@axinom/mosaic-testing 0.7.15-rc.0 → 0.7.16-rc.3

package/dist/esm/performance/plugins/inbox-outbox-report-endpoint-plugin.js

@@ -0,0 +1,68 @@
+import { gql, makeExtendSchemaPlugin } from 'graphile-utils';
+import { getGeneralReport, getProcessedReport, getReportRows, getStoredReport, } from '../utils/index.js';
+const inboxReport = 'inboxReport';
+const outboxReport = 'outboxReport';
+const inboxOutboxReport = 'inboxOutboxReport';
+const getReport = async (table, testId, ownerPool) => {
+    const entries = await getReportRows(table, testId, ownerPool);
+    if (entries.length === 0) {
+        return `No ${table} entries found.`;
+    }
+    const generalReport = getGeneralReport(entries, testId);
+    const storedReport = getStoredReport(entries, table);
+    const processedReport = getProcessedReport(entries, table);
+    return `${generalReport}\n\n${storedReport}\n\n${processedReport}`;
+};
+/**
+ * Returns a postgraphile plugin function that generates a performance report
+ * for inbox and/or outbox entries for a specific testId. Undefined will be
+ * returned for a report value that is not explicitly requested.
+ */
+export const getInboxOutboxReportFunction = (ownerPool) => {
+    return async (_query, { input: { testId } }, _context, { fieldNodes }) => {
+        const selectedProperties = fieldNodes
+            .find((node) => node.name.value === inboxOutboxReport)
+            ?.selectionSet?.selections.map((s) => s.name.value) ??
+            [];
+        const inboxResult = selectedProperties.includes(inboxReport)
+            ? await getReport('inbox', testId, ownerPool)
+            : undefined;
+        const outboxResult = selectedProperties.includes(outboxReport)
+            ? await getReport('outbox', testId, ownerPool)
+            : undefined;
+        return {
+            [inboxReport]: inboxResult,
+            [outboxReport]: outboxResult,
+        };
+    };
+};
+/**
+ * Plugin that adds a custom graphql endpoint `inboxOutboxReport` which uses
+ * inbox and/or outbox entries with the specific test ID and generates a
+ * performance report for said entries. Test ID is expected to be passed as
+ * `message_context: { testId: "test ID value"}` with the message and is a
+ * expected to be string. `ownerPool` must be available as part of the
+ * postgraphile `graphileBuildOptions`.
+ */
+export const InboxOutboxReportEndpointPlugin = makeExtendSchemaPlugin((_, { ownerPool }) => {
+    return {
+        typeDefs: gql `
+      input InboxOutboxReportInput {
+        testId: String!
+      }
+      type InboxOutboxReportPayload {
+        ${inboxReport}: String!
+        ${outboxReport}: String!
+      }
+      extend type Query {
+        ${inboxOutboxReport}(input: InboxOutboxReportInput!): InboxOutboxReportPayload
+      }
+    `,
+        resolvers: {
+            Query: {
+                [inboxOutboxReport]: getInboxOutboxReportFunction(ownerPool),
+            },
+        },
+    };
+});
+//# sourceMappingURL=inbox-outbox-report-endpoint-plugin.js.map

package/dist/esm/performance/plugins/inbox-outbox-report-endpoint-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inbox-outbox-report-endpoint-plugin.js","sourceRoot":"","sources":["../../../../src/performance/plugins/inbox-outbox-report-endpoint-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAG7D,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,eAAe,GAChB,MAAM,mBAAmB,CAAC;AAE3B,MAAM,WAAW,GAAG,aAAa,CAAC;AAClC,MAAM,YAAY,GAAG,cAAc,CAAC;AACpC,MAAM,iBAAiB,GAAG,mBAAmB,CAAC;AAE9C,MAAM,SAAS,GAAG,KAAK,EACrB,KAAyB,EACzB,MAAc,EACd,SAAe,EACE,EAAE;IACnB,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IAC9D,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,MAAM,KAAK,iBAAiB,CAAC;IACtC,CAAC;IACD,MAAM,aAAa,GAAG,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACxD,MAAM,YAAY,GAAG,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACrD,MAAM,eAAe,GAAG,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC3D,OAAO,GAAG,aAAa,OAAO,YAAY,OAAO,eAAe,EAAE,CAAC;AACrE,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,SAAe,EAAE,EAAE;IAC9D,OAAO,KAAK,EACV,MAAe,EACf,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAiC,EACpD,QAAiB,EACjB,EAAE,UAAU,EAAsB,EACA,EAAE;QACpC,MAAM,kBAAkB,GACtB,UAAU;aACP,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,iBAAiB,CAAC;YACtD,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAE,CAAe,CAAC,IAAI,CAAC,KAAK,CAAC;YACpE,EAAE,CAAC;QAEL,MAAM,WAAW,GAAG,kBAAkB,CAAC,QAAQ,CAAC,WAAW,CAAC;YAC1D,CAAC,CAAC,MAAM,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC;YAC7C,CAAC,CAAC,SAAS,CAAC;QACd,MAAM,YAAY,GAAG,kBAAkB,CAAC,QAAQ,CAAC,YAAY,CAAC;YAC5D,CAAC,CAAC,MAAM,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC;YAC9C,CAAC,CAAC,SAAS,CAAC;QAEd,OAAO;YACL,CAAC,WAAW,CAAC,EAAE,WAAW;YAC1B,CAAC,YAAY,CAAC,EAAE,YAAY;SAC7B,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,sBAAsB,CACnE,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACnB,OAAO;QACL,QAAQ,EAAE,GAAG,CAAA;;;;;UAKT,WAAW;UACX,YAAY;;;UAGZ,iBAAiB;;KAEtB;QACC,SAAS,EAAE;YACT,KAAK,EAAE;gBACL,CAAC,iBAAiB,CAAC,EAAE,4BAA4B,CAAC,SAAS,CAAC;aAC7D;SACF;KACF,CAAC;AACJ,CAAC,CACF,CAAC"}

