feat: update Backstage from 1.18.4 to 1.20.3 (#195)

.dockerignore

@@ -4,5 +4,4 @@ node_modules
 packages/*/node_modules
 plugins
 *.local.yaml
-trivy-results.sarif
-vuln.json
+trivy.*

.eslintignore

@@ -0,0 +1 @@
+playwright.config.ts

.github/workflows/release.yaml

@@ -8,12 +8,12 @@ on:
 
 jobs:
   release-container:
-    uses: radiorabe/actions/.github/workflows/release-container.yaml@v0.18.0
+    uses: radiorabe/actions/.github/workflows/release-container.yaml@v0.20.2
     with:
       image: 'ghcr.io/radiorabe/backstage'
       name: 'backstage'
       display-name: 'RaBe Backstage'
       tags: 'minimal rhel9 rabe backstage'
       cosign-base-image-only: true
   mkdocs:
-    uses: radiorabe/actions/.github/workflows/release-mkdocs.yaml@v0.18.0
+    uses: radiorabe/actions/.github/workflows/release-mkdocs.yaml@v0.20.2

.github/workflows/schedule.yaml

@@ -7,6 +7,6 @@ on:
 
 jobs:
   call-workflow:
-    uses: radiorabe/actions/.github/workflows/schedule-trivy.yaml@v0.18.0
+    uses: radiorabe/actions/.github/workflows/schedule-trivy.yaml@v0.20.2
     with:
       image-ref: 'ghcr.io/radiorabe/backstage:latest'

.github/workflows/semantic-release.yaml

@@ -8,6 +8,6 @@ on:
 
 jobs:
   semantic-release:
-    uses: radiorabe/actions/.github/workflows/semantic-release.yaml@v0.18.0
+    uses: radiorabe/actions/.github/workflows/semantic-release.yaml@v0.20.2
     secrets:
       RABE_ITREAKTION_GITHUB_TOKEN: ${{ secrets.RABE_ITREAKTION_GITHUB_TOKEN }}

.github/workflows/test.yaml

@@ -5,7 +5,7 @@ on:
 
 jobs:
   pre-commit:
-    uses: radiorabe/actions/.github/workflows/test-pre-commit.yaml@v0.18.0
+    uses: radiorabe/actions/.github/workflows/test-pre-commit.yaml@v0.20.2
   test-yarn:
     runs-on: ubuntu-latest
     permissions:
@@ -22,19 +22,13 @@ jobs:
       id-token: none
     strategy:
       matrix:
-        node-version: [18]
+        node-version: [18, 20]
     steps:
     - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'yarn'
-    - run: yarn install --frozen-lockfile
+    - run: yarn install --frozen-lockfile --ignore-engines
     - run: yarn test
-    - run: yarn --cwd packages/app/ test:e2e:ci
-    - uses: actions/upload-artifact@v3
-      with:
-        name: cypress-videos
-        path: packages/app/cypress/videos/
-        retention-days: 7

.gitignore

@@ -50,6 +50,9 @@ site
 # vscode database functionality support files
 *.session.sql
 
+# E2E test reports
+e2e-test-report/
+
 # Python
 venv/
 

Dockerfile

@@ -31,7 +31,7 @@ RUN yarn tsc
 RUN yarn build:backend
 
 # Stage 3 - Build the actual backend image and install production dependencies
-FROM ghcr.io/radiorabe/ubi9-minimal:0.5.1
+FROM ghcr.io/radiorabe/ubi9-minimal:0.6.1
 
 ENV APP_ROOT=/opt/app-root \
     # The $HOME is not set by default, but some applications need this variable

backstage.json

@@ -1,3 +1,3 @@
 {
-  "version": "1.18.4"
+  "version": "1.20.3"
 }

lerna.json

@@ -1,6 +1,6 @@
 {
   "packages": ["packages/*", "plugins/*"],
   "npmClient": "yarn",
-  "useWorkspaces": true,
-  "version": "0.1.0"
+  "version": "0.1.0",
+  "$schema": "node_modules/lerna/schemas/lerna-schema.json"
 }

package.json

@@ -3,7 +3,7 @@
   "version": "1.0.0",
   "private": true,
   "engines": {
-    "node": "16 || 18"
+    "node": "18 || 20"
   },
   "scripts": {
     "dev": "concurrently \"yarn start\" \"yarn start-backend\"",
@@ -29,10 +29,12 @@
     ]
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.13",
+    "@backstage/cli": "^0.24.0",
+    "@backstage/e2e-test-utils": "^0.1.0",
+    "@playwright/test": "^1.32.3",
     "@spotify/prettier-config": "^15.0.0",
     "concurrently": "^8.2.0",
-    "lerna": "^7.0.2",
+    "lerna": "^7.3.0",
     "node-gyp": "^9.0.0",
     "prettier": "^2.3.2",
     "typescript": "~5.2.2"

packages/app/e2e-tests/app.test.ts

@@ -0,0 +1,20 @@
+/*
+ * 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 { test, expect } from '@playwright/test';
+test('App should render the welcome page', async ({ page }) => {
+  await page.goto('/');
+  await expect(page.getByText('My Company Catalog')).toBeVisible();
+});

packages/app/package.json

@@ -11,47 +11,43 @@
     "build": "backstage-cli package build",
     "clean": "backstage-cli package clean",
     "test": "backstage-cli package test",
-    "lint": "backstage-cli package lint",
-    "test:e2e": "cross-env PORT=3000 start-server-and-test start http://localhost:3000 cy:dev",
-    "test:e2e:ci": "cross-env PORT=3000 start-server-and-test start http://localhost:3000 cy:run",
-    "cy:dev": "cypress open",
-    "cy:run": "cypress run --browser electron"
+    "lint": "backstage-cli package lint"
   },
   "dependencies": {
-    "@backstage/app-defaults": "^1.4.3",
-    "@backstage/catalog-model": "^1.4.2",
-    "@backstage/cli": "^0.22.13",
-    "@backstage/core-app-api": "^1.10.0",
-    "@backstage/core-components": "^0.13.5",
-    "@backstage/core-plugin-api": "^1.6.0",
-    "@backstage/integration-react": "^1.1.19",
-    "@backstage/plugin-api-docs": "^0.9.11",
-    "@backstage/plugin-catalog": "^1.13.0",
-    "@backstage/plugin-catalog-common": "^1.0.16",
-    "@backstage/plugin-catalog-graph": "^0.2.36",
-    "@backstage/plugin-catalog-import": "^0.10.0",
-    "@backstage/plugin-catalog-react": "^1.8.4",
-    "@backstage/plugin-catalog-unprocessed-entities": "^0.1.3",
-    "@backstage/plugin-devtools": "^0.1.4",
-    "@backstage/plugin-devtools-common": "^0.1.4",
-    "@backstage/plugin-github-actions": "^0.6.5",
-    "@backstage/plugin-github-pull-requests-board": "^0.1.18",
-    "@backstage/plugin-home": "^0.5.8",
-    "@backstage/plugin-org": "^0.6.14",
-    "@backstage/plugin-permission-react": "^0.4.15",
-    "@backstage/plugin-scaffolder": "^1.15.0",
-    "@backstage/plugin-search": "^1.4.0",
-    "@backstage/plugin-search-react": "^1.7.0",
-    "@backstage/plugin-tech-insights": "^0.3.16",
-    "@backstage/plugin-tech-radar": "^0.6.8",
-    "@backstage/plugin-techdocs": "^1.7.0",
-    "@backstage/plugin-techdocs-module-addons-contrib": "^1.1.0",
-    "@backstage/plugin-techdocs-react": "^1.1.11",
-    "@backstage/plugin-user-settings": "^0.7.10",
-    "@backstage/theme": "^0.4.2",
+    "@backstage/app-defaults": "^1.4.5",
+    "@backstage/catalog-model": "^1.4.3",
+    "@backstage/cli": "^0.24.0",
+    "@backstage/core-app-api": "^1.11.1",
+    "@backstage/core-components": "^0.13.8",
+    "@backstage/core-plugin-api": "^1.8.0",
+    "@backstage/integration-react": "^1.1.21",
+    "@backstage/plugin-api-docs": "^0.10.1",
+    "@backstage/plugin-catalog": "^1.15.1",
+    "@backstage/plugin-catalog-common": "^1.0.18",
+    "@backstage/plugin-catalog-graph": "^0.3.1",
+    "@backstage/plugin-catalog-import": "^0.10.3",
+    "@backstage/plugin-catalog-react": "^1.9.1",
+    "@backstage/plugin-catalog-unprocessed-entities": "^0.1.5",
+    "@backstage/plugin-devtools": "^0.1.6",
+    "@backstage/plugin-devtools-common": "^0.1.6",
+    "@backstage/plugin-github-actions": "^0.6.8",
+    "@backstage/plugin-github-pull-requests-board": "^0.1.21",
+    "@backstage/plugin-home": "^0.5.11",
+    "@backstage/plugin-org": "^0.6.17",
+    "@backstage/plugin-permission-react": "^0.4.17",
+    "@backstage/plugin-scaffolder": "^1.16.1",
+    "@backstage/plugin-search": "^1.4.3",
+    "@backstage/plugin-search-react": "^1.7.3",
+    "@backstage/plugin-tech-insights": "^0.3.19",
+    "@backstage/plugin-tech-radar": "^0.6.10",
+    "@backstage/plugin-techdocs": "^1.9.1",
+    "@backstage/plugin-techdocs-module-addons-contrib": "^1.1.2",
+    "@backstage/plugin-techdocs-react": "^1.1.13",
+    "@backstage/plugin-user-settings": "^0.7.13",
+    "@backstage/theme": "^0.4.4",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
-    "@roadiehq/backstage-plugin-github-insights": "^2.3.21",
+    "@roadiehq/backstage-plugin-github-insights": "^2.3.23",
     "history": "^5.0.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
@@ -60,17 +56,15 @@
     "react-use": "^17.2.4"
   },
   "devDependencies": {
-    "@backstage/test-utils": "^1.4.3",
+    "@backstage/test-utils": "^1.4.5",
+    "@playwright/test": "^1.32.3",
     "@testing-library/dom": "^9.3.1",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^14.0.0",
     "@testing-library/user-event": "^14.4.3",
     "@types/node": "^20.3.1",
     "@types/react-dom": "^18.2.5",
-    "cross-env": "^7.0.0",
-    "cypress": "^12.5.1",
-    "eslint-plugin-cypress": "^2.10.3",
-    "start-server-and-test": "^2.0.0"
+    "cross-env": "^7.0.0"
   },
   "browserslist": {
     "production": [

packages/app/public/index.html

@@ -8,7 +8,6 @@
       name="description"
       content="Backstage is an open platform for building developer portals"
     />
-    <link rel="apple-touch-icon" href="<%= publicPath %>/logo192.png" />
     <!--
       manifest.json provides metadata used when your web app is installed on a
       user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/

packages/backend/package.json

@@ -16,41 +16,45 @@
     "build-image": "docker build ../.. -f ../../Dockerfile --tag backstage"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.19.7",
-    "@backstage/backend-tasks": "^0.5.10",
-    "@backstage/catalog-client": "^1.4.4",
-    "@backstage/catalog-model": "^1.4.2",
-    "@backstage/config": "^1.1.0",
-    "@backstage/plugin-app-backend": "^0.3.53",
-    "@backstage/plugin-auth-backend": "^0.19.2",
-    "@backstage/plugin-auth-node": "^0.3.2",
-    "@backstage/plugin-catalog-backend": "^1.13.3",
-    "@backstage/plugin-catalog-backend-module-github": "^0.4.3",
-    "@backstage/plugin-catalog-backend-module-unprocessed": "^0.3.2",
-    "@backstage/plugin-devtools-backend": "^0.2.2",
-    "@backstage/plugin-permission-backend": "^0.5.28",
-    "@backstage/plugin-permission-common": "^0.7.8",
-    "@backstage/plugin-permission-node": "^0.7.16",
-    "@backstage/plugin-proxy-backend": "^0.4.2",
-    "@backstage/plugin-scaffolder-backend": "^1.17.3",
-    "@backstage/plugin-search-backend": "^1.4.5",
-    "@backstage/plugin-search-backend-module-pg": "^0.5.14",
-    "@backstage/plugin-search-backend-node": "^1.2.9",
-    "@backstage/plugin-tech-insights-backend": "^0.5.19",
-    "@backstage/plugin-tech-insights-backend-module-jsonfc": "^0.1.37",
-    "@backstage/plugin-techdocs-backend": "^1.7.2",
-    "@janus-idp/backstage-plugin-keycloak-backend": "^1.5.5",
-    "@roadiehq/scaffolder-backend-module-http-request": "^4.0.13",
+    "@backstage/backend-common": "^0.19.9",
+    "@backstage/backend-tasks": "^0.5.12",
+    "@backstage/catalog-client": "^1.4.6",
+    "@backstage/catalog-model": "^1.4.3",
+    "@backstage/config": "^1.1.1",
+    "@backstage/plugin-app-backend": "^0.3.55",
+    "@backstage/plugin-auth-backend": "^0.20.0",
+    "@backstage/plugin-auth-node": "^0.4.1",
+    "@backstage/plugin-catalog-backend": "^1.15.0",
+    "@backstage/plugin-catalog-backend-module-github": "^0.4.5",
+    "@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "^0.1.4",
+    "@backstage/plugin-catalog-backend-module-unprocessed": "^0.3.4",
+    "@backstage/plugin-devtools-backend": "^0.2.4",
+    "@backstage/plugin-permission-backend": "^0.5.30",
+    "@backstage/plugin-permission-common": "^0.7.10",
+    "@backstage/plugin-permission-node": "^0.7.18",
+    "@backstage/plugin-proxy-backend": "^0.4.5",
+    "@backstage/plugin-scaffolder-backend": "^1.19.1",
+    "@backstage/plugin-search-backend": "^1.4.7",
+    "@backstage/plugin-search-backend-module-catalog": "^0.1.11",
+    "@backstage/plugin-search-backend-module-pg": "^0.5.16",
+    "@backstage/plugin-search-backend-module-techdocs": "^0.1.11",
+    "@backstage/plugin-search-backend-node": "^1.2.11",
+    "@backstage/plugin-tech-insights-backend": "^0.5.21",
+    "@backstage/plugin-tech-insights-backend-module-jsonfc": "^0.1.39",
+    "@backstage/plugin-techdocs-backend": "^1.9.0",
+    "@janus-idp/backstage-plugin-keycloak-backend": "^1.7.10",
+    "@roadiehq/scaffolder-backend-module-http-request": "^4.1.1",
     "app": "link:../app",
-    "better-sqlite3": "^8.0.0",
+    "better-sqlite3": "^9.0.0",
     "dockerode": "^3.3.1",
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0",
-    "pg": "^8.3.0",
+    "node-gyp": "^9.0.0",
+    "pg": "^8.11.3",
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.13",
+    "@backstage/cli": "^0.24.0",
     "@types/dockerode": "^3.3.19",
     "@types/express": "^4.17.17",
     "@types/express-serve-static-core": "^4.17.35",

packages/backend/src/plugins/catalog.ts

@@ -1,5 +1,5 @@
 import { CatalogBuilder } from '@backstage/plugin-catalog-backend';
-import { ScaffolderEntitiesProcessor } from '@backstage/plugin-scaffolder-backend';
+import { ScaffolderEntitiesProcessor } from '@backstage/plugin-catalog-backend-module-scaffolder-entity-model';
 import { UnprocessedEntitiesModule } from '@backstage/plugin-catalog-backend-module-unprocessed';
 import { Router } from 'express';
 import { PluginEnvironment } from '../types';