@backstage/plugin-gateway-backend 1.0.6 → 1.1.0-next.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,23 @@
1
1
  # @backstage/plugin-gateway-backend
2
2
 
3
+ ## 1.1.0-next.1
4
+
5
+ ### Minor Changes
6
+
7
+ - a17d9df: Update usage of the `instanceMetadata` service.
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies
12
+ - @backstage/backend-plugin-api@1.5.0-next.1
13
+
14
+ ## 1.0.7-next.0
15
+
16
+ ### Patch Changes
17
+
18
+ - Updated dependencies
19
+ - @backstage/backend-plugin-api@1.4.5-next.0
20
+
3
21
  ## 1.0.6
4
22
 
5
23
  ### Patch Changes
@@ -2,7 +2,6 @@
2
2
 
3
3
  var backendPluginApi = require('@backstage/backend-plugin-api');
4
4
  var router = require('./router.cjs.js');
5
- var alpha = require('@backstage/backend-plugin-api/alpha');
6
5
 
7
6
  const gatewayPlugin = backendPluginApi.createBackendPlugin({
8
7
  pluginId: "gateway",
@@ -11,13 +10,13 @@ const gatewayPlugin = backendPluginApi.createBackendPlugin({
11
10
  deps: {
12
11
  logger: backendPluginApi.coreServices.logger,
13
12
  rootHttpRouter: backendPluginApi.coreServices.rootHttpRouter,
14
- instanceMeta: alpha.instanceMetadataServiceRef,
13
+ instanceMeta: backendPluginApi.coreServices.rootInstanceMetadata,
15
14
  discovery: backendPluginApi.coreServices.discovery
16
15
  },
17
16
  async init({ logger, discovery, instanceMeta, rootHttpRouter }) {
18
17
  rootHttpRouter.use(
19
18
  "/api/:pluginId",
20
- router.createRouter({
19
+ await router.createRouter({
21
20
  discovery,
22
21
  instanceMeta})
23
22
  );
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './router';\nimport { instanceMetadataServiceRef } from '@backstage/backend-plugin-api/alpha';\nimport { Handler } from 'express';\n\n/**\n * gateway backend plugin\n *\n * @public\n */\nexport const gatewayPlugin = createBackendPlugin({\n pluginId: 'gateway',\n register(env) {\n env.registerInit({\n deps: {\n logger: coreServices.logger,\n rootHttpRouter: coreServices.rootHttpRouter,\n instanceMeta: instanceMetadataServiceRef,\n discovery: coreServices.discovery,\n },\n async init({ logger, discovery, instanceMeta, rootHttpRouter }) {\n rootHttpRouter.use(\n '/api/:pluginId',\n createRouter({\n discovery,\n instanceMeta,\n logger,\n }) as Handler,\n );\n },\n });\n },\n});\n"],"names":["createBackendPlugin","coreServices","instanceMetadataServiceRef","createRouter"],"mappings":";;;;;;AA4BO,MAAM,gBAAgBA,oCAAA,CAAoB;AAAA,EAC/C,QAAA,EAAU,SAAA;AAAA,EACV,SAAS,GAAA,EAAK;AACZ,IAAA,GAAA,CAAI,YAAA,CAAa;AAAA,MACf,IAAA,EAAM;AAAA,QACJ,QAAQC,6BAAA,CAAa,MAAA;AAAA,QACrB,gBAAgBA,6BAAA,CAAa,cAAA;AAAA,QAC7B,YAAA,EAAcC,gCAAA;AAAA,QACd,WAAWD,6BAAA,CAAa;AAAA,OAC1B;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,QAAQ,SAAA,EAAW,YAAA,EAAc,gBAAe,EAAG;AAC9D,QAAA,cAAA,CAAe,GAAA;AAAA,UACb,gBAAA;AAAA,UACAE,mBAAA,CAAa;AAAA,YACX,SAAA;AAAA,YACA,YAEF,CAAC;AAAA,SACH;AAAA,MACF;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;;;"}
1
+ {"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './router';\nimport { Handler } from 'express';\n\n/**\n * gateway backend plugin\n *\n * @public\n */\nexport const gatewayPlugin = createBackendPlugin({\n pluginId: 'gateway',\n register(env) {\n env.registerInit({\n deps: {\n logger: coreServices.logger,\n rootHttpRouter: coreServices.rootHttpRouter,\n instanceMeta: coreServices.rootInstanceMetadata,\n discovery: coreServices.discovery,\n },\n async init({ logger, discovery, instanceMeta, rootHttpRouter }) {\n rootHttpRouter.use(\n '/api/:pluginId',\n (await createRouter({\n discovery,\n instanceMeta,\n logger,\n })) as Handler,\n );\n },\n });\n },\n});\n"],"names":["createBackendPlugin","coreServices","createRouter"],"mappings":";;;;;AA2BO,MAAM,gBAAgBA,oCAAA,CAAoB;AAAA,EAC/C,QAAA,EAAU,SAAA;AAAA,EACV,SAAS,GAAA,EAAK;AACZ,IAAA,GAAA,CAAI,YAAA,CAAa;AAAA,MACf,IAAA,EAAM;AAAA,QACJ,QAAQC,6BAAA,CAAa,MAAA;AAAA,QACrB,gBAAgBA,6BAAA,CAAa,cAAA;AAAA,QAC7B,cAAcA,6BAAA,CAAa,oBAAA;AAAA,QAC3B,WAAWA,6BAAA,CAAa;AAAA,OAC1B;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,QAAQ,SAAA,EAAW,YAAA,EAAc,gBAAe,EAAG;AAC9D,QAAA,cAAA,CAAe,GAAA;AAAA,UACb,gBAAA;AAAA,UACC,MAAMC,mBAAA,CAAa;AAAA,YAClB,SAAA;AAAA,YACA,YAEF,CAAC;AAAA,SACH;AAAA,MACF;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;;;"}
@@ -4,13 +4,12 @@ var httpProxyMiddleware = require('http-proxy-middleware');
4
4
  var api = require('@opentelemetry/api');
5
5
  var core = require('@opentelemetry/core');
6
6
 
7
- function createRouter({
7
+ async function createRouter({
8
8
  discovery,
9
9
  instanceMeta
10
10
  }) {
11
- const localPluginIds = new Set(
12
- instanceMeta.getInstalledFeatures().filter((f) => f.type === "plugin").map((f) => f.pluginId)
13
- );
11
+ const plugins = await instanceMeta.getInstalledPlugins();
12
+ const localPluginIds = new Set(plugins.map((f) => f.pluginId));
14
13
  const proxy = httpProxyMiddleware.createProxyMiddleware({
15
14
  changeOrigin: true,
16
15
  router: async (req) => {
@@ -1 +1 @@
1
- {"version":3,"file":"router.cjs.js","sources":["../src/router.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { DiscoveryService, LoggerService } from '@backstage/backend-plugin-api';\nimport { InstanceMetadataService } from '@backstage/backend-plugin-api/alpha';\nimport { Request, Response, NextFunction } from 'express';\nimport { createProxyMiddleware } from 'http-proxy-middleware';\nimport { context } from '@opentelemetry/api';\nimport { getRPCMetadata } from '@opentelemetry/core';\n\nexport function createRouter({\n discovery,\n instanceMeta,\n}: {\n discovery: DiscoveryService;\n instanceMeta: InstanceMetadataService;\n logger: LoggerService;\n}) {\n const localPluginIds = new Set(\n instanceMeta\n .getInstalledFeatures()\n .filter(f => f.type === 'plugin')\n .map(f => f.pluginId),\n );\n\n const proxy = createProxyMiddleware({\n changeOrigin: true,\n router: async (req: Request<{ pluginId: string }>) => {\n const pluginId = req.params.pluginId;\n return discovery.getBaseUrl(pluginId);\n },\n on: {\n proxyRes(proxyRes, _req, res) {\n // https://github.com/chimurai/http-proxy-middleware/discussions/765\n proxyRes.on('close', () => {\n if (!res.writableEnded) {\n res.end();\n }\n });\n },\n },\n });\n\n return function proxyMiddleware(\n req: Request<{ pluginId: string }>,\n res: Response,\n next: NextFunction,\n ) {\n if (localPluginIds.has(req.params.pluginId)) {\n next();\n return;\n }\n\n const rpcMetadata = getRPCMetadata(context.active());\n if (rpcMetadata) {\n rpcMetadata.route = req.baseUrl;\n }\n\n proxy(req, res, next);\n };\n}\n"],"names":["createProxyMiddleware","getRPCMetadata","context"],"mappings":";;;;;;AAsBO,SAAS,YAAA,CAAa;AAAA,EAC3B,SAAA;AAAA,EACA;AACF,CAAA,EAIG;AACD,EAAA,MAAM,iBAAiB,IAAI,GAAA;AAAA,IACzB,YAAA,CACG,oBAAA,EAAqB,CACrB,MAAA,CAAO,CAAA,CAAA,KAAK,CAAA,CAAE,IAAA,KAAS,QAAQ,CAAA,CAC/B,GAAA,CAAI,CAAA,CAAA,KAAK,CAAA,CAAE,QAAQ;AAAA,GACxB;AAEA,EAAA,MAAM,QAAQA,yCAAA,CAAsB;AAAA,IAClC,YAAA,EAAc,IAAA;AAAA,IACd,MAAA,EAAQ,OAAO,GAAA,KAAuC;AACpD,MAAA,MAAM,QAAA,GAAW,IAAI,MAAA,CAAO,QAAA;AAC5B,MAAA,OAAO,SAAA,CAAU,WAAW,QAAQ,CAAA;AAAA,IACtC,CAAA;AAAA,IACA,EAAA,EAAI;AAAA,MACF,QAAA,CAAS,QAAA,EAAU,IAAA,EAAM,GAAA,EAAK;AAE5B,QAAA,QAAA,CAAS,EAAA,CAAG,SAAS,MAAM;AACzB,UAAA,IAAI,CAAC,IAAI,aAAA,EAAe;AACtB,YAAA,GAAA,CAAI,GAAA,EAAI;AAAA,UACV;AAAA,QACF,CAAC,CAAA;AAAA,MACH;AAAA;AACF,GACD,CAAA;AAED,EAAA,OAAO,SAAS,eAAA,CACd,GAAA,EACA,GAAA,EACA,IAAA,EACA;AACA,IAAA,IAAI,cAAA,CAAe,GAAA,CAAI,GAAA,CAAI,MAAA,CAAO,QAAQ,CAAA,EAAG;AAC3C,MAAA,IAAA,EAAK;AACL,MAAA;AAAA,IACF;AAEA,IAAA,MAAM,WAAA,GAAcC,mBAAA,CAAeC,WAAA,CAAQ,MAAA,EAAQ,CAAA;AACnD,IAAA,IAAI,WAAA,EAAa;AACf,MAAA,WAAA,CAAY,QAAQ,GAAA,CAAI,OAAA;AAAA,IAC1B;AAEA,IAAA,KAAA,CAAM,GAAA,EAAK,KAAK,IAAI,CAAA;AAAA,EACtB,CAAA;AACF;;;;"}
1
+ {"version":3,"file":"router.cjs.js","sources":["../src/router.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n DiscoveryService,\n RootInstanceMetadataService,\n LoggerService,\n} from '@backstage/backend-plugin-api';\nimport { Request, Response, NextFunction } from 'express';\nimport { createProxyMiddleware } from 'http-proxy-middleware';\nimport { context } from '@opentelemetry/api';\nimport { getRPCMetadata } from '@opentelemetry/core';\n\nexport async function createRouter({\n discovery,\n instanceMeta,\n}: {\n discovery: DiscoveryService;\n instanceMeta: RootInstanceMetadataService;\n logger: LoggerService;\n}) {\n const plugins = await instanceMeta.getInstalledPlugins();\n const localPluginIds = new Set(plugins.map(f => f.pluginId));\n\n const proxy = createProxyMiddleware({\n changeOrigin: true,\n router: async (req: Request<{ pluginId: string }>) => {\n const pluginId = req.params.pluginId;\n return discovery.getBaseUrl(pluginId);\n },\n on: {\n proxyRes(proxyRes, _req, res) {\n // https://github.com/chimurai/http-proxy-middleware/discussions/765\n proxyRes.on('close', () => {\n if (!res.writableEnded) {\n res.end();\n }\n });\n },\n },\n });\n\n return function proxyMiddleware(\n req: Request<{ pluginId: string }>,\n res: Response,\n next: NextFunction,\n ) {\n if (localPluginIds.has(req.params.pluginId)) {\n next();\n return;\n }\n\n const rpcMetadata = getRPCMetadata(context.active());\n if (rpcMetadata) {\n rpcMetadata.route = req.baseUrl;\n }\n\n proxy(req, res, next);\n };\n}\n"],"names":["createProxyMiddleware","getRPCMetadata","context"],"mappings":";;;;;;AAyBA,eAAsB,YAAA,CAAa;AAAA,EACjC,SAAA;AAAA,EACA;AACF,CAAA,EAIG;AACD,EAAA,MAAM,OAAA,GAAU,MAAM,YAAA,CAAa,mBAAA,EAAoB;AACvD,EAAA,MAAM,cAAA,GAAiB,IAAI,GAAA,CAAI,OAAA,CAAQ,IAAI,CAAA,CAAA,KAAK,CAAA,CAAE,QAAQ,CAAC,CAAA;AAE3D,EAAA,MAAM,QAAQA,yCAAA,CAAsB;AAAA,IAClC,YAAA,EAAc,IAAA;AAAA,IACd,MAAA,EAAQ,OAAO,GAAA,KAAuC;AACpD,MAAA,MAAM,QAAA,GAAW,IAAI,MAAA,CAAO,QAAA;AAC5B,MAAA,OAAO,SAAA,CAAU,WAAW,QAAQ,CAAA;AAAA,IACtC,CAAA;AAAA,IACA,EAAA,EAAI;AAAA,MACF,QAAA,CAAS,QAAA,EAAU,IAAA,EAAM,GAAA,EAAK;AAE5B,QAAA,QAAA,CAAS,EAAA,CAAG,SAAS,MAAM;AACzB,UAAA,IAAI,CAAC,IAAI,aAAA,EAAe;AACtB,YAAA,GAAA,CAAI,GAAA,EAAI;AAAA,UACV;AAAA,QACF,CAAC,CAAA;AAAA,MACH;AAAA;AACF,GACD,CAAA;AAED,EAAA,OAAO,SAAS,eAAA,CACd,GAAA,EACA,GAAA,EACA,IAAA,EACA;AACA,IAAA,IAAI,cAAA,CAAe,GAAA,CAAI,GAAA,CAAI,MAAA,CAAO,QAAQ,CAAA,EAAG;AAC3C,MAAA,IAAA,EAAK;AACL,MAAA;AAAA,IACF;AAEA,IAAA,MAAM,WAAA,GAAcC,mBAAA,CAAeC,WAAA,CAAQ,MAAA,EAAQ,CAAA;AACnD,IAAA,IAAI,WAAA,EAAa;AACf,MAAA,WAAA,CAAY,QAAQ,GAAA,CAAI,OAAA;AAAA,IAC1B;AAEA,IAAA,KAAA,CAAM,GAAA,EAAK,KAAK,IAAI,CAAA;AAAA,EACtB,CAAA;AACF;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-gateway-backend",
3
- "version": "1.0.6",
3
+ "version": "1.1.0-next.1",
4
4
  "backstage": {
5
5
  "role": "backend-plugin",
6
6
  "pluginId": "gateway",
@@ -37,17 +37,17 @@
37
37
  "test": "backstage-cli package test"
38
38
  },
39
39
  "dependencies": {
40
- "@backstage/backend-plugin-api": "^1.4.4",
40
+ "@backstage/backend-plugin-api": "1.5.0-next.1",
41
41
  "@opentelemetry/api": "^1.9.0",
42
42
  "@opentelemetry/core": "^1.29.0",
43
43
  "express": "^4.17.1",
44
44
  "http-proxy-middleware": "^3.0.3"
45
45
  },
46
46
  "devDependencies": {
47
- "@backstage/backend-app-api": "^1.2.8",
48
- "@backstage/backend-defaults": "^0.13.0",
49
- "@backstage/backend-test-utils": "^1.9.1",
50
- "@backstage/cli": "^0.34.4",
47
+ "@backstage/backend-app-api": "1.3.0-next.1",
48
+ "@backstage/backend-defaults": "0.13.1-next.1",
49
+ "@backstage/backend-test-utils": "1.10.0-next.1",
50
+ "@backstage/cli": "0.34.5-next.1",
51
51
  "@types/express": "^4.17.6",
52
52
  "eventsource": "^3.0.6",
53
53
  "wait-for-expect": "^3.0.2"