@fluidframework/fluid-runner 2.0.0-dev.4.1.0.148229 → 2.0.0-dev.4.2.0.153917

package/src/exportFile.ts

@@ -9,10 +9,9 @@ import { LoaderHeader } from "@fluidframework/container-definitions";
 import { Loader } from "@fluidframework/container-loader";
 import { createLocalOdspDocumentServiceFactory } from "@fluidframework/odsp-driver";
 import { PerformanceEvent } from "@fluidframework/telemetry-utils";
-import { getArgsValidationError } from "./getArgsValidationError";
 import { IFluidFileConverter } from "./codeLoaderBundle";
 import { FakeUrlResolver } from "./fakeUrlResolver";
-import { getSnapshotFileContent } from "./utils";
+import { getSnapshotFileContent, timeoutPromise, getArgsValidationError } from "./utils";
 /* eslint-disable import/no-internal-modules */
 import { ITelemetryOptions } from "./logger/fileLogger";
 import { createLogger, getTelemetryFileValidationError } from "./logger/loggerUtils";
@@ -43,6 +42,7 @@ export async function exportFile(
 	telemetryFile: string,
 	options?: string,
 	telemetryOptions?: ITelemetryOptions,
+	timeout?: number,
 ): Promise<IExportFileResponse> {
 	const telemetryArgError = getTelemetryFileValidationError(telemetryFile);
 	if (telemetryArgError) {
@@ -56,7 +56,7 @@ export async function exportFile(
 			logger,
 			{ eventName: "ExportFile" },
 			async () => {
-				const argsValidationError = getArgsValidationError(inputFile, outputFile);
+				const argsValidationError = getArgsValidationError(inputFile, outputFile, timeout);
 				if (argsValidationError) {
 					const eventName = clientArgsValidationError;
 					logger.sendErrorEvent({ eventName, message: argsValidationError });
@@ -70,6 +70,7 @@ export async function exportFile(
 						fluidFileConverter,
 						logger,
 						options,
+						timeout,
 					),
 				);
 
@@ -94,25 +95,39 @@ export async function createContainerAndExecute(
 	fluidFileConverter: IFluidFileConverter,
 	logger: ITelemetryLogger,
 	options?: string,
+	timeout?: number,
 ): Promise<string> {
-	const loader = new Loader({
-		urlResolver: new FakeUrlResolver(),
-		documentServiceFactory: createLocalOdspDocumentServiceFactory(localOdspSnapshot),
-		codeLoader: await fluidFileConverter.getCodeLoader(logger),
-		scope: await fluidFileConverter.getScope?.(logger),
-		logger,
-	});
+	const fn = async () => {
+		const loader = new Loader({
+			urlResolver: new FakeUrlResolver(),
+			documentServiceFactory: createLocalOdspDocumentServiceFactory(localOdspSnapshot),
+			codeLoader: await fluidFileConverter.getCodeLoader(logger),
+			scope: await fluidFileConverter.getScope?.(logger),
+			logger,
+		});
+
+		const container = await loader.resolve({
+			url: "/fakeUrl/",
+			headers: {
+				[LoaderHeader.loadMode]: { opsBeforeReturn: "cached" },
+			},
+		});
 
-	const container = await loader.resolve({
-		url: "/fakeUrl/",
-		headers: {
-			[LoaderHeader.loadMode]: { opsBeforeReturn: "cached" },
-		},
-	});
+		return PerformanceEvent.timedExecAsync(logger, { eventName: "ExportFile" }, async () => {
+			const result = await fluidFileConverter.execute(container, options);
+			container.close();
+			return result;
+		});
+	};
 
-	return PerformanceEvent.timedExecAsync(logger, { eventName: "ExportFile" }, async () => {
-		const result = await fluidFileConverter.execute(container, options);
-		container.close();
-		return result;
-	});
+	// eslint-disable-next-line unicorn/prefer-ternary
+	if (timeout !== undefined) {
+		return timeoutPromise<string>((resolve, reject) => {
+			fn()
+				.then((value) => resolve(value))
+				.catch((error) => reject(error));
+		}, timeout);
+	} else {
+		return fn();
+	}
 }

package/src/fluidRunner.ts

@@ -71,6 +71,11 @@ export function fluidRunner(fluidFileConverter?: IFluidFileConverter) {
 							"Number of telemetry events per flush to telemetryFile (only applicable for JSON format)",
 						type: "number",
 						demandOption: false,
+					})
+					.option("timeout", {
+						describe: "Allowed timeout in ms before process is automatically cancelled",
+						type: "number",
+						demandOption: false,
 					}),
 			// eslint-disable-next-line @typescript-eslint/no-misused-promises
 			async (argv) => {
@@ -97,6 +102,7 @@ export function fluidRunner(fluidFileConverter?: IFluidFileConverter) {
 							argv.telemetryFile,
 							argv.options,
 							telemetryOptionsResult.telemetryOptions,
+							argv.timeout,
 					  )
 					: exportFile(
 							fluidFileConverter!,
@@ -105,6 +111,7 @@ export function fluidRunner(fluidFileConverter?: IFluidFileConverter) {
 							argv.telemetryFile,
 							argv.options,
 							telemetryOptionsResult.telemetryOptions,
+							argv.timeout,
 					  ));
 
 				if (!result.success) {

package/src/index.ts

@@ -7,8 +7,12 @@
 export { ICodeLoaderBundle, IFluidFileConverter } from "./codeLoaderBundle";
 export { createContainerAndExecute, exportFile, IExportFileResponse } from "./exportFile";
 export { fluidRunner } from "./fluidRunner";
-export { OutputFormat } from "./logger/fileLogger";
-export { createLogger, getTelemetryFileValidationError } from "./logger/loggerUtils";
+export { OutputFormat, ITelemetryOptions } from "./logger/fileLogger";
+export {
+	createLogger,
+	getTelemetryFileValidationError,
+	validateAndParseTelemetryOptions,
+} from "./logger/loggerUtils";
 export { parseBundleAndExportFile } from "./parseBundleAndExportFile";
 export { getSnapshotFileContent } from "./utils";
 /* eslint-enable import/no-internal-modules */

package/src/logger/fileLogger.ts

@@ -27,7 +27,6 @@ export enum OutputFormat {
 /* eslint-disable tsdoc/syntax */
 /**
  * Options to provide upon creation of IFileLogger
- * @internal
  */
 export interface ITelemetryOptions {
 	/** Desired output format used to create a specific IFileLogger implementation */

package/src/logger/loggerUtils.ts

@@ -51,7 +51,6 @@ export function getTelemetryFileValidationError(telemetryFile: string): string |
  * Validate the provided output format and default properties
  * @param format - desired output format of the telemetry
  * @param props - default properties to be added to every telemetry entry
- * @internal
  */
 export function validateAndParseTelemetryOptions(
 	format?: string,

package/src/parseBundleAndExportFile.ts

@@ -7,12 +7,11 @@ import * as fs from "fs";
 import { PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { isCodeLoaderBundle, isFluidFileConverter } from "./codeLoaderBundle";
 import { createContainerAndExecute, IExportFileResponse } from "./exportFile";
-import { getArgsValidationError } from "./getArgsValidationError";
 /* eslint-disable import/no-internal-modules */
 import { ITelemetryOptions } from "./logger/fileLogger";
 import { createLogger, getTelemetryFileValidationError } from "./logger/loggerUtils";
 /* eslint-enable import/no-internal-modules */
-import { getSnapshotFileContent } from "./utils";
+import { getSnapshotFileContent, getArgsValidationError } from "./utils";
 
 const clientArgsValidationError = "Client_ArgsValidationError";
 
@@ -27,6 +26,7 @@ export async function parseBundleAndExportFile(
 	telemetryFile: string,
 	options?: string,
 	telemetryOptions?: ITelemetryOptions,
+	timeout?: number,
 ): Promise<IExportFileResponse> {
 	const telemetryArgError = getTelemetryFileValidationError(telemetryFile);
 	if (telemetryArgError) {
@@ -58,7 +58,7 @@ export async function parseBundleAndExportFile(
 					return { success: false, eventName, errorMessage };
 				}
 
-				const argsValidationError = getArgsValidationError(inputFile, outputFile);
+				const argsValidationError = getArgsValidationError(inputFile, outputFile, timeout);
 				if (argsValidationError) {
 					const eventName = clientArgsValidationError;
 					logger.sendErrorEvent({ eventName, message: argsValidationError });
@@ -72,6 +72,7 @@ export async function parseBundleAndExportFile(
 						fluidExport,
 						logger,
 						options,
+						timeout,
 					),
 				);
 

package/src/utils.ts

@@ -42,3 +42,58 @@ export function validateCommandLineArgs(
 	}
 	return undefined;
 }
+
+/**
+ * @internal
+ */
+export function getArgsValidationError(
+	inputFile: string,
+	outputFile: string,
+	timeout?: number,
+): string | undefined {
+	// Validate input file
+	if (!inputFile) {
+		return "Input file name argument is missing.";
+	} else if (!fs.existsSync(inputFile)) {
+		return "Input file does not exist.";
+	}
+
+	// Validate output file
+	if (!outputFile) {
+		return "Output file argument is missing.";
+	} else if (fs.existsSync(outputFile)) {
+		return `Output file already exists [${outputFile}].`;
+	}
+
+	if (timeout !== undefined && (isNaN(timeout) || timeout < 0)) {
+		return "Invalid timeout";
+	}
+
+	return undefined;
+}
+
+/**
+ * @internal
+ */
+export async function timeoutPromise<T = void>(
+	executor: (
+		resolve: (value: T | PromiseLike<T>) => void,
+		reject: (reason?: any) => void,
+	) => void,
+	timeout: number,
+): Promise<T> {
+	return new Promise<T>((resolve, reject) => {
+		const timer = setTimeout(() => reject(new Error(`Timed out (${timeout}ms)`)), timeout);
+
+		executor(
+			(value) => {
+				clearTimeout(timer);
+				resolve(value);
+			},
+			(reason) => {
+				clearTimeout(timer);
+				reject(reason);
+			},
+		);
+	});
+}

package/dist/getArgsValidationError.d.ts

@@ -1,6 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export declare function getArgsValidationError(inputFile: string, outputFile: string): string | undefined;
-//# sourceMappingURL=getArgsValidationError.d.ts.map

package/dist/getArgsValidationError.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getArgsValidationError.d.ts","sourceRoot":"","sources":["../src/getArgsValidationError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgBhG"}

package/dist/getArgsValidationError.js

@@ -1,46 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getArgsValidationError = void 0;
-const fs = __importStar(require("fs"));
-function getArgsValidationError(inputFile, outputFile) {
-    // Validate input file
-    if (!inputFile) {
-        return "Input file name argument is missing.";
-    }
-    else if (!fs.existsSync(inputFile)) {
-        return "Input file does not exist.";
-    }
-    // Validate output file
-    if (!outputFile) {
-        return "Output file argument is missing.";
-    }
-    else if (fs.existsSync(outputFile)) {
-        return `Output file already exists [${outputFile}].`;
-    }
-    return undefined;
-}
-exports.getArgsValidationError = getArgsValidationError;
-//# sourceMappingURL=getArgsValidationError.js.map

package/dist/getArgsValidationError.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getArgsValidationError.js","sourceRoot":"","sources":["../src/getArgsValidationError.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AAEzB,SAAgB,sBAAsB,CAAC,SAAiB,EAAE,UAAkB;IAC3E,sBAAsB;IACtB,IAAI,CAAC,SAAS,EAAE;QACf,OAAO,sCAAsC,CAAC;KAC9C;SAAM,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QACrC,OAAO,4BAA4B,CAAC;KACpC;IAED,uBAAuB;IACvB,IAAI,CAAC,UAAU,EAAE;QAChB,OAAO,kCAAkC,CAAC;KAC1C;SAAM,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;QACrC,OAAO,+BAA+B,UAAU,IAAI,CAAC;KACrD;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAhBD,wDAgBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as fs from \"fs\";\n\nexport function getArgsValidationError(inputFile: string, outputFile: string): string | undefined {\n\t// Validate input file\n\tif (!inputFile) {\n\t\treturn \"Input file name argument is missing.\";\n\t} else if (!fs.existsSync(inputFile)) {\n\t\treturn \"Input file does not exist.\";\n\t}\n\n\t// Validate output file\n\tif (!outputFile) {\n\t\treturn \"Output file argument is missing.\";\n\t} else if (fs.existsSync(outputFile)) {\n\t\treturn `Output file already exists [${outputFile}].`;\n\t}\n\n\treturn undefined;\n}\n"]}

package/lib/getArgsValidationError.d.ts

@@ -1,6 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export declare function getArgsValidationError(inputFile: string, outputFile: string): string | undefined;
-//# sourceMappingURL=getArgsValidationError.d.ts.map

package/lib/getArgsValidationError.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getArgsValidationError.d.ts","sourceRoot":"","sources":["../src/getArgsValidationError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgBhG"}

package/lib/getArgsValidationError.js

@@ -1,23 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import * as fs from "fs";
-export function getArgsValidationError(inputFile, outputFile) {
-    // Validate input file
-    if (!inputFile) {
-        return "Input file name argument is missing.";
-    }
-    else if (!fs.existsSync(inputFile)) {
-        return "Input file does not exist.";
-    }
-    // Validate output file
-    if (!outputFile) {
-        return "Output file argument is missing.";
-    }
-    else if (fs.existsSync(outputFile)) {
-        return `Output file already exists [${outputFile}].`;
-    }
-    return undefined;
-}
-//# sourceMappingURL=getArgsValidationError.js.map

package/lib/getArgsValidationError.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getArgsValidationError.js","sourceRoot":"","sources":["../src/getArgsValidationError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAEzB,MAAM,UAAU,sBAAsB,CAAC,SAAiB,EAAE,UAAkB;IAC3E,sBAAsB;IACtB,IAAI,CAAC,SAAS,EAAE;QACf,OAAO,sCAAsC,CAAC;KAC9C;SAAM,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QACrC,OAAO,4BAA4B,CAAC;KACpC;IAED,uBAAuB;IACvB,IAAI,CAAC,UAAU,EAAE;QAChB,OAAO,kCAAkC,CAAC;KAC1C;SAAM,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;QACrC,OAAO,+BAA+B,UAAU,IAAI,CAAC;KACrD;IAED,OAAO,SAAS,CAAC;AAClB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as fs from \"fs\";\n\nexport function getArgsValidationError(inputFile: string, outputFile: string): string | undefined {\n\t// Validate input file\n\tif (!inputFile) {\n\t\treturn \"Input file name argument is missing.\";\n\t} else if (!fs.existsSync(inputFile)) {\n\t\treturn \"Input file does not exist.\";\n\t}\n\n\t// Validate output file\n\tif (!outputFile) {\n\t\treturn \"Output file argument is missing.\";\n\t} else if (fs.existsSync(outputFile)) {\n\t\treturn `Output file already exists [${outputFile}].`;\n\t}\n\n\treturn undefined;\n}\n"]}

package/src/getArgsValidationError.ts

@@ -1,24 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import * as fs from "fs";
-
-export function getArgsValidationError(inputFile: string, outputFile: string): string | undefined {
-	// Validate input file
-	if (!inputFile) {
-		return "Input file name argument is missing.";
-	} else if (!fs.existsSync(inputFile)) {
-		return "Input file does not exist.";
-	}
-
-	// Validate output file
-	if (!outputFile) {
-		return "Output file argument is missing.";
-	} else if (fs.existsSync(outputFile)) {
-		return `Output file already exists [${outputFile}].`;
-	}
-
-	return undefined;
-}