@fluidframework/fluid-runner 2.0.0-dev.2.3.0.115467 → 2.0.0-dev.3.1.0.125672

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/fluid-runner",
-  "version": "2.0.0-dev.2.3.0.115467",
+  "version": "2.0.0-dev.3.1.0.125672",
   "description": "Utility for running various functionality inside a Fluid Framework environment",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -27,8 +27,8 @@
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run prettier:fix",
-    "lint": "npm run eslint",
-    "lint:fix": "npm run eslint:fix",
+    "lint": "npm run prettier && npm run eslint",
+    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
     "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
     "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
     "test": "npm run test:mocha",
@@ -58,27 +58,28 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/aqueduct": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
+    "@fluidframework/aqueduct": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/container-definitions": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
-    "@fluidframework/container-loader": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
-    "@fluidframework/odsp-driver": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
-    "@fluidframework/odsp-driver-definitions": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
+    "@fluidframework/container-definitions": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
+    "@fluidframework/container-loader": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
+    "@fluidframework/driver-definitions": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
+    "@fluidframework/odsp-driver": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
+    "@fluidframework/odsp-driver-definitions": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
     "json2csv": "^5.0.7",
     "yargs": "13.2.2"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.7.0",
+    "@fluid-tools/build-cli": "^0.8.0",
     "@fluidframework/build-common": "^1.1.0",
-    "@fluidframework/eslint-config-fluid": "^1.2.0",
-    "@fluidframework/fluid-runner-previous": "npm:@fluidframework/fluid-runner@2.0.0-internal.2.2.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-dev.2.3.0.115467 <2.0.0-dev.3.0.0",
+    "@fluidframework/eslint-config-fluid": "^2.0.0",
+    "@fluidframework/fluid-runner-previous": "npm:@fluidframework/fluid-runner@2.0.0-internal.3.0.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^14.18.0",
+    "@types/node": "^14.18.36",
+    "@types/yargs": "^13",
     "concurrently": "^6.2.0",
     "cross-env": "^7.0.2",
     "eslint": "~8.6.0",
@@ -89,9 +90,10 @@
     "typescript": "~4.5.5"
   },
   "typeValidation": {
-    "version": "2.0.0-internal.2.3.0",
-    "baselineRange": ">=2.0.0-internal.2.2.0 <2.0.0-internal.2.3.0",
-    "baselineVersion": "2.0.0-internal.2.2.0",
+    "version": "2.0.0-internal.3.1.0",
+    "previousVersionStyle": "~previousMinor",
+    "baselineRange": ">=2.0.0-internal.3.0.0 <2.0.0-internal.3.1.0",
+    "baselineVersion": "2.0.0-internal.3.0.0",
     "broken": {}
   }
 }

package/prettier.config.cjs

@@ -4,5 +4,5 @@
  */
 
 module.exports = {
-    ...require("@fluidframework/build-common/prettier.config.cjs"),
+	...require("@fluidframework/build-common/prettier.config.cjs"),
 };

package/src/codeLoaderBundle.ts