package/dist/esm/performance/plugins/inbox-outbox-state-endpoint-plugin.d.ts

@@ -0,0 +1,23 @@
+import type { GraphQLResolveInfo } from 'graphql';
+import type { Pool } from 'pg';
+/**
+ * Returns a postgraphile plugin function that returns the counts of inbox
+ * and/or outbox entries that are still not completed and not abandoned for a
+ * specified testId. Undefined will be returned for a count value that is not
+ * explicitly requested.
+ */
+export declare const getInboxOutboxStateFunction: (ownerPool: Pool) => (_query: unknown, { input: { testId } }: {
+    input: {
+        testId: string;
+    };
+}, _context: unknown, { fieldNodes }: GraphQLResolveInfo) => Promise<Record<string, unknown>>;
+/**
+ * Plugin that adds a custom graphql endpoint `inboxOutboxState` which checks if
+ * inbox and/or outbox entries with the specific test ID are still being
+ * processed and returns the count of such entries. Test ID is expected to be
+ * passed as `message_context: { testId: "test ID value"}` with the message and
+ * is a expected to be string. `ownerPool` must be available as part of the
+ * postgraphile `graphileBuildOptions`.
+ */
+export declare const InboxOutboxStateEndpointPlugin: import("graphile-build").Plugin;
+//# sourceMappingURL=inbox-outbox-state-endpoint-plugin.d.ts.map

package/dist/esm/performance/plugins/inbox-outbox-state-endpoint-plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inbox-outbox-state-endpoint-plugin.d.ts","sourceRoot":"","sources":["../../../../src/performance/plugins/inbox-outbox-state-endpoint-plugin.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAa,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAC7D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAmC/B;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B,GAAI,WAAW,IAAI,MAEvD,QAAQ,OAAO,EACf,uBAAuB;IAAE,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,EACpD,UAAU,OAAO,EACjB,gBAAgB,kBAAkB,KACjC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAmBnC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,8BAA8B,iCAsB1C,CAAC"}

package/dist/esm/performance/plugins/inbox-outbox-state-endpoint-plugin.js

@@ -0,0 +1,78 @@
+import { gql, makeExtendSchemaPlugin } from 'graphile-utils';
+const inboxActiveCount = 'inboxActiveCount';
+const outboxActiveCount = 'outboxActiveCount';
+const inboxOutboxState = 'inboxOutboxState';
+/**
+ * Queries for the count of rows of either inbox or outbox table for not
+ * processed and not abandoned rows for a specified testId.
+ */
+const getRowsCount = async (table, testId, ownerPool) => {
+    const client = await ownerPool.connect();
+    try {
+        const testIdPath = table === 'inbox'
+            ? `metadata->'messageContext'->>'testId'`
+            : `metadata->'envelopeOverrides'->'message_context'->>'testId'`;
+        const result = await client.query(`SELECT COUNT(id) FROM app_hidden.${table} 
+      WHERE ${testIdPath} = $1 AND 
+      processed_at is NULL AND
+      abandoned_at is NULL;`, [testId]);
+        return result.rows[0].count;
+    }
+    finally {
+        client.release();
+    }
+};
+/**
+ * Returns a postgraphile plugin function that returns the counts of inbox
+ * and/or outbox entries that are still not completed and not abandoned for a
+ * specified testId. Undefined will be returned for a count value that is not
+ * explicitly requested.
+ */
+export const getInboxOutboxStateFunction = (ownerPool) => {
+    return async (_query, { input: { testId } }, _context, { fieldNodes }) => {
+        const selectedProperties = fieldNodes
+            .find((node) => node.name.value === inboxOutboxState)
+            ?.selectionSet?.selections.map((s) => s.name.value) ??
+            [];
+        const inboxResult = selectedProperties.includes(inboxActiveCount)
+            ? await getRowsCount('inbox', testId, ownerPool)
+            : undefined;
+        const outboxResult = selectedProperties.includes(outboxActiveCount)
+            ? await getRowsCount('outbox', testId, ownerPool)
+            : undefined;
+        return {
+            [inboxActiveCount]: inboxResult,
+            [outboxActiveCount]: outboxResult,
+        };
+    };
+};
+/**
+ * Plugin that adds a custom graphql endpoint `inboxOutboxState` which checks if
+ * inbox and/or outbox entries with the specific test ID are still being
+ * processed and returns the count of such entries. Test ID is expected to be
+ * passed as `message_context: { testId: "test ID value"}` with the message and
+ * is a expected to be string. `ownerPool` must be available as part of the
+ * postgraphile `graphileBuildOptions`.
+ */
+export const InboxOutboxStateEndpointPlugin = makeExtendSchemaPlugin((_, { ownerPool }) => {
+    return {
+        typeDefs: gql `
+      input InboxOutboxStateInput {
+        testId: String!
+      }
+      type InboxOutboxStatePayload {
+        ${inboxActiveCount}: Int!
+        ${outboxActiveCount}: Int!
+      }
+      extend type Query {
+        ${inboxOutboxState}(input: InboxOutboxStateInput!): InboxOutboxStatePayload
+      }
+    `,
+        resolvers: {
+            Query: {
+                [inboxOutboxState]: getInboxOutboxStateFunction(ownerPool),
+            },
+        },
+    };
+});
+//# sourceMappingURL=inbox-outbox-state-endpoint-plugin.js.map

