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

refactor: Remove more deprecated telemetry types from core-interfaces #19752

Merged

Conversation

alexvy86
Copy link
Contributor

@alexvy86 alexvy86 commented Feb 22, 2024

Description

Removes the remaining deprecated telemetry-related types from core-interfaces:

  • ITelemetryProperties (replaced with the public ITelemetryBaseProperties)
  • TelemetryEventCategory (moved to @fluidframework/telemetry-utils in the past)
  • TelemetryEventPropertyType (replaced with the equivalent, now-public TelemetryBaseEventPropertyType)
  • ITaggedTelemetryPropertyType (replaced with the public Tagged<TelemetryBaseEventPropertyType>)

This is basically just a change in type names within our codebase, and removal of the deprecated types from the API surface of core-interfaces, plus corresponding guidance for consumers.

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:

  • ITaggedTelemetryPropertyType was internal but its replacement Tagged<TelemetryBaseEventPropertyType> is public. I think that's correct because consumers need to support tagged properties in telemetry events.

  • TelemetryEventPropertyType was public and its replacement/equivalent TelemetryBaseEventPropertyType was alpha, but with the replacement became public to support all the scenarios where the deprecated type is being used. In particular, ITelemetryBaseProperties requires it to be public, which I think is fine.

@alexvy86 alexvy86 requested review from a team as code owners February 22, 2024 17:27
@github-actions github-actions bot added area: dds Issues related to distributed data structures area: dds: tree area: driver Driver related issues area: loader Loader related issues area: odsp-driver area: runtime Runtime related issues public api change Changes to a public API labels Feb 22, 2024
@alexvy86 alexvy86 requested review from markfields and a team February 22, 2024 17:27
@github-actions github-actions bot added the base: main PRs targeted against main branch label Feb 22, 2024
@alexvy86
Copy link
Contributor Author

/azp run Build - client packages

@alexvy86
Copy link
Contributor Author

/azp run repo-policy-check

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

1 similar comment
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@msfluid-bot
Copy link
Collaborator

msfluid-bot commented Feb 22, 2024

@fluid-example/bundle-size-tests: +154 Bytes
Metric NameBaseline SizeCompare SizeSize Diff
aqueduct.js 513.7 KB 513.74 KB +44 Bytes
connectionState.js 680 Bytes 680 Bytes No change
containerRuntime.js 247.81 KB 247.83 KB +22 Bytes
loader.js 171.3 KB 171.32 KB +22 Bytes
map.js 46.69 KB 46.7 KB +11 Bytes
matrix.js 148.74 KB 148.74 KB No change
odspDriver.js 97.31 KB 97.33 KB +22 Bytes
odspPrefetchSnapshot.js 42.28 KB 42.29 KB +11 Bytes
sharedString.js 167.32 KB 167.33 KB +11 Bytes
sharedTree.js 334.63 KB 334.63 KB No change
Total Size 1.87 MB 1.87 MB +154 Bytes

Baseline commit: 1a73a3a

Generated by 🚫 dangerJS against 5a12cd6

Copy link
Contributor

@Josmithr Josmithr left a 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!

@alexvy86 alexvy86 enabled auto-merge (squash) February 28, 2024 16:13
@alexvy86 alexvy86 merged commit 615a771 into microsoft:main Feb 28, 2024
31 checks passed
@alexvy86 alexvy86 deleted the remove-more-telemetry-from-core-interfaces branch June 13, 2024 18:30
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants