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

Transfer events and notifications service refs from their plugins to the backend-plugin-api package #24851

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

Comments

@camilaibs
Copy link
Contributor

Context

Ref: #24493

Backend service references are inconsistently provided in core and plugin packages. We intend to use the permissions model, where the service reference resides in the backend-plugin-api, but the default service is implemented in the plugin package.

Description

Similar to permissions, the "events" and "notifications" service references should be extracted to the "coreService" namespace in backend-plugin-api.

Note

There is a related pull request opened, please refer to avoid conflicts.

Acceptance criteria

  • 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
  • The backend-test-utils package should provide a mock and a factory for all core services (e.g. see)
@camilaibs camilaibs added backend area:core Related to the Core Backstage Framework labels May 21, 2024
@github-actions github-actions bot added the area:events Related to the Events Project Area label May 21, 2024
@camilaibs camilaibs removed the area:events Related to the Events Project Area label May 21, 2024
@camilaibs camilaibs assigned camilaibs and unassigned freben May 27, 2024
@camilaibs
Copy link
Contributor Author

Events PR: #24912

@camilaibs
Copy link
Contributor Author

Notifications PR: #24917

@camilaibs
Copy link
Contributor Author

We decided to push back on this and give the events and notifications services more time to be broadly used before moving it into core services.
cc/ @Rugvip

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
2 participants