package/dist/esm/performance/plugins/inbox-outbox-state-endpoint-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inbox-outbox-state-endpoint-plugin.js","sourceRoot":"","sources":["../../../../src/performance/plugins/inbox-outbox-state-endpoint-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAI7D,MAAM,gBAAgB,GAAG,kBAAkB,CAAC;AAC5C,MAAM,iBAAiB,GAAG,mBAAmB,CAAC;AAC9C,MAAM,gBAAgB,GAAG,kBAAkB,CAAC;AAE5C;;;GAGG;AACH,MAAM,YAAY,GAAG,KAAK,EACxB,KAAyB,EACzB,MAAc,EACd,SAAe,EACE,EAAE;IACnB,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;IACzC,IAAI,CAAC;QACH,MAAM,UAAU,GACd,KAAK,KAAK,OAAO;YACf,CAAC,CAAC,uCAAuC;YACzC,CAAC,CAAC,6DAA6D,CAAC;QACpE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAC/B,oCAAoC,KAAK;cACjC,UAAU;;4BAEI,EACtB,CAAC,MAAM,CAAC,CACT,CAAC;QAEF,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC9B,CAAC;YAAS,CAAC;QACT,MAAM,CAAC,OAAO,EAAE,CAAC;IACnB,CAAC;AACH,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,SAAe,EAAE,EAAE;IAC7D,OAAO,KAAK,EACV,MAAe,EACf,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAiC,EACpD,QAAiB,EACjB,EAAE,UAAU,EAAsB,EACA,EAAE;QACpC,MAAM,kBAAkB,GACtB,UAAU;aACP,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,gBAAgB,CAAC;YACrD,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAE,CAAe,CAAC,IAAI,CAAC,KAAK,CAAC;YACpE,EAAE,CAAC;QAEL,MAAM,WAAW,GAAG,kBAAkB,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YAC/D,CAAC,CAAC,MAAM,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC;YAChD,CAAC,CAAC,SAAS,CAAC;QACd,MAAM,YAAY,GAAG,kBAAkB,CAAC,QAAQ,CAAC,iBAAiB,CAAC;YACjE,CAAC,CAAC,MAAM,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC;YACjD,CAAC,CAAC,SAAS,CAAC;QAEd,OAAO;YACL,CAAC,gBAAgB,CAAC,EAAE,WAAW;YAC/B,CAAC,iBAAiB,CAAC,EAAE,YAAY;SAClC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,sBAAsB,CAClE,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACnB,OAAO;QACL,QAAQ,EAAE,GAAG,CAAA;;;;;UAKT,gBAAgB;UAChB,iBAAiB;;;UAGjB,gBAAgB;;KAErB;QACC,SAAS,EAAE;YACT,KAAK,EAAE;gBACL,CAAC,gBAAgB,CAAC,EAAE,2BAA2B,CAAC,SAAS,CAAC;aAC3D;SACF;KACF,CAAC;AACJ,CAAC,CACF,CAAC"}

package/dist/esm/performance/plugins/index.d.ts

@@ -0,0 +1,3 @@
+export { InboxOutboxReportEndpointPlugin } from './inbox-outbox-report-endpoint-plugin.js';
+export { InboxOutboxStateEndpointPlugin } from './inbox-outbox-state-endpoint-plugin.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/performance/plugins/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/performance/plugins/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,0CAA0C,CAAC;AAC3F,OAAO,EAAE,8BAA8B,EAAE,MAAM,yCAAyC,CAAC"}

package/dist/{performance/plugins/index.d.ts → esm/performance/plugins/index.js}

@@ -1,3 +1,3 @@
-export { InboxOutboxReportEndpointPlugin } from './inbox-outbox-report-endpoint-plugin';
-export { InboxOutboxStateEndpointPlugin } from './inbox-outbox-state-endpoint-plugin';
-//# sourceMappingURL=index.d.ts.map
+export { InboxOutboxReportEndpointPlugin } from './inbox-outbox-report-endpoint-plugin.js';
+export { InboxOutboxStateEndpointPlugin } from './inbox-outbox-state-endpoint-plugin.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/performance/plugins/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/performance/plugins/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,0CAA0C,CAAC;AAC3F,OAAO,EAAE,8BAA8B,EAAE,MAAM,yCAAyC,CAAC"}

package/dist/esm/performance/scripts/index.d.ts

@@ -0,0 +1,4 @@
+export * from './make-graphql-request.js';
+export * from './run-inbox-outbox-scenario.js';
+export * from './run-scenario.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/performance/scripts/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/performance/scripts/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mBAAmB,CAAC"}

package/dist/esm/performance/scripts/index.js

@@ -0,0 +1,4 @@
+export * from './make-graphql-request.js';
+export * from './run-inbox-outbox-scenario.js';
+export * from './run-scenario.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/performance/scripts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/performance/scripts/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mBAAmB,CAAC"}

package/dist/esm/performance/scripts/make-graphql-request.d.ts

