@backstage/backend-test-utils 0.4.4-next.1 → 0.4.5-next.0

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @backstage/backend-test-utils
 
+## 0.4.5-next.0
+
+### Patch Changes
+
+- 4e79d19: The default services for `startTestBackend` and `ServiceFactoryTester` now includes the Root Health Service.
+- Updated dependencies
+  - @backstage/backend-defaults@0.4.2-next.0
+  - @backstage/backend-app-api@0.8.1-next.0
+  - @backstage/backend-plugin-api@0.7.1-next.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+  - @backstage/plugin-auth-node@0.4.18-next.0
+  - @backstage/plugin-events-node@0.3.9-next.0
+
+## 0.4.4
+
+### Patch Changes
+
+- 2f99178: The `ServiceFactoryTest.get` method was deprecated and the `ServiceFactoryTest.getSubject` should be used instead. The `getSubject` method has the same behavior, but has a better method name to indicate that the service instance returned is the subject currently being tested.
+- edf5cc3: The function `isDockerDisabledForTests` is deprecated and will no longer be exported in the near future as it should only be used internally.
+- b05e1e1: Service factories exported by this package have been updated to use the new service factory format that doesn't use a callback.
+- fce7887: Added mock for the Root Health Service in `mockServices`.
+- 906c817: Updated `startTestBackend` and `ServiceFactoryTester` to only accept plain service factory or backend feature objects, no longer supporting the callback form. This lines up with the changes to `@backstage/backend-plugin-api` and should not require any code changes.
+- 95a3a0b: Rename frontend and backend `setupRequestMockHandlers` methods to `registerMswTestHooks`.
+- b9ed1bb: bumped better-sqlite3 from ^9.0.0 to ^11.0.0
+- 98ccf00: Internal refactor of `mockServices.httpAuth.factory` to allow it to still be constructed with options, but without declaring options via `createServiceFactory`.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.7.0
+  - @backstage/backend-defaults@0.4.0
+  - @backstage/backend-app-api@0.8.0
+  - @backstage/plugin-events-node@0.3.8
+  - @backstage/plugin-auth-node@0.4.17
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+
 ## 0.4.4-next.1
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -44,10 +44,23 @@ var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 var textextensions__default = /*#__PURE__*/_interopDefaultCompat(textextensions);
 var express__default = /*#__PURE__*/_interopDefaultCompat(express);
 
