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

chore(propagator-grpc-cencus-binary): archive package #2201

Conversation

pichlermarc
Copy link
Member

@pichlermarc pichlermarc commented May 13, 2024

Which problem is this PR solving?

  • We've not had any changes to this package for a while. grpc has been deprecated since 2021. I propose we deprecate/archive the propagator to enable feat: support node 20 #2169, where this package is causing a build failure. This will also help contributors on macOS (on ARM) where it seems like the package needs to build the native grpc library every time it is pulled as no pre-built version is included.

@pichlermarc pichlermarc requested a review from a team as a code owner May 13, 2024 11:02
Copy link

codecov bot commented May 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.37%. Comparing base (dfb2dff) to head (a72380b).
Report is 111 commits behind head on main.

❗ Current head a72380b differs from pull request most recent head 706bce1. Consider uploading reports for the commit 706bce1 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2201      +/-   ##
==========================================
- Coverage   90.97%   90.37%   -0.61%     
==========================================
  Files         146      147       +1     
  Lines        7492     7500       +8     
  Branches     1502     1569      +67     
==========================================
- Hits         6816     6778      -38     
- Misses        676      722      +46     

see 38 files with indirect coverage changes

Copy link
Member

@blumamir blumamir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I support deprecating it.

Regarding moving the files to archieve, the one and only project there states that:

This project has been archived by the maintainers on August 3 2022 because it was causing a failure in the CI and does not have any maintainer.
Anyone who would like to maintain this project should open a PR to move it back into the lerna project and add themselves to the component owners file.

So I wonder, since we never plan to rejuvenate this package in the future, should we just remove it from the codebase altogether? It can always be picked up from git history if needed, but any reason we should keep the code?

@trentm
Copy link
Contributor

trentm commented May 13, 2024

So I wonder, since we never plan to rejuvenate this package in the future, should we just remove it from the codebase altogether?

I was going to say that it would be nice to update the npmjs.com page for this package to clarify where the source went, then... but I can't find any published-to-npm versions for that package name:

% npm info @opentelemetry/browser-extension-autoinjection
npm ERR! code E404
npm ERR! 404 Not Found - GET https://registry.npmjs.org/@opentelemetry%2fbrowser-extension-autoinjection - Not found
npm ERR! 404
npm ERR! 404  '@opentelemetry/browser-extension-autoinjection@*' is not in this registry.
...

Anyway, handling the browser-extension-autoinjection package is a separate issue.

Copy link
Contributor

@trentm trentm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Woot. Thanks, Marc.

Can we also add a deprecation message to the package per https://docs.npmjs.com/deprecating-and-undeprecating-packages-or-package-versions ?

@trentm
Copy link
Contributor

trentm commented May 13, 2024

Some background and motivation for this PR are here: #2169 (comment)

@pichlermarc
Copy link
Member Author

I support deprecating it.

Regarding moving the files to archieve, the one and only project there states that:

This project has been archived by the maintainers on August 3 2022 because it was causing a failure in the CI and does not have any maintainer.
Anyone who would like to maintain this project should open a PR to move it back into the lerna project and add themselves to the component owners file.

So I wonder, since we never plan to rejuvenate this package in the future, should we just remove it from the codebase altogether? It can always be picked up from git history if needed, but any reason we should keep the code?

I think removing it is also okay. I'd keep it around for a bit and then remove it when there's no activity for one month or so after we mark it as deprecated in npm, we can remove it. I'll open a follow-up issue to track it.

Can we also add a deprecation message to the package per https://docs.npmjs.com/deprecating-and-undeprecating-packages-or-package-versions ?

Yep, I'll do that.

@pichlermarc pichlermarc merged commit fd51c1c into open-telemetry:main May 14, 2024
13 checks passed
@pichlermarc pichlermarc deleted the chore/retire-propagator-grpc-cencus-binary branch May 14, 2024 11:56
@trentm
Copy link
Contributor

trentm commented May 14, 2024

This is a big win. No need to add --ignore-scripts everytime I run npm ci for local dev now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants