[Saved Objects] Browser-side client deprecation notice #148979
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…om common with deprecation notice for now
jloleysens
changed the title
jloleysens
added
Team:Core
|
Pinging @elastic/kibana-core (Team:Core) |
packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_create.ts
Outdated
Show resolved
Hide resolved
| type: string; | ||
| id: string; | ||
| } | ||
| import * as serverTypes from './will_move_to_server'; |
There was a problem hiding this comment.
Prefer named imports/exports, especially in packages.
There was a problem hiding this comment.
I think there are a few reasons why it is OK to break convention in this case:
- We are not
*exporting: we are still selectively exposing a set of types for public use - A namespace serves the function of
asing, but in a more efficient way in this instance (IMO) - I expect this code will change/be removed soon anyway (once we remove the SO client from browsers)
Happy to revisit if you feel strongly!
| * @public | ||
| * @deprecated See https://github.com/elastic/dev/issues/2194 | ||
| */ | ||
| export type SavedObjectAttributeSingle = serverTypes.SavedObjectAttributeSingle; |
There was a problem hiding this comment.
Honestly, I'm not a fan of this syntax. Using named imports:
import {
SavedObjectAttributeSingle as LegacySavedObjectAttributeSingle,
SavedObjectAttribute as LegacySavedObjectAttribute,
SavedObjectAttributes as LegacySavedObjectAttributes,
SavedObjectReference as LegacySavedObjectReference,
SavedObject as LegacySavedObject,
} from './will_move_to_server';
allows us to use export type SavedObjectAttributeSingle = LegacySavedObjectAttributeSingle;
There was a problem hiding this comment.
Same response as #148979 (comment) :)
packages/core/saved-objects/core-saved-objects-common/src/will_move_to_server.ts
Outdated
Show resolved
Hide resolved
💚 Build Succeeded
Metrics [docs]Public APIs missing comments
Unknown metric groupsAPI count
References to deprecated APIs
Unreferenced deprecated APIs
History
To update your PR or re-run it, just comment with: |
wayneseymour
pushed a commit
to wayneseymour/kibana
that referenced
this pull request
Jan 19, 2023
## Summary In the near future we will remove Saved Object (SO) HTTP APIs. This PR deprecates all browser-side SO types and interfaces. General comments on the approach taken here: * Add a deprecation notice that links to a GitHub issue that can be referenced by all teams * Do not break existing imports/exports * Mocks are also an indication of SO browser-side use, added deprecation notices * Some common types must also be deprecated, some may remain. For those to be removed they are moved to a separate file, with a deprecated type-alias re-exported ## Notes to reviewers * Easiest way to get an overview of the changes is to have the file-tree open in the "Files changed" view * Are there any other ways browser-side code can get knowledge of Saved Objects? * Please go through some client code and test that the DX is working as expected (the GitHub issue is discoverable) ## Related * elastic#147150 * elastic/dev#2194 Co-authored-by: kibanamachine <[email protected]>
|
Ref #149288 |
jloleysens
added a commit
that referenced
this pull request
Jan 25, 2023
… avoid deprecation (#149289) ## Summary After merging #148979 there are a number of imports that can be fixed immediately to address our new deprecation notice. ## To Core reviewers The package `core-saved-objects-server` is using types from `core-saved-objects-api-server` which creates a circular dependency when using `SavedObject` type from it's new home in `core-saved-object-server`: `core-saved-objects-server` -> `core-saved-objects-api-server` -> `core-saved-objects-server` One solution is that we can create a new package `packages/core/saved-objects/core-saved-objects-server-shared` that will only hold the `SavedObject` type and a select few others. I'm not sure what the best approach here is. I have left `core-saved-objects-api-server` unchanged for now (i.e., it is still importing `SavedObject` from `common` which is deprecated). Any input would be greatly appreciated! Co-authored-by: kibanamachine <[email protected]>
|
@jloleysens We forgot to update the docs when deprecating the APIs: https://www.elastic.co/guide/en/kibana/8.6/saved-objects-service.html#_client_side_usage_2 |
This was referenced Jan 31, 2023
1 task
jloleysens
added a commit
that referenced
this pull request
Feb 15, 2023
) ## Summary After merging #148979 there are a few interfaces in the server-side code that export a reference to a deprecated SO type. In this PR we fix them by updating a few imports to use the non-deprecated SO type. Additionally, we resolve a potential circular reference issue between `core-saved-objects-server` and `core-saved-objects-api-server` by "moving" saved objects and related types exports to `core-saved-objects-api-server`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
In the near future we will remove Saved Object (SO) HTTP APIs. This PR deprecates all browser-side SO types and interfaces.
General notes on the approach taken:
Notes to reviewers
Related