@fluidframework/core-utils 2.0.0-rc.2.0.2 → 2.0.0-rc.3.0.0

package/lib/core-utils-public.d.ts

@@ -1,45 +0,0 @@
-/* Excluded from this release type: assert */
-
-/* Excluded from this release type: compareArrays */
-
-/* Excluded from this release type: Deferred */
-
-/* Excluded from this release type: delay */
-
-/* Excluded from this release type: Heap */
-
-/* Excluded from this release type: IComparer */
-
-/* Excluded from this release type: IHeapNode */
-
-/* Excluded from this release type: IPromiseTimer */
-
-/* Excluded from this release type: IPromiseTimerResult */
-
-/* Excluded from this release type: isObject */
-
-/* Excluded from this release type: isPromiseLike */
-
-/* Excluded from this release type: ITimer */
-
-/* Excluded from this release type: Lazy */
-
-/* Excluded from this release type: LazyPromise */
-
-/* Excluded from this release type: NumberComparer */
-
-/* Excluded from this release type: PromiseCache */
-
-/* Excluded from this release type: PromiseCacheExpiry */
-
-/* Excluded from this release type: PromiseCacheOptions */
-
-/* Excluded from this release type: PromiseTimer */
-
-/* Excluded from this release type: setLongTimeout */
-
-/* Excluded from this release type: Timer */
-
-/* Excluded from this release type: unreachableCase */
-
-export { }

package/lib/core-utils-untrimmed.d.ts

