`
+
+- Code block line highlighting uses [custom magic comments](https://docusaurus.io/docs/markdown-features/code-blocks#custom-magic-comments). Currently, we have the following magic comments:
+ - Highlight line(s)
+ - `highlight-next-line`
+ - `highlight-start`
+ - `highlight-end`
+ - Add line(s)
+ - `highlight-add-next-line`
+ - `highlight-add-start`
+ - `highlight-add-end`
+ - Remove line(s)
+ - `highlight-remove-next-line`
+ - `highlight-remove-start`
+ - `highlight-remove-end`
diff --git a/microsite/blog/2023-03-15-backstage-turns-3.md b/microsite/blog/2023-03-15-backstage-turns-3.md
new file mode 100644
index 0000000000..317cdc0c4d
--- /dev/null
+++ b/microsite/blog/2023-03-15-backstage-turns-3.md
@@ -0,0 +1,84 @@
+---
+title: Backstage Turns Three!
+author: Ben Lambert
+authorURL: https://github.com/benjdlambert
+authorImageURL: https://avatars.githubusercontent.com/u/3645856?v=4
+---
+
+
+
+**TL;DR** Spotify released Backstage into open source three years ago today. Since then, the community has grown by leaps and bounds to stretch across the globe (and the Discord server!). Now that Backstage is a threenager, the growing pains are real. So, on this birthday, we want to cover our collective efforts to make it easier to adopt and contribute to Backstage.
+
+
+
+## They grow up so fast, don’t they?
+
+Happy birthday, Backstage! Three years ago, Spotify released its homegrown developer portal into the wild after a small team collaborated on an internal Hack Week project. We’d had a lot of conversations with companies looking to build out something similar to what we’d been running for years, so our Hack Week sprint started as an experiment to see if the Backstage core plugins could be valuable in open source.
+
+It's cliché at this point — because we’ve said it a million times — but no one could have predicted what came next.
+
+In three short years, Backstage has grown to a Cloud Native Computing Foundation Incubating project, with more than 900 adopters and 1000+ contributors worldwide. Companies like CVS Health, Siemens, LinkedIn, REI, Vodafone, and Lego are building out their own developer portals from the Backstage framework and bringing their learnings to the project.
+
+A few more stats we love to see (mainly coming from the [project repo](https://github.com/backstage/backstage)):
+
+- 3k+ project forks
+- 38k+ commits
+- 12k+ PRs
+- 15k+ total contributions
+- 21k+ stars on GitHub
+- 9k+ Discord members
+- 100+ open source plugins in the [plugin marketplace](https://backstage.io/plugins)
+
+But, without a doubt, the best thing about the Backstage project is the people in this community. People who are curious, collaborative, and excited to share knowledge. People who’ll sift through Discord at all hours to answer questions and support one another. People who come from all over the world but share a common trait: being passionate about enabling developers to do their best work.
+
+Don’t take our word for it! Take a look at this birthday video we put together with a few community members.
+
+
+
+
+
+## The growing pains are real
+
+But it's not all sunshine and roses in Backstage-land. If Year 1 was about getting this community going and Year 2 was focused on maturing the platform, then Year 3 needs to address some of the inevitable growing pains a project undergoes as it gains ground.
+
+We hear two things pretty consistently from the community:
+
+- **Backstage is a steep learning curve:** Over the past three years, the project has grown in scope and breadth which can translate to complexity. This is especially true for newcomers looking to get their arms wrapped around the key concepts.
+- **Backstage has barriers to adoption:** Backstage adopters tell us driving widespread adoption of their developer portal remains the biggest challenge they face. Adoption barriers can be technical but are often cultural.
+
+The maintainers and some of our most involved community members are actively tackling how we can make the Backstage onboarding process easier for contributors. There are also lots of ways the project could better support adopters on that journey and make adoption faster and smoother.
+
+We’re looking at everything from cleaning up documentation to opinionated catalog ingestors being discussed in both the Catalog and Adoption monthly SIGs (running meeting notes [here](https://docs.google.com/document/d/1xg57CDfX2R5jTGbbWANzifm2szEb664kuTwfEEvKgZU/) and [here](https://docs.google.com/document/d/1zeYSzXYgh897bxPQmwy2btOwCFlEjlUDLf00riySLRc)). A few priorities that we’ve already mapped out:
+
+- Make it easier to install, customize, and maintain Backstage
+- Provide Golden Paths for adoption
+- Improve the experience and the content on [backstage.io](https://backstage.io/docs/overview/what-is-backstage)
+
+Because there are now so many mature adopters — Spotify included — there’s so much knowledge on how to create a roadmap for adoption and use cases, how to roll out your developer portal to your teams and drive inner source contributions, how to measure and attribute developer productivity gains, etc.
+
+Our goal is to tap into the knowledge those adopters have gained and create more tangible resources for the entire community. But we can’t do it without help. And that’s where you come in!
+
+## Getting (more) involved
+
+We’re very grateful for the Backstage ride-or-dies: the contributors who show up to every community session, attend every SIG, and are always ready to jump in on any PR or issue.
+
+But one of the areas where we think the project could greatly improve (and better address some of the growing pains I mentioned above!) is more active contribution — both the total number of people contributing and what they’re contributing.
+
+We’ve already shared a bit on this but the maintainer team is starting to address this challenge by proposing the following three initiatives:
+
+- Introduce more steps in between first-time contributor and maintainer in the form of a contributor ladder (loosely based on the [CNCF Project Template](https://github.com/cncf/project-template/blob/main/CONTRIBUTOR_LADDER.md)).
+- Change the ownership model, for example, divide the project up into several project areas, each covering particular parts of the project.
+- Introduce a new process for large contributions in the form of Backstage Enhancement Proposals (BEPs).
+
+These two RFCs on [Updated Backstage Governance](https://github.com/backstage/backstage/issues/15317) and [Backstage Enhancement Proposals](https://github.com/backstage/backstage/issues/15318) remain open so feel free to read and join the discussion! Watch this space as we’ll share more on the go-forward governance and BEPs plan soon.
+
+But if you’re brand-new and just looking to get your feet wet, we’ve also [compiled some small steps](https://backstage.io/docs/getting-started/getting-involved/) you can take to get involved:
+
+- Report (or squash) bugs: Look through the GitHub issues for [bugs](https://github.com/backstage/backstage/labels/bug), [good first issues](https://github.com/backstage/backstage/labels/good%20first%20issue) or [help wanted](https://github.com/backstage/backstage/labels/help%20wanted)
+- Build or suggest a plugin: The Backstage project grows with every new plugin that gets added
+- Add non-code contributions: We welcome things that help the community at large, but may not fit into the scope of the core project
+- Write documentation or improve the website: The current documentation and project site are pretty limited. Better content helps a lot of those growing pains.
+- Contribute to Storybook: Help us [create new components](https://github.com/backstage/backstage/labels/help%20wanted) or improve stories for the existing ones
+- Submit feedback: The best way to send feedback is to file [an issue](https://github.com/backstage/backstage/issues) with as much detail as possible
+- Add your company to ADOPTERS: Adding your company to [ADOPTERS](https://github.com/backstage/backstage/blob/master/ADOPTERS.md) really helps the project, you can do this by filling out this [adopter form](https://form.typeform.com/to/zcOaKikB)
diff --git a/microsite/blog/assets/2023-03-15/birthday.gif b/microsite/blog/assets/2023-03-15/birthday.gif
new file mode 100644
index 0000000000..0c489bc536
Binary files /dev/null and b/microsite/blog/assets/2023-03-15/birthday.gif differ
diff --git a/microsite/data/plugins/backstage-analytics-module-ga.yaml b/microsite/data/plugins/analytics-module-ga.yaml
similarity index 100%
rename from microsite/data/plugins/backstage-analytics-module-ga.yaml
rename to microsite/data/plugins/analytics-module-ga.yaml
diff --git a/microsite/data/plugins/backstage-plugin-api-linter.yaml b/microsite/data/plugins/api-linter.yaml
similarity index 91%
rename from microsite/data/plugins/backstage-plugin-api-linter.yaml
rename to microsite/data/plugins/api-linter.yaml
index ae2a451ea7..a68da228eb 100644
--- a/microsite/data/plugins/backstage-plugin-api-linter.yaml
+++ b/microsite/data/plugins/api-linter.yaml
@@ -1,5 +1,5 @@
---
-title: backstage-plugin-api-linter
+title: API Linter
author: Zalando
authorUrl: https://github.com/zalando
category: Linting
diff --git a/microsite/data/plugins/aws-codeservices.yaml b/microsite/data/plugins/aws-codeservices.yaml
new file mode 100644
index 0000000000..34fa335923
--- /dev/null
+++ b/microsite/data/plugins/aws-codeservices.yaml
@@ -0,0 +1,10 @@
+---
+title: AWS Code Services
+author: Amazon Web Services
+authorUrl: https://aws.amazon.com/
+category: CI/CD
+description: View resources related to AWS CodePipeline, AWS CodeBuild and AWS CodeDeploy for your components in Backstage.
+documentation: https://github.com/awslabs/aws-codeservices-plugins-for-backstage#readme
+iconUrl: https://github.com/awslabs/aws-codeservices-plugins-for-backstage/blob/main/docs/images/codepipeline-logo.png?raw=true
+npmPackageName: '@aws/aws-codeservices-plugin-for-backstage'
+addedDate: '2023-01-17'
diff --git a/microsite/data/plugins/aws-codesuite.yaml b/microsite/data/plugins/aws-codesuite.yaml
deleted file mode 100644
index d1fd039b9b..0000000000
--- a/microsite/data/plugins/aws-codesuite.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
----
-title: AWS CodeSuite
-author: Amazon Web Services
-authorUrl: https://aws.amazon.com/
-category: CI/CD
-description: View resources related to AWS CodePipeline, AWS CodeBuild and AWS CodeDeploy for your components in Backstage.
-documentation: https://github.com/awslabs/aws-codesuite-plugins-for-backstage#readme
-iconUrl: https://github.com/awslabs/aws-codesuite-plugins-for-backstage/blob/main/docs/images/codepipeline-logo.png?raw=true
-npmPackageName: '@aws/aws-codesuite-plugin-for-backstage'
-addedDate: '2023-01-17'
diff --git a/microsite/data/plugins/cloudsmith.yaml b/microsite/data/plugins/cloudsmith.yaml
index 650f0b253c..4a07318a67 100644
--- a/microsite/data/plugins/cloudsmith.yaml
+++ b/microsite/data/plugins/cloudsmith.yaml
@@ -1,6 +1,6 @@
---
title: Cloudsmith
-author: Roadie
+author: roadie.io
authorUrl: https://roadie.io
category: CI/CD
description: Show Cloudsmith Repository stats, Quota, Audit logs and Security scans for specific repositories.
diff --git a/microsite/data/plugins/github-pull-requests-board.yaml b/microsite/data/plugins/github-pull-requests-board.yaml
index 09776eb468..9fe2570f91 100644
--- a/microsite/data/plugins/github-pull-requests-board.yaml
+++ b/microsite/data/plugins/github-pull-requests-board.yaml
@@ -1,5 +1,5 @@
---
-title: Github Pull Requests Board
+title: GitHub Pull Requests Board
author: DAZN
authorUrl: https://engineering.dazn.com
category: Source Control Mgmt
diff --git a/microsite/data/plugins/backstage-plugin-ldap-auth.yml b/microsite/data/plugins/ldap-auth.yml
similarity index 100%
rename from microsite/data/plugins/backstage-plugin-ldap-auth.yml
rename to microsite/data/plugins/ldap-auth.yml
diff --git a/microsite/data/plugins/microsoft-calendar.yaml b/microsite/data/plugins/microsoft-calendar.yaml
new file mode 100644
index 0000000000..183c991761
--- /dev/null
+++ b/microsite/data/plugins/microsoft-calendar.yaml
@@ -0,0 +1,15 @@
+title: Microsoft Calendar
+author: StatusNeo
+authorUrl: https://statusneo.com/
+category: Productivity
+description: |
+ The plugin integrates with your Microsoft Calendar.
+ It displays all your calendars and events in it.
+documentation: https://github.com/backstage/backstage/tree/master/plugins/microsoft-calendar
+iconUrl: /img/outlook-statusneo.png
+npmPackageName: '@backstage/plugin-microsoft-calendar'
+tags:
+ - Microsoft
+ - calendar
+ - Management
+addedDate: '2023-03-15'
diff --git a/microsite/data/plugins/scaffolder-backend-roadie-aws.yaml b/microsite/data/plugins/scaffolder-backend-roadie-aws.yaml
index e8e67dbdad..65808b9af2 100644
--- a/microsite/data/plugins/scaffolder-backend-roadie-aws.yaml
+++ b/microsite/data/plugins/scaffolder-backend-roadie-aws.yaml
@@ -1,9 +1,9 @@
---
-title: Scaffolder AWS cli actions
+title: Scaffolder AWS CLI actions
author: roadie.io
authorUrl: https://roadie.io/?utm_source=backstage.io&utm_medium=marketplace&utm_campaign=scaffolder-aws
category: Scaffolder
-description: Here you can find some AWS cli actions
+description: Scaffolder actions you can trigger for Amazon Web Services.
documentation: https://github.com/RoadieHQ/roadie-backstage-plugins/blob/main/plugins/scaffolder-actions/scaffolder-backend-module-aws/README.md
iconUrl: https://upload.wikimedia.org/wikipedia/commons/9/93/Amazon_Web_Services_Logo.svg
npmPackageName: '@roadiehq/scaffolder-backend-module-aws'
diff --git a/microsite/data/plugins/statusneo-github-plugin.yaml b/microsite/data/plugins/statusneo-github-plugin.yaml
new file mode 100644
index 0000000000..9c56dd4ae4
--- /dev/null
+++ b/microsite/data/plugins/statusneo-github-plugin.yaml
@@ -0,0 +1,13 @@
+title: Statusneo GitHub Plugin
+author: Statusneo
+authorUrl: https://statusneo.com/
+category: GitHub
+description: Provides status cards GitHub pull requests and GitHub actions.
+documentation: https://github.com/StatusNeo/backstage-plugin-github
+iconUrl: /img/github-statusneo.png
+npmPackageName: '@statusneo/backstage-plugin-github'
+tags:
+ - GitHub
+ - Monitoring
+ - Productivity
+addedDate: '2023-02-15'
diff --git a/microsite/data/plugins/vault.yaml b/microsite/data/plugins/vault.yaml
index 29e20417d8..37d474371b 100644
--- a/microsite/data/plugins/vault.yaml
+++ b/microsite/data/plugins/vault.yaml
@@ -2,7 +2,7 @@
title: Vault
author: Spread Group
authorUrl: https://github.com/ivangonzalezacuna
-category: Vault
+category: Security
description: Visualize a list of the secrets stored in your HashiCorp Vault instance.
documentation: https://github.com/backstage/backstage/tree/master/plugins/vault
iconUrl: /img/vault.png
diff --git a/microsite/docusaurus.config.js b/microsite/docusaurus.config.js
index 025c773a9c..549974a168 100644
--- a/microsite/docusaurus.config.js
+++ b/microsite/docusaurus.config.js
@@ -16,6 +16,11 @@
// @ts-check
+/** @type{import('prism-react-renderer').PrismTheme} **/
+// @ts-ignore
+const prismTheme = require('prism-react-renderer/themes/vsDark');
+prismTheme.plain.backgroundColor = '#232323';
+
/** @type {import('@docusaurus/types').Config} */
module.exports = {
title: 'Backstage Software Catalog and Developer Platform',
@@ -55,7 +60,7 @@ module.exports = {
path: 'blog',
},
theme: {
- customCss: 'src/css/customTheme.css',
+ customCss: 'src/theme/customTheme.scss',
},
gtag: {
trackingID: 'G-KSEVGGNCJW',
@@ -158,7 +163,7 @@ module.exports = {
position: 'left',
},
{
- to: 'docs/releases/v1.11.0',
+ to: 'docs/releases/v1.12.0',
label: 'Releases',
position: 'left',
},
@@ -266,10 +271,11 @@ module.exports = {
searchParameters: {},
},
prism: {
+ theme: prismTheme,
magicComments: [
// Extend the default highlight class name
{
- className: 'theme-code-block-highlighted-line',
+ className: 'code-block-highlight-line',
line: 'highlight-next-line',
block: { start: 'highlight-start', end: 'highlight-end' },
},
diff --git a/microsite/package.json b/microsite/package.json
index cb71d5a25a..09409518ee 100644
--- a/microsite/package.json
+++ b/microsite/package.json
@@ -17,7 +17,7 @@
"docusaurus": "docusaurus"
},
"devDependencies": {
- "@docusaurus/module-type-aliases": "2.3.1",
+ "@docusaurus/module-type-aliases": "2.4.0",
"@spotify/prettier-config": "^14.0.0",
"@tsconfig/docusaurus": "^1.0.6",
"@types/webpack-env": "^1.18.0",
@@ -29,12 +29,13 @@
},
"prettier": "@spotify/prettier-config",
"dependencies": {
- "@docusaurus/core": "2.3.1",
+ "@docusaurus/core": "2.4.0",
"@docusaurus/plugin-client-redirects": "^2.3.1",
- "@docusaurus/preset-classic": "2.3.1",
+ "@docusaurus/preset-classic": "2.4.0",
"@swc/core": "^1.3.36",
"clsx": "^1.1.1",
"docusaurus-plugin-sass": "^0.2.3",
+ "prism-react-renderer": "^1.3.5",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"sass": "^1.57.1",
diff --git a/microsite/sidebars.json b/microsite/sidebars.json
index ebb387f81c..09727685a0 100644
--- a/microsite/sidebars.json
+++ b/microsite/sidebars.json
@@ -1,6 +1,7 @@
{
"releases": {
"Release Notes": [
+ "releases/v1.12.0",
"releases/v1.11.0",
"releases/v1.10.0",
"releases/v1.9.0",
diff --git a/microsite/src/components/bannerSection/bannerSection.module.scss b/microsite/src/components/bannerSection/bannerSection.module.scss
index 2beabf9738..64f4967d11 100644
--- a/microsite/src/components/bannerSection/bannerSection.module.scss
+++ b/microsite/src/components/bannerSection/bannerSection.module.scss
@@ -1,5 +1,41 @@
+@use 'src/theme/variables';
+
.bannerSection {
+ --diagonalBorderHeight: 40px;
+
display: block;
+ background: var(--ifm-background-color);
+
+ @media (min-width: variables.$desktopUpBreakpoint) {
+ --diagonalBorderHeight: 80px;
+ }
+
+ &:global(:is(.diagonalBorder, .diagonalBottomBorder)) {
+ padding-bottom: var(--diagonalBorderHeight);
+
+ & + section {
+ margin-top: calc(var(--diagonalBorderHeight) * -1);
+ padding-top: var(--diagonalBorderHeight);
+ }
+ }
+
+ &:global(.diagonalBorder) {
+ clip-path: polygon(
+ 0 var(--diagonalBorderHeight),
+ 100% 0,
+ 100% calc(100% - var(--diagonalBorderHeight)),
+ 0 100%
+ );
+ }
+
+ &:global(.diagonalBottomBorder) {
+ clip-path: polygon(
+ 0 0,
+ 100% 0,
+ 100% calc(100% - var(--diagonalBorderHeight)),
+ 0 100%
+ );
+ }
&:global(.greyBackground) {
background: linear-gradient(90.49deg, #121212 15.36%, #282828 70.44%);
diff --git a/microsite/src/components/bannerSection/bannerSection.tsx b/microsite/src/components/bannerSection/bannerSection.tsx
index 64c8d246c8..5dc99eecf0 100644
--- a/microsite/src/components/bannerSection/bannerSection.tsx
+++ b/microsite/src/components/bannerSection/bannerSection.tsx
@@ -6,6 +6,8 @@ import bannerStyles from './bannerSection.module.scss';
export type IBannerSectionProps = PropsWithChildren<{
className?: string;
greyBackground?: boolean;
+ diagonalBorder?: boolean;
+ diagonalBottomBorder?: boolean;
greenGradientBackground?: boolean;
greenBottomGradientBackground?: boolean;
greenCallToActionGradientBackground?: boolean;
@@ -15,6 +17,8 @@ export const BannerSection = ({
children,
className,
greyBackground = false,
+ diagonalBorder = false,
+ diagonalBottomBorder = false,
greenGradientBackground = false,
greenBottomGradientBackground = false,
greenCallToActionGradientBackground = false,
@@ -22,6 +26,8 @@ export const BannerSection = ({
-
+
{
-
+
@@ -199,7 +199,7 @@ const Community = () => {
-
+
Community initiatives}
>
@@ -223,7 +223,7 @@ const Community = () => {
-
+
Trainings and Certifications
diff --git a/microsite/src/pages/demos/index.tsx b/microsite/src/pages/demos/index.tsx
index 2ca77e5c89..1221c38a63 100644
--- a/microsite/src/pages/demos/index.tsx
+++ b/microsite/src/pages/demos/index.tsx
@@ -167,6 +167,8 @@ const Demos = () => {
{demoItems.map((demoItem, index) => (
0 && index < demoItems.length - 1}
greyBackground={index % 2 === 0}
className={demosStyles.banner}
>
diff --git a/microsite/src/pages/getting-involved/index.tsx b/microsite/src/pages/getting-involved/index.tsx
new file mode 100644
index 0000000000..d838f5d25b
--- /dev/null
+++ b/microsite/src/pages/getting-involved/index.tsx
@@ -0,0 +1,6 @@
+import React from 'react';
+import { Redirect } from '@docusaurus/router';
+
+export default () => {
+ return
-
+
{
-
+
{
-
+
![]()
{
-
+
-
+
![]()
{
-
+
-
+
![]()
{
-
+
-
+
![]()
{
-
+
-
+
{
-
+
-
+
![]()
{
-
+
- entity?.metadata?.tags?.includes('recommended') ?? false,
- },
- ]}
- />
- }
- >
-
-
-
-
-
-
- entity?.metadata?.tags?.includes('recommended') ?? false,
- },
- ]}
- />
- }
- >
-
-
-
-
-
+
+
+ entity?.metadata?.tags?.includes('recommended') ?? false,
+ },
+ ]}
+ />
+ }
+ >
+
+
+
+
+
+
+
+
+ entity?.metadata?.tags?.includes('recommended') ?? false,
+ },
+ ]}
+ />
+ }
+ >
+
+
+
+
+
+
) => (
Promise.resolve({ results: [] }) }],
diff --git a/packages/backend-app-api/CHANGELOG.md b/packages/backend-app-api/CHANGELOG.md
index 6ea78e983f..ed9deb5037 100644
--- a/packages/backend-app-api/CHANGELOG.md
+++ b/packages/backend-app-api/CHANGELOG.md
@@ -1,5 +1,41 @@
# @backstage/backend-app-api
+## 0.4.2-next.0
+
+### Patch Changes
+
+- 8cce2205a39: Register unhandled rejection and uncaught exception handlers to avoid backend crashes.
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/cli-common@0.1.12
+ - @backstage/config-loader@1.1.9
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+ - @backstage/plugin-auth-node@0.2.13-next.0
+ - @backstage/plugin-permission-node@0.7.7-next.0
+
+## 0.4.1
+
+### Patch Changes
+
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 482dae5de1c: Updated link to docs.
+- 915e46622cf: Add support for `NotImplementedError`, properly returning 501 as status code.
+- Updated dependencies
+ - @backstage/plugin-permission-node@0.7.6
+ - @backstage/plugin-auth-node@0.2.12
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/config-loader@1.1.9
+ - @backstage/cli-common@0.1.12
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.4.1-next.2
### Patch Changes
diff --git a/packages/backend-app-api/package.json b/packages/backend-app-api/package.json
index f59e39ef09..dda56af96c 100644
--- a/packages/backend-app-api/package.json
+++ b/packages/backend-app-api/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/backend-app-api",
"description": "Core API used by Backstage backend apps",
- "version": "0.4.1-next.2",
+ "version": "0.4.2-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
diff --git a/packages/backend-app-api/src/wiring/BackendInitializer.ts b/packages/backend-app-api/src/wiring/BackendInitializer.ts
index 2a8fa1e720..b2c62c2122 100644
--- a/packages/backend-app-api/src/wiring/BackendInitializer.ts
+++ b/packages/backend-app-api/src/wiring/BackendInitializer.ts
@@ -165,6 +165,25 @@ export class BackendInitializer {
);
await registerInit.init.func(deps);
}
+
+ // Once the backend is started, any uncaught errors or unhandled rejections are caught
+ // and logged, in order to avoid crashing the entire backend on local failures.
+ if (process.env.NODE_ENV !== 'test') {
+ const rootLogger = await this.#serviceHolder.get(
+ coreServices.rootLogger,
+ 'root',
+ );
+ process.on('unhandledRejection', (reason: Error) => {
+ rootLogger
+ ?.child({ type: 'unhandledRejection' })
+ ?.error('Unhandled rejection', reason);
+ });
+ process.on('uncaughtException', error => {
+ rootLogger
+ ?.child({ type: 'uncaughtException' })
+ ?.error('Uncaught exception', error);
+ });
+ }
}
#resolveInitOrder(registerInits: Array) {
diff --git a/packages/backend-common/CHANGELOG.md b/packages/backend-common/CHANGELOG.md
index 06968a3c8a..3ec4fe5837 100644
--- a/packages/backend-common/CHANGELOG.md
+++ b/packages/backend-common/CHANGELOG.md
@@ -1,5 +1,59 @@
# @backstage/backend-common
+## 0.18.4-next.0
+
+### Patch Changes
+
+- 420164593cf: Improve GitlabUrlReader to only load requested sub-path
+- Updated dependencies
+ - @backstage/backend-app-api@0.4.2-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/integration-aws-node@0.1.2
+ - @backstage/backend-dev-utils@0.1.1
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/cli-common@0.1.12
+ - @backstage/config-loader@1.1.9
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+
+## 0.18.3
+
+### Patch Changes
+
+- f75097868a7: Adds config option `backend.database.role` to set ownership for newly created schemas and tables in Postgres
+
+ The example config below connects to the database as user `v-backstage-123` but sets the ownership of
+ the create schemas and tables to `backstage`
+
+ ```yaml
+ backend:
+ database:
+ client: pg
+ pluginDivisionMode: schema
+ role: backstage
+ connection:
+ user: v-backstage-123
+ ...
+ ```
+
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- 87f0bbec175: AwsS3UrlReader upgraded to use aws-sdk v3
+- c1ee073a82b: Added `lastModifiedAt` field on `UrlReaderService` responses and a `lastModifiedAfter` option to `UrlReaderService.readUrl`.
+- 482dae5de1c: Updated link to docs.
+- Updated dependencies
+ - @backstage/errors@1.1.5
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/backend-app-api@0.4.1
+ - @backstage/config-loader@1.1.9
+ - @backstage/integration@1.4.3
+ - @backstage/backend-dev-utils@0.1.1
+ - @backstage/cli-common@0.1.12
+ - @backstage/config@1.0.7
+ - @backstage/integration-aws-node@0.1.2
+ - @backstage/types@1.0.2
+
## 0.18.3-next.2
### Patch Changes
diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md
index ebdd7315c9..f1d8a74dbe 100644
--- a/packages/backend-common/api-report.md
+++ b/packages/backend-common/api-report.md
@@ -301,6 +301,7 @@ export class FetchUrlReader implements UrlReader {
export type FromReadableArrayOptions = Array<{
data: Readable;
path: string;
+ lastModifiedAt?: Date;
}>;
// @public
@@ -635,6 +636,7 @@ export class ReadUrlResponseFactory {
// @public
export type ReadUrlResponseFactoryFromStreamOptions = {
etag?: string;
+ lastModifiedAt?: Date;
};
// @public
diff --git a/packages/backend-common/package.json b/packages/backend-common/package.json
index beee72c860..3f96d5f4ce 100644
--- a/packages/backend-common/package.json
+++ b/packages/backend-common/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/backend-common",
"description": "Common functionality library for Backstage backends",
- "version": "0.18.3-next.2",
+ "version": "0.18.4-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
diff --git a/packages/backend-common/src/reading/AwsS3UrlReader.test.ts b/packages/backend-common/src/reading/AwsS3UrlReader.test.ts
index 0bd4d2636f..b37a052c1d 100644
--- a/packages/backend-common/src/reading/AwsS3UrlReader.test.ts
+++ b/packages/backend-common/src/reading/AwsS3UrlReader.test.ts
@@ -297,23 +297,26 @@ describe('AwsS3UrlReader', () => {
),
),
ETag: '123abc',
+ LastModified: new Date('2020-01-01T00:00:00Z'),
});
});
it('returns contents of an object in a bucket via buffer', async () => {
- const { buffer, etag } = await reader.readUrl(
+ const { buffer, etag, lastModifiedAt } = await reader.readUrl(
'https://test-bucket.s3.us-east-2.amazonaws.com/awsS3-mock-object.yaml',
);
expect(etag).toBe('123abc');
+ expect(lastModifiedAt).toEqual(new Date('2020-01-01T00:00:00Z'));
const response = await buffer();
expect(response.toString().trim()).toBe('site_name: Test');
});
it('returns contents of an object in a bucket via stream', async () => {
- const { buffer, etag } = await reader.readUrl(
+ const { buffer, etag, lastModifiedAt } = await reader.readUrl(
'https://test-bucket.s3.us-east-2.amazonaws.com/awsS3-mock-object.yaml',
);
expect(etag).toBe('123abc');
+ expect(lastModifiedAt).toEqual(new Date('2020-01-01T00:00:00Z'));
const response = await buffer();
expect(response.toString().trim()).toBe('site_name: Test');
});
@@ -403,6 +406,41 @@ describe('AwsS3UrlReader', () => {
});
});
+ describe('readUrl with lastModifiedAfter', () => {
+ const [{ reader }] = createReader({
+ integrations: {
+ awsS3: [
+ {
+ host: 'amazonaws.com',
+ accessKeyId: 'fake-access-key',
+ secretAccessKey: 'fake-secret-key',
+ },
+ ],
+ },
+ });
+
+ beforeEach(() => {
+ s3Client.reset();
+ const t = new S3ServiceException({
+ name: '304',
+ $fault: 'client',
+ $metadata: { httpStatusCode: 304 },
+ });
+ s3Client.on(GetObjectCommand).rejects(t);
+ });
+
+ it('returns contents of an object in a bucket', async () => {
+ await expect(
+ reader.readUrl!(
+ 'https://test-bucket.s3.us-east-2.amazonaws.com/awsS3-mock-object.yaml',
+ {
+ lastModifiedAfter: new Date('2020-01-01T00:00:00Z'),
+ },
+ ),
+ ).rejects.toThrow(NotModifiedError);
+ });
+ });
+
describe('readTree', () => {
let awsS3UrlReader: AwsS3UrlReader;
diff --git a/packages/backend-common/src/reading/AwsS3UrlReader.ts b/packages/backend-common/src/reading/AwsS3UrlReader.ts
index d06e2d0ad6..4d4c28071f 100644
--- a/packages/backend-common/src/reading/AwsS3UrlReader.ts
+++ b/packages/backend-common/src/reading/AwsS3UrlReader.ts
@@ -41,6 +41,7 @@ import {
ListObjectsV2Command,
ListObjectsV2CommandOutput,
GetObjectCommand,
+ GetObjectCommandInput,
} from '@aws-sdk/client-s3';
import { AbortController } from '@aws-sdk/abort-controller';
import { ReadUrlResponseFactory } from './ReadUrlResponseFactory';
@@ -253,6 +254,8 @@ export class AwsS3UrlReader implements UrlReader {
url: string,
options?: ReadUrlOptions,
): Promise {
+ const { etag, lastModifiedAfter } = options ?? {};
+
try {
const { path, bucket, region } = parseUrl(url, this.integration.config);
const s3Client = await this.buildS3Client(
@@ -262,19 +265,15 @@ export class AwsS3UrlReader implements UrlReader {
);
const abortController = new AbortController();
- let params;
- if (options?.etag) {
- params = {
- Bucket: bucket,
- Key: path,
- IfNoneMatch: options.etag,
- };
- } else {
- params = {
- Bucket: bucket,
- Key: path,
- };
- }
+ const params: GetObjectCommandInput = {
+ Bucket: bucket,
+ Key: path,
+ ...(etag && { IfNoneMatch: etag }),
+ ...(lastModifiedAfter && {
+ IfModifiedSince: lastModifiedAfter,
+ }),
+ };
+
options?.signal?.addEventListener('abort', () => abortController.abort());
const getObjectCommand = new GetObjectCommand(params);
const response = await s3Client.send(getObjectCommand, {
@@ -284,10 +283,10 @@ export class AwsS3UrlReader implements UrlReader {
const s3ObjectData = await this.retrieveS3ObjectData(
response.Body as Readable,
);
- const etag = response.ETag;
return ReadUrlResponseFactory.fromReadable(s3ObjectData, {
- etag: etag,
+ etag: response.ETag,
+ lastModifiedAt: response.LastModified,
});
} catch (e) {
if (e.$metadata && e.$metadata.httpStatusCode === 304) {
@@ -347,6 +346,7 @@ export class AwsS3UrlReader implements UrlReader {
responses.push({
data: s3ObjectData,
path: String(allObjects[i]),
+ lastModifiedAt: response?.LastModified ?? undefined,
});
}
diff --git a/packages/backend-common/src/reading/AzureUrlReader.ts b/packages/backend-common/src/reading/AzureUrlReader.ts
index 08e3917b38..90cf8f29bd 100644
--- a/packages/backend-common/src/reading/AzureUrlReader.ts
+++ b/packages/backend-common/src/reading/AzureUrlReader.ts
@@ -192,6 +192,7 @@ export class AzureUrlReader implements UrlReader {
base: url,
}),
content: file.content,
+ lastModifiedAt: file.lastModifiedAt,
})),
};
}
diff --git a/packages/backend-common/src/reading/BitbucketCloudUrlReader.test.ts b/packages/backend-common/src/reading/BitbucketCloudUrlReader.test.ts
index ca6e15a005..c00aeba124 100644
--- a/packages/backend-common/src/reading/BitbucketCloudUrlReader.test.ts
+++ b/packages/backend-common/src/reading/BitbucketCloudUrlReader.test.ts
@@ -156,6 +156,83 @@ describe('BitbucketCloudUrlReader', () => {
expect(buffer.toString()).toBe('foo');
expect(result.etag).toBe('new-etag-value');
});
+
+ it('should be able to readUrl via buffer without If-Modified-Since', async () => {
+ worker.use(
+ rest.get(
+ 'https://api.bitbucket.org/2.0/repositories/backstage-verification/test-template/src/master/template.yaml',
+ (req, res, ctx) => {
+ expect(req.headers.get('If-None-Match')).toBeNull();
+ return res(
+ ctx.status(200),
+ ctx.body('foo'),
+ ctx.set('ETag', 'etag-value'),
+ ctx.set(
+ 'Last-Modified',
+ new Date('2020-01-01T00:00:00Z').toUTCString(),
+ ),
+ );
+ },
+ ),
+ );
+
+ const result = await reader.readUrl(
+ 'https://bitbucket.org/backstage-verification/test-template/src/master/template.yaml',
+ );
+ const buffer = await result.buffer();
+ expect(result.lastModifiedAt).toEqual(new Date('2020-01-01T00:00:00Z'));
+ expect(buffer.toString()).toBe('foo');
+ });
+
+ it('should be throw not modified when If-Modified-Since returns a 304', async () => {
+ worker.use(
+ rest.get(
+ 'https://api.bitbucket.org/2.0/repositories/backstage-verification/test-template/src/master/template.yaml',
+ (req, res, ctx) => {
+ expect(req.headers.get('If-Modified-Since')).toBe(
+ new Date('1999 12 31 23:59:59 GMT').toUTCString(),
+ );
+ return res(ctx.status(304));
+ },
+ ),
+ );
+
+ await expect(
+ reader.readUrl(
+ 'https://bitbucket.org/backstage-verification/test-template/src/master/template.yaml',
+ { lastModifiedAfter: new Date('1999 12 31 23:59:59 GMT') },
+ ),
+ ).rejects.toThrow(NotModifiedError);
+ });
+
+ it('should be able to readUrl when If-Modified-Since is before Last-Modified', async () => {
+ worker.use(
+ rest.get(
+ 'https://api.bitbucket.org/2.0/repositories/backstage-verification/test-template/src/master/template.yaml',
+ (req, res, ctx) => {
+ expect(req.headers.get('If-Modified-Since')).toBe(
+ new Date('1999 12 31 23:59:59 GMT').toUTCString(),
+ );
+ return res(
+ ctx.status(200),
+ ctx.set(
+ 'Last-Modified',
+ new Date('2020-01-01T00:00:00Z').toUTCString(),
+ ),
+ ctx.body('foo'),
+ );
+ },
+ ),
+ );
+
+ const result = await reader.readUrl(
+ 'https://bitbucket.org/backstage-verification/test-template/src/master/template.yaml',
+ { lastModifiedAfter: new Date('1999 12 31 23:59:59 GMT') },
+ );
+ const buffer = await result.buffer();
+ expect(buffer.toString()).toBe('foo');
+ expect(result.lastModifiedAt).toEqual(new Date('2020-01-01T00:00:00Z'));
+ });
});
describe('read', () => {
diff --git a/packages/backend-common/src/reading/BitbucketCloudUrlReader.ts b/packages/backend-common/src/reading/BitbucketCloudUrlReader.ts
index b83e012423..1522b7678d 100644
--- a/packages/backend-common/src/reading/BitbucketCloudUrlReader.ts
+++ b/packages/backend-common/src/reading/BitbucketCloudUrlReader.ts
@@ -40,6 +40,7 @@ import {
UrlReader,
} from './types';
import { ReadUrlResponseFactory } from './ReadUrlResponseFactory';
+import { parseLastModified } from './util';
/**
* Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for files from Bitbucket Cloud.
@@ -80,7 +81,7 @@ export class BitbucketCloudUrlReader implements UrlReader {
url: string,
options?: ReadUrlOptions,
): Promise {
- const { etag, signal } = options ?? {};
+ const { etag, lastModifiedAfter, signal } = options ?? {};
const bitbucketUrl = getBitbucketCloudFileFetchUrl(
url,
this.integration.config,
@@ -95,6 +96,9 @@ export class BitbucketCloudUrlReader implements UrlReader {
headers: {
...requestOptions.headers,
...(etag && { 'If-None-Match': etag }),
+ ...(lastModifiedAfter && {
+ 'If-Modified-Since': lastModifiedAfter.toUTCString(),
+ }),
},
// TODO(freben): The signal cast is there because pre-3.x versions of
// node-fetch have a very slightly deviating AbortSignal type signature.
@@ -115,6 +119,9 @@ export class BitbucketCloudUrlReader implements UrlReader {
if (response.ok) {
return ReadUrlResponseFactory.fromNodeJSReadable(response.body, {
etag: response.headers.get('ETag') ?? undefined,
+ lastModifiedAt: parseLastModified(
+ response.headers.get('Last-Modified'),
+ ),
});
}
@@ -184,6 +191,7 @@ export class BitbucketCloudUrlReader implements UrlReader {
base: url,
}),
content: file.content,
+ lastModifiedAt: file.lastModifiedAt,
})),
};
}
diff --git a/packages/backend-common/src/reading/BitbucketServerUrlReader.ts b/packages/backend-common/src/reading/BitbucketServerUrlReader.ts
index a97c3b39bb..2b6b5a1f8f 100644
--- a/packages/backend-common/src/reading/BitbucketServerUrlReader.ts
+++ b/packages/backend-common/src/reading/BitbucketServerUrlReader.ts
@@ -39,6 +39,7 @@ import {
UrlReader,
} from './types';
import { ReadUrlResponseFactory } from './ReadUrlResponseFactory';
+import { parseLastModified } from './util';
/**
* Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for files from Bitbucket Server APIs.
@@ -71,7 +72,7 @@ export class BitbucketServerUrlReader implements UrlReader {
url: string,
options?: ReadUrlOptions,
): Promise {
- const { etag, signal } = options ?? {};
+ const { etag, lastModifiedAfter, signal } = options ?? {};
const bitbucketUrl = getBitbucketServerFileFetchUrl(
url,
this.integration.config,
@@ -86,6 +87,9 @@ export class BitbucketServerUrlReader implements UrlReader {
headers: {
...requestOptions.headers,
...(etag && { 'If-None-Match': etag }),
+ ...(lastModifiedAfter && {
+ 'If-Modified-Since': lastModifiedAfter.toUTCString(),
+ }),
},
// TODO(freben): The signal cast is there because pre-3.x versions of
// node-fetch have a very slightly deviating AbortSignal type signature.
@@ -106,6 +110,9 @@ export class BitbucketServerUrlReader implements UrlReader {
if (response.ok) {
return ReadUrlResponseFactory.fromNodeJSReadable(response.body, {
etag: response.headers.get('ETag') ?? undefined,
+ lastModifiedAt: parseLastModified(
+ response.headers.get('Last-Modified'),
+ ),
});
}
@@ -175,6 +182,7 @@ export class BitbucketServerUrlReader implements UrlReader {
base: url,
}),
content: file.content,
+ lastModifiedAt: file.lastModifiedAt,
})),
};
}
diff --git a/packages/backend-common/src/reading/BitbucketUrlReader.test.ts b/packages/backend-common/src/reading/BitbucketUrlReader.test.ts
index 922480f8e7..15e007d516 100644
--- a/packages/backend-common/src/reading/BitbucketUrlReader.test.ts
+++ b/packages/backend-common/src/reading/BitbucketUrlReader.test.ts
@@ -204,6 +204,83 @@ describe('BitbucketUrlReader', () => {
expect(buffer.toString()).toBe('foo');
expect(result.etag).toBe('new-etag-value');
});
+
+ it('should be able to readUrl via buffer without If-Modified-Since', async () => {
+ worker.use(
+ rest.get(
+ 'https://api.bitbucket.org/2.0/repositories/backstage-verification/test-template/src/master/template.yaml',
+ (req, res, ctx) => {
+ expect(req.headers.get('If-None-Match')).toBeNull();
+ return res(
+ ctx.status(200),
+ ctx.body('foo'),
+ ctx.set('ETag', 'etag-value'),
+ ctx.set(
+ 'Last-Modified',
+ new Date('2020-01-01T00:00:00Z').toUTCString(),
+ ),
+ );
+ },
+ ),
+ );
+
+ const result = await bitbucketProcessor.readUrl(
+ 'https://bitbucket.org/backstage-verification/test-template/src/master/template.yaml',
+ );
+ const buffer = await result.buffer();
+ expect(result.lastModifiedAt).toEqual(new Date('2020-01-01T00:00:00Z'));
+ expect(buffer.toString()).toBe('foo');
+ });
+
+ it('should be throw not modified when If-Modified-Since returns a 304', async () => {
+ worker.use(
+ rest.get(
+ 'https://api.bitbucket.org/2.0/repositories/backstage-verification/test-template/src/master/template.yaml',
+ (req, res, ctx) => {
+ expect(req.headers.get('If-Modified-Since')).toBe(
+ new Date('1999 12 31 23:59:59 GMT').toUTCString(),
+ );
+ return res(ctx.status(304));
+ },
+ ),
+ );
+
+ await expect(
+ bitbucketProcessor.readUrl(
+ 'https://bitbucket.org/backstage-verification/test-template/src/master/template.yaml',
+ { lastModifiedAfter: new Date('1999 12 31 23:59:59 GMT') },
+ ),
+ ).rejects.toThrow(NotModifiedError);
+ });
+
+ it('should be able to readUrl when If-Modified-Since is before Last-Modified', async () => {
+ worker.use(
+ rest.get(
+ 'https://api.bitbucket.org/2.0/repositories/backstage-verification/test-template/src/master/template.yaml',
+ (req, res, ctx) => {
+ expect(req.headers.get('If-Modified-Since')).toBe(
+ new Date('1999 12 31 23:59:59 GMT').toUTCString(),
+ );
+ return res(
+ ctx.status(200),
+ ctx.set(
+ 'Last-Modified',
+ new Date('2020-01-01T00:00:00Z').toUTCString(),
+ ),
+ ctx.body('foo'),
+ );
+ },
+ ),
+ );
+
+ const result = await bitbucketProcessor.readUrl(
+ 'https://bitbucket.org/backstage-verification/test-template/src/master/template.yaml',
+ { lastModifiedAfter: new Date('1999 12 31 23:59:59 GMT') },
+ );
+ const buffer = await result.buffer();
+ expect(buffer.toString()).toBe('foo');
+ expect(result.lastModifiedAt).toEqual(new Date('2020-01-01T00:00:00Z'));
+ });
});
describe('read', () => {
diff --git a/packages/backend-common/src/reading/BitbucketUrlReader.ts b/packages/backend-common/src/reading/BitbucketUrlReader.ts
index 01539594dd..3a34c725c6 100644
--- a/packages/backend-common/src/reading/BitbucketUrlReader.ts
+++ b/packages/backend-common/src/reading/BitbucketUrlReader.ts
@@ -41,6 +41,7 @@ import {
UrlReader,
} from './types';
import { ReadUrlResponseFactory } from './ReadUrlResponseFactory';
+import { parseLastModified } from './util';
/**
* Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for files from Bitbucket v1 and v2 APIs, such
@@ -96,7 +97,7 @@ export class BitbucketUrlReader implements UrlReader {
url: string,
options?: ReadUrlOptions,
): Promise {
- const { etag, signal } = options ?? {};
+ const { etag, lastModifiedAfter, signal } = options ?? {};
const bitbucketUrl = getBitbucketFileFetchUrl(url, this.integration.config);
const requestOptions = getBitbucketRequestOptions(this.integration.config);
@@ -106,6 +107,9 @@ export class BitbucketUrlReader implements UrlReader {
headers: {
...requestOptions.headers,
...(etag && { 'If-None-Match': etag }),
+ ...(lastModifiedAfter && {
+ 'If-Modified-Since': lastModifiedAfter.toUTCString(),
+ }),
},
// TODO(freben): The signal cast is there because pre-3.x versions of
// node-fetch have a very slightly deviating AbortSignal type signature.
@@ -126,6 +130,9 @@ export class BitbucketUrlReader implements UrlReader {
if (response.ok) {
return ReadUrlResponseFactory.fromNodeJSReadable(response.body, {
etag: response.headers.get('ETag') ?? undefined,
+ lastModifiedAt: parseLastModified(
+ response.headers.get('Last-Modified'),
+ ),
});
}
@@ -195,6 +202,7 @@ export class BitbucketUrlReader implements UrlReader {
base: url,
}),
content: file.content,
+ lastModifiedAt: file.lastModifiedAt,
})),
};
}
diff --git a/packages/backend-common/src/reading/FetchUrlReader.test.ts b/packages/backend-common/src/reading/FetchUrlReader.test.ts
index e45117a106..ad834c64ef 100644
--- a/packages/backend-common/src/reading/FetchUrlReader.test.ts
+++ b/packages/backend-common/src/reading/FetchUrlReader.test.ts
@@ -45,6 +45,21 @@ describe('FetchUrlReader', () => {
);
}
+ if (
+ req.headers.get('if-modified-since') &&
+ new Date(req.headers.get('if-modified-since') ?? '') <
+ new Date('2021-01-01T00:00:00Z')
+ ) {
+ return res(
+ ctx.status(304),
+ ctx.set('Content-Type', 'text/plain'),
+ ctx.set(
+ 'last-modified',
+ new Date('2021-01-01T00:00:00Z').toUTCString(),
+ ),
+ );
+ }
+
return res(
ctx.status(200),
ctx.set('Content-Type', 'text/plain'),
@@ -192,7 +207,7 @@ describe('FetchUrlReader', () => {
});
describe('readUrl', () => {
- it('should throw NotModified if server responds with 304', async () => {
+ it('should throw NotModified if server responds with 304 from etag', async () => {
await expect(
fetchUrlReader.readUrl('https://backstage.io/some-resource', {
etag: 'foo',
@@ -200,6 +215,14 @@ describe('FetchUrlReader', () => {
).rejects.toThrow(NotModifiedError);
});
+ it('should throw NotModified if server responds with 304 from lastModifiedAfter', async () => {
+ await expect(
+ fetchUrlReader.readUrl('https://backstage.io/some-resource', {
+ lastModifiedAfter: new Date('2020-01-01T00:00:00Z'),
+ }),
+ ).rejects.toThrow(NotModifiedError);
+ });
+
it('should return etag from the response', async () => {
const response = await fetchUrlReader.readUrl(
'https://backstage.io/some-resource',
diff --git a/packages/backend-common/src/reading/FetchUrlReader.ts b/packages/backend-common/src/reading/FetchUrlReader.ts
index 20b78d63c3..90c1cf6c26 100644
--- a/packages/backend-common/src/reading/FetchUrlReader.ts
+++ b/packages/backend-common/src/reading/FetchUrlReader.ts
@@ -26,6 +26,7 @@ import {
} from './types';
import path from 'path';
import { ReadUrlResponseFactory } from './ReadUrlResponseFactory';
+import { parseLastModified } from './util';
const isInRange = (num: number, [start, end]: [number, number]) => {
return num >= start && num <= end;
@@ -127,6 +128,9 @@ export class FetchUrlReader implements UrlReader {
response = await fetch(url, {
headers: {
...(options?.etag && { 'If-None-Match': options.etag }),
+ ...(options?.lastModifiedAfter && {
+ 'If-Modified-Since': options.lastModifiedAfter.toUTCString(),
+ }),
},
// TODO(freben): The signal cast is there because pre-3.x versions of
// node-fetch have a very slightly deviating AbortSignal type signature.
@@ -147,6 +151,9 @@ export class FetchUrlReader implements UrlReader {
if (response.ok) {
return ReadUrlResponseFactory.fromNodeJSReadable(response.body, {
etag: response.headers.get('ETag') ?? undefined,
+ lastModifiedAt: parseLastModified(
+ response.headers.get('Last-Modified'),
+ ),
});
}
diff --git a/packages/backend-common/src/reading/GiteaUrlReader.test.ts b/packages/backend-common/src/reading/GiteaUrlReader.test.ts
index 6c8722d2e5..1860d9f461 100644
--- a/packages/backend-common/src/reading/GiteaUrlReader.test.ts
+++ b/packages/backend-common/src/reading/GiteaUrlReader.test.ts
@@ -25,7 +25,7 @@ import { UrlReaderPredicateTuple } from './types';
import { DefaultReadTreeResponseFactory } from './tree';
import getRawBody from 'raw-body';
import { GiteaUrlReader } from './GiteaUrlReader';
-import { NotFoundError } from '@backstage/errors';
+import { NotFoundError, NotModifiedError } from '@backstage/errors';
const treeResponseFactory = DefaultReadTreeResponseFactory.create({
config: new ConfigReader({}),
@@ -200,5 +200,51 @@ describe('GiteaUrlReader', () => {
'https://gitea.com/owner/project/src/branch/branch2/LICENSE could not be read as https://gitea.com/api/v1/repos/owner/project/contents/LICENSE?ref=branch2, 500 Error!!!',
);
});
+
+ it('should throw NotModified if server responds with 304 from etag', async () => {
+ worker.use(
+ rest.get(
+ 'https://gitea.com/api/v1/repos/owner/project/contents/LICENSE',
+ (_, res, ctx) => {
+ return res(ctx.set('ETag', 'foo'), ctx.status(304, 'Error!!!'));
+ },
+ ),
+ );
+
+ await expect(
+ giteaProcessor.readUrl(
+ 'https://gitea.com/owner/project/src/branch/branch2/LICENSE',
+ {
+ etag: 'foo',
+ },
+ ),
+ ).rejects.toThrow(NotModifiedError);
+ });
+
+ it('should throw NotModified if server responds with 304 from lastModifiedAfter', async () => {
+ worker.use(
+ rest.get(
+ 'https://gitea.com/api/v1/repos/owner/project/contents/LICENSE',
+ (_, res, ctx) => {
+ return res(
+ ctx.set(
+ 'Last-Modified',
+ new Date('2020-01-01T00:00:00Z').toUTCString(),
+ ),
+ ctx.status(304, 'Error!!!'),
+ );
+ },
+ ),
+ );
+
+ await expect(
+ giteaProcessor.readUrl(
+ 'https://gitea.com/owner/project/src/branch/branch2/LICENSE',
+ {
+ lastModifiedAfter: new Date('2020-01-01T00:00:00Z'),
+ },
+ ),
+ ).rejects.toThrow(NotModifiedError);
+ });
});
});
diff --git a/packages/backend-common/src/reading/GiteaUrlReader.ts b/packages/backend-common/src/reading/GiteaUrlReader.ts
index 1471bab608..34542e878e 100644
--- a/packages/backend-common/src/reading/GiteaUrlReader.ts
+++ b/packages/backend-common/src/reading/GiteaUrlReader.ts
@@ -34,6 +34,7 @@ import {
NotModifiedError,
} from '@backstage/errors';
import { Readable } from 'stream';
+import { parseLastModified } from './util';
/**
* Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for the Gitea v1 api.
@@ -86,6 +87,9 @@ export class GiteaUrlReader implements UrlReader {
Readable.from(Buffer.from(content, 'base64')),
{
etag: response.headers.get('ETag') ?? undefined,
+ lastModifiedAt: parseLastModified(
+ response.headers.get('Last-Modified'),
+ ),
},
);
}
diff --git a/packages/backend-common/src/reading/GithubUrlReader.test.ts b/packages/backend-common/src/reading/GithubUrlReader.test.ts
index 2315d1f9e8..1ee25920f2 100644
--- a/packages/backend-common/src/reading/GithubUrlReader.test.ts
+++ b/packages/backend-common/src/reading/GithubUrlReader.test.ts
@@ -247,7 +247,7 @@ describe('GithubUrlReader', () => {
).rejects.toThrow(/rate limit exceeded/);
});
- it('should return etag from the response', async () => {
+ it('should return etag and last-modified from the response', async () => {
(mockCredentialsProvider.getCredentials as jest.Mock).mockResolvedValue({
headers: {
Authorization: 'bearer blah',
@@ -261,6 +261,11 @@ describe('GithubUrlReader', () => {
return res(
ctx.status(200),
ctx.set('Etag', 'foo'),
+ ctx.set(
+ 'Last-Modified',
+ new Date('2021-01-01T00:00:00Z').toUTCString(),
+ ),
+
ctx.body('bar'),
);
},
@@ -271,6 +276,7 @@ describe('GithubUrlReader', () => {
'https://github.com/backstage/mock/tree/blob/main',
);
expect(response.etag).toBe('foo');
+ expect(response.lastModifiedAt).toEqual(new Date('2021-01-01T00:00:00Z'));
});
});
diff --git a/packages/backend-common/src/reading/GithubUrlReader.ts b/packages/backend-common/src/reading/GithubUrlReader.ts
index d91c35621d..ee781daf0b 100644
--- a/packages/backend-common/src/reading/GithubUrlReader.ts
+++ b/packages/backend-common/src/reading/GithubUrlReader.ts
@@ -40,6 +40,7 @@ import {
ReadUrlResponse,
} from './types';
import { ReadUrlResponseFactory } from './ReadUrlResponseFactory';
+import { parseLastModified } from './util';
export type GhRepoResponse =
RestEndpointMethodTypes['repos']['get']['response']['data'];
@@ -109,6 +110,9 @@ export class GithubUrlReader implements UrlReader {
headers: {
...credentials?.headers,
...(options?.etag && { 'If-None-Match': options.etag }),
+ ...(options?.lastModifiedAfter && {
+ 'If-Modified-Since': options.lastModifiedAfter.toUTCString(),
+ }),
Accept: 'application/vnd.github.v3.raw',
},
// TODO(freben): The signal cast is there because pre-3.x versions of
@@ -130,6 +134,9 @@ export class GithubUrlReader implements UrlReader {
if (response.ok) {
return ReadUrlResponseFactory.fromNodeJSReadable(response.body, {
etag: response.headers.get('ETag') ?? undefined,
+ lastModifiedAt: parseLastModified(
+ response.headers.get('Last-Modified'),
+ ),
});
}
@@ -290,6 +297,7 @@ export class GithubUrlReader implements UrlReader {
return files.map(file => ({
url: pathToUrl(file.path),
content: file.content,
+ lastModifiedAt: file.lastModifiedAt,
}));
}
diff --git a/packages/backend-common/src/reading/GitlabUrlReader.test.ts b/packages/backend-common/src/reading/GitlabUrlReader.test.ts
index 3751ee868e..5af4faf7e5 100644
--- a/packages/backend-common/src/reading/GitlabUrlReader.test.ts
+++ b/packages/backend-common/src/reading/GitlabUrlReader.test.ts
@@ -184,7 +184,7 @@ describe('GitlabUrlReader', () => {
treeResponseFactory,
});
- it('should throw NotModified on HTTP 304', async () => {
+ it('should throw NotModified on HTTP 304 from etag', async () => {
worker.use(
rest.get('*/api/v4/projects/:name', (_, res, ctx) =>
res(ctx.status(200), ctx.json({ id: 12345 })),
@@ -205,13 +205,44 @@ describe('GitlabUrlReader', () => {
).rejects.toThrow(NotModifiedError);
});
- it('should return etag in response', async () => {
+ it('should throw NotModified on HTTP 304 from lastModifiedAt', async () => {
+ worker.use(
+ rest.get('*/api/v4/projects/:name', (_, res, ctx) =>
+ res(ctx.status(200), ctx.json({ id: 12345 })),
+ ),
+ rest.get('*', (req, res, ctx) => {
+ expect(req.headers.get('If-Modified-Since')).toBe(
+ new Date('2019 12 31 23:59:59 GMT').toUTCString(),
+ );
+ return res(ctx.status(304));
+ }),
+ );
+
+ await expect(
+ reader.readUrl!(
+ 'https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/my/path/to/file.yaml',
+ {
+ lastModifiedAfter: new Date('2019 12 31 23:59:59 GMT'),
+ },
+ ),
+ ).rejects.toThrow(NotModifiedError);
+ });
+
+ it('should return etag and last-modified in response', async () => {
worker.use(
rest.get('*/api/v4/projects/:name', (_, res, ctx) =>
res(ctx.status(200), ctx.json({ id: 12345 })),
),
rest.get('*', (_req, res, ctx) => {
- return res(ctx.status(200), ctx.set('ETag', '999'), ctx.body('foo'));
+ return res(
+ ctx.status(200),
+ ctx.set('ETag', '999'),
+ ctx.set(
+ 'Last-Modified',
+ new Date('2020 01 01 00:0:00 GMT').toUTCString(),
+ ),
+ ctx.body('foo'),
+ );
}),
);
@@ -219,6 +250,7 @@ describe('GitlabUrlReader', () => {
'https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/my/path/to/file.yaml',
);
expect(result.etag).toBe('999');
+ expect(result.lastModifiedAt).toEqual(new Date('2020 01 01 00:0:00 GMT'));
const content = await result.buffer();
expect(content.toString()).toBe('foo');
});
@@ -524,6 +556,10 @@ describe('GitlabUrlReader', () => {
path.resolve(__dirname, '__fixtures__/gitlab-archive.tar.gz'),
);
+ const archiveSubPathBuffer = fs.readFileSync(
+ path.resolve(__dirname, '__fixtures__/gitlab-subpath-archive.tar.gz'),
+ );
+
const projectGitlabApiResponse = {
id: 11111111,
default_branch: 'main',
@@ -534,21 +570,34 @@ describe('GitlabUrlReader', () => {
id: 'sha123abc',
},
];
+ const commitsOfSubPathGitlabApiResponse = [
+ {
+ id: 'sha456abc',
+ },
+ ];
beforeEach(() => {
worker.use(
rest.get(
'https://gitlab.com/api/v4/projects/backstage%2Fmock/repository/archive',
- (_, res, ctx) =>
- res(
+ (req, res, ctx) => {
+ const filepath = req.url.searchParams.get('path');
+ let filename = 'mock-main-sha123abc.zip';
+ let body = archiveBuffer;
+ if (filepath === 'docs') {
+ filename = 'gitlab-subpath-archive.tar.gz';
+ body = archiveSubPathBuffer;
+ }
+ return res(
ctx.status(200),
ctx.set('Content-Type', 'application/zip'),
ctx.set(
'content-disposition',
- 'attachment; filename="mock-main-sha123abc.zip"',
+ `attachment; filename="${filename}"`,
),
- ctx.body(archiveBuffer),
- ),
+ ctx.body(body),
+ );
+ },
),
rest.get(
'https://gitlab.com/api/v4/projects/backstage%2Fmock',
@@ -564,6 +613,14 @@ describe('GitlabUrlReader', () => {
(req, res, ctx) => {
const refName = req.url.searchParams.get('ref_name');
if (refName === 'main') {
+ const filepath = req.url.searchParams.get('path');
+ if (filepath === 'docs') {
+ return res(
+ ctx.status(200),
+ ctx.set('Content-Type', 'application/json'),
+ ctx.json(commitsOfSubPathGitlabApiResponse),
+ );
+ }
return res(
ctx.status(200),
ctx.set('Content-Type', 'application/json'),
@@ -590,6 +647,21 @@ describe('GitlabUrlReader', () => {
);
});
+ it('load only relevant path', async () => {
+ const result = await gitlabProcessor.search(
+ 'https://gitlab.com/backstage/mock/tree/main/docs/**/index.*',
+ );
+
+ expect(result.etag).toBe('sha456abc');
+ expect(result.files.length).toBe(1);
+ expect(result.files[0].url).toBe(
+ 'https://gitlab.com/backstage/mock/tree/main/docs/index.md',
+ );
+ await expect(result.files[0].content()).resolves.toEqual(
+ Buffer.from('# Test Subpath\n'),
+ );
+ });
+
it('throws NotModifiedError when same etag', async () => {
await expect(
gitlabProcessor.search(
diff --git a/packages/backend-common/src/reading/GitlabUrlReader.ts b/packages/backend-common/src/reading/GitlabUrlReader.ts
index bebc7453d0..ab59c19b16 100644
--- a/packages/backend-common/src/reading/GitlabUrlReader.ts
+++ b/packages/backend-common/src/reading/GitlabUrlReader.ts
@@ -26,7 +26,6 @@ import parseGitUrl from 'git-url-parse';
import { Minimatch } from 'minimatch';
import { Readable } from 'stream';
import { NotFoundError, NotModifiedError } from '@backstage/errors';
-import { stripFirstDirectoryFromPath } from './tree/util';
import {
ReadTreeResponseFactory,
ReaderFactory,
@@ -40,6 +39,7 @@ import {
} from './types';
import { trimEnd, trimStart } from 'lodash';
import { ReadUrlResponseFactory } from './ReadUrlResponseFactory';
+import { parseLastModified } from './util';
/**
* Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for files on GitLab.
@@ -72,7 +72,7 @@ export class GitlabUrlReader implements UrlReader {
url: string,
options?: ReadUrlOptions,
): Promise {
- const { etag, signal } = options ?? {};
+ const { etag, lastModifiedAfter, signal } = options ?? {};
const builtUrl = await this.getGitlabFetchUrl(url);
let response: Response;
@@ -81,6 +81,9 @@ export class GitlabUrlReader implements UrlReader {
headers: {
...getGitLabRequestOptions(this.integration.config).headers,
...(etag && { 'If-None-Match': etag }),
+ ...(lastModifiedAfter && {
+ 'If-Modified-Since': lastModifiedAfter.toUTCString(),
+ }),
},
// TODO(freben): The signal cast is there because pre-3.x versions of
// node-fetch have a very slightly deviating AbortSignal type signature.
@@ -101,6 +104,9 @@ export class GitlabUrlReader implements UrlReader {
if (response.ok) {
return ReadUrlResponseFactory.fromNodeJSReadable(response.body, {
etag: response.headers.get('ETag') ?? undefined,
+ lastModifiedAt: parseLastModified(
+ response.headers.get('Last-Modified'),
+ ),
});
}
@@ -156,7 +162,7 @@ export class GitlabUrlReader implements UrlReader {
// ref is an empty string if no branch is set in provided url to readTree.
const branch = ref || projectGitlabResponseJson.default_branch;
- // Fetch the latest commit that modifies the the filepath in the provided or default branch
+ // Fetch the latest commit that modifies the filepath in the provided or default branch
// to compare against the provided sha.
const commitsReqParams = new URLSearchParams();
commitsReqParams.set('ref_name', branch);
@@ -193,11 +199,16 @@ export class GitlabUrlReader implements UrlReader {
throw new NotModifiedError();
}
+ const archiveReqParams = new URLSearchParams();
+ archiveReqParams.set('sha', branch);
+ if (!!filepath) {
+ archiveReqParams.set('path', filepath);
+ }
// https://docs.gitlab.com/ee/api/repositories.html#get-file-archive
const archiveGitLabResponse = await fetch(
`${this.integration.config.apiBaseUrl}/projects/${encodeURIComponent(
repoFullName,
- )}/repository/archive?sha=${branch}`,
+ )}/repository/archive?${archiveReqParams.toString()}`,
{
...getGitLabRequestOptions(this.integration.config),
// TODO(freben): The signal cast is there because pre-3.x versions of
@@ -227,30 +238,54 @@ export class GitlabUrlReader implements UrlReader {
async search(url: string, options?: SearchOptions): Promise {
const { filepath } = parseGitUrl(url);
+ const staticPart = this.getStaticPart(filepath);
const matcher = new Minimatch(filepath);
-
- // TODO(freben): For now, read the entire repo and filter through that. In
- // a future improvement, we could be smart and try to deduce that non-glob
- // prefixes (like for filepaths such as some-prefix/**/a.yaml) can be used
- // to get just that part of the repo.
- const treeUrl = trimEnd(url.replace(filepath, ''), '/');
-
+ const treeUrl = trimEnd(url.replace(filepath, staticPart), `/`);
+ const pathPrefix = staticPart ? `${staticPart}/` : '';
const tree = await this.readTree(treeUrl, {
etag: options?.etag,
signal: options?.signal,
- filter: path => matcher.match(stripFirstDirectoryFromPath(path)),
+ filter: path => matcher.match(`${pathPrefix}${path}`),
});
- const files = await tree.files();
+ const files = await tree.files();
return {
etag: tree.etag,
files: files.map(file => ({
- url: this.integration.resolveUrl({ url: `/${file.path}`, base: url }),
+ url: this.integration.resolveUrl({
+ url: `/${pathPrefix}${file.path}`,
+ base: url,
+ }),
content: file.content,
+ lastModifiedAt: file.lastModifiedAt,
})),
};
}
+ /**
+ * This function splits the input globPattern string into segments using the path separator /. It then iterates over
+ * the segments from the end of the array towards the beginning, checking if the concatenated string up to that
+ * segment matches the original globPattern using the minimatch function. If a match is found, it continues iterating.
+ * If no match is found, it returns the concatenated string up to the current segment, which is the static part of the
+ * glob pattern.
+ *
+ * E.g. `catalog/foo/*.yaml` will return `catalog/foo`.
+ *
+ * @param globPattern the glob pattern
+ * @private
+ */
+ private getStaticPart(globPattern: string) {
+ const segments = globPattern.split('/');
+ let i = segments.length;
+ while (
+ i > 0 &&
+ new Minimatch(segments.slice(0, i).join('/')).match(globPattern)
+ ) {
+ i--;
+ }
+ return segments.slice(0, i).join('/');
+ }
+
toString() {
const { host, token } = this.integration.config;
return `gitlab{host=${host},authed=${Boolean(token)}}`;
diff --git a/packages/backend-common/src/reading/ReadUrlResponseFactory.ts b/packages/backend-common/src/reading/ReadUrlResponseFactory.ts
index 91d1939c24..69b9c6c16a 100644
--- a/packages/backend-common/src/reading/ReadUrlResponseFactory.ts
+++ b/packages/backend-common/src/reading/ReadUrlResponseFactory.ts
@@ -61,6 +61,7 @@ export class ReadUrlResponseFactory {
return stream;
},
etag: options?.etag,
+ lastModifiedAt: options?.lastModifiedAt,
};
}
diff --git a/packages/backend-common/src/reading/__fixtures__/gitlab-subpath-archive.tar.gz b/packages/backend-common/src/reading/__fixtures__/gitlab-subpath-archive.tar.gz
new file mode 100644
index 0000000000..c41714b452
Binary files /dev/null and b/packages/backend-common/src/reading/__fixtures__/gitlab-subpath-archive.tar.gz differ
diff --git a/packages/backend-common/src/reading/tree/ReadableArrayResponse.ts b/packages/backend-common/src/reading/tree/ReadableArrayResponse.ts
index eabaa3bc56..1429931142 100644
--- a/packages/backend-common/src/reading/tree/ReadableArrayResponse.ts
+++ b/packages/backend-common/src/reading/tree/ReadableArrayResponse.ts
@@ -63,6 +63,7 @@ export class ReadableArrayResponse implements ReadTreeResponse {
files.push({
path: this.stream[i].path,
content: () => getRawBody(this.stream[i].data),
+ lastModifiedAt: this.stream[i]?.lastModifiedAt,
});
}
}
diff --git a/packages/backend-common/src/reading/tree/TarArchiveResponse.test.ts b/packages/backend-common/src/reading/tree/TarArchiveResponse.test.ts
index f0cbc6a612..1765a41156 100644
--- a/packages/backend-common/src/reading/tree/TarArchiveResponse.test.ts
+++ b/packages/backend-common/src/reading/tree/TarArchiveResponse.test.ts
@@ -45,10 +45,12 @@ describe('TarArchiveResponse', () => {
{
path: 'mkdocs.yml',
content: expect.any(Function),
+ lastModifiedAt: undefined,
},
{
path: 'docs/index.md',
content: expect.any(Function),
+ lastModifiedAt: undefined,
},
]);
const contents = await Promise.all(files.map(f => f.content()));
@@ -70,6 +72,7 @@ describe('TarArchiveResponse', () => {
{
path: 'mkdocs.yml',
content: expect.any(Function),
+ lastModifiedAt: undefined,
},
]);
const content = await files[0].content();
@@ -93,10 +96,12 @@ describe('TarArchiveResponse', () => {
{
path: 'mkdocs.yml',
content: expect.any(Function),
+ lastModifiedAt: undefined,
},
{
path: 'docs/index.md',
content: expect.any(Function),
+ lastModifiedAt: undefined,
},
]);
const contents = await Promise.all(files.map(f => f.content()));
diff --git a/packages/backend-common/src/reading/tree/ZipArchiveResponse.test.ts b/packages/backend-common/src/reading/tree/ZipArchiveResponse.test.ts
index e45a25db66..0b010565dd 100644
--- a/packages/backend-common/src/reading/tree/ZipArchiveResponse.test.ts
+++ b/packages/backend-common/src/reading/tree/ZipArchiveResponse.test.ts
@@ -59,10 +59,12 @@ describe('ZipArchiveResponse', () => {
{
path: 'mkdocs.yml',
content: expect.any(Function),
+ lastModifiedAt: expect.any(Date),
},
{
path: 'docs/index.md',
content: expect.any(Function),
+ lastModifiedAt: expect.any(Date),
},
]);
@@ -85,6 +87,7 @@ describe('ZipArchiveResponse', () => {
{
path: 'mkdocs.yml',
content: expect.any(Function),
+ lastModifiedAt: expect.any(Date),
},
]);
const content = await files[0].content();
@@ -108,10 +111,12 @@ describe('ZipArchiveResponse', () => {
{
path: 'mkdocs.yml',
content: expect.any(Function),
+ lastModifiedAt: expect.any(Date),
},
{
path: 'docs/index.md',
content: expect.any(Function),
+ lastModifiedAt: expect.any(Date),
},
]);
const contents = await Promise.all(files.map(f => f.content()));
diff --git a/packages/backend-common/src/reading/tree/ZipArchiveResponse.ts b/packages/backend-common/src/reading/tree/ZipArchiveResponse.ts
index 5a1c5f9688..1e55150310 100644
--- a/packages/backend-common/src/reading/tree/ZipArchiveResponse.ts
+++ b/packages/backend-common/src/reading/tree/ZipArchiveResponse.ts
@@ -146,6 +146,9 @@ export class ZipArchiveResponse implements ReadTreeResponse {
files.push({
path: this.getInnerPath(entry.fileName),
content: async () => await streamToBuffer(content),
+ lastModifiedAt: entry.lastModFileTime
+ ? new Date(entry.lastModFileTime)
+ : undefined,
});
});
diff --git a/packages/backend-common/src/reading/types.ts b/packages/backend-common/src/reading/types.ts
index 35380029e2..7f4d407fd0 100644
--- a/packages/backend-common/src/reading/types.ts
+++ b/packages/backend-common/src/reading/types.ts
@@ -65,6 +65,7 @@ export type ReaderFactory = (options: {
*/
export type ReadUrlResponseFactoryFromStreamOptions = {
etag?: string;
+ lastModifiedAt?: Date;
};
/**
@@ -95,10 +96,16 @@ export type FromReadableArrayOptions = Array<{
* The raw data itself.
*/
data: Readable;
+
/**
* The filepath of the data.
*/
path: string;
+
+ /**
+ * Last modified date of the file contents.
+ */
+ lastModifiedAt?: Date;
}>;
/**
diff --git a/packages/backend-common/src/reading/util.ts b/packages/backend-common/src/reading/util.ts
new file mode 100644
index 0000000000..3d65c2c527
--- /dev/null
+++ b/packages/backend-common/src/reading/util.ts
@@ -0,0 +1,23 @@
+/*
+ * 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 function parseLastModified(value: string | null | undefined) {
+ if (!value) {
+ return undefined;
+ }
+
+ return new Date(value);
+}
diff --git a/packages/backend-defaults/CHANGELOG.md b/packages/backend-defaults/CHANGELOG.md
index 7283ae89e2..01afac257b 100644
--- a/packages/backend-defaults/CHANGELOG.md
+++ b/packages/backend-defaults/CHANGELOG.md
@@ -1,5 +1,26 @@
# @backstage/backend-defaults
+## 0.1.9-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-app-api@0.4.2-next.0
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/backend-plugin-api@0.5.1-next.0
+
+## 0.1.8
+
+### Patch Changes
+
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 482dae5de1c: Updated link to docs.
+- 5d0693edc09: Added a workaround for the cyclic dependency bug across `@backstage/backend-common` and `@backstage/backend-app-api`.
+- Updated dependencies
+ - @backstage/backend-common@0.18.3
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/backend-app-api@0.4.1
+
## 0.1.8-next.2
### Patch Changes
diff --git a/packages/backend-defaults/package.json b/packages/backend-defaults/package.json
index 2ae0074849..2f9655384e 100644
--- a/packages/backend-defaults/package.json
+++ b/packages/backend-defaults/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/backend-defaults",
"description": "Backend defaults used by Backstage backend apps",
- "version": "0.1.8-next.2",
+ "version": "0.1.9-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
diff --git a/packages/backend-dev-utils/CHANGELOG.md b/packages/backend-dev-utils/CHANGELOG.md
index 84a1cbc3f1..6b505e917e 100644
--- a/packages/backend-dev-utils/CHANGELOG.md
+++ b/packages/backend-dev-utils/CHANGELOG.md
@@ -1,5 +1,11 @@
# @backstage/backend-dev-utils
+## 0.1.1
+
+### Patch Changes
+
+- 482dae5de1c: Updated link to docs.
+
## 0.1.1-next.0
### Patch Changes
diff --git a/packages/backend-dev-utils/package.json b/packages/backend-dev-utils/package.json
index 9fea6a34cf..0928032977 100644
--- a/packages/backend-dev-utils/package.json
+++ b/packages/backend-dev-utils/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/backend-dev-utils",
- "version": "0.1.1-next.0",
+ "version": "0.1.1",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/packages/backend-next/CHANGELOG.md b/packages/backend-next/CHANGELOG.md
index 91ded2391f..39af1fa1c3 100644
--- a/packages/backend-next/CHANGELOG.md
+++ b/packages/backend-next/CHANGELOG.md
@@ -1,5 +1,29 @@
# example-backend-next
+## 0.0.10-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-backend@1.12.1-next.0
+ - @backstage/plugin-catalog-backend@1.8.1-next.0
+ - @backstage/backend-defaults@0.1.9-next.0
+ - @backstage/plugin-app-backend@0.3.44-next.0
+ - @backstage/plugin-techdocs-backend@1.6.1-next.0
+ - @backstage/plugin-todo-backend@0.1.41-next.0
+
+## 0.0.9
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-backend@1.12.0
+ - @backstage/plugin-catalog-backend@1.8.0
+ - @backstage/plugin-todo-backend@0.1.40
+ - @backstage/plugin-techdocs-backend@1.6.0
+ - @backstage/backend-defaults@0.1.8
+ - @backstage/plugin-app-backend@0.3.43
+
## 0.0.9-next.2
### Patch Changes
diff --git a/packages/backend-next/package.json b/packages/backend-next/package.json
index 9f7ec8306a..bed4f10975 100644
--- a/packages/backend-next/package.json
+++ b/packages/backend-next/package.json
@@ -1,6 +1,6 @@
{
"name": "example-backend-next",
- "version": "0.0.9-next.2",
+ "version": "0.0.10-next.0",
"main": "dist/index.cjs.js",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -29,6 +29,12 @@
"@backstage/plugin-app-backend": "workspace:^",
"@backstage/plugin-catalog-backend": "workspace:^",
"@backstage/plugin-scaffolder-backend": "workspace:^",
+ "@backstage/plugin-search-backend": "workspace:^",
+ "@backstage/plugin-search-backend-module-catalog": "workspace:^",
+ "@backstage/plugin-search-backend-module-explore": "workspace:^",
+ "@backstage/plugin-search-backend-module-techdocs": "workspace:^",
+ "@backstage/plugin-search-backend-node": "workspace:^",
+ "@backstage/plugin-techdocs-backend": "workspace:^",
"@backstage/plugin-todo-backend": "workspace:^"
},
"devDependencies": {
diff --git a/packages/backend-next/src/index.ts b/packages/backend-next/src/index.ts
index 8e29244ebf..e3cbbd53b8 100644
--- a/packages/backend-next/src/index.ts
+++ b/packages/backend-next/src/index.ts
@@ -14,16 +14,35 @@
* limitations under the License.
*/
-import { catalogPlugin } from '@backstage/plugin-catalog-backend/alpha';
-import { catalogModuleTemplateKind } from '@backstage/plugin-scaffolder-backend/alpha';
import { createBackend } from '@backstage/backend-defaults';
import { appPlugin } from '@backstage/plugin-app-backend/alpha';
import { todoPlugin } from '@backstage/plugin-todo-backend';
+import { techdocsPlugin } from '@backstage/plugin-techdocs-backend/alpha';
+import { catalogPlugin } from '@backstage/plugin-catalog-backend/alpha';
+import { catalogModuleTemplateKind } from '@backstage/plugin-scaffolder-backend/alpha';
+import { searchPlugin } from '@backstage/plugin-search-backend/alpha';
+import { searchModuleCatalogCollator } from '@backstage/plugin-search-backend-module-catalog/alpha';
+import { searchModuleTechDocsCollator } from '@backstage/plugin-search-backend-module-techdocs/alpha';
+import { searchModuleExploreCollator } from '@backstage/plugin-search-backend-module-explore/alpha';
const backend = createBackend();
+backend.add(appPlugin({ appPackageName: 'example-app' }));
+
+// Todo
+backend.add(todoPlugin());
+
+// Techdocs
+backend.add(techdocsPlugin());
+
+// Catalog
backend.add(catalogPlugin());
backend.add(catalogModuleTemplateKind());
-backend.add(appPlugin({ appPackageName: 'example-app' }));
-backend.add(todoPlugin());
+
+// Search
+backend.add(searchPlugin());
+backend.add(searchModuleCatalogCollator());
+backend.add(searchModuleTechDocsCollator());
+backend.add(searchModuleExploreCollator());
+
backend.start();
diff --git a/packages/backend-plugin-api/CHANGELOG.md b/packages/backend-plugin-api/CHANGELOG.md
index 5125411eb6..f3cb679fce 100644
--- a/packages/backend-plugin-api/CHANGELOG.md
+++ b/packages/backend-plugin-api/CHANGELOG.md
@@ -1,5 +1,33 @@
# @backstage/backend-plugin-api
+## 0.5.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/config@1.0.7
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/types@1.0.2
+ - @backstage/plugin-auth-node@0.2.13-next.0
+ - @backstage/plugin-permission-common@0.7.4
+
+## 0.5.0
+
+### Minor Changes
+
+- c1ee073a82b: Added `lastModifiedAt` field on `UrlReaderService` responses and a `lastModifiedAfter` option to `UrlReaderService.readUrl`.
+
+### Patch Changes
+
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 482dae5de1c: Updated link to docs.
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.2.12
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.4.1-next.2
### Patch Changes
diff --git a/packages/backend-plugin-api/api-report.md b/packages/backend-plugin-api/api-report.md
index 5e64502b78..7dc6ae97b3 100644
--- a/packages/backend-plugin-api/api-report.md
+++ b/packages/backend-plugin-api/api-report.md
@@ -359,11 +359,13 @@ export type ReadTreeResponseDirOptions = {
export type ReadTreeResponseFile = {
path: string;
content(): Promise;
+ lastModifiedAt?: Date;
};
// @public
export type ReadUrlOptions = {
etag?: string;
+ lastModifiedAfter?: Date;
signal?: AbortSignal;
};
@@ -372,6 +374,7 @@ export type ReadUrlResponse = {
buffer(): Promise;
stream?(): Readable;
etag?: string;
+ lastModifiedAt?: Date;
};
// @public (undocumented)
@@ -420,6 +423,7 @@ export type SearchResponse = {
export type SearchResponseFile = {
url: string;
content(): Promise;
+ lastModifiedAt?: Date;
};
// @public (undocumented)
diff --git a/packages/backend-plugin-api/package.json b/packages/backend-plugin-api/package.json
index 4d97fdcd74..6566772f2f 100644
--- a/packages/backend-plugin-api/package.json
+++ b/packages/backend-plugin-api/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/backend-plugin-api",
"description": "Core API used by Backstage backend plugins",
- "version": "0.4.1-next.2",
+ "version": "0.5.1-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
diff --git a/packages/backend-plugin-api/src/services/definitions/UrlReaderService.ts b/packages/backend-plugin-api/src/services/definitions/UrlReaderService.ts
index ef825a7fcd..c189b4a339 100644
--- a/packages/backend-plugin-api/src/services/definitions/UrlReaderService.ts
+++ b/packages/backend-plugin-api/src/services/definitions/UrlReaderService.ts
@@ -64,6 +64,26 @@ export type ReadUrlOptions = {
*/
etag?: string;
+ /**
+ * A date which can be provided to check whether a
+ * {@link UrlReaderService.readUrl} response has changed since the lastModifiedAt.
+ *
+ * @remarks
+ *
+ * In the {@link UrlReaderService.readUrl} response, an lastModifiedAt is returned
+ * along with data. The lastModifiedAt date represents the last time the data
+ * was modified.
+ *
+ * When an lastModifiedAfter is given in ReadUrlOptions, {@link UrlReaderService.readUrl}
+ * will compare the lastModifiedAfter against the lastModifiedAt of the target. If
+ * the data has not been modified since this date, the {@link UrlReaderService.readUrl}
+ * will throw a {@link @backstage/errors#NotModifiedError} indicating that the
+ * response does not contain any new data. If they do not match,
+ * {@link UrlReaderService.readUrl} will return the rest of the response along with new
+ * lastModifiedAt date.
+ */
+ lastModifiedAfter?: Date;
+
/**
* An abort signal to pass down to the underlying request.
*
@@ -102,6 +122,11 @@ export type ReadUrlResponse = {
* Can be used to compare and cache responses when doing subsequent calls.
*/
etag?: string;
+
+ /**
+ * Last modified date of the file contents.
+ */
+ lastModifiedAt?: Date;
};
/**
@@ -213,8 +238,20 @@ export type ReadTreeResponse = {
* @public
*/
export type ReadTreeResponseFile = {
+ /**
+ * The filepath of the data.
+ */
path: string;
+
+ /**
+ * The binary contents of the file.
+ */
content(): Promise;
+
+ /**
+ * The last modified timestamp of the data.
+ */
+ lastModifiedAt?: Date;
};
/**
@@ -278,4 +315,9 @@ export type SearchResponseFile = {
* The binary contents of the file.
*/
content(): Promise;
+
+ /**
+ * The last modified timestamp of the data.
+ */
+ lastModifiedAt?: Date;
};
diff --git a/packages/backend-tasks/CHANGELOG.md b/packages/backend-tasks/CHANGELOG.md
index 7eb43c4677..7d2540d83a 100644
--- a/packages/backend-tasks/CHANGELOG.md
+++ b/packages/backend-tasks/CHANGELOG.md
@@ -1,5 +1,31 @@
# @backstage/backend-tasks
+## 0.5.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+
+## 0.5.0
+
+### Minor Changes
+
+- 1578276708a: add functionality to get descriptions from the scheduler for triggering
+
+### Patch Changes
+
+- f0685193efa: Added the adapted query to mysql and sqlite3 databases to not returning warning on logs
+- 482dae5de1c: Updated link to docs.
+- Updated dependencies
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.5.0-next.2
### Minor Changes
diff --git a/packages/backend-tasks/package.json b/packages/backend-tasks/package.json
index fa826067c8..4b78b5f5c4 100644
--- a/packages/backend-tasks/package.json
+++ b/packages/backend-tasks/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/backend-tasks",
"description": "Common distributed task management library for Backstage backends",
- "version": "0.5.0-next.2",
+ "version": "0.5.1-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
@@ -43,7 +43,7 @@
"luxon": "^3.0.0",
"uuid": "^8.0.0",
"winston": "^3.2.1",
- "zod": "~3.18.0"
+ "zod": "^3.21.4"
},
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
diff --git a/packages/backend-test-utils/CHANGELOG.md b/packages/backend-test-utils/CHANGELOG.md
index 3b20fe92d5..a1f4e76ea2 100644
--- a/packages/backend-test-utils/CHANGELOG.md
+++ b/packages/backend-test-utils/CHANGELOG.md
@@ -1,5 +1,32 @@
# @backstage/backend-test-utils
+## 0.1.36-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-app-api@0.4.2-next.0
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/types@1.0.2
+ - @backstage/plugin-auth-node@0.2.13-next.0
+
+## 0.1.35
+
+### Patch Changes
+
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- 482dae5de1c: Updated link to docs.
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.2.12
+ - @backstage/backend-common@0.18.3
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/backend-app-api@0.4.1
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.1.35-next.2
### Patch Changes
diff --git a/packages/backend-test-utils/package.json b/packages/backend-test-utils/package.json
index e797e346ff..05195f98aa 100644
--- a/packages/backend-test-utils/package.json
+++ b/packages/backend-test-utils/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/backend-test-utils",
"description": "Test helpers library for Backstage backends",
- "version": "0.1.35-next.2",
+ "version": "0.1.36-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
diff --git a/packages/backend/CHANGELOG.md b/packages/backend/CHANGELOG.md
index 933d9688b9..fd9247bb44 100644
--- a/packages/backend/CHANGELOG.md
+++ b/packages/backend/CHANGELOG.md
@@ -1,5 +1,107 @@
# example-backend
+## 0.2.82-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-backend@1.12.1-next.0
+ - @backstage/plugin-kubernetes-backend@0.10.0-next.0
+ - @backstage/plugin-entity-feedback-backend@0.1.2-next.0
+ - @backstage/plugin-auth-backend@0.18.2-next.0
+ - @backstage/plugin-catalog-backend@1.8.1-next.0
+ - @backstage/plugin-graphql-backend@0.1.34-next.0
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.12-next.0
+ - example-app@0.2.82-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-adr-backend@0.3.2-next.0
+ - @backstage/plugin-app-backend@0.3.44-next.0
+ - @backstage/plugin-auth-node@0.2.13-next.0
+ - @backstage/plugin-azure-devops-backend@0.3.23-next.0
+ - @backstage/plugin-azure-sites-backend@0.1.6-next.0
+ - @backstage/plugin-badges-backend@0.1.38-next.0
+ - @backstage/plugin-catalog-node@1.3.5-next.0
+ - @backstage/plugin-code-coverage-backend@0.2.10-next.0
+ - @backstage/plugin-events-backend@0.2.5-next.0
+ - @backstage/plugin-events-node@0.2.5-next.0
+ - @backstage/plugin-explore-backend@0.0.6-next.0
+ - @backstage/plugin-jenkins-backend@0.1.34-next.0
+ - @backstage/plugin-kafka-backend@0.2.37-next.0
+ - @backstage/plugin-lighthouse-backend@0.1.2-next.0
+ - @backstage/plugin-linguist-backend@0.2.1-next.0
+ - @backstage/plugin-permission-backend@0.5.19-next.0
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/plugin-permission-node@0.7.7-next.0
+ - @backstage/plugin-playlist-backend@0.2.7-next.0
+ - @backstage/plugin-proxy-backend@0.2.38-next.0
+ - @backstage/plugin-rollbar-backend@0.1.41-next.0
+ - @backstage/plugin-search-backend@1.2.5-next.0
+ - @backstage/plugin-search-backend-module-elasticsearch@1.1.5-next.0
+ - @backstage/plugin-search-backend-module-pg@0.5.5-next.0
+ - @backstage/plugin-search-backend-node@1.1.5-next.0
+ - @backstage/plugin-search-common@1.2.2
+ - @backstage/plugin-tech-insights-backend@0.5.10-next.0
+ - @backstage/plugin-tech-insights-backend-module-jsonfc@0.1.28-next.0
+ - @backstage/plugin-tech-insights-node@0.4.2-next.0
+ - @backstage/plugin-techdocs-backend@1.6.1-next.0
+ - @backstage/plugin-todo-backend@0.1.41-next.0
+
+## 0.2.81
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-backend@1.12.0
+ - @backstage/plugin-catalog-backend@1.8.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/plugin-todo-backend@0.1.40
+ - @backstage/plugin-permission-node@0.7.6
+ - @backstage/plugin-search-backend-module-elasticsearch@1.1.4
+ - @backstage/plugin-tech-insights-backend-module-jsonfc@0.1.27
+ - @backstage/plugin-auth-node@0.2.12
+ - @backstage/plugin-techdocs-backend@1.6.0
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/plugin-tech-insights-backend@0.5.9
+ - @backstage/plugin-adr-backend@0.3.1
+ - @backstage/plugin-auth-backend@0.18.1
+ - @backstage/backend-common@0.18.3
+ - @backstage/plugin-linguist-backend@0.2.0
+ - @backstage/plugin-catalog-node@1.3.4
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-events-backend@0.2.4
+ - @backstage/plugin-app-backend@0.3.43
+ - @backstage/plugin-events-node@0.2.4
+ - @backstage/integration@1.4.3
+ - @backstage/plugin-azure-devops-backend@0.3.22
+ - @backstage/plugin-azure-sites-backend@0.1.5
+ - @backstage/plugin-code-coverage-backend@0.2.9
+ - @backstage/plugin-entity-feedback-backend@0.1.1
+ - @backstage/plugin-explore-backend@0.0.5
+ - @backstage/plugin-graphql-backend@0.1.33
+ - @backstage/plugin-jenkins-backend@0.1.33
+ - @backstage/plugin-kubernetes-backend@0.9.4
+ - @backstage/plugin-permission-backend@0.5.18
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/plugin-playlist-backend@0.2.6
+ - @backstage/plugin-proxy-backend@0.2.37
+ - @backstage/plugin-rollbar-backend@0.1.40
+ - @backstage/plugin-lighthouse-backend@0.1.1
+ - @backstage/config@1.0.7
+ - @backstage/plugin-scaffolder-backend-module-rails@0.4.11
+ - @backstage/plugin-badges-backend@0.1.37
+ - example-app@0.2.81
+ - @backstage/plugin-search-backend@1.2.4
+ - @backstage/plugin-kafka-backend@0.2.36
+ - @backstage/plugin-search-backend-module-pg@0.5.4
+ - @backstage/plugin-search-backend-node@1.1.4
+ - @backstage/plugin-search-common@1.2.2
+ - @backstage/plugin-tech-insights-node@0.4.1
+
## 0.2.81-next.2
### Patch Changes
diff --git a/packages/backend/package.json b/packages/backend/package.json
index 107a1147f1..22da65099f 100644
--- a/packages/backend/package.json
+++ b/packages/backend/package.json
@@ -1,6 +1,6 @@
{
"name": "example-backend",
- "version": "0.2.81-next.2",
+ "version": "0.2.82-next.0",
"main": "dist/index.cjs.js",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/packages/backend/src/plugins/kubernetes.ts b/packages/backend/src/plugins/kubernetes.ts
index 3bc7a5dcbe..3bc6648862 100644
--- a/packages/backend/src/plugins/kubernetes.ts
+++ b/packages/backend/src/plugins/kubernetes.ts
@@ -27,6 +27,7 @@ export default async function createPlugin(
logger: env.logger,
config: env.config,
catalogApi,
+ permissions: env.permissions,
}).build();
return router;
}
diff --git a/packages/backend/src/plugins/scaffolder.ts b/packages/backend/src/plugins/scaffolder.ts
index d079b64c28..813092c9b9 100644
--- a/packages/backend/src/plugins/scaffolder.ts
+++ b/packages/backend/src/plugins/scaffolder.ts
@@ -34,5 +34,6 @@ export default async function createPlugin(
reader: env.reader,
identity: env.identity,
scheduler: env.scheduler,
+ permissionApi: env.permissions,
});
}
diff --git a/packages/catalog-client/CHANGELOG.md b/packages/catalog-client/CHANGELOG.md
index 52eef0291e..edd3811ef8 100644
--- a/packages/catalog-client/CHANGELOG.md
+++ b/packages/catalog-client/CHANGELOG.md
@@ -1,5 +1,19 @@
# @backstage/catalog-client
+## 1.4.0
+
+### Minor Changes
+
+- 8c030b1826c: Add `queryEntities` method to `CatalogApi`.
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- c630360631f: Ensure that `getEntitiesByRefs` returns `undefined` instead of `null` for missing items
+- Updated dependencies
+ - @backstage/errors@1.1.5
+ - @backstage/catalog-model@1.2.1
+
## 1.4.0-next.1
### Patch Changes
diff --git a/packages/catalog-client/package.json b/packages/catalog-client/package.json
index f72ce4464a..07709d8c65 100644
--- a/packages/catalog-client/package.json
+++ b/packages/catalog-client/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/catalog-client",
"description": "An isomorphic client for the catalog backend",
- "version": "1.4.0-next.1",
+ "version": "1.4.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/packages/catalog-client/src/CatalogClient.test.ts b/packages/catalog-client/src/CatalogClient.test.ts
index c235ff1592..53bb55b95f 100644
--- a/packages/catalog-client/src/CatalogClient.test.ts
+++ b/packages/catalog-client/src/CatalogClient.test.ts
@@ -249,7 +249,7 @@ describe('CatalogClient', () => {
{ token },
);
- expect(response).toEqual({ items: [entity, null] });
+ expect(response).toEqual({ items: [entity, undefined] });
});
});
diff --git a/packages/catalog-client/src/CatalogClient.ts b/packages/catalog-client/src/CatalogClient.ts
index 4984d394d4..be4ae6289d 100644
--- a/packages/catalog-client/src/CatalogClient.ts
+++ b/packages/catalog-client/src/CatalogClient.ts
@@ -199,9 +199,11 @@ export class CatalogClient implements CatalogApi {
throw await ResponseError.fromResponse(response);
}
- const { items } = await response.json();
+ const { items } = (await response.json()) as {
+ items: Array;
+ };
- return { items };
+ return { items: items.map(i => i ?? undefined) };
}
/**
diff --git a/packages/catalog-model/CHANGELOG.md b/packages/catalog-model/CHANGELOG.md
index 08560cbec7..fa20368b86 100644
--- a/packages/catalog-model/CHANGELOG.md
+++ b/packages/catalog-model/CHANGELOG.md
@@ -1,5 +1,15 @@
# @backstage/catalog-model
+## 1.2.1
+
+### Patch Changes
+
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- Updated dependencies
+ - @backstage/errors@1.1.5
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 1.2.1-next.1
### Patch Changes
diff --git a/packages/catalog-model/package.json b/packages/catalog-model/package.json
index f6355bd74b..e23d399a37 100644
--- a/packages/catalog-model/package.json
+++ b/packages/catalog-model/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/catalog-model",
"description": "Types and validators that help describe the model of a Backstage Catalog",
- "version": "1.2.1-next.1",
+ "version": "1.2.1",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/packages/cli-common/CHANGELOG.md b/packages/cli-common/CHANGELOG.md
index 030b743fca..bb6e2756a0 100644
--- a/packages/cli-common/CHANGELOG.md
+++ b/packages/cli-common/CHANGELOG.md
@@ -1,5 +1,11 @@
# @backstage/cli-common
+## 0.1.12
+
+### Patch Changes
+
+- 482dae5de1c: Updated link to docs.
+
## 0.1.12-next.0
### Patch Changes
diff --git a/packages/cli-common/package.json b/packages/cli-common/package.json
index ad7ed92e98..38779eba07 100644
--- a/packages/cli-common/package.json
+++ b/packages/cli-common/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/cli-common",
"description": "Common functionality used by cli, backend, and create-app",
- "version": "0.1.12-next.0",
+ "version": "0.1.12",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
index 4db4e1afa1..e88e554b70 100644
--- a/packages/cli/CHANGELOG.md
+++ b/packages/cli/CHANGELOG.md
@@ -1,5 +1,44 @@
# @backstage/cli
+## 0.22.6-next.0
+
+### Patch Changes
+
+- b9839d7135c: Fixed backend start command on Windows by removing the use of platform dependent path joins.
+- c07c3b7364b: Add `onboard` command. While still in development, this command aims to guide users in setting up their Backstage App.
+- Updated dependencies
+ - @backstage/eslint-plugin@0.1.3-next.0
+ - @backstage/config@1.0.7
+ - @backstage/release-manifests@0.0.9
+ - @backstage/cli-common@0.1.12
+ - @backstage/config-loader@1.1.9
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+
+## 0.22.4
+
+### Patch Changes
+
+- 1ad8d885d30: Fixed a bug where additional backend package entry points where not properly marked as internal during local development.
+- 2011b86052c: Added templates for new plugin Web and Node.js libraries.
+- 867f4752ca1: Updated the ESLint plugin configuration that is enabled through `yarn start --check` to only pick up valid source files.
+- b4cd145b574: Added a new `migrate package-exports` command that synchronizes package exports fields in all `package.json`s.
+- 9bf50a36674: Bumped the `msw` version in templates to 1.0.0
+- 8bf24946c66: Adjust express dependencies to be the same as the rest of the project
+- 17271841de8: Updated frontend plugin template to use some more recent features
+- 4b4998466b4: Updated dependency `del` to `^7.0.0`.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- a11b9a23f5a: Keep custom exports entry points in package.json
+- 482dae5de1c: Updated link to docs.
+- Updated dependencies
+ - @backstage/eslint-plugin@0.1.2
+ - @backstage/errors@1.1.5
+ - @backstage/config-loader@1.1.9
+ - @backstage/release-manifests@0.0.9
+ - @backstage/cli-common@0.1.12
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.22.4-next.1
### Patch Changes
diff --git a/packages/cli/asset-types/asset-types.d.ts b/packages/cli/asset-types/asset-types.d.ts
index 9bd158bb8e..a1c053dc54 100644
--- a/packages/cli/asset-types/asset-types.d.ts
+++ b/packages/cli/asset-types/asset-types.d.ts
@@ -40,6 +40,11 @@ declare module '*.jpeg' {
export default src;
}
+declare module '*.md' {
+ const src: string;
+ export default src;
+}
+
declare module '*.png' {
const src: string;
export default src;
diff --git a/packages/cli/package.json b/packages/cli/package.json
index 8c76c7888b..d4b4547225 100644
--- a/packages/cli/package.json
+++ b/packages/cli/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/cli",
"description": "CLI for developing Backstage plugins and apps",
- "version": "0.22.4-next.1",
+ "version": "0.22.6-next.0",
"publishConfig": {
"access": "public"
},
@@ -39,6 +39,7 @@
"@backstage/types": "workspace:^",
"@esbuild-kit/cjs-loader": "^2.4.1",
"@manypkg/get-packages": "^1.1.3",
+ "@octokit/oauth-app": "^4.2.0",
"@octokit/request": "^6.0.0",
"@pmmmwh/react-refresh-webpack-plugin": "^0.5.7",
"@rollup/plugin-commonjs": "^23.0.0",
@@ -127,7 +128,7 @@
"yaml": "^2.0.0",
"yml-loader": "^2.1.0",
"yn": "^4.0.0",
- "zod": "~3.18.0"
+ "zod": "^3.21.4"
},
"devDependencies": {
"@backstage/backend-common": "workspace:^",
diff --git a/packages/cli/src/commands/index.ts b/packages/cli/src/commands/index.ts
index ddec5c6a4a..ba11a53cfd 100644
--- a/packages/cli/src/commands/index.ts
+++ b/packages/cli/src/commands/index.ts
@@ -25,6 +25,13 @@ const configOption = [
Array(),
] as const;
+export function registerOnboardCommand(program: Command) {
+ program
+ .command('onboard', { hidden: true })
+ .description('Get help setting up your Backstage App.')
+ .action(lazy(() => import('./onboard').then(m => m.command)));
+}
+
export function registerRepoCommand(program: Command) {
const command = program
.command('repo [command]')
@@ -360,6 +367,7 @@ export function registerCommands(program: Command) {
registerRepoCommand(program);
registerScriptCommand(program);
registerMigrateCommand(program);
+ registerOnboardCommand(program);
program
.command('versions:bump')
diff --git a/packages/cli/src/commands/onboard/README.md b/packages/cli/src/commands/onboard/README.md
new file mode 100644
index 0000000000..0fb4d22666
--- /dev/null
+++ b/packages/cli/src/commands/onboard/README.md
@@ -0,0 +1,22 @@
+# onboard
+
+## Local dev
+
+# Create a new app
+
+```bash
+cd ..
+npx @backstage/create-app
+cd new-backstage-app
+
+# Run the modded cli in the new app
+
+../RELATIVE_PATH_TO_PROJECT/backstage/packages/cli/bin/backstage-cli onboard
+? Do you want to set up Authentication for this project? (Y/n)
+...
+
+# Try the app with the new changes
+
+yarn dev
+
+```
diff --git a/packages/cli/src/commands/onboard/auth/index.ts b/packages/cli/src/commands/onboard/auth/index.ts
new file mode 100644
index 0000000000..0f4537b110
--- /dev/null
+++ b/packages/cli/src/commands/onboard/auth/index.ts
@@ -0,0 +1,63 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import inquirer from 'inquirer';
+import { Task } from '../../../lib/tasks';
+import { github, Answers as GitHubAnswers } from './providers/github';
+import { gitlab, Answers as GitLabAnswers } from './providers/gitlab';
+
+export { type GitHubAnswers, type GitLabAnswers };
+
+export async function auth(): Promise<{
+ provider: string;
+ answers: GitHubAnswers | GitLabAnswers;
+}> {
+ const answers = await inquirer.prompt<{
+ provider: string;
+ }>([
+ {
+ type: 'list',
+ name: 'provider',
+ message: 'Please select an authentication provider:',
+ choices: ['GitHub', 'GitLab'],
+ },
+ ]);
+
+ const { provider } = answers;
+
+ let providerAnswers;
+ switch (provider) {
+ case 'GitHub': {
+ providerAnswers = await github();
+ break;
+ }
+ case 'GitLab': {
+ providerAnswers = await gitlab();
+ break;
+ }
+ default:
+ throw new Error(`Provider ${provider} not implemented yet.`);
+ }
+
+ Task.log();
+ Task.log(`Done setting up ${provider} Authentication!`);
+ Task.log();
+
+ return {
+ provider,
+ answers: providerAnswers,
+ };
+}
diff --git a/packages/cli/src/commands/onboard/auth/patch.ts b/packages/cli/src/commands/onboard/auth/patch.ts
new file mode 100644
index 0000000000..d004eeb157
--- /dev/null
+++ b/packages/cli/src/commands/onboard/auth/patch.ts
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as fs from 'fs-extra';
+import * as path from 'path';
+import * as differ from 'diff';
+import { PATCH_FOLDER } from '../files';
+import { findPaths } from '@backstage/cli-common';
+
+/* eslint-disable-next-line no-restricted-syntax */
+const { targetRoot } = findPaths(__dirname);
+
+export const patch = async (patchFile: string) => {
+ const patchContent = await fs.readFile(
+ path.join(PATCH_FOLDER, patchFile),
+ 'utf8',
+ );
+ const targetName = patchContent.split('\n')[0].replace('--- a', '');
+ const targetFile = path.join(targetRoot, targetName);
+ const oldContent = await fs.readFile(targetFile, 'utf8');
+ const newContent = differ.applyPatch(oldContent, patchContent);
+ if (!newContent) {
+ throw new Error(
+ `Patch ${patchFile} was not applied correctly.
+ Did you change ${targetName} manually before running this command?`,
+ );
+ }
+
+ return await fs.writeFile(targetFile, newContent, 'utf8');
+};
diff --git a/packages/cli/src/commands/onboard/auth/patches/01-github.Add-SignInPage.patch b/packages/cli/src/commands/onboard/auth/patches/01-github.Add-SignInPage.patch
new file mode 100644
index 0000000000..db9f5228e8
--- /dev/null
+++ b/packages/cli/src/commands/onboard/auth/patches/01-github.Add-SignInPage.patch
@@ -0,0 +1,25 @@
+--- a/packages/app/src/App.tsx
++++ b/packages/app/src/App.tsx
+@@ -30 +30,5 @@ import { Root } from './components/Root';
+-import { AlertDisplay, OAuthRequestDialog } from '@backstage/core-components';
++import {
++ AlertDisplay,
++ OAuthRequestDialog,
++ SignInPage,
++} from '@backstage/core-components';
+@@ -35,0 +40 @@ import { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common/
++import { githubAuthApiRef } from '@backstage/core-plugin-api';
+@@ -38,0 +44,14 @@ const app = createApp({
++ components: {
++ SignInPage: props => (
++ => {
+ Task.log(`
+ To add GitHub authentication, you must create an OAuth App from the GitHub developer settings: ${chalk.blue(
+ 'https://github.com/settings/developers',
+ )}
+ The Homepage URL should point to Backstage's frontend, while the Authorization callback URL will point to the auth backend.
+
+ Settings for local development:
+ ${chalk.cyan(`
+ Homepage URL: http://localhost:3000
+ Authorization callback URL: http://localhost:7007/api/auth/github/handler/frame`)}
+
+ You can find the full documentation page here: ${chalk.blue(
+ 'https://backstage.io/docs/auth/github/provider',
+ )}
+ `);
+
+ const answers = await inquirer.prompt([
+ {
+ type: 'input',
+ name: 'clientId',
+ message: 'What is your Client Id?',
+ validate: (input: string) => (input.length ? true : false),
+ },
+ {
+ type: 'input',
+ name: 'clientSecret',
+ message: 'What is your Client Secret?',
+ validate: (input: string) => (input.length ? true : false),
+ },
+ {
+ type: 'confirm',
+ name: 'hasEnterprise',
+ message: 'Are you using GitHub Enterprise?',
+ },
+ {
+ type: 'input',
+ name: 'enterpriseInstanceUrl',
+ message: 'What is your URL for GitHub Enterprise?',
+ when: ({ hasEnterprise }) => hasEnterprise,
+ validate: (input: string) => Boolean(new URL(input)),
+ },
+ ]);
+
+ const { clientId, clientSecret } = answers;
+ const config = getConfig(answers);
+
+ Task.log('Setting up GitHub Authentication for you...');
+
+ await Task.forItem(
+ 'Validating',
+ 'credentials',
+ async () => await validateCredentials(clientId, clientSecret),
+ );
+ await Task.forItem(
+ 'Updating',
+ APP_CONFIG_FILE,
+ async () => await updateConfigFile(APP_CONFIG_FILE, config),
+ );
+
+ const patches = await fs.readdir(PATCH_FOLDER);
+ for (const patchFile of patches.filter(p => p.includes('github'))) {
+ await Task.forItem('Patching', patchFile, async () => {
+ await patch(patchFile);
+ });
+ }
+
+ return answers;
+};
diff --git a/packages/cli/src/commands/onboard/auth/providers/gitlab.ts b/packages/cli/src/commands/onboard/auth/providers/gitlab.ts
new file mode 100644
index 0000000000..bc5491111c
--- /dev/null
+++ b/packages/cli/src/commands/onboard/auth/providers/gitlab.ts
@@ -0,0 +1,115 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import chalk from 'chalk';
+import * as fs from 'fs-extra';
+import inquirer from 'inquirer';
+import { Task } from '../../../../lib/tasks';
+import { updateConfigFile } from '../../config';
+import { APP_CONFIG_FILE, PATCH_FOLDER } from '../../files';
+import { patch } from '../patch';
+
+const getConfig = (answers: Answers) => {
+ const { clientId, clientSecret, hasAudience, audience } = answers;
+
+ return {
+ auth: {
+ providers: {
+ gitlab: {
+ development: {
+ clientId,
+ clientSecret,
+ ...(hasAudience && {
+ audience,
+ }),
+ },
+ },
+ },
+ },
+ };
+};
+
+export type Answers = {
+ clientSecret: string;
+ clientId: string;
+ hasAudience: boolean;
+ audience?: string;
+};
+
+export const gitlab = async (): Promise => {
+ Task.log(`
+ To add GitLab authentication, you must create an Application from the GitLab Settings: ${chalk.blue(
+ 'https://gitlab.com/-/profile/applications',
+ )}
+ The Redirect URI should point to your Backstage backend auth handler.
+
+ Settings for local development:
+ ${chalk.cyan(`
+ Name: Backstage (or your custom app name)
+ Redirect URI: http://localhost:7007/api/auth/gitlab/handler/frame
+ Scopes: read_api and read_user`)}
+
+ You can find the full documentation page here: ${chalk.blue(
+ 'https://backstage.io/docs/auth/gitlab/provider',
+ )}
+ `);
+
+ const answers = await inquirer.prompt([
+ {
+ type: 'input',
+ name: 'clientId',
+ message: 'What is your Application Id?',
+ validate: (input: string) => (input.length ? true : false),
+ },
+ {
+ type: 'input',
+ name: 'clientSecret',
+ message: 'What is your Application Secret?',
+ validate: (input: string) => (input.length ? true : false),
+ },
+ {
+ type: 'confirm',
+ name: 'hasAudience',
+ message: 'Do you have a self-hosted instance of GitLab?',
+ },
+ {
+ type: 'input',
+ name: 'audience',
+ message: 'What is the URL for your GitLab instance?',
+ when: ({ hasAudience }) => hasAudience,
+ validate: (input: string) => Boolean(new URL(input)),
+ },
+ ]);
+
+ const config = getConfig(answers);
+
+ Task.log('Setting up GitLab Authentication for you...');
+
+ await Task.forItem(
+ 'Updating',
+ APP_CONFIG_FILE,
+ async () => await updateConfigFile(APP_CONFIG_FILE, config),
+ );
+
+ const patches = await fs.readdir(PATCH_FOLDER);
+ for (const patchFile of patches.filter(p => p.includes('gitlab'))) {
+ await Task.forItem('Patching', patchFile, async () => {
+ await patch(patchFile);
+ });
+ }
+
+ return answers;
+};
diff --git a/packages/cli/src/commands/onboard/command.ts b/packages/cli/src/commands/onboard/command.ts
new file mode 100644
index 0000000000..5cf25953ab
--- /dev/null
+++ b/packages/cli/src/commands/onboard/command.ts
@@ -0,0 +1,69 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import chalk from 'chalk';
+import inquirer from 'inquirer';
+import { Task } from '../../lib/tasks';
+import { auth } from './auth';
+import { integrations } from './integrations';
+
+export async function command(): Promise {
+ const answers = await inquirer.prompt<{
+ shouldSetupAuth: boolean;
+ shouldSetupScaffolder: boolean;
+ }>([
+ {
+ type: 'confirm',
+ name: 'shouldSetupAuth',
+ message: 'Do you want to set up Authentication for this project?',
+ default: true,
+ },
+ {
+ type: 'confirm',
+ name: 'shouldSetupScaffolder',
+ message: 'Do you want to use Software Templates in this project?',
+ default: true,
+ },
+ ]);
+
+ const { shouldSetupAuth, shouldSetupScaffolder } = answers;
+
+ let providerInfo;
+ if (shouldSetupAuth) {
+ providerInfo = await auth();
+ }
+
+ if (shouldSetupScaffolder) {
+ await integrations(providerInfo);
+ }
+
+ if (!shouldSetupAuth && !shouldSetupScaffolder) {
+ Task.log(
+ chalk.yellow(
+ 'If you change your mind, feel free to re-run this command.',
+ ),
+ );
+ return;
+ }
+
+ Task.log();
+ Task.log(
+ `You can now start your app with ${chalk.inverse(
+ chalk.italic('yarn dev'),
+ )}`,
+ );
+ Task.log();
+}
diff --git a/packages/cli/src/commands/onboard/config.ts b/packages/cli/src/commands/onboard/config.ts
new file mode 100644
index 0000000000..cce3119fcc
--- /dev/null
+++ b/packages/cli/src/commands/onboard/config.ts
@@ -0,0 +1,45 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as fs from 'fs-extra';
+import yaml from 'yaml';
+
+const readYaml = async (file: string) => {
+ return yaml.parse(await fs.readFile(file, 'utf8'));
+};
+
+export const updateConfigFile = async (file: string, config: T) => {
+ const staticContent =
+ '# Backstage override configuration for your local development environment \n';
+
+ const content = fs.existsSync(file)
+ ? yaml.stringify(
+ { ...(await readYaml(file)), ...config },
+ {
+ indent: 2,
+ },
+ )
+ : staticContent.concat(
+ yaml.stringify(
+ { ...config },
+ {
+ indent: 2,
+ },
+ ),
+ );
+
+ return await fs.writeFile(file, content, 'utf8');
+};
diff --git a/packages/cli/src/commands/onboard/files.ts b/packages/cli/src/commands/onboard/files.ts
new file mode 100644
index 0000000000..17f8a0f85e
--- /dev/null
+++ b/packages/cli/src/commands/onboard/files.ts
@@ -0,0 +1,30 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { findPaths } from '@backstage/cli-common';
+import * as path from 'path';
+
+/* eslint-disable-next-line no-restricted-syntax */
+const { targetRoot, ownDir } = findPaths(__dirname);
+export const APP_CONFIG_FILE = path.join(targetRoot, 'app-config.local.yaml');
+export const PATCH_FOLDER = path.join(
+ ownDir,
+ 'src',
+ 'commands',
+ 'onboard',
+ 'auth',
+ 'patches',
+);
diff --git a/packages/cli/src/commands/onboard/index.ts b/packages/cli/src/commands/onboard/index.ts
new file mode 100644
index 0000000000..4c23ea6e48
--- /dev/null
+++ b/packages/cli/src/commands/onboard/index.ts
@@ -0,0 +1,17 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export { command } from './command';
diff --git a/packages/cli/src/commands/onboard/integrations/github.ts b/packages/cli/src/commands/onboard/integrations/github.ts
new file mode 100644
index 0000000000..a0538c7ace
--- /dev/null
+++ b/packages/cli/src/commands/onboard/integrations/github.ts
@@ -0,0 +1,136 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import chalk from 'chalk';
+import inquirer from 'inquirer';
+import { Task } from '../../../lib/tasks';
+import { updateConfigFile } from '../config';
+import { APP_CONFIG_FILE } from '../files';
+import { GitHubAnswers } from '../auth';
+
+type Answers = {
+ hasEnterprise: boolean;
+ enterpriseInstanceUrl: string;
+ apiBaseUrl: string;
+};
+
+const getConfig = ({
+ hasEnterprise,
+ apiBaseUrl,
+ host,
+ token,
+}: {
+ hasEnterprise: boolean;
+ apiBaseUrl: string;
+ host: string;
+ token: string;
+}) => ({
+ integrations: {
+ github: [
+ {
+ host,
+ token,
+ ...(hasEnterprise && {
+ apiBaseUrl,
+ }),
+ },
+ ],
+ },
+});
+
+export const github = async (providerAnswers?: GitHubAnswers) => {
+ // TODO(tudi2d): Is GitHub Enterprise a valid setup if there is no Authentication?
+ const answers = await inquirer.prompt([
+ {
+ type: 'confirm',
+ name: 'hasEnterprise',
+ message: 'Are you using GitHub Enterprise?',
+ when: () => typeof providerAnswers === 'undefined',
+ },
+ {
+ type: 'input',
+ name: 'enterpriseInstanceUrl',
+ message: 'What is your URL for GitHub Enterprise?',
+ when: ({ hasEnterprise }) => hasEnterprise,
+ validate: (input: string) => Boolean(new URL(input)),
+ },
+ {
+ type: 'input',
+ name: 'apiBaseUrl',
+ message: 'What is your GitHub Enterprise API path?',
+ default: '/api/v3',
+ when: ({ hasEnterprise }) =>
+ hasEnterprise || providerAnswers?.hasEnterprise,
+ // TODO(tudi2d): Fetch API using OAuth Token if Auth was set up
+ },
+ ]);
+
+ const host = new URL(
+ providerAnswers?.enterpriseInstanceUrl ??
+ answers?.enterpriseInstanceUrl ??
+ 'http://github.com',
+ );
+
+ Task.log(`
+ To create new repositories in GitHub using Software Templates you first need to create a personal access token: ${chalk.blue(
+ `${host.origin}/settings/tokens/new`,
+ )}
+
+ Select the following scopes:
+
+ Reading software components:${chalk.cyan(`
+ - "repo"`)}
+
+ Reading organization data:${chalk.cyan(`
+ - "read:org"
+ - "read:user"
+ - "user:email"`)}
+
+ Publishing software templates:${chalk.cyan(`
+ - "repo"
+ - "workflow" (if templates include GitHub workflows)
+ `)}
+
+ You can find the full documentation page here: ${chalk.blue(
+ 'https://backstage.io/docs/integrations/github/locations',
+ )}
+ `);
+
+ const { token } = await inquirer.prompt<{ token: string }>([
+ {
+ type: 'input',
+ name: 'token',
+ message:
+ 'Please insert your personal access token to setup the GitHub Integration',
+ // TODO(tudi2d): validate
+ },
+ ]);
+
+ const config = getConfig({
+ hasEnterprise: providerAnswers?.hasEnterprise ?? answers.hasEnterprise,
+ apiBaseUrl: host.origin + answers.apiBaseUrl,
+ host: host.hostname,
+ token,
+ });
+
+ Task.log('Setting up Software Templates using GitHub integration for you...');
+
+ await Task.forItem(
+ 'Updating',
+ APP_CONFIG_FILE,
+ async () => await updateConfigFile(APP_CONFIG_FILE, config),
+ );
+};
diff --git a/packages/cli/src/commands/onboard/integrations/index.ts b/packages/cli/src/commands/onboard/integrations/index.ts
new file mode 100644
index 0000000000..5cb2f95b38
--- /dev/null
+++ b/packages/cli/src/commands/onboard/integrations/index.ts
@@ -0,0 +1,75 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import inquirer from 'inquirer';
+import { Task } from '../../../lib/tasks';
+import { GitHubAnswers, GitLabAnswers } from '../auth';
+import { github } from './github';
+
+enum Integration {
+ GITHUB = 'GitHub',
+}
+
+const Integrations: Integration[] = [Integration.GITHUB];
+
+export async function integrations(providerInfo?: {
+ provider: string;
+ answers: GitHubAnswers | GitLabAnswers;
+}): Promise {
+ const answers = await inquirer.prompt<{
+ integration?: Integration;
+ shouldUsePreviousProvider: boolean;
+ }>([
+ {
+ type: 'confirm',
+ name: 'shouldUsePreviousProvider',
+ message: `Do you want to keep using ${providerInfo?.provider} as your provider when setting up Software Templates?`,
+ when: () =>
+ providerInfo?.provider &&
+ Object.values(Integrations).includes(
+ providerInfo!.provider as Integration,
+ ),
+ },
+ {
+ // TODO(tudi2d): Let's start with one, but it should be multiple choice in the future
+ type: 'list',
+ name: 'integration',
+ message: 'Please select an integration provider:',
+ choices: Integrations,
+ when: ({ shouldUsePreviousProvider }) => !shouldUsePreviousProvider,
+ },
+ ]);
+
+ if (answers.shouldUsePreviousProvider) {
+ answers.integration = providerInfo!.provider as Integration;
+ }
+
+ switch (answers.integration) {
+ case Integration.GITHUB: {
+ const providerAnswers =
+ providerInfo?.provider === 'GitHub'
+ ? (providerInfo!.answers as GitHubAnswers)
+ : undefined;
+ await github(providerAnswers);
+ break;
+ }
+ default:
+ }
+
+ Task.log();
+ Task.log(`Done setting up ${answers.integration} Integration!`);
+ Task.log();
+}
diff --git a/packages/cli/src/lib/builder/config.ts b/packages/cli/src/lib/builder/config.ts
index ecd755d05b..7bd10cfcc3 100644
--- a/packages/cli/src/lib/builder/config.ts
+++ b/packages/cli/src/lib/builder/config.ts
@@ -75,116 +75,126 @@ export async function makeRollupConfigs(
const distDir = resolvePath(targetDir, 'dist');
const entryPoints = readEntryPoints(targetPkg);
- for (const { path, name, ext } of entryPoints) {
- if (!SCRIPT_EXTS.includes(ext)) {
- continue;
- }
+ const scriptEntryPoints = entryPoints.filter(e =>
+ SCRIPT_EXTS.includes(e.ext),
+ );
- if (options.outputs.has(Output.cjs) || options.outputs.has(Output.esm)) {
- const output = new Array();
- const mainFields = ['module', 'main'];
+ if (options.outputs.has(Output.cjs) || options.outputs.has(Output.esm)) {
+ const output = new Array();
+ const mainFields = ['module', 'main'];
- if (options.outputs.has(Output.cjs)) {
- output.push({
- dir: distDir,
- entryFileNames: `${name}.cjs.js`,
- chunkFileNames: `cjs/${name}/[name]-[hash].cjs.js`,
- format: 'commonjs',
- sourcemap: true,
- });
- }
- if (options.outputs.has(Output.esm)) {
- output.push({
- dir: distDir,
- entryFileNames: `${name}.esm.js`,
- chunkFileNames: `esm/${name}/[name]-[hash].esm.js`,
- format: 'module',
- sourcemap: true,
- });
- // Assume we're building for the browser if ESM output is included
- mainFields.unshift('browser');
- }
-
- configs.push({
- input: resolvePath(targetDir, path),
- output,
- onwarn,
- preserveEntrySignatures: 'strict',
- // All module imports are always marked as external
- external: (source, importer, isResolved) =>
- Boolean(importer && !isResolved && !isFileImport(source)),
- plugins: [
- resolve({ mainFields }),
- commonjs({
- include: /node_modules/,
- exclude: [/\/[^/]+\.(?:stories|test)\.[^/]+$/],
- }),
- postcss(),
- forwardFileImports({
- exclude: /\.icon\.svg$/,
- include: [
- /\.svg$/,
- /\.png$/,
- /\.gif$/,
- /\.jpg$/,
- /\.jpeg$/,
- /\.eot$/,
- /\.woff$/,
- /\.woff2$/,
- /\.ttf$/,
- ],
- }),
- json(),
- yaml(),
- svgr({
- include: /\.icon\.svg$/,
- template: svgrTemplate,
- }),
- esbuild({
- target: 'es2019',
- minify: options.minify,
- }),
- ],
+ if (options.outputs.has(Output.cjs)) {
+ output.push({
+ dir: distDir,
+ entryFileNames: `[name].cjs.js`,
+ chunkFileNames: `cjs/[name]-[hash].cjs.js`,
+ format: 'commonjs',
+ sourcemap: true,
});
}
+ if (options.outputs.has(Output.esm)) {
+ output.push({
+ dir: distDir,
+ entryFileNames: `[name].esm.js`,
+ chunkFileNames: `esm/[name]-[hash].esm.js`,
+ format: 'module',
+ sourcemap: true,
+ });
+ // Assume we're building for the browser if ESM output is included
+ mainFields.unshift('browser');
+ }
- if (options.outputs.has(Output.types) && !options.useApiExtractor) {
- const typesInput = paths.resolveTargetRoot(
- 'dist-types',
- relativePath(paths.targetRoot, targetDir),
- path.replace(/\.ts$/, '.d.ts'),
- );
+ configs.push({
+ input: Object.fromEntries(
+ scriptEntryPoints.map(e => [e.name, resolvePath(targetDir, e.path)]),
+ ),
+ output,
+ onwarn,
+ preserveEntrySignatures: 'strict',
+ // All module imports are always marked as external
+ external: (source, importer, isResolved) =>
+ Boolean(importer && !isResolved && !isFileImport(source)),
+ plugins: [
+ resolve({ mainFields }),
+ commonjs({
+ include: /node_modules/,
+ exclude: [/\/[^/]+\.(?:stories|test)\.[^/]+$/],
+ }),
+ postcss(),
+ forwardFileImports({
+ exclude: /\.icon\.svg$/,
+ include: [
+ /\.svg$/,
+ /\.png$/,
+ /\.gif$/,
+ /\.jpg$/,
+ /\.jpeg$/,
+ /\.eot$/,
+ /\.woff$/,
+ /\.woff2$/,
+ /\.ttf$/,
+ /\.md$/,
+ ],
+ }),
+ json(),
+ yaml(),
+ svgr({
+ include: /\.icon\.svg$/,
+ template: svgrTemplate,
+ }),
+ esbuild({
+ target: 'es2019',
+ minify: options.minify,
+ }),
+ ],
+ });
+ }
- const declarationsExist = await fs.pathExists(typesInput);
+ if (options.outputs.has(Output.types) && !options.useApiExtractor) {
+ const input = Object.fromEntries(
+ scriptEntryPoints.map(e => [
+ e.name,
+ paths.resolveTargetRoot(
+ 'dist-types',
+ relativePath(paths.targetRoot, targetDir),
+ e.path.replace(/\.ts$/, '.d.ts'),
+ ),
+ ]),
+ );
+
+ for (const path of Object.values(input)) {
+ const declarationsExist = await fs.pathExists(path);
if (!declarationsExist) {
- const declarationPath = relativePath(targetDir, typesInput);
+ const declarationPath = relativePath(targetDir, path);
throw new Error(
`No declaration files found at ${declarationPath}, be sure to run ${chalk.bgRed.white(
'yarn tsc',
)} to generate .d.ts files before packaging`,
);
}
-
- configs.push({
- input: typesInput,
- output: {
- file: resolvePath(distDir, `${name}.d.ts`),
- format: 'es',
- },
- external: [
- /\.css$/,
- /\.scss$/,
- /\.sass$/,
- /\.svg$/,
- /\.eot$/,
- /\.woff$/,
- /\.woff2$/,
- /\.ttf$/,
- ],
- onwarn,
- plugins: [dts()],
- });
}
+
+ configs.push({
+ input,
+ output: {
+ dir: distDir,
+ entryFileNames: `[name].d.ts`,
+ chunkFileNames: `types/[name]-[hash].d.ts`,
+ format: 'es',
+ },
+ external: [
+ /\.css$/,
+ /\.scss$/,
+ /\.sass$/,
+ /\.svg$/,
+ /\.eot$/,
+ /\.woff$/,
+ /\.woff2$/,
+ /\.ttf$/,
+ ],
+ onwarn,
+ plugins: [dts()],
+ });
}
return configs;
diff --git a/packages/cli/src/lib/bundler/config.ts b/packages/cli/src/lib/bundler/config.ts
index 01f323a082..6fc7482dce 100644
--- a/packages/cli/src/lib/bundler/config.ts
+++ b/packages/cli/src/lib/bundler/config.ts
@@ -15,7 +15,7 @@
*/
import fs from 'fs-extra';
-import { resolve as resolvePath, join as joinPath } from 'path';
+import { resolve as resolvePath, posix as posixPath } from 'path';
import ForkTsCheckerWebpackPlugin from 'fork-ts-checker-webpack-plugin';
import HtmlWebpackPlugin from 'html-webpack-plugin';
import ModuleScopePlugin from 'react-dev-utils/ModuleScopePlugin';
@@ -236,7 +236,7 @@ export async function createBackendConfig(
const { packages } = await getPackages(cliPaths.targetDir);
const localPackageEntryPoints = packages.flatMap(p => {
const entryPoints = readEntryPoints((p as ExtendedPackage).packageJson);
- return entryPoints.map(e => joinPath(p.packageJson.name, e.mount));
+ return entryPoints.map(e => posixPath.join(p.packageJson.name, e.mount));
});
const moduleDirs = packages.map(p => resolvePath(p.dir, 'node_modules'));
// See frontend config
diff --git a/packages/cli/src/lib/new/factories/index.ts b/packages/cli/src/lib/new/factories/index.ts
index 80a24702e0..232e762b91 100644
--- a/packages/cli/src/lib/new/factories/index.ts
+++ b/packages/cli/src/lib/new/factories/index.ts
@@ -18,4 +18,6 @@ export { frontendPlugin } from './frontendPlugin';
export { backendPlugin } from './backendPlugin';
export { webLibraryPackage } from './webLibraryPackage';
export { pluginCommon } from './pluginCommon';
+export { pluginNode } from './pluginNode';
+export { pluginWeb } from './pluginWeb';
export { scaffolderModule } from './scaffolderModule';
diff --git a/packages/cli/src/lib/new/factories/pluginNode.test.ts b/packages/cli/src/lib/new/factories/pluginNode.test.ts
new file mode 100644
index 0000000000..50971ff191
--- /dev/null
+++ b/packages/cli/src/lib/new/factories/pluginNode.test.ts
@@ -0,0 +1,107 @@
+/*
+ * 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 fs from 'fs-extra';
+import mockFs from 'mock-fs';
+import { sep, resolve as resolvePath } from 'path';
+import { paths } from '../../paths';
+import { Task } from '../../tasks';
+import { FactoryRegistry } from '../FactoryRegistry';
+import { createMockOutputStream, mockPaths } from './common/testUtils';
+import { pluginNode } from './pluginNode';
+
+describe('pluginNode factory', () => {
+ beforeEach(() => {
+ mockPaths({
+ targetRoot: '/root',
+ });
+ });
+
+ afterEach(() => {
+ mockFs.restore();
+ jest.resetAllMocks();
+ });
+
+ it('should create a node plugin package', async () => {
+ mockFs({
+ '/root': {
+ plugins: mockFs.directory(),
+ },
+ [paths.resolveOwn('templates')]: mockFs.load(
+ paths.resolveOwn('templates'),
+ ),
+ });
+
+ const options = await FactoryRegistry.populateOptions(pluginNode, {
+ id: 'test',
+ });
+
+ let modified = false;
+
+ const [output, mockStream] = createMockOutputStream();
+ jest.spyOn(process, 'stderr', 'get').mockReturnValue(mockStream);
+ jest.spyOn(Task, 'forCommand').mockResolvedValue();
+
+ await pluginNode.create(options, {
+ private: true,
+ isMonoRepo: true,
+ defaultVersion: '1.0.0',
+ markAsModified: () => {
+ modified = true;
+ },
+ createTemporaryDirectory: () => fs.mkdtemp('test'),
+ });
+
+ expect(modified).toBe(true);
+
+ expect(output).toEqual([
+ '',
+ 'Creating Node.js plugin library backstage-plugin-test-node',
+ 'Checking Prerequisites:',
+ `availability plugins${sep}test-node`,
+ 'creating temp dir',
+ 'Executing Template:',
+ 'copying .eslintrc.js',
+ 'templating README.md.hbs',
+ 'templating package.json.hbs',
+ 'templating index.ts.hbs',
+ 'copying setupTests.ts',
+ 'Installing:',
+ `moving plugins${sep}test-node`,
+ ]);
+
+ await expect(
+ fs.readJson('/root/plugins/test-node/package.json'),
+ ).resolves.toEqual(
+ expect.objectContaining({
+ name: 'backstage-plugin-test-node',
+ description: 'Node.js library for the test plugin',
+ private: true,
+ version: '1.0.0',
+ }),
+ );
+
+ expect(Task.forCommand).toHaveBeenCalledTimes(2);
+ expect(Task.forCommand).toHaveBeenCalledWith('yarn install', {
+ cwd: resolvePath('/root/plugins/test-node'),
+ optional: true,
+ });
+ expect(Task.forCommand).toHaveBeenCalledWith('yarn lint --fix', {
+ cwd: resolvePath('/root/plugins/test-node'),
+ optional: true,
+ });
+ });
+});
diff --git a/packages/cli/src/lib/new/factories/pluginNode.ts b/packages/cli/src/lib/new/factories/pluginNode.ts
new file mode 100644
index 0000000000..44dbea9fce
--- /dev/null
+++ b/packages/cli/src/lib/new/factories/pluginNode.ts
@@ -0,0 +1,74 @@
+/*
+ * 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 chalk from 'chalk';
+import { paths } from '../../paths';
+import { addCodeownersEntry, getCodeownersFilePath } from '../../codeowners';
+import { createFactory, CreateContext } from '../types';
+import { Task } from '../../tasks';
+import { ownerPrompt, pluginIdPrompt } from './common/prompts';
+import { executePluginPackageTemplate } from './common/tasks';
+
+type Options = {
+ id: string;
+ owner?: string;
+ codeOwnersPath?: string;
+};
+
+export const pluginNode = createFactory({
+ name: 'plugin-node',
+ description: 'A new Node.js library plugin package',
+ optionsDiscovery: async () => ({
+ codeOwnersPath: await getCodeownersFilePath(paths.targetRoot),
+ }),
+ optionsPrompts: [pluginIdPrompt(), ownerPrompt()],
+ async create(options: Options, ctx: CreateContext) {
+ const { id } = options;
+ const suffix = `${id}-node`;
+ const name = ctx.scope
+ ? `@${ctx.scope}/plugin-${suffix}`
+ : `backstage-plugin-${suffix}`;
+
+ Task.log();
+ Task.log(`Creating Node.js plugin library ${chalk.cyan(name)}`);
+
+ const targetDir = ctx.isMonoRepo
+ ? paths.resolveTargetRoot('plugins', suffix)
+ : paths.resolveTargetRoot(`backstage-plugin-${suffix}`);
+
+ await executePluginPackageTemplate(ctx, {
+ targetDir,
+ templateName: 'default-node-plugin-package',
+ values: {
+ id,
+ name,
+ privatePackage: ctx.private,
+ npmRegistry: ctx.npmRegistry,
+ pluginVersion: ctx.defaultVersion,
+ },
+ });
+
+ if (options.owner) {
+ await addCodeownersEntry(`/plugins/${suffix}`, options.owner);
+ }
+
+ await Task.forCommand('yarn install', { cwd: targetDir, optional: true });
+ await Task.forCommand('yarn lint --fix', {
+ cwd: targetDir,
+ optional: true,
+ });
+ },
+});
diff --git a/packages/cli/src/lib/new/factories/pluginWeb.test.ts b/packages/cli/src/lib/new/factories/pluginWeb.test.ts
new file mode 100644
index 0000000000..bcd62f3bcd
--- /dev/null
+++ b/packages/cli/src/lib/new/factories/pluginWeb.test.ts
@@ -0,0 +1,114 @@
+/*
+ * 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 fs from 'fs-extra';
+import mockFs from 'mock-fs';
+import { sep, resolve as resolvePath } from 'path';
+import { paths } from '../../paths';
+import { Task } from '../../tasks';
+import { FactoryRegistry } from '../FactoryRegistry';
+import { createMockOutputStream, mockPaths } from './common/testUtils';
+import { pluginWeb } from './pluginWeb';
+
+describe('pluginWeb factory', () => {
+ beforeEach(() => {
+ mockPaths({
+ targetRoot: '/root',
+ });
+ });
+
+ afterEach(() => {
+ mockFs.restore();
+ jest.resetAllMocks();
+ });
+
+ it('should create a react plugin package', async () => {
+ mockFs({
+ '/root': {
+ plugins: mockFs.directory(),
+ },
+ [paths.resolveOwn('templates')]: mockFs.load(
+ paths.resolveOwn('templates'),
+ ),
+ });
+
+ const options = await FactoryRegistry.populateOptions(pluginWeb, {
+ id: 'test',
+ });
+
+ let modified = false;
+
+ const [output, mockStream] = createMockOutputStream();
+ jest.spyOn(process, 'stderr', 'get').mockReturnValue(mockStream);
+ jest.spyOn(Task, 'forCommand').mockResolvedValue();
+
+ await pluginWeb.create(options, {
+ private: true,
+ isMonoRepo: true,
+ defaultVersion: '1.0.0',
+ markAsModified: () => {
+ modified = true;
+ },
+ createTemporaryDirectory: () => fs.mkdtemp('test'),
+ });
+
+ expect(modified).toBe(true);
+
+ expect(output).toEqual([
+ '',
+ 'Creating web plugin library backstage-plugin-test-react',
+ 'Checking Prerequisites:',
+ `availability plugins${sep}test-react`,
+ 'creating temp dir',
+ 'Executing Template:',
+ 'copying .eslintrc.js',
+ 'templating README.md.hbs',
+ 'templating package.json.hbs',
+ 'templating index.ts.hbs',
+ 'copying setupTests.ts',
+ 'copying index.ts',
+ 'copying ExampleComponent.test.tsx',
+ 'copying ExampleComponent.tsx',
+ 'copying index.ts',
+ 'copying index.ts',
+ 'copying index.ts',
+ 'copying useExample.ts',
+ 'Installing:',
+ `moving plugins${sep}test-react`,
+ ]);
+
+ await expect(
+ fs.readJson('/root/plugins/test-react/package.json'),
+ ).resolves.toEqual(
+ expect.objectContaining({
+ name: 'backstage-plugin-test-react',
+ description: 'Web library for the test plugin',
+ private: true,
+ version: '1.0.0',
+ }),
+ );
+
+ expect(Task.forCommand).toHaveBeenCalledTimes(2);
+ expect(Task.forCommand).toHaveBeenCalledWith('yarn install', {
+ cwd: resolvePath('/root/plugins/test-react'),
+ optional: true,
+ });
+ expect(Task.forCommand).toHaveBeenCalledWith('yarn lint --fix', {
+ cwd: resolvePath('/root/plugins/test-react'),
+ optional: true,
+ });
+ });
+});
diff --git a/packages/cli/src/lib/new/factories/pluginWeb.ts b/packages/cli/src/lib/new/factories/pluginWeb.ts
new file mode 100644
index 0000000000..8189654eb2
--- /dev/null
+++ b/packages/cli/src/lib/new/factories/pluginWeb.ts
@@ -0,0 +1,74 @@
+/*
+ * 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 chalk from 'chalk';
+import { paths } from '../../paths';
+import { addCodeownersEntry, getCodeownersFilePath } from '../../codeowners';
+import { createFactory, CreateContext } from '../types';
+import { Task } from '../../tasks';
+import { ownerPrompt, pluginIdPrompt } from './common/prompts';
+import { executePluginPackageTemplate } from './common/tasks';
+
+type Options = {
+ id: string;
+ owner?: string;
+ codeOwnersPath?: string;
+};
+
+export const pluginWeb = createFactory({
+ name: 'plugin-react',
+ description: 'A new web library plugin package',
+ optionsDiscovery: async () => ({
+ codeOwnersPath: await getCodeownersFilePath(paths.targetRoot),
+ }),
+ optionsPrompts: [pluginIdPrompt(), ownerPrompt()],
+ async create(options: Options, ctx: CreateContext) {
+ const { id } = options;
+ const suffix = `${id}-react`;
+ const name = ctx.scope
+ ? `@${ctx.scope}/plugin-${suffix}`
+ : `backstage-plugin-${suffix}`;
+
+ Task.log();
+ Task.log(`Creating web plugin library ${chalk.cyan(name)}`);
+
+ const targetDir = ctx.isMonoRepo
+ ? paths.resolveTargetRoot('plugins', suffix)
+ : paths.resolveTargetRoot(`backstage-plugin-${suffix}`);
+
+ await executePluginPackageTemplate(ctx, {
+ targetDir,
+ templateName: 'default-react-plugin-package',
+ values: {
+ id,
+ name,
+ privatePackage: ctx.private,
+ npmRegistry: ctx.npmRegistry,
+ pluginVersion: ctx.defaultVersion,
+ },
+ });
+
+ if (options.owner) {
+ await addCodeownersEntry(`/plugins/${suffix}`, options.owner);
+ }
+
+ await Task.forCommand('yarn install', { cwd: targetDir, optional: true });
+ await Task.forCommand('yarn lint --fix', {
+ cwd: targetDir,
+ optional: true,
+ });
+ },
+});
diff --git a/packages/cli/templates/default-node-plugin-package/.eslintrc.js b/packages/cli/templates/default-node-plugin-package/.eslintrc.js
new file mode 100644
index 0000000000..e2a53a6ad2
--- /dev/null
+++ b/packages/cli/templates/default-node-plugin-package/.eslintrc.js
@@ -0,0 +1 @@
+module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);
diff --git a/packages/cli/templates/default-node-plugin-package/README.md.hbs b/packages/cli/templates/default-node-plugin-package/README.md.hbs
new file mode 100644
index 0000000000..a9fc97935e
--- /dev/null
+++ b/packages/cli/templates/default-node-plugin-package/README.md.hbs
@@ -0,0 +1,5 @@
+# {{name}}
+
+Welcome to the Node.js library package for the {{id}} plugin!
+
+_This plugin was created through the Backstage CLI_
diff --git a/packages/cli/templates/default-node-plugin-package/package.json.hbs b/packages/cli/templates/default-node-plugin-package/package.json.hbs
new file mode 100644
index 0000000000..45becd1bea
--- /dev/null
+++ b/packages/cli/templates/default-node-plugin-package/package.json.hbs
@@ -0,0 +1,36 @@
+{
+ "name": "{{name}}",
+ "description": "Node.js library for the {{id}} plugin",
+ "version": "{{pluginVersion}}",
+ "main": "src/index.ts",
+ "types": "src/index.ts",
+ "license": "Apache-2.0",
+{{#if privatePackage}}
+ "private": {{privatePackage}},
+{{/if}}
+ "publishConfig": {
+{{#if npmRegistry}}
+ "registry": "{{npmRegistry}}",
+{{/if}}
+ "access": "public",
+ "main": "dist/index.cjs.js",
+ "types": "dist/index.d.ts"
+ },
+ "backstage": {
+ "role": "node-library"
+ },
+ "scripts": {
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "clean": "backstage-cli package clean",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack"
+ },
+ "devDependencies": {
+ "@backstage/cli": "{{versionQuery '@backstage/cli'}}"
+ },
+ "files": [
+ "dist"
+ ]
+}
diff --git a/packages/cli/templates/default-node-plugin-package/src/index.ts.hbs b/packages/cli/templates/default-node-plugin-package/src/index.ts.hbs
new file mode 100644
index 0000000000..355b35c373
--- /dev/null
+++ b/packages/cli/templates/default-node-plugin-package/src/index.ts.hbs
@@ -0,0 +1,18 @@
+/***/
+/**
+ * Node.js library for the {{id}} plugin.
+ *
+ * @packageDocumentation
+ */
+
+// In this package you might for example export functions that
+// help other plugins or modules interact with your plugin.
+
+/**
+ * Does something useful.
+ *
+ * @public
+ */
+export function someFunction() {
+ // ...
+}
diff --git a/packages/cli/templates/default-node-plugin-package/src/setupTests.ts b/packages/cli/templates/default-node-plugin-package/src/setupTests.ts
new file mode 100644
index 0000000000..cb0ff5c3b5
--- /dev/null
+++ b/packages/cli/templates/default-node-plugin-package/src/setupTests.ts
@@ -0,0 +1 @@
+export {};
diff --git a/packages/cli/templates/default-node-plugin-package/tsconfig.json b/packages/cli/templates/default-node-plugin-package/tsconfig.json
new file mode 100644
index 0000000000..5ae9aeb62d
--- /dev/null
+++ b/packages/cli/templates/default-node-plugin-package/tsconfig.json
@@ -0,0 +1,9 @@
+{
+ "extends": "@backstage/cli/config/tsconfig.json",
+ "include": ["src"],
+ "exclude": ["node_modules"],
+ "compilerOptions": {
+ "outDir": "dist-types",
+ "rootDir": "."
+ }
+}
diff --git a/packages/cli/templates/default-plugin/package.json.hbs b/packages/cli/templates/default-plugin/package.json.hbs
index de42f3cdef..10f893d7dc 100644
--- a/packages/cli/templates/default-plugin/package.json.hbs
+++ b/packages/cli/templates/default-plugin/package.json.hbs
@@ -33,7 +33,7 @@
"@backstage/theme": "{{versionQuery '@backstage/theme'}}",
"@material-ui/core": "{{versionQuery '@material-ui/core' '4.12.2'}}",
"@material-ui/icons": "{{versionQuery '@material-ui/icons' '4.9.1'}}",
- "@material-ui/lab": "{{versionQuery '@material-ui/lab' '4.0.0-alpha.57'}}",
+ "@material-ui/lab": "{{versionQuery '@material-ui/lab' '4.0.0-alpha.61'}}",
"react-use": "{{versionQuery 'react-use' '17.2.4'}}"
},
"peerDependencies": {
diff --git a/packages/cli/templates/default-react-plugin-package/.eslintrc.js b/packages/cli/templates/default-react-plugin-package/.eslintrc.js
new file mode 100644
index 0000000000..e2a53a6ad2
--- /dev/null
+++ b/packages/cli/templates/default-react-plugin-package/.eslintrc.js
@@ -0,0 +1 @@
+module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);
diff --git a/packages/cli/templates/default-react-plugin-package/README.md.hbs b/packages/cli/templates/default-react-plugin-package/README.md.hbs
new file mode 100644
index 0000000000..ab1c36da6b
--- /dev/null
+++ b/packages/cli/templates/default-react-plugin-package/README.md.hbs
@@ -0,0 +1,5 @@
+# {{name}}
+
+Welcome to the web library package for the {{id}} plugin!
+
+_This plugin was created through the Backstage CLI_
diff --git a/packages/cli/templates/default-react-plugin-package/package.json.hbs b/packages/cli/templates/default-react-plugin-package/package.json.hbs
new file mode 100644
index 0000000000..e0ee408eda
--- /dev/null
+++ b/packages/cli/templates/default-react-plugin-package/package.json.hbs
@@ -0,0 +1,47 @@
+{
+ "name": "{{name}}",
+ "description": "Web library for the {{id}} plugin",
+ "version": "{{pluginVersion}}",
+ "main": "src/index.ts",
+ "types": "src/index.ts",
+ "license": "Apache-2.0",
+{{#if privatePackage}}
+ "private": {{privatePackage}},
+{{/if}}
+ "publishConfig": {
+{{#if npmRegistry}}
+ "registry": "{{npmRegistry}}",
+{{/if}}
+ "access": "public",
+ "main": "dist/index.esm.js",
+ "types": "dist/index.d.ts"
+ },
+ "backstage": {
+ "role": "web-library"
+ },
+ "scripts": {
+ "start": "backstage-cli package start",
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "clean": "backstage-cli package clean",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack"
+ },
+ "dependencies": {
+ "@backstage/core-plugin-api": "{{versionQuery '@backstage/core-plugin-api'}}",
+ "@material-ui/core": "{{versionQuery '@material-ui/core' '4.12.2'}}"
+ },
+ "peerDependencies": {
+ "react": "{{versionQuery 'react' '^16.13.1 || ^17.0.0'}}"
+ },
+ "devDependencies": {
+ "@backstage/cli": "{{versionQuery '@backstage/cli'}}",
+ "@backstage/test-utils": "{{versionQuery '@backstage/test-utils'}}",
+ "@testing-library/jest-dom": "{{versionQuery '@testing-library/jest-dom' '5.10.1'}}",
+ "@testing-library/react": "{{versionQuery '@testing-library/react' '12.1.3'}}"
+ },
+ "files": [
+ "dist"
+ ]
+}
diff --git a/packages/cli/templates/default-react-plugin-package/src/components/ExampleComponent/ExampleComponent.test.tsx b/packages/cli/templates/default-react-plugin-package/src/components/ExampleComponent/ExampleComponent.test.tsx
new file mode 100644
index 0000000000..c770cca8cb
--- /dev/null
+++ b/packages/cli/templates/default-react-plugin-package/src/components/ExampleComponent/ExampleComponent.test.tsx
@@ -0,0 +1,18 @@
+import React from 'react';
+import { screen } from '@testing-library/react';
+import { renderInTestApp } from '@backstage/test-utils';
+import { ExampleComponent } from './ExampleComponent';
+
+describe('ExampleComponent', () => {
+ it('should render', async () => {
+ await renderInTestApp({message} ;
+}
diff --git a/packages/cli/templates/default-react-plugin-package/src/components/ExampleComponent/index.ts b/packages/cli/templates/default-react-plugin-package/src/components/ExampleComponent/index.ts
new file mode 100644
index 0000000000..9bb2f2c378
--- /dev/null
+++ b/packages/cli/templates/default-react-plugin-package/src/components/ExampleComponent/index.ts
@@ -0,0 +1,2 @@
+export { ExampleComponent } from './ExampleComponent';
+export type { ExampleComponentProps } from './ExampleComponent';
diff --git a/packages/cli/templates/default-react-plugin-package/src/components/index.ts b/packages/cli/templates/default-react-plugin-package/src/components/index.ts
new file mode 100644
index 0000000000..0380b8ce5f
--- /dev/null
+++ b/packages/cli/templates/default-react-plugin-package/src/components/index.ts
@@ -0,0 +1,5 @@
+/***/
+// The index file in ./components/ is typically responsible for selecting
+// which components are public API and should be exported from the package.
+
+export * from './ExampleComponent';
diff --git a/packages/cli/templates/default-react-plugin-package/src/hooks/index.ts b/packages/cli/templates/default-react-plugin-package/src/hooks/index.ts
new file mode 100644
index 0000000000..cec94f4b04
--- /dev/null
+++ b/packages/cli/templates/default-react-plugin-package/src/hooks/index.ts
@@ -0,0 +1,5 @@
+/***/
+// The index file in ./hooks/ is typically responsible for selecting
+// which hooks are public API and should be exported from the package.
+
+export * from './useExample';
diff --git a/packages/cli/templates/default-react-plugin-package/src/hooks/useExample/index.ts b/packages/cli/templates/default-react-plugin-package/src/hooks/useExample/index.ts
new file mode 100644
index 0000000000..f1fd276930
--- /dev/null
+++ b/packages/cli/templates/default-react-plugin-package/src/hooks/useExample/index.ts
@@ -0,0 +1 @@
+export { useExample } from './useExample';
diff --git a/packages/cli/templates/default-react-plugin-package/src/hooks/useExample/useExample.ts b/packages/cli/templates/default-react-plugin-package/src/hooks/useExample/useExample.ts
new file mode 100644
index 0000000000..911d255238
--- /dev/null
+++ b/packages/cli/templates/default-react-plugin-package/src/hooks/useExample/useExample.ts
@@ -0,0 +1,15 @@
+import { useEffect } from 'react';
+import { useApi, alertApiRef } from '@backstage/core-plugin-api';
+
+/**
+ * Shows an example alert.
+ *
+ * @public
+ */
+export function useExample() {
+ const alertApi = useApi(alertApiRef);
+
+ useEffect(() => {
+ alertApi.post({ message: 'Hello World!' });
+ }, [alertApi])
+}
diff --git a/packages/cli/templates/default-react-plugin-package/src/index.ts.hbs b/packages/cli/templates/default-react-plugin-package/src/index.ts.hbs
new file mode 100644
index 0000000000..a7ebb26f00
--- /dev/null
+++ b/packages/cli/templates/default-react-plugin-package/src/index.ts.hbs
@@ -0,0 +1,12 @@
+/***/
+/**
+ * Web library for the {{id}} plugin.
+ *
+ * @packageDocumentation
+ */
+
+// In this package you might for example export components or hooks
+// that are useful to other plugins or modules.
+
+export * from './components'
+export * from './hooks'
diff --git a/packages/cli/templates/default-react-plugin-package/src/setupTests.ts b/packages/cli/templates/default-react-plugin-package/src/setupTests.ts
new file mode 100644
index 0000000000..7b0828bfa8
--- /dev/null
+++ b/packages/cli/templates/default-react-plugin-package/src/setupTests.ts
@@ -0,0 +1 @@
+import '@testing-library/jest-dom';
diff --git a/packages/cli/templates/default-react-plugin-package/tsconfig.json b/packages/cli/templates/default-react-plugin-package/tsconfig.json
new file mode 100644
index 0000000000..ce3409d31f
--- /dev/null
+++ b/packages/cli/templates/default-react-plugin-package/tsconfig.json
@@ -0,0 +1,11 @@
+{
+ "extends": "@backstage/cli/config/tsconfig.json",
+ "include": [
+ "src",
+ ],
+ "exclude": ["node_modules"],
+ "compilerOptions": {
+ "outDir": "dist-types",
+ "rootDir": "."
+ }
+}
diff --git a/packages/codemods/CHANGELOG.md b/packages/codemods/CHANGELOG.md
index 7104ce9cf4..d19c01a7d5 100644
--- a/packages/codemods/CHANGELOG.md
+++ b/packages/codemods/CHANGELOG.md
@@ -1,5 +1,13 @@
# @backstage/codemods
+## 0.1.44
+
+### Patch Changes
+
+- 482dae5de1c: Updated link to docs.
+- Updated dependencies
+ - @backstage/cli-common@0.1.12
+
## 0.1.44-next.0
### Patch Changes
diff --git a/packages/codemods/package.json b/packages/codemods/package.json
index 8f4ab51a98..acb0f10dd1 100644
--- a/packages/codemods/package.json
+++ b/packages/codemods/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/codemods",
"description": "A collection of codemods for Backstage projects",
- "version": "0.1.44-next.0",
+ "version": "0.1.44",
"publishConfig": {
"access": "public",
"main": "dist/index.cjs.js"
diff --git a/packages/config-loader/CHANGELOG.md b/packages/config-loader/CHANGELOG.md
index 5dbed6c46d..d1eb56d9af 100644
--- a/packages/config-loader/CHANGELOG.md
+++ b/packages/config-loader/CHANGELOG.md
@@ -1,5 +1,17 @@
# @backstage/config-loader
+## 1.1.9
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- 482dae5de1c: Updated link to docs.
+- Updated dependencies
+ - @backstage/errors@1.1.5
+ - @backstage/cli-common@0.1.12
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 1.1.9-next.0
### Patch Changes
diff --git a/packages/config-loader/package.json b/packages/config-loader/package.json
index f842f77809..1ef8d41955 100644
--- a/packages/config-loader/package.json
+++ b/packages/config-loader/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/config-loader",
"description": "Config loading functionality used by Backstage backend, and CLI",
- "version": "1.1.9-next.0",
+ "version": "1.1.9",
"publishConfig": {
"access": "public",
"main": "dist/index.cjs.js",
diff --git a/packages/config/CHANGELOG.md b/packages/config/CHANGELOG.md
index c809e158b7..8b20f72905 100644
--- a/packages/config/CHANGELOG.md
+++ b/packages/config/CHANGELOG.md
@@ -1,5 +1,13 @@
# @backstage/config
+## 1.0.7
+
+### Patch Changes
+
+- 482dae5de1c: Updated link to docs.
+- Updated dependencies
+ - @backstage/types@1.0.2
+
## 1.0.7-next.0
### Patch Changes
diff --git a/packages/config/package.json b/packages/config/package.json
index 5b8ac4279b..c90b7d4c5f 100644
--- a/packages/config/package.json
+++ b/packages/config/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/config",
"description": "Config API used by Backstage core, backend, and CLI",
- "version": "1.0.7-next.0",
+ "version": "1.0.7",
"publishConfig": {
"access": "public",
"main": "dist/index.cjs.js",
diff --git a/packages/core-app-api/CHANGELOG.md b/packages/core-app-api/CHANGELOG.md
index d91fa44f05..af0ca61ef0 100644
--- a/packages/core-app-api/CHANGELOG.md
+++ b/packages/core-app-api/CHANGELOG.md
@@ -1,5 +1,48 @@
# @backstage/core-app-api
+## 1.7.0-next.0
+
+### Minor Changes
+
+- 7908d72e033: Introduce a new global config parameter, `auth.enableExperimentalRedirectFlow`. When enabled, auth will happen with an in-window redirect flow rather than through a popup window.
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+ - @backstage/version-bridge@1.0.3
+
+## 1.6.0
+
+### Minor Changes
+
+- 456eaa8cf83: `OAuth2` now gets ID tokens from a session with the `openid` scope explicitly
+ requested.
+
+ This should not be considered a breaking change, because spec-compliant OIDC
+ providers will already be returning ID tokens if and only if the `openid` scope
+ is granted.
+
+ This change makes the dependence explicit, and removes the burden on
+ OAuth2-based providers which require an ID token (e.g. this is done by various
+ default [auth
+ handlers](https://backstage.io/docs/auth/identity-resolver/#authhandler)) to add
+ `openid` to their default scopes. _That_ could carry another indirect benefit:
+ by removing `openid` from the default scopes for a provider, grants for
+ resource-specific access tokens can avoid requesting excess ID token-related
+ scopes.
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+ - @backstage/version-bridge@1.0.3
+
## 1.6.0-next.2
### Minor Changes
diff --git a/packages/core-app-api/api-report.md b/packages/core-app-api/api-report.md
index 37f7a98de0..d7e4a22873 100644
--- a/packages/core-app-api/api-report.md
+++ b/packages/core-app-api/api-report.md
@@ -25,6 +25,7 @@ import { bitbucketAuthApiRef } from '@backstage/core-plugin-api';
import { bitbucketServerAuthApiRef } from '@backstage/core-plugin-api';
import { ComponentType } from 'react';
import { Config } from '@backstage/config';
+import { ConfigApi } from '@backstage/core-plugin-api';
import { ConfigReader } from '@backstage/config';
import { DiscoveryApi } from '@backstage/core-plugin-api';
import { ErrorApi } from '@backstage/core-plugin-api';
@@ -264,6 +265,7 @@ export type AuthApiCreateOptions = {
discoveryApi: DiscoveryApi;
environment?: string;
provider?: AuthProviderInfo;
+ configApi?: ConfigApi;
};
// @public
@@ -533,6 +535,7 @@ export class OneLoginAuth {
// @public
export type OneLoginAuthCreateOptions = {
+ configApi?: ConfigApi;
discoveryApi: DiscoveryApi;
oauthRequestApi: OAuthRequestApi;
environment?: string;
diff --git a/packages/core-app-api/config.d.ts b/packages/core-app-api/config.d.ts
index ae876f7fe0..2de1d96114 100644
--- a/packages/core-app-api/config.d.ts
+++ b/packages/core-app-api/config.d.ts
@@ -115,4 +115,11 @@ export interface Config {
*/
environment?: string;
};
+
+ /**
+ $ Enable redirect authentication flow type, instead of a popup for authentication
+ * default value: 'false'
+ * @visibility frontend
+ */
+ enableExperimentalRedirectFlow?: boolean;
}
diff --git a/packages/core-app-api/package.json b/packages/core-app-api/package.json
index 073a5a22b2..1dda0c58f8 100644
--- a/packages/core-app-api/package.json
+++ b/packages/core-app-api/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/core-app-api",
"description": "Core app API used by Backstage apps",
- "version": "1.6.0-next.2",
+ "version": "1.7.0-next.0",
"publishConfig": {
"access": "public",
"main": "dist/index.esm.js",
@@ -40,7 +40,7 @@
"prop-types": "^15.7.2",
"react-use": "^17.2.4",
"zen-observable": "^0.10.0",
- "zod": "~3.18.0"
+ "zod": "^3.21.4"
},
"peerDependencies": {
"@types/react": "^16.13.1 || ^17.0.0",
diff --git a/packages/core-app-api/src/apis/implementations/auth/atlassian/AtlassianAuth.ts b/packages/core-app-api/src/apis/implementations/auth/atlassian/AtlassianAuth.ts
index 07ebefca28..3477eec361 100644
--- a/packages/core-app-api/src/apis/implementations/auth/atlassian/AtlassianAuth.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/atlassian/AtlassianAuth.ts
@@ -32,6 +32,7 @@ const DEFAULT_PROVIDER = {
export default class AtlassianAuth {
static create(options: OAuthApiCreateOptions): typeof atlassianAuthApiRef.T {
const {
+ configApi,
discoveryApi,
environment = 'development',
provider = DEFAULT_PROVIDER,
@@ -39,6 +40,7 @@ export default class AtlassianAuth {
} = options;
return OAuth2.create({
+ configApi,
discoveryApi,
oauthRequestApi,
provider,
diff --git a/packages/core-app-api/src/apis/implementations/auth/bitbucket/BitbucketAuth.test.ts b/packages/core-app-api/src/apis/implementations/auth/bitbucket/BitbucketAuth.test.ts
index f4bd7cbe85..1335808280 100644
--- a/packages/core-app-api/src/apis/implementations/auth/bitbucket/BitbucketAuth.test.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/bitbucket/BitbucketAuth.test.ts
@@ -17,6 +17,7 @@
import MockOAuthApi from '../../OAuthRequestApi/MockOAuthApi';
import { UrlPatternDiscovery } from '../../DiscoveryApi';
import BitbucketAuth from './BitbucketAuth';
+import { MockConfigApi } from '@backstage/test-utils';
const getSession = jest.fn();
@@ -32,6 +33,8 @@ describe('BitbucketAuth', () => {
jest.resetAllMocks();
});
+ const configApi = new MockConfigApi({});
+
it.each([
['team api write_repository', ['team', 'api', 'write_repository']],
['read_repository sudo', ['read_repository', 'sudo']],
@@ -39,6 +42,7 @@ describe('BitbucketAuth', () => {
const gitlabAuth = BitbucketAuth.create({
oauthRequestApi: new MockOAuthApi(),
discoveryApi: UrlPatternDiscovery.compile('http://example.com'),
+ configApi: configApi,
});
gitlabAuth.getAccessToken(scope);
diff --git a/packages/core-app-api/src/apis/implementations/auth/bitbucket/BitbucketAuth.ts b/packages/core-app-api/src/apis/implementations/auth/bitbucket/BitbucketAuth.ts
index 7c5d4f3fc0..7a9f1bc094 100644
--- a/packages/core-app-api/src/apis/implementations/auth/bitbucket/BitbucketAuth.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/bitbucket/BitbucketAuth.ts
@@ -47,6 +47,7 @@ const DEFAULT_PROVIDER = {
export default class BitbucketAuth {
static create(options: OAuthApiCreateOptions): typeof bitbucketAuthApiRef.T {
const {
+ configApi,
discoveryApi,
environment = 'development',
provider = DEFAULT_PROVIDER,
@@ -55,6 +56,7 @@ export default class BitbucketAuth {
} = options;
return OAuth2.create({
+ configApi,
discoveryApi,
oauthRequestApi,
provider,
diff --git a/packages/core-app-api/src/apis/implementations/auth/bitbucketServer/BitbucketServerAuth.test.ts b/packages/core-app-api/src/apis/implementations/auth/bitbucketServer/BitbucketServerAuth.test.ts
index 32e7755a00..5631a9a886 100644
--- a/packages/core-app-api/src/apis/implementations/auth/bitbucketServer/BitbucketServerAuth.test.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/bitbucketServer/BitbucketServerAuth.test.ts
@@ -17,6 +17,7 @@
import MockOAuthApi from '../../OAuthRequestApi/MockOAuthApi';
import { UrlPatternDiscovery } from '../../DiscoveryApi';
import BitbucketServerAuth from './BitbucketServerAuth';
+import { MockConfigApi } from '@backstage/test-utils';
const getSession = jest.fn();
@@ -40,7 +41,10 @@ describe('BitbucketServerAuth', () => {
['PROJECT_ADMIN', 'REPO_READ', 'ACCOUNT_WRITE'],
],
])(`should normalize scopes correctly - %p`, (scope, scopes) => {
+ const configApi = new MockConfigApi({});
+
const bitbucketServerAuth = BitbucketServerAuth.create({
+ configApi: configApi,
oauthRequestApi: new MockOAuthApi(),
discoveryApi: UrlPatternDiscovery.compile('http://example.com'),
});
diff --git a/packages/core-app-api/src/apis/implementations/auth/bitbucketServer/BitbucketServerAuth.ts b/packages/core-app-api/src/apis/implementations/auth/bitbucketServer/BitbucketServerAuth.ts
index dc50eff6ab..b25deffb93 100644
--- a/packages/core-app-api/src/apis/implementations/auth/bitbucketServer/BitbucketServerAuth.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/bitbucketServer/BitbucketServerAuth.ts
@@ -48,6 +48,7 @@ export default class BitbucketServerAuth {
options: OAuthApiCreateOptions,
): typeof bitbucketServerAuthApiRef.T {
const {
+ configApi,
discoveryApi,
environment = 'development',
provider = DEFAULT_PROVIDER,
@@ -56,6 +57,7 @@ export default class BitbucketServerAuth {
} = options;
return OAuth2.create({
+ configApi,
discoveryApi,
oauthRequestApi,
provider,
diff --git a/packages/core-app-api/src/apis/implementations/auth/github/GithubAuth.test.ts b/packages/core-app-api/src/apis/implementations/auth/github/GithubAuth.test.ts
index ea7b4ac688..fc77754f6f 100644
--- a/packages/core-app-api/src/apis/implementations/auth/github/GithubAuth.test.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/github/GithubAuth.test.ts
@@ -17,6 +17,7 @@
import { UrlPatternDiscovery } from '../../DiscoveryApi';
import MockOAuthApi from '../../OAuthRequestApi/MockOAuthApi';
import GithubAuth from './GithubAuth';
+import { MockConfigApi } from '@backstage/test-utils';
const getSession = jest.fn();
@@ -32,8 +33,11 @@ describe('GithubAuth', () => {
jest.resetAllMocks();
});
+ const configApi = new MockConfigApi({});
+
it('should forward access token request to session manager', async () => {
const githubAuth = GithubAuth.create({
+ configApi: configApi,
oauthRequestApi: new MockOAuthApi(),
discoveryApi: UrlPatternDiscovery.compile('http://example.com'),
});
diff --git a/packages/core-app-api/src/apis/implementations/auth/github/GithubAuth.ts b/packages/core-app-api/src/apis/implementations/auth/github/GithubAuth.ts
index 7efe4e95c6..943dfa7da4 100644
--- a/packages/core-app-api/src/apis/implementations/auth/github/GithubAuth.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/github/GithubAuth.ts
@@ -32,6 +32,7 @@ const DEFAULT_PROVIDER = {
export default class GithubAuth {
static create(options: OAuthApiCreateOptions): typeof githubAuthApiRef.T {
const {
+ configApi,
discoveryApi,
environment = 'development',
provider = DEFAULT_PROVIDER,
@@ -40,6 +41,7 @@ export default class GithubAuth {
} = options;
return OAuth2.create({
+ configApi,
discoveryApi,
oauthRequestApi,
provider,
diff --git a/packages/core-app-api/src/apis/implementations/auth/gitlab/GitlabAuth.test.ts b/packages/core-app-api/src/apis/implementations/auth/gitlab/GitlabAuth.test.ts
index 3346af9b7c..6dde0c0334 100644
--- a/packages/core-app-api/src/apis/implementations/auth/gitlab/GitlabAuth.test.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/gitlab/GitlabAuth.test.ts
@@ -17,6 +17,7 @@
import MockOAuthApi from '../../OAuthRequestApi/MockOAuthApi';
import { UrlPatternDiscovery } from '../../DiscoveryApi';
import GitlabAuth from './GitlabAuth';
+import { MockConfigApi } from '@backstage/test-utils';
const getSession = jest.fn();
@@ -39,7 +40,10 @@ describe('GitlabAuth', () => {
],
['read_repository sudo', ['read_repository', 'sudo']],
])(`should normalize scopes correctly - %p`, (scope, scopes) => {
+ const configApi = new MockConfigApi({});
+
const gitlabAuth = GitlabAuth.create({
+ configApi: configApi,
oauthRequestApi: new MockOAuthApi(),
discoveryApi: UrlPatternDiscovery.compile('http://example.com'),
});
diff --git a/packages/core-app-api/src/apis/implementations/auth/gitlab/GitlabAuth.ts b/packages/core-app-api/src/apis/implementations/auth/gitlab/GitlabAuth.ts
index 00085de8ac..c39f5a6e23 100644
--- a/packages/core-app-api/src/apis/implementations/auth/gitlab/GitlabAuth.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/gitlab/GitlabAuth.ts
@@ -32,6 +32,7 @@ const DEFAULT_PROVIDER = {
export default class GitlabAuth {
static create(options: OAuthApiCreateOptions): typeof gitlabAuthApiRef.T {
const {
+ configApi,
discoveryApi,
environment = 'development',
provider = DEFAULT_PROVIDER,
@@ -40,6 +41,7 @@ export default class GitlabAuth {
} = options;
return OAuth2.create({
+ configApi,
discoveryApi,
oauthRequestApi,
provider,
diff --git a/packages/core-app-api/src/apis/implementations/auth/google/GoogleAuth.test.ts b/packages/core-app-api/src/apis/implementations/auth/google/GoogleAuth.test.ts
index f8a1c3a1f5..7897eef42e 100644
--- a/packages/core-app-api/src/apis/implementations/auth/google/GoogleAuth.test.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/google/GoogleAuth.test.ts
@@ -17,6 +17,7 @@
import GoogleAuth from './GoogleAuth';
import MockOAuthApi from '../../OAuthRequestApi/MockOAuthApi';
import { UrlPatternDiscovery } from '../../DiscoveryApi';
+import { MockConfigApi } from '@backstage/test-utils';
const PREFIX = 'https://www.googleapis.com/auth/';
@@ -58,7 +59,10 @@ describe('GoogleAuth', () => {
[`${PREFIX}profile`, [`${PREFIX}profile`]],
[`${PREFIX}openid`, [`${PREFIX}openid`]],
])(`should normalize scopes correctly - %p`, (scope, scopes) => {
+ const configApi = new MockConfigApi({});
+
const googleAuth = GoogleAuth.create({
+ configApi: configApi,
oauthRequestApi: new MockOAuthApi(),
discoveryApi: UrlPatternDiscovery.compile('http://example.com'),
});
diff --git a/packages/core-app-api/src/apis/implementations/auth/google/GoogleAuth.ts b/packages/core-app-api/src/apis/implementations/auth/google/GoogleAuth.ts
index 8a528f4511..f4674ab64f 100644
--- a/packages/core-app-api/src/apis/implementations/auth/google/GoogleAuth.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/google/GoogleAuth.ts
@@ -34,6 +34,7 @@ const SCOPE_PREFIX = 'https://www.googleapis.com/auth/';
export default class GoogleAuth {
static create(options: OAuthApiCreateOptions): typeof googleAuthApiRef.T {
const {
+ configApi,
discoveryApi,
oauthRequestApi,
environment = 'development',
@@ -46,6 +47,7 @@ export default class GoogleAuth {
} = options;
return OAuth2.create({
+ configApi,
discoveryApi,
oauthRequestApi,
provider,
diff --git a/packages/core-app-api/src/apis/implementations/auth/microsoft/MicrosoftAuth.ts b/packages/core-app-api/src/apis/implementations/auth/microsoft/MicrosoftAuth.ts
index be5776609d..30cfde7c6e 100644
--- a/packages/core-app-api/src/apis/implementations/auth/microsoft/MicrosoftAuth.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/microsoft/MicrosoftAuth.ts
@@ -32,6 +32,7 @@ const DEFAULT_PROVIDER = {
export default class MicrosoftAuth {
static create(options: OAuthApiCreateOptions): typeof microsoftAuthApiRef.T {
const {
+ configApi,
environment = 'development',
provider = DEFAULT_PROVIDER,
oauthRequestApi,
@@ -46,6 +47,7 @@ export default class MicrosoftAuth {
} = options;
return OAuth2.create({
+ configApi,
discoveryApi,
oauthRequestApi,
provider,
diff --git a/packages/core-app-api/src/apis/implementations/auth/oauth2/OAuth2.test.ts b/packages/core-app-api/src/apis/implementations/auth/oauth2/OAuth2.test.ts
index 63070120ef..6f941379a7 100644
--- a/packages/core-app-api/src/apis/implementations/auth/oauth2/OAuth2.test.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/oauth2/OAuth2.test.ts
@@ -17,6 +17,7 @@
import OAuth2 from './OAuth2';
import MockOAuthApi from '../../OAuthRequestApi/MockOAuthApi';
import { UrlPatternDiscovery } from '../../DiscoveryApi';
+import { MockConfigApi } from '@backstage/test-utils';
const theFuture = new Date(Date.now() + 3600000);
const thePast = new Date(Date.now() - 10);
@@ -34,12 +35,15 @@ jest.mock('../../../../lib/AuthSessionManager', () => ({
},
}));
+const configApi = new MockConfigApi({});
+
describe('OAuth2', () => {
it('should get refreshed access token', async () => {
getSession = jest.fn().mockResolvedValue({
providerInfo: { accessToken: 'access-token', expiresAt: theFuture },
});
const oauth2 = OAuth2.create({
+ configApi: configApi,
scopeTransform: scopeTransform,
oauthRequestApi: new MockOAuthApi(),
discoveryApi: UrlPatternDiscovery.compile('http://example.com'),
@@ -58,6 +62,7 @@ describe('OAuth2', () => {
providerInfo: { accessToken: 'access-token', expiresAt: theFuture },
});
const oauth2 = OAuth2.create({
+ configApi: configApi,
scopeTransform: scopes => scopes.map(scope => `my-prefix/${scope}`),
oauthRequestApi: new MockOAuthApi(),
discoveryApi: UrlPatternDiscovery.compile('http://example.com'),
@@ -75,7 +80,9 @@ describe('OAuth2', () => {
getSession = jest.fn().mockResolvedValue({
providerInfo: { idToken: 'id-token', expiresAt: theFuture },
});
+
const oauth2 = OAuth2.create({
+ configApi: configApi,
scopeTransform: scopeTransform,
oauthRequestApi: new MockOAuthApi(),
discoveryApi: UrlPatternDiscovery.compile('http://example.com'),
@@ -94,6 +101,7 @@ describe('OAuth2', () => {
providerInfo: { idToken: 'id-token', expiresAt: theFuture },
});
const oauth2 = OAuth2.create({
+ configApi: configApi,
scopeTransform: scopes => scopes.map(scope => `my-prefix/${scope}`),
oauthRequestApi: new MockOAuthApi(),
discoveryApi: UrlPatternDiscovery.compile('http://example.com'),
@@ -121,6 +129,7 @@ describe('OAuth2', () => {
})
.mockRejectedValue(error);
const oauth2 = OAuth2.create({
+ configApi: configApi,
scopeTransform: scopes => scopes.map(scope => `my-prefix/${scope}`),
oauthRequestApi: new MockOAuthApi(),
discoveryApi: UrlPatternDiscovery.compile('http://example.com'),
@@ -155,6 +164,7 @@ describe('OAuth2', () => {
},
});
const oauth2 = OAuth2.create({
+ configApi: configApi,
scopeTransform: scopes => scopes.map(scope => `my-prefix/${scope}`),
oauthRequestApi: new MockOAuthApi(),
discoveryApi: UrlPatternDiscovery.compile('http://example.com'),
diff --git a/packages/core-app-api/src/apis/implementations/auth/oauth2/OAuth2.ts b/packages/core-app-api/src/apis/implementations/auth/oauth2/OAuth2.ts
index 6f88178415..44bd5269ea 100644
--- a/packages/core-app-api/src/apis/implementations/auth/oauth2/OAuth2.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/oauth2/OAuth2.ts
@@ -72,6 +72,7 @@ export default class OAuth2
{
static create(options: OAuth2CreateOptions) {
const {
+ configApi,
discoveryApi,
environment = 'development',
provider = DEFAULT_PROVIDER,
@@ -81,6 +82,7 @@ export default class OAuth2
} = options;
const connector = new DefaultAuthConnector({
+ configApi,
discoveryApi,
environment,
provider,
diff --git a/packages/core-app-api/src/apis/implementations/auth/okta/OktaAuth.test.ts b/packages/core-app-api/src/apis/implementations/auth/okta/OktaAuth.test.ts
index 6489b326ff..5e7370a947 100644
--- a/packages/core-app-api/src/apis/implementations/auth/okta/OktaAuth.test.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/okta/OktaAuth.test.ts
@@ -17,6 +17,7 @@
import OktaAuth from './OktaAuth';
import MockOAuthApi from '../../OAuthRequestApi/MockOAuthApi';
import { UrlPatternDiscovery } from '../../DiscoveryApi';
+import { MockConfigApi } from '@backstage/test-utils';
const PREFIX = 'okta.';
@@ -50,7 +51,9 @@ describe('OktaAuth', () => {
[`${PREFIX}profile`, [`${PREFIX}profile`]],
[`${PREFIX}openid`, [`${PREFIX}openid`]],
])(`should normalize scopes correctly - %p`, (scope, scopes) => {
+ const configApi = new MockConfigApi({});
const auth = OktaAuth.create({
+ configApi: configApi,
oauthRequestApi: new MockOAuthApi(),
discoveryApi: UrlPatternDiscovery.compile('http://example.com'),
});
diff --git a/packages/core-app-api/src/apis/implementations/auth/okta/OktaAuth.ts b/packages/core-app-api/src/apis/implementations/auth/okta/OktaAuth.ts
index 42c0ddd0ed..c1921a8f93 100644
--- a/packages/core-app-api/src/apis/implementations/auth/okta/OktaAuth.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/okta/OktaAuth.ts
@@ -44,6 +44,7 @@ const OKTA_SCOPE_PREFIX: string = 'okta.';
export default class OktaAuth {
static create(options: OAuthApiCreateOptions): typeof oktaAuthApiRef.T {
const {
+ configApi,
discoveryApi,
environment = 'development',
provider = DEFAULT_PROVIDER,
@@ -52,6 +53,7 @@ export default class OktaAuth {
} = options;
return OAuth2.create({
+ configApi,
discoveryApi,
oauthRequestApi,
provider,
diff --git a/packages/core-app-api/src/apis/implementations/auth/onelogin/OneLoginAuth.ts b/packages/core-app-api/src/apis/implementations/auth/onelogin/OneLoginAuth.ts
index ea9e2cad28..d8f54e7e50 100644
--- a/packages/core-app-api/src/apis/implementations/auth/onelogin/OneLoginAuth.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/onelogin/OneLoginAuth.ts
@@ -18,6 +18,7 @@ import {
oneloginAuthApiRef,
OAuthRequestApi,
AuthProviderInfo,
+ ConfigApi,
DiscoveryApi,
} from '@backstage/core-plugin-api';
import { OAuth2 } from '../oauth2';
@@ -27,6 +28,7 @@ import { OAuth2 } from '../oauth2';
* @public
*/
export type OneLoginAuthCreateOptions = {
+ configApi?: ConfigApi;
discoveryApi: DiscoveryApi;
oauthRequestApi: OAuthRequestApi;
environment?: string;
@@ -61,6 +63,7 @@ export default class OneLoginAuth {
options: OneLoginAuthCreateOptions,
): typeof oneloginAuthApiRef.T {
const {
+ configApi,
discoveryApi,
environment = 'development',
provider = DEFAULT_PROVIDER,
@@ -68,6 +71,7 @@ export default class OneLoginAuth {
} = options;
return OAuth2.create({
+ configApi,
discoveryApi,
oauthRequestApi,
provider,
diff --git a/packages/core-app-api/src/apis/implementations/auth/types.ts b/packages/core-app-api/src/apis/implementations/auth/types.ts
index 55d6c19098..7a74fd3a3b 100644
--- a/packages/core-app-api/src/apis/implementations/auth/types.ts
+++ b/packages/core-app-api/src/apis/implementations/auth/types.ts
@@ -16,6 +16,7 @@
import {
AuthProviderInfo,
+ ConfigApi,
DiscoveryApi,
OAuthRequestApi,
} from '@backstage/core-plugin-api';
@@ -37,4 +38,5 @@ export type AuthApiCreateOptions = {
discoveryApi: DiscoveryApi;
environment?: string;
provider?: AuthProviderInfo;
+ configApi?: ConfigApi;
};
diff --git a/packages/core-app-api/src/app/types.ts b/packages/core-app-api/src/app/types.ts
index 75b8fb2a34..3d9005b0c0 100644
--- a/packages/core-app-api/src/app/types.ts
+++ b/packages/core-app-api/src/app/types.ts
@@ -45,7 +45,7 @@ export type BootErrorPageProps = {
*/
export type SignInPageProps = {
/**
- * Set the IdentityApi on successful sign in. This should only be called once.
+ * Set the IdentityApi on successful sign-in. This should only be called once.
*/
onSignInSuccess(identityApi: IdentityApi): void;
};
diff --git a/packages/core-app-api/src/lib/AuthConnector/DefaultAuthConnector.test.ts b/packages/core-app-api/src/lib/AuthConnector/DefaultAuthConnector.test.ts
index 2b132e09cd..51da9cbfb5 100644
--- a/packages/core-app-api/src/lib/AuthConnector/DefaultAuthConnector.test.ts
+++ b/packages/core-app-api/src/lib/AuthConnector/DefaultAuthConnector.test.ts
@@ -21,6 +21,8 @@ import { UrlPatternDiscovery } from '../../apis';
import { setupRequestMockHandlers } from '@backstage/test-utils';
import { setupServer } from 'msw/node';
import { rest } from 'msw';
+import { ConfigReader } from '@backstage/config';
+import { ConfigApi } from '@backstage/core-plugin-api';
jest.mock('../loginPopup', () => {
return {
@@ -28,6 +30,10 @@ jest.mock('../loginPopup', () => {
};
});
+const configApi: ConfigApi = new ConfigReader({
+ enableExperimentalRedirectFlow: false,
+});
+
const defaultOptions = {
discoveryApi: UrlPatternDiscovery.compile('http://my-host/api/{{pluginId}}'),
environment: 'production',
@@ -42,6 +48,7 @@ const defaultOptions = {
scopes: new Set(res.scopes.split(' ')),
expiresAt: new Date(Date.now() + expiresInSeconds * 1000),
}),
+ configApi: configApi,
};
describe('DefaultAuthConnector', () => {
@@ -131,7 +138,7 @@ describe('DefaultAuthConnector', () => {
expect(popupSpy).toHaveBeenCalledTimes(1);
expect(popupSpy.mock.calls[0][0]).toMatchObject({
- url: 'http://my-host/api/auth/my-provider/start?scope=a%20b&origin=http%3A%2F%2Flocalhost&env=production',
+ url: 'http://my-host/api/auth/my-provider/start?scope=a%20b&origin=http%3A%2F%2Flocalhost&flow=popup&env=production',
});
await expect(sessionPromise).resolves.toEqual({
@@ -179,7 +186,7 @@ describe('DefaultAuthConnector', () => {
expect(popupSpy).toHaveBeenCalledTimes(1);
expect(popupSpy.mock.calls[0][0]).toMatchObject({
- url: 'http://my-host/api/auth/my-provider/start?scope=-ab-&origin=http%3A%2F%2Flocalhost&env=production',
+ url: 'http://my-host/api/auth/my-provider/start?scope=-ab-&origin=http%3A%2F%2Flocalhost&flow=popup&env=production',
});
});
});
diff --git a/packages/core-app-api/src/lib/AuthConnector/DefaultAuthConnector.ts b/packages/core-app-api/src/lib/AuthConnector/DefaultAuthConnector.ts
index 988c9f17b1..f2c35b0ba3 100644
--- a/packages/core-app-api/src/lib/AuthConnector/DefaultAuthConnector.ts
+++ b/packages/core-app-api/src/lib/AuthConnector/DefaultAuthConnector.ts
@@ -13,16 +13,18 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
import {
- OAuthRequester,
- OAuthRequestApi,
AuthProviderInfo,
+ ConfigApi,
DiscoveryApi,
+ OAuthRequestApi,
+ OAuthRequester,
} from '@backstage/core-plugin-api';
import { showLoginPopup } from '../loginPopup';
import { AuthConnector, CreateSessionOptions } from './types';
+let warned = false;
+
type Options = {
/**
* DiscoveryApi instance used to locate the auth backend endpoint.
@@ -49,6 +51,10 @@ type Options = {
* Function used to transform an auth response into the session type.
*/
sessionTransform?(response: any): AuthSession | Promise;
+ /**
+ * ConfigApi instance used to configure authentication flow of pop-up or redirect.
+ */
+ configApi?: ConfigApi;
};
function defaultJoinScopes(scopes: Set) {
@@ -69,9 +75,10 @@ export class DefaultAuthConnector
private readonly joinScopesFunc: (scopes: Set) => string;
private readonly authRequester: OAuthRequester;
private readonly sessionTransform: (response: any) => Promise;
-
+ private readonly enableExperimentalRedirectFlow: boolean;
constructor(options: Options) {
const {
+ configApi,
discoveryApi,
environment,
provider,
@@ -80,9 +87,26 @@ export class DefaultAuthConnector
sessionTransform = id => id,
} = options;
+ if (!warned && !configApi) {
+ // eslint-disable-next-line no-console
+ console.warn(
+ 'DEPRECATION WARNING: Authentication providers require a configApi instance to configure the authentication flow. Please provide one to the authentication provider constructor.',
+ );
+ warned = true;
+ }
+
+ this.enableExperimentalRedirectFlow = configApi
+ ? configApi.getOptionalBoolean('enableExperimentalRedirectFlow') ?? false
+ : false;
+
this.authRequester = oauthRequestApi.createAuthRequester({
provider,
- onAuthRequest: scopes => this.showPopup(scopes),
+ onAuthRequest: async scopes => {
+ if (!this.enableExperimentalRedirectFlow) {
+ return this.showPopup(scopes);
+ }
+ return this.executeRedirect(scopes);
+ },
});
this.discoveryApi = discoveryApi;
@@ -94,6 +118,9 @@ export class DefaultAuthConnector
async createSession(options: CreateSessionOptions): Promise {
if (options.instantPopup) {
+ if (this.enableExperimentalRedirectFlow) {
+ return this.executeRedirect(options.scopes);
+ }
return this.showPopup(options.scopes);
}
return this.authRequester(options.scopes);
@@ -155,6 +182,7 @@ export class DefaultAuthConnector
const popupUrl = await this.buildUrl('/start', {
scope,
origin: window.location.origin,
+ flow: 'popup',
});
const payload = await showLoginPopup({
@@ -168,6 +196,19 @@ export class DefaultAuthConnector
return await this.sessionTransform(payload);
}
+ private async executeRedirect(scopes: Set): Promise {
+ const scope = this.joinScopesFunc(scopes);
+ // redirect to auth api
+ window.location.href = await this.buildUrl('/start', {
+ scope,
+ origin: window.location.origin,
+ redirectUrl: window.location.href,
+ flow: 'redirect',
+ });
+ // return a promise that never resolves
+ return new Promise(() => {});
+ }
+
private async buildUrl(
path: string,
query?: { [key: string]: string | boolean | undefined },
diff --git a/packages/core-app-api/src/lib/AuthSessionManager/RefreshingAuthSessionManager.ts b/packages/core-app-api/src/lib/AuthSessionManager/RefreshingAuthSessionManager.ts
index d31f5e29bf..67d83bb36a 100644
--- a/packages/core-app-api/src/lib/AuthSessionManager/RefreshingAuthSessionManager.ts
+++ b/packages/core-app-api/src/lib/AuthSessionManager/RefreshingAuthSessionManager.ts
@@ -93,7 +93,7 @@ export class RefreshingAuthSessionManager implements SessionManager {
//
// We skip this check if an instant login popup is requested, as we need to
// stay in a synchronous call stack from the user interaction. The downside
- // is that that the user will sometimes be requested to log in even if they
+ // is that the user will sometimes be requested to log in even if they
// already had an existing session.
if (!this.currentSession && !options.instantPopup) {
try {
diff --git a/packages/core-components/CHANGELOG.md b/packages/core-components/CHANGELOG.md
index 0eac19716d..b8e29342dc 100644
--- a/packages/core-components/CHANGELOG.md
+++ b/packages/core-components/CHANGELOG.md
@@ -1,5 +1,39 @@
# @backstage/core-components
+## 0.12.6-next.0
+
+### Patch Changes
+
+- 7908d72e033: Introduce a new global config parameter, `auth.enableExperimentalRedirectFlow`. When enabled, auth will happen with an in-window redirect flow rather than through a popup window.
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- 7245e744ab1: Fixed the font color on `BackstageHeaderLabel` to respect the active page theme.
+- Updated dependencies
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+ - @backstage/version-bridge@1.0.3
+
+## 0.12.5
+
+### Patch Changes
+
+- 8bbf95b5507: Button labels in the sidebar (previously displayed in uppercase) will be displayed in the case that is provided without any transformations.
+ For example, a sidebar button with the label "Search" will appear as Search, "search" will appear as search, "SEARCH" will appear as SEARCH etc.
+ This can potentially affect any overriding styles previously applied to change the appearance of Button labels in the Sidebar.
+- cb8ec97cdeb: Change black & white colors to be theme aware
+- c10384a9235: Switch to using `LinkButton` instead of the deprecated `Button`
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- e1aae2f5a0c: Updated the `aria-label` of the `HeaderTabs` component.
+- 6a51a49a810: Fix bug where `
` component would not take into account header styles defined in `columns[*].headerStyle`.
+- fa004f66871: Use media queries to change layout instead of `isMobile` prop in `BackstagePage` component
+- Updated dependencies
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/theme@0.2.18
+ - @backstage/version-bridge@1.0.3
+
## 0.12.5-next.2
### Patch Changes
diff --git a/packages/core-components/package.json b/packages/core-components/package.json
index 9630d7d706..2d83426a09 100644
--- a/packages/core-components/package.json
+++ b/packages/core-components/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/core-components",
"description": "Core components used by Backstage plugins and apps",
- "version": "0.12.5-next.2",
+ "version": "0.12.6-next.0",
"publishConfig": {
"access": "public",
"main": "dist/index.esm.js",
@@ -40,7 +40,7 @@
"@material-table/core": "^3.1.0",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"@react-hookz/web": "^20.0.0",
"@types/react-sparklines": "^1.7.0",
"@types/react-text-truncate": "^0.14.0",
@@ -68,7 +68,7 @@
"react-window": "^1.8.6",
"remark-gfm": "^3.0.1",
"zen-observable": "^0.10.0",
- "zod": "~3.18.0"
+ "zod": "^3.21.4"
},
"peerDependencies": {
"@types/react": "^16.13.1 || ^17.0.0",
diff --git a/packages/core-components/src/components/OAuthRequestDialog/OAuthRequestDialog.tsx b/packages/core-components/src/components/OAuthRequestDialog/OAuthRequestDialog.tsx
index 02b1afe4a1..0159d8f503 100644
--- a/packages/core-components/src/components/OAuthRequestDialog/OAuthRequestDialog.tsx
+++ b/packages/core-components/src/components/OAuthRequestDialog/OAuthRequestDialog.tsx
@@ -24,7 +24,11 @@ import Button from '@material-ui/core/Button';
import React, { useMemo, useState } from 'react';
import useObservable from 'react-use/lib/useObservable';
import LoginRequestListItem from './LoginRequestListItem';
-import { useApi, oauthRequestApiRef } from '@backstage/core-plugin-api';
+import {
+ useApi,
+ configApiRef,
+ oauthRequestApiRef,
+} from '@backstage/core-plugin-api';
import Typography from '@material-ui/core/Typography';
export type OAuthRequestDialogClassKey =
@@ -58,6 +62,11 @@ export function OAuthRequestDialog(_props: {}) {
const classes = useStyles();
const [busy, setBusy] = useState(false);
const oauthRequestApi = useApi(oauthRequestApiRef);
+ const configApi = useApi(configApiRef);
+
+ const authRedirect =
+ configApi.getOptionalBoolean('enableExperimentalRedirectFlow') ?? false;
+
const requests = useObservable(
useMemo(() => oauthRequestApi.authRequest$(), [oauthRequestApi]),
[],
@@ -83,6 +92,11 @@ export function OAuthRequestDialog(_props: {}) {
Login Required
+ {authRedirect ? (
+
+ This will trigger a http redirect to OAuth Login.
+
+ ) : null}
diff --git a/packages/core-components/src/components/Table/Table.test.tsx b/packages/core-components/src/components/Table/Table.test.tsx
index ff17409502..ffdca26d98 100644
--- a/packages/core-components/src/components/Table/Table.test.tsx
+++ b/packages/core-components/src/components/Table/Table.test.tsx
@@ -142,6 +142,62 @@ describe('
', () => {
});
});
+ describe('with style headers', () => {
+ describe('with CSS properties object', () => {
+ it('renders styled headers', async () => {
+ const columns = [
+ column1,
+ {
+ ...column2,
+ headerStyle: {
+ backgroundColor: 'pink',
+ },
+ },
+ ];
+
+ const rendered = await renderInTestApp(
+
,
+ );
+
+ expect(rendered.getByText(column1.title).closest('th')).not.toHaveStyle(
+ {
+ backgroundColor: 'pink',
+ },
+ );
+ expect(rendered.getByText(column2.title).closest('th')).toHaveStyle({
+ backgroundColor: 'pink',
+ });
+ });
+
+ it('renders styled headers with highlight', async () => {
+ const columns = [
+ {
+ ...column1,
+ highlight: true,
+ },
+ {
+ ...column2,
+ highlight: true,
+ headerStyle: {
+ backgroundColor: 'pink',
+ },
+ },
+ ];
+
+ const rendered = await renderInTestApp(
+
,
+ );
+
+ const column1Header = rendered.getByText(column1.title).closest('th');
+ expect(column1Header?.style.backgroundColor).toBe('');
+ expect(column1Header?.style.color).toBe('rgb(0, 0, 0)');
+ const column2Header = rendered.getByText(column2.title).closest('th');
+ expect(column2Header?.style.backgroundColor).toBe('pink');
+ expect(column2Header?.style.color).toBe('rgb(0, 0, 0)');
+ });
+ });
+ });
+
it('renders with subtitle', async () => {
const rendered = await renderInTestApp(
,
diff --git a/packages/core-components/src/components/Table/Table.tsx b/packages/core-components/src/components/Table/Table.tsx
index 89a1d69b96..c43345c9d2 100644
--- a/packages/core-components/src/components/Table/Table.tsx
+++ b/packages/core-components/src/components/Table/Table.tsx
@@ -169,7 +169,7 @@ function convertColumns(
theme: BackstageTheme,
): TableColumn[] {
return columns.map(column => {
- const headerStyle: React.CSSProperties = {};
+ const headerStyle: React.CSSProperties = column.headerStyle ?? {};
let cellStyle = column.cellStyle || {};
diff --git a/packages/core-components/src/layout/HeaderLabel/HeaderLabel.tsx b/packages/core-components/src/layout/HeaderLabel/HeaderLabel.tsx
index e3b6299f85..0ea2e163a7 100644
--- a/packages/core-components/src/layout/HeaderLabel/HeaderLabel.tsx
+++ b/packages/core-components/src/layout/HeaderLabel/HeaderLabel.tsx
@@ -14,8 +14,9 @@
* limitations under the License.
*/
+import { BackstageTheme } from '@backstage/theme';
import Grid from '@material-ui/core/Grid';
-import { makeStyles } from '@material-ui/core/styles';
+import { alpha, makeStyles } from '@material-ui/core/styles';
import Typography from '@material-ui/core/Typography';
import React from 'react';
import { Link } from '../../components/Link';
@@ -23,13 +24,13 @@ import { Link } from '../../components/Link';
/** @public */
export type HeaderLabelClassKey = 'root' | 'label' | 'value';
-const useStyles = makeStyles(
+const useStyles = makeStyles(
theme => ({
root: {
textAlign: 'left',
},
label: {
- color: theme.palette.common.white,
+ color: theme.page.fontColor,
fontWeight: theme.typography.fontWeightBold,
letterSpacing: 0,
fontSize: theme.typography.fontSize,
@@ -37,7 +38,7 @@ const useStyles = makeStyles(
lineHeight: 1,
},
value: {
- color: 'rgba(255, 255, 255, 0.8)',
+ color: alpha(theme.page.fontColor, 0.8),
fontSize: theme.typography.fontSize,
lineHeight: 1,
},
@@ -50,9 +51,16 @@ type HeaderLabelContentProps = {
className: string;
};
-const HeaderLabelContent = ({ value, className }: HeaderLabelContentProps) => (
- {value}
-);
+const HeaderLabelContent = ({ value, className }: HeaderLabelContentProps) => {
+ return (
+
+ {value}
+
+ );
+};
type HeaderLabelProps = {
label: string;
diff --git a/packages/core-components/src/layout/SignInPage/commonProvider.tsx b/packages/core-components/src/layout/SignInPage/commonProvider.tsx
index 8f426a3907..1827981e6f 100644
--- a/packages/core-components/src/layout/SignInPage/commonProvider.tsx
+++ b/packages/core-components/src/layout/SignInPage/commonProvider.tsx
@@ -29,17 +29,24 @@ import { GridItem } from './styles';
import { ForwardedError } from '@backstage/errors';
import { UserIdentity } from './UserIdentity';
-const Component: ProviderComponent = ({ config, onSignInSuccess }) => {
+const Component: ProviderComponent = ({
+ config,
+ onSignInStarted,
+ onSignInSuccess,
+ onSignInFailure,
+}) => {
const { apiRef, title, message } = config as SignInProviderConfig;
const authApi = useApi(apiRef);
const errorApi = useApi(errorApiRef);
const handleLogin = async () => {
try {
+ onSignInStarted();
const identityResponse = await authApi.getBackstageIdentity({
instantPopup: true,
});
if (!identityResponse) {
+ onSignInFailure();
throw new Error(
`The ${title} provider is not configured to support sign-in`,
);
@@ -55,6 +62,7 @@ const Component: ProviderComponent = ({ config, onSignInSuccess }) => {
}),
);
} catch (error) {
+ onSignInFailure();
errorApi.post(new ForwardedError('Login failed', error));
}
};
diff --git a/packages/core-components/src/layout/SignInPage/customProvider.tsx b/packages/core-components/src/layout/SignInPage/customProvider.tsx
index 101c74d3cd..ad02715447 100644
--- a/packages/core-components/src/layout/SignInPage/customProvider.tsx
+++ b/packages/core-components/src/layout/SignInPage/customProvider.tsx
@@ -61,7 +61,7 @@ const asInputRef = (renderResult: UseFormRegisterReturn) => {
};
};
-const Component: ProviderComponent = ({ onSignInSuccess }) => {
+const Component: ProviderComponent = ({ onSignInStarted, onSignInSuccess }) => {
const classes = useFormStyles();
const { register, handleSubmit, formState } = useForm({
mode: 'onChange',
@@ -70,6 +70,7 @@ const Component: ProviderComponent = ({ onSignInSuccess }) => {
const { errors } = formState;
const handleResult = ({ userId, idToken }: Data) => {
+ onSignInStarted();
onSignInSuccess(
UserIdentity.fromLegacy({
userId,
diff --git a/packages/core-components/src/layout/SignInPage/guestProvider.tsx b/packages/core-components/src/layout/SignInPage/guestProvider.tsx
index b2370a98d5..5393c1ea89 100644
--- a/packages/core-components/src/layout/SignInPage/guestProvider.tsx
+++ b/packages/core-components/src/layout/SignInPage/guestProvider.tsx
@@ -22,7 +22,7 @@ import { GridItem } from './styles';
import { ProviderComponent, ProviderLoader, SignInProvider } from './types';
import { GuestUserIdentity } from './GuestUserIdentity';
-const Component: ProviderComponent = ({ onSignInSuccess }) => (
+const Component: ProviderComponent = ({ onSignInStarted, onSignInSuccess }) => (
(
diff --git a/packages/core-components/src/layout/SignInPage/providers.tsx b/packages/core-components/src/layout/SignInPage/providers.tsx
index 23d6c95b3c..e456a6948b 100644
--- a/packages/core-components/src/layout/SignInPage/providers.tsx
+++ b/packages/core-components/src/layout/SignInPage/providers.tsx
@@ -134,6 +134,7 @@ export const useSignInProviders = (
.loader(apiHolder, provider.config?.apiRef!)
.then(result => {
if (didCancel) {
+ localStorage.removeItem(PROVIDER_STORAGE_KEY);
return;
}
if (result) {
@@ -143,10 +144,10 @@ export const useSignInProviders = (
}
})
.catch(error => {
+ localStorage.removeItem(PROVIDER_STORAGE_KEY);
if (didCancel) {
return;
}
- localStorage.removeItem(PROVIDER_STORAGE_KEY);
errorApi.post(error);
setLoading(false);
});
@@ -172,16 +173,27 @@ export const useSignInProviders = (
const { Component } = provider.components;
const handleSignInSuccess = (result: IdentityApi) => {
- localStorage.setItem(PROVIDER_STORAGE_KEY, provider.id);
-
handleWrappedResult(result);
};
+ const handleSignInStarted = () => {
+ localStorage.setItem(
+ PROVIDER_STORAGE_KEY,
+ provider?.config?.id || provider.id,
+ );
+ };
+
+ const handleSignInFailure = () => {
+ localStorage.removeItem(PROVIDER_STORAGE_KEY);
+ };
+
return (
} map
+ * @property {() => void} clearCache
* @property {(path: string) => ExtendedPackage | undefined} byPath
*/
@@ -64,6 +65,9 @@ module.exports = (function () {
pkg => !path.relative(pkg.dir, filePath).startsWith('..'),
);
},
+ clearCache() {
+ result = undefined;
+ },
};
lastLoadAt = Date.now();
return result;
diff --git a/packages/eslint-plugin/lib/visitImports.js b/packages/eslint-plugin/lib/visitImports.js
index 1a344c1101..376c37575f 100644
--- a/packages/eslint-plugin/lib/visitImports.js
+++ b/packages/eslint-plugin/lib/visitImports.js
@@ -24,6 +24,16 @@ const getPackages = require('./getPackages');
* @type {object}
* @property {'local'} type
* @property {'value' | 'type'} kind
+ * @property {import('estree').Node} node
+ * @property {string} path
+ */
+
+/**
+ * @typedef ImportDirective
+ * @type {object}
+ * @property {'directive'} type
+ * @property {'value' | 'type'} kind
+ * @property {import('estree').Node} node
* @property {string} path
*/
@@ -32,6 +42,7 @@ const getPackages = require('./getPackages');
* @type {object}
* @property {'internal'} type
* @property {'value' | 'type'} kind
+ * @property {import('estree').Node} node
* @property {string} path
* @property {import('./getPackages').ExtendedPackage} package
* @property {string} packageName
@@ -42,6 +53,7 @@ const getPackages = require('./getPackages');
* @type {object}
* @property {'external'} type
* @property {'value' | 'type'} kind
+ * @property {import('estree').Node} node
* @property {string} path
* @property {string} packageName
*/
@@ -51,6 +63,7 @@ const getPackages = require('./getPackages');
* @type {object}
* @property {'builtin'} type
* @property {'value' | 'type'} kind
+ * @property {import('estree').Literal} node
* @property {string} path
* @property {string} packageName
*/
@@ -58,7 +71,7 @@ const getPackages = require('./getPackages');
/**
* @callback ImportVisitor
* @param {ConsideredNode} node
- * @param {LocalImport | InternalImport | ExternalImport | BuiltinImport} import
+ * @param {ImportDirective | LocalImport | InternalImport | ExternalImport | BuiltinImport} import
*/
/**
@@ -68,7 +81,7 @@ const getPackages = require('./getPackages');
/**
* @param {ConsideredNode} node
- * @returns {undefined | {path: string, kind: 'type' | 'value'}}
+ * @returns {undefined | {path: string, node: import('estree').Literal, kind: 'type' | 'value'}}
*/
function getImportInfo(node) {
/** @type {import('estree').Expression | import('estree').SpreadElement | undefined | null} */
@@ -95,7 +108,11 @@ function getImportInfo(node) {
/** @type {any} */
const anyNode = node;
- return { path: pathNode.value, kind: anyNode.importKind ?? 'value' };
+ return {
+ path: pathNode.value,
+ node: pathNode,
+ kind: anyNode.importKind ?? 'value',
+ };
}
/**
@@ -122,6 +139,10 @@ module.exports = function visitImports(context, visitor) {
return visitor(node, { type: 'local', ...info });
}
+ if (info.path.startsWith('directive:')) {
+ return visitor(node, { type: 'directive', ...info });
+ }
+
const pathParts = info.path.split('/');
// Check for match with plain name, then namespaced name
@@ -143,6 +164,7 @@ module.exports = function visitImports(context, visitor) {
return visitor(node, {
type: 'builtin',
kind: info.kind,
+ node: info.node,
path: subPath,
packageName,
});
@@ -151,6 +173,7 @@ module.exports = function visitImports(context, visitor) {
return visitor(node, {
type: 'external',
kind: info.kind,
+ node: info.node,
path: subPath,
packageName,
});
@@ -159,6 +182,7 @@ module.exports = function visitImports(context, visitor) {
return visitor(node, {
type: 'internal',
kind: info.kind,
+ node: info.node,
path: subPath,
package: pkg,
packageName,
diff --git a/packages/eslint-plugin/package.json b/packages/eslint-plugin/package.json
index fcc038cdbf..5a37dcc871 100644
--- a/packages/eslint-plugin/package.json
+++ b/packages/eslint-plugin/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/eslint-plugin",
"description": "Backstage ESLint plugin",
- "version": "0.1.2-next.0",
+ "version": "0.1.3-next.0",
"publishConfig": {
"access": "public"
},
diff --git a/packages/eslint-plugin/rules/no-undeclared-imports.js b/packages/eslint-plugin/rules/no-undeclared-imports.js
index b1e11d1b97..06f0afed46 100644
--- a/packages/eslint-plugin/rules/no-undeclared-imports.js
+++ b/packages/eslint-plugin/rules/no-undeclared-imports.js
@@ -20,6 +20,7 @@ const path = require('path');
const getPackageMap = require('../lib/getPackages');
const visitImports = require('../lib/visitImports');
const minimatch = require('minimatch');
+const { execFileSync } = require('child_process');
const depFields = {
dep: 'dependencies',
@@ -124,11 +125,13 @@ function getAddFlagForDepsField(depsField) {
module.exports = {
meta: {
type: 'problem',
+ fixable: 'code',
messages: {
undeclared:
"{{ packageName }} must be declared in {{ depsField }} of {{ packageJsonPath }}, run 'yarn --cwd {{ packagePath }} add{{ addFlag }} {{ packageName }}' from the project root.",
switch:
'{{ packageName }} is declared in {{ oldDepsField }}, but should be moved to {{ depsField }} in {{ packageJsonPath }}.',
+ switchBack: 'Switch back to import declaration',
},
docs: {
description:
@@ -150,63 +153,150 @@ module.exports = {
return {};
}
- return visitImports(context, (node, imp) => {
- // We leave checking of type imports to the repo-tools check,
- // and we skip builtins and local imports
- if (
- imp.kind === 'type' ||
- imp.type === 'builtin' ||
- imp.type === 'local'
- ) {
- return;
- }
+ /** @type Array<{name: string, flag: string, node: import('estree').Node}> */
+ const importsToAdd = [];
- // We skip imports for the package itself
- if (imp.packageName === localPkg.packageJson.name) {
- return;
- }
+ return {
+ // All missing imports that we detect are collected as we traverse, and then we use
+ // the program exit to execute all install directives that have been found.
+ ['Program:exit']() {
+ /** @type Record> */
+ const byFlag = {};
- const modulePath = path.relative(localPkg.dir, filePath);
- const expectedType = getExpectedDepType(
- localPkg.packageJson,
- imp.packageName,
- modulePath,
- );
+ for (const { name, flag } of importsToAdd) {
+ byFlag[flag] = byFlag[flag] ?? new Set();
+ byFlag[flag].add(name);
+ }
- const conflict = findConflict(
- localPkg.packageJson,
- imp.packageName,
- expectedType,
- );
+ for (const name of byFlag[''] ?? []) {
+ byFlag['--dev']?.delete(name);
+ }
+ for (const name of byFlag['--peer'] ?? []) {
+ byFlag['']?.delete(name);
+ byFlag['--dev']?.delete(name);
+ }
- if (conflict) {
- try {
- const fullImport = imp.path
- ? `${imp.packageName}/${imp.path}`
- : imp.packageName;
- require.resolve(fullImport, {
- paths: [localPkg.dir],
+ for (const [flag, names] of Object.entries(byFlag)) {
+ // The security implication of this is a bit interesting, as crafted add-import
+ // directives could be used to install malicious packages. However, the same is true
+ // for adding malicious packages to package.json, so there's significant difference.
+ execFileSync('yarn', ['add', ...(flag || []), ...names], {
+ cwd: localPkg.dir,
+ stdio: 'inherit',
});
- } catch {
- // If the dependency doesn't resolve then it's likely a type import, ignore
+ }
+
+ // This switches all import directives back to the original import.
+ for (const added of importsToAdd) {
+ context.report({
+ node: added.node,
+ messageId: 'switchBack',
+ fix(fixer) {
+ return fixer.replaceText(added.node, `'${added.name}'`);
+ },
+ });
+ }
+
+ importsToAdd.length = 0;
+ packages.clearCache();
+ },
+ ...visitImports(context, (node, imp) => {
+ // We leave checking of type imports to the repo-tools check,
+ // and we skip builtins and local imports
+ if (
+ imp.kind === 'type' ||
+ imp.type === 'builtin' ||
+ imp.type === 'local'
+ ) {
return;
}
- const packagePath = path.relative(packages.root.dir, localPkg.dir);
- const packageJsonPath = path.join(packagePath, 'package.json');
+ // Any import directive that is found is collected for processing later
+ if (imp.type === 'directive') {
+ const parts = imp.path.split(':');
+ if (parts[1] !== 'add-import') {
+ return;
+ }
+ const [type, name] = parts.slice(2);
+ if (!name.match(/^(@[-\w\.~]+\/)?[-\w\.~]*$/i)) {
+ throw new Error(
+ `Invalid package name to add as dependency: '${name}'`,
+ );
+ }
- context.report({
- node,
- messageId: conflict.oldDepsField ? 'switch' : 'undeclared',
- data: {
- ...conflict,
- packagePath,
- addFlag: getAddFlagForDepsField(conflict.depsField),
- packageName: imp.packageName,
- packageJsonPath: packageJsonPath,
- },
- });
- }
- });
+ importsToAdd.push({
+ flag: getAddFlagForDepsField(type).trim(),
+ name,
+ node: imp.node,
+ });
+ return;
+ }
+
+ // We skip imports for the package itself
+ if (imp.packageName === localPkg.packageJson.name) {
+ return;
+ }
+
+ const modulePath = path.relative(localPkg.dir, filePath);
+ const expectedType = getExpectedDepType(
+ localPkg.packageJson,
+ imp.packageName,
+ modulePath,
+ );
+
+ const conflict = findConflict(
+ localPkg.packageJson,
+ imp.packageName,
+ expectedType,
+ );
+
+ if (conflict) {
+ try {
+ const fullImport = imp.path
+ ? `${imp.packageName}/${imp.path}`
+ : imp.packageName;
+ require.resolve(fullImport, {
+ paths: [localPkg.dir],
+ });
+ } catch {
+ // If the dependency doesn't resolve then it's likely a type import, ignore
+ return;
+ }
+
+ const packagePath = path.relative(packages.root.dir, localPkg.dir);
+ const packageJsonPath = path.join(packagePath, 'package.json');
+
+ context.report({
+ node,
+ messageId: conflict.oldDepsField ? 'switch' : 'undeclared',
+ data: {
+ ...conflict,
+ packagePath,
+ addFlag: getAddFlagForDepsField(conflict.depsField),
+ packageName: imp.packageName,
+ packageJsonPath: packageJsonPath,
+ },
+ // This fix callback is always executed, regardless of whether linting is run with
+ // fixes enabled or not. There is no way to determine if fixes are being applied, so
+ // instead our fix will replace the import with a directive that will be picked up
+ // on the next run. When ESLint applies fixes all rules are re-run to make sure the fixes
+ // applied correctly, which means that these directives will be picked up, executed,
+ // and switched back to the original import immediately.
+ // This is not true for all editor integrations. For example, VSCode translates there fixes
+ // to native editor commands, and does not re-run ESLint. This means that the import directive
+ // will end up in source code, and the import directive fix needs to be applied manually too.
+ // There is to my knowledge no way around this that doesn't get very hacky, so it will do for now.
+ fix: conflict.oldDepsField
+ ? undefined
+ : fixer => {
+ return fixer.replaceText(
+ imp.node,
+ `'directive:add-import:${conflict.depsField}:${imp.packageName}'`,
+ );
+ },
+ });
+ }
+ }),
+ };
},
};
diff --git a/packages/eslint-plugin/src/no-undeclared-imports.test.ts b/packages/eslint-plugin/src/no-undeclared-imports.test.ts
index 78844899ba..e92d422057 100644
--- a/packages/eslint-plugin/src/no-undeclared-imports.test.ts
+++ b/packages/eslint-plugin/src/no-undeclared-imports.test.ts
@@ -18,6 +18,10 @@ import { RuleTester } from 'eslint';
import { join as joinPath } from 'path';
import rule from '../rules/no-undeclared-imports';
+jest.mock('child_process', () => ({
+ execFileSync: jest.fn(),
+}));
+
const RULE = 'no-undeclared-imports';
const FIXTURE = joinPath(__dirname, '__fixtures__/monorepo');
@@ -45,6 +49,9 @@ const ERR_SWITCHED = (
'package.json',
)}.`,
});
+const ERR_SWITCH_BACK = () => ({
+ message: 'Switch back to import declaration',
+});
process.chdir(FIXTURE);
@@ -130,6 +137,7 @@ ruleTester.run(RULE, rule, {
},
{
code: `import 'lodash'`,
+ output: `import 'directive:add-import:dependencies:lodash'`,
filename: joinPath(FIXTURE, 'packages/bar/src/index.ts'),
errors: [
ERR_UNDECLARED('lodash', 'dependencies', joinPath('packages', 'bar')),
@@ -137,6 +145,7 @@ ruleTester.run(RULE, rule, {
},
{
code: `import { debounce } from 'lodash'`,
+ output: `import { debounce } from 'directive:add-import:dependencies:lodash'`,
filename: joinPath(FIXTURE, 'packages/bar/src/index.ts'),
errors: [
ERR_UNDECLARED('lodash', 'dependencies', joinPath('packages', 'bar')),
@@ -144,6 +153,7 @@ ruleTester.run(RULE, rule, {
},
{
code: `import * as _ from 'lodash'`,
+ output: `import * as _ from 'directive:add-import:dependencies:lodash'`,
filename: joinPath(FIXTURE, 'packages/bar/src/index.ts'),
errors: [
ERR_UNDECLARED('lodash', 'dependencies', joinPath('packages', 'bar')),
@@ -151,6 +161,7 @@ ruleTester.run(RULE, rule, {
},
{
code: `import _ from 'lodash'`,
+ output: `import _ from 'directive:add-import:dependencies:lodash'`,
filename: joinPath(FIXTURE, 'packages/bar/src/index.ts'),
errors: [
ERR_UNDECLARED('lodash', 'dependencies', joinPath('packages', 'bar')),
@@ -158,6 +169,7 @@ ruleTester.run(RULE, rule, {
},
{
code: `import('lodash')`,
+ output: `import('directive:add-import:dependencies:lodash')`,
filename: joinPath(FIXTURE, 'packages/bar/src/index.ts'),
errors: [
ERR_UNDECLARED('lodash', 'dependencies', joinPath('packages', 'bar')),
@@ -165,6 +177,7 @@ ruleTester.run(RULE, rule, {
},
{
code: `require('lodash')`,
+ output: `require('directive:add-import:dependencies:lodash')`,
filename: joinPath(FIXTURE, 'packages/bar/src/index.ts'),
errors: [
ERR_UNDECLARED('lodash', 'dependencies', joinPath('packages', 'bar')),
@@ -172,13 +185,7 @@ ruleTester.run(RULE, rule, {
},
{
code: `import 'lodash'`,
- filename: joinPath(FIXTURE, 'packages/bar/src/index.ts'),
- errors: [
- ERR_UNDECLARED('lodash', 'dependencies', joinPath('packages', 'bar')),
- ],
- },
- {
- code: `import 'lodash'`,
+ output: `import 'directive:add-import:devDependencies:lodash'`,
filename: joinPath(FIXTURE, 'packages/bar/src/index.test.ts'),
errors: [
ERR_UNDECLARED(
@@ -191,6 +198,7 @@ ruleTester.run(RULE, rule, {
},
{
code: `import 'react'`,
+ output: `import 'directive:add-import:peerDependencies:react'`,
filename: joinPath(FIXTURE, 'packages/bar/src/index.ts'),
errors: [
ERR_UNDECLARED(
@@ -203,6 +211,7 @@ ruleTester.run(RULE, rule, {
},
{
code: `import 'react'`,
+ output: `import 'directive:add-import:peerDependencies:react'`,
filename: joinPath(FIXTURE, 'packages/bar/src/index.test.ts'),
errors: [
ERR_UNDECLARED(
@@ -215,6 +224,7 @@ ruleTester.run(RULE, rule, {
},
{
code: `import 'react-dom'`,
+ output: `import 'directive:add-import:dependencies:react-dom'`,
filename: joinPath(FIXTURE, 'packages/foo/src/index.ts'),
errors: [
ERR_UNDECLARED(
@@ -226,6 +236,7 @@ ruleTester.run(RULE, rule, {
},
{
code: `import 'react-dom'`,
+ output: `import 'directive:add-import:devDependencies:react-dom'`,
filename: joinPath(FIXTURE, 'packages/foo/src/index.test.ts'),
errors: [
ERR_UNDECLARED(
@@ -238,6 +249,7 @@ ruleTester.run(RULE, rule, {
},
{
code: `import '@internal/foo'`,
+ output: `import 'directive:add-import:dependencies:@internal/foo'`,
filename: joinPath(FIXTURE, 'packages/bar/src/index.ts'),
errors: [
ERR_UNDECLARED(
@@ -247,5 +259,43 @@ ruleTester.run(RULE, rule, {
),
],
},
+
+ // Switching back to original import declarations
+ {
+ code: `import 'directive:add-import:dependencies:lodash'`,
+ output: `import 'lodash'`,
+ filename: joinPath(FIXTURE, 'packages/bar/src/index.ts'),
+ errors: [ERR_SWITCH_BACK()],
+ },
+ {
+ code: `import { debounce } from 'directive:add-import:dependencies:lodash'`,
+ output: `import { debounce } from 'lodash'`,
+ filename: joinPath(FIXTURE, 'packages/bar/src/index.ts'),
+ errors: [ERR_SWITCH_BACK()],
+ },
+ {
+ code: `import * as _ from 'directive:add-import:dependencies:lodash'`,
+ output: `import * as _ from 'lodash'`,
+ filename: joinPath(FIXTURE, 'packages/bar/src/index.ts'),
+ errors: [ERR_SWITCH_BACK()],
+ },
+ {
+ code: `import _ from 'directive:add-import:dependencies:lodash'`,
+ output: `import _ from 'lodash'`,
+ filename: joinPath(FIXTURE, 'packages/bar/src/index.ts'),
+ errors: [ERR_SWITCH_BACK()],
+ },
+ {
+ code: `import('directive:add-import:dependencies:lodash')`,
+ output: `import('lodash')`,
+ filename: joinPath(FIXTURE, 'packages/bar/src/index.ts'),
+ errors: [ERR_SWITCH_BACK()],
+ },
+ {
+ code: `require('directive:add-import:dependencies:lodash')`,
+ output: `require('lodash')`,
+ filename: joinPath(FIXTURE, 'packages/bar/src/index.ts'),
+ errors: [ERR_SWITCH_BACK()],
+ },
],
});
diff --git a/packages/integration-aws-node/CHANGELOG.md b/packages/integration-aws-node/CHANGELOG.md
index e5ac2a8532..40192bdfaf 100644
--- a/packages/integration-aws-node/CHANGELOG.md
+++ b/packages/integration-aws-node/CHANGELOG.md
@@ -1,5 +1,13 @@
# @backstage/integration-aws-node
+## 0.1.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/errors@1.1.5
+ - @backstage/config@1.0.7
+
## 0.1.2-next.0
### Patch Changes
diff --git a/packages/integration-aws-node/package.json b/packages/integration-aws-node/package.json
index a45cb03e14..7afc31cc47 100644
--- a/packages/integration-aws-node/package.json
+++ b/packages/integration-aws-node/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/integration-aws-node",
"description": "Helpers for fetching AWS account credentials",
- "version": "0.1.2-next.0",
+ "version": "0.1.2",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
diff --git a/packages/integration-react/CHANGELOG.md b/packages/integration-react/CHANGELOG.md
index 028c939822..02a8c9b7e4 100644
--- a/packages/integration-react/CHANGELOG.md
+++ b/packages/integration-react/CHANGELOG.md
@@ -1,5 +1,28 @@
# @backstage/integration-react
+## 1.1.12-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/theme@0.2.18
+
+## 1.1.11
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/integration@1.4.3
+ - @backstage/config@1.0.7
+ - @backstage/theme@0.2.18
+
## 1.1.11-next.2
### Patch Changes
diff --git a/packages/integration-react/package.json b/packages/integration-react/package.json
index 119a8683d6..39a8a9908a 100644
--- a/packages/integration-react/package.json
+++ b/packages/integration-react/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/integration-react",
"description": "Frontend package for managing integrations towards external systems",
- "version": "1.1.11-next.2",
+ "version": "1.1.12-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -30,7 +30,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"react-use": "^17.2.4"
},
"peerDependencies": {
diff --git a/packages/integration/CHANGELOG.md b/packages/integration/CHANGELOG.md
index 3a84452505..f81b1824fe 100644
--- a/packages/integration/CHANGELOG.md
+++ b/packages/integration/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/integration
+## 1.4.3
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/errors@1.1.5
+ - @backstage/config@1.0.7
+
## 1.4.3-next.0
### Patch Changes
diff --git a/packages/integration/package.json b/packages/integration/package.json
index 02c19e1b1d..25e6ba8bf7 100644
--- a/packages/integration/package.json
+++ b/packages/integration/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/integration",
"description": "Helpers for managing integrations towards external systems",
- "version": "1.4.3-next.0",
+ "version": "1.4.3",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/packages/release-manifests/CHANGELOG.md b/packages/release-manifests/CHANGELOG.md
index fa15839a35..f59447666f 100644
--- a/packages/release-manifests/CHANGELOG.md
+++ b/packages/release-manifests/CHANGELOG.md
@@ -1,5 +1,11 @@
# @backstage/release-manifests
+## 0.0.9
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+
## 0.0.9-next.0
### Patch Changes
diff --git a/packages/release-manifests/package.json b/packages/release-manifests/package.json
index 65d1026ca6..0c6ad64446 100644
--- a/packages/release-manifests/package.json
+++ b/packages/release-manifests/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/release-manifests",
"description": "Helper library for receiving release manifests",
- "version": "0.0.9-next.0",
+ "version": "0.0.9",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
diff --git a/packages/repo-tools/CHANGELOG.md b/packages/repo-tools/CHANGELOG.md
index 996377c198..5893c3d87c 100644
--- a/packages/repo-tools/CHANGELOG.md
+++ b/packages/repo-tools/CHANGELOG.md
@@ -1,5 +1,24 @@
# @backstage/repo-tools
+## 0.1.4-next.0
+
+### Patch Changes
+
+- 9129ca8cabb: Log API report instructions when api-report is missing.
+- Updated dependencies
+ - @backstage/cli-common@0.1.12
+ - @backstage/errors@1.1.5
+
+## 0.1.3
+
+### Patch Changes
+
+- 32a4a05838c: Tweaked type dependency check to trim wildcard type imports.
+- 6ba8faf22ac: The API report generation process is now able to detect and generate reports for additional entry points declared in the package `"exports"` field.
+- Updated dependencies
+ - @backstage/errors@1.1.5
+ - @backstage/cli-common@0.1.12
+
## 0.1.3-next.1
### Patch Changes
diff --git a/packages/repo-tools/package.json b/packages/repo-tools/package.json
index 9d24bfad2c..fb1d0c4af8 100644
--- a/packages/repo-tools/package.json
+++ b/packages/repo-tools/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/repo-tools",
"description": "CLI for Backstage repo tooling ",
- "version": "0.1.3-next.1",
+ "version": "0.1.4-next.0",
"publishConfig": {
"access": "public"
},
diff --git a/packages/repo-tools/src/commands/api-reports/api-extractor.ts b/packages/repo-tools/src/commands/api-reports/api-extractor.ts
index 1fe7602617..8194ede7a4 100644
--- a/packages/repo-tools/src/commands/api-reports/api-extractor.ts
+++ b/packages/repo-tools/src/commands/api-reports/api-extractor.ts
@@ -487,6 +487,9 @@ export async function runApiExtraction({
showVerboseMessages: false,
showDiagnostics: false,
messageCallback(message) {
+ if (message.text.includes('The API report file is missing')) {
+ shouldLogInstructions = true;
+ }
if (
message.text.includes(
'You have changed the public API signature for this project.',
@@ -506,7 +509,11 @@ export async function runApiExtraction({
// This release tag validation makes sure that the release tag of known entry points match expectations.
// The root index entrypoint is only allowed @public exports, while /alpha and /beta only allow @alpha and @beta.
- if (validateReleaseTags && !usesExperimentalTypeBuild) {
+ if (
+ validateReleaseTags &&
+ !usesExperimentalTypeBuild &&
+ fs.pathExistsSync(extractorConfig.reportFilePath)
+ ) {
if (['index', 'alpha', 'beta'].includes(name)) {
const report = await fs.readFile(
extractorConfig.reportFilePath,
diff --git a/packages/techdocs-cli-embedded-app/CHANGELOG.md b/packages/techdocs-cli-embedded-app/CHANGELOG.md
index 2d2b669e38..e1c03b9f9c 100644
--- a/packages/techdocs-cli-embedded-app/CHANGELOG.md
+++ b/packages/techdocs-cli-embedded-app/CHANGELOG.md
@@ -1,5 +1,43 @@
# techdocs-cli-embedded-app
+## 0.2.81-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog@1.10.0-next.0
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/app-defaults@1.3.0-next.0
+ - @backstage/core-app-api@1.7.0-next.0
+ - @backstage/test-utils@1.3.0-next.0
+ - @backstage/plugin-techdocs@1.6.1-next.0
+ - @backstage/cli@0.22.6-next.0
+ - @backstage/plugin-techdocs-react@1.1.5-next.0
+ - @backstage/integration-react@1.1.12-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.2.80
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog@1.9.0
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-techdocs-react@1.1.4
+ - @backstage/plugin-techdocs@1.6.0
+ - @backstage/cli@0.22.4
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/test-utils@1.2.6
+ - @backstage/core-app-api@1.6.0
+ - @backstage/integration-react@1.1.11
+ - @backstage/config@1.0.7
+ - @backstage/theme@0.2.18
+ - @backstage/app-defaults@1.2.1
+
## 0.2.80-next.2
### Patch Changes
diff --git a/packages/techdocs-cli-embedded-app/package.json b/packages/techdocs-cli-embedded-app/package.json
index 2cbb1aabc8..eab13938f4 100644
--- a/packages/techdocs-cli-embedded-app/package.json
+++ b/packages/techdocs-cli-embedded-app/package.json
@@ -1,6 +1,6 @@
{
"name": "techdocs-cli-embedded-app",
- "version": "0.2.80-next.2",
+ "version": "0.2.81-next.0",
"private": true,
"backstage": {
"role": "frontend"
diff --git a/packages/techdocs-cli/CHANGELOG.md b/packages/techdocs-cli/CHANGELOG.md
index facd967e90..9c1aaee26a 100644
--- a/packages/techdocs-cli/CHANGELOG.md
+++ b/packages/techdocs-cli/CHANGELOG.md
@@ -1,5 +1,33 @@
# @techdocs/cli
+## 1.4.1-next.0
+
+### Patch Changes
+
+- b348420a804: Adding global-agent to enable the ability to publish through a proxy
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/catalog-model@1.2.1
+ - @backstage/cli-common@0.1.12
+ - @backstage/plugin-techdocs-node@1.6.1-next.0
+
+## 1.4.0
+
+### Minor Changes
+
+- 8e465ce52e2: Running `@techdocs/cli generate` with the `--verbose` flag will now print the mkdocs output.
+- ea2bbef1b16: Added support for an HTTPS proxy for techdocs AWS S3 requests
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-techdocs-node@1.6.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/catalog-model@1.2.1
+ - @backstage/cli-common@0.1.12
+ - @backstage/config@1.0.7
+
## 1.4.0-next.2
### Patch Changes
diff --git a/packages/techdocs-cli/README.md b/packages/techdocs-cli/README.md
index ae296d2c26..85c0075946 100644
--- a/packages/techdocs-cli/README.md
+++ b/packages/techdocs-cli/README.md
@@ -40,6 +40,14 @@ yarn start
yarn techdocs-cli:dev [...options]
```
+### Connecting behind a proxy
+
+```sh
+# Prior to executing the techdocs-cli command
+export GLOBAL_AGENT_HTTPS_PROXY=${HTTP_PROXY}
+export GLOBAL_AGENT_NO_PROXY=${NO_PROXY}
+```
+
### 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.
diff --git a/packages/techdocs-cli/package.json b/packages/techdocs-cli/package.json
index e8d9277871..c8929f3d6a 100644
--- a/packages/techdocs-cli/package.json
+++ b/packages/techdocs-cli/package.json
@@ -1,7 +1,7 @@
{
"name": "@techdocs/cli",
"description": "Utility CLI for managing TechDocs sites in Backstage.",
- "version": "1.4.0-next.2",
+ "version": "1.4.1-next.0",
"publishConfig": {
"access": "public"
},
@@ -69,6 +69,7 @@
"commander": "^9.1.0",
"dockerode": "^3.3.1",
"fs-extra": "^10.0.1",
+ "global-agent": "^3.0.0",
"http-proxy": "^1.18.1",
"react-dev-utils": "^12.0.0-next.60",
"serve-handler": "^6.1.3",
diff --git a/packages/test-utils/CHANGELOG.md b/packages/test-utils/CHANGELOG.md
index e521e9af91..382cce8c09 100644
--- a/packages/test-utils/CHANGELOG.md
+++ b/packages/test-utils/CHANGELOG.md
@@ -1,5 +1,38 @@
# @backstage/test-utils
+## 1.3.0-next.0
+
+### Minor Changes
+
+- 7908d72e033: Introduce a new global config parameter, `auth.enableExperimentalRedirectFlow`. When enabled, auth will happen with an in-window redirect flow rather than through a popup window.
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-app-api@1.7.0-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/plugin-permission-react@0.4.11
+ - @backstage/theme@0.2.18
+ - @backstage/types@1.0.2
+ - @backstage/plugin-permission-common@0.7.4
+
+## 1.2.6
+
+### Patch Changes
+
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- 482dae5de1c: Updated link to docs.
+- Updated dependencies
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/core-app-api@1.6.0
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/config@1.0.7
+ - @backstage/theme@0.2.18
+ - @backstage/types@1.0.2
+ - @backstage/plugin-permission-react@0.4.11
+
## 1.2.6-next.2
### Patch Changes
diff --git a/packages/test-utils/package.json b/packages/test-utils/package.json
index 59ec2ce989..7670d43cbd 100644
--- a/packages/test-utils/package.json
+++ b/packages/test-utils/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/test-utils",
"description": "Utilities to test Backstage plugins and apps.",
- "version": "1.2.6-next.2",
+ "version": "1.3.0-next.0",
"publishConfig": {
"access": "public"
},
diff --git a/packages/test-utils/src/testUtils/defaultApis.ts b/packages/test-utils/src/testUtils/defaultApis.ts
index 1ff10bfe6f..2231d28cd0 100644
--- a/packages/test-utils/src/testUtils/defaultApis.ts
+++ b/packages/test-utils/src/testUtils/defaultApis.ts
@@ -89,6 +89,7 @@ export const defaultApis = [
},
factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
GoogleAuth.create({
+ configApi,
discoveryApi,
oauthRequestApi,
environment: configApi.getOptionalString('auth.environment'),
@@ -103,6 +104,7 @@ export const defaultApis = [
},
factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
MicrosoftAuth.create({
+ configApi,
discoveryApi,
oauthRequestApi,
environment: configApi.getOptionalString('auth.environment'),
@@ -117,6 +119,7 @@ export const defaultApis = [
},
factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
GithubAuth.create({
+ configApi,
discoveryApi,
oauthRequestApi,
defaultScopes: ['read:user'],
@@ -132,6 +135,7 @@ export const defaultApis = [
},
factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
OktaAuth.create({
+ configApi,
discoveryApi,
oauthRequestApi,
environment: configApi.getOptionalString('auth.environment'),
@@ -146,6 +150,7 @@ export const defaultApis = [
},
factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
GitlabAuth.create({
+ configApi,
discoveryApi,
oauthRequestApi,
environment: configApi.getOptionalString('auth.environment'),
@@ -160,6 +165,7 @@ export const defaultApis = [
},
factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
OneLoginAuth.create({
+ configApi,
discoveryApi,
oauthRequestApi,
environment: configApi.getOptionalString('auth.environment'),
@@ -174,6 +180,7 @@ export const defaultApis = [
},
factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
BitbucketAuth.create({
+ configApi,
discoveryApi,
oauthRequestApi,
defaultScopes: ['team'],
@@ -189,6 +196,7 @@ export const defaultApis = [
},
factory: ({ discoveryApi, oauthRequestApi, configApi }) => {
return AtlassianAuth.create({
+ configApi,
discoveryApi,
oauthRequestApi,
environment: configApi.getOptionalString('auth.environment'),
diff --git a/packages/theme/CHANGELOG.md b/packages/theme/CHANGELOG.md
index 2950839e68..5f25f513d4 100644
--- a/packages/theme/CHANGELOG.md
+++ b/packages/theme/CHANGELOG.md
@@ -1,5 +1,11 @@
# @backstage/theme
+## 0.2.18
+
+### Patch Changes
+
+- 482dae5de1c: Updated link to docs.
+
## 0.2.18-next.0
### Patch Changes
diff --git a/packages/theme/package.json b/packages/theme/package.json
index d24a43abdb..999fb02dac 100644
--- a/packages/theme/package.json
+++ b/packages/theme/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/theme",
"description": "material-ui theme for use with Backstage.",
- "version": "0.2.18-next.0",
+ "version": "0.2.18",
"publishConfig": {
"access": "public",
"main": "dist/index.esm.js",
diff --git a/plugins/adr-backend/CHANGELOG.md b/plugins/adr-backend/CHANGELOG.md
index 58b37f1731..53fb3b9f8d 100644
--- a/plugins/adr-backend/CHANGELOG.md
+++ b/plugins/adr-backend/CHANGELOG.md
@@ -1,5 +1,36 @@
# @backstage/plugin-adr-backend
+## 0.3.2-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-adr-common@0.2.7
+ - @backstage/plugin-search-common@1.2.2
+
+## 0.3.1
+
+### Patch Changes
+
+- 2a73ded3861: Support MADR v3 format
+- 8bf24946c66: Adjust express dependencies to be the same as the rest of the project
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/catalog-model@1.2.1
+ - @backstage/integration@1.4.3
+ - @backstage/config@1.0.7
+ - @backstage/plugin-adr-common@0.2.7
+ - @backstage/plugin-search-common@1.2.2
+
## 0.3.1-next.2
### Patch Changes
diff --git a/plugins/adr-backend/package.json b/plugins/adr-backend/package.json
index f73bf159b0..fb0c211284 100644
--- a/plugins/adr-backend/package.json
+++ b/plugins/adr-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-adr-backend",
- "version": "0.3.1-next.2",
+ "version": "0.3.2-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/adr-backend/src/index.ts b/plugins/adr-backend/src/index.ts
index 5cc8f50b72..89c88ab3e7 100644
--- a/plugins/adr-backend/src/index.ts
+++ b/plugins/adr-backend/src/index.ts
@@ -15,7 +15,7 @@
*/
/**
- * ADR backend plugin
+ * Architecture Decision Records backend plugin.
*
* @packageDocumentation
*/
diff --git a/plugins/adr-common/CHANGELOG.md b/plugins/adr-common/CHANGELOG.md
index 5040e0955c..6b5a58da2a 100644
--- a/plugins/adr-common/CHANGELOG.md
+++ b/plugins/adr-common/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/plugin-adr-common
+## 0.2.7
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/catalog-model@1.2.1
+ - @backstage/integration@1.4.3
+ - @backstage/plugin-search-common@1.2.2
+
## 0.2.7-next.1
### Patch Changes
diff --git a/plugins/adr-common/package.json b/plugins/adr-common/package.json
index 9eeeeb2803..e6364f7915 100644
--- a/plugins/adr-common/package.json
+++ b/plugins/adr-common/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-adr-common",
"description": "Common functionalities for the adr plugin",
- "version": "0.2.7-next.1",
+ "version": "0.2.7",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/adr/CHANGELOG.md b/plugins/adr/CHANGELOG.md
index a50f1a60d3..f67ab9bc20 100644
--- a/plugins/adr/CHANGELOG.md
+++ b/plugins/adr/CHANGELOG.md
@@ -1,5 +1,38 @@
# @backstage/plugin-adr
+## 0.4.2-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-search-react@1.5.2-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/integration-react@1.1.12-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-adr-common@0.2.7
+ - @backstage/plugin-search-common@1.2.2
+
+## 0.4.1
+
+### Patch Changes
+
+- d293f4aaf83: Updated readme instructions
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/plugin-search-react@1.5.1
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/integration-react@1.1.11
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-adr-common@0.2.7
+ - @backstage/plugin-search-common@1.2.2
+
## 0.4.1-next.2
### Patch Changes
diff --git a/plugins/adr/package.json b/plugins/adr/package.json
index 5e56c39638..453ff62792 100644
--- a/plugins/adr/package.json
+++ b/plugins/adr/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-adr",
- "version": "0.4.1-next.2",
+ "version": "0.4.2-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -33,7 +33,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"react-markdown": "^8.0.0",
"react-use": "^17.2.4",
"remark-gfm": "^3.0.1"
diff --git a/plugins/adr/src/index.ts b/plugins/adr/src/index.ts
index f24b3ac531..f405621c4a 100644
--- a/plugins/adr/src/index.ts
+++ b/plugins/adr/src/index.ts
@@ -15,7 +15,7 @@
*/
/**
- * ADR frontend plugin
+ * Architecture Decision Records frontend plugin.
*
* @packageDocumentation
*/
diff --git a/plugins/airbrake-backend/CHANGELOG.md b/plugins/airbrake-backend/CHANGELOG.md
index bcbd88a755..29771be91c 100644
--- a/plugins/airbrake-backend/CHANGELOG.md
+++ b/plugins/airbrake-backend/CHANGELOG.md
@@ -1,5 +1,22 @@
# @backstage/plugin-airbrake-backend
+## 0.2.17-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+
+## 0.2.16
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/backend-common@0.18.3
+ - @backstage/config@1.0.7
+
## 0.2.16-next.2
### Patch Changes
diff --git a/plugins/airbrake-backend/package.json b/plugins/airbrake-backend/package.json
index 52bd89e909..fa3c29c022 100644
--- a/plugins/airbrake-backend/package.json
+++ b/plugins/airbrake-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-airbrake-backend",
- "version": "0.2.16-next.2",
+ "version": "0.2.17-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/airbrake/CHANGELOG.md b/plugins/airbrake/CHANGELOG.md
index 088bfbdcf9..e0efd2802b 100644
--- a/plugins/airbrake/CHANGELOG.md
+++ b/plugins/airbrake/CHANGELOG.md
@@ -1,5 +1,33 @@
# @backstage/plugin-airbrake
+## 0.3.17-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/test-utils@1.3.0-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/dev-utils@1.0.14-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.3.16
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/test-utils@1.2.6
+ - @backstage/dev-utils@1.0.13
+ - @backstage/theme@0.2.18
+
## 0.3.16-next.2
### Patch Changes
diff --git a/plugins/airbrake/package.json b/plugins/airbrake/package.json
index e577ee8862..8249410795 100644
--- a/plugins/airbrake/package.json
+++ b/plugins/airbrake/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-airbrake",
- "version": "0.3.16-next.2",
+ "version": "0.3.17-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -31,7 +31,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"react-use": "^17.2.4"
},
"peerDependencies": {
diff --git a/plugins/airbrake/src/index.ts b/plugins/airbrake/src/index.ts
index 717d544dc9..6f189e36b8 100644
--- a/plugins/airbrake/src/index.ts
+++ b/plugins/airbrake/src/index.ts
@@ -15,7 +15,7 @@
*/
/**
- * The Airbrake plugin provides connectivity between Backstage and Airbrake (https://airbrake.io/).
+ * The Airbrake plugin provides connectivity between Backstage and {@link https://airbrake.io/ | Airbrake}.
*
* @packageDocumentation
*/
diff --git a/plugins/allure/CHANGELOG.md b/plugins/allure/CHANGELOG.md
index efde01c0b5..27a470ce2c 100644
--- a/plugins/allure/CHANGELOG.md
+++ b/plugins/allure/CHANGELOG.md
@@ -1,5 +1,29 @@
# @backstage/plugin-allure
+## 0.1.33-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.1.32
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.1.32-next.2
### Patch Changes
diff --git a/plugins/allure/package.json b/plugins/allure/package.json
index 18bf52feab..986fc62f17 100644
--- a/plugins/allure/package.json
+++ b/plugins/allure/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-allure",
"description": "A Backstage plugin that integrates with Allure",
- "version": "0.1.32-next.2",
+ "version": "0.1.33-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -30,7 +30,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"react-use": "^17.2.4"
},
"peerDependencies": {
diff --git a/plugins/analytics-module-ga/CHANGELOG.md b/plugins/analytics-module-ga/CHANGELOG.md
index e457b76bf8..b05b09ab78 100644
--- a/plugins/analytics-module-ga/CHANGELOG.md
+++ b/plugins/analytics-module-ga/CHANGELOG.md
@@ -1,5 +1,27 @@
# @backstage/plugin-analytics-module-ga
+## 0.1.28-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/theme@0.2.18
+
+## 0.1.27
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/theme@0.2.18
+
## 0.1.27-next.2
### Patch Changes
diff --git a/plugins/analytics-module-ga/README.md b/plugins/analytics-module-ga/README.md
index d6e2642e2b..6fdfc91306 100644
--- a/plugins/analytics-module-ga/README.md
+++ b/plugins/analytics-module-ga/README.md
@@ -236,7 +236,7 @@ make and test changes is to do the following:
Code for the isolated version of the plugin can be found inside the [/dev](./dev)
directory. Changes to the plugin are hot-reloaded.
-#### Recommended Dev Config
+### Recommended Dev Config
Paste this into your `app-config.local.yaml` while developing this plugin:
diff --git a/plugins/analytics-module-ga/api-report.md b/plugins/analytics-module-ga/api-report.md
index 557f472f71..f28c919f33 100644
--- a/plugins/analytics-module-ga/api-report.md
+++ b/plugins/analytics-module-ga/api-report.md
@@ -25,6 +25,4 @@ export class GoogleAnalytics implements AnalyticsApi {
},
): GoogleAnalytics;
}
-
-// (No @packageDocumentation comment for this package)
```
diff --git a/plugins/analytics-module-ga/package.json b/plugins/analytics-module-ga/package.json
index b7152b1f69..f77807b138 100644
--- a/plugins/analytics-module-ga/package.json
+++ b/plugins/analytics-module-ga/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-analytics-module-ga",
- "version": "0.1.27-next.2",
+ "version": "0.1.28-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -28,7 +28,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"react-ga": "^3.3.0",
"react-use": "^17.2.4"
},
diff --git a/plugins/analytics-module-ga/src/index.ts b/plugins/analytics-module-ga/src/index.ts
index fca8d91658..7b96c761fb 100644
--- a/plugins/analytics-module-ga/src/index.ts
+++ b/plugins/analytics-module-ga/src/index.ts
@@ -14,5 +14,11 @@
* limitations under the License.
*/
+/**
+ * Analytics Module plugin for Google Analytics.
+ *
+ * @packageDocumentation
+ */
+
export { analyticsModuleGA } from './plugin';
export * from './apis/implementations/AnalyticsApi';
diff --git a/plugins/apache-airflow/CHANGELOG.md b/plugins/apache-airflow/CHANGELOG.md
index acc474e6e3..6386aee20b 100644
--- a/plugins/apache-airflow/CHANGELOG.md
+++ b/plugins/apache-airflow/CHANGELOG.md
@@ -1,5 +1,23 @@
# @backstage/plugin-apache-airflow
+## 0.2.10-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/core-plugin-api@1.5.0
+
+## 0.2.9
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/core-plugin-api@1.5.0
+
## 0.2.9-next.2
### Patch Changes
diff --git a/plugins/apache-airflow/package.json b/plugins/apache-airflow/package.json
index 070cbc4136..ab732c8129 100644
--- a/plugins/apache-airflow/package.json
+++ b/plugins/apache-airflow/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-apache-airflow",
- "version": "0.2.9-next.2",
+ "version": "0.2.10-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -26,7 +26,7 @@
"@backstage/core-plugin-api": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"cross-fetch": "^3.1.5",
"qs": "^6.10.1",
"react-use": "^17.2.4"
diff --git a/plugins/api-docs/CHANGELOG.md b/plugins/api-docs/CHANGELOG.md
index 56644c2322..2c850a0cb3 100644
--- a/plugins/api-docs/CHANGELOG.md
+++ b/plugins/api-docs/CHANGELOG.md
@@ -1,5 +1,35 @@
# @backstage/plugin-api-docs
+## 0.9.2-next.0
+
+### Patch Changes
+
+- ca50c3bbea1: Corrected styling of nested objects in AsyncAPI to avoid inappropriate uppercase text transformation of nested objects.
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/plugin-catalog@1.10.0-next.0
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.9.1
+
+### Patch Changes
+
+- 095e755d9b5: Add ApiDefinitionDialog component for fast access to the API definition in ProvidedApiCards and ConsumedApiCards.
+- 8bc7dcec820: Fix dark theme Swagger's clear button font color.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- 9820eb5d24f: Add a `columns` prop to certain components that use the `EntityTable` for easier extensibility.
+- Updated dependencies
+ - @backstage/plugin-catalog@1.9.0
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.9.1-next.2
### Patch Changes
diff --git a/plugins/api-docs/dev/asyncapi-example-api.yaml b/plugins/api-docs/dev/asyncapi-example-api.yaml
index 725811d0cc..3895006979 100644
--- a/plugins/api-docs/dev/asyncapi-example-api.yaml
+++ b/plugins/api-docs/dev/asyncapi-example-api.yaml
@@ -133,6 +133,8 @@ spec:
description: Light intensity measured in lumens.
sentAt:
$ref: "#/components/schemas/sentAt"
+ sentBy:
+ $ref: "#/components/schemas/sentBy"
turnOnOffPayload:
type: object
properties:
@@ -144,6 +146,8 @@ spec:
description: Whether to turn on or off the light.
sentAt:
$ref: "#/components/schemas/sentAt"
+ sentBy:
+ $ref: "#/components/schemas/sentBy"
dimLightPayload:
type: object
properties:
@@ -154,10 +158,25 @@ spec:
maximum: 100
sentAt:
$ref: "#/components/schemas/sentAt"
+ sentBy:
+ $ref: "#/components/schemas/sentBy"
sentAt:
type: string
format: date-time
description: Date and time when the message was sent.
+ sentBy:
+ type: object
+ description: Description of the message sender.
+ properties:
+ name:
+ type: string
+ description: Name of the sender.
+ type:
+ type: string
+ description: Type of the sender.
+ enum:
+ - user
+ - machine
securitySchemes:
apiKey:
diff --git a/plugins/api-docs/package.json b/plugins/api-docs/package.json
index d7db6566f9..8e24c3ccea 100644
--- a/plugins/api-docs/package.json
+++ b/plugins/api-docs/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-api-docs",
"description": "A Backstage plugin that helps represent API entities in the frontend",
- "version": "0.9.1-next.2",
+ "version": "0.9.2-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -41,7 +41,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"graphiql": "^1.8.8",
"graphql": "^16.0.0",
"graphql-ws": "^5.4.1",
diff --git a/plugins/api-docs/src/components/AsyncApiDefinitionWidget/AsyncApiDefinition.tsx b/plugins/api-docs/src/components/AsyncApiDefinitionWidget/AsyncApiDefinition.tsx
index fd8948828c..64452b7191 100644
--- a/plugins/api-docs/src/components/AsyncApiDefinitionWidget/AsyncApiDefinition.tsx
+++ b/plugins/api-docs/src/components/AsyncApiDefinitionWidget/AsyncApiDefinition.tsx
@@ -76,6 +76,8 @@ const useStyles = makeStyles((theme: BackstageTheme) => ({
...theme.typography.button,
borderRadius: theme.shape.borderRadius,
color: theme.palette.primary.main,
+ // override whatever may be in the theme's typography to ensure consistency with asyncapi
+ textTransform: 'inherit',
},
'& a': {
color: theme.palette.link,
diff --git a/plugins/apollo-explorer/CHANGELOG.md b/plugins/apollo-explorer/CHANGELOG.md
index 8e48be2ab8..6a7ec3d0f2 100644
--- a/plugins/apollo-explorer/CHANGELOG.md
+++ b/plugins/apollo-explorer/CHANGELOG.md
@@ -1,5 +1,24 @@
# @backstage/plugin-apollo-explorer
+## 0.1.10-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/theme@0.2.18
+
+## 0.1.9
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/theme@0.2.18
+
## 0.1.9-next.2
### Patch Changes
diff --git a/plugins/apollo-explorer/api-report.md b/plugins/apollo-explorer/api-report.md
index 1d3b41eac1..66cc473d0b 100644
--- a/plugins/apollo-explorer/api-report.md
+++ b/plugins/apollo-explorer/api-report.md
@@ -40,6 +40,4 @@ export const apolloExplorerPlugin: BackstagePlugin<
{},
{}
>;
-
-// (No @packageDocumentation comment for this package)
```
diff --git a/plugins/apollo-explorer/package.json b/plugins/apollo-explorer/package.json
index 0fcc315797..81ac0f02b9 100644
--- a/plugins/apollo-explorer/package.json
+++ b/plugins/apollo-explorer/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-apollo-explorer",
- "version": "0.1.9-next.2",
+ "version": "0.1.10-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -28,7 +28,6 @@
"@backstage/theme": "workspace:^",
"@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",
"use-deep-compare-effect": "^1.8.1"
},
diff --git a/plugins/apollo-explorer/src/index.ts b/plugins/apollo-explorer/src/index.ts
index 6d07535fc3..565557e79f 100644
--- a/plugins/apollo-explorer/src/index.ts
+++ b/plugins/apollo-explorer/src/index.ts
@@ -13,4 +13,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
+/**
+ * Integrates Apollo Explorer graphs as a tool to browse GraphQL API endpoints inside Backstage.
+ *
+ * @packageDocumentation
+ */
export { apolloExplorerPlugin, ApolloExplorerPage } from './plugin';
diff --git a/plugins/app-backend/CHANGELOG.md b/plugins/app-backend/CHANGELOG.md
index 79c8276eeb..85873f3ddb 100644
--- a/plugins/app-backend/CHANGELOG.md
+++ b/plugins/app-backend/CHANGELOG.md
@@ -1,5 +1,29 @@
# @backstage/plugin-app-backend
+## 0.3.44-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/config-loader@1.1.9
+ - @backstage/types@1.0.2
+
+## 0.3.43
+
+### Patch Changes
+
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/backend-common@0.18.3
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/config-loader@1.1.9
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.3.43-next.2
### Patch Changes
diff --git a/plugins/app-backend/package.json b/plugins/app-backend/package.json
index 77804372d1..79a9c70ca5 100644
--- a/plugins/app-backend/package.json
+++ b/plugins/app-backend/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-app-backend",
"description": "A Backstage backend plugin that serves the Backstage frontend app",
- "version": "0.3.43-next.2",
+ "version": "0.3.44-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/auth-backend/CHANGELOG.md b/plugins/auth-backend/CHANGELOG.md
index a22b2e40ee..3a68d5a495 100644
--- a/plugins/auth-backend/CHANGELOG.md
+++ b/plugins/auth-backend/CHANGELOG.md
@@ -1,5 +1,37 @@
# @backstage/plugin-auth-backend
+## 0.18.2-next.0
+
+### Patch Changes
+
+- d8f774c30df: Enforce the secret visibility of certificates and client secrets in the auth backend. Also, document all known options for each auth plugin.
+- 7908d72e033: Introduce a new global config parameter, `auth.enableExperimentalRedirectFlow`. When enabled, auth will happen with an in-window redirect flow rather than through a popup window.
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+ - @backstage/plugin-auth-node@0.2.13-next.0
+
+## 0.18.1
+
+### Patch Changes
+
+- e262738b8a0: Handle difference in expiration time between Microsoft session and Backstage session which caused the Backstage token to be invalid during a time frame.
+- 86cece2c1fb: Updated dependency `@types/passport-microsoft` to `^1.0.0`.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- 529de8c4211: Added authentication provider for Azure Easy Authentication.
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/plugin-auth-node@0.2.12
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/catalog-model@1.2.1
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.18.1-next.2
### Patch Changes
diff --git a/plugins/auth-backend/api-report.md b/plugins/auth-backend/api-report.md
index 63aa060875..7515083c09 100644
--- a/plugins/auth-backend/api-report.md
+++ b/plugins/auth-backend/api-report.md
@@ -398,6 +398,8 @@ export type OAuthState = {
env: string;
origin?: string;
scope?: string;
+ redirectUrl?: string;
+ flow?: string;
};
// @public
diff --git a/plugins/auth-backend/config.d.ts b/plugins/auth-backend/config.d.ts
index 5aff9df90a..8d76ca8bf5 100644
--- a/plugins/auth-backend/config.d.ts
+++ b/plugins/auth-backend/config.d.ts
@@ -62,30 +62,72 @@ export interface Config {
*/
providers?: {
google?: {
- [authEnv: string]: { [key: string]: string };
+ [authEnv: string]: {
+ clientId: string;
+ /**
+ * @visibility secret
+ */
+ clientSecret: string;
+ callbackUrl?: string;
+ };
};
github?: {
- [authEnv: string]: { [key: string]: string };
+ [authEnv: string]: {
+ clientId: string;
+ /**
+ * @visibility secret
+ */
+ clientSecret: string;
+ callbackUrl?: string;
+ enterpriseInstanceUrl?: string;
+ };
};
gitlab?: {
- [authEnv: string]: { [key: string]: string };
+ [authEnv: string]: {
+ clientId: string;
+ /**
+ * @visibility secret
+ */
+ clientSecret: string;
+ audience?: string;
+ callbackUrl?: string;
+ };
};
saml?: {
entryPoint: string;
logoutUrl?: string;
issuer: string;
+ /**
+ * @visibility secret
+ */
cert: string;
audience?: string;
+ /**
+ * @visibility secret
+ */
privateKey?: string;
authnContext?: string[];
identifierFormat?: string;
+ /**
+ * @visibility secret
+ */
decryptionPvk?: string;
signatureAlgorithm?: 'sha256' | 'sha512';
digestAlgorithm?: string;
acceptedClockSkewMs?: number;
};
okta?: {
- [authEnv: string]: { [key: string]: string };
+ [authEnv: string]: {
+ clientId: string;
+ /**
+ * @visibility secret
+ */
+ clientSecret: string;
+ audience: string;
+ authServerId?: string;
+ idp?: string;
+ callbackUrl?: string;
+ };
};
oauth2?: {
[authEnv: string]: {
@@ -101,19 +143,56 @@ export interface Config {
};
};
oidc?: {
- [authEnv: string]: { [key: string]: string };
+ [authEnv: string]: {
+ clientId: string;
+ /**
+ * @visibility secret
+ */
+ clientSecret: string;
+ callbackUrl?: string;
+ metadataUrl: string;
+ scope?: string;
+ prompt?: string;
+ };
};
auth0?: {
- [authEnv: string]: { [key: string]: string };
+ [authEnv: string]: {
+ clientId: string;
+ /**
+ * @visibility secret
+ */
+ clientSecret: string;
+ domain: string;
+ callbackUrl?: string;
+ audience?: string;
+ connection?: string;
+ connectionScope?: string;
+ };
};
microsoft?: {
- [authEnv: string]: { [key: string]: string };
+ [authEnv: string]: {
+ clientId: string;
+ /**
+ * @visibility secret
+ */
+ clientSecret: string;
+ tenantId: string;
+ callbackUrl?: string;
+ };
};
onelogin?: {
- [authEnv: string]: { [key: string]: string };
+ [authEnv: string]: {
+ clientId: string;
+ /**
+ * @visibility secret
+ */
+ clientSecret: string;
+ issuer: string;
+ callbackUrl?: string;
+ };
};
awsalb?: {
- issuer?: string;
+ iss?: string;
region: string;
};
cfaccess?: {
diff --git a/plugins/auth-backend/package.json b/plugins/auth-backend/package.json
index bcc62814ed..83a9a55906 100644
--- a/plugins/auth-backend/package.json
+++ b/plugins/auth-backend/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-auth-backend",
"description": "A Backstage backend plugin that handles authentication",
- "version": "0.18.1-next.2",
+ "version": "0.18.2-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/auth-backend/src/lib/oauth/OAuthAdapter.test.ts b/plugins/auth-backend/src/lib/oauth/OAuthAdapter.test.ts
index e0d4f0e051..1b6653d97e 100644
--- a/plugins/auth-backend/src/lib/oauth/OAuthAdapter.test.ts
+++ b/plugins/auth-backend/src/lib/oauth/OAuthAdapter.test.ts
@@ -83,56 +83,10 @@ describe('OAuthAdapter', () => {
callbackUrl: 'http://domain.org/auth/test-provider/handler/frame',
};
- it('sets the correct headers in start', async () => {
- const oauthProvider = new OAuthAdapter(
- providerInstance,
- oAuthProviderOptions,
- );
- const mockRequest = {
- query: {
- scope: 'user',
- env: 'development',
- },
- } as unknown as express.Request;
+ const defaultState = { nonce: 'nonce', env: 'development' };
- const mockResponse = {
- cookie: jest.fn().mockReturnThis(),
- end: jest.fn().mockReturnThis(),
- setHeader: jest.fn().mockReturnThis(),
- statusCode: jest.fn().mockReturnThis(),
- } as unknown as express.Response;
-
- await oauthProvider.start(mockRequest, mockResponse);
- // nonce cookie checks
- expect(mockResponse.cookie).toHaveBeenCalledTimes(1);
- expect(mockResponse.cookie).toHaveBeenCalledWith(
- `${oAuthProviderOptions.providerId}-nonce`,
- expect.any(String),
- expect.objectContaining({
- httpOnly: true,
- path: '/auth/test-provider/handler',
- maxAge: TEN_MINUTES_MS,
- domain: 'domain.org',
- sameSite: 'lax',
- secure: false,
- }),
- );
- // redirect checks
- expect(mockResponse.setHeader).toHaveBeenCalledTimes(2);
- expect(mockResponse.setHeader).toHaveBeenCalledWith('Location', '/url');
- expect(mockResponse.setHeader).toHaveBeenCalledWith('Content-Length', '0');
- expect(mockResponse.statusCode).toEqual(301);
- expect(mockResponse.end).toHaveBeenCalledTimes(1);
- });
-
- it('sets the refresh cookie if refresh is enabled', async () => {
- const oauthProvider = new OAuthAdapter(providerInstance, {
- ...oAuthProviderOptions,
- isOriginAllowed: () => false,
- });
-
- const state = { nonce: 'nonce', env: 'development' };
- const mockRequest = {
+ const createEncodedQueryMockRequest = (state: any) => {
+ return {
cookies: {
'test-provider-nonce': 'nonce',
},
@@ -140,12 +94,69 @@ describe('OAuthAdapter', () => {
state: encodeState(state),
},
} as unknown as express.Request;
+ };
- const mockResponse = {
- cookie: jest.fn().mockReturnThis(),
- setHeader: jest.fn().mockReturnThis(),
- end: jest.fn().mockReturnThis(),
- } as unknown as express.Response;
+ const mockResponse = {
+ cookie: jest.fn().mockReturnThis(),
+ end: jest.fn().mockReturnThis(),
+ setHeader: jest.fn().mockReturnThis(),
+ statusCode: jest.fn().mockReturnThis(),
+ redirect: jest.fn().mockReturnThis(),
+ status: jest.fn().mockReturnThis(),
+ json: jest.fn().mockReturnThis(),
+ } as unknown as express.Response;
+
+ const mockStartRequest = {
+ query: {
+ scope: 'user',
+ env: 'development',
+ },
+ } as unknown as express.Request;
+
+ const expectedStartAuthCookieData = {
+ httpOnly: true,
+ path: '/auth/test-provider/handler',
+ maxAge: TEN_MINUTES_MS,
+ domain: 'domain.org',
+ sameSite: 'lax',
+ secure: false,
+ };
+
+ it('sets the correct headers in start', async () => {
+ const oauthProvider = new OAuthAdapter(
+ providerInstance,
+ oAuthProviderOptions,
+ );
+
+ await oauthProvider.start(mockStartRequest, mockResponse);
+ // nonce cookie checks
+ expect(mockResponse.cookie).toHaveBeenCalledTimes(1);
+ expect(mockResponse.cookie).toHaveBeenCalledWith(
+ `${oAuthProviderOptions.providerId}-nonce`,
+ expect.any(String),
+ expect.objectContaining(expectedStartAuthCookieData),
+ );
+ expect(mockResponse.setHeader).toHaveBeenCalledTimes(2);
+ expect(mockResponse.setHeader).toHaveBeenCalledWith('Location', '/url');
+ expect(mockResponse.setHeader).toHaveBeenCalledWith('Content-Length', '0');
+ expect(mockResponse.statusCode).toEqual(301);
+ expect(mockResponse.end).toHaveBeenCalledTimes(1);
+ expect(mockResponse.redirect).not.toHaveBeenCalled();
+ });
+
+ const refreshCookieData = {
+ ...expectedStartAuthCookieData,
+ path: '/auth/test-provider',
+ maxAge: THOUSAND_DAYS_MS,
+ };
+
+ it('sets the refresh cookie if refresh is enabled', async () => {
+ const oauthProvider = new OAuthAdapter(providerInstance, {
+ ...oAuthProviderOptions,
+ isOriginAllowed: () => false,
+ });
+
+ const mockRequest = createEncodedQueryMockRequest(defaultState);
await oauthProvider.frameHandler(mockRequest, mockResponse);
expect(mockCookieConfigurer).toHaveBeenCalledTimes(1);
@@ -153,15 +164,26 @@ describe('OAuthAdapter', () => {
expect(mockResponse.cookie).toHaveBeenCalledWith(
expect.stringContaining('test-provider-refresh-token'),
expect.stringContaining('token'),
- expect.objectContaining({
- httpOnly: true,
- path: '/auth/test-provider',
- maxAge: THOUSAND_DAYS_MS,
- domain: 'domain.org',
- secure: false,
- sameSite: 'lax',
- }),
+ expect.objectContaining(refreshCookieData),
);
+ expect(mockResponse.redirect).not.toHaveBeenCalled();
+ });
+
+ it('sets the refresh cookie if refresh is enabled with redirect', async () => {
+ const oauthProvider = new OAuthAdapter(providerInstance, {
+ ...oAuthProviderOptions,
+ isOriginAllowed: () => false,
+ });
+
+ const state = {
+ ...defaultState,
+ redirectUrl: 'http://localhost:3000',
+ flow: 'redirect',
+ };
+ const mockRequest = createEncodedQueryMockRequest(state);
+
+ await oauthProvider.frameHandler(mockRequest, mockResponse);
+ expect(mockResponse.redirect).toHaveBeenCalledTimes(1);
});
it('persists scope through cookie if enabled', async () => {
@@ -179,32 +201,15 @@ describe('OAuthAdapter', () => {
});
// First we test the /start request, making sure state is set
- const mockStartReq = {
- query: {
- scope: 'user',
- env: 'development',
- },
- } as unknown as express.Request;
- const mockStartRes = {
- cookie: jest.fn().mockReturnThis(),
- end: jest.fn().mockReturnThis(),
- setHeader: jest.fn().mockReturnThis(),
- statusCode: jest.fn().mockReturnThis(),
- } as unknown as express.Response;
-
- await oauthProvider.start(mockStartReq, mockStartRes);
+ await oauthProvider.start(mockStartRequest, mockResponse);
expect(handlers.start).toHaveBeenCalledTimes(1);
expect(handlers.start).toHaveBeenCalledWith({
- query: {
- scope: 'user',
- env: 'development',
- },
+ ...mockStartRequest,
scope: 'user',
state: {
nonce: expect.any(String),
env: 'development',
- origin: undefined,
scope: 'user',
},
});
@@ -223,6 +228,7 @@ describe('OAuthAdapter', () => {
cookie: jest.fn().mockReturnThis(),
setHeader: jest.fn().mockReturnThis(),
end: jest.fn().mockReturnThis(),
+ redirect: jest.fn().mockReturnThis(),
} as unknown as express.Response;
await oauthProvider.frameHandler(mockHandleReq, mockHandleRes);
@@ -230,17 +236,11 @@ describe('OAuthAdapter', () => {
expect(mockHandleRes.cookie).toHaveBeenCalledWith(
'test-provider-granted-scope',
'user',
- expect.objectContaining({
- httpOnly: true,
- path: '/auth/test-provider',
- maxAge: THOUSAND_DAYS_MS,
- domain: 'domain.org',
- secure: false,
- sameSite: 'lax',
- }),
+ expect.objectContaining(refreshCookieData),
);
+ expect(mockResponse.redirect).not.toHaveBeenCalled();
- // Them make sure scopes are forwarded correctly during refresh
+ // Then make sure scopes are forwarded correctly during refresh
const mockRefreshReq = {
query: { scope: 'ignore-me' },
cookies: {
@@ -252,6 +252,7 @@ describe('OAuthAdapter', () => {
const mockRefreshRes = {
status: jest.fn().mockReturnThis(),
json: jest.fn().mockReturnThis(),
+ redirect: jest.fn().mockReturnThis(),
} as unknown as express.Response;
await oauthProvider.refresh(mockRefreshReq, mockRefreshRes);
expect(handlers.refresh).toHaveBeenCalledTimes(1);
@@ -261,8 +262,18 @@ describe('OAuthAdapter', () => {
refreshToken: 'refresh-token',
}),
);
+ expect(mockRefreshRes.redirect).not.toHaveBeenCalled();
});
+ const mockRequestWithHeader = {
+ header: () => 'XMLHttpRequest',
+ cookies: {
+ 'test-provider-refresh-token': 'token',
+ },
+ query: {},
+ get: jest.fn(),
+ } as unknown as express.Request;
+
it('removes refresh cookie and calls logout handler when logging out', async () => {
const logoutSpy = jest.spyOn(providerInstance, 'logout');
const oauthProvider = new OAuthAdapter(providerInstance, {
@@ -270,22 +281,8 @@ describe('OAuthAdapter', () => {
isOriginAllowed: () => false,
});
- const mockRequest = {
- cookies: {
- 'test-provider-refresh-token': 'token',
- },
- header: () => 'XMLHttpRequest',
- get: jest.fn(),
- } as unknown as express.Request;
-
- const mockResponse = {
- cookie: jest.fn().mockReturnThis(),
- end: jest.fn().mockReturnThis(),
- status: jest.fn().mockReturnThis(),
- } as unknown as express.Response;
-
- await oauthProvider.logout(mockRequest, mockResponse);
- expect(mockRequest.get).toHaveBeenCalledTimes(1);
+ await oauthProvider.logout(mockRequestWithHeader, mockResponse);
+ expect(mockRequestWithHeader.get).toHaveBeenCalledTimes(1);
expect(logoutSpy).toHaveBeenCalledTimes(1);
expect(mockResponse.cookie).toHaveBeenCalledTimes(1);
expect(mockResponse.cookie).toHaveBeenCalledWith(
@@ -294,6 +291,7 @@ describe('OAuthAdapter', () => {
expect.objectContaining({ path: '/auth/test-provider' }),
);
expect(mockResponse.end).toHaveBeenCalledTimes(1);
+ expect(mockResponse.redirect).not.toHaveBeenCalled();
});
it('gets new access-token when refreshing', async () => {
@@ -302,20 +300,7 @@ describe('OAuthAdapter', () => {
isOriginAllowed: () => false,
});
- const mockRequest = {
- header: () => 'XMLHttpRequest',
- cookies: {
- 'test-provider-refresh-token': 'token',
- },
- query: {},
- } as unknown as express.Request;
-
- const mockResponse = {
- json: jest.fn().mockReturnThis(),
- status: jest.fn().mockReturnThis(),
- } as unknown as express.Response;
-
- await oauthProvider.refresh(mockRequest, mockResponse);
+ await oauthProvider.refresh(mockRequestWithHeader, mockResponse);
expect(mockResponse.json).toHaveBeenCalledTimes(1);
expect(mockResponse.json).toHaveBeenCalledWith({
...mockResponseData,
@@ -328,6 +313,7 @@ describe('OAuthAdapter', () => {
},
},
});
+ expect(mockResponse.redirect).not.toHaveBeenCalled();
});
it('sets new access-token when old cookie exists', async () => {
@@ -337,20 +323,12 @@ describe('OAuthAdapter', () => {
});
const mockRequest = {
- header: () => 'XMLHttpRequest',
+ ...mockRequestWithHeader,
cookies: {
'test-provider-refresh-token': 'old-token',
},
- query: {},
- get: jest.fn(),
} as unknown as express.Request;
- const mockResponse = {
- json: jest.fn().mockReturnThis(),
- status: jest.fn().mockReturnThis(),
- cookie: jest.fn().mockReturnThis(),
- } as unknown as express.Response;
-
await oauthProvider.refresh(mockRequest, mockResponse);
expect(mockRequest.get).toHaveBeenCalledTimes(1);
expect(mockCookieConfigurer).toHaveBeenCalledTimes(1);
@@ -358,15 +336,9 @@ describe('OAuthAdapter', () => {
expect(mockResponse.cookie).toHaveBeenCalledWith(
'test-provider-refresh-token',
'token',
- expect.objectContaining({
- httpOnly: true,
- path: '/auth/test-provider',
- maxAge: THOUSAND_DAYS_MS,
- domain: 'domain.org',
- secure: false,
- sameSite: 'lax',
- }),
+ expect.objectContaining(refreshCookieData),
);
+ expect(mockResponse.redirect).not.toHaveBeenCalled();
});
it('sets the correct nonce cookie configuration', async () => {
@@ -380,162 +352,89 @@ describe('OAuthAdapter', () => {
...oAuthProviderOptions,
});
- const mockRequest = {
- query: {
- scope: 'user',
- env: 'development',
- origin: 'http://domain.org',
- },
- } as unknown as express.Request;
-
- const mockResponse = {
- cookie: jest.fn().mockReturnThis(),
- end: jest.fn().mockReturnThis(),
- setHeader: jest.fn().mockReturnThis(),
- statusCode: jest.fn().mockReturnThis(),
- } as unknown as express.Response;
-
- await oauthProvider.start(mockRequest, mockResponse);
+ await oauthProvider.start(mockStartRequest, mockResponse);
expect(mockCookieConfigurer).not.toHaveBeenCalled();
expect(mockResponse.cookie).toHaveBeenCalledTimes(1);
expect(mockResponse.cookie).toHaveBeenCalledWith(
`${oAuthProviderOptions.providerId}-nonce`,
expect.any(String),
- expect.objectContaining({
- httpOnly: true,
- domain: 'domain.org',
- maxAge: TEN_MINUTES_MS,
- path: '/auth/test-provider/handler',
- secure: false,
- sameSite: 'lax',
- }),
+ expect.objectContaining(expectedStartAuthCookieData),
);
+ expect(mockResponse.redirect).not.toHaveBeenCalled();
});
- it('sets the correct nonce cookie configuration using origin from request', async () => {
- const config = {
- baseUrl: 'http://domain.org/auth',
- appUrl: 'http://domain.org',
- isOriginAllowed: () => false,
- };
+ const config = {
+ baseUrl: 'http://domain.org/auth',
+ appUrl: 'http://domain.org',
+ isOriginAllowed: () => false,
+ };
+ const mockStartRequestWithOrigin = {
+ query: {
+ scope: 'user',
+ env: 'development',
+ origin: 'http://other.domain',
+ },
+ } as unknown as express.Request;
+
+ it('sets the correct nonce cookie configuration using origin from request', async () => {
const oauthProvider = OAuthAdapter.fromConfig(config, providerInstance, {
...oAuthProviderOptions,
callbackUrl: 'https://domain.org/auth/test-provider/handler/frame',
});
- const mockRequest = {
- query: {
- scope: 'user',
- env: 'development',
- origin: 'http://other.domain',
- },
- } as unknown as express.Request;
-
- const mockResponse = {
- cookie: jest.fn().mockReturnThis(),
- end: jest.fn().mockReturnThis(),
- setHeader: jest.fn().mockReturnThis(),
- statusCode: jest.fn().mockReturnThis(),
- } as unknown as express.Response;
-
- await oauthProvider.start(mockRequest, mockResponse);
+ await oauthProvider.start(mockStartRequestWithOrigin, mockResponse);
expect(mockCookieConfigurer).not.toHaveBeenCalled();
expect(mockResponse.cookie).toHaveBeenCalledTimes(1);
expect(mockResponse.cookie).toHaveBeenCalledWith(
`${oAuthProviderOptions.providerId}-nonce`,
expect.any(String),
expect.objectContaining({
- httpOnly: true,
- domain: 'domain.org',
- maxAge: TEN_MINUTES_MS,
- path: '/auth/test-provider/handler',
+ ...expectedStartAuthCookieData,
secure: true,
sameSite: 'none',
}),
);
+ expect(mockResponse.redirect).not.toHaveBeenCalled();
});
- it('sets the correct cookie configuration using an secure callbackUrl', async () => {
- const config = {
- baseUrl: 'https://domain.org/auth',
- appUrl: 'http://domain.org',
- isOriginAllowed: () => false,
- };
+ const secureCookieData = {
+ ...refreshCookieData,
+ secure: true,
+ sameSite: 'lax',
+ maxAge: THOUSAND_DAYS_MS,
+ };
+ it('sets the correct cookie configuration using an secure callbackUrl', async () => {
const oauthProvider = OAuthAdapter.fromConfig(config, providerInstance, {
...oAuthProviderOptions,
callbackUrl: 'https://domain.org/auth/test-provider/handler/frame',
});
- const state = {
- nonce: 'nonce',
- env: 'development',
- };
-
- const mockRequest = {
- cookies: {
- 'test-provider-nonce': 'nonce',
- },
- query: {
- state: encodeState(state),
- },
- } as unknown as express.Request;
-
- const mockResponse = {
- cookie: jest.fn().mockReturnThis(),
- setHeader: jest.fn().mockReturnThis(),
- end: jest.fn().mockReturnThis(),
- } as unknown as express.Response;
-
+ const mockRequest = createEncodedQueryMockRequest(defaultState);
await oauthProvider.frameHandler(mockRequest, mockResponse);
expect(mockCookieConfigurer).not.toHaveBeenCalled();
expect(mockResponse.cookie).toHaveBeenCalledTimes(1);
expect(mockResponse.cookie).toHaveBeenCalledWith(
expect.stringContaining('test-provider-refresh-token'),
expect.stringContaining('token'),
- expect.objectContaining({
- httpOnly: true,
- domain: 'domain.org',
- path: '/auth/test-provider',
- secure: true,
- sameSite: 'lax',
- }),
+ expect.objectContaining(secureCookieData),
);
+ expect(mockResponse.redirect).not.toHaveBeenCalled();
});
- it('sets the correct cookie configuration when on different domains and secure', async () => {
- const config = {
- baseUrl: 'https://domain.org/auth',
- appUrl: 'http://domain.org',
- isOriginAllowed: () => false,
- };
+ const secureSameSiteNoneCookieData = {
+ ...secureCookieData,
+ sameSite: 'none',
+ };
+ it('sets the correct cookie configuration when on different domains and secure', async () => {
const oauthProvider = OAuthAdapter.fromConfig(config, providerInstance, {
...oAuthProviderOptions,
callbackUrl: 'https://authdomain.org/auth/test-provider/handler/frame',
});
- const state = {
- nonce: 'nonce',
- env: 'development',
- };
-
- const mockRequest = {
- cookies: {
- 'test-provider-nonce': 'nonce',
- },
- query: {
- state: encodeState(state),
- },
- } as unknown as express.Request;
-
- const mockResponse = {
- cookie: jest.fn().mockReturnThis(),
- setHeader: jest.fn().mockReturnThis(),
- end: jest.fn().mockReturnThis(),
- } as unknown as express.Response;
-
+ const mockRequest = createEncodedQueryMockRequest(defaultState);
await oauthProvider.frameHandler(mockRequest, mockResponse);
expect(mockCookieConfigurer).not.toHaveBeenCalled();
expect(mockResponse.cookie).toHaveBeenCalledTimes(1);
@@ -543,106 +442,108 @@ describe('OAuthAdapter', () => {
expect.stringContaining('test-provider-refresh-token'),
expect.stringContaining('token'),
expect.objectContaining({
- httpOnly: true,
+ ...secureSameSiteNoneCookieData,
domain: 'authdomain.org',
- path: '/auth/test-provider',
- secure: true,
- sameSite: 'none',
}),
);
+ expect(mockResponse.redirect).not.toHaveBeenCalled();
});
+ const configOriginAllowed = {
+ ...config,
+ isOriginAllowed: () => true,
+ };
+
it('sets the correct cookie configuration using origin from state', async () => {
- const config = {
- baseUrl: 'https://domain.org/auth',
- appUrl: 'http://domain.org',
- isOriginAllowed: () => true,
- };
+ const oauthProvider = OAuthAdapter.fromConfig(
+ configOriginAllowed,
+ providerInstance,
+ {
+ ...oAuthProviderOptions,
+ callbackUrl: 'https://domain.org/auth/test-provider/handler/frame',
+ },
+ );
- const oauthProvider = OAuthAdapter.fromConfig(config, providerInstance, {
- ...oAuthProviderOptions,
- callbackUrl: 'https://domain.org/auth/test-provider/handler/frame',
- });
-
- const state = {
- nonce: 'nonce',
- env: 'development',
+ const mockRequest = createEncodedQueryMockRequest({
+ ...defaultState,
origin: 'http://other.domain',
- };
-
- const mockRequest = {
- cookies: {
- 'test-provider-nonce': 'nonce',
- },
- query: {
- state: encodeState(state),
- },
- } as unknown as express.Request;
-
- const mockResponse = {
- cookie: jest.fn().mockReturnThis(),
- setHeader: jest.fn().mockReturnThis(),
- end: jest.fn().mockReturnThis(),
- } as unknown as express.Response;
-
+ });
await oauthProvider.frameHandler(mockRequest, mockResponse);
expect(mockCookieConfigurer).not.toHaveBeenCalled();
expect(mockResponse.cookie).toHaveBeenCalledTimes(1);
expect(mockResponse.cookie).toHaveBeenCalledWith(
expect.stringContaining('test-provider-refresh-token'),
expect.stringContaining('token'),
- expect.objectContaining({
- httpOnly: true,
- domain: 'domain.org',
- path: '/auth/test-provider',
- secure: true,
- sameSite: 'none',
- }),
+ expect.objectContaining(secureSameSiteNoneCookieData),
);
+ expect(mockResponse.redirect).not.toHaveBeenCalled();
});
- it('sets the correct cookie configuration using origin from header', async () => {
- const config = {
- baseUrl: 'https://domain.org/auth',
- appUrl: 'http://domain.org',
- isOriginAllowed: () => false,
- };
+ const mockRequestWithGetMockReturn = {
+ header: () => 'XMLHttpRequest',
+ cookies: {
+ 'test-provider-refresh-token': 'old-token',
+ },
+ query: {},
+ get: jest.fn().mockReturnValue('http://other.domain'),
+ } as unknown as express.Request;
+ it('sets the correct cookie configuration using origin from header', async () => {
const oauthProvider = OAuthAdapter.fromConfig(config, providerInstance, {
...oAuthProviderOptions,
callbackUrl: 'https://domain.org/auth/test-provider/handler/frame',
});
- const mockRequest = {
- header: () => 'XMLHttpRequest',
- cookies: {
- 'test-provider-refresh-token': 'old-token',
- },
- query: {},
- get: jest.fn().mockReturnValue('http://other.domain'),
- } as unknown as express.Request;
-
- const mockResponse = {
- json: jest.fn().mockReturnThis(),
- status: jest.fn().mockReturnThis(),
- cookie: jest.fn().mockReturnThis(),
- } as unknown as express.Response;
-
- await oauthProvider.refresh(mockRequest, mockResponse);
- expect(mockRequest.get).toHaveBeenCalledTimes(1);
+ await oauthProvider.refresh(mockRequestWithGetMockReturn, mockResponse);
+ expect(mockRequestWithGetMockReturn.get).toHaveBeenCalledTimes(1);
expect(mockCookieConfigurer).not.toHaveBeenCalled();
expect(mockResponse.cookie).toHaveBeenCalledTimes(1);
expect(mockResponse.cookie).toHaveBeenCalledWith(
'test-provider-refresh-token',
'token',
- expect.objectContaining({
- httpOnly: true,
- path: '/auth/test-provider',
- maxAge: THOUSAND_DAYS_MS,
- domain: 'domain.org',
- secure: true,
- sameSite: 'none',
- }),
+ expect.objectContaining(secureSameSiteNoneCookieData),
);
+ expect(mockResponse.redirect).not.toHaveBeenCalled();
+ });
+
+ it('executed a response redirect when flow query string is set to "redirect"', async () => {
+ const handlers = {
+ start: jest.fn(async (_req: { state: OAuthState }) => ({
+ url: '/url',
+ status: 301,
+ })),
+ handler: jest.fn(async () => ({ response: mockResponseData })),
+ refresh: jest.fn(async () => ({ response: mockResponseData })),
+ };
+ const configWithNoPopupEnabled = {
+ ...configOriginAllowed,
+ };
+ const oauthProvider = OAuthAdapter.fromConfig(
+ configWithNoPopupEnabled,
+ handlers,
+ {
+ ...oAuthProviderOptions,
+ callbackUrl: 'https://domain.org/auth/test-provider/handler/frame',
+ },
+ );
+
+ const state = {
+ ...defaultState,
+ origin: 'http://other.domain',
+ redirectUrl: 'http://domain.org',
+ flow: 'redirect',
+ };
+
+ const mockRequest = {
+ ...createEncodedQueryMockRequest(state),
+ get: jest.fn().mockReturnValue('http://other.domain'),
+ } as unknown as express.Request;
+
+ await oauthProvider.frameHandler(mockRequest, mockResponse);
+ expect(mockRequest.get).not.toHaveBeenCalled();
+ expect(mockCookieConfigurer).not.toHaveBeenCalled();
+ expect(mockResponse.cookie).not.toHaveBeenCalled();
+ expect(mockResponse.redirect).toHaveBeenCalledTimes(1);
+ expect(mockResponse.redirect).toHaveBeenCalledWith('http://domain.org');
});
});
diff --git a/plugins/auth-backend/src/lib/oauth/OAuthAdapter.ts b/plugins/auth-backend/src/lib/oauth/OAuthAdapter.ts
index 85104e9608..5f51b2d301 100644
--- a/plugins/auth-backend/src/lib/oauth/OAuthAdapter.ts
+++ b/plugins/auth-backend/src/lib/oauth/OAuthAdapter.ts
@@ -33,7 +33,11 @@ import {
NotAllowedError,
} from '@backstage/errors';
import { defaultCookieConfigurer, readState, verifyNonce } from './helpers';
-import { postMessageResponse, ensuresXRequestedWith } from '../flow';
+import {
+ postMessageResponse,
+ ensuresXRequestedWith,
+ WebMessageResponse,
+} from '../flow';
import {
OAuthHandlers,
OAuthStartRequest,
@@ -98,6 +102,8 @@ export class OAuthAdapter implements AuthProviderRouteHandlers {
const scope = req.query.scope?.toString() ?? '';
const env = req.query.env?.toString();
const origin = req.query.origin?.toString();
+ const redirectUrl = req.query.redirectUrl?.toString();
+ const flow = req.query.flow?.toString();
if (!env) {
throw new InputError('No env provided in request query parameters');
@@ -109,7 +115,7 @@ export class OAuthAdapter implements AuthProviderRouteHandlers {
// set a nonce cookie before redirecting to oauth provider
this.setNonceCookie(res, nonce, cookieConfig);
- const state: OAuthState = { nonce, env, origin };
+ const state: OAuthState = { nonce, env, origin, redirectUrl, flow };
// If scopes are persisted then we pass them through the state so that we
// can set the cookie on successful auth
@@ -169,11 +175,21 @@ export class OAuthAdapter implements AuthProviderRouteHandlers {
const identity = await this.populateIdentity(response.backstageIdentity);
- // post message back to popup if successful
- return postMessageResponse(res, appOrigin, {
+ const responseObj: WebMessageResponse = {
type: 'authorization_response',
response: { ...response, backstageIdentity: identity },
- });
+ };
+
+ if (state.flow === 'redirect') {
+ if (!state.redirectUrl) {
+ throw new InputError(
+ 'No redirectUrl provided in request query parameters',
+ );
+ }
+ res.redirect(state.redirectUrl);
+ }
+ // post message back to popup if successful
+ return postMessageResponse(res, appOrigin, responseObj);
} catch (error) {
const { name, message } = isError(error)
? error
diff --git a/plugins/auth-backend/src/lib/oauth/types.ts b/plugins/auth-backend/src/lib/oauth/types.ts
index 3902c3f026..e960af2988 100644
--- a/plugins/auth-backend/src/lib/oauth/types.ts
+++ b/plugins/auth-backend/src/lib/oauth/types.ts
@@ -90,6 +90,8 @@ export type OAuthState = {
env: string;
origin?: string;
scope?: string;
+ redirectUrl?: string;
+ flow?: string;
};
/** @public */
diff --git a/plugins/auth-backend/src/providers/microsoft/provider.ts b/plugins/auth-backend/src/providers/microsoft/provider.ts
index fd2a1529a7..9b14a3c91b 100644
--- a/plugins/auth-backend/src/providers/microsoft/provider.ts
+++ b/plugins/auth-backend/src/providers/microsoft/provider.ts
@@ -50,6 +50,8 @@ import {
import { Logger } from 'winston';
import fetch from 'node-fetch';
+const BACKSTAGE_SESSION_EXPIRATION = 3600;
+
type PrivateInfo = {
refreshToken: string;
};
@@ -145,12 +147,17 @@ export class MicrosoftAuthProvider implements OAuthHandlers {
const { profile } = await this.authHandler(result, this.resolverContext);
+ const expiresInSeconds =
+ result.params.expires_in === undefined
+ ? BACKSTAGE_SESSION_EXPIRATION
+ : Math.min(result.params.expires_in, BACKSTAGE_SESSION_EXPIRATION);
+
const response: OAuthResponse = {
providerInfo: {
idToken: result.params.id_token,
accessToken: result.accessToken,
scope: result.params.scope,
- expiresInSeconds: result.params.expires_in,
+ expiresInSeconds,
},
profile,
};
diff --git a/plugins/auth-node/CHANGELOG.md b/plugins/auth-node/CHANGELOG.md
index 0e7bcefae2..210658c09d 100644
--- a/plugins/auth-node/CHANGELOG.md
+++ b/plugins/auth-node/CHANGELOG.md
@@ -1,5 +1,25 @@
# @backstage/plugin-auth-node
+## 0.2.13-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/errors@1.1.5
+
+## 0.2.12
+
+### Patch Changes
+
+- 65454876fb2: Minor API report tweaks
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/config@1.0.7
+
## 0.2.12-next.2
### Patch Changes
diff --git a/plugins/auth-node/package.json b/plugins/auth-node/package.json
index 093b23add9..6e3a74c66d 100644
--- a/plugins/auth-node/package.json
+++ b/plugins/auth-node/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-node",
- "version": "0.2.12-next.2",
+ "version": "0.2.13-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/azure-devops-backend/CHANGELOG.md b/plugins/azure-devops-backend/CHANGELOG.md
index a4a7492ffc..6aae0be627 100644
--- a/plugins/azure-devops-backend/CHANGELOG.md
+++ b/plugins/azure-devops-backend/CHANGELOG.md
@@ -1,5 +1,24 @@
# @backstage/plugin-azure-devops-backend
+## 0.3.23-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/plugin-azure-devops-common@0.3.0
+
+## 0.3.22
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/backend-common@0.18.3
+ - @backstage/config@1.0.7
+ - @backstage/plugin-azure-devops-common@0.3.0
+
## 0.3.22-next.2
### Patch Changes
diff --git a/plugins/azure-devops-backend/package.json b/plugins/azure-devops-backend/package.json
index 1d921a468a..dcafd05680 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.22-next.2",
+ "version": "0.3.23-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/azure-devops/CHANGELOG.md b/plugins/azure-devops/CHANGELOG.md
index b9fcc646b7..de9bb877d4 100644
--- a/plugins/azure-devops/CHANGELOG.md
+++ b/plugins/azure-devops/CHANGELOG.md
@@ -1,5 +1,33 @@
# @backstage/plugin-azure-devops
+## 0.2.8-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-azure-devops-common@0.3.0
+
+## 0.2.7
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-azure-devops-common@0.3.0
+
## 0.2.7-next.2
### Patch Changes
diff --git a/plugins/azure-devops/package.json b/plugins/azure-devops/package.json
index f8bc46f422..40104c5036 100644
--- a/plugins/azure-devops/package.json
+++ b/plugins/azure-devops/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-azure-devops",
- "version": "0.2.7-next.2",
+ "version": "0.2.8-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -37,7 +37,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"humanize-duration": "^3.27.0",
"luxon": "^3.0.0",
"react-use": "^17.2.4"
diff --git a/plugins/azure-sites-backend/CHANGELOG.md b/plugins/azure-sites-backend/CHANGELOG.md
index 9bc9b99388..5fda3502c5 100644
--- a/plugins/azure-sites-backend/CHANGELOG.md
+++ b/plugins/azure-sites-backend/CHANGELOG.md
@@ -1,5 +1,24 @@
# @backstage/plugin-azure-sites-backend
+## 0.1.6-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/plugin-azure-sites-common@0.1.0
+
+## 0.1.5
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/backend-common@0.18.3
+ - @backstage/config@1.0.7
+ - @backstage/plugin-azure-sites-common@0.1.0
+
## 0.1.5-next.2
### Patch Changes
diff --git a/plugins/azure-sites-backend/package.json b/plugins/azure-sites-backend/package.json
index 3cb7023933..77b6b3091c 100644
--- a/plugins/azure-sites-backend/package.json
+++ b/plugins/azure-sites-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-azure-sites-backend",
- "version": "0.1.5-next.2",
+ "version": "0.1.6-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/azure-sites/CHANGELOG.md b/plugins/azure-sites/CHANGELOG.md
index 1de9e7a804..9c4b55e67f 100644
--- a/plugins/azure-sites/CHANGELOG.md
+++ b/plugins/azure-sites/CHANGELOG.md
@@ -1,5 +1,32 @@
# @backstage/plugin-azure-sites
+## 0.1.6-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-azure-sites-common@0.1.0
+
+## 0.1.5
+
+### Patch Changes
+
+- cb8ec97cdeb: Change black & white colors to be theme aware
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-azure-sites-common@0.1.0
+
## 0.1.5-next.2
### Patch Changes
diff --git a/plugins/azure-sites/package.json b/plugins/azure-sites/package.json
index 6daadf199a..6c8acb0fda 100644
--- a/plugins/azure-sites/package.json
+++ b/plugins/azure-sites/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-azure-sites",
- "version": "0.1.5-next.2",
+ "version": "0.1.6-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -40,7 +40,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"luxon": "^3.0.0",
"react-use": "^17.2.4"
},
diff --git a/plugins/badges-backend/CHANGELOG.md b/plugins/badges-backend/CHANGELOG.md
index 837e71bcce..88fb467687 100644
--- a/plugins/badges-backend/CHANGELOG.md
+++ b/plugins/badges-backend/CHANGELOG.md
@@ -1,5 +1,27 @@
# @backstage/plugin-badges-backend
+## 0.1.38-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+
+## 0.1.37
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/catalog-model@1.2.1
+ - @backstage/config@1.0.7
+
## 0.1.37-next.2
### Patch Changes
diff --git a/plugins/badges-backend/package.json b/plugins/badges-backend/package.json
index f570a47874..15caf0ec10 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.37-next.2",
+ "version": "0.1.38-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/badges/CHANGELOG.md b/plugins/badges/CHANGELOG.md
index 567c3e81d6..da109890b7 100644
--- a/plugins/badges/CHANGELOG.md
+++ b/plugins/badges/CHANGELOG.md
@@ -1,5 +1,31 @@
# @backstage/plugin-badges
+## 0.2.41-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+
+## 0.2.40
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.2.40-next.2
### Patch Changes
diff --git a/plugins/badges/package.json b/plugins/badges/package.json
index 7e817c024d..51ed87a34a 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.40-next.2",
+ "version": "0.2.41-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -37,7 +37,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"react-use": "^17.2.4"
},
"peerDependencies": {
diff --git a/plugins/bazaar-backend/CHANGELOG.md b/plugins/bazaar-backend/CHANGELOG.md
index 203c1ef67f..da7151291a 100644
--- a/plugins/bazaar-backend/CHANGELOG.md
+++ b/plugins/bazaar-backend/CHANGELOG.md
@@ -1,5 +1,27 @@
# @backstage/plugin-bazaar-backend
+## 0.2.7-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-auth-node@0.2.13-next.0
+
+## 0.2.6
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.2.12
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/config@1.0.7
+
## 0.2.6-next.2
### Patch Changes
diff --git a/plugins/bazaar-backend/package.json b/plugins/bazaar-backend/package.json
index c9221e5c69..78ddc51153 100644
--- a/plugins/bazaar-backend/package.json
+++ b/plugins/bazaar-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-bazaar-backend",
- "version": "0.2.6-next.2",
+ "version": "0.2.7-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/bazaar/CHANGELOG.md b/plugins/bazaar/CHANGELOG.md
index 57ba471000..139a8af90c 100644
--- a/plugins/bazaar/CHANGELOG.md
+++ b/plugins/bazaar/CHANGELOG.md
@@ -1,5 +1,36 @@
# @backstage/plugin-bazaar
+## 0.2.7-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/plugin-catalog@1.10.0-next.0
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/cli@0.22.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+
+## 0.2.6
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog@1.9.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/cli@0.22.4
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.2.6-next.2
### Patch Changes
diff --git a/plugins/bazaar/package.json b/plugins/bazaar/package.json
index 6a2311004b..ef455587da 100644
--- a/plugins/bazaar/package.json
+++ b/plugins/bazaar/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-bazaar",
- "version": "0.2.6-next.2",
+ "version": "0.2.7-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -34,7 +34,7 @@
"@date-io/luxon": "1.x",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"@material-ui/pickers": "^3.3.10",
"@testing-library/jest-dom": "^5.10.1",
"luxon": "^3.0.0",
diff --git a/plugins/bitbucket-cloud-common/CHANGELOG.md b/plugins/bitbucket-cloud-common/CHANGELOG.md
index 0902619c92..faeeca7d48 100644
--- a/plugins/bitbucket-cloud-common/CHANGELOG.md
+++ b/plugins/bitbucket-cloud-common/CHANGELOG.md
@@ -1,5 +1,13 @@
# @backstage/plugin-bitbucket-cloud-common
+## 0.2.4
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/integration@1.4.3
+
## 0.2.4-next.0
### Patch Changes
diff --git a/plugins/bitbucket-cloud-common/package.json b/plugins/bitbucket-cloud-common/package.json
index 1290d9c8b8..c5cf434a60 100644
--- a/plugins/bitbucket-cloud-common/package.json
+++ b/plugins/bitbucket-cloud-common/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-bitbucket-cloud-common",
"description": "Common functionalities for bitbucket-cloud plugins",
- "version": "0.2.4-next.0",
+ "version": "0.2.4",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/bitrise/CHANGELOG.md b/plugins/bitrise/CHANGELOG.md
index 1a9d86268d..4a92237aaa 100644
--- a/plugins/bitrise/CHANGELOG.md
+++ b/plugins/bitrise/CHANGELOG.md
@@ -1,5 +1,29 @@
# @backstage/plugin-bitrise
+## 0.1.44-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.1.43
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.1.43-next.2
### Patch Changes
diff --git a/plugins/bitrise/package.json b/plugins/bitrise/package.json
index 41cb8562b5..9cdbeda3cd 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.43-next.2",
+ "version": "0.1.44-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -30,7 +30,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"cross-fetch": "^3.1.5",
"lodash": "^4.17.21",
"luxon": "^3.0.0",
diff --git a/plugins/catalog-backend-module-aws/CHANGELOG.md b/plugins/catalog-backend-module-aws/CHANGELOG.md
index f4e268aae7..1aab4dac82 100644
--- a/plugins/catalog-backend-module-aws/CHANGELOG.md
+++ b/plugins/catalog-backend-module-aws/CHANGELOG.md
@@ -1,5 +1,44 @@
# @backstage/plugin-catalog-backend-module-aws
+## 0.1.18-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/plugin-kubernetes-common@0.6.2-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/plugin-catalog-node@1.3.5-next.0
+
+## 0.1.17
+
+### Patch Changes
+
+- 90469c02c8c: Renamed `awsS3EntityProviderCatalogModule` to `catalogModuleAwsS3EntityProviders` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).
+- e675f902980: Make sure to not use deprecated exports from `@backstage/plugin-catalog-backend`
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 87f0bbec175: AwsS3UrlReader upgraded to use aws-sdk v3
+- bf611cf019a: Fix missing `dependencies` in `package.json`
+- Updated dependencies
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-catalog-node@1.3.4
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/integration@1.4.3
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+ - @backstage/plugin-kubernetes-common@0.6.1
+
## 0.1.17-next.2
### Patch Changes
diff --git a/plugins/catalog-backend-module-aws/package.json b/plugins/catalog-backend-module-aws/package.json
index 79271cf4de..0380c59585 100644
--- a/plugins/catalog-backend-module-aws/package.json
+++ b/plugins/catalog-backend-module-aws/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-backend-module-aws",
"description": "A Backstage catalog backend module that helps integrate towards AWS",
- "version": "0.1.17-next.2",
+ "version": "0.1.18-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/catalog-backend-module-azure/CHANGELOG.md b/plugins/catalog-backend-module-azure/CHANGELOG.md
index 86566d383f..3a7d09070f 100644
--- a/plugins/catalog-backend-module-azure/CHANGELOG.md
+++ b/plugins/catalog-backend-module-azure/CHANGELOG.md
@@ -1,5 +1,41 @@
# @backstage/plugin-catalog-backend-module-azure
+## 0.1.15-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+ - @backstage/plugin-catalog-node@1.3.5-next.0
+
+## 0.1.14
+
+### Patch Changes
+
+- 90469c02c8c: Renamed `azureDevOpsEntityProviderCatalogModule` to `catalogModuleAzureDevOpsEntityProvider` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).
+- c17fa101825: Add branch filter support
+ https://backstage.io/docs/integrations/azure/discovery
+- e675f902980: Make sure to not use deprecated exports from `@backstage/plugin-catalog-backend`
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-catalog-node@1.3.4
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/integration@1.4.3
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.1.14-next.2
### Patch Changes
diff --git a/plugins/catalog-backend-module-azure/package.json b/plugins/catalog-backend-module-azure/package.json
index afe85243db..4ed831fcfd 100644
--- a/plugins/catalog-backend-module-azure/package.json
+++ b/plugins/catalog-backend-module-azure/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-backend-module-azure",
"description": "A Backstage catalog backend module that helps integrate towards Azure",
- "version": "0.1.14-next.2",
+ "version": "0.1.15-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/catalog-backend-module-azure/src/lib/azure.ts b/plugins/catalog-backend-module-azure/src/lib/azure.ts
index 0c96d133d3..714090d5bc 100644
--- a/plugins/catalog-backend-module-azure/src/lib/azure.ts
+++ b/plugins/catalog-backend-module-azure/src/lib/azure.ts
@@ -34,6 +34,7 @@ export interface CodeSearchResultItem {
project: {
name: string;
};
+ branch?: string;
}
const isCloud = (host: string) => host === 'dev.azure.com';
diff --git a/plugins/catalog-backend-module-azure/src/providers/AzureDevOpsEntityProvider.test.ts b/plugins/catalog-backend-module-azure/src/providers/AzureDevOpsEntityProvider.test.ts
index 23a668d60b..d89f10c949 100644
--- a/plugins/catalog-backend-module-azure/src/providers/AzureDevOpsEntityProvider.test.ts
+++ b/plugins/catalog-backend-module-azure/src/providers/AzureDevOpsEntityProvider.test.ts
@@ -105,9 +105,13 @@ describe('AzureDevOpsEntityProvider', () => {
await (taskDef.fn as () => Promise)();
const expectedEntities = codeSearchResults.map(item => {
- const url = encodeURI(
- `${expectedBaseUrl}/_git/${item.repository.name}?path=${item.path}`,
- );
+ const url = item.branch
+ ? encodeURI(
+ `${expectedBaseUrl}/_git/${item.repository.name}?path=${item.path}&version=GB${item.branch}`,
+ )
+ : encodeURI(
+ `${expectedBaseUrl}/_git/${item.repository.name}?path=${item.path}`,
+ );
return {
entity: {
apiVersion: 'backstage.io/v1alpha1',
@@ -177,6 +181,36 @@ describe('AzureDevOpsEntityProvider', () => {
);
});
+ // eslint-disable-next-line jest/expect-expect
+ it('single mutation when repos use branch filter', async () => {
+ return expectMutation(
+ 'allReposSingleFile',
+ {
+ organization: 'myorganization',
+ project: 'myproject',
+ branch: 'mybranch',
+ },
+ [
+ {
+ fileName: 'catalog-info.yaml',
+ path: '/catalog-info.yaml',
+ repository: {
+ name: 'myrepo',
+ },
+ project: {
+ name: 'myproject',
+ },
+ branch: 'mybranch',
+ },
+ ],
+ 'https://dev.azure.com/myorganization/myproject',
+ {
+ 'myrepo?path=/catalog-info.yaml':
+ 'generated-589e8cc47341987c7a34f5291791151fa64f7754',
+ },
+ );
+ });
+
// eslint-disable-next-line jest/expect-expect
it('single mutation when multiple repos have multiple files', async () => {
return expectMutation(
diff --git a/plugins/catalog-backend-module-azure/src/providers/AzureDevOpsEntityProvider.ts b/plugins/catalog-backend-module-azure/src/providers/AzureDevOpsEntityProvider.ts
index 89572286a1..6ad4e9ae0b 100644
--- a/plugins/catalog-backend-module-azure/src/providers/AzureDevOpsEntityProvider.ts
+++ b/plugins/catalog-backend-module-azure/src/providers/AzureDevOpsEntityProvider.ts
@@ -177,8 +177,12 @@ export class AzureDevOpsEntityProvider implements EntityProvider {
private createObjectUrl(file: CodeSearchResultItem): string {
const baseUrl = `https://${this.config.host}/${this.config.organization}/${file.project.name}`;
- return encodeURI(
- `${baseUrl}/_git/${file.repository.name}?path=${file.path}`,
- );
+
+ let fullUrl = `${baseUrl}/_git/${file.repository.name}?path=${file.path}`;
+ if (this.config.branch) {
+ fullUrl += `&version=GB${this.config.branch}`;
+ }
+
+ return encodeURI(fullUrl);
}
}
diff --git a/plugins/catalog-backend-module-azure/src/providers/config.test.ts b/plugins/catalog-backend-module-azure/src/providers/config.test.ts
index a09079f1c3..02dbaab90e 100644
--- a/plugins/catalog-backend-module-azure/src/providers/config.test.ts
+++ b/plugins/catalog-backend-module-azure/src/providers/config.test.ts
@@ -44,17 +44,30 @@ describe('readAzureDevOpsConfigs', () => {
},
},
};
+ const provider5 = {
+ host: 'azure.mycompany.com',
+ organization: 'mycompany',
+ project: 'myproject',
+ branch: 'mybranch',
+ };
+
const config = {
catalog: {
providers: {
- azureDevOps: { provider1, provider2, provider3, provider4 },
+ azureDevOps: {
+ provider1,
+ provider2,
+ provider3,
+ provider4,
+ provider5,
+ },
},
},
};
const actual = readAzureDevOpsConfigs(new ConfigReader(config));
- expect(actual).toHaveLength(4);
+ expect(actual).toHaveLength(5);
expect(actual[0]).toEqual({
...provider1,
path: '/catalog-info.yaml',
@@ -85,5 +98,12 @@ describe('readAzureDevOpsConfigs', () => {
frequency: Duration.fromISO(provider4.schedule.frequency),
},
});
+ expect(actual[4]).toEqual({
+ ...provider5,
+ branch: 'mybranch',
+ path: '/catalog-info.yaml',
+ repository: '*',
+ id: 'provider5',
+ });
});
});
diff --git a/plugins/catalog-backend-module-azure/src/providers/config.ts b/plugins/catalog-backend-module-azure/src/providers/config.ts
index c84c242488..3c10a50863 100644
--- a/plugins/catalog-backend-module-azure/src/providers/config.ts
+++ b/plugins/catalog-backend-module-azure/src/providers/config.ts
@@ -41,6 +41,7 @@ function readAzureDevOpsConfig(id: string, config: Config): AzureDevOpsConfig {
const project = config.getString('project');
const host = config.getOptionalString('host') || 'dev.azure.com';
const repository = config.getOptionalString('repository') || '*';
+ const branch = config.getOptionalString('branch');
const path = config.getOptionalString('path') || '/catalog-info.yaml';
const schedule = config.has('schedule')
@@ -53,6 +54,7 @@ function readAzureDevOpsConfig(id: string, config: Config): AzureDevOpsConfig {
organization,
project,
repository,
+ branch,
path,
schedule,
};
diff --git a/plugins/catalog-backend-module-azure/src/providers/types.ts b/plugins/catalog-backend-module-azure/src/providers/types.ts
index b22a8551a5..3cd827b380 100644
--- a/plugins/catalog-backend-module-azure/src/providers/types.ts
+++ b/plugins/catalog-backend-module-azure/src/providers/types.ts
@@ -22,6 +22,7 @@ export type AzureDevOpsConfig = {
organization: string;
project: string;
repository: string;
+ branch?: string;
path: string;
schedule?: TaskScheduleDefinition;
};
diff --git a/plugins/catalog-backend-module-bitbucket-cloud/CHANGELOG.md b/plugins/catalog-backend-module-bitbucket-cloud/CHANGELOG.md
index b1de810710..4a289a393f 100644
--- a/plugins/catalog-backend-module-bitbucket-cloud/CHANGELOG.md
+++ b/plugins/catalog-backend-module-bitbucket-cloud/CHANGELOG.md
@@ -1,5 +1,43 @@
# @backstage/plugin-catalog-backend-module-bitbucket-cloud
+## 0.1.11-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-bitbucket-cloud-common@0.2.4
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/plugin-catalog-node@1.3.5-next.0
+ - @backstage/plugin-events-node@0.2.5-next.0
+
+## 0.1.10
+
+### Patch Changes
+
+- 90469c02c8c: Renamed `bitbucketCloudEntityProviderCatalogModule` to `catalogModuleBitbucketCloudEntityProvider` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).
+- e675f902980: Make sure to not use deprecated exports from `@backstage/plugin-catalog-backend`
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/plugin-catalog-node@1.3.4
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/plugin-events-node@0.2.4
+ - @backstage/integration@1.4.3
+ - @backstage/plugin-bitbucket-cloud-common@0.2.4
+ - @backstage/config@1.0.7
+
## 0.1.10-next.2
### Patch Changes
diff --git a/plugins/catalog-backend-module-bitbucket-cloud/package.json b/plugins/catalog-backend-module-bitbucket-cloud/package.json
index 8ed58f0333..6e9aed31be 100644
--- a/plugins/catalog-backend-module-bitbucket-cloud/package.json
+++ b/plugins/catalog-backend-module-bitbucket-cloud/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-backend-module-bitbucket-cloud",
"description": "A Backstage catalog backend module that helps integrate towards Bitbucket Cloud",
- "version": "0.1.10-next.2",
+ "version": "0.1.11-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/catalog-backend-module-bitbucket-server/CHANGELOG.md b/plugins/catalog-backend-module-bitbucket-server/CHANGELOG.md
index 00341a3870..12e3d2e7d8 100644
--- a/plugins/catalog-backend-module-bitbucket-server/CHANGELOG.md
+++ b/plugins/catalog-backend-module-bitbucket-server/CHANGELOG.md
@@ -1,5 +1,37 @@
# @backstage/plugin-catalog-backend-module-bitbucket-server
+## 0.1.9-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-catalog-node@1.3.5-next.0
+
+## 0.1.8
+
+### Patch Changes
+
+- 90469c02c8c: Renamed `bitbucketServerEntityProviderCatalogModule` to `catalogModuleBitbucketServerEntityProvider` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).
+- e675f902980: Make sure to not use deprecated exports from `@backstage/plugin-catalog-backend`
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-catalog-node@1.3.4
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/integration@1.4.3
+ - @backstage/config@1.0.7
+
## 0.1.8-next.2
### Patch Changes
diff --git a/plugins/catalog-backend-module-bitbucket-server/package.json b/plugins/catalog-backend-module-bitbucket-server/package.json
index 433d4bc907..9b680a80ca 100644
--- a/plugins/catalog-backend-module-bitbucket-server/package.json
+++ b/plugins/catalog-backend-module-bitbucket-server/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-bitbucket-server",
- "version": "0.1.8-next.2",
+ "version": "0.1.9-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/catalog-backend-module-bitbucket/CHANGELOG.md b/plugins/catalog-backend-module-bitbucket/CHANGELOG.md
index eef6da4c0e..c10530f41a 100644
--- a/plugins/catalog-backend-module-bitbucket/CHANGELOG.md
+++ b/plugins/catalog-backend-module-bitbucket/CHANGELOG.md
@@ -1,5 +1,35 @@
# @backstage/plugin-catalog-backend-module-bitbucket
+## 0.2.11-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+ - @backstage/plugin-bitbucket-cloud-common@0.2.4
+ - @backstage/plugin-catalog-node@1.3.5-next.0
+
+## 0.2.10
+
+### Patch Changes
+
+- e675f902980: Make sure to not use deprecated exports from `@backstage/plugin-catalog-backend`
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-catalog-node@1.3.4
+ - @backstage/catalog-model@1.2.1
+ - @backstage/integration@1.4.3
+ - @backstage/plugin-bitbucket-cloud-common@0.2.4
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.2.10-next.2
### Patch Changes
diff --git a/plugins/catalog-backend-module-bitbucket/package.json b/plugins/catalog-backend-module-bitbucket/package.json
index 79fbbe08c4..92c0adda4a 100644
--- a/plugins/catalog-backend-module-bitbucket/package.json
+++ b/plugins/catalog-backend-module-bitbucket/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-backend-module-bitbucket",
"description": "A Backstage catalog backend module that helps integrate towards Bitbucket",
- "version": "0.2.10-next.2",
+ "version": "0.2.11-next.0",
"deprecated": true,
"main": "src/index.ts",
"types": "src/index.ts",
diff --git a/plugins/catalog-backend-module-gerrit/CHANGELOG.md b/plugins/catalog-backend-module-gerrit/CHANGELOG.md
index 07ab61c8c4..98f0959dfd 100644
--- a/plugins/catalog-backend-module-gerrit/CHANGELOG.md
+++ b/plugins/catalog-backend-module-gerrit/CHANGELOG.md
@@ -1,5 +1,37 @@
# @backstage/plugin-catalog-backend-module-gerrit
+## 0.1.12-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-catalog-node@1.3.5-next.0
+
+## 0.1.11
+
+### Patch Changes
+
+- 90469c02c8c: Renamed `gerritEntityProviderCatalogModule` to `catalogModuleGerritEntityProvider` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).
+- e675f902980: Make sure to not use deprecated exports from `@backstage/plugin-catalog-backend`
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-catalog-node@1.3.4
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/integration@1.4.3
+ - @backstage/config@1.0.7
+
## 0.1.11-next.2
### Patch Changes
diff --git a/plugins/catalog-backend-module-gerrit/package.json b/plugins/catalog-backend-module-gerrit/package.json
index af9727cbf9..3d66f715cc 100644
--- a/plugins/catalog-backend-module-gerrit/package.json
+++ b/plugins/catalog-backend-module-gerrit/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-backend-module-gerrit",
- "version": "0.1.11-next.2",
+ "version": "0.1.12-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/catalog-backend-module-github/CHANGELOG.md b/plugins/catalog-backend-module-github/CHANGELOG.md
index 1e0c455391..44760980cb 100644
--- a/plugins/catalog-backend-module-github/CHANGELOG.md
+++ b/plugins/catalog-backend-module-github/CHANGELOG.md
@@ -1,5 +1,48 @@
# @backstage/plugin-catalog-backend-module-github
+## 0.2.7-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-backend@1.8.1-next.0
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/plugin-catalog-node@1.3.5-next.0
+ - @backstage/plugin-events-node@0.2.5-next.0
+
+## 0.2.6
+
+### Patch Changes
+
+- 65454876fb2: Minor API report tweaks
+- 90469c02c8c: Renamed `githubEntityProviderCatalogModule` to `catalogModuleGithubEntityProvider` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).
+- e675f902980: Make sure to not use deprecated exports from `@backstage/plugin-catalog-backend`
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/plugin-catalog-backend@1.8.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-catalog-node@1.3.4
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/plugin-events-node@0.2.4
+ - @backstage/integration@1.4.3
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.2.6-next.2
### Patch Changes
diff --git a/plugins/catalog-backend-module-github/package.json b/plugins/catalog-backend-module-github/package.json
index fe9183917e..ba7233e70f 100644
--- a/plugins/catalog-backend-module-github/package.json
+++ b/plugins/catalog-backend-module-github/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-backend-module-github",
"description": "A Backstage catalog backend module that helps integrate towards GitHub",
- "version": "0.2.6-next.2",
+ "version": "0.2.7-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/catalog-backend-module-github/src/lib/github.test.ts b/plugins/catalog-backend-module-github/src/lib/github.test.ts
index 624ea5c3c9..0345d4ba3e 100644
--- a/plugins/catalog-backend-module-github/src/lib/github.test.ts
+++ b/plugins/catalog-backend-module-github/src/lib/github.test.ts
@@ -16,11 +16,10 @@
import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
import { GroupEntity, UserEntity } from '@backstage/catalog-model';
-import { graphql } from '@octokit/graphql';
+import { graphql as graphqlOctokit } from '@octokit/graphql';
import { graphql as graphqlMsw } from 'msw';
import { setupServer } from 'msw/node';
import { TeamTransformer, UserTransformer } from './defaultTransformers';
-
import {
getOrganizationTeams,
getOrganizationUsers,
@@ -35,11 +34,9 @@ import {
} from './github';
import fetch from 'node-fetch';
-// Workaround for Node.js 18, where native fetch is available, but not yet picked up by msw
-// TODO(Rugvip): remove once https://github.com/mswjs/msw/issues/1388 is resolved
-(global as any).fetch = fetch;
-
describe('github', () => {
+ const graphql = graphqlOctokit.defaults({ request: { fetch } });
+
const server = setupServer();
setupRequestMockHandlers(server);
diff --git a/plugins/catalog-backend-module-gitlab/CHANGELOG.md b/plugins/catalog-backend-module-gitlab/CHANGELOG.md
index 491d972754..02a274469d 100644
--- a/plugins/catalog-backend-module-gitlab/CHANGELOG.md
+++ b/plugins/catalog-backend-module-gitlab/CHANGELOG.md
@@ -1,5 +1,57 @@
# @backstage/plugin-catalog-backend-module-gitlab
+## 0.2.0-next.0
+
+### Minor Changes
+
+- f64345108a0: **BREAKING**: The configuration of the `GitlabDiscoveryEntityProvider` has changed as follows:
+
+ - The configuration key `branch` is now used to define the branch from which the catalog-info should be discovered.
+ - The old configuration key `branch` is now called `fallbackBranch`. This value specifies which branch should be used
+ if no default branch is defined on the project itself.
+
+ To migrate to the new configuration value, rename `branch` to `fallbackBranch`
+
+### Patch Changes
+
+- 7b1b7bfdb7b: The gitlab org data integration now makes use of the GraphQL API to determine
+ the relationships between imported User and Group entities, effectively making
+ this integration usable without an administrator account's Personal Access
+ Token.
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+ - @backstage/plugin-catalog-node@1.3.5-next.0
+
+## 0.1.14
+
+### Patch Changes
+
+- 90469c02c8c: Renamed `gitlabDiscoveryEntityProviderCatalogModule` to `catalogModuleGitlabDiscoveryEntityProvider` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).
+- e675f902980: Make sure to not use deprecated exports from `@backstage/plugin-catalog-backend`
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- af1095f1e11: The configuration key `branch` of the `GitlabDiscoveryEntityProvider` has been deprecated in favor of the configuration key `fallbackBranch`.
+ It will be reused in future release to enforce a concrete branch to be used in catalog file discovery.
+ To migrate to the new configuration value, rename `branch` to `fallbackBranch`.
+- be129f8f3cd: filter gitlab groups by prefix
+- Updated dependencies
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-catalog-node@1.3.4
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/integration@1.4.3
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.1.14-next.2
### Patch Changes
diff --git a/plugins/catalog-backend-module-gitlab/package.json b/plugins/catalog-backend-module-gitlab/package.json
index ed07ea842c..3bdef6958d 100644
--- a/plugins/catalog-backend-module-gitlab/package.json
+++ b/plugins/catalog-backend-module-gitlab/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-backend-module-gitlab",
"description": "A Backstage catalog backend module that helps integrate towards GitLab",
- "version": "0.1.14-next.2",
+ "version": "0.2.0-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/catalog-backend-module-gitlab/src/lib/client.test.ts b/plugins/catalog-backend-module-gitlab/src/lib/client.test.ts
index 513a5b937f..122aae7f54 100644
--- a/plugins/catalog-backend-module-gitlab/src/lib/client.test.ts
+++ b/plugins/catalog-backend-module-gitlab/src/lib/client.test.ts
@@ -18,9 +18,10 @@ import { ConfigReader } from '@backstage/config';
import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
import { readGitLabIntegrationConfig } from '@backstage/integration';
import { getVoidLogger } from '@backstage/backend-common';
-import { rest } from 'msw';
-import { setupServer, SetupServerApi } from 'msw/node';
+import { graphql, rest } from 'msw';
+import { setupServer, SetupServer } from 'msw/node';
import { GitLabClient, paginated } from './client';
+import { GitLabGroup, GitLabUser } from './types';
const server = setupServer();
setupRequestMockHandlers(server);
@@ -30,12 +31,13 @@ const MOCK_CONFIG = readGitLabIntegrationConfig(
host: 'example.com',
token: 'test-token',
apiBaseUrl: 'https://example.com/api/v4',
+ baseUrl: 'https://example.com',
}),
);
const FAKE_PAGED_ENDPOINT = `/some-endpoint`;
const FAKE_PAGED_URL = `${MOCK_CONFIG.apiBaseUrl}${FAKE_PAGED_ENDPOINT}`;
-function setupFakeFourPageURL(srv: SetupServerApi, url: string) {
+function setupFakeFourPageURL(srv: SetupServer, url: string) {
srv.use(
rest.get(url, (req, res, ctx) => {
const page = req.url.searchParams.get('page');
@@ -55,7 +57,7 @@ function setupFakeFourPageURL(srv: SetupServerApi, url: string) {
}
function setupFakeGroupProjectsEndpoint(
- srv: SetupServerApi,
+ srv: SetupServer,
apiBaseUrl: string,
groupID: string,
) {
@@ -77,7 +79,7 @@ function setupFakeGroupProjectsEndpoint(
}
function setupFakeInstanceProjectsEndpoint(
- srv: SetupServerApi,
+ srv: SetupServer,
apiBaseUrl: string,
) {
srv.use(
@@ -103,7 +105,7 @@ function setupFakeInstanceProjectsEndpoint(
);
}
-function setupFakeHasFileEndpoint(srv: SetupServerApi, apiBaseUrl: string) {
+function setupFakeHasFileEndpoint(srv: SetupServer, apiBaseUrl: string) {
srv.use(
rest.head(
`${apiBaseUrl}/projects/group%2Frepo/repository/files/catalog-info.yaml`,
@@ -259,6 +261,228 @@ describe('GitLabClient', () => {
expect(allProjects).toHaveLength(2);
});
});
+
+ it('listUsers gets all users in the instance', async () => {
+ server.use(
+ rest.get(`${MOCK_CONFIG.apiBaseUrl}/users`, (_, res, ctx) =>
+ res(
+ ctx.set('x-next-page', ''),
+ ctx.json([
+ {
+ id: 1,
+ username: 'test1',
+ name: 'Test Testit',
+ state: 'active',
+ avatar_url: 'https://secure.gravatar.com/',
+ web_url: 'https://gitlab.example/test1',
+ created_at: '2023-01-19T07:27:03.333Z',
+ bio: '',
+ location: null,
+ public_email: null,
+ skype: '',
+ linkedin: '',
+ twitter: '',
+ website_url: '',
+ organization: null,
+ job_title: '',
+ pronouns: null,
+ bot: false,
+ work_information: null,
+ followers: 0,
+ following: 0,
+ is_followed: false,
+ local_time: null,
+ last_sign_in_at: '2023-01-19T07:27:49.601Z',
+ confirmed_at: '2023-01-19T07:27:02.905Z',
+ last_activity_on: '2023-01-19',
+ email: 'test@example.com',
+ theme_id: 1,
+ color_scheme_id: 1,
+ projects_limit: 100000,
+ current_sign_in_at: '2023-01-19T09:09:10.676Z',
+ identities: [],
+ can_create_group: true,
+ can_create_project: true,
+ two_factor_enabled: false,
+ external: false,
+ private_profile: false,
+ commit_email: 'test@example.com',
+ is_admin: false,
+ note: '',
+ },
+ ]),
+ ),
+ ),
+ );
+ const client = new GitLabClient({
+ config: MOCK_CONFIG,
+ logger: getVoidLogger(),
+ });
+
+ const allUsers: GitLabUser[] = [];
+ for await (const user of paginated(
+ options => client.listUsers(options),
+ {},
+ )) {
+ allUsers.push(user);
+ }
+
+ expect(allUsers).toMatchObject([
+ {
+ id: 1,
+ username: 'test1',
+ email: 'test@example.com',
+ name: 'Test Testit',
+ state: 'active',
+ web_url: 'https://gitlab.example/test1',
+ avatar_url: 'https://secure.gravatar.com/',
+ },
+ ]);
+ });
+
+ it('listGroups gets all groups in the instance', async () => {
+ server.use(
+ rest.get(`${MOCK_CONFIG.apiBaseUrl}/groups`, (_, res, ctx) =>
+ res(
+ ctx.set('x-next-page', ''),
+ ctx.json([
+ {
+ id: 1,
+ web_url: 'https://gitlab.example/groups/group1',
+ name: 'group1',
+ path: 'group1',
+ description: '',
+ visibility: 'internal',
+ share_with_group_lock: false,
+ require_two_factor_authentication: false,
+ two_factor_grace_period: 48,
+ project_creation_level: 'developer',
+ auto_devops_enabled: null,
+ subgroup_creation_level: 'owner',
+ emails_disabled: null,
+ mentions_disabled: null,
+ lfs_enabled: true,
+ default_branch_protection: 2,
+ avatar_url: null,
+ request_access_enabled: false,
+ full_name: '8020',
+ full_path: '8020',
+ created_at: '2017-06-19T06:42:34.160Z',
+ parent_id: null,
+ },
+ ]),
+ ),
+ ),
+ );
+ const client = new GitLabClient({
+ config: MOCK_CONFIG,
+ logger: getVoidLogger(),
+ });
+
+ const allGroups: GitLabGroup[] = [];
+ for await (const group of paginated(
+ options => client.listGroups(options),
+ {},
+ )) {
+ allGroups.push(group);
+ }
+
+ expect(allGroups).toMatchObject([
+ {
+ id: 1,
+ name: 'group1',
+ full_path: '8020',
+ description: '',
+ parent_id: null,
+ },
+ ]);
+ });
+
+ describe('getGroupMembers', () => {
+ it('gets member IDs', async () => {
+ server.use(
+ graphql
+ .link(`${MOCK_CONFIG.baseUrl}/api/graphql`)
+ .operation((_, res, ctx) =>
+ res(
+ ctx.data({
+ group: {
+ groupMembers: {
+ nodes: [{ user: { id: 'gid://gitlab/User/1' } }],
+ pageInfo: {
+ endCursor: 'end',
+ hasNextPage: false,
+ },
+ },
+ },
+ }),
+ ),
+ ),
+ );
+ const client = new GitLabClient({
+ config: MOCK_CONFIG,
+ logger: getVoidLogger(),
+ });
+
+ const members = await client.getGroupMembers('group1');
+
+ expect(members).toEqual([1]);
+ });
+
+ it('rejects when GraphQL returns errors', async () => {
+ server.use(
+ graphql
+ .link(`${MOCK_CONFIG.baseUrl}/api/graphql`)
+ .operation((_, res, ctx) =>
+ res(
+ ctx.errors([
+ { message: 'Unexpected end of document', locations: [] },
+ ]),
+ ),
+ ),
+ );
+ const client = new GitLabClient({
+ config: MOCK_CONFIG,
+ logger: getVoidLogger(),
+ });
+
+ await expect(() => client.getGroupMembers('group1')).rejects.toThrow(
+ 'GraphQL errors: [{"message":"Unexpected end of document","locations":[]}]',
+ );
+ });
+
+ it('traverses multi-page results', async () => {
+ server.use(
+ graphql
+ .link(`${MOCK_CONFIG.baseUrl}/api/graphql`)
+ .operation((req, res, ctx) =>
+ res(
+ ctx.data({
+ group: {
+ groupMembers: {
+ nodes: req.variables.endCursor
+ ? [{ user: { id: 'gid://gitlab/User/2' } }]
+ : [{ user: { id: 'gid://gitlab/User/1' } }],
+ pageInfo: {
+ endCursor: req.variables.endCursor ? 'end' : 'next',
+ hasNextPage: !req.variables.endCursor,
+ },
+ },
+ },
+ }),
+ ),
+ ),
+ );
+ const client = new GitLabClient({
+ config: MOCK_CONFIG,
+ logger: getVoidLogger(),
+ });
+
+ const members = await client.getGroupMembers('group1');
+
+ expect(members).toEqual([1, 2]);
+ });
+ });
});
describe('paginated', () => {
diff --git a/plugins/catalog-backend-module-gitlab/src/lib/client.ts b/plugins/catalog-backend-module-gitlab/src/lib/client.ts
index bad0eb2a86..8f8c67895c 100644
--- a/plugins/catalog-backend-module-gitlab/src/lib/client.ts
+++ b/plugins/catalog-backend-module-gitlab/src/lib/client.ts
@@ -20,7 +20,7 @@ import {
GitLabIntegrationConfig,
} from '@backstage/integration';
import { Logger } from 'winston';
-import { GitLabGroup, GitLabMembership, GitLabUser } from './types';
+import { GitLabGroup, GitLabGroupMembersResponse, GitLabUser } from './types';
export type CommonListOptions = {
[key: string]: string | number | boolean | undefined;
@@ -78,16 +78,11 @@ export class GitLabClient {
async listUsers(
options?: UserListOptions,
): Promise> {
- let requestOptions = options;
-
- if (!requestOptions) {
- requestOptions = {};
- }
-
- requestOptions.without_project_bots = true;
- requestOptions.exclude_internal = true;
-
- return this.pagedRequest(`/users?`, requestOptions);
+ return this.pagedRequest(`/users?`, {
+ ...options,
+ without_project_bots: true,
+ exclude_internal: true,
+ });
}
async listGroups(
@@ -96,30 +91,51 @@ export class GitLabClient {
return this.pagedRequest(`/groups`, options);
}
- async getUserMemberships(userId: number): Promise {
- const endpoint: string = `/users/${encodeURIComponent(userId)}/memberships`;
- const request = new URL(`${this.config.apiBaseUrl}${endpoint}`);
- request.searchParams.append('per_page', '100');
-
- const response = await fetch(request.toString(), {
- headers: getGitLabRequestOptions(this.config).headers,
- method: 'GET',
- });
-
- if (!response.ok) {
- if (response.status >= 500) {
- this.logger.debug(
- `Unexpected response when fetching ${request.toString()}. Expected 200 but got ${
- response.status
- } - ${response.statusText}`,
- );
+ async getGroupMembers(groupPath: string): Promise {
+ const memberIds = [];
+ let hasNextPage: boolean = false;
+ let endCursor: string | null = null;
+ do {
+ const response: GitLabGroupMembersResponse = await fetch(
+ `${this.config.baseUrl}/api/graphql`,
+ {
+ method: 'POST',
+ headers: {
+ ...getGitLabRequestOptions(this.config).headers,
+ ['Content-Type']: 'application/json',
+ },
+ body: JSON.stringify({
+ variables: { group: groupPath, endCursor },
+ query: `query($group: ID!, $endCursor: String) {
+ group(fullPath: $group) {
+ groupMembers(first: 100, relations: [DIRECT], after: $endCursor) {
+ nodes {
+ user {
+ id
+ }
+ }
+ pageInfo {
+ endCursor
+ hasNextPage
+ }
+ }
+ }
+ }`,
+ }),
+ },
+ ).then(r => r.json());
+ if (response.errors) {
+ throw new Error(`GraphQL errors: ${JSON.stringify(response.errors)}`);
}
- return [];
- }
-
- return response.json().then(items => {
- return items as GitLabMembership[];
- });
+ memberIds.push(
+ ...response.data.group.groupMembers.nodes.map(
+ (node: { user: { id: string } }) =>
+ Number(node.user.id.replace(/^gid:\/\/gitlab\/User\//, '')),
+ ),
+ );
+ ({ hasNextPage, endCursor } = response.data.group.groupMembers.pageInfo);
+ } while (hasNextPage);
+ return memberIds;
}
/**
diff --git a/plugins/catalog-backend-module-gitlab/src/lib/types.ts b/plugins/catalog-backend-module-gitlab/src/lib/types.ts
index c3fc8a4ede..c27007861b 100644
--- a/plugins/catalog-backend-module-gitlab/src/lib/types.ts
+++ b/plugins/catalog-backend-module-gitlab/src/lib/types.ts
@@ -50,11 +50,19 @@ export type GitLabGroup = {
parent_id?: number;
};
-export type GitLabMembership = {
- source_id: number;
- source_name: string;
- source_type: string;
- access_level: number;
+export type GitLabGroupMembersResponse = {
+ errors: { message: string }[];
+ data: {
+ group: {
+ groupMembers: {
+ nodes: { user: { id: string } }[];
+ pageInfo: {
+ endCursor: string;
+ hasNextPage: boolean;
+ };
+ };
+ };
+ };
};
export type GitlabProviderConfig = {
@@ -62,11 +70,12 @@ export type GitlabProviderConfig = {
group: string;
id: string;
/**
- * @deprecated use `fallbackBranch` instead
+ * The name of the branch to be used, to discover catalog files.
*/
branch?: string;
/**
- * If there is no default branch defined at the project, this fallback is used to discover catalog files.
+ * If no `branch` is configured and there is no default branch defined at the project as well, this fallback is used
+ * to discover catalog files.
* Defaults to: `master`
*/
fallbackBranch: string;
diff --git a/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.test.ts b/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.test.ts
index 42fa1b471c..75a4c6414c 100644
--- a/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.test.ts
+++ b/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.test.ts
@@ -449,4 +449,111 @@ describe('GitlabDiscoveryEntityProvider', () => {
'GitlabDiscoveryEntityProvider:test-id',
);
});
+
+ it('should filter found projects based on the branch', async () => {
+ const config = new ConfigReader({
+ integrations: {
+ gitlab: [
+ {
+ host: 'test-gitlab',
+ apiBaseUrl: 'https://api.gitlab.example/api/v4',
+ token: '1234',
+ },
+ ],
+ },
+ catalog: {
+ providers: {
+ gitlab: {
+ 'test-id': {
+ host: 'test-gitlab',
+ branch: 'test',
+ },
+ },
+ },
+ },
+ });
+ const schedule = new PersistingTaskRunner();
+ const entityProviderConnection: EntityProviderConnection = {
+ applyMutation: jest.fn(),
+ refresh: jest.fn(),
+ };
+ const provider = GitlabDiscoveryEntityProvider.fromConfig(config, {
+ logger,
+ schedule,
+ })[0];
+
+ server.use(
+ rest.get(
+ `https://api.gitlab.example/api/v4/projects`,
+ (_req, res, ctx) => {
+ const response = [
+ {
+ id: 123,
+ default_branch: 'master',
+ archived: false,
+ last_activity_at: new Date().toString(),
+ web_url: 'https://api.gitlab.example/test-group/test-repo',
+ path_with_namespace: 'test-group/test-repo',
+ },
+ {
+ id: 124,
+ default_branch: 'master',
+ archived: false,
+ last_activity_at: new Date().toString(),
+ web_url: 'https://api.gitlab.example/john/example',
+ path_with_namespace: 'john/example',
+ },
+ ];
+ return res(ctx.json(response));
+ },
+ ),
+ rest.head(
+ 'https://api.gitlab.example/api/v4/projects/test-group%2Ftest-repo/repository/files/catalog-info.yaml',
+ (_, res, ctx) => {
+ return res(ctx.status(404, 'Not Found'));
+ },
+ ),
+ rest.head(
+ 'https://api.gitlab.example/api/v4/projects/john%2Fexample/repository/files/catalog-info.yaml',
+ (req, res, ctx) => {
+ if (req.url.searchParams.get('ref') === 'test') {
+ return res(ctx.status(200));
+ }
+ return res(ctx.status(404, 'Not Found'));
+ },
+ ),
+ );
+
+ await provider.connect(entityProviderConnection);
+
+ await provider.refresh(logger);
+
+ expect(entityProviderConnection.applyMutation).toHaveBeenCalledWith({
+ type: 'full',
+ entities: [
+ {
+ entity: {
+ apiVersion: 'backstage.io/v1alpha1',
+ kind: 'Location',
+ metadata: {
+ annotations: {
+ 'backstage.io/managed-by-location':
+ 'url:https://api.gitlab.example/john/example/-/blob/test/catalog-info.yaml',
+ 'backstage.io/managed-by-origin-location':
+ 'url:https://api.gitlab.example/john/example/-/blob/test/catalog-info.yaml',
+ },
+ name: 'generated-232185d858fee049986d202c10316d634e76a3d1',
+ },
+ spec: {
+ presence: 'optional',
+ target:
+ 'https://api.gitlab.example/john/example/-/blob/test/catalog-info.yaml',
+ type: 'url',
+ },
+ },
+ locationKey: 'GitlabDiscoveryEntityProvider:test-id',
+ },
+ ],
+ });
+ });
});
diff --git a/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.ts b/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.ts
index ece10ee8c6..6001a32a4a 100644
--- a/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.ts
+++ b/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.ts
@@ -61,10 +61,7 @@ export class GitlabDiscoveryEntityProvider implements EntityProvider {
throw new Error('Either schedule or scheduler must be provided.');
}
- const providerConfigs = readGitlabConfigs(
- config,
- options.logger.child({ target: 'GitlabDiscoveryEntityProvider' }),
- );
+ const providerConfigs = readGitlabConfigs(config);
const integrations = ScmIntegrations.fromConfig(config).gitlab;
const providers: GitlabDiscoveryEntityProvider[] = [];
@@ -181,6 +178,7 @@ export class GitlabDiscoveryEntityProvider implements EntityProvider {
}
if (
+ !this.config.branch &&
this.config.fallbackBranch === '*' &&
project.default_branch === undefined
) {
@@ -188,7 +186,9 @@ export class GitlabDiscoveryEntityProvider implements EntityProvider {
}
const project_branch =
- project.default_branch ?? this.config.fallbackBranch;
+ this.config.branch ??
+ project.default_branch ??
+ this.config.fallbackBranch;
const projectHasFile: boolean = await client.hasFile(
project.path_with_namespace ?? '',
@@ -211,7 +211,10 @@ export class GitlabDiscoveryEntityProvider implements EntityProvider {
}
private createLocationSpec(project: GitLabProject): LocationSpec {
- const project_branch = project.default_branch ?? this.config.fallbackBranch;
+ const project_branch =
+ this.config.branch ??
+ project.default_branch ??
+ this.config.fallbackBranch;
return {
type: 'url',
target: `${project.web_url}/-/blob/${project_branch}/${this.config.catalogFile}`,
diff --git a/plugins/catalog-backend-module-gitlab/src/providers/GitlabOrgDiscoveryEntityProvider.test.ts b/plugins/catalog-backend-module-gitlab/src/providers/GitlabOrgDiscoveryEntityProvider.test.ts
index 5a323a8dec..3d6ff0a91a 100644
--- a/plugins/catalog-backend-module-gitlab/src/providers/GitlabOrgDiscoveryEntityProvider.test.ts
+++ b/plugins/catalog-backend-module-gitlab/src/providers/GitlabOrgDiscoveryEntityProvider.test.ts
@@ -23,7 +23,7 @@ import {
import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
import { ConfigReader } from '@backstage/config';
import { EntityProviderConnection } from '@backstage/plugin-catalog-node';
-import { rest } from 'msw';
+import { graphql, rest } from 'msw';
import { setupServer } from 'msw/node';
import { GitlabOrgDiscoveryEntityProvider } from './GitlabOrgDiscoveryEntityProvider';
@@ -318,20 +318,26 @@ describe('GitlabOrgDiscoveryEntityProvider', () => {
];
return res(ctx.json(response));
}),
- rest.get(
- `https://api.gitlab.example/api/v4/users/1/memberships`,
- (_req, res, ctx) => {
- const response = [
- {
- source_id: 2,
- source_name: 'Group 2',
- source_type: 'Namespace',
- access_level: 50,
- },
- ];
- return res(ctx.json(response));
- },
- ),
+ graphql
+ .link('https://test-gitlab/api/graphql')
+ .operation(async (req, res, ctx) =>
+ res(
+ ctx.data({
+ group: {
+ groupMembers: {
+ nodes:
+ req.variables.group === 'group1/group2'
+ ? [{ user: { id: 'gid://gitlab/User/1' } }]
+ : [],
+ pageInfo: {
+ endCursor: 'end',
+ hasNextPage: false,
+ },
+ },
+ },
+ }),
+ ),
+ ),
);
await provider.connect(entityProviderConnection);
diff --git a/plugins/catalog-backend-module-gitlab/src/providers/GitlabOrgDiscoveryEntityProvider.ts b/plugins/catalog-backend-module-gitlab/src/providers/GitlabOrgDiscoveryEntityProvider.ts
index acfa784c2e..1fe607afbb 100644
--- a/plugins/catalog-backend-module-gitlab/src/providers/GitlabOrgDiscoveryEntityProvider.ts
+++ b/plugins/catalog-backend-module-gitlab/src/providers/GitlabOrgDiscoveryEntityProvider.ts
@@ -72,10 +72,7 @@ export class GitlabOrgDiscoveryEntityProvider implements EntityProvider {
throw new Error('Either schedule or scheduler must be provided.');
}
- const providerConfigs = readGitlabConfigs(
- config,
- options.logger.child({ target: 'GitlabOrgDiscoveryEntityProvider' }),
- );
+ const providerConfigs = readGitlabConfigs(config);
const integrations = ScmIntegrations.fromConfig(config).gitlab;
const providers: GitlabOrgDiscoveryEntityProvider[] = [];
@@ -185,7 +182,7 @@ export class GitlabOrgDiscoveryEntityProvider implements EntityProvider {
},
);
- const idMappedGroup: { [groupId: number]: GitLabGroup } = {};
+ const idMappedUser: { [userId: number]: GitLabUser } = {};
const res: Result = {
scanned: 0,
@@ -197,6 +194,21 @@ export class GitlabOrgDiscoveryEntityProvider implements EntityProvider {
matches: [],
};
+ for await (const user of users) {
+ if (!this.config.userPattern.test(user.email ?? user.username ?? '')) {
+ continue;
+ }
+
+ res.scanned++;
+
+ if (user.state !== 'active') {
+ continue;
+ }
+
+ idMappedUser[user.id] = user;
+ res.matches.push(user);
+ }
+
for await (const group of groups) {
if (!this.config.groupPattern.test(group.full_path ?? '')) {
continue;
@@ -212,35 +224,12 @@ export class GitlabOrgDiscoveryEntityProvider implements EntityProvider {
groupRes.scanned++;
groupRes.matches.push(group);
- idMappedGroup[group.id] = group;
- }
-
- for await (const user of users) {
- if (!this.config.userPattern.test(user.email ?? user.username ?? '')) {
- continue;
- }
-
- res.scanned++;
-
- if (user.state !== 'active') {
- continue;
- }
-
- const memberships = await client.getUserMemberships(user.id);
- const userGroups: GitLabGroup[] = [];
-
- for (const i of memberships) {
- if (
- i.source_type === 'Namespace' &&
- idMappedGroup.hasOwnProperty(i.source_id)
- ) {
- userGroups.push(idMappedGroup[i.source_id]);
+ for (const id of await client.getGroupMembers(group.full_path)) {
+ const user = idMappedUser[id];
+ if (user) {
+ user.groups = (user.groups ?? []).concat(group);
}
}
-
- user.groups = userGroups;
-
- res.matches.push(user);
}
const groupsWithUsers = groupRes.matches.filter(group => {
diff --git a/plugins/catalog-backend-module-gitlab/src/providers/config.test.ts b/plugins/catalog-backend-module-gitlab/src/providers/config.test.ts
index c9b35e78c2..1035538939 100644
--- a/plugins/catalog-backend-module-gitlab/src/providers/config.test.ts
+++ b/plugins/catalog-backend-module-gitlab/src/providers/config.test.ts
@@ -17,9 +17,6 @@
import { ConfigReader } from '@backstage/config';
import { Duration } from 'luxon';
import { readGitlabConfigs } from './config';
-import { getVoidLogger } from '@backstage/backend-common';
-
-const logger = getVoidLogger();
describe('config', () => {
it('empty gitlab config', () => {
@@ -29,7 +26,7 @@ describe('config', () => {
},
});
- const result = readGitlabConfigs(config, logger);
+ const result = readGitlabConfigs(config);
expect(result).toHaveLength(0);
});
@@ -47,12 +44,13 @@ describe('config', () => {
},
});
- const result = readGitlabConfigs(config, logger);
+ const result = readGitlabConfigs(config);
expect(result).toHaveLength(1);
result.forEach(r =>
expect(r).toStrictEqual({
id: 'test',
group: 'group',
+ branch: undefined,
fallbackBranch: 'master',
host: 'host',
catalogFile: 'catalog-info.yaml',
@@ -74,6 +72,7 @@ describe('config', () => {
group: 'group',
host: 'host',
branch: 'not-master',
+ fallbackBranch: 'main',
entityFilename: 'custom-file.yaml',
},
},
@@ -81,13 +80,14 @@ describe('config', () => {
},
});
- const result = readGitlabConfigs(config, logger);
+ const result = readGitlabConfigs(config);
expect(result).toHaveLength(1);
result.forEach(r =>
expect(r).toStrictEqual({
id: 'test',
group: 'group',
- fallbackBranch: 'not-master',
+ branch: 'not-master',
+ fallbackBranch: 'main',
host: 'host',
catalogFile: 'custom-file.yaml',
projectPattern: /[\s\S]*/,
@@ -119,12 +119,13 @@ describe('config', () => {
},
});
- const result = readGitlabConfigs(config, logger);
+ const result = readGitlabConfigs(config);
expect(result).toHaveLength(1);
result.forEach(r =>
expect(r).toStrictEqual({
id: 'test',
group: 'group',
+ branch: undefined,
fallbackBranch: 'master',
host: 'host',
catalogFile: 'catalog-info.yaml',
@@ -158,7 +159,7 @@ describe('config', () => {
},
});
- expect(() => readGitlabConfigs(config, logger)).toThrow(
+ expect(() => readGitlabConfigs(config)).toThrow(
"Missing required config value at 'catalog.providers.gitlab.test.host'",
);
});
@@ -177,7 +178,7 @@ describe('config', () => {
},
});
- const result = readGitlabConfigs(config, logger);
+ const result = readGitlabConfigs(config);
expect(result).toHaveLength(1);
expect(result[0].group).toEqual('');
});
diff --git a/plugins/catalog-backend-module-gitlab/src/providers/config.ts b/plugins/catalog-backend-module-gitlab/src/providers/config.ts
index e5cf5a6298..cd15c4825c 100644
--- a/plugins/catalog-backend-module-gitlab/src/providers/config.ts
+++ b/plugins/catalog-backend-module-gitlab/src/providers/config.ts
@@ -17,7 +17,6 @@
import { readTaskScheduleDefinitionFromConfig } from '@backstage/backend-tasks';
import { Config } from '@backstage/config';
import { GitlabProviderConfig } from '../lib';
-import { Logger } from 'winston';
/**
* Extracts the gitlab config from a config object
@@ -26,25 +25,12 @@ import { Logger } from 'winston';
*
* @param id - The provider key
* @param config - The config object to extract from
- * @param logger - The logger
*/
-function readGitlabConfig(
- id: string,
- config: Config,
- logger: Logger,
-): GitlabProviderConfig {
+function readGitlabConfig(id: string, config: Config): GitlabProviderConfig {
const group = config.getOptionalString('group') ?? '';
const host = config.getString('host');
const branch = config.getOptionalString('branch');
-
- if (branch) {
- logger.warn(
- 'The configuration key `branch` has been deprecated in favor of the configuration key `fallbackBranch`.',
- );
- }
-
- const fallbackBranch =
- config.getOptionalString('fallbackBranch') ?? branch ?? 'master';
+ const fallbackBranch = config.getOptionalString('fallbackBranch') ?? 'master';
const catalogFile =
config.getOptionalString('entityFilename') ?? 'catalog-info.yaml';
const projectPattern = new RegExp(
@@ -65,6 +51,7 @@ function readGitlabConfig(
return {
id,
group,
+ branch,
fallbackBranch,
host,
catalogFile,
@@ -82,12 +69,8 @@ function readGitlabConfig(
* @public
*
* @param config - The config object to extract from
- * @param logger - The logger
*/
-export function readGitlabConfigs(
- config: Config,
- logger: Logger,
-): GitlabProviderConfig[] {
+export function readGitlabConfigs(config: Config): GitlabProviderConfig[] {
const configs: GitlabProviderConfig[] = [];
const providerConfigs = config.getOptionalConfig('catalog.providers.gitlab');
@@ -97,13 +80,7 @@ export function readGitlabConfigs(
}
for (const id of providerConfigs.keys()) {
- configs.push(
- readGitlabConfig(
- id,
- providerConfigs.getConfig(id),
- logger.child({ target: id }),
- ),
- );
+ configs.push(readGitlabConfig(id, providerConfigs.getConfig(id)));
}
return configs;
diff --git a/plugins/catalog-backend-module-incremental-ingestion/CHANGELOG.md b/plugins/catalog-backend-module-incremental-ingestion/CHANGELOG.md
index 11393c6db2..5bf522c41b 100644
--- a/plugins/catalog-backend-module-incremental-ingestion/CHANGELOG.md
+++ b/plugins/catalog-backend-module-incremental-ingestion/CHANGELOG.md
@@ -1,5 +1,46 @@
# @backstage/plugin-catalog-backend-module-incremental-ingestion
+## 0.3.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-backend@1.8.1-next.0
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-catalog-node@1.3.5-next.0
+ - @backstage/plugin-events-node@0.2.5-next.0
+ - @backstage/plugin-permission-common@0.7.4
+
+## 0.3.0
+
+### Minor Changes
+
+- a811bd246c4: Added endpoint to get a list of known incremental entity providers
+
+### Patch Changes
+
+- 90469c02c8c: Renamed `incrementalIngestionEntityProviderCatalogModule` to `catalogModuleIncrementalIngestionEntityProvider` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).
+- e675f902980: Make sure to not use deprecated exports from `@backstage/plugin-catalog-backend`
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- bf611cf019a: Fix missing `dependencies` in `package.json`
+- 6e612b58577: Move `@backstage/backend-defaults` to `devDependencies`
+- Updated dependencies
+ - @backstage/plugin-catalog-backend@1.8.0
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-catalog-node@1.3.4
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-events-node@0.2.4
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/config@1.0.7
+
## 0.3.0-next.2
### Patch Changes
diff --git a/plugins/catalog-backend-module-incremental-ingestion/package.json b/plugins/catalog-backend-module-incremental-ingestion/package.json
index 5b2a534fcb..66e939dbe3 100644
--- a/plugins/catalog-backend-module-incremental-ingestion/package.json
+++ b/plugins/catalog-backend-module-incremental-ingestion/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-backend-module-incremental-ingestion",
"description": "An entity provider for streaming large asset sources into the catalog",
- "version": "0.3.0-next.2",
+ "version": "0.3.1-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/catalog-backend-module-ldap/CHANGELOG.md b/plugins/catalog-backend-module-ldap/CHANGELOG.md
index 5e176f09ba..a89c835ef2 100644
--- a/plugins/catalog-backend-module-ldap/CHANGELOG.md
+++ b/plugins/catalog-backend-module-ldap/CHANGELOG.md
@@ -1,5 +1,32 @@
# @backstage/plugin-catalog-backend-module-ldap
+## 0.5.11-next.0
+
+### Patch Changes
+
+- c9a0fdcd2c8: Fix deprecated types.
+- Updated dependencies
+ - @backstage/config@1.0.7
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/plugin-catalog-node@1.3.5-next.0
+
+## 0.5.10
+
+### Patch Changes
+
+- e675f902980: Make sure to not use deprecated exports from `@backstage/plugin-catalog-backend`
+- Updated dependencies
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-catalog-node@1.3.4
+ - @backstage/catalog-model@1.2.1
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.5.10-next.2
### Patch Changes
diff --git a/plugins/catalog-backend-module-ldap/api-report.md b/plugins/catalog-backend-module-ldap/api-report.md
index 088e34fc34..997ad55560 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-node';
import { EntityProviderConnection } from '@backstage/plugin-catalog-node';
import { GroupEntity } from '@backstage/catalog-model';
import { JsonValue } from '@backstage/types';
-import { LocationSpec } from '@backstage/plugin-catalog-node';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
import { Logger } from 'winston';
import { SearchEntry } from 'ldapjs';
import { SearchOptions } from 'ldapjs';
diff --git a/plugins/catalog-backend-module-ldap/package.json b/plugins/catalog-backend-module-ldap/package.json
index 06b33f1db2..6986f7a84a 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 module that helps integrate towards LDAP",
- "version": "0.5.10-next.2",
+ "version": "0.5.11-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -36,6 +36,7 @@
"@backstage/catalog-model": "workspace:^",
"@backstage/config": "workspace:^",
"@backstage/errors": "workspace:^",
+ "@backstage/plugin-catalog-common": "workspace:^",
"@backstage/plugin-catalog-node": "workspace:^",
"@backstage/types": "workspace:^",
"@types/ldapjs": "^2.2.0",
diff --git a/plugins/catalog-backend-module-ldap/src/processors/LdapOrgReaderProcessor.ts b/plugins/catalog-backend-module-ldap/src/processors/LdapOrgReaderProcessor.ts
index 9c5442ca0c..00578ac3a4 100644
--- a/plugins/catalog-backend-module-ldap/src/processors/LdapOrgReaderProcessor.ts
+++ b/plugins/catalog-backend-module-ldap/src/processors/LdapOrgReaderProcessor.ts
@@ -27,9 +27,9 @@ import {
import {
CatalogProcessor,
CatalogProcessorEmit,
- LocationSpec,
processingResult,
} from '@backstage/plugin-catalog-node';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
/**
* Extracts teams and users out of an LDAP server.
diff --git a/plugins/catalog-backend-module-msgraph/CHANGELOG.md b/plugins/catalog-backend-module-msgraph/CHANGELOG.md
index dc1a32f25a..9eed88aa13 100644
--- a/plugins/catalog-backend-module-msgraph/CHANGELOG.md
+++ b/plugins/catalog-backend-module-msgraph/CHANGELOG.md
@@ -1,5 +1,38 @@
# @backstage/plugin-catalog-backend-module-msgraph
+## 0.5.3-next.0
+
+### Patch Changes
+
+- c9a0fdcd2c8: Fix deprecated types.
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/plugin-catalog-node@1.3.5-next.0
+
+## 0.5.2
+
+### Patch Changes
+
+- a4ebd513527: Revert using `baseUrl` for MS Graph provider as it breaks token retrieval
+- 26eef93c547: Fixed msgraph catalog backend to use user.select option when fetching user from AzureAD
+- 90469c02c8c: Renamed `microsoftGraphOrgEntityProviderCatalogModule` to `catalogModuleMicrosoftGraphOrgEntityProvider` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).
+- e675f902980: Make sure to not use deprecated exports from `@backstage/plugin-catalog-backend`
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- 2c234a89325: properly support custom graph api URL
+- Updated dependencies
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/plugin-catalog-node@1.3.4
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/config@1.0.7
+
## 0.5.2-next.2
### Patch Changes
diff --git a/plugins/catalog-backend-module-msgraph/api-report.md b/plugins/catalog-backend-module-msgraph/api-report.md
index bde8c06fbb..3e4d8d99bc 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-node';
import { EntityProviderConnection } from '@backstage/plugin-catalog-node';
import { GroupEntity } from '@backstage/catalog-model';
-import { LocationSpec } from '@backstage/plugin-catalog-node';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
import { Logger } from 'winston';
import * as MicrosoftGraph from '@microsoft/microsoft-graph-types';
import { PluginTaskScheduler } from '@backstage/backend-tasks';
diff --git a/plugins/catalog-backend-module-msgraph/package.json b/plugins/catalog-backend-module-msgraph/package.json
index f66151bbc4..15f272d48f 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 module that helps integrate towards Microsoft Graph",
- "version": "0.5.2-next.2",
+ "version": "0.5.3-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -51,6 +51,7 @@
"@backstage/backend-tasks": "workspace:^",
"@backstage/catalog-model": "workspace:^",
"@backstage/config": "workspace:^",
+ "@backstage/plugin-catalog-common": "workspace:^",
"@backstage/plugin-catalog-node": "workspace:^",
"@microsoft/microsoft-graph-types": "^2.6.0",
"@types/node-fetch": "^2.5.12",
diff --git a/plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgReaderProcessor.ts b/plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgReaderProcessor.ts
index 2beef51c31..d9119a3c4d 100644
--- a/plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgReaderProcessor.ts
+++ b/plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgReaderProcessor.ts
@@ -18,9 +18,9 @@ import { Config } from '@backstage/config';
import {
CatalogProcessor,
CatalogProcessorEmit,
- LocationSpec,
processingResult,
} from '@backstage/plugin-catalog-node';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
import { Logger } from 'winston';
import {
GroupTransformer,
diff --git a/plugins/catalog-backend-module-openapi/CHANGELOG.md b/plugins/catalog-backend-module-openapi/CHANGELOG.md
index 8bf478947a..680e86263f 100644
--- a/plugins/catalog-backend-module-openapi/CHANGELOG.md
+++ b/plugins/catalog-backend-module-openapi/CHANGELOG.md
@@ -1,5 +1,33 @@
# @backstage/plugin-catalog-backend-module-openapi
+## 0.1.10-next.0
+
+### Patch Changes
+
+- c9a0fdcd2c8: Fix deprecated types.
+- Updated dependencies
+ - @backstage/plugin-catalog-backend@1.8.1-next.0
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/catalog-model@1.2.1
+ - @backstage/types@1.0.2
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/plugin-catalog-node@1.3.5-next.0
+
+## 0.1.9
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-backend@1.8.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/plugin-catalog-node@1.3.4
+ - @backstage/catalog-model@1.2.1
+ - @backstage/integration@1.4.3
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.1.9-next.2
### Patch Changes
diff --git a/plugins/catalog-backend-module-openapi/api-report.md b/plugins/catalog-backend-module-openapi/api-report.md
index c2af9cbe01..455816645a 100644
--- a/plugins/catalog-backend-module-openapi/api-report.md
+++ b/plugins/catalog-backend-module-openapi/api-report.md
@@ -3,11 +3,11 @@
> 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 { CatalogProcessor } from '@backstage/plugin-catalog-node';
import { Config } from '@backstage/config';
import { Entity } from '@backstage/catalog-model';
import { JsonValue } from '@backstage/types';
-import { LocationSpec } from '@backstage/plugin-catalog-backend';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
import { Logger } from 'winston';
import { PlaceholderResolverParams } from '@backstage/plugin-catalog-backend';
import { ScmIntegrations } from '@backstage/integration';
diff --git a/plugins/catalog-backend-module-openapi/package.json b/plugins/catalog-backend-module-openapi/package.json
index fee080d1bf..fd4a8fef4d 100644
--- a/plugins/catalog-backend-module-openapi/package.json
+++ b/plugins/catalog-backend-module-openapi/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-backend-module-openapi",
"description": "A Backstage catalog backend module that helps with OpenAPI specifications",
- "version": "0.1.9-next.2",
+ "version": "0.1.10-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -38,6 +38,7 @@
"@backstage/config": "workspace:^",
"@backstage/integration": "workspace:^",
"@backstage/plugin-catalog-backend": "workspace:^",
+ "@backstage/plugin-catalog-common": "workspace:^",
"@backstage/plugin-catalog-node": "workspace:^",
"@backstage/types": "workspace:^",
"winston": "^3.2.1",
diff --git a/plugins/catalog-backend-module-openapi/src/OpenApiRefProcessor.ts b/plugins/catalog-backend-module-openapi/src/OpenApiRefProcessor.ts
index 9dcadad61d..6b00519b2f 100644
--- a/plugins/catalog-backend-module-openapi/src/OpenApiRefProcessor.ts
+++ b/plugins/catalog-backend-module-openapi/src/OpenApiRefProcessor.ts
@@ -17,10 +17,8 @@ import { UrlReader } from '@backstage/backend-common';
import { Entity } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
import { ScmIntegrations } from '@backstage/integration';
-import {
- CatalogProcessor,
- LocationSpec,
-} from '@backstage/plugin-catalog-backend';
+import { CatalogProcessor } from '@backstage/plugin-catalog-node';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
import { bundleFileWithRefs } from './lib';
import { Logger } from 'winston';
diff --git a/plugins/catalog-backend-module-puppetdb/CHANGELOG.md b/plugins/catalog-backend-module-puppetdb/CHANGELOG.md
index 5bc50ae148..50c805985e 100644
--- a/plugins/catalog-backend-module-puppetdb/CHANGELOG.md
+++ b/plugins/catalog-backend-module-puppetdb/CHANGELOG.md
@@ -1,5 +1,39 @@
# @backstage/plugin-catalog-backend-module-puppetdb
+## 0.1.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+ - @backstage/plugin-catalog-node@1.3.5-next.0
+
+## 0.1.0
+
+### Minor Changes
+
+- a1efcf9a658: Initial version of the plugin.
+
+### Patch Changes
+
+- 561ce41191d: Added a `catalogModulePuppetDbEntityProvider` alpha export for the new backend system
+- e675f902980: Make sure to not use deprecated exports from `@backstage/plugin-catalog-backend`
+- Updated dependencies
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-catalog-node@1.3.4
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.1.0-next.0
### Minor Changes
diff --git a/plugins/catalog-backend-module-puppetdb/package.json b/plugins/catalog-backend-module-puppetdb/package.json
index 252fe21969..f3df2dfdc8 100644
--- a/plugins/catalog-backend-module-puppetdb/package.json
+++ b/plugins/catalog-backend-module-puppetdb/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-backend-module-puppetdb",
"description": "A Backstage catalog backend module that helps integrate towards PuppetDB",
- "version": "0.1.0-next.0",
+ "version": "0.1.1-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/catalog-backend/CHANGELOG.md b/plugins/catalog-backend/CHANGELOG.md
index 1cc3b3620a..e450baf77b 100644
--- a/plugins/catalog-backend/CHANGELOG.md
+++ b/plugins/catalog-backend/CHANGELOG.md
@@ -1,5 +1,81 @@
# @backstage/plugin-catalog-backend
+## 1.8.1-next.0
+
+### Patch Changes
+
+- c9a0fdcd2c8: Fix deprecated types.
+- 899ebfd8e02: Add full text search support to the `by-query` endpoint.
+- Updated dependencies
+ - @backstage/plugin-scaffolder-common@1.2.7-next.0
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/plugin-catalog-node@1.3.5-next.0
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/plugin-permission-node@0.7.7-next.0
+ - @backstage/plugin-search-common@1.2.2
+
+## 1.8.0
+
+### Minor Changes
+
+- 7f4ea3d3602: Add /entities/by-query endpoint returning paginated entities.
+
+ The endpoint supports cursor base pagination and server side sorting of the entities
+
+### Patch Changes
+
+- e675f902980: Add deprecations for symbols that were moved to `@backstage/plugin-catalog-node` a long time ago:
+
+ - `CatalogProcessor`
+ - `CatalogProcessorCache`
+ - `CatalogProcessorEmit`
+ - `CatalogProcessorEntityResult`
+ - `CatalogProcessorErrorResult`
+ - `CatalogProcessorLocationResult`
+ - `CatalogProcessorParser`
+ - `CatalogProcessorRefreshKeysResult`
+ - `CatalogProcessorRelationResult`
+ - `CatalogProcessorResult`
+ - `DeferredEntity`
+ - `EntityProvider`
+ - `EntityProviderConnection`
+ - `EntityProviderMutation`
+ - `EntityRelationSpec`
+ - `processingResult`
+
+ Also moved over and deprecated the following symbols:
+
+ - `locationSpecToLocationEntity`
+ - `locationSpecToMetadataName`
+
+- ac8929f2f31: Fix export of `defaultCatalogCollatorEntityTransformer`.
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- f093ce83d58: Fix a bug where the batch fetch by ref endpoint did not work in conjunction with filtering (e.g. if authorization was enabled).
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/plugin-permission-node@0.7.6
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-catalog-node@1.3.4
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/integration@1.4.3
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+ - @backstage/plugin-scaffolder-common@1.2.6
+ - @backstage/plugin-search-common@1.2.2
+
## 1.8.0-next.2
### Patch Changes
diff --git a/plugins/catalog-backend/alpha-api-report.md b/plugins/catalog-backend/alpha-api-report.md
index df2fa3d2e9..df3e809ade 100644
--- a/plugins/catalog-backend/alpha-api-report.md
+++ b/plugins/catalog-backend/alpha-api-report.md
@@ -20,8 +20,8 @@ export const catalogConditions: Conditions<{
EntitiesSearchFilter,
'catalog-entity',
{
- value?: string | undefined;
annotation: string;
+ value?: string | undefined;
}
>;
hasLabel: PermissionRule<
@@ -37,8 +37,8 @@ export const catalogConditions: Conditions<{
EntitiesSearchFilter,
'catalog-entity',
{
- value?: string | undefined;
key: string;
+ value?: string | undefined;
}
>;
hasSpec: PermissionRule<
@@ -46,8 +46,8 @@ export const catalogConditions: Conditions<{
EntitiesSearchFilter,
'catalog-entity',
{
- value?: string | undefined;
key: string;
+ value?: string | undefined;
}
>;
isEntityKind: PermissionRule<
@@ -104,8 +104,8 @@ export const permissionRules: {
EntitiesSearchFilter,
'catalog-entity',
{
- value?: string | undefined;
annotation: string;
+ value?: string | undefined;
}
>;
hasLabel: PermissionRule<
@@ -121,8 +121,8 @@ export const permissionRules: {
EntitiesSearchFilter,
'catalog-entity',
{
- value?: string | undefined;
key: string;
+ value?: string | undefined;
}
>;
hasSpec: PermissionRule<
@@ -130,8 +130,8 @@ export const permissionRules: {
EntitiesSearchFilter,
'catalog-entity',
{
- value?: string | undefined;
key: string;
+ value?: string | undefined;
}
>;
isEntityKind: PermissionRule<
diff --git a/plugins/catalog-backend/api-report.md b/plugins/catalog-backend/api-report.md
index 5e7b2dee02..d491f391d5 100644
--- a/plugins/catalog-backend/api-report.md
+++ b/plugins/catalog-backend/api-report.md
@@ -11,6 +11,7 @@ import { AnalyzeLocationGenerateEntity as AnalyzeLocationGenerateEntity_2 } from
import { AnalyzeLocationRequest as AnalyzeLocationRequest_2 } from '@backstage/plugin-catalog-common';
import { AnalyzeLocationResponse as AnalyzeLocationResponse_2 } from '@backstage/plugin-catalog-common';
import { CatalogApi } from '@backstage/catalog-client';
+import type { CatalogCollatorEntityTransformer as CatalogCollatorEntityTransformer_2 } from '@backstage/plugin-search-backend-module-catalog';
import { CatalogEntityDocument } from '@backstage/plugin-catalog-common';
import { CatalogProcessor as CatalogProcessor_2 } from '@backstage/plugin-catalog-node';
import { CatalogProcessorCache as CatalogProcessorCache_2 } from '@backstage/plugin-catalog-node';
@@ -23,8 +24,9 @@ import { CatalogProcessorRefreshKeysResult as CatalogProcessorRefreshKeysResult_
import { CatalogProcessorRelationResult as CatalogProcessorRelationResult_2 } from '@backstage/plugin-catalog-node';
import { CatalogProcessorResult as CatalogProcessorResult_2 } from '@backstage/plugin-catalog-node';
import { Config } from '@backstage/config';
+import { DefaultCatalogCollatorFactory as DefaultCatalogCollatorFactory_2 } from '@backstage/plugin-search-backend-module-catalog';
+import type { DefaultCatalogCollatorFactoryOptions as DefaultCatalogCollatorFactoryOptions_2 } from '@backstage/plugin-search-backend-module-catalog';
import { DeferredEntity as DeferredEntity_2 } from '@backstage/plugin-catalog-node';
-import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
import { Entity } from '@backstage/catalog-model';
import { EntityPolicy } from '@backstage/catalog-model';
import { EntityProvider as EntityProvider_2 } from '@backstage/plugin-catalog-node';
@@ -44,7 +46,6 @@ import { PermissionRule } from '@backstage/plugin-permission-node';
import { PermissionRuleParams } from '@backstage/plugin-permission-common';
import { PluginDatabaseManager } from '@backstage/backend-common';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
-import { Readable } from 'stream';
import { Router } from 'express';
import { ScmIntegrationRegistry } from '@backstage/integration';
import { TokenManager } from '@backstage/backend-common';
@@ -160,10 +161,9 @@ export class CatalogBuilder {
useLegacySingleProcessorValidation(): this;
}
-// @public (undocumented)
-export type CatalogCollatorEntityTransformer = (
- entity: Entity,
-) => Omit;
+// @public @deprecated (undocumented)
+export type CatalogCollatorEntityTransformer =
+ CatalogCollatorEntityTransformer_2;
// @public (undocumented)
export type CatalogEnvironment = {
@@ -286,34 +286,15 @@ export class DefaultCatalogCollator {
readonly visibilityPermission: Permission;
}
-// @public (undocumented)
-export const defaultCatalogCollatorEntityTransformer: CatalogCollatorEntityTransformer;
+// @public @deprecated (undocumented)
+export const defaultCatalogCollatorEntityTransformer: CatalogCollatorEntityTransformer_2;
-// @public (undocumented)
-export class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {
- // (undocumented)
- static fromConfig(
- _config: Config,
- options: DefaultCatalogCollatorFactoryOptions,
- ): DefaultCatalogCollatorFactory;
- // (undocumented)
- getCollator(): Promise;
- // (undocumented)
- readonly type = 'software-catalog';
- // (undocumented)
- readonly visibilityPermission: Permission;
-}
+// @public @deprecated (undocumented)
+export const DefaultCatalogCollatorFactory: typeof DefaultCatalogCollatorFactory_2;
-// @public (undocumented)
-export type DefaultCatalogCollatorFactoryOptions = {
- discovery: PluginEndpointDiscovery;
- tokenManager: TokenManager;
- locationTemplate?: string;
- filter?: GetEntitiesRequest['filter'];
- batchSize?: number;
- catalogClient?: CatalogApi;
- entityTransformer?: CatalogCollatorEntityTransformer;
-};
+// @public @deprecated (undocumented)
+export type DefaultCatalogCollatorFactoryOptions =
+ DefaultCatalogCollatorFactoryOptions_2;
// @public @deprecated (undocumented)
export type DeferredEntity = DeferredEntity_2;
diff --git a/plugins/catalog-backend/package.json b/plugins/catalog-backend/package.json
index 35eac97cc1..6bd5313e7d 100644
--- a/plugins/catalog-backend/package.json
+++ b/plugins/catalog-backend/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-backend",
"description": "The Backstage backend plugin that provides the Backstage catalog",
- "version": "1.8.0-next.2",
+ "version": "1.8.1-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -57,6 +57,7 @@
"@backstage/plugin-permission-common": "workspace:^",
"@backstage/plugin-permission-node": "workspace:^",
"@backstage/plugin-scaffolder-common": "workspace:^",
+ "@backstage/plugin-search-backend-module-catalog": "workspace:^",
"@backstage/plugin-search-common": "workspace:^",
"@backstage/types": "workspace:^",
"@opentelemetry/api": "^1.3.0",
@@ -80,7 +81,7 @@
"winston": "^3.2.1",
"yaml": "^2.0.0",
"yn": "^4.0.0",
- "zod": "~3.18.0"
+ "zod": "^3.21.4"
},
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
diff --git a/plugins/catalog-backend/src/index.ts b/plugins/catalog-backend/src/index.ts
index b3d2bc95c7..eca155ce46 100644
--- a/plugins/catalog-backend/src/index.ts
+++ b/plugins/catalog-backend/src/index.ts
@@ -27,3 +27,40 @@ export * from './processing';
export * from './search';
export * from './service';
export * from './deprecated';
+
+import {
+ DefaultCatalogCollatorFactory as _DefaultCatalogCollatorFactory,
+ defaultCatalogCollatorEntityTransformer as _defaultCatalogCollatorEntityTransformer,
+} from '@backstage/plugin-search-backend-module-catalog';
+
+/**
+ * @public
+ * @deprecated import from `@backstage/search-backend-module-catalog` instead
+ */
+export const DefaultCatalogCollatorFactory = _DefaultCatalogCollatorFactory;
+
+/**
+ * @public
+ * @deprecated import from `@backstage/search-backend-module-catalog` instead
+ */
+export const defaultCatalogCollatorEntityTransformer =
+ _defaultCatalogCollatorEntityTransformer;
+
+import type {
+ DefaultCatalogCollatorFactoryOptions as _DefaultCatalogCollatorFactoryOptions,
+ CatalogCollatorEntityTransformer as _CatalogCollatorEntityTransformer,
+} from '@backstage/plugin-search-backend-module-catalog';
+
+/**
+ * @public
+ * @deprecated import from `@backstage/search-backend-module-catalog` instead
+ */
+export type DefaultCatalogCollatorFactoryOptions =
+ _DefaultCatalogCollatorFactoryOptions;
+
+/**
+ * @public
+ * @deprecated import from `@backstage/search-backend-module-catalog` instead
+ */
+export type CatalogCollatorEntityTransformer =
+ _CatalogCollatorEntityTransformer;
diff --git a/plugins/catalog-backend/src/migrations.test.ts b/plugins/catalog-backend/src/migrations.test.ts
index f1ed40dbbe..33f88e9aa7 100644
--- a/plugins/catalog-backend/src/migrations.test.ts
+++ b/plugins/catalog-backend/src/migrations.test.ts
@@ -44,6 +44,67 @@ describe('migrations', () => {
ids: ['MYSQL_8', 'POSTGRES_13', 'POSTGRES_9', 'SQLITE_3'],
});
+ it.each(databases.eachSupportedId())(
+ 'latest version correctly cascades deletions, %p',
+ async databaseId => {
+ const knex = await databases.init(databaseId);
+ await knex.migrate.latest({ directory: migrationsDir });
+
+ await knex
+ .insert({
+ entity_id: 'i1',
+ entity_ref: 'k:ns/n1',
+ unprocessed_entity: '{}',
+ errors: '[]',
+ next_update_at: new Date(),
+ last_discovery_at: new Date(),
+ })
+ .into('refresh_state');
+ await knex
+ .insert({
+ entity_id: 'i2',
+ entity_ref: 'k:ns/n2',
+ unprocessed_entity: '{}',
+ errors: '[]',
+ next_update_at: new Date(),
+ last_discovery_at: new Date(),
+ })
+ .into('refresh_state');
+ await knex
+ .insert({ entity_id: 'i1', key: 'k1', value: 'v1' })
+ .into('search');
+ await knex
+ .insert({
+ source_entity_ref: 'k:ns/n1',
+ target_entity_ref: 'k:ns/n2',
+ })
+ .into('refresh_state_references');
+ await knex
+ .insert({
+ originating_entity_id: 'i1',
+ source_entity_ref: 'k:ns/n1',
+ target_entity_ref: 'k:ns/n2',
+ type: 't',
+ })
+ .into('relations');
+ await knex
+ .insert({
+ entity_id: 'i1',
+ hash: 'h',
+ stitch_ticket: '',
+ final_entity: '{}',
+ })
+ .into('final_entities');
+
+ await knex.delete().from('refresh_state').where({ entity_id: 'i1' });
+
+ await expect(knex('search')).resolves.toEqual([]);
+ await expect(knex('refresh_state_references')).resolves.toEqual([]);
+ await expect(knex('relations')).resolves.toEqual([]);
+ await expect(knex('final_entities')).resolves.toEqual([]);
+ },
+ );
+
it.each(databases.eachSupportedId())(
'20221109192547_search_add_original_value_column.js, %p',
async databaseId => {
diff --git a/plugins/catalog-backend/src/modules/core/LocationEntityProcessor.test.ts b/plugins/catalog-backend/src/modules/core/LocationEntityProcessor.test.ts
index 68c073eb0a..5e000f87d6 100644
--- a/plugins/catalog-backend/src/modules/core/LocationEntityProcessor.test.ts
+++ b/plugins/catalog-backend/src/modules/core/LocationEntityProcessor.test.ts
@@ -21,7 +21,7 @@ import {
} from '@backstage/integration';
import path from 'path';
import { toAbsoluteUrl } from './LocationEntityProcessor';
-import { LocationSpec } from '@backstage/plugin-catalog-node';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
describe('LocationEntityProcessor', () => {
describe('toAbsoluteUrl', () => {
diff --git a/plugins/catalog-backend/src/search/index.ts b/plugins/catalog-backend/src/search/index.ts
index 3603ab2e60..50966e4c5b 100644
--- a/plugins/catalog-backend/src/search/index.ts
+++ b/plugins/catalog-backend/src/search/index.ts
@@ -14,11 +14,6 @@
* limitations under the License.
*/
-export { DefaultCatalogCollatorFactory } from './DefaultCatalogCollatorFactory';
-export type { DefaultCatalogCollatorFactoryOptions } from './DefaultCatalogCollatorFactory';
-export type { CatalogCollatorEntityTransformer } from './CatalogCollatorEntityTransformer';
-export { defaultCatalogCollatorEntityTransformer } from './defaultCatalogCollatorEntityTransformer';
-
/**
* todo(backstage/techdocs-core): stop exporting this in a future release.
*/
diff --git a/plugins/catalog-backend/src/service/CatalogBuilder.ts b/plugins/catalog-backend/src/service/CatalogBuilder.ts
index 7da5d69767..782ad1bf3c 100644
--- a/plugins/catalog-backend/src/service/CatalogBuilder.ts
+++ b/plugins/catalog-backend/src/service/CatalogBuilder.ts
@@ -599,16 +599,28 @@ export class CatalogBuilder {
...this.placeholderResolvers,
};
- // These are always there no matter what
+ // The placeholder is always there no matter what
const processors: CatalogProcessor[] = [
new PlaceholderProcessor({
resolvers: placeholderResolvers,
reader,
integrations,
}),
- new BuiltinKindsEntityProcessor(),
];
+ const builtinKindsEntityProcessor = new BuiltinKindsEntityProcessor();
+ // If the user adds a processor named 'BuiltinKindsEntityProcessor',
+ // skip inclusion of the catalog-backend version.
+ if (
+ !this.processors.some(
+ processor =>
+ processor.getProcessorName() ===
+ builtinKindsEntityProcessor.getProcessorName(),
+ )
+ ) {
+ processors.push(builtinKindsEntityProcessor);
+ }
+
// These are only added unless the user replaced them all
if (!this.processorsReplace) {
processors.push(...this.getDefaultProcessors());
diff --git a/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.test.ts b/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.test.ts
index 275bd1c42c..25cdc8d826 100644
--- a/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.test.ts
+++ b/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.test.ts
@@ -1119,6 +1119,193 @@ describe('DefaultEntitiesCatalog', () => {
},
);
+ it.each(databases.eachSupportedId())(
+ 'should filter the text results when sortOrder is not provided, %p',
+ async databaseId => {
+ await createDatabase(databaseId);
+
+ const names = ['lion', 'cat', 'atcatss', 'dog', 'dogcat', 'aa', 's'];
+ const entities: Entity[] = names.map((name, index) =>
+ // Need a stable search since default filtering is by uid, and those get generated on the fly
+ // during the test case.
+ entityFrom(`${index}`, { uid: `id${index}`, title: name }),
+ );
+
+ const notFoundEntities: Entity[] = [
+ {
+ apiVersion: 'a',
+ kind: 'k',
+ metadata: { name: 'something' },
+ spec: {},
+ },
+ {
+ apiVersion: 'a',
+ kind: 'k',
+ metadata: { name: 'something else' },
+ spec: {},
+ },
+ ];
+
+ await Promise.all(
+ entities.concat(notFoundEntities).map(e => addEntityToSearch(e)),
+ );
+
+ const catalog = new DefaultEntitiesCatalog({
+ database: knex,
+ logger: getVoidLogger(),
+ stitcher,
+ });
+
+ const filter = {
+ key: 'spec.should_include_this',
+ };
+
+ const request: QueryEntitiesInitialRequest = {
+ filter,
+ limit: 100,
+ fullTextFilter: { term: 'cAt ', fields: ['metadata.title'] },
+ };
+ const response = await catalog.queryEntities(request);
+ expect(response.items).toEqual([
+ entityFrom('1', { uid: 'id1', title: 'cat' }),
+ entityFrom('2', { uid: 'id2', title: 'atcatss' }),
+ entityFrom('4', { uid: 'id4', title: 'dogcat' }),
+ ]);
+ expect(response.pageInfo.nextCursor).toBeUndefined();
+ expect(response.pageInfo.prevCursor).toBeUndefined();
+ expect(response.totalItems).toBe(3);
+
+ const paginatedResponse = await catalog.queryEntities({
+ ...request,
+ limit: 2,
+ });
+ expect(paginatedResponse.items).toEqual([
+ entityFrom('1', { uid: 'id1', title: 'cat' }),
+ entityFrom('2', { uid: 'id2', title: 'atcatss' }),
+ ]);
+ expect(paginatedResponse.pageInfo.nextCursor).not.toBeUndefined();
+ expect(paginatedResponse.pageInfo.prevCursor).toBeUndefined();
+ expect(paginatedResponse.totalItems).toBe(3);
+
+ const paginatedResponseNext = await catalog.queryEntities({
+ cursor: paginatedResponse.pageInfo.nextCursor!,
+ });
+ expect(paginatedResponseNext.items).toEqual([
+ entityFrom('4', { uid: 'id4', title: 'dogcat' }),
+ ]);
+ expect(paginatedResponseNext.pageInfo.nextCursor).toBeUndefined();
+ expect(paginatedResponseNext.pageInfo.prevCursor).not.toBeUndefined();
+ expect(paginatedResponseNext.totalItems).toBe(3);
+
+ const paginatedResponsePrev = await catalog.queryEntities({
+ cursor: paginatedResponseNext.pageInfo.prevCursor!,
+ });
+ expect(paginatedResponsePrev).toMatchObject(paginatedResponse);
+ },
+ );
+
+ it.each(databases.eachSupportedId())(
+ 'should filter the text results by multiple search fields if provided, %p',
+ async databaseId => {
+ await createDatabase(databaseId);
+
+ const defs = [
+ {
+ title: 'lion',
+ name: 'KingOfTheJungle',
+ },
+ { title: 'cat', name: 'NotKingOfTheJungle' },
+ { title: 'atcatss', name: 'NotACatKing' },
+ { title: 'king', name: '123' },
+ { title: 'dogcat', name: 'dogcat' },
+ { title: 'aa', name: 'test123' },
+ { title: 's', name: 'idk' },
+ ];
+ const entities: Entity[] = defs.map(({ title, name }, index) =>
+ // Need a stable search since default filtering is by uid, and those get generated on the fly
+ // during the test case.
+ entityFrom(name, { uid: `id${index}`, title }),
+ );
+
+ const notFoundEntities: Entity[] = [
+ {
+ apiVersion: 'a',
+ kind: 'k',
+ metadata: { name: 'something' },
+ spec: {},
+ },
+ {
+ apiVersion: 'a',
+ kind: 'k',
+ metadata: { name: 'something else' },
+ spec: {},
+ },
+ ];
+
+ await Promise.all(
+ entities.concat(notFoundEntities).map(e => addEntityToSearch(e)),
+ );
+
+ const catalog = new DefaultEntitiesCatalog({
+ database: knex,
+ logger: getVoidLogger(),
+ stitcher,
+ });
+
+ const filter = {
+ key: 'spec.should_include_this',
+ };
+
+ const request: QueryEntitiesInitialRequest = {
+ filter,
+ limit: 100,
+ fullTextFilter: {
+ term: 'KiNg ',
+ fields: ['metadata.title', 'metadata.name'],
+ },
+ };
+ const response = await catalog.queryEntities(request);
+
+ expect(response.items).toEqual([
+ entityFrom('KingOfTheJungle', { uid: 'id0', title: 'lion' }),
+ entityFrom('NotKingOfTheJungle', { uid: 'id1', title: 'cat' }),
+ entityFrom('NotACatKing', { uid: 'id2', title: 'atcatss' }),
+ entityFrom('123', { uid: 'id3', title: 'king' }),
+ ]);
+ expect(response.pageInfo.nextCursor).toBeUndefined();
+ expect(response.pageInfo.prevCursor).toBeUndefined();
+ expect(response.totalItems).toBe(4);
+
+ const paginatedResponse = await catalog.queryEntities({
+ ...request,
+ limit: 2,
+ });
+ expect(paginatedResponse.items).toEqual([
+ entityFrom('KingOfTheJungle', { uid: 'id0', title: 'lion' }),
+ entityFrom('NotKingOfTheJungle', { uid: 'id1', title: 'cat' }),
+ ]);
+ expect(paginatedResponse.pageInfo.nextCursor).not.toBeUndefined();
+ expect(paginatedResponse.pageInfo.prevCursor).toBeUndefined();
+ expect(paginatedResponse.totalItems).toBe(4);
+
+ const paginatedResponseNext = await catalog.queryEntities({
+ cursor: paginatedResponse.pageInfo.nextCursor!,
+ });
+ expect(paginatedResponseNext.items).toEqual([
+ entityFrom('NotACatKing', { uid: 'id2', title: 'atcatss' }),
+ entityFrom('123', { uid: 'id3', title: 'king' }),
+ ]);
+ expect(paginatedResponseNext.pageInfo.nextCursor).toBeUndefined();
+ expect(paginatedResponseNext.pageInfo.prevCursor).not.toBeUndefined();
+ expect(paginatedResponseNext.totalItems).toBe(4);
+
+ const paginatedResponsePrev = await catalog.queryEntities({
+ cursor: paginatedResponseNext.pageInfo.prevCursor!,
+ });
+ expect(paginatedResponsePrev).toMatchObject(paginatedResponse);
+ },
+ );
+
it.each(databases.eachSupportedId())(
'should include totalItems and empty entities in the response in case limit is zero, %p',
async databaseId => {
@@ -1577,7 +1764,11 @@ describe('DefaultEntitiesCatalog', () => {
function entityFrom(
name: string,
- { uid, namespace }: { uid?: string; namespace?: string } = {},
+ {
+ uid,
+ namespace,
+ title,
+ }: { uid?: string; namespace?: string; title?: string } = {},
) {
return {
apiVersion: 'a',
@@ -1586,6 +1777,7 @@ function entityFrom(
name,
...(!!namespace && { namespace }),
...(!!uid && { uid }),
+ ...(!!title && { title }),
},
spec: { should_include_this: 'yes' },
};
diff --git a/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.ts b/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.ts
index 4e6109423e..ba165f96af 100644
--- a/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.ts
+++ b/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.ts
@@ -382,11 +382,30 @@ export class DefaultEntitiesCatalog implements EntitiesCatalog {
}
const normalizedFullTextFilterTerm = cursor.fullTextFilter?.term?.trim();
+ const textFilterFields = cursor.fullTextFilter?.fields ?? [sortField.field];
if (normalizedFullTextFilterTerm) {
- dbQuery.andWhereRaw(
- 'value like ?',
- `%${normalizedFullTextFilterTerm.toLocaleLowerCase('en-US')}%`,
- );
+ if (
+ textFilterFields.length === 1 &&
+ textFilterFields[0] === sortField.field
+ ) {
+ // If there is one item, apply the like query to the top level query which is already
+ // filtered based on the singular sortField.
+ dbQuery.andWhereRaw(
+ 'value like ?',
+ `%${normalizedFullTextFilterTerm.toLocaleLowerCase('en-US')}%`,
+ );
+ } else {
+ const matchQuery = db('search')
+ .select('search.entity_id')
+ .whereIn('key', textFilterFields)
+ .andWhere(function keyFilter() {
+ this.andWhereRaw(
+ 'value like ?',
+ `%${normalizedFullTextFilterTerm.toLocaleLowerCase('en-US')}%`,
+ );
+ });
+ dbQuery.andWhere('search.entity_id', 'in', matchQuery);
+ }
}
const countQuery = dbQuery.clone();
diff --git a/plugins/catalog-common/CHANGELOG.md b/plugins/catalog-common/CHANGELOG.md
index 813d888be2..37862d47bd 100644
--- a/plugins/catalog-common/CHANGELOG.md
+++ b/plugins/catalog-common/CHANGELOG.md
@@ -1,5 +1,15 @@
# @backstage/plugin-catalog-common
+## 1.0.12
+
+### Patch Changes
+
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- Updated dependencies
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/plugin-search-common@1.2.2
+
## 1.0.12-next.1
### Patch Changes
diff --git a/plugins/catalog-common/package.json b/plugins/catalog-common/package.json
index e2423f834b..aa7f26f4df 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": "1.0.12-next.1",
+ "version": "1.0.12",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/catalog-customized/CHANGELOG.md b/plugins/catalog-customized/CHANGELOG.md
index 654672a156..b71628d43c 100644
--- a/plugins/catalog-customized/CHANGELOG.md
+++ b/plugins/catalog-customized/CHANGELOG.md
@@ -1,5 +1,21 @@
# @internal/plugin-catalog-customized
+## 0.0.9-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog@1.10.0-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+
+## 0.0.8
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog@1.9.0
+ - @backstage/plugin-catalog-react@1.4.0
+
## 0.0.8-next.2
### Patch Changes
diff --git a/plugins/catalog-customized/package.json b/plugins/catalog-customized/package.json
index 20ef38355b..0cca05de5a 100644
--- a/plugins/catalog-customized/package.json
+++ b/plugins/catalog-customized/package.json
@@ -1,7 +1,7 @@
{
"name": "@internal/plugin-catalog-customized",
"description": "The internal Backstage Customizable plugin for browsing the Backstage catalog",
- "version": "0.0.8-next.2",
+ "version": "0.0.9-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/catalog-graph/CHANGELOG.md b/plugins/catalog-graph/CHANGELOG.md
index bd0a9d7c76..5975f7d319 100644
--- a/plugins/catalog-graph/CHANGELOG.md
+++ b/plugins/catalog-graph/CHANGELOG.md
@@ -1,5 +1,30 @@
# @backstage/plugin-catalog-graph
+## 0.2.29-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.2.28
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.2.28-next.2
### Patch Changes
diff --git a/plugins/catalog-graph/package.json b/plugins/catalog-graph/package.json
index ab7e7e78a9..f5cc5f7619 100644
--- a/plugins/catalog-graph/package.json
+++ b/plugins/catalog-graph/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-catalog-graph",
- "version": "0.2.28-next.2",
+ "version": "0.2.29-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -30,7 +30,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"classnames": "^2.3.1",
"lodash": "^4.17.15",
"p-limit": "^3.1.0",
diff --git a/plugins/catalog-graphql/CHANGELOG.md b/plugins/catalog-graphql/CHANGELOG.md
index 64721ef98e..041191fcef 100644
--- a/plugins/catalog-graphql/CHANGELOG.md
+++ b/plugins/catalog-graphql/CHANGELOG.md
@@ -1,5 +1,29 @@
# @backstage/plugin-catalog-graphql
+## 0.3.20-next.0
+
+### Patch Changes
+
+- e47e69eadf0: Updated dependency `@apollo/server` to `^4.0.0`.
+- Updated dependencies
+ - @backstage/config@1.0.7
+ - @backstage/catalog-model@1.2.1
+ - @backstage/types@1.0.2
+
+## 0.3.19
+
+### Patch Changes
+
+- b990021ddeb: Updated dependency `@graphql-codegen/cli` to `^3.0.0`.
+ Updated dependency `@graphql-codegen/graphql-modules-preset` to `^3.0.0`.
+ Updated dependency `@graphql-codegen/typescript` to `^3.0.0`.
+ Updated dependency `@graphql-codegen/typescript-resolvers` to `^3.0.0`.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/catalog-model@1.2.1
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.3.19-next.1
### Patch Changes
diff --git a/plugins/catalog-graphql/package.json b/plugins/catalog-graphql/package.json
index 0c6fc28c09..11b899f528 100644
--- a/plugins/catalog-graphql/package.json
+++ b/plugins/catalog-graphql/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-graphql",
"description": "An experimental Backstage catalog GraphQL module",
- "version": "0.3.19-next.1",
+ "version": "0.3.20-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -34,10 +34,11 @@
"clean": "backstage-cli package clean"
},
"dependencies": {
+ "@apollo/client": "^3.0.0",
+ "@apollo/server": "^4.0.0",
"@backstage/catalog-model": "workspace:^",
"@backstage/config": "workspace:^",
"@backstage/types": "workspace:^",
- "apollo-server": "^3.0.0",
"graphql": "^16.0.0",
"graphql-modules": "^2.0.0",
"graphql-tag": "^2.11.0",
diff --git a/plugins/catalog-graphql/src/graphql/module.test.ts b/plugins/catalog-graphql/src/graphql/module.test.ts
index 5490c2030a..d4589a2625 100644
--- a/plugins/catalog-graphql/src/graphql/module.test.ts
+++ b/plugins/catalog-graphql/src/graphql/module.test.ts
@@ -22,7 +22,7 @@ import { ConfigReader } from '@backstage/config';
import { ReaderEntity } from '../service/client';
import { createLogger } from 'winston';
import { setupRequestMockHandlers } from '@backstage/test-utils';
-import { gql } from 'apollo-server';
+import { gql } from '@apollo/client';
import { Module, createApplication, testkit } from 'graphql-modules';
describe('Catalog Module', () => {
diff --git a/plugins/catalog-import/CHANGELOG.md b/plugins/catalog-import/CHANGELOG.md
index 0451769b82..2298180278 100644
--- a/plugins/catalog-import/CHANGELOG.md
+++ b/plugins/catalog-import/CHANGELOG.md
@@ -1,5 +1,39 @@
# @backstage/plugin-catalog-import
+## 0.9.7-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/integration-react@1.1.12-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-catalog-common@1.0.12
+
+## 0.9.6
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/integration-react@1.1.11
+ - @backstage/integration@1.4.3
+ - @backstage/config@1.0.7
+
## 0.9.6-next.2
### Patch Changes
diff --git a/plugins/catalog-import/package.json b/plugins/catalog-import/package.json
index baddab4656..d27a6118bd 100644
--- a/plugins/catalog-import/package.json
+++ b/plugins/catalog-import/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-import",
"description": "A Backstage plugin the helps you import entities into your catalog",
- "version": "0.9.6-next.2",
+ "version": "0.9.7-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -44,7 +44,7 @@
"@backstage/plugin-catalog-react": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"@octokit/rest": "^19.0.3",
"git-url-parse": "^13.0.0",
"js-base64": "^3.6.0",
diff --git a/plugins/catalog-node/CHANGELOG.md b/plugins/catalog-node/CHANGELOG.md
index 8ed02981ca..e38a38d596 100644
--- a/plugins/catalog-node/CHANGELOG.md
+++ b/plugins/catalog-node/CHANGELOG.md
@@ -1,5 +1,31 @@
# @backstage/plugin-catalog-node
+## 1.3.5-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+ - @backstage/plugin-catalog-common@1.0.12
+
+## 1.3.4
+
+### Patch Changes
+
+- e675f902980: Added `locationSpecToMetadataName` and `locationSpecToLocationEntity` as their new home, moved over from the backend package where they now are marked as deprecated.
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/errors@1.1.5
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/types@1.0.2
+
## 1.3.4-next.2
### Patch Changes
diff --git a/plugins/catalog-node/package.json b/plugins/catalog-node/package.json
index d5ad3b86ea..31b7032462 100644
--- a/plugins/catalog-node/package.json
+++ b/plugins/catalog-node/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-node",
"description": "The plugin-catalog-node module for @backstage/plugin-catalog-backend",
- "version": "1.3.4-next.2",
+ "version": "1.3.5-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/catalog-react/CHANGELOG.md b/plugins/catalog-react/CHANGELOG.md
index 4d8acf0936..f7a96b5f07 100644
--- a/plugins/catalog-react/CHANGELOG.md
+++ b/plugins/catalog-react/CHANGELOG.md
@@ -1,5 +1,49 @@
# @backstage/plugin-catalog-react
+## 1.4.1-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/integration@1.4.3
+ - @backstage/plugin-permission-react@0.4.11
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+ - @backstage/types@1.0.2
+ - @backstage/version-bridge@1.0.3
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/plugin-permission-common@0.7.4
+
+## 1.4.0
+
+### Minor Changes
+
+- 0a5b73b2926: Add possibility to re-use EntityPicker for filters with multiple select.
+
+### Patch Changes
+
+- 65454876fb2: Minor API report tweaks
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 24916d23494: Do not close `Autocomplete` powered multiple-selection filters when checking boxes
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/core-components@0.12.5
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/integration@1.4.3
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/theme@0.2.18
+ - @backstage/types@1.0.2
+ - @backstage/version-bridge@1.0.3
+ - @backstage/plugin-permission-react@0.4.11
+
## 1.4.0-next.2
### Patch Changes
diff --git a/plugins/catalog-react/package.json b/plugins/catalog-react/package.json
index 8f0b9627c7..166da09118 100644
--- a/plugins/catalog-react/package.json
+++ b/plugins/catalog-react/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog-react",
"description": "A frontend library that helps other Backstage plugins interact with the catalog",
- "version": "1.4.0-next.2",
+ "version": "1.4.1-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -59,7 +59,7 @@
"@backstage/version-bridge": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"classnames": "^2.2.6",
"jwt-decode": "^3.1.0",
"lodash": "^4.17.21",
diff --git a/plugins/catalog/CHANGELOG.md b/plugins/catalog/CHANGELOG.md
index 873c90de07..d7cd7cbe3a 100644
--- a/plugins/catalog/CHANGELOG.md
+++ b/plugins/catalog/CHANGELOG.md
@@ -1,5 +1,78 @@
# @backstage/plugin-catalog
+## 1.10.0-next.0
+
+### Minor Changes
+
+- 4dbf3d3e4da: Added a new EntitySwitch isResourceType to allow different views depending on Resource type
+- fc6cab4eb48: Added `isEntityWith` condition helper for `EntitySwitch` case statements.
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-search-react@1.5.2-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/integration-react@1.1.12-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+ - @backstage/types@1.0.2
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/plugin-search-common@1.2.2
+
+## 1.9.0
+
+### Minor Changes
+
+- 23cc40039c0: Allow `EntitySwitch` to render all cases that match the condition.
+
+ This change introduces a new parameter for the `EntitySwitch` component
+ `renderMultipleMatches`. In case the parameter value is `all`, the `EntitySwitch`
+ will render all `EntitySwitch.Case` that contain `if` parameter, and it
+ evaluates to true. In case none of the cases match, the default case will be
+ rendered, if any.
+
+ This means for example in the CI/CD page you can now do the following:
+
+ ```tsx
+
+ Jenkins
+ CodeBuild
+ No CI/CD
+
+ ```
+
+ This allows the component to have multiple CI/CD systems and all of those are
+ rendered on the same page.
+
+- 3f75b7607ca: Add ability to pass icon as function to have ability to customize it by search item
+- c9a9f3c834f: Add a `columns` prop to certain components that use the `EntityTable` for easier extensibility.
+
+### Patch Changes
+
+- 3fa41696820: Make the "Copied!" message disappear automatically after some time
+- 7e8930ae1c6: Fix icon alignment in `CatalogSearchResultListItem`
+- dbbde6ed353: fix entity switch rendering when there is no default case
+- cb8ec97cdeb: Change black & white colors to be theme aware
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/plugin-search-react@1.5.1
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/integration-react@1.1.11
+ - @backstage/theme@0.2.18
+ - @backstage/types@1.0.2
+ - @backstage/plugin-search-common@1.2.2
+
## 1.9.0-next.2
### Minor Changes
diff --git a/plugins/catalog/api-report.md b/plugins/catalog/api-report.md
index d891ebb7c8..ca91296913 100644
--- a/plugins/catalog/api-report.md
+++ b/plugins/catalog/api-report.md
@@ -355,6 +355,14 @@ export const EntityListContainer: (props: {
// @public
export function EntityOrphanWarning(): JSX.Element;
+// @public (undocumented)
+export interface EntityPredicates {
+ // (undocumented)
+ kind?: string | string[];
+ // (undocumented)
+ type?: string | string[];
+}
+
// @public
export function EntityProcessingErrorsPanel(): JSX.Element | null;
@@ -433,6 +441,11 @@ export function isComponentType(
types: string | string[],
): (entity: Entity) => boolean;
+// @public
+export function isEntityWith(
+ predicate: EntityPredicates,
+): (entity: Entity) => boolean;
+
// @public
export function isKind(kinds: string | string[]): (entity: Entity) => boolean;
@@ -444,6 +457,11 @@ export function isNamespace(
// @public
export function isOrphan(entity: Entity): boolean;
+// @public
+export function isResourceType(
+ types: string | string[],
+): (entity: Entity) => boolean;
+
// @public (undocumented)
export type PluginCatalogComponentsNameToClassKey = {
PluginCatalogEntityLinksEmptyState: EntityLinksEmptyStateClassKey;
diff --git a/plugins/catalog/package.json b/plugins/catalog/package.json
index c66ae8fb5e..49242b8724 100644
--- a/plugins/catalog/package.json
+++ b/plugins/catalog/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-catalog",
"description": "The Backstage plugin for browsing the Backstage catalog",
- "version": "1.9.0-next.2",
+ "version": "1.10.0-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -46,7 +46,7 @@
"@backstage/types": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"history": "^5.0.0",
"lodash": "^4.17.21",
"pluralize": "^8.0.0",
diff --git a/plugins/catalog/src/components/EntityContextMenu/EntityContextMenu.tsx b/plugins/catalog/src/components/EntityContextMenu/EntityContextMenu.tsx
index 675f74fa8d..1961fe6cac 100644
--- a/plugins/catalog/src/components/EntityContextMenu/EntityContextMenu.tsx
+++ b/plugins/catalog/src/components/EntityContextMenu/EntityContextMenu.tsx
@@ -90,9 +90,13 @@ export function EntityContextMenu(props: EntityContextMenuProps) {
const alertApi = useApi(alertApiRef);
const copyToClipboard = useCallback(() => {
- window.navigator.clipboard
- .writeText(window.location.toString())
- .then(() => alertApi.post({ message: 'Copied!', severity: 'info' }));
+ window.navigator.clipboard.writeText(window.location.toString()).then(() =>
+ alertApi.post({
+ message: 'Copied!',
+ severity: 'info',
+ display: 'transient',
+ }),
+ );
}, [alertApi]);
const extraItems = UNSTABLE_extraContextMenuItems && [
diff --git a/plugins/catalog/src/components/EntitySwitch/conditions.test.ts b/plugins/catalog/src/components/EntitySwitch/conditions.test.ts
index dfed546fd8..66408aec18 100644
--- a/plugins/catalog/src/components/EntitySwitch/conditions.test.ts
+++ b/plugins/catalog/src/components/EntitySwitch/conditions.test.ts
@@ -15,7 +15,34 @@
*/
import { Entity } from '@backstage/catalog-model';
-import { isComponentType, isKind, isNamespace } from './conditions';
+import {
+ isComponentType,
+ isKind,
+ isNamespace,
+ isResourceType,
+ isEntityWith,
+} from './conditions';
+
+const kubernetesClusterResource: Entity = {
+ apiVersion: '',
+ kind: 'Resource',
+ metadata: { name: 'aKubernetesCluster' },
+ spec: { type: 'kubernetes-cluster' },
+};
+
+const databaseResource: Entity = {
+ apiVersion: '',
+ kind: 'Resource',
+ metadata: { name: 'aDatabase' },
+ spec: { type: 'database' },
+};
+
+const notResource: Entity = {
+ apiVersion: '',
+ kind: 'not-Resource',
+ metadata: { name: 'aService' },
+ spec: { type: 'service' },
+};
const serviceComponent: Entity = {
apiVersion: '',
@@ -38,6 +65,13 @@ const notComponent: Entity = {
spec: { type: 'service' },
};
+const missingSpecType: Entity = {
+ apiVersion: '',
+ kind: 'another-type',
+ metadata: { name: 'anEntity' },
+ spec: {},
+};
+
const apiKind: Entity = {
apiVersion: '',
kind: 'api',
@@ -59,6 +93,26 @@ const bNamespace: Entity = {
spec: { type: 'service' },
};
+describe('isResourceType', () => {
+ it('should false on non resource kinds', () => {
+ const checkEntity = isResourceType('kubernetes-cluster');
+
+ expect(checkEntity(notResource)).not.toBeTruthy();
+ });
+ it('should check for the intended type', () => {
+ const checkEntity = isResourceType('kubernetes-cluster');
+
+ expect(checkEntity(databaseResource)).not.toBeTruthy();
+ expect(checkEntity(kubernetesClusterResource)).toBeTruthy();
+ });
+ it('should check for multiple types', () => {
+ const checkEntity = isResourceType(['database', 'kubernetes-cluster']);
+
+ expect(checkEntity(databaseResource)).toBeTruthy();
+ expect(checkEntity(kubernetesClusterResource)).toBeTruthy();
+ });
+});
+
describe('isComponentType', () => {
it('should false on non component kinds', () => {
const checkEntity = isComponentType('service');
@@ -79,6 +133,25 @@ describe('isComponentType', () => {
});
});
+describe('isEntityWith', () => {
+ it('allows for a kind-only check (empty type array)', () => {
+ const checkEntity = isEntityWith({ kind: 'api', type: [] });
+ expect(checkEntity(apiKind)).toBeTruthy();
+ });
+ it('handles missing spec.type field', () => {
+ const checkEntity = isEntityWith({ kind: 'another-type', type: 'service' });
+ expect(checkEntity(missingSpecType)).not.toBeTruthy();
+ });
+ it('allows a check against no criteria', () => {
+ const checkEntity = isEntityWith({});
+ expect(checkEntity(apiKind)).toBeTruthy();
+ });
+ it('allows a check against empty criteria', () => {
+ const checkEntity = isEntityWith({ kind: [], type: [] });
+ expect(checkEntity(apiKind)).toBeTruthy();
+ });
+});
+
describe('isKind', () => {
it('should check for the intended kind', () => {
const checkEntity = isKind('component');
diff --git a/plugins/catalog/src/components/EntitySwitch/conditions.ts b/plugins/catalog/src/components/EntitySwitch/conditions.ts
index 86fd38a900..f834804141 100644
--- a/plugins/catalog/src/components/EntitySwitch/conditions.ts
+++ b/plugins/catalog/src/components/EntitySwitch/conditions.ts
@@ -14,18 +14,26 @@
* limitations under the License.
*/
-import { ComponentEntity, Entity } from '@backstage/catalog-model';
+import { Entity } from '@backstage/catalog-model';
-function strCmp(a: string | undefined, b: string | undefined): boolean {
+/** @public */
+export interface EntityPredicates {
+ kind?: string | string[];
+ type?: string | string[];
+}
+
+function strCmp(a: unknown, b: string | undefined): boolean {
return Boolean(
- a && a?.toLocaleLowerCase('en-US') === b?.toLocaleLowerCase('en-US'),
+ a &&
+ typeof a === 'string' &&
+ a?.toLocaleLowerCase('en-US') === b?.toLocaleLowerCase('en-US'),
);
}
-function strCmpAll(value: string | undefined, cmpValues: string | string[]) {
+function strCmpAll(value: unknown, cmpValues: string | string[]) {
return typeof cmpValues === 'string'
? strCmp(value, cmpValues)
- : cmpValues.some(cmpVal => strCmp(value, cmpVal));
+ : cmpValues.length === 0 || cmpValues.some(cmpVal => strCmp(value, cmpVal));
}
/**
@@ -33,7 +41,7 @@ function strCmpAll(value: string | undefined, cmpValues: string | string[]) {
* @public
*/
export function isKind(kinds: string | string[]) {
- return (entity: Entity) => strCmpAll(entity.kind, kinds);
+ return isEntityWith({ kind: kinds });
}
/**
@@ -41,12 +49,33 @@ export function isKind(kinds: string | string[]) {
* @public
*/
export function isComponentType(types: string | string[]) {
+ return isEntityWith({ kind: 'component', type: types });
+}
+
+/**
+ * For use in EntitySwitch.Case. Matches if the entity is a Resource of a given spec.type.
+ * @public
+ */
+export function isResourceType(types: string | string[]) {
+ return isEntityWith({ kind: 'resource', type: types });
+}
+
+/**
+ * For use in EntitySwitch.Case. Matches if the entity is the specified kind and type (if present).
+ * @public
+ */
+export function isEntityWith(predicate: EntityPredicates) {
return (entity: Entity) => {
- if (!strCmp(entity.kind, 'component')) {
+ if (predicate.kind && !strCmpAll(entity.kind, predicate.kind)) {
return false;
}
- const componentEntity = entity as ComponentEntity;
- return strCmpAll(componentEntity.spec.type, types);
+
+ if (predicate.type && !strCmpAll(entity.spec?.type, predicate.type)) {
+ return false;
+ }
+
+ // there's no type check, return true
+ return true;
};
}
diff --git a/plugins/catalog/src/components/EntitySwitch/index.ts b/plugins/catalog/src/components/EntitySwitch/index.ts
index 6cccf4be6e..8848f98866 100644
--- a/plugins/catalog/src/components/EntitySwitch/index.ts
+++ b/plugins/catalog/src/components/EntitySwitch/index.ts
@@ -16,4 +16,11 @@
export { EntitySwitch } from './EntitySwitch';
export type { EntitySwitchProps, EntitySwitchCaseProps } from './EntitySwitch';
-export { isKind, isNamespace, isComponentType } from './conditions';
+export type { EntityPredicates } from './conditions';
+export {
+ isKind,
+ isNamespace,
+ isComponentType,
+ isResourceType,
+ isEntityWith,
+} from './conditions';
diff --git a/plugins/cicd-statistics-module-gitlab/CHANGELOG.md b/plugins/cicd-statistics-module-gitlab/CHANGELOG.md
index 55ec192258..f68f624292 100644
--- a/plugins/cicd-statistics-module-gitlab/CHANGELOG.md
+++ b/plugins/cicd-statistics-module-gitlab/CHANGELOG.md
@@ -1,5 +1,23 @@
# @backstage/plugin-cicd-statistics-module-gitlab
+## 0.1.13-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-cicd-statistics@0.1.19-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+
+## 0.1.12
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-cicd-statistics@0.1.18
+
## 0.1.12-next.2
### Patch Changes
diff --git a/plugins/cicd-statistics-module-gitlab/package.json b/plugins/cicd-statistics-module-gitlab/package.json
index 38de7c6799..3cef2e0ff7 100644
--- a/plugins/cicd-statistics-module-gitlab/package.json
+++ b/plugins/cicd-statistics-module-gitlab/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-cicd-statistics-module-gitlab",
"description": "CI/CD Statistics plugin module; Gitlab CICD",
- "version": "0.1.12-next.2",
+ "version": "0.1.13-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/cicd-statistics/CHANGELOG.md b/plugins/cicd-statistics/CHANGELOG.md
index 97434f99c7..86c2579da9 100644
--- a/plugins/cicd-statistics/CHANGELOG.md
+++ b/plugins/cicd-statistics/CHANGELOG.md
@@ -1,5 +1,24 @@
# @backstage/plugin-cicd-statistics
+## 0.1.19-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+
+## 0.1.18
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+
## 0.1.18-next.2
### Patch Changes
diff --git a/plugins/cicd-statistics/package.json b/plugins/cicd-statistics/package.json
index 8262235489..1a531cbf88 100644
--- a/plugins/cicd-statistics/package.json
+++ b/plugins/cicd-statistics/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-cicd-statistics",
"description": "A frontend plugin visualizing CI/CD pipeline statistics (build time)",
- "version": "0.1.18-next.2",
+ "version": "0.1.19-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -43,7 +43,7 @@
"@date-io/luxon": "^1.3.13",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"@material-ui/pickers": "^3.3.10",
"already": "^3.2.0",
"humanize-duration": "^3.27.0",
diff --git a/plugins/circleci/CHANGELOG.md b/plugins/circleci/CHANGELOG.md
index c43162fe14..7dc02638c4 100644
--- a/plugins/circleci/CHANGELOG.md
+++ b/plugins/circleci/CHANGELOG.md
@@ -1,5 +1,30 @@
# @backstage/plugin-circleci
+## 0.3.17-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.3.16
+
+### Patch Changes
+
+- c10384a9235: Switch to using `LinkButton` instead of the deprecated `Button`
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.3.16-next.2
### Patch Changes
diff --git a/plugins/circleci/package.json b/plugins/circleci/package.json
index 55d02ce8bd..5f74d66245 100644
--- a/plugins/circleci/package.json
+++ b/plugins/circleci/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-circleci",
"description": "A Backstage plugin that integrates towards Circle CI",
- "version": "0.3.16-next.2",
+ "version": "0.3.17-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -40,7 +40,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"circleci-api": "^4.0.0",
"humanize-duration": "^3.27.0",
"lodash": "^4.17.21",
diff --git a/plugins/circleci/src/index.ts b/plugins/circleci/src/index.ts
index e20f5c7d6b..442f774b68 100644
--- a/plugins/circleci/src/index.ts
+++ b/plugins/circleci/src/index.ts
@@ -15,7 +15,7 @@
*/
/**
- * A Backstage plugin that integrates towards Circle CI
+ * A Backstage plugin that integrates towards CircleCI.
*
* @packageDocumentation
*/
diff --git a/plugins/cloudbuild/CHANGELOG.md b/plugins/cloudbuild/CHANGELOG.md
index bc5f71d8e1..e1131349cf 100644
--- a/plugins/cloudbuild/CHANGELOG.md
+++ b/plugins/cloudbuild/CHANGELOG.md
@@ -1,5 +1,29 @@
# @backstage/plugin-cloudbuild
+## 0.3.17-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.3.16
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.3.16-next.2
### Patch Changes
diff --git a/plugins/cloudbuild/package.json b/plugins/cloudbuild/package.json
index 04fa511cb6..87b76043d2 100644
--- a/plugins/cloudbuild/package.json
+++ b/plugins/cloudbuild/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-cloudbuild",
"description": "A Backstage plugin that integrates towards Google Cloud Build",
- "version": "0.3.16-next.2",
+ "version": "0.3.17-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -40,7 +40,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"luxon": "^3.0.0",
"qs": "^6.9.4",
"react-use": "^17.2.4"
diff --git a/plugins/code-climate/CHANGELOG.md b/plugins/code-climate/CHANGELOG.md
index e98be293b8..f84df1f4fd 100644
--- a/plugins/code-climate/CHANGELOG.md
+++ b/plugins/code-climate/CHANGELOG.md
@@ -1,5 +1,30 @@
# @backstage/plugin-code-climate
+## 0.1.17-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.1.16
+
+### Patch Changes
+
+- cb8ec97cdeb: Change black & white colors to be theme aware
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.1.16-next.2
### Patch Changes
diff --git a/plugins/code-climate/package.json b/plugins/code-climate/package.json
index 9890f8b95e..1b75d7c59d 100644
--- a/plugins/code-climate/package.json
+++ b/plugins/code-climate/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-code-climate",
- "version": "0.1.16-next.2",
+ "version": "0.1.17-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -29,7 +29,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"humanize-duration": "^3.27.1",
"luxon": "^3.0.0",
"react-use": "^17.2.4"
diff --git a/plugins/code-coverage-backend/CHANGELOG.md b/plugins/code-coverage-backend/CHANGELOG.md
index 74336f32c8..9f498b3687 100644
--- a/plugins/code-coverage-backend/CHANGELOG.md
+++ b/plugins/code-coverage-backend/CHANGELOG.md
@@ -1,5 +1,30 @@
# @backstage/plugin-code-coverage-backend
+## 0.2.10-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+
+## 0.2.9
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/catalog-model@1.2.1
+ - @backstage/integration@1.4.3
+ - @backstage/config@1.0.7
+
## 0.2.9-next.2
### Patch Changes
diff --git a/plugins/code-coverage-backend/package.json b/plugins/code-coverage-backend/package.json
index fca52bdebc..dd4dac88c8 100644
--- a/plugins/code-coverage-backend/package.json
+++ b/plugins/code-coverage-backend/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-code-coverage-backend",
"description": "A Backstage backend plugin that helps you keep track of your code coverage",
- "version": "0.2.9-next.2",
+ "version": "0.2.10-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/code-coverage/CHANGELOG.md b/plugins/code-coverage/CHANGELOG.md
index 914768f638..dfa39648c7 100644
--- a/plugins/code-coverage/CHANGELOG.md
+++ b/plugins/code-coverage/CHANGELOG.md
@@ -1,5 +1,34 @@
# @backstage/plugin-code-coverage
+## 0.2.10-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+
+## 0.2.9
+
+### Patch Changes
+
+- cb8ec97cdeb: Change black & white colors to be theme aware
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/config@1.0.7
+ - @backstage/theme@0.2.18
+
## 0.2.9-next.2
### Patch Changes
diff --git a/plugins/code-coverage/package.json b/plugins/code-coverage/package.json
index cfdddfc6af..e09a20355e 100644
--- a/plugins/code-coverage/package.json
+++ b/plugins/code-coverage/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-code-coverage",
"description": "A Backstage plugin that helps you keep track of your code coverage",
- "version": "0.2.9-next.2",
+ "version": "0.2.10-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -32,7 +32,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"@material-ui/styles": "^4.11.0",
"highlight.js": "^10.6.0",
"luxon": "^3.0.0",
diff --git a/plugins/codescene/CHANGELOG.md b/plugins/codescene/CHANGELOG.md
index 7390729c48..f854b3f22d 100644
--- a/plugins/codescene/CHANGELOG.md
+++ b/plugins/codescene/CHANGELOG.md
@@ -1,5 +1,28 @@
# @backstage/plugin-codescene
+## 0.1.12-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+
+## 0.1.11
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/theme@0.2.18
+
## 0.1.11-next.2
### Patch Changes
diff --git a/plugins/codescene/package.json b/plugins/codescene/package.json
index 49cedd3bc4..3e688063fc 100644
--- a/plugins/codescene/package.json
+++ b/plugins/codescene/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-codescene",
- "version": "0.1.11-next.2",
+ "version": "0.1.12-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -29,7 +29,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "^4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"rc-progress": "3.4.1",
"react-use": "^17.2.4"
},
diff --git a/plugins/config-schema/CHANGELOG.md b/plugins/config-schema/CHANGELOG.md
index 5e0de80621..e4e81e46c0 100644
--- a/plugins/config-schema/CHANGELOG.md
+++ b/plugins/config-schema/CHANGELOG.md
@@ -1,5 +1,31 @@
# @backstage/plugin-config-schema
+## 0.1.40-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+ - @backstage/types@1.0.2
+
+## 0.1.39
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/theme@0.2.18
+ - @backstage/types@1.0.2
+
## 0.1.39-next.2
### Patch Changes
diff --git a/plugins/config-schema/package.json b/plugins/config-schema/package.json
index 730265cbea..13222fd55d 100644
--- a/plugins/config-schema/package.json
+++ b/plugins/config-schema/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-config-schema",
"description": "A Backstage plugin that lets you browse the configuration schema of your app",
- "version": "0.1.39-next.2",
+ "version": "0.1.40-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -31,7 +31,7 @@
"@backstage/types": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"jsonschema": "^1.2.6",
"react-use": "^17.2.4",
"zen-observable": "^0.10.0"
diff --git a/plugins/cost-insights/CHANGELOG.md b/plugins/cost-insights/CHANGELOG.md
index f108804cb6..8d459fb000 100644
--- a/plugins/cost-insights/CHANGELOG.md
+++ b/plugins/cost-insights/CHANGELOG.md
@@ -1,5 +1,34 @@
# @backstage/plugin-cost-insights
+## 0.12.6-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-cost-insights-common@0.1.1
+
+## 0.12.5
+
+### Patch Changes
+
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/config@1.0.7
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-cost-insights-common@0.1.1
+
## 0.12.5-next.2
### Patch Changes
diff --git a/plugins/cost-insights/package.json b/plugins/cost-insights/package.json
index aabd4d340d..aef2c7635e 100644
--- a/plugins/cost-insights/package.json
+++ b/plugins/cost-insights/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-cost-insights",
"description": "A Backstage plugin that helps you keep track of your cloud spend",
- "version": "0.12.5-next.2",
+ "version": "0.12.6-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -41,7 +41,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"@material-ui/styles": "^4.9.6",
"@types/recharts": "^1.8.14",
"classnames": "^2.2.6",
diff --git a/plugins/dynatrace/CHANGELOG.md b/plugins/dynatrace/CHANGELOG.md
index 402ee43c1e..46fde4973e 100644
--- a/plugins/dynatrace/CHANGELOG.md
+++ b/plugins/dynatrace/CHANGELOG.md
@@ -1,5 +1,29 @@
# @backstage/plugin-dynatrace
+## 3.0.1-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 3.0.0
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 3.0.0-next.2
### Patch Changes
diff --git a/plugins/dynatrace/README.md b/plugins/dynatrace/README.md
index df6bb75f10..b07fe985fe 100644
--- a/plugins/dynatrace/README.md
+++ b/plugins/dynatrace/README.md
@@ -49,7 +49,7 @@ const serviceEntityPage = (
+ >
+ ;
// (undocumented)
getOwnedRatings(ownerRef: string): Promise;
+ getRatingAggregates(entityRef: string): Promise;
// (undocumented)
getRatings(entityRef: string): Promise[]>;
// (undocumented)
@@ -48,6 +50,8 @@ export class EntityFeedbackClient implements EntityFeedbackApi {
// (undocumented)
getOwnedRatings(ownerRef: string): Promise;
// (undocumented)
+ getRatingAggregates(entityRef: string): Promise;
+ // (undocumented)
getRatings(entityRef: string): Promise[]>;
// (undocumented)
getResponses(
diff --git a/plugins/entity-feedback/package.json b/plugins/entity-feedback/package.json
index 760b192440..bac96f561c 100644
--- a/plugins/entity-feedback/package.json
+++ b/plugins/entity-feedback/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-entity-feedback",
- "version": "0.1.1-next.2",
+ "version": "0.2.0-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -36,7 +36,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.9.13",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"react-use": "^17.2.4"
},
"peerDependencies": {
diff --git a/plugins/entity-feedback/src/api/EntityFeedbackApi.ts b/plugins/entity-feedback/src/api/EntityFeedbackApi.ts
index d2f1a46f55..7ec6a447f0 100644
--- a/plugins/entity-feedback/src/api/EntityFeedbackApi.ts
+++ b/plugins/entity-feedback/src/api/EntityFeedbackApi.ts
@@ -19,6 +19,7 @@ import {
EntityRatingsData,
FeedbackResponse,
Rating,
+ Ratings,
} from '@backstage/plugin-entity-feedback-common';
/**
@@ -40,6 +41,11 @@ export interface EntityFeedbackApi {
getRatings(entityRef: string): Promise[]>;
+ /**
+ * Returns anonymized aggregated results for one entityRef
+ */
+ getRatingAggregates(entityRef: string): Promise;
+
recordResponse(
entityRef: string,
response: Omit,
diff --git a/plugins/entity-feedback/src/api/EntityFeedbackClient.test.ts b/plugins/entity-feedback/src/api/EntityFeedbackClient.test.ts
index 694fd66b06..8ef6810115 100644
--- a/plugins/entity-feedback/src/api/EntityFeedbackClient.test.ts
+++ b/plugins/entity-feedback/src/api/EntityFeedbackClient.test.ts
@@ -121,6 +121,24 @@ describe('EntityFeedbackClient', () => {
expect(response).toEqual(ratings);
});
+ it('getRatingAggregates', async () => {
+ const ratings = { LIKE: 3, DISLIKE: 5 };
+
+ server.use(
+ rest.get(
+ `${mockBaseUrl}/ratings/${encodeURIComponent(
+ 'component:default/service',
+ )}/aggregate`,
+ (_, res, ctx) => res(ctx.json(ratings)),
+ ),
+ );
+
+ const response = await client.getRatingAggregates(
+ 'component:default/service',
+ );
+ expect(response).toEqual(ratings);
+ });
+
it('recordResponse', async () => {
expect.assertions(1);
const response = {
diff --git a/plugins/entity-feedback/src/api/EntityFeedbackClient.ts b/plugins/entity-feedback/src/api/EntityFeedbackClient.ts
index 34856473c8..f911cdc7f8 100644
--- a/plugins/entity-feedback/src/api/EntityFeedbackClient.ts
+++ b/plugins/entity-feedback/src/api/EntityFeedbackClient.ts
@@ -20,6 +20,7 @@ import {
EntityRatingsData,
FeedbackResponse,
Rating,
+ Ratings,
} from '@backstage/plugin-entity-feedback-common';
import { EntityFeedbackApi } from './EntityFeedbackApi';
@@ -97,6 +98,22 @@ export class EntityFeedbackClient implements EntityFeedbackApi {
return resp.json();
}
+ async getRatingAggregates(entityRef: string): Promise {
+ const baseUrl = await this.discoveryApi.getBaseUrl('entity-feedback');
+ const resp = await this.fetchApi.fetch(
+ `${baseUrl}/ratings/${encodeURIComponent(entityRef)}/aggregate`,
+ {
+ method: 'GET',
+ },
+ );
+
+ if (!resp.ok) {
+ throw await ResponseError.fromResponse(resp);
+ }
+
+ return resp.json();
+ }
+
async recordResponse(
entityRef: string,
response: Omit,
diff --git a/plugins/entity-validation/CHANGELOG.md b/plugins/entity-validation/CHANGELOG.md
index 43ecb6527d..dc7db0eaec 100644
--- a/plugins/entity-validation/CHANGELOG.md
+++ b/plugins/entity-validation/CHANGELOG.md
@@ -1,5 +1,36 @@
# @backstage/plugin-entity-validation
+## 0.1.2-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-catalog-common@1.0.12
+
+## 0.1.1
+
+### Patch Changes
+
+- 47d246691ac: Fixed bug in EntityVaidation plugin where string in text box was unable to be updated.
+- c10384a9235: Switch to using `LinkButton` instead of the deprecated `Button`
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/theme@0.2.18
+
## 0.1.1-next.2
### Patch Changes
diff --git a/plugins/entity-validation/package.json b/plugins/entity-validation/package.json
index 81c13cc46b..811f9ab3c8 100644
--- a/plugins/entity-validation/package.json
+++ b/plugins/entity-validation/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-entity-validation",
- "version": "0.1.1-next.2",
+ "version": "0.1.2-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -40,7 +40,7 @@
"@codemirror/view": "^6.0.0",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "^4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"@react-hookz/web": "^20.0.0",
"@uiw/react-codemirror": "^4.9.3",
"lodash": "^4.17.21",
diff --git a/plugins/events-backend-module-aws-sqs/CHANGELOG.md b/plugins/events-backend-module-aws-sqs/CHANGELOG.md
index 0e5659c538..2dc726e160 100644
--- a/plugins/events-backend-module-aws-sqs/CHANGELOG.md
+++ b/plugins/events-backend-module-aws-sqs/CHANGELOG.md
@@ -1,5 +1,31 @@
# @backstage/plugin-events-backend-module-aws-sqs
+## 0.1.6-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/types@1.0.2
+ - @backstage/plugin-events-node@0.2.5-next.0
+
+## 0.1.5
+
+### Patch Changes
+
+- a5de745ac17: Renamed `awsSqsConsumingEventPublisherEventsModule` to `eventsModuleAwsSqsConsumingEventPublisher` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- Updated dependencies
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/plugin-events-node@0.2.4
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.1.5-next.2
### Patch Changes
diff --git a/plugins/events-backend-module-aws-sqs/package.json b/plugins/events-backend-module-aws-sqs/package.json
index 9278099801..a90dafadde 100644
--- a/plugins/events-backend-module-aws-sqs/package.json
+++ b/plugins/events-backend-module-aws-sqs/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-events-backend-module-aws-sqs",
- "version": "0.1.5-next.2",
+ "version": "0.1.6-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/events-backend-module-azure/CHANGELOG.md b/plugins/events-backend-module-azure/CHANGELOG.md
index 159603d965..35560f1156 100644
--- a/plugins/events-backend-module-azure/CHANGELOG.md
+++ b/plugins/events-backend-module-azure/CHANGELOG.md
@@ -1,5 +1,23 @@
# @backstage/plugin-events-backend-module-azure
+## 0.1.6-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/plugin-events-node@0.2.5-next.0
+
+## 0.1.5
+
+### Patch Changes
+
+- a5de745ac17: Renamed `azureDevOpsEventRouterEventsModule` to `eventsModuleAzureDevOpsEventRouter` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/plugin-events-node@0.2.4
+
## 0.1.5-next.2
### Patch Changes
diff --git a/plugins/events-backend-module-azure/package.json b/plugins/events-backend-module-azure/package.json
index ef00f0f3b9..2b66bd1421 100644
--- a/plugins/events-backend-module-azure/package.json
+++ b/plugins/events-backend-module-azure/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-events-backend-module-azure",
- "version": "0.1.5-next.2",
+ "version": "0.1.6-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/events-backend-module-bitbucket-cloud/CHANGELOG.md b/plugins/events-backend-module-bitbucket-cloud/CHANGELOG.md
index 9cf0d0a70e..8189dc2b99 100644
--- a/plugins/events-backend-module-bitbucket-cloud/CHANGELOG.md
+++ b/plugins/events-backend-module-bitbucket-cloud/CHANGELOG.md
@@ -1,5 +1,23 @@
# @backstage/plugin-events-backend-module-bitbucket-cloud
+## 0.1.6-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/plugin-events-node@0.2.5-next.0
+
+## 0.1.5
+
+### Patch Changes
+
+- a5de745ac17: Renamed `bitbucketCloudEventRouterEventsModule` to `eventsModuleBitbucketCloudEventRouter` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/plugin-events-node@0.2.4
+
## 0.1.5-next.2
### Patch Changes
diff --git a/plugins/events-backend-module-bitbucket-cloud/package.json b/plugins/events-backend-module-bitbucket-cloud/package.json
index fa7dba892e..e575d325ff 100644
--- a/plugins/events-backend-module-bitbucket-cloud/package.json
+++ b/plugins/events-backend-module-bitbucket-cloud/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-events-backend-module-bitbucket-cloud",
- "version": "0.1.5-next.2",
+ "version": "0.1.6-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/events-backend-module-gerrit/CHANGELOG.md b/plugins/events-backend-module-gerrit/CHANGELOG.md
index accd659217..82bf56ef32 100644
--- a/plugins/events-backend-module-gerrit/CHANGELOG.md
+++ b/plugins/events-backend-module-gerrit/CHANGELOG.md
@@ -1,5 +1,23 @@
# @backstage/plugin-events-backend-module-gerrit
+## 0.1.6-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/plugin-events-node@0.2.5-next.0
+
+## 0.1.5
+
+### Patch Changes
+
+- a5de745ac17: Renamed `gerritEventRouterEventsModule` to `eventsModuleGerritEventRouter` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/plugin-events-node@0.2.4
+
## 0.1.5-next.2
### Patch Changes
diff --git a/plugins/events-backend-module-gerrit/package.json b/plugins/events-backend-module-gerrit/package.json
index de5d104781..95612d2aab 100644
--- a/plugins/events-backend-module-gerrit/package.json
+++ b/plugins/events-backend-module-gerrit/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-events-backend-module-gerrit",
- "version": "0.1.5-next.2",
+ "version": "0.1.6-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/events-backend-module-github/CHANGELOG.md b/plugins/events-backend-module-github/CHANGELOG.md
index b531c5db52..d281e432df 100644
--- a/plugins/events-backend-module-github/CHANGELOG.md
+++ b/plugins/events-backend-module-github/CHANGELOG.md
@@ -1,5 +1,25 @@
# @backstage/plugin-events-backend-module-github
+## 0.1.6-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/config@1.0.7
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/plugin-events-node@0.2.5-next.0
+
+## 0.1.5
+
+### Patch Changes
+
+- a5de745ac17: Renamed `githubEventRouterEventsModule` to `eventsModuleGithubEventRouter` and `githubWebhookEventsModule` to `eventsModuleGithubWebhook`, to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/plugin-events-node@0.2.4
+ - @backstage/config@1.0.7
+
## 0.1.5-next.2
### Patch Changes
diff --git a/plugins/events-backend-module-github/package.json b/plugins/events-backend-module-github/package.json
index 4a010f5841..7ec3660013 100644
--- a/plugins/events-backend-module-github/package.json
+++ b/plugins/events-backend-module-github/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-events-backend-module-github",
- "version": "0.1.5-next.2",
+ "version": "0.1.6-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/events-backend-module-gitlab/CHANGELOG.md b/plugins/events-backend-module-gitlab/CHANGELOG.md
index f992585219..9a47340948 100644
--- a/plugins/events-backend-module-gitlab/CHANGELOG.md
+++ b/plugins/events-backend-module-gitlab/CHANGELOG.md
@@ -1,5 +1,25 @@
# @backstage/plugin-events-backend-module-gitlab
+## 0.1.6-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/config@1.0.7
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/plugin-events-node@0.2.5-next.0
+
+## 0.1.5
+
+### Patch Changes
+
+- a5de745ac17: Renamed `gitlabEventRouterEventsModule` to `eventsModuleGitlabEventRouter` and `gitlabWebhookEventsModule` to `eventsModuleGitlabWebhook` to match the [recommended naming patterns](https://backstage.io/docs/backend-system/architecture/naming-patterns).
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/plugin-events-node@0.2.4
+ - @backstage/config@1.0.7
+
## 0.1.5-next.2
### Patch Changes
diff --git a/plugins/events-backend-module-gitlab/package.json b/plugins/events-backend-module-gitlab/package.json
index 917f9fdb89..3729fa4f24 100644
--- a/plugins/events-backend-module-gitlab/package.json
+++ b/plugins/events-backend-module-gitlab/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-events-backend-module-gitlab",
- "version": "0.1.5-next.2",
+ "version": "0.1.6-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/events-backend-test-utils/CHANGELOG.md b/plugins/events-backend-test-utils/CHANGELOG.md
index aaf14aa68b..04e373d809 100644
--- a/plugins/events-backend-test-utils/CHANGELOG.md
+++ b/plugins/events-backend-test-utils/CHANGELOG.md
@@ -1,5 +1,19 @@
# @backstage/plugin-events-backend-test-utils
+## 0.1.6-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-events-node@0.2.5-next.0
+
+## 0.1.5
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-events-node@0.2.4
+
## 0.1.5-next.2
### Patch Changes
diff --git a/plugins/events-backend-test-utils/package.json b/plugins/events-backend-test-utils/package.json
index 67d6671497..6f7ec7c54d 100644
--- a/plugins/events-backend-test-utils/package.json
+++ b/plugins/events-backend-test-utils/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-events-backend-test-utils",
"description": "The plugin-events-backend-test-utils for @backstage/plugin-events-node",
- "version": "0.1.5-next.2",
+ "version": "0.1.6-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/events-backend/CHANGELOG.md b/plugins/events-backend/CHANGELOG.md
index 82fb0c6fc1..af29213c08 100644
--- a/plugins/events-backend/CHANGELOG.md
+++ b/plugins/events-backend/CHANGELOG.md
@@ -1,5 +1,27 @@
# @backstage/plugin-events-backend
+## 0.2.5-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/plugin-events-node@0.2.5-next.0
+
+## 0.2.4
+
+### Patch Changes
+
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- a5de745ac17: Updated README instructions
+- Updated dependencies
+ - @backstage/backend-common@0.18.3
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/plugin-events-node@0.2.4
+ - @backstage/config@1.0.7
+
## 0.2.4-next.2
### Patch Changes
diff --git a/plugins/events-backend/package.json b/plugins/events-backend/package.json
index 4a51e56b6a..7fda105e15 100644
--- a/plugins/events-backend/package.json
+++ b/plugins/events-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-events-backend",
- "version": "0.2.4-next.2",
+ "version": "0.2.5-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/events-node/CHANGELOG.md b/plugins/events-node/CHANGELOG.md
index a19d9badc2..955ad8c4e0 100644
--- a/plugins/events-node/CHANGELOG.md
+++ b/plugins/events-node/CHANGELOG.md
@@ -1,5 +1,20 @@
# @backstage/plugin-events-node
+## 0.2.5-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.5.1-next.0
+
+## 0.2.4
+
+### Patch Changes
+
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.5.0
+
## 0.2.4-next.2
### Patch Changes
diff --git a/plugins/events-node/package.json b/plugins/events-node/package.json
index 76eb1b2bf3..930cd439e3 100644
--- a/plugins/events-node/package.json
+++ b/plugins/events-node/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-events-node",
"description": "The plugin-events-node module for @backstage/plugin-events-backend",
- "version": "0.2.4-next.2",
+ "version": "0.2.5-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/example-todo-list-backend/CHANGELOG.md b/plugins/example-todo-list-backend/CHANGELOG.md
index edde9b9d54..c0fd1fcb21 100644
--- a/plugins/example-todo-list-backend/CHANGELOG.md
+++ b/plugins/example-todo-list-backend/CHANGELOG.md
@@ -1,5 +1,27 @@
# @internal/plugin-todo-list-backend
+## 1.0.12-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-auth-node@0.2.13-next.0
+
+## 1.0.11
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.2.12
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/config@1.0.7
+
## 1.0.11-next.2
### Patch Changes
diff --git a/plugins/example-todo-list-backend/package.json b/plugins/example-todo-list-backend/package.json
index 5579f748b2..d5a4a116e0 100644
--- a/plugins/example-todo-list-backend/package.json
+++ b/plugins/example-todo-list-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@internal/plugin-todo-list-backend",
- "version": "1.0.11-next.2",
+ "version": "1.0.12-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/example-todo-list-common/CHANGELOG.md b/plugins/example-todo-list-common/CHANGELOG.md
index 2596387d2d..40909ff841 100644
--- a/plugins/example-todo-list-common/CHANGELOG.md
+++ b/plugins/example-todo-list-common/CHANGELOG.md
@@ -1,5 +1,12 @@
# @internal/plugin-todo-list-common
+## 1.0.9
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-permission-common@0.7.4
+
## 1.0.9-next.0
### Patch Changes
diff --git a/plugins/example-todo-list-common/package.json b/plugins/example-todo-list-common/package.json
index 5463a19348..7c48939e8b 100644
--- a/plugins/example-todo-list-common/package.json
+++ b/plugins/example-todo-list-common/package.json
@@ -1,6 +1,6 @@
{
"name": "@internal/plugin-todo-list-common",
- "version": "1.0.9-next.0",
+ "version": "1.0.9",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/example-todo-list/CHANGELOG.md b/plugins/example-todo-list/CHANGELOG.md
index 4739ab303e..87fc367b86 100644
--- a/plugins/example-todo-list/CHANGELOG.md
+++ b/plugins/example-todo-list/CHANGELOG.md
@@ -1,5 +1,23 @@
# @internal/plugin-todo-list
+## 1.0.12-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/theme@0.2.18
+
+## 1.0.11
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/theme@0.2.18
+
## 1.0.11-next.2
### Patch Changes
diff --git a/plugins/example-todo-list/package.json b/plugins/example-todo-list/package.json
index a7366ce36f..27e05d7144 100644
--- a/plugins/example-todo-list/package.json
+++ b/plugins/example-todo-list/package.json
@@ -1,6 +1,6 @@
{
"name": "@internal/plugin-todo-list",
- "version": "1.0.11-next.2",
+ "version": "1.0.12-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -28,7 +28,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"react-use": "^17.2.4"
},
"peerDependencies": {
diff --git a/plugins/explore-backend/CHANGELOG.md b/plugins/explore-backend/CHANGELOG.md
index 7874062954..950430d91f 100644
--- a/plugins/explore-backend/CHANGELOG.md
+++ b/plugins/explore-backend/CHANGELOG.md
@@ -1,5 +1,26 @@
# @backstage/plugin-explore-backend
+## 0.0.6-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/plugin-explore-common@0.0.1
+ - @backstage/plugin-search-common@1.2.2
+
+## 0.0.5
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/backend-common@0.18.3
+ - @backstage/config@1.0.7
+ - @backstage/plugin-explore-common@0.0.1
+ - @backstage/plugin-search-common@1.2.2
+
## 0.0.5-next.2
### Patch Changes
diff --git a/plugins/explore-backend/api-report.md b/plugins/explore-backend/api-report.md
index cc112ed3cc..e3933e350b 100644
--- a/plugins/explore-backend/api-report.md
+++ b/plugins/explore-backend/api-report.md
@@ -3,18 +3,14 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
-/// ;
@@ -40,27 +36,13 @@ export class StaticExploreToolProvider implements ExploreToolProvider {
getTools(request: GetExploreToolsRequest): Promise;
}
-// @public
-export interface ToolDocument extends IndexableDocument, ExploreTool {}
+// @public @deprecated (undocumented)
+export type ToolDocument = ToolDocument_2;
-// @public
-export class ToolDocumentCollatorFactory implements DocumentCollatorFactory {
- // (undocumented)
- execute(): AsyncGenerator;
- // (undocumented)
- static fromConfig(
- _config: Config,
- options: ToolDocumentCollatorFactoryOptions,
- ): ToolDocumentCollatorFactory;
- // (undocumented)
- getCollator(): Promise;
- // (undocumented)
- readonly type: string;
-}
+// @public @deprecated (undocumented)
+export const ToolDocumentCollatorFactory: typeof ToolDocumentCollatorFactory_2;
-// @public
-export type ToolDocumentCollatorFactoryOptions = {
- discovery: PluginEndpointDiscovery;
- logger: Logger;
-};
+// @public @deprecated (undocumented)
+export type ToolDocumentCollatorFactoryOptions =
+ ToolDocumentCollatorFactoryOptions_2;
```
diff --git a/plugins/explore-backend/package.json b/plugins/explore-backend/package.json
index dbdab19329..30ab27bf07 100644
--- a/plugins/explore-backend/package.json
+++ b/plugins/explore-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-explore-backend",
- "version": "0.0.5-next.2",
+ "version": "0.0.6-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -25,6 +25,7 @@
"@backstage/backend-common": "workspace:^",
"@backstage/config": "workspace:^",
"@backstage/plugin-explore-common": "workspace:^",
+ "@backstage/plugin-search-backend-module-explore": "workspace:^",
"@backstage/plugin-search-common": "workspace:^",
"@types/express": "*",
"express": "^4.18.1",
diff --git a/plugins/explore-backend/src/index.ts b/plugins/explore-backend/src/index.ts
index a0e7216621..ca501db96b 100644
--- a/plugins/explore-backend/src/index.ts
+++ b/plugins/explore-backend/src/index.ts
@@ -20,7 +20,6 @@
* @packageDocumentation
*/
-export * from './search';
export * from './service';
export * from './tools';
@@ -28,3 +27,28 @@ export * from './tools';
* @internal Example only - do not use in production
*/
export { exampleTools } from './example/exampleTools';
+
+import { ToolDocumentCollatorFactory as _ToolDocumentCollatorFactory } from '@backstage/plugin-search-backend-module-explore';
+import type {
+ ToolDocument as _ToolDocument,
+ ToolDocumentCollatorFactoryOptions as _ToolDocumentCollatorFactoryOptions,
+} from '@backstage/plugin-search-backend-module-explore';
+
+/**
+ * @public
+ * @deprecated import from `@backstage/search-backend-module-explore` instead
+ */
+export const ToolDocumentCollatorFactory = _ToolDocumentCollatorFactory;
+
+/**
+ * @public
+ * @deprecated import from `@backstage/search-backend-module-explore` instead
+ */
+export type ToolDocument = _ToolDocument;
+
+/**
+ * @public
+ * @deprecated import from `@backstage/search-backend-module-explore` instead
+ */
+export type ToolDocumentCollatorFactoryOptions =
+ _ToolDocumentCollatorFactoryOptions;
diff --git a/plugins/explore-react/CHANGELOG.md b/plugins/explore-react/CHANGELOG.md
index 1f68752e6e..954492e81e 100644
--- a/plugins/explore-react/CHANGELOG.md
+++ b/plugins/explore-react/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/plugin-explore-react
+## 0.0.27
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/plugin-explore-common@0.0.1
+
## 0.0.27-next.2
### Patch Changes
diff --git a/plugins/explore-react/package.json b/plugins/explore-react/package.json
index 6bb7ad5f0a..fbbde21b0f 100644
--- a/plugins/explore-react/package.json
+++ b/plugins/explore-react/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-explore-react",
"description": "A frontend library for Backstage plugins that want to interact with the explore plugin",
- "version": "0.0.27-next.2",
+ "version": "0.0.27",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/explore/CHANGELOG.md b/plugins/explore/CHANGELOG.md
index 72d93cf927..f5cbde7200 100644
--- a/plugins/explore/CHANGELOG.md
+++ b/plugins/explore/CHANGELOG.md
@@ -1,5 +1,43 @@
# @backstage/plugin-explore
+## 0.4.2-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-search-react@1.5.2-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/plugin-explore-react@0.0.27
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-explore-common@0.0.1
+ - @backstage/plugin-search-common@1.2.2
+
+## 0.4.1
+
+### Patch Changes
+
+- 65454876fb2: Minor API report tweaks
+- cb8ec97cdeb: Change black & white colors to be theme aware
+- c10384a9235: Switch to using `LinkButton` instead of the deprecated `Button`
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- 3f75b7607ca: Add ability to pass icon as function to have ability to customize it by search item
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/plugin-search-react@1.5.1
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-explore-react@0.0.27
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-explore-common@0.0.1
+ - @backstage/plugin-search-common@1.2.2
+
## 0.4.1-next.2
### Patch Changes
diff --git a/plugins/explore/package.json b/plugins/explore/package.json
index c91671c816..eb5e1da5b3 100644
--- a/plugins/explore/package.json
+++ b/plugins/explore/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-explore",
"description": "A Backstage plugin for building an exploration page of your software ecosystem",
- "version": "0.4.1-next.2",
+ "version": "0.4.2-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -44,7 +44,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"classnames": "^2.2.6",
"react-use": "^17.2.4"
},
diff --git a/plugins/firehydrant/CHANGELOG.md b/plugins/firehydrant/CHANGELOG.md
index 1fbf09d8d4..50440aba5d 100644
--- a/plugins/firehydrant/CHANGELOG.md
+++ b/plugins/firehydrant/CHANGELOG.md
@@ -1,5 +1,34 @@
# @backstage/plugin-firehydrant
+## 0.2.1-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.2.0
+
+### Minor Changes
+
+- e2e3dd08a54: Allow firehydrant to use component annotation
+
+### Patch Changes
+
+- cb8ec97cdeb: Change black & white colors to be theme aware
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.1.33-next.2
### Patch Changes
diff --git a/plugins/firehydrant/README.md b/plugins/firehydrant/README.md
index d7169e08f0..4472536245 100644
--- a/plugins/firehydrant/README.md
+++ b/plugins/firehydrant/README.md
@@ -56,3 +56,11 @@ proxy:
# Supply the token you generated from https://app.firehydrant.io/organizations/bots
Authorization: Bearer fhb-e4911b22bcd788c4a4afeb0c111ffbfa
```
+
+4. Optionally add an annotation to the yaml config file of a component
+
+```yaml
+metadata:
+ annotations:
+ firehydrant.com/service-name:
+```
diff --git a/plugins/firehydrant/api-report.md b/plugins/firehydrant/api-report.md
index 2e3bcf6385..0ff5bbc62a 100644
--- a/plugins/firehydrant/api-report.md
+++ b/plugins/firehydrant/api-report.md
@@ -6,6 +6,7 @@
/// ;
getServiceIncidents(options: {
@@ -77,11 +78,13 @@ export class FireHydrantAPIClient implements FireHydrantAPI {
async getServiceDetails(options: {
serviceName: string;
+ lookupByName: boolean;
}): Promise {
+ const queryOpt = options.lookupByName ? 'name' : 'query';
+ const query = new URLSearchParams();
+ query.set(queryOpt, options.serviceName);
const proxyUrl = await this.getApiUrl();
- const response = await fetch(
- `${proxyUrl}/services?query=${options.serviceName}`,
- );
+ const response = await fetch(`${proxyUrl}/services?${query}`);
if (!response.ok) {
throw new Error(
diff --git a/plugins/firehydrant/src/components/ServiceDetailsCard/ServiceDetailsCard.test.tsx b/plugins/firehydrant/src/components/ServiceDetailsCard/ServiceDetailsCard.test.tsx
index 20dbb77e86..ce2b1f5391 100644
--- a/plugins/firehydrant/src/components/ServiceDetailsCard/ServiceDetailsCard.test.tsx
+++ b/plugins/firehydrant/src/components/ServiceDetailsCard/ServiceDetailsCard.test.tsx
@@ -30,7 +30,9 @@ const apis = TestApiRegistry.from([fireHydrantApiRef, mockFireHydrantApi]);
jest.mock('@backstage/plugin-catalog-react', () => ({
useEntity: () => {
- return { entity: { metadata: { name: 'service-example' } } };
+ return {
+ entity: { kind: 'Component', metadata: { name: 'service-example' } },
+ };
},
}));
diff --git a/plugins/firehydrant/src/components/ServiceDetailsCard/ServiceDetailsCard.tsx b/plugins/firehydrant/src/components/ServiceDetailsCard/ServiceDetailsCard.tsx
index bc2dd46fef..b6bfbcc13b 100644
--- a/plugins/firehydrant/src/components/ServiceDetailsCard/ServiceDetailsCard.tsx
+++ b/plugins/firehydrant/src/components/ServiceDetailsCard/ServiceDetailsCard.tsx
@@ -39,6 +39,7 @@ import {
ResponseErrorPanel,
} from '@backstage/core-components';
import { configApiRef, useApi } from '@backstage/core-plugin-api';
+import { isFireHydrantAvailable, getFireHydrantServiceName } from '../hooks';
const useStyles = makeStyles(theme => ({
button: {
@@ -149,14 +150,14 @@ export const ServiceDetailsCard = () => {
const startDate = DateTime.now().minus({ days: 30 }).toUTC();
const endDate = DateTime.now().toUTC();
+ // The service name is provided by an annotation or a Backstage generated service name.
// The Backstage service name in FireHydrant is a unique formatted string
// that requires the entity's kind, name, and namespace.
- const fireHydrantServiceName = `${entity?.kind}:${
- entity?.metadata?.namespace ?? 'default'
- }/${entity?.metadata?.name}`;
+ const fireHydrantServiceName = getFireHydrantServiceName(entity);
const { loading, value, error } = useServiceDetails({
serviceName: fireHydrantServiceName,
+ lookupByName: isFireHydrantAvailable(entity),
});
const activeIncidents: string[] = value?.service?.active_incidents ?? [];
diff --git a/plugins/firehydrant/src/components/hooks.test.ts b/plugins/firehydrant/src/components/hooks.test.ts
new file mode 100644
index 0000000000..f35d6774ce
--- /dev/null
+++ b/plugins/firehydrant/src/components/hooks.test.ts
@@ -0,0 +1,78 @@
+/*
+ * 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 { isFireHydrantAvailable, getFireHydrantServiceName } from './hooks';
+
+describe('firehydrant-hooks-isFireHydrantAvailable', () => {
+ it('should find an annotation', () => {
+ const e: Entity = {
+ apiVersion: 'backstage.io/v1alpha1',
+ kind: 'Component',
+ metadata: {
+ namespace: 'default',
+ name: 'test-fh-name',
+ annotations: {
+ 'firehydrant.com/service-name': 'test-fh-name',
+ },
+ },
+ };
+ expect(isFireHydrantAvailable(e)).toEqual(true);
+ });
+
+ it('should not find an annotation', () => {
+ const e: Entity = {
+ apiVersion: 'backstage.io/v1alpha1',
+ kind: 'Component',
+ metadata: {
+ namespace: 'default',
+ name: 'test-fh-name',
+ },
+ };
+ expect(isFireHydrantAvailable(e)).toEqual(false);
+ });
+});
+
+describe('firehydrant-hooks-getFireHydrantServiceName', () => {
+ it('should return annotation service name', () => {
+ const expected = 'test-fh-name';
+ const e: Entity = {
+ apiVersion: 'backstage.io/v1alpha1',
+ kind: 'Component',
+ metadata: {
+ namespace: 'default',
+ name: 'test-fh-name',
+ annotations: {
+ 'firehydrant.com/service-name': expected,
+ },
+ },
+ };
+ expect(getFireHydrantServiceName(e)).toEqual(expected);
+ });
+
+ it('should return generated service name', () => {
+ const expected = 'component:default/test-fh-name';
+ const e: Entity = {
+ apiVersion: 'backstage.io/v1alpha1',
+ kind: 'Component',
+ metadata: {
+ namespace: 'default',
+ name: 'test-fh-name',
+ annotations: {},
+ },
+ };
+ expect(getFireHydrantServiceName(e)).toEqual(expected);
+ });
+});
diff --git a/plugins/firehydrant/src/components/hooks.ts b/plugins/firehydrant/src/components/hooks.ts
new file mode 100644
index 0000000000..c4055b1724
--- /dev/null
+++ b/plugins/firehydrant/src/components/hooks.ts
@@ -0,0 +1,25 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Entity, stringifyEntityRef } from '@backstage/catalog-model';
+
+export const FIREHYDRANT_SERVICE_NAME_ANNOTATION =
+ 'firehydrant.com/service-name';
+/** @public */
+export const isFireHydrantAvailable = (entity: Entity) =>
+ Boolean(entity.metadata.annotations?.[FIREHYDRANT_SERVICE_NAME_ANNOTATION]);
+export const getFireHydrantServiceName = (entity: Entity) =>
+ entity?.metadata.annotations?.[FIREHYDRANT_SERVICE_NAME_ANNOTATION] ??
+ stringifyEntityRef(entity);
diff --git a/plugins/firehydrant/src/components/serviceDetails.ts b/plugins/firehydrant/src/components/serviceDetails.ts
index 9c12677577..f0ea325419 100644
--- a/plugins/firehydrant/src/components/serviceDetails.ts
+++ b/plugins/firehydrant/src/components/serviceDetails.ts
@@ -17,13 +17,22 @@ import useAsyncRetry from 'react-use/lib/useAsyncRetry';
import { fireHydrantApiRef } from '../api';
import { errorApiRef, useApi } from '@backstage/core-plugin-api';
-export const useServiceDetails = ({ serviceName }: { serviceName: string }) => {
+export const useServiceDetails = ({
+ serviceName,
+ lookupByName,
+}: {
+ serviceName: string;
+ lookupByName: boolean;
+}) => {
const api = useApi(fireHydrantApiRef);
const errorApi = useApi(errorApiRef);
const { loading, value, error, retry } = useAsyncRetry(async () => {
try {
- return await api.getServiceDetails({ serviceName: serviceName });
+ return await api.getServiceDetails({
+ serviceName: serviceName,
+ lookupByName: lookupByName,
+ });
} catch (e) {
errorApi.post(e);
return Promise.reject(e);
diff --git a/plugins/firehydrant/src/index.ts b/plugins/firehydrant/src/index.ts
index f1ef66fd3e..218b944244 100644
--- a/plugins/firehydrant/src/index.ts
+++ b/plugins/firehydrant/src/index.ts
@@ -20,4 +20,8 @@
* @packageDocumentation
*/
-export { firehydrantPlugin, FirehydrantCard } from './plugin';
+export {
+ firehydrantPlugin,
+ FirehydrantCard,
+ isFireHydrantAvailable,
+} from './plugin';
diff --git a/plugins/firehydrant/src/plugin.ts b/plugins/firehydrant/src/plugin.ts
index 6deefe4fce..14a8c53c66 100644
--- a/plugins/firehydrant/src/plugin.ts
+++ b/plugins/firehydrant/src/plugin.ts
@@ -50,3 +50,6 @@ export const FirehydrantCard = firehydrantPlugin.provide(
},
}),
);
+
+/** @public */
+export { isFireHydrantAvailable } from './components/hooks';
diff --git a/plugins/fossa/CHANGELOG.md b/plugins/fossa/CHANGELOG.md
index af439b6fd0..3cb8c21d6c 100644
--- a/plugins/fossa/CHANGELOG.md
+++ b/plugins/fossa/CHANGELOG.md
@@ -1,5 +1,31 @@
# @backstage/plugin-fossa
+## 0.2.49-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+
+## 0.2.48
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.2.48-next.2
### Patch Changes
diff --git a/plugins/fossa/package.json b/plugins/fossa/package.json
index 1135c76bb1..f7d14a79aa 100644
--- a/plugins/fossa/package.json
+++ b/plugins/fossa/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-fossa",
"description": "A Backstage plugin that integrates towards FOSSA",
- "version": "0.2.48-next.2",
+ "version": "0.2.49-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -41,7 +41,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"cross-fetch": "^3.1.5",
"luxon": "^3.0.0",
"p-limit": "^3.0.2",
diff --git a/plugins/gcalendar/CHANGELOG.md b/plugins/gcalendar/CHANGELOG.md
index 2460deb73c..e13f9f04eb 100644
--- a/plugins/gcalendar/CHANGELOG.md
+++ b/plugins/gcalendar/CHANGELOG.md
@@ -1,5 +1,28 @@
# @backstage/plugin-gcalendar
+## 0.3.13-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+
+## 0.3.12
+
+### Patch Changes
+
+- cb8ec97cdeb: Change black & white colors to be theme aware
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/theme@0.2.18
+
## 0.3.12-next.2
### Patch Changes
diff --git a/plugins/gcalendar/package.json b/plugins/gcalendar/package.json
index 83471340b8..5a0508b41c 100644
--- a/plugins/gcalendar/package.json
+++ b/plugins/gcalendar/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-gcalendar",
- "version": "0.3.12-next.2",
+ "version": "0.3.13-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -28,7 +28,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"@maxim_mazurok/gapi.client.calendar": "^3.0.20220408",
"@tanstack/react-query": "^4.1.3",
"classnames": "^2.3.1",
diff --git a/plugins/gcp-projects/CHANGELOG.md b/plugins/gcp-projects/CHANGELOG.md
index ecb3ec60fc..b952be109f 100644
--- a/plugins/gcp-projects/CHANGELOG.md
+++ b/plugins/gcp-projects/CHANGELOG.md
@@ -1,5 +1,25 @@
# @backstage/plugin-gcp-projects
+## 0.3.36-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/theme@0.2.18
+
+## 0.3.35
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/theme@0.2.18
+
## 0.3.35-next.2
### Patch Changes
diff --git a/plugins/gcp-projects/package.json b/plugins/gcp-projects/package.json
index 1029b37cd0..516a72cbfa 100644
--- a/plugins/gcp-projects/package.json
+++ b/plugins/gcp-projects/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-gcp-projects",
"description": "A Backstage plugin that helps you manage projects in GCP",
- "version": "0.3.35-next.2",
+ "version": "0.3.36-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -38,7 +38,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"@react-hookz/web": "^20.0.0"
},
"peerDependencies": {
diff --git a/plugins/git-release-manager/CHANGELOG.md b/plugins/git-release-manager/CHANGELOG.md
index c97568b076..34e2e430ae 100644
--- a/plugins/git-release-manager/CHANGELOG.md
+++ b/plugins/git-release-manager/CHANGELOG.md
@@ -1,5 +1,28 @@
# @backstage/plugin-git-release-manager
+## 0.3.30-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/integration@1.4.3
+ - @backstage/theme@0.2.18
+
+## 0.3.29
+
+### Patch Changes
+
+- cb8ec97cdeb: Change black & white colors to be theme aware
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/integration@1.4.3
+ - @backstage/theme@0.2.18
+
## 0.3.29-next.2
### Patch Changes
diff --git a/plugins/git-release-manager/package.json b/plugins/git-release-manager/package.json
index 0c9507bc24..b43ee73925 100644
--- a/plugins/git-release-manager/package.json
+++ b/plugins/git-release-manager/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-git-release-manager",
"description": "A Backstage plugin that helps you manage releases in git",
- "version": "0.3.29-next.2",
+ "version": "0.3.30-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -29,7 +29,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"@octokit/rest": "^19.0.3",
"luxon": "^3.0.0",
"qs": "^6.10.1",
diff --git a/plugins/github-actions/CHANGELOG.md b/plugins/github-actions/CHANGELOG.md
index ffec353673..df186ba39d 100644
--- a/plugins/github-actions/CHANGELOG.md
+++ b/plugins/github-actions/CHANGELOG.md
@@ -1,5 +1,31 @@
# @backstage/plugin-github-actions
+## 0.5.17-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/integration@1.4.3
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.5.16
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/integration@1.4.3
+ - @backstage/theme@0.2.18
+
## 0.5.16-next.2
### Patch Changes
diff --git a/plugins/github-actions/package.json b/plugins/github-actions/package.json
index d26249218e..78c0f5096a 100644
--- a/plugins/github-actions/package.json
+++ b/plugins/github-actions/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-github-actions",
"description": "A Backstage plugin that integrates towards GitHub Actions",
- "version": "0.5.16-next.2",
+ "version": "0.5.17-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -42,7 +42,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"@octokit/rest": "^19.0.3",
"luxon": "^3.0.0",
"react-use": "^17.2.4"
diff --git a/plugins/github-deployments/CHANGELOG.md b/plugins/github-deployments/CHANGELOG.md
index cc8c6a838e..47f7e4d86b 100644
--- a/plugins/github-deployments/CHANGELOG.md
+++ b/plugins/github-deployments/CHANGELOG.md
@@ -1,5 +1,35 @@
# @backstage/plugin-github-deployments
+## 0.1.48-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/integration-react@1.1.12-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/integration@1.4.3
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+
+## 0.1.47
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/integration-react@1.1.11
+ - @backstage/integration@1.4.3
+ - @backstage/theme@0.2.18
+
## 0.1.47-next.2
### Patch Changes
diff --git a/plugins/github-deployments/package.json b/plugins/github-deployments/package.json
index f9019b5029..e60e3da91a 100644
--- a/plugins/github-deployments/package.json
+++ b/plugins/github-deployments/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-github-deployments",
"description": "A Backstage plugin that integrates towards GitHub Deployments",
- "version": "0.1.47-next.2",
+ "version": "0.1.48-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -33,7 +33,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"@octokit/graphql": "^5.0.0",
"luxon": "^3.0.0",
"react-use": "^17.2.4"
diff --git a/plugins/github-issues/CHANGELOG.md b/plugins/github-issues/CHANGELOG.md
index 5a440a28f3..affbf603a6 100644
--- a/plugins/github-issues/CHANGELOG.md
+++ b/plugins/github-issues/CHANGELOG.md
@@ -1,5 +1,32 @@
# @backstage/plugin-github-issues
+## 0.2.6-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/integration@1.4.3
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+
+## 0.2.5
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/integration@1.4.3
+ - @backstage/theme@0.2.18
+
## 0.2.5-next.2
### Patch Changes
diff --git a/plugins/github-issues/package.json b/plugins/github-issues/package.json
index 83e457a606..cac335d9e3 100644
--- a/plugins/github-issues/package.json
+++ b/plugins/github-issues/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-github-issues",
- "version": "0.2.5-next.2",
+ "version": "0.2.6-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -31,7 +31,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.4",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "^4.0.0-alpha.61",
+ "@material-ui/lab": "4.0.0-alpha.61",
"luxon": "^3.0.0",
"octokit": "^2.0.4",
"react-use": "^17.4.0"
diff --git a/plugins/github-pull-requests-board/CHANGELOG.md b/plugins/github-pull-requests-board/CHANGELOG.md
index ae15428eed..681552a571 100644
--- a/plugins/github-pull-requests-board/CHANGELOG.md
+++ b/plugins/github-pull-requests-board/CHANGELOG.md
@@ -1,5 +1,31 @@
# @backstage/plugin-github-pull-requests-board
+## 0.1.11-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/integration@1.4.3
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.1.10
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/integration@1.4.3
+ - @backstage/theme@0.2.18
+
## 0.1.10-next.2
### Patch Changes
diff --git a/plugins/github-pull-requests-board/package.json b/plugins/github-pull-requests-board/package.json
index ff5393988b..1792a6e98c 100644
--- a/plugins/github-pull-requests-board/package.json
+++ b/plugins/github-pull-requests-board/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-github-pull-requests-board",
"description": "A Backstage plugin that allows you to see all open Pull Requests for all the repositories owned by your team",
- "version": "0.1.10-next.2",
+ "version": "0.1.11-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -42,7 +42,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"@octokit/rest": "^19.0.3",
"luxon": "^3.0.0",
"p-limit": "^4.0.0",
diff --git a/plugins/gitops-profiles/CHANGELOG.md b/plugins/gitops-profiles/CHANGELOG.md
index 8522e1e16c..6201080830 100644
--- a/plugins/gitops-profiles/CHANGELOG.md
+++ b/plugins/gitops-profiles/CHANGELOG.md
@@ -1,5 +1,26 @@
# @backstage/plugin-gitops-profiles
+## 0.3.35-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/theme@0.2.18
+
+## 0.3.34
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/theme@0.2.18
+
## 0.3.34-next.2
### Patch Changes
diff --git a/plugins/gitops-profiles/package.json b/plugins/gitops-profiles/package.json
index 291b73b308..2208c6d011 100644
--- a/plugins/gitops-profiles/package.json
+++ b/plugins/gitops-profiles/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-gitops-profiles",
"description": "A Backstage plugin that helps you manage GitOps profiles",
- "version": "0.3.34-next.2",
+ "version": "0.3.35-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -33,12 +33,13 @@
"clean": "backstage-cli package clean"
},
"dependencies": {
+ "@backstage/config": "workspace:^",
"@backstage/core-components": "workspace:^",
"@backstage/core-plugin-api": "workspace:^",
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"react-use": "^17.2.4"
},
"peerDependencies": {
diff --git a/plugins/gitops-profiles/src/components/ProfileCatalog/ProfileCatalog.test.tsx b/plugins/gitops-profiles/src/components/ProfileCatalog/ProfileCatalog.test.tsx
index 5aa59a1cae..eb58e03580 100644
--- a/plugins/gitops-profiles/src/components/ProfileCatalog/ProfileCatalog.test.tsx
+++ b/plugins/gitops-profiles/src/components/ProfileCatalog/ProfileCatalog.test.tsx
@@ -14,7 +14,11 @@
* limitations under the License.
*/
-import { renderInTestApp, TestApiRegistry } from '@backstage/test-utils';
+import {
+ MockConfigApi,
+ renderInTestApp,
+ TestApiRegistry,
+} from '@backstage/test-utils';
import React from 'react';
import { gitOpsApiRef, GitOpsRestApi } from '../../api';
import ProfileCatalog from './ProfileCatalog';
@@ -31,6 +35,7 @@ import { githubAuthApiRef } from '@backstage/core-plugin-api';
describe('ProfileCatalog', () => {
it('should render', async () => {
const oauthRequestApi = new OAuthRequestManager();
+ const configApi = new MockConfigApi({});
const apis = TestApiRegistry.from(
[gitOpsApiRef, new GitOpsRestApi('http://localhost:3008')],
[
@@ -40,6 +45,7 @@ describe('ProfileCatalog', () => {
'http://example.com/{{pluginId}}',
),
oauthRequestApi,
+ configApi: configApi,
}),
],
);
diff --git a/plugins/gocd/CHANGELOG.md b/plugins/gocd/CHANGELOG.md
index 71d7aa3af0..06ca6ecca7 100644
--- a/plugins/gocd/CHANGELOG.md
+++ b/plugins/gocd/CHANGELOG.md
@@ -1,5 +1,31 @@
# @backstage/plugin-gocd
+## 0.1.23-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+
+## 0.1.22
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.1.22-next.2
### Patch Changes
diff --git a/plugins/gocd/package.json b/plugins/gocd/package.json
index f9789ffde4..a8e2599f3b 100644
--- a/plugins/gocd/package.json
+++ b/plugins/gocd/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-gocd",
"description": "A Backstage plugin that integrates towards GoCD",
- "version": "0.1.22-next.2",
+ "version": "0.1.23-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -37,7 +37,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"lodash": "^4.17.21",
"luxon": "^3.0.0",
"qs": "^6.10.1",
diff --git a/plugins/graphiql/CHANGELOG.md b/plugins/graphiql/CHANGELOG.md
index f110d7b813..816962b034 100644
--- a/plugins/graphiql/CHANGELOG.md
+++ b/plugins/graphiql/CHANGELOG.md
@@ -1,5 +1,25 @@
# @backstage/plugin-graphiql
+## 0.2.49-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/theme@0.2.18
+
+## 0.2.48
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/theme@0.2.18
+
## 0.2.48-next.2
### Patch Changes
diff --git a/plugins/graphiql/api-report.md b/plugins/graphiql/api-report.md
index c96966c585..ea765d4d2b 100644
--- a/plugins/graphiql/api-report.md
+++ b/plugins/graphiql/api-report.md
@@ -16,7 +16,7 @@ import { RouteRef } from '@backstage/core-plugin-api';
export type EndpointConfig = {
id: string;
title: string;
- url: string;
+ url: string | Promise;
method?: 'POST';
headers?: {
[name in string]: string;
diff --git a/plugins/graphiql/package.json b/plugins/graphiql/package.json
index a608ecb8db..fcdf347ba1 100644
--- a/plugins/graphiql/package.json
+++ b/plugins/graphiql/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-graphiql",
"description": "Backstage plugin for browsing GraphQL APIs",
- "version": "0.2.48-next.2",
+ "version": "0.2.49-next.0",
"publishConfig": {
"access": "public",
"main": "dist/index.esm.js",
@@ -37,7 +37,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"graphiql": "^1.5.12",
"graphql": "^16.0.0",
"graphql-ws": "^5.4.1",
diff --git a/plugins/graphiql/src/lib/api/GraphQLEndpoints.ts b/plugins/graphiql/src/lib/api/GraphQLEndpoints.ts
index 7f9c0ca4ee..52dc40fd81 100644
--- a/plugins/graphiql/src/lib/api/GraphQLEndpoints.ts
+++ b/plugins/graphiql/src/lib/api/GraphQLEndpoints.ts
@@ -26,7 +26,7 @@ export type EndpointConfig = {
id: string;
title: string;
// Endpoint URL
- url: string;
+ url: string | Promise;
// only supports POST right now
method?: 'POST';
// Defaults to setting Content-Type to application/json
@@ -66,7 +66,7 @@ export class GraphQLEndpoints implements GraphQLBrowseApi {
...config.headers,
...options.headers,
};
- const res = await fetch(url, {
+ const res = await fetch(await url, {
method,
headers,
body,
diff --git a/plugins/graphql-backend/CHANGELOG.md b/plugins/graphql-backend/CHANGELOG.md
index 0ab0918031..1e2f5059eb 100644
--- a/plugins/graphql-backend/CHANGELOG.md
+++ b/plugins/graphql-backend/CHANGELOG.md
@@ -1,5 +1,25 @@
# @backstage/plugin-graphql-backend
+## 0.1.34-next.0
+
+### Patch Changes
+
+- e47e69eadf0: Updated dependency `@apollo/server` to `^4.0.0`.
+- Updated dependencies
+ - @backstage/plugin-catalog-graphql@0.3.20-next.0
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+
+## 0.1.33
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/backend-common@0.18.3
+ - @backstage/plugin-catalog-graphql@0.3.19
+ - @backstage/config@1.0.7
+
## 0.1.33-next.2
### Patch Changes
diff --git a/plugins/graphql-backend/package.json b/plugins/graphql-backend/package.json
index 401119b052..736c057a5b 100644
--- a/plugins/graphql-backend/package.json
+++ b/plugins/graphql-backend/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-graphql-backend",
"description": "An experimental Backstage backend plugin for GraphQL",
- "version": "0.1.33-next.2",
+ "version": "0.1.34-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -33,13 +33,12 @@
"clean": "backstage-cli package clean"
},
"dependencies": {
+ "@apollo/server": "^4.0.0",
"@backstage/backend-common": "workspace:^",
"@backstage/config": "workspace:^",
"@backstage/plugin-catalog-graphql": "workspace:^",
"@graphql-tools/schema": "^9.0.0",
"@types/express": "^4.17.6",
- "apollo-server": "^3.0.0",
- "apollo-server-express": "^3.0.0",
"express": "^4.17.1",
"express-promise-router": "^4.1.0",
"graphql": "^16.0.0",
diff --git a/plugins/graphql-backend/src/service/router.ts b/plugins/graphql-backend/src/service/router.ts
index aa83b51beb..fbddee435f 100644
--- a/plugins/graphql-backend/src/service/router.ts
+++ b/plugins/graphql-backend/src/service/router.ts
@@ -19,7 +19,8 @@ import express from 'express';
import Router from 'express-promise-router';
import { Logger } from 'winston';
import { createApplication } from 'graphql-modules';
-import { ApolloServer } from 'apollo-server-express';
+import { ApolloServer } from '@apollo/server';
+import { expressMiddleware } from '@apollo/server/express4';
import { createModule as createCatalogModule } from '@backstage/plugin-catalog-graphql';
import { Config } from '@backstage/config';
import helmet from 'helmet';
@@ -61,8 +62,6 @@ export async function createRouter(
response.json({ status: 'ok' });
});
- const apolloMiddleware = server.getMiddleware({ path: '/' });
-
if (process.env.NODE_ENV === 'development')
router.use(
helmet.contentSecurityPolicy({
@@ -72,7 +71,7 @@ export async function createRouter(
}),
);
- router.use(apolloMiddleware);
+ router.use(expressMiddleware(server));
router.use(errorHandler());
return router;
diff --git a/plugins/graphql-voyager/CHANGELOG.md b/plugins/graphql-voyager/CHANGELOG.md
index 982dfec9dc..480e859caa 100644
--- a/plugins/graphql-voyager/CHANGELOG.md
+++ b/plugins/graphql-voyager/CHANGELOG.md
@@ -1,5 +1,25 @@
# @backstage/plugin-graphql-voyager
+## 0.1.2-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/theme@0.2.18
+
+## 0.1.1
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/theme@0.2.18
+
## 0.1.1-next.2
### Patch Changes
diff --git a/plugins/graphql-voyager/package.json b/plugins/graphql-voyager/package.json
index 5d2b809bb3..deba02b6a4 100644
--- a/plugins/graphql-voyager/package.json
+++ b/plugins/graphql-voyager/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-graphql-voyager",
"description": "Backstage plugin for GraphQL Voyager",
- "version": "0.1.1-next.2",
+ "version": "0.1.2-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -28,7 +28,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"graphql-voyager": "^1.0.0-rc.31",
"react-use": "^17.2.4"
},
diff --git a/plugins/home/CHANGELOG.md b/plugins/home/CHANGELOG.md
index 51552a0135..0c1e662fef 100644
--- a/plugins/home/CHANGELOG.md
+++ b/plugins/home/CHANGELOG.md
@@ -1,5 +1,31 @@
# @backstage/plugin-home
+## 0.4.33-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.4.32
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/config@1.0.7
+ - @backstage/theme@0.2.18
+
## 0.4.32-next.2
### Patch Changes
diff --git a/plugins/home/package.json b/plugins/home/package.json
index 2957625478..767ed33557 100644
--- a/plugins/home/package.json
+++ b/plugins/home/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-home",
"description": "A Backstage plugin that helps you build a home page",
- "version": "0.4.32-next.2",
+ "version": "0.4.33-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -41,7 +41,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"lodash": "^4.17.21",
"react-use": "^17.2.4"
},
diff --git a/plugins/ilert/CHANGELOG.md b/plugins/ilert/CHANGELOG.md
index e3d63efd71..ae6e292c85 100644
--- a/plugins/ilert/CHANGELOG.md
+++ b/plugins/ilert/CHANGELOG.md
@@ -1,5 +1,32 @@
# @backstage/plugin-ilert
+## 0.2.6-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+
+## 0.2.5
+
+### Patch Changes
+
+- cb8ec97cdeb: Change black & white colors to be theme aware
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.2.5-next.2
### Patch Changes
diff --git a/plugins/ilert/package.json b/plugins/ilert/package.json
index cc8183d6cb..67573d1e3a 100644
--- a/plugins/ilert/package.json
+++ b/plugins/ilert/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-ilert",
"description": "A Backstage plugin that integrates towards iLert",
- "version": "0.2.5-next.2",
+ "version": "0.2.6-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -32,7 +32,7 @@
"@date-io/luxon": "1.x",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"@material-ui/pickers": "^3.3.10",
"humanize-duration": "^3.26.0",
"luxon": "^3.0.0",
diff --git a/plugins/jenkins-backend/CHANGELOG.md b/plugins/jenkins-backend/CHANGELOG.md
index f18f75d0a4..0655d6c189 100644
--- a/plugins/jenkins-backend/CHANGELOG.md
+++ b/plugins/jenkins-backend/CHANGELOG.md
@@ -1,5 +1,34 @@
# @backstage/plugin-jenkins-backend
+## 0.1.34-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-auth-node@0.2.13-next.0
+ - @backstage/plugin-jenkins-common@0.1.14
+ - @backstage/plugin-permission-common@0.7.4
+
+## 0.1.33
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/plugin-auth-node@0.2.12
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-jenkins-common@0.1.14
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/config@1.0.7
+
## 0.1.33-next.2
### Patch Changes
diff --git a/plugins/jenkins-backend/package.json b/plugins/jenkins-backend/package.json
index daf5073792..54375b6f30 100644
--- a/plugins/jenkins-backend/package.json
+++ b/plugins/jenkins-backend/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-jenkins-backend",
"description": "A Backstage backend plugin that integrates towards Jenkins",
- "version": "0.1.33-next.2",
+ "version": "0.1.34-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/jenkins-common/CHANGELOG.md b/plugins/jenkins-common/CHANGELOG.md
index 820a600fc1..73be4b306c 100644
--- a/plugins/jenkins-common/CHANGELOG.md
+++ b/plugins/jenkins-common/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/plugin-jenkins-common
+## 0.1.14
+
+### Patch Changes
+
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- Updated dependencies
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/plugin-permission-common@0.7.4
+
## 0.1.14-next.1
### Patch Changes
diff --git a/plugins/jenkins-common/package.json b/plugins/jenkins-common/package.json
index 8786afd22c..04cc34b48d 100644
--- a/plugins/jenkins-common/package.json
+++ b/plugins/jenkins-common/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-jenkins-common",
- "version": "0.1.14-next.1",
+ "version": "0.1.14",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/jenkins/CHANGELOG.md b/plugins/jenkins/CHANGELOG.md
index fe8f1e2d13..97bfce2e07 100644
--- a/plugins/jenkins/CHANGELOG.md
+++ b/plugins/jenkins/CHANGELOG.md
@@ -1,5 +1,34 @@
# @backstage/plugin-jenkins
+## 0.7.16-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-jenkins-common@0.1.14
+
+## 0.7.15
+
+### Patch Changes
+
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-jenkins-common@0.1.14
+ - @backstage/theme@0.2.18
+
## 0.7.15-next.2
### Patch Changes
diff --git a/plugins/jenkins/package.json b/plugins/jenkins/package.json
index 204d88db60..23bbcfedcd 100644
--- a/plugins/jenkins/package.json
+++ b/plugins/jenkins/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-jenkins",
"description": "A Backstage plugin that integrates towards Jenkins",
- "version": "0.7.15-next.2",
+ "version": "0.7.16-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -42,7 +42,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"luxon": "^3.0.0",
"react-use": "^17.2.4"
},
diff --git a/plugins/kafka-backend/CHANGELOG.md b/plugins/kafka-backend/CHANGELOG.md
index 92bcf3de3f..d844d8339b 100644
--- a/plugins/kafka-backend/CHANGELOG.md
+++ b/plugins/kafka-backend/CHANGELOG.md
@@ -1,5 +1,27 @@
# @backstage/plugin-kafka-backend
+## 0.2.37-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+
+## 0.2.36
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/config@1.0.7
+
## 0.2.36-next.2
### Patch Changes
diff --git a/plugins/kafka-backend/package.json b/plugins/kafka-backend/package.json
index 38b1f60fcb..d29ce0fb82 100644
--- a/plugins/kafka-backend/package.json
+++ b/plugins/kafka-backend/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-kafka-backend",
"description": "A Backstage backend plugin that integrates towards Kafka",
- "version": "0.2.36-next.2",
+ "version": "0.2.37-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/kafka/CHANGELOG.md b/plugins/kafka/CHANGELOG.md
index 1706f206e7..324b9ae111 100644
--- a/plugins/kafka/CHANGELOG.md
+++ b/plugins/kafka/CHANGELOG.md
@@ -1,5 +1,31 @@
# @backstage/plugin-kafka
+## 0.3.17-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.3.16
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/config@1.0.7
+ - @backstage/theme@0.2.18
+
## 0.3.16-next.2
### Patch Changes
diff --git a/plugins/kafka/package.json b/plugins/kafka/package.json
index 017c14881a..a39b72c5b9 100644
--- a/plugins/kafka/package.json
+++ b/plugins/kafka/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-kafka",
"description": "A Backstage plugin that integrates towards Kafka",
- "version": "0.3.16-next.2",
+ "version": "0.3.17-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -32,7 +32,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"react-use": "^17.2.4"
},
"peerDependencies": {
diff --git a/plugins/kubernetes-backend/CHANGELOG.md b/plugins/kubernetes-backend/CHANGELOG.md
index ac1287f8aa..75a4567b98 100644
--- a/plugins/kubernetes-backend/CHANGELOG.md
+++ b/plugins/kubernetes-backend/CHANGELOG.md
@@ -1,5 +1,40 @@
# @backstage/plugin-kubernetes-backend
+## 0.10.0-next.0
+
+### Minor Changes
+
+- 804f6d16b0c: **BREAKING**: `KubernetesBuilder.create` now requires a `permissions` field of type `PermissionEvaluator`. The kubernetes `/proxy` endpoint now requires two tokens: the `Backstage-Kubernetes-Authorization` header should contain a bearer token for the target cluster, and the `Authorization` header should contain a backstage identity token. The kubernetes `/proxy` endpoint now requires a `Backstage-Kubernetes-Cluster` header replacing the previously required `X-Kubernetes-Cluster` header.
+
+### Patch Changes
+
+- 75d4985f5e8: Fixes bug whereby backstage crashes when bad credentials are provided to the kubernetes plugin.
+- 83d250badc6: Fix parsing error when kubernetes api is returning badly structured data.
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/plugin-kubernetes-common@0.6.2-next.0
+ - @backstage/config@1.0.7
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-auth-node@0.2.13-next.0
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/plugin-permission-node@0.7.7-next.0
+
+## 0.9.4
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/plugin-auth-node@0.2.12
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/catalog-model@1.2.1
+ - @backstage/config@1.0.7
+ - @backstage/plugin-kubernetes-common@0.6.1
+
## 0.9.4-next.2
### Patch Changes
diff --git a/plugins/kubernetes-backend/api-report.md b/plugins/kubernetes-backend/api-report.md
index a6a4bcfc58..449131a26e 100644
--- a/plugins/kubernetes-backend/api-report.md
+++ b/plugins/kubernetes-backend/api-report.md
@@ -17,6 +17,7 @@ import { KubernetesRequestAuth } from '@backstage/plugin-kubernetes-common';
import type { KubernetesRequestBody } from '@backstage/plugin-kubernetes-common';
import { Logger } from 'winston';
import type { ObjectsByEntityResponse } from '@backstage/plugin-kubernetes-common';
+import { PermissionEvaluator } from '@backstage/plugin-permission-common';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
import type { RequestHandler } from 'express';
import { TokenCredential } from '@azure/identity';
@@ -141,6 +142,9 @@ export class GoogleServiceAccountAuthTranslator
): Promise;
}
+// @public
+export const HEADER_KUBERNETES_AUTH: string;
+
// @public
export const HEADER_KUBERNETES_CLUSTER: string;
@@ -200,6 +204,7 @@ export class KubernetesBuilder {
clusterSupplier: KubernetesClustersSupplier,
catalogApi: CatalogApi,
proxy: KubernetesProxy,
+ permissionApi: PermissionEvaluator,
): express.Router;
// (undocumented)
protected buildServiceLocator(
@@ -271,6 +276,8 @@ export interface KubernetesEnvironment {
config: Config;
// (undocumented)
logger: Logger;
+ // (undocumented)
+ permissions: PermissionEvaluator;
}
// @public
@@ -340,9 +347,16 @@ export type KubernetesObjectTypes =
export class KubernetesProxy {
constructor(logger: Logger, clusterSupplier: KubernetesClustersSupplier);
// (undocumented)
- createRequestHandler(): RequestHandler;
+ createRequestHandler(
+ options: KubernetesProxyCreateRequestHandlerOptions,
+ ): RequestHandler;
}
+// @public
+export type KubernetesProxyCreateRequestHandlerOptions = {
+ permissionApi: PermissionEvaluator;
+};
+
// @public
export interface KubernetesServiceLocator {
// (undocumented)
@@ -418,6 +432,8 @@ export interface RouterOptions {
discovery: PluginEndpointDiscovery;
// (undocumented)
logger: Logger;
+ // (undocumented)
+ permissions: PermissionEvaluator;
}
// @public (undocumented)
diff --git a/plugins/kubernetes-backend/examples/dice-roller/metrics-server.yaml b/plugins/kubernetes-backend/examples/dice-roller/metrics-server.yaml
index 673064aaf2..06875a5cf1 100644
--- a/plugins/kubernetes-backend/examples/dice-roller/metrics-server.yaml
+++ b/plugins/kubernetes-backend/examples/dice-roller/metrics-server.yaml
@@ -82,7 +82,7 @@ spec:
emptyDir: {}
containers:
- name: metrics-server
- image: k8s.gcr.io/metrics-server-amd64:v0.3.1
+ image: registry.k8s.io/metrics-server-amd64:v0.3.1
args:
- --kubelet-insecure-tls
- --kubelet-preferred-address-types=InternalIP
diff --git a/plugins/kubernetes-backend/package.json b/plugins/kubernetes-backend/package.json
index ee7844c76e..8f7b071c9a 100644
--- a/plugins/kubernetes-backend/package.json
+++ b/plugins/kubernetes-backend/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-kubernetes-backend",
"description": "A Backstage backend plugin that integrates towards Kubernetes",
- "version": "0.9.4-next.2",
+ "version": "0.10.0-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -42,6 +42,8 @@
"@backstage/errors": "workspace:^",
"@backstage/plugin-auth-node": "workspace:^",
"@backstage/plugin-kubernetes-common": "workspace:^",
+ "@backstage/plugin-permission-common": "workspace:^",
+ "@backstage/plugin-permission-node": "workspace:^",
"@google-cloud/container": "^4.0.0",
"@jest-mock/express": "^2.0.1",
"@kubernetes/client-node": "0.18.1",
diff --git a/plugins/kubernetes-backend/src/kubernetes-auth-translator/AwsIamKubernetesAuthTranslator.test.ts b/plugins/kubernetes-backend/src/kubernetes-auth-translator/AwsIamKubernetesAuthTranslator.test.ts
index 2696587e69..1f8d525ea8 100644
--- a/plugins/kubernetes-backend/src/kubernetes-auth-translator/AwsIamKubernetesAuthTranslator.test.ts
+++ b/plugins/kubernetes-backend/src/kubernetes-auth-translator/AwsIamKubernetesAuthTranslator.test.ts
@@ -17,6 +17,13 @@ import AWS from 'aws-sdk';
import AWSMock from 'aws-sdk-mock';
import { AwsIamKubernetesAuthTranslator } from './AwsIamKubernetesAuthTranslator';
+const awsError: AWS.AWSError = {
+ code: '123',
+ message: 'no way',
+ name: 'nope',
+ time: new Date(),
+};
+
describe('AwsIamKubernetesAuthTranslator tests', () => {
let role: any = undefined;
const credentials: any = {
@@ -84,6 +91,25 @@ describe('AwsIamKubernetesAuthTranslator tests', () => {
expect(response.serviceAccountToken).toBeDefined();
});
+ describe('When the credentials is failing', () => {
+ beforeEach(() => {
+ jest.spyOn(AWS.config, 'getCredentials').mockImplementation(cb => {
+ cb(awsError, null);
+ });
+ });
+ it('throws the right error', async () => {
+ const authTranslator = new AwsIamKubernetesAuthTranslator();
+ await expect(
+ authTranslator.decorateClusterDetailsWithAuth({
+ assumeRole: role,
+ name: 'test-cluster',
+ url: '',
+ authProvider: 'aws',
+ }),
+ ).rejects.toEqual(awsError);
+ });
+ });
+
describe('When the role is assumed', () => {
// These credentials are not real.
// Pulled from example in docs: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html
diff --git a/plugins/kubernetes-backend/src/kubernetes-auth-translator/AwsIamKubernetesAuthTranslator.ts b/plugins/kubernetes-backend/src/kubernetes-auth-translator/AwsIamKubernetesAuthTranslator.ts
index b89945902d..84e60c9c69 100644
--- a/plugins/kubernetes-backend/src/kubernetes-auth-translator/AwsIamKubernetesAuthTranslator.ts
+++ b/plugins/kubernetes-backend/src/kubernetes-auth-translator/AwsIamKubernetesAuthTranslator.ts
@@ -55,46 +55,44 @@ export class AwsIamKubernetesAuthTranslator
assumeRole?: string,
externalId?: string,
): Promise {
- return new Promise(async (resolve, reject) => {
- const awsCreds = await this.awsGetCredentials();
+ const awsCreds = await this.awsGetCredentials();
- if (!(awsCreds instanceof Credentials))
- return reject(Error('No AWS credentials found.'));
+ if (!(awsCreds instanceof Credentials))
+ throw new Error('No AWS credentials found.');
- let creds: SigningCreds = {
- accessKeyId: awsCreds.accessKeyId,
- secretAccessKey: awsCreds.secretAccessKey,
- sessionToken: awsCreds.sessionToken,
+ let creds: SigningCreds = {
+ accessKeyId: awsCreds.accessKeyId,
+ secretAccessKey: awsCreds.secretAccessKey,
+ sessionToken: awsCreds.sessionToken,
+ };
+
+ if (!this.validCredentials(creds))
+ throw new Error('Invalid AWS credentials found.');
+ if (!assumeRole) return creds;
+
+ try {
+ const params: AWS.STS.Types.AssumeRoleRequest = {
+ RoleArn: assumeRole,
+ RoleSessionName: 'backstage-login',
};
+ if (externalId) params.ExternalId = externalId;
- if (!this.validCredentials(creds))
- return reject(Error('Invalid AWS credentials found.'));
- if (!assumeRole) return resolve(creds);
+ const assumedRole = await new AWS.STS().assumeRole(params).promise();
- try {
- const params: AWS.STS.Types.AssumeRoleRequest = {
- RoleArn: assumeRole,
- RoleSessionName: 'backstage-login',
- };
- if (externalId) params.ExternalId = externalId;
-
- const assumedRole = await new AWS.STS().assumeRole(params).promise();
-
- if (!assumedRole.Credentials) {
- throw new Error(`No credentials returned for role ${assumeRole}`);
- }
-
- creds = {
- accessKeyId: assumedRole.Credentials.AccessKeyId,
- secretAccessKey: assumedRole.Credentials.SecretAccessKey,
- sessionToken: assumedRole.Credentials.SessionToken,
- };
- } catch (e) {
- console.warn(`There was an error assuming the role: ${e}`);
- return reject(Error(`Unable to assume role: ${e}`));
+ if (!assumedRole.Credentials) {
+ throw new Error(`No credentials returned for role ${assumeRole}`);
}
- return resolve(creds);
- });
+
+ creds = {
+ accessKeyId: assumedRole.Credentials.AccessKeyId,
+ secretAccessKey: assumedRole.Credentials.SecretAccessKey,
+ sessionToken: assumedRole.Credentials.SessionToken,
+ };
+ } catch (e) {
+ console.warn(`There was an error assuming the role: ${e}`);
+ throw new Error(`Unable to assume role: ${e}`);
+ }
+ return creds;
}
async getBearerToken(
clusterName: string,
diff --git a/plugins/kubernetes-backend/src/service/KubernetesBuilder.test.ts b/plugins/kubernetes-backend/src/service/KubernetesBuilder.test.ts
index cc2dea26c0..8eb7a066df 100644
--- a/plugins/kubernetes-backend/src/service/KubernetesBuilder.test.ts
+++ b/plugins/kubernetes-backend/src/service/KubernetesBuilder.test.ts
@@ -31,16 +31,24 @@ import {
import { KubernetesBuilder } from './KubernetesBuilder';
import { KubernetesFanOutHandler } from './KubernetesFanOutHandler';
import { CatalogApi } from '@backstage/catalog-client';
-import { HEADER_KUBERNETES_CLUSTER } from './KubernetesProxy';
+import {
+ HEADER_KUBERNETES_CLUSTER,
+ HEADER_KUBERNETES_AUTH,
+} from './KubernetesProxy';
import { setupServer } from 'msw/node';
import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
import { rest } from 'msw';
+import {
+ AuthorizeResult,
+ PermissionEvaluator,
+} from '@backstage/plugin-permission-common';
describe('KubernetesBuilder', () => {
let app: express.Express;
let kubernetesFanOutHandler: jest.Mocked;
let config: Config;
let catalogApi: CatalogApi;
+ let permissions: jest.Mocked;
beforeAll(async () => {
const logger = getVoidLogger();
@@ -74,10 +82,16 @@ describe('KubernetesBuilder', () => {
getKubernetesObjectsByEntity: jest.fn(),
} as any;
+ permissions = {
+ authorize: jest.fn(),
+ authorizeConditional: jest.fn(),
+ };
+
const { router } = await KubernetesBuilder.createBuilder({
config,
logger,
catalogApi,
+ permissions,
})
.setObjectsProvider(kubernetesFanOutHandler)
.setClusterSupplier(clusterSupplier)
@@ -250,6 +264,7 @@ describe('KubernetesBuilder', () => {
logger,
config,
catalogApi,
+ permissions,
})
.setClusterSupplier(clusterSupplier)
.setServiceLocator(serviceLocator)
@@ -271,27 +286,32 @@ describe('KubernetesBuilder', () => {
expect(response.status).toEqual(200);
});
});
-
describe('post /proxy', () => {
const worker = setupServer();
setupRequestMockHandlers(worker);
beforeEach(() => {
worker.use(
- rest.post('https://localhost:1234/api/v1/namespaces', (req, res, ctx) =>
- req
- .arrayBuffer()
- .then(body =>
- res(
- ctx.set('content-type', `${req.headers.get('content-type')}`),
- ctx.body(body),
- ),
- ),
+ rest.post(
+ 'https://localhost:1234/api/v1/namespaces',
+ (req, res, ctx) => {
+ if (!req.headers.get('Authorization')) {
+ return res(ctx.status(401));
+ }
+ return req
+ .arrayBuffer()
+ .then(body =>
+ res(
+ ctx.set('content-type', `${req.headers.get('content-type')}`),
+ ctx.body(body),
+ ),
+ );
+ },
),
);
});
- it('returns the given request body', async () => {
+ it('returns the given request body with permission set to allow', async () => {
const requestBody = {
kind: 'Namespace',
apiVersion: 'v1',
@@ -300,9 +320,14 @@ describe('KubernetesBuilder', () => {
},
};
+ permissions.authorize.mockReturnValue(
+ Promise.resolve([{ result: AuthorizeResult.ALLOW }]),
+ );
+
const proxyEndpointRequest = request(app)
.post('/proxy/api/v1/namespaces')
.set(HEADER_KUBERNETES_CLUSTER, 'some-cluster')
+ .set(HEADER_KUBERNETES_AUTH, 'randomtoken')
.send(requestBody);
worker.use(rest.all(proxyEndpointRequest.url, req => req.passthrough()));
@@ -312,7 +337,7 @@ describe('KubernetesBuilder', () => {
expect(response.body).toStrictEqual(requestBody);
});
- it('supports yaml content type', async () => {
+ it('supports yaml content type with permission set to allow', async () => {
const requestBody = `---
kind: Namespace
apiVersion: v1
@@ -320,9 +345,14 @@ metadata:
name: new-ns
`;
+ permissions.authorize.mockReturnValue(
+ Promise.resolve([{ result: AuthorizeResult.ALLOW }]),
+ );
+
const proxyEndpointRequest = request(app)
.post('/proxy/api/v1/namespaces')
.set(HEADER_KUBERNETES_CLUSTER, 'some-cluster')
+ .set(HEADER_KUBERNETES_AUTH, 'randomtoken')
.set('content-type', 'application/yaml')
.send(requestBody);
@@ -331,5 +361,50 @@ metadata:
const response = await proxyEndpointRequest;
expect(response.text).toEqual(requestBody);
});
+
+ it('returns a 403 response if Permission Policy is in place that blocks endpoint', async () => {
+ const requestBody = {
+ kind: 'Namespace',
+ apiVersion: 'v1',
+ metadata: {
+ name: 'new-ns',
+ },
+ };
+
+ permissions.authorize.mockReturnValue(
+ Promise.resolve([{ result: AuthorizeResult.DENY }]),
+ );
+
+ const proxyEndpointRequest = request(app)
+ .post('/proxy/api/v1/namespaces')
+ .set(HEADER_KUBERNETES_CLUSTER, 'some-cluster')
+ .set(HEADER_KUBERNETES_AUTH, 'randomtoken')
+ .send(requestBody);
+
+ worker.use(rest.all(proxyEndpointRequest.url, req => req.passthrough()));
+
+ const response = await proxyEndpointRequest;
+
+ expect(response.status).toEqual(403);
+ });
+ });
+ describe('get /.well-known/backstage/permissions/metadata', () => {
+ it('lists permissions supported by the kubernetes plugin', async () => {
+ const response = await request(app).get(
+ '/.well-known/backstage/permissions/metadata',
+ );
+
+ expect(response.status).toEqual(200);
+ expect(response.body).toMatchObject({
+ permissions: [
+ {
+ type: 'basic',
+ name: 'kubernetes.proxy',
+ attributes: {},
+ },
+ ],
+ rules: [],
+ });
+ });
});
});
diff --git a/plugins/kubernetes-backend/src/service/KubernetesBuilder.ts b/plugins/kubernetes-backend/src/service/KubernetesBuilder.ts
index 74ec9eada2..367e5edef3 100644
--- a/plugins/kubernetes-backend/src/service/KubernetesBuilder.ts
+++ b/plugins/kubernetes-backend/src/service/KubernetesBuilder.ts
@@ -15,6 +15,9 @@
*/
import { CatalogApi } from '@backstage/catalog-client';
import { Config } from '@backstage/config';
+import { kubernetesPermissions } from '@backstage/plugin-kubernetes-common';
+import { PermissionEvaluator } from '@backstage/plugin-permission-common';
+import { createPermissionIntegrationRouter } from '@backstage/plugin-permission-node';
import express from 'express';
import Router from 'express-promise-router';
import { Duration } from 'luxon';
@@ -49,6 +52,7 @@ export interface KubernetesEnvironment {
logger: Logger;
config: Config;
catalogApi: CatalogApi;
+ permissions: PermissionEvaluator;
}
/**
@@ -89,6 +93,7 @@ export class KubernetesBuilder {
public async build(): KubernetesBuilderReturn {
const logger = this.env.logger;
const config = this.env.config;
+ const permissions = this.env.permissions;
logger.info('Initializing Kubernetes backend');
@@ -126,6 +131,7 @@ export class KubernetesBuilder {
clusterSupplier,
this.env.catalogApi,
proxy,
+ permissions,
);
return {
@@ -262,12 +268,17 @@ export class KubernetesBuilder {
clusterSupplier: KubernetesClustersSupplier,
catalogApi: CatalogApi,
proxy: KubernetesProxy,
+ permissionApi: PermissionEvaluator,
): express.Router {
const logger = this.env.logger;
const router = Router();
- router.use('/proxy', proxy.createRequestHandler());
+ router.use('/proxy', proxy.createRequestHandler({ permissionApi }));
router.use(express.json());
-
+ router.use(
+ createPermissionIntegrationRouter({
+ permissions: kubernetesPermissions,
+ }),
+ );
// @deprecated
router.post('/services/:serviceId', async (req, res) => {
const serviceId = req.params.serviceId;
diff --git a/plugins/kubernetes-backend/src/service/KubernetesFanOutHandler.test.ts b/plugins/kubernetes-backend/src/service/KubernetesFanOutHandler.test.ts
index 17a86eb30d..53aaa1ad3a 100644
--- a/plugins/kubernetes-backend/src/service/KubernetesFanOutHandler.test.ts
+++ b/plugins/kubernetes-backend/src/service/KubernetesFanOutHandler.test.ts
@@ -502,6 +502,47 @@ describe('getKubernetesObjectsByEntity', () => {
});
});
+ it('pods api is returning garbage', async () => {
+ getClustersByEntity.mockImplementation(() =>
+ Promise.resolve({
+ clusters: [
+ {
+ name: 'test-cluster',
+ authProvider: 'serviceAccount',
+ },
+ ],
+ }),
+ );
+
+ fetchObjectsForService.mockImplementation((_: ObjectFetchParams) =>
+ Promise.resolve({
+ errors: [],
+ responses: [
+ {
+ garbage: ['thrash', 'rubbish'],
+ },
+ ],
+ }),
+ );
+
+ mockMetrics(fetchPodMetricsByNamespaces);
+
+ const sut = getKubernetesFanOutHandler([]);
+
+ const result = await sut.getKubernetesObjectsByEntity({
+ entity,
+ auth: {},
+ });
+
+ expect(getClustersByEntity.mock.calls.length).toBe(1);
+ expect(fetchObjectsForService.mock.calls.length).toBe(1);
+ expect(fetchPodMetricsByNamespaces.mock.calls.length).toBe(0);
+
+ expect(result).toStrictEqual({
+ items: [],
+ });
+ });
+
it('retrieve objects for two clusters', async () => {
getClustersByEntity.mockImplementation(() =>
Promise.resolve({
diff --git a/plugins/kubernetes-backend/src/service/KubernetesFanOutHandler.ts b/plugins/kubernetes-backend/src/service/KubernetesFanOutHandler.ts
index 63e46a44e3..f71c6506bd 100644
--- a/plugins/kubernetes-backend/src/service/KubernetesFanOutHandler.ts
+++ b/plugins/kubernetes-backend/src/service/KubernetesFanOutHandler.ts
@@ -49,6 +49,14 @@ import {
PodStatus,
} from '@kubernetes/client-node';
+const isRejected = (
+ input: PromiseSettledResult,
+): input is PromiseRejectedResult => input.status === 'rejected';
+
+const isFulfilled = (
+ input: PromiseSettledResult,
+): input is PromiseFulfilledResult => input.status === 'fulfilled';
+
/**
*
* @public
@@ -298,12 +306,12 @@ export class KubernetesFanOutHandler {
auth: KubernetesRequestAuth,
requestContext: ServiceLocatorRequestContext,
) {
- const clusterDetails: ClusterDetails[] = await (
+ const clusterDetails: ClusterDetails[] = (
await this.serviceLocator.getClustersByEntity(entity, requestContext)
).clusters;
// Execute all of these async actions simultaneously/without blocking sequentially as no common object is modified by them
- return await Promise.all(
+ const promiseResults = await Promise.allSettled(
clusterDetails.map(cd => {
const kubernetesAuthTranslator: KubernetesAuthTranslator =
this.getAuthTranslator(cd.authProvider);
@@ -313,6 +321,11 @@ export class KubernetesFanOutHandler {
);
}),
);
+
+ promiseResults.filter(isRejected).map(item => {
+ this.logger.info(`Failed to decorate cluster details: ${item.reason}`);
+ });
+ return promiseResults.filter(isFulfilled).map(item => item.value);
}
toObjectsByEntityResponse(
@@ -324,7 +337,7 @@ export class KubernetesFanOutHandler {
(item.errors !== undefined && item.errors.length >= 1) ||
(item.resources !== undefined &&
item.resources.length >= 1 &&
- item.resources.some(fr => fr.resources.length >= 1)),
+ item.resources.some(fr => fr.resources?.length >= 1)),
),
};
}
diff --git a/plugins/kubernetes-backend/src/service/KubernetesProxy.test.ts b/plugins/kubernetes-backend/src/service/KubernetesProxy.test.ts
index 4254bb33da..d2404af839 100644
--- a/plugins/kubernetes-backend/src/service/KubernetesProxy.test.ts
+++ b/plugins/kubernetes-backend/src/service/KubernetesProxy.test.ts
@@ -30,6 +30,10 @@ import {
HEADER_KUBERNETES_CLUSTER,
KubernetesProxy,
} from './KubernetesProxy';
+import {
+ AuthorizeResult,
+ PermissionEvaluator,
+} from '@backstage/plugin-permission-common';
describe('KubernetesProxy', () => {
let proxy: KubernetesProxy;
@@ -64,6 +68,11 @@ describe('KubernetesProxy', () => {
getClusters: jest.fn(),
};
+ const permissionApi: jest.Mocked = {
+ authorize: jest.fn(),
+ authorizeConditional: jest.fn(),
+ };
+
beforeEach(() => {
jest.resetAllMocks();
proxy = new KubernetesProxy(getVoidLogger(), clusterSupplier);
@@ -71,13 +80,16 @@ describe('KubernetesProxy', () => {
it('should return a ERROR_NOT_FOUND if no clusters are found', async () => {
clusterSupplier.getClusters.mockResolvedValue([]);
+ permissionApi.authorize.mockReturnValue(
+ Promise.resolve([{ result: AuthorizeResult.ALLOW }]),
+ );
const req = buildMockRequest('test', 'api');
const { res, next } = getMockRes();
- await expect(proxy.createRequestHandler()(req, res, next)).rejects.toThrow(
- NotFoundError,
- );
+ await expect(
+ proxy.createRequestHandler({ permissionApi })(req, res, next),
+ ).rejects.toThrow(NotFoundError);
});
it('should pass the exact response from Kubernetes', async () => {
@@ -100,7 +112,13 @@ describe('KubernetesProxy', () => {
authProvider: 'serviceAccount',
},
] as ClusterDetails[]);
- const app = express().use('/mountpath', proxy.createRequestHandler());
+ const app = express().use(
+ '/mountpath',
+ proxy.createRequestHandler({ permissionApi }),
+ );
+ permissionApi.authorize.mockReturnValue(
+ Promise.resolve([{ result: AuthorizeResult.ALLOW }]),
+ );
const requestPromise = request(app)
.get('/mountpath/api')
.set(HEADER_KUBERNETES_CLUSTER, 'cluster1');
diff --git a/plugins/kubernetes-backend/src/service/KubernetesProxy.ts b/plugins/kubernetes-backend/src/service/KubernetesProxy.ts
index 178105ef79..49a381b75a 100644
--- a/plugins/kubernetes-backend/src/service/KubernetesProxy.ts
+++ b/plugins/kubernetes-backend/src/service/KubernetesProxy.ts
@@ -18,9 +18,16 @@ import {
ErrorResponseBody,
ForwardedError,
InputError,
+ NotAllowedError,
NotFoundError,
serializeError,
} from '@backstage/errors';
+import { getBearerTokenFromAuthorizationHeader } from '@backstage/plugin-auth-node';
+import { kubernetesProxyPermission } from '@backstage/plugin-kubernetes-common';
+import {
+ PermissionEvaluator,
+ AuthorizeResult,
+} from '@backstage/plugin-permission-common';
import { bufferFromFileOrString } from '@kubernetes/client-node';
import type { Request, RequestHandler } from 'express';
import { createProxyMiddleware } from 'http-proxy-middleware';
@@ -34,7 +41,24 @@ export const APPLICATION_JSON: string = 'application/json';
*
* @public
*/
-export const HEADER_KUBERNETES_CLUSTER: string = 'X-Kubernetes-Cluster';
+export const HEADER_KUBERNETES_CLUSTER: string = 'Backstage-Kubernetes-Cluster';
+
+/**
+ * The header that is used to specify the Authentication Authorities token.
+ * e.x if using the google auth provider as your authentication authority then this field would be the google provided bearer token.
+ * @public
+ */
+export const HEADER_KUBERNETES_AUTH: string =
+ 'Backstage-Kubernetes-Authorization';
+
+/**
+ * The options object expected to be passed as a parameter to KubernetesProxy.createRequestHandler().
+ *
+ * @public
+ */
+export type KubernetesProxyCreateRequestHandlerOptions = {
+ permissionApi: PermissionEvaluator;
+};
/**
* A proxy that routes requests to the Kubernetes API.
@@ -49,8 +73,29 @@ export class KubernetesProxy {
private readonly clusterSupplier: KubernetesClustersSupplier,
) {}
- public createRequestHandler(): RequestHandler {
+ public createRequestHandler(
+ options: KubernetesProxyCreateRequestHandlerOptions,
+ ): RequestHandler {
+ const { permissionApi } = options;
return async (req, res, next) => {
+ const token = getBearerTokenFromAuthorizationHeader(
+ req.header('authorization'),
+ );
+
+ const authorizeResponse = (
+ await permissionApi.authorize(
+ [{ permission: kubernetesProxyPermission }],
+ {
+ token,
+ },
+ )
+ )[0];
+
+ if (authorizeResponse.result === AuthorizeResult.DENY) {
+ res.status(403).json({ error: new NotAllowedError('Unauthorized') });
+ return;
+ }
+
const middleware = await this.getMiddleware(req);
middleware(req, res, next);
};
@@ -104,6 +149,11 @@ export class KubernetesProxy {
res.status(500).json(body);
},
+ onProxyReq: (proxyReq, req) => {
+ // the kubernetes proxy endpoint expects a header field labeled `Backstage-Kubernetes-Authorization` that will be used to authenticate with the Kubernetes Api. The token provided as a value should be an bearer token for the target cluster.
+ const token = req.header(HEADER_KUBERNETES_AUTH) ?? '';
+ proxyReq.setHeader('Authorization', token);
+ },
});
this.middlewareForClusterName.set(originalCluster.name, middleware);
diff --git a/plugins/kubernetes-backend/src/service/index.ts b/plugins/kubernetes-backend/src/service/index.ts
index 620f788ac2..2f3e907879 100644
--- a/plugins/kubernetes-backend/src/service/index.ts
+++ b/plugins/kubernetes-backend/src/service/index.ts
@@ -16,5 +16,10 @@
export * from './KubernetesBuilder';
export { DEFAULT_OBJECTS } from './KubernetesFanOutHandler';
-export { HEADER_KUBERNETES_CLUSTER, KubernetesProxy } from './KubernetesProxy';
+export {
+ HEADER_KUBERNETES_CLUSTER,
+ KubernetesProxy,
+ HEADER_KUBERNETES_AUTH,
+} from './KubernetesProxy';
+export type { KubernetesProxyCreateRequestHandlerOptions } from './KubernetesProxy';
export * from './router';
diff --git a/plugins/kubernetes-backend/src/service/router.ts b/plugins/kubernetes-backend/src/service/router.ts
index 341956553e..f7e58f535c 100644
--- a/plugins/kubernetes-backend/src/service/router.ts
+++ b/plugins/kubernetes-backend/src/service/router.ts
@@ -21,6 +21,7 @@ import express from 'express';
import { KubernetesBuilder } from './KubernetesBuilder';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { CatalogApi } from '@backstage/catalog-client';
+import { PermissionEvaluator } from '@backstage/plugin-permission-common';
/**
*
@@ -32,6 +33,7 @@ export interface RouterOptions {
catalogApi: CatalogApi;
clusterSupplier?: KubernetesClustersSupplier;
discovery: PluginEndpointDiscovery;
+ permissions: PermissionEvaluator;
}
/**
diff --git a/plugins/kubernetes-backend/src/service/standaloneApplication.ts b/plugins/kubernetes-backend/src/service/standaloneApplication.ts
index 8234f89d48..e3afb5a385 100644
--- a/plugins/kubernetes-backend/src/service/standaloneApplication.ts
+++ b/plugins/kubernetes-backend/src/service/standaloneApplication.ts
@@ -28,6 +28,7 @@ import { Logger } from 'winston';
import { createRouter } from './router';
import { ConfigReader } from '@backstage/config';
import { CatalogClient } from '@backstage/catalog-client';
+import { PermissionEvaluator } from '@backstage/plugin-permission-common';
export interface ApplicationOptions {
enableCors: boolean;
@@ -47,6 +48,8 @@ export async function createStandaloneApplication(
discoveryApi: SingleHostDiscovery.fromConfig(config),
});
+ const permissions = {} as PermissionEvaluator;
+
app.use(helmet());
if (enableCors) {
app.use(cors());
@@ -54,7 +57,10 @@ export async function createStandaloneApplication(
app.use(compression());
app.use(express.json());
app.use(requestLoggingHandler());
- app.use('/', await createRouter({ logger, config, discovery, catalogApi }));
+ app.use(
+ '/',
+ await createRouter({ logger, config, discovery, catalogApi, permissions }),
+ );
app.use(notFoundHandler());
app.use(errorHandler());
diff --git a/plugins/kubernetes-common/CHANGELOG.md b/plugins/kubernetes-common/CHANGELOG.md
index 35044f7576..862899600e 100644
--- a/plugins/kubernetes-common/CHANGELOG.md
+++ b/plugins/kubernetes-common/CHANGELOG.md
@@ -1,5 +1,21 @@
# @backstage/plugin-kubernetes-common
+## 0.6.2-next.0
+
+### Patch Changes
+
+- 804f6d16b0c: Introduced proxy permission types to be used with the kubernetes proxy endpoint's permission framework integration.
+- Updated dependencies
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-permission-common@0.7.4
+
+## 0.6.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/catalog-model@1.2.1
+
## 0.6.1-next.1
### Patch Changes
diff --git a/plugins/kubernetes-common/api-report.md b/plugins/kubernetes-common/api-report.md
index fb41895f1a..6c88074e50 100644
--- a/plugins/kubernetes-common/api-report.md
+++ b/plugins/kubernetes-common/api-report.md
@@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
+import { BasicPermission } from '@backstage/plugin-permission-common';
import { Entity } from '@backstage/catalog-model';
import type { JsonObject } from '@backstage/types';
import { PodStatus } from '@kubernetes/client-node';
@@ -217,6 +218,12 @@ export type KubernetesErrorTypes =
// @public (undocumented)
export type KubernetesFetchError = StatusError | RawFetchError;
+// @public
+export const kubernetesPermissions: BasicPermission[];
+
+// @public
+export const kubernetesProxyPermission: BasicPermission;
+
// @public (undocumented)
export interface KubernetesRequestAuth {
// (undocumented)
diff --git a/plugins/kubernetes-common/package.json b/plugins/kubernetes-common/package.json
index e100b64500..4eb4a02bf9 100644
--- a/plugins/kubernetes-common/package.json
+++ b/plugins/kubernetes-common/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-kubernetes-common",
"description": "Common functionalities for kubernetes, to be shared between kubernetes and kubernetes-backend plugin",
- "version": "0.6.1-next.1",
+ "version": "0.6.2-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -39,6 +39,7 @@
},
"dependencies": {
"@backstage/catalog-model": "workspace:^",
+ "@backstage/plugin-permission-common": "workspace:^",
"@kubernetes/client-node": "0.18.1"
},
"devDependencies": {
diff --git a/plugins/kubernetes-common/src/index.ts b/plugins/kubernetes-common/src/index.ts
index ade73e4f79..d5cf8dcf61 100644
--- a/plugins/kubernetes-common/src/index.ts
+++ b/plugins/kubernetes-common/src/index.ts
@@ -22,3 +22,7 @@
export * from './types';
export * from './catalog-entity-constants';
+export {
+ kubernetesProxyPermission,
+ kubernetesPermissions,
+} from './permissions';
diff --git a/plugins/kubernetes-common/src/permissions.ts b/plugins/kubernetes-common/src/permissions.ts
new file mode 100644
index 0000000000..d3ccbe8171
--- /dev/null
+++ b/plugins/kubernetes-common/src/permissions.ts
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { createPermission } from '@backstage/plugin-permission-common';
+
+/** This permission is used to check access to the proxy endpoint
+ * @public
+ */
+export const kubernetesProxyPermission = createPermission({
+ name: 'kubernetes.proxy',
+ attributes: {},
+});
+
+/**
+ * List of all Kubernetes permissions.
+ * @public
+ */
+export const kubernetesPermissions = [kubernetesProxyPermission];
diff --git a/plugins/kubernetes/CHANGELOG.md b/plugins/kubernetes/CHANGELOG.md
index 05929a7d46..cc8131b399 100644
--- a/plugins/kubernetes/CHANGELOG.md
+++ b/plugins/kubernetes/CHANGELOG.md
@@ -1,5 +1,35 @@
# @backstage/plugin-kubernetes
+## 0.7.10-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/plugin-kubernetes-common@0.6.2-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.7.9
+
+### Patch Changes
+
+- 8adeb19b37d: GitLab can now be used as an `oidcTokenProvider` for Kubernetes clusters
+- c10384a9235: Switch to using `LinkButton` instead of the deprecated `Button`
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/config@1.0.7
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-kubernetes-common@0.6.1
+
## 0.7.9-next.2
### Patch Changes
diff --git a/plugins/kubernetes/package.json b/plugins/kubernetes/package.json
index ed806ee521..f674402545 100644
--- a/plugins/kubernetes/package.json
+++ b/plugins/kubernetes/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-kubernetes",
"description": "A Backstage plugin that integrates towards Kubernetes",
- "version": "0.7.9-next.2",
+ "version": "0.7.10-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -43,7 +43,7 @@
"@kubernetes/client-node": "0.18.1",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"@types/react": "^16.13.1 || ^17.0.0",
"cronstrue": "^2.2.0",
"js-yaml": "^4.0.0",
diff --git a/plugins/lighthouse-backend/CHANGELOG.md b/plugins/lighthouse-backend/CHANGELOG.md
index 0caf949bd6..7320fc7b77 100644
--- a/plugins/lighthouse-backend/CHANGELOG.md
+++ b/plugins/lighthouse-backend/CHANGELOG.md
@@ -1,5 +1,32 @@
# @backstage/plugin-lighthouse-backend
+## 0.1.2-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/types@1.0.2
+ - @backstage/plugin-lighthouse-common@0.1.1
+
+## 0.1.1
+
+### Patch Changes
+
+- 46829bc2f0e: Update README.md; typo with plugin name & removed unneeded "import { Router } from 'express';"
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/catalog-model@1.2.1
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+ - @backstage/plugin-lighthouse-common@0.1.1
+
## 0.1.1-next.2
### Patch Changes
diff --git a/plugins/lighthouse-backend/package.json b/plugins/lighthouse-backend/package.json
index 7fa51b3446..523f3837f5 100644
--- a/plugins/lighthouse-backend/package.json
+++ b/plugins/lighthouse-backend/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-lighthouse-backend",
"description": "Backend functionalities for lighthouse",
- "version": "0.1.1-next.2",
+ "version": "0.1.2-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/lighthouse-common/CHANGELOG.md b/plugins/lighthouse-common/CHANGELOG.md
index 001182cf98..a44c2b52a6 100644
--- a/plugins/lighthouse-common/CHANGELOG.md
+++ b/plugins/lighthouse-common/CHANGELOG.md
@@ -1,5 +1,12 @@
# @backstage/plugin-lighthouse-common
+## 0.1.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/config@1.0.7
+
## 0.1.1-next.0
### Patch Changes
diff --git a/plugins/lighthouse-common/package.json b/plugins/lighthouse-common/package.json
index cf7a598ce8..9cd13e7510 100644
--- a/plugins/lighthouse-common/package.json
+++ b/plugins/lighthouse-common/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-lighthouse-common",
"description": "Common functionalities for lighthouse, to be shared between lighthouse and lighthouse-backend plugin",
- "version": "0.1.1-next.0",
+ "version": "0.1.1",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/lighthouse/CHANGELOG.md b/plugins/lighthouse/CHANGELOG.md
index f326707dfa..e662f3d81d 100644
--- a/plugins/lighthouse/CHANGELOG.md
+++ b/plugins/lighthouse/CHANGELOG.md
@@ -1,5 +1,33 @@
# @backstage/plugin-lighthouse
+## 0.4.2-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/config@1.0.7
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-lighthouse-common@0.1.1
+
+## 0.4.1
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/config@1.0.7
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-lighthouse-common@0.1.1
+
## 0.4.1-next.2
### Patch Changes
diff --git a/plugins/lighthouse/package.json b/plugins/lighthouse/package.json
index 3fcb24986d..c46fcffe57 100644
--- a/plugins/lighthouse/package.json
+++ b/plugins/lighthouse/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-lighthouse",
"description": "A Backstage plugin that integrates towards Lighthouse",
- "version": "0.4.1-next.2",
+ "version": "0.4.2-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -42,7 +42,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"react-use": "^17.2.4"
},
"peerDependencies": {
diff --git a/plugins/linguist-backend/CHANGELOG.md b/plugins/linguist-backend/CHANGELOG.md
index ac922c735b..5f38af055f 100644
--- a/plugins/linguist-backend/CHANGELOG.md
+++ b/plugins/linguist-backend/CHANGELOG.md
@@ -1,5 +1,48 @@
# @backstage/plugin-linguist-backend
+## 0.2.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+ - @backstage/plugin-auth-node@0.2.13-next.0
+ - @backstage/plugin-linguist-common@0.1.0
+
+## 0.2.0
+
+### Minor Changes
+
+- 4a1c318853d: **BREAKING** The linguist-backend `createRouter` now requires that the `tokenManger` is passed to the router.
+
+### Patch Changes
+
+- 8a298b47240: Added support for linguist-js options using the linguistJSOptions in the plugin, the available config can be found [here](https://www.npmjs.com/package/linguist-js#API).
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- 2ea57821629: Fixed bug in LinguistBackendApi that caused initial batch of entities to be skipped.
+- b271d5ca052: Allow kind to be configurable
+
+ ```ts
+ return createRouter({ schedule: schedule, kind: ['Component'] }, { ...env });
+ ```
+
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/plugin-auth-node@0.2.12
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/catalog-model@1.2.1
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+ - @backstage/plugin-linguist-common@0.1.0
+
## 0.2.0-next.2
### Patch Changes
diff --git a/plugins/linguist-backend/package.json b/plugins/linguist-backend/package.json
index 01c4f12afa..d9f971d178 100644
--- a/plugins/linguist-backend/package.json
+++ b/plugins/linguist-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-linguist-backend",
- "version": "0.2.0-next.2",
+ "version": "0.2.1-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/linguist/CHANGELOG.md b/plugins/linguist/CHANGELOG.md
index 3d83855122..1670d80f97 100644
--- a/plugins/linguist/CHANGELOG.md
+++ b/plugins/linguist/CHANGELOG.md
@@ -1,5 +1,33 @@
# @backstage/plugin-linguist
+## 0.1.2-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-linguist-common@0.1.0
+
+## 0.1.1
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- ab997ce243f: Updated `README.md` to removed images with refresh button as this feature was not implemented in the current version
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-linguist-common@0.1.0
+
## 0.1.1-next.2
### Patch Changes
diff --git a/plugins/linguist/package.json b/plugins/linguist/package.json
index 276bb81574..0a36244b81 100644
--- a/plugins/linguist/package.json
+++ b/plugins/linguist/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-linguist",
- "version": "0.1.1-next.2",
+ "version": "0.1.2-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -37,7 +37,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.9.13",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "^4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"luxon": "^2.0.2",
"react-use": "^17.2.4",
"slugify": "^1.6.4"
diff --git a/plugins/microsoft-calendar/CHANGELOG.md b/plugins/microsoft-calendar/CHANGELOG.md
index 69a93bc320..1cb17d787b 100644
--- a/plugins/microsoft-calendar/CHANGELOG.md
+++ b/plugins/microsoft-calendar/CHANGELOG.md
@@ -1,5 +1,27 @@
# @backstage/plugin-microsoft-calendar
+## 0.1.2-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+
+## 0.1.1
+
+### Patch Changes
+
+- cb8ec97cdeb: Change black & white colors to be theme aware
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/theme@0.2.18
+
## 0.1.1-next.2
### Patch Changes
diff --git a/plugins/microsoft-calendar/README.md b/plugins/microsoft-calendar/README.md
index 219a7cf2dc..92421046e2 100644
--- a/plugins/microsoft-calendar/README.md
+++ b/plugins/microsoft-calendar/README.md
@@ -1,7 +1,6 @@
# Microsoft-Calendar Plugin
-Welcome to the Microsoft calendar plugin!
-_This plugin was created through the Backstage CLI_
+This plugin is contributed by [StatusNeo](https://statusneo.com/)
## Features
diff --git a/plugins/microsoft-calendar/package.json b/plugins/microsoft-calendar/package.json
index 8d20a5de70..8170c7847f 100644
--- a/plugins/microsoft-calendar/package.json
+++ b/plugins/microsoft-calendar/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-microsoft-calendar",
- "version": "0.1.1-next.2",
+ "version": "0.1.2-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -13,10 +13,24 @@
"role": "frontend-plugin"
},
"author": {
- "name": "Abhay Soni",
- "email": "abhaysoni.developer@gmail.com",
- "url": "https://github.com/Abhay-soni-developer"
+ "name": "Statusneo",
+ "email": "reach@statusneo.com",
+ "url": "https://statusneo.com/"
},
+ "contributors": [
+ {
+ "email": "abhaysoni.developer@gmail.com",
+ "url": "https://github.com/Abhay-soni-developer",
+ "name": "abhaysoni"
+ }
+ ],
+ "maintainers": [
+ {
+ "email": "abhaysoni.developer@gmail.com",
+ "url": "https://github.com/Abhay-soni-developer",
+ "name": "abhaysoni"
+ }
+ ],
"scripts": {
"start": "backstage-cli package start",
"build": "backstage-cli package build",
diff --git a/plugins/newrelic-dashboard/CHANGELOG.md b/plugins/newrelic-dashboard/CHANGELOG.md
index 93b27ba385..81112322fb 100644
--- a/plugins/newrelic-dashboard/CHANGELOG.md
+++ b/plugins/newrelic-dashboard/CHANGELOG.md
@@ -1,5 +1,29 @@
# @backstage/plugin-newrelic-dashboard
+## 0.2.10-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+
+## 0.2.9
+
+### Patch Changes
+
+- cb8ec97cdeb: Change black & white colors to be theme aware
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+
## 0.2.9-next.2
### Patch Changes
diff --git a/plugins/newrelic-dashboard/package.json b/plugins/newrelic-dashboard/package.json
index 9958741b5f..8718cbfe70 100644
--- a/plugins/newrelic-dashboard/package.json
+++ b/plugins/newrelic-dashboard/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-newrelic-dashboard",
- "version": "0.2.9-next.2",
+ "version": "0.2.10-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -29,7 +29,7 @@
"@backstage/plugin-catalog-react": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"react-use": "^17.2.4"
},
"devDependencies": {
diff --git a/plugins/newrelic/CHANGELOG.md b/plugins/newrelic/CHANGELOG.md
index bd0ef0d06f..60ccace53b 100644
--- a/plugins/newrelic/CHANGELOG.md
+++ b/plugins/newrelic/CHANGELOG.md
@@ -1,5 +1,26 @@
# @backstage/plugin-newrelic
+## 0.3.35-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/theme@0.2.18
+
+## 0.3.34
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- 66fdf05a1ef: Updated installation instructions
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/theme@0.2.18
+
## 0.3.34-next.2
### Patch Changes
diff --git a/plugins/newrelic/package.json b/plugins/newrelic/package.json
index 3ad74b3949..89823c559b 100644
--- a/plugins/newrelic/package.json
+++ b/plugins/newrelic/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-newrelic",
"description": "A Backstage plugin that integrates towards New Relic",
- "version": "0.3.34-next.2",
+ "version": "0.3.35-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -38,7 +38,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"react-use": "^17.2.4"
},
"peerDependencies": {
diff --git a/plugins/octopus-deploy/CHANGELOG.md b/plugins/octopus-deploy/CHANGELOG.md
index a3743722b8..8b39119ce2 100644
--- a/plugins/octopus-deploy/CHANGELOG.md
+++ b/plugins/octopus-deploy/CHANGELOG.md
@@ -1,5 +1,34 @@
# @backstage/plugin-octopus-deploy
+## 0.1.1-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.1.0
+
+### Minor Changes
+
+- b7fff1171f0: Initial version
+
+### Patch Changes
+
+- cb0fc15a992: Added Octopus Deploy logo
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.1.0-next.2
### Patch Changes
diff --git a/plugins/octopus-deploy/package.json b/plugins/octopus-deploy/package.json
index 9ba86f1587..ce36c80678 100644
--- a/plugins/octopus-deploy/package.json
+++ b/plugins/octopus-deploy/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-octopus-deploy",
- "version": "0.1.0-next.2",
+ "version": "0.1.1-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -29,7 +29,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.9.13",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"react-use": "^17.2.4"
},
"peerDependencies": {
diff --git a/plugins/org-react/CHANGELOG.md b/plugins/org-react/CHANGELOG.md
index cb59276110..cdb4ef0b9e 100644
--- a/plugins/org-react/CHANGELOG.md
+++ b/plugins/org-react/CHANGELOG.md
@@ -1,5 +1,30 @@
# @backstage/plugin-org-react
+## 0.1.6-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.1.5
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.1.5-next.2
### Patch Changes
diff --git a/plugins/org-react/package.json b/plugins/org-react/package.json
index a2e6623523..6b48a9c381 100644
--- a/plugins/org-react/package.json
+++ b/plugins/org-react/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-org-react",
- "version": "0.1.5-next.2",
+ "version": "0.1.6-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -38,7 +38,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "^4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"react-use": "^17.2.4"
},
"peerDependencies": {
diff --git a/plugins/org/CHANGELOG.md b/plugins/org/CHANGELOG.md
index 4728f8be20..d4db2bcc61 100644
--- a/plugins/org/CHANGELOG.md
+++ b/plugins/org/CHANGELOG.md
@@ -1,5 +1,32 @@
# @backstage/plugin-org
+## 0.6.7-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.6.6
+
+### Patch Changes
+
+- cb8ec97cdeb: Change black & white colors to be theme aware
+- 36bccb5252f: Fix small UI-glitch in MemberListCard
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- a06fcac4040: Add styling to the `MembersListCard` and `ComponentsGrid` to handle overflow text.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.6.6-next.2
### Patch Changes
diff --git a/plugins/org/package.json b/plugins/org/package.json
index bd7ea9a344..43a102e1dd 100644
--- a/plugins/org/package.json
+++ b/plugins/org/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-org",
"description": "A Backstage plugin that helps you create entity pages for your organization",
- "version": "0.6.6-next.2",
+ "version": "0.6.7-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -35,7 +35,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"p-limit": "^3.1.0",
"pluralize": "^8.0.0",
"qs": "^6.10.1",
diff --git a/plugins/org/src/components/Cards/Group/GroupProfile/GroupProfileCard.stories.tsx b/plugins/org/src/components/Cards/Group/GroupProfile/GroupProfileCard.stories.tsx
index f183ab4d8e..526d7c9c4c 100644
--- a/plugins/org/src/components/Cards/Group/GroupProfile/GroupProfileCard.stories.tsx
+++ b/plugins/org/src/components/Cards/Group/GroupProfile/GroupProfileCard.stories.tsx
@@ -128,3 +128,33 @@ export const ExtraDetails = () => (
);
+
+const groupWithTitle: GroupEntity = {
+ apiVersion: 'backstage.io/v1alpha1',
+ kind: 'Group',
+ metadata: {
+ name: 'team-a',
+ description: 'Team A description',
+ title: 'Team A title',
+ },
+ spec: {
+ profile: {
+ email: 'team-a@example.com',
+ picture:
+ 'https://avatars.dicebear.com/api/identicon/team-a@example.com.svg?background=%23fff&margin=25',
+ },
+ type: 'group',
+ children: [],
+ },
+ relations: [dummyDepartment],
+};
+
+export const UseGroupTitle = () => (
+
+
+
+
+
+
+);
diff --git a/plugins/org/src/components/Cards/Group/GroupProfile/GroupProfileCard.tsx b/plugins/org/src/components/Cards/Group/GroupProfile/GroupProfileCard.tsx
index 5e795b2710..e8f06e49b3 100644
--- a/plugins/org/src/components/Cards/Group/GroupProfile/GroupProfileCard.tsx
+++ b/plugins/org/src/components/Cards/Group/GroupProfile/GroupProfileCard.tsx
@@ -81,7 +81,7 @@ export const GroupProfileCard = (props: {
}
const {
- metadata: { name, description, annotations, links },
+ metadata: { name, description, title, annotations, links },
spec: { profile },
} = group;
@@ -99,7 +99,7 @@ export const GroupProfileCard = (props: {
const entityMetadataEditUrl =
group.metadata.annotations?.[ANNOTATION_EDIT_URL];
- const displayName = profile?.displayName ?? name;
+ const displayName = profile?.displayName ?? title ?? name;
const emailHref = profile?.email ? `mailto:${profile.email}` : '#';
const infoCardAction = entityMetadataEditUrl ? (
{
describe('applyConditions', () => {
- let server: SetupServerApi;
+ let server: SetupServer;
const mockConditions: PermissionCriteria = {
not: {
diff --git a/plugins/permission-common/CHANGELOG.md b/plugins/permission-common/CHANGELOG.md
index e193c4f8e6..be9d35ef6a 100644
--- a/plugins/permission-common/CHANGELOG.md
+++ b/plugins/permission-common/CHANGELOG.md
@@ -1,5 +1,15 @@
# @backstage/plugin-permission-common
+## 0.7.4
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/errors@1.1.5
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
## 0.7.4-next.0
### Patch Changes
diff --git a/plugins/permission-common/package.json b/plugins/permission-common/package.json
index 5b1abb5d94..8b8a6f60c0 100644
--- a/plugins/permission-common/package.json
+++ b/plugins/permission-common/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-permission-common",
"description": "Isomorphic types and client for Backstage permissions and authorization",
- "version": "0.7.4-next.0",
+ "version": "0.7.4",
"main": "src/index.ts",
"types": "src/index.ts",
"publishConfig": {
@@ -46,7 +46,7 @@
"@backstage/types": "workspace:^",
"cross-fetch": "^3.1.5",
"uuid": "^8.0.0",
- "zod": "~3.18.0"
+ "zod": "^3.21.4"
},
"devDependencies": {
"@backstage/cli": "workspace:^",
diff --git a/plugins/permission-node/CHANGELOG.md b/plugins/permission-node/CHANGELOG.md
index 59052c2184..3bd2cf06c4 100644
--- a/plugins/permission-node/CHANGELOG.md
+++ b/plugins/permission-node/CHANGELOG.md
@@ -1,5 +1,31 @@
# @backstage/plugin-permission-node
+## 0.7.7-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-auth-node@0.2.13-next.0
+ - @backstage/plugin-permission-common@0.7.4
+
+## 0.7.6
+
+### Patch Changes
+
+- 27a103ca07b: Changed the `createPermissionIntegrationRouter` API to allow `getResources`, `resourceType` and `rules` to be optional
+- 37e9215c793: Update the service-to-service auth docs URL in error message.
+ ``
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/plugin-auth-node@0.2.12
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/config@1.0.7
+
## 0.7.6-next.2
### Patch Changes
diff --git a/plugins/permission-node/api-report.md b/plugins/permission-node/api-report.md
index f89ff0a8d5..b3d06efdc7 100644
--- a/plugins/permission-node/api-report.md
+++ b/plugins/permission-node/api-report.md
@@ -73,6 +73,11 @@ export type ConditionTransformer = (
conditions: PermissionCriteria,
) => PermissionCriteria;
+// @public
+export const createConditionAuthorizer: (
+ rules: PermissionRule[],
+) => (decision: PolicyDecision, resource: TResource | undefined) => boolean;
+
// @public
export const createConditionExports: <
TResourceType extends string,
diff --git a/plugins/permission-node/package.json b/plugins/permission-node/package.json
index 92c0a7685a..23c24fe3cc 100644
--- a/plugins/permission-node/package.json
+++ b/plugins/permission-node/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-permission-node",
"description": "Common permission and authorization utilities for backend plugins",
- "version": "0.7.6-next.2",
+ "version": "0.7.7-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -41,8 +41,8 @@
"@types/express": "^4.17.6",
"express": "^4.17.1",
"express-promise-router": "^4.1.0",
- "zod": "~3.18.0",
- "zod-to-json-schema": "~3.18.0"
+ "zod": "^3.21.4",
+ "zod-to-json-schema": "^3.20.4"
},
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
diff --git a/plugins/permission-node/src/integration/createPermissionIntegrationRouter.test.ts b/plugins/permission-node/src/integration/createPermissionIntegrationRouter.test.ts
index 1a7462665e..6e28c5ddc4 100644
--- a/plugins/permission-node/src/integration/createPermissionIntegrationRouter.test.ts
+++ b/plugins/permission-node/src/integration/createPermissionIntegrationRouter.test.ts
@@ -25,6 +25,7 @@ import { z } from 'zod';
import {
createPermissionIntegrationRouter,
CreatePermissionIntegrationRouterResourceOptions,
+ createConditionAuthorizer,
} from './createPermissionIntegrationRouter';
import { createPermissionRule } from './createPermissionRule';
@@ -33,6 +34,9 @@ const testPermission: Permission = createPermission({
attributes: {},
});
+const mockTestRule1Apply = jest
+ .fn()
+ .mockImplementation((_resource: any, _params) => true);
const testRule1 = createPermissionRule({
name: 'test-rule-1',
description: 'Test rule 1',
@@ -41,15 +45,18 @@ const testRule1 = createPermissionRule({
foo: z.string(),
bar: z.number().describe('bar'),
}),
- apply: (_resource: any, _params) => true,
+ apply: mockTestRule1Apply,
toQuery: _params => ({}),
});
+const mockTestRule2Apply = jest
+ .fn()
+ .mockImplementation((_resource: any) => false);
const testRule2 = createPermissionRule({
name: 'test-rule-2',
description: 'Test rule 2',
resourceType: 'test-resource',
- apply: (_resource: any) => false,
+ apply: mockTestRule2Apply,
toQuery: () => ({}),
});
@@ -625,3 +632,72 @@ describe('createPermissionIntegrationRouter', () => {
});
});
});
+
+describe('createConditionAuthorizer', () => {
+ afterEach(() => {
+ jest.clearAllMocks();
+ });
+
+ it('should return true in case of allowed decision', () => {
+ const isAuthorized = createConditionAuthorizer([testRule1, testRule2]);
+ expect(
+ isAuthorized(
+ {
+ result: AuthorizeResult.ALLOW,
+ },
+ {},
+ ),
+ ).toBe(true);
+
+ expect(mockTestRule1Apply).not.toHaveBeenCalled();
+ expect(mockTestRule2Apply).not.toHaveBeenCalled();
+ });
+ it('should return false in case of denied decision', () => {
+ const isAuthorized = createConditionAuthorizer([testRule1, testRule2]);
+ expect(
+ isAuthorized(
+ {
+ result: AuthorizeResult.DENY,
+ },
+ {},
+ ),
+ ).toBe(false);
+
+ expect(mockTestRule1Apply).not.toHaveBeenCalled();
+ expect(mockTestRule2Apply).not.toHaveBeenCalled();
+ });
+
+ it('should apply conditions to a resource in case of conditional decision', () => {
+ const isAuthorized = createConditionAuthorizer([testRule1, testRule2]);
+ expect(
+ isAuthorized(
+ {
+ pluginId: 'plugin',
+ resourceType: 'test-resource',
+ result: AuthorizeResult.CONDITIONAL,
+ conditions: {
+ allOf: [
+ {
+ rule: 'test-rule-1',
+ resourceType: 'test-resource',
+ params: {
+ foo: 'a',
+ bar: 1,
+ },
+ },
+ {
+ rule: 'test-rule-2',
+ resourceType: 'test-resource',
+ params: {},
+ },
+ ],
+ },
+ },
+ {},
+ ),
+ ).toBe(false);
+
+ expect(mockTestRule1Apply).toHaveBeenCalledTimes(1);
+ expect(mockTestRule2Apply).toHaveBeenCalledTimes(1);
+ });
+});
diff --git a/plugins/permission-node/src/integration/createPermissionIntegrationRouter.ts b/plugins/permission-node/src/integration/createPermissionIntegrationRouter.ts
index 087de23198..850123d55e 100644
--- a/plugins/permission-node/src/integration/createPermissionIntegrationRouter.ts
+++ b/plugins/permission-node/src/integration/createPermissionIntegrationRouter.ts
@@ -27,6 +27,7 @@ import {
Permission,
PermissionCondition,
PermissionCriteria,
+ PolicyDecision,
} from '@backstage/plugin-permission-common';
import { PermissionRule } from '../types';
import {
@@ -160,6 +161,30 @@ const applyConditions = (
return rule.apply(resource, criteria.params ?? {});
};
+/**
+
+ * Takes some permission conditions and returns a definitive authorization result
+ * on the resource to which they apply.
+ *
+ * @public
+ */
+export const createConditionAuthorizer = (
+ rules: PermissionRule[],
+) => {
+ const getRule = createGetRule(rules);
+
+ return (
+ decision: PolicyDecision,
+ resource: TResource | undefined,
+ ): boolean => {
+ if (decision.result === AuthorizeResult.CONDITIONAL) {
+ return applyConditions(decision.conditions, resource, getRule);
+ }
+
+ return decision.result === AuthorizeResult.ALLOW;
+ };
+};
+
/**
* Options for creating a permission integration router specific
* for a particular resource type.
diff --git a/plugins/permission-react/CHANGELOG.md b/plugins/permission-react/CHANGELOG.md
index 31832e9a83..9da20a2875 100644
--- a/plugins/permission-react/CHANGELOG.md
+++ b/plugins/permission-react/CHANGELOG.md
@@ -1,5 +1,14 @@
# @backstage/plugin-permission-react
+## 0.4.11
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/config@1.0.7
+
## 0.4.11-next.2
### Patch Changes
diff --git a/plugins/permission-react/package.json b/plugins/permission-react/package.json
index 1d5d0713b7..afa4a4768e 100644
--- a/plugins/permission-react/package.json
+++ b/plugins/permission-react/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-permission-react",
- "version": "0.4.11-next.2",
+ "version": "0.4.11",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/playlist-backend/CHANGELOG.md b/plugins/playlist-backend/CHANGELOG.md
index da2697188a..51e419f0fb 100644
--- a/plugins/playlist-backend/CHANGELOG.md
+++ b/plugins/playlist-backend/CHANGELOG.md
@@ -1,5 +1,36 @@
# @backstage/plugin-playlist-backend
+## 0.2.7-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-auth-node@0.2.13-next.0
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/plugin-permission-node@0.7.7-next.0
+ - @backstage/plugin-playlist-common@0.1.5
+
+## 0.2.6
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/plugin-permission-node@0.7.6
+ - @backstage/plugin-auth-node@0.2.12
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/config@1.0.7
+ - @backstage/plugin-playlist-common@0.1.5
+
## 0.2.6-next.2
### Patch Changes
diff --git a/plugins/playlist-backend/package.json b/plugins/playlist-backend/package.json
index 2d868b950a..054651b841 100644
--- a/plugins/playlist-backend/package.json
+++ b/plugins/playlist-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-playlist-backend",
- "version": "0.2.6-next.2",
+ "version": "0.2.7-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -39,7 +39,7 @@
"uuid": "^8.2.0",
"winston": "^3.2.1",
"yn": "^4.0.0",
- "zod": "~3.18.0"
+ "zod": "^3.21.4"
},
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
diff --git a/plugins/playlist-common/CHANGELOG.md b/plugins/playlist-common/CHANGELOG.md
index 13e19e9204..15eebfc59b 100644
--- a/plugins/playlist-common/CHANGELOG.md
+++ b/plugins/playlist-common/CHANGELOG.md
@@ -1,5 +1,12 @@
# @backstage/plugin-playlist-common
+## 0.1.5
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-permission-common@0.7.4
+
## 0.1.5-next.0
### Patch Changes
diff --git a/plugins/playlist-common/package.json b/plugins/playlist-common/package.json
index 1bf0b8be27..440e46713d 100644
--- a/plugins/playlist-common/package.json
+++ b/plugins/playlist-common/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-playlist-common",
"description": "Common functionalities for the playlist plugin",
- "version": "0.1.5-next.0",
+ "version": "0.1.5",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/playlist/CHANGELOG.md b/plugins/playlist/CHANGELOG.md
index bc0263fd00..6e09f280bd 100644
--- a/plugins/playlist/CHANGELOG.md
+++ b/plugins/playlist/CHANGELOG.md
@@ -1,5 +1,42 @@
# @backstage/plugin-playlist
+## 0.1.8-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-search-react@1.5.2-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/plugin-permission-react@0.4.11
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/plugin-playlist-common@0.1.5
+
+## 0.1.7
+
+### Patch Changes
+
+- c10384a9235: Switch to using `LinkButton` instead of the deprecated `Button`
+- 122a37a880e: Internal update to work with newer versions of react-router
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/plugin-search-react@1.5.1
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/plugin-permission-common@0.7.4
+ - @backstage/theme@0.2.18
+ - @backstage/plugin-permission-react@0.4.11
+ - @backstage/plugin-playlist-common@0.1.5
+
## 0.1.7-next.2
### Patch Changes
diff --git a/plugins/playlist/package.json b/plugins/playlist/package.json
index 445171f9b8..4bf202bdba 100644
--- a/plugins/playlist/package.json
+++ b/plugins/playlist/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-playlist",
- "version": "0.1.7-next.2",
+ "version": "0.1.8-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -40,7 +40,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "^4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"lodash": "^4.17.21",
"qs": "^6.9.4",
"react-hook-form": "^7.13.0",
diff --git a/plugins/proxy-backend/CHANGELOG.md b/plugins/proxy-backend/CHANGELOG.md
index 8b649c44de..58d68eceab 100644
--- a/plugins/proxy-backend/CHANGELOG.md
+++ b/plugins/proxy-backend/CHANGELOG.md
@@ -1,5 +1,38 @@
# @backstage/plugin-proxy-backend
+## 0.2.38-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/backend-plugin-api@0.5.1-next.0
+
+## 0.2.37
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- 3e3eea4bc7e: The proxy-backend plugin now supports reviving request bodies that have previously been consumed by an express middleware (e.g. `express.json()`). This is done by setting `reviveConsumedRequestBodies: true` on the proxy `RouterOptions`. In order to preserve the current behavior, the proxy will **not** revive request bodies by default.
+
+ The following is an example of a proxy `createRouter` invocation that revives request bodies:
+
+ ```diff
+ const router = await createRouter({
+ config,
+ logger,
+ discovery,
+ + reviveConsumedRequestBodies: true,
+ });
+ ```
+
+- 4acd93dae1d: Ensure that `@backstage/plugin-proxy-backend` logs the requests that it proxies when log level is set to `debug`.
+- Updated dependencies
+ - @backstage/backend-common@0.18.3
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/config@1.0.7
+
## 0.2.37-next.2
### Patch Changes
diff --git a/plugins/proxy-backend/package.json b/plugins/proxy-backend/package.json
index a7d320c37c..11caccbff3 100644
--- a/plugins/proxy-backend/package.json
+++ b/plugins/proxy-backend/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-proxy-backend",
"description": "A Backstage backend plugin that helps you set up proxy endpoints in the backend",
- "version": "0.2.37-next.2",
+ "version": "0.2.38-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/rollbar-backend/CHANGELOG.md b/plugins/rollbar-backend/CHANGELOG.md
index edda54dcd1..f7f91fea98 100644
--- a/plugins/rollbar-backend/CHANGELOG.md
+++ b/plugins/rollbar-backend/CHANGELOG.md
@@ -1,5 +1,22 @@
# @backstage/plugin-rollbar-backend
+## 0.1.41-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+
+## 0.1.40
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/backend-common@0.18.3
+ - @backstage/config@1.0.7
+
## 0.1.40-next.2
### Patch Changes
diff --git a/plugins/rollbar-backend/package.json b/plugins/rollbar-backend/package.json
index 31d802dece..bec3819121 100644
--- a/plugins/rollbar-backend/package.json
+++ b/plugins/rollbar-backend/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-rollbar-backend",
"description": "A Backstage backend plugin that integrates towards Rollbar",
- "version": "0.1.40-next.2",
+ "version": "0.1.41-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/rollbar/CHANGELOG.md b/plugins/rollbar/CHANGELOG.md
index 943db21cce..24e85c8e77 100644
--- a/plugins/rollbar/CHANGELOG.md
+++ b/plugins/rollbar/CHANGELOG.md
@@ -1,5 +1,29 @@
# @backstage/plugin-rollbar
+## 0.4.17-next.0
+
+### Patch Changes
+
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
+## 0.4.16
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+
## 0.4.16-next.2
### Patch Changes
diff --git a/plugins/rollbar/package.json b/plugins/rollbar/package.json
index a3189c147d..4abd1b90f2 100644
--- a/plugins/rollbar/package.json
+++ b/plugins/rollbar/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-rollbar",
"description": "A Backstage plugin that integrates towards Rollbar",
- "version": "0.4.16-next.2",
+ "version": "0.4.17-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -40,7 +40,7 @@
"@backstage/theme": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"lodash": "^4.17.21",
"react-sparklines": "^1.7.0",
"react-use": "^17.2.4"
diff --git a/plugins/scaffolder-backend-module-confluence-to-markdown/.eslintrc.js b/plugins/scaffolder-backend-module-confluence-to-markdown/.eslintrc.js
new file mode 100644
index 0000000000..e2a53a6ad2
--- /dev/null
+++ b/plugins/scaffolder-backend-module-confluence-to-markdown/.eslintrc.js
@@ -0,0 +1 @@
+module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);
diff --git a/plugins/scaffolder-backend-module-confluence-to-markdown/README.md b/plugins/scaffolder-backend-module-confluence-to-markdown/README.md
new file mode 100644
index 0000000000..d9b235d6c1
--- /dev/null
+++ b/plugins/scaffolder-backend-module-confluence-to-markdown/README.md
@@ -0,0 +1,118 @@
+# @backstage/plugin-scaffolder-backend-module-confluence-to-markdown
+
+Welcome to the `confluence:transform:markdown` action for the `scaffolder-backend`.
+
+## Getting started
+
+You need to configure the action in your backend:
+
+## From your Backstage root directory
+
+```bash
+# From your Backstage root directory
+yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend-module-confluence-to-markdown
+```
+
+Configure the action:
+(you can check the [docs](https://backstage.io/docs/features/software-templates/writing-custom-actions#registering-custom-actions) to see all options):
+
+```typescript
+// packages/backend/src/plugins/scaffolder.ts
+
+import { createBuiltinActions } from '@backstage/plugin-scaffolder-backend';
+import { ScmIntegrations } from '@backstage/integration';
+import { createConfluenceToMarkdownAction } from '@backstage/plugin-scaffolder-backend-module-confluence-to-markdown';
+
+export default async function createPlugin(
+ env: PluginEnvironment,
+): Promise {
+ const catalogClient = new CatalogClient({ discoveryApi: env.discovery });
+ const integrations = ScmIntegrations.fromConfig(env.config);
+
+ const builtInActions = createBuiltinActions({
+ integrations,
+ catalogClient,
+ config: env.config,
+ reader: env.reader,
+ });
+
+ const actions = [
+ ...builtInActions,
+ createConfluenceToMarkdownAction({
+ integrations,
+ config: env.config,
+ reader: env.reader,
+ }),
+ ];
+
+ return createRouter({
+ actions,
+ catalogClient: catalogClient,
+ logger: env.logger,
+ config: env.config,
+ database: env.database,
+ reader: env.reader,
+ });
+}
+```
+
+You will also need an access token for authorization with `Read` permissions. You can create a Personal Access Token (PAT) in confluence and add the PAT to your `app-config.yaml`
+
+```yaml
+confluence:
+ baseUrl: ${CONFLUENCE_BASE_URL}
+ token: ${CONFLUENCE_TOKEN}
+```
+
+After that you can use the action in your template:
+
+```yaml
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+ name: confluence-to-markdown
+ title: Confluence to Markdown
+ description: This template converts a single confluence document to Markdown for Techdocs and adds it to a given GitHub repo.
+ tags:
+ - do-not-use
+ - poc
+spec:
+ owner:
+ type: service
+ parameters:
+ - title: Confluence and Github Repo Information
+ properties:
+ confluenceUrls:
+ type: array
+ description: Urls for confluence doc to be converted to markdown. In format /display//
+ items:
+ type: string
+ default: confluence url
+ ui:options:
+ addable: true
+ minItems: 1
+ maxItems: 5
+ repoUrl:
+ type: string
+ title: GitHub URL mkdocs.yaml link
+ description: The GitHub repo URL to your mkdocs.yaml file. Example
+ steps:
+ - id: create-docs
+ name: Get markdown file created and update markdown.yaml file
+ action: confluence:transform:markdown
+ input:
+ confluenceUrls: ${{ parameters.confluenceUrls }}
+ repoUrl: ${{ parameters.repoUrl }}
+ - id: publish
+ name: Publish PR to GitHub
+ action: publish:github:pull-request
+ input:
+ repoUrl: ?repo=${{ steps['create-docs'].output.repo }}&owner=${{ steps['create-docs'].output.owner }}
+ branchName: confluence-to-markdown
+ title: Confluence to Markdown
+ description: PR for converting confluence page to mkdocs
+```
+
+Replace `` with your GitHub URL without `https://`.
+
+You can find a list of all registered actions including their parameters at the /create/actions route in your Backstage application.
diff --git a/plugins/scaffolder-backend-module-confluence-to-markdown/api-report.md b/plugins/scaffolder-backend-module-confluence-to-markdown/api-report.md
new file mode 100644
index 0000000000..398beb5059
--- /dev/null
+++ b/plugins/scaffolder-backend-module-confluence-to-markdown/api-report.md
@@ -0,0 +1,20 @@
+## API Report File for "@backstage/plugin-scaffolder-backend-module-confluence-to-markdown"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { Config } from '@backstage/config';
+import { ScmIntegrations } from '@backstage/integration';
+import { TemplateAction } from '@backstage/plugin-scaffolder-node';
+import { UrlReader } from '@backstage/backend-common';
+
+// @public (undocumented)
+export const createConfluenceToMarkdownAction: (options: {
+ reader: UrlReader;
+ integrations: ScmIntegrations;
+ config: Config;
+}) => TemplateAction<{
+ confluenceUrls: string[];
+ repoUrl: string;
+}>;
+```
diff --git a/plugins/scaffolder-backend-module-confluence-to-markdown/package.json b/plugins/scaffolder-backend-module-confluence-to-markdown/package.json
new file mode 100644
index 0000000000..7ad5f127f6
--- /dev/null
+++ b/plugins/scaffolder-backend-module-confluence-to-markdown/package.json
@@ -0,0 +1,49 @@
+{
+ "name": "@backstage/plugin-scaffolder-backend-module-confluence-to-markdown",
+ "description": "The confluence-to-markdown module for @backstage/plugin-scaffolder-backend",
+ "version": "0.0.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"
+ },
+ "backstage": {
+ "role": "backend-plugin-module"
+ },
+ "scripts": {
+ "start": "backstage-cli package start",
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "clean": "backstage-cli package clean",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack",
+ "help": "backstage-cli help"
+ },
+ "dependencies": {
+ "@backstage/backend-common": "workspace:^",
+ "@backstage/config": "workspace:^",
+ "@backstage/errors": "workspace:^",
+ "@backstage/integration": "workspace:^",
+ "@backstage/plugin-scaffolder-backend": "workspace:^",
+ "@backstage/plugin-scaffolder-node": "workspace:^",
+ "@backstage/types": "workspace:^",
+ "fs-extra": "10.1.0",
+ "git-url-parse": "^13.1.0",
+ "node-fetch": "^2.6.7",
+ "node-html-markdown": "^1.3.0",
+ "yaml": "^2.0.0"
+ },
+ "devDependencies": {
+ "@backstage/cli": "workspace:^",
+ "@backstage/test-utils": "workspace:^",
+ "mock-fs": "^5.2.0",
+ "msw": "^1.0.0"
+ },
+ "files": [
+ "dist"
+ ]
+}
diff --git a/plugins/scaffolder-backend-module-confluence-to-markdown/src/actions/confluence/confluenceToMarkdown.test.ts b/plugins/scaffolder-backend-module-confluence-to-markdown/src/actions/confluence/confluenceToMarkdown.test.ts
new file mode 100644
index 0000000000..b95d8ae520
--- /dev/null
+++ b/plugins/scaffolder-backend-module-confluence-to-markdown/src/actions/confluence/confluenceToMarkdown.test.ts
@@ -0,0 +1,294 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { PassThrough } from 'stream';
+import { createConfluenceToMarkdownAction } from './confluenceToMarkdown';
+import { getVoidLogger } from '@backstage/backend-common';
+import { UrlReader } from '@backstage/backend-common';
+import { ConfigReader } from '@backstage/config';
+import { ScmIntegrations } from '@backstage/integration';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
+import mockFs from 'mock-fs';
+import os from 'os';
+import type { ActionContext } from '@backstage/plugin-scaffolder-node';
+import { readFile, writeFile, createWriteStream } from 'fs-extra';
+import { rest } from 'msw';
+import { setupServer } from 'msw/node';
+
+jest.mock('fs-extra', () => ({
+ mkdirSync: jest.fn(),
+ readFile: jest.fn().mockResolvedValue('File contents'),
+ writeFile: jest.fn().mockImplementation(() => {
+ return Promise.resolve();
+ }),
+ outputFile: jest.fn(),
+ openSync: jest.fn(),
+ createWriteStream: jest.fn().mockReturnValue(new PassThrough()),
+ ensureDir: jest.fn(),
+}));
+
+describe('confluence:transform:markdown', () => {
+ const baseUrl = `https://nodomain.confluence.com`;
+ const worker = setupServer();
+ setupRequestMockHandlers(worker);
+
+ const config = new ConfigReader({
+ confluence: {
+ baseUrl: baseUrl,
+ token: 'fake_token',
+ },
+ });
+
+ const integrations = ScmIntegrations.fromConfig(
+ new ConfigReader({
+ integrations: {
+ github: [{ host: 'github.com', token: 'token' }],
+ },
+ }),
+ );
+
+ let reader: UrlReader;
+ let mockContext: ActionContext<{
+ confluenceUrls: string[];
+ repoUrl: string;
+ }>;
+
+ const logger = getVoidLogger();
+ jest.spyOn(logger, 'info');
+
+ const mockTmpDir = os.tmpdir();
+
+ beforeEach(() => {
+ reader = {
+ readUrl: jest.fn(),
+ readTree: jest.fn().mockResolvedValue({
+ dir: jest.fn(),
+ }),
+ search: jest.fn(),
+ };
+ mockContext = {
+ input: {
+ confluenceUrls: [
+ 'https://nodomain.confluence.com/display/testing/mkdocs',
+ ],
+ repoUrl: 'https://notreal.github.com/space/backstage/mkdocs.yml',
+ },
+ workspacePath: '/tmp',
+ logger,
+ logStream: new PassThrough(),
+ output: jest.fn(),
+ createTemporaryDirectory: jest.fn().mockResolvedValue(mockTmpDir),
+ };
+ mockFs({ [`${mockTmpDir}/src/docs`]: {} });
+ });
+ afterEach(() => {
+ jest.clearAllMocks();
+ mockFs.restore();
+ });
+
+ it('should call confluence to markdown action successfully with results array', async () => {
+ const options = {
+ reader,
+ integrations,
+ config,
+ };
+ const responseBody = {
+ results: [
+ {
+ id: '4444444',
+ type: 'page',
+ title: 'Testing',
+ body: {
+ export_view: {
+ value: '/display//`',
+ );
+};
diff --git a/plugins/scaffolder-backend-module-confluence-to-markdown/src/actions/confluence/index.ts b/plugins/scaffolder-backend-module-confluence-to-markdown/src/actions/confluence/index.ts
new file mode 100644
index 0000000000..00f00eabda
--- /dev/null
+++ b/plugins/scaffolder-backend-module-confluence-to-markdown/src/actions/confluence/index.ts
@@ -0,0 +1,16 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export { createConfluenceToMarkdownAction } from './confluenceToMarkdown';
diff --git a/plugins/scaffolder-backend-module-confluence-to-markdown/src/actions/index.ts b/plugins/scaffolder-backend-module-confluence-to-markdown/src/actions/index.ts
new file mode 100644
index 0000000000..3d3a6c73a0
--- /dev/null
+++ b/plugins/scaffolder-backend-module-confluence-to-markdown/src/actions/index.ts
@@ -0,0 +1,16 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from './confluence';
diff --git a/plugins/scaffolder-backend-module-confluence-to-markdown/src/index.ts b/plugins/scaffolder-backend-module-confluence-to-markdown/src/index.ts
new file mode 100644
index 0000000000..80d2e35cb3
--- /dev/null
+++ b/plugins/scaffolder-backend-module-confluence-to-markdown/src/index.ts
@@ -0,0 +1,23 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * The confluence-to-markdown module for \@backstage/plugin-scaffolder-backend.
+ *
+ * @packageDocumentation
+ */
+
+export * from './actions';
diff --git a/plugins/scaffolder-backend-module-cookiecutter/CHANGELOG.md b/plugins/scaffolder-backend-module-cookiecutter/CHANGELOG.md
index 2dcb0eb279..b03b35dc72 100644
--- a/plugins/scaffolder-backend-module-cookiecutter/CHANGELOG.md
+++ b/plugins/scaffolder-backend-module-cookiecutter/CHANGELOG.md
@@ -1,5 +1,33 @@
# @backstage/plugin-scaffolder-backend-module-cookiecutter
+## 0.2.19-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-backend@1.12.1-next.0
+ - @backstage/plugin-scaffolder-node@0.1.2-next.0
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+
+## 0.2.18
+
+### Patch Changes
+
+- 62414770ead: allow container runner to be undefined in cookiecutter plugin
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+ - @backstage/plugin-scaffolder-backend@1.12.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/integration@1.4.3
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+ - @backstage/plugin-scaffolder-node@0.1.1
+
## 0.2.18-next.2
### Patch Changes
diff --git a/plugins/scaffolder-backend-module-cookiecutter/package.json b/plugins/scaffolder-backend-module-cookiecutter/package.json
index 373320191a..c78cdae972 100644
--- a/plugins/scaffolder-backend-module-cookiecutter/package.json
+++ b/plugins/scaffolder-backend-module-cookiecutter/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-scaffolder-backend-module-cookiecutter",
"description": "A module for the scaffolder backend that lets you template projects using cookiecutter",
- "version": "0.2.18-next.2",
+ "version": "0.2.19-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/scaffolder-backend-module-gitlab/.eslintrc.js b/plugins/scaffolder-backend-module-gitlab/.eslintrc.js
new file mode 100644
index 0000000000..e2a53a6ad2
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gitlab/.eslintrc.js
@@ -0,0 +1 @@
+module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);
diff --git a/plugins/scaffolder-backend-module-gitlab/CHANGELOG.md b/plugins/scaffolder-backend-module-gitlab/CHANGELOG.md
new file mode 100644
index 0000000000..9bd33f6aae
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gitlab/CHANGELOG.md
@@ -0,0 +1,15 @@
+# @backstage/plugin-scaffolder-backend-module-gitlab
+
+## 0.1.0-next.0
+
+### Minor Changes
+
+- 1ad400bb2de: Add Gitlab Scaffolder Plugin
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-node@0.1.2-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/errors@1.1.5
diff --git a/plugins/scaffolder-backend-module-gitlab/README.md b/plugins/scaffolder-backend-module-gitlab/README.md
new file mode 100644
index 0000000000..35353cf9c1
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gitlab/README.md
@@ -0,0 +1,162 @@
+# scaffolder-backend-module-gitlab
+
+Welcome to the Gitlab Module for Scaffolder.
+
+Here you can find all Gitlab related features to improve your scaffolder:
+
+## Getting started
+
+## From your Backstage root directory
+
+```bash
+# From your Backstage root directory
+yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend-module-gitlab
+```
+
+Configure the action:
+(you can check the [docs](https://backstage.io/docs/features/software-templates/writing-custom-actions#registering-custom-actions) to see all options):
+
+```typescript
+// packages/backend/src/plugins/scaffolder.ts
+
+import {
+ createGitlabProjectAccessTokenAction,
+ createGitlabProjectAccessTokenAction,
+ createGitlabProjectDeployTokenAction,
+} from '@backstage/plugin-scaffolder-backend-module-gitlab';
+
+// Create BuiltIn Actions
+const builtInActions = createBuiltinActions({
+ integrations,
+ catalogClient,
+ config: env.config,
+ reader: env.reader,
+});
+
+// Add Gitlab Actions
+const actions = [
+ ...builtInActions,
+ createGitlabProjectAccessTokenAction({
+ integrations: integrations,
+ }),
+ createGitlabProjectAccessTokenAction({
+ integrations: integrations,
+ }),
+ createGitlabProjectDeployTokenAction({
+ integrations: integrations,
+ }),
+];
+
+// Create Scaffolder Router
+return await createRouter({
+ containerRunner,
+ catalogClient,
+ actions,
+ logger: env.logger,
+ config: env.config,
+ database: env.database,
+ reader: env.reader,
+});
+```
+
+After that you can use the action in your template:
+
+```yaml
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+ name: gitlab-demo
+ title: Gitlab DEMO
+ description: Scaffolder Gitlab Demo
+spec:
+ owner: backstage/techdocs-core
+ type: service
+
+ parameters:
+ - title: Fill in some steps
+ required:
+ - name
+ properties:
+ name:
+ title: Name
+ type: string
+ description: Unique name of the component
+ ui:autofocus: true
+ ui:options:
+ rows: 5
+ - title: Choose a location
+ required:
+ - repoUrl
+ properties:
+ repoUrl:
+ title: Repository Location
+ type: string
+ ui:field: RepoUrlPicker
+ ui:options:
+ allowedHosts:
+ - gitlab.com
+
+ steps:
+ - id: fetch
+ name: Fetch
+ action: fetch:template
+ input:
+ url: https://github.com/TEMPLATE
+ values:
+ name: ${{ parameters.name }}
+
+ - id: publish
+ name: Publish
+ action: publish:gitlab
+ input:
+ description: This is ${{ parameters.name }}
+ repoUrl: ${{ parameters.repoUrl }}
+ sourcePath: pimcore
+ defaultBranch: main
+
+ - id: gitlab-deploy-token
+ name: Create Deploy Token
+ action: gitlab:projectDeployToken:create
+ input:
+ repoUrl: ${{ parameters.repoUrl }}
+ projectId: "${{ steps['publish'].output.projectId }}"
+ name: ${{ parameters.name }}-secret
+ username: ${{ parameters.name }}-secret
+ scopes: ['read_registry']
+
+ - id: gitlab-access-token
+ name: Gitlab Project Access Token
+ action: gitlab:projectAccessToken:create
+ input:
+ repoUrl: ${{ parameters.repoUrl }}
+ projectId: "${{ steps['publish-manifest'].output.projectId }}"
+ name: ${{ parameters.name }}-access-token
+ accessLevel: 40
+ scopes: ['read_repository', 'write_repository']
+
+ - id: gitlab-project-variable
+ name: Gitlab Project Variable
+ action: gitlab:projectVariable:create
+ input:
+ repoUrl: ${{ parameters.repoUrl }}
+ projectId: "${{ steps['publish'].output.projectId }}"
+ key: 'VARIABLE_NAME'
+ value: "${{ steps['gitlab-access-token'].output.access_token }}"
+ variableType: 'env_var'
+ masked: true
+ variableProtected: false
+ raw: false
+ environmentScope: '*'
+
+ - id: register
+ name: Register
+ action: catalog:register
+ input:
+ repoContentsUrl: ${{ steps['publish'].output.repoContentsUrl }}
+ catalogInfoPath: '/catalog-info.yaml'
+
+ output:
+ links:
+ - title: Repository
+ url: ${{ steps['publish'].output.remoteUrl }}
+```
diff --git a/plugins/scaffolder-backend-module-gitlab/api-report.md b/plugins/scaffolder-backend-module-gitlab/api-report.md
new file mode 100644
index 0000000000..6db732fdcc
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gitlab/api-report.md
@@ -0,0 +1,48 @@
+## API Report File for "@backstage/plugin-scaffolder-backend-module-gitlab"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { ScmIntegrationRegistry } from '@backstage/integration';
+import { TemplateAction } from '@backstage/plugin-scaffolder-node';
+
+// @public
+export const createGitlabProjectAccessTokenAction: (options: {
+ integrations: ScmIntegrationRegistry;
+}) => TemplateAction<{
+ repoUrl: string;
+ projectId: string | number;
+ name: string;
+ accessLevel: number;
+ scopes: string[];
+ token?: string | undefined;
+}>;
+
+// @public
+export const createGitlabProjectDeployTokenAction: (options: {
+ integrations: ScmIntegrationRegistry;
+}) => TemplateAction<{
+ repoUrl: string;
+ projectId: string | number;
+ name: string;
+ username: string;
+ scopes: string[];
+ token?: string | undefined;
+}>;
+
+// @public
+export const createGitlabProjectVariableAction: (options: {
+ integrations: ScmIntegrationRegistry;
+}) => TemplateAction<{
+ repoUrl: string;
+ projectId: string | number;
+ key: string;
+ value: string;
+ variableType: string;
+ variableProtected: boolean;
+ masked: boolean;
+ raw: boolean;
+ environmentScope: string;
+ token?: string | undefined;
+}>;
+```
diff --git a/plugins/scaffolder-backend-module-gitlab/package.json b/plugins/scaffolder-backend-module-gitlab/package.json
new file mode 100644
index 0000000000..e870ba57a0
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gitlab/package.json
@@ -0,0 +1,48 @@
+{
+ "name": "@backstage/plugin-scaffolder-backend-module-gitlab",
+ "version": "0.1.0-next.0",
+ "main": "src/index.ts",
+ "types": "src/index.ts",
+ "license": "Apache-2.0",
+ "publishConfig": {
+ "access": "public",
+ "main": "dist/index.esm.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/scaffolder-backend-module-gitlab"
+ },
+ "keywords": [
+ "backstage"
+ ],
+ "scripts": {
+ "start": "backstage-cli package start",
+ "build": "backstage-cli package build",
+ "lint": "backstage-cli package lint",
+ "test": "backstage-cli package test",
+ "clean": "backstage-cli package clean",
+ "prepack": "backstage-cli package prepack",
+ "postpack": "backstage-cli package postpack"
+ },
+ "dependencies": {
+ "@backstage/config": "workspace:^",
+ "@backstage/errors": "workspace:^",
+ "@backstage/integration": "workspace:^",
+ "@backstage/plugin-scaffolder-node": "workspace:^",
+ "@gitbeaker/node": "^35.8.0"
+ },
+ "devDependencies": {
+ "@backstage/backend-common": "workspace:^",
+ "@backstage/cli": "workspace:^",
+ "@backstage/core-app-api": "workspace:^"
+ },
+ "files": [
+ "dist"
+ ]
+}
diff --git a/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabProjectAccessTokenAction.ts b/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabProjectAccessTokenAction.ts
new file mode 100644
index 0000000000..0f39e3bc33
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabProjectAccessTokenAction.ts
@@ -0,0 +1,112 @@
+/*
+ * 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 { createTemplateAction } from '@backstage/plugin-scaffolder-node';
+import { ScmIntegrationRegistry } from '@backstage/integration';
+import { getToken } from '../util';
+
+/**
+ * Creates a `gitlab:create-project-access-token` Scaffolder action.
+ *
+ * @param options - Templating configuration.
+ * @public
+ */
+export const createGitlabProjectAccessTokenAction = (options: {
+ integrations: ScmIntegrationRegistry;
+}) => {
+ const { integrations } = options;
+ return createTemplateAction<{
+ repoUrl: string;
+ projectId: string | number;
+ name: string;
+ accessLevel: number;
+ scopes: string[];
+ token?: string;
+ }>({
+ id: 'gitlab:projectAccessToken:create',
+ schema: {
+ input: {
+ required: ['projectId', 'repoUrl'],
+ type: 'object',
+ properties: {
+ repoUrl: {
+ title: 'Repository Location',
+ type: 'string',
+ },
+ projectId: {
+ title: 'Project ID',
+ type: ['string', 'number'],
+ },
+ name: {
+ title: 'Deploy Token Name',
+ type: 'string',
+ },
+ accessLevel: {
+ title: 'Access Level of the Token',
+ type: 'number',
+ },
+ scopes: {
+ title: 'Scopes',
+ type: 'array',
+ },
+ token: {
+ title: 'Authentication Token',
+ type: 'string',
+ description: 'The token to use for authorization to GitLab',
+ },
+ },
+ },
+ output: {
+ type: 'object',
+ properties: {
+ access_token: {
+ title: 'Access Token',
+ type: 'string',
+ },
+ },
+ },
+ },
+ async handler(ctx) {
+ ctx.logger.info(`Creating Token for Project "${ctx.input.projectId}"`);
+ const { repoUrl, projectId, name, accessLevel, scopes } = ctx.input;
+ const { token, integrationConfig } = getToken(
+ repoUrl,
+ ctx.input.token,
+ integrations,
+ );
+
+ const response = await fetch(
+ `${integrationConfig.config.baseUrl}/api/v4/projects/${projectId}/access_tokens`,
+ {
+ method: 'POST', // *GET, POST, PUT, DELETE, etc.
+ headers: {
+ 'PRIVATE-TOKEN': token,
+ 'Content-Type': 'application/json',
+ },
+ body: JSON.stringify({
+ name: name,
+ scopes: scopes,
+ access_level: accessLevel,
+ }),
+ },
+ );
+
+ const result = await response.json();
+
+ ctx.output('access_token', result.token);
+ },
+ });
+};
diff --git a/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabProjectDeployTokenAction.test.ts b/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabProjectDeployTokenAction.test.ts
new file mode 100644
index 0000000000..1d3ae804c1
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabProjectDeployTokenAction.test.ts
@@ -0,0 +1,101 @@
+/*
+ * 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 { createGitlabProjectDeployTokenAction } from './createGitlabProjectDeployTokenAction';
+import { ScmIntegrations } from '@backstage/integration';
+import { ConfigReader } from '@backstage/config';
+import { getVoidLogger } from '@backstage/backend-common';
+import { PassThrough } from 'stream';
+
+const mockGitlabClient = {
+ ProjectDeployTokens: {
+ add: jest.fn(),
+ },
+};
+jest.mock('@gitbeaker/node', () => ({
+ Gitlab: class {
+ constructor() {
+ return mockGitlabClient;
+ }
+ },
+}));
+
+describe('gitlab:create-deploy-token', () => {
+ const config = new ConfigReader({
+ integrations: {
+ gitlab: [
+ {
+ host: 'gitlab.com',
+ token: 'tokenlols',
+ apiBaseUrl: 'https://api.gitlab.com',
+ },
+ {
+ host: 'hosted.gitlab.com',
+ apiBaseUrl: 'https://api.hosted.gitlab.com',
+ },
+ ],
+ },
+ });
+
+ const integrations = ScmIntegrations.fromConfig(config);
+ const action = createGitlabProjectDeployTokenAction({ integrations });
+ const mockContext = {
+ input: {
+ repoUrl: 'gitlab.com?repo=repo&owner=owner',
+ projectId: '123',
+ name: 'tokenname',
+ username: 'tokenuser',
+ scopes: ['read_repository'],
+ },
+ workspacePath: 'lol',
+ logger: getVoidLogger(),
+ logStream: new PassThrough(),
+ output: jest.fn(),
+ createTemporaryDirectory: jest.fn(),
+ };
+
+ beforeEach(() => {
+ jest.resetAllMocks();
+ });
+
+ it('should work when there is a token provided through ctx.input', async () => {
+ mockGitlabClient.ProjectDeployTokens.add.mockResolvedValue({
+ token: 'TOKEN',
+ username: 'User',
+ });
+
+ await action.handler({
+ ...mockContext,
+ input: {
+ repoUrl: 'hosted.gitlab.com?repo=bob&owner=owner',
+ projectId: '123',
+ name: 'tokenname',
+ username: 'tokenuser',
+ scopes: ['read_repository'],
+ },
+ });
+
+ expect(mockGitlabClient.ProjectDeployTokens.add).toHaveBeenCalledWith(
+ '123',
+ 'tokenname',
+ ['read_repository'],
+ { username: 'tokenuser' },
+ );
+
+ expect(mockContext.output).toHaveBeenCalledWith('deploy_token', 'TOKEN');
+ expect(mockContext.output).toHaveBeenCalledWith('user', 'User');
+ });
+});
diff --git a/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabProjectDeployTokenAction.ts b/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabProjectDeployTokenAction.ts
new file mode 100644
index 0000000000..35a53c87e2
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabProjectDeployTokenAction.ts
@@ -0,0 +1,120 @@
+/*
+ * 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 { createTemplateAction } from '@backstage/plugin-scaffolder-node';
+import { Gitlab } from '@gitbeaker/node';
+import { ScmIntegrationRegistry } from '@backstage/integration';
+import { DeployTokenScope } from '@gitbeaker/core/dist/types/templates/ResourceDeployTokens';
+import { getToken } from '../util';
+import { InputError } from '@backstage/errors';
+
+/**
+ * Creates a `gitlab:create-project-deploy-token` Scaffolder action.
+ *
+ * @param options - Templating configuration.
+ * @public
+ */
+export const createGitlabProjectDeployTokenAction = (options: {
+ integrations: ScmIntegrationRegistry;
+}) => {
+ const { integrations } = options;
+ return createTemplateAction<{
+ repoUrl: string;
+ projectId: string | number;
+ name: string;
+ username: string;
+ scopes: string[];
+ token?: string;
+ }>({
+ id: 'gitlab:projectDeployToken:create',
+ schema: {
+ input: {
+ required: ['projectId', 'repoUrl'],
+ type: 'object',
+ properties: {
+ repoUrl: {
+ title: 'Repository Location',
+ type: 'string',
+ },
+ projectId: {
+ title: 'Project ID',
+ type: ['string', 'number'],
+ },
+ name: {
+ title: 'Deploy Token Name',
+ type: 'string',
+ },
+ username: {
+ title: 'Deploy Token Username',
+ type: 'string',
+ },
+ scopes: {
+ title: 'Scopes',
+ type: 'array',
+ },
+ token: {
+ title: 'Authentication Token',
+ type: 'string',
+ description: 'The token to use for authorization to GitLab',
+ },
+ },
+ },
+ output: {
+ type: 'object',
+ properties: {
+ deploy_token: {
+ title: 'Deploy Token',
+ type: 'string',
+ },
+ user: {
+ title: 'User',
+ type: 'string',
+ },
+ },
+ },
+ },
+ async handler(ctx) {
+ ctx.logger.info(`Creating Token for Project "${ctx.input.projectId}"`);
+ const { repoUrl, projectId, name, username, scopes } = ctx.input;
+ const { token, integrationConfig } = getToken(
+ repoUrl,
+ ctx.input.token,
+ integrations,
+ );
+
+ const api = new Gitlab({
+ host: integrationConfig.config.baseUrl,
+ token: token,
+ });
+
+ const deployToken = await api.ProjectDeployTokens.add(
+ projectId,
+ name,
+ scopes as DeployTokenScope[],
+ {
+ username: username,
+ },
+ );
+
+ if (!deployToken.hasOwnProperty('token')) {
+ throw new InputError(`No deploy_token given from gitlab instance`);
+ }
+
+ ctx.output('deploy_token', deployToken.token as string);
+ ctx.output('user', deployToken.username);
+ },
+ });
+};
diff --git a/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabProjectVariableAction.ts b/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabProjectVariableAction.ts
new file mode 100644
index 0000000000..847bbc2057
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabProjectVariableAction.ts
@@ -0,0 +1,139 @@
+/*
+ * 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 { createTemplateAction } from '@backstage/plugin-scaffolder-node';
+import { ScmIntegrationRegistry } from '@backstage/integration';
+import { getToken } from '../util';
+import { Gitlab } from '@gitbeaker/node';
+
+/**
+ * Creates a `gitlab:create-project-variable` Scaffolder action.
+ *
+ * @param options - Templating configuration.
+ * @public
+ */
+export const createGitlabProjectVariableAction = (options: {
+ integrations: ScmIntegrationRegistry;
+}) => {
+ const { integrations } = options;
+ return createTemplateAction<{
+ repoUrl: string;
+ projectId: string | number;
+ key: string;
+ value: string;
+ variableType: string;
+ variableProtected: boolean;
+ masked: boolean;
+ raw: boolean;
+ environmentScope: string;
+ token?: string;
+ }>({
+ id: 'gitlab:projectVariable:create',
+ schema: {
+ input: {
+ required: [
+ 'repoUrl',
+ 'projectId',
+ 'key',
+ 'value',
+ 'variableType',
+ 'variableProtected',
+ 'masked',
+ 'raw',
+ 'environmentScope',
+ ],
+ type: 'object',
+ properties: {
+ repoUrl: {
+ title: 'Repository Location',
+ type: 'string',
+ },
+ projectId: {
+ title: 'Project ID',
+ type: ['string', 'number'],
+ },
+ key: {
+ title:
+ 'The key of a variable; must have no more than 255 characters; only A-Z, a-z, 0-9, and _ are allowed',
+ type: 'string',
+ },
+ value: {
+ title: 'The value of a variable',
+ type: 'string',
+ },
+ variableType: {
+ title: 'Variable Type (env_var or file)',
+ type: 'string',
+ },
+ variableProtected: {
+ title: 'Whether the variable is protected. Default: false',
+ type: 'boolean',
+ },
+ masked: {
+ title: 'Whether the variable is masked. Default: false',
+ type: 'boolean',
+ },
+ raw: {
+ title: 'Whether the variable is expandable. Default: false',
+ type: 'boolean',
+ },
+ environmentScope: {
+ title: 'The environment_scope of the variable. Default: *',
+ type: 'string',
+ },
+ token: {
+ title: 'Authentication Token',
+ type: 'string',
+ description: 'The token to use for authorization to GitLab',
+ },
+ },
+ },
+ },
+ async handler(ctx) {
+ const {
+ repoUrl,
+ projectId,
+ key,
+ value,
+ variableType,
+ variableProtected,
+ masked,
+ raw,
+ environmentScope,
+ } = ctx.input;
+ const { token, integrationConfig } = getToken(
+ repoUrl,
+ ctx.input.token,
+ integrations,
+ );
+
+ const api = new Gitlab({
+ host: integrationConfig.config.baseUrl,
+ token: token,
+ });
+
+ await api.ProjectVariables.create(projectId, {
+ key: key,
+ value: value,
+ variable_type: variableType,
+ protected: variableProtected,
+ masked: masked,
+ raw: raw,
+ environment_scope: environmentScope,
+ });
+ },
+ });
+};
diff --git a/plugins/scaffolder-backend-module-gitlab/src/index.ts b/plugins/scaffolder-backend-module-gitlab/src/index.ts
new file mode 100644
index 0000000000..11209e19bd
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gitlab/src/index.ts
@@ -0,0 +1,24 @@
+/*
+ * 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.
+ */
+/**
+ * A module for the scaffolder backend that lets you create gitlab project access tokens or deploy tokens
+ *
+ * @packageDocumentation
+ */
+
+export * from './actions/createGitlabProjectDeployTokenAction';
+export * from './actions/createGitlabProjectAccessTokenAction';
+export * from './actions/createGitlabProjectVariableAction';
diff --git a/plugins/scaffolder-backend-module-gitlab/src/util.ts b/plugins/scaffolder-backend-module-gitlab/src/util.ts
new file mode 100644
index 0000000000..fc6667d6d3
--- /dev/null
+++ b/plugins/scaffolder-backend-module-gitlab/src/util.ts
@@ -0,0 +1,57 @@
+/*
+ * 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 { InputError } from '@backstage/errors';
+import {
+ GitLabIntegration,
+ ScmIntegrationRegistry,
+} from '@backstage/integration';
+
+export const parseRepoHost = (repoUrl: string): string => {
+ let parsed;
+ try {
+ parsed = new URL(`https://${repoUrl}`);
+ } catch (error) {
+ throw new InputError(
+ `Invalid repo URL passed to publisher, got ${repoUrl}, ${error}`,
+ );
+ }
+ return parsed.host;
+};
+
+export const getToken = (
+ repoUrl: string,
+ inputToken: string | null | undefined,
+ integrations: ScmIntegrationRegistry,
+): { token: string; integrationConfig: GitLabIntegration } => {
+ const host = parseRepoHost(repoUrl);
+ const integrationConfig = integrations.gitlab.byHost(host);
+
+ if (!integrationConfig) {
+ throw new InputError(
+ `No matching integration configuration for host ${host}, please check your integrations config`,
+ );
+ }
+
+ const token = inputToken || integrationConfig.config.token!;
+ const tokenType = inputToken ? 'oauthToken' : 'token';
+
+ if (tokenType === 'oauthToken') {
+ throw new InputError(`OAuth Token is currently not supported`);
+ }
+
+ return { token: token, integrationConfig: integrationConfig };
+};
diff --git a/plugins/scaffolder-backend-module-rails/CHANGELOG.md b/plugins/scaffolder-backend-module-rails/CHANGELOG.md
index 5c7fb1dc2d..bd3509dbd0 100644
--- a/plugins/scaffolder-backend-module-rails/CHANGELOG.md
+++ b/plugins/scaffolder-backend-module-rails/CHANGELOG.md
@@ -1,5 +1,31 @@
# @backstage/plugin-scaffolder-backend-module-rails
+## 0.4.12-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-backend@1.12.1-next.0
+ - @backstage/plugin-scaffolder-node@0.1.2-next.0
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+
+## 0.4.11
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-backend@1.12.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/integration@1.4.3
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+ - @backstage/plugin-scaffolder-node@0.1.1
+
## 0.4.11-next.2
### Patch Changes
diff --git a/plugins/scaffolder-backend-module-rails/package.json b/plugins/scaffolder-backend-module-rails/package.json
index be9d053340..aa1a178d9d 100644
--- a/plugins/scaffolder-backend-module-rails/package.json
+++ b/plugins/scaffolder-backend-module-rails/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-scaffolder-backend-module-rails",
"description": "A module for the scaffolder backend that lets you template projects using Rails",
- "version": "0.4.11-next.2",
+ "version": "0.4.12-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/scaffolder-backend-module-sentry/CHANGELOG.md b/plugins/scaffolder-backend-module-sentry/CHANGELOG.md
index ae6d8734c9..67772961ab 100644
--- a/plugins/scaffolder-backend-module-sentry/CHANGELOG.md
+++ b/plugins/scaffolder-backend-module-sentry/CHANGELOG.md
@@ -1,5 +1,23 @@
# @backstage/plugin-scaffolder-backend-module-sentry
+## 0.1.4-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-node@0.1.2-next.0
+ - @backstage/config@1.0.7
+ - @backstage/errors@1.1.5
+
+## 0.1.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/errors@1.1.5
+ - @backstage/config@1.0.7
+ - @backstage/plugin-scaffolder-node@0.1.1
+
## 0.1.3-next.2
### Patch Changes
diff --git a/plugins/scaffolder-backend-module-sentry/package.json b/plugins/scaffolder-backend-module-sentry/package.json
index 36f5139b28..6f04036110 100644
--- a/plugins/scaffolder-backend-module-sentry/package.json
+++ b/plugins/scaffolder-backend-module-sentry/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-scaffolder-backend-module-sentry",
- "version": "0.1.3-next.2",
+ "version": "0.1.4-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/scaffolder-backend-module-yeoman/CHANGELOG.md b/plugins/scaffolder-backend-module-yeoman/CHANGELOG.md
index e87cf64167..2948bbc79b 100644
--- a/plugins/scaffolder-backend-module-yeoman/CHANGELOG.md
+++ b/plugins/scaffolder-backend-module-yeoman/CHANGELOG.md
@@ -1,5 +1,23 @@
# @backstage/plugin-scaffolder-backend-module-yeoman
+## 0.2.17-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-scaffolder-node@0.1.2-next.0
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+
+## 0.2.16
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+ - @backstage/plugin-scaffolder-node@0.1.1
+
## 0.2.16-next.2
### Patch Changes
diff --git a/plugins/scaffolder-backend-module-yeoman/package.json b/plugins/scaffolder-backend-module-yeoman/package.json
index 01ba3f5eea..50db3c38d0 100644
--- a/plugins/scaffolder-backend-module-yeoman/package.json
+++ b/plugins/scaffolder-backend-module-yeoman/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-scaffolder-backend-module-yeoman",
- "version": "0.2.16-next.2",
+ "version": "0.2.17-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/scaffolder-backend/CHANGELOG.md b/plugins/scaffolder-backend/CHANGELOG.md
index 65a827797f..89bfc23549 100644
--- a/plugins/scaffolder-backend/CHANGELOG.md
+++ b/plugins/scaffolder-backend/CHANGELOG.md
@@ -1,5 +1,60 @@
# @backstage/plugin-scaffolder-backend
+## 1.12.1-next.0
+
+### Patch Changes
+
+- e23abb37ec1: Rename output parameter `mergeRequestURL` of `publish:gitlab:merge-request` action to `mergeRequestUrl`.
+- e27ddc36dad: Added a possibility to cancel the running task (executing of a scaffolder template)
+- c9a0fdcd2c8: Fix deprecated types.
+- Updated dependencies
+ - @backstage/plugin-scaffolder-node@0.1.2-next.0
+ - @backstage/plugin-scaffolder-common@1.2.7-next.0
+ - @backstage/plugin-catalog-backend@1.8.1-next.0
+ - @backstage/backend-common@0.18.4-next.0
+ - @backstage/config@1.0.7
+ - @backstage/integration@1.4.3
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/backend-tasks@0.5.1-next.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/types@1.0.2
+ - @backstage/plugin-auth-node@0.2.13-next.0
+ - @backstage/plugin-catalog-common@1.0.12
+ - @backstage/plugin-catalog-node@1.3.5-next.0
+
+## 1.12.0
+
+### Minor Changes
+
+- 7d724d8ef56: Added the ability to be able to define an actions `input` and `output` schema using `zod` instead of hand writing types and `jsonschema`
+
+### Patch Changes
+
+- 860de10fa67: Make identity valid if subject of token is a backstage server-2-server auth token
+- 65454876fb2: Minor API report tweaks
+- c6c78b4acbe: throw error from catalog:fetch scaffolder action when entity is null and optional is false
+- 9968f455921: catalog write action should allow any shape of object
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- 7af12854970: Extended scaffolder action `catalog:fetch` to fetch multiple catalog entities by entity references.
+- Updated dependencies
+ - @backstage/plugin-catalog-backend@1.8.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/plugin-auth-node@0.2.12
+ - @backstage/backend-tasks@0.5.0
+ - @backstage/backend-common@0.18.3
+ - @backstage/errors@1.1.5
+ - @backstage/plugin-catalog-node@1.3.4
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/integration@1.4.3
+ - @backstage/config@1.0.7
+ - @backstage/types@1.0.2
+ - @backstage/plugin-scaffolder-common@1.2.6
+ - @backstage/plugin-scaffolder-node@0.1.1
+
## 1.12.0-next.2
### Patch Changes
diff --git a/plugins/scaffolder-backend/alpha-api-report.md b/plugins/scaffolder-backend/alpha-api-report.md
index 3199444c6b..2ecd2cc800 100644
--- a/plugins/scaffolder-backend/alpha-api-report.md
+++ b/plugins/scaffolder-backend/alpha-api-report.md
@@ -4,14 +4,43 @@
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
+import { ConditionalPolicyDecision } from '@backstage/plugin-permission-common';
+import { Conditions } from '@backstage/plugin-permission-node';
+import { PermissionCondition } from '@backstage/plugin-permission-common';
+import { PermissionCriteria } from '@backstage/plugin-permission-common';
+import { PermissionRule } from '@backstage/plugin-permission-node';
+import { PermissionRuleParams } from '@backstage/plugin-permission-common';
+import { ResourcePermission } from '@backstage/plugin-permission-common';
import { TaskBroker } from '@backstage/plugin-scaffolder-backend';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
+import { TemplateEntityStepV1beta3 } from '@backstage/plugin-scaffolder-common';
import { TemplateFilter } from '@backstage/plugin-scaffolder-backend';
import { TemplateGlobal } from '@backstage/plugin-scaffolder-backend';
+import { TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common';
// @alpha
export const catalogModuleTemplateKind: () => BackendFeature;
+// @alpha
+export const createScaffolderConditionalDecision: (
+ permission: ResourcePermission<'scaffolder-template'>,
+ conditions: PermissionCriteria<
+ PermissionCondition<'scaffolder-template', PermissionRuleParams>
+ >,
+) => ConditionalPolicyDecision;
+
+// @alpha
+export const scaffolderConditions: Conditions<{
+ hasTag: PermissionRule<
+ TemplateParametersV1beta3 | TemplateEntityStepV1beta3,
+ {},
+ 'scaffolder-template',
+ {
+ tag: string;
+ }
+ >;
+}>;
+
// @alpha
export const scaffolderPlugin: (
options: ScaffolderPluginOptions,
diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md
index ca9b3543af..a50bb7a515 100644
--- a/plugins/scaffolder-backend/api-report.md
+++ b/plugins/scaffolder-backend/api-report.md
@@ -7,23 +7,29 @@
import { ActionContext as ActionContext_2 } from '@backstage/plugin-scaffolder-node';
import { CatalogApi } from '@backstage/catalog-client';
-import { CatalogProcessor } from '@backstage/plugin-catalog-backend';
-import { CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
+import { CatalogProcessor } from '@backstage/plugin-catalog-node';
+import { CatalogProcessorEmit } from '@backstage/plugin-catalog-node';
import { Config } from '@backstage/config';
import { createPullRequest } from 'octokit-plugin-create-pull-request';
+import { Duration } from 'luxon';
import { Entity } from '@backstage/catalog-model';
import express from 'express';
import { GithubCredentialsProvider } from '@backstage/integration';
+import { HumanDuration } from '@backstage/types';
import { IdentityApi } from '@backstage/plugin-auth-node';
import { JsonObject } from '@backstage/types';
import { JsonValue } from '@backstage/types';
import { Knex } from 'knex';
-import { LocationSpec } from '@backstage/plugin-catalog-backend';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
import { Logger } from 'winston';
import { Observable } from '@backstage/types';
import { Octokit } from 'octokit';
+import { PermissionEvaluator } from '@backstage/plugin-permission-common';
+import { PermissionRule } from '@backstage/plugin-permission-node';
+import { PermissionRuleParams } from '@backstage/plugin-permission-common';
import { PluginDatabaseManager } from '@backstage/backend-common';
import { PluginTaskScheduler } from '@backstage/backend-tasks';
+import { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE } from '@backstage/plugin-scaffolder-common/alpha';
import { Schema } from 'jsonschema';
import { ScmIntegrationRegistry } from '@backstage/integration';
import { ScmIntegrations } from '@backstage/integration';
@@ -33,6 +39,8 @@ import { TaskSpec } from '@backstage/plugin-scaffolder-common';
import { TaskSpecV1beta3 } from '@backstage/plugin-scaffolder-common';
import { TemplateAction as TemplateAction_2 } from '@backstage/plugin-scaffolder-node';
import { TemplateActionOptions } from '@backstage/plugin-scaffolder-node';
+import { TemplateEntityStepV1beta3 } from '@backstage/plugin-scaffolder-common';
+import { TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common';
import { UrlReader } from '@backstage/backend-common';
import { Writable } from 'stream';
import { ZodType } from 'zod';
@@ -75,8 +83,10 @@ export function createCatalogRegisterAction(options: {
// @public
export function createCatalogWriteAction(): TemplateAction_2<{
+ entity: {} & {
+ [k: string]: unknown;
+ };
filePath?: string | undefined;
- entity: {};
}>;
// @public
@@ -89,7 +99,8 @@ export function createDebugLogAction(): TemplateAction_2<{
export function createFetchCatalogEntityAction(options: {
catalogClient: CatalogApi;
}): TemplateAction_2<{
- entityRef: string;
+ entityRef?: string | undefined;
+ entityRefs?: string[] | undefined;
optional?: boolean | undefined;
}>;
@@ -102,6 +113,15 @@ export function createFetchPlainAction(options: {
targetPath?: string | undefined;
}>;
+// @public
+export function createFetchPlainFileAction(options: {
+ reader: UrlReader;
+ integrations: ScmIntegrations;
+}): TemplateAction_2<{
+ url: string;
+ targetPath: string;
+}>;
+
// @public
export function createFetchTemplateAction(options: {
reader: UrlReader;
@@ -527,6 +547,11 @@ export const createTemplateAction: <
action: TemplateActionOptions,
) => TemplateAction_2;
+// @public
+export function createWaitAction(options?: {
+ maxWaitTime?: Duration | HumanDuration;
+}): TemplateAction_2;
+
// @public
export type CreateWorkerOptions = {
taskBroker: TaskBroker;
@@ -549,6 +574,14 @@ export interface CurrentClaimedTask {
// @public
export class DatabaseTaskStore implements TaskStore {
+ // (undocumented)
+ cancelTask(
+ options: TaskStoreEmitOptions<
+ {
+ message: string;
+ } & JsonObject
+ >,
+ ): Promise;
// (undocumented)
claimTask(): Promise;
// (undocumented)
@@ -640,6 +673,10 @@ export interface RouterOptions {
// (undocumented)
logger: Logger;
// (undocumented)
+ permissionApi?: PermissionEvaluator;
+ // (undocumented)
+ permissionRules?: TemplatePermissionRuleInput[];
+ // (undocumented)
reader: UrlReader;
// (undocumented)
scheduler?: PluginTaskScheduler;
@@ -693,6 +730,8 @@ export type SerializedTaskEvent = {
// @public
export interface TaskBroker {
+ // (undocumented)
+ cancel?(taskId: string): Promise;
// (undocumented)
claim(): Promise;
// (undocumented)
@@ -730,6 +769,8 @@ export type TaskCompletionState = 'failed' | 'completed';
// @public
export interface TaskContext {
+ // (undocumented)
+ cancelSignal: AbortSignal;
// (undocumented)
complete(result: TaskCompletionState, metadata?: JsonObject): Promise;
// (undocumented)
@@ -749,16 +790,19 @@ export interface TaskContext {
}
// @public
-export type TaskEventType = 'completion' | 'log';
+export type TaskEventType = 'completion' | 'log' | 'cancelled';
// @public
export class TaskManager implements TaskContext {
+ // (undocumented)
+ get cancelSignal(): AbortSignal;
// (undocumented)
complete(result: TaskCompletionState, metadata?: JsonObject): Promise;
// (undocumented)
static create(
task: CurrentClaimedTask,
storage: TaskStore,
+ abortSignal: AbortSignal,
logger: Logger,
): TaskManager;
// (undocumented)
@@ -780,14 +824,16 @@ export type TaskSecrets = TaskSecrets_2;
// @public
export type TaskStatus =
- | 'open'
- | 'processing'
- | 'failed'
| 'cancelled'
- | 'completed';
+ | 'completed'
+ | 'failed'
+ | 'open'
+ | 'processing';
// @public
export interface TaskStore {
+ // (undocumented)
+ cancelTask?(options: TaskStoreEmitOptions): Promise;
// (undocumented)
claimTask(): Promise;
// (undocumented)
@@ -886,4 +932,14 @@ export type TemplateFilter = (...args: JsonValue[]) => JsonValue | undefined;
export type TemplateGlobal =
| ((...args: JsonValue[]) => JsonValue | undefined)
| JsonValue;
+
+// @public (undocumented)
+export type TemplatePermissionRuleInput<
+ TParams extends PermissionRuleParams = PermissionRuleParams,
+> = PermissionRule<
+ TemplateEntityStepV1beta3 | TemplateParametersV1beta3,
+ {},
+ typeof RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,
+ TParams
+>;
```
diff --git a/plugins/scaffolder-backend/package.json b/plugins/scaffolder-backend/package.json
index 03f813b036..d8d7347d6c 100644
--- a/plugins/scaffolder-backend/package.json
+++ b/plugins/scaffolder-backend/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-scaffolder-backend",
"description": "The Backstage backend plugin that helps you create new things",
- "version": "1.12.0-next.2",
+ "version": "1.12.1-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -56,7 +56,10 @@
"@backstage/integration": "workspace:^",
"@backstage/plugin-auth-node": "workspace:^",
"@backstage/plugin-catalog-backend": "workspace:^",
+ "@backstage/plugin-catalog-common": "workspace:^",
"@backstage/plugin-catalog-node": "workspace:^",
+ "@backstage/plugin-permission-common": "workspace:^",
+ "@backstage/plugin-permission-node": "workspace:^",
"@backstage/plugin-scaffolder-common": "workspace:^",
"@backstage/plugin-scaffolder-node": "workspace:^",
"@backstage/types": "workspace:^",
@@ -64,6 +67,7 @@
"@gitbeaker/node": "^35.1.0",
"@octokit/webhooks": "^10.0.0",
"@types/express": "^4.17.6",
+ "@types/luxon": "^3.0.0",
"azure-devops-node-api": "^11.0.1",
"command-exists": "^1.2.9",
"compression": "^1.7.4",
@@ -92,7 +96,7 @@
"winston": "^3.2.1",
"yaml": "^2.0.0",
"zen-observable": "^0.10.0",
- "zod": "~3.18.0"
+ "zod": "^3.21.4"
},
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
@@ -109,6 +113,7 @@
"mock-fs": "^5.1.0",
"msw": "^1.0.0",
"supertest": "^6.1.3",
+ "wait-for-expect": "^3.0.2",
"yaml": "^2.0.0"
},
"files": [
diff --git a/plugins/scaffolder-backend/src/ScaffolderPlugin.ts b/plugins/scaffolder-backend/src/ScaffolderPlugin.ts
index 182bb60223..97abf41828 100644
--- a/plugins/scaffolder-backend/src/ScaffolderPlugin.ts
+++ b/plugins/scaffolder-backend/src/ScaffolderPlugin.ts
@@ -94,6 +94,7 @@ export const scaffolderPlugin = createBackendPlugin(
database,
httpRouter,
catalogClient,
+ permissions,
}) {
const {
additionalTemplateFilters,
@@ -131,6 +132,7 @@ export const scaffolderPlugin = createBackendPlugin(
taskWorkers,
additionalTemplateFilters,
additionalTemplateGlobals,
+ permissionApi: permissions,
});
httpRouter.use(router);
},
diff --git a/plugins/scaffolder-backend/src/alpha.ts b/plugins/scaffolder-backend/src/alpha.ts
index ac96f081ad..713f2569aa 100644
--- a/plugins/scaffolder-backend/src/alpha.ts
+++ b/plugins/scaffolder-backend/src/alpha.ts
@@ -15,5 +15,6 @@
*/
export * from './modules';
+export * from './service';
export { scaffolderPlugin } from './ScaffolderPlugin';
export type { ScaffolderPluginOptions } from './ScaffolderPlugin';
diff --git a/plugins/scaffolder-backend/src/processor/ScaffolderEntitiesProcessor.ts b/plugins/scaffolder-backend/src/processor/ScaffolderEntitiesProcessor.ts
index d095b77b4c..1de381a8ff 100644
--- a/plugins/scaffolder-backend/src/processor/ScaffolderEntitiesProcessor.ts
+++ b/plugins/scaffolder-backend/src/processor/ScaffolderEntitiesProcessor.ts
@@ -24,9 +24,9 @@ import {
import {
CatalogProcessor,
CatalogProcessorEmit,
- LocationSpec,
processingResult,
-} from '@backstage/plugin-catalog-backend';
+} from '@backstage/plugin-catalog-node';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
import {
TemplateEntityV1beta3,
templateEntityV1beta3Validator,
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/catalog/fetch.test.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/catalog/fetch.test.ts
index 52c76c8769..1cce7d66cb 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/catalog/fetch.test.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/catalog/fetch.test.ts
@@ -23,8 +23,11 @@ import { createFetchCatalogEntityAction } from './fetch';
describe('catalog:fetch', () => {
const getEntityByRef = jest.fn();
+ const getEntitiesByRefs = jest.fn();
+
const catalogClient = {
getEntityByRef: getEntityByRef,
+ getEntitiesByRefs: getEntitiesByRefs,
};
const action = createFetchCatalogEntityAction({
@@ -71,25 +74,6 @@ describe('catalog:fetch', () => {
});
});
- it('should return null if entity not in catalog and optional is true', async () => {
- getEntityByRef.mockImplementationOnce(() => {
- throw new Error('Not found');
- });
-
- await action.handler({
- ...mockContext,
- input: {
- entityRef: 'component:default/test',
- optional: true,
- },
- });
-
- expect(getEntityByRef).toHaveBeenCalledWith('component:default/test', {
- token: 'secret',
- });
- expect(mockContext.output).toHaveBeenCalledWith('entity', null);
- });
-
it('should throw error if entity fetch fails from catalog and optional is false', async () => {
getEntityByRef.mockImplementationOnce(() => {
throw new Error('Not found');
@@ -127,4 +111,114 @@ describe('catalog:fetch', () => {
});
expect(mockContext.output).not.toHaveBeenCalled();
});
+
+ it('should return entities from catalog', async () => {
+ getEntitiesByRefs.mockReturnValueOnce({
+ items: [
+ {
+ metadata: {
+ namespace: 'default',
+ name: 'test',
+ },
+ kind: 'Component',
+ } as Entity,
+ ],
+ });
+
+ await action.handler({
+ ...mockContext,
+ input: {
+ entityRefs: ['component:default/test'],
+ },
+ });
+
+ expect(getEntitiesByRefs).toHaveBeenCalledWith(
+ { entityRefs: ['component:default/test'] },
+ {
+ token: 'secret',
+ },
+ );
+ expect(mockContext.output).toHaveBeenCalledWith('entities', [
+ {
+ metadata: {
+ namespace: 'default',
+ name: 'test',
+ },
+ kind: 'Component',
+ },
+ ]);
+ });
+
+ it('should throw error if undefined is returned for some entity', async () => {
+ getEntitiesByRefs.mockReturnValueOnce({
+ items: [
+ {
+ metadata: {
+ namespace: 'default',
+ name: 'test',
+ },
+ kind: 'Component',
+ } as Entity,
+ undefined,
+ ],
+ });
+
+ await expect(
+ action.handler({
+ ...mockContext,
+ input: {
+ entityRefs: ['component:default/test', 'component:default/test2'],
+ optional: false,
+ },
+ }),
+ ).rejects.toThrow('Entity component:default/test2 not found');
+
+ expect(getEntitiesByRefs).toHaveBeenCalledWith(
+ { entityRefs: ['component:default/test', 'component:default/test2'] },
+ {
+ token: 'secret',
+ },
+ );
+ expect(mockContext.output).not.toHaveBeenCalled();
+ });
+
+ it('should return null in case some of the entities not found and optional is true', async () => {
+ getEntitiesByRefs.mockReturnValueOnce({
+ items: [
+ {
+ metadata: {
+ namespace: 'default',
+ name: 'test',
+ },
+ kind: 'Component',
+ } as Entity,
+ undefined,
+ ],
+ });
+
+ await action.handler({
+ ...mockContext,
+ input: {
+ entityRefs: ['component:default/test', 'component:default/test2'],
+ optional: true,
+ },
+ });
+
+ expect(getEntitiesByRefs).toHaveBeenCalledWith(
+ { entityRefs: ['component:default/test', 'component:default/test2'] },
+ {
+ token: 'secret',
+ },
+ );
+ expect(mockContext.output).toHaveBeenCalledWith('entities', [
+ {
+ metadata: {
+ namespace: 'default',
+ name: 'test',
+ },
+ kind: 'Component',
+ },
+ null,
+ ]);
+ });
});
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/catalog/fetch.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/catalog/fetch.ts
index 17e510ce64..1bcbfa0006 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/catalog/fetch.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/catalog/fetch.ts
@@ -36,10 +36,26 @@ const examples = [
],
}),
},
+ {
+ description: 'Fetch multiple entities by referencse',
+ example: yaml.stringify({
+ steps: [
+ {
+ action: id,
+ id: 'fetchMultiple',
+ name: 'Fetch catalog entities',
+ input: {
+ entityRefs: ['component:default/name'],
+ },
+ },
+ ],
+ }),
+ },
];
/**
- * Returns entity from the catalog by entity reference.
+ * Returns entity or entities from the catalog by entity reference(s).
+ *
* @public
*/
export function createFetchCatalogEntityAction(options: {
@@ -47,13 +63,17 @@ export function createFetchCatalogEntityAction(options: {
}) {
const { catalogClient } = options;
- return createTemplateAction<{ entityRef: string; optional?: boolean }>({
+ return createTemplateAction<{
+ entityRef?: string;
+ entityRefs?: string[];
+ optional?: boolean;
+ }>({
id,
- description: 'Returns entity from the catalog by entity reference',
+ description:
+ 'Returns entity or entities from the catalog by entity reference(s)',
examples,
schema: {
input: {
- required: ['entityRef'],
type: 'object',
properties: {
entityRef: {
@@ -61,10 +81,15 @@ export function createFetchCatalogEntityAction(options: {
title: 'Entity reference',
description: 'Entity reference of the entity to get',
},
+ entityRefs: {
+ type: 'array',
+ title: 'Entity references',
+ description: 'Entity references of the entities to get',
+ },
optional: {
title: 'Optional',
description:
- 'Permit the entity to optionally exist. Default: false',
+ 'Allow the entity or entities to optionally exist. Default: false',
type: 'boolean',
},
},
@@ -76,29 +101,55 @@ export function createFetchCatalogEntityAction(options: {
title: 'Entity found by the entity reference',
type: 'object',
description:
- 'Object containing same values used in the Entity schema.',
+ 'Object containing same values used in the Entity schema. Only when used with `entityRef` parameter.',
+ },
+ entities: {
+ title: 'Entities found by the entity references',
+ type: 'array',
+ items: { type: 'object' },
+ description:
+ 'Array containing objects with same values used in the Entity schema. Only when used with `entityRefs` parameter.',
},
},
},
},
async handler(ctx) {
- const { entityRef, optional } = ctx.input;
- let entity;
- try {
- entity = await catalogClient.getEntityByRef(entityRef, {
+ const { entityRef, entityRefs, optional } = ctx.input;
+ if (!entityRef && !entityRefs) {
+ if (optional) {
+ return;
+ }
+ throw new Error('Missing entity reference or references');
+ }
+
+ if (entityRef) {
+ const entity = await catalogClient.getEntityByRef(entityRef, {
token: ctx.secrets?.backstageToken,
});
- } catch (e) {
- if (!optional) {
- throw e;
+
+ if (!entity && !optional) {
+ throw new Error(`Entity ${entityRef} not found`);
}
+ ctx.output('entity', entity ?? null);
}
- if (!entity && !optional) {
- throw new Error(`Entity ${entityRef} not found`);
- }
+ if (entityRefs) {
+ const entities = await catalogClient.getEntitiesByRefs(
+ { entityRefs },
+ {
+ token: ctx.secrets?.backstageToken,
+ },
+ );
- ctx.output('entity', entity ?? null);
+ const finalEntities = entities.items.map((e, i) => {
+ if (!e && !optional) {
+ throw new Error(`Entity ${entityRefs[i]} not found`);
+ }
+ return e ?? null;
+ });
+
+ ctx.output('entities', finalEntities);
+ }
},
});
}
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/createBuiltinActions.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/createBuiltinActions.ts
index 9ba4a27b1a..747b5cdaed 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/createBuiltinActions.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/createBuiltinActions.ts
@@ -30,8 +30,12 @@ import {
} from './catalog';
import { TemplateFilter, TemplateGlobal } from '../../../lib';
-import { createDebugLogAction } from './debug';
-import { createFetchPlainAction, createFetchTemplateAction } from './fetch';
+import { createDebugLogAction, createWaitAction } from './debug';
+import {
+ createFetchPlainAction,
+ createFetchPlainFileAction,
+ createFetchTemplateAction,
+} from './fetch';
import {
createFilesystemDeleteAction,
createFilesystemRenameAction,
@@ -112,6 +116,10 @@ export const createBuiltinActions = (
reader,
integrations,
}),
+ createFetchPlainFileAction({
+ reader,
+ integrations,
+ }),
createFetchTemplateAction({
integrations,
reader,
@@ -159,6 +167,7 @@ export const createBuiltinActions = (
config,
}),
createDebugLogAction(),
+ createWaitAction(),
createCatalogRegisterAction({ catalogClient, integrations }),
createFetchCatalogEntityAction({ catalogClient }),
createCatalogWriteAction(),
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/debug/index.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/debug/index.ts
index 8cc50a7eba..3776ce7f03 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/debug/index.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/debug/index.ts
@@ -15,3 +15,4 @@
*/
export { createDebugLogAction } from './log';
+export { createWaitAction } from './wait';
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/debug/wait.test.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/debug/wait.test.ts
new file mode 100644
index 0000000000..0d4cdaba4b
--- /dev/null
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/debug/wait.test.ts
@@ -0,0 +1,76 @@
+/*
+ * 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 { getVoidLogger } from '@backstage/backend-common';
+import mockFs from 'mock-fs';
+import { createWaitAction } from './wait';
+import { Writable } from 'stream';
+import os from 'os';
+
+describe('debug:wait', () => {
+ const action = createWaitAction();
+
+ const logStream = {
+ write: jest.fn(),
+ } as jest.Mocked> as jest.Mocked;
+
+ const mockTmpDir = os.tmpdir();
+ const mockContext = {
+ input: {},
+ baseUrl: 'somebase',
+ workspacePath: mockTmpDir,
+ logger: getVoidLogger(),
+ logStream,
+ output: jest.fn(),
+ createTemporaryDirectory: jest.fn().mockResolvedValue(mockTmpDir),
+ };
+
+ beforeEach(() => {
+ jest.resetAllMocks();
+ });
+
+ afterEach(() => {
+ mockFs.restore();
+ });
+
+ it('should wait for specified period of time', async () => {
+ const context = {
+ ...mockContext,
+ input: {
+ milliseconds: 50,
+ },
+ };
+ const start = new Date().getTime();
+ await action.handler(context);
+ const end = new Date().getTime();
+ expect(end - start).toBeGreaterThanOrEqual(50);
+ });
+
+ it('should not allow to set waiting time longer than the max waiting time', async () => {
+ const context = {
+ ...mockContext,
+ input: {
+ minutes: 11,
+ },
+ };
+
+ await expect(async () => {
+ await action.handler(context);
+ }).rejects.toThrow(
+ 'Waiting duration is longer than the maximum threshold of 0 hours, 0 minutes, 30 seconds',
+ );
+ });
+});
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/debug/wait.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/debug/wait.ts
new file mode 100644
index 0000000000..02cab239cb
--- /dev/null
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/debug/wait.ts
@@ -0,0 +1,131 @@
+/*
+ * 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 { createTemplateAction } from '@backstage/plugin-scaffolder-node';
+import { HumanDuration } from '@backstage/types';
+import yaml from 'yaml';
+import { Duration } from 'luxon';
+
+const id = 'debug:wait';
+
+const MAX_WAIT_TIME_IN_ISO = 'T00:00:30';
+
+const examples = [
+ {
+ description: 'Waiting for 5 seconds',
+ example: yaml.stringify({
+ steps: [
+ {
+ action: id,
+ id: 'wait-5sec',
+ name: 'Waiting for 5 seconds',
+ input: {
+ seconds: 5,
+ },
+ },
+ ],
+ }),
+ },
+ {
+ description: 'Waiting for 5 minutes',
+ example: yaml.stringify({
+ steps: [
+ {
+ action: id,
+ id: 'wait-5min',
+ name: 'Waiting for 5 minutes',
+ input: {
+ minutes: 5,
+ },
+ },
+ ],
+ }),
+ },
+];
+
+/**
+ * Waits for a certain period of time.
+ *
+ * @remarks
+ *
+ * This task is useful to give some waiting time for manual intervention.
+ * Has to be used in a combination with other actions.
+ *
+ * @public
+ */
+export function createWaitAction(options?: {
+ maxWaitTime?: Duration | HumanDuration;
+}) {
+ const toDuration = (
+ maxWaitTime: Duration | HumanDuration | undefined,
+ ): Duration => {
+ if (maxWaitTime) {
+ if (maxWaitTime instanceof Duration) {
+ return maxWaitTime;
+ }
+ return Duration.fromObject(maxWaitTime);
+ }
+ return Duration.fromISOTime(MAX_WAIT_TIME_IN_ISO);
+ };
+
+ return createTemplateAction({
+ id,
+ description: 'Waits for a certain period of time.',
+ examples,
+ schema: {
+ input: {
+ type: 'object',
+ properties: {
+ minutes: {
+ title: 'Waiting period in minutes.',
+ type: 'number',
+ },
+ seconds: {
+ title: 'Waiting period in seconds.',
+ type: 'number',
+ },
+ milliseconds: {
+ title: 'Waiting period in milliseconds.',
+ type: 'number',
+ },
+ },
+ },
+ },
+ async handler(ctx) {
+ const delayTime = Duration.fromObject(ctx.input);
+ const maxWait = toDuration(options?.maxWaitTime);
+
+ if (delayTime.minus(maxWait).toMillis() > 0) {
+ throw new Error(
+ `Waiting duration is longer than the maximum threshold of ${maxWait.toHuman()}`,
+ );
+ }
+
+ await new Promise(resolve => {
+ const controller = new AbortController();
+ const timeoutHandle = setTimeout(abort, delayTime.toMillis());
+ ctx.signal?.addEventListener('abort', abort);
+
+ function abort() {
+ ctx.signal?.removeEventListener('abort', abort);
+ clearTimeout(timeoutHandle!);
+ controller.abort();
+ resolve('finished');
+ }
+ });
+ },
+ });
+}
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/helpers.test.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/helpers.test.ts
index 86d5f17803..3c4a677d4d 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/helpers.test.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/helpers.test.ts
@@ -21,7 +21,7 @@ import { resolve as resolvePath } from 'path';
import { UrlReader } from '@backstage/backend-common';
import { ConfigReader } from '@backstage/config';
import { ScmIntegrations } from '@backstage/integration';
-import { fetchContents } from './helpers';
+import { fetchContents, fetchFile } from './helpers';
import os from 'os';
describe('fetchContent helper', () => {
@@ -37,9 +37,10 @@ describe('fetchContent helper', () => {
}),
);
+ const readUrl = jest.fn();
const readTree = jest.fn();
const reader: UrlReader = {
- readUrl: jest.fn(),
+ readUrl,
readTree,
search: jest.fn(),
};
@@ -50,73 +51,165 @@ describe('fetchContent helper', () => {
outputPath: os.tmpdir(),
};
- it('should reject absolute file locations', async () => {
- await expect(
- fetchContents({
- ...options,
- baseUrl: 'file:///some/path',
- fetchUrl: '/etc/passwd',
- }),
- ).rejects.toThrow(
- 'Relative path is not allowed to refer to a directory outside its parent',
- );
- });
-
- it('should reject relative file locations that exit the baseUrl', async () => {
- await expect(
- fetchContents({
- ...options,
- baseUrl: 'file:///some/path',
- fetchUrl: '../test',
- }),
- ).rejects.toThrow(
- 'Relative path is not allowed to refer to a directory outside its parent',
- );
- });
-
- it('should copy file to outputpath', async () => {
- await fetchContents({
- ...options,
- baseUrl: 'file:///some/path',
- fetchUrl: 'foo',
- outputPath: 'somepath',
+ describe('fetch contents', () => {
+ it('should reject absolute file locations', async () => {
+ await expect(
+ fetchContents({
+ ...options,
+ baseUrl: 'file:///some/path',
+ fetchUrl: '/etc/passwd',
+ }),
+ ).rejects.toThrow(
+ 'Relative path is not allowed to refer to a directory outside its parent',
+ );
});
- expect(fs.copy).toHaveBeenCalledWith(resolvePath('/some/foo'), 'somepath');
- });
- it('should reject if no integration matches location', async () => {
- await expect(
- fetchContents({
- ...options,
- baseUrl: 'http://example.com/some/folder',
- }),
- ).rejects.toThrow(
- 'No integration found for location http://example.com/some/folder',
- );
- });
+ it('should reject relative file locations that exit the baseUrl', async () => {
+ await expect(
+ fetchContents({
+ ...options,
+ baseUrl: 'file:///some/path',
+ fetchUrl: '../test',
+ }),
+ ).rejects.toThrow(
+ 'Relative path is not allowed to refer to a directory outside its parent',
+ );
+ });
- it('should reject if fetch url is relative and no base url is specified', async () => {
- await expect(
- fetchContents({
+ it('should copy file to outputpath', async () => {
+ await fetchContents({
...options,
+ baseUrl: 'file:///some/path',
fetchUrl: 'foo',
- }),
- ).rejects.toThrow(
- 'Failed to fetch, template location could not be determined and the fetch URL is relative, foo',
- );
+ outputPath: 'somepath',
+ });
+ expect(fs.copy).toHaveBeenCalledWith(
+ resolvePath('/some/foo'),
+ 'somepath',
+ );
+ });
+
+ it('should reject if no integration matches location', async () => {
+ await expect(
+ fetchContents({
+ ...options,
+ baseUrl: 'http://example.com/some/folder',
+ }),
+ ).rejects.toThrow(
+ 'No integration found for location http://example.com/some/folder',
+ );
+ });
+
+ it('should reject if fetch url is relative and no base url is specified', async () => {
+ await expect(
+ fetchContents({
+ ...options,
+ fetchUrl: 'foo',
+ }),
+ ).rejects.toThrow(
+ 'Failed to fetch, template location could not be determined and the fetch URL is relative, foo',
+ );
+ });
+
+ it('should fetch url contents', async () => {
+ const dirFunction = jest.fn();
+ readTree.mockResolvedValue({
+ dir: dirFunction,
+ });
+ await fetchContents({
+ ...options,
+ outputPath: 'foo',
+ fetchUrl: 'https://github.com/backstage/foo',
+ });
+ expect(fs.ensureDir).toHaveBeenCalledWith('foo');
+ expect(dirFunction).toHaveBeenCalledWith({ targetDir: 'foo' });
+ });
});
- it('should fetch url contents', async () => {
- const dirFunction = jest.fn();
- readTree.mockResolvedValue({
- dir: dirFunction,
+ describe('fetch file', () => {
+ it('should reject absolute file locations', async () => {
+ await expect(
+ fetchFile({
+ ...options,
+ baseUrl: 'file:///some/path',
+ fetchUrl: '/etc/passwd',
+ }),
+ ).rejects.toThrow(
+ 'Relative path is not allowed to refer to a directory outside its parent',
+ );
});
- await fetchContents({
- ...options,
- outputPath: 'foo',
- fetchUrl: 'https://github.com/backstage/foo',
+
+ it('should reject relative file locations that exit the baseUrl', async () => {
+ await expect(
+ fetchFile({
+ ...options,
+ baseUrl: 'file:///some/path',
+ fetchUrl: '../test',
+ }),
+ ).rejects.toThrow(
+ 'Relative path is not allowed to refer to a directory outside its parent',
+ );
+ });
+
+ it('should copy file to outputpath', async () => {
+ await fetchFile({
+ ...options,
+ baseUrl: 'file:///some/path',
+ fetchUrl: 'foo',
+ outputPath: 'somepath',
+ });
+ expect(fs.copyFile).toHaveBeenCalledWith(
+ resolvePath('/some/foo'),
+ 'somepath',
+ );
+ });
+
+ it('should reject if no integration matches location', async () => {
+ await expect(
+ fetchFile({
+ ...options,
+ baseUrl: 'http://example.com/some/folder',
+ }),
+ ).rejects.toThrow(
+ 'No integration found for location http://example.com/some/folder',
+ );
+ });
+
+ it('should reject if fetch url is relative and no base url is specified', async () => {
+ await expect(
+ fetchFile({
+ ...options,
+ fetchUrl: 'foo',
+ }),
+ ).rejects.toThrow(
+ 'Failed to fetch, template location could not be determined and the fetch URL is relative, foo',
+ );
+ });
+
+ it('should fetch content from url', async () => {
+ readUrl.mockResolvedValue({
+ buffer: () => Buffer.from('test', 'utf8'),
+ });
+ await fetchFile({
+ ...options,
+ outputPath: 'foo',
+ fetchUrl: 'https://github.com/backstage/foo',
+ });
+ expect(fs.ensureDir).toHaveBeenCalledWith('.');
+ expect(fs.outputFile).toHaveBeenCalledWith('foo', 'test');
+ });
+
+ it('should fetch content from url into directory', async () => {
+ readUrl.mockResolvedValue({
+ buffer: () => Buffer.from('test', 'utf8'),
+ });
+ await fetchFile({
+ ...options,
+ outputPath: 'mydir/foo',
+ fetchUrl: 'https://github.com/backstage/foo',
+ });
+ expect(fs.ensureDir).toHaveBeenCalledWith('mydir');
+ expect(fs.outputFile).toHaveBeenCalledWith('mydir/foo', 'test');
});
- expect(fs.ensureDir).toHaveBeenCalled();
- expect(dirFunction).toHaveBeenCalledWith({ targetDir: 'foo' });
});
});
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/helpers.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/helpers.ts
index 4b82595cfd..301c9991c4 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/helpers.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/helpers.ts
@@ -35,6 +35,53 @@ export async function fetchContents(options: {
}) {
const { reader, integrations, baseUrl, fetchUrl = '.', outputPath } = options;
+ const fetchUrlIsAbsolute = isFetchUrlAbsolute(fetchUrl);
+
+ // We handle both file locations and url ones
+ if (!fetchUrlIsAbsolute && baseUrl?.startsWith('file://')) {
+ const basePath = baseUrl.slice('file://'.length);
+ const srcDir = resolveSafeChildPath(path.dirname(basePath), fetchUrl);
+ await fs.copy(srcDir, outputPath);
+ } else {
+ const readUrl = getReadUrl(fetchUrl, baseUrl, integrations);
+
+ const res = await reader.readTree(readUrl);
+ await fs.ensureDir(outputPath);
+ await res.dir({ targetDir: outputPath });
+ }
+}
+
+/**
+ * A helper function that reads the content of a single file from the given URL.
+ * Can be used in your own actions, and also used behind `fetch:plain:file`
+ */
+export async function fetchFile(options: {
+ reader: UrlReader;
+ integrations: ScmIntegrations;
+ baseUrl?: string;
+ fetchUrl?: string;
+ outputPath: string;
+}) {
+ const { reader, integrations, baseUrl, fetchUrl = '.', outputPath } = options;
+
+ const fetchUrlIsAbsolute = isFetchUrlAbsolute(fetchUrl);
+
+ // We handle both file locations and url ones
+ if (!fetchUrlIsAbsolute && baseUrl?.startsWith('file://')) {
+ const basePath = baseUrl.slice('file://'.length);
+ const src = resolveSafeChildPath(path.dirname(basePath), fetchUrl);
+ await fs.copyFile(src, outputPath);
+ } else {
+ const readUrl = getReadUrl(fetchUrl, baseUrl, integrations);
+
+ const res = await reader.readUrl(readUrl);
+ await fs.ensureDir(path.dirname(outputPath));
+ const buffer = await res.buffer();
+ await fs.outputFile(outputPath, buffer.toString());
+ }
+}
+
+function isFetchUrlAbsolute(fetchUrl: string) {
let fetchUrlIsAbsolute = false;
try {
// eslint-disable-next-line no-new
@@ -43,35 +90,28 @@ export async function fetchContents(options: {
} catch {
/* ignored */
}
+ return fetchUrlIsAbsolute;
+}
- // We handle both file locations and url ones
- if (!fetchUrlIsAbsolute && baseUrl?.startsWith('file://')) {
- const basePath = baseUrl.slice('file://'.length);
- const srcDir = resolveSafeChildPath(path.dirname(basePath), fetchUrl);
- await fs.copy(srcDir, outputPath);
- } else {
- let readUrl;
-
- if (fetchUrlIsAbsolute) {
- readUrl = fetchUrl;
- } else if (baseUrl) {
- const integration = integrations.byUrl(baseUrl);
- if (!integration) {
- throw new InputError(`No integration found for location ${baseUrl}`);
- }
-
- readUrl = integration.resolveUrl({
- url: fetchUrl,
- base: baseUrl,
- });
- } else {
- throw new InputError(
- `Failed to fetch, template location could not be determined and the fetch URL is relative, ${fetchUrl}`,
- );
+function getReadUrl(
+ fetchUrl: string,
+ baseUrl: string | undefined,
+ integrations: ScmIntegrations,
+) {
+ if (isFetchUrlAbsolute(fetchUrl)) {
+ return fetchUrl;
+ } else if (baseUrl) {
+ const integration = integrations.byUrl(baseUrl);
+ if (!integration) {
+ throw new InputError(`No integration found for location ${baseUrl}`);
}
- const res = await reader.readTree(readUrl);
- await fs.ensureDir(outputPath);
- await res.dir({ targetDir: outputPath });
+ return integration.resolveUrl({
+ url: fetchUrl,
+ base: baseUrl,
+ });
}
+ throw new InputError(
+ `Failed to fetch, template location could not be determined and the fetch URL is relative, ${fetchUrl}`,
+ );
}
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/index.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/index.ts
index c9a16c274e..14a40f53c3 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/index.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/index.ts
@@ -15,5 +15,6 @@
*/
export { createFetchPlainAction } from './plain';
+export { createFetchPlainFileAction } from './plainFile';
export { createFetchTemplateAction } from './template';
export { fetchContents } from './helpers';
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/plainFile.test.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/plainFile.test.ts
new file mode 100644
index 0000000000..5d9e99fc7d
--- /dev/null
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/plainFile.test.ts
@@ -0,0 +1,85 @@
+/*
+ * 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.
+ */
+
+jest.mock('./helpers');
+
+import os from 'os';
+import { resolve as resolvePath } from 'path';
+import { getVoidLogger, UrlReader } from '@backstage/backend-common';
+import { ConfigReader } from '@backstage/config';
+import { ScmIntegrations } from '@backstage/integration';
+import { createFetchPlainFileAction } from './plainFile';
+import { PassThrough } from 'stream';
+import { fetchFile } from './helpers';
+
+describe('fetch:plain:file', () => {
+ const integrations = ScmIntegrations.fromConfig(
+ new ConfigReader({
+ integrations: {
+ github: [{ host: 'github.com', token: 'token' }],
+ },
+ }),
+ );
+ const reader: UrlReader = {
+ readUrl: jest.fn(),
+ readTree: jest.fn(),
+ search: jest.fn(),
+ };
+
+ beforeEach(() => {
+ jest.resetAllMocks();
+ });
+
+ const action = createFetchPlainFileAction({ integrations, reader });
+ const mockContext = {
+ workspacePath: os.tmpdir(),
+ logger: getVoidLogger(),
+ logStream: new PassThrough(),
+ output: jest.fn(),
+ createTemporaryDirectory: jest.fn(),
+ };
+
+ it('should disallow a target path outside working directory', async () => {
+ await expect(
+ action.handler({
+ ...mockContext,
+ input: {
+ url: 'https://github.com/backstage/community/tree/main/backstage-community-sessions/assets/Backstage%20Community%20Sessions.png',
+ targetPath: '/foobar',
+ },
+ }),
+ ).rejects.toThrow(
+ /Relative path is not allowed to refer to a directory outside its parent/,
+ );
+ });
+
+ it('should fetch plain', async () => {
+ await action.handler({
+ ...mockContext,
+ input: {
+ url: 'https://github.com/backstage/community/tree/main/backstage-community-sessions/assets/Backstage%20Community%20Sessions.png',
+ targetPath: 'lol',
+ },
+ });
+ expect(fetchFile).toHaveBeenCalledWith(
+ expect.objectContaining({
+ outputPath: resolvePath(mockContext.workspacePath, 'lol'),
+ fetchUrl:
+ 'https://github.com/backstage/community/tree/main/backstage-community-sessions/assets/Backstage%20Community%20Sessions.png',
+ }),
+ );
+ });
+});
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/plainFile.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/plainFile.ts
new file mode 100644
index 0000000000..7b33ad93b4
--- /dev/null
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/fetch/plainFile.ts
@@ -0,0 +1,75 @@
+/*
+ * 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 { UrlReader, resolveSafeChildPath } from '@backstage/backend-common';
+import { ScmIntegrations } from '@backstage/integration';
+import { fetchFile } from './helpers';
+import { createTemplateAction } from '@backstage/plugin-scaffolder-node';
+
+/**
+ * Downloads content and places it in the workspace, or optionally
+ * in a subdirectory specified by the 'targetPath' input option.
+ * @public
+ */
+export function createFetchPlainFileAction(options: {
+ reader: UrlReader;
+ integrations: ScmIntegrations;
+}) {
+ const { reader, integrations } = options;
+
+ return createTemplateAction<{ url: string; targetPath: string }>({
+ id: 'fetch:plain:file',
+ description: 'Downloads single file and places it in the workspace.',
+ schema: {
+ input: {
+ type: 'object',
+ required: ['url', 'targetPath'],
+ properties: {
+ url: {
+ title: 'Fetch URL',
+ description:
+ 'Relative path or absolute URL pointing to the single file to fetch.',
+ type: 'string',
+ },
+ targetPath: {
+ title: 'Target Path',
+ description:
+ 'Target path within the working directory to download the file as.',
+ type: 'string',
+ },
+ },
+ },
+ },
+ supportsDryRun: true,
+ async handler(ctx) {
+ ctx.logger.info('Fetching plain content from remote URL');
+
+ // Finally move the template result into the task workspace
+ const outputPath = resolveSafeChildPath(
+ ctx.workspacePath,
+ ctx.input.targetPath,
+ );
+
+ await fetchFile({
+ reader,
+ integrations,
+ baseUrl: ctx.templateInfo?.baseUrl,
+ fetchUrl: ctx.input.url,
+ outputPath,
+ });
+ },
+ });
+}
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlabMergeRequest.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlabMergeRequest.ts
index bb27410402..06e056cda3 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlabMergeRequest.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/gitlabMergeRequest.ts
@@ -127,7 +127,7 @@ export const createPublishGitlabMergeRequestAction = (options: {
title: 'Gitlab Project path',
type: 'string',
},
- mergeRequestURL: {
+ mergeRequestUrl: {
title: 'MergeRequest(MR) URL',
type: 'string',
description: 'Link to the merge request in GitLab',
diff --git a/plugins/scaffolder-backend/src/scaffolder/dryrun/createDryRunner.ts b/plugins/scaffolder-backend/src/scaffolder/dryrun/createDryRunner.ts
index 1929e3b8ac..d9302f4d74 100644
--- a/plugins/scaffolder-backend/src/scaffolder/dryrun/createDryRunner.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/dryrun/createDryRunner.ts
@@ -25,7 +25,7 @@ import {
SerializedFile,
serializeDirectoryContents,
} from '../../lib/files';
-import { TemplateFilter, TemplateGlobal } from '../../lib/templating';
+import { TemplateFilter, TemplateGlobal } from '../../lib';
import { TemplateActionRegistry } from '../actions';
import { NunjucksWorkflowRunner } from '../tasks/NunjucksWorkflowRunner';
import { DecoratedActionsRegistry } from './DecoratedActionsRegistry';
@@ -94,6 +94,8 @@ export function createDryRunner(options: TemplateTesterCreateOptions) {
try {
await deserializeDirectoryContents(contentsPath, input.directoryContents);
+ const abortSignal = new AbortController().signal;
+
const result = await workflowRunner.execute({
spec: {
...input.spec,
@@ -117,6 +119,7 @@ export function createDryRunner(options: TemplateTesterCreateOptions) {
done: false,
isDryRun: true,
getWorkspaceName: async () => `dry-run-${dryRunId}`,
+ cancelSignal: abortSignal,
async emitLog(message: string, logMetadata?: JsonObject) {
if (logMetadata?.stepId === dryRunId) {
return;
@@ -128,7 +131,7 @@ export function createDryRunner(options: TemplateTesterCreateOptions) {
},
});
},
- async complete() {
+ complete: async () => {
throw new Error('Not implemented');
},
});
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.test.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.test.ts
new file mode 100644
index 0000000000..4c0eb94c82
--- /dev/null
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.test.ts
@@ -0,0 +1,191 @@
+/*
+ * 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 { DatabaseManager } from '@backstage/backend-common';
+import { ConfigReader } from '@backstage/config';
+import { DatabaseTaskStore } from './DatabaseTaskStore';
+import { TaskSpec } from '@backstage/plugin-scaffolder-common';
+import { ConflictError } from '@backstage/errors';
+
+const createStore = async () => {
+ const manager = DatabaseManager.fromConfig(
+ new ConfigReader({
+ backend: {
+ database: {
+ client: 'better-sqlite3',
+ connection: ':memory:',
+ },
+ },
+ }),
+ ).forPlugin('scaffolder');
+ const store = await DatabaseTaskStore.create({
+ database: manager,
+ });
+ return { store, manager };
+};
+
+describe('DatabaseTaskStore', () => {
+ it('should create the database store and run migration', async () => {
+ const { store, manager } = await createStore();
+ expect(store).toBeDefined();
+
+ const client = await manager.getClient();
+ expect(client.schema.hasTable('tasks')).toBeTruthy();
+ expect(client.schema.hasTable('task_events')).toBeTruthy();
+ });
+
+ it('should list all created tasks', async () => {
+ const { store } = await createStore();
+ await store.createTask({
+ spec: {} as TaskSpec,
+ createdBy: 'me',
+ });
+
+ const { tasks } = await store.list({});
+ expect(tasks.length).toBe(1);
+ expect(tasks[0].createdBy).toBe('me');
+ expect(tasks[0].status).toBe('open');
+ expect(tasks[0].id).toBeDefined();
+ });
+
+ it('should list filtered created tasks by createdBy', async () => {
+ const { store } = await createStore();
+
+ await store.createTask({
+ spec: {} as TaskSpec,
+ createdBy: 'me',
+ });
+
+ await store.createTask({
+ spec: {} as TaskSpec,
+ createdBy: 'him',
+ });
+
+ const { tasks } = await store.list({ createdBy: 'him' });
+ expect(tasks.length).toBe(1);
+ expect(tasks[0].createdBy).toBe('him');
+ expect(tasks[0].status).toBe('open');
+ expect(tasks[0].id).toBeDefined();
+ });
+
+ it('should sent an event to start cancelling the task', async () => {
+ const { store } = await createStore();
+
+ const { taskId } = await store.createTask({
+ spec: {} as TaskSpec,
+ createdBy: 'me',
+ });
+ const task = await store.getTask(taskId);
+ expect(task.status).toBe('open');
+
+ await store.cancelTask({
+ taskId,
+ body: {
+ message: `Step 2 has been cancelled.`,
+ stepId: 2,
+ status: 'cancelled',
+ },
+ });
+
+ const { events } = await store.listEvents({ taskId });
+ const event = events[0];
+ expect(event.taskId).toBe(taskId);
+ expect(event.body.status).toBe('cancelled');
+ });
+
+ it('should emit a log event', async () => {
+ const { store } = await createStore();
+ const { taskId } = await store.createTask({
+ spec: {} as TaskSpec,
+ createdBy: 'me',
+ });
+ await store.emitLogEvent({
+ taskId,
+ body: {
+ message: 'Step #2 failed',
+ stepId: 2,
+ status: 'failed',
+ },
+ });
+ const { events } = await store.listEvents({ taskId });
+ const event = events[0];
+ expect(event.taskId).toBe(taskId);
+ expect(event.body.status).toBe('failed');
+ expect(event.type).toBe('log');
+ });
+
+ it('should complete the task', async () => {
+ const { store } = await createStore();
+ const { taskId } = await store.createTask({
+ spec: {} as TaskSpec,
+ createdBy: 'me',
+ });
+ const task = await store.getTask(taskId);
+ expect(task.status).toBe('open');
+
+ const message = `This task was marked as stale as it exceeded its timeout`;
+ await store.completeTask({
+ taskId,
+ status: 'cancelled',
+ eventBody: { message },
+ });
+
+ const taskAfterCompletion = await store.getTask(taskId);
+ expect(taskAfterCompletion.status).toBe('cancelled');
+ });
+
+ it('should claim a new task', async () => {
+ const { store } = await createStore();
+ const { taskId } = await store.createTask({
+ spec: {} as TaskSpec,
+ createdBy: 'me',
+ });
+ const task = await store.getTask(taskId);
+ expect(task.status).toBe('open');
+ await store.claimTask();
+
+ const claimedTask = await store.getTask(taskId);
+ expect(claimedTask.status).toBe('processing');
+ });
+
+ it('should shutdown the running task', async () => {
+ const { store } = await createStore();
+ const { taskId } = await store.createTask({
+ spec: {} as TaskSpec,
+ createdBy: 'me',
+ });
+ const task = await store.getTask(taskId);
+ expect(task.status).toBe('open');
+ await store.claimTask();
+ await store.shutdownTask({ taskId });
+
+ const claimedTask = await store.getTask(taskId);
+ expect(claimedTask.status).toBe('failed');
+ });
+
+ it('should be not possible to shutdown not running task', async () => {
+ const { store } = await createStore();
+ const { taskId } = await store.createTask({
+ spec: {} as TaskSpec,
+ createdBy: 'me',
+ });
+ const task = await store.getTask(taskId);
+ expect(task.status).toBe('open');
+ await expect(async () => {
+ await store.shutdownTask({ taskId });
+ }).rejects.toThrow(ConflictError);
+ });
+});
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts
index 879b457544..f3cb9b645e 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts
@@ -220,7 +220,7 @@ export class DatabaseTaskStore implements TaskStore {
.update({
status: 'processing',
last_heartbeat_at: this.db.fn.now(),
- // remove the secrets when moving moving to processing state.
+ // remove the secrets when moving to processing state.
secrets: null,
});
@@ -287,13 +287,14 @@ export class DatabaseTaskStore implements TaskStore {
const { taskId, status, eventBody } = options;
let oldStatus: string;
- if (status === 'failed' || status === 'completed') {
+ if (['failed', 'completed', 'cancelled'].includes(status)) {
oldStatus = 'processing';
} else {
throw new Error(
`Invalid status update of run '${taskId}' to status '${status}'`,
);
}
+
await this.db.transaction(async tx => {
const [task] = await tx('tasks')
.where({
@@ -302,6 +303,40 @@ export class DatabaseTaskStore implements TaskStore {
.limit(1)
.select();
+ const updateTask = async (criteria: {
+ id: string;
+ status?: TaskStatus;
+ }) => {
+ const updateCount = await tx('tasks')
+ .where(criteria)
+ .update({
+ status,
+ });
+
+ if (updateCount !== 1) {
+ throw new ConflictError(
+ `Failed to update status to '${status}' for taskId ${taskId}`,
+ );
+ }
+
+ await tx('task_events').insert({
+ task_id: taskId,
+ event_type: 'completion',
+ body: JSON.stringify(eventBody),
+ });
+ };
+
+ if (status === 'cancelled') {
+ await updateTask({
+ id: taskId,
+ });
+ return;
+ }
+
+ if (task.status === 'cancelled') {
+ return;
+ }
+
if (!task) {
throw new Error(`No task with taskId ${taskId} found`);
}
@@ -311,25 +346,10 @@ export class DatabaseTaskStore implements TaskStore {
`as it is currently '${task.status}', expected '${oldStatus}'`,
);
}
- const updateCount = await tx('tasks')
- .where({
- id: taskId,
- status: oldStatus,
- })
- .update({
- status,
- });
- if (updateCount !== 1) {
- throw new ConflictError(
- `Failed to update status to '${status}' for taskId ${taskId}`,
- );
- }
-
- await tx('task_events').insert({
- task_id: taskId,
- event_type: 'completion',
- body: JSON.stringify(eventBody),
+ await updateTask({
+ id: taskId,
+ status: oldStatus,
});
});
}
@@ -419,4 +439,16 @@ export class DatabaseTaskStore implements TaskStore {
},
});
}
+
+ async cancelTask(
+ options: TaskStoreEmitOptions<{ message: string } & JsonObject>,
+ ): Promise {
+ const { taskId, body } = options;
+ const serializedBody = JSON.stringify(body);
+ await this.db('task_events').insert({
+ task_id: taskId,
+ event_type: 'cancelled',
+ body: serializedBody,
+ });
+ }
}
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts
index 0d2246ed36..3b6ec54249 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts
@@ -70,6 +70,7 @@ describe('DefaultWorkflowRunner', () => {
complete: async () => {},
done: false,
emitLog: async () => {},
+ cancelSignal: new AbortController().signal,
getWorkspaceName: () => Promise.resolve('test-workspace'),
});
@@ -166,7 +167,7 @@ describe('DefaultWorkflowRunner', () => {
});
await expect(runner.execute(task)).rejects.toThrow(
- /Invalid input passed to action jest-validated-action, instance requires property \"foo\"/,
+ /Invalid input passed to action jest-validated-action, instance requires property "foo"/,
);
});
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts
index 88abe05cad..629c730d48 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts
@@ -15,7 +15,12 @@
*/
import { ScmIntegrations } from '@backstage/integration';
-import { TaskContext, WorkflowResponse, WorkflowRunner } from './types';
+import {
+ TaskContext,
+ TaskTrackType,
+ WorkflowResponse,
+ WorkflowRunner,
+} from './types';
import * as winston from 'winston';
import fs from 'fs-extra';
import path from 'path';
@@ -99,6 +104,7 @@ const createStepLogger = ({
export class NunjucksWorkflowRunner implements WorkflowRunner {
constructor(private readonly options: NunjucksWorkflowRunnerOptions) {}
+
private readonly tracker = scaffoldingTracker();
private isSingleTemplateString(input: string) {
@@ -180,6 +186,138 @@ export class NunjucksWorkflowRunner implements WorkflowRunner {
});
}
+ async executeStep(
+ task: TaskContext,
+ step: TaskStep,
+ context: TemplateContext,
+ renderTemplate: (template: string, values: unknown) => string,
+ taskTrack: TaskTrackType,
+ workspacePath: string,
+ ) {
+ const stepTrack = await this.tracker.stepStart(task, step);
+
+ if (task.cancelSignal.aborted) {
+ throw new Error(`Step ${step.name} has been cancelled.`);
+ }
+
+ try {
+ if (step.if) {
+ const ifResult = await this.render(step.if, context, renderTemplate);
+ if (!isTruthy(ifResult)) {
+ await stepTrack.skipFalsy();
+ return;
+ }
+ }
+
+ const action: TemplateAction =
+ this.options.actionRegistry.get(step.action);
+ const { taskLogger, streamLogger } = createStepLogger({ task, step });
+
+ if (task.isDryRun) {
+ const redactedSecrets = Object.fromEntries(
+ Object.entries(task.secrets ?? {}).map(secret => [
+ secret[0],
+ '[REDACTED]',
+ ]),
+ );
+ const debugInput =
+ (step.input &&
+ this.render(
+ step.input,
+ {
+ ...context,
+ secrets: redactedSecrets,
+ },
+ renderTemplate,
+ )) ??
+ {};
+ taskLogger.info(
+ `Running ${
+ action.id
+ } in dry-run mode with inputs (secrets redacted): ${JSON.stringify(
+ debugInput,
+ undefined,
+ 2,
+ )}`,
+ );
+ if (!action.supportsDryRun) {
+ await taskTrack.skipDryRun(step, action);
+ const outputSchema = action.schema?.output;
+ if (outputSchema) {
+ context.steps[step.id] = {
+ output: generateExampleOutput(outputSchema) as {
+ [name in string]: JsonValue;
+ },
+ };
+ } else {
+ context.steps[step.id] = { output: {} };
+ }
+ return;
+ }
+ }
+
+ // Secrets are only passed when templating the input to actions for security reasons
+ const input =
+ (step.input &&
+ this.render(
+ step.input,
+ { ...context, secrets: task.secrets ?? {} },
+ renderTemplate,
+ )) ??
+ {};
+
+ if (action.schema?.input) {
+ const validateResult = validateJsonSchema(input, action.schema.input);
+ if (!validateResult.valid) {
+ const errors = validateResult.errors.join(', ');
+ throw new InputError(
+ `Invalid input passed to action ${action.id}, ${errors}`,
+ );
+ }
+ }
+
+ const tmpDirs = new Array();
+ const stepOutput: { [outputName: string]: JsonValue } = {};
+
+ await action.handler({
+ input,
+ secrets: task.secrets ?? {},
+ logger: taskLogger,
+ logStream: streamLogger,
+ workspacePath,
+ createTemporaryDirectory: async () => {
+ const tmpDir = await fs.mkdtemp(`${workspacePath}_step-${step.id}-`);
+ tmpDirs.push(tmpDir);
+ return tmpDir;
+ },
+ output(name: string, value: JsonValue) {
+ stepOutput[name] = value;
+ },
+ templateInfo: task.spec.templateInfo,
+ user: task.spec.user,
+ isDryRun: task.isDryRun,
+ signal: task.cancelSignal,
+ });
+
+ // Remove all temporary directories that were created when executing the action
+ for (const tmpDir of tmpDirs) {
+ await fs.remove(tmpDir);
+ }
+
+ context.steps[step.id] = { output: stepOutput };
+
+ if (task.cancelSignal.aborted) {
+ throw new Error(`Step ${step.name} has been cancelled.`);
+ }
+
+ await stepTrack.markSuccessful();
+ } catch (err) {
+ await taskTrack.markFailed(step, err);
+ await stepTrack.markFailed();
+ throw err;
+ }
+ }
+
async execute(task: TaskContext): Promise {
if (!isValidTaskSpec(task.spec)) {
throw new InputError(
@@ -191,7 +329,12 @@ export class NunjucksWorkflowRunner implements WorkflowRunner {
await task.getWorkspaceName(),
);
- const { integrations } = this.options;
+ const {
+ additionalTemplateFilters,
+ additionalTemplateGlobals,
+ integrations,
+ } = this.options;
+
const renderTemplate = await SecureTemplater.loadRenderer({
// TODO(blam): let's work out how we can deprecate this.
// We shouldn't really need to be exposing these now we can deal with
@@ -200,8 +343,8 @@ export class NunjucksWorkflowRunner implements WorkflowRunner {
parseRepoUrl(url: string) {
return parseRepoUrl(url, integrations);
},
- additionalTemplateFilters: this.options.additionalTemplateFilters,
- additionalTemplateGlobals: this.options.additionalTemplateGlobals,
+ additionalTemplateFilters,
+ additionalTemplateGlobals,
});
try {
@@ -215,126 +358,14 @@ export class NunjucksWorkflowRunner implements WorkflowRunner {
};
for (const step of task.spec.steps) {
- const stepTrack = await this.tracker.stepStart(task, step);
- try {
- if (step.if) {
- const ifResult = await this.render(
- step.if,
- context,
- renderTemplate,
- );
- if (!isTruthy(ifResult)) {
- await stepTrack.skipFalsy();
- continue;
- }
- }
-
- const action = this.options.actionRegistry.get(step.action);
- const { taskLogger, streamLogger } = createStepLogger({ task, step });
-
- if (task.isDryRun) {
- const redactedSecrets = Object.fromEntries(
- Object.entries(task.secrets ?? {}).map(secret => [
- secret[0],
- '[REDACTED]',
- ]),
- );
- const debugInput =
- (step.input &&
- this.render(
- step.input,
- {
- ...context,
- secrets: redactedSecrets,
- },
- renderTemplate,
- )) ??
- {};
- taskLogger.info(
- `Running ${
- action.id
- } in dry-run mode with inputs (secrets redacted): ${JSON.stringify(
- debugInput,
- undefined,
- 2,
- )}`,
- );
- if (!action.supportsDryRun) {
- await taskTrack.skipDryRun(step, action);
- const outputSchema = action.schema?.output;
- if (outputSchema) {
- context.steps[step.id] = {
- output: generateExampleOutput(outputSchema) as {
- [name in string]: JsonValue;
- },
- };
- } else {
- context.steps[step.id] = { output: {} };
- }
- continue;
- }
- }
-
- // Secrets are only passed when templating the input to actions for security reasons
- const input =
- (step.input &&
- this.render(
- step.input,
- { ...context, secrets: task.secrets ?? {} },
- renderTemplate,
- )) ??
- {};
-
- if (action.schema?.input) {
- const validateResult = validateJsonSchema(
- input,
- action.schema.input,
- );
- if (!validateResult.valid) {
- const errors = validateResult.errors.join(', ');
- throw new InputError(
- `Invalid input passed to action ${action.id}, ${errors}`,
- );
- }
- }
-
- const tmpDirs = new Array();
- const stepOutput: { [outputName: string]: JsonValue } = {};
-
- await action.handler({
- input,
- secrets: task.secrets ?? {},
- logger: taskLogger,
- logStream: streamLogger,
- workspacePath,
- createTemporaryDirectory: async () => {
- const tmpDir = await fs.mkdtemp(
- `${workspacePath}_step-${step.id}-`,
- );
- tmpDirs.push(tmpDir);
- return tmpDir;
- },
- output(name: string, value: JsonValue) {
- stepOutput[name] = value;
- },
- templateInfo: task.spec.templateInfo,
- user: task.spec.user,
- isDryRun: task.isDryRun,
- });
-
- // Remove all temporary directories that were created when executing the action
- for (const tmpDir of tmpDirs) {
- await fs.remove(tmpDir);
- }
-
- context.steps[step.id] = { output: stepOutput };
-
- await stepTrack.markSuccessful();
- } catch (err) {
- await taskTrack.markFailed(step, err);
- await stepTrack.markFailed();
- throw err;
- }
+ await this.executeStep(
+ task,
+ step,
+ context,
+ renderTemplate,
+ taskTrack,
+ workspacePath,
+ );
}
const output = this.render(task.spec.output, context, renderTemplate);
@@ -380,7 +411,10 @@ function scaffoldingTracker() {
template,
});
- async function skipDryRun(step: TaskStep, action: TemplateAction) {
+ async function skipDryRun(
+ step: TaskStep,
+ action: TemplateAction,
+ ) {
task.emitLog(`Skipping because ${action.id} does not support dry-run`, {
stepId: step.id,
status: 'skipped',
@@ -409,8 +443,22 @@ function scaffoldingTracker() {
taskTimer({ result: 'failed' });
}
+ async function markCancelled(step: TaskStep) {
+ await task.emitLog(`Step ${step.id} has been cancelled.`, {
+ stepId: step.id,
+ status: 'cancelled',
+ });
+ taskCount.inc({
+ template,
+ user,
+ result: 'cancelled',
+ });
+ taskTimer({ result: 'cancelled' });
+ }
+
return {
skipDryRun,
+ markCancelled,
markSuccessful,
markFailed,
};
@@ -441,6 +489,15 @@ function scaffoldingTracker() {
stepTimer({ result: 'ok' });
}
+ async function markCancelled() {
+ stepCount.inc({
+ template,
+ step: step.name,
+ result: 'cancelled',
+ });
+ stepTimer({ result: 'cancelled' });
+ }
+
async function markFailed() {
stepCount.inc({
template,
@@ -459,8 +516,9 @@ function scaffoldingTracker() {
}
return {
- markSuccessful,
+ markCancelled,
markFailed,
+ markSuccessful,
skipFalsy,
};
}
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts
index d01351d8ae..fc5a724e47 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts
@@ -39,8 +39,13 @@ export class TaskManager implements TaskContext {
private heartbeatTimeoutId?: ReturnType;
- static create(task: CurrentClaimedTask, storage: TaskStore, logger: Logger) {
- const agent = new TaskManager(task, storage, logger);
+ static create(
+ task: CurrentClaimedTask,
+ storage: TaskStore,
+ abortSignal: AbortSignal,
+ logger: Logger,
+ ) {
+ const agent = new TaskManager(task, storage, abortSignal, logger);
agent.startTimeout();
return agent;
}
@@ -49,6 +54,7 @@ export class TaskManager implements TaskContext {
private constructor(
private readonly task: CurrentClaimedTask,
private readonly storage: TaskStore,
+ private readonly signal: AbortSignal,
private readonly logger: Logger,
) {}
@@ -56,6 +62,10 @@ export class TaskManager implements TaskContext {
return this.task.spec;
}
+ get cancelSignal() {
+ return this.signal;
+ }
+
get secrets() {
return this.task.secrets;
}
@@ -165,6 +175,33 @@ export class StorageTaskBroker implements TaskBroker {
private deferredDispatch = defer();
+ private async registerCancellable(
+ taskId: string,
+ abortController: AbortController,
+ ) {
+ let shouldUnsubscribe = false;
+ const subscription = this.event$({ taskId, after: undefined }).subscribe({
+ error: _ => {
+ subscription.unsubscribe();
+ },
+ next: ({ events }) => {
+ for (const event of events) {
+ if (event.type === 'cancelled') {
+ abortController.abort();
+ shouldUnsubscribe = true;
+ }
+
+ if (event.type === 'completion') {
+ shouldUnsubscribe = true;
+ }
+ }
+ if (shouldUnsubscribe) {
+ subscription.unsubscribe();
+ }
+ },
+ });
+ }
+
/**
* {@inheritdoc TaskBroker.claim}
*/
@@ -172,6 +209,8 @@ export class StorageTaskBroker implements TaskBroker {
for (;;) {
const pendingTask = await this.storage.claimTask();
if (pendingTask) {
+ const abortController = new AbortController();
+ await this.registerCancellable(pendingTask.id, abortController);
return TaskManager.create(
{
taskId: pendingTask.id,
@@ -180,6 +219,7 @@ export class StorageTaskBroker implements TaskBroker {
createdBy: pendingTask.createdBy,
},
this.storage,
+ abortController.signal,
this.logger,
);
}
@@ -271,4 +311,24 @@ export class StorageTaskBroker implements TaskBroker {
this.deferredDispatch.resolve();
this.deferredDispatch = defer();
}
+
+ async cancel(taskId: string) {
+ const { events } = await this.storage.listEvents({ taskId });
+ const currentStepId =
+ events.length > 0
+ ? events
+ .filter(({ body }) => body?.stepId)
+ .reduce((prev, curr) => (prev.id > curr.id ? prev : curr)).body
+ .stepId
+ : 0;
+
+ await this.storage.cancelTask?.({
+ taskId,
+ body: {
+ message: `Step ${currentStepId} has been cancelled.`,
+ stepId: currentStepId,
+ status: 'cancelled',
+ },
+ });
+ }
}
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.test.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.test.ts
index d39671cb67..e886b31369 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.test.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.test.ts
@@ -15,7 +15,7 @@
*/
import os from 'os';
-import { getVoidLogger, DatabaseManager } from '@backstage/backend-common';
+import { DatabaseManager, getVoidLogger } from '@backstage/backend-common';
import { ConfigReader } from '@backstage/config';
import { DatabaseTaskStore } from './DatabaseTaskStore';
import { StorageTaskBroker } from './StorageTaskBroker';
@@ -23,7 +23,14 @@ import { TaskWorker, TaskWorkerOptions } from './TaskWorker';
import { ScmIntegrations } from '@backstage/integration';
import { TemplateActionRegistry } from '../actions';
import { NunjucksWorkflowRunner } from './NunjucksWorkflowRunner';
-import { TaskBroker, TaskContext, WorkflowRunner } from './types';
+import {
+ SerializedTaskEvent,
+ TaskBroker,
+ TaskContext,
+ WorkflowRunner,
+} from './types';
+import ObservableImpl from 'zen-observable';
+import waitForExpect from 'wait-for-expect';
jest.mock('./NunjucksWorkflowRunner');
const MockedNunjucksWorkflowRunner =
@@ -198,6 +205,67 @@ describe('Concurrent TaskWorker', () => {
});
});
+describe('Cancellable TaskWorker', () => {
+ let storage: DatabaseTaskStore;
+ const integrations: ScmIntegrations = {} as ScmIntegrations;
+ const actionRegistry: TemplateActionRegistry = {} as TemplateActionRegistry;
+ const workingDirectory = os.tmpdir();
+
+ let myTask: TaskContext | undefined = undefined;
+
+ const workflowRunner: NunjucksWorkflowRunner = {
+ execute: (task: TaskContext) => {
+ myTask = task;
+ },
+ } as unknown as NunjucksWorkflowRunner;
+
+ beforeAll(async () => {
+ storage = await createStore();
+ });
+
+ beforeEach(() => {
+ jest.resetAllMocks();
+ MockedNunjucksWorkflowRunner.mockImplementation(() => workflowRunner);
+ });
+
+ const logger = getVoidLogger();
+
+ it('should be able to cancel the running task', async () => {
+ const taskBroker = new StorageTaskBroker(storage, logger);
+ const taskWorker = await TaskWorker.create({
+ logger,
+ workingDirectory,
+ integrations,
+ taskBroker,
+ actionRegistry,
+ });
+
+ const steps = [...Array(10)].map(n => ({
+ id: `test${n}`,
+ name: `test${n}`,
+ action: 'not-found-action',
+ }));
+
+ const { taskId } = await taskBroker.dispatch({
+ spec: {
+ apiVersion: 'scaffolder.backstage.io/v1beta3',
+ steps,
+ output: {
+ result: '{{ steps.test.output.testOutput }}',
+ },
+ parameters: {},
+ },
+ });
+
+ await taskWorker.start();
+ await taskBroker.cancel(taskId);
+
+ await waitForExpect(() => {
+ expect(myTask?.cancelSignal.aborted).toBeTruthy();
+ });
+ });
+});
+
describe('TaskWorker internals', () => {
const TaskWorkerConstructor = TaskWorker as unknown as {
new (options: TaskWorkerOptions): TaskWorker;
@@ -219,10 +287,24 @@ describe('TaskWorker internals', () => {
},
};
+ const subscribers = new Set<
+ ZenObservable.SubscriptionObserver<{ events: SerializedTaskEvent[] }>
+ >();
+
let claimedTaskCount = 0;
const taskWorker = new TaskWorkerConstructor({
runners: { workflowRunner },
taskBroker: {
+ event$() {
+ return new ObservableImpl<{ events: SerializedTaskEvent[] }>(
+ subscriber => {
+ subscribers.add(subscriber);
+ return () => {
+ subscribers.delete(subscriber);
+ };
+ },
+ );
+ },
async claim() {
claimedTaskCount++;
return {
@@ -233,7 +315,7 @@ describe('TaskWorker internals', () => {
async complete(_result, _metadata) {},
} as TaskContext;
},
- } as TaskBroker,
+ } as unknown as TaskBroker,
concurrentTasksLimit: 2,
});
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.ts
index 82829665a3..5723e7136f 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.ts
@@ -21,10 +21,7 @@ import { Logger } from 'winston';
import { TemplateActionRegistry } from '../actions';
import { ScmIntegrations } from '@backstage/integration';
import { assertError } from '@backstage/errors';
-import {
- TemplateFilter,
- TemplateGlobal,
-} from '../../lib/templating/SecureTemplater';
+import { TemplateFilter, TemplateGlobal } from '../../lib';
/**
* TaskWorkerOptions
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/types.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/types.ts
index 5a91802f3e..112276b9dd 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/types.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/types.ts
@@ -15,8 +15,9 @@
*/
import { JsonValue, JsonObject, Observable } from '@backstage/types';
-import { TaskSpec } from '@backstage/plugin-scaffolder-common';
+import { TaskSpec, TaskStep } from '@backstage/plugin-scaffolder-common';
import { TaskSecrets } from '@backstage/plugin-scaffolder-node';
+import { TemplateAction } from '@backstage/plugin-scaffolder-node';
/**
* The status of each step of the Task
@@ -24,11 +25,11 @@ import { TaskSecrets } from '@backstage/plugin-scaffolder-node';
* @public
*/
export type TaskStatus =
- | 'open'
- | 'processing'
- | 'failed'
| 'cancelled'
- | 'completed';
+ | 'completed'
+ | 'failed'
+ | 'open'
+ | 'processing';
/**
* The state of a completed task.
@@ -57,7 +58,7 @@ export type SerializedTask = {
*
* @public
*/
-export type TaskEventType = 'completion' | 'log';
+export type TaskEventType = 'completion' | 'log' | 'cancelled';
/**
* SerializedTaskEvent
@@ -99,13 +100,17 @@ export type TaskBrokerDispatchOptions = {
* @public
*/
export interface TaskContext {
+ cancelSignal: AbortSignal;
spec: TaskSpec;
secrets?: TaskSecrets;
createdBy?: string;
done: boolean;
isDryRun?: boolean;
- emitLog(message: string, logMetadata?: JsonObject): Promise;
+
complete(result: TaskCompletionState, metadata?: JsonObject): Promise;
+
+ emitLog(message: string, logMetadata?: JsonObject): Promise;
+
getWorkspaceName(): Promise;
}
@@ -115,16 +120,23 @@ export interface TaskContext {
* @public
*/
export interface TaskBroker {
+ cancel?(taskId: string): Promise;
+
claim(): Promise;
+
dispatch(
options: TaskBrokerDispatchOptions,
): Promise;
+
vacuumTasks(options: { timeoutS: number }): Promise;
+
event$(options: {
taskId: string;
after: number | undefined;
}): Observable<{ events: SerializedTaskEvent[] }>;
+
get(taskId: string): Promise;
+
list?(options?: { createdBy?: string }): Promise<{ tasks: SerializedTask[] }>;
}
@@ -181,30 +193,51 @@ export type TaskStoreCreateTaskResult = {
* @public
*/
export interface TaskStore {
+ cancelTask?(options: TaskStoreEmitOptions): Promise;
+
createTask(
options: TaskStoreCreateTaskOptions,
): Promise;
+
getTask(taskId: string): Promise;
+
claimTask(): Promise;
+
completeTask(options: {
taskId: string;
status: TaskStatus;
eventBody: JsonObject;
}): Promise;
+
heartbeatTask(taskId: string): Promise;
+
listStaleTasks(options: { timeoutS: number }): Promise<{
tasks: { taskId: string }[];
}>;
+
list?(options: { createdBy?: string }): Promise<{ tasks: SerializedTask[] }>;
emitLogEvent(options: TaskStoreEmitOptions): Promise;
+
listEvents(
options: TaskStoreListEventsOptions,
): Promise<{ events: SerializedTaskEvent[] }>;
+
shutdownTask?(options: TaskStoreShutDownTaskOptions): Promise;
}
export type WorkflowResponse = { output: { [key: string]: JsonValue } };
+
export interface WorkflowRunner {
execute(task: TaskContext): Promise;
}
+
+export type TaskTrackType = {
+ markCancelled: (step: TaskStep) => Promise;
+ markFailed: (step: TaskStep, err: Error) => Promise;
+ markSuccessful: () => Promise;
+ skipDryRun: (
+ step: TaskStep,
+ action: TemplateAction,
+ ) => Promise;
+};
diff --git a/plugins/scaffolder-backend/src/service/conditionExports.ts b/plugins/scaffolder-backend/src/service/conditionExports.ts
new file mode 100644
index 0000000000..0c502c6075
--- /dev/null
+++ b/plugins/scaffolder-backend/src/service/conditionExports.ts
@@ -0,0 +1,67 @@
+/*
+ * 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 { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE } from '@backstage/plugin-scaffolder-common/alpha';
+import { createConditionExports } from '@backstage/plugin-permission-node';
+import { scaffolderTemplateRules } from './rules';
+
+const { conditions, createConditionalDecision } = createConditionExports({
+ pluginId: 'scaffolder',
+ resourceType: RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,
+ rules: scaffolderTemplateRules,
+});
+
+/**
+ * These conditions are used when creating conditional decisions for scaffolder
+ * templates that are returned by authorization policies.
+ *
+ * @alpha
+ */
+export const scaffolderConditions = conditions;
+
+/**
+ * `createScaffolderConditionalDecision` can be used when authoring policies to
+ * create conditional decisions. It requires a permission of type
+ * `ResourcePermission<'scaffolder-template'>` to be passed as the first parameter.
+ * It's recommended that you use the provided `isResourcePermission` and
+ * `isPermission` helper methods to narrow the type of the permission passed to
+ * the handle method as shown below.
+ *
+ * ```
+ * // MyAuthorizationPolicy.ts
+ * ...
+ * import { createScaffolderPolicyDecision } from '@backstage/plugin-scaffolder-backend';
+ * import { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE } from '@backstage/plugin-scaffolder-common';
+ *
+ * class MyAuthorizationPolicy implements PermissionPolicy {
+ * async handle(request, user) {
+ * ...
+ *
+ * if (isResourcePermission(request.permission, RESOURCE_TYPE_SCAFFOLDER_TEMPLATE)) {
+ * return createScaffolderConditionalDecision(
+ * request.permission,
+ * { anyOf: [...insert conditions here...] }
+ * );
+ * }
+ *
+ * ...
+ * }
+ *
+ * ```
+ *
+ * @alpha
+ */
+export const createScaffolderConditionalDecision = createConditionalDecision;
diff --git a/plugins/scaffolder-backend/src/service/helpers.ts b/plugins/scaffolder-backend/src/service/helpers.ts
index 3412fec2d3..97d4ab93aa 100644
--- a/plugins/scaffolder-backend/src/service/helpers.ts
+++ b/plugins/scaffolder-backend/src/service/helpers.ts
@@ -107,3 +107,7 @@ export async function findTemplate(options: {
return template as TemplateEntityV1beta3;
}
+
+export type TemplateTransform = (
+ template: TemplateEntityV1beta3,
+) => TemplateEntityV1beta3;
diff --git a/plugins/scaffolder-backend/src/service/index.ts b/plugins/scaffolder-backend/src/service/index.ts
new file mode 100644
index 0000000000..dc5508d47f
--- /dev/null
+++ b/plugins/scaffolder-backend/src/service/index.ts
@@ -0,0 +1,17 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './conditionExports';
diff --git a/plugins/scaffolder-backend/src/service/router.test.ts b/plugins/scaffolder-backend/src/service/router.test.ts
index 5e3c1c7278..4f5ed0fe22 100644
--- a/plugins/scaffolder-backend/src/service/router.test.ts
+++ b/plugins/scaffolder-backend/src/service/router.test.ts
@@ -44,6 +44,10 @@ import {
IdentityApiGetIdentityRequest,
BackstageIdentityResponse,
} from '@backstage/plugin-auth-node';
+import {
+ AuthorizeResult,
+ PermissionEvaluator,
+} from '@backstage/plugin-permission-common';
const mockAccess = jest.fn();
@@ -85,8 +89,12 @@ describe('createRouter', () => {
let loggerSpy: jest.SpyInstance;
let taskBroker: TaskBroker;
const catalogClient = { getEntityByRef: jest.fn() } as unknown as CatalogApi;
+ const permissionApi = {
+ authorize: jest.fn(),
+ authorizeConditional: jest.fn(),
+ } as unknown as PermissionEvaluator;
- const mockTemplate: TemplateEntityV1beta3 = {
+ const getMockTemplate = (): TemplateEntityV1beta3 => ({
apiVersion: 'scaffolder.backstage.io/v1beta3',
kind: 'Template',
metadata: {
@@ -101,19 +109,54 @@ describe('createRouter', () => {
spec: {
owner: 'web@example.com',
type: 'website',
- steps: [],
- parameters: {
- type: 'object',
- required: ['required'],
- properties: {
- required: {
- type: 'string',
- description: 'Required parameter',
+ steps: [
+ {
+ id: 'step-one',
+ name: 'First log',
+ action: 'debug:log',
+ input: {
+ message: 'hello',
},
},
- },
+ {
+ id: 'step-two',
+ name: 'Second log',
+ action: 'debug:log',
+ input: {
+ message: 'world',
+ },
+ 'backstage:permissions': {
+ tags: ['steps-tag'],
+ },
+ },
+ ],
+ parameters: [
+ {
+ type: 'object',
+ required: ['requiredParameter1'],
+ properties: {
+ requiredParameter1: {
+ type: 'string',
+ description: 'Required parameter 1',
+ },
+ },
+ },
+ {
+ type: 'object',
+ required: ['requiredParameter2'],
+ 'backstage:permissions': {
+ tags: ['parameters-tag'],
+ },
+ properties: {
+ requiredParameter2: {
+ type: 'string',
+ description: 'Required parameter 2',
+ },
+ },
+ },
+ ],
},
- };
+ });
const mockUser: UserEntity = {
apiVersion: 'backstage.io/v1alpha1',
@@ -152,6 +195,7 @@ describe('createRouter', () => {
catalogClient,
reader: mockUrlReader,
taskBroker,
+ permissionApi,
});
app = express().use(router);
@@ -160,15 +204,27 @@ describe('createRouter', () => {
.mockImplementation(async ref => {
const { kind } = parseEntityRef(ref);
- if (kind === 'template') {
- return mockTemplate;
+ if (kind.toLocaleLowerCase() === 'template') {
+ return getMockTemplate();
}
- if (kind === 'user') {
+ if (kind.toLocaleLowerCase() === 'user') {
return mockUser;
}
+
throw new Error(`no mock found for kind: ${kind}`);
});
+
+ jest
+ .spyOn(permissionApi, 'authorizeConditional')
+ .mockImplementation(async () => [
+ {
+ result: AuthorizeResult.ALLOW,
+ },
+ {
+ result: AuthorizeResult.ALLOW,
+ },
+ ]);
});
afterEach(() => {
@@ -216,12 +272,13 @@ describe('createRouter', () => {
name: 'create-react-app-template',
}),
values: {
- required: 'required-value',
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
},
});
- expect(response.body.id).toBe('a-random-id');
expect(response.status).toEqual(201);
+ expect(response.body.id).toBe('a-random-id');
});
it('should call the broker with a correct spec', async () => {
@@ -229,6 +286,7 @@ describe('createRouter', () => {
taskBroker.dispatch as jest.Mocked['dispatch'];
const mockToken =
'blob.eyJzdWIiOiJ1c2VyOmRlZmF1bHQvZ3Vlc3QiLCJuYW1lIjoiSm9obiBEb2UifQ.blob';
+ const mockTemplate = getMockTemplate();
await request(app)
.post('/v2/tasks')
@@ -239,7 +297,8 @@ describe('createRouter', () => {
name: 'create-react-app-template',
}),
values: {
- required: 'required-value',
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
},
});
expect(broker).toHaveBeenCalledWith(
@@ -258,7 +317,8 @@ describe('createRouter', () => {
})),
output: mockTemplate.spec.output ?? {},
parameters: {
- required: 'required-value',
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
},
user: {
entity: mockUser,
@@ -284,6 +344,7 @@ describe('createRouter', () => {
const broker =
taskBroker.dispatch as jest.Mocked['dispatch'];
const mockToken = 'blob.eyJzdWIiOiIiLCJuYW1lIjoiSm9obiBEb2UifQ.blob';
+ const mockTemplate = getMockTemplate();
await request(app)
.post('/v2/tasks')
@@ -294,7 +355,8 @@ describe('createRouter', () => {
name: 'create-react-app-template',
}),
values: {
- required: 'required-value',
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
},
});
expect(broker).toHaveBeenCalledWith(
@@ -313,7 +375,8 @@ describe('createRouter', () => {
})),
output: mockTemplate.spec.output ?? {},
parameters: {
- required: 'required-value',
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
},
user: {
entity: undefined,
@@ -347,7 +410,8 @@ describe('createRouter', () => {
name: 'create-react-app-template',
}),
values: {
- required: 'required-value',
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
},
});
@@ -370,7 +434,8 @@ describe('createRouter', () => {
name: 'create-react-app-template',
}),
values: {
- required: 'required-value',
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
},
});
@@ -393,7 +458,8 @@ describe('createRouter', () => {
name: 'create-react-app-template',
}),
values: {
- required: 'required-value',
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
},
});
@@ -713,6 +779,7 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{
});
});
});
+
describe('providing an identity api', () => {
beforeEach(async () => {
const logger = getVoidLogger();
@@ -752,6 +819,7 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{
reader: mockUrlReader,
taskBroker,
identity: { getIdentity },
+ permissionApi,
});
app = express().use(router);
@@ -760,15 +828,26 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{
.mockImplementation(async ref => {
const { kind } = parseEntityRef(ref);
- if (kind === 'template') {
- return mockTemplate;
+ if (kind.toLocaleLowerCase() === 'template') {
+ return getMockTemplate();
}
- if (kind === 'user') {
+ if (kind.toLocaleLowerCase() === 'user') {
return mockUser;
}
throw new Error(`no mock found for kind: ${kind}`);
});
+
+ jest
+ .spyOn(permissionApi, 'authorizeConditional')
+ .mockImplementation(async () => [
+ {
+ result: AuthorizeResult.ALLOW,
+ },
+ {
+ result: AuthorizeResult.ALLOW,
+ },
+ ]);
});
afterEach(() => {
@@ -784,6 +863,125 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{
});
});
+ describe('GET /v2/templates/:namespace/:kind/:name/parameter-schema', () => {
+ it('returns the parameter schema', async () => {
+ const response = await request(app)
+ .get(
+ '/v2/templates/default/Template/create-react-app-template/parameter-schema',
+ )
+ .send();
+
+ expect(response.status).toEqual(200);
+ expect(response.body).toEqual({
+ title: 'Create React App Template',
+ description: 'Create a new CRA website project',
+ steps: [
+ {
+ title: 'Please enter the following information',
+ schema: {
+ required: ['requiredParameter1'],
+ type: 'object',
+ properties: {
+ requiredParameter1: {
+ description: 'Required parameter 1',
+ type: 'string',
+ },
+ },
+ },
+ },
+ {
+ title: 'Please enter the following information',
+ schema: {
+ type: 'object',
+ required: ['requiredParameter2'],
+ 'backstage:permissions': {
+ tags: ['parameters-tag'],
+ },
+ properties: {
+ requiredParameter2: {
+ type: 'string',
+ description: 'Required parameter 2',
+ },
+ },
+ },
+ },
+ ],
+ });
+ });
+
+ it('filters parameters that the user is not authorized to see', async () => {
+ jest
+ .spyOn(permissionApi, 'authorizeConditional')
+ .mockImplementationOnce(async () => [
+ {
+ result: AuthorizeResult.DENY,
+ },
+ {
+ result: AuthorizeResult.ALLOW,
+ },
+ ]);
+ const response = await request(app)
+ .get(
+ '/v2/templates/default/Template/create-react-app-template/parameter-schema',
+ )
+ .send();
+ expect(response.status).toEqual(200);
+ expect(response.body).toEqual({
+ title: 'Create React App Template',
+ description: 'Create a new CRA website project',
+ steps: [],
+ });
+ });
+
+ it('filters parameters that the user is not authorized to see in case of conditional decision', async () => {
+ jest
+ .spyOn(permissionApi, 'authorizeConditional')
+ .mockImplementationOnce(async () => [
+ {
+ conditions: {
+ resourceType: 'scaffolder-template',
+ rule: 'HAS_TAG',
+ params: { tag: 'parameters-tag' },
+ },
+ pluginId: 'scaffolder',
+ resourceType: 'scaffolder-template',
+ result: AuthorizeResult.CONDITIONAL,
+ },
+ {
+ result: AuthorizeResult.ALLOW,
+ },
+ ]);
+ const response = await request(app)
+ .get(
+ '/v2/templates/default/Template/create-react-app-template/parameter-schema',
+ )
+ .send();
+ expect(response.status).toEqual(200);
+ expect(response.body).toEqual({
+ title: 'Create React App Template',
+ description: 'Create a new CRA website project',
+ steps: [
+ {
+ title: 'Please enter the following information',
+ schema: {
+ type: 'object',
+ required: ['requiredParameter2'],
+ 'backstage:permissions': {
+ tags: ['parameters-tag'],
+ },
+ properties: {
+ requiredParameter2: {
+ type: 'string',
+ description: 'Required parameter 2',
+ },
+ },
+ },
+ },
+ ],
+ });
+ });
+ });
+
describe('POST /v2/tasks', () => {
it('rejects template values which do not match the template schema definition', async () => {
const response = await request(app)
@@ -801,6 +999,150 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{
expect(response.status).toEqual(400);
});
+ it('filters steps that the user is not authorized to see', async () => {
+ jest
+ .spyOn(permissionApi, 'authorizeConditional')
+ .mockImplementation(async () => [
+ {
+ result: AuthorizeResult.ALLOW,
+ },
+ {
+ result: AuthorizeResult.DENY,
+ },
+ ]);
+
+ const broker =
+ taskBroker.dispatch as jest.Mocked['dispatch'];
+ const mockTemplate = getMockTemplate();
+
+ await request(app)
+ .post('/v2/tasks')
+ .send({
+ templateRef: stringifyEntityRef({
+ kind: 'template',
+ name: 'create-react-app-template',
+ }),
+ values: {
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
+ },
+ });
+ expect(broker).toHaveBeenCalledWith(
+ expect.objectContaining({
+ createdBy: 'user:default/guest',
+ secrets: {
+ backstageToken: 'token',
+ },
+
+ spec: {
+ apiVersion: mockTemplate.apiVersion,
+ steps: [],
+ output: mockTemplate.spec.output ?? {},
+ parameters: {
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
+ },
+ user: {
+ entity: mockUser,
+ ref: 'user:default/guest',
+ },
+ templateInfo: {
+ entityRef: stringifyEntityRef({
+ kind: 'Template',
+ namespace: 'Default',
+ name: mockTemplate.metadata?.name,
+ }),
+ baseUrl: 'https://dev.azure.com',
+ entity: {
+ metadata: mockTemplate.metadata,
+ },
+ },
+ },
+ }),
+ );
+ });
+
+ it('filters steps that the user is not authorized to see in case of conditional decision', async () => {
+ jest
+ .spyOn(permissionApi, 'authorizeConditional')
+ .mockImplementation(async () => [
+ {
+ result: AuthorizeResult.ALLOW,
+ },
+ {
+ conditions: {
+ resourceType: 'scaffolder-template',
+ rule: 'HAS_TAG',
+ params: { tag: 'steps-tag' },
+ },
+ pluginId: 'scaffolder',
+ resourceType: 'scaffolder-template',
+ result: AuthorizeResult.CONDITIONAL,
+ },
+ ]);
+
+ const broker =
+ taskBroker.dispatch as jest.Mocked['dispatch'];
+ const mockTemplate = getMockTemplate();
+ await request(app)
+ .post('/v2/tasks')
+ .send({
+ templateRef: stringifyEntityRef({
+ kind: 'template',
+ name: 'create-react-app-template',
+ }),
+ values: {
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
+ },
+ });
+ expect(broker).toHaveBeenCalledWith(
+ expect.objectContaining({
+ createdBy: 'user:default/guest',
+ secrets: {
+ backstageToken: 'token',
+ },
+
+ spec: {
+ apiVersion: mockTemplate.apiVersion,
+ steps: [
+ {
+ id: 'step-two',
+ name: 'Second log',
+ action: 'debug:log',
+ input: {
+ message: 'world',
+ },
+ 'backstage:permissions': {
+ tags: ['steps-tag'],
+ },
+ },
+ ],
+ output: mockTemplate.spec.output ?? {},
+ parameters: {
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
+ },
+ user: {
+ entity: mockUser,
+ ref: 'user:default/guest',
+ },
+ templateInfo: {
+ entityRef: stringifyEntityRef({
+ kind: 'Template',
+ namespace: 'Default',
+ name: mockTemplate.metadata?.name,
+ }),
+ baseUrl: 'https://dev.azure.com',
+ entity: {
+ metadata: mockTemplate.metadata,
+ },
+ },
+ },
+ }),
+ );
+ });
+
it('return the template id', async () => {
const broker =
taskBroker.dispatch as jest.Mocked['dispatch'];
@@ -816,7 +1158,8 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{
name: 'create-react-app-template',
}),
values: {
- required: 'required-value',
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
},
});
@@ -827,6 +1170,7 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{
it('should call the broker with a correct spec', async () => {
const broker =
taskBroker.dispatch as jest.Mocked['dispatch'];
+ const mockTemplate = getMockTemplate();
await request(app)
.post('/v2/tasks')
@@ -836,7 +1180,8 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{
name: 'create-react-app-template',
}),
values: {
- required: 'required-value',
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
},
});
expect(broker).toHaveBeenCalledWith(
@@ -855,7 +1200,8 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{
})),
output: mockTemplate.spec.output ?? {},
parameters: {
- required: 'required-value',
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
},
user: {
entity: mockUser,
@@ -898,7 +1244,8 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{
name: 'create-react-app-template',
}),
values: {
- required: 'required-value',
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
},
});
expect(response.status).not.toEqual(201);
@@ -930,7 +1277,8 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{
name: 'create-react-app-template',
}),
values: {
- required: 'required-value',
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
},
});
@@ -953,7 +1301,8 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{
name: 'create-react-app-template',
}),
values: {
- required: 'required-value',
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
},
});
@@ -973,7 +1322,8 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{
name: 'create-react-app-template',
}),
values: {
- required: 'required-value',
+ requiredParameter1: 'required-value-1',
+ requiredParameter2: 'required-value-2',
},
});
diff --git a/plugins/scaffolder-backend/src/service/router.ts b/plugins/scaffolder-backend/src/service/router.ts
index dfccc4dc43..1f2d390f9f 100644
--- a/plugins/scaffolder-backend/src/service/router.ts
+++ b/plugins/scaffolder-backend/src/service/router.ts
@@ -18,6 +18,7 @@ import { PluginDatabaseManager, UrlReader } from '@backstage/backend-common';
import { PluginTaskScheduler } from '@backstage/backend-tasks';
import { CatalogApi } from '@backstage/catalog-client';
import {
+ CompoundEntityRef,
Entity,
parseEntityRef,
stringifyEntityRef,
@@ -31,7 +32,15 @@ import {
TaskSpec,
TemplateEntityV1beta3,
templateEntityV1beta3Validator,
+ TemplateParametersV1beta3,
+ TemplateEntityStepV1beta3,
} from '@backstage/plugin-scaffolder-common';
+import {
+ RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,
+ scaffolderPermissions,
+ templateParameterReadPermission,
+ templateStepReadPermission,
+} from '@backstage/plugin-scaffolder-common/alpha';
import express from 'express';
import Router from 'express-promise-router';
import { validate } from 'jsonschema';
@@ -53,6 +62,29 @@ import {
IdentityApiGetIdentityRequest,
} from '@backstage/plugin-auth-node';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
+import {
+ PermissionEvaluator,
+ PermissionRuleParams,
+} from '@backstage/plugin-permission-common';
+import {
+ createConditionAuthorizer,
+ createPermissionIntegrationRouter,
+ PermissionRule,
+} from '@backstage/plugin-permission-node';
+import { scaffolderTemplateRules } from './rules';
+
+/**
+ *
+ * @public
+ */
+export type TemplatePermissionRuleInput<
+ TParams extends PermissionRuleParams = PermissionRuleParams,
+> = PermissionRule<
+ TemplateEntityStepV1beta3 | TemplateParametersV1beta3,
+ {},
+ typeof RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,
+ TParams
+>;
/**
* RouterOptions
@@ -80,6 +112,8 @@ export interface RouterOptions {
taskBroker?: TaskBroker;
additionalTemplateFilters?: Record;
additionalTemplateGlobals?: Record;
+ permissionApi?: PermissionEvaluator;
+ permissionRules?: TemplatePermissionRuleInput[];
identity?: IdentityApi;
}
@@ -174,6 +208,8 @@ export async function createRouter(
scheduler,
additionalTemplateFilters,
additionalTemplateGlobals,
+ permissionApi,
+ permissionRules,
} = options;
const logger = parentLogger.child({ plugin: 'scaffolder' });
@@ -249,41 +285,46 @@ export async function createRouter(
additionalTemplateGlobals,
});
+ const templateRules: TemplatePermissionRuleInput[] = Object.values(
+ scaffolderTemplateRules,
+ );
+
+ if (permissionRules) {
+ templateRules.push(...permissionRules);
+ }
+
+ const isAuthorized = createConditionAuthorizer(Object.values(templateRules));
+
+ const permissionIntegrationRouter = createPermissionIntegrationRouter({
+ resourceType: RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,
+ permissions: scaffolderPermissions,
+ rules: templateRules,
+ });
+
+ router.use(permissionIntegrationRouter);
+
router
.get(
'/v2/templates/:namespace/:kind/:name/parameter-schema',
async (req, res) => {
- const { namespace, kind, name } = req.params;
-
const userIdentity = await identity.getIdentity({
request: req,
});
const token = userIdentity?.token;
- const template = await findTemplate({
- catalogApi: catalogClient,
- entityRef: { kind, namespace, name },
- token,
+ const template = await authorizeTemplate(req.params, token);
+
+ const parameters = [template.spec.parameters ?? []].flat();
+ res.json({
+ title: template.metadata.title ?? template.metadata.name,
+ description: template.metadata.description,
+ 'ui:options': template.metadata['ui:options'],
+ steps: parameters.map(schema => ({
+ title: schema.title ?? 'Please enter the following information',
+ description: schema.description,
+ schema,
+ })),
});
- if (isSupportedTemplate(template)) {
- const parameters = [template.spec.parameters ?? []].flat();
- res.json({
- title: template.metadata.title ?? template.metadata.name,
- description: template.metadata.description,
- 'ui:options': template.metadata['ui:options'],
- steps: parameters.map(schema => ({
- title: schema.title ?? 'Please enter the following information',
- description: schema.description,
- schema,
- })),
- });
- } else {
- throw new InputError(
- `Unsupported apiVersion field in schema entity, ${
- (template as Entity).apiVersion
- }`,
- );
- }
},
)
.get('/v2/actions', async (_req, res) => {
@@ -321,22 +362,14 @@ export async function createRouter(
const values = req.body.values;
- const template = await findTemplate({
- catalogApi: catalogClient,
- entityRef: { kind, namespace, name },
+ const template = await authorizeTemplate(
+ { kind, namespace, name },
token,
- });
-
- if (!isSupportedTemplate(template)) {
- throw new InputError(
- `Unsupported apiVersion field in schema entity, ${
- (template as Entity).apiVersion
- }`,
- );
- }
+ );
for (const parameters of [template.spec.parameters ?? []].flat()) {
const result = validate(values, parameters);
+
if (!result.valid) {
res.status(400).json({ errors: result.errors });
return;
@@ -414,6 +447,11 @@ export async function createRouter(
delete task.secrets;
res.status(200).json(task);
})
+ .post('/v2/tasks/:taskId/cancel', async (req, res) => {
+ const { taskId } = req.params;
+ await taskBroker.cancel?.(taskId);
+ res.status(200).json({ status: 'cancelled' });
+ })
.get('/v2/tasks/:taskId/eventstream', async (req, res) => {
const { taskId } = req.params;
const after =
@@ -562,5 +600,56 @@ export async function createRouter(
app.set('logger', logger);
app.use('/', router);
+ async function authorizeTemplate(
+ entityRef: CompoundEntityRef,
+ token: string | undefined,
+ ) {
+ const template = await findTemplate({
+ catalogApi: catalogClient,
+ entityRef,
+ token,
+ });
+
+ if (!isSupportedTemplate(template)) {
+ throw new InputError(
+ `Unsupported apiVersion field in schema entity, ${
+ (template as Entity).apiVersion
+ }`,
+ );
+ }
+
+ if (!permissionApi) {
+ return template;
+ }
+
+ const [parameterDecision, stepDecision] =
+ await permissionApi.authorizeConditional(
+ [
+ { permission: templateParameterReadPermission },
+ { permission: templateStepReadPermission },
+ ],
+ { token },
+ );
+
+ // Authorize parameters
+ if (Array.isArray(template.spec.parameters)) {
+ template.spec.parameters = template.spec.parameters.filter(step =>
+ isAuthorized(parameterDecision, step),
+ );
+ } else if (
+ template.spec.parameters &&
+ !isAuthorized(parameterDecision, template.spec.parameters)
+ ) {
+ template.spec.parameters = undefined;
+ }
+
+ // Authorize steps
+ template.spec.steps = template.spec.steps.filter(step =>
+ isAuthorized(stepDecision, step),
+ );
+
+ return template;
+ }
+
return app;
}
diff --git a/plugins/scaffolder-backend/src/service/rules.test.ts b/plugins/scaffolder-backend/src/service/rules.test.ts
new file mode 100644
index 0000000000..7d8e0eb445
--- /dev/null
+++ b/plugins/scaffolder-backend/src/service/rules.test.ts
@@ -0,0 +1,81 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { hasTag } from './rules';
+
+describe('hasTag', () => {
+ describe('apply', () => {
+ it('returns false when the tag is not present', () => {
+ expect(
+ hasTag.apply(
+ {
+ 'backstage:permissions': {
+ tags: ['foo', 'bar'],
+ },
+ },
+ {
+ tag: 'baz',
+ },
+ ),
+ ).toEqual(false);
+ });
+
+ it('returns false when backstage:permissions is missing', () => {
+ expect(
+ hasTag.apply(
+ {},
+ {
+ tag: 'baz',
+ },
+ ),
+ ).toEqual(false);
+ });
+
+ it('returns false when tags is an empty array', () => {
+ expect(
+ hasTag.apply(
+ {
+ apiVersion: 'backstage.io/v1alpha1',
+ kind: 'Component',
+ metadata: {
+ 'backstage:permissions': {
+ tags: [],
+ },
+ },
+ },
+ {
+ tag: 'baz',
+ },
+ ),
+ ).toEqual(false);
+ });
+
+ it('returns true when the tag is present', () => {
+ expect(
+ hasTag.apply(
+ {
+ 'backstage:permissions': {
+ tags: ['foo', 'bar'],
+ },
+ },
+ {
+ tag: 'bar',
+ },
+ ),
+ ).toEqual(true);
+ });
+ });
+});
diff --git a/plugins/scaffolder-backend/src/service/rules.ts b/plugins/scaffolder-backend/src/service/rules.ts
new file mode 100644
index 0000000000..d94f7dd4f4
--- /dev/null
+++ b/plugins/scaffolder-backend/src/service/rules.ts
@@ -0,0 +1,45 @@
+/*
+ * 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 { makeCreatePermissionRule } from '@backstage/plugin-permission-node';
+import {
+ TemplateEntityStepV1beta3,
+ TemplateParametersV1beta3,
+} from '@backstage/plugin-scaffolder-common';
+import { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE } from '@backstage/plugin-scaffolder-common/alpha';
+
+import { z } from 'zod';
+
+export const createScaffolderPermissionRule = makeCreatePermissionRule<
+ TemplateEntityStepV1beta3 | TemplateParametersV1beta3,
+ {},
+ typeof RESOURCE_TYPE_SCAFFOLDER_TEMPLATE
+>();
+
+export const hasTag = createScaffolderPermissionRule({
+ name: 'HAS_TAG',
+ resourceType: RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,
+ description: `Match parameters or steps with the given tag`,
+ paramsSchema: z.object({
+ tag: z.string().describe('Name of the tag to match on'),
+ }),
+ apply: (resource, { tag }) => {
+ return resource['backstage:permissions']?.tags?.includes(tag) ?? false;
+ },
+ toQuery: () => ({}),
+});
+
+export const scaffolderTemplateRules = { hasTag };
diff --git a/plugins/scaffolder-common/CHANGELOG.md b/plugins/scaffolder-common/CHANGELOG.md
index 8b50ec85a9..83e32d4d30 100644
--- a/plugins/scaffolder-common/CHANGELOG.md
+++ b/plugins/scaffolder-common/CHANGELOG.md
@@ -1,5 +1,22 @@
# @backstage/plugin-scaffolder-common
+## 1.2.7-next.0
+
+### Patch Changes
+
+- 48da4c46e45: Export `typeguard` for `isTemplateEntityV1beta3`
+- Updated dependencies
+ - @backstage/catalog-model@1.2.1
+ - @backstage/types@1.0.2
+
+## 1.2.6
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/catalog-model@1.2.1
+ - @backstage/types@1.0.2
+
## 1.2.6-next.1
### Patch Changes
diff --git a/plugins/scaffolder-common/alpha-api-report.md b/plugins/scaffolder-common/alpha-api-report.md
new file mode 100644
index 0000000000..e89999ad85
--- /dev/null
+++ b/plugins/scaffolder-common/alpha-api-report.md
@@ -0,0 +1,21 @@
+## API Report File for "@backstage/plugin-scaffolder-common"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { ResourcePermission } from '@backstage/plugin-permission-common';
+
+// @alpha
+export const RESOURCE_TYPE_SCAFFOLDER_TEMPLATE = 'scaffolder-template';
+
+// @alpha
+export const scaffolderPermissions: ResourcePermission<'scaffolder-template'>[];
+
+// @alpha
+export const templateParameterReadPermission: ResourcePermission<'scaffolder-template'>;
+
+// @alpha
+export const templateStepReadPermission: ResourcePermission<'scaffolder-template'>;
+
+// (No @packageDocumentation comment for this package)
+```
diff --git a/plugins/scaffolder-common/api-report.md b/plugins/scaffolder-common/api-report.md
index 8864c0d76d..7c40780b57 100644
--- a/plugins/scaffolder-common/api-report.md
+++ b/plugins/scaffolder-common/api-report.md
@@ -10,6 +10,11 @@ import type { JsonValue } from '@backstage/types';
import { KindValidator } from '@backstage/catalog-model';
import type { UserEntity } from '@backstage/catalog-model';
+// @public
+export const isTemplateEntityV1beta3: (
+ entity: Entity,
+) => entity is TemplateEntityV1beta3;
+
// @public
export type TaskSpec = TaskSpecV1beta3;
@@ -37,20 +42,30 @@ export interface TaskStep {
name: string;
}
+// @public
+export interface TemplateEntityStepV1beta3 extends JsonObject {
+ // (undocumented)
+ 'backstage:permissions'?: TemplatePermissionsV1beta3;
+ // (undocumented)
+ action: string;
+ // (undocumented)
+ id?: string;
+ // (undocumented)
+ if?: string | boolean;
+ // (undocumented)
+ input?: JsonObject;
+ // (undocumented)
+ name?: string;
+}
+
// @public
export interface TemplateEntityV1beta3 extends Entity {
apiVersion: 'scaffolder.backstage.io/v1beta3';
kind: 'Template';
spec: {
type: string;
- parameters?: JsonObject | JsonObject[];
- steps: Array<{
- id?: string;
- name?: string;
- action: string;
- input?: JsonObject;
- if?: string | boolean;
- }>;
+ parameters?: TemplateParametersV1beta3 | TemplateParametersV1beta3[];
+ steps: Array;
output?: {
[name: string]: string;
};
@@ -69,4 +84,16 @@ export type TemplateInfo = {
metadata: EntityMeta;
};
};
+
+// @public
+export interface TemplateParametersV1beta3 extends JsonObject {
+ // (undocumented)
+ 'backstage:permissions'?: TemplatePermissionsV1beta3;
+}
+
+// @public
+export interface TemplatePermissionsV1beta3 extends JsonObject {
+ // (undocumented)
+ tags?: string[];
+}
```
diff --git a/plugins/scaffolder-common/package.json b/plugins/scaffolder-common/package.json
index a64185d681..41c1b28fc1 100644
--- a/plugins/scaffolder-common/package.json
+++ b/plugins/scaffolder-common/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-scaffolder-common",
"description": "Common functionalities for the scaffolder, to be shared between scaffolder and scaffolder-backend plugin",
- "version": "1.2.6-next.1",
+ "version": "1.2.7-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -11,6 +11,21 @@
"module": "dist/index.esm.js",
"types": "dist/index.d.ts"
},
+ "exports": {
+ ".": "./src/index.ts",
+ "./alpha": "./src/alpha.ts",
+ "./package.json": "./package.json"
+ },
+ "typesVersions": {
+ "*": {
+ "alpha": [
+ "src/alpha.ts"
+ ],
+ "package.json": [
+ "package.json"
+ ]
+ }
+ },
"backstage": {
"role": "common-library"
},
@@ -39,6 +54,7 @@
},
"dependencies": {
"@backstage/catalog-model": "workspace:^",
+ "@backstage/plugin-permission-common": "workspace:^",
"@backstage/types": "workspace:^"
},
"devDependencies": {
diff --git a/plugins/scaffolder-common/src/Template.v1beta3.schema.json b/plugins/scaffolder-common/src/Template.v1beta3.schema.json
index e45bfb788d..beb0ca5e31 100644
--- a/plugins/scaffolder-common/src/Template.v1beta3.schema.json
+++ b/plugins/scaffolder-common/src/Template.v1beta3.schema.json
@@ -16,6 +16,9 @@
"owner": "artist-relations-team",
"parameters": {
"required": ["name", "description", "repoUrl"],
+ "backstage:permissions": {
+ "tags": ["one", "two"]
+ },
"properties": {
"name": {
"title": "Name",
@@ -41,6 +44,9 @@
"action": "fetch:plain",
"parameters": {
"url": "./template"
+ },
+ "backstage:permissions": {
+ "tags": ["one", "two"]
}
},
{
@@ -92,14 +98,42 @@
"oneOf": [
{
"type": "object",
- "description": "The JSONSchema describing the inputs for the template."
+ "description": "The JSONSchema describing the inputs for the template.",
+ "properties": {
+ "backstage:permissions": {
+ "type": "object",
+ "description": "Object used for authorizing the parameter",
+ "properties": {
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
},
{
"type": "array",
"description": "A list of separate forms to collect parameters.",
"items": {
"type": "object",
- "description": "The JSONSchema describing the inputs for the template."
+ "description": "The JSONSchema describing the inputs for the template.",
+ "properties": {
+ "backstage:permissions": {
+ "type": "object",
+ "description": "Object used for authorizing the parameter",
+ "properties": {
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
}
}
]
@@ -131,6 +165,18 @@
"if": {
"type": ["string", "boolean"],
"description": "A templated condition that skips the step when evaluated to false. If the condition is true or not defined, the step is executed. The condition is true, if the input is not `false`, `undefined`, `null`, `\"\"`, `0`, or `[]`."
+ },
+ "backstage:permissions": {
+ "type": "object",
+ "description": "Object used for authorizing the step",
+ "properties": {
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
}
}
}
diff --git a/plugins/scaffolder-common/src/TemplateEntityV1beta3.test.ts b/plugins/scaffolder-common/src/TemplateEntityV1beta3.test.ts
index ab5900ab32..432292548e 100644
--- a/plugins/scaffolder-common/src/TemplateEntityV1beta3.test.ts
+++ b/plugins/scaffolder-common/src/TemplateEntityV1beta3.test.ts
@@ -15,7 +15,10 @@
*/
import { entityKindSchemaValidator } from '@backstage/catalog-model';
-import type { TemplateEntityV1beta3 } from './TemplateEntityV1beta3';
+import type {
+ TemplateEntityV1beta3,
+ TemplateParametersV1beta3,
+} from './TemplateEntityV1beta3';
import schema from './Template.v1beta3.schema.json';
const validator = entityKindSchemaValidator(schema);
@@ -35,6 +38,7 @@ describe('templateEntityV1beta3Validator', () => {
owner: 'team-b',
parameters: {
required: ['owner'],
+ 'backstage:permissions': { tags: ['one', 'two'] },
properties: {
owner: {
type: 'string',
@@ -52,6 +56,9 @@ describe('templateEntityV1beta3Validator', () => {
url: './template',
},
if: '${{ parameters.owner }}',
+ 'backstage:permissions': {
+ tags: ['one', 'two'],
+ },
},
],
output: {
@@ -154,4 +161,24 @@ describe('templateEntityV1beta3Validator', () => {
(entity as any).spec.steps[0].if = 5;
expect(() => validator(entity)).toThrow(/if/);
});
+
+ it('rejects parameters with wrong backstage:permissions', async () => {
+ (entity.spec.parameters as TemplateParametersV1beta3)[
+ 'backstage:permissions'
+ ]!.tags = true as unknown as [];
+ expect(() => validator(entity)).toThrow(/must be array/);
+
+ (entity.spec.parameters as TemplateParametersV1beta3)[
+ 'backstage:permissions'
+ ] = true as {};
+ expect(() => validator(entity)).toThrow(/must be object/);
+ });
+
+ it('rejects steps with wrong backstage:permissions', async () => {
+ entity.spec.steps[0]['backstage:permissions']!.tags = true as unknown as [];
+ expect(() => validator(entity)).toThrow(/must be array/);
+
+ entity.spec.steps[0]['backstage:permissions'] = true as {};
+ expect(() => validator(entity)).toThrow(/must be object/);
+ });
});
diff --git a/plugins/scaffolder-common/src/TemplateEntityV1beta3.ts b/plugins/scaffolder-common/src/TemplateEntityV1beta3.ts
index 8ded484ee2..ebabb5cad4 100644
--- a/plugins/scaffolder-common/src/TemplateEntityV1beta3.ts
+++ b/plugins/scaffolder-common/src/TemplateEntityV1beta3.ts
@@ -50,18 +50,12 @@ export interface TemplateEntityV1beta3 extends Entity {
* to collect user input and validate it against that schema. This can then be used in the `steps` part below to template
* variables passed from the user into each action in the template.
*/
- parameters?: JsonObject | JsonObject[];
+ parameters?: TemplateParametersV1beta3 | TemplateParametersV1beta3[];
/**
* A list of steps to be executed in sequence which are defined by the template. These steps are a list of the underlying
* javascript action and some optional input parameters that may or may not have been collected from the end user.
*/
- steps: Array<{
- id?: string;
- name?: string;
- action: string;
- input?: JsonObject;
- if?: string | boolean;
- }>;
+ steps: Array;
/**
* The output is an object where template authors can pull out information from template actions and return them in a known standard way.
*/
@@ -73,6 +67,38 @@ export interface TemplateEntityV1beta3 extends Entity {
};
}
+/**
+ * Step that is part of a Template Entity.
+ *
+ * @public
+ */
+export interface TemplateEntityStepV1beta3 extends JsonObject {
+ id?: string;
+ name?: string;
+ action: string;
+ input?: JsonObject;
+ if?: string | boolean;
+ 'backstage:permissions'?: TemplatePermissionsV1beta3;
+}
+
+/**
+ * Parameter that is part of a Template Entity.
+ *
+ * @public
+ */
+export interface TemplateParametersV1beta3 extends JsonObject {
+ 'backstage:permissions'?: TemplatePermissionsV1beta3;
+}
+
+/**
+ * Access control properties for parts of a template.
+ *
+ * @public
+ */
+export interface TemplatePermissionsV1beta3 extends JsonObject {
+ tags?: string[];
+}
+
const validator = entityKindSchemaValidator(schema);
/**
@@ -86,3 +112,13 @@ export const templateEntityV1beta3Validator: KindValidator = {
return validator(data) === data;
},
};
+
+/**
+ * Typeguard for filtering entities and ensuring v1beta3 entities
+ * @public
+ */
+export const isTemplateEntityV1beta3 = (
+ entity: Entity,
+): entity is TemplateEntityV1beta3 =>
+ entity.apiVersion === 'scaffolder.backstage.io/v1beta3' &&
+ entity.kind === 'Template';
diff --git a/plugins/scaffolder-common/src/alpha.ts b/plugins/scaffolder-common/src/alpha.ts
new file mode 100644
index 0000000000..9a8c021d15
--- /dev/null
+++ b/plugins/scaffolder-common/src/alpha.ts
@@ -0,0 +1,16 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from './permissions';
diff --git a/plugins/scaffolder-common/src/index.ts b/plugins/scaffolder-common/src/index.ts
index 521e678ab6..fd34fe6f41 100644
--- a/plugins/scaffolder-common/src/index.ts
+++ b/plugins/scaffolder-common/src/index.ts
@@ -21,5 +21,14 @@
*/
export * from './TaskSpec';
-export { templateEntityV1beta3Validator } from './TemplateEntityV1beta3';
-export type { TemplateEntityV1beta3 } from './TemplateEntityV1beta3';
+
+export {
+ templateEntityV1beta3Validator,
+ isTemplateEntityV1beta3,
+} from './TemplateEntityV1beta3';
+export type {
+ TemplateEntityV1beta3,
+ TemplateEntityStepV1beta3,
+ TemplateParametersV1beta3,
+ TemplatePermissionsV1beta3,
+} from './TemplateEntityV1beta3';
diff --git a/plugins/scaffolder-common/src/permissions.ts b/plugins/scaffolder-common/src/permissions.ts
new file mode 100644
index 0000000000..858430eaf3
--- /dev/null
+++ b/plugins/scaffolder-common/src/permissions.ts
@@ -0,0 +1,69 @@
+/*
+ * 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 { createPermission } from '@backstage/plugin-permission-common';
+
+/**
+ * Permission resource type which corresponds to a scaffolder templates.
+ *
+ * @alpha
+ */
+export const RESOURCE_TYPE_SCAFFOLDER_TEMPLATE = 'scaffolder-template';
+
+/**
+ * This permission is used to authorize actions that involve reading
+ * one or more parameters from a template.
+ *
+ * If this permission is not authorized, it will appear that the
+ * parameter does not exist in the template — both in the frontend
+ * and in API responses.
+ *
+ * @alpha
+ */
+export const templateParameterReadPermission = createPermission({
+ name: 'scaffolder.template.parameter.read',
+ attributes: {
+ action: 'read',
+ },
+ resourceType: RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,
+});
+
+/**
+ * This permission is used to authorize actions that involve reading
+ * one or more steps from a template.
+ *
+ * If this permission is not authorized, it will appear that the
+ * step does not exist in the template — both in the frontend
+ * and in API responses. Steps will also not be executed.
+ *
+ * @alpha
+ */
+export const templateStepReadPermission = createPermission({
+ name: 'scaffolder.template.step.read',
+ attributes: {
+ action: 'read',
+ },
+ resourceType: RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,
+});
+
+/**
+ * List of all the scaffolder permissions
+ * @alpha
+ */
+export const scaffolderPermissions = [
+ templateParameterReadPermission,
+ templateStepReadPermission,
+];
diff --git a/plugins/scaffolder-node/CHANGELOG.md b/plugins/scaffolder-node/CHANGELOG.md
index 37b9613524..aa73af9a1f 100644
--- a/plugins/scaffolder-node/CHANGELOG.md
+++ b/plugins/scaffolder-node/CHANGELOG.md
@@ -1,5 +1,26 @@
# @backstage/plugin-scaffolder-node
+## 0.1.2-next.0
+
+### Patch Changes
+
+- e27ddc36dad: Added a possibility to cancel the running task (executing of a scaffolder template)
+- Updated dependencies
+ - @backstage/plugin-scaffolder-common@1.2.7-next.0
+ - @backstage/backend-plugin-api@0.5.1-next.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/types@1.0.2
+
+## 0.1.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-plugin-api@0.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/types@1.0.2
+ - @backstage/plugin-scaffolder-common@1.2.6
+
## 0.1.1-next.2
### Patch Changes
diff --git a/plugins/scaffolder-node/api-report.md b/plugins/scaffolder-node/api-report.md
index 89b7171ef9..d5b9b73767 100644
--- a/plugins/scaffolder-node/api-report.md
+++ b/plugins/scaffolder-node/api-report.md
@@ -30,6 +30,7 @@ export type ActionContext = {
entity?: UserEntity;
ref?: string;
};
+ signal?: AbortSignal;
};
// @public
diff --git a/plugins/scaffolder-node/package.json b/plugins/scaffolder-node/package.json
index 8978c155bf..d63fddc0b5 100644
--- a/plugins/scaffolder-node/package.json
+++ b/plugins/scaffolder-node/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-scaffolder-node",
"description": "The plugin-scaffolder-node module for @backstage/plugin-scaffolder-backend",
- "version": "0.1.1-next.2",
+ "version": "0.1.2-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -30,8 +30,8 @@
"@backstage/types": "workspace:^",
"jsonschema": "^1.2.6",
"winston": "^3.2.1",
- "zod": "~3.18.0",
- "zod-to-json-schema": "~3.18.0"
+ "zod": "^3.21.4",
+ "zod-to-json-schema": "^3.20.4"
},
"devDependencies": {
"@backstage/cli": "workspace:^"
diff --git a/plugins/scaffolder-node/src/actions/types.ts b/plugins/scaffolder-node/src/actions/types.ts
index cce149adbe..8827aaf98c 100644
--- a/plugins/scaffolder-node/src/actions/types.ts
+++ b/plugins/scaffolder-node/src/actions/types.ts
@@ -60,6 +60,11 @@ export type ActionContext = {
*/
ref?: string;
};
+
+ /**
+ * Implement the signal to make your custom step abortable https://developer.mozilla.org/en-US/docs/Web/API/AbortController/signal
+ */
+ signal?: AbortSignal;
};
/** @public */
diff --git a/plugins/scaffolder-react/CHANGELOG.md b/plugins/scaffolder-react/CHANGELOG.md
index 25385e4816..5993000724 100644
--- a/plugins/scaffolder-react/CHANGELOG.md
+++ b/plugins/scaffolder-react/CHANGELOG.md
@@ -1,5 +1,61 @@
# @backstage/plugin-scaffolder-react
+## 1.3.0-next.0
+
+### Minor Changes
+
+- 259d3407b9b: Move `CategoryPicker` from `scaffolder` into `scaffolder-react`
+ Move `ContextMenu` into `scaffolder-react` and rename it to `ScaffolderPageContextMenu`
+- 2cfd03d7376: To offer better customization options, `ScaffolderPageContextMenu` takes callbacks as props instead of booleans
+- 48da4c46e45: `scaffolder/next`: Export the `TemplateGroupFilter` and `TemplateGroups` and make an extensible component
+
+### Patch Changes
+
+- e27ddc36dad: Added a possibility to cancel the running task (executing of a scaffolder template)
+- 7a6b16cc506: `scaffolder/next`: Bump `@rjsf/*` deps to 5.3.1
+- f84fc7fd040: Updated dependency `@rjsf/validator-ajv8` to `5.3.0`.
+- 8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
+- Updated dependencies
+ - @backstage/plugin-scaffolder-common@1.2.7-next.0
+ - @backstage/core-components@0.12.6-next.0
+ - @backstage/plugin-catalog-react@1.4.1-next.0
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-client@1.4.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/errors@1.1.5
+ - @backstage/theme@0.2.18
+ - @backstage/types@1.0.2
+ - @backstage/version-bridge@1.0.3
+
+## 1.2.0
+
+### Minor Changes
+
+- 8f4d13f21cf: Move `useTaskStream`, `TaskBorder`, `TaskLogStream` and `TaskSteps` into `scaffolder-react`.
+
+### Patch Changes
+
+- 65454876fb2: Minor API report tweaks
+- 3c96e77b513: Make scaffolder adhere to page themes by using page `fontColor` consistently. If your theme overwrites template list or card headers, review those styles.
+- c8d78b9ae9d: fix bug with `hasErrors` returning false when dealing with empty objects
+- 9b8c374ace5: Remove timer for skipped steps in Scaffolder Next's TaskSteps
+- 44941fc97eb: scaffolder/next: Move the `uiSchema` to its own property in the validation `context` to align with component development and access of `ui:options`
+- d9893263ba9: scaffolder/next: Fix for steps without properties
+- 928a12a9b3e: Internal refactor of `/alpha` exports.
+- cc418d652a7: scaffolder/next: Added the ability to get the fields definition in the schema in the validation function
+- d4100d0ec42: Fix alignment bug for owners on `TemplateCard`
+- Updated dependencies
+ - @backstage/catalog-client@1.4.0
+ - @backstage/core-components@0.12.5
+ - @backstage/plugin-catalog-react@1.4.0
+ - @backstage/errors@1.1.5
+ - @backstage/core-plugin-api@1.5.0
+ - @backstage/catalog-model@1.2.1
+ - @backstage/theme@0.2.18
+ - @backstage/types@1.0.2
+ - @backstage/version-bridge@1.0.3
+ - @backstage/plugin-scaffolder-common@1.2.6
+
## 1.2.0-next.2
### Patch Changes
diff --git a/plugins/scaffolder-react/alpha-api-report.md b/plugins/scaffolder-react/alpha-api-report.md
index 35029cb796..319e3963f0 100644
--- a/plugins/scaffolder-react/alpha-api-report.md
+++ b/plugins/scaffolder-react/alpha-api-report.md
@@ -132,6 +132,18 @@ export type ReviewStateProps = {
formState: JsonObject;
};
+// @alpha (undocumented)
+export function ScaffolderPageContextMenu(
+ props: ScaffolderPageContextMenuProps,
+): JSX.Element | null;
+
+// @alpha (undocumented)
+export type ScaffolderPageContextMenuProps = {
+ onEditorClicked?: () => void;
+ onActionsClicked?: () => void;
+ onTasksClicked?: () => void;
+};
+
// @alpha
export const Stepper: (stepperProps: StepperProps) => JSX.Element;
@@ -190,9 +202,18 @@ export interface TemplateCardProps {
template: TemplateEntityV1beta3;
}
+// @alpha
+export const TemplateCategoryPicker: () => JSX.Element | null;
+
// @alpha
export const TemplateGroup: (props: TemplateGroupProps) => JSX.Element;
+// @alpha (undocumented)
+export type TemplateGroupFilter = {
+ title?: React_2.ReactNode;
+ filter: (entity: TemplateEntityV1beta3) => boolean;
+};
+
// @alpha
export interface TemplateGroupProps {
// (undocumented)
@@ -214,6 +235,29 @@ export interface TemplateGroupProps {
title: React_2.ReactNode;
}
+// @alpha (undocumented)
+export const TemplateGroups: (props: TemplateGroupsProps) => JSX.Element | null;
+
+// @alpha (undocumented)
+export interface TemplateGroupsProps {
+ // (undocumented)
+ additionalLinksForEntity?: (template: TemplateEntityV1beta3) => {
+ icon: IconComponent;
+ text: string;
+ url: string;
+ }[];
+ // (undocumented)
+ groups: TemplateGroupFilter[];
+ // (undocumented)
+ onTemplateSelected?: (template: TemplateEntityV1beta3) => void;
+ // (undocumented)
+ TemplateCardComponent?: React_2.ComponentType<{
+ template: TemplateEntityV1beta3;
+ }>;
+ // (undocumented)
+ templateFilter?: (entity: TemplateEntityV1beta3) => boolean;
+}
+
// @alpha
export const useFormDataFromQuery: (
initialState?: Record,
diff --git a/plugins/scaffolder-react/api-report.md b/plugins/scaffolder-react/api-report.md
index 0fbc8d0eed..da8309d5ec 100644
--- a/plugins/scaffolder-react/api-report.md
+++ b/plugins/scaffolder-react/api-report.md
@@ -113,7 +113,7 @@ export type ListActionsResponse = Array;
// @public
export type LogEvent = {
- type: 'log' | 'completion';
+ type: 'log' | 'completion' | 'cancelled';
body: {
message: string;
stepId?: string;
@@ -126,6 +126,7 @@ export type LogEvent = {
// @public
export interface ScaffolderApi {
+ cancelTask(taskId: string): Promise;
// (undocumented)
dryRun?(options: ScaffolderDryRunOptions): Promise;
// (undocumented)
@@ -266,10 +267,11 @@ export type ScaffolderTaskOutput = {
// @public
export type ScaffolderTaskStatus =
+ | 'cancelled'
+ | 'completed'
+ | 'failed'
| 'open'
| 'processing'
- | 'failed'
- | 'completed'
| 'skipped';
// @public
@@ -287,6 +289,7 @@ export const SecretsContextProvider: (
// @public
export type TaskStream = {
+ cancelled: boolean;
loading: boolean;
error?: Error;
stepLogs: {
diff --git a/plugins/scaffolder-react/package.json b/plugins/scaffolder-react/package.json
index 4e0cb590e4..db0b30c758 100644
--- a/plugins/scaffolder-react/package.json
+++ b/plugins/scaffolder-react/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-scaffolder-react",
"description": "A frontend library that helps other Backstage plugins interact with the Scaffolder",
- "version": "1.2.0-next.2",
+ "version": "1.3.0-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -57,14 +57,14 @@
"@backstage/version-bridge": "workspace:^",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
- "@material-ui/lab": "4.0.0-alpha.57",
+ "@material-ui/lab": "4.0.0-alpha.61",
"@react-hookz/web": "^20.0.0",
"@rjsf/core": "^3.2.1",
- "@rjsf/core-v5": "npm:@rjsf/core@5.1.0",
+ "@rjsf/core-v5": "npm:@rjsf/core@5.3.1",
"@rjsf/material-ui": "^3.2.1",
- "@rjsf/material-ui-v5": "npm:@rjsf/material-ui@5.1.0",
- "@rjsf/utils": "5.1.0",
- "@rjsf/validator-ajv8": "5.1.0",
+ "@rjsf/material-ui-v5": "npm:@rjsf/material-ui@5.3.1",
+ "@rjsf/utils": "5.3.1",
+ "@rjsf/validator-ajv8": "5.3.1",
"@types/json-schema": "^7.0.9",
"classnames": "^2.2.6",
"humanize-duration": "^3.25.1",
@@ -77,8 +77,8 @@
"react-use": "^17.2.4",
"use-immer": "^0.8.0",
"zen-observable": "^0.10.0",
- "zod": "~3.18.0",
- "zod-to-json-schema": "~3.18.0"
+ "zod": "^3.21.4",
+ "zod-to-json-schema": "^3.20.4"
},
"peerDependencies": {
"@types/react": "^16.13.1 || ^17.0.0",
diff --git a/plugins/scaffolder-react/src/api/types.ts b/plugins/scaffolder-react/src/api/types.ts
index 0a517e7bff..b39555c14f 100644
--- a/plugins/scaffolder-react/src/api/types.ts
+++ b/plugins/scaffolder-react/src/api/types.ts
@@ -24,10 +24,11 @@ import { TemplateParameterSchema } from '../types';
* @public
*/
export type ScaffolderTaskStatus =
+ | 'cancelled'
+ | 'completed'
+ | 'failed'
| 'open'
| 'processing'
- | 'failed'
- | 'completed'
| 'skipped';
/**
@@ -96,7 +97,7 @@ export type ScaffolderTaskOutput = {
* @public
*/
export type LogEvent = {
- type: 'log' | 'completion';
+ type: 'log' | 'completion' | 'cancelled';
body: {
message: string;
stepId?: string;
@@ -196,6 +197,13 @@ export interface ScaffolderApi {
getTask(taskId: string): Promise;
+ /**
+ * Sends a signal to a task broker to cancel the running task by taskId.
+ *
+ * @param taskId - the id of the task
+ */
+ cancelTask(taskId: string): Promise;
+
listTasks?(options: {
filterByOwnership: 'owned' | 'all';
}): Promise<{ tasks: ScaffolderTask[] }>;
diff --git a/plugins/scaffolder-react/src/hooks/useEventStream.ts b/plugins/scaffolder-react/src/hooks/useEventStream.ts
index d8c9cf4c1f..ec49911471 100644
--- a/plugins/scaffolder-react/src/hooks/useEventStream.ts
+++ b/plugins/scaffolder-react/src/hooks/useEventStream.ts
@@ -44,6 +44,7 @@ export type ScaffolderStep = {
* @public
*/
export type TaskStream = {
+ cancelled: boolean;
loading: boolean;
error?: Error;
stepLogs: { [stepId in string]: string[] };
@@ -66,6 +67,7 @@ type ReducerLogEntry = {
type ReducerAction =
| { type: 'INIT'; data: ScaffolderTask }
+ | { type: 'CANCELLED' }
| { type: 'LOGS'; data: ReducerLogEntry[] }
| { type: 'COMPLETED'; data: ReducerLogEntry }
| { type: 'ERROR'; data: Error };
@@ -111,7 +113,7 @@ function reducer(draft: TaskStream, action: ReducerAction) {
}
if (
- ['cancelled', 'failed', 'completed'].includes(currentStep.status)
+ ['cancelled', 'completed', 'failed'].includes(currentStep.status)
) {
currentStep.endedAt = entry.createdAt;
}
@@ -131,6 +133,11 @@ function reducer(draft: TaskStream, action: ReducerAction) {
return;
}
+ case 'CANCELLED': {
+ draft.cancelled = true;
+ return;
+ }
+
case 'ERROR': {
draft.error = action.data;
draft.loading = false;
@@ -151,6 +158,7 @@ function reducer(draft: TaskStream, action: ReducerAction) {
export const useTaskEventStream = (taskId: string): TaskStream => {
const scaffolderApi = useApi(scaffolderApiRef);
const [state, dispatch] = useImmerReducer(reducer, {
+ cancelled: false,
loading: true,
completed: false,
stepLogs: {} as { [stepId in string]: string[] },
@@ -196,6 +204,9 @@ export const useTaskEventStream = (taskId: string): TaskStream => {
switch (event.type) {
case 'log':
return collectedLogEvents.push(event);
+ case 'cancelled':
+ dispatch({ type: 'CANCELLED' });
+ return undefined;
case 'completion':
emitLogs();
dispatch({ type: 'COMPLETED', data: event });
diff --git a/plugins/scaffolder/src/next/TemplateListPage/ContextMenu.tsx b/plugins/scaffolder-react/src/next/components/ScaffolderPageContextMenu/ScaffolderPageContextMenu.tsx
similarity index 74%
rename from plugins/scaffolder/src/next/TemplateListPage/ContextMenu.tsx
rename to plugins/scaffolder-react/src/next/components/ScaffolderPageContextMenu/ScaffolderPageContextMenu.tsx
index d78b8a62c4..fc3c0249a0 100644
--- a/plugins/scaffolder/src/next/TemplateListPage/ContextMenu.tsx
+++ b/plugins/scaffolder-react/src/next/components/ScaffolderPageContextMenu/ScaffolderPageContextMenu.tsx
@@ -14,7 +14,6 @@
* limitations under the License.
*/
-import { useRouteRef } from '@backstage/core-plugin-api';
import { BackstageTheme } from '@backstage/theme';
import IconButton from '@material-ui/core/IconButton';
import ListItemIcon from '@material-ui/core/ListItemIcon';
@@ -28,12 +27,6 @@ import Edit from '@material-ui/icons/Edit';
import List from '@material-ui/icons/List';
import MoreVert from '@material-ui/icons/MoreVert';
import React, { useState } from 'react';
-import { useNavigate } from 'react-router-dom';
-import {
- nextActionsRouteRef,
- nextEditRouteRef,
- nextScaffolderListTaskRouteRef,
-} from '../routes';
const useStyles = makeStyles((theme: BackstageTheme) => ({
button: {
@@ -41,26 +34,26 @@ const useStyles = makeStyles((theme: BackstageTheme) => ({
},
}));
+/**
+ * @alpha
+ */
export type ScaffolderPageContextMenuProps = {
- editor?: boolean;
- actions?: boolean;
- tasks?: boolean;
+ onEditorClicked?: () => void;
+ onActionsClicked?: () => void;
+ onTasksClicked?: () => void;
};
-export function ContextMenu(props: ScaffolderPageContextMenuProps) {
+/**
+ * @alpha
+ */
+export function ScaffolderPageContextMenu(
+ props: ScaffolderPageContextMenuProps,
+) {
+ const { onEditorClicked, onActionsClicked, onTasksClicked } = props;
const classes = useStyles();
const [anchorEl, setAnchorEl] = useState();
- const editLink = useRouteRef(nextEditRouteRef);
- const actionsLink = useRouteRef(nextActionsRouteRef);
- const tasksLink = useRouteRef(nextScaffolderListTaskRouteRef);
- const navigate = useNavigate();
-
- const showEditor = props.editor !== false;
- const showActions = props.actions !== false;
- const showTasks = props.tasks !== false;
-
- if (!showEditor && !showActions) {
+ if (!onEditorClicked && !onActionsClicked) {
return null;
}
@@ -93,24 +86,24 @@ export function ContextMenu(props: ScaffolderPageContextMenuProps) {
transformOrigin={{ vertical: 'top', horizontal: 'right' }}
>
- {showEditor && (
-
Learn more about the software catalog
@@ -196,7 +196,7 @@ const HomePage = () => {Build your own software templates
@@ -260,7 +260,7 @@ const HomePage = () => {Learn more about TechDocs
@@ -320,7 +320,7 @@ const HomePage = () => {Learn more about Backstage Search
@@ -381,7 +381,7 @@ const HomePage = () => {Learn more about the K8s plugin
@@ -437,7 +437,7 @@ const HomePage = () => {Build a plugin
diff --git a/microsite/src/pages/home/home.module.scss b/microsite/src/pages/home/home.module.scss index 57f2b9acde..5877f7b5f5 100644 --- a/microsite/src/pages/home/home.module.scss +++ b/microsite/src/pages/home/home.module.scss @@ -1,4 +1,4 @@ -$desktopUpBreakpoint: 997px; +@use '../../theme/variables.scss'; .homePage { font-size: 1.25rem; @@ -70,7 +70,7 @@ $desktopUpBreakpoint: 997px; } .catalogContainer { - @media (min-width: $desktopUpBreakpoint) { + @media (min-width: variables.$desktopUpBreakpoint) { grid-template-columns: repeat(4, 1fr); picture { @@ -85,7 +85,7 @@ $desktopUpBreakpoint: 997px; } .softwareTemplatesContainer { - @media (min-width: $desktopUpBreakpoint) { + @media (min-width: variables.$desktopUpBreakpoint) { grid: repeat(2, auto) / repeat(4, 1fr); picture { diff --git a/microsite/src/pages/plugins/_pluginCard.tsx b/microsite/src/pages/plugins/_pluginCard.tsx index 99f27b865d..d6b4017db5 100644 --- a/microsite/src/pages/plugins/_pluginCard.tsx +++ b/microsite/src/pages/plugins/_pluginCard.tsx @@ -35,9 +35,7 @@ export const PluginCard = ({ by {author} - - {category} - + {category} } body={{description}
} diff --git a/microsite/src/pages/plugins/plugins.module.scss b/microsite/src/pages/plugins/plugins.module.scss index d21444583a..bb08c2fd33 100644 --- a/microsite/src/pages/plugins/plugins.module.scss +++ b/microsite/src/pages/plugins/plugins.module.scss @@ -30,4 +30,8 @@ display: grid; grid-template-columns: repeat(auto-fit, minmax(250px, 1fr)); } + + :global(.fit-content) { + width: fit-content; + } } diff --git a/microsite/src/css/customTheme.css b/microsite/src/theme/customTheme.scss similarity index 86% rename from microsite/src/css/customTheme.css rename to microsite/src/theme/customTheme.scss index 4ba7f1df86..f216762418 100644 --- a/microsite/src/css/customTheme.css +++ b/microsite/src/theme/customTheme.scss @@ -75,4 +75,12 @@ border-left: 3px solid rgba(255, 0, 0, 0.5); } +.code-block-highlight-line { + background-color: rgba(255, 255, 255, 0.08); + display: block; + margin: 0 calc(-1 * var(--ifm-pre-padding)); + padding: 0 var(--ifm-pre-padding); + border-left: 3px solid rgb(255, 255, 255, 0.5); +} + /* #endregion */ diff --git a/microsite/src/theme/variables.scss b/microsite/src/theme/variables.scss new file mode 100644 index 0000000000..3d74e59c9c --- /dev/null +++ b/microsite/src/theme/variables.scss @@ -0,0 +1,2 @@ +$xlUpBreakpoint: 1441px; +$desktopUpBreakpoint: 997px; diff --git a/microsite/static/img/github-statusneo.png b/microsite/static/img/github-statusneo.png new file mode 100644 index 0000000000..927ace351a Binary files /dev/null and b/microsite/static/img/github-statusneo.png differ diff --git a/microsite/static/img/outlook-statusneo.png b/microsite/static/img/outlook-statusneo.png new file mode 100644 index 0000000000..99e3b6a0bc Binary files /dev/null and b/microsite/static/img/outlook-statusneo.png differ diff --git a/microsite/yarn.lock b/microsite/yarn.lock index a9db81ead4..021d21a043 100644 --- a/microsite/yarn.lock +++ b/microsite/yarn.lock @@ -1660,9 +1660,9 @@ __metadata: languageName: node linkType: hard -"@docusaurus/core@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/core@npm:2.3.1" +"@docusaurus/core@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/core@npm:2.4.0" dependencies: "@babel/core": ^7.18.6 "@babel/generator": ^7.18.7 @@ -1674,13 +1674,13 @@ __metadata: "@babel/runtime": ^7.18.6 "@babel/runtime-corejs3": ^7.18.6 "@babel/traverse": ^7.18.8 - "@docusaurus/cssnano-preset": 2.3.1 - "@docusaurus/logger": 2.3.1 - "@docusaurus/mdx-loader": 2.3.1 + "@docusaurus/cssnano-preset": 2.4.0 + "@docusaurus/logger": 2.4.0 + "@docusaurus/mdx-loader": 2.4.0 "@docusaurus/react-loadable": 5.5.2 - "@docusaurus/utils": 2.3.1 - "@docusaurus/utils-common": 2.3.1 - "@docusaurus/utils-validation": 2.3.1 + "@docusaurus/utils": 2.4.0 + "@docusaurus/utils-common": 2.4.0 + "@docusaurus/utils-validation": 2.4.0 "@slorber/static-site-generator-webpack-plugin": ^4.0.7 "@svgr/webpack": ^6.2.1 autoprefixer: ^10.4.7 @@ -1740,40 +1740,40 @@ __metadata: react-dom: ^16.8.4 || ^17.0.0 bin: docusaurus: bin/docusaurus.mjs - checksum: 812aecae45af3f4d02fd16e89517ca9f1ba22821a078aaa890f5797ac7e0cc0c79e7623eb999e885cf7e7652a6ffda8ff7c06dfd85ca29aaab600993c3d9980d + checksum: 04d30e31e9c4198ce3f4a47c4f59943f357ef96a5cfa10674fd3049d4cf067c15fa0ae184383ba3e420f59a9b3077ed1cf1f373626399f0e46cea6fcf0897d7b languageName: node linkType: hard -"@docusaurus/cssnano-preset@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/cssnano-preset@npm:2.3.1" +"@docusaurus/cssnano-preset@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/cssnano-preset@npm:2.4.0" dependencies: cssnano-preset-advanced: ^5.3.8 postcss: ^8.4.14 postcss-sort-media-queries: ^4.2.1 tslib: ^2.4.0 - checksum: a3d00ce86b16caffde36734bb2f4541d2c0df5e8ab6891a78ad05bccc631a895fecb04c385626ebcb8f905510c28fa6158288585673ae96565532d4ee4b60d4f + checksum: b8982230ec014378a5453453df400a328a6ecdeecffb666ead5cfbeb5dc689610f0e62ee818ffcc8adc270c7c47cb818ad730c769eb8fa689dd79d4f9d448b6d languageName: node linkType: hard -"@docusaurus/logger@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/logger@npm:2.3.1" +"@docusaurus/logger@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/logger@npm:2.4.0" dependencies: chalk: ^4.1.2 tslib: ^2.4.0 - checksum: eff5f258aeac9c643431426256e3bc4515074cc3cc754fa643579ba427ba232ecace9a9579ae5af542330b22d7361892a1eaf84526983a0c821c5ca3ee895176 + checksum: 0424b77e2abaa50f20d6042ededf831157852656d1242ae9b0829b897e6f5b1e1e5ea30df599839e0ec51c72e42a5a867b136387dd5359032c735f431eddd078 languageName: node linkType: hard -"@docusaurus/mdx-loader@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/mdx-loader@npm:2.3.1" +"@docusaurus/mdx-loader@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/mdx-loader@npm:2.4.0" dependencies: "@babel/parser": ^7.18.8 "@babel/traverse": ^7.18.8 - "@docusaurus/logger": 2.3.1 - "@docusaurus/utils": 2.3.1 + "@docusaurus/logger": 2.4.0 + "@docusaurus/utils": 2.4.0 "@mdx-js/mdx": ^1.6.22 escape-html: ^1.0.3 file-loader: ^6.2.0 @@ -1790,16 +1790,16 @@ __metadata: peerDependencies: react: ^16.8.4 || ^17.0.0 react-dom: ^16.8.4 || ^17.0.0 - checksum: 4a1c9ef0e8506ab4d9cb4714ff7437664e238e0f2878a5eb4a2e082897bbee7ae8d0b61ba9d45ffa820beb5ce75aa0050201db815b00c18fc136aaa4c6411c21 + checksum: 3d4e7bf6840fa7dcf4250aa5ea019f80dac6cc38e9f8b9a0515b81b6c0f6d6f4ed4103f521784e70db856aec06cff4be176ef281e1cac53afc82bc1182bbf9ad languageName: node linkType: hard -"@docusaurus/module-type-aliases@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/module-type-aliases@npm:2.3.1" +"@docusaurus/module-type-aliases@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/module-type-aliases@npm:2.4.0" dependencies: "@docusaurus/react-loadable": 5.5.2 - "@docusaurus/types": 2.3.1 + "@docusaurus/types": 2.4.0 "@types/history": ^4.7.11 "@types/react": "*" "@types/react-router-config": "*" @@ -1809,19 +1809,19 @@ __metadata: peerDependencies: react: "*" react-dom: "*" - checksum: 74f799f81455dc8ff3e6edf07428996764014c2c7b416e6b5d160af15f00ad3aa1ab75dee5356645ec7f2ea832fb2aca6e9a32b19d64abeb9e3d57c4195f1e50 + checksum: fc655d9dc77d88ba9d10abe602c9fd5533992b14de495e4f3e4caea368693a7b7e5a805fb2938287bed949900e7e3d7f94bea3c1a8727b45e19c85996965d0c7 languageName: node linkType: hard "@docusaurus/plugin-client-redirects@npm:^2.3.1": - version: 2.3.1 - resolution: "@docusaurus/plugin-client-redirects@npm:2.3.1" + version: 2.4.0 + resolution: "@docusaurus/plugin-client-redirects@npm:2.4.0" dependencies: - "@docusaurus/core": 2.3.1 - "@docusaurus/logger": 2.3.1 - "@docusaurus/utils": 2.3.1 - "@docusaurus/utils-common": 2.3.1 - "@docusaurus/utils-validation": 2.3.1 + "@docusaurus/core": 2.4.0 + "@docusaurus/logger": 2.4.0 + "@docusaurus/utils": 2.4.0 + "@docusaurus/utils-common": 2.4.0 + "@docusaurus/utils-validation": 2.4.0 eta: ^2.0.0 fs-extra: ^10.1.0 lodash: ^4.17.21 @@ -1829,21 +1829,21 @@ __metadata: peerDependencies: react: ^16.8.4 || ^17.0.0 react-dom: ^16.8.4 || ^17.0.0 - checksum: bb730359c7f9015108a3d4ec8a570e9c73847349747bf71711f522a7dc40007786b7cd25cebc845eeb16b3505e8068242559a2eda790f4c07d4083d9014a6f84 + checksum: e0a82b71521752fb338b928fd0e04c78f01a1b8f240ffde12631a25711cdf63b0bf1a56d1ee19e479ea11d33ef9aabf337071f2eb5dcd55b4f17228374ceae26 languageName: node linkType: hard -"@docusaurus/plugin-content-blog@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/plugin-content-blog@npm:2.3.1" +"@docusaurus/plugin-content-blog@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/plugin-content-blog@npm:2.4.0" dependencies: - "@docusaurus/core": 2.3.1 - "@docusaurus/logger": 2.3.1 - "@docusaurus/mdx-loader": 2.3.1 - "@docusaurus/types": 2.3.1 - "@docusaurus/utils": 2.3.1 - "@docusaurus/utils-common": 2.3.1 - "@docusaurus/utils-validation": 2.3.1 + "@docusaurus/core": 2.4.0 + "@docusaurus/logger": 2.4.0 + "@docusaurus/mdx-loader": 2.4.0 + "@docusaurus/types": 2.4.0 + "@docusaurus/utils": 2.4.0 + "@docusaurus/utils-common": 2.4.0 + "@docusaurus/utils-validation": 2.4.0 cheerio: ^1.0.0-rc.12 feed: ^4.2.2 fs-extra: ^10.1.0 @@ -1856,21 +1856,21 @@ __metadata: peerDependencies: react: ^16.8.4 || ^17.0.0 react-dom: ^16.8.4 || ^17.0.0 - checksum: abc668ceab15269f57be7f74acbec2e139b4f6b90af8771d246a9036d124b49b0d9fd4890e9566df7a4ba960f2da0316c18741eed1be0646f2b4602465219ddd + checksum: e912ea1a01c1769b374aecf1af72cef96dbed5faa01b74cc12d951dd5dccc089994ff649f0a18f994e39730338f99c0aa12f3b2a1eefc40888f1fb7956cece29 languageName: node linkType: hard -"@docusaurus/plugin-content-docs@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/plugin-content-docs@npm:2.3.1" +"@docusaurus/plugin-content-docs@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/plugin-content-docs@npm:2.4.0" dependencies: - "@docusaurus/core": 2.3.1 - "@docusaurus/logger": 2.3.1 - "@docusaurus/mdx-loader": 2.3.1 - "@docusaurus/module-type-aliases": 2.3.1 - "@docusaurus/types": 2.3.1 - "@docusaurus/utils": 2.3.1 - "@docusaurus/utils-validation": 2.3.1 + "@docusaurus/core": 2.4.0 + "@docusaurus/logger": 2.4.0 + "@docusaurus/mdx-loader": 2.4.0 + "@docusaurus/module-type-aliases": 2.4.0 + "@docusaurus/types": 2.4.0 + "@docusaurus/utils": 2.4.0 + "@docusaurus/utils-validation": 2.4.0 "@types/react-router-config": ^5.0.6 combine-promises: ^1.1.0 fs-extra: ^10.1.0 @@ -1883,132 +1883,132 @@ __metadata: peerDependencies: react: ^16.8.4 || ^17.0.0 react-dom: ^16.8.4 || ^17.0.0 - checksum: bcf8d921407d11b497926a1f61a1dc8c96f82fbe5a1959cc106b082e555f8fb6f42cf9262a658acf33d9543e5eb3e778049d91f71e4a2855993dc759c845cf31 + checksum: 5a273e80f2c28e4a33ab994e8702b3afaff04eb73f156a0a3e42cd9d182f8e1ed2b794348b090ec170cc1e4aba2e997d1fb6e8684f73ac6698bf66d96114c57b languageName: node linkType: hard -"@docusaurus/plugin-content-pages@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/plugin-content-pages@npm:2.3.1" +"@docusaurus/plugin-content-pages@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/plugin-content-pages@npm:2.4.0" dependencies: - "@docusaurus/core": 2.3.1 - "@docusaurus/mdx-loader": 2.3.1 - "@docusaurus/types": 2.3.1 - "@docusaurus/utils": 2.3.1 - "@docusaurus/utils-validation": 2.3.1 + "@docusaurus/core": 2.4.0 + "@docusaurus/mdx-loader": 2.4.0 + "@docusaurus/types": 2.4.0 + "@docusaurus/utils": 2.4.0 + "@docusaurus/utils-validation": 2.4.0 fs-extra: ^10.1.0 tslib: ^2.4.0 webpack: ^5.73.0 peerDependencies: react: ^16.8.4 || ^17.0.0 react-dom: ^16.8.4 || ^17.0.0 - checksum: 8543050ed7330f54a28c0daeef11662eed3f3a08a6d0015b1a32db3d5e9ec46f0c6a8a5a4cb3e871ce953074d60424cc418b7ffa280695294626855a7a1a146a + checksum: 5381e913101f271476cbdc264e6058a0cbe0835ed4a823e430540da545253c1dc56578c66a6d978ee2f1aca114110aba529443ae835f26ef0eaf7de1ed6a5001 languageName: node linkType: hard -"@docusaurus/plugin-debug@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/plugin-debug@npm:2.3.1" +"@docusaurus/plugin-debug@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/plugin-debug@npm:2.4.0" dependencies: - "@docusaurus/core": 2.3.1 - "@docusaurus/types": 2.3.1 - "@docusaurus/utils": 2.3.1 + "@docusaurus/core": 2.4.0 + "@docusaurus/types": 2.4.0 + "@docusaurus/utils": 2.4.0 fs-extra: ^10.1.0 react-json-view: ^1.21.3 tslib: ^2.4.0 peerDependencies: react: ^16.8.4 || ^17.0.0 react-dom: ^16.8.4 || ^17.0.0 - checksum: e660575f900eedbeab6e222eb4f8ef6a7a49815c91a97839a4839737c0b3101698bf7c6e035cbafaa49010340010a9ec0d37270dc81a470b3bae42662c7a24b8 + checksum: 921614843453ef189dfa2ada31e7abed8f976b0c314f7486fde35f976911de2ab307863608326e96bea67468e98dc648aeea82dbad04d0701c3c48c92bd40c6c languageName: node linkType: hard -"@docusaurus/plugin-google-analytics@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/plugin-google-analytics@npm:2.3.1" +"@docusaurus/plugin-google-analytics@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/plugin-google-analytics@npm:2.4.0" dependencies: - "@docusaurus/core": 2.3.1 - "@docusaurus/types": 2.3.1 - "@docusaurus/utils-validation": 2.3.1 + "@docusaurus/core": 2.4.0 + "@docusaurus/types": 2.4.0 + "@docusaurus/utils-validation": 2.4.0 tslib: ^2.4.0 peerDependencies: react: ^16.8.4 || ^17.0.0 react-dom: ^16.8.4 || ^17.0.0 - checksum: 9306ae89cd5fb8ca86fd58809d7e624f988411d8908a151e9b6d9e8d0b84e08f1e3eba46024bc4321bcaeb3e9bc38e919b0bcf561adc9d40fa97c8ffeb232888 + checksum: 2d8c7e5689675ced9acffe1e2187144d6ebeea471a5992139c3eea87094e315e272263da5499591e85bc3501b7583f693d33c660507b36a835fc9eb75584c706 languageName: node linkType: hard -"@docusaurus/plugin-google-gtag@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/plugin-google-gtag@npm:2.3.1" +"@docusaurus/plugin-google-gtag@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/plugin-google-gtag@npm:2.4.0" dependencies: - "@docusaurus/core": 2.3.1 - "@docusaurus/types": 2.3.1 - "@docusaurus/utils-validation": 2.3.1 + "@docusaurus/core": 2.4.0 + "@docusaurus/types": 2.4.0 + "@docusaurus/utils-validation": 2.4.0 tslib: ^2.4.0 peerDependencies: react: ^16.8.4 || ^17.0.0 react-dom: ^16.8.4 || ^17.0.0 - checksum: 494f0405d79aa9cb36d1ea4cf739499ad15b59fe876573ab5b304b5e84ab6ef4d428ebdc26647777b0816af452f62959b5ddb25e5bbf73c7fb3d6568258980d0 + checksum: 6aa0bb6ac5e410ea438db2de20c95a4a34d7056855b2e0baa7685e31bd9b3f48ef55f8135ca496688ccbfaba88945219acae146a244141bfb7e2372ba54c0ce2 languageName: node linkType: hard -"@docusaurus/plugin-google-tag-manager@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/plugin-google-tag-manager@npm:2.3.1" +"@docusaurus/plugin-google-tag-manager@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/plugin-google-tag-manager@npm:2.4.0" dependencies: - "@docusaurus/core": 2.3.1 - "@docusaurus/types": 2.3.1 - "@docusaurus/utils-validation": 2.3.1 + "@docusaurus/core": 2.4.0 + "@docusaurus/types": 2.4.0 + "@docusaurus/utils-validation": 2.4.0 tslib: ^2.4.0 peerDependencies: react: ^16.8.4 || ^17.0.0 react-dom: ^16.8.4 || ^17.0.0 - checksum: d0b2ccc212652bb4f1c1bd61420e7f235325d4f2e8de0f5b25282305f54209d05da981c1253325bcae9afbc7575bd5c246d037d2be5fbda06f2842ba8335ab47 + checksum: 2df57cd95808ed7cf58ade342dcc3382e167ecebaedc7184588c214f6b64eab60fa0145ab0ce7e25803acfe3952412c1134d52ad0ea636cef652a73ccd79a5cb languageName: node linkType: hard -"@docusaurus/plugin-sitemap@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/plugin-sitemap@npm:2.3.1" +"@docusaurus/plugin-sitemap@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/plugin-sitemap@npm:2.4.0" dependencies: - "@docusaurus/core": 2.3.1 - "@docusaurus/logger": 2.3.1 - "@docusaurus/types": 2.3.1 - "@docusaurus/utils": 2.3.1 - "@docusaurus/utils-common": 2.3.1 - "@docusaurus/utils-validation": 2.3.1 + "@docusaurus/core": 2.4.0 + "@docusaurus/logger": 2.4.0 + "@docusaurus/types": 2.4.0 + "@docusaurus/utils": 2.4.0 + "@docusaurus/utils-common": 2.4.0 + "@docusaurus/utils-validation": 2.4.0 fs-extra: ^10.1.0 sitemap: ^7.1.1 tslib: ^2.4.0 peerDependencies: react: ^16.8.4 || ^17.0.0 react-dom: ^16.8.4 || ^17.0.0 - checksum: 667d2abbf46efffc4d20e38fe435a19392f07726446193a017306652ee9db3d478e971eefb209e1a5c243b6b82af3de72d4b975b8e74aa93bda4711ce8c309bc + checksum: e96fcc84352880da6a3e566cdc249e44ad825b400f2d798746201c3a4a255b196b999f5bf5d0a5b52c752acf9e9eb1169111b463914502a6cae9c114800fa09e languageName: node linkType: hard -"@docusaurus/preset-classic@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/preset-classic@npm:2.3.1" +"@docusaurus/preset-classic@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/preset-classic@npm:2.4.0" dependencies: - "@docusaurus/core": 2.3.1 - "@docusaurus/plugin-content-blog": 2.3.1 - "@docusaurus/plugin-content-docs": 2.3.1 - "@docusaurus/plugin-content-pages": 2.3.1 - "@docusaurus/plugin-debug": 2.3.1 - "@docusaurus/plugin-google-analytics": 2.3.1 - "@docusaurus/plugin-google-gtag": 2.3.1 - "@docusaurus/plugin-google-tag-manager": 2.3.1 - "@docusaurus/plugin-sitemap": 2.3.1 - "@docusaurus/theme-classic": 2.3.1 - "@docusaurus/theme-common": 2.3.1 - "@docusaurus/theme-search-algolia": 2.3.1 - "@docusaurus/types": 2.3.1 + "@docusaurus/core": 2.4.0 + "@docusaurus/plugin-content-blog": 2.4.0 + "@docusaurus/plugin-content-docs": 2.4.0 + "@docusaurus/plugin-content-pages": 2.4.0 + "@docusaurus/plugin-debug": 2.4.0 + "@docusaurus/plugin-google-analytics": 2.4.0 + "@docusaurus/plugin-google-gtag": 2.4.0 + "@docusaurus/plugin-google-tag-manager": 2.4.0 + "@docusaurus/plugin-sitemap": 2.4.0 + "@docusaurus/theme-classic": 2.4.0 + "@docusaurus/theme-common": 2.4.0 + "@docusaurus/theme-search-algolia": 2.4.0 + "@docusaurus/types": 2.4.0 peerDependencies: react: ^16.8.4 || ^17.0.0 react-dom: ^16.8.4 || ^17.0.0 - checksum: e4128a1bcb64d5ced04a281476ec1ae2d5523040d41ed57a8f744fb83659a2a2be902e94989de69ab1e6d693ec26c60d1ef6b2fe3ec96d5af6c9b3ef58f5b0cd + checksum: 33961a1edd445f13971e640db9445a0fae418babf0fe5f4078f21e605f9d945f7a3a4b7ad53ac7b578a7302f093c708429f462a76a3f297b3439d8e23b3990aa languageName: node linkType: hard @@ -2024,26 +2024,26 @@ __metadata: languageName: node linkType: hard -"@docusaurus/theme-classic@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/theme-classic@npm:2.3.1" +"@docusaurus/theme-classic@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/theme-classic@npm:2.4.0" dependencies: - "@docusaurus/core": 2.3.1 - "@docusaurus/mdx-loader": 2.3.1 - "@docusaurus/module-type-aliases": 2.3.1 - "@docusaurus/plugin-content-blog": 2.3.1 - "@docusaurus/plugin-content-docs": 2.3.1 - "@docusaurus/plugin-content-pages": 2.3.1 - "@docusaurus/theme-common": 2.3.1 - "@docusaurus/theme-translations": 2.3.1 - "@docusaurus/types": 2.3.1 - "@docusaurus/utils": 2.3.1 - "@docusaurus/utils-common": 2.3.1 - "@docusaurus/utils-validation": 2.3.1 + "@docusaurus/core": 2.4.0 + "@docusaurus/mdx-loader": 2.4.0 + "@docusaurus/module-type-aliases": 2.4.0 + "@docusaurus/plugin-content-blog": 2.4.0 + "@docusaurus/plugin-content-docs": 2.4.0 + "@docusaurus/plugin-content-pages": 2.4.0 + "@docusaurus/theme-common": 2.4.0 + "@docusaurus/theme-translations": 2.4.0 + "@docusaurus/types": 2.4.0 + "@docusaurus/utils": 2.4.0 + "@docusaurus/utils-common": 2.4.0 + "@docusaurus/utils-validation": 2.4.0 "@mdx-js/react": ^1.6.22 clsx: ^1.2.1 copy-text-to-clipboard: ^3.0.1 - infima: 0.2.0-alpha.42 + infima: 0.2.0-alpha.43 lodash: ^4.17.21 nprogress: ^0.2.0 postcss: ^8.4.14 @@ -2056,20 +2056,21 @@ __metadata: peerDependencies: react: ^16.8.4 || ^17.0.0 react-dom: ^16.8.4 || ^17.0.0 - checksum: 273812924fc29b2316aff554ae0302509ebeaca5aa829b58253e74d22a66e69444f1c324a2d5e8e170e6c6f27dd0d6927e6c6a22a7e0c14567ff777d04a5b0c1 + checksum: 7f3161d7be653b6a86ffd58d8a6c6d62f464db919c32b7b9ab2ec9ca1b79136e2278fdc908e90cfa31cf21385d87cd7496d5bf9c80d30c2279ef95e7f7be28aa languageName: node linkType: hard -"@docusaurus/theme-common@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/theme-common@npm:2.3.1" +"@docusaurus/theme-common@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/theme-common@npm:2.4.0" dependencies: - "@docusaurus/mdx-loader": 2.3.1 - "@docusaurus/module-type-aliases": 2.3.1 - "@docusaurus/plugin-content-blog": 2.3.1 - "@docusaurus/plugin-content-docs": 2.3.1 - "@docusaurus/plugin-content-pages": 2.3.1 - "@docusaurus/utils": 2.3.1 + "@docusaurus/mdx-loader": 2.4.0 + "@docusaurus/module-type-aliases": 2.4.0 + "@docusaurus/plugin-content-blog": 2.4.0 + "@docusaurus/plugin-content-docs": 2.4.0 + "@docusaurus/plugin-content-pages": 2.4.0 + "@docusaurus/utils": 2.4.0 + "@docusaurus/utils-common": 2.4.0 "@types/history": ^4.7.11 "@types/react": "*" "@types/react-router-config": "*" @@ -2082,22 +2083,22 @@ __metadata: peerDependencies: react: ^16.8.4 || ^17.0.0 react-dom: ^16.8.4 || ^17.0.0 - checksum: 6b902e9e782721c3c49bcdee5d969ea1c1138ebcb03891e34f827b16f2c06f43a86d95f240a60ed084539e9b16435312a41be7bff4e724f4fb209998dd4d3a59 + checksum: 0790c6e5ad14bc8518173314a058e01837321d5992364d1ae4f9907f1d055f5852f883512d7a64e5add95dcfe362a009b374220de6493b32624a406d8ce74750 languageName: node linkType: hard -"@docusaurus/theme-search-algolia@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/theme-search-algolia@npm:2.3.1" +"@docusaurus/theme-search-algolia@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/theme-search-algolia@npm:2.4.0" dependencies: "@docsearch/react": ^3.1.1 - "@docusaurus/core": 2.3.1 - "@docusaurus/logger": 2.3.1 - "@docusaurus/plugin-content-docs": 2.3.1 - "@docusaurus/theme-common": 2.3.1 - "@docusaurus/theme-translations": 2.3.1 - "@docusaurus/utils": 2.3.1 - "@docusaurus/utils-validation": 2.3.1 + "@docusaurus/core": 2.4.0 + "@docusaurus/logger": 2.4.0 + "@docusaurus/plugin-content-docs": 2.4.0 + "@docusaurus/theme-common": 2.4.0 + "@docusaurus/theme-translations": 2.4.0 + "@docusaurus/utils": 2.4.0 + "@docusaurus/utils-validation": 2.4.0 algoliasearch: ^4.13.1 algoliasearch-helper: ^3.10.0 clsx: ^1.2.1 @@ -2109,23 +2110,23 @@ __metadata: peerDependencies: react: ^16.8.4 || ^17.0.0 react-dom: ^16.8.4 || ^17.0.0 - checksum: 965303068e43b11f58d20b95bb6dfc01d5e575c2070d2730b94303bd2a1d33794075cae43bfe472f08061bd8770f14c8eb54932274e6b39f954ab34e7cfc5689 + checksum: a74a199faf6bab1d663cd41f9477c65c17f8dd2080664d5c00f998eb7c57345f1c30ff4f2c3bc88863f2e606c6f7475300747480dc145e61dd42798ca4fd435e languageName: node linkType: hard -"@docusaurus/theme-translations@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/theme-translations@npm:2.3.1" +"@docusaurus/theme-translations@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/theme-translations@npm:2.4.0" dependencies: fs-extra: ^10.1.0 tslib: ^2.4.0 - checksum: dd3796be63c4c946af789c3da18ed2704a2fa90d8e752ba2b780a124dc13369ba590218afad0ac4ea2342f7331ccb9eb1be086226c950b8384978d94a15c57ad + checksum: 37f329eb74fcb16c14bd370038d8bd1e18017fb1f78564d960c53fd4e110eb166f6f1c03f323dea28ede95873ebe28a659554d02cc26d1c3e748a772f9d2313a languageName: node linkType: hard -"@docusaurus/types@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/types@npm:2.3.1" +"@docusaurus/types@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/types@npm:2.4.0" dependencies: "@types/history": ^4.7.11 "@types/react": "*" @@ -2138,13 +2139,13 @@ __metadata: peerDependencies: react: ^16.8.4 || ^17.0.0 react-dom: ^16.8.4 || ^17.0.0 - checksum: 91e52f37b97964112aa0d50ee4a6f534d7da941443af5ddc96418817c6ce532a98c73e67045ac703b582c7ed703ebb360205eec30da7f738c0105f2b3ae1a246 + checksum: 54b0cd8992269ab0508d94ce19a7fcc2b3e7c9700eb112c9b859ddac8228dcc64282c414b602ba44894be87be79eeeef730fb8e569be68b6e26453e18addcf21 languageName: node linkType: hard -"@docusaurus/utils-common@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/utils-common@npm:2.3.1" +"@docusaurus/utils-common@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/utils-common@npm:2.4.0" dependencies: tslib: ^2.4.0 peerDependencies: @@ -2152,28 +2153,28 @@ __metadata: peerDependenciesMeta: "@docusaurus/types": optional: true - checksum: 405dc5b8aba9a97b2670ba8ff3911bbdaed274edc15214ab482a7159a07ad1c9b3198835a7bee42de4e0320d42bd402ed89ae6896744a364d64d89d9f78bcfb0 + checksum: 711e61e899b133fc7cd755e6de75fd79a712eeabbd9853b9122e3929c8390e015bb9e4bca2284028e40e7a0fb2b89ef1c184f7e4149097ffd7b64821b38c11da languageName: node linkType: hard -"@docusaurus/utils-validation@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/utils-validation@npm:2.3.1" +"@docusaurus/utils-validation@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/utils-validation@npm:2.4.0" dependencies: - "@docusaurus/logger": 2.3.1 - "@docusaurus/utils": 2.3.1 + "@docusaurus/logger": 2.4.0 + "@docusaurus/utils": 2.4.0 joi: ^17.6.0 js-yaml: ^4.1.0 tslib: ^2.4.0 - checksum: 1e5529d1d0c4fcd9006adf2e5b545458a7dba3877563fb444dcec472f27a3d8492d4c6fb5dd1071bb6e668a13a845d74b8f6c4b6387babfa0e467a9b8b237fda + checksum: 21a229858ed9254830b68dd08de6456dc19b68adead581f86e854ea3e55b64b9616a3bbca521e74f754c9c7bc835ca348dfe9f0949d9a8d189db5b39bcdb9f6b languageName: node linkType: hard -"@docusaurus/utils@npm:2.3.1": - version: 2.3.1 - resolution: "@docusaurus/utils@npm:2.3.1" +"@docusaurus/utils@npm:2.4.0": + version: 2.4.0 + resolution: "@docusaurus/utils@npm:2.4.0" dependencies: - "@docusaurus/logger": 2.3.1 + "@docusaurus/logger": 2.4.0 "@svgr/webpack": ^6.2.1 escape-string-regexp: ^4.0.0 file-loader: ^6.2.0 @@ -2194,7 +2195,7 @@ __metadata: peerDependenciesMeta: "@docusaurus/types": optional: true - checksum: e8bce9bbd98bf63664fcd7c0a5f8dec30dad31ed19e18d724b43189b04ecdc1174537e1d987293575ec18d421236fb92d3d39d28477e921507260a39c3f6d6d0 + checksum: 7ba6634b6ff71bb7cc64b0eb3c6d2892a21873bce8559bcd460693a80ca0229828c04da751277cdb17c6f18e80e061322bbcd84e9b743adc96c594b43e8a2165 languageName: node linkType: hard @@ -2623,90 +2624,90 @@ __metadata: languageName: node linkType: hard -"@swc/core-darwin-arm64@npm:1.3.38": - version: 1.3.38 - resolution: "@swc/core-darwin-arm64@npm:1.3.38" +"@swc/core-darwin-arm64@npm:1.3.42": + version: 1.3.42 + resolution: "@swc/core-darwin-arm64@npm:1.3.42" conditions: os=darwin & cpu=arm64 languageName: node linkType: hard -"@swc/core-darwin-x64@npm:1.3.38": - version: 1.3.38 - resolution: "@swc/core-darwin-x64@npm:1.3.38" +"@swc/core-darwin-x64@npm:1.3.42": + version: 1.3.42 + resolution: "@swc/core-darwin-x64@npm:1.3.42" conditions: os=darwin & cpu=x64 languageName: node linkType: hard -"@swc/core-linux-arm-gnueabihf@npm:1.3.38": - version: 1.3.38 - resolution: "@swc/core-linux-arm-gnueabihf@npm:1.3.38" +"@swc/core-linux-arm-gnueabihf@npm:1.3.42": + version: 1.3.42 + resolution: "@swc/core-linux-arm-gnueabihf@npm:1.3.42" conditions: os=linux & cpu=arm languageName: node linkType: hard -"@swc/core-linux-arm64-gnu@npm:1.3.38": - version: 1.3.38 - resolution: "@swc/core-linux-arm64-gnu@npm:1.3.38" +"@swc/core-linux-arm64-gnu@npm:1.3.42": + version: 1.3.42 + resolution: "@swc/core-linux-arm64-gnu@npm:1.3.42" conditions: os=linux & cpu=arm64 & libc=glibc languageName: node linkType: hard -"@swc/core-linux-arm64-musl@npm:1.3.38": - version: 1.3.38 - resolution: "@swc/core-linux-arm64-musl@npm:1.3.38" +"@swc/core-linux-arm64-musl@npm:1.3.42": + version: 1.3.42 + resolution: "@swc/core-linux-arm64-musl@npm:1.3.42" conditions: os=linux & cpu=arm64 & libc=musl languageName: node linkType: hard -"@swc/core-linux-x64-gnu@npm:1.3.38": - version: 1.3.38 - resolution: "@swc/core-linux-x64-gnu@npm:1.3.38" +"@swc/core-linux-x64-gnu@npm:1.3.42": + version: 1.3.42 + resolution: "@swc/core-linux-x64-gnu@npm:1.3.42" conditions: os=linux & cpu=x64 & libc=glibc languageName: node linkType: hard -"@swc/core-linux-x64-musl@npm:1.3.38": - version: 1.3.38 - resolution: "@swc/core-linux-x64-musl@npm:1.3.38" +"@swc/core-linux-x64-musl@npm:1.3.42": + version: 1.3.42 + resolution: "@swc/core-linux-x64-musl@npm:1.3.42" conditions: os=linux & cpu=x64 & libc=musl languageName: node linkType: hard -"@swc/core-win32-arm64-msvc@npm:1.3.38": - version: 1.3.38 - resolution: "@swc/core-win32-arm64-msvc@npm:1.3.38" +"@swc/core-win32-arm64-msvc@npm:1.3.42": + version: 1.3.42 + resolution: "@swc/core-win32-arm64-msvc@npm:1.3.42" conditions: os=win32 & cpu=arm64 languageName: node linkType: hard -"@swc/core-win32-ia32-msvc@npm:1.3.38": - version: 1.3.38 - resolution: "@swc/core-win32-ia32-msvc@npm:1.3.38" +"@swc/core-win32-ia32-msvc@npm:1.3.42": + version: 1.3.42 + resolution: "@swc/core-win32-ia32-msvc@npm:1.3.42" conditions: os=win32 & cpu=ia32 languageName: node linkType: hard -"@swc/core-win32-x64-msvc@npm:1.3.38": - version: 1.3.38 - resolution: "@swc/core-win32-x64-msvc@npm:1.3.38" +"@swc/core-win32-x64-msvc@npm:1.3.42": + version: 1.3.42 + resolution: "@swc/core-win32-x64-msvc@npm:1.3.42" conditions: os=win32 & cpu=x64 languageName: node linkType: hard "@swc/core@npm:^1.3.36": - version: 1.3.38 - resolution: "@swc/core@npm:1.3.38" + version: 1.3.42 + resolution: "@swc/core@npm:1.3.42" dependencies: - "@swc/core-darwin-arm64": 1.3.38 - "@swc/core-darwin-x64": 1.3.38 - "@swc/core-linux-arm-gnueabihf": 1.3.38 - "@swc/core-linux-arm64-gnu": 1.3.38 - "@swc/core-linux-arm64-musl": 1.3.38 - "@swc/core-linux-x64-gnu": 1.3.38 - "@swc/core-linux-x64-musl": 1.3.38 - "@swc/core-win32-arm64-msvc": 1.3.38 - "@swc/core-win32-ia32-msvc": 1.3.38 - "@swc/core-win32-x64-msvc": 1.3.38 + "@swc/core-darwin-arm64": 1.3.42 + "@swc/core-darwin-x64": 1.3.42 + "@swc/core-linux-arm-gnueabihf": 1.3.42 + "@swc/core-linux-arm64-gnu": 1.3.42 + "@swc/core-linux-arm64-musl": 1.3.42 + "@swc/core-linux-x64-gnu": 1.3.42 + "@swc/core-linux-x64-musl": 1.3.42 + "@swc/core-win32-arm64-msvc": 1.3.42 + "@swc/core-win32-ia32-msvc": 1.3.42 + "@swc/core-win32-x64-msvc": 1.3.42 dependenciesMeta: "@swc/core-darwin-arm64": optional: true @@ -2728,7 +2729,7 @@ __metadata: optional: true "@swc/core-win32-x64-msvc": optional: true - checksum: c55d30e57638bcd21f788add8490c3f3e71bfe027aa5a8b153e1b1b9686ecddd6deeaaa6a6b17717c7eab4c1e2a232b465b6755b6c891506fc0d03139badfbf7 + checksum: 5c28c03ee6a4e1f630c4a519b56d7e23a0102f70fad977a3ab144a3da96231cf4849e473cdc9ee7be6b9266ba0838d0bc0b6b3575a75540f302befe96cc9606e languageName: node linkType: hard @@ -2756,9 +2757,9 @@ __metadata: linkType: hard "@tsconfig/docusaurus@npm:^1.0.6": - version: 1.0.6 - resolution: "@tsconfig/docusaurus@npm:1.0.6" - checksum: fb0d7965c01fe64fc6369a72695b903d654bd5fb145f373d707c2bae3c2d828703517d812cef1c041ae44b108f44e52778b9d9837a54fdf782e68e6619a90a4d + version: 1.0.7 + resolution: "@tsconfig/docusaurus@npm:1.0.7" + checksum: 8f5b14005d90b2008f10daf03a5edec86d2a7603e5641c579ea936a5c2d165a8c3007a72254fc4c2adb0554d73062f52bb97b30ff818f01c9215957822f3c4db languageName: node linkType: hard @@ -3726,10 +3727,10 @@ __metadata: version: 0.0.0-use.local resolution: "backstage-microsite@workspace:." dependencies: - "@docusaurus/core": 2.3.1 - "@docusaurus/module-type-aliases": 2.3.1 + "@docusaurus/core": 2.4.0 + "@docusaurus/module-type-aliases": 2.4.0 "@docusaurus/plugin-client-redirects": ^2.3.1 - "@docusaurus/preset-classic": 2.3.1 + "@docusaurus/preset-classic": 2.4.0 "@spotify/prettier-config": ^14.0.0 "@swc/core": ^1.3.36 "@tsconfig/docusaurus": ^1.0.6 @@ -3738,6 +3739,7 @@ __metadata: docusaurus-plugin-sass: ^0.2.3 js-yaml: ^4.1.0 prettier: ^2.6.2 + prism-react-renderer: ^1.3.5 react: ^17.0.2 react-dom: ^17.0.2 replace: ^1.2.2 @@ -6442,10 +6444,10 @@ __metadata: languageName: node linkType: hard -"infima@npm:0.2.0-alpha.42": - version: 0.2.0-alpha.42 - resolution: "infima@npm:0.2.0-alpha.42" - checksum: 7206f36639c00a08daab811fedc748068951497efb5ec948cba846fb23856443668015f6bd65ddebe857cc2235f6ca98429f7018c73dcac47b0361ef4721bb8f +"infima@npm:0.2.0-alpha.43": + version: 0.2.0-alpha.43 + resolution: "infima@npm:0.2.0-alpha.43" + checksum: fc5f79240e940eddd750439511767092ccb4051e5e91d253ec7630a9e7ce691812da3aa0f05e46b4c0a95dbfadeae5714fd0073f8d2df12e5aaff0697a1d6aa2 languageName: node linkType: hard @@ -8558,11 +8560,11 @@ __metadata: linkType: hard "prettier@npm:^2.6.2": - version: 2.8.4 - resolution: "prettier@npm:2.8.4" + version: 2.8.7 + resolution: "prettier@npm:2.8.7" bin: prettier: bin-prettier.js - checksum: c173064bf3df57b6d93d19aa98753b9b9dd7657212e33b41ada8e2e9f9884066bb9ca0b4005b89b3ab137efffdf8fbe0b462785aba20364798ff4303aadda57e + checksum: fdc8f2616f099f5f0d685907f4449a70595a0fc1d081a88919604375989e0d5e9168d6121d8cc6861f21990b31665828e00472544d785d5940ea08a17660c3a6 languageName: node linkType: hard @@ -9437,15 +9439,15 @@ __metadata: linkType: hard "sass@npm:^1.57.1": - version: 1.58.3 - resolution: "sass@npm:1.58.3" + version: 1.60.0 + resolution: "sass@npm:1.60.0" dependencies: chokidar: ">=3.0.0 <4.0.0" immutable: ^4.0.0 source-map-js: ">=0.6.2 <2.0.0" bin: sass: sass.js - checksum: 35a2b98c037ef80fdc93c9b0be846e6ccc7d75596351a37ee79c397e66666d0a754c52c4696e746c0aff32327471e185343ca349e998a58340411adc9d0489a5 + checksum: 06e163c37af466ec194cf2ed8dab616372afeb19322d356947d48ea664fc38398ae77c4d91bea9cb0ace954ce289d5518d0f8555ecc49f6bf2539a8ef52fc580 languageName: node linkType: hard @@ -10889,8 +10891,8 @@ __metadata: linkType: hard "webpack@npm:^5.73.0": - version: 5.75.0 - resolution: "webpack@npm:5.75.0" + version: 5.76.2 + resolution: "webpack@npm:5.76.2" dependencies: "@types/eslint-scope": ^3.7.3 "@types/estree": ^0.0.51 @@ -10921,7 +10923,7 @@ __metadata: optional: true bin: webpack: bin/webpack.js - checksum: 2bcc5f3c195f375944e8af2f00bf2feea39cb9fda5f763b0d1b00077f1c51783db25c94d3fae96a07dead9fa085e6ae7474417e5ab31719c9776ea5969ceb83a + checksum: 86db98299a175c371031449c26077e87b33acd8f45de7f7945ed4b9b37c8ca11bc5169af9c44743efccd4d55e08042a3aa3a3bc42aff831309a0821ffbcd395e languageName: node linkType: hard diff --git a/package.json b/package.json index 43a146e0a1..8550a72a97 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@types/react": "^17", "@types/react-dom": "^17" }, - "version": "1.12.0-next.2", + "version": "1.13.0-next.0", "dependencies": { "@backstage/errors": "workspace:^", "@manypkg/get-packages": "^1.1.3" diff --git a/packages/app-defaults/CHANGELOG.md b/packages/app-defaults/CHANGELOG.md index 0b2b813d14..b2d85cea1a 100644 --- a/packages/app-defaults/CHANGELOG.md +++ b/packages/app-defaults/CHANGELOG.md @@ -1,5 +1,31 @@ # @backstage/app-defaults +## 1.3.0-next.0 + +### Minor Changes + +- 7908d72e033: Introduce a new global config parameter, `auth.enableExperimentalRedirectFlow`. When enabled, auth will happen with an in-window redirect flow rather than through a popup window. + +### Patch Changes + +- Updated dependencies + - @backstage/core-components@0.12.6-next.0 + - @backstage/core-app-api@1.7.0-next.0 + - @backstage/core-plugin-api@1.5.0 + - @backstage/plugin-permission-react@0.4.11 + - @backstage/theme@0.2.18 + +## 1.2.1 + +### Patch Changes + +- Updated dependencies + - @backstage/core-components@0.12.5 + - @backstage/core-plugin-api@1.5.0 + - @backstage/core-app-api@1.6.0 + - @backstage/theme@0.2.18 + - @backstage/plugin-permission-react@0.4.11 + ## 1.2.1-next.2 ### Patch Changes diff --git a/packages/app-defaults/package.json b/packages/app-defaults/package.json index 873a2fa28f..d4540bfd1d 100644 --- a/packages/app-defaults/package.json +++ b/packages/app-defaults/package.json @@ -1,7 +1,7 @@ { "name": "@backstage/app-defaults", "description": "Provides the default wiring of a Backstage App", - "version": "1.2.1-next.2", + "version": "1.3.0-next.0", "publishConfig": { "access": "public", "main": "dist/index.esm.js", diff --git a/packages/app-defaults/src/defaults/apis.ts b/packages/app-defaults/src/defaults/apis.ts index d3ebddfb84..3a552c25c7 100644 --- a/packages/app-defaults/src/defaults/apis.ts +++ b/packages/app-defaults/src/defaults/apis.ts @@ -130,6 +130,7 @@ export const apis = [ }, factory: ({ discoveryApi, oauthRequestApi, configApi }) => GoogleAuth.create({ + configApi, discoveryApi, oauthRequestApi, environment: configApi.getOptionalString('auth.environment'), @@ -144,6 +145,7 @@ export const apis = [ }, factory: ({ discoveryApi, oauthRequestApi, configApi }) => MicrosoftAuth.create({ + configApi, discoveryApi, oauthRequestApi, environment: configApi.getOptionalString('auth.environment'), @@ -158,6 +160,7 @@ export const apis = [ }, factory: ({ discoveryApi, oauthRequestApi, configApi }) => GithubAuth.create({ + configApi, discoveryApi, oauthRequestApi, defaultScopes: ['read:user'], @@ -173,6 +176,7 @@ export const apis = [ }, factory: ({ discoveryApi, oauthRequestApi, configApi }) => OktaAuth.create({ + configApi, discoveryApi, oauthRequestApi, environment: configApi.getOptionalString('auth.environment'), @@ -187,6 +191,7 @@ export const apis = [ }, factory: ({ discoveryApi, oauthRequestApi, configApi }) => GitlabAuth.create({ + configApi, discoveryApi, oauthRequestApi, environment: configApi.getOptionalString('auth.environment'), @@ -201,6 +206,7 @@ export const apis = [ }, factory: ({ discoveryApi, oauthRequestApi, configApi }) => OneLoginAuth.create({ + configApi, discoveryApi, oauthRequestApi, environment: configApi.getOptionalString('auth.environment'), @@ -215,6 +221,7 @@ export const apis = [ }, factory: ({ discoveryApi, oauthRequestApi, configApi }) => BitbucketAuth.create({ + configApi, discoveryApi, oauthRequestApi, defaultScopes: ['team'], @@ -226,9 +233,11 @@ export const apis = [ deps: { discoveryApi: discoveryApiRef, oauthRequestApi: oauthRequestApiRef, + configApi: configApiRef, }, - factory: ({ discoveryApi, oauthRequestApi }) => + factory: ({ discoveryApi, oauthRequestApi, configApi }) => BitbucketServerAuth.create({ + configApi, discoveryApi, oauthRequestApi, defaultScopes: ['REPO_READ'], @@ -243,6 +252,7 @@ export const apis = [ }, factory: ({ discoveryApi, oauthRequestApi, configApi }) => { return AtlassianAuth.create({ + configApi, discoveryApi, oauthRequestApi, environment: configApi.getOptionalString('auth.environment'), diff --git a/packages/app/CHANGELOG.md b/packages/app/CHANGELOG.md index ac21cbad07..7c0a558a86 100644 --- a/packages/app/CHANGELOG.md +++ b/packages/app/CHANGELOG.md @@ -1,5 +1,143 @@ # example-app +## 0.2.82-next.0 + +### Patch Changes + +- Updated dependencies + - @backstage/plugin-api-docs@0.9.2-next.0 + - @backstage/plugin-scaffolder@1.13.0-next.0 + - @backstage/plugin-scaffolder-react@1.3.0-next.0 + - @backstage/plugin-entity-feedback@0.2.0-next.0 + - @backstage/plugin-tech-insights@0.3.9-next.0 + - @backstage/core-components@0.12.6-next.0 + - @backstage/app-defaults@1.3.0-next.0 + - @backstage/core-app-api@1.7.0-next.0 + - @backstage/plugin-search-react@1.5.2-next.0 + - @backstage/plugin-techdocs@1.6.1-next.0 + - @backstage/cli@0.22.6-next.0 + - @backstage/plugin-techdocs-react@1.1.5-next.0 + - @backstage/plugin-techdocs-module-addons-contrib@1.0.12-next.0 + - @backstage/plugin-newrelic-dashboard@0.2.10-next.0 + - @backstage/plugin-apache-airflow@0.2.10-next.0 + - @backstage/plugin-catalog-import@0.9.7-next.0 + - @backstage/plugin-github-actions@0.5.17-next.0 + - @backstage/plugin-catalog-graph@0.2.29-next.0 + - @backstage/plugin-catalog-react@1.4.1-next.0 + - @backstage/plugin-code-coverage@0.2.10-next.0 + - @backstage/plugin-cost-insights@0.12.6-next.0 + - @backstage/plugin-user-settings@0.7.2-next.0 + - @backstage/plugin-azure-devops@0.2.8-next.0 + - @backstage/plugin-gcp-projects@0.3.36-next.0 + - @backstage/plugin-azure-sites@0.1.6-next.0 + - @backstage/plugin-cloudbuild@0.3.17-next.0 + - @backstage/plugin-kubernetes@0.7.10-next.0 + - @backstage/plugin-lighthouse@0.4.2-next.0 + - @backstage/plugin-tech-radar@0.6.3-next.0 + - @backstage/plugin-dynatrace@3.0.1-next.0 + - @backstage/plugin-gcalendar@0.3.13-next.0 + - @backstage/plugin-pagerduty@0.5.10-next.0 + - @backstage/plugin-shortcuts@0.3.9-next.0 + - @backstage/plugin-airbrake@0.3.17-next.0 + - @backstage/plugin-circleci@0.3.17-next.0 + - @backstage/plugin-graphiql@0.2.49-next.0 + - @backstage/plugin-newrelic@0.3.35-next.0 + - @backstage/plugin-explore@0.4.2-next.0 + - @backstage/plugin-jenkins@0.7.16-next.0 + - @backstage/plugin-rollbar@0.4.17-next.0 + - @backstage/plugin-badges@0.2.41-next.0 + - @backstage/plugin-search@1.1.2-next.0 + - @backstage/plugin-sentry@0.5.2-next.0 + - @backstage/plugin-kafka@0.3.17-next.0 + - @backstage/plugin-gocd@0.1.23-next.0 + - @backstage/plugin-home@0.4.33-next.0 + - @backstage/plugin-todo@0.2.19-next.0 + - @backstage/plugin-org@0.6.7-next.0 + - @internal/plugin-catalog-customized@0.0.9-next.0 + - @backstage/integration-react@1.1.12-next.0 + - @backstage/plugin-linguist@0.1.2-next.0 + - @backstage/plugin-microsoft-calendar@0.1.2-next.0 + - @backstage/plugin-playlist@0.1.8-next.0 + - @backstage/plugin-stack-overflow@0.1.13-next.0 + - @backstage/plugin-stackstorm@0.1.1-next.0 + - @backstage/core-plugin-api@1.5.0 + - @backstage/config@1.0.7 + - @backstage/plugin-permission-react@0.4.11 + - @backstage/catalog-model@1.2.1 + - @backstage/theme@0.2.18 + - @backstage/plugin-catalog-common@1.0.12 + - @backstage/plugin-linguist-common@0.1.0 + - @backstage/plugin-search-common@1.2.2 + +## 0.2.81 + +### Patch Changes + +- Updated dependencies + - @backstage/core-components@0.12.5 + - @backstage/plugin-scaffolder-react@1.2.0 + - @backstage/plugin-techdocs-react@1.1.4 + - @backstage/plugin-catalog-react@1.4.0 + - @backstage/plugin-tech-insights@0.3.8 + - @backstage/plugin-search-react@1.5.1 + - @backstage/plugin-scaffolder@1.12.0 + - @backstage/plugin-techdocs@1.6.0 + - @backstage/plugin-explore@0.4.1 + - @backstage/plugin-search@1.1.1 + - @backstage/cli@0.22.4 + - @backstage/plugin-kubernetes@0.7.9 + - @backstage/plugin-tech-radar@0.6.2 + - @backstage/plugin-microsoft-calendar@0.1.1 + - @backstage/plugin-newrelic-dashboard@0.2.9 + - @backstage/plugin-code-coverage@0.2.9 + - @backstage/plugin-azure-sites@0.1.5 + - @backstage/plugin-gcalendar@0.3.12 + - @backstage/plugin-shortcuts@0.3.8 + - @backstage/plugin-org@0.6.6 + - @backstage/plugin-api-docs@0.9.1 + - @backstage/plugin-stackstorm@0.1.0 + - @backstage/plugin-circleci@0.3.16 + - @backstage/plugin-playlist@0.1.7 + - @backstage/core-plugin-api@1.5.0 + - @backstage/catalog-model@1.2.1 + - @backstage/plugin-catalog-common@1.0.12 + - @backstage/plugin-cost-insights@0.12.5 + - @backstage/plugin-jenkins@0.7.15 + - @backstage/core-app-api@1.6.0 + - @backstage/integration-react@1.1.11 + - @backstage/plugin-airbrake@0.3.16 + - @backstage/plugin-apache-airflow@0.2.9 + - @backstage/plugin-azure-devops@0.2.7 + - @backstage/plugin-badges@0.2.40 + - @backstage/plugin-catalog-import@0.9.6 + - @backstage/plugin-cloudbuild@0.3.16 + - @backstage/plugin-dynatrace@3.0.0 + - @backstage/plugin-entity-feedback@0.1.1 + - @backstage/plugin-gcp-projects@0.3.35 + - @backstage/plugin-github-actions@0.5.16 + - @backstage/plugin-gocd@0.1.22 + - @backstage/plugin-graphiql@0.2.48 + - @backstage/plugin-home@0.4.32 + - @backstage/plugin-kafka@0.3.16 + - @backstage/plugin-lighthouse@0.4.1 + - @backstage/plugin-linguist@0.1.1 + - @backstage/plugin-newrelic@0.3.34 + - @backstage/plugin-pagerduty@0.5.9 + - @backstage/plugin-rollbar@0.4.16 + - @backstage/plugin-sentry@0.5.1 + - @backstage/plugin-stack-overflow@0.1.12 + - @backstage/plugin-techdocs-module-addons-contrib@1.0.11 + - @backstage/plugin-todo@0.2.18 + - @backstage/plugin-user-settings@0.7.1 + - @backstage/config@1.0.7 + - @backstage/theme@0.2.18 + - @internal/plugin-catalog-customized@0.0.8 + - @backstage/plugin-catalog-graph@0.2.28 + - @backstage/app-defaults@1.2.1 + - @backstage/plugin-linguist-common@0.1.0 + - @backstage/plugin-permission-react@0.4.11 + - @backstage/plugin-search-common@1.2.2 + ## 0.2.81-next.2 ### Patch Changes diff --git a/packages/app/package.json b/packages/app/package.json index c51f8be911..5902184f89 100644 --- a/packages/app/package.json +++ b/packages/app/package.json @@ -1,6 +1,6 @@ { "name": "example-app", - "version": "0.2.81-next.2", + "version": "0.2.82-next.0", "private": true, "backstage": { "role": "frontend" @@ -72,7 +72,7 @@ "@internal/plugin-catalog-customized": "workspace:^", "@material-ui/core": "^4.12.2", "@material-ui/icons": "^4.9.1", - "@material-ui/lab": "4.0.0-alpha.57", + "@material-ui/lab": "4.0.0-alpha.61", "@octokit/rest": "^19.0.3", "@oriflame/backstage-plugin-score-card": "^0.6.0", "@roadiehq/backstage-plugin-buildkite": "^2.0.8", diff --git a/packages/app/src/App.tsx b/packages/app/src/App.tsx index 4dacbbc007..1ee6978a87 100644 --- a/packages/app/src/App.tsx +++ b/packages/app/src/App.tsx @@ -27,7 +27,7 @@ import { RELATION_PROVIDES_API, } from '@backstage/catalog-model'; import { createApp } from '@backstage/app-defaults'; -import { AppRouter, FlatRoutes } from '@backstage/core-app-api'; +import { AppRouter, FeatureFlagged, FlatRoutes } from '@backstage/core-app-api'; import { AlertDisplay, OAuthRequestDialog, @@ -117,10 +117,13 @@ const app = createApp({ // Custom icon example alert: AlarmIcon, }, - // Example of application level feature flag - // featureFlags: [ - // { name: 'tech-radar', description: 'Enables the tech radar plugin' }, - // ], + featureFlags: [ + { + name: 'scaffolder-next-preview', + description: 'Preview the new Scaffolder Next', + pluginId: '', + }, + ], components: { SignInPage: props => { return ( @@ -208,49 +211,53 @@ const routes = (hello world
', + }, + }, + }, + ], + }; + const responseBodyTwo = { + results: [ + { + id: '4444444', + type: 'attachment', + title: 'testing.pdf', + metadata: { + mediaType: 'application/pdf', + }, + _links: { + download: '/download/attachments/4444444/testing.pdf', + }, + }, + ], + }; + + worker.use( + rest.get(`${baseUrl}/rest/api/content`, (_, res, ctx) => + res(ctx.status(200, 'OK'), ctx.json(responseBody)), + ), + rest.get( + `${baseUrl}/rest/api/content/4444444/child/attachment`, + (_, res, ctx) => res(ctx.status(200, 'OK'), ctx.json(responseBodyTwo)), + ), + rest.get( + `${baseUrl}/download/attachments/4444444/testing.pdf`, + (_, res, ctx) => res(ctx.status(200, 'OK'), ctx.body('hello')), + ), + ); + + const action = createConfluenceToMarkdownAction(options); + + await action.handler(mockContext); + + expect(logger.info).toHaveBeenCalledWith( + `Fetching the mkdocs.yml catalog from https://notreal.github.com/space/backstage/mkdocs.yml`, + ); + expect(logger.info).toHaveBeenCalledTimes(5); + expect(createWriteStream).toHaveBeenCalledTimes(1); + expect(readFile).toHaveBeenCalledTimes(1); + expect(writeFile).toHaveBeenCalledTimes(1); + }); + + it('should call confluence to markdown action successfully with empty results array', async () => { + const options = { + reader, + integrations, + config, + }; + const responseBody = { + results: [ + { + id: '4444444', + type: 'page', + title: 'Testing', + body: { + export_view: { + value: 'hello world
', + }, + }, + }, + ], + }; + const responseBodyTwo = { + results: [], + }; + + worker.use( + rest.get(`${baseUrl}/rest/api/content`, (_, res, ctx) => + res(ctx.status(200, 'OK'), ctx.json(responseBody)), + ), + rest.get( + `${baseUrl}/rest/api/content/4444444/child/attachment`, + (_, res, ctx) => res(ctx.status(200, 'OK'), ctx.json(responseBodyTwo)), + ), + ); + + const action = createConfluenceToMarkdownAction(options); + + await action.handler(mockContext); + + expect(logger.info).toHaveBeenCalledWith( + `Fetching the mkdocs.yml catalog from https://notreal.github.com/space/backstage/mkdocs.yml`, + ); + expect(logger.info).toHaveBeenCalledTimes(5); + + expect(createWriteStream).not.toHaveBeenCalled(); + expect(readFile).toHaveBeenCalledTimes(1); + expect(writeFile).toHaveBeenCalledTimes(1); + }); + + it('shoud fail on the first fetch call with response.ok set to false', async () => { + const options = { + reader, + integrations, + config, + }; + const responseBody = {}; + + worker.use( + rest.get(`${baseUrl}/rest/api/content`, (_, res, ctx) => + res(ctx.status(401, 'nope'), ctx.json(responseBody)), + ), + ); + + const action = createConfluenceToMarkdownAction(options); + await expect(async () => { + await action.handler(mockContext); + }).rejects.toThrow('Request failed with 401 Error'); + }); + + it('should return nothing in results from the first api call and fail', async () => { + const options = { + reader, + integrations, + config, + }; + const responseBody = { + results: [], + }; + + worker.use( + rest.get(`${baseUrl}/rest/api/content`, (_, res, ctx) => + res(ctx.status(200, 'OK'), ctx.json(responseBody)), + ), + ); + + const action = createConfluenceToMarkdownAction(options); + await expect(async () => { + await action.handler(mockContext); + }).rejects.toThrow( + 'Could not find document https://nodomain.confluence.com/display/testing/mkdocs. Please check your input.', + ); + }); + + it('should fail on the second fetch call to confluence', async () => { + const options = { + reader, + integrations, + config, + }; + const responseBody = { + results: [ + { + id: '4444444', + type: 'page', + title: 'Testing', + body: { + export_view: { + value: 'hello world
', + }, + }, + }, + ], + }; + const responseBodyTwo = {}; + + worker.use( + rest.get(`${baseUrl}/rest/api/content`, (_, res, ctx) => + res(ctx.status(200, 'OK'), ctx.json(responseBody)), + ), + rest.get( + `${baseUrl}/rest/api/content/4444444/child/attachment`, + (_, res, ctx) => + res(ctx.status(404, 'nope'), ctx.json(responseBodyTwo)), + ), + ); + + const action = createConfluenceToMarkdownAction(options); + await expect(async () => { + await action.handler(mockContext); + }).rejects.toThrow('Request failed with 404 Error'); + }); +}); diff --git a/plugins/scaffolder-backend-module-confluence-to-markdown/src/actions/confluence/confluenceToMarkdown.ts b/plugins/scaffolder-backend-module-confluence-to-markdown/src/actions/confluence/confluenceToMarkdown.ts new file mode 100644 index 0000000000..655b1bbdb7 --- /dev/null +++ b/plugins/scaffolder-backend-module-confluence-to-markdown/src/actions/confluence/confluenceToMarkdown.ts @@ -0,0 +1,182 @@ +/* + * Copyright 2023 The Backstage Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +import { Config } from '@backstage/config'; +import { UrlReader } from '@backstage/backend-common'; +import { ScmIntegrations } from '@backstage/integration'; +import { createFetchPlainAction } from '@backstage/plugin-scaffolder-backend'; +import { createTemplateAction } from '@backstage/plugin-scaffolder-node'; +import { InputError, ConflictError } from '@backstage/errors'; +import { NodeHtmlMarkdown } from 'node-html-markdown'; +import fs from 'fs-extra'; +import parseGitUrl from 'git-url-parse'; +import YAML from 'yaml'; +import { + readFileAsString, + fetchConfluence, + getAndWriteAttachments, + createConfluenceVariables, +} from './helpers'; + +/** + * @public + */ + +export const createConfluenceToMarkdownAction = (options: { + reader: UrlReader; + integrations: ScmIntegrations; + config: Config; +}) => { + const { config, reader, integrations } = options; + const fetchPlainAction = createFetchPlainAction({ reader, integrations }); + type Obj = { + [key: string]: string; + }; + + return createTemplateAction<{ + confluenceUrls: string[]; + repoUrl: string; + }>({ + id: 'confluence:transform:markdown', + schema: { + input: { + properties: { + confluenceUrls: { + type: 'array', + title: 'Confluence URL', + description: + 'Paste your confluence url. Ensure it follows this format: https://{confluence+base+url}/display/{spacekey}/{page+title}', + items: { + type: 'string', + default: 'Confluence URL', + }, + }, + repoUrl: { + type: 'string', + title: 'GitHub Repo Url', + description: + 'mkdocs.yml file location inside the github repo you want to store the document', + }, + }, + }, + }, + async handler(ctx) { + const { confluenceUrls, repoUrl } = ctx.input; + const parsedRepoUrl = parseGitUrl(repoUrl); + const filePathToMkdocs = parsedRepoUrl.filepath.substring( + 0, + parsedRepoUrl.filepath.lastIndexOf('/') + 1, + ); + const dirPath = ctx.workspacePath; + let productArray: string[][] = []; + + ctx.logger.info(`Fetching the mkdocs.yml catalog from ${repoUrl}`); + + // This grabs the files from Github + const repoFileDir = `${dirPath}/${parsedRepoUrl.filepath}`; + await fetchPlainAction.handler({ + ...ctx, + input: { + url: `https://${parsedRepoUrl.resource}/${parsedRepoUrl.owner}/${parsedRepoUrl.name}`, + targetPath: dirPath, + }, + }); + + for (const url of confluenceUrls) { + const { spacekey, title, titleWithSpaces } = + await createConfluenceVariables(url); + // This calls confluence to get the page html and page id + const getConfluenceDoc = await fetchConfluence( + `/rest/api/content?title=${title}&spaceKey=${spacekey}&expand=body.export_view`, + config, + ); + if (getConfluenceDoc.results.length === 0) { + throw new InputError( + `Could not find document ${url}. Please check your input.`, + ); + } + // This gets attachements for the confluence page if they exist + const getDocAttachments = await fetchConfluence( + `/rest/api/content/${getConfluenceDoc.results[0].id}/child/attachment`, + config, + ); + + if (getDocAttachments.results.length) { + fs.mkdirSync(`${dirPath}/${filePathToMkdocs}docs/img`, { + recursive: true, + }); + productArray = await getAndWriteAttachments( + getDocAttachments, + dirPath, + config, + filePathToMkdocs, + ); + } + + ctx.logger.info( + `starting action for converting ${titleWithSpaces} from Confluence To Markdown`, + ); + + // This reads mkdocs.yml file + const mkdocsFileContent = await readFileAsString(repoFileDir); + const mkdocsFile = await YAML.parse(mkdocsFileContent); + ctx.logger.info( + `Adding new file - ${titleWithSpaces} to the current mkdocs.yml file`, + ); + + // This modifies the mkdocs.yml file + if (mkdocsFile !== undefined && mkdocsFile.hasOwnProperty('nav')) { + const { nav } = mkdocsFile; + if (!nav.some((i: Obj) => i.hasOwnProperty(titleWithSpaces))) { + nav.push({ + [titleWithSpaces]: `${titleWithSpaces.replace(/\s+/g, '-')}.md`, + }); + mkdocsFile.nav = nav; + } else { + throw new ConflictError( + 'This document looks to exist inside the GitHub repo. Will end the action.', + ); + } + } + + await fs.writeFile(repoFileDir, YAML.stringify(mkdocsFile)); + + // This grabs the confluence html and converts it to markdown and adds attachments + const html = getConfluenceDoc.results[0].body.export_view.value; + const markdownToPublish = NodeHtmlMarkdown.translate(html); + let newString: string = markdownToPublish; + productArray.forEach((product: string[]) => { + // This regex is looking for either [](link to confluence) or  in the newly created markdown doc and updating it to point to the versions saved(in ./docs/img) in the local version of GitHub Repo during getAndWriteAttachments + const regex = product[0].includes('.pdf') + ? new RegExp(`(\\[.*?\\]\\()(.*?${product[0]}.*?)(\\))`, 'gi') + : new RegExp(`(\\!\\[.*?\\]\\()(.*?${product[0]}.*?)(\\))`, 'gi'); + newString = newString.replace(regex, `$1./img/${product[1]}$3`); + }); + + ctx.logger.info(`Adding new file to repo.`); + await fs.outputFile( + `${dirPath}/${filePathToMkdocs}docs/${titleWithSpaces.replace( + /\s+/g, + '-', + )}.md`, + newString, + ); + } + + ctx.output('repo', parsedRepoUrl.name); + ctx.output('owner', parsedRepoUrl.owner); + }, + }); +}; diff --git a/plugins/scaffolder-backend-module-confluence-to-markdown/src/actions/confluence/helpers.ts b/plugins/scaffolder-backend-module-confluence-to-markdown/src/actions/confluence/helpers.ts new file mode 100644 index 0000000000..58f84a8747 --- /dev/null +++ b/plugins/scaffolder-backend-module-confluence-to-markdown/src/actions/confluence/helpers.ts @@ -0,0 +1,128 @@ +/* + * Copyright 2023 The Backstage Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { Config } from '@backstage/config'; +import { ResponseError, ConflictError, InputError } from '@backstage/errors'; +import fs from 'fs-extra'; +import fetch, { Response } from 'node-fetch'; + +interface Links { + webui: string; + download: string; + thumbnail: string; + self: string; +} + +interface Metadata { + mediaType: string; +} + +export interface Result { + id: string; + type: string; + status: string; + title: string; + metadata: Metadata; + _links: Links; +} + +export interface Results { + results: Result[]; +} + +export const readFileAsString = async (fileDir: string) => { + const content = await fs.readFile(fileDir, 'utf-8'); + return content.toString(); +}; + +export const fetchConfluence = async (relativeUrl: string, config: Config) => { + const baseUrl = config.getString('confluence.baseUrl'); + const token = config.getString('confluence.token'); + const response: Response = await fetch(`${baseUrl}${relativeUrl}`, { + method: 'GET', + headers: { + Authorization: `Bearer ${token}`, + }, + }); + if (!response.ok) { + throw await ResponseError.fromResponse(response); + } + + return response.json(); +}; + +export const getAndWriteAttachments = async ( + arr: Results, + workspace: string, + config: Config, + mkdocsDir: string, +) => { + const productArr: string[][] = []; + const baseUrl = config.getString('confluence.baseUrl'); + const token = config.getString('confluence.token'); + await Promise.all( + await arr.results.map(async (result: Result) => { + const downloadLink = result._links.download; + const downloadTitle = result.title.replace(/ /g, '-'); + if (result.metadata.mediaType !== 'application/gliffy+json') { + productArr.push([result.title.replace(/ /g, '%20'), downloadTitle]); + } + + const res = await fetch(`${baseUrl}${downloadLink}`, { + method: 'GET', + headers: { + Authorization: `Bearer ${token}`, + }, + }); + if (!res.ok) { + throw ResponseError.fromResponse(res); + } else if (res.body !== null) { + fs.openSync(`${workspace}/${mkdocsDir}docs/img/${downloadTitle}`, 'w'); + const writeStream = fs.createWriteStream( + `${workspace}/${mkdocsDir}docs/img/${downloadTitle}`, + ); + res.body.pipe(writeStream); + await new Promise((resolve, reject) => { + writeStream.on('finish', () => { + resolve(`${workspace}/${mkdocsDir}docs/img/${downloadTitle}`); + }); + writeStream.on('error', reject); + }); + } else { + throw new ConflictError( + 'No Body on the response. Can not save images from Confluence Doc', + ); + } + }), + ); + return productArr; +}; + +export const createConfluenceVariables = async (url: string) => { + let spacekey: string | undefined = undefined; + let title: string | undefined = undefined; + let titleWithSpaces: string | undefined = ''; + const params = new URL(url); + if (params.pathname.split('/')[1] === 'display') { + spacekey = params.pathname.split('/')[2]; + title = params.pathname.split('/')[3]; + titleWithSpaces = title?.replace(/\+/g, ' '); + return { spacekey, title, titleWithSpaces }; + } + throw new InputError( + 'The Url format for Confluence is incorrect. Acceptable format is `