@backstage/backend-test-utils 1.10.4 → 1.11.0-next.1

package/CHANGELOG.md

@@ -1,15 +1,38 @@
 # @backstage/backend-test-utils
 
-## 1.10.4
+## 1.11.0-next.1
+
+### Minor Changes
+
+- 42abfb1: Added `createServiceMock`, a public utility for creating `ServiceMock` instances for custom service refs. This allows plugin authors to define mock creators for their own services following the same pattern as the built-in `mockServices` mocks.
 
 ### Patch Changes
 
-- 5683c85: Bump to latest zod to ensure it has the latest features
+- 68eb322: Added `@types/jest` as an optional peer dependency, since jest types are exposed in the public API surface.
 - Updated dependencies
-  - @backstage/backend-plugin-api@1.6.2
-  - @backstage/backend-defaults@0.15.1
-  - @backstage/plugin-permission-common@0.9.5
-  - @backstage/plugin-auth-node@0.6.12
+  - @backstage/backend-app-api@1.5.0-next.1
+  - @backstage/backend-defaults@0.15.2-next.1
+  - @backstage/backend-plugin-api@1.7.0-next.1
+  - @backstage/plugin-auth-node@0.6.13-next.1
+  - @backstage/plugin-events-node@0.4.19-next.0
+
+## 1.10.4-next.0
+
+### Patch Changes
+
+- f1d29b4: Updated `startTestBackend` to support factory-based extension points (v1.1 format) in addition to the existing direct implementation format.
+- 7455dae: Use node prefix on native imports
+- 69d880e: Bump to latest zod to ensure it has the latest features
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.7.0-next.0
+  - @backstage/backend-defaults@0.15.1-next.0
+  - @backstage/plugin-auth-node@0.6.12-next.0
+  - @backstage/backend-app-api@1.5.0-next.0
+  - @backstage/plugin-permission-common@0.9.5-next.0
+  - @backstage/plugin-events-node@0.4.19-next.0
+  - @backstage/config@1.3.6
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.2
 
 ## 1.10.3
 

package/dist/alpha/services/ActionsRegistryServiceMock.cjs.js

@@ -2,8 +2,8 @@
 
 var mockServices = require('../../services/mockServices.cjs.js');
 require('../../services/mockCredentials.cjs.js');
+var createServiceMock = require('../../services/createServiceMock.cjs.js');
 var MockActionsRegistry = require('./MockActionsRegistry.cjs.js');
-var simpleMock = require('./simpleMock.cjs.js');
 var alpha$1 = require('@backstage/backend-plugin-api/alpha');
 var alpha = require('@backstage/backend-defaults/alpha');
 
@@ -14,12 +14,9 @@ function actionsRegistryServiceMock(options) {
 }
 ((actionsRegistryServiceMock2) => {
   actionsRegistryServiceMock2.factory = () => alpha.actionsRegistryServiceFactory;
-  actionsRegistryServiceMock2.mock = simpleMock.simpleMock(
-    alpha$1.actionsRegistryServiceRef,
-    () => ({
-      register: jest.fn()
-    })
-  );
+  actionsRegistryServiceMock2.mock = createServiceMock.createServiceMock(alpha$1.actionsRegistryServiceRef, () => ({
+    register: jest.fn()
+  }));
 })(actionsRegistryServiceMock || (actionsRegistryServiceMock = {}));
 
 exports.actionsRegistryServiceMock = actionsRegistryServiceMock;

package/dist/alpha/services/ActionsRegistryServiceMock.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"ActionsRegistryServiceMock.cjs.js","sources":["../../../src/alpha/services/ActionsRegistryServiceMock.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { mockServices } from '../../services';\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport { MockActionsRegistry } from './MockActionsRegistry';\nimport { simpleMock } from './simpleMock';\nimport {\n  ActionsRegistryService,\n  actionsRegistryServiceRef,\n} from '@backstage/backend-plugin-api/alpha';\nimport { actionsRegistryServiceFactory } from '@backstage/backend-defaults/alpha';\n\n/**\n * @alpha\n */\nexport function actionsRegistryServiceMock(options?: {\n  logger: LoggerService;\n}): MockActionsRegistry {\n  return MockActionsRegistry.create({\n    logger: options?.logger ?? mockServices.logger.mock(),\n  });\n}\n\n/**\n * @alpha\n */\nexport namespace actionsRegistryServiceMock {\n  export const factory = () => actionsRegistryServiceFactory;\n\n  export const mock = simpleMock<ActionsRegistryService>(\n    actionsRegistryServiceRef,\n    () => ({\n      register: jest.fn(),\n    }),\n  );\n}\n"],"names":["MockActionsRegistry","mockServices","actionsRegistryServiceMock","actionsRegistryServiceFactory","simpleMock","actionsRegistryServiceRef"],"mappings":";;;;;;;;;AA4BO,SAAS,2BAA2B,OAAA,EAEnB;AACtB,EAAA,OAAOA,wCAAoB,MAAA,CAAO;AAAA,IAChC,MAAA,EAAQ,OAAA,EAAS,MAAA,IAAUC,yBAAA,CAAa,OAAO,IAAA;AAAK,GACrD,CAAA;AACH;AAAA,CAKO,CAAUC,2BAAAA,KAAV;AACE,EAAMA,2BAAAA,CAAA,UAAU,MAAMC,mCAAA;AAEtB,EAAMD,4BAAA,IAAA,GAAOE,qBAAA;AAAA,IAClBC,iCAAA;AAAA,IACA,OAAO;AAAA,MACL,QAAA,EAAU,KAAK,EAAA;AAAG,KACpB;AAAA,GACF;AAAA,CAAA,EARe,0BAAA,KAAA,0BAAA,GAAA,EAAA,CAAA,CAAA;;;;"}
+{"version":3,"file":"ActionsRegistryServiceMock.cjs.js","sources":["../../../src/alpha/services/ActionsRegistryServiceMock.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { mockServices } from '../../services';\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport { MockActionsRegistry } from './MockActionsRegistry';\nimport { createServiceMock } from './alphaCreateServiceMock';\nimport { actionsRegistryServiceRef } from '@backstage/backend-plugin-api/alpha';\nimport { actionsRegistryServiceFactory } from '@backstage/backend-defaults/alpha';\n\n/**\n * @alpha\n */\nexport function actionsRegistryServiceMock(options?: {\n  logger: LoggerService;\n}): MockActionsRegistry {\n  return MockActionsRegistry.create({\n    logger: options?.logger ?? mockServices.logger.mock(),\n  });\n}\n\n/**\n * @alpha\n */\nexport namespace actionsRegistryServiceMock {\n  export const factory = () => actionsRegistryServiceFactory;\n\n  export const mock = createServiceMock(actionsRegistryServiceRef, () => ({\n    register: jest.fn(),\n  }));\n}\n"],"names":["MockActionsRegistry","mockServices","actionsRegistryServiceMock","actionsRegistryServiceFactory","createServiceMock","actionsRegistryServiceRef"],"mappings":";;;;;;;;;AAyBO,SAAS,2BAA2B,OAAA,EAEnB;AACtB,EAAA,OAAOA,wCAAoB,MAAA,CAAO;AAAA,IAChC,MAAA,EAAQ,OAAA,EAAS,MAAA,IAAUC,yBAAA,CAAa,OAAO,IAAA;AAAK,GACrD,CAAA;AACH;AAAA,CAKO,CAAUC,2BAAAA,KAAV;AACE,EAAMA,2BAAAA,CAAA,UAAU,MAAMC,mCAAA;AAEtB,EAAMD,2BAAAA,CAAA,IAAA,GAAOE,mCAAA,CAAkBC,iCAAA,EAA2B,OAAO;AAAA,IACtE,QAAA,EAAU,KAAK,EAAA;AAAG,GACpB,CAAE,CAAA;AAAA,CAAA,EALa,0BAAA,KAAA,0BAAA,GAAA,EAAA,CAAA,CAAA;;;;"}

package/dist/alpha/services/ActionsServiceMock.cjs.js

@@ -1,13 +1,13 @@
 'use strict';
 
