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

package/src/logger/baseFileLogger.ts

@@ -11,48 +11,48 @@ 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();
-    }
+	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

@@ -13,28 +13,28 @@ import { BaseFileLogger } from "./baseFileLogger";
  * @internal
  */
 export class CSVFileLogger extends BaseFileLogger {
-    /** Store the column names to write as the CSV header */
-    private readonly columns = new Set();
+	/** Store the column names to write as the CSV header */
+	private readonly columns = new Set();
 
-    protected async flush(): Promise<void> {
-        // No flushing is performed since we need all log entries to determine set of CSV columns
-    }
+	protected async flush(): Promise<void> {
+		// No flushing is performed since we need all log entries to determine set of CSV columns
+	}
 
-    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 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);
-        }
+	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)));
-    }
+		fs.writeFileSync(this.filePath, parse(this.events, Array.from(this.columns)));
+	}
 }

package/src/logger/fileLogger.ts

@@ -10,18 +10,18 @@ import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
  * @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>;
+	/**
+	 * 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,
+	JSON,
+	CSV,
 }
 
 /* eslint-disable tsdoc/syntax */
@@ -30,16 +30,16 @@ export enum OutputFormat {
  * @internal
  */
 export interface ITelemetryOptions {
-    /** Desired output format used to create a specific IFileLogger implementation */
-    outputFormat?: OutputFormat;
+	/** 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>;
+	/**
+	 * 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;
+	/** Number of telemetry events per flush to telemetry file */
+	eventsPerFlush?: number;
 }
 /* eslint-enable tsdoc/syntax */

package/src/logger/jsonFileLogger.ts

@@ -11,17 +11,17 @@ import { BaseFileLogger } from "./baseFileLogger";
  * @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, "[");
-    }
+	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, "]");
-    }
+	public async close(): Promise<void> {
+		await super.close();
+		fs.appendFileSync(this.filePath, "]");
+	}
 }

package/src/logger/loggerUtils.ts

@@ -17,18 +17,20 @@ import { JSONFileLogger } from "./jsonFileLogger";
  * 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);
+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() } });
+	const logger = ChildLogger.create(fileLogger, "LocalSnapshotRunnerApp", {
+		all: { Event_Time: () => Date.now() },
+	});
 
-    return { logger, fileLogger };
+	return { logger, fileLogger };
 }
 
 /**
@@ -36,13 +38,13 @@ import { JSONFileLogger } from "./jsonFileLogger";
  * @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}].`;
-    }
+	if (!telemetryFile) {
+		return "Telemetry file argument is missing.";
+	} else if (fs.existsSync(telemetryFile)) {
+		return `Telemetry file already exists [${telemetryFile}].`;
+	}
 
-    return undefined;
+	return undefined;
 }
 
 /**
@@ -52,30 +54,36 @@ export function getTelemetryFileValidationError(telemetryFile: string): string |
  * @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> = {};
+	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 (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];
-        }
-    }
+	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 } };
+	return { success: true, telemetryOptions: { outputFormat, defaultProps } };
 }

package/src/parseBundleAndExportFile.ts

@@ -21,60 +21,68 @@ const clientArgsValidationError = "Client_ArgsValidationError";
  * @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,
+	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);
+	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 };
-            }
+	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 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 };
-            }
+				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,
-            ));
+				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();
-    }
+				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

@@ -12,7 +12,7 @@ import { IFluidFileConverter } from "./codeLoaderBundle";
  * @internal
  */
 export function isJsonSnapshot(content: Buffer): boolean {
-    return content.toString(undefined, 0, 1) === "{";
+	return content.toString(undefined, 0, 1) === "{";
 }
 
 /**
@@ -21,25 +21,24 @@ export function isJsonSnapshot(content: Buffer): boolean {
  * @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;
+	// 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,
+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;
+	if (codeLoader && fluidFileConverter !== undefined) {
+		return '"codeLoader" and "fluidFileConverter" cannot both be provided. See README for details.';
+	}
+	if (!codeLoader && fluidFileConverter === undefined) {
+		return '"codeLoader" must be provided if there is no explicit "fluidFileConverter". See README for details.';
+	}
+	return undefined;
 }

package/tsconfig.esnext.json

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

package/tsconfig.json

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