DGS-19771 Support Protobuf oneof fields in Data Controct rules (#261)

Author: rayokota

proto/test/schemaregistry/serde/example.proto

@@ -14,6 +14,10 @@ message Author {
     (confluent.field_meta).tags = "PII"
   ];
   repeated string works = 4;
+  oneof pii_oneof {
+    Pizza oneof_message = 5;
+    string oneof_string = 6 [(.confluent.field_meta).tags = "PII"];
+  }
 }
 
 message Pizza {

schemaregistry/confluent/meta_pb.ts

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-es v2.0.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.2.3 with parameter "target=ts"
 // @generated from file confluent/meta.proto (package confluent, syntax proto3)
 /* eslint-disable */
 

schemaregistry/confluent/types/decimal_pb.ts

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-es v2.0.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.2.3 with parameter "target=ts"
 // @generated from file confluent/types/decimal.proto (package confluent.type, syntax proto3)
 /* eslint-disable */
 

schemaregistry/rules/encryption/tink/proto/aes_gcm_pb.ts

@@ -14,7 +14,7 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-// @generated by protoc-gen-es v2.0.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.2.3 with parameter "target=ts"
 // @generated from file rules/encryption/tink/proto/aes_gcm.proto (package google.crypto.tink, syntax proto3)
 /* eslint-disable */
 

schemaregistry/rules/encryption/tink/proto/aes_siv_pb.ts

@@ -14,7 +14,7 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-// @generated by protoc-gen-es v2.0.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.2.3 with parameter "target=ts"
 // @generated from file rules/encryption/tink/proto/aes_siv.proto (package google.crypto.tink, syntax proto3)
 /* eslint-disable */
 

schemaregistry/serde/protobuf.ts

@@ -525,14 +525,29 @@ async function transformField(ctx: RuleContext, fd: DescField, desc: DescMessage
       getType(fd),
       getInlineTags(fd)
     )
-    const value = msg[fd.name]
+    let value = null;
+    if (fd.oneof != null) {
+      let oneof = msg[fd.oneof.localName]
+      if (oneof != null && oneof.case === fd.localName) {
+        value = oneof.value
+      } else {
+        // skip oneof fields that are not set
+        return
+      }
+    } else {
+      value = msg[fd.localName]
+    }
     const newValue = await transform(ctx, desc, value, fieldTransform)
     if (ctx.rule.kind === 'CONDITION') {
       if (newValue === false) {
         throw new RuleConditionError(ctx.rule)
       }
     } else {
-      msg[fd.name] = newValue
+      if (fd.oneof != null) {
+        msg[fd.oneof.localName] = { case: fd.localName, value: newValue }
+      } else {
+        msg[fd.localName] = newValue
+      }
     }
   } finally {
     ctx.leaveField()

schemaregistry/test/serde/protobuf.spec.ts

@@ -208,13 +208,18 @@ describe('ProtobufSerializer', () => {
       name: 'Kafka',
       id: 123,
       picture: Buffer.from([1, 2]),
-      works: ['The Castle', 'The Trial']
+      works: ['The Castle', 'The Trial'],
+      piiOneof: {
+        case: 'oneofString',
+        value: 'oneof'
+      }
     })
     let bytes = await ser.serialize(topic, obj)
 
     // reset encrypted field
     obj.name = 'Kafka'
     obj.picture = Buffer.from([1, 2])
+    obj.piiOneof = { case: 'oneofString', value: 'oneof' }
 
     let deserConfig: ProtobufDeserializerConfig = {
       ruleConfig: {

schemaregistry/test/serde/test/cycle_pb.ts

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-es v2.0.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.2.3 with parameter "target=ts"
 // @generated from file test/schemaregistry/serde/cycle.proto (package test, syntax proto3)
 /* eslint-disable */
 

schemaregistry/test/serde/test/dep_pb.ts

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-es v2.0.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.2.3 with parameter "target=ts"
 // @generated from file test/schemaregistry/serde/dep.proto (package test, syntax proto3)
 /* eslint-disable */
 

schemaregistry/test/serde/test/example_pb.ts

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-es v2.0.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.2.3 with parameter "target=ts"
 // @generated from file test/schemaregistry/serde/example.proto (package test, syntax proto3)
 /* eslint-disable */
 
@@ -11,7 +11,7 @@ import type { Message } from "@bufbuild/protobuf";
  * Describes the file test/schemaregistry/serde/example.proto.
  */
 export const file_test_schemaregistry_serde_example: GenFile = /*@__PURE__*/
-  fileDesc("Cid0ZXN0L3NjaGVtYXJlZ2lzdHJ5L3NlcmRlL2V4YW1wbGUucHJvdG8SBHRlc3QiVgoGQXV0aG9yEhYKBG5hbWUYASABKAlCCIJEBRoDUElJEgoKAmlkGAIgASgFEhkKB3BpY3R1cmUYAyABKAxCCIJEBRoDUElJEg0KBXdvcmtzGAQgAygJIicKBVBpenphEgwKBHNpemUYASABKAkSEAoIdG9wcGluZ3MYAiADKAlCCVoHLi4vdGVzdGIGcHJvdG8z", [file_confluent_meta]);
+  fileDesc("Cid0ZXN0L3NjaGVtYXJlZ2lzdHJ5L3NlcmRlL2V4YW1wbGUucHJvdG8SBHRlc3QiqwEKBkF1dGhvchIWCgRuYW1lGAEgASgJQgiCRAUaA1BJSRIKCgJpZBgCIAEoBRIZCgdwaWN0dXJlGAMgASgMQgiCRAUaA1BJSRINCgV3b3JrcxgEIAMoCRIkCg1vbmVvZl9tZXNzYWdlGAUgASgLMgsudGVzdC5QaXp6YUgAEiAKDG9uZW9mX3N0cmluZxgGIAEoCUIIgkQFGgNQSUlIAEILCglwaWlfb25lb2YiJwoFUGl6emESDAoEc2l6ZRgBIAEoCRIQCgh0b3BwaW5ncxgCIAMoCUIJWgcuLi90ZXN0YgZwcm90bzM", [file_confluent_meta]);
 
 /**
  * @generated from message test.Author
@@ -36,6 +36,23 @@ export type Author = Message<"test.Author"> & {
    * @generated from field: repeated string works = 4;
    */
   works: string[];
+
+  /**
+   * @generated from oneof test.Author.pii_oneof
+   */
+  piiOneof: {
+    /**
+     * @generated from field: test.Pizza oneof_message = 5;
+     */
+    value: Pizza;
+    case: "oneofMessage";
+  } | {
+    /**
+     * @generated from field: string oneof_string = 6;
+     */
+    value: string;
+    case: "oneofString";
+  } | { case: undefined; value?: undefined };
 };
 
 /**