@@ -1,432 +0,0 @@
-/**
- * A browser friendly assert library.
- * Use this instead of the 'assert' package, which has a big impact on bundle sizes.
- * @param condition - The condition that should be true, if the condition is false an error will be thrown.
- * Only use this API when `false` indicates a logic error in the problem and thus a bug that should be fixed.
- * @param message - The message to include in the error when the condition does not hold.
- * A number should not be specified manually: use a string.
- * Before a release, policy-check should be run, which will convert any asserts still using strings to
- * use numbered error codes instead.
- * @alpha
- */
-export declare function assert(condition: boolean, message: string | number): asserts condition;
-
-/**
- * Compare two arrays.  Returns true if their elements are equivalent and in the same order.
- *
- * @alpha
- *
- * @param left - The first array to compare
- * @param right - The second array to compare
- * @param comparator - The function used to check if two `T`s are equivalent.
- * Defaults to `Object.is()` equality (a shallow compare where NaN = NaN and -0 ≠ 0)
- */
-export declare const compareArrays: <T>(left: readonly T[], right: readonly T[], comparator?: (leftItem: T, rightItem: T, index: number) => boolean) => boolean;
-
-/**
- * A deferred creates a promise and the ability to resolve or reject it
- * @alpha
- */
-export declare class Deferred<T> {
-    private readonly p;
-    private res;
-    private rej;
-    private completed;
-    constructor();
-    /**
-     * Returns whether the underlying promise has been completed
-     */
-    get isCompleted(): boolean;
-    /**
-     * Retrieves the underlying promise for the deferred
-     *
-     * @returns the underlying promise
-     */
-    get promise(): Promise<T>;
-    /**
-     * Resolves the promise
-     *
-     * @param value - the value to resolve the promise with
-     */
-    resolve(value: T | PromiseLike<T>): void;
-    /**
-     * Rejects the promise
-     *
-     * @param value - the value to reject the promise with
-     */
-    reject(error: any): void;
-}
-
-/**
- * Returns a promise that resolves after `timeMs`.
- * @param timeMs - Time in milliseconds to wait.
- * @internal
- */
-export declare const delay: (timeMs: number) => Promise<void>;
-
-/**
- * Ordered {@link https://en.wikipedia.org/wiki/Heap_(data_structure) | Heap} data structure implementation.
- * @internal
- */
-export declare class Heap<T> {
-    comp: IComparer<T>;
-    private L;
-    /**
-     * Creates an instance of `Heap` with comparer.
-     * @param comp - A comparer that specify how elements are ordered.
-     */
-    constructor(comp: IComparer<T>);
-    /**
-     * Return the smallest element in the heap as determined by the order of the comparer
-     *
-     * @returns Heap node containing the smallest element
-     */
-    peek(): IHeapNode<T> | undefined;
-    /**
-     * Get and remove the smallest element in the heap as determined by the order of the comparer
-     *
-     * @returns The smallest value in the heap
-     */
-    get(): T | undefined;
-    /**
-     * Add a value to the heap
-     *
-     * @param x - value to add
-     * @returns The heap node that contains the value
-     */
-    add(x: T): IHeapNode<T>;
-    /**
-     * Allows for the Heap to be updated after a node's value changes.
-     */
-    update(node: IHeapNode<T>): void;
-    /**
-     * Removes the given node from the heap.
-     *
-     * @param node - The node to remove from the heap.
-     */
-    remove(node: IHeapNode<T>): void;
-    /**
-     * Get the number of elements in the Heap.
-     *
-     * @returns The number of elements in the Heap.
-     */
-    count(): number;
-    private fixup;
-    private isGreaterThanParent;
-    private fixdown;
-    private swap;
-}
-
-/**
- * Interface for a comparer.
- * @internal
- */
-export declare interface IComparer<T> {
-    /**
-     * The minimum value of type T.
-     */
-    min: T;
-    /**
-     * Compare the two value
-     *
-     * @returns 0 if the value is equal, negative number if a is smaller then b, positive number otherwise
-     */
-    compare(a: T, b: T): number;
-}
-
-/**
- * Interface to a node in {@link Heap}.
- * @internal
- */
-export declare interface IHeapNode<T> {
-    value: T;
-    position: number;
-}
-
-/**
- * Timer which offers a promise that fulfills when the timer
- * completes.
- * @internal
- */
-export declare interface IPromiseTimer extends ITimer {
-    /**
-     * Starts the timer and returns a promise that
-     * resolves when the timer times out or is canceled.
-     */
-    start(): Promise<IPromiseTimerResult>;
-}
-
-/**
- * @internal
- */
-export declare interface IPromiseTimerResult {
-    timerResult: "timeout" | "cancel";
-}
-
-/**
- * Determines if an arbitrary  value is an object
- * @param value - The value to check to see if it is an object
- * @returns True if the passed value is an object
- *
- * @internal
- */
-export declare const isObject: (value: unknown) => value is object;
-
-/**
- * Determines if an arbitrary value is a promise
- * @param value - The value to check to see if it is a promise
- * @returns True if the passed value is a promise
- *
- * @internal
- */
-export declare const isPromiseLike: (value: unknown) => value is PromiseLike<unknown>;
-
-/**
- * @internal
- */
-export declare interface ITimer {
-    /**
-     * True if timer is currently running
-     */
-    readonly hasTimer: boolean;
-    /**
-     * Starts the timer
-     */
-    start(): void;
-    /**
-     * Cancels the timer if already running
-     */
-    clear(): void;
-}
-
-/**
- * Helper class for lazy initialized values. Ensures the value is only generated once, and remain immutable.
- * @internal
- */
-export declare class Lazy<T> {
-    private readonly valueGenerator;
-    private _value;
-    private _evaluated;
-    /**
-     * Instantiates an instance of Lazy<T>.
-     * @param valueGenerator - The function that will generate the value when value is accessed the first time.
-     */
-    constructor(valueGenerator: () => T);
-    /**
-     * Return true if the value as been generated, otherwise false.
-     */
-    get evaluated(): boolean;
-    /**
-     * Get the value. If this is the first call the value will be generated.
-     */
-    get value(): T;
-}
-
-/**
- * A lazy evaluated promise. The execute function is delayed until
- * the promise is used, e.g. await, then, catch ...
- * The execute function is only called once.
- * All calls are then proxied to the promise returned by the execute method.
- * @alpha
- */
-export declare class LazyPromise<T> implements Promise<T> {
-    private readonly execute;
-    get [Symbol.toStringTag](): string;
-    private result;
-    constructor(execute: () => Promise<T>);
-    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<TResult1 | TResult2>;
-    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null | undefined): Promise<T | TResult>;
-    finally(onfinally?: (() => void) | null | undefined): Promise<T>;
-    private getPromise;
-}
-
-/**
- * A comparer for numbers.
- * @internal
- */
-export declare const NumberComparer: IComparer<number>;
-
-/**
- * A specialized cache for async work, allowing you to safely cache the promised result of some async work
- * without fear of running it multiple times or losing track of errors.
- * @alpha
- */
-export declare class PromiseCache<TKey, TResult> {
-    private readonly cache;
-    private readonly gc;
-    private readonly removeOnError;
-    /**
-     * Create the PromiseCache with the given options, with the following defaults:
-     *
-     * expiry: indefinite, removeOnError: true for all errors
-     */
-    constructor({ expiry, removeOnError, }?: PromiseCacheOptions);
-    /**
-     * Check if there's anything cached at the given key
-     */
-    has(key: TKey): boolean;
-    /**
-     * Get the Promise for the given key, or undefined if it's not found.
-     * Extend expiry if applicable.
-     */
-    get(key: TKey): Promise<TResult> | undefined;
-    /**
-     * Remove the Promise for the given key, returning true if it was found and removed
-     */
-    remove(key: TKey): boolean;
-    /**
-     * Try to add the result of the given asyncFn, without overwriting an existing cache entry at that key.
-     * Returns a Promise for the added or existing async work being done at that key.
-     * @param key - key name where to store the async work
-     * @param asyncFn - the async work to do and store, if not already in progress under the given key
-     */
-    addOrGet(key: TKey, asyncFn: () => Promise<TResult>): Promise<TResult>;
-    /**
-     * Try to add the result of the given asyncFn, without overwriting an existing cache entry at that key.
-     * Returns false if the cache already contained an entry at that key, and true otherwise.
-     * @param key - key name where to store the async work
-     * @param asyncFn - the async work to do and store, if not already in progress under the given key
-     */
-    add(key: TKey, asyncFn: () => Promise<TResult>): boolean;
-    /**
-     * Try to add the given value, without overwriting an existing cache entry at that key.
-     * Returns a Promise for the added or existing async work being done at that key.
-     * @param key - key name where to store the async work
-     * @param value - value to store
-     */
-    addValueOrGet(key: TKey, value: TResult): Promise<TResult>;
-    /**
-     * Try to add the given value, without overwriting an existing cache entry at that key.
-     * Returns false if the cache already contained an entry at that key, and true otherwise.
-     * @param key - key name where to store the value
-     * @param value - value to store
-     */
-    addValue(key: TKey, value: TResult): boolean;
-}
-
-/**
- * Three supported expiry policies:
- * - indefinite: entries don't expire and must be explicitly removed
- * - absolute: entries expire after the given duration in MS, even if accessed multiple times in the mean time
- * - sliding: entries expire after the given duration in MS of inactivity (i.e. get resets the clock)
- * @alpha
- */
-export declare type PromiseCacheExpiry = {
-    policy: "indefinite";
-} | {
-    policy: "absolute" | "sliding";
-    durationMs: number;
-};
-
-/**
- * Options for configuring the {@link PromiseCache}
- * @alpha
- */
-export declare interface PromiseCacheOptions {
-    /**
-     * Common expiration policy for all items added to this cache
-     */
-    expiry?: PromiseCacheExpiry;
-    /**
-     * If the stored Promise is rejected with a particular error, should the given key be removed?
-     */
-    removeOnError?: (error: any) => boolean;
-}
-
-/**
- * This class is a wrapper over setTimeout and clearTimeout which
- * makes it simpler to keep track of recurring timeouts with the
- * same handlers and timeouts, while also providing a promise that
- * resolves when it times out.
- * @internal
- */
-export declare class PromiseTimer implements IPromiseTimer {
-    private deferred?;
-    private readonly timer;
-    /**
-     * {@inheritDoc Timer.hasTimer}
-     */
-    get hasTimer(): boolean;
-    constructor(defaultTimeout: number, defaultHandler: () => void);
-    /**
-     * {@inheritDoc IPromiseTimer.start}
-     */
-    start(ms?: number, handler?: () => void): Promise<IPromiseTimerResult>;
-    clear(): void;
-    protected wrapHandler(handler: () => void): void;
-}
-
-/**
- * Sets timeouts like the setTimeout function allowing timeouts to exceed the setTimeout's max timeout limit.
- * Timeouts may not be exactly accurate due to browser implementations and the OS.
- * https://stackoverflow.com/questions/21097421/what-is-the-reason-javascript-settimeout-is-so-inaccurate
- * @param timeoutFn - Executed when the timeout expires
- * @param timeoutMs - Duration of the timeout in milliseconds
- * @param setTimeoutIdFn - Executed to update the timeout if multiple timeouts are required when
- * timeoutMs greater than maxTimeout
- * @returns The initial timeout
- * @internal
- */
-export declare function setLongTimeout(timeoutFn: () => void, timeoutMs: number, setTimeoutIdFn?: (timeoutId: ReturnType<typeof setTimeout>) => void): ReturnType<typeof setTimeout>;
-
-/**
- * This class is a thin wrapper over setTimeout and clearTimeout which
- * makes it simpler to keep track of recurring timeouts with the same
- * or similar handlers and timeouts. This class supports long timeouts
- * or timeouts exceeding (2^31)-1 ms or approximately 24.8 days.
- * @internal
- */
-export declare class Timer implements ITimer {
-    private readonly defaultTimeout;
-    private readonly defaultHandler;
-    private readonly getCurrentTick;
-    /**
-     * Returns true if the timer is running.
-     */
-    get hasTimer(): boolean;
-    private runningState;
-    constructor(defaultTimeout: number, defaultHandler: () => void, getCurrentTick?: () => number);
-    /**
-     * Calls setTimeout and tracks the resulting timeout.
-     * @param ms - overrides default timeout in ms
-     * @param handler - overrides default handler
-     */
-    start(ms?: number, handler?: () => void): void;
-    /**
-     * Calls clearTimeout on the underlying timeout if running.
-     */
-    clear(): void;
-    /**
-     * Restarts the timer with the new handler and duration.
-     * If a new handler is passed, the original handler may
-     * never execute.
-     * This is a potentially more efficient way to clear and start
-     * a new timer.
-     * @param ms - overrides previous or default timeout in ms
-     * @param handler - overrides previous or default handler
-     */
-    restart(ms?: number, handler?: () => void): void;
-    private startCore;
-    private handler;
-    private calculateRemainingTime;
-}
-
-/**
- * This function can be used to assert at compile time that a given value has type never.
- * One common usage is in the default case of a switch block,
- * to ensure that all cases are explicitly handled.
- *
- * Example:
- * ```typescript
- * const bool: true | false = ...;
- * switch(bool) {
- *   case true: {...}
- *   case false: {...}
- *   default: unreachableCase(bool);
- * }
- * ```
- * @internal
- */
-export declare function unreachableCase(_: never, message?: string): never;
-
-export { }

