sonarqube - Removed usages and references of `@backstage/backend-comm…

…on` (#1955) * sonarqube - Removed usages and references of `@backstage/backend-common` Signed-off-by: Andre Wanlin <awanlin@spotify.com> * Added deprecation Signed-off-by: Andre Wanlin <awanlin@spotify.com> * Updated changeset and reports Signed-off-by: Andre Wanlin <awanlin@spotify.com> --------- Signed-off-by: Andre Wanlin <awanlin@spotify.com>
backstage · Nov 18, 2024 · f53852b · f53852b
1 parent 3a74e4b
commit f53852b
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 8 deletions.
diff --git a/workspaces/sonarqube/.changeset/giant-comics-remain.md b/workspaces/sonarqube/.changeset/giant-comics-remain.md
@@ -0,0 +1,7 @@
+---
+'@backstage-community/plugin-sonarqube-backend': patch
+---
+
+Removed usages and references of `@backstage/backend-common`
+
+Deprecated `createRouter` and its router options in favour of the new backend system.
diff --git a/workspaces/sonarqube/packages/backend/package.json b/workspaces/sonarqube/packages/backend/package.json
@@ -22,7 +22,6 @@
   },
   "dependencies": {
     "@backstage-community/plugin-sonarqube-backend": "workspace:^",
-    "@backstage/backend-common": "^0.25.0",
     "@backstage/backend-defaults": "^0.5.2",
     "@backstage/backend-plugin-api": "^1.0.1",
     "@backstage/backend-tasks": "^0.6.1",

diff --git a/workspaces/sonarqube/plugins/sonarqube-backend/package.json b/workspaces/sonarqube/plugins/sonarqube-backend/package.json
@@ -38,7 +38,6 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.25.0",
     "@backstage/backend-defaults": "^0.5.2",
     "@backstage/backend-plugin-api": "^1.0.1",
     "@backstage/config": "^1.2.0",

diff --git a/workspaces/sonarqube/plugins/sonarqube-backend/report.api.md b/workspaces/sonarqube/plugins/sonarqube-backend/report.api.md
@@ -8,7 +8,7 @@ import { Config } from '@backstage/config';
 import express from 'express';
 import { LoggerService } from '@backstage/backend-plugin-api';
 
-// @public
+// @public @deprecated (undocumented)
 export function createRouter(options: RouterOptions): Promise<express.Router>;
 
 // @public
@@ -27,7 +27,7 @@ export class DefaultSonarqubeInfoProvider implements SonarqubeInfoProvider {
   }): Promise<SonarqubeFindings | undefined>;
 }
 
-// @public
+// @public @deprecated (undocumented)
 export interface RouterOptions {
   logger: LoggerService;
   sonarqubeInfoProvider: SonarqubeInfoProvider;

diff --git a/workspaces/sonarqube/plugins/sonarqube-backend/src/service/router.test.ts b/workspaces/sonarqube/plugins/sonarqube-backend/src/service/router.test.ts
@@ -14,12 +14,12 @@
  * limitations under the License.
  */
 
-import { getVoidLogger } from '@backstage/backend-common';
 import express from 'express';
 import request from 'supertest';
 
 import { createRouter } from './router';
 import { SonarqubeFindings } from './sonarqubeInfoProvider';
+import { mockServices } from '@backstage/backend-test-utils';
 
 describe('createRouter', () => {
   let app: express.Express;
@@ -39,7 +39,7 @@ describe('createRouter', () => {
 
   beforeAll(async () => {
     const router = await createRouter({
-      logger: getVoidLogger(),
+      logger: mockServices.rootLogger(),
       sonarqubeInfoProvider: {
         getBaseUrl: getBaseUrlMock,
         getFindings: getFindingsMock,

diff --git a/workspaces/sonarqube/plugins/sonarqube-backend/src/service/router.ts b/workspaces/sonarqube/plugins/sonarqube-backend/src/service/router.ts
@@ -21,6 +21,8 @@ import { InputError } from '@backstage/errors';
 import { LoggerService } from '@backstage/backend-plugin-api';
 
 /**
+ * @deprecated Please migrate to the new backend system as this will be removed in the future.
+ *
  * Dependencies needed by the router
  * @public
  */
@@ -36,6 +38,8 @@ export interface RouterOptions {
 }
 
 /**
+ * @deprecated Please migrate to the new backend system as this will be removed in the future.
+ *
  * @public
  *
  * Constructs a sonarqube router.

diff --git a/workspaces/sonarqube/yarn.lock b/workspaces/sonarqube/yarn.lock
@@ -2637,7 +2637,6 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@backstage-community/plugin-sonarqube-backend@workspace:plugins/sonarqube-backend"
   dependencies:
-    "@backstage/backend-common": ^0.25.0
     "@backstage/backend-defaults": ^0.5.2
     "@backstage/backend-plugin-api": ^1.0.1
     "@backstage/backend-test-utils": ^1.0.2
@@ -13414,7 +13413,6 @@ __metadata:
   resolution: "backend@workspace:packages/backend"
   dependencies:
     "@backstage-community/plugin-sonarqube-backend": "workspace:^"
-    "@backstage/backend-common": ^0.25.0
     "@backstage/backend-defaults": ^0.5.2
     "@backstage/backend-plugin-api": ^1.0.1
     "@backstage/backend-tasks": ^0.6.1