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

Migrate off from github.com/gogo/protobuf #6564

Closed
kzys opened this issue Feb 17, 2022 · 3 comments
Closed

Migrate off from github.com/gogo/protobuf #6564

kzys opened this issue Feb 17, 2022 · 3 comments
Assignees
@kzys
Labels
kind/feature
Milestone
1.7

Comments

@kzys
Copy link
Member

kzys commented Feb 17, 2022 •
edited
Loading

What is the problem you're trying to solve

We'd like to migrate off from github.com/gogo/protobuf. The package is looking for owners since 2020 and no longer compatible with https://go.dev/blog/protobuf-apiv2.

This is the master ticket to associate all PRs related to the migration.

Describe the solution you'd like

Use google.golang.org/protobuf instead.

We have removed gogo/protobuf and upgraded protobuf on the following packages.

https://github.com/containerd/protobuild

https://github.com/containerd/ttrpc

gogo/protobuf's code generation extension

There are multiple gogo/protobuf extensions which don't work with protoc-gen-go. That being said, those types are mostly invisible from our Go client. So we might be able to just follow Google's new convention (e.g. using protobuf's Time instead time.Time) instead of making them fully Go-idiomatic.

Addressed

Fixed by #6699

  • gogoproto.customtype (10): All of them are used to use github.com/opencontainers/go-digest.Digest instead of string.

Fixed by #6708
@kzys kzys added this to the 1.7 milestone Feb 17, 2022
kzys added a commit to kzys/cgroups that referenced this issue Feb 17, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
518baa2 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564.

Signed-off-by: Kazuyoshi Kato <[email protected]>
@kzys kzys mentioned this issue Feb 17, 2022
Merged
kzys added a commit to kzys/cgroups that referenced this issue Feb 17, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
07fa92f 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/containerd that referenced this issue Feb 17, 2022
@kzys
Add protoc-gen-go-fieldpath
06cbf83 
This command will replace protobuf/plugin/fieldpath when we migrate
off from gogo/protobuf.

See containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
@kzys kzys mentioned this issue Feb 18, 2022
Merged
kzys added a commit to kzys/cgroups that referenced this issue Feb 18, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
9c33513 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Feb 18, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
9752089 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/containerd that referenced this issue Feb 21, 2022
@kzys
Add protoc-gen-go-fieldpath
3febabf 
This command will replace protobuf/plugin/fieldpath when we migrate
off from gogo/protobuf.

See containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
This was referenced Feb 21, 2022
Merged
Closed
@dmcgowan dmcgowan moved this to Todo in Feature Tracking Feb 21, 2022
kzys added a commit to kzys/hcsshim that referenced this issue Feb 22, 2022
@kzys
Run Protobuild on GitHub Actions
593f21e 
containerd is planning to migrate off from github.com/gogo/protobuf
which will affect hcsshim.
See containerd/containerd#6564 for
the overall progress.

Before that, this commit runs Protobuild in GitHub Actions to
make sure all generated files are reproducible from .proto files.

Signed-off-by: Kazuyoshi Kato <[email protected]>
@kzys kzys mentioned this issue Feb 22, 2022
Merged
@TBBle TBBle mentioned this issue Feb 22, 2022
Draft
2 tasks
@kzys kzys self-assigned this Feb 22, 2022
kzys added a commit to kzys/hcsshim that referenced this issue Feb 28, 2022
@kzys
Run Protobuild on GitHub Actions
430008a 
containerd is planning to migrate off from github.com/gogo/protobuf
which will affect hcsshim.
See containerd/containerd#6564 for
the overall progress.

Before that, this commit runs Protobuild in GitHub Actions to
make sure all generated files are reproducible from .proto files.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/hcsshim that referenced this issue Feb 28, 2022
@kzys
Run Protobuild on GitHub Actions
603dd84 
containerd is planning to migrate off from github.com/gogo/protobuf
which will affect hcsshim.
See containerd/containerd#6564 for
the overall progress.

Before that, this commit runs Protobuild in GitHub Actions to
make sure all generated files are reproducible from .proto files.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Mar 1, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
c065dd9 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Mar 1, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
cf80bf2 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Mar 1, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
db0d154 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Mar 1, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
70f8326 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Mar 1, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
553df9b 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Mar 1, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
a329c4a 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Mar 1, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
291531d 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
@dmcgowan dmcgowan moved this from Todo to In Progress in Feature Tracking Mar 15, 2022
@dmcgowan
Copy link
Member

What are we going to do about the use of types.Any from "github.com/gogo/protobuf/types" in some of out interfaces. For example: https://github.com/containerd/containerd/blob/v1.6.1/runtime/runtime.go#L38

kzys added a commit to kzys/containerd that referenced this issue Mar 18, 2022
@kzys
Remove gogoproto.customtype
e35723e 
gogoproto.customtype is used to have go-digest.Digest instead of string.
While it is convinient, protoc-gen-go doesn't support the extension
and blocks containerd#6564.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Aug 26, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
1a1648f 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Aug 26, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
3d88d2f 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Aug 26, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
37a387b 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Aug 26, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
cdc2cd4 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Aug 26, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
7f90d99 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Aug 26, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
162e4d2 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Aug 26, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
3d58d77 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Aug 26, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
ffc9c25 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Aug 26, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
24cf84d 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Aug 26, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
2fc1226 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Aug 26, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
75101da 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Oct 19, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
cd2ccc8 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kzys added a commit to kzys/cgroups that referenced this issue Nov 3, 2022
@kzys
Use google.golang.org/protobuf instead of github.com/gogo/protobuf
7746639 
We'd like to migrate off from gogo/protobuf. The package is looking
for new ownership since 2020.

See containerd/containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
@littlejawa littlejawa mentioned this issue Nov 10, 2022
Closed
akhilerm pushed a commit to akhilerm/containerd-test that referenced this issue Feb 22, 2023
@kzys
Remove gogoproto.stdtime
1c81c0e 
This commit removes gogoproto.stdtime, since it is not supported by
Google's official toolchain
(see containerd/containerd#6564).

Signed-off-by: Kazuyoshi Kato <[email protected]>

Containerd-test-commit: 80b825c
akhilerm pushed a commit to akhilerm/containerd-test that referenced this issue Feb 22, 2023
@kzys
Remove gogoproto.stdtime
caf4c55 
This commit removes gogoproto.stdtime, since it is not supported by
Google's official toolchain
(see containerd/containerd#6564).

Signed-off-by: Kazuyoshi Kato <[email protected]>

Containerd-test-commit: a8578f6
@jpmcb jpmcb mentioned this issue Feb 22, 2023
Closed
@thaJeztah thaJeztah mentioned this issue Jun 15, 2023
Open
@yoheiueda yoheiueda mentioned this issue Jul 24, 2023
Closed
@kzys kzys mentioned this issue Nov 16, 2023
Closed
princepereira pushed a commit to princepereira/hcsshim that referenced this issue Aug 29, 2024
@kzys
Run Protobuild on GitHub Actions (microsoft#1302)
5509359 
containerd is planning to migrate off from github.com/gogo/protobuf
which will affect hcsshim.
See containerd/containerd#6564 for
the overall progress.

Before that, this commit runs Protobuild in GitHub Actions to
make sure all generated files are reproducible from .proto files.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kiashok pushed a commit to kiashok/containerd-containerd that referenced this issue Oct 23, 2024
@kzys
Add protoc-gen-go-fieldpath
fd68817 
This command will replace protobuf/plugin/fieldpath when we migrate
off from gogo/protobuf.

See containerd#6564 for the detail.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kiashok pushed a commit to kiashok/containerd-containerd that referenced this issue Oct 23, 2024
@kzys
Remove gogoproto.customtype
28f0e2d 
gogoproto.customtype is used to have go-digest.Digest instead of string.
While it is convinient, protoc-gen-go doesn't support the extension
and that blocks containerd#6564.

Signed-off-by: Kazuyoshi Kato <[email protected]>
kiashok pushed a commit to kiashok/containerd-containerd that referenced this issue Oct 23, 2024
@kzys
Remove enumvalue_customname, goproto_enum_prefix and enum_customname
a7ff6f0 
This commit removes gogoproto.enumvalue_customname,
gogoproto.goproto_enum_prefix and gogoproto.enum_customname.

All of them make proto-generated Go code more idiomatic, but we already
don't use these enums in our external-surfacing types and they are anyway
not supported by Google's official toolchain (see containerd#6564).

Signed-off-by: Kazuyoshi Kato <[email protected]>
kiashok pushed a commit to kiashok/containerd-containerd that referenced this issue Oct 23, 2024
@kzys
Remove gogoproto.stdtime
24f71b8 
This commit removes gogoproto.stdtime, since it is not supported by
Google's official toolchain
(see containerd#6564).

Signed-off-by: Kazuyoshi Kato <[email protected]>
kiashok pushed a commit to kiashok/containerd-containerd that referenced this issue Oct 23, 2024
@kzys
Remove all gogoproto extensions
d363ed7 
This commit removes the following gogoproto extensions;

- gogoproto.nullable
- gogoproto.customename
- gogoproto.unmarshaller_all
- gogoproto.stringer_all
- gogoproto.sizer_all
- gogoproto.marshaler_all
- gogoproto.goproto_unregonized_all
- gogoproto.goproto_stringer_all
- gogoproto.goproto_getters_all

None of them are supported by Google's toolchain (see containerd#6564).

Signed-off-by: Kazuyoshi Kato <[email protected]>
kiashok pushed a commit to kiashok/containerd-containerd that referenced this issue Oct 23, 2024
@kzys
Embed "Unimplemented" structs as proto recommended
f23bd28 
Embedding these structs will be mandatory after migratring off from
gogo/protobuf (see containerd#6564).

Signed-off-by: Kazuyoshi Kato <[email protected]>
kiashok pushed a commit to kiashok/containerd-containerd that referenced this issue Oct 23, 2024
@kzys
Use proto.Marshal instead of calling Marshal() on objects
c90e09a 
With google.golang.org/protobuf, proto-generated objects only have
ProtoReflect(). They don't have Marshal() anymore (see containerd#6564).

Signed-off-by: Kazuyoshi Kato <[email protected]>
kiashok pushed a commit to kiashok/containerd-containerd that referenced this issue Oct 23, 2024
@kzys
Add go_package on all proto files
ef29adc 
Seems it is no longer optional after migratring off from
gogo/protobuf (see containerd#6564).

Signed-off-by: Kazuyoshi Kato <[email protected]>
kiashok pushed a commit to kiashok/containerd-containerd that referenced this issue Oct 23, 2024
@kzys
Remove gogo/protobuf and adjust types
59550fa 
This commit migrates containerd/protobuf from github.com/gogo/protobuf
to google.golang.org/protobuf and adjust types. Proto-generated structs
cannot be passed as values.

Fixes containerd#6564.

Signed-off-by: Kazuyoshi Kato <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kzys kzys

Labels
kind/feature
Projects
Feature Tracking
Archived in project
Milestone
1.7
Development

No branches or pull requests
2 participants
@kzys @dmcgowan