@@ -0,0 +1,29 @@
+import type { AxiosResponse } from 'axios';
+import type { DocumentNode } from 'graphql';
+/**
+ * Config to make a GraphQL request using `makeGraphQLRequest`
+ */
+export interface MakeGraphQLRequestOptions {
+    /**
+     * Base URL that should be requested. `/graphql` will be attached to it to
+     * make a request.
+     */
+    baseUrl: string;
+    /**
+     * Operation to request. Use `graphql-tag` to wrap the operation string.
+     */
+    operation: DocumentNode;
+    /**
+     * Optional GraphQL request variables.
+     */
+    variables?: Record<string, unknown>;
+    /**
+     * Bearer authorization token.
+     */
+    token: string;
+}
+/**
+ * Wrapper to make a GraphQL request with minimal input parameters
+ */
+export declare const makeGraphQLRequest: ({ baseUrl, operation, variables, token, }: MakeGraphQLRequestOptions) => Promise<AxiosResponse<any, any>>;
+//# sourceMappingURL=make-graphql-request.d.ts.map

package/dist/esm/performance/scripts/make-graphql-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"make-graphql-request.d.ts","sourceRoot":"","sources":["../../../../src/performance/scripts/make-graphql-request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAE3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAG5C;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,EAAE,YAAY,CAAC;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,GAAU,2CAMzC,yBAAyB,KAAG,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAa1D,CAAC"}

package/dist/esm/performance/scripts/make-graphql-request.js

@@ -0,0 +1,16 @@
+import axios from 'axios';
+import { print } from 'graphql/language/printer.js';
+/**
+ * Wrapper to make a GraphQL request with minimal input parameters
+ */
+export const makeGraphQLRequest = async ({ baseUrl, operation, variables, token, }) => {
+    return axios.post(new URL('graphql', baseUrl).href, {
+        query: print(operation),
+        variables,
+    }, {
+        headers: {
+            Authorization: `Bearer ${token}`,
+        },
+    });
+};
+//# sourceMappingURL=make-graphql-request.js.map

package/dist/esm/performance/scripts/make-graphql-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"make-graphql-request.js","sourceRoot":"","sources":["../../../../src/performance/scripts/make-graphql-request.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAyBpD;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,EAAE,EACvC,OAAO,EACP,SAAS,EACT,SAAS,EACT,KAAK,GAEkB,EAAoC,EAAE;IAC7D,OAAO,KAAK,CAAC,IAAI,CACf,IAAI,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,IAAI,EAChC;QACE,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC;QACvB,SAAS;KACV,EACD;QACE,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,KAAK,EAAE;SACjC;KACF,CACF,CAAC;AACJ,CAAC,CAAC"}

package/dist/esm/performance/scripts/run-inbox-outbox-scenario.d.ts

@@ -0,0 +1,97 @@
+import { Broker } from '@axinom/mosaic-message-bus';
+import { type MessagingSettings } from '@axinom/mosaic-message-bus-abstractions';
+import { type BasicConfig, type BasicCustomizableConfig, type BasicManagedServiceConfig, type BasicRMQConfig, type ShutdownAction } from '@axinom/mosaic-service-common';
+import { type RunnerConfig } from './run-scenario.js';
+/**
+ * Configuration with all messaging-related environment variable values,
+ */
+type InboxOutboxMessagingConfig = Pick<BasicConfig & BasicRMQConfig & BasicManagedServiceConfig & BasicCustomizableConfig, 'serviceId' | 'tenantId' | 'environmentId' | 'idServiceAuthBaseUrl' | 'managedServiceAccountClientId' | 'managedServiceAccountClientSecret' | 'isDev' | 'rmqHost' | 'rmqPort' | 'rmqProtocol' | 'rmqUser' | 'rmqVHost' | 'rmqPassword' | 'rmqVHostAssert'>;
+/**
+ * Configuration to run `runInboxOutboxScenario` function.
+ */
+interface InboxOutboxRunScenarioConfig {
+    /**
+     * Description of the scenario. Printed together with the report.
+     */
+    description?: string;
+    /**
+     * Configuration to fine-tune how scenario is executed.
+     */
+    runnerConfig?: RunnerConfig;
+    /**
+     * Messaging settings for the message that will be repeatedly sent.
+     */
+    messagingSettings: MessagingSettings;
+    /**
+     * Configuration to be able to send messages, e.g. RabbitMQ connection details.
+     */
+    config: InboxOutboxMessagingConfig;
+    /**
+     * Payload to be sent with each iteration.
+     */
+    payload: unknown | (() => unknown);
+    /**
+     * Base URL for the service. Used to request `inboxOutboxState` and
+     * `inboxOutboxReport` operations.
+     */
+    serviceBaseUrl: string;
+}
+/**
+ * Config that is created by the `setup` step of `getInboxOutboxSetup` and
+ * passed to each function/step of `runInboxOutboxScenario`
+ */
+export interface InboxOutboxScenarioConfig {
+    /**
+     * Configuration to be able to send messages, e.g. RabbitMQ connection details.
+     */
+    config: InboxOutboxMessagingConfig;
+    /**
+     * Shutdown actions that are executed as part of the `teardown` step.
+     */
+    shutdownActions: ShutdownAction[];
+    /**
+     * Messaging broker to send RabbitMQ messages.
+     */
+    broker: Broker;
+    /**
+     * Authorization token to include in messages and GraphQL requests.
+     */
+    token: string;
+    /**
+     * Test identifier. Passed along with each sent message as part of
+     * `message_context` and used to retrieve the inbox/outbox state and report.
+     */
+    testId: string;
+}
+/**
+ * Generic setup function to produce all required components to run messaging
+ * tests for services using transactional inbox-outbox pattern.
+ */
+export declare const getInboxOutboxSetup: <T extends InboxOutboxScenarioConfig>(messagingSettings: MessagingSettings, config: InboxOutboxMessagingConfig) => (() => Promise<T>);
+/**
+ * Generic iteration function to send RabbitMQ messages.
+ */
+export declare const getInboxOutboxIteration: <T extends InboxOutboxScenarioConfig>(payload: unknown, messagingSettings: MessagingSettings) => ({ broker, token, testId, config }: T) => Promise<void>;
+/**
+ * Generic hasScenarioCompleted function to check if all inbox and outbox
+ * messages have been processed.
+ */
+export declare const getInboxOutboxHasScenarioCompleted: <T extends InboxOutboxScenarioConfig>(serviceBaseUrl: string) => ((tc: T) => Promise<boolean>);
+/**
+ * Generic function to request a report from the target service that scenario is
+ * running against.
+ */
+export declare const getInboxOutboxGenerateReport: <T extends InboxOutboxScenarioConfig>(serviceBaseUrl: string) => ({ token, testId }: T) => Promise<string>;
+/**
+ * Generic function to run all shutdown actions, e.g. dispose the broker.
+ */
+export declare const inboxOutboxTeardown: <T extends InboxOutboxScenarioConfig>({ shutdownActions, }: T) => Promise<void>;
+/**
+ * A wrapper function for the `runScenario` to send RabbitMQ messages for the
+ * service using transactional inbox-outbox pattern. Has limited configuration
+ * fitting for simple cases where sending a message with the same payload is
+ * acceptable. For more complex scenarios - consider using `runScenario` explicitly.
+ */
+export declare const runInboxOutboxScenario: <T extends InboxOutboxScenarioConfig>({ runnerConfig, messagingSettings, config, payload, serviceBaseUrl, description, }: InboxOutboxRunScenarioConfig) => Promise<void>;
+export {};
+//# sourceMappingURL=run-inbox-outbox-scenario.d.ts.map

