@hypertestco/node-sdk-v3 0.0.1-8

package/instrumentation/libraries/mysql2/instrumentation.d.ts

@@ -0,0 +1,62 @@
+import type * as Mysql2TypesOriginal from 'mysql2/typings/mysql/index';
+import type { Connection } from 'mysql2/typings/mysql/lib/Connection';
+import type { Pool } from 'mysql2/typings/mysql/lib/Pool';
+import type { PoolCluster } from 'mysql2/typings/mysql/lib/PoolCluster';
+import type { PoolConnection } from 'mysql2/typings/mysql/lib/PoolConnection';
+import { HtInstrumentationBase } from '../../core/baseClasses/HtInstrumentationBase';
+import { HtInstrumentationNodeModule } from '../../core/baseClasses/HtInstrumentationNodeModule';
+type Mysql2Types = typeof Mysql2TypesOriginal & {
+    Connection: Connection;
+};
+export declare class HtMysql2Instrumentation extends HtInstrumentationBase {
+    _HT_Patched_Connection: any;
+    _Original_Connection: typeof Connection;
+    _HT_Patched_Pool: any;
+    _Original_Pool: typeof Pool;
+    _Original_PoolConnection: typeof PoolConnection;
+    _HT_Patched_Pool_Connection: any;
+    _HT_Patched_Promise_Pool_Connection: any;
+    _Original_PoolCluster: typeof PoolCluster;
+    _HT_Patched_PoolCluster: any;
+    constructor(options?: {
+        enabled: boolean;
+    });
+    manuallyPatchMysql2(originalMysql2: Mysql2Types, version: string): unknown;
+    protected init(): HtInstrumentationNodeModule<Mysql2Types>[];
+    private getMockConnectionForReplayMode;
+    private getMockPoolConnectionForReplayMode;
+    private getPatchedConnectionClass;
+    private getPatchedPromiseConnectionClass;
+    private getPatchedPoolClass;
+    private getPatchedPoolConnectionClass;
+    private getPatchedPoolClusterClass;
+    private getPoolGetConnectionFn;
+    private getPatchedStreamFn;
+    /**
+     * Checks if given packet is of type ResultSetHeader.
+     * For non select queries ResultSetHeader object is emitted for result
+     */
+    private _isResultSetHeaderPacket;
+    /**
+     * Determins no. of queries executed using private property _resultIndex.
+     * Mysql results shape changes for multi statement queries
+     * And it depends on this property for it
+     *
+     * WARNING!: Should be used after receiving all the results
+     */
+    private _getQueryCount;
+    private getExecuteQueryCommonFn;
+    private getPatchedQueryFn;
+    private getPatchedExecuteFn;
+    private executeFnWithPatchedCallback;
+    private getPatchedPingFn;
+    private getPatchedEndFn;
+    private getPatchedChangeUserFn;
+    private getPatchedBeginTransactionFn;
+    private getPatchedCommitTransactionFn;
+    private getPatchedRollbackTransactionFn;
+    private getPatchedPrepareFn;
+    private getPatchedPreparedExecuteFnForReplay;
+    private getPoolClusterGetConnectionPatchFn;
+}
+export {};

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

@@ -0,0 +1,26 @@
+import type { QueryOptions } from 'mysql2';
+/**
+ * ColumnDefinition is an internal class which probably extends FieldPacket
+ * We are not concerned with other properties of FieldPacket so we created a new type
+ */
+export type ColumnDefinition = {
+    name: string;
+    columnType: number;
+};
+export type Mysql2NonSelectResult = {
+    fieldCount: number;
+    affectedRows: number;
+    insertId: number;
+    info: string;
+    serverStatus: number;
+    warningStatus: number;
+    stateChanges: Record<string, any>;
+};
+export type QueryInputvalues = string | any[] | {
+    [param: string]: any;
+};
+export type QueryResult = Record<string, any>[] | Mysql2NonSelectResult | Array<Record<string, any>[] | Mysql2NonSelectResult>;
+export type QueryResultFields = ColumnDefinition[] | ColumnDefinition[][];
+export type HtMysql2QueryOptions = Omit<QueryOptions, 'sql' | 'values' | 'timeout' | 'typeCast' | 'infileStreamFactory'> & {
+    infileStreamFactoryGiven?: boolean;
+};

package/instrumentation/libraries/mysql2/mocks/Mysql2ConnectMock.d.ts

