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
refactor: Remove more deprecated telemetry types from core-interfaces #19752
Open
alexvy86
wants to merge
7
commits into
microsoft:main
Choose a base branch
from
alexvy86:remove-more-telemetry-from-core-interfaces
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
refactor: Remove more deprecated telemetry types from core-interfaces #19752
alexvy86
wants to merge
7
commits into
microsoft:main
from
alexvy86:remove-more-telemetry-from-core-interfaces
+205
−268
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
|
/azp run Build - client packages |
|
/azp run repo-policy-check |
|
Azure Pipelines successfully started running 1 pipeline(s). |
1 similar comment
|
Azure Pipelines successfully started running 1 pipeline(s). |
⯅ @fluid-example/bundle-size-tests: +187 Bytes
Baseline commit: 42ed6d1 |
Josmithr
reviewed
Feb 22, 2024
packages/common/core-interfaces/api-report/core-interfaces.api.md
Outdated
Show resolved
Hide resolved
Josmithr
reviewed
Feb 23, 2024
Josmithr
reviewed
Feb 23, 2024
packages/utils/telemetry-utils/src/test/sampledTelemetryHelper.spec.ts
Outdated
Show resolved
Hide resolved
Josmithr
reviewed
Feb 23, 2024
Josmithr
reviewed
Feb 23, 2024
Josmithr
reviewed
Feb 23, 2024
Josmithr
reviewed
Feb 23, 2024
packages/utils/odsp-doclib-utils/api-report/odsp-doclib-utils.api.md
Outdated
Show resolved
Hide resolved
Josmithr
reviewed
Feb 23, 2024
Josmithr
approved these changes
Feb 23, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1 documentation suggestion, and I sort of randomly suggested changing some import statements to be type-only - take them or leave them :)
Otherwise, looks good to me!
Co-authored-by: Joshua Smithrud <54606601+Josmithr@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
area: dds: tree
area: dds
Issues related to distributed data structures
area: driver
Driver related issues
area: loader
Loader related issues
area: odsp-driver
area: runtime
Runtime related issues
base: main
PRs targeted against main branch
public api change
Changes to a public API
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.
Description
Removes the remaining deprecated telemetry-related types from core-interfaces:
ITelemetryProperties(replaced with the publicITelemetryBaseProperties)@fluidframework/telemetry-utilsin the past)TelemetryBaseEventPropertyType)Tagged<TelemetryBaseEventPropertyType>)Breaking Changes
See description above. 3 types have equivalent replacements already available in the package so consumers would only need to update the names of types being imported. 1 type has its replacement in a different package, so consumers would need to change their import to come from the new package (potentially introducing a new dependency; in practice they probably already have this dependency).
Reviewer Guidance
The review process is outlined on this wiki page.
Particular things where I'd like feedback:
ITaggedTelemetryPropertyTypewas internal but its replacementTagged<TelemetryBaseEventPropertyType>is public. I think that's correct because consumers need to support tagged properties in telemetry events.TelemetryEventPropertyTypewas public and its replacement/equivalentTelemetryBaseEventPropertyTypewas alpha, but with the replacement became public to support all the scenarios where the deprecated type is being used. In particular,ITelemetryBasePropertiesrequires it to be public, which I think is fine.