package/lib/test/assert.spec.js

@@ -1,21 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { strict } from "node:assert";
-import { assert } from "@fluidframework/core-utils";
-describe("Assert", () => {
-    it("Validate Shortcode Format", async () => {
-        // short codes should be hex, and at least 3 chars
-        for (const shortCode of ["0x000", "0x03a", "0x200", "0x4321"]) {
-            try {
-                assert(false, Number.parseInt(shortCode, 16));
-            }
-            catch (error) {
-                strict(error instanceof Error, "not an error");
-                strict.strictEqual(error.message, shortCode, "incorrect short code format");
-            }
-        }
-    });
-});
-//# sourceMappingURL=assert.spec.js.map

package/lib/test/assert.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"assert.spec.js","sourceRoot":"","sources":["../../src/test/assert.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAEpD,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACvB,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QAC1C,kDAAkD;QAClD,KAAK,MAAM,SAAS,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE;YAC9D,IAAI;gBACH,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC;aAC9C;YAAC,OAAO,KAAc,EAAE;gBACxB,MAAM,CAAC,KAAK,YAAY,KAAK,EAAE,cAAc,CAAC,CAAC;gBAC/C,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,6BAA6B,CAAC,CAAC;aAC5E;SACD;IACF,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict } from \"node:assert\";\nimport { assert } from \"@fluidframework/core-utils\";\n\ndescribe(\"Assert\", () => {\n\tit(\"Validate Shortcode Format\", async () => {\n\t\t// short codes should be hex, and at least 3 chars\n\t\tfor (const shortCode of [\"0x000\", \"0x03a\", \"0x200\", \"0x4321\"]) {\n\t\t\ttry {\n\t\t\t\tassert(false, Number.parseInt(shortCode, 16));\n\t\t\t} catch (error: unknown) {\n\t\t\t\tstrict(error instanceof Error, \"not an error\");\n\t\t\t\tstrict.strictEqual(error.message, shortCode, \"incorrect short code format\");\n\t\t\t}\n\t\t}\n\t});\n});\n"]}

