@fluidframework/fluid-runner 2.0.0-internal.1.2.1 → 2.0.0-internal.1.2.2

package/lib/utils.js

@@ -6,6 +6,7 @@ import * as fs from "fs";
 /**
  * Is the given snapshot in JSON format
  * @param content - snapshot file content
+ * @internal
  */
 export function isJsonSnapshot(content) {
     return content.toString(undefined, 0, 1) === "{";
@@ -20,4 +21,18 @@ export function getSnapshotFileContent(filePath) {
     const content = fs.readFileSync(filePath);
     return isJsonSnapshot(content) ? content.toString() : content;
 }
+/**
+ * Validate provided command line arguments
+ * @internal
+ */
+export function validateCommandLineArgs(codeLoader, fluidFileConverter) {
+    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;
+}
 //# sourceMappingURL=utils.js.map

package/lib/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAEzB;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,OAAe;IAC1C,OAAO,OAAO,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC;AACrD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,QAAgB;IACnD,yBAAyB;IACzB,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC1C,OAAO,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;AAClE,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\n/**\n * Is the given snapshot in JSON format\n * @param content - snapshot file content\n */\nexport function isJsonSnapshot(content: Buffer): boolean {\n    return content.toString(undefined, 0, 1) === \"{\";\n}\n\n/**\n * Get the ODSP snapshot file content\n * Works on both JSON and binary snapshot formats\n * @param filePath - path to the ODSP snapshot file\n */\nexport function getSnapshotFileContent(filePath: string): string | Buffer {\n    // TODO: read file stream\n    const content = fs.readFileSync(filePath);\n    return isJsonSnapshot(content) ? content.toString() : content;\n}\n"]}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAGzB;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,OAAe;IAC1C,OAAO,OAAO,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC;AACrD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,QAAgB;IACnD,yBAAyB;IACzB,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC1C,OAAO,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;AAClE,CAAC;AAED;;;GAGG;AACF,MAAM,UAAU,uBAAuB,CACpC,UAAmB,EACnB,kBAAwC;IAExC,IAAI,UAAU,IAAI,kBAAkB,KAAK,SAAS,EAAE;QAChD,OAAO,4FAA4F,CAAC;KACvG;IACD,IAAI,CAAC,UAAU,IAAI,kBAAkB,KAAK,SAAS,EAAE;QACjD,mCAAmC;QACnC,OAAO,yGAAyG,CAAC;KACpH;IACD,OAAO,SAAS,CAAC;AACrB,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\";\nimport { IFluidFileConverter } from \"./codeLoaderBundle\";\n\n/**\n * Is the given snapshot in JSON format\n * @param content - snapshot file content\n * @internal\n */\nexport function isJsonSnapshot(content: Buffer): boolean {\n    return content.toString(undefined, 0, 1) === \"{\";\n}\n\n/**\n * Get the ODSP snapshot file content\n * Works on both JSON and binary snapshot formats\n * @param filePath - path to the ODSP snapshot file\n */\nexport function getSnapshotFileContent(filePath: string): string | Buffer {\n    // TODO: read file stream\n    const content = fs.readFileSync(filePath);\n    return isJsonSnapshot(content) ? content.toString() : content;\n}\n\n/**\n * Validate provided command line arguments\n * @internal\n */\n export function validateCommandLineArgs(\n    codeLoader?: string,\n    fluidFileConverter?: IFluidFileConverter,\n): string | undefined {\n    if (codeLoader && fluidFileConverter !== undefined) {\n        return \"\\\"codeLoader\\\" and \\\"fluidFileConverter\\\" cannot both be provided. See README for details.\";\n    }\n    if (!codeLoader && fluidFileConverter === undefined) {\n        // eslint-disable-next-line max-len\n        return \"\\\"codeLoader\\\" must be provided if there is no explicit \\\"fluidFileConverter\\\". See README for details.\";\n    }\n    return undefined;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/fluid-runner",
-  "version": "2.0.0-internal.1.2.1",
+  "version": "2.0.0-internal.1.2.2",
   "description": "Utility for running various functionality inside a Fluid Framework environment",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -57,21 +57,22 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/aqueduct": "^2.0.0-internal.1.2.1",
