@fluid-experimental/tree 2.0.0-rc.2.0.1 → 2.0.0-rc.3.0.0

package/lib/test/utilities/IdCompressorTestUtilities.d.ts

@@ -1,246 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { Generator, SaveInfo, BaseFuzzTestState } from '@fluid-private/stochastic-test-utils';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ClosedMap } from '../../Common.js';
-import { IdCompressor } from '../../id-compressor/IdCompressor.js';
-import { NumericUuid } from '../../id-compressor/NumericUuid.js';
-import { SessionId, StableId, SessionSpaceCompressedId, AttributionId, OpSpaceCompressedId } from '../../Identifiers.js';
-import type { IdCreationRange, SerializedIdCompressorWithOngoingSession, SerializedIdCompressorWithNoSession } from '../../id-compressor/index.js';
-/** Identifies a compressor in a network */
-export declare enum Client {
-    Client1 = "Client1",
-    Client2 = "Client2",
-    Client3 = "Client3"
-}
-/** Identifies a compressor with respect to a specific operation */
-export declare enum SemanticClient {
-    LocalClient = "LocalClient"
-}
-/** Identifies categories of compressors */
-export declare enum MetaClient {
-    All = "All"
-}
-/**
- * Used to attribute actions to clients in a distributed collaboration session.
- * `Local` implies a local and unsequenced operation. All others imply sequenced operations.
- */
-export type OriginatingClient = Client | SemanticClient;
-export declare const OriginatingClient: {
-    LocalClient: SemanticClient.LocalClient;
-    Client1: Client.Client1;
-    Client2: Client.Client2;
-    Client3: Client.Client3;
-};
-/** Identifies a compressor to which to send an operation */
-export type DestinationClient = Client | MetaClient;
-export declare const DestinationClient: {
-    All: MetaClient.All;
-    Client1: Client.Client1;
-    Client2: Client.Client2;
-    Client3: Client.Client3;
-};
-/**
- * Creates a new compressor with the supplied cluster capacity.
- */
-export declare function createCompressor(client: Client, clusterCapacity?: number, attributionId?: AttributionId, logger?: ITelemetryBaseLogger): IdCompressor;
-/**
- * A closed map from NamedClient to T.
- */
-export type ClientMap<T> = ClosedMap<Client, T>;
-/**
- * An array of session ID strings corresponding to all non-local `Client` entries.
- */
-export declare const sessionIds: ClientMap<SessionId>;
-/**
- * An array of session uuids corresponding to all non-local `Client` entries.
- */
-export declare const sessionNumericUuids: ClientMap<NumericUuid>;
-export declare const attributionIds: ClientMap<import("../../Identifiers.js").UuidString>;
-/** An immutable view of an `IdCompressor` */
-export interface ReadonlyIdCompressor extends Omit<IdCompressor, 'generateCompressedId' | 'generateCompressedIdRange' | 'takeNextCreationRange' | 'finalizeCreationRange'> {
-    readonly clusterCapacity: number;
-}
-/** Information about a generated ID in a network to be validated by tests */
-export interface TestIdData {
-    readonly id: SessionSpaceCompressedId;
-    readonly originatingClient: Client;
-    readonly sessionId: SessionId;
-    readonly sessionNumericUuid: NumericUuid;
-    readonly expectedOverride: string | undefined;
-    readonly isSequenced: boolean;
-}
-/**
- * Simulates a network of ID compressors.
- * Not suitable for performance testing.
- */
-export declare class IdCompressorTestNetwork {
-    readonly initialClusterSize: number;
-    private readonly onIdReceived?;
-    /** The compressors used in this network */
-    private readonly compressors;
-    /** The log of operations seen by the server so far. Append-only. */
-    private readonly serverOperations;
-    /** An index into `serverOperations` for each client which represents how many operations have been delivered to that client */
-    private readonly clientProgress;
-    /** All ids (local and sequenced) that a client has created or received, in order. */
-    private readonly idLogs;
-    /** All ids that a client has received from the server, in order. */
-    private readonly sequencedIdLogs;
-    constructor(initialClusterSize?: number, onIdReceived?: ((network: IdCompressorTestNetwork, clientTo: Client, ids: TestIdData[]) => void) | undefined);
-    /**
-     * Returns the number of undelivered operations for the given client that are in flight in the network.
-     */
-    getPendingOperations(destination: Client): number;
-    /**
-     * Returns an immutable handle to a compressor in the network.
-     */
-    getCompressor(client: Client): ReadonlyIdCompressor;
-    /**
-     * Returns a mutable handle to a compressor in the network. Use of mutation methods will break the network invariants and
-     * should only be used if the network will not be used again.
-     */
-    getCompressorUnsafe(client: Client): IdCompressor;
-    /**
-     * Returns a mutable handle to a compressor in the network. Use of mutation methods will break the network invariants and
-     * should only be used if the network will not be used again. Additionally, the returned compressor will be invalidated/unusable
-     * if any network operations cause it to be regenerated (serialization/deserialization, etc.).
-     */
-    getCompressorUnsafeNoProxy(client: Client): IdCompressor;
-    /**
-     * Returns data for all IDs created and received by this client, including ack's of their own (i.e. their own IDs will appear twice)
-     */
-    getIdLog(client: Client): readonly TestIdData[];
-    /**
-     * Returns data for all IDs received by this client, including ack's of their own.
-     */
-    getSequencedIdLog(client: Client): readonly TestIdData[];
-    /**
-     * Get all compressors for the given destination
-     */
-    getTargetCompressors(clientTo: DestinationClient): [Client, IdCompressor][];
-    /**
-     * Submit a capacity change operation to the network. It will not take effect immediately but will be processed in sequence order.
-     */
-    enqueueCapacityChange(newClusterCapacity: number): void;
-    private addNewId;
-    /**
-     * Allocates a new range of local IDs and enqueues them for future delivery via a `testIdDelivery` action.
-     * Calls to this method determine the total order of delivery, regardless of when `deliverOperations` is called.
-     */
-    allocateAndSendIds(client: Client, numIds: number): OpSpaceCompressedId[];
-    /**
-     * Allocates a new range of local IDs and enqueues them for future delivery via a `testIdDelivery` action.
-     * Calls to this method determine the total order of delivery, regardless of when `deliverOperations` is called.
-     */
-    allocateAndSendIds(client: Client, numIds: number, overrides: {
-        [index: number]: string;
-    }): IdCreationRange;
-    /**
-     * Delivers all undelivered ID ranges and cluster capacity changes from the server to the target clients.
-     */
-    deliverOperations(clientTakingDelivery: Client, opsToDeliver?: number): any;
-    /**
-     * Delivers all undelivered ID ranges and cluster capacity changes from the server to the target clients.
-     */
-    deliverOperations(clientTakingDelivery: DestinationClient): any;
-    /**
-     * Simulate a client disconnecting (and serializing), then reconnecting (and deserializing)
-     */
-    goOfflineThenResume(client: Client): void;
-    /**
-     * Ensure general validity of the network state. Useful for calling periodically or at the end of test scenarios.
-     */
-    assertNetworkState(): void;
-}
-/**
- * Roundtrips the supplied compressor through serialization and deserialization.
- */
-export declare function roundtrip(compressor: ReadonlyIdCompressor, withSession: true): [SerializedIdCompressorWithOngoingSession, IdCompressor];
-/**
- * Roundtrips the supplied compressor through serialization and deserialization.
- */
-export declare function roundtrip(compressor: ReadonlyIdCompressor, withSession: false): [SerializedIdCompressorWithNoSession, IdCompressor];
-/**
- * Asserts that the supplied compressor correctly roundtrips through serialization/deserialization.
- */
-export declare function expectSerializes(compressor: ReadonlyIdCompressor): [SerializedIdCompressorWithNoSession, SerializedIdCompressorWithOngoingSession];
-/**
- * Merges 'from' into 'to', and returns 'to'.
- */
-export declare function mergeArrayMaps<K, V>(to: Pick<Map<K, V[]>, 'get' | 'set'>, from: ReadonlyMap<K, V[]>): Pick<Map<K, V[]>, 'get' | 'set'>;
-interface AllocateIds {
-    type: 'allocateIds';
-    client: Client;
-    numIds: number;
-    overrides: {
-        [index: number]: string;
-    };
-}
-interface DeliverAllOperations {
-    type: 'deliverAllOperations';
-}
-interface DeliverSomeOperations {
-    type: 'deliverSomeOperations';
-    client: Client;
-    count: number;
-}
-interface ChangeCapacity {
-    type: 'changeCapacity';
-    newSize: number;
-}
-interface GenerateUnifyingIds {
-    type: 'generateUnifyingIds';
-    clientA: Client;
-    clientB: Client;
-    uuid: string;
-}
-interface Reconnect {
-    type: 'reconnect';
-    client: Client;
-}
-interface Validate {
-    type: 'validate';
-}
-type Operation = AllocateIds | DeliverSomeOperations | DeliverAllOperations | ChangeCapacity | GenerateUnifyingIds | Reconnect | Validate;
-interface FuzzTestState extends BaseFuzzTestState {
-    network: IdCompressorTestNetwork;
-    activeClients: Client[];
-    selectableClients: Client[];
-    clusterSize: number;
-}
-export interface OperationGenerationConfig {
-    /** whether or not the fuzz actions will generate override UUIDs */
-    includeOverrides: boolean;
-    /** maximum cluster size of the network. Default: 25 */
-    maxClusterSize?: number;
-    /** Number of ops between validation ops. Default: 200 */
-    validateInterval?: number;
-}
-export declare function makeOpGenerator(options: OperationGenerationConfig): Generator<Operation, FuzzTestState>;
-/**
- * Performs random actions on a test network.
- * @param generator - the generator used to provide operations
- * @param network - the test network to test
- * @param seed - the seed for the random generation of the fuzz actions
- * @param observerClient - if provided, this client will never generate local ids
- * @param synchronizeAtEnd - if provided, all client will have all operations delivered from the server at the end of the test
- * @param validator - if provided, this callback will be invoked periodically during the fuzz test.
- */
-export declare function performFuzzActions(generator: Generator<Operation, FuzzTestState>, network: IdCompressorTestNetwork, seed: number, observerClient?: Client, synchronizeAtEnd?: boolean, validator?: (network: IdCompressorTestNetwork) => void, saveInfo?: SaveInfo): void;
-/**
- * Converts the supplied integer to a uuid.
- */
-export declare function integerToStableId(num: number | bigint): StableId;
-/**
- * Pads the strings to a length of 32 with zeroes.
- */
-export declare function padToUuidLength(str: string): string;
-/**
- * Helper to generate a fixed number of IDs.
- */
-export declare function generateCompressedIds(compressor: IdCompressor, count: number): SessionSpaceCompressedId[];
-export {};
-//# sourceMappingURL=IdCompressorTestUtilities.d.ts.map