package/dist/esm/performance/scripts/run-inbox-outbox-scenario.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-inbox-outbox-scenario.d.ts","sourceRoot":"","sources":["../../../../src/performance/scripts/run-inbox-outbox-scenario.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,MAAM,EAGP,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AACjF,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,uBAAuB,EAC5B,KAAK,yBAAyB,EAC9B,KAAK,cAAc,EAEnB,KAAK,cAAc,EAEpB,MAAM,+BAA+B,CAAC;AAIvC,OAAO,EAAE,KAAK,YAAY,EAAe,MAAM,mBAAmB,CAAC;AAEnE;;GAEG;AACH,KAAK,0BAA0B,GAAG,IAAI,CACpC,WAAW,GACT,cAAc,GACd,yBAAyB,GACzB,uBAAuB,EACvB,WAAW,GACX,UAAU,GACV,eAAe,GACf,sBAAsB,GACtB,+BAA+B,GAC/B,mCAAmC,GACnC,OAAO,GACP,SAAS,GACT,SAAS,GACT,aAAa,GACb,SAAS,GACT,UAAU,GACV,aAAa,GACb,gBAAgB,CACnB,CAAC;AAEF;;GAEG;AACH,UAAU,4BAA4B;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;OAEG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;IACrC;;OAEG;IACH,MAAM,EAAE,0BAA0B,CAAC;IACnC;;OAEG;IACH,OAAO,EAAE,OAAO,GAAG,CAAC,MAAM,OAAO,CAAC,CAAC;IACnC;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,MAAM,EAAE,0BAA0B,CAAC;IACnC;;OAEG;IACH,eAAe,EAAE,cAAc,EAAE,CAAC;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,GAAI,CAAC,SAAS,yBAAyB,EACrE,mBAAmB,iBAAiB,EACpC,QAAQ,0BAA0B,KACjC,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,CAkCnB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB,GAAI,CAAC,SAAS,yBAAyB,EACzE,SAAS,OAAO,EAChB,mBAAmB,iBAAiB,MAEtB,mCAAmC,CAAC,KAAG,OAAO,CAAC,IAAI,CAMlE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kCAAkC,GAC7C,CAAC,SAAS,yBAAyB,EAEnC,gBAAgB,MAAM,KACrB,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAsC9B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,4BAA4B,GACvC,CAAC,SAAS,yBAAyB,EAEnC,gBAAgB,MAAM,MAER,mBAAmB,CAAC,KAAG,OAAO,CAAC,MAAM,CAgBpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAAU,CAAC,SAAS,yBAAyB,EAAE,sBAE5E,CAAC,KAAG,OAAO,CAAC,IAAI,CAIlB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,GACjC,CAAC,SAAS,yBAAyB,EACnC,oFAOC,4BAA4B,KAAG,OAAO,CAAC,IAAI,CAc7C,CAAC"}

package/dist/esm/performance/scripts/run-inbox-outbox-scenario.js