package/lib/test/bench/compareArrays.bench.spec.js

@@ -1,105 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { benchmark, BenchmarkType } from "@fluid-tools/benchmark";
-import { compareArrays } from "@fluidframework/core-utils";
-const a4 = Array.from({ length: 4 }).fill(0);
-const a1024 = Array.from({ length: 1024 }).fill(0);
-const comparisons = [
-    ["trivial rejection based on length", a1024, a1024.slice(1)],
-    ["trivial acceptance based on ref", a1024, a1024],
-    ["compare empty", [], []],
-    [`compare ${a4.length} items`, [...a4], [...a4]],
-    [`compare ${a1024.length} items`, [...a1024], [...a1024]],
-];
-function compareWithFor(left, right) {
-    if (left.length !== right.length) {
-        return false;
-    }
-    for (let index = 0; index < left.length; index++) {
-        if (left[index] !== right[index]) {
-            return false;
-        }
-    }
-    return true;
-}
-function compareWithEvery(left, right) {
-    return (left.length === right.length && left.every((leftItem, index) => leftItem === right[index]));
-}
-function compareWithObjectIs(left, right) {
-    return (left.length === right.length &&
-        left.every((leftItem, index) => Object.is(leftItem, right[index])));
-}
-describe("compareArrays()", () => {
-    describe.skip("baseline", () => {
-        describe("using for-loop", () => {
-            for (const [title, left, right] of comparisons) {
-                benchmark({
-                    type: BenchmarkType.Measurement,
-                    title: `${title}`,
-                    before: () => { },
-                    benchmarkFn: () => {
-                        compareWithFor(left, right);
-                    },
-                });
-            }
-        });
-        describe("using Array.every()", () => {
-            for (const [title, left, right] of comparisons) {
-                benchmark({
-                    type: BenchmarkType.Measurement,
-                    title: `${title}`,
-                    before: () => { },
-                    benchmarkFn: () => {
-                        compareWithEvery(left, right);
-                    },
-                });
-            }
-        });
-        describe("using Object.is()", () => {
-            for (const [title, left, right] of comparisons) {
-                benchmark({
-                    type: BenchmarkType.Measurement,
-                    title: `${title}`,
-                    before: () => { },
-                    benchmarkFn: () => {
-                        compareWithObjectIs(left, right);
-                    },
-                });
-            }
-        });
-    });
-    describe("no callback", () => {
-        for (const [title, left, right] of comparisons) {
-            benchmark({
-                type: BenchmarkType.Measurement,
-                title: `${title}`,
-                before: () => { },
-                benchmarkFn: () => {
-                    compareArrays(left, right);
-                },
-            });
-        }
-    });
-    describe("with callback", () => {
-        let sum = 0;
-        for (const [title, left, right] of comparisons) {
-            benchmark({
-                type: BenchmarkType.Measurement,
-                title: `${title}`,
-                benchmarkFn: () => {
-                    compareArrays(left, right, (leftItem, rightItem, index) => {
-                        sum += index;
-                        return Object.is(leftItem, rightItem);
-                    });
-                },
-                after: () => {
-                    // Paranoid usage of 'sum' to prevent dead code optimization.
-                    console.log(`after: ${sum}`);
-                },
-            });
-        }
-    });
-});
-//# sourceMappingURL=compareArrays.bench.spec.js.map