@@ -12,33 +12,33 @@ import { FluidObject } from "@fluidframework/core-interfaces";
  * For an example, see "src/test/sampleCodeLoaders/sampleCodeLoader.ts"
  */
 export interface ICodeLoaderBundle {
-    /**
-     * Fluid export of all the required objects and functions
-     */
-    fluidExport: Promise<IFluidFileConverter>;
+	/**
+	 * Fluid export of all the required objects and functions
+	 */
+	fluidExport: Promise<IFluidFileConverter>;
 }
 
 /**
  * Instance that holds all the details for Fluid file conversion
  */
 export interface IFluidFileConverter {
-    /**
-     * Get code loader details to provide at Loader creation
-     * @param logger - created logger object to pass to code loader
-     */
-    getCodeLoader(logger: ITelemetryBaseLogger): Promise<ICodeDetailsLoader>;
+	/**
+	 * Get code loader details to provide at Loader creation
+	 * @param logger - created logger object to pass to code loader
+	 */
+	getCodeLoader(logger: ITelemetryBaseLogger): Promise<ICodeDetailsLoader>;
 
-    /**
-     * Scope object to provide at Loader creation
-     */
-    scope?: FluidObject;
+	/**
+	 * Scope object to provide at Loader creation
+	 */
+	scope?: FluidObject;
 
-    /**
-     * Executes code on container and returns the result
-     * @param container - container created by this application
-     * @param options - additional options
-     */
-    execute(container: IContainer, options?: string): Promise<string>;
+	/**
+	 * Executes code on container and returns the result
+	 * @param container - container created by this application
+	 * @param options - additional options
+	 */
+	execute(container: IContainer, options?: string): Promise<string>;
 }
 
 /**
@@ -46,12 +46,16 @@ export interface IFluidFileConverter {
  * @param bundle - bundle provided to this application
  */
 export function isCodeLoaderBundle(bundle: any): bundle is ICodeLoaderBundle {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
-    return bundle?.fluidExport && typeof bundle.fluidExport === "object";
+	// eslint-disable-next-line @typescript-eslint/no-unsafe-return
+	return bundle?.fluidExport && typeof bundle.fluidExport === "object";
 }
 
 export function isFluidFileConverter(obj: any): obj is IFluidFileConverter {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
-    return obj?.getCodeLoader && typeof obj.getCodeLoader === "function"
-        && obj.execute && typeof obj.execute === "function";
+	// eslint-disable-next-line @typescript-eslint/no-unsafe-return
+	return (
+		obj?.getCodeLoader &&
+		typeof obj.getCodeLoader === "function" &&
+		obj.execute &&
+		typeof obj.execute === "function"
+	);
 }

package/src/exportFile.ts

@@ -21,14 +21,14 @@ import { createLogger, getTelemetryFileValidationError } from "./logger/loggerUt
 export type IExportFileResponse = IExportFileResponseSuccess | IExportFileResponseFailure;
 
 interface IExportFileResponseSuccess {
-    success: true;
+	success: true;
 }
 
 interface IExportFileResponseFailure {
-    success: false;
-    eventName: string;
-    errorMessage: string;
-    error?: any;
+	success: false;
+	eventName: string;
+	errorMessage: string;
+	error?: any;
 }
 
 const clientArgsValidationError = "Client_ArgsValidationError";