@@ -0,0 +1,141 @@
+/* eslint-disable no-console */
+import { getManagedServiceAccountToken } from '@axinom/mosaic-id-link-be';
+import { Broker, RascalConfigBuilder, setupMessagingBroker, } from '@axinom/mosaic-message-bus';
+import {} from '@axinom/mosaic-message-bus-abstractions';
+import { Logger, ShutdownActionsMiddleware, } from '@axinom/mosaic-service-common';
+import gql from 'graphql-tag';
+import { randomUUID } from 'node:crypto';
+import { makeGraphQLRequest } from './make-graphql-request.js';
+import { runScenario } from './run-scenario.js';
+/**
+ * Generic setup function to produce all required components to run messaging
+ * tests for services using transactional inbox-outbox pattern.
+ */
+export const getInboxOutboxSetup = (messagingSettings, config) => {
+    return async () => {
+        const shutdownActions = [];
+        const builder = new RascalConfigBuilder(messagingSettings, config);
+        const broker = await setupMessagingBroker({
+            config,
+            builders: [
+                messagingSettings.action === 'command'
+                    ? builder.sendCommand()
+                    : builder.publishEvent(),
+            ],
+            logger: new Logger({ config }),
+            // we just want setupMessagingBroker to push shutdown actions to an array
+            // and call it manually
+            shutdownActions: shutdownActions,
+        });
+        const token = (await getManagedServiceAccountToken(config.idServiceAuthBaseUrl, config.managedServiceAccountClientId, config.managedServiceAccountClientSecret, config.tenantId, config.environmentId)).accessToken;
+        return {
+            testId: randomUUID(),
+            config,
+            broker,
+            token,
+            shutdownActions,
+        };
+    };
+};
+/**
+ * Generic iteration function to send RabbitMQ messages.
+ */
+export const getInboxOutboxIteration = (payload, messagingSettings) => {
+    return async ({ broker, token, testId, config }) => {
+        await broker.publish(config.environmentId, messagingSettings, payload, {
+            auth_token: token,
+            message_context: { testId },
+        });
+    };
+};
+/**
+ * Generic hasScenarioCompleted function to check if all inbox and outbox
+ * messages have been processed.
+ */
+export const getInboxOutboxHasScenarioCompleted = (serviceBaseUrl) => {
+    let checks = 1;
+    let isFirstLog = true;
+    return async ({ token, testId }) => {
+        const response = await makeGraphQLRequest({
+            baseUrl: serviceBaseUrl,
+            token,
+            variables: { testId },
+            operation: gql `
+        query GetState($testId: String!) {
+          inboxOutboxState(input: { testId: $testId }) {
+            inboxActiveCount
+            outboxActiveCount
+          }
+        }
+      `,
+        });
+        const inbox = response.data.data.inboxOutboxState.inboxActiveCount;
+        const outbox = response.data.data.inboxOutboxState.outboxActiveCount;
+        const clearLine = ' '.repeat(10); // Empty line to clear leftover characters
+        process.stdout.write(`${isFirstLog ? '' : '\r' // erase previous log in the terminal to preserve space for multiple reports
+        }Waiting for all messages to be processed: inbox - ${inbox}; outbox - ${outbox}${clearLine}`);
+        if (isFirstLog) {
+            isFirstLog = false;
+        }
+        if (inbox === 0 && outbox === 0 && checks > 1) {
+            process.stdout.write('\n'); // make sure next log is not written on the same line as the log above
+            return true;
+        }
+        else if (inbox === 0 && outbox === 0) {
+            // Make sure it does not bounce back, so doing 2 checks
+            checks++;
+        }
+        return false;
+    };
+};
+/**
+ * Generic function to request a report from the target service that scenario is
+ * running against.
+ */
+export const getInboxOutboxGenerateReport = (serviceBaseUrl) => {
+    return async ({ token, testId }) => {
+        const response = await makeGraphQLRequest({
+            baseUrl: serviceBaseUrl,
+            token,
+            variables: { testId },
+            operation: gql `
+        query GetInboxOutboxReport($testId: String!) {
+          inboxOutboxReport(input: { testId: $testId }) {
+            inboxReport
+            outboxReport
+          }
+        }
+      `,
+        });
+        return `[INBOX]\n${response.data.data.inboxOutboxReport.inboxReport}\n\n[OUTBOX]\n${response.data.data.inboxOutboxReport.outboxReport}`;
+    };
+};
+/**
+ * Generic function to run all shutdown actions, e.g. dispose the broker.
+ */
+export const inboxOutboxTeardown = async ({ shutdownActions, }) => {
+    for await (const shutdown of shutdownActions) {
+        await shutdown();
+    }
+};
+/**
+ * A wrapper function for the `runScenario` to send RabbitMQ messages for the
+ * service using transactional inbox-outbox pattern. Has limited configuration
+ * fitting for simple cases where sending a message with the same payload is
+ * acceptable. For more complex scenarios - consider using `runScenario` explicitly.
+ */
+export const runInboxOutboxScenario = async ({ runnerConfig, messagingSettings, config, payload, serviceBaseUrl, description, }) => {
+    await runScenario({
+        description,
+        runnerConfig: {
+            iterations: runnerConfig?.iterations ?? 50,
+            awaitCompletionIntervalInSec: runnerConfig?.awaitCompletionIntervalInSec ?? 5,
+        },
+        setup: getInboxOutboxSetup(messagingSettings, config),
+        iteration: getInboxOutboxIteration(payload, messagingSettings),
+        hasScenarioCompleted: getInboxOutboxHasScenarioCompleted(serviceBaseUrl),
+        generateReport: getInboxOutboxGenerateReport(serviceBaseUrl),
+        teardown: inboxOutboxTeardown,
+    });
+};
+//# sourceMappingURL=run-inbox-outbox-scenario.js.map