-var simpleMock = require('./simpleMock.cjs.js');
+var createServiceMock = require('../../services/createServiceMock.cjs.js');
 var alpha$1 = require('@backstage/backend-plugin-api/alpha');
 var alpha = require('@backstage/backend-defaults/alpha');
 
 exports.actionsServiceMock = void 0;
 ((actionsServiceMock2) => {
   actionsServiceMock2.factory = () => alpha.actionsServiceFactory;
-  actionsServiceMock2.mock = simpleMock.simpleMock(alpha$1.actionsServiceRef, () => ({
+  actionsServiceMock2.mock = createServiceMock.createServiceMock(alpha$1.actionsServiceRef, () => ({
     invoke: jest.fn(),
     list: jest.fn()
   }));

package/dist/alpha/services/ActionsServiceMock.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"ActionsServiceMock.cjs.js","sources":["../../../src/alpha/services/ActionsServiceMock.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { simpleMock } from './simpleMock';\nimport {\n  ActionsService,\n  actionsServiceRef,\n} from '@backstage/backend-plugin-api/alpha';\nimport { actionsServiceFactory } from '@backstage/backend-defaults/alpha';\n\n/**\n * @alpha\n */\nexport namespace actionsServiceMock {\n  export const factory = () => actionsServiceFactory;\n\n  export const mock = simpleMock<ActionsService>(actionsServiceRef, () => ({\n    invoke: jest.fn(),\n    list: jest.fn(),\n  }));\n}\n"],"names":["actionsServiceMock","actionsServiceFactory","simpleMock","actionsServiceRef"],"mappings":";;;;;;AA0BiBA;AAAA,CAAV,CAAUA,mBAAAA,KAAV;AACE,EAAMA,mBAAAA,CAAA,UAAU,MAAMC,2BAAA;AAEtB,EAAMD,mBAAAA,CAAA,IAAA,GAAOE,qBAAA,CAA2BC,yBAAA,EAAmB,OAAO;AAAA,IACvE,MAAA,EAAQ,KAAK,EAAA,EAAG;AAAA,IAChB,IAAA,EAAM,KAAK,EAAA;AAAG,GAChB,CAAE,CAAA;AAAA,CAAA,EANaH,0BAAA,KAAAA,0BAAA,GAAA,EAAA,CAAA,CAAA;;"}
+{"version":3,"file":"ActionsServiceMock.cjs.js","sources":["../../../src/alpha/services/ActionsServiceMock.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceMock } from './alphaCreateServiceMock';\nimport { actionsServiceRef } from '@backstage/backend-plugin-api/alpha';\nimport { actionsServiceFactory } from '@backstage/backend-defaults/alpha';\n\n/**\n * @alpha\n */\nexport namespace actionsServiceMock {\n  export const factory = () => actionsServiceFactory;\n\n  export const mock = createServiceMock(actionsServiceRef, () => ({\n    invoke: jest.fn(),\n    list: jest.fn(),\n  }));\n}\n"],"names":["actionsServiceMock","actionsServiceFactory","createServiceMock","actionsServiceRef"],"mappings":";;;;;;AAuBiBA;AAAA,CAAV,CAAUA,mBAAAA,KAAV;AACE,EAAMA,mBAAAA,CAAA,UAAU,MAAMC,2BAAA;AAEtB,EAAMD,mBAAAA,CAAA,IAAA,GAAOE,mCAAA,CAAkBC,yBAAA,EAAmB,OAAO;AAAA,IAC9D,MAAA,EAAQ,KAAK,EAAA,EAAG;AAAA,IAChB,IAAA,EAAM,KAAK,EAAA;AAAG,GAChB,CAAE,CAAA;AAAA,CAAA,EANaH,0BAAA,KAAAA,0BAAA,GAAA,EAAA,CAAA,CAAA;;"}

package/dist/alpha/services/MockActionsRegistry.cjs.js

@@ -5,6 +5,7 @@ var zod = require('zod');
 var zodToJsonSchema = require('zod-to-json-schema');
 require('../../services/mockServices.cjs.js');
 var mockCredentials = require('../../services/mockCredentials.cjs.js');
+require('@backstage/backend-plugin-api');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 

package/dist/alpha/services/MockActionsRegistry.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"MockActionsRegistry.cjs.js","sources":["../../../src/alpha/services/MockActionsRegistry.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  BackstageCredentials,\n  LoggerService,\n} from '@backstage/backend-plugin-api';\nimport { ForwardedError, InputError, NotFoundError } from '@backstage/errors';\nimport { JsonObject, JsonValue } from '@backstage/types';\nimport { z, AnyZodObject } from 'zod';\nimport zodToJsonSchema from 'zod-to-json-schema';\nimport { mockCredentials } from '../../services';\nimport {\n  ActionsRegistryActionOptions,\n  ActionsRegistryService,\n  ActionsService,\n  ActionsServiceAction,\n} from '@backstage/backend-plugin-api/alpha';\n\n/**\n * A mock implementation of the ActionsRegistryService and ActionsService that can be used in tests.\n *\n * This is useful for testing actions that are registered with the ActionsRegistryService and ActionsService.\n *\n * The plugin ID is hardcoded to `testing` in the mock implementation.\n *\n * @example\n * ```ts\n * const actionsRegistry = mockServices.actionsRegistry();\n *\n * actionsRegistry.register({\n *   name: 'test',\n *   title: 'Test',\n *   description: 'Test',\n *   schema: {\n *     input: z.object({ name: z.string() }),\n *     output: z.object({ name: z.string() }),\n *   },\n *   action: async ({ input }) => ({ output: { name: input.name } }),\n * });\n *\n *\n * const result = await actionsRegistry.invoke({\n *   id: 'testing:test',\n *   input: { name: 'test' },\n * });\n *\n * expect(result).toEqual({ output: { name: 'test' } });\n * ```\n *\n * @alpha\n */\nexport class MockActionsRegistry\n  implements ActionsRegistryService, ActionsService\n{\n  private readonly logger: LoggerService;\n\n  private constructor(logger: LoggerService) {\n    this.logger = logger;\n  }\n\n  static create(opts: { logger: LoggerService }) {\n    return new MockActionsRegistry(opts.logger);\n  }\n\n  readonly actions: Map<string, ActionsRegistryActionOptions<any, any>> =\n    new Map();\n\n  async list(): Promise<{ actions: ActionsServiceAction[] }> {\n    return {\n      actions: Array.from(this.actions.entries()).map(([id, action]) => ({\n        id,\n        name: action.name,\n        title: action.title,\n        description: action.description,\n        attributes: {\n          destructive: action.attributes?.destructive ?? true,\n          idempotent: action.attributes?.idempotent ?? false,\n          readOnly: action.attributes?.readOnly ?? false,\n        },\n        schema: {\n          input: action.schema?.input\n            ? zodToJsonSchema(action.schema.input(z))\n            : zodToJsonSchema(z.object({})),\n          output: action.schema?.output\n            ? zodToJsonSchema(action.schema.output(z))\n            : zodToJsonSchema(z.object({})),\n        } as ActionsServiceAction['schema'],\n      })),\n    };\n  }\n\n  async invoke(opts: {\n    id: string;\n    input?: JsonObject;\n    credentials?: BackstageCredentials;\n  }): Promise<{ output: JsonValue }> {\n    const action = this.actions.get(opts.id);\n\n    if (!action) {\n      const availableActionIds = Array.from(this.actions.keys()).join(', ');\n      throw new NotFoundError(\n        `Action \"${opts.id}\" not found, available actions: ${\n          availableActionIds ? `\"${availableActionIds}\"` : 'none'\n        }`,\n      );\n    }\n\n    const input = action.schema?.input\n      ? action.schema.input(z).safeParse(opts.input)\n      : ({ success: true, data: undefined } as const);\n\n    if (!input.success) {\n      throw new InputError(`Invalid input to action \"${opts.id}\"`, input.error);\n    }\n\n    try {\n      const result = await action.action({\n        input: input.data,\n        credentials: opts.credentials ?? mockCredentials.none(),\n        logger: this.logger,\n      });\n\n      const output = action.schema?.output\n        ? action.schema.output(z).safeParse(result?.output)\n        : ({ success: true, data: result?.output } as const);\n\n      if (!output.success) {\n        throw new InputError(\n          `Invalid output from action \"${opts.id}\"`,\n          output.error,\n        );\n      }\n\n      return { output: output.data };\n    } catch (error) {\n      throw new ForwardedError(\n        `Failed execution of action \"${opts.id}\"`,\n        error,\n      );\n    }\n  }\n\n  register<\n    TInputSchema extends AnyZodObject,\n    TOutputSchema extends AnyZodObject,\n  >(options: ActionsRegistryActionOptions<TInputSchema, TOutputSchema>): void {\n    // hardcode test: prefix similar to how the default actions registry does it\n    // and other places around the testing ecosystem:\n    // https://github.com/backstage/backstage/blob/a9219496d5c073aaa0b8caf32ece10455cf65e61/packages/backend-test-utils/src/next/services/mockServices.ts#L321\n    // https://github.com/backstage/backstage/blob/861f162b4a39117b824669d67a951ed1db142e3d/packages/backend-test-utils/src/next/wiring/ServiceFactoryTester.ts#L99\n    const id = `test:${options.name}`;\n\n    if (this.actions.has(id)) {\n      throw new Error(`Action with id \"${id}\" is already registered`);\n    }\n\n    this.actions.set(id, options);\n  }\n}\n"],"names":["zodToJsonSchema","z","NotFoundError","InputError","mockCredentials","ForwardedError"],"mappings":";;;;;;;;;;;;AAgEO,MAAM,mBAAA,CAEb;AAAA,EACmB,MAAA;AAAA,EAET,YAAY,MAAA,EAAuB;AACzC,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AAAA,EAChB;AAAA,EAEA,OAAO,OAAO,IAAA,EAAiC;AAC7C,IAAA,OAAO,IAAI,mBAAA,CAAoB,IAAA,CAAK,MAAM,CAAA;AAAA,EAC5C;AAAA,EAES,OAAA,uBACH,GAAA,EAAI;AAAA,EAEV,MAAM,IAAA,GAAqD;AACzD,IAAA,OAAO;AAAA,MACL,OAAA,EAAS,KAAA,CAAM,IAAA,CAAK,IAAA,CAAK,OAAA,CAAQ,OAAA,EAAS,CAAA,CAAE,GAAA,CAAI,CAAC,CAAC,EAAA,EAAI,MAAM,CAAA,MAAO;AAAA,QACjE,EAAA;AAAA,QACA,MAAM,MAAA,CAAO,IAAA;AAAA,QACb,OAAO,MAAA,CAAO,KAAA;AAAA,QACd,aAAa,MAAA,CAAO,WAAA;AAAA,QACpB,UAAA,EAAY;AAAA,UACV,WAAA,EAAa,MAAA,CAAO,UAAA,EAAY,WAAA,IAAe,IAAA;AAAA,UAC/C,UAAA,EAAY,MAAA,CAAO,UAAA,EAAY,UAAA,IAAc,KAAA;AAAA,UAC7C,QAAA,EAAU,MAAA,CAAO,UAAA,EAAY,QAAA,IAAY;AAAA,SAC3C;AAAA,QACA,MAAA,EAAQ;AAAA,UACN,OAAO,MAAA,CAAO,MAAA,EAAQ,KAAA,GAClBA,gCAAA,CAAgB,OAAO,MAAA,CAAO,KAAA,CAAMC,KAAC,CAAC,IACtCD,gCAAA,CAAgBC,KAAA,CAAE,MAAA,CAAO,EAAE,CAAC,CAAA;AAAA,UAChC,QAAQ,MAAA,CAAO,MAAA,EAAQ,MAAA,GACnBD,gCAAA,CAAgB,OAAO,MAAA,CAAO,MAAA,CAAOC,KAAC,CAAC,IACvCD,gCAAA,CAAgBC,KAAA,CAAE,MAAA,CAAO,EAAE,CAAC;AAAA;AAClC,OACF,CAAE;AAAA,KACJ;AAAA,EACF;AAAA,EAEA,MAAM,OAAO,IAAA,EAIsB;AACjC,IAAA,MAAM,MAAA,GAAS,IAAA,CAAK,OAAA,CAAQ,GAAA,CAAI,KAAK,EAAE,CAAA;AAEvC,IAAA,IAAI,CAAC,MAAA,EAAQ;AACX,MAAA,MAAM,kBAAA,GAAqB,MAAM,IAAA,CAAK,IAAA,CAAK,QAAQ,IAAA,EAAM,CAAA,CAAE,IAAA,CAAK,IAAI,CAAA;AACpE,MAAA,MAAM,IAAIC,oBAAA;AAAA,QACR,CAAA,QAAA,EAAW,KAAK,EAAE,CAAA,gCAAA,EAChB,qBAAqB,CAAA,CAAA,EAAI,kBAAkB,MAAM,MACnD,CAAA;AAAA,OACF;AAAA,IACF;AAEA,IAAA,MAAM,QAAQ,MAAA,CAAO,MAAA,EAAQ,KAAA,GACzB,MAAA,CAAO,OAAO,KAAA,CAAMD,KAAC,CAAA,CAAE,SAAA,CAAU,KAAK,KAAK,CAAA,GAC1C,EAAE,OAAA,EAAS,IAAA,EAAM,MAAM,MAAA,EAAU;AAEtC,IAAA,IAAI,CAAC,MAAM,OAAA,EAAS;AAClB,MAAA,MAAM,IAAIE,iBAAA,CAAW,CAAA,yBAAA,EAA4B,KAAK,EAAE,CAAA,CAAA,CAAA,EAAK,MAAM,KAAK,CAAA;AAAA,IAC1E;AAEA,IAAA,IAAI;AACF,MAAA,MAAM,MAAA,GAAS,MAAM,MAAA,CAAO,MAAA,CAAO;AAAA,QACjC,OAAO,KAAA,CAAM,IAAA;AAAA,QACb,WAAA,EAAa,IAAA,CAAK,WAAA,IAAeC,+BAAA,CAAgB,IAAA,EAAK;AAAA,QACtD,QAAQ,IAAA,CAAK;AAAA,OACd,CAAA;AAED,MAAA,MAAM,SAAS,MAAA,CAAO,MAAA,EAAQ,SAC1B,MAAA,CAAO,MAAA,CAAO,OAAOH,KAAC,CAAA,CAAE,SAAA,CAAU,MAAA,EAAQ,MAAM,CAAA,GAC/C,EAAE,SAAS,IAAA,EAAM,IAAA,EAAM,QAAQ,MAAA,EAAO;AAE3C,MAAA,IAAI,CAAC,OAAO,OAAA,EAAS;AACnB,QAAA,MAAM,IAAIE,iBAAA;AAAA,UACR,CAAA,4BAAA,EAA+B,KAAK,EAAE,CAAA,CAAA,CAAA;AAAA,UACtC,MAAA,CAAO;AAAA,SACT;AAAA,MACF;AAEA,MAAA,OAAO,EAAE,MAAA,EAAQ,MAAA,CAAO,IAAA,EAAK;AAAA,IAC/B,SAAS,KAAA,EAAO;AACd,MAAA,MAAM,IAAIE,qBAAA;AAAA,QACR,CAAA,4BAAA,EAA+B,KAAK,EAAE,CAAA,CAAA,CAAA;AAAA,QACtC;AAAA,OACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,SAGE,OAAA,EAA0E;AAK1E,IAAA,MAAM,EAAA,GAAK,CAAA,KAAA,EAAQ,OAAA,CAAQ,IAAI,CAAA,CAAA;AAE/B,IAAA,IAAI,IAAA,CAAK,OAAA,CAAQ,GAAA,CAAI,EAAE,CAAA,EAAG;AACxB,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,gBAAA,EAAmB,EAAE,CAAA,uBAAA,CAAyB,CAAA;AAAA,IAChE;AAEA,IAAA,IAAA,CAAK,OAAA,CAAQ,GAAA,CAAI,EAAA,EAAI,OAAO,CAAA;AAAA,EAC9B;AACF;;;;"}
+{"version":3,"file":"MockActionsRegistry.cjs.js","sources":["../../../src/alpha/services/MockActionsRegistry.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  BackstageCredentials,\n  LoggerService,\n} from '@backstage/backend-plugin-api';\nimport { ForwardedError, InputError, NotFoundError } from '@backstage/errors';\nimport { JsonObject, JsonValue } from '@backstage/types';\nimport { z, AnyZodObject } from 'zod';\nimport zodToJsonSchema from 'zod-to-json-schema';\nimport { mockCredentials } from '../../services';\nimport {\n  ActionsRegistryActionOptions,\n  ActionsRegistryService,\n  ActionsService,\n  ActionsServiceAction,\n} from '@backstage/backend-plugin-api/alpha';\n\n/**\n * A mock implementation of the ActionsRegistryService and ActionsService that can be used in tests.\n *\n * This is useful for testing actions that are registered with the ActionsRegistryService and ActionsService.\n *\n * The plugin ID is hardcoded to `testing` in the mock implementation.\n *\n * @example\n * ```ts\n * const actionsRegistry = mockServices.actionsRegistry();\n *\n * actionsRegistry.register({\n *   name: 'test',\n *   title: 'Test',\n *   description: 'Test',\n *   schema: {\n *     input: z.object({ name: z.string() }),\n *     output: z.object({ name: z.string() }),\n *   },\n *   action: async ({ input }) => ({ output: { name: input.name } }),\n * });\n *\n *\n * const result = await actionsRegistry.invoke({\n *   id: 'testing:test',\n *   input: { name: 'test' },\n * });\n *\n * expect(result).toEqual({ output: { name: 'test' } });\n * ```\n *\n * @alpha\n */\nexport class MockActionsRegistry\n  implements ActionsRegistryService, ActionsService\n{\n  private readonly logger: LoggerService;\n\n  private constructor(logger: LoggerService) {\n    this.logger = logger;\n  }\n\n  static create(opts: { logger: LoggerService }) {\n    return new MockActionsRegistry(opts.logger);\n  }\n\n  readonly actions: Map<string, ActionsRegistryActionOptions<any, any>> =\n    new Map();\n\n  async list(): Promise<{ actions: ActionsServiceAction[] }> {\n    return {\n      actions: Array.from(this.actions.entries()).map(([id, action]) => ({\n        id,\n        name: action.name,\n        title: action.title,\n        description: action.description,\n        attributes: {\n          destructive: action.attributes?.destructive ?? true,\n          idempotent: action.attributes?.idempotent ?? false,\n          readOnly: action.attributes?.readOnly ?? false,\n        },\n        schema: {\n          input: action.schema?.input\n            ? zodToJsonSchema(action.schema.input(z))\n            : zodToJsonSchema(z.object({})),\n          output: action.schema?.output\n            ? zodToJsonSchema(action.schema.output(z))\n            : zodToJsonSchema(z.object({})),\n        } as ActionsServiceAction['schema'],\n      })),\n    };\n  }\n\n  async invoke(opts: {\n    id: string;\n    input?: JsonObject;\n    credentials?: BackstageCredentials;\n  }): Promise<{ output: JsonValue }> {\n    const action = this.actions.get(opts.id);\n\n    if (!action) {\n      const availableActionIds = Array.from(this.actions.keys()).join(', ');\n      throw new NotFoundError(\n        `Action \"${opts.id}\" not found, available actions: ${\n          availableActionIds ? `\"${availableActionIds}\"` : 'none'\n        }`,\n      );\n    }\n\n    const input = action.schema?.input\n      ? action.schema.input(z).safeParse(opts.input)\n      : ({ success: true, data: undefined } as const);\n\n    if (!input.success) {\n      throw new InputError(`Invalid input to action \"${opts.id}\"`, input.error);\n    }\n\n    try {\n      const result = await action.action({\n        input: input.data,\n        credentials: opts.credentials ?? mockCredentials.none(),\n        logger: this.logger,\n      });\n\n      const output = action.schema?.output\n        ? action.schema.output(z).safeParse(result?.output)\n        : ({ success: true, data: result?.output } as const);\n\n      if (!output.success) {\n        throw new InputError(\n          `Invalid output from action \"${opts.id}\"`,\n          output.error,\n        );\n      }\n\n      return { output: output.data };\n    } catch (error) {\n      throw new ForwardedError(\n        `Failed execution of action \"${opts.id}\"`,\n        error,\n      );\n    }\n  }\n\n  register<\n    TInputSchema extends AnyZodObject,\n    TOutputSchema extends AnyZodObject,\n  >(options: ActionsRegistryActionOptions<TInputSchema, TOutputSchema>): void {\n    // hardcode test: prefix similar to how the default actions registry does it\n    // and other places around the testing ecosystem:\n    // https://github.com/backstage/backstage/blob/a9219496d5c073aaa0b8caf32ece10455cf65e61/packages/backend-test-utils/src/next/services/mockServices.ts#L321\n    // https://github.com/backstage/backstage/blob/861f162b4a39117b824669d67a951ed1db142e3d/packages/backend-test-utils/src/next/wiring/ServiceFactoryTester.ts#L99\n    const id = `test:${options.name}`;\n\n    if (this.actions.has(id)) {\n      throw new Error(`Action with id \"${id}\" is already registered`);\n    }\n\n    this.actions.set(id, options);\n  }\n}\n"],"names":["zodToJsonSchema","z","NotFoundError","InputError","mockCredentials","ForwardedError"],"mappings":";;;;;;;;;;;;;AAgEO,MAAM,mBAAA,CAEb;AAAA,EACmB,MAAA;AAAA,EAET,YAAY,MAAA,EAAuB;AACzC,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AAAA,EAChB;AAAA,EAEA,OAAO,OAAO,IAAA,EAAiC;AAC7C,IAAA,OAAO,IAAI,mBAAA,CAAoB,IAAA,CAAK,MAAM,CAAA;AAAA,EAC5C;AAAA,EAES,OAAA,uBACH,GAAA,EAAI;AAAA,EAEV,MAAM,IAAA,GAAqD;AACzD,IAAA,OAAO;AAAA,MACL,OAAA,EAAS,KAAA,CAAM,IAAA,CAAK,IAAA,CAAK,OAAA,CAAQ,OAAA,EAAS,CAAA,CAAE,GAAA,CAAI,CAAC,CAAC,EAAA,EAAI,MAAM,CAAA,MAAO;AAAA,QACjE,EAAA;AAAA,QACA,MAAM,MAAA,CAAO,IAAA;AAAA,QACb,OAAO,MAAA,CAAO,KAAA;AAAA,QACd,aAAa,MAAA,CAAO,WAAA;AAAA,QACpB,UAAA,EAAY;AAAA,UACV,WAAA,EAAa,MAAA,CAAO,UAAA,EAAY,WAAA,IAAe,IAAA;AAAA,UAC/C,UAAA,EAAY,MAAA,CAAO,UAAA,EAAY,UAAA,IAAc,KAAA;AAAA,UAC7C,QAAA,EAAU,MAAA,CAAO,UAAA,EAAY,QAAA,IAAY;AAAA,SAC3C;AAAA,QACA,MAAA,EAAQ;AAAA,UACN,OAAO,MAAA,CAAO,MAAA,EAAQ,KAAA,GAClBA,gCAAA,CAAgB,OAAO,MAAA,CAAO,KAAA,CAAMC,KAAC,CAAC,IACtCD,gCAAA,CAAgBC,KAAA,CAAE,MAAA,CAAO,EAAE,CAAC,CAAA;AAAA,UAChC,QAAQ,MAAA,CAAO,MAAA,EAAQ,MAAA,GACnBD,gCAAA,CAAgB,OAAO,MAAA,CAAO,MAAA,CAAOC,KAAC,CAAC,IACvCD,gCAAA,CAAgBC,KAAA,CAAE,MAAA,CAAO,EAAE,CAAC;AAAA;AAClC,OACF,CAAE;AAAA,KACJ;AAAA,EACF;AAAA,EAEA,MAAM,OAAO,IAAA,EAIsB;AACjC,IAAA,MAAM,MAAA,GAAS,IAAA,CAAK,OAAA,CAAQ,GAAA,CAAI,KAAK,EAAE,CAAA;AAEvC,IAAA,IAAI,CAAC,MAAA,EAAQ;AACX,MAAA,MAAM,kBAAA,GAAqB,MAAM,IAAA,CAAK,IAAA,CAAK,QAAQ,IAAA,EAAM,CAAA,CAAE,IAAA,CAAK,IAAI,CAAA;AACpE,MAAA,MAAM,IAAIC,oBAAA;AAAA,QACR,CAAA,QAAA,EAAW,KAAK,EAAE,CAAA,gCAAA,EAChB,qBAAqB,CAAA,CAAA,EAAI,kBAAkB,MAAM,MACnD,CAAA;AAAA,OACF;AAAA,IACF;AAEA,IAAA,MAAM,QAAQ,MAAA,CAAO,MAAA,EAAQ,KAAA,GACzB,MAAA,CAAO,OAAO,KAAA,CAAMD,KAAC,CAAA,CAAE,SAAA,CAAU,KAAK,KAAK,CAAA,GAC1C,EAAE,OAAA,EAAS,IAAA,EAAM,MAAM,MAAA,EAAU;AAEtC,IAAA,IAAI,CAAC,MAAM,OAAA,EAAS;AAClB,MAAA,MAAM,IAAIE,iBAAA,CAAW,CAAA,yBAAA,EAA4B,KAAK,EAAE,CAAA,CAAA,CAAA,EAAK,MAAM,KAAK,CAAA;AAAA,IAC1E;AAEA,IAAA,IAAI;AACF,MAAA,MAAM,MAAA,GAAS,MAAM,MAAA,CAAO,MAAA,CAAO;AAAA,QACjC,OAAO,KAAA,CAAM,IAAA;AAAA,QACb,WAAA,EAAa,IAAA,CAAK,WAAA,IAAeC,+BAAA,CAAgB,IAAA,EAAK;AAAA,QACtD,QAAQ,IAAA,CAAK;AAAA,OACd,CAAA;AAED,MAAA,MAAM,SAAS,MAAA,CAAO,MAAA,EAAQ,SAC1B,MAAA,CAAO,MAAA,CAAO,OAAOH,KAAC,CAAA,CAAE,SAAA,CAAU,MAAA,EAAQ,MAAM,CAAA,GAC/C,EAAE,SAAS,IAAA,EAAM,IAAA,EAAM,QAAQ,MAAA,EAAO;AAE3C,MAAA,IAAI,CAAC,OAAO,OAAA,EAAS;AACnB,QAAA,MAAM,IAAIE,iBAAA;AAAA,UACR,CAAA,4BAAA,EAA+B,KAAK,EAAE,CAAA,CAAA,CAAA;AAAA,UACtC,MAAA,CAAO;AAAA,SACT;AAAA,MACF;AAEA,MAAA,OAAO,EAAE,MAAA,EAAQ,MAAA,CAAO,IAAA,EAAK;AAAA,IAC/B,SAAS,KAAA,EAAO;AACd,MAAA,MAAM,IAAIE,qBAAA;AAAA,QACR,CAAA,4BAAA,EAA+B,KAAK,EAAE,CAAA,CAAA,CAAA;AAAA,QACtC;AAAA,OACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,SAGE,OAAA,EAA0E;AAK1E,IAAA,MAAM,EAAA,GAAK,CAAA,KAAA,EAAQ,OAAA,CAAQ,IAAI,CAAA,CAAA;AAE/B,IAAA,IAAI,IAAA,CAAK,OAAA,CAAQ,GAAA,CAAI,EAAE,CAAA,EAAG;AACxB,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,gBAAA,EAAmB,EAAE,CAAA,uBAAA,CAAyB,CAAA;AAAA,IAChE;AAEA,IAAA,IAAA,CAAK,OAAA,CAAQ,GAAA,CAAI,EAAA,EAAI,OAAO,CAAA;AAAA,EAC9B;AACF;;;;"}

package/dist/alpha.d.ts

@@ -1,15 +1,10 @@
+import { S as ServiceMock } from './types/createServiceMock.d-CeKvILsY.js';
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { ServiceFactory, LoggerService, BackstageCredentials } from '@backstage/backend-plugin-api';
+import { LoggerService, BackstageCredentials } from '@backstage/backend-plugin-api';
+import * as _backstage_backend_plugin_api_alpha from '@backstage/backend-plugin-api/alpha';
+import { ActionsRegistryService, ActionsService, ActionsRegistryActionOptions, ActionsServiceAction } from '@backstage/backend-plugin-api/alpha';
 import { JsonObject, JsonValue } from '@backstage/types';
 import { AnyZodObject } from 'zod';
-import { ActionsRegistryService, ActionsService, ActionsRegistryActionOptions, ActionsServiceAction } from '@backstage/backend-plugin-api/alpha';
-
-/** @alpha */
-type ServiceMock<TService> = {
-    factory: ServiceFactory<TService>;
-} & {
-    [Key in keyof TService]: TService[Key] extends (...args: infer Args) => infer Return ? TService[Key] & jest.MockInstance<Return, Args> : TService[Key];
-};
 
 /**
  * A mock implementation of the ActionsRegistryService and ActionsService that can be used in tests.
@@ -74,17 +69,16 @@ declare function actionsRegistryServiceMock(options?: {
  * @alpha
  */
 declare namespace actionsRegistryServiceMock {
-    const factory: () => _backstage_backend_plugin_api.ServiceFactory<ActionsRegistryService, "plugin", "singleton">;
-    const mock: (partialImpl?: Partial<ActionsRegistryService> | undefined) => ServiceMock<ActionsRegistryService>;
+    const factory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api_alpha.ActionsRegistryService, "plugin", "singleton">;
+    const mock: (partialImpl?: Partial<_backstage_backend_plugin_api_alpha.ActionsRegistryService> | undefined) => ServiceMock<_backstage_backend_plugin_api_alpha.ActionsRegistryService>;
 }
 
 /**
  * @alpha
  */
 declare namespace actionsServiceMock {
-    const factory: () => _backstage_backend_plugin_api.ServiceFactory<ActionsService, "plugin", "singleton">;
-    const mock: (partialImpl?: Partial<ActionsService> | undefined) => ServiceMock<ActionsService>;
+    const factory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api_alpha.ActionsService, "plugin", "singleton">;
+    const mock: (partialImpl?: Partial<_backstage_backend_plugin_api_alpha.ActionsService> | undefined) => ServiceMock<_backstage_backend_plugin_api_alpha.ActionsService>;
 }
 
-export { MockActionsRegistry, actionsRegistryServiceMock, actionsServiceMock };
-export type { ServiceMock };
+export { MockActionsRegistry, ServiceMock, actionsRegistryServiceMock, actionsServiceMock };

package/dist/database/mysql.cjs.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var errors = require('@backstage/errors');
-var crypto = require('crypto');
+var node_crypto = require('node:crypto');
 var knexFactory = require('knex');
 var uuid = require('uuid');
 var yn = require('yn');
@@ -132,7 +132,7 @@ class MysqlEngine {
   async createDatabaseInstance() {
     const adminConnection = this.#connectAdmin();
     try {
-      const databaseName = `db${crypto.randomBytes(16).toString("hex")}`;
+      const databaseName = `db${node_crypto.randomBytes(16).toString("hex")}`;
       await adminConnection.raw("CREATE DATABASE ??", [databaseName]);
       this.#databaseNames.push(databaseName);
       const knexInstance = knexFactory__default.default({

package/dist/database/mysql.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"mysql.cjs.js","sources":["../../src/database/mysql.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { stringifyError } from '@backstage/errors';\nimport { randomBytes } from 'crypto';\nimport knexFactory, { Knex } from 'knex';\nimport { v4 as uuid } from 'uuid';\nimport yn from 'yn';\nimport { Engine, LARGER_POOL_CONFIG, TestDatabaseProperties } from './types';\n\nasync function waitForMysqlReady(\n  connection: Knex.MySqlConnectionConfig,\n): Promise<void> {\n  const startTime = Date.now();\n\n  let lastError: Error | undefined;\n  let attempts = 0;\n  for (;;) {\n    attempts += 1;\n\n    let knex: Knex | undefined;\n    try {\n      knex = knexFactory({\n        client: 'mysql2',\n        connection: {\n          // make a copy because the driver mutates this\n          ...connection,\n        },\n      });\n      const result = await knex.select(knex.raw('version() AS version'));\n      if (Array.isArray(result) && result[0]?.version) {\n        return;\n      }\n    } catch (e) {\n      lastError = e;\n    } finally {\n      await knex?.destroy();\n    }\n\n    if (Date.now() - startTime > 30_000) {\n      throw new Error(\n        `Timed out waiting for the database to be ready for connections, ${attempts} attempts, ${\n          lastError\n            ? `last error was ${stringifyError(lastError)}`\n            : '(no errors thrown)'\n        }`,\n      );\n    }\n\n    await new Promise(resolve => setTimeout(resolve, 100));\n  }\n}\n\nexport async function startMysqlContainer(image: string): Promise<{\n  connection: Knex.MySqlConnectionConfig;\n  stopContainer: () => Promise<void>;\n}> {\n  const user = 'root';\n  const password = uuid();\n\n  // Lazy-load to avoid side-effect of importing testcontainers\n  const { GenericContainer } =\n    require('testcontainers') as typeof import('testcontainers');\n\n  const container = await new GenericContainer(image)\n    .withExposedPorts(3306)\n    .withEnvironment({ MYSQL_ROOT_PASSWORD: password })\n    .withTmpFs({ '/var/lib/mysql': 'rw' })\n    .start();\n\n  const host = container.getHost();\n  const port = container.getMappedPort(3306);\n  const connection = { host, port, user, password };\n  const stopContainer = async () => {\n    await container.stop({ timeout: 10_000 });\n  };\n\n  await waitForMysqlReady(connection);\n\n  return { connection, stopContainer };\n}\n\nexport function parseMysqlConnectionString(\n  connectionString: string,\n): Knex.MySqlConnectionConfig {\n  try {\n    const {\n      protocol,\n      username,\n      password,\n      port,\n      hostname,\n      pathname,\n      searchParams,\n    } = new URL(connectionString);\n\n    if (protocol !== 'mysql:') {\n      throw new Error(`Unknown protocol ${protocol}`);\n    } else if (!username || !password) {\n      throw new Error(`Missing username/password`);\n    } else if (!pathname.match(/^\\/[^/]+$/)) {\n      throw new Error(`Expected single path segment`);\n    }\n\n    const result: Knex.MySqlConnectionConfig = {\n      user: username,\n      password,\n      host: hostname,\n      port: Number(port || 3306),\n      database: decodeURIComponent(pathname.substring(1)),\n    };\n\n    const ssl = searchParams.get('ssl');\n    if (ssl) {\n      result.ssl = ssl;\n    }\n\n    const debug = searchParams.get('debug');\n    if (debug) {\n      result.debug = yn(debug);\n    }\n\n    return result;\n  } catch (e) {\n    throw new Error(`Error while parsing MySQL connection string, ${e}`, e);\n  }\n}\n\nexport class MysqlEngine implements Engine {\n  static async create(\n    properties: TestDatabaseProperties,\n  ): Promise<MysqlEngine> {\n    const { connectionStringEnvironmentVariableName, dockerImageName } =\n      properties;\n\n    if (connectionStringEnvironmentVariableName) {\n      const connectionString =\n        process.env[connectionStringEnvironmentVariableName];\n      if (connectionString) {\n        const connection = parseMysqlConnectionString(connectionString);\n        return new MysqlEngine(\n          properties,\n          connection as Knex.MySqlConnectionConfig,\n        );\n      }\n    }\n\n    if (dockerImageName) {\n      const { connection, stopContainer } = await startMysqlContainer(\n        dockerImageName,\n      );\n      return new MysqlEngine(properties, connection, stopContainer);\n    }\n\n    throw new Error(`Test databasee for ${properties.name} not configured`);\n  }\n\n  readonly #properties: TestDatabaseProperties;\n  readonly #connection: Knex.MySqlConnectionConfig;\n  readonly #knexInstances: Knex[];\n  readonly #databaseNames: string[];\n  readonly #stopContainer?: () => Promise<void>;\n\n  constructor(\n    properties: TestDatabaseProperties,\n    connection: Knex.MySqlConnectionConfig,\n    stopContainer?: () => Promise<void>,\n  ) {\n    this.#properties = properties;\n    this.#connection = connection;\n    this.#knexInstances = [];\n    this.#databaseNames = [];\n    this.#stopContainer = stopContainer;\n  }\n\n  async createDatabaseInstance(): Promise<Knex> {\n    const adminConnection = this.#connectAdmin();\n    try {\n      const databaseName = `db${randomBytes(16).toString('hex')}`;\n\n      await adminConnection.raw('CREATE DATABASE ??', [databaseName]);\n      this.#databaseNames.push(databaseName);\n\n      const knexInstance = knexFactory({\n        client: this.#properties.driver,\n        connection: {\n          ...this.#connection,\n          database: databaseName,\n        },\n        ...LARGER_POOL_CONFIG,\n      });\n      this.#knexInstances.push(knexInstance);\n\n      return knexInstance;\n    } finally {\n      await adminConnection.destroy();\n    }\n  }\n\n  async shutdown(): Promise<void> {\n    for (const instance of this.#knexInstances) {\n      await instance.destroy();\n    }\n\n    const adminConnection = this.#connectAdmin();\n    try {\n      for (const databaseName of this.#databaseNames) {\n        await adminConnection.raw('DROP DATABASE ??', [databaseName]);\n      }\n    } finally {\n      await adminConnection.destroy();\n    }\n\n    await this.#stopContainer?.();\n  }\n\n  #connectAdmin(): Knex {\n    const connection = {\n      ...this.#connection,\n      database: null as unknown as string,\n    };\n    return knexFactory({\n      client: this.#properties.driver,\n      connection,\n      pool: {\n        min: 0,\n        max: 1,\n        acquireTimeoutMillis: 20_000,\n        createTimeoutMillis: 20_000,\n        createRetryIntervalMillis: 1_000,\n      },\n    });\n  }\n}\n"],"names":["knexFactory","stringifyError","uuid","yn","randomBytes","LARGER_POOL_CONFIG"],"mappings":";;;;;;;;;;;;;;AAuBA,eAAe,kBACb,UAAA,EACe;AACf,EAAA,MAAM,SAAA,GAAY,KAAK,GAAA,EAAI;AAE3B,EAAA,IAAI,SAAA;AACJ,EAAA,IAAI,QAAA,GAAW,CAAA;AACf,EAAA,WAAS;AACP,IAAA,QAAA,IAAY,CAAA;AAEZ,IAAA,IAAI,IAAA;AACJ,IAAA,IAAI;AACF,MAAA,IAAA,GAAOA,4BAAA,CAAY;AAAA,QACjB,MAAA,EAAQ,QAAA;AAAA,QACR,UAAA,EAAY;AAAA;AAAA,UAEV,GAAG;AAAA;AACL,OACD,CAAA;AACD,MAAA,MAAM,SAAS,MAAM,IAAA,CAAK,OAAO,IAAA,CAAK,GAAA,CAAI,sBAAsB,CAAC,CAAA;AACjE,MAAA,IAAI,MAAM,OAAA,CAAQ,MAAM,KAAK,MAAA,CAAO,CAAC,GAAG,OAAA,EAAS;AAC/C,QAAA;AAAA,MACF;AAAA,IACF,SAAS,CAAA,EAAG;AACV,MAAA,SAAA,GAAY,CAAA;AAAA,IACd,CAAA,SAAE;AACA,MAAA,MAAM,MAAM,OAAA,EAAQ;AAAA,IACtB;AAEA,IAAA,IAAI,IAAA,CAAK,GAAA,EAAI,GAAI,SAAA,GAAY,GAAA,EAAQ;AACnC,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gEAAA,EAAmE,QAAQ,CAAA,WAAA,EACzE,SAAA,GACI,kBAAkBC,qBAAA,CAAe,SAAS,CAAC,CAAA,CAAA,GAC3C,oBACN,CAAA;AAAA,OACF;AAAA,IACF;AAEA,IAAA,MAAM,IAAI,OAAA,CAAQ,CAAA,OAAA,KAAW,UAAA,CAAW,OAAA,EAAS,GAAG,CAAC,CAAA;AAAA,EACvD;AACF;AAEA,eAAsB,oBAAoB,KAAA,EAGvC;AACD,EAAA,MAAM,IAAA,GAAO,MAAA;AACb,EAAA,MAAM,WAAWC,OAAA,EAAK;AAGtB,EAAA,MAAM,EAAE,gBAAA,EAAiB,GACvB,OAAA,CAAQ,gBAAgB,CAAA;AAE1B,EAAA,MAAM,SAAA,GAAY,MAAM,IAAI,gBAAA,CAAiB,KAAK,CAAA,CAC/C,gBAAA,CAAiB,IAAI,CAAA,CACrB,eAAA,CAAgB,EAAE,mBAAA,EAAqB,QAAA,EAAU,CAAA,CACjD,SAAA,CAAU,EAAE,gBAAA,EAAkB,IAAA,EAAM,CAAA,CACpC,KAAA,EAAM;AAET,EAAA,MAAM,IAAA,GAAO,UAAU,OAAA,EAAQ;AAC/B,EAAA,MAAM,IAAA,GAAO,SAAA,CAAU,aAAA,CAAc,IAAI,CAAA;AACzC,EAAA,MAAM,UAAA,GAAa,EAAE,IAAA,EAAM,IAAA,EAAM,MAAM,QAAA,EAAS;AAChD,EAAA,MAAM,gBAAgB,YAAY;AAChC,IAAA,MAAM,SAAA,CAAU,IAAA,CAAK,EAAE,OAAA,EAAS,KAAQ,CAAA;AAAA,EAC1C,CAAA;AAEA,EAAA,MAAM,kBAAkB,UAAU,CAAA;AAElC,EAAA,OAAO,EAAE,YAAY,aAAA,EAAc;AACrC;AAEO,SAAS,2BACd,gBAAA,EAC4B;AAC5B,EAAA,IAAI;AACF,IAAA,MAAM;AAAA,MACJ,QAAA;AAAA,MACA,QAAA;AAAA,MACA,QAAA;AAAA,MACA,IAAA;AAAA,MACA,QAAA;AAAA,MACA,QAAA;AAAA,MACA;AAAA,KACF,GAAI,IAAI,GAAA,CAAI,gBAAgB,CAAA;AAE5B,IAAA,IAAI,aAAa,QAAA,EAAU;AACzB,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,iBAAA,EAAoB,QAAQ,CAAA,CAAE,CAAA;AAAA,IAChD,CAAA,MAAA,IAAW,CAAC,QAAA,IAAY,CAAC,QAAA,EAAU;AACjC,MAAA,MAAM,IAAI,MAAM,CAAA,yBAAA,CAA2B,CAAA;AAAA,IAC7C,CAAA,MAAA,IAAW,CAAC,QAAA,CAAS,KAAA,CAAM,WAAW,CAAA,EAAG;AACvC,MAAA,MAAM,IAAI,MAAM,CAAA,4BAAA,CAA8B,CAAA;AAAA,IAChD;AAEA,IAAA,MAAM,MAAA,GAAqC;AAAA,MACzC,IAAA,EAAM,QAAA;AAAA,MACN,QAAA;AAAA,MACA,IAAA,EAAM,QAAA;AAAA,MACN,IAAA,EAAM,MAAA,CAAO,IAAA,IAAQ,IAAI,CAAA;AAAA,MACzB,QAAA,EAAU,kBAAA,CAAmB,QAAA,CAAS,SAAA,CAAU,CAAC,CAAC;AAAA,KACpD;AAEA,IAAA,MAAM,GAAA,GAAM,YAAA,CAAa,GAAA,CAAI,KAAK,CAAA;AAClC,IAAA,IAAI,GAAA,EAAK;AACP,MAAA,MAAA,CAAO,GAAA,GAAM,GAAA;AAAA,IACf;AAEA,IAAA,MAAM,KAAA,GAAQ,YAAA,CAAa,GAAA,CAAI,OAAO,CAAA;AACtC,IAAA,IAAI,KAAA,EAAO;AACT,MAAA,MAAA,CAAO,KAAA,GAAQC,oBAAG,KAAK,CAAA;AAAA,IACzB;AAEA,IAAA,OAAO,MAAA;AAAA,EACT,SAAS,CAAA,EAAG;AACV,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,6CAAA,EAAgD,CAAC,IAAI,CAAC,CAAA;AAAA,EACxE;AACF;AAEO,MAAM,WAAA,CAA8B;AAAA,EACzC,aAAa,OACX,UAAA,EACsB;AACtB,IAAA,MAAM,EAAE,uCAAA,EAAyC,eAAA,EAAgB,GAC/D,UAAA;AAEF,IAAA,IAAI,uCAAA,EAAyC;AAC3C,MAAA,MAAM,gBAAA,GACJ,OAAA,CAAQ,GAAA,CAAI,uCAAuC,CAAA;AACrD,MAAA,IAAI,gBAAA,EAAkB;AACpB,QAAA,MAAM,UAAA,GAAa,2BAA2B,gBAAgB,CAAA;AAC9D,QAAA,OAAO,IAAI,WAAA;AAAA,UACT,UAAA;AAAA,UACA;AAAA,SACF;AAAA,MACF;AAAA,IACF;AAEA,IAAA,IAAI,eAAA,EAAiB;AACnB,MAAA,MAAM,EAAE,UAAA,EAAY,aAAA,EAAc,GAAI,MAAM,mBAAA;AAAA,QAC1C;AAAA,OACF;AACA,MAAA,OAAO,IAAI,WAAA,CAAY,UAAA,EAAY,UAAA,EAAY,aAAa,CAAA;AAAA,IAC9D;AAEA,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,mBAAA,EAAsB,UAAA,CAAW,IAAI,CAAA,eAAA,CAAiB,CAAA;AAAA,EACxE;AAAA,EAES,WAAA;AAAA,EACA,WAAA;AAAA,EACA,cAAA;AAAA,EACA,cAAA;AAAA,EACA,cAAA;AAAA,EAET,WAAA,CACE,UAAA,EACA,UAAA,EACA,aAAA,EACA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,UAAA;AACnB,IAAA,IAAA,CAAK,WAAA,GAAc,UAAA;AACnB,IAAA,IAAA,CAAK,iBAAiB,EAAC;AACvB,IAAA,IAAA,CAAK,iBAAiB,EAAC;AACvB,IAAA,IAAA,CAAK,cAAA,GAAiB,aAAA;AAAA,EACxB;AAAA,EAEA,MAAM,sBAAA,GAAwC;AAC5C,IAAA,MAAM,eAAA,GAAkB,KAAK,aAAA,EAAc;AAC3C,IAAA,IAAI;AACF,MAAA,MAAM,eAAe,CAAA,EAAA,EAAKC,kBAAA,CAAY,EAAE,CAAA,CAAE,QAAA,CAAS,KAAK,CAAC,CAAA,CAAA;AAEzD,MAAA,MAAM,eAAA,CAAgB,GAAA,CAAI,oBAAA,EAAsB,CAAC,YAAY,CAAC,CAAA;AAC9D,MAAA,IAAA,CAAK,cAAA,CAAe,KAAK,YAAY,CAAA;AAErC,MAAA,MAAM,eAAeJ,4BAAA,CAAY;AAAA,QAC/B,MAAA,EAAQ,KAAK,WAAA,CAAY,MAAA;AAAA,QACzB,UAAA,EAAY;AAAA,UACV,GAAG,IAAA,CAAK,WAAA;AAAA,UACR,QAAA,EAAU;AAAA,SACZ;AAAA,QACA,GAAGK;AAAA,OACJ,CAAA;AACD,MAAA,IAAA,CAAK,cAAA,CAAe,KAAK,YAAY,CAAA;AAErC,MAAA,OAAO,YAAA;AAAA,IACT,CAAA,SAAE;AACA,MAAA,MAAM,gBAAgB,OAAA,EAAQ;AAAA,IAChC;AAAA,EACF;AAAA,EAEA,MAAM,QAAA,GAA0B;AAC9B,IAAA,KAAA,MAAW,QAAA,IAAY,KAAK,cAAA,EAAgB;AAC1C,MAAA,MAAM,SAAS,OAAA,EAAQ;AAAA,IACzB;AAEA,IAAA,MAAM,eAAA,GAAkB,KAAK,aAAA,EAAc;AAC3C,IAAA,IAAI;AACF,MAAA,KAAA,MAAW,YAAA,IAAgB,KAAK,cAAA,EAAgB;AAC9C,QAAA,MAAM,eAAA,CAAgB,GAAA,CAAI,kBAAA,EAAoB,CAAC,YAAY,CAAC,CAAA;AAAA,MAC9D;AAAA,IACF,CAAA,SAAE;AACA,MAAA,MAAM,gBAAgB,OAAA,EAAQ;AAAA,IAChC;AAEA,IAAA,MAAM,KAAK,cAAA,IAAiB;AAAA,EAC9B;AAAA,EAEA,aAAA,GAAsB;AACpB,IAAA,MAAM,UAAA,GAAa;AAAA,MACjB,GAAG,IAAA,CAAK,WAAA;AAAA,MACR,QAAA,EAAU;AAAA,KACZ;AACA,IAAA,OAAOL,4BAAA,CAAY;AAAA,MACjB,MAAA,EAAQ,KAAK,WAAA,CAAY,MAAA;AAAA,MACzB,UAAA;AAAA,MACA,IAAA,EAAM;AAAA,QACJ,GAAA,EAAK,CAAA;AAAA,QACL,GAAA,EAAK,CAAA;AAAA,QACL,oBAAA,EAAsB,GAAA;AAAA,QACtB,mBAAA,EAAqB,GAAA;AAAA,QACrB,yBAAA,EAA2B;AAAA;AAC7B,KACD,CAAA;AAAA,EACH;AACF;;;;;;"}
+{"version":3,"file":"mysql.cjs.js","sources":["../../src/database/mysql.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { stringifyError } from '@backstage/errors';\nimport { randomBytes } from 'node:crypto';\nimport knexFactory, { Knex } from 'knex';\nimport { v4 as uuid } from 'uuid';\nimport yn from 'yn';\nimport { Engine, LARGER_POOL_CONFIG, TestDatabaseProperties } from './types';\n\nasync function waitForMysqlReady(\n  connection: Knex.MySqlConnectionConfig,\n): Promise<void> {\n  const startTime = Date.now();\n\n  let lastError: Error | undefined;\n  let attempts = 0;\n  for (;;) {\n    attempts += 1;\n\n    let knex: Knex | undefined;\n    try {\n      knex = knexFactory({\n        client: 'mysql2',\n        connection: {\n          // make a copy because the driver mutates this\n          ...connection,\n        },\n      });\n      const result = await knex.select(knex.raw('version() AS version'));\n      if (Array.isArray(result) && result[0]?.version) {\n        return;\n      }\n    } catch (e) {\n      lastError = e;\n    } finally {\n      await knex?.destroy();\n    }\n\n    if (Date.now() - startTime > 30_000) {\n      throw new Error(\n        `Timed out waiting for the database to be ready for connections, ${attempts} attempts, ${\n          lastError\n            ? `last error was ${stringifyError(lastError)}`\n            : '(no errors thrown)'\n        }`,\n      );\n    }\n\n    await new Promise(resolve => setTimeout(resolve, 100));\n  }\n}\n\nexport async function startMysqlContainer(image: string): Promise<{\n  connection: Knex.MySqlConnectionConfig;\n  stopContainer: () => Promise<void>;\n}> {\n  const user = 'root';\n  const password = uuid();\n\n  // Lazy-load to avoid side-effect of importing testcontainers\n  const { GenericContainer } =\n    require('testcontainers') as typeof import('testcontainers');\n\n  const container = await new GenericContainer(image)\n    .withExposedPorts(3306)\n    .withEnvironment({ MYSQL_ROOT_PASSWORD: password })\n    .withTmpFs({ '/var/lib/mysql': 'rw' })\n    .start();\n\n  const host = container.getHost();\n  const port = container.getMappedPort(3306);\n  const connection = { host, port, user, password };\n  const stopContainer = async () => {\n    await container.stop({ timeout: 10_000 });\n  };\n\n  await waitForMysqlReady(connection);\n\n  return { connection, stopContainer };\n}\n\nexport function parseMysqlConnectionString(\n  connectionString: string,\n): Knex.MySqlConnectionConfig {\n  try {\n    const {\n      protocol,\n      username,\n      password,\n      port,\n      hostname,\n      pathname,\n      searchParams,\n    } = new URL(connectionString);\n\n    if (protocol !== 'mysql:') {\n      throw new Error(`Unknown protocol ${protocol}`);\n    } else if (!username || !password) {\n      throw new Error(`Missing username/password`);\n    } else if (!pathname.match(/^\\/[^/]+$/)) {\n      throw new Error(`Expected single path segment`);\n    }\n\n    const result: Knex.MySqlConnectionConfig = {\n      user: username,\n      password,\n      host: hostname,\n      port: Number(port || 3306),\n      database: decodeURIComponent(pathname.substring(1)),\n    };\n\n    const ssl = searchParams.get('ssl');\n    if (ssl) {\n      result.ssl = ssl;\n    }\n\n    const debug = searchParams.get('debug');\n    if (debug) {\n      result.debug = yn(debug);\n    }\n\n    return result;\n  } catch (e) {\n    throw new Error(`Error while parsing MySQL connection string, ${e}`, e);\n  }\n}\n\nexport class MysqlEngine implements Engine {\n  static async create(\n    properties: TestDatabaseProperties,\n  ): Promise<MysqlEngine> {\n    const { connectionStringEnvironmentVariableName, dockerImageName } =\n      properties;\n\n    if (connectionStringEnvironmentVariableName) {\n      const connectionString =\n        process.env[connectionStringEnvironmentVariableName];\n      if (connectionString) {\n        const connection = parseMysqlConnectionString(connectionString);\n        return new MysqlEngine(\n          properties,\n          connection as Knex.MySqlConnectionConfig,\n        );\n      }\n    }\n\n    if (dockerImageName) {\n      const { connection, stopContainer } = await startMysqlContainer(\n        dockerImageName,\n      );\n      return new MysqlEngine(properties, connection, stopContainer);\n    }\n\n    throw new Error(`Test databasee for ${properties.name} not configured`);\n  }\n\n  readonly #properties: TestDatabaseProperties;\n  readonly #connection: Knex.MySqlConnectionConfig;\n  readonly #knexInstances: Knex[];\n  readonly #databaseNames: string[];\n  readonly #stopContainer?: () => Promise<void>;\n\n  constructor(\n    properties: TestDatabaseProperties,\n    connection: Knex.MySqlConnectionConfig,\n    stopContainer?: () => Promise<void>,\n  ) {\n    this.#properties = properties;\n    this.#connection = connection;\n    this.#knexInstances = [];\n    this.#databaseNames = [];\n    this.#stopContainer = stopContainer;\n  }\n\n  async createDatabaseInstance(): Promise<Knex> {\n    const adminConnection = this.#connectAdmin();\n    try {\n      const databaseName = `db${randomBytes(16).toString('hex')}`;\n\n      await adminConnection.raw('CREATE DATABASE ??', [databaseName]);\n      this.#databaseNames.push(databaseName);\n\n      const knexInstance = knexFactory({\n        client: this.#properties.driver,\n        connection: {\n          ...this.#connection,\n          database: databaseName,\n        },\n        ...LARGER_POOL_CONFIG,\n      });\n      this.#knexInstances.push(knexInstance);\n\n      return knexInstance;\n    } finally {\n      await adminConnection.destroy();\n    }\n  }\n\n  async shutdown(): Promise<void> {\n    for (const instance of this.#knexInstances) {\n      await instance.destroy();\n    }\n\n    const adminConnection = this.#connectAdmin();\n    try {\n      for (const databaseName of this.#databaseNames) {\n        await adminConnection.raw('DROP DATABASE ??', [databaseName]);\n      }\n    } finally {\n      await adminConnection.destroy();\n    }\n\n    await this.#stopContainer?.();\n  }\n\n  #connectAdmin(): Knex {\n    const connection = {\n      ...this.#connection,\n      database: null as unknown as string,\n    };\n    return knexFactory({\n      client: this.#properties.driver,\n      connection,\n      pool: {\n        min: 0,\n        max: 1,\n        acquireTimeoutMillis: 20_000,\n        createTimeoutMillis: 20_000,\n        createRetryIntervalMillis: 1_000,\n      },\n    });\n  }\n}\n"],"names":["knexFactory","stringifyError","uuid","yn","randomBytes","LARGER_POOL_CONFIG"],"mappings":";;;;;;;;;;;;;;AAuBA,eAAe,kBACb,UAAA,EACe;AACf,EAAA,MAAM,SAAA,GAAY,KAAK,GAAA,EAAI;AAE3B,EAAA,IAAI,SAAA;AACJ,EAAA,IAAI,QAAA,GAAW,CAAA;AACf,EAAA,WAAS;AACP,IAAA,QAAA,IAAY,CAAA;AAEZ,IAAA,IAAI,IAAA;AACJ,IAAA,IAAI;AACF,MAAA,IAAA,GAAOA,4BAAA,CAAY;AAAA,QACjB,MAAA,EAAQ,QAAA;AAAA,QACR,UAAA,EAAY;AAAA;AAAA,UAEV,GAAG;AAAA;AACL,OACD,CAAA;AACD,MAAA,MAAM,SAAS,MAAM,IAAA,CAAK,OAAO,IAAA,CAAK,GAAA,CAAI,sBAAsB,CAAC,CAAA;AACjE,MAAA,IAAI,MAAM,OAAA,CAAQ,MAAM,KAAK,MAAA,CAAO,CAAC,GAAG,OAAA,EAAS;AAC/C,QAAA;AAAA,MACF;AAAA,IACF,SAAS,CAAA,EAAG;AACV,MAAA,SAAA,GAAY,CAAA;AAAA,IACd,CAAA,SAAE;AACA,MAAA,MAAM,MAAM,OAAA,EAAQ;AAAA,IACtB;AAEA,IAAA,IAAI,IAAA,CAAK,GAAA,EAAI,GAAI,SAAA,GAAY,GAAA,EAAQ;AACnC,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gEAAA,EAAmE,QAAQ,CAAA,WAAA,EACzE,SAAA,GACI,kBAAkBC,qBAAA,CAAe,SAAS,CAAC,CAAA,CAAA,GAC3C,oBACN,CAAA;AAAA,OACF;AAAA,IACF;AAEA,IAAA,MAAM,IAAI,OAAA,CAAQ,CAAA,OAAA,KAAW,UAAA,CAAW,OAAA,EAAS,GAAG,CAAC,CAAA;AAAA,EACvD;AACF;AAEA,eAAsB,oBAAoB,KAAA,EAGvC;AACD,EAAA,MAAM,IAAA,GAAO,MAAA;AACb,EAAA,MAAM,WAAWC,OAAA,EAAK;AAGtB,EAAA,MAAM,EAAE,gBAAA,EAAiB,GACvB,OAAA,CAAQ,gBAAgB,CAAA;AAE1B,EAAA,MAAM,SAAA,GAAY,MAAM,IAAI,gBAAA,CAAiB,KAAK,CAAA,CAC/C,gBAAA,CAAiB,IAAI,CAAA,CACrB,eAAA,CAAgB,EAAE,mBAAA,EAAqB,QAAA,EAAU,CAAA,CACjD,SAAA,CAAU,EAAE,gBAAA,EAAkB,IAAA,EAAM,CAAA,CACpC,KAAA,EAAM;AAET,EAAA,MAAM,IAAA,GAAO,UAAU,OAAA,EAAQ;AAC/B,EAAA,MAAM,IAAA,GAAO,SAAA,CAAU,aAAA,CAAc,IAAI,CAAA;AACzC,EAAA,MAAM,UAAA,GAAa,EAAE,IAAA,EAAM,IAAA,EAAM,MAAM,QAAA,EAAS;AAChD,EAAA,MAAM,gBAAgB,YAAY;AAChC,IAAA,MAAM,SAAA,CAAU,IAAA,CAAK,EAAE,OAAA,EAAS,KAAQ,CAAA;AAAA,EAC1C,CAAA;AAEA,EAAA,MAAM,kBAAkB,UAAU,CAAA;AAElC,EAAA,OAAO,EAAE,YAAY,aAAA,EAAc;AACrC;AAEO,SAAS,2BACd,gBAAA,EAC4B;AAC5B,EAAA,IAAI;AACF,IAAA,MAAM;AAAA,MACJ,QAAA;AAAA,MACA,QAAA;AAAA,MACA,QAAA;AAAA,MACA,IAAA;AAAA,MACA,QAAA;AAAA,MACA,QAAA;AAAA,MACA;AAAA,KACF,GAAI,IAAI,GAAA,CAAI,gBAAgB,CAAA;AAE5B,IAAA,IAAI,aAAa,QAAA,EAAU;AACzB,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,iBAAA,EAAoB,QAAQ,CAAA,CAAE,CAAA;AAAA,IAChD,CAAA,MAAA,IAAW,CAAC,QAAA,IAAY,CAAC,QAAA,EAAU;AACjC,MAAA,MAAM,IAAI,MAAM,CAAA,yBAAA,CAA2B,CAAA;AAAA,IAC7C,CAAA,MAAA,IAAW,CAAC,QAAA,CAAS,KAAA,CAAM,WAAW,CAAA,EAAG;AACvC,MAAA,MAAM,IAAI,MAAM,CAAA,4BAAA,CAA8B,CAAA;AAAA,IAChD;AAEA,IAAA,MAAM,MAAA,GAAqC;AAAA,MACzC,IAAA,EAAM,QAAA;AAAA,MACN,QAAA;AAAA,MACA,IAAA,EAAM,QAAA;AAAA,MACN,IAAA,EAAM,MAAA,CAAO,IAAA,IAAQ,IAAI,CAAA;AAAA,MACzB,QAAA,EAAU,kBAAA,CAAmB,QAAA,CAAS,SAAA,CAAU,CAAC,CAAC;AAAA,KACpD;AAEA,IAAA,MAAM,GAAA,GAAM,YAAA,CAAa,GAAA,CAAI,KAAK,CAAA;AAClC,IAAA,IAAI,GAAA,EAAK;AACP,MAAA,MAAA,CAAO,GAAA,GAAM,GAAA;AAAA,IACf;AAEA,IAAA,MAAM,KAAA,GAAQ,YAAA,CAAa,GAAA,CAAI,OAAO,CAAA;AACtC,IAAA,IAAI,KAAA,EAAO;AACT,MAAA,MAAA,CAAO,KAAA,GAAQC,oBAAG,KAAK,CAAA;AAAA,IACzB;AAEA,IAAA,OAAO,MAAA;AAAA,EACT,SAAS,CAAA,EAAG;AACV,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,6CAAA,EAAgD,CAAC,IAAI,CAAC,CAAA;AAAA,EACxE;AACF;AAEO,MAAM,WAAA,CAA8B;AAAA,EACzC,aAAa,OACX,UAAA,EACsB;AACtB,IAAA,MAAM,EAAE,uCAAA,EAAyC,eAAA,EAAgB,GAC/D,UAAA;AAEF,IAAA,IAAI,uCAAA,EAAyC;AAC3C,MAAA,MAAM,gBAAA,GACJ,OAAA,CAAQ,GAAA,CAAI,uCAAuC,CAAA;AACrD,MAAA,IAAI,gBAAA,EAAkB;AACpB,QAAA,MAAM,UAAA,GAAa,2BAA2B,gBAAgB,CAAA;AAC9D,QAAA,OAAO,IAAI,WAAA;AAAA,UACT,UAAA;AAAA,UACA;AAAA,SACF;AAAA,MACF;AAAA,IACF;AAEA,IAAA,IAAI,eAAA,EAAiB;AACnB,MAAA,MAAM,EAAE,UAAA,EAAY,aAAA,EAAc,GAAI,MAAM,mBAAA;AAAA,QAC1C;AAAA,OACF;AACA,MAAA,OAAO,IAAI,WAAA,CAAY,UAAA,EAAY,UAAA,EAAY,aAAa,CAAA;AAAA,IAC9D;AAEA,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,mBAAA,EAAsB,UAAA,CAAW,IAAI,CAAA,eAAA,CAAiB,CAAA;AAAA,EACxE;AAAA,EAES,WAAA;AAAA,EACA,WAAA;AAAA,EACA,cAAA;AAAA,EACA,cAAA;AAAA,EACA,cAAA;AAAA,EAET,WAAA,CACE,UAAA,EACA,UAAA,EACA,aAAA,EACA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,UAAA;AACnB,IAAA,IAAA,CAAK,WAAA,GAAc,UAAA;AACnB,IAAA,IAAA,CAAK,iBAAiB,EAAC;AACvB,IAAA,IAAA,CAAK,iBAAiB,EAAC;AACvB,IAAA,IAAA,CAAK,cAAA,GAAiB,aAAA;AAAA,EACxB;AAAA,EAEA,MAAM,sBAAA,GAAwC;AAC5C,IAAA,MAAM,eAAA,GAAkB,KAAK,aAAA,EAAc;AAC3C,IAAA,IAAI;AACF,MAAA,MAAM,eAAe,CAAA,EAAA,EAAKC,uBAAA,CAAY,EAAE,CAAA,CAAE,QAAA,CAAS,KAAK,CAAC,CAAA,CAAA;AAEzD,MAAA,MAAM,eAAA,CAAgB,GAAA,CAAI,oBAAA,EAAsB,CAAC,YAAY,CAAC,CAAA;AAC9D,MAAA,IAAA,CAAK,cAAA,CAAe,KAAK,YAAY,CAAA;AAErC,MAAA,MAAM,eAAeJ,4BAAA,CAAY;AAAA,QAC/B,MAAA,EAAQ,KAAK,WAAA,CAAY,MAAA;AAAA,QACzB,UAAA,EAAY;AAAA,UACV,GAAG,IAAA,CAAK,WAAA;AAAA,UACR,QAAA,EAAU;AAAA,SACZ;AAAA,QACA,GAAGK;AAAA,OACJ,CAAA;AACD,MAAA,IAAA,CAAK,cAAA,CAAe,KAAK,YAAY,CAAA;AAErC,MAAA,OAAO,YAAA;AAAA,IACT,CAAA,SAAE;AACA,MAAA,MAAM,gBAAgB,OAAA,EAAQ;AAAA,IAChC;AAAA,EACF;AAAA,EAEA,MAAM,QAAA,GAA0B;AAC9B,IAAA,KAAA,MAAW,QAAA,IAAY,KAAK,cAAA,EAAgB;AAC1C,MAAA,MAAM,SAAS,OAAA,EAAQ;AAAA,IACzB;AAEA,IAAA,MAAM,eAAA,GAAkB,KAAK,aAAA,EAAc;AAC3C,IAAA,IAAI;AACF,MAAA,KAAA,MAAW,YAAA,IAAgB,KAAK,cAAA,EAAgB;AAC9C,QAAA,MAAM,eAAA,CAAgB,GAAA,CAAI,kBAAA,EAAoB,CAAC,YAAY,CAAC,CAAA;AAAA,MAC9D;AAAA,IACF,CAAA,SAAE;AACA,MAAA,MAAM,gBAAgB,OAAA,EAAQ;AAAA,IAChC;AAEA,IAAA,MAAM,KAAK,cAAA,IAAiB;AAAA,EAC9B;AAAA,EAEA,aAAA,GAAsB;AACpB,IAAA,MAAM,UAAA,GAAa;AAAA,MACjB,GAAG,IAAA,CAAK,WAAA;AAAA,MACR,QAAA,EAAU;AAAA,KACZ;AACA,IAAA,OAAOL,4BAAA,CAAY;AAAA,MACjB,MAAA,EAAQ,KAAK,WAAA,CAAY,MAAA;AAAA,MACzB,UAAA;AAAA,MACA,IAAA,EAAM;AAAA,QACJ,GAAA,EAAK,CAAA;AAAA,QACL,GAAA,EAAK,CAAA;AAAA,QACL,oBAAA,EAAsB,GAAA;AAAA,QACtB,mBAAA,EAAqB,GAAA;AAAA,QACrB,yBAAA,EAA2B;AAAA;AAC7B,KACD,CAAA;AAAA,EACH;AACF;;;;;;"}

package/dist/database/postgres.cjs.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var errors = require('@backstage/errors');
-var crypto = require('crypto');
+var node_crypto = require('node:crypto');
 var knexFactory = require('knex');
 var pgConnectionString = require('pg-connection-string');
 var uuid = require('uuid');
@@ -97,7 +97,7 @@ class PostgresEngine {
   async createDatabaseInstance() {
     const adminConnection = this.#connectAdmin();
     try {
-      const databaseName = `db${crypto.randomBytes(16).toString("hex")}`;
+      const databaseName = `db${node_crypto.randomBytes(16).toString("hex")}`;
       await adminConnection.raw("CREATE DATABASE ??", [databaseName]);
       this.#databaseNames.push(databaseName);
       const knexInstance = knexFactory__default.default({

package/dist/database/postgres.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"postgres.cjs.js","sources":["../../src/database/postgres.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { stringifyError } from '@backstage/errors';\nimport { randomBytes } from 'crypto';\nimport knexFactory, { Knex } from 'knex';\nimport { parse as parsePgConnectionString } from 'pg-connection-string';\nimport { v4 as uuid } from 'uuid';\nimport { Engine, LARGER_POOL_CONFIG, TestDatabaseProperties } from './types';\n\nasync function waitForPostgresReady(\n  connection: Knex.PgConnectionConfig,\n): Promise<void> {\n  const startTime = Date.now();\n\n  let lastError: Error | undefined;\n  let attempts = 0;\n  for (;;) {\n    attempts += 1;\n\n    let knex: Knex | undefined;\n    try {\n      knex = knexFactory({\n        client: 'pg',\n        connection: {\n          // make a copy because the driver mutates this\n          ...connection,\n        },\n      });\n      const result = await knex.select(knex.raw('version()'));\n      if (Array.isArray(result) && result[0]?.version) {\n        return;\n      }\n    } catch (e) {\n      lastError = e;\n    } finally {\n      await knex?.destroy();\n    }\n\n    if (Date.now() - startTime > 30_000) {\n      throw new Error(\n        `Timed out waiting for the database to be ready for connections, ${attempts} attempts, ${\n          lastError\n            ? `last error was ${stringifyError(lastError)}`\n            : '(no errors thrown)'\n        }`,\n      );\n    }\n\n    await new Promise(resolve => setTimeout(resolve, 100));\n  }\n}\n\nexport async function startPostgresContainer(image: string): Promise<{\n  connection: Knex.PgConnectionConfig;\n  stopContainer: () => Promise<void>;\n}> {\n  const user = 'postgres';\n  const password = uuid();\n\n  // Lazy-load to avoid side-effect of importing testcontainers\n  const { GenericContainer } =\n    require('testcontainers') as typeof import('testcontainers');\n\n  const container = await new GenericContainer(image)\n    .withExposedPorts(5432)\n    .withEnvironment({\n      // Since postgres 18, the default directory changed - so we pin it here\n      PGDATA: '/var/lib/postgresql/data',\n      POSTGRES_PASSWORD: password,\n    })\n    .withTmpFs({ '/var/lib/postgresql/data': 'rw' })\n    .start();\n\n  const host = container.getHost();\n  const port = container.getMappedPort(5432);\n  const connection = { host, port, user, password };\n  const stopContainer = async () => {\n    await container.stop({ timeout: 10_000 });\n  };\n\n  await waitForPostgresReady(connection);\n\n  return { connection, stopContainer };\n}\n\nexport class PostgresEngine implements Engine {\n  static async create(\n    properties: TestDatabaseProperties,\n  ): Promise<PostgresEngine> {\n    const { connectionStringEnvironmentVariableName, dockerImageName } =\n      properties;\n\n    if (connectionStringEnvironmentVariableName) {\n      const connectionString =\n        process.env[connectionStringEnvironmentVariableName];\n      if (connectionString) {\n        const connection = parsePgConnectionString(connectionString);\n        return new PostgresEngine(\n          properties,\n          connection as Knex.PgConnectionConfig,\n        );\n      }\n    }\n\n    if (dockerImageName) {\n      const { connection, stopContainer } = await startPostgresContainer(\n        dockerImageName,\n      );\n      return new PostgresEngine(properties, connection, stopContainer);\n    }\n\n    throw new Error(`Test databasee for ${properties.name} not configured`);\n  }\n\n  readonly #properties: TestDatabaseProperties;\n  readonly #connection: Knex.PgConnectionConfig;\n  readonly #knexInstances: Knex[];\n  readonly #databaseNames: string[];\n  readonly #stopContainer?: () => Promise<void>;\n\n  constructor(\n    properties: TestDatabaseProperties,\n    connection: Knex.PgConnectionConfig,\n    stopContainer?: () => Promise<void>,\n  ) {\n    this.#properties = properties;\n    this.#connection = connection;\n    this.#knexInstances = [];\n    this.#databaseNames = [];\n    this.#stopContainer = stopContainer;\n  }\n\n  async createDatabaseInstance(): Promise<Knex> {\n    const adminConnection = this.#connectAdmin();\n    try {\n      const databaseName = `db${randomBytes(16).toString('hex')}`;\n\n      await adminConnection.raw('CREATE DATABASE ??', [databaseName]);\n      this.#databaseNames.push(databaseName);\n\n      const knexInstance = knexFactory({\n        client: this.#properties.driver,\n        connection: {\n          ...this.#connection,\n          database: databaseName,\n        },\n        ...LARGER_POOL_CONFIG,\n      });\n      this.#knexInstances.push(knexInstance);\n\n      return knexInstance;\n    } finally {\n      await adminConnection.destroy();\n    }\n  }\n\n  async shutdown(): Promise<void> {\n    for (const instance of this.#knexInstances) {\n      await instance.destroy();\n    }\n\n    const adminConnection = this.#connectAdmin();\n    try {\n      for (const databaseName of this.#databaseNames) {\n        await adminConnection.raw('DROP DATABASE ??', [databaseName]);\n      }\n    } finally {\n      await adminConnection.destroy();\n    }\n\n    await this.#stopContainer?.();\n  }\n\n  #connectAdmin(): Knex {\n    return knexFactory({\n      client: this.#properties.driver,\n      connection: {\n        ...this.#connection,\n        database: 'postgres',\n      },\n      pool: {\n        acquireTimeoutMillis: 10000,\n      },\n    });\n  }\n}\n"],"names":["knexFactory","stringifyError","uuid","parsePgConnectionString","randomBytes","LARGER_POOL_CONFIG"],"mappings":";;;;;;;;;;;;;AAuBA,eAAe,qBACb,UAAA,EACe;AACf,EAAA,MAAM,SAAA,GAAY,KAAK,GAAA,EAAI;AAE3B,EAAA,IAAI,SAAA;AACJ,EAAA,IAAI,QAAA,GAAW,CAAA;AACf,EAAA,WAAS;AACP,IAAA,QAAA,IAAY,CAAA;AAEZ,IAAA,IAAI,IAAA;AACJ,IAAA,IAAI;AACF,MAAA,IAAA,GAAOA,4BAAA,CAAY;AAAA,QACjB,MAAA,EAAQ,IAAA;AAAA,QACR,UAAA,EAAY;AAAA;AAAA,UAEV,GAAG;AAAA;AACL,OACD,CAAA;AACD,MAAA,MAAM,SAAS,MAAM,IAAA,CAAK,OAAO,IAAA,CAAK,GAAA,CAAI,WAAW,CAAC,CAAA;AACtD,MAAA,IAAI,MAAM,OAAA,CAAQ,MAAM,KAAK,MAAA,CAAO,CAAC,GAAG,OAAA,EAAS;AAC/C,QAAA;AAAA,MACF;AAAA,IACF,SAAS,CAAA,EAAG;AACV,MAAA,SAAA,GAAY,CAAA;AAAA,IACd,CAAA,SAAE;AACA,MAAA,MAAM,MAAM,OAAA,EAAQ;AAAA,IACtB;AAEA,IAAA,IAAI,IAAA,CAAK,GAAA,EAAI,GAAI,SAAA,GAAY,GAAA,EAAQ;AACnC,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gEAAA,EAAmE,QAAQ,CAAA,WAAA,EACzE,SAAA,GACI,kBAAkBC,qBAAA,CAAe,SAAS,CAAC,CAAA,CAAA,GAC3C,oBACN,CAAA;AAAA,OACF;AAAA,IACF;AAEA,IAAA,MAAM,IAAI,OAAA,CAAQ,CAAA,OAAA,KAAW,UAAA,CAAW,OAAA,EAAS,GAAG,CAAC,CAAA;AAAA,EACvD;AACF;AAEA,eAAsB,uBAAuB,KAAA,EAG1C;AACD,EAAA,MAAM,IAAA,GAAO,UAAA;AACb,EAAA,MAAM,WAAWC,OAAA,EAAK;AAGtB,EAAA,MAAM,EAAE,gBAAA,EAAiB,GACvB,OAAA,CAAQ,gBAAgB,CAAA;AAE1B,EAAA,MAAM,SAAA,GAAY,MAAM,IAAI,gBAAA,CAAiB,KAAK,CAAA,CAC/C,gBAAA,CAAiB,IAAI,CAAA,CACrB,eAAA,CAAgB;AAAA;AAAA,IAEf,MAAA,EAAQ,0BAAA;AAAA,IACR,iBAAA,EAAmB;AAAA,GACpB,EACA,SAAA,CAAU,EAAE,4BAA4B,IAAA,EAAM,EAC9C,KAAA,EAAM;AAET,EAAA,MAAM,IAAA,GAAO,UAAU,OAAA,EAAQ;AAC/B,EAAA,MAAM,IAAA,GAAO,SAAA,CAAU,aAAA,CAAc,IAAI,CAAA;AACzC,EAAA,MAAM,UAAA,GAAa,EAAE,IAAA,EAAM,IAAA,EAAM,MAAM,QAAA,EAAS;AAChD,EAAA,MAAM,gBAAgB,YAAY;AAChC,IAAA,MAAM,SAAA,CAAU,IAAA,CAAK,EAAE,OAAA,EAAS,KAAQ,CAAA;AAAA,EAC1C,CAAA;AAEA,EAAA,MAAM,qBAAqB,UAAU,CAAA;AAErC,EAAA,OAAO,EAAE,YAAY,aAAA,EAAc;AACrC;AAEO,MAAM,cAAA,CAAiC;AAAA,EAC5C,aAAa,OACX,UAAA,EACyB;AACzB,IAAA,MAAM,EAAE,uCAAA,EAAyC,eAAA,EAAgB,GAC/D,UAAA;AAEF,IAAA,IAAI,uCAAA,EAAyC;AAC3C,MAAA,MAAM,gBAAA,GACJ,OAAA,CAAQ,GAAA,CAAI,uCAAuC,CAAA;AACrD,MAAA,IAAI,gBAAA,EAAkB;AACpB,QAAA,MAAM,UAAA,GAAaC,yBAAwB,gBAAgB,CAAA;AAC3D,QAAA,OAAO,IAAI,cAAA;AAAA,UACT,UAAA;AAAA,UACA;AAAA,SACF;AAAA,MACF;AAAA,IACF;AAEA,IAAA,IAAI,eAAA,EAAiB;AACnB,MAAA,MAAM,EAAE,UAAA,EAAY,aAAA,EAAc,GAAI,MAAM,sBAAA;AAAA,QAC1C;AAAA,OACF;AACA,MAAA,OAAO,IAAI,cAAA,CAAe,UAAA,EAAY,UAAA,EAAY,aAAa,CAAA;AAAA,IACjE;AAEA,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,mBAAA,EAAsB,UAAA,CAAW,IAAI,CAAA,eAAA,CAAiB,CAAA;AAAA,EACxE;AAAA,EAES,WAAA;AAAA,EACA,WAAA;AAAA,EACA,cAAA;AAAA,EACA,cAAA;AAAA,EACA,cAAA;AAAA,EAET,WAAA,CACE,UAAA,EACA,UAAA,EACA,aAAA,EACA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,UAAA;AACnB,IAAA,IAAA,CAAK,WAAA,GAAc,UAAA;AACnB,IAAA,IAAA,CAAK,iBAAiB,EAAC;AACvB,IAAA,IAAA,CAAK,iBAAiB,EAAC;AACvB,IAAA,IAAA,CAAK,cAAA,GAAiB,aAAA;AAAA,EACxB;AAAA,EAEA,MAAM,sBAAA,GAAwC;AAC5C,IAAA,MAAM,eAAA,GAAkB,KAAK,aAAA,EAAc;AAC3C,IAAA,IAAI;AACF,MAAA,MAAM,eAAe,CAAA,EAAA,EAAKC,kBAAA,CAAY,EAAE,CAAA,CAAE,QAAA,CAAS,KAAK,CAAC,CAAA,CAAA;AAEzD,MAAA,MAAM,eAAA,CAAgB,GAAA,CAAI,oBAAA,EAAsB,CAAC,YAAY,CAAC,CAAA;AAC9D,MAAA,IAAA,CAAK,cAAA,CAAe,KAAK,YAAY,CAAA;AAErC,MAAA,MAAM,eAAeJ,4BAAA,CAAY;AAAA,QAC/B,MAAA,EAAQ,KAAK,WAAA,CAAY,MAAA;AAAA,QACzB,UAAA,EAAY;AAAA,UACV,GAAG,IAAA,CAAK,WAAA;AAAA,UACR,QAAA,EAAU;AAAA,SACZ;AAAA,QACA,GAAGK;AAAA,OACJ,CAAA;AACD,MAAA,IAAA,CAAK,cAAA,CAAe,KAAK,YAAY,CAAA;AAErC,MAAA,OAAO,YAAA;AAAA,IACT,CAAA,SAAE;AACA,MAAA,MAAM,gBAAgB,OAAA,EAAQ;AAAA,IAChC;AAAA,EACF;AAAA,EAEA,MAAM,QAAA,GAA0B;AAC9B,IAAA,KAAA,MAAW,QAAA,IAAY,KAAK,cAAA,EAAgB;AAC1C,MAAA,MAAM,SAAS,OAAA,EAAQ;AAAA,IACzB;AAEA,IAAA,MAAM,eAAA,GAAkB,KAAK,aAAA,EAAc;AAC3C,IAAA,IAAI;AACF,MAAA,KAAA,MAAW,YAAA,IAAgB,KAAK,cAAA,EAAgB;AAC9C,QAAA,MAAM,eAAA,CAAgB,GAAA,CAAI,kBAAA,EAAoB,CAAC,YAAY,CAAC,CAAA;AAAA,MAC9D;AAAA,IACF,CAAA,SAAE;AACA,MAAA,MAAM,gBAAgB,OAAA,EAAQ;AAAA,IAChC;AAEA,IAAA,MAAM,KAAK,cAAA,IAAiB;AAAA,EAC9B;AAAA,EAEA,aAAA,GAAsB;AACpB,IAAA,OAAOL,4BAAA,CAAY;AAAA,MACjB,MAAA,EAAQ,KAAK,WAAA,CAAY,MAAA;AAAA,MACzB,UAAA,EAAY;AAAA,QACV,GAAG,IAAA,CAAK,WAAA;AAAA,QACR,QAAA,EAAU;AAAA,OACZ;AAAA,MACA,IAAA,EAAM;AAAA,QACJ,oBAAA,EAAsB;AAAA;AACxB,KACD,CAAA;AAAA,EACH;AACF;;;;;"}
+{"version":3,"file":"postgres.cjs.js","sources":["../../src/database/postgres.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { stringifyError } from '@backstage/errors';\nimport { randomBytes } from 'node:crypto';\nimport knexFactory, { Knex } from 'knex';\nimport { parse as parsePgConnectionString } from 'pg-connection-string';\nimport { v4 as uuid } from 'uuid';\nimport { Engine, LARGER_POOL_CONFIG, TestDatabaseProperties } from './types';\n\nasync function waitForPostgresReady(\n  connection: Knex.PgConnectionConfig,\n): Promise<void> {\n  const startTime = Date.now();\n\n  let lastError: Error | undefined;\n  let attempts = 0;\n  for (;;) {\n    attempts += 1;\n\n    let knex: Knex | undefined;\n    try {\n      knex = knexFactory({\n        client: 'pg',\n        connection: {\n          // make a copy because the driver mutates this\n          ...connection,\n        },\n      });\n      const result = await knex.select(knex.raw('version()'));\n      if (Array.isArray(result) && result[0]?.version) {\n        return;\n      }\n    } catch (e) {\n      lastError = e;\n    } finally {\n      await knex?.destroy();\n    }\n\n    if (Date.now() - startTime > 30_000) {\n      throw new Error(\n        `Timed out waiting for the database to be ready for connections, ${attempts} attempts, ${\n          lastError\n            ? `last error was ${stringifyError(lastError)}`\n            : '(no errors thrown)'\n        }`,\n      );\n    }\n\n    await new Promise(resolve => setTimeout(resolve, 100));\n  }\n}\n\nexport async function startPostgresContainer(image: string): Promise<{\n  connection: Knex.PgConnectionConfig;\n  stopContainer: () => Promise<void>;\n}> {\n  const user = 'postgres';\n  const password = uuid();\n\n  // Lazy-load to avoid side-effect of importing testcontainers\n  const { GenericContainer } =\n    require('testcontainers') as typeof import('testcontainers');\n\n  const container = await new GenericContainer(image)\n    .withExposedPorts(5432)\n    .withEnvironment({\n      // Since postgres 18, the default directory changed - so we pin it here\n      PGDATA: '/var/lib/postgresql/data',\n      POSTGRES_PASSWORD: password,\n    })\n    .withTmpFs({ '/var/lib/postgresql/data': 'rw' })\n    .start();\n\n  const host = container.getHost();\n  const port = container.getMappedPort(5432);\n  const connection = { host, port, user, password };\n  const stopContainer = async () => {\n    await container.stop({ timeout: 10_000 });\n  };\n\n  await waitForPostgresReady(connection);\n\n  return { connection, stopContainer };\n}\n\nexport class PostgresEngine implements Engine {\n  static async create(\n    properties: TestDatabaseProperties,\n  ): Promise<PostgresEngine> {\n    const { connectionStringEnvironmentVariableName, dockerImageName } =\n      properties;\n\n    if (connectionStringEnvironmentVariableName) {\n      const connectionString =\n        process.env[connectionStringEnvironmentVariableName];\n      if (connectionString) {\n        const connection = parsePgConnectionString(connectionString);\n        return new PostgresEngine(\n          properties,\n          connection as Knex.PgConnectionConfig,\n        );\n      }\n    }\n\n    if (dockerImageName) {\n      const { connection, stopContainer } = await startPostgresContainer(\n        dockerImageName,\n      );\n      return new PostgresEngine(properties, connection, stopContainer);\n    }\n\n    throw new Error(`Test databasee for ${properties.name} not configured`);\n  }\n\n  readonly #properties: TestDatabaseProperties;\n  readonly #connection: Knex.PgConnectionConfig;\n  readonly #knexInstances: Knex[];\n  readonly #databaseNames: string[];\n  readonly #stopContainer?: () => Promise<void>;\n\n  constructor(\n    properties: TestDatabaseProperties,\n    connection: Knex.PgConnectionConfig,\n    stopContainer?: () => Promise<void>,\n  ) {\n    this.#properties = properties;\n    this.#connection = connection;\n    this.#knexInstances = [];\n    this.#databaseNames = [];\n    this.#stopContainer = stopContainer;\n  }\n\n  async createDatabaseInstance(): Promise<Knex> {\n    const adminConnection = this.#connectAdmin();\n    try {\n      const databaseName = `db${randomBytes(16).toString('hex')}`;\n\n      await adminConnection.raw('CREATE DATABASE ??', [databaseName]);\n      this.#databaseNames.push(databaseName);\n\n      const knexInstance = knexFactory({\n        client: this.#properties.driver,\n        connection: {\n          ...this.#connection,\n          database: databaseName,\n        },\n        ...LARGER_POOL_CONFIG,\n      });\n      this.#knexInstances.push(knexInstance);\n\n      return knexInstance;\n    } finally {\n      await adminConnection.destroy();\n    }\n  }\n\n  async shutdown(): Promise<void> {\n    for (const instance of this.#knexInstances) {\n      await instance.destroy();\n    }\n\n    const adminConnection = this.#connectAdmin();\n    try {\n      for (const databaseName of this.#databaseNames) {\n        await adminConnection.raw('DROP DATABASE ??', [databaseName]);\n      }\n    } finally {\n      await adminConnection.destroy();\n    }\n\n    await this.#stopContainer?.();\n  }\n\n  #connectAdmin(): Knex {\n    return knexFactory({\n      client: this.#properties.driver,\n      connection: {\n        ...this.#connection,\n        database: 'postgres',\n      },\n      pool: {\n        acquireTimeoutMillis: 10000,\n      },\n    });\n  }\n}\n"],"names":["knexFactory","stringifyError","uuid","parsePgConnectionString","randomBytes","LARGER_POOL_CONFIG"],"mappings":";;;;;;;;;;;;;AAuBA,eAAe,qBACb,UAAA,EACe;AACf,EAAA,MAAM,SAAA,GAAY,KAAK,GAAA,EAAI;AAE3B,EAAA,IAAI,SAAA;AACJ,EAAA,IAAI,QAAA,GAAW,CAAA;AACf,EAAA,WAAS;AACP,IAAA,QAAA,IAAY,CAAA;AAEZ,IAAA,IAAI,IAAA;AACJ,IAAA,IAAI;AACF,MAAA,IAAA,GAAOA,4BAAA,CAAY;AAAA,QACjB,MAAA,EAAQ,IAAA;AAAA,QACR,UAAA,EAAY;AAAA;AAAA,UAEV,GAAG;AAAA;AACL,OACD,CAAA;AACD,MAAA,MAAM,SAAS,MAAM,IAAA,CAAK,OAAO,IAAA,CAAK,GAAA,CAAI,WAAW,CAAC,CAAA;AACtD,MAAA,IAAI,MAAM,OAAA,CAAQ,MAAM,KAAK,MAAA,CAAO,CAAC,GAAG,OAAA,EAAS;AAC/C,QAAA;AAAA,MACF;AAAA,IACF,SAAS,CAAA,EAAG;AACV,MAAA,SAAA,GAAY,CAAA;AAAA,IACd,CAAA,SAAE;AACA,MAAA,MAAM,MAAM,OAAA,EAAQ;AAAA,IACtB;AAEA,IAAA,IAAI,IAAA,CAAK,GAAA,EAAI,GAAI,SAAA,GAAY,GAAA,EAAQ;AACnC,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gEAAA,EAAmE,QAAQ,CAAA,WAAA,EACzE,SAAA,GACI,kBAAkBC,qBAAA,CAAe,SAAS,CAAC,CAAA,CAAA,GAC3C,oBACN,CAAA;AAAA,OACF;AAAA,IACF;AAEA,IAAA,MAAM,IAAI,OAAA,CAAQ,CAAA,OAAA,KAAW,UAAA,CAAW,OAAA,EAAS,GAAG,CAAC,CAAA;AAAA,EACvD;AACF;AAEA,eAAsB,uBAAuB,KAAA,EAG1C;AACD,EAAA,MAAM,IAAA,GAAO,UAAA;AACb,EAAA,MAAM,WAAWC,OAAA,EAAK;AAGtB,EAAA,MAAM,EAAE,gBAAA,EAAiB,GACvB,OAAA,CAAQ,gBAAgB,CAAA;AAE1B,EAAA,MAAM,SAAA,GAAY,MAAM,IAAI,gBAAA,CAAiB,KAAK,CAAA,CAC/C,gBAAA,CAAiB,IAAI,CAAA,CACrB,eAAA,CAAgB;AAAA;AAAA,IAEf,MAAA,EAAQ,0BAAA;AAAA,IACR,iBAAA,EAAmB;AAAA,GACpB,EACA,SAAA,CAAU,EAAE,4BAA4B,IAAA,EAAM,EAC9C,KAAA,EAAM;AAET,EAAA,MAAM,IAAA,GAAO,UAAU,OAAA,EAAQ;AAC/B,EAAA,MAAM,IAAA,GAAO,SAAA,CAAU,aAAA,CAAc,IAAI,CAAA;AACzC,EAAA,MAAM,UAAA,GAAa,EAAE,IAAA,EAAM,IAAA,EAAM,MAAM,QAAA,EAAS;AAChD,EAAA,MAAM,gBAAgB,YAAY;AAChC,IAAA,MAAM,SAAA,CAAU,IAAA,CAAK,EAAE,OAAA,EAAS,KAAQ,CAAA;AAAA,EAC1C,CAAA;AAEA,EAAA,MAAM,qBAAqB,UAAU,CAAA;AAErC,EAAA,OAAO,EAAE,YAAY,aAAA,EAAc;AACrC;AAEO,MAAM,cAAA,CAAiC;AAAA,EAC5C,aAAa,OACX,UAAA,EACyB;AACzB,IAAA,MAAM,EAAE,uCAAA,EAAyC,eAAA,EAAgB,GAC/D,UAAA;AAEF,IAAA,IAAI,uCAAA,EAAyC;AAC3C,MAAA,MAAM,gBAAA,GACJ,OAAA,CAAQ,GAAA,CAAI,uCAAuC,CAAA;AACrD,MAAA,IAAI,gBAAA,EAAkB;AACpB,QAAA,MAAM,UAAA,GAAaC,yBAAwB,gBAAgB,CAAA;AAC3D,QAAA,OAAO,IAAI,cAAA;AAAA,UACT,UAAA;AAAA,UACA;AAAA,SACF;AAAA,MACF;AAAA,IACF;AAEA,IAAA,IAAI,eAAA,EAAiB;AACnB,MAAA,MAAM,EAAE,UAAA,EAAY,aAAA,EAAc,GAAI,MAAM,sBAAA;AAAA,QAC1C;AAAA,OACF;AACA,MAAA,OAAO,IAAI,cAAA,CAAe,UAAA,EAAY,UAAA,EAAY,aAAa,CAAA;AAAA,IACjE;AAEA,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,mBAAA,EAAsB,UAAA,CAAW,IAAI,CAAA,eAAA,CAAiB,CAAA;AAAA,EACxE;AAAA,EAES,WAAA;AAAA,EACA,WAAA;AAAA,EACA,cAAA;AAAA,EACA,cAAA;AAAA,EACA,cAAA;AAAA,EAET,WAAA,CACE,UAAA,EACA,UAAA,EACA,aAAA,EACA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,UAAA;AACnB,IAAA,IAAA,CAAK,WAAA,GAAc,UAAA;AACnB,IAAA,IAAA,CAAK,iBAAiB,EAAC;AACvB,IAAA,IAAA,CAAK,iBAAiB,EAAC;AACvB,IAAA,IAAA,CAAK,cAAA,GAAiB,aAAA;AAAA,EACxB;AAAA,EAEA,MAAM,sBAAA,GAAwC;AAC5C,IAAA,MAAM,eAAA,GAAkB,KAAK,aAAA,EAAc;AAC3C,IAAA,IAAI;AACF,MAAA,MAAM,eAAe,CAAA,EAAA,EAAKC,uBAAA,CAAY,EAAE,CAAA,CAAE,QAAA,CAAS,KAAK,CAAC,CAAA,CAAA;AAEzD,MAAA,MAAM,eAAA,CAAgB,GAAA,CAAI,oBAAA,EAAsB,CAAC,YAAY,CAAC,CAAA;AAC9D,MAAA,IAAA,CAAK,cAAA,CAAe,KAAK,YAAY,CAAA;AAErC,MAAA,MAAM,eAAeJ,4BAAA,CAAY;AAAA,QAC/B,MAAA,EAAQ,KAAK,WAAA,CAAY,MAAA;AAAA,QACzB,UAAA,EAAY;AAAA,UACV,GAAG,IAAA,CAAK,WAAA;AAAA,UACR,QAAA,EAAU;AAAA,SACZ;AAAA,QACA,GAAGK;AAAA,OACJ,CAAA;AACD,MAAA,IAAA,CAAK,cAAA,CAAe,KAAK,YAAY,CAAA;AAErC,MAAA,OAAO,YAAA;AAAA,IACT,CAAA,SAAE;AACA,MAAA,MAAM,gBAAgB,OAAA,EAAQ;AAAA,IAChC;AAAA,EACF;AAAA,EAEA,MAAM,QAAA,GAA0B;AAC9B,IAAA,KAAA,MAAW,QAAA,IAAY,KAAK,cAAA,EAAgB;AAC1C,MAAA,MAAM,SAAS,OAAA,EAAQ;AAAA,IACzB;AAEA,IAAA,MAAM,eAAA,GAAkB,KAAK,aAAA,EAAc;AAC3C,IAAA,IAAI;AACF,MAAA,KAAA,MAAW,YAAA,IAAgB,KAAK,cAAA,EAAgB;AAC9C,QAAA,MAAM,eAAA,CAAgB,GAAA,CAAI,kBAAA,EAAoB,CAAC,YAAY,CAAC,CAAA;AAAA,MAC9D;AAAA,IACF,CAAA,SAAE;AACA,MAAA,MAAM,gBAAgB,OAAA,EAAQ;AAAA,IAChC;AAEA,IAAA,MAAM,KAAK,cAAA,IAAiB;AAAA,EAC9B;AAAA,EAEA,aAAA,GAAsB;AACpB,IAAA,OAAOL,4BAAA,CAAY;AAAA,MACjB,MAAA,EAAQ,KAAK,WAAA,CAAY,MAAA;AAAA,MACzB,UAAA,EAAY;AAAA,QACV,GAAG,IAAA,CAAK,WAAA;AAAA,QACR,QAAA,EAAU;AAAA,OACZ;AAAA,MACA,IAAA,EAAM;AAAA,QACJ,oBAAA,EAAsB;AAAA;AACxB,KACD,CAAA;AAAA,EACH;AACF;;;;;"}

package/dist/filesystem/MockDirectory.cjs.js

@@ -1,10 +1,10 @@
 'use strict';
 
-var os = require('os');
+var os = require('node:os');
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var fs = require('fs-extra');
 var textextensions = require('text-extensions');
-var path = require('path');
+var node_path = require('node:path');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -22,7 +22,7 @@ class MockDirectoryImpl {
     return this.#root;
   }
   resolve(...paths) {
-    return path.resolve(this.#root, ...paths);
+    return node_path.resolve(this.#root, ...paths);
   }
   setContent(root) {
     this.remove();
@@ -31,7 +31,7 @@ class MockDirectoryImpl {
   addContent(root) {
     const entries = this.#transformInput(root);
     for (const entry of entries) {
-      const fullPath = path.resolve(this.#root, entry.path);
+      const fullPath = node_path.resolve(this.#root, entry.path);
       if (!backendPluginApi.isChildPath(this.#root, fullPath)) {
         throw new Error(
           `Provided path must resolve to a child path of the mock directory, got '${fullPath}'`
@@ -40,10 +40,10 @@ class MockDirectoryImpl {
       if (entry.type === "dir") {
         fs__default.default.ensureDirSync(fullPath);
       } else if (entry.type === "file") {
-        fs__default.default.ensureDirSync(path.dirname(fullPath));
+        fs__default.default.ensureDirSync(node_path.dirname(fullPath));
         fs__default.default.writeFileSync(fullPath, entry.content);
       } else if (entry.type === "callback") {
-        fs__default.default.ensureDirSync(path.dirname(fullPath));
+        fs__default.default.ensureDirSync(node_path.dirname(fullPath));
         entry.callback({
           path: fullPath,
           symlink(target) {
@@ -54,26 +54,26 @@ class MockDirectoryImpl {
     }
   }
   content(options) {
-    const shouldReadAsText = (typeof options?.shouldReadAsText === "boolean" ? () => options?.shouldReadAsText : options?.shouldReadAsText) ?? ((path$1) => textextensions__default.default.includes(path.extname(path$1).slice(1)));
-    const root = path.resolve(this.#root, options?.path ?? "");
+    const shouldReadAsText = (typeof options?.shouldReadAsText === "boolean" ? () => options?.shouldReadAsText : options?.shouldReadAsText) ?? ((path) => textextensions__default.default.includes(node_path.extname(path).slice(1)));
+    const root = node_path.resolve(this.#root, options?.path ?? "");
     if (!backendPluginApi.isChildPath(this.#root, root)) {
       throw new Error(
         `Provided path must resolve to a child path of the mock directory, got '${root}'`
       );
     }
-    function read(path$1) {
-      if (!fs__default.default.pathExistsSync(path$1)) {
+    function read(path) {
+      if (!fs__default.default.pathExistsSync(path)) {
         return void 0;
       }
-      const entries = fs__default.default.readdirSync(path$1, { withFileTypes: true });
+      const entries = fs__default.default.readdirSync(path, { withFileTypes: true });
       return Object.fromEntries(
         entries.map((entry) => {
-          const fullPath = path.resolve(path$1, entry.name);
+          const fullPath = node_path.resolve(path, entry.name);
           if (entry.isDirectory()) {
             return [entry.name, read(fullPath)];
           }
           const content = fs__default.default.readFileSync(fullPath);
-          const relativePosixPath = path.relative(root, fullPath).split(path.win32.sep).join(path.posix.sep);
+          const relativePosixPath = node_path.relative(root, fullPath).split(node_path.win32.sep).join(node_path.posix.sep);
           if (shouldReadAsText(relativePosixPath, content)) {
             return [entry.name, content.toString("utf8")];
           }
@@ -139,7 +139,7 @@ function registerTestHooks() {
 registerTestHooks();
 function createMockDirectory(options) {
   const tmpDir = process.env.RUNNER_TEMP || os__default.default.tmpdir();
-  const root = fs__default.default.mkdtempSync(path.join(tmpDir, "backstage-tmp-test-dir-"));
+  const root = fs__default.default.mkdtempSync(node_path.join(tmpDir, "backstage-tmp-test-dir-"));
   const mocker = new MockDirectoryImpl(root);
   const origTmpdir = options?.mockOsTmpDir ? os__default.default.tmpdir : void 0;
   if (origTmpdir) {

package/dist/filesystem/MockDirectory.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"MockDirectory.cjs.js","sources":["../../src/filesystem/MockDirectory.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport os from 'os';\nimport { isChildPath } from '@backstage/backend-plugin-api';\nimport fs from 'fs-extra';\nimport textextensions from 'text-extensions';\nimport {\n  dirname,\n  extname,\n  join as joinPath,\n  resolve as resolvePath,\n  relative as relativePath,\n  win32,\n  posix,\n} from 'path';\n\nconst tmpdirMarker = Symbol('os-tmpdir-mock');\n\n/**\n * A context that allows for more advanced file system operations when writing mock directory content.\n *\n * @public\n */\nexport interface MockDirectoryContentCallbackContext {\n  /** Absolute path to the location of this piece of content on the filesystem */\n  path: string;\n\n  /** Creates a symbolic link at the current location */\n  symlink(target: string): void;\n}\n\n/**\n * A callback that allows for more advanced file system operations when writing mock directory content.\n *\n * @public\n */\nexport type MockDirectoryContentCallback = (\n  ctx: MockDirectoryContentCallbackContext,\n) => void;\n\n/**\n * The content of a mock directory represented by a nested object structure.\n *\n * @remarks\n *\n * When used as input, the keys may contain forward slashes to indicate nested directories.\n * Then returned as output, each directory will always be represented as a separate object.\n *\n * @example\n * ```ts\n * {\n *   'test.txt': 'content',\n *   'sub-dir': {\n *     'file.txt': 'content',\n *     'nested-dir/file.txt': 'content',\n *   },\n *   'empty-dir': {},\n *   'binary-file': Buffer.from([0, 1, 2]),\n * }\n * ```\n *\n * @public\n */\nexport type MockDirectoryContent = {\n  [name in string]:\n    | MockDirectoryContent\n    | string\n    | Buffer\n    | MockDirectoryContentCallback;\n};\n\n/**\n * Options for {@link MockDirectory.content}.\n *\n * @public\n */\nexport interface MockDirectoryContentOptions {\n  /**\n   * The path to read content from. Defaults to the root of the mock directory.\n   *\n   * An absolute path can also be provided, as long as it is a child path of the mock directory.\n   */\n  path?: string;\n\n  /**\n   * Whether or not to return files as text rather than buffers.\n   *\n   * Defaults to checking the file extension against a list of known text extensions.\n   */\n  shouldReadAsText?: boolean | ((path: string, buffer: Buffer) => boolean);\n}\n\n/**\n * A utility for creating a mock directory that is automatically cleaned up.\n *\n * @public\n */\nexport interface MockDirectory {\n  /**\n   * The path to the root of the mock directory\n   */\n  readonly path: string;\n\n  /**\n   * Resolves a path relative to the root of the mock directory.\n   */\n  resolve(...paths: string[]): string;\n\n  /**\n   * Sets the content of the mock directory. This will remove any existing content.\n   *\n   * @example\n   * ```ts\n   * mockDir.setContent({\n   *   'test.txt': 'content',\n   *   'sub-dir': {\n   *     'file.txt': 'content',\n   *     'nested-dir/file.txt': 'content',\n   *   },\n   *   'empty-dir': {},\n   *   'binary-file': Buffer.from([0, 1, 2]),\n   * });\n   * ```\n   */\n  setContent(root: MockDirectoryContent): void;\n\n  /**\n   * Adds content of the mock directory. This will overwrite existing files.\n   *\n   * @example\n   * ```ts\n   * mockDir.addContent({\n   *   'test.txt': 'content',\n   *   'sub-dir': {\n   *     'file.txt': 'content',\n   *     'nested-dir/file.txt': 'content',\n   *   },\n   *   'empty-dir': {},\n   *   'binary-file': Buffer.from([0, 1, 2]),\n   * });\n   * ```\n   */\n  addContent(root: MockDirectoryContent): void;\n\n  /**\n   * Reads the content of the mock directory.\n   *\n   * @remarks\n   *\n   * Text files will be returned as strings, while binary files will be returned as buffers.\n   * By default the file extension is used to determine whether a file should be read as text.\n   *\n   * @example\n   * ```ts\n   * expect(mockDir.content()).toEqual({\n   *   'test.txt': 'content',\n   *   'sub-dir': {\n   *     'file.txt': 'content',\n   *     'nested-dir': {\n   *       'file.txt': 'content',\n   *     },\n   *   },\n   *   'empty-dir': {},\n   *   'binary-file': Buffer.from([0, 1, 2]),\n   * });\n   * ```\n   */\n  content(\n    options?: MockDirectoryContentOptions,\n  ): MockDirectoryContent | undefined;\n\n  /**\n   * Clears the content of the mock directory, ensuring that the directory itself exists.\n   */\n  clear(): void;\n\n  /**\n   * Removes the mock directory and all its contents.\n   */\n  remove(): void;\n}\n\n/** @internal */\ntype MockEntry =\n  | {\n      type: 'file';\n      path: string;\n      content: Buffer;\n    }\n  | {\n      type: 'dir';\n      path: string;\n    }\n  | {\n      type: 'callback';\n      path: string;\n      callback: MockDirectoryContentCallback;\n    };\n\n/** @internal */\nclass MockDirectoryImpl {\n  readonly #root: string;\n\n  constructor(root: string) {\n    this.#root = root;\n  }\n\n  get path(): string {\n    return this.#root;\n  }\n\n  resolve(...paths: string[]): string {\n    return resolvePath(this.#root, ...paths);\n  }\n\n  setContent(root: MockDirectoryContent): void {\n    this.remove();\n\n    return this.addContent(root);\n  }\n\n  addContent(root: MockDirectoryContent): void {\n    const entries = this.#transformInput(root);\n\n    for (const entry of entries) {\n      const fullPath = resolvePath(this.#root, entry.path);\n      if (!isChildPath(this.#root, fullPath)) {\n        throw new Error(\n          `Provided path must resolve to a child path of the mock directory, got '${fullPath}'`,\n        );\n      }\n\n      if (entry.type === 'dir') {\n        fs.ensureDirSync(fullPath);\n      } else if (entry.type === 'file') {\n        fs.ensureDirSync(dirname(fullPath));\n        fs.writeFileSync(fullPath, entry.content);\n      } else if (entry.type === 'callback') {\n        fs.ensureDirSync(dirname(fullPath));\n        entry.callback({\n          path: fullPath,\n          symlink(target: string) {\n            fs.symlinkSync(target, fullPath);\n          },\n        });\n      }\n    }\n  }\n\n  content(\n    options?: MockDirectoryContentOptions,\n  ): MockDirectoryContent | undefined {\n    const shouldReadAsText =\n      (typeof options?.shouldReadAsText === 'boolean'\n        ? () => options?.shouldReadAsText\n        : options?.shouldReadAsText) ??\n      ((path: string) => textextensions.includes(extname(path).slice(1)));\n\n    const root = resolvePath(this.#root, options?.path ?? '');\n    if (!isChildPath(this.#root, root)) {\n      throw new Error(\n        `Provided path must resolve to a child path of the mock directory, got '${root}'`,\n      );\n    }\n\n    function read(path: string): MockDirectoryContent | undefined {\n      if (!fs.pathExistsSync(path)) {\n        return undefined;\n      }\n\n      const entries = fs.readdirSync(path, { withFileTypes: true });\n      return Object.fromEntries(\n        entries.map(entry => {\n          const fullPath = resolvePath(path, entry.name);\n\n          if (entry.isDirectory()) {\n            return [entry.name, read(fullPath)];\n          }\n          const content = fs.readFileSync(fullPath);\n          const relativePosixPath = relativePath(root, fullPath)\n            .split(win32.sep)\n            .join(posix.sep);\n\n          if (shouldReadAsText(relativePosixPath, content)) {\n            return [entry.name, content.toString('utf8')];\n          }\n          return [entry.name, content];\n        }),\n      );\n    }\n\n    return read(root);\n  }\n\n  clear = (): void => {\n    this.setContent({});\n  };\n\n  remove = (): void => {\n    fs.rmSync(this.#root, { recursive: true, force: true, maxRetries: 10 });\n  };\n\n  #transformInput(input: MockDirectoryContent[string]): MockEntry[] {\n    const entries: MockEntry[] = [];\n\n    function traverse(node: MockDirectoryContent[string], path: string) {\n      if (typeof node === 'string') {\n        entries.push({\n          type: 'file',\n          path,\n          content: Buffer.from(node, 'utf8'),\n        });\n      } else if (node instanceof Buffer) {\n        entries.push({ type: 'file', path, content: node });\n      } else if (typeof node === 'function') {\n        entries.push({ type: 'callback', path, callback: node });\n      } else {\n        entries.push({ type: 'dir', path });\n        for (const [name, child] of Object.entries(node)) {\n          traverse(child, path ? `${path}/${name}` : name);\n        }\n      }\n    }\n\n    traverse(input, '');\n\n    return entries;\n  }\n}\n\n/**\n * Options for {@link createMockDirectory}.\n *\n * @public\n */\nexport interface CreateMockDirectoryOptions {\n  /**\n   * In addition to creating a temporary directory, also mock `os.tmpdir()` to\n   * return the mock directory path until the end of the test suite.\n   *\n   * When this option is provided the `createMockDirectory` call must happen in\n   * a scope where calling `afterAll` from Jest is allowed\n   *\n   * @returns\n   */\n  mockOsTmpDir?: boolean;\n\n  /**\n   * Initializes the directory with the given content, see {@link MockDirectory.setContent}.\n   */\n  content?: MockDirectoryContent;\n}\n\nconst cleanupCallbacks = new Array<() => void>();\n\nlet registered = false;\nfunction registerTestHooks() {\n  if (typeof afterAll !== 'function') {\n    return;\n  }\n  if (registered) {\n    return;\n  }\n  registered = true;\n\n  afterAll(async () => {\n    for (const callback of cleanupCallbacks) {\n      try {\n        callback();\n      } catch (error) {\n        console.error(\n          `Failed to clean up mock directory after tests, ${error}`,\n        );\n      }\n    }\n    cleanupCallbacks.length = 0;\n  });\n}\n\nregisterTestHooks();\n\n/**\n * Creates a new temporary mock directory that will be removed after the tests have completed.\n *\n * @public\n * @remarks\n *\n * This method is intended to be called outside of any test, either at top-level or\n * within a `describe` block. It will call `afterAll` to make sure that the mock directory\n * is removed after the tests have run.\n *\n * @example\n * ```ts\n * describe('MySubject', () => {\n *   const mockDir = createMockDirectory();\n *\n *   beforeEach(mockDir.clear);\n *\n *   it('should work', () => {\n *     // ... use mockDir\n *   })\n * })\n * ```\n */\nexport function createMockDirectory(\n  options?: CreateMockDirectoryOptions,\n): MockDirectory {\n  const tmpDir = process.env.RUNNER_TEMP || os.tmpdir(); // GitHub Actions\n  const root = fs.mkdtempSync(joinPath(tmpDir, 'backstage-tmp-test-dir-'));\n\n  const mocker = new MockDirectoryImpl(root);\n\n  const origTmpdir = options?.mockOsTmpDir ? os.tmpdir : undefined;\n  if (origTmpdir) {\n    if (Object.hasOwn(origTmpdir, tmpdirMarker)) {\n      throw new Error(\n        'Cannot mock os.tmpdir() when it has already been mocked',\n      );\n    }\n    const mock = Object.assign(() => mocker.path, { [tmpdirMarker]: true });\n    os.tmpdir = mock;\n  }\n\n  // In CI we expect there to be no need to clean up temporary directories\n  const needsCleanup = !process.env.CI;\n  if (needsCleanup) {\n    process.on('beforeExit', mocker.remove);\n  }\n\n  if (needsCleanup) {\n    cleanupCallbacks.push(() => mocker.remove());\n  }\n\n  if (origTmpdir) {\n    afterAll(() => {\n      os.tmpdir = origTmpdir;\n    });\n  }\n\n  if (options?.content) {\n    mocker.setContent(options.content);\n  }\n\n  return mocker;\n}\n"],"names":["resolvePath","isChildPath","fs","dirname","path","textextensions","extname","relativePath","win32","posix","os","joinPath"],"mappings":";;;;;;;;;;;;;;AA8BA,MAAM,YAAA,0BAAsB,gBAAgB,CAAA;AAwL5C,MAAM,iBAAA,CAAkB;AAAA,EACb,KAAA;AAAA,EAET,YAAY,IAAA,EAAc;AACxB,IAAA,IAAA,CAAK,KAAA,GAAQ,IAAA;AAAA,EACf;AAAA,EAEA,IAAI,IAAA,GAAe;AACjB,IAAA,OAAO,IAAA,CAAK,KAAA;AAAA,EACd;AAAA,EAEA,WAAW,KAAA,EAAyB;AAClC,IAAA,OAAOA,YAAA,CAAY,IAAA,CAAK,KAAA,EAAO,GAAG,KAAK,CAAA;AAAA,EACzC;AAAA,EAEA,WAAW,IAAA,EAAkC;AAC3C,IAAA,IAAA,CAAK,MAAA,EAAO;AAEZ,IAAA,OAAO,IAAA,CAAK,WAAW,IAAI,CAAA;AAAA,EAC7B;AAAA,EAEA,WAAW,IAAA,EAAkC;AAC3C,IAAA,MAAM,OAAA,GAAU,IAAA,CAAK,eAAA,CAAgB,IAAI,CAAA;AAEzC,IAAA,KAAA,MAAW,SAAS,OAAA,EAAS;AAC3B,MAAA,MAAM,QAAA,GAAWA,YAAA,CAAY,IAAA,CAAK,KAAA,EAAO,MAAM,IAAI,CAAA;AACnD,MAAA,IAAI,CAACC,4BAAA,CAAY,IAAA,CAAK,KAAA,EAAO,QAAQ,CAAA,EAAG;AACtC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,0EAA0E,QAAQ,CAAA,CAAA;AAAA,SACpF;AAAA,MACF;AAEA,MAAA,IAAI,KAAA,CAAM,SAAS,KAAA,EAAO;AACxB,QAAAC,mBAAA,CAAG,cAAc,QAAQ,CAAA;AAAA,MAC3B,CAAA,MAAA,IAAW,KAAA,CAAM,IAAA,KAAS,MAAA,EAAQ;AAChC,QAAAA,mBAAA,CAAG,aAAA,CAAcC,YAAA,CAAQ,QAAQ,CAAC,CAAA;AAClC,QAAAD,mBAAA,CAAG,aAAA,CAAc,QAAA,EAAU,KAAA,CAAM,OAAO,CAAA;AAAA,MAC1C,CAAA,MAAA,IAAW,KAAA,CAAM,IAAA,KAAS,UAAA,EAAY;AACpC,QAAAA,mBAAA,CAAG,aAAA,CAAcC,YAAA,CAAQ,QAAQ,CAAC,CAAA;AAClC,QAAA,KAAA,CAAM,QAAA,CAAS;AAAA,UACb,IAAA,EAAM,QAAA;AAAA,UACN,QAAQ,MAAA,EAAgB;AACtB,YAAAD,mBAAA,CAAG,WAAA,CAAY,QAAQ,QAAQ,CAAA;AAAA,UACjC;AAAA,SACD,CAAA;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAAA,EAEA,QACE,OAAA,EACkC;AAClC,IAAA,MAAM,oBACH,OAAO,OAAA,EAAS,qBAAqB,SAAA,GAClC,MAAM,SAAS,gBAAA,GACf,OAAA,EAAS,sBACZ,CAACE,MAAA,KAAiBC,gCAAe,QAAA,CAASC,YAAA,CAAQF,MAAI,CAAA,CAAE,KAAA,CAAM,CAAC,CAAC,CAAA,CAAA;AAEnE,IAAA,MAAM,OAAOJ,YAAA,CAAY,IAAA,CAAK,KAAA,EAAO,OAAA,EAAS,QAAQ,EAAE,CAAA;AACxD,IAAA,IAAI,CAACC,4BAAA,CAAY,IAAA,CAAK,KAAA,EAAO,IAAI,CAAA,EAAG;AAClC,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,0EAA0E,IAAI,CAAA,CAAA;AAAA,OAChF;AAAA,IACF;AAEA,IAAA,SAAS,KAAKG,MAAA,EAAgD;AAC5D,MAAA,IAAI,CAACF,mBAAA,CAAG,cAAA,CAAeE,MAAI,CAAA,EAAG;AAC5B,QAAA,OAAO,MAAA;AAAA,MACT;AAEA,MAAA,MAAM,UAAUF,mBAAA,CAAG,WAAA,CAAYE,QAAM,EAAE,aAAA,EAAe,MAAM,CAAA;AAC5D,MAAA,OAAO,MAAA,CAAO,WAAA;AAAA,QACZ,OAAA,CAAQ,IAAI,CAAA,KAAA,KAAS;AACnB,UAAA,MAAM,QAAA,GAAWJ,YAAA,CAAYI,MAAA,EAAM,KAAA,CAAM,IAAI,CAAA;AAE7C,UAAA,IAAI,KAAA,CAAM,aAAY,EAAG;AACvB,YAAA,OAAO,CAAC,KAAA,CAAM,IAAA,EAAM,IAAA,CAAK,QAAQ,CAAC,CAAA;AAAA,UACpC;AACA,UAAA,MAAM,OAAA,GAAUF,mBAAA,CAAG,YAAA,CAAa,QAAQ,CAAA;AACxC,UAAA,MAAM,iBAAA,GAAoBK,aAAA,CAAa,IAAA,EAAM,QAAQ,CAAA,CAClD,KAAA,CAAMC,UAAA,CAAM,GAAG,CAAA,CACf,IAAA,CAAKC,UAAA,CAAM,GAAG,CAAA;AAEjB,UAAA,IAAI,gBAAA,CAAiB,iBAAA,EAAmB,OAAO,CAAA,EAAG;AAChD,YAAA,OAAO,CAAC,KAAA,CAAM,IAAA,EAAM,OAAA,CAAQ,QAAA,CAAS,MAAM,CAAC,CAAA;AAAA,UAC9C;AACA,UAAA,OAAO,CAAC,KAAA,CAAM,IAAA,EAAM,OAAO,CAAA;AAAA,QAC7B,CAAC;AAAA,OACH;AAAA,IACF;AAEA,IAAA,OAAO,KAAK,IAAI,CAAA;AAAA,EAClB;AAAA,EAEA,QAAQ,MAAY;AAClB,IAAA,IAAA,CAAK,UAAA,CAAW,EAAE,CAAA;AAAA,EACpB,CAAA;AAAA,EAEA,SAAS,MAAY;AACnB,IAAAP,mBAAA,CAAG,MAAA,CAAO,IAAA,CAAK,KAAA,EAAO,EAAE,SAAA,EAAW,MAAM,KAAA,EAAO,IAAA,EAAM,UAAA,EAAY,EAAA,EAAI,CAAA;AAAA,EACxE,CAAA;AAAA,EAEA,gBAAgB,KAAA,EAAkD;AAChE,IAAA,MAAM,UAAuB,EAAC;AAE9B,IAAA,SAAS,QAAA,CAAS,MAAoC,IAAA,EAAc;AAClE,MAAA,IAAI,OAAO,SAAS,QAAA,EAAU;AAC5B,QAAA,OAAA,CAAQ,IAAA,CAAK;AAAA,UACX,IAAA,EAAM,MAAA;AAAA,UACN,IAAA;AAAA,UACA,OAAA,EAAS,MAAA,CAAO,IAAA,CAAK,IAAA,EAAM,MAAM;AAAA,SAClC,CAAA;AAAA,MACH,CAAA,MAAA,IAAW,gBAAgB,MAAA,EAAQ;AACjC,QAAA,OAAA,CAAQ,KAAK,EAAE,IAAA,EAAM,QAAQ,IAAA,EAAM,OAAA,EAAS,MAAM,CAAA;AAAA,MACpD,CAAA,MAAA,IAAW,OAAO,IAAA,KAAS,UAAA,EAAY;AACrC,QAAA,OAAA,CAAQ,KAAK,EAAE,IAAA,EAAM,YAAY,IAAA,EAAM,QAAA,EAAU,MAAM,CAAA;AAAA,MACzD,CAAA,MAAO;AACL,QAAA,OAAA,CAAQ,IAAA,CAAK,EAAE,IAAA,EAAM,KAAA,EAAO,MAAM,CAAA;AAClC,QAAA,KAAA,MAAW,CAAC,IAAA,EAAM,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,IAAI,CAAA,EAAG;AAChD,UAAA,QAAA,CAAS,OAAO,IAAA,GAAO,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,IAAI,KAAK,IAAI,CAAA;AAAA,QACjD;AAAA,MACF;AAAA,IACF;AAEA,IAAA,QAAA,CAAS,OAAO,EAAE,CAAA;AAElB,IAAA,OAAO,OAAA;AAAA,EACT;AACF;AAyBA,MAAM,gBAAA,GAAmB,IAAI,KAAA,EAAkB;AAE/C,IAAI,UAAA,GAAa,KAAA;AACjB,SAAS,iBAAA,GAAoB;AAC3B,EAAA,IAAI,OAAO,aAAa,UAAA,EAAY;AAClC,IAAA;AAAA,EACF;AACA,EAAA,IAAI,UAAA,EAAY;AACd,IAAA;AAAA,EACF;AACA,EAAA,UAAA,GAAa,IAAA;AAEb,EAAA,QAAA,CAAS,YAAY;AACnB,IAAA,KAAA,MAAW,YAAY,gBAAA,EAAkB;AACvC,MAAA,IAAI;AACF,QAAA,QAAA,EAAS;AAAA,MACX,SAAS,KAAA,EAAO;AACd,QAAA,OAAA,CAAQ,KAAA;AAAA,UACN,kDAAkD,KAAK,CAAA;AAAA,SACzD;AAAA,MACF;AAAA,IACF;AACA,IAAA,gBAAA,CAAiB,MAAA,GAAS,CAAA;AAAA,EAC5B,CAAC,CAAA;AACH;AAEA,iBAAA,EAAkB;AAyBX,SAAS,oBACd,OAAA,EACe;AACf,EAAA,MAAM,MAAA,GAAS,OAAA,CAAQ,GAAA,CAAI,WAAA,IAAeQ,oBAAG,MAAA,EAAO;AACpD,EAAA,MAAM,OAAOR,mBAAA,CAAG,WAAA,CAAYS,SAAA,CAAS,MAAA,EAAQ,yBAAyB,CAAC,CAAA;AAEvE,EAAA,MAAM,MAAA,GAAS,IAAI,iBAAA,CAAkB,IAAI,CAAA;AAEzC,EAAA,MAAM,UAAA,GAAa,OAAA,EAAS,YAAA,GAAeD,mBAAA,CAAG,MAAA,GAAS,MAAA;AACvD,EAAA,IAAI,UAAA,EAAY;AACd,IAAA,IAAI,MAAA,CAAO,MAAA,CAAO,UAAA,EAAY,YAAY,CAAA,EAAG;AAC3C,MAAA,MAAM,IAAI,KAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF;AACA,IAAA,MAAM,IAAA,GAAO,MAAA,CAAO,MAAA,CAAO,MAAM,MAAA,CAAO,IAAA,EAAM,EAAE,CAAC,YAAY,GAAG,IAAA,EAAM,CAAA;AACtE,IAAAA,mBAAA,CAAG,MAAA,GAAS,IAAA;AAAA,EACd;AAGA,EAAA,MAAM,YAAA,GAAe,CAAC,OAAA,CAAQ,GAAA,CAAI,EAAA;AAClC,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,OAAA,CAAQ,EAAA,CAAG,YAAA,EAAc,MAAA,CAAO,MAAM,CAAA;AAAA,EACxC;AAEA,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,gBAAA,CAAiB,IAAA,CAAK,MAAM,MAAA,CAAO,MAAA,EAAQ,CAAA;AAAA,EAC7C;AAEA,EAAA,IAAI,UAAA,EAAY;AACd,IAAA,QAAA,CAAS,MAAM;AACb,MAAAA,mBAAA,CAAG,MAAA,GAAS,UAAA;AAAA,IACd,CAAC,CAAA;AAAA,EACH;AAEA,EAAA,IAAI,SAAS,OAAA,EAAS;AACpB,IAAA,MAAA,CAAO,UAAA,CAAW,QAAQ,OAAO,CAAA;AAAA,EACnC;AAEA,EAAA,OAAO,MAAA;AACT;;;;"}
+{"version":3,"file":"MockDirectory.cjs.js","sources":["../../src/filesystem/MockDirectory.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport os from 'node:os';\nimport { isChildPath } from '@backstage/backend-plugin-api';\nimport fs from 'fs-extra';\nimport textextensions from 'text-extensions';\nimport {\n  dirname,\n  extname,\n  join as joinPath,\n  resolve as resolvePath,\n  relative as relativePath,\n  win32,\n  posix,\n} from 'node:path';\n\nconst tmpdirMarker = Symbol('os-tmpdir-mock');\n\n/**\n * A context that allows for more advanced file system operations when writing mock directory content.\n *\n * @public\n */\nexport interface MockDirectoryContentCallbackContext {\n  /** Absolute path to the location of this piece of content on the filesystem */\n  path: string;\n\n  /** Creates a symbolic link at the current location */\n  symlink(target: string): void;\n}\n\n/**\n * A callback that allows for more advanced file system operations when writing mock directory content.\n *\n * @public\n */\nexport type MockDirectoryContentCallback = (\n  ctx: MockDirectoryContentCallbackContext,\n) => void;\n\n/**\n * The content of a mock directory represented by a nested object structure.\n *\n * @remarks\n *\n * When used as input, the keys may contain forward slashes to indicate nested directories.\n * Then returned as output, each directory will always be represented as a separate object.\n *\n * @example\n * ```ts\n * {\n *   'test.txt': 'content',\n *   'sub-dir': {\n *     'file.txt': 'content',\n *     'nested-dir/file.txt': 'content',\n *   },\n *   'empty-dir': {},\n *   'binary-file': Buffer.from([0, 1, 2]),\n * }\n * ```\n *\n * @public\n */\nexport type MockDirectoryContent = {\n  [name in string]:\n    | MockDirectoryContent\n    | string\n    | Buffer\n    | MockDirectoryContentCallback;\n};\n\n/**\n * Options for {@link MockDirectory.content}.\n *\n * @public\n */\nexport interface MockDirectoryContentOptions {\n  /**\n   * The path to read content from. Defaults to the root of the mock directory.\n   *\n   * An absolute path can also be provided, as long as it is a child path of the mock directory.\n   */\n  path?: string;\n\n  /**\n   * Whether or not to return files as text rather than buffers.\n   *\n   * Defaults to checking the file extension against a list of known text extensions.\n   */\n  shouldReadAsText?: boolean | ((path: string, buffer: Buffer) => boolean);\n}\n\n/**\n * A utility for creating a mock directory that is automatically cleaned up.\n *\n * @public\n */\nexport interface MockDirectory {\n  /**\n   * The path to the root of the mock directory\n   */\n  readonly path: string;\n\n  /**\n   * Resolves a path relative to the root of the mock directory.\n   */\n  resolve(...paths: string[]): string;\n\n  /**\n   * Sets the content of the mock directory. This will remove any existing content.\n   *\n   * @example\n   * ```ts\n   * mockDir.setContent({\n   *   'test.txt': 'content',\n   *   'sub-dir': {\n   *     'file.txt': 'content',\n   *     'nested-dir/file.txt': 'content',\n   *   },\n   *   'empty-dir': {},\n   *   'binary-file': Buffer.from([0, 1, 2]),\n   * });\n   * ```\n   */\n  setContent(root: MockDirectoryContent): void;\n\n  /**\n   * Adds content of the mock directory. This will overwrite existing files.\n   *\n   * @example\n   * ```ts\n   * mockDir.addContent({\n   *   'test.txt': 'content',\n   *   'sub-dir': {\n   *     'file.txt': 'content',\n   *     'nested-dir/file.txt': 'content',\n   *   },\n   *   'empty-dir': {},\n   *   'binary-file': Buffer.from([0, 1, 2]),\n   * });\n   * ```\n   */\n  addContent(root: MockDirectoryContent): void;\n\n  /**\n   * Reads the content of the mock directory.\n   *\n   * @remarks\n   *\n   * Text files will be returned as strings, while binary files will be returned as buffers.\n   * By default the file extension is used to determine whether a file should be read as text.\n   *\n   * @example\n   * ```ts\n   * expect(mockDir.content()).toEqual({\n   *   'test.txt': 'content',\n   *   'sub-dir': {\n   *     'file.txt': 'content',\n   *     'nested-dir': {\n   *       'file.txt': 'content',\n   *     },\n   *   },\n   *   'empty-dir': {},\n   *   'binary-file': Buffer.from([0, 1, 2]),\n   * });\n   * ```\n   */\n  content(\n    options?: MockDirectoryContentOptions,\n  ): MockDirectoryContent | undefined;\n\n  /**\n   * Clears the content of the mock directory, ensuring that the directory itself exists.\n   */\n  clear(): void;\n\n  /**\n   * Removes the mock directory and all its contents.\n   */\n  remove(): void;\n}\n\n/** @internal */\ntype MockEntry =\n  | {\n      type: 'file';\n      path: string;\n      content: Buffer;\n    }\n  | {\n      type: 'dir';\n      path: string;\n    }\n  | {\n      type: 'callback';\n      path: string;\n      callback: MockDirectoryContentCallback;\n    };\n\n/** @internal */\nclass MockDirectoryImpl {\n  readonly #root: string;\n\n  constructor(root: string) {\n    this.#root = root;\n  }\n\n  get path(): string {\n    return this.#root;\n  }\n\n  resolve(...paths: string[]): string {\n    return resolvePath(this.#root, ...paths);\n  }\n\n  setContent(root: MockDirectoryContent): void {\n    this.remove();\n\n    return this.addContent(root);\n  }\n\n  addContent(root: MockDirectoryContent): void {\n    const entries = this.#transformInput(root);\n\n    for (const entry of entries) {\n      const fullPath = resolvePath(this.#root, entry.path);\n      if (!isChildPath(this.#root, fullPath)) {\n        throw new Error(\n          `Provided path must resolve to a child path of the mock directory, got '${fullPath}'`,\n        );\n      }\n\n      if (entry.type === 'dir') {\n        fs.ensureDirSync(fullPath);\n      } else if (entry.type === 'file') {\n        fs.ensureDirSync(dirname(fullPath));\n        fs.writeFileSync(fullPath, entry.content);\n      } else if (entry.type === 'callback') {\n        fs.ensureDirSync(dirname(fullPath));\n        entry.callback({\n          path: fullPath,\n          symlink(target: string) {\n            fs.symlinkSync(target, fullPath);\n          },\n        });\n      }\n    }\n  }\n\n  content(\n    options?: MockDirectoryContentOptions,\n  ): MockDirectoryContent | undefined {\n    const shouldReadAsText =\n      (typeof options?.shouldReadAsText === 'boolean'\n        ? () => options?.shouldReadAsText\n        : options?.shouldReadAsText) ??\n      ((path: string) => textextensions.includes(extname(path).slice(1)));\n\n    const root = resolvePath(this.#root, options?.path ?? '');\n    if (!isChildPath(this.#root, root)) {\n      throw new Error(\n        `Provided path must resolve to a child path of the mock directory, got '${root}'`,\n      );\n    }\n\n    function read(path: string): MockDirectoryContent | undefined {\n      if (!fs.pathExistsSync(path)) {\n        return undefined;\n      }\n\n      const entries = fs.readdirSync(path, { withFileTypes: true });\n      return Object.fromEntries(\n        entries.map(entry => {\n          const fullPath = resolvePath(path, entry.name);\n\n          if (entry.isDirectory()) {\n            return [entry.name, read(fullPath)];\n          }\n          const content = fs.readFileSync(fullPath);\n          const relativePosixPath = relativePath(root, fullPath)\n            .split(win32.sep)\n            .join(posix.sep);\n\n          if (shouldReadAsText(relativePosixPath, content)) {\n            return [entry.name, content.toString('utf8')];\n          }\n          return [entry.name, content];\n        }),\n      );\n    }\n\n    return read(root);\n  }\n\n  clear = (): void => {\n    this.setContent({});\n  };\n\n  remove = (): void => {\n    fs.rmSync(this.#root, { recursive: true, force: true, maxRetries: 10 });\n  };\n\n  #transformInput(input: MockDirectoryContent[string]): MockEntry[] {\n    const entries: MockEntry[] = [];\n\n    function traverse(node: MockDirectoryContent[string], path: string) {\n      if (typeof node === 'string') {\n        entries.push({\n          type: 'file',\n          path,\n          content: Buffer.from(node, 'utf8'),\n        });\n      } else if (node instanceof Buffer) {\n        entries.push({ type: 'file', path, content: node });\n      } else if (typeof node === 'function') {\n        entries.push({ type: 'callback', path, callback: node });\n      } else {\n        entries.push({ type: 'dir', path });\n        for (const [name, child] of Object.entries(node)) {\n          traverse(child, path ? `${path}/${name}` : name);\n        }\n      }\n    }\n\n    traverse(input, '');\n\n    return entries;\n  }\n}\n\n/**\n * Options for {@link createMockDirectory}.\n *\n * @public\n */\nexport interface CreateMockDirectoryOptions {\n  /**\n   * In addition to creating a temporary directory, also mock `os.tmpdir()` to\n   * return the mock directory path until the end of the test suite.\n   *\n   * When this option is provided the `createMockDirectory` call must happen in\n   * a scope where calling `afterAll` from Jest is allowed\n   *\n   * @returns\n   */\n  mockOsTmpDir?: boolean;\n\n  /**\n   * Initializes the directory with the given content, see {@link MockDirectory.setContent}.\n   */\n  content?: MockDirectoryContent;\n}\n\nconst cleanupCallbacks = new Array<() => void>();\n\nlet registered = false;\nfunction registerTestHooks() {\n  if (typeof afterAll !== 'function') {\n    return;\n  }\n  if (registered) {\n    return;\n  }\n  registered = true;\n\n  afterAll(async () => {\n    for (const callback of cleanupCallbacks) {\n      try {\n        callback();\n      } catch (error) {\n        console.error(\n          `Failed to clean up mock directory after tests, ${error}`,\n        );\n      }\n    }\n    cleanupCallbacks.length = 0;\n  });\n}\n\nregisterTestHooks();\n\n/**\n * Creates a new temporary mock directory that will be removed after the tests have completed.\n *\n * @public\n * @remarks\n *\n * This method is intended to be called outside of any test, either at top-level or\n * within a `describe` block. It will call `afterAll` to make sure that the mock directory\n * is removed after the tests have run.\n *\n * @example\n * ```ts\n * describe('MySubject', () => {\n *   const mockDir = createMockDirectory();\n *\n *   beforeEach(mockDir.clear);\n *\n *   it('should work', () => {\n *     // ... use mockDir\n *   })\n * })\n * ```\n */\nexport function createMockDirectory(\n  options?: CreateMockDirectoryOptions,\n): MockDirectory {\n  const tmpDir = process.env.RUNNER_TEMP || os.tmpdir(); // GitHub Actions\n  const root = fs.mkdtempSync(joinPath(tmpDir, 'backstage-tmp-test-dir-'));\n\n  const mocker = new MockDirectoryImpl(root);\n\n  const origTmpdir = options?.mockOsTmpDir ? os.tmpdir : undefined;\n  if (origTmpdir) {\n    if (Object.hasOwn(origTmpdir, tmpdirMarker)) {\n      throw new Error(\n        'Cannot mock os.tmpdir() when it has already been mocked',\n      );\n    }\n    const mock = Object.assign(() => mocker.path, { [tmpdirMarker]: true });\n    os.tmpdir = mock;\n  }\n\n  // In CI we expect there to be no need to clean up temporary directories\n  const needsCleanup = !process.env.CI;\n  if (needsCleanup) {\n    process.on('beforeExit', mocker.remove);\n  }\n\n  if (needsCleanup) {\n    cleanupCallbacks.push(() => mocker.remove());\n  }\n\n  if (origTmpdir) {\n    afterAll(() => {\n      os.tmpdir = origTmpdir;\n    });\n  }\n\n  if (options?.content) {\n    mocker.setContent(options.content);\n  }\n\n  return mocker;\n}\n"],"names":["resolvePath","isChildPath","fs","dirname","textextensions","extname","relativePath","win32","posix","os","joinPath"],"mappings":";;;;;;;;;;;;;;AA8BA,MAAM,YAAA,0BAAsB,gBAAgB,CAAA;AAwL5C,MAAM,iBAAA,CAAkB;AAAA,EACb,KAAA;AAAA,EAET,YAAY,IAAA,EAAc;AACxB,IAAA,IAAA,CAAK,KAAA,GAAQ,IAAA;AAAA,EACf;AAAA,EAEA,IAAI,IAAA,GAAe;AACjB,IAAA,OAAO,IAAA,CAAK,KAAA;AAAA,EACd;AAAA,EAEA,WAAW,KAAA,EAAyB;AAClC,IAAA,OAAOA,iBAAA,CAAY,IAAA,CAAK,KAAA,EAAO,GAAG,KAAK,CAAA;AAAA,EACzC;AAAA,EAEA,WAAW,IAAA,EAAkC;AAC3C,IAAA,IAAA,CAAK,MAAA,EAAO;AAEZ,IAAA,OAAO,IAAA,CAAK,WAAW,IAAI,CAAA;AAAA,EAC7B;AAAA,EAEA,WAAW,IAAA,EAAkC;AAC3C,IAAA,MAAM,OAAA,GAAU,IAAA,CAAK,eAAA,CAAgB,IAAI,CAAA;AAEzC,IAAA,KAAA,MAAW,SAAS,OAAA,EAAS;AAC3B,MAAA,MAAM,QAAA,GAAWA,iBAAA,CAAY,IAAA,CAAK,KAAA,EAAO,MAAM,IAAI,CAAA;AACnD,MAAA,IAAI,CAACC,4BAAA,CAAY,IAAA,CAAK,KAAA,EAAO,QAAQ,CAAA,EAAG;AACtC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,0EAA0E,QAAQ,CAAA,CAAA;AAAA,SACpF;AAAA,MACF;AAEA,MAAA,IAAI,KAAA,CAAM,SAAS,KAAA,EAAO;AACxB,QAAAC,mBAAA,CAAG,cAAc,QAAQ,CAAA;AAAA,MAC3B,CAAA,MAAA,IAAW,KAAA,CAAM,IAAA,KAAS,MAAA,EAAQ;AAChC,QAAAA,mBAAA,CAAG,aAAA,CAAcC,iBAAA,CAAQ,QAAQ,CAAC,CAAA;AAClC,QAAAD,mBAAA,CAAG,aAAA,CAAc,QAAA,EAAU,KAAA,CAAM,OAAO,CAAA;AAAA,MAC1C,CAAA,MAAA,IAAW,KAAA,CAAM,IAAA,KAAS,UAAA,EAAY;AACpC,QAAAA,mBAAA,CAAG,aAAA,CAAcC,iBAAA,CAAQ,QAAQ,CAAC,CAAA;AAClC,QAAA,KAAA,CAAM,QAAA,CAAS;AAAA,UACb,IAAA,EAAM,QAAA;AAAA,UACN,QAAQ,MAAA,EAAgB;AACtB,YAAAD,mBAAA,CAAG,WAAA,CAAY,QAAQ,QAAQ,CAAA;AAAA,UACjC;AAAA,SACD,CAAA;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAAA,EAEA,QACE,OAAA,EACkC;AAClC,IAAA,MAAM,oBACH,OAAO,OAAA,EAAS,qBAAqB,SAAA,GAClC,MAAM,SAAS,gBAAA,GACf,OAAA,EAAS,sBACZ,CAAC,IAAA,KAAiBE,gCAAe,QAAA,CAASC,iBAAA,CAAQ,IAAI,CAAA,CAAE,KAAA,CAAM,CAAC,CAAC,CAAA,CAAA;AAEnE,IAAA,MAAM,OAAOL,iBAAA,CAAY,IAAA,CAAK,KAAA,EAAO,OAAA,EAAS,QAAQ,EAAE,CAAA;AACxD,IAAA,IAAI,CAACC,4BAAA,CAAY,IAAA,CAAK,KAAA,EAAO,IAAI,CAAA,EAAG;AAClC,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,0EAA0E,IAAI,CAAA,CAAA;AAAA,OAChF;AAAA,IACF;AAEA,IAAA,SAAS,KAAK,IAAA,EAAgD;AAC5D,MAAA,IAAI,CAACC,mBAAA,CAAG,cAAA,CAAe,IAAI,CAAA,EAAG;AAC5B,QAAA,OAAO,MAAA;AAAA,MACT;AAEA,MAAA,MAAM,UAAUA,mBAAA,CAAG,WAAA,CAAY,MAAM,EAAE,aAAA,EAAe,MAAM,CAAA;AAC5D,MAAA,OAAO,MAAA,CAAO,WAAA;AAAA,QACZ,OAAA,CAAQ,IAAI,CAAA,KAAA,KAAS;AACnB,UAAA,MAAM,QAAA,GAAWF,iBAAA,CAAY,IAAA,EAAM,KAAA,CAAM,IAAI,CAAA;AAE7C,UAAA,IAAI,KAAA,CAAM,aAAY,EAAG;AACvB,YAAA,OAAO,CAAC,KAAA,CAAM,IAAA,EAAM,IAAA,CAAK,QAAQ,CAAC,CAAA;AAAA,UACpC;AACA,UAAA,MAAM,OAAA,GAAUE,mBAAA,CAAG,YAAA,CAAa,QAAQ,CAAA;AACxC,UAAA,MAAM,iBAAA,GAAoBI,kBAAA,CAAa,IAAA,EAAM,QAAQ,CAAA,CAClD,KAAA,CAAMC,eAAA,CAAM,GAAG,CAAA,CACf,IAAA,CAAKC,eAAA,CAAM,GAAG,CAAA;AAEjB,UAAA,IAAI,gBAAA,CAAiB,iBAAA,EAAmB,OAAO,CAAA,EAAG;AAChD,YAAA,OAAO,CAAC,KAAA,CAAM,IAAA,EAAM,OAAA,CAAQ,QAAA,CAAS,MAAM,CAAC,CAAA;AAAA,UAC9C;AACA,UAAA,OAAO,CAAC,KAAA,CAAM,IAAA,EAAM,OAAO,CAAA;AAAA,QAC7B,CAAC;AAAA,OACH;AAAA,IACF;AAEA,IAAA,OAAO,KAAK,IAAI,CAAA;AAAA,EAClB;AAAA,EAEA,QAAQ,MAAY;AAClB,IAAA,IAAA,CAAK,UAAA,CAAW,EAAE,CAAA;AAAA,EACpB,CAAA;AAAA,EAEA,SAAS,MAAY;AACnB,IAAAN,mBAAA,CAAG,MAAA,CAAO,IAAA,CAAK,KAAA,EAAO,EAAE,SAAA,EAAW,MAAM,KAAA,EAAO,IAAA,EAAM,UAAA,EAAY,EAAA,EAAI,CAAA;AAAA,EACxE,CAAA;AAAA,EAEA,gBAAgB,KAAA,EAAkD;AAChE,IAAA,MAAM,UAAuB,EAAC;AAE9B,IAAA,SAAS,QAAA,CAAS,MAAoC,IAAA,EAAc;AAClE,MAAA,IAAI,OAAO,SAAS,QAAA,EAAU;AAC5B,QAAA,OAAA,CAAQ,IAAA,CAAK;AAAA,UACX,IAAA,EAAM,MAAA;AAAA,UACN,IAAA;AAAA,UACA,OAAA,EAAS,MAAA,CAAO,IAAA,CAAK,IAAA,EAAM,MAAM;AAAA,SAClC,CAAA;AAAA,MACH,CAAA,MAAA,IAAW,gBAAgB,MAAA,EAAQ;AACjC,QAAA,OAAA,CAAQ,KAAK,EAAE,IAAA,EAAM,QAAQ,IAAA,EAAM,OAAA,EAAS,MAAM,CAAA;AAAA,MACpD,CAAA,MAAA,IAAW,OAAO,IAAA,KAAS,UAAA,EAAY;AACrC,QAAA,OAAA,CAAQ,KAAK,EAAE,IAAA,EAAM,YAAY,IAAA,EAAM,QAAA,EAAU,MAAM,CAAA;AAAA,MACzD,CAAA,MAAO;AACL,QAAA,OAAA,CAAQ,IAAA,CAAK,EAAE,IAAA,EAAM,KAAA,EAAO,MAAM,CAAA;AAClC,QAAA,KAAA,MAAW,CAAC,IAAA,EAAM,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,IAAI,CAAA,EAAG;AAChD,UAAA,QAAA,CAAS,OAAO,IAAA,GAAO,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,IAAI,KAAK,IAAI,CAAA;AAAA,QACjD;AAAA,MACF;AAAA,IACF;AAEA,IAAA,QAAA,CAAS,OAAO,EAAE,CAAA;AAElB,IAAA,OAAO,OAAA;AAAA,EACT;AACF;AAyBA,MAAM,gBAAA,GAAmB,IAAI,KAAA,EAAkB;AAE/C,IAAI,UAAA,GAAa,KAAA;AACjB,SAAS,iBAAA,GAAoB;AAC3B,EAAA,IAAI,OAAO,aAAa,UAAA,EAAY;AAClC,IAAA;AAAA,EACF;AACA,EAAA,IAAI,UAAA,EAAY;AACd,IAAA;AAAA,EACF;AACA,EAAA,UAAA,GAAa,IAAA;AAEb,EAAA,QAAA,CAAS,YAAY;AACnB,IAAA,KAAA,MAAW,YAAY,gBAAA,EAAkB;AACvC,MAAA,IAAI;AACF,QAAA,QAAA,EAAS;AAAA,MACX,SAAS,KAAA,EAAO;AACd,QAAA,OAAA,CAAQ,KAAA;AAAA,UACN,kDAAkD,KAAK,CAAA;AAAA,SACzD;AAAA,MACF;AAAA,IACF;AACA,IAAA,gBAAA,CAAiB,MAAA,GAAS,CAAA;AAAA,EAC5B,CAAC,CAAA;AACH;AAEA,iBAAA,EAAkB;AAyBX,SAAS,oBACd,OAAA,EACe;AACf,EAAA,MAAM,MAAA,GAAS,OAAA,CAAQ,GAAA,CAAI,WAAA,IAAeO,oBAAG,MAAA,EAAO;AACpD,EAAA,MAAM,OAAOP,mBAAA,CAAG,WAAA,CAAYQ,cAAA,CAAS,MAAA,EAAQ,yBAAyB,CAAC,CAAA;AAEvE,EAAA,MAAM,MAAA,GAAS,IAAI,iBAAA,CAAkB,IAAI,CAAA;AAEzC,EAAA,MAAM,UAAA,GAAa,OAAA,EAAS,YAAA,GAAeD,mBAAA,CAAG,MAAA,GAAS,MAAA;AACvD,EAAA,IAAI,UAAA,EAAY;AACd,IAAA,IAAI,MAAA,CAAO,MAAA,CAAO,UAAA,EAAY,YAAY,CAAA,EAAG;AAC3C,MAAA,MAAM,IAAI,KAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF;AACA,IAAA,MAAM,IAAA,GAAO,MAAA,CAAO,MAAA,CAAO,MAAM,MAAA,CAAO,IAAA,EAAM,EAAE,CAAC,YAAY,GAAG,IAAA,EAAM,CAAA;AACtE,IAAAA,mBAAA,CAAG,MAAA,GAAS,IAAA;AAAA,EACd;AAGA,EAAA,MAAM,YAAA,GAAe,CAAC,OAAA,CAAQ,GAAA,CAAI,EAAA;AAClC,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,OAAA,CAAQ,EAAA,CAAG,YAAA,EAAc,MAAA,CAAO,MAAM,CAAA;AAAA,EACxC;AAEA,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,gBAAA,CAAiB,IAAA,CAAK,MAAM,MAAA,CAAO,MAAA,EAAQ,CAAA;AAAA,EAC7C;AAEA,EAAA,IAAI,UAAA,EAAY;AACd,IAAA,QAAA,CAAS,MAAM;AACb,MAAAA,mBAAA,CAAG,MAAA,GAAS,UAAA;AAAA,IACd,CAAC,CAAA;AAAA,EACH;AAEA,EAAA,IAAI,SAAS,OAAA,EAAS;AACpB,IAAA,MAAA,CAAO,UAAA,CAAW,QAAQ,OAAO,CAAA;AAAA,EACnC;AAEA,EAAA,OAAO,MAAA;AACT;;;;"}

package/dist/index.cjs.js

@@ -6,6 +6,7 @@ var registerMswTestHooks = require('./msw/registerMswTestHooks.cjs.js');
 var MockDirectory = require('./filesystem/MockDirectory.cjs.js');
 var mockServices = require('./services/mockServices.cjs.js');
 var mockCredentials = require('./services/mockCredentials.cjs.js');
+var createServiceMock = require('./services/createServiceMock.cjs.js');
 var ServiceFactoryTester = require('./wiring/ServiceFactoryTester.cjs.js');
 var TestBackend = require('./wiring/TestBackend.cjs.js');
 var errorHandler = require('./util/errorHandler.cjs.js');
@@ -24,6 +25,7 @@ Object.defineProperty(exports, "mockCredentials", {
 	enumerable: true,
 	get: function () { return mockCredentials.mockCredentials; }
 });
+exports.createServiceMock = createServiceMock.createServiceMock;
 exports.ServiceFactoryTester = ServiceFactoryTester.ServiceFactoryTester;
 exports.startTestBackend = TestBackend.startTestBackend;
 exports.mockErrorHandler = errorHandler.mockErrorHandler;

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,7 +1,9 @@
 import Keyv from 'keyv';
 import { Knex } from 'knex';
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { ServiceFactory, RootConfigService, RootLoggerService, AuthService, DiscoveryService, BackstageCredentials, HttpAuthService, BackstageUserInfo, UserInfoService, DatabaseService, PermissionsService, SchedulerService, RootInstanceMetadataService, BackstageNonePrincipal, BackstageUserPrincipal, BackstagePrincipalAccessRestrictions, BackstageServicePrincipal, ServiceRef, ExtensionPoint, BackendFeature } from '@backstage/backend-plugin-api';
+import { RootConfigService, ServiceFactory, RootLoggerService, AuthService, DiscoveryService, BackstageCredentials, HttpAuthService, BackstageUserInfo, UserInfoService, DatabaseService, PermissionsService, SchedulerService, RootInstanceMetadataService, BackstageNonePrincipal, BackstageUserPrincipal, BackstagePrincipalAccessRestrictions, BackstageServicePrincipal, ServiceRef, ExtensionPoint, BackendFeature } from '@backstage/backend-plugin-api';
+import { S as ServiceMock } from './types/createServiceMock.d-CeKvILsY.js';
+export { c as createServiceMock } from './types/createServiceMock.d-CeKvILsY.js';
 import { EventsService } from '@backstage/plugin-events-node';
 import { AuthorizeResult } from '@backstage/plugin-permission-common';
 import { JsonObject } from '@backstage/types';
@@ -316,13 +318,6 @@ interface CreateMockDirectoryOptions {
  */
 declare function createMockDirectory(options?: CreateMockDirectoryOptions): MockDirectory;
 
-/** @public */
-type ServiceMock<TService> = {
-    factory: ServiceFactory<TService>;
-} & {
-    [Key in keyof TService]: TService[Key] extends (...args: infer Args) => infer Return ? TService[Key] & jest.MockInstance<Return, Args> : TService[Key];
-};
-
 /**
  * Mock implementations of the core services, to be used in tests.
  *
@@ -785,5 +780,5 @@ declare function startTestBackend<TExtensionPoints extends any[]>(options: TestB
  */
 declare function mockErrorHandler(_options?: {}, ..._args: never[]): express.ErrorRequestHandler<express_serve_static_core.ParamsDictionary, any, any, qs.ParsedQs, Record<string, any>>;
 
-export { ServiceFactoryTester, TestCaches, TestDatabases, createMockDirectory, mockCredentials, mockErrorHandler, mockServices, registerMswTestHooks, startTestBackend };
-export type { CreateMockDirectoryOptions, MockDirectory, MockDirectoryContent, MockDirectoryContentCallback, MockDirectoryContentCallbackContext, MockDirectoryContentOptions, ServiceFactoryTesterOptions, ServiceMock, TestBackend, TestBackendOptions, TestCacheId, TestDatabaseId };
+export { ServiceFactoryTester, ServiceMock, TestCaches, TestDatabases, createMockDirectory, mockCredentials, mockErrorHandler, mockServices, registerMswTestHooks, startTestBackend };
+export type { CreateMockDirectoryOptions, MockDirectory, MockDirectoryContent, MockDirectoryContentCallback, MockDirectoryContentCallbackContext, MockDirectoryContentOptions, ServiceFactoryTesterOptions, TestBackend, TestBackendOptions, TestCacheId, TestDatabaseId };