= ComponentType
& {
[DATA_KEY]?: DataContainer;
};
-type ReactNodeWithData = ReactNode & {
- type?: { [DATA_KEY]?: DataContainer };
+type DataContainer = {
+ map: Map (
component: ComponentType ,
type: string,
@@ -37,9 +56,11 @@ export function attachComponentData (
) {
const dataComponent = component as ComponentWithData ;
- let container = dataComponent[DATA_KEY];
+ let container = store.get(component) || dataComponent[DATA_KEY];
if (!container) {
- container = dataComponent[DATA_KEY] = { map: new Map() };
+ container = { map: new Map() };
+ store.set(component, container);
+ dataComponent[DATA_KEY] = container;
}
if (container.map.has(type)) {
@@ -60,7 +81,12 @@ export function getComponentData
- {type ?? {type} }
+ {(subtitle || type) && (
+ {subtitle ?? type}
+ )}
{title}
diff --git a/packages/create-app/CHANGELOG.md b/packages/create-app/CHANGELOG.md
index 6a0f75ebaf..de59a343ed 100644
--- a/packages/create-app/CHANGELOG.md
+++ b/packages/create-app/CHANGELOG.md
@@ -1,5 +1,277 @@
# @backstage/create-app
+## 0.3.11
+
+### Patch Changes
+
+- 4594f7efc: Add the google analytics scripts in the `index.html` template for new applications.
+
+ To apply this change to an existing application, change the following in `packages\app\public\index.html`:
+
+ ```diff
+ <%= app.title %>
+
+ + <% if (app.googleAnalyticsTrackingId && typeof app.googleAnalyticsTrackingId
+ + === 'string') { %>
+ +
+ +
+ + <% } %>
+
+ ```
+
+- 08fa2176a: **BREAKING CHANGE**
+
+ The Scaffolder and Catalog plugins have been migrated to partially require use of the [new composability API](https://backstage.io/docs/plugins/composability). The Scaffolder used to register its pages using the deprecated route registration plugin API, but those registrations have been removed. This means you now need to add the Scaffolder plugin page to the app directly.
+
+ The Catalog plugin has also been migrated to use an [external route reference](https://backstage.io/docs/plugins/composability#binding-external-routes-in-the-app) to dynamically link to the create component page. This means you need to migrate the catalog plugin to use the new extension components, as well as bind the external route.
+
+ Apply the following changes to `packages/app/src/App.tsx`:
+
+ ```diff
+ -import { Router as CatalogRouter } from '@backstage/plugin-catalog';
+ +import {
+ + catalogPlugin,
+ + CatalogIndexPage,
+ + CatalogEntityPage,
+ +} from '@backstage/plugin-catalog';
+ +import { scaffolderPlugin, ScaffolderPage } from '@backstage/plugin-scaffolder';
+
+ # The following addition to the app config allows the catalog plugin to link to the
+ # component creation page, i.e. the scaffolder. You can chose a different target if you want to.
+ const app = createApp({
+ apis,
+ plugins: Object.values(plugins),
+ + bindRoutes({ bind }) {
+ + bind(catalogPlugin.externalRoutes, {
+ + createComponent: scaffolderPlugin.routes.root,
+ + });
+ + }
+ });
+
+ # Apply these changes within FlatRoutes. It is important to have migrated to using FlatRoutes
+ # for this to work, if you haven't done that yet, see the previous entries in this changelog.
+ - <%= app.title %>
+ <% if (app.googleAnalyticsTrackingId && typeof app.googleAnalyticsTrackingId
+ === 'string') { %>
+
+
+ <% } %>
diff --git a/packages/create-app/templates/default-app/packages/app/src/App.tsx b/packages/create-app/templates/default-app/packages/app/src/App.tsx
index 711e501224..d4f1178899 100644
--- a/packages/create-app/templates/default-app/packages/app/src/App.tsx
+++ b/packages/create-app/templates/default-app/packages/app/src/App.tsx
@@ -10,23 +10,33 @@ import { apis } from './apis';
import * as plugins from './plugins';
import { AppSidebar } from './sidebar';
import { Route, Navigate } from 'react-router';
-import { Router as CatalogRouter } from '@backstage/plugin-catalog';
-import { Router as DocsRouter } from '@backstage/plugin-techdocs';
+import {
+ catalogPlugin,
+ CatalogIndexPage,
+ CatalogEntityPage,
+} from '@backstage/plugin-catalog';
+import { TechdocsPage } from '@backstage/plugin-techdocs';
import { CatalogImportPage } from '@backstage/plugin-catalog-import';
-import { Router as TechRadarRouter } from '@backstage/plugin-tech-radar';
-import { SearchPage as SearchRouter } from '@backstage/plugin-search';
-import { Router as SettingsRouter } from '@backstage/plugin-user-settings';
+import { TechRadarPage } from '@backstage/plugin-tech-radar';
+import { SearchPage } from '@backstage/plugin-search';
+import { UserSettingsPage } from '@backstage/plugin-user-settings';
+import { ApiExplorerPage } from '@backstage/plugin-api-docs';
import { EntityPage } from './components/catalog/EntityPage';
+import { scaffolderPlugin, ScaffolderPage } from '@backstage/plugin-scaffolder';
const app = createApp({
apis,
plugins: Object.values(plugins),
+ bindRoutes({ bind }) {
+ bind(catalogPlugin.externalRoutes, {
+ createComponent: scaffolderPlugin.routes.root,
+ });
+ }
});
const AppProvider = app.getProvider();
const AppRouter = app.getRouter();
-const deprecatedAppRoutes = app.getRoutes();
const App = () => (
@@ -37,22 +47,23 @@ const App = () => (
}
- />
-
diff --git a/packages/create-app/templates/default-app/packages/backend/Dockerfile b/packages/create-app/templates/default-app/packages/backend/Dockerfile
index 50514713d3..acef405c8a 100644
--- a/packages/create-app/templates/default-app/packages/backend/Dockerfile
+++ b/packages/create-app/templates/default-app/packages/backend/Dockerfile
@@ -1,16 +1,26 @@
-FROM node:12-buster
+# This dockerfile builds an image for the backend package.
+# It should be executed with the root of the repo as docker context.
+#
+# Before building this image, be sure to have run the following commands in the repo root:
+#
+# yarn install
+# yarn tsc
+# yarn build
+#
+# Once the commands have been run, you can build the image using `yarn build-image`
-WORKDIR /usr/src/app
+FROM node:14-buster-slim
+
+WORKDIR /app
# Copy repo skeleton first, to avoid unnecessary docker cache invalidation.
# The skeleton contains the package.json of each package in the monorepo,
# and along with yarn.lock and the root package.json, that's enough to run yarn install.
-ADD yarn.lock package.json skeleton.tar ./
+ADD yarn.lock package.json packages/backend/dist/skeleton.tar.gz ./
RUN yarn install --frozen-lockfile --production --network-timeout 300000 && rm -rf "$(yarn cache dir)"
-# This will copy the contents of the dist-workspace when running the build-image command.
-# Do not use this Dockerfile outside of that command, as it will copy in the source code instead.
-COPY . .
+# Then copy the rest of the backend bundle, along with any other files we might want.
+ADD packages/backend/dist/bundle.tar.gz app-config.yaml ./
-CMD ["node", "packages/backend", "--config", "app-config.yaml", "--config", "app-config.production.yaml"]
+CMD ["node", "packages/backend", "--config", "app-config.yaml"]
diff --git a/packages/create-app/templates/default-app/packages/backend/package.json.hbs b/packages/create-app/templates/default-app/packages/backend/package.json.hbs
index 3fed72f07b..8c8cfae0b3 100644
--- a/packages/create-app/templates/default-app/packages/backend/package.json.hbs
+++ b/packages/create-app/templates/default-app/packages/backend/package.json.hbs
@@ -8,8 +8,8 @@
"node": "12 || 14"
},
"scripts": {
- "build": "backstage-cli backend:build",
- "build-image": "backstage-cli backend:build-image --build --tag backstage",
+ "build": "backstage-cli backend:bundle",
+ "build-image": "docker build ../.. -f Dockerfile --tag backstage",
"start": "backstage-cli backend:dev",
"lint": "backstage-cli lint",
"test": "backstage-cli test",
@@ -20,6 +20,7 @@
"app": "0.0.0",
"@backstage/backend-common": "^{{version '@backstage/backend-common'}}",
"@backstage/catalog-model": "^{{version '@backstage/catalog-model'}}",
+ "@backstage/catalog-client": "^{{version '@backstage/catalog-client'}}",
"@backstage/config": "^{{version '@backstage/config'}}",
"@backstage/plugin-app-backend": "^{{version '@backstage/plugin-app-backend'}}",
"@backstage/plugin-auth-backend": "^{{version '@backstage/plugin-auth-backend'}}",
diff --git a/packages/create-app/templates/default-app/packages/backend/src/plugins/scaffolder.ts b/packages/create-app/templates/default-app/packages/backend/src/plugins/scaffolder.ts
index d68f90ce08..6f42aaa327 100644
--- a/packages/create-app/templates/default-app/packages/backend/src/plugins/scaffolder.ts
+++ b/packages/create-app/templates/default-app/packages/backend/src/plugins/scaffolder.ts
@@ -5,11 +5,11 @@ import {
Publishers,
CreateReactAppTemplater,
Templaters,
- CatalogEntityClient,
} from '@backstage/plugin-scaffolder-backend';
import { SingleHostDiscovery } from '@backstage/backend-common';
import type { PluginEnvironment } from '../types';
import Docker from 'dockerode';
+import { CatalogClient } from '@backstage/catalog-client';
export default async function createPlugin({
logger,
@@ -29,7 +29,7 @@ export default async function createPlugin({
const dockerClient = new Docker();
const discovery = SingleHostDiscovery.fromConfig(config);
- const entityClient = new CatalogEntityClient({ discovery });
+ const catalogClient = new CatalogClient({ discoveryApi: discovery });
return await createRouter({
preparers,
@@ -38,7 +38,7 @@ export default async function createPlugin({
logger,
config,
dockerClient,
- entityClient,
database,
+ catalogClient,
});
}
diff --git a/packages/dev-utils/CHANGELOG.md b/packages/dev-utils/CHANGELOG.md
index 4e16deebdc..f02ce3ae23 100644
--- a/packages/dev-utils/CHANGELOG.md
+++ b/packages/dev-utils/CHANGELOG.md
@@ -1,5 +1,43 @@
# @backstage/dev-utils
+## 0.1.12
+
+### Patch Changes
+
+- 5aa4ceea6: Make sure to provide dummy routes for all external routes of plugins given to DevApp
+- Updated dependencies [3a58084b6]
+- Updated dependencies [e799e74d4]
+- Updated dependencies [dc12852c9]
+- Updated dependencies [d0760ecdf]
+- Updated dependencies [1407b34c6]
+- Updated dependencies [88f1f1b60]
+- Updated dependencies [bad21a085]
+- Updated dependencies [9615e68fb]
+- Updated dependencies [49f9b7346]
+- Updated dependencies [5c2e2863f]
+- Updated dependencies [3a58084b6]
+- Updated dependencies [2c1f2a7c2]
+ - @backstage/core@0.6.3
+ - @backstage/test-utils@0.1.8
+ - @backstage/plugin-catalog-react@0.1.0
+ - @backstage/catalog-model@0.7.2
+
+## 0.1.11
+
+### Patch Changes
+
+- Updated dependencies [fd3f2a8c0]
+- Updated dependencies [d34d26125]
+- Updated dependencies [0af242b6d]
+- Updated dependencies [f4c2bcf54]
+- Updated dependencies [10a0124e0]
+- Updated dependencies [07e226872]
+- Updated dependencies [f62e7abe5]
+- Updated dependencies [96f378d10]
+- Updated dependencies [688b73110]
+ - @backstage/core@0.6.2
+ - @backstage/plugin-catalog-react@0.0.4
+
## 0.1.10
### Patch Changes
diff --git a/packages/dev-utils/package.json b/packages/dev-utils/package.json
index 7f53d029b3..0d2af1bc69 100644
--- a/packages/dev-utils/package.json
+++ b/packages/dev-utils/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/dev-utils",
"description": "Utilities for developing Backstage plugins.",
- "version": "0.1.10",
+ "version": "0.1.12",
"private": false,
"publishConfig": {
"access": "public",
@@ -29,10 +29,10 @@
"clean": "backstage-cli clean"
},
"dependencies": {
- "@backstage/core": "^0.6.1",
- "@backstage/catalog-model": "^0.7.1",
- "@backstage/plugin-catalog-react": "^0.0.3",
- "@backstage/test-utils": "^0.1.7",
+ "@backstage/core": "^0.6.3",
+ "@backstage/catalog-model": "^0.7.2",
+ "@backstage/plugin-catalog-react": "^0.1.0",
+ "@backstage/test-utils": "^0.1.8",
"@backstage/theme": "^0.2.3",
"@material-ui/core": "^4.11.0",
"@material-ui/icons": "^4.9.1",
@@ -47,7 +47,7 @@
"react-router-dom": "6.0.0-beta.0"
},
"devDependencies": {
- "@backstage/cli": "^0.6.0",
+ "@backstage/cli": "^0.6.2",
"@types/jest": "^26.0.7",
"@types/node": "^12.0.0"
},
diff --git a/packages/dev-utils/src/devApp/render.tsx b/packages/dev-utils/src/devApp/render.tsx
index e1bdf4d0e9..0c3a1395a6 100644
--- a/packages/dev-utils/src/devApp/render.tsx
+++ b/packages/dev-utils/src/devApp/render.tsx
@@ -14,26 +14,30 @@
* limitations under the License.
*/
-import { hot } from 'react-hot-loader';
-import React, { ComponentType, ReactNode } from 'react';
-import ReactDOM from 'react-dom';
-import BookmarkIcon from '@material-ui/icons/Bookmark';
import {
+ AlertDisplay,
+ AnyApiFactory,
+ ApiFactory,
+ attachComponentData,
createApp,
- SidebarPage,
+ createPlugin,
+ createRouteRef,
+ FlatRoutes,
+ IconComponent,
+ OAuthRequestDialog,
+ RouteRef,
Sidebar,
SidebarItem,
+ SidebarPage,
SidebarSpacer,
- ApiFactory,
- createPlugin,
- AlertDisplay,
- OAuthRequestDialog,
- AnyApiFactory,
- IconComponent,
- FlatRoutes,
- attachComponentData,
} from '@backstage/core';
+import { Box } from '@material-ui/core';
+import BookmarkIcon from '@material-ui/icons/Bookmark';
import SentimentDissatisfiedIcon from '@material-ui/icons/SentimentDissatisfied';
+import React, { ComponentType, ReactNode } from 'react';
+import ReactDOM from 'react-dom';
+import { hot } from 'react-hot-loader';
+import { Route } from 'react-router';
const GatheringRoute: (props: {
path: string;
@@ -128,9 +132,22 @@ class DevAppBuilder {
* Build a DevApp component using the resources registered so far
*/
build(): ComponentType<{}> {
+ const dummyRouteRef = createRouteRef({ title: 'Page of another plugin' });
+ const DummyPage = () => Page belonging to another plugin. ;
+ attachComponentData(DummyPage, 'core.mountPoint', dummyRouteRef);
+
const app = createApp({
apis: this.apis,
plugins: this.plugins,
+ bindRoutes: ({ bind }) => {
+ for (const plugin of this.plugins ?? []) {
+ const targets: Record> = {};
+ for (const routeKey of Object.keys(plugin.externalRoutes)) {
+ targets[routeKey] = dummyRouteRef;
+ }
+ bind(plugin.externalRoutes, targets);
+ }
+ },
});
const AppProvider = app.getProvider();
@@ -145,13 +162,13 @@ class DevAppBuilder {
{sidebar}
{this.routes}
{deprecatedAppRoutes}
+
diff --git a/packages/integration/CHANGELOG.md b/packages/integration/CHANGELOG.md
index 7056976458..2f6192c047 100644
--- a/packages/integration/CHANGELOG.md
+++ b/packages/integration/CHANGELOG.md
@@ -1,5 +1,11 @@
# @backstage/integration
+## 0.5.0
+
+### Minor Changes
+
+- 491f3a0ec: Make `ScmIntegration.resolveUrl` mandatory.
+
## 0.4.0
### Minor Changes
diff --git a/packages/integration/package.json b/packages/integration/package.json
index b4134ab00e..a7cd63171b 100644
--- a/packages/integration/package.json
+++ b/packages/integration/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/integration",
- "version": "0.4.0",
+ "version": "0.5.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -37,7 +37,7 @@
"luxon": "^1.25.0"
},
"devDependencies": {
- "@backstage/cli": "^0.6.0",
+ "@backstage/cli": "^0.6.1",
"@backstage/test-utils": "^0.1.7",
"@types/jest": "^26.0.7",
"@types/luxon": "^1.25.0",
diff --git a/packages/techdocs-common/CHANGELOG.md b/packages/techdocs-common/CHANGELOG.md
index 9f2a8c0be4..60a10c924e 100644
--- a/packages/techdocs-common/CHANGELOG.md
+++ b/packages/techdocs-common/CHANGELOG.md
@@ -1,5 +1,33 @@
# @backstage/techdocs-common
+## 0.4.2
+
+### Patch Changes
+
+- 2499f6cde: Add support for assuming role in AWS integrations
+- 1e4ddd71d: Fix AWS, GCS and Azure publisher to work on Windows.
+- Updated dependencies [bad21a085]
+- Updated dependencies [a1f5e6545]
+ - @backstage/catalog-model@0.7.2
+ - @backstage/config@0.1.3
+
+## 0.4.1
+
+### Patch Changes
+
+- fb28da212: Switched to using `'x-access-token'` for authenticating Git over HTTPS towards GitHub.
+- 26e143e60: After TechDocs generate step, insert build timestamp to techdocs_metadata.json
+- c6655413d: Improved error reporting in AzureBlobStorage to surface errors when fetching metadata and uploading files fails.
+- 44414239f: Pass user and group ID when invoking docker container. When TechDocs invokes Docker, docker could be run as a `root` user which results in generation of files by applications run by non-root user (e.g. TechDocs) will not have access to modify. This PR passes in current user and group ID to docker so that the file permissions of the generated files and folders are correct.
+- b0a41c707: Add etag of the prepared file tree to techdocs_metadata.json in the storage
+- Updated dependencies [16fb1d03a]
+- Updated dependencies [491f3a0ec]
+- Updated dependencies [491f3a0ec]
+- Updated dependencies [434b4e81a]
+- Updated dependencies [fb28da212]
+ - @backstage/backend-common@0.5.4
+ - @backstage/integration@0.5.0
+
## 0.4.0
### Minor Changes
diff --git a/packages/techdocs-common/__mocks__/@azure/storage-blob.ts b/packages/techdocs-common/__mocks__/@azure/storage-blob.ts
index 60a705f6a7..4fc1e4c374 100644
--- a/packages/techdocs-common/__mocks__/@azure/storage-blob.ts
+++ b/packages/techdocs-common/__mocks__/@azure/storage-blob.ts
@@ -13,7 +13,32 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import fs from 'fs';
+import type {
+ BlobUploadCommonResponse,
+ ContainerGetPropertiesResponse,
+} from '@azure/storage-blob';
+import fs from 'fs-extra';
+import os from 'os';
+import path from 'path';
+
+const rootDir = os.platform() === 'win32' ? 'C:\\rootDir' : '/rootDir';
+/**
+ * @param sourceFile Relative path to entity root dir. Contains either / or \ as file separator
+ * depending upon the OS.
+ */
+const checkFileExists = async (sourceFile: string): Promise => {
+ // sourceFile will always have / as file separator irrespective of OS since Azure expects /.
+ // Normalize sourceFile to OS specific path before checking if file exists.
+ const relativeFilePath = sourceFile.split(path.posix.sep).join(path.sep);
+ const filePath = path.join(rootDir, sourceFile);
+
+ try {
+ await fs.access(filePath, fs.constants.F_OK);
+ return true;
+ } catch (err) {
+ return false;
+ }
+};
export class BlockBlobClient {
private readonly blobName;
@@ -22,23 +47,33 @@ export class BlockBlobClient {
this.blobName = blobName;
}
- uploadFile(source: string) {
- return new Promise((resolve, reject) => {
- if (!fs.existsSync(source)) {
- reject('');
- } else {
- resolve('');
- }
+ uploadFile(source: string): Promise {
+ return Promise.resolve({
+ _response: {
+ request: {
+ url: `https://example.blob.core.windows.net`,
+ } as any,
+ status: 200,
+ headers: {} as any,
+ },
});
}
exists() {
- return new Promise((resolve, reject) => {
- if (fs.existsSync(this.blobName)) {
- resolve(true);
- } else {
- reject({ message: 'The object doest not exist !' });
- }
+ return checkFileExists(this.blobName);
+ }
+}
+
+class BlockBlobClientFailUpload extends BlockBlobClient {
+ uploadFile(source: string): Promise {
+ return Promise.resolve({
+ _response: {
+ request: {
+ url: `https://example.blob.core.windows.net`,
+ } as any,
+ status: 500,
+ headers: {} as any,
+ },
});
}
}
@@ -50,9 +85,16 @@ export class ContainerClient {
this.containerName = containerName;
}
- getProperties() {
- return new Promise(resolve => {
- resolve('');
+ getProperties(): Promise {
+ return Promise.resolve({
+ _response: {
+ request: {
+ url: `https://example.blob.core.windows.net`,
+ } as any,
+ status: 200,
+ headers: {} as any,
+ parsedHeaders: {},
+ },
});
}
@@ -61,6 +103,27 @@ export class ContainerClient {
}
}
+class ContainerClientFailGetProperties extends ContainerClient {
+ getProperties(): Promise {
+ return Promise.resolve({
+ _response: {
+ request: {
+ url: `https://example.blob.core.windows.net`,
+ } as any,
+ status: 404,
+ headers: {} as any,
+ parsedHeaders: {},
+ },
+ });
+ }
+}
+
+class ContainerClientFailUpload extends ContainerClient {
+ getBlockBlobClient(blobName: string) {
+ return new BlockBlobClientFailUpload(blobName);
+ }
+}
+
export class BlobServiceClient {
private readonly url;
private readonly credential;
@@ -71,6 +134,12 @@ export class BlobServiceClient {
}
getContainerClient(containerName: string) {
+ if (containerName === 'bad_container') {
+ return new ContainerClientFailGetProperties(containerName);
+ }
+ if (this.credential.accountName === 'failupload') {
+ return new ContainerClientFailUpload(containerName);
+ }
return new ContainerClient(containerName);
}
}
diff --git a/packages/techdocs-common/__mocks__/@google-cloud/storage.ts b/packages/techdocs-common/__mocks__/@google-cloud/storage.ts
index b84018c089..264852d31c 100644
--- a/packages/techdocs-common/__mocks__/@google-cloud/storage.ts
+++ b/packages/techdocs-common/__mocks__/@google-cloud/storage.ts
@@ -13,10 +13,67 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+import { EventEmitter } from 'events';
+import fs from 'fs-extra';
+import os from 'os';
+import path from 'path';
+
type storageOptions = {
keyFilename?: string;
};
+const rootDir = os.platform() === 'win32' ? 'C:\\rootDir' : '/rootDir';
+/**
+ * @param sourceFile Absolute path. Contains either / or \ as file separator depending upon the OS.
+ */
+const checkFileExists = async (sourceFile: string): Promise => {
+ // sourceFile will always have / as file separator irrespective of OS since GCS expects /.
+ // Normalize sourceFile to OS specific path before checking if file exists.
+ const filePath = sourceFile.split(path.posix.sep).join(path.sep);
+
+ try {
+ await fs.access(filePath, fs.constants.F_OK);
+ return true;
+ } catch (err) {
+ return false;
+ }
+};
+
+class GCSFile {
+ private readonly localFilePath: string;
+
+ constructor(private readonly destinationFilePath: string) {
+ this.destinationFilePath = destinationFilePath;
+ this.localFilePath = path.join(rootDir, this.destinationFilePath);
+ }
+
+ exists() {
+ return new Promise(async (resolve, reject) => {
+ if (await checkFileExists(this.localFilePath)) {
+ resolve([true]);
+ } else {
+ reject();
+ }
+ });
+ }
+
+ createReadStream() {
+ const emitter = new EventEmitter();
+ process.nextTick(() => {
+ if (fs.existsSync(this.localFilePath)) {
+ emitter.emit('data', Buffer.from(fs.readFileSync(this.localFilePath)));
+ emitter.emit('end');
+ } else {
+ emitter.emit(
+ 'error',
+ new Error(`The file ${this.localFilePath} does not exist !`),
+ );
+ }
+ });
+ return emitter;
+ }
+}
+
class Bucket {
private readonly bucketName;
@@ -31,10 +88,18 @@ class Bucket {
}
upload(source: string, { destination }) {
- return new Promise(resolve => {
- resolve({ source, destination });
+ return new Promise(async (resolve, reject) => {
+ if (await checkFileExists(source)) {
+ resolve({ source, destination });
+ } else {
+ reject(`Source file ${source} does not exist.`);
+ }
});
}
+
+ file(destinationFilePath: string) {
+ return new GCSFile(destinationFilePath);
+ }
}
export class Storage {
diff --git a/packages/techdocs-common/__mocks__/aws-sdk.ts b/packages/techdocs-common/__mocks__/aws-sdk.ts
index f0fb13c642..4717feda9b 100644
--- a/packages/techdocs-common/__mocks__/aws-sdk.ts
+++ b/packages/techdocs-common/__mocks__/aws-sdk.ts
@@ -15,7 +15,29 @@
*/
import type { S3 as S3Types } from 'aws-sdk';
import { EventEmitter } from 'events';
-import fs from 'fs';
+import fs from 'fs-extra';
+import os from 'os';
+import path from 'path';
+
+const rootDir = os.platform() === 'win32' ? 'C:\\rootDir' : '/rootDir';
+
+/**
+ * @param Key Relative path to entity root dir. Contains either / or \ as file separator
+ * depending upon the OS.
+ */
+const checkFileExists = async (Key: string): Promise => {
+ // Key will always have / as file separator irrespective of OS since S3 expects /.
+ // Normalize Key to OS specific path before checking if file exists.
+ const relativeFilePath = Key.split(path.posix.sep).join(path.sep);
+ const filePath = path.join(rootDir, Key);
+
+ try {
+ await fs.access(filePath, fs.constants.F_OK);
+ return true;
+ } catch (err) {
+ return false;
+ }
+};
export class S3 {
private readonly options;
@@ -26,39 +48,34 @@ export class S3 {
headObject({ Key }: { Key: string }) {
return {
- promise: () => this.checkFileExists(Key),
- };
- }
-
- getObject({ Key }: { Key: string }) {
- return {
- promise: () => this.checkFileExists(Key),
- createReadStream: () => {
- const emitter = new EventEmitter();
- process.nextTick(() => {
- if (fs.existsSync(Key)) {
- emitter.emit('data', Buffer.from(fs.readFileSync(Key)));
- } else {
- emitter.emit(
- 'error',
- new Error(`The file ${Key} doest not exist !`),
- );
- }
- emitter.emit('end');
- });
- return emitter;
+ promise: async () => {
+ if (!(await checkFileExists(Key))) {
+ throw new Error('File does not exist');
+ }
},
};
}
- checkFileExists(Key: string) {
- return new Promise((resolve, reject) => {
- if (fs.existsSync(Key)) {
- resolve('');
- } else {
- reject({ message: 'The object doest not exist !' });
- }
- });
+ getObject({ Key }: { Key: string }) {
+ const filePath = path.join(rootDir, Key);
+ return {
+ promise: () => checkFileExists(filePath),
+ createReadStream: () => {
+ const emitter = new EventEmitter();
+ process.nextTick(() => {
+ if (fs.existsSync(filePath)) {
+ emitter.emit('data', Buffer.from(fs.readFileSync(filePath)));
+ emitter.emit('end');
+ } else {
+ emitter.emit(
+ 'error',
+ new Error(`The file ${filePath} does not exist !`),
+ );
+ }
+ });
+ return emitter;
+ },
+ };
}
headBucket() {
@@ -70,8 +87,12 @@ export class S3 {
upload({ Key }: { Key: string }) {
return {
promise: () =>
- new Promise((resolve, reject) => {
- resolve('');
+ new Promise(async (resolve, reject) => {
+ if (!(await checkFileExists(Key))) {
+ reject(`The file ${Key} does not exist`);
+ } else {
+ resolve('');
+ }
}),
};
}
diff --git a/packages/techdocs-common/package.json b/packages/techdocs-common/package.json
index f1236cd6d5..c8ae633c97 100644
--- a/packages/techdocs-common/package.json
+++ b/packages/techdocs-common/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/techdocs-common",
"description": "Common functionalities for TechDocs, to be shared between techdocs-backend plugin and techdocs-cli",
- "version": "0.4.0",
+ "version": "0.4.2",
"main": "src/index.ts",
"types": "src/index.ts",
"private": false,
@@ -38,10 +38,10 @@
"dependencies": {
"@azure/identity": "^1.2.2",
"@azure/storage-blob": "^12.4.0",
- "@backstage/backend-common": "^0.5.3",
- "@backstage/catalog-model": "^0.7.1",
- "@backstage/config": "^0.1.2",
- "@backstage/integration": "^0.4.0",
+ "@backstage/backend-common": "^0.5.4",
+ "@backstage/catalog-model": "^0.7.2",
+ "@backstage/config": "^0.1.3",
+ "@backstage/integration": "^0.5.0",
"@google-cloud/storage": "^5.6.0",
"@types/dockerode": "^3.2.1",
"@types/express": "^4.17.6",
@@ -60,7 +60,7 @@
"winston": "^3.2.1"
},
"devDependencies": {
- "@backstage/cli": "^0.6.0",
+ "@backstage/cli": "^0.6.2",
"@types/fs-extra": "^9.0.5",
"@types/git-url-parse": "^9.0.0",
"@types/js-yaml": "^3.12.5",
diff --git a/packages/techdocs-common/src/stages/generate/helpers.test.ts b/packages/techdocs-common/src/stages/generate/helpers.test.ts
index c4bf102610..fbca6d1ed2 100644
--- a/packages/techdocs-common/src/stages/generate/helpers.test.ts
+++ b/packages/techdocs-common/src/stages/generate/helpers.test.ts
@@ -30,6 +30,7 @@ import {
patchMkdocsYmlPreBuild,
runDockerContainer,
storeEtagMetadata,
+ UserOptions,
} from './helpers';
const mockEntity = {
@@ -114,7 +115,7 @@ describe('helpers', () => {
imageName,
args,
expect.any(Stream),
- {
+ expect.objectContaining({
Volumes: {
'/content': {},
'/result': {},
@@ -123,7 +124,7 @@ describe('helpers', () => {
HostConfig: {
Binds: [`${docsDir}:/content`, `${outputDir}:/result`],
},
- },
+ }),
);
});
@@ -139,6 +140,30 @@ describe('helpers', () => {
expect(mockDocker.ping).toHaveBeenCalled();
});
+ it('should pass through the user and group id from the host machine and set the home dir', async () => {
+ await runDockerContainer({
+ imageName,
+ args,
+ docsDir,
+ outputDir,
+ dockerClient: mockDocker,
+ });
+
+ const userOptions: UserOptions = {};
+ if (process.getuid && process.getgid) {
+ userOptions.User = `${process.getuid()}:${process.getgid()}`;
+ }
+
+ expect(mockDocker.run).toHaveBeenCalledWith(
+ imageName,
+ args,
+ expect.any(Stream),
+ expect.objectContaining({
+ ...userOptions,
+ }),
+ );
+ });
+
describe('where docker is unavailable', () => {
const dockerError = 'a docker error';
diff --git a/packages/techdocs-common/src/stages/generate/helpers.ts b/packages/techdocs-common/src/stages/generate/helpers.ts
index 32da5d19e8..a88ed13231 100644
--- a/packages/techdocs-common/src/stages/generate/helpers.ts
+++ b/packages/techdocs-common/src/stages/generate/helpers.ts
@@ -51,6 +51,12 @@ export type RunCommandOptions = {
logStream?: Writable;
};
+export type UserOptions = {
+ User?: string;
+};
+
+// To be replaced by a runDockerContainer from backend-common
+// shared between Scaffolder and TechDocs and any other plugin.
export async function runDockerContainer({
imageName,
args,
@@ -78,6 +84,17 @@ export async function runDockerContainer({
});
});
+ const userOptions: UserOptions = {};
+ // @ts-ignore
+ if (process.getuid && process.getgid) {
+ // Files that are created inside the Docker container will be owned by
+ // root on the host system on non Mac systems, because of reasons. Mainly the fact that
+ // volume sharing is done using NFS on Mac and actual mounts in Linux world.
+ // So we set the user in the container as the same user and group id as the host.
+ // On Windows we don't have process.getuid nor process.getgid
+ userOptions.User = `${process.getuid()}:${process.getgid()}`;
+ }
+
const [{ Error: error, StatusCode: statusCode }] = await dockerClient.run(
imageName,
args,
@@ -91,6 +108,7 @@ export async function runDockerContainer({
HostConfig: {
Binds: [`${docsDir}:/content`, `${outputDir}:/result`],
},
+ ...userOptions,
...createOptions,
},
);
diff --git a/packages/techdocs-common/src/stages/publish/awsS3.test.ts b/packages/techdocs-common/src/stages/publish/awsS3.test.ts
index f8450a07a0..3d7bd337d2 100644
--- a/packages/techdocs-common/src/stages/publish/awsS3.test.ts
+++ b/packages/techdocs-common/src/stages/publish/awsS3.test.ts
@@ -13,14 +13,21 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import type { Entity, EntityName } from '@backstage/catalog-model';
+import {
+ Entity,
+ EntityName,
+ ENTITY_DEFAULT_NAMESPACE,
+} from '@backstage/catalog-model';
import { ConfigReader } from '@backstage/config';
import mockFs from 'mock-fs';
+import os from 'os';
import path from 'path';
import * as winston from 'winston';
import { AwsS3Publish } from './awsS3';
import { PublisherBase, TechDocsMetadata } from './types';
+// NOTE: /packages/techdocs-common/__mocks__ is being used to mock aws-sdk client library
+
const createMockEntity = (annotations = {}): Entity => {
return {
apiVersion: 'version',
@@ -41,13 +48,15 @@ const createMockEntityName = (): EntityName => ({
namespace: 'test-namespace',
});
+const rootDir = os.platform() === 'win32' ? 'C:\\rootDir' : '/rootDir';
+
const getEntityRootDir = (entity: Entity) => {
const {
kind,
metadata: { namespace, name },
} = entity;
- const entityRootDir = path.join(namespace as string, kind, name);
- return entityRootDir;
+
+ return path.join(rootDir, namespace || ENTITY_DEFAULT_NAMESPACE, kind, name);
};
const logger = winston.createLogger();
@@ -57,6 +66,7 @@ jest.spyOn(logger, 'error').mockReturnValue(logger);
let publisher: PublisherBase;
beforeEach(() => {
+ mockFs.restore();
const mockConfig = new ConfigReader({
techdocs: {
requestUrl: 'http://localhost:7000',
@@ -78,7 +88,7 @@ beforeEach(() => {
describe('AwsS3Publish', () => {
describe('publish', () => {
- it('should publish a directory', async () => {
+ beforeEach(() => {
const entity = createMockEntity();
const entityRootDir = getEntityRootDir(entity);
@@ -91,6 +101,15 @@ describe('AwsS3Publish', () => {
},
},
});
+ });
+
+ afterEach(() => {
+ mockFs.restore();
+ });
+
+ it('should publish a directory', async () => {
+ const entity = createMockEntity();
+ const entityRootDir = getEntityRootDir(entity);
expect(
await publisher.publish({
@@ -98,41 +117,43 @@ describe('AwsS3Publish', () => {
directory: entityRootDir,
}),
).toBeUndefined();
- mockFs.restore();
});
it('should fail to publish a directory', async () => {
+ expect.assertions(3);
const wrongPathToGeneratedDirectory = path.join(
+ rootDir,
'wrong',
'path',
'to',
'generatedDirectory',
);
- const entity = createMockEntity();
- const entityRootDir = getEntityRootDir(entity);
- mockFs({
- [entityRootDir]: {
- 'index.html': '',
- '404.html': '',
- assets: {
- 'main.css': '',
- },
- },
- });
+ const entity = createMockEntity();
+ await expect(
+ publisher.publish({
+ entity,
+ directory: wrongPathToGeneratedDirectory,
+ }),
+ ).rejects.toThrowError();
await publisher
.publish({
entity,
directory: wrongPathToGeneratedDirectory,
})
- .catch(error =>
+ .catch(error => {
expect(error.message).toEqual(
+ // Can not do exact error message match due to mockFs adding unexpected characters in the path when throwing the error
+ // Issue reported https://github.com/tschaub/mock-fs/issues/118
expect.stringContaining(
- 'Unable to upload file(s) to AWS S3. Error Failed to read template directory: ENOENT, no such file or directory',
+ `Unable to upload file(s) to AWS S3. Error: Failed to read template directory: ENOENT, no such file or directory`,
),
- ),
- );
+ );
+ expect(error.message).toEqual(
+ expect.stringContaining(wrongPathToGeneratedDirectory),
+ );
+ });
mockFs.restore();
});
});
@@ -205,12 +226,19 @@ describe('AwsS3Publish', () => {
it('should return an error if the techdocs_metadata.json file is not present', async () => {
const entityNameMock = createMockEntityName();
+ const entity = createMockEntity();
+ const entityRootDir = getEntityRootDir(entity);
await publisher
.fetchTechDocsMetadata(entityNameMock)
.catch(error =>
- expect(error.message).toEqual(
- expect.stringContaining('TechDocs metadata fetch'),
+ expect(error).toEqual(
+ new Error(
+ `TechDocs metadata fetch failed, The file ${path.join(
+ entityRootDir,
+ 'techdocs_metadata.json',
+ )} does not exist !`,
+ ),
),
);
});
diff --git a/packages/techdocs-common/src/stages/publish/awsS3.ts b/packages/techdocs-common/src/stages/publish/awsS3.ts
index 6c0cadcfae..fc45a2d5cd 100644
--- a/packages/techdocs-common/src/stages/publish/awsS3.ts
+++ b/packages/techdocs-common/src/stages/publish/awsS3.ts
@@ -15,12 +15,13 @@
*/
import { Entity, EntityName } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
-import aws from 'aws-sdk';
+import aws, { Credentials } from 'aws-sdk';
import { ManagedUpload } from 'aws-sdk/clients/s3';
import express from 'express';
import fs from 'fs-extra';
import JSON5 from 'json5';
import createLimiter from 'p-limit';
+import { CredentialsOptions } from 'aws-sdk/lib/credentials';
import path from 'path';
import { Readable } from 'stream';
import { Logger } from 'winston';
@@ -52,35 +53,49 @@ export class AwsS3Publish implements PublisherBase {
);
}
- // Credentials is an optional config. If missing, default AWS environment variables
- // or AWS shared credentials file at ~/.aws/credentials will be used to authenticate
- // https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-environment.html
- // https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-shared.html
- const credentials = config.getOptionalConfig(
+ // Credentials is an optional config. If missing, the default ways of authenticating AWS SDK V2 will be used.
+ // 1. AWS environment variables
+ // https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-environment.html
+ // 2. AWS shared credentials file at ~/.aws/credentials
+ // https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-shared.html
+ // 3. IAM Roles for EC2
+ // https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-iam.html
+ const credentialsConfig = config.getOptionalConfig(
'techdocs.publisher.awsS3.credentials',
);
let accessKeyId = undefined;
let secretAccessKey = undefined;
- if (credentials) {
- accessKeyId = credentials.getOptionalString('accessKeyId');
- secretAccessKey = credentials.getOptionalString('secretAccessKey');
+ let credentials: Credentials | CredentialsOptions | undefined = undefined;
+ if (credentialsConfig) {
+ const roleArn = credentialsConfig.getOptionalString('roleArn');
+ if (roleArn && aws.config.credentials instanceof Credentials) {
+ credentials = new aws.ChainableTemporaryCredentials({
+ masterCredentials: aws.config.credentials as Credentials,
+ params: {
+ RoleSessionName: 'backstage-aws-techdocs-s3-publisher',
+ RoleArn: roleArn,
+ },
+ });
+ } else {
+ accessKeyId = credentialsConfig.getOptionalString('accessKeyId');
+ secretAccessKey = credentialsConfig.getOptionalString(
+ 'secretAccessKey',
+ );
+ if (accessKeyId && secretAccessKey) {
+ credentials = {
+ accessKeyId,
+ secretAccessKey,
+ };
+ }
+ }
}
// AWS Region is an optional config. If missing, default AWS env variable AWS_REGION
- // or AWS shared credentials file at ~/.aws/credentials will be used. Any way, AWS SDK v3 client needs
- // to have the AWS Region information for it to work.
- // https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-region.html
+ // or AWS shared credentials file at ~/.aws/credentials will be used.
const region = config.getOptionalString('techdocs.publisher.awsS3.region');
const storageClient = new aws.S3({
- ...(credentials &&
- accessKeyId &&
- secretAccessKey && {
- credentials: {
- accessKeyId,
- secretAccessKey,
- },
- }),
+ credentials,
...(region && {
region,
}),
@@ -139,9 +154,18 @@ export class AwsS3Publish implements PublisherBase {
// Remove the absolute path prefix of the source directory
// Path of all files to upload, relative to the root of the source directory
// e.g. ['index.html', 'sub-page/index.html', 'assets/images/favicon.png']
- const relativeFilePath = filePath.replace(`${directory}/`, '');
+ const relativeFilePath = path.relative(directory, filePath);
+
+ // Convert destination file path to a POSIX path for uploading.
+ // S3 expects / as path separator and relativeFilePath will contain \\ on Windows.
+ // https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html
+ const relativeFilePathPosix = relativeFilePath
+ .split(path.sep)
+ .join(path.posix.sep);
+
+ // The / delimiter is intentional since it represents the cloud storage and not the local file system.
const entityRootDir = `${entity.metadata.namespace}/${entity.kind}/${entity.metadata.name}`;
- const destination = `${entityRootDir}/${relativeFilePath}`; // S3 Bucket file relative path
+ const destination = `${entityRootDir}/${relativeFilePathPosix}`; // S3 Bucket file relative path
const fileContent = await fs.readFile(filePath, 'utf8');
@@ -163,7 +187,7 @@ export class AwsS3Publish implements PublisherBase {
);
return;
} catch (e) {
- const errorMessage = `Unable to upload file(s) to AWS S3. Error ${e.message}`;
+ const errorMessage = `Unable to upload file(s) to AWS S3. ${e}`;
this.logger.error(errorMessage);
throw new Error(errorMessage);
}
diff --git a/packages/techdocs-common/src/stages/publish/azureBlobStorage.test.ts b/packages/techdocs-common/src/stages/publish/azureBlobStorage.test.ts
index 80f3cb0cf7..cf1ea60592 100644
--- a/packages/techdocs-common/src/stages/publish/azureBlobStorage.test.ts
+++ b/packages/techdocs-common/src/stages/publish/azureBlobStorage.test.ts
@@ -13,12 +13,16 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import mockFs from 'mock-fs';
-import { ConfigReader } from '@backstage/config';
import { getVoidLogger } from '@backstage/backend-common';
+import { Entity, ENTITY_DEFAULT_NAMESPACE } from '@backstage/catalog-model';
+import { ConfigReader } from '@backstage/config';
+import mockFs from 'mock-fs';
+import os from 'os';
+import path from 'path';
import { AzureBlobStoragePublish } from './azureBlobStorage';
import { PublisherBase } from './types';
-import type { Entity } from '@backstage/catalog-model';
+
+// NOTE: /packages/techdocs-common/__mocks__ is being used to mock Azure client library
const createMockEntity = (annotations = {}) => {
return {
@@ -34,22 +38,26 @@ const createMockEntity = (annotations = {}) => {
};
};
+const rootDir = os.platform() === 'win32' ? 'C:\\rootDir' : '/rootDir';
const getEntityRootDir = (entity: Entity) => {
const {
kind,
metadata: { namespace, name },
} = entity;
- const entityRootDir = `${namespace}/${kind}/${name}`;
- return entityRootDir;
+
+ return path.join(rootDir, namespace || ENTITY_DEFAULT_NAMESPACE, kind, name);
};
-const logger = getVoidLogger();
-jest.spyOn(logger, 'info').mockReturnValue(logger);
-jest.spyOn(logger, 'error').mockReturnValue(logger);
+function createLogger() {
+ const logger = getVoidLogger();
+ jest.spyOn(logger, 'info').mockReturnValue(logger);
+ jest.spyOn(logger, 'error').mockReturnValue(logger);
+ return logger;
+}
let publisher: PublisherBase;
-
beforeEach(async () => {
+ mockFs.restore();
const mockConfig = new ConfigReader({
techdocs: {
requestUrl: 'http://localhost:7000',
@@ -66,12 +74,15 @@ beforeEach(async () => {
},
});
- publisher = await AzureBlobStoragePublish.fromConfig(mockConfig, logger);
+ publisher = await AzureBlobStoragePublish.fromConfig(
+ mockConfig,
+ createLogger(),
+ );
});
-describe('AzureBlobStoragePublish', () => {
+describe('publishing with valid credentials', () => {
describe('publish', () => {
- it('should publish a directory', async () => {
+ beforeEach(() => {
const entity = createMockEntity();
const entityRootDir = getEntityRootDir(entity);
@@ -84,6 +95,11 @@ describe('AzureBlobStoragePublish', () => {
},
},
});
+ });
+
+ it('should publish a directory', async () => {
+ const entity = createMockEntity();
+ const entityRootDir = getEntityRootDir(entity);
expect(
await publisher.publish({
@@ -95,30 +111,33 @@ describe('AzureBlobStoragePublish', () => {
});
it('should fail to publish a directory', async () => {
- const wrongPathToGeneratedDirectory = 'wrong/path/to/generatedDirectory';
- const entity = createMockEntity();
- const entityRootDir = getEntityRootDir(entity);
+ expect.assertions(1);
+ const wrongPathToGeneratedDirectory = path.join(
+ rootDir,
+ 'wrong',
+ 'path',
+ 'to',
+ 'generatedDirectory',
+ );
- mockFs({
- [entityRootDir]: {
- 'index.html': '',
- '404.html': '',
- assets: {
- 'main.css': '',
- },
- },
- });
+ const entity = createMockEntity();
await publisher
.publish({
entity,
directory: wrongPathToGeneratedDirectory,
})
- .catch(error =>
- expect(error.message).toContain(
- 'Unable to upload file(s) to Azure Blob Storage. Error Failed to read template directory: ENOENT, no such file or directory',
- ),
- );
+ .catch(error => {
+ // Can not do exact error message match due to mockFs adding unexpected characters in the path when throwing the error
+ // Issue reported https://github.com/tschaub/mock-fs/issues/118
+ expect.stringContaining(
+ `Unable to upload file(s) to Azure Blob Storage. Error: Failed to read template directory: ENOENT, no such file or directory`,
+ );
+
+ expect(error.message).toEqual(
+ expect.stringContaining(wrongPathToGeneratedDirectory),
+ );
+ });
mockFs.restore();
});
});
@@ -145,3 +164,95 @@ describe('AzureBlobStoragePublish', () => {
});
});
});
+
+describe('error reporting', () => {
+ it('reports an error when unable to read container properties', async () => {
+ const mockConfig = new ConfigReader({
+ techdocs: {
+ requestUrl: 'http://localhost:7000',
+ publisher: {
+ type: 'azureBlobStorage',
+ azureBlobStorage: {
+ credentials: {
+ accountName: 'accountName',
+ },
+ containerName: 'bad_container',
+ },
+ },
+ },
+ });
+
+ const logger = createLogger();
+
+ let error;
+ try {
+ publisher = await AzureBlobStoragePublish.fromConfig(mockConfig, logger);
+ } catch (e) {
+ error = e;
+ }
+
+ expect(error).toBeInstanceOf(Error);
+
+ expect(logger.error).toHaveBeenCalledWith(
+ expect.stringContaining(
+ `Could not retrieve metadata about the Azure Blob Storage container bad_container.`,
+ ),
+ );
+ });
+
+ it('reports an error when bad account credentials', async () => {
+ const mockConfig = new ConfigReader({
+ techdocs: {
+ requestUrl: 'http://localhost:7000',
+ publisher: {
+ type: 'azureBlobStorage',
+ azureBlobStorage: {
+ credentials: {
+ accountName: 'failupload',
+ accountKey: 'accountKey',
+ },
+ containerName: 'containerName',
+ },
+ },
+ },
+ });
+
+ const logger = createLogger();
+
+ publisher = await AzureBlobStoragePublish.fromConfig(mockConfig, logger);
+
+ const entity = createMockEntity();
+ const entityRootDir = getEntityRootDir(entity);
+
+ mockFs({
+ [entityRootDir]: {
+ 'index.html': '',
+ },
+ });
+
+ let error;
+ try {
+ await publisher.publish({
+ entity,
+ directory: entityRootDir,
+ });
+ } catch (e) {
+ error = e;
+ }
+
+ expect(error.message).toContain(
+ `Unable to upload file(s) to Azure Blob Storage.`,
+ );
+
+ expect(logger.error).toHaveBeenCalledWith(
+ expect.stringContaining(
+ `Unable to upload file(s) to Azure Blob Storage. Error: Upload failed for ${path.join(
+ entityRootDir,
+ 'index.html',
+ )} with status code 500`,
+ ),
+ );
+
+ mockFs.restore();
+ });
+});
diff --git a/packages/techdocs-common/src/stages/publish/azureBlobStorage.ts b/packages/techdocs-common/src/stages/publish/azureBlobStorage.ts
index a02639e63f..0d2e9871bf 100644
--- a/packages/techdocs-common/src/stages/publish/azureBlobStorage.ts
+++ b/packages/techdocs-common/src/stages/publish/azureBlobStorage.ts
@@ -13,21 +13,20 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import platformPath from 'path';
-import express from 'express';
+import { DefaultAzureCredential } from '@azure/identity';
import {
BlobServiceClient,
- BlobUploadCommonResponse,
StorageSharedKeyCredential,
} from '@azure/storage-blob';
-import { DefaultAzureCredential } from '@azure/identity';
-import { Logger } from 'winston';
import { Entity, EntityName } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
-import { getHeadersForFileExtension, getFileTreeRecursively } from './helpers';
-import { PublisherBase, PublishRequest, TechDocsMetadata } from './types';
-import limiterFactory from 'p-limit';
+import express from 'express';
import JSON5 from 'json5';
+import limiterFactory from 'p-limit';
+import { default as path, default as platformPath } from 'path';
+import { Logger } from 'winston';
+import { getFileTreeRecursively, getHeadersForFileExtension } from './helpers';
+import { PublisherBase, PublishRequest, TechDocsMetadata } from './types';
// The number of batches that may be ongoing at the same time.
const BATCH_CONCURRENCY = 3;
@@ -79,25 +78,25 @@ export class AzureBlobStoragePublish implements PublisherBase {
credential,
);
- await storageClient
- .getContainerClient(containerName)
- .getProperties()
- .then(() => {
- logger.info(
- `Successfully connected to the Azure Blob Storage container ${containerName}.`,
- );
- })
- .catch(reason => {
- logger.error(
- `Could not retrieve metadata about the Azure Blob Storage container ${containerName}. ` +
- 'Make sure that the Azure project and container exist and the access key is setup correctly ' +
- 'techdocs.publisher.azureBlobStorage.credentials defined in app config has correct permissions. ' +
- 'Refer to https://backstage.io/docs/features/techdocs/using-cloud-storage',
- );
+ try {
+ const response = await storageClient
+ .getContainerClient(containerName)
+ .getProperties();
+
+ if (response._response.status >= 400) {
throw new Error(
- `from Azure Blob Storage client library: ${reason.message}`,
+ `Failed to retrieve metadata from ${response._response.request.url} with status code ${response._response.status}.`,
);
- });
+ }
+ } catch (e) {
+ logger.error(
+ `Could not retrieve metadata about the Azure Blob Storage container ${containerName}. ` +
+ 'Make sure that the Azure project and container exist and the access key is setup correctly ' +
+ 'techdocs.publisher.azureBlobStorage.credentials defined in app config has correct permissions. ' +
+ 'Refer to https://backstage.io/docs/features/techdocs/using-cloud-storage',
+ );
+ throw new Error(`from Azure Blob Storage client library: ${e.message}`);
+ }
return new AzureBlobStoragePublish(storageClient, containerName, logger);
}
@@ -122,52 +121,78 @@ export class AzureBlobStoragePublish implements PublisherBase {
// So collecting path of only the files is good enough.
const allFilesToUpload = await getFileTreeRecursively(directory);
- const uploadPromises: Array> = [];
-
// Bound the number of concurrent batches. We want a bit of concurrency for
// performance reasons, but not so much that we starve the connection pool
// or start thrashing.
const limiter = limiterFactory(BATCH_CONCURRENCY);
- const promises = allFilesToUpload.map(filePath => {
+ const promises = allFilesToUpload.map(sourceFilePath => {
// Remove the absolute path prefix of the source directory
// Path of all files to upload, relative to the root of the source directory
// e.g. ['index.html', 'sub-page/index.html', 'assets/images/favicon.png']
- const relativeFilePath = filePath.replace(`${directory}/`, '');
- const entityRootDir = `${entity.metadata.namespace}/${entity.kind}/${entity.metadata.name}`;
- const destination = platformPath.normalize(
- `${entityRootDir}/${relativeFilePath}`,
- ); // Azure Blob Storage Container file relative path
+ const relativeFilePath = path.normalize(
+ path.relative(directory, sourceFilePath),
+ );
+ // Convert destination file path to a POSIX path for uploading.
+ // Azure Blob Storage expects / as path separator and relativeFilePath will contain \\ on Windows.
+ // https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#blob-names
+ const relativeFilePathPosix = relativeFilePath
+ .split(path.sep)
+ .join(path.posix.sep);
+
+ // The / delimiter is intentional since it represents the cloud storage and not the local file system.
+ const entityRootDir = `${entity.metadata.namespace}/${entity.kind}/${entity.metadata.name}`;
+ const destination = `${entityRootDir}/${relativeFilePathPosix}`; // Azure Blob Storage Container file relative path
return limiter(async () => {
- await uploadPromises.push(
- this.storageClient
- .getContainerClient(this.containerName)
- .getBlockBlobClient(destination)
- .uploadFile(filePath),
- );
+ const response = await this.storageClient
+ .getContainerClient(this.containerName)
+ .getBlockBlobClient(destination)
+ .uploadFile(sourceFilePath);
+
+ if (response._response.status >= 400) {
+ return {
+ ...response,
+ error: new Error(
+ `Upload failed for ${sourceFilePath} with status code ${response._response.status}`,
+ ),
+ };
+ }
+ return {
+ ...response,
+ error: undefined,
+ };
});
});
- await Promise.all(promises).then(() => {
+ const responses = await Promise.all(promises);
+
+ const failed = responses.filter(r => r.error);
+ if (failed.length === 0) {
this.logger.info(
- `Successfully uploaded all the generated files for Entity ${entity.metadata.name}. Total number of files: ${allFilesToUpload.length}`,
+ `Successfully uploaded the ${responses.length} generated file(s) for Entity ${entity.metadata.name}. Total number of files: ${allFilesToUpload.length}`,
);
- });
- return;
+ } else {
+ throw new Error(
+ failed
+ .map(r => r.error?.message)
+ .filter(Boolean)
+ .join(' '),
+ );
+ }
} catch (e) {
- const errorMessage = `Unable to upload file(s) to Azure Blob Storage. Error ${e.message}`;
+ const errorMessage = `Unable to upload file(s) to Azure Blob Storage. ${e}`;
this.logger.error(errorMessage);
throw new Error(errorMessage);
}
}
- private download(containerName: string, path: string): Promise {
+ private download(containerName: string, blobPath: string): Promise {
return new Promise((resolve, reject) => {
const fileStreamChunks: Array = [];
this.storageClient
.getContainerClient(containerName)
- .getBlockBlobClient(path)
+ .getBlockBlobClient(blobPath)
.download()
.then(res => {
const body = res.readableStreamBody;
@@ -241,19 +266,11 @@ export class AzureBlobStoragePublish implements PublisherBase {
* A helper function which checks if index.html of an Entity's docs site is available. This
* can be used to verify if there are any pre-generated docs available to serve.
*/
- async hasDocsBeenGenerated(entity: Entity): Promise {
- return new Promise(resolve => {
- const entityRootDir = `${entity.metadata.namespace}/${entity.kind}/${entity.metadata.name}`;
- this.storageClient
- .getContainerClient(this.containerName)
- .getBlockBlobClient(`${entityRootDir}/index.html`)
- .exists()
- .then((response: boolean) => {
- resolve(response);
- })
- .catch(() => {
- resolve(false);
- });
- });
+ hasDocsBeenGenerated(entity: Entity): Promise {
+ const entityRootDir = `${entity.metadata.namespace}/${entity.kind}/${entity.metadata.name}`;
+ return this.storageClient
+ .getContainerClient(this.containerName)
+ .getBlockBlobClient(`${entityRootDir}/index.html`)
+ .exists();
}
}
diff --git a/packages/techdocs-common/src/stages/publish/googleStorage.test.ts b/packages/techdocs-common/src/stages/publish/googleStorage.test.ts
index f8fb00647c..10da0d476a 100644
--- a/packages/techdocs-common/src/stages/publish/googleStorage.test.ts
+++ b/packages/techdocs-common/src/stages/publish/googleStorage.test.ts
@@ -13,18 +13,28 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import mockFs from 'mock-fs';
-import * as winston from 'winston';
+import { getVoidLogger } from '@backstage/backend-common';
+import {
+ Entity,
+ EntityName,
+ ENTITY_DEFAULT_NAMESPACE,
+} from '@backstage/catalog-model';
import { ConfigReader } from '@backstage/config';
+import mockFs from 'mock-fs';
+import os from 'os';
+import path from 'path';
import { GoogleGCSPublish } from './googleStorage';
-import { PublisherBase } from './types';
+import { PublisherBase, TechDocsMetadata } from './types';
-const createMockEntity = (annotations = {}) => {
+// NOTE: /packages/techdocs-common/__mocks__ is being used to mock Google Cloud Storage client library
+
+const createMockEntity = (annotations = {}): Entity => {
return {
apiVersion: 'version',
kind: 'TestKind',
metadata: {
name: 'test-component-name',
+ namespace: 'test-namespace',
annotations: {
...annotations,
},
@@ -32,12 +42,30 @@ const createMockEntity = (annotations = {}) => {
};
};
-const logger = winston.createLogger();
+const createMockEntityName = (): EntityName => ({
+ kind: 'TestKind',
+ name: 'test-component-name',
+ namespace: 'test-namespace',
+});
+
+const rootDir = os.platform() === 'win32' ? 'C:\\rootDir' : '/rootDir';
+
+const getEntityRootDir = (entity: Entity) => {
+ const {
+ kind,
+ metadata: { namespace, name },
+ } = entity;
+
+ return path.join(rootDir, namespace || ENTITY_DEFAULT_NAMESPACE, kind, name);
+};
+
+const logger = getVoidLogger();
jest.spyOn(logger, 'info').mockReturnValue(logger);
let publisher: PublisherBase;
beforeEach(async () => {
+ mockFs.restore();
const mockConfig = new ConfigReader({
techdocs: {
requestUrl: 'http://localhost:7000',
@@ -55,24 +83,166 @@ beforeEach(async () => {
});
describe('GoogleGCSPublish', () => {
- it('should publish a directory', async () => {
- mockFs({
- '/path/to/generatedDirectory': {
- 'index.html': '',
- '404.html': '',
- assets: {
- 'main.css': '',
+ describe('publish', () => {
+ beforeEach(() => {
+ const entity = createMockEntity();
+ const entityRootDir = getEntityRootDir(entity);
+
+ mockFs({
+ [entityRootDir]: {
+ 'index.html': '',
+ '404.html': '',
+ assets: {
+ 'main.css': '',
+ },
},
- },
+ });
});
- const entity = createMockEntity();
- expect(
- await publisher.publish({
- entity,
- directory: '/path/to/generatedDirectory',
- }),
- ).toBeUndefined();
- mockFs.restore();
+ afterEach(() => {
+ mockFs.restore();
+ });
+
+ it('should publish a directory', async () => {
+ const entity = createMockEntity();
+ const entityRootDir = getEntityRootDir(entity);
+
+ expect(
+ await publisher.publish({
+ entity,
+ directory: entityRootDir,
+ }),
+ ).toBeUndefined();
+ mockFs.restore();
+ });
+
+ it('should fail to publish a directory', async () => {
+ expect.assertions(3);
+
+ const wrongPathToGeneratedDirectory = path.join(
+ rootDir,
+ 'wrong',
+ 'path',
+ 'to',
+ 'generatedDirectory',
+ );
+
+ const entity = createMockEntity();
+
+ await expect(
+ publisher.publish({
+ entity,
+ directory: wrongPathToGeneratedDirectory,
+ }),
+ ).rejects.toThrowError();
+
+ await publisher
+ .publish({
+ entity,
+ directory: wrongPathToGeneratedDirectory,
+ })
+ .catch(error => {
+ expect(error.message).toEqual(
+ // Can not do exact error message match due to mockFs adding unexpected characters in the path when throwing the error
+ // Issue reported https://github.com/tschaub/mock-fs/issues/118
+ expect.stringContaining(
+ `Unable to upload file(s) to Google Cloud Storage. Error: Failed to read template directory: ENOENT, no such file or directory`,
+ ),
+ );
+ expect(error.message).toEqual(
+ expect.stringContaining(wrongPathToGeneratedDirectory),
+ );
+ });
+
+ mockFs.restore();
+ });
+ });
+
+ describe('hasDocsBeenGenerated', () => {
+ it('should return true if docs has been generated', async () => {
+ const entity = createMockEntity();
+ const entityRootDir = getEntityRootDir(entity);
+
+ mockFs({
+ [entityRootDir]: {
+ 'index.html': 'file-content',
+ },
+ });
+
+ expect(await publisher.hasDocsBeenGenerated(entity)).toBe(true);
+ mockFs.restore();
+ });
+
+ it('should return false if docs has not been generated', async () => {
+ const entity = createMockEntity();
+
+ expect(await publisher.hasDocsBeenGenerated(entity)).toBe(false);
+ });
+ });
+
+ describe('fetchTechDocsMetadata', () => {
+ beforeEach(() => {
+ mockFs.restore();
+ });
+
+ it('should return tech docs metadata', async () => {
+ const entityNameMock = createMockEntityName();
+ const entity = createMockEntity();
+ const entityRootDir = getEntityRootDir(entity);
+
+ mockFs({
+ [entityRootDir]: {
+ 'techdocs_metadata.json':
+ '{"site_name": "backstage", "site_description": "site_content"}',
+ },
+ });
+
+ const expectedMetadata: TechDocsMetadata = {
+ site_name: 'backstage',
+ site_description: 'site_content',
+ };
+ expect(
+ await publisher.fetchTechDocsMetadata(entityNameMock),
+ ).toStrictEqual(expectedMetadata);
+ });
+
+ it('should return tech docs metadata when json encoded with single quotes', async () => {
+ const entityNameMock = createMockEntityName();
+ const entity = createMockEntity();
+ const entityRootDir = getEntityRootDir(entity);
+
+ mockFs({
+ [entityRootDir]: {
+ 'techdocs_metadata.json':
+ "{'site_name': 'backstage', 'site_description': 'site_content'}",
+ },
+ });
+
+ const expectedMetadata: TechDocsMetadata = {
+ site_name: 'backstage',
+ site_description: 'site_content',
+ };
+ expect(
+ await publisher.fetchTechDocsMetadata(entityNameMock),
+ ).toStrictEqual(expectedMetadata);
+ mockFs.restore();
+ });
+
+ it('should return an error if the techdocs_metadata.json file is not present', async () => {
+ const entityNameMock = createMockEntityName();
+ const entity = createMockEntity();
+ const entityRootDir = getEntityRootDir(entity);
+
+ await publisher
+ .fetchTechDocsMetadata(entityNameMock)
+ .catch(errorMessage =>
+ expect(errorMessage).toEqual(
+ `The file ${path.join(
+ entityRootDir,
+ 'techdocs_metadata.json',
+ )} does not exist !`,
+ ),
+ );
+ });
});
});
diff --git a/packages/techdocs-common/src/stages/publish/googleStorage.ts b/packages/techdocs-common/src/stages/publish/googleStorage.ts
index 8876007504..12ecf45b2d 100644
--- a/packages/techdocs-common/src/stages/publish/googleStorage.ts
+++ b/packages/techdocs-common/src/stages/publish/googleStorage.ts
@@ -13,20 +13,20 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import path from 'path';
-import express from 'express';
-import {
- Storage,
- UploadResponse,
- FileExistsResponse,
-} from '@google-cloud/storage';
-import { Logger } from 'winston';
import { Entity, EntityName } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
-import { getHeadersForFileExtension, getFileTreeRecursively } from './helpers';
-import { PublisherBase, PublishRequest, TechDocsMetadata } from './types';
+import {
+ FileExistsResponse,
+ Storage,
+ UploadResponse,
+} from '@google-cloud/storage';
+import express from 'express';
import JSON5 from 'json5';
import createLimiter from 'p-limit';
+import path from 'path';
+import { Logger } from 'winston';
+import { getFileTreeRecursively, getHeadersForFileExtension } from './helpers';
+import { PublisherBase, PublishRequest, TechDocsMetadata } from './types';
export class GoogleGCSPublish implements PublisherBase {
static async fromConfig(
@@ -97,44 +97,50 @@ export class GoogleGCSPublish implements PublisherBase {
* Upload all the files from the generated `directory` to the GCS bucket.
* Directory structure used in the bucket is - entityNamespace/entityKind/entityName/index.html
*/
- publish({ entity, directory }: PublishRequest): Promise {
- return new Promise(async (resolve, reject) => {
+ async publish({ entity, directory }: PublishRequest): Promise {
+ try {
// Note: GCS manages creation of parent directories if they do not exist.
// So collecting path of only the files is good enough.
const allFilesToUpload = await getFileTreeRecursively(directory);
const limiter = createLimiter(10);
const uploadPromises: Array> = [];
- allFilesToUpload.forEach(filePath => {
+ allFilesToUpload.forEach(sourceFilePath => {
// Remove the absolute path prefix of the source directory
// Path of all files to upload, relative to the root of the source directory
// e.g. ['index.html', 'sub-page/index.html', 'assets/images/favicon.png']
- const relativeFilePath = filePath.replace(`${directory}/`, '');
+ const relativeFilePath = path.relative(directory, sourceFilePath);
+
+ // Convert destination file path to a POSIX path for uploading.
+ // GCS expects / as path separator and relativeFilePath will contain \\ on Windows.
+ // https://cloud.google.com/storage/docs/gsutil/addlhelp/HowSubdirectoriesWork
+ const relativeFilePathPosix = relativeFilePath
+ .split(path.sep)
+ .join(path.posix.sep);
+
+ // The / delimiter is intentional since it represents the cloud storage and not the local file system.
const entityRootDir = `${entity.metadata.namespace}/${entity.kind}/${entity.metadata.name}`;
- const destination = `${entityRootDir}/${relativeFilePath}`; // GCS Bucket file relative path
+ const destination = `${entityRootDir}/${relativeFilePathPosix}`; // GCS Bucket file relative path
// Rate limit the concurrent execution of file uploads to batches of 10 (per publish)
const uploadFile = limiter(() =>
- this.storageClient
- .bucket(this.bucketName)
- .upload(filePath, { destination }),
+ this.storageClient.bucket(this.bucketName).upload(sourceFilePath, {
+ destination,
+ }),
);
uploadPromises.push(uploadFile);
});
- Promise.all(uploadPromises)
- .then(() => {
- this.logger.info(
- `Successfully uploaded all the generated files for Entity ${entity.metadata.name}. Total number of files: ${allFilesToUpload.length}`,
- );
- resolve(undefined);
- })
- .catch((err: Error) => {
- const errorMessage = `Unable to upload file(s) to Google Cloud Storage. Error ${err.message}`;
- this.logger.error(errorMessage);
- reject(errorMessage);
- });
- });
+ await Promise.all(uploadPromises);
+
+ this.logger.info(
+ `Successfully uploaded all the generated files for Entity ${entity.metadata.name}. Total number of files: ${allFilesToUpload.length}`,
+ );
+ } catch (e) {
+ const errorMessage = `Unable to upload file(s) to Google Cloud Storage. ${e}`;
+ this.logger.error(errorMessage);
+ throw new Error(errorMessage);
+ }
}
fetchTechDocsMetadata(entityName: EntityName): Promise {
@@ -154,9 +160,9 @@ export class GoogleGCSPublish implements PublisherBase {
fileStreamChunks.push(chunk);
})
.on('end', () => {
- const techdocsMetadataJson = Buffer.concat(
- fileStreamChunks,
- ).toString();
+ const techdocsMetadataJson = Buffer.concat(fileStreamChunks).toString(
+ 'utf-8',
+ );
resolve(JSON5.parse(techdocsMetadataJson));
});
});
diff --git a/packages/test-utils/CHANGELOG.md b/packages/test-utils/CHANGELOG.md
index a30b2b3f6a..50f656ec67 100644
--- a/packages/test-utils/CHANGELOG.md
+++ b/packages/test-utils/CHANGELOG.md
@@ -1,5 +1,16 @@
# @backstage/test-utils
+## 0.1.8
+
+### Patch Changes
+
+- dc12852c9: Allow `ExternalRouteRef` instances to be passed as a route ref to `mountedRoutes`.
+- Updated dependencies [3a58084b6]
+- Updated dependencies [1407b34c6]
+- Updated dependencies [b6c4f485d]
+- Updated dependencies [3a58084b6]
+ - @backstage/core-api@0.2.11
+
## 0.1.7
### Patch Changes
diff --git a/packages/test-utils/package.json b/packages/test-utils/package.json
index 5a4ad2b4a4..fbbd4f9eca 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": "0.1.7",
+ "version": "0.1.8",
"private": false,
"publishConfig": {
"access": "public",
@@ -29,7 +29,7 @@
"clean": "backstage-cli clean"
},
"dependencies": {
- "@backstage/core-api": "^0.2.7",
+ "@backstage/core-api": "^0.2.11",
"@backstage/test-utils-core": "^0.1.1",
"@backstage/theme": "^0.2.3",
"@material-ui/core": "^4.11.0",
@@ -45,7 +45,7 @@
"zen-observable": "^0.8.15"
},
"devDependencies": {
- "@backstage/cli": "^0.6.0",
+ "@backstage/cli": "^0.6.2",
"@types/jest": "^26.0.7",
"@types/node": "^12.0.0"
},
diff --git a/packages/test-utils/src/testUtils/appWrappers.tsx b/packages/test-utils/src/testUtils/appWrappers.tsx
index cc67a5b707..05cd0b8fd4 100644
--- a/packages/test-utils/src/testUtils/appWrappers.tsx
+++ b/packages/test-utils/src/testUtils/appWrappers.tsx
@@ -22,8 +22,8 @@ import privateExports, {
defaultSystemIcons,
BootErrorPageProps,
RouteRef,
- createPlugin,
- createRoutableExtension,
+ ExternalRouteRef,
+ attachComponentData,
} from '@backstage/core-api';
import { RenderResult } from '@testing-library/react';
import { renderWithEffects } from '@backstage/test-utils-core';
@@ -62,7 +62,7 @@ type TestAppOptions = {
* // ...
* const link = useRouteRef(myRouteRef)
*/
- mountedRoutes?: { [path: string]: RouteRef };
+ mountedRoutes?: { [path: string]: RouteRef | ExternalRouteRef };
};
/**
@@ -109,16 +109,10 @@ export function wrapInTestApp(
Wrapper = () => Component as React.ReactElement;
}
- const routePlugin = createPlugin({ id: 'mock-route-plugin' });
const routeElements = Object.entries(options.mountedRoutes ?? {}).map(
([path, routeRef]) => {
- const PageComponent = () => [] = [
{
title: 'Description',
field: 'entity.metadata.description',
+ render: ({ entity }) => (
+ [] = [
+ EntityTable.columns.createEntityRefColumn({ defaultKind: 'API' }),
+ EntityTable.columns.createOwnerColumn(),
+ EntityTable.columns.createSpecLifecycleColumn(),
+ createSpecApiTypeColumn(),
+ EntityTable.columns.createMetadataDescriptionColumn(),
+];
+
export const HasApisCard = ({ variant = 'gridItem' }: Props) => {
const { entity } = useEntity();
const { entities, loading, error } = useRelatedEntities(entity, {
@@ -73,7 +82,7 @@ export const HasApisCard = ({ variant = 'gridItem' }: Props) => {
}
- columns={apiEntityColumns}
+ columns={columns}
entities={entities as ApiEntity[]}
/>
);
diff --git a/plugins/app-backend/CHANGELOG.md b/plugins/app-backend/CHANGELOG.md
index f39dad2eb9..06ec3e150f 100644
--- a/plugins/app-backend/CHANGELOG.md
+++ b/plugins/app-backend/CHANGELOG.md
@@ -1,5 +1,13 @@
# @backstage/plugin-app-backend
+## 0.3.8
+
+### Patch Changes
+
+- 1c06cb312: Clarify troubleshooting steps for schema serialization issues.
+- Updated dependencies [a1f5e6545]
+ - @backstage/config@0.1.3
+
## 0.3.7
### Patch Changes
diff --git a/plugins/app-backend/package.json b/plugins/app-backend/package.json
index 52ebab520d..af5a1e2f3d 100644
--- a/plugins/app-backend/package.json
+++ b/plugins/app-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-app-backend",
- "version": "0.3.7",
+ "version": "0.3.8",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -31,7 +31,7 @@
"dependencies": {
"@backstage/backend-common": "^0.5.3",
"@backstage/config-loader": "^0.5.1",
- "@backstage/config": "^0.1.2",
+ "@backstage/config": "^0.1.3",
"@types/express": "^4.17.6",
"express": "^4.17.1",
"express-promise-router": "^3.0.3",
@@ -40,7 +40,7 @@
"yn": "^4.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.6.0",
+ "@backstage/cli": "^0.6.2",
"@types/supertest": "^2.0.8",
"msw": "^0.20.5",
"supertest": "^4.0.2"
diff --git a/plugins/app-backend/src/lib/config.ts b/plugins/app-backend/src/lib/config.ts
index 0607956894..4fe383414f 100644
--- a/plugins/app-backend/src/lib/config.ts
+++ b/plugins/app-backend/src/lib/config.ts
@@ -95,8 +95,9 @@ export async function readConfigs(options: ReadOptions): PromiseMounted at {path}
;
- const Page = routePlugin.provide(
- createRoutableExtension({
- component: async () => PageComponent,
- mountPoint: routeRef,
- }),
- );
+ const Page = () => Mounted at {path}
;
+ attachComponentData(Page, 'core.mountPoint', routeRef);
return