Merge pull request #14346 from backstage/jhaals/lifecycle

RFC backend plugin lifecycle events

.changeset/old-keys-leave.md

@@ -0,0 +1,5 @@
+---
+'@backstage/backend-app-api': patch
+---
+
+Added `lifecycleFactory` implementation.

.changeset/silly-wolves-remember.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog-backend': patch
+---
+
+Registered shutdown hook in experimental catalog plugin.

.changeset/twenty-dodos-wash.md

@@ -0,0 +1,5 @@
+---
+'@backstage/backend-defaults': patch
+---
+
+Added `lifecycleFactory` to default service factories.

.changeset/young-turkeys-relax.md

@@ -0,0 +1,5 @@
+---
+'@backstage/backend-plugin-api': patch
+---
+
+Added initial support for registering shutdown hooks via `lifecycleServiceRef`.

packages/backend-app-api/api-report.md

@@ -4,6 +4,7 @@
 
 ```ts
 import { BackendFeature } from '@backstage/backend-plugin-api';
+import { BackendLifecycle } from '@backstage/backend-plugin-api';
 import { Config } from '@backstage/config';
 import { ExtensionPoint } from '@backstage/backend-plugin-api';
 import { HttpRouterService } from '@backstage/backend-plugin-api';
@@ -66,6 +67,11 @@ export type HttpRouterFactoryOptions = {
   indexPlugin?: string;
 };
 
+// @public
+export const lifecycleFactory: (
+  options?: undefined,
+) => ServiceFactory<BackendLifecycle>;
+
 // @public (undocumented)
 export const loggerFactory: (options?: undefined) => ServiceFactory<Logger>;
 

packages/backend-app-api/src/services/implementations/index.ts

@@ -25,4 +25,5 @@ export { schedulerFactory } from './schedulerService';
 export { tokenManagerFactory } from './tokenManagerService';
 export { urlReaderFactory } from './urlReaderService';
 export { httpRouterFactory } from './httpRouterService';
+export { lifecycleFactory } from './lifecycleService';
 export type { HttpRouterFactoryOptions } from './httpRouterService';

packages/backend-app-api/src/services/implementations/lifecycleService.test.ts

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { getVoidLogger } from '@backstage/backend-common';
+import { BackendLifecycleImpl } from './lifecycleService';
+
+describe('lifecycleService', () => {
+  it('should execute registered shutdown hook', async () => {
+    const service = new BackendLifecycleImpl(getVoidLogger());
+    const hook = jest.fn();
+    service.addShutdownHook({
+      pluginId: 'test',
+      fn: async () => {
+        hook();
+      },
+    });
+    // should not execute the hook more than once.
+    await service.shutdown();
+    await service.shutdown();
+    await service.shutdown();
+    expect(hook).toHaveBeenCalledTimes(1);
+  });
+
+  it('should not throw errors', async () => {
+    const service = new BackendLifecycleImpl(getVoidLogger());
+    service.addShutdownHook({
+      pluginId: 'test',
+      fn: async () => {
+        throw new Error('oh no');
+      },
+    });
+    await expect(service.shutdown()).resolves.toBeUndefined();
+  });
+});

packages/backend-app-api/src/services/implementations/lifecycleService.ts

@@ -0,0 +1,96 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import {
+  BackendLifecycle,
+  createServiceFactory,
+  lifecycleServiceRef,
+  loggerToWinstonLogger,
+  pluginMetadataServiceRef,
+  rootLoggerServiceRef,
+  BackendLifecycleShutdownHook,
+} from '@backstage/backend-plugin-api';
+import { Logger } from 'winston';
+
+const CALLBACKS = ['SIGTERM', 'SIGINT', 'beforeExit'];
+export class BackendLifecycleImpl {
+  constructor(private readonly logger: Logger) {
+    CALLBACKS.map(signal => process.on(signal, () => this.shutdown()));
+  }
+
+  #isCalled = false;
+  #shutdownTasks: Array<BackendLifecycleShutdownHook & { pluginId: string }> =
+    [];
+
+  addShutdownHook(
+    options: BackendLifecycleShutdownHook & { pluginId: string },
+  ): void {
+    this.#shutdownTasks.push(options);
+  }
+
+  async shutdown(): Promise<void> {
+    if (this.#isCalled) {
+      return;
+    }
+    this.#isCalled = true;
+
+    this.logger.info(`Running ${this.#shutdownTasks.length} shutdown tasks...`);
+    await Promise.all(
+      this.#shutdownTasks.map(hook =>
+        Promise.resolve()
+          .then(() => hook.fn())
+          .catch(e => {
+            this.logger.error(
+              `Shutdown hook registered by plugin '${hook.pluginId}' failed with: ${e}`,
+            );
+          })
+          .then(() =>
+            this.logger.info(
+              `Successfully ran shutdown hook registered by plugin ${hook.pluginId}`,
+            ),
+          ),
+      ),
+    );
+  }
+}
+
+class PluginScopedLifecycleImpl implements BackendLifecycle {
+  constructor(
+    private readonly lifecycle: BackendLifecycleImpl,
+    private readonly pluginId: string,
+  ) {}
+  addShutdownHook(options: BackendLifecycleShutdownHook): void {
+    this.lifecycle.addShutdownHook({ ...options, pluginId: this.pluginId });
+  }
+}
+
+/**
+ * Allows plugins to register shutdown hooks that are run when the process is about to exit.
+ * @public */
+export const lifecycleFactory = createServiceFactory({
+  service: lifecycleServiceRef,
+  deps: {
+    logger: rootLoggerServiceRef,
+    plugin: pluginMetadataServiceRef,
+  },
+  async factory({ logger }) {
+    const rootLifecycle = new BackendLifecycleImpl(
+      loggerToWinstonLogger(logger),
+    );
+    return async ({ plugin }) => {
+      return new PluginScopedLifecycleImpl(rootLifecycle, plugin.getId());
+    };
+  },
+});

