Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extract all service helpers and types from backend-common to the backend-plugin-api #24606

Closed
Tracked by #24493
camilaibs opened this issue May 3, 2024 · 1 comment · Fixed by #24757
Closed
Tracked by #24493
Assignees
Labels
area:core Related to the Core Backstage Framework backend

Comments

@camilaibs
Copy link
Contributor

Context

Ref: #24493

In preparation for the new backend system stable release, we will deprecate the backend-common package.

Description

All service helpers and types currently exported from the backend-common package should be extracted to backend-plugin-api package.

Note

The decision was proposed in this Spike.

Acceptance criteria

  • Types and helpers should be consumable by the app and plugins without causing cyclical dependencies
  • Extracted code should be re-exported from the new module in the old package
  • Deprecation exports in the old packages must be declared in a deprecated.ts file
  • Deprecation exports should be annotated with @deprecated and contain a comment explaining their replacements
  • Other packages' import statements should be updated to use bindings from the new package
  • Documentation examples should be revisited to use code from the new package instead
@camilaibs
Copy link
Contributor Author

camilaibs commented May 10, 2024

These are a few of the helpers to extract:

  • Database:
    createDatabaseClient, dropDatabase, ensureDatabaseExists, isDatabaseConflictError
  • Logger:
    coloredFormat, redactWinstonLogLine

@camilaibs camilaibs added merge-after-release This is a bit too scary to merge until after the next release backend area:core Related to the Core Backstage Framework and removed merge-after-release This is a bit too scary to merge until after the next release labels May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:core Related to the Core Backstage Framework backend
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant