balena-cli 19.1.1 → 19.1.2

package/src/hooks/prerun.ts

@@ -0,0 +1,119 @@
+/**
+ * @license
+ * Copyright 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 {
+	type Hook,
+	type Command,
+	// ux
+} from '@oclif/core';
+import { InsufficientPrivilegesError } from '../errors';
+import { checkLoggedIn, checkNotUsingOfflineMode } from '../utils/patterns';
+
+let trackResolve: (result: Promise<any>) => void;
+
+// note: trackPromise is subject to a Bluebird.timeout, defined in events.ts
+export const trackPromise = new Promise((resolve) => {
+	trackResolve = resolve;
+});
+
+/**
+ * Throw InsufficientPrivilegesError if not root on Mac/Linux
+ * or non-Administrator on Windows.
+ *
+ * Called automatically if `root=true`.
+ * Can be called explicitly by command implementation, if e.g.:
+ *  - check should only be done conditionally
+ *  - other code needs to execute before check
+ */
+const checkElevatedPrivileges = async () => {
+	const isElevated = await (await import('is-elevated'))();
+	if (!isElevated) {
+		throw new InsufficientPrivilegesError(
+			'You need root/admin privileges to run this command',
+		);
+	}
+};
+
+/**
+ * Require elevated privileges to run.
+ * When set to true, command will exit with an error
+ * if executed without root on Mac/Linux
+ * or if executed by non-Administrator on Windows.
+ */
+const DEFAULT_ROOT = false;
+
+/**
+ * Require authentication to run.
+ * When set to true, command will exit with an error
+ * if user is not already logged in.
+ */
+const DEFAULT_AUTHENTICATED = false;
+
+/**
+ * Require an internet connection to run.
+ * When set to true, command will exit with an error
+ * if user is running in offline mode (BALENARC_OFFLINE_MODE).
+ */
+const DEFAULT_OFFLINE_COMPATIBLE = false;
+
+/**
+ * This is an oclif 'prerun' hook. This hook runs after the command line is
+ * parsed by oclif, but before the command's run() function is called.
+ * See: https://oclif.io/docs/hooks
+ *
+ * This hook is used to track CLI command signatures (usage analytics).
+ * A command signature is something like "env add NAME [VALUE]". That's
+ * literally so: 'NAME' and 'VALUE' are NOT replaced with actual values.
+ */
+
+const hook: Hook<'prerun'> = async function (options) {
+	try {
+		if (
+			(options.Command as Command.Class & { root: boolean }).root ??
+			DEFAULT_ROOT
+		) {
+			await checkElevatedPrivileges();
+		}
+
+		if (
+			(options.Command as Command.Class & { authenticated: boolean })
+				.authenticated ??
+			DEFAULT_AUTHENTICATED
+		) {
+			await checkLoggedIn();
+		}
+
+		if (
+			!(
+				(options.Command as Command.Class & { offlineCompatible: boolean })
+					.offlineCompatible ?? DEFAULT_OFFLINE_COMPATIBLE
+			)
+		) {
+			await checkNotUsingOfflineMode();
+		}
+	} catch (error) {
+		this.error(error);
+	}
+	const events = await import('../events');
+	const cmd = options.Command.id;
+
+	// Intentionally do not await for the track promise here, in order to
+	// run the command tracking and the command itself in parallel.
+	trackResolve(events.trackCommand(cmd));
+};
+
+export default hook;

package/src/utils/patterns.ts

@@ -24,7 +24,12 @@ import type {
 	PineTypedResult,
 } from 'balena-sdk';
 
-import { instanceOf, NotLoggedInError, ExpectedError } from '../errors';
+import {
+	instanceOf,
+	NotLoggedInError,
+	ExpectedError,
+	NotAvailableInOfflineModeError,
+} from '../errors';
 import { getBalenaSdk, getVisuals, stripIndent, getCliForm } from './lazy';
 import validation = require('./validation');
 import { delay } from './helpers';
@@ -89,6 +94,41 @@ export async function checkLoggedIn(): Promise<void> {
 	}
 }
 