package/lib/test/bench/compareArrays.bench.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"compareArrays.bench.spec.js","sourceRoot":"","sources":["../../../src/test/bench/compareArrays.bench.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE3D,MAAM,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC7C,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAEnD,MAAM,WAAW,GAAqC;IACrD,CAAC,mCAAmC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC5D,CAAC,iCAAiC,EAAE,KAAK,EAAE,KAAK,CAAC;IACjD,CAAC,eAAe,EAAE,EAAE,EAAE,EAAE,CAAC;IACzB,CAAC,WAAW,EAAE,CAAC,MAAM,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;IAChD,CAAC,WAAW,KAAK,CAAC,MAAM,QAAQ,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC;CACzD,CAAC;AAEF,SAAS,cAAc,CAAI,IAAkB,EAAE,KAAmB;IACjE,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE;QACjC,OAAO,KAAK,CAAC;KACb;IAED,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QACjD,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC,KAAK,CAAC,EAAE;YACjC,OAAO,KAAK,CAAC;SACb;KACD;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAED,SAAS,gBAAgB,CAAI,IAAkB,EAAE,KAAmB;IACnE,OAAO,CACN,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,QAAQ,KAAK,KAAK,CAAC,KAAK,CAAC,CAAC,CAC1F,CAAC;AACH,CAAC;AAED,SAAS,mBAAmB,CAAI,IAAkB,EAAE,KAAmB;IACtE,OAAO,CACN,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;QAC5B,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAClE,CAAC;AACH,CAAC;AAED,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAChC,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE;QAC9B,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;YAC/B,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,WAAW,EAAE;gBAC/C,SAAS,CAAC;oBACT,IAAI,EAAE,aAAa,CAAC,WAAW;oBAC/B,KAAK,EAAE,GAAG,KAAK,EAAE;oBACjB,MAAM,EAAE,GAAG,EAAE,GAAE,CAAC;oBAChB,WAAW,EAAE,GAAG,EAAE;wBACjB,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;oBAC7B,CAAC;iBACD,CAAC,CAAC;aACH;QACF,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;YACpC,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,WAAW,EAAE;gBAC/C,SAAS,CAAC;oBACT,IAAI,EAAE,aAAa,CAAC,WAAW;oBAC/B,KAAK,EAAE,GAAG,KAAK,EAAE;oBACjB,MAAM,EAAE,GAAG,EAAE,GAAE,CAAC;oBAChB,WAAW,EAAE,GAAG,EAAE;wBACjB,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;oBAC/B,CAAC;iBACD,CAAC,CAAC;aACH;QACF,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;YAClC,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,WAAW,EAAE;gBAC/C,SAAS,CAAC;oBACT,IAAI,EAAE,aAAa,CAAC,WAAW;oBAC/B,KAAK,EAAE,GAAG,KAAK,EAAE;oBACjB,MAAM,EAAE,GAAG,EAAE,GAAE,CAAC;oBAChB,WAAW,EAAE,GAAG,EAAE;wBACjB,mBAAmB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;oBAClC,CAAC;iBACD,CAAC,CAAC;aACH;QACF,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAC5B,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,WAAW,EAAE;YAC/C,SAAS,CAAC;gBACT,IAAI,EAAE,aAAa,CAAC,WAAW;gBAC/B,KAAK,EAAE,GAAG,KAAK,EAAE;gBACjB,MAAM,EAAE,GAAG,EAAE,GAAE,CAAC;gBAChB,WAAW,EAAE,GAAG,EAAE;oBACjB,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAC5B,CAAC;aACD,CAAC,CAAC;SACH;IACF,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC9B,IAAI,GAAG,GAAG,CAAC,CAAC;QAEZ,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,WAAW,EAAE;YAC/C,SAAS,CAAC;gBACT,IAAI,EAAE,aAAa,CAAC,WAAW;gBAC/B,KAAK,EAAE,GAAG,KAAK,EAAE;gBAEjB,WAAW,EAAE,GAAG,EAAE;oBACjB,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE;wBACzD,GAAG,IAAI,KAAK,CAAC;wBACb,OAAO,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;oBACvC,CAAC,CAAC,CAAC;gBACJ,CAAC;gBAED,KAAK,EAAE,GAAG,EAAE;oBACX,6DAA6D;oBAC7D,OAAO,CAAC,GAAG,CAAC,UAAU,GAAG,EAAE,CAAC,CAAC;gBAC9B,CAAC;aACD,CAAC,CAAC;SACH;IACF,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { benchmark, BenchmarkType } from \"@fluid-tools/benchmark\";\nimport { compareArrays } from \"@fluidframework/core-utils\";\n\nconst a4 = Array.from({ length: 4 }).fill(0);\nconst a1024 = Array.from({ length: 1024 }).fill(0);\n\nconst comparisons: [string, unknown[], unknown[]][] = [\n\t[\"trivial rejection based on length\", a1024, a1024.slice(1)],\n\t[\"trivial acceptance based on ref\", a1024, a1024],\n\t[\"compare empty\", [], []],\n\t[`compare ${a4.length} items`, [...a4], [...a4]],\n\t[`compare ${a1024.length} items`, [...a1024], [...a1024]],\n];\n\nfunction compareWithFor<T>(left: readonly T[], right: readonly T[]): boolean {\n\tif (left.length !== right.length) {\n\t\treturn false;\n\t}\n\n\tfor (let index = 0; index < left.length; index++) {\n\t\tif (left[index] !== right[index]) {\n\t\t\treturn false;\n\t\t}\n\t}\n\n\treturn true;\n}\n\nfunction compareWithEvery<T>(left: readonly T[], right: readonly T[]): boolean {\n\treturn (\n\t\tleft.length === right.length && left.every((leftItem, index) => leftItem === right[index])\n\t);\n}\n\nfunction compareWithObjectIs<T>(left: readonly T[], right: readonly T[]): boolean {\n\treturn (\n\t\tleft.length === right.length &&\n\t\tleft.every((leftItem, index) => Object.is(leftItem, right[index]))\n\t);\n}\n\ndescribe(\"compareArrays()\", () => {\n\tdescribe.skip(\"baseline\", () => {\n\t\tdescribe(\"using for-loop\", () => {\n\t\t\tfor (const [title, left, right] of comparisons) {\n\t\t\t\tbenchmark({\n\t\t\t\t\ttype: BenchmarkType.Measurement,\n\t\t\t\t\ttitle: `${title}`,\n\t\t\t\t\tbefore: () => {},\n\t\t\t\t\tbenchmarkFn: () => {\n\t\t\t\t\t\tcompareWithFor(left, right);\n\t\t\t\t\t},\n\t\t\t\t});\n\t\t\t}\n\t\t});\n\n\t\tdescribe(\"using Array.every()\", () => {\n\t\t\tfor (const [title, left, right] of comparisons) {\n\t\t\t\tbenchmark({\n\t\t\t\t\ttype: BenchmarkType.Measurement,\n\t\t\t\t\ttitle: `${title}`,\n\t\t\t\t\tbefore: () => {},\n\t\t\t\t\tbenchmarkFn: () => {\n\t\t\t\t\t\tcompareWithEvery(left, right);\n\t\t\t\t\t},\n\t\t\t\t});\n\t\t\t}\n\t\t});\n\n\t\tdescribe(\"using Object.is()\", () => {\n\t\t\tfor (const [title, left, right] of comparisons) {\n\t\t\t\tbenchmark({\n\t\t\t\t\ttype: BenchmarkType.Measurement,\n\t\t\t\t\ttitle: `${title}`,\n\t\t\t\t\tbefore: () => {},\n\t\t\t\t\tbenchmarkFn: () => {\n\t\t\t\t\t\tcompareWithObjectIs(left, right);\n\t\t\t\t\t},\n\t\t\t\t});\n\t\t\t}\n\t\t});\n\t});\n\n\tdescribe(\"no callback\", () => {\n\t\tfor (const [title, left, right] of comparisons) {\n\t\t\tbenchmark({\n\t\t\t\ttype: BenchmarkType.Measurement,\n\t\t\t\ttitle: `${title}`,\n\t\t\t\tbefore: () => {},\n\t\t\t\tbenchmarkFn: () => {\n\t\t\t\t\tcompareArrays(left, right);\n\t\t\t\t},\n\t\t\t});\n\t\t}\n\t});\n\n\tdescribe(\"with callback\", () => {\n\t\tlet sum = 0;\n\n\t\tfor (const [title, left, right] of comparisons) {\n\t\t\tbenchmark({\n\t\t\t\ttype: BenchmarkType.Measurement,\n\t\t\t\ttitle: `${title}`,\n\n\t\t\t\tbenchmarkFn: () => {\n\t\t\t\t\tcompareArrays(left, right, (leftItem, rightItem, index) => {\n\t\t\t\t\t\tsum += index;\n\t\t\t\t\t\treturn Object.is(leftItem, rightItem);\n\t\t\t\t\t});\n\t\t\t\t},\n\n\t\t\t\tafter: () => {\n\t\t\t\t\t// Paranoid usage of 'sum' to prevent dead code optimization.\n\t\t\t\t\tconsole.log(`after: ${sum}`);\n\t\t\t\t},\n\t\t\t});\n\t\t}\n\t});\n});\n"]}