package/lib/test/utilities/IdCompressorTestUtilities.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"IdCompressorTestUtilities.d.ts","sourceRoot":"","sources":["../../../src/test/utilities/IdCompressorTestUtilities.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EACN,SAAS,EAMT,QAAQ,EAER,iBAAiB,EACjB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAsB,SAAS,EAAqB,MAAM,iBAAiB,CAAC;AACnF,OAAO,EAAE,YAAY,EAAa,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAGN,WAAW,EAGX,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAEN,SAAS,EACT,QAAQ,EACR,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,KAAK,EACX,eAAe,EACf,wCAAwC,EACxC,mCAAmC,EACnC,MAAM,8BAA8B,CAAC;AAItC,2CAA2C;AAC3C,oBAAY,MAAM;IACjB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,OAAO,YAAY;CACnB;AAED,mEAAmE;AACnE,oBAAY,cAAc;IACzB,WAAW,gBAAgB;CAC3B;AAED,2CAA2C;AAC3C,oBAAY,UAAU;IACrB,GAAG,QAAQ;CACX;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,cAAc,CAAC;AACxD,eAAO,MAAM,iBAAiB;;;;;CAAmC,CAAC;AAElE,4DAA4D;AAC5D,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,UAAU,CAAC;AACpD,eAAO,MAAM,iBAAiB;;;;;CAA+B,CAAC;AAE9D;;GAEG;AACH,wBAAgB,gBAAgB,CAC/B,MAAM,EAAE,MAAM,EACd,eAAe,SAAI,EACnB,aAAa,CAAC,EAAE,aAAa,EAC7B,MAAM,CAAC,EAAE,oBAAoB,GAC3B,YAAY,CAId;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AAchD;;GAEG;AACH,eAAO,MAAM,UAAU,sBAAmB,CAAC;AAE3C;;GAEG;AACH,eAAO,MAAM,mBAAmB,wBAIL,CAAC;AAE5B,eAAO,MAAM,cAAc,sDAKE,CAAC;AAE9B,6CAA6C;AAC7C,MAAM,WAAW,oBAChB,SAAQ,IAAI,CACX,YAAY,EACZ,sBAAsB,GAAG,2BAA2B,GAAG,uBAAuB,GAAG,uBAAuB,CACxG;IACD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;CACjC;AAED,6EAA6E;AAC7E,MAAM,WAAW,UAAU;IAC1B,QAAQ,CAAC,EAAE,EAAE,wBAAwB,CAAC;IACtC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,kBAAkB,EAAE,WAAW,CAAC;IACzC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9C,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CAC9B;AAED;;;GAGG;AACH,qBAAa,uBAAuB;aAgBlB,kBAAkB;IAClC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC;IAhB/B,2CAA2C;IAC3C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA0B;IACtD,oEAAoE;IACpE,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAGxB;IACT,+HAA+H;IAC/H,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAoB;IACnD,qFAAqF;IACrF,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA0B;IACjD,oEAAoE;IACpE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA0B;gBAGzC,kBAAkB,SAAI,EACrB,YAAY,CAAC,aAAY,uBAAuB,YAAY,MAAM,OAAO,UAAU,EAAE,KAAK,IAAI,aAAA;IAmBhH;;OAEG;IACI,oBAAoB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAIxD;;OAEG;IACI,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,oBAAoB;IAgB1D;;;OAGG;IACI,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY;IAIxD;;;;OAIG;IACI,0BAA0B,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY;IAI/D;;OAEG;IACI,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,UAAU,EAAE;IAItD;;OAEG;IACI,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,UAAU,EAAE;IAI/D;;OAEG;IACI,oBAAoB,CAAC,QAAQ,EAAE,iBAAiB,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE;IAMlF;;OAEG;IACI,qBAAqB,CAAC,kBAAkB,EAAE,MAAM,GAAG,IAAI;IAI9D,OAAO,CAAC,QAAQ;IAwBhB;;;OAGG;IACI,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,mBAAmB,EAAE;IAEhF;;;OAGG;IACI,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,eAAe;IAuClH;;OAEG;IACI,iBAAiB,CAAC,oBAAoB,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM;IAE5E;;OAEG;IACI,iBAAiB,CAAC,oBAAoB,EAAE,iBAAiB;IAmDhE;;OAEG;IACI,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAMhD;;OAEG;IACI,kBAAkB,IAAI,IAAI;CAmJjC;AAED;;GAEG;AACH,wBAAgB,SAAS,CACxB,UAAU,EAAE,oBAAoB,EAChC,WAAW,EAAE,IAAI,GACf,CAAC,wCAAwC,EAAE,YAAY,CAAC,CAAC;AAE5D;;GAEG;AACH,wBAAgB,SAAS,CACxB,UAAU,EAAE,oBAAoB,EAChC,WAAW,EAAE,KAAK,GAChB,CAAC,mCAAmC,EAAE,YAAY,CAAC,CAAC;AAevD;;GAEG;AACH,wBAAgB,gBAAgB,CAC/B,UAAU,EAAE,oBAAoB,GAC9B,CAAC,mCAAmC,EAAE,wCAAwC,CAAC,CA0CjF;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,CAAC,EAClC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,EACpC,IAAI,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GACvB,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,CAUlC;AAED,UAAU,WAAW;IACpB,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACvC;AAED,UAAU,oBAAoB;IAC7B,IAAI,EAAE,sBAAsB,CAAC;CAC7B;AAED,UAAU,qBAAqB;IAC9B,IAAI,EAAE,uBAAuB,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACd;AAED,UAAU,cAAc;IACvB,IAAI,EAAE,gBAAgB,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,mBAAmB;IAC5B,IAAI,EAAE,qBAAqB,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACb;AAGD,UAAU,SAAS;IAClB,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CACf;AAED,UAAU,QAAQ;IACjB,IAAI,EAAE,UAAU,CAAC;CACjB;AAED,KAAK,SAAS,GACX,WAAW,GACX,qBAAqB,GACrB,oBAAoB,GACpB,cAAc,GACd,mBAAmB,GACnB,SAAS,GACT,QAAQ,CAAC;AAEZ,UAAU,aAAc,SAAQ,iBAAiB;IAChD,OAAO,EAAE,uBAAuB,CAAC;IACjC,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACzC,mEAAmE;IACnE,gBAAgB,EAAE,OAAO,CAAC;IAC1B,uDAAuD;IACvD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,yDAAyD;IACzD,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC1B;AAQD,wBAAgB,eAAe,CAAC,OAAO,EAAE,yBAAyB,GAAG,SAAS,CAAC,SAAS,EAAE,aAAa,CAAC,CA+EvG;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CACjC,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,aAAa,CAAC,EAC9C,OAAO,EAAE,uBAAuB,EAChC,IAAI,EAAE,MAAM,EACZ,cAAc,CAAC,EAAE,MAAM,EACvB,gBAAgB,GAAE,OAAc,EAChC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,uBAAuB,KAAK,IAAI,EACtD,QAAQ,CAAC,EAAE,QAAQ,GACjB,IAAI,CAsDN;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAYhE;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEnD;AAMD;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,GAAG,wBAAwB,EAAE,CAMzG"}