paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

implement some of the trivial backend plugins

Browse Source 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2023-02-01 11:35:52 +01:00
parent bcd8f0b2fe
commit 4a6f38a535
26 changed files with 372 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/stale-experts-punch.md
+9
View File
@@ -0,0 +1,9 @@
---
'@backstage/plugin-user-settings-backend': patch
'@backstage/plugin-periskop-backend': patch
'@backstage/plugin-bazaar-backend': patch
'@backstage/plugin-kafka-backend': patch
'@backstage/plugin-proxy-backend': patch
---
Added a Backend System plugin feature
plugins/bazaar-backend/api-report.md
+4
View File
@@ -3,12 +3,16 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
import { Config } from '@backstage/config';
import express from 'express';
import { IdentityApi } from '@backstage/plugin-auth-node';
import { Logger } from 'winston';
import { PluginDatabaseManager } from '@backstage/backend-common';
// @alpha
export const bazaarPlugin: () => BackendFeature;
// @public (undocumented)
export function createRouter(options: RouterOptions): Promise<express.Router>;
plugins/bazaar-backend/package.json
+6 -3
View File
@@ -7,14 +7,15 @@
"publishConfig": {
"access": "public",
"main": "dist/index.cjs.js",
"types": "dist/index.d.ts"
"types": "dist/index.d.ts",
"alphaTypes": "dist/index.alpha.d.ts"
},
"backstage": {
"role": "backend-plugin"
},
"scripts": {
"start": "backstage-cli package start",
"build": "backstage-cli package build",
"build": "backstage-cli package build --experimental-type-build",
"lint": "backstage-cli package lint",
"test": "backstage-cli package test",
"prepack": "backstage-cli package prepack",
@@ -23,6 +24,7 @@
},
"dependencies": {
"@backstage/backend-common": "workspace:^",
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/backend-test-utils": "workspace:^",
"@backstage/config": "workspace:^",
"@backstage/errors": "workspace:^",
@@ -39,6 +41,7 @@
},
"files": [
"dist",
"migrations/**/*.{js,d.ts}"
"migrations/**/*.{js,d.ts}",
"alpha"
]
}
plugins/bazaar-backend/src/index.ts
+1
View File
@@ -15,3 +15,4 @@
*/
export * from './service/router';
export { bazaarPlugin } from './plugin';
plugins/bazaar-backend/src/plugin.ts
+52
View File
@@ -0,0 +1,52 @@
/*
* Copyright 2023 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 { loggerToWinstonLogger } from '@backstage/backend-common';
import {
coreServices,
createBackendPlugin,
} from '@backstage/backend-plugin-api';
import { createRouter } from './service/router';
/**
* The Bazaar backend plugin.
*
* @alpha
*/
export const bazaarPlugin = createBackendPlugin({
id: 'bazaar',
register(env) {
env.registerInit({
deps: {
config: coreServices.config,
database: coreServices.database,
identity: coreServices.identity,
logger: coreServices.logger,
httpRouter: coreServices.httpRouter,
},
async init({ database, config, identity, logger, httpRouter }) {
httpRouter.use(
await createRouter({
database,
config,
identity,
logger: loggerToWinstonLogger(logger),
}),
);
},
});
},
});
plugins/example-todo-list-backend/api-report.md
+4
View File
@@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
import express from 'express';
import { IdentityApi } from '@backstage/plugin-auth-node';
import { Logger } from 'winston';
@@ -10,6 +11,9 @@ import { Logger } from 'winston';
// @public
export function createRouter(options: RouterOptions): Promise<express.Router>;
// @alpha
export const exampleTodoListPlugin: () => BackendFeature;
// @public
export interface RouterOptions {
// (undocumented)
plugins/example-todo-list-backend/package.json
+6 -3
View File
@@ -11,11 +11,12 @@
"publishConfig": {
"access": "public",
"main": "dist/index.cjs.js",
"types": "dist/index.d.ts"
"types": "dist/index.d.ts",
"alphaTypes": "dist/index.alpha.d.ts"
},
"scripts": {
"start": "backstage-cli package start",
"build": "backstage-cli package build",
"build": "backstage-cli package build --experimental-type-build",
"lint": "backstage-cli package lint",
"test": "backstage-cli package test",
"prepack": "backstage-cli package prepack",
@@ -24,6 +25,7 @@
},
"dependencies": {
"@backstage/backend-common": "workspace:^",
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/config": "workspace:^",
"@backstage/errors": "workspace:^",
"@backstage/plugin-auth-node": "workspace:^",
@@ -42,6 +44,7 @@
"supertest": "^6.1.6"
},
"files": [
"dist"
"dist",
"alpha"
]
}
plugins/example-todo-list-backend/src/index.ts
+1
View File
@@ -15,3 +15,4 @@
*/
export * from './service/router';
export { exampleTodoListPlugin } from './plugin';
plugins/example-todo-list-backend/src/plugin.ts
+48
View File
@@ -0,0 +1,48 @@
/*
* Copyright 2023 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 { loggerToWinstonLogger } from '@backstage/backend-common';
import {
coreServices,
createBackendPlugin,
} from '@backstage/backend-plugin-api';
import { createRouter } from './service/router';
/**
* The example TODO list backend plugin.
*
* @alpha
*/
export const exampleTodoListPlugin = createBackendPlugin({
id: 'exampleTodoList',
register(env) {
env.registerInit({
deps: {
identity: coreServices.identity,
logger: coreServices.logger,
httpRouter: coreServices.httpRouter,
},
async init({ identity, logger, httpRouter }) {
httpRouter.use(
await createRouter({
identity,
logger: loggerToWinstonLogger(logger),
}),
);
},
});
},
});
plugins/kafka-backend/api-report.md
+4
View File
@@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
import { Config } from '@backstage/config';
import express from 'express';
import { Logger } from 'winston';
@@ -10,6 +11,9 @@ import { Logger } from 'winston';
// @public (undocumented)
export function createRouter(options: RouterOptions): Promise<express.Router>;
// @alpha
export const kafkaPlugin: () => BackendFeature;
// @public (undocumented)
export interface RouterOptions {
// (undocumented)
plugins/kafka-backend/package.json
+6 -3
View File
@@ -8,7 +8,8 @@
"publishConfig": {
"access": "public",
"main": "dist/index.cjs.js",
"types": "dist/index.d.ts"
"types": "dist/index.d.ts",
"alphaTypes": "dist/index.alpha.d.ts"
},
"backstage": {
"role": "backend-plugin"
@@ -26,7 +27,7 @@
"configSchema": "config.d.ts",
"scripts": {
"start": "backstage-cli package start",
"build": "backstage-cli package build",
"build": "backstage-cli package build --experimental-type-build",
"lint": "backstage-cli package lint",
"test": "backstage-cli package test",
"prepack": "backstage-cli package prepack",
@@ -35,6 +36,7 @@
},
"dependencies": {
"@backstage/backend-common": "workspace:^",
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/catalog-model": "workspace:^",
"@backstage/config": "workspace:^",
"@backstage/errors": "workspace:^",
@@ -54,6 +56,7 @@
},
"files": [
"dist",
"config.d.ts"
"config.d.ts",
"alpha"
]
}
plugins/kafka-backend/src/index.ts
+1
View File
@@ -22,3 +22,4 @@
export type { RouterOptions } from './service/router';
export { createRouter } from './service/router';
export { kafkaPlugin } from './plugin';
plugins/kafka-backend/src/plugin.ts
+45
View File
@@ -0,0 +1,45 @@
/*
* Copyright 2023 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 { loggerToWinstonLogger } from '@backstage/backend-common';
import {
coreServices,
createBackendPlugin,
} from '@backstage/backend-plugin-api';
import { createRouter } from './service/router';
/**
* The Kafka backend plugin.
*
* @alpha
*/
export const kafkaPlugin = createBackendPlugin({
id: 'kafka',
register(env) {
env.registerInit({
deps: {
config: coreServices.config,
logger: coreServices.logger,
httpRouter: coreServices.httpRouter,
},
async init({ config, logger, httpRouter }) {
httpRouter.use(
await createRouter({ config, logger: loggerToWinstonLogger(logger) }),
);
},
});
},
});
plugins/periskop-backend/api-report.md
+4
View File
@@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
import { Config } from '@backstage/config';
import express from 'express';
import { Logger } from 'winston';
@@ -10,6 +11,9 @@ import { Logger } from 'winston';
// @public (undocumented)
export function createRouter(options: RouterOptions): Promise<express.Router>;
// @alpha
export const periskopPlugin: () => BackendFeature;
// @public (undocumented)
export interface RouterOptions {
// (undocumented)
plugins/periskop-backend/package.json
+6 -3
View File
@@ -11,11 +11,12 @@
"publishConfig": {
"access": "public",
"main": "dist/index.cjs.js",
"types": "dist/index.d.ts"
"types": "dist/index.d.ts",
"alphaTypes": "dist/index.alpha.d.ts"
},
"scripts": {
"start": "backstage-cli package start",
"build": "backstage-cli package build",
"build": "backstage-cli package build --experimental-type-build",
"lint": "backstage-cli package lint",
"test": "backstage-cli package test",
"prepack": "backstage-cli package prepack",
@@ -24,6 +25,7 @@
},
"dependencies": {
"@backstage/backend-common": "workspace:^",
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/config": "workspace:^",
"@types/express": "*",
"express": "^4.17.1",
@@ -39,6 +41,7 @@
"supertest": "^6.1.6"
},
"files": [
"dist"
"dist",
"alpha"
]
}
plugins/periskop-backend/src/index.ts
+1
View File
@@ -15,3 +15,4 @@
*/
export * from './service/router';
export { periskopPlugin } from './plugin';
plugins/periskop-backend/src/plugin.ts
+45
View File
@@ -0,0 +1,45 @@
/*
* Copyright 2023 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 { loggerToWinstonLogger } from '@backstage/backend-common';
import {
coreServices,
createBackendPlugin,
} from '@backstage/backend-plugin-api';
import { createRouter } from './service/router';
/**
* The Periskop backend plugin.
*
* @alpha
*/
export const periskopPlugin = createBackendPlugin({
id: 'periskop',
register(env) {
env.registerInit({
deps: {
config: coreServices.config,
logger: coreServices.logger,
httpRouter: coreServices.httpRouter,
},
async init({ config, logger, httpRouter }) {
httpRouter.use(
await createRouter({ config, logger: loggerToWinstonLogger(logger) }),
);
},
});
},
});
plugins/proxy-backend/api-report.md
+10
View File
@@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
import { Config } from '@backstage/config';
import express from 'express';
import { Logger } from 'winston';
@@ -11,6 +12,15 @@ import { PluginEndpointDiscovery } from '@backstage/backend-common';
// @public
export function createRouter(options: RouterOptions): Promise<express.Router>;
// @alpha
export const proxyPlugin: (
options?:
| {
skipInvalidProxies?: boolean | undefined;
}
| undefined,
) => BackendFeature;
// @public (undocumented)
export interface RouterOptions {
// (undocumented)
plugins/proxy-backend/package.json
+6 -3
View File
@@ -8,7 +8,8 @@
"publishConfig": {
"access": "public",
"main": "dist/index.cjs.js",
"types": "dist/index.d.ts"
"types": "dist/index.d.ts",
"alphaTypes": "dist/index.alpha.d.ts"
},
"backstage": {
"role": "backend-plugin"
@@ -24,7 +25,7 @@
],
"scripts": {
"start": "backstage-cli package start",
"build": "backstage-cli package build",
"build": "backstage-cli package build --experimental-type-build",
"lint": "backstage-cli package lint",
"test": "backstage-cli package test",
"prepack": "backstage-cli package prepack",
@@ -33,6 +34,7 @@
},
"dependencies": {
"@backstage/backend-common": "workspace:^",
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/config": "workspace:^",
"@types/express": "^4.17.6",
"express": "^4.17.1",
@@ -56,7 +58,8 @@
},
"files": [
"dist",
"config.d.ts"
"config.d.ts",
"alpha"
],
"configSchema": "config.d.ts"
}
plugins/proxy-backend/src/index.ts
+1
View File
@@ -21,3 +21,4 @@
*/
export * from './service';
export { proxyPlugin } from './plugin';
plugins/proxy-backend/src/plugin.ts
+53
View File
@@ -0,0 +1,53 @@
/*
* Copyright 2023 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 { loggerToWinstonLogger } from '@backstage/backend-common';
import {
createBackendPlugin,
coreServices,
} from '@backstage/backend-plugin-api';
import { createRouter } from './service/router';
/**
* The proxy backend plugin.
*
* @alpha
*/
export const proxyPlugin = createBackendPlugin(
(options?: { skipInvalidProxies?: boolean }) => ({
id: 'proxy',
register(env) {
env.registerInit({
deps: {
config: coreServices.config,
discovery: coreServices.discovery,
logger: coreServices.logger,
httpRouter: coreServices.httpRouter,
},
async init({ config, discovery, logger, httpRouter }) {
httpRouter.use(
await createRouter({
config,
discovery,
logger: loggerToWinstonLogger(logger),
skipInvalidProxies: options?.skipInvalidProxies,
}),
);
},
});
},
}),
);
plugins/user-settings-backend/api-report.md
+4
View File
@@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
import express from 'express';
import { IdentityApi } from '@backstage/plugin-auth-node';
import { PluginDatabaseManager } from '@backstage/backend-common';
@@ -18,5 +19,8 @@ export interface RouterOptions {
identity: IdentityApi;
}
// @alpha
export const userSettingsPlugin: () => BackendFeature;
// (No @packageDocumentation comment for this package)
```
plugins/user-settings-backend/package.json
+6 -3
View File
@@ -11,7 +11,8 @@
"publishConfig": {
"access": "public",
"main": "dist/index.cjs.js",
"types": "dist/index.d.ts"
"types": "dist/index.d.ts",
"alphaTypes": "dist/index.alpha.d.ts"
},
"repository": {
"type": "git",
@@ -20,7 +21,7 @@
},
"scripts": {
"start": "backstage-cli package start",
"build": "backstage-cli package build",
"build": "backstage-cli package build --experimental-type-build",
"lint": "backstage-cli package lint",
"test": "backstage-cli package test",
"prepack": "backstage-cli package prepack",
@@ -29,6 +30,7 @@
},
"dependencies": {
"@backstage/backend-common": "workspace:^",
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/catalog-model": "workspace:^",
"@backstage/errors": "workspace:^",
"@backstage/plugin-auth-node": "workspace:^",
@@ -48,6 +50,7 @@
},
"files": [
"dist",
"migrations"
"migrations",
"alpha"
]
}
plugins/user-settings-backend/src/index.ts
+1
View File
@@ -16,3 +16,4 @@
export * from './service';
export * from './database';
export { userSettingsPlugin } from './plugin';
plugins/user-settings-backend/src/plugin.ts
+42
View File
@@ -0,0 +1,42 @@
/*
* Copyright 2023 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 {
createBackendPlugin,
coreServices,
} from '@backstage/backend-plugin-api';
import { createRouter } from './service/router';
/**
* The user settings backend plugin.
*
* @alpha
*/
export const userSettingsPlugin = createBackendPlugin({
id: 'userSettings',
register(env) {
env.registerInit({
deps: {
database: coreServices.database,
identity: coreServices.identity,
httpRouter: coreServices.httpRouter,
},
async init({ database, identity, httpRouter }) {
httpRouter.use(await createRouter({ database, identity }));
},
});
},
});
yarn.lock
+6
View File
@@ -4758,6 +4758,7 @@ __metadata:
resolution: "@backstage/plugin-bazaar-backend@workspace:plugins/bazaar-backend"
dependencies:
"@backstage/backend-common": "workspace:^"
"@backstage/backend-plugin-api": "workspace:^"
"@backstage/backend-test-utils": "workspace:^"
"@backstage/cli": "workspace:^"
"@backstage/config": "workspace:^"
@@ -6602,6 +6603,7 @@ __metadata:
resolution: "@backstage/plugin-kafka-backend@workspace:plugins/kafka-backend"
dependencies:
"@backstage/backend-common": "workspace:^"
"@backstage/backend-plugin-api": "workspace:^"
"@backstage/catalog-model": "workspace:^"
"@backstage/cli": "workspace:^"
"@backstage/config": "workspace:^"
@@ -6924,6 +6926,7 @@ __metadata:
resolution: "@backstage/plugin-periskop-backend@workspace:plugins/periskop-backend"
dependencies:
"@backstage/backend-common": "workspace:^"
"@backstage/backend-plugin-api": "workspace:^"
"@backstage/cli": "workspace:^"
"@backstage/config": "workspace:^"
"@types/express": "*"
@@ -7139,6 +7142,7 @@ __metadata:
resolution: "@backstage/plugin-proxy-backend@workspace:plugins/proxy-backend"
dependencies:
"@backstage/backend-common": "workspace:^"
"@backstage/backend-plugin-api": "workspace:^"
"@backstage/cli": "workspace:^"
"@backstage/config": "workspace:^"
"@types/express": ^4.17.6
@@ -8349,6 +8353,7 @@ __metadata:
resolution: "@backstage/plugin-user-settings-backend@workspace:plugins/user-settings-backend"
dependencies:
"@backstage/backend-common": "workspace:^"
"@backstage/backend-plugin-api": "workspace:^"
"@backstage/backend-test-utils": "workspace:^"
"@backstage/catalog-model": "workspace:^"
"@backstage/cli": "workspace:^"
@@ -10302,6 +10307,7 @@ __metadata:
resolution: "@internal/plugin-todo-list-backend@workspace:plugins/example-todo-list-backend"
dependencies:
"@backstage/backend-common": "workspace:^"
"@backstage/backend-plugin-api": "workspace:^"
"@backstage/cli": "workspace:^"
"@backstage/config": "workspace:^"
"@backstage/errors": "workspace:^"