+    "@fluidframework/aqueduct": "^2.0.0-internal.1.2.2",
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/container-definitions": "^2.0.0-internal.1.2.1",
-    "@fluidframework/container-loader": "^2.0.0-internal.1.2.1",
-    "@fluidframework/core-interfaces": "^2.0.0-internal.1.2.1",
-    "@fluidframework/driver-definitions": "^2.0.0-internal.1.2.1",
-    "@fluidframework/odsp-driver": "^2.0.0-internal.1.2.1",
-    "@fluidframework/odsp-driver-definitions": "^2.0.0-internal.1.2.1",
-    "@fluidframework/telemetry-utils": "^2.0.0-internal.1.2.1",
+    "@fluidframework/container-definitions": "^2.0.0-internal.1.2.2",
+    "@fluidframework/container-loader": "^2.0.0-internal.1.2.2",
+    "@fluidframework/core-interfaces": "^2.0.0-internal.1.2.2",
+    "@fluidframework/driver-definitions": "^2.0.0-internal.1.2.2",
+    "@fluidframework/odsp-driver": "^2.0.0-internal.1.2.2",
+    "@fluidframework/odsp-driver-definitions": "^2.0.0-internal.1.2.2",
+    "@fluidframework/telemetry-utils": "^2.0.0-internal.1.2.2",
+    "json2csv": "^5.0.7",
     "yargs": "13.2.2"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^1.0.0",
     "@fluidframework/eslint-config-fluid": "^1.0.0",
-    "@fluidframework/mocha-test-setup": "^2.0.0-internal.1.2.1",
+    "@fluidframework/mocha-test-setup": "^2.0.0-internal.1.2.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",
     "@types/node": "^14.18.0",

package/src/exportFile.ts

@@ -13,8 +13,10 @@ import { getArgsValidationError } from "./getArgsValidationError";
 import { IFluidFileConverter } from "./codeLoaderBundle";
 import { FakeUrlResolver } from "./fakeUrlResolver";
 import { getSnapshotFileContent } from "./utils";
-// eslint-disable-next-line import/no-internal-modules
-import { createLogger, FileLogger, getTelemetryFileValidationError } from "./logger/FileLogger";
+/* eslint-disable import/no-internal-modules */
+import { ITelemetryOptions } from "./logger/fileLogger";
+import { createLogger, getTelemetryFileValidationError } from "./logger/loggerUtils";
+/* eslint-enable import/no-internal-modules */
 
 export type IExportFileResponse = IExportFileResponseSuccess | IExportFileResponseFailure;
 