package/dist/esm/performance/scripts/run-inbox-outbox-scenario.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-inbox-outbox-scenario.js","sourceRoot":"","sources":["../../../../src/performance/scripts/run-inbox-outbox-scenario.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,OAAO,EAAE,6BAA6B,EAAE,MAAM,2BAA2B,CAAC;AAC1E,OAAO,EACL,MAAM,EACN,mBAAmB,EACnB,oBAAoB,GACrB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAA0B,MAAM,yCAAyC,CAAC;AACjF,OAAO,EAKL,MAAM,EAEN,yBAAyB,GAC1B,MAAM,+BAA+B,CAAC;AACvC,OAAO,GAAG,MAAM,aAAa,CAAC;AAC9B,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAqB,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAqFnE;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,iBAAoC,EACpC,MAAkC,EACd,EAAE;IACtB,OAAO,KAAK,IAAgB,EAAE;QAC5B,MAAM,eAAe,GAAqB,EAAE,CAAC;QAC7C,MAAM,OAAO,GAAG,IAAI,mBAAmB,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;QACnE,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC;YACxC,MAAM;YACN,QAAQ,EAAE;gBACR,iBAAiB,CAAC,MAAM,KAAK,SAAS;oBACpC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE;oBACvB,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE;aAC3B;YACD,MAAM,EAAE,IAAI,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;YAC9B,yEAAyE;YACzE,uBAAuB;YACvB,eAAe,EAAE,eAAuD;SACzE,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,CACZ,MAAM,6BAA6B,CACjC,MAAM,CAAC,oBAAoB,EAC3B,MAAM,CAAC,6BAA6B,EACpC,MAAM,CAAC,iCAAiC,EACxC,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,aAAa,CACrB,CACF,CAAC,WAAW,CAAC;QAEd,OAAO;YACL,MAAM,EAAE,UAAU,EAAE;YACpB,MAAM;YACN,MAAM;YACN,KAAK;YACL,eAAe;SACX,CAAC;IACT,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,OAAgB,EAChB,iBAAoC,EACpC,EAAE;IACF,OAAO,KAAK,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAK,EAAiB,EAAE;QACnE,MAAM,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,iBAAiB,EAAE,OAAO,EAAE;YACrE,UAAU,EAAE,KAAK;YACjB,eAAe,EAAE,EAAE,MAAM,EAAE;SAC5B,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAGhD,cAAsB,EACS,EAAE;IACjC,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,UAAU,GAAG,IAAI,CAAC;IACtB,OAAO,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAAK,EAAoB,EAAE;QACtD,MAAM,QAAQ,GAAG,MAAM,kBAAkB,CAAC;YACxC,OAAO,EAAE,cAAc;YACvB,KAAK;YACL,SAAS,EAAE,EAAE,MAAM,EAAE;YACrB,SAAS,EAAE,GAAG,CAAA;;;;;;;OAOb;SACF,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC;QACnE,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC;QAErE,MAAM,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,0CAA0C;QAC5E,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,GACE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,4EAA4E;QACrG,qDAAqD,KAAK,cAAc,MAAM,GAAG,SAAS,EAAE,CAC7F,CAAC;QACF,IAAI,UAAU,EAAE,CAAC;YACf,UAAU,GAAG,KAAK,CAAC;QACrB,CAAC;QACD,IAAI,KAAK,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9C,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,sEAAsE;YAClG,OAAO,IAAI,CAAC;QACd,CAAC;aAAM,IAAI,KAAK,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;YACvC,uDAAuD;YACvD,MAAM,EAAE,CAAC;QACX,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAG1C,cAAsB,EACtB,EAAE;IACF,OAAO,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAAK,EAAmB,EAAE;QACrD,MAAM,QAAQ,GAAG,MAAM,kBAAkB,CAAC;YACxC,OAAO,EAAE,cAAc;YACvB,KAAK;YACL,SAAS,EAAE,EAAE,MAAM,EAAE;YACrB,SAAS,EAAE,GAAG,CAAA;;;;;;;OAOb;SACF,CAAC,CAAC;QACH,OAAO,YAAY,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,WAAW,iBAAiB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,CAAC;IAC1I,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EAAuC,EAC7E,eAAe,GACb,EAAiB,EAAE;IACrB,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,eAAe,EAAE,CAAC;QAC7C,MAAM,QAAQ,EAAE,CAAC;IACnB,CAAC;AACH,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,KAAK,EAEzC,EACA,YAAY,EACZ,iBAAiB,EACjB,MAAM,EACN,OAAO,EACP,cAAc,EACd,WAAW,GACkB,EAAiB,EAAE;IAChD,MAAM,WAAW,CAAI;QACnB,WAAW;QACX,YAAY,EAAE;YACZ,UAAU,EAAE,YAAY,EAAE,UAAU,IAAI,EAAE;YAC1C,4BAA4B,EAC1B,YAAY,EAAE,4BAA4B,IAAI,CAAC;SAClD;QACD,KAAK,EAAE,mBAAmB,CAAC,iBAAiB,EAAE,MAAM,CAAC;QACrD,SAAS,EAAE,uBAAuB,CAAC,OAAO,EAAE,iBAAiB,CAAC;QAC9D,oBAAoB,EAAE,kCAAkC,CAAC,cAAc,CAAC;QACxE,cAAc,EAAE,4BAA4B,CAAC,cAAc,CAAC;QAC5D,QAAQ,EAAE,mBAAmB;KAC9B,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/esm/performance/scripts/run-scenario.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Configuration to fine-tune how scenario is executed.
+ */
+export interface RunnerConfig {
+    /**
+     * Defines how many times the `iteration` function will be executed.
+     */
+    iterations: number;
+    /**
+     * Defines how long will the scenario wait to call the `hasScenarioCompleted`
+     * function to check if scenario is ready for report generation.
+     */
+    awaitCompletionIntervalInSec: number;
+}
+/**
+ * Configuration for the `runScenario` function.
+ */
+export interface RunScenarioConfig<TC> {
+    /**
+     * Description of the scenario. Printed together with the report.
+     */
+    description?: string;
+    /**
+     * Configuration to fine-tune how scenario is executed.
+     */
+    runnerConfig: RunnerConfig;
+    /**
+     * Function to set up initial data that can be reused by other scenario functions.
+     */
+    setup: () => Promise<TC>;
+    /**
+     * Function that will be repeatedly executed as many times as defined in `runnerConfig.iterations`.
+     */
+    iteration: (tc: TC) => Promise<void>;
+    /**
+     * Function to check if scenario is completed, e.g. call a service API and
+     * return true or false based on response.
+     */
+    hasScenarioCompleted: (tc: TC) => Promise<boolean>;
+    /**
+     * Function to generate a report for the scenario. Printed as is.
+     */
+    generateReport: (tc: TC) => Promise<string>;
+    /**
+     * Function to cleanup after scenario is completed.
+     */
+    teardown: (tc: TC) => Promise<void>;
+}
+/**
+ * Generic function to execute a custom piece of code multiple times, await for
+ * the completion of processing caused by previous execution, and print a report.
+ */
+export declare const runScenario: <TC>({ description, runnerConfig: { iterations, awaitCompletionIntervalInSec }, setup, iteration, hasScenarioCompleted, generateReport, teardown, }: RunScenarioConfig<TC>) => Promise<void>;
+//# sourceMappingURL=run-scenario.d.ts.map

