${notification.content}
`; -+ const html = await getNotificationHtmlContent(notification); -+ return html; - }, - }); - }, - }); - }, -}); -``` diff --git a/.changeset/spotty-planets-accept.md b/.changeset/spotty-planets-accept.md deleted file mode 100644 index 7342f89bd1..0000000000 --- a/.changeset/spotty-planets-accept.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@backstage/plugin-scaffolder': patch ---- - -Cleaned up codebase of RepoUrlPicker diff --git a/.changeset/strange-papayas-beg.md b/.changeset/strange-papayas-beg.md deleted file mode 100644 index 6ce33fb029..0000000000 --- a/.changeset/strange-papayas-beg.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@backstage/plugin-scaffolder-backend-module-gitlab': patch ---- - -Added test cases for gitlab:pipeline:trigger examples diff --git a/.changeset/strong-otters-compete.md b/.changeset/strong-otters-compete.md deleted file mode 100644 index fdcb982b88..0000000000 --- a/.changeset/strong-otters-compete.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@backstage/cli': patch ---- - -Add support for dynamic plugins via the EXPERIMENTAL_MODULE_FEDERATION environment variable when running `yarn start`. diff --git a/.changeset/stupid-dots-relate.md b/.changeset/stupid-dots-relate.md deleted file mode 100644 index a83777bff9..0000000000 --- a/.changeset/stupid-dots-relate.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@backstage/plugin-scaffolder-backend-module-cookiecutter': patch ---- - -Add examples for `fetch:cookiecutter` scaffolder action & improve related tests diff --git a/.changeset/sweet-oranges-buy.md b/.changeset/sweet-oranges-buy.md deleted file mode 100644 index d9f3343e3d..0000000000 --- a/.changeset/sweet-oranges-buy.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@backstage/frontend-plugin-api': patch ---- - -Added support to be able to define `zod` config schema in Blueprints, with built in schema merging from the Blueprint and the extension instances. diff --git a/.changeset/swift-kings-sparkle.md b/.changeset/swift-kings-sparkle.md deleted file mode 100644 index 84ceae962b..0000000000 --- a/.changeset/swift-kings-sparkle.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@backstage/plugin-catalog-backend-module-aws': patch ---- - -`AwsOrganizationCloudAccountProcessor` configuration field `roleArn` is deprecated in favor of new field `accountId` diff --git a/.changeset/tall-snakes-fix.md b/.changeset/tall-snakes-fix.md deleted file mode 100644 index 351c781375..0000000000 --- a/.changeset/tall-snakes-fix.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@backstage/backend-plugin-api': patch ---- - -fix typo in `getPluginRequestToken` comments diff --git a/.changeset/tasty-ads-rescue.md b/.changeset/tasty-ads-rescue.md deleted file mode 100644 index d522856bdd..0000000000 --- a/.changeset/tasty-ads-rescue.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@backstage/backend-defaults': patch ---- - -Avoid excessive numbers of error listeners on cache clients diff --git a/.changeset/thick-hotels-know.md b/.changeset/thick-hotels-know.md deleted file mode 100644 index f0c7129256..0000000000 --- a/.changeset/thick-hotels-know.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@backstage/plugin-scaffolder-backend': patch ---- - -Fix scaffolder action `catalog:write` to write to directories that don't already exist diff --git a/.changeset/thirty-adults-grab.md b/.changeset/thirty-adults-grab.md deleted file mode 100644 index ed986a8289..0000000000 --- a/.changeset/thirty-adults-grab.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'@backstage/plugin-search-backend-node': patch -'@backstage/plugin-catalog-node': patch ---- - -Explicit declare if the service ref accepts `single` or `multiple` implementations. diff --git a/.changeset/thirty-paws-hope.md b/.changeset/thirty-paws-hope.md deleted file mode 100644 index 0de607f331..0000000000 --- a/.changeset/thirty-paws-hope.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@backstage/core-app-api': patch ---- - -The request to delete the session cookie when running the app in protected mode is now done with a plain `fetch` rather than `FetchApi`. This fixes a bug where the app would immediately try to sign-in again when removing the cookie during logout. diff --git a/.changeset/tiny-oranges-pretend.md b/.changeset/tiny-oranges-pretend.md deleted file mode 100644 index 87227fb962..0000000000 --- a/.changeset/tiny-oranges-pretend.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -'@backstage/frontend-plugin-api': patch ---- - -Extension data references can now be defined in a way that encapsulates the ID string in the type, in addition to the data type itself. The old way of creating extension data references is deprecated and will be removed in a future release. - -For example, the following code: - -```ts -export const myExtension = createExtensionDataRefHello World
,
- };
+ return [coreExtensionData.reactElement(Hello World
)];
},
});
```
-Note that while the `createExtension` is public API and used in many places, it is not typically what you use when building plugins and features. Instead there are many extension creator functions exported by both the core APIs and plugins that make it easier to create extensions for more specific usages.
+Note that while the `createExtension` function is public API and used in many places, it is not typically what you use when building plugins and features. Instead there are many [extension blueprints](./23-extension-blueprints.md) exported by both the core APIs and plugins that make it easier to create extensions for more specific usages.
-## Extension Data
+## Extension data
Communication between extensions happens in one direction, from one child extension through the attachment point to its parent. The child extension outputs data which is then passed as inputs to the parent extension. This data is called Extension Data, where the shape of each individual piece of data is described by an Extension Data Reference. These references are created separately from the extensions themselves, and can be shared across multiple different kinds of extensions. Each reference consists of an ID and a TypeScript type that the data needs to conform to, and represents one type of data that can be shared between extensions.
-### Extension Data References
+### Extension data references
To create a new extension data reference to represent a type of shared extension data you use the `createExtensionDataRef` function. When defining a new reference you need to provide an ID and a TypeScript type, for example:
@@ -101,59 +95,53 @@ The `ExtensionDataRef` can then be used to describe an output property of the ex
```tsx
const extension = createExtension({
// ...
- output: {
- element: reactElementExtensionDataRef,
- },
+ output: [reactElementExtensionDataRef],
factory() {
- return {
- element: Hello World
,
- };
+ return [reactElementExtensionDataRef(Hello World
)];
},
});
```
-### Extension Data Uniqueness
+### Extension data uniqueness
-Note that the key used in the output map, in this case `element`, is only used internally within the definition of the extension itself. That actual identifier for the data when consumed by other extensions is the ID of the reference, in this case [`core.reactElement`](https://github.com/backstage/backstage/blob/916da47e8abdb880877daa18881eb8fdbb33e70a/packages/frontend-plugin-api/src/wiring/coreExtensionData.ts#L23). This means that you can not output multiple different values for the same extension data reference, as they would conflict with each other. That in turn makes overly generic extension data references a bad idea, for example a generic "string" type. Instead create separate references for each type of data that you want to share.
+Note that you are **not** allowed to repeat the same data reference in the outputs, or return multiple values for the same reference. Multiple outputs for the same reference will conflict with each other and cause an error. If you want to output multiple values of the same TypeScript type you should create separate references for each value. That in turn means that overly generic extension data references are a bad idea, for example a generic "string" type. Instead create separate references for each type of data that you want to share.
```tsx
const extension = createExtension({
// ...
- output: {
- // ❌ Bad example - outputting values of same type
- element1: reactElementExtensionDataRef,
- element2: reactElementExtensionDataRef,
- },
+ output: [
+ // ❌ Bad example - duplicate output declaration
+ reactElementExtensionDataRef,
+ reactElementExtensionDataRef,
+ ],
factory() {
- return {
- element1: Hello World
,
- element2: Hello World
,
- };
+ return [
+ // ❌ Bad example - duplicate output values
+ reactElementExtensionDataRef(Hello
),
+ reactElementExtensionDataRef(World
),
+ ];
},
});
```
-### Core Extension Data
+### Core extension data
We provide default `coreExtensionData`, which provides commonly used `ExtensionDataRef`s - e.g. for `React.JSX.Element` and `RouteRef`. They can be used when creating your own extension. For example, the React Element extension data that we defined above is already provided as `coreExtensionData.reactElement`.
For a full list and explanations of all types of core extension data, see the [core extension data reference](../building-plugins/04-built-in-data-refs.md).
-### Optional Extension Data
+### Optional extension data
By default all extension data is required, meaning that the extension factory must provide a value for each output. However, it is possible to make extension data optional by calling the `.optional()` method. This makes it optional for the factory function to return a value as part of its output. When calling the `.optional()` method you create a new copy of the extension data reference, it does not mutate the existing reference.
```tsx
const extension = createExtension({
// ...
- output: {
- element: coreExtensionData.reactElement.optional(),
- },
+ output: [coreExtensionData.reactElement.optional()],
factory() {
- return {
- element:
- Math.random() < 0.5 ? 
: undefined,
- };
+ return Math.random() > 0.5
+ ? [coreExtensionData.reactElement(Hello World
)]
+ : [];
},
});
```
@@ -167,17 +155,19 @@ const navigationExtension = createExtension({
// ...
inputs: {
// [1]: Input
- logo: createExtensionInput(
- {
- element: coreExtensionData.reactElement,
- },
- { singleton: true, optional: true },
- ),
+ logo: createExtensionInput([coreExtensionData.reactElement], {
+ singleton: true,
+ optional: true,
+ }),
},
factory({ inputs }) {
return {
element: (
-
+
),
};
},
@@ -193,10 +183,9 @@ So how can we now attach the output to the parent extension's input? If we think
const navigationItemExtension = createExtension({
// ...
attachTo: { id: 'app/nav', input: 'items' },
+ output: [coreExtensionData.reactElement],
factory() {
- return {
- element: Home,
- };
+ return [coreExtensionData.reactElement(Home)];
},
});
@@ -205,26 +194,22 @@ const navigationExtension = createExtension({
// [2]: Extension `id` will be `app/nav` following the extension naming pattern
namespace: 'app',
name: 'nav',
- output: {
- element: coreExtensionData.reactElement,
- },
+ output: [coreExtensionData.reactElement],
inputs: {
- items: createExtensionInput({
- element: coreExtensionData.reactElement,
- }),
+ items: createExtensionInput([coreExtensionData.reactElement]),
},
factory({ inputs }) {
- return {
- element: (
+ return [
+ coreExtensionData.reactElement(
+ ,
),
- };
+ ];
},
// ...
});
@@ -232,27 +217,27 @@ const navigationExtension = createExtension({
In this case the extension input `items` is an array, where each individual item is an extension that attached itself to the extension inputs of this `id`.
-With the `inputs` not only the `output` of an extensions item is passed to the extension, but also the `node`. However, it is discouraged to consume the `node` here unless needed. If we are looking at the `factory` function from the example above we could access the `node` like the following:
+In addition to being able to access data passed through the input, you also have access to the underlying app `node`. This can be useful if you for example want to get the ID of the attached extension. However, avoid using the `node` unless needed, it is generally better to stick to only consuming the provided data. If we are looking at the `factory` function from the example above we could access the `node` like the following:
```tsx
// ...
factory({ inputs }) {
- return {
- element: (
+ return [
+ coreExtensionData.reactElement(
),
- };
+ ];
},
```
-## Extension Configuration
+## Extension configuration
With the `app-config.yaml` there is already the option to pass configuration to plugins or the app to e.g. define the `baseURL` of your app. For extensions this concept would be limiting as an extension can be independent of the plugin & initiated several times. Therefore we created a possibility to configure each extension individually through config. The extension config schema is created using the [`zod`](https://zod.dev/) library, which in addition to TypeScript type checking also provides runtime validation and coercion. If we continue with the example of the `navigationExtension` and now want it to contain a configurable title, we could make it available like the following:
@@ -262,20 +247,20 @@ const navigationExtension = createExtension({
namespace: 'app',
name: 'nav',
// [3]: Extension `id` will be `app/nav` following the extension naming pattern
- configSchema: createSchemaFromZod(z =>
- z.object({
- title: z.string().default('Sidebar Title'),
- }),
- ),
+ config: {
+ schema: {
+ title: z => z.string().default('Sidebar Title'),
+ },
+ },
factory({ config }) {
- return {
- element: (
+ return [
+ coreExtensionData.reactElement(
+ ,
),
- };
+ ];
},
// ...
});
@@ -293,47 +278,40 @@ app:
title: 'Backstage'
```
-## Extension Creators
+## Extension factory as a generator function
-With creating an extension by using `createExtension(...)` you have the advantage that the extension can be anything in your Backstage application. We realised that this comes with the trade-off of having to repeat boilerplate code for similar building blocks. Here extension creators come into play for covering common building blocks in Backstage like pages using `createPageExtension`, themes using the `createThemeExtension` or items for the navigation using `createNavItemExtension`.
+In all examples so far we have defined the extension factory as a regular function that returns its output in an array. However, the only requirement is that the factory function returns any iterable of extension data values. This means that you can also define the factory function as a generator function, which allows you to yield values one by one. This is particularly useful if you want to conditionally output values.
-If we follow the example from above all items of the navigation have similarities, like they all want to be attached to the same extension with the same input as well as rendering the same navigation item component. Therefore `createExtension` can be abstracted for this use case to `createNavItemExtension` and if we add the extension to the app it will end up in the right place & looks like we expect a navigation item to look.
+For example, this is how we could define an extension where its output depends on the configuration:
```tsx
-export const HomeNavIcon = createNavItemExtension({
- routeRef: routeRefForTheHomePage,
- title: 'Home',
- icon: HomeIcon,
+const exampleExtension = createExtension({
+ // ...
+ config: {
+ schema: {
+ disableIcon: z.boolean().default(false),
+ },
+ },
+ output: [coreExtensionData.reactElement, iconDataRef.optional()],
+ *factory({ config }) {
+ yield coreExtensionData.reactElement(Hello World
);
+
+ if (!config.disableIcon) {
+ yield iconDataRef(Hello Override
), + ]; + }, +}); +``` + +You can also access individual data values from the original factory, in order to decorate the output: + +```tsx +const myOverrideExtension = myExtension.override({ + factory(originalFactory) { + const originalOutput = originalFactory(); + const originalElement = originalOutput.get(coreExtensionData.reactElement); + + return [ + ...originalOutput, + coreExtensionData.reactElement( +
+
,
+ ),
+ ];
+ },
+});
+```
+
+Just as [extension factories can be declared as a generator function](./20-extensions.md#extension-factory-as-a-generator-function), so can the override factory. Using a generator function, the first example above can be written as follows:
+
+```tsx
+const myOverrideExtension = myExtension.override({
+ *factory(originalFactory) {
+ yield* originalFactory();
+ yield coreExtensionData.reactElement(Show original element
+ {originalElement} +Hello Override
); + }, +}); +``` + +Note the `yield*` expression, which forwards all values from the provided iterable to the generator, in this case the original factory output. + +## Overriding declared outputs + +When overriding an extension you can provide a new output declaration. This **replaces** any existing output declaration, which means that if you want to forward any of the original output you will need to declare it again. The following example shows how to override an extension and replace the output declaration: + +```tsx +// Original extension +const exampleExtension = createExtension({ + name: 'example', + output: [coreExtensionData.reactElement], + factory: () => [coreExtensionData.reactElement(Example
)], +}); + +// Override extension, with additional outputs +const overrideExtension = exampleExtension.override({ + output: [coreExtensionData.reactElement, coreExtensionData.routePath], + factory(originalFactory) { + return [...originalFactory(), coreExtensionData.routePath('/example')]; + }, +}); +``` + +When overriding the output declaration you don't need to include the original outputs. Just remember that you will no longer be able to directly forward the output from the original factory, and will still need to adhere to the contract of the input that the extension is attached to. + +## Overriding declared inputs + +When overriding an extension you can also provide new input declarations. You can define any number of new inputs, but you are **not** able to override the existing inputs declared by the original extension. The new inputs will be merged with the existing ones, giving the override factory access to both. The following example shows how to override an extension and add a new input declaration: + +```tsx +const myOverrideExtension = myExtension.override({ + inputs: { + myOverrideInput: createExtensionInput([coreExtensionData.reactElement]), + }, + factory(originalFactory, { inputs }) { + const originalOutput = originalFactory(); + const originalElement = originalOutput.get(coreExtensionData.reactElement); + + return [ + ...originalOutput, + coreExtensionData.reactElement( +
+
,
+ ),
+ ];
+ },
+});
+```
+
+## Overriding configuration schema
+
+Overriding the configuration schema works very similarly to overriding the declared inputs. You can define new configuration fields that will be merged with the existing ones, but you can not re-declare existing fields. The following example shows how to override an extension and add a new configuration field:
+
+```tsx
+const exampleExtension = createExtension({
+ config: {
+ schema: {
+ foo: z => z.string(),
+ },
+ },
+ // ...
+});
+
+const overrideExtension = exampleExtension.override({
+ config: {
+ schema: {
+ bar: z => z.string(),
+ },
+ },
+ factory(originalFactory, { config }) {
+ //
+ console.log(`foo=${config.foo} bar=${config.bar}`);
+ return originalFactory();
+ },
+});
+```
+
+## Overriding original factory config context
+
+In all examples so far we have called the `originalFactory` callback without any arguments. It is however possible to override parts of the factory context for the original factory using the first parameter of the original factory. This can be useful if you want to override the provided configuration or change the inputs in some way. Note that if you are implementing a `factory` for a blueprint, the override factory context will instead be the second parameter of the original factory function. The following is an example of how to override the configuration for the original factory:
+
+```tsx
+const exampleExtension = createExtension({
+ name: 'example',
+ config: {
+ schema: {
+ layout: z => z.enum(['grid', 'list']).optional(),
+ },
+ },
+ output: [coreExtensionData.reactElement],
+ factory: ({ config }) => [
+ coreExtensionData.reactElement(
+ Original element
+ {originalElement} +Additional inputs
+-
+ {inputs.myOverrideInput.map(i => (
+
- + {i.get(coreExtensionData.reactElement)} + + ))} +
Example
)]; }, }); ``` diff --git a/docs/frontend-system/building-plugins/05-migrating.md b/docs/frontend-system/building-plugins/05-migrating.md index 16f465ece7..f0abc97c81 100644 --- a/docs/frontend-system/building-plugins/05-migrating.md +++ b/docs/frontend-system/building-plugins/05-migrating.md @@ -8,16 +8,16 @@ description: How to migrate an existing frontend plugin to the new frontend syst This guide allows you to migrate a frontend plugin and its own components, routes, apis to the new frontend system. -The main concept is that routes, components, apis are now extensions. You can use the appropriate extension creators to migrate all of them to extensions. +The main concept is that routes, components, apis are now extensions. You can use the appropriate [extension blueprints](../architecture/23-extension-blueprints.md) to migrate all of them to extensions. ## Migrating the plugin In the legacy frontend system a plugin was defined in its own `plugin.ts` file as following: ```ts title="my-plugin/src/plugin.ts" - import { createPlugin } from '@backstage/core-plugin-api'; + import { createFrontendPlugin } from '@backstage/core-plugin-api'; - export const myPlugin = createPlugin({ + export const myPlugin = createFrontendPlugin({ id: 'my-plugin', apis: [], routes: { @@ -29,13 +29,13 @@ In the legacy frontend system a plugin was defined in its own `plugin.ts` file a }); ``` -In order to migrate the actual definition of the plugin you need to recreate the plugin using the new `createPlugin` utility exported by `@backstage/frontend-plugin-api`. -The new `createPlugin` function doesn't accept apis anymore as apis are now extensions. +In order to migrate the actual definition of the plugin you need to recreate the plugin using the new `createFrontendPlugin` utility exported by `@backstage/frontend-plugin-api`. +The new `createFrontendPlugin` function doesn't accept apis anymore as apis are now extensions. ```ts title="my-plugin/src/alpha.ts" - import { createPlugin } from '@backstage/frontend-plugin-api'; + import { createFrontendPlugin } from '@backstage/frontend-plugin-api'; - export default createPlugin({ + export default createFrontendPlugin({ id: 'my-plugin', // bind all the extensions to the plugin /* highlight-next-line */ @@ -77,7 +77,7 @@ The code above binds all the extensions to the plugin. _Important_: Make sure to ## Migrating Pages -Pages that were previously created using the `createRoutableExtension` extension function can be migrated to the new Frontend System using the `createPageExtension` extension creator, exported by `@backstage/frontend-plugin-api`. +Pages that were previously created using the `createRoutableExtension` extension function can be migrated to the new Frontend System using the `PageBlueprint` [extension blueprint](../architecture/23-extension-blueprints.md), exported by `@backstage/frontend-plugin-api`. For example, given the following page: @@ -94,33 +94,35 @@ export const FooPage = fooPlugin.provide( it can be migrated as the following: ```tsx -import { createPageExtension } from '@backstage/frontend-plugin-api'; +import { PageBlueprint } from '@backstage/frontend-plugin-api'; import { compatWrapper, convertLegacyRouteRef, } from '@backstage/core-compat-api'; -const fooPage = createPageExtension({ - defaultPath: '/foo', - // you can reuse the existing routeRef - // by wrapping into the convertLegacyRouteRef. - routeRef: convertLegacyRouteRef(rootRouteRef), - // these inputs usually match the props required by the component. - loader: ({ inputs }) => - import('./components/').then(m => - // The compatWrapper utility allows you to use the existing - // legacy frontend utilities used internally by the components. - compatWrapper({params.text}
)]; + }, + }); + + // create an instance of the extension blueprint with params + const testExtension = EntityCardBlueprint.make({ + name: 'foo', + params: { + text: 'Hello World', + }, + }); + ``` + +- 9b89b82: The `ExtensionBoundary` now by default infers whether it's routable from whether it outputs a route path. + +- e493020: Deprecated `inputs` and `configSchema` options for `createComponentExtenion`, these will be removed in a future release + +- 7777b5f: Added a new `IconBundleBlueprint` that lets you create icon bundle extensions that can be installed in an App in order to override or add new app icons. + + ```tsx + import { IconBundleBlueprint } from '@backstage/frontend-plugin-api'; + + const exampleIconBundle = IconBundleBlueprint.make({ + name: 'example-bundle', + params: { + icons: { + user: MyOwnUserIcon, + }, + }, + }); + ``` + +- 99abb6b: Support overriding of plugin extensions using the new `plugin.withOverrides` method. + + ```tsx + import homePlugin from '@backstage/plugin-home'; + + export default homePlugin.withOverrides({ + extensions: [ + homePage.getExtension('page:home').override({ + *factory(originalFactory) { + yield* originalFactory(); + yield coreExtensionData.reactElement(My custom home page
); + }, + }), + ], + }); + ``` + +- 813cac4: Add an `ExtensionBoundary.lazy` function to create properly wrapped lazy-loading enabled elements, suitable for use with `coreExtensionData.reactElement`. The page blueprint now automatically leverages this. + +- a65cfc8: Add support for accessing extensions definitions provided by a plugin via `plugin.getExtension(...)`. For this to work the extensions must be defined using the v2 format, typically using an extension blueprint. + +- 3be9aeb: Extensions have been changed to be declared with an array of inputs and outputs, rather than a map of named data refs. This change was made to reduce confusion around the role of the input and output names, as well as enable more powerful APIs for overriding extensions. + + An extension that was previously declared like this: + + ```tsx + const exampleExtension = createExtension({ + name: 'example', + inputs: { + items: createExtensionInput({ + element: coreExtensionData.reactElement, + }), + }, + output: { + element: coreExtensionData.reactElement, + }, + factory({ inputs }) { + return { + element: ( +
+ Example
+ {inputs.items.map(item => {
+ return
+ ),
+ };
+ },
+ });
+ ```
+
+ Should be migrated to the following:
+
+ ```tsx
+ const exampleExtension = createExtension({
+ name: 'example',
+ inputs: {
+ items: createExtensionInput([coreExtensionData.reactElement]),
+ },
+ output: [coreExtensionData.reactElement],
+ factory({ inputs }) {
+ return [
+ coreExtensionData.reactElement(
+ {item.output.element}
;
+ })}
+
+ Example
+ {inputs.items.map(item => {
+ return
,
+ ),
+ ];
+ },
+ });
+ ```
+
+- 34f1b2a: Support merging of `inputs` in extension blueprints, but stop merging `output`. In addition, the original factory in extension blueprints now returns a data container that both provides access to the returned data, but can also be forwarded as output.
+
+- 3fb421d: Added support to be able to define `zod` config schema in Blueprints, with built in schema merging from the Blueprint and the extension instances.
+
+- 2d21599: Added support for being able to override extension definitions.
+
+ ```tsx
+ const TestCard = EntityCardBlueprint.make({
+ ...
+ });
+
+ TestCard.override({
+ // override attachment points
+ attachTo: { id: 'something-else', input: 'overridden' },
+ // extend the config schema
+ config: {
+ schema: {
+ newConfig: z => z.string().optional(),
+ }
+ },
+ // override factory
+ *factory(originalFactory, { inputs, config }){
+ const originalOutput = originalFactory();
+
+ yield coreExentsionData.reactElement(
+ {item.get(coreExtensionData.reactElement)}
;
+ })}
+ ${notification.content}
`; + + const html = await getNotificationHtmlContent(notification); + + return html; + }, + }); + }, + }); + }, + }); + ``` + +### Patch Changes + +- d55b8e3: Avoid sending broadcast emails as a fallback in case the entity-typed notification user can not be resolved. +- cdb630d: Add support for stream transport for debugging purposes +- 83faf24: Notification email processor supports allowing or denying specific email addresses from receiving notifications +- Updated dependencies + - @backstage/backend-plugin-api@0.8.0 + - @backstage/backend-common@0.24.0 + - @backstage/plugin-notifications-node@0.2.4 + - @backstage/catalog-model@1.6.0 + - @backstage/catalog-client@1.6.6 + - @backstage/config@1.2.0 + - @backstage/integration-aws-node@0.1.12 + - @backstage/types@1.1.1 + - @backstage/plugin-notifications-common@0.0.5 + +## @backstage/plugin-scaffolder@1.24.0 + +### Minor Changes + +- 1552c33: Changed the way to display entities in `MyGroupsPicker` to use `entityPresentationApi` and make it consistent across scaffolder pickers +- 3fca643: Added field extension `RepoBranchPicker` that supports autocompletion for Bitbucket + +### Patch Changes + +- 47ed51b: Add an extra bit of height to the EntityPicker dropdown to make it clear there are more options to select from, and to remove the scroll bar when there is less than 10 options +- 46e5e55: Change scaffolder widgets to use `TextField` component for more flexibility in theme overrides. +- c7603e8: Deprecate the old pattern of `create*Extension`, and replace it with the equivalent Blueprint implementation instead +- 2ae63cd: add i18n for scaffolder +- d18f4eb: Fix undefined in the title of Scaffolder Runs on the page load +- 896a22d: Fix helper text margin for scaffolder EntityNamePicker and EntityTagsPicker when using outlined text field +- bbd9f56: Cleaned up codebase of RepoUrlPicker +- b8600fe: Fix issue with `RepoUrlPicker` not refreshing the credentials for a different host +- Updated dependencies + - @backstage/frontend-plugin-api@0.7.0 + - @backstage/plugin-scaffolder-react@1.11.0 + - @backstage/plugin-catalog-react@1.12.3 + - @backstage/core-components@0.14.10 + - @backstage/core-compat-api@0.2.8 + - @backstage/integration@1.14.0 + - @backstage/catalog-model@1.6.0 + - @backstage/catalog-client@1.6.6 + - @backstage/core-plugin-api@1.9.3 + - @backstage/errors@1.2.4 + - @backstage/integration-react@1.1.30 + - @backstage/types@1.1.1 + - @backstage/plugin-catalog-common@1.0.26 + - @backstage/plugin-permission-react@0.4.25 + - @backstage/plugin-scaffolder-common@1.5.5 + +## @backstage/plugin-scaffolder-backend@1.24.0 + +### Minor Changes + +- fc24d9e: Stop using `@backstage/backend-tasks` as it will be deleted in near future. +- dcd6a79: Added OpenTelemetry support to Scaffolder metrics + +### Patch Changes + +- 389f5a4: Update deprecated url-reader-related imports. +- c544f81: Add support for status filtering in scaffolder tasks endpoint +- b63d378: Update internal imports +- ef87e06: Fix scaffolder action `catalog:write` to write to directories that don't already exist +- Updated dependencies + - @backstage/backend-defaults@0.4.2 + - @backstage/plugin-scaffolder-backend-module-github@0.4.1 + - @backstage/backend-plugin-api@0.8.0 + - @backstage/backend-common@0.24.0 + - @backstage/plugin-scaffolder-node@0.4.9 + - @backstage/plugin-permission-common@0.8.1 + - @backstage/plugin-scaffolder-backend-module-bitbucket-server@0.1.13 + - @backstage/plugin-scaffolder-backend-module-bitbucket-cloud@0.1.13 + - @backstage/plugin-scaffolder-backend-module-bitbucket@0.2.13 + - @backstage/plugin-scaffolder-backend-module-gerrit@0.1.15 + - @backstage/plugin-scaffolder-backend-module-gitea@0.1.13 + - @backstage/plugin-auth-node@0.5.0 + - @backstage/plugin-scaffolder-backend-module-azure@0.1.15 + - @backstage/plugin-permission-node@0.8.1 + - @backstage/plugin-scaffolder-backend-module-gitlab@0.4.5 + - @backstage/plugin-catalog-node@1.12.5 + - @backstage/integration@1.14.0 + - @backstage/plugin-bitbucket-cloud-common@0.2.22 + - @backstage/catalog-model@1.6.0 + - @backstage/catalog-client@1.6.6 + - @backstage/config@1.2.0 + - @backstage/errors@1.2.4 + - @backstage/types@1.1.1 + - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.21 + - @backstage/plugin-scaffolder-common@1.5.5 + +## @backstage/plugin-scaffolder-react@1.11.0 + +### Minor Changes + +- 8839381: Add scaffolder option to display object items in separate rows on review page + +### Patch Changes + +- 072c00c: Fixed a bug in `DefaultTableOutputs` where output elements overlapped on smaller screen sizes +- 46e5e55: Change scaffolder widgets to use `TextField` component for more flexibility in theme overrides. +- d0e95a7: Add ability to customise form fields in the UI by exposing `uiSchema` and `formContext` in `FormProps` +- 4670f06: support `ajv-errors` for scaffolder validation to allow for customizing the error messages +- 04759f2: Fix null check in `isJsonObject` utility function for scaffolder review state component +- Updated dependencies + - @backstage/plugin-catalog-react@1.12.3 + - @backstage/core-components@0.14.10 + - @backstage/catalog-model@1.6.0 + - @backstage/catalog-client@1.6.6 + - @backstage/core-plugin-api@1.9.3 + - @backstage/theme@0.5.6 + - @backstage/types@1.1.1 + - @backstage/version-bridge@1.0.8 + - @backstage/plugin-permission-react@0.4.25 + - @backstage/plugin-scaffolder-common@1.5.5 + +## @backstage/plugin-search-backend-module-catalog@0.2.0 + +### Minor Changes + +- fc24d9e: Stop using `@backstage/backend-tasks` as it will be deleted in near future. + +### Patch Changes + +- Updated dependencies + - @backstage/backend-plugin-api@0.8.0 + - @backstage/backend-common@0.24.0 + - @backstage/plugin-search-backend-node@1.3.0 + - @backstage/plugin-permission-common@0.8.1 + - @backstage/plugin-search-common@1.2.14 + - @backstage/plugin-catalog-node@1.12.5 + - @backstage/catalog-model@1.6.0 + - @backstage/catalog-client@1.6.6 + - @backstage/config@1.2.0 + - @backstage/errors@1.2.4 + - @backstage/plugin-catalog-common@1.0.26 + +## @backstage/plugin-search-backend-module-explore@0.2.0 + +### Minor Changes + +- fc24d9e: Stop using `@backstage/backend-tasks` as it will be deleted in near future. + +### Patch Changes + +- 93095ee: Make sure node-fetch is version 2.7.0 or greater +- 93fc1a0: Updated dependency `@backstage-community/plugin-explore-common` to `^0.0.4`. +- Updated dependencies + - @backstage/backend-plugin-api@0.8.0 + - @backstage/backend-common@0.24.0 + - @backstage/plugin-search-backend-node@1.3.0 + - @backstage/plugin-search-common@1.2.14 + - @backstage/config@1.2.0 + +## @backstage/plugin-search-backend-module-stack-overflow-collator@0.2.0 + +### Minor Changes + +- fc24d9e: Stop using `@backstage/backend-tasks` as it will be deleted in near future. + +### Patch Changes + +- 93095ee: Make sure node-fetch is version 2.7.0 or greater +- Updated dependencies + - @backstage/backend-plugin-api@0.8.0 + - @backstage/backend-common@0.24.0 + - @backstage/plugin-search-backend-node@1.3.0 + - @backstage/plugin-search-common@1.2.14 + - @backstage/config@1.2.0 + +## @backstage/plugin-search-backend-module-techdocs@0.2.0 + +### Minor Changes + +- fc24d9e: Stop using `@backstage/backend-tasks` as it will be deleted in near future. + +### Patch Changes + +- 93095ee: Make sure node-fetch is version 2.7.0 or greater +- Updated dependencies + - @backstage/backend-plugin-api@0.8.0 + - @backstage/backend-common@0.24.0 + - @backstage/plugin-search-backend-node@1.3.0 + - @backstage/plugin-techdocs-node@1.12.9 + - @backstage/plugin-permission-common@0.8.1 + - @backstage/plugin-search-common@1.2.14 + - @backstage/plugin-catalog-node@1.12.5 + - @backstage/catalog-model@1.6.0 + - @backstage/catalog-client@1.6.6 + - @backstage/config@1.2.0 + - @backstage/plugin-catalog-common@1.0.26 + +## @backstage/plugin-search-backend-node@1.3.0 + +### Minor Changes + +- fc24d9e: Stop using `@backstage/backend-tasks` as it will be deleted in near future. + +### Patch Changes + +- 389f5a4: Update deprecated url-reader-related imports. +- 3123c16: Fix package metadata +- 7c5f3b0: Explicit declare if the service ref accepts `single` or `multiple` implementations. +- Updated dependencies + - @backstage/backend-defaults@0.4.2 + - @backstage/backend-plugin-api@0.8.0 + - @backstage/plugin-permission-common@0.8.1 + - @backstage/plugin-search-common@1.2.14 + - @backstage/config@1.2.0 + - @backstage/errors@1.2.4 + +## @backstage/plugin-techdocs-common@0.1.0 + +### Minor Changes + +- 4698e1f: Initial release of the techdocs-common package. + +## @backstage/app-defaults@1.5.10 + +### Patch Changes + +- Updated dependencies + - @backstage/core-components@0.14.10 + - @backstage/core-app-api@1.14.2 + - @backstage/core-plugin-api@1.9.3 + - @backstage/theme@0.5.6 + - @backstage/plugin-permission-react@0.4.25 + +## @backstage/backend-defaults@0.4.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 +- 3b429fb: Added deprecation warning to urge users to perform the auth service migration or implement their own token manager service. + SeeMy custom home page
); + }, + }), + ], + }); + ``` + +- a65cfc8: Add support for accessing extensions definitions provided by a plugin via `plugin.getExtension(...)`. For this to work the extensions must be defined using the v2 format, typically using an extension blueprint. + +- 34f1b2a: Support merging of `inputs` in extension blueprints, but stop merging `output`. In addition, the original factory in extension blueprints now returns a data container that both provides access to the returned data, but can also be forwarded as output. + +- 2d21599: Added support for being able to override extension definitions. + + ```tsx + const TestCard = EntityCardBlueprint.make({ + ... + }); + + TestCard.override({ + // override attachment points + attachTo: { id: 'something-else', input: 'overridden' }, + // extend the config schema + config: { + schema: { + newConfig: z => z.string().optional(), + } + }, + // override factory + *factory(originalFactory, { inputs, config }){ + const originalOutput = originalFactory(); + + yield coreExentsionData.reactElement( +
- op
- {page1Link && (
+ params: {
+ defaultPath: '/',
+ routeRef: indexRouteRef,
+ loader: async () => {
+ const Component = () => {
+ const page1Link = useRouteRef(page1RouteRef);
+ return (
+ ;
// (undocumented)
stop(): Promise;
}
-// @public @deprecated (undocumented)
-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
-//
-// @public @deprecated (undocumented)
-export const createConfigSecretEnumerator: typeof createConfigSecretEnumerator_2;
-
-// Warning: (ae-forgotten-export) The symbol "createHttpServer_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export const createHttpServer: typeof createHttpServer_2;
-
-// Warning: (ae-forgotten-export) The symbol "createLifecycleMiddleware_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated
-export const createLifecycleMiddleware: typeof createLifecycleMiddleware_2;
-
// @public (undocumented)
export function createSpecializedBackend(
options: CreateSpecializedBackendOptions,
@@ -111,82 +36,6 @@ export interface CreateSpecializedBackendOptions {
defaultServiceFactories: ServiceFactory[];
}
-// @public @deprecated (undocumented)
-export const databaseServiceFactory: ServiceFactoryCompat<
- DatabaseService,
- 'plugin',
- 'singleton',
- undefined
->;
-
-// @public @deprecated
-export class DefaultRootHttpRouter implements RootHttpRouterService {
- // (undocumented)
- static create(options?: DefaultRootHttpRouterOptions): DefaultRootHttpRouter;
- // (undocumented)
- handler(): Handler;
- // (undocumented)
- use(path: string, handler: Handler): void;
-}
-
-// Warning: (ae-forgotten-export) The symbol "DefaultRootHttpRouterOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated
-export type DefaultRootHttpRouterOptions = DefaultRootHttpRouterOptions_2;
-
-// @public @deprecated (undocumented)
-export const discoveryServiceFactory: ServiceFactoryCompat<
- DiscoveryService,
- 'plugin',
- 'singleton',
- undefined
->;
-
-// Warning: (ae-forgotten-export) The symbol "ExtendedHttpServer_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type ExtendedHttpServer = ExtendedHttpServer_2;
-
-// @public @deprecated
-export class HostDiscovery implements DiscoveryService {
- static fromConfig(
- config: Config,
- options?: {
- basePath?: string;
- },
- ): HostDiscovery;
- // (undocumented)
- getBaseUrl(pluginId: string): Promise;
- // (undocumented)
- getExternalBaseUrl(pluginId: string): Promise;
-}
-
-// @public @deprecated (undocumented)
-export const httpAuthServiceFactory: ServiceFactoryCompat<
- HttpAuthService,
- 'plugin',
- 'singleton',
- undefined
->;
-
-// @public @deprecated
-export const httpRouterServiceFactory: ServiceFactoryCompat<
- HttpRouterService,
- 'plugin',
- 'singleton',
- undefined
->;
-
-// Warning: (ae-forgotten-export) The symbol "HttpServerCertificateOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type HttpServerCertificateOptions = HttpServerCertificateOptions_2;
-
-// Warning: (ae-forgotten-export) The symbol "HttpServerOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type HttpServerOptions = HttpServerOptions_2;
-
// @public @deprecated
export type IdentityFactoryOptions = {
issuer?: string;
@@ -201,137 +50,6 @@ export const identityServiceFactory: ServiceFactoryCompat<
IdentityFactoryOptions
>;
-// Warning: (ae-forgotten-export) The symbol "LifecycleMiddlewareOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated
-export type LifecycleMiddlewareOptions = LifecycleMiddlewareOptions_2;
-
-// @public @deprecated
-export const lifecycleServiceFactory: ServiceFactoryCompat<
- LifecycleService,
- 'plugin',
- 'singleton',
- undefined
->;
-
-// @public @deprecated
-export function loadBackendConfig(options: {
- remote?: LoadConfigOptionsRemote;
- argv: string[];
- additionalConfigs?: AppConfig[];
- watch?: boolean;
-}): Promise<{
- config: Config;
-}>;
-
-// @public @deprecated
-export const loggerServiceFactory: ServiceFactoryCompat<
- LoggerService,
- 'plugin',
- 'singleton',
- undefined
->;
-
-// @public @deprecated (undocumented)
-export class MiddlewareFactory {
- compression(): RequestHandler;
- cors(): RequestHandler;
- static create(options: MiddlewareFactoryOptions): MiddlewareFactory;
- error(options?: MiddlewareFactoryErrorOptions): ErrorRequestHandler;
- helmet(): RequestHandler;
- logging(): RequestHandler;
- notFound(): RequestHandler;
-}
-
-// Warning: (ae-forgotten-export) The symbol "MiddlewareFactoryErrorOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type MiddlewareFactoryErrorOptions = MiddlewareFactoryErrorOptions_2;
-
-// Warning: (ae-forgotten-export) The symbol "MiddlewareFactoryOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type MiddlewareFactoryOptions = MiddlewareFactoryOptions_2;
-
-// @public @deprecated (undocumented)
-export const permissionsServiceFactory: ServiceFactoryCompat<
- PermissionsService,
- 'plugin',
- 'singleton',
- undefined
->;
-
-// Warning: (ae-forgotten-export) The symbol "readCorsOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export const readCorsOptions: typeof readCorsOptions_2;
-
-// Warning: (ae-forgotten-export) The symbol "readHelmetOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export const readHelmetOptions: typeof readHelmetOptions_2;
-
-// Warning: (ae-forgotten-export) The symbol "readHttpServerOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export const readHttpServerOptions: typeof readHttpServerOptions_2;
-
-// @public @deprecated (undocumented)
-export interface RootConfigFactoryOptions {
- argv?: string[];
- remote?: Pick;
- // (undocumented)
- watch?: boolean;
-}
-
-// @public @deprecated (undocumented)
-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
-//
-// @public @deprecated (undocumented)
-export type RootHttpRouterConfigureContext = RootHttpRouterConfigureContext_2;
-
-// Warning: (ae-forgotten-export) The symbol "RootHttpRouterFactoryOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated
-export type RootHttpRouterFactoryOptions = RootHttpRouterFactoryOptions_2;
-
-// @public @deprecated (undocumented)
-export const rootHttpRouterServiceFactory: ((
- options?: RootHttpRouterFactoryOptions_2 | undefined,
-) => ServiceFactory) &
- ServiceFactory;
-
-// @public @deprecated
-export const rootLifecycleServiceFactory: ServiceFactoryCompat<
- RootLifecycleService,
- 'root',
- 'singleton',
- undefined
->;
-
-// @public @deprecated
-export const rootLoggerServiceFactory: ServiceFactoryCompat<
- RootLoggerService,
- 'root',
- 'singleton',
- undefined
->;
-
-// @public @deprecated (undocumented)
-export const schedulerServiceFactory: ServiceFactoryCompat<
- SchedulerService,
- 'plugin',
- 'singleton',
- undefined
->;
-
// @public @deprecated (undocumented)
export const tokenManagerServiceFactory: ServiceFactoryCompat<
TokenManagerService,
@@ -339,47 +57,4 @@ export const tokenManagerServiceFactory: ServiceFactoryCompat<
'singleton',
undefined
>;
-
-// @public @deprecated (undocumented)
-export const urlReaderServiceFactory: ServiceFactoryCompat<
- UrlReaderService,
- 'plugin',
- 'singleton',
- undefined
->;
-
-// @public @deprecated (undocumented)
-export const userInfoServiceFactory: ServiceFactoryCompat<
- UserInfoService,
- 'plugin',
- 'singleton',
- undefined
->;
-
-// @public @deprecated
-export class WinstonLogger implements RootLoggerService {
- // (undocumented)
- addRedactions(redactions: Iterable): void;
- // (undocumented)
- child(meta: JsonObject): LoggerService;
- static colorFormat(): Format;
- static create(options: WinstonLoggerOptions): WinstonLogger;
- // (undocumented)
- debug(message: string, meta?: JsonObject): void;
- // (undocumented)
- error(message: string, meta?: JsonObject): void;
- // (undocumented)
- info(message: string, meta?: JsonObject): void;
- static redacter(): {
- format: Format;
- add: (redactions: Iterable) => void;
- };
- // (undocumented)
- warn(message: string, meta?: JsonObject): void;
-}
-
-// Warning: (ae-forgotten-export) The symbol "WinstonLoggerOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type WinstonLoggerOptions = WinstonLoggerOptions_2;
```
diff --git a/packages/backend-app-api/config.d.ts b/packages/backend-app-api/config.d.ts
index e94da62b77..76d22db8b2 100644
--- a/packages/backend-app-api/config.d.ts
+++ b/packages/backend-app-api/config.d.ts
@@ -71,7 +71,7 @@ export interface Config {
* the Backstage ecosystem to get authorized for access to APIs that do
* not permit unauthorized access.
*/
- externalAccess: Array<
+ externalAccess?: Array<
| {
/**
* This is the legacy service-to-service access method, where a set
diff --git a/packages/backend-app-api/package.json b/packages/backend-app-api/package.json
index e809d1c2f0..27cbb0b916 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.8.1-next.2",
+ "version": "0.9.0",
"description": "Core API used by Backstage backend apps",
"backstage": {
"role": "node-library"
@@ -52,7 +52,6 @@
"dependencies": {
"@backstage/backend-common": "workspace:^",
"@backstage/backend-plugin-api": "workspace:^",
- "@backstage/backend-tasks": "workspace:^",
"@backstage/cli-common": "workspace:^",
"@backstage/cli-node": "workspace:^",
"@backstage/config": "workspace:^",
@@ -62,8 +61,6 @@
"@backstage/plugin-permission-node": "workspace:^",
"@backstage/types": "workspace:^",
"@manypkg/get-packages": "^1.1.3",
- "@types/cors": "^2.8.6",
- "@types/express": "^4.17.6",
"compression": "^1.7.4",
"cookie": "^0.6.0",
"cors": "^2.8.5",
diff --git a/packages/backend-app-api/src/http/index.ts b/packages/backend-app-api/src/http/index.ts
deleted file mode 100644
index a056ed2d61..0000000000
--- a/packages/backend-app-api/src/http/index.ts
+++ /dev/null
@@ -1,187 +0,0 @@
-/*
- * Copyright 2023 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 { ErrorRequestHandler, RequestHandler } from 'express';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import {
- readHttpServerOptions as _readHttpServerOptions,
- createHttpServer as _createHttpServer,
- MiddlewareFactory as _MiddlewareFactory,
- readCorsOptions as _readCorsOptions,
- readHelmetOptions as _readHelmetOptions,
- type MiddlewareFactoryErrorOptions as _MiddlewareFactoryErrorOptions,
- type MiddlewareFactoryOptions as _MiddlewareFactoryOptions,
- type ExtendedHttpServer as _ExtendedHttpServer,
- type HttpServerCertificateOptions as _HttpServerCertificateOptions,
- type HttpServerOptions as _HttpServerOptions,
-} from '../../../backend-defaults/src/entrypoints/rootHttpRouter/http';
-
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
- */
-export const readHttpServerOptions = _readHttpServerOptions;
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
- */
-export const createHttpServer = _createHttpServer;
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
- */
-export const readCorsOptions = _readCorsOptions;
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
- */
-export const readHelmetOptions = _readHelmetOptions;
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
- */
-export class MiddlewareFactory {
- /**
- * Creates a new {@link MiddlewareFactory}.
- */
- static create(options: MiddlewareFactoryOptions) {
- return new MiddlewareFactory(_MiddlewareFactory.create(options));
- }
-
- private constructor(private readonly impl: _MiddlewareFactory) {}
-
- /**
- * Returns a middleware that unconditionally produces a 404 error response.
- *
- * @remarks
- *
- * Typically you want to place this middleware at the end of the chain, such
- * that it's the last one attempted after no other routes matched.
- *
- * @returns An Express request handler
- */
- notFound(): RequestHandler {
- return this.impl.notFound();
- }
-
- /**
- * Returns the compression middleware.
- *
- * @remarks
- *
- * The middleware will attempt to compress response bodies for all requests
- * that traverse through the middleware.
- */
- compression(): RequestHandler {
- return this.impl.compression();
- }
-
- /**
- * Returns a request logging middleware.
- *
- * @remarks
- *
- * Typically you want to place this middleware at the start of the chain, such
- * that it always logs requests whether they are "caught" by handlers farther
- * down or not.
- *
- * @returns An Express request handler
- */
- logging(): RequestHandler {
- return this.impl.logging();
- }
-
- /**
- * Returns a middleware that implements the helmet library.
- *
- * @remarks
- *
- * This middleware applies security policies to incoming requests and outgoing
- * responses. It is configured using config keys such as `backend.csp`.
- *
- * @see {@link https://helmetjs.github.io/}
- *
- * @returns An Express request handler
- */
- helmet(): RequestHandler {
- return this.impl.helmet();
- }
-
- /**
- * Returns a middleware that implements the cors library.
- *
- * @remarks
- *
- * This middleware handles CORS. It is configured using the config key
- * `backend.cors`.
- *
- * @see {@link https://github.com/expressjs/cors}
- *
- * @returns An Express request handler
- */
- cors(): RequestHandler {
- return this.impl.cors();
- }
-
- /**
- * Express middleware to handle errors during request processing.
- *
- * @remarks
- *
- * This is commonly the very last middleware in the chain.
- *
- * Its primary purpose is not to do translation of business logic exceptions,
- * but rather to be a global catch-all for uncaught "fatal" errors that are
- * expected to result in a 500 error. However, it also does handle some common
- * error types (such as http-error exceptions, and the well-known error types
- * in the `@backstage/errors` package) and returns the enclosed status code
- * accordingly.
- *
- * It will also produce a response body with a serialized form of the error,
- * unless a previous handler already did send a body. See
- * {@link @backstage/errors#ErrorResponseBody} for the response shape used.
- *
- * @returns An Express error request handler
- */
- error(options: MiddlewareFactoryErrorOptions = {}): ErrorRequestHandler {
- return this.impl.error(options);
- }
-}
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
- */
-export type MiddlewareFactoryErrorOptions = _MiddlewareFactoryErrorOptions;
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
- */
-export type MiddlewareFactoryOptions = _MiddlewareFactoryOptions;
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
- */
-export type ExtendedHttpServer = _ExtendedHttpServer;
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
- */
-export type HttpServerCertificateOptions = _HttpServerCertificateOptions;
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
- */
-export type HttpServerOptions = _HttpServerOptions;
diff --git a/packages/backend-app-api/src/index.ts b/packages/backend-app-api/src/index.ts
index 13864a3470..02633f3732 100644
--- a/packages/backend-app-api/src/index.ts
+++ b/packages/backend-app-api/src/index.ts
@@ -20,8 +20,5 @@
* @packageDocumentation
*/
-export * from './config';
-export * from './http';
-export * from './logging';
export * from './wiring';
export * from './services/implementations';
diff --git a/packages/backend-app-api/src/logging/WinstonLogger.ts b/packages/backend-app-api/src/logging/WinstonLogger.ts
deleted file mode 100644
index e5403906ce..0000000000
--- a/packages/backend-app-api/src/logging/WinstonLogger.ts
+++ /dev/null
@@ -1,92 +0,0 @@
-/*
- * Copyright 2023 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.
- */
-
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import {
- WinstonLogger as _WinstonLogger,
- type WinstonLoggerOptions as _WinstonLoggerOptions,
-} from '../../../backend-defaults/src/entrypoints/rootLogger';
-
-import {
- LoggerService,
- RootLoggerService,
-} from '@backstage/backend-plugin-api';
-import { JsonObject } from '@backstage/types';
-import { Format } from 'logform';
-
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootLogger` instead.
- */
-export type WinstonLoggerOptions = _WinstonLoggerOptions;
-
-/**
- * A {@link @backstage/backend-plugin-api#LoggerService} implementation based on winston.
- *
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootLogger` instead.
- */
-export class WinstonLogger implements RootLoggerService {
- /**
- * Creates a {@link WinstonLogger} instance.
- */
- static create(options: WinstonLoggerOptions): WinstonLogger {
- return new WinstonLogger(_WinstonLogger.create(options));
- }
-
- /**
- * Creates a winston log formatter for redacting secrets.
- */
- static redacter(): {
- format: Format;
- add: (redactions: Iterable) => void;
- } {
- return _WinstonLogger.redacter();
- }
-
- /**
- * Creates a pretty printed winston log formatter.
- */
- static colorFormat(): Format {
- return _WinstonLogger.colorFormat();
- }
-
- private constructor(private readonly impl: _WinstonLogger) {}
-
- error(message: string, meta?: JsonObject): void {
- this.impl.error(message, meta);
- }
-
- warn(message: string, meta?: JsonObject): void {
- this.impl.warn(message, meta);
- }
-
- info(message: string, meta?: JsonObject): void {
- this.impl.info(message, meta);
- }
-
- debug(message: string, meta?: JsonObject): void {
- this.impl.debug(message, meta);
- }
-
- child(meta: JsonObject): LoggerService {
- return this.impl.child(meta);
- }
-
- addRedactions(redactions: Iterable) {
- this.impl.addRedactions(redactions);
- }
-}
diff --git a/packages/backend-app-api/src/logging/index.ts b/packages/backend-app-api/src/logging/index.ts
deleted file mode 100644
index 14fe33f898..0000000000
--- a/packages/backend-app-api/src/logging/index.ts
+++ /dev/null
@@ -1,18 +0,0 @@
-/*
- * Copyright 2023 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.
- */
-
-export { WinstonLogger } from './WinstonLogger';
-export type { WinstonLoggerOptions } from './WinstonLogger';
diff --git a/packages/backend-app-api/src/services/implementations/cache/cacheServiceFactory.ts b/packages/backend-app-api/src/services/implementations/cache/cacheServiceFactory.ts
deleted file mode 100644
index 9b5e5ab16a..0000000000
--- a/packages/backend-app-api/src/services/implementations/cache/cacheServiceFactory.ts
+++ /dev/null
@@ -1,40 +0,0 @@
-/*
- * 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 { CacheManager } from '@backstage/backend-common';
-import {
- coreServices,
- createServiceFactory,
-} from '@backstage/backend-plugin-api';
-
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/cache` instead.
- */
-export const cacheServiceFactory = createServiceFactory({
- service: coreServices.cache,
- deps: {
- config: coreServices.rootConfig,
- logger: coreServices.rootLogger,
- plugin: coreServices.pluginMetadata,
- },
- async createRootContext({ config, logger }) {
- return CacheManager.fromConfig(config, { logger });
- },
- async factory({ plugin }, manager) {
- return manager.forPlugin(plugin.getId()).getClient();
- },
-});
diff --git a/packages/backend-app-api/src/services/implementations/cache/index.ts b/packages/backend-app-api/src/services/implementations/cache/index.ts
deleted file mode 100644
index f96ee77182..0000000000
--- a/packages/backend-app-api/src/services/implementations/cache/index.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-/*
- * Copyright 2023 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.
- */
-
-export { cacheServiceFactory } from './cacheServiceFactory';
diff --git a/packages/backend-app-api/src/services/implementations/config/rootConfigServiceFactory.ts b/packages/backend-app-api/src/services/implementations/config/rootConfigServiceFactory.ts
deleted file mode 100644
index c74474e629..0000000000
--- a/packages/backend-app-api/src/services/implementations/config/rootConfigServiceFactory.ts
+++ /dev/null
@@ -1,61 +0,0 @@
-/*
- * 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 {
- coreServices,
- createServiceFactory,
-} from '@backstage/backend-plugin-api';
-import {
- ConfigSources,
- RemoteConfigSourceOptions,
-} from '@backstage/config-loader';
-
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootConfig` instead.
- */
-export interface RootConfigFactoryOptions {
- /**
- * Process arguments to use instead of the default `process.argv()`.
- */
- argv?: string[];
-
- /**
- * Enables and sets options for remote configuration loading.
- */
- remote?: Pick;
- watch?: boolean;
-}
-
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootConfig` instead.
- */
-export const rootConfigServiceFactory = createServiceFactory(
- (options?: RootConfigFactoryOptions) => ({
- service: coreServices.rootConfig,
- deps: {},
- async factory() {
- const source = ConfigSources.default({
- argv: options?.argv,
- remote: options?.remote,
- watch: options?.watch,
- });
- console.log(`Loading config from ${source}`);
- return await ConfigSources.toConfig(source);
- },
- }),
-);
diff --git a/packages/backend-app-api/src/services/implementations/database/databaseServiceFactory.ts b/packages/backend-app-api/src/services/implementations/database/databaseServiceFactory.ts
deleted file mode 100644
index 972d8dd4ec..0000000000
--- a/packages/backend-app-api/src/services/implementations/database/databaseServiceFactory.ts
+++ /dev/null
@@ -1,52 +0,0 @@
-/*
- * 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 { DatabaseManager } from '@backstage/backend-common';
-import {
- coreServices,
- createServiceFactory,
-} from '@backstage/backend-plugin-api';
-import { ConfigReader } from '@backstage/config';
-
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/database` instead.
- */
-export const databaseServiceFactory = createServiceFactory({
- service: coreServices.database,
- deps: {
- config: coreServices.rootConfig,
- lifecycle: coreServices.lifecycle,
- pluginMetadata: coreServices.pluginMetadata,
- },
- async createRootContext({ config }) {
- return config.getOptional('backend.database')
- ? DatabaseManager.fromConfig(config)
- : DatabaseManager.fromConfig(
- new ConfigReader({
- backend: {
- database: { client: 'better-sqlite3', connection: ':memory:' },
- },
- }),
- );
- },
- async factory({ pluginMetadata, lifecycle }, databaseManager) {
- return databaseManager.forPlugin(pluginMetadata.getId(), {
- pluginMetadata,
- lifecycle,
- });
- },
-});
diff --git a/packages/backend-app-api/src/services/implementations/discovery/HostDiscovery.test.ts b/packages/backend-app-api/src/services/implementations/discovery/HostDiscovery.test.ts
deleted file mode 100644
index 4e6aff5853..0000000000
--- a/packages/backend-app-api/src/services/implementations/discovery/HostDiscovery.test.ts
+++ /dev/null
@@ -1,257 +0,0 @@
-/*
- * 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 { ConfigReader } from '@backstage/config';
-import { HostDiscovery } from './HostDiscovery';
-
-describe('HostDiscovery', () => {
- it('is created from config', async () => {
- const discovery = HostDiscovery.fromConfig(
- new ConfigReader({
- backend: {
- baseUrl: 'http://localhost:40',
- listen: { port: 80, host: 'localhost' },
- },
- }),
- );
-
- await expect(discovery.getBaseUrl('catalog')).resolves.toBe(
- 'http://localhost:80/api/catalog',
- );
- await expect(discovery.getExternalBaseUrl('catalog')).resolves.toBe(
- 'http://localhost:40/api/catalog',
- );
- });
-
- it('strips trailing slashes in config', async () => {
- const discovery = HostDiscovery.fromConfig(
- new ConfigReader({
- backend: {
- baseUrl: 'http://localhost:40//',
- listen: { port: 80, host: 'localhost' },
- },
- }),
- );
-
- await expect(discovery.getBaseUrl('catalog')).resolves.toBe(
- 'http://localhost:80/api/catalog',
- );
- await expect(discovery.getExternalBaseUrl('catalog')).resolves.toBe(
- 'http://localhost:40/api/catalog',
- );
- });
-
- it('can configure the base path', async () => {
- const discovery = HostDiscovery.fromConfig(
- new ConfigReader({
- backend: {
- baseUrl: 'http://localhost:40',
- listen: { port: 80, host: 'localhost' },
- },
- }),
- { basePath: '/service' },
- );
-
- await expect(discovery.getBaseUrl('catalog')).resolves.toBe(
- 'http://localhost:80/service/catalog',
- );
- await expect(discovery.getExternalBaseUrl('catalog')).resolves.toBe(
- 'http://localhost:40/service/catalog',
- );
- });
-
- it.each([
- [{ listen: ':80' }, 'http://localhost:80'],
- [{ listen: ':40', https: true }, 'https://localhost:40'],
- [{ listen: '127.0.0.1:80' }, 'http://127.0.0.1:80'],
- [{ listen: '127.0.0.1:80', https: true }, 'https://127.0.0.1:80'],
- [{ listen: '0.0.0.0:40' }, 'http://127.0.0.1:40'],
- [{ listen: { port: 80 } }, 'http://localhost:80'],
- [{ listen: { port: 8000 } }, 'http://localhost:8000'],
- [{ listen: { port: 80, host: '0.0.0.0' } }, 'http://127.0.0.1:80'],
- [{ listen: { port: 80, host: '::' } }, 'http://localhost:80'],
- [{ listen: { port: 80, host: '::1' } }, 'http://[::1]:80'],
- [{ listen: { port: 90, host: '::2' }, https: true }, 'https://[::2]:90'],
- ])('resolves internal baseUrl for %j as %s', async (config, expected) => {
- const discovery = HostDiscovery.fromConfig(
- new ConfigReader({
- backend: {
- baseUrl: 'http://localhost:40',
- ...config,
- },
- }),
- );
-
- await expect(discovery.getBaseUrl('catalog')).resolves.toBe(
- `${expected}/api/catalog`,
- );
- });
-
- it('uses plugin specific targets from config if provided', async () => {
- const discovery = HostDiscovery.fromConfig(
- new ConfigReader({
- backend: {
- baseUrl: 'http://localhost:40',
- listen: { port: 80, host: 'localhost' },
- },
- discovery: {
- endpoints: [
- {
- target: {
- internal: 'http://catalog-backend-internal:8080/api/catalog',
- external: 'http://catalog-backend-external:8080/api/catalog',
- },
- plugins: ['catalog'],
- },
- ],
- },
- }),
- );
-
- await expect(discovery.getBaseUrl('catalog')).resolves.toBe(
- 'http://catalog-backend-internal:8080/api/catalog',
- );
- await expect(discovery.getExternalBaseUrl('catalog')).resolves.toBe(
- 'http://catalog-backend-external:8080/api/catalog',
- );
- });
-
- it('uses a single target for internal and external for a plugin', async () => {
- const discovery = HostDiscovery.fromConfig(
- new ConfigReader({
- backend: {
- baseUrl: 'http://localhost:40',
- listen: { port: 80, host: 'localhost' },
- },
- discovery: {
- endpoints: [
- {
- target: 'http://catalog-backend:8080/api/catalog',
- plugins: ['catalog'],
- },
- ],
- },
- }),
- );
-
- await expect(discovery.getBaseUrl('catalog')).resolves.toBe(
- 'http://catalog-backend:8080/api/catalog',
- );
- await expect(discovery.getExternalBaseUrl('catalog')).resolves.toBe(
- 'http://catalog-backend:8080/api/catalog',
- );
- });
-
- it('defaults to the backend baseUrl when there is not an endpoint for a plugin', async () => {
- const discovery = HostDiscovery.fromConfig(
- new ConfigReader({
- backend: {
- baseUrl: 'http://localhost:40',
- listen: { port: 80, host: 'localhost' },
- },
- discovery: {
- endpoints: [
- {
- target: 'http://catalog-backend:8080/api/catalog',
- plugins: ['catalog'],
- },
- ],
- },
- }),
- );
-
- await expect(discovery.getBaseUrl('scaffolder')).resolves.toBe(
- 'http://localhost:80/api/scaffolder',
- );
- await expect(discovery.getExternalBaseUrl('scaffolder')).resolves.toBe(
- 'http://localhost:40/api/scaffolder',
- );
- });
-
- it('replaces {{pluginId}} or {{ pluginId }} in the target', async () => {
- const discovery = HostDiscovery.fromConfig(
- new ConfigReader({
- backend: {
- baseUrl: 'http://localhost:40',
- listen: { port: 80, host: 'localhost' },
- },
- discovery: {
- endpoints: [
- {
- target: 'http://common-backend:8080/api/{{pluginId}}',
- plugins: ['catalog', 'docs'],
- },
- {
- target: {
- internal: 'http://scaffolder-internal:8080/api/{{ pluginId }}',
- external: 'http://scaffolder-external:8080/api/{{ pluginId }}',
- },
- plugins: ['scaffolder'],
- },
- ],
- },
- }),
- );
-
- await expect(discovery.getBaseUrl('catalog')).resolves.toBe(
- 'http://common-backend:8080/api/catalog',
- );
- await expect(discovery.getExternalBaseUrl('catalog')).resolves.toBe(
- 'http://common-backend:8080/api/catalog',
- );
- await expect(discovery.getBaseUrl('docs')).resolves.toBe(
- 'http://common-backend:8080/api/docs',
- );
- await expect(discovery.getExternalBaseUrl('docs')).resolves.toBe(
- 'http://common-backend:8080/api/docs',
- );
- await expect(discovery.getBaseUrl('scaffolder')).resolves.toBe(
- 'http://scaffolder-internal:8080/api/scaffolder',
- );
- await expect(discovery.getExternalBaseUrl('scaffolder')).resolves.toBe(
- 'http://scaffolder-external:8080/api/scaffolder',
- );
- });
-
- it('encodes the pluginId', async () => {
- const discovery = HostDiscovery.fromConfig(
- new ConfigReader({
- backend: {
- baseUrl: 'http://localhost:40',
- listen: { port: 80, host: 'localhost' },
- },
- discovery: {
- endpoints: [
- {
- target: 'http://common-backend:8080/api/{{pluginId}}',
- plugins: ['plugin/beta'],
- },
- ],
- },
- }),
- );
-
- await expect(discovery.getBaseUrl('plugin/beta')).resolves.toBe(
- 'http://common-backend:8080/api/plugin%2Fbeta',
- );
- await expect(discovery.getBaseUrl('plugin/alpha')).resolves.toBe(
- 'http://localhost:80/api/plugin%2Falpha',
- );
- await expect(discovery.getExternalBaseUrl('plugin/alpha')).resolves.toBe(
- 'http://localhost:40/api/plugin%2Falpha',
- );
- });
-});
diff --git a/packages/backend-app-api/src/services/implementations/discovery/HostDiscovery.ts b/packages/backend-app-api/src/services/implementations/discovery/HostDiscovery.ts
deleted file mode 100644
index 5909dd1ae6..0000000000
--- a/packages/backend-app-api/src/services/implementations/discovery/HostDiscovery.ts
+++ /dev/null
@@ -1,71 +0,0 @@
-/*
- * 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 { Config } from '@backstage/config';
-import { DiscoveryService } from '@backstage/backend-plugin-api';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { HostDiscovery as _HostDiscovery } from '../../../../../backend-defaults/src/entrypoints/discovery';
-
-/**
- * HostDiscovery is a basic PluginEndpointDiscovery implementation
- * that can handle plugins that are hosted in a single or multiple deployments.
- *
- * The deployment may be scaled horizontally, as long as the external URL
- * is the same for all instances. However, internal URLs will always be
- * resolved to the same host, so there won't be any balancing of internal traffic.
- *
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/discovery` instead.
- */
-export class HostDiscovery implements DiscoveryService {
- /**
- * Creates a new HostDiscovery discovery instance by reading
- * from the `backend` config section, specifically the `.baseUrl` for
- * discovering the external URL, and the `.listen` and `.https` config
- * for the internal one.
- *
- * Can be overridden in config by providing a target and corresponding plugins in `discovery.endpoints`.
- * eg.
- * ```yaml
- * discovery:
- * endpoints:
- * - target: https://internal.example.com/internal-catalog
- * plugins: [catalog]
- * - target: https://internal.example.com/secure/api/{{pluginId}}
- * plugins: [auth, permission]
- * - target:
- * internal: https://internal.example.com/search
- * external: https://example.com/search
- * plugins: [search]
- * ```
- *
- * The basePath defaults to `/api`, meaning the default full internal
- * path for the `catalog` plugin will be `http://localhost:7007/api/catalog`.
- */
- static fromConfig(config: Config, options?: { basePath?: string }) {
- return new HostDiscovery(_HostDiscovery.fromConfig(config, options));
- }
-
- private constructor(private readonly impl: _HostDiscovery) {}
-
- async getBaseUrl(pluginId: string): Promise {
- return this.impl.getBaseUrl(pluginId);
- }
-
- async getExternalBaseUrl(pluginId: string): Promise {
- return this.impl.getExternalBaseUrl(pluginId);
- }
-}
diff --git a/packages/backend-app-api/src/services/implementations/discovery/discoveryServiceFactory.ts b/packages/backend-app-api/src/services/implementations/discovery/discoveryServiceFactory.ts
deleted file mode 100644
index b29a589438..0000000000
--- a/packages/backend-app-api/src/services/implementations/discovery/discoveryServiceFactory.ts
+++ /dev/null
@@ -1,35 +0,0 @@
-/*
- * 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 {
- coreServices,
- createServiceFactory,
-} from '@backstage/backend-plugin-api';
-import { HostDiscovery } from './HostDiscovery';
-
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/discovery` instead.
- */
-export const discoveryServiceFactory = createServiceFactory({
- service: coreServices.discovery,
- deps: {
- config: coreServices.rootConfig,
- },
- async factory({ config }) {
- return HostDiscovery.fromConfig(config);
- },
-});
diff --git a/packages/backend-app-api/src/services/implementations/discovery/index.ts b/packages/backend-app-api/src/services/implementations/discovery/index.ts
deleted file mode 100644
index ee4851271a..0000000000
--- a/packages/backend-app-api/src/services/implementations/discovery/index.ts
+++ /dev/null
@@ -1,18 +0,0 @@
-/*
- * Copyright 2023 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.
- */
-
-export { discoveryServiceFactory } from './discoveryServiceFactory';
-export { HostDiscovery } from './HostDiscovery';
diff --git a/packages/backend-app-api/src/services/implementations/httpRouter/createLifecycleMiddleware.ts b/packages/backend-app-api/src/services/implementations/httpRouter/createLifecycleMiddleware.ts
deleted file mode 100644
index d4864a23a6..0000000000
--- a/packages/backend-app-api/src/services/implementations/httpRouter/createLifecycleMiddleware.ts
+++ /dev/null
@@ -1,45 +0,0 @@
-/*
- * 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.
- */
-
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import {
- createLifecycleMiddleware as _createLifecycleMiddleware,
- type LifecycleMiddlewareOptions as _LifecycleMiddlewareOptions,
-} from '../../../../../backend-defaults/src/entrypoints/httpRouter/createLifecycleMiddleware';
-
-/**
- * Options for {@link createLifecycleMiddleware}.
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/httpRouter` instead.
- */
-export type LifecycleMiddlewareOptions = _LifecycleMiddlewareOptions;
-
-/**
- * Creates a middleware that pauses requests until the service has started.
- *
- * @remarks
- *
- * Requests that arrive before the service has started will be paused until startup is complete.
- * If the service does not start within the provided timeout, the request will be rejected with a
- * {@link @backstage/errors#ServiceUnavailableError}.
- *
- * If the service is shutting down, all requests will be rejected with a
- * {@link @backstage/errors#ServiceUnavailableError}.
- *
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/httpRouter` instead.
- */
-export const createLifecycleMiddleware = _createLifecycleMiddleware;
diff --git a/packages/backend-app-api/src/services/implementations/httpRouter/httpRouterServiceFactory.ts b/packages/backend-app-api/src/services/implementations/httpRouter/httpRouterServiceFactory.ts
deleted file mode 100644
index 0088e53f98..0000000000
--- a/packages/backend-app-api/src/services/implementations/httpRouter/httpRouterServiceFactory.ts
+++ /dev/null
@@ -1,30 +0,0 @@
-/*
- * 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.
- */
-
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { httpRouterServiceFactory as _httpRouterServiceFactory } from '../../../../../backend-defaults/src/entrypoints/httpRouter/httpRouterServiceFactory';
-
-/**
- * HTTP route registration for plugins.
- *
- * See {@link @backstage/code-plugin-api#HttpRouterService}
- * and {@link https://backstage.io/docs/backend-system/core-services/http-router | the service docs}
- * for more information.
- *
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/httpRouter` instead.
- */
-export const httpRouterServiceFactory = _httpRouterServiceFactory;
diff --git a/packages/backend-app-api/src/services/implementations/httpRouter/index.ts b/packages/backend-app-api/src/services/implementations/httpRouter/index.ts
deleted file mode 100644
index bc12480ae8..0000000000
--- a/packages/backend-app-api/src/services/implementations/httpRouter/index.ts
+++ /dev/null
@@ -1,19 +0,0 @@
-/*
- * Copyright 2023 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.
- */
-
-export { httpRouterServiceFactory } from './httpRouterServiceFactory';
-export { createLifecycleMiddleware } from './createLifecycleMiddleware';
-export type { LifecycleMiddlewareOptions } from './createLifecycleMiddleware';
diff --git a/packages/backend-app-api/src/services/implementations/index.ts b/packages/backend-app-api/src/services/implementations/index.ts
index 3a2fe819ed..5f9bb9479a 100644
--- a/packages/backend-app-api/src/services/implementations/index.ts
+++ b/packages/backend-app-api/src/services/implementations/index.ts
@@ -14,15 +14,5 @@
* limitations under the License.
*/
-export * from './cache';
-export * from './config';
-export * from './database';
-export * from './discovery';
export * from './identity';
-export * from './lifecycle';
-export * from './permissions';
-export * from './rootLifecycle';
export * from './tokenManager';
-export * from './urlReader';
-
-export * from './deprecated';
diff --git a/packages/backend-app-api/src/services/implementations/lifecycle/index.ts b/packages/backend-app-api/src/services/implementations/lifecycle/index.ts
deleted file mode 100644
index 8dac4c26b4..0000000000
--- a/packages/backend-app-api/src/services/implementations/lifecycle/index.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-/*
- * Copyright 2023 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.
- */
-
-export { lifecycleServiceFactory } from './lifecycleServiceFactory';
diff --git a/packages/backend-app-api/src/services/implementations/lifecycle/lifecycleServiceFactory.ts b/packages/backend-app-api/src/services/implementations/lifecycle/lifecycleServiceFactory.ts
deleted file mode 100644
index b3b0135a7c..0000000000
--- a/packages/backend-app-api/src/services/implementations/lifecycle/lifecycleServiceFactory.ts
+++ /dev/null
@@ -1,109 +0,0 @@
-/*
- * 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 {
- LifecycleService,
- LifecycleServiceShutdownHook,
- LifecycleServiceShutdownOptions,
- LifecycleServiceStartupHook,
- LifecycleServiceStartupOptions,
- LoggerService,
- PluginMetadataService,
- RootLifecycleService,
- coreServices,
- createServiceFactory,
-} from '@backstage/backend-plugin-api';
-
-/**
- * @internal
- * @deprecated
- */
-export class BackendPluginLifecycleImpl implements LifecycleService {
- constructor(
- private readonly logger: LoggerService,
- private readonly rootLifecycle: RootLifecycleService,
- private readonly pluginMetadata: PluginMetadataService,
- ) {}
-
- #hasStarted = false;
- #startupTasks: Array<{
- hook: LifecycleServiceStartupHook;
- options?: LifecycleServiceStartupOptions;
- }> = [];
-
- addStartupHook(
- hook: LifecycleServiceStartupHook,
- options?: LifecycleServiceStartupOptions,
- ): void {
- if (this.#hasStarted) {
- throw new Error('Attempted to add startup hook after startup');
- }
- this.#startupTasks.push({ hook, options });
- }
-
- async startup(): Promise {
- if (this.#hasStarted) {
- return;
- }
- this.#hasStarted = true;
-
- this.logger.debug(
- `Running ${this.#startupTasks.length} plugin startup tasks...`,
- );
- await Promise.all(
- this.#startupTasks.map(async ({ hook, options }) => {
- const logger = options?.logger ?? this.logger;
- try {
- await hook();
- logger.debug(`Plugin startup hook succeeded`);
- } catch (error) {
- logger.error(`Plugin startup hook failed, ${error}`);
- }
- }),
- );
- }
-
- addShutdownHook(
- hook: LifecycleServiceShutdownHook,
- options?: LifecycleServiceShutdownOptions,
- ): void {
- const plugin = this.pluginMetadata.getId();
- this.rootLifecycle.addShutdownHook(hook, {
- logger: options?.logger?.child({ plugin }) ?? this.logger,
- });
- }
-}
-
-/**
- * Allows plugins to register shutdown hooks that are run when the process is about to exit.
- *
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/lifecycle` instead.
- */
-export const lifecycleServiceFactory = createServiceFactory({
- service: coreServices.lifecycle,
- deps: {
- logger: coreServices.logger,
- rootLifecycle: coreServices.rootLifecycle,
- pluginMetadata: coreServices.pluginMetadata,
- },
- async factory({ rootLifecycle, logger, pluginMetadata }) {
- return new BackendPluginLifecycleImpl(
- logger,
- rootLifecycle,
- pluginMetadata,
- );
- },
-});
diff --git a/packages/backend-app-api/src/services/implementations/logger/index.ts b/packages/backend-app-api/src/services/implementations/logger/index.ts
deleted file mode 100644
index ca52bf5193..0000000000
--- a/packages/backend-app-api/src/services/implementations/logger/index.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-/*
- * Copyright 2023 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.
- */
-
-export { loggerServiceFactory } from './loggerServiceFactory';
diff --git a/packages/backend-app-api/src/services/implementations/logger/loggerServiceFactory.ts b/packages/backend-app-api/src/services/implementations/logger/loggerServiceFactory.ts
deleted file mode 100644
index 7e7b4b98b0..0000000000
--- a/packages/backend-app-api/src/services/implementations/logger/loggerServiceFactory.ts
+++ /dev/null
@@ -1,30 +0,0 @@
-/*
- * 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.
- */
-
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { loggerServiceFactory as _loggerServiceFactory } from '../../../../../backend-defaults/src/entrypoints/logger/loggerServiceFactory';
-
-/**
- * Plugin-level logging.
- *
- * See {@link @backstage/code-plugin-api#LoggerService}
- * and {@link https://backstage.io/docs/backend-system/core-services/logger | the service docs}
- * for more information.
- *
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/logger` instead.
- */
-export const loggerServiceFactory = _loggerServiceFactory;
diff --git a/packages/backend-app-api/src/services/implementations/permissions/index.ts b/packages/backend-app-api/src/services/implementations/permissions/index.ts
deleted file mode 100644
index 781dda31a0..0000000000
--- a/packages/backend-app-api/src/services/implementations/permissions/index.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-/*
- * Copyright 2023 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.
- */
-
-export { permissionsServiceFactory } from './permissionsServiceFactory';
diff --git a/packages/backend-app-api/src/services/implementations/permissions/permissionsServiceFactory.ts b/packages/backend-app-api/src/services/implementations/permissions/permissionsServiceFactory.ts
deleted file mode 100644
index c8fa0e7bbf..0000000000
--- a/packages/backend-app-api/src/services/implementations/permissions/permissionsServiceFactory.ts
+++ /dev/null
@@ -1,42 +0,0 @@
-/*
- * 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 {
- coreServices,
- createServiceFactory,
-} from '@backstage/backend-plugin-api';
-import { ServerPermissionClient } from '@backstage/plugin-permission-node';
-
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/permissions` instead.
- */
-export const permissionsServiceFactory = createServiceFactory({
- service: coreServices.permissions,
- deps: {
- auth: coreServices.auth,
- config: coreServices.rootConfig,
- discovery: coreServices.discovery,
- tokenManager: coreServices.tokenManager,
- },
- async factory({ auth, config, discovery, tokenManager }) {
- return ServerPermissionClient.fromConfig(config, {
- auth,
- discovery,
- tokenManager,
- });
- },
-});
diff --git a/packages/backend-app-api/src/services/implementations/rootHttpRouter/DefaultRootHttpRouter.test.ts b/packages/backend-app-api/src/services/implementations/rootHttpRouter/DefaultRootHttpRouter.test.ts
deleted file mode 100644
index fc1de9b205..0000000000
--- a/packages/backend-app-api/src/services/implementations/rootHttpRouter/DefaultRootHttpRouter.test.ts
+++ /dev/null
@@ -1,124 +0,0 @@
-/*
- * 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 express from 'express';
-import request from 'supertest';
-import { DefaultRootHttpRouter } from './DefaultRootHttpRouter';
-
-describe('DefaultRootHttpRouter', () => {
- it.each([
- [['/b'], '/a'],
- [['/a'], '/aa/b'],
- [['/aa'], '/a/b'],
- [['/a/b'], '/aa'],
- [['/b/a'], '/a'],
- [['/a'], '/aa'],
- ])(`with existing paths %s, adds %s without conflict`, (existing, added) => {
- const router = DefaultRootHttpRouter.create();
- for (const path of existing) {
- router.use(path, () => {});
- }
- expect(() => router.use(added, () => {})).not.toThrow();
- });
-
- it.each([
- [['/a'], '/a', '/a'],
- [['/a'], '/a/b', '/a'],
- [['/a/b'], '/a', '/a/b'],
- ])(
- `find conflict when existing paths %s, adds %s`,
- (existing, added, conflict) => {
- const router = DefaultRootHttpRouter.create();
- for (const path of existing) {
- router.use(path, () => {});
- }
- expect(() => router.use(added, () => {})).toThrow(
- `Path ${added} conflicts with the existing path ${conflict}`,
- );
- },
- );
-
- it('should not be possible to supply an empty indexPath', () => {
- expect(() => DefaultRootHttpRouter.create({ indexPath: '' })).toThrow(
- 'indexPath option may not be an empty string',
- );
- });
-
- it('will always prioritize non-index paths', async () => {
- const router = DefaultRootHttpRouter.create({ indexPath: '/x' });
- const app = express();
- app.use(router.handler());
-
- const routerX = express.Router();
- routerX.get('/a', (_req, res) => res.status(201).end());
-
- const routerY = express.Router();
- routerY.get('/a', (_req, res) => res.status(202).end());
-
- await request(app).get('/').expect(404);
- await request(app).get('/a').expect(404);
- await request(app).get('/x/a').expect(404);
- await request(app).get('/y/a').expect(404);
-
- router.use('/x', routerX);
-
- await request(app).get('/').expect(404);
- await request(app).get('/a').expect(201);
- await request(app).get('/x/a').expect(201);
- await request(app).get('/y/a').expect(404);
-
- router.use('/y', routerY);
-
- await request(app).get('/').expect(404);
- await request(app).get('/a').expect(201);
- await request(app).get('/x/a').expect(201);
- await request(app).get('/y/a').expect(202);
-
- expect('test').toBe('test');
- });
-
- it('should treat unknown /api/ routes as 404', async () => {
- const router = DefaultRootHttpRouter.create();
- const app = express();
- app.use(router.handler());
-
- router.use('/api/app', (_req, res) => res.status(201).end());
- router.use('/api/catalog', (_req, res) => res.status(202).end());
-
- await request(app).get('/').expect(201);
- await request(app).get('/api/catalog').expect(202);
- await request(app).get('/unknown').expect(201);
- await request(app).get('/api/unknown').expect(404);
-
- expect('test').toBe('test');
- });
-
- it('should treat unknown /api/ routes as 404 without an index path', async () => {
- const router = DefaultRootHttpRouter.create({ indexPath: false });
- const app = express();
- app.use(router.handler());
-
- router.use('/api/app', (_req, res) => res.status(201).end());
- router.use('/api/catalog', (_req, res) => res.status(202).end());
-
- await request(app).get('/').expect(404);
- await request(app).get('/api/catalog').expect(202);
- await request(app).get('/unknown').expect(404);
- await request(app).get('/api/unknown').expect(404);
-
- expect('test').toBe('test');
- });
-});
diff --git a/packages/backend-app-api/src/services/implementations/rootHttpRouter/DefaultRootHttpRouter.ts b/packages/backend-app-api/src/services/implementations/rootHttpRouter/DefaultRootHttpRouter.ts
deleted file mode 100644
index 617d5055db..0000000000
--- a/packages/backend-app-api/src/services/implementations/rootHttpRouter/DefaultRootHttpRouter.ts
+++ /dev/null
@@ -1,54 +0,0 @@
-/*
- * Copyright 2023 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 { RootHttpRouterService } from '@backstage/backend-plugin-api';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import {
- DefaultRootHttpRouter as _DefaultRootHttpRouter,
- DefaultRootHttpRouterOptions as _DefaultRootHttpRouterOptions,
-} from '../../../../../backend-defaults/src/entrypoints/rootHttpRouter/DefaultRootHttpRouter';
-import { Handler } from 'express';
-
-/**
- * Options for the {@link DefaultRootHttpRouter} class.
- *
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
- */
-export type DefaultRootHttpRouterOptions = _DefaultRootHttpRouterOptions;
-
-/**
- * The default implementation of the {@link @backstage/backend-plugin-api#RootHttpRouterService} interface for
- * {@link @backstage/backend-plugin-api#coreServices.rootHttpRouter}.
- *
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
- */
-export class DefaultRootHttpRouter implements RootHttpRouterService {
- static create(options?: DefaultRootHttpRouterOptions) {
- return new DefaultRootHttpRouter(_DefaultRootHttpRouter.create(options));
- }
-
- private constructor(private readonly impl: RootHttpRouterService) {}
-
- use(path: string, handler: Handler) {
- this.impl.use(path, handler);
- }
-
- handler(): Handler {
- return (this.impl as any).handler();
- }
-}
diff --git a/packages/backend-app-api/src/services/implementations/rootHttpRouter/index.ts b/packages/backend-app-api/src/services/implementations/rootHttpRouter/index.ts
deleted file mode 100644
index 8437399fec..0000000000
--- a/packages/backend-app-api/src/services/implementations/rootHttpRouter/index.ts
+++ /dev/null
@@ -1,25 +0,0 @@
-/*
- * Copyright 2023 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.
- */
-
-export {
- rootHttpRouterServiceFactory,
- type RootHttpRouterFactoryOptions,
- type RootHttpRouterConfigureContext,
-} from './rootHttpRouterServiceFactory';
-export {
- DefaultRootHttpRouter,
- type DefaultRootHttpRouterOptions,
-} from './DefaultRootHttpRouter';
diff --git a/packages/backend-app-api/src/services/implementations/rootHttpRouter/rootHttpRouterServiceFactory.ts b/packages/backend-app-api/src/services/implementations/rootHttpRouter/rootHttpRouterServiceFactory.ts
deleted file mode 100644
index bef1913645..0000000000
--- a/packages/backend-app-api/src/services/implementations/rootHttpRouter/rootHttpRouterServiceFactory.ts
+++ /dev/null
@@ -1,46 +0,0 @@
-/*
- * 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.
- */
-
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import {
- rootHttpRouterServiceFactory as _rootHttpRouterServiceFactory,
- RootHttpRouterFactoryOptions as _RootHttpRouterFactoryOptions,
- RootHttpRouterConfigureContext as _RootHttpRouterConfigureContext,
-} from '../../../../../backend-defaults/src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory';
-
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
- */
-export type RootHttpRouterConfigureContext = _RootHttpRouterConfigureContext;
-
-/**
- * HTTP route registration for root services.
- *
- * See {@link @backstage/code-plugin-api#RootHttpRouterService}
- * and {@link https://backstage.io/docs/backend-system/core-services/root-http-router | the service docs}
- * for more information.
- *
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
- */
-export type RootHttpRouterFactoryOptions = _RootHttpRouterFactoryOptions;
-
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
- */
-export const rootHttpRouterServiceFactory = _rootHttpRouterServiceFactory;
diff --git a/packages/backend-app-api/src/services/implementations/rootLifecycle/index.ts b/packages/backend-app-api/src/services/implementations/rootLifecycle/index.ts
deleted file mode 100644
index 86589cd23e..0000000000
--- a/packages/backend-app-api/src/services/implementations/rootLifecycle/index.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-/*
- * Copyright 2023 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.
- */
-
-export { rootLifecycleServiceFactory } from './rootLifecycleServiceFactory';
diff --git a/packages/backend-app-api/src/services/implementations/rootLifecycle/rootLifecycleServiceFactory.test.ts b/packages/backend-app-api/src/services/implementations/rootLifecycle/rootLifecycleServiceFactory.test.ts
deleted file mode 100644
index 5992e38d50..0000000000
--- a/packages/backend-app-api/src/services/implementations/rootLifecycle/rootLifecycleServiceFactory.test.ts
+++ /dev/null
@@ -1,60 +0,0 @@
-/*
- * 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 { BackendLifecycleImpl } from './rootLifecycleServiceFactory';
-import { mockServices } from '@backstage/backend-test-utils';
-
-describe('lifecycleService', () => {
- it('should execute registered shutdown hook', async () => {
- const service = new BackendLifecycleImpl(mockServices.logger.mock());
- const hook = jest.fn();
- service.addShutdownHook(() => hook());
- // should not execute the hook more than once.
- await service.shutdown();
- await service.shutdown();
- await service.shutdown();
- expect(hook).toHaveBeenCalledTimes(1);
- });
-
- it('should not throw errors', async () => {
- const service = new BackendLifecycleImpl(mockServices.logger.mock());
- service.addShutdownHook(() => {
- throw new Error('oh no');
- });
- await expect(service.shutdown()).resolves.toBeUndefined();
- });
-
- it('should not throw async errors', async () => {
- const service = new BackendLifecycleImpl(mockServices.logger.mock());
- service.addShutdownHook(async () => {
- throw new Error('oh no');
- });
- await expect(service.shutdown()).resolves.toBeUndefined();
- });
-
- it('should reject hooks after trigger', async () => {
- const service = new BackendLifecycleImpl(mockServices.logger.mock());
- await service.startup();
- expect(() => {
- service.addStartupHook(() => {});
- }).toThrow('Attempted to add startup hook after startup');
-
- await service.shutdown();
- expect(() => {
- service.addShutdownHook(() => {});
- }).toThrow('Attempted to add shutdown hook after shutdown');
- });
-});
diff --git a/packages/backend-app-api/src/services/implementations/rootLifecycle/rootLifecycleServiceFactory.ts b/packages/backend-app-api/src/services/implementations/rootLifecycle/rootLifecycleServiceFactory.ts
deleted file mode 100644
index bf5dc09b80..0000000000
--- a/packages/backend-app-api/src/services/implementations/rootLifecycle/rootLifecycleServiceFactory.ts
+++ /dev/null
@@ -1,124 +0,0 @@
-/*
- * 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 {
- createServiceFactory,
- coreServices,
- LifecycleServiceStartupHook,
- LifecycleServiceStartupOptions,
- LifecycleServiceShutdownHook,
- LifecycleServiceShutdownOptions,
- RootLifecycleService,
- LoggerService,
-} from '@backstage/backend-plugin-api';
-
-/**
- * @internal
- * @deprecated
- */
-export class BackendLifecycleImpl implements RootLifecycleService {
- constructor(private readonly logger: LoggerService) {}
-
- #hasStarted = false;
- #startupTasks: Array<{
- hook: LifecycleServiceStartupHook;
- options?: LifecycleServiceStartupOptions;
- }> = [];
-
- addStartupHook(
- hook: LifecycleServiceStartupHook,
- options?: LifecycleServiceStartupOptions,
- ): void {
- if (this.#hasStarted) {
- throw new Error('Attempted to add startup hook after startup');
- }
- this.#startupTasks.push({ hook, options });
- }
-
- async startup(): Promise {
- if (this.#hasStarted) {
- return;
- }
- this.#hasStarted = true;
-
- this.logger.debug(`Running ${this.#startupTasks.length} startup tasks...`);
- await Promise.all(
- this.#startupTasks.map(async ({ hook, options }) => {
- const logger = options?.logger ?? this.logger;
- try {
- await hook();
- logger.debug(`Startup hook succeeded`);
- } catch (error) {
- logger.error(`Startup hook failed, ${error}`);
- }
- }),
- );
- }
-
- #hasShutdown = false;
- #shutdownTasks: Array<{
- hook: LifecycleServiceShutdownHook;
- options?: LifecycleServiceShutdownOptions;
- }> = [];
-
- addShutdownHook(
- hook: LifecycleServiceShutdownHook,
- options?: LifecycleServiceShutdownOptions,
- ): void {
- if (this.#hasShutdown) {
- throw new Error('Attempted to add shutdown hook after shutdown');
- }
- this.#shutdownTasks.push({ hook, options });
- }
-
- async shutdown(): Promise {
- if (this.#hasShutdown) {
- return;
- }
- this.#hasShutdown = true;
-
- this.logger.debug(
- `Running ${this.#shutdownTasks.length} shutdown tasks...`,
- );
- await Promise.all(
- this.#shutdownTasks.map(async ({ hook, options }) => {
- const logger = options?.logger ?? this.logger;
- try {
- await hook();
- logger.debug(`Shutdown hook succeeded`);
- } catch (error) {
- logger.error(`Shutdown hook failed, ${error}`);
- }
- }),
- );
- }
-}
-
-/**
- * Allows plugins to register shutdown hooks that are run when the process is about to exit.
- *
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootLifecycle` instead.
- */
-export const rootLifecycleServiceFactory = createServiceFactory({
- service: coreServices.rootLifecycle,
- deps: {
- logger: coreServices.rootLogger,
- },
- async factory({ logger }) {
- return new BackendLifecycleImpl(logger);
- },
-});
diff --git a/packages/backend-app-api/src/services/implementations/rootLogger/index.ts b/packages/backend-app-api/src/services/implementations/rootLogger/index.ts
deleted file mode 100644
index 366cd53163..0000000000
--- a/packages/backend-app-api/src/services/implementations/rootLogger/index.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-/*
- * Copyright 2023 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.
- */
-
-export { rootLoggerServiceFactory } from './rootLoggerServiceFactory';
diff --git a/packages/backend-app-api/src/services/implementations/rootLogger/rootLoggerServiceFactory.ts b/packages/backend-app-api/src/services/implementations/rootLogger/rootLoggerServiceFactory.ts
deleted file mode 100644
index af1931c438..0000000000
--- a/packages/backend-app-api/src/services/implementations/rootLogger/rootLoggerServiceFactory.ts
+++ /dev/null
@@ -1,30 +0,0 @@
-/*
- * 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.
- */
-
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { rootLoggerServiceFactory as _rootLoggerServiceFactory } from '../../../../../backend-defaults/src/entrypoints/rootLogger/rootLoggerServiceFactory';
-
-/**
- * Root-level logging.
- *
- * See {@link @backstage/code-plugin-api#RootLoggerService}
- * and {@link https://backstage.io/docs/backend-system/core-services/root-logger | the service docs}
- * for more information.
- *
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/rootLogger` instead.
- */
-export const rootLoggerServiceFactory = _rootLoggerServiceFactory;
diff --git a/packages/backend-app-api/src/services/implementations/scheduler/index.ts b/packages/backend-app-api/src/services/implementations/scheduler/index.ts
deleted file mode 100644
index 8b67006a4d..0000000000
--- a/packages/backend-app-api/src/services/implementations/scheduler/index.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-/*
- * Copyright 2023 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.
- */
-
-export { schedulerServiceFactory } from './schedulerServiceFactory';
diff --git a/packages/backend-app-api/src/services/implementations/scheduler/schedulerServiceFactory.test.ts b/packages/backend-app-api/src/services/implementations/scheduler/schedulerServiceFactory.test.ts
deleted file mode 100644
index b16509cf96..0000000000
--- a/packages/backend-app-api/src/services/implementations/scheduler/schedulerServiceFactory.test.ts
+++ /dev/null
@@ -1,46 +0,0 @@
-/*
- * Copyright 2023 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 { coreServices } from '@backstage/backend-plugin-api';
-import { ServiceFactoryTester } from '@backstage/backend-test-utils';
-import { schedulerServiceFactory } from './schedulerServiceFactory';
-
-describe('schedulerFactory', () => {
- it('creates sidecar database features', async () => {
- const tester = ServiceFactoryTester.from(schedulerServiceFactory());
-
- const scheduler = await tester.getSubject();
- await scheduler.scheduleTask({
- id: 'task1',
- timeout: { seconds: 1 },
- frequency: { seconds: 1 },
- fn: async () => {},
- });
-
- const database = await tester.getService(coreServices.database);
-
- const client = await database.getClient();
- await expect(
- client.from('backstage_backend_tasks__tasks').count(),
- ).resolves.toEqual([{ 'count(*)': 1 }]);
- await expect(
- client.from('backstage_backend_tasks__knex_migrations').count(),
- ).resolves.toEqual([{ 'count(*)': expect.any(Number) }]);
- await expect(
- client.from('backstage_backend_tasks__knex_migrations_lock').count(),
- ).resolves.toEqual([{ 'count(*)': expect.any(Number) }]);
- });
-});
diff --git a/packages/backend-app-api/src/services/implementations/scheduler/schedulerServiceFactory.ts b/packages/backend-app-api/src/services/implementations/scheduler/schedulerServiceFactory.ts
deleted file mode 100644
index b4370761d9..0000000000
--- a/packages/backend-app-api/src/services/implementations/scheduler/schedulerServiceFactory.ts
+++ /dev/null
@@ -1,41 +0,0 @@
-/*
- * 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 {
- coreServices,
- createServiceFactory,
-} from '@backstage/backend-plugin-api';
-import { TaskScheduler } from '@backstage/backend-tasks';
-
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/scheduler` instead.
- */
-export const schedulerServiceFactory = createServiceFactory({
- service: coreServices.scheduler,
- deps: {
- plugin: coreServices.pluginMetadata,
- databaseManager: coreServices.database,
- logger: coreServices.logger,
- },
- async factory({ plugin, databaseManager, logger }) {
- return TaskScheduler.forPlugin({
- pluginId: plugin.getId(),
- databaseManager,
- logger,
- });
- },
-});
diff --git a/packages/backend-app-api/src/services/implementations/urlReader/index.ts b/packages/backend-app-api/src/services/implementations/urlReader/index.ts
deleted file mode 100644
index 6a4b9f65be..0000000000
--- a/packages/backend-app-api/src/services/implementations/urlReader/index.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-/*
- * Copyright 2023 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.
- */
-
-export { urlReaderServiceFactory } from './urlReaderServiceFactory';
diff --git a/packages/backend-app-api/src/services/implementations/urlReader/urlReaderServiceFactory.ts b/packages/backend-app-api/src/services/implementations/urlReader/urlReaderServiceFactory.ts
deleted file mode 100644
index 44caf25ad6..0000000000
--- a/packages/backend-app-api/src/services/implementations/urlReader/urlReaderServiceFactory.ts
+++ /dev/null
@@ -1,39 +0,0 @@
-/*
- * 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 { UrlReaders } from '@backstage/backend-common';
-import {
- coreServices,
- createServiceFactory,
-} from '@backstage/backend-plugin-api';
-
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/urlReader` instead.
- */
-export const urlReaderServiceFactory = createServiceFactory({
- service: coreServices.urlReader,
- deps: {
- config: coreServices.rootConfig,
- logger: coreServices.logger,
- },
- async factory({ config, logger }) {
- return UrlReaders.default({
- config,
- logger,
- });
- },
-});
diff --git a/packages/backend-app-api/src/wiring/BackendInitializer.test.ts b/packages/backend-app-api/src/wiring/BackendInitializer.test.ts
index 6f60d65861..cf8845fcec 100644
--- a/packages/backend-app-api/src/wiring/BackendInitializer.test.ts
+++ b/packages/backend-app-api/src/wiring/BackendInitializer.test.ts
@@ -342,6 +342,62 @@ describe('BackendInitializer', () => {
await init.start();
});
+ it('should allow plugins and modules depend on multiton services', async () => {
+ expect.assertions(2);
+
+ const multiServiceRef = createServiceRef({
+ id: 'a',
+ multiton: true,
+ });
+ const init = new BackendInitializer(baseFactories);
+
+ init.add(
+ createServiceFactory({
+ service: multiServiceRef,
+ deps: {},
+ factory: () => 'x',
+ }),
+ );
+ init.add(
+ createServiceFactory({
+ service: multiServiceRef,
+ deps: {},
+ factory: () => 'y',
+ }),
+ );
+
+ init.add(
+ createBackendPlugin({
+ pluginId: 'test',
+ register(reg) {
+ reg.registerInit({
+ deps: { multi: multiServiceRef },
+ async init({ multi }) {
+ expect(multi).toEqual(['x', 'y']);
+ },
+ });
+ },
+ }),
+ );
+
+ init.add(
+ createBackendModule({
+ pluginId: 'test',
+ moduleId: 'test',
+ register(reg) {
+ reg.registerInit({
+ deps: { multi: multiServiceRef },
+ async init({ multi }) {
+ expect(multi).toEqual(['x', 'y']);
+ },
+ });
+ },
+ }),
+ );
+
+ await init.start();
+ });
+
it('should forward errors when plugins fail to start', async () => {
const init = new BackendInitializer([]);
init.add(
diff --git a/packages/backend-app-api/src/wiring/BackstageBackend.ts b/packages/backend-app-api/src/wiring/BackstageBackend.ts
index 0dd3ba4423..9df7549bcb 100644
--- a/packages/backend-app-api/src/wiring/BackstageBackend.ts
+++ b/packages/backend-app-api/src/wiring/BackstageBackend.ts
@@ -25,12 +25,7 @@ export class BackstageBackend implements Backend {
this.#initializer = new BackendInitializer(defaultServiceFactories);
}
- add(
- feature:
- | BackendFeature
- | (() => BackendFeature)
- | Promise<{ default: BackendFeature | (() => BackendFeature) }>,
- ): void {
+ add(feature: BackendFeature | Promise<{ default: BackendFeature }>): void {
if (isPromise(feature)) {
this.#initializer.add(feature.then(f => unwrapFeature(f.default)));
} else {
@@ -57,15 +52,8 @@ function isPromise(value: unknown | Promise): value is Promise {
}
function unwrapFeature(
- feature:
- | BackendFeature
- | (() => BackendFeature)
- | { default: BackendFeature | (() => BackendFeature) },
+ feature: BackendFeature | { default: BackendFeature },
): BackendFeature {
- if (typeof feature === 'function') {
- return feature();
- }
-
if ('$$type' in feature) {
return feature;
}
@@ -75,10 +63,7 @@ function unwrapFeature(
// when importing using a dynamic import.
// TODO: This is a broader issue than just this piece of code, and should move away from CommonJS.
if ('default' in feature) {
- const defaultFeature = feature.default;
- return typeof defaultFeature === 'function'
- ? defaultFeature()
- : defaultFeature;
+ return feature.default;
}
return feature;
diff --git a/packages/backend-app-api/src/wiring/types.ts b/packages/backend-app-api/src/wiring/types.ts
index 075eb58b3f..bd761ff3c8 100644
--- a/packages/backend-app-api/src/wiring/types.ts
+++ b/packages/backend-app-api/src/wiring/types.ts
@@ -26,18 +26,6 @@ import {
*/
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)
- | Promise<{ default: () => BackendFeature }>,
- ): void;
start(): Promise;
stop(): Promise;
}
diff --git a/packages/backend-common/CHANGELOG.md b/packages/backend-common/CHANGELOG.md
index 5eadae4c0f..40ba8fb687 100644
--- a/packages/backend-common/CHANGELOG.md
+++ b/packages/backend-common/CHANGELOG.md
@@ -1,5 +1,89 @@
# @backstage/backend-common
+## 0.24.0
+
+### Minor Changes
+
+- 389f5a4: **BREAKING**: Removed the following `Url Reader` deprecated exports:
+
+ - UrlReader: Use `UrlReaderService` from `@backstage/backend-plugin-api` instead;
+ - AzureUrlReader: Import from `@backstage/backend-defaults/urlReader` instead;
+ - BitbucketUrlReader: Import from `@backstage/backend-defaults/urlReader` instead;
+ - BitbucketCloudUrlReader: Import from `@backstage/backend-defaults/urlReader` instead;
+ - BitbucketServerUrlReader: Import from `@backstage/backend-defaults/urlReader` instead;
+ - GithubUrlReader: Import from `@backstage/backend-defaults/urlReader` instead;
+ - GitlabUrlReader: Import from `@backstage/backend-defaults/urlReader` instead;
+ - GerritUrlReader: Import from `@backstage/backend-defaults/urlReader` instead;
+ - GiteaUrlReader: Import from `@backstage/backend-defaults/urlReader` instead;
+ - HarnessUrlReader: Import from `@backstage/backend-defaults/urlReader` instead;
+ - AwsS3UrlReader: Import from `@backstage/backend-defaults/urlReader` instead;
+ - FetchUrlReader: Import from `@backstage/backend-defaults/urlReader` instead;
+ - UrlReaders: Import from `@backstage/backend-defaults/urlReader` instead;
+ - UrlReadersOptions: Import from `@backstage/backend-defaults/urlReader` instead;
+ - UrlReaderPredicateTuple: Import from `@backstage/backend-defaults/urlReader` instead;
+ - FromReadableArrayOptions: Import from `@backstage/backend-defaults/urlReader` instead;
+ - ReaderFactory: Import from `@backstage/backend-defaults/urlReader` instead;
+ - ReadUrlOptions:Use `UrlReaderServiceReadUrlOptions` from `@backstage/backend-plugin-api` instead;
+ - ReadUrlResponse: Use `UrlReaderServiceReadUrlResponse` from `@backstage/backend-plugin-api` instead;
+ - ReadUrlResponseFactory: Import from `@backstage/backend-defaults/urlReader` instead;
+ - ReadUrlResponseFactoryFromStreamOptions: Import from `@backstage/backend-defaults/urlReader` instead;
+ - ReadTreeOptions: Use `UrlReaderServiceReadTreeOptions` from `@backstage/backend-plugin-api` instead;
+ - ReadTreeResponse: Use `UrlReaderServiceReadTreeResponse` from `@backstage/backend-plugin-api` instead;
+ - ReadTreeResponseFile: Use `UrlReaderServiceReadTreeResponseFile` from `@backstage/backend-plugin-api` instead;
+ - ReadTreeResponseDirOptions: Use `UrlReaderServiceReadTreeResponseDirOptions` from `@backstage/backend-plugin-api` instead;
+ - ReadTreeResponseFactory: Import from `@backstage/backend-defaults/urlReader` instead;
+ - ReadTreeResponseFactoryOptions: Import from `@backstage/backend-defaults/urlReader` instead;
+ - SearchOptions: Use `UrlReaderServiceSearchOptions` from `@backstage/backend-plugin-api` instead;
+ - SearchResponse: Use `UrlReaderServiceSearchResponse` from `@backstage/backend-plugin-api` instead;
+ - SearchResponseFile: Use `UrlReaderServiceSearchResponseFile` from `@backstage/backend-plugin-api` instead.
+
+### 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.
+- 93095ee: Make sure node-fetch is version 2.7.0 or greater
+- 6795e33: This package is marked as `deprecated` and will be removed in a near future, please follow the deprecated instructions for the exports you still use.
+- 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).
+
+- ddde5fe: Internal type refactor.
+- b63d378: export `createConfigSecretEnumerator` from `@backstage/backend-common` instead of `@backstage/backend-app-api`.
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.8.0
+ - @backstage/config-loader@1.9.0
+ - @backstage/plugin-auth-node@0.5.0
+ - @backstage/backend-dev-utils@0.1.5
+ - @backstage/integration@1.14.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
+
+## 0.23.4-next.3
+
+### Patch Changes
+
+- ddde5fe: Internal type refactor.
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.8.0-next.3
+ - @backstage/backend-dev-utils@0.1.4
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/config-loader@1.9.0-next.2
+ - @backstage/errors@1.2.4
+ - @backstage/integration@1.14.0-next.0
+ - @backstage/integration-aws-node@0.1.12
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.5.0-next.3
+
## 0.23.4-next.2
### Patch Changes
diff --git a/packages/backend-common/README.md b/packages/backend-common/README.md
index 71a15bfb5a..e9f2f43e83 100644
--- a/packages/backend-common/README.md
+++ b/packages/backend-common/README.md
@@ -1,5 +1,8 @@
# @backstage/backend-common
+> [!CAUTION]
+> This package is deprecated and will be removed in a near future, so please follow the deprecated instructions for the exports you still use.
+
Common functionality library for Backstage backends, implementing logging,
error handling and similar.
diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md
index 23ed13b62c..61efc0f3a1 100644
--- a/packages/backend-common/api-report.md
+++ b/packages/backend-common/api-report.md
@@ -9,30 +9,18 @@
import { AppConfig } from '@backstage/config';
import { AuthCallback } from 'isomorphic-git';
import { AuthService } from '@backstage/backend-plugin-api';
-import { AwsCredentialsManager } from '@backstage/integration-aws-node';
-import { AwsS3Integration } from '@backstage/integration';
-import { AzureDevOpsCredentialsProvider } from '@backstage/integration';
-import { AzureIntegration } from '@backstage/integration';
import { BackendFeatureCompat } from '@backstage/backend-plugin-api';
-import { BitbucketCloudIntegration } from '@backstage/integration';
-import { BitbucketIntegration } from '@backstage/integration';
-import { BitbucketServerIntegration } from '@backstage/integration';
import { CacheService } from '@backstage/backend-plugin-api';
import { CacheServiceOptions } from '@backstage/backend-plugin-api';
import { CacheServiceSetOptions } from '@backstage/backend-plugin-api';
import { Config } from '@backstage/config';
+import { ConfigSchema } from '@backstage/config-loader';
import cors from 'cors';
import { DatabaseService } from '@backstage/backend-plugin-api';
import { DiscoveryService } from '@backstage/backend-plugin-api';
import Docker from 'dockerode';
import { ErrorRequestHandler } from 'express';
import express from 'express';
-import { GerritIntegration } from '@backstage/integration';
-import { GiteaIntegration } from '@backstage/integration';
-import { GithubCredentialsProvider } from '@backstage/integration';
-import { GithubIntegration } from '@backstage/integration';
-import { GitLabIntegration } from '@backstage/integration';
-import { HarnessIntegration } from '@backstage/integration';
import { HttpAuthService } from '@backstage/backend-plugin-api';
import { IdentityService } from '@backstage/backend-plugin-api';
import { isChildPath as isChildPath_2 } from '@backstage/backend-plugin-api';
@@ -46,34 +34,18 @@ import { MergeResult } from 'isomorphic-git';
import { PermissionsService } from '@backstage/backend-plugin-api';
import { PluginMetadataService } from '@backstage/backend-plugin-api';
import { PushResult } from 'isomorphic-git';
-import { Readable } from 'stream';
import { ReadCommitResult } from 'isomorphic-git';
-import { ReadTreeOptions as ReadTreeOptions_2 } from '@backstage/backend-plugin-api';
-import { ReadTreeResponse as ReadTreeResponse_2 } from '@backstage/backend-plugin-api';
-import { ReadTreeResponseDirOptions as ReadTreeResponseDirOptions_2 } from '@backstage/backend-plugin-api';
-import { ReadTreeResponseFile as ReadTreeResponseFile_2 } from '@backstage/backend-plugin-api';
-import { ReadUrlOptions as ReadUrlOptions_2 } from '@backstage/backend-plugin-api';
-import { ReadUrlResponse as ReadUrlResponse_2 } from '@backstage/backend-plugin-api';
import { RequestHandler } from 'express';
import { resolvePackagePath as resolvePackagePath_2 } from '@backstage/backend-plugin-api';
import { resolveSafeChildPath as resolveSafeChildPath_2 } from '@backstage/backend-plugin-api';
import { RootConfigService } from '@backstage/backend-plugin-api';
import { Router } from 'express';
import { SchedulerService } from '@backstage/backend-plugin-api';
-import { SearchOptions as SearchOptions_2 } from '@backstage/backend-plugin-api';
-import { SearchResponse as SearchResponse_2 } from '@backstage/backend-plugin-api';
-import { SearchResponseFile as SearchResponseFile_2 } from '@backstage/backend-plugin-api';
import { Server } from 'http';
import { ServiceRef } from '@backstage/backend-plugin-api';
import { TokenManagerService } from '@backstage/backend-plugin-api';
import { TransportStreamOptions } from 'winston-transport';
import { UrlReaderService } from '@backstage/backend-plugin-api';
-import { UrlReaderServiceReadTreeOptions } from '@backstage/backend-plugin-api';
-import { UrlReaderServiceReadTreeResponse } from '@backstage/backend-plugin-api';
-import { UrlReaderServiceReadUrlOptions } from '@backstage/backend-plugin-api';
-import { UrlReaderServiceReadUrlResponse } from '@backstage/backend-plugin-api';
-import { UrlReaderServiceSearchOptions } from '@backstage/backend-plugin-api';
-import { UrlReaderServiceSearchResponse } from '@backstage/backend-plugin-api';
import { UserInfoService } from '@backstage/backend-plugin-api';
import { V1PodTemplateSpec } from '@kubernetes/client-node';
import * as winston from 'winston';
@@ -85,31 +57,6 @@ export type AuthCallbackOptions = {
logger?: LoggerService;
};
-// Warning: (ae-forgotten-export) The symbol "AwsS3UrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class AwsS3UrlReader extends AwsS3UrlReader_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "AzureUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class AzureUrlReader extends AzureUrlReader_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "BitbucketCloudUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class BitbucketCloudUrlReader extends BitbucketCloudUrlReader_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "BitbucketServerUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class BitbucketServerUrlReader extends BitbucketServerUrlReader_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "BitbucketUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class BitbucketUrlReader extends BitbucketUrlReader_2 {}
-
// @public @deprecated (undocumented)
export type CacheClient = CacheService;
@@ -142,6 +89,11 @@ export interface ContainerRunner {
runContainer(opts: RunContainerOptions): Promise;
}
+// Warning: (ae-forgotten-export) The symbol "createConfigSecretEnumerator_2" needs to be exported by the entry point index.d.ts
+//
+// @public @deprecated (undocumented)
+export const createConfigSecretEnumerator: typeof createConfigSecretEnumerator_2;
+
// @public @deprecated
export function createLegacyAuthAdapters<
TOptions extends {
@@ -239,21 +191,6 @@ export type ErrorHandlerOptions = {
logClientErrors?: boolean;
};
-// Warning: (ae-forgotten-export) The symbol "FetchUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class FetchUrlReader extends FetchUrlReader_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "FromReadableArrayOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type FromReadableArrayOptions = FromReadableArrayOptions_2;
-
-// Warning: (ae-forgotten-export) The symbol "GerritUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class GerritUrlReader extends GerritUrlReader_2 {}
-
// @public @deprecated
export function getRootLogger(): winston.Logger;
@@ -336,26 +273,6 @@ export class Git {
resolveRef(options: { dir: string; ref: string }): Promise;
}
-// Warning: (ae-forgotten-export) The symbol "GiteaUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class GiteaUrlReader extends GiteaUrlReader_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "GithubUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class GithubUrlReader extends GithubUrlReader_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "GitlabUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class GitlabUrlReader extends GitlabUrlReader_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "HarnessUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class HarnessUrlReader extends HarnessUrlReader_2 {}
-
// @public @deprecated
class HostDiscovery implements DiscoveryService {
static fromConfig(
@@ -500,50 +417,6 @@ export interface PullOptions {
};
}
-// Warning: (ae-forgotten-export) The symbol "ReaderFactory_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type ReaderFactory = ReaderFactory_2;
-
-// @public @deprecated (undocumented)
-export type ReadTreeOptions = ReadTreeOptions_2;
-
-// @public @deprecated (undocumented)
-export type ReadTreeResponse = ReadTreeResponse_2;
-
-// @public @deprecated (undocumented)
-export type ReadTreeResponseDirOptions = ReadTreeResponseDirOptions_2;
-
-// Warning: (ae-forgotten-export) The symbol "ReadTreeResponseFactory_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type ReadTreeResponseFactory = ReadTreeResponseFactory_2;
-
-// Warning: (ae-forgotten-export) The symbol "ReadTreeResponseFactoryOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type ReadTreeResponseFactoryOptions = ReadTreeResponseFactoryOptions_2;
-
-// @public @deprecated (undocumented)
-export type ReadTreeResponseFile = ReadTreeResponseFile_2;
-
-// @public @deprecated (undocumented)
-export type ReadUrlOptions = ReadUrlOptions_2;
-
-// @public @deprecated (undocumented)
-export type ReadUrlResponse = ReadUrlResponse_2;
-
-// Warning: (ae-forgotten-export) The symbol "ReadUrlResponseFactory_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class ReadUrlResponseFactory extends ReadUrlResponseFactory_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "ReadUrlResponseFactoryFromStreamOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type ReadUrlResponseFactoryFromStreamOptions =
- ReadUrlResponseFactoryFromStreamOptions_2;
-
// @public @deprecated
export function redactWinstonLogLine(
info: winston.Logform.TransformableInfo,
@@ -577,15 +450,6 @@ export type RunContainerOptions = {
pullOptions?: PullOptions;
};
-// @public @deprecated (undocumented)
-export type SearchOptions = SearchOptions_2;
-
-// @public @deprecated (undocumented)
-export type SearchResponse = SearchResponse_2;
-
-// @public @deprecated (undocumented)
-export type SearchResponseFile = SearchResponseFile_2;
-
// @public @deprecated
export class ServerTokenManager implements TokenManager {
// (undocumented)
@@ -661,24 +525,6 @@ export interface StatusCheckHandlerOptions {
// @public @deprecated (undocumented)
export type TokenManager = TokenManagerService;
-// @public @deprecated (undocumented)
-export type UrlReader = UrlReaderService;
-
-// Warning: (ae-forgotten-export) The symbol "UrlReaderPredicateTuple_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type UrlReaderPredicateTuple = UrlReaderPredicateTuple_2;
-
-// Warning: (ae-forgotten-export) The symbol "UrlReaders_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class UrlReaders extends UrlReaders_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "UrlReadersOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type UrlReadersOptions = UrlReadersOptions_2;
-
// @public @deprecated
export function useHotCleanup(
_module: NodeModule,
diff --git a/packages/backend-common/package.json b/packages/backend-common/package.json
index ccf44fba0f..ce26958aaf 100644
--- a/packages/backend-common/package.json
+++ b/packages/backend-common/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/backend-common",
- "version": "0.23.4-next.2",
+ "version": "0.24.0",
"description": "Common functionality library for Backstage backends",
"backstage": {
"role": "node-library"
diff --git a/packages/backend-common/src/compat/legacy/legacy.test.ts b/packages/backend-common/src/compat/legacy/legacy.test.ts
index e5d395a8f9..08a645f660 100644
--- a/packages/backend-common/src/compat/legacy/legacy.test.ts
+++ b/packages/backend-common/src/compat/legacy/legacy.test.ts
@@ -24,7 +24,7 @@ import { Router } from 'express';
import { createLegacyAuthAdapters } from '..';
import { legacyPlugin } from './legacy';
// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { authServiceFactory } from '../../../../backend-app-api/src/services/implementations/auth';
+import { authServiceFactory } from '../../../../backend-defaults/src/entrypoints/auth';
// eslint-disable-next-line @backstage/no-relative-monorepo-imports
import { tokenManagerServiceFactory } from '../../../../backend-app-api/src/services/implementations/tokenManager';
diff --git a/packages/backend-common/src/compat/legacy/legacy.ts b/packages/backend-common/src/compat/legacy/legacy.ts
index c779daacd2..4dc7d1a09a 100644
--- a/packages/backend-common/src/compat/legacy/legacy.ts
+++ b/packages/backend-common/src/compat/legacy/legacy.ts
@@ -18,6 +18,7 @@ import {
AuthService,
coreServices,
createBackendPlugin,
+ HttpRouterService,
ServiceRef,
} from '@backstage/backend-plugin-api';
import { RequestHandler } from 'express';
@@ -107,7 +108,10 @@ export function makeLegacyPlugin<
return [key, transform(dep)];
}
if (key === 'tokenManager') {
- return [key, wrapTokenManager(dep as TokenManager, _auth)];
+ return [
+ key,
+ wrapTokenManager(dep as TokenManager, _auth as AuthService),
+ ];
}
return [key, dep];
}),
@@ -115,7 +119,7 @@ export function makeLegacyPlugin<
const router = await createRouter(
pluginEnv as TransformedEnv,
);
- _router.use(router);
+ (_router as HttpRouterService).use(router);
},
});
},
diff --git a/packages/backend-common/src/deprecated/config.ts b/packages/backend-common/src/deprecated/config.ts
deleted file mode 100644
index 2d06ca2072..0000000000
--- a/packages/backend-common/src/deprecated/config.ts
+++ /dev/null
@@ -1,54 +0,0 @@
-/*
- * 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.
- */
-
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import {
- createConfigSecretEnumerator,
- loadBackendConfig as newLoadBackendConfig,
-} from '../../../backend-app-api/src/config';
-import { LoggerService } from '@backstage/backend-plugin-api';
-import { AppConfig, Config } from '@backstage/config';
-import { LoadConfigOptionsRemote } from '@backstage/config-loader';
-import { setRootLoggerRedactionList } from './logging/createRootLogger';
-
-/**
- * Load configuration for a Backend.
- *
- * This function should only be called once, during the initialization of the backend.
- *
- * @public
- * @deprecated Use {@link @backstage/backend-app-api#loadBackendConfig} instead.
- */
-export async function loadBackendConfig(options: {
- logger: LoggerService;
- // process.argv or any other overrides
- remote?: LoadConfigOptionsRemote;
- additionalConfigs?: AppConfig[];
- argv: string[];
- watch?: boolean;
-}): Promise {
- const secretEnumerator = await createConfigSecretEnumerator({
- logger: options.logger,
- });
- const { config } = await newLoadBackendConfig(options);
-
- setRootLoggerRedactionList(secretEnumerator(config));
- config.subscribe?.(() =>
- setRootLoggerRedactionList(secretEnumerator(config)),
- );
-
- return config;
-}
diff --git a/packages/backend-app-api/src/config/ObservableConfigProxy.test.ts b/packages/backend-common/src/deprecated/config/ObservableConfigProxy.test.ts
similarity index 100%
rename from packages/backend-app-api/src/config/ObservableConfigProxy.test.ts
rename to packages/backend-common/src/deprecated/config/ObservableConfigProxy.test.ts
diff --git a/packages/backend-app-api/src/config/ObservableConfigProxy.ts b/packages/backend-common/src/deprecated/config/ObservableConfigProxy.ts
similarity index 100%
rename from packages/backend-app-api/src/config/ObservableConfigProxy.ts
rename to packages/backend-common/src/deprecated/config/ObservableConfigProxy.ts
diff --git a/packages/backend-app-api/src/config/config.test.ts b/packages/backend-common/src/deprecated/config/config.test.ts
similarity index 100%
rename from packages/backend-app-api/src/config/config.test.ts
rename to packages/backend-common/src/deprecated/config/config.test.ts
index 8828c557e0..865b1b4d60 100644
--- a/packages/backend-app-api/src/config/config.test.ts
+++ b/packages/backend-common/src/deprecated/config/config.test.ts
@@ -15,8 +15,8 @@
*/
import { loadConfigSchema } from '@backstage/config-loader';
-import { createConfigSecretEnumerator } from './config';
import { mockServices } from '@backstage/backend-test-utils';
+import { createConfigSecretEnumerator } from './config';
describe('createConfigSecretEnumerator', () => {
it('should enumerate secrets', async () => {
diff --git a/packages/backend-app-api/src/config/config.ts b/packages/backend-common/src/deprecated/config/config.ts
similarity index 76%
rename from packages/backend-app-api/src/config/config.ts
rename to packages/backend-common/src/deprecated/config/config.ts
index 957997849e..d50476a9f2 100644
--- a/packages/backend-app-api/src/config/config.ts
+++ b/packages/backend-common/src/deprecated/config/config.ts
@@ -14,8 +14,11 @@
* limitations under the License.
*/
+import { LoggerService } from '@backstage/backend-plugin-api';
+import { AppConfig, Config } from '@backstage/config';
+import { setRootLoggerRedactionList } from '../logging/createRootLogger';
// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { createConfigSecretEnumerator as _createConfigSecretEnumerator } from '../../../backend-defaults/src/entrypoints/rootConfig/createConfigSecretEnumerator';
+import { createConfigSecretEnumerator as _createConfigSecretEnumerator } from '../../../../backend-defaults/src/entrypoints/rootConfig/createConfigSecretEnumerator';
import { resolve as resolvePath } from 'path';
import parseArgs from 'minimist';
@@ -26,13 +29,12 @@ import {
LoadConfigOptionsRemote,
} from '@backstage/config-loader';
import { ConfigReader } from '@backstage/config';
-import type { Config, AppConfig } from '@backstage/config';
import { ObservableConfigProxy } from './ObservableConfigProxy';
-import { isValidUrl } from '../lib/urls';
+import { isValidUrl } from './urls';
/**
* @public
- * @deprecated Please import from `@backstage/backend-defaults/rootConfig` instead.
+ * @deprecated Please migrate to the new backend system and use `coreServices.rootConfig` instead, or the {@link @backstage/config-loader#ConfigSources} facilities if required.
*/
export const createConfigSecretEnumerator = _createConfigSecretEnumerator;
@@ -45,6 +47,27 @@ export const createConfigSecretEnumerator = _createConfigSecretEnumerator;
* @deprecated Please migrate to the new backend system and use `coreServices.rootConfig` instead, or the {@link @backstage/config-loader#ConfigSources} facilities if required.
*/
export async function loadBackendConfig(options: {
+ logger: LoggerService;
+ // process.argv or any other overrides
+ remote?: LoadConfigOptionsRemote;
+ additionalConfigs?: AppConfig[];
+ argv: string[];
+ watch?: boolean;
+}): Promise {
+ const secretEnumerator = await createConfigSecretEnumerator({
+ logger: options.logger,
+ });
+ const { config } = await newLoadBackendConfig(options);
+
+ setRootLoggerRedactionList(secretEnumerator(config));
+ config.subscribe?.(() =>
+ setRootLoggerRedactionList(secretEnumerator(config)),
+ );
+
+ return config;
+}
+
+async function newLoadBackendConfig(options: {
remote?: LoadConfigOptionsRemote;
argv: string[];
additionalConfigs?: AppConfig[];
diff --git a/packages/backend-app-api/src/config/index.ts b/packages/backend-common/src/deprecated/config/index.ts
similarity index 94%
rename from packages/backend-app-api/src/config/index.ts
rename to packages/backend-common/src/deprecated/config/index.ts
index 0ed8d2bc93..c87193876c 100644
--- a/packages/backend-app-api/src/config/index.ts
+++ b/packages/backend-common/src/deprecated/config/index.ts
@@ -1,5 +1,5 @@
/*
- * Copyright 2023 The Backstage Authors
+ * 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.
diff --git a/packages/backend-app-api/src/lib/urls.test.ts b/packages/backend-common/src/deprecated/config/urls.test.ts
similarity index 100%
rename from packages/backend-app-api/src/lib/urls.test.ts
rename to packages/backend-common/src/deprecated/config/urls.test.ts
diff --git a/packages/backend-app-api/src/lib/urls.ts b/packages/backend-common/src/deprecated/config/urls.ts
similarity index 100%
rename from packages/backend-app-api/src/lib/urls.ts
rename to packages/backend-common/src/deprecated/config/urls.ts
diff --git a/packages/backend-common/src/deprecated/index.ts b/packages/backend-common/src/deprecated/index.ts
index e3e4101d25..5dfcd322ed 100644
--- a/packages/backend-common/src/deprecated/index.ts
+++ b/packages/backend-common/src/deprecated/index.ts
@@ -36,45 +36,6 @@ import {
type LegacyRootDatabaseService as _LegacyRootDatabaseService,
} from '../../../backend-defaults/src/entrypoints/database/DatabaseManager';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { AzureUrlReader as _AzureUrlReader } from '../../../backend-defaults/src/entrypoints/urlReader/lib/AzureUrlReader';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { BitbucketCloudUrlReader as _BitbucketCloudUrlReader } from '../../../backend-defaults/src/entrypoints/urlReader/lib/BitbucketCloudUrlReader';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { BitbucketUrlReader as _BitbucketUrlReader } from '../../../backend-defaults/src/entrypoints/urlReader/lib/BitbucketUrlReader';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { BitbucketServerUrlReader as _BitbucketServerUrlReader } from '../../../backend-defaults/src/entrypoints/urlReader/lib/BitbucketServerUrlReader';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { GerritUrlReader as _GerritUrlReader } from '../../../backend-defaults/src/entrypoints/urlReader/lib/GerritUrlReader';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { GithubUrlReader as _GithubUrlReader } from '../../../backend-defaults/src/entrypoints/urlReader/lib/GithubUrlReader';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { GitlabUrlReader as _GitlabUrlReader } from '../../../backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { GiteaUrlReader as _GiteaUrlReader } from '../../../backend-defaults/src/entrypoints/urlReader/lib/GiteaUrlReader';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { HarnessUrlReader as _HarnessUrlReader } from '../../../backend-defaults/src/entrypoints/urlReader/lib/HarnessUrlReader';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { AwsS3UrlReader as _AwsS3UrlReader } from '../../../backend-defaults/src/entrypoints/urlReader/lib/AwsS3UrlReader';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { FetchUrlReader as _FetchUrlReader } from '../../../backend-defaults/src/entrypoints/urlReader/lib/FetchUrlReader';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { UrlReaders as _UrlReaders } from '../../../backend-defaults/src/entrypoints/urlReader/lib/UrlReaders';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { ReadUrlResponseFactory as _ReadUrlResponseFactory } from '../../../backend-defaults/src/entrypoints/urlReader/lib/ReadUrlResponseFactory';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import type { UrlReadersOptions as _UrlReadersOptions } from '../../../backend-defaults/src/entrypoints/urlReader/lib/UrlReaders';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import type { FromReadableArrayOptions as _FromReadableArrayOptions } from '../../../backend-defaults/src/entrypoints/urlReader/lib/types';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import type {
- ReaderFactory as _ReaderFactory,
- ReadTreeResponseFactory as _ReadTreeResponseFactory,
- ReadTreeResponseFactoryOptions as _ReadTreeResponseFactoryOptions,
- ReadUrlResponseFactoryFromStreamOptions as _ReadUrlResponseFactoryFromStreamOptions,
- UrlReaderPredicateTuple as _UrlReaderPredicateTuple,
-} from '../../../backend-defaults/src/entrypoints/urlReader/lib/types';
-
import {
DiscoveryService,
CacheService,
@@ -85,16 +46,6 @@ import {
resolvePackagePath as _resolvePackagePath,
resolveSafeChildPath as _resolveSafeChildPath,
isChildPath as _isChildPath,
- ReadTreeOptions as _ReadTreeOptions,
- ReadTreeResponse as _ReadTreeResponse,
- ReadTreeResponseFile as _ReadTreeResponseFile,
- ReadTreeResponseDirOptions as _ReadTreeResponseDirOptions,
- ReadUrlOptions as _ReadUrlOptions,
- ReadUrlResponse as _ReadUrlResponse,
- SearchOptions as _SearchOptions,
- SearchResponse as _SearchResponse,
- SearchResponseFile as _SearchResponseFile,
- UrlReaderService as _UrlReaderService,
LifecycleService,
PluginMetadataService,
} from '@backstage/backend-plugin-api';
@@ -290,184 +241,3 @@ export const resolveSafeChildPath = _resolveSafeChildPath;
* Please use the `isChildPath` function from the `@backstage/cli-common` package instead.
*/
export const isChildPath = _isChildPath;
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export class AzureUrlReader extends _AzureUrlReader {}
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export class BitbucketCloudUrlReader extends _BitbucketCloudUrlReader {}
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export class BitbucketUrlReader extends _BitbucketUrlReader {}
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export class BitbucketServerUrlReader extends _BitbucketServerUrlReader {}
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export class GerritUrlReader extends _GerritUrlReader {}
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export class GithubUrlReader extends _GithubUrlReader {}
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export class GitlabUrlReader extends _GitlabUrlReader {}
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export class GiteaUrlReader extends _GiteaUrlReader {}
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export class HarnessUrlReader extends _HarnessUrlReader {}
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export class AwsS3UrlReader extends _AwsS3UrlReader {}
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export class FetchUrlReader extends _FetchUrlReader {}
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export class UrlReaders extends _UrlReaders {}
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export class ReadUrlResponseFactory extends _ReadUrlResponseFactory {}
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export type UrlReadersOptions = _UrlReadersOptions;
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export type FromReadableArrayOptions = _FromReadableArrayOptions;
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export type ReaderFactory = _ReaderFactory;
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export type ReadTreeResponseFactory = _ReadTreeResponseFactory;
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export type ReadTreeResponseFactoryOptions = _ReadTreeResponseFactoryOptions;
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export type ReadUrlResponseFactoryFromStreamOptions =
- _ReadUrlResponseFactoryFromStreamOptions;
-
-/**
- * @public
- * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
- */
-export type UrlReaderPredicateTuple = _UrlReaderPredicateTuple;
-
-/**
- * @public
- * @deprecated Use `UrlReaderServiceReadTreeOptions` from `@backstage/backend-plugin-api` instead
- */
-export type ReadTreeOptions = _ReadTreeOptions;
-
-/**
- * @public
- * @deprecated Use `UrlReaderServiceReadTreeResponse` from `@backstage/backend-plugin-api` instead
- */
-export type ReadTreeResponse = _ReadTreeResponse;
-
-/**
- * @public
- * @deprecated Use `UrlReaderServiceReadTreeResponseFile` from `@backstage/backend-plugin-api` instead
- */
-export type ReadTreeResponseFile = _ReadTreeResponseFile;
-
-/**
- * @public
- * @deprecated Use `UrlReaderServiceReadTreeResponseDirOptions` from `@backstage/backend-plugin-api` instead
- */
-export type ReadTreeResponseDirOptions = _ReadTreeResponseDirOptions;
-
-/**
- * @public
- * @deprecated Use `UrlReaderServiceReadUrlOptions` from `@backstage/backend-plugin-api` instead
- */
-export type ReadUrlOptions = _ReadUrlOptions;
-
-/**
- * @public
- * @deprecated Use `UrlReaderServiceReadUrlResponse` from `@backstage/backend-plugin-api` instead
- */
-export type ReadUrlResponse = _ReadUrlResponse;
-
-/**
- * @public
- * @deprecated Use `UrlReaderServiceSearchOptions` from `@backstage/backend-plugin-api` instead
- */
-export type SearchOptions = _SearchOptions;
-
-/**
- * @public
- * @deprecated Use `UrlReaderServiceSearchResponse` from `@backstage/backend-plugin-api` instead
- */
-export type SearchResponse = _SearchResponse;
-
-/**
- * @public
- * @deprecated Use `UrlReaderServiceSearchResponseFile` from `@backstage/backend-plugin-api` instead
- */
-export type SearchResponseFile = _SearchResponseFile;
-
-/**
- * @public
- * @deprecated Use `UrlReaderService` from `@backstage/backend-plugin-api` instead
- */
-export type UrlReader = _UrlReaderService;
diff --git a/packages/backend-common/src/deprecated/logging/createRootLogger.ts b/packages/backend-common/src/deprecated/logging/createRootLogger.ts
index b177024601..04b3799381 100644
--- a/packages/backend-common/src/deprecated/logging/createRootLogger.ts
+++ b/packages/backend-common/src/deprecated/logging/createRootLogger.ts
@@ -15,7 +15,7 @@
*/
// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { WinstonLogger } from '../../../../backend-app-api/src/logging/WinstonLogger';
+import { WinstonLogger } from '../../../../backend-defaults/src/entrypoints/rootLogger/WinstonLogger';
import { merge } from 'lodash';
import * as winston from 'winston';
import { format, LoggerOptions } from 'winston';
diff --git a/packages/backend-common/src/index.ts b/packages/backend-common/src/index.ts
index ad5621b5a9..e08bef3048 100644
--- a/packages/backend-common/src/index.ts
+++ b/packages/backend-common/src/index.ts
@@ -17,6 +17,9 @@
/**
* Common functionality library for Backstage backends
*
+ * @remarks
+ * This package is deprecated and will be removed in a near future, so please follow the deprecated instructions for the exports you still use.
+ *
* @packageDocumentation
*/
diff --git a/packages/backend-defaults/CHANGELOG.md b/packages/backend-defaults/CHANGELOG.md
index 44b0a6b9b0..64d9b77fba 100644
--- a/packages/backend-defaults/CHANGELOG.md
+++ b/packages/backend-defaults/CHANGELOG.md
@@ -1,5 +1,58 @@
# @backstage/backend-defaults
+## 0.4.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
+- 3b429fb: Added deprecation warning to urge users to perform the auth service migration or implement their own token manager service.
+ See https://backstage.io/docs/tutorials/auth-service-migration for more information.
+- 7681b17: update the `morgan` middleware to use a custom format to prevent PII from being logged
+- 4e79d19: The `createHealthRouter` utility that allows you to create a health check router is now exported via `@backstage/backend-defaults/rootHttpRouter`.
+- 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`.
+- 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`.
+- 7c5f3b0: Update the `UrlReader` service to depends on multiple instances of `UrlReaderFactoryProvider` service.
+- 81f930a: use formatted query to prevent chance of SQL-injection
+- 1d5f298: Avoid excessive numbers of error listeners on cache clients
+- Updated dependencies
+ - @backstage/backend-app-api@0.9.0
+ - @backstage/backend-plugin-api@0.8.0
+ - @backstage/backend-common@0.24.0
+ - @backstage/config-loader@1.9.0
+ - @backstage/plugin-auth-node@0.5.0
+ - @backstage/plugin-permission-node@0.8.1
+ - @backstage/backend-dev-utils@0.1.5
+ - @backstage/integration@1.14.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-events-node@0.3.9
+
+## 0.4.2-next.3
+
+### Patch Changes
+
+- 81f930a: use formatted query to prevent chance of SQL-injection
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.8.0-next.3
+ - @backstage/backend-common@0.23.4-next.3
+ - @backstage/backend-app-api@0.8.1-next.3
+ - @backstage/backend-dev-utils@0.1.4
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/config-loader@1.9.0-next.2
+ - @backstage/errors@1.2.4
+ - @backstage/integration@1.14.0-next.0
+ - @backstage/integration-aws-node@0.1.12
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.5.0-next.3
+ - @backstage/plugin-events-node@0.3.9-next.3
+ - @backstage/plugin-permission-node@0.8.1-next.3
+
## 0.4.2-next.2
### Patch Changes
diff --git a/packages/backend-defaults/config.d.ts b/packages/backend-defaults/config.d.ts
index 1c784bce0c..1582cf1a39 100644
--- a/packages/backend-defaults/config.d.ts
+++ b/packages/backend-defaults/config.d.ts
@@ -74,7 +74,7 @@ export interface Config {
* the Backstage ecosystem to get authorized for access to APIs that do
* not permit unauthorized access.
*/
- externalAccess: Array<
+ externalAccess?: Array<
| {
/**
* This is the legacy service-to-service access method, where a set
diff --git a/packages/backend-defaults/package.json b/packages/backend-defaults/package.json
index cef9641de6..3280a3cf9d 100644
--- a/packages/backend-defaults/package.json
+++ b/packages/backend-defaults/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/backend-defaults",
- "version": "0.4.2-next.2",
+ "version": "0.4.2",
"description": "Backend defaults used by Backstage backend apps",
"backstage": {
"role": "node-library"
@@ -171,6 +171,7 @@
"path-to-regexp": "^6.2.1",
"pg": "^8.11.3",
"pg-connection-string": "^2.3.0",
+ "pg-format": "^1.0.4",
"raw-body": "^2.4.1",
"selfsigned": "^2.0.0",
"stoppable": "^1.1.0",
@@ -191,6 +192,7 @@
"@types/http-errors": "^2.0.0",
"@types/morgan": "^1.9.0",
"@types/node-forge": "^1.3.0",
+ "@types/pg-format": "^1.0.5",
"@types/stoppable": "^1.1.0",
"aws-sdk-client-mock": "^4.0.0",
"http-errors": "^2.0.0",
diff --git a/packages/backend-defaults/src/entrypoints/auth/DefaultAuthService.ts b/packages/backend-defaults/src/entrypoints/auth/DefaultAuthService.ts
index 159da79435..08cfc147f8 100644
--- a/packages/backend-defaults/src/entrypoints/auth/DefaultAuthService.ts
+++ b/packages/backend-defaults/src/entrypoints/auth/DefaultAuthService.ts
@@ -22,6 +22,7 @@ import {
BackstagePrincipalTypes,
BackstageServicePrincipal,
BackstageUserPrincipal,
+ LoggerService,
} from '@backstage/backend-plugin-api';
import { AuthenticationError, ForwardedError } from '@backstage/errors';
import { JsonObject } from '@backstage/types';
@@ -47,6 +48,7 @@ export class DefaultAuthService implements AuthService {
private readonly pluginId: string,
private readonly disableDefaultAuthPolicy: boolean,
private readonly pluginKeySource: PluginKeySource,
+ private readonly logger: LoggerService,
) {}
async authenticate(
@@ -166,6 +168,9 @@ export class DefaultAuthService implements AuthService {
});
}
// If the target plugin does not support the new auth service, fall back to using old token format
+ this.logger.warn(
+ `DEPRECATION WARNING: A call to the '${targetPluginId}' plugin had to fall back to using deprecated auth via the token manager service. Please migrate all plugins to the new auth service, see https://backstage.io/docs/tutorials/auth-service-migration for more information`,
+ );
return this.tokenManager.getToken().catch(error => {
throw new ForwardedError(
`Unable to generate legacy token for communication with the '${targetPluginId}' plugin. ` +
diff --git a/packages/backend-defaults/src/entrypoints/auth/authServiceFactory.ts b/packages/backend-defaults/src/entrypoints/auth/authServiceFactory.ts
index e275e2be00..b66ba7227f 100644
--- a/packages/backend-defaults/src/entrypoints/auth/authServiceFactory.ts
+++ b/packages/backend-defaults/src/entrypoints/auth/authServiceFactory.ts
@@ -88,6 +88,7 @@ export const authServiceFactory = createServiceFactory({
plugin.getId(),
disableDefaultAuthPolicy,
keySource,
+ logger,
);
},
});
diff --git a/packages/backend-defaults/src/entrypoints/database/connectors/postgres.ts b/packages/backend-defaults/src/entrypoints/database/connectors/postgres.ts
index 444bbc0d18..46b958789d 100644
--- a/packages/backend-defaults/src/entrypoints/database/connectors/postgres.ts
+++ b/packages/backend-defaults/src/entrypoints/database/connectors/postgres.ts
@@ -29,6 +29,7 @@ import { Connector } from '../types';
import defaultNameOverride from './defaultNameOverride';
import defaultSchemaOverride from './defaultSchemaOverride';
import { mergeDatabaseConfig } from './mergeDatabaseConfig';
+import format from 'pg-format';
// Limits the number of concurrent DDL operations to 1
const ddlLimiter = limiterFactory(1);
@@ -52,7 +53,8 @@ export function createPgDatabaseClient(
database.client.pool.on(
'createSuccess',
async (_event: number, pgClient: Client) => {
- await pgClient.query(`SET ROLE ${role}`);
+ const query = format('SET ROLE %I', role);
+ await pgClient.query(query);
},
);
}
diff --git a/packages/backend-defaults/src/entrypoints/rootHttpRouter/http/MiddlewareFactory.ts b/packages/backend-defaults/src/entrypoints/rootHttpRouter/http/MiddlewareFactory.ts
index 77136fd7e5..f38c10820a 100644
--- a/packages/backend-defaults/src/entrypoints/rootHttpRouter/http/MiddlewareFactory.ts
+++ b/packages/backend-defaults/src/entrypoints/rootHttpRouter/http/MiddlewareFactory.ts
@@ -140,8 +140,9 @@ export class MiddlewareFactory {
const logger = this.#logger.child({
type: 'incomingRequest',
});
-
- return morgan('combined', {
+ const customMorganFormat =
+ '[:date[clf]] ":method :url HTTP/:http-version" :status :res[content-length] ":referrer" ":user-agent"';
+ return morgan(customMorganFormat, {
stream: {
write(message: string) {
logger.info(message.trimEnd());
diff --git a/packages/backend-dev-utils/CHANGELOG.md b/packages/backend-dev-utils/CHANGELOG.md
index d60b686e79..81686fb493 100644
--- a/packages/backend-dev-utils/CHANGELOG.md
+++ b/packages/backend-dev-utils/CHANGELOG.md
@@ -1,5 +1,11 @@
# @backstage/backend-dev-utils
+## 0.1.5
+
+### Patch Changes
+
+- 3a35172: Fix `EventEmitter` memory leak in the development utilities
+
## 0.1.4
### Patch Changes
diff --git a/packages/backend-dev-utils/package.json b/packages/backend-dev-utils/package.json
index b24c9102b2..4d22c5010f 100644
--- a/packages/backend-dev-utils/package.json
+++ b/packages/backend-dev-utils/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/backend-dev-utils",
- "version": "0.1.4",
+ "version": "0.1.5",
"backstage": {
"role": "node-library"
},
diff --git a/packages/backend-dev-utils/src/ipcClient.ts b/packages/backend-dev-utils/src/ipcClient.ts
index d9ec7821de..6e1d3d181e 100644
--- a/packages/backend-dev-utils/src/ipcClient.ts
+++ b/packages/backend-dev-utils/src/ipcClient.ts
@@ -35,6 +35,8 @@ type Response =
error: Error;
};
+type ResponseHandler = (response: Response) => void;
+
const requestType = '@backstage/cli/channel/request';
const responseType = '@backstage/cli/channel/response';
@@ -48,21 +50,40 @@ const IPC_TIMEOUT_MS = 5000;
export class BackstageIpcClient {
#messageId = 0;
#sendMessage: SendMessage;
+ #handlers: Map = new Map();
/**
* Creates a new client if we're in a child process with IPC and BACKSTAGE_CLI_CHANNEL is set.
*/
static create(): BackstageIpcClient | undefined {
const sendMessage = process.send?.bind(process);
- return sendMessage && process.env.BACKSTAGE_CLI_CHANNEL
- ? new BackstageIpcClient(sendMessage)
- : undefined;
+ const client =
+ sendMessage && process.env.BACKSTAGE_CLI_CHANNEL
+ ? new BackstageIpcClient(sendMessage)
+ : undefined;
+
+ if (client) {
+ process.on('message', (message, _sendHandle) =>
+ client.handleMessage(message, _sendHandle),
+ );
+ }
+
+ return client;
}
constructor(sendMessage: SendMessage) {
this.#sendMessage = sendMessage;
}
+ private handleMessage(message: unknown, _sendHandle: unknown) {
+ const isResponse = (msg: unknown): msg is Response =>
+ (msg as Response)?.type === responseType;
+
+ if (isResponse(message)) {
+ this.#handlers.get(message.id)?.(message);
+ }
+ }
+
/**
* Send a request to the parent process and wait for a response.
*/
@@ -82,17 +103,10 @@ export class BackstageIpcClient {
let timeout: NodeJS.Timeout | undefined = undefined;
- const messageHandler = (response: Response) => {
- if (response?.type !== responseType) {
- return;
- }
- if (response.id !== id) {
- return;
- }
-
+ const responseHandler: ResponseHandler = (response: Response) => {
clearTimeout(timeout);
timeout = undefined;
- process.removeListener('message', messageHandler);
+ this.#handlers.delete(id);
if ('error' in response) {
const error = new Error(response.error.message);
@@ -107,12 +121,11 @@ export class BackstageIpcClient {
timeout = setTimeout(() => {
reject(new Error(`IPC request '${method}' with ID ${id} timed out`));
- process.removeListener('message', messageHandler);
+ this.#handlers.delete(id);
}, IPC_TIMEOUT_MS);
timeout.unref();
- process.addListener('message', messageHandler as () => void);
-
+ this.#handlers.set(id, responseHandler);
this.#sendMessage(request, (e: Error) => {
if (e) {
reject(e);
diff --git a/packages/backend-dynamic-feature-service/CHANGELOG.md b/packages/backend-dynamic-feature-service/CHANGELOG.md
index 14111873a1..5828cebe32 100644
--- a/packages/backend-dynamic-feature-service/CHANGELOG.md
+++ b/packages/backend-dynamic-feature-service/CHANGELOG.md
@@ -1,5 +1,63 @@
# @backstage/backend-dynamic-feature-service
+## 0.3.0
+
+### Minor Changes
+
+- fc24d9e: Stop using `@backstage/backend-tasks` as it will be deleted in near future.
+
+### Patch Changes
+
+- 389f5a4: Update deprecated url-reader-related imports.
+- b63d378: Update internal imports
+- Updated dependencies
+ - @backstage/backend-defaults@0.4.2
+ - @backstage/backend-app-api@0.9.0
+ - @backstage/backend-plugin-api@0.8.0
+ - @backstage/backend-common@0.24.0
+ - @backstage/plugin-catalog-backend@1.25.0
+ - @backstage/plugin-search-backend-node@1.3.0
+ - @backstage/plugin-scaffolder-node@0.4.9
+ - @backstage/plugin-permission-common@0.8.1
+ - @backstage/config-loader@1.9.0
+ - @backstage/plugin-auth-node@0.5.0
+ - @backstage/plugin-permission-node@0.8.1
+ - @backstage/plugin-search-common@1.2.14
+ - @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
+ - @backstage/plugin-events-backend@0.3.10
+ - @backstage/plugin-events-node@0.3.9
+
+## 0.2.16-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.8.0-next.3
+ - @backstage/backend-common@0.23.4-next.3
+ - @backstage/backend-app-api@0.8.1-next.3
+ - @backstage/backend-tasks@0.5.28-next.3
+ - @backstage/cli-common@0.1.14
+ - @backstage/cli-node@0.2.7
+ - @backstage/config@1.2.0
+ - @backstage/config-loader@1.9.0-next.2
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+ - @backstage/plugin-app-node@0.1.23-next.3
+ - @backstage/plugin-auth-node@0.5.0-next.3
+ - @backstage/plugin-catalog-backend@1.24.1-next.3
+ - @backstage/plugin-events-backend@0.3.10-next.3
+ - @backstage/plugin-events-node@0.3.9-next.3
+ - @backstage/plugin-permission-common@0.8.1-next.1
+ - @backstage/plugin-permission-node@0.8.1-next.3
+ - @backstage/plugin-scaffolder-node@0.4.9-next.3
+ - @backstage/plugin-search-backend-node@1.2.28-next.3
+ - @backstage/plugin-search-common@1.2.14-next.1
+
## 0.2.16-next.2
### Patch Changes
diff --git a/packages/backend-dynamic-feature-service/api-report.md b/packages/backend-dynamic-feature-service/api-report.md
index 97dea60170..d7a4b8b75d 100644
--- a/packages/backend-dynamic-feature-service/api-report.md
+++ b/packages/backend-dynamic-feature-service/api-report.md
@@ -25,15 +25,15 @@ import { PermissionPolicy } from '@backstage/plugin-permission-node';
import { PluginCacheManager } from '@backstage/backend-common';
import { PluginDatabaseManager } from '@backstage/backend-common';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
-import { PluginTaskScheduler } from '@backstage/backend-tasks';
import { RootLoggerService } from '@backstage/backend-plugin-api';
import { Router } from 'express';
+import { SchedulerService } from '@backstage/backend-plugin-api';
+import { SchedulerServiceTaskRunner } 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';
import { TokenManager } from '@backstage/backend-common';
-import { UrlReader } from '@backstage/backend-common';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
// @public (undocumented)
export interface BackendDynamicPlugin extends BaseDynamicPlugin {
@@ -210,7 +210,7 @@ export interface LegacyBackendPluginInstaller {
// (undocumented)
search?(
indexBuilder: IndexBuilder,
- schedule: TaskRunner,
+ schedule: SchedulerServiceTaskRunner,
env: LegacyPluginEnvironment,
): void;
}
@@ -221,11 +221,11 @@ export type LegacyPluginEnvironment = {
cache: PluginCacheManager;
database: PluginDatabaseManager;
config: Config;
- reader: UrlReader;
+ reader: UrlReaderService;
discovery: PluginEndpointDiscovery;
tokenManager: TokenManager;
permissions: PermissionEvaluator;
- scheduler: PluginTaskScheduler;
+ scheduler: SchedulerService;
identity: IdentityApi;
eventBroker: EventBroker;
events: EventsService;
diff --git a/packages/backend-dynamic-feature-service/package.json b/packages/backend-dynamic-feature-service/package.json
index d6ac21a3ae..ac06fcd8d0 100644
--- a/packages/backend-dynamic-feature-service/package.json
+++ b/packages/backend-dynamic-feature-service/package.json
@@ -1,24 +1,29 @@
{
"name": "@backstage/backend-dynamic-feature-service",
+ "version": "0.3.0",
"description": "Backstage dynamic feature service",
- "version": "0.2.16-next.2",
- "main": "src/index.ts",
- "types": "src/index.ts",
+ "backstage": {
+ "role": "node-library"
+ },
"publishConfig": {
"access": "public"
},
+ "keywords": [
+ "backstage"
+ ],
+ "homepage": "https://backstage.io",
"repository": {
"type": "git",
"url": "https://github.com/backstage/backstage",
"directory": "packages/backend-dynamic-feature-service"
},
- "backstage": {
- "role": "node-library"
- },
+ "license": "Apache-2.0",
"exports": {
".": "./src/index.ts",
"./package.json": "./package.json"
},
+ "main": "src/index.ts",
+ "types": "src/index.ts",
"typesVersions": {
"*": {
"package.json": [
@@ -26,25 +31,24 @@
]
}
},
- "homepage": "https://backstage.io",
- "keywords": [
- "backstage"
+ "files": [
+ "dist",
+ "config.d.ts"
],
- "license": "Apache-2.0",
"scripts": {
"build": "backstage-cli package build",
+ "clean": "backstage-cli package clean",
"lint": "backstage-cli package lint",
- "test": "backstage-cli package test",
"prepack": "backstage-cli package prepack",
"postpack": "backstage-cli package postpack",
- "clean": "backstage-cli package clean",
- "start": "backstage-cli package start"
+ "start": "backstage-cli package start",
+ "test": "backstage-cli package test"
},
"dependencies": {
"@backstage/backend-app-api": "workspace:^",
"@backstage/backend-common": "workspace:^",
+ "@backstage/backend-defaults": "workspace:^",
"@backstage/backend-plugin-api": "workspace:^",
- "@backstage/backend-tasks": "workspace:^",
"@backstage/cli-common": "workspace:^",
"@backstage/cli-node": "workspace:^",
"@backstage/config": "workspace:^",
@@ -73,9 +77,5 @@
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"wait-for-expect": "^3.0.2"
- },
- "files": [
- "dist",
- "config.d.ts"
- ]
+ }
}
diff --git a/packages/backend-dynamic-feature-service/src/manager/plugin-manager.test.ts b/packages/backend-dynamic-feature-service/src/manager/plugin-manager.test.ts
index 8531624509..9c45cc53f6 100644
--- a/packages/backend-dynamic-feature-service/src/manager/plugin-manager.test.ts
+++ b/packages/backend-dynamic-feature-service/src/manager/plugin-manager.test.ts
@@ -37,15 +37,13 @@ import {
import { ScannedPluginManifest, ScannedPluginPackage } from '../scanner/types';
import { randomUUID } from 'crypto';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
-import {
- createSpecializedBackend,
- rootLifecycleServiceFactory,
-} from '@backstage/backend-app-api';
+import { createSpecializedBackend } from '@backstage/backend-app-api';
import { ConfigSources } from '@backstage/config-loader';
import { Logs, MockedLogger, LogContent } from '../__testUtils__/testUtils';
import { PluginScanner } from '../scanner/plugin-scanner';
import { findPaths } from '@backstage/cli-common';
import { createMockDirectory } from '@backstage/backend-test-utils';
+import { rootLifecycleServiceFactory } from '@backstage/backend-defaults/rootLifecycle';
describe('backend-dynamic-feature-service', () => {
const mockDir = createMockDirectory();
diff --git a/packages/backend-dynamic-feature-service/src/manager/types.ts b/packages/backend-dynamic-feature-service/src/manager/types.ts
index 60b2eb831e..a4f2937fd5 100644
--- a/packages/backend-dynamic-feature-service/src/manager/types.ts
+++ b/packages/backend-dynamic-feature-service/src/manager/types.ts
@@ -21,10 +21,8 @@ import {
PluginDatabaseManager,
PluginEndpointDiscovery,
TokenManager,
- UrlReader,
} from '@backstage/backend-common';
import { Router } from 'express';
-import { PluginTaskScheduler, TaskRunner } from '@backstage/backend-tasks';
import { IdentityApi } from '@backstage/plugin-auth-node';
import { PermissionEvaluator } from '@backstage/plugin-permission-common';
import {
@@ -33,7 +31,12 @@ import {
HttpPostIngressOptions,
} from '@backstage/plugin-events-node';
-import { BackendFeature } from '@backstage/backend-plugin-api';
+import {
+ BackendFeature,
+ UrlReaderService,
+ SchedulerService,
+ SchedulerServiceTaskRunner,
+} from '@backstage/backend-plugin-api';
import { PackagePlatform, PackageRole } from '@backstage/cli-node';
import { CatalogBuilder } from '@backstage/plugin-catalog-backend';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
@@ -58,11 +61,11 @@ export type LegacyPluginEnvironment = {
cache: PluginCacheManager;
database: PluginDatabaseManager;
config: Config;
- reader: UrlReader;
+ reader: UrlReaderService;
discovery: PluginEndpointDiscovery;
tokenManager: TokenManager;
permissions: PermissionEvaluator;
- scheduler: PluginTaskScheduler;
+ scheduler: SchedulerService;
identity: IdentityApi;
eventBroker: EventBroker;
events: EventsService;
@@ -161,7 +164,7 @@ export interface LegacyBackendPluginInstaller {
scaffolder?(env: LegacyPluginEnvironment): TemplateAction[];
search?(
indexBuilder: IndexBuilder,
- schedule: TaskRunner,
+ schedule: SchedulerServiceTaskRunner,
env: LegacyPluginEnvironment,
): void;
events?(
diff --git a/packages/backend-dynamic-feature-service/src/schemas/rootLoggerServiceFactory.ts b/packages/backend-dynamic-feature-service/src/schemas/rootLoggerServiceFactory.ts
index 6681a65a75..00d5c85e6e 100644
--- a/packages/backend-dynamic-feature-service/src/schemas/rootLoggerServiceFactory.ts
+++ b/packages/backend-dynamic-feature-service/src/schemas/rootLoggerServiceFactory.ts
@@ -18,9 +18,9 @@ import {
createServiceFactory,
coreServices,
} from '@backstage/backend-plugin-api';
-import { WinstonLogger } from '@backstage/backend-app-api';
+import { WinstonLogger } from '@backstage/backend-defaults/rootLogger';
import { transports, format } from 'winston';
-import { createConfigSecretEnumerator } from '@backstage/backend-app-api';
+import { createConfigSecretEnumerator } from '@backstage/backend-common';
import { loadConfigSchema } from '@backstage/config-loader';
import { getPackages } from '@manypkg/get-packages';
import { dynamicPluginsSchemasServiceRef } from './schemas';
diff --git a/packages/backend-legacy/CHANGELOG.md b/packages/backend-legacy/CHANGELOG.md
index a601890055..3b6a1af6f4 100644
--- a/packages/backend-legacy/CHANGELOG.md
+++ b/packages/backend-legacy/CHANGELOG.md
@@ -1,5 +1,88 @@
# example-backend-legacy
+## 0.2.101
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-defaults@0.4.2
+ - @backstage/backend-plugin-api@0.8.0
+ - @backstage/backend-common@0.24.0
+ - @backstage/plugin-catalog-backend@1.25.0
+ - @backstage/plugin-scaffolder-backend-module-confluence-to-markdown@0.2.24
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.40
+ - @backstage/plugin-search-backend-node@1.3.0
+ - @backstage/plugin-scaffolder-backend@1.24.0
+ - @backstage/plugin-techdocs-backend@1.10.10
+ - @backstage/plugin-permission-common@0.8.1
+ - @backstage/plugin-search-backend-module-techdocs@0.2.0
+ - @backstage/plugin-search-backend-module-explore@0.2.0
+ - @backstage/plugin-kubernetes-backend@0.18.4
+ - @backstage/plugin-permission-backend@0.5.47
+ - @backstage/plugin-devtools-backend@0.3.9
+ - @backstage/plugin-signals-backend@0.1.9
+ - @backstage/plugin-proxy-backend@0.5.4
+ - @backstage/plugin-auth-backend@0.22.10
+ - @backstage/plugin-app-backend@0.3.72
+ - @backstage/plugin-auth-node@0.5.0
+ - @backstage/plugin-permission-node@0.8.1
+ - @backstage/plugin-scaffolder-backend-module-gitlab@0.4.5
+ - @backstage/plugin-search-backend-module-catalog@0.2.0
+ - @backstage/plugin-search-backend@1.5.15
+ - @backstage/plugin-catalog-node@1.12.5
+ - @backstage/integration@1.14.0
+ - @backstage/plugin-search-backend-module-pg@0.5.33
+ - @backstage/catalog-model@1.6.0
+ - @backstage/catalog-client@1.6.6
+ - @backstage/config@1.2.0
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.21
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.4.10
+ - @backstage/plugin-events-backend@0.3.10
+ - @backstage/plugin-events-node@0.3.9
+ - @backstage/plugin-search-backend-module-elasticsearch@1.5.4
+ - @backstage/plugin-signals-node@0.1.9
+
+## 0.2.101-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-backend-module-gitlab@0.4.5-next.3
+ - @backstage/plugin-techdocs-backend@1.10.10-next.3
+ - @backstage/backend-common@0.23.4-next.3
+ - @backstage/catalog-model@1.6.0-next.0
+ - @backstage/plugin-scaffolder-backend@1.23.1-next.3
+ - @backstage/backend-tasks@0.5.28-next.3
+ - @backstage/catalog-client@1.6.6-next.0
+ - @backstage/config@1.2.0
+ - @backstage/integration@1.14.0-next.0
+ - @backstage/plugin-app-backend@0.3.72-next.3
+ - @backstage/plugin-auth-backend@0.22.10-next.3
+ - @backstage/plugin-auth-node@0.5.0-next.3
+ - @backstage/plugin-catalog-backend@1.24.1-next.3
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.21-next.3
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.4.10-next.3
+ - @backstage/plugin-catalog-node@1.12.5-next.3
+ - @backstage/plugin-devtools-backend@0.3.9-next.3
+ - @backstage/plugin-events-backend@0.3.10-next.3
+ - @backstage/plugin-events-node@0.3.9-next.3
+ - @backstage/plugin-kubernetes-backend@0.18.4-next.3
+ - @backstage/plugin-permission-backend@0.5.47-next.3
+ - @backstage/plugin-permission-common@0.8.1-next.1
+ - @backstage/plugin-permission-node@0.8.1-next.3
+ - @backstage/plugin-proxy-backend@0.5.4-next.3
+ - @backstage/plugin-scaffolder-backend-module-confluence-to-markdown@0.2.24-next.3
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.40-next.3
+ - @backstage/plugin-search-backend@1.5.15-next.3
+ - @backstage/plugin-search-backend-module-catalog@0.1.29-next.3
+ - @backstage/plugin-search-backend-module-elasticsearch@1.5.4-next.3
+ - @backstage/plugin-search-backend-module-explore@0.1.29-next.3
+ - @backstage/plugin-search-backend-module-pg@0.5.33-next.3
+ - @backstage/plugin-search-backend-module-techdocs@0.1.28-next.3
+ - @backstage/plugin-search-backend-node@1.2.28-next.3
+ - @backstage/plugin-signals-backend@0.1.9-next.3
+ - @backstage/plugin-signals-node@0.1.9-next.3
+
## 0.2.101-next.2
### Patch Changes
diff --git a/packages/backend-legacy/package.json b/packages/backend-legacy/package.json
index a650924720..0bdfa350e9 100644
--- a/packages/backend-legacy/package.json
+++ b/packages/backend-legacy/package.json
@@ -1,6 +1,6 @@
{
"name": "example-backend-legacy",
- "version": "0.2.101-next.2",
+ "version": "0.2.101",
"backstage": {
"role": "backend"
},
@@ -29,7 +29,8 @@
},
"dependencies": {
"@backstage/backend-common": "workspace:^",
- "@backstage/backend-tasks": "workspace:^",
+ "@backstage/backend-defaults": "workspace:^",
+ "@backstage/backend-plugin-api": "workspace:^",
"@backstage/catalog-client": "workspace:^",
"@backstage/catalog-model": "workspace:^",
"@backstage/config": "workspace:^",
diff --git a/packages/backend-legacy/src/index.ts b/packages/backend-legacy/src/index.ts
index 33520cba03..9a581e7d26 100644
--- a/packages/backend-legacy/src/index.ts
+++ b/packages/backend-legacy/src/index.ts
@@ -32,10 +32,8 @@ import {
loadBackendConfig,
notFoundHandler,
ServerTokenManager,
- UrlReaders,
useHotMemoize,
} from '@backstage/backend-common';
-import { TaskScheduler } from '@backstage/backend-tasks';
import { Config } from '@backstage/config';
import healthcheck from './plugins/healthcheck';
import { metricsHandler, metricsInit } from './metrics';
@@ -57,6 +55,8 @@ import { DefaultIdentityClient } from '@backstage/plugin-auth-node';
import { DefaultEventBroker } from '@backstage/plugin-events-backend';
import { DefaultEventsService } from '@backstage/plugin-events-node';
import { DefaultSignalsService } from '@backstage/plugin-signals-node';
+import { UrlReaders } from '@backstage/backend-defaults/urlReader';
+import { DefaultSchedulerService } from '@backstage/backend-defaults/scheduler';
function makeCreateEnv(config: Config) {
const root = getRootLogger();
@@ -69,7 +69,6 @@ function makeCreateEnv(config: Config) {
});
const databaseManager = DatabaseManager.fromConfig(config, { logger: root });
const cacheManager = CacheManager.fromConfig(config);
- const taskScheduler = TaskScheduler.fromConfig(config, { databaseManager });
const identity = DefaultIdentityClient.create({
discovery,
});
@@ -89,7 +88,10 @@ function makeCreateEnv(config: Config) {
const logger = root.child({ type: 'plugin', plugin });
const database = databaseManager.forPlugin(plugin);
const cache = cacheManager.forPlugin(plugin);
- const scheduler = taskScheduler.forPlugin(plugin);
+ const scheduler = DefaultSchedulerService.create({
+ logger,
+ database,
+ });
return {
logger,
diff --git a/packages/backend-legacy/src/types.ts b/packages/backend-legacy/src/types.ts
index a75b1620c4..3f5d163925 100644
--- a/packages/backend-legacy/src/types.ts
+++ b/packages/backend-legacy/src/types.ts
@@ -21,24 +21,26 @@ import {
PluginDatabaseManager,
PluginEndpointDiscovery,
TokenManager,
- UrlReader,
} from '@backstage/backend-common';
-import { PluginTaskScheduler } from '@backstage/backend-tasks';
import { IdentityApi } from '@backstage/plugin-auth-node';
import { PermissionEvaluator } from '@backstage/plugin-permission-common';
import { EventBroker, EventsService } from '@backstage/plugin-events-node';
import { SignalsService } from '@backstage/plugin-signals-node';
+import {
+ UrlReaderService,
+ SchedulerService,
+} from '@backstage/backend-plugin-api';
export type PluginEnvironment = {
logger: Logger;
cache: PluginCacheManager;
database: PluginDatabaseManager;
config: Config;
- reader: UrlReader;
+ reader: UrlReaderService;
discovery: PluginEndpointDiscovery;
tokenManager: TokenManager;
permissions: PermissionEvaluator;
- scheduler: PluginTaskScheduler;
+ scheduler: SchedulerService;
identity: IdentityApi;
/**
* @deprecated use `events` instead
diff --git a/packages/backend-openapi-utils/CHANGELOG.md b/packages/backend-openapi-utils/CHANGELOG.md
index 682036d984..0d58c6ad9c 100644
--- a/packages/backend-openapi-utils/CHANGELOG.md
+++ b/packages/backend-openapi-utils/CHANGELOG.md
@@ -1,5 +1,21 @@
# @backstage/backend-openapi-utils
+## 0.1.16
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.8.0
+ - @backstage/errors@1.2.4
+
+## 0.1.16-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.8.0-next.3
+ - @backstage/errors@1.2.4
+
## 0.1.16-next.2
### Patch Changes
diff --git a/packages/backend-openapi-utils/package.json b/packages/backend-openapi-utils/package.json
index 35db691c25..a64ef674a9 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.16-next.2",
+ "version": "0.1.16",
"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 d404d05b33..cb830feb33 100644
--- a/packages/backend-plugin-api/CHANGELOG.md
+++ b/packages/backend-plugin-api/CHANGELOG.md
@@ -1,5 +1,132 @@
# @backstage/backend-plugin-api
+## 0.8.0
+
+### Minor Changes
+
+- 389f5a4: **BREAKING** Deleted the following deprecated `UrlReader` exports
+
+ - ReadUrlOptions: Use `UrlReaderServiceReadUrlOptions` instead;
+ - ReadUrlResponse: Use `UrlReaderServiceReadUrlResponse` instead;
+ - ReadTreeOptions: Use `UrlReaderServiceReadTreeOptions` instead;
+ - ReadTreeResponse: Use `UrlReaderServiceReadTreeResponse` instead;
+ - ReadTreeResponseFile: Use `UrlReaderServiceReadTreeResponseFile` instead;
+ - ReadTreeResponseDirOptions: Use `UrlReaderServiceReadTreeResponseDirOptions` instead;
+ - SearchOptions: Use `UrlReaderServiceSearchOptions` instead;
+ - SearchResponse: Use `UrlReaderServiceSearchResponse` instead;
+ - SearchResponseFile: Use `UrlReaderServiceSearchResponseFile` instead.
+
+- 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;
+ },
+ }));
+
+ ...
+
+ ```
+
+- c99c620: **BREAKING** Removed the following deprecated types:
+
+ - `ServiceRefConfig` use `ServiceRefOptions`
+ - `RootServiceFactoryConfig` use `RootServiceFactoryOptions`
+ - `PluginServiceFactoryConfig` use `PluginServiceFactoryOptions`
+
+### 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');
+ }
+ },
+ });
+ ```
+
+- ddde5fe: Fixed a type issue where plugin and modules depending on multiton services would not receive the correct type.
+- f011d1b: fix typo in `getPluginRequestToken` comments
+- Updated dependencies
+ - @backstage/plugin-permission-common@0.8.1
+ - @backstage/plugin-auth-node@0.5.0
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+
+## 0.8.0-next.3
+
+### Patch Changes
+
+- ddde5fe: Fixed a type issue where plugin and modules depending on multiton services would not receive the correct type.
+- 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.5.0-next.3
+ - @backstage/plugin-permission-common@0.8.1-next.1
+
## 0.8.0-next.2
### Minor Changes
diff --git a/packages/backend-plugin-api/api-report.md b/packages/backend-plugin-api/api-report.md
index e5189dce4d..5ea07ead7a 100644
--- a/packages/backend-plugin-api/api-report.md
+++ b/packages/backend-plugin-api/api-report.md
@@ -82,14 +82,12 @@ export interface BackendModuleRegistrationPoints {
): void;
// (undocumented)
registerInit<
- Deps extends {
- [name in string]: unknown;
+ TDeps extends {
+ [name in string]: ServiceRef | ExtensionPoint;
},
>(options: {
- deps: {
- [name in keyof Deps]: ServiceRef | ExtensionPoint;
- };
- init(deps: Deps): Promise;
+ deps: TDeps;
+ init(deps: DepsToInstances): Promise;
}): void;
}
@@ -105,14 +103,12 @@ export interface BackendPluginRegistrationPoints {
): void;
// (undocumented)
registerInit<
- Deps extends {
- [name in string]: unknown;
+ TDeps extends {
+ [name in string]: ServiceRef;
},
>(options: {
- deps: {
- [name in keyof Deps]: ServiceRef;
- };
- init(deps: Deps): Promise;
+ deps: TDeps;
+ init(deps: DepsToInstances): Promise;
}): void;
}
@@ -515,17 +511,6 @@ export interface PluginMetadataService {
getId(): string;
}
-// @public @deprecated (undocumented)
-export type PluginServiceFactoryConfig<
- TService,
- TInstances extends 'singleton' | 'multiton',
- TContext,
- TImpl extends TService,
- TDeps extends {
- [name in string]: ServiceRef;
- },
-> = PluginServiceFactoryOptions;
-
// @public (undocumented)
export interface PluginServiceFactoryOptions<
TService,
@@ -557,25 +542,6 @@ export function readSchedulerServiceTaskScheduleDefinitionFromConfig(
config: Config,
): SchedulerServiceTaskScheduleDefinition;
-// @public @deprecated (undocumented)
-export type ReadTreeOptions = UrlReaderServiceReadTreeOptions;
-
-// @public @deprecated (undocumented)
-export type ReadTreeResponse = UrlReaderServiceReadTreeResponse;
-
-// @public @deprecated (undocumented)
-export type ReadTreeResponseDirOptions =
- UrlReaderServiceReadTreeResponseDirOptions;
-
-// @public @deprecated (undocumented)
-export type ReadTreeResponseFile = UrlReaderServiceReadTreeResponseFile;
-
-// @public @deprecated (undocumented)
-export type ReadUrlOptions = UrlReaderServiceReadUrlOptions;
-
-// @public @deprecated (undocumented)
-export type ReadUrlResponse = UrlReaderServiceReadUrlResponse;
-
// @public
export function resolvePackagePath(name: string, ...paths: string[]): string;
@@ -608,16 +574,6 @@ export interface RootLifecycleService extends LifecycleService {}
// @public
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;
-
// @public (undocumented)
export interface RootServiceFactoryOptions<
TService, // TODO(Rugvip): Can we forward the entire service ref type here instead of forwarding each type arg once the callback form is gone?
@@ -711,15 +667,6 @@ export interface SchedulerServiceTaskScheduleDefinitionConfig {
timeout: string | HumanDuration;
}
-// @public @deprecated (undocumented)
-export type SearchOptions = UrlReaderServiceSearchOptions;
-
-// @public @deprecated (undocumented)
-export type SearchResponse = UrlReaderServiceSearchResponse;
-
-// @public @deprecated (undocumented)
-export type SearchResponseFile = UrlReaderServiceSearchResponseFile;
-
// @public (undocumented)
export interface ServiceFactory<
TService = unknown,
@@ -759,13 +706,6 @@ export type ServiceRef<
$$type: '@backstage/ServiceRef';
};
-// @public @deprecated (undocumented)
-export type ServiceRefConfig<
- TService,
- TScope extends 'root' | 'plugin',
- TInstances extends 'singleton' | 'multiton',
-> = ServiceRefOptions;
-
// @public (undocumented)
export interface ServiceRefOptions<
TService,
diff --git a/packages/backend-plugin-api/package.json b/packages/backend-plugin-api/package.json
index 61f8b9353d..94793e1e49 100644
--- a/packages/backend-plugin-api/package.json
+++ b/packages/backend-plugin-api/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/backend-plugin-api",
- "version": "0.8.0-next.2",
+ "version": "0.8.0",
"description": "Core API used by Backstage backend plugins",
"backstage": {
"role": "node-library"
diff --git a/packages/backend-plugin-api/src/deprecated.ts b/packages/backend-plugin-api/src/deprecated.ts
deleted file mode 100644
index 0d02f9ed7e..0000000000
--- a/packages/backend-plugin-api/src/deprecated.ts
+++ /dev/null
@@ -1,55 +0,0 @@
-/*
- * 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 {
- ServiceRef,
- ServiceRefOptions,
- RootServiceFactoryOptions,
- PluginServiceFactoryOptions,
-} from './services';
-
-/**
- * @public
- * @deprecated Use {@link ServiceRefOptions} instead
- */
-export type ServiceRefConfig<
- TService,
- TScope extends 'root' | 'plugin',
- TInstances extends 'singleton' | 'multiton',
-> = ServiceRefOptions;
-
-/**
- * @public
- * @deprecated Use {@link RootServiceFactoryOptions} instead
- */
-export type RootServiceFactoryConfig<
- TService,
- TInstances extends 'singleton' | 'multiton',
- TImpl extends TService,
- TDeps extends { [name in string]: ServiceRef },
-> = RootServiceFactoryOptions;
-
-/**
- * @public
- * @deprecated Use {@link PluginServiceFactoryOptions} instead
- */
-export type PluginServiceFactoryConfig<
- TService,
- TInstances extends 'singleton' | 'multiton',
- TContext,
- TImpl extends TService,
- TDeps extends { [name in string]: ServiceRef },
-> = PluginServiceFactoryOptions;
diff --git a/packages/backend-plugin-api/src/index.ts b/packages/backend-plugin-api/src/index.ts
index eb554db25d..e6e57db1dc 100644
--- a/packages/backend-plugin-api/src/index.ts
+++ b/packages/backend-plugin-api/src/index.ts
@@ -24,4 +24,3 @@ export * from './services';
export type { BackendFeature, BackendFeatureCompat } from './types';
export * from './paths';
export * from './wiring';
-export * from './deprecated';
diff --git a/packages/backend-plugin-api/src/services/definitions/UrlReaderService.ts b/packages/backend-plugin-api/src/services/definitions/UrlReaderService.ts
index 25b787107e..9b327cfbf0 100644
--- a/packages/backend-plugin-api/src/services/definitions/UrlReaderService.ts
+++ b/packages/backend-plugin-api/src/services/definitions/UrlReaderService.ts
@@ -368,50 +368,3 @@ export type UrlReaderServiceSearchResponseFile = {
*/
lastModifiedAt?: Date;
};
-
-/**
- * @public
- * @deprecated Use `UrlReaderServiceReadTreeOptions` instead
- */
-export type ReadTreeOptions = UrlReaderServiceReadTreeOptions;
-/**
- * @public
- * @deprecated Use `UrlReaderServiceReadTreeResponse` instead
- */
-export type ReadTreeResponse = UrlReaderServiceReadTreeResponse;
-/**
- * @public
- * @deprecated Use `UrlReaderServiceReadTreeResponseDirOptions` instead
- */
-export type ReadTreeResponseDirOptions =
- UrlReaderServiceReadTreeResponseDirOptions;
-/**
- * @public
- * @deprecated Use `UrlReaderServiceReadTreeResponseFile` instead
- */
-export type ReadTreeResponseFile = UrlReaderServiceReadTreeResponseFile;
-/**
- * @public
- * @deprecated Use `UrlReaderServiceReadUrlResponse` instead
- */
-export type ReadUrlResponse = UrlReaderServiceReadUrlResponse;
-/**
- * @public
- * @deprecated Use `UrlReaderServiceReadUrlOptions` instead
- */
-export type ReadUrlOptions = UrlReaderServiceReadUrlOptions;
-/**
- * @public
- * @deprecated Use `UrlReaderServiceSearchOptions` instead
- */
-export type SearchOptions = UrlReaderServiceSearchOptions;
-/**
- * @public
- * @deprecated Use `UrlReaderServiceSearchResponse` instead
- */
-export type SearchResponse = UrlReaderServiceSearchResponse;
-/**
- * @public
- * @deprecated Use `UrlReaderServiceSearchResponseFile` instead
- */
-export type SearchResponseFile = UrlReaderServiceSearchResponseFile;
diff --git a/packages/backend-plugin-api/src/services/definitions/index.ts b/packages/backend-plugin-api/src/services/definitions/index.ts
index 5e30d444fd..194658dc0e 100644
--- a/packages/backend-plugin-api/src/services/definitions/index.ts
+++ b/packages/backend-plugin-api/src/services/definitions/index.ts
@@ -66,15 +66,6 @@ export type {
} from './SchedulerService';
export type { TokenManagerService } from './TokenManagerService';
export type {
- ReadTreeOptions,
- ReadTreeResponse,
- ReadTreeResponseDirOptions,
- ReadTreeResponseFile,
- ReadUrlResponse,
- ReadUrlOptions,
- SearchOptions,
- SearchResponse,
- SearchResponseFile,
UrlReaderServiceReadTreeOptions,
UrlReaderServiceReadTreeResponse,
UrlReaderServiceReadTreeResponseDirOptions,
diff --git a/packages/backend-plugin-api/src/wiring/createBackendModule.test.ts b/packages/backend-plugin-api/src/wiring/createBackendModule.test.ts
index e3c9f9007a..3426d5a90c 100644
--- a/packages/backend-plugin-api/src/wiring/createBackendModule.test.ts
+++ b/packages/backend-plugin-api/src/wiring/createBackendModule.test.ts
@@ -14,7 +14,9 @@
* limitations under the License.
*/
+import { createServiceRef } from '../services';
import { createBackendModule } from './createBackendModule';
+import { createExtensionPoint } from './createExtensionPoint';
import { InternalBackendRegistrations } from './types';
describe('createBackendModule', () => {
@@ -54,4 +56,35 @@ describe('createBackendModule', () => {
// @ts-expect-error
expect(module({ a: 'a' })).toBeDefined();
});
+
+ it('should be able to depend on all types of dependencies', () => {
+ const extensionPoint = createExtensionPoint({ id: 'point' });
+ const singleServiceRef = createServiceRef({ id: 'single' });
+ const multiServiceRef = createServiceRef({
+ id: 'multi',
+ multiton: true,
+ });
+
+ const plugin = createBackendModule({
+ pluginId: 'x',
+ moduleId: 'y',
+ register(r) {
+ r.registerInit({
+ deps: {
+ point: extensionPoint,
+ single: singleServiceRef,
+ multi: multiServiceRef,
+ },
+ async init({ point, single, multi }) {
+ const a: string = point;
+ const b: string = single;
+ const c: string[] = multi;
+ expect([a, b, c]).toBe('unused');
+ },
+ });
+ },
+ });
+
+ expect(plugin.$$type).toEqual('@backstage/BackendFeature');
+ });
});
diff --git a/packages/backend-plugin-api/src/wiring/createBackendPlugin.test.ts b/packages/backend-plugin-api/src/wiring/createBackendPlugin.test.ts
index db4d60ee19..f4a0877b85 100644
--- a/packages/backend-plugin-api/src/wiring/createBackendPlugin.test.ts
+++ b/packages/backend-plugin-api/src/wiring/createBackendPlugin.test.ts
@@ -14,7 +14,9 @@
* limitations under the License.
*/
+import { createServiceRef } from '../services';
import { createBackendPlugin } from './createBackendPlugin';
+import { createExtensionPoint } from './createExtensionPoint';
import { InternalBackendRegistrations } from './types';
describe('createBackendPlugin', () => {
@@ -52,4 +54,50 @@ describe('createBackendPlugin', () => {
// @ts-expect-error
expect(plugin({ a: 'a' })).toBeDefined();
});
+
+ it('should be able to depend on all compatible dependencies', () => {
+ const singleServiceRef = createServiceRef({ id: 'single' });
+ const multiServiceRef = createServiceRef({
+ id: 'multi',
+ multiton: true,
+ });
+
+ const plugin = createBackendPlugin({
+ pluginId: 'x',
+ register(r) {
+ r.registerInit({
+ deps: {
+ single: singleServiceRef,
+ multi: multiServiceRef,
+ },
+ async init({ single, multi }) {
+ const a: string = single;
+ const b: string[] = multi;
+ expect([a, b]).toBe('unused');
+ },
+ });
+ },
+ });
+
+ expect(plugin.$$type).toEqual('@backstage/BackendFeature');
+ });
+
+ it('should not be able to depend on extension points', () => {
+ const extensionPoint = createExtensionPoint({ id: 'point' });
+
+ const plugin = createBackendPlugin({
+ pluginId: 'x',
+ register(r) {
+ r.registerInit({
+ deps: {
+ // @ts-expect-error
+ point: extensionPoint,
+ },
+ async init() {},
+ });
+ },
+ });
+
+ expect(plugin.$$type).toEqual('@backstage/BackendFeature');
+ });
});
diff --git a/packages/backend-plugin-api/src/wiring/types.ts b/packages/backend-plugin-api/src/wiring/types.ts
index 01ab8c2e3e..1e8c3910a3 100644
--- a/packages/backend-plugin-api/src/wiring/types.ts
+++ b/packages/backend-plugin-api/src/wiring/types.ts
@@ -36,6 +36,17 @@ export type ExtensionPoint = {
$$type: '@backstage/ExtensionPoint';
};
+/** @ignore */
+type DepsToInstances<
+ TDeps extends {
+ [key in string]: ServiceRef | ExtensionPoint;
+ },
+> = {
+ [key in keyof TDeps]: TDeps[key] extends ServiceRef
+ ? Array
+ : TDeps[key]['T'];
+};
+
/**
* The callbacks passed to the `register` method of a backend plugin.
*
@@ -46,11 +57,13 @@ export interface BackendPluginRegistrationPoints {
ref: ExtensionPoint,
impl: TExtensionPoint,
): void;
- registerInit(options: {
- deps: {
- [name in keyof Deps]: ServiceRef;
- };
- init(deps: Deps): Promise;
+ registerInit<
+ TDeps extends {
+ [name in string]: ServiceRef;
+ },
+ >(options: {
+ deps: TDeps;
+ init(deps: DepsToInstances): Promise;
}): void;
}
@@ -64,11 +77,13 @@ export interface BackendModuleRegistrationPoints {
ref: ExtensionPoint,
impl: TExtensionPoint,
): void;
- registerInit(options: {
- deps: {
- [name in keyof Deps]: ServiceRef | ExtensionPoint;
- };
- init(deps: Deps): Promise;
+ registerInit<
+ TDeps extends {
+ [name in string]: ServiceRef | ExtensionPoint;
+ },
+ >(options: {
+ deps: TDeps;
+ init(deps: DepsToInstances): Promise;
}): void;
}
diff --git a/packages/backend-tasks/CHANGELOG.md b/packages/backend-tasks/CHANGELOG.md
index 1a5879f14e..fbdbff1a8a 100644
--- a/packages/backend-tasks/CHANGELOG.md
+++ b/packages/backend-tasks/CHANGELOG.md
@@ -1,5 +1,43 @@
# @backstage/backend-tasks
+## 0.6.0
+
+### Minor Changes
+
+- fc24d9e: This package is deprecated and will be removed in a near future, follow the instructions below to stop using it:
+
+ - `TaskScheduler`: Please migrate to the new backend system, and depend on `coreServices.scheduler` from `@backstage/backend-plugin-api` instead, or use `DefaultSchedulerService` from `@backstage/backend-defaults;
+ - `TaskRunner`: Please import `SchedulerServiceTaskRunner` from `@backstage/backend-plugin-api` instead;
+ - `TaskFunction`: Please import `SchedulerServiceTaskFunction` from `@backstage/backend-plugin-api` instead;
+ - `TaskDescriptor`: Please import `SchedulerServiceTaskDescriptor` from `@backstage/backend-plugin-api` instead;
+ - `TaskInvocationDefinition`: Please import `SchedulerServiceTaskInvocationDefinition` from `@backstage/backend-plugin-api` instead;
+ - `TaskScheduleDefinition`: Please import `SchedulerServiceTaskFunction` from `@backstage/backend-plugin-api` instead;
+ - `TaskScheduleDefinitionConfig`: Please import `SchedulerServiceTaskScheduleDefinitionConfig` from `@backstage/backend-plugin-api` instead;
+ - `PluginTaskScheduler`: Please use `SchedulerService` from `@backstage/backend-plugin-api` instead (most likely via `coreServices.scheduler`);
+ - `readTaskScheduleDefinitionFromConfig`: Please import `readSchedulerServiceTaskScheduleDefinitionFromConfig` from `@backstage/backend-plugin-api` instead;
+ - `HumanDuration`: Import `TypesHumanDuration` from `@backstage/types` instead.
+
+### Patch Changes
+
+- ba9abf4: The `PluginTaskScheduler` now allows tasks with `frequency: { trigger: 'manual' }`. This means that the task will not be scheduled, but rather run only when manually triggered with `PluginTaskScheduler.triggerTask`.
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.8.0
+ - @backstage/backend-common@0.24.0
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+
+## 0.5.28-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.8.0-next.3
+ - @backstage/backend-common@0.23.4-next.3
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+
## 0.5.28-next.2
### Patch Changes
diff --git a/packages/backend-tasks/README.md b/packages/backend-tasks/README.md
index 57cd63b0e0..bdb151dea6 100644
--- a/packages/backend-tasks/README.md
+++ b/packages/backend-tasks/README.md
@@ -1,9 +1,16 @@
# @backstage/backend-tasks
+> [!CAUTION]
+> This package is deprecated and will be removed in a near future.
+
Common distributed task management for Backstage backends.
## Usage
+> [!CAUTION]
+> Please note that the documentation below is only valid for versions equal to or below `0.5.28-next.3`.
+> As this package will be deleted soon, we recommend that you migrate to the new backend system, and depend on `coreServices.scheduler` from `@backstage/backend-plugin-api` instead, or use `DefaultSchedulerService` from `@backstage/backend-defaults`. Here are the [backend](https://backstage.io/docs/backend-system/building-backends/migrating) and [plugin](https://backstage.io/docs/backend-system/building-plugins-and-modules/migrating) migration guides.
+
Add the library to your backend package:
```bash
@@ -27,12 +34,3 @@ await scheduler.scheduleTask({
},
});
```
-
-## Local Development
-
-When working with the `@backstage/backend-tasks` library you may run into your task not running immediately at startup as expected if you are using a persistent database. This is by design - the library respects the previous state and does not run the task sooner than the specified frequency. If you want to get around this, there is a table called `backstage_backend_tasks__tasks` in the applicable plugin's database which will contain a record with the next run date and time. You can delete this record to get things back to what you expect.
-
-## Documentation
-
-- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
-- [Backstage Documentation](https://backstage.io/docs)
diff --git a/packages/backend-tasks/package.json b/packages/backend-tasks/package.json
index 3f482b38e6..f0209c1fa9 100644
--- a/packages/backend-tasks/package.json
+++ b/packages/backend-tasks/package.json
@@ -1,35 +1,39 @@
{
"name": "@backstage/backend-tasks",
+ "version": "0.6.0",
"description": "Common distributed task management library for Backstage backends",
- "version": "0.5.28-next.2",
- "main": "src/index.ts",
- "types": "src/index.ts",
+ "backstage": {
+ "role": "node-library"
+ },
"publishConfig": {
"access": "public",
"main": "dist/index.cjs.js",
"types": "dist/index.d.ts"
},
- "backstage": {
- "role": "node-library"
- },
+ "keywords": [
+ "backstage"
+ ],
"homepage": "https://backstage.io",
"repository": {
"type": "git",
"url": "https://github.com/backstage/backstage",
"directory": "packages/backend-tasks"
},
- "keywords": [
- "backstage"
- ],
"license": "Apache-2.0",
+ "main": "src/index.ts",
+ "types": "src/index.ts",
+ "files": [
+ "dist",
+ "migrations/**/*.{js,d.ts}"
+ ],
"scripts": {
"build": "backstage-cli package build",
+ "clean": "backstage-cli package clean",
"lint": "backstage-cli package lint",
- "test": "backstage-cli package test",
"prepack": "backstage-cli package prepack",
"postpack": "backstage-cli package postpack",
- "clean": "backstage-cli package clean",
- "start": "backstage-cli package start"
+ "start": "backstage-cli package start",
+ "test": "backstage-cli package test"
},
"dependencies": {
"@backstage/backend-common": "workspace:^",
@@ -50,9 +54,5 @@
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"wait-for-expect": "^3.0.2"
- },
- "files": [
- "dist",
- "migrations/**/*.{js,d.ts}"
- ]
+ }
}
diff --git a/packages/backend-tasks/src/index.ts b/packages/backend-tasks/src/index.ts
index 0aae81b143..83c7606700 100644
--- a/packages/backend-tasks/src/index.ts
+++ b/packages/backend-tasks/src/index.ts
@@ -17,6 +17,10 @@
/**
* Common distributed task management library for Backstage backends
*
+ * @remarks
+ * This package is deprecated and will be removed in a near future.
+ * Please migrate to the new backend system, and depend on `coreServices.scheduler` from `@backstage/backend-plugin-api` instead, or use `DefaultSchedulerService` from `@backstage/backend-defaults`.
+ *
* @packageDocumentation
*/
diff --git a/packages/backend-test-utils/CHANGELOG.md b/packages/backend-test-utils/CHANGELOG.md
index cbca6bdcab..59542fb241 100644
--- a/packages/backend-test-utils/CHANGELOG.md
+++ b/packages/backend-test-utils/CHANGELOG.md
@@ -1,5 +1,48 @@
# @backstage/backend-test-utils
+## 0.5.0
+
+### Minor Changes
+
+- 861f162: **BREAKING**: Removed these deprecated helpers:
+
+ - `setupRequestMockHandlers` Use `CreateMockDirectoryOptions` instead.
+ - `CreateMockDirectoryOptions` Use `registerMswTestHooks` instead.
+
+ Stopped exporting the deprecated and internal `isDockerDisabledForTests` helper.
+
+ Removed `get` method from `ServiceFactoryTester` which is replaced by `getSubject`
+
+### Patch Changes
+
+- 8b13183: Internal updates to support latest version of `BackendFeauture`s from `@backstage/backend-plugin-api`.
+- b63d378: Update internal imports
+- 7c5f3b0: Update the `ServiceFactoryTester` to be able to test services that enables multi implementation installation.
+- 4e79d19: The default services for `startTestBackend` and `ServiceFactoryTester` now includes the Root Health Service.
+- Updated dependencies
+ - @backstage/backend-defaults@0.4.2
+ - @backstage/backend-app-api@0.9.0
+ - @backstage/backend-plugin-api@0.8.0
+ - @backstage/plugin-auth-node@0.5.0
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+ - @backstage/plugin-events-node@0.3.9
+
+## 0.4.5-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.8.0-next.3
+ - @backstage/backend-defaults@0.4.2-next.3
+ - @backstage/backend-app-api@0.8.1-next.3
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.5.0-next.3
+ - @backstage/plugin-events-node@0.3.9-next.3
+
## 0.4.5-next.2
### Patch Changes
diff --git a/packages/backend-test-utils/api-report.md b/packages/backend-test-utils/api-report.md
index 584fedb1f5..f2a925c0ff 100644
--- a/packages/backend-test-utils/api-report.md
+++ b/packages/backend-test-utils/api-report.md
@@ -19,7 +19,7 @@ import { CacheService } from '@backstage/backend-plugin-api';
import { DatabaseService } from '@backstage/backend-plugin-api';
import { DiscoveryService } from '@backstage/backend-plugin-api';
import { EventsService } from '@backstage/plugin-events-node';
-import { ExtendedHttpServer } from '@backstage/backend-app-api';
+import { ExtendedHttpServer } from '@backstage/backend-defaults/rootHttpRouter';
import { ExtensionPoint } from '@backstage/backend-plugin-api';
import { HttpAuthService } from '@backstage/backend-plugin-api';
import { HttpRouterService } from '@backstage/backend-plugin-api';
@@ -55,9 +55,6 @@ export interface CreateMockDirectoryOptions {
mockOsTmpDir?: boolean;
}
-// @public @deprecated (undocumented)
-export function isDockerDisabledForTests(): boolean;
-
// @public (undocumented)
export namespace mockCredentials {
export function limitedUser(
@@ -143,9 +140,6 @@ export interface MockDirectoryContentOptions {
shouldReadAsText?: boolean | ((path: string, buffer: Buffer) => boolean);
}
-// @public @deprecated (undocumented)
-export type MockDirectoryOptions = CreateMockDirectoryOptions;
-
// @public (undocumented)
export namespace mockServices {
// (undocumented)
@@ -475,10 +469,6 @@ export class ServiceFactoryTester<
subject: ServiceFactory,
options?: ServiceFactoryTesterOptions,
): ServiceFactoryTester;
- // @deprecated
- get(
- ...args: 'root' extends TScope ? [] : [pluginId?: string]
- ): Promise;
getService<
TGetService,
TGetScope extends 'root' | 'plugin',
@@ -508,13 +498,6 @@ export type ServiceMock = {
: TService[Key];
};
-// @public @deprecated (undocumented)
-export function setupRequestMockHandlers(worker: {
- listen: (t: any) => void;
- close: () => void;
- resetHandlers: () => void;
-}): void;
-
// @public (undocumented)
export function startTestBackend(
options: TestBackendOptions,
diff --git a/packages/backend-test-utils/package.json b/packages/backend-test-utils/package.json
index 44373e733f..682ec3067e 100644
--- a/packages/backend-test-utils/package.json
+++ b/packages/backend-test-utils/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/backend-test-utils",
- "version": "0.4.5-next.2",
+ "version": "0.5.0",
"description": "Test helpers library for Backstage backends",
"backstage": {
"role": "node-library"
diff --git a/packages/backend-test-utils/src/deprecated.ts b/packages/backend-test-utils/src/deprecated.ts
deleted file mode 100644
index 9790580a9c..0000000000
--- a/packages/backend-test-utils/src/deprecated.ts
+++ /dev/null
@@ -1,45 +0,0 @@
-/*
- * 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 { registerMswTestHooks } from './msw';
-import { CreateMockDirectoryOptions } from './filesystem';
-import { isDockerDisabledForTests as _isDockerDisabledForTests } from './util';
-
-/**
- * @public
- * @deprecated Use `CreateMockDirectoryOptions` from `@backstage/backend-test-utils` instead.
- */
-export type MockDirectoryOptions = CreateMockDirectoryOptions;
-
-/**
- * @public
- * @deprecated Use `registerMswTestHooks` from `@backstage/backend-test-utils` instead.
- */
-export function setupRequestMockHandlers(worker: {
- listen: (t: any) => void;
- close: () => void;
- resetHandlers: () => void;
-}): void {
- registerMswTestHooks(worker);
-}
-
-/**
- * @public
- * @deprecated This is an internal function and will no longer be exported from this package.
- */
-export function isDockerDisabledForTests(): boolean {
- return _isDockerDisabledForTests();
-}
diff --git a/packages/backend-test-utils/src/index.ts b/packages/backend-test-utils/src/index.ts
index 4124a861f4..d1d80bf387 100644
--- a/packages/backend-test-utils/src/index.ts
+++ b/packages/backend-test-utils/src/index.ts
@@ -20,7 +20,6 @@
* @packageDocumentation
*/
-export * from './deprecated';
export * from './cache';
export * from './database';
export * from './msw';
diff --git a/packages/backend-test-utils/src/next/wiring/ServiceFactoryTester.ts b/packages/backend-test-utils/src/next/wiring/ServiceFactoryTester.ts
index e8530f89bf..83a6a42307 100644
--- a/packages/backend-test-utils/src/next/wiring/ServiceFactoryTester.ts
+++ b/packages/backend-test-utils/src/next/wiring/ServiceFactoryTester.ts
@@ -82,17 +82,6 @@ export class ServiceFactoryTester<
this.#registry = registry;
}
- /**
- * Returns the service instance for the subject.
- *
- * @deprecated Use `getSubject` instead.
- */
- async get(
- ...args: 'root' extends TScope ? [] : [pluginId?: string]
- ): Promise {
- return this.getSubject(...args);
- }
-
/**
* Returns the service instance for the subject.
*
diff --git a/packages/backend-test-utils/src/next/wiring/TestBackend.ts b/packages/backend-test-utils/src/next/wiring/TestBackend.ts
index cf98c25e4a..6b4110d4de 100644
--- a/packages/backend-test-utils/src/next/wiring/TestBackend.ts
+++ b/packages/backend-test-utils/src/next/wiring/TestBackend.ts
@@ -14,15 +14,7 @@
* limitations under the License.
*/
-import {
- Backend,
- createSpecializedBackend,
- MiddlewareFactory,
- createHttpServer,
- ExtendedHttpServer,
- HostDiscovery,
- DefaultRootHttpRouter,
-} from '@backstage/backend-app-api';
+import { Backend, createSpecializedBackend } from '@backstage/backend-app-api';
import {
createServiceFactory,
BackendFeature,
@@ -40,7 +32,14 @@ import {
InternalBackendFeature,
InternalBackendRegistrations,
} from '@backstage/backend-plugin-api/src/wiring/types';
-import { createHealthRouter } from '@backstage/backend-defaults/rootHttpRouter';
+import {
+ DefaultRootHttpRouter,
+ ExtendedHttpServer,
+ MiddlewareFactory,
+ createHealthRouter,
+ createHttpServer,
+} from '@backstage/backend-defaults/rootHttpRouter';
+import { HostDiscovery } from '@backstage/backend-defaults/discovery';
/** @public */
export interface TestBackendOptions {
diff --git a/packages/backend/CHANGELOG.md b/packages/backend/CHANGELOG.md
index 8fbce11752..8c856f53ca 100644
--- a/packages/backend/CHANGELOG.md
+++ b/packages/backend/CHANGELOG.md
@@ -1,5 +1,78 @@
# example-backend
+## 0.0.29
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-defaults@0.4.2
+ - @backstage/plugin-scaffolder-backend-module-github@0.4.1
+ - @backstage/plugin-auth-backend-module-github-provider@0.1.20
+ - @backstage/backend-plugin-api@0.8.0
+ - @backstage/plugin-catalog-backend@1.25.0
+ - @backstage/plugin-catalog-backend-module-openapi@0.1.41
+ - @backstage/plugin-search-backend-node@1.3.0
+ - @backstage/plugin-scaffolder-backend@1.24.0
+ - @backstage/plugin-techdocs-backend@1.10.10
+ - @backstage/plugin-permission-common@0.8.1
+ - @backstage/plugin-search-backend-module-techdocs@0.2.0
+ - @backstage/plugin-search-backend-module-explore@0.2.0
+ - @backstage/plugin-notifications-backend@0.3.4
+ - @backstage/plugin-kubernetes-backend@0.18.4
+ - @backstage/plugin-permission-backend@0.5.47
+ - @backstage/plugin-devtools-backend@0.3.9
+ - @backstage/plugin-signals-backend@0.1.9
+ - @backstage/plugin-proxy-backend@0.5.4
+ - @backstage/plugin-auth-backend@0.22.10
+ - @backstage/plugin-app-backend@0.3.72
+ - @backstage/plugin-auth-node@0.5.0
+ - @backstage/plugin-permission-node@0.8.1
+ - @backstage/plugin-catalog-backend-module-backstage-openapi@0.3.0
+ - @backstage/plugin-search-backend-module-catalog@0.2.0
+ - @backstage/plugin-search-backend@1.5.15
+ - @backstage/catalog-model@1.6.0
+ - @backstage/plugin-auth-backend-module-guest-provider@0.1.9
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.21
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.4.10
+ - @backstage/plugin-permission-backend-module-allow-all-policy@0.1.20
+
+## 0.0.29-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-backend-module-github@0.4.1-next.3
+ - @backstage/plugin-notifications-backend@0.3.4-next.3
+ - @backstage/backend-plugin-api@0.8.0-next.3
+ - @backstage/plugin-techdocs-backend@1.10.10-next.3
+ - @backstage/backend-defaults@0.4.2-next.3
+ - @backstage/catalog-model@1.6.0-next.0
+ - @backstage/plugin-scaffolder-backend@1.23.1-next.3
+ - @backstage/backend-tasks@0.5.28-next.3
+ - @backstage/plugin-app-backend@0.3.72-next.3
+ - @backstage/plugin-auth-backend@0.22.10-next.3
+ - @backstage/plugin-auth-backend-module-github-provider@0.1.20-next.3
+ - @backstage/plugin-auth-backend-module-guest-provider@0.1.9-next.3
+ - @backstage/plugin-auth-node@0.5.0-next.3
+ - @backstage/plugin-catalog-backend@1.24.1-next.3
+ - @backstage/plugin-catalog-backend-module-backstage-openapi@0.2.6-next.3
+ - @backstage/plugin-catalog-backend-module-openapi@0.1.41-next.3
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.21-next.3
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.4.10-next.3
+ - @backstage/plugin-devtools-backend@0.3.9-next.3
+ - @backstage/plugin-kubernetes-backend@0.18.4-next.3
+ - @backstage/plugin-permission-backend@0.5.47-next.3
+ - @backstage/plugin-permission-backend-module-allow-all-policy@0.1.20-next.3
+ - @backstage/plugin-permission-common@0.8.1-next.1
+ - @backstage/plugin-permission-node@0.8.1-next.3
+ - @backstage/plugin-proxy-backend@0.5.4-next.3
+ - @backstage/plugin-search-backend@1.5.15-next.3
+ - @backstage/plugin-search-backend-module-catalog@0.1.29-next.3
+ - @backstage/plugin-search-backend-module-explore@0.1.29-next.3
+ - @backstage/plugin-search-backend-module-techdocs@0.1.28-next.3
+ - @backstage/plugin-search-backend-node@1.2.28-next.3
+ - @backstage/plugin-signals-backend@0.1.9-next.3
+
## 0.0.29-next.2
### Patch Changes
diff --git a/packages/backend/package.json b/packages/backend/package.json
index cafe89a527..570a545741 100644
--- a/packages/backend/package.json
+++ b/packages/backend/package.json
@@ -1,6 +1,6 @@
{
"name": "example-backend",
- "version": "0.0.29-next.2",
+ "version": "0.0.29",
"main": "dist/index.cjs.js",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -29,7 +29,6 @@
"dependencies": {
"@backstage/backend-defaults": "workspace:^",
"@backstage/backend-plugin-api": "workspace:^",
- "@backstage/backend-tasks": "workspace:^",
"@backstage/catalog-model": "workspace:^",
"@backstage/plugin-app-backend": "workspace:^",
"@backstage/plugin-auth-backend": "workspace:^",
diff --git a/packages/catalog-client/CHANGELOG.md b/packages/catalog-client/CHANGELOG.md
index da7b16dce1..9ed8a50b91 100644
--- a/packages/catalog-client/CHANGELOG.md
+++ b/packages/catalog-client/CHANGELOG.md
@@ -1,5 +1,21 @@
# @backstage/catalog-client
+## 1.6.6
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/catalog-model@1.6.0
+ - @backstage/errors@1.2.4
+
+## 1.6.6-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/catalog-model@1.6.0-next.0
+ - @backstage/errors@1.2.4
+
## 1.6.5
### Patch Changes
diff --git a/packages/catalog-client/package.json b/packages/catalog-client/package.json
index c9e7f25723..29c1d3049c 100644
--- a/packages/catalog-client/package.json
+++ b/packages/catalog-client/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/catalog-client",
- "version": "1.6.5",
+ "version": "1.6.6",
"description": "An isomorphic client for the catalog backend",
"backstage": {
"role": "common-library"
diff --git a/packages/catalog-model/CHANGELOG.md b/packages/catalog-model/CHANGELOG.md
index f47465a03e..1242c48f31 100644
--- a/packages/catalog-model/CHANGELOG.md
+++ b/packages/catalog-model/CHANGELOG.md
@@ -1,5 +1,29 @@
# @backstage/catalog-model
+## 1.6.0
+
+### Minor Changes
+
+- 34fa803: Introduce an optional spec.type attribute on the Domain and System entity kinds
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+
+## 1.6.0-next.0
+
+### Minor Changes
+
+- 34fa803: Introduce an optional spec.type attribute on the Domain and System entity kinds
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+
## 1.5.0
### Minor Changes
diff --git a/packages/catalog-model/api-report.md b/packages/catalog-model/api-report.md
index 2d91fa44a5..de941e2502 100644
--- a/packages/catalog-model/api-report.md
+++ b/packages/catalog-model/api-report.md
@@ -123,6 +123,7 @@ interface DomainEntityV1alpha1 extends Entity {
spec: {
owner: string;
subdomainOf?: string;
+ type?: string;
};
}
export { DomainEntityV1alpha1 as DomainEntity };
@@ -454,6 +455,7 @@ interface SystemEntityV1alpha1 extends Entity {
spec: {
owner: string;
domain?: string;
+ type?: string;
};
}
export { SystemEntityV1alpha1 as SystemEntity };
diff --git a/packages/catalog-model/examples/domains/artists-domain.yaml b/packages/catalog-model/examples/domains/artists-domain.yaml
index 598f8500aa..02370d9a14 100644
--- a/packages/catalog-model/examples/domains/artists-domain.yaml
+++ b/packages/catalog-model/examples/domains/artists-domain.yaml
@@ -13,3 +13,4 @@ metadata:
spec:
owner: team-a
subdomainOf: audio
+ type: product-group
diff --git a/packages/catalog-model/examples/domains/playback-domain.yaml b/packages/catalog-model/examples/domains/playback-domain.yaml
index 58b5afe56e..e058ebf0a2 100644
--- a/packages/catalog-model/examples/domains/playback-domain.yaml
+++ b/packages/catalog-model/examples/domains/playback-domain.yaml
@@ -6,3 +6,4 @@ metadata:
spec:
owner: user:frank.tiernan
subdomainOf: audio
+ type: product-group
diff --git a/packages/catalog-model/examples/systems/artist-engagement-portal-system.yaml b/packages/catalog-model/examples/systems/artist-engagement-portal-system.yaml
index 8de3c00880..17fe21ba69 100644
--- a/packages/catalog-model/examples/systems/artist-engagement-portal-system.yaml
+++ b/packages/catalog-model/examples/systems/artist-engagement-portal-system.yaml
@@ -8,3 +8,4 @@ metadata:
spec:
owner: team-a
domain: artists
+ type: service
diff --git a/packages/catalog-model/examples/systems/audio-playback-system.yaml b/packages/catalog-model/examples/systems/audio-playback-system.yaml
index 7430ae2ff5..f1edb7f17d 100644
--- a/packages/catalog-model/examples/systems/audio-playback-system.yaml
+++ b/packages/catalog-model/examples/systems/audio-playback-system.yaml
@@ -6,3 +6,4 @@ metadata:
spec:
owner: team-c
domain: playback
+ type: feature-set
diff --git a/packages/catalog-model/examples/systems/podcast-system.yaml b/packages/catalog-model/examples/systems/podcast-system.yaml
index 47a2f7ac9f..77f53925c1 100644
--- a/packages/catalog-model/examples/systems/podcast-system.yaml
+++ b/packages/catalog-model/examples/systems/podcast-system.yaml
@@ -6,3 +6,4 @@ metadata:
spec:
owner: team-b
domain: playback
+ type: feature-set
diff --git a/packages/catalog-model/package.json b/packages/catalog-model/package.json
index 5a60531cb2..150317aee1 100644
--- a/packages/catalog-model/package.json
+++ b/packages/catalog-model/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/catalog-model",
- "version": "1.5.0",
+ "version": "1.6.0",
"description": "Types and validators that help describe the model of a Backstage Catalog",
"backstage": {
"role": "common-library"
diff --git a/packages/catalog-model/src/kinds/DomainEntityV1alpha1.test.ts b/packages/catalog-model/src/kinds/DomainEntityV1alpha1.test.ts
index 3c1e7f0a6d..61408b7e80 100644
--- a/packages/catalog-model/src/kinds/DomainEntityV1alpha1.test.ts
+++ b/packages/catalog-model/src/kinds/DomainEntityV1alpha1.test.ts
@@ -32,6 +32,7 @@ describe('DomainV1alpha1Validator', () => {
spec: {
owner: 'me',
subdomainOf: 'parent-domain',
+ type: 'domain-type',
},
};
});
@@ -84,4 +85,19 @@ describe('DomainV1alpha1Validator', () => {
(entity as any).spec.subdomainOf = '';
await expect(validator.check(entity)).rejects.toThrow(/subdomainOf/);
});
+
+ it('accepts missing type', async () => {
+ delete (entity as any).spec.type;
+ await expect(validator.check(entity)).resolves.toBe(true);
+ });
+
+ it('rejects wrong type', async () => {
+ (entity as any).spec.type = 7;
+ await expect(validator.check(entity)).rejects.toThrow(/type/);
+ });
+
+ it('rejects empty type', async () => {
+ (entity as any).spec.type = '';
+ await expect(validator.check(entity)).rejects.toThrow(/type/);
+ });
});
diff --git a/packages/catalog-model/src/kinds/DomainEntityV1alpha1.ts b/packages/catalog-model/src/kinds/DomainEntityV1alpha1.ts
index 1fe3dfb522..765329abb4 100644
--- a/packages/catalog-model/src/kinds/DomainEntityV1alpha1.ts
+++ b/packages/catalog-model/src/kinds/DomainEntityV1alpha1.ts
@@ -33,6 +33,7 @@ export interface DomainEntityV1alpha1 extends Entity {
spec: {
owner: string;
subdomainOf?: string;
+ type?: string;
};
}
diff --git a/packages/catalog-model/src/kinds/SystemEntityV1alpha1.test.ts b/packages/catalog-model/src/kinds/SystemEntityV1alpha1.test.ts
index fd78633a89..828fe7a648 100644
--- a/packages/catalog-model/src/kinds/SystemEntityV1alpha1.test.ts
+++ b/packages/catalog-model/src/kinds/SystemEntityV1alpha1.test.ts
@@ -32,6 +32,7 @@ describe('SystemV1alpha1Validator', () => {
spec: {
owner: 'me',
domain: 'domain',
+ type: 'system-type',
},
};
});
@@ -84,4 +85,19 @@ describe('SystemV1alpha1Validator', () => {
(entity as any).spec.domain = '';
await expect(validator.check(entity)).rejects.toThrow(/domain/);
});
+
+ it('accepts missing type', async () => {
+ delete (entity as any).spec.type;
+ await expect(validator.check(entity)).resolves.toBe(true);
+ });
+
+ it('rejects wrong type', async () => {
+ (entity as any).spec.type = 7;
+ await expect(validator.check(entity)).rejects.toThrow(/type/);
+ });
+
+ it('rejects empty type', async () => {
+ (entity as any).spec.type = '';
+ await expect(validator.check(entity)).rejects.toThrow(/type/);
+ });
});
diff --git a/packages/catalog-model/src/kinds/SystemEntityV1alpha1.ts b/packages/catalog-model/src/kinds/SystemEntityV1alpha1.ts
index 88d405ec5b..37ecee8f6c 100644
--- a/packages/catalog-model/src/kinds/SystemEntityV1alpha1.ts
+++ b/packages/catalog-model/src/kinds/SystemEntityV1alpha1.ts
@@ -33,6 +33,7 @@ export interface SystemEntityV1alpha1 extends Entity {
spec: {
owner: string;
domain?: string;
+ type?: string;
};
}
diff --git a/packages/catalog-model/src/schema/kinds/Domain.v1alpha1.schema.json b/packages/catalog-model/src/schema/kinds/Domain.v1alpha1.schema.json
index 7d0d7e25ff..e4a6c29dd1 100644
--- a/packages/catalog-model/src/schema/kinds/Domain.v1alpha1.schema.json
+++ b/packages/catalog-model/src/schema/kinds/Domain.v1alpha1.schema.json
@@ -12,7 +12,8 @@
},
"spec": {
"owner": "artist-relations-team",
- "subdomainOf": "audio"
+ "subdomainOf": "audio",
+ "type": "product-group"
}
}
],
@@ -45,6 +46,12 @@
"description": "An entity reference to another domain of which the domain is a part.",
"examples": ["audio"],
"minLength": 1
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of domain. There is currently no enforced set of values for this field, so it is left up to the adopting organization to choose a nomenclature that matches their catalog hierarchy.",
+ "examples": ["product-group", "bundle"],
+ "minLength": 1
}
}
}
diff --git a/packages/catalog-model/src/schema/kinds/System.v1alpha1.schema.json b/packages/catalog-model/src/schema/kinds/System.v1alpha1.schema.json
index 2cdbc37076..f91fe751dc 100644
--- a/packages/catalog-model/src/schema/kinds/System.v1alpha1.schema.json
+++ b/packages/catalog-model/src/schema/kinds/System.v1alpha1.schema.json
@@ -12,7 +12,8 @@
},
"spec": {
"owner": "artist-relations-team",
- "domain": "artists"
+ "domain": "artists",
+ "type": "service"
}
}
],
@@ -45,6 +46,12 @@
"description": "An entity reference to the domain that the system belongs to.",
"examples": ["artists"],
"minLength": 1
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of system. There is currently no enforced set of values for this field, so it is left up to the adopting organization to choose a nomenclature that matches their catalog hierarchy.",
+ "examples": ["product", "service", "feature-set"],
+ "minLength": 1
}
}
}
diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
index 887445aac7..ec823ef23e 100644
--- a/packages/cli/CHANGELOG.md
+++ b/packages/cli/CHANGELOG.md
@@ -1,5 +1,64 @@
# @backstage/cli
+## 0.27.0
+
+### Minor Changes
+
+- 32a38e1: **BREAKING**: The lockfile (`yarn.lock`) dependency analysis and mutations have been removed from several commands.
+
+ The `versions:bump` command will no longer attempt to bump and deduplicate dependencies by modifying the lockfile, it will only update `package.json` files.
+
+ The `versions:check` command has been removed, since its only purpose was verification and mutation of the lockfile. We recommend using the `yarn dedupe` command instead, or the `yarn-deduplicate` package if you're using Yarn classic.
+
+ The check that was built into the `package start` command has been removed, it will no longer warn about lockfile mismatches.
+
+ The packages in the Backstage ecosystem handle package duplications much better now than when these CLI features were first introduced, so the need for these features has diminished. By removing them, we drastically reduce the integration between the Backstage CLI and Yarn, making it much easier to add support for other package managers in the future.
+
+### Patch Changes
+
+- 7eb08a6: Add frontend-dynamic-container role to eslint config factory
+- b2d97fd: Fixing loading of additional config files with new `ConfigSources`
+- fbc7819: Use ES2022 in CLI bundler
+- 93095ee: Make sure node-fetch is version 2.7.0 or greater
+- 6d898d8: Switched the `process` polyfill to use `require.resolve` for greater compatability.
+- e53074f: Updated default backend plugin to use `RootConfigService` instead of `Config`. This also removes the dependency on `@backstage/config` as it's no longer used.
+- ee2b0e5: The experimental module federation build now has the ability to force the use of development versions of `react` and `react-dom` by setting the `FORCE_REACT_DEVELOPMENT` flag.
+- 239dffc: Remove usage of deprecated functionality from @backstage/config-loader
+- e6e7d86: Switched the target from `'ES2022'` to `'es2022'` for better compatibility with older versions of `swc`.
+- 2ced236: Updated dependency `@module-federation/enhanced` to `0.3.1`
+- 0eedec3: Add support for dynamic plugins via the EXPERIMENTAL_MODULE_FEDERATION environment variable when running `yarn start`.
+- adabb40: New command now supports setting package license
+- dc4fb4f: Fix for `repo build --all` not properly detecting the experimental public entry point.
+- Updated dependencies
+ - @backstage/config-loader@1.9.0
+ - @backstage/integration@1.14.0
+ - @backstage/catalog-model@1.6.0
+ - @backstage/cli-common@0.1.14
+ - @backstage/cli-node@0.2.7
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/eslint-plugin@0.1.8
+ - @backstage/release-manifests@0.0.11
+ - @backstage/types@1.1.1
+
+## 0.27.0-next.4
+
+### Patch Changes
+
+- 6d898d8: Switched the `process` polyfill to use `require.resolve` for greater compatability.
+- 2ced236: Updated dependency `@module-federation/enhanced` to `0.3.1`
+- Updated dependencies
+ - @backstage/catalog-model@1.6.0-next.0
+ - @backstage/cli-common@0.1.14
+ - @backstage/cli-node@0.2.7
+ - @backstage/config@1.2.0
+ - @backstage/config-loader@1.9.0-next.2
+ - @backstage/errors@1.2.4
+ - @backstage/eslint-plugin@0.1.8
+ - @backstage/integration@1.14.0-next.0
+ - @backstage/release-manifests@0.0.11
+ - @backstage/types@1.1.1
+
## 0.27.0-next.3
### Patch Changes
diff --git a/packages/cli/package.json b/packages/cli/package.json
index ba45b8f514..c3f70bcbf4 100644
--- a/packages/cli/package.json
+++ b/packages/cli/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/cli",
- "version": "0.27.0-next.3",
+ "version": "0.27.0",
"description": "CLI for developing Backstage plugins and apps",
"backstage": {
"role": "cli"
@@ -53,7 +53,7 @@
"@backstage/release-manifests": "workspace:^",
"@backstage/types": "workspace:^",
"@manypkg/get-packages": "^1.1.3",
- "@module-federation/enhanced": "^0.1.19",
+ "@module-federation/enhanced": "^0.3.5",
"@octokit/graphql": "^5.0.0",
"@octokit/graphql-schema": "^13.7.0",
"@octokit/oauth-app": "^4.2.0",
diff --git a/packages/cli/src/lib/bundler/config.ts b/packages/cli/src/lib/bundler/config.ts
index 42cdae24e3..da7b378fbd 100644
--- a/packages/cli/src/lib/bundler/config.ts
+++ b/packages/cli/src/lib/bundler/config.ts
@@ -180,7 +180,7 @@ export async function createConfig(
// to remove this eventually!
plugins.push(
new ProvidePlugin({
- process: 'process/browser',
+ process: require.resolve('process/browser'),
Buffer: ['buffer', 'Buffer'],
}),
);
diff --git a/packages/config-loader/CHANGELOG.md b/packages/config-loader/CHANGELOG.md
index 78f2123970..a60e86a6c8 100644
--- a/packages/config-loader/CHANGELOG.md
+++ b/packages/config-loader/CHANGELOG.md
@@ -1,5 +1,24 @@
# @backstage/config-loader
+## 1.9.0
+
+### Minor Changes
+
+- 274428f: Add configuration key to File and Remote `ConfigSource`s that enables configuration of parsing logic. Previously limited to yaml, these `ConfigSource`s now allow for a multitude of parsing options (e.g. JSON).
+
+### Patch Changes
+
+- 93095ee: Make sure node-fetch is version 2.7.0 or greater
+- 1edd6c2: The `env` option of `ConfigSources.default` now correctly allows undefined members.
+- 493feac: Add boolean `allowMissingDefaultConfig` option to `ConfigSources.default` and
+ `ConfigSources.defaultForTargets`, which results in omission of a ConfigSource
+ for the default app-config.yaml configuration file if it's not present.
+- Updated dependencies
+ - @backstage/cli-common@0.1.14
+ - @backstage/config@1.2.0
+ - @backstage/errors@1.2.4
+ - @backstage/types@1.1.1
+
## 1.9.0-next.2
### Patch Changes
diff --git a/packages/config-loader/package.json b/packages/config-loader/package.json
index a47a17c12f..98d233b348 100644
--- a/packages/config-loader/package.json
+++ b/packages/config-loader/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/config-loader",
- "version": "1.9.0-next.2",
+ "version": "1.9.0",
"description": "Config loading functionality used by Backstage backend, and CLI",
"backstage": {
"role": "node-library"
diff --git a/packages/core-app-api/CHANGELOG.md b/packages/core-app-api/CHANGELOG.md
index 26b9eb20fe..2ae26f8b97 100644
--- a/packages/core-app-api/CHANGELOG.md
+++ b/packages/core-app-api/CHANGELOG.md
@@ -1,5 +1,16 @@
# @backstage/core-app-api
+## 1.14.2
+
+### Patch Changes
+
+- 9a46a81: The request to delete the session cookie when running the app in protected mode is now done with a plain `fetch` rather than `FetchApi`. This fixes a bug where the app would immediately try to sign-in again when removing the cookie during logout.
+- Updated dependencies
+ - @backstage/config@1.2.0
+ - @backstage/core-plugin-api@1.9.3
+ - @backstage/types@1.1.1
+ - @backstage/version-bridge@1.0.8
+
## 1.14.1-next.0
### Patch Changes
diff --git a/packages/core-app-api/package.json b/packages/core-app-api/package.json
index 6a107e0a87..ad8b4b49c0 100644
--- a/packages/core-app-api/package.json
+++ b/packages/core-app-api/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/core-app-api",
"description": "Core app API used by Backstage apps",
- "version": "1.14.2-next.0",
+ "version": "1.14.2",
"publishConfig": {
"access": "public"
},
diff --git a/packages/core-compat-api/CHANGELOG.md b/packages/core-compat-api/CHANGELOG.md
index 34c134f731..35849d453c 100644
--- a/packages/core-compat-api/CHANGELOG.md
+++ b/packages/core-compat-api/CHANGELOG.md
@@ -1,5 +1,28 @@
# @backstage/core-compat-api
+## 0.2.8
+
+### Patch Changes
+
+- 72754db: Updated usage of `useRouteRef`, which can now always return `undefined`.
+- fe1fbb2: Migrating usages of the deprecated `createExtension` `v1` format to the newer `v2` format, and old `create*Extension` extension creators to blueprints.
+- 16cf96c: Both `compatWrapper` and `convertLegacyRouteRef` now support converting from the new system to the old.
+- 519b8e0: Added new utilities for converting legacy plugins and extensions to the new system. The `convertLegacyPlugin` option will convert an existing plugin to the new system, although you need to supply extensions for the plugin yourself. To help out with this, there is also a new `convertLegacyPageExtension` which converts an existing page extension to the new system.
+- 6349099: Added config input type to the extensions
+- Updated dependencies
+ - @backstage/frontend-plugin-api@0.7.0
+ - @backstage/core-plugin-api@1.9.3
+ - @backstage/version-bridge@1.0.8
+
+## 0.2.8-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/frontend-plugin-api@0.7.0-next.3
+ - @backstage/core-plugin-api@1.9.3
+ - @backstage/version-bridge@1.0.8
+
## 0.2.8-next.2
### Patch Changes
diff --git a/packages/core-compat-api/api-report.md b/packages/core-compat-api/api-report.md
index 8d177b4dab..75b91cc055 100644
--- a/packages/core-compat-api/api-report.md
+++ b/packages/core-compat-api/api-report.md
@@ -8,6 +8,10 @@ import { AnalyticsApi as AnalyticsApi_2 } from '@backstage/frontend-plugin-api';
import { AnalyticsEvent } from '@backstage/core-plugin-api';
import { AnalyticsEvent as AnalyticsEvent_2 } from '@backstage/frontend-plugin-api';
import { AnyRouteRefParams } from '@backstage/core-plugin-api';
+import { BackstagePlugin } from '@backstage/core-plugin-api';
+import { BackstagePlugin as BackstagePlugin_2 } from '@backstage/frontend-plugin-api';
+import { ComponentType } from 'react';
+import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { ExternalRouteRef } from '@backstage/core-plugin-api';
import { ExternalRouteRef as ExternalRouteRef_2 } from '@backstage/frontend-plugin-api';
import { FrontendFeature } from '@backstage/frontend-plugin-api';
@@ -26,6 +30,23 @@ export function convertLegacyApp(
rootElement: React_2.JSX.Element,
): FrontendFeature[];
+// @public (undocumented)
+export function convertLegacyPageExtension(
+ LegacyExtension: ComponentType<{}>,
+ overrides?: {
+ name?: string;
+ defaultPath?: string;
+ },
+): ExtensionDefinition;
+
+// @public (undocumented)
+export function convertLegacyPlugin(
+ legacyPlugin: BackstagePlugin,
+ options: {
+ extensions: ExtensionDefinition[];
+ },
+): BackstagePlugin_2;
+
// @public
export function convertLegacyRouteRef(
ref: RouteRef,
diff --git a/packages/core-compat-api/package.json b/packages/core-compat-api/package.json
index 0434b206d9..5af7d1b960 100644
--- a/packages/core-compat-api/package.json
+++ b/packages/core-compat-api/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/core-compat-api",
- "version": "0.2.8-next.2",
+ "version": "0.2.8",
"backstage": {
"role": "web-library"
},
@@ -34,7 +34,8 @@
"@backstage/core-plugin-api": "workspace:^",
"@backstage/frontend-plugin-api": "workspace:^",
"@backstage/version-bridge": "workspace:^",
- "@types/react": "^16.13.1 || ^17.0.0"
+ "@types/react": "^16.13.1 || ^17.0.0",
+ "lodash": "^4.17.21"
},
"devDependencies": {
"@backstage-community/plugin-puppetdb": "^0.1.18",
diff --git a/packages/core-compat-api/src/collectLegacyRoutes.test.tsx b/packages/core-compat-api/src/collectLegacyRoutes.test.tsx
index aa3beee679..f8b40a561c 100644
--- a/packages/core-compat-api/src/collectLegacyRoutes.test.tsx
+++ b/packages/core-compat-api/src/collectLegacyRoutes.test.tsx
@@ -31,7 +31,7 @@ import { Navigate, Route, Routes } from 'react-router-dom';
import { collectLegacyRoutes } from './collectLegacyRoutes';
// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { toInternalBackstagePlugin } from '../../frontend-plugin-api/src/wiring/createPlugin';
+import { toInternalBackstagePlugin } from '../../frontend-plugin-api/src/wiring/createFrontendPlugin';
import {
createPlugin,
createRoutableExtension,
@@ -70,7 +70,7 @@ describe('collectLegacyRoutes', () => {
id: 'page:score-card',
attachTo: { id: 'app/routes', input: 'routes' },
disabled: false,
- defaultConfig: { path: 'score-board' },
+ defaultConfig: {},
},
{
id: 'api:plugin.scoringdata.service',
@@ -86,7 +86,7 @@ describe('collectLegacyRoutes', () => {
id: 'page:stackstorm',
attachTo: { id: 'app/routes', input: 'routes' },
disabled: false,
- defaultConfig: { path: 'stackstorm' },
+ defaultConfig: {},
},
{
id: 'api:plugin.stackstorm.service',
@@ -102,13 +102,13 @@ describe('collectLegacyRoutes', () => {
id: 'page:puppetDb',
attachTo: { id: 'app/routes', input: 'routes' },
disabled: false,
- defaultConfig: { path: 'puppetdb' },
+ defaultConfig: {},
},
{
id: 'page:puppetDb/1',
attachTo: { id: 'app/routes', input: 'routes' },
disabled: false,
- defaultConfig: { path: 'puppetdb' },
+ defaultConfig: {},
},
{
id: 'api:plugin.puppetdb.service',
@@ -173,12 +173,12 @@ describe('collectLegacyRoutes', () => {
id: 'page:catalog',
attachTo: { id: 'app/routes', input: 'routes' },
disabled: false,
- defaultConfig: { path: 'catalog' },
+ defaultConfig: {},
},
{
id: 'page:catalog/1',
attachTo: { id: 'app/routes', input: 'routes' },
- defaultConfig: { path: 'catalog/:namespace/:kind/:name' },
+ defaultConfig: {},
disabled: false,
},
{
diff --git a/packages/core-compat-api/src/collectLegacyRoutes.tsx b/packages/core-compat-api/src/collectLegacyRoutes.tsx
index 3523b0a40b..c5cb13b6e1 100644
--- a/packages/core-compat-api/src/collectLegacyRoutes.tsx
+++ b/packages/core-compat-api/src/collectLegacyRoutes.tsx
@@ -24,11 +24,11 @@ import {
BackstagePlugin,
ExtensionDefinition,
coreExtensionData,
- createApiExtension,
createExtension,
createExtensionInput,
- createPageExtension,
- createPlugin,
+ createFrontendPlugin,
+ ApiBlueprint,
+ PageBlueprint,
} from '@backstage/frontend-plugin-api';
import React, { Children, ReactNode, isValidElement } from 'react';
import { Route, Routes } from 'react-router-dom';
@@ -80,19 +80,24 @@ function makeRoutingShimExtension(options: {
name,
attachTo: { id: parentExtensionId, input: 'childRoutingShims' },
inputs: {
- childRoutingShims: createExtensionInput({
- routePath: coreExtensionData.routePath.optional(),
- routeRef: coreExtensionData.routeRef.optional(),
- }),
+ childRoutingShims: createExtensionInput([
+ coreExtensionData.routePath.optional(),
+ coreExtensionData.routeRef.optional(),
+ ]),
},
- output: {
- routePath: coreExtensionData.routePath.optional(),
- routeRef: coreExtensionData.routeRef.optional(),
+ output: [
+ coreExtensionData.routePath.optional(),
+ coreExtensionData.routeRef.optional(),
+ ],
+ *factory() {
+ if (routePath !== undefined) {
+ yield coreExtensionData.routePath(routePath);
+ }
+
+ if (routeRef) {
+ yield coreExtensionData.routeRef(convertLegacyRouteRef(routeRef));
+ }
},
- factory: () => ({
- routePath,
- routeRef: routeRef ? convertLegacyRouteRef(routeRef) : undefined,
- }),
});
}
@@ -214,28 +219,33 @@ export function collectLegacyRoutes(
}`;
extensions.push(
- createPageExtension({
+ PageBlueprint.makeWithOverrides({
name: pageExtensionName,
- defaultPath: path[0] === '/' ? path.slice(1) : path,
- routeRef: routeRef ? convertLegacyRouteRef(routeRef) : undefined,
inputs: {
- childRoutingShims: createExtensionInput({
- routePath: coreExtensionData.routePath.optional(),
- routeRef: coreExtensionData.routeRef.optional(),
- }),
+ childRoutingShims: createExtensionInput([
+ coreExtensionData.routePath.optional(),
+ coreExtensionData.routeRef.optional(),
+ ]),
+ },
+ factory(originalFactory, { inputs: _inputs }) {
+ // todo(blam): why do we not use the inputs here?
+ return originalFactory({
+ defaultPath: path[0] === '/' ? path.slice(1) : path,
+ routeRef: routeRef ? convertLegacyRouteRef(routeRef) : undefined,
+ loader: async () =>
+ compatWrapper(
+ route.props.children ? (
+
+
+
+
+ ) : (
+ routeElement
+ ),
+ ),
+ });
},
- loader: async () =>
- compatWrapper(
- route.props.children ? (
-
-
-
-
- ) : (
- routeElement
- ),
- ),
}),
);
@@ -253,12 +263,12 @@ export function collectLegacyRoutes(
);
return Array.from(pluginExtensions).map(([plugin, extensions]) =>
- createPlugin({
+ createFrontendPlugin({
id: plugin.getId(),
extensions: [
...extensions,
...Array.from(plugin.getApis()).map(factory =>
- createApiExtension({ factory }),
+ ApiBlueprint.make({ namespace: factory.api.id, params: { factory } }),
),
],
routes: convertLegacyRouteRefs(plugin.routes ?? {}),
diff --git a/packages/core-compat-api/src/compatWrapper/BackwardsCompatProvider.tsx b/packages/core-compat-api/src/compatWrapper/BackwardsCompatProvider.tsx
index 4f9ba3a836..445f42124f 100644
--- a/packages/core-compat-api/src/compatWrapper/BackwardsCompatProvider.tsx
+++ b/packages/core-compat-api/src/compatWrapper/BackwardsCompatProvider.tsx
@@ -21,7 +21,7 @@ import { AppContextProvider } from '../../../core-app-api/src/app/AppContext';
// eslint-disable-next-line @backstage/no-relative-monorepo-imports
import { RouteResolver } from '../../../core-plugin-api/src/routing/useRouteRef';
import {
- createPlugin as createNewPlugin,
+ createFrontendPlugin as createNewPlugin,
BackstagePlugin as NewBackstagePlugin,
appTreeApiRef,
componentsApiRef,
diff --git a/packages/core-compat-api/src/compatWrapper/compatWrapper.test.tsx b/packages/core-compat-api/src/compatWrapper/compatWrapper.test.tsx
index 04e2361087..6357f13906 100644
--- a/packages/core-compat-api/src/compatWrapper/compatWrapper.test.tsx
+++ b/packages/core-compat-api/src/compatWrapper/compatWrapper.test.tsx
@@ -45,9 +45,7 @@ describe('BackwardsCompatProvider', () => {
createExtensionTester(
createExtension({
attachTo: { id: 'ignored', input: 'ignored' },
- output: {
- element: coreExtensionData.reactElement,
- },
+ output: [coreExtensionData.reactElement],
factory() {
function Component() {
const app = useApp();
@@ -66,9 +64,7 @@ describe('BackwardsCompatProvider', () => {
);
}
- return {
- element: compatWrapper( {
+ const element = (element, 'core.extensionName');
+ if (!extName) {
+ throw new Error('Extension has no name');
+ }
+
+ const mountPoint = getComponentData(
+ element,
+ 'core.mountPoint',
+ );
+
+ const name = extName.endsWith('Page')
+ ? extName.slice(0, -'Page'.length)
+ : extName;
+ const kebabName = kebabCase(name);
+
+ return PageBlueprint.make({
+ name: overrides?.name ?? kebabName,
+ params: {
+ defaultPath: overrides?.defaultPath ?? `/${kebabName}`,
+ routeRef: mountPoint && convertLegacyRouteRef(mountPoint),
+ loader: async () => compatWrapper(element),
+ },
+ });
+}
diff --git a/packages/core-compat-api/src/convertLegacyPlugin.test.tsx b/packages/core-compat-api/src/convertLegacyPlugin.test.tsx
new file mode 100644
index 0000000000..657ee91725
--- /dev/null
+++ b/packages/core-compat-api/src/convertLegacyPlugin.test.tsx
@@ -0,0 +1,91 @@
+/*
+ * 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 {
+ createPlugin as createLegacyPlugin,
+ createRouteRef as createLegacyRouteRef,
+ createExternalRouteRef as createLegacyExternalRouteRef,
+ createApiFactory,
+ createApiRef,
+} from '@backstage/core-plugin-api';
+import { convertLegacyPlugin } from './convertLegacyPlugin';
+import { PageBlueprint } from '@backstage/frontend-plugin-api';
+// eslint-disable-next-line @backstage/no-relative-monorepo-imports
+import { toInternalBackstagePlugin } from '../../frontend-plugin-api/src/wiring/createFrontendPlugin';
+
+describe('convertLegacyPlugin', () => {
+ it('should convert a plain legacy plugin to a new plugin', () => {
+ expect(
+ convertLegacyPlugin(createLegacyPlugin({ id: 'test' }), {
+ extensions: [],
+ }),
+ ).toMatchInlineSnapshot(`
+ {
+ "$$type": "@backstage/BackstagePlugin",
+ "extensions": [],
+ "externalRoutes": {},
+ "featureFlags": [],
+ "getExtension": [Function],
+ "id": "test",
+ "routes": {},
+ "toString": [Function],
+ "version": "v1",
+ "withOverrides": [Function],
+ }
+ `);
+ });
+
+ it('should convert a legacy plugin with options to a new plugin', () => {
+ const apiRef = createApiRef({ id: 'plugin.test.client' });
+
+ const routeRef = createLegacyRouteRef({ id: 'test' });
+ const extRouteRef = createLegacyExternalRouteRef({ id: 'testExt' });
+
+ const converted = convertLegacyPlugin(
+ createLegacyPlugin({
+ id: 'test',
+ apis: [createApiFactory(apiRef, 'hello')],
+ routes: { test: routeRef },
+ externalRoutes: {
+ testExt: extRouteRef,
+ },
+ featureFlags: [{ name: 'test-flag' }],
+ }),
+ {
+ extensions: [
+ PageBlueprint.make({
+ params: { defaultPath: '/test', loader: async () => ({} as any) },
+ }),
+ ],
+ },
+ );
+
+ const internalConverted = toInternalBackstagePlugin(converted);
+
+ expect(internalConverted.id).toBe('test');
+ expect(internalConverted.routes).toEqual({
+ test: routeRef,
+ });
+ expect(internalConverted.externalRoutes).toEqual({
+ testExt: extRouteRef,
+ });
+ expect(internalConverted.featureFlags).toEqual([{ name: 'test-flag' }]);
+ expect(internalConverted.extensions.map(e => e.id)).toEqual([
+ 'api:plugin.test.client',
+ 'page:test',
+ ]);
+ });
+});
diff --git a/packages/core-compat-api/src/convertLegacyPlugin.ts b/packages/core-compat-api/src/convertLegacyPlugin.ts
new file mode 100644
index 0000000000..5856108f29
--- /dev/null
+++ b/packages/core-compat-api/src/convertLegacyPlugin.ts
@@ -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.
+ */
+
+import { BackstagePlugin as LegacyBackstagePlugin } from '@backstage/core-plugin-api';
+import {
+ ApiBlueprint,
+ ExtensionDefinition,
+ BackstagePlugin as NewBackstagePlugin,
+ createFrontendPlugin,
+} from '@backstage/frontend-plugin-api';
+import { convertLegacyRouteRefs } from './convertLegacyRouteRef';
+
+/** @public */
+export function convertLegacyPlugin(
+ legacyPlugin: LegacyBackstagePlugin,
+ options: { extensions: ExtensionDefinition[] },
+): NewBackstagePlugin {
+ const apiExtensions = Array.from(legacyPlugin.getApis()).map(factory =>
+ ApiBlueprint.make({ namespace: factory.api.id, params: { factory } }),
+ );
+ return createFrontendPlugin({
+ id: legacyPlugin.getId(),
+ featureFlags: [...legacyPlugin.getFeatureFlags()],
+ routes: convertLegacyRouteRefs(legacyPlugin.routes ?? {}),
+ externalRoutes: convertLegacyRouteRefs(legacyPlugin.externalRoutes ?? {}),
+ extensions: [...apiExtensions, ...options.extensions],
+ });
+}
diff --git a/packages/core-compat-api/src/index.ts b/packages/core-compat-api/src/index.ts
index 88e1892eac..7f99a7ab7a 100644
--- a/packages/core-compat-api/src/index.ts
+++ b/packages/core-compat-api/src/index.ts
@@ -18,6 +18,8 @@ export * from './compatWrapper';
export * from './apis';
export { convertLegacyApp } from './convertLegacyApp';
+export { convertLegacyPlugin } from './convertLegacyPlugin';
+export { convertLegacyPageExtension } from './convertLegacyPageExtension';
export {
convertLegacyRouteRef,
convertLegacyRouteRefs,
diff --git a/packages/core-components/CHANGELOG.md b/packages/core-components/CHANGELOG.md
index a2463f594e..f50b830702 100644
--- a/packages/core-components/CHANGELOG.md
+++ b/packages/core-components/CHANGELOG.md
@@ -1,5 +1,18 @@
# @backstage/core-components
+## 0.14.10
+
+### Patch Changes
+
+- 678971a: Move the `Link` component to the `RoutedTabs` instead of the `HeaderTabs` component
+- 13a9c63: Corrected the documentation for the GCP IAP auth module and updated the configuration to follow proxy configuration conventions by ignoring authEnv
+- Updated dependencies
+ - @backstage/config@1.2.0
+ - @backstage/core-plugin-api@1.9.3
+ - @backstage/errors@1.2.4
+ - @backstage/theme@0.5.6
+ - @backstage/version-bridge@1.0.8
+
## 0.14.10-next.0
### Patch Changes
diff --git a/packages/core-components/package.json b/packages/core-components/package.json
index a2688a0037..154331d70d 100644
--- a/packages/core-components/package.json
+++ b/packages/core-components/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/core-components",
"description": "Core components used by Backstage plugins and apps",
- "version": "0.14.10-next.0",
+ "version": "0.14.10",
"publishConfig": {
"access": "public"
},
diff --git a/packages/core-components/src/layout/ProxiedSignInPage/ProxiedSignInPage.tsx b/packages/core-components/src/layout/ProxiedSignInPage/ProxiedSignInPage.tsx
index 98fca7c6ef..df0d256312 100644
--- a/packages/core-components/src/layout/ProxiedSignInPage/ProxiedSignInPage.tsx
+++ b/packages/core-components/src/layout/ProxiedSignInPage/ProxiedSignInPage.tsx
@@ -34,7 +34,7 @@ import { useTranslationRef } from '@backstage/core-plugin-api/alpha';
*/
export type ProxiedSignInPageProps = SignInPageProps & {
/**
- * The provider to use, e.g. "gcp-iap" or "awsalb". This must correspond to
+ * The provider to use, e.g. "gcpIap" or "awsalb". This must correspond to
* a properly configured auth provider ID in the auth backend.
*/
provider: string;
diff --git a/packages/create-app/CHANGELOG.md b/packages/create-app/CHANGELOG.md
index dce729b811..9a21164f9b 100644
--- a/packages/create-app/CHANGELOG.md
+++ b/packages/create-app/CHANGELOG.md
@@ -1,5 +1,25 @@
# @backstage/create-app
+## 0.5.18
+
+### Patch Changes
+
+- c0a705d: Added the Kubernetes plugin to `create-app`
+- d7a0aa3: Bumped create-app version.
+- 93095ee: Make sure node-fetch is version 2.7.0 or greater
+- 6c1081c: Updated dockerfile and `app-config.production.yaml` to make it easier to get started with example data
+- bfeba46: Included permission config and enabled it out of the box
+- Updated dependencies
+ - @backstage/cli-common@0.1.14
+
+## 0.5.18-next.4
+
+### Patch Changes
+
+- bfeba46: Included permission config and enabled it out of the box
+- Updated dependencies
+ - @backstage/cli-common@0.1.14
+
## 0.5.18-next.3
### Patch Changes
diff --git a/packages/create-app/package.json b/packages/create-app/package.json
index 8886ed9a6d..48a3651f71 100644
--- a/packages/create-app/package.json
+++ b/packages/create-app/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/create-app",
"description": "A CLI that helps you create your own Backstage app",
- "version": "0.5.18-next.3",
+ "version": "0.5.18",
"publishConfig": {
"access": "public"
},
diff --git a/packages/dev-utils/CHANGELOG.md b/packages/dev-utils/CHANGELOG.md
index 5ea08c7762..6d40e8fe18 100644
--- a/packages/dev-utils/CHANGELOG.md
+++ b/packages/dev-utils/CHANGELOG.md
@@ -1,5 +1,33 @@
# @backstage/dev-utils
+## 1.0.37
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-react@1.12.3
+ - @backstage/core-components@0.14.10
+ - @backstage/core-app-api@1.14.2
+ - @backstage/catalog-model@1.6.0
+ - @backstage/app-defaults@1.5.10
+ - @backstage/core-plugin-api@1.9.3
+ - @backstage/integration-react@1.1.30
+ - @backstage/theme@0.5.6
+
+## 1.0.37-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/catalog-model@1.6.0-next.0
+ - @backstage/plugin-catalog-react@1.12.3-next.3
+ - @backstage/app-defaults@1.5.10-next.2
+ - @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
+
## 1.0.37-next.2
### Patch Changes
diff --git a/packages/dev-utils/package.json b/packages/dev-utils/package.json
index b2b6eb3292..447cc13cdc 100644
--- a/packages/dev-utils/package.json
+++ b/packages/dev-utils/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/dev-utils",
- "version": "1.0.37-next.2",
+ "version": "1.0.37",
"description": "Utilities for developing Backstage plugins.",
"backstage": {
"role": "web-library"
diff --git a/packages/e2e-test/CHANGELOG.md b/packages/e2e-test/CHANGELOG.md
index 4609771fb5..13f01f7458 100644
--- a/packages/e2e-test/CHANGELOG.md
+++ b/packages/e2e-test/CHANGELOG.md
@@ -1,5 +1,23 @@
# e2e-test
+## 0.2.19
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/create-app@0.5.18
+ - @backstage/cli-common@0.1.14
+ - @backstage/errors@1.2.4
+
+## 0.2.19-next.4
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/create-app@0.5.18-next.4
+ - @backstage/cli-common@0.1.14
+ - @backstage/errors@1.2.4
+
## 0.2.19-next.3
### Patch Changes
diff --git a/packages/e2e-test/package.json b/packages/e2e-test/package.json
index 481b011d01..2e2ca6e331 100644
--- a/packages/e2e-test/package.json
+++ b/packages/e2e-test/package.json
@@ -1,7 +1,7 @@
{
"name": "e2e-test",
"description": "E2E test for verifying Backstage packages",
- "version": "0.2.19-next.3",
+ "version": "0.2.19",
"private": true,
"backstage": {
"role": "cli"
diff --git a/packages/frontend-app-api/CHANGELOG.md b/packages/frontend-app-api/CHANGELOG.md
index dd419c284b..961d099fa1 100644
--- a/packages/frontend-app-api/CHANGELOG.md
+++ b/packages/frontend-app-api/CHANGELOG.md
@@ -1,5 +1,44 @@
# @backstage/frontend-app-api
+## 0.8.0
+
+### Minor Changes
+
+- fc24d9e: Stop using `@backstage/backend-tasks` as it will be deleted in near future.
+
+### Patch Changes
+
+- 7777b5f: Support icon overriding with the new `IconBundleBlueprint` API.
+- 72754db: Updated usage of `useRouteRef`, which can now always return `undefined`.
+- 3be9aeb: Added support for v2 extensions, which declare their inputs and outputs without using a data map.
+- fe1fbb2: Migrating usages of the deprecated `createExtension` `v1` format to the newer `v2` format, and old `create*Extension` extension creators to blueprints.
+- 6349099: Added config input type to the extensions
+- Updated dependencies
+ - @backstage/frontend-plugin-api@0.7.0
+ - @backstage/core-components@0.14.10
+ - @backstage/core-app-api@1.14.2
+ - @backstage/config@1.2.0
+ - @backstage/core-plugin-api@1.9.3
+ - @backstage/errors@1.2.4
+ - @backstage/theme@0.5.6
+ - @backstage/types@1.1.1
+ - @backstage/version-bridge@1.0.8
+
+## 0.7.5-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/frontend-plugin-api@0.7.0-next.3
+ - @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/errors@1.2.4
+ - @backstage/theme@0.5.6
+ - @backstage/types@1.1.1
+ - @backstage/version-bridge@1.0.8
+
## 0.7.5-next.2
### Patch Changes
diff --git a/packages/frontend-app-api/package.json b/packages/frontend-app-api/package.json
index 0d462e2721..3f13b4ad93 100644
--- a/packages/frontend-app-api/package.json
+++ b/packages/frontend-app-api/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/frontend-app-api",
- "version": "0.7.5-next.2",
+ "version": "0.8.0",
"backstage": {
"role": "web-library"
},
diff --git a/packages/frontend-app-api/src/apis/implementations/ComponentsApi/DefaultComponentsApi.test.tsx b/packages/frontend-app-api/src/apis/implementations/ComponentsApi/DefaultComponentsApi.test.tsx
index 7d62103727..e2c7581e63 100644
--- a/packages/frontend-app-api/src/apis/implementations/ComponentsApi/DefaultComponentsApi.test.tsx
+++ b/packages/frontend-app-api/src/apis/implementations/ComponentsApi/DefaultComponentsApi.test.tsx
@@ -40,14 +40,8 @@ const baseOverrides = createExtensionOverrides({
namespace: 'app',
name: 'root',
attachTo: { id: 'app', input: 'root' },
- output: {
- element: coreExtensionData.reactElement,
- },
- factory() {
- return {
- element:
+ {inputs.root.get(coreExtensionData.reactElement)}
+ ,
),
- },
- output: {
- root: coreExtensionData.reactElement,
- },
- factory({ node, inputs }) {
- return {
- root: (
-
- {inputs.root.output.element}
-
- ),
- };
- },
+ ],
});
diff --git a/packages/frontend-app-api/src/extensions/AppLayout.tsx b/packages/frontend-app-api/src/extensions/AppLayout.tsx
index 7be0029c25..9fadba8a93 100644
--- a/packages/frontend-app-api/src/extensions/AppLayout.tsx
+++ b/packages/frontend-app-api/src/extensions/AppLayout.tsx
@@ -27,30 +27,20 @@ export const AppLayout = createExtension({
name: 'layout',
attachTo: { id: 'app/root', input: 'children' },
inputs: {
- nav: createExtensionInput(
- {
- element: coreExtensionData.reactElement,
- },
- { singleton: true },
+ nav: createExtensionInput([coreExtensionData.reactElement], {
+ singleton: true,
+ }),
+ content: createExtensionInput([coreExtensionData.reactElement], {
+ singleton: true,
+ }),
+ },
+ output: [coreExtensionData.reactElement],
+ factory: ({ inputs }) => [
+ coreExtensionData.reactElement(
+
+ {inputs.nav.get(coreExtensionData.reactElement)}
+ {inputs.content.get(coreExtensionData.reactElement)}
+ ,
),
- content: createExtensionInput(
- {
- element: coreExtensionData.reactElement,
- },
- { singleton: true },
- ),
- },
- output: {
- element: coreExtensionData.reactElement,
- },
- factory({ inputs }) {
- return {
- element: (
-
- {inputs.nav.output.element}
- {inputs.content.output.element}
-
- ),
- };
- },
+ ],
});
diff --git a/packages/frontend-app-api/src/extensions/AppNav.tsx b/packages/frontend-app-api/src/extensions/AppNav.tsx
index ffef1c7c61..b80a537ef6 100644
--- a/packages/frontend-app-api/src/extensions/AppNav.tsx
+++ b/packages/frontend-app-api/src/extensions/AppNav.tsx
@@ -20,8 +20,8 @@ import {
coreExtensionData,
createExtensionInput,
useRouteRef,
- createNavItemExtension,
- createNavLogoExtension,
+ NavItemBlueprint,
+ NavLogoBlueprint,
} from '@backstage/frontend-plugin-api';
import { makeStyles } from '@material-ui/core/styles';
import {
@@ -53,7 +53,7 @@ const useSidebarLogoStyles = makeStyles({
});
const SidebarLogo = (
- props: (typeof createNavLogoExtension.logoElementsDataRef)['T'],
+ props: (typeof NavLogoBlueprint.dataRefs.logoElements)['T'],
) => {
const classes = useSidebarLogoStyles();
const { isOpen } = useSidebarOpenState();
@@ -70,7 +70,7 @@ const SidebarLogo = (
};
const SidebarNavItem = (
- props: (typeof createNavItemExtension.targetDataRef)['T'],
+ props: (typeof NavItemBlueprint.dataRefs.target)['T'],
) => {
const { icon: Icon, title, routeRef } = props;
const link = useRouteRef(routeRef);
@@ -86,33 +86,27 @@ export const AppNav = createExtension({
name: 'nav',
attachTo: { id: 'app/layout', input: 'nav' },
inputs: {
- items: createExtensionInput({
- target: createNavItemExtension.targetDataRef,
+ items: createExtensionInput([NavItemBlueprint.dataRefs.target]),
+ logos: createExtensionInput([NavLogoBlueprint.dataRefs.logoElements], {
+ singleton: true,
+ optional: true,
}),
- logos: createExtensionInput(
- {
- elements: createNavLogoExtension.logoElementsDataRef,
- },
- {
- singleton: true,
- optional: true,
- },
+ },
+ output: [coreExtensionData.reactElement],
+ factory: ({ inputs }) => [
+ coreExtensionData.reactElement(
+
+ ,
),
- },
- output: {
- element: coreExtensionData.reactElement,
- },
- factory({ inputs }) {
- return {
- element: (
-
-
- ),
- };
- },
+ ],
});
diff --git a/packages/frontend-app-api/src/extensions/AppRoot.tsx b/packages/frontend-app-api/src/extensions/AppRoot.tsx
index f3a962dd10..a158386d04 100644
--- a/packages/frontend-app-api/src/extensions/AppRoot.tsx
+++ b/packages/frontend-app-api/src/extensions/AppRoot.tsx
@@ -23,12 +23,12 @@ import React, {
useState,
} from 'react';
import {
+ AppRootWrapperBlueprint,
+ RouterBlueprint,
+ SignInPageBlueprint,
coreExtensionData,
- createAppRootWrapperExtension,
createExtension,
createExtensionInput,
- createRouterExtension,
- createSignInPageExtension,
} from '@backstage/frontend-plugin-api';
import {
IdentityApi,
@@ -48,52 +48,54 @@ export const AppRoot = createExtension({
name: 'root',
attachTo: { id: 'app', input: 'root' },
inputs: {
- router: createExtensionInput(
- { component: createRouterExtension.componentDataRef },
- { singleton: true, optional: true },
- ),
- signInPage: createExtensionInput(
- { component: createSignInPageExtension.componentDataRef },
- { singleton: true, optional: true },
- ),
- children: createExtensionInput(
- { element: coreExtensionData.reactElement },
- { singleton: true },
- ),
- elements: createExtensionInput({
- element: coreExtensionData.reactElement,
+ router: createExtensionInput([RouterBlueprint.dataRefs.component], {
+ singleton: true,
+ optional: true,
}),
- wrappers: createExtensionInput({
- component: createAppRootWrapperExtension.componentDataRef,
+ signInPage: createExtensionInput([SignInPageBlueprint.dataRefs.component], {
+ singleton: true,
+ optional: true,
}),
+ children: createExtensionInput([coreExtensionData.reactElement], {
+ singleton: true,
+ }),
+ elements: createExtensionInput([coreExtensionData.reactElement]),
+ wrappers: createExtensionInput([
+ AppRootWrapperBlueprint.dataRefs.component,
+ ]),
},
- output: {
- element: coreExtensionData.reactElement,
- },
+ output: [coreExtensionData.reactElement],
factory({ inputs }) {
let content: React.ReactNode = (
<>
{inputs.elements.map(el => (
- {el.output.element}
+
+ {el.get(coreExtensionData.reactElement)}
+
))}
- {inputs.children.output.element}
+ {inputs.children.get(coreExtensionData.reactElement)}
);
for (const wrapper of inputs.wrappers) {
- content = {content} ;
+ const Component = wrapper.get(AppRootWrapperBlueprint.dataRefs.component);
+ content = {content} ;
}
- return {
- element: (
+ return [
+ coreExtensionData.reactElement(
{content}
-
+ ,
),
- };
+ ];
},
});
diff --git a/packages/frontend-app-api/src/extensions/AppRoutes.tsx b/packages/frontend-app-api/src/extensions/AppRoutes.tsx
index 38a9291755..6ef7e2a271 100644
--- a/packages/frontend-app-api/src/extensions/AppRoutes.tsx
+++ b/packages/frontend-app-api/src/extensions/AppRoutes.tsx
@@ -29,15 +29,13 @@ export const AppRoutes = createExtension({
name: 'routes',
attachTo: { id: 'app/layout', input: 'content' },
inputs: {
- routes: createExtensionInput({
- path: coreExtensionData.routePath,
- ref: coreExtensionData.routeRef.optional(),
- element: coreExtensionData.reactElement,
- }),
- },
- output: {
- element: coreExtensionData.reactElement,
+ routes: createExtensionInput([
+ coreExtensionData.routePath,
+ coreExtensionData.routeRef.optional(),
+ coreExtensionData.reactElement,
+ ]),
},
+ output: [coreExtensionData.reactElement],
factory({ inputs }) {
const Routes = () => {
const NotFoundErrorPage = useComponentRef(
@@ -46,8 +44,8 @@ export const AppRoutes = createExtension({
const element = useRoutes([
...inputs.routes.map(route => ({
- path: `${route.output.path}/*`,
- element: route.output.element,
+ path: `${route.get(coreExtensionData.routePath)}/*`,
+ element: route.get(coreExtensionData.reactElement),
})),
{
path: '*',
@@ -58,8 +56,6 @@ export const AppRoutes = createExtension({
return element;
};
- return {
- element: []) {
- const plugin = createPlugin({
+ const plugin = createFrontendPlugin({
id: 'test',
extensions,
});
diff --git a/packages/frontend-app-api/src/tree/createAppTree.test.ts b/packages/frontend-app-api/src/tree/createAppTree.test.ts
index 9ee58fe2d2..f5df5270cd 100644
--- a/packages/frontend-app-api/src/tree/createAppTree.test.ts
+++ b/packages/frontend-app-api/src/tree/createAppTree.test.ts
@@ -17,7 +17,7 @@
import {
createExtension,
createExtensionOverrides,
- createPlugin,
+ createFrontendPlugin,
} from '@backstage/frontend-plugin-api';
import { MockConfigApi } from '@backstage/test-utils';
import { createAppTree } from './createAppTree';
@@ -25,8 +25,8 @@ import { createAppTree } from './createAppTree';
const extBase = {
id: 'test',
attachTo: { id: 'app', input: 'root' },
- output: {},
- factory: () => ({}),
+ output: [],
+ factory: () => [],
};
describe('createAppTree', () => {
@@ -41,7 +41,7 @@ describe('createAppTree', () => {
},
});
const features = [
- createPlugin({
+ createFrontendPlugin({
id: 'plugin',
extensions: [],
}),
@@ -60,8 +60,8 @@ describe('createAppTree', () => {
name: 'app',
attachTo: { id: 'app/routes', input: 'route' },
inputs: {},
- output: {},
- factory: () => ({}),
+ output: [],
+ factory: () => [],
}),
],
}),
diff --git a/packages/frontend-app-api/src/tree/instantiateAppNodeTree.test.ts b/packages/frontend-app-api/src/tree/instantiateAppNodeTree.test.ts
index de8889daf0..b8acb6643d 100644
--- a/packages/frontend-app-api/src/tree/instantiateAppNodeTree.test.ts
+++ b/packages/frontend-app-api/src/tree/instantiateAppNodeTree.test.ts
@@ -15,14 +15,15 @@
*/
import {
+ AnyExtensionDataRef,
AppNode,
Extension,
ExtensionInput,
+ PortableSchema,
ResolvedExtensionInput,
createExtension,
createExtensionDataRef,
createExtensionInput,
- createSchemaFromZod,
} from '@backstage/frontend-plugin-api';
import {
createAppNodeInstance,
@@ -31,7 +32,12 @@ import {
import { AppNodeSpec } from '@backstage/frontend-plugin-api';
import { resolveAppTree } from './resolveAppTree';
// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { resolveExtensionDefinition } from '../../../frontend-plugin-api/src/wiring/resolveExtensionDefinition';
+import {
+ InternalExtension,
+ resolveExtensionDefinition,
+} from '../../../frontend-plugin-api/src/wiring/resolveExtensionDefinition';
+// eslint-disable-next-line @backstage/no-relative-monorepo-imports
+import { createSchemaFromZod } from '../../../frontend-plugin-api/src/schema/createSchemaFromZod';
import { withLogCollector } from '@backstage/test-utils';
const testDataRef = createExtensionDataRef().with({ id: 'test' });
@@ -68,7 +74,7 @@ function makeNode(
function makeInstanceWithId(
extension: Extension,
- config?: TConfig,
+ config?: TConfigInput,
): AppNode {
const node = makeNode(extension, { config });
return {
@@ -80,28 +86,63 @@ function makeInstanceWithId(
};
}
+function createV1ExtensionInput(
+ extensionData: Record,
+ options: { singleton?: boolean; optional?: boolean } = {},
+) {
+ return {
+ $$type: '@backstage/ExtensionInput' as const,
+ extensionData,
+ config: {
+ singleton: options.singleton ?? false,
+ optional: options.optional ?? false,
+ },
+ };
+}
+
+function createV1Extension(opts: {
+ namespace: string;
+ name?: string;
+ attachTo?: { id: string; input: string };
+ inputs?: Record>;
+ output: Record;
+ configSchema?: PortableSchema;
+ factory: (ctx: { inputs: any; config: any }) => any;
+}): Extension {
+ const ext: InternalExtension = {
+ $$type: '@backstage/Extension',
+ version: 'v1',
+ id: opts.name ? `${opts.namespace}/${opts.name}` : opts.namespace,
+ disabled: false,
+ attachTo: opts.attachTo ?? { id: 'ignored', input: 'ignored' },
+ inputs: opts.inputs ?? {},
+ output: opts.output,
+ configSchema: opts.configSchema,
+ factory: opts.factory,
+ };
+ return ext;
+}
+
describe('instantiateAppNodeTree', () => {
describe('v1', () => {
- const simpleExtension = resolveExtensionDefinition(
- createExtension({
- namespace: 'app',
- name: 'test',
- attachTo: { id: 'ignored', input: 'ignored' },
- output: {
- test: testDataRef,
- other: otherDataRef.optional(),
- },
- configSchema: createSchemaFromZod(z =>
- z.object({
- output: z.string().default('test'),
- other: z.number().optional(),
- }),
- ),
- factory({ config }) {
- return { test: config.output, other: config.other };
- },
- }),
- );
+ const simpleExtension = createV1Extension({
+ namespace: 'app',
+ name: 'test',
+ attachTo: { id: 'ignored', input: 'ignored' },
+ output: {
+ test: testDataRef,
+ other: otherDataRef.optional(),
+ },
+ configSchema: createSchemaFromZod(z =>
+ z.object({
+ output: z.string().default('test'),
+ other: z.number().optional(),
+ }),
+ ),
+ factory({ config }) {
+ return { test: config.output, other: config.other };
+ },
+ });
it('should instantiate a single node', () => {
const tree = resolveAppTree('root-node', [
@@ -129,21 +170,19 @@ describe('instantiateAppNodeTree', () => {
it('should instantiate a node with attachments', () => {
const tree = resolveAppTree('root-node', [
makeSpec(
- resolveExtensionDefinition(
- createExtension({
- namespace: 'root-node',
- attachTo: { id: 'ignored', input: 'ignored' },
- inputs: {
- test: createExtensionInput({ test: testDataRef }),
- },
- output: {
- inputMirror: inputMirrorDataRef,
- },
- factory({ inputs }) {
- return { inputMirror: inputs };
- },
- }),
- ),
+ createV1Extension({
+ namespace: 'root-node',
+ attachTo: { id: 'ignored', input: 'ignored' },
+ inputs: {
+ test: createV1ExtensionInput({ test: testDataRef }),
+ },
+ output: {
+ inputMirror: inputMirrorDataRef,
+ },
+ factory({ inputs }) {
+ return { inputMirror: inputs };
+ },
+ }),
),
makeSpec(simpleExtension, {
id: 'child-node',
@@ -175,21 +214,19 @@ describe('instantiateAppNodeTree', () => {
const tree = resolveAppTree('root-node', [
{
...makeSpec(
- resolveExtensionDefinition(
- createExtension({
- namespace: 'root-node',
- attachTo: { id: 'ignored', input: 'ignored' },
- inputs: {
- test: createExtensionInput({ test: testDataRef }),
- },
- output: {
- inputMirror: inputMirrorDataRef,
- },
- factory({ inputs }) {
- return { inputMirror: inputs };
- },
- }),
- ),
+ createV1Extension({
+ namespace: 'root-node',
+ attachTo: { id: 'ignored', input: 'ignored' },
+ inputs: {
+ test: createV1ExtensionInput({ test: testDataRef }),
+ },
+ output: {
+ inputMirror: inputMirrorDataRef,
+ },
+ factory({ inputs }) {
+ return { inputMirror: inputs };
+ },
+ }),
),
},
{
@@ -262,46 +299,44 @@ describe('instantiateAppNodeTree', () => {
const instance = createAppNodeInstance({
attachments,
node: makeNode(
- resolveExtensionDefinition(
- createExtension({
- namespace: 'app',
- name: 'test',
- attachTo: { id: 'ignored', input: 'ignored' },
- inputs: {
- optionalSingletonPresent: createExtensionInput(
- {
- test: testDataRef,
- other: otherDataRef.optional(),
- },
- { singleton: true, optional: true },
- ),
- optionalSingletonMissing: createExtensionInput(
- {
- test: testDataRef,
- other: otherDataRef.optional(),
- },
- { singleton: true, optional: true },
- ),
- singleton: createExtensionInput(
- {
- test: testDataRef,
- other: otherDataRef.optional(),
- },
- { singleton: true },
- ),
- many: createExtensionInput({
+ createV1Extension({
+ namespace: 'app',
+ name: 'test',
+ attachTo: { id: 'ignored', input: 'ignored' },
+ inputs: {
+ optionalSingletonPresent: createV1ExtensionInput(
+ {
test: testDataRef,
other: otherDataRef.optional(),
- }),
- },
- output: {
- inputMirror: inputMirrorDataRef,
- },
- factory({ inputs }) {
- return { inputMirror: inputs };
- },
- }),
- ),
+ },
+ { singleton: true, optional: true },
+ ),
+ optionalSingletonMissing: createV1ExtensionInput(
+ {
+ test: testDataRef,
+ other: otherDataRef.optional(),
+ },
+ { singleton: true, optional: true },
+ ),
+ singleton: createV1ExtensionInput(
+ {
+ test: testDataRef,
+ other: otherDataRef.optional(),
+ },
+ { singleton: true },
+ ),
+ many: createV1ExtensionInput({
+ test: testDataRef,
+ other: otherDataRef.optional(),
+ }),
+ },
+ output: {
+ inputMirror: inputMirrorDataRef,
+ },
+ factory({ inputs }) {
+ return { inputMirror: inputs };
+ },
+ }),
),
});
@@ -344,19 +379,17 @@ describe('instantiateAppNodeTree', () => {
expect(() =>
createAppNodeInstance({
node: makeNode(
- resolveExtensionDefinition(
- createExtension({
- namespace: 'app',
- name: 'test',
- attachTo: { id: 'ignored', input: 'ignored' },
- output: {},
- factory() {
- const error = new Error('NOPE');
- error.name = 'NopeError';
- throw error;
- },
- }),
- ),
+ createV1Extension({
+ namespace: 'app',
+ name: 'test',
+ attachTo: { id: 'ignored', input: 'ignored' },
+ output: {},
+ factory() {
+ const error = new Error('NOPE');
+ error.name = 'NopeError';
+ throw error;
+ },
+ }),
),
attachments: new Map(),
}),
@@ -369,20 +402,18 @@ describe('instantiateAppNodeTree', () => {
expect(() =>
createAppNodeInstance({
node: makeNode(
- resolveExtensionDefinition(
- createExtension({
- namespace: 'app',
- name: 'test',
- attachTo: { id: 'ignored', input: 'ignored' },
- output: {
- test1: testDataRef,
- test2: testDataRef,
- },
- factory({}) {
- return { test1: 'test', test2: 'test2' };
- },
- }),
- ),
+ createV1Extension({
+ namespace: 'app',
+ name: 'test',
+ attachTo: { id: 'ignored', input: 'ignored' },
+ output: {
+ test1: testDataRef,
+ test2: testDataRef,
+ },
+ factory({}) {
+ return { test1: 'test', test2: 'test2' };
+ },
+ }),
),
attachments: new Map(),
}),
@@ -395,19 +426,17 @@ describe('instantiateAppNodeTree', () => {
expect(() =>
createAppNodeInstance({
node: makeNode(
- resolveExtensionDefinition(
- createExtension({
- namespace: 'app',
- name: 'test',
- attachTo: { id: 'ignored', input: 'ignored' },
- output: {
- test: testDataRef,
- },
- factory({}) {
- return { nonexistent: 'test' } as any;
- },
- }),
- ),
+ createV1Extension({
+ namespace: 'app',
+ name: 'test',
+ attachTo: { id: 'ignored', input: 'ignored' },
+ output: {
+ test: testDataRef,
+ },
+ factory({}) {
+ return { nonexistent: 'test' } as any;
+ },
+ }),
),
attachments: new Map(),
}),
@@ -420,23 +449,21 @@ describe('instantiateAppNodeTree', () => {
expect(() =>
createAppNodeInstance({
node: makeNode(
- resolveExtensionDefinition(
- createExtension({
- namespace: 'app',
- name: 'test',
- attachTo: { id: 'ignored', input: 'ignored' },
- inputs: {
- singleton: createExtensionInput(
- {
- test: testDataRef,
- },
- { singleton: true },
- ),
- },
- output: {},
- factory: () => ({}),
- }),
- ),
+ createV1Extension({
+ namespace: 'app',
+ name: 'test',
+ attachTo: { id: 'ignored', input: 'ignored' },
+ inputs: {
+ singleton: createV1ExtensionInput(
+ {
+ test: testDataRef,
+ },
+ { singleton: true },
+ ),
+ },
+ output: {},
+ factory: () => ({}),
+ }),
),
attachments: new Map(),
}),
@@ -467,20 +494,18 @@ describe('instantiateAppNodeTree', () => {
],
]),
node: makeNode(
- resolveExtensionDefinition(
- createExtension({
- namespace: 'app',
- name: 'parent',
- attachTo: { id: 'ignored', input: 'ignored' },
- inputs: {
- declared: createExtensionInput({
- test: testDataRef,
- }),
- },
- output: {},
- factory: () => ({}),
- }),
- ),
+ createV1Extension({
+ namespace: 'app',
+ name: 'parent',
+ attachTo: { id: 'ignored', input: 'ignored' },
+ inputs: {
+ declared: createV1ExtensionInput({
+ test: testDataRef,
+ }),
+ },
+ output: {},
+ factory: () => ({}),
+ }),
),
}),
);
@@ -507,15 +532,13 @@ describe('instantiateAppNodeTree', () => {
],
]),
node: makeNode(
- resolveExtensionDefinition(
- createExtension({
- namespace: 'app',
- name: 'parent',
- attachTo: { id: 'ignored', input: 'ignored' },
- output: {},
- factory: () => ({}),
- }),
- ),
+ createV1Extension({
+ namespace: 'app',
+ name: 'parent',
+ attachTo: { id: 'ignored', input: 'ignored' },
+ output: {},
+ factory: () => ({}),
+ }),
),
}),
);
@@ -539,23 +562,21 @@ describe('instantiateAppNodeTree', () => {
],
]),
node: makeNode(
- resolveExtensionDefinition(
- createExtension({
- namespace: 'app',
- name: 'test',
- attachTo: { id: 'ignored', input: 'ignored' },
- inputs: {
- singleton: createExtensionInput(
- {
- test: testDataRef,
- },
- { singleton: true },
- ),
- },
- output: {},
- factory: () => ({}),
- }),
- ),
+ createV1Extension({
+ namespace: 'app',
+ name: 'test',
+ attachTo: { id: 'ignored', input: 'ignored' },
+ inputs: {
+ singleton: createV1ExtensionInput(
+ {
+ test: testDataRef,
+ },
+ { singleton: true },
+ ),
+ },
+ output: {},
+ factory: () => ({}),
+ }),
),
}),
).toThrow(
@@ -576,23 +597,21 @@ describe('instantiateAppNodeTree', () => {
],
]),
node: makeNode(
- resolveExtensionDefinition(
- createExtension({
- namespace: 'app',
- name: 'test',
- attachTo: { id: 'ignored', input: 'ignored' },
- inputs: {
- singleton: createExtensionInput(
- {
- test: testDataRef,
- },
- { singleton: true, optional: true },
- ),
- },
- output: {},
- factory: () => ({}),
- }),
- ),
+ createV1Extension({
+ namespace: 'app',
+ name: 'test',
+ attachTo: { id: 'ignored', input: 'ignored' },
+ inputs: {
+ singleton: createV1ExtensionInput(
+ {
+ test: testDataRef,
+ },
+ { singleton: true, optional: true },
+ ),
+ },
+ output: {},
+ factory: () => ({}),
+ }),
),
}),
).toThrow(
@@ -607,23 +626,21 @@ describe('instantiateAppNodeTree', () => {
['singleton', [makeInstanceWithId(simpleExtension, undefined)]],
]),
node: makeNode(
- resolveExtensionDefinition(
- createExtension({
- namespace: 'app',
- name: 'test',
- attachTo: { id: 'ignored', input: 'ignored' },
- inputs: {
- singleton: createExtensionInput(
- {
- other: otherDataRef,
- },
- { singleton: true },
- ),
- },
- output: {},
- factory: () => ({}),
- }),
- ),
+ createV1Extension({
+ namespace: 'app',
+ name: 'test',
+ attachTo: { id: 'ignored', input: 'ignored' },
+ inputs: {
+ singleton: createV1ExtensionInput(
+ {
+ other: otherDataRef,
+ },
+ { singleton: true },
+ ),
+ },
+ output: {},
+ factory: () => ({}),
+ }),
),
}),
).toThrowErrorMatchingInlineSnapshot(
@@ -640,12 +657,12 @@ describe('instantiateAppNodeTree', () => {
name: 'test',
attachTo: { id: 'ignored', input: 'ignored' },
output: [testDataRef, otherDataRef.optional()],
- configSchema: createSchemaFromZod(z =>
- z.object({
- output: z.string().default('test'),
- other: z.number().optional(),
- }),
- ),
+ config: {
+ schema: {
+ output: z => z.string().default('test'),
+ other: z => z.number().optional(),
+ },
+ },
factory({ config }) {
return [
testDataRef(config.output),
diff --git a/packages/frontend-app-api/src/tree/instantiateAppNodeTree.ts b/packages/frontend-app-api/src/tree/instantiateAppNodeTree.ts
index 65626e0be1..fd8d324652 100644
--- a/packages/frontend-app-api/src/tree/instantiateAppNodeTree.ts
+++ b/packages/frontend-app-api/src/tree/instantiateAppNodeTree.ts
@@ -15,9 +15,7 @@
*/
import {
- AnyExtensionDataMap,
AnyExtensionDataRef,
- AnyExtensionInputMap,
ExtensionDataContainer,
ExtensionDataRef,
ExtensionInput,
@@ -32,8 +30,10 @@ type Mutable = {
-readonly [P in keyof T]: T[P];
};
-function resolveInputDataMap(
- dataMap: AnyExtensionDataMap,
+function resolveV1InputDataMap(
+ dataMap: {
+ [name in string]: AnyExtensionDataRef;
+ },
attachment: AppNode,
inputName: string,
) {
@@ -92,6 +92,16 @@ function resolveInputDataContainer(
get(ref) {
return dataMap.get(ref.id);
},
+ *[Symbol.iterator]() {
+ for (const [id, value] of dataMap) {
+ // TODO: Would be better to be able to create a new instance using the ref here instead
+ yield {
+ $$type: '@backstage/ExtensionDataValue',
+ id,
+ value,
+ };
+ }
+ },
} as { node: AppNode } & ExtensionDataContainer;
}
@@ -124,9 +134,17 @@ function reportUndeclaredAttachments(
}
function resolveV1Inputs(
- inputMap: AnyExtensionInputMap,
+ inputMap: {
+ [inputName in string]: {
+ $$type: '@backstage/ExtensionInput';
+ extensionData: {
+ [name in string]: AnyExtensionDataRef;
+ };
+ config: { optional: boolean; singleton: boolean };
+ };
+ },
attachments: ReadonlyMap,
-): ResolvedExtensionInputs {
+) {
return mapValues(inputMap, (input, inputName) => {
const attachedNodes = attachments.get(inputName) ?? [];
@@ -148,7 +166,7 @@ function resolveV1Inputs(
}
return {
node: attachedNodes[0],
- output: resolveInputDataMap(
+ output: resolveV1InputDataMap(
input.extensionData,
attachedNodes[0],
inputName,
@@ -158,9 +176,16 @@ function resolveV1Inputs(
return attachedNodes.map(attachment => ({
node: attachment,
- output: resolveInputDataMap(input.extensionData, attachment, inputName),
+ output: resolveV1InputDataMap(input.extensionData, attachment, inputName),
}));
- }) as ResolvedExtensionInputs;
+ }) as {
+ [inputName in string]: {
+ node: AppNode;
+ output: {
+ [name in string]: unknown;
+ };
+ };
+ };
}
function resolveV2Inputs(
diff --git a/packages/frontend-app-api/src/tree/resolveAppNodeSpecs.test.ts b/packages/frontend-app-api/src/tree/resolveAppNodeSpecs.test.ts
index 8af2aef070..a732b327b6 100644
--- a/packages/frontend-app-api/src/tree/resolveAppNodeSpecs.test.ts
+++ b/packages/frontend-app-api/src/tree/resolveAppNodeSpecs.test.ts
@@ -16,7 +16,7 @@
import {
createExtensionOverrides,
- createPlugin,
+ createFrontendPlugin,
Extension,
ExtensionDefinition,
} from '@backstage/frontend-plugin-api';
@@ -48,6 +48,7 @@ function makeExtDef(
name,
attachTo: { id: attachId, input: 'default' },
disabled: status === 'disabled',
+ override: () => ({} as ExtensionDefinition),
} as ExtensionDefinition;
}
@@ -97,7 +98,10 @@ describe('resolveAppNodeSpecs', () => {
it('should override attachment points', () => {
const b = makeExt('b');
- const pluginA = createPlugin({ id: 'test', extensions: [makeExtDef('a')] });
+ const pluginA = createFrontendPlugin({
+ id: 'test',
+ extensions: [makeExtDef('a')],
+ });
expect(
resolveAppNodeSpecs({
features: [pluginA],
@@ -129,7 +133,7 @@ describe('resolveAppNodeSpecs', () => {
it('should fully override configuration and duplicate', () => {
const a = makeExt('test/a');
const b = makeExt('test/b');
- const plugin = createPlugin({
+ const plugin = createFrontendPlugin({
id: 'test',
extensions: [makeExtDef('a'), makeExtDef('b')],
});
@@ -177,7 +181,7 @@ describe('resolveAppNodeSpecs', () => {
const b = makeExt('b', 'disabled');
expect(
resolveAppNodeSpecs({
- features: [createPlugin({ id: 'empty', extensions: [] })],
+ features: [createFrontendPlugin({ id: 'empty', extensions: [] })],
builtinExtensions: [a, b],
parameters: [
{
@@ -216,7 +220,7 @@ describe('resolveAppNodeSpecs', () => {
const g = makeExt('g', 'disabled');
expect(
resolveAppNodeSpecs({
- features: [createPlugin({ id: 'empty', extensions: [] })],
+ features: [createFrontendPlugin({ id: 'empty', extensions: [] })],
builtinExtensions: [a, b, c, d, e, f, g],
parameters: [
{ id: 'e', disabled: false },
@@ -271,7 +275,7 @@ describe('resolveAppNodeSpecs', () => {
});
it('should apply extension overrides', () => {
- const plugin = createPlugin({
+ const plugin = createFrontendPlugin({
id: 'test',
extensions: [makeExtDef('a'), makeExtDef('b')],
});
@@ -322,7 +326,7 @@ describe('resolveAppNodeSpecs', () => {
it('should use order from configuration when rather than overrides', () => {
const result = resolveAppNodeSpecs({
features: [
- createPlugin({
+ createFrontendPlugin({
id: 'test',
extensions: [
makeExtDef('a', 'disabled'),
@@ -356,7 +360,10 @@ describe('resolveAppNodeSpecs', () => {
expect(() =>
resolveAppNodeSpecs({
features: [
- createPlugin({ id: 'test', extensions: [makeExtDef('forbidden')] }),
+ createFrontendPlugin({
+ id: 'test',
+ extensions: [makeExtDef('forbidden')],
+ }),
],
builtinExtensions: [],
parameters: [],
diff --git a/packages/frontend-app-api/src/tree/resolveAppNodeSpecs.ts b/packages/frontend-app-api/src/tree/resolveAppNodeSpecs.ts
index e31c70025d..0560066f6b 100644
--- a/packages/frontend-app-api/src/tree/resolveAppNodeSpecs.ts
+++ b/packages/frontend-app-api/src/tree/resolveAppNodeSpecs.ts
@@ -25,7 +25,7 @@ import { toInternalExtensionOverrides } from '../../../frontend-plugin-api/src/w
import { ExtensionParameters } from './readAppExtensionsConfig';
import { AppNodeSpec } from '@backstage/frontend-plugin-api';
// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { toInternalBackstagePlugin } from '../../../frontend-plugin-api/src/wiring/createPlugin';
+import { toInternalBackstagePlugin } from '../../../frontend-plugin-api/src/wiring/createFrontendPlugin';
// eslint-disable-next-line @backstage/no-relative-monorepo-imports
import { toInternalExtension } from '../../../frontend-plugin-api/src/wiring/resolveExtensionDefinition';
diff --git a/packages/frontend-app-api/src/tree/resolveAppTree.test.ts b/packages/frontend-app-api/src/tree/resolveAppTree.test.ts
index d9b65555fe..740f05d5f7 100644
--- a/packages/frontend-app-api/src/tree/resolveAppTree.test.ts
+++ b/packages/frontend-app-api/src/tree/resolveAppTree.test.ts
@@ -23,8 +23,8 @@ const extension = resolveExtensionDefinition(
createExtension({
name: 'test',
attachTo: { id: 'nonexistent', input: 'nonexistent' },
- output: {},
- factory: () => ({}),
+ output: [],
+ factory: () => [],
}),
) as Extension;
diff --git a/packages/frontend-app-api/src/wiring/createApp.test.tsx b/packages/frontend-app-api/src/wiring/createApp.test.tsx
index 94254a2e01..c79d8eed76 100644
--- a/packages/frontend-app-api/src/wiring/createApp.test.tsx
+++ b/packages/frontend-app-api/src/wiring/createApp.test.tsx
@@ -20,9 +20,9 @@ import {
coreExtensionData,
createExtension,
createExtensionOverrides,
- createPageExtension,
- createPlugin,
- createThemeExtension,
+ PageBlueprint,
+ createFrontendPlugin,
+ ThemeBlueprint,
} from '@backstage/frontend-plugin-api';
import { screen, waitFor } from '@testing-library/react';
import { CreateAppFeatureLoader, createApp } from './createApp';
@@ -44,14 +44,19 @@ describe('createApp', () => {
}),
}),
features: [
- createPlugin({
+ createFrontendPlugin({
id: 'test',
extensions: [
- createThemeExtension({
- id: 'derp',
- title: 'Derp',
- variant: 'dark',
- Provider: () =>
);
};
- return { element:
+ op
+ {page1Link && (
+
- );
- };
- return
+ Page 1
+
+ )}
- Page 1
+ Home
+
+
+ GraphiQL
+
+
+ Search
+
+
+ Settings
- )}
-
- Home
-
- GraphiQL
-
-
- Search
-
-
- Settings
-
-
-
- );
- };
- return This is page 1
- {indexLink && Go back} - Page 2 - {/* Page 2 */} - {xLink && Page X} + params: { + defaultPath: '/page1', + routeRef: page1RouteRef, + loader: async () => { + const Component = () => { + const indexLink = useRouteRef(indexRouteRef); + const xLink = useRouteRef(externalPageXRouteRef); + // const page2Link = useRouteRef(page2RouteRef); + return (
- Sub-page content:
+
- This is page 1
+ {indexLink && Go back} + Page 2 + {/* Page 2 */} + {xLink && Page X} +
-
- This is also page 1} />
- This is page 2} />
-
+ Sub-page content:
+
+
+ This is also page 1} />
+ This is page 2} />
+
+
-
- );
- };
- return This is page X
- {indexLink && Go back} -
+
+ );
+ };
+ return This is page X
+ {indexLink && Go back} +Hello
,
+ }),
+ );
+
+ const converted = convertLegacyPageExtension(LegacyExtension);
+ expect(converted.kind).toBe('page');
+ expect(converted.namespace).toBe(undefined);
+ expect(converted.name).toBe('example');
+
+ const tester = createExtensionTester(converted);
+
+ await renderInTestApp(tester.reactElement(), {
+ mountedRoutes: {
+ '/': convertLegacyRouteRef(routeRef),
+ },
+ });
+
+ await expect(screen.findByText('Hello')).resolves.toBeInTheDocument();
+
+ expect(tester.get(coreExtensionData.routePath)).toBe('/example');
+ expect(tester.get(coreExtensionData.routeRef)).toBe(routeRef);
+ });
+
+ it('should convert a page extension with overrides', async () => {
+ const LegacyExtension = legacyPlugin.provide(
+ createRoutableExtension({
+ name: 'ExamplePage',
+ mountPoint: routeRef,
+ component: async () => () => Hello
,
+ }),
+ );
+
+ const converted = convertLegacyPageExtension(LegacyExtension, {
+ name: 'other',
+ defaultPath: '/other',
+ });
+ expect(converted.kind).toBe('page');
+ expect(converted.namespace).toBe(undefined);
+ expect(converted.name).toBe('other');
+
+ const tester = createExtensionTester(converted);
+
+ await renderInTestApp(tester.reactElement(), {
+ mountedRoutes: {
+ '/': convertLegacyRouteRef(routeRef),
+ },
+ });
+
+ await expect(screen.findByText('Hello')).resolves.toBeInTheDocument();
+
+ expect(tester.get(coreExtensionData.routePath)).toBe('/other');
+ expect(tester.get(coreExtensionData.routeRef)).toBe(routeRef);
+ });
+});
diff --git a/packages/core-compat-api/src/convertLegacyPageExtension.tsx b/packages/core-compat-api/src/convertLegacyPageExtension.tsx
new file mode 100644
index 0000000000..7ef4e0faff
--- /dev/null
+++ b/packages/core-compat-api/src/convertLegacyPageExtension.tsx
@@ -0,0 +1,64 @@
+/*
+ * 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 {
+ getComponentData,
+ RouteRef as LegacyRouteRef,
+} from '@backstage/core-plugin-api';
+import {
+ ExtensionDefinition,
+ PageBlueprint,
+} from '@backstage/frontend-plugin-api';
+import kebabCase from 'lodash/kebabCase';
+import { convertLegacyRouteRef } from './convertLegacyRouteRef';
+import { ComponentType } from 'react';
+import React from 'react';
+import { compatWrapper } from './compatWrapper';
+
+/** @public */
+export function convertLegacyPageExtension(
+ LegacyExtension: ComponentType<{}>,
+ overrides?: {
+ name?: string;
+ defaultPath?: string;
+ },
+): ExtensionDefinitionroot
,
- };
- },
+ output: [coreExtensionData.reactElement],
+ factory: () => [coreExtensionData.reactElement(root
)],
}),
],
});
diff --git a/packages/frontend-app-api/src/extensions/App.tsx b/packages/frontend-app-api/src/extensions/App.tsx
index 7794aceb79..ba6c5f65f1 100644
--- a/packages/frontend-app-api/src/extensions/App.tsx
+++ b/packages/frontend-app-api/src/extensions/App.tsx
@@ -18,51 +18,38 @@ import React from 'react';
import {
ExtensionBoundary,
coreExtensionData,
- createApiExtension,
createComponentExtension,
createExtension,
createExtensionInput,
- createThemeExtension,
- createTranslationExtension,
IconBundleBlueprint,
+ ThemeBlueprint,
+ ApiBlueprint,
+ TranslationBlueprint,
} from '@backstage/frontend-plugin-api';
export const App = createExtension({
namespace: 'app',
attachTo: { id: 'root', input: 'default' }, // ignored
inputs: {
- apis: createExtensionInput({
- api: createApiExtension.factoryDataRef,
+ apis: createExtensionInput([ApiBlueprint.dataRefs.factory]),
+ themes: createExtensionInput([ThemeBlueprint.dataRefs.theme]),
+ components: createExtensionInput([
+ createComponentExtension.componentDataRef,
+ ]),
+ translations: createExtensionInput([
+ TranslationBlueprint.dataRefs.translation,
+ ]),
+ icons: createExtensionInput([IconBundleBlueprint.dataRefs.icons]),
+ root: createExtensionInput([coreExtensionData.reactElement], {
+ singleton: true,
}),
- themes: createExtensionInput({
- theme: createThemeExtension.themeDataRef,
- }),
- components: createExtensionInput({
- component: createComponentExtension.componentDataRef,
- }),
- translations: createExtensionInput({
- translation: createTranslationExtension.translationDataRef,
- }),
- icons: createExtensionInput({
- icon: IconBundleBlueprint.dataRefs.icons,
- }),
- root: createExtensionInput(
- {
- element: coreExtensionData.reactElement,
- },
- { singleton: true },
+ },
+ output: [coreExtensionData.reactElement],
+ factory: ({ node, inputs }) => [
+ coreExtensionData.reactElement(
+ Derp
,
+ ThemeBlueprint.make({
+ name: 'derp',
+ params: {
+ theme: {
+ id: 'derp',
+ title: 'Derp',
+ variant: 'dark',
+ Provider: () => Derp
,
+ },
+ },
}),
],
}),
@@ -68,21 +73,25 @@ describe('createApp', () => {
const app = createApp({
configLoader: async () => ({ config: new MockConfigApi({}) }),
features: [
- createPlugin({
+ createFrontendPlugin({
id: duplicatedFeatureId,
extensions: [
- createPageExtension({
- defaultPath: '/',
- loader: async () => First Page
,
+ PageBlueprint.make({
+ params: {
+ defaultPath: '/',
+ loader: async () => First Page
,
+ },
}),
],
}),
- createPlugin({
+ createFrontendPlugin({
id: duplicatedFeatureId,
extensions: [
- createPageExtension({
- defaultPath: '/',
- loader: async () => Last Page
,
+ PageBlueprint.make({
+ params: {
+ defaultPath: '/',
+ loader: async () => Last Page
,
+ },
}),
],
}),
@@ -107,12 +116,14 @@ describe('createApp', () => {
async load({ config }) {
return {
features: [
- createPlugin({
+ createFrontendPlugin({
id: 'test',
extensions: [
- createPageExtension({
- defaultPath: '/',
- loader: async () => {config.getString('key')}
,
+ PageBlueprint.make({
+ params: {
+ defaultPath: '/',
+ loader: async () => {config.getString('key')}
,
+ },
}),
],
}),
@@ -163,14 +174,14 @@ describe('createApp', () => {
const app = createApp({
configLoader: async () => ({ config: new MockConfigApi({}) }),
features: [
- createPlugin({
+ createFrontendPlugin({
id: 'test',
featureFlags: [{ name: 'test-1' }],
extensions: [
createExtension({
name: 'first',
attachTo: { id: 'app', input: 'root' },
- output: { element: coreExtensionData.reactElement },
+ output: [coreExtensionData.reactElement],
factory() {
const Component = () => {
const flagsApi = useApi(featureFlagsApiRef);
@@ -184,7 +195,7 @@ describe('createApp', () => {
My Plugin Page
;
- };
- return My Plugin Page
;
+ };
+ return {params.text}
)]; + }, + }); + + // create an instance of the extension blueprint with params + const testExtension = EntityCardBlueprint.make({ + name: 'foo', + params: { + text: 'Hello World', + }, + }); + ``` + +- 9b89b82: The `ExtensionBoundary` now by default infers whether it's routable from whether it outputs a route path. +- e493020: Deprecated `inputs` and `configSchema` options for `createComponentExtenion`, these will be removed in a future release +- 7777b5f: Added a new `IconBundleBlueprint` that lets you create icon bundle extensions that can be installed in an App in order to override or add new app icons. + + ```tsx + import { IconBundleBlueprint } from '@backstage/frontend-plugin-api'; + + const exampleIconBundle = IconBundleBlueprint.make({ + name: 'example-bundle', + params: { + icons: { + user: MyOwnUserIcon, + }, + }, + }); + ``` + +- 99abb6b: Support overriding of plugin extensions using the new `plugin.withOverrides` method. + + ```tsx + import homePlugin from '@backstage/plugin-home'; + + export default homePlugin.withOverrides({ + extensions: [ + homePage.getExtension('page:home').override({ + *factory(originalFactory) { + yield* originalFactory(); + yield coreExtensionData.reactElement(My custom home page
); + }, + }), + ], + }); + ``` + +- 813cac4: Add an `ExtensionBoundary.lazy` function to create properly wrapped lazy-loading enabled elements, suitable for use with `coreExtensionData.reactElement`. The page blueprint now automatically leverages this. +- a65cfc8: Add support for accessing extensions definitions provided by a plugin via `plugin.getExtension(...)`. For this to work the extensions must be defined using the v2 format, typically using an extension blueprint. +- 3be9aeb: Extensions have been changed to be declared with an array of inputs and outputs, rather than a map of named data refs. This change was made to reduce confusion around the role of the input and output names, as well as enable more powerful APIs for overriding extensions. + + An extension that was previously declared like this: + + ```tsx + const exampleExtension = createExtension({ + name: 'example', + inputs: { + items: createExtensionInput({ + element: coreExtensionData.reactElement, + }), + }, + output: { + element: coreExtensionData.reactElement, + }, + factory({ inputs }) { + return { + element: ( +
+ Example
+ {inputs.items.map(item => {
+ return
+ ),
+ };
+ },
+ });
+ ```
+
+ Should be migrated to the following:
+
+ ```tsx
+ const exampleExtension = createExtension({
+ name: 'example',
+ inputs: {
+ items: createExtensionInput([coreExtensionData.reactElement]),
+ },
+ output: [coreExtensionData.reactElement],
+ factory({ inputs }) {
+ return [
+ coreExtensionData.reactElement(
+ {item.output.element}
;
+ })}
+
+ Example
+ {inputs.items.map(item => {
+ return
,
+ ),
+ ];
+ },
+ });
+ ```
+
+- 34f1b2a: Support merging of `inputs` in extension blueprints, but stop merging `output`. In addition, the original factory in extension blueprints now returns a data container that both provides access to the returned data, but can also be forwarded as output.
+- 3fb421d: Added support to be able to define `zod` config schema in Blueprints, with built in schema merging from the Blueprint and the extension instances.
+- 2d21599: Added support for being able to override extension definitions.
+
+ ```tsx
+ const TestCard = EntityCardBlueprint.make({
+ ...
+ });
+
+ TestCard.override({
+ // override attachment points
+ attachTo: { id: 'something-else', input: 'overridden' },
+ // extend the config schema
+ config: {
+ schema: {
+ newConfig: z => z.string().optional(),
+ }
+ },
+ // override factory
+ *factory(originalFactory, { inputs, config }){
+ const originalOutput = originalFactory();
+
+ yield coreExentsionData.reactElement(
+ {item.get(coreExtensionData.reactElement)}
;
+ })}
+ My custom home page
); + }, + }), + ], + }); + ``` + +- a65cfc8: Add support for accessing extensions definitions provided by a plugin via `plugin.getExtension(...)`. For this to work the extensions must be defined using the v2 format, typically using an extension blueprint. +- 34f1b2a: Support merging of `inputs` in extension blueprints, but stop merging `output`. In addition, the original factory in extension blueprints now returns a data container that both provides access to the returned data, but can also be forwarded as output. +- 2d21599: Added support for being able to override extension definitions. + + ```tsx + const TestCard = EntityCardBlueprint.make({ + ... + }); + + TestCard.override({ + // override attachment points + attachTo: { id: 'something-else', input: 'overridden' }, + // extend the config schema + config: { + schema: { + newConfig: z => z.string().optional(), + } + }, + // override factory + *factory(originalFactory, { inputs, config }){ + const originalOutput = originalFactory(); + + yield coreExentsionData.reactElement( +Hello
,
+ },
+ });
+
+ expect(extension).toMatchInlineSnapshot(`
+ {
+ "$$type": "@backstage/ExtensionDefinition",
+ "attachTo": {
+ "id": "app/root",
+ "input": "wrappers",
+ },
+ "configSchema": undefined,
+ "disabled": false,
+ "factory": [Function],
+ "inputs": {},
+ "kind": "app-root-wrapper",
+ "name": undefined,
+ "namespace": undefined,
+ "output": [
+ [Function],
+ ],
+ "override": [Function],
+ "toString": [Function],
+ "version": "v2",
+ }
+ `);
+ });
+
+ it('should render the simple component wrapper', async () => {
+ const extension = AppRootWrapperBlueprint.make({
+ params: {
+ Component: () => Hello
,
+ },
+ });
+
+ const { getByText } = createExtensionTester(
+ PageBlueprint.make({
+ params: {
+ defaultPath: '/',
+ loader: async () => ,
+ },
+ }),
+ )
+ .add(extension)
+ .render();
+
+ await waitFor(() => expect(getByText('Hello')).toBeInTheDocument());
+ });
+
+ it('should render the complex component wrapper', async () => {
+ const extension = AppRootWrapperBlueprint.makeWithOverrides({
+ namespace: 'ns',
+ name: 'test',
+ config: {
+ schema: {
+ name: z => z.string(),
+ },
+ },
+ inputs: {
+ children: createExtensionInput([coreExtensionData.reactElement]),
+ },
+ *factory(originalFactory, { inputs, config }) {
+ yield* originalFactory({
+ Component: ({ children }) => (
+
+ {children}
+ {inputs.children.flatMap(c =>
+ c.get(coreExtensionData.reactElement),
+ )}
+
+ ),
+ });
+ },
+ });
+
+ const { getByText, getByTestId } = createExtensionTester(
+ PageBlueprint.make({
+ params: {
+ defaultPath: '/',
+ loader: async () => Hi
,
+ },
+ }),
+ )
+ .add(extension, { config: { name: 'Robin' } })
+ .add(
+ createExtension({
+ attachTo: { id: 'app-root-wrapper:ns/test', input: 'children' },
+ output: [coreExtensionData.reactElement],
+ factory: () => [coreExtensionData.reactElement(Its Me
)],
+ }),
+ )
+ .render();
+
+ await waitFor(() => {
+ expect(getByText('Hi')).toBeInTheDocument();
+ expect(getByTestId('Robin-1')).toBeInTheDocument();
+ expect(getByText('Its Me')).toBeInTheDocument();
+ });
+ });
+});
diff --git a/packages/frontend-plugin-api/src/blueprints/AppRootWrapperBlueprint.tsx b/packages/frontend-plugin-api/src/blueprints/AppRootWrapperBlueprint.tsx
new file mode 100644
index 0000000000..da11bd8cb0
--- /dev/null
+++ b/packages/frontend-plugin-api/src/blueprints/AppRootWrapperBlueprint.tsx
@@ -0,0 +1,47 @@
+/*
+ * 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 { ComponentType, PropsWithChildren } from 'react';
+import { createExtensionBlueprint, createExtensionDataRef } from '../wiring';
+
+const componentDataRef = createExtensionDataRef<
+ ComponentTypeLogo Full
,
+ logoIcon: Logo Icon
,
+ },
+ });
+
+ expect(extension).toMatchInlineSnapshot(`
+ {
+ "$$type": "@backstage/ExtensionDefinition",
+ "attachTo": {
+ "id": "app/nav",
+ "input": "logos",
+ },
+ "configSchema": undefined,
+ "disabled": false,
+ "factory": [Function],
+ "inputs": {},
+ "kind": "nav-logo",
+ "name": undefined,
+ "namespace": undefined,
+ "output": [
+ [Function],
+ ],
+ "override": [Function],
+ "toString": [Function],
+ "version": "v2",
+ }
+ `);
+ });
+
+ it('should return a valid component ref', () => {
+ const logoFull = Logo Full
;
+ const logoIcon = Logo Icon
;
+
+ const extension = NavLogoBlueprint.make({
+ name: 'test',
+ params: {
+ logoFull,
+ logoIcon,
+ },
+ });
+
+ const tester = createExtensionTester(extension);
+
+ expect(tester.get(NavLogoBlueprint.dataRefs.logoElements)).toEqual({
+ logoFull,
+ logoIcon,
+ });
+ });
+});
diff --git a/packages/frontend-plugin-api/src/blueprints/NavLogoBlueprint.ts b/packages/frontend-plugin-api/src/blueprints/NavLogoBlueprint.ts
new file mode 100644
index 0000000000..4a37859975
--- /dev/null
+++ b/packages/frontend-plugin-api/src/blueprints/NavLogoBlueprint.ts
@@ -0,0 +1,48 @@
+/*
+ * 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 { createExtensionBlueprint, createExtensionDataRef } from '../wiring';
+
+const logoElementsDataRef = createExtensionDataRef<{
+ logoIcon?: JSX.Element;
+ logoFull?: JSX.Element;
+}>().with({ id: 'core.nav-logo.logo-elements' });
+
+/**
+ * Creates an extension that replaces the logo in the nav bar with your own.
+ *
+ * @public
+ */
+export const NavLogoBlueprint = createExtensionBlueprint({
+ kind: 'nav-logo',
+ attachTo: { id: 'app/nav', input: 'logos' },
+ output: [logoElementsDataRef],
+ dataRefs: {
+ logoElements: logoElementsDataRef,
+ },
+ *factory({
+ logoIcon,
+ logoFull,
+ }: {
+ logoIcon: JSX.Element;
+ logoFull: JSX.Element;
+ }) {
+ yield logoElementsDataRef({
+ logoIcon,
+ logoFull,
+ });
+ },
+});
diff --git a/packages/frontend-plugin-api/src/blueprints/PageBlueprint.test.tsx b/packages/frontend-plugin-api/src/blueprints/PageBlueprint.test.tsx
new file mode 100644
index 0000000000..dedc5454bd
--- /dev/null
+++ b/packages/frontend-plugin-api/src/blueprints/PageBlueprint.test.tsx
@@ -0,0 +1,157 @@
+/*
+ * 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 { createRouteRef } from '../routing';
+import { PageBlueprint } from './PageBlueprint';
+import {
+ createExtensionTester,
+ renderInTestApp,
+} from '@backstage/frontend-test-utils';
+import {
+ coreExtensionData,
+ createExtensionBlueprint,
+ createExtensionInput,
+} from '../wiring';
+import { waitFor } from '@testing-library/react';
+
+describe('PageBlueprint', () => {
+ const mockRouteRef = createRouteRef();
+
+ it('should return an extension when calling make with sensible defaults', () => {
+ const myPage = PageBlueprint.make({
+ name: 'test-page',
+ params: {
+ loader: () => Promise.resolve(Test
),
+ defaultPath: '/test',
+ routeRef: mockRouteRef,
+ },
+ });
+
+ expect(myPage).toMatchInlineSnapshot(`
+ {
+ "$$type": "@backstage/ExtensionDefinition",
+ "attachTo": {
+ "id": "app/routes",
+ "input": "routes",
+ },
+ "configSchema": {
+ "parse": [Function],
+ "schema": {
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "additionalProperties": false,
+ "properties": {
+ "path": {
+ "type": "string",
+ },
+ },
+ "type": "object",
+ },
+ },
+ "disabled": false,
+ "factory": [Function],
+ "inputs": {},
+ "kind": "page",
+ "name": "test-page",
+ "namespace": undefined,
+ "output": [
+ [Function],
+ [Function],
+ {
+ "$$type": "@backstage/ExtensionDataRef",
+ "config": {
+ "optional": true,
+ },
+ "id": "core.routing.ref",
+ "optional": [Function],
+ "toString": [Function],
+ },
+ ],
+ "override": [Function],
+ "toString": [Function],
+ "version": "v2",
+ }
+ `);
+ });
+
+ it('should output a routeRef with the input routeRef', async () => {
+ const myPage = PageBlueprint.make({
+ name: 'test-page',
+ params: {
+ loader: () => Promise.resolve(Test
),
+ defaultPath: '/test',
+ routeRef: mockRouteRef,
+ },
+ });
+
+ const tester = createExtensionTester(myPage);
+
+ // TODO(blam): test for the routePath output doesn't work, due to the the way the test harness works
+ // expect(tester.data(coreExtensionData.routePath)).toBe('/test');
+
+ expect(tester.get(coreExtensionData.routeRef)).toBe(mockRouteRef);
+
+ const { getByTestId } = tester.render();
+
+ await waitFor(() => expect(getByTestId('test')).toBeInTheDocument());
+ });
+
+ it('should allow defining additional inputs to the extension', async () => {
+ const myPage = PageBlueprint.makeWithOverrides({
+ name: 'test-page',
+ inputs: {
+ cards: createExtensionInput([coreExtensionData.reactElement], {
+ optional: false,
+ singleton: false,
+ }),
+ },
+ factory(originalFactory, { inputs }) {
+ return originalFactory({
+ loader: async () => (
+
+ {inputs.cards.map(c => c.get(coreExtensionData.reactElement))}
+
+ ),
+ defaultPath: '/test',
+ routeRef: mockRouteRef,
+ });
+ },
+ });
+
+ const CardBlueprint = createExtensionBlueprint({
+ kind: 'card',
+ attachTo: { id: 'page:test-page', input: 'cards' },
+ output: [coreExtensionData.reactElement],
+ factory() {
+ return [
+ coreExtensionData.reactElement(
+ I'm a lovely card
,
+ ),
+ ];
+ },
+ });
+
+ const tester = createExtensionTester(myPage).add(
+ CardBlueprint.make({ name: 'card', params: {} }),
+ );
+
+ const { getByTestId, getByText } = renderInTestApp(tester.reactElement());
+
+ await waitFor(() => expect(getByTestId('card')).toBeInTheDocument());
+ await waitFor(() =>
+ expect(getByText("I'm a lovely card")).toBeInTheDocument(),
+ );
+ });
+});
diff --git a/packages/frontend-plugin-api/src/blueprints/PageBlueprint.tsx b/packages/frontend-plugin-api/src/blueprints/PageBlueprint.tsx
new file mode 100644
index 0000000000..303e99daaa
--- /dev/null
+++ b/packages/frontend-plugin-api/src/blueprints/PageBlueprint.tsx
@@ -0,0 +1,57 @@
+/*
+ * 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 { RouteRef } from '../routing';
+import { coreExtensionData, createExtensionBlueprint } from '../wiring';
+import { ExtensionBoundary } from '../components';
+
+/**
+ * Createx extensions that are routable React page components.
+ *
+ * @public
+ */
+export const PageBlueprint = createExtensionBlueprint({
+ kind: 'page',
+ attachTo: { id: 'app/routes', input: 'routes' },
+ output: [
+ coreExtensionData.routePath,
+ coreExtensionData.reactElement,
+ coreExtensionData.routeRef.optional(),
+ ],
+ config: {
+ schema: {
+ path: z => z.string().optional(),
+ },
+ },
+ *factory(
+ {
+ defaultPath,
+ loader,
+ routeRef,
+ }: {
+ defaultPath: string;
+ loader: () => Promise{props.children}
,
+ },
+ });
+
+ expect(extension).toMatchInlineSnapshot(`
+ {
+ "$$type": "@backstage/ExtensionDefinition",
+ "attachTo": {
+ "id": "app/root",
+ "input": "router",
+ },
+ "configSchema": undefined,
+ "disabled": false,
+ "factory": [Function],
+ "inputs": {},
+ "kind": "app-router-component",
+ "name": undefined,
+ "namespace": undefined,
+ "output": [
+ [Function],
+ ],
+ "override": [Function],
+ "toString": [Function],
+ "version": "v2",
+ }
+ `);
+ });
+
+ it('should work with simple options', async () => {
+ const extension = RouterBlueprint.make({
+ namespace: 'test',
+ params: {
+ Component: ({ children }) => (
+ {children}
+
+ {children}
+
+ Hello
,
- });
-
- expect(extension).toEqual({
- $$type: '@backstage/ExtensionDefinition',
- version: 'v1',
- kind: 'app-root-element',
- attachTo: { id: 'app/root', input: 'elements' },
- disabled: false,
- inputs: {},
- output: {
- element: expect.anything(),
- },
- factory: expect.any(Function),
- toString: expect.any(Function),
- });
-
- createExtensionTester(extension).render();
-
- await expect(screen.findByText('Hello')).resolves.toBeInTheDocument();
- });
-
- it('works with complex options and a callback', async () => {
- const schema = createSchemaFromZod(z => z.object({ name: z.string() }));
-
- const extension = createAppRootElementExtension({
- namespace: 'ns',
- name: 'test',
- configSchema: schema,
- attachTo: { id: 'other', input: 'slot' },
- disabled: true,
- inputs: {
- children: createExtensionInput({
- element: coreExtensionData.reactElement,
- }),
- },
- element: ({ inputs, config }) => (
-
- Hello, {config.name}, {inputs.children.length}
-
- ),
- });
-
- expect(extension).toEqual({
- $$type: '@backstage/ExtensionDefinition',
- version: 'v1',
- kind: 'app-root-element',
- namespace: 'ns',
- name: 'test',
- attachTo: { id: 'other', input: 'slot' },
- configSchema: schema,
- disabled: true,
- inputs: {
- children: createExtensionInput({
- element: coreExtensionData.reactElement,
- }),
- },
- output: {
- element: expect.anything(),
- },
- factory: expect.any(Function),
- toString: expect.any(Function),
- });
-
- createExtensionTester(extension, { config: { name: 'Robin' } })
- .add(
- createExtension({
- attachTo: { id: 'app-root-element:ns/test', input: 'children' },
- output: { element: coreExtensionData.reactElement },
- factory: () => ({ element: }),
- }),
- )
- .render();
-
- await expect(
- screen.findByText('Hello, Robin, 1'),
- ).resolves.toBeInTheDocument();
- });
-});
diff --git a/packages/frontend-plugin-api/src/extensions/createAppRootElementExtension.ts b/packages/frontend-plugin-api/src/extensions/createAppRootElementExtension.ts
deleted file mode 100644
index 8be82d5540..0000000000
--- a/packages/frontend-plugin-api/src/extensions/createAppRootElementExtension.ts
+++ /dev/null
@@ -1,71 +0,0 @@
-/*
- * Copyright 2023 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 { JSX } from 'react';
-import { PortableSchema } from '../schema/types';
-import { Expand } from '../types';
-import { coreExtensionData } from '../wiring/coreExtensionData';
-import {
- AnyExtensionInputMap,
- ExtensionDefinition,
- ResolvedExtensionInputs,
- createExtension,
-} from '../wiring/createExtension';
-
-/**
- * Creates an extension that renders a React element at the app root, outside of
- * the app layout. This is useful for example for shared popups and similar.
- *
- * @public
- */
-export function createAppRootElementExtension<
- TConfig extends {},
- TInputs extends AnyExtensionInputMap,
->(options: {
- namespace?: string;
- name?: string;
- attachTo?: { id: string; input: string };
- configSchema?: PortableSchemaHello
,
- });
-
- expect(extension).toEqual({
- $$type: '@backstage/ExtensionDefinition',
- version: 'v1',
- kind: 'app-root-wrapper',
- attachTo: { id: 'app/root', input: 'wrappers' },
- disabled: false,
- inputs: {},
- output: {
- component: expect.anything(),
- },
- factory: expect.any(Function),
- toString: expect.any(Function),
- });
-
- createExtensionTester(
- createPageExtension({
- defaultPath: '/',
- loader: async () => ,
- }),
- )
- .add(extension)
- .render();
-
- await expect(screen.findByText('Hello')).resolves.toBeInTheDocument();
- });
-
- it('works with complex options and props', async () => {
- const schema = createSchemaFromZod(z => z.object({ name: z.string() }));
-
- const extension = createAppRootWrapperExtension({
- namespace: 'ns',
- name: 'test',
- configSchema: schema,
- disabled: true,
- inputs: {
- children: createExtensionInput({
- element: coreExtensionData.reactElement,
- }),
- },
- Component: ({ inputs, config, children }) => (
-
- {children}
-
- ),
- });
-
- expect(extension).toEqual({
- $$type: '@backstage/ExtensionDefinition',
- version: 'v1',
- kind: 'app-root-wrapper',
- namespace: 'ns',
- name: 'test',
- attachTo: { id: 'app/root', input: 'wrappers' },
- configSchema: schema,
- disabled: true,
- inputs: {
- children: createExtensionInput({
- element: coreExtensionData.reactElement,
- }),
- },
- output: {
- component: expect.anything(),
- },
- factory: expect.any(Function),
- toString: expect.any(Function),
- });
-
- createExtensionTester(
- createPageExtension({
- defaultPath: '/',
- loader: async () => Hello
,
- }),
- )
- .add(extension, { config: { name: 'Robin' } })
- .add(
- createExtension({
- attachTo: { id: 'app-root-wrapper:ns/test', input: 'children' },
- output: { element: coreExtensionData.reactElement },
- factory: () => ({ element: }),
- }),
- )
- .render();
-
- await expect(screen.findByText('Hello')).resolves.toBeInTheDocument();
- await expect(screen.findByTestId('Robin-1')).resolves.toBeInTheDocument();
- });
-});
diff --git a/packages/frontend-plugin-api/src/extensions/createAppRootWrapperExtension.tsx b/packages/frontend-plugin-api/src/extensions/createAppRootWrapperExtension.tsx
deleted file mode 100644
index ce2eb89f25..0000000000
--- a/packages/frontend-plugin-api/src/extensions/createAppRootWrapperExtension.tsx
+++ /dev/null
@@ -1,83 +0,0 @@
-/*
- * Copyright 2023 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, { ComponentType, PropsWithChildren } from 'react';
-import { PortableSchema } from '../schema/types';
-import {
- AnyExtensionInputMap,
- ExtensionDefinition,
- ResolvedExtensionInputs,
- createExtension,
-} from '../wiring/createExtension';
-import { createExtensionDataRef } from '../wiring/createExtensionDataRef';
-import { Expand } from '../types';
-
-/**
- * Creates an extension that renders a React wrapper at the app root, enclosing
- * the app layout. This is useful for example for adding global React contexts
- * and similar.
- *
- * @public
- */
-export function createAppRootWrapperExtension<
- TConfig extends {},
- TInputs extends AnyExtensionInputMap,
->(options: {
- namespace?: string;
- name?: string;
- attachTo?: { id: string; input: string };
- configSchema?: PortableSchemaLogo Full
,
- logoIcon: Logo Icon
,
- }),
- ).toEqual({
- $$type: '@backstage/ExtensionDefinition',
- version: 'v1',
- kind: 'nav-logo',
- name: 'test',
- attachTo: { id: 'app/nav', input: 'logos' },
- disabled: false,
- inputs: {},
- output: {
- logos: expect.anything(),
- },
- factory: expect.any(Function),
- toString: expect.any(Function),
- });
- });
-});
diff --git a/packages/frontend-plugin-api/src/extensions/createNavLogoExtension.tsx b/packages/frontend-plugin-api/src/extensions/createNavLogoExtension.tsx
deleted file mode 100644
index 1f2419bd02..0000000000
--- a/packages/frontend-plugin-api/src/extensions/createNavLogoExtension.tsx
+++ /dev/null
@@ -1,55 +0,0 @@
-/*
- * Copyright 2023 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 { createExtension, createExtensionDataRef } from '../wiring';
-
-/**
- * Helper for creating extensions for a nav logos.
- * @public
- */
-export function createNavLogoExtension(options: {
- name?: string;
- namespace?: string;
- logoIcon: JSX.Element;
- logoFull: JSX.Element;
-}) {
- const { logoIcon, logoFull } = options;
- return createExtension({
- kind: 'nav-logo',
- name: options?.name,
- namespace: options?.namespace,
- attachTo: { id: 'app/nav', input: 'logos' },
- output: {
- logos: createNavLogoExtension.logoElementsDataRef,
- },
- factory: () => {
- return {
- logos: {
- logoIcon,
- logoFull,
- },
- };
- },
- });
-}
-
-/** @public */
-export namespace createNavLogoExtension {
- export const logoElementsDataRef = createExtensionDataRef<{
- logoIcon?: JSX.Element;
- logoFull?: JSX.Element;
- }>().with({ id: 'core.nav-logo.logo-elements' });
-}
diff --git a/packages/frontend-plugin-api/src/extensions/createPageExtension.test.tsx b/packages/frontend-plugin-api/src/extensions/createPageExtension.test.tsx
deleted file mode 100644
index 374400fce8..0000000000
--- a/packages/frontend-plugin-api/src/extensions/createPageExtension.test.tsx
+++ /dev/null
@@ -1,142 +0,0 @@
-/*
- * Copyright 2023 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 { useAnalytics } from '@backstage/core-plugin-api';
-import { waitFor } from '@testing-library/react';
-import { PortableSchema } from '../schema';
-import { coreExtensionData, createExtensionInput } from '../wiring';
-import { createPageExtension } from './createPageExtension';
-import { createExtensionTester } from '@backstage/frontend-test-utils';
-
-jest.mock('@backstage/core-plugin-api', () => ({
- ...jest.requireActual('@backstage/core-plugin-api'),
- useAnalytics: jest.fn(),
-}));
-
-describe('createPageExtension', () => {
- it('creates the extension properly', () => {
- const configSchema: PortableSchema<{ path: string }> = {
- parse: jest.fn(),
- schema: {} as any,
- };
-
- expect(
- createPageExtension({
- name: 'test',
- configSchema,
- loader: async () => ,
- }),
- ).toEqual({
- $$type: '@backstage/ExtensionDefinition',
- version: 'v1',
- name: 'test',
- kind: 'page',
- attachTo: { id: 'app/routes', input: 'routes' },
- configSchema: expect.anything(),
- disabled: false,
- inputs: {},
- output: {
- element: expect.anything(),
- path: expect.anything(),
- routeRef: expect.anything(),
- },
- factory: expect.any(Function),
- toString: expect.any(Function),
- });
-
- expect(
- createPageExtension({
- name: 'test',
- attachTo: { id: 'other', input: 'place' },
- disabled: true,
- configSchema,
- inputs: {
- first: createExtensionInput({
- element: coreExtensionData.reactElement,
- }),
- },
- loader: async () => ,
- }),
- ).toEqual({
- $$type: '@backstage/ExtensionDefinition',
- version: 'v1',
- name: 'test',
- kind: 'page',
- attachTo: { id: 'other', input: 'place' },
- configSchema: expect.anything(),
- disabled: true,
- inputs: {
- first: createExtensionInput({
- element: coreExtensionData.reactElement,
- }),
- },
- output: {
- element: expect.anything(),
- path: expect.anything(),
- routeRef: expect.anything(),
- },
- factory: expect.any(Function),
- toString: expect.any(Function),
- });
-
- expect(
- createPageExtension({
- name: 'test',
- defaultPath: '/here',
- loader: async () => ,
- }),
- ).toEqual({
- $$type: '@backstage/ExtensionDefinition',
- version: 'v1',
- name: 'test',
- kind: 'page',
- attachTo: { id: 'app/routes', input: 'routes' },
- configSchema: expect.anything(),
- disabled: false,
- inputs: {},
- output: {
- element: expect.anything(),
- path: expect.anything(),
- routeRef: expect.anything(),
- },
- factory: expect.any(Function),
- toString: expect.any(Function),
- });
- });
-
- it('capture page view event in analytics', async () => {
- const captureEvent = jest.fn();
-
- (useAnalytics as jest.Mock).mockReturnValue({
- captureEvent,
- });
-
- createExtensionTester(
- createPageExtension({
- defaultPath: '/',
- loader: async () => Component
,
- }),
- ).render();
-
- await waitFor(() =>
- expect(captureEvent).toHaveBeenCalledWith(
- '_ROUTABLE-EXTENSION-RENDERED',
- '',
- ),
- );
- });
-});
diff --git a/packages/frontend-plugin-api/src/extensions/createPageExtension.tsx b/packages/frontend-plugin-api/src/extensions/createPageExtension.tsx
deleted file mode 100644
index cd434a3ffc..0000000000
--- a/packages/frontend-plugin-api/src/extensions/createPageExtension.tsx
+++ /dev/null
@@ -1,97 +0,0 @@
-/*
- * Copyright 2023 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, { lazy } from 'react';
-import { ExtensionBoundary } from '../components';
-import { createSchemaFromZod, PortableSchema } from '../schema';
-import {
- coreExtensionData,
- createExtension,
- ResolvedExtensionInputs,
- AnyExtensionInputMap,
-} from '../wiring';
-import { RouteRef } from '../routing';
-import { Expand } from '../types';
-import { ExtensionDefinition } from '../wiring/createExtension';
-
-/**
- * Helper for creating extensions for a routable React page component.
- *
- * @public
- */
-export function createPageExtension<
- TConfig extends { path: string },
- TInputs extends AnyExtensionInputMap,
->(
- options: (
- | {
- defaultPath: string;
- }
- | {
- configSchema: PortableSchema{children}
-
- {children}
-
-