-function isDockerDisabledForTests() {
+function registerMswTestHooks(worker) {
+  beforeAll(() => worker.listen({ onUnhandledRequest: "error" }));
+  afterAll(() => worker.close());
+  afterEach(() => worker.resetHandlers());
+}
+
+function isDockerDisabledForTests$1() {
   return Boolean(process.env.BACKSTAGE_TEST_DISABLE_DOCKER) || !Boolean(process.env.CI);
 }
 
+function setupRequestMockHandlers(worker) {
+  registerMswTestHooks(worker);
+}
+function isDockerDisabledForTests() {
+  return isDockerDisabledForTests$1();
+}
+
 async function attemptMemcachedConnection(connection) {
   const startTime = Date.now();
   for (; ; ) {
@@ -183,7 +196,7 @@ class TestCaches {
    */
   static create(options) {
     const ids = options?.ids;
-    const disableDocker = options?.disableDocker ?? isDockerDisabledForTests();
+    const disableDocker = options?.disableDocker ?? isDockerDisabledForTests$1();
     let testCacheIds;
     if (ids) {
       testCacheIds = ids;
@@ -720,7 +733,7 @@ class TestDatabases {
    */
   static create(options) {
     const ids = options?.ids;
-    const disableDocker = options?.disableDocker ?? isDockerDisabledForTests();
+    const disableDocker = options?.disableDocker ?? isDockerDisabledForTests$1();
     let testDatabaseIds;
     if (ids) {
       testDatabaseIds = ids;
@@ -814,12 +827,6 @@ class TestDatabases {
   }
 }
 
-function setupRequestMockHandlers(worker) {
-  beforeAll(() => worker.listen({ onUnhandledRequest: "error" }));
-  afterAll(() => worker.close());
-  afterEach(() => worker.resetHandlers());
-}
-
 const tmpdirMarker = Symbol("os-tmpdir-mock");
 class MockDirectoryImpl {
   #root;
@@ -1358,14 +1365,18 @@ function createLoggerMock() {
     warn: jest.fn()
   };
 }
-function simpleFactory(ref, factory) {
-  return backendPluginApi.createServiceFactory((options) => ({
+function simpleFactoryWithOptions(ref, factory) {
+  const factoryWithOptions = (...options) => backendPluginApi.createServiceFactory({
     service: ref,
     deps: {},
     async factory() {
-      return factory(options);
+      return factory(...options);
     }
-  }));
+  })();
+  return Object.assign(
+    factoryWithOptions,
+    factoryWithOptions(...[void 0])
+  );
 }
 function simpleMock(ref, mockFactory) {
   return (partialImpl) => {
@@ -1395,14 +1406,20 @@ exports.mockServices = void 0;
   }
   mockServices2.rootConfig = rootConfig;
   ((rootConfig2) => {
-    rootConfig2.factory = simpleFactory(backendPluginApi.coreServices.rootConfig, rootConfig2);
+    rootConfig2.factory = simpleFactoryWithOptions(
+      backendPluginApi.coreServices.rootConfig,
+      rootConfig2
+    );
   })(rootConfig = mockServices2.rootConfig || (mockServices2.rootConfig = {}));
   function rootLogger(options) {
     return MockRootLoggerService.create(options);
   }
   mockServices2.rootLogger = rootLogger;
   ((rootLogger2) => {
-    rootLogger2.factory = simpleFactory(backendPluginApi.coreServices.rootLogger, rootLogger2);
+    rootLogger2.factory = simpleFactoryWithOptions(
+      backendPluginApi.coreServices.rootLogger,
+      rootLogger2
+    );
     rootLogger2.mock = simpleMock(backendPluginApi.coreServices.rootLogger, () => ({
       child: jest.fn(),
       debug: jest.fn(),
@@ -1425,10 +1442,11 @@ exports.mockServices = void 0;
   }
   mockServices2.tokenManager = tokenManager;
   ((tokenManager2) => {
-    tokenManager2.factory = simpleFactory(
-      backendPluginApi.coreServices.tokenManager,
-      tokenManager2
-    );
+    tokenManager2.factory = backendPluginApi.createServiceFactory({
+      service: backendPluginApi.coreServices.tokenManager,
+      deps: {},
+      factory: () => tokenManager2()
+    });
     tokenManager2.mock = simpleMock(backendPluginApi.coreServices.tokenManager, () => ({
       authenticate: jest.fn(),
       getToken: jest.fn()
@@ -1439,7 +1457,11 @@ exports.mockServices = void 0;
   }
   mockServices2.identity = identity;
   ((identity2) => {
-    identity2.factory = simpleFactory(backendPluginApi.coreServices.identity, identity2);
+    identity2.factory = backendPluginApi.createServiceFactory({
+      service: backendPluginApi.coreServices.identity,
+      deps: {},
+      factory: () => identity2()
+    });
     identity2.mock = simpleMock(backendPluginApi.coreServices.identity, () => ({
       getIdentity: jest.fn()
     }));
@@ -1507,15 +1529,17 @@ exports.mockServices = void 0;
   }
   mockServices2.httpAuth = httpAuth;
   ((httpAuth2) => {
-    httpAuth2.factory = backendPluginApi.createServiceFactory(
-      (options) => ({
-        service: backendPluginApi.coreServices.httpAuth,
-        deps: { plugin: backendPluginApi.coreServices.pluginMetadata },
-        factory: ({ plugin }) => new MockHttpAuthService(
-          plugin.getId(),
-          options?.defaultCredentials ?? exports.mockCredentials.user()
-        )
-      })
+    const factoryWithOptions = (options) => backendPluginApi.createServiceFactory({
+      service: backendPluginApi.coreServices.httpAuth,
+      deps: { plugin: backendPluginApi.coreServices.pluginMetadata },
+      factory: ({ plugin }) => new MockHttpAuthService(
+        plugin.getId(),
+        options?.defaultCredentials ?? exports.mockCredentials.user()
+      )
+    })();
+    httpAuth2.factory = Object.assign(
+      factoryWithOptions,
+      factoryWithOptions()
     );
     httpAuth2.mock = simpleMock(backendPluginApi.coreServices.httpAuth, () => ({
       credentials: jest.fn(),
@@ -1638,6 +1662,7 @@ const defaultServiceFactories = [
   exports.mockServices.lifecycle.factory(),
   exports.mockServices.logger.factory(),
   exports.mockServices.permissions.factory(),
+  exports.mockServices.rootHealth.factory(),
   exports.mockServices.rootLifecycle.factory(),
   exports.mockServices.rootLogger.factory(),
   exports.mockServices.scheduler.factory(),
@@ -1766,13 +1791,16 @@ async function startTestBackend(options) {
     deps: {
       config: backendPluginApi.coreServices.rootConfig,
       lifecycle: backendPluginApi.coreServices.rootLifecycle,
-      rootLogger: backendPluginApi.coreServices.rootLogger
+      rootLogger: backendPluginApi.coreServices.rootLogger,
+      health: backendPluginApi.coreServices.rootHealth
     },
-    async factory({ config, lifecycle, rootLogger }) {
+    async factory({ config, lifecycle, rootLogger, health }) {
       const router = backendAppApi.DefaultRootHttpRouter.create();
       const logger = rootLogger.child({ service: "rootHttpRouter" });
       const app = express__default.default();
       const middleware = backendAppApi.MiddlewareFactory.create({ config, logger });
+      const healthRouter = rootHttpRouter.createHealthRouter({ health });
+      app.use(healthRouter);
       app.use(router.handler());
       app.use(middleware.notFound());
       app.use(middleware.error());
@@ -2047,13 +2075,13 @@ function toInternalServiceFactory(factory) {
   }
   return f;
 }
-const pluginMetadataServiceFactory = backendPluginApi.createServiceFactory(
-  (options) => ({
+function createPluginMetadataServiceFactory(pluginId) {
+  return backendPluginApi.createServiceFactory({
     service: backendPluginApi.coreServices.pluginMetadata,
     deps: {},
-    factory: async () => ({ getId: () => options?.pluginId })
-  })
-);
+    factory: async () => ({ getId: () => pluginId })
+  });
+}
 class ServiceRegistry {
   static create(factories) {
     const registry = new ServiceRegistry(factories);
@@ -2076,7 +2104,7 @@ class ServiceRegistry {
   #resolveFactory(ref, pluginId) {
     if (ref.id === backendPluginApi.coreServices.pluginMetadata.id) {
       return Promise.resolve(
-        toInternalServiceFactory(pluginMetadataServiceFactory({ pluginId }))
+        toInternalServiceFactory(createPluginMetadataServiceFactory(pluginId))
       );
     }
     let resolvedFactory = this.#providedFactories.get(ref.id);
@@ -2249,20 +2277,25 @@ class ServiceFactoryTester {
    * @returns A new tester instance for the provided subject.
    */
   static from(subject, options) {
-    const subjectFactory = typeof subject === "function" ? subject() : subject;
     const registry = ServiceRegistry.create([
       ...defaultServiceFactories,
-      ...options?.dependencies?.map(
-        (f) => typeof f === "function" ? f() : f
-      ) ?? [],
-      subjectFactory
+      ...options?.dependencies ?? [],
+      subject
     ]);
-    return new ServiceFactoryTester(subjectFactory.service, registry);
+    return new ServiceFactoryTester(subject.service, registry);
   }
   constructor(subject, registry) {
     this.#subject = subject;
     this.#registry = registry;
   }
+  /**
+   * Returns the service instance for the subject.
+   *
+   * @deprecated Use `getSubject` instead.
+   */
+  async get(...args) {
+    return this.getSubject(...args);
+  }
   /**
    * Returns the service instance for the subject.
    *
@@ -2273,7 +2306,7 @@ class ServiceFactoryTester {
    *
    * By default the plugin ID 'test' is used.
    */
-  async get(...args) {
+  async getSubject(...args) {
     const [pluginId] = args;
     return this.#registry.get(this.#subject, pluginId ?? "test");
   }
@@ -2299,6 +2332,7 @@ exports.TestCaches = TestCaches;
 exports.TestDatabases = TestDatabases;
 exports.createMockDirectory = createMockDirectory;
 exports.isDockerDisabledForTests = isDockerDisabledForTests;
+exports.registerMswTestHooks = registerMswTestHooks;
 exports.setupRequestMockHandlers = setupRequestMockHandlers;
 exports.startTestBackend = startTestBackend;
 //# sourceMappingURL=index.cjs.js.map