package/lib/test/compareArrays.spec.js

@@ -1,43 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { strict as assert } from "node:assert";
-import { compareArrays } from "@fluidframework/core-utils";
-const o = { o: "o" };
-const s = Symbol("s");
-const tests = [
-    [[], [], true],
-    [[0], [], false],
-    [[], [0], false],
-    [[0], [0], true],
-    [[1], [0], false],
-    [[0], [1], false],
-    [[0, 1], [0], false],
-    [[0], [0, 1], false],
-    [[0, 1], [0, 2], false],
-    [[0, 1], [-1, 1], false],
-    [[0, 1], [0, 1], true],
-    // Object.is() semantics:
-    [[Number.NaN], [Number.NaN], true],
-    [[0], [-0], false],
-    // eslint-disable-next-line unicorn/no-null
-    [[null], [undefined], false],
-    [[""], [0], false],
-    [[{}], [{}], false],
-    [[o], [o], true],
-    [[Symbol("sl")], [Symbol("sr")], false],
-    [[s], [s], true],
-];
-describe("compareArrays()", () => {
-    function check(left, right, expected) {
-        it(`${JSON.stringify(left)} and ${JSON.stringify(right)} must ${expected ? "" : "not "}be equal`, () => {
-            const actual = compareArrays(left, right);
-            assert.equal(actual, expected);
-        });
-    }
-    for (const [left, right, expected] of tests) {
-        check(left, right, expected);
-    }
-});
-//# sourceMappingURL=compareArrays.spec.js.map