@@ -37,45 +37,52 @@ const clientArgsValidationError = "Client_ArgsValidationError";
  * Execute code on Container based on ODSP snapshot and write result to file
  */
 export async function exportFile(
-    fluidFileConverter: IFluidFileConverter,
-    inputFile: string,
-    outputFile: string,
-    telemetryFile: string,
-    options?: string,
-    telemetryOptions?: ITelemetryOptions,
+	fluidFileConverter: IFluidFileConverter,
+	inputFile: string,
+	outputFile: string,
+	telemetryFile: string,
+	options?: string,
+	telemetryOptions?: ITelemetryOptions,
 ): Promise<IExportFileResponse> {
-    const telemetryArgError = getTelemetryFileValidationError(telemetryFile);
-    if (telemetryArgError) {
-        const eventName = clientArgsValidationError;
-        return { success: false, eventName, errorMessage: telemetryArgError };
-    }
-    const { fileLogger, logger } = createLogger(telemetryFile, telemetryOptions);
+	const telemetryArgError = getTelemetryFileValidationError(telemetryFile);
+	if (telemetryArgError) {
+		const eventName = clientArgsValidationError;
+		return { success: false, eventName, errorMessage: telemetryArgError };
+	}
+	const { fileLogger, logger } = createLogger(telemetryFile, telemetryOptions);
 
-    try {
-        return await PerformanceEvent.timedExecAsync(logger, { eventName: "ExportFile" }, async () => {
-            const argsValidationError = getArgsValidationError(inputFile, outputFile);
-            if (argsValidationError) {
-                const eventName = clientArgsValidationError;
-                logger.sendErrorEvent({ eventName, message: argsValidationError });
-                return { success: false, eventName, errorMessage: argsValidationError };
-            }
+	try {
+		return await PerformanceEvent.timedExecAsync(
+			logger,
+			{ eventName: "ExportFile" },
+			async () => {
+				const argsValidationError = getArgsValidationError(inputFile, outputFile);
+				if (argsValidationError) {
+					const eventName = clientArgsValidationError;
+					logger.sendErrorEvent({ eventName, message: argsValidationError });
+					return { success: false, eventName, errorMessage: argsValidationError };
+				}
 
-            fs.writeFileSync(outputFile, await createContainerAndExecute(
-                getSnapshotFileContent(inputFile),
-                fluidFileConverter,
-                logger,
-                options,
-            ));
+				fs.writeFileSync(
+					outputFile,
+					await createContainerAndExecute(
+						getSnapshotFileContent(inputFile),
+						fluidFileConverter,
+						logger,
+						options,
+					),
+				);
 
-            return { success: true };
-        });
-    } catch (error) {
-        const eventName = "Client_UnexpectedError";
-        logger.sendErrorEvent({ eventName }, error);
-        return { success: false, eventName, errorMessage: "Unexpected error", error };
-    } finally {
-        await fileLogger.close();
-    }
+				return { success: true };
+			},
+		);
+	} catch (error) {
+		const eventName = "Client_UnexpectedError";
+		logger.sendErrorEvent({ eventName }, error);
+		return { success: false, eventName, errorMessage: "Unexpected error", error };
+	} finally {
+		await fileLogger.close();
+	}
 }
 
 /**
@@ -83,25 +90,29 @@ export async function exportFile(
  * @returns result of execution
  */
 export async function createContainerAndExecute(
-    localOdspSnapshot: string | Uint8Array,
-    fluidFileConverter: IFluidFileConverter,
-    logger: ITelemetryLogger,
-    options?: string,
+	localOdspSnapshot: string | Uint8Array,
+	fluidFileConverter: IFluidFileConverter,
+	logger: ITelemetryLogger,
+	options?: string,
 ): Promise<string> {
-    const loader = new Loader({
-        urlResolver: new FakeUrlResolver(),
-        documentServiceFactory: createLocalOdspDocumentServiceFactory(localOdspSnapshot),
-        codeLoader: await fluidFileConverter.getCodeLoader(logger),
-        scope: fluidFileConverter.scope,
-        logger,
-    });
+	const loader = new Loader({
+		urlResolver: new FakeUrlResolver(),
+		documentServiceFactory: createLocalOdspDocumentServiceFactory(localOdspSnapshot),
+		codeLoader: await fluidFileConverter.getCodeLoader(logger),
+		scope: fluidFileConverter.scope,
+		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;
+	});
 }

package/src/fakeUrlResolver.ts

@@ -4,7 +4,11 @@
  */
 
 import { IRequest } from "@fluidframework/core-interfaces";
-import { IContainerPackageInfo, IResolvedUrl, IUrlResolver } from "@fluidframework/driver-definitions";
+import {
+	IContainerPackageInfo,
+	IResolvedUrl,
+	IUrlResolver,
+} from "@fluidframework/driver-definitions";
 import { IOdspResolvedUrl } from "@fluidframework/odsp-driver-definitions";
 
 const fakeId = "FakeUrlResolver";
