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

Stop recording the ecosystem param #7492

Merged
merged 1 commit into from Jul 4, 2023
Merged

Conversation

jeffwidman
Copy link
Member

@jeffwidman jeffwidman commented Jun 27, 2023

I'm starting a broader project to re-think how we instrument the ecosystem (language * package manager) versions.

As part of this, the shape of the data that is sent to the internal API is changing, and the ecosystem param is no longer a separate k/v param.

Although the cloud version of the API no longer uses/requires this param, customers running GHES could upgrade their version of dependabot-core but against an older version of the API which still requires/uses this param. So I continued to send the param, but as a placeholder string of "deprecated", so that nothing breaks.

Again, this param is no longer used by the cloud's version of the API, so it will never see the ecosystem placeholder value.

Related PR's:

@jeffwidman jeffwidman requested a review from a team as a code owner June 27, 2023 22:58
@github-actions github-actions bot added L: go:modules Golang modules L: javascript L: ruby:bundler RubyGems via bundler L: rust:cargo Rust crates via cargo labels Jun 27, 2023
package_managers: {
"channel" => channel
"cargo" => channel
Copy link
Member Author

Choose a reason for hiding this comment

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

I consciously renamed this from "channel" to "cargo" because that seemed more consistent with the pattern in other ecosystems.

In the long term, it probably won't matter because the entire shape of the data is changing, but in the short term it just seemed more straightforward this way.

@jeffwidman jeffwidman force-pushed the stop-recording-ecosystem-param branch 2 times, most recently from 5f525fe to 0185612 Compare June 27, 2023 23:13
@jeffwidman jeffwidman marked this pull request as draft June 27, 2023 23:13
I'm starting a broader project to re-think how we instrument the
ecosystem (language * package manager) versions.

As part of this, the shape of the data that is sent to the internal API
is changing, and the `ecosystem` param is no longer a separate k/v
param.

Although the cloud version of the API no longer uses/requires this
param, customers running GHES could upgrade their version of
`dependabot-core` but against an older version of the API which still
requires/uses this param. So I continued to send the param, but as a
placeholder string of `"deprecated"`, so that nothing breaks.

Again, this param is no longer used by the cloud's version of the API,
so it will never see the `ecosystem` placeholder value.
@jeffwidman jeffwidman force-pushed the stop-recording-ecosystem-param branch from 0185612 to 0187e67 Compare July 4, 2023 05:02
@jeffwidman
Copy link
Member Author

This is ready for review.

Smoke test failures are expected, TBH it might be simplest to fix them after merging the related PR's so that I don't have to keep re-doing them in lockstep.

But keeping the PR's here in core separate for easier bite-size review.

@jeffwidman jeffwidman merged commit 09dfce0 into main Jul 4, 2023
89 of 102 checks passed
@jeffwidman jeffwidman deleted the stop-recording-ecosystem-param branch July 4, 2023 14:40
jeffwidman added a commit to dependabot/cli that referenced this pull request Jul 11, 2023
I confused myself in the previous two PR's... the `Ecosystem` field is
actually removed, and the `PackageManager` field is replaced by the
`EcosystemVersions` field.

For background context:
* #145
* #146
* dependabot/dependabot-core#7492
* dependabot/dependabot-core#7517

Caught this discrepancy over here:
* https://github.com/dependabot/smoke-tests/pull/98/files#r1260099204
jeffwidman added a commit to dependabot/cli that referenced this pull request Jul 11, 2023
I confused myself in the previous two PR's... the `Ecosystem` field is
actually removed, and the top-level `PackageManager` field is replaced by the
`EcosystemVersions` field.

As explained in #146, there may
be an inner `PackageManager` field, which is optional. But no need to
map it out in the struct, at least not yet.

For background context:
* #145
* #146
* dependabot/dependabot-core#7492
* dependabot/dependabot-core#7517

Caught this discrepancy over here:
* https://github.com/dependabot/smoke-tests/pull/98/files#r1260099204
jeffwidman added a commit to dependabot/cli that referenced this pull request Jul 11, 2023
I confused myself in the previous two PR's... the `Ecosystem` field is
actually removed, and the top-level `PackageManager` field is replaced by the
`EcosystemVersions` field.

As explained in #146, there may
be an inner `PackageManager` field, which is optional. But no need to
map it out in the struct, at least not yet.

For background context:
* #145
* #146
* dependabot/dependabot-core#7492
* dependabot/dependabot-core#7517

Caught this discrepancy over here:
* https://github.com/dependabot/smoke-tests/pull/98/files#r1260099204
jeffwidman added a commit to dependabot/cli that referenced this pull request Jul 11, 2023
I confused myself in the previous two PR's... the `Ecosystem` field is
actually removed, and the top-level `PackageManager` field is replaced by the
`EcosystemVersions` field.

As explained in #146, there may
be an inner `PackageManager` field, which is optional. But no need to
map it out in the struct, at least not yet.

For background context:
* #145
* #146
* dependabot/dependabot-core#7492
* dependabot/dependabot-core#7517

Caught this discrepancy over here:
* https://github.com/dependabot/smoke-tests/pull/98/files#r1260099204
brettfo pushed a commit to brettfo/dependabot-core that referenced this pull request Oct 11, 2023
I'm starting a broader project to re-think how we instrument the
ecosystem (language * package manager) versions.

As part of this, the shape of the data that is sent to the internal API
is changing, and the `ecosystem` param is no longer a separate k/v
param.

Although the cloud version of the API no longer uses/requires this
param, customers running GHES could upgrade their version of
`dependabot-core` but against an older version of the API which still
requires/uses this param. So I continued to send the param, but as a
placeholder string of `"deprecated"`, so that nothing breaks.

Again, this param is no longer used by the cloud's version of the API,
so it will never see the `ecosystem` placeholder value.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
L: go:modules Golang modules L: javascript L: ruby:bundler RubyGems via bundler L: rust:cargo Rust crates via cargo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants