backend-defaults: refactor rootHttpRouterServiceFactory to define options on its own

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2024-07-11 14:29:18 +02:00
parent 0a474ae85a
commit 419f3878bd
5 changed files with 28 additions and 20 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/backend-defaults': patch
---
Refactor of `rootHttpRouterServiceFactory` to allow it to be constructed with options, but without declaring options via `createServiceFactory`.
+4 -5
View File
@@ -292,11 +292,10 @@ export type RootHttpRouterConfigureContext = RootHttpRouterConfigureContext_2;
export type RootHttpRouterFactoryOptions = RootHttpRouterFactoryOptions_2;
// @public @deprecated (undocumented)
export const rootHttpRouterServiceFactory: ServiceFactoryCompat<
RootHttpRouterService,
'root',
RootHttpRouterFactoryOptions_2
>;
export const rootHttpRouterServiceFactory: ((
options?: RootHttpRouterFactoryOptions_2 | undefined,
) => ServiceFactory<RootHttpRouterService, 'root'>) &
ServiceFactory<RootHttpRouterService, 'root'>;
// @public @deprecated
export const rootLifecycleServiceFactory: ServiceFactoryCompat<
@@ -19,7 +19,7 @@ import { RequestListener } from 'http';
import { RootConfigService } from '@backstage/backend-plugin-api';
import { RootHttpRouterService } from '@backstage/backend-plugin-api';
import type { Server } from 'node:http';
import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
import { ServiceFactory } from '@backstage/backend-plugin-api';
// @public
export function createHttpServer(
@@ -141,11 +141,10 @@ export type RootHttpRouterFactoryOptions = {
};
// @public (undocumented)
export const rootHttpRouterServiceFactory: ServiceFactoryCompat<
RootHttpRouterService,
'root',
RootHttpRouterFactoryOptions
>;
export const rootHttpRouterServiceFactory: ((
options?: RootHttpRouterFactoryOptions,
) => ServiceFactory<RootHttpRouterService, 'root'>) &
ServiceFactory<RootHttpRouterService, 'root'>;
// (No @packageDocumentation comment for this package)
```
@@ -69,9 +69,10 @@ function defaultConfigure({ applyDefaults }: RootHttpRouterConfigureContext) {
applyDefaults();
}
/** @public */
export const rootHttpRouterServiceFactory = createServiceFactory(
(options?: RootHttpRouterFactoryOptions) => ({
const rootHttpRouterServiceFactoryWithOptions = (
options?: RootHttpRouterFactoryOptions,
) =>
createServiceFactory({
service: coreServices.rootHttpRouter,
deps: {
config: coreServices.rootConfig,
@@ -122,5 +123,10 @@ export const rootHttpRouterServiceFactory = createServiceFactory(
return router;
},
}),
})();
/** @public */
export const rootHttpRouterServiceFactory = Object.assign(
rootHttpRouterServiceFactoryWithOptions,
rootHttpRouterServiceFactoryWithOptions(),
);
+4 -5
View File
@@ -290,11 +290,10 @@ export namespace mockServices {
// (undocumented)
export namespace rootHttpRouter {
const // (undocumented)
factory: ServiceFactoryCompat<
RootHttpRouterService,
'root',
RootHttpRouterFactoryOptions
>;
factory: ((
options?: RootHttpRouterFactoryOptions | undefined,
) => ServiceFactory<RootHttpRouterService, 'root'>) &
ServiceFactory<RootHttpRouterService, 'root'>;
const // (undocumented)
mock: (
partialImpl?: Partial<RootHttpRouterService> | undefined,