diff --git a/.changeset/few-mice-study.md b/.changeset/few-mice-study.md new file mode 100644 index 0000000000..57a89cc547 --- /dev/null +++ b/.changeset/few-mice-study.md @@ -0,0 +1,5 @@ +--- +'@backstage/backend-common': patch +--- + +Added `loggerToWinstonLogger`, which was moved from `@backstage/backend-plugin-api`. diff --git a/.changeset/poor-crews-battle.md b/.changeset/poor-crews-battle.md new file mode 100644 index 0000000000..e05391ef5e --- /dev/null +++ b/.changeset/poor-crews-battle.md @@ -0,0 +1,5 @@ +--- +'@backstage/backend-plugin-api': minor +--- + +Moved `loggerToWinstonLogger` to `@backstage/backend-common`. diff --git a/.changeset/ten-peas-grab.md b/.changeset/ten-peas-grab.md new file mode 100644 index 0000000000..c3022bb627 --- /dev/null +++ b/.changeset/ten-peas-grab.md @@ -0,0 +1,19 @@ +--- +'@backstage/plugin-catalog-backend-module-incremental-ingestion': patch +'@backstage/plugin-catalog-backend-module-bitbucket-server': patch +'@backstage/plugin-catalog-backend-module-bitbucket-cloud': patch +'@backstage/plugin-catalog-backend-module-msgraph': patch +'@backstage/plugin-catalog-backend-module-gerrit': patch +'@backstage/plugin-catalog-backend-module-github': patch +'@backstage/plugin-catalog-backend-module-gitlab': patch +'@backstage/plugin-events-backend-module-aws-sqs': patch +'@backstage/plugin-catalog-backend-module-azure': patch +'@backstage/plugin-catalog-backend-module-aws': patch +'@backstage/plugin-scaffolder-backend': patch +'@backstage/backend-app-api': patch +'@backstage/plugin-catalog-backend': patch +'@backstage/plugin-events-backend': patch +'@backstage/plugin-app-backend': patch +--- + +Switched imports of `loggerToWinstonLogger` to `@backstage/backend-common`. diff --git a/packages/backend-app-api/src/services/implementations/configService.ts b/packages/backend-app-api/src/services/implementations/configService.ts index f58a756c64..6bb84aa5a1 100644 --- a/packages/backend-app-api/src/services/implementations/configService.ts +++ b/packages/backend-app-api/src/services/implementations/configService.ts @@ -14,11 +14,13 @@ * limitations under the License. */ -import { loadBackendConfig } from '@backstage/backend-common'; +import { + loadBackendConfig, + loggerToWinstonLogger, +} from '@backstage/backend-common'; import { coreServices, createServiceFactory, - loggerToWinstonLogger, } from '@backstage/backend-plugin-api'; /** @public */ diff --git a/packages/backend-app-api/src/services/implementations/rootLifecycleService.ts b/packages/backend-app-api/src/services/implementations/rootLifecycleService.ts index c4ad4678ba..3797e6ffc5 100644 --- a/packages/backend-app-api/src/services/implementations/rootLifecycleService.ts +++ b/packages/backend-app-api/src/services/implementations/rootLifecycleService.ts @@ -13,10 +13,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ +import { loggerToWinstonLogger } from '@backstage/backend-common'; import { createServiceFactory, coreServices, - loggerToWinstonLogger, LifecycleServiceShutdownHook, RootLifecycleService, } from '@backstage/backend-plugin-api'; diff --git a/packages/backend-app-api/src/services/implementations/tokenManagerService.ts b/packages/backend-app-api/src/services/implementations/tokenManagerService.ts index 6a2d47ae14..025830afc7 100644 --- a/packages/backend-app-api/src/services/implementations/tokenManagerService.ts +++ b/packages/backend-app-api/src/services/implementations/tokenManagerService.ts @@ -17,9 +17,11 @@ import { coreServices, createServiceFactory, - loggerToWinstonLogger, } from '@backstage/backend-plugin-api'; -import { ServerTokenManager } from '@backstage/backend-common'; +import { + loggerToWinstonLogger, + ServerTokenManager, +} from '@backstage/backend-common'; /** @public */ export const tokenManagerFactory = createServiceFactory({ diff --git a/packages/backend-app-api/src/services/implementations/urlReaderService.ts b/packages/backend-app-api/src/services/implementations/urlReaderService.ts index b68be74d8c..758b555d66 100644 --- a/packages/backend-app-api/src/services/implementations/urlReaderService.ts +++ b/packages/backend-app-api/src/services/implementations/urlReaderService.ts @@ -14,11 +14,10 @@ * limitations under the License. */ -import { UrlReaders } from '@backstage/backend-common'; +import { loggerToWinstonLogger, UrlReaders } from '@backstage/backend-common'; import { coreServices, createServiceFactory, - loggerToWinstonLogger, } from '@backstage/backend-plugin-api'; /** @public */ diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md index e8b41e21bb..7e81d40394 100644 --- a/packages/backend-common/api-report.md +++ b/packages/backend-common/api-report.md @@ -29,6 +29,7 @@ import { Knex } from 'knex'; import { KubeConfig } from '@kubernetes/client-node'; import { LoadConfigOptionsRemote } from '@backstage/config-loader'; import { Logger } from 'winston'; +import { LoggerService } from '@backstage/backend-plugin-api'; import { MergeResult } from 'isomorphic-git'; import { DiscoveryService as PluginEndpointDiscovery } from '@backstage/backend-plugin-api'; import { PushResult } from 'isomorphic-git'; @@ -46,6 +47,7 @@ import { SearchOptions } from '@backstage/backend-plugin-api'; import { SearchResponse } from '@backstage/backend-plugin-api'; import { SearchResponseFile } from '@backstage/backend-plugin-api'; import { Server } from 'http'; +import { TransportStreamOptions } from 'winston-transport'; import { UrlReaderService as UrlReader } from '@backstage/backend-plugin-api'; import { V1PodTemplateSpec } from '@kubernetes/client-node'; import * as winston from 'winston'; @@ -515,6 +517,12 @@ export function loadBackendConfig(options: { argv: string[]; }): Promise; +// @public (undocumented) +export function loggerToWinstonLogger( + logger: LoggerService, + opts?: TransportStreamOptions, +): Logger; + // @public export function notFoundHandler(): RequestHandler; diff --git a/packages/backend-common/package.json b/packages/backend-common/package.json index fc131723a7..cb3f4776ae 100644 --- a/packages/backend-common/package.json +++ b/packages/backend-common/package.json @@ -83,6 +83,7 @@ "tar": "^6.1.12", "uuid": "^8.3.2", "winston": "^3.2.1", + "winston-transport": "^4.5.0", "yauzl": "^2.10.0", "yn": "^4.0.0" }, diff --git a/packages/backend-common/src/logging/index.ts b/packages/backend-common/src/logging/index.ts index 4657dd4101..ff2315c51b 100644 --- a/packages/backend-common/src/logging/index.ts +++ b/packages/backend-common/src/logging/index.ts @@ -22,3 +22,4 @@ export { redactWinstonLogLine, } from './rootLogger'; export * from './voidLogger'; +export { loggerToWinstonLogger } from './loggerToWinstonLogger'; diff --git a/packages/backend-plugin-api/src/services/helpers/loggerToWinstonLogger.ts b/packages/backend-common/src/logging/loggerToWinstonLogger.ts similarity index 96% rename from packages/backend-plugin-api/src/services/helpers/loggerToWinstonLogger.ts rename to packages/backend-common/src/logging/loggerToWinstonLogger.ts index 6f435a250a..f15bd5be81 100644 --- a/packages/backend-plugin-api/src/services/helpers/loggerToWinstonLogger.ts +++ b/packages/backend-common/src/logging/loggerToWinstonLogger.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { LoggerService } from '../definitions'; +import { LoggerService } from '@backstage/backend-plugin-api'; import { Logger as WinstonLogger, createLogger } from 'winston'; import Transport, { TransportStreamOptions } from 'winston-transport'; diff --git a/packages/backend-plugin-api/api-report.md b/packages/backend-plugin-api/api-report.md index 9c6ffe6dd5..16f00ad89f 100644 --- a/packages/backend-plugin-api/api-report.md +++ b/packages/backend-plugin-api/api-report.md @@ -7,14 +7,12 @@ import { Config } from '@backstage/config'; import { Handler } from 'express'; -import { Logger } from 'winston'; import { PermissionEvaluator } from '@backstage/plugin-permission-common'; import { PluginCacheManager } from '@backstage/backend-common'; import { PluginDatabaseManager } from '@backstage/backend-common'; import { PluginTaskScheduler } from '@backstage/backend-tasks'; import { Readable } from 'stream'; import { TokenManager } from '@backstage/backend-common'; -import { TransportStreamOptions } from 'winston-transport'; // @public (undocumented) export interface BackendFeature { @@ -201,12 +199,6 @@ export interface LoggerService { warn(message: string, meta?: Error | LogMeta): void; } -// @public (undocumented) -export function loggerToWinstonLogger( - logger: LoggerService, - opts?: TransportStreamOptions, -): Logger; - // @public (undocumented) export type LogMeta = { [name: string]: unknown; diff --git a/packages/backend-plugin-api/package.json b/packages/backend-plugin-api/package.json index 732cfa3858..0719ea8f45 100644 --- a/packages/backend-plugin-api/package.json +++ b/packages/backend-plugin-api/package.json @@ -38,9 +38,7 @@ "@backstage/config": "workspace:^", "@backstage/plugin-permission-common": "workspace:^", "@types/express": "^4.17.6", - "express": "^4.17.1", - "winston": "^3.2.1", - "winston-transport": "^4.5.0" + "express": "^4.17.1" }, "devDependencies": { "@backstage/cli": "workspace:^" diff --git a/packages/backend-plugin-api/src/services/helpers/index.ts b/packages/backend-plugin-api/src/services/helpers/index.ts deleted file mode 100644 index 24336c1af2..0000000000 --- a/packages/backend-plugin-api/src/services/helpers/index.ts +++ /dev/null @@ -1,17 +0,0 @@ -/* - * 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'; diff --git a/packages/backend-plugin-api/src/services/index.ts b/packages/backend-plugin-api/src/services/index.ts index 96bd3d320a..dd24127b88 100644 --- a/packages/backend-plugin-api/src/services/index.ts +++ b/packages/backend-plugin-api/src/services/index.ts @@ -15,5 +15,4 @@ */ export * from './definitions'; -export * from './helpers'; export * from './system'; diff --git a/plugins/app-backend/src/service/appPlugin.ts b/plugins/app-backend/src/service/appPlugin.ts index bfccf3cc02..2c0c73c71b 100644 --- a/plugins/app-backend/src/service/appPlugin.ts +++ b/plugins/app-backend/src/service/appPlugin.ts @@ -18,9 +18,9 @@ import express from 'express'; import { coreServices, createBackendPlugin, - loggerToWinstonLogger, } from '@backstage/backend-plugin-api'; import { createRouter } from './router'; +import { loggerToWinstonLogger } from '@backstage/backend-common'; /** @alpha */ export type AppPluginOptions = { diff --git a/plugins/catalog-backend-module-aws/src/service/AwsS3EntityProviderCatalogModule.ts b/plugins/catalog-backend-module-aws/src/service/AwsS3EntityProviderCatalogModule.ts index fa49d1e4c7..cbc137ab40 100644 --- a/plugins/catalog-backend-module-aws/src/service/AwsS3EntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-aws/src/service/AwsS3EntityProviderCatalogModule.ts @@ -14,10 +14,10 @@ * limitations under the License. */ +import { loggerToWinstonLogger } from '@backstage/backend-common'; import { coreServices, createBackendModule, - loggerToWinstonLogger, } from '@backstage/backend-plugin-api'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node'; import { AwsS3EntityProvider } from '../providers'; diff --git a/plugins/catalog-backend-module-azure/src/service/AzureDevOpsEntityProviderCatalogModule.ts b/plugins/catalog-backend-module-azure/src/service/AzureDevOpsEntityProviderCatalogModule.ts index 0d0ebdb591..bd59cec29b 100644 --- a/plugins/catalog-backend-module-azure/src/service/AzureDevOpsEntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-azure/src/service/AzureDevOpsEntityProviderCatalogModule.ts @@ -14,9 +14,9 @@ * limitations under the License. */ +import { loggerToWinstonLogger } from '@backstage/backend-common'; import { createBackendModule, - loggerToWinstonLogger, coreServices, } from '@backstage/backend-plugin-api'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node'; diff --git a/plugins/catalog-backend-module-bitbucket-cloud/src/service/BitbucketCloudEntityProviderCatalogModule.ts b/plugins/catalog-backend-module-bitbucket-cloud/src/service/BitbucketCloudEntityProviderCatalogModule.ts index 19b83b92b6..d17656a473 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/src/service/BitbucketCloudEntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-bitbucket-cloud/src/service/BitbucketCloudEntityProviderCatalogModule.ts @@ -14,10 +14,10 @@ * limitations under the License. */ +import { loggerToWinstonLogger } from '@backstage/backend-common'; import { coreServices, createBackendModule, - loggerToWinstonLogger, } from '@backstage/backend-plugin-api'; import { catalogProcessingExtensionPoint, diff --git a/plugins/catalog-backend-module-bitbucket-server/src/service/BitbucketServerEntityProviderCatalogModule.ts b/plugins/catalog-backend-module-bitbucket-server/src/service/BitbucketServerEntityProviderCatalogModule.ts index e0f5a21ff9..46712d29dd 100644 --- a/plugins/catalog-backend-module-bitbucket-server/src/service/BitbucketServerEntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-bitbucket-server/src/service/BitbucketServerEntityProviderCatalogModule.ts @@ -14,10 +14,10 @@ * limitations under the License. */ +import { loggerToWinstonLogger } from '@backstage/backend-common'; import { coreServices, createBackendModule, - loggerToWinstonLogger, } from '@backstage/backend-plugin-api'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node'; import { BitbucketServerEntityProvider } from '../providers'; diff --git a/plugins/catalog-backend-module-gerrit/src/service/GerritEntityProviderCatalogModule.ts b/plugins/catalog-backend-module-gerrit/src/service/GerritEntityProviderCatalogModule.ts index 674845862f..8c61038c8f 100644 --- a/plugins/catalog-backend-module-gerrit/src/service/GerritEntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-gerrit/src/service/GerritEntityProviderCatalogModule.ts @@ -14,10 +14,10 @@ * limitations under the License. */ +import { loggerToWinstonLogger } from '@backstage/backend-common'; import { coreServices, createBackendModule, - loggerToWinstonLogger, } from '@backstage/backend-plugin-api'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node'; import { GerritEntityProvider } from '../providers/GerritEntityProvider'; diff --git a/plugins/catalog-backend-module-github/src/service/GithubEntityProviderCatalogModule.ts b/plugins/catalog-backend-module-github/src/service/GithubEntityProviderCatalogModule.ts index e61543ea13..d9dc0a12aa 100644 --- a/plugins/catalog-backend-module-github/src/service/GithubEntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-github/src/service/GithubEntityProviderCatalogModule.ts @@ -16,9 +16,9 @@ import { createBackendModule, - loggerToWinstonLogger, coreServices, } from '@backstage/backend-plugin-api'; +import { loggerToWinstonLogger } from '@backstage/backend-common'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node'; import { GithubEntityProvider } from '../providers/GithubEntityProvider'; diff --git a/plugins/catalog-backend-module-gitlab/src/service/GitlabDiscoveryEntityProviderCatalogModule.ts b/plugins/catalog-backend-module-gitlab/src/service/GitlabDiscoveryEntityProviderCatalogModule.ts index 75a8de263f..bb4fb656a8 100644 --- a/plugins/catalog-backend-module-gitlab/src/service/GitlabDiscoveryEntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-gitlab/src/service/GitlabDiscoveryEntityProviderCatalogModule.ts @@ -16,9 +16,9 @@ import { createBackendModule, - loggerToWinstonLogger, coreServices, } from '@backstage/backend-plugin-api'; +import { loggerToWinstonLogger } from '@backstage/backend-common'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node'; import { GitlabDiscoveryEntityProvider } from '../providers'; diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/module/WrapperProviders.ts b/plugins/catalog-backend-module-incremental-ingestion/src/module/WrapperProviders.ts index a6cfe14df2..abe4cdb951 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/src/module/WrapperProviders.ts +++ b/plugins/catalog-backend-module-incremental-ingestion/src/module/WrapperProviders.ts @@ -18,8 +18,8 @@ import { ConfigService, LoggerService, SchedulerService, - loggerToWinstonLogger, } from '@backstage/backend-plugin-api'; +import { loggerToWinstonLogger } from '@backstage/backend-common'; import { stringifyError } from '@backstage/errors'; import { EntityProvider, diff --git a/plugins/catalog-backend-module-msgraph/package.json b/plugins/catalog-backend-module-msgraph/package.json index 5bfe4e35ea..4ff9952bc5 100644 --- a/plugins/catalog-backend-module-msgraph/package.json +++ b/plugins/catalog-backend-module-msgraph/package.json @@ -34,6 +34,7 @@ }, "dependencies": { "@azure/identity": "^2.1.0", + "@backstage/backend-common": "workspace:^", "@backstage/backend-plugin-api": "workspace:^", "@backstage/backend-tasks": "workspace:^", "@backstage/catalog-model": "workspace:^", diff --git a/plugins/catalog-backend-module-msgraph/src/service/MicrosoftGraphOrgEntityProviderCatalogModule.ts b/plugins/catalog-backend-module-msgraph/src/service/MicrosoftGraphOrgEntityProviderCatalogModule.ts index 2643e6e937..fc63867a23 100644 --- a/plugins/catalog-backend-module-msgraph/src/service/MicrosoftGraphOrgEntityProviderCatalogModule.ts +++ b/plugins/catalog-backend-module-msgraph/src/service/MicrosoftGraphOrgEntityProviderCatalogModule.ts @@ -17,8 +17,8 @@ import { coreServices, createBackendModule, - loggerToWinstonLogger, } from '@backstage/backend-plugin-api'; +import { loggerToWinstonLogger } from '@backstage/backend-common'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node'; import { GroupTransformer, diff --git a/plugins/catalog-backend/src/service/CatalogPlugin.ts b/plugins/catalog-backend/src/service/CatalogPlugin.ts index 6db54ed4fa..effed7f8f1 100644 --- a/plugins/catalog-backend/src/service/CatalogPlugin.ts +++ b/plugins/catalog-backend/src/service/CatalogPlugin.ts @@ -16,7 +16,6 @@ import { createBackendPlugin, coreServices, - loggerToWinstonLogger, } from '@backstage/backend-plugin-api'; import { CatalogBuilder } from './CatalogBuilder'; import { @@ -25,6 +24,7 @@ import { catalogProcessingExtensionPoint, EntityProvider, } from '@backstage/plugin-catalog-node'; +import { loggerToWinstonLogger } from '@backstage/backend-common'; class CatalogExtensionPointImpl implements CatalogProcessingExtensionPoint { #processors = new Array(); diff --git a/plugins/events-backend-module-aws-sqs/package.json b/plugins/events-backend-module-aws-sqs/package.json index 62e897a42e..c01c706f67 100644 --- a/plugins/events-backend-module-aws-sqs/package.json +++ b/plugins/events-backend-module-aws-sqs/package.json @@ -24,6 +24,7 @@ }, "dependencies": { "@aws-sdk/client-sqs": "^3.208.0", + "@backstage/backend-common": "workspace:^", "@backstage/backend-plugin-api": "workspace:^", "@backstage/backend-tasks": "workspace:^", "@backstage/config": "workspace:^", diff --git a/plugins/events-backend-module-aws-sqs/src/service/AwsSqsConsumingEventPublisherEventsModule.ts b/plugins/events-backend-module-aws-sqs/src/service/AwsSqsConsumingEventPublisherEventsModule.ts index a6c43d4046..50812f321b 100644 --- a/plugins/events-backend-module-aws-sqs/src/service/AwsSqsConsumingEventPublisherEventsModule.ts +++ b/plugins/events-backend-module-aws-sqs/src/service/AwsSqsConsumingEventPublisherEventsModule.ts @@ -17,8 +17,8 @@ import { coreServices, createBackendModule, - loggerToWinstonLogger, } from '@backstage/backend-plugin-api'; +import { loggerToWinstonLogger } from '@backstage/backend-common'; import { eventsExtensionPoint } from '@backstage/plugin-events-node'; import { AwsSqsConsumingEventPublisher } from '../publisher/AwsSqsConsumingEventPublisher'; diff --git a/plugins/events-backend/src/service/EventsPlugin.ts b/plugins/events-backend/src/service/EventsPlugin.ts index 63d0d0b02a..29456d71f7 100644 --- a/plugins/events-backend/src/service/EventsPlugin.ts +++ b/plugins/events-backend/src/service/EventsPlugin.ts @@ -17,8 +17,8 @@ import { createBackendPlugin, coreServices, - loggerToWinstonLogger, } from '@backstage/backend-plugin-api'; +import { loggerToWinstonLogger } from '@backstage/backend-common'; import { EventBroker, EventPublisher, diff --git a/plugins/scaffolder-backend/src/ScaffolderPlugin.ts b/plugins/scaffolder-backend/src/ScaffolderPlugin.ts index 8a9da38bf2..5d4c16e2dc 100644 --- a/plugins/scaffolder-backend/src/ScaffolderPlugin.ts +++ b/plugins/scaffolder-backend/src/ScaffolderPlugin.ts @@ -16,9 +16,9 @@ import { createBackendPlugin, coreServices, - loggerToWinstonLogger, createExtensionPoint, } from '@backstage/backend-plugin-api'; +import { loggerToWinstonLogger } from '@backstage/backend-common'; import { ScmIntegrations } from '@backstage/integration'; import { catalogServiceRef } from '@backstage/plugin-catalog-node'; import { TemplateFilter, TemplateGlobal } from './lib'; diff --git a/yarn.lock b/yarn.lock index 41202619bc..7cb8c4dcd5 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3466,6 +3466,7 @@ __metadata: tar: ^6.1.12 uuid: ^8.3.2 winston: ^3.2.1 + winston-transport: ^4.5.0 yauzl: ^2.10.0 yn: ^4.0.0 peerDependencies: @@ -3497,8 +3498,6 @@ __metadata: "@backstage/plugin-permission-common": "workspace:^" "@types/express": ^4.17.6 express: ^4.17.1 - winston: ^3.2.1 - winston-transport: ^4.5.0 languageName: unknown linkType: soft