feat: add support for new backend to notifications

Signed-off-by: Heikki Hellgren <heikki.hellgren@op.fi>
This commit is contained in:
Heikki Hellgren
2023-12-15 14:47:22 +02:00
parent 92c327211a
commit b3d70e2a4f
9 changed files with 103 additions and 0 deletions
@@ -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';
@@ -11,6 +12,9 @@ import { NotificationService } from '@backstage/plugin-notifications-node';
// @public (undocumented)
export function createRouter(options: RouterOptions): Promise<express.Router>;
// @public
export const notificationsPlugin: () => BackendFeature;
// @public (undocumented)
export interface RouterOptions {
// (undocumented)
@@ -23,6 +23,7 @@
},
"dependencies": {
"@backstage/backend-common": "workspace:^",
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/config": "workspace:^",
"@backstage/plugin-auth-node": "workspace:^",
"@backstage/plugin-notifications-node": "workspace:^",
@@ -14,3 +14,4 @@
* limitations under the License.
*/
export * from './service/router';
export * from './plugin';
@@ -0,0 +1,50 @@
/*
* 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';
import { notificationService } from '@backstage/plugin-notifications-node';
/**
* Notifications backend plugin
*
* @public
*/
export const notificationsPlugin = createBackendPlugin({
pluginId: 'notifications',
register(env) {
env.registerInit({
deps: {
httpRouter: coreServices.httpRouter,
logger: coreServices.logger,
identity: coreServices.identity,
service: notificationService,
},
async init({ httpRouter, logger, identity, service }) {
httpRouter.use(
await createRouter({
logger: loggerToWinstonLogger(logger),
identity,
notificationService: service,
}),
);
},
});
},
});
+4
View File
@@ -8,6 +8,7 @@ import { NotificationStatus } from '@backstage/plugin-notifications-common';
import { NotificationType } from '@backstage/plugin-notifications-common';
import { PluginDatabaseManager } from '@backstage/backend-common';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { ServiceRef } from '@backstage/backend-plugin-api';
// @public (undocumented)
export class DatabaseNotificationsStore implements NotificationsStore {
@@ -54,6 +55,9 @@ export class NotificationService {
): Promise<Notification_2[]>;
}
// @public (undocumented)
export const notificationService: ServiceRef<NotificationService, 'plugin'>;
// @public (undocumented)
export type NotificationServiceOptions = {
database: PluginDatabaseManager;
+1
View File
@@ -29,6 +29,7 @@
],
"dependencies": {
"@backstage/backend-common": "workspace:^",
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/catalog-client": "workspace:^",
"@backstage/catalog-model": "workspace:^",
"@backstage/plugin-notifications-common": "workspace:^",
+1
View File
@@ -22,3 +22,4 @@
export * from './database';
export * from './service';
export * from './lib';
+39
View File
@@ -0,0 +1,39 @@
/*
* 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 {
coreServices,
createServiceFactory,
createServiceRef,
} from '@backstage/backend-plugin-api';
import { NotificationService } from './service';
/** @public */
export const notificationService = createServiceRef<NotificationService>({
id: 'notifications.service',
scope: 'plugin',
defaultFactory: async service =>
createServiceFactory({
service,
deps: {
discovery: coreServices.discovery,
database: coreServices.database,
// TODO: Signals
},
factory({ discovery, database }) {
return NotificationService.create({ discovery, database });
},
}),
});
+2
View File
@@ -7784,6 +7784,7 @@ __metadata:
resolution: "@backstage/plugin-notifications-backend@workspace:plugins/notifications-backend"
dependencies:
"@backstage/backend-common": "workspace:^"
"@backstage/backend-plugin-api": "workspace:^"
"@backstage/cli": "workspace:^"
"@backstage/config": "workspace:^"
"@backstage/plugin-auth-node": "workspace:^"
@@ -7814,6 +7815,7 @@ __metadata:
resolution: "@backstage/plugin-notifications-node@workspace:plugins/notifications-node"
dependencies:
"@backstage/backend-common": "workspace:^"
"@backstage/backend-plugin-api": "workspace:^"
"@backstage/catalog-client": "workspace:^"
"@backstage/catalog-model": "workspace:^"
"@backstage/cli": "workspace:^"