@hypertestco/node-sdk-v3 0.0.1-8

package/instrumentation/libraries/mongodb/mongoHelpers/fakeCursors/v4AndAbove/HtFakeListIndexesCursor.d.ts

@@ -0,0 +1,12 @@
+import type { HtInstrumentationMockAbstract } from '../../../../../core/baseClasses/HtInstrumentationMockAbstract';
+import type { SetReadableInput } from '../../../modules/cursor/MongoDbCursorMock';
+import { HtFakeCoreCursor } from './HtFakeCoreCursor';
+export declare class HtFakeListIndexesCursor extends HtFakeCoreCursor {
+    pipeline: Record<string, unknown>[];
+    mock: HtInstrumentationMockAbstract;
+    setReadableInput: SetReadableInput;
+    version: string;
+    constructor(mock: HtInstrumentationMockAbstract, setReadableInput: SetReadableInput, version: string, options: Record<string, unknown>);
+    setReadableInputAndExtractDataFromMock(): void;
+    clone(): HtFakeListIndexesCursor;
+}

package/instrumentation/libraries/mongodb/mongoHelpers/fakeCursors/v4AndAbove/HtFakeRunCommandCursor.d.ts

@@ -0,0 +1,24 @@
+import type { ReadConcernLike } from 'mongov6';
+import type { HtInstrumentationMockAbstract } from '../../../../../core/baseClasses/HtInstrumentationMockAbstract';
+import type { SetReadableInput } from '../../../modules/cursor/MongoDbCursorMock';
+import { HtFakeCoreCursor } from './HtFakeCoreCursor';
+export declare class HtFakeRunCommandCursor extends HtFakeCoreCursor {
+    pipeline: Record<string, unknown>[];
+    mock: HtInstrumentationMockAbstract;
+    setReadableInput: SetReadableInput;
+    version: string;
+    constructor(mock: HtInstrumentationMockAbstract, setReadableInput: SetReadableInput, version: string);
+    setReadableInputAndExtractDataFromMock(): void;
+    clone(): HtFakeRunCommandCursor;
+    setComment(): this;
+    setMaxTimeMS(): this;
+    setBatchSize(): this;
+    /** Unsupported for RunCommandCursor: readConcern must be configured directly on command document */
+    withReadConcern(_: ReadConcernLike): never;
+    /** Unsupported for RunCommandCursor: various cursor flags must be configured directly on command document */
+    addCursorFlag(_: string, __: boolean): never;
+    /** Unsupported for RunCommandCursor: maxTimeMS must be configured directly on command document */
+    maxTimeMS(_: number): never;
+    /** Unsupported for RunCommandCursor: batchSize must be configured directly on command document */
+    batchSize(_: number): never;
+}

package/instrumentation/libraries/mongodb/mongoHelpers/fakeCursors/v4AndAbove/cursorErrors.d.ts