@@ -0,0 +1,27 @@
+import { type FunctionTypeEnum } from '../../../../../../utils/types';
+import type { HtInstrumentationBase } from '../../../core/baseClasses/HtInstrumentationBase';
+import { HtInstrumentationMockAbstract } from '../../../core/baseClasses/HtInstrumentationMockAbstract';
+type EmpytyObject = Record<string, never>;
+type InputMeta = EmpytyObject;
+type ReadableInput = EmpytyObject;
+type ProcessedInput = EmpytyObject;
+type ProcessedInputSchema = EmpytyObject;
+type OutputMeta = EmpytyObject;
+type RealOutput = EmpytyObject;
+type ReadableOutput = EmpytyObject;
+type ProcessedOutputSchema = EmpytyObject;
+export default class Mysql2ConnectMock extends HtInstrumentationMockAbstract<InputMeta, ReadableInput, ProcessedInput, ProcessedInputSchema, OutputMeta, RealOutput, ReadableOutput, ProcessedOutputSchema> {
+    static mockSymbol: symbol;
+    static get mockVersion(): number;
+    constructor({ plugin, packageName, submoduleName, functionType, }: {
+        plugin: HtInstrumentationBase;
+        packageName: string;
+        submoduleName: string;
+        functionType: FunctionTypeEnum;
+    });
+    generateProcessedInput(): {};
+    generateProcessedInputSchema(): ProcessedInputSchema;
+    generateProcessedOutputSchema(): ProcessedOutputSchema;
+    generateReadableOutput(): ReadableOutput;
+}
+export {};

package/instrumentation/libraries/mysql2/mocks/Mysql2ErrOnlyCallbackMock.d.ts

@@ -0,0 +1,29 @@
+import type { JsonSchema } from '../../../../../../utils/jsonSchemaDiffGenerator/jsonSchemaTypes';
+import { type FunctionTypeEnum } from '../../../../../../utils/types';
+import type { HtInstrumentationBase } from '../../../core/baseClasses/HtInstrumentationBase';
+import { HtInstrumentationMockAbstract } from '../../../core/baseClasses/HtInstrumentationMockAbstract';
+type EmpytyObject = Record<string, never>;
+type InputMeta = EmpytyObject;
+type ReadableInput = Record<string, string> | EmpytyObject;
+type ProcessedInput = ReadableInput;
+type ProcessedInputSchema = JsonSchema;
+type OutputMeta = EmpytyObject;
+type RealOutput = EmpytyObject;
+type ReadableOutput = RealOutput;
+type ProcessedOutputSchema = RealOutput;
+export default class Mysql2ErrOnlyCallbackMock extends HtInstrumentationMockAbstract<InputMeta, ReadableInput, ProcessedInput, ProcessedInputSchema, OutputMeta, RealOutput, ReadableOutput, ProcessedOutputSchema> {
+    static mockSymbol: symbol;
+    static get mockVersion(): number;
+    constructor({ plugin, packageName, submoduleName, functionType, isImportantMock, }: {
+        plugin: HtInstrumentationBase;
+        packageName: string;
+        submoduleName: string;
+        functionType: FunctionTypeEnum;
+        isImportantMock: boolean;
+    });
+    generateProcessedInput(): ReadableInput;
+    generateProcessedInputSchema(): ProcessedInputSchema;
+    generateProcessedOutputSchema(realOutput: RealOutput): ProcessedOutputSchema;
+    generateReadableOutput(realOutput: RealOutput): ReadableOutput;
+}
+export {};

package/instrumentation/libraries/mysql2/mocks/Mysql2PrepareMock.d.ts

@@ -0,0 +1,36 @@
+import { type FunctionTypeEnum } from '../../../../../../utils/types';
+import type { HtInstrumentationBase } from '../../../core/baseClasses/HtInstrumentationBase';
+import { HtInstrumentationMockAbstract } from '../../../core/baseClasses/HtInstrumentationMockAbstract';
+import { type HT_AST } from '../../../helpers/sqlParser';
+type EmpytyObject = Record<string, never>;
+type InputMeta = EmpytyObject;
+type ReadableInput = {
+    queryText: string;
+};
+type ProcessedInput = {
+    parsedSql: HT_AST | HT_AST[];
+};
+type ProcessedInputSchema = {
+    parsedSqlSchema: HT_AST | HT_AST[];
+};
+type OutputMeta = EmpytyObject;
+type RealOutput = EmpytyObject;
+type ReadableOutput = EmpytyObject;
+type ProcessedOutputSchema = EmpytyObject;
+export default class Mysql2PrepareMock extends HtInstrumentationMockAbstract<InputMeta, ReadableInput, ProcessedInput, ProcessedInputSchema, OutputMeta, RealOutput, ReadableOutput, ProcessedOutputSchema> {
+    static mockSymbol: symbol;
+    static get mockVersion(): number;
+    constructor({ plugin, packageName, submoduleName, functionType, }: {
+        plugin: HtInstrumentationBase;
+        packageName: string;
+        submoduleName: string;
+        functionType: FunctionTypeEnum;
+    });
+    generateProcessedInput(): {
+        parsedSql: HT_AST | HT_AST[];
+    };
+    generateProcessedInputSchema(): ProcessedInputSchema;
+    generateProcessedOutputSchema(realOutput: RealOutput): ProcessedOutputSchema;
+    generateReadableOutput(realOutput: RealOutput): ReadableOutput;
+}
+export {};

