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.

Sign up for GitHub

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

Jump to bottom

fix(deps): update module github.com/grpc-ecosystem/grpc-gateway to v2 #361

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

fix(deps): update module github.com/grpc-ecosystem/grpc-gateway to v2 #361

wants to merge 5 commits into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Dec 20, 2022 •
edited
Loading

Mend Renovate

This PR contains the following updates:

Package Type Update Change
github.com/grpc-ecosystem/grpc-gateway require major v1.16.0 -> v2.15.0

Release Notes

grpc-ecosystem/grpc-gateway

v2.15.0

Compare Source

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.14.0...v2.15.0

v2.14.0

Compare Source

New features

This release contains two significant new OpenAPIv2 generator features, contributed by @​krak3n:

  1. A new option to disable rendering of 200 OK responses. This is useful if you define custom responses for your endpoints and you modify the return code a forward response writer. Note that this does not change the behavior of the gateway itself.
  2. A new annotation for defining header parameters. This lets to define header parameters you want to be rendered in the swagger.json output in addition to those defined in your API messages. Note that this does not change the behavior of the gateway itself and must be coupled with custom header parsing in your application.

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.13.0...v2.14.0

v2.13.0

Compare Source

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.12.0...v2.13.0

v2.12.0

Compare Source

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.11.3...v2.12.0

v2.11.3

Compare Source

This release adds signed release binaries with SLSA signatures. Please see the README for more information.

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.11.2...v2.11.3

v2.11.2

Compare Source

This fixes an issue with the openapiv2 generator if there is a colon in the verb, and updates the minimum supported Go version to Go 1.17.

What's Changed

Full Changelog: grpc-ecosystem/grpc-gateway@v2.11.1...v2.11.2

v2.11.1

Compare Source

