Sub-page content:
@@ -115,7 +117,7 @@ const ExternalPage = createPageExtension({
return (
This is page X
- Go back
+ {indexLink && Go back}
);
};
diff --git a/packages/app-next/src/index-public-experimental.tsx b/packages/app-next/src/index-public-experimental.tsx
new file mode 100644
index 0000000000..56bc698ffd
--- /dev/null
+++ b/packages/app-next/src/index-public-experimental.tsx
@@ -0,0 +1,49 @@
+/*
+ * Copyright 2020 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 React from 'react';
+import ReactDOM from 'react-dom/client';
+import { CookieAuthRedirect } from '@backstage/plugin-auth-react';
+import { createApp } from '@backstage/frontend-app-api';
+import { signInPageOverrides } from './overrides/SignInPage';
+import {
+ coreExtensionData,
+ createExtension,
+ createExtensionOverrides,
+} from '@backstage/frontend-plugin-api';
+
+const authRedirectExtension = createExtension({
+ namespace: 'app',
+ name: 'layout',
+ attachTo: { id: 'app/root', input: 'children' },
+ output: {
+ element: coreExtensionData.reactElement,
+ },
+ factory: () => ({
+ element:
,
+ }),
+});
+
+const app = createApp({
+ features: [
+ signInPageOverrides,
+ createExtensionOverrides({
+ extensions: [authRedirectExtension],
+ }),
+ ],
+});
+
+ReactDOM.createRoot(document.getElementById('root')!).render(app.createRoot());
diff --git a/packages/app-next/src/overrides/SignInPage.tsx b/packages/app-next/src/overrides/SignInPage.tsx
new file mode 100644
index 0000000000..364a749293
--- /dev/null
+++ b/packages/app-next/src/overrides/SignInPage.tsx
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2024 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 React from 'react';
+import { SignInPage } from '@backstage/core-components';
+import {
+ createExtensionOverrides,
+ createSignInPageExtension,
+} from '@backstage/frontend-plugin-api';
+
+const signInPage = createSignInPageExtension({
+ name: 'guest',
+ loader: async () => props =>
,
+});
+
+export const signInPageOverrides = createExtensionOverrides({
+ extensions: [signInPage],
+});
diff --git a/packages/app/CHANGELOG.md b/packages/app/CHANGELOG.md
index 4977cc1d6d..88e1134800 100644
--- a/packages/app/CHANGELOG.md
+++ b/packages/app/CHANGELOG.md
@@ -1,5 +1,210 @@
# example-app
+## 0.2.100-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-react@1.11.0-next.2
+ - @backstage/plugin-catalog@1.22.0-next.2
+ - @backstage/cli@0.27.0-next.3
+ - @backstage/frontend-app-api@0.7.5-next.2
+ - @backstage/plugin-search-common@1.2.14-next.1
+ - @backstage/plugin-search-react@1.7.14-next.2
+ - @backstage/plugin-search@1.4.15-next.2
+ - @backstage/plugin-api-docs@0.11.8-next.2
+ - @backstage/plugin-techdocs@1.10.8-next.2
+ - @backstage/plugin-scaffolder@1.24.0-next.2
+ - @backstage/plugin-catalog-react@1.12.3-next.2
+ - @backstage/plugin-catalog-graph@0.4.8-next.3
+ - @backstage/plugin-catalog-import@0.12.2-next.2
+ - @backstage/plugin-org@0.6.28-next.2
+ - @backstage/plugin-user-settings@0.8.11-next.2
+ - @backstage/plugin-devtools@0.1.17-next.2
+ - @backstage/plugin-home@0.7.9-next.2
+ - @backstage/plugin-kubernetes@0.11.13-next.2
+ - @backstage/plugin-catalog-common@1.0.26-next.1
+ - @backstage/plugin-permission-react@0.4.25-next.1
+ - @backstage/app-defaults@1.5.10-next.2
+ - @backstage/catalog-model@1.5.0
+ - @backstage/config@1.2.0
+ - @backstage/core-app-api@1.14.2-next.0
+ - @backstage/core-components@0.14.10-next.0
+ - @backstage/core-plugin-api@1.9.3
+ - @backstage/integration-react@1.1.30-next.0
+ - @backstage/theme@0.5.6
+ - @backstage/plugin-auth-react@0.1.5-next.0
+ - @backstage/plugin-catalog-unprocessed-entities@0.2.7-next.0
+ - @backstage/plugin-kubernetes-cluster@0.0.14-next.2
+ - @backstage/plugin-notifications@0.2.4-next.0
+ - @backstage/plugin-signals@0.0.9-next.0
+ - @backstage/plugin-techdocs-module-addons-contrib@1.1.13-next.0
+ - @backstage/plugin-techdocs-react@1.2.7-next.0
+
+## 0.2.100-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/cli@0.27.0-next.2
+ - @backstage/plugin-catalog-graph@0.4.8-next.2
+ - @backstage/app-defaults@1.5.10-next.1
+ - @backstage/catalog-model@1.5.0
+ - @backstage/config@1.2.0
+ - @backstage/core-app-api@1.14.2-next.0
+ - @backstage/core-components@0.14.10-next.0
+ - @backstage/core-plugin-api@1.9.3
+ - @backstage/frontend-app-api@0.7.5-next.1
+ - @backstage/integration-react@1.1.30-next.0
+ - @backstage/theme@0.5.6
+ - @backstage/plugin-api-docs@0.11.8-next.1
+ - @backstage/plugin-auth-react@0.1.5-next.0
+ - @backstage/plugin-catalog@1.21.2-next.1
+ - @backstage/plugin-catalog-common@1.0.26-next.0
+ - @backstage/plugin-catalog-import@0.12.2-next.1
+ - @backstage/plugin-catalog-react@1.12.3-next.1
+ - @backstage/plugin-catalog-unprocessed-entities@0.2.7-next.0
+ - @backstage/plugin-devtools@0.1.17-next.1
+ - @backstage/plugin-home@0.7.9-next.1
+ - @backstage/plugin-kubernetes@0.11.13-next.1
+ - @backstage/plugin-kubernetes-cluster@0.0.14-next.1
+ - @backstage/plugin-notifications@0.2.4-next.0
+ - @backstage/plugin-org@0.6.28-next.1
+ - @backstage/plugin-permission-react@0.4.25-next.0
+ - @backstage/plugin-scaffolder@1.23.1-next.1
+ - @backstage/plugin-scaffolder-react@1.11.0-next.1
+ - @backstage/plugin-search@1.4.15-next.1
+ - @backstage/plugin-search-common@1.2.14-next.0
+ - @backstage/plugin-search-react@1.7.14-next.1
+ - @backstage/plugin-signals@0.0.9-next.0
+ - @backstage/plugin-techdocs@1.10.8-next.1
+ - @backstage/plugin-techdocs-module-addons-contrib@1.1.13-next.0
+ - @backstage/plugin-techdocs-react@1.2.7-next.0
+ - @backstage/plugin-user-settings@0.8.11-next.1
+
+## 0.2.100-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-techdocs@1.10.8-next.1
+ - @backstage/plugin-catalog-react@1.12.3-next.1
+ - @backstage/frontend-app-api@0.7.5-next.1
+ - @backstage/plugin-kubernetes@0.11.13-next.1
+ - @backstage/cli@0.27.0-next.1
+ - @backstage/plugin-scaffolder@1.23.1-next.1
+ - @backstage/plugin-user-settings@0.8.11-next.1
+ - @backstage/plugin-search-react@1.7.14-next.1
+ - @backstage/plugin-catalog@1.21.2-next.1
+ - @backstage/plugin-search@1.4.15-next.1
+ - @backstage/plugin-api-docs@0.11.8-next.1
+ - @backstage/plugin-catalog-graph@0.4.8-next.1
+ - @backstage/plugin-catalog-import@0.12.2-next.1
+ - @backstage/plugin-home@0.7.9-next.1
+ - @backstage/plugin-kubernetes-cluster@0.0.14-next.1
+ - @backstage/plugin-org@0.6.28-next.1
+ - @backstage/plugin-scaffolder-react@1.11.0-next.1
+ - @backstage/plugin-catalog-common@1.0.26-next.0
+ - @backstage/plugin-permission-react@0.4.25-next.0
+ - @backstage/plugin-search-common@1.2.14-next.0
+ - @backstage/plugin-devtools@0.1.17-next.1
+ - @backstage/app-defaults@1.5.10-next.1
+ - @backstage/catalog-model@1.5.0
+ - @backstage/config@1.2.0
+ - @backstage/core-app-api@1.14.2-next.0
+ - @backstage/core-components@0.14.10-next.0
+ - @backstage/core-plugin-api@1.9.3
+ - @backstage/integration-react@1.1.30-next.0
+ - @backstage/theme@0.5.6
+ - @backstage/plugin-auth-react@0.1.5-next.0
+ - @backstage/plugin-catalog-unprocessed-entities@0.2.7-next.0
+ - @backstage/plugin-notifications@0.2.4-next.0
+ - @backstage/plugin-signals@0.0.9-next.0
+ - @backstage/plugin-techdocs-module-addons-contrib@1.1.13-next.0
+ - @backstage/plugin-techdocs-react@1.2.7-next.0
+
+## 0.2.100-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/cli@0.27.0-next.0
+ - @backstage/plugin-catalog-react@1.12.3-next.0
+ - @backstage/plugin-search-react@1.7.14-next.0
+ - @backstage/plugin-home@0.7.8-next.0
+ - @backstage/core-components@0.14.10-next.0
+ - @backstage/plugin-scaffolder-react@1.11.0-next.0
+ - @backstage/frontend-app-api@0.7.4-next.0
+ - @backstage/plugin-catalog-graph@0.4.8-next.0
+ - @backstage/plugin-scaffolder@1.23.1-next.0
+ - @backstage/core-app-api@1.14.1-next.0
+ - @backstage/plugin-auth-react@0.1.5-next.0
+ - @backstage/app-defaults@1.5.9-next.0
+ - @backstage/catalog-model@1.5.0
+ - @backstage/config@1.2.0
+ - @backstage/core-plugin-api@1.9.3
+ - @backstage/integration-react@1.1.30-next.0
+ - @backstage/theme@0.5.6
+ - @backstage/plugin-api-docs@0.11.8-next.0
+ - @backstage/plugin-catalog@1.21.2-next.0
+ - @backstage/plugin-catalog-common@1.0.25
+ - @backstage/plugin-catalog-import@0.12.2-next.0
+ - @backstage/plugin-catalog-unprocessed-entities@0.2.7-next.0
+ - @backstage/plugin-devtools@0.1.17-next.0
+ - @backstage/plugin-kubernetes@0.11.13-next.0
+ - @backstage/plugin-kubernetes-cluster@0.0.14-next.0
+ - @backstage/plugin-notifications@0.2.4-next.0
+ - @backstage/plugin-org@0.6.28-next.0
+ - @backstage/plugin-permission-react@0.4.24
+ - @backstage/plugin-search@1.4.15-next.0
+ - @backstage/plugin-search-common@1.2.13
+ - @backstage/plugin-signals@0.0.9-next.0
+ - @backstage/plugin-techdocs@1.10.8-next.0
+ - @backstage/plugin-techdocs-module-addons-contrib@1.1.13-next.0
+ - @backstage/plugin-techdocs-react@1.2.7-next.0
+ - @backstage/plugin-user-settings@0.8.10-next.0
+
+## 0.2.99
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder@1.23.0
+ - @backstage/plugin-techdocs@1.10.7
+ - @backstage/plugin-techdocs-react@1.2.6
+ - @backstage/core-components@0.14.9
+ - @backstage/cli@0.26.11
+ - @backstage/core-app-api@1.14.0
+ - @backstage/frontend-app-api@0.7.3
+ - @backstage/plugin-org@0.6.27
+ - @backstage/plugin-catalog-react@1.12.2
+ - @backstage/plugin-catalog@1.21.1
+ - @backstage/plugin-notifications@0.2.3
+ - @backstage/plugin-home@0.7.7
+ - @backstage/plugin-scaffolder-react@1.10.0
+ - @backstage/plugin-permission-react@0.4.24
+ - @backstage/plugin-search@1.4.14
+ - @backstage/plugin-techdocs-module-addons-contrib@1.1.12
+ - @backstage/plugin-catalog-common@1.0.25
+ - @backstage/plugin-search-common@1.2.13
+ - @backstage/app-defaults@1.5.8
+ - @backstage/integration-react@1.1.29
+ - @backstage/plugin-api-docs@0.11.7
+ - @backstage/plugin-auth-react@0.1.4
+ - @backstage/plugin-catalog-graph@0.4.7
+ - @backstage/plugin-catalog-import@0.12.1
+ - @backstage/plugin-catalog-unprocessed-entities@0.2.6
+ - @backstage/plugin-devtools@0.1.16
+ - @backstage/plugin-kubernetes@0.11.12
+ - @backstage/plugin-kubernetes-cluster@0.0.13
+ - @backstage/plugin-search-react@1.7.13
+ - @backstage/plugin-signals@0.0.8
+ - @backstage/plugin-user-settings@0.8.9
+ - @backstage/catalog-model@1.5.0
+ - @backstage/config@1.2.0
+ - @backstage/core-plugin-api@1.9.3
+ - @backstage/theme@0.5.6
+
## 0.2.99-next.2
### Patch Changes
diff --git a/packages/app/package.json b/packages/app/package.json
index f15dbac9db..c4c0c18391 100644
--- a/packages/app/package.json
+++ b/packages/app/package.json
@@ -1,6 +1,6 @@
{
"name": "example-app",
- "version": "0.2.99-next.2",
+ "version": "0.2.100-next.3",
"backstage": {
"role": "frontend"
},
diff --git a/packages/backend-app-api/CHANGELOG.md b/packages/backend-app-api/CHANGELOG.md
index 4456d8438b..c7c8883302 100644
--- a/packages/backend-app-api/CHANGELOG.md
+++ b/packages/backend-app-api/CHANGELOG.md
@@ -1,5 +1,88 @@
# @backstage/backend-app-api
+## 0.8.1-next.2
+
+### Patch Changes
+
+- 8b13183: Added support for the latest version of `BackendFeature`s from `@backstage/backend-plugin-api`, including feature loaders.
+- 93095ee: Make sure node-fetch is version 2.7.0 or greater
+- 7c5f3b0: Update the `ServiceRegister` implementation to enable registering multiple service implementations for a given service ref.
+- 80a0737: Added configuration for the `packages` options to config schema
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.8.0-next.2
+ - @backstage/backend-common@0.23.4-next.2
+ - @backstage/config-loader@1.9.0-next.2
+ - @backstage/plugin-auth-node@0.5.0-next.2
+ - @backstage/plugin-permission-node@0.8.1-next.2
+ - @backstage/backend-tasks@0.5.28-next.2
+ - @backstage/cli-node@0.2.7
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+
+## 0.8.1-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/config-loader@1.9.0-next.1
+ - @backstage/plugin-permission-node@0.8.1-next.1
+ - @backstage/backend-plugin-api@0.7.1-next.1
+ - @backstage/backend-common@0.23.4-next.1
+ - @backstage/backend-tasks@0.5.28-next.1
+ - @backstage/cli-common@0.1.14
+ - @backstage/cli-node@0.2.7
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.4.18-next.1
+
+## 0.8.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.23.4-next.0
+ - @backstage/config-loader@1.8.2-next.0
+ - @backstage/backend-plugin-api@0.7.1-next.0
+ - @backstage/backend-tasks@0.5.28-next.0
+ - @backstage/cli-common@0.1.14
+ - @backstage/cli-node@0.2.7
+ - @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-permission-node@0.8.1-next.0
+
+## 0.8.0
+
+### Minor Changes
+
+- 1cb84d7: **BREAKING**: Removed the depreacted `getPath` option from `httpRouterServiceFactory`, as well as the `HttpRouterFactoryOptions` type.
+- f691c9b: **BREAKING**: Removed the ability to pass callback-form service factories through the `defaultServiceFactories` option of `createSpecializedBackend`. This is an immediate breaking change as usage of this function is expected to be very rare.
+
+### 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.
+- b05e1e1: Service factories exported by this package have been updated to use the new service factory format that doesn't use a callback.
+- 617a7d2: Internal refactor that avoids the use of service factory options.
+- b60db08: Fixing exporting of classes properly from new packages
+- 18b96b1: The ability to install backend features in callback form (`() => BackendFeature`) has been deprecated. This typically means that you need to update the installed features to use the latest version of `@backstage/backend-plugin-api`. If the feature is from a third-party package, please reach out to the package maintainer to update it.
+- a63c4b6: Fixing issue with `MiddlewareFactory` deprecation wrapping
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.7.0
+ - @backstage/backend-common@0.23.3
+ - @backstage/cli-node@0.2.7
+ - @backstage/backend-tasks@0.5.27
+ - @backstage/plugin-permission-node@0.8.0
+ - @backstage/plugin-auth-node@0.4.17
+ - @backstage/config-loader@1.8.1
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+
## 0.7.10-next.1
### Patch Changes
diff --git a/packages/backend-app-api/api-report-alpha.md b/packages/backend-app-api/api-report-alpha.md
index 488feedf2c..8616eec29a 100644
--- a/packages/backend-app-api/api-report-alpha.md
+++ b/packages/backend-app-api/api-report-alpha.md
@@ -4,12 +4,14 @@
```ts
import { FeatureDiscoveryService } from '@backstage/backend-plugin-api/alpha';
-import { ServiceFactory } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
// @alpha (undocumented)
-export const featureDiscoveryServiceFactory: () => ServiceFactory<
+export const featureDiscoveryServiceFactory: ServiceFactoryCompat<
FeatureDiscoveryService,
- 'root'
+ 'root',
+ 'singleton',
+ undefined
>;
// (No @packageDocumentation comment for this package)
diff --git a/packages/backend-app-api/api-report.md b/packages/backend-app-api/api-report.md
index c577084a58..dea309ebb0 100644
--- a/packages/backend-app-api/api-report.md
+++ b/packages/backend-app-api/api-report.md
@@ -39,14 +39,19 @@ import { RootLoggerService } from '@backstage/backend-plugin-api';
import { SchedulerService } from '@backstage/backend-plugin-api';
import type { Server } from 'node:http';
import { ServiceFactory } from '@backstage/backend-plugin-api';
-import { ServiceFactoryOrFunction } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
import { TokenManagerService } from '@backstage/backend-plugin-api';
import { transport } from 'winston';
import { UrlReaderService } from '@backstage/backend-plugin-api';
import { UserInfoService } from '@backstage/backend-plugin-api';
// @public @deprecated (undocumented)
-export const authServiceFactory: () => ServiceFactory
;
+export const authServiceFactory: ServiceFactoryCompat<
+ AuthService,
+ 'plugin',
+ 'singleton',
+ undefined
+>;
// @public (undocumented)
export interface Backend {
@@ -54,9 +59,16 @@ export interface Backend {
add(
feature:
| BackendFeature
+ | Promise<{
+ default: BackendFeature;
+ }>,
+ ): void;
+ // @deprecated (undocumented)
+ add(
+ feature:
| (() => BackendFeature)
| Promise<{
- default: BackendFeature | (() => BackendFeature);
+ default: () => BackendFeature;
}>,
): void;
// (undocumented)
@@ -66,7 +78,12 @@ export interface Backend {
}
// @public @deprecated (undocumented)
-export const cacheServiceFactory: () => ServiceFactory;
+export const cacheServiceFactory: ServiceFactoryCompat<
+ CacheService,
+ 'plugin',
+ 'singleton',
+ undefined
+>;
// Warning: (ae-forgotten-export) The symbol "createConfigSecretEnumerator_2" needs to be exported by the entry point index.d.ts
//
@@ -91,13 +108,15 @@ export function createSpecializedBackend(
// @public (undocumented)
export interface CreateSpecializedBackendOptions {
// (undocumented)
- defaultServiceFactories: ServiceFactoryOrFunction[];
+ defaultServiceFactories: ServiceFactory[];
}
// @public @deprecated (undocumented)
-export const databaseServiceFactory: () => ServiceFactory<
+export const databaseServiceFactory: ServiceFactoryCompat<
DatabaseService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// @public @deprecated
@@ -116,9 +135,11 @@ export class DefaultRootHttpRouter implements RootHttpRouterService {
export type DefaultRootHttpRouterOptions = DefaultRootHttpRouterOptions_2;
// @public @deprecated (undocumented)
-export const discoveryServiceFactory: () => ServiceFactory<
+export const discoveryServiceFactory: ServiceFactoryCompat<
DiscoveryService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// Warning: (ae-forgotten-export) The symbol "ExtendedHttpServer_2" needs to be exported by the entry point index.d.ts
@@ -141,15 +162,19 @@ export class HostDiscovery implements DiscoveryService {
}
// @public @deprecated (undocumented)
-export const httpAuthServiceFactory: () => ServiceFactory<
+export const httpAuthServiceFactory: ServiceFactoryCompat<
HttpAuthService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// @public @deprecated
-export const httpRouterServiceFactory: () => ServiceFactory<
+export const httpRouterServiceFactory: ServiceFactoryCompat<
HttpRouterService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// Warning: (ae-forgotten-export) The symbol "HttpServerCertificateOptions_2" needs to be exported by the entry point index.d.ts
@@ -169,9 +194,12 @@ export type IdentityFactoryOptions = {
};
// @public @deprecated (undocumented)
-export const identityServiceFactory: (
- options?: IdentityFactoryOptions | undefined,
-) => ServiceFactory;
+export const identityServiceFactory: ServiceFactoryCompat<
+ IdentityService,
+ 'plugin',
+ 'singleton',
+ IdentityFactoryOptions
+>;
// Warning: (ae-forgotten-export) The symbol "LifecycleMiddlewareOptions_2" needs to be exported by the entry point index.d.ts
//
@@ -179,9 +207,11 @@ export const identityServiceFactory: (
export type LifecycleMiddlewareOptions = LifecycleMiddlewareOptions_2;
// @public @deprecated
-export const lifecycleServiceFactory: () => ServiceFactory<
+export const lifecycleServiceFactory: ServiceFactoryCompat<
LifecycleService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// @public @deprecated
@@ -195,9 +225,11 @@ export function loadBackendConfig(options: {
}>;
// @public @deprecated
-export const loggerServiceFactory: () => ServiceFactory<
+export const loggerServiceFactory: ServiceFactoryCompat<
LoggerService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// @public @deprecated (undocumented)
@@ -222,9 +254,11 @@ export type MiddlewareFactoryErrorOptions = MiddlewareFactoryErrorOptions_2;
export type MiddlewareFactoryOptions = MiddlewareFactoryOptions_2;
// @public @deprecated (undocumented)
-export const permissionsServiceFactory: () => ServiceFactory<
+export const permissionsServiceFactory: ServiceFactoryCompat<
PermissionsService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// Warning: (ae-forgotten-export) The symbol "readCorsOptions_2" needs to be exported by the entry point index.d.ts
@@ -251,9 +285,12 @@ export interface RootConfigFactoryOptions {
}
// @public @deprecated (undocumented)
-export const rootConfigServiceFactory: (
- options?: RootConfigFactoryOptions | undefined,
-) => ServiceFactory;
+export const rootConfigServiceFactory: ServiceFactoryCompat<
+ RootConfigService,
+ 'root',
+ 'singleton',
+ RootConfigFactoryOptions
+>;
// Warning: (ae-forgotten-export) The symbol "RootHttpRouterConfigureContext_2" needs to be exported by the entry point index.d.ts
//
@@ -266,44 +303,57 @@ export type RootHttpRouterConfigureContext = RootHttpRouterConfigureContext_2;
export type RootHttpRouterFactoryOptions = RootHttpRouterFactoryOptions_2;
// @public @deprecated (undocumented)
-export const rootHttpRouterServiceFactory: (
+export const rootHttpRouterServiceFactory: ((
options?: RootHttpRouterFactoryOptions_2 | undefined,
-) => ServiceFactory;
+) => ServiceFactory) &
+ ServiceFactory;
// @public @deprecated
-export const rootLifecycleServiceFactory: () => ServiceFactory<
+export const rootLifecycleServiceFactory: ServiceFactoryCompat<
RootLifecycleService,
- 'root'
+ 'root',
+ 'singleton',
+ undefined
>;
// @public @deprecated
-export const rootLoggerServiceFactory: () => ServiceFactory<
+export const rootLoggerServiceFactory: ServiceFactoryCompat<
RootLoggerService,
- 'root'
+ 'root',
+ 'singleton',
+ undefined
>;
// @public @deprecated (undocumented)
-export const schedulerServiceFactory: () => ServiceFactory<
+export const schedulerServiceFactory: ServiceFactoryCompat<
SchedulerService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// @public @deprecated (undocumented)
-export const tokenManagerServiceFactory: () => ServiceFactory<
+export const tokenManagerServiceFactory: ServiceFactoryCompat<
TokenManagerService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// @public @deprecated (undocumented)
-export const urlReaderServiceFactory: () => ServiceFactory<
+export const urlReaderServiceFactory: ServiceFactoryCompat<
UrlReaderService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// @public @deprecated (undocumented)
-export const userInfoServiceFactory: () => ServiceFactory<
+export const userInfoServiceFactory: ServiceFactoryCompat<
UserInfoService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// @public @deprecated
diff --git a/packages/backend-app-api/config.d.ts b/packages/backend-app-api/config.d.ts
index a23bca447b..e94da62b77 100644
--- a/packages/backend-app-api/config.d.ts
+++ b/packages/backend-app-api/config.d.ts
@@ -287,6 +287,7 @@ export interface Config {
}
>;
};
+ packages?: 'all' | { include?: string[]; exclude?: string[] };
};
/** Discovery options. */
diff --git a/packages/backend-app-api/package.json b/packages/backend-app-api/package.json
index 4d3ffd874f..e809d1c2f0 100644
--- a/packages/backend-app-api/package.json
+++ b/packages/backend-app-api/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/backend-app-api",
- "version": "0.7.10-next.1",
+ "version": "0.8.1-next.2",
"description": "Core API used by Backstage backend apps",
"backstage": {
"role": "node-library"
@@ -79,7 +79,7 @@
"minimatch": "^9.0.0",
"minimist": "^1.2.5",
"morgan": "^1.10.0",
- "node-fetch": "^2.6.7",
+ "node-fetch": "^2.7.0",
"node-forge": "^1.3.1",
"path-to-regexp": "^6.2.1",
"selfsigned": "^2.0.0",
diff --git a/packages/backend-app-api/src/wiring/BackendInitializer.test.ts b/packages/backend-app-api/src/wiring/BackendInitializer.test.ts
index 3bbef5a4c0..6f60d65861 100644
--- a/packages/backend-app-api/src/wiring/BackendInitializer.test.ts
+++ b/packages/backend-app-api/src/wiring/BackendInitializer.test.ts
@@ -24,6 +24,7 @@ import {
createBackendPlugin,
createBackendModule,
createExtensionPoint,
+ createBackendFeatureLoader,
} from '@backstage/backend-plugin-api';
import { BackendInitializer } from './BackendInitializer';
@@ -105,6 +106,128 @@ describe('BackendInitializer', () => {
expect(factory3).not.toHaveBeenCalled();
});
+ it('should discover features from feature loader', async () => {
+ const ref1 = createServiceRef<{ x: number }>({
+ id: '1',
+ scope: 'root',
+ });
+ const ref2 = createServiceRef<{ x: number }>({
+ id: '2',
+ scope: 'plugin',
+ });
+ const factory1 = jest.fn();
+ const factory2 = jest.fn();
+
+ const pluginInit = jest.fn(async () => {});
+ const moduleInit = jest.fn(async () => {});
+
+ const init = new BackendInitializer(baseFactories);
+ init.add(
+ createBackendFeatureLoader({
+ *loader() {
+ yield createServiceFactory({
+ service: ref1,
+ deps: {},
+ factory: factory1,
+ });
+ yield createServiceFactory({
+ service: ref2,
+ initialization: 'always',
+ deps: {},
+ factory: factory2,
+ });
+ yield createBackendPlugin({
+ pluginId: 'test',
+ register(reg) {
+ reg.registerInit({
+ deps: {},
+ init: pluginInit,
+ });
+ },
+ });
+ yield createBackendModule({
+ pluginId: 'test',
+ moduleId: 'tester',
+ register(reg) {
+ reg.registerInit({
+ deps: {},
+ init: moduleInit,
+ });
+ },
+ });
+ },
+ }),
+ );
+ await init.start();
+
+ expect(factory1).toHaveBeenCalled();
+ expect(factory2).toHaveBeenCalled();
+ expect(pluginInit).toHaveBeenCalled();
+ expect(moduleInit).toHaveBeenCalled();
+ });
+
+ it('should refuse to override already initialized services through loaded features', async () => {
+ const ref1 = createServiceRef<{ x: number }>({
+ id: '1',
+ scope: 'root',
+ });
+
+ const init = new BackendInitializer([
+ ...baseFactories,
+ createServiceFactory({
+ service: ref1,
+ deps: {},
+ factory: () => ({ x: 1 }),
+ }),
+ ]);
+ init.add(
+ createBackendFeatureLoader({
+ deps: { service1: ref1 },
+ *loader() {
+ yield createServiceFactory({
+ service: ref1,
+ deps: {},
+ factory: jest.fn(),
+ });
+ },
+ }),
+ );
+ await expect(init.start()).rejects.toThrow(
+ 'Unable to set service factory with id 1, service has already been instantiated',
+ );
+ });
+
+ it('should refuse feature loader that depends on a plugin scoped service', async () => {
+ const ref1 = createServiceRef<{ x: number }>({
+ id: '1',
+ });
+
+ const init = new BackendInitializer([
+ ...baseFactories,
+ createServiceFactory({
+ service: ref1,
+ deps: {},
+ factory: () => ({ x: 1 }),
+ }),
+ ]);
+ init.add(
+ createBackendFeatureLoader({
+ // @ts-expect-error
+ deps: { service1: ref1 },
+ *loader() {
+ yield createServiceFactory({
+ service: ref1,
+ deps: {},
+ factory: jest.fn(),
+ });
+ },
+ }),
+ );
+ await expect(init.start()).rejects.toThrow(
+ /^Feature loaders can only depend on root scoped services, but 'service1' is scoped to 'plugin'. Offending loader is created at '.*'$/,
+ );
+ });
+
it('should initialize plugin scoped services with eager initialization', async () => {
const ref1 = createServiceRef<{ x: number }>({
id: '1',
diff --git a/packages/backend-app-api/src/wiring/BackendInitializer.ts b/packages/backend-app-api/src/wiring/BackendInitializer.ts
index ddad94de14..c0da9eda62 100644
--- a/packages/backend-app-api/src/wiring/BackendInitializer.ts
+++ b/packages/backend-app-api/src/wiring/BackendInitializer.ts
@@ -25,8 +25,14 @@ import {
} from '@backstage/backend-plugin-api';
import { ServiceOrExtensionPoint } from './types';
// Direct internal import to avoid duplication
-// eslint-disable-next-line @backstage/no-forbidden-package-imports
-import { InternalBackendFeature } from '@backstage/backend-plugin-api/src/wiring/types';
+// eslint-disable-next-line @backstage/no-relative-monorepo-imports
+import type {
+ InternalBackendFeature,
+ InternalBackendFeatureLoader,
+ InternalBackendRegistrations,
+} from '../../../backend-plugin-api/src/wiring/types';
+// eslint-disable-next-line @backstage/no-relative-monorepo-imports
+import type { InternalServiceFactory } from '../../../backend-plugin-api/src/services/system/types';
import { ForwardedError, ConflictError } from '@backstage/errors';
import { featureDiscoveryServiceRef } from '@backstage/backend-plugin-api/alpha';
import { DependencyGraph } from '../lib/DependencyGraph';
@@ -44,10 +50,11 @@ export interface BackendRegisterInit {
export class BackendInitializer {
#startPromise?: Promise;
- #features = new Array();
+ #registrations = new Array();
#extensionPoints = new Map();
#serviceRegistry: ServiceRegistry;
#registeredFeatures = new Array>();
+ #registeredFeatureLoaders = new Array();
constructor(defaultApiFactories: ServiceFactory[]) {
this.#serviceRegistry = ServiceRegistry.create([...defaultApiFactories]);
@@ -101,21 +108,12 @@ export class BackendInitializer {
}
#addFeature(feature: BackendFeature) {
- if (feature.$$type !== '@backstage/BackendFeature') {
- throw new Error(
- `Failed to add feature, invalid type '${feature.$$type}'`,
- );
- }
-
if (isServiceFactory(feature)) {
this.#serviceRegistry.add(feature);
- } else if (isInternalBackendFeature(feature)) {
- if (feature.version !== 'v1') {
- throw new Error(
- `Failed to add feature, invalid version '${feature.version}'`,
- );
- }
- this.#features.push(feature);
+ } else if (isBackendFeatureLoader(feature)) {
+ this.#registeredFeatureLoaders.push(feature);
+ } else if (isBackendRegistrations(feature)) {
+ this.#registrations.push(feature);
} else {
throw new Error(
`Failed to add feature, invalid feature ${JSON.stringify(feature)}`,
@@ -170,14 +168,16 @@ export class BackendInitializer {
this.#serviceRegistry.checkForCircularDeps();
}
+ await this.#applyBackendFeatureLoaders(this.#registeredFeatureLoaders);
+
// Initialize all root scoped services
await this.#serviceRegistry.initializeEagerServicesWithScope('root');
const pluginInits = new Map();
const moduleInits = new Map>();
- // Enumerate all features
- for (const feature of this.#features) {
+ // Enumerate all registrations
+ for (const feature of this.#registrations) {
for (const r of feature.getRegistrations()) {
const provides = new Set>();
@@ -205,7 +205,7 @@ export class BackendInitializer {
consumes: new Set(Object.values(r.init.deps)),
init: r.init,
});
- } else {
+ } else if (r.type === 'module') {
let modules = moduleInits.get(r.pluginId);
if (!modules) {
modules = new Map();
@@ -221,6 +221,8 @@ export class BackendInitializer {
consumes: new Set(Object.values(r.init.deps)),
init: r.init,
});
+ } else {
+ throw new Error(`Invalid registration type '${(r as any).type}'`);
}
}
}
@@ -383,16 +385,109 @@ export class BackendInitializer {
throw new Error('Unexpected plugin lifecycle service implementation');
}
+
+ async #applyBackendFeatureLoaders(loaders: InternalBackendFeatureLoader[]) {
+ for (const loader of loaders) {
+ const deps = new Map();
+ const missingRefs = new Set();
+
+ for (const [name, ref] of Object.entries(loader.deps ?? {})) {
+ if (ref.scope !== 'root') {
+ throw new Error(
+ `Feature loaders can only depend on root scoped services, but '${name}' is scoped to '${ref.scope}'. Offending loader is ${loader.description}`,
+ );
+ }
+ const impl = await this.#serviceRegistry.get(
+ ref as ServiceRef,
+ 'root',
+ );
+ if (impl) {
+ deps.set(name, impl);
+ } else {
+ missingRefs.add(ref);
+ }
+ }
+
+ if (missingRefs.size > 0) {
+ const missing = Array.from(missingRefs).join(', ');
+ throw new Error(
+ `No service available for the following ref(s): ${missing}, depended on by feature loader ${loader.description}`,
+ );
+ }
+
+ const result = await loader
+ .loader(Object.fromEntries(deps))
+ .catch(error => {
+ throw new ForwardedError(
+ `Feature loader ${loader.description} failed`,
+ error,
+ );
+ });
+
+ let didAddServiceFactory = false;
+ const newLoaders = new Array();
+
+ for await (const feature of result) {
+ if (isBackendFeatureLoader(feature)) {
+ newLoaders.push(feature);
+ } else {
+ didAddServiceFactory ||= isServiceFactory(feature);
+ this.#addFeature(feature);
+ }
+ }
+
+ // Every time we add a new service factory we need to make sure that we don't have circular dependencies
+ if (didAddServiceFactory) {
+ this.#serviceRegistry.checkForCircularDeps();
+ }
+
+ // Apply loaders recursively, depth-first
+ if (newLoaders.length > 0) {
+ await this.#applyBackendFeatureLoaders(newLoaders);
+ }
+ }
+ }
}
-function isServiceFactory(feature: BackendFeature): feature is ServiceFactory {
- return !!(feature as ServiceFactory).service;
-}
-
-function isInternalBackendFeature(
+function toInternalBackendFeature(
feature: BackendFeature,
-): feature is InternalBackendFeature {
- return (
- typeof (feature as InternalBackendFeature).getRegistrations === 'function'
- );
+): InternalBackendFeature {
+ if (feature.$$type !== '@backstage/BackendFeature') {
+ throw new Error(`Invalid BackendFeature, bad type '${feature.$$type}'`);
+ }
+ const internal = feature as InternalBackendFeature;
+ if (internal.version !== 'v1') {
+ throw new Error(
+ `Invalid BackendFeature, bad version '${internal.version}'`,
+ );
+ }
+ return internal;
+}
+
+function isServiceFactory(
+ feature: BackendFeature,
+): feature is InternalServiceFactory {
+ const internal = toInternalBackendFeature(feature);
+ if (internal.featureType === 'service') {
+ return true;
+ }
+ // Backwards compatibility for v1 registrations that use duck typing
+ return 'service' in internal;
+}
+
+function isBackendRegistrations(
+ feature: BackendFeature,
+): feature is InternalBackendRegistrations {
+ const internal = toInternalBackendFeature(feature);
+ if (internal.featureType === 'registrations') {
+ return true;
+ }
+ // Backwards compatibility for v1 registrations that use duck typing
+ return 'getRegistrations' in internal;
+}
+
+function isBackendFeatureLoader(
+ feature: BackendFeature,
+): feature is InternalBackendFeatureLoader {
+ return toInternalBackendFeature(feature).featureType === 'loader';
}
diff --git a/packages/backend-app-api/src/wiring/ServiceRegistry.ts b/packages/backend-app-api/src/wiring/ServiceRegistry.ts
index 6e20dd98e8..0abd5605ae 100644
--- a/packages/backend-app-api/src/wiring/ServiceRegistry.ts
+++ b/packages/backend-app-api/src/wiring/ServiceRegistry.ts
@@ -48,22 +48,34 @@ function toInternalServiceFactory(
return f;
}
-const pluginMetadataServiceFactory = createServiceFactory(
- (options?: { pluginId: string }) => ({
+function createPluginMetadataServiceFactory(pluginId: string) {
+ return createServiceFactory({
service: coreServices.pluginMetadata,
deps: {},
- factory: async () => ({ getId: () => options?.pluginId! }),
- }),
-);
+ factory: async () => ({ getId: () => pluginId }),
+ });
+}
export class ServiceRegistry {
static create(factories: Array): ServiceRegistry {
- const registry = new ServiceRegistry(factories);
+ const factoryMap = new Map();
+ for (const factory of factories) {
+ if (factory.service.multiton) {
+ const existing = factoryMap.get(factory.service.id) ?? [];
+ factoryMap.set(
+ factory.service.id,
+ existing.concat(toInternalServiceFactory(factory)),
+ );
+ } else {
+ factoryMap.set(factory.service.id, [toInternalServiceFactory(factory)]);
+ }
+ }
+ const registry = new ServiceRegistry(factoryMap);
registry.checkForCircularDeps();
return registry;
}
- readonly #providedFactories: Map;
+ readonly #providedFactories: Map;
readonly #loadedDefaultFactories: Map<
Function,
Promise
@@ -82,10 +94,8 @@ export class ServiceRegistry {
readonly #addedFactoryIds = new Set();
readonly #instantiatedFactories = new Set();
- private constructor(factories: Array) {
- this.#providedFactories = new Map(
- factories.map(sf => [sf.service.id, toInternalServiceFactory(sf)]),
- );
+ private constructor(factories: Map) {
+ this.#providedFactories = factories;
this.#loadedDefaultFactories = new Map();
this.#implementations = new Map();
}
@@ -93,17 +103,17 @@ export class ServiceRegistry {
#resolveFactory(
ref: ServiceRef,
pluginId: string,
- ): Promise | undefined {
+ ): Promise | undefined {
// Special case handling of the plugin metadata service, generating a custom factory for it each time
if (ref.id === coreServices.pluginMetadata.id) {
- return Promise.resolve(
- toInternalServiceFactory(pluginMetadataServiceFactory({ pluginId })),
- );
+ return Promise.resolve([
+ toInternalServiceFactory(createPluginMetadataServiceFactory(pluginId)),
+ ]);
}
let resolvedFactory:
- | Promise
- | InternalServiceFactory
+ | Promise
+ | InternalServiceFactory[]
| undefined = this.#providedFactories.get(ref.id);
const { __defaultFactory: defaultFactory } = ref as InternalServiceRef;
if (!resolvedFactory && !defaultFactory) {
@@ -120,15 +130,18 @@ export class ServiceRegistry {
);
this.#loadedDefaultFactories.set(defaultFactory!, loadedFactory);
}
- resolvedFactory = loadedFactory.catch(error => {
- throw new Error(
- `Failed to instantiate service '${
- ref.id
- }' because the default factory loader threw an error, ${stringifyError(
- error,
- )}`,
- );
- });
+ resolvedFactory = loadedFactory.then(
+ factory => [factory],
+ error => {
+ throw new Error(
+ `Failed to instantiate service '${
+ ref.id
+ }' because the default factory loader threw an error, ${stringifyError(
+ error,
+ )}`,
+ );
+ },
+ );
}
return Promise.resolve(resolvedFactory);
@@ -142,6 +155,9 @@ export class ServiceRegistry {
if (this.#providedFactories.get(ref.id)) {
return false;
}
+ if (ref.multiton) {
+ return false;
+ }
return !(ref as InternalServiceRef).__defaultFactory;
});
@@ -156,13 +172,13 @@ export class ServiceRegistry {
checkForCircularDeps(): void {
const graph = DependencyGraph.fromIterable(
- Array.from(this.#providedFactories).map(
- ([serviceId, serviceFactory]) => ({
- value: serviceId,
- provides: [serviceId],
- consumes: Object.values(serviceFactory.deps).map(d => d.id),
- }),
- ),
+ Array.from(this.#providedFactories).map(([serviceId, factories]) => ({
+ value: serviceId,
+ provides: [serviceId],
+ consumes: factories.flatMap(factory =>
+ Object.values(factory.deps).map(d => d.id),
+ ),
+ })),
);
const circularDependencies = Array.from(graph.detectCircularDependencies());
@@ -183,27 +199,36 @@ export class ServiceRegistry {
);
}
- if (this.#addedFactoryIds.has(factoryId)) {
- throw new Error(
- `Duplicate service implementations provided for ${factoryId}`,
- );
- }
-
if (this.#instantiatedFactories.has(factoryId)) {
throw new Error(
`Unable to set service factory with id ${factoryId}, service has already been instantiated`,
);
}
- this.#addedFactoryIds.add(factoryId);
- this.#providedFactories.set(factoryId, toInternalServiceFactory(factory));
+ if (factory.service.multiton) {
+ const newFactories = (
+ this.#providedFactories.get(factoryId) ?? []
+ ).concat(toInternalServiceFactory(factory));
+ this.#providedFactories.set(factoryId, newFactories);
+ } else {
+ if (this.#addedFactoryIds.has(factoryId)) {
+ throw new Error(
+ `Duplicate service implementations provided for ${factoryId}`,
+ );
+ }
+
+ this.#addedFactoryIds.add(factoryId);
+ this.#providedFactories.set(factoryId, [
+ toInternalServiceFactory(factory),
+ ]);
+ }
}
async initializeEagerServicesWithScope(
scope: 'root' | 'plugin',
pluginId: string = 'root',
) {
- for (const factory of this.#providedFactories.values()) {
+ for (const [factory] of this.#providedFactories.values()) {
if (factory.service.scope === scope) {
// Root-scoped services are eager by default, plugin-scoped are lazy by default
if (scope === 'root' && factory.initialization !== 'lazy') {
@@ -215,88 +240,112 @@ export class ServiceRegistry {
}
}
- get(ref: ServiceRef, pluginId: string): Promise | undefined {
+ get(
+ ref: ServiceRef,
+ pluginId: string,
+ ): Promise | undefined {
this.#instantiatedFactories.add(ref.id);
- return this.#resolveFactory(ref, pluginId)?.then(factory => {
- if (factory.service.scope === 'root') {
- let existing = this.#rootServiceImplementations.get(factory);
- if (!existing) {
- this.#checkForMissingDeps(factory, pluginId);
- const rootDeps = new Array>();
+ const resolvedFactory = this.#resolveFactory(ref, pluginId);
- for (const [name, serviceRef] of Object.entries(factory.deps)) {
- if (serviceRef.scope !== 'root') {
- throw new Error(
- `Failed to instantiate 'root' scoped service '${ref.id}' because it depends on '${serviceRef.scope}' scoped service '${serviceRef.id}'.`,
- );
+ if (!resolvedFactory) {
+ return ref.multiton
+ ? (Promise.resolve([]) as
+ | Promise
+ | undefined)
+ : undefined;
+ }
+
+ return resolvedFactory
+ .then(factories => {
+ return Promise.all(
+ factories.map(factory => {
+ if (factory.service.scope === 'root') {
+ let existing = this.#rootServiceImplementations.get(factory);
+ if (!existing) {
+ this.#checkForMissingDeps(factory, pluginId);
+ const rootDeps = new Array<
+ Promise<[name: string, impl: unknown]>
+ >();
+
+ for (const [name, serviceRef] of Object.entries(factory.deps)) {
+ if (serviceRef.scope !== 'root') {
+ throw new Error(
+ `Failed to instantiate 'root' scoped service '${ref.id}' because it depends on '${serviceRef.scope}' scoped service '${serviceRef.id}'.`,
+ );
+ }
+ const target = this.get(serviceRef, pluginId)!;
+ rootDeps.push(target.then(impl => [name, impl]));
+ }
+
+ existing = Promise.all(rootDeps).then(entries =>
+ factory.factory(Object.fromEntries(entries), undefined),
+ );
+ this.#rootServiceImplementations.set(factory, existing);
+ }
+ return existing as Promise;
}
- const target = this.get(serviceRef, pluginId)!;
- rootDeps.push(target.then(impl => [name, impl]));
- }
- existing = Promise.all(rootDeps).then(entries =>
- factory.factory(Object.fromEntries(entries), undefined),
- );
- this.#rootServiceImplementations.set(factory, existing);
- }
- return existing as Promise;
- }
+ let implementation = this.#implementations.get(factory);
+ if (!implementation) {
+ this.#checkForMissingDeps(factory, pluginId);
+ const rootDeps = new Array<
+ Promise<[name: string, impl: unknown]>
+ >();
- let implementation = this.#implementations.get(factory);
- if (!implementation) {
- this.#checkForMissingDeps(factory, pluginId);
- const rootDeps = new Array>();
+ for (const [name, serviceRef] of Object.entries(factory.deps)) {
+ if (serviceRef.scope === 'root') {
+ const target = this.get(serviceRef, pluginId)!;
+ rootDeps.push(target.then(impl => [name, impl]));
+ }
+ }
- for (const [name, serviceRef] of Object.entries(factory.deps)) {
- if (serviceRef.scope === 'root') {
- const target = this.get(serviceRef, pluginId)!;
- rootDeps.push(target.then(impl => [name, impl]));
- }
- }
+ implementation = {
+ context: Promise.all(rootDeps)
+ .then(entries =>
+ factory.createRootContext?.(Object.fromEntries(entries)),
+ )
+ .catch(error => {
+ const cause = stringifyError(error);
+ throw new Error(
+ `Failed to instantiate service '${ref.id}' because createRootContext threw an error, ${cause}`,
+ );
+ }),
+ byPlugin: new Map(),
+ };
- implementation = {
- context: Promise.all(rootDeps)
- .then(entries =>
- factory.createRootContext?.(Object.fromEntries(entries)),
- )
- .catch(error => {
- const cause = stringifyError(error);
- throw new Error(
- `Failed to instantiate service '${ref.id}' because createRootContext threw an error, ${cause}`,
- );
- }),
- byPlugin: new Map(),
- };
+ this.#implementations.set(factory, implementation);
+ }
- this.#implementations.set(factory, implementation);
- }
+ let result = implementation.byPlugin.get(pluginId) as Promise;
+ if (!result) {
+ const allDeps = new Array<
+ Promise<[name: string, impl: unknown]>
+ >();
- let result = implementation.byPlugin.get(pluginId) as Promise;
- if (!result) {
- const allDeps = new Array>();
+ for (const [name, serviceRef] of Object.entries(factory.deps)) {
+ const target = this.get(serviceRef, pluginId)!;
+ allDeps.push(target.then(impl => [name, impl]));
+ }
- for (const [name, serviceRef] of Object.entries(factory.deps)) {
- const target = this.get(serviceRef, pluginId)!;
- allDeps.push(target.then(impl => [name, impl]));
- }
-
- result = implementation.context
- .then(context =>
- Promise.all(allDeps).then(entries =>
- factory.factory(Object.fromEntries(entries), context),
- ),
- )
- .catch(error => {
- const cause = stringifyError(error);
- throw new Error(
- `Failed to instantiate service '${ref.id}' for '${pluginId}' because the factory function threw an error, ${cause}`,
- );
- });
- implementation.byPlugin.set(pluginId, result);
- }
-
- return result;
- });
+ result = implementation.context
+ .then(context =>
+ Promise.all(allDeps).then(entries =>
+ factory.factory(Object.fromEntries(entries), context),
+ ),
+ )
+ .catch(error => {
+ const cause = stringifyError(error);
+ throw new Error(
+ `Failed to instantiate service '${ref.id}' for '${pluginId}' because the factory function threw an error, ${cause}`,
+ );
+ });
+ implementation.byPlugin.set(pluginId, result);
+ }
+ return result;
+ }),
+ );
+ })
+ .then(results => (ref.multiton ? results : results[0]));
}
}
diff --git a/packages/backend-app-api/src/wiring/createSpecializedBackend.ts b/packages/backend-app-api/src/wiring/createSpecializedBackend.ts
index f5c4d8b152..fd449be541 100644
--- a/packages/backend-app-api/src/wiring/createSpecializedBackend.ts
+++ b/packages/backend-app-api/src/wiring/createSpecializedBackend.ts
@@ -24,13 +24,9 @@ import { Backend, CreateSpecializedBackendOptions } from './types';
export function createSpecializedBackend(
options: CreateSpecializedBackendOptions,
): Backend {
- const services = options.defaultServiceFactories.map(sf =>
- typeof sf === 'function' ? sf() : sf,
- );
-
const exists = new Set();
const duplicates = new Set();
- for (const { service } of services) {
+ for (const { service } of options.defaultServiceFactories) {
if (exists.has(service.id)) {
duplicates.add(service.id);
} else {
@@ -47,5 +43,5 @@ export function createSpecializedBackend(
);
}
- return new BackstageBackend(services);
+ return new BackstageBackend(options.defaultServiceFactories);
}
diff --git a/packages/backend-app-api/src/wiring/types.ts b/packages/backend-app-api/src/wiring/types.ts
index 027b2bf254..075eb58b3f 100644
--- a/packages/backend-app-api/src/wiring/types.ts
+++ b/packages/backend-app-api/src/wiring/types.ts
@@ -18,18 +18,25 @@ import {
BackendFeature,
ExtensionPoint,
ServiceRef,
- ServiceFactoryOrFunction,
+ ServiceFactory,
} from '@backstage/backend-plugin-api';
/**
* @public
*/
export interface Backend {
+ add(feature: BackendFeature | Promise<{ default: BackendFeature }>): void;
+ /**
+ * @deprecated The ability to add features defined as a callback is being
+ * removed. Please update the installed feature to no longer be defined as a
+ * callback, typically this means updating it to use the latest version of
+ * `@backstage/backend-plugin-api`. If the feature is from a third-party
+ * package, please reach out to the package maintainer to update it.
+ */
add(
feature:
- | BackendFeature
| (() => BackendFeature)
- | Promise<{ default: BackendFeature | (() => BackendFeature) }>,
+ | Promise<{ default: () => BackendFeature }>,
): void;
start(): Promise;
stop(): Promise;
@@ -39,7 +46,7 @@ export interface Backend {
* @public
*/
export interface CreateSpecializedBackendOptions {
- defaultServiceFactories: ServiceFactoryOrFunction[];
+ defaultServiceFactories: ServiceFactory[];
}
/**
diff --git a/packages/backend-common/CHANGELOG.md b/packages/backend-common/CHANGELOG.md
index d144d461b8..5eadae4c0f 100644
--- a/packages/backend-common/CHANGELOG.md
+++ b/packages/backend-common/CHANGELOG.md
@@ -1,5 +1,87 @@
# @backstage/backend-common
+## 0.23.4-next.2
+
+### Patch Changes
+
+- 93095ee: Make sure node-fetch is version 2.7.0 or greater
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.8.0-next.2
+ - @backstage/config-loader@1.9.0-next.2
+ - @backstage/plugin-auth-node@0.5.0-next.2
+ - @backstage/integration@1.14.0-next.0
+ - @backstage/integration-aws-node@0.1.12
+ - @backstage/backend-dev-utils@0.1.4
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+
+## 0.23.4-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/config-loader@1.9.0-next.1
+ - @backstage/backend-plugin-api@0.7.1-next.1
+ - @backstage/integration@1.14.0-next.0
+ - @backstage/integration-aws-node@0.1.12
+ - @backstage/backend-dev-utils@0.1.4
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.4.18-next.1
+
+## 0.23.4-next.0
+
+### Patch Changes
+
+- ba8571e: Setup user agent header for AWS sdk clients, this enables users to better track API calls made from Backstage to AWS APIs through things like CloudTrail.
+- 7e13b7a: The remaining exports in the package have now been deprecated:
+
+ - `cacheToPluginCacheManager`
+ - `createLegacyAuthAdapters`
+ - `LegacyCreateRouter`
+ - `legacyPlugin`
+ - `loggerToWinstonLogger`
+ - `makeLegacyPlugin`
+
+ Users of these export should fully [migrate to the new backend system](https://backstage.io/docs/backend-system/building-backends/migrating).
+
+- Updated dependencies
+ - @backstage/integration@1.14.0-next.0
+ - @backstage/config-loader@1.8.2-next.0
+ - @backstage/backend-dev-utils@0.1.4
+ - @backstage/backend-plugin-api@0.7.1-next.0
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/integration-aws-node@0.1.12
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.4.18-next.0
+
+## 0.23.3
+
+### Patch Changes
+
+- 8c09c97: Deprecate legacy status check factory, handler and types.
+- d228862: Update default backend plugin created by the cli to use non-deprecated error handling middleware
+- c964a3d: Add dependencies that are needed by cross-imports from backend-defaults
+- b60db08: Fixing exporting of classes properly from new packages
+- b9ed1bb: bumped better-sqlite3 from ^9.0.0 to ^11.0.0
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.7.0
+ - @backstage/integration@1.13.0
+ - @backstage/plugin-auth-node@0.4.17
+ - @backstage/config-loader@1.8.1
+ - @backstage/backend-dev-utils@0.1.4
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/integration-aws-node@0.1.12
+ - @backstage/types@1.1.1
+
## 0.23.3-next.1
### Patch Changes
diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md
index 52b661bcaf..23ed13b62c 100644
--- a/packages/backend-common/api-report.md
+++ b/packages/backend-common/api-report.md
@@ -129,7 +129,7 @@ export class CacheManager extends CacheManager_2 {}
// @public @deprecated (undocumented)
export type CacheManagerOptions = CacheManagerOptions_2;
-// @public
+// @public @deprecated
export function cacheToPluginCacheManager(cache: CacheService): {
getClient(options?: CacheServiceOptions): CacheService;
};
@@ -142,7 +142,7 @@ export interface ContainerRunner {
runContainer(opts: RunContainerOptions): Promise;
}
-// @public
+// @public @deprecated
export function createLegacyAuthAdapters<
TOptions extends {
auth?: AuthService;
@@ -401,10 +401,10 @@ export type KubernetesContainerRunnerOptions = {
timeoutMs?: number;
};
-// @public (undocumented)
+// @public @deprecated (undocumented)
export type LegacyCreateRouter = (deps: TEnv) => Promise;
-// @public
+// @public @deprecated
export const legacyPlugin: (
name: string,
createRouterImport: Promise<{
@@ -447,13 +447,13 @@ export function loadBackendConfig(options: {
watch?: boolean;
}): Promise;
-// @public (undocumented)
+// @public @deprecated (undocumented)
export function loggerToWinstonLogger(
logger: LoggerService,
opts?: TransportStreamOptions,
): Logger;
-// @public
+// @public @deprecated
export function makeLegacyPlugin<
TEnv extends Record,
TEnvTransforms extends {
diff --git a/packages/backend-common/package.json b/packages/backend-common/package.json
index f23f0d2ce9..ccf44fba0f 100644
--- a/packages/backend-common/package.json
+++ b/packages/backend-common/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/backend-common",
- "version": "0.23.3-next.1",
+ "version": "0.23.4-next.2",
"description": "Common functionality library for Backstage backends",
"backstage": {
"role": "node-library"
@@ -102,7 +102,7 @@
"minimist": "^1.2.5",
"morgan": "^1.10.0",
"mysql2": "^3.0.0",
- "node-fetch": "^2.6.7",
+ "node-fetch": "^2.7.0",
"node-forge": "^1.3.1",
"p-limit": "^3.1.0",
"path-to-regexp": "^6.2.1",
diff --git a/packages/backend-common/src/compat/auth/createLegacyAuthAdapters.ts b/packages/backend-common/src/compat/auth/createLegacyAuthAdapters.ts
index 0f591eac6c..15cd881649 100644
--- a/packages/backend-common/src/compat/auth/createLegacyAuthAdapters.ts
+++ b/packages/backend-common/src/compat/auth/createLegacyAuthAdapters.ts
@@ -292,6 +292,7 @@ export class UserInfoCompat implements UserInfoService {
/**
* An adapter that ensures presence of the auth and/or httpAuth services.
* @public
+ * @deprecated Migrate to use the new backend system and auth services instead.
*/
export function createLegacyAuthAdapters<
TOptions extends {
diff --git a/packages/backend-common/src/compat/cache/cacheToPluginCacheManager.ts b/packages/backend-common/src/compat/cache/cacheToPluginCacheManager.ts
index 2654934804..2ae55b016f 100644
--- a/packages/backend-common/src/compat/cache/cacheToPluginCacheManager.ts
+++ b/packages/backend-common/src/compat/cache/cacheToPluginCacheManager.ts
@@ -24,6 +24,7 @@ import {
* old-backend plugin cache manager.
*
* @public
+ * @deprecated Migrate to use the new CacheService instead.
*/
export function cacheToPluginCacheManager(cache: CacheService): {
getClient(options?: CacheServiceOptions): CacheService;
diff --git a/packages/backend-common/src/compat/legacy/legacy.ts b/packages/backend-common/src/compat/legacy/legacy.ts
index 57220a8430..c779daacd2 100644
--- a/packages/backend-common/src/compat/legacy/legacy.ts
+++ b/packages/backend-common/src/compat/legacy/legacy.ts
@@ -27,6 +27,7 @@ import { TokenManager } from '../../deprecated';
/**
* @public
+ * @deprecated Fully use the new backend system instead.
*/
export type LegacyCreateRouter = (deps: TEnv) => Promise;
@@ -69,6 +70,7 @@ function wrapTokenManager(tokenManager: TokenManager, auth: AuthService) {
* Creates a new custom plugin compatibility wrapper.
*
* @public
+ * @deprecated Fully use the new backend system instead.
* @remarks
*
* Usually you can use {@link legacyPlugin} directly instead, but you might
@@ -128,6 +130,7 @@ export function makeLegacyPlugin<
* register it with the http router based on the plugin id.
*
* @public
+ * @deprecated Fully use the new backend system instead.
* @remarks
*
* This is intended to be used by plugin authors to ease the transition to the
diff --git a/packages/backend-common/src/compat/logging/loggerToWinstonLogger.ts b/packages/backend-common/src/compat/logging/loggerToWinstonLogger.ts
index 4ba88358d2..83871f48e3 100644
--- a/packages/backend-common/src/compat/logging/loggerToWinstonLogger.ts
+++ b/packages/backend-common/src/compat/logging/loggerToWinstonLogger.ts
@@ -53,7 +53,10 @@ class BackstageLoggerTransport extends Transport {
}
}
-/** @public */
+/**
+ * @public
+ * @deprecated Migrate to use the new LoggerService instead.
+ */
export function loggerToWinstonLogger(
logger: LoggerService,
opts?: TransportStreamOptions,
diff --git a/packages/backend-defaults/CHANGELOG.md b/packages/backend-defaults/CHANGELOG.md
index a9b20bfbea..44b0a6b9b0 100644
--- a/packages/backend-defaults/CHANGELOG.md
+++ b/packages/backend-defaults/CHANGELOG.md
@@ -1,5 +1,105 @@
# @backstage/backend-defaults
+## 0.4.2-next.2
+
+### Patch Changes
+
+- 0d16b52: Add access restrictions to the JWKS external access method config schema
+- 93095ee: Make sure node-fetch is version 2.7.0 or greater
+- ba9abf4: The `SchedulerService` now allows tasks with `frequency: { trigger: 'manual' }`. This means that the task will not be scheduled, but rather run only when manually triggered with `SchedulerService.triggerTask`.
+- 7c5f3b0: Update the `UrlReader` service to depends on multiple instances of `UrlReaderFactoryProvider` service.
+- 1d5f298: Avoid excessive numbers of error listeners on cache clients
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.8.0-next.2
+ - @backstage/backend-app-api@0.8.1-next.2
+ - @backstage/backend-common@0.23.4-next.2
+ - @backstage/config-loader@1.9.0-next.2
+ - @backstage/plugin-auth-node@0.5.0-next.2
+ - @backstage/plugin-permission-node@0.8.1-next.2
+ - @backstage/plugin-events-node@0.3.9-next.2
+ - @backstage/integration@1.14.0-next.0
+ - @backstage/integration-aws-node@0.1.12
+ - @backstage/backend-dev-utils@0.1.4
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+
+## 0.4.2-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/config-loader@1.9.0-next.1
+ - @backstage/plugin-permission-node@0.8.1-next.1
+ - @backstage/backend-plugin-api@0.7.1-next.1
+ - @backstage/backend-app-api@0.8.1-next.1
+ - @backstage/backend-common@0.23.4-next.1
+ - @backstage/integration@1.14.0-next.0
+ - @backstage/integration-aws-node@0.1.12
+ - @backstage/backend-dev-utils@0.1.4
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.4.18-next.1
+ - @backstage/plugin-events-node@0.3.9-next.1
+
+## 0.4.2-next.0
+
+### Patch Changes
+
+- 4e79d19: The `createHealthRouter` utility that allows you to create a health check router is now exported via `@backstage/backend-defaults/rootHttpRouter`.
+- 78c1329: Updated `GitlabUrlReader.readUrl` and `GitlabUrlReader.readTree` to accept a user-provided token, supporting both bearer and private tokens.
+- 8e967da: Fixed the routing of the new health check service, the health endpoints should now properly be available at `/.backstage/health/v1/readiness` and `/.backstage/health/v1/liveness`.
+- Updated dependencies
+ - @backstage/backend-common@0.23.4-next.0
+ - @backstage/integration@1.14.0-next.0
+ - @backstage/config-loader@1.8.2-next.0
+ - @backstage/backend-app-api@0.8.1-next.0
+ - @backstage/backend-dev-utils@0.1.4
+ - @backstage/backend-plugin-api@0.7.1-next.0
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/integration-aws-node@0.1.12
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.4.18-next.0
+ - @backstage/plugin-events-node@0.3.9-next.0
+ - @backstage/plugin-permission-node@0.8.1-next.0
+
+## 0.4.0
+
+### Minor Changes
+
+- 1cb84d7: **BREAKING**: Removed the depreacted `getPath` option from `httpRouterServiceFactory`, as well as the `HttpRouterFactoryOptions` type.
+
+### Patch Changes
+
+- 53ced70: Added a new Root Health Service which adds new endpoints for health checks.
+- 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.
+- 083eaf9: Fix bug where ISO durations could no longer be used for schedules
+- b05e1e1: Service factories exported by this package have been updated to use the new service factory format that doesn't use a callback.
+- 419f387: Refactor of `rootHttpRouterServiceFactory` to allow it to be constructed with options, but without declaring options via `createServiceFactory`.
+- cb14a05: Repack the package to fix issues with typescript with named exports
+- b9ed1bb: bumped better-sqlite3 from ^9.0.0 to ^11.0.0
+- e28af58: Refactor of `rootConfigServiceFactory` to allow it to be constructed with options, but without declaring options via `createServiceFactory`.
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.7.0
+ - @backstage/backend-app-api@0.8.0
+ - @backstage/backend-common@0.23.3
+ - @backstage/plugin-permission-node@0.8.0
+ - @backstage/integration@1.13.0
+ - @backstage/plugin-events-node@0.3.8
+ - @backstage/plugin-auth-node@0.4.17
+ - @backstage/config-loader@1.8.1
+ - @backstage/backend-dev-utils@0.1.4
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/integration-aws-node@0.1.12
+ - @backstage/types@1.1.1
+
## 0.3.4-next.1
### Patch Changes
diff --git a/packages/backend-defaults/api-report-auth.md b/packages/backend-defaults/api-report-auth.md
index d64ce5bc2a..5ceca7f72e 100644
--- a/packages/backend-defaults/api-report-auth.md
+++ b/packages/backend-defaults/api-report-auth.md
@@ -4,10 +4,15 @@
```ts
import { AuthService } from '@backstage/backend-plugin-api';
-import { ServiceFactory } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
// @public
-export const authServiceFactory: () => ServiceFactory;
+export const authServiceFactory: ServiceFactoryCompat<
+ AuthService,
+ 'plugin',
+ 'singleton',
+ undefined
+>;
// (No @packageDocumentation comment for this package)
```
diff --git a/packages/backend-defaults/api-report-cache.md b/packages/backend-defaults/api-report-cache.md
index 0bfd7eb463..e8b6f075ab 100644
--- a/packages/backend-defaults/api-report-cache.md
+++ b/packages/backend-defaults/api-report-cache.md
@@ -7,7 +7,7 @@ import { CacheService } from '@backstage/backend-plugin-api';
import { CacheServiceOptions } from '@backstage/backend-plugin-api';
import { Config } from '@backstage/config';
import { LoggerService } from '@backstage/backend-plugin-api';
-import { ServiceFactory } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
// @public
export class CacheManager {
@@ -25,7 +25,12 @@ export type CacheManagerOptions = {
};
// @public
-export const cacheServiceFactory: () => ServiceFactory;
+export const cacheServiceFactory: ServiceFactoryCompat<
+ CacheService,
+ 'plugin',
+ 'singleton',
+ undefined
+>;
// @public (undocumented)
export interface PluginCacheManager {
diff --git a/packages/backend-defaults/api-report-database.md b/packages/backend-defaults/api-report-database.md
index 116830343a..8d204db025 100644
--- a/packages/backend-defaults/api-report-database.md
+++ b/packages/backend-defaults/api-report-database.md
@@ -8,7 +8,7 @@ import { DatabaseService } from '@backstage/backend-plugin-api';
import { LifecycleService } from '@backstage/backend-plugin-api';
import { LoggerService } from '@backstage/backend-plugin-api';
import { PluginMetadataService } from '@backstage/backend-plugin-api';
-import { ServiceFactory } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
// @public
export class DatabaseManager implements LegacyRootDatabaseService {
@@ -32,9 +32,11 @@ export type DatabaseManagerOptions = {
};
// @public
-export const databaseServiceFactory: () => ServiceFactory<
+export const databaseServiceFactory: ServiceFactoryCompat<
DatabaseService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// @public @deprecated
diff --git a/packages/backend-defaults/api-report-discovery.md b/packages/backend-defaults/api-report-discovery.md
index b434dab6fc..1b19a42aa5 100644
--- a/packages/backend-defaults/api-report-discovery.md
+++ b/packages/backend-defaults/api-report-discovery.md
@@ -5,12 +5,14 @@
```ts
import { Config } from '@backstage/config';
import { DiscoveryService } from '@backstage/backend-plugin-api';
-import { ServiceFactory } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
// @public
-export const discoveryServiceFactory: () => ServiceFactory<
+export const discoveryServiceFactory: ServiceFactoryCompat<
DiscoveryService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// @public
diff --git a/packages/backend-defaults/api-report-httpAuth.md b/packages/backend-defaults/api-report-httpAuth.md
index 6ffe3d6539..a65a6e157d 100644
--- a/packages/backend-defaults/api-report-httpAuth.md
+++ b/packages/backend-defaults/api-report-httpAuth.md
@@ -4,12 +4,14 @@
```ts
import { HttpAuthService } from '@backstage/backend-plugin-api';
-import { ServiceFactory } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
// @public
-export const httpAuthServiceFactory: () => ServiceFactory<
+export const httpAuthServiceFactory: ServiceFactoryCompat<
HttpAuthService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// (No @packageDocumentation comment for this package)
diff --git a/packages/backend-defaults/api-report-httpRouter.md b/packages/backend-defaults/api-report-httpRouter.md
index f191a5a847..300e75a44d 100644
--- a/packages/backend-defaults/api-report-httpRouter.md
+++ b/packages/backend-defaults/api-report-httpRouter.md
@@ -7,7 +7,7 @@ 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';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
// @public
export function createLifecycleMiddleware(
@@ -15,9 +15,11 @@ export function createLifecycleMiddleware(
): RequestHandler;
// @public
-export const httpRouterServiceFactory: () => ServiceFactory<
+export const httpRouterServiceFactory: ServiceFactoryCompat<
HttpRouterService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// @public
diff --git a/packages/backend-defaults/api-report-lifecycle.md b/packages/backend-defaults/api-report-lifecycle.md
index 4233584664..54ffb77fed 100644
--- a/packages/backend-defaults/api-report-lifecycle.md
+++ b/packages/backend-defaults/api-report-lifecycle.md
@@ -4,12 +4,14 @@
```ts
import { LifecycleService } from '@backstage/backend-plugin-api';
-import { ServiceFactory } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
// @public
-export const lifecycleServiceFactory: () => ServiceFactory<
+export const lifecycleServiceFactory: ServiceFactoryCompat<
LifecycleService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// (No @packageDocumentation comment for this package)
diff --git a/packages/backend-defaults/api-report-logger.md b/packages/backend-defaults/api-report-logger.md
index fa9018a40c..40ca4e21b4 100644
--- a/packages/backend-defaults/api-report-logger.md
+++ b/packages/backend-defaults/api-report-logger.md
@@ -4,12 +4,14 @@
```ts
import { LoggerService } from '@backstage/backend-plugin-api';
-import { ServiceFactory } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
// @public
-export const loggerServiceFactory: () => ServiceFactory<
+export const loggerServiceFactory: ServiceFactoryCompat<
LoggerService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// (No @packageDocumentation comment for this package)
diff --git a/packages/backend-defaults/api-report-permissions.md b/packages/backend-defaults/api-report-permissions.md
index c436443ff1..eea11ed7c9 100644
--- a/packages/backend-defaults/api-report-permissions.md
+++ b/packages/backend-defaults/api-report-permissions.md
@@ -4,12 +4,14 @@
```ts
import { PermissionsService } from '@backstage/backend-plugin-api';
-import { ServiceFactory } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
// @public
-export const permissionsServiceFactory: () => ServiceFactory<
+export const permissionsServiceFactory: ServiceFactoryCompat<
PermissionsService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// (No @packageDocumentation comment for this package)
diff --git a/packages/backend-defaults/api-report-rootConfig.md b/packages/backend-defaults/api-report-rootConfig.md
index 317c451e1b..2935ad1128 100644
--- a/packages/backend-defaults/api-report-rootConfig.md
+++ b/packages/backend-defaults/api-report-rootConfig.md
@@ -26,9 +26,10 @@ export interface RootConfigFactoryOptions {
}
// @public (undocumented)
-export const rootConfigServiceFactory: (
- options?: RootConfigFactoryOptions | undefined,
-) => ServiceFactory;
+export const rootConfigServiceFactory: ((
+ options?: RootConfigFactoryOptions,
+) => ServiceFactory) &
+ ServiceFactory;
// (No @packageDocumentation comment for this package)
```
diff --git a/packages/backend-defaults/api-report-rootHealth.md b/packages/backend-defaults/api-report-rootHealth.md
index ffa067605a..c7580cacd6 100644
--- a/packages/backend-defaults/api-report-rootHealth.md
+++ b/packages/backend-defaults/api-report-rootHealth.md
@@ -4,12 +4,14 @@
```ts
import { RootHealthService } from '@backstage/backend-plugin-api';
-import { ServiceFactory } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
// @public (undocumented)
-export const rootHealthServiceFactory: () => ServiceFactory<
+export const rootHealthServiceFactory: ServiceFactoryCompat<
RootHealthService,
- 'root'
+ 'root',
+ 'singleton',
+ undefined
>;
// (No @packageDocumentation comment for this package)
diff --git a/packages/backend-defaults/api-report-rootHttpRouter.md b/packages/backend-defaults/api-report-rootHttpRouter.md
index d9727fd36d..3686f25a12 100644
--- a/packages/backend-defaults/api-report-rootHttpRouter.md
+++ b/packages/backend-defaults/api-report-rootHttpRouter.md
@@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
+///
///
import { Config } from '@backstage/config';
@@ -17,10 +18,17 @@ import { LoggerService } from '@backstage/backend-plugin-api';
import { RequestHandler } from 'express';
import { RequestListener } from 'http';
import { RootConfigService } from '@backstage/backend-plugin-api';
+import { RootHealthService } from '@backstage/backend-plugin-api';
import { RootHttpRouterService } from '@backstage/backend-plugin-api';
+import { Router } from 'express';
import type { Server } from 'node:http';
import { ServiceFactory } from '@backstage/backend-plugin-api';
+// @public (undocumented)
+export function createHealthRouter(options: {
+ health: RootHealthService;
+}): Router;
+
// @public
export function createHttpServer(
listener: RequestListener,
@@ -141,9 +149,10 @@ export type RootHttpRouterFactoryOptions = {
};
// @public (undocumented)
-export const rootHttpRouterServiceFactory: (
- options?: RootHttpRouterFactoryOptions | undefined,
-) => ServiceFactory;
+export const rootHttpRouterServiceFactory: ((
+ options?: RootHttpRouterFactoryOptions,
+) => ServiceFactory) &
+ ServiceFactory;
// (No @packageDocumentation comment for this package)
```
diff --git a/packages/backend-defaults/api-report-rootLifecycle.md b/packages/backend-defaults/api-report-rootLifecycle.md
index 00eb9c1ebb..e522471d04 100644
--- a/packages/backend-defaults/api-report-rootLifecycle.md
+++ b/packages/backend-defaults/api-report-rootLifecycle.md
@@ -4,12 +4,14 @@
```ts
import { RootLifecycleService } from '@backstage/backend-plugin-api';
-import { ServiceFactory } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
// @public
-export const rootLifecycleServiceFactory: () => ServiceFactory<
+export const rootLifecycleServiceFactory: ServiceFactoryCompat<
RootLifecycleService,
- 'root'
+ 'root',
+ 'singleton',
+ undefined
>;
// (No @packageDocumentation comment for this package)
diff --git a/packages/backend-defaults/api-report-rootLogger.md b/packages/backend-defaults/api-report-rootLogger.md
index 70dc0deee6..3878420192 100644
--- a/packages/backend-defaults/api-report-rootLogger.md
+++ b/packages/backend-defaults/api-report-rootLogger.md
@@ -7,13 +7,15 @@ import { Format } from 'logform';
import { JsonObject } from '@backstage/types';
import { LoggerService } from '@backstage/backend-plugin-api';
import { RootLoggerService } from '@backstage/backend-plugin-api';
-import { ServiceFactory } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
import { transport } from 'winston';
// @public
-export const rootLoggerServiceFactory: () => ServiceFactory<
+export const rootLoggerServiceFactory: ServiceFactoryCompat<
RootLoggerService,
- 'root'
+ 'root',
+ 'singleton',
+ undefined
>;
// @public
diff --git a/packages/backend-defaults/api-report-scheduler.md b/packages/backend-defaults/api-report-scheduler.md
index 58991ddca3..9953518e09 100644
--- a/packages/backend-defaults/api-report-scheduler.md
+++ b/packages/backend-defaults/api-report-scheduler.md
@@ -6,7 +6,7 @@
import { DatabaseService } from '@backstage/backend-plugin-api';
import { LoggerService } from '@backstage/backend-plugin-api';
import { SchedulerService } from '@backstage/backend-plugin-api';
-import { ServiceFactory } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
// @public
export class DefaultSchedulerService {
@@ -18,9 +18,11 @@ export class DefaultSchedulerService {
}
// @public
-export const schedulerServiceFactory: () => ServiceFactory<
+export const schedulerServiceFactory: ServiceFactoryCompat<
SchedulerService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// (No @packageDocumentation comment for this package)
diff --git a/packages/backend-defaults/api-report-urlReader.md b/packages/backend-defaults/api-report-urlReader.md
index c56cdba69b..f561c2cbf5 100644
--- a/packages/backend-defaults/api-report-urlReader.md
+++ b/packages/backend-defaults/api-report-urlReader.md
@@ -21,7 +21,8 @@ import { GitLabIntegration } from '@backstage/integration';
import { HarnessIntegration } from '@backstage/integration';
import { LoggerService } from '@backstage/backend-plugin-api';
import { Readable } from 'stream';
-import { ServiceFactory } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
+import { ServiceRef } from '@backstage/backend-plugin-api';
import { UrlReaderService } from '@backstage/backend-plugin-api';
import { UrlReaderServiceReadTreeOptions } from '@backstage/backend-plugin-api';
import { UrlReaderServiceReadTreeResponse } from '@backstage/backend-plugin-api';
@@ -413,6 +414,13 @@ export type ReadUrlResponseFactoryFromStreamOptions = {
lastModifiedAt?: Date;
};
+// @public
+export const urlReaderFactoriesServiceRef: ServiceRef<
+ ReaderFactory,
+ 'plugin',
+ 'multiton'
+>;
+
// @public
export type UrlReaderPredicateTuple = {
predicate: (url: URL) => boolean;
@@ -426,9 +434,11 @@ export class UrlReaders {
}
// @public
-export const urlReaderServiceFactory: () => ServiceFactory<
+export const urlReaderServiceFactory: ServiceFactoryCompat<
UrlReaderService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// @public
diff --git a/packages/backend-defaults/api-report-userInfo.md b/packages/backend-defaults/api-report-userInfo.md
index d11fb69718..27f73d06e1 100644
--- a/packages/backend-defaults/api-report-userInfo.md
+++ b/packages/backend-defaults/api-report-userInfo.md
@@ -3,13 +3,15 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
-import { ServiceFactory } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
import { UserInfoService } from '@backstage/backend-plugin-api';
// @public
-export const userInfoServiceFactory: () => ServiceFactory<
+export const userInfoServiceFactory: ServiceFactoryCompat<
UserInfoService,
- 'plugin'
+ 'plugin',
+ 'singleton',
+ undefined
>;
// (No @packageDocumentation comment for this package)
diff --git a/packages/backend-defaults/config.d.ts b/packages/backend-defaults/config.d.ts
index ab1e443fc2..1c784bce0c 100644
--- a/packages/backend-defaults/config.d.ts
+++ b/packages/backend-defaults/config.d.ts
@@ -287,6 +287,46 @@ export interface Config {
*/
subjectPrefix?: string;
};
+ /**
+ * Restricts what types of access that are permitted for this access
+ * method. If no access restrictions are given, it'll have unlimited
+ * access. This access restriction applies for the framework level;
+ * individual plugins may have their own access control mechanisms
+ * on top of this.
+ */
+ accessRestrictions?: Array<{
+ /**
+ * Permit access to make requests to this plugin.
+ *
+ * Can be further refined by setting additional fields below.
+ */
+ plugin: string;
+ /**
+ * If given, this method is limited to only performing actions
+ * with these named permissions in this plugin.
+ *
+ * Note that this only applies where permissions checks are
+ * enabled in the first place. Endpoints that are not protected by
+ * the permissions system at all, are not affected by this
+ * setting.
+ */
+ permission?: string | Array;
+ /**
+ * If given, this method is limited to only performing actions
+ * whose permissions have these attributes.
+ *
+ * Note that this only applies where permissions checks are
+ * enabled in the first place. Endpoints that are not protected by
+ * the permissions system at all, are not affected by this
+ * setting.
+ */
+ permissionAttribute?: {
+ /**
+ * One of more of 'create', 'read', 'update', or 'delete'.
+ */
+ action?: string | Array;
+ };
+ }>;
}
>;
};
diff --git a/packages/backend-defaults/migrations/scheduler/20240712211735_nullable_next_run.js b/packages/backend-defaults/migrations/scheduler/20240712211735_nullable_next_run.js
new file mode 100644
index 0000000000..efbef1c76f
--- /dev/null
+++ b/packages/backend-defaults/migrations/scheduler/20240712211735_nullable_next_run.js
@@ -0,0 +1,41 @@
+/*
+ * Copyright 2024 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.
+ */
+
+// @ts-check
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise }
+ */
+exports.up = async function up(knex) {
+ await knex.schema.alterTable('backstage_backend_tasks__tasks', table => {
+ table.setNullable('next_run_start_at');
+ });
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise }
+ */
+exports.down = async function down(knex) {
+ await knex
+ .delete()
+ .from('backstage_backend_tasks__tasks')
+ .where({ next_run_start_at: null });
+ await knex.schema.alterTable('backstage_backend_tasks__tasks', table => {
+ table.dropNullable('next_run_start_at');
+ });
+};
diff --git a/packages/backend-defaults/package.json b/packages/backend-defaults/package.json
index 0606d942ff..cef9641de6 100644
--- a/packages/backend-defaults/package.json
+++ b/packages/backend-defaults/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/backend-defaults",
- "version": "0.3.4-next.1",
+ "version": "0.4.2-next.2",
"description": "Backend defaults used by Backstage backend apps",
"backstage": {
"role": "node-library"
@@ -165,7 +165,7 @@
"minimist": "^1.2.5",
"morgan": "^1.10.0",
"mysql2": "^3.0.0",
- "node-fetch": "^2.6.7",
+ "node-fetch": "^2.7.0",
"node-forge": "^1.3.1",
"p-limit": "^3.1.0",
"path-to-regexp": "^6.2.1",
diff --git a/packages/backend-defaults/src/CreateBackend.ts b/packages/backend-defaults/src/CreateBackend.ts
index e3195748a6..47fa09da49 100644
--- a/packages/backend-defaults/src/CreateBackend.ts
+++ b/packages/backend-defaults/src/CreateBackend.ts
@@ -40,26 +40,26 @@ import { userInfoServiceFactory } from '@backstage/backend-defaults/userInfo';
import { eventsServiceFactory } from '@backstage/plugin-events-node';
export const defaultServiceFactories = [
- authServiceFactory(),
- cacheServiceFactory(),
- rootConfigServiceFactory(),
- databaseServiceFactory(),
- discoveryServiceFactory(),
- httpAuthServiceFactory(),
- httpRouterServiceFactory(),
- identityServiceFactory(),
- lifecycleServiceFactory(),
- loggerServiceFactory(),
- permissionsServiceFactory(),
- rootHealthServiceFactory(),
- rootHttpRouterServiceFactory(),
- rootLifecycleServiceFactory(),
- rootLoggerServiceFactory(),
- schedulerServiceFactory(),
- tokenManagerServiceFactory(),
- userInfoServiceFactory(),
- urlReaderServiceFactory(),
- eventsServiceFactory(),
+ authServiceFactory,
+ cacheServiceFactory,
+ rootConfigServiceFactory,
+ databaseServiceFactory,
+ discoveryServiceFactory,
+ httpAuthServiceFactory,
+ httpRouterServiceFactory,
+ identityServiceFactory,
+ lifecycleServiceFactory,
+ loggerServiceFactory,
+ permissionsServiceFactory,
+ rootHealthServiceFactory,
+ rootHttpRouterServiceFactory,
+ rootLifecycleServiceFactory,
+ rootLoggerServiceFactory,
+ schedulerServiceFactory,
+ tokenManagerServiceFactory,
+ userInfoServiceFactory,
+ urlReaderServiceFactory,
+ eventsServiceFactory,
];
/**
diff --git a/packages/backend-defaults/src/entrypoints/auth/authServiceFactory.test.ts b/packages/backend-defaults/src/entrypoints/auth/authServiceFactory.test.ts
index de89efa351..f9ef4c9762 100644
--- a/packages/backend-defaults/src/entrypoints/auth/authServiceFactory.test.ts
+++ b/packages/backend-defaults/src/entrypoints/auth/authServiceFactory.test.ts
@@ -17,7 +17,7 @@
import {
ServiceFactoryTester,
mockServices,
- setupRequestMockHandlers,
+ registerMswTestHooks,
} from '@backstage/backend-test-utils';
import { tokenManagerServiceFactory } from '@backstage/backend-app-api';
import { authServiceFactory } from './authServiceFactory';
@@ -68,7 +68,7 @@ const mockDeps = [
];
describe('authServiceFactory', () => {
- setupRequestMockHandlers(server);
+ registerMswTestHooks(server);
afterEach(() => {
jest.useRealTimers();
diff --git a/packages/backend-defaults/src/entrypoints/auth/external/ExternalTokenHandler.test.ts b/packages/backend-defaults/src/entrypoints/auth/external/ExternalTokenHandler.test.ts
index 559107c59c..39b01c46b6 100644
--- a/packages/backend-defaults/src/entrypoints/auth/external/ExternalTokenHandler.test.ts
+++ b/packages/backend-defaults/src/entrypoints/auth/external/ExternalTokenHandler.test.ts
@@ -19,7 +19,7 @@ import { ExternalTokenHandler } from './ExternalTokenHandler';
import { TokenHandler } from './types';
import {
mockServices,
- setupRequestMockHandlers,
+ registerMswTestHooks,
} from '@backstage/backend-test-utils';
import { randomBytes } from 'crypto';
import { SignJWT, exportJWK, generateKeyPair } from 'jose';
@@ -81,7 +81,7 @@ class FakeTokenFactory {
describe('ExternalTokenHandler', () => {
const server = setupServer();
- setupRequestMockHandlers(server);
+ registerMswTestHooks(server);
it('skips over inner handlers that do not match, and applies plugin restrictions', async () => {
const handler1: TokenHandler = {
diff --git a/packages/backend-defaults/src/entrypoints/auth/external/jwks.test.ts b/packages/backend-defaults/src/entrypoints/auth/external/jwks.test.ts
index 56930e4480..321e1823aa 100644
--- a/packages/backend-defaults/src/entrypoints/auth/external/jwks.test.ts
+++ b/packages/backend-defaults/src/entrypoints/auth/external/jwks.test.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
+import { registerMswTestHooks } from '@backstage/backend-test-utils';
import { ConfigReader } from '@backstage/config';
import { SignJWT, exportJWK, generateKeyPair } from 'jose';
import { rest } from 'msw';
@@ -81,7 +81,7 @@ describe('JWKSHandler', () => {
let mockSubject: string;
const keyDurationSeconds = 5;
- setupRequestMockHandlers(server);
+ registerMswTestHooks(server);
beforeEach(() => {
mockSubject = 'test_subject';
diff --git a/packages/backend-defaults/src/entrypoints/auth/user/UserTokenHandler.test.ts b/packages/backend-defaults/src/entrypoints/auth/user/UserTokenHandler.test.ts
index 76bafb2a8f..e85ec8db63 100644
--- a/packages/backend-defaults/src/entrypoints/auth/user/UserTokenHandler.test.ts
+++ b/packages/backend-defaults/src/entrypoints/auth/user/UserTokenHandler.test.ts
@@ -18,7 +18,7 @@ import { JsonObject } from '@backstage/types';
import { UserTokenHandler } from './UserTokenHandler';
import {
mockServices,
- setupRequestMockHandlers,
+ registerMswTestHooks,
} from '@backstage/backend-test-utils';
import { rest } from 'msw';
import { setupServer } from 'msw/node';
@@ -64,7 +64,7 @@ async function createToken(options: {
describe('UserTokenHandler', () => {
let userTokenHandler: UserTokenHandler;
- setupRequestMockHandlers(server);
+ registerMswTestHooks(server);
beforeEach(() => {
jest.useRealTimers();
diff --git a/packages/backend-defaults/src/entrypoints/cache/CacheManager.ts b/packages/backend-defaults/src/entrypoints/cache/CacheManager.ts
index 89fabfe977..873bcf9648 100644
--- a/packages/backend-defaults/src/entrypoints/cache/CacheManager.ts
+++ b/packages/backend-defaults/src/entrypoints/cache/CacheManager.ts
@@ -111,23 +111,10 @@ export class CacheManager {
return {
getClient: (defaultOptions = {}) => {
const clientFactory = (options: CacheServiceOptions) => {
- const concreteClient = this.getClientWithTtl(
+ return this.getClientWithTtl(
pluginId,
options.defaultTtl ?? this.defaultTtl,
);
-
- // Always provide an error handler to avoid stopping the process.
- concreteClient.on('error', (err: Error) => {
- // In all cases, just log the error.
- this.logger?.error('Failed to create cache client', err);
-
- // Invoke any custom error handler if provided.
- if (typeof this.errorHandler === 'function') {
- this.errorHandler(err);
- }
- });
-
- return concreteClient;
};
return new DefaultCacheClient(
@@ -149,11 +136,17 @@ export class CacheManager {
return (pluginId, defaultTtl) => {
if (!store) {
store = new KeyvRedis(this.connection);
+ // Always provide an error handler to avoid stopping the process
+ store.on('error', (err: Error) => {
+ this.logger?.error('Failed to create redis cache client', err);
+ this.errorHandler?.(err);
+ });
}
return new Keyv({
namespace: pluginId,
ttl: defaultTtl,
store,
+ emitErrors: false,
useRedisSets: this.useRedisSets,
});
};
@@ -165,10 +158,16 @@ export class CacheManager {
return (pluginId, defaultTtl) => {
if (!store) {
store = new KeyvMemcache(this.connection);
+ // Always provide an error handler to avoid stopping the process
+ store.on('error', (err: Error) => {
+ this.logger?.error('Failed to create memcache cache client', err);
+ this.errorHandler?.(err);
+ });
}
return new Keyv({
namespace: pluginId,
ttl: defaultTtl,
+ emitErrors: false,
store,
});
};
@@ -180,6 +179,7 @@ export class CacheManager {
new Keyv({
namespace: pluginId,
ttl: defaultTtl,
+ emitErrors: false,
store,
});
}
diff --git a/packages/backend-defaults/src/entrypoints/rootConfig/rootConfigServiceFactory.ts b/packages/backend-defaults/src/entrypoints/rootConfig/rootConfigServiceFactory.ts
index 5752a9c634..63a7353241 100644
--- a/packages/backend-defaults/src/entrypoints/rootConfig/rootConfigServiceFactory.ts
+++ b/packages/backend-defaults/src/entrypoints/rootConfig/rootConfigServiceFactory.ts
@@ -45,11 +45,10 @@ export interface RootConfigFactoryOptions {
watch?: boolean;
}
-/**
- * @public
- */
-export const rootConfigServiceFactory = createServiceFactory(
- (options?: RootConfigFactoryOptions) => ({
+export const rootConfigServiceFactoryWithOptions = (
+ options?: RootConfigFactoryOptions,
+) =>
+ createServiceFactory({
service: coreServices.rootConfig,
deps: {},
async factory() {
@@ -61,5 +60,12 @@ export const rootConfigServiceFactory = createServiceFactory(
console.log(`Loading config from ${source}`);
return await ConfigSources.toConfig(source);
},
- }),
+ })();
+
+/**
+ * @public
+ */
+export const rootConfigServiceFactory = Object.assign(
+ rootConfigServiceFactoryWithOptions,
+ rootConfigServiceFactoryWithOptions(),
);
diff --git a/packages/backend-defaults/src/entrypoints/rootHttpRouter/createHealthRouter.ts b/packages/backend-defaults/src/entrypoints/rootHttpRouter/createHealthRouter.ts
index 13691ede28..3772ab0fab 100644
--- a/packages/backend-defaults/src/entrypoints/rootHttpRouter/createHealthRouter.ts
+++ b/packages/backend-defaults/src/entrypoints/rootHttpRouter/createHealthRouter.ts
@@ -1,5 +1,3 @@
-import { RootHealthService } from '@backstage/backend-plugin-api';
-
/*
* Copyright 2024 The Backstage Authors
*
@@ -16,14 +14,18 @@ import { RootHealthService } from '@backstage/backend-plugin-api';
* limitations under the License.
*/
+import { RootHealthService } from '@backstage/backend-plugin-api';
import Router from 'express-promise-router';
import { Request, Response } from 'express';
+/**
+ * @public
+ */
export function createHealthRouter(options: { health: RootHealthService }) {
const router = Router();
router.get(
- '.backstage/health/v1/readiness',
+ '/.backstage/health/v1/readiness',
async (_request: Request, response: Response) => {
const { status, payload } = await options.health.getReadiness();
response.status(status).json(payload);
@@ -31,7 +33,7 @@ export function createHealthRouter(options: { health: RootHealthService }) {
);
router.get(
- '.backstage/health/v1/liveness',
+ '/.backstage/health/v1/liveness',
async (_request: Request, response: Response) => {
const { status, payload } = await options.health.getLiveness();
response.status(status).json(payload);
diff --git a/packages/backend-defaults/src/entrypoints/rootHttpRouter/index.ts b/packages/backend-defaults/src/entrypoints/rootHttpRouter/index.ts
index 9c2d96dab2..e9aee8a0e0 100644
--- a/packages/backend-defaults/src/entrypoints/rootHttpRouter/index.ts
+++ b/packages/backend-defaults/src/entrypoints/rootHttpRouter/index.ts
@@ -18,6 +18,7 @@ export {
DefaultRootHttpRouter,
type DefaultRootHttpRouterOptions,
} from './DefaultRootHttpRouter';
+export { createHealthRouter } from './createHealthRouter';
export * from './http';
export {
rootHttpRouterServiceFactory,
diff --git a/packages/backend-defaults/src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.test.ts b/packages/backend-defaults/src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.test.ts
new file mode 100644
index 0000000000..dea0159dff
--- /dev/null
+++ b/packages/backend-defaults/src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.test.ts
@@ -0,0 +1,74 @@
+/*
+ * 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 {
+ ServiceFactoryTester,
+ mockServices,
+} from '@backstage/backend-test-utils';
+import { Express } from 'express';
+import request from 'supertest';
+import { rootHttpRouterServiceFactory } from './rootHttpRouterServiceFactory';
+import { coreServices } from '@backstage/backend-plugin-api';
+
+describe('rootHttpRouterServiceFactory', () => {
+ it('should make the health endpoints available', async () => {
+ let app: Express | undefined = undefined;
+
+ const tester = ServiceFactoryTester.from(
+ rootHttpRouterServiceFactory({
+ configure(options) {
+ options.applyDefaults();
+ app = options.app;
+ },
+ }),
+ {
+ dependencies: [
+ mockServices.rootConfig.factory({
+ data: {
+ app: { baseUrl: 'http://localhost' },
+ backend: {
+ baseUrl: 'http://localhost',
+ listen: { host: '', port: 0 },
+ },
+ },
+ }),
+ ],
+ },
+ );
+
+ // Trigger creation of the http service, accessing the app instance through the configure callback
+ await tester.getSubject();
+
+ await request(app!)
+ .get('/.backstage/health/v1/liveness')
+ .expect(200, { status: 'ok' });
+
+ await request(app!).get('/.backstage/health/v1/readiness').expect(503, {
+ message: 'Backend has not started yet',
+ status: 'error',
+ });
+
+ const lifecycle = await tester.getService(coreServices.rootLifecycle);
+
+ await (lifecycle as any).startup(); // Trigger startup by calling the private startup method
+
+ await request(app!).get('/.backstage/health/v1/readiness').expect(200, {
+ status: 'ok',
+ });
+
+ expect('test').toBe('test');
+ });
+});
diff --git a/packages/backend-defaults/src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.ts b/packages/backend-defaults/src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.ts
index 22f5c2f310..c3a97737e4 100644
--- a/packages/backend-defaults/src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.ts
+++ b/packages/backend-defaults/src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.ts
@@ -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(),
);
diff --git a/packages/backend-defaults/src/entrypoints/scheduler/lib/PluginTaskSchedulerImpl.test.ts b/packages/backend-defaults/src/entrypoints/scheduler/lib/PluginTaskSchedulerImpl.test.ts
index c5c4c8708a..3e0782d4a3 100644
--- a/packages/backend-defaults/src/entrypoints/scheduler/lib/PluginTaskSchedulerImpl.test.ts
+++ b/packages/backend-defaults/src/entrypoints/scheduler/lib/PluginTaskSchedulerImpl.test.ts
@@ -347,6 +347,7 @@ describe('PluginTaskManagerImpl', () => {
expect(parseDuration({ milliseconds: 5000 })).toEqual('PT5S');
expect(parseDuration(Duration.fromMillis(5000))).toEqual('PT5S');
expect(parseDuration({ cron: '1 * * * *' })).toEqual('1 * * * *');
+ expect(parseDuration({ trigger: 'manual' })).toEqual('manual');
});
});
});
diff --git a/packages/backend-defaults/src/entrypoints/scheduler/lib/PluginTaskSchedulerImpl.ts b/packages/backend-defaults/src/entrypoints/scheduler/lib/PluginTaskSchedulerImpl.ts
index 40aa9d521c..f8d06baf56 100644
--- a/packages/backend-defaults/src/entrypoints/scheduler/lib/PluginTaskSchedulerImpl.ts
+++ b/packages/backend-defaults/src/entrypoints/scheduler/lib/PluginTaskSchedulerImpl.ts
@@ -155,6 +155,9 @@ export function parseDuration(
if (typeof frequency === 'object' && 'cron' in frequency) {
return frequency.cron;
}
+ if (typeof frequency === 'object' && 'trigger' in frequency) {
+ return frequency.trigger;
+ }
const parsed = Duration.isDuration(frequency)
? frequency
diff --git a/packages/backend-defaults/src/entrypoints/scheduler/lib/TaskWorker.test.ts b/packages/backend-defaults/src/entrypoints/scheduler/lib/TaskWorker.test.ts
index 1cafe00670..5db82f3ece 100644
--- a/packages/backend-defaults/src/entrypoints/scheduler/lib/TaskWorker.test.ts
+++ b/packages/backend-defaults/src/entrypoints/scheduler/lib/TaskWorker.test.ts
@@ -503,4 +503,32 @@ describe('TaskWorker', () => {
await knex.destroy();
},
);
+
+ it.each(databases.eachSupportedId())(
+ 'next_run_start_at is not set for manually-triggered tasks, %p',
+ async databaseId => {
+ const knex = await databases.init(databaseId);
+ await migrateBackendTasks(knex);
+
+ const fn = jest.fn(
+ async () => new Promise(resolve => setTimeout(resolve, 50)),
+ );
+
+ const initialSettings: TaskSettingsV2 = {
+ version: 2,
+ cadence: 'manual',
+ timeoutAfterDuration: 'PT1M',
+ };
+
+ const worker = new TaskWorker('task99', fn, knex, logger);
+ await worker.persistTask(initialSettings);
+ await worker.tryClaimTask('ticket', initialSettings);
+ await worker.tryReleaseTask('ticket', initialSettings);
+
+ const row = (await knex(DB_TASKS_TABLE))[0];
+ expect(row.next_run_start_at).toBeNull();
+
+ await knex.destroy();
+ },
+ );
});
diff --git a/packages/backend-defaults/src/entrypoints/scheduler/lib/TaskWorker.ts b/packages/backend-defaults/src/entrypoints/scheduler/lib/TaskWorker.ts
index a1c4ec44fd..c5570a8e30 100644
--- a/packages/backend-defaults/src/entrypoints/scheduler/lib/TaskWorker.ts
+++ b/packages/backend-defaults/src/entrypoints/scheduler/lib/TaskWorker.ts
@@ -53,8 +53,8 @@ export class TaskWorker {
);
let workCheckFrequency = this.workCheckFrequency;
- const isCron = !settings?.cadence.startsWith('P');
- if (!isCron) {
+ const isDuration = settings?.cadence.startsWith('P');
+ if (isDuration) {
const cadence = Duration.fromISO(settings.cadence);
if (cadence < workCheckFrequency) {
workCheckFrequency = cadence;
@@ -175,7 +175,9 @@ export class TaskWorker {
// read it back again.
taskSettingsV2Schema.parse(settings);
- const isCron = !settings?.cadence.startsWith('P');
+ const isManual = settings?.cadence === 'manual';
+ const isDuration = settings?.cadence.startsWith('P');
+ const isCron = !isManual && !isDuration;
let startAt: Knex.Raw | undefined;
let nextStartAt: Knex.Raw | undefined;
@@ -194,6 +196,9 @@ export class TaskWorker {
nextStartAt = this.nextRunAtRaw(time);
startAt ||= nextStartAt;
+ } else if (isManual) {
+ nextStartAt = this.knex.raw('null');
+ startAt ||= nextStartAt;
} else {
startAt ||= this.knex.fn.now();
nextStartAt = nowPlus(Duration.fromISO(settings.cadence), this.knex);
@@ -317,7 +322,9 @@ export class TaskWorker {
ticket: string,
settings: TaskSettingsV2,
): Promise {
- const isCron = !settings?.cadence.startsWith('P');
+ const isManual = settings?.cadence === 'manual';
+ const isDuration = settings?.cadence.startsWith('P');
+ const isCron = !isManual && !isDuration;
let nextRun: Knex.Raw;
if (isCron) {
@@ -325,6 +332,8 @@ export class TaskWorker {
this.logger.debug(`task: ${this.taskId} will next occur around ${time}`);
nextRun = this.nextRunAtRaw(time);
+ } else if (isManual) {
+ nextRun = this.knex.raw('null');
} else {
const dt = Duration.fromISO(settings.cadence).as('seconds');
this.logger.debug(
diff --git a/packages/backend-defaults/src/entrypoints/scheduler/lib/types.ts b/packages/backend-defaults/src/entrypoints/scheduler/lib/types.ts
index 61e6c1d9a8..173c989543 100644
--- a/packages/backend-defaults/src/entrypoints/scheduler/lib/types.ts
+++ b/packages/backend-defaults/src/entrypoints/scheduler/lib/types.ts
@@ -40,6 +40,10 @@ function isValidCronFormat(c: string | undefined): boolean {
}
}
+function isValidTrigger(t: string): boolean {
+ return t === 'manual';
+}
+
export const taskSettingsV1Schema = z.object({
version: z.literal(1),
initialDelayDuration: z
@@ -68,6 +72,11 @@ export const taskSettingsV2Schema = z.object({
cadence: z
.string()
.refine(isValidCronFormat, { message: 'Invalid cron' })
+ .or(
+ z.string().refine(isValidTrigger, {
+ message: "Invalid trigger, expecting 'manual'",
+ }),
+ )
.or(
z.string().refine(isValidOptionalDurationString, {
message: 'Invalid duration, expecting ISO Period',
diff --git a/packages/backend-defaults/src/entrypoints/urlReader/index.ts b/packages/backend-defaults/src/entrypoints/urlReader/index.ts
index cf927ea031..05271966c9 100644
--- a/packages/backend-defaults/src/entrypoints/urlReader/index.ts
+++ b/packages/backend-defaults/src/entrypoints/urlReader/index.ts
@@ -15,4 +15,7 @@
*/
export * from './lib';
-export { urlReaderServiceFactory } from './urlReaderServiceFactory';
+export {
+ urlReaderServiceFactory,
+ urlReaderFactoriesServiceRef,
+} from './urlReaderServiceFactory';
diff --git a/packages/backend-defaults/src/entrypoints/urlReader/lib/AwsCodeCommitUrlReader.ts b/packages/backend-defaults/src/entrypoints/urlReader/lib/AwsCodeCommitUrlReader.ts
index 7f02f1468f..5a2655ad1c 100644
--- a/packages/backend-defaults/src/entrypoints/urlReader/lib/AwsCodeCommitUrlReader.ts
+++ b/packages/backend-defaults/src/entrypoints/urlReader/lib/AwsCodeCommitUrlReader.ts
@@ -213,6 +213,7 @@ export class AwsCodeCommitUrlReader implements UrlReaderService {
);
const codeCommit = new CodeCommitClient({
+ customUserAgent: 'backstage-aws-codecommit-url-reader',
region: region,
credentials: credentials,
});
diff --git a/packages/backend-defaults/src/entrypoints/urlReader/lib/AwsS3UrlReader.ts b/packages/backend-defaults/src/entrypoints/urlReader/lib/AwsS3UrlReader.ts
index 27f60f5b77..324538add4 100644
--- a/packages/backend-defaults/src/entrypoints/urlReader/lib/AwsS3UrlReader.ts
+++ b/packages/backend-defaults/src/entrypoints/urlReader/lib/AwsS3UrlReader.ts
@@ -222,6 +222,7 @@ export class AwsS3UrlReader implements UrlReaderService {
);
const s3 = new S3Client({
+ customUserAgent: 'backstage-aws-s3-url-reader',
region: region,
credentials: credentials,
endpoint: integration.config.endpoint,
diff --git a/packages/backend-defaults/src/entrypoints/urlReader/lib/AzureUrlReader.test.ts b/packages/backend-defaults/src/entrypoints/urlReader/lib/AzureUrlReader.test.ts
index ce2385507b..f53a7b6c11 100644
--- a/packages/backend-defaults/src/entrypoints/urlReader/lib/AzureUrlReader.test.ts
+++ b/packages/backend-defaults/src/entrypoints/urlReader/lib/AzureUrlReader.test.ts
@@ -26,7 +26,7 @@ import {
import {
createMockDirectory,
mockServices,
- setupRequestMockHandlers,
+ registerMswTestHooks,
} from '@backstage/backend-test-utils';
import fs from 'fs-extra';
import { rest } from 'msw';
@@ -76,7 +76,7 @@ describe('AzureUrlReader', () => {
beforeEach(mockDir.clear);
const worker = setupServer();
- setupRequestMockHandlers(worker);
+ registerMswTestHooks(worker);
describe('read', () => {
beforeEach(() => {
diff --git a/packages/backend-defaults/src/entrypoints/urlReader/lib/BitbucketCloudUrlReader.test.ts b/packages/backend-defaults/src/entrypoints/urlReader/lib/BitbucketCloudUrlReader.test.ts
index dc182af619..f5caade3fa 100644
--- a/packages/backend-defaults/src/entrypoints/urlReader/lib/BitbucketCloudUrlReader.test.ts
+++ b/packages/backend-defaults/src/entrypoints/urlReader/lib/BitbucketCloudUrlReader.test.ts
@@ -21,7 +21,7 @@ import {
} from '@backstage/integration';
import {
createMockDirectory,
- setupRequestMockHandlers,
+ registerMswTestHooks,
} from '@backstage/backend-test-utils';
import fs from 'fs-extra';
import { rest } from 'msw';
@@ -56,7 +56,7 @@ describe('BitbucketCloudUrlReader', () => {
beforeEach(mockDir.clear);
const worker = setupServer();
- setupRequestMockHandlers(worker);
+ registerMswTestHooks(worker);
describe('readUrl', () => {
it('should be able to readUrl via buffer without ETag', async () => {
diff --git a/packages/backend-defaults/src/entrypoints/urlReader/lib/BitbucketServerUrlReader.test.ts b/packages/backend-defaults/src/entrypoints/urlReader/lib/BitbucketServerUrlReader.test.ts
index 2870138535..6af2858cde 100644
--- a/packages/backend-defaults/src/entrypoints/urlReader/lib/BitbucketServerUrlReader.test.ts
+++ b/packages/backend-defaults/src/entrypoints/urlReader/lib/BitbucketServerUrlReader.test.ts
@@ -21,7 +21,7 @@ import {
} from '@backstage/integration';
import {
createMockDirectory,
- setupRequestMockHandlers,
+ registerMswTestHooks,
} from '@backstage/backend-test-utils';
import fs from 'fs-extra';
import { rest } from 'msw';
@@ -51,7 +51,7 @@ const reader = new BitbucketServerUrlReader(
describe('BitbucketServerUrlReader', () => {
const worker = setupServer();
- setupRequestMockHandlers(worker);
+ registerMswTestHooks(worker);
describe('readTree', () => {
const repoBuffer = fs.readFileSync(
diff --git a/packages/backend-defaults/src/entrypoints/urlReader/lib/BitbucketUrlReader.test.ts b/packages/backend-defaults/src/entrypoints/urlReader/lib/BitbucketUrlReader.test.ts
index edd8d6d3fc..54880aaa75 100644
--- a/packages/backend-defaults/src/entrypoints/urlReader/lib/BitbucketUrlReader.test.ts
+++ b/packages/backend-defaults/src/entrypoints/urlReader/lib/BitbucketUrlReader.test.ts
@@ -22,7 +22,7 @@ import {
import {
createMockDirectory,
mockServices,
- setupRequestMockHandlers,
+ registerMswTestHooks,
} from '@backstage/backend-test-utils';
import fs from 'fs-extra';
import { rest } from 'msw';
@@ -104,7 +104,7 @@ describe('BitbucketUrlReader', () => {
);
const worker = setupServer();
- setupRequestMockHandlers(worker);
+ registerMswTestHooks(worker);
describe('readUrl', () => {
it('should be able to readUrl via buffer without ETag', async () => {
diff --git a/packages/backend-defaults/src/entrypoints/urlReader/lib/FetchUrlReader.test.ts b/packages/backend-defaults/src/entrypoints/urlReader/lib/FetchUrlReader.test.ts
index 38936806c6..f84422c564 100644
--- a/packages/backend-defaults/src/entrypoints/urlReader/lib/FetchUrlReader.test.ts
+++ b/packages/backend-defaults/src/entrypoints/urlReader/lib/FetchUrlReader.test.ts
@@ -18,7 +18,7 @@ import { ConfigReader } from '@backstage/config';
import { NotFoundError, NotModifiedError } from '@backstage/errors';
import {
mockServices,
- setupRequestMockHandlers,
+ registerMswTestHooks,
} from '@backstage/backend-test-utils';
import { rest } from 'msw';
import { setupServer } from 'msw/node';
@@ -30,7 +30,7 @@ const fetchUrlReader = new FetchUrlReader();
describe('FetchUrlReader', () => {
const worker = setupServer();
- setupRequestMockHandlers(worker);
+ registerMswTestHooks(worker);
beforeEach(() => {
jest.clearAllMocks();
diff --git a/packages/backend-defaults/src/entrypoints/urlReader/lib/GerritUrlReader.test.ts b/packages/backend-defaults/src/entrypoints/urlReader/lib/GerritUrlReader.test.ts
index 94627e074f..14ca4c018e 100644
--- a/packages/backend-defaults/src/entrypoints/urlReader/lib/GerritUrlReader.test.ts
+++ b/packages/backend-defaults/src/entrypoints/urlReader/lib/GerritUrlReader.test.ts
@@ -17,7 +17,7 @@
import {
createMockDirectory,
mockServices,
- setupRequestMockHandlers,
+ registerMswTestHooks,
} from '@backstage/backend-test-utils';
import { ConfigReader } from '@backstage/config';
import { NotModifiedError, NotFoundError } from '@backstage/errors';
@@ -92,7 +92,7 @@ const createReader = (config: JsonObject): UrlReaderPredicateTuple[] => {
// eslint-disable-next-line jest/no-disabled-tests
describe.skip('GerritUrlReader', () => {
const worker = setupServer();
- setupRequestMockHandlers(worker);
+ registerMswTestHooks(worker);
beforeEach(() => {
mockDir.clear();
diff --git a/packages/backend-defaults/src/entrypoints/urlReader/lib/GiteaUrlReader.test.ts b/packages/backend-defaults/src/entrypoints/urlReader/lib/GiteaUrlReader.test.ts
index 0b5983eefd..77c995c552 100644
--- a/packages/backend-defaults/src/entrypoints/urlReader/lib/GiteaUrlReader.test.ts
+++ b/packages/backend-defaults/src/entrypoints/urlReader/lib/GiteaUrlReader.test.ts
@@ -16,7 +16,7 @@
import {
mockServices,
- setupRequestMockHandlers,
+ registerMswTestHooks,
} from '@backstage/backend-test-utils';
import { ConfigReader } from '@backstage/config';
import { GiteaIntegration, readGiteaConfig } from '@backstage/integration';
@@ -64,7 +64,7 @@ const createReader = (config: JsonObject): UrlReaderPredicateTuple[] => {
describe('GiteaUrlReader', () => {
const worker = setupServer();
- setupRequestMockHandlers(worker);
+ registerMswTestHooks(worker);
afterAll(() => {
jest.clearAllMocks();
diff --git a/packages/backend-defaults/src/entrypoints/urlReader/lib/GithubUrlReader.test.ts b/packages/backend-defaults/src/entrypoints/urlReader/lib/GithubUrlReader.test.ts
index f07ada0cc3..f1dd7c0dc6 100644
--- a/packages/backend-defaults/src/entrypoints/urlReader/lib/GithubUrlReader.test.ts
+++ b/packages/backend-defaults/src/entrypoints/urlReader/lib/GithubUrlReader.test.ts
@@ -22,7 +22,7 @@ import {
} from '@backstage/integration';
import {
createMockDirectory,
- setupRequestMockHandlers,
+ registerMswTestHooks,
} from '@backstage/backend-test-utils';
import fs from 'fs-extra';
import { rest } from 'msw';
@@ -74,7 +74,7 @@ const gheProcessor = new GithubUrlReader(
describe('GithubUrlReader', () => {
const worker = setupServer();
- setupRequestMockHandlers(worker);
+ registerMswTestHooks(worker);
beforeEach(mockDir.clear);
diff --git a/packages/backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader.test.ts b/packages/backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader.test.ts
index 46276fcdda..dd6a0970d2 100644
--- a/packages/backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader.test.ts
+++ b/packages/backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader.test.ts
@@ -18,7 +18,7 @@ import { ConfigReader } from '@backstage/config';
import {
createMockDirectory,
mockServices,
- setupRequestMockHandlers,
+ registerMswTestHooks,
} from '@backstage/backend-test-utils';
import fs from 'fs-extra';
import { rest } from 'msw';
@@ -72,7 +72,7 @@ describe('GitlabUrlReader', () => {
beforeEach(mockDir.clear);
const worker = setupServer();
- setupRequestMockHandlers(worker);
+ registerMswTestHooks(worker);
describe('read', () => {
beforeEach(() => {
diff --git a/packages/backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader.ts b/packages/backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader.ts
index 615eeb20a2..35123da851 100644
--- a/packages/backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader.ts
+++ b/packages/backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader.ts
@@ -23,21 +23,21 @@ import {
UrlReaderServiceSearchOptions,
UrlReaderServiceSearchResponse,
} from '@backstage/backend-plugin-api';
+import { NotFoundError, NotModifiedError } from '@backstage/errors';
import {
+ GitLabIntegration,
+ ScmIntegrations,
getGitLabFileFetchUrl,
getGitLabIntegrationRelativePath,
getGitLabRequestOptions,
- GitLabIntegration,
- ScmIntegrations,
} from '@backstage/integration';
-import fetch, { Response } from 'node-fetch';
import parseGitUrl from 'git-url-parse';
-import { Minimatch } from 'minimatch';
-import { Readable } from 'stream';
-import { NotFoundError, NotModifiedError } from '@backstage/errors';
-import { ReadTreeResponseFactory, ReaderFactory } from './types';
import { trimEnd, trimStart } from 'lodash';
+import { Minimatch } from 'minimatch';
+import fetch, { Response } from 'node-fetch';
+import { Readable } from 'stream';
import { ReadUrlResponseFactory } from './ReadUrlResponseFactory';
+import { ReadTreeResponseFactory, ReaderFactory } from './types';
import { parseLastModified } from './util';
/**
@@ -71,14 +71,14 @@ export class GitlabUrlReader implements UrlReaderService {
url: string,
options?: UrlReaderServiceReadUrlOptions,
): Promise {
- const { etag, lastModifiedAfter, signal } = options ?? {};
+ const { etag, lastModifiedAfter, signal, token } = options ?? {};
const builtUrl = await this.getGitlabFetchUrl(url);
let response: Response;
try {
response = await fetch(builtUrl, {
headers: {
- ...getGitLabRequestOptions(this.integration.config).headers,
+ ...getGitLabRequestOptions(this.integration.config, token).headers,
...(etag && { 'If-None-Match': etag }),
...(lastModifiedAfter && {
'If-Modified-Since': lastModifiedAfter.toUTCString(),
@@ -120,7 +120,7 @@ export class GitlabUrlReader implements UrlReaderService {
url: string,
options?: UrlReaderServiceReadTreeOptions,
): Promise {
- const { etag, signal } = options ?? {};
+ const { etag, signal, token } = options ?? {};
const { ref, full_name, filepath } = parseGitUrl(url);
let repoFullName = full_name;
@@ -147,7 +147,7 @@ export class GitlabUrlReader implements UrlReaderService {
repoFullName,
)}`,
).toString(),
- getGitLabRequestOptions(this.integration.config),
+ getGitLabRequestOptions(this.integration.config, token),
);
if (!projectGitlabResponse.ok) {
const msg = `Failed to read tree from ${url}, ${projectGitlabResponse.status} ${projectGitlabResponse.statusText}`;
@@ -175,7 +175,7 @@ export class GitlabUrlReader implements UrlReaderService {
)}/repository/commits?${commitsReqParams.toString()}`,
).toString(),
{
- ...getGitLabRequestOptions(this.integration.config),
+ ...getGitLabRequestOptions(this.integration.config, token),
// TODO(freben): The signal cast is there because pre-3.x versions of
// node-fetch have a very slightly deviating AbortSignal type signature.
// The difference does not affect us in practice however. The cast can
@@ -209,7 +209,7 @@ export class GitlabUrlReader implements UrlReaderService {
repoFullName,
)}/repository/archive?${archiveReqParams.toString()}`,
{
- ...getGitLabRequestOptions(this.integration.config),
+ ...getGitLabRequestOptions(this.integration.config, token),
// TODO(freben): The signal cast is there because pre-3.x versions of
// node-fetch have a very slightly deviating AbortSignal type signature.
// The difference does not affect us in practice however. The cast can
diff --git a/packages/backend-defaults/src/entrypoints/urlReader/lib/HarnessUrlReader.test.ts b/packages/backend-defaults/src/entrypoints/urlReader/lib/HarnessUrlReader.test.ts
index f1efbca108..004e1931d0 100644
--- a/packages/backend-defaults/src/entrypoints/urlReader/lib/HarnessUrlReader.test.ts
+++ b/packages/backend-defaults/src/entrypoints/urlReader/lib/HarnessUrlReader.test.ts
@@ -16,7 +16,7 @@
import {
mockServices,
- setupRequestMockHandlers,
+ registerMswTestHooks,
} from '@backstage/backend-test-utils';
import { ConfigReader } from '@backstage/config';
import { HarnessIntegration, readHarnessConfig } from '@backstage/integration';
@@ -120,7 +120,7 @@ const handlers = [
describe('HarnessUrlReader', () => {
const worker = setupServer(...handlers);
- setupRequestMockHandlers(worker);
+ registerMswTestHooks(worker);
beforeAll(() => worker.listen({ onUnhandledRequest: 'bypass' }));
afterAll(() => {
jest.clearAllMocks();
diff --git a/packages/backend-defaults/src/entrypoints/urlReader/urlReaderServiceFactory.ts b/packages/backend-defaults/src/entrypoints/urlReader/urlReaderServiceFactory.ts
index 810882edf8..2639e99d83 100644
--- a/packages/backend-defaults/src/entrypoints/urlReader/urlReaderServiceFactory.ts
+++ b/packages/backend-defaults/src/entrypoints/urlReader/urlReaderServiceFactory.ts
@@ -14,12 +14,36 @@
* limitations under the License.
*/
+import { ReaderFactory } from './lib';
import { UrlReaders } from './lib/UrlReaders';
import {
coreServices,
createServiceFactory,
+ createServiceRef,
} from '@backstage/backend-plugin-api';
+/**
+ * @public
+ * A non-singleton reference to URL Reader factory services.
+ *
+ * @example
+ * Creating a service factory implementation for a Custom URL Reader.
+ * ```ts
+ * createServiceFactory({
+ * service: urlReaderFactoriesServiceRef,
+ * deps: {},
+ * async factory() {
+ * return CustomUrlReader.factory;
+ * },
+ * });
+ * ```
+ */
+export const urlReaderFactoriesServiceRef = createServiceRef({
+ id: 'core.urlReader.factories',
+ scope: 'plugin',
+ multiton: true,
+});
+
/**
* Reading content from external systems.
*
@@ -34,11 +58,13 @@ export const urlReaderServiceFactory = createServiceFactory({
deps: {
config: coreServices.rootConfig,
logger: coreServices.logger,
+ factories: urlReaderFactoriesServiceRef,
},
- async factory({ config, logger }) {
+ async factory({ config, logger, factories }) {
return UrlReaders.default({
config,
logger,
+ factories,
});
},
});
diff --git a/packages/backend-defaults/src/entrypoints/userInfo/DefaultUserInfoService.test.ts b/packages/backend-defaults/src/entrypoints/userInfo/DefaultUserInfoService.test.ts
index b63b24fb18..692d179ee2 100644
--- a/packages/backend-defaults/src/entrypoints/userInfo/DefaultUserInfoService.test.ts
+++ b/packages/backend-defaults/src/entrypoints/userInfo/DefaultUserInfoService.test.ts
@@ -17,7 +17,7 @@
import { BackstageUserPrincipal } from '@backstage/backend-plugin-api';
import {
mockServices,
- setupRequestMockHandlers,
+ registerMswTestHooks,
} from '@backstage/backend-test-utils';
import { JsonObject } from '@backstage/types';
import { SignJWT, base64url, importJWK } from 'jose';
@@ -28,7 +28,7 @@ import { DefaultUserInfoService } from './DefaultUserInfoService';
describe('DefaultUserInfoService', () => {
const server = setupServer();
- setupRequestMockHandlers(server);
+ registerMswTestHooks(server);
const mockPublicKey = {
kty: 'EC',
diff --git a/packages/backend-defaults/src/migrations.test.ts b/packages/backend-defaults/src/migrations.test.ts
new file mode 100644
index 0000000000..579c32e626
--- /dev/null
+++ b/packages/backend-defaults/src/migrations.test.ts
@@ -0,0 +1,123 @@
+/*
+ * Copyright 2024 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 { Knex } from 'knex';
+import { TestDatabases } from '@backstage/backend-test-utils';
+import fs from 'fs';
+
+const migrationsDir = `${__dirname}/../migrations/scheduler`;
+const migrationsFiles = fs.readdirSync(migrationsDir).sort();
+
+async function migrateUpOnce(knex: Knex): Promise {
+ await knex.migrate.up({ directory: migrationsDir });
+}
+
+async function migrateDownOnce(knex: Knex): Promise {
+ await knex.migrate.down({ directory: migrationsDir });
+}
+
+async function migrateUntilBefore(knex: Knex, target: string): Promise {
+ const index = migrationsFiles.indexOf(target);
+ if (index === -1) {
+ throw new Error(`Migration ${target} not found`);
+ }
+ for (let i = 0; i < index; i++) {
+ await migrateUpOnce(knex);
+ }
+}
+
+jest.setTimeout(60_000);
+
+describe('migrations', () => {
+ const databases = TestDatabases.create();
+
+ it.each(databases.eachSupportedId())(
+ '20210928160613_init.js, %p',
+ async databaseId => {
+ const knex = await databases.init(databaseId);
+
+ await migrateUntilBefore(knex, '20210928160613_init.js');
+ await migrateUpOnce(knex);
+
+ await knex('backstage_backend_tasks__tasks').insert({
+ id: 'test',
+ settings_json: '{}',
+ next_run_start_at: knex.fn.now(),
+ });
+
+ await expect(knex('backstage_backend_tasks__tasks')).resolves.toEqual([
+ {
+ id: 'test',
+ settings_json: '{}',
+ next_run_start_at: expect.anything(),
+ current_run_ticket: null,
+ current_run_started_at: null,
+ current_run_expires_at: null,
+ },
+ ]);
+
+ await migrateDownOnce(knex);
+
+ // This looks odd - you might expect a .toThrow at the end but that
+ // actually is flaky for some reason specifically on sqlite when
+ // performing multiple runs in sequence
+ await expect(knex('backstage_backend_tasks__tasks')).rejects.toEqual(
+ expect.anything(),
+ );
+
+ await knex.destroy();
+ },
+ );
+
+ it.each(databases.eachSupportedId())(
+ '20240712211735_nullable_next_run.js, %p',
+ async databaseId => {
+ const knex = await databases.init(databaseId);
+
+ await migrateUntilBefore(knex, '20240712211735_nullable_next_run.js');
+ await migrateUpOnce(knex);
+
+ await knex('backstage_backend_tasks__tasks').insert({
+ id: 'test',
+ settings_json: '{}',
+ next_run_start_at: knex.raw('null'),
+ });
+
+ await expect(knex('backstage_backend_tasks__tasks')).resolves.toEqual([
+ {
+ id: 'test',
+ settings_json: '{}',
+ next_run_start_at: null,
+ current_run_ticket: null,
+ current_run_started_at: null,
+ current_run_expires_at: null,
+ },
+ ]);
+
+ await migrateDownOnce(knex);
+
+ await expect(
+ knex('backstage_backend_tasks__tasks').insert({
+ id: 'test',
+ settings_json: '{}',
+ next_run_start_at: knex.raw('null'),
+ }),
+ ).rejects.toEqual(expect.anything());
+
+ await knex.destroy();
+ },
+ );
+});
diff --git a/packages/backend-dynamic-feature-service/CHANGELOG.md b/packages/backend-dynamic-feature-service/CHANGELOG.md
index 02f47ef7b4..14111873a1 100644
--- a/packages/backend-dynamic-feature-service/CHANGELOG.md
+++ b/packages/backend-dynamic-feature-service/CHANGELOG.md
@@ -1,5 +1,110 @@
# @backstage/backend-dynamic-feature-service
+## 0.2.16-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.8.0-next.2
+ - @backstage/backend-app-api@0.8.1-next.2
+ - @backstage/plugin-scaffolder-node@0.4.9-next.2
+ - @backstage/plugin-permission-common@0.8.1-next.1
+ - @backstage/backend-common@0.23.4-next.2
+ - @backstage/plugin-catalog-backend@1.24.1-next.2
+ - @backstage/config-loader@1.9.0-next.2
+ - @backstage/plugin-auth-node@0.5.0-next.2
+ - @backstage/plugin-permission-node@0.8.1-next.2
+ - @backstage/plugin-search-backend-node@1.2.28-next.2
+ - @backstage/plugin-search-common@1.2.14-next.1
+ - @backstage/backend-tasks@0.5.28-next.2
+ - @backstage/plugin-app-node@0.1.23-next.2
+ - @backstage/plugin-events-backend@0.3.10-next.2
+ - @backstage/plugin-events-node@0.3.9-next.2
+ - @backstage/cli-node@0.2.7
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+
+## 0.2.16-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/config-loader@1.9.0-next.1
+ - @backstage/plugin-permission-common@0.8.1-next.0
+ - @backstage/plugin-catalog-backend@1.24.1-next.1
+ - @backstage/plugin-permission-node@0.8.1-next.1
+ - @backstage/backend-plugin-api@0.7.1-next.1
+ - @backstage/backend-app-api@0.8.1-next.1
+ - @backstage/backend-common@0.23.4-next.1
+ - @backstage/plugin-app-node@0.1.23-next.1
+ - @backstage/plugin-search-backend-node@1.2.28-next.1
+ - @backstage/plugin-search-common@1.2.14-next.0
+ - @backstage/backend-tasks@0.5.28-next.1
+ - @backstage/cli-common@0.1.14
+ - @backstage/cli-node@0.2.7
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.4.18-next.1
+ - @backstage/plugin-events-backend@0.3.10-next.1
+ - @backstage/plugin-events-node@0.3.9-next.1
+ - @backstage/plugin-scaffolder-node@0.4.9-next.1
+
+## 0.2.16-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.23.4-next.0
+ - @backstage/plugin-catalog-backend@1.24.1-next.0
+ - @backstage/config-loader@1.8.2-next.0
+ - @backstage/backend-app-api@0.8.1-next.0
+ - @backstage/backend-plugin-api@0.7.1-next.0
+ - @backstage/backend-tasks@0.5.28-next.0
+ - @backstage/cli-common@0.1.14
+ - @backstage/cli-node@0.2.7
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+ - @backstage/plugin-app-node@0.1.23-next.0
+ - @backstage/plugin-auth-node@0.4.18-next.0
+ - @backstage/plugin-events-backend@0.3.10-next.0
+ - @backstage/plugin-events-node@0.3.9-next.0
+ - @backstage/plugin-permission-common@0.8.0
+ - @backstage/plugin-permission-node@0.8.1-next.0
+ - @backstage/plugin-scaffolder-node@0.4.9-next.0
+ - @backstage/plugin-search-backend-node@1.2.28-next.0
+ - @backstage/plugin-search-common@1.2.13
+
+## 0.2.15
+
+### Patch Changes
+
+- b05e1e1: Service factories exported by this package have been updated to use the new service factory format that doesn't use a callback.
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.7.0
+ - @backstage/backend-app-api@0.8.0
+ - @backstage/backend-common@0.23.3
+ - @backstage/cli-node@0.2.7
+ - @backstage/backend-tasks@0.5.27
+ - @backstage/plugin-permission-common@0.8.0
+ - @backstage/plugin-permission-node@0.8.0
+ - @backstage/plugin-scaffolder-node@0.4.8
+ - @backstage/plugin-events-node@0.3.8
+ - @backstage/plugin-auth-node@0.4.17
+ - @backstage/plugin-catalog-backend@1.24.0
+ - @backstage/plugin-app-node@0.1.22
+ - @backstage/plugin-events-backend@0.3.9
+ - @backstage/plugin-search-backend-node@1.2.27
+ - @backstage/config-loader@1.8.1
+ - @backstage/plugin-search-common@1.2.13
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+
## 0.2.15-next.1
### Patch Changes
diff --git a/packages/backend-dynamic-feature-service/api-report.md b/packages/backend-dynamic-feature-service/api-report.md
index 20db7db71b..97dea60170 100644
--- a/packages/backend-dynamic-feature-service/api-report.md
+++ b/packages/backend-dynamic-feature-service/api-report.md
@@ -28,7 +28,7 @@ import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { PluginTaskScheduler } from '@backstage/backend-tasks';
import { RootLoggerService } from '@backstage/backend-plugin-api';
import { Router } from 'express';
-import { ServiceFactory } from '@backstage/backend-plugin-api';
+import { ServiceFactoryCompat } from '@backstage/backend-plugin-api';
import { ServiceRef } from '@backstage/backend-plugin-api';
import { TaskRunner } from '@backstage/backend-tasks';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
@@ -114,18 +114,22 @@ export interface DynamicPluginsFactoryOptions {
}
// @public (undocumented)
-export const dynamicPluginsFeatureDiscoveryServiceFactory: () => ServiceFactory<
+export const dynamicPluginsFeatureDiscoveryServiceFactory: ServiceFactoryCompat<
FeatureDiscoveryService,
- 'root'
+ 'root',
+ 'singleton',
+ undefined
>;
// @public (undocumented)
export const dynamicPluginsFrontendSchemas: BackendFeatureCompat;
// @public (undocumented)
-export const dynamicPluginsRootLoggerServiceFactory: () => ServiceFactory<
+export const dynamicPluginsRootLoggerServiceFactory: ServiceFactoryCompat<
RootLoggerService,
- 'root'
+ 'root',
+ 'singleton',
+ undefined
>;
// @public (undocumented)
@@ -142,19 +146,26 @@ export interface DynamicPluginsSchemasService {
}
// @public (undocumented)
-export const dynamicPluginsSchemasServiceFactory: (
- options?: DynamicPluginsSchemasOptions | undefined,
-) => ServiceFactory;
+export const dynamicPluginsSchemasServiceFactory: ServiceFactoryCompat<
+ DynamicPluginsSchemasService,
+ 'root',
+ 'singleton',
+ DynamicPluginsSchemasOptions
+>;
// @public (undocumented)
-export const dynamicPluginsServiceFactory: (
- options?: DynamicPluginsFactoryOptions | undefined,
-) => ServiceFactory;
+export const dynamicPluginsServiceFactory: ServiceFactoryCompat<
+ DynamicPluginProvider,
+ 'root',
+ 'singleton',
+ DynamicPluginsFactoryOptions
+>;
// @public (undocumented)
export const dynamicPluginsServiceRef: ServiceRef<
DynamicPluginProvider,
- 'root'
+ 'root',
+ 'singleton'
>;
// @public (undocumented)
diff --git a/packages/backend-dynamic-feature-service/package.json b/packages/backend-dynamic-feature-service/package.json
index 3e3e566879..d6ac21a3ae 100644
--- a/packages/backend-dynamic-feature-service/package.json
+++ b/packages/backend-dynamic-feature-service/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/backend-dynamic-feature-service",
"description": "Backstage dynamic feature service",
- "version": "0.2.15-next.1",
+ "version": "0.2.16-next.2",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
diff --git a/packages/backend-legacy/CHANGELOG.md b/packages/backend-legacy/CHANGELOG.md
index 35ed7a6c93..a601890055 100644
--- a/packages/backend-legacy/CHANGELOG.md
+++ b/packages/backend-legacy/CHANGELOG.md
@@ -1,5 +1,172 @@
# example-backend-legacy
+## 0.2.101-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-backend@1.23.1-next.2
+ - @backstage/plugin-permission-common@0.8.1-next.1
+ - @backstage/plugin-scaffolder-backend-module-confluence-to-markdown@0.2.24-next.2
+ - @backstage/plugin-search-backend-module-techdocs@0.1.28-next.2
+ - @backstage/plugin-search-backend-module-explore@0.1.29-next.2
+ - @backstage/plugin-kubernetes-backend@0.18.4-next.2
+ - @backstage/plugin-permission-backend@0.5.47-next.2
+ - @backstage/plugin-devtools-backend@0.3.9-next.2
+ - @backstage/plugin-techdocs-backend@1.10.10-next.2
+ - @backstage/backend-common@0.23.4-next.2
+ - @backstage/plugin-catalog-backend@1.24.1-next.2
+ - @backstage/plugin-signals-backend@0.1.9-next.2
+ - @backstage/plugin-proxy-backend@0.5.4-next.2
+ - @backstage/plugin-auth-backend@0.22.10-next.2
+ - @backstage/plugin-app-backend@0.3.72-next.2
+ - @backstage/plugin-auth-node@0.5.0-next.2
+ - @backstage/plugin-permission-node@0.8.1-next.2
+ - @backstage/plugin-search-backend-node@1.2.28-next.2
+ - @backstage/plugin-search-backend@1.5.15-next.2
+ - @backstage/backend-tasks@0.5.28-next.2
+ - @backstage/plugin-catalog-node@1.12.5-next.2
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.21-next.2
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.4.10-next.2
+ - @backstage/plugin-events-backend@0.3.10-next.2
+ - @backstage/plugin-events-node@0.3.9-next.2
+ - @backstage/plugin-scaffolder-backend-module-gitlab@0.4.5-next.2
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.40-next.2
+ - @backstage/plugin-search-backend-module-catalog@0.1.29-next.2
+ - @backstage/plugin-search-backend-module-elasticsearch@1.5.4-next.2
+ - @backstage/plugin-search-backend-module-pg@0.5.33-next.2
+ - @backstage/plugin-signals-node@0.1.9-next.2
+ - @backstage/integration@1.14.0-next.0
+ - @backstage/catalog-client@1.6.5
+ - @backstage/catalog-model@1.5.0
+ - @backstage/config@1.2.0
+
+## 0.2.101-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-techdocs-backend@1.10.10-next.1
+ - @backstage/plugin-permission-common@0.8.1-next.0
+ - @backstage/plugin-catalog-backend@1.24.1-next.1
+ - @backstage/plugin-permission-node@0.8.1-next.1
+ - @backstage/plugin-search-backend-module-explore@0.1.29-next.1
+ - @backstage/plugin-scaffolder-backend@1.23.1-next.1
+ - @backstage/plugin-auth-backend@0.22.10-next.1
+ - @backstage/plugin-search-backend-module-techdocs@0.1.28-next.1
+ - example-app@0.2.100-next.1
+ - @backstage/backend-common@0.23.4-next.1
+ - @backstage/integration@1.14.0-next.0
+ - @backstage/plugin-app-backend@0.3.72-next.1
+ - @backstage/plugin-devtools-backend@0.3.9-next.1
+ - @backstage/plugin-proxy-backend@0.5.4-next.1
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.4.10-next.1
+ - @backstage/plugin-catalog-node@1.12.5-next.1
+ - @backstage/plugin-kubernetes-backend@0.18.4-next.1
+ - @backstage/plugin-permission-backend@0.5.47-next.1
+ - @backstage/plugin-search-backend@1.5.15-next.1
+ - @backstage/plugin-search-backend-module-catalog@0.1.29-next.1
+ - @backstage/plugin-search-backend-node@1.2.28-next.1
+ - @backstage/backend-tasks@0.5.28-next.1
+ - @backstage/catalog-client@1.6.5
+ - @backstage/catalog-model@1.5.0
+ - @backstage/config@1.2.0
+ - @backstage/plugin-auth-node@0.4.18-next.1
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.21-next.1
+ - @backstage/plugin-events-backend@0.3.10-next.1
+ - @backstage/plugin-events-node@0.3.9-next.1
+ - @backstage/plugin-scaffolder-backend-module-confluence-to-markdown@0.2.24-next.1
+ - @backstage/plugin-scaffolder-backend-module-gitlab@0.4.5-next.1
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.40-next.1
+ - @backstage/plugin-search-backend-module-elasticsearch@1.5.4-next.1
+ - @backstage/plugin-search-backend-module-pg@0.5.33-next.1
+ - @backstage/plugin-signals-backend@0.1.9-next.1
+ - @backstage/plugin-signals-node@0.1.9-next.1
+
+## 0.2.101-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.23.4-next.0
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.40-next.0
+ - @backstage/plugin-scaffolder-backend-module-gitlab@0.4.5-next.0
+ - @backstage/plugin-catalog-backend@1.24.1-next.0
+ - @backstage/plugin-catalog-node@1.12.5-next.0
+ - @backstage/plugin-devtools-backend@0.3.9-next.0
+ - @backstage/integration@1.14.0-next.0
+ - @backstage/plugin-search-backend-module-pg@0.5.33-next.0
+ - example-app@0.2.100-next.0
+ - @backstage/backend-tasks@0.5.28-next.0
+ - @backstage/catalog-client@1.6.5
+ - @backstage/catalog-model@1.5.0
+ - @backstage/config@1.2.0
+ - @backstage/plugin-app-backend@0.3.72-next.0
+ - @backstage/plugin-auth-backend@0.22.10-next.0
+ - @backstage/plugin-auth-node@0.4.18-next.0
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.21-next.0
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.4.10-next.0
+ - @backstage/plugin-events-backend@0.3.10-next.0
+ - @backstage/plugin-events-node@0.3.9-next.0
+ - @backstage/plugin-kubernetes-backend@0.18.4-next.0
+ - @backstage/plugin-permission-backend@0.5.47-next.0
+ - @backstage/plugin-permission-common@0.8.0
+ - @backstage/plugin-permission-node@0.8.1-next.0
+ - @backstage/plugin-proxy-backend@0.5.4-next.0
+ - @backstage/plugin-scaffolder-backend@1.23.1-next.0
+ - @backstage/plugin-scaffolder-backend-module-confluence-to-markdown@0.2.24-next.0
+ - @backstage/plugin-search-backend@1.5.15-next.0
+ - @backstage/plugin-search-backend-module-catalog@0.1.29-next.0
+ - @backstage/plugin-search-backend-module-elasticsearch@1.5.4-next.0
+ - @backstage/plugin-search-backend-module-explore@0.1.29-next.0
+ - @backstage/plugin-search-backend-module-techdocs@0.1.28-next.0
+ - @backstage/plugin-search-backend-node@1.2.28-next.0
+ - @backstage/plugin-signals-backend@0.1.9-next.0
+ - @backstage/plugin-signals-node@0.1.9-next.0
+ - @backstage/plugin-techdocs-backend@1.10.10-next.0
+
+## 0.2.100
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.23.3
+ - @backstage/backend-tasks@0.5.27
+ - @backstage/plugin-scaffolder-backend@1.23.0
+ - @backstage/plugin-permission-common@0.8.0
+ - @backstage/plugin-permission-backend@0.5.46
+ - @backstage/plugin-permission-node@0.8.0
+ - @backstage/plugin-techdocs-backend@1.10.9
+ - @backstage/plugin-scaffolder-backend-module-gitlab@0.4.4
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.39
+ - @backstage/integration@1.13.0
+ - @backstage/plugin-events-node@0.3.8
+ - @backstage/plugin-auth-node@0.4.17
+ - @backstage/plugin-search-backend@1.5.14
+ - @backstage/plugin-catalog-backend@1.24.0
+ - @backstage/plugin-app-backend@0.3.71
+ - @backstage/plugin-auth-backend@0.22.9
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.20
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.4.9
+ - @backstage/plugin-catalog-node@1.12.4
+ - @backstage/plugin-devtools-backend@0.3.8
+ - @backstage/plugin-events-backend@0.3.9
+ - @backstage/plugin-kubernetes-backend@0.18.3
+ - @backstage/plugin-proxy-backend@0.5.3
+ - @backstage/plugin-scaffolder-backend-module-confluence-to-markdown@0.2.23
+ - @backstage/plugin-search-backend-module-catalog@0.1.28
+ - @backstage/plugin-search-backend-module-elasticsearch@1.5.3
+ - @backstage/plugin-search-backend-module-explore@0.1.28
+ - @backstage/plugin-search-backend-module-pg@0.5.32
+ - @backstage/plugin-search-backend-module-techdocs@0.1.27
+ - @backstage/plugin-search-backend-node@1.2.27
+ - @backstage/plugin-signals-backend@0.1.8
+ - @backstage/plugin-signals-node@0.1.8
+ - example-app@0.2.99
+ - @backstage/catalog-client@1.6.5
+ - @backstage/catalog-model@1.5.0
+ - @backstage/config@1.2.0
+
## 0.2.100-next.2
### Patch Changes
diff --git a/packages/backend-legacy/package.json b/packages/backend-legacy/package.json
index a537361746..a650924720 100644
--- a/packages/backend-legacy/package.json
+++ b/packages/backend-legacy/package.json
@@ -1,6 +1,6 @@
{
"name": "example-backend-legacy",
- "version": "0.2.100-next.2",
+ "version": "0.2.101-next.2",
"backstage": {
"role": "backend"
},
diff --git a/packages/backend-openapi-utils/CHANGELOG.md b/packages/backend-openapi-utils/CHANGELOG.md
index 43a57f7d8c..682036d984 100644
--- a/packages/backend-openapi-utils/CHANGELOG.md
+++ b/packages/backend-openapi-utils/CHANGELOG.md
@@ -1,5 +1,37 @@
# @backstage/backend-openapi-utils
+## 0.1.16-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.8.0-next.2
+ - @backstage/errors@1.2.4
+
+## 0.1.16-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.7.1-next.1
+ - @backstage/errors@1.2.4
+
+## 0.1.16-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.7.1-next.0
+ - @backstage/errors@1.2.4
+
+## 0.1.15
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.7.0
+ - @backstage/errors@1.2.4
+
## 0.1.15-next.1
### Patch Changes
diff --git a/packages/backend-openapi-utils/package.json b/packages/backend-openapi-utils/package.json
index f35863c6e3..35db691c25 100644
--- a/packages/backend-openapi-utils/package.json
+++ b/packages/backend-openapi-utils/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/backend-openapi-utils",
"description": "OpenAPI typescript support.",
- "version": "0.1.15-next.1",
+ "version": "0.1.16-next.2",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/packages/backend-plugin-api/CHANGELOG.md b/packages/backend-plugin-api/CHANGELOG.md
index cb341b218e..d404d05b33 100644
--- a/packages/backend-plugin-api/CHANGELOG.md
+++ b/packages/backend-plugin-api/CHANGELOG.md
@@ -1,5 +1,222 @@
# @backstage/backend-plugin-api
+## 0.8.0-next.2
+
+### Minor Changes
+
+- 7c5f3b0: The `createServiceRef` function now accepts a new boolean `multiple` option. The `multiple` option defaults to `false` and when set to `true`, it enables that multiple implementation are installed for the created service ref.
+
+ We're looking for ways to make it possible to augment services without the need to replace the entire service.
+
+ Typical example of that being the ability to install support for additional targets for the `UrlReader` service without replacing the service itself. This achieves that by allowing us to define services that can have multiple simultaneous implementation, allowing the `UrlReader` implementation to depend on such a service to collect all possible implementation of support for external targets:
+
+ ```diff
+ // @backstage/backend-defaults
+
+ + export const urlReaderFactoriesServiceRef = createServiceRef({
+ + id: 'core.urlReader.factories',
+ + scope: 'plugin',
+ + multiton: true,
+ + });
+
+ ...
+
+ export const urlReaderServiceFactory = createServiceFactory({
+ service: coreServices.urlReader,
+ deps: {
+ config: coreServices.rootConfig,
+ logger: coreServices.logger,
+ + factories: urlReaderFactoriesServiceRef,
+ },
+ - async factory({ config, logger }) {
+ + async factory({ config, logger, factories }) {
+ return UrlReaders.default({
+ config,
+ logger,
+ + factories,
+ });
+ },
+ });
+ ```
+
+ With that, you can then add more custom `UrlReader` factories by installing more implementations of the `urlReaderFactoriesServiceRef` in your backend instance. Something like:
+
+ ```ts
+ // packages/backend/index.ts
+ import { createServiceFactory } from '@backstage/backend-plugin-api';
+ import { urlReaderFactoriesServiceRef } from '@backstage/backend-defaults';
+ ...
+
+ backend.add(createServiceFactory({
+ service: urlReaderFactoriesServiceRef,
+ deps: {},
+ async factory() {
+ return CustomUrlReader.factory;
+ },
+ }));
+
+ ...
+
+ ```
+
+### Patch Changes
+
+- 6061061: Added `createBackendFeatureLoader`, which can be used to create an installable backend feature that can in turn load in additional backend features in a dynamic way.
+- ba9abf4: The `SchedulerService` now allows tasks with `frequency: { trigger: 'manual' }`. This means that the task will not be scheduled, but rather run only when manually triggered with `SchedulerService.triggerTask`.
+- 8b13183: Added `createBackendFeatureLoader`, which can be used to programmatically select and install backend features.
+
+ A feature loader can return an list of features to be installed, for example in the form on an `Array` or other for of iterable, which allows for the loader to be defined as a generator function. Both synchronous and asynchronous loaders are supported.
+
+ Additionally, a loader can depend on services in its implementation, with the restriction that it can only depend on root-scoped services, and it may not override services that have already been instantiated.
+
+ ```ts
+ const searchLoader = createBackendFeatureLoader({
+ deps: {
+ config: coreServices.rootConfig,
+ },
+ *loader({ config }) {
+ // Example of a custom config flag to enable search
+ if (config.getOptionalString('customFeatureToggle.search')) {
+ yield import('@backstage/plugin-search-backend/alpha');
+ yield import('@backstage/plugin-search-backend-module-catalog/alpha');
+ yield import('@backstage/plugin-search-backend-module-explore/alpha');
+ yield import('@backstage/plugin-search-backend-module-techdocs/alpha');
+ }
+ },
+ });
+ ```
+
+- Updated dependencies
+ - @backstage/plugin-permission-common@0.8.1-next.1
+ - @backstage/plugin-auth-node@0.5.0-next.2
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+
+## 0.7.1-next.1
+
+### Patch Changes
+
+- f011d1b: fix typo in `getPluginRequestToken` comments
+- Updated dependencies
+ - @backstage/plugin-permission-common@0.8.1-next.0
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.4.18-next.1
+
+## 0.7.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/cli-common@0.1.14
+ - @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-permission-common@0.8.0
+
+## 0.7.0
+
+### Minor Changes
+
+- 36f91e8: **BREAKING**: The `PermissionsService` no longer supports passing the deprecated `token` option, and the request options are now required.
+
+### Patch Changes
+
+- 53ced70: Added a new Root Health Service which adds new endpoints for health checks.
+- 083eaf9: Fix bug where ISO durations could no longer be used for schedules
+- 062c01c: Deprecated the ability to define options for service factories through `createServiceFactory`. In the future all service factories will return a plain `ServiceFactory` object, rather than allowing users to pass options to the factory. To allow for customization of a service implementation one can instead export one or a few building blocks that allows for simple re-implementation of the service instead.
+
+ For example, instead of:
+
+ ```ts
+ export const fooServiceFactory = createServiceFactory(
+ (options?: { bar: string }) => ({
+ service: fooServiceRef,
+ deps: { logger: coreServices.logger },
+ factory({ logger }) {
+ return {
+ // Implementation of the foo service using the `bar` option.
+ };
+ },
+ }),
+ );
+ ```
+
+ We instead encourage service implementations to provide an easy to use API for re-implementing the service for advanced use-cases:
+
+ ```ts
+ /** @public */
+ export class DefaultFooService implements FooService {
+ static create(options: { bar: string; logger: LoggerService }) {
+ return new DefaultFooService(options.logger, options.bar ?? 'default');
+ }
+
+ private constructor(
+ private readonly logger: string,
+ private readonly bar: string,
+ ) {}
+
+ // The rest of the implementation
+ }
+ ```
+
+ A user that wishes to customize the service can then easily do so by defining their own factory:
+
+ ```ts
+ export const customFooServiceFactory = createServiceFactory({
+ service: fooServiceRef,
+ deps: { logger: coreServices.logger },
+ factory({ logger }) {
+ return DefaultFooService.create({ logger, bar: 'baz' });
+ },
+ });
+ ```
+
+ This is of course more verbose than the previous solution where the factory could be customized through `fooServiceFactory({ bar: 'baz' })`, but this is a simplified which in practice should be using static configuration instead.
+
+ In cases where the old options patterns significantly improves the usability of the service factory, the old pattern can still be implemented like this:
+
+ ```ts
+ const fooServiceFactoryWithOptions = (options?: { bar: string }) =>
+ createServiceFactory({
+ service: fooServiceRef,
+ deps: { logger: coreServices.logger },
+ factory({ logger }) {
+ return {
+ // Implementation of the foo service using the `bar` option.
+ };
+ },
+ });
+
+ export const fooServiceFactory = Object.assign(
+ fooServiceFactoryWithOptions,
+ fooServiceFactoryWithOptions(),
+ );
+ ```
+
+ This change is being made because the ability to define an options callback encourages bad design of services factories. When possible, a service should be configurable through static configuration, and the existence of options may discourage that. More importantly though, the existing options do not work well with the dependency injection system of services, which is a problem for callbacks an other more advanced options. This lead to a bad pattern where only a few explicit dependencies where made available in callbacks, rather than providing an API that allowed simple re-implementation of the service with full access to dependency injection.
+
+ A separate benefit of this change is that it simplifies the TypeScript types in a way that allows TypeScript to provide a much better error message when a service factory doesn't properly implement the service interface.
+
+- fe47a3e: All service config types were renamed to option types in order to standardize frontend and backend `create*` function signatures:
+
+ - The `ServiceRefConfig` type was renamed to`ServiceRefOptions`;
+ - The `RootServiceFactoryConfig` type was renamed to `RootServiceFactoryOptions`;
+ - The `PluginServiceFactoryConfig` type was renamed to `PluginServiceFactoryOptions`
+
+- Updated dependencies
+ - @backstage/plugin-permission-common@0.8.0
+ - @backstage/plugin-auth-node@0.4.17
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+
## 0.6.22-next.1
### Patch Changes
diff --git a/packages/backend-plugin-api/api-report-alpha.md b/packages/backend-plugin-api/api-report-alpha.md
index 81b378a671..0f4348336a 100644
--- a/packages/backend-plugin-api/api-report-alpha.md
+++ b/packages/backend-plugin-api/api-report-alpha.md
@@ -17,7 +17,8 @@ export interface FeatureDiscoveryService {
// @alpha
export const featureDiscoveryServiceRef: ServiceRef<
FeatureDiscoveryService,
- 'root'
+ 'root',
+ 'singleton'
>;
// (No @packageDocumentation comment for this package)
diff --git a/packages/backend-plugin-api/api-report.md b/packages/backend-plugin-api/api-report.md
index 7b1e6ef2d3..e5189dce4d 100644
--- a/packages/backend-plugin-api/api-report.md
+++ b/packages/backend-plugin-api/api-report.md
@@ -9,6 +9,7 @@ import { AuthorizePermissionRequest } from '@backstage/plugin-permission-common'
import { AuthorizePermissionResponse } from '@backstage/plugin-permission-common';
import { Config } from '@backstage/config';
import { Duration } from 'luxon';
+import { EvaluatorRequestOptions } from '@backstage/plugin-permission-common';
import { Handler } from 'express';
import { HumanDuration } from '@backstage/types';
import { IdentityApi } from '@backstage/plugin-auth-node';
@@ -188,28 +189,73 @@ export type CacheServiceSetOptions = {
// @public
export namespace coreServices {
- const auth: ServiceRef;
- const userInfo: ServiceRef;
- const cache: ServiceRef;
- const rootConfig: ServiceRef;
- const database: ServiceRef;
- const discovery: ServiceRef;
- const rootHealth: ServiceRef;
- const httpAuth: ServiceRef;
- const httpRouter: ServiceRef;
- const lifecycle: ServiceRef;
- const logger: ServiceRef;
- const permissions: ServiceRef;
- const pluginMetadata: ServiceRef;
- const rootHttpRouter: ServiceRef;
- const rootLifecycle: ServiceRef;
- const rootLogger: ServiceRef;
- const scheduler: ServiceRef;
+ const auth: ServiceRef;
+ const userInfo: ServiceRef;
+ const cache: ServiceRef;
+ const rootConfig: ServiceRef;
+ const database: ServiceRef;
+ const discovery: ServiceRef;
+ const rootHealth: ServiceRef;
+ const httpAuth: ServiceRef;
+ const httpRouter: ServiceRef;
+ const lifecycle: ServiceRef;
+ const logger: ServiceRef;
+ const permissions: ServiceRef;
+ const pluginMetadata: ServiceRef<
+ PluginMetadataService,
+ 'plugin',
+ 'singleton'
+ >;
+ const rootHttpRouter: ServiceRef;
+ const rootLifecycle: ServiceRef;
+ const rootLogger: ServiceRef;
+ const scheduler: ServiceRef;
const // @deprecated
- tokenManager: ServiceRef;
- const urlReader: ServiceRef;
+ tokenManager: ServiceRef;
+ const urlReader: ServiceRef;
const // @deprecated
- identity: ServiceRef;
+ identity: ServiceRef;
+}
+
+// @public
+export function createBackendFeatureLoader<
+ TDeps extends {
+ [name in string]: unknown;
+ },
+>(options: CreateBackendFeatureLoaderOptions): BackendFeature;
+
+// @public
+export interface CreateBackendFeatureLoaderOptions<
+ TDeps extends {
+ [name in string]: unknown;
+ },
+> {
+ // (undocumented)
+ deps?: {
+ [name in keyof TDeps]: ServiceRef;
+ };
+ // (undocumented)
+ loader(deps: TDeps):
+ | Iterable<
+ | BackendFeature
+ | Promise<{
+ default: BackendFeature;
+ }>
+ >
+ | Promise<
+ Iterable<
+ | BackendFeature
+ | Promise<{
+ default: BackendFeature;
+ }>
+ >
+ >
+ | AsyncIterable<
+ | BackendFeature
+ | {
+ default: BackendFeature;
+ }
+ >;
}
// @public
@@ -250,18 +296,20 @@ export interface CreateExtensionPointOptions {
// @public
export function createServiceFactory<
TService,
+ TInstances extends 'singleton' | 'multiton',
TImpl extends TService,
TDeps extends {
[name in string]: ServiceRef;
},
TOpts extends object | undefined = undefined,
>(
- options: RootServiceFactoryOptions,
-): () => ServiceFactory;
+ options: RootServiceFactoryOptions,
+): ServiceFactoryCompat;
-// @public
+// @public @deprecated
export function createServiceFactory<
TService,
+ TInstances extends 'singleton' | 'multiton',
TImpl extends TService,
TDeps extends {
[name in string]: ServiceRef;
@@ -270,12 +318,13 @@ export function createServiceFactory<
>(
options: (
options?: TOpts,
- ) => RootServiceFactoryOptions,
-): (options?: TOpts) => ServiceFactory;
+ ) => RootServiceFactoryOptions,
+): ServiceFactoryCompat;
// @public
export function createServiceFactory<
TService,
+ TInstances extends 'singleton' | 'multiton',
TImpl extends TService,
TDeps extends {
[name in string]: ServiceRef;
@@ -283,12 +332,19 @@ export function createServiceFactory<
TContext = undefined,
TOpts extends object | undefined = undefined,
>(
- options: PluginServiceFactoryOptions,
-): () => ServiceFactory;
+ options: PluginServiceFactoryOptions<
+ TService,
+ TInstances,
+ TContext,
+ TImpl,
+ TDeps
+ >,
+): ServiceFactoryCompat;
-// @public
+// @public @deprecated
export function createServiceFactory<
TService,
+ TInstances extends 'singleton' | 'multiton',
TImpl extends TService,
TDeps extends {
[name in string]: ServiceRef;
@@ -298,18 +354,34 @@ export function createServiceFactory<
>(
options: (
options?: TOpts,
- ) => PluginServiceFactoryOptions,
-): (options?: TOpts) => ServiceFactory;
+ ) => PluginServiceFactoryOptions<
+ TService,
+ TInstances,
+ TContext,
+ TImpl,
+ TDeps
+ >,
+): ServiceFactoryCompat;
// @public
export function createServiceRef(
- options: ServiceRefOptions,
-): ServiceRef;
+ options: ServiceRefOptions,
+): ServiceRef;
// @public
export function createServiceRef(
- options: ServiceRefOptions,
-): ServiceRef;
+ options: ServiceRefOptions,
+): ServiceRef;
+
+// @public
+export function createServiceRef(
+ options: ServiceRefOptions,
+): ServiceRef;
+
+// @public
+export function createServiceRef(
+ options: ServiceRefOptions,
+): ServiceRef;
// @public
export interface DatabaseService {
@@ -423,22 +495,20 @@ export interface LoggerService {
export interface PermissionsService extends PermissionEvaluator {
authorize(
requests: AuthorizePermissionRequest[],
- options?: PermissionsServiceRequestOptions,
+ options: PermissionsServiceRequestOptions,
): Promise;
authorizeConditional(
requests: QueryPermissionRequest[],
- options?: PermissionsServiceRequestOptions,
+ options: PermissionsServiceRequestOptions,
): Promise;
}
// @public
-export type PermissionsServiceRequestOptions =
- | {
- token?: string;
- }
- | {
- credentials: BackstageCredentials;
- };
+export interface PermissionsServiceRequestOptions
+ extends EvaluatorRequestOptions {
+ // (undocumented)
+ credentials: BackstageCredentials;
+}
// @public
export interface PluginMetadataService {
@@ -448,16 +518,18 @@ export interface PluginMetadataService {
// @public @deprecated (undocumented)
export type PluginServiceFactoryConfig<
TService,
+ TInstances extends 'singleton' | 'multiton',
TContext,
TImpl extends TService,
TDeps extends {
[name in string]: ServiceRef;
},
-> = PluginServiceFactoryOptions;
+> = PluginServiceFactoryOptions;
// @public (undocumented)
export interface PluginServiceFactoryOptions<
TService,
+ TInstances extends 'singleton' | 'multiton',
TContext,
TImpl extends TService,
TDeps extends {
@@ -477,7 +549,7 @@ export interface PluginServiceFactoryOptions<
): TImpl | Promise;
initialization?: 'always' | 'lazy';
// (undocumented)
- service: ServiceRef;
+ service: ServiceRef;
}
// @public
@@ -539,15 +611,17 @@ export interface RootLoggerService extends LoggerService {}
// @public @deprecated (undocumented)
export type RootServiceFactoryConfig<
TService,
+ TInstances extends 'singleton' | 'multiton',
TImpl extends TService,
TDeps extends {
[name in string]: ServiceRef;
},
-> = RootServiceFactoryOptions;
+> = RootServiceFactoryOptions;
// @public (undocumented)
export interface RootServiceFactoryOptions<
- TService,
+ TService, // TODO(Rugvip): Can we forward the entire service ref type here instead of forwarding each type arg once the callback form is gone?
+ TInstances extends 'singleton' | 'multiton',
TImpl extends TService,
TDeps extends {
[name in string]: ServiceRef;
@@ -559,7 +633,7 @@ export interface RootServiceFactoryOptions<
factory(deps: ServiceRefsToInstances): TImpl | Promise;
initialization?: 'always' | 'lazy';
// (undocumented)
- service: ServiceRef;
+ service: ServiceRef