package/instrumentation/libraries/mysql2/mocks/Mysql2QueryMock.d.ts

@@ -0,0 +1,60 @@
+import type { JsonSchemaWithoutValues } from '../../../../../../utils/jsonSchemaDiffGenerator/jsonSchemaTypes';
+import { type FunctionTypeEnum } from '../../../../../../utils/types';
+import type { HtInstrumentationBase } from '../../../core/baseClasses/HtInstrumentationBase';
+import { HtInstrumentationMockAbstract } from '../../../core/baseClasses/HtInstrumentationMockAbstract';
+import { type HT_AST } from '../../../helpers/sqlParser';
+import type { HtMysql2QueryOptions, QueryInputvalues, QueryResult, QueryResultFields } from '../internalTypes';
+type InputMeta = Record<string, any>;
+export type ReadableInput = {
+    queryText: string;
+    values: QueryInputvalues;
+    options: HtMysql2QueryOptions;
+};
+type ProcessedInput = {
+    parsedSql: HT_AST | HT_AST[];
+    values: QueryInputvalues;
+    options: HtMysql2QueryOptions;
+};
+type ProcessedInputSchema = {
+    parsedSqlSchema: HT_AST | HT_AST[];
+    options: JsonSchemaWithoutValues;
+};
+type OutputMeta = {
+    queryCount: number;
+    errQueryIndex?: number;
+};
+type RealOutput = {
+    result: QueryResult;
+    fields: QueryResultFields;
+};
+type ReadableOutput = {
+    rows: QueryResult;
+};
+type ProcessedOutputSchema = {
+    columnTypes: Record<string, number> | Record<string, number>[];
+};
+export default class Mysql2QueryMock extends HtInstrumentationMockAbstract<InputMeta, ReadableInput, ProcessedInput, ProcessedInputSchema, OutputMeta, RealOutput, ReadableOutput, ProcessedOutputSchema> {
+    static mockSymbol: symbol;
+    static get mockVersion(): number;
+    constructor({ plugin, packageName, submoduleName, functionType, }: {
+        plugin: HtInstrumentationBase;
+        packageName: string;
+        submoduleName: string;
+        functionType: FunctionTypeEnum;
+    });
+    setReadableInput(readableInput: ReadableInput, inputMeta: InputMeta): void;
+    generateProcessedInput(): {
+        parsedSql: HT_AST | HT_AST[];
+        values: QueryInputvalues;
+        options: HtMysql2QueryOptions;
+    };
+    generateProcessedInputSchema(): ProcessedInputSchema;
+    generateProcessedOutputSchema(realOutput: RealOutput): ProcessedOutputSchema;
+    generateReadableOutput(realOutput: RealOutput): ReadableOutput;
+}
+/**
+ * The readable input generated here would have different formatting for the SQL string than the original one.
+ * Always compare the two re-generated inputs from this function to get accurate results
+ */
+export declare const generateReadableInputFromProcessedInputMysql2QueryMock: (processedInput: ProcessedInput) => ReadableInput;
+export {};

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

@@ -0,0 +1,12 @@
+export declare function isObjectWithSqlString(it: unknown): it is ObjectWithSqlString;
+export type ObjectWithSqlString = {
+    [k: string]: unknown;
+    sql: string;
+};
+/**
+ * Marks "SET TIMEZONE", and "GET VERSION" queries as unimportant queries.
+ * Trying to optimize mocks generated by sequilize, these queries are part of connection made by sequilize-pool,
+ * having these queries as important mocks can introduces unwanted request duplication
+ * */
+export declare function isImportantConnectionQuery(sql: string): boolean;
+export declare function isArrayOfArrays<T>(obj: T, key: keyof T): boolean;

package/instrumentation/libraries/node-cache/instrumentation.d.ts

