Hello World
,
- });
+ };
},
});
```
@@ -81,24 +85,288 @@ Note that while the `createExtension` is public API and used in many places, it
## Extension Data
-TODO
+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
+
+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:
+
+```ts
+export const reactElementExtensionDataRef =
+ createExtensionDataRefHello World
,
+ };
+ },
+});
+```
+
+### 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`. 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.
+
+```tsx
+const extension = createExtension({
+ // ...
+ output: {
+ // ❌ Bad example - outputting values of same type
+ element1: reactElementExtensionDataRef,
+ element2: reactElementExtensionDataRef,
+ },
+ factory() {
+ return {
+ element1: Hello World
,
+ element2: Hello World
,
+ };
+ },
+});
+```
+
+### 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`.
+
+
+
+### 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(),
+ },
+ factory() {
+ return {
+ element:
+ Math.random() < 0.5 ? 
: undefined,
+ };
+ },
+});
+```
## Extension Inputs
-TODO
+The Extension Data can be passed up to other extensions through their extension inputs. Similar to the outputs seen before, let's create an example an extension with a extension input:
-## Configuration
+```tsx
+const navigationExtension = createExtension({
+ // ...
+ inputs: {
+ // [1]: Input
+ logo: createExtensionInput(
+ {
+ element: coreExtensionData.reactElement,
+ },
+ { singleton: true, optional: true },
+ ),
+ },
+ factory({ inputs }) {
+ return {
+ element: (
+
+ ),
+ };
+ },
+ // ...
+});
+```
-TODO
+The input (see [1] above) is an object that we create using `createExtensionInput`. The first argument is the set of extension data that we accept via this input, and works just like the `output` option. The second argument is optional, and it allows us to put constraints on the extensions that are attached to our input. If the `singleton: true` option is set, only a single extension can attached at a time, and unless the `optional: true` option is set it will also be required that there is exactly on attached extension.
-## Configuration Schema
+So how can we now attach the output to the parent extension's input? If we think about a navigation component, like the Sidebar in Backstage, there might be plugins that want to attach a link to their plugin to this navigation component. In this case the plugin only needs to know the extension `id` and the name of the extension `input` to attach the extension `output` returned by the `factory` to the specified extension:
-TODO
+```tsx
+const navigationItemExtension = createExtension({
+ // ...
+ attachTo: { id: 'app/nav', input: 'items' },
+ factory() {
+ return {
+ element: Home,
+ };
+ },
+});
+
+const navigationExtension = createExtension({
+ // ...
+ // [2]: Extension `id` will be `app/nav` following the extension naming pattern
+ namespace: 'app',
+ name: 'nav',
+ output: {
+ element: coreExtensionData.reactElement,
+ },
+ inputs: {
+ items: createExtensionInput({
+ element: coreExtensionData.reactElement,
+ }),
+ },
+ factory({ inputs }) {
+ return {
+ element: (
+
+ ),
+ };
+ },
+ // ...
+});
+```
+
+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:
+
+```tsx
+ // ...
+ factory({ inputs }) {
+ return {
+ element: (
+
+ ),
+ };
+ },
+```
+
+## 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. Therefor 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:
+
+```tsx
+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'),
+ }),
+ ),
+ factory({ config }) {
+ return {
+ element: (
+
+ ),
+ };
+ },
+ // ...
+});
+```
+
+To now change the text of the title from "Sidebar Title" to "Backstage" we can look at the `id` of the extension & add the following to the `app-config.yaml`:
+
+```yaml
+app:
+ # ...
+ extensions:
+ # ...
+ - app/nav:
+ config:
+ title: 'Backstage'
+```
## Extension Creators
-TODO
+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`.
+
+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. Therefor `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.
+
+```tsx
+export const HomeNavIcon = createNavItemExtension({
+ routeRef: routeRefForTheHomePage,
+ title: 'Home',
+ icon: HomeIcon,
+});
+```
+
+### Extension Kind
+
+With the example `HomeNavIcon` will end up on the extension input `items` of the extensions with the id `app/nav`. It raises the question what the `id` of the `HomeNavIcon` itself is. The extension creator for the navigation item has a defined `kind`, which by convention matches the own name. So in this example `createNavItemExtension` sets the kind to `nav-item`.
+
+The `id` of the extension is then build out of `namespace`, `name` & `kind` like the following - where `namespace` & `name` are optional properties that can be passed to the extension creator:
+
+```
+id: kind:namespace/name
+```
+
+For more information on naming of extension refer to the [naming patterns documentation](./08-naming-patterns.md).
+
+### Extension Creators in libraries
+
+Extension creators should be exported from frontend library packages (e.g. `*-react`) rather than plugin packages.
+
+If an extension is only for in-house tweaks, it's okay to put it in the plugin package. But if you want other open source plugins to use it, or you already have a `-react` package, always put extension creators in the `-react` package.
## Extension Boundary
-TODO
+The `ExtensionBoundary` wraps extensions with several React contexts for different purposes
+
+### Suspense
+
+All React elements rendered by extension creators should be wrapped in the extension boundary. With `Suspense` the extension can than load resources asynchronously with having a loading fallback. It also allows to lazy load the whole extension similar to how plugins are currently lazy loaded in Backstage.
+
+### Error Boundary
+
+Similar to plugins the `ErrorBoundary` for extension allows to pass in a fallback component in case there is an uncaught error inside of the component. With this the error can be isolated & it would prevent the rest of the plugin to crash.
+
+### Analytics
+
+Analytics information are provided through the `AnalyticsContext`, which will give `extensionId` & `pluginId` as context to analytics event fired inside of the extension. Additionally `RouteTracker` will capture an analytics event for routable extension to inform which extension metadata gets associated with a navigation event when the route navigated to is a gathered `mountPoint`.
+
+The `ExtensionBoundary` can be used like the following in an extension creator:
+
+```tsx
+export function createSomeExtension<
+ TConfig extends {},
+ TInputs extends AnyExtensionInputMap,
+>(options): ExtensionDefinition
+
+ );
+};
+```
+
+We use the `useRouteRef` hook to create a link generator function that returns the details page path. We then call the link generator, passing it an object with the kind, namespace, and name. These parameters are used to construct a concrete path to the "Foo" details page.
+
+Let's see how the details page can get the parameters from the URL:
+
+```tsx title="plugins/catalog/src/components/DetailsPage.tsx"
+import React from 'react';
+import { useRouteRefParams } from '@backstage/frontend-plugin-api';
+import { detailsRouteRef } from '../routes';
+
+export const DetailsPage = () => {
+ // highlight-next-line
+ const params = useRouteRefParams(detailsRouteRef);
+ return (
+ Index Page
+ + See "Foo" details + +
+
+ );
+};
+```
+
+In the code above, we are using the `useRouteRefParams` hook to retrieve the entity-composed id from the URL. The parameter object contains three values: kind, namespace, and name. We can display these values or call an API using them.
+
+Since we are linking to pages of the same package, we are using a route ref directly. However, in the following sections, you will see how to link to pages of different plugins.
+
+## External Route References
+
+External routes are made for linking to a page of an external plugin.
+For this section example, let's assume that we want to link from the Catalog entities list page to the Scaffolder create component page.
+
+We don't want to reference the Scaffolder plugin directly, since that would create an unnecessary dependency. It would also provide little flexibility in allowing the app to tie plugins together, with the links instead being dictated by the plugins themselves. To solve this, we use an `ExternalRouteRef`. Much like regular route references, they can be passed to `useRouteRef` to create concrete URLs, but they can not be used in page extensions and instead have to be associated with a target route using route bindings in the app.
+
+We create a new `RouteRef` inside the Scaffolder plugin, using a neutral name that describes its role in the plugin rather than a specific plugin page that it might be linking to, allowing the app to decide the final target. If the Catalog entity list page for example wants to link the Scaffolder create component page in the header, it might declare an `ExternalRouteRef` similar to this:
+
+```tsx title="plugins/catalog/src/routes.ts"
+import { createExternalRouteRef } from '@backstage/frontend-plugin-api';
+
+export const createComponentExternalRouteRef = createExternalRouteRef();
+```
+
+External routes are also used in a similar way as regular routes:
+
+```tsx title="plugins/catalog/src/components/IndexPage.tsx"
+import React from 'react';
+import { useRouteRef } from '@backstage/frontend-plugin-api';
+import { createComponentExternalRouteRef } from '../routes';
+
+export const IndexPage = () => {
+ // highlight-next-line
+ const getCreateComponentPath = useRouteRef(createComponentExternalRouteRef);
+ return (
+ Details Page
+-
+ {/* highlight-start */}
+
- Kind: {params.kind} +
- Namespace: {params.namespace} +
- Name: {params.name} + {/* highlight-end */} +
+
+ );
+};
+```
+
+Given the above binding, using `useRouteRef(createComponentExternalRouteRef)` within the Catalog plugin will let us create a link to whatever path the Scaffolder create component page is mounted at. Note that there is no direct dependency between the Catalog plugin and Scaffolder, that is, we are not importing the `createComponentExternalRouteRef` from the Scaffolder package.
+
+Now the only thing left is to provide the page and external route via a plugin:
+
+```tsx title="plugins/catalog/src/plugin.tsx"
+import React from 'react';
+import {
+ createPlugin,
+ createPageExtension,
+ useRouteRef,
+} from '@backstage/frontend-plugin-api';
+import { indexRouteRef, createComponentExternalRouteRef } from './routes';
+
+const catalogIndexPage = createPageExtension({
+ defaultPath: '/entities',
+ routeRef: indexRouteRef,
+ loader: () => import('./components').then(m => Index Page
+ {/* highlight-next-line */} + Create Component +
+
+ );
+};
+```
+
+## Sub Route References
+
+The last kind of route ref that can be created is a `SubRouteRef`, which can be used to create a route ref with a fixed path relative to an absolute `RouteRef`. They are useful if you have a page that internally is mounted at a sub route of a page extension component, and you want other plugins to be able to route to that page. And they can be a useful utility to handle routing within a plugin itself as well.
+
+For example:
+
+```tsx title ="plugins/catalog/src/routes.ts"
+import {
+ createRouteRef,
+ createSubRouteRef,
+} from '@backstage/frontend-plugin-api';
+
+export const indexRouteRef = createRouteRef();
+// highlight-start
+export const detailsSubRouteRef = createSubRouteRef({
+ parent: indexRouteRef,
+ path: '/details',
+});
+// highlight-end
+```
+
+There are substantial differences between creating subroutes and regular or external routes because subroutes are associated with regular routes, and the sub route path must be specified. The path string must include the parameters if this sub route has them:
+
+```tsx title ="plugins/catalog/src/routes.ts"
+// Omitting rest of the previous example file
+export const detailsSubRouteRef = createSubRouteRef({
+ parent: indexRouteRef,
+ // highlight-next-line
+ path: '/:name/:namespace/:kind',
+});
+```
+
+Using subroutes in a page extension is as simple as this:
+
+```tsx title="plugins/catalog/src/components/IndexPage.ts"
+import React from 'react';
+import { Routes, Route, useLocation } from 'react-router-dom';
+import { useRouteRef } from '@backstage/frontend-plugin-api';
+import { indexRouteRef, detailsSubRouteRef } from '../routes';
+import { DetailsPage } from './DetailsPage';
+
+export const IndexPage = () => {
+ const { pathname } = useLocation();
+ const getIndexPath = useRouteRef(indexRouteRef);
+ const getDetailsPath = useRouteRef(detailsSubRouteRef);
+ return (
+ Index Page
+ {/* Rendering the link only if the getCreateComponentPath is defined */} + {/* highlight-start */} + {getCreateComponentPath && ( + Create Component + )} + {/* highlight-end */} +
+
+
+
+ );
+};
+```
+
+This is how you can get the parameters of a sub route URL:
+
+```tsx title="plugins/catalog/src/components/DetailsPage.ts"
+import React from 'react';
+import { useParams } from 'react-router-dom';
+
+export const DetailsPage = () => {
+ // highlight-next-line
+ const params = useParams();
+ return (
+ Index Page
+ {/* Linking to the details sub route */} + {pathname === getIndexPath() ? ( + // highlight-start + + Show details + + // highlight-end + ) : ( + // highlight-next-line + Hide details + )} + {/* Registering the details sub route */} +
+
+ );
+};
+```
+
+Finally, see how a plugin can provide subroutes:
+
+```tsx title="plugins/catalog/src/plugin.ts"
+import React from 'react';
+import {
+ createPlugin,
+ createPageExtension,
+} from '@backstage/frontend-plugin-api';
+import { indexRouteRef, detailsSubRouteRef } from './routes';
+
+const catalogIndexPage = createPageExtension({
+ defaultPath: '/entities',
+ routeRef: indexRouteRef,
+ loader: () => import('./components').then(m => Details Sub Page
+-
+ {/* highlight-start */}
+
- Kind: {params.kind} +
- Namespace: {params.namespace} +
- Name: {params.name} + {/* highlight-end */} +
+
+ );
+}
+```
+
+```tsx title="in src/plugin.ts - Registering a factory for our API"
+import {
+ createApiFactory,
+ createApiExtension,
+} from '@backstage/frontend-plugin-api';
+import { exampleApiRef, DefaultExampleApi } from './api';
+
+// highlight-add-start
+const exampleApi = createApiExtension({
+ factory: createApiFactory({
+ api: exampleApiRef,
+ deps: {},
+ factory: () => new DefaultExampleApi(),
+ }),
+});
+// highlight-add-end
+
+/* Omitted definitions for examplePage, exampleNavItem, and rootRouteRef. */
+
+export const examplePlugin = createPlugin({
+ id: 'example',
+ extensions: [
+ // highlight-add-next-line
+ exampleApi,
+ examplePage,
+ exampleNavItem,
+ ],
+ routes: {
+ root: rootRouteRef,
+ },
+});
+```
+
+## Plugin specific extensions
+
+There are many different plugins that you can extend with additional functionality through extensions. One such plugin is [the catalog plugin](../../features/software-catalog/), one of the core features of Backstage. It lets you catalog the software in your organization, where each item in the catalog has its own page that can be populated with tools and information relating to that catalog entity. In this example we will explore how our plugin can provide such a tool to display on an entity page.
+
+```tsx title="in src/plugin.ts - An example entity content extension"
+import { createEntityContentExtension } from '@backstage/plugin-catalog-react';
+
+// Entity content extensions are similar to page extensions in that they are rendered at a route,
+// although they also have a title to support in-line navigation between the different content.
+// Just like a page extension the content is lazy loaded, and you can also provide a
+// route reference if you want to be able to generate a URL that links to the content.
+const exampleEntityContent = createEntityContentExtension({
+ defaultPath: 'example',
+ defaultTitle: 'Example',
+ loader: () =>
+ import('./components/ExampleEntityContent').then(m => (
+ Example Page
+Example: {exampleApi.getExample().example}
++Replace: `"@testing-library/react": "^14.0.0"` + +Find: `"@testing-library/react-hooks": ".*",?`
+Replace: `
Copyright © 2023 Backstage Project Authors. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page: https://www.linuxfoundation.org/trademark-usage
', + 'Copyright © 2024 Backstage Project Authors. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page: https://www.linuxfoundation.org/trademark-usage
', }, algolia: { apiKey: '1f0ba86672ccfc3576faa94583e5b318', @@ -287,6 +294,9 @@ module.exports = { }, prism: { theme: prismTheme, + // Supported languages: https://prismjs.com/#supported-languages + // Default languages: https://github.com/FormidableLabs/prism-react-renderer/blob/master/packages/generate-prism-languages/index.ts#L9-L23 + additionalLanguages: ['docker', 'bash'], magicComments: [ // Extend the default highlight class name { diff --git a/microsite/package.json b/microsite/package.json index 61bfcbd04a..53309fb358 100644 --- a/microsite/package.json +++ b/microsite/package.json @@ -6,6 +6,7 @@ "scripts": { "start": "node scripts/pre-build.js && docusaurus start", "build": "node scripts/pre-build.js && docusaurus build", + "prettier:fix": "prettier --write .", "prettier:check": "prettier --check .", "publish-gh-pages": "docusaurus-publish", "write-translations": "docusaurus-write-translations", @@ -33,7 +34,7 @@ "@docusaurus/plugin-client-redirects": "0.0.0-5703", "@docusaurus/preset-classic": "0.0.0-5703", "@swc/core": "^1.3.46", - "clsx": "^1.1.1", + "clsx": "^2.0.0", "docusaurus-plugin-sass": "^0.2.3", "luxon": "^3.0.0", "prism-react-renderer": "^1.3.5", diff --git a/microsite/sidebars.json b/microsite/sidebars.json index c9b1c99eba..e32e027807 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -1,6 +1,8 @@ { "releases": { "Release Notes": [ + "releases/v1.22.0", + "releases/v1.21.0", "releases/v1.20.0", "releases/v1.19.0", "releases/v1.18.0", @@ -248,6 +250,15 @@ "plugins/internationalization", "plugins/analytics", "plugins/feature-flags", + { + "type": "category", + "label": "OpenAPI", + "items": [ + "openapi/01-getting-started", + "openapi/generate-client", + "openapi/test-case-validation" + ] + }, { "type": "category", "label": "Backends and APIs", @@ -380,6 +391,44 @@ "items": ["backend-system/core-services/index"] } ], + "New Frontend System": [ + "frontend-system/index", + { + "type": "category", + "label": "Architecture", + "items": [ + "frontend-system/architecture/index", + "frontend-system/architecture/app", + "frontend-system/architecture/extensions", + "frontend-system/architecture/plugins", + "frontend-system/architecture/extension-overrides", + "frontend-system/architecture/utility-apis", + "frontend-system/architecture/routes", + "frontend-system/architecture/naming-patterns", + "frontend-system/architecture/references" + ] + }, + { + "type": "category", + "label": "Building Plugins", + "items": [ + "frontend-system/building-plugins/index", + "frontend-system/building-plugins/testing", + "frontend-system/building-plugins/extension-types" + ] + }, + { + "type": "category", + "label": "Utility APIs", + "items": [ + "frontend-system/utility-apis/index", + "frontend-system/utility-apis/creating", + "frontend-system/utility-apis/consuming", + "frontend-system/utility-apis/configuring", + "frontend-system/utility-apis/migrating" + ] + } + ], "Designing for Backstage": [ "dls/design", "dls/component-design-guidelines", @@ -403,12 +452,15 @@ "tutorials/journey", "tutorials/quickstart-app-plugin", "tutorials/react-router-stable-migration", + "tutorials/react18-migration", "tutorials/package-role-migration", "tutorials/migrating-away-from-core", "tutorials/configuring-plugin-databases", "tutorials/switching-sqlite-postgres", "tutorials/using-backstage-proxy-within-plugin", - "tutorials/yarn-migration" + "tutorials/yarn-migration", + "tutorials/migrate-to-mui5", + "tutorials/setup-opentelemetry" ], "Architecture Decision Records (ADRs)": [ "architecture-decisions/adrs-overview", @@ -426,7 +478,7 @@ "architecture-decisions/adrs-adr012", "architecture-decisions/adrs-adr013" ], - "FAQ": ["FAQ"], + "FAQ": ["faq/index", "faq/product", "faq/technical"], "Accessibility": ["accessibility/index"] } } diff --git a/microsite/src/pages/community/index.tsx b/microsite/src/pages/community/index.tsx index 82dd69d1a0..9b10183ea4 100644 --- a/microsite/src/pages/community/index.tsx +++ b/microsite/src/pages/community/index.tsx @@ -110,6 +110,11 @@ const Community = () => { url: 'https://frontside.com/backstage/', logo: 'img/partner-logo-frontside.png', }, + { + name: 'RedHat', + url: 'https://www.redhat.com/', + logo: 'img/partner-logo-redhat.png', + }, { name: 'Roadie', url: 'https://roadie.io/', diff --git a/microsite/src/pages/home/_home.tsx b/microsite/src/pages/home/_home.tsx index ddcfed7d03..5cf0f85072 100644 --- a/microsite/src/pages/home/_home.tsx +++ b/microsite/src/pages/home/_home.tsx @@ -95,10 +95,12 @@ const HomePage = () => {
diff --git a/microsite/src/pages/home/hubSpotNewAdoptersForm.module.scss b/microsite/src/pages/home/hubSpotNewAdoptersForm.module.scss
index 77e1a87a53..9533890660 100644
--- a/microsite/src/pages/home/hubSpotNewAdoptersForm.module.scss
+++ b/microsite/src/pages/home/hubSpotNewAdoptersForm.module.scss
@@ -1,9 +1,13 @@
+$page-header-height: 44px;
+
.hubSpotNewAdopterFormContainer {
top: 50%;
right: 0;
display: flex;
position: fixed;
transform: translateY(-50%);
+ margin-top: $page-header-height;
+ max-height: calc(100% - $page-header-height);
transition: all 250ms ease-in-out;
@@ -22,9 +26,7 @@
}
.hubSpotNewAdopterFormContent {
- height: 600px;
max-width: 500px;
- overflow-y: hidden;
border-radius: 8px 0 0 8px;
background-color: var(--ifm-color-white);
diff --git a/microsite/src/pages/plugins/index.tsx b/microsite/src/pages/plugins/index.tsx
index 006b7d4807..2abdbabf4b 100644
--- a/microsite/src/pages/plugins/index.tsx
+++ b/microsite/src/pages/plugins/index.tsx
@@ -151,6 +151,12 @@ const Plugins = () => {
{showOtherPlugins && (
All Plugins
++ Friendly reminder: While we love the variety and contributions of + our open source plugins, they haven't been fully vetted by the + core Backstage team. We encourage you to exercise caution and do + your due diligence before installing. Happy exploring! +
{plugins.otherPlugins
.filter(
diff --git a/microsite/src/pages/plugins/plugins.module.scss b/microsite/src/pages/plugins/plugins.module.scss
index 80ac60cf98..dbd0c62c75 100644
--- a/microsite/src/pages/plugins/plugins.module.scss
+++ b/microsite/src/pages/plugins/plugins.module.scss
@@ -78,6 +78,8 @@
:global(.dropdown) {
float: right;
margin-bottom: 1rem;
+ text-overflow: ellipsis;
+ white-space: nowrap;
}
:global(.button--info) {
diff --git a/microsite/src/theme/customTheme.scss b/microsite/src/theme/customTheme.scss
index f216762418..57e1f8828e 100644
--- a/microsite/src/theme/customTheme.scss
+++ b/microsite/src/theme/customTheme.scss
@@ -8,6 +8,14 @@
--ifm-color-primary-darkest: #268271;
}
+#__docusaurus {
+ .theme-doc-markdown {
+ a {
+ text-decoration: underline;
+ }
+ }
+}
+
.footerLogo {
background-image: url(/img/logo.svg);
background-repeat: no-repeat;
diff --git a/microsite/static/img/azure-storage-folder.png b/microsite/static/img/azure-storage-folder.png
new file mode 100644
index 0000000000..479340c5b3
Binary files /dev/null and b/microsite/static/img/azure-storage-folder.png differ
diff --git a/microsite/static/img/backchat-logo.png b/microsite/static/img/backchat-logo.png
new file mode 100644
index 0000000000..2d58948007
Binary files /dev/null and b/microsite/static/img/backchat-logo.png differ
diff --git a/microsite/static/img/dqicon.png b/microsite/static/img/dqicon.png
new file mode 100644
index 0000000000..3746841cd8
Binary files /dev/null and b/microsite/static/img/dqicon.png differ
diff --git a/microsite/static/img/hcp-consul.svg b/microsite/static/img/hcp-consul.svg
new file mode 100644
index 0000000000..d84972585c
--- /dev/null
+++ b/microsite/static/img/hcp-consul.svg
@@ -0,0 +1,17 @@
+
diff --git a/microsite/static/img/nobl9.svg b/microsite/static/img/nobl9.svg
new file mode 100644
index 0000000000..a4065df602
--- /dev/null
+++ b/microsite/static/img/nobl9.svg
@@ -0,0 +1,4 @@
+
diff --git a/microsite/static/img/open-dora-icon.png b/microsite/static/img/open-dora-icon.png
new file mode 100644
index 0000000000..3612fb06af
Binary files /dev/null and b/microsite/static/img/open-dora-icon.png differ
diff --git a/microsite/static/img/partner-logo-redhat.png b/microsite/static/img/partner-logo-redhat.png
new file mode 100644
index 0000000000..ad9bc9ceba
Binary files /dev/null and b/microsite/static/img/partner-logo-redhat.png differ
diff --git a/microsite/yarn.lock b/microsite/yarn.lock
index 10ad6d0d68..5c92ba5e69 100644
--- a/microsite/yarn.lock
+++ b/microsite/yarn.lock
@@ -2701,90 +2701,90 @@ __metadata:
languageName: node
linkType: hard
-"@swc/core-darwin-arm64@npm:1.3.96":
- version: 1.3.96
- resolution: "@swc/core-darwin-arm64@npm:1.3.96"
+"@swc/core-darwin-arm64@npm:1.3.105":
+ version: 1.3.105
+ resolution: "@swc/core-darwin-arm64@npm:1.3.105"
conditions: os=darwin & cpu=arm64
languageName: node
linkType: hard
-"@swc/core-darwin-x64@npm:1.3.96":
- version: 1.3.96
- resolution: "@swc/core-darwin-x64@npm:1.3.96"
+"@swc/core-darwin-x64@npm:1.3.105":
+ version: 1.3.105
+ resolution: "@swc/core-darwin-x64@npm:1.3.105"
conditions: os=darwin & cpu=x64
languageName: node
linkType: hard
-"@swc/core-linux-arm-gnueabihf@npm:1.3.96":
- version: 1.3.96
- resolution: "@swc/core-linux-arm-gnueabihf@npm:1.3.96"
+"@swc/core-linux-arm-gnueabihf@npm:1.3.105":
+ version: 1.3.105
+ resolution: "@swc/core-linux-arm-gnueabihf@npm:1.3.105"
conditions: os=linux & cpu=arm
languageName: node
linkType: hard
-"@swc/core-linux-arm64-gnu@npm:1.3.96":
- version: 1.3.96
- resolution: "@swc/core-linux-arm64-gnu@npm:1.3.96"
+"@swc/core-linux-arm64-gnu@npm:1.3.105":
+ version: 1.3.105
+ resolution: "@swc/core-linux-arm64-gnu@npm:1.3.105"
conditions: os=linux & cpu=arm64 & libc=glibc
languageName: node
linkType: hard
-"@swc/core-linux-arm64-musl@npm:1.3.96":
- version: 1.3.96
- resolution: "@swc/core-linux-arm64-musl@npm:1.3.96"
+"@swc/core-linux-arm64-musl@npm:1.3.105":
+ version: 1.3.105
+ resolution: "@swc/core-linux-arm64-musl@npm:1.3.105"
conditions: os=linux & cpu=arm64 & libc=musl
languageName: node
linkType: hard
-"@swc/core-linux-x64-gnu@npm:1.3.96":
- version: 1.3.96
- resolution: "@swc/core-linux-x64-gnu@npm:1.3.96"
+"@swc/core-linux-x64-gnu@npm:1.3.105":
+ version: 1.3.105
+ resolution: "@swc/core-linux-x64-gnu@npm:1.3.105"
conditions: os=linux & cpu=x64 & libc=glibc
languageName: node
linkType: hard
-"@swc/core-linux-x64-musl@npm:1.3.96":
- version: 1.3.96
- resolution: "@swc/core-linux-x64-musl@npm:1.3.96"
+"@swc/core-linux-x64-musl@npm:1.3.105":
+ version: 1.3.105
+ resolution: "@swc/core-linux-x64-musl@npm:1.3.105"
conditions: os=linux & cpu=x64 & libc=musl
languageName: node
linkType: hard
-"@swc/core-win32-arm64-msvc@npm:1.3.96":
- version: 1.3.96
- resolution: "@swc/core-win32-arm64-msvc@npm:1.3.96"
+"@swc/core-win32-arm64-msvc@npm:1.3.105":
+ version: 1.3.105
+ resolution: "@swc/core-win32-arm64-msvc@npm:1.3.105"
conditions: os=win32 & cpu=arm64
languageName: node
linkType: hard
-"@swc/core-win32-ia32-msvc@npm:1.3.96":
- version: 1.3.96
- resolution: "@swc/core-win32-ia32-msvc@npm:1.3.96"
+"@swc/core-win32-ia32-msvc@npm:1.3.105":
+ version: 1.3.105
+ resolution: "@swc/core-win32-ia32-msvc@npm:1.3.105"
conditions: os=win32 & cpu=ia32
languageName: node
linkType: hard
-"@swc/core-win32-x64-msvc@npm:1.3.96":
- version: 1.3.96
- resolution: "@swc/core-win32-x64-msvc@npm:1.3.96"
+"@swc/core-win32-x64-msvc@npm:1.3.105":
+ version: 1.3.105
+ resolution: "@swc/core-win32-x64-msvc@npm:1.3.105"
conditions: os=win32 & cpu=x64
languageName: node
linkType: hard
"@swc/core@npm:^1.3.46":
- version: 1.3.96
- resolution: "@swc/core@npm:1.3.96"
+ version: 1.3.105
+ resolution: "@swc/core@npm:1.3.105"
dependencies:
- "@swc/core-darwin-arm64": 1.3.96
- "@swc/core-darwin-x64": 1.3.96
- "@swc/core-linux-arm-gnueabihf": 1.3.96
- "@swc/core-linux-arm64-gnu": 1.3.96
- "@swc/core-linux-arm64-musl": 1.3.96
- "@swc/core-linux-x64-gnu": 1.3.96
- "@swc/core-linux-x64-musl": 1.3.96
- "@swc/core-win32-arm64-msvc": 1.3.96
- "@swc/core-win32-ia32-msvc": 1.3.96
- "@swc/core-win32-x64-msvc": 1.3.96
+ "@swc/core-darwin-arm64": 1.3.105
+ "@swc/core-darwin-x64": 1.3.105
+ "@swc/core-linux-arm-gnueabihf": 1.3.105
+ "@swc/core-linux-arm64-gnu": 1.3.105
+ "@swc/core-linux-arm64-musl": 1.3.105
+ "@swc/core-linux-x64-gnu": 1.3.105
+ "@swc/core-linux-x64-musl": 1.3.105
+ "@swc/core-win32-arm64-msvc": 1.3.105
+ "@swc/core-win32-ia32-msvc": 1.3.105
+ "@swc/core-win32-x64-msvc": 1.3.105
"@swc/counter": ^0.1.1
"@swc/types": ^0.1.5
peerDependencies:
@@ -2813,7 +2813,7 @@ __metadata:
peerDependenciesMeta:
"@swc/helpers":
optional: true
- checksum: 41d4a4461b2952aaf8d3be945d373d0f3bd126115ee1aad0f76f2690e2b5635b6ec5bb54a7638deb9afedb1ad6f7d8453468a704e54e5fbb8234dd4a43b80205
+ checksum: 5baa880bc92748ef4845d9c65eba5d6dd01adaa673854e20a5116f5e267c12180db50e563cf3c34a415772b9742d021176a9d9a91065c190ef6f54fefe85728c
languageName: node
linkType: hard
@@ -2855,9 +2855,9 @@ __metadata:
linkType: hard
"@tsconfig/docusaurus@npm:^2.0.0":
- version: 2.0.1
- resolution: "@tsconfig/docusaurus@npm:2.0.1"
- checksum: 63bebda70d83c56f95a90176d2e188e1ea9c08c23b499e5e7b292ebfae0ce7117f712809828ed21ae3b8440daf22191d6bf71bf2575f9bd474a51b1770ca30cc
+ version: 2.0.2
+ resolution: "@tsconfig/docusaurus@npm:2.0.2"
+ checksum: 129f2532172496c108f53a15082e410b418e664c1761902664558059541a6cf7faff2b3d2953e2d507a7e3688afacf2479e17adcb35b89cae04ddb0415d0397a
languageName: node
linkType: hard
@@ -3055,9 +3055,9 @@ __metadata:
linkType: hard
"@types/luxon@npm:^3.0.0":
- version: 3.3.4
- resolution: "@types/luxon@npm:3.3.4"
- checksum: aa4862bd62d748e7966f9a0ec76058e9d74397ee426c7d64f61c677d83de0303c303cc78515001833df3f4ad16c95f572b0e2ffaee6e55bc50b80857e8437f3a
+ version: 3.3.8
+ resolution: "@types/luxon@npm:3.3.8"
+ checksum: 026711b4aefc01c6e233e359c693b6d4c0873acc3f52a08661ea3751b2cf3e34d1ce1d5b0b99b0e40a059a2a3755acc20498d37db5f9a5a4f0f330cdf72db3db
languageName: node
linkType: hard
@@ -3897,7 +3897,7 @@ __metadata:
"@tsconfig/docusaurus": ^2.0.0
"@types/luxon": ^3.0.0
"@types/webpack-env": ^1.18.0
- clsx: ^1.1.1
+ clsx: ^2.0.0
docusaurus-plugin-sass: ^0.2.3
js-yaml: ^4.1.0
luxon: ^3.0.0
@@ -4375,13 +4375,20 @@ __metadata:
languageName: node
linkType: hard
-"clsx@npm:^1.1.1, clsx@npm:^1.2.1":
+"clsx@npm:^1.2.1":
version: 1.2.1
resolution: "clsx@npm:1.2.1"
checksum: 30befca8019b2eb7dbad38cff6266cf543091dae2825c856a62a8ccf2c3ab9c2907c4d12b288b73101196767f66812365400a227581484a05f968b0307cfaf12
languageName: node
linkType: hard
+"clsx@npm:^2.0.0":
+ version: 2.1.0
+ resolution: "clsx@npm:2.1.0"
+ checksum: 43fefc29b6b49c9476fbce4f8b1cc75c27b67747738e598e6651dd40d63692135dc60b18fa1c5b78a2a9ba8ae6fd2055a068924b94e20b42039bd53b78b98e1d
+ languageName: node
+ linkType: hard
+
"color-convert@npm:^1.9.0":
version: 1.9.3
resolution: "color-convert@npm:1.9.3"
@@ -5867,12 +5874,12 @@ __metadata:
linkType: hard
"follow-redirects@npm:^1.0.0, follow-redirects@npm:^1.14.9":
- version: 1.15.2
- resolution: "follow-redirects@npm:1.15.2"
+ version: 1.15.4
+ resolution: "follow-redirects@npm:1.15.4"
peerDependenciesMeta:
debug:
optional: true
- checksum: faa66059b66358ba65c234c2f2a37fcec029dc22775f35d9ad6abac56003268baf41e55f9ee645957b32c7d9f62baf1f0b906e68267276f54ec4b4c597c2b190
+ checksum: e178d1deff8b23d5d24ec3f7a94cde6e47d74d0dc649c35fc9857041267c12ec5d44650a0c5597ef83056ada9ea6ca0c30e7c4f97dbf07d035086be9e6a5b7b6
languageName: node
linkType: hard
@@ -10810,15 +10817,15 @@ __metadata:
linkType: hard
"sass@npm:^1.57.1":
- version: 1.69.5
- resolution: "sass@npm:1.69.5"
+ version: 1.70.0
+ resolution: "sass@npm:1.70.0"
dependencies:
chokidar: ">=3.0.0 <4.0.0"
immutable: ^4.0.0
source-map-js: ">=0.6.2 <2.0.0"
bin:
sass: sass.js
- checksum: c66f4f02882e7aa7aa49703824dadbb5a174dcd05e3cd96f17f73687889aab6027d078b518e2c04b594dfd89b2f574824bf935c7aee46c770aa6be9aafcc49f2
+ checksum: fd1b622cf9b7fa699a03ec634611997552ece45eb98ac365fef22f42bdcb8ed63b326b64173379c966830c8551ae801e44e4a00d2de16fdadda2dc8f35400bbb
languageName: node
linkType: hard
diff --git a/mkdocs.yml b/mkdocs.yml
index de66c97884..8c9f84ba81 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -128,6 +128,10 @@ nav:
- Composability System: 'plugins/composability.md'
- Plugin Analytics: 'plugins/analytics.md'
- Feature Flags: 'plugins/feature-flags.md'
+ - OpenAPI:
+ - Schema-first plugins with OpenAPI (Experimental): 'openapi/01-getting-started.md'
+ - Generate a client from your OpenAPI spec: 'openapi/generate-client.md'
+ - Validate your OpenAPI spec against test data: 'openapi/test-case-validation.md'
- Backends and APIs:
- Proxying: 'plugins/proxying.md'
- Backend plugin: 'plugins/backend-plugin.md'
@@ -193,6 +197,8 @@ nav:
- Switching Backstage from SQLite to PostgreSQL: 'tutorials/switching-sqlite-postgres.md'
- Using the Backstage Proxy from Within a Plugin: 'tutorials/using-backstage-proxy-within-plugin.md'
- Migration to Yarn 3: 'tutorials/yarn-migration.md'
+ - Migration to Material UI v5: 'tutorials/migrate-to-mui5.md'
+ - Setup OpenTelemetry: 'tutorials/setup-opentelemetry.md'
- Architecture Decision Records (ADRs):
- Overview: 'architecture-decisions/index.md'
- ADR001 - Architecture Decision Record (ADR) log: 'architecture-decisions/adr001-add-adr-log.md'
@@ -208,4 +214,7 @@ nav:
- ADR011 - Plugin Package Structure: 'architecture-decisions/adr011-plugin-package-structure.md'
- ADR012 - Plugin Package Structure: 'architecture-decisions/adr012-use-luxon-locale-and-date-presets.md'
- ADR013 - Plugin Package Structure: 'architecture-decisions/adr013-use-node-fetch.md'
- - FAQ: FAQ.md
+ - FAQ:
+ - Overview: 'faq/index.md'
+ - Product FAQ: 'faq/product.md'
+ - Technical FAQ: 'faq/technical.md'
diff --git a/package.json b/package.json
index 1b23829f76..e24cedb527 100644
--- a/package.json
+++ b/package.json
@@ -6,13 +6,16 @@
},
"scripts": {
"dev": "concurrently 'yarn start' 'yarn start-backend'",
+ "dev:next": "concurrently 'yarn start:next' 'yarn start-backend:next'",
"start": "yarn workspace example-app start",
"start-backend": "yarn workspace example-backend start",
+ "start:next": "yarn workspace example-app-next start",
+ "start-backend:next": "yarn workspace example-backend-next start",
"build:backend": "yarn workspace example-backend build",
"build:all": "backstage-cli repo build --all",
"build:api-reports": "yarn build:api-reports:only --tsc",
"build:api-reports:only": "backstage-repo-tools api-reports --allow-warnings 'packages/core-components,plugins/+(catalog|catalog-import|git-release-manager|jenkins|kubernetes)' -o ae-wrong-input-file-type --validate-release-tags",
- "build:api-docs": "LANG=en_EN yarn build:api-reports --docs",
+ "build:api-docs": "LANG=en_EN yarn build:api-reports --docs --exclude 'plugins/@(adr|adr-backend|adr-common|airbrake|airbrake-backend|allure|analytics-module-ga|analytics-module-ga4|analytics-module-newrelic-browser|apache-airflow|api-docs|api-docs-module-protoc-gen-doc|apollo-explorer|app-visualizer|azure-devops|azure-devops-backend|azure-devops-common|azure-sites|azure-sites-backend|azure-sites-common|badges|badges-backend|bazaar|bazaar-backend|bitbucket-cloud-common|bitrise|catalog-graph|catalog-graphql|catalog-import|catalog-unprocessed-entities|cicd-statistics|cicd-statistics-module-gitlab|circleci|cloudbuild|code-climate|code-coverage|code-coverage-backend|codescene|config-schema|cost-insights|cost-insights-common|dynatrace|entity-feedback|entity-feedback-backend|entity-feedback-common|entity-validation|example-todo-list|example-todo-list-backend|example-todo-list-common|firehydrant|fossa|gcalendar|gcp-projects|git-release-manager|github-actions|github-deployments|github-issues|github-pull-requests-board|gitops-profiles|gocd|graphiql|graphql-backend|graphql-voyager|ilert|jenkins|jenkins-backend|jenkins-common|kafka|kafka-backend|lighthouse|lighthouse-backend|lighthouse-common|linguist|linguist-backend|linguist-common|microsoft-calendar|newrelic|newrelic-dashboard|nomad|nomad-backend|octopus-deploy|opencost|pagerduty|periskop|periskop-backend|playlist|playlist-backend|playlist-common|proxy-backend|puppetdb|rollbar|rollbar-backend|sentry|shortcuts|splunk-on-call|stack-overflow|stack-overflow-backend|stackstorm|tech-radar|tech-radar-2|todo|todo-backend|xcmetrics)'",
"build:plugins-report": "node ./scripts/build-plugins-report",
"tsc": "tsc",
"tsc:full": "backstage-cli repo clean && tsc --skipLibCheck false --incremental false",
@@ -50,11 +53,10 @@
"@types/react": "^18",
"@types/react-dom": "^18",
"jest-haste-map@^29.7.0": "patch:jest-haste-map@npm%3A29.7.0#./.yarn/patches/jest-haste-map-npm-29.7.0-e3be419eff.patch",
- "mock-fs@^5.2.0": "patch:mock-fs@npm%3A5.2.0#./.yarn/patches/mock-fs-npm-5.2.0-5103a7b507.patch",
"@material-ui/pickers@^3.3.10": "patch:@material-ui/pickers@npm%3A3.3.11#./.yarn/patches/@material-ui-pickers-npm-3.3.11-1c8f68ea20.patch",
"@material-ui/pickers@^3.2.10": "patch:@material-ui/pickers@npm%3A3.3.11#./.yarn/patches/@material-ui-pickers-npm-3.3.11-1c8f68ea20.patch"
},
- "version": "1.21.0-next.1",
+ "version": "1.23.0-next.0",
"dependencies": {
"@backstage/errors": "workspace:^",
"@manypkg/get-packages": "^1.1.3",
diff --git a/packages/app-defaults/CHANGELOG.md b/packages/app-defaults/CHANGELOG.md
index 62873d9809..9ac73e575a 100644
--- a/packages/app-defaults/CHANGELOG.md
+++ b/packages/app-defaults/CHANGELOG.md
@@ -1,5 +1,94 @@
# @backstage/app-defaults
+## 1.4.8-next.0
+
+### Patch Changes
+
+- f899eec: Change default icon for `kind:resource` to the storage icon.
+- Updated dependencies
+ - @backstage/core-components@0.13.10
+ - @backstage/core-app-api@1.11.3
+ - @backstage/core-plugin-api@1.8.2
+ - @backstage/theme@0.5.0
+ - @backstage/plugin-permission-react@0.4.19
+
+## 1.4.7
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.13.10
+ - @backstage/core-plugin-api@1.8.2
+ - @backstage/plugin-permission-react@0.4.19
+ - @backstage/core-app-api@1.11.3
+ - @backstage/theme@0.5.0
+
+## 1.4.7-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-plugin-api@1.8.2-next.0
+ - @backstage/core-components@0.13.10-next.1
+ - @backstage/core-app-api@1.11.3-next.0
+ - @backstage/plugin-permission-react@0.4.19-next.1
+ - @backstage/theme@0.5.0
+
+## 1.4.7-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.13.10-next.0
+ - @backstage/plugin-permission-react@0.4.19-next.0
+ - @backstage/core-app-api@1.11.2
+ - @backstage/core-plugin-api@1.8.1
+ - @backstage/theme@0.5.0
+
+## 1.4.6
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-plugin-api@1.8.1
+ - @backstage/core-components@0.13.9
+ - @backstage/theme@0.5.0
+ - @backstage/core-app-api@1.11.2
+ - @backstage/plugin-permission-react@0.4.18
+
+## 1.4.6-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.13.9-next.3
+ - @backstage/core-app-api@1.11.2-next.1
+ - @backstage/core-plugin-api@1.8.1-next.1
+ - @backstage/theme@0.5.0-next.1
+ - @backstage/plugin-permission-react@0.4.18-next.1
+
+## 1.4.6-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/theme@0.5.0-next.1
+ - @backstage/core-app-api@1.11.2-next.1
+ - @backstage/core-components@0.13.9-next.2
+ - @backstage/core-plugin-api@1.8.1-next.1
+ - @backstage/plugin-permission-react@0.4.18-next.1
+
+## 1.4.6-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.13.9-next.1
+ - @backstage/core-plugin-api@1.8.1-next.1
+ - @backstage/core-app-api@1.11.2-next.1
+ - @backstage/plugin-permission-react@0.4.18-next.1
+ - @backstage/theme@0.5.0-next.0
+
## 1.4.6-next.0
### Patch Changes
diff --git a/packages/app-defaults/package.json b/packages/app-defaults/package.json
index 550672d7fb..4b15d5875a 100644
--- a/packages/app-defaults/package.json
+++ b/packages/app-defaults/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/app-defaults",
"description": "Provides the default wiring of a Backstage App",
- "version": "1.4.6-next.0",
+ "version": "1.4.8-next.0",
"publishConfig": {
"access": "public",
"main": "dist/index.esm.js",
diff --git a/packages/app-defaults/src/defaults/icons.tsx b/packages/app-defaults/src/defaults/icons.tsx
index fbdfb14e5b..1ed5bf03c6 100644
--- a/packages/app-defaults/src/defaults/icons.tsx
+++ b/packages/app-defaults/src/defaults/icons.tsx
@@ -34,7 +34,7 @@ import MuiMenuBookIcon from '@material-ui/icons/MenuBook';
import MuiPeopleIcon from '@material-ui/icons/People';
import MuiPersonIcon from '@material-ui/icons/Person';
import MuiWarningIcon from '@material-ui/icons/Warning';
-import MuiWorkIcon from '@material-ui/icons/Work';
+import MuiStorageIcon from '@material-ui/icons/Storage';
import MuiFeaturedPlayListIcon from '@material-ui/icons/FeaturedPlayList';
export const icons = {
@@ -58,7 +58,7 @@ export const icons = {
'kind:location': MuiLocationOnIcon as IconComponent,
'kind:system': MuiCategoryIcon as IconComponent,
'kind:user': MuiPersonIcon as IconComponent,
- 'kind:resource': MuiWorkIcon as IconComponent,
+ 'kind:resource': MuiStorageIcon as IconComponent,
'kind:template': MuiFeaturedPlayListIcon as IconComponent,
user: MuiPersonIcon as IconComponent,
warning: MuiWarningIcon as IconComponent,
diff --git a/packages/app-next-example-plugin/CHANGELOG.md b/packages/app-next-example-plugin/CHANGELOG.md
index 2eff29241d..4e41b9690a 100644
--- a/packages/app-next-example-plugin/CHANGELOG.md
+++ b/packages/app-next-example-plugin/CHANGELOG.md
@@ -1,5 +1,76 @@
# app-next-example-plugin
+## 0.0.6-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/frontend-plugin-api@0.5.1-next.0
+ - @backstage/core-components@0.13.10
+
+## 0.0.5
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/frontend-plugin-api@0.5.0
+ - @backstage/core-components@0.13.10
+
+## 0.0.5-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/frontend-plugin-api@0.4.1-next.2
+
+## 0.0.5-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.13.10-next.1
+ - @backstage/frontend-plugin-api@0.4.1-next.1
+
+## 0.0.5-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.13.10-next.0
+ - @backstage/frontend-plugin-api@0.4.1-next.0
+
+## 0.0.4
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/frontend-plugin-api@0.4.0
+ - @backstage/core-components@0.13.9
+
+## 0.0.4-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.13.9-next.3
+ - @backstage/frontend-plugin-api@0.4.0-next.3
+
+## 0.0.4-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/frontend-plugin-api@0.4.0-next.2
+ - @backstage/core-components@0.13.9-next.2
+
+## 0.0.4-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/frontend-plugin-api@0.4.0-next.1
+ - @backstage/core-components@0.13.9-next.1
+
## 0.0.4-next.0
### Patch Changes
diff --git a/packages/app-next-example-plugin/package.json b/packages/app-next-example-plugin/package.json
index b3de8f9a83..05d7e20823 100644
--- a/packages/app-next-example-plugin/package.json
+++ b/packages/app-next-example-plugin/package.json
@@ -1,7 +1,7 @@
{
"name": "app-next-example-plugin",
"description": "Backstage internal example plugin",
- "version": "0.0.4-next.0",
+ "version": "0.0.6-next.0",
"publishConfig": {
"access": "public",
"main": "dist/index.esm.js",
diff --git a/packages/app-next-example-plugin/src/plugin.tsx b/packages/app-next-example-plugin/src/plugin.tsx
index a3c95e900c..99c377b7e5 100644
--- a/packages/app-next-example-plugin/src/plugin.tsx
+++ b/packages/app-next-example-plugin/src/plugin.tsx
@@ -21,7 +21,6 @@ import {
} from '@backstage/frontend-plugin-api';
export const ExamplePage = createPageExtension({
- id: 'example.page',
defaultPath: '/example',
loader: () => import('./Component').then(m =>
,
@@ -110,9 +124,16 @@ const app = createApp({
techdocsPlugin,
userSettingsPlugin,
homePlugin,
+ appVisualizerPlugin,
...collectedLegacyPlugins,
createExtensionOverrides({
- extensions: [homePageExtension, scmAuthExtension, scmIntegrationApi],
+ extensions: [
+ homePageExtension,
+ scmAuthExtension,
+ scmIntegrationApi,
+ signInPage,
+ notFoundErrorPage,
+ ],
}),
],
/* Handled through config instead */
diff --git a/packages/app-next/src/examples/notFoundErrorPageExtension.tsx b/packages/app-next/src/examples/notFoundErrorPageExtension.tsx
new file mode 100644
index 0000000000..f83671bc23
--- /dev/null
+++ b/packages/app-next/src/examples/notFoundErrorPageExtension.tsx
@@ -0,0 +1,56 @@
+/*
+ * 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 {
+ createComponentExtension,
+ coreComponentRefs,
+} from '@backstage/frontend-plugin-api';
+import { Box, Typography } from '@material-ui/core';
+import { Button } from '@backstage/core-components';
+
+export function CustomNotFoundErrorPage() {
+ return (
+
+ 404
+
+ Unable to locate this page. Please contact your support team if this
+ page used to exist.
+
+
+
+ );
+}
+
+export default createComponentExtension({
+ ref: coreComponentRefs.notFoundErrorPage,
+ loader: { sync: () => CustomNotFoundErrorPage },
+});
diff --git a/packages/app-next/src/examples/pagesPlugin.tsx b/packages/app-next/src/examples/pagesPlugin.tsx
index 1e9409a5e4..c5069f99c3 100644
--- a/packages/app-next/src/examples/pagesPlugin.tsx
+++ b/packages/app-next/src/examples/pagesPlugin.tsx
@@ -36,7 +36,7 @@ export const pageXRouteRef = createRouteRef();
// });
const IndexPage = createPageExtension({
- id: 'index',
+ name: 'index',
defaultPath: '/',
routeRef: indexRouteRef,
loader: async () => {
@@ -68,7 +68,7 @@ const IndexPage = createPageExtension({
});
const Page1 = createPageExtension({
- id: 'page1',
+ name: 'page1',
defaultPath: '/page1',
routeRef: page1RouteRef,
loader: async () => {
@@ -102,7 +102,7 @@ const Page1 = createPageExtension({
});
const ExternalPage = createPageExtension({
- id: 'pageX',
+ name: 'pageX',
defaultPath: '/pageX',
routeRef: pageXRouteRef,
loader: async () => {
diff --git a/packages/app/CHANGELOG.md b/packages/app/CHANGELOG.md
index 089aa84942..370100920f 100644
--- a/packages/app/CHANGELOG.md
+++ b/packages/app/CHANGELOG.md
@@ -1,5 +1,678 @@
# example-app
+## 0.2.92-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-import@0.10.6-next.0
+ - @backstage/plugin-catalog-graph@0.3.4-next.0
+ - @backstage/plugin-catalog-react@1.9.4-next.0
+ - @backstage/plugin-catalog@1.17.0-next.0
+ - @backstage/plugin-adr@0.6.13-next.0
+ - @backstage/app-defaults@1.4.8-next.0
+ - @backstage/frontend-app-api@0.6.0-next.0
+ - @backstage/plugin-scaffolder-react@1.8.0-next.0
+ - @backstage/plugin-scaffolder@1.18.0-next.0
+ - @backstage/plugin-devtools@0.1.9-next.0
+ - @backstage/plugin-user-settings@0.8.1-next.0
+ - @backstage/plugin-tech-radar@0.6.13-next.0
+ - @backstage/plugin-graphiql@0.3.3-next.0
+ - @backstage/plugin-techdocs@1.9.4-next.0
+ - @backstage/plugin-search@1.4.6-next.0
+ - @backstage/plugin-api-docs@0.10.4-next.0
+ - @backstage/cli@0.25.2-next.0
+ - @backstage/plugin-stack-overflow@0.1.25-next.0
+ - @backstage/plugin-signals@0.0.1-next.0
+ - @backstage/plugin-home@0.6.2-next.0
+ - @backstage/plugin-cloudbuild@0.4.0-next.0
+ - @backstage/plugin-techdocs-module-addons-contrib@1.1.5-next.0
+ - @backstage/plugin-azure-devops@0.3.12-next.0
+ - @backstage/plugin-linguist@0.1.15-next.0
+ - @backstage/plugin-airbrake@0.3.30-next.0
+ - @backstage/plugin-azure-sites@0.1.19-next.0
+ - @backstage/plugin-badges@0.2.54-next.0
+ - @backstage/plugin-code-coverage@0.2.23-next.0
+ - @backstage/plugin-cost-insights@0.12.19-next.0
+ - @backstage/plugin-dynatrace@8.0.4-next.0
+ - @backstage/plugin-entity-feedback@0.2.13-next.0
+ - @backstage/plugin-explore@0.4.16-next.0
+ - @backstage/plugin-github-actions@0.6.11-next.0
+ - @backstage/plugin-gocd@0.1.36-next.0
+ - @backstage/plugin-jenkins@0.9.5-next.0
+ - @backstage/plugin-kafka@0.3.30-next.0
+ - @backstage/plugin-kubernetes@0.11.5-next.0
+ - @backstage/plugin-kubernetes-cluster@0.0.6-next.0
+ - @backstage/plugin-lighthouse@0.4.15-next.0
+ - @backstage/plugin-newrelic-dashboard@0.3.5-next.0
+ - @backstage/plugin-nomad@0.1.11-next.0
+ - @backstage/plugin-octopus-deploy@0.2.12-next.0
+ - @backstage/plugin-org@0.6.20-next.0
+ - @backstage/plugin-pagerduty@0.7.2-next.0
+ - @backstage/plugin-playlist@0.2.4-next.0
+ - @backstage/plugin-puppetdb@0.1.13-next.0
+ - @backstage/plugin-rollbar@0.4.30-next.0
+ - @backstage/plugin-sentry@0.5.15-next.0
+ - @backstage/plugin-tech-insights@0.3.22-next.0
+ - @backstage/plugin-todo@0.2.34-next.0
+ - @backstage/core-components@0.13.10
+ - @backstage/plugin-search-react@1.7.6-next.0
+ - @backstage/catalog-model@1.4.3
+ - @backstage/config@1.1.1
+ - @backstage/core-app-api@1.11.3
+ - @backstage/core-plugin-api@1.8.2
+ - @backstage/integration-react@1.1.23
+ - @backstage/theme@0.5.0
+ - @backstage/plugin-apache-airflow@0.2.19
+ - @backstage/plugin-catalog-common@1.0.20
+ - @backstage/plugin-catalog-unprocessed-entities@0.1.7
+ - @backstage/plugin-gcalendar@0.3.22
+ - @backstage/plugin-gcp-projects@0.3.45
+ - @backstage/plugin-linguist-common@0.1.2
+ - @backstage/plugin-microsoft-calendar@0.1.11
+ - @backstage/plugin-newrelic@0.3.44
+ - @backstage/plugin-permission-react@0.4.19
+ - @backstage/plugin-search-common@1.2.10
+ - @backstage/plugin-shortcuts@0.3.18
+ - @backstage/plugin-stackstorm@0.1.10
+ - @backstage/plugin-techdocs-react@1.1.15
+
+## 0.2.91
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-api-docs@0.10.3
+ - @backstage/plugin-scaffolder-react@1.7.1
+ - @backstage/core-components@0.13.10
+ - @backstage/plugin-user-settings@0.8.0
+ - @backstage/plugin-azure-sites@0.1.18
+ - @backstage/cli@0.25.1
+ - @backstage/core-plugin-api@1.8.2
+ - @backstage/plugin-octopus-deploy@0.2.11
+ - @backstage/frontend-app-api@0.5.0
+ - @backstage/plugin-kubernetes@0.11.4
+ - @backstage/plugin-home@0.6.1
+ - @backstage/plugin-scaffolder@1.17.1
+ - @backstage/plugin-techdocs-module-addons-contrib@1.1.4
+ - @backstage/plugin-catalog-unprocessed-entities@0.1.7
+ - @backstage/plugin-kubernetes-cluster@0.0.5
+ - @backstage/plugin-microsoft-calendar@0.1.11
+ - @backstage/plugin-newrelic-dashboard@0.3.4
+ - @backstage/plugin-permission-react@0.4.19
+ - @backstage/plugin-entity-feedback@0.2.12
+ - @backstage/plugin-apache-airflow@0.2.19
+ - @backstage/plugin-github-actions@0.6.10
+ - @backstage/plugin-stack-overflow@0.1.24
+ - @backstage/plugin-techdocs-react@1.1.15
+ - @backstage/plugin-catalog-graph@0.3.3
+ - @backstage/plugin-catalog-react@1.9.3
+ - @backstage/plugin-code-coverage@0.2.22
+ - @backstage/plugin-cost-insights@0.12.18
+ - @backstage/plugin-tech-insights@0.3.21
+ - @backstage/plugin-azure-devops@0.3.11
+ - @backstage/plugin-gcp-projects@0.3.45
+ - @backstage/plugin-cloudbuild@0.3.29
+ - @backstage/plugin-lighthouse@0.4.14
+ - @backstage/plugin-stackstorm@0.1.10
+ - @backstage/plugin-tech-radar@0.6.12
+ - @backstage/plugin-dynatrace@8.0.3
+ - @backstage/plugin-gcalendar@0.3.22
+ - @backstage/plugin-pagerduty@0.7.1
+ - @backstage/plugin-shortcuts@0.3.18
+ - @backstage/plugin-airbrake@0.3.29
+ - @backstage/plugin-devtools@0.1.8
+ - @backstage/plugin-graphiql@0.3.2
+ - @backstage/plugin-linguist@0.1.14
+ - @backstage/plugin-newrelic@0.3.44
+ - @backstage/plugin-playlist@0.2.3
+ - @backstage/plugin-puppetdb@0.1.12
+ - @backstage/plugin-techdocs@1.9.3
+ - @backstage/plugin-catalog@1.16.1
+ - @backstage/plugin-explore@0.4.15
+ - @backstage/plugin-jenkins@0.9.4
+ - @backstage/plugin-rollbar@0.4.29
+ - @backstage/plugin-badges@0.2.53
+ - @backstage/plugin-search@1.4.5
+ - @backstage/plugin-sentry@0.5.14
+ - @backstage/plugin-kafka@0.3.29
+ - @backstage/plugin-nomad@0.1.10
+ - @backstage/plugin-gocd@0.1.35
+ - @backstage/plugin-todo@0.2.33
+ - @backstage/plugin-adr@0.6.12
+ - @backstage/plugin-org@0.6.19
+ - @backstage/plugin-catalog-import@0.10.5
+ - @backstage/plugin-search-react@1.7.5
+ - @backstage/app-defaults@1.4.7
+ - @backstage/integration-react@1.1.23
+ - @backstage/catalog-model@1.4.3
+ - @backstage/config@1.1.1
+ - @backstage/core-app-api@1.11.3
+ - @backstage/theme@0.5.0
+ - @backstage/plugin-catalog-common@1.0.20
+ - @backstage/plugin-linguist-common@0.1.2
+ - @backstage/plugin-search-common@1.2.10
+
+## 0.2.91-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-user-settings@0.8.0-next.2
+ - @backstage/plugin-octopus-deploy@0.2.11-next.2
+ - @backstage/frontend-app-api@0.4.1-next.2
+ - @backstage/plugin-home@0.6.1-next.2
+ - @backstage/plugin-scaffolder-react@1.7.1-next.2
+ - @backstage/plugin-scaffolder@1.17.1-next.2
+ - @backstage/plugin-linguist@0.1.14-next.2
+ - @backstage/plugin-catalog@1.16.1-next.2
+ - @backstage/plugin-catalog-import@0.10.5-next.2
+ - @backstage/plugin-graphiql@0.3.2-next.2
+ - @backstage/plugin-search@1.4.5-next.2
+ - @backstage/plugin-tech-radar@0.6.12-next.2
+ - @backstage/plugin-techdocs@1.9.3-next.2
+ - @backstage/plugin-adr@0.6.12-next.2
+ - @backstage/plugin-catalog-react@1.9.3-next.2
+ - @backstage/plugin-explore@0.4.15-next.2
+ - @backstage/plugin-search-react@1.7.5-next.2
+ - @backstage/plugin-stack-overflow@0.1.24-next.2
+ - @backstage/cli@0.25.1-next.1
+ - @backstage/plugin-pagerduty@0.7.1-next.2
+ - @backstage/plugin-api-docs@0.10.3-next.2
+ - @backstage/plugin-catalog-graph@0.3.3-next.2
+ - @backstage/plugin-org@0.6.19-next.2
+ - @backstage/plugin-airbrake@0.3.29-next.2
+ - @backstage/plugin-azure-devops@0.3.11-next.2
+ - @backstage/plugin-azure-sites@0.1.18-next.2
+ - @backstage/plugin-badges@0.2.53-next.2
+ - @backstage/plugin-cloudbuild@0.3.29-next.2
+ - @backstage/plugin-code-coverage@0.2.22-next.2
+ - @backstage/plugin-cost-insights@0.12.18-next.2
+ - @backstage/plugin-dynatrace@8.0.3-next.2
+ - @backstage/plugin-entity-feedback@0.2.12-next.2
+ - @backstage/plugin-github-actions@0.6.10-next.2
+ - @backstage/plugin-gocd@0.1.35-next.2
+ - @backstage/plugin-jenkins@0.9.4-next.2
+ - @backstage/plugin-kafka@0.3.29-next.2
+ - @backstage/plugin-kubernetes@0.11.4-next.2
+ - @backstage/plugin-kubernetes-cluster@0.0.5-next.2
+ - @backstage/plugin-lighthouse@0.4.14-next.2
+ - @backstage/plugin-newrelic-dashboard@0.3.4-next.2
+ - @backstage/plugin-nomad@0.1.10-next.2
+ - @backstage/plugin-playlist@0.2.3-next.2
+ - @backstage/plugin-puppetdb@0.1.12-next.2
+ - @backstage/plugin-rollbar@0.4.29-next.2
+ - @backstage/plugin-sentry@0.5.14-next.2
+ - @backstage/plugin-tech-insights@0.3.21-next.2
+ - @backstage/plugin-todo@0.2.33-next.2
+ - @backstage/plugin-techdocs-module-addons-contrib@1.1.4-next.1
+ - @backstage/integration-react@1.1.23-next.0
+ - @backstage/plugin-apache-airflow@0.2.19-next.1
+ - @backstage/plugin-catalog-unprocessed-entities@0.1.7-next.1
+ - @backstage/plugin-devtools@0.1.8-next.1
+ - @backstage/plugin-gcalendar@0.3.22-next.1
+ - @backstage/plugin-gcp-projects@0.3.45-next.1
+ - @backstage/plugin-microsoft-calendar@0.1.11-next.1
+ - @backstage/plugin-newrelic@0.3.44-next.1
+ - @backstage/plugin-shortcuts@0.3.18-next.1
+ - @backstage/plugin-stackstorm@0.1.10-next.1
+
+## 0.2.91-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-azure-sites@0.1.18-next.1
+ - @backstage/core-plugin-api@1.8.2-next.0
+ - @backstage/plugin-user-settings@0.8.0-next.1
+ - @backstage/plugin-kubernetes@0.11.4-next.1
+ - @backstage/core-components@0.13.10-next.1
+ - @backstage/app-defaults@1.4.7-next.1
+ - @backstage/cli@0.25.1-next.1
+ - @backstage/core-app-api@1.11.3-next.0
+ - @backstage/frontend-app-api@0.4.1-next.1
+ - @backstage/integration-react@1.1.23-next.0
+ - @backstage/plugin-adr@0.6.12-next.1
+ - @backstage/plugin-airbrake@0.3.29-next.1
+ - @backstage/plugin-apache-airflow@0.2.19-next.1
+ - @backstage/plugin-api-docs@0.10.3-next.1
+ - @backstage/plugin-azure-devops@0.3.11-next.1
+ - @backstage/plugin-badges@0.2.53-next.1
+ - @backstage/plugin-catalog@1.16.1-next.1
+ - @backstage/plugin-catalog-graph@0.3.3-next.1
+ - @backstage/plugin-catalog-import@0.10.5-next.1
+ - @backstage/plugin-catalog-react@1.9.3-next.1
+ - @backstage/plugin-catalog-unprocessed-entities@0.1.7-next.1
+ - @backstage/plugin-cloudbuild@0.3.29-next.1
+ - @backstage/plugin-code-coverage@0.2.22-next.1
+ - @backstage/plugin-cost-insights@0.12.18-next.1
+ - @backstage/plugin-devtools@0.1.8-next.1
+ - @backstage/plugin-dynatrace@8.0.3-next.1
+ - @backstage/plugin-entity-feedback@0.2.12-next.1
+ - @backstage/plugin-explore@0.4.15-next.1
+ - @backstage/plugin-gcalendar@0.3.22-next.1
+ - @backstage/plugin-gcp-projects@0.3.45-next.1
+ - @backstage/plugin-github-actions@0.6.10-next.1
+ - @backstage/plugin-gocd@0.1.35-next.1
+ - @backstage/plugin-graphiql@0.3.2-next.1
+ - @backstage/plugin-home@0.6.1-next.1
+ - @backstage/plugin-jenkins@0.9.4-next.1
+ - @backstage/plugin-kafka@0.3.29-next.1
+ - @backstage/plugin-kubernetes-cluster@0.0.5-next.1
+ - @backstage/plugin-lighthouse@0.4.14-next.1
+ - @backstage/plugin-linguist@0.1.14-next.1
+ - @backstage/plugin-microsoft-calendar@0.1.11-next.1
+ - @backstage/plugin-newrelic@0.3.44-next.1
+ - @backstage/plugin-newrelic-dashboard@0.3.4-next.1
+ - @backstage/plugin-nomad@0.1.10-next.1
+ - @backstage/plugin-octopus-deploy@0.2.11-next.1
+ - @backstage/plugin-org@0.6.19-next.1
+ - @backstage/plugin-pagerduty@0.7.1-next.1
+ - @backstage/plugin-permission-react@0.4.19-next.1
+ - @backstage/plugin-playlist@0.2.3-next.1
+ - @backstage/plugin-puppetdb@0.1.12-next.1
+ - @backstage/plugin-rollbar@0.4.29-next.1
+ - @backstage/plugin-scaffolder@1.17.1-next.1
+ - @backstage/plugin-scaffolder-react@1.7.1-next.1
+ - @backstage/plugin-search@1.4.5-next.1
+ - @backstage/plugin-search-react@1.7.5-next.1
+ - @backstage/plugin-sentry@0.5.14-next.1
+ - @backstage/plugin-shortcuts@0.3.18-next.1
+ - @backstage/plugin-stack-overflow@0.1.24-next.1
+ - @backstage/plugin-stackstorm@0.1.10-next.1
+ - @backstage/plugin-tech-insights@0.3.21-next.1
+ - @backstage/plugin-tech-radar@0.6.12-next.1
+ - @backstage/plugin-techdocs@1.9.3-next.1
+ - @backstage/plugin-techdocs-module-addons-contrib@1.1.4-next.1
+ - @backstage/plugin-techdocs-react@1.1.15-next.1
+ - @backstage/plugin-todo@0.2.33-next.1
+ - @backstage/config@1.1.1
+ - @backstage/catalog-model@1.4.3
+ - @backstage/theme@0.5.0
+ - @backstage/plugin-catalog-common@1.0.19
+ - @backstage/plugin-linguist-common@0.1.2
+ - @backstage/plugin-search-common@1.2.9
+
+## 0.2.91-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-react@1.7.1-next.0
+ - @backstage/core-components@0.13.10-next.0
+ - @backstage/cli@0.25.1-next.0
+ - @backstage/plugin-techdocs-module-addons-contrib@1.1.4-next.0
+ - @backstage/plugin-catalog-unprocessed-entities@0.1.7-next.0
+ - @backstage/plugin-kubernetes-cluster@0.0.5-next.0
+ - @backstage/plugin-microsoft-calendar@0.1.11-next.0
+ - @backstage/plugin-newrelic-dashboard@0.3.4-next.0
+ - @backstage/plugin-permission-react@0.4.19-next.0
+ - @backstage/plugin-entity-feedback@0.2.12-next.0
+ - @backstage/plugin-apache-airflow@0.2.19-next.0
+ - @backstage/plugin-github-actions@0.6.10-next.0
+ - @backstage/plugin-octopus-deploy@0.2.11-next.0
+ - @backstage/plugin-stack-overflow@0.1.24-next.0
+ - @backstage/plugin-techdocs-react@1.1.15-next.0
+ - @backstage/plugin-catalog-graph@0.3.3-next.0
+ - @backstage/plugin-catalog-react@1.9.3-next.0
+ - @backstage/plugin-code-coverage@0.2.22-next.0
+ - @backstage/plugin-cost-insights@0.12.18-next.0
+ - @backstage/plugin-tech-insights@0.3.21-next.0
+ - @backstage/plugin-user-settings@0.7.15-next.0
+ - @backstage/plugin-azure-devops@0.3.11-next.0
+ - @backstage/plugin-gcp-projects@0.3.45-next.0
+ - @backstage/plugin-azure-sites@0.1.18-next.0
+ - @backstage/plugin-cloudbuild@0.3.29-next.0
+ - @backstage/plugin-kubernetes@0.11.4-next.0
+ - @backstage/plugin-lighthouse@0.4.14-next.0
+ - @backstage/plugin-scaffolder@1.17.1-next.0
+ - @backstage/plugin-stackstorm@0.1.10-next.0
+ - @backstage/plugin-tech-radar@0.6.12-next.0
+ - @backstage/plugin-dynatrace@8.0.3-next.0
+ - @backstage/plugin-gcalendar@0.3.22-next.0
+ - @backstage/plugin-pagerduty@0.7.1-next.0
+ - @backstage/plugin-shortcuts@0.3.18-next.0
+ - @backstage/plugin-airbrake@0.3.29-next.0
+ - @backstage/plugin-api-docs@0.10.3-next.0
+ - @backstage/plugin-devtools@0.1.8-next.0
+ - @backstage/plugin-graphiql@0.3.2-next.0
+ - @backstage/plugin-linguist@0.1.14-next.0
+ - @backstage/plugin-newrelic@0.3.44-next.0
+ - @backstage/plugin-playlist@0.2.3-next.0
+ - @backstage/plugin-puppetdb@0.1.12-next.0
+ - @backstage/plugin-techdocs@1.9.3-next.0
+ - @backstage/plugin-catalog@1.16.1-next.0
+ - @backstage/plugin-explore@0.4.15-next.0
+ - @backstage/plugin-jenkins@0.9.4-next.0
+ - @backstage/plugin-rollbar@0.4.29-next.0
+ - @backstage/plugin-badges@0.2.53-next.0
+ - @backstage/plugin-search@1.4.5-next.0
+ - @backstage/plugin-sentry@0.5.14-next.0
+ - @backstage/plugin-kafka@0.3.29-next.0
+ - @backstage/plugin-nomad@0.1.10-next.0
+ - @backstage/plugin-gocd@0.1.35-next.0
+ - @backstage/plugin-home@0.6.1-next.0
+ - @backstage/plugin-todo@0.2.33-next.0
+ - @backstage/plugin-adr@0.6.12-next.0
+ - @backstage/plugin-org@0.6.19-next.0
+ - @backstage/app-defaults@1.4.7-next.0
+ - @backstage/frontend-app-api@0.4.1-next.0
+ - @backstage/integration-react@1.1.22
+ - @backstage/plugin-catalog-import@0.10.5-next.0
+ - @backstage/plugin-search-react@1.7.5-next.0
+ - @backstage/catalog-model@1.4.3
+ - @backstage/config@1.1.1
+ - @backstage/core-app-api@1.11.2
+ - @backstage/core-plugin-api@1.8.1
+ - @backstage/theme@0.5.0
+ - @backstage/plugin-catalog-common@1.0.19
+ - @backstage/plugin-linguist-common@0.1.2
+ - @backstage/plugin-search-common@1.2.9
+
+## 0.2.90
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-plugin-api@1.8.1
+ - @backstage/frontend-app-api@0.4.0
+ - @backstage/plugin-catalog-react@1.9.2
+ - @backstage/plugin-api-docs@0.10.2
+ - @backstage/core-components@0.13.9
+ - @backstage/cli@0.25.0
+ - @backstage/theme@0.5.0
+ - @backstage/plugin-scaffolder@1.17.0
+ - @backstage/plugin-home@0.6.0
+ - @backstage/plugin-catalog@1.16.0
+ - @backstage/plugin-scaffolder-react@1.7.0
+ - @backstage/plugin-kubernetes@0.11.3
+ - @backstage/plugin-org@0.6.18
+ - @backstage/plugin-github-actions@0.6.9
+ - @backstage/plugin-azure-devops@0.3.10
+ - @backstage/core-app-api@1.11.2
+ - @backstage/plugin-lighthouse@0.4.13
+ - @backstage/plugin-explore@0.4.14
+ - @backstage/plugin-catalog-import@0.10.4
+ - @backstage/plugin-user-settings@0.7.14
+ - @backstage/plugin-tech-radar@0.6.11
+ - @backstage/plugin-graphiql@0.3.1
+ - @backstage/plugin-techdocs@1.9.2
+ - @backstage/plugin-search@1.4.4
+ - @backstage/plugin-search-react@1.7.4
+ - @backstage/plugin-stack-overflow@0.1.23
+ - @backstage/plugin-adr@0.6.11
+ - @backstage/plugin-gcp-projects@0.3.44
+ - @backstage/plugin-techdocs-module-addons-contrib@1.1.3
+ - @backstage/plugin-pagerduty@0.7.0
+ - @backstage/app-defaults@1.4.6
+ - @backstage/integration-react@1.1.22
+ - @backstage/plugin-airbrake@0.3.28
+ - @backstage/plugin-apache-airflow@0.2.18
+ - @backstage/plugin-azure-sites@0.1.17
+ - @backstage/plugin-badges@0.2.52
+ - @backstage/plugin-catalog-graph@0.3.2
+ - @backstage/plugin-catalog-unprocessed-entities@0.1.6
+ - @backstage/plugin-cloudbuild@0.3.28
+ - @backstage/plugin-code-coverage@0.2.21
+ - @backstage/plugin-cost-insights@0.12.17
+ - @backstage/plugin-devtools@0.1.7
+ - @backstage/plugin-dynatrace@8.0.2
+ - @backstage/plugin-entity-feedback@0.2.11
+ - @backstage/plugin-gcalendar@0.3.21
+ - @backstage/plugin-gocd@0.1.34
+ - @backstage/plugin-jenkins@0.9.3
+ - @backstage/plugin-kafka@0.3.28
+ - @backstage/plugin-kubernetes-cluster@0.0.4
+ - @backstage/plugin-linguist@0.1.13
+ - @backstage/plugin-microsoft-calendar@0.1.10
+ - @backstage/plugin-newrelic@0.3.43
+ - @backstage/plugin-newrelic-dashboard@0.3.3
+ - @backstage/plugin-nomad@0.1.9
+ - @backstage/plugin-octopus-deploy@0.2.10
+ - @backstage/plugin-permission-react@0.4.18
+ - @backstage/plugin-playlist@0.2.2
+ - @backstage/plugin-puppetdb@0.1.11
+ - @backstage/plugin-rollbar@0.4.28
+ - @backstage/plugin-sentry@0.5.13
+ - @backstage/plugin-shortcuts@0.3.17
+ - @backstage/plugin-stackstorm@0.1.9
+ - @backstage/plugin-tech-insights@0.3.20
+ - @backstage/plugin-techdocs-react@1.1.14
+ - @backstage/plugin-todo@0.2.32
+ - @backstage/catalog-model@1.4.3
+ - @backstage/config@1.1.1
+ - @backstage/plugin-catalog-common@1.0.19
+ - @backstage/plugin-linguist-common@0.1.2
+ - @backstage/plugin-search-common@1.2.9
+
+## 0.2.90-next.4
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-home@0.6.0-next.3
+ - @backstage/plugin-org@0.6.18-next.3
+ - @backstage/plugin-azure-devops@0.3.10-next.3
+ - @backstage/cli@0.25.0-next.3
+ - @backstage/plugin-api-docs@0.10.2-next.4
+ - @backstage/plugin-scaffolder-react@1.6.2-next.3
+ - @backstage/plugin-scaffolder@1.16.2-next.3
+ - @backstage/core-components@0.13.9-next.3
+ - @backstage/app-defaults@1.4.6-next.3
+ - @backstage/catalog-model@1.4.3
+ - @backstage/config@1.1.1
+ - @backstage/core-app-api@1.11.2-next.1
+ - @backstage/core-plugin-api@1.8.1-next.1
+ - @backstage/frontend-app-api@0.4.0-next.3
+ - @backstage/integration-react@1.1.22-next.1
+ - @backstage/theme@0.5.0-next.1
+ - @backstage/plugin-adr@0.6.11-next.3
+ - @backstage/plugin-airbrake@0.3.28-next.3
+ - @backstage/plugin-apache-airflow@0.2.18-next.3
+ - @backstage/plugin-azure-sites@0.1.17-next.3
+ - @backstage/plugin-badges@0.2.52-next.3
+ - @backstage/plugin-catalog@1.16.0-next.4
+ - @backstage/plugin-catalog-common@1.0.18
+ - @backstage/plugin-catalog-graph@0.3.2-next.3
+ - @backstage/plugin-catalog-import@0.10.4-next.4
+ - @backstage/plugin-catalog-react@1.9.2-next.3
+ - @backstage/plugin-catalog-unprocessed-entities@0.1.6-next.3
+ - @backstage/plugin-cloudbuild@0.3.28-next.3
+ - @backstage/plugin-code-coverage@0.2.21-next.3
+ - @backstage/plugin-cost-insights@0.12.17-next.3
+ - @backstage/plugin-devtools@0.1.7-next.3
+ - @backstage/plugin-dynatrace@8.0.2-next.3
+ - @backstage/plugin-entity-feedback@0.2.11-next.3
+ - @backstage/plugin-explore@0.4.14-next.3
+ - @backstage/plugin-gcalendar@0.3.21-next.3
+ - @backstage/plugin-gcp-projects@0.3.44-next.3
+ - @backstage/plugin-github-actions@0.6.9-next.3
+ - @backstage/plugin-gocd@0.1.34-next.3
+ - @backstage/plugin-graphiql@0.3.1-next.4
+ - @backstage/plugin-jenkins@0.9.3-next.3
+ - @backstage/plugin-kafka@0.3.28-next.3
+ - @backstage/plugin-kubernetes@0.11.3-next.3
+ - @backstage/plugin-kubernetes-cluster@0.0.4-next.3
+ - @backstage/plugin-lighthouse@0.4.13-next.3
+ - @backstage/plugin-linguist@0.1.13-next.3
+ - @backstage/plugin-linguist-common@0.1.2
+ - @backstage/plugin-microsoft-calendar@0.1.10-next.3
+ - @backstage/plugin-newrelic@0.3.43-next.3
+ - @backstage/plugin-newrelic-dashboard@0.3.3-next.3
+ - @backstage/plugin-nomad@0.1.9-next.3
+ - @backstage/plugin-octopus-deploy@0.2.10-next.3
+ - @backstage/plugin-pagerduty@0.7.0-next.3
+ - @backstage/plugin-permission-react@0.4.18-next.1
+ - @backstage/plugin-playlist@0.2.2-next.3
+ - @backstage/plugin-puppetdb@0.1.11-next.3
+ - @backstage/plugin-rollbar@0.4.28-next.3
+ - @backstage/plugin-search@1.4.4-next.4
+ - @backstage/plugin-search-common@1.2.8
+ - @backstage/plugin-search-react@1.7.4-next.3
+ - @backstage/plugin-sentry@0.5.13-next.3
+ - @backstage/plugin-shortcuts@0.3.17-next.3
+ - @backstage/plugin-stack-overflow@0.1.23-next.3
+ - @backstage/plugin-stackstorm@0.1.9-next.3
+ - @backstage/plugin-tech-insights@0.3.20-next.3
+ - @backstage/plugin-tech-radar@0.6.11-next.4
+ - @backstage/plugin-techdocs@1.9.2-next.4
+ - @backstage/plugin-techdocs-module-addons-contrib@1.1.3-next.3
+ - @backstage/plugin-techdocs-react@1.1.14-next.3
+ - @backstage/plugin-todo@0.2.32-next.3
+ - @backstage/plugin-user-settings@0.7.14-next.4
+
+## 0.2.90-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/frontend-app-api@0.4.0-next.2
+ - @backstage/cli@0.25.0-next.2
+ - @backstage/theme@0.5.0-next.1
+ - @backstage/plugin-kubernetes@0.11.3-next.2
+ - @backstage/plugin-lighthouse@0.4.13-next.2
+ - @backstage/plugin-catalog-import@0.10.4-next.3
+ - @backstage/plugin-user-settings@0.7.14-next.3
+ - @backstage/plugin-tech-radar@0.6.11-next.3
+ - @backstage/plugin-graphiql@0.3.1-next.3
+ - @backstage/plugin-techdocs@1.9.2-next.3
+ - @backstage/plugin-catalog@1.16.0-next.3
+ - @backstage/plugin-search@1.4.4-next.3
+ - @backstage/plugin-home@0.6.0-next.2
+ - @backstage/plugin-catalog-react@1.9.2-next.2
+ - @backstage/plugin-stack-overflow@0.1.23-next.2
+ - @backstage/plugin-search-react@1.7.4-next.2
+ - @backstage/plugin-explore@0.4.14-next.2
+ - @backstage/plugin-adr@0.6.11-next.2
+ - @backstage/plugin-scaffolder-react@1.6.2-next.2
+ - @backstage/app-defaults@1.4.6-next.2
+ - @backstage/catalog-model@1.4.3
+ - @backstage/config@1.1.1
+ - @backstage/core-app-api@1.11.2-next.1
+ - @backstage/core-components@0.13.9-next.2
+ - @backstage/core-plugin-api@1.8.1-next.1
+ - @backstage/integration-react@1.1.22-next.1
+ - @backstage/plugin-airbrake@0.3.28-next.2
+ - @backstage/plugin-apache-airflow@0.2.18-next.2
+ - @backstage/plugin-api-docs@0.10.2-next.3
+ - @backstage/plugin-azure-devops@0.3.10-next.2
+ - @backstage/plugin-azure-sites@0.1.17-next.2
+ - @backstage/plugin-badges@0.2.52-next.2
+ - @backstage/plugin-catalog-common@1.0.18
+ - @backstage/plugin-catalog-graph@0.3.2-next.2
+ - @backstage/plugin-catalog-unprocessed-entities@0.1.6-next.2
+ - @backstage/plugin-cloudbuild@0.3.28-next.2
+ - @backstage/plugin-code-coverage@0.2.21-next.2
+ - @backstage/plugin-cost-insights@0.12.17-next.2
+ - @backstage/plugin-devtools@0.1.7-next.2
+ - @backstage/plugin-dynatrace@8.0.2-next.2
+ - @backstage/plugin-entity-feedback@0.2.11-next.2
+ - @backstage/plugin-gcalendar@0.3.21-next.2
+ - @backstage/plugin-gcp-projects@0.3.44-next.2
+ - @backstage/plugin-github-actions@0.6.9-next.2
+ - @backstage/plugin-gocd@0.1.34-next.2
+ - @backstage/plugin-jenkins@0.9.3-next.2
+ - @backstage/plugin-kafka@0.3.28-next.2
+ - @backstage/plugin-kubernetes-cluster@0.0.4-next.2
+ - @backstage/plugin-linguist@0.1.13-next.2
+ - @backstage/plugin-linguist-common@0.1.2
+ - @backstage/plugin-microsoft-calendar@0.1.10-next.2
+ - @backstage/plugin-newrelic@0.3.43-next.2
+ - @backstage/plugin-newrelic-dashboard@0.3.3-next.2
+ - @backstage/plugin-nomad@0.1.9-next.2
+ - @backstage/plugin-octopus-deploy@0.2.10-next.2
+ - @backstage/plugin-org@0.6.18-next.2
+ - @backstage/plugin-pagerduty@0.7.0-next.2
+ - @backstage/plugin-permission-react@0.4.18-next.1
+ - @backstage/plugin-playlist@0.2.2-next.2
+ - @backstage/plugin-puppetdb@0.1.11-next.2
+ - @backstage/plugin-rollbar@0.4.28-next.2
+ - @backstage/plugin-scaffolder@1.16.2-next.2
+ - @backstage/plugin-search-common@1.2.8
+ - @backstage/plugin-sentry@0.5.13-next.2
+ - @backstage/plugin-shortcuts@0.3.17-next.2
+ - @backstage/plugin-stackstorm@0.1.9-next.2
+ - @backstage/plugin-tech-insights@0.3.20-next.2
+ - @backstage/plugin-techdocs-module-addons-contrib@1.1.3-next.2
+ - @backstage/plugin-techdocs-react@1.1.14-next.2
+ - @backstage/plugin-todo@0.2.32-next.2
+
+## 0.2.90-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/frontend-app-api@0.4.0-next.1
+ - @backstage/core-components@0.13.9-next.1
+ - @backstage/core-plugin-api@1.8.1-next.1
+ - @backstage/cli@0.25.0-next.1
+ - @backstage/plugin-catalog-react@1.9.2-next.1
+ - @backstage/plugin-catalog@1.16.0-next.2
+ - @backstage/plugin-scaffolder-react@1.6.2-next.1
+ - @backstage/plugin-home@0.6.0-next.1
+ - @backstage/plugin-github-actions@0.6.9-next.1
+ - @backstage/core-app-api@1.11.2-next.1
+ - @backstage/plugin-search-react@1.7.4-next.1
+ - @backstage/plugin-azure-devops@0.3.10-next.1
+ - @backstage/plugin-scaffolder@1.16.2-next.1
+ - @backstage/plugin-api-docs@0.10.2-next.2
+ - @backstage/plugin-gcp-projects@0.3.44-next.1
+ - @backstage/plugin-techdocs-module-addons-contrib@1.1.3-next.1
+ - @backstage/plugin-user-settings@0.7.14-next.2
+ - @backstage/plugin-adr@0.6.11-next.1
+ - @backstage/plugin-pagerduty@0.7.0-next.1
+ - @backstage/plugin-catalog-import@0.10.4-next.2
+ - @backstage/plugin-explore@0.4.14-next.1
+ - @backstage/plugin-graphiql@0.3.1-next.2
+ - @backstage/plugin-search@1.4.4-next.2
+ - @backstage/plugin-stack-overflow@0.1.23-next.1
+ - @backstage/plugin-tech-radar@0.6.11-next.2
+ - @backstage/plugin-techdocs@1.9.2-next.2
+ - @backstage/app-defaults@1.4.6-next.1
+ - @backstage/integration-react@1.1.22-next.1
+ - @backstage/plugin-airbrake@0.3.28-next.1
+ - @backstage/plugin-apache-airflow@0.2.18-next.1
+ - @backstage/plugin-azure-sites@0.1.17-next.1
+ - @backstage/plugin-badges@0.2.52-next.1
+ - @backstage/plugin-catalog-graph@0.3.2-next.1
+ - @backstage/plugin-catalog-unprocessed-entities@0.1.6-next.1
+ - @backstage/plugin-cloudbuild@0.3.28-next.1
+ - @backstage/plugin-code-coverage@0.2.21-next.1
+ - @backstage/plugin-cost-insights@0.12.17-next.1
+ - @backstage/plugin-devtools@0.1.7-next.1
+ - @backstage/plugin-dynatrace@8.0.2-next.1
+ - @backstage/plugin-entity-feedback@0.2.11-next.1
+ - @backstage/plugin-gcalendar@0.3.21-next.1
+ - @backstage/plugin-gocd@0.1.34-next.1
+ - @backstage/plugin-jenkins@0.9.3-next.1
+ - @backstage/plugin-kafka@0.3.28-next.1
+ - @backstage/plugin-kubernetes@0.11.3-next.1
+ - @backstage/plugin-kubernetes-cluster@0.0.4-next.1
+ - @backstage/plugin-lighthouse@0.4.13-next.1
+ - @backstage/plugin-linguist@0.1.13-next.1
+ - @backstage/plugin-microsoft-calendar@0.1.10-next.1
+ - @backstage/plugin-newrelic@0.3.43-next.1
+ - @backstage/plugin-newrelic-dashboard@0.3.3-next.1
+ - @backstage/plugin-nomad@0.1.9-next.1
+ - @backstage/plugin-octopus-deploy@0.2.10-next.1
+ - @backstage/plugin-org@0.6.18-next.1
+ - @backstage/plugin-playlist@0.2.2-next.1
+ - @backstage/plugin-puppetdb@0.1.11-next.1
+ - @backstage/plugin-rollbar@0.4.28-next.1
+ - @backstage/plugin-sentry@0.5.13-next.1
+ - @backstage/plugin-shortcuts@0.3.17-next.1
+ - @backstage/plugin-stackstorm@0.1.9-next.1
+ - @backstage/plugin-tech-insights@0.3.20-next.1
+ - @backstage/plugin-techdocs-react@1.1.14-next.1
+ - @backstage/plugin-todo@0.2.32-next.1
+ - @backstage/plugin-permission-react@0.4.18-next.1
+ - @backstage/catalog-model@1.4.3
+ - @backstage/config@1.1.1
+ - @backstage/theme@0.5.0-next.0
+ - @backstage/plugin-catalog-common@1.0.18
+ - @backstage/plugin-linguist-common@0.1.2
+ - @backstage/plugin-search-common@1.2.8
+
## 0.2.90-next.1
### Patch Changes
diff --git a/packages/app/package.json b/packages/app/package.json
index 7cf7ae3290..ae03c7aa11 100644
--- a/packages/app/package.json
+++ b/packages/app/package.json
@@ -1,6 +1,6 @@
{
"name": "example-app",
- "version": "0.2.90-next.1",
+ "version": "0.2.92-next.0",
"private": true,
"backstage": {
"role": "frontend"
@@ -35,7 +35,6 @@
"@backstage/plugin-catalog-import": "workspace:^",
"@backstage/plugin-catalog-react": "workspace:^",
"@backstage/plugin-catalog-unprocessed-entities": "workspace:^",
- "@backstage/plugin-circleci": "workspace:^",
"@backstage/plugin-cloudbuild": "workspace:^",
"@backstage/plugin-code-coverage": "workspace:^",
"@backstage/plugin-cost-insights": "workspace:^",
@@ -74,6 +73,7 @@
"@backstage/plugin-search-react": "workspace:^",
"@backstage/plugin-sentry": "workspace:^",
"@backstage/plugin-shortcuts": "workspace:^",
+ "@backstage/plugin-signals": "workspace:^",
"@backstage/plugin-stack-overflow": "workspace:^",
"@backstage/plugin-stackstorm": "workspace:^",
"@backstage/plugin-tech-insights": "workspace:^",
@@ -84,6 +84,7 @@
"@backstage/plugin-todo": "workspace:^",
"@backstage/plugin-user-settings": "workspace:^",
"@backstage/theme": "workspace:^",
+ "@circleci/backstage-plugin": "^0.1.1",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
"@material-ui/lab": "4.0.0-alpha.61",
@@ -102,7 +103,7 @@
"react-use": "^17.2.4",
"vite": "^4.4.9",
"vite-plugin-html": "^3.2.0",
- "vite-plugin-node-polyfills": "^0.16.0",
+ "vite-plugin-node-polyfills": "^0.19.0",
"zen-observable": "^0.10.0"
},
"devDependencies": {
diff --git a/packages/app/src/App.test.tsx b/packages/app/src/App.test.tsx
index 8c7cefeb2c..919a60e53d 100644
--- a/packages/app/src/App.test.tsx
+++ b/packages/app/src/App.test.tsx
@@ -15,7 +15,7 @@
*/
import React from 'react';
-import { renderWithEffects } from '@backstage/test-utils';
+import { render, waitFor } from '@testing-library/react';
import App from './App';
describe('App', () => {
@@ -42,7 +42,10 @@ describe('App', () => {
] as any,
};
- const rendered = await renderWithEffects(
-
- entity?.metadata?.tags?.includes('recommended') ?? false,
- },
- ]}
- />
- }
- >
-
-
-
-
-
-
-
-
- entity?.metadata?.tags?.includes('recommended') ?? false,
- },
- ]}
- />
- }
- >
-
-
-
-
-
-
+
+ entity?.metadata?.tags?.includes('recommended') ?? false,
+ },
+ ]}
+ />
+ }
+ >
+
+
+
+
+
+
+
+
diff --git a/packages/app/src/index-public-experimental.tsx b/packages/app/src/index-public-experimental.tsx
new file mode 100644
index 0000000000..9e5f89b4c2
--- /dev/null
+++ b/packages/app/src/index-public-experimental.tsx
@@ -0,0 +1,82 @@
+/*
+ * 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 { createApp } from '@backstage/app-defaults';
+import { AppRouter } from '@backstage/core-app-api';
+import {
+ AlertDisplay,
+ OAuthRequestDialog,
+ SignInPage,
+} from '@backstage/core-components';
+import React from 'react';
+import ReactDOM from 'react-dom/client';
+import { providers } from '../src/identityProviders';
+import {
+ configApiRef,
+ createApiFactory,
+ discoveryApiRef,
+ useApi,
+} from '@backstage/core-plugin-api';
+import { AuthProxyDiscoveryApi } from '../src/AuthProxyDiscoveryApi';
+
+// TODO(Rugvip): make this available via some util, or maybe Utility API?
+function readBasePath(configApi: typeof configApiRef.T) {
+ let { pathname } = new URL(
+ configApi.getOptionalString('app.baseUrl') ?? '/',
+ 'http://sample.dev', // baseUrl can be specified as just a path
+ );
+ pathname = pathname.replace(/\/*$/, '');
+ return pathname;
+}
+
+const app = createApp({
+ apis: [
+ createApiFactory({
+ api: discoveryApiRef,
+ deps: { configApi: configApiRef },
+ factory: ({ configApi }) => AuthProxyDiscoveryApi.fromConfig(configApi),
+ }),
+ ],
+ components: {
+ SignInPage: props => {
+ return (
+
+
+ ,
+);
+
+ReactDOM.createRoot(document.getElementById('root')!).render(({ id: 'a' });
init.add(
createBackendPlugin({
- pluginId: 'testA',
+ pluginId: 'test-a',
register(reg) {
reg.registerExtensionPoint(extA, 'a');
reg.registerInit({
@@ -310,7 +310,7 @@ describe('BackendInitializer', () => {
);
init.add(
createBackendModule({
- pluginId: 'testB',
+ pluginId: 'test-b',
moduleId: 'mod',
register(reg) {
reg.registerInit({
@@ -321,7 +321,7 @@ describe('BackendInitializer', () => {
})(),
);
await expect(init.start()).rejects.toThrow(
- "Extension point registered for plugin 'testA' may not be used by module for plugin 'testB'",
+ "Illegal dependency: Module 'mod' for plugin 'test-b' attempted to depend on extension point 'a' for plugin 'test-a'. Extension points can only be used within their plugin's scope.",
);
});
});
diff --git a/packages/backend-app-api/src/wiring/BackendInitializer.ts b/packages/backend-app-api/src/wiring/BackendInitializer.ts
index 4969f82176..2da3a5a226 100644
--- a/packages/backend-app-api/src/wiring/BackendInitializer.ts
+++ b/packages/backend-app-api/src/wiring/BackendInitializer.ts
@@ -55,6 +55,7 @@ export class BackendInitializer {
async #getInitDeps(
deps: { [name: string]: ServiceOrExtensionPoint },
pluginId: string,
+ moduleId?: string,
) {
const result = new Map();
const missingRefs = new Set();
@@ -64,7 +65,7 @@ export class BackendInitializer {
if (ep) {
if (ep.pluginId !== pluginId) {
throw new Error(
- `Extension point registered for plugin '${ep.pluginId}' may not be used by module for plugin '${pluginId}'`,
+ `Illegal dependency: Module '${moduleId}' for plugin '${pluginId}' attempted to depend on extension point '${ref.id}' for plugin '${ep.pluginId}'. Extension points can only be used within their plugin's scope.`,
);
}
result.set(name, ep.impl);
@@ -260,6 +261,7 @@ export class BackendInitializer {
const moduleDeps = await this.#getInitDeps(
moduleInit.init.deps,
pluginId,
+ moduleId,
);
await moduleInit.init.func(moduleDeps).catch(error => {
throw new ForwardedError(
diff --git a/packages/backend-common/CHANGELOG.md b/packages/backend-common/CHANGELOG.md
index 16a4bcafb4..ca05772aa5 100644
--- a/packages/backend-common/CHANGELOG.md
+++ b/packages/backend-common/CHANGELOG.md
@@ -1,5 +1,176 @@
# @backstage/backend-common
+## 0.21.0-next.0
+
+### Minor Changes
+
+- e85aa98: drop databases after unit tests if the database instance is not running in docker
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-app-api@0.5.11-next.0
+ - @backstage/config-loader@1.6.1
+ - @backstage/backend-dev-utils@0.1.3
+ - @backstage/backend-plugin-api@0.6.10-next.0
+ - @backstage/cli-common@0.1.13
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/integration@1.8.0
+ - @backstage/integration-aws-node@0.1.8
+ - @backstage/types@1.1.1
+
+## 0.20.1
+
+### Patch Changes
+
+- 3b24eae: Adding support for removing file from git index
+- 454d17c: Do not call fetch directly but rather use `fetchResponse` facility
+- b6b15b2: Use sha256 instead of md5 for hash key calculation in caches
+
+ This can have a side effect of invalidating caches (when cache key was >250 characters)
+ This improves compliance with FIPS nodejs
+
+- Updated dependencies
+ - @backstage/config-loader@1.6.1
+ - @backstage/backend-plugin-api@0.6.9
+ - @backstage/backend-dev-utils@0.1.3
+ - @backstage/backend-app-api@0.5.10
+ - @backstage/cli-common@0.1.13
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/integration@1.8.0
+ - @backstage/integration-aws-node@0.1.8
+ - @backstage/types@1.1.1
+
+## 0.20.1-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.6.9-next.2
+ - @backstage/backend-dev-utils@0.1.3-next.0
+ - @backstage/backend-app-api@0.5.10-next.2
+ - @backstage/config-loader@1.6.1-next.0
+
+## 0.20.1-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/config-loader@1.6.1-next.0
+ - @backstage/backend-app-api@0.5.10-next.1
+ - @backstage/integration@1.8.0
+ - @backstage/integration-aws-node@0.1.8
+ - @backstage/config@1.1.1
+ - @backstage/backend-dev-utils@0.1.2
+ - @backstage/backend-plugin-api@0.6.9-next.1
+ - @backstage/cli-common@0.1.13
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+
+## 0.20.1-next.0
+
+### Patch Changes
+
+- b6b15b2: Use sha256 instead of md5 for hash key calculation in caches
+
+ This can have a side effect of invalidating caches (when cache key was >250 characters)
+ This improves compliance with FIPS nodejs
+
+- Updated dependencies
+ - @backstage/backend-app-api@0.5.10-next.0
+ - @backstage/backend-dev-utils@0.1.2
+ - @backstage/backend-plugin-api@0.6.9-next.0
+ - @backstage/cli-common@0.1.13
+ - @backstage/config@1.1.1
+ - @backstage/config-loader@1.6.0
+ - @backstage/errors@1.2.3
+ - @backstage/integration@1.8.0
+ - @backstage/integration-aws-node@0.1.8
+ - @backstage/types@1.1.1
+
+## 0.20.0
+
+### Minor Changes
+
+- 870db76: Implemented `readTree` for Gitea provider to support TechDocs functionality
+
+### Patch Changes
+
+- 7f04128: Allow a default cache TTL to be set through the app config
+- 1ad8906: Use `Readable.from` to fix some of the stream issues
+- d86a007: Fixed the AwsS3UrlReader host regex and host to allow the S3 reading for CN AWS domain
+- bc67498: Updated dependency `archiver` to `^6.0.0`.
+ Updated dependency `@types/archiver` to `^6.0.0`.
+- 706fc3a: Updated dependency `@kubernetes/client-node` to `0.20.0`.
+- 2666675: Updated dependency `@google-cloud/storage` to `^7.0.0`.
+- d15d483: Add command `--runAsDefaultUser` for `@techdocs/cli generate` to bypass running the docker builds as host user for macOS and Linux.
+- d1e00aa: Expose an `onAuth` handler for `git` actions to provide custom credentials
+- Updated dependencies
+ - @backstage/config-loader@1.6.0
+ - @backstage/backend-app-api@0.5.9
+ - @backstage/integration@1.8.0
+ - @backstage/backend-dev-utils@0.1.2
+ - @backstage/backend-plugin-api@0.6.8
+ - @backstage/cli-common@0.1.13
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/integration-aws-node@0.1.8
+ - @backstage/types@1.1.1
+
+## 0.20.0-next.3
+
+### Patch Changes
+
+- d86a007: Fixed the AwsS3UrlReader host regex and host to allow the S3 reading for CN AWS domain
+- Updated dependencies
+ - @backstage/backend-app-api@0.5.9-next.3
+ - @backstage/backend-dev-utils@0.1.2
+ - @backstage/backend-plugin-api@0.6.8-next.3
+ - @backstage/cli-common@0.1.13
+ - @backstage/config@1.1.1
+ - @backstage/config-loader@1.6.0-next.0
+ - @backstage/errors@1.2.3
+ - @backstage/integration@1.8.0-next.1
+ - @backstage/integration-aws-node@0.1.8
+ - @backstage/types@1.1.1
+
+## 0.20.0-next.2
+
+### Patch Changes
+
+- bc67498: Updated dependency `archiver` to `^6.0.0`.
+ Updated dependency `@types/archiver` to `^6.0.0`.
+- Updated dependencies
+ - @backstage/config-loader@1.6.0-next.0
+ - @backstage/backend-app-api@0.5.9-next.2
+ - @backstage/backend-dev-utils@0.1.2
+ - @backstage/backend-plugin-api@0.6.8-next.2
+ - @backstage/cli-common@0.1.13
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/integration@1.8.0-next.1
+ - @backstage/integration-aws-node@0.1.8
+ - @backstage/types@1.1.1
+
+## 0.20.0-next.1
+
+### Patch Changes
+
+- 2666675457: Updated dependency `@google-cloud/storage` to `^7.0.0`.
+- Updated dependencies
+ - @backstage/backend-app-api@0.5.9-next.1
+ - @backstage/integration@1.8.0-next.1
+ - @backstage/backend-dev-utils@0.1.2
+ - @backstage/backend-plugin-api@0.6.8-next.1
+ - @backstage/cli-common@0.1.13
+ - @backstage/config@1.1.1
+ - @backstage/config-loader@1.5.3
+ - @backstage/errors@1.2.3
+ - @backstage/integration-aws-node@0.1.8
+ - @backstage/types@1.1.1
+
## 0.20.0-next.0
### Minor Changes
diff --git a/packages/backend-common/alpha-api-report.md b/packages/backend-common/api-report-alpha.md
similarity index 100%
rename from packages/backend-common/alpha-api-report.md
rename to packages/backend-common/api-report-alpha.md
diff --git a/packages/backend-common/testUtils-api-report.md b/packages/backend-common/api-report-testUtils.md
similarity index 100%
rename from packages/backend-common/testUtils-api-report.md
rename to packages/backend-common/api-report-testUtils.md
diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md
index e7d89c2aa5..e4a1ecfdf1 100644
--- a/packages/backend-common/api-report.md
+++ b/packages/backend-common/api-report.md
@@ -276,6 +276,12 @@ export class DockerContainerRunner implements ContainerRunner {
runContainer(options: RunContainerOptions): Promise;
}
+// @public
+export function dropDatabase(
+ dbConfig: Config,
+ ...databases: Array
+): Promise;
+
// @public
export function ensureDatabaseExists(
dbConfig: Config,
@@ -417,6 +423,7 @@ export class Git {
force?: boolean;
}): Promise;
readCommit(options: { dir: string; sha: string }): Promise;
+ remove(options: { dir: string; filepath: string }): Promise;
resolveRef(options: { dir: string; ref: string }): Promise;
}
diff --git a/packages/backend-common/package.json b/packages/backend-common/package.json
index dd52df0b40..4df64738ce 100644
--- a/packages/backend-common/package.json
+++ b/packages/backend-common/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/backend-common",
"description": "Common functionality library for Backstage backends",
- "version": "0.20.0-next.0",
+ "version": "0.21.0-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
@@ -64,7 +64,7 @@
"@backstage/integration": "workspace:^",
"@backstage/integration-aws-node": "workspace:^",
"@backstage/types": "workspace:^",
- "@google-cloud/storage": "^6.0.0",
+ "@google-cloud/storage": "^7.0.0",
"@keyv/memcache": "^1.3.5",
"@keyv/redis": "^2.5.3",
"@kubernetes/client-node": "0.20.0",
@@ -75,7 +75,7 @@
"@types/express": "^4.17.6",
"@types/luxon": "^3.0.0",
"@types/webpack-env": "^1.15.2",
- "archiver": "^5.0.2",
+ "archiver": "^6.0.0",
"base64-stream": "^1.0.0",
"compression": "^1.7.4",
"concat-stream": "^2.0.0",
@@ -118,7 +118,7 @@
"@aws-sdk/util-stream-node": "^3.350.0",
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
- "@types/archiver": "^5.1.0",
+ "@types/archiver": "^6.0.0",
"@types/base64-stream": "^1.0.2",
"@types/compression": "^1.7.0",
"@types/concat-stream": "^2.0.0",
diff --git a/packages/backend-common/src/cache/CacheClient.ts b/packages/backend-common/src/cache/CacheClient.ts
index 24ee7ac455..aba62558d4 100644
--- a/packages/backend-common/src/cache/CacheClient.ts
+++ b/packages/backend-common/src/cache/CacheClient.ts
@@ -88,6 +88,6 @@ export class DefaultCacheClient implements CacheService {
return wellFormedKey;
}
- return createHash('md5').update(candidateKey).digest('base64');
+ return createHash('sha256').update(candidateKey).digest('base64');
}
}
diff --git a/packages/backend-common/src/database/connection.test.ts b/packages/backend-common/src/database/connection.test.ts
index caf2fccc30..3028d46cae 100644
--- a/packages/backend-common/src/database/connection.test.ts
+++ b/packages/backend-common/src/database/connection.test.ts
@@ -19,10 +19,11 @@ import {
createDatabaseClient,
createNameOverride,
createSchemaOverride,
+ dropDatabase,
ensureSchemaExists,
parseConnectionString,
} from './connection';
-import { pgConnector } from './connectors';
+import { mysqlConnector, pgConnector } from './connectors';
const mocked = (f: Function) => f as jest.Mock;
@@ -30,8 +31,13 @@ jest.mock('./connectors', () => {
const connectors = jest.requireActual('./connectors');
return {
...connectors,
+ mysqlConnector: {
+ ...connectors.mysqlConnector,
+ dropDatabase: jest.fn(),
+ },
pgConnector: {
...connectors.pgConnector,
+ dropDatabase: jest.fn(),
ensureSchemaExists: jest.fn(),
},
};
@@ -229,4 +235,74 @@ describe('database connection', () => {
).resolves.toBeUndefined();
});
});
+
+ describe('dropDatabase', () => {
+ it('returns successfully with pg client', async () => {
+ await dropDatabase(
+ new ConfigReader({
+ client: 'pg',
+ schema: 'catalog',
+ connection: 'postgresql://testuser:testpass@acme:5432/userdbname',
+ }),
+ 'backstage_plugin_foobar',
+ );
+
+ const mockCalls = mocked(
+ pgConnector.dropDatabase as Function,
+ ).mock.calls.splice(-1);
+ const [baseConfig, databaseName] = mockCalls[0];
+
+ expect(baseConfig.get()).toMatchObject({
+ client: 'pg',
+ connection: 'postgresql://testuser:testpass@acme:5432/userdbname',
+ });
+
+ expect(databaseName).toEqual('backstage_plugin_foobar');
+ });
+
+ it('returns successfully with mysql client', async () => {
+ await dropDatabase(
+ new ConfigReader({
+ client: 'mysql2',
+ connection: {
+ host: '127.0.0.1',
+ user: 'foo',
+ password: 'bar',
+ database: 'dbname',
+ },
+ }),
+ 'backstage_plugin_foobar',
+ );
+
+ const mockCalls = mocked(
+ mysqlConnector.dropDatabase as Function,
+ ).mock.calls.splice(-1);
+ const [baseConfig, databaseName] = mockCalls[0];
+
+ expect(baseConfig.get()).toMatchObject({
+ client: 'mysql2',
+ connection: {
+ host: '127.0.0.1',
+ user: 'foo',
+ password: 'bar',
+ database: 'dbname',
+ },
+ });
+
+ expect(databaseName).toEqual('backstage_plugin_foobar');
+ });
+
+ it('does nothing in other database drivers', () => {
+ return expect(
+ dropDatabase(
+ new ConfigReader({
+ client: 'better-sqlite3',
+ schema: 'catalog',
+ connection: ':memory:',
+ }),
+ 'catalog',
+ ),
+ ).resolves.toBeUndefined();
+ });
+ });
});
diff --git a/packages/backend-common/src/database/connection.ts b/packages/backend-common/src/database/connection.ts
index e369323e04..c0e031516f 100644
--- a/packages/backend-common/src/database/connection.ts
+++ b/packages/backend-common/src/database/connection.ts
@@ -95,6 +95,22 @@ export async function ensureDatabaseExists(
);
}
+/**
+ * Drops the given databases.
+ *
+ * @public
+ */
+export async function dropDatabase(
+ dbConfig: Config,
+ ...databases: Array
+): Promise {
+ const client: DatabaseClient = dbConfig.getString('client');
+
+ return await ddlLimiter(() =>
+ ConnectorMapping[client]?.dropDatabase?.(dbConfig, ...databases),
+ );
+}
+
/**
* Ensures that the given schemas all exist, creating them if they do not.
*
diff --git a/packages/backend-common/src/database/connectors/mysql.ts b/packages/backend-common/src/database/connectors/mysql.ts
index 16610dd920..a4bac3f7e1 100644
--- a/packages/backend-common/src/database/connectors/mysql.ts
+++ b/packages/backend-common/src/database/connectors/mysql.ts
@@ -183,6 +183,40 @@ export async function ensureMysqlDatabaseExists(
}
}
+/**
+ * Drops the given mysql databases.
+ *
+ * @param dbConfig - The database config
+ * @param databases - The names of the databases to create
+ */
+export async function dropMysqlDatabase(
+ dbConfig: Config,
+ ...databases: Array
+) {
+ const admin = createMysqlDatabaseClient(dbConfig, {
+ connection: {
+ database: null as unknown as string,
+ },
+ pool: {
+ min: 0,
+ acquireTimeoutMillis: 10000,
+ },
+ });
+
+ try {
+ const dropDatabase = async (database: string) => {
+ await admin.raw(`DROP DATABASE ??`, [database]);
+ };
+ await Promise.all(
+ databases.map(async database => {
+ return await dropDatabase(database);
+ }),
+ );
+ } finally {
+ await admin.destroy();
+ }
+}
+
/**
* MySQL database connector.
*
@@ -193,4 +227,5 @@ export const mysqlConnector: DatabaseConnector = Object.freeze({
ensureDatabaseExists: ensureMysqlDatabaseExists,
createNameOverride: defaultNameOverride,
parseConnectionString: parseMysqlConnectionString,
+ dropDatabase: dropMysqlDatabase,
});
diff --git a/packages/backend-common/src/database/connectors/postgres.ts b/packages/backend-common/src/database/connectors/postgres.ts
index f132488e29..dc9b19f6ad 100644
--- a/packages/backend-common/src/database/connectors/postgres.ts
+++ b/packages/backend-common/src/database/connectors/postgres.ts
@@ -199,6 +199,24 @@ export async function ensurePgSchemaExists(
}
}
+/**
+ * Drops the Postgres databases.
+ *
+ * @param dbConfig - The database config
+ * @param databases - The name of the databases to drop
+ */
+export async function dropPgDatabase(
+ dbConfig: Config,
+ ...databases: Array
+) {
+ const admin = createPgDatabaseClient(dbConfig);
+ await Promise.all(
+ databases.map(async database => {
+ await admin.raw(`DROP DATABASE ??`, [database]);
+ }),
+ );
+}
+
/**
* PostgreSQL database connector.
*
@@ -211,4 +229,5 @@ export const pgConnector: DatabaseConnector = Object.freeze({
createNameOverride: defaultNameOverride,
createSchemaOverride: defaultSchemaOverride,
parseConnectionString: parsePgConnectionString,
+ dropDatabase: dropPgDatabase,
});
diff --git a/packages/backend-common/src/database/index.ts b/packages/backend-common/src/database/index.ts
index 0dde1ec239..330429f0ef 100644
--- a/packages/backend-common/src/database/index.ts
+++ b/packages/backend-common/src/database/index.ts
@@ -20,7 +20,11 @@ export * from './DatabaseManager';
* Undocumented API surface from connection is being reduced for future deprecation.
* Avoid exporting additional symbols.
*/
-export { createDatabaseClient, ensureDatabaseExists } from './connection';
+export {
+ createDatabaseClient,
+ ensureDatabaseExists,
+ dropDatabase,
+} from './connection';
export type { PluginDatabaseManager } from './types';
export { isDatabaseConflictError } from './util';
diff --git a/packages/backend-common/src/database/types.ts b/packages/backend-common/src/database/types.ts
index 621bcc676b..3e9832aec5 100644
--- a/packages/backend-common/src/database/types.ts
+++ b/packages/backend-common/src/database/types.ts
@@ -79,4 +79,6 @@ export interface DatabaseConnector {
dbConfig: Config,
...schemas: Array
): Promise;
+
+ dropDatabase?(dbConfig: Config, ...databases: Array): Promise;
}
diff --git a/packages/backend-common/src/reading/AwsS3UrlReader.test.ts b/packages/backend-common/src/reading/AwsS3UrlReader.test.ts
index b37a052c1d..e3247f190b 100644
--- a/packages/backend-common/src/reading/AwsS3UrlReader.test.ts
+++ b/packages/backend-common/src/reading/AwsS3UrlReader.test.ts
@@ -53,6 +53,39 @@ describe('parseUrl', () => {
bucket: 'my.bucket-3',
region: 'us-east-1',
});
+ expect(
+ parseUrl('https://s3.amazonaws.com.cn/my.bucket-3/a/puppy.jpg', {
+ host: 'amazonaws.com',
+ }),
+ ).toEqual({
+ path: 'a/puppy.jpg',
+ bucket: 'my.bucket-3',
+ region: 'us-east-1',
+ });
+ expect(
+ parseUrl(
+ 'https://ec-backstage-staging.s3.cn-north-1.amazonaws.com.cn/payments-prod-oas30.json',
+ {
+ host: 'amazonaws.com',
+ },
+ ),
+ ).toEqual({
+ path: 'payments-prod-oas30.json',
+ bucket: 'ec-backstage-staging',
+ region: 'cn-north-1',
+ });
+ expect(
+ parseUrl(
+ 'https://ec-backstage-staging.s3.cn-north-1.amazonaws.com.cn/payments-prod-oas30.json',
+ {
+ host: 'amazonaws.com.cn',
+ },
+ ),
+ ).toEqual({
+ path: 'payments-prod-oas30.json',
+ bucket: 'ec-backstage-staging',
+ region: 'cn-north-1',
+ });
expect(
parseUrl('https://s3.us-west-2.amazonaws.com/my.bucket-3/a/puppy.jpg', {
host: 'amazonaws.com',
diff --git a/packages/backend-common/src/reading/AwsS3UrlReader.ts b/packages/backend-common/src/reading/AwsS3UrlReader.ts
index 4d4c28071f..23ef0f7b27 100644
--- a/packages/backend-common/src/reading/AwsS3UrlReader.ts
+++ b/packages/backend-common/src/reading/AwsS3UrlReader.ts
@@ -69,9 +69,9 @@ export function parseUrl(
const host = parsedUrl.host;
// Treat Amazon hosted separately because it has special region logic
- if (config.host === 'amazonaws.com') {
+ if (config.host === 'amazonaws.com' || config.host === 'amazonaws.com.cn') {
const match = host.match(
- /^(?:([a-z0-9.-]+)\.)?s3(?:[.-]([a-z0-9-]+))?\.amazonaws\.com$/,
+ /^(?:([a-z0-9.-]+)\.)?s3(?:[.-]([a-z0-9-]+))?\.amazonaws\.com(\.cn)?$/,
);
if (!match) {
throw new Error(`Invalid AWS S3 URL ${url}`);
diff --git a/packages/backend-common/src/reading/GithubUrlReader.ts b/packages/backend-common/src/reading/GithubUrlReader.ts
index 764431386d..67f6a975c1 100644
--- a/packages/backend-common/src/reading/GithubUrlReader.ts
+++ b/packages/backend-common/src/reading/GithubUrlReader.ts
@@ -105,58 +105,28 @@ export class GithubUrlReader implements UrlReader {
credentials,
);
- let response: Response;
- try {
- response = await fetch(ghUrl, {
- headers: {
- ...credentials?.headers,
- ...(options?.etag && { 'If-None-Match': options.etag }),
- ...(options?.lastModifiedAfter && {
- 'If-Modified-Since': options.lastModifiedAfter.toUTCString(),
- }),
- Accept: 'application/vnd.github.v3.raw',
- },
- // TODO(freben): The signal cast is there because pre-3.x versions of
- // node-fetch have a very slightly deviating AbortSignal type signature.
- // The difference does not affect us in practice however. The cast can
- // be removed after we support ESM for CLI dependencies and migrate to
- // version 3 of node-fetch.
- // https://github.com/backstage/backstage/issues/8242
- signal: options?.signal as any,
- });
- } catch (e) {
- throw new Error(`Unable to read ${url}, ${e}`);
- }
+ const response = await this.fetchResponse(ghUrl, {
+ headers: {
+ ...credentials?.headers,
+ ...(options?.etag && { 'If-None-Match': options.etag }),
+ ...(options?.lastModifiedAfter && {
+ 'If-Modified-Since': options.lastModifiedAfter.toUTCString(),
+ }),
+ Accept: 'application/vnd.github.v3.raw',
+ },
+ // TODO(freben): The signal cast is there because pre-3.x versions of
+ // node-fetch have a very slightly deviating AbortSignal type signature.
+ // The difference does not affect us in practice however. The cast can
+ // be removed after we support ESM for CLI dependencies and migrate to
+ // version 3 of node-fetch.
+ // https://github.com/backstage/backstage/issues/8242
+ signal: options?.signal as any,
+ });
- if (response.status === 304) {
- throw new NotModifiedError();
- }
-
- if (response.ok) {
- return ReadUrlResponseFactory.fromNodeJSReadable(response.body, {
- etag: response.headers.get('ETag') ?? undefined,
- lastModifiedAt: parseLastModified(
- response.headers.get('Last-Modified'),
- ),
- });
- }
-
- let message = `${url} could not be read as ${ghUrl}, ${response.status} ${response.statusText}`;
- if (response.status === 404) {
- throw new NotFoundError(message);
- }
-
- // GitHub returns a 403 response with a couple of headers indicating rate
- // limit status. See more in the GitHub docs:
- // https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting
- if (
- response.status === 403 &&
- response.headers.get('X-RateLimit-Remaining') === '0'
- ) {
- message += ' (rate limit exceeded)';
- }
-
- throw new Error(message);
+ return ReadUrlResponseFactory.fromNodeJSReadable(response.body, {
+ etag: response.headers.get('ETag') ?? undefined,
+ lastModifiedAt: parseLastModified(response.headers.get('Last-Modified')),
+ });
}
async readTree(
@@ -350,10 +320,26 @@ export class GithubUrlReader implements UrlReader {
const response = await fetch(urlAsString, init);
if (!response.ok) {
- const message = `Request failed for ${urlAsString}, ${response.status} ${response.statusText}`;
+ let message = `Request failed for ${urlAsString}, ${response.status} ${response.statusText}`;
+
+ if (response.status === 304) {
+ throw new NotModifiedError();
+ }
+
if (response.status === 404) {
throw new NotFoundError(message);
}
+
+ // GitHub returns a 403 response with a couple of headers indicating rate
+ // limit status. See more in the GitHub docs:
+ // https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting
+ if (
+ response.status === 403 &&
+ response.headers.get('X-RateLimit-Remaining') === '0'
+ ) {
+ message += ' (rate limit exceeded)';
+ }
+
throw new Error(message);
}
diff --git a/packages/backend-common/src/scm/git.test.ts b/packages/backend-common/src/scm/git.test.ts
index 7533c6e2f3..1c07dfb917 100644
--- a/packages/backend-common/src/scm/git.test.ts
+++ b/packages/backend-common/src/scm/git.test.ts
@@ -63,6 +63,22 @@ describe('Git', () => {
});
});
+ describe('remove', () => {
+ it('should call isomorphic-git remove with the correct arguments', async () => {
+ const git = Git.fromAuth({});
+ const dir = 'mockdirectory';
+ const filepath = 'mockfile/path';
+
+ await git.remove({ dir, filepath });
+
+ expect(isomorphic.remove).toHaveBeenCalledWith({
+ fs,
+ dir,
+ filepath,
+ });
+ });
+ });
+
describe('deleteRemote', () => {
it('should call isomorphic-git with the correct arguments', async () => {
const git = Git.fromAuth({});
diff --git a/packages/backend-common/src/scm/git.ts b/packages/backend-common/src/scm/git.ts
index 364e1bacd5..e7bad693fe 100644
--- a/packages/backend-common/src/scm/git.ts
+++ b/packages/backend-common/src/scm/git.ts
@@ -300,6 +300,15 @@ export class Git {
return git.readCommit({ fs, dir, oid: sha });
}
+ /** https://isomorphic-git.org/docs/en/remove */
+ async remove(options: { dir: string; filepath: string }): Promise {
+ const { dir, filepath } = options;
+ this.config.logger?.info(
+ `Removing file from git index {dir=${dir},filepath=${filepath}}`,
+ );
+ return git.remove({ fs, dir, filepath });
+ }
+
/** https://isomorphic-git.org/docs/en/resolveRef */
async resolveRef(options: { dir: string; ref: string }): Promise {
const { dir, ref } = options;
diff --git a/packages/backend-defaults/CHANGELOG.md b/packages/backend-defaults/CHANGELOG.md
index 7354e39b9d..1b50491f54 100644
--- a/packages/backend-defaults/CHANGELOG.md
+++ b/packages/backend-defaults/CHANGELOG.md
@@ -1,5 +1,88 @@
# @backstage/backend-defaults
+## 0.2.10-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.21.0-next.0
+ - @backstage/backend-app-api@0.5.11-next.0
+ - @backstage/backend-plugin-api@0.6.10-next.0
+
+## 0.2.9
+
+### Patch Changes
+
+- 516fd3e: Updated README to reflect release status
+- Updated dependencies
+ - @backstage/backend-common@0.20.1
+ - @backstage/backend-plugin-api@0.6.9
+ - @backstage/backend-app-api@0.5.10
+
+## 0.2.9-next.2
+
+### Patch Changes
+
+- 516fd3e: Updated README to reflect release status
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.6.9-next.2
+ - @backstage/backend-app-api@0.5.10-next.2
+ - @backstage/backend-common@0.20.1-next.2
+
+## 0.2.9-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-app-api@0.5.10-next.1
+ - @backstage/backend-common@0.20.1-next.1
+ - @backstage/backend-plugin-api@0.6.9-next.1
+
+## 0.2.9-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.1-next.0
+ - @backstage/backend-app-api@0.5.10-next.0
+ - @backstage/backend-plugin-api@0.6.9-next.0
+
+## 0.2.8
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.0
+ - @backstage/backend-app-api@0.5.9
+ - @backstage/backend-plugin-api@0.6.8
+
+## 0.2.8-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.0-next.3
+ - @backstage/backend-app-api@0.5.9-next.3
+ - @backstage/backend-plugin-api@0.6.8-next.3
+
+## 0.2.8-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.0-next.2
+ - @backstage/backend-app-api@0.5.9-next.2
+ - @backstage/backend-plugin-api@0.6.8-next.2
+
+## 0.2.8-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-app-api@0.5.9-next.1
+ - @backstage/backend-common@0.20.0-next.1
+ - @backstage/backend-plugin-api@0.6.8-next.1
+
## 0.2.8-next.0
### Patch Changes
diff --git a/packages/backend-defaults/README.md b/packages/backend-defaults/README.md
index 2dcc5766df..01e42d42c4 100644
--- a/packages/backend-defaults/README.md
+++ b/packages/backend-defaults/README.md
@@ -1,7 +1,5 @@
# @backstage/backend-defaults
-**This package is EXPERIMENTAL, we recommend against using it for production deployments**
-
This package provides the default implementations and setup for a standard Backstage backend app.
## Installation
diff --git a/packages/backend-defaults/package.json b/packages/backend-defaults/package.json
index bb2e2b0743..3e8793cd3e 100644
--- a/packages/backend-defaults/package.json
+++ b/packages/backend-defaults/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/backend-defaults",
"description": "Backend defaults used by Backstage backend apps",
- "version": "0.2.8-next.0",
+ "version": "0.2.10-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
diff --git a/packages/backend-dev-utils/CHANGELOG.md b/packages/backend-dev-utils/CHANGELOG.md
index f1d1887b78..1c4deba50a 100644
--- a/packages/backend-dev-utils/CHANGELOG.md
+++ b/packages/backend-dev-utils/CHANGELOG.md
@@ -1,5 +1,17 @@
# @backstage/backend-dev-utils
+## 0.1.3
+
+### Patch Changes
+
+- 516fd3e: Updated README to reflect release status
+
+## 0.1.3-next.0
+
+### Patch Changes
+
+- 516fd3e: Updated README to reflect release status
+
## 0.1.2
### Patch Changes
diff --git a/packages/backend-dev-utils/README.md b/packages/backend-dev-utils/README.md
index cebe591d50..744a9d2ca0 100644
--- a/packages/backend-dev-utils/README.md
+++ b/packages/backend-dev-utils/README.md
@@ -1,7 +1,5 @@
# @backstage/backend-dev-utils
-**This package is EXPERIMENTAL, but we encourage use of it to add support for the new backend system in your own plugins**
-
This package helps set up local development environments for Backstage backend packages.
## Installation
diff --git a/packages/backend-dev-utils/package.json b/packages/backend-dev-utils/package.json
index b6156e622c..67fd763dcd 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.2",
+ "version": "0.1.3",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/packages/backend-plugin-manager/.eslintrc.js b/packages/backend-dynamic-feature-service/.eslintrc.js
similarity index 100%
rename from packages/backend-plugin-manager/.eslintrc.js
rename to packages/backend-dynamic-feature-service/.eslintrc.js
diff --git a/packages/backend-plugin-manager/CHANGELOG.md b/packages/backend-dynamic-feature-service/CHANGELOG.md
similarity index 56%
rename from packages/backend-plugin-manager/CHANGELOG.md
rename to packages/backend-dynamic-feature-service/CHANGELOG.md
index f826362f2d..fa60b2d208 100644
--- a/packages/backend-plugin-manager/CHANGELOG.md
+++ b/packages/backend-dynamic-feature-service/CHANGELOG.md
@@ -1,4 +1,209 @@
-# @backstage/backend-plugin-manager
+# @backstage/backend-dynamic-feature-service
+
+## 0.1.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.21.0-next.0
+ - @backstage/plugin-catalog-backend@1.17.0-next.0
+ - @backstage/plugin-scaffolder-node@0.3.0-next.0
+ - @backstage/backend-tasks@0.5.15-next.0
+ - @backstage/cli-node@0.2.2
+ - @backstage/plugin-auth-node@0.4.4-next.0
+ - @backstage/plugin-events-backend@0.2.19-next.0
+ - @backstage/plugin-permission-node@0.7.21-next.0
+ - @backstage/plugin-search-backend-node@1.2.14-next.0
+ - @backstage/backend-plugin-api@0.6.10-next.0
+ - @backstage/cli-common@0.1.13
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+ - @backstage/plugin-events-node@0.2.19-next.0
+ - @backstage/plugin-permission-common@0.7.12
+ - @backstage/plugin-search-common@1.2.10
+
+## 0.1.0
+
+### Minor Changes
+
+- eb81f42: New `backend-dynamic-feature-service` package, for the discovery of dynamic frontend and backend plugins (and modules) and the loading of the backend ones inside the backend application.
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.1
+ - @backstage/cli-node@0.2.2
+ - @backstage/plugin-events-backend@0.2.18
+ - @backstage/backend-plugin-api@0.6.9
+ - @backstage/plugin-permission-common@0.7.12
+ - @backstage/plugin-permission-node@0.7.20
+ - @backstage/plugin-catalog-backend@1.16.1
+ - @backstage/backend-tasks@0.5.14
+ - @backstage/plugin-auth-node@0.4.3
+ - @backstage/plugin-scaffolder-node@0.2.10
+ - @backstage/plugin-search-backend-node@1.2.13
+ - @backstage/cli-common@0.1.13
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+ - @backstage/plugin-events-node@0.2.18
+ - @backstage/plugin-search-common@1.2.10
+
+## 0.0.5-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.6.9-next.2
+ - @backstage/backend-common@0.20.1-next.2
+ - @backstage/plugin-auth-node@0.4.3-next.2
+ - @backstage/plugin-catalog-backend@1.16.1-next.2
+ - @backstage/plugin-events-backend@0.2.18-next.2
+ - @backstage/plugin-events-node@0.2.18-next.2
+ - @backstage/plugin-permission-node@0.7.20-next.2
+ - @backstage/plugin-scaffolder-node@0.2.10-next.2
+ - @backstage/plugin-search-backend-node@1.2.13-next.2
+ - @backstage/backend-tasks@0.5.14-next.2
+ - @backstage/cli-node@0.2.2-next.0
+
+## 0.0.5-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/cli-node@0.2.2-next.0
+ - @backstage/backend-common@0.20.1-next.1
+ - @backstage/config@1.1.1
+ - @backstage/backend-tasks@0.5.14-next.1
+ - @backstage/plugin-auth-node@0.4.3-next.1
+ - @backstage/plugin-catalog-backend@1.16.1-next.1
+ - @backstage/plugin-events-backend@0.2.18-next.1
+ - @backstage/plugin-permission-node@0.7.20-next.1
+ - @backstage/plugin-scaffolder-node@0.2.10-next.1
+ - @backstage/plugin-search-backend-node@1.2.13-next.1
+ - @backstage/backend-plugin-api@0.6.9-next.1
+ - @backstage/cli-common@0.1.13
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+ - @backstage/plugin-events-node@0.2.18-next.1
+ - @backstage/plugin-permission-common@0.7.11
+ - @backstage/plugin-search-common@1.2.9
+
+## 0.0.5-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.1-next.0
+ - @backstage/backend-plugin-api@0.6.9-next.0
+ - @backstage/backend-tasks@0.5.14-next.0
+ - @backstage/cli-common@0.1.13
+ - @backstage/cli-node@0.2.1
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.4.3-next.0
+ - @backstage/plugin-catalog-backend@1.16.1-next.0
+ - @backstage/plugin-events-backend@0.2.18-next.0
+ - @backstage/plugin-events-node@0.2.18-next.0
+ - @backstage/plugin-permission-common@0.7.11
+ - @backstage/plugin-permission-node@0.7.20-next.0
+ - @backstage/plugin-scaffolder-node@0.2.10-next.0
+ - @backstage/plugin-search-backend-node@1.2.13-next.0
+ - @backstage/plugin-search-common@1.2.9
+
+## 0.0.4
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.0
+ - @backstage/plugin-catalog-backend@1.16.0
+ - @backstage/plugin-scaffolder-node@0.2.9
+ - @backstage/backend-tasks@0.5.13
+ - @backstage/plugin-auth-node@0.4.2
+ - @backstage/plugin-permission-common@0.7.11
+ - @backstage/plugin-permission-node@0.7.19
+ - @backstage/cli-node@0.2.1
+ - @backstage/plugin-events-backend@0.2.17
+ - @backstage/plugin-search-backend-node@1.2.12
+ - @backstage/backend-plugin-api@0.6.8
+ - @backstage/cli-common@0.1.13
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+ - @backstage/plugin-events-node@0.2.17
+ - @backstage/plugin-search-common@1.2.9
+
+## 0.0.4-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-node@0.2.9-next.3
+ - @backstage/backend-common@0.20.0-next.3
+ - @backstage/backend-plugin-api@0.6.8-next.3
+ - @backstage/backend-tasks@0.5.13-next.3
+ - @backstage/cli-common@0.1.13
+ - @backstage/cli-node@0.2.0
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.4.2-next.3
+ - @backstage/plugin-catalog-backend@1.16.0-next.3
+ - @backstage/plugin-events-backend@0.2.17-next.3
+ - @backstage/plugin-events-node@0.2.17-next.3
+ - @backstage/plugin-permission-common@0.7.10
+ - @backstage/plugin-permission-node@0.7.19-next.3
+ - @backstage/plugin-search-backend-node@1.2.12-next.3
+ - @backstage/plugin-search-common@1.2.8
+
+## 0.0.4-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-backend@1.16.0-next.2
+ - @backstage/backend-common@0.20.0-next.2
+ - @backstage/plugin-auth-node@0.4.2-next.2
+ - @backstage/plugin-events-backend@0.2.17-next.2
+ - @backstage/backend-plugin-api@0.6.8-next.2
+ - @backstage/backend-tasks@0.5.13-next.2
+ - @backstage/cli-common@0.1.13
+ - @backstage/cli-node@0.2.0
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+ - @backstage/plugin-events-node@0.2.17-next.2
+ - @backstage/plugin-permission-common@0.7.10
+ - @backstage/plugin-permission-node@0.7.19-next.2
+ - @backstage/plugin-scaffolder-node@0.2.9-next.2
+ - @backstage/plugin-search-backend-node@1.2.12-next.2
+ - @backstage/plugin-search-common@1.2.8
+
+## 0.0.4-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-backend@1.15.1-next.1
+ - @backstage/backend-common@0.20.0-next.1
+ - @backstage/backend-plugin-api@0.6.8-next.1
+ - @backstage/backend-tasks@0.5.13-next.1
+ - @backstage/cli-common@0.1.13
+ - @backstage/cli-node@0.2.0
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.4.2-next.1
+ - @backstage/plugin-events-backend@0.2.17-next.1
+ - @backstage/plugin-events-node@0.2.17-next.1
+ - @backstage/plugin-permission-common@0.7.10
+ - @backstage/plugin-permission-node@0.7.19-next.1
+ - @backstage/plugin-scaffolder-node@0.2.9-next.1
+ - @backstage/plugin-search-backend-node@1.2.12-next.1
+ - @backstage/plugin-search-common@1.2.8
## 0.0.4-next.0
diff --git a/packages/backend-plugin-manager/README.md b/packages/backend-dynamic-feature-service/README.md
similarity index 64%
rename from packages/backend-plugin-manager/README.md
rename to packages/backend-dynamic-feature-service/README.md
index c9fd666fb3..211148ee10 100644
--- a/packages/backend-plugin-manager/README.md
+++ b/packages/backend-dynamic-feature-service/README.md
@@ -1,10 +1,6 @@
-# @backstage/backend-plugin-manager
+# @backstage/backend-dynamic-feature-service
-This package adds experimental support for **dynamic backend plugins**, according to the content of the proposal in [RFC 18390](https://github.com/backstage/backstage/issues/18390)
-
-## Status
-
-**This package is EXPERIMENTAL, and is subject to change according to the discussions and conclusions that happen around the RFC mentioned above.**
+This package adds experimental support for **dynamic backend features (plugins and modules)**, according to the content of the proposal in [RFC 18390](https://github.com/backstage/backstage/issues/18390)
## Testing the backend dynamic plugins feature
@@ -12,9 +8,9 @@ In order to test the dynamic backend plugins feature provided by this package, e
## How it works
-The backend plugin manager is a service that scans a configured root directory (`dynamicPlugins.rootDirectory` in the app config) for dynamic plugin packages, and loads them dynamically.
+The dynamic plugin manager is a service that scans a configured root directory (`dynamicPlugins.rootDirectory` in the app config) for dynamic plugin packages, and loads them dynamically.
-In the `backend-next` application, it can be enabled by adding the `backend-plugin-manager` as a dependency in the `package.json` and the following lines in the `src/index.ts` file:
+In the `backend-next` application, it can be enabled by adding the `backend-dynamic-feature-service` as a dependency in the `package.json` and the following lines in the `src/index.ts` file:
```ts
const backend = createBackend();
@@ -36,9 +32,9 @@ Points 2 and 3 can be done by the `export-dynamic-plugin` CLI command used to pe
### About the `export-dynamic-plugin` command
-The `export-dynamic-plugin` CLI command, used the dynamic plugin examples provided in the [showcase repository](https://github.com/janus-idp/dynamic-backend-plugins-showcase), is part of a `@backstage/cli` fork (`@dfatwork-pkgs/backstage-cli@0.22.9-next.6`), and can be used to help packaging the dynamic plugins according to the constraints mentioned above, in order to allow straightforward testing of the dynamic plugins feature.
+The `export-dynamic-plugin` CLI command, used the dynamic plugin examples provided in the [showcase repository](https://github.com/janus-idp/dynamic-backend-plugins-showcase), is part of the `@janus-idp/cli` package, and can be used to help packaging the dynamic plugins according to the constraints mentioned above, in order to allow straightforward testing of the dynamic plugins feature.
-However the `backend-plugin-manager` experimental package does **not** depend on the use of this additional CLI command, and in future steps of this backend dynamic plugin work, the use of such a dedicated command might not even be necessary.
+However the `backend-dynamic-feature-service` experimental package does **not** depend on the use of this additional CLI command, and in future steps of this backend dynamic plugin work, the use of such a dedicated command might not even be necessary.
### About the support of the legacy backend system
@@ -49,4 +45,4 @@ This is why the API related to the old backend is already marked as deprecated.
### Future work
-The current implementation of the backend plugin manager is a first step towards the final implementation of the dynamic backend plugins feature, which will be completed / simplified in future steps, as the status of the backstage codebase allows it.
+The current implementation of the dynamic plugin manager is a first step towards the final implementation of the dynamic features loading, which will be completed / simplified in future steps, as the status of the backstage codebase allows it.
diff --git a/packages/backend-plugin-manager/api-report.md b/packages/backend-dynamic-feature-service/api-report.md
similarity index 85%
rename from packages/backend-plugin-manager/api-report.md
rename to packages/backend-dynamic-feature-service/api-report.md
index b4221007ae..caf2cf01ec 100644
--- a/packages/backend-plugin-manager/api-report.md
+++ b/packages/backend-dynamic-feature-service/api-report.md
@@ -1,4 +1,4 @@
-## API Report File for "@backstage/backend-plugin-manager"
+## API Report File for "@backstage/backend-dynamic-feature-service"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
@@ -65,6 +65,44 @@ export interface BaseDynamicPlugin {
// @public (undocumented)
export type DynamicPlugin = FrontendDynamicPlugin | BackendDynamicPlugin;
+// @public (undocumented)
+export class DynamicPluginManager implements DynamicPluginProvider {
+ // (undocumented)
+ addBackendPlugin(plugin: BackendDynamicPlugin): void;
+ // (undocumented)
+ get availablePackages(): ScannedPluginPackage[];
+ // (undocumented)
+ backendPlugins(): BackendDynamicPlugin[];
+ // (undocumented)
+ static create(
+ options: DynamicPluginManagerOptions,
+ ): Promise;
+ // (undocumented)
+ frontendPlugins(): FrontendDynamicPlugin[];
+ // (undocumented)
+ plugins(): DynamicPlugin[];
+}
+
+// @public (undocumented)
+export interface DynamicPluginManagerOptions {
+ // (undocumented)
+ config: Config;
+ // (undocumented)
+ logger: LoggerService;
+ // (undocumented)
+ moduleLoader?: ModuleLoader;
+ // (undocumented)
+ preferAlpha?: boolean;
+}
+
+// @public (undocumented)
+export interface DynamicPluginProvider
+ extends FrontendPluginProvider,
+ BackendPluginProvider {
+ // (undocumented)
+ plugins(): DynamicPlugin[];
+}
+
// @public (undocumented)
export interface DynamicPluginsFactoryOptions {
// (undocumented)
@@ -80,11 +118,11 @@ export const dynamicPluginsFeatureDiscoveryServiceFactory: () => ServiceFactory<
// @public (undocumented)
export const dynamicPluginsServiceFactory: (
options?: DynamicPluginsFactoryOptions | undefined,
-) => ServiceFactory;
+) => ServiceFactory;
// @public (undocumented)
export const dynamicPluginsServiceRef: ServiceRef<
- BackendPluginProvider,
+ DynamicPluginProvider,
'root'
>;
@@ -94,6 +132,12 @@ export interface FrontendDynamicPlugin extends BaseDynamicPlugin {
platform: 'web';
}
+// @public (undocumented)
+export interface FrontendPluginProvider {
+ // (undocumented)
+ frontendPlugins(): FrontendDynamicPlugin[];
+}
+
// @public (undocumented)
export function isBackendDynamicPluginInstaller(
obj: any,
@@ -161,25 +205,6 @@ export interface NewBackendPluginInstaller {
kind: 'new';
}
-// @public (undocumented)
-export class PluginManager implements BackendPluginProvider {
- // (undocumented)
- addBackendPlugin(plugin: BackendDynamicPlugin): void;
- // (undocumented)
- get availablePackages(): ScannedPluginPackage[];
- // (undocumented)
- backendPlugins(): BackendDynamicPlugin[];
- // (undocumented)
- static fromConfig(
- config: Config,
- logger: LoggerService,
- preferAlpha?: boolean,
- moduleLoader?: ModuleLoader,
- ): Promise;
- // (undocumented)
- readonly plugins: DynamicPlugin[];
-}
-
// @public (undocumented)
export type ScannedPluginManifest = BackstagePackageJson &
Required> &
diff --git a/packages/backend-dynamic-feature-service/catalog-info.yaml b/packages/backend-dynamic-feature-service/catalog-info.yaml
new file mode 100644
index 0000000000..1269a5c406
--- /dev/null
+++ b/packages/backend-dynamic-feature-service/catalog-info.yaml
@@ -0,0 +1,10 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+ name: backstage-backend-dynamic-feature-service
+ title: '@backstage/backend-dynamic-feature-service'
+ description: Backstage backend service to handle dynamic features
+spec:
+ lifecycle: experimental
+ type: backstage-node-library
+ owner: maintainers
diff --git a/packages/backend-plugin-manager/config.d.ts b/packages/backend-dynamic-feature-service/config.d.ts
similarity index 100%
rename from packages/backend-plugin-manager/config.d.ts
rename to packages/backend-dynamic-feature-service/config.d.ts
diff --git a/packages/backend-plugin-manager/package.json b/packages/backend-dynamic-feature-service/package.json
similarity index 92%
rename from packages/backend-plugin-manager/package.json
rename to packages/backend-dynamic-feature-service/package.json
index 643a94f3cb..51f7184c49 100644
--- a/packages/backend-plugin-manager/package.json
+++ b/packages/backend-dynamic-feature-service/package.json
@@ -1,8 +1,7 @@
{
- "name": "@backstage/backend-plugin-manager",
- "description": "Backstage plugin management backend",
- "version": "0.0.4-next.0",
- "private": true,
+ "name": "@backstage/backend-dynamic-feature-service",
+ "description": "Backstage dynamic feature service",
+ "version": "0.1.1-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
diff --git a/packages/backend-plugin-manager/src/__testUtils__/testUtils.ts b/packages/backend-dynamic-feature-service/src/__testUtils__/testUtils.ts
similarity index 100%
rename from packages/backend-plugin-manager/src/__testUtils__/testUtils.ts
rename to packages/backend-dynamic-feature-service/src/__testUtils__/testUtils.ts
diff --git a/packages/backend-plugin-manager/src/index.ts b/packages/backend-dynamic-feature-service/src/index.ts
similarity index 100%
rename from packages/backend-plugin-manager/src/index.ts
rename to packages/backend-dynamic-feature-service/src/index.ts
diff --git a/packages/backend-plugin-manager/src/loader/CommonJSModuleLoader.ts b/packages/backend-dynamic-feature-service/src/loader/CommonJSModuleLoader.ts
similarity index 96%
rename from packages/backend-plugin-manager/src/loader/CommonJSModuleLoader.ts
rename to packages/backend-dynamic-feature-service/src/loader/CommonJSModuleLoader.ts
index 06a08117cd..66af367cea 100644
--- a/packages/backend-plugin-manager/src/loader/CommonJSModuleLoader.ts
+++ b/packages/backend-dynamic-feature-service/src/loader/CommonJSModuleLoader.ts
@@ -49,6 +49,6 @@ export class CommonJSModuleLoader implements ModuleLoader {
}
async load(packagePath: string): Promise {
- return await import(/* webpackIgnore: true */ packagePath);
+ return await require(/* webpackIgnore: true */ packagePath);
}
}
diff --git a/packages/backend-plugin-manager/src/loader/index.ts b/packages/backend-dynamic-feature-service/src/loader/index.ts
similarity index 100%
rename from packages/backend-plugin-manager/src/loader/index.ts
rename to packages/backend-dynamic-feature-service/src/loader/index.ts
diff --git a/packages/backend-plugin-manager/src/loader/types.ts b/packages/backend-dynamic-feature-service/src/loader/types.ts
similarity index 100%
rename from packages/backend-plugin-manager/src/loader/types.ts
rename to packages/backend-dynamic-feature-service/src/loader/types.ts
diff --git a/packages/backend-plugin-manager/src/manager/index.ts b/packages/backend-dynamic-feature-service/src/manager/index.ts
similarity index 85%
rename from packages/backend-plugin-manager/src/manager/index.ts
rename to packages/backend-dynamic-feature-service/src/manager/index.ts
index a9cd163617..dd6aaacfe9 100644
--- a/packages/backend-plugin-manager/src/manager/index.ts
+++ b/packages/backend-dynamic-feature-service/src/manager/index.ts
@@ -25,14 +25,19 @@ export type {
NewBackendPluginInstaller,
LegacyBackendPluginInstaller,
LegacyPluginEnvironment,
+ DynamicPluginProvider,
+ FrontendPluginProvider,
BackendPluginProvider,
} from './types';
export {
- PluginManager,
+ DynamicPluginManager,
dynamicPluginsFeatureDiscoveryServiceFactory,
dynamicPluginsServiceFactory,
dynamicPluginsServiceRef,
} from './plugin-manager';
-export type { DynamicPluginsFactoryOptions } from './plugin-manager';
+export type {
+ DynamicPluginManagerOptions,
+ DynamicPluginsFactoryOptions,
+} from './plugin-manager';
diff --git a/packages/backend-plugin-manager/src/manager/plugin-manager.test.ts b/packages/backend-dynamic-feature-service/src/manager/plugin-manager.test.ts
similarity index 73%
rename from packages/backend-plugin-manager/src/manager/plugin-manager.test.ts
rename to packages/backend-dynamic-feature-service/src/manager/plugin-manager.test.ts
index 4aabd2c072..487729687f 100644
--- a/packages/backend-plugin-manager/src/manager/plugin-manager.test.ts
+++ b/packages/backend-dynamic-feature-service/src/manager/plugin-manager.test.ts
@@ -14,7 +14,10 @@
* limitations under the License.
*/
-import { PluginManager, dynamicPluginsServiceFactory } from './plugin-manager';
+import {
+ DynamicPluginManager,
+ dynamicPluginsServiceFactory,
+} from './plugin-manager';
import {
BackendFeature,
coreServices,
@@ -44,7 +47,7 @@ import { PluginScanner } from '../scanner/plugin-scanner';
import { findPaths } from '@backstage/cli-common';
import { createMockDirectory } from '@backstage/backend-test-utils';
-describe('backend-plugin-manager', () => {
+describe('backend-dynamic-feature-service', () => {
const mockDir = createMockDirectory();
describe('loadPlugins', () => {
@@ -113,6 +116,94 @@ describe('backend-plugin-manager', () => {
>([]);
},
},
+ {
+ name: 'should successfully load a new backend plugin by the default BackendFeature',
+ packageManifest: {
+ name: 'backend-dynamic-plugin-test',
+ version: '0.0.0',
+ backstage: {
+ role: 'backend-plugin',
+ },
+ main: 'dist/index.cjs.js',
+ },
+ indexFile: {
+ retativePath: ['dist', 'index.cjs.js'],
+ content: `const alpha = { $$type: '@backstage/BackendFeature' }; exports["default"] = alpha;`,
+ },
+ expectedLogs(location) {
+ return {
+ infos: [
+ {
+ message: `loaded dynamic backend plugin 'backend-dynamic-plugin-test' from '${location}'`,
+ },
+ ],
+ };
+ },
+ checkLoadedPlugins(plugins) {
+ expect(plugins).toMatchObject([
+ {
+ name: 'backend-dynamic-plugin-test',
+ version: '0.0.0',
+ role: 'backend-plugin',
+ platform: 'node',
+ installer: {
+ kind: 'new',
+ },
+ },
+ ]);
+ const installer: NewBackendPluginInstaller = (
+ plugins[0] as BackendDynamicPlugin
+ ).installer as NewBackendPluginInstaller;
+ expect(installer.install()).toEqual<
+ BackendFeature | BackendFeature[]
+ >({ $$type: '@backstage/BackendFeature' });
+ },
+ },
+ {
+ name: 'should successfully load a new backend plugin by the default BackendFeatureFactory',
+ packageManifest: {
+ name: 'backend-dynamic-plugin-test',
+ version: '0.0.0',
+ backstage: {
+ role: 'backend-plugin',
+ },
+ main: 'dist/index.cjs.js',
+ },
+ indexFile: {
+ retativePath: ['dist', 'index.cjs.js'],
+ content: `const alpha = () => { return { $$type: '@backstage/BackendFeature' } };
+ alpha.$$type = '@backstage/BackendFeatureFactory';
+ exports["default"] = alpha;`,
+ },
+ expectedLogs(location) {
+ return {
+ infos: [
+ {
+ message: `loaded dynamic backend plugin 'backend-dynamic-plugin-test' from '${location}'`,
+ },
+ ],
+ };
+ },
+ checkLoadedPlugins(plugins) {
+ expect(plugins).toMatchObject([
+ {
+ name: 'backend-dynamic-plugin-test',
+ version: '0.0.0',
+ role: 'backend-plugin',
+ platform: 'node',
+ installer: {
+ kind: 'new',
+ },
+ },
+ ]);
+ const installer: NewBackendPluginInstaller = (
+ plugins[0] as BackendDynamicPlugin
+ ).installer as NewBackendPluginInstaller;
+ expect(installer.install()).toEqual<
+ BackendFeature | BackendFeature[]
+ >({ $$type: '@backstage/BackendFeature' });
+ },
+ },
{
name: 'should successfully load a new backend plugin module',
packageManifest: {
@@ -221,7 +312,7 @@ describe('backend-plugin-manager', () => {
return {
errors: [
{
- message: `dynamic backend plugin 'backend-dynamic-plugin-test' could not be loaded from '${location}': the module should export a 'const dynamicPluginInstaller: BackendDynamicPluginInstaller' field.`,
+ message: `dynamic backend plugin 'backend-dynamic-plugin-test' could not be loaded from '${location}': the module should either export a 'BackendFeature' or 'BackendFeatureFactory' as default export, or export a 'const dynamicPluginInstaller: BackendDynamicPluginInstaller' field as dynamic loading entrypoint.`,
},
],
};
@@ -249,7 +340,7 @@ describe('backend-plugin-manager', () => {
return {
errors: [
{
- message: `dynamic backend plugin 'backend-dynamic-plugin-test' could not be loaded from '${location}': the module should export a 'const dynamicPluginInstaller: BackendDynamicPluginInstaller' field.`,
+ message: `dynamic backend plugin 'backend-dynamic-plugin-test' could not be loaded from '${location}': the module should either export a 'BackendFeature' or 'BackendFeatureFactory' as default export, or export a 'const dynamicPluginInstaller: BackendDynamicPluginInstaller' field as dynamic loading entrypoint.`,
},
],
};
@@ -374,12 +465,16 @@ describe('backend-plugin-manager', () => {
mockDir.setContent(mockedFiles);
const logger = new MockedLogger();
- const pluginManager = new (PluginManager as any)(logger, [plugin], {
+ const pluginManager = new (DynamicPluginManager as any)(
logger,
- async bootstrap(_: string, __: string[]): Promise {},
- load: async (packagePath: string) =>
- await import(/* webpackIgnore: true */ packagePath),
- });
+ [plugin],
+ {
+ logger,
+ async bootstrap(_: string, __: string[]): Promise {},
+ load: async (packagePath: string) =>
+ await require(/* webpackIgnore: true */ packagePath),
+ },
+ );
const loadedPlugins: DynamicPlugin[] = await pluginManager.loadPlugins();
@@ -395,7 +490,10 @@ describe('backend-plugin-manager', () => {
describe('backendPlugins', () => {
it('should return only backend plugins and modules', async () => {
const logger = new MockedLogger();
- const pluginManager = new (PluginManager as any)(logger, '', []);
+ const pluginManager = new (DynamicPluginManager as any)(
+ logger,
+ [],
+ ) as DynamicPluginManager;
const plugins: BaseDynamicPlugin[] = [
{
name: 'a-frontend-plugin',
@@ -416,7 +514,7 @@ describe('backend-plugin-manager', () => {
version: '0.0.0',
},
];
- pluginManager.plugins = plugins;
+ (pluginManager as any)._plugins = plugins;
expect(pluginManager.backendPlugins()).toEqual([
{
name: 'a-backend-plugin',
@@ -434,6 +532,57 @@ describe('backend-plugin-manager', () => {
});
});
+ describe('frontendPlugins', () => {
+ it('should return only frontend plugins', async () => {
+ const logger = new MockedLogger();
+ const pluginManager = new (DynamicPluginManager as any)(
+ logger,
+ [],
+ ) as DynamicPluginManager;
+ const plugins: BaseDynamicPlugin[] = [
+ {
+ name: 'a-frontend-plugin',
+ platform: 'web',
+ role: 'frontend-plugin',
+ version: '0.0.0',
+ },
+ {
+ name: 'a-frontend-module',
+ platform: 'web',
+ role: 'frontend-plugin-module',
+ version: '0.0.0',
+ },
+ {
+ name: 'a-backend-plugin',
+ platform: 'node',
+ role: 'backend-plugin',
+ version: '0.0.0',
+ },
+ {
+ name: 'a-backend-module',
+ platform: 'node',
+ role: 'backend-plugin-module',
+ version: '0.0.0',
+ },
+ ];
+ (pluginManager as any)._plugins = plugins;
+ expect(pluginManager.frontendPlugins()).toEqual([
+ {
+ name: 'a-frontend-plugin',
+ platform: 'web',
+ role: 'frontend-plugin',
+ version: '0.0.0',
+ },
+ {
+ name: 'a-frontend-module',
+ platform: 'web',
+ role: 'frontend-plugin-module',
+ version: '0.0.0',
+ },
+ ]);
+ });
+ });
+
describe('dynamicPluginsServiceFactory', () => {
const otherMockDir = createMockDirectory();
@@ -459,27 +608,29 @@ describe('backend-plugin-manager', () => {
'a-dynamic-plugin': {},
});
- const fromConfigSpier = jest.spyOn(PluginManager, 'fromConfig');
+ const fromConfigSpier = jest.spyOn(DynamicPluginManager, 'create');
const applyConfigSpier = jest
.spyOn(PluginScanner.prototype as any, 'applyConfig')
.mockImplementation(() => {});
const scanRootSpier = jest
.spyOn(PluginScanner.prototype, 'scanRoot')
- .mockImplementation(async () => [
- {
- location: url.pathToFileURL(
- mockDir.resolve('dynamic-plugins-root/a-dynamic-plugin'),
- ),
- manifest: {
- name: 'test',
- version: '0.0.0',
- main: 'dist/index.cjs.js',
- backstage: {
- role: 'backend-plugin',
+ .mockImplementation(async () => ({
+ packages: [
+ {
+ location: url.pathToFileURL(
+ mockDir.resolve('dynamic-plugins-root/a-dynamic-plugin'),
+ ),
+ manifest: {
+ name: 'test',
+ version: '0.0.0',
+ main: 'dist/index.cjs.js',
+ backstage: {
+ role: 'backend-plugin',
+ },
},
},
- },
- ]);
+ ],
+ }));
const mockedModuleLoader = {
logger,
bootstrap: jest.fn(),
diff --git a/packages/backend-plugin-manager/src/manager/plugin-manager.ts b/packages/backend-dynamic-feature-service/src/manager/plugin-manager.ts
similarity index 69%
rename from packages/backend-plugin-manager/src/manager/plugin-manager.ts
rename to packages/backend-dynamic-feature-service/src/manager/plugin-manager.ts
index ad76c7529e..edc3e20f72 100644
--- a/packages/backend-plugin-manager/src/manager/plugin-manager.ts
+++ b/packages/backend-dynamic-feature-service/src/manager/plugin-manager.ts
@@ -15,10 +15,11 @@
*/
import { Config } from '@backstage/config';
import {
- BackendPluginProvider,
+ DynamicPluginProvider,
BackendDynamicPlugin,
isBackendDynamicPluginInstaller,
DynamicPlugin,
+ FrontendDynamicPlugin,
} from './types';
import { ScannedPluginPackage } from '../scanner';
import { PluginScanner } from '../scanner/plugin-scanner';
@@ -44,24 +45,37 @@ import {
/**
* @public
*/
-export class PluginManager implements BackendPluginProvider {
- static async fromConfig(
- config: Config,
- logger: LoggerService,
- preferAlpha: boolean = false,
- moduleLoader: ModuleLoader = new CommonJSModuleLoader(logger),
- ): Promise {
+export interface DynamicPluginManagerOptions {
+ config: Config;
+ logger: LoggerService;
+ preferAlpha?: boolean;
+ moduleLoader?: ModuleLoader;
+}
+
+/**
+ * @public
+ */
+export class DynamicPluginManager implements DynamicPluginProvider {
+ static async create(
+ options: DynamicPluginManagerOptions,
+ ): Promise {
/* eslint-disable-next-line no-restricted-syntax */
const backstageRoot = findPaths(__dirname).targetRoot;
- const scanner = new PluginScanner(
- config,
- logger,
+ const scanner = PluginScanner.create({
+ config: options.config,
+ logger: options.logger,
backstageRoot,
- preferAlpha,
- );
- const scannedPlugins = await scanner.scanRoot();
+ preferAlpha: options.preferAlpha,
+ });
+ const scannedPlugins = (await scanner.scanRoot()).packages;
scanner.trackChanges();
- const manager = new PluginManager(logger, scannedPlugins, moduleLoader);
+ const moduleLoader =
+ options.moduleLoader || new CommonJSModuleLoader(options.logger);
+ const manager = new DynamicPluginManager(
+ options.logger,
+ scannedPlugins,
+ moduleLoader,
+ );
const dynamicPluginsPaths = scannedPlugins.map(p =>
fs.realpathSync(
@@ -76,15 +90,15 @@ export class PluginManager implements BackendPluginProvider {
moduleLoader.bootstrap(backstageRoot, dynamicPluginsPaths);
scanner.subscribeToRootDirectoryChange(async () => {
- manager._availablePackages = await scanner.scanRoot();
+ manager._availablePackages = (await scanner.scanRoot()).packages;
// TODO: do not store _scannedPlugins again, but instead store a diff of the changes
});
- manager.plugins.push(...(await manager.loadPlugins()));
+ manager._plugins.push(...(await manager.loadPlugins()));
return manager;
}
- readonly plugins: DynamicPlugin[];
+ private readonly _plugins: DynamicPlugin[];
private _availablePackages: ScannedPluginPackage[];
private constructor(
@@ -92,7 +106,7 @@ export class PluginManager implements BackendPluginProvider {
private packages: ScannedPluginPackage[],
private readonly moduleLoader: ModuleLoader,
) {
- this.plugins = [];
+ this._plugins = [];
this._availablePackages = packages;
}
@@ -101,7 +115,7 @@ export class PluginManager implements BackendPluginProvider {
}
addBackendPlugin(plugin: BackendDynamicPlugin): void {
- this.plugins.push(plugin);
+ this._plugins.push(plugin);
}
private async loadPlugins(): Promise {
@@ -140,12 +154,25 @@ export class PluginManager implements BackendPluginProvider {
`${plugin.location}/${plugin.manifest.main}`,
);
try {
- const { dynamicPluginInstaller } = await this.moduleLoader.load(
- packagePath,
- );
+ const pluginModule = await this.moduleLoader.load(packagePath);
+
+ let dynamicPluginInstaller;
+ if (isBackendFeature(pluginModule.default)) {
+ dynamicPluginInstaller = {
+ kind: 'new',
+ install: () => pluginModule.default,
+ };
+ } else if (isBackendFeatureFactory(pluginModule.default)) {
+ dynamicPluginInstaller = {
+ kind: 'new',
+ install: pluginModule.default,
+ };
+ } else {
+ dynamicPluginInstaller = pluginModule.dynamicPluginInstaller;
+ }
if (!isBackendDynamicPluginInstaller(dynamicPluginInstaller)) {
this.logger.error(
- `dynamic backend plugin '${plugin.manifest.name}' could not be loaded from '${plugin.location}': the module should export a 'const dynamicPluginInstaller: BackendDynamicPluginInstaller' field.`,
+ `dynamic backend plugin '${plugin.manifest.name}' could not be loaded from '${plugin.location}': the module should either export a 'BackendFeature' or 'BackendFeatureFactory' as default export, or export a 'const dynamicPluginInstaller: BackendDynamicPluginInstaller' field as dynamic loading entrypoint.`,
);
return undefined;
}
@@ -169,16 +196,26 @@ export class PluginManager implements BackendPluginProvider {
}
backendPlugins(): BackendDynamicPlugin[] {
- return this.plugins.filter(
+ return this._plugins.filter(
(p): p is BackendDynamicPlugin => p.platform === 'node',
);
}
+
+ frontendPlugins(): FrontendDynamicPlugin[] {
+ return this._plugins.filter(
+ (p): p is FrontendDynamicPlugin => p.platform === 'web',
+ );
+ }
+
+ plugins(): DynamicPlugin[] {
+ return this._plugins;
+ }
}
/**
* @public
*/
-export const dynamicPluginsServiceRef = createServiceRef(
+export const dynamicPluginsServiceRef = createServiceRef(
{
id: 'core.dynamicplugins',
scope: 'root',
@@ -203,15 +240,12 @@ export const dynamicPluginsServiceFactory = createServiceFactory(
logger: coreServices.rootLogger,
},
async factory({ config, logger }) {
- if (options?.moduleLoader) {
- return await PluginManager.fromConfig(
- config,
- logger,
- true,
- options.moduleLoader(logger),
- );
- }
- return await PluginManager.fromConfig(config, logger, true);
+ return await DynamicPluginManager.create({
+ config,
+ logger,
+ preferAlpha: true,
+ moduleLoader: options?.moduleLoader?.(logger),
+ });
},
}),
);
@@ -220,7 +254,7 @@ class DynamicPluginsEnabledFeatureDiscoveryService
implements FeatureDiscoveryService
{
constructor(
- private readonly dynamicPlugins: BackendPluginProvider,
+ private readonly dynamicPlugins: DynamicPluginProvider,
private readonly featureDiscoveryService?: FeatureDiscoveryService,
) {}
@@ -263,3 +297,21 @@ export const dynamicPluginsFeatureDiscoveryServiceFactory =
return new DynamicPluginsEnabledFeatureDiscoveryService(dynamicPlugins);
},
});
+
+function isBackendFeature(value: unknown): value is BackendFeature {
+ return (
+ !!value &&
+ typeof value === 'object' &&
+ (value as BackendFeature).$$type === '@backstage/BackendFeature'
+ );
+}
+
+function isBackendFeatureFactory(
+ value: unknown,
+): value is () => BackendFeature {
+ return (
+ !!value &&
+ typeof value === 'function' &&
+ (value as any).$$type === '@backstage/BackendFeatureFactory'
+ );
+}
diff --git a/packages/backend-plugin-manager/src/manager/types.ts b/packages/backend-dynamic-feature-service/src/manager/types.ts
similarity index 94%
rename from packages/backend-plugin-manager/src/manager/types.ts
rename to packages/backend-dynamic-feature-service/src/manager/types.ts
index 201941292d..0038470686 100644
--- a/packages/backend-plugin-manager/src/manager/types.ts
+++ b/packages/backend-dynamic-feature-service/src/manager/types.ts
@@ -67,6 +67,15 @@ export type LegacyPluginEnvironment = {
pluginProvider: BackendPluginProvider;
};
+/**
+ * @public
+ */
+export interface DynamicPluginProvider
+ extends FrontendPluginProvider,
+ BackendPluginProvider {
+ plugins(): DynamicPlugin[];
+}
+
/**
* @public
*/
@@ -74,6 +83,13 @@ export interface BackendPluginProvider {
backendPlugins(): BackendDynamicPlugin[];
}
+/**
+ * @public
+ */
+export interface FrontendPluginProvider {
+ frontendPlugins(): FrontendDynamicPlugin[];
+}
+
/**
* @public
*/
diff --git a/packages/backend-plugin-manager/src/scanner/index.ts b/packages/backend-dynamic-feature-service/src/scanner/index.ts
similarity index 100%
rename from packages/backend-plugin-manager/src/scanner/index.ts
rename to packages/backend-dynamic-feature-service/src/scanner/index.ts
diff --git a/packages/backend-plugin-manager/src/scanner/plugin-scanner-watcher.test.ts b/packages/backend-dynamic-feature-service/src/scanner/plugin-scanner-watcher.test.ts
similarity index 93%
rename from packages/backend-plugin-manager/src/scanner/plugin-scanner-watcher.test.ts
rename to packages/backend-dynamic-feature-service/src/scanner/plugin-scanner-watcher.test.ts
index e346bf749f..2d017d805b 100644
--- a/packages/backend-plugin-manager/src/scanner/plugin-scanner-watcher.test.ts
+++ b/packages/backend-dynamic-feature-service/src/scanner/plugin-scanner-watcher.test.ts
@@ -64,22 +64,23 @@ describe('plugin-scanner', () => {
unsubscribe: configUnsubscribe,
};
};
- const pluginScanner = new PluginScanner(
+ const pluginScanner = PluginScanner.create({
config,
logger,
- backstageRootDirectory,
- false,
- );
+ backstageRoot: backstageRootDirectory,
+ preferAlpha: false,
+ });
await pluginScanner.trackChanges();
expect(onConfigChange).toBeDefined();
- let scannedPlugins: ScannedPluginPackage[] =
- await pluginScanner.scanRoot();
+ let scannedPlugins: ScannedPluginPackage[] = (
+ await pluginScanner.scanRoot()
+ ).packages;
expect(scannedPlugins).toEqual([]);
const rootDirectorySubscriber = jest.fn(async () => {
- scannedPlugins = await pluginScanner.scanRoot();
+ scannedPlugins = (await pluginScanner.scanRoot()).packages;
});
pluginScanner.subscribeToRootDirectoryChange(rootDirectorySubscriber);
@@ -229,6 +230,7 @@ describe('plugin-scanner', () => {
logger.logs = {};
const debug = jest.spyOn(logger, 'debug');
+ const info = jest.spyOn(logger, 'info');
// Check that not all file changes trigger a new scan of plugins
await mkdir(
@@ -240,8 +242,11 @@ describe('plugin-scanner', () => {
),
);
await waitForExpect(() => {
- expect(debug).toHaveBeenCalledTimes(1);
+ expect(debug).toHaveBeenCalled();
});
+ expect(info).toHaveBeenCalledTimes(0);
+ debug.mockClear();
+
await writeFile(
join(
backstageRootDirectory,
@@ -252,8 +257,11 @@ describe('plugin-scanner', () => {
'content',
);
await waitForExpect(() => {
- expect(debug).toHaveBeenCalledTimes(2);
+ expect(debug).toHaveBeenCalled();
});
+ expect(info).toHaveBeenCalledTimes(0);
+ debug.mockClear();
+
await rm(
join(
backstageRootDirectory,
@@ -263,8 +271,11 @@ describe('plugin-scanner', () => {
),
);
await waitForExpect(() => {
- expect(debug).toHaveBeenCalledTimes(3);
+ expect(debug).toHaveBeenCalled();
});
+ expect(info).toHaveBeenCalledTimes(0);
+ debug.mockClear();
+
await rm(
join(
backstageRootDirectory,
@@ -275,8 +286,10 @@ describe('plugin-scanner', () => {
{ recursive: true },
);
await waitForExpect(() => {
- expect(debug).toHaveBeenCalledTimes(4);
+ expect(debug).toHaveBeenCalled();
});
+ expect(info).toHaveBeenCalledTimes(0);
+ debug.mockClear();
const onWindows = path.sep === '\\';
// Order of events is not fixed on Windows.
diff --git a/packages/backend-plugin-manager/src/scanner/plugin-scanner.test.ts b/packages/backend-dynamic-feature-service/src/scanner/plugin-scanner.test.ts
similarity index 98%
rename from packages/backend-plugin-manager/src/scanner/plugin-scanner.test.ts
rename to packages/backend-dynamic-feature-service/src/scanner/plugin-scanner.test.ts
index d4ab8940c9..e52eee87c4 100644
--- a/packages/backend-plugin-manager/src/scanner/plugin-scanner.test.ts
+++ b/packages/backend-dynamic-feature-service/src/scanner/plugin-scanner.test.ts
@@ -206,11 +206,11 @@ Please add '${mockDir.resolve(
const logger = new MockedLogger();
const backstageRoot = tc.backstageRoot ? tc.backstageRoot : '';
function toTest(): PluginScanner {
- return new PluginScanner(
- new ConfigReader(tc.config),
+ return PluginScanner.create({
+ config: new ConfigReader(tc.config),
logger,
backstageRoot,
- );
+ });
}
if (tc.fileSystem) {
mockDir.setContent(tc.fileSystem);
@@ -609,8 +609,8 @@ Please add '${mockDir.resolve(
const logger = new MockedLogger();
const backstageRoot = mockDir.resolve('backstageRoot');
async function toTest(): Promise {
- const pluginScanner = new PluginScanner(
- new ConfigReader(
+ const pluginScanner = PluginScanner.create({
+ config: new ConfigReader(
tc.fileSystem
? {
dynamicPlugins: {
@@ -621,9 +621,9 @@ Please add '${mockDir.resolve(
),
logger,
backstageRoot,
- tc.preferAlpha === undefined ? false : tc.preferAlpha,
- );
- return await pluginScanner.scanRoot();
+ preferAlpha: tc.preferAlpha,
+ });
+ return (await pluginScanner.scanRoot()).packages;
}
if (tc.fileSystem) {
mockDir.setContent(tc.fileSystem);
diff --git a/packages/backend-plugin-manager/src/scanner/plugin-scanner.ts b/packages/backend-dynamic-feature-service/src/scanner/plugin-scanner.ts
similarity index 83%
rename from packages/backend-plugin-manager/src/scanner/plugin-scanner.ts
rename to packages/backend-dynamic-feature-service/src/scanner/plugin-scanner.ts
index 51e38002e9..25e0d614dd 100644
--- a/packages/backend-plugin-manager/src/scanner/plugin-scanner.ts
+++ b/packages/backend-dynamic-feature-service/src/scanner/plugin-scanner.ts
@@ -24,28 +24,39 @@ import debounce from 'lodash/debounce';
import { PackagePlatform, PackageRoles } from '@backstage/cli-node';
import { LoggerService } from '@backstage/backend-plugin-api';
+export interface DynamicPluginScannerOptions {
+ config: Config;
+ backstageRoot: string;
+ logger: LoggerService;
+ preferAlpha?: boolean;
+}
+
+export interface ScanRootResponse {
+ packages: ScannedPluginPackage[];
+}
+
export class PluginScanner {
- private readonly logger: LoggerService;
- private backstageRoot: string;
- readonly #config: Config;
private _rootDirectory?: string;
- private readonly preferAlpha: boolean;
private configUnsubscribe?: () => void;
private rootDirectoryWatcher?: chokidar.FSWatcher;
private subscribers: (() => void)[] = [];
- constructor(
- config: Config,
- logger: LoggerService,
- backstageRoot: string,
- preferAlpha: boolean = false,
- ) {
- this.backstageRoot = backstageRoot;
- this.logger = logger;
- this.preferAlpha = preferAlpha;
- this.#config = config;
+ private constructor(
+ private readonly config: Config,
+ private readonly logger: LoggerService,
+ private readonly backstageRoot: string,
+ private readonly preferAlpha: boolean,
+ ) {}
- this.applyConfig();
+ static create(options: DynamicPluginScannerOptions): PluginScanner {
+ const scanner = new PluginScanner(
+ options.config,
+ options.logger,
+ options.backstageRoot,
+ options.preferAlpha || false,
+ );
+ scanner.applyConfig();
+ return scanner;
}
subscribeToRootDirectoryChange(subscriber: () => void) {
@@ -57,7 +68,7 @@ export class PluginScanner {
}
private applyConfig(): void | never {
- const dynamicPlugins = this.#config.getOptional('dynamicPlugins');
+ const dynamicPlugins = this.config.getOptional('dynamicPlugins');
if (!dynamicPlugins) {
this.logger.info("'dynamicPlugins' config entry not found.");
this._rootDirectory = undefined;
@@ -114,9 +125,9 @@ export class PluginScanner {
this._rootDirectory = dynamicPluginsRootPath;
}
- async scanRoot(): Promise {
+ async scanRoot(): Promise {
if (!this._rootDirectory) {
- return [];
+ return { packages: [] };
}
const dynamicPluginsLocation = this._rootDirectory;
@@ -189,7 +200,7 @@ export class PluginScanner {
scannedPlugins.push(scannedPlugin);
}
- return scannedPlugins;
+ return { packages: scannedPlugins };
}
private async scanDir(pluginHome: string): Promise {
@@ -263,30 +274,28 @@ export class PluginScanner {
};
await setupRootDirectoryWatcher();
- if (this.#config.subscribe) {
- const { unsubscribe } = this.#config.subscribe(
- async (): Promise => {
- const oldRootDirectory = this._rootDirectory;
- try {
- this.applyConfig();
- } catch (e) {
- this.logger.error(
- 'failed to apply new config for dynamic plugins',
- e,
- );
+ if (this.config.subscribe) {
+ const { unsubscribe } = this.config.subscribe(async (): Promise => {
+ const oldRootDirectory = this._rootDirectory;
+ try {
+ this.applyConfig();
+ } catch (e) {
+ this.logger.error(
+ 'failed to apply new config for dynamic plugins',
+ e,
+ );
+ }
+ if (oldRootDirectory !== this._rootDirectory) {
+ this.logger.info(
+ `rootDirectory changed in Config from '${oldRootDirectory}' to '${this._rootDirectory}'`,
+ );
+ this.subscribers.forEach(s => s());
+ if (this.rootDirectoryWatcher) {
+ await this.rootDirectoryWatcher.close();
}
- if (oldRootDirectory !== this._rootDirectory) {
- this.logger.info(
- `rootDirectory changed in Config from '${oldRootDirectory}' to '${this._rootDirectory}'`,
- );
- this.subscribers.forEach(s => s());
- if (this.rootDirectoryWatcher) {
- await this.rootDirectoryWatcher.close();
- }
- await setupRootDirectoryWatcher();
- }
- },
- );
+ await setupRootDirectoryWatcher();
+ }
+ });
this.configUnsubscribe = unsubscribe;
}
}
diff --git a/packages/backend-plugin-manager/src/scanner/types.ts b/packages/backend-dynamic-feature-service/src/scanner/types.ts
similarity index 100%
rename from packages/backend-plugin-manager/src/scanner/types.ts
rename to packages/backend-dynamic-feature-service/src/scanner/types.ts
diff --git a/packages/backend-next/CHANGELOG.md b/packages/backend-next/CHANGELOG.md
index 5d035799c5..25474b6c54 100644
--- a/packages/backend-next/CHANGELOG.md
+++ b/packages/backend-next/CHANGELOG.md
@@ -1,5 +1,373 @@
# example-backend-next
+## 0.0.20-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-azure-devops-backend@0.5.2-next.0
+ - @backstage/plugin-kubernetes-backend@0.14.2-next.0
+ - @backstage/plugin-catalog-backend@1.17.0-next.0
+ - @backstage/plugin-search-backend@1.5.0-next.0
+ - @backstage/plugin-todo-backend@0.3.8-next.0
+ - @backstage/plugin-scaffolder-backend@1.21.0-next.0
+ - @backstage/plugin-app-backend@0.3.58-next.0
+ - @backstage/backend-defaults@0.2.10-next.0
+ - @backstage/backend-tasks@0.5.15-next.0
+ - @backstage/plugin-auth-node@0.4.4-next.0
+ - @backstage/plugin-badges-backend@0.3.7-next.0
+ - @backstage/plugin-catalog-backend-module-openapi@0.1.27-next.0
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.7-next.0
+ - @backstage/plugin-entity-feedback-backend@0.2.7-next.0
+ - @backstage/plugin-linguist-backend@0.5.7-next.0
+ - @backstage/plugin-permission-backend-module-allow-all-policy@0.1.7-next.0
+ - @backstage/plugin-permission-node@0.7.21-next.0
+ - @backstage/plugin-playlist-backend@0.3.14-next.0
+ - @backstage/plugin-proxy-backend@0.4.8-next.0
+ - @backstage/plugin-search-backend-module-catalog@0.1.14-next.0
+ - @backstage/plugin-search-backend-module-explore@0.1.14-next.0
+ - @backstage/plugin-search-backend-module-techdocs@0.1.14-next.0
+ - @backstage/plugin-sonarqube-backend@0.2.12-next.0
+ - @backstage/plugin-techdocs-backend@1.9.3-next.0
+ - @backstage/plugin-adr-backend@0.4.7-next.0
+ - @backstage/plugin-catalog-backend-module-backstage-openapi@0.1.3-next.0
+ - @backstage/plugin-devtools-backend@0.2.7-next.0
+ - @backstage/plugin-jenkins-backend@0.3.4-next.0
+ - @backstage/plugin-lighthouse-backend@0.4.2-next.0
+ - @backstage/plugin-nomad-backend@0.1.12-next.0
+ - @backstage/plugin-permission-backend@0.5.33-next.0
+ - @backstage/plugin-search-backend-node@1.2.14-next.0
+ - @backstage/backend-plugin-api@0.6.10-next.0
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.7-next.0
+ - @backstage/plugin-permission-common@0.7.12
+
+## 0.0.19
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-sonarqube-backend@0.2.11
+ - @backstage/plugin-scaffolder-backend@1.20.0
+ - @backstage/plugin-catalog-backend-module-openapi@0.1.26
+ - @backstage/plugin-search-backend-module-techdocs@0.1.13
+ - @backstage/plugin-search-backend-module-catalog@0.1.13
+ - @backstage/plugin-search-backend-module-explore@0.1.13
+ - @backstage/backend-plugin-api@0.6.9
+ - @backstage/backend-defaults@0.2.9
+ - @backstage/plugin-azure-devops-backend@0.5.1
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.6
+ - @backstage/plugin-permission-backend-module-allow-all-policy@0.1.6
+ - @backstage/plugin-catalog-backend-module-backstage-openapi@0.1.2
+ - @backstage/plugin-entity-feedback-backend@0.2.6
+ - @backstage/plugin-devtools-backend@0.2.6
+ - @backstage/plugin-linguist-backend@0.5.6
+ - @backstage/plugin-playlist-backend@0.3.13
+ - @backstage/plugin-techdocs-backend@1.9.2
+ - @backstage/plugin-jenkins-backend@0.3.3
+ - @backstage/plugin-badges-backend@0.3.6
+ - @backstage/plugin-search-backend@1.4.9
+ - @backstage/plugin-nomad-backend@0.1.11
+ - @backstage/plugin-todo-backend@0.3.7
+ - @backstage/plugin-adr-backend@0.4.6
+ - @backstage/plugin-app-backend@0.3.57
+ - @backstage/plugin-permission-backend@0.5.32
+ - @backstage/plugin-permission-common@0.7.12
+ - @backstage/plugin-permission-node@0.7.20
+ - @backstage/plugin-catalog-backend@1.16.1
+ - @backstage/backend-tasks@0.5.14
+ - @backstage/plugin-auth-node@0.4.3
+ - @backstage/plugin-kubernetes-backend@0.14.1
+ - @backstage/plugin-lighthouse-backend@0.4.1
+ - @backstage/plugin-proxy-backend@0.4.7
+ - @backstage/plugin-search-backend-node@1.2.13
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.6
+
+## 0.0.19-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-sonarqube-backend@0.2.11-next.2
+ - @backstage/backend-plugin-api@0.6.9-next.2
+ - @backstage/backend-defaults@0.2.9-next.2
+ - @backstage/plugin-adr-backend@0.4.6-next.2
+ - @backstage/plugin-app-backend@0.3.57-next.2
+ - @backstage/plugin-auth-node@0.4.3-next.2
+ - @backstage/plugin-azure-devops-backend@0.5.1-next.2
+ - @backstage/plugin-badges-backend@0.3.6-next.2
+ - @backstage/plugin-catalog-backend@1.16.1-next.2
+ - @backstage/plugin-catalog-backend-module-backstage-openapi@0.1.2-next.2
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.6-next.2
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.6-next.2
+ - @backstage/plugin-devtools-backend@0.2.6-next.2
+ - @backstage/plugin-entity-feedback-backend@0.2.6-next.2
+ - @backstage/plugin-jenkins-backend@0.3.3-next.2
+ - @backstage/plugin-kubernetes-backend@0.14.1-next.2
+ - @backstage/plugin-lighthouse-backend@0.4.1-next.2
+ - @backstage/plugin-linguist-backend@0.5.6-next.2
+ - @backstage/plugin-nomad-backend@0.1.11-next.2
+ - @backstage/plugin-permission-backend@0.5.32-next.2
+ - @backstage/plugin-permission-backend-module-allow-all-policy@0.1.6-next.2
+ - @backstage/plugin-permission-node@0.7.20-next.2
+ - @backstage/plugin-playlist-backend@0.3.13-next.2
+ - @backstage/plugin-proxy-backend@0.4.7-next.2
+ - @backstage/plugin-scaffolder-backend@1.19.3-next.2
+ - @backstage/plugin-search-backend@1.4.9-next.2
+ - @backstage/plugin-search-backend-module-catalog@0.1.13-next.2
+ - @backstage/plugin-search-backend-module-explore@0.1.13-next.2
+ - @backstage/plugin-search-backend-module-techdocs@0.1.13-next.2
+ - @backstage/plugin-search-backend-node@1.2.13-next.2
+ - @backstage/plugin-techdocs-backend@1.9.2-next.2
+ - @backstage/plugin-todo-backend@0.3.7-next.2
+ - @backstage/backend-tasks@0.5.14-next.2
+ - @backstage/plugin-catalog-backend-module-openapi@0.1.26-next.2
+
+## 0.0.19-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-app-backend@0.3.57-next.1
+ - @backstage/plugin-devtools-backend@0.2.6-next.1
+ - @backstage/plugin-proxy-backend@0.4.7-next.1
+ - @backstage/backend-defaults@0.2.9-next.1
+ - @backstage/plugin-kubernetes-backend@0.14.1-next.1
+ - @backstage/backend-tasks@0.5.14-next.1
+ - @backstage/plugin-adr-backend@0.4.6-next.1
+ - @backstage/plugin-auth-node@0.4.3-next.1
+ - @backstage/plugin-azure-devops-backend@0.5.1-next.1
+ - @backstage/plugin-badges-backend@0.3.6-next.1
+ - @backstage/plugin-catalog-backend@1.16.1-next.1
+ - @backstage/plugin-catalog-backend-module-backstage-openapi@0.1.2-next.1
+ - @backstage/plugin-catalog-backend-module-openapi@0.1.26-next.1
+ - @backstage/plugin-entity-feedback-backend@0.2.6-next.1
+ - @backstage/plugin-jenkins-backend@0.3.3-next.1
+ - @backstage/plugin-lighthouse-backend@0.4.1-next.1
+ - @backstage/plugin-linguist-backend@0.5.6-next.1
+ - @backstage/plugin-nomad-backend@0.1.11-next.1
+ - @backstage/plugin-permission-backend@0.5.32-next.1
+ - @backstage/plugin-permission-node@0.7.20-next.1
+ - @backstage/plugin-playlist-backend@0.3.13-next.1
+ - @backstage/plugin-scaffolder-backend@1.19.3-next.1
+ - @backstage/plugin-search-backend@1.4.9-next.1
+ - @backstage/plugin-search-backend-module-catalog@0.1.13-next.1
+ - @backstage/plugin-search-backend-module-explore@0.1.13-next.1
+ - @backstage/plugin-search-backend-module-techdocs@0.1.13-next.1
+ - @backstage/plugin-search-backend-node@1.2.13-next.1
+ - @backstage/plugin-sonarqube-backend@0.2.11-next.1
+ - @backstage/plugin-techdocs-backend@1.9.2-next.1
+ - @backstage/plugin-todo-backend@0.3.7-next.1
+ - @backstage/backend-plugin-api@0.6.9-next.1
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.6-next.1
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.6-next.1
+ - @backstage/plugin-permission-backend-module-allow-all-policy@0.1.6-next.1
+ - @backstage/plugin-permission-common@0.7.11
+
+## 0.0.19-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-backend@1.19.3-next.0
+ - @backstage/plugin-search-backend-module-techdocs@0.1.13-next.0
+ - @backstage/plugin-search-backend-module-catalog@0.1.13-next.0
+ - @backstage/plugin-search-backend-module-explore@0.1.13-next.0
+ - @backstage/plugin-azure-devops-backend@0.5.1-next.0
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.6-next.0
+ - @backstage/plugin-permission-backend-module-allow-all-policy@0.1.6-next.0
+ - @backstage/plugin-catalog-backend-module-backstage-openapi@0.1.2-next.0
+ - @backstage/plugin-entity-feedback-backend@0.2.6-next.0
+ - @backstage/plugin-devtools-backend@0.2.6-next.0
+ - @backstage/plugin-linguist-backend@0.5.6-next.0
+ - @backstage/plugin-playlist-backend@0.3.13-next.0
+ - @backstage/plugin-techdocs-backend@1.9.2-next.0
+ - @backstage/plugin-jenkins-backend@0.3.3-next.0
+ - @backstage/plugin-badges-backend@0.3.6-next.0
+ - @backstage/plugin-search-backend@1.4.9-next.0
+ - @backstage/plugin-nomad-backend@0.1.11-next.0
+ - @backstage/plugin-todo-backend@0.3.7-next.0
+ - @backstage/plugin-adr-backend@0.4.6-next.0
+ - @backstage/plugin-app-backend@0.3.57-next.0
+ - @backstage/backend-defaults@0.2.9-next.0
+ - @backstage/backend-plugin-api@0.6.9-next.0
+ - @backstage/backend-tasks@0.5.14-next.0
+ - @backstage/plugin-auth-node@0.4.3-next.0
+ - @backstage/plugin-catalog-backend@1.16.1-next.0
+ - @backstage/plugin-catalog-backend-module-openapi@0.1.26-next.0
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.6-next.0
+ - @backstage/plugin-kubernetes-backend@0.14.1-next.0
+ - @backstage/plugin-lighthouse-backend@0.4.1-next.0
+ - @backstage/plugin-permission-backend@0.5.32-next.0
+ - @backstage/plugin-permission-common@0.7.11
+ - @backstage/plugin-permission-node@0.7.20-next.0
+ - @backstage/plugin-proxy-backend@0.4.7-next.0
+ - @backstage/plugin-search-backend-node@1.2.13-next.0
+ - @backstage/plugin-sonarqube-backend@0.2.11-next.0
+
+## 0.0.18
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-backend-module-backstage-openapi@0.1.1
+ - @backstage/plugin-techdocs-backend@1.9.1
+ - @backstage/plugin-catalog-backend@1.16.0
+ - @backstage/plugin-azure-devops-backend@0.5.0
+ - @backstage/plugin-scaffolder-backend@1.19.2
+ - @backstage/backend-tasks@0.5.13
+ - @backstage/plugin-lighthouse-backend@0.4.0
+ - @backstage/plugin-kubernetes-backend@0.14.0
+ - @backstage/plugin-auth-node@0.4.2
+ - @backstage/plugin-permission-backend@0.5.31
+ - @backstage/plugin-permission-common@0.7.11
+ - @backstage/plugin-playlist-backend@0.3.12
+ - @backstage/plugin-permission-node@0.7.19
+ - @backstage/plugin-search-backend@1.4.8
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.5
+ - @backstage/plugin-permission-backend-module-allow-all-policy@0.1.5
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.5
+ - @backstage/plugin-search-backend-module-techdocs@0.1.12
+ - @backstage/plugin-search-backend-module-catalog@0.1.12
+ - @backstage/plugin-search-backend-module-explore@0.1.12
+ - @backstage/backend-defaults@0.2.8
+ - @backstage/plugin-adr-backend@0.4.5
+ - @backstage/plugin-app-backend@0.3.56
+ - @backstage/plugin-badges-backend@0.3.5
+ - @backstage/plugin-catalog-backend-module-openapi@0.1.25
+ - @backstage/plugin-devtools-backend@0.2.5
+ - @backstage/plugin-entity-feedback-backend@0.2.5
+ - @backstage/plugin-jenkins-backend@0.3.2
+ - @backstage/plugin-linguist-backend@0.5.5
+ - @backstage/plugin-nomad-backend@0.1.10
+ - @backstage/plugin-proxy-backend@0.4.6
+ - @backstage/plugin-search-backend-node@1.2.12
+ - @backstage/plugin-sonarqube-backend@0.2.10
+ - @backstage/plugin-todo-backend@0.3.6
+ - @backstage/backend-plugin-api@0.6.8
+
+## 0.0.18-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-azure-devops-backend@0.5.0-next.3
+ - @backstage/plugin-scaffolder-backend@1.19.2-next.3
+ - @backstage/backend-defaults@0.2.8-next.3
+ - @backstage/backend-plugin-api@0.6.8-next.3
+ - @backstage/backend-tasks@0.5.13-next.3
+ - @backstage/plugin-adr-backend@0.4.5-next.3
+ - @backstage/plugin-app-backend@0.3.56-next.3
+ - @backstage/plugin-auth-node@0.4.2-next.3
+ - @backstage/plugin-badges-backend@0.3.5-next.3
+ - @backstage/plugin-catalog-backend@1.16.0-next.3
+ - @backstage/plugin-catalog-backend-module-backstage-openapi@0.1.1-next.3
+ - @backstage/plugin-catalog-backend-module-openapi@0.1.25-next.3
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.5-next.3
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.5-next.3
+ - @backstage/plugin-devtools-backend@0.2.5-next.3
+ - @backstage/plugin-entity-feedback-backend@0.2.5-next.3
+ - @backstage/plugin-jenkins-backend@0.3.2-next.3
+ - @backstage/plugin-kubernetes-backend@0.14.0-next.3
+ - @backstage/plugin-lighthouse-backend@0.4.0-next.3
+ - @backstage/plugin-linguist-backend@0.5.5-next.3
+ - @backstage/plugin-nomad-backend@0.1.10-next.3
+ - @backstage/plugin-permission-backend@0.5.31-next.3
+ - @backstage/plugin-permission-backend-module-allow-all-policy@0.1.5-next.3
+ - @backstage/plugin-permission-common@0.7.10
+ - @backstage/plugin-permission-node@0.7.19-next.3
+ - @backstage/plugin-playlist-backend@0.3.12-next.3
+ - @backstage/plugin-proxy-backend@0.4.6-next.3
+ - @backstage/plugin-search-backend@1.4.8-next.3
+ - @backstage/plugin-search-backend-module-catalog@0.1.12-next.3
+ - @backstage/plugin-search-backend-module-explore@0.1.12-next.3
+ - @backstage/plugin-search-backend-module-techdocs@0.1.12-next.3
+ - @backstage/plugin-search-backend-node@1.2.12-next.3
+ - @backstage/plugin-sonarqube-backend@0.2.10-next.3
+ - @backstage/plugin-techdocs-backend@1.9.1-next.3
+ - @backstage/plugin-todo-backend@0.3.6-next.3
+
+## 0.0.18-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-backend@1.16.0-next.2
+ - @backstage/plugin-lighthouse-backend@0.4.0-next.2
+ - @backstage/plugin-auth-node@0.4.2-next.2
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.5-next.2
+ - @backstage/plugin-permission-backend-module-allow-all-policy@0.1.5-next.2
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.5-next.2
+ - @backstage/plugin-search-backend-module-techdocs@0.1.12-next.2
+ - @backstage/plugin-search-backend-module-catalog@0.1.12-next.2
+ - @backstage/plugin-search-backend-module-explore@0.1.12-next.2
+ - @backstage/backend-defaults@0.2.8-next.2
+ - @backstage/backend-plugin-api@0.6.8-next.2
+ - @backstage/backend-tasks@0.5.13-next.2
+ - @backstage/plugin-adr-backend@0.4.5-next.2
+ - @backstage/plugin-app-backend@0.3.56-next.2
+ - @backstage/plugin-azure-devops-backend@0.5.0-next.2
+ - @backstage/plugin-badges-backend@0.3.5-next.2
+ - @backstage/plugin-catalog-backend-module-backstage-openapi@0.1.1-next.2
+ - @backstage/plugin-catalog-backend-module-openapi@0.1.25-next.2
+ - @backstage/plugin-devtools-backend@0.2.5-next.2
+ - @backstage/plugin-entity-feedback-backend@0.2.5-next.2
+ - @backstage/plugin-jenkins-backend@0.3.2-next.2
+ - @backstage/plugin-kubernetes-backend@0.14.0-next.2
+ - @backstage/plugin-linguist-backend@0.5.5-next.2
+ - @backstage/plugin-nomad-backend@0.1.10-next.2
+ - @backstage/plugin-permission-backend@0.5.31-next.2
+ - @backstage/plugin-permission-common@0.7.10
+ - @backstage/plugin-permission-node@0.7.19-next.2
+ - @backstage/plugin-playlist-backend@0.3.12-next.2
+ - @backstage/plugin-proxy-backend@0.4.6-next.2
+ - @backstage/plugin-scaffolder-backend@1.19.2-next.2
+ - @backstage/plugin-search-backend@1.4.8-next.2
+ - @backstage/plugin-search-backend-node@1.2.12-next.2
+ - @backstage/plugin-sonarqube-backend@0.2.10-next.2
+ - @backstage/plugin-techdocs-backend@1.9.1-next.2
+ - @backstage/plugin-todo-backend@0.3.6-next.2
+
+## 0.0.18-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-backend-module-backstage-openapi@0.1.1-next.1
+ - @backstage/plugin-catalog-backend@1.15.1-next.1
+ - @backstage/plugin-azure-devops-backend@0.5.0-next.1
+ - @backstage/plugin-kubernetes-backend@0.14.0-next.1
+ - @backstage/backend-defaults@0.2.8-next.1
+ - @backstage/backend-plugin-api@0.6.8-next.1
+ - @backstage/backend-tasks@0.5.13-next.1
+ - @backstage/plugin-adr-backend@0.4.5-next.1
+ - @backstage/plugin-app-backend@0.3.56-next.1
+ - @backstage/plugin-auth-node@0.4.2-next.1
+ - @backstage/plugin-badges-backend@0.3.5-next.1
+ - @backstage/plugin-catalog-backend-module-openapi@0.1.25-next.1
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.5-next.1
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.5-next.1
+ - @backstage/plugin-devtools-backend@0.2.5-next.1
+ - @backstage/plugin-entity-feedback-backend@0.2.5-next.1
+ - @backstage/plugin-jenkins-backend@0.3.2-next.1
+ - @backstage/plugin-lighthouse-backend@0.3.5-next.1
+ - @backstage/plugin-linguist-backend@0.5.5-next.1
+ - @backstage/plugin-nomad-backend@0.1.10-next.1
+ - @backstage/plugin-permission-backend@0.5.31-next.1
+ - @backstage/plugin-permission-backend-module-allow-all-policy@0.1.5-next.1
+ - @backstage/plugin-permission-common@0.7.10
+ - @backstage/plugin-permission-node@0.7.19-next.1
+ - @backstage/plugin-playlist-backend@0.3.12-next.1
+ - @backstage/plugin-proxy-backend@0.4.6-next.1
+ - @backstage/plugin-scaffolder-backend@1.19.2-next.1
+ - @backstage/plugin-search-backend@1.4.8-next.1
+ - @backstage/plugin-search-backend-module-catalog@0.1.12-next.1
+ - @backstage/plugin-search-backend-module-explore@0.1.12-next.1
+ - @backstage/plugin-search-backend-module-techdocs@0.1.12-next.1
+ - @backstage/plugin-search-backend-node@1.2.12-next.1
+ - @backstage/plugin-sonarqube-backend@0.2.10-next.1
+ - @backstage/plugin-techdocs-backend@1.9.1-next.1
+ - @backstage/plugin-todo-backend@0.3.6-next.1
+
## 0.0.18-next.0
### Patch Changes
diff --git a/packages/backend-next/README.md b/packages/backend-next/README.md
index 94fc0767c4..4634e5673f 100644
--- a/packages/backend-next/README.md
+++ b/packages/backend-next/README.md
@@ -1,5 +1,5 @@
# example-backend-next
-This is an example backend for the new **EXPERIMENTAL** Backstage backend system.
+This is an example backend for [the new Backstage backend system](https://backstage.io/docs/backend-system/).
Do not use this in your own projects.
diff --git a/packages/backend-next/package.json b/packages/backend-next/package.json
index 2d53421dfc..d230227889 100644
--- a/packages/backend-next/package.json
+++ b/packages/backend-next/package.json
@@ -1,6 +1,6 @@
{
"name": "example-backend-next",
- "version": "0.0.18-next.0",
+ "version": "0.0.20-next.0",
"main": "dist/index.cjs.js",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/packages/backend-openapi-utils/CHANGELOG.md b/packages/backend-openapi-utils/CHANGELOG.md
index 39c12d507f..0b21b9aff3 100644
--- a/packages/backend-openapi-utils/CHANGELOG.md
+++ b/packages/backend-openapi-utils/CHANGELOG.md
@@ -1,5 +1,84 @@
# @backstage/backend-openapi-utils
+## 0.1.3-next.0
+
+### Patch Changes
+
+- 2067689: Internal updates due to `json-schema-to-ts`
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.6.10-next.0
+ - @backstage/errors@1.2.3
+
+## 0.1.2
+
+### Patch Changes
+
+- 4016f21: Remove some unused dependencies
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.6.9
+ - @backstage/errors@1.2.3
+
+## 0.1.2-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.6.9-next.2
+
+## 0.1.2-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.6.9-next.1
+ - @backstage/errors@1.2.3
+
+## 0.1.2-next.0
+
+### Patch Changes
+
+- 4016f21: Remove some unused dependencies
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.6.9-next.0
+ - @backstage/errors@1.2.3
+
+## 0.1.1
+
+### Patch Changes
+
+- aaa6fb3: Minor updates for TypeScript 5.2.2+ compatibility
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.6.8
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+
+## 0.1.1-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.6.8-next.3
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+
+## 0.1.1-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.6.8-next.2
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+
+## 0.1.1-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.6.8-next.1
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+
## 0.1.1-next.0
### Patch Changes
diff --git a/packages/backend-openapi-utils/api-report.md b/packages/backend-openapi-utils/api-report.md
index 0d78ec9671..8e702b8c23 100644
--- a/packages/backend-openapi-utils/api-report.md
+++ b/packages/backend-openapi-utils/api-report.md
@@ -7,7 +7,7 @@ import type { ContentObject } from 'openapi3-ts';
import type core from 'express-serve-static-core';
import { Express as Express_2 } from 'express';
import { FromSchema } from 'json-schema-to-ts';
-import { JSONSchema7 } from 'json-schema-to-ts';
+import { JSONSchema } from 'json-schema-to-ts';
import { middleware } from 'express-openapi-validator';
import type { OpenAPIObject } from 'openapi3-ts';
import type { ParameterObject } from 'openapi3-ts';
@@ -62,7 +62,7 @@ type ComponentTypes = Extract<
// @public (undocumented)
type ConvertAll> = {
- [Index in keyof T]: T[Index] extends JSONSchema7
+ [Index in keyof T]: T[Index] extends JSONSchema
? FromSchema
: T[Index];
} & {
@@ -463,7 +463,7 @@ type ParameterSchema<
Schema extends ImmutableParameterObject['schema'],
> = SchemaRef extends infer R
? R extends ImmutableSchemaObject
- ? R extends JSONSchema7
+ ? R extends JSONSchema
? FromSchema
: never
: never
diff --git a/packages/backend-openapi-utils/package.json b/packages/backend-openapi-utils/package.json
index e3d57c8f27..a9ce8c56e2 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.1-next.0",
+ "version": "0.1.3-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -38,7 +38,6 @@
],
"dependencies": {
"@backstage/backend-plugin-api": "workspace:^",
- "@backstage/config": "workspace:^",
"@backstage/errors": "workspace:^",
"@types/express": "^4.17.6",
"@types/express-serve-static-core": "^4.17.5",
diff --git a/packages/backend-openapi-utils/src/types/common.ts b/packages/backend-openapi-utils/src/types/common.ts
index f9dedf2f84..a43ad4449f 100644
--- a/packages/backend-openapi-utils/src/types/common.ts
+++ b/packages/backend-openapi-utils/src/types/common.ts
@@ -18,7 +18,7 @@
* Pulled from https://github.com/varanauskas/oatx.
*/
-import { FromSchema, JSONSchema7 } from 'json-schema-to-ts';
+import { FromSchema, JSONSchema } from 'json-schema-to-ts';
import {
ImmutableContentObject,
ImmutableOpenAPIObject,
@@ -221,7 +221,7 @@ export type TuplifyUnion<
* @public
*/
export type ConvertAll> = {
- [Index in keyof T]: T[Index] extends JSONSchema7
+ [Index in keyof T]: T[Index] extends JSONSchema
? FromSchema
: T[Index];
} & { length: T['length'] };
diff --git a/packages/backend-openapi-utils/src/types/params.ts b/packages/backend-openapi-utils/src/types/params.ts
index 208cbd4e9a..969657bac7 100644
--- a/packages/backend-openapi-utils/src/types/params.ts
+++ b/packages/backend-openapi-utils/src/types/params.ts
@@ -36,7 +36,7 @@ import {
SchemaRef,
ValueOf,
} from './common';
-import { FromSchema, JSONSchema7 } from 'json-schema-to-ts';
+import { FromSchema, JSONSchema } from 'json-schema-to-ts';
/**
* @public
@@ -96,7 +96,7 @@ export type ParameterSchema<
Schema extends ImmutableParameterObject['schema'],
> = SchemaRef extends infer R
? R extends ImmutableSchemaObject
- ? R extends JSONSchema7
+ ? R extends JSONSchema
? FromSchema
: never
: never
diff --git a/packages/backend-plugin-api/CHANGELOG.md b/packages/backend-plugin-api/CHANGELOG.md
index 98d025ca68..aa8a153f41 100644
--- a/packages/backend-plugin-api/CHANGELOG.md
+++ b/packages/backend-plugin-api/CHANGELOG.md
@@ -1,5 +1,103 @@
# @backstage/backend-plugin-api
+## 0.6.10-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-tasks@0.5.15-next.0
+ - @backstage/plugin-auth-node@0.4.4-next.0
+ - @backstage/config@1.1.1
+ - @backstage/types@1.1.1
+ - @backstage/plugin-permission-common@0.7.12
+
+## 0.6.9
+
+### Patch Changes
+
+- 516fd3e: Updated README to reflect release status
+- Updated dependencies
+ - @backstage/plugin-permission-common@0.7.12
+ - @backstage/backend-tasks@0.5.14
+ - @backstage/plugin-auth-node@0.4.3
+ - @backstage/config@1.1.1
+ - @backstage/types@1.1.1
+
+## 0.6.9-next.2
+
+### Patch Changes
+
+- 516fd3e: Updated README to reflect release status
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.4.3-next.2
+ - @backstage/backend-tasks@0.5.14-next.2
+
+## 0.6.9-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/config@1.1.1
+ - @backstage/backend-tasks@0.5.14-next.1
+ - @backstage/plugin-auth-node@0.4.3-next.1
+ - @backstage/types@1.1.1
+ - @backstage/plugin-permission-common@0.7.11
+
+## 0.6.9-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-tasks@0.5.14-next.0
+ - @backstage/config@1.1.1
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.4.3-next.0
+ - @backstage/plugin-permission-common@0.7.11
+
+## 0.6.8
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-tasks@0.5.13
+ - @backstage/plugin-auth-node@0.4.2
+ - @backstage/plugin-permission-common@0.7.11
+ - @backstage/config@1.1.1
+ - @backstage/types@1.1.1
+
+## 0.6.8-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-tasks@0.5.13-next.3
+ - @backstage/config@1.1.1
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.4.2-next.3
+ - @backstage/plugin-permission-common@0.7.10
+
+## 0.6.8-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.4.2-next.2
+ - @backstage/backend-tasks@0.5.13-next.2
+ - @backstage/config@1.1.1
+ - @backstage/types@1.1.1
+ - @backstage/plugin-permission-common@0.7.10
+
+## 0.6.8-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-tasks@0.5.13-next.1
+ - @backstage/config@1.1.1
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.4.2-next.1
+ - @backstage/plugin-permission-common@0.7.10
+
## 0.6.8-next.0
### Patch Changes
diff --git a/packages/backend-plugin-api/README.md b/packages/backend-plugin-api/README.md
index a17c8715a7..b827ecc50c 100644
--- a/packages/backend-plugin-api/README.md
+++ b/packages/backend-plugin-api/README.md
@@ -1,8 +1,6 @@
# @backstage/backend-plugin-api
-**This package is EXPERIMENTAL, but we encourage use of it to add support for the new backend system in your own plugins**
-
-This package provides the core API used by Backstage backend plugins and modules.
+This package provides the framework API used by Backstage backend plugins and modules.
## Installation
diff --git a/packages/backend-plugin-api/alpha-api-report.md b/packages/backend-plugin-api/api-report-alpha.md
similarity index 100%
rename from packages/backend-plugin-api/alpha-api-report.md
rename to packages/backend-plugin-api/api-report-alpha.md
diff --git a/packages/backend-plugin-api/package.json b/packages/backend-plugin-api/package.json
index 81a4694934..2d099e7383 100644
--- a/packages/backend-plugin-api/package.json
+++ b/packages/backend-plugin-api/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/backend-plugin-api",
"description": "Core API used by Backstage backend plugins",
- "version": "0.6.8-next.0",
+ "version": "0.6.10-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
diff --git a/packages/backend-tasks/CHANGELOG.md b/packages/backend-tasks/CHANGELOG.md
index 8635aa3e03..654d092591 100644
--- a/packages/backend-tasks/CHANGELOG.md
+++ b/packages/backend-tasks/CHANGELOG.md
@@ -1,5 +1,94 @@
# @backstage/backend-tasks
+## 0.5.15-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.21.0-next.0
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+
+## 0.5.14
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.1
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+
+## 0.5.14-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.1-next.2
+
+## 0.5.14-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.1-next.1
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+
+## 0.5.14-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.1-next.0
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+
+## 0.5.13
+
+### Patch Changes
+
+- d8f488a: Allow tasks to run more often that the default work check interval, which is 5 seconds.
+- 0cbb03b: Fixing regular expression ReDoS with zod packages. Upgrading to latest. ref: https://security.snyk.io/vuln/SNYK-JS-ZOD-5925617
+- Updated dependencies
+ - @backstage/backend-common@0.20.0
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+
+## 0.5.13-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.0-next.3
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+
+## 0.5.13-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.0-next.2
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+
+## 0.5.13-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.0-next.1
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+
## 0.5.13-next.0
### Patch Changes
diff --git a/packages/backend-tasks/package.json b/packages/backend-tasks/package.json
index cd71be4190..12ed0dc414 100644
--- a/packages/backend-tasks/package.json
+++ b/packages/backend-tasks/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/backend-tasks",
"description": "Common distributed task management library for Backstage backends",
- "version": "0.5.13-next.0",
+ "version": "0.5.15-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
@@ -44,7 +44,7 @@
"luxon": "^3.0.0",
"uuid": "^8.0.0",
"winston": "^3.2.1",
- "zod": "^3.21.4"
+ "zod": "^3.22.4"
},
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
diff --git a/packages/backend-tasks/src/migrations.test.ts b/packages/backend-tasks/src/migrations.test.ts
index 1d701c971d..82208da975 100644
--- a/packages/backend-tasks/src/migrations.test.ts
+++ b/packages/backend-tasks/src/migrations.test.ts
@@ -42,9 +42,7 @@ async function migrateUntilBefore(knex: Knex, target: string): Promise {
jest.setTimeout(60_000);
describe('migrations', () => {
- const databases = TestDatabases.create({
- ids: ['POSTGRES_13', 'POSTGRES_9', 'MYSQL_8', 'SQLITE_3'],
- });
+ const databases = TestDatabases.create();
it.each(databases.eachSupportedId())(
'20210928160613_init.js, %p',
diff --git a/packages/backend-tasks/src/setupTests.ts b/packages/backend-tasks/src/setupTests.ts
index 5245d37c26..76619a2542 100644
--- a/packages/backend-tasks/src/setupTests.ts
+++ b/packages/backend-tasks/src/setupTests.ts
@@ -14,7 +14,12 @@
* limitations under the License.
*/
+import { TestDatabases } from '@backstage/backend-test-utils';
import { Settings } from 'luxon';
// TS still thinks that methods can return null / placeholders, but we still want to throw as soon as possible when things go wrong
Settings.throwOnInvalid = true;
+
+TestDatabases.setDefaults({
+ ids: ['MYSQL_8', 'POSTGRES_16', 'POSTGRES_12', 'SQLITE_3'],
+});
diff --git a/packages/backend-tasks/src/tasks/PluginTaskSchedulerImpl.test.ts b/packages/backend-tasks/src/tasks/PluginTaskSchedulerImpl.test.ts
index 6247755bbd..4b40791cb5 100644
--- a/packages/backend-tasks/src/tasks/PluginTaskSchedulerImpl.test.ts
+++ b/packages/backend-tasks/src/tasks/PluginTaskSchedulerImpl.test.ts
@@ -36,7 +36,7 @@ jest.setTimeout(60_000);
describe('PluginTaskManagerImpl', () => {
const databases = TestDatabases.create({
- ids: ['POSTGRES_13', 'POSTGRES_9', 'SQLITE_3'],
+ ids: ['POSTGRES_16', 'POSTGRES_12', 'SQLITE_3'],
});
beforeAll(async () => {
diff --git a/packages/backend-tasks/src/tasks/PluginTaskSchedulerJanitor.test.ts b/packages/backend-tasks/src/tasks/PluginTaskSchedulerJanitor.test.ts
index 50bea27d27..1f0363625e 100644
--- a/packages/backend-tasks/src/tasks/PluginTaskSchedulerJanitor.test.ts
+++ b/packages/backend-tasks/src/tasks/PluginTaskSchedulerJanitor.test.ts
@@ -40,8 +40,8 @@ describe('PluginTaskSchedulerJanitor', () => {
const databases = TestDatabases.create({
ids: [
/* 'MYSQL_8' not supported yet */
- 'POSTGRES_13',
- 'POSTGRES_9',
+ 'POSTGRES_16',
+ 'POSTGRES_12',
'SQLITE_3',
'MYSQL_8',
],
diff --git a/packages/backend-tasks/src/tasks/TaskScheduler.test.ts b/packages/backend-tasks/src/tasks/TaskScheduler.test.ts
index 8e419437bc..d286eaee38 100644
--- a/packages/backend-tasks/src/tasks/TaskScheduler.test.ts
+++ b/packages/backend-tasks/src/tasks/TaskScheduler.test.ts
@@ -25,9 +25,7 @@ jest.setTimeout(60_000);
describe('TaskScheduler', () => {
const logger = getVoidLogger();
- const databases = TestDatabases.create({
- ids: ['POSTGRES_13', 'POSTGRES_9', 'SQLITE_3', 'MYSQL_8'],
- });
+ const databases = TestDatabases.create();
const testScopedSignal = createTestScopedSignal();
async function createDatabase(
diff --git a/packages/backend-tasks/src/tasks/TaskWorker.test.ts b/packages/backend-tasks/src/tasks/TaskWorker.test.ts
index 45eb7d1003..a2ecdaa779 100644
--- a/packages/backend-tasks/src/tasks/TaskWorker.test.ts
+++ b/packages/backend-tasks/src/tasks/TaskWorker.test.ts
@@ -28,9 +28,7 @@ jest.setTimeout(60_000);
describe('TaskWorker', () => {
const logger = getVoidLogger();
- const databases = TestDatabases.create({
- ids: ['POSTGRES_13', 'POSTGRES_9', 'SQLITE_3', 'MYSQL_8'],
- });
+ const databases = TestDatabases.create();
const testScopedSignal = createTestScopedSignal();
beforeEach(() => {
diff --git a/packages/backend-test-utils/CHANGELOG.md b/packages/backend-test-utils/CHANGELOG.md
index 4931fd8b2f..4b369454a0 100644
--- a/packages/backend-test-utils/CHANGELOG.md
+++ b/packages/backend-test-utils/CHANGELOG.md
@@ -1,5 +1,129 @@
# @backstage/backend-test-utils
+## 0.3.0-next.0
+
+### Minor Changes
+
+- e85aa98: drop databases after unit tests if the database instance is not running in docker
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.21.0-next.0
+ - @backstage/backend-app-api@0.5.11-next.0
+ - @backstage/plugin-auth-node@0.4.4-next.0
+ - @backstage/backend-plugin-api@0.6.10-next.0
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+
+## 0.2.10
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.1
+ - @backstage/backend-plugin-api@0.6.9
+ - @backstage/backend-app-api@0.5.10
+ - @backstage/plugin-auth-node@0.4.3
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+
+## 0.2.10-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.6.9-next.2
+ - @backstage/backend-app-api@0.5.10-next.2
+ - @backstage/backend-common@0.20.1-next.2
+ - @backstage/plugin-auth-node@0.4.3-next.2
+
+## 0.2.10-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-app-api@0.5.10-next.1
+ - @backstage/backend-common@0.20.1-next.1
+ - @backstage/config@1.1.1
+ - @backstage/plugin-auth-node@0.4.3-next.1
+ - @backstage/backend-plugin-api@0.6.9-next.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+
+## 0.2.10-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.1-next.0
+ - @backstage/backend-app-api@0.5.10-next.0
+ - @backstage/backend-plugin-api@0.6.9-next.0
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.4.3-next.0
+
+## 0.2.9
+
+### Patch Changes
+
+- cc4228e: Switched module ID to use kebab-case.
+- b7de76a: Added support for PostgreSQL versions 15 and 16
+
+ Also introduced a new `setDefaults(options: { ids?: TestDatabaseId[] })` static method that can be added to the `setupTests.ts` file to define the default database ids you want to use throughout your package. Usage would look like this: `TestDatabases.setDefaults({ ids: ['POSTGRES_12','POSTGRES_16'] })` and would result in PostgreSQL versions 12 and 16 being used for your tests.
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.0
+ - @backstage/backend-app-api@0.5.9
+ - @backstage/plugin-auth-node@0.4.2
+ - @backstage/backend-plugin-api@0.6.8
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+
+## 0.2.9-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.20.0-next.3
+ - @backstage/backend-app-api@0.5.9-next.3
+ - @backstage/backend-plugin-api@0.6.8-next.3
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.4.2-next.3
+
+## 0.2.9-next.2
+
+### Patch Changes
+
+- cc4228e: Switched module ID to use kebab-case.
+- Updated dependencies
+ - @backstage/backend-common@0.20.0-next.2
+ - @backstage/plugin-auth-node@0.4.2-next.2
+ - @backstage/backend-app-api@0.5.9-next.2
+ - @backstage/backend-plugin-api@0.6.8-next.2
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+
+## 0.2.9-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-app-api@0.5.9-next.1
+ - @backstage/backend-common@0.20.0-next.1
+ - @backstage/backend-plugin-api@0.6.8-next.1
+ - @backstage/config@1.1.1
+ - @backstage/errors@1.2.3
+ - @backstage/types@1.1.1
+ - @backstage/plugin-auth-node@0.4.2-next.1
+
## 0.2.9-next.0
### Patch Changes
diff --git a/packages/backend-test-utils/api-report.md b/packages/backend-test-utils/api-report.md
index ac012e2f69..204e5dc84a 100644
--- a/packages/backend-test-utils/api-report.md
+++ b/packages/backend-test-utils/api-report.md
@@ -307,6 +307,8 @@ export interface TestBackendOptions {
// @public
export type TestDatabaseId =
+ | 'POSTGRES_16'
+ | 'POSTGRES_15'
| 'POSTGRES_14'
| 'POSTGRES_13'
| 'POSTGRES_12'
@@ -325,6 +327,8 @@ export class TestDatabases {
eachSupportedId(): [TestDatabaseId][];
init(id: TestDatabaseId): Promise;
// (undocumented)
+ static setDefaults(options: { ids?: TestDatabaseId[] }): void;
+ // (undocumented)
supports(id: TestDatabaseId): boolean;
}
```
diff --git a/packages/backend-test-utils/package.json b/packages/backend-test-utils/package.json
index f449be08ed..2e517d542f 100644
--- a/packages/backend-test-utils/package.json
+++ b/packages/backend-test-utils/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/backend-test-utils",
"description": "Test helpers library for Backstage backends",
- "version": "0.2.9-next.0",
+ "version": "0.3.0-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
diff --git a/packages/backend-test-utils/src/database/TestDatabases.test.ts b/packages/backend-test-utils/src/database/TestDatabases.test.ts
index d766d38815..64e4d76443 100644
--- a/packages/backend-test-utils/src/database/TestDatabases.test.ts
+++ b/packages/backend-test-utils/src/database/TestDatabases.test.ts
@@ -59,6 +59,68 @@ describe('TestDatabases', () => {
describe('each connect', () => {
const dbs = TestDatabases.create();
+ itIfDocker(
+ 'obeys a provided connection string for postgres 16',
+ async () => {
+ const { host, port, user, password, stop } =
+ await startPostgresContainer('postgres:16');
+
+ try {
+ // Leave a mark
+ process.env.BACKSTAGE_TEST_DATABASE_POSTGRES16_CONNECTION_STRING = `postgresql://${user}:${password}@${host}:${port}`;
+ const input = await dbs.init('POSTGRES_16');
+ await input.schema.createTable('a', table =>
+ table.string('x').primary(),
+ );
+ await input.insert({ x: 'y' }).into('a');
+
+ // Look for the mark
+ const database = input.client.config.connection.database;
+ const output = knexFactory({
+ client: 'pg',
+ connection: { host, port, user, password, database },
+ });
+ // eslint-disable-next-line jest/no-standalone-expect
+ await expect(output.select('x').from('a')).resolves.toEqual([
+ { x: 'y' },
+ ]);
+ } finally {
+ await stop();
+ }
+ },
+ );
+
+ itIfDocker(
+ 'obeys a provided connection string for postgres 15',
+ async () => {
+ const { host, port, user, password, stop } =
+ await startPostgresContainer('postgres:15');
+
+ try {
+ // Leave a mark
+ process.env.BACKSTAGE_TEST_DATABASE_POSTGRES15_CONNECTION_STRING = `postgresql://${user}:${password}@${host}:${port}`;
+ const input = await dbs.init('POSTGRES_15');
+ await input.schema.createTable('a', table =>
+ table.string('x').primary(),
+ );
+ await input.insert({ x: 'y' }).into('a');
+
+ // Look for the mark
+ const database = input.client.config.connection.database;
+ const output = knexFactory({
+ client: 'pg',
+ connection: { host, port, user, password, database },
+ });
+ // eslint-disable-next-line jest/no-standalone-expect
+ await expect(output.select('x').from('a')).resolves.toEqual([
+ { x: 'y' },
+ ]);
+ } finally {
+ await stop();
+ }
+ },
+ );
+
itIfDocker(
'obeys a provided connection string for postgres 14',
async () => {
diff --git a/packages/backend-test-utils/src/database/TestDatabases.ts b/packages/backend-test-utils/src/database/TestDatabases.ts
index 45d2899dbb..4ea8fe05d7 100644
--- a/packages/backend-test-utils/src/database/TestDatabases.ts
+++ b/packages/backend-test-utils/src/database/TestDatabases.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-import { DatabaseManager } from '@backstage/backend-common';
+import { DatabaseManager, dropDatabase } from '@backstage/backend-common';
import { ConfigReader } from '@backstage/config';
import { randomBytes } from 'crypto';
import { Knex } from 'knex';
@@ -44,6 +44,7 @@ const LARGER_POOL_CONFIG = {
export class TestDatabases {
private readonly instanceById: Map;
private readonly supportedIds: TestDatabaseId[];
+ private static defaultIds?: TestDatabaseId[];
/**
* Creates an empty `TestDatabases` instance, and sets up Jest to clean up
@@ -60,18 +61,19 @@ export class TestDatabases {
ids?: TestDatabaseId[];
disableDocker?: boolean;
}): TestDatabases {
- const defaultOptions = {
- ids: Object.keys(allDatabases) as TestDatabaseId[],
- disableDocker: isDockerDisabledForTests(),
- };
+ const ids = options?.ids;
+ const disableDocker = options?.disableDocker ?? isDockerDisabledForTests();
- const { ids, disableDocker } = Object.assign(
- {},
- defaultOptions,
- options ?? {},
- );
+ let testDatabaseIds: TestDatabaseId[];
+ if (ids) {
+ testDatabaseIds = ids;
+ } else if (TestDatabases.defaultIds) {
+ testDatabaseIds = TestDatabases.defaultIds;
+ } else {
+ testDatabaseIds = Object.keys(allDatabases) as TestDatabaseId[];
+ }
- const supportedIds = ids.filter(id => {
+ const supportedIds = testDatabaseIds.filter(id => {
const properties = allDatabases[id];
if (!properties) {
return false;
@@ -107,6 +109,10 @@ export class TestDatabases {
return databases;
}
+ static setDefaults(options: { ids?: TestDatabaseId[] }) {
+ TestDatabases.defaultIds = options.ids;
+ }
+
private constructor(supportedIds: TestDatabaseId[]) {
this.instanceById = new Map();
this.supportedIds = supportedIds;
@@ -151,11 +157,13 @@ export class TestDatabases {
}
// Ensure that a unique logical database is created in the instance
+ const databaseName = `db${randomBytes(16).toString('hex')}`;
const connection = await instance.databaseManager
- .forPlugin(`db${randomBytes(16).toString('hex')}`)
+ .forPlugin(databaseName)
.getClient();
instance.connections.push(connection);
+ instance.databaseNames.push(databaseName);
return connection;
}
@@ -167,21 +175,30 @@ export class TestDatabases {
if (envVarName) {
const connectionString = process.env[envVarName];
if (connectionString) {
- const databaseManager = DatabaseManager.fromConfig(
- new ConfigReader({
- backend: {
- database: {
- knexConfig: properties.driver.includes('sqlite')
- ? {}
- : LARGER_POOL_CONFIG,
- client: properties.driver,
- connection: connectionString,
- },
+ const config = new ConfigReader({
+ backend: {
+ database: {
+ knexConfig: properties.driver.includes('sqlite')
+ ? {}
+ : LARGER_POOL_CONFIG,
+ client: properties.driver,
+ connection: connectionString,
},
- }),
- );
+ },
+ });
+ const databaseManager = DatabaseManager.fromConfig(config);
+ const databaseNames: Array = [];
return {
+ dropDatabases: async () => {
+ await dropDatabase(
+ config.getConfig('backend.database'),
+ ...databaseNames.map(
+ databaseName => `backstage_plugin_${databaseName}`,
+ ),
+ );
+ },
databaseManager,
+ databaseNames,
connections: [],
};
}
@@ -220,10 +237,10 @@ export class TestDatabases {
},
}),
);
-
return {
stopContainer: stop,
databaseManager,
+ databaseNames: [],
connections: [],
};
}
@@ -250,6 +267,7 @@ export class TestDatabases {
return {
stopContainer: stop,
databaseManager,
+ databaseNames: [],
connections: [],
};
}
@@ -267,9 +285,9 @@ export class TestDatabases {
},
}),
);
-
return {
databaseManager,
+ databaseNames: [],
connections: [],
};
}
@@ -278,7 +296,12 @@ export class TestDatabases {
const instances = [...this.instanceById.values()];
this.instanceById.clear();
- for (const { stopContainer, connections, databaseManager } of instances) {
+ for (const {
+ stopContainer,
+ dropDatabases,
+ connections,
+ databaseManager,
+ } of instances) {
for (const connection of connections) {
try {
await connection.destroy();
@@ -290,6 +313,15 @@ export class TestDatabases {
}
}
+ // If the database is not running in docker then drop the databases
+ try {
+ await dropDatabases?.();
+ } catch (error) {
+ console.warn(`TestDatabases: Failed to drop databases`, {
+ error,
+ });
+ }
+
try {
await stopContainer?.();
} catch (error) {
diff --git a/packages/backend-test-utils/src/database/types.ts b/packages/backend-test-utils/src/database/types.ts
index a7bfdeb12d..77a0c4e960 100644
--- a/packages/backend-test-utils/src/database/types.ts
+++ b/packages/backend-test-utils/src/database/types.ts
@@ -24,6 +24,8 @@ import { getDockerImageForName } from '../util/getDockerImageForName';
* @public
*/
export type TestDatabaseId =
+ | 'POSTGRES_16'
+ | 'POSTGRES_15'
| 'POSTGRES_14'
| 'POSTGRES_13'
| 'POSTGRES_12'
@@ -41,12 +43,28 @@ export type TestDatabaseProperties = {
export type Instance = {
stopContainer?: () => Promise;
+ dropDatabases?: () => Promise;
databaseManager: DatabaseManager;
connections: Array;
+ databaseNames: Array;
};
export const allDatabases: Record =
Object.freeze({
+ POSTGRES_16: {
+ name: 'Postgres 16.x',
+ driver: 'pg',
+ dockerImageName: getDockerImageForName('postgres:16'),
+ connectionStringEnvironmentVariableName:
+ 'BACKSTAGE_TEST_DATABASE_POSTGRES16_CONNECTION_STRING',
+ },
+ POSTGRES_15: {
+ name: 'Postgres 15.x',
+ driver: 'pg',
+ dockerImageName: getDockerImageForName('postgres:15'),
+ connectionStringEnvironmentVariableName:
+ 'BACKSTAGE_TEST_DATABASE_POSTGRES15_CONNECTION_STRING',
+ },
POSTGRES_14: {
name: 'Postgres 14.x',
driver: 'pg',
diff --git a/packages/backend-test-utils/src/next/wiring/TestBackend.test.ts b/packages/backend-test-utils/src/next/wiring/TestBackend.test.ts
index b127712927..968237f11d 100644
--- a/packages/backend-test-utils/src/next/wiring/TestBackend.test.ts
+++ b/packages/backend-test-utils/src/next/wiring/TestBackend.test.ts
@@ -33,8 +33,8 @@ beforeAll(async () => {
await startTestBackend({
features: [
createBackendModule({
- moduleId: 'test.module',
pluginId: 'test',
+ moduleId: 'test-module',
register(env) {
env.registerInit({
deps: { lifecycle: coreServices.lifecycle },
@@ -128,8 +128,8 @@ describe('TestBackend', () => {
});
const testModule = createBackendModule({
- moduleId: 'test.module',
pluginId: 'test',
+ moduleId: 'test-module',
register(env) {
env.registerInit({
deps: {
@@ -153,8 +153,8 @@ describe('TestBackend', () => {
const shutdownSpy = jest.fn();
const testModule = createBackendModule({
- moduleId: 'test.module',
pluginId: 'test',
+ moduleId: 'test-module',
register(env) {
env.registerInit({
deps: {
@@ -307,7 +307,7 @@ describe('TestBackend', () => {
],
}),
).rejects.toThrow(
- "Extension point registered for plugin 'testA' may not be used by module for plugin 'testB'",
+ "Illegal dependency: Module 'test' for plugin 'testB' attempted to depend on extension point 'a' for plugin 'testA'. Extension points can only be used within their plugin's scope.",
);
});
diff --git a/packages/backend-test-utils/src/next/wiring/TestBackend.ts b/packages/backend-test-utils/src/next/wiring/TestBackend.ts
index 21ae6159c9..14e8920390 100644
--- a/packages/backend-test-utils/src/next/wiring/TestBackend.ts
+++ b/packages/backend-test-utils/src/next/wiring/TestBackend.ts
@@ -156,7 +156,7 @@ function createExtensionPointTestModules(
modules.push(
createBackendModule({
pluginId,
- moduleId: 'testExtensionPointRegistration',
+ moduleId: 'test-extension-point-registration',
register(reg) {
for (const id of pluginExtensionPointIds) {
const tuple = extensionPointMap.get(id)!;
diff --git a/packages/backend/CHANGELOG.md b/packages/backend/CHANGELOG.md
index 11ddf672a8..4b90e2631e 100644
--- a/packages/backend/CHANGELOG.md
+++ b/packages/backend/CHANGELOG.md
@@ -1,5 +1,523 @@
# example-backend
+## 0.2.92-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.27-next.0
+ - @backstage/plugin-azure-devops-backend@0.5.2-next.0
+ - @backstage/plugin-explore-backend@0.0.20-next.0
+ - @backstage/plugin-auth-backend@0.20.4-next.0
+ - @backstage/backend-common@0.21.0-next.0
+ - @backstage/plugin-kubernetes-backend@0.14.2-next.0
+ - @backstage/plugin-scaffolder-backend-module-confluence-to-markdown@0.2.11-next.0
+ - @backstage/plugin-catalog-backend@1.17.0-next.0
+ - @backstage/plugin-search-backend@1.5.0-next.0
+ - @backstage/plugin-todo-backend@0.3.8-next.0
+ - @backstage/catalog-client@1.6.0-next.0
+ - @backstage/plugin-signals-backend@0.0.1-next.0
+ - @backstage/plugin-signals-node@0.0.1-next.0
+ - @backstage/plugin-scaffolder-backend@1.21.0-next.0
+ - @backstage/plugin-app-backend@0.3.58-next.0
+ - example-app@0.2.92-next.0
+ - @backstage/backend-tasks@0.5.15-next.0
+ - @backstage/plugin-auth-node@0.4.4-next.0
+ - @backstage/plugin-badges-backend@0.3.7-next.0
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.7-next.0
+ - @backstage/plugin-catalog-node@1.6.2-next.0
+ - @backstage/plugin-entity-feedback-backend@0.2.7-next.0
+ - @backstage/plugin-events-backend@0.2.19-next.0
+ - @backstage/plugin-linguist-backend@0.5.7-next.0
+ - @backstage/plugin-permission-node@0.7.21-next.0
+ - @backstage/plugin-playlist-backend@0.3.14-next.0
+ - @backstage/plugin-proxy-backend@0.4.8-next.0
+ - @backstage/plugin-rollbar-backend@0.1.55-next.0
+ - @backstage/plugin-search-backend-module-catalog@0.1.14-next.0
+ - @backstage/plugin-search-backend-module-explore@0.1.14-next.0
+ - @backstage/plugin-search-backend-module-pg@0.5.19-next.0
+ - @backstage/plugin-search-backend-module-techdocs@0.1.14-next.0
+ - @backstage/plugin-tech-insights-backend@0.5.24-next.0
+ - @backstage/plugin-techdocs-backend@1.9.3-next.0
+ - @backstage/plugin-adr-backend@0.4.7-next.0
+ - @backstage/plugin-azure-sites-backend@0.1.20-next.0
+ - @backstage/plugin-code-coverage-backend@0.2.24-next.0
+ - @backstage/plugin-devtools-backend@0.2.7-next.0
+ - @backstage/plugin-jenkins-backend@0.3.4-next.0
+ - @backstage/plugin-kafka-backend@0.3.8-next.0
+ - @backstage/plugin-lighthouse-backend@0.4.2-next.0
+ - @backstage/plugin-nomad-backend@0.1.12-next.0
+ - @backstage/plugin-permission-backend@0.5.33-next.0
+ - @backstage/plugin-search-backend-module-elasticsearch@1.3.13-next.0
+ - @backstage/plugin-search-backend-node@1.2.14-next.0
+ - @backstage/plugin-tech-insights-backend-module-jsonfc@0.1.42-next.0
+ - @backstage/plugin-tech-insights-node@0.4.16-next.0
+ - @backstage/catalog-model@1.4.3
+ - @backstage/config@1.1.1
+ - @backstage/integration@1.8.0
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.7-next.0
+ - @backstage/plugin-events-node@0.2.19-next.0
+ - @backstage/plugin-permission-common@0.7.12
+ - @backstage/plugin-search-common@1.2.10
+
+## 0.2.91
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-auth-backend@0.20.3
+ - @backstage/backend-common@0.20.1
+ - @backstage/plugin-scaffolder-backend@1.20.0
+ - @backstage/catalog-client@1.5.2
+ - @backstage/plugin-scaffolder-backend-module-confluence-to-markdown@0.2.10
+ - @backstage/plugin-events-backend@0.2.18
+ - @backstage/plugin-search-backend-module-techdocs@0.1.13
+ - @backstage/plugin-search-backend-module-catalog@0.1.13
+ - @backstage/plugin-search-backend-module-explore@0.1.13
+ - @backstage/plugin-azure-devops-backend@0.5.1
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.6
+ - @backstage/plugin-tech-insights-backend-module-jsonfc@0.1.41
+ - @backstage/plugin-entity-feedback-backend@0.2.6
+ - @backstage/plugin-code-coverage-backend@0.2.23
+ - @backstage/plugin-azure-sites-backend@0.1.19
+ - @backstage/plugin-tech-insights-node@0.4.15
+ - @backstage/plugin-devtools-backend@0.2.6
+ - @backstage/plugin-linguist-backend@0.5.6
+ - @backstage/plugin-playlist-backend@0.3.13
+ - @backstage/plugin-techdocs-backend@1.9.2
+ - @backstage/plugin-explore-backend@0.0.19
+ - @backstage/plugin-jenkins-backend@0.3.3
+ - @backstage/plugin-badges-backend@0.3.6
+ - @backstage/plugin-search-backend@1.4.9
+ - @backstage/plugin-kafka-backend@0.3.7
+ - @backstage/plugin-nomad-backend@0.1.11
+ - @backstage/plugin-catalog-node@1.6.1
+ - @backstage/plugin-todo-backend@0.3.7
+ - @backstage/plugin-adr-backend@0.4.6
+ - @backstage/plugin-app-backend@0.3.57
+ - @backstage/plugin-permission-backend@0.5.32
+ - @backstage/plugin-permission-common@0.7.12
+ - @backstage/plugin-permission-node@0.7.20
+ - @backstage/plugin-catalog-backend@1.16.1
+ - example-app@0.2.91
+ - @backstage/backend-tasks@0.5.14
+ - @backstage/plugin-auth-node@0.4.3
+ - @backstage/plugin-kubernetes-backend@0.14.1
+ - @backstage/plugin-lighthouse-backend@0.4.1
+ - @backstage/plugin-proxy-backend@0.4.7
+ - @backstage/plugin-rollbar-backend@0.1.54
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.26
+ - @backstage/plugin-search-backend-module-elasticsearch@1.3.12
+ - @backstage/plugin-search-backend-module-pg@0.5.18
+ - @backstage/plugin-search-backend-node@1.2.13
+ - @backstage/plugin-tech-insights-backend@0.5.23
+ - @backstage/catalog-model@1.4.3
+ - @backstage/config@1.1.1
+ - @backstage/integration@1.8.0
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.6
+ - @backstage/plugin-events-node@0.2.18
+ - @backstage/plugin-search-common@1.2.10
+
+## 0.2.91-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - example-app@0.2.91-next.2
+ - @backstage/backend-common@0.20.1-next.2
+ - @backstage/plugin-adr-backend@0.4.6-next.2
+ - @backstage/plugin-app-backend@0.3.57-next.2
+ - @backstage/plugin-auth-backend@0.20.3-next.2
+ - @backstage/plugin-auth-node@0.4.3-next.2
+ - @backstage/plugin-azure-devops-backend@0.5.1-next.2
+ - @backstage/plugin-badges-backend@0.3.6-next.2
+ - @backstage/plugin-catalog-backend@1.16.1-next.2
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.6-next.2
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.6-next.2
+ - @backstage/plugin-catalog-node@1.6.1-next.2
+ - @backstage/plugin-code-coverage-backend@0.2.23-next.2
+ - @backstage/plugin-devtools-backend@0.2.6-next.2
+ - @backstage/plugin-entity-feedback-backend@0.2.6-next.2
+ - @backstage/plugin-events-backend@0.2.18-next.2
+ - @backstage/plugin-events-node@0.2.18-next.2
+ - @backstage/plugin-jenkins-backend@0.3.3-next.2
+ - @backstage/plugin-kafka-backend@0.3.7-next.2
+ - @backstage/plugin-kubernetes-backend@0.14.1-next.2
+ - @backstage/plugin-lighthouse-backend@0.4.1-next.2
+ - @backstage/plugin-linguist-backend@0.5.6-next.2
+ - @backstage/plugin-nomad-backend@0.1.11-next.2
+ - @backstage/plugin-permission-backend@0.5.32-next.2
+ - @backstage/plugin-permission-node@0.7.20-next.2
+ - @backstage/plugin-playlist-backend@0.3.13-next.2
+ - @backstage/plugin-proxy-backend@0.4.7-next.2
+ - @backstage/plugin-scaffolder-backend@1.19.3-next.2
+ - @backstage/plugin-search-backend@1.4.9-next.2
+ - @backstage/plugin-search-backend-module-catalog@0.1.13-next.2
+ - @backstage/plugin-search-backend-module-elasticsearch@1.3.12-next.2
+ - @backstage/plugin-search-backend-module-explore@0.1.13-next.2
+ - @backstage/plugin-search-backend-module-pg@0.5.18-next.2
+ - @backstage/plugin-search-backend-module-techdocs@0.1.13-next.2
+ - @backstage/plugin-search-backend-node@1.2.13-next.2
+ - @backstage/plugin-techdocs-backend@1.9.2-next.2
+ - @backstage/plugin-todo-backend@0.3.7-next.2
+ - @backstage/backend-tasks@0.5.14-next.2
+ - @backstage/plugin-azure-sites-backend@0.1.19-next.2
+ - @backstage/plugin-explore-backend@0.0.19-next.2
+ - @backstage/plugin-rollbar-backend@0.1.54-next.2
+ - @backstage/plugin-scaffolder-backend-module-confluence-to-markdown@0.2.10-next.2
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.26-next.2
+ - @backstage/plugin-tech-insights-backend@0.5.23-next.2
+ - @backstage/plugin-tech-insights-backend-module-jsonfc@0.1.41-next.2
+ - @backstage/plugin-tech-insights-node@0.4.15-next.2
+
+## 0.2.91-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-backend-module-confluence-to-markdown@0.2.10-next.1
+ - example-app@0.2.91-next.1
+ - @backstage/backend-common@0.20.1-next.1
+ - @backstage/integration@1.8.0
+ - @backstage/plugin-app-backend@0.3.57-next.1
+ - @backstage/plugin-devtools-backend@0.2.6-next.1
+ - @backstage/plugin-proxy-backend@0.4.7-next.1
+ - @backstage/config@1.1.1
+ - @backstage/plugin-kubernetes-backend@0.14.1-next.1
+ - @backstage/backend-tasks@0.5.14-next.1
+ - @backstage/plugin-adr-backend@0.4.6-next.1
+ - @backstage/plugin-auth-backend@0.20.3-next.1
+ - @backstage/plugin-auth-node@0.4.3-next.1
+ - @backstage/plugin-azure-devops-backend@0.5.1-next.1
+ - @backstage/plugin-azure-sites-backend@0.1.19-next.1
+ - @backstage/plugin-badges-backend@0.3.6-next.1
+ - @backstage/plugin-catalog-backend@1.16.1-next.1
+ - @backstage/plugin-code-coverage-backend@0.2.23-next.1
+ - @backstage/plugin-entity-feedback-backend@0.2.6-next.1
+ - @backstage/plugin-events-backend@0.2.18-next.1
+ - @backstage/plugin-explore-backend@0.0.19-next.1
+ - @backstage/plugin-jenkins-backend@0.3.3-next.1
+ - @backstage/plugin-kafka-backend@0.3.7-next.1
+ - @backstage/plugin-lighthouse-backend@0.4.1-next.1
+ - @backstage/plugin-linguist-backend@0.5.6-next.1
+ - @backstage/plugin-nomad-backend@0.1.11-next.1
+ - @backstage/plugin-permission-backend@0.5.32-next.1
+ - @backstage/plugin-permission-node@0.7.20-next.1
+ - @backstage/plugin-playlist-backend@0.3.13-next.1
+ - @backstage/plugin-rollbar-backend@0.1.54-next.1
+ - @backstage/plugin-scaffolder-backend@1.19.3-next.1
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.26-next.1
+ - @backstage/plugin-search-backend@1.4.9-next.1
+ - @backstage/plugin-search-backend-module-catalog@0.1.13-next.1
+ - @backstage/plugin-search-backend-module-elasticsearch@1.3.12-next.1
+ - @backstage/plugin-search-backend-module-explore@0.1.13-next.1
+ - @backstage/plugin-search-backend-module-pg@0.5.18-next.1
+ - @backstage/plugin-search-backend-module-techdocs@0.1.13-next.1
+ - @backstage/plugin-search-backend-node@1.2.13-next.1
+ - @backstage/plugin-tech-insights-backend@0.5.23-next.1
+ - @backstage/plugin-tech-insights-backend-module-jsonfc@0.1.41-next.1
+ - @backstage/plugin-tech-insights-node@0.4.15-next.1
+ - @backstage/plugin-techdocs-backend@1.9.2-next.1
+ - @backstage/plugin-todo-backend@0.3.7-next.1
+ - @backstage/catalog-client@1.5.2-next.0
+ - @backstage/catalog-model@1.4.3
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.6-next.1
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.6-next.1
+ - @backstage/plugin-catalog-node@1.6.1-next.1
+ - @backstage/plugin-events-node@0.2.18-next.1
+ - @backstage/plugin-permission-common@0.7.11
+ - @backstage/plugin-search-common@1.2.9
+
+## 0.2.91-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-auth-backend@0.20.3-next.0
+ - @backstage/backend-common@0.20.1-next.0
+ - @backstage/plugin-scaffolder-backend@1.19.3-next.0
+ - @backstage/catalog-client@1.5.2-next.0
+ - @backstage/plugin-search-backend-module-techdocs@0.1.13-next.0
+ - @backstage/plugin-search-backend-module-catalog@0.1.13-next.0
+ - @backstage/plugin-search-backend-module-explore@0.1.13-next.0
+ - @backstage/plugin-azure-devops-backend@0.5.1-next.0
+ - @backstage/plugin-scaffolder-backend-module-confluence-to-markdown@0.2.10-next.0
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.6-next.0
+ - @backstage/plugin-tech-insights-backend-module-jsonfc@0.1.41-next.0
+ - @backstage/plugin-entity-feedback-backend@0.2.6-next.0
+ - @backstage/plugin-code-coverage-backend@0.2.23-next.0
+ - @backstage/plugin-azure-sites-backend@0.1.19-next.0
+ - @backstage/plugin-tech-insights-node@0.4.15-next.0
+ - @backstage/plugin-devtools-backend@0.2.6-next.0
+ - @backstage/plugin-linguist-backend@0.5.6-next.0
+ - @backstage/plugin-playlist-backend@0.3.13-next.0
+ - @backstage/plugin-techdocs-backend@1.9.2-next.0
+ - @backstage/plugin-explore-backend@0.0.19-next.0
+ - @backstage/plugin-jenkins-backend@0.3.3-next.0
+ - @backstage/plugin-badges-backend@0.3.6-next.0
+ - @backstage/plugin-search-backend@1.4.9-next.0
+ - @backstage/plugin-kafka-backend@0.3.7-next.0
+ - @backstage/plugin-nomad-backend@0.1.11-next.0
+ - @backstage/plugin-catalog-node@1.6.1-next.0
+ - @backstage/plugin-todo-backend@0.3.7-next.0
+ - @backstage/plugin-adr-backend@0.4.6-next.0
+ - @backstage/plugin-app-backend@0.3.57-next.0
+ - example-app@0.2.91-next.0
+ - @backstage/backend-tasks@0.5.14-next.0
+ - @backstage/catalog-model@1.4.3
+ - @backstage/config@1.1.1
+ - @backstage/integration@1.8.0
+ - @backstage/plugin-auth-node@0.4.3-next.0
+ - @backstage/plugin-catalog-backend@1.16.1-next.0
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.6-next.0
+ - @backstage/plugin-events-backend@0.2.18-next.0
+ - @backstage/plugin-events-node@0.2.18-next.0
+ - @backstage/plugin-kubernetes-backend@0.14.1-next.0
+ - @backstage/plugin-lighthouse-backend@0.4.1-next.0
+ - @backstage/plugin-permission-backend@0.5.32-next.0
+ - @backstage/plugin-permission-common@0.7.11
+ - @backstage/plugin-permission-node@0.7.20-next.0
+ - @backstage/plugin-proxy-backend@0.4.7-next.0
+ - @backstage/plugin-rollbar-backend@0.1.54-next.0
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.26-next.0
+ - @backstage/plugin-search-backend-module-elasticsearch@1.3.12-next.0
+ - @backstage/plugin-search-backend-module-pg@0.5.18-next.0
+ - @backstage/plugin-search-backend-node@1.2.13-next.0
+ - @backstage/plugin-search-common@1.2.9
+ - @backstage/plugin-tech-insights-backend@0.5.23-next.0
+
+## 0.2.90
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-auth-backend@0.20.1
+ - @backstage/backend-common@0.20.0
+ - @backstage/plugin-catalog-node@1.6.0
+ - @backstage/plugin-techdocs-backend@1.9.1
+ - @backstage/plugin-catalog-backend@1.16.0
+ - @backstage/catalog-client@1.5.0
+ - @backstage/plugin-azure-devops-backend@0.5.0
+ - @backstage/plugin-scaffolder-backend@1.19.2
+ - @backstage/backend-tasks@0.5.13
+ - @backstage/plugin-lighthouse-backend@0.4.0
+ - @backstage/plugin-kubernetes-backend@0.14.0
+ - @backstage/integration@1.8.0
+ - @backstage/plugin-azure-sites-backend@0.1.18
+ - @backstage/plugin-auth-node@0.4.2
+ - @backstage/plugin-permission-backend@0.5.31
+ - @backstage/plugin-permission-common@0.7.11
+ - @backstage/plugin-playlist-backend@0.3.12
+ - @backstage/plugin-permission-node@0.7.19
+ - @backstage/plugin-search-backend@1.4.8
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.5
+ - @backstage/plugin-search-backend-module-elasticsearch@1.3.11
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.5
+ - @backstage/plugin-search-backend-module-techdocs@0.1.12
+ - @backstage/plugin-search-backend-module-catalog@0.1.12
+ - @backstage/plugin-search-backend-module-explore@0.1.12
+ - @backstage/plugin-search-backend-module-pg@0.5.17
+ - @backstage/plugin-events-backend@0.2.17
+ - example-app@0.2.90
+ - @backstage/plugin-adr-backend@0.4.5
+ - @backstage/plugin-app-backend@0.3.56
+ - @backstage/plugin-badges-backend@0.3.5
+ - @backstage/plugin-code-coverage-backend@0.2.22
+ - @backstage/plugin-devtools-backend@0.2.5
+ - @backstage/plugin-entity-feedback-backend@0.2.5
+ - @backstage/plugin-explore-backend@0.0.18
+ - @backstage/plugin-jenkins-backend@0.3.2
+ - @backstage/plugin-kafka-backend@0.3.6
+ - @backstage/plugin-linguist-backend@0.5.5
+ - @backstage/plugin-nomad-backend@0.1.10
+ - @backstage/plugin-proxy-backend@0.4.6
+ - @backstage/plugin-rollbar-backend@0.1.53
+ - @backstage/plugin-scaffolder-backend-module-confluence-to-markdown@0.2.9
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.25
+ - @backstage/plugin-search-backend-node@1.2.12
+ - @backstage/plugin-tech-insights-backend@0.5.22
+ - @backstage/plugin-tech-insights-backend-module-jsonfc@0.1.40
+ - @backstage/plugin-tech-insights-node@0.4.14
+ - @backstage/plugin-todo-backend@0.3.6
+ - @backstage/catalog-model@1.4.3
+ - @backstage/config@1.1.1
+ - @backstage/plugin-events-node@0.2.17
+ - @backstage/plugin-search-common@1.2.9
+
+## 0.2.90-next.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-azure-devops-backend@0.5.0-next.3
+ - @backstage/plugin-scaffolder-backend@1.19.2-next.3
+ - @backstage/backend-common@0.20.0-next.3
+ - example-app@0.2.90-next.4
+ - @backstage/plugin-scaffolder-backend-module-confluence-to-markdown@0.2.9-next.3
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.25-next.3
+ - @backstage/backend-tasks@0.5.13-next.3
+ - @backstage/catalog-client@1.5.0-next.1
+ - @backstage/catalog-model@1.4.3
+ - @backstage/config@1.1.1
+ - @backstage/integration@1.8.0-next.1
+ - @backstage/plugin-adr-backend@0.4.5-next.3
+ - @backstage/plugin-app-backend@0.3.56-next.3
+ - @backstage/plugin-auth-backend@0.20.1-next.3
+ - @backstage/plugin-auth-node@0.4.2-next.3
+ - @backstage/plugin-azure-sites-backend@0.1.18-next.3
+ - @backstage/plugin-badges-backend@0.3.5-next.3
+ - @backstage/plugin-catalog-backend@1.16.0-next.3
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.5-next.3
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.5-next.3
+ - @backstage/plugin-catalog-node@1.6.0-next.3
+ - @backstage/plugin-code-coverage-backend@0.2.22-next.3
+ - @backstage/plugin-devtools-backend@0.2.5-next.3
+ - @backstage/plugin-entity-feedback-backend@0.2.5-next.3
+ - @backstage/plugin-events-backend@0.2.17-next.3
+ - @backstage/plugin-events-node@0.2.17-next.3
+ - @backstage/plugin-explore-backend@0.0.18-next.3
+ - @backstage/plugin-jenkins-backend@0.3.2-next.3
+ - @backstage/plugin-kafka-backend@0.3.6-next.3
+ - @backstage/plugin-kubernetes-backend@0.14.0-next.3
+ - @backstage/plugin-lighthouse-backend@0.4.0-next.3
+ - @backstage/plugin-linguist-backend@0.5.5-next.3
+ - @backstage/plugin-nomad-backend@0.1.10-next.3
+ - @backstage/plugin-permission-backend@0.5.31-next.3
+ - @backstage/plugin-permission-common@0.7.10
+ - @backstage/plugin-permission-node@0.7.19-next.3
+ - @backstage/plugin-playlist-backend@0.3.12-next.3
+ - @backstage/plugin-proxy-backend@0.4.6-next.3
+ - @backstage/plugin-rollbar-backend@0.1.53-next.3
+ - @backstage/plugin-search-backend@1.4.8-next.3
+ - @backstage/plugin-search-backend-module-catalog@0.1.12-next.3
+ - @backstage/plugin-search-backend-module-elasticsearch@1.3.11-next.3
+ - @backstage/plugin-search-backend-module-explore@0.1.12-next.3
+ - @backstage/plugin-search-backend-module-pg@0.5.17-next.3
+ - @backstage/plugin-search-backend-module-techdocs@0.1.12-next.3
+ - @backstage/plugin-search-backend-node@1.2.12-next.3
+ - @backstage/plugin-search-common@1.2.8
+ - @backstage/plugin-tech-insights-backend@0.5.22-next.3
+ - @backstage/plugin-tech-insights-backend-module-jsonfc@0.1.40-next.3
+ - @backstage/plugin-tech-insights-node@0.4.14-next.3
+ - @backstage/plugin-techdocs-backend@1.9.1-next.3
+ - @backstage/plugin-todo-backend@0.3.6-next.3
+
+## 0.2.90-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-node@1.6.0-next.2
+ - @backstage/plugin-catalog-backend@1.16.0-next.2
+ - @backstage/plugin-auth-backend@0.20.1-next.2
+ - @backstage/plugin-lighthouse-backend@0.4.0-next.2
+ - @backstage/backend-common@0.20.0-next.2
+ - @backstage/plugin-auth-node@0.4.2-next.2
+ - @backstage/catalog-client@1.5.0-next.1
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.5-next.2
+ - @backstage/plugin-search-backend-module-elasticsearch@1.3.11-next.2
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.5-next.2
+ - @backstage/plugin-search-backend-module-techdocs@0.1.12-next.2
+ - @backstage/plugin-search-backend-module-catalog@0.1.12-next.2
+ - @backstage/plugin-search-backend-module-explore@0.1.12-next.2
+ - @backstage/plugin-search-backend-module-pg@0.5.17-next.2
+ - @backstage/plugin-events-backend@0.2.17-next.2
+ - example-app@0.2.90-next.3
+ - @backstage/backend-tasks@0.5.13-next.2
+ - @backstage/catalog-model@1.4.3
+ - @backstage/config@1.1.1
+ - @backstage/integration@1.8.0-next.1
+ - @backstage/plugin-adr-backend@0.4.5-next.2
+ - @backstage/plugin-app-backend@0.3.56-next.2
+ - @backstage/plugin-azure-devops-backend@0.5.0-next.2
+ - @backstage/plugin-azure-sites-backend@0.1.18-next.2
+ - @backstage/plugin-badges-backend@0.3.5-next.2
+ - @backstage/plugin-code-coverage-backend@0.2.22-next.2
+ - @backstage/plugin-devtools-backend@0.2.5-next.2
+ - @backstage/plugin-entity-feedback-backend@0.2.5-next.2
+ - @backstage/plugin-events-node@0.2.17-next.2
+ - @backstage/plugin-explore-backend@0.0.18-next.2
+ - @backstage/plugin-jenkins-backend@0.3.2-next.2
+ - @backstage/plugin-kafka-backend@0.3.6-next.2
+ - @backstage/plugin-kubernetes-backend@0.14.0-next.2
+ - @backstage/plugin-linguist-backend@0.5.5-next.2
+ - @backstage/plugin-nomad-backend@0.1.10-next.2
+ - @backstage/plugin-permission-backend@0.5.31-next.2
+ - @backstage/plugin-permission-common@0.7.10
+ - @backstage/plugin-permission-node@0.7.19-next.2
+ - @backstage/plugin-playlist-backend@0.3.12-next.2
+ - @backstage/plugin-proxy-backend@0.4.6-next.2
+ - @backstage/plugin-rollbar-backend@0.1.53-next.2
+ - @backstage/plugin-scaffolder-backend@1.19.2-next.2
+ - @backstage/plugin-scaffolder-backend-module-confluence-to-markdown@0.2.9-next.2
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.25-next.2
+ - @backstage/plugin-search-backend@1.4.8-next.2
+ - @backstage/plugin-search-backend-node@1.2.12-next.2
+ - @backstage/plugin-search-common@1.2.8
+ - @backstage/plugin-tech-insights-backend@0.5.22-next.2
+ - @backstage/plugin-tech-insights-backend-module-jsonfc@0.1.40-next.2
+ - @backstage/plugin-tech-insights-node@0.4.14-next.2
+ - @backstage/plugin-techdocs-backend@1.9.1-next.2
+ - @backstage/plugin-todo-backend@0.3.6-next.2
+
+## 0.2.90-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-auth-backend@0.20.1-next.1
+ - @backstage/plugin-catalog-backend@1.15.1-next.1
+ - @backstage/catalog-client@1.5.0-next.0
+ - @backstage/plugin-azure-devops-backend@0.5.0-next.1
+ - @backstage/plugin-kubernetes-backend@0.14.0-next.1
+ - @backstage/integration@1.8.0-next.1
+ - @backstage/plugin-azure-sites-backend@0.1.18-next.1
+ - @backstage/backend-common@0.20.0-next.1
+ - example-app@0.2.90-next.2
+ - @backstage/backend-tasks@0.5.13-next.1
+ - @backstage/catalog-model@1.4.3
+ - @backstage/config@1.1.1
+ - @backstage/plugin-adr-backend@0.4.5-next.1
+ - @backstage/plugin-app-backend@0.3.56-next.1
+ - @backstage/plugin-auth-node@0.4.2-next.1
+ - @backstage/plugin-badges-backend@0.3.5-next.1
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.5-next.1
+ - @backstage/plugin-catalog-backend-module-unprocessed@0.3.5-next.1
+ - @backstage/plugin-catalog-node@1.5.1-next.1
+ - @backstage/plugin-code-coverage-backend@0.2.22-next.1
+ - @backstage/plugin-devtools-backend@0.2.5-next.1
+ - @backstage/plugin-entity-feedback-backend@0.2.5-next.1
+ - @backstage/plugin-events-backend@0.2.17-next.1
+ - @backstage/plugin-events-node@0.2.17-next.1
+ - @backstage/plugin-explore-backend@0.0.18-next.1
+ - @backstage/plugin-jenkins-backend@0.3.2-next.1
+ - @backstage/plugin-kafka-backend@0.3.6-next.1
+ - @backstage/plugin-lighthouse-backend@0.3.5-next.1
+ - @backstage/plugin-linguist-backend@0.5.5-next.1
+ - @backstage/plugin-nomad-backend@0.1.10-next.1
+ - @backstage/plugin-permission-backend@0.5.31-next.1
+ - @backstage/plugin-permission-common@0.7.10
+ - @backstage/plugin-permission-node@0.7.19-next.1
+ - @backstage/plugin-playlist-backend@0.3.12-next.1
+ - @backstage/plugin-proxy-backend@0.4.6-next.1
+ - @backstage/plugin-rollbar-backend@0.1.53-next.1
+ - @backstage/plugin-scaffolder-backend@1.19.2-next.1
+ - @backstage/plugin-scaffolder-backend-module-confluence-to-markdown@0.2.9-next.1
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.25-next.1
+ - @backstage/plugin-search-backend@1.4.8-next.1
+ - @backstage/plugin-search-backend-module-catalog@0.1.12-next.1
+ - @backstage/plugin-search-backend-module-elasticsearch@1.3.11-next.1
+ - @backstage/plugin-search-backend-module-explore@0.1.12-next.1
+ - @backstage/plugin-search-backend-module-pg@0.5.17-next.1
+ - @backstage/plugin-search-backend-module-techdocs@0.1.12-next.1
+ - @backstage/plugin-search-backend-node@1.2.12-next.1
+ - @backstage/plugin-search-common@1.2.8
+ - @backstage/plugin-tech-insights-backend@0.5.22-next.1
+ - @backstage/plugin-tech-insights-backend-module-jsonfc@0.1.40-next.1
+ - @backstage/plugin-tech-insights-node@0.4.14-next.1
+ - @backstage/plugin-techdocs-backend@1.9.1-next.1
+ - @backstage/plugin-todo-backend@0.3.6-next.1
+
## 0.2.90-next.0
### Patch Changes
diff --git a/packages/backend/package.json b/packages/backend/package.json
index fc964dfdbc..f76a40a8f0 100644
--- a/packages/backend/package.json
+++ b/packages/backend/package.json
@@ -1,6 +1,6 @@
{
"name": "example-backend",
- "version": "0.2.90-next.0",
+ "version": "0.2.92-next.0",
"main": "dist/index.cjs.js",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -38,6 +38,7 @@
"@backstage/plugin-auth-node": "workspace:^",
"@backstage/plugin-azure-devops-backend": "workspace:^",
"@backstage/plugin-azure-sites-backend": "workspace:^",
+ "@backstage/plugin-azure-sites-common": "workspace:^",
"@backstage/plugin-badges-backend": "workspace:^",
"@backstage/plugin-catalog-backend": "workspace:^",
"@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "workspace:^",
@@ -72,6 +73,8 @@
"@backstage/plugin-search-backend-module-techdocs": "workspace:^",
"@backstage/plugin-search-backend-node": "workspace:^",
"@backstage/plugin-search-common": "workspace:^",
+ "@backstage/plugin-signals-backend": "workspace:^",
+ "@backstage/plugin-signals-node": "workspace:^",
"@backstage/plugin-tech-insights-backend": "workspace:^",
"@backstage/plugin-tech-insights-backend-module-jsonfc": "workspace:^",
"@backstage/plugin-tech-insights-node": "workspace:^",
@@ -80,9 +83,9 @@
"@gitbeaker/node": "^35.1.0",
"@octokit/rest": "^19.0.3",
"@opentelemetry/api": "^1.4.1",
- "@opentelemetry/exporter-prometheus": "^0.45.0",
+ "@opentelemetry/exporter-prometheus": "^0.47.0",
"@opentelemetry/sdk-metrics": "^1.13.0",
- "azure-devops-node-api": "^11.0.1",
+ "azure-devops-node-api": "^12.0.0",
"better-sqlite3": "^9.0.0",
"dockerode": "^3.3.1",
"example-app": "link:../app",
diff --git a/packages/backend/src/index.ts b/packages/backend/src/index.ts
index 8df01b050e..323fc27005 100644
--- a/packages/backend/src/index.ts
+++ b/packages/backend/src/index.ts
@@ -26,21 +26,22 @@ import Router from 'express-promise-router';
import {
CacheManager,
createServiceBuilder,
+ DatabaseManager,
getRootLogger,
+ HostDiscovery,
loadBackendConfig,
notFoundHandler,
- DatabaseManager,
- HostDiscovery,
+ ServerTokenManager,
UrlReaders,
useHotMemoize,
- ServerTokenManager,
} from '@backstage/backend-common';
import { TaskScheduler } from '@backstage/backend-tasks';
import { Config } from '@backstage/config';
import healthcheck from './plugins/healthcheck';
-import { metricsInit, metricsHandler } from './metrics';
+import { metricsHandler, metricsInit } from './metrics';
import auth from './plugins/auth';
import azureDevOps from './plugins/azure-devops';
+import azureSites from './plugins/azure-sites';
import catalog from './plugins/catalog';
import codeCoverage from './plugins/codecoverage';
import entityFeedback from './plugins/entityFeedback';
@@ -65,6 +66,7 @@ import lighthouse from './plugins/lighthouse';
import linguist from './plugins/linguist';
import devTools from './plugins/devtools';
import nomad from './plugins/nomad';
+import signals from './plugins/signals';
import { PluginEnvironment } from './types';
import { ServerPermissionClient } from '@backstage/plugin-permission-node';
import { DefaultIdentityClient } from '@backstage/plugin-auth-node';
@@ -72,6 +74,7 @@ import { DefaultEventBroker } from '@backstage/plugin-events-backend';
import { PrometheusExporter } from '@opentelemetry/exporter-prometheus';
import { MeterProvider } from '@opentelemetry/sdk-metrics';
import { metrics } from '@opentelemetry/api';
+import { DefaultSignalService } from '@backstage/plugin-signals-node';
// Expose opentelemetry metrics using a Prometheus exporter on
// http://localhost:9464/metrics . See prometheus.yml in packages/backend for
@@ -98,6 +101,9 @@ function makeCreateEnv(config: Config) {
});
const eventBroker = new DefaultEventBroker(root.child({ type: 'plugin' }));
+ const signalService = DefaultSignalService.create({
+ eventBroker,
+ });
root.info(`Created UrlReader ${reader}`);
@@ -119,6 +125,7 @@ function makeCreateEnv(config: Config) {
permissions,
scheduler,
identity,
+ signalService,
};
};
}
@@ -139,6 +146,7 @@ async function main() {
const createEnv = makeCreateEnv(config);
+ const azureSitesEnv = useHotMemoize(module, () => createEnv('azure-sites'));
const healthcheckEnv = useHotMemoize(module, () => createEnv('healthcheck'));
const catalogEnv = useHotMemoize(module, () => createEnv('catalog'));
const codeCoverageEnv = useHotMemoize(module, () =>
@@ -172,6 +180,7 @@ async function main() {
const linguistEnv = useHotMemoize(module, () => createEnv('linguist'));
const devToolsEnv = useHotMemoize(module, () => createEnv('devtools'));
const nomadEnv = useHotMemoize(module, () => createEnv('nomad'));
+ const signalsEnv = useHotMemoize(module, () => createEnv('signals'));
const apiRouter = Router();
apiRouter.use('/catalog', await catalog(catalogEnv));
@@ -182,6 +191,7 @@ async function main() {
apiRouter.use('/tech-insights', await techInsights(techInsightsEnv));
apiRouter.use('/auth', await auth(authEnv));
apiRouter.use('/azure-devops', await azureDevOps(azureDevOpsEnv));
+ apiRouter.use('/azure-sites', await azureSites(azureSitesEnv));
apiRouter.use('/search', await search(searchEnv));
apiRouter.use('/techdocs', await techdocs(techdocsEnv));
apiRouter.use('/todo', await todo(todoEnv));
@@ -198,6 +208,7 @@ async function main() {
apiRouter.use('/linguist', await linguist(linguistEnv));
apiRouter.use('/devtools', await devTools(devToolsEnv));
apiRouter.use('/nomad', await nomad(nomadEnv));
+ apiRouter.use('/signals', await signals(signalsEnv));
apiRouter.use(notFoundHandler());
await lighthouse(lighthouseEnv);
diff --git a/packages/backend/src/plugins/azure-sites.ts b/packages/backend/src/plugins/azure-sites.ts
new file mode 100644
index 0000000000..54c7746cb2
--- /dev/null
+++ b/packages/backend/src/plugins/azure-sites.ts
@@ -0,0 +1,34 @@
+/*
+ * 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 {
+ createRouter,
+ AzureSitesApi,
+} from '@backstage/plugin-azure-sites-backend';
+import { Router } from 'express';
+import { PluginEnvironment } from '../types';
+import { CatalogClient } from '@backstage/catalog-client';
+
+export default async function createPlugin(
+ env: PluginEnvironment,
+): Promise {
+ const catalogApi = new CatalogClient({ discoveryApi: env.discovery });
+ return await createRouter({
+ logger: env.logger,
+ permissions: env.permissions,
+ azureSitesApi: AzureSitesApi.fromConfig(env.config),
+ catalogApi,
+ });
+}
diff --git a/packages/backend/src/plugins/signals.ts b/packages/backend/src/plugins/signals.ts
new file mode 100644
index 0000000000..477cea1938
--- /dev/null
+++ b/packages/backend/src/plugins/signals.ts
@@ -0,0 +1,28 @@
+/*
+ * 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 { Router } from 'express';
+import { createRouter } from '@backstage/plugin-signals-backend';
+import { PluginEnvironment } from '../types';
+
+export default async function createPlugin(
+ env: PluginEnvironment,
+): Promise {
+ return await createRouter({
+ logger: env.logger,
+ eventBroker: env.eventBroker,
+ identity: env.identity,
+ });
+}
diff --git a/packages/backend/src/types.ts b/packages/backend/src/types.ts
index ab1baf0c95..3dad2f739b 100644
--- a/packages/backend/src/types.ts
+++ b/packages/backend/src/types.ts
@@ -27,6 +27,7 @@ import { PluginTaskScheduler } from '@backstage/backend-tasks';
import { IdentityApi } from '@backstage/plugin-auth-node';
import { PermissionEvaluator } from '@backstage/plugin-permission-common';
import { EventBroker } from '@backstage/plugin-events-node';
+import { DefaultSignalService } from '@backstage/plugin-signals-node';
export type PluginEnvironment = {
logger: Logger;
@@ -40,4 +41,5 @@ export type PluginEnvironment = {
scheduler: PluginTaskScheduler;
identity: IdentityApi;
eventBroker: EventBroker;
+ signalService: DefaultSignalService;
};
diff --git a/packages/catalog-client/CHANGELOG.md b/packages/catalog-client/CHANGELOG.md
index 7a2618f0e0..0d1e91dc99 100644
--- a/packages/catalog-client/CHANGELOG.md
+++ b/packages/catalog-client/CHANGELOG.md
@@ -1,5 +1,69 @@
# @backstage/catalog-client
+## 1.6.0-next.0
+
+### Minor Changes
+
+- 04907c3: Updates the OpenAPI specification title to plugin ID instead of package name.
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/catalog-model@1.4.3
+ - @backstage/errors@1.2.3
+
+## 1.5.2
+
+### Patch Changes
+
+- 883782e: Fix a bug in `getLocationByRef` that led to invalid backend calls
+- Updated dependencies
+ - @backstage/catalog-model@1.4.3
+ - @backstage/errors@1.2.3
+
+## 1.5.2-next.0
+
+### Patch Changes
+
+- 883782e: Fix a bug in `getLocationByRef` that led to invalid backend calls
+- Updated dependencies
+ - @backstage/catalog-model@1.4.3
+ - @backstage/errors@1.2.3
+
+## 1.5.0
+
+### Minor Changes
+
+- 3834067: The internals of `CatalogClient` are now auto-generated using the `backstage-repo-tools schema openapi generate-client` command.
+
+### Patch Changes
+
+- 82fa88b: Fixes a bug where some query parameters were double URL encoded.
+- Updated dependencies
+ - @backstage/catalog-model@1.4.3
+ - @backstage/errors@1.2.3
+
+## 1.5.0-next.1
+
+### Patch Changes
+
+- 82fa88b: Fixes a bug where some query parameters were double URL encoded.
+- Updated dependencies
+ - @backstage/catalog-model@1.4.3
+ - @backstage/errors@1.2.3
+
+## 1.5.0-next.0
+
+### Minor Changes
+
+- 38340678c3: The internals of `CatalogClient` are now auto-generated using the `backstage-repo-tools schema openapi generate-client` command.
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/catalog-model@1.4.3
+ - @backstage/errors@1.2.3
+
## 1.4.6
### Patch Changes
diff --git a/packages/catalog-client/package.json b/packages/catalog-client/package.json
index 02c30ee19b..da9611e8d4 100644
--- a/packages/catalog-client/package.json
+++ b/packages/catalog-client/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/catalog-client",
"description": "An isomorphic client for the catalog backend",
- "version": "1.4.6",
+ "version": "1.6.0-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -35,7 +35,8 @@
"dependencies": {
"@backstage/catalog-model": "workspace:^",
"@backstage/errors": "workspace:^",
- "cross-fetch": "^4.0.0"
+ "cross-fetch": "^4.0.0",
+ "uri-template": "^2.0.0"
},
"devDependencies": {
"@backstage/cli": "workspace:^",
diff --git a/packages/catalog-client/src/CatalogClient.test.ts b/packages/catalog-client/src/CatalogClient.test.ts
index f5c221569d..b8212fde96 100644
--- a/packages/catalog-client/src/CatalogClient.test.ts
+++ b/packages/catalog-client/src/CatalogClient.test.ts
@@ -86,9 +86,12 @@ describe('CatalogClient', () => {
server.use(
rest.get(`${mockBaseUrl}/entities`, (req, res, ctx) => {
- expect(req.url.search).toBe(
- '?filter=a=1,b=2,b=3,%C3%B6=%3D&filter=a=2&filter=c',
- );
+ const queryParams = new URLSearchParams(req.url.search);
+ expect(queryParams.getAll('filter')).toEqual([
+ 'a=1,b=2,b=3,ö==',
+ 'a=2',
+ 'c',
+ ]);
return res(ctx.json([]));
}),
);
@@ -120,7 +123,8 @@ describe('CatalogClient', () => {
server.use(
rest.get(`${mockBaseUrl}/entities`, (req, res, ctx) => {
- expect(req.url.search).toBe('?filter=a=1,b=2,b=3,%C3%B6=%3D,c');
+ const queryParams = new URLSearchParams(req.url.search);
+ expect(queryParams.getAll('filter')).toEqual(['a=1,b=2,b=3,ö==,c']);
return res(ctx.json([]));
}),
);
@@ -140,12 +144,45 @@ describe('CatalogClient', () => {
expect(response.items).toEqual([]);
});
+ it('builds search filters property even those with URL unsafe values', async () => {
+ const mockedEndpoint = jest
+ .fn()
+ .mockImplementation((_req, res, ctx) =>
+ res(ctx.json({ items: [], totalItems: 0 })),
+ );
+
+ server.use(rest.get(`${mockBaseUrl}/entities/by-query`, mockedEndpoint));
+
+ const response = await client.queryEntities(
+ {
+ filter: [
+ {
+ '!@#$%': 't?i=1&a:2',
+ '^&*(){}[]': ['t%^url*encoded2', 'url'],
+ },
+ ],
+ },
+ { token },
+ );
+
+ expect(response).toEqual({ items: [], totalItems: 0 });
+ expect(mockedEndpoint).toHaveBeenCalledTimes(1);
+
+ const queryParams = new URLSearchParams(
+ mockedEndpoint.mock.calls[0][0].url.search,
+ );
+ expect(queryParams.getAll('filter')).toEqual([
+ '!@#$%=t?i=1&a:2,^&*(){}[]=t%^url*encoded2,^&*(){}[]=url',
+ ]);
+ });
+
it('builds entity field selectors properly', async () => {
expect.assertions(2);
server.use(
rest.get(`${mockBaseUrl}/entities`, (req, res, ctx) => {
- expect(req.url.search).toBe('?fields=a.b,%C3%B6');
+ const queryParams = new URLSearchParams(req.url.search);
+ expect(queryParams.getAll('fields')).toEqual(['a.b,ö']);
return res(ctx.json([]));
}),
);
@@ -185,7 +222,7 @@ describe('CatalogClient', () => {
server.use(
rest.get(`${mockBaseUrl}/entities`, (req, res, ctx) => {
- expect(req.url.search).toBe('?offset=1&limit=2&after=%3D');
+ expect(req.url.search).toBe('?limit=2&offset=1&after=%3D');
return res(ctx.json([]));
}),
);
@@ -203,9 +240,11 @@ describe('CatalogClient', () => {
server.use(
rest.get(`${mockBaseUrl}/entities`, (req, res, ctx) => {
- expect(req.url.search).toBe(
- '?order=asc:kind&order=desc:metadata.name',
- );
+ const queryParams = new URLSearchParams(req.url.search);
+ expect(queryParams.getAll('order')).toEqual([
+ 'asc:kind',
+ 'desc:metadata.name',
+ ]);
return res(ctx.json([]));
}),
);
@@ -326,9 +365,46 @@ describe('CatalogClient', () => {
expect(response).toEqual({ items: [], totalItems: 0 });
expect(mockedEndpoint).toHaveBeenCalledTimes(1);
- expect(mockedEndpoint.mock.calls[0][0].url.search).toBe(
- '?filter=a=1,b=2,b=3,%C3%B6=%3D&filter=a=2&filter=c',
+
+ const queryParams = new URLSearchParams(
+ mockedEndpoint.mock.calls[0][0].url.search,
);
+ expect(queryParams.getAll('filter')).toEqual([
+ 'a=1,b=2,b=3,ö==',
+ 'a=2',
+ 'c',
+ ]);
+ });
+
+ it('builds search filters property even those with URL unsafe values', async () => {
+ const mockedEndpoint = jest
+ .fn()
+ .mockImplementation((_req, res, ctx) =>
+ res(ctx.json({ items: [], totalItems: 0 })),
+ );
+
+ server.use(rest.get(`${mockBaseUrl}/entities/by-query`, mockedEndpoint));
+
+ const response = await client.queryEntities(
+ {
+ filter: [
+ {
+ '!@#$%': 't?i=1&a:2',
+ '^&*(){}[]': ['t%^url*encoded2', 'url'],
+ },
+ ],
+ },
+ { token },
+ );
+
+ expect(response).toEqual({ items: [], totalItems: 0 });
+ expect(mockedEndpoint).toHaveBeenCalledTimes(1);
+ const queryParams = new URLSearchParams(
+ mockedEndpoint.mock.calls[0][0].url.search,
+ );
+ expect(queryParams.getAll('filter')).toEqual([
+ '!@#$%=t?i=1&a:2,^&*(){}[]=t%^url*encoded2,^&*(){}[]=url',
+ ]);
});
it('should send query params correctly on initial request', async () => {
@@ -351,9 +427,17 @@ describe('CatalogClient', () => {
{ field: 'metadata.uid', order: 'desc' },
],
});
- expect(mockedEndpoint.mock.calls[0][0].url.search).toBe(
- '?limit=100&orderField=metadata.name,asc&orderField=metadata.uid,desc&fields=a,b&fullTextFilterTerm=query',
+
+ const queryParams = new URLSearchParams(
+ mockedEndpoint.mock.calls[0][0].url.search,
);
+ expect(queryParams.getAll('fields')).toEqual(['a,b']);
+ expect(queryParams.getAll('limit')).toEqual(['100']);
+ expect(queryParams.getAll('fullTextFilterTerm')).toEqual(['query']);
+ expect(queryParams.getAll('orderField')).toEqual([
+ 'metadata.name,asc',
+ 'metadata.uid,desc',
+ ]);
});
it('should ignore initial query params if cursor is passed', async () => {
@@ -375,7 +459,7 @@ describe('CatalogClient', () => {
cursor: 'cursor',
});
expect(mockedEndpoint.mock.calls[0][0].url.search).toBe(
- '?cursor=cursor&limit=100&fields=a,b',
+ '?fields=a,b&limit=100&cursor=cursor',
);
});
diff --git a/packages/catalog-client/src/CatalogClient.ts b/packages/catalog-client/src/CatalogClient.ts
index c388519e05..0d6bd6b926 100644
--- a/packages/catalog-client/src/CatalogClient.ts
+++ b/packages/catalog-client/src/CatalogClient.ts
@@ -22,7 +22,6 @@ import {
stringifyLocationRef,
} from '@backstage/catalog-model';
import { ResponseError } from '@backstage/errors';
-import crossFetch from 'cross-fetch';
import {
CATALOG_FILTER_EXISTS,
AddLocationRequest,
@@ -40,12 +39,11 @@ import {
GetEntitiesByRefsRequest,
GetEntitiesByRefsResponse,
QueryEntitiesRequest,
- QueryEntitiesResponse,
EntityFilterQuery,
+ QueryEntitiesResponse,
} from './types/api';
-import { DiscoveryApi } from './types/discovery';
-import { FetchApi } from './types/fetch';
import { isQueryEntitiesInitialRequest } from './utils';
+import { DefaultApiClient, TypedResponse } from './generated';
/**
* A frontend and backend compatible client for communicating with the Backstage
@@ -54,15 +52,13 @@ import { isQueryEntitiesInitialRequest } from './utils';
* @public
*/
export class CatalogClient implements CatalogApi {
- private readonly discoveryApi: DiscoveryApi;
- private readonly fetchApi: FetchApi;
+ private readonly apiClient: DefaultApiClient;
constructor(options: {
discoveryApi: { getBaseUrl(pluginId: string): Promise };
fetchApi?: { fetch: typeof fetch };
}) {
- this.discoveryApi = options.discoveryApi;
- this.fetchApi = options.fetchApi || { fetch: crossFetch };
+ this.apiClient = new DefaultApiClient(options);
}
/**
@@ -72,13 +68,11 @@ export class CatalogClient implements CatalogApi {
request: GetEntityAncestorsRequest,
options?: CatalogRequestOptions,
): Promise {
- const { kind, namespace, name } = parseEntityRef(request.entityRef);
return await this.requestRequired(
- 'GET',
- `/entities/by-name/${encodeURIComponent(kind)}/${encodeURIComponent(
- namespace,
- )}/${encodeURIComponent(name)}/ancestry`,
- options,
+ await this.apiClient.getEntityAncestryByName(
+ { path: parseEntityRef(request.entityRef) },
+ options,
+ ),
);
}
@@ -90,9 +84,7 @@ export class CatalogClient implements CatalogApi {
options?: CatalogRequestOptions,
): Promise {
return await this.requestOptional(
- 'GET',
- `/locations/${encodeURIComponent(id)}`,
- options,
+ await this.apiClient.getLocation({ path: { id } }, options),
);
}
@@ -111,39 +103,29 @@ export class CatalogClient implements CatalogApi {
limit,
after,
} = request ?? {};
- const params = this.getParams(filter);
-
- if (fields.length) {
- params.push(`fields=${fields.map(encodeURIComponent).join(',')}`);
- }
-
+ const encodedOrder = [];
if (order) {
for (const directive of [order].flat()) {
if (directive) {
- params.push(
- `order=${encodeURIComponent(directive.order)}:${encodeURIComponent(
- directive.field,
- )}`,
- );
+ encodedOrder.push(`${directive.order}:${directive.field}`);
}
}
}
- if (offset !== undefined) {
- params.push(`offset=${offset}`);
- }
- if (limit !== undefined) {
- params.push(`limit=${limit}`);
- }
- if (after !== undefined) {
- params.push(`after=${encodeURIComponent(after)}`);
- }
-
- const query = params.length ? `?${params.join('&')}` : '';
- const entities: Entity[] = await this.requestRequired(
- 'GET',
- `/entities${query}`,
- options,
+ const entities = await this.requestRequired(
+ await this.apiClient.getEntities(
+ {
+ query: {
+ fields,
+ limit,
+ filter: this.getFilterValue(filter),
+ offset,
+ after,
+ order: order ? encodedOrder : undefined,
+ },
+ },
+ options,
+ ),
);
const refCompare = (a: Entity, b: Entity) => {
@@ -178,22 +160,12 @@ export class CatalogClient implements CatalogApi {
request: GetEntitiesByRefsRequest,
options?: CatalogRequestOptions,
): Promise {
- const body: any = { entityRefs: request.entityRefs };
- if (request.fields?.length) {
- body.fields = request.fields;
- }
-
- const baseUrl = await this.discoveryApi.getBaseUrl('catalog');
- const url = `${baseUrl}/entities/by-refs`;
-
- const response = await this.fetchApi.fetch(url, {
- headers: {
- 'Content-Type': 'application/json',
- ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+ const response = await this.apiClient.getEntitiesByRefs(
+ {
+ body: request,
},
- method: 'POST',
- body: JSON.stringify(body),
- });
+ options,
+ );
if (!response.ok) {
throw await ResponseError.fromResponse(response);
@@ -212,8 +184,10 @@ export class CatalogClient implements CatalogApi {
async queryEntities(
request: QueryEntitiesRequest = {},
options?: CatalogRequestOptions,
- ) {
- const params: string[] = [];
+ ): Promise {
+ const params: Partial<
+ Parameters[0]['query']
+ > = {};
if (isQueryEntitiesInitialRequest(request)) {
const {
@@ -223,45 +197,42 @@ export class CatalogClient implements CatalogApi {
orderFields,
fullTextFilter,
} = request;
- params.push(...this.getParams(filter));
+ params.filter = this.getFilterValue(filter);
if (limit !== undefined) {
- params.push(`limit=${limit}`);
+ params.limit = limit;
}
if (orderFields !== undefined) {
- (Array.isArray(orderFields) ? orderFields : [orderFields]).forEach(
- ({ field, order }) => params.push(`orderField=${field},${order}`),
- );
+ params.orderField = (
+ Array.isArray(orderFields) ? orderFields : [orderFields]
+ ).map(({ field, order }) => `${field},${order}`);
}
if (fields.length) {
- params.push(`fields=${fields.map(encodeURIComponent).join(',')}`);
+ params.fields = fields;
}
const normalizedFullTextFilterTerm = fullTextFilter?.term?.trim();
if (normalizedFullTextFilterTerm) {
- params.push(`fullTextFilterTerm=${normalizedFullTextFilterTerm}`);
+ params.fullTextFilterTerm = normalizedFullTextFilterTerm;
}
if (fullTextFilter?.fields?.length) {
- params.push(`fullTextFilterFields=${fullTextFilter.fields.join(',')}`);
+ params.fullTextFilterFields = fullTextFilter.fields;
}
} else {
const { fields = [], limit, cursor } = request;
- params.push(`cursor=${cursor}`);
+ params.cursor = cursor;
if (limit !== undefined) {
- params.push(`limit=${limit}`);
+ params.limit = limit;
}
if (fields.length) {
- params.push(`fields=${fields.map(encodeURIComponent).join(',')}`);
+ params.fields = fields;
}
}
- const query = params.length ? `?${params.join('&')}` : '';
- return this.requestRequired(
- 'GET',
- `/entities/by-query${query}`,
- options,
- );
+ return this.apiClient
+ .getEntitiesByQuery({ query: params }, options)
+ .then(r => r.json());
}
/**
@@ -271,13 +242,13 @@ export class CatalogClient implements CatalogApi {
entityRef: string | CompoundEntityRef,
options?: CatalogRequestOptions,
): Promise {
- const { kind, namespace, name } = parseEntityRef(entityRef);
return this.requestOptional(
- 'GET',
- `/entities/by-name/${encodeURIComponent(kind)}/${encodeURIComponent(
- namespace,
- )}/${encodeURIComponent(name)}`,
- options,
+ await this.apiClient.getEntityByName(
+ {
+ path: parseEntityRef(entityRef),
+ },
+ options,
+ ),
);
}
@@ -294,11 +265,10 @@ export class CatalogClient implements CatalogApi {
): Promise {
const { kind, namespace = 'default', name } = compoundName;
return this.requestOptional(
- 'GET',
- `/entities/by-name/${encodeURIComponent(kind)}/${encodeURIComponent(
- namespace,
- )}/${encodeURIComponent(name)}`,
- options,
+ await this.apiClient.getEntityByName(
+ { path: { kind, namespace, name } },
+ options,
+ ),
);
}
@@ -306,16 +276,9 @@ export class CatalogClient implements CatalogApi {
* {@inheritdoc CatalogApi.refreshEntity}
*/
async refreshEntity(entityRef: string, options?: CatalogRequestOptions) {
- const response = await this.fetchApi.fetch(
- `${await this.discoveryApi.getBaseUrl('catalog')}/refresh`,
- {
- headers: {
- 'Content-Type': 'application/json',
- ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
- },
- method: 'POST',
- body: JSON.stringify({ entityRef }),
- },
+ const response = await this.apiClient.refreshEntity(
+ { body: { entityRef } },
+ options,
);
if (response.status !== 200) {
@@ -331,14 +294,14 @@ export class CatalogClient implements CatalogApi {
options?: CatalogRequestOptions,
): Promise {
const { filter = [], facets } = request;
- const params = this.getParams(filter);
-
- for (const facet of facets) {
- params.push(`facet=${encodeURIComponent(facet)}`);
- }
-
- const query = params.length ? `?${params.join('&')}` : '';
- return await this.requestOptional('GET', `/entity-facets${query}`, options);
+ return await this.requestOptional(
+ await this.apiClient.getEntityFacets(
+ {
+ query: { facet: facets, filter: this.getFilterValue(filter) },
+ },
+ options,
+ ),
+ );
}
/**
@@ -350,18 +313,12 @@ export class CatalogClient implements CatalogApi {
): Promise {
const { type = 'url', target, dryRun } = request;
- const response = await this.fetchApi.fetch(
- `${await this.discoveryApi.getBaseUrl('catalog')}/locations${
- dryRun ? '?dryRun=true' : ''
- }`,
+ const response = await this.apiClient.createLocation(
{
- headers: {
- 'Content-Type': 'application/json',
- ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
- },
- method: 'POST',
- body: JSON.stringify({ type, target }),
+ body: { type, target },
+ query: { dryRun: dryRun ? 'true' : undefined },
},
+ options,
);
if (response.status !== 201) {
@@ -388,10 +345,8 @@ export class CatalogClient implements CatalogApi {
locationRef: string,
options?: CatalogRequestOptions,
): Promise {
- const all: { data: Location }[] = await this.requestRequired(
- 'GET',
- '/locations',
- options,
+ const all = await this.requestRequired(
+ await this.apiClient.getLocations({}, options),
);
return all
.map(r => r.data)
@@ -406,9 +361,7 @@ export class CatalogClient implements CatalogApi {
options?: CatalogRequestOptions,
): Promise {
await this.requestIgnored(
- 'DELETE',
- `/locations/${encodeURIComponent(id)}`,
- options,
+ await this.apiClient.deleteLocation({ path: { id } }, options),
);
}
@@ -420,9 +373,7 @@ export class CatalogClient implements CatalogApi {
options?: CatalogRequestOptions,
): Promise {
await this.requestIgnored(
- 'DELETE',
- `/entities/by-uid/${encodeURIComponent(uid)}`,
- options,
+ await this.apiClient.deleteEntityByUid({ path: { uid } }, options),
);
}
@@ -434,16 +385,9 @@ export class CatalogClient implements CatalogApi {
locationRef: string,
options?: CatalogRequestOptions,
): Promise {
- const response = await this.fetchApi.fetch(
- `${await this.discoveryApi.getBaseUrl('catalog')}/validate-entity`,
- {
- headers: {
- 'Content-Type': 'application/json',
- ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
- },
- method: 'POST',
- body: JSON.stringify({ entity, location: locationRef }),
- },
+ const response = await this.apiClient.validateEntity(
+ { body: { entity, location: locationRef } },
+ options,
);
if (response.ok) {
@@ -456,7 +400,7 @@ export class CatalogClient implements CatalogApi {
throw await ResponseError.fromResponse(response);
}
- const { errors = [] } = await response.json();
+ const { errors = [] } = (await response.json()) as any;
return {
valid: false,
@@ -468,33 +412,13 @@ export class CatalogClient implements CatalogApi {
// Private methods
//
- private async requestIgnored(
- method: string,
- path: string,
- options?: CatalogRequestOptions,
- ): Promise {
- const url = `${await this.discoveryApi.getBaseUrl('catalog')}${path}`;
- const headers: Record = options?.token
- ? { Authorization: `Bearer ${options.token}` }
- : {};
- const response = await this.fetchApi.fetch(url, { method, headers });
-
+ private async requestIgnored(response: Response): Promise {
if (!response.ok) {
throw await ResponseError.fromResponse(response);
}
}
- private async requestRequired(
- method: string,
- path: string,
- options?: CatalogRequestOptions,
- ): Promise {
- const url = `${await this.discoveryApi.getBaseUrl('catalog')}${path}`;
- const headers: Record = options?.token
- ? { Authorization: `Bearer ${options.token}` }
- : {};
- const response = await this.fetchApi.fetch(url, { method, headers });
-
+ private async requestRequired(response: TypedResponse): Promise {
if (!response.ok) {
throw await ResponseError.fromResponse(response);
}
@@ -502,17 +426,7 @@ export class CatalogClient implements CatalogApi {
return response.json();
}
- private async requestOptional(
- method: string,
- path: string,
- options?: CatalogRequestOptions,
- ): Promise {
- const url = `${await this.discoveryApi.getBaseUrl('catalog')}${path}`;
- const headers: Record = options?.token
- ? { Authorization: `Bearer ${options.token}` }
- : {};
- const response = await this.fetchApi.fetch(url, { method, headers });
-
+ private async requestOptional(response: Response): Promise {
if (!response.ok) {
if (response.status === 404) {
return undefined;
@@ -523,8 +437,8 @@ export class CatalogClient implements CatalogApi {
return await response.json();
}
- private getParams(filter: EntityFilterQuery = []) {
- const params: string[] = [];
+ private getFilterValue(filter: EntityFilterQuery = []) {
+ const filters: string[] = [];
// filter param can occur multiple times, for example
// /api/catalog/entities?filter=metadata.name=wayback-search,kind=component&filter=metadata.name=www-artist,kind=component'
// the "outer array" defined by `filter` occurrences corresponds to "anyOf" filters
@@ -534,19 +448,17 @@ export class CatalogClient implements CatalogApi {
for (const [key, value] of Object.entries(filterItem)) {
for (const v of [value].flat()) {
if (v === CATALOG_FILTER_EXISTS) {
- filterParts.push(encodeURIComponent(key));
+ filterParts.push(key);
} else if (typeof v === 'string') {
- filterParts.push(
- `${encodeURIComponent(key)}=${encodeURIComponent(v)}`,
- );
+ filterParts.push(`${key}=${v}`);
}
}
}
if (filterParts.length) {
- params.push(`filter=${filterParts.join(',')}`);
+ filters.push(filterParts.join(','));
}
}
- return params;
+ return filters;
}
}
diff --git a/packages/catalog-client/src/generated/apis/DefaultApi.client.ts b/packages/catalog-client/src/generated/apis/DefaultApi.client.ts
new file mode 100644
index 0000000000..65b8699370
--- /dev/null
+++ b/packages/catalog-client/src/generated/apis/DefaultApi.client.ts
@@ -0,0 +1,540 @@
+/*
+ * 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 { DiscoveryApi } from '../types/discovery';
+import { FetchApi } from '../types/fetch';
+import crossFetch from 'cross-fetch';
+import { pluginId } from '../pluginId';
+import * as parser from 'uri-template';
+
+import { AnalyzeLocationRequest } from '../models/AnalyzeLocationRequest.model';
+import { AnalyzeLocationResponse } from '../models/AnalyzeLocationResponse.model';
+import { CreateLocation201Response } from '../models/CreateLocation201Response.model';
+import { CreateLocationRequest } from '../models/CreateLocationRequest.model';
+import { EntitiesBatchResponse } from '../models/EntitiesBatchResponse.model';
+import { EntitiesQueryResponse } from '../models/EntitiesQueryResponse.model';
+import { Entity } from '../models/Entity.model';
+import { EntityAncestryResponse } from '../models/EntityAncestryResponse.model';
+import { EntityFacetsResponse } from '../models/EntityFacetsResponse.model';
+import { GetEntitiesByRefsRequest } from '../models/GetEntitiesByRefsRequest.model';
+import { GetLocations200ResponseInner } from '../models/GetLocations200ResponseInner.model';
+import { Location } from '../models/Location.model';
+import { RefreshEntityRequest } from '../models/RefreshEntityRequest.model';
+import { ValidateEntityRequest } from '../models/ValidateEntityRequest.model';
+
+/**
+ * Wraps the Response type to convey a type on the json call.
+ *
+ * @public
+ */
+export type TypedResponse = Omit & {
+ json: () => Promise;
+};
+
+/**
+ * Options you can pass into a request for additional information.
+ *
+ * @public
+ */
+export interface RequestOptions {
+ token?: string;
+}
+
+/**
+ * no description
+ */
+export class DefaultApiClient {
+ private readonly discoveryApi: DiscoveryApi;
+ private readonly fetchApi: FetchApi;
+
+ constructor(options: {
+ discoveryApi: { getBaseUrl(pluginId: string): Promise };
+ fetchApi?: { fetch: typeof fetch };
+ }) {
+ this.discoveryApi = options.discoveryApi;
+ this.fetchApi = options.fetchApi || { fetch: crossFetch };
+ }
+
+ /**
+ * Validate a given location.
+ * @param analyzeLocationRequest
+ */
+ public async analyzeLocation(
+ // @ts-ignore
+ request: {
+ body: AnalyzeLocationRequest;
+ },
+ options?: RequestOptions,
+ ): Promise> {
+ const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+ const uriTemplate = `/analyze-location`;
+
+ const uri = parser.parse(uriTemplate).expand({});
+
+ return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+ headers: {
+ 'Content-Type': 'application/json',
+ ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+ },
+ method: 'POST',
+ body: JSON.stringify(request.body),
+ });
+ }
+
+ /**
+ * Create a location for a given target.
+ * @param createLocationRequest
+ * @param dryRun
+ */
+ public async createLocation(
+ // @ts-ignore
+ request: {
+ body: CreateLocationRequest;
+ query: {
+ dryRun?: string;
+ };
+ },
+ options?: RequestOptions,
+ ): Promise> {
+ const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+ const uriTemplate = `/locations{?dryRun}`;
+
+ const uri = parser.parse(uriTemplate).expand({
+ ...request.query,
+ });
+
+ return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+ headers: {
+ 'Content-Type': 'application/json',
+ ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+ },
+ method: 'POST',
+ body: JSON.stringify(request.body),
+ });
+ }
+
+ /**
+ * Delete a single entity by UID.
+ * @param uid
+ */
+ public async deleteEntityByUid(
+ // @ts-ignore
+ request: {
+ path: {
+ uid: string;
+ };
+ },
+ options?: RequestOptions,
+ ): Promise> {
+ const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+ const uriTemplate = `/entities/by-uid/{uid}`;
+
+ const uri = parser.parse(uriTemplate).expand({
+ uid: request.path.uid,
+ });
+
+ return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+ headers: {
+ 'Content-Type': 'application/json',
+ ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+ },
+ method: 'DELETE',
+ });
+ }
+
+ /**
+ * Delete a location by id.
+ * @param id
+ */
+ public async deleteLocation(
+ // @ts-ignore
+ request: {
+ path: {
+ id: string;
+ };
+ },
+ options?: RequestOptions,
+ ): Promise> {
+ const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+ const uriTemplate = `/locations/{id}`;
+
+ const uri = parser.parse(uriTemplate).expand({
+ id: request.path.id,
+ });
+
+ return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+ headers: {
+ 'Content-Type': 'application/json',
+ ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+ },
+ method: 'DELETE',
+ });
+ }
+
+ /**
+ * Get all entities matching a given filter.
+ * @param fields Restrict to just these fields in the response.
+ * @param limit Number of records to return in the response.
+ * @param filter Filter for just the entities defined by this filter.
+ * @param offset Number of records to skip in the query page.
+ * @param after Pointer to the previous page of results.
+ * @param order
+ */
+ public async getEntities(
+ // @ts-ignore
+ request: {
+ query: {
+ fields?: Array;
+ limit?: number;
+ filter?: Array;
+ offset?: number;
+ after?: string;
+ order?: Array;
+ };
+ },
+ options?: RequestOptions,
+ ): Promise>> {
+ const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+ const uriTemplate = `/entities{?fields,limit,filter*,offset,after,order*}`;
+
+ const uri = parser.parse(uriTemplate).expand({
+ ...request.query,
+ });
+
+ return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+ headers: {
+ 'Content-Type': 'application/json',
+ ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+ },
+ method: 'GET',
+ });
+ }
+
+ /**
+ * Search for entities by a given query.
+ * @param fields Restrict to just these fields in the response.
+ * @param limit Number of records to return in the response.
+ * @param orderField The fields to sort returned results by.
+ * @param cursor Cursor to a set page of results.
+ * @param filter Filter for just the entities defined by this filter.
+ * @param fullTextFilterTerm Text search term.
+ * @param fullTextFilterFields A comma separated list of fields to sort returned results by.
+ */
+ public async getEntitiesByQuery(
+ // @ts-ignore
+ request: {
+ query: {
+ fields?: Array;
+ limit?: number;
+ orderField?: Array;
+ cursor?: string;
+ filter?: Array;
+ fullTextFilterTerm?: string;
+ fullTextFilterFields?: Array;
+ };
+ },
+ options?: RequestOptions,
+ ): Promise> {
+ const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+ const uriTemplate = `/entities/by-query{?fields,limit,orderField*,cursor,filter*,fullTextFilterTerm,fullTextFilterFields}`;
+
+ const uri = parser.parse(uriTemplate).expand({
+ ...request.query,
+ });
+
+ return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+ headers: {
+ 'Content-Type': 'application/json',
+ ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+ },
+ method: 'GET',
+ });
+ }
+
+ /**
+ * Get a batch set of entities given an array of entityRefs.
+ * @param getEntitiesByRefsRequest
+ */
+ public async getEntitiesByRefs(
+ // @ts-ignore
+ request: {
+ body: GetEntitiesByRefsRequest;
+ },
+ options?: RequestOptions,
+ ): Promise> {
+ const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+ const uriTemplate = `/entities/by-refs`;
+
+ const uri = parser.parse(uriTemplate).expand({});
+
+ return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+ headers: {
+ 'Content-Type': 'application/json',
+ ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+ },
+ method: 'POST',
+ body: JSON.stringify(request.body),
+ });
+ }
+
+ /**
+ * Get an entity's ancestry by entity ref.
+ * @param kind
+ * @param namespace
+ * @param name
+ */
+ public async getEntityAncestryByName(
+ // @ts-ignore
+ request: {
+ path: {
+ kind: string;
+ namespace: string;
+ name: string;
+ };
+ },
+ options?: RequestOptions,
+ ): Promise> {
+ const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+ const uriTemplate = `/entities/by-name/{kind}/{namespace}/{name}/ancestry`;
+
+ const uri = parser.parse(uriTemplate).expand({
+ kind: request.path.kind,
+ namespace: request.path.namespace,
+ name: request.path.name,
+ });
+
+ return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+ headers: {
+ 'Content-Type': 'application/json',
+ ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+ },
+ method: 'GET',
+ });
+ }
+
+ /**
+ * Get an entity by an entity ref.
+ * @param kind
+ * @param namespace
+ * @param name
+ */
+ public async getEntityByName(
+ // @ts-ignore
+ request: {
+ path: {
+ kind: string;
+ namespace: string;
+ name: string;
+ };
+ },
+ options?: RequestOptions,
+ ): Promise> {
+ const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+ const uriTemplate = `/entities/by-name/{kind}/{namespace}/{name}`;
+
+ const uri = parser.parse(uriTemplate).expand({
+ kind: request.path.kind,
+ namespace: request.path.namespace,
+ name: request.path.name,
+ });
+
+ return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+ headers: {
+ 'Content-Type': 'application/json',
+ ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+ },
+ method: 'GET',
+ });
+ }
+
+ /**
+ * Get a single entity by the UID.
+ * @param uid
+ */
+ public async getEntityByUid(
+ // @ts-ignore
+ request: {
+ path: {
+ uid: string;
+ };
+ },
+ options?: RequestOptions,
+ ): Promise> {
+ const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+ const uriTemplate = `/entities/by-uid/{uid}`;
+
+ const uri = parser.parse(uriTemplate).expand({
+ uid: request.path.uid,
+ });
+
+ return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+ headers: {
+ 'Content-Type': 'application/json',
+ ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+ },
+ method: 'GET',
+ });
+ }
+
+ /**
+ * Get all entity facets that match the given filters.
+ * @param facet
+ * @param filter Filter for just the entities defined by this filter.
+ */
+ public async getEntityFacets(
+ // @ts-ignore
+ request: {
+ query: {
+ facet: Array;
+ filter?: Array;
+ };
+ },
+ options?: RequestOptions,
+ ): Promise> {
+ const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+ const uriTemplate = `/entity-facets{?facet*,filter*}`;
+
+ const uri = parser.parse(uriTemplate).expand({
+ ...request.query,
+ });
+
+ return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+ headers: {
+ 'Content-Type': 'application/json',
+ ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+ },
+ method: 'GET',
+ });
+ }
+
+ /**
+ * Get a location by id.
+ * @param id
+ */
+ public async getLocation(
+ // @ts-ignore
+ request: {
+ path: {
+ id: string;
+ };
+ },
+ options?: RequestOptions,
+ ): Promise> {
+ const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+ const uriTemplate = `/locations/{id}`;
+
+ const uri = parser.parse(uriTemplate).expand({
+ id: request.path.id,
+ });
+
+ return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+ headers: {
+ 'Content-Type': 'application/json',
+ ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+ },
+ method: 'GET',
+ });
+ }
+
+ /**
+ * Get all locations
+ */
+ public async getLocations(
+ // @ts-ignore
+ request: {},
+ options?: RequestOptions,
+ ): Promise>> {
+ const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+ const uriTemplate = `/locations`;
+
+ const uri = parser.parse(uriTemplate).expand({});
+
+ return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+ headers: {
+ 'Content-Type': 'application/json',
+ ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+ },
+ method: 'GET',
+ });
+ }
+
+ /**
+ * Refresh the entity related to entityRef.
+ * @param refreshEntityRequest
+ */
+ public async refreshEntity(
+ // @ts-ignore
+ request: {
+ body: RefreshEntityRequest;
+ },
+ options?: RequestOptions,
+ ): Promise> {
+ const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+ const uriTemplate = `/refresh`;
+
+ const uri = parser.parse(uriTemplate).expand({});
+
+ return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+ headers: {
+ 'Content-Type': 'application/json',
+ ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+ },
+ method: 'POST',
+ body: JSON.stringify(request.body),
+ });
+ }
+
+ /**
+ * Validate that a passed in entity has no errors in schema.
+ * @param validateEntityRequest
+ */
+ public async validateEntity(
+ // @ts-ignore
+ request: {
+ body: ValidateEntityRequest;
+ },
+ options?: RequestOptions,
+ ): Promise> {
+ const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+ const uriTemplate = `/validate-entity`;
+
+ const uri = parser.parse(uriTemplate).expand({});
+
+ return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+ headers: {
+ 'Content-Type': 'application/json',
+ ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+ },
+ method: 'POST',
+ body: JSON.stringify(request.body),
+ });
+ }
+}
diff --git a/plugins/scaffolder/src/legacy/TemplateEditorPage/index.ts b/packages/catalog-client/src/generated/apis/index.ts
similarity index 91%
rename from plugins/scaffolder/src/legacy/TemplateEditorPage/index.ts
rename to packages/catalog-client/src/generated/apis/index.ts
index 7de0d3c679..ad2f72c5b2 100644
--- a/plugins/scaffolder/src/legacy/TemplateEditorPage/index.ts
+++ b/packages/catalog-client/src/generated/apis/index.ts
@@ -13,4 +13,5 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-export { TemplateEditorPage } from './TemplateEditorPage';
+
+export * from './DefaultApi.client';
diff --git a/packages/catalog-client/src/generated/index.ts b/packages/catalog-client/src/generated/index.ts
new file mode 100644
index 0000000000..0cf3e9cc49
--- /dev/null
+++ b/packages/catalog-client/src/generated/index.ts
@@ -0,0 +1,18 @@
+/*
+ * 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 * from './apis';
+export * from './models';
diff --git a/packages/catalog-client/src/generated/models/AnalyzeLocationEntityField.model.ts b/packages/catalog-client/src/generated/models/AnalyzeLocationEntityField.model.ts
new file mode 100644
index 0000000000..a1c1e1f669
--- /dev/null
+++ b/packages/catalog-client/src/generated/models/AnalyzeLocationEntityField.model.ts
@@ -0,0 +1,36 @@
+/*
+ * 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 interface AnalyzeLocationEntityField {
+ /**
+ * A text to show to the user to inform about the choices made. Like, it could say \"Found a CODEOWNERS file that covers this target, so we suggest leaving this field empty; which would currently make it owned by X\" where X is taken from the codeowners file.
+ */
+ description: string;
+ value: string | null;
+ /**
+ * The outcome of the analysis for this particular field
+ */
+ state: AnalyzeLocationEntityFieldStateEnum;
+ /**
+ * e.g. \"spec.owner\"? The frontend needs to know how to \"inject\" the field into the entity again if the user wants to change it
+ */
+ field: string;
+}
+
+export type AnalyzeLocationEntityFieldStateEnum =
+ | 'analysisSuggestedValue'
+ | 'analysisSuggestedNoValue'
+ | 'needsUserInput';
diff --git a/packages/catalog-client/src/generated/models/AnalyzeLocationExistingEntity.model.ts b/packages/catalog-client/src/generated/models/AnalyzeLocationExistingEntity.model.ts
new file mode 100644
index 0000000000..5ede0fb60b
--- /dev/null
+++ b/packages/catalog-client/src/generated/models/AnalyzeLocationExistingEntity.model.ts
@@ -0,0 +1,27 @@
+/*
+ * 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 { Entity } from '../models/Entity.model';
+import { LocationSpec } from '../models/LocationSpec.model';
+
+/**
+ * If the folder pointed to already contained catalog info yaml files, they are read and emitted like this so that the frontend can inform the user that it located them and can make sure to register them as well if they weren't already
+ */
+export interface AnalyzeLocationExistingEntity {
+ entity: Entity;
+ isRegistered: boolean;
+ location: LocationSpec;
+}
diff --git a/packages/catalog-client/src/generated/models/AnalyzeLocationGenerateEntity.model.ts b/packages/catalog-client/src/generated/models/AnalyzeLocationGenerateEntity.model.ts
new file mode 100644
index 0000000000..886aac05d9
--- /dev/null
+++ b/packages/catalog-client/src/generated/models/AnalyzeLocationGenerateEntity.model.ts
@@ -0,0 +1,26 @@
+/*
+ * 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 { AnalyzeLocationEntityField } from '../models/AnalyzeLocationEntityField.model';
+import { RecursivePartialEntity } from '../models/RecursivePartialEntity.model';
+
+/**
+ * This is some form of representation of what the analyzer could deduce. We should probably have a chat about how this can best be conveyed to the frontend. It'll probably contain a (possibly incomplete) entity, plus enough info for the frontend to know what form data to show to the user for overriding/completing the info.
+ */
+export interface AnalyzeLocationGenerateEntity {
+ fields: Array;
+ entity: RecursivePartialEntity;
+}
diff --git a/packages/catalog-client/src/generated/models/AnalyzeLocationRequest.model.ts b/packages/catalog-client/src/generated/models/AnalyzeLocationRequest.model.ts
new file mode 100644
index 0000000000..e8e9542f5a
--- /dev/null
+++ b/packages/catalog-client/src/generated/models/AnalyzeLocationRequest.model.ts
@@ -0,0 +1,22 @@
+/*
+ * 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 { LocationInput } from '../models/LocationInput.model';
+
+export interface AnalyzeLocationRequest {
+ catalogFileName?: string;
+ location: LocationInput;
+}
diff --git a/packages/catalog-client/src/generated/models/AnalyzeLocationResponse.model.ts b/packages/catalog-client/src/generated/models/AnalyzeLocationResponse.model.ts
new file mode 100644
index 0000000000..bf60aa8018
--- /dev/null
+++ b/packages/catalog-client/src/generated/models/AnalyzeLocationResponse.model.ts
@@ -0,0 +1,23 @@
+/*
+ * 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 { AnalyzeLocationExistingEntity } from '../models/AnalyzeLocationExistingEntity.model';
+import { AnalyzeLocationGenerateEntity } from '../models/AnalyzeLocationGenerateEntity.model';
+
+export interface AnalyzeLocationResponse {
+ generateEntities: Array;
+ existingEntityFiles: Array;
+}
diff --git a/packages/catalog-client/src/generated/models/CreateLocation201Response.model.ts b/packages/catalog-client/src/generated/models/CreateLocation201Response.model.ts
new file mode 100644
index 0000000000..d090d80bf2
--- /dev/null
+++ b/packages/catalog-client/src/generated/models/CreateLocation201Response.model.ts
@@ -0,0 +1,24 @@
+/*
+ * 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 { Entity } from '../models/Entity.model';
+import { Location } from '../models/Location.model';
+
+export interface CreateLocation201Response {
+ exists?: boolean;
+ entities: Array;
+ location: Location;
+}
diff --git a/packages/catalog-client/src/generated/models/CreateLocationRequest.model.ts b/packages/catalog-client/src/generated/models/CreateLocationRequest.model.ts
new file mode 100644
index 0000000000..6ef950072e
--- /dev/null
+++ b/packages/catalog-client/src/generated/models/CreateLocationRequest.model.ts
@@ -0,0 +1,20 @@
+/*
+ * 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 interface CreateLocationRequest {
+ target: string;
+ type: string;
+}
diff --git a/packages/catalog-client/src/generated/models/EntitiesBatchResponse.model.ts b/packages/catalog-client/src/generated/models/EntitiesBatchResponse.model.ts
new file mode 100644
index 0000000000..d09b2cc086
--- /dev/null
+++ b/packages/catalog-client/src/generated/models/EntitiesBatchResponse.model.ts
@@ -0,0 +1,24 @@
+/*
+ * 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 { NullableEntity } from '../models/NullableEntity.model';
+
+export interface EntitiesBatchResponse {
+ /**
+ * The list of entities, in the same order as the refs in the request. Entries that are null signify that no entity existed with that ref.
+ */
+ items: Array;
+}
diff --git a/packages/catalog-client/src/generated/models/EntitiesQueryResponse.model.ts b/packages/catalog-client/src/generated/models/EntitiesQueryResponse.model.ts
new file mode 100644
index 0000000000..10d4747caf
--- /dev/null
+++ b/packages/catalog-client/src/generated/models/EntitiesQueryResponse.model.ts
@@ -0,0 +1,27 @@
+/*
+ * 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 { EntitiesQueryResponsePageInfo } from '../models/EntitiesQueryResponsePageInfo.model';
+import { Entity } from '../models/Entity.model';
+
+export interface EntitiesQueryResponse {
+ /**
+ * The list of entities paginated by a specific filter.
+ */
+ items: Array;
+ totalItems: number;
+ pageInfo: EntitiesQueryResponsePageInfo;
+}
diff --git a/packages/catalog-client/src/generated/models/EntitiesQueryResponsePageInfo.model.ts b/packages/catalog-client/src/generated/models/EntitiesQueryResponsePageInfo.model.ts
new file mode 100644
index 0000000000..8a7d5b39bb
--- /dev/null
+++ b/packages/catalog-client/src/generated/models/EntitiesQueryResponsePageInfo.model.ts
@@ -0,0 +1,26 @@
+/*
+ * 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 interface EntitiesQueryResponsePageInfo {
+ /**
+ * The cursor for the next batch of entities.
+ */
+ nextCursor?: string;
+ /**
+ * The cursor for the previous batch of entities.
+ */
+ prevCursor?: string;
+}
diff --git a/packages/catalog-client/src/generated/models/Entity.model.ts b/packages/catalog-client/src/generated/models/Entity.model.ts
new file mode 100644
index 0000000000..59ef9bc741
--- /dev/null
+++ b/packages/catalog-client/src/generated/models/Entity.model.ts
@@ -0,0 +1,41 @@
+/*
+ * 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 { EntityMeta } from '../models/EntityMeta.model';
+import { EntityRelation } from '../models/EntityRelation.model';
+
+/**
+ * The parts of the format that's common to all versions/kinds of entity.
+ */
+export interface Entity {
+ /**
+ * The relations that this entity has with other entities.
+ */
+ relations?: Array;
+ /**
+ * A type representing all allowed JSON object values.
+ */
+ spec?: { [key: string]: any };
+ metadata: EntityMeta;
+ /**
+ * The high level entity type being described.
+ */
+ kind: string;
+ /**
+ * The version of specification format for this particular entity that this is written against.
+ */
+ apiVersion: string;
+}
diff --git a/packages/catalog-client/src/generated/models/EntityAncestryResponse.model.ts b/packages/catalog-client/src/generated/models/EntityAncestryResponse.model.ts
new file mode 100644
index 0000000000..08076fcf36
--- /dev/null
+++ b/packages/catalog-client/src/generated/models/EntityAncestryResponse.model.ts
@@ -0,0 +1,22 @@
+/*
+ * 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 { EntityAncestryResponseItemsInner } from '../models/EntityAncestryResponseItemsInner.model';
+
+export interface EntityAncestryResponse {
+ items: Array;
+ rootEntityRef: string;
+}
diff --git a/packages/catalog-client/src/generated/models/EntityAncestryResponseItemsInner.model.ts b/packages/catalog-client/src/generated/models/EntityAncestryResponseItemsInner.model.ts
new file mode 100644
index 0000000000..7713c21295
--- /dev/null
+++ b/packages/catalog-client/src/generated/models/EntityAncestryResponseItemsInner.model.ts
@@ -0,0 +1,22 @@
+/*
+ * 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 { Entity } from '../models/Entity.model';
+
+export interface EntityAncestryResponseItemsInner {
+ parentEntityRefs: Array;
+ entity: Entity;
+}
diff --git a/plugins/catalog-backend/src/catalog/index.ts b/packages/catalog-client/src/generated/models/EntityFacet.model.ts
similarity index 84%
rename from plugins/catalog-backend/src/catalog/index.ts
rename to packages/catalog-client/src/generated/models/EntityFacet.model.ts
index ba34673bba..3872091d77 100644
--- a/plugins/catalog-backend/src/catalog/index.ts
+++ b/packages/catalog-client/src/generated/models/EntityFacet.model.ts
@@ -1,5 +1,5 @@
/*
- * Copyright 2020 The Backstage Authors
+ * 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.
@@ -14,4 +14,7 @@
* limitations under the License.
*/
-export type { EntitiesSearchFilter, EntityFilter } from './types';
+export interface EntityFacet {
+ value: string;
+ count: number;
+}
diff --git a/packages/catalog-client/src/generated/models/EntityFacetsResponse.model.ts b/packages/catalog-client/src/generated/models/EntityFacetsResponse.model.ts
new file mode 100644
index 0000000000..0ff37e4f2f
--- /dev/null
+++ b/packages/catalog-client/src/generated/models/EntityFacetsResponse.model.ts
@@ -0,0 +1,21 @@
+/*
+ * 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 { EntityFacet } from '../models/EntityFacet.model';
+
+export interface EntityFacetsResponse {
+ facets: { [key: string]: Array };
+}
diff --git a/packages/catalog-client/src/generated/models/EntityLink.model.ts b/packages/catalog-client/src/generated/models/EntityLink.model.ts
new file mode 100644
index 0000000000..f52f9f2df0
--- /dev/null
+++ b/packages/catalog-client/src/generated/models/EntityLink.model.ts
@@ -0,0 +1,37 @@
+/*
+ * 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.
+ */
+
+/**
+ * A link to external information that is related to the entity.
+ */
+export interface EntityLink {
+ /**
+ * An optional value to categorize links into specific groups
+ */
+ type?: string;
+ /**
+ * An optional semantic key that represents a visual icon.
+ */
+ icon?: string;
+ /**
+ * An optional descriptive title for the link.
+ */
+ title?: string;
+ /**
+ * The url to the external site, document, etc.
+ */
+ url: string;
+}
diff --git a/packages/catalog-client/src/generated/models/EntityMeta.model.ts b/packages/catalog-client/src/generated/models/EntityMeta.model.ts
new file mode 100644
index 0000000000..cb0fd28fdc
--- /dev/null
+++ b/packages/catalog-client/src/generated/models/EntityMeta.model.ts
@@ -0,0 +1,64 @@
+/*
+ * 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 { EntityLink } from '../models/EntityLink.model';
+
+/**
+ * Metadata fields common to all versions/kinds of entity.
+ */
+export interface EntityMeta {
+ [key: string]: any;
+ /**
+ * A list of external hyperlinks related to the entity.
+ */
+ links?: Array