feat: add dynamic-plugins-info backend plugin

.changeset/purple-cougars-fry.md

@@ -0,0 +1,8 @@
+---
+'@internal/plugin-dynamic-plugins-info-backend': patch
+'backend': patch
+---
+
+Adds a 'dynamic-plugins-info' backend plugin
+
+This plugin depends on the `backend-plugin-manager` and lists all the dynamic plugins installed in the dynamic plugins root folder.

.dockerignore

@@ -4,6 +4,7 @@
 **/node_modules
 plugins
 !plugins/scalprum-backend
+!plugins/dynamic-plugins-info-backend
 *.local.yaml
 coverage
 dist-types

docker/Dockerfile

@@ -51,6 +51,7 @@ COPY $EXTERNAL_SOURCE_NESTED/package.json $EXTERNAL_SOURCE_NESTED/yarn.lock ./
 COPY $EXTERNAL_SOURCE_NESTED/packages/app/package.json ./packages/app/package.json
 COPY $EXTERNAL_SOURCE_NESTED/packages/backend/package.json ./packages/backend/package.json
 COPY $EXTERNAL_SOURCE_NESTED/plugins/scalprum-backend/package.json ./plugins/scalprum-backend/package.json
+COPY $EXTERNAL_SOURCE_NESTED/plugins/dynamic-plugins-info-backend/package.json ./plugins/dynamic-plugins-info-backend/package.json
 
 RUN $YARN install --frozen-lockfile --network-timeout 600000
 
@@ -75,13 +76,13 @@ FROM skeleton AS cleanup
 
 # Upstream only - copy the install dependencies from the build stage and context
 COPY --from=build $CONTAINER_SOURCE/yarn.lock \
-     $CONTAINER_SOURCE/package.json \
-     $CONTAINER_SOURCE/packages/backend/dist/skeleton.tar.gz \
-     $CONTAINER_SOURCE/packages/backend/dist/bundle.tar.gz \
-     ./
+  $CONTAINER_SOURCE/package.json \
+  $CONTAINER_SOURCE/packages/backend/dist/skeleton.tar.gz \
+  $CONTAINER_SOURCE/packages/backend/dist/bundle.tar.gz \
+  ./
 ENV TARBALL_PATH=.
 RUN tar xzf $TARBALL_PATH/skeleton.tar.gz; tar xzf $TARBALL_PATH/bundle.tar.gz; \
-    rm -f $TARBALL_PATH/skeleton.tar.gz $TARBALL_PATH/bundle.tar.gz
+  rm -f $TARBALL_PATH/skeleton.tar.gz $TARBALL_PATH/bundle.tar.gz
 
 # Copy app-config files needed in runtime
 # Upstream only

docker/brew.Dockerfile

@@ -51,6 +51,7 @@ COPY $EXTERNAL_SOURCE_NESTED/package.json $EXTERNAL_SOURCE_NESTED/yarn.lock ./
 COPY $EXTERNAL_SOURCE_NESTED/packages/app/package.json ./packages/app/package.json
 COPY $EXTERNAL_SOURCE_NESTED/packages/backend/package.json ./packages/backend/package.json
 COPY $EXTERNAL_SOURCE_NESTED/plugins/scalprum-backend/package.json ./plugins/scalprum-backend/package.json
+COPY $EXTERNAL_SOURCE_NESTED/plugins/dynamic-plugins-info-backend/package.json ./plugins/dynamic-plugins-info-backend/package.json
 
 # Downstream only - debugging
 # COPY $REMOTE_SOURCES/ ./
@@ -64,9 +65,9 @@ COPY $EXTERNAL_SOURCE_NESTED/plugins/scalprum-backend/package.json ./plugins/sca
 # Downstream only - Cachito configuration
 # see https://docs.engineering.redhat.com/pages/viewpage.action?pageId=228017926#UpstreamSources(Cachito,ContainerFirst)-CachitoIntegrationfornpm
 COPY $REMOTE_SOURCES/upstream1/cachito.env \
-     $REMOTE_SOURCES/upstream1/app/registry-ca.pem \
-     $REMOTE_SOURCES/upstream1/app/distgit/containers/rhdh-hub/.npmrc \
-     ./
+  $REMOTE_SOURCES/upstream1/app/registry-ca.pem \
+  $REMOTE_SOURCES/upstream1/app/distgit/containers/rhdh-hub/.npmrc \
+  ./
 # registry=https://cachito-nexus.engineering.redhat.com/repository/cachito-yarn-914335/
 # email=noreply@domain.local
 # always-auth=true
@@ -77,24 +78,24 @@ COPY $REMOTE_SOURCES/upstream1/cachito.env \
 # cafile="../../../registry-ca.pem"
 # hadolint ignore=SC1091
 RUN \