@@ -0,0 +1,63 @@
+import type { TopologyVersion } from 'mongov4';
+/**
+ * @public
+ * @category Error
+ *
+ * @privateRemarks
+ * mongodb-client-encryption has a dependency on this error, it uses the constructor with a string argument
+ */
+export declare class MongoError extends Error {
+    /**
+     * This is a number in MongoServerError and a string in MongoDriverError
+     * @privateRemarks
+     * Define the type override on the subclasses when we can use the override keyword
+     */
+    code?: number | string;
+    topologyVersion?: TopologyVersion;
+    connectionGeneration?: number;
+    cause?: Error;
+    constructor(message: string | Error);
+    get name(): string;
+    /** Legacy name for server error responses */
+    get errmsg(): string;
+    /**
+     * Checks the error to see if it has an error label
+     *
+     * @param label - The error label to check for
+     * @returns returns true if the error has the provided error label
+     */
+    hasErrorLabel(label: string): boolean;
+    addErrorLabel(label: string): void;
+    get errorLabels(): string[];
+}
+/**
+ * An error generated by the driver
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoDriverError extends MongoError {
+    get name(): string;
+}
+/**
+ * An error generated when the driver API is used incorrectly
+ *
+ * @privateRemarks
+ * Should **never** be directly instantiated
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoAPIError extends MongoDriverError {
+    get name(): string;
+}
+/**
+ * An error thrown when an attempt is made to read from a cursor that has been exhausted
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoCursorExhaustedError extends MongoAPIError {
+    constructor(message?: string);
+    get name(): string;
+}

package/instrumentation/libraries/mongodb/mongoHelpers/getInternalSymbol.d.ts

@@ -0,0 +1 @@
+export declare function getInternalSymbol(obj: object, symbolDescription: string): symbol;

package/instrumentation/libraries/mongodb/mongoHelpers/makeReadableInputForBulkOpExecute.d.ts

@@ -0,0 +1,18 @@
+import type { OrderedBulkOperation, UnorderedBulkOperation } from '../modules/bulkOperation/MongoDbBulkOpExecuteMock';
+export type ReadableOperation = InsertOperation | UpdateOperation | DeleteOperation;
+type InsertOperation = {
+    operation: 'Insert';
+    document: unknown;
+};
+type UpdateOperation = {
+    operation: 'UpdateOne' | 'Update' | 'ReplaceOne';
+    query: unknown;
+    document: unknown;
+};
+type DeleteOperation = {
+    operation: 'Delete' | 'DeleteOne';
+    query: unknown;
+};
+export declare function makeReadableOperation(operation: any, batchType: any): ReadableOperation;
+export declare function makeReadableInputForBulkOpExecute(bulkOperationObj: OrderedBulkOperation | UnorderedBulkOperation, isOrdered: boolean): ReadableOperation[];
+export {};

package/instrumentation/libraries/mongodb/mongoHelpers/maybeCallback.d.ts

@@ -0,0 +1 @@
+export declare function maybeCallback(toBeExecuted: (cb: (err: any, output: any) => void) => void, callback?: (...args: unknown[]) => unknown): Promise<unknown>;

package/instrumentation/libraries/mongodb/mongoHelpers/processPayloadHelpers.d.ts

@@ -0,0 +1,16 @@
+import type { Jsonable } from '../../../../../../utils/types/jsonableTypes';
+import type { JsonableArray, JsonableMap } from '../../../../../../utils/types/jsonableTypes';
+type NonEmptyPath = [string, ...string[]];
+export type Meta = {
+    ObjectID: NonEmptyPath[];
+    Binary: NonEmptyPath[];
+    Timestamp: NonEmptyPath[];
+    UUID: NonEmptyPath[];
+};
+export type Sanitized<T> = ReturnType<typeof sanitizePayload<T>>['sanitizedPayload'];
+export declare const sanitizePayload: <T>(payload: T) => {
+    sanitizedPayload: T extends unknown[] ? JsonableArray : T extends Record<string, unknown> ? JsonableMap : Jsonable;
+    meta: Meta;
+};
+export declare const convertSanitizedPayloadToRealPayload: (sanitizedPayload: JsonableArray | JsonableMap, meta: Meta, version: string) => void;
+export {};

package/instrumentation/libraries/mongodb/mongoHelpers/removeConnectionAndMessageObj.d.ts

@@ -0,0 +1 @@
+export declare function removeConnectionAndMessageObj<T>(output: T): T;

package/instrumentation/libraries/mongodb/mongoHelpers/removeSessionAndSanitizeOptions.d.ts

@@ -0,0 +1,6 @@
+import type { JsonableMap } from '../../../../../../utils/types/jsonableTypes';
+import { type Meta as PathMeta } from './processPayloadHelpers';
+export declare function removeSessionAndSanitizeOptions(options: any): {
+    sanitizedOptions: JsonableMap;
+    optionsPathMeta: PathMeta;
+};

package/instrumentation/libraries/mongodb/utils.d.ts

@@ -0,0 +1,34 @@
+import type { Admin as AdminV4, AggregationCursor as AggregationCursorV4, Binary as BinaryV4, BulkWriteResult as BulkWriteResultV4, ClientSession as ClientSessionV4, Collection as CollectionV4, Db as DbV4, FindCursor as FindCursorV4, ListCollectionsCursor as ListCollectionsCursorV4, ListIndexesCursor as ListIndexesCursorV4, Long as LongV4, MongoDBNamespace as MongoDBNamespaceV4, ObjectId as ObjectIDV4, OrderedBulkOperation as OrderedBulkOperationV4, ReadConcern as ReadConcernV4, ReadPreference as ReadPreferenceV4, Timestamp as TimestampV4, UnorderedBulkOperation as UnorderedBulkOperationV4 } from 'mongov4';
+import type { Admin as AdminV5, AggregationCursor as AggregationCursorV5, Binary as BinaryV5, BulkWriteResult as BulkWriteResultV5, ClientSession as ClientSessionV5, Collection as CollectionV5, Db as DbV5, FindCursor as FindCursorV5, ListCollectionsCursor as ListCollectionsCursorV5, ListIndexesCursor as ListIndexesCursorV5, ListSearchIndexesCursor as ListSearchIndexesCursorV5, Long as LongV5, MongoDBNamespace as MongoDBNamespaceV5, ObjectId as ObjectIDV5, OrderedBulkOperation as OrderedBulkOperationV5, ReadConcern as ReadConcernV5, ReadPreference as ReadPreferenceV5, Timestamp as TimestampV5, UnorderedBulkOperation as UnorderedBulkOperationV5 } from 'mongov5';
+import type { Admin as AdminV6, AggregationCursor as AggregationCursorV6, Binary as BinaryV6, BulkWriteResult as BulkWriteResultV6, ClientSession as ClientSessionV6, Collection as CollectionV6, Db as DbV6, FindCursor as FindCursorV6, ListCollectionsCursor as ListCollectionsCursorV6, ListIndexesCursor as ListIndexesCursorV6, ListSearchIndexesCursor as ListSearchIndexesCursorV6, Long as LongV6, MongoDBNamespace as MongoDBNamespaceV6, ObjectId as ObjectIDV6, OrderedBulkOperation as OrderedBulkOperationV6, ReadConcern as ReadConcernV6, ReadPreference as ReadPreferenceV6, Timestamp as TimestampV6, UUID as UUIDV6, UnorderedBulkOperation as UnorderedBulkOperationV6 } from 'mongov6';
+import type { AnyFunction } from '../../../../../utils/types';
+export declare function startsWith(versionString: string): string;
+export type ClassStore = {
+    ObjectId: typeof ObjectIDV4 | typeof ObjectIDV5 | typeof ObjectIDV6;
+    Binary: typeof BinaryV4 | typeof BinaryV5 | typeof BinaryV6;
+    Timestamp: typeof TimestampV4 | typeof TimestampV5 | typeof TimestampV6;
+    Long: typeof LongV4 | typeof LongV5 | typeof LongV6;
+    OrderedBulkOperation: typeof OrderedBulkOperationV4 | typeof OrderedBulkOperationV5 | typeof OrderedBulkOperationV6;
+    UnorderedBulkOperation: typeof UnorderedBulkOperationV4 | typeof UnorderedBulkOperationV5 | typeof UnorderedBulkOperationV6;
+    BulkWriteResult: typeof BulkWriteResultV4 | typeof BulkWriteResultV5 | typeof BulkWriteResultV6;
+    ListSearchIndexesCursor: typeof ListSearchIndexesCursorV5 | typeof ListSearchIndexesCursorV6;
+    AggregationCursor: typeof AggregationCursorV4 | typeof AggregationCursorV5 | typeof AggregationCursorV6;
+    FindCursor: typeof FindCursorV4 | typeof FindCursorV5 | typeof FindCursorV6;
+    ListIndexesCursor: typeof ListIndexesCursorV4 | typeof ListIndexesCursorV5 | typeof ListIndexesCursorV6;
+    ListCollectionsCursor: typeof ListCollectionsCursorV4 | typeof ListCollectionsCursorV5 | typeof ListCollectionsCursorV6;
+    ReadPreference: typeof ReadPreferenceV4 | typeof ReadPreferenceV5 | typeof ReadPreferenceV6;
+    ReadConcern: typeof ReadConcernV4 | typeof ReadConcernV5 | typeof ReadConcernV6;
+    MongoDBNamespace: typeof MongoDBNamespaceV4 | typeof MongoDBNamespaceV5 | typeof MongoDBNamespaceV6;
+    Collection: typeof CollectionV4 | typeof CollectionV5 | typeof CollectionV6;
+    Admin: typeof AdminV4 | typeof AdminV5 | typeof AdminV6;
+    ClientSession: typeof ClientSessionV4 | typeof ClientSessionV5 | typeof ClientSessionV6;
+    ServerSessionPool: unknown;
+    CommandResult: unknown;
+    UUID: typeof UUIDV6;
+    Db: typeof DbV4 | typeof DbV5 | typeof DbV6;
+};
+declare const classStore: Map<string, Partial<ClassStore>>;
+export declare function insertInClassStore(version: string, classStoreObj: Partial<ClassStore>): void;
+export declare function getFromClassStore<T extends keyof ClassStore>(version: string, className: T): ClassStore[T];
+export { classStore };
+export declare function patchCallbackToOriginalArgs(orignialFnArgs: unknown[], patchedCbFn: AnyFunction, cbIndex?: number): void;

package/instrumentation/libraries/mongoose/MongooseCursor.d.ts

@@ -0,0 +1,21 @@
+import { Readable } from 'stream';
+export declare class MockCursor extends Readable {
+    currentIndex: number;
+    error: unknown;
+    data: unknown;
+    shouldAddModelPrototype: boolean;
+    prototypeToSet: unknown;
+    _HtObjectId: unknown;
+    submoduleName: string;
+    constructor(data: any, _HtObjectId: any, submoduleName: string, error?: any, shouldAddModelPrototype?: boolean, prototypeToSet?: any);
+    eachAsync(fn: any, opts: {}, callback: any): Promise<any>;
+    next(callback: any): any;
+    _read(): void;
+    addCursorFlag(): void;
+    rewind(): void;
+    close(): void;
+    [Symbol.asyncIterator](): {
+        next: () => any;
+        [Symbol.asyncIterator](): any;
+    };
+}

package/instrumentation/libraries/mongoose/instrumentation.d.ts

@@ -0,0 +1,32 @@
+import { HtInstrumentationBase } from '../../core/baseClasses/HtInstrumentationBase';
+import { HtInstrumentationNodeModule } from '../../core/baseClasses/HtInstrumentationNodeModule';
+export declare class HtMongooseInstrumentation extends HtInstrumentationBase {
+    constructor(config?: {});
+    protected init(): HtInstrumentationNodeModule<any>[];
+    private patchAsyncOrErrOnlyCallbackFn;
+    private patchAsyncOrCallbackFn;
+    private getDBConnectPatch;
+    private getDBDisconnectPatch;
+    private getDBCreateConnectionPatch;
+    private getQueryPatchFunc;
+    private getModelCreatePatch;
+    private getModelInsertManyPatch;
+    private getModelCleanNListIndexesPatch;
+    private getModelCreateNDiffNEnsureNSyncIndexesPatch;
+    private getModelCreateCollectionPatch;
+    private getModelMapReducePatch;
+    private getQueryCursorPatch;
+    private getAggregateCursorPatch;
+    private getQueryAsyncIteratorPatch;
+    private getAggregateAsyncIteratorPatch;
+    private getModelInitPatch;
+    private getTransactionPatch;
+    private getMongooseNModelStartSessionPatch;
+    private getModelBulkWritePatch;
+    private getMongooseNModelWatch;
+    private getModelInstanceRemovePatch;
+    private getModelInstanceSavePatch;
+    private getAggregateExecPatch;
+    private getAggregateV5ExecPatch;
+    private getPatchedCursor;
+}

package/instrumentation/libraries/mongoose/internalTypes.d.ts

@@ -0,0 +1,19 @@
+import type { AnyFunction } from '../../../../../utils/types';
+import type { HtMongooseInstrumentation } from './instrumentation';
+export type FunctionPatchParams = {
+    plugin: HtMongooseInstrumentation;
+    submoduleName: string;
+    inputArgs: unknown[];
+    readableInput: Record<string, unknown>;
+    originalFn: AnyFunction;
+    thisValue: Record<string, unknown>;
+    callback?: AnyFunction;
+    shouldAddModelPrototype?: boolean;
+    prototypeToSet?: Record<string, unknown>;
+    shouldHandleToJsonAndObjectIds?: boolean;
+    isImportantMock?: boolean;
+    version?: string;
+    inputMeta?: Record<string, unknown>;
+    shouldSetMapAsEnumerable?: boolean;
+    shouldLogMockNotFoundError?: boolean;
+};

package/instrumentation/libraries/mongoose/mocks/MongooseMock.d.ts

@@ -0,0 +1,40 @@
+import { type FunctionTypeEnum } from '../../../../../../utils/types';
+import type { Jsonable } from '../../../../../../utils/types/jsonableTypes';
+import type { HtInstrumentationBase } from '../../../core/baseClasses/HtInstrumentationBase';
+import { HtInstrumentationMockAbstract } from '../../../core/baseClasses/HtInstrumentationMockAbstract';
+import type { Meta as PathMeta } from '../mongooseHelpers/processPayloadHelpers';
+type EmptyObject = Record<string, never>;
+type InputMeta = EmptyObject | {
+    FilterPathMeta?: PathMeta;
+    OptionsPathMeta?: PathMeta;
+    DocsPathMeta?: PathMeta;
+};
+type ReadableInput = Record<string, Jsonable>;
+type ProcessedInput = ReadableInput;
+type ProcessedInputSchema = ReadableInput;
+type OutputMeta = EmptyObject | {
+    pathMeta?: PathMeta;
+};
+type RealOutput = Jsonable;
+type ReadableOutput = RealOutput;
+type ProcessedOutputSchema = RealOutput;
+export default class MongooseMock extends HtInstrumentationMockAbstract<InputMeta, ReadableInput, ProcessedInput, ProcessedInputSchema, OutputMeta, RealOutput, ReadableOutput, ProcessedOutputSchema> {
+    static mockSymbol: symbol;
+    unsantizedRealOutput: unknown;
+    shouldHandleToJsonAndObjectIds: boolean;
+    static get mockVersion(): number;
+    constructor({ plugin, packageName, submoduleName, functionType, isImportantMock, shouldHandleToJsonAndObjectIds, }: {
+        plugin: HtInstrumentationBase;
+        packageName: string;
+        submoduleName: string;
+        functionType: FunctionTypeEnum;
+        isImportantMock: boolean;
+        shouldHandleToJsonAndObjectIds?: boolean;
+    });
+    generateProcessedInput(): ProcessedInput;
+    generateProcessedInputSchema(): ProcessedInputSchema;
+    setOutput(realOutput: Jsonable, emptyDefaultPathMeta?: {}): void;
+    generateReadableOutput(realOutput: RealOutput): ReadableOutput;
+    generateProcessedOutputSchema(): ProcessedOutputSchema;
+}
+export {};

package/instrumentation/libraries/mongoose/mongooseHelpers/processPayloadHelpers.d.ts

@@ -0,0 +1,13 @@
+import type { Jsonable } from '../../../../../../utils/types/jsonableTypes';
+import type { JsonableArray, JsonableMap } from '../../../../../../utils/types/jsonableTypes';
+type NonEmptyPath = [string, ...string[]];
+export type Meta = {
+    ObjectID: NonEmptyPath[];
+};
+export type Sanitized<T> = ReturnType<typeof sanitizePayload<T>>['sanitizedPayload'];
+export declare const sanitizePayload: <T>(payload: T) => {
+    sanitizedPayload: T extends unknown[] ? JsonableArray : T extends Record<string, unknown> ? JsonableMap : Jsonable;
+    meta: Meta;
+};
+export declare const convertSanitizedPayloadToRealPayload: (sanitizedPayload: JsonableArray | JsonableMap, meta: Meta, version: string) => void;
+export {};

package/instrumentation/libraries/mongoose/utils.d.ts

@@ -0,0 +1,25 @@
+import type { ChangeStream as ChangeStreamV5, Connection as HtConnectionV5, ObjectId as ObjectIDV5 } from 'mongooseV5';
+import type { ChangeStream as ChangeStreamV6, Connection as HtConnectionV6, ObjectId as ObjectIDV6 } from 'mongooseV6';
+import type { ChangeStream as ChangeStreamV7, Connection as HtConnectionV7, ObjectId as ObjectIDV7 } from 'mongooseV7';
+import type { ChangeStream as ChangeStreamV8, Connection as HtConnectionV8, ObjectId as ObjectIDV8 } from 'mongooseV8';
+import type { AnyFunction } from '../../../../../utils/types';
+export declare function modulesArray(moduleExports: any): {
+    module: any;
+    method: string;
+    subModuleName: string;
+}[];
+export declare function removeSessionFromOptions(options: any): any;
+export declare function normalizeInputParams(options?: Record<string, unknown>, callback?: AnyFunction): {
+    inputArgs: unknown[];
+    restOptions: {};
+};
+export declare function setModelPrototype(row: any, prototypeToSet: any, shouldSetMapAsEnumerable?: boolean): void;
+export type ClassStore = {
+    ObjectId: typeof ObjectIDV5 | typeof ObjectIDV6 | typeof ObjectIDV7 | typeof ObjectIDV8;
+    HtConnection: typeof HtConnectionV5 | typeof HtConnectionV6 | typeof HtConnectionV7 | typeof HtConnectionV8;
+    ChangeStream: typeof ChangeStreamV5 | typeof ChangeStreamV6 | typeof ChangeStreamV7 | typeof ChangeStreamV8;
+};
+declare const classStore: Map<string, Partial<ClassStore>>;
+export declare function insertInClassStore(version: string, classStoreObj: Partial<ClassStore>): void;
+export declare function getFromClassStore<T extends keyof ClassStore>(version: string, className: T): ClassStore[T];
+export { classStore };