@@ -15,36 +19,36 @@ const fakeUrl = "/FakeUrlResolver/";
  * @internal
  */
 export class FakeUrlResolver implements IUrlResolver {
-    public async resolve(_request: IRequest): Promise<IResolvedUrl | undefined> {
-        const fakeOdspResolvedUrl: IOdspResolvedUrl = {
-            type: "fluid",
-            odspResolvedUrl: true,
-            id: fakeId,
-            siteUrl: fakeUrl,
-            driveId: fakeId,
-            itemId: fakeId,
-            url: fakeUrl,
-            hashedDocumentId: fakeId,
-            endpoints: {
-                snapshotStorageUrl: fakeUrl,
-                attachmentPOSTStorageUrl: fakeUrl,
-                attachmentGETStorageUrl: fakeUrl,
-                deltaStorageUrl: fakeUrl,
-            },
-            tokens: {},
-            fileName: fakeId,
-            summarizer: false,
-            fileVersion: fakeId,
-        };
+	public async resolve(_request: IRequest): Promise<IResolvedUrl | undefined> {
+		const fakeOdspResolvedUrl: IOdspResolvedUrl = {
+			type: "fluid",
+			odspResolvedUrl: true,
+			id: fakeId,
+			siteUrl: fakeUrl,
+			driveId: fakeId,
+			itemId: fakeId,
+			url: fakeUrl,
+			hashedDocumentId: fakeId,
+			endpoints: {
+				snapshotStorageUrl: fakeUrl,
+				attachmentPOSTStorageUrl: fakeUrl,
+				attachmentGETStorageUrl: fakeUrl,
+				deltaStorageUrl: fakeUrl,
+			},
+			tokens: {},
+			fileName: fakeId,
+			summarizer: false,
+			fileVersion: fakeId,
+		};
 
-        return fakeOdspResolvedUrl;
-    }
+		return fakeOdspResolvedUrl;
+	}
 
-    public async getAbsoluteUrl(
-        _resolvedUrl: IResolvedUrl,
-        _relativeUrl: string,
-        _packageInfoSource?: IContainerPackageInfo,
-    ): Promise<string> {
-        return "";
-    }
+	public async getAbsoluteUrl(
+		_resolvedUrl: IResolvedUrl,
+		_relativeUrl: string,
+		_packageInfoSource?: IContainerPackageInfo,
+	): Promise<string> {
+		return "";
+	}
 }

package/src/fluidRunner.ts

@@ -3,7 +3,6 @@
  * Licensed under the MIT License.
  */
 
-/* eslint-disable max-len */
 import * as yargs from "yargs";
 import { exportFile } from "./exportFile";
 import { IFluidFileConverter } from "./codeLoaderBundle";
