@hypertestco/node-sdk-v3 0.0.1-8

package/instrumentation/libraries/mysql/instrumentation.d.ts

@@ -0,0 +1,34 @@
+import type MysqlTypes from 'mysql';
+import { HtInstrumentationBase } from '../../core/baseClasses/HtInstrumentationBase';
+import { HtInstrumentationNodeModule } from '../../core/baseClasses/HtInstrumentationNodeModule';
+export declare class HtMysqlInstrumentation extends HtInstrumentationBase {
+    private _HTCreateQuery;
+    constructor(options?: {
+        enabled: boolean;
+    });
+    manuallyPatchMysql(originalMysql: typeof MysqlTypes, version: string): typeof MysqlTypes;
+    protected init(): HtInstrumentationNodeModule<any>[];
+    private getPatchedStreamFn;
+    /**
+     * Checks if given packet is of type OkPacket.
+     * For non select queries OkPacket object is emitted for result
+     */
+    private _isOkPacket;
+    /**
+     * Determins no. of queries executed using private property _index.
+     *
+     * WARNING!: Should be used after receiving all the results
+     */
+    private _getQueryCount;
+    private getPatchedQueryFn;
+    private executeFnWithPatchedCallback;
+    private getPatchedConnectFn;
+    private getPatchedChangeUserFn;
+    private getPatchedPingFn;
+    private getPatchedEndFn;
+    private getPatchedPauseFn;
+    private getPatchedResumeFn;
+    private getPatchedBeginTransactionFn;
+    private getPatchedCommitTransactionFn;
+    private getPatchedRollbackTransactionFn;
+}

package/instrumentation/libraries/mysql/mocks/MysqlErrOnlyCallbackMock.d.ts

@@ -0,0 +1,28 @@
+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, any> | EmpytyObject;
+type ProcessedInput = ReadableInput;
+type ProcessedInputSchema = JsonSchema;
+type OutputMeta = EmpytyObject;
+type RealOutput = EmpytyObject;
+type ReadableOutput = RealOutput;
+type ProcessedOutputSchema = RealOutput;
+export default class MysqlErrOnlyCallbackMock extends HtInstrumentationMockAbstract<InputMeta, ReadableInput, ProcessedInput, ProcessedInputSchema, OutputMeta, RealOutput, ReadableOutput, ProcessedOutputSchema> {
+    static mockSymbol: symbol;
+    static get mockVersion(): number;
+    constructor({ plugin, submoduleName, functionType, isImportantMock, }: {
+        plugin: HtInstrumentationBase;
+        submoduleName: string;
+        functionType: FunctionTypeEnum;
+        isImportantMock: boolean;
+    });
+    generateProcessedInput(): ReadableInput;
+    generateProcessedInputSchema(): ProcessedInputSchema;
+    generateProcessedOutputSchema(realOutput: RealOutput): ProcessedOutputSchema;
+    generateReadableOutput(realOutput: RealOutput): ReadableOutput;
+}
+export {};

package/instrumentation/libraries/mysql/mocks/MysqlQueryMock.d.ts

@@ -0,0 +1,62 @@
+import type { FieldInfo, OkPacket, QueryOptions } from 'mysql';
+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 HtQueryOptions = Omit<QueryOptions, 'sql' | 'values' | 'timeout' | 'typeCast'>;
+type EmptyObject = Record<string, never>;
+type InputMeta = {
+    streamOptions: {
+        highWaterMark?: number;
+        objectMode?: boolean;
+    };
+} | EmptyObject;
+type ReadableInput = {
+    queryText: string;
+    values: any[];
+    options: HtQueryOptions;
+};
+type ProcessedInput = {
+    parsedSql: HT_AST | HT_AST[];
+    values: any[];
+    options: HtQueryOptions;
+};
+type ProcessedInputSchema = {
+    parsedSqlSchema: HT_AST | HT_AST[];
+    options: HtQueryOptions;
+};
+type OutputMeta = {
+    queryCount: number;
+    errQueryIndex?: number;
+};
+export type RealOutput = {
+    results: OkPacket | Array<OkPacket | Record<string, any>>;
+    fields: FieldInfo[] | FieldInfo[][];
+};
+type ReadableOutput = {
+    results: OkPacket | Array<OkPacket | Record<string, any>>;
+};
+type ProcessedOutputSchema = {
+    columnTypes: Record<string, number> | Record<string, number>[];
+};
+export default class MysqlQueryMock extends HtInstrumentationMockAbstract<InputMeta, ReadableInput, ProcessedInput, ProcessedInputSchema, OutputMeta, RealOutput, ReadableOutput, ProcessedOutputSchema> {
+    static mockSymbol: symbol;
+    static get mockVersion(): number;
+    constructor({ plugin, submoduleName, functionType, }: {
+        plugin: HtInstrumentationBase;
+        submoduleName: string;
+        functionType: FunctionTypeEnum;
+        isImportantMock: boolean;
+    });
+    setReadableInput(readableInput: ReadableInput, inputMeta: InputMeta): void;
+    generateProcessedInput(): ProcessedInput;
+    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 generateReadableInputFromProcessedInputMysqlQueryMock: (processedInput: ProcessedInput) => ReadableInput;
+export {};