Exit with non-zero code on unexpected errors (microsoft/vscode-remote-release#10217)

chrmarti · chrmarti · commit fd68152404e7 · 2024-09-05T21:15:16.000+02:00
diff --git a/src/spec-configuration/containerTemplatesOCI.ts b/src/spec-configuration/containerTemplatesOCI.ts
@@ -50,7 +50,8 @@ export async function fetchTemplate(params: CommonParams, selectedTemplate: Sele
 	const blobResult = await getBlob(params, blobUrl, tmpDir, templateDestPath, templateRef, blobDigest, [...omitPaths, 'devcontainer-template.json', 'README.md', 'NOTES.md'], 'devcontainer-template.json');
 
 	if (!blobResult) {
-		throw new Error(`Failed to download package for ${templateRef.resource}`);
+		output.write(`Failed to download package for ${templateRef.resource}`, LogLevel.Error);
+		return;
 	}
 
 	const { files, metadata } = blobResult;
diff --git a/src/spec-node/devContainersSpecCLI.ts b/src/spec-node/devContainersSpecCLI.ts
@@ -10,7 +10,7 @@ import textTable from 'text-table';
 import * as jsonc from 'jsonc-parser';
 
 import { createDockerParams, createLog, launch, ProvisionOptions } from './devContainers';
-import { SubstitutedConfig, createContainerProperties, envListToObj, inspectDockerImage, isDockerFileConfig, SubstituteConfig, addSubstitution, findContainerAndIdLabels, getCacheFolder } from './utils';
+import { SubstitutedConfig, createContainerProperties, envListToObj, inspectDockerImage, isDockerFileConfig, SubstituteConfig, addSubstitution, findContainerAndIdLabels, getCacheFolder, runAsyncHandler } from './utils';
 import { URI } from 'vscode-uri';
 import { ContainerError } from '../spec-common/errors';
 import { Log, LogDimensions, LogLevel, makeLog, mapLogLevel } from '../spec-utils/log';
@@ -168,7 +168,7 @@ function provisionOptions(y: Argv) {
 type ProvisionArgs = UnpackArgv<ReturnType<typeof provisionOptions>>;
 
 function provisionHandler(args: ProvisionArgs) {
-	(async () => provision(args))().catch(console.error);
+	runAsyncHandler(provision.bind(null, args));
 }
 
 async function provision({
@@ -366,7 +366,7 @@ function setUpOptions(y: Argv) {
 type SetUpArgs = UnpackArgv<ReturnType<typeof setUpOptions>>;
 
 function setUpHandler(args: SetUpArgs) {
-	(async () => setUp(args))().catch(console.error);
+	runAsyncHandler(setUp.bind(null, args));
 }
 
 async function setUp(args: SetUpArgs) {
@@ -529,7 +529,7 @@ function buildOptions(y: Argv) {
 type BuildArgs = UnpackArgv<ReturnType<typeof buildOptions>>;
 
 function buildHandler(args: BuildArgs) {
-	(async () => build(args))().catch(console.error);
+	runAsyncHandler(build.bind(null, args));
 }
 
 async function build(args: BuildArgs) {
@@ -791,7 +791,7 @@ function runUserCommandsOptions(y: Argv) {
 type RunUserCommandsArgs = UnpackArgv<ReturnType<typeof runUserCommandsOptions>>;
 
 function runUserCommandsHandler(args: RunUserCommandsArgs) {
-	(async () => runUserCommands(args))().catch(console.error);
+	runAsyncHandler(runUserCommands.bind(null, args));
 }
 async function runUserCommands(args: RunUserCommandsArgs) {
 	const result = await doRunUserCommands(args);
@@ -981,7 +981,7 @@ function readConfigurationOptions(y: Argv) {
 type ReadConfigurationArgs = UnpackArgv<ReturnType<typeof readConfigurationOptions>>;
 
 function readConfigurationHandler(args: ReadConfigurationArgs) {
-	(async () => readConfiguration(args))().catch(console.error);
+	runAsyncHandler(readConfiguration.bind(null, args));
 }
 
 async function readConfiguration({
@@ -1117,7 +1117,7 @@ function outdatedOptions(y: Argv) {
 type OutdatedArgs = UnpackArgv<ReturnType<typeof outdatedOptions>>;
 
 function outdatedHandler(args: OutdatedArgs) {
-	(async () => outdated(args))().catch(console.error);
+	runAsyncHandler(outdated.bind(null, args));
 }
 
 async function outdated({
@@ -1249,7 +1249,7 @@ function execOptions(y: Argv) {
 export type ExecArgs = UnpackArgv<ReturnType<typeof execOptions>>;
 
 function execHandler(args: ExecArgs) {
-	(async () => exec(args))().catch(console.error);
+	runAsyncHandler(exec.bind(null, args));
 }
 
 async function exec(args: ExecArgs) {
diff --git a/src/spec-node/featuresCLI/generateDocs.ts b/src/spec-node/featuresCLI/generateDocs.ts
@@ -4,6 +4,7 @@ import { generateFeaturesDocumentation } from '../collectionCommonUtils/generate
 import { createLog } from '../devContainers';
 import { mapLogLevel } from '../../spec-utils/log';
 import { getPackageConfig } from '../../spec-utils/product';
+import { runAsyncHandler } from '../utils';
 
 // -- 'features generate-docs' command
 export function featuresGenerateDocsOptions(y: Argv) {
@@ -24,7 +25,7 @@ export function featuresGenerateDocsOptions(y: Argv) {
 export type FeaturesGenerateDocsArgs = UnpackArgv<ReturnType<typeof featuresGenerateDocsOptions>>;
 
 export function featuresGenerateDocsHandler(args: FeaturesGenerateDocsArgs) {
-	(async () => await featuresGenerateDocs(args))().catch(console.error);
+	runAsyncHandler(featuresGenerateDocs.bind(null, args));
 }
 
 export async function featuresGenerateDocs({
diff --git a/src/spec-node/featuresCLI/info.ts b/src/spec-node/featuresCLI/info.ts
@@ -7,6 +7,7 @@ import { UnpackArgv } from '../devContainersSpecCLI';
 import { buildDependencyGraph, generateMermaidDiagram } from '../../spec-configuration/containerFeaturesOrder';
 import { DevContainerFeature } from '../../spec-configuration/configuration';
 import { processFeatureIdentifier } from '../../spec-configuration/containerFeaturesConfiguration';
+import { runAsyncHandler } from '../utils';
 
 export function featuresInfoOptions(y: Argv) {
 	return y
@@ -21,7 +22,7 @@ export function featuresInfoOptions(y: Argv) {
 export type FeaturesInfoArgs = UnpackArgv<ReturnType<typeof featuresInfoOptions>>;
 
 export function featuresInfoHandler(args: FeaturesInfoArgs) {
-	(async () => await featuresInfo(args))().catch(console.error);
+	runAsyncHandler(featuresInfo.bind(null, args));
 }
 
 interface InfoJsonOutput {
diff --git a/src/spec-node/featuresCLI/package.ts b/src/spec-node/featuresCLI/package.ts
@@ -7,14 +7,15 @@ import { createLog } from '../devContainers';
 import { UnpackArgv } from '../devContainersSpecCLI';
 import { doFeaturesPackageCommand } from './packageCommandImpl';
 import { PackageCommandInput, PackageOptions } from '../collectionCommonUtils/package';
+import { runAsyncHandler } from '../utils';
 
 export function featuresPackageOptions(y: Argv) {
 	return PackageOptions(y, 'feature');
 }
 
 export type FeaturesPackageArgs = UnpackArgv<ReturnType<typeof featuresPackageOptions>>;
 export function featuresPackageHandler(args: FeaturesPackageArgs) {
-	(async () => await featuresPackage(args))().catch(console.error);
+	runAsyncHandler(featuresPackage.bind(null, args));
 }
 
 async function featuresPackage({
diff --git a/src/spec-node/featuresCLI/publish.ts b/src/spec-node/featuresCLI/publish.ts
@@ -14,6 +14,7 @@ import { getArchiveName, OCICollectionFileName } from '../collectionCommonUtils/
 import { publishOptions } from '../collectionCommonUtils/publish';
 import { getCollectionRef, getRef, OCICollectionRef } from '../../spec-configuration/containerCollectionsOCI';
 import { doPublishCommand, doPublishMetadata } from '../collectionCommonUtils/publishCommandImpl';
+import { runAsyncHandler } from '../utils';
 
 const collectionType = 'feature';
 export function featuresPublishOptions(y: Argv) {
@@ -23,7 +24,7 @@ export function featuresPublishOptions(y: Argv) {
 export type FeaturesPublishArgs = UnpackArgv<ReturnType<typeof featuresPublishOptions>>;
 
 export function featuresPublishHandler(args: FeaturesPublishArgs) {
-    (async () => await featuresPublish(args))().catch(console.error);
+	runAsyncHandler(featuresPublish.bind(null, args));
 }
 
 async function featuresPublish({
diff --git a/src/spec-node/featuresCLI/resolveDependencies.ts b/src/spec-node/featuresCLI/resolveDependencies.ts
@@ -10,6 +10,7 @@ import { DevContainerConfig, DevContainerFeature } from '../../spec-configuratio
 import { buildDependencyGraph, computeDependsOnInstallationOrder, generateMermaidDiagram } from '../../spec-configuration/containerFeaturesOrder';
 import { OCISourceInformation, processFeatureIdentifier, userFeaturesToArray } from '../../spec-configuration/containerFeaturesConfiguration';
 import { readLockfile } from '../../spec-configuration/lockfile';
+import { runAsyncHandler } from '../utils';
 
 interface JsonOutput {
 	installOrder?: {
@@ -29,7 +30,7 @@ export function featuresResolveDependenciesOptions(y: Argv) {
 export type featuresResolveDependenciesArgs = UnpackArgv<ReturnType<typeof featuresResolveDependenciesOptions>>;
 
 export function featuresResolveDependenciesHandler(args: featuresResolveDependenciesArgs) {
-	(async () => await featuresResolveDependencies(args))().catch(console.error);
+	runAsyncHandler(featuresResolveDependencies.bind(null, args));
 }
 
 async function featuresResolveDependencies({
diff --git a/src/spec-node/featuresCLI/test.ts b/src/spec-node/featuresCLI/test.ts
@@ -5,6 +5,7 @@ import { LogLevel, mapLogLevel } from '../../spec-utils/log';
 import { getPackageConfig, PackageConfiguration } from '../../spec-utils/product';
 import { UnpackArgv } from '../devContainersSpecCLI';
 import { doFeaturesTestCommand } from './testCommandImpl';
+import { runAsyncHandler } from '../utils';
 
 // -- 'features test' command
 export function featuresTestOptions(y: Argv) {
@@ -67,7 +68,7 @@ export interface FeaturesTestCommandInput {
 }
 
 export function featuresTestHandler(args: FeaturesTestArgs) {
-	(async () => await featuresTest(args))().catch(console.error);
+	runAsyncHandler(featuresTest.bind(null, args));
 }
 
 async function featuresTest({
diff --git a/src/spec-node/templatesCLI/apply.ts b/src/spec-node/templatesCLI/apply.ts
@@ -5,6 +5,7 @@ import { createLog } from '../devContainers';
 import * as jsonc from 'jsonc-parser';
 import { UnpackArgv } from '../devContainersSpecCLI';
 import { fetchTemplate, SelectedTemplate, TemplateFeatureOption, TemplateOptions } from '../../spec-configuration/containerTemplatesOCI';
+import { runAsyncHandler } from '../utils';
 
 export function templateApplyOptions(y: Argv) {
 	return y
@@ -25,7 +26,7 @@ export function templateApplyOptions(y: Argv) {
 export type TemplateApplyArgs = UnpackArgv<ReturnType<typeof templateApplyOptions>>;
 
 export function templateApplyHandler(args: TemplateApplyArgs) {
-	(async () => await templateApply(args))().catch(console.error);
+	runAsyncHandler(templateApply.bind(null, args));
 }
 
 async function templateApply({
diff --git a/src/spec-node/templatesCLI/generateDocs.ts b/src/spec-node/templatesCLI/generateDocs.ts
@@ -4,6 +4,7 @@ import { generateTemplatesDocumentation } from '../collectionCommonUtils/generat
 import { createLog } from '../devContainers';
 import { mapLogLevel } from '../../spec-utils/log';
 import { getPackageConfig } from '../../spec-utils/product';
+import { runAsyncHandler } from '../utils';
 
 // -- 'templates generate-docs' command
 export function templatesGenerateDocsOptions(y: Argv) {
@@ -22,7 +23,7 @@ export function templatesGenerateDocsOptions(y: Argv) {
 export type TemplatesGenerateDocsArgs = UnpackArgv<ReturnType<typeof templatesGenerateDocsOptions>>;
 
 export function templatesGenerateDocsHandler(args: TemplatesGenerateDocsArgs) {
-	(async () => await templatesGenerateDocs(args))().catch(console.error);
+	runAsyncHandler(templatesGenerateDocs.bind(null, args));
 }
 
 export async function templatesGenerateDocs({
diff --git a/src/spec-node/templatesCLI/metadata.ts b/src/spec-node/templatesCLI/metadata.ts
@@ -5,6 +5,7 @@ import { createLog } from '../devContainers';
 import { fetchOCIManifestIfExists, getRef } from '../../spec-configuration/containerCollectionsOCI';
 
 import { UnpackArgv } from '../devContainersSpecCLI';
+import { runAsyncHandler } from '../utils';
 
 export function templateMetadataOptions(y: Argv) {
 	return y
@@ -17,7 +18,7 @@ export function templateMetadataOptions(y: Argv) {
 export type TemplateMetadataArgs = UnpackArgv<ReturnType<typeof templateMetadataOptions>>;
 
 export function templateMetadataHandler(args: TemplateMetadataArgs) {
-	(async () => await templateMetadata(args))().catch(console.error);
+	runAsyncHandler(templateMetadata.bind(null, args));
 }
 
 async function templateMetadata({
diff --git a/src/spec-node/templatesCLI/publish.ts b/src/spec-node/templatesCLI/publish.ts
@@ -14,6 +14,7 @@ import { getArchiveName, OCICollectionFileName } from '../collectionCommonUtils/
 import { packageTemplates } from './packageImpl';
 import { getCollectionRef, getRef, OCICollectionRef } from '../../spec-configuration/containerCollectionsOCI';
 import { doPublishCommand, doPublishMetadata } from '../collectionCommonUtils/publishCommandImpl';
+import { runAsyncHandler } from '../utils';
 
 const collectionType = 'template';
 
@@ -24,7 +25,7 @@ export function templatesPublishOptions(y: Argv) {
 export type TemplatesPublishArgs = UnpackArgv<ReturnType<typeof templatesPublishOptions>>;
 
 export function templatesPublishHandler(args: TemplatesPublishArgs) {
-    (async () => await templatesPublish(args))().catch(console.error);
+	runAsyncHandler(templatesPublish.bind(null, args));
 }
 
 async function templatesPublish({
diff --git a/src/spec-node/upgradeCommand.ts b/src/spec-node/upgradeCommand.ts
@@ -13,7 +13,7 @@ import { Workspace, workspaceFromPath } from '../spec-utils/workspaces';
 import { getDefaultDevContainerConfigPath, getDevContainerConfigPathIn, uriToFsPath } from '../spec-configuration/configurationCommonUtils';
 import { readDevContainerConfigFile } from './configContainer';
 import { ContainerError } from '../spec-common/errors';
-import { getCacheFolder } from './utils';
+import { getCacheFolder, runAsyncHandler } from './utils';
 import { Lockfile, generateLockfile, getLockfilePath, writeLockfile } from '../spec-configuration/lockfile';
 import { isLocalFile, readLocalFile, writeLocalFile } from '../spec-utils/pfs';
 import { readFeaturesConfig } from './featureUtils';
@@ -51,7 +51,7 @@ export function featuresUpgradeOptions(y: Argv) {
 export type FeaturesUpgradeArgs = UnpackArgv<ReturnType<typeof featuresUpgradeOptions>>;
 
 export function featuresUpgradeHandler(args: FeaturesUpgradeArgs) {
-	(async () => await featuresUpgrade(args))().catch(console.error);
+	runAsyncHandler(featuresUpgrade.bind(null, args));
 }
 
 async function featuresUpgrade({
diff --git a/src/spec-node/utils.ts b/src/spec-node/utils.ts
@@ -579,3 +579,14 @@ export async function findContainerAndIdLabels(params: DockerResolverParameters
 			[`${hostFolderLabel}=${workspaceFolder}`],
 	};
 }
+
+export function runAsyncHandler(handler: () => Promise<void>) {
+	(async () => {
+		try {
+			await handler();
+		} catch (err) {
+			console.error(err);
+			process.exit(1);
+		}
+	})();
+}

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,8 @@ export async function fetchTemplate(params: CommonParams, selectedTemplate: Sele`
`50`	`50`	`const blobResult = await getBlob(params, blobUrl, tmpDir, templateDestPath, templateRef, blobDigest, [...omitPaths, 'devcontainer-template.json', 'README.md', 'NOTES.md'], 'devcontainer-template.json');`
`51`	`51`
`52`	`52`	`if (!blobResult) {`
`53`		- throw new Error(`Failed to download package for ${templateRef.resource}`);
	`53`	+ output.write(`Failed to download package for ${templateRef.resource}`, LogLevel.Error);
	`54`	`+ return;`
`54`	`55`	`}`
`55`	`56`
`56`	`57`	`const { files, metadata } = blobResult;`
Original file line number	Diff line number	Diff line change
`@@ -7,14 +7,15 @@ import { createLog } from '../devContainers';`
`7`	`7`	`import { UnpackArgv } from '../devContainersSpecCLI';`
`8`	`8`	`import { doFeaturesPackageCommand } from './packageCommandImpl';`
`9`	`9`	`import { PackageCommandInput, PackageOptions } from '../collectionCommonUtils/package';`
	`10`	`+import { runAsyncHandler } from '../utils';`
`10`	`11`
`11`	`12`	`export function featuresPackageOptions(y: Argv) {`
`12`	`13`	`return PackageOptions(y, 'feature');`
`13`	`14`	`}`
`14`	`15`
`15`	`16`	`export type FeaturesPackageArgs = UnpackArgv<ReturnType<typeof featuresPackageOptions>>;`
`16`	`17`	`export function featuresPackageHandler(args: FeaturesPackageArgs) {`
`17`		`- (async () => await featuresPackage(args))().catch(console.error);`
	`18`	`+ runAsyncHandler(featuresPackage.bind(null, args));`
`18`	`19`	`}`
`19`	`20`
`20`	`21`	`async function featuresPackage({`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ import { LogLevel, mapLogLevel } from '../../spec-utils/log';`
`5`	`5`	`import { getPackageConfig, PackageConfiguration } from '../../spec-utils/product';`
`6`	`6`	`import { UnpackArgv } from '../devContainersSpecCLI';`
`7`	`7`	`import { doFeaturesTestCommand } from './testCommandImpl';`
	`8`	`+import { runAsyncHandler } from '../utils';`
`8`	`9`
`9`	`10`	`// -- 'features test' command`
`10`	`11`	`export function featuresTestOptions(y: Argv) {`
`@@ -67,7 +68,7 @@ export interface FeaturesTestCommandInput {`
`67`	`68`	`}`
`68`	`69`
`69`	`70`	`export function featuresTestHandler(args: FeaturesTestArgs) {`
`70`		`- (async () => await featuresTest(args))().catch(console.error);`
	`71`	`+ runAsyncHandler(featuresTest.bind(null, args));`
`71`	`72`	`}`
`72`	`73`
`73`	`74`	`async function featuresTest({`