@fluidframework/fluid-runner 2.0.0-dev.1.3.0.96595

package/src/logger/loggerUtils.ts

@@ -0,0 +1,81 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import * as fs from "fs";
+import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { ChildLogger } from "@fluidframework/telemetry-utils";
+import { CSVFileLogger } from "./csvFileLogger";
+import { IFileLogger, ITelemetryOptions, OutputFormat } from "./fileLogger";
+import { JSONFileLogger } from "./jsonFileLogger";
+
+/**
+ * Create a ITelemetryLogger wrapped around provided IFileLogger
+ * ! It is expected that all events be sent through the returned "logger" value
+ * ! The "fileLogger" value should have its "close()" method called at the end of execution
+ * Note: if an output format is not supplied, default is JSON
+ * @returns - both the IFileLogger implementation and ITelemetryLogger wrapper to be called
+ */
+ export function createLogger(
+    filePath: string,
+    options?: ITelemetryOptions,
+): { logger: ITelemetryLogger; fileLogger: IFileLogger; } {
+    const fileLogger = options?.outputFormat === OutputFormat.CSV
+        ? new CSVFileLogger(filePath, options?.eventsPerFlush, options?.defaultProps)
+        : new JSONFileLogger(filePath, options?.eventsPerFlush, options?.defaultProps);
+
+    const logger = ChildLogger.create(fileLogger, "LocalSnapshotRunnerApp",
+        { all: { Event_Time: () => Date.now() } });
+
+    return { logger, fileLogger };
+}
+
+/**
+ * Validate the telemetryFile command line argument
+ * @param telemetryFile - path where telemetry will be written
+ */
+export function getTelemetryFileValidationError(telemetryFile: string): string | undefined {
+    if (!telemetryFile) {
+        return "Telemetry file argument is missing.";
+    } else if (fs.existsSync(telemetryFile)) {
+        return `Telemetry file already exists [${telemetryFile}].`;
+    }
+
+    return undefined;
+}
+
+/**
+ * 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,
+    props?: (string | number)[],
+): { success: false; error: string; } | { success: true; telemetryOptions: ITelemetryOptions; } {
+    let outputFormat: OutputFormat | undefined;
+    const defaultProps: Record<string, string | number> = {};
+
+    if (format) {
+        outputFormat = OutputFormat[format];
+        if (outputFormat === undefined) {
+            return { success: false, error: `Invalid telemetry format [${format}]` };
+        }
+    }
+
+    if (props && props.length > 0) {
+        if (props.length % 2 !== 0) {
+            return { success: false, error: `Invalid number of telemetry properties to add [${props.length}]` };
+        }
+        for (let i = 0; i < props.length; i += 2) {
+            if (typeof props[i] === "number") {
+                return { success: false, error: `Property name cannot be number at index [${i}] -> [${props[i]}]` };
+            }
+            defaultProps[props[i]] = props[i + 1];
+        }
+    }
+
+    return { success: true, telemetryOptions: { outputFormat, defaultProps } };
+}

package/src/packageVersion.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ *
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
+ */
+
+export const pkgName = "@fluidframework/fluid-runner";
+export const pkgVersion = "1.2.0";

package/src/parseBundleAndExportFile.ts

@@ -0,0 +1,80 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+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";
+
+const clientArgsValidationError = "Client_ArgsValidationError";
+
+/**
+ * Parse a provided JS bundle, execute code on Container based on ODSP snapshot, and write result to file
+ * @param codeLoader - path to provided JS bundle that implements ICodeLoaderBundle (see codeLoaderBundle.ts)
+ */
+export async function parseBundleAndExportFile(
+    codeLoader: string,
+    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);
+
+    try {
+        return await PerformanceEvent.timedExecAsync(logger, { eventName: "ParseBundleAndExportFile" }, async () => {
+            // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires
+            const codeLoaderBundle = require(codeLoader);
+            if (!isCodeLoaderBundle(codeLoaderBundle)) {
+                const eventName = clientArgsValidationError;
+                const errorMessage = "Code loader bundle is not of type ICodeLoaderBundle";
+                logger.sendErrorEvent({ eventName, message: errorMessage });
+                return { success: false, eventName, errorMessage };
+            }
+
+            const fluidExport = await codeLoaderBundle.fluidExport;
+            if (!isFluidFileConverter(fluidExport)) {
+                const eventName = clientArgsValidationError;
+                const errorMessage = "Fluid export from CodeLoaderBundle is not of type IFluidFileConverter";
+                logger.sendErrorEvent({ eventName, message: errorMessage });
+                return { success: false, eventName, errorMessage };
+            }
+
+            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),
+                fluidExport,
+                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();
+    }
+}

package/src/utils.ts

@@ -0,0 +1,45 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import * as fs from "fs";
+import { IFluidFileConverter } from "./codeLoaderBundle";
+
+/**
+ * Is the given snapshot in JSON format
+ * @param content - snapshot file content
+ * @internal
+ */
+export function isJsonSnapshot(content: Buffer): boolean {
+    return content.toString(undefined, 0, 1) === "{";
+}
+
+/**
+ * Get the ODSP snapshot file content
+ * Works on both JSON and binary snapshot formats
+ * @param filePath - path to the ODSP snapshot file
+ */
+export function getSnapshotFileContent(filePath: string): string | Buffer {
+    // TODO: read file stream
+    const content = fs.readFileSync(filePath);
+    return isJsonSnapshot(content) ? content.toString() : content;
+}
+
+/**
+ * Validate provided command line arguments
+ * @internal
+ */
+ export function validateCommandLineArgs(
+    codeLoader?: string,
+    fluidFileConverter?: IFluidFileConverter,
+): string | undefined {
+    if (codeLoader && fluidFileConverter !== undefined) {
+        return "\"codeLoader\" and \"fluidFileConverter\" cannot both be provided. See README for details.";
+    }
+    if (!codeLoader && fluidFileConverter === undefined) {
+        // eslint-disable-next-line max-len
+        return "\"codeLoader\" must be provided if there is no explicit \"fluidFileConverter\". See README for details.";
+    }
+    return undefined;
+}

package/tsconfig.esnext.json

@@ -0,0 +1,7 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "outDir": "./lib",
+        "module": "esnext"
+    },
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+    "extends": "@fluidframework/build-common/ts-common-config.json",
+    "exclude": [
+        "src/test/**/*"
+    ],
+    "compilerOptions": {
+        "rootDir": "./src",
+        "outDir": "./dist",
+        "composite": true
+    },
+    "include": [
+        "src/**/*"
+    ]
+}