-    # debug
-    # ls -l $CONTAINER_SOURCE/cachito.env; \
-    # load envs
-    source $CONTAINER_SOURCE/cachito.env; \
-    \
-    # load cert
-    cert_path=$CONTAINER_SOURCE/registry-ca.pem; \
-    # debug
-    # ls -la "${cert_path}"; \
-    npm config set cafile "${cert_path}"; $YARN config set cafile "${cert_path}" -g; \
-    \
-    # debug
-    # ls -l /usr/; \
-    # set up node dir with common.gypi and unsafe-perms=true
-    ln -s /usr/include/node/common.gypi /usr/common.gypi; $YARN config set nodedir /usr; $YARN config set unsafe-perm true
-    # debug
-    # cat $CONTAINER_SOURCE/.npmrc || true; \
-    # $YARN config list --verbose; npm config list; npm config list -l
+  # debug
+  # ls -l $CONTAINER_SOURCE/cachito.env; \
+  # load envs
+  source $CONTAINER_SOURCE/cachito.env; \
+  \
+  # load cert
+  cert_path=$CONTAINER_SOURCE/registry-ca.pem; \
+  # debug
+  # ls -la "${cert_path}"; \
+  npm config set cafile "${cert_path}"; $YARN config set cafile "${cert_path}" -g; \
+  \
+  # debug
+  # ls -l /usr/; \
+  # set up node dir with common.gypi and unsafe-perms=true
+  ln -s /usr/include/node/common.gypi /usr/common.gypi; $YARN config set nodedir /usr; $YARN config set unsafe-perm true
+# debug
+# cat $CONTAINER_SOURCE/.npmrc || true; \
+# $YARN config list --verbose; npm config list; npm config list -l
 
 RUN $YARN install --frozen-lockfile --network-timeout 600000
 
@@ -122,7 +123,7 @@ RUN find dynamic-plugins -type f -not -name 'dist' -delete
 # RUN ls -l $CONTAINER_SOURCE/ $CONTAINER_SOURCE/packages/backend/dist/
 ENV TARBALL_PATH=./packages/backend/dist
 RUN tar xzf $TARBALL_PATH/skeleton.tar.gz; tar xzf $TARBALL_PATH/bundle.tar.gz; \
-    rm -f $TARBALL_PATH/skeleton.tar.gz $TARBALL_PATH/bundle.tar.gz
+  rm -f $TARBALL_PATH/skeleton.tar.gz $TARBALL_PATH/bundle.tar.gz
 
 # Copy app-config files needed in runtime
 # Upstream only
@@ -148,24 +149,24 @@ WORKDIR $CONTAINER_SOURCE/
 # Downstream only - install techdocs dependencies using cachito sources
 COPY $REMOTE_SOURCES/upstream2 ./upstream2/
 RUN microdnf update -y && \
-    microdnf install -y python3.11 python3.11-pip python3.11-devel make cmake cpp gcc gcc-c++; \
-    ln -s /usr/bin/pip3.11 /usr/bin/pip3; \
-    ln -s /usr/bin/pip3.11 /usr/bin/pip; \
-    # ls -la $CONTAINER_SOURCE/ $CONTAINER_SOURCE/upstream2/ $CONTAINER_SOURCE/upstream2/app/distgit/containers/rhdh-hub/docker/ || true; \
-    cat $CONTAINER_SOURCE/upstream2/cachito.env && \
-    # cachito.env contains path to cert:
-    # export PIP_CERT=/remote-source/upstream2/app/package-index-ca.pem
-    source $CONTAINER_SOURCE/upstream2/cachito.env && \
-    # fix ownership for pip install folder
-    mkdir -p /opt/app-root/src/.cache/pip && chown -R root:root /opt/app-root && \
-    # ls -ld /opt/ /opt/app-root /opt/app-root/src/ /opt/app-root/src/.cache /opt/app-root/src/.cache/pip || true; \
-    pushd $CONTAINER_SOURCE/upstream2/app/distgit/containers/rhdh-hub/docker/ >/dev/null && \
-        set -xe; \
-        python3.11 -V; pip3.11 -V; \
-        pip3.11 install --user --no-cache-dir --upgrade pip setuptools pyyaml; \
-        pip3.11 install --user --no-cache-dir -r requirements.txt -r requirements-build.txt; \
-    popd >/dev/null; \
-    microdnf clean all; rm -fr $CONTAINER_SOURCE/upstream2
+  microdnf install -y python3.11 python3.11-pip python3.11-devel make cmake cpp gcc gcc-c++; \
+  ln -s /usr/bin/pip3.11 /usr/bin/pip3; \
+  ln -s /usr/bin/pip3.11 /usr/bin/pip; \
+  # ls -la $CONTAINER_SOURCE/ $CONTAINER_SOURCE/upstream2/ $CONTAINER_SOURCE/upstream2/app/distgit/containers/rhdh-hub/docker/ || true; \
+  cat $CONTAINER_SOURCE/upstream2/cachito.env && \
+  # cachito.env contains path to cert:
+  # export PIP_CERT=/remote-source/upstream2/app/package-index-ca.pem
+  source $CONTAINER_SOURCE/upstream2/cachito.env && \
+  # fix ownership for pip install folder
+  mkdir -p /opt/app-root/src/.cache/pip && chown -R root:root /opt/app-root && \
+  # ls -ld /opt/ /opt/app-root /opt/app-root/src/ /opt/app-root/src/.cache /opt/app-root/src/.cache/pip || true; \
+  pushd $CONTAINER_SOURCE/upstream2/app/distgit/containers/rhdh-hub/docker/ >/dev/null && \
+  set -xe; \
+  python3.11 -V; pip3.11 -V; \
+  pip3.11 install --user --no-cache-dir --upgrade pip setuptools pyyaml; \
+  pip3.11 install --user --no-cache-dir -r requirements.txt -r requirements-build.txt; \
+  popd >/dev/null; \
+  microdnf clean all; rm -fr $CONTAINER_SOURCE/upstream2
 
 # Downstream only - copy from builder, not cleanup stage
 COPY --from=builder --chown=1001:1001 $CONTAINER_SOURCE/ ./

