cleanups and refactor of protosanitizer #184

huww98 · 2024-11-23T18:04:06Z

What type of PR is this?
/kind cleanup

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespaces from that line:

/kind api-change
/kind bug
/kind cleanup
/kind design
/kind documentation
/kind failing-test
/kind feature
/kind flake

What this PR does / why we need it:

This PR does a series cleanups and refactors about protosanitizer:

Update the referenced CSI spec package to 1.10
Remove all the reference to old github.com/golang/protobuf package
Refactor the protosanitizer to use the new protoreflect package
Sync the Makefile for csitest.proto with csi spec repo

About the output change of protosanitizer:

All kinds of fields now supported: including those in array, in map, or in oneof.
Enum now outputs their name instead of number, I think this is more suitable for logging purpose.
The nesting level of oneof is reduced by one.
Example diff of the output (manually formatted for diff):

--- old.json
+++ new.json
@@ -12,22 +12,18 @@
     "secrets": "***stripped***",
     "volume_capabilities": [
         {
-            "AccessType": {
-                "Mount": {
-                    "fs_type": "ext4",
-                    "mount_flags": [
-                        "flag1",
-                        "flag2",
-                        "flag3"
-                    ]
-                }
-            },
             "access_mode": {
-                "mode": 5
+                "mode": "MULTI_NODE_MULTI_WRITER"
+            },
+            "mount": {
+                "fs_type": "ext4",
+                "mount_flags": [
+                    "flag1",
+                    "flag2",
+                    "flag3"
+                ]
             }
         }
     ],
-    "volume_content_source": {
-        "Type": null
-    }
+    "volume_content_source": {}
 }

Also added a benchmark to justify the new implementation:
Old:

goos: darwin
goarch: arm64
pkg: github.com/kubernetes-csi/csi-lib-utils/protosanitizer
cpu: Apple M2 Pro
BenchmarkStrip             98264             11801 ns/op            7488 B/op        149 allocs/op
BenchmarkStripLarge           22          49160320 ns/op        39795573 B/op     620137 allocs/op

New:

BenchmarkStrip            141199              7608 ns/op            4816 B/op         89 allocs/op
BenchmarkStripLarge          122          12642834 ns/op         9955752 B/op     140009 allocs/op

The new implementation is significantly faster, and allocates less memory

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

protosanitizer now imports csi spec directly, instead of copy over the e_CsiSecret. Since this module already requires the csi spec module, this should not break anyone.

Support for CSI spec v0.3 is dropped, since the csi.pb.go file in that version does not implement the new protoreflect interface. And again, since this module already requires the csi spec module v1, users cannot use this module with v0.3 even without this PR. So, this is not a new breakage.

Does this PR introduce a user-facing change?:

The output format of protosanitizer is slightly refined.

k8s-ci-robot · 2024-11-23T18:04:14Z

Welcome @huww98!

It looks like this is your first PR to kubernetes-csi/csi-lib-utils 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-csi/csi-lib-utils has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2024-11-23T18:04:15Z

Hi @huww98. Thanks for your PR.

I'm waiting for a kubernetes-csi member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

huww98 · 2024-11-23T18:08:55Z

/cc @pohly @mowangdk

mowangdk · 2024-11-26T07:40:00Z

/ok-to-test

It now works with all kinds of nested fields, and don't require json.Marshal() twice. The output also looks better for oneof and enum.

huww98 · 2024-12-14T10:36:48Z

@jsafrane Can you also take a look at this one? It should speedup several times for cases like kubernetes-csi/external-provisioner#1310 when the log level is high.

jsafrane · 2024-12-16T18:55:29Z

protosanitizer/protosanitizer.go

 	}