package/dist/esm/performance/scripts/run-scenario.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-scenario.d.ts","sourceRoot":"","sources":["../../../../src/performance/scripts/run-scenario.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,4BAA4B,EAAE,MAAM,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,EAAE;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,OAAO,CAAC,EAAE,CAAC,CAAC;IACzB;;OAEG;IACH,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC;;;OAGG;IACH,oBAAoB,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACnD;;OAEG;IACH,cAAc,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C;;OAEG;IACH,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACrC;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAU,EAAE,EAAE,gJAQnC,iBAAiB,CAAC,EAAE,CAAC,KAAG,OAAO,CAAC,IAAI,CA6BtC,CAAC"}

package/dist/esm/performance/scripts/run-scenario.js

@@ -0,0 +1,33 @@
+/* eslint-disable no-console */
+import { sleep } from '@axinom/mosaic-service-common';
+import { blue } from '../utils/index.js';
+/**
+ * Generic function to execute a custom piece of code multiple times, await for
+ * the completion of processing caused by previous execution, and print a report.
+ */
+export const runScenario = async ({ description, runnerConfig: { iterations, awaitCompletionIntervalInSec }, setup, iteration, hasScenarioCompleted, generateReport, teardown, }) => {
+    console.log(blue(`Scenario has started:\n\t${description}`));
+    console.log('Performing setup...');
+    const tc = await setup();
+    console.log('Running iterations...');
+    Array.from({ length: iterations }).map(async () => {
+        await iteration(tc);
+    });
+    console.log('Checking if scenario is completed...');
+    while (!(await hasScenarioCompleted(tc))) {
+        await sleep(awaitCompletionIntervalInSec * 1000);
+    }
+    console.log(`Generating report...`);
+    const report = await generateReport(tc);
+    console.log('Performing teardown...');
+    await teardown(tc);
+    console.log(`Scenario has finished! See report below:`);
+    console.log('\n--------------------------------------------');
+    if (description) {
+        console.log(`- Scenario Description: ${blue(description)}\n`);
+    }
+    console.log(report);
+    console.log('--------------------------------------------\n');
+    process.exit(0);
+};
+//# sourceMappingURL=run-scenario.js.map

package/dist/esm/performance/scripts/run-scenario.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-scenario.js","sourceRoot":"","sources":["../../../../src/performance/scripts/run-scenario.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAC;AACtD,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAoDzC;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAAM,EACpC,WAAW,EACX,YAAY,EAAE,EAAE,UAAU,EAAE,4BAA4B,EAAE,EAC1D,KAAK,EACL,SAAS,EACT,oBAAoB,EACpB,cAAc,EACd,QAAQ,GACc,EAAiB,EAAE;IACzC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,4BAA4B,WAAW,EAAE,CAAC,CAAC,CAAC;IAC7D,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IACnC,MAAM,EAAE,GAAG,MAAM,KAAK,EAAE,CAAC;IAEzB,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;IACrC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;QAChD,MAAM,SAAS,CAAC,EAAE,CAAC,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;IACpD,OAAO,CAAC,CAAC,MAAM,oBAAoB,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;QACzC,MAAM,KAAK,CAAC,4BAA4B,GAAG,IAAI,CAAC,CAAC;IACnD,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IACpC,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;IAExC,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;IACtC,MAAM,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEnB,OAAO,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAC;IACxD,OAAO,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;IAC9D,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,CAAC,GAAG,CAAC,2BAA2B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACpB,OAAO,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;IAC9D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC"}

package/dist/esm/performance/utils/colorize-text.d.ts

@@ -0,0 +1,3 @@
+export declare const blue: (text: string | number) => string;
+export declare const red: (text: string | number) => string;
+//# sourceMappingURL=colorize-text.d.ts.map

package/dist/esm/performance/utils/colorize-text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"colorize-text.d.ts","sourceRoot":"","sources":["../../../../src/performance/utils/colorize-text.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,IAAI,GAAI,MAAM,MAAM,GAAG,MAAM,KAAG,MACd,CAAC;AAChC,eAAO,MAAM,GAAG,GAAI,MAAM,MAAM,GAAG,MAAM,KAAG,MACb,CAAC"}