This release fixes a crash in the grpc-gateway handling of requests containing invalid an Grpc-Timeout or Grpc-Metadata-Bin header (#​2822). It is strongly recommended that users upgrade both the runtime and generator versions.

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.11.0...v2.11.1

v2.11.0

Compare Source

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.10.3...v2.11.0

v2.10.3

Compare Source

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.10.2...v2.10.3

v2.10.2

Compare Source

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.10.1...v2.10.2

v2.10.1

Compare Source

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.10.0...v2.10.1

v2.10.0

Compare Source

This release contains a new annotation that allows you to configure the path parameter names generated in your swagger.json, which can be useful in some circumstances. Please see https://grpc-ecosystem.github.io/grpc-gateway/docs/mapping/customizing_openapi_output/#path-parameters for documentation on how to use this new capability.

Note that in order to take advantage of the new annotation, you will need to update your vendored dependency, or update your buf.build/grpc-ecosystem/grpc-gateway dependency to at least f85c60ac38544f2d8f346491c9d916e5. This can be accomplished by running buf mod update in the folder where you have your buf.yaml.

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.9.0...v2.10.0

v2.9.0

Compare Source

This release adds the ability to filter properties (Services, RPCs, Fields, Enum values) from being rendered in the OpenAPI v2 spec generated by protoc-gen-openapiv2. See https://grpc-ecosystem.github.io/grpc-gateway/docs/mapping/customizing_openapi_output/#hiding-fields-methods-services-and-enum-values for more information about this new exciting capability!

Other new features:

  • A new option to generate the OpenAPI v2 spec in YAML format
  • Allow serving a health endpoint at an arbitrary path with the new WithHealthEndpointAt ServeMux option

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.8.0...v2.9.0

v2.8.0

Compare Source

Overview

This release introduces the new WithHealthzEndpoint which makes it easy to forward your gRPC health check endpoint to your gRPC-gateway server, and fixes a long standing bug in protoc-gen-openapiv2 where path parameters were included in both the path and the body of the generated spec (#​1670 and #​1015).

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.7.3...v2.8.0

v2.7.3

Compare Source

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.7.2...v2.7.3

v2.7.2

Compare Source

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.7.1...v2.7.2

v2.7.1

Compare Source

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.7.0...v2.7.1

v2.7.0

Compare Source

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.6.0...v2.7.0

v2.6.0

Compare Source

Changes in this release

Major features in this release include:

As well as various bug fixes, including the auto generation of the Www-Authenticate header when returning an 401 Unauthorized error (#​2314), better google.protobuf.Any representation in openapiv2 files (#​2292) and much more.

This is also the first release to automatically publish the Protobuf plugins to the Buf Schema Registry. See https://buf.build/grpc-ecosystem/plugins. These can be used together with the new buf generate remote plugins feature: https://docs.buf.build/configuration/v1/buf-gen-yaml#name-or-remote. An example buf.gen.yaml using these new plugins looks like this:

version: v1
plugins:
  - remote: buf.build/library/plugins/go:v1.27.1-1
    out: gen/go
    opt: paths=source_relative
  - remote: buf.build/library/plugins/go-grpc:v1.1.0-2
    out: gen/go
    opt: paths=source_relative
  - remote: buf.build/grpc-ecosystem/plugins/grpc-gateway:v2.6.0-1
    out: gen/go
    opt: paths=source_relative
  - remote: buf.build/grpc-ecosystem/plugins/openapiv2:v2.6.0-1
    out: gen/openapiv2

v2.5.0

Compare Source

Changes in this release

This release adds support for extracting the HTTP path for an incoming request through the request context. Thanks to @​0daryo for the contribution!

Note that this release slightly changes the behavior of the generator, so you must ensure that you are using the new version of the runtime library after updating the generator to this new version.

v2.4.0

Compare Source

This release adds support for customizing routing error HTTP status codes. Thanks to @​electrofelix for the contribution!

Other changes

New Contributors

Full Changelog: https://github.com/grpc-ecosystem/

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate
Copy link
Contributor Author

renovate bot commented Dec 20, 2022

⚠ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

  • any of the package files in this branch needs updating, or
  • the branch becomes conflicted, or
  • you click the rebase/retry checkbox if found above, or
  • you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: gwy/templates/go.mod.tmpl
Command failed: docker run --rm --name=renovate_sidecar --label=renovate_child -v "/mnt/renovate/gh/namely/docker-protoc":"/mnt/renovate/gh/namely/docker-protoc" -v "/tmp/renovate-cache":"/tmp/renovate-cache" -v "/tmp/containerbase":"/tmp/containerbase" -e GOPATH -e GOPROXY -e GOFLAGS -e CGO_ENABLED -e GIT_CONFIG_KEY_0 -e GIT_CONFIG_VALUE_0 -e GIT_CONFIG_KEY_1 -e GIT_CONFIG_VALUE_1 -e GIT_CONFIG_KEY_2 -e GIT_CONFIG_VALUE_2 -e GIT_CONFIG_COUNT -e BUILDPACK_CACHE_DIR -e CONTAINERBASE_CACHE_DIR -w "/mnt/renovate/gh/namely/docker-protoc/gwy/templates" docker.io/renovate/sidecar bash -l -c "install-tool golang 1.19.4 && go get -d -t ./..."
go: go.mod file not found in current directory or any parent directory.
	'go get' is no longer supported outside a module.
	To build and install a command, use 'go install' with a version,
	like 'go install example.com/cmd@latest'
	For more information, see https://golang.org/doc/go-get-install-deprecation
	or run 'go help get' or 'go help install'.

@renovate renovate bot force-pushed the renovate/github.com-grpc-ecosystem-grpc-gateway-2.x branch 2 times, most recently from c69f4a3 to 6b51511 Compare December 21, 2022 19:19
@renovate renovate bot changed the title fix(deps): update module github.com/grpc-ecosystem/grpc-gateway to v2 fix(deps): update module github.com/grpc-ecosystem/grpc-gateway to v2 - autoclosed Dec 31, 2022
@renovate renovate bot closed this Dec 31, 2022
@renovate renovate bot deleted the renovate/github.com-grpc-ecosystem-grpc-gateway-2.x branch December 31, 2022 07:58
@renovate renovate bot changed the title fix(deps): update module github.com/grpc-ecosystem/grpc-gateway to v2 - autoclosed fix(deps): update module github.com/grpc-ecosystem/grpc-gateway to v2 Dec 31, 2022
@renovate renovate bot reopened this Dec 31, 2022
@renovate renovate bot restored the renovate/github.com-grpc-ecosystem-grpc-gateway-2.x branch December 31, 2022 10:33
@nycdotnet
Copy link
Contributor

This PR definitely seems weird - do we have two versions of gRPC gateway in here intentionally?

@renovate renovate bot force-pushed the renovate/github.com-grpc-ecosystem-grpc-gateway-2.x branch from 6b51511 to 67362c5 Compare January 5, 2023 15:09
abe545
abe545 suggested changes Jan 5, 2023
View reviewed changes
Copy link
Contributor

@abe545 abe545 left a comment

Choose a reason for hiding this comment

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

@nycdotnet is right

@jtabachnick
Copy link

I approved, but I think I might agree with @nycdotnet also. Why do we have two?

@jtabachnick jtabachnick self-requested a review January 5, 2023 20:36
@abe545
Copy link
Contributor

abe545 commented Jan 5, 2023

I approved, but I think I might agree with @nycdotnet also. Why do we have two?

I'm not sure, but if we want to update to this version, I'd suggest we update the v2 one

@renovate
Copy link
Contributor Author

renovate bot commented Jan 5, 2023 •
edited
Loading

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.

@jcburley
Copy link
Collaborator

jcburley commented Jan 5, 2023

@nycdotnet @abe545 @jtabachnick – okay, I removed the older listing/version from the template. Let's see how that goes...!

@nycdotnet
Copy link
Contributor

@abe545 I think we have v1 here intentionally. This was the version that would by default not include default but didn't support changing it, etc. It was a while ago that I think we intentionally decided to have both. I think the 1.x dependency should probably be pinned to the latest version of 1.x if it's not already and is not on the latest (assuming dev has stopped on it) or we do a breaking release and drop 1.x altogether. I don't know if we use gRPC gateway 1.x anywhere.

@abe545
Copy link
Contributor

abe545 commented Jan 5, 2023

@abe545 I think we have v1 here intentionally. This was the version that would by default not include default but didn't support changing it, etc. It was a while ago that I think we intentionally decided to have both. I think the 1.x dependency should probably be pinned to the latest version of 1.x if it's not already and is not on the latest (assuming dev has stopped on it) or we do a breaking release and drop 1.x altogether. I don't know if we use gRPC gateway 1.x anywhere.

Yeah, that makes sense. I think since this is an open source repo, we shouldn't just drop it if it behaves differently. I imagine we could cause problems for others if we unilaterally drop it because we don't need it. We probably need to tweak renovate so it doesn't do this again (if we decide to keep v1).

@nycdotnet
Copy link
Contributor

ok it appears that 1.16.0 is the final release of gRPC Gateway 1.x https://github.com/grpc-ecosystem/grpc-gateway/releases?page=3

@jcburley
Copy link
Collaborator

jcburley commented Jan 6, 2023

@nycdotnet @abe545 – are you saying I should restore the deleted v1 line? And, will the resulting go.mod files actually work in generated repos?

@nycdotnet
Copy link
Contributor

@jcburley let's discuss tomorrow. I don't know what we should do. All I can say is that the 1.x and 2.x dependencies are both there intentionally for legacy reasons and that they have different behavior.

@jcburley jcburley mentioned this pull request Jan 13, 2023
Open
@idodod
Copy link

idodod commented Feb 24, 2023

@jcburley let's discuss tomorrow. I don't know what we should do. All I can say is that the 1.x and 2.x dependencies are both there intentionally for legacy reasons and that they have different behavior.

Hey guys,
I hope this can provide some more context about why we still use v1 - #229
Also why we don't upgrade to the latest v2 version - #318 (comment)

So upgrading can be done, it's just a matter of being prepared to handle the breaking change in the FE.

@jcburley
Copy link
Collaborator

@nycdotnet @abe545 et al — I've rolled in a number of (I think) innocuous Renovate changes here, but backed out the problematic grpc_gateway upgrade that we should try to address soon.

But the tests still don't pass, and (offhand) I don't understand why?

@cdecoux
Copy link

cdecoux commented May 11, 2023

FWIW - I forked it and pushed to dockerhub via cdecoux/protoc-all. Updated the version as shown here: cdecoux@4d4772e

@glimchb glimchb mentioned this pull request Sep 7, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abe545 abe545 abe545 requested changes

@jcburley jcburley jcburley approved these changes

@nycdotnet nycdotnet Awaiting requested review from nycdotnet

@jtabachnick jtabachnick Awaiting requested review from jtabachnick

Assignees
No one assigned
Labels
question
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@nycdotnet @jtabachnick @abe545 @jcburley @idodod @cdecoux