Emerging usage : TechDocs, Explore Ecosystem, TechRadar, etc | | [Mosaico](https://www.mosaico.com.br/) | [Wédney Yuri](https://github.com/wedneyyuri),[@tino.milton](https://github.com/miltonjacomini) | A centralized service catalog of our documentation for our service engineers. | -| [Mox Bank](https://www.mox.com/) | [Nick Laqua](https://github.com/nick-laqua-dragon) | "Single pane of glass" developer portal for providing a best-in-class developer experience to our product teams and making Mox the best tech environment in Hongkong 🥰🚀 | +| [Mox Bank](https://www.mox.com/) | [Nick Laqua](https://github.com/nick-laqua-dragon) | "Single pane of glass" developer portal for providing a best-in-class developer experience to our product teams and making Mox the best tech environment in Hongkong 🥰🚀 | | [Keyloop](https://www.keyloop.com/) | [Andre Wanlin](https://github.com/awanlin) | Future-motive Developer Portal to help our teams create technology to make everything about buying and owning a car better. 🚗 | | [Simply Business](https://sbtech.simplybusiness.co.uk/) | [@addersuk](https://github.com/addersuk), [@LightningStairs](https://github.com/LightningStairs), [@punitcse](https://github.com/punitcse), [@moltenice](https://github.com/moltenice) | Central developer portal to access everything a developer needs such as docs, internal service catalog, and the ability to quickly create a new service from a template. Internally developed Backstage plugins allow us to customise the experience to how we work. | | [Overwolf](https://www.overwolf.com) | [@tomwolfgang](https://github.com/tomwolfgang) | Dev portal - software catalog, tech-docs, scaffolding | @@ -93,3 +97,6 @@ | [Invitae](https://www.invitae.com/en) | [@ryan-hanchett](https://github.com/ryan-hanchett), [@gmandler42](https://github.com/gmandler42) | Centralized Developer Experience portal, putting all of our tooling behind a single pane of glass and creating a living service catalog. | | [Fortum](https://www.fortum.com/) | [@brunoamaroalmeida](https://github.com/brunoamaroalmeida), [@dhaval-vithalani](https://github.com/dhaval-vithalani), [@sunilkumarmohanty](https://github.com/sunilkumarmohanty) | A central portal containing information about our applications, services, processes and other software assets to be used by Fortum software engineering community. | | [Procore](https://www.procore.com/jobs/engineering) | [@shayon](https://github.com/Shayon), [@jamesdabbs-procore](https://github.com/jamesdabbs-procore) | Developer portal - centralized software catalog and templates to enable self serve and reduce cognitive load. | +| [Bradesco](https://banco.bradesco/html/classic/sobre/index.shtm) | [@danilosoarescardoso](https://github.com/danilosoarescardoso) | Centralized developer portal with software catalog, software templates, techdocs and some plugins from community and by our own. | +| [SeatGeek](https://seatgeek.com) | [@zhammer](https://github.com/zhammer) | Software catalog and documentation platform | +| [Grupo Boticário](https://www.grupoboticario.com.br/) | [@chicoribas](https://github.com/chicoribas), [@fndiaz](https://github.com/fndiaz), [@digogid](https://github.com/digogid), [@manumbs](https://github.com/manumbs), [@haooliveira84](https://github.com/haooliveira84), [@Rhullyam](https://github.com/Rhullyam) | Centralized developer portal with catalog, documentation, and software templates to build a ready to go application, including pipelines (CI/CD) and cloud services provisioning | \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f054de05ce..e853a68ad3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ Our vision for Backstage is for it to become the trusted standard toolbox (read: UX layer) for the open source infrastructure landscape. Think of it like Kubernetes for developer experience. We realize this is an ambitious goal. We can’t do it alone. -Therefore we want to create strong community of contributors -- all working together to create the kind of delightful experience that our developers deserve. +Therefore we want to create a strong community of contributors -- all working together to create the kind of delightful experience that our developers deserve. Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. ❤️ @@ -100,7 +100,7 @@ Signed-off-by: Jane Smith
Welcome to Backstage!
; +}; +``` + +#### 3. Update router for the root `/` route + +If you don't have a homepage already, most likely you have a redirect setup to use the Catalog homepage as a homepage. + +Inside your `packages/app/src/App.tsx`, look for + +```tsx +const routes = ( +
+ | 
+ |
|---|---|
| Before | +After | +
+
+In the next steps, we will make it interesting and useful!
+
+### Use the default template
+
+There is a default homepage template ([storybook link](https://backstage.io/storybook/?path=/story/plugins-home-templates--default-template)) which we will use to set up our homepage. Checkout the [blog post announcement](https://backstage.io/blog/2022/01/25/backstage-homepage-templates) about the Backstage homepage templates for more information.
+
+
+
+### Composing your homepage
+
+Composing a homepage is no different from creating a regular React Component,
+i.e. the App Integrator is free to include whatever content they like. However,
+there are components developed with the homepage in mind. If you are looking
+for components to use when composing your homepage, you can take a look at the
+[collection of Homepage components](https://backstage.io/storybook?path=/story/plugins-home-components)
+in storybook. If you don't find a component that suits your needs but want to
+contribute, check the
+[Contributing documentation](https://github.com/backstage/backstage/blob/master/plugins/home/README.md#contributing).
+
+> If you want to use one of the available homepage templates you can find the
+> [templates](https://backstage.io/storybook/?path=/story/plugins-home-templates)
+> in the storybook under the "Home" plugin. And if you would like to contribute
+> a template, please see the
+> [Contributing documentation](https://github.com/backstage/backstage/blob/master/plugins/home/README.md#contributing)
+
+```tsx
+import React from 'react';
+import Grid from '@material-ui/core/Grid';
+import { HomePageCompanyLogo } from '@backstage/plugin-home';
+
+export const HomePage = () => {
+ return (
+
{dropdownItems.map((object, key) => (
{
return (
login({ checkExisting: true }));
+ useMountEffect(() => login({ checkExisting: true }));
return showLoginPage ? (
diff --git a/packages/core-plugin-api/CHANGELOG.md b/packages/core-plugin-api/CHANGELOG.md
index 21668577a1..bba39bf2cf 100644
--- a/packages/core-plugin-api/CHANGELOG.md
+++ b/packages/core-plugin-api/CHANGELOG.md
@@ -1,5 +1,23 @@
# @backstage/core-plugin-api
+## 0.7.0
+
+### Minor Changes
+
+- 33cd215b11: **BREAKING**: Removed deprecated `AnyAnalyticsContext` type which is replaced by `AnalyticsContextValue`
+
+## 0.6.1
+
+### Patch Changes
+
+- 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- 2714145cf5: Removes unused react-use dependency.
+- Updated dependencies
+ - @backstage/config@0.1.14
+ - @backstage/types@0.1.2
+ - @backstage/version-bridge@0.1.2
+
## 0.6.0
### Minor Changes
diff --git a/packages/core-plugin-api/api-report.md b/packages/core-plugin-api/api-report.md
index 5ac07e195c..1647d1c2cb 100644
--- a/packages/core-plugin-api/api-report.md
+++ b/packages/core-plugin-api/api-report.md
@@ -76,11 +76,6 @@ export type AnalyticsTracker = {
) => void;
};
-// @public @deprecated
-export type AnyAnalyticsContext = {
- [param in string]: string | boolean | number | undefined;
-};
-
// @public
export type AnyApiFactory = ApiFactory<
unknown,
diff --git a/packages/core-plugin-api/package.json b/packages/core-plugin-api/package.json
index c9f110b432..4e9198557b 100644
--- a/packages/core-plugin-api/package.json
+++ b/packages/core-plugin-api/package.json
@@ -1,13 +1,16 @@
{
"name": "@backstage/core-plugin-api",
"description": "Core API used by Backstage plugins",
- "version": "0.6.0",
+ "version": "0.7.0",
"private": false,
"publishConfig": {
"access": "public",
"main": "dist/index.esm.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "web-library"
+ },
"homepage": "https://backstage.io",
"repository": {
"type": "git",
@@ -21,21 +24,21 @@
"main": "src/index.ts",
"types": "src/index.ts",
"scripts": {
- "build": "backstage-cli build --outputs types,esm",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean",
+ "start": "backstage-cli package start"
},
"dependencies": {
- "@backstage/config": "^0.1.13",
- "@backstage/types": "^0.1.1",
- "@backstage/version-bridge": "^0.1.1",
+ "@backstage/config": "^0.1.15",
+ "@backstage/types": "^0.1.3",
+ "@backstage/version-bridge": "^0.1.2",
"history": "^5.0.0",
"prop-types": "^15.7.2",
"react-router-dom": "6.0.0-beta.0",
- "react-use": "^17.2.4",
"zen-observable": "^0.8.15"
},
"peerDependencies": {
@@ -43,9 +46,9 @@
"react": "^16.13.1 || ^17.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.13.2-next.0",
- "@backstage/core-app-api": "^0.5.2-next.0",
- "@backstage/test-utils": "^0.2.4-next.0",
+ "@backstage/cli": "^0.14.1",
+ "@backstage/core-app-api": "^0.5.4",
+ "@backstage/test-utils": "^0.2.6",
"@testing-library/jest-dom": "^5.10.1",
"@testing-library/react": "^11.2.5",
"@testing-library/react-hooks": "^7.0.2",
diff --git a/packages/core-plugin-api/src/analytics/index.ts b/packages/core-plugin-api/src/analytics/index.ts
index 942df56ef8..651e8e105e 100644
--- a/packages/core-plugin-api/src/analytics/index.ts
+++ b/packages/core-plugin-api/src/analytics/index.ts
@@ -15,9 +15,5 @@
*/
export { AnalyticsContext } from './AnalyticsContext';
-export type {
- AnalyticsContextValue,
- AnyAnalyticsContext,
- CommonAnalyticsContext,
-} from './types';
+export type { AnalyticsContextValue, CommonAnalyticsContext } from './types';
export { useAnalytics } from './useAnalytics';
diff --git a/packages/core-plugin-api/src/analytics/types.ts b/packages/core-plugin-api/src/analytics/types.ts
index 431e453a61..1a60572082 100644
--- a/packages/core-plugin-api/src/analytics/types.ts
+++ b/packages/core-plugin-api/src/analytics/types.ts
@@ -36,16 +36,6 @@ export type CommonAnalyticsContext = {
extension: string;
};
-/**
- * Allows arbitrary scalar values as context attributes too.
- *
- * @public
- * @deprecated Will be removed, use `AnalyticsContextValue` instead
- */
-export type AnyAnalyticsContext = {
- [param in string]: string | boolean | number | undefined;
-};
-
/**
* Analytics context envelope.
*
diff --git a/packages/create-app/CHANGELOG.md b/packages/create-app/CHANGELOG.md
index 886d873740..52dad1bfc9 100644
--- a/packages/create-app/CHANGELOG.md
+++ b/packages/create-app/CHANGELOG.md
@@ -1,5 +1,82 @@
# @backstage/create-app
+## 0.4.21
+
+### Patch Changes
+
+- a686702dbe: Update the template to reflect the renaming of `CatalogResultListItem` to `CatalogSearchResultListItem` from `@backstage/plugin-catalog`.
+
+ To apply this change to an existing app, make the following change to `packages/app/src/components/search/SearchPage.tsx`:
+
+ ```diff
+ -import { CatalogResultListItem } from '@backstage/plugin-catalog';
+ +import { CatalogSearchResultListItem } from '@backstage/plugin-catalog';
+ ```
+
+ ```diff
+ case 'software-catalog':
+ return (
+ -
+ -
+ + ({
+ theme: Themes.LIGHT,
+ toggleTheme: () => {},
+});
+
+const TechdocsThemeProvider: FC = ({ children }) => {
+ const [theme, setTheme] = useState(Themes.LIGHT);
+
+ const toggleTheme = useCallback(() => {
+ setTheme(prevTheme =>
+ prevTheme === Themes.LIGHT ? Themes.DARK : Themes.LIGHT,
+ );
+ }, [setTheme]);
+
+ const value = { theme, toggleTheme };
+
+ const themes = {
+ [Themes.LIGHT]: lightTheme,
+ [Themes.DARK]: darkTheme,
+ };
+
+ return (
+
+ {children}
+
+ );
+};
+
+const useTechDocsTheme = () => useContext(TechDocsThemeContext);
+
+const TechDocsThemeToggle = () => {
+ const classes = useStyles();
+ const { theme, toggleTheme } = useTechDocsTheme();
+
+ const themes = {
+ [Themes.LIGHT]: {
+ icon: DarkIcon,
+ title: 'Dark theme',
+ },
+ [Themes.DARK]: {
+ icon: LightIcon,
+ title: 'Light theme',
+ },
+ };
+
+ const { title, icon: Icon } = themes[theme];
+
+ return (
+
+
+
+
+
+
+ );
+};
+
+const TechDocsPageContent = ({
+ onReady,
+ entityRef,
+}: {
+ entityRef: EntityName;
+ onReady: () => void;
+}) => {
+ const classes = useStyles();
+
+ return (
+
+
+ );
+};
+
const DefaultTechDocsPage = () => {
const techDocsMetadata = {
site_name: 'Live preview environment',
@@ -35,20 +150,20 @@ const DefaultTechDocsPage = () => {
{({ entityRef, onReady }) => (
<>
-
+ techDocsMetadata={techDocsMetadata}
+ >
+
+
+);
diff --git a/packages/techdocs-cli/CHANGELOG.md b/packages/techdocs-cli/CHANGELOG.md
index 98015f766a..bc23499662 100644
--- a/packages/techdocs-cli/CHANGELOG.md
+++ b/packages/techdocs-cli/CHANGELOG.md
@@ -1,5 +1,31 @@
# @techdocs/cli
+## 0.8.15
+
+### Patch Changes
+
+- ed78516480: chore(deps-dev): bump `cypress` from 7.3.0 to 9.5.0
+- 209fd128e6: Updated usage of `github:` location types in docs to use `url:` instead.
+- 61ff215e08: - Adds `cypress` and `cypress-plugin-snapshots` as dependencies for integration and visual regression tests.
+ - Updates README documentation with instructions for how to run tests.
+ - Clarifies output text for prepack script.
+- Updated dependencies
+ - @backstage/backend-common@0.11.0
+ - @backstage/catalog-model@0.11.0
+ - @backstage/techdocs-common@0.11.10
+
+## 0.8.14
+
+### Patch Changes
+
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- Updated dependencies
+ - @backstage/backend-common@0.10.8
+ - @backstage/catalog-model@0.10.0
+ - @backstage/cli-common@0.1.7
+ - @backstage/config@0.1.14
+ - @backstage/techdocs-common@0.11.8
+
## 0.8.13
### Patch Changes
diff --git a/packages/techdocs-cli/README.md b/packages/techdocs-cli/README.md
index 3ac423cb38..ae296d2c26 100644
--- a/packages/techdocs-cli/README.md
+++ b/packages/techdocs-cli/README.md
@@ -17,7 +17,7 @@ bundle into the `packages/techdocs-cli/dist` which is then published with the
```sh
# From the root of this repository run
# NOTE: This will build the techdocs-cli-embedded-app and copy the output into the cli dist directory
-yarn build --scope @techdocs/cli
+yarn workspace @techdocs/cli build
# Now execute the binary
packages/techdocs-cli/bin/techdocs-cli
@@ -40,8 +40,25 @@ yarn start
yarn techdocs-cli:dev [...options]
```
+### Using an example docs project
+
+For the purpose of local development, we have created an example documentation project. You are of course also free to create your own local test site - all it takes is a `docs/index.md` and an `mkdocs.yml` in a directory.
+
+```sh
+
+cd packages/techdocs-cli/src/example-docs
+
+# To get a view of your docs in Backstage, use:
+techdocs-cli serve
+
+# To view the raw mkdocs site (without Backstage), use:
+techdocs-cli serve:mkdocs
+```
+
### Testing
+#### E2E tests
+
Running unit tests requires mkdocs to be installed locally:
```sh
@@ -51,18 +68,37 @@ pip install mkdocs-techdocs-core
Then run `yarn test`.
-### Use an example docs project
+#### Cypress (Integration and Visual regression) tests
-We have created an [example documentation project](https://github.com/backstage/techdocs-container/tree/main/mock-docs) and it's shipped with [techdocs-container](https://github.com/backstage/techdocs-container) repository, for the purpose of local development. But you are free to create your own local test site. All it takes is a `docs/index.md` and `mkdocs.yml` in a directory.
+Running cypress tests requires you to run the CLI locally against our example docs.
+
+Run the local version of techdocs-cli against the example docs:
```sh
-git clone https://github.com/backstage/techdocs-container.git
+# From the root of this repository run
+# NOTE: This will build the techdocs-cli-embedded-app and copy the output into the cli dist directory
+yarn build --scope @techdocs/cli
-cd techdocs-container/mock-docs
+# Navigate to the example project
+cd packages/techdocs-cli/src/example-docs
-# To get a view of your docs in Backstage, use:
-techdocs-cli serve
-
-# To view the raw mkdocs site (without Backstage), use:
-techdocs-cli serve:mkdocs
+# Now execute the techdocs-cli serve command
+../../bin/techdocs-cli serve
```
+
+In another shell, run the cypress tests:
+
+```sh
+# From the root of the project, navigate to the techdocs-cli package
+cd packages/techdocs-cli
+
+# Run tests
+yarn test:cypress
+```
+
+This will launch a cypress app where you can run the two different tests:
+
+- `backstage_serve` - will run against the backstage server
+- `mkdocs_serve` - will run test against the mkdocs server
+
+> If its the first time you run Cypress, it will run a "Verifying Cypress can run" step. This step can result in a "Cypress verification timed out" error. If that is the case, let the verification step run and then run the command again and it should succeed.
diff --git a/packages/techdocs-cli/cypress.json b/packages/techdocs-cli/cypress.json
new file mode 100644
index 0000000000..b6f3b96019
--- /dev/null
+++ b/packages/techdocs-cli/cypress.json
@@ -0,0 +1,17 @@
+{
+ "env": {
+ "mkDocsBaseUrl": "http://localhost:8000",
+ "backstageBaseUrl": "http://localhost:3000",
+ "cypress-plugin-snapshots": {
+ "autoCleanUp": false,
+ "imageConfig": {
+ "resizeDevicePixelRatio": true,
+ "threshold": 0.01
+ }
+ }
+ },
+ "viewportWidth": 1920,
+ "viewportHeight": 1080,
+ "includeShadowDom": true,
+ "ignoreTestFiles": ["**/__snapshots__/*", "**/__image_snapshots__/*"]
+}
diff --git a/packages/techdocs-cli/cypress/.eslintrc.json b/packages/techdocs-cli/cypress/.eslintrc.json
new file mode 100644
index 0000000000..2481ac5715
--- /dev/null
+++ b/packages/techdocs-cli/cypress/.eslintrc.json
@@ -0,0 +1,21 @@
+{
+ "plugins": ["cypress"],
+ "extends": ["plugin:cypress/recommended"],
+ "rules": {
+ "jest/expect-expect": [
+ "error",
+ {
+ "assertFunctionNames": ["expect", "cy.contains", "cy.document"]
+ }
+ ],
+ "import/no-extraneous-dependencies": [
+ "error",
+ {
+ "devDependencies": true,
+ "optionalDependencies": true,
+ "peerDependencies": true,
+ "bundledDependencies": true
+ }
+ ]
+ }
+}
diff --git a/packages/techdocs-cli/cypress/fixtures/example.json b/packages/techdocs-cli/cypress/fixtures/example.json
new file mode 100644
index 0000000000..02e4254378
--- /dev/null
+++ b/packages/techdocs-cli/cypress/fixtures/example.json
@@ -0,0 +1,5 @@
+{
+ "name": "Using fixtures to represent data",
+ "email": "hello@cypress.io",
+ "body": "Fixtures are a great way to mock data for responses to routes"
+}
diff --git a/packages/techdocs-cli/cypress/integration/__image_snapshots__/TechDocs Live Preview - Backstage Serve toMatchImageSnapshot - Backstage TechDocs Page #0.png b/packages/techdocs-cli/cypress/integration/__image_snapshots__/TechDocs Live Preview - Backstage Serve toMatchImageSnapshot - Backstage TechDocs Page #0.png
new file mode 100644
index 0000000000..99fc1ea483
Binary files /dev/null and b/packages/techdocs-cli/cypress/integration/__image_snapshots__/TechDocs Live Preview - Backstage Serve toMatchImageSnapshot - Backstage TechDocs Page #0.png differ
diff --git a/packages/techdocs-cli/cypress/integration/__image_snapshots__/TechDocs Live Preview - MkDocs Serve toMatchImageSnapshot - MkDocs Page #0.png b/packages/techdocs-cli/cypress/integration/__image_snapshots__/TechDocs Live Preview - MkDocs Serve toMatchImageSnapshot - MkDocs Page #0.png
new file mode 100644
index 0000000000..e6c63d5d57
Binary files /dev/null and b/packages/techdocs-cli/cypress/integration/__image_snapshots__/TechDocs Live Preview - MkDocs Serve toMatchImageSnapshot - MkDocs Page #0.png differ
diff --git a/packages/techdocs-cli/cypress/integration/backstage_serve.js b/packages/techdocs-cli/cypress/integration/backstage_serve.js
new file mode 100644
index 0000000000..15fc03f8f4
--- /dev/null
+++ b/packages/techdocs-cli/cypress/integration/backstage_serve.js
@@ -0,0 +1,58 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/// ',
- 'The repository hosting documentation source files e.g. github:https://ghe.mycompany.net.com/org/repo.' +
+ 'The repository hosting documentation source files e.g. url:https://ghe.mycompany.net.com/org/repo.' +
'\nThis value is same as the backstage.io/techdocs-ref annotation of the corresponding Backstage entity.' +
'\nIt is completely fine to skip this as it is only being used to set repo_url in mkdocs.yml if not found.\n',
)
diff --git a/packages/techdocs-cli/src/e2e.test.ts b/packages/techdocs-cli/src/e2e.test.ts
index 088dbc44b8..7cdd867d0f 100644
--- a/packages/techdocs-cli/src/e2e.test.ts
+++ b/packages/techdocs-cli/src/e2e.test.ts
@@ -58,7 +58,7 @@ const timeout = 25000;
jest.setTimeout(timeout * 2);
describe('end-to-end', () => {
- const cwd = path.resolve(__dirname, 'fixture');
+ const cwd = path.resolve(__dirname, 'example-docs');
afterEach(async () => {
// On Windows the pid of a spawned process may be wrong
diff --git a/packages/techdocs-cli/src/example-docs/.gitignore b/packages/techdocs-cli/src/example-docs/.gitignore
new file mode 100644
index 0000000000..45ddf0ae39
--- /dev/null
+++ b/packages/techdocs-cli/src/example-docs/.gitignore
@@ -0,0 +1 @@
+site/
diff --git a/packages/techdocs-cli/src/example-docs/docs/index.md b/packages/techdocs-cli/src/example-docs/docs/index.md
new file mode 100644
index 0000000000..074d3ccb3e
--- /dev/null
+++ b/packages/techdocs-cli/src/example-docs/docs/index.md
@@ -0,0 +1,92 @@
+## hello mock docs
+
+!!! test
+Testing something
+
+Abbreviations:
+Some text about MOCDOC
+
+This is a paragraph.
+{: #test_id .test_class }
+
+Apple
+: A fruit.
+
+```javascript
+import { test } from 'something';
+
+const addThingToThing = (a, b) a + b;
+```
+
+- [abc](#abc)
+- [xyz](#xyz)
+
+## abc
+
+This is a b c.
+
+## xyz
+
+This is x y z.
+
+# Emojis
+
+:bulb: :smile:
+
+# Code blocks
+
+```javascript
+import { test } from 'something';
+
+const addThingToThing = (a, b) a + b;
+```
+
+# Grouped Code blocks
+
+=== "JavaScript"
+
+ ```javascript
+ import { test } from 'something';
+
+ const addThingToThing = (a, b) a + b;
+ ```
+
+=== "Java"
+
+ ```java
+ public void function() {
+ test();
+ }
+ ```
+
+```java tab="java"
+ public void function() {
+ test();
+ }
+```
+
+```java tab="java 2"
+ public void function() {
+ test();
+ }
+```
+
+# MDX truly sane lists
+
+- attributes
+
+- customer
+ - first_name
+ - test
+ - family_name
+ - email
+- person
+ - first_name
+ - family_name
+ - birth_date
+- subscription_id
+
+- request
+
+
+*[MOCDOC]: Mock Documentation
diff --git a/packages/techdocs-cli/src/fixture/mkdocs.yml b/packages/techdocs-cli/src/example-docs/mkdocs.yml
similarity index 50%
rename from packages/techdocs-cli/src/fixture/mkdocs.yml
rename to packages/techdocs-cli/src/example-docs/mkdocs.yml
index 5d5c2a02ae..9c9406f6e6 100644
--- a/packages/techdocs-cli/src/fixture/mkdocs.yml
+++ b/packages/techdocs-cli/src/example-docs/mkdocs.yml
@@ -2,7 +2,9 @@ site_name: docs-test-fixture
site_description: Documentation site test fixture
nav:
- - HOME: README.md
+ - Home: index.md
+ - SubDocs: '!include ./sub-docs/mkdocs.yml'
+ - Plugins: '*include ./plugins/*/mkdocs.yml'
plugins:
- techdocs-core
diff --git a/packages/techdocs-cli/src/example-docs/plugins/plugin-a/docs/index.md b/packages/techdocs-cli/src/example-docs/plugins/plugin-a/docs/index.md
new file mode 100644
index 0000000000..bd8bc3a4ea
--- /dev/null
+++ b/packages/techdocs-cli/src/example-docs/plugins/plugin-a/docs/index.md
@@ -0,0 +1,4 @@
+# Plugin A
+
+This is a description of Plugin A. This file exists to prove that glob'd
+includes using the `*include` syntax work as expected.
diff --git a/packages/techdocs-cli/src/example-docs/plugins/plugin-a/mkdocs.yml b/packages/techdocs-cli/src/example-docs/plugins/plugin-a/mkdocs.yml
new file mode 100644
index 0000000000..66407d5391
--- /dev/null
+++ b/packages/techdocs-cli/src/example-docs/plugins/plugin-a/mkdocs.yml
@@ -0,0 +1,5 @@
+site_name: Plugin A
+site_description: A description of Plugin A
+
+nav:
+ - Introduction: index.md
diff --git a/packages/techdocs-cli/src/example-docs/plugins/plugin-b/docs/index.md b/packages/techdocs-cli/src/example-docs/plugins/plugin-b/docs/index.md
new file mode 100644
index 0000000000..93e545252f
--- /dev/null
+++ b/packages/techdocs-cli/src/example-docs/plugins/plugin-b/docs/index.md
@@ -0,0 +1,4 @@
+# Plugin B
+
+This is a description of Plugin B. This file exists to prove that glob'd
+includes using the `*include` syntax work as expected.
diff --git a/packages/techdocs-cli/src/example-docs/plugins/plugin-b/mkdocs.yml b/packages/techdocs-cli/src/example-docs/plugins/plugin-b/mkdocs.yml
new file mode 100644
index 0000000000..81580c33af
--- /dev/null
+++ b/packages/techdocs-cli/src/example-docs/plugins/plugin-b/mkdocs.yml
@@ -0,0 +1,5 @@
+site_name: Plugin B
+site_description: A description of Plugin B
+
+nav:
+ - Introduction: index.md
diff --git a/packages/techdocs-cli/src/example-docs/sub-docs/docs/index.md b/packages/techdocs-cli/src/example-docs/sub-docs/docs/index.md
new file mode 100644
index 0000000000..65c6644ef8
--- /dev/null
+++ b/packages/techdocs-cli/src/example-docs/sub-docs/docs/index.md
@@ -0,0 +1 @@
+### This is an md file in another docs folder using the [MkDocs Monorepo Plugin](https://github.com/spotify/mkdocs-monorepo-plugin)
diff --git a/packages/techdocs-cli/src/example-docs/sub-docs/mkdocs.yml b/packages/techdocs-cli/src/example-docs/sub-docs/mkdocs.yml
new file mode 100644
index 0000000000..4490ddbefa
--- /dev/null
+++ b/packages/techdocs-cli/src/example-docs/sub-docs/mkdocs.yml
@@ -0,0 +1,4 @@
+site_name: subdocs
+
+nav:
+ - Home 2: 'index.md'
diff --git a/packages/techdocs-cli/src/fixture/docs/README.md b/packages/techdocs-cli/src/fixture/docs/README.md
deleted file mode 100644
index c32f73f6f4..0000000000
--- a/packages/techdocs-cli/src/fixture/docs/README.md
+++ /dev/null
@@ -1 +0,0 @@
-# Test Fixture
diff --git a/packages/techdocs-common/CHANGELOG.md b/packages/techdocs-common/CHANGELOG.md
index 44fbec4171..c99295e8db 100644
--- a/packages/techdocs-common/CHANGELOG.md
+++ b/packages/techdocs-common/CHANGELOG.md
@@ -1,5 +1,44 @@
# @backstage/techdocs-common
+## 0.11.10
+
+### Patch Changes
+
+- 209fd128e6: Updated usage of `github:` location types in docs to use `url:` instead.
+- 13ef228d03: Clean up the API interface for TechDocs common library.
+- Updated dependencies
+ - @backstage/backend-common@0.11.0
+ - @backstage/catalog-model@0.11.0
+ - @backstage/integration@0.7.5
+
+## 0.11.9
+
+### Patch Changes
+
+- Fix for the previous release with missing type declarations.
+- Updated dependencies
+ - @backstage/backend-common@0.10.9
+ - @backstage/catalog-model@0.10.1
+ - @backstage/config@0.1.15
+ - @backstage/errors@0.2.2
+ - @backstage/integration@0.7.4
+ - @backstage/search-common@0.2.4
+
+## 0.11.8
+
+### Patch Changes
+
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- 216725b434: Updated to use new names for `parseLocationRef` and `stringifyLocationRef`
+- 7aeb491394: Replace use of deprecated `ENTITY_DEFAULT_NAMESPACE` constant with `DEFAULT_NAMESPACE`.
+- Updated dependencies
+ - @backstage/backend-common@0.10.8
+ - @backstage/errors@0.2.1
+ - @backstage/integration@0.7.3
+ - @backstage/catalog-model@0.10.0
+ - @backstage/config@0.1.14
+ - @backstage/search-common@0.2.3
+
## 0.11.7
### Patch Changes
diff --git a/packages/techdocs-common/README.md b/packages/techdocs-common/README.md
index e4889d6f79..bbaac85e9b 100644
--- a/packages/techdocs-common/README.md
+++ b/packages/techdocs-common/README.md
@@ -39,7 +39,7 @@ Currently the build process is split up in these three stages.
- Generators
- Publishers
-Preparers read your entity data and creates a working directory with your documentation source code. For example if you have set your `backstage.io/techdocs-ref` to `github:https://github.com/backstage/backstage.git` it will clone that repository to a temp folder and pass that on to the generator.
+Preparers read your entity data and creates a working directory with your documentation source code. For example if you have set your `backstage.io/techdocs-ref` to `url:https://github.com/backstage/backstage.git` it will clone that repository to a temp folder and pass that on to the generator.
Generators takes the prepared source and runs the `techdocs-container` on it. It then passes on the output folder of that build to the publisher.
diff --git a/packages/techdocs-common/api-report.md b/packages/techdocs-common/api-report.md
index 281accca30..7c4fc95abb 100644
--- a/packages/techdocs-common/api-report.md
+++ b/packages/techdocs-common/api-report.md
@@ -17,38 +17,37 @@ import { ScmIntegrationRegistry } from '@backstage/integration';
import { UrlReader } from '@backstage/backend-common';
import { Writable } from 'stream';
-// Warning: (ae-missing-release-tag) "DirectoryPreparer" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export class DirectoryPreparer implements PreparerBase {
- constructor(config: Config, _logger: Logger_2, reader: UrlReader);
- // Warning: (ae-forgotten-export) The symbol "PreparerResponse" needs to be exported by the entry point index.d.ts
- //
- // (undocumented)
- prepare(
- entity: Entity,
- options?: {
- logger?: Logger_2;
- etag?: string;
- },
- ): Promise;
+ // @deprecated
+ constructor(config: Config, _logger: Logger_2 | null, reader: UrlReader);
+ static fromConfig(
+ config: Config,
+ { logger, reader }: PreparerConfig,
+ ): DirectoryPreparer;
+ prepare(entity: Entity, options?: PreparerOptions): Promise;
}
-// Warning: (ae-missing-release-tag) "GeneratorBase" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
+export type ETag = string;
+
+// @public
export type GeneratorBase = {
run(opts: GeneratorRunOptions): Promise;
};
-// Warning: (ae-missing-release-tag) "GeneratorBuilder" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public
export type GeneratorBuilder = {
register(protocol: SupportedGeneratorKey, generator: GeneratorBase): void;
get(entity: Entity): GeneratorBase;
};
+// @public
+export type GeneratorOptions = {
+ containerRunner: ContainerRunner;
+ logger: Logger_2;
+};
+
// @public
export type GeneratorRunOptions = {
inputDir: string;
@@ -59,11 +58,8 @@ export type GeneratorRunOptions = {
logStream?: Writable;
};
-// Warning: (ae-missing-release-tag) "Generators" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export class Generators implements GeneratorBuilder {
- // (undocumented)
static fromConfig(
config: Config,
options: {
@@ -71,15 +67,11 @@ export class Generators implements GeneratorBuilder {
containerRunner: ContainerRunner;
},
): Promise;
- // (undocumented)
get(entity: Entity): GeneratorBase;
- // (undocumented)
register(generatorKey: SupportedGeneratorKey, generator: GeneratorBase): void;
}
-// Warning: (ae-missing-release-tag) "getDocFilesFromRepository" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export const getDocFilesFromRepository: (
reader: UrlReader,
entity: Entity,
@@ -91,78 +83,74 @@ export const getDocFilesFromRepository: (
| undefined,
) => Promise;
-// Warning: (ae-missing-release-tag) "getLocationForEntity" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export const getLocationForEntity: (
entity: Entity,
scmIntegration: ScmIntegrationRegistry,
) => ParsedLocationAnnotation;
-// Warning: (ae-missing-release-tag) "ParsedLocationAnnotation" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
+export type MigrateRequest = {
+ removeOriginal?: boolean;
+ concurrency?: number;
+};
+
+// @public
export type ParsedLocationAnnotation = {
type: RemoteProtocol;
target: string;
};
-// Warning: (ae-missing-release-tag) "parseReferenceAnnotation" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export const parseReferenceAnnotation: (
annotationName: string,
entity: Entity,
) => ParsedLocationAnnotation;
-// Warning: (ae-missing-release-tag) "PreparerBase" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export type PreparerBase = {
- prepare(
- entity: Entity,
- options?: {
- logger?: Logger_2;
- etag?: string;
- },
- ): Promise;
+ prepare(entity: Entity, options?: PreparerOptions): Promise;
};
-// Warning: (ae-missing-release-tag) "PreparerBuilder" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export type PreparerBuilder = {
register(protocol: RemoteProtocol, preparer: PreparerBase): void;
get(entity: Entity): PreparerBase;
};
-// Warning: (ae-missing-release-tag) "Preparers" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
+export type PreparerConfig = {
+ logger: Logger_2;
+ reader: UrlReader;
+};
+
+// @public
+export type PreparerOptions = {
+ logger?: Logger_2;
+ etag?: ETag;
+};
+
+// @public
+export type PreparerResponse = {
+ preparedDir: string;
+ etag: ETag;
+};
+
+// @public
export class Preparers implements PreparerBuilder {
- // Warning: (ae-forgotten-export) The symbol "factoryOptions" needs to be exported by the entry point index.d.ts
- //
- // (undocumented)
static fromConfig(
- config: Config,
- { logger, reader }: factoryOptions,
+ backstageConfig: Config,
+ { logger, reader }: PreparerConfig,
): Promise;
- // (undocumented)
get(entity: Entity): PreparerBase;
- // (undocumented)
register(protocol: RemoteProtocol, preparer: PreparerBase): void;
}
-// Warning: (ae-missing-release-tag) "Publisher" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public
export class Publisher {
- // Warning: (ae-forgotten-export) The symbol "factoryOptions" needs to be exported by the entry point index.d.ts
- //
- // (undocumented)
static fromConfig(
config: Config,
- { logger, discovery }: factoryOptions_2,
+ { logger, discovery }: PublisherFactory,
): Promise;
}
@@ -172,15 +160,16 @@ export interface PublisherBase {
fetchTechDocsMetadata(entityName: EntityName): Promise;
getReadiness(): Promise;
hasDocsBeenGenerated(entityName: Entity): Promise;
- // Warning: (ae-forgotten-export) The symbol "MigrateRequest" needs to be exported by the entry point index.d.ts
migrateDocsCase?(migrateRequest: MigrateRequest): Promise;
- // Warning: (ae-forgotten-export) The symbol "PublishRequest" needs to be exported by the entry point index.d.ts
- // Warning: (ae-forgotten-export) The symbol "PublishResponse" needs to be exported by the entry point index.d.ts
publish(request: PublishRequest): Promise;
}
-// Warning: (ae-missing-release-tag) "PublisherType" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
+// @public
+export type PublisherFactory = {
+ logger: Logger_2;
+ discovery: PluginEndpointDiscovery;
+};
+
// @public
export type PublisherType =
| 'local'
@@ -189,37 +178,40 @@ export type PublisherType =
| 'azureBlobStorage'
| 'openStackSwift';
+// @public
+export type PublishRequest = {
+ entity: Entity;
+ directory: string;
+};
+
+// @public
+export type PublishResponse = {
+ remoteUrl?: string;
+ objects?: string[];
+} | void;
+
// @public
export type ReadinessResponse = {
isAvailable: boolean;
};
-// Warning: (ae-missing-release-tag) "RemoteProtocol" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export type RemoteProtocol = 'url' | 'dir';
-// Warning: (ae-missing-release-tag) "TechDocsDocument" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
+export type SupportedGeneratorKey = 'techdocs' | string;
+
+// @public
export interface TechDocsDocument extends IndexableDocument {
- // (undocumented)
kind: string;
- // (undocumented)
lifecycle: string;
- // (undocumented)
name: string;
- // (undocumented)
namespace: string;
- // (undocumented)
owner: string;
- // (undocumented)
path: string;
}
-// Warning: (ae-missing-release-tag) "TechdocsGenerator" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export class TechdocsGenerator implements GeneratorBase {
constructor(options: {
logger: Logger_2;
@@ -227,21 +219,14 @@ export class TechdocsGenerator implements GeneratorBase {
config: Config;
scmIntegrations: ScmIntegrationRegistry;
});
- static readonly defaultDockerImage = 'spotify/techdocs:v0.3.6';
- // (undocumented)
+ static readonly defaultDockerImage = 'spotify/techdocs:v0.3.7';
static fromConfig(
config: Config,
- options: {
- containerRunner: ContainerRunner;
- logger: Logger_2;
- },
+ options: GeneratorOptions,
): TechdocsGenerator;
- // (undocumented)
run(options: GeneratorRunOptions): Promise;
}
-// Warning: (ae-missing-release-tag) "TechDocsMetadata" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public
export type TechDocsMetadata = {
site_name: string;
@@ -251,8 +236,6 @@ export type TechDocsMetadata = {
files?: string[];
};
-// Warning: (ae-missing-release-tag) "transformDirLocation" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public
export const transformDirLocation: (
entity: Entity,
@@ -263,21 +246,11 @@ export const transformDirLocation: (
target: string;
};
-// Warning: (ae-missing-release-tag) "UrlPreparer" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export class UrlPreparer implements PreparerBase {
+ // @deprecated
constructor(reader: UrlReader, logger: Logger_2);
- // (undocumented)
- prepare(
- entity: Entity,
- options?: {
- etag?: string;
- },
- ): Promise;
+ static fromConfig({ reader, logger }: PreparerConfig): UrlPreparer;
+ prepare(entity: Entity, options?: PreparerOptions): Promise;
}
-
-// Warnings were encountered during analysis:
-//
-// src/stages/generate/types.d.ts:45:5 - (ae-forgotten-export) The symbol "SupportedGeneratorKey" needs to be exported by the entry point index.d.ts
```
diff --git a/packages/techdocs-common/package.json b/packages/techdocs-common/package.json
index f45f842100..731e967637 100644
--- a/packages/techdocs-common/package.json
+++ b/packages/techdocs-common/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/techdocs-common",
"description": "Common functionalities for TechDocs, to be shared between techdocs-backend plugin and techdocs-cli",
- "version": "0.11.7",
+ "version": "0.11.10",
"main": "src/index.ts",
"types": "src/index.ts",
"private": false,
@@ -10,6 +10,9 @@
"main": "dist/index.cjs.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "node-library"
+ },
"homepage": "https://backstage.io",
"repository": {
"type": "git",
@@ -25,12 +28,13 @@
"dist"
],
"scripts": {
- "build": "backstage-cli build --outputs cjs,types",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean",
+ "start": "backstage-cli package start"
},
"bugs": {
"url": "https://github.com/backstage/backstage/issues"
@@ -38,12 +42,12 @@
"dependencies": {
"@azure/identity": "^2.0.1",
"@azure/storage-blob": "^12.5.0",
- "@backstage/backend-common": "^0.10.7",
- "@backstage/catalog-model": "^0.9.10",
- "@backstage/config": "^0.1.13",
- "@backstage/errors": "^0.2.0",
- "@backstage/search-common": "^0.2.2",
- "@backstage/integration": "^0.7.2",
+ "@backstage/backend-common": "^0.11.0",
+ "@backstage/catalog-model": "^0.11.0",
+ "@backstage/config": "^0.1.15",
+ "@backstage/errors": "^0.2.2",
+ "@backstage/search-common": "^0.2.4",
+ "@backstage/integration": "^0.7.5",
"@google-cloud/storage": "^5.6.0",
"@trendyol-js/openstack-swift-sdk": "^0.0.5",
"@types/express": "^4.17.6",
@@ -60,7 +64,7 @@
"winston": "^3.2.1"
},
"devDependencies": {
- "@backstage/cli": "^0.13.2",
+ "@backstage/cli": "^0.14.1",
"@types/fs-extra": "^9.0.5",
"@types/js-yaml": "^4.0.0",
"@types/mime-types": "^2.1.0",
diff --git a/packages/techdocs-common/src/helpers.ts b/packages/techdocs-common/src/helpers.ts
index ccf1256381..39a1f4c666 100644
--- a/packages/techdocs-common/src/helpers.ts
+++ b/packages/techdocs-common/src/helpers.ts
@@ -26,11 +26,21 @@ import path from 'path';
import { Logger } from 'winston';
import { PreparerResponse, RemoteProtocol } from './stages/prepare/types';
+/**
+ * Parsed location annotation
+ * @public
+ */
export type ParsedLocationAnnotation = {
type: RemoteProtocol;
target: string;
};
+/**
+ * Returns a parset locations annotation
+ * @public
+ * @param annotationName - The name of the annotation in the entity metadata
+ * @param entity - A TechDocs entity instance
+ */
export const parseReferenceAnnotation = (
annotationName: string,
entity: Entity,
@@ -56,7 +66,7 @@ export const parseReferenceAnnotation = (
* location, it returns a `url` location with a resolved target that points to the
* targeted subfolder. If the entity was registered by a `file` location, it returns
* an absolute `dir` location.
- *
+ * @public
* @param entity - the entity with annotations
* @param dirAnnotation - the parsed techdocs-ref annotation of type 'dir'
* @param scmIntegrations - access to the scmIntegration to do url transformations
@@ -101,6 +111,12 @@ export const transformDirLocation = (
}
};
+/**
+ * Returns a entity reference based on the TechDocs annotation type
+ * @public
+ * @param entity - A TechDocs instance
+ * @param scmIntegration - An implementation for SCM integration API
+ */
export const getLocationForEntity = (
entity: Entity,
scmIntegration: ScmIntegrationRegistry,
@@ -120,6 +136,13 @@ export const getLocationForEntity = (
}
};
+/**
+ * Returns a preparer response {@link PreparerResponse}
+ * @public
+ * @param reader - Read a tree of files from a repository
+ * @param entity - A TechDocs entity instance
+ * @param opts - Options for configuring the reader, e.g. logger, etag, etc.
+ */
export const getDocFilesFromRepository = async (
reader: UrlReader,
entity: Entity,
diff --git a/packages/techdocs-common/src/stages/generate/generators.ts b/packages/techdocs-common/src/stages/generate/generators.ts
index de39d4e7c3..630fccfa44 100644
--- a/packages/techdocs-common/src/stages/generate/generators.ts
+++ b/packages/techdocs-common/src/stages/generate/generators.ts
@@ -26,9 +26,18 @@ import {
SupportedGeneratorKey,
} from './types';
+/**
+ * Collection of docs generators
+ * @public
+ */
export class Generators implements GeneratorBuilder {
private generatorMap = new Map();
+ /**
+ * Returns a generators instance containing a generator for TechDocs
+ * @param config - A Backstage configuration
+ * @param options - Options to configure the TechDocs generator
+ */
static async fromConfig(
config: Config,
options: { logger: Logger; containerRunner: ContainerRunner },
@@ -41,10 +50,19 @@ export class Generators implements GeneratorBuilder {
return generators;
}
+ /**
+ * Register a generator in the generators collection
+ * @param generatorKey - Unique identifier for the generator
+ * @param generator - The generator instance to register
+ */
register(generatorKey: SupportedGeneratorKey, generator: GeneratorBase) {
this.generatorMap.set(generatorKey, generator);
}
+ /**
+ * Returns the generator for a given TechDocs entity
+ * @param entity - A TechDocs entity instance
+ */
get(entity: Entity): GeneratorBase {
const generatorKey = getGeneratorKey(entity);
const generator = this.generatorMap.get(generatorKey);
diff --git a/packages/techdocs-common/src/stages/generate/index.ts b/packages/techdocs-common/src/stages/generate/index.ts
index eb015a5c2d..1c20c58887 100644
--- a/packages/techdocs-common/src/stages/generate/index.ts
+++ b/packages/techdocs-common/src/stages/generate/index.ts
@@ -16,7 +16,9 @@
export { TechdocsGenerator } from './techdocs';
export { Generators } from './generators';
export type {
- GeneratorBuilder,
GeneratorBase,
+ GeneratorOptions,
+ GeneratorBuilder,
GeneratorRunOptions,
+ SupportedGeneratorKey,
} from './types';
diff --git a/packages/techdocs-common/src/stages/generate/techdocs.ts b/packages/techdocs-common/src/stages/generate/techdocs.ts
index 5cf992092c..baa2e008a1 100644
--- a/packages/techdocs-common/src/stages/generate/techdocs.ts
+++ b/packages/techdocs-common/src/stages/generate/techdocs.ts
@@ -34,26 +34,33 @@ import {
import {
GeneratorBase,
GeneratorConfig,
+ GeneratorOptions,
GeneratorRunInType,
GeneratorRunOptions,
} from './types';
import { ForwardedError } from '@backstage/errors';
+/**
+ * Generates documentation files
+ * @public
+ */
export class TechdocsGenerator implements GeneratorBase {
/**
* The default docker image (and version) used to generate content. Public
* and static so that techdocs-common consumers can use the same version.
*/
- public static readonly defaultDockerImage = 'spotify/techdocs:v0.3.6';
+ public static readonly defaultDockerImage = 'spotify/techdocs:v0.3.7';
private readonly logger: Logger;
private readonly containerRunner: ContainerRunner;
private readonly options: GeneratorConfig;
private readonly scmIntegrations: ScmIntegrationRegistry;
- static fromConfig(
- config: Config,
- options: { containerRunner: ContainerRunner; logger: Logger },
- ) {
+ /**
+ * Returns a instance of TechDocs generator
+ * @param config - A Backstage configuration
+ * @param options - Options to configure the generator
+ */
+ static fromConfig(config: Config, options: GeneratorOptions) {
const { containerRunner, logger } = options;
const scmIntegrations = ScmIntegrations.fromConfig(config);
return new TechdocsGenerator({
@@ -76,6 +83,7 @@ export class TechdocsGenerator implements GeneratorBase {
this.scmIntegrations = options.scmIntegrations;
}
+ /** {@inheritDoc GeneratorBase.run} */
public async run(options: GeneratorRunOptions): Promise {
const {
inputDir,
diff --git a/packages/techdocs-common/src/stages/generate/types.ts b/packages/techdocs-common/src/stages/generate/types.ts
index 2a090d5584..2ff3064991 100644
--- a/packages/techdocs-common/src/stages/generate/types.ts
+++ b/packages/techdocs-common/src/stages/generate/types.ts
@@ -14,6 +14,7 @@
* limitations under the License.
*/
+import { ContainerRunner } from '@backstage/backend-common';
import { Entity } from '@backstage/catalog-model';
import { Writable } from 'stream';
import { Logger } from 'winston';
@@ -22,6 +23,15 @@ import { ParsedLocationAnnotation } from '../../helpers';
// Determines where the generator will be run
export type GeneratorRunInType = 'docker' | 'local';
+/**
+ * Options for building generators
+ * @public
+ */
+export type GeneratorOptions = {
+ containerRunner: ContainerRunner;
+ logger: Logger;
+};
+
/**
* The techdocs generator configurations options.
*/
@@ -51,18 +61,27 @@ export type GeneratorRunOptions = {
logStream?: Writable;
};
+/**
+ * Generates documentation files
+ * @public
+ */
export type GeneratorBase = {
- // Runs the generator with the values
+ /**
+ * Runs the generator with the values
+ * @public
+ */
run(opts: GeneratorRunOptions): Promise;
};
/**
* List of supported generator options
+ * @public
*/
export type SupportedGeneratorKey = 'techdocs' | string;
/**
* The generator builder holds the generator ready for run time
+ * @public
*/
export type GeneratorBuilder = {
register(protocol: SupportedGeneratorKey, generator: GeneratorBase): void;
diff --git a/packages/techdocs-common/src/stages/prepare/dir.test.ts b/packages/techdocs-common/src/stages/prepare/dir.test.ts
index 019bf51fe9..2bf3fe29fc 100644
--- a/packages/techdocs-common/src/stages/prepare/dir.test.ts
+++ b/packages/techdocs-common/src/stages/prepare/dir.test.ts
@@ -86,7 +86,7 @@ describe('directory preparer', () => {
);
});
- it('should reject when managed-by-location is a git repository', async () => {
+ it('should reject when managed-by-location has an unknown type', async () => {
const directoryPreparer = new DirectoryPreparer(
mockConfig,
logger,
@@ -95,12 +95,12 @@ describe('directory preparer', () => {
const mockEntity = createMockEntity({
'backstage.io/managed-by-location':
- 'github:https://github.com/backstage/backstage/blob/master/catalog-info.yaml',
+ 'does-not-exist:https://github.com/backstage/backstage/blob/master/catalog-info.yaml',
'backstage.io/techdocs-ref': 'dir:./docs',
});
await expect(directoryPreparer.prepare(mockEntity)).rejects.toThrow(
- /Unable to resolve location type github/,
+ /Unable to resolve location type does-not-exist/,
);
});
});
diff --git a/packages/techdocs-common/src/stages/prepare/dir.ts b/packages/techdocs-common/src/stages/prepare/dir.ts
index ade0b00162..42bfa5b903 100644
--- a/packages/techdocs-common/src/stages/prepare/dir.ts
+++ b/packages/techdocs-common/src/stages/prepare/dir.ts
@@ -24,20 +24,43 @@ import {
} from '@backstage/integration';
import { Logger } from 'winston';
import { parseReferenceAnnotation, transformDirLocation } from '../../helpers';
-import { PreparerBase, PreparerResponse } from './types';
+import {
+ PreparerBase,
+ PreparerConfig,
+ PreparerOptions,
+ PreparerResponse,
+} from './types';
+/**
+ * Preparer used to retrieve documentation files from a local directory
+ * @public
+ */
export class DirectoryPreparer implements PreparerBase {
private readonly scmIntegrations: ScmIntegrationRegistry;
private readonly reader: UrlReader;
- constructor(config: Config, _logger: Logger, reader: UrlReader) {
+ /** @deprecated use static fromConfig method instead */
+ constructor(config: Config, _logger: Logger | null, reader: UrlReader) {
this.reader = reader;
this.scmIntegrations = ScmIntegrations.fromConfig(config);
}
+ /**
+ * Returns a directory preparer instance
+ * @param config - A backstage config
+ * @param options - A directory preparer options containing a logger and reader
+ */
+ static fromConfig(
+ config: Config,
+ { logger, reader }: PreparerConfig,
+ ): DirectoryPreparer {
+ return new DirectoryPreparer(config, logger, reader);
+ }
+
+ /** {@inheritDoc PreparerBase.prepare} */
async prepare(
entity: Entity,
- options?: { logger?: Logger; etag?: string },
+ options?: PreparerOptions,
): Promise {
const annotation = parseReferenceAnnotation(
'backstage.io/techdocs-ref',
diff --git a/packages/techdocs-common/src/stages/prepare/index.ts b/packages/techdocs-common/src/stages/prepare/index.ts
index f129bf5315..3593b49c86 100644
--- a/packages/techdocs-common/src/stages/prepare/index.ts
+++ b/packages/techdocs-common/src/stages/prepare/index.ts
@@ -16,4 +16,12 @@
export { DirectoryPreparer } from './dir';
export { UrlPreparer } from './url';
export { Preparers } from './preparers';
-export type { PreparerBuilder, PreparerBase, RemoteProtocol } from './types';
+export type {
+ PreparerBase,
+ PreparerBuilder,
+ PreparerConfig,
+ PreparerOptions,
+ PreparerResponse,
+ RemoteProtocol,
+ ETag,
+} from './types';
diff --git a/packages/techdocs-common/src/stages/prepare/preparers.ts b/packages/techdocs-common/src/stages/prepare/preparers.ts
index 75c9a7f23b..575294e91a 100644
--- a/packages/techdocs-common/src/stages/prepare/preparers.ts
+++ b/packages/techdocs-common/src/stages/prepare/preparers.ts
@@ -13,26 +13,34 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import { UrlReader } from '@backstage/backend-common';
import { Entity } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
-import { Logger } from 'winston';
import { parseReferenceAnnotation } from '../../helpers';
import { DirectoryPreparer } from './dir';
import { UrlPreparer } from './url';
-import { PreparerBase, PreparerBuilder, RemoteProtocol } from './types';
-
-type factoryOptions = {
- logger: Logger;
- reader: UrlReader;
-};
+import {
+ PreparerBase,
+ PreparerBuilder,
+ PreparerConfig,
+ RemoteProtocol,
+} from './types';
+/**
+ * Collection of docs preparers (dir and url)
+ * @public
+ */
export class Preparers implements PreparerBuilder {
private preparerMap = new Map();
+ /**
+ * Returns a generators instance containing a generator for TechDocs
+ * @public
+ * @param backstageConfig - A Backstage configuration
+ * @param preparerConfig - Options to configure preparers
+ */
static async fromConfig(
- config: Config,
- { logger, reader }: factoryOptions,
+ backstageConfig: Config,
+ { logger, reader }: PreparerConfig,
): Promise {
const preparers = new Preparers();
@@ -43,16 +51,30 @@ export class Preparers implements PreparerBuilder {
* Dir preparer is a syntactic sugar for users to define techdocs-ref annotation.
* When using dir preparer, the docs will be fetched using URL Reader.
*/
- const directoryPreparer = new DirectoryPreparer(config, logger, reader);
+ const directoryPreparer = new DirectoryPreparer(
+ backstageConfig,
+ logger,
+ reader,
+ );
preparers.register('dir', directoryPreparer);
return preparers;
}
+ /**
+ * Register a preparer in the preparers collection
+ * @param protocol - url or dir to associate with preparer
+ * @param preparer - The preparer instance to set
+ */
register(protocol: RemoteProtocol, preparer: PreparerBase) {
this.preparerMap.set(protocol, preparer);
}
+ /**
+ * Returns the preparer for a given TechDocs entity
+ * @param entity - A TechDocs entity instance
+ * @returns
+ */
get(entity: Entity): PreparerBase {
const { type } = parseReferenceAnnotation(
'backstage.io/techdocs-ref',
diff --git a/packages/techdocs-common/src/stages/prepare/types.ts b/packages/techdocs-common/src/stages/prepare/types.ts
index 5c219752fa..aee9d216ab 100644
--- a/packages/techdocs-common/src/stages/prepare/types.ts
+++ b/packages/techdocs-common/src/stages/prepare/types.ts
@@ -15,19 +15,58 @@
*/
import type { Entity } from '@backstage/catalog-model';
+import { UrlReader } from '@backstage/backend-common';
import { Logger } from 'winston';
+/**
+ * A unique identifier of the tree blob, usually the commit SHA or etag from the target.
+ * @public
+ */
+export type ETag = string;
+
+/**
+ * Options for building preparers
+ * @public
+ */
+export type PreparerConfig = {
+ logger: Logger;
+ reader: UrlReader;
+};
+
+/**
+ * Options for configuring the content preparation process.
+ * @public
+ */
+export type PreparerOptions = {
+ /**
+ * An instance of the logger
+ */
+ logger?: Logger;
+ /**
+ * see {@link ETag}
+ */
+ etag?: ETag;
+};
+
+/**
+ * Result of the preparation step.
+ * @public
+ */
export type PreparerResponse = {
/**
* The path to directory where the tree is downloaded.
*/
preparedDir: string;
/**
- * A unique identifier of the tree blob, usually the commit SHA or etag from the target.
+ * see {@link ETag}
*/
- etag: string;
+ etag: ETag;
};
+/**
+ * Definition of a TechDocs preparer
+ * @public
+ */
export type PreparerBase = {
/**
* Given an Entity definition from the Software Catalog, go and prepare a directory
@@ -38,15 +77,20 @@ export type PreparerBase = {
* updated since the last build.
* @throws `NotModifiedError` when the prepared directory has not been changed since the last build.
*/
- prepare(
- entity: Entity,
- options?: { logger?: Logger; etag?: string },
- ): Promise;
+ prepare(entity: Entity, options?: PreparerOptions): Promise;
};
+/**
+ * Definition for a TechDocs preparer builder
+ * @public
+ */
export type PreparerBuilder = {
register(protocol: RemoteProtocol, preparer: PreparerBase): void;
get(entity: Entity): PreparerBase;
};
+/**
+ * Location where documentation files are stored
+ * @public
+ */
export type RemoteProtocol = 'url' | 'dir';
diff --git a/packages/techdocs-common/src/stages/prepare/url.ts b/packages/techdocs-common/src/stages/prepare/url.ts
index cd4a8860e4..8026dca41e 100644
--- a/packages/techdocs-common/src/stages/prepare/url.ts
+++ b/packages/techdocs-common/src/stages/prepare/url.ts
@@ -19,20 +19,39 @@ import { UrlReader } from '@backstage/backend-common';
import { Entity } from '@backstage/catalog-model';
import { Logger } from 'winston';
import { getDocFilesFromRepository } from '../../helpers';
-import { PreparerBase, PreparerResponse } from './types';
+import {
+ PreparerBase,
+ PreparerConfig,
+ PreparerOptions,
+ PreparerResponse,
+} from './types';
+/**
+ * Preparer used to retrieve documentation files from a remote repository
+ * @public
+ */
export class UrlPreparer implements PreparerBase {
private readonly logger: Logger;
private readonly reader: UrlReader;
+ /** @deprecated use static fromConfig method instead */
constructor(reader: UrlReader, logger: Logger) {
this.logger = logger;
this.reader = reader;
}
+ /**
+ * Returns a directory preparer instance
+ * @param config - A URL preparer config containing the a logger and reader
+ */
+ static fromConfig({ reader, logger }: PreparerConfig): UrlPreparer {
+ return new UrlPreparer(reader, logger);
+ }
+
+ /** {@inheritDoc PreparerBase.prepare} */
async prepare(
entity: Entity,
- options?: { etag?: string },
+ options?: PreparerOptions,
): Promise {
try {
return await getDocFilesFromRepository(this.reader, entity, {
diff --git a/packages/techdocs-common/src/stages/publish/googleStorage.ts b/packages/techdocs-common/src/stages/publish/googleStorage.ts
index ba70c36e27..c3d9d3330b 100644
--- a/packages/techdocs-common/src/stages/publish/googleStorage.ts
+++ b/packages/techdocs-common/src/stages/publish/googleStorage.ts
@@ -83,7 +83,7 @@ export class GoogleGCSPublish implements PublisherBase {
const credentials = config.getOptionalString(
'techdocs.publisher.googleGcs.credentials',
);
- let credentialsJson = {};
+ let credentialsJson: any = {};
if (credentials) {
try {
credentialsJson = JSON.parse(credentials);
@@ -96,6 +96,7 @@ export class GoogleGCSPublish implements PublisherBase {
const storageClient = new Storage({
...(credentials && {
+ projectId: credentialsJson.project_id,
credentials: credentialsJson,
}),
});
diff --git a/packages/techdocs-common/src/stages/publish/index.ts b/packages/techdocs-common/src/stages/publish/index.ts
index 083cf2b8ff..c6f86f6bc1 100644
--- a/packages/techdocs-common/src/stages/publish/index.ts
+++ b/packages/techdocs-common/src/stages/publish/index.ts
@@ -17,6 +17,10 @@ export { Publisher } from './publish';
export type {
PublisherBase,
PublisherType,
- TechDocsMetadata,
+ PublisherFactory,
+ PublishRequest,
+ PublishResponse,
+ MigrateRequest,
ReadinessResponse,
+ TechDocsMetadata,
} from './types';
diff --git a/packages/techdocs-common/src/stages/publish/publish.ts b/packages/techdocs-common/src/stages/publish/publish.ts
index eb9e3104bf..bc7f50b5a3 100644
--- a/packages/techdocs-common/src/stages/publish/publish.ts
+++ b/packages/techdocs-common/src/stages/publish/publish.ts
@@ -14,29 +14,28 @@
* limitations under the License.
*/
-import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { Config } from '@backstage/config';
-import { Logger } from 'winston';
import { AwsS3Publish } from './awsS3';
import { AzureBlobStoragePublish } from './azureBlobStorage';
import { GoogleGCSPublish } from './googleStorage';
import { LocalPublish } from './local';
import { OpenStackSwiftPublish } from './openStackSwift';
-import { PublisherBase, PublisherType } from './types';
-
-type factoryOptions = {
- logger: Logger;
- discovery: PluginEndpointDiscovery;
-};
+import { PublisherFactory, PublisherBase, PublisherType } from './types';
/**
* Factory class to create a TechDocs publisher based on defined publisher type in app config.
* Uses `techdocs.publisher.type`.
+ * @public
*/
export class Publisher {
+ /**
+ * Returns a instance of TechDocs publisher
+ * @param config - A Backstage configuration
+ * @param options - Options for configuring the publisher factory
+ */
static async fromConfig(
config: Config,
- { logger, discovery }: factoryOptions,
+ { logger, discovery }: PublisherFactory,
): Promise {
const publisherType = (config.getOptionalString(
'techdocs.publisher.type',
diff --git a/packages/techdocs-common/src/stages/publish/types.ts b/packages/techdocs-common/src/stages/publish/types.ts
index 37075a35a4..c6ad032484 100644
--- a/packages/techdocs-common/src/stages/publish/types.ts
+++ b/packages/techdocs-common/src/stages/publish/types.ts
@@ -14,10 +14,22 @@
* limitations under the License.
*/
import { Entity, EntityName } from '@backstage/catalog-model';
+import { PluginEndpointDiscovery } from '@backstage/backend-common';
+import { Logger } from 'winston';
import express from 'express';
+/**
+ * Options for building publishers
+ * @public
+ */
+export type PublisherFactory = {
+ logger: Logger;
+ discovery: PluginEndpointDiscovery;
+};
+
/**
* Key for all the different types of TechDocs publishers that are supported.
+ * @public
*/
export type PublisherType =
| 'local'
@@ -26,6 +38,10 @@ export type PublisherType =
| 'azureBlobStorage'
| 'openStackSwift';
+/**
+ * Request publish definition
+ * @public
+ */
export type PublishRequest = {
entity: Entity;
/* The Path to the directory where the generated files are stored. */
@@ -35,6 +51,7 @@ export type PublishRequest = {
/**
* Response containing metadata about where files were published and what may
* have been published or updated.
+ * @public
*/
export type PublishResponse = {
/**
@@ -51,7 +68,6 @@ export type PublishResponse = {
/**
* Result for the validation check.
- *
* @public
*/
export type ReadinessResponse = {
@@ -62,6 +78,7 @@ export type ReadinessResponse = {
/**
* Type to hold metadata found in techdocs_metadata.json and associated with each site
* @param etag - ETag of the resource used to generate the site. Usually the latest commit sha of the source repository.
+ * @public
*/
export type TechDocsMetadata = {
site_name: string;
@@ -71,6 +88,10 @@ export type TechDocsMetadata = {
files?: string[];
};
+/**
+ * TechDocs entity triplet migration request
+ * @public
+ */
export type MigrateRequest = {
/**
* Whether or not to remove the source file. Defaults to false (acting like a
diff --git a/packages/techdocs-common/src/techdocsTypes.ts b/packages/techdocs-common/src/techdocsTypes.ts
index 4aa3972b31..0b722f4da5 100644
--- a/packages/techdocs-common/src/techdocsTypes.ts
+++ b/packages/techdocs-common/src/techdocsTypes.ts
@@ -16,11 +16,33 @@
import { IndexableDocument } from '@backstage/search-common';
+/**
+ * TechDocs indexable document interface
+ * @public
+ */
export interface TechDocsDocument extends IndexableDocument {
+ /**
+ * Entity kind
+ */
kind: string;
+ /**
+ * Entity metadata namespace
+ */
namespace: string;
+ /**
+ * Entity metadata name
+ */
name: string;
+ /**
+ * Entity lifecycle
+ */
lifecycle: string;
+ /**
+ * Entity owner
+ */
owner: string;
+ /**
+ * Entity path
+ */
path: string;
}
diff --git a/packages/test-utils/CHANGELOG.md b/packages/test-utils/CHANGELOG.md
index 35c9ebfb35..4de90a4aa7 100644
--- a/packages/test-utils/CHANGELOG.md
+++ b/packages/test-utils/CHANGELOG.md
@@ -1,5 +1,29 @@
# @backstage/test-utils
+## 0.2.6
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-plugin-api@0.7.0
+ - @backstage/core-app-api@0.5.4
+ - @backstage/plugin-permission-react@0.3.2
+
+## 0.2.5
+
+### Patch Changes
+
+- 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- Updated dependencies
+ - @backstage/core-app-api@0.5.3
+ - @backstage/core-plugin-api@0.6.1
+ - @backstage/plugin-permission-common@0.5.0
+ - @backstage/plugin-permission-react@0.3.1
+ - @backstage/config@0.1.14
+ - @backstage/theme@0.2.15
+ - @backstage/types@0.1.2
+
## 0.2.4
### Patch Changes
diff --git a/packages/test-utils/package.json b/packages/test-utils/package.json
index 67b68e08cc..5465f7783a 100644
--- a/packages/test-utils/package.json
+++ b/packages/test-utils/package.json
@@ -1,13 +1,16 @@
{
"name": "@backstage/test-utils",
"description": "Utilities to test Backstage plugins and apps.",
- "version": "0.2.4",
+ "version": "0.2.6",
"private": false,
"publishConfig": {
"access": "public",
"main": "dist/index.esm.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "web-library"
+ },
"homepage": "https://backstage.io",
"repository": {
"type": "git",
@@ -21,21 +24,22 @@
"main": "src/index.ts",
"types": "src/index.ts",
"scripts": {
- "build": "backstage-cli build --outputs types,esm",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean",
+ "start": "backstage-cli package start"
},
"dependencies": {
- "@backstage/config": "^0.1.13",
- "@backstage/core-app-api": "^0.5.2",
- "@backstage/core-plugin-api": "^0.6.0",
- "@backstage/plugin-permission-common": "^0.4.0",
- "@backstage/plugin-permission-react": "^0.3.0",
- "@backstage/theme": "^0.2.14",
- "@backstage/types": "^0.1.1",
+ "@backstage/config": "^0.1.15",
+ "@backstage/core-app-api": "^0.5.4",
+ "@backstage/core-plugin-api": "^0.7.0",
+ "@backstage/plugin-permission-common": "^0.5.1",
+ "@backstage/plugin-permission-react": "^0.3.2",
+ "@backstage/theme": "^0.2.15",
+ "@backstage/types": "^0.1.3",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.11.2",
"@testing-library/jest-dom": "^5.10.1",
@@ -51,7 +55,7 @@
"react": "^16.13.1 || ^17.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.13.2-next.0",
+ "@backstage/cli": "^0.14.1",
"@types/jest": "^26.0.7",
"@types/node": "^14.14.32",
"msw": "^0.35.0"
diff --git a/packages/theme/CHANGELOG.md b/packages/theme/CHANGELOG.md
index cfa6ee3633..5c3e8cf5d6 100644
--- a/packages/theme/CHANGELOG.md
+++ b/packages/theme/CHANGELOG.md
@@ -1,5 +1,11 @@
# @backstage/theme
+## 0.2.15
+
+### Patch Changes
+
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+
## 0.2.14
### Patch Changes
diff --git a/packages/theme/package.json b/packages/theme/package.json
index 2846db2805..17404e8db0 100644
--- a/packages/theme/package.json
+++ b/packages/theme/package.json
@@ -1,13 +1,16 @@
{
"name": "@backstage/theme",
"description": "material-ui theme for use with Backstage.",
- "version": "0.2.14",
+ "version": "0.2.15",
"private": false,
"publishConfig": {
"access": "public",
"main": "dist/index.esm.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "web-library"
+ },
"homepage": "https://backstage.io",
"repository": {
"type": "git",
@@ -21,17 +24,19 @@
"main": "src/index.ts",
"types": "src/index.ts",
"scripts": {
- "build": "backstage-cli build --outputs types,esm",
- "lint": "backstage-cli lint",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean",
+ "start": "backstage-cli package start",
+ "test": "backstage-cli package test"
},
"dependencies": {
"@material-ui/core": "^4.12.2"
},
"devDependencies": {
- "@backstage/cli": "^0.13.2-next.0"
+ "@backstage/cli": "^0.14.0"
},
"files": [
"dist"
diff --git a/packages/types/CHANGELOG.md b/packages/types/CHANGELOG.md
new file mode 100644
index 0000000000..238c61f68f
--- /dev/null
+++ b/packages/types/CHANGELOG.md
@@ -0,0 +1,13 @@
+# @backstage/types
+
+## 0.1.3
+
+### Patch Changes
+
+- Fix for the previous release with missing type declarations.
+
+## 0.1.2
+
+### Patch Changes
+
+- c77c5c7eb6: Added `backstage.role` to `package.json`
diff --git a/packages/types/package.json b/packages/types/package.json
index ae18fe519d..ab0740d568 100644
--- a/packages/types/package.json
+++ b/packages/types/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/types",
"description": "Common TypeScript types used within Backstage",
- "version": "0.1.1",
+ "version": "0.1.3",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -12,6 +12,9 @@
"module": "dist/index.esm.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "common-library"
+ },
"homepage": "https://backstage.io",
"repository": {
"type": "git",
@@ -22,16 +25,16 @@
"backstage"
],
"scripts": {
- "build": "backstage-cli build",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean"
},
"dependencies": {},
"devDependencies": {
- "@backstage/cli": "^0.13.2-next.0",
+ "@backstage/cli": "^0.14.0",
"@types/zen-observable": "^0.8.0",
"zen-observable": "^0.8.15"
},
diff --git a/packages/version-bridge/CHANGELOG.md b/packages/version-bridge/CHANGELOG.md
index e079cd6c61..fe131f7987 100644
--- a/packages/version-bridge/CHANGELOG.md
+++ b/packages/version-bridge/CHANGELOG.md
@@ -1,5 +1,11 @@
# @backstage/version-bridge
+## 0.1.2
+
+### Patch Changes
+
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+
## 0.1.1
### Patch Changes
diff --git a/packages/version-bridge/package.json b/packages/version-bridge/package.json
index 6989aec3cf..485b0417cf 100644
--- a/packages/version-bridge/package.json
+++ b/packages/version-bridge/package.json
@@ -1,13 +1,16 @@
{
"name": "@backstage/version-bridge",
"description": "Utilities used by @backstage packages to support multiple concurrent versions",
- "version": "0.1.1",
+ "version": "0.1.2",
"private": false,
"publishConfig": {
"access": "public",
"main": "dist/index.esm.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "web-library"
+ },
"homepage": "https://backstage.io",
"repository": {
"type": "git",
@@ -21,19 +24,20 @@
"main": "src/index.ts",
"types": "src/index.ts",
"scripts": {
- "build": "backstage-cli build --outputs types,esm",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean",
+ "start": "backstage-cli package start"
},
"peerDependencies": {
"@types/react": "^16.13.1 || ^17.0.0",
"react": "^16.13.1 || ^17.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.13.2-next.0",
+ "@backstage/cli": "^0.14.0",
"@testing-library/jest-dom": "^5.10.1",
"@testing-library/react": "^11.2.5",
"@testing-library/react-hooks": "^7.0.2"
diff --git a/plugins/airbrake-backend/.eslintrc.js b/plugins/airbrake-backend/.eslintrc.js
new file mode 100644
index 0000000000..16a033dbc6
--- /dev/null
+++ b/plugins/airbrake-backend/.eslintrc.js
@@ -0,0 +1,3 @@
+module.exports = {
+ extends: [require.resolve('@backstage/cli/config/eslint.backend')],
+};
diff --git a/plugins/airbrake-backend/CHANGELOG.md b/plugins/airbrake-backend/CHANGELOG.md
new file mode 100644
index 0000000000..148dbdeb07
--- /dev/null
+++ b/plugins/airbrake-backend/CHANGELOG.md
@@ -0,0 +1,25 @@
+# @backstage/plugin-airbrake-backend
+
+## 0.2.0
+
+### Minor Changes
+
+- da78e79a94: This marks the first release where the Airbrake plugin is useable. Airbrake frontend and Airbrake backend work with each other. Currently just a summary of the latest Airbrakes is shown on Backstage.
+
+### Patch Changes
+
+- 0045270527: Make config optional
+- Updated dependencies
+ - @backstage/backend-common@0.11.0
+
+## 0.1.0
+
+### Minor Changes
+
+- a5aebe3e30: Created the Airbrake backend plugin that proxies requests to the Airbrake API
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.10.8
+ - @backstage/config@0.1.14
diff --git a/plugins/airbrake-backend/README.md b/plugins/airbrake-backend/README.md
new file mode 100644
index 0000000000..9c9b56ade4
--- /dev/null
+++ b/plugins/airbrake-backend/README.md
@@ -0,0 +1,32 @@
+# airbrake-backend
+
+The Airbrake backend plugin provides a simple proxy to the Airbrake API while hiding away the secret API key from the frontend.
+
+## How to use
+
+See the [Airbrake plugin instructions](../airbrake/README.md#how-to-use).
+
+## Local Development
+
+This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads.
+
+1. Add the required config to your `app-config.local.yaml`:
+
+ ```yaml
+ airbrake:
+ apiKey: ${AIRBRAKE_API_KEY}
+ ```
+
+2. Set the environment variable `AIRBRAKE_API_KEY` with your [API
+ key](https://airbrake.io/docs/api/#authentication). You can also write it
+ directly into the config file above for convenience - but beware of
+ accidentally leaking the key.
+
+3. Go into the plugin's directory and run it in standalone mode by running `yarn start`.
+
+Access it from http://localhost:7007/api/airbrake. Or use the Airbrake plugin which will talk to it automatically.
+
+Here are some example endpoints:
+
+- http://localhost:7007/api/airbrake/health
+- http://localhost:7007/api/airbrake/api/v4/projects
diff --git a/plugins/airbrake-backend/api-report.md b/plugins/airbrake-backend/api-report.md
new file mode 100644
index 0000000000..b9e9a50e0b
--- /dev/null
+++ b/plugins/airbrake-backend/api-report.md
@@ -0,0 +1,26 @@
+## API Report File for "@backstage/plugin-airbrake-backend"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { Config } from '@backstage/config';
+import express from 'express';
+import { Logger as Logger_2 } from 'winston';
+
+// @public
+export interface AirbrakeConfig {
+ apiKey: string;
+}
+
+// @public
+export function createRouter(options: RouterOptions): Promise;
+
+// @public
+export function extractAirbrakeConfig(config: Config): AirbrakeConfig;
+
+// @public
+export interface RouterOptions {
+ airbrakeConfig: AirbrakeConfig;
+ logger: Logger_2;
+}
+```
diff --git a/plugins/airbrake-backend/config.d.ts b/plugins/airbrake-backend/config.d.ts
new file mode 100644
index 0000000000..a21f609550
--- /dev/null
+++ b/plugins/airbrake-backend/config.d.ts
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2021 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 Config {
+ /** Configuration options for the Airbrake plugin */
+ airbrake?: {
+ /**
+ * The API Key to authenticate requests. More details on how to get this
+ * here: https://airbrake.io/docs/api/#authentication
+ *
+ * @visibility secret
+ */
+ apiKey: string;
+ };
+}
diff --git a/plugins/airbrake-backend/package.json b/plugins/airbrake-backend/package.json
new file mode 100644
index 0000000000..2ee36eefb7
--- /dev/null
+++ b/plugins/airbrake-backend/package.json
@@ -0,0 +1,44 @@
+{
+ "name": "@backstage/plugin-airbrake-backend",
+ "version": "0.2.0",
+ "main": "src/index.ts",
+ "types": "src/index.ts",
+ "license": "Apache-2.0",
+ "publishConfig": {
+ "access": "public",
+ "main": "dist/index.cjs.js",
+ "types": "dist/index.d.ts"
+ },
+ "scripts": {
+ "start": "backstage-cli backend:dev",
+ "build": "backstage-cli backend:build",
+ "lint": "backstage-cli lint",
+ "test": "backstage-cli test",
+ "prepack": "backstage-cli prepack",
+ "postpack": "backstage-cli postpack",
+ "clean": "backstage-cli clean"
+ },
+ "dependencies": {
+ "@backstage/backend-common": "^0.11.0",
+ "@backstage/config": "^0.1.15",
+ "@types/express": "*",
+ "express": "^4.17.1",
+ "express-promise-router": "^4.1.0",
+ "http-proxy-middleware": "^2.0.0",
+ "winston": "^3.2.1",
+ "cross-fetch": "^3.0.6",
+ "yn": "^4.0.0"
+ },
+ "devDependencies": {
+ "@backstage/cli": "^0.14.1",
+ "@types/http-proxy-middleware": "^0.19.3",
+ "@types/supertest": "^2.0.8",
+ "supertest": "^6.1.6",
+ "msw": "^0.35.0"
+ },
+ "files": [
+ "dist",
+ "config.d.ts"
+ ],
+ "configSchema": "config.d.ts"
+}
diff --git a/plugins/airbrake-backend/src/config/ExtractAirbrakeConfig.test.ts b/plugins/airbrake-backend/src/config/ExtractAirbrakeConfig.test.ts
new file mode 100644
index 0000000000..53d744b9ee
--- /dev/null
+++ b/plugins/airbrake-backend/src/config/ExtractAirbrakeConfig.test.ts
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { ConfigReader } from '@backstage/config';
+import { extractAirbrakeConfig } from './ExtractAirbrakeConfig';
+
+describe('ExtractAirbrakeConfig', () => {
+ it('gets the API key', () => {
+ const config = new ConfigReader({
+ airbrake: {
+ apiKey: 'fakeApiKey',
+ },
+ });
+
+ const airbrakeConfig = extractAirbrakeConfig(config);
+ expect(airbrakeConfig.apiKey).toStrictEqual('fakeApiKey');
+ });
+
+ it('fails for missing keys', () => {
+ expect(() => extractAirbrakeConfig(new ConfigReader({}))).toThrow();
+ expect(() =>
+ extractAirbrakeConfig(new ConfigReader({ airbrake: {} })),
+ ).toThrow();
+ });
+});
diff --git a/plugins/airbrake-backend/src/config/ExtractAirbrakeConfig.ts b/plugins/airbrake-backend/src/config/ExtractAirbrakeConfig.ts
new file mode 100644
index 0000000000..de6a31feec
--- /dev/null
+++ b/plugins/airbrake-backend/src/config/ExtractAirbrakeConfig.ts
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Config } from '@backstage/config';
+
+/**
+ * The configuration needed for the airbrake-backend plugin
+ *
+ * @public
+ */
+export interface AirbrakeConfig {
+ /**
+ * The API Key to authenticate requests. More details on how to get this here: https://airbrake.io/docs/api/#authentication
+ */
+ apiKey: string;
+}
+
+/**
+ * Extract the Airbrake config from a config object
+ *
+ * @public
+ *
+ * @param config - The config object to extract from
+ */
+export function extractAirbrakeConfig(config: Config): AirbrakeConfig {
+ return {
+ apiKey: config.getString('airbrake.apiKey'),
+ };
+}
diff --git a/plugins/scaffolder/src/components/fields/TextValuePicker/index.ts b/plugins/airbrake-backend/src/config/index.ts
similarity index 85%
rename from plugins/scaffolder/src/components/fields/TextValuePicker/index.ts
rename to plugins/airbrake-backend/src/config/index.ts
index 8ab810b6ed..60d60c2761 100644
--- a/plugins/scaffolder/src/components/fields/TextValuePicker/index.ts
+++ b/plugins/airbrake-backend/src/config/index.ts
@@ -1,5 +1,5 @@
/*
- * Copyright 2021 The Backstage Authors
+ * Copyright 2022 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -13,4 +13,5 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-export { TextValuePicker } from './TextValuePicker';
+
+export * from './ExtractAirbrakeConfig';
diff --git a/plugins/airbrake-backend/src/index.ts b/plugins/airbrake-backend/src/index.ts
new file mode 100644
index 0000000000..f4ec6008c2
--- /dev/null
+++ b/plugins/airbrake-backend/src/index.ts
@@ -0,0 +1,24 @@
+/*
+ * 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.
+ */
+
+/**
+ * The Airbrake Backend plugin used by \@backstage/plugin-airbrake
+ *
+ * @packageDocumentation
+ */
+
+export * from './service/router';
+export * from './config';
diff --git a/plugins/airbrake/src/components/EntityAirbrakeContent/EntityAirbrakeContent.test.tsx b/plugins/airbrake-backend/src/run.ts
similarity index 51%
rename from plugins/airbrake/src/components/EntityAirbrakeContent/EntityAirbrakeContent.test.tsx
rename to plugins/airbrake-backend/src/run.ts
index a621eb281c..0a3ed2b7f0 100644
--- a/plugins/airbrake/src/components/EntityAirbrakeContent/EntityAirbrakeContent.test.tsx
+++ b/plugins/airbrake-backend/src/run.ts
@@ -14,19 +14,20 @@
* limitations under the License.
*/
-import React from 'react';
-import { EntityAirbrakeContent } from './EntityAirbrakeContent';
-import exampleData from './example-data.json';
-import { renderInTestApp } from '@backstage/test-utils';
+import { getRootLogger } from '@backstage/backend-common';
+import yn from 'yn';
+import { startStandaloneServer } from './service/standaloneServer';
-describe('EntityAirbrakeContent', () => {
- it('renders all errors sent from Airbrake', async () => {
- const table = await renderInTestApp( {
+ const { logger } = options;
+
+ const router = Router();
+ router.use(express.json());
+
+ router.get('/health', (_, response) => {
+ logger.info('PONG!');
+ response.send({ status: 'ok' });
+ });
+
+ router.use(
+ '/api',
+ createProxyMiddleware({
+ target: 'https://api.airbrake.io/api',
+ changeOrigin: true,
+ pathRewrite: generateAirbrakePathRewrite(options),
+ }),
+ );
+
+ router.use(errorHandler());
+ return router;
+}
diff --git a/plugins/airbrake-backend/src/service/standaloneServer.ts b/plugins/airbrake-backend/src/service/standaloneServer.ts
new file mode 100644
index 0000000000..6825e60a0a
--- /dev/null
+++ b/plugins/airbrake-backend/src/service/standaloneServer.ts
@@ -0,0 +1,61 @@
+/*
+ * 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 {
+ createServiceBuilder,
+ loadBackendConfig,
+} from '@backstage/backend-common';
+import { Server } from 'http';
+import { Logger } from 'winston';
+import { createRouter } from './router';
+import { extractAirbrakeConfig } from '../config';
+
+export interface ServerOptions {
+ port: number;
+ enableCors: boolean;
+ logger: Logger;
+}
+
+export async function startStandaloneServer(
+ options: ServerOptions,
+): Promise {
+ const logger = options.logger.child({ service: 'airbrake-backend' });
+ const config = await loadBackendConfig({ logger, argv: process.argv });
+ const airbrakeConfig = extractAirbrakeConfig(config);
+ logger.debug('Starting application server...');
+ const router = await createRouter({
+ logger,
+ airbrakeConfig,
+ });
+
+ let service = createServiceBuilder(module)
+ .setPort(options.port)
+ .addRouter('/api/airbrake', router);
+ if (options.enableCors) {
+ logger.info('CORS is enabled, limiting to localhost with port 3000');
+ service = service.enableCors({ origin: 'http://localhost:3000' });
+ } else {
+ logger.info('CORS is disabled, allowing all origins');
+ service = service.enableCors({ origin: '*' });
+ }
+
+ return await service.start().catch(err => {
+ logger.error(err);
+ process.exit(1);
+ });
+}
+
+module.hot?.accept();
diff --git a/plugins/airbrake-backend/src/setupTests.ts b/plugins/airbrake-backend/src/setupTests.ts
new file mode 100644
index 0000000000..d3232290a7
--- /dev/null
+++ b/plugins/airbrake-backend/src/setupTests.ts
@@ -0,0 +1,17 @@
+/*
+ * 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.
+ */
+
+export {};
diff --git a/plugins/airbrake/CHANGELOG.md b/plugins/airbrake/CHANGELOG.md
index df784d0030..685ef4c0e7 100644
--- a/plugins/airbrake/CHANGELOG.md
+++ b/plugins/airbrake/CHANGELOG.md
@@ -1,5 +1,40 @@
# @backstage/plugin-airbrake
+## 0.3.0
+
+### Minor Changes
+
+- da78e79a94: This marks the first release where the Airbrake plugin is useable. Airbrake frontend and Airbrake backend work with each other. Currently just a summary of the latest Airbrakes is shown on Backstage.
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.8.10
+ - @backstage/plugin-catalog-react@0.7.0
+ - @backstage/catalog-model@0.11.0
+ - @backstage/core-plugin-api@0.7.0
+ - @backstage/dev-utils@0.2.23
+ - @backstage/test-utils@0.2.6
+
+## 0.2.0
+
+### Minor Changes
+
+- 9e505d20a3: API connectivity has added, but currently will only work by running it standalone on a browser with CORS disabled.
+
+### Patch Changes
+
+- 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- Updated dependencies
+ - @backstage/core-components@0.8.9
+ - @backstage/core-plugin-api@0.6.1
+ - @backstage/test-utils@0.2.5
+ - @backstage/plugin-catalog-react@0.6.15
+ - @backstage/catalog-model@0.10.0
+ - @backstage/dev-utils@0.2.22
+ - @backstage/theme@0.2.15
+
## 0.1.3
### Patch Changes
diff --git a/plugins/airbrake/README.md b/plugins/airbrake/README.md
index de041fb3ec..d5ea9bb006 100644
--- a/plugins/airbrake/README.md
+++ b/plugins/airbrake/README.md
@@ -1,13 +1,75 @@
# Airbrake
-Welcome to the Airbrake plugin!
+The Airbrake plugin provides connectivity between Backstage and Airbrake (https://airbrake.io/).
-This is a plugin providing connectivity between Backstage and Airbrake (https://airbrake.io/).
+## How to use
-_This plugin is currently not fit for use as it is work in progress_
+1. Install the Frontend plugin:
-## Getting started
+ ```bash
+ # From your Backstage root directory
+ cd packages/app
+ yarn add @backstage/plugin-airbrake
+ ```
-You can serve the plugin in isolation by running `yarn start` in the plugin directory.
-This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads.
-It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory.
+2. Install the Backend plugin:
+
+ ```bash
+ # From your Backstage root directory
+ cd packages/backend
+ yarn add @backstage/plugin-airbrake-backend
+ ```
+
+3. Add the `EntityAirbrakeContent` to `packages/app/src/components/catalog/EntityPage.tsx`:
+
+ ```typescript jsx
+ import { EntityAirbrakeContent } from '@backstage/plugin-airbrake';
+
+ const serviceEntityPage = (
+
+
+
+
+ );
+ ```
+
+4. Setup the Backend code in `packages/backend/src/index.ts`:
+
+ ```typescript
+ import {
+ createRouter as createAirbrakeRouter,
+ extractAirbrakeConfig,
+ } from '@backstage/plugin-airbrake-backend';
+
+ async function main() {
+ //... After const config = await loadBackendConfig({ ...
+
+ const airbrakeRouter = await createAirbrakeRouter({
+ logger,
+ airbrakeConfig: extractAirbrakeConfig(config),
+ });
+
+ const service = createServiceBuilder(module)
+ // ... Add the airbrakeRouter here
+ .addRouter('/api/airbrake', airbrakeRouter);
+ }
+ ```
+
+5. Add this config as a top level section in your `app-config.yaml`:
+
+ ```yaml
+ airbrake:
+ apiKey: ${AIRBRAKE_API_KEY}
+ ```
+
+6. Set an environment variable `AIRBRAKE_API_KEY` with your [API key](https://airbrake.io/docs/api/#authentication)
+ before starting Backstage backend.
+
+## Local Development
+
+Start this plugin in standalone mode by running `yarn start` inside the plugin directory. This method of serving the plugin provides quicker
+iteration speed and a faster startup and hot reloads. It is only meant for local development, and the setup for it can
+be found inside the [/dev](./dev) directory.
+
+> A mock API will be used to run it in standalone. If you want to talk to the real API [follow the instructions to start up Airbrake Backend in standalone](../airbrake-backend/README.md#local-development).
diff --git a/plugins/airbrake/api-report.md b/plugins/airbrake/api-report.md
index c01aa938ae..bd274e604d 100644
--- a/plugins/airbrake/api-report.md
+++ b/plugins/airbrake/api-report.md
@@ -8,9 +8,7 @@
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { RouteRef } from '@backstage/core-plugin-api';
-// Warning: (ae-missing-release-tag) "airbrakePlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export const airbrakePlugin: BackstagePlugin<
{
root: RouteRef;
@@ -18,10 +16,6 @@ export const airbrakePlugin: BackstagePlugin<
{}
>;
-// Warning: (ae-missing-release-tag) "EntityAirbrakeContent" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export const EntityAirbrakeContent: () => JSX.Element;
-
-// (No @packageDocumentation comment for this package)
```
diff --git a/plugins/airbrake/dev/components/ApiBar/ApiBar.tsx b/plugins/airbrake/dev/components/ApiBar/ApiBar.tsx
new file mode 100644
index 0000000000..7a4ee42f14
--- /dev/null
+++ b/plugins/airbrake/dev/components/ApiBar/ApiBar.tsx
@@ -0,0 +1,79 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import React from 'react';
+import {
+ createTheme,
+ makeStyles,
+ MuiThemeProvider,
+ TextField,
+} from '@material-ui/core';
+import { Context } from '../ContextProvider';
+
+const useStyles = makeStyles({
+ root: {
+ display: 'flex',
+ gap: '1em',
+ flexWrap: 'wrap',
+ },
+});
+
+const textFieldTheme = createTheme({
+ palette: {
+ type: 'dark',
+ primary: {
+ light: '#fff',
+ main: '#fff',
+ dark: '#fff',
+ contrastText: '#fff',
+ },
+ secondary: {
+ light: '#fff',
+ main: '#fff',
+ dark: '#fff',
+ contrastText: '#fff',
+ },
+ action: {
+ disabled: '#fff',
+ },
+ text: {
+ primary: '#fff',
+ secondary: '#fff',
+ },
+ },
+});
+
+export const ApiBar = () => {
+ const classes = useStyles();
+
+ return (
+
+ {value => (
+
+ );
+};
diff --git a/plugins/scaffolder-backend/src/lib/catalog/index.ts b/plugins/airbrake/dev/components/ApiBar/index.ts
similarity index 90%
rename from plugins/scaffolder-backend/src/lib/catalog/index.ts
rename to plugins/airbrake/dev/components/ApiBar/index.ts
index ea693b00b3..ff6e80d3d8 100644
--- a/plugins/scaffolder-backend/src/lib/catalog/index.ts
+++ b/plugins/airbrake/dev/components/ApiBar/index.ts
@@ -13,4 +13,5 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-export { CatalogEntityClient } from './CatalogEntityClient';
+
+export { ApiBar } from './ApiBar';
diff --git a/plugins/airbrake/dev/components/ContextProvider/ContextProvider.tsx b/plugins/airbrake/dev/components/ContextProvider/ContextProvider.tsx
new file mode 100644
index 0000000000..d46366d8f6
--- /dev/null
+++ b/plugins/airbrake/dev/components/ContextProvider/ContextProvider.tsx
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import React, {
+ Dispatch,
+ PropsWithChildren,
+ SetStateAction,
+ useState,
+} from 'react';
+
+interface ContextInterface {
+ projectId?: number;
+ setProjectId?: Dispatch>;
+}
+
+export const Context = React.createContext({});
+
+export const ContextProvider = ({ children }: PropsWithChildren<{}>) => {
+ const [projectId, setProjectId] = useState();
+
+ return (
+
+ {children}
+
+ );
+};
diff --git a/plugins/airbrake/dev/components/ContextProvider/index.ts b/plugins/airbrake/dev/components/ContextProvider/index.ts
new file mode 100644
index 0000000000..f1e350868a
--- /dev/null
+++ b/plugins/airbrake/dev/components/ContextProvider/index.ts
@@ -0,0 +1,17 @@
+/*
+ * 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.
+ */
+
+export { ContextProvider, Context } from './ContextProvider';
diff --git a/plugins/airbrake/dev/index.tsx b/plugins/airbrake/dev/index.tsx
index e74ce68ee5..a844dfdfdc 100644
--- a/plugins/airbrake/dev/index.tsx
+++ b/plugins/airbrake/dev/index.tsx
@@ -15,39 +15,74 @@
*/
import React from 'react';
import { createDevApp } from '@backstage/dev-utils';
-import { EntityAirbrakeContent, airbrakePlugin } from '../src/plugin';
+import { TestApiProvider } from '@backstage/test-utils';
+import { airbrakePlugin, EntityAirbrakeContent } from '../src';
import {
- Content,
- ContentHeader,
- Header,
- HeaderLabel,
- Page,
- SupportButton,
-} from '@backstage/core-components';
+ airbrakeApiRef,
+ localDiscoveryApi,
+ MockAirbrakeApi,
+ ProductionAirbrakeApi,
+} from '../src/api';
+import { ApiBar } from './components/ApiBar';
+import { Content, Header, Page } from '@backstage/core-components';
+import { EntityProvider } from '@backstage/plugin-catalog-react';
+import { createEntity } from '../src/api';
+import CloudOffIcon from '@material-ui/icons/CloudOff';
+import CloudIcon from '@material-ui/icons/Cloud';
+import { Context, ContextProvider } from './components/ContextProvider';
createDevApp()
.registerPlugin(airbrakePlugin)
.addPage({
element: (
-
-
+
-
-
- A description of your plugin goes here.
-
-
-
+
+
+
),
- title: 'Root Page',
- path: '/airbrake',
+ title: 'Mock API',
+ path: '/airbrake-mock-api',
+ icon: CloudOffIcon,
+ })
+ .addPage({
+ element: (
+
+
+
+
+
+
+ {value => (
+
+
+
+
+ )}
+
+
+
+
+ ),
+ title: 'Real API',
+ path: '/airbrake-real-api',
+ icon: CloudIcon,
})
.render();
diff --git a/plugins/airbrake/package.json b/plugins/airbrake/package.json
index 40b4787dd5..7342fdd839 100644
--- a/plugins/airbrake/package.json
+++ b/plugins/airbrake/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-airbrake",
- "version": "0.1.3",
+ "version": "0.3.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -9,55 +9,52 @@
"main": "dist/index.esm.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "frontend-plugin"
+ },
"scripts": {
- "build": "backstage-cli plugin:build",
- "start": "backstage-cli plugin:serve",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test",
+ "build": "backstage-cli package build",
+ "start": "backstage-cli package start",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
"diff": "backstage-cli plugin:diff",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean"
},
"dependencies": {
- "@backstage/core-components": "^0.8.8",
- "@backstage/core-plugin-api": "^0.6.0",
- "@backstage/theme": "^0.2.14",
+ "@backstage/catalog-model": "^0.11.0",
+ "@backstage/core-components": "^0.8.10",
+ "@backstage/core-plugin-api": "^0.7.0",
+ "@backstage/dev-utils": "^0.2.23",
+ "@backstage/plugin-catalog-react": "^0.7.0",
+ "@backstage/test-utils": "^0.2.6",
+ "@backstage/theme": "^0.2.15",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
"@material-ui/lab": "4.0.0-alpha.57",
- "react-use": "^17.2.4",
- "object-hash": "^2.2.0"
+ "object-hash": "^2.2.0",
+ "react-use": "^17.2.4"
},
"peerDependencies": {
"react": "^16.13.1 || ^17.0.0"
},
"devDependencies": {
- "@types/object-hash": "^2.2.1",
- "@backstage/app-defaults": "^0.1.7",
- "@backstage/cli": "^0.13.2",
- "@backstage/core-app-api": "^0.5.2",
- "@backstage/dev-utils": "^0.2.21",
- "@backstage/test-utils": "^0.2.4",
+ "@backstage/app-defaults": "^0.1.9",
+ "@backstage/cli": "^0.14.1",
+ "@backstage/dev-utils": "^0.2.23",
+ "@backstage/test-utils": "^0.2.6",
"@testing-library/jest-dom": "^5.10.1",
"@testing-library/react": "^11.2.5",
"@testing-library/user-event": "^13.1.8",
"@types/jest": "^26.0.7",
"@types/node": "^14.14.32",
- "msw": "^0.35.0",
+ "@types/object-hash": "^2.2.1",
"cross-fetch": "^3.1.5",
+ "msw": "^0.35.0",
"react-router": "6.0.0-beta.0"
},
"files": [
"dist"
- ],
- "jest": {
- "coverageThreshold": {
- "global": {
- "functions": 100,
- "lines": 100,
- "statements": 100
- }
- }
- }
+ ]
}
diff --git a/plugins/airbrake/src/api/AirbrakeApi.ts b/plugins/airbrake/src/api/AirbrakeApi.ts
new file mode 100644
index 0000000000..a29aa3eca7
--- /dev/null
+++ b/plugins/airbrake/src/api/AirbrakeApi.ts
@@ -0,0 +1,26 @@
+/*
+ * 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 { Groups } from './airbrakeGroups';
+import { createApiRef } from '@backstage/core-plugin-api';
+
+export const airbrakeApiRef = createApiRef({
+ id: 'plugin.airbrake.service',
+});
+
+export interface AirbrakeApi {
+ fetchGroups(projectId: string): Promise;
+}
diff --git a/plugins/airbrake/src/api/ProductionApi.test.ts b/plugins/airbrake/src/api/ProductionApi.test.ts
new file mode 100644
index 0000000000..f09127b4c2
--- /dev/null
+++ b/plugins/airbrake/src/api/ProductionApi.test.ts
@@ -0,0 +1,56 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { ProductionAirbrakeApi } from './ProductionApi';
+import { rest } from 'msw';
+import mockGroupsData from './mock/airbrakeGroupsApiMock.json';
+import { setupServer } from 'msw/node';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { localDiscoveryApi } from './mock';
+
+describe('The production Airbrake API', () => {
+ const productionApi = new ProductionAirbrakeApi(localDiscoveryApi);
+ const worker = setupServer();
+ setupRequestMockHandlers(worker);
+
+ it('fetches groups using the provided project ID', async () => {
+ worker.use(
+ rest.get(
+ 'http://localhost:7007/api/airbrake/api/v4/projects/123456/groups',
+ (_, res, ctx) => {
+ return res(ctx.status(200), ctx.json(mockGroupsData));
+ },
+ ),
+ );
+
+ const groups = await productionApi.fetchGroups('123456');
+
+ expect(groups).toStrictEqual(mockGroupsData);
+ });
+
+ it('throws if fetching groups was unsuccessful', async () => {
+ worker.use(
+ rest.get(
+ 'http://localhost:7007/api/airbrake/api/v4/projects/123456/groups',
+ (_, res, ctx) => {
+ return res(ctx.status(500));
+ },
+ ),
+ );
+
+ await expect(productionApi.fetchGroups('123456')).rejects.toThrow();
+ });
+});
diff --git a/plugins/airbrake/src/api/ProductionApi.ts b/plugins/airbrake/src/api/ProductionApi.ts
new file mode 100644
index 0000000000..21ca19ee7d
--- /dev/null
+++ b/plugins/airbrake/src/api/ProductionApi.ts
@@ -0,0 +1,36 @@
+/*
+ * 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 { Groups } from './airbrakeGroups';
+import { AirbrakeApi } from './AirbrakeApi';
+import { DiscoveryApi } from '@backstage/core-plugin-api';
+
+export class ProductionAirbrakeApi implements AirbrakeApi {
+ constructor(private readonly discoveryApi: DiscoveryApi) {}
+
+ async fetchGroups(projectId: string): Promise {
+ const baseUrl = await this.discoveryApi.getBaseUrl('airbrake');
+ const apiUrl = `${baseUrl}/api/v4/projects/${projectId}/groups`;
+
+ const response = await fetch(apiUrl);
+
+ if (response.status >= 400 && response.status < 600) {
+ throw new Error('Failed fetching Airbrake groups');
+ }
+
+ return (await response.json()) as Groups;
+ }
+}
diff --git a/plugins/airbrake/src/api/airbrakeGroups.d.ts b/plugins/airbrake/src/api/airbrakeGroups.d.ts
new file mode 100644
index 0000000000..e1887eca9b
--- /dev/null
+++ b/plugins/airbrake/src/api/airbrakeGroups.d.ts
@@ -0,0 +1,65 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface Groups {
+ count: number;
+ end: string;
+ groups?: Group[] | null;
+ page: number;
+ resolvedCount: number;
+ unresolvedCount: number;
+}
+
+export interface Group {
+ id: string;
+ projectId: number;
+ resolved: boolean;
+ muted: boolean;
+ mutedBy: number;
+ mutedAt?: string | null;
+ errors?: Error[];
+ attributes?: string | null;
+ context: Context;
+ lastDeployId: string;
+ lastDeployAt?: string | null;
+ lastNoticeId: string;
+ lastNoticeAt: string;
+ noticeCount: number;
+ noticeTotalCount: number;
+ commentCount: number;
+ createdAt: string;
+}
+
+export interface Error {
+ type: string;
+ message: string;
+ backtrace?: Backtrace[];
+}
+
+export interface Backtrace {
+ file: string;
+ function: string;
+ line: number;
+ column: number;
+ code?: string | null;
+}
+
+export interface Context {
+ action: string;
+ component: string;
+ environment: string;
+ severity: string;
+}
diff --git a/plugins/airbrake/src/api/index.ts b/plugins/airbrake/src/api/index.ts
new file mode 100644
index 0000000000..2d92789653
--- /dev/null
+++ b/plugins/airbrake/src/api/index.ts
@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+export * from './mock';
+export type { AirbrakeApi } from './AirbrakeApi';
+export { airbrakeApiRef } from './AirbrakeApi';
+export type { Groups } from './airbrakeGroups';
+export { ProductionAirbrakeApi } from './ProductionApi';
diff --git a/plugins/airbrake/src/api/mock/LocalDiscoveryApi.ts b/plugins/airbrake/src/api/mock/LocalDiscoveryApi.ts
new file mode 100644
index 0000000000..c3080a8104
--- /dev/null
+++ b/plugins/airbrake/src/api/mock/LocalDiscoveryApi.ts
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { DiscoveryApi } from '@backstage/core-plugin-api';
+
+export const localDiscoveryApi: DiscoveryApi = {
+ async getBaseUrl(pluginId: string): Promise {
+ return `http://localhost:7007/api/${pluginId}`;
+ },
+};
diff --git a/plugins/catalog-backend/src/util/timing.ts b/plugins/airbrake/src/api/mock/MockApi.ts
similarity index 53%
rename from plugins/catalog-backend/src/util/timing.ts
rename to plugins/airbrake/src/api/mock/MockApi.ts
index b5f9eb258f..dbb1d5c049 100644
--- a/plugins/catalog-backend/src/util/timing.ts
+++ b/plugins/airbrake/src/api/mock/MockApi.ts
@@ -14,18 +14,20 @@
* limitations under the License.
*/
-/**
- * Returns a string with the elapsed time since the start of an operation,
- * with some human friendly precision, e.g. "133ms" or "14.5s".
- *
- * @param startTimestamp - The timestamp (from process.hrtime()) at the start ot
- * the operation
- */
-export function durationText(startTimestamp: [number, number]): string {
- const delta = process.hrtime(startTimestamp);
- const seconds = delta[0] + delta[1] / 1e9;
- if (seconds > 1) {
- return `${seconds.toFixed(1)}s`;
+import { Groups } from '../airbrakeGroups';
+import { AirbrakeApi } from '../AirbrakeApi';
+import mockGroupsData from './airbrakeGroupsApiMock.json';
+
+export class MockAirbrakeApi implements AirbrakeApi {
+ waitTimeInMillis: number;
+
+ constructor(waitTimeInMillis = 10) {
+ this.waitTimeInMillis = waitTimeInMillis;
+ }
+
+ fetchGroups(): Promise {
+ return new Promise(resolve => {
+ setTimeout(() => resolve(mockGroupsData), this.waitTimeInMillis);
+ });
}
- return `${(seconds * 1000).toFixed(0)}ms`;
}
diff --git a/plugins/airbrake/src/api/mock/MockEntity.ts b/plugins/airbrake/src/api/mock/MockEntity.ts
new file mode 100644
index 0000000000..13534f2458
--- /dev/null
+++ b/plugins/airbrake/src/api/mock/MockEntity.ts
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { AIRBRAKE_PROJECT_ID_ANNOTATION } from '../../components/useProjectId';
+import { Entity } from '@backstage/catalog-model';
+
+export const createEntity = (projectId?: number) => {
+ const projectIdString = projectId?.toString();
+
+ return {
+ apiVersion: 'backstage.io/v1alpha1',
+ kind: 'Component',
+ metadata: {
+ annotations: {
+ [AIRBRAKE_PROJECT_ID_ANNOTATION]: projectIdString,
+ },
+ name: projectIdString,
+ },
+ } as Entity;
+};
diff --git a/plugins/airbrake/src/components/EntityAirbrakeContent/example-data.json b/plugins/airbrake/src/api/mock/airbrakeGroupsApiMock.json
similarity index 100%
rename from plugins/airbrake/src/components/EntityAirbrakeContent/example-data.json
rename to plugins/airbrake/src/api/mock/airbrakeGroupsApiMock.json
diff --git a/plugins/airbrake/src/api/mock/index.ts b/plugins/airbrake/src/api/mock/index.ts
new file mode 100644
index 0000000000..4e0ab5fabf
--- /dev/null
+++ b/plugins/airbrake/src/api/mock/index.ts
@@ -0,0 +1,19 @@
+/*
+ * 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.
+ */
+
+export * from './MockApi';
+export * from './MockEntity';
+export * from './LocalDiscoveryApi';
diff --git a/plugins/airbrake/src/components/EntityAirbrakeContent/EntityAirbrakeContent.tsx b/plugins/airbrake/src/components/EntityAirbrakeContent/EntityAirbrakeContent.tsx
deleted file mode 100644
index 062d9e898a..0000000000
--- a/plugins/airbrake/src/components/EntityAirbrakeContent/EntityAirbrakeContent.tsx
+++ /dev/null
@@ -1,48 +0,0 @@
-/*
- * Copyright 2021 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 { Grid, Typography } from '@material-ui/core';
-import { InfoCard } from '@backstage/core-components';
-import exampleData from './example-data.json';
-import hash from 'object-hash';
-import { makeStyles } from '@material-ui/core/styles';
-import { BackstageTheme } from '@backstage/theme';
-
-const useStyles = makeStyles(() => ({
- multilineText: {
- whiteSpace: 'pre-wrap',
- },
-}));
-
-export const EntityAirbrakeContent = () => {
- const classes = useStyles();
-
- return (
-
- {exampleData.groups.map(group => (
-
- {group.errors.map(error => (
-
-
- {error.message}
-
-
- ))}
-
- ))}
-
- );
-};
diff --git a/plugins/airbrake/src/components/EntityAirbrakeWidget/EntityAirbrakeWidget.test.tsx b/plugins/airbrake/src/components/EntityAirbrakeWidget/EntityAirbrakeWidget.test.tsx
new file mode 100644
index 0000000000..ee14a17f9a
--- /dev/null
+++ b/plugins/airbrake/src/components/EntityAirbrakeWidget/EntityAirbrakeWidget.test.tsx
@@ -0,0 +1,96 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import React from 'react';
+import { EntityAirbrakeWidget } from './EntityAirbrakeWidget';
+import exampleData from '../../api/mock/airbrakeGroupsApiMock.json';
+import {
+ MockErrorApi,
+ renderInTestApp,
+ setupRequestMockHandlers,
+ TestApiProvider,
+} from '@backstage/test-utils';
+import { createEntity } from '../../api';
+import {
+ airbrakeApiRef,
+ localDiscoveryApi,
+ MockAirbrakeApi,
+ ProductionAirbrakeApi,
+} from '../../api';
+import { errorApiRef } from '@backstage/core-plugin-api';
+import { rest } from 'msw';
+import { setupServer } from 'msw/node';
+
+describe('EntityAirbrakeContent', () => {
+ const worker = setupServer();
+ setupRequestMockHandlers(worker);
+
+ it('renders all errors sent from Airbrake', async () => {
+ const widget = await renderInTestApp(
+
+ ,
+ );
+ expect(exampleData.groups.length).toBeGreaterThan(0);
+ for (const group of exampleData.groups) {
+ expect(
+ await widget.getByText(group.errors[0].message),
+ ).toBeInTheDocument();
+ }
+ });
+
+ it('states that the annotation is missing if no project ID annotation is provided', async () => {
+ const widget = await renderInTestApp(
+
+ ,
+ );
+ await expect(
+ widget.findByText('Missing Annotation'),
+ ).resolves.toBeInTheDocument();
+ });
+
+ it('states that an error occurred if the API call fails', async () => {
+ worker.use(
+ rest.get(
+ 'http://localhost:7007/api/airbrake/api/v4/projects/123/groups',
+ (_, res, ctx) => {
+ return res(ctx.status(500));
+ },
+ ),
+ );
+ const mockErrorApi = new MockErrorApi({ collect: true });
+
+ const widget = await renderInTestApp(
+
+ ,
+ );
+
+ await expect(
+ widget.findByText(/.*there was an issue communicating with Airbrake.*/),
+ ).resolves.toBeInTheDocument();
+ expect(mockErrorApi.getErrors().length).toBe(1);
+ expect(mockErrorApi.getErrors()[0].error.message).toStrictEqual(
+ 'Failed fetching Airbrake groups',
+ );
+ });
+});
diff --git a/plugins/airbrake/src/components/EntityAirbrakeWidget/EntityAirbrakeWidget.tsx b/plugins/airbrake/src/components/EntityAirbrakeWidget/EntityAirbrakeWidget.tsx
new file mode 100644
index 0000000000..b11116aeef
--- /dev/null
+++ b/plugins/airbrake/src/components/EntityAirbrakeWidget/EntityAirbrakeWidget.tsx
@@ -0,0 +1,94 @@
+/*
+ * Copyright 2021 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 '@backstage/catalog-model';
+import React, { useEffect } from 'react';
+import { Grid, Typography } from '@material-ui/core';
+import {
+ EmptyState,
+ InfoCard,
+ MissingAnnotationEmptyState,
+ Progress,
+} from '@backstage/core-components';
+import hash from 'object-hash';
+import { makeStyles } from '@material-ui/core/styles';
+import { BackstageTheme } from '@backstage/theme';
+import { ErrorApi, errorApiRef, useApi } from '@backstage/core-plugin-api';
+import { airbrakeApiRef } from '../../api';
+import useAsync from 'react-use/lib/useAsync';
+import { AIRBRAKE_PROJECT_ID_ANNOTATION, useProjectId } from '../useProjectId';
+
+const useStyles = makeStyles(() => ({
+ multilineText: {
+ whiteSpace: 'pre-wrap',
+ },
+}));
+
+export const EntityAirbrakeWidget = ({ entity }: { entity: Entity }) => {
+ const classes = useStyles();
+
+ const projectId = useProjectId(entity);
+ const errorApi = useApi(errorApiRef);
+ const airbrakeApi = useApi(airbrakeApiRef);
+
+ const { loading, value, error } = useAsync(
+ () => airbrakeApi.fetchGroups(projectId),
+ [airbrakeApi, projectId],
+ );
+
+ useEffect(() => {
+ if (error) {
+ errorApi.post(error);
+ }
+ }, [error, errorApi]);
+
+ if (loading || !projectId || error) {
+ return (
+
+ {loading && }
+
+ {!loading && !projectId && (
+
+ );
+ }
+
+ return (
+
+ {value?.groups?.map(group => (
+
+ {group.errors?.map(groupError => (
+
+
+ {groupError.message}
+
+
+ ))}
+
+ ))}
+
+ );
+};
diff --git a/plugins/airbrake/src/components/EntityAirbrakeWidget/index.ts b/plugins/airbrake/src/components/EntityAirbrakeWidget/index.ts
new file mode 100644
index 0000000000..0a85263c5f
--- /dev/null
+++ b/plugins/airbrake/src/components/EntityAirbrakeWidget/index.ts
@@ -0,0 +1,17 @@
+/*
+ * 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.
+ */
+
+export { EntityAirbrakeWidget } from './EntityAirbrakeWidget';
diff --git a/plugins/airbrake/src/components/useProjectId.ts b/plugins/airbrake/src/components/useProjectId.ts
new file mode 100644
index 0000000000..3402778b7b
--- /dev/null
+++ b/plugins/airbrake/src/components/useProjectId.ts
@@ -0,0 +1,23 @@
+/*
+ * 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 { Entity } from '@backstage/catalog-model';
+
+export const AIRBRAKE_PROJECT_ID_ANNOTATION = 'airbrake.io/project-id';
+
+export const useProjectId = (entity: Entity) => {
+ return entity?.metadata.annotations?.[AIRBRAKE_PROJECT_ID_ANNOTATION] ?? '';
+};
diff --git a/plugins/airbrake/src/extensions.test.tsx b/plugins/airbrake/src/extensions.test.tsx
new file mode 100644
index 0000000000..05afe8f1e3
--- /dev/null
+++ b/plugins/airbrake/src/extensions.test.tsx
@@ -0,0 +1,37 @@
+/*
+ * Copyright 2021 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 { EntityAirbrakeContent } from './extensions';
+import { Route } from 'react-router';
+import { renderInTestApp, TestApiProvider } from '@backstage/test-utils';
+import { airbrakeApiRef, MockAirbrakeApi } from './api';
+import { createEntity } from './api';
+import { EntityProvider } from '@backstage/plugin-catalog-react';
+
+describe('The Airbrake entity', () => {
+ it('should render the content properly', async () => {
+ const rendered = await renderInTestApp(
+
+
+
+ ,
+ );
+ await expect(
+ rendered.findByText('ChunkLoadError'),
+ ).resolves.toBeInTheDocument();
+ });
+});
diff --git a/plugins/airbrake/src/extensions.tsx b/plugins/airbrake/src/extensions.tsx
new file mode 100644
index 0000000000..d4f890f44a
--- /dev/null
+++ b/plugins/airbrake/src/extensions.tsx
@@ -0,0 +1,42 @@
+/*
+ * 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 { useEntity } from '@backstage/plugin-catalog-react';
+import React from 'react';
+import { airbrakePlugin } from './plugin';
+import { createRoutableExtension } from '@backstage/core-plugin-api';
+import { rootRouteRef } from './routes';
+
+/**
+ * This is the widget that shows up on a component page
+ *
+ * @public
+ */
+export const EntityAirbrakeContent = airbrakePlugin.provide(
+ createRoutableExtension({
+ name: 'EntityAirbrakeContent',
+ mountPoint: rootRouteRef,
+ component: () =>
+ import('./components/EntityAirbrakeWidget').then(
+ ({ EntityAirbrakeWidget }) => {
+ return () => {
+ const { entity } = useEntity();
+ return ();
const config = useApi(apiDocsConfigRef);
const { getApiDefinitionWidget } = config;
diff --git a/plugins/api-docs/src/components/ApiExplorerPage/DefaultApiExplorerPage.test.tsx b/plugins/api-docs/src/components/ApiExplorerPage/DefaultApiExplorerPage.test.tsx
index 9e4c861e24..16b335b0a7 100644
--- a/plugins/api-docs/src/components/ApiExplorerPage/DefaultApiExplorerPage.test.tsx
+++ b/plugins/api-docs/src/components/ApiExplorerPage/DefaultApiExplorerPage.test.tsx
@@ -56,8 +56,8 @@ describe('DefaultApiExplorerPage', () => {
},
] as Entity[],
}),
- getLocationByEntity: () =>
- Promise.resolve({ id: 'id', type: 'github', target: 'url' }),
+ getLocationByRef: () =>
+ Promise.resolve({ id: 'id', type: 'url', target: 'url' }),
getEntityByName: async entityName => {
return {
apiVersion: 'backstage.io/v1alpha1',
@@ -66,7 +66,8 @@ describe('DefaultApiExplorerPage', () => {
relations: [
{
type: RELATION_MEMBER_OF,
- target: { namespace: 'default', kind: 'Group', name: 'tools' },
+ targetRef: 'group:default/tools',
+ target: { namespace: 'default', kind: 'group', name: 'tools' },
},
],
};
diff --git a/plugins/api-docs/src/components/ApisCards/ConsumedApisCard.test.tsx b/plugins/api-docs/src/components/ApisCards/ConsumedApisCard.test.tsx
index 5e7b22524a..f84f66cee8 100644
--- a/plugins/api-docs/src/components/ApisCards/ConsumedApisCard.test.tsx
+++ b/plugins/api-docs/src/components/ApisCards/ConsumedApisCard.test.tsx
@@ -36,7 +36,7 @@ describe(' = {
getToken: jest.fn(),
@@ -79,8 +79,9 @@ describe('CatalogIdentityClient', () => {
relations: [
{
type: RELATION_MEMBER_OF,
+ targetRef: 'group:default/team-a',
target: {
- kind: 'Group',
+ kind: 'group',
namespace: 'default',
name: 'team-a',
},
@@ -100,8 +101,9 @@ describe('CatalogIdentityClient', () => {
relations: [
{
type: RELATION_MEMBER_OF,
+ targetRef: 'group:reality/screen-actors-guild',
target: {
- kind: 'Group',
+ kind: 'group',
namespace: 'reality',
name: 'screen-actors-guild',
},
diff --git a/plugins/auth-backend/src/lib/catalog/CatalogIdentityClient.ts b/plugins/auth-backend/src/lib/catalog/CatalogIdentityClient.ts
index aecf018975..d948af2e05 100644
--- a/plugins/auth-backend/src/lib/catalog/CatalogIdentityClient.ts
+++ b/plugins/auth-backend/src/lib/catalog/CatalogIdentityClient.ts
@@ -120,11 +120,11 @@ export class CatalogIdentityClient {
e =>
e!.relations
?.filter(r => r.type === RELATION_MEMBER_OF)
- .map(r => r.target) ?? [],
+ .map(r => r.targetRef) ?? [],
);
const newEntityRefs = [
- ...new Set(resolvedEntityRefs.concat(memberOf).map(stringifyEntityRef)),
+ ...new Set(resolvedEntityRefs.map(stringifyEntityRef).concat(memberOf)),
];
logger?.debug(`Found catalog membership: ${newEntityRefs.join()}`);
diff --git a/plugins/auth-backend/src/lib/catalog/helpers.ts b/plugins/auth-backend/src/lib/catalog/helpers.ts
index 61dc428b3f..db9b38e2a6 100644
--- a/plugins/auth-backend/src/lib/catalog/helpers.ts
+++ b/plugins/auth-backend/src/lib/catalog/helpers.ts
@@ -27,11 +27,9 @@ export function getEntityClaims(entity: UserEntity): TokenParams['claims'] {
const membershipRefs =
entity.relations
?.filter(
- r =>
- r.type === RELATION_MEMBER_OF &&
- r.target.kind.toLocaleLowerCase('en-US') === 'group',
+ r => r.type === RELATION_MEMBER_OF && r.targetRef.startsWith('group:'),
)
- .map(r => stringifyEntityRef(r.target)) ?? [];
+ .map(r => r.targetRef) ?? [];
return {
sub: userRef,
diff --git a/plugins/auth-backend/src/providers/github/provider.ts b/plugins/auth-backend/src/providers/github/provider.ts
index ec7f8cafa6..29e8679fe0 100644
--- a/plugins/auth-backend/src/providers/github/provider.ts
+++ b/plugins/auth-backend/src/providers/github/provider.ts
@@ -14,6 +14,10 @@
* limitations under the License.
*/
+import {
+ DEFAULT_NAMESPACE,
+ stringifyEntityRef,
+} from '@backstage/catalog-model';
import express from 'express';
import { Logger } from 'winston';
import { Profile as PassportProfile } from 'passport';
@@ -247,10 +251,16 @@ export const githubDefaultSignInResolver: SignInResolver<
const userId = fullProfile.username || fullProfile.id;
+ const entityRef = stringifyEntityRef({
+ kind: 'User',
+ namespace: DEFAULT_NAMESPACE,
+ name: userId,
+ });
+
const token = await ctx.tokenIssuer.issueToken({
claims: {
- sub: `user:default/${userId}`,
- ent: [`user:default/${userId}`],
+ sub: entityRef,
+ ent: [entityRef],
},
});
diff --git a/plugins/auth-backend/src/providers/gitlab/provider.ts b/plugins/auth-backend/src/providers/gitlab/provider.ts
index 6689aba884..59f9a5a4cb 100644
--- a/plugins/auth-backend/src/providers/gitlab/provider.ts
+++ b/plugins/auth-backend/src/providers/gitlab/provider.ts
@@ -14,10 +14,13 @@
* limitations under the License.
*/
+import {
+ DEFAULT_NAMESPACE,
+ stringifyEntityRef,
+} from '@backstage/catalog-model';
import express from 'express';
import { Strategy as GitlabStrategy } from 'passport-gitlab2';
import { Logger } from 'winston';
-
import {
executeRedirectStrategy,
executeFrameHandlerStrategy,
@@ -71,8 +74,17 @@ export const gitlabDefaultSignInResolver: SignInResolver = async (
id = profile.email.split('@')[0];
}
+ const entityRef = stringifyEntityRef({
+ kind: 'User',
+ namespace: DEFAULT_NAMESPACE,
+ name: id,
+ });
+
const token = await ctx.tokenIssuer.issueToken({
- claims: { sub: `user:default/${id}`, ent: [`user:default/${id}`] },
+ claims: {
+ sub: entityRef,
+ ent: [entityRef],
+ },
});
return { id, token };
diff --git a/plugins/auth-backend/src/providers/google/provider.ts b/plugins/auth-backend/src/providers/google/provider.ts
index fbaf8c7462..e5e5698ec4 100644
--- a/plugins/auth-backend/src/providers/google/provider.ts
+++ b/plugins/auth-backend/src/providers/google/provider.ts
@@ -14,6 +14,10 @@
* limitations under the License.
*/
+import {
+ DEFAULT_NAMESPACE,
+ stringifyEntityRef,
+} from '@backstage/catalog-model';
import express from 'express';
import passport from 'passport';
import { Strategy as GoogleStrategy } from 'passport-google-oauth20';
@@ -226,8 +230,17 @@ const googleDefaultSignInResolver: SignInResolver = async (
userId = profile.email.split('@')[0];
}
+ const entityRef = stringifyEntityRef({
+ kind: 'User',
+ namespace: DEFAULT_NAMESPACE,
+ name: userId,
+ });
+
const token = await ctx.tokenIssuer.issueToken({
- claims: { sub: `user:default/${userId}`, ent: [`user:default/${userId}`] },
+ claims: {
+ sub: entityRef,
+ ent: [entityRef],
+ },
});
return { id: userId, token };
diff --git a/plugins/auth-backend/src/providers/microsoft/provider.ts b/plugins/auth-backend/src/providers/microsoft/provider.ts
index 25c940547b..98f94811bd 100644
--- a/plugins/auth-backend/src/providers/microsoft/provider.ts
+++ b/plugins/auth-backend/src/providers/microsoft/provider.ts
@@ -14,6 +14,10 @@
* limitations under the License.
*/
+import {
+ DEFAULT_NAMESPACE,
+ stringifyEntityRef,
+} from '@backstage/catalog-model';
import express from 'express';
import passport from 'passport';
import { Strategy as MicrosoftStrategy } from 'passport-microsoft';
@@ -231,10 +235,16 @@ export const microsoftDefaultSignInResolver: SignInResolver<
const userId = profile.email.split('@')[0];
+ const entityRef = stringifyEntityRef({
+ kind: 'User',
+ namespace: DEFAULT_NAMESPACE,
+ name: userId,
+ });
+
const token = await ctx.tokenIssuer.issueToken({
claims: {
- sub: `user:default/${userId}`,
- ent: [`user:default/${userId}`],
+ sub: entityRef,
+ ent: [entityRef],
},
});
diff --git a/plugins/auth-backend/src/providers/oauth2/index.ts b/plugins/auth-backend/src/providers/oauth2/index.ts
index 767466f8f6..d68208a148 100644
--- a/plugins/auth-backend/src/providers/oauth2/index.ts
+++ b/plugins/auth-backend/src/providers/oauth2/index.ts
@@ -15,5 +15,4 @@
*/
export { createOAuth2Provider } from './provider';
-
export type { OAuth2ProviderOptions } from './provider';
diff --git a/plugins/auth-backend/src/providers/oauth2/provider.ts b/plugins/auth-backend/src/providers/oauth2/provider.ts
index 0906005791..d09337f5ad 100644
--- a/plugins/auth-backend/src/providers/oauth2/provider.ts
+++ b/plugins/auth-backend/src/providers/oauth2/provider.ts
@@ -14,6 +14,10 @@
* limitations under the License.
*/
+import {
+ DEFAULT_NAMESPACE,
+ stringifyEntityRef,
+} from '@backstage/catalog-model';
import express from 'express';
import passport from 'passport';
import { Strategy as OAuth2Strategy } from 'passport-oauth2';
@@ -210,8 +214,17 @@ export const oAuth2DefaultSignInResolver: SignInResolver = async (
const userId = profile.email.split('@')[0];
+ const entityRef = stringifyEntityRef({
+ kind: 'User',
+ namespace: DEFAULT_NAMESPACE,
+ name: userId,
+ });
+
const token = await ctx.tokenIssuer.issueToken({
- claims: { sub: `user:default/${userId}`, ent: [`user:default/${userId}`] },
+ claims: {
+ sub: entityRef,
+ ent: [entityRef],
+ },
});
return { id: userId, token };
diff --git a/plugins/auth-backend/src/providers/oidc/index.ts b/plugins/auth-backend/src/providers/oidc/index.ts
index 39bd02928d..e63c9920df 100644
--- a/plugins/auth-backend/src/providers/oidc/index.ts
+++ b/plugins/auth-backend/src/providers/oidc/index.ts
@@ -13,5 +13,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
export type { OidcAuthResult, OidcProviderOptions } from './provider';
export { createOidcProvider } from './provider';
diff --git a/plugins/auth-backend/src/providers/oidc/provider.ts b/plugins/auth-backend/src/providers/oidc/provider.ts
index 9ccdf25f74..b4f34cd127 100644
--- a/plugins/auth-backend/src/providers/oidc/provider.ts
+++ b/plugins/auth-backend/src/providers/oidc/provider.ts
@@ -14,6 +14,10 @@
* limitations under the License.
*/
+import {
+ DEFAULT_NAMESPACE,
+ stringifyEntityRef,
+} from '@backstage/catalog-model';
import express from 'express';
import {
Client,
@@ -211,21 +215,31 @@ export class OidcAuthProvider implements OAuthHandlers {
}
}
-export const oAuth2DefaultSignInResolver: SignInResolver<
- OidcAuthResult
-> = async (info, ctx) => {
+export const oidcDefaultSignInResolver: SignInResolver = async (
+ info,
+ ctx,
+) => {
const { profile } = info;
if (!profile.email) {
throw new Error('Profile contained no email');
}
+
const userId = profile.email.split('@')[0];
+
+ const entityRef = stringifyEntityRef({
+ kind: 'User',
+ namespace: DEFAULT_NAMESPACE,
+ name: userId,
+ });
+
const token = await ctx.tokenIssuer.issueToken({
claims: {
- sub: `user:default/${userId}`,
- ent: [`user:default/${userId}`],
+ sub: entityRef,
+ ent: [entityRef],
},
});
+
return { id: userId, token };
};
@@ -289,7 +303,7 @@ export const createOidcProvider = (
},
});
const signInResolverFn =
- options?.signIn?.resolver ?? oAuth2DefaultSignInResolver;
+ options?.signIn?.resolver ?? oidcDefaultSignInResolver;
const signInResolver: SignInResolver = info =>
signInResolverFn(info, {
catalogIdentityClient,
diff --git a/plugins/auth-backend/src/providers/okta/provider.ts b/plugins/auth-backend/src/providers/okta/provider.ts
index 0ba7d241d3..26f586c578 100644
--- a/plugins/auth-backend/src/providers/okta/provider.ts
+++ b/plugins/auth-backend/src/providers/okta/provider.ts
@@ -13,6 +13,11 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
+import {
+ DEFAULT_NAMESPACE,
+ stringifyEntityRef,
+} from '@backstage/catalog-model';
import express from 'express';
import {
OAuthAdapter,
@@ -235,8 +240,17 @@ export const oktaDefaultSignInResolver: SignInResolver = async (
// TODO(Rugvip): Hardcoded to the local part of the email for now
const userId = profile.email.split('@')[0];
+ const entityRef = stringifyEntityRef({
+ kind: 'User',
+ namespace: DEFAULT_NAMESPACE,
+ name: userId,
+ });
+
const token = await ctx.tokenIssuer.issueToken({
- claims: { sub: `user:default/${userId}`, ent: [`user:default/${userId}`] },
+ claims: {
+ sub: entityRef,
+ ent: [entityRef],
+ },
});
return { id: userId, token };
diff --git a/plugins/auth-backend/src/providers/saml/provider.ts b/plugins/auth-backend/src/providers/saml/provider.ts
index 1ca8cf0d5d..4458d423ef 100644
--- a/plugins/auth-backend/src/providers/saml/provider.ts
+++ b/plugins/auth-backend/src/providers/saml/provider.ts
@@ -14,6 +14,10 @@
* limitations under the License.
*/
+import {
+ DEFAULT_NAMESPACE,
+ stringifyEntityRef,
+} from '@backstage/catalog-model';
import express from 'express';
import { SamlConfig } from 'passport-saml/lib/passport-saml/types';
import {
@@ -150,8 +154,17 @@ const samlDefaultSignInResolver: SignInResolver = async (
) => {
const id = info.result.fullProfile.nameID;
+ const entityRef = stringifyEntityRef({
+ kind: 'User',
+ namespace: DEFAULT_NAMESPACE,
+ name: id,
+ });
+
const token = await ctx.tokenIssuer.issueToken({
- claims: { sub: id },
+ claims: {
+ sub: entityRef,
+ ent: [entityRef],
+ },
});
return { id, token };
diff --git a/plugins/auth-node/CHANGELOG.md b/plugins/auth-node/CHANGELOG.md
index a5103ea034..7676ce7afa 100644
--- a/plugins/auth-node/CHANGELOG.md
+++ b/plugins/auth-node/CHANGELOG.md
@@ -1,5 +1,36 @@
# @backstage/plugin-auth-node
+## 0.1.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.11.0
+ - @backstage/catalog-model@0.11.0
+
+## 0.1.2
+
+### Patch Changes
+
+- Fix for the previous release with missing type declarations.
+- Updated dependencies
+ - @backstage/backend-common@0.10.9
+ - @backstage/catalog-model@0.10.1
+ - @backstage/config@0.1.15
+ - @backstage/errors@0.2.2
+
+## 0.1.1
+
+### Patch Changes
+
+- 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- Updated dependencies
+ - @backstage/backend-common@0.10.8
+ - @backstage/errors@0.2.1
+ - @backstage/catalog-model@0.10.0
+ - @backstage/config@0.1.14
+
## 0.1.0
### Minor Changes
diff --git a/plugins/auth-node/package.json b/plugins/auth-node/package.json
index 4e059c5e19..2becee849d 100644
--- a/plugins/auth-node/package.json
+++ b/plugins/auth-node/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-node",
- "version": "0.1.0",
+ "version": "0.1.3",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -10,25 +10,29 @@
"main": "dist/index.cjs.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "node-library"
+ },
"scripts": {
- "build": "backstage-cli backend:build",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean",
+ "start": "backstage-cli package start"
},
"dependencies": {
- "@backstage/backend-common": "^0.10.7",
- "@backstage/catalog-model": "^0.9.10",
- "@backstage/config": "^0.1.13",
- "@backstage/errors": "^0.2.0",
+ "@backstage/backend-common": "^0.11.0",
+ "@backstage/catalog-model": "^0.11.0",
+ "@backstage/config": "^0.1.15",
+ "@backstage/errors": "^0.2.2",
"jose": "^1.27.1",
"node-fetch": "^2.6.7",
"winston": "^3.2.1"
},
"devDependencies": {
- "@backstage/cli": "^0.13.2",
+ "@backstage/cli": "^0.14.1",
"msw": "^0.35.0",
"uuid": "^8.0.0"
},
diff --git a/plugins/azure-devops-backend/CHANGELOG.md b/plugins/azure-devops-backend/CHANGELOG.md
index 0b44be4e13..0156f92891 100644
--- a/plugins/azure-devops-backend/CHANGELOG.md
+++ b/plugins/azure-devops-backend/CHANGELOG.md
@@ -1,5 +1,32 @@
# @backstage/plugin-azure-devops-backend
+## 0.3.6
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.11.0
+
+## 0.3.5
+
+### Patch Changes
+
+- Fix for the previous release with missing type declarations.
+- Updated dependencies
+ - @backstage/backend-common@0.10.9
+ - @backstage/config@0.1.15
+ - @backstage/plugin-azure-devops-common@0.2.2
+
+## 0.3.4
+
+### Patch Changes
+
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- Updated dependencies
+ - @backstage/backend-common@0.10.8
+ - @backstage/config@0.1.14
+ - @backstage/plugin-azure-devops-common@0.2.1
+
## 0.3.3
### Patch Changes
diff --git a/plugins/azure-devops-backend/package.json b/plugins/azure-devops-backend/package.json
index a87a48046e..206294c863 100644
--- a/plugins/azure-devops-backend/package.json
+++ b/plugins/azure-devops-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-azure-devops-backend",
- "version": "0.3.3",
+ "version": "0.3.6",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -10,19 +10,22 @@
"main": "dist/index.cjs.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "backend-plugin"
+ },
"scripts": {
- "start": "backstage-cli backend:dev",
- "build": "backstage-cli backend:build",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "start": "backstage-cli package start",
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean"
},
"dependencies": {
- "@backstage/backend-common": "^0.10.7",
- "@backstage/config": "^0.1.13",
- "@backstage/plugin-azure-devops-common": "^0.2.0",
+ "@backstage/backend-common": "^0.11.0",
+ "@backstage/config": "^0.1.15",
+ "@backstage/plugin-azure-devops-common": "^0.2.2",
"@types/express": "^4.17.6",
"azure-devops-node-api": "^11.0.1",
"express": "^4.17.1",
@@ -32,7 +35,7 @@
"yn": "^4.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.13.2",
+ "@backstage/cli": "^0.14.1",
"@types/supertest": "^2.0.8",
"supertest": "^6.1.6",
"msw": "^0.35.0"
diff --git a/plugins/azure-devops-common/CHANGELOG.md b/plugins/azure-devops-common/CHANGELOG.md
index 74129ea19e..65eaa862fb 100644
--- a/plugins/azure-devops-common/CHANGELOG.md
+++ b/plugins/azure-devops-common/CHANGELOG.md
@@ -1,5 +1,17 @@
# @backstage/plugin-azure-devops-common
+## 0.2.2
+
+### Patch Changes
+
+- Fix for the previous release with missing type declarations.
+
+## 0.2.1
+
+### Patch Changes
+
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+
## 0.2.0
### Minor Changes
diff --git a/plugins/azure-devops-common/package.json b/plugins/azure-devops-common/package.json
index 02faebca61..7810469bf9 100644
--- a/plugins/azure-devops-common/package.json
+++ b/plugins/azure-devops-common/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-azure-devops-common",
- "version": "0.2.0",
+ "version": "0.2.2",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -11,6 +11,9 @@
"module": "dist/index.esm.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "common-library"
+ },
"homepage": "https://backstage.io",
"repository": {
"type": "git",
@@ -21,15 +24,15 @@
"backstage"
],
"scripts": {
- "build": "backstage-cli build",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test --passWithNoTests",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean"
},
"devDependencies": {
- "@backstage/cli": "^0.13.2-next.0"
+ "@backstage/cli": "^0.14.0"
},
"files": [
"dist"
diff --git a/plugins/azure-devops/CHANGELOG.md b/plugins/azure-devops/CHANGELOG.md
index 8b0331e75d..7c0a533dd3 100644
--- a/plugins/azure-devops/CHANGELOG.md
+++ b/plugins/azure-devops/CHANGELOG.md
@@ -1,5 +1,30 @@
# @backstage/plugin-azure-devops
+## 0.1.16
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.8.10
+ - @backstage/plugin-catalog-react@0.7.0
+ - @backstage/catalog-model@0.11.0
+ - @backstage/core-plugin-api@0.7.0
+
+## 0.1.15
+
+### Patch Changes
+
+- 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- Updated dependencies
+ - @backstage/core-components@0.8.9
+ - @backstage/core-plugin-api@0.6.1
+ - @backstage/errors@0.2.1
+ - @backstage/plugin-catalog-react@0.6.15
+ - @backstage/catalog-model@0.10.0
+ - @backstage/theme@0.2.15
+ - @backstage/plugin-azure-devops-common@0.2.1
+
## 0.1.14
### Patch Changes
diff --git a/plugins/azure-devops/package.json b/plugins/azure-devops/package.json
index a34686d856..57c1654527 100644
--- a/plugins/azure-devops/package.json
+++ b/plugins/azure-devops/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-azure-devops",
- "version": "0.1.14",
+ "version": "0.1.16",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -10,6 +10,9 @@
"main": "dist/index.esm.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "frontend-plugin"
+ },
"homepage": "https://backstage.io",
"repository": {
"type": "git",
@@ -17,23 +20,23 @@
"directory": "plugins/azure-devops"
},
"scripts": {
- "build": "backstage-cli plugin:build",
- "start": "backstage-cli plugin:serve",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test",
+ "build": "backstage-cli package build",
+ "start": "backstage-cli package start",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
"diff": "backstage-cli plugin:diff",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean"
},
"dependencies": {
- "@backstage/catalog-model": "^0.9.10",
- "@backstage/core-components": "^0.8.8",
- "@backstage/core-plugin-api": "^0.6.0",
- "@backstage/errors": "^0.2.0",
- "@backstage/plugin-azure-devops-common": "^0.2.0",
- "@backstage/plugin-catalog-react": "^0.6.14",
- "@backstage/theme": "^0.2.14",
+ "@backstage/catalog-model": "^0.11.0",
+ "@backstage/core-components": "^0.8.10",
+ "@backstage/core-plugin-api": "^0.7.0",
+ "@backstage/errors": "^0.2.2",
+ "@backstage/plugin-azure-devops-common": "^0.2.2",
+ "@backstage/plugin-catalog-react": "^0.7.0",
+ "@backstage/theme": "^0.2.15",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
"@material-ui/lab": "4.0.0-alpha.57",
@@ -46,10 +49,10 @@
"react": "^16.13.1 || ^17.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.13.2",
- "@backstage/core-app-api": "^0.5.2",
- "@backstage/dev-utils": "^0.2.21",
- "@backstage/test-utils": "^0.2.4",
+ "@backstage/cli": "^0.14.1",
+ "@backstage/core-app-api": "^0.5.4",
+ "@backstage/dev-utils": "^0.2.23",
+ "@backstage/test-utils": "^0.2.6",
"@testing-library/jest-dom": "^5.10.1",
"@testing-library/react": "^11.2.5",
"@testing-library/user-event": "^13.1.8",
diff --git a/plugins/badges-backend/CHANGELOG.md b/plugins/badges-backend/CHANGELOG.md
index f025515703..ae93cdbe5a 100644
--- a/plugins/badges-backend/CHANGELOG.md
+++ b/plugins/badges-backend/CHANGELOG.md
@@ -1,5 +1,41 @@
# @backstage/plugin-badges-backend
+## 0.1.21
+
+### Patch Changes
+
+- 6e1cbc12a6: Updated according to the new `getEntityFacets` catalog API method
+- Updated dependencies
+ - @backstage/backend-common@0.11.0
+ - @backstage/catalog-model@0.11.0
+ - @backstage/catalog-client@0.7.2
+
+## 0.1.20
+
+### Patch Changes
+
+- Fix for the previous release with missing type declarations.
+- Updated dependencies
+ - @backstage/backend-common@0.10.9
+ - @backstage/catalog-client@0.7.1
+ - @backstage/catalog-model@0.10.1
+ - @backstage/config@0.1.15
+ - @backstage/errors@0.2.2
+
+## 0.1.19
+
+### Patch Changes
+
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- deaf6065db: Adapt to the new `CatalogApi.getLocationByRef`
+- 7aeb491394: Replace use of deprecated `ENTITY_DEFAULT_NAMESPACE` constant with `DEFAULT_NAMESPACE`.
+- Updated dependencies
+ - @backstage/backend-common@0.10.8
+ - @backstage/catalog-client@0.7.0
+ - @backstage/errors@0.2.1
+ - @backstage/catalog-model@0.10.0
+ - @backstage/config@0.1.14
+
## 0.1.18
### Patch Changes
diff --git a/plugins/badges-backend/package.json b/plugins/badges-backend/package.json
index b5fc38f289..94796ba665 100644
--- a/plugins/badges-backend/package.json
+++ b/plugins/badges-backend/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-badges-backend",
"description": "A Backstage backend plugin that generates README badges for your entities",
- "version": "0.1.18",
+ "version": "0.1.21",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -11,6 +11,9 @@
"main": "dist/index.cjs.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "backend-plugin"
+ },
"homepage": "https://backstage.io",
"repository": {
"type": "git",
@@ -22,20 +25,20 @@
"badges"
],
"scripts": {
- "start": "backstage-cli backend:dev",
- "build": "backstage-cli backend:build",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "start": "backstage-cli package start",
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean"
},
"dependencies": {
- "@backstage/backend-common": "^0.10.7",
- "@backstage/catalog-client": "^0.6.0",
- "@backstage/catalog-model": "^0.9.10",
- "@backstage/config": "^0.1.13",
- "@backstage/errors": "^0.2.0",
+ "@backstage/backend-common": "^0.11.0",
+ "@backstage/catalog-client": "^0.7.2",
+ "@backstage/catalog-model": "^0.11.0",
+ "@backstage/config": "^0.1.15",
+ "@backstage/errors": "^0.2.2",
"@types/express": "^4.17.6",
"badge-maker": "^3.3.0",
"cors": "^2.8.5",
@@ -45,7 +48,7 @@
"yn": "^4.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.13.2",
+ "@backstage/cli": "^0.14.1",
"@types/supertest": "^2.0.8",
"supertest": "^6.1.3"
},
diff --git a/plugins/badges-backend/src/service/router.test.ts b/plugins/badges-backend/src/service/router.test.ts
index 286a2335f1..56dbfb0655 100644
--- a/plugins/badges-backend/src/service/router.test.ts
+++ b/plugins/badges-backend/src/service/router.test.ts
@@ -61,13 +61,13 @@ describe('createRouter', () => {
addLocation: jest.fn(),
getEntities: jest.fn(),
getEntityByName: jest.fn(),
- getOriginLocationByEntity: jest.fn(),
- getLocationByEntity: jest.fn(),
+ getLocationByRef: jest.fn(),
getLocationById: jest.fn(),
removeLocationById: jest.fn(),
removeEntityByUid: jest.fn(),
refreshEntity: jest.fn(),
getEntityAncestors: jest.fn(),
+ getEntityFacets: jest.fn(),
};
config = new ConfigReader({
diff --git a/plugins/badges/CHANGELOG.md b/plugins/badges/CHANGELOG.md
index 8f2a3b2e84..e624dc36e9 100644
--- a/plugins/badges/CHANGELOG.md
+++ b/plugins/badges/CHANGELOG.md
@@ -1,5 +1,30 @@
# @backstage/plugin-badges
+## 0.2.24
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.8.10
+ - @backstage/plugin-catalog-react@0.7.0
+ - @backstage/catalog-model@0.11.0
+ - @backstage/core-plugin-api@0.7.0
+
+## 0.2.23
+
+### Patch Changes
+
+- 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- 7aeb491394: Replace use of deprecated `ENTITY_DEFAULT_NAMESPACE` constant with `DEFAULT_NAMESPACE`.
+- Updated dependencies
+ - @backstage/core-components@0.8.9
+ - @backstage/core-plugin-api@0.6.1
+ - @backstage/errors@0.2.1
+ - @backstage/plugin-catalog-react@0.6.15
+ - @backstage/catalog-model@0.10.0
+ - @backstage/theme@0.2.15
+
## 0.2.22
### Patch Changes
diff --git a/plugins/badges/package.json b/plugins/badges/package.json
index 5250318164..612b9f3b2d 100644
--- a/plugins/badges/package.json
+++ b/plugins/badges/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-badges",
"description": "A Backstage plugin that generates README badges for your entities",
- "version": "0.2.22",
+ "version": "0.2.24",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -10,6 +10,9 @@
"main": "dist/index.esm.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "frontend-plugin"
+ },
"homepage": "https://backstage.io",
"repository": {
"type": "git",
@@ -17,22 +20,22 @@
"directory": "plugins/badges"
},
"scripts": {
- "build": "backstage-cli plugin:build",
- "start": "backstage-cli plugin:serve",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test",
+ "build": "backstage-cli package build",
+ "start": "backstage-cli package start",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
"diff": "backstage-cli plugin:diff",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean"
},
"dependencies": {
- "@backstage/catalog-model": "^0.9.10",
- "@backstage/core-components": "^0.8.8",
- "@backstage/core-plugin-api": "^0.6.0",
- "@backstage/errors": "^0.2.0",
- "@backstage/plugin-catalog-react": "^0.6.14",
- "@backstage/theme": "^0.2.14",
+ "@backstage/catalog-model": "^0.11.0",
+ "@backstage/core-components": "^0.8.10",
+ "@backstage/core-plugin-api": "^0.7.0",
+ "@backstage/errors": "^0.2.2",
+ "@backstage/plugin-catalog-react": "^0.7.0",
+ "@backstage/theme": "^0.2.15",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
"@material-ui/lab": "4.0.0-alpha.57",
@@ -43,10 +46,10 @@
"react": "^16.13.1 || ^17.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.13.2",
- "@backstage/core-app-api": "^0.5.2",
- "@backstage/dev-utils": "^0.2.21",
- "@backstage/test-utils": "^0.2.4",
+ "@backstage/cli": "^0.14.1",
+ "@backstage/core-app-api": "^0.5.4",
+ "@backstage/dev-utils": "^0.2.23",
+ "@backstage/test-utils": "^0.2.6",
"@testing-library/jest-dom": "^5.10.1",
"@testing-library/react": "^11.2.5",
"@testing-library/user-event": "^13.1.8",
diff --git a/plugins/bazaar-backend/CHANGELOG.md b/plugins/bazaar-backend/CHANGELOG.md
index fdd63ff59b..50dc8b2ad3 100644
--- a/plugins/bazaar-backend/CHANGELOG.md
+++ b/plugins/bazaar-backend/CHANGELOG.md
@@ -1,5 +1,23 @@
# @backstage/plugin-bazaar-backend
+## 0.1.11
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.11.0
+ - @backstage/backend-test-utils@0.1.19
+
+## 0.1.10
+
+### Patch Changes
+
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- Updated dependencies
+ - @backstage/backend-common@0.10.8
+ - @backstage/backend-test-utils@0.1.18
+ - @backstage/config@0.1.14
+
## 0.1.9
### Patch Changes
diff --git a/plugins/bazaar-backend/package.json b/plugins/bazaar-backend/package.json
index 71980acea4..cb596770d4 100644
--- a/plugins/bazaar-backend/package.json
+++ b/plugins/bazaar-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-bazaar-backend",
- "version": "0.1.9",
+ "version": "0.1.11",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -10,19 +10,22 @@
"main": "dist/index.cjs.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "backend-plugin"
+ },
"scripts": {
- "start": "backstage-cli backend:dev",
- "build": "backstage-cli backend:build",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "start": "backstage-cli package start",
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean"
},
"dependencies": {
- "@backstage/backend-common": "^0.10.7",
- "@backstage/backend-test-utils": "^0.1.17",
- "@backstage/config": "^0.1.13",
+ "@backstage/backend-common": "^0.11.0",
+ "@backstage/backend-test-utils": "^0.1.19",
+ "@backstage/config": "^0.1.15",
"@types/express": "^4.17.6",
"express": "^4.17.1",
"express-promise-router": "^4.1.0",
@@ -31,7 +34,7 @@
"yn": "^4.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.13.2"
+ "@backstage/cli": "^0.14.1"
},
"files": [
"dist",
diff --git a/plugins/bazaar/CHANGELOG.md b/plugins/bazaar/CHANGELOG.md
index 00f7605888..df72f76d6a 100644
--- a/plugins/bazaar/CHANGELOG.md
+++ b/plugins/bazaar/CHANGELOG.md
@@ -1,5 +1,34 @@
# @backstage/plugin-bazaar
+## 0.1.15
+
+### Patch Changes
+
+- 67a7c02d26: Remove usages of `EntityRef` and `parseEntityName` from `@backstage/catalog-model`
+- Updated dependencies
+ - @backstage/plugin-catalog@0.9.0
+ - @backstage/cli@0.14.1
+ - @backstage/core-components@0.8.10
+ - @backstage/plugin-catalog-react@0.7.0
+ - @backstage/catalog-model@0.11.0
+ - @backstage/catalog-client@0.7.2
+ - @backstage/core-plugin-api@0.7.0
+
+## 0.1.14
+
+### Patch Changes
+
+- 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- Updated dependencies
+ - @backstage/cli@0.14.0
+ - @backstage/catalog-client@0.7.0
+ - @backstage/core-components@0.8.9
+ - @backstage/core-plugin-api@0.6.1
+ - @backstage/plugin-catalog@0.8.0
+ - @backstage/plugin-catalog-react@0.6.15
+ - @backstage/catalog-model@0.10.0
+
## 0.1.13
### Patch Changes
diff --git a/plugins/bazaar/package.json b/plugins/bazaar/package.json
index bfdcb18ca3..a38cd1cd16 100644
--- a/plugins/bazaar/package.json
+++ b/plugins/bazaar/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-bazaar",
- "version": "0.1.13",
+ "version": "0.1.15",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -10,24 +10,27 @@
"main": "dist/index.esm.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "frontend-plugin"
+ },
"scripts": {
- "build": "backstage-cli plugin:build",
- "start": "backstage-cli plugin:serve",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test",
+ "build": "backstage-cli package build",
+ "start": "backstage-cli package start",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
"diff": "backstage-cli plugin:diff",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean"
},
"dependencies": {
- "@backstage/catalog-client": "^0.6.0",
- "@backstage/catalog-model": "^0.9.10",
- "@backstage/cli": "^0.13.2",
- "@backstage/core-components": "^0.8.8",
- "@backstage/core-plugin-api": "^0.6.0",
- "@backstage/plugin-catalog": "^0.7.12",
- "@backstage/plugin-catalog-react": "^0.6.14",
+ "@backstage/catalog-client": "^0.7.2",
+ "@backstage/catalog-model": "^0.11.0",
+ "@backstage/cli": "^0.14.1",
+ "@backstage/core-components": "^0.8.10",
+ "@backstage/core-plugin-api": "^0.7.0",
+ "@backstage/plugin-catalog": "^0.9.0",
+ "@backstage/plugin-catalog-react": "^0.7.0",
"@date-io/luxon": "1.x",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
@@ -44,8 +47,8 @@
"react": "^16.13.1 || ^17.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.13.2",
- "@backstage/dev-utils": "^0.2.21",
+ "@backstage/cli": "^0.14.1",
+ "@backstage/dev-utils": "^0.2.23",
"@testing-library/jest-dom": "^5.10.1",
"cross-fetch": "^3.1.5"
},
diff --git a/plugins/bazaar/src/components/HomePageBazaarInfoCard/HomePageBazaarInfoCard.tsx b/plugins/bazaar/src/components/HomePageBazaarInfoCard/HomePageBazaarInfoCard.tsx
index 5624f40765..ec29d1429b 100644
--- a/plugins/bazaar/src/components/HomePageBazaarInfoCard/HomePageBazaarInfoCard.tsx
+++ b/plugins/bazaar/src/components/HomePageBazaarInfoCard/HomePageBazaarInfoCard.tsx
@@ -47,7 +47,6 @@ import useAsyncFn from 'react-use/lib/useAsyncFn';
import { catalogApiRef, entityRouteRef } from '@backstage/plugin-catalog-react';
import {
- parseEntityName,
stringifyEntityRef,
Entity,
parseEntityRef,
@@ -150,7 +149,7 @@ export const HomePageBazaarInfoCard = ({
const getEntityPageLink = () => {
if (bazaarProject?.value?.entityRef) {
- const { name, kind, namespace } = parseEntityName(
+ const { name, kind, namespace } = parseEntityRef(
bazaarProject.value.entityRef,
);
return entityLink({ kind, namespace, name });
diff --git a/plugins/bazaar/src/components/SortView/SortView.tsx b/plugins/bazaar/src/components/SortView/SortView.tsx
index fa97ac69ee..f5bb6facd7 100644
--- a/plugins/bazaar/src/components/SortView/SortView.tsx
+++ b/plugins/bazaar/src/components/SortView/SortView.tsx
@@ -107,7 +107,7 @@ export const SortView = () => {
if (catalogEntityRefs) {
bazaarProjects.value?.forEach(async (project: BazaarProject) => {
if (project.entityRef) {
- if (!catalogEntityRefs?.includes(project.entityRef as string)) {
+ if (!catalogEntityRefs?.includes(project.entityRef)) {
await bazaarApi.updateProject({
...project,
entityRef: null,
diff --git a/plugins/bazaar/src/types.ts b/plugins/bazaar/src/types.ts
index 30c07286ac..ec3996d1e2 100644
--- a/plugins/bazaar/src/types.ts
+++ b/plugins/bazaar/src/types.ts
@@ -14,8 +14,6 @@
* limitations under the License.
*/
-import { EntityRef } from '@backstage/catalog-model';
-
export type Member = {
itemId: number;
userId: string;
@@ -30,7 +28,7 @@ export type Size = 'small' | 'medium' | 'large';
export type BazaarProject = {
name: string;
id: number;
- entityRef?: EntityRef;
+ entityRef?: string;
community: string;
status: Status;
description: string;
diff --git a/plugins/bitrise/CHANGELOG.md b/plugins/bitrise/CHANGELOG.md
index 3fc26f7da7..8af11aa8a4 100644
--- a/plugins/bitrise/CHANGELOG.md
+++ b/plugins/bitrise/CHANGELOG.md
@@ -1,5 +1,28 @@
# @backstage/plugin-bitrise
+## 0.1.27
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.8.10
+ - @backstage/plugin-catalog-react@0.7.0
+ - @backstage/catalog-model@0.11.0
+ - @backstage/core-plugin-api@0.7.0
+
+## 0.1.26
+
+### Patch Changes
+
+- 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- Updated dependencies
+ - @backstage/core-components@0.8.9
+ - @backstage/core-plugin-api@0.6.1
+ - @backstage/plugin-catalog-react@0.6.15
+ - @backstage/catalog-model@0.10.0
+ - @backstage/theme@0.2.15
+
## 0.1.25
### Patch Changes
diff --git a/plugins/bitrise/package.json b/plugins/bitrise/package.json
index 8b50459a84..228eed3e9b 100644
--- a/plugins/bitrise/package.json
+++ b/plugins/bitrise/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-bitrise",
"description": "A Backstage plugin that integrates towards Bitrise",
- "version": "0.1.25",
+ "version": "0.1.27",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -10,22 +10,25 @@
"main": "dist/index.esm.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "frontend-plugin"
+ },
"scripts": {
- "build": "backstage-cli plugin:build",
- "start": "backstage-cli plugin:serve",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test",
+ "build": "backstage-cli package build",
+ "start": "backstage-cli package start",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
"diff": "backstage-cli plugin:diff",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean"
},
"dependencies": {
- "@backstage/catalog-model": "^0.9.10",
- "@backstage/core-components": "^0.8.8",
- "@backstage/core-plugin-api": "^0.6.0",
- "@backstage/plugin-catalog-react": "^0.6.14",
- "@backstage/theme": "^0.2.14",
+ "@backstage/catalog-model": "^0.11.0",
+ "@backstage/core-components": "^0.8.10",
+ "@backstage/core-plugin-api": "^0.7.0",
+ "@backstage/plugin-catalog-react": "^0.7.0",
+ "@backstage/theme": "^0.2.15",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
"@material-ui/lab": "4.0.0-alpha.57",
@@ -40,10 +43,10 @@
"react": "^16.13.1 || ^17.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.13.2",
- "@backstage/core-app-api": "^0.5.2",
- "@backstage/dev-utils": "^0.2.21",
- "@backstage/test-utils": "^0.2.4",
+ "@backstage/cli": "^0.14.1",
+ "@backstage/core-app-api": "^0.5.4",
+ "@backstage/dev-utils": "^0.2.23",
+ "@backstage/test-utils": "^0.2.6",
"@testing-library/jest-dom": "^5.10.1",
"@testing-library/react": "^11.2.5",
"@testing-library/user-event": "^13.1.8",
diff --git a/plugins/catalog-backend-module-aws/.eslintrc.js b/plugins/catalog-backend-module-aws/.eslintrc.js
new file mode 100644
index 0000000000..16a033dbc6
--- /dev/null
+++ b/plugins/catalog-backend-module-aws/.eslintrc.js
@@ -0,0 +1,3 @@
+module.exports = {
+ extends: [require.resolve('@backstage/cli/config/eslint.backend')],
+};
diff --git a/plugins/catalog-backend-module-aws/CHANGELOG.md b/plugins/catalog-backend-module-aws/CHANGELOG.md
new file mode 100644
index 0000000000..749ab3a230
--- /dev/null
+++ b/plugins/catalog-backend-module-aws/CHANGELOG.md
@@ -0,0 +1,41 @@
+# @backstage/plugin-catalog-backend-module-aws
+
+## 0.1.0
+
+### Minor Changes
+
+- 25e97e7242: Added this new catalog module, initially containing only the
+ `AwsOrganizationCloudAccountProcessor`.
+
+ Note that this was moved over from the catalog backend itself, and therefore is
+ no longer part of its builtin set of processors. If you were using this
+ processor, through making use of the location type `aws-cloud-accounts` and/or
+ using the configuration key `catalog.processors.awsOrganization`, you will from
+ now on have to add the processor manually to your catalog.
+
+ First, add the `@backstage/plugin-catalog-backend-module-aws` dependency to your
+ `packages/backend` package.
+
+ Then, in `packages/backend/src/plugins/catalog.ts`:
+
+ ```diff
+ +import { AwsOrganizationCloudAccountProcessor } from '@backstage/plugin-catalog-backend-module-aws';
+
+ export default async function createPlugin(
+ env: PluginEnvironment,
+ ): Promise {
+ const builder = await CatalogBuilder.create(env);
+ + builder.addProcessor(
+ + AwsOrganizationCloudAccountProcessor.fromConfig(
+ + env.config,
+ + { logger: env.logger }
+ + )
+ + );
+ // ...
+ ```
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-backend@0.22.0
+ - @backstage/catalog-model@0.11.0
diff --git a/plugins/catalog-backend-module-aws/README.md b/plugins/catalog-backend-module-aws/README.md
new file mode 100644
index 0000000000..304fe7a080
--- /dev/null
+++ b/plugins/catalog-backend-module-aws/README.md
@@ -0,0 +1,10 @@
+# Catalog Backend Module for LDAP
+
+This is an extension module to the plugin-catalog-backend plugin, providing an
+`AwsOrganizationCloudAccountProcessor` that can be used to ingest cloud accounts
+as `Resource` kind entities.
+
+## Getting started
+
+See [Backstage documentation](https://backstage.io/docs/integrations/ldap/org) for details on how to install
+and configure the plugin.
diff --git a/plugins/catalog-backend-module-aws/api-report.md b/plugins/catalog-backend-module-aws/api-report.md
new file mode 100644
index 0000000000..1cab6555fe
--- /dev/null
+++ b/plugins/catalog-backend-module-aws/api-report.md
@@ -0,0 +1,30 @@
+## API Report File for "@backstage/plugin-catalog-backend-module-aws"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { CatalogProcessor } from '@backstage/plugin-catalog-backend';
+import { CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
+import { Config } from '@backstage/config';
+import { LocationSpec } from '@backstage/plugin-catalog-backend';
+import { Logger as Logger_2 } from 'winston';
+
+// @public
+export class AwsOrganizationCloudAccountProcessor implements CatalogProcessor {
+ // (undocumented)
+ static fromConfig(
+ config: Config,
+ options: {
+ logger: Logger_2;
+ },
+ ): AwsOrganizationCloudAccountProcessor;
+ // (undocumented)
+ getProcessorName(): string;
+ // (undocumented)
+ readLocation(
+ location: LocationSpec,
+ _optional: boolean,
+ emit: CatalogProcessorEmit,
+ ): Promise;
+}
+```
diff --git a/plugins/catalog-backend-module-aws/config.d.ts b/plugins/catalog-backend-module-aws/config.d.ts
new file mode 100644
index 0000000000..bb416a576e
--- /dev/null
+++ b/plugins/catalog-backend-module-aws/config.d.ts
@@ -0,0 +1,36 @@
+/*
+ * 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.
+ */
+
+export interface Config {
+ catalog?: {
+ /**
+ * List of processor-specific options and attributes
+ */
+ processors?: {
+ /**
+ * AwsOrganizationCloudAccountProcessor configuration
+ */
+ awsOrganization?: {
+ provider: {
+ /**
+ * The role to be assumed by this processor
+ */
+ roleArn?: string;
+ };
+ };
+ };
+ };
+}
diff --git a/plugins/catalog-backend-module-aws/package.json b/plugins/catalog-backend-module-aws/package.json
new file mode 100644
index 0000000000..ebe77263ac
--- /dev/null
+++ b/plugins/catalog-backend-module-aws/package.json
@@ -0,0 +1,55 @@
+{
+ "name": "@backstage/plugin-catalog-backend-module-aws",
+ "description": "A Backstage catalog backend module that helps integrate towards AWS",
+ "version": "0.1.0",
+ "main": "src/index.ts",
+ "types": "src/index.ts",
+ "license": "Apache-2.0",
+ "private": false,
+ "publishConfig": {
+ "access": "public",
+ "main": "dist/index.cjs.js",
+ "types": "dist/index.d.ts"
+ },
+ "backstage": {
+ "role": "backend-plugin-module"
+ },
+ "homepage": "https://backstage.io",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/backstage/backstage",
+ "directory": "plugins/catalog-backend-module-aws"
+ },
+ "keywords": [
+ "backstage"
+ ],
+ "scripts": {
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean",
+ "start": "backstage-cli package start"
+ },
+ "dependencies": {
+ "@backstage/catalog-model": "^0.11.0",
+ "@backstage/config": "^0.1.15",
+ "@backstage/errors": "^0.2.2",
+ "@backstage/plugin-catalog-backend": "^0.22.0",
+ "@backstage/types": "^0.1.3",
+ "aws-sdk": "^2.840.0",
+ "lodash": "^4.17.21",
+ "winston": "^3.2.1"
+ },
+ "devDependencies": {
+ "@backstage/cli": "^0.14.1",
+ "@types/lodash": "^4.14.151",
+ "aws-sdk-mock": "^5.2.1"
+ },
+ "files": [
+ "dist",
+ "config.d.ts"
+ ],
+ "configSchema": "config.d.ts"
+}
diff --git a/plugins/catalog-backend/src/ingestion/processors/awsOrganization/config.test.ts b/plugins/catalog-backend-module-aws/src/awsOrganization/config.test.ts
similarity index 100%
rename from plugins/catalog-backend/src/ingestion/processors/awsOrganization/config.test.ts
rename to plugins/catalog-backend-module-aws/src/awsOrganization/config.test.ts
diff --git a/plugins/catalog-backend/src/ingestion/processors/awsOrganization/config.ts b/plugins/catalog-backend-module-aws/src/awsOrganization/config.ts
similarity index 100%
rename from plugins/catalog-backend/src/ingestion/processors/awsOrganization/config.ts
rename to plugins/catalog-backend-module-aws/src/awsOrganization/config.ts
diff --git a/plugins/catalog-backend-module-aws/src/index.ts b/plugins/catalog-backend-module-aws/src/index.ts
new file mode 100644
index 0000000000..62c10a0f6d
--- /dev/null
+++ b/plugins/catalog-backend-module-aws/src/index.ts
@@ -0,0 +1,23 @@
+/*
+ * 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.
+ */
+
+/**
+ * A Backstage catalog backend module that helps integrate towards AWS
+ *
+ * @packageDocumentation
+ */
+
+export * from './processors';
diff --git a/plugins/catalog-backend/src/ingestion/processors/AwsOrganizationCloudAccountProcessor.test.ts b/plugins/catalog-backend-module-aws/src/processors/AwsOrganizationCloudAccountProcessor.test.ts
similarity index 96%
rename from plugins/catalog-backend/src/ingestion/processors/AwsOrganizationCloudAccountProcessor.test.ts
rename to plugins/catalog-backend-module-aws/src/processors/AwsOrganizationCloudAccountProcessor.test.ts
index 88b033c33f..a7da6d9ad3 100644
--- a/plugins/catalog-backend/src/ingestion/processors/AwsOrganizationCloudAccountProcessor.test.ts
+++ b/plugins/catalog-backend-module-aws/src/processors/AwsOrganizationCloudAccountProcessor.test.ts
@@ -15,13 +15,11 @@
*/
import { AwsOrganizationCloudAccountProcessor } from './AwsOrganizationCloudAccountProcessor';
-import * as winston from 'winston';
describe('AwsOrganizationCloudAccountProcessor', () => {
describe('readLocation', () => {
- const processor = new AwsOrganizationCloudAccountProcessor({
+ const processor = new (AwsOrganizationCloudAccountProcessor as any)({
provider: {},
- logger: winston.createLogger(),
});
const location = { type: 'aws-cloud-accounts', target: '' };
const emit = jest.fn();
diff --git a/plugins/catalog-backend/src/ingestion/processors/AwsOrganizationCloudAccountProcessor.ts b/plugins/catalog-backend-module-aws/src/processors/AwsOrganizationCloudAccountProcessor.ts
similarity index 80%
rename from plugins/catalog-backend/src/ingestion/processors/AwsOrganizationCloudAccountProcessor.ts
rename to plugins/catalog-backend-module-aws/src/processors/AwsOrganizationCloudAccountProcessor.ts
index 655f99d14a..e5e72d5fa8 100644
--- a/plugins/catalog-backend/src/ingestion/processors/AwsOrganizationCloudAccountProcessor.ts
+++ b/plugins/catalog-backend-module-aws/src/processors/AwsOrganizationCloudAccountProcessor.ts
@@ -13,35 +13,41 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import { LocationSpec, ResourceEntityV1alpha1 } from '@backstage/catalog-model';
+
+import { ResourceEntityV1alpha1 } from '@backstage/catalog-model';
+import { Config } from '@backstage/config';
+import {
+ CatalogProcessor,
+ CatalogProcessorEmit,
+ LocationSpec,
+ results,
+} from '@backstage/plugin-catalog-backend';
import AWS, { Credentials, Organizations } from 'aws-sdk';
import { Account, ListAccountsResponse } from 'aws-sdk/clients/organizations';
-
-import * as results from './results';
-import { CatalogProcessor, CatalogProcessorEmit } from './types';
-import { Config } from '@backstage/config';
import { Logger } from 'winston';
import {
AwsOrganizationProviderConfig,
readAwsOrganizationConfig,
-} from './awsOrganization/config';
+} from '../awsOrganization/config';
const AWS_ORGANIZATION_REGION = 'us-east-1';
const LOCATION_TYPE = 'aws-cloud-accounts';
-const ACCOUNTID_ANNOTATION: string = 'amazonaws.com/account-id';
-const ARN_ANNOTATION: string = 'amazonaws.com/arn';
-const ORGANIZATION_ANNOTATION: string = 'amazonaws.com/organization-id';
+const ACCOUNTID_ANNOTATION = 'amazonaws.com/account-id';
+const ARN_ANNOTATION = 'amazonaws.com/arn';
+const ORGANIZATION_ANNOTATION = 'amazonaws.com/organization-id';
/**
* A processor for ingesting AWS Accounts from AWS Organizations.
*
- * If custom authentication is needed, it can be achieved by configuring the global AWS.credentials object.
+ * If custom authentication is needed, it can be achieved by configuring the
+ * global AWS.credentials object.
+ *
+ * @public
*/
export class AwsOrganizationCloudAccountProcessor implements CatalogProcessor {
- logger: Logger;
- organizations: Organizations;
- provider: AwsOrganizationProviderConfig;
+ private readonly organizations: Organizations;
+ private readonly provider: AwsOrganizationProviderConfig;
static fromConfig(config: Config, options: { logger: Logger }) {
const c = config.getOptionalConfig('catalog.processors.awsOrganization');
@@ -67,12 +73,8 @@ export class AwsOrganizationCloudAccountProcessor implements CatalogProcessor {
});
}
- constructor(options: {
- provider: AwsOrganizationProviderConfig;
- logger: Logger;
- }) {
+ private constructor(options: { provider: AwsOrganizationProviderConfig }) {
this.provider = options.provider;
- this.logger = options.logger;
const credentials = AwsOrganizationCloudAccountProcessor.buildCredentials(
this.provider,
);
@@ -82,64 +84,8 @@ export class AwsOrganizationCloudAccountProcessor implements CatalogProcessor {
}); // Only available in us-east-1
}
- normalizeName(name: string): string {
- return name
- .trim()
- .toLocaleLowerCase()
- .replace(/[^a-zA-Z0-9\-]/g, '-');
- }
-
- extractInformationFromArn(arn: string): {
- accountId: string;
- organizationId: string;
- } {
- const parts = arn.split('/');
-
- return {
- accountId: parts[parts.length - 1],
- organizationId: parts[parts.length - 2],
- };
- }
-
- async getAwsAccounts(): Promise {
- let awsAccounts: Account[] = [];
- let isInitialAttempt = true;
- let nextToken = undefined;
- while (isInitialAttempt || nextToken) {
- isInitialAttempt = false;
- const orgAccounts: ListAccountsResponse = await this.organizations
- .listAccounts({ NextToken: nextToken })
- .promise();
- if (orgAccounts.Accounts) {
- awsAccounts = awsAccounts.concat(orgAccounts.Accounts);
- }
- nextToken = orgAccounts.NextToken;
- }
-
- return awsAccounts;
- }
-
- mapAccountToComponent(account: Account): ResourceEntityV1alpha1 {
- const { accountId, organizationId } = this.extractInformationFromArn(
- account.Arn as string,
- );
- return {
- apiVersion: 'backstage.io/v1alpha1',
- kind: 'Resource',
- metadata: {
- annotations: {
- [ACCOUNTID_ANNOTATION]: accountId,
- [ARN_ANNOTATION]: account.Arn || '',
- [ORGANIZATION_ANNOTATION]: organizationId,
- },
- name: this.normalizeName(account.Name || ''),
- namespace: 'default',
- },
- spec: {
- type: 'cloud-account',
- owner: 'unknown',
- },
- };
+ getProcessorName(): string {
+ return 'AwsOrganizationCloudAccountProcessor';
}
async readLocation(
@@ -165,10 +111,70 @@ export class AwsOrganizationCloudAccountProcessor implements CatalogProcessor {
}
return true;
})
- .forEach((entity: ResourceEntityV1alpha1) => {
+ .forEach(entity => {
emit(results.entity(location, entity));
});
return true;
}
+
+ private normalizeName(name: string): string {
+ return name
+ .trim()
+ .toLocaleLowerCase('en-US')
+ .replace(/[^a-zA-Z0-9\-]/g, '-');
+ }
+
+ private extractInformationFromArn(arn: string): {
+ accountId: string;
+ organizationId: string;
+ } {
+ const parts = arn.split('/');
+
+ return {
+ accountId: parts[parts.length - 1],
+ organizationId: parts[parts.length - 2],
+ };
+ }
+
+ private async getAwsAccounts(): Promise {
+ let awsAccounts: Account[] = [];
+ let isInitialAttempt = true;
+ let nextToken = undefined;
+ while (isInitialAttempt || nextToken) {
+ isInitialAttempt = false;
+ const orgAccounts: ListAccountsResponse = await this.organizations
+ .listAccounts({ NextToken: nextToken })
+ .promise();
+ if (orgAccounts.Accounts) {
+ awsAccounts = awsAccounts.concat(orgAccounts.Accounts);
+ }
+ nextToken = orgAccounts.NextToken;
+ }
+
+ return awsAccounts;
+ }
+
+ private mapAccountToComponent(account: Account): ResourceEntityV1alpha1 {
+ const { accountId, organizationId } = this.extractInformationFromArn(
+ account.Arn as string,
+ );
+ return {
+ apiVersion: 'backstage.io/v1alpha1',
+ kind: 'Resource',
+ metadata: {
+ annotations: {
+ [ACCOUNTID_ANNOTATION]: accountId,
+ [ARN_ANNOTATION]: account.Arn || '',
+ [ORGANIZATION_ANNOTATION]: organizationId,
+ },
+ name: this.normalizeName(account.Name || ''),
+ namespace: 'default',
+ },
+ spec: {
+ type: 'cloud-account',
+ owner: 'unknown',
+ },
+ };
+ }
}
diff --git a/plugins/catalog/src/components/CatalogResultListItem/index.ts b/plugins/catalog-backend-module-aws/src/processors/index.ts
similarity index 86%
rename from plugins/catalog/src/components/CatalogResultListItem/index.ts
rename to plugins/catalog-backend-module-aws/src/processors/index.ts
index e8a67d8f89..fa858aa744 100644
--- a/plugins/catalog/src/components/CatalogResultListItem/index.ts
+++ b/plugins/catalog-backend-module-aws/src/processors/index.ts
@@ -14,4 +14,4 @@
* limitations under the License.
*/
-export { CatalogResultListItem } from './CatalogResultListItem';
+export { AwsOrganizationCloudAccountProcessor } from './AwsOrganizationCloudAccountProcessor';
diff --git a/plugins/catalog-backend-module-aws/src/setupTests.ts b/plugins/catalog-backend-module-aws/src/setupTests.ts
new file mode 100644
index 0000000000..d3232290a7
--- /dev/null
+++ b/plugins/catalog-backend-module-aws/src/setupTests.ts
@@ -0,0 +1,17 @@
+/*
+ * 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.
+ */
+
+export {};
diff --git a/plugins/catalog-backend-module-ldap/CHANGELOG.md b/plugins/catalog-backend-module-ldap/CHANGELOG.md
index 55162c6003..e05e4936a8 100644
--- a/plugins/catalog-backend-module-ldap/CHANGELOG.md
+++ b/plugins/catalog-backend-module-ldap/CHANGELOG.md
@@ -1,5 +1,30 @@
# @backstage/plugin-catalog-backend-module-ldap
+## 0.3.14
+
+### Patch Changes
+
+- ed09ad8093: Updated usage of the `LocationSpec` type from `@backstage/catalog-model`, which is deprecated.
+- 25e97e7242: Minor wording update
+- df61ca71dd: Implemented required `getProcessorName` method for catalog processor.
+- Updated dependencies
+ - @backstage/plugin-catalog-backend@0.22.0
+ - @backstage/catalog-model@0.11.0
+
+## 0.3.13
+
+### Patch Changes
+
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- 244d24ebc4: Import `Location` from the `@backstage/catalog-client` package.
+- 27eccab216: Replaces use of deprecated catalog-model constants.
+- Updated dependencies
+ - @backstage/plugin-catalog-backend@0.21.4
+ - @backstage/errors@0.2.1
+ - @backstage/catalog-model@0.10.0
+ - @backstage/config@0.1.14
+ - @backstage/types@0.1.2
+
## 0.3.12
### Patch Changes
diff --git a/plugins/catalog-backend-module-ldap/api-report.md b/plugins/catalog-backend-module-ldap/api-report.md
index e2dbef74e5..f6b2475e65 100644
--- a/plugins/catalog-backend-module-ldap/api-report.md
+++ b/plugins/catalog-backend-module-ldap/api-report.md
@@ -11,7 +11,7 @@ import { EntityProvider } from '@backstage/plugin-catalog-backend';
import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
import { GroupEntity } from '@backstage/catalog-model';
import { JsonValue } from '@backstage/types';
-import { LocationSpec } from '@backstage/catalog-model';
+import { LocationSpec } from '@backstage/plugin-catalog-backend';
import { Logger as Logger_2 } from 'winston';
import { SearchEntry } from 'ldapjs';
import { SearchOptions } from 'ldapjs';
@@ -137,6 +137,8 @@ export class LdapOrgReaderProcessor implements CatalogProcessor {
},
): LdapOrgReaderProcessor;
// (undocumented)
+ getProcessorName(): string;
+ // (undocumented)
readLocation(
location: LocationSpec,
_optional: boolean,
diff --git a/plugins/catalog-backend-module-ldap/config.d.ts b/plugins/catalog-backend-module-ldap/config.d.ts
index 57781fd711..df167bc520 100644
--- a/plugins/catalog-backend-module-ldap/config.d.ts
+++ b/plugins/catalog-backend-module-ldap/config.d.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-import { JsonValue } from '@backstage/config';
+import { JsonValue } from '@backstage/types';
export interface Config {
/**
diff --git a/plugins/catalog-backend-module-ldap/package.json b/plugins/catalog-backend-module-ldap/package.json
index a499049265..dc2f56aad6 100644
--- a/plugins/catalog-backend-module-ldap/package.json
+++ b/plugins/catalog-backend-module-ldap/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-backend-module-ldap",
- "description": "A Backstage catalog backend modules that helps integrate towards LDAP",
- "version": "0.3.12",
+ "description": "A Backstage catalog backend module that helps integrate towards LDAP",
+ "version": "0.3.14",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -11,6 +11,9 @@
"main": "dist/index.cjs.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "backend-plugin-module"
+ },
"homepage": "https://backstage.io",
"repository": {
"type": "git",
@@ -21,26 +24,27 @@
"backstage"
],
"scripts": {
- "build": "backstage-cli backend:build",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean",
+ "start": "backstage-cli package start"
},
"dependencies": {
- "@backstage/catalog-model": "^0.9.10",
- "@backstage/config": "^0.1.13",
- "@backstage/errors": "^0.2.0",
- "@backstage/plugin-catalog-backend": "^0.21.3",
- "@backstage/types": "^0.1.1",
+ "@backstage/catalog-model": "^0.11.0",
+ "@backstage/config": "^0.1.15",
+ "@backstage/errors": "^0.2.2",
+ "@backstage/plugin-catalog-backend": "^0.22.0",
+ "@backstage/types": "^0.1.3",
"@types/ldapjs": "^2.2.0",
"ldapjs": "^2.2.0",
"lodash": "^4.17.21",
"winston": "^3.2.1"
},
"devDependencies": {
- "@backstage/cli": "^0.13.2",
+ "@backstage/cli": "^0.14.1",
"@types/lodash": "^4.14.151"
},
"files": [
diff --git a/plugins/catalog-backend-module-ldap/src/index.ts b/plugins/catalog-backend-module-ldap/src/index.ts
index a3b3c46815..243044369c 100644
--- a/plugins/catalog-backend-module-ldap/src/index.ts
+++ b/plugins/catalog-backend-module-ldap/src/index.ts
@@ -15,7 +15,7 @@
*/
/**
- * A Backstage catalog backend modules that helps integrate towards LDAP
+ * A Backstage catalog backend module that helps integrate towards LDAP
*
* @packageDocumentation
*/
diff --git a/plugins/catalog-backend-module-ldap/src/ldap/client.ts b/plugins/catalog-backend-module-ldap/src/ldap/client.ts
index 91fbd87c39..414d043d3d 100644
--- a/plugins/catalog-backend-module-ldap/src/ldap/client.ts
+++ b/plugins/catalog-backend-module-ldap/src/ldap/client.ts
@@ -106,6 +106,12 @@ export class LdapClient {
reject(new Error(errorString(e)));
});
+ res.on('page', (_result, cb) => {
+ if (cb) {
+ cb();
+ }
+ });
+
res.on('end', r => {
if (!r) {
reject(new Error('Null response'));
diff --git a/plugins/catalog-backend-module-ldap/src/processors/LdapOrgReaderProcessor.ts b/plugins/catalog-backend-module-ldap/src/processors/LdapOrgReaderProcessor.ts
index be2d748840..6c31d5a27d 100644
--- a/plugins/catalog-backend-module-ldap/src/processors/LdapOrgReaderProcessor.ts
+++ b/plugins/catalog-backend-module-ldap/src/processors/LdapOrgReaderProcessor.ts
@@ -14,7 +14,6 @@
* limitations under the License.
*/
-import { LocationSpec } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
import { Logger } from 'winston';
import {
@@ -28,6 +27,7 @@ import {
import {
CatalogProcessor,
CatalogProcessorEmit,
+ LocationSpec,
results,
} from '@backstage/plugin-catalog-backend';
@@ -69,6 +69,10 @@ export class LdapOrgReaderProcessor implements CatalogProcessor {
this.userTransformer = options.userTransformer;
}
+ getProcessorName(): string {
+ return 'LdapOrgReaderProcessor';
+ }
+
async readLocation(
location: LocationSpec,
_optional: boolean,
diff --git a/plugins/catalog-backend-module-msgraph/CHANGELOG.md b/plugins/catalog-backend-module-msgraph/CHANGELOG.md
index 847fbae9d4..d2e9facfb5 100644
--- a/plugins/catalog-backend-module-msgraph/CHANGELOG.md
+++ b/plugins/catalog-backend-module-msgraph/CHANGELOG.md
@@ -1,5 +1,29 @@
# @backstage/plugin-catalog-backend-module-msgraph
+## 0.2.17
+
+### Patch Changes
+
+- ed09ad8093: Updated usage of the `LocationSpec` type from `@backstage/catalog-model`, which is deprecated.
+- 25e97e7242: Minor wording update
+- a097678475: add configuration to use search criteria to select groups
+- df61ca71dd: Implemented required `getProcessorName` method for catalog processor.
+- Updated dependencies
+ - @backstage/plugin-catalog-backend@0.22.0
+ - @backstage/catalog-model@0.11.0
+
+## 0.2.16
+
+### Patch Changes
+
+- 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- 27eccab216: Replaces use of deprecated catalog-model constants.
+- Updated dependencies
+ - @backstage/plugin-catalog-backend@0.21.4
+ - @backstage/catalog-model@0.10.0
+ - @backstage/config@0.1.14
+
## 0.2.15
### Patch Changes
diff --git a/plugins/catalog-backend-module-msgraph/api-report.md b/plugins/catalog-backend-module-msgraph/api-report.md
index 4f5d247a06..7ad603e6ca 100644
--- a/plugins/catalog-backend-module-msgraph/api-report.md
+++ b/plugins/catalog-backend-module-msgraph/api-report.md
@@ -9,7 +9,7 @@ import { Config } from '@backstage/config';
import { EntityProvider } from '@backstage/plugin-catalog-backend';
import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
import { GroupEntity } from '@backstage/catalog-model';
-import { LocationSpec } from '@backstage/catalog-model';
+import { LocationSpec } from '@backstage/plugin-catalog-backend';
import { Logger as Logger_2 } from 'winston';
import * as MicrosoftGraph from '@microsoft/microsoft-graph-types';
import * as msal from '@azure/msal-node';
@@ -80,9 +80,16 @@ export class MicrosoftGraphClient {
): Promise;
getUserProfile(userId: string): Promise;
getUsers(query?: ODataQuery): AsyncIterable;
- requestApi(path: string, query?: ODataQuery): Promise;
+ requestApi(
+ path: string,
+ query?: ODataQuery,
+ headers?: Record,
+ ): Promise;
requestCollection(path: string, query?: ODataQuery): AsyncIterable;
- requestRaw(url: string): Promise;
+ requestRaw(
+ url: string,
+ headers?: Record,
+ ): Promise;
}
// @public
@@ -134,6 +141,8 @@ export class MicrosoftGraphOrgReaderProcessor implements CatalogProcessor {
},
): MicrosoftGraphOrgReaderProcessor;
// (undocumented)
+ getProcessorName(): string;
+ // (undocumented)
readLocation(
location: LocationSpec,
_optional: boolean,
@@ -151,7 +160,9 @@ export type MicrosoftGraphProviderConfig = {
userFilter?: string;
userExpand?: string[];
userGroupMemberFilter?: string;
+ userGroupMemberSearch?: string;
groupFilter?: string;
+ groupSearch?: string;
};
// @public
@@ -159,6 +170,7 @@ export function normalizeEntityName(name: string): string;
// @public
export type ODataQuery = {
+ search?: string;
filter?: string;
expand?: string[];
select?: string[];
@@ -181,7 +193,9 @@ export function readMicrosoftGraphOrg(
options: {
userExpand?: string[];
userFilter?: string;
+ userGroupMemberSearch?: string;
userGroupMemberFilter?: string;
+ groupSearch?: string;
groupFilter?: string;
userTransformer?: UserTransformer;
groupTransformer?: GroupTransformer;
diff --git a/plugins/catalog-backend-module-msgraph/config.d.ts b/plugins/catalog-backend-module-msgraph/config.d.ts
index c7eb5ae8e4..d47abf60bb 100644
--- a/plugins/catalog-backend-module-msgraph/config.d.ts
+++ b/plugins/catalog-backend-module-msgraph/config.d.ts
@@ -73,12 +73,24 @@ export interface Config {
* E.g. "securityEnabled eq false and mailEnabled eq true"
*/
groupFilter?: string;
+ /**
+ * The search criteria to apply to extract users by groups memberships.
+ *
+ * E.g. "\"displayName:-team\"" would only match groups which contain '-team'
+ */
+ groupSearch?: string;
/**
* The filter to apply to extract users by groups memberships.
*
* E.g. "displayName eq 'Backstage Users'"
*/
userGroupMemberFilter?: string;
+ /**
+ * The search criteria to apply to extract groups.
+ *
+ * E.g. "\"displayName:-team\"" would only match groups which contain '-team'
+ */
+ userGroupMemberSearch?: string;
}>;
};
};
diff --git a/plugins/catalog-backend-module-msgraph/package.json b/plugins/catalog-backend-module-msgraph/package.json
index 7fd0a2d319..5005a16c5b 100644
--- a/plugins/catalog-backend-module-msgraph/package.json
+++ b/plugins/catalog-backend-module-msgraph/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-backend-module-msgraph",
- "description": "A Backstage catalog backend modules that helps integrate towards Microsoft Graph",
- "version": "0.2.15",
+ "description": "A Backstage catalog backend module that helps integrate towards Microsoft Graph",
+ "version": "0.2.17",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -11,6 +11,9 @@
"main": "dist/index.cjs.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "backend-plugin-module"
+ },
"homepage": "https://backstage.io",
"repository": {
"type": "git",
@@ -21,18 +24,19 @@
"backstage"
],
"scripts": {
- "build": "backstage-cli backend:build",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean",
+ "start": "backstage-cli package start"
},
"dependencies": {
"@azure/msal-node": "^1.1.0",
- "@backstage/catalog-model": "^0.9.10",
- "@backstage/config": "^0.1.13",
- "@backstage/plugin-catalog-backend": "^0.21.3",
+ "@backstage/catalog-model": "^0.11.0",
+ "@backstage/config": "^0.1.15",
+ "@backstage/plugin-catalog-backend": "^0.22.0",
"@microsoft/microsoft-graph-types": "^2.6.0",
"@types/node-fetch": "^2.5.12",
"lodash": "^4.17.21",
@@ -42,9 +46,9 @@
"qs": "^6.9.4"
},
"devDependencies": {
- "@backstage/backend-common": "^0.10.7",
- "@backstage/cli": "^0.13.2",
- "@backstage/test-utils": "^0.2.4",
+ "@backstage/backend-common": "^0.11.0",
+ "@backstage/cli": "^0.14.1",
+ "@backstage/test-utils": "^0.2.6",
"@types/lodash": "^4.14.151",
"msw": "^0.35.0"
},
diff --git a/plugins/catalog-backend-module-msgraph/src/index.ts b/plugins/catalog-backend-module-msgraph/src/index.ts
index 396ccc3e6a..6a7adedc58 100644
--- a/plugins/catalog-backend-module-msgraph/src/index.ts
+++ b/plugins/catalog-backend-module-msgraph/src/index.ts
@@ -15,7 +15,7 @@
*/
/**
- * A Backstage catalog backend modules that helps integrate towards Microsoft Graph
+ * A Backstage catalog backend module that helps integrate towards Microsoft Graph
*
* @packageDocumentation
*/
diff --git a/plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts b/plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts
index 827c9fc14d..db749a536e 100644
--- a/plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts
+++ b/plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts
@@ -27,6 +27,10 @@ import { MicrosoftGraphProviderConfig } from './config';
* @public
*/
export type ODataQuery = {
+ /**
+ * search resources within a collection matching a free-text search expression.
+ */
+ search?: string;
/**
* filter a collection of resources
*/
@@ -102,7 +106,15 @@ export class MicrosoftGraphClient {
path: string,
query?: ODataQuery,
): AsyncIterable {
- let response = await this.requestApi(path, query);
+ const headers: Record = query?.search
+ ? {
+ // Eventual consistency is required to use $search.
+ // If a new user/group is not found, it'll eventually be imported on a subsequent read
+ ConsistencyLevel: 'eventual',
+ }
+ : {};
+
+ let response = await this.requestApi(path, query, headers);
for (;;) {
if (response.status !== 200) {
@@ -121,7 +133,7 @@ export class MicrosoftGraphClient {
return;
}
- response = await this.requestRaw(result['@odata.nextLink']);
+ response = await this.requestRaw(result['@odata.nextLink'], headers);
}
}
@@ -131,10 +143,16 @@ export class MicrosoftGraphClient {
* @public
* @param path - Resource in Microsoft Graph
* @param query - OData Query {@link ODataQuery}
+ * @param headers - optional HTTP headers
*/
- async requestApi(path: string, query?: ODataQuery): Promise {
+ async requestApi(
+ path: string,
+ query?: ODataQuery,
+ headers?: Record,
+ ): Promise {
const queryString = qs.stringify(
{
+ $search: query?.search,
$filter: query?.filter,
$select: query?.select?.join(','),
$expand: query?.expand?.join(','),
@@ -146,15 +164,22 @@ export class MicrosoftGraphClient {
},
);
- return await this.requestRaw(`${this.baseUrl}/${path}${queryString}`);
+ return await this.requestRaw(
+ `${this.baseUrl}/${path}${queryString}`,
+ headers,
+ );
}
/**
* Makes a HTTP call to Graph API with token
*
* @param url - HTTP Endpoint of Graph API
+ * @param headers - optional HTTP headers
*/
- async requestRaw(url: string): Promise {
+ async requestRaw(
+ url: string,
+ headers?: Record,
+ ): Promise {
// Make sure that we always have a valid access token (might be cached)
const token = await this.pca.acquireTokenByClientCredential({
scopes: ['https://graph.microsoft.com/.default'],
@@ -166,6 +191,7 @@ export class MicrosoftGraphClient {
return await fetch(url, {
headers: {
+ ...headers,
Authorization: `Bearer ${token.accessToken}`,
},
});
diff --git a/plugins/catalog-backend-module-msgraph/src/microsoftGraph/config.ts b/plugins/catalog-backend-module-msgraph/src/microsoftGraph/config.ts
index c401bc2553..6809144f80 100644
--- a/plugins/catalog-backend-module-msgraph/src/microsoftGraph/config.ts
+++ b/plugins/catalog-backend-module-msgraph/src/microsoftGraph/config.ts
@@ -64,12 +64,24 @@ export type MicrosoftGraphProviderConfig = {
* E.g. "displayName eq 'Backstage Users'"
*/
userGroupMemberFilter?: string;
+ /**
+ * The search criteria to apply to extract users by groups memberships.
+ *
+ * E.g. "\"displayName:-team\"" would only match groups which contain '-team'
+ */
+ userGroupMemberSearch?: string;
/**
* The filter to apply to extract groups.
*
* E.g. "securityEnabled eq false and mailEnabled eq true"
*/
groupFilter?: string;
+ /**
+ * The search criteria to apply to extract groups.
+ *
+ * E.g. "\"displayName:-team\"" would only match groups which contain '-team'
+ */
+ groupSearch?: string;
};
/**
@@ -98,13 +110,22 @@ export function readMicrosoftGraphConfig(
const userGroupMemberFilter = providerConfig.getOptionalString(
'userGroupMemberFilter',
);
+ const userGroupMemberSearch = providerConfig.getOptionalString(
+ 'userGroupMemberSearch',
+ );
const groupFilter = providerConfig.getOptionalString('groupFilter');
+ const groupSearch = providerConfig.getOptionalString('groupSearch');
if (userFilter && userGroupMemberFilter) {
throw new Error(
`userFilter and userGroupMemberFilter are mutually exclusive, only one can be specified.`,
);
}
+ if (userFilter && userGroupMemberSearch) {
+ throw new Error(
+ `userGroupMemberSearch cannot be specified when userFilter is defined.`,
+ );
+ }
providers.push({
target,
@@ -114,7 +135,9 @@ export function readMicrosoftGraphConfig(
clientSecret,
userFilter,
userGroupMemberFilter,
+ userGroupMemberSearch,
groupFilter,
+ groupSearch,
});
}
diff --git a/plugins/catalog-backend-module-msgraph/src/microsoftGraph/read.ts b/plugins/catalog-backend-module-msgraph/src/microsoftGraph/read.ts
index 58e60ab76a..f862fd5ace 100644
--- a/plugins/catalog-backend-module-msgraph/src/microsoftGraph/read.ts
+++ b/plugins/catalog-backend-module-msgraph/src/microsoftGraph/read.ts
@@ -137,6 +137,7 @@ export async function readMicrosoftGraphUsers(
export async function readMicrosoftGraphUsersInGroups(
client: MicrosoftGraphClient,
options: {
+ userGroupMemberSearch?: string;
userGroupMemberFilter?: string;
transformer?: UserTransformer;
logger: Logger;
@@ -155,6 +156,7 @@ export async function readMicrosoftGraphUsersInGroups(
const groupMemberUsers: Set = new Set();
for await (const group of client.getGroups({
+ search: options?.userGroupMemberSearch,
filter: options?.userGroupMemberFilter,
})) {
// Process all groups in parallel, otherwise it can take quite some time
@@ -324,6 +326,7 @@ export async function readMicrosoftGraphGroups(
client: MicrosoftGraphClient,
tenantId: string,
options?: {
+ groupSearch?: string;
groupFilter?: string;
groupTransformer?: GroupTransformer;
organizationTransformer?: OrganizationTransformer;
@@ -351,6 +354,7 @@ export async function readMicrosoftGraphGroups(
const promises: Promise[] = [];
for await (const group of client.getGroups({
+ search: options?.groupSearch,
filter: options?.groupFilter,
})) {
// Process all groups in parallel, otherwise it can take quite some time
@@ -504,7 +508,9 @@ export async function readMicrosoftGraphOrg(
options: {
userExpand?: string[];
userFilter?: string;
+ userGroupMemberSearch?: string;
userGroupMemberFilter?: string;
+ groupSearch?: string;
groupFilter?: string;
userTransformer?: UserTransformer;
groupTransformer?: GroupTransformer;
@@ -519,6 +525,7 @@ export async function readMicrosoftGraphOrg(
client,
{
userGroupMemberFilter: options.userGroupMemberFilter,
+ userGroupMemberSearch: options.userGroupMemberSearch,
transformer: options.userTransformer,
logger: options.logger,
},
@@ -535,6 +542,7 @@ export async function readMicrosoftGraphOrg(
}
const { groups, rootGroup, groupMember, groupMemberOf } =
await readMicrosoftGraphGroups(client, tenantId, {
+ groupSearch: options?.groupSearch,
groupFilter: options?.groupFilter,
groupTransformer: options?.groupTransformer,
organizationTransformer: options?.organizationTransformer,
diff --git a/plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgEntityProvider.ts b/plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgEntityProvider.ts
index 92836893f0..7d27e87d73 100644
--- a/plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgEntityProvider.ts
+++ b/plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgEntityProvider.ts
@@ -123,7 +123,9 @@ export class MicrosoftGraphOrgEntityProvider implements EntityProvider {
{
userFilter: provider.userFilter,
userGroupMemberFilter: provider.userGroupMemberFilter,
+ userGroupMemberSearch: provider.userGroupMemberSearch,
groupFilter: provider.groupFilter,
+ groupSearch: provider.groupSearch,
groupTransformer: this.options.groupTransformer,
userTransformer: this.options.userTransformer,
organizationTransformer: this.options.organizationTransformer,
diff --git a/plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgReaderProcessor.ts b/plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgReaderProcessor.ts
index e0e63d86fc..4db3a9b1a0 100644
--- a/plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgReaderProcessor.ts
+++ b/plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgReaderProcessor.ts
@@ -14,11 +14,11 @@
* limitations under the License.
*/
-import { LocationSpec } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
import {
CatalogProcessor,
CatalogProcessorEmit,
+ LocationSpec,
results,
} from '@backstage/plugin-catalog-backend';
import { Logger } from 'winston';
@@ -73,6 +73,9 @@ export class MicrosoftGraphOrgReaderProcessor implements CatalogProcessor {
this.groupTransformer = options.groupTransformer;
this.organizationTransformer = options.organizationTransformer;
}
+ getProcessorName(): string {
+ return 'MicrosoftGraphOrgReaderProcessor';
+ }
async readLocation(
location: LocationSpec,
@@ -105,7 +108,9 @@ export class MicrosoftGraphOrgReaderProcessor implements CatalogProcessor {
userExpand: provider.userExpand,
userFilter: provider.userFilter,
userGroupMemberFilter: provider.userGroupMemberFilter,
+ userGroupMemberSearch: provider.userGroupMemberSearch,
groupFilter: provider.groupFilter,
+ groupSearch: provider.groupSearch,
userTransformer: this.userTransformer,
groupTransformer: this.groupTransformer,
organizationTransformer: this.organizationTransformer,
diff --git a/plugins/catalog-backend/CHANGELOG.md b/plugins/catalog-backend/CHANGELOG.md
index a371712c80..d80acc6d23 100644
--- a/plugins/catalog-backend/CHANGELOG.md
+++ b/plugins/catalog-backend/CHANGELOG.md
@@ -1,5 +1,174 @@
# @backstage/plugin-catalog-backend
+## 0.22.0
+
+### Minor Changes
+
+- 209fd128e6: The `CodeOwnersProcessor` no longer supports the deprecated SCM-specific location types like `'github/api'`. This is a breaking change but it is unlikely to have an impact, as these location types haven't been supported by the rest of the catalog for a long time.
+- 9876e7f172: **BREAKING**: Removed unused `durationText` utility.
+- 25e97e7242: **BREAKING**: Removed `AwsOrganizationCloudAccountProcessor` from the default
+ set of builtin processors, and instead moved it into its own module
+ `@backstage/plugin-catalog-backend-module-aws`.
+
+ If you were using this processor, through making use of the location type
+ `aws-cloud-accounts` and/or using the configuration key
+ `catalog.processors.awsOrganization`, you will from now on have to add the
+ processor manually to your catalog.
+
+ First, add the `@backstage/plugin-catalog-backend-module-aws` dependency to your
+ `packages/backend` package.
+
+ Then, in `packages/backend/src/plugins/catalog.ts`:
+
+ ```diff
+ +import { AwsOrganizationCloudAccountProcessor } from '@backstage/plugin-catalog-backend-module-aws';
+
+ export default async function createPlugin(
+ env: PluginEnvironment,
+ ): Promise {
+ const builder = await CatalogBuilder.create(env);
+ + builder.addProcessor(
+ + AwsOrganizationCloudAccountProcessor.fromConfig(
+ + env.config,
+ + { logger: env.logger }
+ + )
+ + );
+ // ...
+ ```
+
+- e9cf0dd03e: Made the `GitLabDiscoveryProcessor.updateLastActivity` method private, as it was accidentally exposed. It has also been fixed to properly operate in its own cache namespace to avoid collisions with other processors.
+- df61ca71dd: Updated all processors to implement `getProcessorName`.
+
+ **BREAKING**: The `CatalogProcessor` interface now require that the `CatalogProcessor` class implements `getProcessorName()`.
+ The processor name has previously defaulted processor class name. It's therefore _recommended_ to keep your return the same name as the class name if you did not implement this method previously.
+
+ For example:
+
+ ```ts
+ class CustomProcessor implements CatalogProcessor {
+ getProcessorName() {
+ // Use the same name as the class name if this method was not previously implemented.
+ return 'CustomProcessor';
+ }
+ }
+ ```
+
+### Patch Changes
+
+- 919cf2f836: The catalog API now returns entity relations that have three fields: The old
+ `type` and `target` fields, as well as a new `targetRef` field. The last one is
+ the stringified form of the second one.
+
+ **DEPRECATION**: The `target` field is hereby deprecated, both as seen from the
+ catalog API as well as from the `@backstage/catalog-model` package. Both
+ `target` and `targetRef` will be produced for some time, but eventually,
+ `target` will be removed entirely. Please update your readers to stop consuming
+ the `relations.[].target` field from the catalog API as soon as possible.
+
+- 957cb4cb20: Deprecated the `runPeriodically` function which is no longer in use.
+- 01e124ea60: Added an `/entity-facets` endpoint, which lets you query the distribution of
+ possible values for fields of entities.
+
+ This can be useful for example when populating a dropdown in the user interface,
+ such as listing all tag values that are actually being used right now in your
+ catalog instance, along with putting the most common ones at the top.
+
+- 082c32f948: Deprecated the second parameter of `results.location()` that determines whether an emitted location is optional. In cases where this is currently being set to `false`, the parameter can simply be dropped, as that is the default. Usage where this was being set to `true` should be migrated to set the `presence` option of the emitted location to `optional`. For example:
+
+ ```ts
+ results.location(
+ {
+ type: 'url',
+ target: 'http://example.com/foo',
+ },
+ true,
+ );
+
+ // migrated to
+
+ results.location({
+ type: 'url',
+ target: 'http://example.com/foo',
+ presence: 'optional',
+ });
+ ```
+
+- ed09ad8093: Added `LocationSpec`, which was moved over from `@backstage/catalog-model`.
+
+ Added `LocationInput`, which replaced `LocationSpec` where it was used in the `LocationService` and `LocationStore` interfaces. The `LocationInput` type deprecates the `presence` field, which was not being used in those contexts.
+
+- 6d994fd9da: Cleanup catalog-backend API report.
+- 7010349c9a: Added `EntityRelationSpec`, which was moved over from `@backstage/catalog-model`.
+- 6e1cbc12a6: Updated according to the new `getEntityFacets` catalog API method
+- 420f8d710f: Removed the `processors.githubOrg` config section which is unused and has been replaced by the integrations config.
+- b1296f1f57: Deprecated `StaticLocationProcessor` which is unused and replaced by `ConfigLocationEntityProvider`.
+- Updated dependencies
+ - @backstage/backend-common@0.11.0
+ - @backstage/plugin-scaffolder-common@0.2.2
+ - @backstage/catalog-model@0.11.0
+ - @backstage/catalog-client@0.7.2
+ - @backstage/plugin-permission-node@0.5.2
+ - @backstage/integration@0.7.5
+
+## 0.21.5
+
+### Patch Changes
+
+- Fix for the previous release with missing type declarations.
+- Updated dependencies
+ - @backstage/backend-common@0.10.9
+ - @backstage/catalog-client@0.7.1
+ - @backstage/catalog-model@0.10.1
+ - @backstage/config@0.1.15
+ - @backstage/errors@0.2.2
+ - @backstage/integration@0.7.4
+ - @backstage/search-common@0.2.4
+ - @backstage/types@0.1.3
+ - @backstage/plugin-catalog-common@0.1.4
+ - @backstage/plugin-permission-common@0.5.1
+ - @backstage/plugin-permission-node@0.5.1
+ - @backstage/plugin-scaffolder-common@0.2.1
+
+## 0.21.4
+
+### Patch Changes
+
+- 379da9fb1d: The following processors now properly accept an `ScmIntegrationRegistry` (an
+ interface) instead of an `ScmIntegrations` (which is a concrete class).
+
+ - `AzureDevOpsDiscoveryProcessor`
+ - `CodeOwnersProcessor`
+ - `GitLabDiscoveryProcessor`
+ - `GithubDiscoveryProcessor`
+ - `GithubMultiOrgReaderProcessor`
+ - `GithubOrgReaderProcessor`
+
+- 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- 538ca90790: Use updated type names from `@backstage/catalog-client`
+- ca1d6c1788: Support "dependencyOf" relation in Resource entities
+- 244d24ebc4: Import `Location` from the `@backstage/catalog-client` package.
+- e483dd6c72: Update internal `Location` validation.
+- 216725b434: Updated to use new names for `parseLocationRef` and `stringifyLocationRef`
+- e72d371296: Use `TemplateEntityV1beta2` from `@backstage/plugin-scaffolder-common` instead
+ of `@backstage/catalog-model`.
+- 27eccab216: Replaces use of deprecated catalog-model constants.
+- 7aeb491394: Replace use of deprecated `ENTITY_DEFAULT_NAMESPACE` constant with `DEFAULT_NAMESPACE`.
+- b590e9b58d: Optimized entity provider mutations with large numbers of new additions, such as big initial startup commits
+- Updated dependencies
+ - @backstage/plugin-scaffolder-common@0.2.0
+ - @backstage/backend-common@0.10.8
+ - @backstage/catalog-client@0.7.0
+ - @backstage/errors@0.2.1
+ - @backstage/integration@0.7.3
+ - @backstage/plugin-permission-common@0.5.0
+ - @backstage/catalog-model@0.10.0
+ - @backstage/config@0.1.14
+ - @backstage/search-common@0.2.3
+ - @backstage/types@0.1.2
+ - @backstage/plugin-catalog-common@0.1.3
+ - @backstage/plugin-permission-node@0.5.0
+
## 0.21.3
### Patch Changes
@@ -725,16 +894,16 @@
### Minor Changes
-- 8bfc0571c: Add a default catalog value for BitBucketDiscoveryProcessor. This allows to have a target like so: https://bitbucket.mycompany.com/projects/backstage/repos/service-*
- which will be expanded to https://bitbucket.mycompany.com/projects/backstage/repos/service-a/catalog-info.yaml given that repository 'service-a' exists.
+- 8bfc0571c: Add a default catalog value for BitBucketDiscoveryProcessor. This allows to have a target like so: `https://bitbucket.mycompany.com/projects/backstage/repos/service-*`
+ which will be expanded to `https://bitbucket.mycompany.com/projects/backstage/repos/service-a/catalog-info.yaml` given that repository 'service-a' exists.
## Migration
If you are using a custom [Bitbucket parser](https://backstage.io/docs/integrations/bitbucket/discovery#custom-repository-processing) and your `bitbucket-discovery` target (e.g. in your app-config.yaml) omits the catalog path in any of the following ways:
- - https://bitbucket.mycompany.com/projects/backstage/repos/service-*
- - https://bitbucket.mycompany.com/projects/backstage/repos/*
- - https://bitbucket.mycompany.com/projects/backstage/repos/*/
+ - `https://bitbucket.mycompany.com/projects/backstage/repos/service-*`
+ - `https://bitbucket.mycompany.com/projects/backstage/repos/*`
+ - `https://bitbucket.mycompany.com/projects/backstage/repos/*/`
then you will be affected by this change.
The 'target' input to your parser before this commit would be '/', and after this commit it will be '/catalog-info.yaml', and as such needs to be handled to maintain the same functionality.
@@ -1052,7 +1221,7 @@
- 0fd4ea443: Updates the `GithubCredentialsProvider` to return the token type, it can either be `token` or `app` depending on the authentication method.
- Update the `GithubOrgReaderProcessor` NOT to query for email addresses if GitHub Apps is used for authentication, this is due to inconsistencies in the GitHub API when using server to server communications and installation tokens. https://github.community/t/api-v4-unable-to-retrieve-email-resource-not-accessible-by-integration/13831/4 for more info.
+ Update the `GithubOrgReaderProcessor` NOT to query for email addresses if GitHub Apps is used for authentication, this is due to inconsistencies in the GitHub API when using server to server communications and installation tokens. See [this community discussion](https://github.community/t/api-v4-unable-to-retrieve-email-resource-not-accessible-by-integration/13831/4) for more info.
**Removes** deprecated GithubOrgReaderProcessor provider configuration(`catalog.processors.githubOrg`). If you're using the deprecated config section make sure to migrate to [integrations](https://backstage.io/docs/integrations/github/locations) instead.
diff --git a/plugins/catalog-backend/api-report.md b/plugins/catalog-backend/api-report.md
index d97df9967c..9b4db418b3 100644
--- a/plugins/catalog-backend/api-report.md
+++ b/plugins/catalog-backend/api-report.md
@@ -5,7 +5,6 @@
```ts
/// ;
fields: AnalyzeLocationEntityField[];
};
-// Warning: (ae-missing-release-tag) "AnalyzeLocationRequest" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type AnalyzeLocationRequest = {
location: LocationSpec;
};
-// Warning: (ae-missing-release-tag) "AnalyzeLocationResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type AnalyzeLocationResponse = {
existingEntityFiles: AnalyzeLocationExistingEntity[];
generateEntities: AnalyzeLocationGenerateEntity[];
};
-// Warning: (ae-missing-release-tag) "AnnotateLocationEntityProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export class AnnotateLocationEntityProcessor implements CatalogProcessor {
- // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
- constructor(options: Options);
+ constructor(options: { integrations: ScmIntegrationRegistry });
+ // (undocumented)
+ getProcessorName(): string;
// (undocumented)
preProcessEntity(
entity: Entity,
@@ -100,70 +85,23 @@ export class AnnotateLocationEntityProcessor implements CatalogProcessor {
): Promise;
}
-// Warning: (ae-missing-release-tag) "AnnotateScmSlugEntityProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export class AnnotateScmSlugEntityProcessor implements CatalogProcessor {
constructor(opts: { scmIntegrationRegistry: ScmIntegrationRegistry });
// (undocumented)
static fromConfig(config: Config): AnnotateScmSlugEntityProcessor;
// (undocumented)
+ getProcessorName(): string;
+ // (undocumented)
preProcessEntity(entity: Entity, location: LocationSpec): Promise;
}
-// Warning: (ae-missing-release-tag) "AwsOrganizationCloudAccountProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public
-export class AwsOrganizationCloudAccountProcessor implements CatalogProcessor {
- constructor(options: {
- provider: AwsOrganizationProviderConfig;
- logger: Logger_2;
- });
- // (undocumented)
- extractInformationFromArn(arn: string): {
- accountId: string;
- organizationId: string;
- };
- // (undocumented)
- static fromConfig(
- config: Config,
- options: {
- logger: Logger_2;
- },
- ): AwsOrganizationCloudAccountProcessor;
- // (undocumented)
- getAwsAccounts(): Promise;
- // (undocumented)
- logger: Logger_2;
- // (undocumented)
- mapAccountToComponent(account: Account): ResourceEntityV1alpha1;
- // (undocumented)
- normalizeName(name: string): string;
- // (undocumented)
- organizations: Organizations;
- // (undocumented)
- provider: AwsOrganizationProviderConfig;
- // (undocumented)
- readLocation(
- location: LocationSpec,
- _optional: boolean,
- emit: CatalogProcessorEmit,
- ): Promise;
-}
-
-// Warning: (ae-missing-release-tag) "AwsOrganizationProviderConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public
-export type AwsOrganizationProviderConfig = {
- roleArn?: string;
-};
-
-// Warning: (ae-missing-release-tag) "AwsS3DiscoveryProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export class AwsS3DiscoveryProcessor implements CatalogProcessor {
constructor(reader: UrlReader);
// (undocumented)
+ getProcessorName(): string;
+ // (undocumented)
readLocation(
location: LocationSpec,
optional: boolean,
@@ -172,8 +110,6 @@ export class AwsS3DiscoveryProcessor implements CatalogProcessor {
): Promise;
}
-// Warning: (ae-missing-release-tag) "AzureDevOpsDiscoveryProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public
export class AzureDevOpsDiscoveryProcessor implements CatalogProcessor {
constructor(options: {
@@ -188,6 +124,8 @@ export class AzureDevOpsDiscoveryProcessor implements CatalogProcessor {
},
): AzureDevOpsDiscoveryProcessor;
// (undocumented)
+ getProcessorName(): string;
+ // (undocumented)
readLocation(
location: LocationSpec,
_optional: boolean,
@@ -195,8 +133,6 @@ export class AzureDevOpsDiscoveryProcessor implements CatalogProcessor {
): Promise;
}
-// Warning: (ae-missing-release-tag) "BitbucketDiscoveryProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export class BitbucketDiscoveryProcessor implements CatalogProcessor {
constructor(options: {
@@ -213,6 +149,8 @@ export class BitbucketDiscoveryProcessor implements CatalogProcessor {
},
): BitbucketDiscoveryProcessor;
// (undocumented)
+ getProcessorName(): string;
+ // (undocumented)
readLocation(
location: LocationSpec,
_optional: boolean,
@@ -220,8 +158,6 @@ export class BitbucketDiscoveryProcessor implements CatalogProcessor {
): Promise;
}
-// Warning: (ae-missing-release-tag) "BitbucketRepositoryParser" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type BitbucketRepositoryParser = (options: {
integration: BitbucketIntegration;
@@ -229,10 +165,10 @@ export type BitbucketRepositoryParser = (options: {
logger: Logger_2;
}) => AsyncIterable;
-// Warning: (ae-missing-release-tag) "BuiltinKindsEntityProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export class BuiltinKindsEntityProcessor implements CatalogProcessor {
+ // (undocumented)
+ getProcessorName(): string;
// (undocumented)
postProcessEntity(
entity: Entity,
@@ -303,8 +239,6 @@ export const catalogConditions: Conditions<{
>;
}>;
-// Warning: (ae-missing-release-tag) "CatalogEntityDocument" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export interface CatalogEntityDocument extends IndexableDocument {
// (undocumented)
@@ -319,8 +253,6 @@ export interface CatalogEntityDocument extends IndexableDocument {
owner: string;
}
-// Warning: (ae-missing-release-tag) "CatalogEnvironment" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type CatalogEnvironment = {
logger: Logger_2;
@@ -330,8 +262,6 @@ export type CatalogEnvironment = {
permissions: PermissionAuthorizer;
};
-// Warning: (ae-missing-release-tag) "CatalogProcessingEngine" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export interface CatalogProcessingEngine {
// (undocumented)
@@ -340,19 +270,15 @@ export interface CatalogProcessingEngine {
stop(): Promise;
}
-// Warning: (ae-missing-release-tag) "CatalogProcessingOrchestrator" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export interface CatalogProcessingOrchestrator {
// (undocumented)
process(request: EntityProcessingRequest): Promise;
}
-// Warning: (ae-missing-release-tag) "CatalogProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type CatalogProcessor = {
- getProcessorName?(): string;
+ getProcessorName(): string;
readLocation?(
location: LocationSpec,
optional: boolean,
@@ -387,13 +313,9 @@ export interface CatalogProcessorCache {
set(key: string, value: ItemType): Promise;
}
-// Warning: (ae-missing-release-tag) "CatalogProcessorEmit" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type CatalogProcessorEmit = (generated: CatalogProcessorResult) => void;
-// Warning: (ae-missing-release-tag) "CatalogProcessorEntityResult" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type CatalogProcessorEntityResult = {
type: 'entity';
@@ -401,8 +323,6 @@ export type CatalogProcessorEntityResult = {
location: LocationSpec;
};
-// Warning: (ae-missing-release-tag) "CatalogProcessorErrorResult" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type CatalogProcessorErrorResult = {
type: 'error';
@@ -410,25 +330,19 @@ export type CatalogProcessorErrorResult = {
location: LocationSpec;
};
-// Warning: (ae-missing-release-tag) "CatalogProcessorLocationResult" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type CatalogProcessorLocationResult = {
type: 'location';
location: LocationSpec;
- optional: boolean;
+ optional?: boolean;
};
-// Warning: (ae-missing-release-tag) "CatalogProcessorParser" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public
export type CatalogProcessorParser = (options: {
data: Buffer;
location: LocationSpec;
}) => AsyncIterable;
-// Warning: (ae-missing-release-tag) "CatalogProcessorRelationResult" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type CatalogProcessorRelationResult = {
type: 'relation';
@@ -436,8 +350,6 @@ export type CatalogProcessorRelationResult = {
entityRef?: string;
};
-// Warning: (ae-missing-release-tag) "CatalogProcessorResult" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type CatalogProcessorResult =
| CatalogProcessorLocationResult
@@ -461,8 +373,6 @@ export type CatalogRulesEnforcer = {
isAllowed(entity: Entity, location: LocationSpec): boolean;
};
-// Warning: (ae-missing-release-tag) "CodeOwnersProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export class CodeOwnersProcessor implements CatalogProcessor {
constructor(options: {
@@ -479,6 +389,8 @@ export class CodeOwnersProcessor implements CatalogProcessor {
},
): CodeOwnersProcessor;
// (undocumented)
+ getProcessorName(): string;
+ // (undocumented)
preProcessEntity(entity: Entity, location: LocationSpec): Promise;
}
@@ -492,8 +404,6 @@ export const createCatalogPolicyDecision: (
conditions: PermissionCriteria>,
) => ConditionalPolicyDecision;
-// Warning: (ae-missing-release-tag) "createRandomRefreshInterval" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public
export function createRandomRefreshInterval(options: {
minSeconds: number;
@@ -503,8 +413,6 @@ export function createRandomRefreshInterval(options: {
// @public
export function createRouter(options: RouterOptions): Promise;
-// Warning: (ae-missing-release-tag) "DefaultCatalogCollator" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export class DefaultCatalogCollator implements DocumentCollator {
constructor(options: {
@@ -546,8 +454,6 @@ export class DefaultCatalogCollator implements DocumentCollator {
readonly visibilityPermission: Permission;
}
-// Warning: (ae-missing-release-tag) "DefaultCatalogProcessingOrchestrator" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export class DefaultCatalogProcessingOrchestrator
implements CatalogProcessingOrchestrator
@@ -572,19 +478,12 @@ export class DefaultCatalogRulesEnforcer implements CatalogRulesEnforcer {
isAllowed(entity: Entity, location: LocationSpec): boolean;
}
-// Warning: (ae-missing-release-tag) "DeferredEntity" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export type DeferredEntity = {
entity: Entity;
locationKey?: string;
};
-// Warning: (ae-missing-release-tag) "durationText" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public
-export function durationText(startTimestamp: [number, number]): string;
-
// @public (undocumented)
export type EntitiesCatalog = {
entities(request?: EntitiesRequest): Promise;
@@ -600,10 +499,9 @@ export type EntitiesCatalog = {
authorizationToken?: string;
},
): Promise;
+ facets(request: EntityFacetsRequest): Promise;
};
-// Warning: (ae-missing-release-tag) "EntitiesRequest" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type EntitiesRequest = {
filter?: EntityFilter;
@@ -612,24 +510,18 @@ export type EntitiesRequest = {
authorizationToken?: string;
};
-// Warning: (ae-missing-release-tag) "EntitiesResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type EntitiesResponse = {
entities: Entity[];
pageInfo: PageInfo;
};
-// Warning: (ae-missing-release-tag) "EntitiesSearchFilter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public
export type EntitiesSearchFilter = {
key: string;
values?: string[];
};
-// Warning: (ae-missing-release-tag) "entity" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
function entity(
atLocation: LocationSpec,
@@ -645,8 +537,24 @@ export type EntityAncestryResponse = {
}>;
};
-// Warning: (ae-missing-release-tag) "EntityFilter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
+// @public
+export interface EntityFacetsRequest {
+ authorizationToken?: string;
+ facets: string[];
+ filter?: EntityFilter;
+}
+
+// @public
+export interface EntityFacetsResponse {
+ facets: Record<
+ string,
+ Array<{
+ value: string;
+ count: number;
+ }>
+ >;
+}
+
// @public
export type EntityFilter =
| {
@@ -660,8 +568,6 @@ export type EntityFilter =
}
| EntitiesSearchFilter;
-// Warning: (ae-missing-release-tag) "EntityPagination" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public
export type EntityPagination = {
limit?: number;
@@ -669,17 +575,13 @@ export type EntityPagination = {
after?: string;
};
-// Warning: (ae-missing-release-tag) "EntityProcessingRequest" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export type EntityProcessingRequest = {
entity: Entity;
state?: JsonObject;
};
-// Warning: (ae-missing-release-tag) "EntityProcessingResult" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export type EntityProcessingResult =
| {
ok: true;
@@ -694,27 +596,18 @@ export type EntityProcessingResult =
errors: Error[];
};
-// Warning: (ae-missing-release-tag) "EntityProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export interface EntityProvider {
- // (undocumented)
connect(connection: EntityProviderConnection): Promise;
- // (undocumented)
getProviderName(): string;
}
-// Warning: (ae-missing-release-tag) "EntityProviderConnection" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export interface EntityProviderConnection {
- // (undocumented)
applyMutation(mutation: EntityProviderMutation): Promise;
}
-// Warning: (ae-missing-release-tag) "EntityProviderMutation" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export type EntityProviderMutation =
| {
type: 'full';
@@ -726,10 +619,17 @@ export type EntityProviderMutation =
removed: DeferredEntity[];
};
-// Warning: (ae-missing-release-tag) "FileReaderProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
+// @public
+export type EntityRelationSpec = {
+ source: EntityName;
+ type: string;
+ target: EntityName;
+};
+
// @public (undocumented)
export class FileReaderProcessor implements CatalogProcessor {
+ // (undocumented)
+ getProcessorName(): string;
// (undocumented)
readLocation(
location: LocationSpec,
@@ -739,16 +639,12 @@ export class FileReaderProcessor implements CatalogProcessor {
): Promise;
}
-// Warning: (ae-missing-release-tag) "generalError" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
function generalError(
atLocation: LocationSpec,
message: string,
): CatalogProcessorResult;
-// Warning: (ae-missing-release-tag) "GithubDiscoveryProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public
export class GithubDiscoveryProcessor implements CatalogProcessor {
constructor(options: {
@@ -765,6 +661,8 @@ export class GithubDiscoveryProcessor implements CatalogProcessor {
},
): GithubDiscoveryProcessor;
// (undocumented)
+ getProcessorName(): string;
+ // (undocumented)
readLocation(
location: LocationSpec,
_optional: boolean,
@@ -772,6 +670,13 @@ export class GithubDiscoveryProcessor implements CatalogProcessor {
): Promise;
}
+// @public
+export type GithubMultiOrgConfig = Array<{
+ name: string;
+ groupNamespace: string;
+ userNamespace: string | undefined;
+}>;
+
// @alpha
export class GithubMultiOrgReaderProcessor implements CatalogProcessor {
constructor(options: {
@@ -789,6 +694,8 @@ export class GithubMultiOrgReaderProcessor implements CatalogProcessor {
},
): GithubMultiOrgReaderProcessor;
// (undocumented)
+ getProcessorName(): string;
+ // (undocumented)
readLocation(
location: LocationSpec,
_optional: boolean,
@@ -796,8 +703,6 @@ export class GithubMultiOrgReaderProcessor implements CatalogProcessor {
): Promise;
}
-// Warning: (ae-missing-release-tag) "GitHubOrgEntityProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export class GitHubOrgEntityProvider implements EntityProvider {
constructor(options: {
@@ -825,8 +730,6 @@ export class GitHubOrgEntityProvider implements EntityProvider {
read(): Promise;
}
-// Warning: (ae-missing-release-tag) "GithubOrgReaderProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public
export class GithubOrgReaderProcessor implements CatalogProcessor {
constructor(options: {
@@ -843,6 +746,8 @@ export class GithubOrgReaderProcessor implements CatalogProcessor {
},
): GithubOrgReaderProcessor;
// (undocumented)
+ getProcessorName(): string;
+ // (undocumented)
readLocation(
location: LocationSpec,
_optional: boolean,
@@ -850,8 +755,6 @@ export class GithubOrgReaderProcessor implements CatalogProcessor {
): Promise;
}
-// Warning: (ae-missing-release-tag) "GitLabDiscoveryProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public
export class GitLabDiscoveryProcessor implements CatalogProcessor {
// (undocumented)
@@ -862,33 +765,27 @@ export class GitLabDiscoveryProcessor implements CatalogProcessor {
},
): GitLabDiscoveryProcessor;
// (undocumented)
+ getProcessorName(): string;
+ // (undocumented)
readLocation(
location: LocationSpec,
_optional: boolean,
emit: CatalogProcessorEmit,
): Promise;
- // (undocumented)
- updateLastActivity(): Promise;
}
-// Warning: (ae-missing-release-tag) "inputError" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
function inputError(
atLocation: LocationSpec,
message: string,
): CatalogProcessorResult;
-// Warning: (ae-missing-release-tag) "location" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
function location_2(
newLocation: LocationSpec,
- optional: boolean,
+ optional?: boolean,
): CatalogProcessorResult;
-// Warning: (ae-missing-release-tag) "LocationAnalyzer" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type LocationAnalyzer = {
analyzeLocation(
@@ -896,12 +793,12 @@ export type LocationAnalyzer = {
): Promise;
};
-// Warning: (ae-missing-release-tag) "LocationEntityProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export class LocationEntityProcessor implements CatalogProcessor {
constructor(options: LocationEntityProcessorOptions);
// (undocumented)
+ getProcessorName(): string;
+ // (undocumented)
postProcessEntity(
entity: Entity,
location: LocationSpec,
@@ -909,20 +806,26 @@ export class LocationEntityProcessor implements CatalogProcessor {
): Promise;
}
-// Warning: (ae-missing-release-tag) "LocationEntityProcessorOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type LocationEntityProcessorOptions = {
integrations: ScmIntegrationRegistry;
};
-// Warning: (ae-missing-release-tag) "LocationService" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
+export interface LocationInput {
+ // @deprecated (undocumented)
+ presence?: 'optional' | 'required';
+ // (undocumented)
+ target: string;
+ // (undocumented)
+ type: string;
+}
+
+// @public
export interface LocationService {
// (undocumented)
createLocation(
- spec: LocationSpec,
+ location: LocationInput,
dryRun: boolean,
options?: {
authorizationToken?: string;
@@ -952,12 +855,17 @@ export interface LocationService {
}): Promise;
}
-// Warning: (ae-missing-release-tag) "LocationStore" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
+export type LocationSpec = {
+ type: string;
+ target: string;
+ presence?: 'optional' | 'required';
+};
+
+// @public
export interface LocationStore {
// (undocumented)
- createLocation(spec: LocationSpec): Promise;
+ createLocation(location: LocationInput): Promise;
// (undocumented)
deleteLocation(id: string): Promise;
// (undocumented)
@@ -966,16 +874,12 @@ export interface LocationStore {
listLocations(): Promise;
}
-// Warning: (ae-missing-release-tag) "notFoundError" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
function notFoundError(
atLocation: LocationSpec,
message: string,
): CatalogProcessorResult;
-// Warning: (ae-missing-release-tag) "PageInfo" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type PageInfo =
| {
@@ -986,8 +890,6 @@ export type PageInfo =
endCursor: string;
};
-// Warning: (ae-missing-release-tag) "parseEntityYaml" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export function parseEntityYaml(
data: Buffer,
@@ -1020,17 +922,15 @@ export const permissionRules: {
>;
};
-// Warning: (ae-missing-release-tag) "PlaceholderProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public
export class PlaceholderProcessor implements CatalogProcessor {
constructor(options: PlaceholderProcessorOptions);
// (undocumented)
+ getProcessorName(): string;
+ // (undocumented)
preProcessEntity(entity: Entity, location: LocationSpec): Promise;
}
-// Warning: (ae-missing-release-tag) "PlaceholderProcessorOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type PlaceholderProcessorOptions = {
resolvers: Record;
@@ -1038,15 +938,11 @@ export type PlaceholderProcessorOptions = {
integrations: ScmIntegrationRegistry;
};
-// Warning: (ae-missing-release-tag) "PlaceholderResolver" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type PlaceholderResolver = (
params: PlaceholderResolverParams,
) => Promise;
-// Warning: (ae-missing-release-tag) "PlaceholderResolverParams" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type PlaceholderResolverParams = {
key: string;
@@ -1056,21 +952,15 @@ export type PlaceholderResolverParams = {
resolveUrl: PlaceholderResolverResolveUrl;
};
-// Warning: (ae-missing-release-tag) "PlaceholderResolverRead" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type PlaceholderResolverRead = (url: string) => Promise;
-// Warning: (ae-missing-release-tag) "PlaceholderResolverResolveUrl" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export type PlaceholderResolverResolveUrl = (
url: string,
base: string,
) => string;
-// Warning: (ae-missing-release-tag) "RecursivePartial" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public
export type RecursivePartial = {
[P in keyof T]?: T[P] extends (infer U)[]
@@ -1080,8 +970,6 @@ export type RecursivePartial = {
: T[P];
};
-// Warning: (ae-missing-release-tag) "RefreshIntervalFunction" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public
export type RefreshIntervalFunction = () => number;
@@ -1096,8 +984,6 @@ export interface RefreshService {
refresh(options: RefreshOptions): Promise;
}
-// Warning: (ae-missing-release-tag) "relation" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
function relation(spec: EntityRelationSpec): CatalogProcessorResult;
@@ -1131,14 +1017,10 @@ export interface RouterOptions {
refreshService?: RefreshService;
}
-// Warning: (ae-missing-release-tag) "runPeriodically" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public
+// @public @deprecated
export function runPeriodically(fn: () => any, delayMs: number): () => void;
-// Warning: (ae-missing-release-tag) "StaticLocationProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public @deprecated (undocumented)
export class StaticLocationProcessor implements StaticLocationProcessor {
constructor(staticLocations: LocationSpec[]);
// (undocumented)
@@ -1151,12 +1033,9 @@ export class StaticLocationProcessor implements StaticLocationProcessor {
): Promise;
}
-// Warning: (ae-missing-release-tag) "UrlReaderProcessor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public (undocumented)
export class UrlReaderProcessor implements CatalogProcessor {
- // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
- constructor(options: Options_2);
+ constructor(options: { reader: UrlReader; logger: Logger_2 });
// (undocumented)
getProcessorName(): string;
// (undocumented)
@@ -1168,8 +1047,4 @@ export class UrlReaderProcessor implements CatalogProcessor {
cache: CatalogProcessorCache,
): Promise;
}
-
-// Warnings were encountered during analysis:
-//
-// src/ingestion/processors/GithubMultiOrgReaderProcessor.d.ts:25:9 - (ae-forgotten-export) The symbol "GithubMultiOrgConfig" needs to be exported by the entry point index.d.ts
```
diff --git a/plugins/catalog-backend/config.d.ts b/plugins/catalog-backend/config.d.ts
index 5701c9df48..957f18c15f 100644
--- a/plugins/catalog-backend/config.d.ts
+++ b/plugins/catalog-backend/config.d.ts
@@ -14,8 +14,6 @@
* limitations under the License.
*/
-import { JsonValue } from '@backstage/config';
-
export interface Config {
/**
* Configuration options for the catalog plugin.
@@ -112,39 +110,6 @@ export interface Config {
* List of processor-specific options and attributes
*/
processors?: {
- /**
- * GithubOrgReaderProcessor configuration
- *
- * @deprecated Configure a GitHub integration instead.
- */
- githubOrg?: {
- /**
- * The configuration parameters for each single GitHub org provider.
- */
- providers: Array<{
- /**
- * The prefix of the target that this matches on, e.g.
- * "https://github.com", with no trailing slash.
- */
- target: string;
- /**
- * The base URL of the API of this provider, e.g.
- * "https://api.github.com", with no trailing slash.
- *
- * May be omitted specifically for GitHub; then it will be deduced.
- */
- apiBaseUrl?: string;
- /**
- * The authorization token to use for requests to this provider.
- *
- * If no token is specified, anonymous access is used.
- *
- * @visibility secret
- */
- token?: string;
- }>;
- };
-
/**
* GithubMultiOrgReaderProcessor configuration
*/
@@ -172,19 +137,6 @@ export interface Config {
userNamespace?: string;
}>;
};
-
- /**
- * AwsOrganizationCloudAccountProcessor configuration
- */
- awsOrganization?: {
- provider: {
- /**
- * The role to be assumed by this processor
- *
- */
- roleArn?: string;
- };
- };
};
};
}
diff --git a/plugins/airbrake/src/EntityAirbrakeContent.test.tsx b/plugins/catalog-backend/migrations/20220222164811_reprocess_for_relation_refs.js
similarity index 61%
rename from plugins/airbrake/src/EntityAirbrakeContent.test.tsx
rename to plugins/catalog-backend/migrations/20220222164811_reprocess_for_relation_refs.js
index f0afef425f..f4be2172a0 100644
--- a/plugins/airbrake/src/EntityAirbrakeContent.test.tsx
+++ b/plugins/catalog-backend/migrations/20220222164811_reprocess_for_relation_refs.js
@@ -13,13 +13,19 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import React from 'react';
-import { EntityAirbrakeContent } from './plugin';
-import { renderInTestApp } from '@backstage/test-utils';
-describe('The Airbrake entity', () => {
- it('should render the content properly', async () => {
- const rendered = await renderInTestApp(>;
+}
+
/** @public */
export type EntitiesCatalog = {
/**
@@ -115,4 +159,12 @@ export type EntitiesCatalog = {
entityRef: string,
options?: { authorizationToken?: string },
): Promise;
+
+ /**
+ * Computes facets for a set of entities, e.g. for populating filter lists
+ * or driving insights or similar.
+ *
+ * @param request - Request options
+ */
+ facets(request: EntityFacetsRequest): Promise;
};
diff --git a/plugins/catalog-backend/src/database/types.ts b/plugins/catalog-backend/src/database/types.ts
index ac2ff07498..08201323ea 100644
--- a/plugins/catalog-backend/src/database/types.ts
+++ b/plugins/catalog-backend/src/database/types.ts
@@ -14,10 +14,10 @@
* limitations under the License.
*/
-import { Entity, EntityRelationSpec } from '@backstage/catalog-model';
+import { Entity } from '@backstage/catalog-model';
import { JsonObject } from '@backstage/types';
import { DateTime } from 'luxon';
-import { DeferredEntity } from '../processing/types';
+import { DeferredEntity, EntityRelationSpec } from '../processing/types';
/**
* An abstraction for transactions of the underlying database technology.
diff --git a/plugins/catalog-backend/src/ingestion/CatalogRules.test.ts b/plugins/catalog-backend/src/ingestion/CatalogRules.test.ts
index 24d6b2fd66..d29a445a8c 100644
--- a/plugins/catalog-backend/src/ingestion/CatalogRules.test.ts
+++ b/plugins/catalog-backend/src/ingestion/CatalogRules.test.ts
@@ -14,9 +14,10 @@
* limitations under the License.
*/
-import { Entity, LocationSpec } from '@backstage/catalog-model';
+import { Entity } from '@backstage/catalog-model';
import { ConfigReader } from '@backstage/config';
import { DefaultCatalogRulesEnforcer } from './CatalogRules';
+import { LocationSpec } from './processors';
const entity = {
user: {
@@ -35,11 +36,11 @@ const entity = {
const location: Record = {
x: {
- type: 'github',
+ type: 'url',
target: 'https://github.com/a/b/blob/master/x.yaml',
},
y: {
- type: 'github',
+ type: 'url',
target: 'https://github.com/a/b/blob/master/y.yaml',
},
z: {
@@ -180,7 +181,7 @@ describe('DefaultCatalogRulesEnforcer', () => {
rules: [{ allow: ['user'] }],
locations: [
{
- type: 'github',
+ type: 'url',
target: 'https://github.com/a/b/blob/master/x.yaml',
rules: [
{
@@ -204,7 +205,7 @@ describe('DefaultCatalogRulesEnforcer', () => {
const enforcer = DefaultCatalogRulesEnforcer.fromConfig(
new ConfigReader({
catalog: {
- rules: [{ allow: ['Group'], locations: [{ type: 'github' }] }],
+ rules: [{ allow: ['Group'], locations: [{ type: 'url' }] }],
},
}),
);
diff --git a/plugins/catalog-backend/src/ingestion/CatalogRules.ts b/plugins/catalog-backend/src/ingestion/CatalogRules.ts
index a0ef5f3d53..b4ad394168 100644
--- a/plugins/catalog-backend/src/ingestion/CatalogRules.ts
+++ b/plugins/catalog-backend/src/ingestion/CatalogRules.ts
@@ -15,8 +15,9 @@
*/
import { Config } from '@backstage/config';
-import { LocationSpec, Entity } from '@backstage/catalog-model';
+import { Entity } from '@backstage/catalog-model';
import path from 'path';
+import { LocationSpec } from './processors';
/**
* Rules to apply to catalog entities.
diff --git a/plugins/catalog-backend/src/ingestion/processors/AnnotateLocationEntityProcessor.test.ts b/plugins/catalog-backend/src/ingestion/processors/AnnotateLocationEntityProcessor.test.ts
index 41d44ab157..5f5b20d1c2 100644
--- a/plugins/catalog-backend/src/ingestion/processors/AnnotateLocationEntityProcessor.test.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/AnnotateLocationEntityProcessor.test.ts
@@ -14,9 +14,10 @@
* limitations under the License.
*/
-import { Entity, LocationSpec } from '@backstage/catalog-model';
+import { Entity } from '@backstage/catalog-model';
import { ConfigReader } from '@backstage/config';
import { ScmIntegrations } from '@backstage/integration';
+import { LocationSpec } from './types';
import { AnnotateLocationEntityProcessor } from './AnnotateLocationEntityProcessor';
describe('AnnotateLocationEntityProcessor', () => {
diff --git a/plugins/catalog-backend/src/ingestion/processors/AnnotateLocationEntityProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/AnnotateLocationEntityProcessor.ts
index 8adbaec628..b8c31ed5a2 100644
--- a/plugins/catalog-backend/src/ingestion/processors/AnnotateLocationEntityProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/AnnotateLocationEntityProcessor.ts
@@ -21,19 +21,23 @@ import {
ANNOTATION_SOURCE_LOCATION,
ANNOTATION_VIEW_URL,
Entity,
- LocationSpec,
stringifyLocationRef,
} from '@backstage/catalog-model';
import { ScmIntegrationRegistry } from '@backstage/integration';
import { identity, merge, pickBy } from 'lodash';
-import { CatalogProcessor, CatalogProcessorEmit } from './types';
-
-type Options = {
- integrations: ScmIntegrationRegistry;
-};
+import { CatalogProcessor, CatalogProcessorEmit, LocationSpec } from './types';
+/** @public */
export class AnnotateLocationEntityProcessor implements CatalogProcessor {
- constructor(private readonly options: Options) {}
+ constructor(
+ private readonly options: {
+ integrations: ScmIntegrationRegistry;
+ },
+ ) {}
+
+ getProcessorName(): string {
+ return 'AnnotateLocationEntityProcessor';
+ }
async preProcessEntity(
entity: Entity,
diff --git a/plugins/catalog-backend/src/ingestion/processors/AnnotateScmSlugEntityProcessor.test.ts b/plugins/catalog-backend/src/ingestion/processors/AnnotateScmSlugEntityProcessor.test.ts
index 5bdf4a4b83..311dd13789 100644
--- a/plugins/catalog-backend/src/ingestion/processors/AnnotateScmSlugEntityProcessor.test.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/AnnotateScmSlugEntityProcessor.test.ts
@@ -13,9 +13,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import { Entity, LocationSpec } from '@backstage/catalog-model';
+import { Entity } from '@backstage/catalog-model';
import { ConfigReader } from '@backstage/config';
import { AnnotateScmSlugEntityProcessor } from './AnnotateScmSlugEntityProcessor';
+import { LocationSpec } from './types';
describe('AnnotateScmSlugEntityProcessor', () => {
describe('github', () => {
diff --git a/plugins/catalog-backend/src/ingestion/processors/AnnotateScmSlugEntityProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/AnnotateScmSlugEntityProcessor.ts
index 483472da4b..4d3b3aff6c 100644
--- a/plugins/catalog-backend/src/ingestion/processors/AnnotateScmSlugEntityProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/AnnotateScmSlugEntityProcessor.ts
@@ -13,7 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import { Entity, LocationSpec } from '@backstage/catalog-model';
+import { Entity } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
import {
ScmIntegrationRegistry,
@@ -21,15 +21,20 @@ import {
} from '@backstage/integration';
import parseGitUrl from 'git-url-parse';
import { identity, merge, pickBy } from 'lodash';
-import { CatalogProcessor } from './types';
+import { CatalogProcessor, LocationSpec } from './types';
const GITHUB_ACTIONS_ANNOTATION = 'github.com/project-slug';
+/** @public */
export class AnnotateScmSlugEntityProcessor implements CatalogProcessor {
constructor(
private readonly opts: { scmIntegrationRegistry: ScmIntegrationRegistry },
) {}
+ getProcessorName(): string {
+ return 'AnnotateScmSlugEntityProcessor';
+ }
+
static fromConfig(config: Config): AnnotateScmSlugEntityProcessor {
return new AnnotateScmSlugEntityProcessor({
scmIntegrationRegistry: ScmIntegrations.fromConfig(config),
diff --git a/plugins/catalog-backend/src/ingestion/processors/AwsS3DiscoveryProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/AwsS3DiscoveryProcessor.ts
index 63bc45726d..0dc44cc157 100644
--- a/plugins/catalog-backend/src/ingestion/processors/AwsS3DiscoveryProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/AwsS3DiscoveryProcessor.ts
@@ -15,7 +15,6 @@
*/
import { UrlReader } from '@backstage/backend-common';
-import { LocationSpec } from '@backstage/catalog-model';
import { isError } from '@backstage/errors';
import limiterFactory from 'p-limit';
import * as result from './results';
@@ -23,11 +22,17 @@ import {
CatalogProcessor,
CatalogProcessorEmit,
CatalogProcessorParser,
+ LocationSpec,
} from './types';
+/** @public */
export class AwsS3DiscoveryProcessor implements CatalogProcessor {
constructor(private readonly reader: UrlReader) {}
+ getProcessorName(): string {
+ return 'AwsS3DiscoveryProcessor';
+ }
+
async readLocation(
location: LocationSpec,
optional: boolean,
diff --git a/plugins/catalog-backend/src/ingestion/processors/AzureDevOpsDiscoveryProcessor.test.ts b/plugins/catalog-backend/src/ingestion/processors/AzureDevOpsDiscoveryProcessor.test.ts
index 463d982ca2..a406feaa74 100644
--- a/plugins/catalog-backend/src/ingestion/processors/AzureDevOpsDiscoveryProcessor.test.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/AzureDevOpsDiscoveryProcessor.test.ts
@@ -15,13 +15,13 @@
*/
import { getVoidLogger } from '@backstage/backend-common';
-import { LocationSpec } from '@backstage/catalog-model';
import { ConfigReader } from '@backstage/config';
import { codeSearch } from './azure';
import {
AzureDevOpsDiscoveryProcessor,
parseUrl,
} from './AzureDevOpsDiscoveryProcessor';
+import { LocationSpec } from './types';
jest.mock('./azure');
const mockCodeSearch = codeSearch as jest.MockedFunction;
@@ -167,7 +167,6 @@ describe('AzureDevOpsDiscoveryProcessor', () => {
'https://dev.azure.com/shopify/engineering/_git/backstage?path=/catalog-info.yaml',
presence: 'optional',
},
- optional: true,
});
expect(emitter).toHaveBeenCalledWith({
type: 'location',
@@ -177,7 +176,6 @@ describe('AzureDevOpsDiscoveryProcessor', () => {
'https://dev.azure.com/shopify/engineering/_git/ios-app?path=/src/catalog-info.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -215,7 +213,6 @@ describe('AzureDevOpsDiscoveryProcessor', () => {
'https://dev.azure.com/shopify/engineering/_git/backstage?path=/catalog-info.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -254,7 +251,6 @@ describe('AzureDevOpsDiscoveryProcessor', () => {
'https://dev.azure.com/shopify/engineering/_git/backstage?path=/src/main/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
});
diff --git a/plugins/catalog-backend/src/ingestion/processors/AzureDevOpsDiscoveryProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/AzureDevOpsDiscoveryProcessor.ts
index 4f5df6f656..bc74621f1d 100644
--- a/plugins/catalog-backend/src/ingestion/processors/AzureDevOpsDiscoveryProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/AzureDevOpsDiscoveryProcessor.ts
@@ -14,7 +14,6 @@
* limitations under the License.
*/
-import { LocationSpec } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
import {
ScmIntegrationRegistry,
@@ -22,7 +21,7 @@ import {
} from '@backstage/integration';
import { Logger } from 'winston';
import * as results from './results';
-import { CatalogProcessor, CatalogProcessorEmit } from './types';
+import { CatalogProcessor, CatalogProcessorEmit, LocationSpec } from './types';
import { codeSearch } from './azure';
/**
@@ -38,6 +37,8 @@ import { codeSearch } from './azure';
* You may also explicitly specify a single repo:
*
* target: https://dev.azure.com/org/project/_git/repo
+ *
+ * @public
**/
export class AzureDevOpsDiscoveryProcessor implements CatalogProcessor {
private readonly integrations: ScmIntegrationRegistry;
@@ -60,6 +61,10 @@ export class AzureDevOpsDiscoveryProcessor implements CatalogProcessor {
this.logger = options.logger;
}
+ getProcessorName(): string {
+ return 'AzureDevOpsDiscoveryProcessor';
+ }
+
async readLocation(
location: LocationSpec,
_optional: boolean,
@@ -97,17 +102,14 @@ export class AzureDevOpsDiscoveryProcessor implements CatalogProcessor {
for (const file of files) {
emit(
- results.location(
- {
- type: 'url',
- target: `${baseUrl}/${org}/${project}/_git/${file.repository.name}?path=${file.path}`,
- presence: 'optional',
- },
+ results.location({
+ type: 'url',
+ target: `${baseUrl}/${org}/${project}/_git/${file.repository.name}?path=${file.path}`,
// Not all locations may actually exist, since the user defined them as a wildcard pattern.
// Thus, we emit them as optional and let the downstream processor find them while not outputting
// an error if it couldn't.
- true,
- ),
+ presence: 'optional',
+ }),
);
}
diff --git a/plugins/catalog-backend/src/ingestion/processors/BitbucketDiscoveryProcessor.test.ts b/plugins/catalog-backend/src/ingestion/processors/BitbucketDiscoveryProcessor.test.ts
index 7ace995fda..9ee8bf1b57 100644
--- a/plugins/catalog-backend/src/ingestion/processors/BitbucketDiscoveryProcessor.test.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/BitbucketDiscoveryProcessor.test.ts
@@ -16,13 +16,13 @@
import { getVoidLogger } from '@backstage/backend-common';
import { BitbucketDiscoveryProcessor } from './BitbucketDiscoveryProcessor';
import { ConfigReader } from '@backstage/config';
-import { LocationSpec } from '@backstage/catalog-model';
import {
BitbucketRepository20,
BitbucketRepositoryParser,
PagedResponse,
PagedResponse20,
} from './bitbucket';
+import { LocationSpec } from './types';
import { results } from './index';
import { RequestHandler, rest } from 'msw';
import { setupServer } from 'msw/node';
@@ -210,7 +210,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.mycompany.com/projects/backstage/repos/backstage/browse/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
expect(emitter).toHaveBeenCalledWith({
type: 'location',
@@ -220,7 +219,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.mycompany.com/projects/demo/repos/demo/browse/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -246,7 +244,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.mycompany.com/projects/backstage/repos/techdocs-cli/browse/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -269,7 +266,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.mycompany.com/projects/demo/repos/demo/browse/catalog.yaml?ref=branch-name',
presence: 'optional',
},
- optional: true,
});
});
@@ -292,7 +288,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.mycompany.com/projects/backstage/repos/test/browse/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -321,7 +316,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.mycompany.com/projects/backstage/repos/techdocs-cli/browse/catalog-info.yaml',
presence: 'optional',
},
- optional: true,
});
});
});
@@ -369,7 +363,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.mycompany.com/custom-path/projects/backstage/repos/backstage/browse/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
expect(emitter).toHaveBeenCalledWith({
type: 'location',
@@ -379,7 +372,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.mycompany.com/custom-path/projects/demo/repos/demo/browse/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -408,7 +400,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.mycompany.com/custom-path/projects/backstage/repos/techdocs-cli/browse/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -434,7 +425,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.mycompany.com/custom-path/projects/demo/repos/demo/browse/catalog.yaml?ref=branch-name',
presence: 'optional',
},
- optional: true,
});
});
@@ -460,7 +450,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.mycompany.com/custom-path/projects/backstage/repos/test/browse/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -492,7 +481,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.mycompany.com/custom-path/projects/backstage/repos/techdocs-cli/browse/catalog-info.yaml',
presence: 'optional',
},
- optional: true,
});
});
});
@@ -536,7 +524,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.org/myworkspace/repository-one/src/master/catalog-info.yaml',
presence: 'optional',
},
- optional: true,
});
expect(emitter).toHaveBeenCalledWith({
type: 'location',
@@ -546,7 +533,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.org/myworkspace/repository-two/src/master/catalog-info.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -574,7 +560,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.org/myworkspace/repository-one/src/master/my/nested/path/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
expect(emitter).toHaveBeenCalledWith({
type: 'location',
@@ -584,7 +569,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.org/myworkspace/repository-two/src/master/my/nested/path/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -612,7 +596,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.org/myworkspace/repository-one/src/master/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
expect(emitter).toHaveBeenCalledWith({
type: 'location',
@@ -622,7 +605,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.org/myworkspace/repository-two/src/master/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -649,7 +631,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.org/myworkspace/repository-one/src/master/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -677,7 +658,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.org/myworkspace/repository-three/src/master/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -703,7 +683,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.org/myworkspace/repository-one/src/master/catalog-info.yaml',
presence: 'optional',
},
- optional: true,
});
expect(mockCall).toBeCalledTimes(1);
// it should be possible to do this via an `expect.objectContaining` check but seems to fail with some encoding issue.
@@ -739,7 +718,6 @@ describe('BitbucketDiscoveryProcessor', () => {
'https://bitbucket.org/myworkspace/repository-one/src/master/catalog-info.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -766,13 +744,11 @@ describe('BitbucketDiscoveryProcessor', () => {
describe('Custom repository parser', () => {
const customRepositoryParser: BitbucketRepositoryParser =
async function* customRepositoryParser({}) {
- yield results.location(
- {
- type: 'custom-location-type',
- target: 'custom-target',
- },
- true,
- );
+ yield results.location({
+ type: 'custom-location-type',
+ target: 'custom-target',
+ presence: 'optional',
+ });
};
const processor = BitbucketDiscoveryProcessor.fromConfig(
@@ -808,8 +784,8 @@ describe('BitbucketDiscoveryProcessor', () => {
location: {
type: 'custom-location-type',
target: 'custom-target',
+ presence: 'optional',
},
- optional: true,
});
});
});
diff --git a/plugins/catalog-backend/src/ingestion/processors/BitbucketDiscoveryProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/BitbucketDiscoveryProcessor.ts
index f08888d1ab..8fcf64dc55 100644
--- a/plugins/catalog-backend/src/ingestion/processors/BitbucketDiscoveryProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/BitbucketDiscoveryProcessor.ts
@@ -21,7 +21,6 @@ import {
ScmIntegrationRegistry,
ScmIntegrations,
} from '@backstage/integration';
-import { LocationSpec } from '@backstage/catalog-model';
import {
BitbucketRepositoryParser,
BitbucketClient,
@@ -31,12 +30,13 @@ import {
BitbucketRepository,
BitbucketRepository20,
} from './bitbucket';
-import { CatalogProcessor, CatalogProcessorEmit } from './types';
+import { CatalogProcessor, CatalogProcessorEmit, LocationSpec } from './types';
const DEFAULT_BRANCH = 'master';
const DEFAULT_CATALOG_LOCATION = '/catalog-info.yaml';
const EMPTY_CATALOG_LOCATION = '/';
+/** @public */
export class BitbucketDiscoveryProcessor implements CatalogProcessor {
private readonly integrations: ScmIntegrationRegistry;
private readonly parser: BitbucketRepositoryParser;
@@ -64,6 +64,10 @@ export class BitbucketDiscoveryProcessor implements CatalogProcessor {
this.logger = options.logger;
}
+ getProcessorName(): string {
+ return 'BitbucketDiscoveryProcessor';
+ }
+
async readLocation(
location: LocationSpec,
_optional: boolean,
diff --git a/plugins/catalog-backend/src/ingestion/processors/BuiltinKindsEntityProcessor.test.ts b/plugins/catalog-backend/src/ingestion/processors/BuiltinKindsEntityProcessor.test.ts
index c42980d97b..2532293acf 100644
--- a/plugins/catalog-backend/src/ingestion/processors/BuiltinKindsEntityProcessor.test.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/BuiltinKindsEntityProcessor.test.ts
@@ -21,9 +21,9 @@ import {
GroupEntity,
ResourceEntity,
SystemEntity,
- TemplateEntityV1beta2,
UserEntity,
} from '@backstage/catalog-model';
+import { TemplateEntityV1beta2 } from '@backstage/plugin-scaffolder-common';
import { BuiltinKindsEntityProcessor } from './BuiltinKindsEntityProcessor';
describe('BuiltinKindsEntityProcessor', () => {
@@ -187,7 +187,7 @@ describe('BuiltinKindsEntityProcessor', () => {
await expect(
processor.postProcessEntity(entity, location, emit),
).rejects.toThrowError(
- 'Entity reference "r" did not specify a kind (e.g. starting with "Component:"), and has no default',
+ 'Entity reference "r" had missing or empty kind (e.g. did not start with "component:" or similar)',
);
});
@@ -360,7 +360,7 @@ describe('BuiltinKindsEntityProcessor', () => {
await expect(
processor.postProcessEntity(entity, location, emit),
).rejects.toThrowError(
- 'Entity reference "c" did not specify a kind (e.g. starting with "Component:"), and has no default',
+ 'Entity reference "c" had missing or empty kind (e.g. did not start with "component:" or similar)',
);
});
diff --git a/plugins/catalog-backend/src/ingestion/processors/BuiltinKindsEntityProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/BuiltinKindsEntityProcessor.ts
index 5999be9793..89b0bb1bb5 100644
--- a/plugins/catalog-backend/src/ingestion/processors/BuiltinKindsEntityProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/BuiltinKindsEntityProcessor.ts
@@ -26,7 +26,6 @@ import {
GroupEntity,
groupEntityV1alpha1Validator,
locationEntityV1alpha1Validator,
- LocationSpec,
parseEntityRef,
RELATION_API_CONSUMED_BY,
RELATION_API_PROVIDED_BY,
@@ -46,14 +45,17 @@ import {
resourceEntityV1alpha1Validator,
SystemEntity,
systemEntityV1alpha1Validator,
- TemplateEntityV1beta2,
- templateEntityV1beta2Validator,
UserEntity,
userEntityV1alpha1Validator,
} from '@backstage/catalog-model';
+import {
+ TemplateEntityV1beta2,
+ templateEntityV1beta2Validator,
+} from '@backstage/plugin-scaffolder-common';
import * as result from './results';
-import { CatalogProcessor, CatalogProcessorEmit } from './types';
+import { CatalogProcessor, CatalogProcessorEmit, LocationSpec } from './types';
+/** @public */
export class BuiltinKindsEntityProcessor implements CatalogProcessor {
private readonly validators = [
apiEntityV1alpha1Validator,
@@ -67,6 +69,10 @@ export class BuiltinKindsEntityProcessor implements CatalogProcessor {
domainEntityV1alpha1Validator,
];
+ getProcessorName(): string {
+ return 'BuiltinKindsEntityProcessor';
+ }
+
async validateEntityKind(entity: Entity): Promise {
for (const validator of this.validators) {
const results = await validator.check(entity);
@@ -100,11 +106,6 @@ export class BuiltinKindsEntityProcessor implements CatalogProcessor {
}
for (const target of [targets].flat()) {
const targetRef = parseEntityRef(target, context);
- if (targetRef.kind === undefined) {
- throw new Error(
- `Entity reference "${target}" did not specify a kind (e.g. starting with "Component:"), and has no default`,
- );
- }
emit(
result.relation({
source: selfRef,
diff --git a/plugins/catalog-backend/src/ingestion/processors/CodeOwnersProcessor.test.ts b/plugins/catalog-backend/src/ingestion/processors/CodeOwnersProcessor.test.ts
index 2f52a1ddd9..8d6d1f8ff7 100644
--- a/plugins/catalog-backend/src/ingestion/processors/CodeOwnersProcessor.test.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/CodeOwnersProcessor.test.ts
@@ -15,9 +15,9 @@
*/
import { getVoidLogger } from '@backstage/backend-common';
-import { LocationSpec } from '@backstage/catalog-model';
import { ConfigReader } from '@backstage/config';
import { CodeOwnersProcessor } from './CodeOwnersProcessor';
+import { LocationSpec } from './types';
const mockCodeOwnersText = () => `
* @acme/team-foo @acme/team-bar
@@ -27,7 +27,7 @@ const mockCodeOwnersText = () => `
describe('CodeOwnersProcessor', () => {
const mockLocation = ({
basePath = '',
- type = 'github',
+ type = 'url',
} = {}): LocationSpec => ({
type,
target: `https://github.com/backstage/backstage/blob/master/${basePath}catalog-info.yaml`,
diff --git a/plugins/catalog-backend/src/ingestion/processors/CodeOwnersProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/CodeOwnersProcessor.ts
index f358abf7e9..93e3c1618a 100644
--- a/plugins/catalog-backend/src/ingestion/processors/CodeOwnersProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/CodeOwnersProcessor.ts
@@ -15,7 +15,7 @@
*/
import { UrlReader } from '@backstage/backend-common';
-import { Entity, LocationSpec } from '@backstage/catalog-model';
+import { Entity } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
import {
ScmIntegrationRegistry,
@@ -23,20 +23,13 @@ import {
} from '@backstage/integration';
import { Logger } from 'winston';
import { findCodeOwnerByTarget } from './codeowners';
-import { CatalogProcessor } from './types';
+import { CatalogProcessor, LocationSpec } from './types';
const ALLOWED_KINDS = ['API', 'Component', 'Domain', 'Resource', 'System'];
-const ALLOWED_LOCATION_TYPES = [
- 'url',
- 'azure/api',
- 'bitbucket/api',
- 'github',
- 'github/api',
- 'gitlab',
- 'gitlab/api',
-];
+const ALLOWED_LOCATION_TYPES = ['url'];
+/** @public */
export class CodeOwnersProcessor implements CatalogProcessor {
private readonly integrations: ScmIntegrationRegistry;
private readonly logger: Logger;
@@ -64,6 +57,10 @@ export class CodeOwnersProcessor implements CatalogProcessor {
this.reader = options.reader;
}
+ getProcessorName(): string {
+ return 'CodeOwnersProcessor';
+ }
+
async preProcessEntity(
entity: Entity,
location: LocationSpec,
diff --git a/plugins/catalog-backend/src/ingestion/processors/FileReaderProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/FileReaderProcessor.ts
index 9ff3f52ba0..996beff24a 100644
--- a/plugins/catalog-backend/src/ingestion/processors/FileReaderProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/FileReaderProcessor.ts
@@ -14,7 +14,6 @@
* limitations under the License.
*/
-import { LocationSpec } from '@backstage/catalog-model';
import fs from 'fs-extra';
import g from 'glob';
import path from 'path';
@@ -24,11 +23,17 @@ import {
CatalogProcessor,
CatalogProcessorEmit,
CatalogProcessorParser,
+ LocationSpec,
} from './types';
const glob = promisify(g);
+/** @public */
export class FileReaderProcessor implements CatalogProcessor {
+ getProcessorName(): string {
+ return 'FileReaderProcessor';
+ }
+
async readLocation(
location: LocationSpec,
optional: boolean,
diff --git a/plugins/catalog-backend/src/ingestion/processors/GitLabDiscoveryProcessor.test.ts b/plugins/catalog-backend/src/ingestion/processors/GitLabDiscoveryProcessor.test.ts
index 8d85d7375f..8261690e8f 100644
--- a/plugins/catalog-backend/src/ingestion/processors/GitLabDiscoveryProcessor.test.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/GitLabDiscoveryProcessor.test.ts
@@ -16,11 +16,11 @@
import { ConfigReader } from '@backstage/config';
import { getVoidLogger } from '@backstage/backend-common';
-import { LocationSpec } from '@backstage/catalog-model';
import { GitLabDiscoveryProcessor, parseUrl } from './GitLabDiscoveryProcessor';
import { setupServer } from 'msw/node';
import { rest } from 'msw';
import { GitLabProject } from './gitlab';
+import { LocationSpec } from './types';
const server = setupServer();
@@ -210,7 +210,6 @@ describe('GitlabDiscoveryProcessor', () => {
target: 'https://gitlab.fake/1/-/blob/main/catalog-info.yaml',
presence: 'optional',
},
- optional: true,
},
{
type: 'location',
@@ -219,7 +218,6 @@ describe('GitlabDiscoveryProcessor', () => {
target: 'https://gitlab.fake/2/-/blob/master/catalog-info.yaml',
presence: 'optional',
},
- optional: true,
},
]);
});
@@ -257,7 +255,6 @@ describe('GitlabDiscoveryProcessor', () => {
target: 'https://gitlab.fake/1/-/blob/master/catalog-info.yaml',
presence: 'optional',
},
- optional: true,
},
]);
});
diff --git a/plugins/catalog-backend/src/ingestion/processors/GitLabDiscoveryProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/GitLabDiscoveryProcessor.ts
index cc0113bfbe..b534d50044 100644
--- a/plugins/catalog-backend/src/ingestion/processors/GitLabDiscoveryProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/GitLabDiscoveryProcessor.ts
@@ -14,7 +14,6 @@
* limitations under the License.
*/
-import { LocationSpec } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
import {
ScmIntegrationRegistry,
@@ -22,7 +21,7 @@ import {
} from '@backstage/integration';
import { Logger } from 'winston';
import * as results from './results';
-import { CatalogProcessor, CatalogProcessorEmit } from './types';
+import { CatalogProcessor, CatalogProcessorEmit, LocationSpec } from './types';
import { GitLabClient, GitLabProject, paginated } from './gitlab';
import {
CacheClient,
@@ -32,6 +31,7 @@ import {
/**
* Extracts repositories out of an GitLab instance.
+ * @public
*/
export class GitLabDiscoveryProcessor implements CatalogProcessor {
private readonly integrations: ScmIntegrationRegistry;
@@ -60,6 +60,10 @@ export class GitLabDiscoveryProcessor implements CatalogProcessor {
this.logger = options.logger;
}
+ getProcessorName(): string {
+ return 'GitLabDiscoveryProcessor';
+ }
+
async readLocation(
location: LocationSpec,
_optional: boolean,
@@ -113,20 +117,17 @@ export class GitLabDiscoveryProcessor implements CatalogProcessor {
const project_branch = branch === '*' ? project.default_branch : branch;
emit(
- results.location(
- {
- type: 'url',
- // The format expected by the GitLabUrlReader:
- // https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath
- //
- // This unfortunately will trigger another API call in `getGitLabFileFetchUrl` to get the project ID.
- // The alternative is using the `buildRawUrl` function, which does not support subgroups, so providing a raw
- // URL here won't work either.
- target: `${project.web_url}/-/blob/${project_branch}/${catalogPath}`,
- presence: 'optional',
- },
- true,
- ),
+ results.location({
+ type: 'url',
+ // The format expected by the GitLabUrlReader:
+ // https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath
+ //
+ // This unfortunately will trigger another API call in `getGitLabFileFetchUrl` to get the project ID.
+ // The alternative is using the `buildRawUrl` function, which does not support subgroups, so providing a raw
+ // URL here won't work either.
+ target: `${project.web_url}/-/blob/${project_branch}/${catalogPath}`,
+ presence: 'optional',
+ }),
);
}
@@ -138,9 +139,10 @@ export class GitLabDiscoveryProcessor implements CatalogProcessor {
return true;
}
- async updateLastActivity(): Promise {
- const lastActivity = await this.cache.get('last-activity');
- await this.cache.set('last-activity', new Date().toISOString());
+ private async updateLastActivity(): Promise {
+ const cacheKey = `processors/${this.getProcessorName()}/last-activity`;
+ const lastActivity = await this.cache.get(cacheKey);
+ await this.cache.set(cacheKey, new Date().toISOString());
return lastActivity as string | undefined;
}
}
diff --git a/plugins/catalog-backend/src/ingestion/processors/GithubDiscoveryProcessor.test.ts b/plugins/catalog-backend/src/ingestion/processors/GithubDiscoveryProcessor.test.ts
index d6746f13da..55e5560451 100644
--- a/plugins/catalog-backend/src/ingestion/processors/GithubDiscoveryProcessor.test.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/GithubDiscoveryProcessor.test.ts
@@ -15,9 +15,9 @@
*/
import { getVoidLogger } from '@backstage/backend-common';
-import { LocationSpec } from '@backstage/catalog-model';
import { GithubDiscoveryProcessor, parseUrl } from './GithubDiscoveryProcessor';
import { getOrganizationRepositories } from './github';
+import { LocationSpec } from './types';
import { ConfigReader } from '@backstage/config';
import {
ScmIntegrations,
@@ -175,7 +175,6 @@ describe('GithubDiscoveryProcessor', () => {
'https://github.com/backstage/backstage/blob/master/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
expect(emitter).toHaveBeenCalledWith({
type: 'location',
@@ -184,7 +183,6 @@ describe('GithubDiscoveryProcessor', () => {
target: 'https://github.com/backstage/demo/blob/master/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -217,7 +215,6 @@ describe('GithubDiscoveryProcessor', () => {
'https://github.com/backstage/tech-docs/blob/main/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -272,7 +269,6 @@ describe('GithubDiscoveryProcessor', () => {
'https://github.com/backstage/backstage/blob/master/catalog-info.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -328,7 +324,6 @@ describe('GithubDiscoveryProcessor', () => {
'https://github.com/backstage/techdocs-cli/blob/master/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
expect(emitter).toHaveBeenCalledWith({
type: 'location',
@@ -338,7 +333,6 @@ describe('GithubDiscoveryProcessor', () => {
'https://github.com/backstage/techdocs-container/blob/master/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
});
@@ -394,7 +388,6 @@ describe('GithubDiscoveryProcessor', () => {
target: 'https://github.com/backstage/test/blob/master/catalog.yaml',
presence: 'optional',
},
- optional: true,
});
});
});
diff --git a/plugins/catalog-backend/src/ingestion/processors/GithubDiscoveryProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/GithubDiscoveryProcessor.ts
index 3cb73f0181..e790134011 100644
--- a/plugins/catalog-backend/src/ingestion/processors/GithubDiscoveryProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/GithubDiscoveryProcessor.ts
@@ -14,7 +14,6 @@
* limitations under the License.
*/
-import { LocationSpec } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
import {
DefaultGithubCredentialsProvider,
@@ -26,7 +25,7 @@ import { graphql } from '@octokit/graphql';
import { Logger } from 'winston';
import { getOrganizationRepositories } from './github';
import * as results from './results';
-import { CatalogProcessor, CatalogProcessorEmit } from './types';
+import { CatalogProcessor, CatalogProcessorEmit, LocationSpec } from './types';
/**
* Extracts repositories out of a GitHub org.
@@ -41,6 +40,8 @@ import { CatalogProcessor, CatalogProcessorEmit } from './types';
* You may also explicitly specify the source branch:
*
* target: https://github.com/backstage/*\/blob/main/catalog-info.yaml
+ *
+ * @public
**/
export class GithubDiscoveryProcessor implements CatalogProcessor {
private readonly integrations: ScmIntegrationRegistry;
@@ -73,6 +74,9 @@ export class GithubDiscoveryProcessor implements CatalogProcessor {
options.githubCredentialsProvider ||
DefaultGithubCredentialsProvider.fromIntegrations(this.integrations);
}
+ getProcessorName(): string {
+ return 'GithubDiscoveryProcessor';
+ }
async readLocation(
location: LocationSpec,
@@ -137,17 +141,14 @@ export class GithubDiscoveryProcessor implements CatalogProcessor {
const path = `/blob/${branchName}${catalogPath}`;
emit(
- results.location(
- {
- type: 'url',
- target: `${repository.url}${path}`,
- presence: 'optional',
- },
+ results.location({
+ type: 'url',
+ target: `${repository.url}${path}`,
// Not all locations may actually exist, since the user defined them as a wildcard pattern.
// Thus, we emit them as optional and let the downstream processor find them while not outputting
// an error if it couldn't.
- true,
- ),
+ presence: 'optional',
+ }),
);
}
diff --git a/plugins/catalog-backend/src/ingestion/processors/GithubMultiOrgReaderProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/GithubMultiOrgReaderProcessor.ts
index 7d10428494..383b82c019 100644
--- a/plugins/catalog-backend/src/ingestion/processors/GithubMultiOrgReaderProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/GithubMultiOrgReaderProcessor.ts
@@ -14,7 +14,6 @@
* limitations under the License.
*/
-import { LocationSpec } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
import {
DefaultGithubCredentialsProvider,
@@ -33,7 +32,7 @@ import {
readGithubMultiOrgConfig,
} from './github';
import * as results from './results';
-import { CatalogProcessor, CatalogProcessorEmit } from './types';
+import { CatalogProcessor, CatalogProcessorEmit, LocationSpec } from './types';
import { buildOrgHierarchy } from './util/org';
/**
@@ -78,6 +77,9 @@ export class GithubMultiOrgReaderProcessor implements CatalogProcessor {
options.githubCredentialsProvider ||
DefaultGithubCredentialsProvider.fromIntegrations(this.integrations);
}
+ getProcessorName(): string {
+ return 'GithubMultiOrgReaderProcessor';
+ }
async readLocation(
location: LocationSpec,
diff --git a/plugins/catalog-backend/src/ingestion/processors/GithubOrgReaderProcessor.test.ts b/plugins/catalog-backend/src/ingestion/processors/GithubOrgReaderProcessor.test.ts
index 953c926c71..c01db88d3a 100644
--- a/plugins/catalog-backend/src/ingestion/processors/GithubOrgReaderProcessor.test.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/GithubOrgReaderProcessor.test.ts
@@ -14,7 +14,6 @@
* limitations under the License.
*/
import { getVoidLogger } from '@backstage/backend-common';
-import { LocationSpec } from '@backstage/catalog-model';
import { ConfigReader } from '@backstage/config';
import {
ScmIntegrations,
@@ -22,6 +21,7 @@ import {
} from '@backstage/integration';
import { graphql } from '@octokit/graphql';
import { GithubOrgReaderProcessor } from './GithubOrgReaderProcessor';
+import { LocationSpec } from './types';
jest.mock('@octokit/graphql');
diff --git a/plugins/catalog-backend/src/ingestion/processors/GithubOrgReaderProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/GithubOrgReaderProcessor.ts
index dbb7b98e87..8b5914cc80 100644
--- a/plugins/catalog-backend/src/ingestion/processors/GithubOrgReaderProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/GithubOrgReaderProcessor.ts
@@ -14,7 +14,6 @@
* limitations under the License.
*/
-import { LocationSpec } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
import {
GithubCredentialType,
@@ -31,13 +30,14 @@ import {
parseGitHubOrgUrl,
} from './github';
import * as results from './results';
-import { CatalogProcessor, CatalogProcessorEmit } from './types';
+import { CatalogProcessor, CatalogProcessorEmit, LocationSpec } from './types';
import { assignGroupsToUsers, buildOrgHierarchy } from './util/org';
type GraphQL = typeof graphql;
/**
* Extracts teams and users out of a GitHub org.
+ * @public
*/
export class GithubOrgReaderProcessor implements CatalogProcessor {
private readonly integrations: ScmIntegrationRegistry;
@@ -70,6 +70,9 @@ export class GithubOrgReaderProcessor implements CatalogProcessor {
DefaultGithubCredentialsProvider.fromIntegrations(this.integrations);
this.logger = options.logger;
}
+ getProcessorName(): string {
+ return 'GithubOrgReaderProcessor';
+ }
async readLocation(
location: LocationSpec,
diff --git a/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.test.ts b/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.test.ts
index c4551e30f8..83f1ca1925 100644
--- a/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.test.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.test.ts
@@ -14,7 +14,6 @@
* limitations under the License.
*/
-import { LocationSpec } from '@backstage/catalog-model';
import { ConfigReader } from '@backstage/config';
import {
ScmIntegrations,
@@ -22,6 +21,7 @@ import {
} from '@backstage/integration';
import path from 'path';
import { toAbsoluteUrl } from './LocationEntityProcessor';
+import { LocationSpec } from './types';
describe('LocationEntityProcessor', () => {
describe('toAbsoluteUrl', () => {
diff --git a/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.ts
index c6b7def5fc..533a366f57 100644
--- a/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.ts
@@ -14,11 +14,11 @@
* limitations under the License.
*/
-import { Entity, LocationEntity, LocationSpec } from '@backstage/catalog-model';
+import { Entity, LocationEntity } from '@backstage/catalog-model';
import { ScmIntegrationRegistry } from '@backstage/integration';
import path from 'path';
import * as result from './results';
-import { CatalogProcessor, CatalogProcessorEmit } from './types';
+import { CatalogProcessor, CatalogProcessorEmit, LocationSpec } from './types';
export function toAbsoluteUrl(
integrations: ScmIntegrationRegistry,
@@ -38,13 +38,19 @@ export function toAbsoluteUrl(
}
}
+/** @public */
export type LocationEntityProcessorOptions = {
integrations: ScmIntegrationRegistry;
};
+/** @public */
export class LocationEntityProcessor implements CatalogProcessor {
constructor(private readonly options: LocationEntityProcessorOptions) {}
+ getProcessorName(): string {
+ return 'LocationEntityProcessor';
+ }
+
async postProcessEntity(
entity: Entity,
location: LocationSpec,
@@ -77,7 +83,7 @@ export class LocationEntityProcessor implements CatalogProcessor {
location,
maybeRelativeTarget,
);
- emit(result.location({ type, target }, false));
+ emit(result.location({ type, target }));
}
}
diff --git a/plugins/catalog-backend/src/ingestion/processors/PlaceholderProcessor.test.ts b/plugins/catalog-backend/src/ingestion/processors/PlaceholderProcessor.test.ts
index c7a49353ae..7bfc66276e 100644
--- a/plugins/catalog-backend/src/ingestion/processors/PlaceholderProcessor.test.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/PlaceholderProcessor.test.ts
@@ -154,7 +154,7 @@ describe('PlaceholderProcessor', () => {
spec: { data: { $text: '../file.txt' } },
},
{
- type: 'github',
+ type: 'url',
target:
'https://github.com/backstage/backstage/a/b/catalog-info.yaml',
},
@@ -190,7 +190,7 @@ describe('PlaceholderProcessor', () => {
spec: { data: { $json: './file.json' } },
},
{
- type: 'github',
+ type: 'url',
target:
'https://github.com/backstage/backstage/a/b/catalog-info.yaml',
},
@@ -224,7 +224,7 @@ describe('PlaceholderProcessor', () => {
spec: { data: { $yaml: '../file.yaml' } },
},
{
- type: 'github',
+ type: 'url',
target:
'https://github.com/backstage/backstage/a/b/catalog-info.yaml',
},
@@ -262,7 +262,7 @@ describe('PlaceholderProcessor', () => {
},
},
{
- type: 'github',
+ type: 'url',
target:
'https://github.com/backstage/backstage/a/b/catalog-info.yaml',
},
@@ -300,7 +300,7 @@ describe('PlaceholderProcessor', () => {
},
},
{
- type: 'github',
+ type: 'url',
target: './a/b/catalog-info.yaml',
},
),
@@ -340,7 +340,7 @@ describe('PlaceholderProcessor', () => {
},
},
{
- type: 'github',
+ type: 'url',
target: './a/b/catalog-info.yaml',
},
),
diff --git a/plugins/catalog-backend/src/ingestion/processors/PlaceholderProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/PlaceholderProcessor.ts
index 65f65a0479..0d572a024d 100644
--- a/plugins/catalog-backend/src/ingestion/processors/PlaceholderProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/PlaceholderProcessor.ts
@@ -15,18 +15,22 @@
*/
import { UrlReader } from '@backstage/backend-common';
-import { Entity, LocationSpec } from '@backstage/catalog-model';
+import { Entity } from '@backstage/catalog-model';
import { JsonValue } from '@backstage/types';
import { ScmIntegrationRegistry } from '@backstage/integration';
import yaml from 'yaml';
-import { CatalogProcessor } from './types';
+import { CatalogProcessor, LocationSpec } from './types';
+/** @public */
export type PlaceholderResolverRead = (url: string) => Promise;
+
+/** @public */
export type PlaceholderResolverResolveUrl = (
url: string,
base: string,
) => string;
+/** @public */
export type PlaceholderResolverParams = {
key: string;
value: JsonValue;
@@ -35,10 +39,12 @@ export type PlaceholderResolverParams = {
resolveUrl: PlaceholderResolverResolveUrl;
};
+/** @public */
export type PlaceholderResolver = (
params: PlaceholderResolverParams,
) => Promise;
+/** @public */
export type PlaceholderProcessorOptions = {
resolvers: Record;
reader: UrlReader;
@@ -48,10 +54,15 @@ export type PlaceholderProcessorOptions = {
/**
* Traverses raw entity JSON looking for occurrences of $-prefixed placeholders
* that it then fills in with actual data.
+ * @public
*/
export class PlaceholderProcessor implements CatalogProcessor {
constructor(private readonly options: PlaceholderProcessorOptions) {}
+ getProcessorName(): string {
+ return 'PlaceholderProcessor';
+ }
+
async preProcessEntity(
entity: Entity,
location: LocationSpec,
diff --git a/plugins/catalog-backend/src/ingestion/processors/StaticLocationProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/StaticLocationProcessor.ts
index 425ad6e0fe..1c2c27f425 100644
--- a/plugins/catalog-backend/src/ingestion/processors/StaticLocationProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/StaticLocationProcessor.ts
@@ -14,11 +14,14 @@
* limitations under the License.
*/
-import { LocationSpec } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
import * as result from './results';
-import { CatalogProcessorEmit } from './types';
+import { CatalogProcessorEmit, LocationSpec } from './types';
+/**
+ * @deprecated no longer in use, replaced by the ConfigLocationEntityProvider.
+ * @public
+ */
export class StaticLocationProcessor implements StaticLocationProcessor {
static fromConfig(config: Config): StaticLocationProcessor {
const locations: LocationSpec[] = [];
@@ -45,7 +48,7 @@ export class StaticLocationProcessor implements StaticLocationProcessor {
}
for (const staticLocation of this.staticLocations) {
- emit(result.location(staticLocation, false));
+ emit(result.location(staticLocation));
}
return true;
diff --git a/plugins/catalog-backend/src/ingestion/processors/UrlReaderProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/UrlReaderProcessor.ts
index 6a85cc07c7..c2be454bcf 100644
--- a/plugins/catalog-backend/src/ingestion/processors/UrlReaderProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/UrlReaderProcessor.ts
@@ -15,7 +15,7 @@
*/
import { UrlReader } from '@backstage/backend-common';
-import { Entity, LocationSpec } from '@backstage/catalog-model';
+import { Entity } from '@backstage/catalog-model';
import { assertError } from '@backstage/errors';
import parseGitUrl from 'git-url-parse';
import limiterFactory from 'p-limit';
@@ -28,15 +28,11 @@ import {
CatalogProcessorEntityResult,
CatalogProcessorParser,
CatalogProcessorResult,
+ LocationSpec,
} from './types';
const CACHE_KEY = 'v1';
-type Options = {
- reader: UrlReader;
- logger: Logger;
-};
-
// WARNING: If you change this type, you likely need to bump the CACHE_KEY as well
type CacheItem = {
etag: string;
@@ -47,8 +43,14 @@ type CacheItem = {
}[];
};
+/** @public */
export class UrlReaderProcessor implements CatalogProcessor {
- constructor(private readonly options: Options) {}
+ constructor(
+ private readonly options: {
+ reader: UrlReader;
+ logger: Logger;
+ },
+ ) {}
getProcessorName() {
return 'url-reader';
diff --git a/plugins/catalog-backend/src/ingestion/processors/bitbucket/BitbucketRepositoryParser.test.ts b/plugins/catalog-backend/src/ingestion/processors/bitbucket/BitbucketRepositoryParser.test.ts
index 397d259bae..35e24ed4cb 100644
--- a/plugins/catalog-backend/src/ingestion/processors/bitbucket/BitbucketRepositoryParser.test.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/bitbucket/BitbucketRepositoryParser.test.ts
@@ -25,14 +25,11 @@ describe('BitbucketRepositoryParser', () => {
'https://bitbucket.mycompany.com/projects/project-key/repos/repo-slug/browse';
const path = '/catalog-info.yaml';
const expected = [
- results.location(
- {
- type: 'url',
- target: `${browseUrl}${path}`,
- presence: 'optional',
- },
- true,
- ),
+ results.location({
+ type: 'url',
+ target: `${browseUrl}${path}`,
+ presence: 'optional',
+ }),
];
const actual = await defaultRepositoryParser({
integration: {} as BitbucketIntegration,
diff --git a/plugins/catalog-backend/src/ingestion/processors/bitbucket/BitbucketRepositoryParser.ts b/plugins/catalog-backend/src/ingestion/processors/bitbucket/BitbucketRepositoryParser.ts
index 34a9284b3e..9eaec221b5 100644
--- a/plugins/catalog-backend/src/ingestion/processors/bitbucket/BitbucketRepositoryParser.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/bitbucket/BitbucketRepositoryParser.ts
@@ -18,6 +18,7 @@ import { results } from '../index';
import { Logger } from 'winston';
import { BitbucketIntegration } from '@backstage/integration';
+/** @public */
export type BitbucketRepositoryParser = (options: {
integration: BitbucketIntegration;
target: string;
@@ -26,15 +27,12 @@ export type BitbucketRepositoryParser = (options: {
export const defaultRepositoryParser: BitbucketRepositoryParser =
async function* defaultRepositoryParser({ target }) {
- yield results.location(
- {
- type: 'url',
- target: target,
- presence: 'optional',
- },
+ yield results.location({
+ type: 'url',
+ target: target,
// Not all locations may actually exist, since the user defined them as a wildcard pattern.
// Thus, we emit them as optional and let the downstream processor find them while not outputting
// an error if it couldn't.
- true,
- );
+ presence: 'optional',
+ });
};
diff --git a/plugins/catalog-backend/src/ingestion/processors/github/config.test.ts b/plugins/catalog-backend/src/ingestion/processors/github/config.test.ts
index a67d2378d0..3b722a0e7b 100644
--- a/plugins/catalog-backend/src/ingestion/processors/github/config.test.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/github/config.test.ts
@@ -15,68 +15,9 @@
*/
import { ConfigReader } from '@backstage/config';
-import { readGithubConfig, readGithubMultiOrgConfig } from './config';
+import { readGithubMultiOrgConfig } from './config';
describe('config', () => {
- describe('readGithubConfig', () => {
- function config(
- providers: { target: string; apiBaseUrl?: string; token?: string }[],
- ) {
- return new ConfigReader({
- catalog: { processors: { githubOrg: { providers } } },
- });
- }
-
- it('adds a default GitHub entry when missing', () => {
- const output = readGithubConfig(config([]));
- expect(output).toEqual([
- {
- target: 'https://github.com',
- apiBaseUrl: 'https://api.github.com',
- },
- ]);
- });
-
- it('injects the correct GitHub API base URL when missing', () => {
- const output = readGithubConfig(
- config([{ target: 'https://github.com' }]),
- );
- expect(output).toEqual([
- {
- target: 'https://github.com',
- apiBaseUrl: 'https://api.github.com',
- },
- ]);
- });
-
- it('rejects custom targets with no base URLs', () => {
- expect(() =>
- readGithubConfig(config([{ target: 'https://ghe.company.com' }])),
- ).toThrow(
- 'Provider at https://ghe.company.com must configure an explicit apiBaseUrl',
- );
- });
-
- it('rejects funky configs', () => {
- expect(() => readGithubConfig(config([{ target: 7 } as any]))).toThrow(
- /target/,
- );
- expect(() =>
- readGithubConfig(config([{ noTarget: '7' } as any])),
- ).toThrow(/target/);
- expect(() =>
- readGithubConfig(
- config([{ target: 'https://github.com', apiBaseUrl: 7 } as any]),
- ),
- ).toThrow(/apiBaseUrl/);
- expect(() =>
- readGithubConfig(
- config([{ target: 'https://github.com', token: 7 } as any]),
- ),
- ).toThrow(/token/);
- });
- });
-
describe('readGithubMultiOrgConfig', () => {
function config(
orgs: { name: string; groupNamespace?: string; userNamespace?: string }[],
diff --git a/plugins/catalog-backend/src/ingestion/processors/github/config.ts b/plugins/catalog-backend/src/ingestion/processors/github/config.ts
index 27bec6eb0d..242296b4be 100644
--- a/plugins/catalog-backend/src/ingestion/processors/github/config.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/github/config.ts
@@ -15,77 +15,10 @@
*/
import { Config } from '@backstage/config';
-import { trimEnd } from 'lodash';
-
-/**
- * The configuration parameters for a single GitHub API provider.
- */
-export type ProviderConfig = {
- /**
- * The prefix of the target that this matches on, e.g. "https://github.com",
- * with no trailing slash.
- */
- target: string;
-
- /**
- * The base URL of the API of this provider, e.g. "https://api.github.com",
- * with no trailing slash.
- *
- * May be omitted specifically for GitHub; then it will be deduced.
- */
- apiBaseUrl?: string;
-
- /**
- * The authorization token to use for requests to this provider.
- *
- * If no token is specified, anonymous access is used.
- */
- token?: string;
-};
-
-// TODO(freben): Break out common code and config from here and GithubReaderProcessor
-export function readGithubConfig(config: Config): ProviderConfig[] {
- const providers: ProviderConfig[] = [];
-
- const providerConfigs =
- config.getOptionalConfigArray('catalog.processors.githubOrg.providers') ??
- [];
-
- // First read all the explicit providers
- for (const providerConfig of providerConfigs) {
- const target = trimEnd(providerConfig.getString('target'), '/');
- let apiBaseUrl = providerConfig.getOptionalString('apiBaseUrl');
- const token = providerConfig.getOptionalString('token');
-
- if (apiBaseUrl) {
- apiBaseUrl = trimEnd(apiBaseUrl, '/');
- } else if (target === 'https://github.com') {
- apiBaseUrl = 'https://api.github.com';
- }
-
- if (!apiBaseUrl) {
- throw new Error(
- `Provider at ${target} must configure an explicit apiBaseUrl`,
- );
- }
-
- providers.push({ target, apiBaseUrl, token });
- }
-
- // If no explicit github.com provider was added, put one in the list as
- // a convenience
- if (!providers.some(p => p.target === 'https://github.com')) {
- providers.push({
- target: 'https://github.com',
- apiBaseUrl: 'https://api.github.com',
- });
- }
-
- return providers;
-}
/**
* The configuration parameters for a multi-org GitHub processor.
+ * @public
*/
export type GithubMultiOrgConfig = Array<{
/**
diff --git a/plugins/catalog-backend/src/ingestion/processors/github/index.ts b/plugins/catalog-backend/src/ingestion/processors/github/index.ts
index 3d9e881ddd..3e31d9e00c 100644
--- a/plugins/catalog-backend/src/ingestion/processors/github/index.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/github/index.ts
@@ -14,8 +14,8 @@
* limitations under the License.
*/
-export { readGithubConfig, readGithubMultiOrgConfig } from './config';
-export type { GithubMultiOrgConfig, ProviderConfig } from './config';
+export { readGithubMultiOrgConfig } from './config';
+export type { GithubMultiOrgConfig } from './config';
export {
getOrganizationRepositories,
getOrganizationTeams,
diff --git a/plugins/catalog-backend/src/ingestion/processors/index.ts b/plugins/catalog-backend/src/ingestion/processors/index.ts
index 63feac51af..84a92fb1ba 100644
--- a/plugins/catalog-backend/src/ingestion/processors/index.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/index.ts
@@ -18,8 +18,6 @@ import * as results from './results';
export { AnnotateLocationEntityProcessor } from './AnnotateLocationEntityProcessor';
export { AnnotateScmSlugEntityProcessor } from './AnnotateScmSlugEntityProcessor';
-export { AwsOrganizationCloudAccountProcessor } from './AwsOrganizationCloudAccountProcessor';
-export type { AwsOrganizationProviderConfig } from './awsOrganization/config';
export { AwsS3DiscoveryProcessor } from './AwsS3DiscoveryProcessor';
export { BitbucketDiscoveryProcessor } from './BitbucketDiscoveryProcessor';
export { BuiltinKindsEntityProcessor } from './BuiltinKindsEntityProcessor';
@@ -47,3 +45,4 @@ export { parseEntityYaml } from './util/parse';
export { results };
export type { BitbucketRepositoryParser } from './bitbucket';
+export type { GithubMultiOrgConfig } from './github';
diff --git a/plugins/catalog-backend/src/ingestion/processors/results.ts b/plugins/catalog-backend/src/ingestion/processors/results.ts
index 5b6f07bae4..01583678df 100644
--- a/plugins/catalog-backend/src/ingestion/processors/results.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/results.ts
@@ -15,13 +15,11 @@
*/
import { InputError, NotFoundError } from '@backstage/errors';
-import {
- Entity,
- EntityRelationSpec,
- LocationSpec,
-} from '@backstage/catalog-model';
-import { CatalogProcessorResult } from './types';
+import { Entity } from '@backstage/catalog-model';
+import { CatalogProcessorResult, LocationSpec } from './types';
+import { EntityRelationSpec } from '../../processing/types';
+/** @public */
export function notFoundError(
atLocation: LocationSpec,
message: string,
@@ -33,6 +31,7 @@ export function notFoundError(
};
}
+/** @public */
export function inputError(
atLocation: LocationSpec,
message: string,
@@ -44,6 +43,7 @@ export function inputError(
};
}
+/** @public */
export function generalError(
atLocation: LocationSpec,
message: string,
@@ -51,13 +51,15 @@ export function generalError(
return { type: 'error', location: atLocation, error: new Error(message) };
}
+/** @public */
export function location(
newLocation: LocationSpec,
- optional: boolean,
+ optional?: boolean,
): CatalogProcessorResult {
return { type: 'location', location: newLocation, optional };
}
+/** @public */
export function entity(
atLocation: LocationSpec,
newEntity: Entity,
@@ -65,6 +67,7 @@ export function entity(
return { type: 'entity', location: atLocation, entity: newEntity };
}
+/** @public */
export function relation(spec: EntityRelationSpec): CatalogProcessorResult {
return { type: 'relation', relation: spec };
}
diff --git a/plugins/catalog-backend/src/ingestion/processors/types.ts b/plugins/catalog-backend/src/ingestion/processors/types.ts
index 3e4e24b0fe..879b4d32a8 100644
--- a/plugins/catalog-backend/src/ingestion/processors/types.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/types.ts
@@ -14,19 +14,35 @@
* limitations under the License.
*/
-import {
- Entity,
- EntityRelationSpec,
- LocationSpec,
-} from '@backstage/catalog-model';
+import { Entity } from '@backstage/catalog-model';
import { JsonValue } from '@backstage/types';
+import { EntityRelationSpec } from '../../processing/types';
+/**
+ * Holds the entity location information.
+ *
+ * @remarks
+ *
+ * `presence` flag: when using repo importer plugin, location is being created before the component yaml file is merged to the main branch.
+ * This flag is then set to indicate that the file can be not present.
+ * default value: 'required'.
+ *
+ * @public
+ */
+export type LocationSpec = {
+ type: string;
+ target: string;
+ presence?: 'optional' | 'required';
+};
+
+/**
+ * @public
+ */
export type CatalogProcessor = {
/**
* A unique identifier for the Catalog Processor.
- * It's strongly recommended to implement getProcessorName as this method will be required in the future.
*/
- getProcessorName?(): string;
+ getProcessorName(): string;
/**
* Reads the contents of a location.
@@ -120,6 +136,7 @@ export type CatalogProcessor = {
* A parser, that is able to take the raw catalog descriptor data and turn it
* into the actual result pieces. The default implementation performs a YAML
* document parsing.
+ * @public
*/
export type CatalogProcessorParser = (options: {
data: Buffer;
@@ -154,32 +171,39 @@ export interface CatalogProcessorCache {
set(key: string, value: ItemType): Promise;
}
+/** @public */
export type CatalogProcessorEmit = (generated: CatalogProcessorResult) => void;
+/** @public */
export type CatalogProcessorLocationResult = {
type: 'location';
location: LocationSpec;
- optional: boolean;
+ /** @deprecated Set `location.presence = 'optional'` instead */
+ optional?: boolean;
};
+/** @public */
export type CatalogProcessorEntityResult = {
type: 'entity';
entity: Entity;
location: LocationSpec;
};
+/** @public */
export type CatalogProcessorRelationResult = {
type: 'relation';
relation: EntityRelationSpec;
entityRef?: string;
};
+/** @public */
export type CatalogProcessorErrorResult = {
type: 'error';
error: Error;
location: LocationSpec;
};
+/** @public */
export type CatalogProcessorResult =
| CatalogProcessorLocationResult
| CatalogProcessorEntityResult
diff --git a/plugins/catalog-backend/src/ingestion/processors/util/parse.ts b/plugins/catalog-backend/src/ingestion/processors/util/parse.ts
index a6aba7e1f9..0beaf1cd4c 100644
--- a/plugins/catalog-backend/src/ingestion/processors/util/parse.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/util/parse.ts
@@ -14,16 +14,17 @@
* limitations under the License.
*/
-import {
- Entity,
- LocationSpec,
- stringifyLocationRef,
-} from '@backstage/catalog-model';
+import { Entity, stringifyLocationRef } from '@backstage/catalog-model';
import lodash from 'lodash';
import yaml from 'yaml';
import * as result from '../results';
-import { CatalogProcessorParser, CatalogProcessorResult } from '../types';
+import {
+ CatalogProcessorParser,
+ CatalogProcessorResult,
+ LocationSpec,
+} from '../types';
+/** @public */
export function* parseEntityYaml(
data: Buffer,
location: LocationSpec,
diff --git a/plugins/catalog-backend/src/ingestion/providers/GitHubOrgEntityProvider.ts b/plugins/catalog-backend/src/ingestion/providers/GitHubOrgEntityProvider.ts
index 20e9966bd1..a20f7fdb0b 100644
--- a/plugins/catalog-backend/src/ingestion/providers/GitHubOrgEntityProvider.ts
+++ b/plugins/catalog-backend/src/ingestion/providers/GitHubOrgEntityProvider.ts
@@ -38,7 +38,7 @@ import {
import { assignGroupsToUsers, buildOrgHierarchy } from '../processors/util/org';
// TODO: Consider supporting an (optional) webhook that reacts on org changes
-
+/** @public */
export class GitHubOrgEntityProvider implements EntityProvider {
private connection?: EntityProviderConnection;
private githubCredentialsProvider: GithubCredentialsProvider;
diff --git a/plugins/catalog-backend/src/ingestion/types.ts b/plugins/catalog-backend/src/ingestion/types.ts
index 30cdee4760..eccf583e4b 100644
--- a/plugins/catalog-backend/src/ingestion/types.ts
+++ b/plugins/catalog-backend/src/ingestion/types.ts
@@ -14,13 +14,11 @@
* limitations under the License.
*/
-import { Entity, LocationSpec } from '@backstage/catalog-model';
+import { Entity } from '@backstage/catalog-model';
import { RecursivePartial } from '../util/RecursivePartial';
+import { LocationSpec } from './processors';
-//
-// LocationAnalyzer
-//
-
+/** @public */
export type LocationAnalyzer = {
/**
* Generates an entity configuration for given git repository. It's used for
@@ -33,30 +31,38 @@ export type LocationAnalyzer = {
): Promise;
};
+/** @public */
export type AnalyzeLocationRequest = {
location: LocationSpec;
};
+/** @public */
export type AnalyzeLocationResponse = {
existingEntityFiles: AnalyzeLocationExistingEntity[];
generateEntities: AnalyzeLocationGenerateEntity[];
};
-// 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
+/**
+ * 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
+ * @public
+ */
export type AnalyzeLocationExistingEntity = {
location: LocationSpec;
isRegistered: boolean;
entity: Entity;
};
-// 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.
+/**
+ * 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.
+ * @public
+ * */
export type AnalyzeLocationGenerateEntity = {
// Some form of partial representation of the entity
entity: RecursivePartial;
@@ -67,12 +73,15 @@ export type AnalyzeLocationGenerateEntity = {
// This is where I get really vague. Something like this perhaps? Or it could be
// something like a json-schema that contains enough info for the frontend to
// be able to present a form and explanations
+/** @public */
export type AnalyzeLocationEntityField = {
- // 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
+ /**
+ * 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;
- // The outcome of the analysis for this particular field
+ /** The outcome of the analysis for this particular field */
state:
| 'analysisSuggestedValue'
| 'analysisSuggestedNoValue'
@@ -81,10 +90,11 @@ export type AnalyzeLocationEntityField = {
// If the analysis did suggest a value, this is where it would be. Not sure if we want
// to limit this to strings or if we want it to be any JsonValue
value: string | null;
-
- // 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.
+ /**
+ * 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;
};
diff --git a/plugins/catalog-backend/src/permissions/rules/isEntityOwner.test.ts b/plugins/catalog-backend/src/permissions/rules/isEntityOwner.test.ts
index 282d2558ef..8e20655393 100644
--- a/plugins/catalog-backend/src/permissions/rules/isEntityOwner.test.ts
+++ b/plugins/catalog-backend/src/permissions/rules/isEntityOwner.test.ts
@@ -29,6 +29,7 @@ describe('isEntityOwner', () => {
relations: [
{
type: 'ownedBy',
+ targetRef: 'user:default/spiderman',
target: {
kind: 'user',
namespace: 'default',
@@ -52,6 +53,7 @@ describe('isEntityOwner', () => {
relations: [
{
type: 'ownedBy',
+ targetRef: 'user:default/green-goblin',
target: {
kind: 'user',
namespace: 'default',
diff --git a/plugins/catalog-backend/src/permissions/rules/isEntityOwner.ts b/plugins/catalog-backend/src/permissions/rules/isEntityOwner.ts
index 3176b31b87..a6dda13c29 100644
--- a/plugins/catalog-backend/src/permissions/rules/isEntityOwner.ts
+++ b/plugins/catalog-backend/src/permissions/rules/isEntityOwner.ts
@@ -14,16 +14,13 @@
* limitations under the License.
*/
-import {
- Entity,
- RELATION_OWNED_BY,
- stringifyEntityRef,
-} from '@backstage/catalog-model';
+import { Entity, RELATION_OWNED_BY } from '@backstage/catalog-model';
import { createCatalogPermissionRule } from './util';
/**
* A catalog {@link @backstage/plugin-permission-node#PermissionRule} which
* filters for entities with a specified owner.
+ *
* @public
*/
export const isEntityOwner = createCatalogPermissionRule({
@@ -36,7 +33,7 @@ export const isEntityOwner = createCatalogPermissionRule({
return resource.relations
.filter(relation => relation.type === RELATION_OWNED_BY)
- .some(relation => claims.includes(stringifyEntityRef(relation.target)));
+ .some(relation => claims.includes(relation.targetRef));
},
toQuery: (claims: string[]) => ({
key: 'relations.ownedBy',
diff --git a/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.test.ts b/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.test.ts
index cc77f6a17b..0853484408 100644
--- a/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.test.ts
+++ b/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.test.ts
@@ -21,7 +21,6 @@ import {
Entity,
EntityPolicies,
LocationEntity,
- LocationSpec,
} from '@backstage/catalog-model';
import { ScmIntegrations } from '@backstage/integration';
import {
@@ -29,6 +28,7 @@ import {
CatalogProcessorCache,
CatalogProcessorEmit,
CatalogProcessorParser,
+ LocationSpec,
results,
} from '../ingestion';
import { CatalogRulesEnforcer } from '../ingestion/CatalogRules';
@@ -208,6 +208,7 @@ describe('DefaultCatalogProcessingOrchestrator', () => {
const integrations = ScmIntegrations.fromConfig(new ConfigReader({}));
const processor: jest.Mocked = {
+ getProcessorName: jest.fn(),
validateEntityKind: jest.fn(async () => true),
readLocation: jest.fn(async (_l, _o, emit) => {
emit(results.entity({ type: 't', target: 't' }, entity));
diff --git a/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.ts b/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.ts
index 105121ae2a..9649bc937b 100644
--- a/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.ts
+++ b/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.ts
@@ -18,7 +18,6 @@ import {
Entity,
EntityPolicy,
LocationEntity,
- LocationSpec,
parseLocationRef,
stringifyEntityRef,
stringifyLocationRef,
@@ -36,6 +35,7 @@ import { Logger } from 'winston';
import {
CatalogProcessor,
CatalogProcessorParser,
+ LocationSpec,
} from '../ingestion/processors';
import * as results from '../ingestion/processors/results';
import {
@@ -64,6 +64,7 @@ type Context = {
cache: ProcessorCacheManager;
};
+/** @public */
export class DefaultCatalogProcessingOrchestrator
implements CatalogProcessingOrchestrator
{
diff --git a/plugins/catalog-backend/src/processing/ProcessorCacheManager.test.ts b/plugins/catalog-backend/src/processing/ProcessorCacheManager.test.ts
index e7f9fb313b..71631b13d8 100644
--- a/plugins/catalog-backend/src/processing/ProcessorCacheManager.test.ts
+++ b/plugins/catalog-backend/src/processing/ProcessorCacheManager.test.ts
@@ -21,7 +21,11 @@ class MyProcessor implements CatalogProcessor {
getProcessorName = () => 'my-processor';
}
-class OtherProcessor implements CatalogProcessor {}
+class OtherProcessor implements CatalogProcessor {
+ getProcessorName(): string {
+ return 'OtherProcessor';
+ }
+}
describe('ProcessorCacheManager', () => {
const myProcessor = new MyProcessor();
diff --git a/plugins/catalog-backend/src/processing/ProcessorCacheManager.ts b/plugins/catalog-backend/src/processing/ProcessorCacheManager.ts
index 472d6453ce..ab95fcedb7 100644
--- a/plugins/catalog-backend/src/processing/ProcessorCacheManager.ts
+++ b/plugins/catalog-backend/src/processing/ProcessorCacheManager.ts
@@ -104,7 +104,7 @@ export class ProcessorCacheManager {
key?: string,
): CatalogProcessorCache {
// constructor name will be deprecated in the future when we make `getProcessorName` required in the implementation
- const name = processor.getProcessorName?.() ?? processor.constructor.name;
+ const name = processor.getProcessorName();
const cache = this.caches.get(name);
if (cache) {
return key ? cache.withKey(key) : cache;
diff --git a/plugins/catalog-backend/src/processing/ProcessorOutputCollector.ts b/plugins/catalog-backend/src/processing/ProcessorOutputCollector.ts
index 832c5b41bf..351e68882b 100644
--- a/plugins/catalog-backend/src/processing/ProcessorOutputCollector.ts
+++ b/plugins/catalog-backend/src/processing/ProcessorOutputCollector.ts
@@ -16,7 +16,6 @@
import {
Entity,
- EntityRelationSpec,
ANNOTATION_LOCATION,
ANNOTATION_ORIGIN_LOCATION,
stringifyLocationRef,
@@ -25,7 +24,7 @@ import { assertError } from '@backstage/errors';
import { Logger } from 'winston';
import { CatalogProcessorResult } from '../ingestion';
import { locationSpecToLocationEntity } from '../util/conversion';
-import { DeferredEntity } from './types';
+import { DeferredEntity, EntityRelationSpec } from './types';
import {
getEntityLocationRef,
getEntityOriginLocationRef,
diff --git a/plugins/catalog-backend/src/processing/index.ts b/plugins/catalog-backend/src/processing/index.ts
index dc8b07eceb..83f8a9f566 100644
--- a/plugins/catalog-backend/src/processing/index.ts
+++ b/plugins/catalog-backend/src/processing/index.ts
@@ -19,6 +19,7 @@ export type {
CatalogProcessingEngine,
EntityProcessingRequest,
EntityProcessingResult,
+ EntityRelationSpec,
DeferredEntity,
} from './types';
export { DefaultCatalogProcessingOrchestrator } from './DefaultCatalogProcessingOrchestrator';
diff --git a/plugins/catalog-backend/src/processing/refresh.ts b/plugins/catalog-backend/src/processing/refresh.ts
index c60f42ff96..3e03e3add8 100644
--- a/plugins/catalog-backend/src/processing/refresh.ts
+++ b/plugins/catalog-backend/src/processing/refresh.ts
@@ -16,12 +16,14 @@
/**
* Function that returns the catalog refresh interval in seconds.
+ * @public
*/
export type RefreshIntervalFunction = () => number;
/**
* Creates a function that returns a random refresh interval between minSeconds and maxSeconds.
* @returns A {@link RefreshIntervalFunction} that provides the next refresh interval
+ * @public
*/
export function createRandomRefreshInterval(options: {
minSeconds: number;
diff --git a/plugins/catalog-backend/src/processing/types.ts b/plugins/catalog-backend/src/processing/types.ts
index 7fb1157d3b..b732df297e 100644
--- a/plugins/catalog-backend/src/processing/types.ts
+++ b/plugins/catalog-backend/src/processing/types.ts
@@ -14,14 +14,44 @@
* limitations under the License.
*/
-import { Entity, EntityRelationSpec } from '@backstage/catalog-model';
+import { Entity, EntityName } from '@backstage/catalog-model';
import { JsonObject } from '@backstage/types';
+/**
+ * Holds the relation data for entities.
+ *
+ * @public
+ */
+export type EntityRelationSpec = {
+ /**
+ * The source entity of this relation.
+ */
+ source: EntityName;
+
+ /**
+ * The type of the relation.
+ */
+ type: string;
+
+ /**
+ * The target entity of this relation.
+ */
+ target: EntityName;
+};
+
+/**
+ * The request to process an entity.
+ * @public
+ */
export type EntityProcessingRequest = {
entity: Entity;
state?: JsonObject; // Versions for multiple deployments etc
};
+/**
+ * The result of processing an entity.
+ * @public
+ */
export type EntityProcessingResult =
| {
ok: true;
@@ -36,15 +66,24 @@ export type EntityProcessingResult =
errors: Error[];
};
+/**
+ * Responsible for executing the individual processing steps in order to fully process an entity.
+ * @public
+ * */
export interface CatalogProcessingOrchestrator {
process(request: EntityProcessingRequest): Promise;
}
+/**
+ * Entities that are not yet processed.
+ * @public
+ * */
export type DeferredEntity = {
entity: Entity;
locationKey?: string;
};
+/** @public */
export interface CatalogProcessingEngine {
start(): Promise;
stop(): Promise;
diff --git a/plugins/catalog-backend/src/processing/util.ts b/plugins/catalog-backend/src/processing/util.ts
index a4fa984dc1..94634f794a 100644
--- a/plugins/catalog-backend/src/processing/util.ts
+++ b/plugins/catalog-backend/src/processing/util.ts
@@ -19,7 +19,6 @@ import {
entityEnvelopeSchemaValidator,
entitySchemaValidator,
LocationEntity,
- LocationSpec,
ANNOTATION_LOCATION,
ANNOTATION_ORIGIN_LOCATION,
stringifyEntityRef,
@@ -28,6 +27,7 @@ import { JsonObject, JsonValue } from '@backstage/types';
import { InputError } from '@backstage/errors';
import { ScmIntegrationRegistry } from '@backstage/integration';
import path from 'path';
+import { LocationSpec } from '../ingestion';
export function isLocationEntity(entity: Entity): entity is LocationEntity {
return entity.kind === 'Location';
@@ -37,7 +37,9 @@ export function getEntityLocationRef(entity: Entity): string {
const ref = entity.metadata.annotations?.[ANNOTATION_LOCATION];
if (!ref) {
const entityRef = stringifyEntityRef(entity);
- throw new InputError(`Entity '${entityRef}' does not have a location`);
+ throw new InputError(
+ `Entity '${entityRef}' does not have the annotation ${ANNOTATION_LOCATION}`,
+ );
}
return ref;
}
@@ -47,7 +49,7 @@ export function getEntityOriginLocationRef(entity: Entity): string {
if (!ref) {
const entityRef = stringifyEntityRef(entity);
throw new InputError(
- `Entity '${entityRef}' does not have an origin location`,
+ `Entity '${entityRef}' does not have the annotation ${ANNOTATION_ORIGIN_LOCATION}`,
);
}
return ref;
diff --git a/plugins/catalog-backend/src/providers/DefaultLocationStore.ts b/plugins/catalog-backend/src/providers/DefaultLocationStore.ts
index f93afedbaa..9d5971508f 100644
--- a/plugins/catalog-backend/src/providers/DefaultLocationStore.ts
+++ b/plugins/catalog-backend/src/providers/DefaultLocationStore.ts
@@ -14,7 +14,6 @@
* limitations under the License.
*/
-import { LocationSpec } from '@backstage/catalog-model';
import { Location } from '@backstage/catalog-client';
import { ConflictError, NotFoundError } from '@backstage/errors';
import { Knex } from 'knex';
@@ -23,7 +22,7 @@ import { DbLocationsRow } from '../database/tables';
import { getEntityLocationRef } from '../processing/util';
import { EntityProvider, EntityProviderConnection } from './types';
import { locationSpecToLocationEntity } from '../util/conversion';
-import { LocationStore } from '../service';
+import { LocationInput, LocationStore } from '../service';
export class DefaultLocationStore implements LocationStore, EntityProvider {
private _connection: EntityProviderConnection | undefined;
@@ -34,25 +33,25 @@ export class DefaultLocationStore implements LocationStore, EntityProvider {
return 'DefaultLocationStore';
}
- async createLocation(spec: LocationSpec): Promise {
+ async createLocation(input: LocationInput): Promise {
const location = await this.db.transaction(async tx => {
- // Attempt to find a previous location matching the spec
+ // Attempt to find a previous location matching the input
const previousLocations = await this.locations(tx);
- // TODO: when location id's are a compilation of spec target we can remove this full
+ // TODO: when location id's are a compilation of input target we can remove this full
// lookup of locations first and just grab the by that instead.
const previousLocation = previousLocations.some(
- l => spec.type === l.type && spec.target === l.target,
+ l => input.type === l.type && input.target === l.target,
);
if (previousLocation) {
throw new ConflictError(
- `Location ${spec.type}:${spec.target} already exists`,
+ `Location ${input.type}:${input.target} already exists`,
);
}
const inner: DbLocationsRow = {
id: uuid(),
- type: spec.type,
- target: spec.target,
+ type: input.type,
+ target: input.target,
};
await tx('locations').insert(inner);
diff --git a/plugins/catalog-backend/src/providers/types.ts b/plugins/catalog-backend/src/providers/types.ts
index 90c5f13215..226c021e3c 100644
--- a/plugins/catalog-backend/src/providers/types.ts
+++ b/plugins/catalog-backend/src/providers/types.ts
@@ -16,15 +16,36 @@
import { DeferredEntity } from '../processing';
+/**
+ * @public
+ * A 'full' mutation replaces all existing entities created by this entity provider with new ones.
+ * A 'delta' mutation can both add and remove entities provided by this provider. Previously provided
+ * entities from a 'full' mutation are not removed.
+ */
export type EntityProviderMutation =
| { type: 'full'; entities: DeferredEntity[] }
| { type: 'delta'; added: DeferredEntity[]; removed: DeferredEntity[] };
+/**
+ * The EntityProviderConnection is the connection between the catalog and the entity provider.
+ * The EntityProvider use this connection to add and remove entities from the catalog.
+ * @public
+ */
export interface EntityProviderConnection {
+ /**
+ * Applies either a full or delta update to the catalog engine.
+ */
applyMutation(mutation: EntityProviderMutation): Promise;
}
+/**
+ * An EntityProvider is able to provide entities to the catalog.
+ * See https://backstage.io/docs/features/software-catalog/life-of-an-entity for more details.
+ * @public
+ */
export interface EntityProvider {
+ /** Unique name provider name used internally for caching. */
getProviderName(): string;
+ /** Connect is called upon initialization by the catalog engine. */
connect(connection: EntityProviderConnection): Promise;
}
diff --git a/plugins/catalog-backend/src/search/DefaultCatalogCollator.ts b/plugins/catalog-backend/src/search/DefaultCatalogCollator.ts
index 8e72a265af..96704a6c1a 100644
--- a/plugins/catalog-backend/src/search/DefaultCatalogCollator.ts
+++ b/plugins/catalog-backend/src/search/DefaultCatalogCollator.ts
@@ -32,6 +32,7 @@ import {
} from '@backstage/catalog-client';
import { catalogEntityReadPermission } from '@backstage/plugin-catalog-common';
+/** @public */
export interface CatalogEntityDocument extends IndexableDocument {
componentType: string;
namespace: string;
@@ -40,6 +41,7 @@ export interface CatalogEntityDocument extends IndexableDocument {
owner: string;
}
+/** @public */
export class DefaultCatalogCollator implements DocumentCollator {
protected discovery: PluginEndpointDiscovery;
protected locationTemplate: string;
diff --git a/plugins/catalog-backend/src/service/AuthorizedEntitiesCatalog.test.ts b/plugins/catalog-backend/src/service/AuthorizedEntitiesCatalog.test.ts
index 156db8e8ce..1f0e5ea644 100644
--- a/plugins/catalog-backend/src/service/AuthorizedEntitiesCatalog.test.ts
+++ b/plugins/catalog-backend/src/service/AuthorizedEntitiesCatalog.test.ts
@@ -30,6 +30,7 @@ describe('AuthorizedEntitiesCatalog', () => {
entities: jest.fn(),
removeEntityByUid: jest.fn(),
entityAncestry: jest.fn(),
+ facets: jest.fn(),
};
const fakePermissionApi = {
authorize: jest.fn(),
@@ -254,4 +255,54 @@ describe('AuthorizedEntitiesCatalog', () => {
});
});
});
+
+ describe('facets', () => {
+ it('returns empty response on DENY', async () => {
+ fakePermissionApi.authorize.mockResolvedValue([
+ { result: AuthorizeResult.DENY },
+ ]);
+ const catalog = createCatalog();
+
+ expect(
+ await catalog.facets({
+ facets: ['a'],
+ authorizationToken: 'abcd',
+ }),
+ ).toEqual({
+ facets: { a: [] },
+ });
+ });
+
+ it('calls underlying catalog method with correct filter on CONDITIONAL', async () => {
+ fakePermissionApi.authorize.mockResolvedValue([
+ {
+ result: AuthorizeResult.CONDITIONAL,
+ conditions: { rule: 'IS_ENTITY_KIND', params: [['b']] },
+ },
+ ]);
+ const catalog = createCatalog(isEntityKind);
+
+ await catalog.facets({ facets: ['a'], authorizationToken: 'abcd' });
+
+ expect(fakeCatalog.facets).toHaveBeenCalledWith({
+ facets: ['a'],
+ authorizationToken: 'abcd',
+ filter: { key: 'kind', values: ['b'] },
+ });
+ });
+
+ it('calls underlying catalog method on ALLOW', async () => {
+ fakePermissionApi.authorize.mockResolvedValue([
+ { result: AuthorizeResult.ALLOW },
+ ]);
+ const catalog = createCatalog();
+
+ await catalog.facets({ facets: ['a'], authorizationToken: 'abcd' });
+
+ expect(fakeCatalog.facets).toHaveBeenCalledWith({
+ facets: ['a'],
+ authorizationToken: 'abcd',
+ });
+ });
+ });
});
diff --git a/plugins/catalog-backend/src/service/AuthorizedEntitiesCatalog.ts b/plugins/catalog-backend/src/service/AuthorizedEntitiesCatalog.ts
index 99fc3ebc8e..2f94e23303 100644
--- a/plugins/catalog-backend/src/service/AuthorizedEntitiesCatalog.ts
+++ b/plugins/catalog-backend/src/service/AuthorizedEntitiesCatalog.ts
@@ -30,6 +30,8 @@ import {
EntitiesRequest,
EntitiesResponse,
EntityAncestryResponse,
+ EntityFacetsRequest,
+ EntityFacetsResponse,
EntityFilter,
} from '../catalog/types';
import { basicEntityFilter } from './request/basicEntityFilter';
@@ -151,6 +153,35 @@ export class AuthorizedEntitiesCatalog implements EntitiesCatalog {
};
}
+ async facets(request: EntityFacetsRequest): Promise {
+ const authorizeDecision = (
+ await this.permissionApi.authorize(
+ [{ permission: catalogEntityReadPermission }],
+ { token: request?.authorizationToken },
+ )
+ )[0];
+
+ if (authorizeDecision.result === AuthorizeResult.DENY) {
+ return {
+ facets: Object.fromEntries(request.facets.map(f => [f, []])),
+ };
+ }
+
+ if (authorizeDecision.result === AuthorizeResult.CONDITIONAL) {
+ const permissionFilter: EntityFilter = this.transformConditions(
+ authorizeDecision.conditions,
+ );
+ return this.entitiesCatalog.facets({
+ ...request,
+ filter: request?.filter
+ ? { allOf: [permissionFilter, request.filter] }
+ : permissionFilter,
+ });
+ }
+
+ return this.entitiesCatalog.facets(request);
+ }
+
private findParents(
entityRef: string,
allAncestryItems: { entity: Entity; parentEntityRefs: string[] }[],
diff --git a/plugins/catalog-backend/src/service/AuthorizedLocationService.ts b/plugins/catalog-backend/src/service/AuthorizedLocationService.ts
index 13557102c9..077f56c737 100644
--- a/plugins/catalog-backend/src/service/AuthorizedLocationService.ts
+++ b/plugins/catalog-backend/src/service/AuthorizedLocationService.ts
@@ -15,7 +15,7 @@
*/
import { Location } from '@backstage/catalog-client';
-import { LocationSpec, Entity } from '@backstage/catalog-model';
+import { Entity } from '@backstage/catalog-model';
import { NotAllowedError, NotFoundError } from '@backstage/errors';
import {
catalogLocationCreatePermission,
@@ -26,7 +26,7 @@ import {
AuthorizeResult,
PermissionAuthorizer,
} from '@backstage/plugin-permission-common';
-import { LocationService } from './types';
+import { LocationInput, LocationService } from './types';
export class AuthorizedLocationService implements LocationService {
constructor(
@@ -35,7 +35,7 @@ export class AuthorizedLocationService implements LocationService {
) {}
async createLocation(
- spec: LocationSpec,
+ spec: LocationInput,
dryRun: boolean,
options?: {
authorizationToken?: string;
diff --git a/plugins/catalog-backend/src/service/CatalogBuilder.ts b/plugins/catalog-backend/src/service/CatalogBuilder.ts
index 46c92c43da..9004cb4c56 100644
--- a/plugins/catalog-backend/src/service/CatalogBuilder.ts
+++ b/plugins/catalog-backend/src/service/CatalogBuilder.ts
@@ -97,6 +97,7 @@ import { basicEntityFilter } from './request/basicEntityFilter';
import { RESOURCE_TYPE_CATALOG_ENTITY } from '@backstage/plugin-catalog-common';
import { AuthorizedLocationService } from './AuthorizedLocationService';
+/** @public */
export type CatalogEnvironment = {
logger: Logger;
database: PluginDatabaseManager;
diff --git a/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.test.ts b/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.test.ts
index d6d4e957f6..43e208197f 100644
--- a/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.test.ts
+++ b/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.test.ts
@@ -469,6 +469,62 @@ describe('DefaultEntitiesCatalog', () => {
expect(entities.length).toBe(0);
},
);
+
+ it.each(databases.eachSupportedId())(
+ 'should return both target and targetRef for entities',
+ async databaseId => {
+ const { knex } = await createDatabase(databaseId);
+ await addEntity(
+ knex,
+ {
+ apiVersion: 'a',
+ kind: 'k',
+ metadata: { name: 'one' },
+ spec: {},
+ relations: [{ type: 'r', targetRef: 'x:y/z' } as any],
+ },
+ [],
+ );
+ await addEntity(
+ knex,
+ {
+ apiVersion: 'a',
+ kind: 'k',
+ metadata: { name: 'two' },
+ spec: {},
+ relations: [
+ {
+ type: 'r',
+ target: { kind: 'x', namespace: 'y', name: 'z' },
+ } as any,
+ ],
+ },
+ [],
+ );
+ const catalog = new DefaultEntitiesCatalog(knex);
+
+ const { entities } = await catalog.entities();
+
+ expect(
+ entities.find(e => e.metadata.name === 'one')!.relations,
+ ).toEqual([
+ {
+ type: 'r',
+ targetRef: 'x:y/z',
+ target: { kind: 'x', namespace: 'y', name: 'z' },
+ },
+ ]);
+ expect(
+ entities.find(e => e.metadata.name === 'two')!.relations,
+ ).toEqual([
+ {
+ type: 'r',
+ targetRef: 'x:y/z',
+ target: { kind: 'x', namespace: 'y', name: 'z' },
+ },
+ ]);
+ },
+ );
});
describe('removeEntityByUid', () => {
@@ -535,4 +591,129 @@ describe('DefaultEntitiesCatalog', () => {
},
);
});
+
+ describe('facets', () => {
+ it.each(databases.eachSupportedId())(
+ 'can filter and collect properly',
+ async databaseId => {
+ const { knex } = await createDatabase(databaseId);
+
+ await addEntityToSearch(knex, {
+ apiVersion: 'a',
+ kind: 'k',
+ metadata: { name: 'one' },
+ spec: {},
+ });
+ await addEntityToSearch(knex, {
+ apiVersion: 'a',
+ kind: 'k',
+ metadata: { name: 'two' },
+ spec: {},
+ });
+ await addEntityToSearch(knex, {
+ apiVersion: 'a',
+ kind: 'k2',
+ metadata: { name: 'two' },
+ spec: {},
+ });
+ const catalog = new DefaultEntitiesCatalog(knex);
+
+ await expect(catalog.facets({ facets: ['kind'] })).resolves.toEqual({
+ facets: {
+ kind: [
+ { value: 'k', count: 2 },
+ { value: 'k2', count: 1 },
+ ],
+ },
+ });
+ },
+ );
+
+ it.each(databases.eachSupportedId())(
+ 'can match on annotations and labels with dots in them',
+ async databaseId => {
+ const { knex } = await createDatabase(databaseId);
+
+ await addEntityToSearch(knex, {
+ apiVersion: 'a',
+ kind: 'k',
+ metadata: {
+ name: 'one',
+ annotations: { 'a.b/c.d': 'annotation1' },
+ labels: { 'e.f/g.h': 'label1' },
+ },
+ spec: {},
+ });
+ await addEntityToSearch(knex, {
+ apiVersion: 'a',
+ kind: 'k',
+ metadata: {
+ name: 'two',
+ annotations: { 'a.b/c.d': 'annotation2' },
+ labels: { 'e.f/g.h': 'label2' },
+ },
+ spec: {},
+ });
+ const catalog = new DefaultEntitiesCatalog(knex);
+
+ await expect(
+ catalog.facets({
+ facets: ['metadata.annotations.a.b/c.d', 'metadata.labels.e.f/g.h'],
+ }),
+ ).resolves.toEqual({
+ facets: {
+ 'metadata.annotations.a.b/c.d': [
+ { value: 'annotation1', count: 1 },
+ { value: 'annotation2', count: 1 },
+ ],
+ 'metadata.labels.e.f/g.h': [
+ { value: 'label1', count: 1 },
+ { value: 'label2', count: 1 },
+ ],
+ },
+ });
+ },
+ );
+
+ it.each(databases.eachSupportedId())(
+ 'can match on strings in arrays',
+ async databaseId => {
+ const { knex } = await createDatabase(databaseId);
+
+ await addEntityToSearch(knex, {
+ apiVersion: 'a',
+ kind: 'k',
+ metadata: {
+ name: 'one',
+ tags: ['java', 'rust'],
+ },
+ spec: {},
+ });
+ await addEntityToSearch(knex, {
+ apiVersion: 'a',
+ kind: 'k',
+ metadata: {
+ name: 'two',
+ tags: ['java', 'node'],
+ },
+ spec: {},
+ });
+ const catalog = new DefaultEntitiesCatalog(knex);
+
+ await expect(
+ catalog.facets({
+ facets: ['metadata.tags'],
+ }),
+ ).resolves.toEqual({
+ facets: {
+ 'metadata.tags': expect.arrayContaining([
+ { value: 'java', count: 2 },
+ { value: 'rust', count: 1 },
+ { value: 'node', count: 1 },
+ ]),
+ },
+ });
+ },
+ );
+ });
});
diff --git a/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.ts b/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.ts
index 6979f94ba7..f8b68bebc5 100644
--- a/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.ts
+++ b/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.ts
@@ -14,24 +14,31 @@
* limitations under the License.
*/
-import { Entity, stringifyEntityRef } from '@backstage/catalog-model';
+import {
+ Entity,
+ parseEntityRef,
+ stringifyEntityRef,
+} from '@backstage/catalog-model';
import { InputError, NotFoundError } from '@backstage/errors';
import { Knex } from 'knex';
+import lodash from 'lodash';
import {
EntitiesCatalog,
EntitiesRequest,
EntitiesResponse,
- EntityAncestryResponse,
- EntityPagination,
- EntityFilter,
EntitiesSearchFilter,
+ EntityAncestryResponse,
+ EntityFacetsRequest,
+ EntityFacetsResponse,
+ EntityFilter,
+ EntityPagination,
} from '../catalog/types';
import {
DbFinalEntitiesRow,
+ DbPageInfo,
DbRefreshStateReferencesRow,
DbRefreshStateRow,
DbSearchRow,
- DbPageInfo,
} from '../database/tables';
function parsePagination(input?: EntityPagination): {
@@ -191,11 +198,32 @@ export class DefaultEntitiesCatalog implements EntitiesCatalog {
};
}
- const dbResponse = rows.map(e => JSON.parse(e.final_entity!));
+ let entities: Entity[] = rows.map(e => JSON.parse(e.final_entity!));
- const entities = dbResponse.map(e =>
- request?.fields ? request.fields(e) : e,
- );
+ if (request?.fields) {
+ entities = entities.map(e => request.fields!(e));
+ }
+
+ // TODO(freben): This is added as a compatibility guarantee, until we can be
+ // sure that all adopters have re-stitched their entities so that the new
+ // targetRef field is present on them, and that they have stopped consuming
+ // the now-removed old field
+ for (const entity of entities) {
+ if (entity.relations) {
+ for (const relation of entity.relations) {
+ if (!relation.targetRef && relation.target) {
+ // This is the case where an old-form entity, not yet stitched with
+ // the updated code, was in the database
+ relation.targetRef = stringifyEntityRef(relation.target);
+ } else if (!relation.target && relation.targetRef) {
+ // This is the case where a new-form entity, stitched with the
+ // updated code, was in the database but we still want to produce
+ // the old data shape as well for compatibility reasons
+ relation.target = parseEntityRef(relation.targetRef);
+ }
+ }
+ }
+ }
return {
entities,
@@ -295,4 +323,49 @@ export class DefaultEntitiesCatalog implements EntitiesCatalog {
items,
};
}
+
+ async facets(request: EntityFacetsRequest): Promise {
+ const { entities } = await this.entities({
+ filter: request.filter,
+ authorizationToken: request.authorizationToken,
+ });
+
+ const facets: EntityFacetsResponse['facets'] = {};
+
+ for (const facet of request.facets) {
+ const values = entities
+ .map(entity => {
+ // TODO(freben): Generalize this code to handle any field that may
+ // have dots in its key?
+ if (facet.startsWith('metadata.annotations.')) {
+ return entity.metadata.annotations?.[
+ facet.substring('metadata.annotations.'.length)
+ ];
+ } else if (facet.startsWith('metadata.labels.')) {
+ return entity.metadata.labels?.[
+ facet.substring('metadata.labels.'.length)
+ ];
+ }
+ return lodash.get(entity, facet);
+ })
+ .flatMap(field => {
+ if (typeof field === 'string') {
+ return [field];
+ } else if (Array.isArray(field)) {
+ return field.filter(i => typeof i === 'string');
+ }
+ return [];
+ })
+ .sort();
+
+ const counts = lodash.countBy(values, lodash.identity);
+
+ facets[facet] = Object.entries(counts).map(([value, count]) => ({
+ value,
+ count,
+ }));
+ }
+
+ return { facets };
+ }
}
diff --git a/plugins/catalog-backend/src/service/DefaultLocationService.ts b/plugins/catalog-backend/src/service/DefaultLocationService.ts
index 8bc02e24f6..c6b5eaf162 100644
--- a/plugins/catalog-backend/src/service/DefaultLocationService.ts
+++ b/plugins/catalog-backend/src/service/DefaultLocationService.ts
@@ -15,7 +15,6 @@
*/
import {
Entity,
- LocationSpec,
ANNOTATION_LOCATION,
ANNOTATION_ORIGIN_LOCATION,
stringifyEntityRef,
@@ -25,7 +24,7 @@ import {
CatalogProcessingOrchestrator,
DeferredEntity,
} from '../processing/types';
-import { LocationService, LocationStore } from './types';
+import { LocationInput, LocationService, LocationStore } from './types';
import { locationSpecToMetadataName } from '../util/conversion';
export class DefaultLocationService implements LocationService {
@@ -35,13 +34,13 @@ export class DefaultLocationService implements LocationService {
) {}
async createLocation(
- spec: LocationSpec,
+ input: LocationInput,
dryRun: boolean,
): Promise<{ location: Location; entities: Entity[]; exists?: boolean }> {
if (dryRun) {
- return this.dryRunCreateLocation(spec);
+ return this.dryRunCreateLocation(input);
}
- const location = await this.store.createLocation(spec);
+ const location = await this.store.createLocation(input);
return { location, entities: [] };
}
@@ -93,7 +92,7 @@ export class DefaultLocationService implements LocationService {
}
private async dryRunCreateLocation(
- spec: LocationSpec,
+ spec: LocationInput,
): Promise<{ location: Location; entities: Entity[]; exists?: boolean }> {
// Run the existence check in parallel with the processing
const existsPromise = this.store
diff --git a/plugins/catalog-backend/src/service/createRouter.test.ts b/plugins/catalog-backend/src/service/createRouter.test.ts
index 6ae24ecd27..8db15cb4a1 100644
--- a/plugins/catalog-backend/src/service/createRouter.test.ts
+++ b/plugins/catalog-backend/src/service/createRouter.test.ts
@@ -18,11 +18,11 @@ import { getVoidLogger } from '@backstage/backend-common';
import { ConfigReader } from '@backstage/config';
import { NotFoundError } from '@backstage/errors';
import type { Location } from '@backstage/catalog-client';
-import type { Entity, LocationSpec } from '@backstage/catalog-model';
+import type { Entity } from '@backstage/catalog-model';
import express from 'express';
import request from 'supertest';
import { EntitiesCatalog } from '../catalog';
-import { LocationService, RefreshService } from './types';
+import { LocationInput, LocationService, RefreshService } from './types';
import { basicEntityFilter } from './request';
import { createRouter } from './createRouter';
import { AuthorizeResult } from '@backstage/plugin-permission-common';
@@ -40,6 +40,7 @@ describe('createRouter readonly disabled', () => {
entities: jest.fn(),
removeEntityByUid: jest.fn(),
entityAncestry: jest.fn(),
+ facets: jest.fn(),
};
locationService = {
getLocation: jest.fn(),
@@ -298,7 +299,7 @@ describe('createRouter readonly disabled', () => {
const spec = {
typez: 'b',
target: 'c',
- } as unknown as LocationSpec;
+ } as unknown as LocationInput;
const response = await request(app)
.post('/locations')
@@ -310,7 +311,7 @@ describe('createRouter readonly disabled', () => {
});
it('passes the body down', async () => {
- const spec: LocationSpec = {
+ const spec: LocationInput = {
type: 'b',
target: 'c',
};
@@ -338,7 +339,7 @@ describe('createRouter readonly disabled', () => {
});
it('supports dry run', async () => {
- const spec: LocationSpec = {
+ const spec: LocationInput = {
type: 'b',
target: 'c',
};
@@ -394,6 +395,7 @@ describe('createRouter readonly enabled', () => {
entities: jest.fn(),
removeEntityByUid: jest.fn(),
entityAncestry: jest.fn(),
+ facets: jest.fn(),
};
locationService = {
getLocation: jest.fn(),
@@ -504,7 +506,7 @@ describe('createRouter readonly enabled', () => {
describe('POST /locations', () => {
it('is not allowed', async () => {
- const spec: LocationSpec = {
+ const spec: LocationInput = {
type: 'b',
target: 'c',
};
@@ -520,7 +522,7 @@ describe('createRouter readonly enabled', () => {
});
it('supports dry run', async () => {
- const spec: LocationSpec = {
+ const spec: LocationInput = {
type: 'b',
target: 'c',
};
@@ -578,6 +580,7 @@ describe('NextRouter permissioning', () => {
entities: jest.fn(),
removeEntityByUid: jest.fn(),
entityAncestry: jest.fn(),
+ facets: jest.fn(),
};
locationService = {
getLocation: jest.fn(),
diff --git a/plugins/catalog-backend/src/service/createRouter.ts b/plugins/catalog-backend/src/service/createRouter.ts
index 0dce765507..56121f4155 100644
--- a/plugins/catalog-backend/src/service/createRouter.ts
+++ b/plugins/catalog-backend/src/service/createRouter.ts
@@ -32,11 +32,12 @@ import {
} from './request';
import {
disallowReadonlyMode,
- locationSpec,
+ locationInput,
validateRequestBody,
} from './util';
import { RefreshOptions, LocationService, RefreshService } from './types';
import { z } from 'zod';
+import { parseEntityFacetParams } from './request/parseEntityFacetParams';
/**
* Options used by {@link createRouter}.
@@ -160,13 +161,21 @@ export async function createRouter(
const response = await entitiesCatalog.entityAncestry(entityRef);
res.status(200).json(response);
},
- );
+ )
+ .get('/entity-facets', async (req, res) => {
+ const response = await entitiesCatalog.facets({
+ filter: parseEntityFilterParams(req.query),
+ facets: parseEntityFacetParams(req.query),
+ authorizationToken: getBearerToken(req.header('authorization')),
+ });
+ res.status(200).json(response);
+ });
}
if (locationService) {
router
.post('/locations', async (req, res) => {
- const location = await validateRequestBody(req, locationSpec);
+ const location = await validateRequestBody(req, locationInput);
const dryRun = yn(req.query.dryRun, { default: false });
// when in dryRun addLocation is effectively a read operation so we don't
@@ -209,9 +218,9 @@ export async function createRouter(
router.post('/analyze-location', async (req, res) => {
const body = await validateRequestBody(
req,
- z.object({ location: locationSpec }),
+ z.object({ location: locationInput }),
);
- const schema = z.object({ location: locationSpec });
+ const schema = z.object({ location: locationInput });
const output = await locationAnalyzer.analyzeLocation(schema.parse(body));
res.status(200).json(output);
});
diff --git a/plugins/catalog-backend/src/service/index.ts b/plugins/catalog-backend/src/service/index.ts
index fd1b31b9d1..e1c7f54475 100644
--- a/plugins/catalog-backend/src/service/index.ts
+++ b/plugins/catalog-backend/src/service/index.ts
@@ -19,6 +19,7 @@ export type {
RefreshService,
RefreshOptions,
LocationStore,
+ LocationInput,
} from './types';
export { createRouter } from './createRouter';
export type { RouterOptions } from './createRouter';
diff --git a/plugins/catalog-backend/src/service/request/parseEntityFacetParams.ts b/plugins/catalog-backend/src/service/request/parseEntityFacetParams.ts
new file mode 100644
index 0000000000..00493f068f
--- /dev/null
+++ b/plugins/catalog-backend/src/service/request/parseEntityFacetParams.ts
@@ -0,0 +1,37 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { InputError } from '@backstage/errors';
+import { parseStringsParam } from './common';
+
+/**
+ * Parses the facets part of a facet query, like
+ * /entity-facets?filter=metadata.namespace=default,kind=Component&facet=metadata.namespace
+ */
+export function parseEntityFacetParams(
+ params: Record,
+): string[] {
+ // Each facet string is on the form a.b.c
+ const facetStrings = parseStringsParam(params.facet, 'facet');
+ if (facetStrings) {
+ const filtered = facetStrings.filter(Boolean);
+ if (filtered.length) {
+ return filtered;
+ }
+ }
+
+ throw new InputError('Missing facet parameter');
+}
diff --git a/plugins/catalog-backend/src/service/types.ts b/plugins/catalog-backend/src/service/types.ts
index c923949a04..02268ab63c 100644
--- a/plugins/catalog-backend/src/service/types.ts
+++ b/plugins/catalog-backend/src/service/types.ts
@@ -14,12 +14,28 @@
* limitations under the License.
*/
-import { Entity, LocationSpec } from '@backstage/catalog-model';
+import { Entity } from '@backstage/catalog-model';
import { Location } from '@backstage/catalog-client';
+/**
+ * Holds the information required to create a new location in the catalog location store.
+ *
+ * @public
+ */
+export interface LocationInput {
+ type: string;
+ target: string;
+ /** @deprecated This field is ignored and will be removed */
+ presence?: 'optional' | 'required';
+}
+
+/**
+ * The location service manages entity locations.
+ * @public
+ */
export interface LocationService {
createLocation(
- spec: LocationSpec,
+ location: LocationInput,
dryRun: boolean,
options?: {
authorizationToken?: string;
@@ -59,8 +75,11 @@ export interface RefreshService {
refresh(options: RefreshOptions): Promise;
}
+/**
+ * Interacts with the database to manage locations.
+ * @public */
export interface LocationStore {
- createLocation(spec: LocationSpec): Promise;
+ createLocation(location: LocationInput): Promise;
listLocations(): Promise;
getLocation(id: string): Promise;
deleteLocation(id: string): Promise;
diff --git a/plugins/catalog-backend/src/service/util.ts b/plugins/catalog-backend/src/service/util.ts
index 09f1c2d8cf..9a914aadcb 100644
--- a/plugins/catalog-backend/src/service/util.ts
+++ b/plugins/catalog-backend/src/service/util.ts
@@ -40,7 +40,7 @@ export async function requireRequestBody(req: Request): Promise {
return body;
}
-export const locationSpec = z
+export const locationInput = z
.object({
type: z.string(),
target: z.string(),
diff --git a/plugins/catalog-backend/src/stitching/Stitcher.test.ts b/plugins/catalog-backend/src/stitching/Stitcher.test.ts
index be57ff7083..9df4bedd60 100644
--- a/plugins/catalog-backend/src/stitching/Stitcher.test.ts
+++ b/plugins/catalog-backend/src/stitching/Stitcher.test.ts
@@ -93,6 +93,7 @@ describe('Stitcher', () => {
relations: [
{
type: 'looksAt',
+ targetRef: 'k:ns/other',
target: {
kind: 'k',
namespace: 'ns',
@@ -159,6 +160,7 @@ describe('Stitcher', () => {
relations: expect.arrayContaining([
{
type: 'looksAt',
+ targetRef: 'k:ns/other',
target: {
kind: 'k',
namespace: 'ns',
@@ -167,6 +169,7 @@ describe('Stitcher', () => {
},
{
type: 'looksAt',
+ targetRef: 'k:ns/third',
target: {
kind: 'k',
namespace: 'ns',
diff --git a/plugins/catalog-backend/src/stitching/Stitcher.ts b/plugins/catalog-backend/src/stitching/Stitcher.ts
index 9ec028ed35..37b86fef46 100644
--- a/plugins/catalog-backend/src/stitching/Stitcher.ts
+++ b/plugins/catalog-backend/src/stitching/Stitcher.ts
@@ -18,6 +18,7 @@ import { ENTITY_STATUS_CATALOG_PROCESSING_TYPE } from '@backstage/catalog-client
import {
AlphaEntity,
parseEntityRef,
+ EntityRelation,
EntityStatusItem,
} from '@backstage/catalog-model';
import { SerializedError, stringifyError } from '@backstage/errors';
@@ -183,9 +184,11 @@ export class Stitcher {
);
entity.relations = uniqueRelationRows
.filter(row => row.relationType /* exclude null row, if relevant */)
- .map(row => ({
+ .map(row => ({
type: row.relationType!,
+ // TODO(freben): This field is deprecated and should be removed in a future release
target: parseEntityRef(row.relationTarget!),
+ targetRef: row.relationTarget!,
}));
if (statusItems.length) {
entity.status = {
@@ -210,7 +213,7 @@ export class Stitcher {
}
// This may throw if the entity is invalid, so we call it before
- // the final_entites write, even though we may end up not needing
+ // the final_entities write, even though we may end up not needing
// to write the search index.
const searchEntries = buildEntitySearch(entityId, entity);
diff --git a/plugins/catalog-backend/src/stitching/buildEntitySearch.test.ts b/plugins/catalog-backend/src/stitching/buildEntitySearch.test.ts
index 173538f18f..52e3392676 100644
--- a/plugins/catalog-backend/src/stitching/buildEntitySearch.test.ts
+++ b/plugins/catalog-backend/src/stitching/buildEntitySearch.test.ts
@@ -141,8 +141,16 @@ describe('buildEntitySearch', () => {
it('adds relations', () => {
const input: Entity = {
relations: [
- { type: 't1', target: { kind: 'k', namespace: 'ns', name: 'a' } },
- { type: 't2', target: { kind: 'k', namespace: 'ns', name: 'b' } },
+ {
+ type: 't1',
+ targetRef: 'k:ns/a',
+ target: { kind: 'k', namespace: 'ns', name: 'a' },
+ },
+ {
+ type: 't2',
+ targetRef: 'k:ns/b',
+ target: { kind: 'k', namespace: 'ns', name: 'b' },
+ },
],
apiVersion: 'a',
kind: 'b',
@@ -182,8 +190,16 @@ describe('buildEntitySearch', () => {
expect(() =>
buildEntitySearch('eid', {
relations: [
- { type: 'dup', target: { kind: 'k', namespace: 'ns', name: 'a' } },
- { type: 'DUP', target: { kind: 'k', namespace: 'ns', name: 'b' } },
+ {
+ type: 'dup',
+ targetRef: 'k:ns/a',
+ target: { kind: 'k', namespace: 'ns', name: 'a' },
+ },
+ {
+ type: 'DUP',
+ targetRef: 'k:ns/b',
+ target: { kind: 'k', namespace: 'ns', name: 'b' },
+ },
],
apiVersion: 'a',
kind: 'b',
diff --git a/plugins/catalog-backend/src/stitching/buildEntitySearch.ts b/plugins/catalog-backend/src/stitching/buildEntitySearch.ts
index d0506e8998..cd8a3735de 100644
--- a/plugins/catalog-backend/src/stitching/buildEntitySearch.ts
+++ b/plugins/catalog-backend/src/stitching/buildEntitySearch.ts
@@ -14,11 +14,7 @@
* limitations under the License.
*/
-import {
- Entity,
- DEFAULT_NAMESPACE,
- stringifyEntityRef,
-} from '@backstage/catalog-model';
+import { Entity, DEFAULT_NAMESPACE } from '@backstage/catalog-model';
import { InputError } from '@backstage/errors';
import { DbSearchRow } from '../database/tables';
@@ -181,7 +177,7 @@ export function buildEntitySearch(
for (const relation of entity.relations ?? []) {
raw.push({
key: `relations.${relation.type}`,
- value: stringifyEntityRef(relation.target),
+ value: relation.targetRef,
});
}
diff --git a/plugins/catalog-backend/src/util/RecursivePartial.ts b/plugins/catalog-backend/src/util/RecursivePartial.ts
index 502f4464c1..92e1ab9296 100644
--- a/plugins/catalog-backend/src/util/RecursivePartial.ts
+++ b/plugins/catalog-backend/src/util/RecursivePartial.ts
@@ -16,6 +16,7 @@
/**
* Makes all keys of an entire hierarchy optional.
+ * @public
*/
export type RecursivePartial = {
[P in keyof T]?: T[P] extends (infer U)[]
diff --git a/plugins/catalog-backend/src/util/conversion.ts b/plugins/catalog-backend/src/util/conversion.ts
index 9dd5ce7986..75ed4f5e96 100644
--- a/plugins/catalog-backend/src/util/conversion.ts
+++ b/plugins/catalog-backend/src/util/conversion.ts
@@ -17,13 +17,13 @@
import {
Entity,
LocationEntityV1alpha1,
- LocationSpec,
ANNOTATION_LOCATION,
ANNOTATION_ORIGIN_LOCATION,
stringifyEntityRef,
stringifyLocationRef,
} from '@backstage/catalog-model';
import { createHash } from 'crypto';
+import { LocationSpec } from '../ingestion';
export function locationSpecToMetadataName(location: LocationSpec) {
const hash = createHash('sha1')
diff --git a/plugins/catalog-backend/src/util/index.ts b/plugins/catalog-backend/src/util/index.ts
index 2e592fb8df..13a9c84b0f 100644
--- a/plugins/catalog-backend/src/util/index.ts
+++ b/plugins/catalog-backend/src/util/index.ts
@@ -16,4 +16,3 @@
export * from './runPeriodically';
export * from './RecursivePartial';
-export * from './timing';
diff --git a/plugins/catalog-backend/src/util/runPeriodically.ts b/plugins/catalog-backend/src/util/runPeriodically.ts
index 2f3104e221..361fb33b2f 100644
--- a/plugins/catalog-backend/src/util/runPeriodically.ts
+++ b/plugins/catalog-backend/src/util/runPeriodically.ts
@@ -23,6 +23,8 @@
* @param delayMs - The delay between a completed function invocation and the
* next.
* @returns A function that, when called, stops the invocation loop.
+ * @deprecated use \@backstage/backend-tasks package instead.
+ * @public
*/
export function runPeriodically(fn: () => any, delayMs: number): () => void {
let cancel: () => void;
diff --git a/plugins/catalog-common/CHANGELOG.md b/plugins/catalog-common/CHANGELOG.md
index a236e55857..337bd6854c 100644
--- a/plugins/catalog-common/CHANGELOG.md
+++ b/plugins/catalog-common/CHANGELOG.md
@@ -1,5 +1,21 @@
# @backstage/plugin-catalog-common
+## 0.1.4
+
+### Patch Changes
+
+- Fix for the previous release with missing type declarations.
+- Updated dependencies
+ - @backstage/plugin-permission-common@0.5.1
+
+## 0.1.3
+
+### Patch Changes
+
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- Updated dependencies
+ - @backstage/plugin-permission-common@0.5.0
+
## 0.1.2
### Patch Changes
diff --git a/plugins/catalog-common/package.json b/plugins/catalog-common/package.json
index 4b94809ed5..9a52d22798 100644
--- a/plugins/catalog-common/package.json
+++ b/plugins/catalog-common/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-common",
"description": "Common functionalities for the catalog plugin",
- "version": "0.1.2",
+ "version": "0.1.4",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -12,6 +12,9 @@
"module": "dist/index.esm.js",
"types": "dist/index.d.ts"
},
+ "backstage": {
+ "role": "common-library"
+ },
"homepage": "https://backstage.io",
"repository": {
"type": "git",
@@ -22,18 +25,18 @@
"backstage"
],
"scripts": {
- "build": "backstage-cli build",
- "lint": "backstage-cli lint",
- "test": "backstage-cli test --passWithNoTests",
- "prepack": "backstage-cli prepack",
- "postpack": "backstage-cli postpack",
- "clean": "backstage-cli clean"
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "clean": "backstage-cli package clean"
},
"dependencies": {
- "@backstage/plugin-permission-common": "^0.4.0"
+ "@backstage/plugin-permission-common": "^0.5.1"
},
"devDependencies": {
- "@backstage/cli": "^0.13.2-next.0"
+ "@backstage/cli": "^0.14.0"
},
"files": [
"dist"
diff --git a/plugins/catalog-graph/CHANGELOG.md b/plugins/catalog-graph/CHANGELOG.md
index 0bb6e7224a..5ce044aa14 100644
--- a/plugins/catalog-graph/CHANGELOG.md
+++ b/plugins/catalog-graph/CHANGELOG.md
@@ -1,5 +1,35 @@
# @backstage/plugin-catalog-graph
+## 0.2.12
+
+### Patch Changes
+
+- a8331830f1: Remove use of deprecated `useEntityKinds` hook.
+- 6e1cbc12a6: Updated according to the new `getEntityFacets` catalog API method
+- 919cf2f836: Minor updates to match the new `targetRef` field of relations, and to stop consuming the `target` field
+- Updated dependencies
+ - @backstage/core-components@0.8.10
+ - @backstage/plugin-catalog-react@0.7.0
+ - @backstage/catalog-model@0.11.0
+ - @backstage/catalog-client@0.7.2
+ - @backstage/core-plugin-api@0.7.0
+
+## 0.2.11
+
+### Patch Changes
+
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- 538ca90790: Use updated type names from `@backstage/catalog-client`
+- deaf6065db: Adapt to the new `CatalogApi.getLocationByRef`
+- 7aeb491394: Replace use of deprecated `ENTITY_DEFAULT_NAMESPACE` constant with `DEFAULT_NAMESPACE`.
+- Updated dependencies
+ - @backstage/catalog-client@0.7.0
+ - @backstage/core-components@0.8.9
+ - @backstage/core-plugin-api@0.6.1
+ - @backstage/plugin-catalog-react@0.6.15
+ - @backstage/catalog-model@0.10.0
+ - @backstage/theme@0.2.15
+
## 0.2.10
### Patch Changes
diff --git a/plugins/catalog-graph/dev/index.tsx b/plugins/catalog-graph/dev/index.tsx
index 3ff9285a81..62d5eccef3 100644
--- a/plugins/catalog-graph/dev/index.tsx
+++ b/plugins/catalog-graph/dev/index.tsx
@@ -42,6 +42,7 @@ import {
catalogGraphPlugin,
EntityCatalogGraphCard,
} from '../src';
+import { CatalogEntityPage } from '@backstage/plugin-catalog';
type DataRelation = [string, string, string];
type DataEntity = [string, string, DataRelation[]];
@@ -118,6 +119,11 @@ const entities = (
},
relations: relations.map(([type, k, n]) => ({
target: { kind: k, name: n, namespace: DEFAULT_NAMESPACE },
+ targetRef: stringifyEntityRef({
+ kind: k,
+ namespace: DEFAULT_NAMESPACE,
+ name: n,
+ }),
type,
})),
};
@@ -162,6 +168,12 @@ createDevApp()
),
})
.addPage({
+ path: '/catalog-graph',
element: >;
-const useEntityKinds = useEntityKindsMocked as jest.Mock<
- ReturnType
->;
+const catalogApi = {
+ getEntityFacets: jest.fn().mockResolvedValue({
+ facets: {
+ kind: [
+ { value: 'Component', count: 2 },
+ { value: 'System', count: 1 },
+ { value: 'API', count: 1 },
+ { value: 'Resource', count: 1 },
+ ],
+ },
+ } as GetEntityFacetsResponse),
+};
+const apis = TestApiRegistry.from(
+ [catalogApiRef, catalogApi],
+ [alertApiRef, {} as AlertApi],
+);
describe('
+ {}} />
+ ,
+ );
+ expect(rendered.baseElement).toBeInTheDocument();
});
- afterEach(() => jest.resetAllMocks());
-
- test('should not explode while loading', () => {
- useEntityKinds.mockReturnValue({
- loading: true,
- kinds: undefined,
- error: undefined,
- });
- const { baseElement } = render(
- {}} />,
+ it('should render current value', async () => {
+ const rendered = await renderWithEffects(
+
+ {}} />
+ ,
);
- expect(baseElement).toBeInTheDocument();
+ expect(rendered.getByText('API')).toBeInTheDocument();
+ expect(rendered.getByText('Component')).toBeInTheDocument();
});
- test('should render current value', () => {
- const { getByText } = render(
- {}} />,
- );
-
- expect(getByText('API')).toBeInTheDocument();
- expect(getByText('Component')).toBeInTheDocument();
- });
-
- test('should select value', async () => {
+ it('should select value', async () => {
const onChange = jest.fn();
- const { getByText, getByLabelText } = render(
-
+ ,
);
userEvent.click(getByLabelText('Open'));
-
await waitFor(() => expect(getByText('System')).toBeInTheDocument());
userEvent.click(getByText('System'));
@@ -79,15 +79,16 @@ describe('
+ ,
);
-
userEvent.click(getByLabelText('Open'));
await waitFor(() => expect(getByText('Resource')).toBeInTheDocument());
@@ -99,10 +100,12 @@ describe('
+ ,
);
userEvent.click(getByRole('combobox'));
diff --git a/plugins/catalog-graph/src/components/CatalogGraphPage/SelectedKindsFilter.tsx b/plugins/catalog-graph/src/components/CatalogGraphPage/SelectedKindsFilter.tsx
index 87ba8e77bf..316f83da62 100644
--- a/plugins/catalog-graph/src/components/CatalogGraphPage/SelectedKindsFilter.tsx
+++ b/plugins/catalog-graph/src/components/CatalogGraphPage/SelectedKindsFilter.tsx
@@ -14,7 +14,7 @@
* limitations under the License.
*/
import { alertApiRef, useApi } from '@backstage/core-plugin-api';
-import { useEntityKinds } from '@backstage/plugin-catalog-react';
+import { catalogApiRef } from '@backstage/plugin-catalog-react';
import {
Box,
Checkbox,
@@ -28,6 +28,7 @@ import CheckBoxOutlineBlankIcon from '@material-ui/icons/CheckBoxOutlineBlank';
import ExpandMoreIcon from '@material-ui/icons/ExpandMore';
import { Autocomplete } from '@material-ui/lab';
import React, { useCallback, useEffect, useMemo } from 'react';
+import useAsync from 'react-use/lib/useAsync';
const useStyles = makeStyles({
formControl: {
@@ -43,7 +44,13 @@ export type Props = {
export const SelectedKindsFilter = ({ value, onChange }: Props) => {
const classes = useStyles();
const alertApi = useApi(alertApiRef);
- const { error, kinds } = useEntityKinds();
+ const catalogApi = useApi(catalogApiRef);
+
+ const { error, value: kinds } = useAsync(async () => {
+ return await catalogApi
+ .getEntityFacets({ facets: ['kind'] })
+ .then(response => response.facets.kind?.map(f => f.value).sort() || []);
+ });
useEffect(() => {
if (error) {
diff --git a/plugins/catalog-graph/src/components/EntityRelationsGraph/EntityRelationsGraph.test.tsx b/plugins/catalog-graph/src/components/EntityRelationsGraph/EntityRelationsGraph.test.tsx
index be0c4dc5e5..36dc816444 100644
--- a/plugins/catalog-graph/src/components/EntityRelationsGraph/EntityRelationsGraph.test.tsx
+++ b/plugins/catalog-graph/src/components/EntityRelationsGraph/EntityRelationsGraph.test.tsx
@@ -54,6 +54,7 @@ describe(' = {
diff --git a/plugins/catalog-react/CHANGELOG.md b/plugins/catalog-react/CHANGELOG.md
index 65fd275389..ac611032e5 100644
--- a/plugins/catalog-react/CHANGELOG.md
+++ b/plugins/catalog-react/CHANGELOG.md
@@ -1,5 +1,65 @@
# @backstage/plugin-catalog-react
+## 0.7.0
+
+### Minor Changes
+
+- 3334ad47d4: Removed the deprecated `EntityContext` which have been replaced by `useEntity`, `EntityProvider` and `AsyncEntityProvider`.
+- e2e0b6625c: Improved API documentation.
+
+ **BREAKING**: The individual table column factories (e.g. `createEntityRefColumn`) are now no longer available directly, but only through `EntityTable.columns`.
+
+- c4276915c0: **BREAKING**: Deleted the deprecated `loadIdentityOwnerRefs` function which is replaced by `ownershipEntityRefs` from `identityApi.getBackstageIdentity()`.
+
+ Deprecated the `loadCatalogOwnerRefs` hook as membership references should be added as `ent` inside `claims` sections of the `SignInResolver` when issuing tokens. See https://backstage.io/docs/auth/identity-resolver for more details on how to prepare your `SignInResolver` if not done already. Usage of the `loadCatalogOwnerRefs` hook should be replaced by `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
+
+### Patch Changes
+
+- a8331830f1: Deprecated the `useEntityKinds` hook due to low usage and utility value.
+- 6e1cbc12a6: Updated according to the new `getEntityFacets` catalog API method
+- b776ce5aab: Deprecated the `useEntityListProvider` hook which is now renamed to `useEntityList`
+- b3ef24038b: Deprecated `reduceCatalogFilters` and `reduceEntityFilters` as these helper functions are used internally and provides low external value.
+- 2d339b5f2c: Deprecated `useEntityFromUrl` and the `useEntityCompoundName` hooks as these have very low utility value.
+- 96b8ae9a9e: Deprecated the `EntityTypeReturn` type and inlined the return type to `useEntityTypeFilter` as the type and function name does not align
+- d4f67fa728: Deprecated the `useOwnedEntities` hook which is replaced by the IdentityAPI.
+ Deprecated the `useOwnUser` hook due to low external value.
+- 919cf2f836: Minor updates to match the new `targetRef` field of relations, and to stop consuming the `target` field
+- Updated dependencies
+ - @backstage/core-components@0.8.10
+ - @backstage/catalog-model@0.11.0
+ - @backstage/catalog-client@0.7.2
+ - @backstage/core-plugin-api@0.7.0
+ - @backstage/integration@0.7.5
+ - @backstage/plugin-permission-react@0.3.2
+
+## 0.6.15
+
+### Patch Changes
+
+- 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- 538ca90790: Use updated type names from `@backstage/catalog-client`
+- edbc03814a: Replace usage of `serializeEntityRef` with `stringifyEntityRef`
+- 244d24ebc4: Import `Location` from the `@backstage/catalog-client` package.
+- deaf6065db: Adapt to the new `CatalogApi.getLocationByRef`
+- 216725b434: Updated to use new names for `parseLocationRef` and `stringifyLocationRef`
+- e72d371296: Use `TemplateEntityV1beta2` from `@backstage/plugin-scaffolder-common` instead
+ of `@backstage/catalog-model`.
+- 98d1aa1ea1: Fix CatalogPage showing all components when owned filter was pre-selected
+- 27eccab216: Replaces use of deprecated catalog-model constants.
+- 7aeb491394: Replace use of deprecated `ENTITY_DEFAULT_NAMESPACE` constant with `DEFAULT_NAMESPACE`.
+- Updated dependencies
+ - @backstage/catalog-client@0.7.0
+ - @backstage/core-components@0.8.9
+ - @backstage/core-plugin-api@0.6.1
+ - @backstage/errors@0.2.1
+ - @backstage/integration@0.7.3
+ - @backstage/plugin-permission-common@0.5.0
+ - @backstage/plugin-permission-react@0.3.1
+ - @backstage/catalog-model@0.10.0
+ - @backstage/types@0.1.2
+ - @backstage/version-bridge@0.1.2
+
## 0.6.14
### Patch Changes
diff --git a/plugins/catalog-react/api-report.md b/plugins/catalog-react/api-report.md
index 5ab3f20d76..f117e8cd5c 100644
--- a/plugins/catalog-react/api-report.md
+++ b/plugins/catalog-react/api-report.md
@@ -11,12 +11,10 @@ import { CATALOG_FILTER_EXISTS } from '@backstage/catalog-client';
import { CatalogApi } from '@backstage/catalog-client';
import { ComponentEntity } from '@backstage/catalog-model';
import { ComponentProps } from 'react';
-import { Context } from 'react';
import { Entity } from '@backstage/catalog-model';
import { EntityName } from '@backstage/catalog-model';
import { GetEntitiesResponse } from '@backstage/catalog-client';
import { IconButton } from '@material-ui/core';
-import { IdentityApi } from '@backstage/core-plugin-api';
import { LinkProps } from '@backstage/core-components';
import { Observable } from '@backstage/types';
import { Overrides } from '@material-ui/core/styles/overrides';
@@ -66,9 +64,7 @@ export { CATALOG_FILTER_EXISTS };
export { CatalogApi };
-// Warning: (ae-missing-release-tag) "catalogApiRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export const catalogApiRef: ApiRef;
// @public (undocumented)
@@ -100,51 +96,37 @@ export type CatalogReactUserListPickerClassKey =
| 'menuItem'
| 'groupWrapper';
-// Warning: (ae-missing-release-tag) "catalogRouteRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
// @public @deprecated (undocumented)
export const catalogRouteRef: RouteRef;
// @public (undocumented)
-function createDomainColumn(): TableColumn;
+export const columnFactories: Readonly<{
+ createEntityRefColumn(options: {
+ defaultKind?: string;
+ }): TableColumn;
+ createEntityRelationColumn({
+ title,
+ relation,
+ defaultKind,
+ filter: entityFilter,
+ }: {
+ title: string;
+ relation: string;
+ defaultKind?: string | undefined;
+ filter?:
+ | {
+ kind: string;
+ }
+ | undefined;
+ }): TableColumn;
+ createOwnerColumn(): TableColumn;
+ createDomainColumn(): TableColumn;
+ createSystemColumn(): TableColumn;
+ createMetadataDescriptionColumn(): TableColumn;
+ createSpecLifecycleColumn(): TableColumn;
+ createSpecTypeColumn
+
+
+ value.setProjectId?.(parseInt(e.target.value, 10) || undefined)
+ }
+ />
+
+
+ )}
+