@@ -40,14 +42,14 @@ export async function exportFile(
     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 = new FileLogger(telemetryFile);
-    const logger = createLogger(fileLogger);
+    const { fileLogger, logger } = createLogger(telemetryFile, telemetryOptions);
 
     try {
         return await PerformanceEvent.timedExecAsync(logger, { eventName: "ExportFile" }, async () => {
@@ -72,7 +74,7 @@ export async function exportFile(
         logger.sendErrorEvent({ eventName }, error);
         return { success: false, eventName, errorMessage: "Unexpected error", error };
     } finally {
-        await fileLogger.flush();
+        await fileLogger.close();
     }
 }
 

package/src/fakeUrlResolver.ts

@@ -12,6 +12,7 @@ const fakeUrl = "/FakeUrlResolver/";
 
 /**
  * Fake URL resolver that returns hard coded values on every request
+ * @internal
  */
 export class FakeUrlResolver implements IUrlResolver {
     public async resolve(_request: IRequest): Promise<IResolvedUrl | undefined> {

package/src/fluidRunner.ts

@@ -3,10 +3,14 @@
  * Licensed under the MIT License.
  */
 
+/* eslint-disable max-len */
 import * as yargs from "yargs";
 import { exportFile } from "./exportFile";
 import { IFluidFileConverter } from "./codeLoaderBundle";
 import { parseBundleAndExportFile } from "./parseBundleAndExportFile";
+// eslint-disable-next-line import/no-internal-modules
+import { validateAndParseTelemetryOptions } from "./logger/loggerUtils";
+import { validateCommandLineArgs } from "./utils";
 
 /**
  * @param fluidFileConverter - needs to be provided if "codeLoaderBundle" is not and vice versa
@@ -23,7 +27,6 @@ export function fluidRunner(fluidFileConverter?: IFluidFileConverter) {
             (yargs) =>
                 yargs
                     .option("codeLoader", {
-                        // eslint-disable-next-line max-len
                         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,
@@ -47,14 +50,30 @@ export function fluidRunner(fluidFileConverter?: IFluidFileConverter) {
                         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 = validateProvidedArgs(argv.codeLoader, fluidFileConverter);
+                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(
@@ -63,12 +82,14 @@ export function fluidRunner(fluidFileConverter?: IFluidFileConverter) {
                         argv.outputFile,
                         argv.telemetryFile,
                         argv.options,
+                        telemetryOptionsResult.telemetryOptions,
                     ) : exportFile(
                         fluidFileConverter!,
                         argv.inputFile,
                         argv.outputFile,
                         argv.telemetryFile,
                         argv.options,
+                        telemetryOptionsResult.telemetryOptions,
                     ));
 
                 if (!result.success) {
@@ -81,18 +102,5 @@ export function fluidRunner(fluidFileConverter?: IFluidFileConverter) {
         .demandCommand().argv;
 }
 
-function validateProvidedArgs(
-    codeLoader?: string,
-    fluidFileConverter?: IFluidFileConverter,
-): string | undefined {
-    if (codeLoader !== undefined && fluidFileConverter !== undefined) {
-        return "\"codeLoader\" and \"fluidFileConverter\" cannot both be provided. See \"fluidRunner.ts\" for details.";
-    }
-    if (codeLoader === undefined && fluidFileConverter === undefined) {
-        // eslint-disable-next-line max-len
-        return "\"codeLoader\" must be provided if there is no explicit \"fluidFileConverter\". See \"fluidRunner.ts\" for details.";
-    }
-    return undefined;
-}
-
 fluidRunner();
+/* eslint-enable max-len */

package/src/getArgsValidationError.ts

@@ -11,7 +11,6 @@ export function getArgsValidationError(
 ): string | undefined {
     // Validate input file
     if (!inputFile) {
-        // TODO: Do not log file name. It can be customer content
         return "Input file name argument is missing.";
     } else if (!fs.existsSync(inputFile)) {
         return "Input file does not exist.";

package/src/index.ts

@@ -3,9 +3,12 @@
  * Licensed under the MIT License.
  */
 
+/* eslint-disable import/no-internal-modules */
 export { ICodeLoaderBundle, IFluidFileConverter } from "./codeLoaderBundle";
 export * from "./exportFile";
 export { fluidRunner } from "./fluidRunner";
-// eslint-disable-next-line import/no-internal-modules
-export * from "./logger/FileLogger";
+export { OutputFormat } from "./logger/fileLogger";
+export { createLogger, getTelemetryFileValidationError } from "./logger/loggerUtils";
 export * from "./parseBundleAndExportFile";
+export { getSnapshotFileContent } from "./utils";
+/* eslint-enable import/no-internal-modules */

package/src/logger/baseFileLogger.ts

@@ -0,0 +1,58 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import * as fs from "fs";
+import { ITelemetryBaseEvent } from "@fluidframework/common-definitions";
+import { IFileLogger } from "./fileLogger";
+
+/**
+ * @internal
+ */
+export abstract class BaseFileLogger implements IFileLogger {
+    public supportsTags?: true | undefined;
+
+    /** Hold events in memory until flushed */
+    protected events: any[] = [];
+    protected hasWrittenToFile = false;
+
+    /**
+     * @param filePath - file path to write logs to
+     * @param eventsPerFlush - number of events per flush
+     * @param defaultProps - default properties to add to every telemetry event
+     */
+     public constructor(
+        protected readonly filePath: string,
+        protected readonly eventsPerFlush: number = 50,
+        protected readonly defaultProps?: Record<string, string | number>,
+    ) { }
+
+    public send(event: ITelemetryBaseEvent): void {
+        // eslint-disable-next-line no-param-reassign
+        event = { ...event, ...this.defaultProps };
+        this.events.push(event);
+
+        if (this.events.length >= this.eventsPerFlush || event.category === "error") {
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises
+            this.flush();
+        }
+    }
+
+    protected async flush(): Promise<void> {
+        if (this.events.length > 0) {
+            const contentToWrite = this.events.map((it) => JSON.stringify(it)).join(",");
+            if (this.hasWrittenToFile) {
+                fs.appendFileSync(this.filePath, `,${contentToWrite}`);
+            } else {
+                fs.appendFileSync(this.filePath, contentToWrite);
+            }
+            this.events = [];
+            this.hasWrittenToFile = true;
+        }
+    }
+
+    public async close(): Promise<void> {
+        await this.flush();
+    }
+}

package/src/logger/csvFileLogger.ts

@@ -0,0 +1,40 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import * as fs from "fs";
+import { parse } from "json2csv";
+import { ITelemetryBaseEvent } from "@fluidframework/common-definitions";
+import { BaseFileLogger } from "./baseFileLogger";
+
+/**
+ * FileLogger that writes events into a defined CSV file
+ * @internal
+ */
+export class CSVFileLogger extends BaseFileLogger {
+    /** Store the column names to write as the CSV header */
+    private readonly columns = new Set();
+
+    public async flush(): Promise<void> {
+        // Do nothing
+    }
+
+    public send(event: ITelemetryBaseEvent): void {
+        // eslint-disable-next-line guard-for-in, no-restricted-syntax
+        for (const prop in event) {
+            this.columns.add(prop);
+        }
+        super.send(event);
+    }
+
+    public async close(): Promise<void> {
+        await super.close();
+        // eslint-disable-next-line guard-for-in, no-restricted-syntax
+        for (const field in this.defaultProps) {
+            this.columns.add(field);
+        }
+
+        fs.writeFileSync(this.filePath, parse(this.events, Array.from(this.columns)));
+    }
+}

package/src/logger/fileLogger.ts

@@ -0,0 +1,45 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
+
+/**
+ * Contract for logger that writes telemetry to a file
+ * @internal
+ */
+export interface IFileLogger extends ITelemetryBaseLogger {
+    /**
+     * This method acts as a "dispose" and should be explicitly called at the end of execution
+     */
+    close(): Promise<void>;
+}
+
+/**
+ * Desired output format for the telemetry
+ */
+export enum OutputFormat {
+    JSON,
+    CSV,
+}
+
+/* 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 */
+    outputFormat?: OutputFormat;
+
+    /**
+     * Properties that should be added to every telemetry event
+     * Example: { "prop1": "value1", "prop2": 10.0 }
+     */
+    defaultProps?: Record<string, string | number>;
+
+    /** Number of telemetry events per flush to telemetry file */
+    eventsPerFlush?: number;
+}
+/* eslint-enable tsdoc/syntax */

package/src/logger/jsonFileLogger.ts

@@ -0,0 +1,27 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import * as fs from "fs";
+import { BaseFileLogger } from "./baseFileLogger";
+
+/**
+ * FileLogger that writes events into a defined CSV file
+ * @internal
+ */
+export class JSONFileLogger extends BaseFileLogger {
+    constructor(
+        filePath: string,
+        eventsPerFlush: number = 50,
+        defaultProps?: Record<string, string | number>,
+    ) {
+        super(filePath, eventsPerFlush, defaultProps);
+        fs.appendFileSync(this.filePath, "[");
+    }
+
+    public async close(): Promise<void> {
+        await super.close();
+        fs.appendFileSync(this.filePath, "]");
+    }
+}

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/parseBundleAndExportFile.ts

@@ -8,8 +8,10 @@ import { PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { isCodeLoaderBundle, isFluidFileConverter } from "./codeLoaderBundle";
 import { createContainerAndExecute, IExportFileResponse } from "./exportFile";
 import { getArgsValidationError } from "./getArgsValidationError";
-// eslint-disable-next-line import/no-internal-modules
-import { createLogger, FileLogger, getTelemetryFileValidationError } from "./logger/FileLogger";
+/* 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";
@@ -24,14 +26,14 @@ export async function parseBundleAndExportFile(
     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 = new FileLogger(telemetryFile);
-    const logger = createLogger(fileLogger);
+    const { fileLogger, logger } = createLogger(telemetryFile, telemetryOptions);
 
     try {
         return await PerformanceEvent.timedExecAsync(logger, { eventName: "ParseBundleAndExportFile" }, async () => {
@@ -73,6 +75,6 @@ export async function parseBundleAndExportFile(
         logger.sendErrorEvent({ eventName }, error);
         return { success: false, eventName, errorMessage: "Unexpected error", error };
     } finally {
-        await fileLogger.flush();
+        await fileLogger.close();
     }
 }

package/src/utils.ts

@@ -4,10 +4,12 @@
  */
 
 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) === "{";
@@ -23,3 +25,21 @@ export function getSnapshotFileContent(filePath: string): string | Buffer {
     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/dist/logger/FileLogger.d.ts

@@ -1,32 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ITelemetryBaseEvent, ITelemetryBaseLogger, ITelemetryLogger } from "@fluidframework/common-definitions";
-/**
- * Logger that writes events into a defined file
- */
-export declare class FileLogger implements ITelemetryBaseLogger {
-    private readonly filePath;
-    private readonly eventsPerFlush;
-    supportsTags?: true | undefined;
-    /** Hold events in memory until flushed */
-    private events;
-    /**
-     * @param filePath - file path to write logs to
-     * @param eventsPerFlush - number of events per flush
-     */
-    constructor(filePath: string, eventsPerFlush?: number);
-    flush(): Promise<void>;
-    send(event: ITelemetryBaseEvent): void;
-}
-/**
- * Create a ITelemetryLogger wrapped around provided FileLogger
- */
-export declare function createLogger(fileLogger: FileLogger): ITelemetryLogger;
-/**
- * Validate the telemetryFile command line argument
- * @param telemetryFile - path where telemetry will be written
- */
-export declare function getTelemetryFileValidationError(telemetryFile: string): string | undefined;
-//# sourceMappingURL=FileLogger.d.ts.map

package/dist/logger/FileLogger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FileLogger.d.ts","sourceRoot":"","sources":["../../src/logger/FileLogger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAGjH;;GAEG;AACH,qBAAa,UAAW,YAAW,oBAAoB;IAW/C,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,cAAc;IAX5B,YAAY,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IAEvC,0CAA0C;IAC1C,OAAO,CAAC,MAAM,CAAgB;IAE9B;;;OAGG;gBAEkB,QAAQ,EAAE,MAAM,EAChB,cAAc,GAAE,MAAW;IAGnC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAO5B,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;CAUhD;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,UAAU,EAAE,UAAU,GAAG,gBAAgB,CAGrE;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAQzF"}

package/dist/logger/FileLogger.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FileLogger.js","sourceRoot":"","sources":["../../src/logger/FileLogger.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AAEzB,qEAA8D;AAE9D;;GAEG;AACH,MAAa,UAAU;IAMnB;;;OAGG;IACH,YACqB,QAAgB,EAChB,iBAAyB,EAAE;QAD3B,aAAQ,GAAR,QAAQ,CAAQ;QAChB,mBAAc,GAAd,cAAc,CAAa;QAThD,0CAA0C;QAClC,WAAM,GAAa,EAAE,CAAC;IAS1B,CAAC;IAEE,KAAK,CAAC,KAAK;QACd,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YACzD,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;SACpB;IACL,CAAC;IAEM,IAAI,CAAC,KAA0B;QAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAEvC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE3B,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,cAAc,IAAI,KAAK,CAAC,QAAQ,KAAK,OAAO,EAAE;YACzE,mEAAmE;YACnE,IAAI,CAAC,KAAK,EAAE,CAAC;SAChB;IACL,CAAC;CACJ;AAhCD,gCAgCC;AAED;;GAEG;AACH,SAAgB,YAAY,CAAC,UAAsB;IAC/C,OAAO,6BAAW,CAAC,MAAM,CAAC,UAAU,EAAE,wBAAwB,EAC1D,EAAE,GAAG,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC;AACnD,CAAC;AAHD,oCAGC;AAED;;;GAGG;AACH,SAAgB,+BAA+B,CAAC,aAAqB;IACjE,IAAI,CAAC,aAAa,EAAE;QAChB,OAAO,qCAAqC,CAAC;KAChD;SAAM,IAAI,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE;QACrC,OAAO,kCAAkC,aAAa,IAAI,CAAC;KAC9D;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AARD,0EAQC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as fs from \"fs\";\nimport { ITelemetryBaseEvent, ITelemetryBaseLogger, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\n\n/**\n * Logger that writes events into a defined file\n */\nexport class FileLogger implements ITelemetryBaseLogger {\n    public supportsTags?: true | undefined;\n\n    /** Hold events in memory until flushed */\n    private events: string[] = [];\n\n    /**\n     * @param filePath - file path to write logs to\n     * @param eventsPerFlush - number of events per flush\n     */\n    public constructor(\n        private readonly filePath: string,\n        private readonly eventsPerFlush: number = 50,\n    ) { }\n\n    public async flush(): Promise<void> {\n        if (this.events.length > 0) {\n            fs.appendFileSync(this.filePath, this.events.join(\"\\n\"));\n            this.events = [];\n        }\n    }\n\n    public send(event: ITelemetryBaseEvent): void {\n        const logEvent = JSON.stringify(event);\n\n        this.events.push(logEvent);\n\n        if (this.events.length >= this.eventsPerFlush || event.category === \"error\") {\n            // eslint-disable-next-line @typescript-eslint/no-floating-promises\n            this.flush();\n        }\n    }\n}\n\n/**\n * Create a ITelemetryLogger wrapped around provided FileLogger\n */\nexport function createLogger(fileLogger: FileLogger): ITelemetryLogger {\n    return ChildLogger.create(fileLogger, \"LocalSnapshotRunnerApp\",\n        { all: { Event_Time: () => Date.now() } });\n}\n\n/**\n * Validate the telemetryFile command line argument\n * @param telemetryFile - path where telemetry will be written\n */\nexport function getTelemetryFileValidationError(telemetryFile: string): string | undefined {\n    if (!telemetryFile) {\n        return \"Telemetry file argument is missing.\";\n    } else if (fs.existsSync(telemetryFile)) {\n        return `Telemetry file already exists [${telemetryFile}].`;\n    }\n\n    return undefined;\n}\n"]}

package/lib/logger/FileLogger.d.ts

@@ -1,32 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ITelemetryBaseEvent, ITelemetryBaseLogger, ITelemetryLogger } from "@fluidframework/common-definitions";
-/**
- * Logger that writes events into a defined file
- */
-export declare class FileLogger implements ITelemetryBaseLogger {
-    private readonly filePath;
-    private readonly eventsPerFlush;
-    supportsTags?: true | undefined;
-    /** Hold events in memory until flushed */
-    private events;
-    /**
-     * @param filePath - file path to write logs to
-     * @param eventsPerFlush - number of events per flush
-     */
-    constructor(filePath: string, eventsPerFlush?: number);
-    flush(): Promise<void>;
-    send(event: ITelemetryBaseEvent): void;
-}
-/**
- * Create a ITelemetryLogger wrapped around provided FileLogger
- */
-export declare function createLogger(fileLogger: FileLogger): ITelemetryLogger;
-/**
- * Validate the telemetryFile command line argument
- * @param telemetryFile - path where telemetry will be written
- */
-export declare function getTelemetryFileValidationError(telemetryFile: string): string | undefined;
-//# sourceMappingURL=FileLogger.d.ts.map

package/lib/logger/FileLogger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FileLogger.d.ts","sourceRoot":"","sources":["../../src/logger/FileLogger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAGjH;;GAEG;AACH,qBAAa,UAAW,YAAW,oBAAoB;IAW/C,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,cAAc;IAX5B,YAAY,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IAEvC,0CAA0C;IAC1C,OAAO,CAAC,MAAM,CAAgB;IAE9B;;;OAGG;gBAEkB,QAAQ,EAAE,MAAM,EAChB,cAAc,GAAE,MAAW;IAGnC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAO5B,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;CAUhD;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,UAAU,EAAE,UAAU,GAAG,gBAAgB,CAGrE;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAQzF"}