chore: remove own backstage/backend-common dependency (#153)

Author: Kirdock

packages/backend/package.json

@@ -21,7 +21,6 @@
     "build-image": "docker build ../.. -f Dockerfile --tag backstage"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.23.2",
     "@backstage/backend-defaults": "^0.4.0",
     "@backstage/backend-plugin-api": "^0.7.0",
     "@backstage/backend-tasks": "^0.5.23",

plugins/dql-backend/package.json

@@ -34,14 +34,13 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.23.0",
     "@backstage/config": "^1.2.0",
     "@dynatrace/backstage-plugin-dql-common": "^0.1.0",
     "@types/express": "*",
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0",
-    "node-fetch": "^2.6.7",
     "https-proxy-agent": "7.0.5",
+    "node-fetch": "^2.6.7",
     "winston": "^3.2.1",
     "yn": "^4.0.0",
     "zod": "^3.22.4"

plugins/dql-backend/src/run.ts

@@ -21,6 +21,7 @@ import {
   PollQueryResponse,
   TokenResponse,
 } from './dynatraceApi';
+import { createLogger } from 'winston';
 
 jest.mock('../utils', () => ({ dtFetch: jest.fn() }));
 
@@ -58,10 +59,12 @@ describe('dynatraceApi', () => {
     name: 'myEnv',
     accountUrn: 'urn',
   };
-  const dynatraceApi = new DynatraceApi(defaultApiConfig, 'identifier');
+  const logger = createLogger();
+  const dynatraceApi = new DynatraceApi(defaultApiConfig, 'identifier', logger);
   const trailingSlashApi = new DynatraceApi(
     { ...defaultApiConfig, url: 'https://example.com/' },
     'identifier',
+    logger,
   );
 
   const mockTokenResult = (result: MockResult<TokenResponse>) =>

plugins/dql-backend/src/service/dynatraceApi.test.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { dtFetch } from '../utils';
-import { getRootLogger } from '@backstage/backend-common';
+import { LoggerService } from '@backstage/backend-plugin-api';
 import { TabularData } from '@dynatrace/backstage-plugin-dql-common';
 
 export type DynatraceEnvironmentConfig = {
@@ -59,7 +59,6 @@ export type PollQueryResponse<RecordType> = {
   };
 };
 
-const logger = getRootLogger().child({ plugin: 'dql-backend' });
 const DEFAULT_TOKEN_URL = 'https://sso.dynatrace.com/sso/oauth2/token';
 
 const executeQuery = async (
@@ -84,6 +83,7 @@ const executeQuery = async (
 const pollQuery = async <T>(
   { url, accessToken, identifier }: DynatraceAccessInfo,
   requestToken: string,
+  logger: LoggerService,
 ): Promise<PollQueryResponse<T>> => {
   const fullUrl = new URL('platform/storage/query/v1/query:poll', url);
   fullUrl.searchParams.set('request-token', requestToken);
@@ -105,20 +105,23 @@ const pollQuery = async <T>(
 const waitForQueryResult = async <RecordType>(
   accessInfo: DynatraceAccessInfo,
   requestToken: string,
+  logger: LoggerService,
 ): Promise<RecordType[]> => {
   let pollQueryRes: PollQueryResponse<RecordType> = await pollQuery(
     accessInfo,
     requestToken,
+    logger,
   );
   while (pollQueryRes.state !== 'SUCCEEDED') {
-    pollQueryRes = await pollQuery(accessInfo, requestToken);
+    pollQueryRes = await pollQuery(accessInfo, requestToken, logger);
   }
   return pollQueryRes.result.records;
 };
 
 const getAccessToken = async (
   config: DynatraceEnvironmentConfig,
   identifier: string,
+  logger: LoggerService,
 ): Promise<TokenResponse> => {
   const body = new URLSearchParams({
     grant_type: 'client_credentials',
@@ -152,6 +155,7 @@ export class DynatraceApi {
   constructor(
     private readonly config: DynatraceEnvironmentConfig,
     private identifier: string,
+    private logger: LoggerService,
   ) {}
 
   get environmentName() {
@@ -163,14 +167,22 @@ export class DynatraceApi {
   }
 
   async executeDqlQuery(query: string): Promise<TabularData> {
-    const tokenResponse = await getAccessToken(this.config, this.identifier);
+    const tokenResponse = await getAccessToken(
+      this.config,
+      this.identifier,
+      this.logger,
+    );
     const environment: DynatraceAccessInfo = {
       url: this.config.url,
       accessToken: tokenResponse.access_token,
       identifier: this.identifier,
     };
 
     const execQueryRes = await executeQuery(environment, query);
-    return await waitForQueryResult(environment, execQueryRes.requestToken);
+    return await waitForQueryResult(
+      environment,
+      execQueryRes.requestToken,
+      this.logger,
+    );
   }
 }

plugins/dql-backend/src/service/dynatraceApi.ts

@@ -14,16 +14,16 @@
  * limitations under the License.
  */
 import { RouterOptions, createRouter } from './router';
-import { getVoidLogger } from '@backstage/backend-common';
 import { MockConfigApi } from '@backstage/test-utils';
 import express from 'express';
+import { createLogger } from 'winston';
 
 describe('createRouter', () => {
   let app: express.Express;
 
   beforeAll(async () => {
     const router = await createRouter({
-      logger: getVoidLogger(),
+      logger: createLogger(),
       discovery: {
         async getBaseUrl(): Promise<string> {
           return '';

plugins/dql-backend/src/service/router.test.ts

@@ -16,11 +16,8 @@
 import { parseCustomQueries, parseEnvironments } from '../utils/configParser';
 import { getEntityFromRequest, validateQueries } from '../utils/routeUtils';
 import { QueryExecutor } from './queryExecutor';
-import {
-  createLegacyAuthAdapters,
-  errorHandler,
-} from '@backstage/backend-common';
-import { PluginEndpointDiscovery } from '@backstage/backend-common';
+import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';
+import { DiscoveryService } from '@backstage/backend-plugin-api';
 import { LoggerService, AuthService } from '@backstage/backend-plugin-api';
 import { CatalogClient } from '@backstage/catalog-client';
 import { Config } from '@backstage/config';
@@ -31,22 +28,16 @@ import Router from 'express-promise-router';
 export interface RouterOptions {
   logger: LoggerService;
   config: Config;
-  discovery: PluginEndpointDiscovery;
-  auth?: AuthService;
+  discovery: DiscoveryService;
+  auth: AuthService;
 }
 
 export const createRouter = async (
   options: RouterOptions,
 ): Promise<express.Router> => {
-  // In order to make the new auth services available to the plugin
-  // implementation in a backwards compatible way, we use the
-  // createLegacyAuthAdapters helper from @backstage/backend-common.
-  // Ref: https://backstage.io/docs/tutorials/auth-service-migration/#making-the-new-auth-services-available-in-createrouter
-  const { auth } = createLegacyAuthAdapters(options);
+  const { config, discovery, logger, auth } = options;
 
-  const { config, discovery } = options;
-
-  const apis = parseEnvironments(config);
+  const apis = parseEnvironments(config, logger);
   const customQueries = parseCustomQueries(config);
   const queryExecutor = new QueryExecutor(apis, customQueries);
   const catalogClient = new CatalogClient({ discoveryApi: discovery });
@@ -86,6 +77,6 @@ export const createRouter = async (
     res.json(deployments);
   });
 
-  router.use(errorHandler());
+  router.use(MiddlewareFactory.create({ logger, config }).error());
   return router;
 };

plugins/dql-backend/src/service/router.ts

@@ -15,6 +15,7 @@
  */
 import { parseCustomQueries, parseEnvironments } from './configParser';
 import { MockConfigApi } from '@backstage/test-utils';
+import { createLogger } from 'winston';
 
 const TEST_ENVIRONMENT = {
   name: 'test',
@@ -25,13 +26,15 @@ const TEST_ENVIRONMENT = {
   accountUrn: 'test',
 };
 
+const logger = createLogger();
+
 describe('config-parser', () => {
   describe('parseEnvironments', () => {
     it('should return a list of DynatraceApis with the corresponding config', () => {
       const config = new MockConfigApi({
         dynatrace: { environments: [TEST_ENVIRONMENT] },
       });
-      const result = parseEnvironments(config);
+      const result = parseEnvironments(config, logger);
 
       expect(result).toHaveLength(1);
       const api = result[0];
@@ -46,7 +49,7 @@ describe('config-parser', () => {
           environments: [{ ...TEST_ENVIRONMENT, url: 'https://example' }],
         },
       });
-      const result = parseEnvironments(config);
+      const result = parseEnvironments(config, logger);
       const api = result[0];
       expect(Reflect.get(api, 'identifier')).toEqual(btoa('unknown'));
     });
@@ -55,7 +58,7 @@ describe('config-parser', () => {
       const config = new MockConfigApi({
         dynatrace: { environments: [{ ...TEST_ENVIRONMENT, url: '' }] },
       });
-      const result = parseEnvironments(config);
+      const result = parseEnvironments(config, logger);
       const api = result[0];
       expect(Reflect.get(api, 'identifier')).toEqual(btoa('unknown'));
     });

plugins/dql-backend/src/service/standaloneServer.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 import { DynatraceApi, DynatraceEnvironmentConfig } from '../service';
+import { LoggerService } from '@backstage/backend-plugin-api';
 import { Config } from '@backstage/config';
 
 const defaultId = 'unknown';
@@ -35,13 +36,20 @@ const getIdentifier = (configArray: Config[]) => {
   );
 };
 
-export const parseEnvironments = (config: Config): DynatraceApi[] => {
+export const parseEnvironments = (
+  config: Config,
+  logger: LoggerService,
+): DynatraceApi[] => {
   const configArray = config.getConfigArray('dynatrace.environments');
 
   const identifier = getIdentifier(configArray);
   return configArray.map(
     envConfig =>
-      new DynatraceApi(envConfig.get<DynatraceEnvironmentConfig>(), identifier),
+      new DynatraceApi(
+        envConfig.get<DynatraceEnvironmentConfig>(),
+        identifier,
+        logger,
+      ),
   );
 };