From d94a4771a4065369e68ac658f6dcca5ff24a43d7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Wed, 12 Jun 2024 15:49:57 +0200 Subject: [PATCH] detach backend-common from backend-app-api MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- .changeset/silver-scissors-fold.md | 5 +++++ packages/backend-common/api-report.md | 3 ++- packages/backend-common/package.json | 1 - packages/backend-common/src/config.ts | 3 ++- packages/backend-common/src/discovery/HostDiscovery.ts | 3 ++- packages/backend-common/src/legacy.test.ts | 8 ++++---- packages/backend-common/src/logging/createRootLogger.ts | 3 ++- packages/backend-common/src/middleware/errorHandler.ts | 3 ++- packages/backend-common/src/middleware/notFoundHandler.ts | 3 ++- .../src/middleware/requestLoggingHandler.ts | 3 ++- .../backend-common/src/service/lib/ServiceBuilderImpl.ts | 3 ++- yarn.lock | 1 - 12 files changed, 25 insertions(+), 14 deletions(-) create mode 100644 .changeset/silver-scissors-fold.md diff --git a/.changeset/silver-scissors-fold.md b/.changeset/silver-scissors-fold.md new file mode 100644 index 0000000000..d562b35d3c --- /dev/null +++ b/.changeset/silver-scissors-fold.md @@ -0,0 +1,5 @@ +--- +'@backstage/backend-common': patch +--- + +Removed the circular dependency on `@backstage/backend-app-api` diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md index 977809071b..615e26b24c 100644 --- a/packages/backend-common/api-report.md +++ b/packages/backend-common/api-report.md @@ -32,7 +32,6 @@ import { GithubCredentialsProvider } from '@backstage/integration'; import { GithubIntegration } from '@backstage/integration'; import { GitLabIntegration } from '@backstage/integration'; import { HarnessIntegration } from '@backstage/integration'; -import { HostDiscovery as HostDiscovery_2 } from '@backstage/backend-app-api'; import { HttpAuthService } from '@backstage/backend-plugin-api'; import { IdentityService } from '@backstage/backend-plugin-api'; import { isChildPath as isChildPath_2 } from '@backstage/backend-plugin-api'; @@ -365,6 +364,8 @@ export const GitlabUrlReader: typeof GitlabUrlReader_2; // @public @deprecated (undocumented) export const HarnessUrlReader: typeof HarnessUrlReader_2; +// Warning: (ae-forgotten-export) The symbol "HostDiscovery_2" needs to be exported by the entry point index.d.ts +// // @public @deprecated export const HostDiscovery: typeof HostDiscovery_2; diff --git a/packages/backend-common/package.json b/packages/backend-common/package.json index 0cc440e56d..847fefa697 100644 --- a/packages/backend-common/package.json +++ b/packages/backend-common/package.json @@ -59,7 +59,6 @@ "@aws-sdk/client-s3": "^3.350.0", "@aws-sdk/credential-providers": "^3.350.0", "@aws-sdk/types": "^3.347.0", - "@backstage/backend-app-api": "workspace:^", "@backstage/backend-dev-utils": "workspace:^", "@backstage/backend-plugin-api": "workspace:^", "@backstage/cli-common": "workspace:^", diff --git a/packages/backend-common/src/config.ts b/packages/backend-common/src/config.ts index 1dfa9643e2..733cd62390 100644 --- a/packages/backend-common/src/config.ts +++ b/packages/backend-common/src/config.ts @@ -14,10 +14,11 @@ * limitations under the License. */ +// eslint-disable-next-line @backstage/no-relative-monorepo-imports import { createConfigSecretEnumerator, loadBackendConfig as newLoadBackendConfig, -} from '@backstage/backend-app-api'; +} from '../../backend-app-api/src/config'; import { LoggerService } from '@backstage/backend-plugin-api'; import { AppConfig, Config } from '@backstage/config'; import { LoadConfigOptionsRemote } from '@backstage/config-loader'; diff --git a/packages/backend-common/src/discovery/HostDiscovery.ts b/packages/backend-common/src/discovery/HostDiscovery.ts index 77810b7f6d..ec8d02cce0 100644 --- a/packages/backend-common/src/discovery/HostDiscovery.ts +++ b/packages/backend-common/src/discovery/HostDiscovery.ts @@ -14,7 +14,8 @@ * limitations under the License. */ -import { HostDiscovery as _HostDiscovery } from '@backstage/backend-app-api'; +// eslint-disable-next-line @backstage/no-relative-monorepo-imports +import { HostDiscovery as _HostDiscovery } from '../../../backend-defaults/src/entrypoints/discovery/HostDiscovery'; import { DiscoveryService } from '@backstage/backend-plugin-api'; /** diff --git a/packages/backend-common/src/legacy.test.ts b/packages/backend-common/src/legacy.test.ts index 1ddebce5c4..09545daef4 100644 --- a/packages/backend-common/src/legacy.test.ts +++ b/packages/backend-common/src/legacy.test.ts @@ -23,10 +23,10 @@ import { EventEmitter } from 'events'; import { Router } from 'express'; import { createLegacyAuthAdapters } from './auth'; import { legacyPlugin } from './legacy'; -import { - authServiceFactory, - tokenManagerServiceFactory, -} from '@backstage/backend-app-api'; +// eslint-disable-next-line @backstage/no-relative-monorepo-imports +import { authServiceFactory } from '../../backend-app-api/src/services/implementations/auth'; +// eslint-disable-next-line @backstage/no-relative-monorepo-imports +import { tokenManagerServiceFactory } from '../../backend-app-api/src/services/implementations/tokenManager'; describe('legacyPlugin', () => { it('can auth across the new and old systems', async () => { diff --git a/packages/backend-common/src/logging/createRootLogger.ts b/packages/backend-common/src/logging/createRootLogger.ts index 16554750ef..99dc052382 100644 --- a/packages/backend-common/src/logging/createRootLogger.ts +++ b/packages/backend-common/src/logging/createRootLogger.ts @@ -14,7 +14,8 @@ * limitations under the License. */ -import { WinstonLogger } from '@backstage/backend-app-api'; +// eslint-disable-next-line @backstage/no-relative-monorepo-imports +import { WinstonLogger } from '../../../backend-app-api/src/logging/WinstonLogger'; import { merge } from 'lodash'; import * as winston from 'winston'; import { format, LoggerOptions } from 'winston'; diff --git a/packages/backend-common/src/middleware/errorHandler.ts b/packages/backend-common/src/middleware/errorHandler.ts index 110734b0a2..346fe01645 100644 --- a/packages/backend-common/src/middleware/errorHandler.ts +++ b/packages/backend-common/src/middleware/errorHandler.ts @@ -18,7 +18,8 @@ import { ErrorRequestHandler } from 'express'; import { LoggerService } from '@backstage/backend-plugin-api'; import { getRootLogger } from '../logging'; import { ConfigReader } from '@backstage/config'; -import { MiddlewareFactory } from '@backstage/backend-app-api'; +// eslint-disable-next-line @backstage/no-relative-monorepo-imports +import { MiddlewareFactory } from '../../../backend-app-api/src/http/MiddlewareFactory'; /** * Options passed to the {@link errorHandler} middleware. diff --git a/packages/backend-common/src/middleware/notFoundHandler.ts b/packages/backend-common/src/middleware/notFoundHandler.ts index 4f29b4f824..fe30590863 100644 --- a/packages/backend-common/src/middleware/notFoundHandler.ts +++ b/packages/backend-common/src/middleware/notFoundHandler.ts @@ -14,7 +14,8 @@ * limitations under the License. */ -import { MiddlewareFactory } from '@backstage/backend-app-api'; +// eslint-disable-next-line @backstage/no-relative-monorepo-imports +import { MiddlewareFactory } from '../../../backend-app-api/src/http/MiddlewareFactory'; import { ConfigReader } from '@backstage/config'; import { RequestHandler } from 'express'; import { getRootLogger } from '../logging'; diff --git a/packages/backend-common/src/middleware/requestLoggingHandler.ts b/packages/backend-common/src/middleware/requestLoggingHandler.ts index 81dfa1d345..fd6973f9b6 100644 --- a/packages/backend-common/src/middleware/requestLoggingHandler.ts +++ b/packages/backend-common/src/middleware/requestLoggingHandler.ts @@ -14,7 +14,8 @@ * limitations under the License. */ -import { MiddlewareFactory } from '@backstage/backend-app-api'; +// eslint-disable-next-line @backstage/no-relative-monorepo-imports +import { MiddlewareFactory } from '../../../backend-app-api/src/http/MiddlewareFactory'; import { RequestHandler } from 'express'; import { LoggerService } from '@backstage/backend-plugin-api'; import { getRootLogger } from '../logging'; diff --git a/packages/backend-common/src/service/lib/ServiceBuilderImpl.ts b/packages/backend-common/src/service/lib/ServiceBuilderImpl.ts index f577017b77..039a9a51eb 100644 --- a/packages/backend-common/src/service/lib/ServiceBuilderImpl.ts +++ b/packages/backend-common/src/service/lib/ServiceBuilderImpl.ts @@ -30,13 +30,14 @@ import { requestLoggingHandler as defaultRequestLoggingHandler, } from '../../middleware'; import { RequestLoggingHandlerFactory, ServiceBuilder } from '../types'; +// eslint-disable-next-line @backstage/no-relative-monorepo-imports import { readCorsOptions, readHelmetOptions, readHttpServerOptions, HttpServerOptions, createHttpServer, -} from '@backstage/backend-app-api'; +} from '../../../../backend-app-api/src/http'; export type CspOptions = Record; diff --git a/yarn.lock b/yarn.lock index cf3b76d3ce..e699a5656a 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3514,7 +3514,6 @@ __metadata: "@aws-sdk/credential-providers": ^3.350.0 "@aws-sdk/types": ^3.347.0 "@aws-sdk/util-stream-node": ^3.350.0 - "@backstage/backend-app-api": "workspace:^" "@backstage/backend-dev-utils": "workspace:^" "@backstage/backend-plugin-api": "workspace:^" "@backstage/backend-test-utils": "workspace:^"