feat: optionally output versions used to generate files (#1040)

### Description - Add the `annotateFilesWithVersion` option so that changes are correctly captured in CI (eliminating noise on each file) - Added this option to the README
stephenh · May 14, 2024 · e803b8a · e803b8a
1 parent 46e0c96
commit e803b8a
Show file tree

Hide file tree

Showing 258 changed files with 23 additions and 767 deletions.
diff --git a/README.markdown b/README.markdown
@@ -432,6 +432,8 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=useMongoObjectId=true`, fields of a type called ObjectId where the message is constructed to have on field called value that is a string will be mapped to type `mongodb.ObjectId` in the generated types. This will require your project to install the mongodb npm package. See [ObjectId](#objectid) for more details.
 
+- With `--ts_proto_opt=annotateFilesWithVersion=false`, the generated files will not contain the versions of `protoc` and `ts-proto` used to generate the file. This option is normally set to `true`, such that files list the versions used.
+
 - With `--ts_proto_opt=outputSchema=true`, meta typings will be generated that can later be used in other code generators.
 
 - With `--ts_proto_opt=outputTypeAnnotations=true`, each message will be given a `$type` field containing its fully-qualified name. You can use `--ts_proto_opt=outputTypeAnnotations=static-only` to omit it from the `interface` declaration, or `--ts_proto_opt=outputTypeAnnotations=optional` to make it an optional property on the `interface` definition. The latter option may be useful if you want to use the `$type` field for runtime type checking on responses from a server.
@@ -787,9 +789,7 @@ The following helper types may make it easier to work with the types generated f
 type OneOfCases<T> = T extends { $case: infer U extends string } ? U : never;
 
 /** Extracts a union of all the value types from a oneOf field */
-type OneOfValues<T> = T extends { $case: infer U extends string; [key: string]: unknown }
-  ? T[U]
-  : never;
+type OneOfValues<T> = T extends { $case: infer U extends string; [key: string]: unknown } ? T[U] : never;
 
 /** Extracts the specific type of a oneOf case based on its field name */
 type OneOfCase<T, K extends OneOfCases<T>> = T extends {

diff --git a/integration/angular/simple-message.ts b/integration/angular/simple-message.ts
diff --git a/integration/async-iterable-services-abort-signal/simple.ts b/integration/async-iterable-services-abort-signal/simple.ts
diff --git a/integration/async-iterable-services/simple.ts b/integration/async-iterable-services/simple.ts
diff --git a/integration/avoid-import-conflicts-folder-name/ui.ts b/integration/avoid-import-conflicts-folder-name/ui.ts
diff --git a/integration/avoid-import-conflicts-folder-name/ui/simple.ts b/integration/avoid-import-conflicts-folder-name/ui/simple.ts
diff --git a/integration/avoid-import-conflicts-types-only/simple.ts b/integration/avoid-import-conflicts-types-only/simple.ts
diff --git a/integration/avoid-import-conflicts-types-only/simple2.ts b/integration/avoid-import-conflicts-types-only/simple2.ts
diff --git a/integration/avoid-import-conflicts/simple.ts b/integration/avoid-import-conflicts/simple.ts
diff --git a/integration/avoid-import-conflicts/simple2.ts b/integration/avoid-import-conflicts/simple2.ts
diff --git a/integration/barrel-imports/bar.ts b/integration/barrel-imports/bar.ts
diff --git a/integration/barrel-imports/foo.ts b/integration/barrel-imports/foo.ts
diff --git a/integration/batching-with-context-esModuleInterop/batching.ts b/integration/batching-with-context-esModuleInterop/batching.ts
diff --git a/integration/batching-with-context/batching.ts b/integration/batching-with-context/batching.ts
diff --git a/integration/batching/batching.ts b/integration/batching/batching.ts
diff --git a/integration/before-after-request-streaming/example.ts b/integration/before-after-request-streaming/example.ts
diff --git a/integration/before-after-request-streaming/google/protobuf/wrappers.ts b/integration/before-after-request-streaming/google/protobuf/wrappers.ts
diff --git a/integration/before-after-request/simple.ts b/integration/before-after-request/simple.ts
diff --git a/integration/before-after-request/simple2.ts b/integration/before-after-request/simple2.ts
diff --git a/integration/bytes-as-base64-browser/message.ts b/integration/bytes-as-base64-browser/message.ts
diff --git a/integration/bytes-as-base64-node/message.ts b/integration/bytes-as-base64-node/message.ts
diff --git a/integration/bytes-as-base64/message.ts b/integration/bytes-as-base64/message.ts
diff --git a/integration/bytes-node/google/protobuf/wrappers.ts b/integration/bytes-node/google/protobuf/wrappers.ts
diff --git a/integration/bytes-node/point.ts b/integration/bytes-node/point.ts
diff --git a/integration/codegen.ts b/integration/codegen.ts
@@ -31,6 +31,16 @@ async function generate(binFile: string, baseDir: string, parameter: string) {
   const { protocVersion, tsProtoVersion } = await getVersions(request);
 
   const options = optionsFromParameter(parameter || "");
+
+  // we have to check for the parameter as a string here because the
+  // default value of the parameter is true.
+  if (parameter.includes("annotateFilesWithVersion=true")) {
+    options.annotateFilesWithVersion = true;
+  } else {
+    // we practically always want to not annotate files with version in tests
+    // as this will make snapshots fail on every version bump
+    options.annotateFilesWithVersion = false;
+  }
   const typeMap = createTypeMap(request, options);
 
   for (let file of request.protoFile) {

diff --git a/integration/const-enum/const-enum.ts b/integration/const-enum/const-enum.ts
diff --git a/integration/default-with-custom-metadata/default-with-custom-metadata.ts b/integration/default-with-custom-metadata/default-with-custom-metadata.ts
diff --git a/integration/default-with-metadata/default-with-metadata.ts b/integration/default-with-metadata/default-with-metadata.ts
diff --git a/integration/emit-default-values-json/google/protobuf/timestamp.ts b/integration/emit-default-values-json/google/protobuf/timestamp.ts
diff --git a/integration/emit-default-values-json/test.ts b/integration/emit-default-values-json/test.ts
diff --git a/integration/enums-as-literals-with-string-enums/enums-as-literals-with-string-enums.ts b/integration/enums-as-literals-with-string-enums/enums-as-literals-with-string-enums.ts
diff --git a/integration/enums-as-literals/enums-as-literals.ts b/integration/enums-as-literals/enums-as-literals.ts
diff --git a/integration/enums-with-unrecognized-name-value/test.ts b/integration/enums-with-unrecognized-name-value/test.ts
diff --git a/integration/extensions/test.ts b/integration/extensions/test.ts
diff --git a/integration/fieldmask-optional-all/fieldmask-optional.ts b/integration/fieldmask-optional-all/fieldmask-optional.ts
diff --git a/integration/fieldmask-optional-all/google/protobuf/field_mask.ts b/integration/fieldmask-optional-all/google/protobuf/field_mask.ts
diff --git a/integration/fieldmask/fieldmask.ts b/integration/fieldmask/fieldmask.ts
diff --git a/integration/fieldmask/google/protobuf/field_mask.ts b/integration/fieldmask/google/protobuf/field_mask.ts
diff --git a/...tion/fieldoption-jstype-with-forcelong-bigint/fieldoption-jstype-with-forcelong-bigint.ts b/...tion/fieldoption-jstype-with-forcelong-bigint/fieldoption-jstype-with-forcelong-bigint.ts
diff --git a/integration/fieldoption-jstype-with-forcelong-long/fieldoption-jstype-with-forcelong-long.ts b/integration/fieldoption-jstype-with-forcelong-long/fieldoption-jstype-with-forcelong-long.ts
diff --git a/...tion/fieldoption-jstype-with-forcelong-number/fieldoption-jstype-with-forcelong-number.ts b/...tion/fieldoption-jstype-with-forcelong-number/fieldoption-jstype-with-forcelong-number.ts
diff --git a/...tion/fieldoption-jstype-with-forcelong-string/fieldoption-jstype-with-forcelong-string.ts b/...tion/fieldoption-jstype-with-forcelong-string/fieldoption-jstype-with-forcelong-string.ts
diff --git a/integration/fieldoption-jstype/fieldoption-jstype.ts b/integration/fieldoption-jstype/fieldoption-jstype.ts
diff --git a/integration/file-suffix/child.pb.ts b/integration/file-suffix/child.pb.ts
diff --git a/integration/file-suffix/google/protobuf/timestamp.pb.ts b/integration/file-suffix/google/protobuf/timestamp.pb.ts
diff --git a/integration/file-suffix/parent.pb.ts b/integration/file-suffix/parent.pb.ts
diff --git a/integration/from-partial-no-initialize/test.ts b/integration/from-partial-no-initialize/test.ts