From da5dd9361827df0fcb01be2bd720338db227771a Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Mon, 2 Sep 2024 15:12:21 +0200 Subject: [PATCH 1/3] backend-defaults: deprecate createLifecycleMiddleware Reduce API surface by deprecating export with no external usage. Fixes #26359 Signed-off-by: Johan Haals --- packages/backend-defaults/api-report-httpRouter.md | 2 +- .../src/entrypoints/httpRouter/createLifecycleMiddleware.ts | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/backend-defaults/api-report-httpRouter.md b/packages/backend-defaults/api-report-httpRouter.md index dc612377ae..bc5f069559 100644 --- a/packages/backend-defaults/api-report-httpRouter.md +++ b/packages/backend-defaults/api-report-httpRouter.md @@ -9,7 +9,7 @@ import { LifecycleService } from '@backstage/backend-plugin-api'; import { RequestHandler } from 'express'; import { ServiceFactory } from '@backstage/backend-plugin-api'; -// @public +// @public @deprecated export function createLifecycleMiddleware( options: LifecycleMiddlewareOptions, ): RequestHandler; diff --git a/packages/backend-defaults/src/entrypoints/httpRouter/createLifecycleMiddleware.ts b/packages/backend-defaults/src/entrypoints/httpRouter/createLifecycleMiddleware.ts index 3f8ee3ea69..2a18f5046e 100644 --- a/packages/backend-defaults/src/entrypoints/httpRouter/createLifecycleMiddleware.ts +++ b/packages/backend-defaults/src/entrypoints/httpRouter/createLifecycleMiddleware.ts @@ -48,6 +48,8 @@ export interface LifecycleMiddlewareOptions { * {@link @backstage/errors#ServiceUnavailableError}. * * @public + * @deprecated This function export will be removed in a future release. + * If rely on this function then please reach out to the Backstage maintainers. */ export function createLifecycleMiddleware( options: LifecycleMiddlewareOptions, From baeef13ec0a7bb3adbb96cc8a21f99e19c433136 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Mon, 2 Sep 2024 15:45:42 +0200 Subject: [PATCH 2/3] add changeset Signed-off-by: Johan Haals --- .changeset/silent-worms-admire.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/silent-worms-admire.md diff --git a/.changeset/silent-worms-admire.md b/.changeset/silent-worms-admire.md new file mode 100644 index 0000000000..4038382962 --- /dev/null +++ b/.changeset/silent-worms-admire.md @@ -0,0 +1,5 @@ +--- +'@backstage/backend-defaults': minor +--- + +Deprecated `createLifecycleMiddleware` to clean up API surface, it has no external references, let us know if you use this directly. From 09f16b8a7d7b2cc67866410d5ee6cbf05c5a09c5 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Mon, 9 Sep 2024 14:52:33 +0200 Subject: [PATCH 3/3] Remove export of createLifecycleMiddleware and LifecycleMiddlewareOptions Signed-off-by: Johan Haals --- .changeset/silent-worms-admire.md | 2 +- .../backend-defaults/api-report-httpRouter.md | 15 --------------- .../httpRouter/createLifecycleMiddleware.ts | 6 ++---- .../src/entrypoints/httpRouter/index.ts | 2 -- 4 files changed, 3 insertions(+), 22 deletions(-) diff --git a/.changeset/silent-worms-admire.md b/.changeset/silent-worms-admire.md index 4038382962..c9e7e25ad9 100644 --- a/.changeset/silent-worms-admire.md +++ b/.changeset/silent-worms-admire.md @@ -2,4 +2,4 @@ '@backstage/backend-defaults': minor --- -Deprecated `createLifecycleMiddleware` to clean up API surface, it has no external references, let us know if you use this directly. +**BREAKING** Removed `createLifecycleMiddleware` and `LifecycleMiddlewareOptions` to clean up API surface. These exports have no external usage and do not provide value in its current form. If you were using these exports, please reach out to the maintainers to discuss your use case. diff --git a/packages/backend-defaults/api-report-httpRouter.md b/packages/backend-defaults/api-report-httpRouter.md index bc5f069559..97805bc926 100644 --- a/packages/backend-defaults/api-report-httpRouter.md +++ b/packages/backend-defaults/api-report-httpRouter.md @@ -4,16 +4,8 @@ ```ts import { HttpRouterService } from '@backstage/backend-plugin-api'; -import { HumanDuration } from '@backstage/types'; -import { LifecycleService } from '@backstage/backend-plugin-api'; -import { RequestHandler } from 'express'; import { ServiceFactory } from '@backstage/backend-plugin-api'; -// @public @deprecated -export function createLifecycleMiddleware( - options: LifecycleMiddlewareOptions, -): RequestHandler; - // @public export const httpRouterServiceFactory: ServiceFactory< HttpRouterService, @@ -21,12 +13,5 @@ export const httpRouterServiceFactory: ServiceFactory< 'singleton' >; -// @public -export interface LifecycleMiddlewareOptions { - // (undocumented) - lifecycle: LifecycleService; - startupRequestPauseTimeout?: HumanDuration; -} - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/src/entrypoints/httpRouter/createLifecycleMiddleware.ts b/packages/backend-defaults/src/entrypoints/httpRouter/createLifecycleMiddleware.ts index 2a18f5046e..18ff2f0840 100644 --- a/packages/backend-defaults/src/entrypoints/httpRouter/createLifecycleMiddleware.ts +++ b/packages/backend-defaults/src/entrypoints/httpRouter/createLifecycleMiddleware.ts @@ -23,7 +23,7 @@ export const DEFAULT_TIMEOUT = { seconds: 5 }; /** * Options for {@link createLifecycleMiddleware}. - * @public + * @internal */ export interface LifecycleMiddlewareOptions { lifecycle: LifecycleService; @@ -47,9 +47,7 @@ export interface LifecycleMiddlewareOptions { * If the service is shutting down, all requests will be rejected with a * {@link @backstage/errors#ServiceUnavailableError}. * - * @public - * @deprecated This function export will be removed in a future release. - * If rely on this function then please reach out to the Backstage maintainers. + * @internal */ export function createLifecycleMiddleware( options: LifecycleMiddlewareOptions, diff --git a/packages/backend-defaults/src/entrypoints/httpRouter/index.ts b/packages/backend-defaults/src/entrypoints/httpRouter/index.ts index bc12480ae8..15bced5ef3 100644 --- a/packages/backend-defaults/src/entrypoints/httpRouter/index.ts +++ b/packages/backend-defaults/src/entrypoints/httpRouter/index.ts @@ -15,5 +15,3 @@ */ export { httpRouterServiceFactory } from './httpRouterServiceFactory'; -export { createLifecycleMiddleware } from './createLifecycleMiddleware'; -export type { LifecycleMiddlewareOptions } from './createLifecycleMiddleware';