@backstage/backend-test-utils 0.5.1 → 0.6.0-next.1

package/CHANGELOG.md

@@ -1,15 +1,43 @@
 # @backstage/backend-test-utils
 
-## 0.5.1
+## 0.6.0-next.1
 
 ### Patch Changes
 
+- 710f621: Added missing service mock for `mockServices.rootConfig.mock`, and fixed the definition of `mockServices.rootHttpRouter.factory` to not have a duplicate callback.
 - Updated dependencies
-  - @backstage/backend-app-api@0.9.3
-  - @backstage/backend-defaults@0.4.4
-  - @backstage/plugin-auth-node@0.5.1
-  - @backstage/plugin-events-node@0.3.10
-  - @backstage/backend-plugin-api@0.8.1
+  - @backstage/backend-defaults@0.5.0-next.1
+  - @backstage/plugin-auth-node@0.5.2-next.1
+  - @backstage/backend-app-api@0.10.0-next.1
+  - @backstage/backend-plugin-api@0.9.0-next.1
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+  - @backstage/plugin-events-node@0.4.0-next.1
+
+## 0.6.0-next.0
+
+### Minor Changes
+
+- 19ff127: **BREAKING**: Removed service mocks for the identity and token manager services, which have been removed from `@backstage/backend-plugin-api`.
+- d425fc4: **BREAKING**: The return values from `createBackendPlugin`, `createBackendModule`, and `createServiceFactory` are now simply `BackendFeature` and `ServiceFactory`, instead of the previously deprecated form of a function that returns them. For this reason, `createServiceFactory` also no longer accepts the callback form where you provide direct options to the service. This also affects all `coreServices.*` service refs.
+
+  This may in particular affect tests; if you were effectively doing `createBackendModule({...})()` (note the parentheses), you can now remove those extra parentheses at the end. You may encounter cases of this in your `packages/backend/src/index.ts` too, where you add plugins, modules, and services. If you were using `createServiceFactory` with a function as its argument for the purpose of passing in options, this pattern has been deprecated for a while and is no longer supported. You may want to explore the new multiton patterns to achieve your goals, or moving settings to app-config.
+
+  As part of this change, the `IdentityFactoryOptions` type was removed, and can no longer be used to tweak that service. The identity service was also deprecated some time ago, and you will want to [migrate to the new auth system](https://backstage.io/docs/tutorials/auth-service-migration) if you still rely on it.
+
+### Patch Changes
+
+- 0363bf1: There is a new `mockErrorHandler` utility to help in mocking the error middleware in tests.
+- Updated dependencies
+  - @backstage/backend-app-api@0.10.0-next.0
+  - @backstage/backend-plugin-api@0.9.0-next.0
+  - @backstage/backend-defaults@0.5.0-next.0
+  - @backstage/plugin-events-node@0.4.0-next.0
+  - @backstage/plugin-auth-node@0.5.2-next.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
 
 ## 0.5.0
 
@@ -17,8 +45,8 @@
 
 - 861f162: **BREAKING**: Removed these deprecated helpers:
 
-  - `setupRequestMockHandlers` Use `CreateMockDirectoryOptions` instead.
-  - `CreateMockDirectoryOptions` Use `registerMswTestHooks` instead.
+  - `setupRequestMockHandlers` is removed; use `registerMswTestHooks` instead.
+  - `MockDirectoryOptions` is removed; use `CreateMockDirectoryOptions` instead.
 
   Stopped exporting the deprecated and internal `isDockerDisabledForTests` helper.
 

package/dist/index.cjs.js

@@ -1271,19 +1271,6 @@ class MockHttpAuthService {
   }
 }
 
-class MockIdentityService {
-  getIdentity(_options) {
-    return Promise.resolve({
-      token: "mock-token",
-      identity: {
-        type: "user",
-        userEntityRef: "user:default/mock-user",
-        ownershipEntityRefs: []
-      }
-    });
-  }
-}
-
 const levels = {
   none: 0,
   error: 1,
@@ -1365,7 +1352,7 @@ function simpleFactoryWithOptions(ref, factory) {
     async factory() {
       return factory(...options);
     }
-  })();
+  });
   return Object.assign(
     factoryWithOptions,
     factoryWithOptions(...[void 0])
@@ -1388,7 +1375,7 @@ function simpleMock(ref, mockFactory) {
         service: ref,
         deps: {},
         factory: () => mock
-      })()
+      })
     });
   };
 }
@@ -1403,6 +1390,24 @@ exports.mockServices = void 0;
       backendPluginApi.coreServices.rootConfig,
       rootConfig2
     );