+}
+
+func stripValue(field protoreflect.FieldDescriptor, v protoreflect.Value) any {


Can be stripValue() and stripSingleValue() combined into a single function with a bigger switch?

switch { case field.IsList(): ... case field.IsMap(): ... case field.Kind() == protoreflect.MessageKind: ... case field.Kind() == ... default: return v.Interface()

It is possible, but less clear, I think. Because for field that IsList(), its Kind() still returns the kind of list element. So, we will have multiple case statements matched.

My code structure actually looks very like the official encoder:
https://github.com/protocolbuffers/protobuf-go/blob/b98563540c0a4edb38526bcd6e6c97f9fac1f453/encoding/prototext/encode.go#L201-L212

(I'm not referencing it when writing, but reached agreement eventually :)

jsafrane · 2024-12-16T18:57:46Z

protosanitizer/protosanitizer.go

+		for i := range l.Len() {
+			res[i] = stripSingleValue(field, l.Get(i))


For example, what happens when a list has a list? Will it call stripSingleValue() with a list, which then leads to default: branch there and thus print the list with potential secrets?

List is represented as repeated field in the protobuf. Like:

repeated VolumeCapability volume_capabilities = 3;

And it cannot be nested without going through a level of message. i.e.:

repeated repeated VolumeCapability volume_capabilities = 3;

is not valid, but this one is:

repeated Topology accessible_topology = 5; message Topology { map<string, string> segments = 1; }

Similarly, map<string, map<string, string>> or repeated map<string, string> are not valid.

Thanks for the explanation!
/lgtm
/approve

huww98 · 2024-12-17T01:24:54Z

golang/protobuf#1655 We may get official redact support in the future. But even after that is ready, I think we should still keep ours, because that one will be prototext based, not json.

k8s-ci-robot · 2024-12-17T12:01:32Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: huww98, jsafrane

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [jsafrane]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Nov 23, 2024

k8s-ci-robot requested review from carlory and RaunakShah November 23, 2024 18:04

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Nov 23, 2024

k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Nov 23, 2024

k8s-ci-robot requested review from mowangdk and pohly November 23, 2024 18:08

huww98 force-pushed the update-proto branch 2 times, most recently from 819e5e4 to 278086b Compare November 23, 2024 18:27

huww98 added 3 commits November 24, 2024 02:28

update csi spec and protoc

b7eddd9

fix warnings

4b75450

protosanitizer: rewrite with protoreflect

36e3fcb

huww98 force-pushed the update-proto branch from 278086b to 26306f6 Compare November 23, 2024 18:28

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 26, 2024

get rid of remaining github.com/golang/protobuf

a085ea1

huww98 force-pushed the update-proto branch from 26306f6 to 69de83e Compare November 26, 2024 08:05

huww98 added 2 commits December 14, 2024 18:30

protosanitizer: add benchmark

648bd9e

protosanitizer: recurse into all fields

a4d492b

It now works with all kinds of nested fields, and don't require json.Marshal() twice. The output also looks better for oneof and enum.

huww98 force-pushed the update-proto branch from 69de83e to a4d492b Compare December 14, 2024 10:31

jsafrane reviewed Dec 16, 2024

View reviewed changes

k8s-ci-robot assigned jsafrane Dec 17, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 17, 2024

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 17, 2024

k8s-ci-robot merged commit ffe5305 into kubernetes-csi:master Dec 17, 2024
2 of 3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cleanups and refactor of protosanitizer #184

cleanups and refactor of protosanitizer #184

huww98 commented Nov 23, 2024 •

edited

Loading

k8s-ci-robot commented Nov 23, 2024

k8s-ci-robot commented Nov 23, 2024

huww98 commented Nov 23, 2024

mowangdk commented Nov 26, 2024

huww98 commented Dec 14, 2024

jsafrane Dec 16, 2024

huww98 Dec 17, 2024 •

edited

Loading

jsafrane Dec 16, 2024

huww98 Dec 17, 2024

jsafrane Dec 17, 2024

huww98 commented Dec 17, 2024

k8s-ci-robot commented Dec 17, 2024

		for i := range l.Len() {
		res[i] = stripSingleValue(field, l.Get(i))

cleanups and refactor of protosanitizer #184

cleanups and refactor of protosanitizer #184

Conversation

huww98 commented Nov 23, 2024 • edited Loading

k8s-ci-robot commented Nov 23, 2024

k8s-ci-robot commented Nov 23, 2024

huww98 commented Nov 23, 2024

mowangdk commented Nov 26, 2024

huww98 commented Dec 14, 2024

jsafrane Dec 16, 2024

Choose a reason for hiding this comment

huww98 Dec 17, 2024 • edited Loading

Choose a reason for hiding this comment

jsafrane Dec 16, 2024

Choose a reason for hiding this comment

huww98 Dec 17, 2024

Choose a reason for hiding this comment

jsafrane Dec 17, 2024

Choose a reason for hiding this comment

huww98 commented Dec 17, 2024

k8s-ci-robot commented Dec 17, 2024

huww98 commented Nov 23, 2024 •

edited

Loading

huww98 Dec 17, 2024 •

edited

Loading