+/**
+ * Throw NotLoggedInError if not logged in when condition true.
+ *
+ * @param {boolean} doCheck - will check if true.
+ * @throws {NotLoggedInError}
+ */
+export const checkLoggedInIf = async (doCheck: boolean) => {
+	if (doCheck) {
+		await checkLoggedIn();
+	}
+};
+
+/**
+ * Throw NotAvailableInOfflineModeError if in offline mode.
+ *
+ * Called automatically if `onlineOnly=true`.
+ * Can be called explicitly by command implementation, if e.g.:
+ *  - check should only be done conditionally
+ *  - other code needs to execute before check
+ *
+ *  Note, currently public to allow use outside of derived commands
+ *  (as some command implementations require this. Can be made protected
+ *  if this changes).
+ *
+ * @throws {NotAvailableInOfflineModeError}
+ */
+export const checkNotUsingOfflineMode = async () => {
+	if (process.env.BALENARC_OFFLINE_MODE) {
+		throw new NotAvailableInOfflineModeError(stripIndent`
+	This command requires an internet connection, and cannot be used in offline mode.
+	To leave offline mode, unset the BALENARC_OFFLINE_MODE environment variable.
+	`);
+	}
+};
+
 export function askLoginType() {
 	return getCliForm().ask<'web' | 'credentials' | 'token' | 'register'>({
 		message: 'How would you like to login?',

package/build/command.d.ts

@@ -1,16 +0,0 @@
-import { Command } from '@oclif/core';
-export default abstract class BalenaCommand extends Command {
-    static primary: boolean;
-    static root: boolean;
-    static authenticated: boolean;
-    static offlineCompatible: boolean;
-    static readStdin: boolean;
-    stdin: string;
-    protected static checkElevatedPrivileges(): Promise<void>;
-    static checkLoggedIn(): Promise<void>;
-    static checkLoggedInIf(doCheck: boolean): Promise<void>;
-    static checkNotUsingOfflineMode(): void;
-    protected getStdin(): Promise<void>;
-    protected static getLogger(): Promise<import("./utils/logger")>;
-    protected init(): Promise<void>;
-}

package/build/command.js

@@ -1,57 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const core_1 = require("@oclif/core");
-const errors_1 = require("./errors");
-const lazy_1 = require("./utils/lazy");
-class BalenaCommand extends core_1.Command {
-    static async checkElevatedPrivileges() {
-        const isElevated = await (await Promise.resolve().then(() => require('is-elevated')))();
-        if (!isElevated) {
-            throw new errors_1.InsufficientPrivilegesError('You need root/admin privileges to run this command');
-        }
-    }
-    static async checkLoggedIn() {
-        await (await Promise.resolve().then(() => require('./utils/patterns'))).checkLoggedIn();
-    }
-    static async checkLoggedInIf(doCheck) {
-        if (doCheck) {
-            await this.checkLoggedIn();
-        }
-    }
-    static checkNotUsingOfflineMode() {
-        if (process.env.BALENARC_OFFLINE_MODE) {
-            throw new errors_1.NotAvailableInOfflineModeError((0, lazy_1.stripIndent) `
-		This command requires an internet connection, and cannot be used in offline mode.
-		To leave offline mode, unset the BALENARC_OFFLINE_MODE environment variable.
-		`);
-        }
-    }
-    async getStdin() {
-        this.stdin = await (await Promise.resolve().then(() => require('get-stdin')))();
-    }
-    static async getLogger() {
-        return (await Promise.resolve().then(() => require('./utils/logger'))).getLogger();
-    }
-    async init() {
-        const ctr = this.constructor;
-        if (ctr.root) {
-            await BalenaCommand.checkElevatedPrivileges();
-        }
-        if (ctr.authenticated) {
-            await BalenaCommand.checkLoggedIn();
-        }
-        if (!ctr.offlineCompatible) {
-            BalenaCommand.checkNotUsingOfflineMode();
-        }
-        if (ctr.readStdin) {
-            await this.getStdin();
-        }
-    }
-}
-BalenaCommand.primary = false;
-BalenaCommand.root = false;
-BalenaCommand.authenticated = false;
-BalenaCommand.offlineCompatible = false;
-BalenaCommand.readStdin = false;
-exports.default = BalenaCommand;
-//# sourceMappingURL=command.js.map

package/build/command.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"command.js","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":";;AAiBA,sCAAsC;AACtC,qCAGkB;AAClB,uCAA2C;AAE3C,MAA8B,aAAc,SAAQ,cAAO;IA+ChD,MAAM,CAAC,KAAK,CAAC,uBAAuB;QAC7C,MAAM,UAAU,GAAG,MAAM,CAAC,2CAAa,aAAa,EAAC,CAAC,EAAE,CAAC;QACzD,IAAI,CAAC,UAAU,EAAE,CAAC;YACjB,MAAM,IAAI,oCAA2B,CACpC,oDAAoD,CACpD,CAAC;QACH,CAAC;IACF,CAAC;IAgBM,MAAM,CAAC,KAAK,CAAC,aAAa;QAChC,MAAM,CAAC,2CAAa,kBAAkB,EAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IAC1D,CAAC;IAQM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,OAAgB;QACnD,IAAI,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC5B,CAAC;IACF,CAAC;IAgBM,MAAM,CAAC,wBAAwB;QACrC,IAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC;YACvC,MAAM,IAAI,uCAA8B,CAAC,IAAA,kBAAW,EAAA;;;GAGpD,CAAC,CAAC;QACH,CAAC;IACF,CAAC;IAQS,KAAK,CAAC,QAAQ;QACvB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,2CAAa,WAAW,EAAC,CAAC,EAAE,CAAC;IAClD,CAAC;IAKS,MAAM,CAAC,KAAK,CAAC,SAAS;QAC/B,OAAO,CAAC,2CAAa,gBAAgB,EAAC,CAAC,CAAC,SAAS,EAAE,CAAC;IACrD,CAAC;IAES,KAAK,CAAC,IAAI;QACnB,MAAM,GAAG,GAAG,IAAI,CAAC,WAAmC,CAAC;QAErD,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;YACd,MAAM,aAAa,CAAC,uBAAuB,EAAE,CAAC;QAC/C,CAAC;QAED,IAAI,GAAG,CAAC,aAAa,EAAE,CAAC;YACvB,MAAM,aAAa,CAAC,aAAa,EAAE,CAAC;QACrC,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC;YAC5B,aAAa,CAAC,wBAAwB,EAAE,CAAC;QAC1C,CAAC;QAED,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACvB,CAAC;IACF,CAAC;;AA3Ia,qBAAO,GAAG,KAAK,CAAC;AAQhB,kBAAI,GAAG,KAAK,CAAC;AAOb,2BAAa,GAAG,KAAK,CAAC;AAOtB,+BAAiB,GAAG,KAAK,CAAC;AAO1B,uBAAS,GAAG,KAAK,CAAC;kBAlCH,aAAa"}

package/build/hooks/prerun/track.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.trackPromise = void 0;
-let trackResolve;
-exports.trackPromise = new Promise((resolve) => {
-    trackResolve = resolve;
-});
-const hook = async function (options) {
-    const events = await Promise.resolve().then(() => require('../../events'));
-    const cmd = options.Command.id;
-    trackResolve(events.trackCommand(cmd));
-};
-exports.default = hook;
-//# sourceMappingURL=track.js.map

package/build/hooks/prerun/track.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"track.js","sourceRoot":"","sources":["../../../src/hooks/prerun/track.ts"],"names":[],"mappings":";;;AAkBA,IAAI,YAA4C,CAAC;AAGpC,QAAA,YAAY,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;IACnD,YAAY,GAAG,OAAO,CAAC;AACxB,CAAC,CAAC,CAAC;AAWH,MAAM,IAAI,GAAmB,KAAK,WAAW,OAAO;IACnD,MAAM,MAAM,GAAG,2CAAa,cAAc,EAAC,CAAC;IAC5C,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;IAI/B,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;AACxC,CAAC,CAAC;AAEF,kBAAe,IAAI,CAAC"}

package/src/command.ts

@@ -1,170 +0,0 @@
-/**
- * @license
- * Copyright 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 { Command } from '@oclif/core';
-import {
-	InsufficientPrivilegesError,
-	NotAvailableInOfflineModeError,
-} from './errors';
-import { stripIndent } from './utils/lazy';
-
-export default abstract class BalenaCommand extends Command {
-	/**
-	 * When set to true, command will be listed in `help`,
-	 * otherwise listed in `help --verbose` with secondary commands.
-	 */
-	public static primary = false;
-
-	/**
-	 * Require elevated privileges to run.
-	 * When set to true, command will exit with an error
-	 * if executed without root on Mac/Linux
-	 * or if executed by non-Administrator on Windows.
-	 */
-	public static root = false;
-
-	/**
-	 * Require authentication to run.
-	 * When set to true, command will exit with an error
-	 * if user is not already logged in.
-	 */
-	public static authenticated = false;
-
-	/**
-	 * Require an internet connection to run.
-	 * When set to true, command will exit with an error
-	 * if user is running in offline mode (BALENARC_OFFLINE_MODE).
-	 */
-	public static offlineCompatible = false;
-
-	/**
-	 * Accept piped input.
-	 * When set to true, command will read from stdin during init
-	 * and make contents available on member `stdin`.
-	 */
-	public static readStdin = false;
-
-	public stdin: string;
-
-	/**
-	 * Throw InsufficientPrivilegesError if not root on Mac/Linux
-	 * or non-Administrator on Windows.
-	 *
-	 * Called automatically if `root=true`.
-	 * Can be called explicitly by command implementation, if e.g.:
-	 *  - check should only be done conditionally
-	 *  - other code needs to execute before check
-	 */
-	protected static async checkElevatedPrivileges() {
-		const isElevated = await (await import('is-elevated'))();
-		if (!isElevated) {
-			throw new InsufficientPrivilegesError(
-				'You need root/admin privileges to run this command',
-			);
-		}
-	}
-
-	/**
-	 * Throw NotLoggedInError if not logged in.
-	 *
-	 * Called automatically if `authenticated=true`.
-	 * Can be called explicitly by command implementation, if e.g.:
-	 *  - check should only be done conditionally
-	 *  - other code needs to execute before check
-	 *
-	 *  Note, currently public to allow use outside of derived commands
-	 *  (as some command implementations require this. Can be made protected
-	 *  if this changes).
-	 *
-	 * @throws {NotLoggedInError}
-	 */
-	public static async checkLoggedIn() {
-		await (await import('./utils/patterns')).checkLoggedIn();
-	}
-
-	/**
-	 * Throw NotLoggedInError if not logged in when condition true.
-	 *
-	 * @param {boolean} doCheck - will check if true.
-	 * @throws {NotLoggedInError}
-	 */
-	public static async checkLoggedInIf(doCheck: boolean) {
-		if (doCheck) {
-			await this.checkLoggedIn();
-		}
-	}
-
-	/**
-	 * Throw NotAvailableInOfflineModeError if in offline mode.
-	 *
-	 * Called automatically if `onlineOnly=true`.
-	 * Can be called explicitly by command implementation, if e.g.:
-	 *  - check should only be done conditionally
-	 *  - other code needs to execute before check
-	 *
-	 *  Note, currently public to allow use outside of derived commands
-	 *  (as some command implementations require this. Can be made protected
-	 *  if this changes).
-	 *
-	 * @throws {NotAvailableInOfflineModeError}
-	 */
-	public static checkNotUsingOfflineMode() {
-		if (process.env.BALENARC_OFFLINE_MODE) {
-			throw new NotAvailableInOfflineModeError(stripIndent`
-		This command requires an internet connection, and cannot be used in offline mode.
-		To leave offline mode, unset the BALENARC_OFFLINE_MODE environment variable.
-		`);
-		}
-	}
-
-	/**
-	 * Read stdin contents and make available to command.
-	 *
-	 * This approach could be improved in the future to automatically set argument
-	 * values from stdin based in configuration, minimising command implementation.
-	 */
-	protected async getStdin() {
-		this.stdin = await (await import('get-stdin'))();
-	}
-
-	/**
-	 * Get a logger instance.
-	 */
-	protected static async getLogger() {
-		return (await import('./utils/logger')).getLogger();
-	}
-
-	protected async init() {
-		const ctr = this.constructor as typeof BalenaCommand;
-
-		if (ctr.root) {
-			await BalenaCommand.checkElevatedPrivileges();
-		}
-
-		if (ctr.authenticated) {
-			await BalenaCommand.checkLoggedIn();
-		}
-
-		if (!ctr.offlineCompatible) {
-			BalenaCommand.checkNotUsingOfflineMode();
-		}
-
-		if (ctr.readStdin) {
-			await this.getStdin();
-		}
-	}
-}

package/src/hooks/prerun/track.ts

@@ -1,44 +0,0 @@
-/**
- * @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 type { Hook } from '@oclif/core';
-
-let trackResolve: (result: Promise<any>) => void;
-
-// note: trackPromise is subject to a Bluebird.timeout, defined in events.ts
-export const trackPromise = new Promise((resolve) => {
-	trackResolve = resolve;
-});
-
-/**
- * This is an oclif 'prerun' hook. This hook runs after the command line is
- * parsed by oclif, but before the command's run() function is called.
- * See: https://oclif.io/docs/hooks
- *
- * This hook is used to track CLI command signatures (usage analytics).
- * A command signature is something like "env add NAME [VALUE]". That's
- * literally so: 'NAME' and 'VALUE' are NOT replaced with actual values.
- */
-const hook: Hook<'prerun'> = async function (options) {
-	const events = await import('../../events');
-	const cmd = options.Command.id;
-
-	// Intentionally do not await for the track promise here, in order to
-	// run the command tracking and the command itself in parallel.
-	trackResolve(events.trackCommand(cmd));
-};
-
-export default hook;