+    rootConfig2.mock = simpleMock(backendPluginApi.coreServices.rootConfig, () => ({
+      get: jest.fn(),
+      getBoolean: jest.fn(),
+      getConfig: jest.fn(),
+      getConfigArray: jest.fn(),
+      getNumber: jest.fn(),
+      getOptional: jest.fn(),
+      getOptionalBoolean: jest.fn(),
+      getOptionalConfig: jest.fn(),
+      getOptionalConfigArray: jest.fn(),
+      getOptionalNumber: jest.fn(),
+      getOptionalString: jest.fn(),
+      getOptionalStringArray: jest.fn(),
+      getString: jest.fn(),
+      getStringArray: jest.fn(),
+      has: jest.fn(),
+      keys: jest.fn()
+    }));
   })(rootConfig = mockServices2.rootConfig || (mockServices2.rootConfig = {}));
   function rootLogger(options) {
     return MockRootLoggerService.create(options);
@@ -1421,44 +1426,6 @@ exports.mockServices = void 0;
       warn: jest.fn()
     }));
   })(rootLogger = mockServices2.rootLogger || (mockServices2.rootLogger = {}));
-  function tokenManager() {
-    return {
-      async getToken() {
-        return { token: "mock-token" };
-      },
-      async authenticate(token) {
-        if (token !== "mock-token") {
-          throw new Error("Invalid token");
-        }
-      }
-    };
-  }
-  mockServices2.tokenManager = 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()
-    }));
-  })(tokenManager = mockServices2.tokenManager || (mockServices2.tokenManager = {}));
-  function identity() {
-    return new MockIdentityService();
-  }
-  mockServices2.identity = identity;
-  ((identity2) => {
-    identity2.factory = backendPluginApi.createServiceFactory({
-      service: backendPluginApi.coreServices.identity,
-      deps: {},
-      factory: () => identity2()
-    });
-    identity2.mock = simpleMock(backendPluginApi.coreServices.identity, () => ({
-      getIdentity: jest.fn()
-    }));
-  })(identity = mockServices2.identity || (mockServices2.identity = {}));
   function auth(options) {
     return new MockAuthService({
       pluginId: options?.pluginId ?? "test",
@@ -1467,7 +1434,7 @@ exports.mockServices = void 0;
   }
   mockServices2.auth = auth;
   ((auth2) => {
-    auth2.factory = backendPluginApi.createServiceFactory({
+    auth2.factory = () => backendPluginApi.createServiceFactory({
       service: backendPluginApi.coreServices.auth,
       deps: {
         plugin: backendPluginApi.coreServices.pluginMetadata,
@@ -1508,7 +1475,7 @@ exports.mockServices = void 0;
   }
   mockServices2.discovery = discovery$1;
   ((discovery2) => {
-    discovery2.factory = discovery.discoveryServiceFactory;
+    discovery2.factory = () => discovery.discoveryServiceFactory;
     discovery2.mock = simpleMock(backendPluginApi.coreServices.discovery, () => ({
       getBaseUrl: jest.fn(),
       getExternalBaseUrl: jest.fn()
@@ -1522,18 +1489,14 @@ exports.mockServices = void 0;
   }
   mockServices2.httpAuth = httpAuth;
   ((httpAuth2) => {
-    const factoryWithOptions = (options) => backendPluginApi.createServiceFactory({
+    httpAuth2.factory = (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(),
       issueUserCookie: jest.fn()
@@ -1544,7 +1507,7 @@ exports.mockServices = void 0;
   }
   mockServices2.userInfo = userInfo;
   ((userInfo2) => {
-    userInfo2.factory = backendPluginApi.createServiceFactory({
+    userInfo2.factory = () => backendPluginApi.createServiceFactory({
       service: backendPluginApi.coreServices.userInfo,
       deps: {},
       factory() {
@@ -1556,7 +1519,7 @@ exports.mockServices = void 0;
     }));
   })(userInfo = mockServices2.userInfo || (mockServices2.userInfo = {}));
   ((cache2) => {
-    cache2.factory = cache.cacheServiceFactory;
+    cache2.factory = () => cache.cacheServiceFactory;
     cache2.mock = simpleMock(backendPluginApi.coreServices.cache, () => ({
       delete: jest.fn(),
       get: jest.fn(),
@@ -1565,61 +1528,61 @@ exports.mockServices = void 0;
     }));
   })(mockServices2.cache || (mockServices2.cache = {}));
   ((database2) => {
-    database2.factory = database.databaseServiceFactory;
+    database2.factory = () => database.databaseServiceFactory;
     database2.mock = simpleMock(backendPluginApi.coreServices.database, () => ({
       getClient: jest.fn()
     }));
   })(mockServices2.database || (mockServices2.database = {}));
   ((rootHealth2) => {
-    rootHealth2.factory = rootHealth.rootHealthServiceFactory;
+    rootHealth2.factory = () => rootHealth.rootHealthServiceFactory;
     rootHealth2.mock = simpleMock(backendPluginApi.coreServices.rootHealth, () => ({
       getLiveness: jest.fn(),
       getReadiness: jest.fn()
     }));
   })(mockServices2.rootHealth || (mockServices2.rootHealth = {}));
   ((httpRouter2) => {
-    httpRouter2.factory = httpRouter.httpRouterServiceFactory;
+    httpRouter2.factory = () => httpRouter.httpRouterServiceFactory;
     httpRouter2.mock = simpleMock(backendPluginApi.coreServices.httpRouter, () => ({
       use: jest.fn(),
       addAuthPolicy: jest.fn()
     }));
   })(mockServices2.httpRouter || (mockServices2.httpRouter = {}));
   ((rootHttpRouter2) => {
-    rootHttpRouter2.factory = rootHttpRouter.rootHttpRouterServiceFactory;
+    rootHttpRouter2.factory = () => rootHttpRouter.rootHttpRouterServiceFactory();
     rootHttpRouter2.mock = simpleMock(backendPluginApi.coreServices.rootHttpRouter, () => ({
       use: jest.fn()
     }));
   })(mockServices2.rootHttpRouter || (mockServices2.rootHttpRouter = {}));
   ((lifecycle2) => {
-    lifecycle2.factory = lifecycle.lifecycleServiceFactory;
+    lifecycle2.factory = () => lifecycle.lifecycleServiceFactory;
     lifecycle2.mock = simpleMock(backendPluginApi.coreServices.lifecycle, () => ({
       addShutdownHook: jest.fn(),
       addStartupHook: jest.fn()
     }));
   })(mockServices2.lifecycle || (mockServices2.lifecycle = {}));
   ((logger2) => {
-    logger2.factory = logger.loggerServiceFactory;
+    logger2.factory = () => logger.loggerServiceFactory;
     logger2.mock = simpleMock(
       backendPluginApi.coreServices.logger,
       () => createLoggerMock()
     );
   })(mockServices2.logger || (mockServices2.logger = {}));
   ((permissions2) => {
-    permissions2.factory = permissions.permissionsServiceFactory;
+    permissions2.factory = () => permissions.permissionsServiceFactory;
     permissions2.mock = simpleMock(backendPluginApi.coreServices.permissions, () => ({
       authorize: jest.fn(),
       authorizeConditional: jest.fn()
     }));
   })(mockServices2.permissions || (mockServices2.permissions = {}));
   ((rootLifecycle2) => {
-    rootLifecycle2.factory = rootLifecycle.rootLifecycleServiceFactory;
+    rootLifecycle2.factory = () => rootLifecycle.rootLifecycleServiceFactory;
     rootLifecycle2.mock = simpleMock(backendPluginApi.coreServices.rootLifecycle, () => ({
       addShutdownHook: jest.fn(),
       addStartupHook: jest.fn()
     }));
   })(mockServices2.rootLifecycle || (mockServices2.rootLifecycle = {}));
   ((scheduler2) => {
-    scheduler2.factory = scheduler.schedulerServiceFactory;
+    scheduler2.factory = () => scheduler.schedulerServiceFactory;
     scheduler2.mock = simpleMock(backendPluginApi.coreServices.scheduler, () => ({
       createScheduledTaskRunner: jest.fn(),
       getScheduledTasks: jest.fn(),
@@ -1628,7 +1591,7 @@ exports.mockServices = void 0;
     }));
   })(mockServices2.scheduler || (mockServices2.scheduler = {}));
   ((urlReader2) => {
-    urlReader2.factory = urlReader.urlReaderServiceFactory;
+    urlReader2.factory = () => urlReader.urlReaderServiceFactory;
     urlReader2.mock = simpleMock(backendPluginApi.coreServices.urlReader, () => ({
       readTree: jest.fn(),
       readUrl: jest.fn(),
@@ -1636,7 +1599,7 @@ exports.mockServices = void 0;
     }));
   })(mockServices2.urlReader || (mockServices2.urlReader = {}));
   ((events2) => {
-    events2.factory = pluginEventsNode.eventsServiceFactory;
+    events2.factory = () => pluginEventsNode.eventsServiceFactory;
     events2.mock = simpleMock(pluginEventsNode.eventsServiceRef, () => ({
       publish: jest.fn(),
       subscribe: jest.fn()
@@ -1651,7 +1614,6 @@ const defaultServiceFactories = [
   exports.mockServices.database.factory(),
   exports.mockServices.httpAuth.factory(),
   exports.mockServices.httpRouter.factory(),
-  exports.mockServices.identity.factory(),
   exports.mockServices.lifecycle.factory(),
   exports.mockServices.logger.factory(),
   exports.mockServices.permissions.factory(),
@@ -1659,7 +1621,6 @@ const defaultServiceFactories = [
   exports.mockServices.rootLifecycle.factory(),
   exports.mockServices.rootLogger.factory(),
   exports.mockServices.scheduler.factory(),
-  exports.mockServices.tokenManager.factory(),
   exports.mockServices.userInfo.factory(),
   exports.mockServices.urlReader.factory(),
   exports.mockServices.events.factory()
@@ -2350,10 +2311,18 @@ class ServiceFactoryTester {
   }
 }
 
+function mockErrorHandler() {
+  return rootHttpRouter.MiddlewareFactory.create({
+    config: exports.mockServices.rootConfig(),
+    logger: exports.mockServices.rootLogger()
+  }).error();
+}
+
 exports.ServiceFactoryTester = ServiceFactoryTester;
 exports.TestCaches = TestCaches;
 exports.TestDatabases = TestDatabases;
 exports.createMockDirectory = createMockDirectory;
+exports.mockErrorHandler = mockErrorHandler;
 exports.registerMswTestHooks = registerMswTestHooks;
 exports.startTestBackend = startTestBackend;
 //# sourceMappingURL=index.cjs.js.map