backend-plugin-api: loggerToWinstonLogger refactor

Co-authored-by: Johan Haals <johan.haals@gmail.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

packages/backend-plugin-api/src/index.ts

@@ -20,6 +20,5 @@
  * @packageDocumentation
  */
 
+export * from './services';
 export * from './wiring';
-export * from './services/system/types';
-export * from './services/definitions';

packages/backend-plugin-api/src/services/helpers/index.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2022 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.
+ */
+
+export { loggerToWinstonLogger } from './loggerToWinstonLogger';

packages/backend-plugin-api/src/services/helpers/loggerToWinstonLogger.ts

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2022 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 { Logger as BackstageLogger } from '../definitions';
+import { Logger as WinstonLogger, createLogger } from 'winston';
+import Transport, { TransportStreamOptions } from 'winston-transport';
+
+class BackstageLoggerTransport extends Transport {
+  constructor(
+    private readonly backstageLogger: BackstageLogger,
+    opts?: TransportStreamOptions,
+  ) {
+    super(opts);
+  }
+
+  log(info: { message: string }, callback: VoidFunction) {
+    // TODO: add support for levels and fields
+    this.backstageLogger.info(info.message);
+    callback();
+  }
+}
+
+export function loggerToWinstonLogger(
+  logger: BackstageLogger,
+  opts?: TransportStreamOptions,
+): WinstonLogger {
+  return createLogger({
+    transports: [new BackstageLoggerTransport(logger, opts)],
+  });
+}

packages/backend-plugin-api/src/services/index.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2022 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.
+ */
+
+export * from './definitions';
+export * from './helpers';
+export * from './system';

packages/backend-plugin-api/src/services/system/index.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2022 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.
+ */
+
+export type {
+  ServiceRef,
+  TypesToServiceRef,
+  DepsToDepFactories,
+  FactoryFunc,
+  ServiceFactory,
+  AnyServiceFactory,
+} from './types';
+export { createServiceRef, createServiceFactory } from './types';