packages/backend/package.json

@@ -16,37 +16,38 @@
   },
   "dependencies": {
     "@backstage/backend-common": "0.19.7",
+    "@backstage/backend-plugin-manager": "npm:@janus-idp/backend-plugin-manager@0.0.5-janus.0",
     "@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-events-backend": "0.2.14",
+    "@backstage/plugin-events-node": "0.2.14",
     "@backstage/integration": "1.7.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-openapi": "0.1.22",
+    "@internal/plugin-dynamic-plugins-info-backend": "0.1.0",
     "@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",
+    "@internal/plugin-scalprum-backend": "0.1.0",
     "@backstage/plugin-search-backend": "1.4.5",
     "@backstage/plugin-search-backend-module-pg": "0.5.14",
     "@backstage/plugin-search-backend-node": "1.2.9",
-    "@internal/plugin-scalprum-backend": "^0.1.0",
-    "@backstage/backend-plugin-manager": "npm:@janus-idp/backend-plugin-manager@0.0.5-janus.0",
-    "@backstage/plugin-events-backend": "0.2.14",
-    "@backstage/plugin-events-node": "0.2.14",
     "app": "*",
     "better-sqlite3": "8.7.0",
     "express": "4.18.2",
+    "express-prom-bundle": "6.6.0",
     "express-promise-router": "4.1.1",
     "isolated-vm": "4.6.0",
     "pg": "8.11.3",
-    "winston": "3.11.0",
-    "express-prom-bundle": "6.6.0",
-    "prom-client": "14.2.0"
+    "prom-client": "14.2.0",
+    "winston": "3.11.0"
   },
   "devDependencies": {
     "@backstage/cli": "0.22.13",

packages/backend/src/index.ts

@@ -42,6 +42,7 @@ import {
 } from '@backstage/backend-plugin-manager';
 import { DefaultEventBroker } from '@backstage/plugin-events-backend';
 import { createRouter as scalprumRouter } from '@internal/plugin-scalprum-backend';
+import { createRouter as dynamicPluginsInfoRouter } from '@internal/plugin-dynamic-plugins-info-backend';
 
 // TODO(davidfestal): The following import is a temporary workaround for a bug
 // in the upstream @backstage/backend-plugin-manager package.
@@ -193,13 +194,25 @@ async function main() {
   const apiRouter = Router();
 
   // Scalprum frontend plugins provider
-  const scalprumEmv = useHotMemoize(module, () => createEnv('scalprum'));
+  const scalprumEnv = useHotMemoize(module, () => createEnv('scalprum'));
   apiRouter.use(
     '/scalprum',
     await scalprumRouter({
-      logger: scalprumEmv.logger,
+      logger: scalprumEnv.logger,
+      pluginManager,
+      discovery: scalprumEnv.discovery,
+    }),
+  );
+
+  // Dynamic plugins info provider
+  const dynamicPluginsInfoEnv = useHotMemoize(module, () =>
+    createEnv('dynamic-plugins-info'),
+  );
+  apiRouter.use(
+    '/dynamic-plugins-info',
+    await dynamicPluginsInfoRouter({
+      logger: dynamicPluginsInfoEnv.logger,
       pluginManager,
-      discovery: scalprumEmv.discovery,
     }),
   );
 

plugins/dynamic-plugins-info-backend/.eslintrc.js

@@ -0,0 +1 @@
+module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);

plugins/dynamic-plugins-info-backend/README.md

@@ -0,0 +1,12 @@
+# dynamic-plugins-info
+
+Welcome to the dynamic-plugins-info backend plugin!
+
+This plugin depends on the `backend-plugin-manager` and lists all the dynamic plugins installed in the dynamic plugins root folder.
+
+## Getting started
+
+This plugin has been added to the backend app in this repository, meaning you'll be able to access it by running `yarn
+start-backend` in the root directory, and then navigating to [/api/dynamic-plugins-info](http://localhost:7007/api/dynamic-plugins-info).
+
+To view the list of installed dynamic plugins, navigate to `http://localhost:7007/api/dynamic-plugins-info/dynamic-plugins``