Feature: New Backend System Migration

.changeset/orange-buses-hug.md

@@ -0,0 +1,5 @@
+---
+'@axis-backstage/plugin-jira-dashboard-backend': major
+---
+
+Migrated Jira Dashboard Backend to new Backstage backend system

plugins/jira-dashboard-backend/README.md

@@ -96,49 +96,6 @@ jiraDashboard:
 
 ### Integrating
 
-Here's how to get the backend plugin up and running:
-
-1. Create a new file named `packages/backend/src/plugins/jiraDashboard.ts`, and add the following to it:
-
- ```ts
- import { createRouter } from '@axis-backstage/plugin-jira-dashboard-backend';
- import { Router } from 'express';
- import { PluginEnvironment } from '../types';
-
- export default async function createPlugin(
- env: PluginEnvironment,
- ): Promise<Router> {
- return await createRouter({
- logger: env.logger,
- config: env.config,
- discovery: env.discovery,
- identity: env.identity,
- tokenManager: env.tokenManager,
- });
- }
- ```
-
-2. Wire this into the overall backend router by adding the following to `packages/backend/src/index.ts`:
-
- ```ts
- import jiraDashboard from './plugins/jiraDashboard';
- ...
-
- async function main() {
- // Add this line under the other lines that follow the useHotMemoize pattern
- const jiraDashboardEnv = useHotMemoize(module, () => createEnv('jira-dashboard'),
-
- // Add this under the lines that add their routers to apiRouter
- apiRouter.use('/jira-dashboard', await jiraDashboard(jiraDashboardEnv));
- }
- ```
-
-3. Now run `yarn start-backend` from the repo root.
-
-4. In another terminal, run the command: `curl localhost:7007/api/jira-dashboard/health`. The request should return `{"status":"ok"}`.
-
-### New Backend System
-
 The Jira Dashboard backend plugin has support for the [new backend system](https://backstage.io/docs/backend-system/). Here is how you can set it up:
 
 In your `packages/backend/src/index.ts` make the following changes:

plugins/jira-dashboard-backend/api-report.md

@@ -8,14 +8,12 @@ import { BackendFeatureCompat } from '@backstage/backend-plugin-api';
 import { DiscoveryService } from '@backstage/backend-plugin-api';
 import express from 'express';
 import { HttpAuthService } from '@backstage/backend-plugin-api';
-import { IdentityService } from '@backstage/backend-plugin-api';
 import { Issue } from '@axis-backstage/plugin-jira-dashboard-common';
 import { LoggerService } from '@backstage/backend-plugin-api';
 import { RootConfigService } from '@backstage/backend-plugin-api';
-import { TokenManagerService } from '@backstage/backend-plugin-api';
 import { UserInfoService } from '@backstage/backend-plugin-api';
 
-// @public @deprecated
+// @public
 export function createRouter(options: RouterOptions): Promise<express.Router>;
 
 // @public
@@ -36,15 +34,13 @@ export type JqlQueryBuilderArgs = {
  query?: string;
 };
 
-// @public @deprecated
+// @public
 export interface RouterOptions {
- auth?: AuthService;
+ auth: AuthService;
  config: RootConfigService;
  discovery: DiscoveryService;
- httpAuth?: HttpAuthService;
- identity?: IdentityService;
+ httpAuth: HttpAuthService;
  logger: LoggerService;
- tokenManager?: TokenManagerService;
  userInfo: UserInfoService;
 }
 

plugins/jira-dashboard-backend/dev/index.ts

@@ -1,5 +1,9 @@
 import { createBackend } from '@backstage/backend-defaults';
 
 const backend = createBackend();
+
+backend.add(import('@backstage/plugin-auth-backend'));
+backend.add(import('@backstage/plugin-auth-backend-module-guest-provider'));
 backend.add(import('../src'));
+
 backend.start();

plugins/jira-dashboard-backend/package.json

@@ -35,15 +35,16 @@
  "@backstage/backend-plugin-api": "^0.8.0",
  "@backstage/catalog-client": "^1.6.6",
  "@backstage/catalog-model": "^1.6.0",
- "@backstage/plugin-permission-common": "^0.8.1",
- "@types/express": "*",
  "express": "^4.17.1",
  "express-promise-router": "^4.1.0",
  "node-fetch": "^2.6.7"
  },
  "devDependencies": {
  "@backstage/backend-test-utils": "^0.5.0",
  "@backstage/cli": "^0.27.0",
+ "@backstage/plugin-auth-backend": "^0.23.0",
+ "@backstage/plugin-auth-backend-module-guest-provider": "^0.2.0",
+ "@types/express": "*",
  "@types/supertest": "^2.0.12",
  "msw": "^1.0.0",
  "supertest": "^6.2.4"

plugins/jira-dashboard-backend/src/api.ts

@@ -136,11 +136,10 @@ export const getIssuesByComponent = async (
 };
 
 export async function getProjectAvatar(url: string, config: RootConfigService) {
- const response = await fetch(url, {
+ return await fetch(url, {
  method: 'GET',
  headers: {
  Authorization: resolveJiraToken(config),
  },
  });
- return response;
 }

plugins/jira-dashboard-backend/src/plugin.ts

@@ -14,33 +14,37 @@ export const jiraDashboardPlugin = createBackendPlugin({
  register(env) {
  env.registerInit({
  deps: {
+ auth: coreServices.auth,
+ httpRouter: coreServices.httpRouter,
  logger: coreServices.logger,
  config: coreServices.rootConfig,
  discovery: coreServices.discovery,
- httpRouter: coreServices.httpRouter,
- auth: coreServices.auth,
  httpAuth: coreServices.httpAuth,
  userInfo: coreServices.userInfo,
  },
  async init({
+ auth,
+ httpRouter,
  logger,
  config,
  discovery,
- httpRouter,
- auth,
  httpAuth,
  userInfo,
  }) {
  httpRouter.use(
  await createRouter({
+ auth,
  logger,
  config,
  discovery,
- auth,
  httpAuth,
  userInfo,
  }),
  );
+ httpRouter.addAuthPolicy({
+ path: '/health',
+ allow: 'unauthenticated',
+ });
  },
  });
  },

plugins/jira-dashboard-backend/src/service/defaultValues.ts

@@ -0,0 +1,3 @@
+export const DEFAULT_TTL = 1000 * 60;
+
+export const DEFAULT_MAX_RESULTS_USER_ISSUES = 10;

plugins/jira-dashboard-backend/src/service/router.test.ts

@@ -1,22 +1,20 @@
+import { mockServices } from '@backstage/backend-test-utils';
 import express from 'express';
 import request from 'supertest';
+
 import { createRouter } from './router';
-import { mockServices } from '@backstage/backend-test-utils';
 
 describe('createRouter', () => {
  let app: express.Express;
- const tokenManager = mockServices.tokenManager.mock();
- const testDiscovery = mockServices.discovery.mock();
- const identity = mockServices.identity.mock();
 
  beforeAll(async () => {
  const router = await createRouter({
+ auth: mockServices.auth.mock(),
  logger: mockServices.logger.mock(),
  config: mockServices.rootConfig(),
- discovery: testDiscovery,
- identity,
- tokenManager,
- userInfo: mockServices.userInfo({ userEntityRef: 'user:default/guest' }),
+ discovery: mockServices.discovery.mock(),
+ httpAuth: mockServices.httpAuth.mock(),
+ userInfo: mockServices.userInfo.mock(),
  });
  app = express().use(router);
  });

plugins/jira-dashboard-backend/src/service/router.ts

@@ -1,98 +1,74 @@
-import { createLegacyAuthAdapters } from '@backstage/backend-common';
 import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';
 import { CacheManager } from '@backstage/backend-defaults/cache';
 import {
  AuthService,
  DiscoveryService,
  HttpAuthService,
  LoggerService,
- IdentityService,
  RootConfigService,
- TokenManagerService,
  UserInfoService,
 } from '@backstage/backend-plugin-api';
-import { stringifyEntityRef, UserEntity } from '@backstage/catalog-model';
 import express from 'express';
 import Router from 'express-promise-router';
+import { stringifyEntityRef, UserEntity } from '@backstage/catalog-model';
 import { CatalogClient } from '@backstage/catalog-client';
-
-import { getAssigneUser, getDefaultFiltersForUser } from '../filters';
-import {
- type Filter,
- type JiraResponse,
- type Project,
-} from '@axis-backstage/plugin-jira-dashboard-common';
-import stream from 'stream';
-import { getProjectAvatar } from '../api';
+import { getAnnotations } from '../lib';
 import {
  getFiltersFromAnnotations,
  getIssuesFromComponents,
  getIssuesFromFilters,
  getProjectResponse,
  getUserIssues,
 } from './service';
-import { getAnnotations } from '../lib';
+import { DEFAULT_MAX_RESULTS_USER_ISSUES, DEFAULT_TTL } from './defaultValues';
+import { getAssigneUser, getDefaultFiltersForUser } from '../filters';
+import {
+ type Filter,
+ type JiraResponse,
+ type Project,
+} from '@axis-backstage/plugin-jira-dashboard-common';
+import { getProjectAvatar } from '../api';
+import stream from 'stream';
 
 /**
  * Constructs a jira dashboard router.
- * @deprecated Please migrate to the new backend system as this will be removed in the future.
  * @public
  */
 export interface RouterOptions {
  /**
- * Implementation of Winston logger
+ * Implementation of Authentication Service
+ */
+ auth: AuthService;
+ /**
+ * Implementation of Logger Service
  */
  logger: LoggerService;
-
  /**
- * Backstage config object
+ * Implementation of Config Service
  */
  config: RootConfigService;
-
  /**
- * Backstage discovery api instance
+ * Implementation of Discovery Service
  */
  discovery: DiscoveryService;
-
- /**
- * Backstage identity api instance
- */
- identity?: IdentityService;
-
  /**
- * Backstage token manager instance
+ * Implementation of Http Authentication Service
  */
- tokenManager?: TokenManagerService;
+ httpAuth: HttpAuthService;
  /**
- * Backstage auth service
- */
- auth?: AuthService;
- /**
- * Backstage httpAuth service
- */
- httpAuth?: HttpAuthService;
-
- /**
- * Backstage userInfo service
+ * Implementation of User Info Service
  */
  userInfo: UserInfoService;
 }
 
-const DEFAULT_TTL = 1000 * 60;
-
-const DEFAULT_MAX_RESULTS_USER_ISSUES = 10;
-
 /**
  * Constructs a jira dashboard router.
- *
- * @deprecated Please migrate to the new backend system as this will be removed in the future.
  * @public
  */
 export async function createRouter(
  options: RouterOptions,
 ): Promise<express.Router> {
- const { auth, httpAuth } = createLegacyAuthAdapters(options);
- const { logger, config, discovery, userInfo } = options;
+ const { auth, logger, config, discovery, httpAuth, userInfo } = options;
  const catalogClient = new CatalogClient({ discoveryApi: discovery });
 
  const pluginCache =
@@ -104,6 +80,7 @@ export async function createRouter(
  router.use(express.json());
 
  router.get('/health', (_, response) => {
+ logger.info('PONG!');
  response.json({ status: 'ok' });
  });
 
@@ -326,7 +303,9 @@ export async function createRouter(
  ps.pipe(response);
  },
  );
+
  const middleware = MiddlewareFactory.create({ logger, config });
+
  router.use(middleware.error());
  return router;
 }

plugins/jira-dashboard-backend/src/service/service.ts

@@ -24,7 +24,9 @@ export const getProjectResponse = async (
 
  projectResponse = (await cache.get(projectKey)) as Project;
 
- if (projectResponse) return projectResponse as Project;
+ if (projectResponse) {
+ return projectResponse as Project;
+ }
 
  try {
  projectResponse = await getProjectInfo(projectKey, config);
@@ -49,7 +51,9 @@ export const getJqlResponse = async (
 
  issuesResponse = (await cache.get(jql)) as Issue[];
 
- if (issuesResponse) return issuesResponse as Issue[];
+ if (issuesResponse) {
+ return issuesResponse as Issue[];
+ }
 
  try {
  issuesResponse = await searchJira(config, jql, searchOptions);