packages/backend-defaults/src/CreateBackend.ts

@@ -22,6 +22,7 @@ import {
   databaseFactory,
   discoveryFactory,
   httpRouterFactory,
+  lifecycleFactory,
   loggerFactory,
   permissionsFactory,
   rootLoggerFactory,
@@ -43,6 +44,7 @@ export const defaultServiceFactories = [
   tokenManagerFactory,
   urlReaderFactory,
   httpRouterFactory,
+  lifecycleFactory,
 ];
 
 /**

packages/backend-plugin-api/api-report.md

@@ -24,6 +24,16 @@ export interface BackendFeature {
   register(reg: BackendRegistrationPoints): void;
 }
 
+// @public (undocumented)
+export interface BackendLifecycle {
+  addShutdownHook(options: BackendLifecycleShutdownHook): void;
+}
+
+// @public (undocumented)
+export type BackendLifecycleShutdownHook = {
+  fn: () => void | Promise<void>;
+};
+
 // @public (undocumented)
 export interface BackendModuleConfig<TOptions> {
   // (undocumented)
@@ -158,6 +168,9 @@ export interface HttpRouterService {
 // @public (undocumented)
 export const httpRouterServiceRef: ServiceRef<HttpRouterService, 'plugin'>;
 
+// @public (undocumented)
+export const lifecycleServiceRef: ServiceRef<BackendLifecycle, 'plugin'>;
+
 // @public (undocumented)
 export interface Logger {
   // (undocumented)

packages/backend-plugin-api/src/services/definitions/index.ts

@@ -28,4 +28,9 @@ export { permissionsServiceRef } from './permissionsServiceRef';
 export { schedulerServiceRef } from './schedulerServiceRef';
 export { rootLoggerServiceRef } from './rootLoggerServiceRef';
 export { pluginMetadataServiceRef } from './pluginMetadataServiceRef';
+export { lifecycleServiceRef } from './lifecycleServiceRef';
+export type {
+  BackendLifecycle,
+  BackendLifecycleShutdownHook,
+} from './lifecycleServiceRef';
 export type { PluginMetadata } from './pluginMetadataServiceRef';

packages/backend-plugin-api/src/services/definitions/lifecycleServiceRef.ts

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { createServiceRef } from '../system/types';
+
+/**
+ * @public
+ **/
+export type BackendLifecycleShutdownHook = {
+  fn: () => void | Promise<void>;
+};
+
+/**
+ * @public
+ **/
+export interface BackendLifecycle {
+  /**
+   * Register a function to be called when the backend is shutting down.
+   */
+  addShutdownHook(options: BackendLifecycleShutdownHook): void;
+}
+
+/**
+ * @public
+ */
+export const lifecycleServiceRef = createServiceRef<BackendLifecycle>({
+  id: 'core.lifecycle',
+  scope: 'plugin',
+});

plugins/catalog-backend/src/service/CatalogPlugin.ts

@@ -22,6 +22,7 @@ import {
   permissionsServiceRef,
   urlReaderServiceRef,
   httpRouterServiceRef,
+  lifecycleServiceRef,
 } from '@backstage/backend-plugin-api';
 import { CatalogBuilder } from './CatalogBuilder';
 import {
@@ -78,6 +79,7 @@ export const catalogPlugin = createBackendPlugin({
         permissions: permissionsServiceRef,
         database: databaseServiceRef,
         httpRouter: httpRouterServiceRef,
+        lifecycle: lifecycleServiceRef,
       },
       async init({
         logger,
@@ -86,6 +88,7 @@ export const catalogPlugin = createBackendPlugin({
         database,
         permissions,
         httpRouter,
+        lifecycle,
       }) {
         const winstonLogger = loggerToWinstonLogger(logger);
         const builder = await CatalogBuilder.create({
@@ -100,7 +103,11 @@ export const catalogPlugin = createBackendPlugin({
         const { processingEngine, router } = await builder.build();
 
         await processingEngine.start();
-
+        lifecycle.addShutdownHook({
+          fn: async () => {
+            await processingEngine.stop();
+          },
+        });
         httpRouter.use(router);
       },
     });