From 6dd47b8a8122ce4f0aafd77b99fa79c095becd8c Mon Sep 17 00:00:00 2001
From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com>
Date: Wed, 10 Aug 2022 19:34:54 +0000
Subject: [PATCH 12/24] fix(deps): update dependency aws-sdk to v2.1192.0
Signed-off-by: Renovate Bot
---
yarn.lock | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/yarn.lock b/yarn.lock
index 8d7f8ea446..a18da54699 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -9072,9 +9072,9 @@ aws-sdk-mock@^5.2.1:
traverse "^0.6.6"
aws-sdk@^2.1122.0, aws-sdk@^2.814.0, aws-sdk@^2.840.0, aws-sdk@^2.948.0:
- version "2.1191.0"
- resolved "https://registry.npmjs.org/aws-sdk/-/aws-sdk-2.1191.0.tgz#2748567252c68ef37a8ce29f48aa063681083918"
- integrity sha512-G8hWvuc+3rxTfHqsnUwGx/fy8zlnVPtlNesXMHlwU/l4oBx3+Weg0Nhng6HvLGzUJifzlnSKDXrOsWVkHtuZ1w==
+ version "2.1192.0"
+ resolved "https://registry.npmjs.org/aws-sdk/-/aws-sdk-2.1192.0.tgz#13fe38ec8dae3232f17d52b370e69daa9c7a0e9c"
+ integrity sha512-6uzrlG1Ow3qcOnL0+et+DBTGhYgJzgNydVvos1Eg01vPc/ZhxR7roZ3epZQcPmOR0thQuzzckTq7FBO6wzZA2w==
dependencies:
buffer "4.9.2"
events "1.1.1"
From bc0addf4de335a388b57f1c16a569043fcbd1b04 Mon Sep 17 00:00:00 2001
From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com>
Date: Wed, 10 Aug 2022 20:26:21 +0000
Subject: [PATCH 13/24] fix(deps): update dependency @types/passport to v1.0.10
Signed-off-by: Renovate Bot
---
yarn.lock | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/yarn.lock b/yarn.lock
index 7cf1217bf2..43f1cc89fc 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -7444,9 +7444,9 @@
"@types/passport" "*"
"@types/passport@*", "@types/passport@^1.0.3":
- version "1.0.9"
- resolved "https://registry.npmjs.org/@types/passport/-/passport-1.0.9.tgz#b32fa8f7485dace77a9b58e82d0c92908f6e8387"
- integrity sha512-9+ilzUhmZQR4JP49GdC2O4UdDE3POPLwpmaTC/iLkW7l0TZCXOo1zsTnnlXPq6rP1UsUZPfbAV4IUdiwiXyC7g==
+ version "1.0.10"
+ resolved "https://registry.npmjs.org/@types/passport/-/passport-1.0.10.tgz#c518f2bae8b1538b7be71ee7f9220fbd3f569f05"
+ integrity sha512-IZamnXuN7mY+2/v8bAW6nuTcKiay7gXBBcMBZ8n7YHB4u5DwsWoJaNrHdAQ8PZEODRjCv3oHOg76CYJ40j9RqA==
dependencies:
"@types/express" "*"
From d4ff58fd6166d593d6f4672dad98963bac91ed1b Mon Sep 17 00:00:00 2001
From: Bruce Arctor <5032356+brucearctor@users.noreply.github.com>
Date: Wed, 10 Aug 2022 14:41:26 -0700
Subject: [PATCH 14/24] vacation over
Signed-off-by: Bruce Arctor <5032356+brucearctor@users.noreply.github.com>
---
README.md | 2 --
1 file changed, 2 deletions(-)
diff --git a/README.md b/README.md
index a6e740a427..5dba1fdf52 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,5 @@
-> 🏖 From July 7th due to Summer Vacations for some of the maintainers, expect the project to move a little slower than normal, and support to be limited. Normal service will resume on August 8th 🏝
-
# [Backstage](https://backstage.io)
[](https://opensource.org/licenses/Apache-2.0)
From a9c0f40404f8822083f829aa47bc7d08a5222dcd Mon Sep 17 00:00:00 2001
From: blam
Date: Thu, 11 Aug 2022 11:36:40 +0200
Subject: [PATCH 15/24] chore: adding a note about division mode
Signed-off-by: blam
---
docs/tutorials/switching-sqlite-postgres.md | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/docs/tutorials/switching-sqlite-postgres.md b/docs/tutorials/switching-sqlite-postgres.md
index c4e4bd83b6..b31ce120d8 100644
--- a/docs/tutorials/switching-sqlite-postgres.md
+++ b/docs/tutorials/switching-sqlite-postgres.md
@@ -86,3 +86,16 @@ backend:
+ # ca: # if you have a CA file and want to verify it you can uncomment this section
+ # $file: /ca/server.crt
```
+
+### Using a single database
+
+By default, each plugin will get it's own database ensure that there's no conflict in table names throughout the plugins that you install, and to keep these seperate for other use cases further down the line. If you are limited in that you can only create one database, you can use a special option `pluginDivisionMode` with `client: pg` in the config to create seperate [PostgreSQL Schemas](https://www.postgresql.org/docs/current/ddl-schemas.html) instead of creating seperate databases.
+
+You can enable this using the following config:
+
+```yaml
+backend:
+ database:
+ client: pg
+ pluginDivisionMode: schema # defaults to database, but changing this to schema means plugins will be given their own schema (in the specified/default database)
+```
From 097ad14492fc6817c063db3386594a0ae2aace56 Mon Sep 17 00:00:00 2001
From: blam
Date: Thu, 11 Aug 2022 11:41:31 +0200
Subject: [PATCH 16/24] chore: fix my spelling issues
Signed-off-by: blam
---
docs/tutorials/switching-sqlite-postgres.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/tutorials/switching-sqlite-postgres.md b/docs/tutorials/switching-sqlite-postgres.md
index b31ce120d8..74fddb5eb3 100644
--- a/docs/tutorials/switching-sqlite-postgres.md
+++ b/docs/tutorials/switching-sqlite-postgres.md
@@ -89,7 +89,7 @@ backend:
### Using a single database
-By default, each plugin will get it's own database ensure that there's no conflict in table names throughout the plugins that you install, and to keep these seperate for other use cases further down the line. If you are limited in that you can only create one database, you can use a special option `pluginDivisionMode` with `client: pg` in the config to create seperate [PostgreSQL Schemas](https://www.postgresql.org/docs/current/ddl-schemas.html) instead of creating seperate databases.
+By default, each plugin will get it's own database ensure that there's no conflict in table names throughout the plugins that you install, and to keep these separate for other use cases further down the line. If you are limited in that you can only create one database, you can use a special option `pluginDivisionMode` with `client: pg` in the config to create separate [PostgreSQL Schemas](https://www.postgresql.org/docs/current/ddl-schemas.html) instead of creating separate databases.
You can enable this using the following config:
From 2cf8337e57894e8ee7c87820762d87a1d01e8a81 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg
Date: Thu, 11 Aug 2022 11:44:18 +0200
Subject: [PATCH 17/24] exit
Signed-off-by: Patrik Oldsberg
---
.changeset/pre.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.changeset/pre.json b/.changeset/pre.json
index 0d89198dec..012728eb38 100644
--- a/.changeset/pre.json
+++ b/.changeset/pre.json
@@ -1,5 +1,5 @@
{
- "mode": "pre",
+ "mode": "exit",
"tag": "next",
"initialVersions": {
"example-app": "0.2.73",
From c2b932dfb9ee53e4eb66763473bc861e0c35f52b Mon Sep 17 00:00:00 2001
From: Ben Lambert
Date: Thu, 11 Aug 2022 11:46:21 +0200
Subject: [PATCH 18/24] Update docs/tutorials/switching-sqlite-postgres.md
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: Fredrik Adelöw
Signed-off-by: Ben Lambert
---
docs/tutorials/switching-sqlite-postgres.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/tutorials/switching-sqlite-postgres.md b/docs/tutorials/switching-sqlite-postgres.md
index 74fddb5eb3..c0c35999c6 100644
--- a/docs/tutorials/switching-sqlite-postgres.md
+++ b/docs/tutorials/switching-sqlite-postgres.md
@@ -89,7 +89,7 @@ backend:
### Using a single database
-By default, each plugin will get it's own database ensure that there's no conflict in table names throughout the plugins that you install, and to keep these separate for other use cases further down the line. If you are limited in that you can only create one database, you can use a special option `pluginDivisionMode` with `client: pg` in the config to create separate [PostgreSQL Schemas](https://www.postgresql.org/docs/current/ddl-schemas.html) instead of creating separate databases.
+By default, each plugin will get its own logical database, to ensure that there's no conflict in table names throughout the plugins that you install and to keep their concerns separate for other use cases further down the line. If you are limited in that you can only make use of a single database, you can use a special option `pluginDivisionMode` with `client: pg` in the config to create separate [PostgreSQL Schemas](https://www.postgresql.org/docs/current/ddl-schemas.html) instead of creating separate databases.
You can enable this using the following config:
From b50e8e533b7aca0c93b78a56b2788cf7209a4b4b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mattias=20Frinnstr=C3=B6m?=
Date: Thu, 11 Aug 2022 12:04:27 +0200
Subject: [PATCH 19/24] Add openApiPlaceholderResolver
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Mattias Frinnström
---
.changeset/strong-birds-pretend.md | 21 +++++
.../catalog-backend-module-openapi/README.md | 26 ++++++
.../api-report.md | 7 ++
.../package.json | 2 +
.../src/OpenApiRefProcessor.test.ts | 2 +-
.../src/OpenApiRefProcessor.ts | 19 +++--
.../src/index.ts | 1 +
.../src/lib/bundle.test.ts | 36 ++------
.../src/lib/bundle.ts | 31 +++----
.../src/openApiPlaceholderResolver.test.ts | 63 ++++++++++++++
.../src/openApiPlaceholderResolver.ts | 85 +++++++++++++++++++
11 files changed, 237 insertions(+), 56 deletions(-)
create mode 100644 .changeset/strong-birds-pretend.md
create mode 100644 plugins/catalog-backend-module-openapi/src/openApiPlaceholderResolver.test.ts
create mode 100644 plugins/catalog-backend-module-openapi/src/openApiPlaceholderResolver.ts
diff --git a/.changeset/strong-birds-pretend.md b/.changeset/strong-birds-pretend.md
new file mode 100644
index 0000000000..9ad3bae97b
--- /dev/null
+++ b/.changeset/strong-birds-pretend.md
@@ -0,0 +1,21 @@
+---
+'@backstage/plugin-catalog-backend-module-openapi': patch
+---
+
+Add an `$openapi` placeholder resolver that supports more use cases for resolving `$ref` instances. This means that the quite recently added `OpenApiRefProcessor` has been deprecated in favor of the `openApiPlaceholderResolver`.
+
+An example of how to use it can be seen below.
+
+```yaml
+apiVersion: backstage.io/v1alpha1
+kind: API
+metadata:
+ name: example
+ description: Example API
+spec:
+ type: openapi
+ lifecycle: production
+ owner: team
+ definition:
+ $openapi: ./spec/openapi.yaml # by using $openapi Backstage will now resolve all $ref instances
+```
diff --git a/plugins/catalog-backend-module-openapi/README.md b/plugins/catalog-backend-module-openapi/README.md
index 1a133521c6..f80798e267 100644
--- a/plugins/catalog-backend-module-openapi/README.md
+++ b/plugins/catalog-backend-module-openapi/README.md
@@ -15,6 +15,32 @@ yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-openapi
### Adding the plugin to your `packages/backend`
+#### **openApiPlaceholderResolver**
+
+The placeholder resolver can be added by importing `openApiPlaceholderResolver` in `src/plugins/catalog.ts` in your `backend` package and adding the following.
+
+```ts
+builder.setPlaceholderResolver('openapi', openApiPlaceholderResolver);
+```
+
+This allows you to use the `$openapi` placeholder when referencing your OpenAPI specification. This will then resolve all `$ref` instances in your specification.
+
+```yaml
+apiVersion: backstage.io/v1alpha1
+kind: API
+metadata:
+ name: example
+ description: Example API
+spec:
+ type: openapi
+ lifecycle: production
+ owner: team
+ definition:
+ $openapi: ./spec/openapi.yaml # by using $openapi Backstage will now resolve all $ref instances
+```
+
+#### **OpenAPIRefProcessor** (deprecated)
+
The processor can be added by importing `OpenApiRefProcessor` in `src/plugins/catalog.ts` in your `backend` package and adding the following.
```ts
diff --git a/plugins/catalog-backend-module-openapi/api-report.md b/plugins/catalog-backend-module-openapi/api-report.md
index 92ddd1e3cd..d3a40067c5 100644
--- a/plugins/catalog-backend-module-openapi/api-report.md
+++ b/plugins/catalog-backend-module-openapi/api-report.md
@@ -6,12 +6,19 @@
import { CatalogProcessor } from '@backstage/plugin-catalog-backend';
import { Config } from '@backstage/config';
import { Entity } from '@backstage/catalog-model';
+import { JsonValue } from '@backstage/types';
import { LocationSpec } from '@backstage/plugin-catalog-backend';
import { Logger } from 'winston';
+import { PlaceholderResolverParams } from '@backstage/plugin-catalog-backend';
import { ScmIntegrations } from '@backstage/integration';
import { UrlReader } from '@backstage/backend-common';
// @public (undocumented)
+export function openApiPlaceholderResolver(
+ params: PlaceholderResolverParams,
+): Promise;
+
+// @public @deprecated (undocumented)
export class OpenApiRefProcessor implements CatalogProcessor {
constructor(options: {
integrations: ScmIntegrations;
diff --git a/plugins/catalog-backend-module-openapi/package.json b/plugins/catalog-backend-module-openapi/package.json
index d2d4d4989c..81f8875247 100644
--- a/plugins/catalog-backend-module-openapi/package.json
+++ b/plugins/catalog-backend-module-openapi/package.json
@@ -39,6 +39,8 @@
"@backstage/config": "^1.0.1",
"@backstage/integration": "^1.3.0-next.0",
"@backstage/plugin-catalog-backend": "^1.3.1-next.0",
+ "@backstage/plugin-catalog-node": "^1.0.1-next.0",
+ "@backstage/types": "^1.0.0",
"winston": "^3.2.1",
"yaml": "^2.1.1"
},
diff --git a/plugins/catalog-backend-module-openapi/src/OpenApiRefProcessor.test.ts b/plugins/catalog-backend-module-openapi/src/OpenApiRefProcessor.test.ts
index 8f2cc571c2..21080202b5 100644
--- a/plugins/catalog-backend-module-openapi/src/OpenApiRefProcessor.test.ts
+++ b/plugins/catalog-backend-module-openapi/src/OpenApiRefProcessor.test.ts
@@ -86,7 +86,7 @@ describe('OpenApiRefProcessor', () => {
it('should ignore other specification types', async () => {
const { entity, processor } = setupTest({
- kind: 'Group',
+ kind: 'API',
spec: { type: 'asyncapi' },
});
diff --git a/plugins/catalog-backend-module-openapi/src/OpenApiRefProcessor.ts b/plugins/catalog-backend-module-openapi/src/OpenApiRefProcessor.ts
index 01875e0779..f4cffdf48f 100644
--- a/plugins/catalog-backend-module-openapi/src/OpenApiRefProcessor.ts
+++ b/plugins/catalog-backend-module-openapi/src/OpenApiRefProcessor.ts
@@ -24,7 +24,10 @@ import {
import { bundleOpenApiSpecification } from './lib';
import { Logger } from 'winston';
-/** @public */
+/**
+ * @public
+ * @deprecated replaced by the openApiPlaceholderResolver
+ */
export class OpenApiRefProcessor implements CatalogProcessor {
private readonly integrations: ScmIntegrations;
private readonly logger: Logger;
@@ -69,17 +72,23 @@ export class OpenApiRefProcessor implements CatalogProcessor {
}
const scmIntegration = this.integrations.byUrl(location.target);
- if (!scmIntegration) {
+ const definition = entity.spec!.definition;
+
+ if (!scmIntegration || !definition) {
return entity;
}
+ const resolveUrl = (url: string, base: string): string => {
+ return scmIntegration.resolveUrl({ url, base });
+ };
+
this.logger.debug(`Bundling OpenAPI specification from ${location.target}`);
try {
const bundledSpec = await bundleOpenApiSpecification(
- entity.spec!.definition?.toString(),
+ definition.toString(),
location.target,
- this.reader,
- scmIntegration,
+ this.reader.read,
+ resolveUrl,
);
return {
diff --git a/plugins/catalog-backend-module-openapi/src/index.ts b/plugins/catalog-backend-module-openapi/src/index.ts
index f98bee6bac..ccd3ced71e 100644
--- a/plugins/catalog-backend-module-openapi/src/index.ts
+++ b/plugins/catalog-backend-module-openapi/src/index.ts
@@ -14,3 +14,4 @@
* limitations under the License.
*/
export { OpenApiRefProcessor } from './OpenApiRefProcessor';
+export { openApiPlaceholderResolver } from './openApiPlaceholderResolver';
diff --git a/plugins/catalog-backend-module-openapi/src/lib/bundle.test.ts b/plugins/catalog-backend-module-openapi/src/lib/bundle.test.ts
index 4505f158b5..0ecd9f7fd1 100644
--- a/plugins/catalog-backend-module-openapi/src/lib/bundle.test.ts
+++ b/plugins/catalog-backend-module-openapi/src/lib/bundle.test.ts
@@ -13,8 +13,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import { ConfigReader } from '@backstage/config';
-import { ScmIntegrations } from '@backstage/integration';
import { bundleOpenApiSpecification } from './bundle';
const specification = `
@@ -73,43 +71,21 @@ paths:
`;
describe('bundleOpenApiSpecification', () => {
- const readUrl = jest.fn();
- const reader = {
- readUrl,
- read: jest.fn(),
- readTree: jest.fn(),
- search: jest.fn(),
- };
-
- const scmIntegration = ScmIntegrations.fromConfig(new ConfigReader({})).byUrl(
- 'https://github.com/owner/repo/blob/main/openapi.yaml',
- );
+ const read = jest.fn();
+ const resolveUrl = jest.fn();
beforeEach(() => {
jest.clearAllMocks();
});
- it('should return undefined if no specification is supplied', async () => {
- expect(
- await bundleOpenApiSpecification(
- undefined,
- 'https://github.com/owner/repo/blob/main/openapi.yaml',
- reader,
- scmIntegration as any,
- ),
- ).toBeUndefined();
- });
-
it('should return the bundled specification', async () => {
- readUrl.mockResolvedValue({
- buffer: jest.fn().mockResolvedValue(list),
- });
+ read.mockResolvedValue(list);
const result = await bundleOpenApiSpecification(
specification,
- 'https://github.com/owner/repo/blob/main/openapi.yaml',
- reader,
- scmIntegration as any,
+ 'https://github.com/owner/repo/blob/main/catalog-info.yaml',
+ read,
+ resolveUrl,
);
expect(result).toEqual(expectedResult.trimStart());
diff --git a/plugins/catalog-backend-module-openapi/src/lib/bundle.ts b/plugins/catalog-backend-module-openapi/src/lib/bundle.ts
index 3d35429d8b..6ac8d211e2 100644
--- a/plugins/catalog-backend-module-openapi/src/lib/bundle.ts
+++ b/plugins/catalog-backend-module-openapi/src/lib/bundle.ts
@@ -13,8 +13,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import { UrlReader } from '@backstage/backend-common';
-import { ScmIntegration } from '@backstage/integration';
import SwaggerParser from '@apidevtools/swagger-parser';
import { parse, stringify } from 'yaml';
import * as path from 'path';
@@ -28,12 +26,16 @@ const getProtocol = (refPath: string) => {
return undefined;
};
+export type BundlerRead = (url: string) => Promise;
+
+export type BundlerResolveUrl = (url: string, base: string) => string;
+
export async function bundleOpenApiSpecification(
- specification: string | undefined,
- targetUrl: string,
- reader: UrlReader,
- scmIntegration: ScmIntegration,
-): Promise {
+ specification: string,
+ baseUrl: string,
+ read: BundlerRead,
+ resolveUrl: BundlerResolveUrl,
+): Promise {
const fileUrlReaderResolver: SwaggerParser.ResolverOptions = {
canRead: file => {
const protocol = getProtocol(file.url);
@@ -41,22 +43,11 @@ export async function bundleOpenApiSpecification(
},
read: async file => {
const relativePath = path.relative('.', file.url);
- const url = scmIntegration.resolveUrl({
- base: targetUrl,
- url: relativePath,
- });
- if (reader.readUrl) {
- const data = await reader.readUrl(url);
- return data.buffer();
- }
- throw new Error('UrlReader has no readUrl method defined');
+ const url = resolveUrl(relativePath, baseUrl);
+ return await read(url);
},
};
- if (!specification) {
- return undefined;
- }
-
const options: SwaggerParser.Options = {
resolve: {
file: fileUrlReaderResolver,
diff --git a/plugins/catalog-backend-module-openapi/src/openApiPlaceholderResolver.test.ts b/plugins/catalog-backend-module-openapi/src/openApiPlaceholderResolver.test.ts
new file mode 100644
index 0000000000..f58a818ba5
--- /dev/null
+++ b/plugins/catalog-backend-module-openapi/src/openApiPlaceholderResolver.test.ts
@@ -0,0 +1,63 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { PlaceholderResolverParams } from '@backstage/plugin-catalog-backend';
+import { openApiPlaceholderResolver } from './openApiPlaceholderResolver';
+import { bundleOpenApiSpecification } from './lib';
+
+jest.mock('./lib', () => ({
+ bundleOpenApiSpecification: jest.fn(),
+}));
+
+const bundledSpecification = '';
+
+describe('openApiPlaceholderResolver', () => {
+ const mockResolveUrl = jest.fn();
+ mockResolveUrl.mockReturnValue('mockUrl');
+
+ const mockRead = jest.fn();
+ mockRead.mockResolvedValue(Buffer.from('mockData'));
+
+ const params: PlaceholderResolverParams = {
+ key: 'openapi',
+ value: './spec/openapi.yaml',
+ baseUrl: 'https://github.com/owner/repo/blob/main/catalog-info.yaml',
+ resolveUrl: mockResolveUrl,
+ read: mockRead,
+ emit: jest.fn(),
+ };
+
+ beforeEach(() => {
+ (bundleOpenApiSpecification as any).mockResolvedValue(bundledSpecification);
+ });
+
+ afterEach(() => {
+ jest.clearAllMocks();
+ });
+
+ it('should throw error if unable to bundle the OpenAPI specification', async () => {
+ (bundleOpenApiSpecification as any).mockRejectedValue(new Error('TEST'));
+
+ await expect(openApiPlaceholderResolver(params)).rejects.toThrow(
+ 'Placeholder $openapi unable to bundle OpenAPI specification',
+ );
+ });
+
+ it('should bundle the OpenAPI specification', async () => {
+ const result = await openApiPlaceholderResolver(params);
+
+ expect(result).toEqual(bundledSpecification);
+ });
+});
diff --git a/plugins/catalog-backend-module-openapi/src/openApiPlaceholderResolver.ts b/plugins/catalog-backend-module-openapi/src/openApiPlaceholderResolver.ts
new file mode 100644
index 0000000000..96fadb3cbc
--- /dev/null
+++ b/plugins/catalog-backend-module-openapi/src/openApiPlaceholderResolver.ts
@@ -0,0 +1,85 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { PlaceholderResolverParams } from '@backstage/plugin-catalog-backend';
+import { JsonValue } from '@backstage/types';
+import { processingResult } from '@backstage/plugin-catalog-node';
+import { bundleOpenApiSpecification } from './lib';
+
+/** @public */
+export async function openApiPlaceholderResolver(
+ params: PlaceholderResolverParams,
+): Promise {
+ const { content, url } = await readTextLocation(params);
+
+ params.emit(processingResult.refresh(`url:${url}`));
+
+ try {
+ return await bundleOpenApiSpecification(
+ content,
+ url,
+ params.read,
+ params.resolveUrl,
+ );
+ } catch (error) {
+ throw new Error(
+ `Placeholder \$${params.key} unable to bundle OpenAPI specification at ${params.value}, ${error}`,
+ );
+ }
+}
+
+/*
+ * Helpers, copied from PlaceholderProcessor
+ */
+
+async function readTextLocation(
+ params: PlaceholderResolverParams,
+): Promise<{ content: string; url: string }> {
+ const newUrl = relativeUrl(params);
+
+ try {
+ const data = await params.read(newUrl);
+ return { content: data.toString('utf-8'), url: newUrl };
+ } catch (e) {
+ throw new Error(
+ `Placeholder \$${params.key} could not read location ${params.value}, ${e}`,
+ );
+ }
+}
+
+function relativeUrl({
+ key,
+ value,
+ baseUrl,
+ resolveUrl,
+}: PlaceholderResolverParams): string {
+ if (typeof value !== 'string') {
+ throw new Error(
+ `Placeholder \$${key} expected a string value parameter, in the form of an absolute URL or a relative path`,
+ );
+ }
+
+ try {
+ return resolveUrl(value, baseUrl);
+ } catch (e) {
+ // The only remaining case that isn't support is a relative file path that should be
+ // resolved using a relative file location. Accessing local file paths can lead to
+ // path traversal attacks and access to any file on the host system. Implementing this
+ // would require additional security measures.
+ throw new Error(
+ `Placeholder \$${key} could not form a URL out of ${baseUrl} and ${value}, ${e}`,
+ );
+ }
+}
From fcb6b2d531fa2ebc7cd1d6f4f3a69b6c3af506fd Mon Sep 17 00:00:00 2001
From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com>
Date: Thu, 11 Aug 2022 11:13:32 +0000
Subject: [PATCH 20/24] fix(deps): update dependency rollup to v2.77.3
Signed-off-by: Renovate Bot
---
yarn.lock | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/yarn.lock b/yarn.lock
index 43f1cc89fc..76410ec502 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -23320,9 +23320,9 @@ rollup@^0.63.4:
"@types/node" "*"
rollup@^2.60.2:
- version "2.77.2"
- resolved "https://registry.npmjs.org/rollup/-/rollup-2.77.2.tgz#6b6075c55f9cc2040a5912e6e062151e42e2c4e3"
- integrity sha512-m/4YzYgLcpMQbxX3NmAqDvwLATZzxt8bIegO78FZLl+lAgKJBd1DRAOeEiZcKOIOPjxE6ewHWHNgGEalFXuz1g==
+ version "2.77.3"
+ resolved "https://registry.npmjs.org/rollup/-/rollup-2.77.3.tgz#8f00418d3a2740036e15deb653bed1a90ee0cc12"
+ integrity sha512-/qxNTG7FbmefJWoeeYJFbHehJ2HNWnjkAFRKzWN/45eNBBF/r8lo992CwcJXEzyVxs5FmfId+vTSTQDb+bxA+g==
optionalDependencies:
fsevents "~2.3.2"
From 2d7e22953a7c61f6523640f07917fe48bf382ee4 Mon Sep 17 00:00:00 2001
From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com>
Date: Thu, 11 Aug 2022 11:26:49 +0000
Subject: [PATCH 21/24] chore(deps): update dependency @graphql-codegen/cli to
v2.11.6
Signed-off-by: Renovate Bot
---
yarn.lock | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/yarn.lock b/yarn.lock
index f9fd40ff2d..c1b27dc74e 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -2815,11 +2815,11 @@
meros "^1.1.4"
"@graphql-codegen/cli@^2.3.1":
- version "2.11.5"
- resolved "https://registry.npmjs.org/@graphql-codegen/cli/-/cli-2.11.5.tgz#6e781d9e77b8a9192456a8f50059e4281be12b73"
- integrity sha512-0RntZ/F/d7M7KJU24nDwfKTuuhpwQ8nSs00RgKIqsk4xSX/U9HgOp29pWZfJjHCppb0EiXKBDvK4DtQIqe3n3w==
+ version "2.11.6"
+ resolved "https://registry.npmjs.org/@graphql-codegen/cli/-/cli-2.11.6.tgz#3acfd7cd3bac40999ba1262063d84ca7c96172dc"
+ integrity sha512-0R2Bhgjt3XZTSdsn8MGGuJjDEN2z+KCo7920zLZz9boy6bQ0EyuxS9AUATePS9aC3djy2POAIPCHz8iHK68IlQ==
dependencies:
- "@graphql-codegen/core" "2.6.1"
+ "@graphql-codegen/core" "2.6.2"
"@graphql-codegen/plugin-helpers" "^2.6.2"
"@graphql-tools/apollo-engine-loader" "^7.3.6"
"@graphql-tools/code-file-loader" "^7.3.1"
@@ -2851,13 +2851,13 @@
yaml "^1.10.0"
yargs "^17.0.0"
-"@graphql-codegen/core@2.6.1":
- version "2.6.1"
- resolved "https://registry.npmjs.org/@graphql-codegen/core/-/core-2.6.1.tgz#57599a2e97d3c5109d888781587eba65f3c6cabe"
- integrity sha512-X6IIQCIvEm+g6xcd/5ml/Tmz8U6pd4q9s1mM4WcstBQ26v+gzzlj6lc7+6ALhrNm25gHKQ4PiVoG2W0pw503Dw==
+"@graphql-codegen/core@2.6.2":
+ version "2.6.2"
+ resolved "https://registry.npmjs.org/@graphql-codegen/core/-/core-2.6.2.tgz#29c766d2e9e5a3deeeb4f1728c1f7b1aca054a22"
+ integrity sha512-58T5yf9nEfAhDwN1Vz1hImqpdJ/gGpCGUaroQ5tqskZPf7eZYYVkEXbtqRZZLx1MCCKwjWX4hMtTPpHhwKCkng==
dependencies:
"@graphql-codegen/plugin-helpers" "^2.6.2"
- "@graphql-tools/schema" "^8.5.0"
+ "@graphql-tools/schema" "^9.0.0"
"@graphql-tools/utils" "^8.8.0"
tslib "~2.4.0"
@@ -3228,7 +3228,7 @@
tslib "~2.3.0"
value-or-promise "1.0.11"
-"@graphql-tools/schema@8.5.0", "@graphql-tools/schema@^8.5.0":
+"@graphql-tools/schema@8.5.0":
version "8.5.0"
resolved "https://registry.npmjs.org/@graphql-tools/schema/-/schema-8.5.0.tgz#0332b3a2e674d16e9bf8a58dfd47432449ce2368"
integrity sha512-VeFtKjM3SA9/hCJJfr95aEdC3G0xIKM9z0Qdz4i+eC1g2fdZYnfWFt2ucW4IME+2TDd0enHlKzaV0qk2SLVUww==
From dcf81f1a6e6eecd96430ae3ca5ddfae5913ff5c9 Mon Sep 17 00:00:00 2001
From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com>
Date: Thu, 11 Aug 2022 12:04:53 +0000
Subject: [PATCH 22/24] fix(deps): update dependency @graphql-tools/schema to
v9.0.1
Signed-off-by: Renovate Bot
---
yarn.lock | 34 +++++++++++++++++-----------------
1 file changed, 17 insertions(+), 17 deletions(-)
diff --git a/yarn.lock b/yarn.lock
index a3c5aacf8b..8c8279aff0 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -3159,12 +3159,12 @@
"@graphql-tools/utils" "8.9.0"
tslib "^2.4.0"
-"@graphql-tools/merge@8.3.2":
- version "8.3.2"
- resolved "https://registry.npmjs.org/@graphql-tools/merge/-/merge-8.3.2.tgz#a058e0307b9a145c6965420fd67ee1405cf033e8"
- integrity sha512-r8TFlDFA9N4hbkKbHCUK5pkiSnVUsB5AtcyhoY1d3b9zNa9CAYgxZMkKZgDJAf9ZTIqki9t0eOW/jn1H4MCFsg==
+"@graphql-tools/merge@8.3.3":
+ version "8.3.3"
+ resolved "https://registry.npmjs.org/@graphql-tools/merge/-/merge-8.3.3.tgz#74dd4816c3fc7af38730fc59d1cba6e687d7fb2d"
+ integrity sha512-EfULshN2s2s2mhBwbV9WpGnoehRLe7eIMdZrKfHhxlBWOvtNUd3KSCN0PUdAMd7lj1jXUW9KYdn624JrVn6qzg==
dependencies:
- "@graphql-tools/utils" "8.9.1"
+ "@graphql-tools/utils" "8.10.0"
tslib "^2.4.0"
"@graphql-tools/mock@^8.1.2":
@@ -3249,12 +3249,12 @@
value-or-promise "1.0.11"
"@graphql-tools/schema@^9.0.0":
- version "9.0.0"
- resolved "https://registry.npmjs.org/@graphql-tools/schema/-/schema-9.0.0.tgz#a689ae23474bf662b3571a180f0e0d11c7b8f135"
- integrity sha512-H1rlt0tptzYE1jnKGjfmMvvMCwsDTUgCy3Eam9agsPP4ZtHAcwijDx3BKKJaV1fDRV5ztz2aJ5Q7+4s/SMOYvQ==
+ version "9.0.1"
+ resolved "https://registry.npmjs.org/@graphql-tools/schema/-/schema-9.0.1.tgz#ba8629107c1f0b9ffad14c08c2a85961967682fd"
+ integrity sha512-Y6apeiBmvXEz082IAuS/ainnEEQrzMECP1MRIV72eo2WPa6ZtLYPycvIbd56Z5uU2LKP4XcWRgK6WUbCyN16Rw==
dependencies:
- "@graphql-tools/merge" "8.3.2"
- "@graphql-tools/utils" "8.9.1"
+ "@graphql-tools/merge" "8.3.3"
+ "@graphql-tools/utils" "8.10.0"
tslib "^2.4.0"
value-or-promise "1.0.11"
@@ -3300,6 +3300,13 @@
value-or-promise "^1.0.11"
ws "^8.3.0"
+"@graphql-tools/utils@8.10.0":
+ version "8.10.0"
+ resolved "https://registry.npmjs.org/@graphql-tools/utils/-/utils-8.10.0.tgz#8e76db7487e19b60cf99fb90c2d6343b2105b331"
+ integrity sha512-yI+V373FdXQbYfqdarehn9vRWDZZYuvyQ/xwiv5ez2BbobHrqsexF7qs56plLRaQ8ESYpVAjMQvJWe9s23O0Jg==
+ dependencies:
+ tslib "^2.4.0"
+
"@graphql-tools/utils@8.6.9":
version "8.6.9"
resolved "https://registry.npmjs.org/@graphql-tools/utils/-/utils-8.6.9.tgz#fe1b81df29c9418b41b7a1ffe731710b93d3a1fe"
@@ -3321,13 +3328,6 @@
dependencies:
tslib "^2.4.0"
-"@graphql-tools/utils@8.9.1":
- version "8.9.1"
- resolved "https://registry.npmjs.org/@graphql-tools/utils/-/utils-8.9.1.tgz#11d6c8a292ac5f224dfda655b87adfece3a257c6"
- integrity sha512-LHR7U4okICeUap+WV/T1FnLOmTr3KYuphgkXYendaBVO/DXKyc+TeOFBiN1LcEjPqCB8hO+0B0iTIO0cGqhNTA==
- dependencies:
- tslib "^2.4.0"
-
"@graphql-tools/wrap@8.5.0":
version "8.5.0"
resolved "https://registry.npmjs.org/@graphql-tools/wrap/-/wrap-8.5.0.tgz#ce1b0d775e1fc3a17404df566f4d2196d31c6e20"
From 72c228fdb8edc3258232f2f45bdba515b99c0098 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg
Date: Thu, 11 Aug 2022 15:38:37 +0200
Subject: [PATCH 23/24] cli: fix node env not being set for backend dev
Signed-off-by: Patrik Oldsberg
---
.changeset/funny-oranges-switch.md | 5 +++++
packages/cli/src/lib/bundler/backend.ts | 4 ++++
2 files changed, 9 insertions(+)
create mode 100644 .changeset/funny-oranges-switch.md
diff --git a/.changeset/funny-oranges-switch.md b/.changeset/funny-oranges-switch.md
new file mode 100644
index 0000000000..23c3104441
--- /dev/null
+++ b/.changeset/funny-oranges-switch.md
@@ -0,0 +1,5 @@
+---
+'@backstage/cli': patch
+---
+
+Fixed a bug where `NODE_ENV` was not set in the environment when starting the backend in development mode. It has always been the case that Webpack transformed `NODE_ENV` when running in development mode, but this did not affect dependencies in `node_modules` as they are treated as external.
diff --git a/packages/cli/src/lib/bundler/backend.ts b/packages/cli/src/lib/bundler/backend.ts
index 1b161976e3..3094450d4b 100644
--- a/packages/cli/src/lib/bundler/backend.ts
+++ b/packages/cli/src/lib/bundler/backend.ts
@@ -26,6 +26,10 @@ export async function serveBackend(options: BackendServeOptions) {
isDev: true,
});
+ // Webpack only replaces occurrences of this in code it touches, which does
+ // not include dependencies in node_modules. So we set it here at runtime as well.
+ (process.env as { NODE_ENV: string }).NODE_ENV = 'development';
+
const compiler = webpack(config, (err: Error | undefined) => {
if (err) {
console.error(err);
From 57e550fae1a2402208350d06d0acb9b9f0884a51 Mon Sep 17 00:00:00 2001
From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com>
Date: Thu, 11 Aug 2022 15:13:13 +0000
Subject: [PATCH 24/24] fix(deps): update dependency @octokit/webhooks to
v10.1.3
Signed-off-by: Renovate Bot
---
yarn.lock | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/yarn.lock b/yarn.lock
index 96f098eeed..9bd862beb8 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -5837,19 +5837,19 @@
resolved "https://registry.npmjs.org/@octokit/webhooks-methods/-/webhooks-methods-3.0.0.tgz#4f4443605233f46abc5f85a857ba105095aa1181"
integrity sha512-FAIyAchH9JUKXugKMC17ERAXM/56vVJekwXOON46pmUDYfU7uXB4cFY8yc8nYr5ABqVI7KjRKfFt3mZF7OcyUA==
-"@octokit/webhooks-types@6.3.2":
- version "6.3.2"
- resolved "https://registry.npmjs.org/@octokit/webhooks-types/-/webhooks-types-6.3.2.tgz#752497434e735874ba985ea0d53d63e2568e838d"
- integrity sha512-6DSvdzg7AIVgLjIjqf5BDrloMs7zUfpF0EJhLiOjXtuLr38W5pWSC7aHr7V59LCEDueJRfKZ6c9ZyuLLqVgx8g==
+"@octokit/webhooks-types@6.3.4":
+ version "6.3.4"
+ resolved "https://registry.npmjs.org/@octokit/webhooks-types/-/webhooks-types-6.3.4.tgz#b553da7479edfb04218160c85f16dbbc68251533"
+ integrity sha512-9E0HNgHqc5v22+9IzCSEZ9iXnBJ/n+GM9gZye0kp7XmzcOfrnAKZzd4km269n6/vVOkmXwT11DbbQFukWOvbdw==
"@octokit/webhooks@^10.0.0":
- version "10.1.2"
- resolved "https://registry.npmjs.org/@octokit/webhooks/-/webhooks-10.1.2.tgz#78396b6d32c60789f6031d2551a2cd598c157627"
- integrity sha512-jxISKMLiYebQ/EByLXDEWQMcHASKUVl1T0EuCnpHTYjELsDXg7BEw0FCInlc8RpWmmPp4sMsh3Dd86spXAIp1A==
+ version "10.1.3"
+ resolved "https://registry.npmjs.org/@octokit/webhooks/-/webhooks-10.1.3.tgz#415bb4f826167b15da4dede81c14cb7a8978ac9a"
+ integrity sha512-c5uQW0HJbI5mcQpUFcM7LVs1gbdEiHD6OLXZcwxLJeNUmI8Cy9uzfCib6HguARKgnz3tSavYX/teHq7brm05iQ==
dependencies:
"@octokit/request-error" "^3.0.0"
"@octokit/webhooks-methods" "^3.0.0"
- "@octokit/webhooks-types" "6.3.2"
+ "@octokit/webhooks-types" "6.3.4"
aggregate-error "^3.1.0"
"@open-draft/until@^1.0.3":