@@ -16,90 +15,98 @@ import { validateCommandLineArgs } from "./utils";
  * @param fluidFileConverter - needs to be provided if "codeLoaderBundle" is not and vice versa
  */
 export function fluidRunner(fluidFileConverter?: IFluidFileConverter) {
-    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
-    yargs
-        .strict()
-        .version(false)
-        .command(
-            "exportFile",
-            "Generate an output for a local ODSP snapshot",
-            // eslint-disable-next-line @typescript-eslint/no-shadow
-            (yargs) =>
-                yargs
-                    .option("codeLoader", {
-                        describe: "Path to code loader bundle. Required if this application is being called without modification.\nSee \"README.md\" for more details.",
-                        type: "string",
-                        demandOption: false,
-                    })
-                    .option("inputFile", {
-                        describe: "Path to local ODSP snapshot",
-                        type: "string",
-                        demandOption: true,
-                    })
-                    .option("outputFile", {
-                        describe: "Path of output file (cannot already exist).\nExecution result will be written here",
-                        type: "string",
-                        demandOption: true,
-                    })
-                    .option("telemetryFile", {
-                        describe: "Path of telemetry file for config and session data (cannot already exist)",
-                        type: "string",
-                        demandOption: true,
-                    })
-                    .option("options", {
-                        describe: "Additional options passed to container on execution",
-                        type: "string",
-                        demandOption: false,
-                    })
-                    .option("telemetryFormat", {
-                        describe: "Output format for telemetry. Current options are: [\"JSON\", \"CSV\"]",
-                        type: "string",
-                        demandOption: false,
-                        default: "JSON",
-                    })
-                    .option("telemetryProp", {
-                        describe: "Property to add to every telemetry entry. Formatted like \"--telemetryProp prop1 value1 --telemetryProp prop2 \\\"value 2\\\"\".",
-                        type: "array",
-                        demandOption: false,
-                    }),
-            // eslint-disable-next-line @typescript-eslint/no-misused-promises
-            async (argv) => {
-                const argsError = validateCommandLineArgs(argv.codeLoader, fluidFileConverter);
-                if (argsError) {
-                    console.error(argsError);
-                    process.exit(1);
-                }
-                const telemetryOptionsResult = validateAndParseTelemetryOptions(argv.telemetryFormat, argv.telemetryProp);
-                if (!telemetryOptionsResult.success) {
-                    console.error(telemetryOptionsResult.error);
-                    process.exit(1);
-                }
+	// eslint-disable-next-line @typescript-eslint/no-unused-expressions
+	yargs
+		.strict()
+		.version(false)
+		.command(
+			"exportFile",
+			"Generate an output for a local ODSP snapshot",
+			// eslint-disable-next-line @typescript-eslint/no-shadow
+			(yargs) =>
+				yargs
+					.option("codeLoader", {
+						describe:
+							'Path to code loader bundle. Required if this application is being called without modification.\nSee "README.md" for more details.',
+						type: "string",
+						demandOption: false,
+					})
+					.option("inputFile", {
+						describe: "Path to local ODSP snapshot",
+						type: "string",
+						demandOption: true,
+					})
+					.option("outputFile", {
+						describe:
+							"Path of output file (cannot already exist).\nExecution result will be written here",
+						type: "string",
+						demandOption: true,
+					})
+					.option("telemetryFile", {
+						describe:
+							"Path of telemetry file for config and session data (cannot already exist)",
+						type: "string",
+						demandOption: true,
+					})
+					.option("options", {
+						describe: "Additional options passed to container on execution",
+						type: "string",
+						demandOption: false,
+					})
+					.option("telemetryFormat", {
+						describe:
+							'Output format for telemetry. Current options are: ["JSON", "CSV"]',
+						type: "string",
+						demandOption: false,
+						default: "JSON",
+					})
+					.option("telemetryProp", {
+						describe:
+							'Property to add to every telemetry entry. Formatted like "--telemetryProp prop1 value1 --telemetryProp prop2 \\"value 2\\"".',
+						type: "array",
+						demandOption: false,
+					}),
+			// eslint-disable-next-line @typescript-eslint/no-misused-promises
+			async (argv) => {
+				const argsError = validateCommandLineArgs(argv.codeLoader, fluidFileConverter);
+				if (argsError) {
+					console.error(argsError);
+					process.exit(1);
+				}
+				const telemetryOptionsResult = validateAndParseTelemetryOptions(
+					argv.telemetryFormat,
+					argv.telemetryProp,
+				);
+				if (!telemetryOptionsResult.success) {
+					console.error(telemetryOptionsResult.error);
+					process.exit(1);
+				}
 
-                const result = await (argv.codeLoader
-                    ? parseBundleAndExportFile(
-                        argv.codeLoader,
-                        argv.inputFile,
-                        argv.outputFile,
-                        argv.telemetryFile,
-                        argv.options,
-                        telemetryOptionsResult.telemetryOptions,
-                    ) : exportFile(
-                        fluidFileConverter!,
-                        argv.inputFile,
-                        argv.outputFile,
-                        argv.telemetryFile,
-                        argv.options,
-                        telemetryOptionsResult.telemetryOptions,
-                    ));
+				const result = await (argv.codeLoader
+					? parseBundleAndExportFile(
+							argv.codeLoader,
+							argv.inputFile,
+							argv.outputFile,
+							argv.telemetryFile,
+							argv.options,
+							telemetryOptionsResult.telemetryOptions,
+					  )
+					: exportFile(
+							fluidFileConverter!,
+							argv.inputFile,
+							argv.outputFile,
+							argv.telemetryFile,
+							argv.options,
+							telemetryOptionsResult.telemetryOptions,
+					  ));
 
-                if (!result.success) {
-                    console.error(`${result.eventName}: ${result.errorMessage}`);
-                    process.exit(1);
-                }
-                process.exit(0);
-            },
-        )
-        .help()
-        .demandCommand().argv;
+				if (!result.success) {
+					console.error(`${result.eventName}: ${result.errorMessage}`);
+					process.exit(1);
+				}
+				process.exit(0);
+			},
+		)
+		.help()
+		.demandCommand().argv;
 }
-/* eslint-enable max-len */

package/src/getArgsValidationError.ts

@@ -5,23 +5,20 @@
 
 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.";
-    }
+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}].`;
-    }
+	// Validate output file
+	if (!outputFile) {
+		return "Output file argument is missing.";
+	} else if (fs.existsSync(outputFile)) {
+		return `Output file already exists [${outputFile}].`;
+	}
 
-    return undefined;
+	return undefined;
 }