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

Use API 0.19.0 #2212

Closed
Flarna opened this issue May 19, 2021 · 18 comments
Closed

Use API 0.19.0 #2212

Flarna opened this issue May 19, 2021 · 18 comments
Labels
dependencies Pull requests that update a dependency file enhancement New feature or request

Comments

@Flarna
Copy link
Member

Flarna commented May 19, 2021

API 1.0.0-rc.1 has been released and includes several breaking changes.

We should adapt core to use api 1.0.0-rc.1

Maybe someone started already with this. Please leave a message to avoid double work.

Update: it's API 0.19.0 to target

@Flarna Flarna added feature-request enhancement New feature or request dependencies Pull requests that update a dependency file and removed feature-request labels May 19, 2021
@blumamir
Copy link
Member

Just encountered this issue in my setup.
dependency on "@opentelemetry/api": "^1.0.0-rc.0" no longer works as it now fetches 1.0.0-rc.1

@Flarna
Copy link
Member Author

Flarna commented May 19, 2021

There was a discussion about this, see open-telemetry/opentelemetry-js-api#15

I guess that time no one expected breaking changes like this to happen in the rc phase.

Does this mean the new API release broke a lot user setups?

@Flarna
Copy link
Member Author

Flarna commented May 19, 2021

I start on a PR now.

@Flarna Flarna self-assigned this May 19, 2021
@blumamir
Copy link
Member

Our SDK is currently broken on fresh installations due to this issue.
Any suggestion on how to fix this until new otel SDK packages are published?

@Flarna
Copy link
Member Author

Flarna commented May 19, 2021

Maybe pin the API version in the package.json of your SDK?

@blumamir
Copy link
Member

Maybe pin the API version in the package.json of your SDK?

that works well for otel-sdk packages as they have peer dependency on api, but we also use instrumentations which have caret dependency on "@opentelemetry/api": "^1.0.0-rc.0", and that install new rc version with no option to lock API version to rc.0.

@Flarna
Copy link
Member Author

Flarna commented May 19, 2021

I think at least with npm it should work as pinning 1.0.0-rc.0 at one place is compatible with ^1.0.0-rc.0 at other places and as a result it should de-duplicate it. But maybe other package managers have a different opinion in this. could be also that a leftover package-lock.json has impact here.

@blumamir
Copy link
Member

blumamir commented May 19, 2021

Thanks @Flarna
Tested it with both npm and yarn and couldn't get it to pin the api version used by instrumentation packages. Perhaps it should be a peer dependency in auto-instrumentations packages as well?

@Flarna
Copy link
Member Author

Flarna commented May 19, 2021

I created a PR to pin to 1.0.0-rc.0.
Update to rc.1 is not that simple as it requires at least #2202

@blumamir
Copy link
Member

I created a PR to pin to 1.0.0-rc.0.

Great, thank you.
To my understanding, the issue will still exist for installations that depend on contrib repo (instrumentations). Should we pin or limit the semver range there as well?

@Flarna
Copy link
Member Author

Flarna commented May 19, 2021

I'm also preparing a PR for contrib to pin API.

@blumamir
Copy link
Member

I'm also preparing a PR for contrib to pin API.

Do you plan to change contrib to use peer dependency like core packages? or just pin the api regular dependency to 1.0.0-rc.0?

@Flarna
Copy link
Member Author

Flarna commented May 19, 2021

like in core, see open-telemetry/opentelemetry-js-contrib#491

@dyladan
Copy link
Member

dyladan commented May 19, 2021

We are releasing the old rc.0 as rc.2 to fix users who have depended on carat ranges. We will deprecate all 1.0.0-rc.x versions on npm. New release candidates will be released as 0.x.y versions so that they can follow semver.

@dyladan
Copy link
Member

dyladan commented May 19, 2021

@blumamir I am deeply sorry that I broke your users. Please let me know if there is anything I can do to help mitigate the damage. See above for the remediation steps we have taken so far.

@dyladan
Copy link
Member

dyladan commented May 19, 2021

For details see open-telemetry/opentelemetry-js-api#74

@dyladan
Copy link
Member

dyladan commented May 19, 2021

As far as I know @obecny is already working on the updated core version for the changes. This issue should be changed to reference 0.19.0 as we will be using 0.x.y moving forward.

@Flarna Flarna removed their assignment May 19, 2021
@Flarna Flarna changed the title Use API 1.0.0-rc.1 Use API 0.19.0 May 19, 2021
@vmarchaud
Copy link
Member

We can close this since we released since then both 0.19 and 0.20 :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants