Added support for new backend system

Signed-off-by: Josh Uvi <joshuauvbiekpahor@gmail.com>
This commit is contained in:
Josh Uvi
2023-10-20 12:22:09 +01:00
parent ec779d4d8c
commit 11f671eaa9
5 changed files with 94 additions and 0 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-code-coverage-backend': patch
---
Added support for new backend system
+23
View File
@@ -67,6 +67,29 @@ diff --git a/packages/backend/src/index.ts b/packages/backend/src/index.ts
apiRouter.use(notFoundHandler());
```
## New Backend System
The code coverage backend plugin has support for the [new backend system](https://backstage.io/docs/backend-system/), here's how you can set that up:
In your `packages/backend/src/index.ts` make the following changes:
```diff
import { createBackend } from '@backstage/backend-defaults';
+ import { codeCoveragePlugin } from '@backstage/plugin-code-coverage-backend';
const backend = createBackend();
// ... other feature additions
+ backend.add(codeCoveragePlugin());
backend.start();
```
Alternatively, you can actually remove the import line above, and do this instead.
```diff
backend.add(explorePlugin());
+ backend.add(import('@backstage/plugin-explore-backend'));
```
## Configuring your entity
In order to use this plugin, you must set the `backstage.io/code-coverage` annotation.
@@ -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 { CatalogApi } from '@backstage/catalog-client';
import { Config } from '@backstage/config';
import express from 'express';
@@ -11,6 +12,10 @@ import { PluginDatabaseManager } from '@backstage/backend-common';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { UrlReader } from '@backstage/backend-common';
// @public
const codeCoveragePlugin: () => BackendFeature;
export default codeCoveragePlugin;
// @public
export function createRouter(options: RouterOptions): Promise<express.Router>;
@@ -22,3 +22,4 @@
export { createRouter } from './service/router';
export type { RouterOptions } from './service/router';
export { codeCoveragePlugin as default } from './plugin';
@@ -0,0 +1,60 @@
/*
* 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';
/**
* Code coverage backend plugin
*
* @public
*/
export const codeCoveragePlugin = createBackendPlugin({
pluginId: 'codeCoverage',
register(env) {
env.registerInit({
deps: {
config: coreServices.rootConfig,
logger: coreServices.logger,
urlReader: coreServices.urlReader,
httpRouter: coreServices.httpRouter,
discovery: coreServices.discovery,
database: coreServices.database,
},
async init({
config,
logger,
urlReader,
httpRouter,
discovery,
database,
}) {
httpRouter.use(
await createRouter({
config,
logger: loggerToWinstonLogger(logger),
urlReader,
discovery,
database,
}),
);
},
});
},
});