refactor: create a void logger service impl

Signed-off-by: Camila Belo <camilaibs@gmail.com>

packages/backend-app-api/api-report.md

@@ -347,6 +347,22 @@ export const userInfoServiceFactory: () => ServiceFactory<
   'plugin'
 >;
 
+// @public
+export class VoidLogger implements RootLoggerService {
+  // (undocumented)
+  child(_meta: JsonObject): LoggerService;
+  // (undocumented)
+  static create(): VoidLogger;
+  // (undocumented)
+  debug(_message: string, _meta?: JsonObject): void;
+  // (undocumented)
+  error(_message: string, _meta?: JsonObject): void;
+  // (undocumented)
+  info(_message: string, _meta?: JsonObject): void;
+  // (undocumented)
+  warn(_message: string, _meta?: JsonObject): void;
+}
+
 // @public
 export class WinstonLogger implements RootLoggerService {
   // (undocumented)

packages/backend-app-api/src/logging/VoidLogger.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 {
+  LoggerService,
+  RootLoggerService,
+} from '@backstage/backend-plugin-api';
+import { JsonObject } from '@backstage/types';
+
+/**
+ * An empty {@link @backstage/backend-plugin-api#LoggerService} implementation.
+ *
+ * @public
+ */
+export class VoidLogger implements RootLoggerService {
+  static create(): VoidLogger {
+    return new VoidLogger();
+  }
+
+  error(_message: string, _meta?: JsonObject): void {}
+
+  warn(_message: string, _meta?: JsonObject): void {}
+
+  info(_message: string, _meta?: JsonObject): void {}
+
+  debug(_message: string, _meta?: JsonObject): void {}
+
+  child(_meta: JsonObject): LoggerService {
+    return new VoidLogger();
+  }
+}

packages/backend-app-api/src/logging/index.ts

@@ -14,5 +14,6 @@
  * limitations under the License.
  */
 
+export { VoidLogger } from './VoidLogger';
 export { WinstonLogger } from './WinstonLogger';
 export type { WinstonLoggerOptions } from './WinstonLogger';

packages/backend-test-utils/src/next/services/mockServices.ts

@@ -60,7 +60,7 @@ import {
 /** @internal */
 function createLoggerMock() {
   return {
-    child: jest.fn().mockImplementation(() => createLoggerMock()),
+    child: jest.fn().mockImplementation(createLoggerMock),
     debug: jest.fn(),
     error: jest.fn(),
     info: jest.fn(),

plugins/search-backend-module-pg/package.json

@@ -47,6 +47,7 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
+    "@backstage/backend-app-api": "workspace:^",
     "@backstage/backend-common": "workspace:^",
     "@backstage/backend-plugin-api": "workspace:^",
     "@backstage/config": "workspace:^",

plugins/search-backend-module-pg/src/PgSearchEngine/PgSearchEngineIndexer.ts

@@ -14,12 +14,13 @@
  * limitations under the License.
  */
 
-import { getVoidLogger } from '@backstage/backend-common';
+import { loggerToWinstonLogger } from '@backstage/backend-common';
 import { BatchSearchEngineIndexer } from '@backstage/plugin-search-backend-node';
 import { IndexableDocument } from '@backstage/plugin-search-common';
 import { Knex } from 'knex';
 import { Logger } from 'winston';
 import { DatabaseStore } from '../database';
+import { VoidLogger } from '@backstage/backend-app-api';
 
 /** @public */
 export type PgSearchEngineIndexerOptions = {
@@ -41,7 +42,7 @@ export class PgSearchEngineIndexer extends BatchSearchEngineIndexer {
     super({ batchSize: options.batchSize });
     this.store = options.databaseStore;
     this.type = options.type;
-    this.logger = options.logger || getVoidLogger();
+    this.logger = options.logger || loggerToWinstonLogger(VoidLogger.create());
   }
 
   async initialize(): Promise<void> {

yarn.lock

@@ -6933,6 +6933,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@backstage/plugin-search-backend-module-pg@workspace:plugins/search-backend-module-pg"
   dependencies:
+    "@backstage/backend-app-api": "workspace:^"
     "@backstage/backend-common": "workspace:^"
     "@backstage/backend-plugin-api": "workspace:^"
     "@backstage/backend-test-utils": "workspace:^"