/** * @license * Copyright 2019-2020 Balena Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import * as packageJSON from '../package.json'; import { AppOptions, checkDeletedCommand, preparseArgs, unsupportedFlag, } from './preparser'; import { CliSettings } from './utils/bootstrap'; import { onceAsync } from './utils/lazy'; import { run as mainRun, settings } from '@oclif/core'; /** * Sentry.io setup * @see https://docs.sentry.io/error-reporting/quickstart/?platform=node */ export const setupSentry = onceAsync(async () => { const config = await import('./config'); const Sentry = await import('@sentry/node'); Sentry.init({ autoSessionTracking: false, dsn: config.sentryDsn, release: packageJSON.version, }); Sentry.configureScope((scope) => { scope.setExtras({ is_pkg: !!(process as any).pkg, node_version: process.version, platform: process.platform, }); }); return Sentry.getCurrentHub(); }); async function checkNodeVersion() { const validNodeVersions = packageJSON.engines.node; if (!(await import('semver')).satisfies(process.version, validNodeVersions)) { const { getNodeEngineVersionWarn } = await import('./utils/messages'); console.warn(getNodeEngineVersionWarn(process.version, validNodeVersions)); } } /** Setup balena-sdk options that are shared with imported packages */ function setupBalenaSdkSharedOptions(settings: CliSettings) { const BalenaSdk = require('balena-sdk') as typeof import('balena-sdk'); BalenaSdk.setSharedOptions({ apiUrl: settings.get('apiUrl'), dataDirectory: settings.get('dataDirectory'), }); } /** * Addresses the console warning: * (node:49500) MaxListenersExceededWarning: Possible EventEmitter memory * leak detected. 11 error listeners added. Use emitter.setMaxListeners() to * increase limit */ export function setMaxListeners(maxListeners: number) { require('events').EventEmitter.defaultMaxListeners = maxListeners; } /** Selected CLI initialization steps */ async function init() { if (process.env.BALENARC_NO_SENTRY) { if (process.env.DEBUG) { console.error(`WARN: disabling Sentry.io error reporting`); } } else { await setupSentry(); } await checkNodeVersion(); const settings = new CliSettings(); // Proxy setup should be done early on, before loading balena-sdk await (await import('./utils/proxy')).setupGlobalHttpProxy(settings); setupBalenaSdkSharedOptions(settings); // check for CLI updates once a day if (!process.env.BALENARC_OFFLINE_MODE) { (await import('./utils/update')).notify(); } } /** Execute the oclif parser and the CLI command. */ async function oclifRun(command: string[], options: AppOptions) { let deprecationPromise: Promise; // check and enforce the CLI's deprecation policy if (unsupportedFlag || process.env.BALENARC_UNSUPPORTED) { deprecationPromise = Promise.resolve(); } else { const { DeprecationChecker } = await import('./deprecation'); const deprecationChecker = new DeprecationChecker(packageJSON.version); // warnAndAbortIfDeprecated uses previously cached data only await deprecationChecker.warnAndAbortIfDeprecated(); // checkForNewReleasesIfNeeded may query the npm registry deprecationPromise = deprecationChecker.checkForNewReleasesIfNeeded(); } const runPromise = (async function (shouldFlush: boolean) { let isEEXIT = false; try { if (options.development) { // In dev mode -> use ts-node and dev plugins process.env.NODE_ENV = 'development'; settings.debug = true; } // For posteriority: We can't use default oclif 'execute' as // We customize error handling and flushing await mainRun(command, options.loadOptions ?? options.dir); } catch (error) { // oclif sometimes exits with ExitError code EEXIT 0 (not an error), // for example the `balena help` command. // (Avoid `error instanceof ExitError` here for the reasons explained // in the CONTRIBUTING.md file regarding the `instanceof` operator.) if (error.oclif?.exit === 0) { isEEXIT = true; } else { throw error; } } if (shouldFlush) { await import('@oclif/core/flush'); } // TODO: figure out why we need to call fast-boot stop() here, in // addition to calling it in the main `run()` function in this file. // If it is not called here as well, there is a process exit delay of // 1 second when the fast-boot2 cache is modified (1 second is the // default cache saving timeout). Try for example `balena help`. // I have found that, when oclif's `Error: EEXIT: 0` is caught in // the try/catch block above, execution does not get past the // Promise.all() call below, but I don't understand why. if (isEEXIT) { (await import('./fast-boot')).stop(); } })(!options.noFlush); const { trackPromise } = await import('./hooks/prerun/track'); await Promise.all([trackPromise, deprecationPromise, runPromise]); } /** CLI entrypoint. Called by the `bin/balena` and `bin/balena-dev` scripts. */ export async function run(cliArgs = process.argv, options: AppOptions) { try { const { setOfflineModeEnvVars, normalizeEnvVars, pkgExec } = await import( './utils/bootstrap' ); setOfflineModeEnvVars(); normalizeEnvVars(); // The 'pkgExec' special/internal command provides a Node.js interpreter // for use of the standalone zip package. See pkgExec function. if (cliArgs.length > 3 && cliArgs[2] === 'pkgExec') { return pkgExec(cliArgs[3], cliArgs.slice(4)); } await init(); // Look for commands that have been removed and if so, exit with a notice checkDeletedCommand(cliArgs.slice(2)); const args = await preparseArgs(cliArgs); await oclifRun(args, options); } catch (err) { await (await import('./errors')).handleError(err); } finally { try { (await import('./fast-boot')).stop(); } catch (e) { if (process.env.DEBUG) { console.error(`[debug] Stopping fast-boot: ${e}`); } } // Windows fix: reading from stdin prevents the process from exiting process.stdin.pause(); } }