@@ -0,0 +1,9 @@
+import { HtInstrumentationBase } from '../../core/baseClasses/HtInstrumentationBase';
+import { HtInstrumentationNodeModule } from '../../core/baseClasses/HtInstrumentationNodeModule';
+export declare class HtNodeCacheInstrumentation extends HtInstrumentationBase {
+    constructor(options?: {
+        enabled: boolean;
+    });
+    protected init(): HtInstrumentationNodeModule<any>;
+    private _getPatchNodeCacheMethods;
+}

package/instrumentation/libraries/node-cache/mocks/NodeCacheMock.d.ts

@@ -0,0 +1,37 @@
+import { type FunctionTypeEnum } from '../../../../../../utils/types';
+import type { HtInstrumentationBase } from '../../../core/baseClasses/HtInstrumentationBase';
+import { HtInstrumentationMockAbstract } from '../../../core/baseClasses/HtInstrumentationMockAbstract';
+import type { JsonSchema, JsonSchemaWithoutValues } from '../../../../../../utils/jsonSchemaDiffGenerator/jsonSchemaTypes';
+import type { Jsonable } from '../../../../../../utils/types/jsonableTypes';
+type InputMeta = Record<string, never>;
+export type ReadableInput = {
+    key?: string | number;
+    value?: Jsonable;
+    ttl?: number;
+    keys?: (string | number)[];
+    keyValueSet?: Record<string | number, Jsonable>;
+};
+type ProcessedInput = JsonSchema;
+type ProcessedInputSchema = JsonSchemaWithoutValues;
+type OutputMeta = Record<string, never>;
+type RealOutput = {
+    returnValue: Jsonable;
+};
+type ReadableOutput = RealOutput;
+type ProcessedOutputSchema = JsonSchemaWithoutValues;
+export default class NodeCacheMock extends HtInstrumentationMockAbstract<InputMeta, ReadableInput, ProcessedInput, ProcessedInputSchema, OutputMeta, RealOutput, ReadableOutput, ProcessedOutputSchema> {
+    static mockSymbol: symbol;
+    static get mockVersion(): number;
+    constructor({ plugin, packageName, submoduleName, functionType, isImportantMock, }: {
+        plugin: HtInstrumentationBase;
+        packageName: string;
+        submoduleName: string;
+        functionType: FunctionTypeEnum;
+        isImportantMock: boolean;
+    });
+    generateProcessedInput(): JsonSchema;
+    generateProcessedInputSchema(): ProcessedInputSchema;
+    generateProcessedOutputSchema(realOutput: RealOutput): ProcessedOutputSchema;
+    generateReadableOutput(realOutput: RealOutput): ReadableOutput;
+}
+export {};

package/instrumentation/libraries/nodemailer/instrumentation.d.ts

@@ -0,0 +1,11 @@
+import type * as Nodemailer from 'nodemailer';
+import { HtInstrumentationBase } from '../../core/baseClasses/HtInstrumentationBase';
+import { HtInstrumentationNodeModule } from '../../core/baseClasses/HtInstrumentationNodeModule';
+export declare class HtNodemailerInstrumentation extends HtInstrumentationBase {
+    constructor(options?: {
+        enabled: boolean;
+    });
+    protected init(): HtInstrumentationNodeModule<typeof Nodemailer>[];
+    private getSendMailPatchFn;
+    private getVerifyPatchFn;
+}

package/instrumentation/libraries/nodemailer/mocks/NodemailerSendMailMock.d.ts

