@backstage/plugin-devtools-backend 0.0.0-nightly-20241129023656 → 0.0.0-nightly-20241201024112
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 +8 -3
- package/README.md +0 -48
- package/dist/index.cjs.js +0 -2
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +2 -21
- package/dist/service/router.cjs.js +4 -4
- package/dist/service/router.cjs.js.map +1 -1
- package/package.json +8 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,12 +1,17 @@
|
|
|
1
1
|
# @backstage/plugin-devtools-backend
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20241201024112
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- c781a9a: **BREAKING** Removed support for what is known as the legacy backend, please use the New Backend System.
|
|
4
8
|
|
|
5
9
|
### Patch Changes
|
|
6
10
|
|
|
7
11
|
- 1e624ca: Restrict `@types/express` version range from `*` to `^4.17.6`.
|
|
8
12
|
- Updated dependencies
|
|
9
|
-
- @backstage/backend-
|
|
13
|
+
- @backstage/backend-defaults@0.0.0-nightly-20241201024112
|
|
14
|
+
- @backstage/backend-plugin-api@0.0.0-nightly-20241201024112
|
|
10
15
|
- @backstage/cli-common@0.1.15
|
|
11
16
|
- @backstage/config@1.3.0
|
|
12
17
|
- @backstage/config-loader@1.9.2
|
|
@@ -14,7 +19,7 @@
|
|
|
14
19
|
- @backstage/types@1.2.0
|
|
15
20
|
- @backstage/plugin-devtools-common@0.1.13
|
|
16
21
|
- @backstage/plugin-permission-common@0.8.2
|
|
17
|
-
- @backstage/plugin-permission-node@0.0.0-nightly-
|
|
22
|
+
- @backstage/plugin-permission-node@0.0.0-nightly-20241201024112
|
|
18
23
|
|
|
19
24
|
## 0.4.3-next.0
|
|
20
25
|
|
package/README.md
CHANGED
|
@@ -25,54 +25,6 @@ Here's how to get the DevTools Backend up and running in the new backend system:
|
|
|
25
25
|
3. Now run `yarn start-backend` from the repo root
|
|
26
26
|
4. Finally open `http://localhost:7007/api/devtools/health` in a browser and it should return `{"status":"ok"}`
|
|
27
27
|
|
|
28
|
-
## Old Backend System
|
|
29
|
-
|
|
30
|
-
If you are still on the old backend system, please consider migrating to the new backend system. But to install this plugin in an old backend, see below.
|
|
31
|
-
|
|
32
|
-
1. First we need to add the `@backstage/plugin-devtools-backend` package to your backend:
|
|
33
|
-
|
|
34
|
-
```sh
|
|
35
|
-
# From the Backstage root directory
|
|
36
|
-
yarn --cwd packages/backend add @backstage/plugin-devtools-backend
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
2. Then we will create a new file named `packages/backend/src/plugins/devtools.ts`, and add the
|
|
40
|
-
following to it:
|
|
41
|
-
|
|
42
|
-
```ts
|
|
43
|
-
import { createRouter } from '@backstage/plugin-devtools-backend';
|
|
44
|
-
import { Router } from 'express';
|
|
45
|
-
import type { PluginEnvironment } from '../types';
|
|
46
|
-
|
|
47
|
-
export default function createPlugin(
|
|
48
|
-
env: PluginEnvironment,
|
|
49
|
-
): Promise<Router> {
|
|
50
|
-
return createRouter({
|
|
51
|
-
logger: env.logger,
|
|
52
|
-
config: env.config,
|
|
53
|
-
permissions: env.permissions,
|
|
54
|
-
discovery: env.discovery,
|
|
55
|
-
});
|
|
56
|
-
}
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
3. Next we wire this into the overall backend router, edit `packages/backend/src/index.ts`:
|
|
60
|
-
|
|
61
|
-
```ts
|
|
62
|
-
import devTools from './plugins/devtools';
|
|
63
|
-
// ...
|
|
64
|
-
async function main() {
|
|
65
|
-
// ...
|
|
66
|
-
// Add this line under the other lines that follow the useHotMemoize pattern
|
|
67
|
-
const devToolsEnv = useHotMemoize(module, () => createEnv('devtools'));
|
|
68
|
-
// ...
|
|
69
|
-
// Insert this line under the other lines that add their routers to apiRouter in the same way
|
|
70
|
-
apiRouter.use('/devtools', await devTools(devToolsEnv));
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
4. Now run `yarn start-backend` from the repo root
|
|
74
|
-
5. Finally open `http://localhost:7007/api/devtools/health` in a browser and it should return `{"status":"ok"}`
|
|
75
|
-
|
|
76
28
|
## Links
|
|
77
29
|
|
|
78
30
|
- [Frontend part of the plugin](https://github.com/backstage/backstage/tree/master/plugins/devtools)
|
package/dist/index.cjs.js
CHANGED
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
4
|
|
|
5
5
|
var DevToolsBackendApi = require('./api/DevToolsBackendApi.cjs.js');
|
|
6
|
-
var router = require('./service/router.cjs.js');
|
|
7
6
|
var plugin = require('./plugin.cjs.js');
|
|
8
7
|
|
|
9
8
|
|
|
10
9
|
|
|
11
10
|
exports.DevToolsBackendApi = DevToolsBackendApi.DevToolsBackendApi;
|
|
12
|
-
exports.createRouter = router.createRouter;
|
|
13
11
|
exports.default = plugin.devtoolsPlugin;
|
|
14
12
|
//# sourceMappingURL=index.cjs.js.map
|
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { Config } from '@backstage/config';
|
|
2
2
|
import { ExternalDependency, ConfigInfo, DevToolsInfo } from '@backstage/plugin-devtools-common';
|
|
3
3
|
import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
|
|
4
|
-
import { LoggerService
|
|
5
|
-
import express from 'express';
|
|
4
|
+
import { LoggerService } from '@backstage/backend-plugin-api';
|
|
6
5
|
|
|
7
6
|
/** @public */
|
|
8
7
|
declare class DevToolsBackendApi {
|
|
@@ -16,24 +15,6 @@ declare class DevToolsBackendApi {
|
|
|
16
15
|
listInfo(): Promise<DevToolsInfo>;
|
|
17
16
|
}
|
|
18
17
|
|
|
19
|
-
/**
|
|
20
|
-
* @public
|
|
21
|
-
* @deprecated Please migrate to the new backend system as this will be removed in the future.
|
|
22
|
-
*/
|
|
23
|
-
interface RouterOptions {
|
|
24
|
-
devToolsBackendApi?: DevToolsBackendApi;
|
|
25
|
-
logger: LoggerService;
|
|
26
|
-
config: RootConfigService;
|
|
27
|
-
permissions: PermissionsService;
|
|
28
|
-
discovery: DiscoveryService;
|
|
29
|
-
httpAuth?: HttpAuthService;
|
|
30
|
-
}
|
|
31
|
-
/**
|
|
32
|
-
* @deprecated Please migrate to the new backend system as this will be removed in the future.
|
|
33
|
-
* @public
|
|
34
|
-
* */
|
|
35
|
-
declare function createRouter(options: RouterOptions): Promise<express.Router>;
|
|
36
|
-
|
|
37
18
|
/**
|
|
38
19
|
* DevTools backend plugin
|
|
39
20
|
*
|
|
@@ -41,4 +22,4 @@ declare function createRouter(options: RouterOptions): Promise<express.Router>;
|
|
|
41
22
|
*/
|
|
42
23
|
declare const devtoolsPlugin: _backstage_backend_plugin_api.BackendFeature;
|
|
43
24
|
|
|
44
|
-
export { DevToolsBackendApi,
|
|
25
|
+
export { DevToolsBackendApi, devtoolsPlugin as default };
|
|
@@ -5,9 +5,9 @@ var pluginDevtoolsCommon = require('@backstage/plugin-devtools-common');
|
|
|
5
5
|
var DevToolsBackendApi = require('../api/DevToolsBackendApi.cjs.js');
|
|
6
6
|
var errors = require('@backstage/errors');
|
|
7
7
|
var Router = require('express-promise-router');
|
|
8
|
-
var backendCommon = require('@backstage/backend-common');
|
|
9
8
|
var express = require('express');
|
|
10
9
|
var pluginPermissionNode = require('@backstage/plugin-permission-node');
|
|
10
|
+
var rootHttpRouter = require('@backstage/backend-defaults/rootHttpRouter');
|
|
11
11
|
|
|
12
12
|
function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
|
|
13
13
|
|
|
@@ -15,8 +15,7 @@ var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
|
|
|
15
15
|
var express__default = /*#__PURE__*/_interopDefaultCompat(express);
|
|
16
16
|
|
|
17
17
|
async function createRouter(options) {
|
|
18
|
-
const { logger, config, permissions } = options;
|
|
19
|
-
const { httpAuth } = backendCommon.createLegacyAuthAdapters(options);
|
|
18
|
+
const { logger, config, permissions, httpAuth } = options;
|
|
20
19
|
const devToolsBackendApi = options.devToolsBackendApi || new DevToolsBackendApi.DevToolsBackendApi(logger, config);
|
|
21
20
|
const router = Router__default.default();
|
|
22
21
|
router.use(express__default.default.json());
|
|
@@ -61,7 +60,8 @@ async function createRouter(options) {
|
|
|
61
60
|
const health = await devToolsBackendApi.listExternalDependencyDetails();
|
|
62
61
|
response.status(200).json(health);
|
|
63
62
|
});
|
|
64
|
-
|
|
63
|
+
const middleware = rootHttpRouter.MiddlewareFactory.create({ logger, config });
|
|
64
|
+
router.use(middleware.error());
|
|
65
65
|
return router;
|
|
66
66
|
}
|
|
67
67
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"router.cjs.js","sources":["../../src/service/router.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { AuthorizeResult } from '@backstage/plugin-permission-common';\nimport {\n devToolsConfigReadPermission,\n devToolsExternalDependenciesReadPermission,\n devToolsInfoReadPermission,\n devToolsPermissions,\n} from '@backstage/plugin-devtools-common';\n\nimport { DevToolsBackendApi } from '../api';\nimport { NotAllowedError } from '@backstage/errors';\nimport Router from 'express-promise-router';\nimport
|
|
1
|
+
{"version":3,"file":"router.cjs.js","sources":["../../src/service/router.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { AuthorizeResult } from '@backstage/plugin-permission-common';\nimport {\n devToolsConfigReadPermission,\n devToolsExternalDependenciesReadPermission,\n devToolsInfoReadPermission,\n devToolsPermissions,\n} from '@backstage/plugin-devtools-common';\n\nimport { DevToolsBackendApi } from '../api';\nimport { NotAllowedError } from '@backstage/errors';\nimport Router from 'express-promise-router';\nimport express from 'express';\nimport { createPermissionIntegrationRouter } from '@backstage/plugin-permission-node';\nimport {\n DiscoveryService,\n HttpAuthService,\n LoggerService,\n PermissionsService,\n RootConfigService,\n} from '@backstage/backend-plugin-api';\nimport { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';\n\n/**\n * @internal\n */\nexport interface RouterOptions {\n devToolsBackendApi?: DevToolsBackendApi;\n logger: LoggerService;\n config: RootConfigService;\n permissions: PermissionsService;\n discovery: DiscoveryService;\n httpAuth: HttpAuthService;\n}\n\n/**\n * @internal\n * */\nexport async function createRouter(\n options: RouterOptions,\n): Promise<express.Router> {\n const { logger, config, permissions, httpAuth } = options;\n\n const devToolsBackendApi =\n options.devToolsBackendApi || new DevToolsBackendApi(logger, config);\n\n const router = Router();\n router.use(express.json());\n router.use(\n createPermissionIntegrationRouter({\n permissions: devToolsPermissions,\n }),\n );\n\n router.get('/health', (_req, res) => {\n res.status(200).json({ status: 'ok' });\n });\n\n router.get('/info', async (req, response) => {\n const decision = (\n await permissions.authorize(\n [{ permission: devToolsInfoReadPermission }],\n { credentials: await httpAuth.credentials(req) },\n )\n )[0];\n\n if (decision.result === AuthorizeResult.DENY) {\n throw new NotAllowedError('Unauthorized');\n }\n\n const info = await devToolsBackendApi.listInfo();\n\n response.status(200).json(info);\n });\n\n router.get('/config', async (req, response) => {\n const decision = (\n await permissions.authorize(\n [{ permission: devToolsConfigReadPermission }],\n { credentials: await httpAuth.credentials(req) },\n )\n )[0];\n\n if (decision.result === AuthorizeResult.DENY) {\n throw new NotAllowedError('Unauthorized');\n }\n\n const configList = await devToolsBackendApi.listConfig();\n\n response.status(200).json(configList);\n });\n\n router.get('/external-dependencies', async (req, response) => {\n const decision = (\n await permissions.authorize(\n [{ permission: devToolsExternalDependenciesReadPermission }],\n { credentials: await httpAuth.credentials(req) },\n )\n )[0];\n\n if (decision.result === AuthorizeResult.DENY) {\n throw new NotAllowedError('Unauthorized');\n }\n\n const health = await devToolsBackendApi.listExternalDependencyDetails();\n\n response.status(200).json(health);\n });\n\n const middleware = MiddlewareFactory.create({ logger, config });\n\n router.use(middleware.error());\n return router;\n}\n"],"names":["DevToolsBackendApi","Router","express","createPermissionIntegrationRouter","devToolsPermissions","devToolsInfoReadPermission","AuthorizeResult","NotAllowedError","devToolsConfigReadPermission","devToolsExternalDependenciesReadPermission","MiddlewareFactory"],"mappings":";;;;;;;;;;;;;;;;AAoDA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,MAAM,EAAE,MAAA,EAAQ,MAAQ,EAAA,WAAA,EAAa,UAAa,GAAA,OAAA;AAElD,EAAA,MAAM,qBACJ,OAAQ,CAAA,kBAAA,IAAsB,IAAIA,qCAAA,CAAmB,QAAQ,MAAM,CAAA;AAErE,EAAA,MAAM,SAASC,uBAAO,EAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA;AACzB,EAAO,MAAA,CAAA,GAAA;AAAA,IACLC,sDAAkC,CAAA;AAAA,MAChC,WAAa,EAAAC;AAAA,KACd;AAAA,GACH;AAEA,EAAA,MAAA,CAAO,GAAI,CAAA,SAAA,EAAW,CAAC,IAAA,EAAM,GAAQ,KAAA;AACnC,IAAA,GAAA,CAAI,OAAO,GAAG,CAAA,CAAE,KAAK,EAAE,MAAA,EAAQ,MAAM,CAAA;AAAA,GACtC,CAAA;AAED,EAAA,MAAA,CAAO,GAAI,CAAA,OAAA,EAAS,OAAO,GAAA,EAAK,QAAa,KAAA;AAC3C,IAAM,MAAA,QAAA,GAAA,CACJ,MAAM,WAAY,CAAA,SAAA;AAAA,MAChB,CAAC,EAAE,UAAY,EAAAC,+CAAA,EAA4B,CAAA;AAAA,MAC3C,EAAE,WAAa,EAAA,MAAM,QAAS,CAAA,WAAA,CAAY,GAAG,CAAE;AAAA,OAEjD,CAAC,CAAA;AAEH,IAAI,IAAA,QAAA,CAAS,MAAW,KAAAC,sCAAA,CAAgB,IAAM,EAAA;AAC5C,MAAM,MAAA,IAAIC,uBAAgB,cAAc,CAAA;AAAA;AAG1C,IAAM,MAAA,IAAA,GAAO,MAAM,kBAAA,CAAmB,QAAS,EAAA;AAE/C,IAAA,QAAA,CAAS,MAAO,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,IAAI,CAAA;AAAA,GAC/B,CAAA;AAED,EAAA,MAAA,CAAO,GAAI,CAAA,SAAA,EAAW,OAAO,GAAA,EAAK,QAAa,KAAA;AAC7C,IAAM,MAAA,QAAA,GAAA,CACJ,MAAM,WAAY,CAAA,SAAA;AAAA,MAChB,CAAC,EAAE,UAAY,EAAAC,iDAAA,EAA8B,CAAA;AAAA,MAC7C,EAAE,WAAa,EAAA,MAAM,QAAS,CAAA,WAAA,CAAY,GAAG,CAAE;AAAA,OAEjD,CAAC,CAAA;AAEH,IAAI,IAAA,QAAA,CAAS,MAAW,KAAAF,sCAAA,CAAgB,IAAM,EAAA;AAC5C,MAAM,MAAA,IAAIC,uBAAgB,cAAc,CAAA;AAAA;AAG1C,IAAM,MAAA,UAAA,GAAa,MAAM,kBAAA,CAAmB,UAAW,EAAA;AAEvD,IAAA,QAAA,CAAS,MAAO,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,UAAU,CAAA;AAAA,GACrC,CAAA;AAED,EAAA,MAAA,CAAO,GAAI,CAAA,wBAAA,EAA0B,OAAO,GAAA,EAAK,QAAa,KAAA;AAC5D,IAAM,MAAA,QAAA,GAAA,CACJ,MAAM,WAAY,CAAA,SAAA;AAAA,MAChB,CAAC,EAAE,UAAY,EAAAE,+DAAA,EAA4C,CAAA;AAAA,MAC3D,EAAE,WAAa,EAAA,MAAM,QAAS,CAAA,WAAA,CAAY,GAAG,CAAE;AAAA,OAEjD,CAAC,CAAA;AAEH,IAAI,IAAA,QAAA,CAAS,MAAW,KAAAH,sCAAA,CAAgB,IAAM,EAAA;AAC5C,MAAM,MAAA,IAAIC,uBAAgB,cAAc,CAAA;AAAA;AAG1C,IAAM,MAAA,MAAA,GAAS,MAAM,kBAAA,CAAmB,6BAA8B,EAAA;AAEtE,IAAA,QAAA,CAAS,MAAO,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,MAAM,CAAA;AAAA,GACjC,CAAA;AAED,EAAA,MAAM,aAAaG,gCAAkB,CAAA,MAAA,CAAO,EAAE,MAAA,EAAQ,QAAQ,CAAA;AAE9D,EAAO,MAAA,CAAA,GAAA,CAAI,UAAW,CAAA,KAAA,EAAO,CAAA;AAC7B,EAAO,OAAA,MAAA;AACT;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-devtools-backend",
|
|
3
|
-
"version": "0.0.0-nightly-
|
|
3
|
+
"version": "0.0.0-nightly-20241201024112",
|
|
4
4
|
"backstage": {
|
|
5
5
|
"role": "backend-plugin",
|
|
6
6
|
"pluginId": "devtools",
|
|
@@ -38,18 +38,17 @@
|
|
|
38
38
|
"test": "backstage-cli package test"
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@backstage/backend-
|
|
42
|
-
"@backstage/backend-plugin-api": "0.0.0-nightly-
|
|
41
|
+
"@backstage/backend-defaults": "0.0.0-nightly-20241201024112",
|
|
42
|
+
"@backstage/backend-plugin-api": "0.0.0-nightly-20241201024112",
|
|
43
43
|
"@backstage/cli-common": "0.1.15",
|
|
44
44
|
"@backstage/config": "1.3.0",
|
|
45
45
|
"@backstage/config-loader": "1.9.2",
|
|
46
46
|
"@backstage/errors": "1.2.5",
|
|
47
47
|
"@backstage/plugin-devtools-common": "0.1.13",
|
|
48
48
|
"@backstage/plugin-permission-common": "0.8.2",
|
|
49
|
-
"@backstage/plugin-permission-node": "0.0.0-nightly-
|
|
49
|
+
"@backstage/plugin-permission-node": "0.0.0-nightly-20241201024112",
|
|
50
50
|
"@backstage/types": "1.2.0",
|
|
51
51
|
"@manypkg/get-packages": "^1.1.3",
|
|
52
|
-
"@types/express": "^4.17.6",
|
|
53
52
|
"@yarnpkg/lockfile": "^1.1.0",
|
|
54
53
|
"@yarnpkg/parsers": "^3.0.0",
|
|
55
54
|
"express": "^4.18.1",
|
|
@@ -62,9 +61,10 @@
|
|
|
62
61
|
"yn": "^4.0.0"
|
|
63
62
|
},
|
|
64
63
|
"devDependencies": {
|
|
65
|
-
"@backstage/backend-defaults": "0.0.0-nightly-
|
|
66
|
-
"@backstage/backend-test-utils": "0.0.0-nightly-
|
|
67
|
-
"@backstage/cli": "0.0.0-nightly-
|
|
64
|
+
"@backstage/backend-defaults": "0.0.0-nightly-20241201024112",
|
|
65
|
+
"@backstage/backend-test-utils": "0.0.0-nightly-20241201024112",
|
|
66
|
+
"@backstage/cli": "0.0.0-nightly-20241201024112",
|
|
67
|
+
"@types/express": "^4.17.6",
|
|
68
68
|
"@types/ping": "^0.4.1",
|
|
69
69
|
"@types/supertest": "^2.0.8",
|
|
70
70
|
"@types/yarnpkg__lockfile": "^1.1.4",
|