package/lib/test/compareArrays.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"compareArrays.spec.js","sourceRoot":"","sources":["../../src/test/compareArrays.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE3D,MAAM,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC;AACrB,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;AAEtB,MAAM,KAAK,GAAsC;IAChD,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC;IACd,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC;IAChB,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;IAChB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;IAChB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;IACjB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;IAEjB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;IACpB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC;IACpB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC;IACvB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC;IACxB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC;IAEtB,yBAAyB;IACzB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC;IAClC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;IAElB,2CAA2C;IAC3C,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC;IAC5B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;IAClB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC;IACnB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;IAChB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC;IACvC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;CAChB,CAAC;AAEF,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAChC,SAAS,KAAK,CAAI,IAAS,EAAE,KAAU,EAAE,QAAiB;QACzD,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,SACtD,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MACjB,UAAU,EAAE,GAAG,EAAE;YAChB,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAE1C,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,KAAK,EAAE;QAC5C,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;KAC7B;AACF,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"node:assert\";\nimport { compareArrays } from \"@fluidframework/core-utils\";\n\nconst o = { o: \"o\" };\nconst s = Symbol(\"s\");\n\nconst tests: [unknown[], unknown[], boolean][] = [\n\t[[], [], true],\n\t[[0], [], false],\n\t[[], [0], false],\n\t[[0], [0], true],\n\t[[1], [0], false],\n\t[[0], [1], false],\n\n\t[[0, 1], [0], false],\n\t[[0], [0, 1], false],\n\t[[0, 1], [0, 2], false],\n\t[[0, 1], [-1, 1], false],\n\t[[0, 1], [0, 1], true],\n\n\t// Object.is() semantics:\n\t[[Number.NaN], [Number.NaN], true],\n\t[[0], [-0], false],\n\n\t// eslint-disable-next-line unicorn/no-null\n\t[[null], [undefined], false],\n\t[[\"\"], [0], false],\n\t[[{}], [{}], false],\n\t[[o], [o], true],\n\t[[Symbol(\"sl\")], [Symbol(\"sr\")], false],\n\t[[s], [s], true],\n];\n\ndescribe(\"compareArrays()\", () => {\n\tfunction check<T>(left: T[], right: T[], expected: boolean): void {\n\t\tit(`${JSON.stringify(left)} and ${JSON.stringify(right)} must ${\n\t\t\texpected ? \"\" : \"not \"\n\t\t}be equal`, () => {\n\t\t\tconst actual = compareArrays(left, right);\n\n\t\t\tassert.equal(actual, expected);\n\t\t});\n\t}\n\n\tfor (const [left, right, expected] of tests) {\n\t\tcheck(left, right, expected);\n\t}\n});\n"]}