@@ -0,0 +1,32 @@
+import type * as Mail from 'nodemailer/lib/mailer';
+import type { JsonSchemaWithoutValues } from '../../../../../../utils/jsonSchemaDiffGenerator/jsonSchemaTypes';
+import type { FunctionTypeEnum } from '../../../../../../utils/types';
+import type { JsonableMap } from '../../../../../../utils/types/jsonableTypes';
+import type { HtInstrumentationBase } from '../../../core/baseClasses/HtInstrumentationBase';
+import { HtInstrumentationMockAbstract } from '../../../core/baseClasses/HtInstrumentationMockAbstract';
+type EmptyObject = Record<string, never>;
+export type InputMeta = EmptyObject;
+export type ReadableInput = Pick<Mail.Options, 'from' | 'sender' | 'to' | 'cc' | 'bcc' | 'replyTo' | 'inReplyTo' | 'references' | 'subject' | 'headers' | 'list' | 'envelope' | 'messageId' | 'disableUrlAccess' | 'disableFileAccess' | 'dkim' | 'priority' | 'attachDataUrls'> & {
+    date: string;
+};
+type ProcessedInput = Omit<ReadableInput, 'date' | 'messageId'>;
+type ProcessedInputSchema = JsonSchemaWithoutValues;
+type OutputMeta = EmptyObject;
+type RealOutput = JsonableMap;
+type ReadableOutput = RealOutput;
+type ProcessedOutputSchema = RealOutput;
+export default class NodemailerSendMailMock extends HtInstrumentationMockAbstract<InputMeta, ReadableInput, ProcessedInput, ProcessedInputSchema, OutputMeta, RealOutput, ReadableOutput, ProcessedOutputSchema> {
+    static mockSymbol: symbol;
+    static get mockVersion(): number;
+    constructor({ plugin, packageName, submoduleName, functionType, }: {
+        plugin: HtInstrumentationBase;
+        packageName: string;
+        submoduleName: string;
+        functionType: FunctionTypeEnum;
+    });
+    generateProcessedInput(): ProcessedInput;
+    generateProcessedInputSchema(): ProcessedInputSchema;
+    generateReadableOutput(realOutput: RealOutput): ReadableOutput;
+    generateProcessedOutputSchema(realOutput: RealOutput): ProcessedOutputSchema;
+}
+export {};

package/instrumentation/libraries/nodemailer/mocks/NodemailerVerifyMock.d.ts

@@ -0,0 +1,28 @@
+import type { JsonSchemaWithoutValues } from '../../../../../../utils/jsonSchemaDiffGenerator/jsonSchemaTypes';
+import { type FunctionTypeEnum } from '../../../../../../utils/types';
+import type { HtInstrumentationBase } from '../../../core/baseClasses/HtInstrumentationBase';
+import { HtInstrumentationMockAbstract } from '../../../core/baseClasses/HtInstrumentationMockAbstract';
+type EmptyObject = Record<string, never>;
+export type InputMeta = EmptyObject;
+export type ReadableInput = EmptyObject;
+type ProcessedInput = EmptyObject;
+type ProcessedInputSchema = EmptyObject;
+type OutputMeta = EmptyObject;
+type RealOutput = boolean;
+type ReadableOutput = RealOutput;
+type ProcessedOutputSchema = JsonSchemaWithoutValues;
+export default class NodemailerVerifyMock extends HtInstrumentationMockAbstract<InputMeta, ReadableInput, ProcessedInput, ProcessedInputSchema, OutputMeta, RealOutput, ReadableOutput, ProcessedOutputSchema> {
+    static mockSymbol: symbol;
+    static get mockVersion(): number;
+    constructor({ plugin, packageName, submoduleName, functionType, }: {
+        plugin: HtInstrumentationBase;
+        packageName: string;
+        submoduleName: string;
+        functionType: FunctionTypeEnum;
+    });
+    generateProcessedInput(): ProcessedInput;
+    generateProcessedInputSchema(): ProcessedInputSchema;
+    generateReadableOutput(realOutput: RealOutput): ReadableOutput;
+    generateProcessedOutputSchema(realOutput: RealOutput): ProcessedOutputSchema;
+}
+export {};

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

@@ -0,0 +1,10 @@
+import type * as Mail from 'nodemailer/lib/mailer';
+import type { AnyFunction } from '../../../../../utils/types';
+import type { InputMeta, ReadableInput } from './mocks/NodemailerSendMailMock';
+import type NodemailerSendMailMock from './mocks/NodemailerSendMailMock';
+import type NodemailerVerifyMock from './mocks/NodemailerVerifyMock';
+export declare const getInputAndInputMeta: (inputArgs: Parameters<typeof Mail.prototype.sendMail>) => {
+    readableInput: ReadableInput;
+    inputMeta: InputMeta;
+};
+export declare const patchedCallbackHelper: (mock: NodemailerSendMailMock | NodemailerVerifyMock, originalCallback: AnyFunction) => (err: any, data: any) => any;

package/instrumentation/libraries/opossum/instrumentation.d.ts

@@ -0,0 +1,9 @@
+import { HtInstrumentationBase } from '../../core/baseClasses/HtInstrumentationBase';
+import { HtInstrumentationNodeModule } from '../../core/baseClasses/HtInstrumentationNodeModule';
+export declare class HtOpossumInstrumentation extends HtInstrumentationBase {
+    _Original_CircuitBreaker: any;
+    _HT_Patched_CircuitBreaker: any;
+    constructor(config?: {});
+    protected init(): HtInstrumentationNodeModule<any>[];
+    private getPatchedCircuitBreakerClass;
+}