@foxglove/schemas 0.4.0 → 0.6.1

package/src/generateJsonSchema.test.ts

@@ -7,46 +7,46 @@ import { exampleMessage } from "./testFixtures";
 describe("generateJsonSchema", () => {
   it("generates expected JSON Schema", () => {
     expect(generateJsonSchema(exampleMessage)).toMatchInlineSnapshot(`
-      Object {
+      {
         "$comment": "Generated by https://github.com/foxglove/schemas",
         "description": "An example type",
-        "properties": Object {
-          "field_boolean": Object {
+        "properties": {
+          "field_boolean": {
             "description": "boolean field",
             "type": "boolean",
           },
-          "field_boolean_array": Object {
+          "field_boolean_array": {
             "description": "boolean array field",
-            "items": Object {
+            "items": {
               "type": "boolean",
             },
             "type": "array",
           },
-          "field_boolean_fixed_array": Object {
+          "field_boolean_fixed_array": {
             "description": "boolean fixed-length array field",
-            "items": Object {
+            "items": {
               "type": "boolean",
             },
             "maxItems": 3,
             "minItems": 3,
             "type": "array",
           },
-          "field_bytes": Object {
+          "field_bytes": {
             "contentEncoding": "base64",
             "description": "bytes field",
             "type": "string",
           },
-          "field_bytes_array": Object {
+          "field_bytes_array": {
             "description": "bytes array field",
-            "items": Object {
+            "items": {
               "contentEncoding": "base64",
               "type": "string",
             },
             "type": "array",
           },
-          "field_bytes_fixed_array": Object {
+          "field_bytes_fixed_array": {
             "description": "bytes fixed-length array field",
-            "items": Object {
+            "items": {
               "contentEncoding": "base64",
               "type": "string",
             },
@@ -54,31 +54,31 @@ describe("generateJsonSchema", () => {
             "minItems": 3,
             "type": "array",
           },
-          "field_duration": Object {
+          "field_duration": {
             "description": "duration field",
-            "properties": Object {
-              "nsec": Object {
+            "properties": {
+              "nsec": {
                 "maximum": 999999999,
                 "minimum": 0,
                 "type": "integer",
               },
-              "sec": Object {
+              "sec": {
                 "type": "integer",
               },
             },
             "title": "duration",
             "type": "object",
           },
-          "field_duration_array": Object {
+          "field_duration_array": {
             "description": "duration array field",
-            "items": Object {
-              "properties": Object {
-                "nsec": Object {
+            "items": {
+              "properties": {
+                "nsec": {
                   "maximum": 999999999,
                   "minimum": 0,
                   "type": "integer",
                 },
-                "sec": Object {
+                "sec": {
                   "type": "integer",
                 },
               },
@@ -87,16 +87,16 @@ describe("generateJsonSchema", () => {
             },
             "type": "array",
           },
-          "field_duration_fixed_array": Object {
+          "field_duration_fixed_array": {
             "description": "duration fixed-length array field",
-            "items": Object {
-              "properties": Object {
-                "nsec": Object {
+            "items": {
+              "properties": {
+                "nsec": {
                   "maximum": 999999999,
                   "minimum": 0,
                   "type": "integer",
                 },
-                "sec": Object {
+                "sec": {
                   "type": "integer",
                 },
               },
@@ -107,15 +107,15 @@ describe("generateJsonSchema", () => {
             "minItems": 3,
             "type": "array",
           },
-          "field_enum": Object {
+          "field_enum": {
             "description": "An enum field",
-            "oneOf": Array [
-              Object {
+            "oneOf": [
+              {
                 "const": 1,
                 "description": "Value A",
                 "title": "A",
               },
-              Object {
+              {
                 "const": 2,
                 "description": "Value B",
                 "title": "B",
@@ -123,17 +123,17 @@ describe("generateJsonSchema", () => {
             ],
             "title": "foxglove.ExampleEnum",
           },
-          "field_enum_array": Object {
+          "field_enum_array": {
             "description": "An enum array field",
-            "items": Object {
+            "items": {
               "description": "An enum array field",
-              "oneOf": Array [
-                Object {
+              "oneOf": [
+                {
                   "const": 1,
                   "description": "Value A",
                   "title": "A",
                 },
-                Object {
+                {
                   "const": 2,
                   "description": "Value B",
                   "title": "B",
@@ -143,30 +143,30 @@ describe("generateJsonSchema", () => {
             },
             "type": "array",
           },
-          "field_float64": Object {
+          "field_float64": {
             "description": "float64 field",
             "type": "number",
           },
-          "field_float64_array": Object {
+          "field_float64_array": {
             "description": "float64 array field",
-            "items": Object {
+            "items": {
               "type": "number",
             },
             "type": "array",
           },
-          "field_float64_fixed_array": Object {
+          "field_float64_fixed_array": {
             "description": "float64 fixed-length array field",
-            "items": Object {
+            "items": {
               "type": "number",
             },
             "maxItems": 3,
             "minItems": 3,
             "type": "array",
           },
-          "field_nested": Object {
+          "field_nested": {
             "description": "A nested field",
-            "properties": Object {
-              "field_enum": Object {
+            "properties": {
+              "field_enum": {
                 "description": "An enum field",
                 "minimum": 0,
                 "type": "integer",
@@ -175,17 +175,17 @@ describe("generateJsonSchema", () => {
             "title": "foxglove.NestedMessage",
             "type": "object",
           },
-          "field_nested_array": Object {
+          "field_nested_array": {
             "description": "A nested array field
       With
       a
       very
       long
       description",
-            "items": Object {
+            "items": {
               "description": "An example nested message",
-              "properties": Object {
-                "field_enum": Object {
+              "properties": {
+                "field_enum": {
                   "description": "An enum field",
                   "minimum": 0,
                   "type": "integer",
@@ -196,35 +196,35 @@ describe("generateJsonSchema", () => {
             },
             "type": "array",
           },
-          "field_string": Object {
+          "field_string": {
             "description": "string field",
             "type": "string",
           },
-          "field_string_array": Object {
+          "field_string_array": {
             "description": "string array field",
-            "items": Object {
+            "items": {
               "type": "string",
             },
             "type": "array",
           },
-          "field_string_fixed_array": Object {
+          "field_string_fixed_array": {
             "description": "string fixed-length array field",
-            "items": Object {
+            "items": {
               "type": "string",
             },
             "maxItems": 3,
             "minItems": 3,
             "type": "array",
           },
-          "field_time": Object {
+          "field_time": {
             "description": "time field",
-            "properties": Object {
-              "nsec": Object {
+            "properties": {
+              "nsec": {
                 "maximum": 999999999,
                 "minimum": 0,
                 "type": "integer",
               },
-              "sec": Object {
+              "sec": {
                 "minimum": 0,
                 "type": "integer",
               },
@@ -232,16 +232,16 @@ describe("generateJsonSchema", () => {
             "title": "time",
             "type": "object",
           },
-          "field_time_array": Object {
+          "field_time_array": {
             "description": "time array field",
-            "items": Object {
-              "properties": Object {
-                "nsec": Object {
+            "items": {
+              "properties": {
+                "nsec": {
                   "maximum": 999999999,
                   "minimum": 0,
                   "type": "integer",
                 },
-                "sec": Object {
+                "sec": {
                   "minimum": 0,
                   "type": "integer",
                 },
@@ -251,16 +251,16 @@ describe("generateJsonSchema", () => {
             },
             "type": "array",
           },
-          "field_time_fixed_array": Object {
+          "field_time_fixed_array": {
             "description": "time fixed-length array field",
-            "items": Object {
-              "properties": Object {
-                "nsec": Object {
+            "items": {
+              "properties": {
+                "nsec": {
                   "maximum": 999999999,
                   "minimum": 0,
                   "type": "integer",
                 },
-                "sec": Object {
+                "sec": {
                   "minimum": 0,
                   "type": "integer",
                 },
@@ -272,22 +272,22 @@ describe("generateJsonSchema", () => {
             "minItems": 3,
             "type": "array",
           },
-          "field_uint32": Object {
+          "field_uint32": {
             "description": "uint32 field",
             "minimum": 0,
             "type": "integer",
           },
-          "field_uint32_array": Object {
+          "field_uint32_array": {
             "description": "uint32 array field",
-            "items": Object {
+            "items": {
               "minimum": 0,
               "type": "integer",
             },
             "type": "array",
           },
-          "field_uint32_fixed_array": Object {
+          "field_uint32_fixed_array": {
             "description": "uint32 fixed-length array field",
-            "items": Object {
+            "items": {
               "minimum": 0,
               "type": "integer",
             },

package/src/generateProto.test.ts

@@ -9,11 +9,11 @@ describe("generateProto", () => {
     expect(generateProto(exampleMessage, [exampleEnum])).toMatchInlineSnapshot(`
       "// Generated by https://github.com/foxglove/schemas
 
-      syntax = \\"proto3\\";
+      syntax = "proto3";
 
-      import \\"foxglove/NestedMessage.proto\\";
-      import \\"google/protobuf/duration.proto\\";
-      import \\"google/protobuf/timestamp.proto\\";
+      import "foxglove/NestedMessage.proto";
+      import "google/protobuf/duration.proto";
+      import "google/protobuf/timestamp.proto";
 
       package foxglove;
 
@@ -37,67 +37,67 @@ describe("generateProto", () => {
         bool field_boolean = 3;
 
         // bytes field
-        bytes field_bytes = 4;
+        bytes field_bytes = 5;
 
         // float64 field
-        double field_float64 = 5;
+        double field_float64 = 6;
 
         // uint32 field
-        fixed32 field_uint32 = 6;
+        fixed32 field_uint32 = 7;
 
         // string field
-        string field_string = 7;
+        string field_string = 8;
 
         // duration array field
-        repeated google.protobuf.Duration field_duration_array = 8;
+        repeated google.protobuf.Duration field_duration_array = 9;
 
         // time array field
-        repeated google.protobuf.Timestamp field_time_array = 9;
+        repeated google.protobuf.Timestamp field_time_array = 10;
 
         // boolean array field
-        repeated bool field_boolean_array = 10;
+        repeated bool field_boolean_array = 11;
 
         // bytes array field
-        repeated bytes field_bytes_array = 11;
+        repeated bytes field_bytes_array = 12;
 
         // float64 array field
-        repeated double field_float64_array = 12;
+        repeated double field_float64_array = 13;
 
         // uint32 array field
-        repeated fixed32 field_uint32_array = 13;
+        repeated fixed32 field_uint32_array = 14;
 
         // string array field
-        repeated string field_string_array = 14;
+        repeated string field_string_array = 15;
 
         // duration fixed-length array field
-        repeated google.protobuf.Duration field_duration_fixed_array = 15; // length 3
+        repeated google.protobuf.Duration field_duration_fixed_array = 16; // length 3
 
         // time fixed-length array field
-        repeated google.protobuf.Timestamp field_time_fixed_array = 16; // length 3
+        repeated google.protobuf.Timestamp field_time_fixed_array = 17; // length 3
 
         // boolean fixed-length array field
-        repeated bool field_boolean_fixed_array = 17; // length 3
+        repeated bool field_boolean_fixed_array = 18; // length 3
 
         // bytes fixed-length array field
-        repeated bytes field_bytes_fixed_array = 18; // length 3
+        repeated bytes field_bytes_fixed_array = 19; // length 3
 
         // float64 fixed-length array field
-        repeated double field_float64_fixed_array = 19; // length 3
+        repeated double field_float64_fixed_array = 20; // length 3
 
         // uint32 fixed-length array field
-        repeated fixed32 field_uint32_fixed_array = 20; // length 3
+        repeated fixed32 field_uint32_fixed_array = 21; // length 3
 
         // string fixed-length array field
-        repeated string field_string_fixed_array = 21; // length 3
+        repeated string field_string_fixed_array = 22; // length 3
 
         // An enum field
-        ExampleProtoEnum field_enum = 22;
+        ExampleProtoEnum field_enum = 23;
 
         // An enum array field
-        repeated ExampleProtoEnum field_enum_array = 23;
+        repeated ExampleProtoEnum field_enum_array = 24;
 
         // A nested field
-        foxglove.NestedMessage field_nested = 24;
+        foxglove.NestedMessage field_nested = 25;
 
         // A nested array field
         // With
@@ -105,7 +105,7 @@ describe("generateProto", () => {
         // very
         // long
         // description
-        repeated foxglove.NestedMessage field_nested_array = 25;
+        repeated foxglove.NestedMessage field_nested_array = 4;
       }
       "
     `);

package/src/generateProto.ts

@@ -1,4 +1,9 @@
-import { FoxgloveEnumSchema, FoxgloveMessageSchema, FoxglovePrimitive } from "./types";
+import {
+  FoxgloveEnumSchema,
+  FoxgloveMessageField,
+  FoxgloveMessageSchema,
+  FoxglovePrimitive,
+} from "./types";
 
 function primitiveToProto(type: Exclude<FoxglovePrimitive, "time" | "duration">) {
   switch (type) {
@@ -35,9 +40,33 @@ export function generateProto(
     );
   }
 
-  let fieldNumber = 1;
+  const explicitFieldNumbers = new Set<number>();
+  for (const field of schema.fields) {
+    if (field.protobufFieldNumber != undefined) {
+      if (explicitFieldNumbers.has(field.protobufFieldNumber)) {
+        throw new Error(
+          `More than one field with protobufFieldNumber ${field.protobufFieldNumber}`,
+        );
+      }
+      explicitFieldNumbers.add(field.protobufFieldNumber);
+    }
+  }
+
+  let nextFieldNumber = 1;
+  const numberedFields = schema.fields.map(
+    (field): FoxgloveMessageField & { protobufFieldNumber: number } => {
+      if (field.protobufFieldNumber != undefined) {
+        return { ...field, protobufFieldNumber: field.protobufFieldNumber };
+      }
+      while (explicitFieldNumbers.has(nextFieldNumber)) {
+        ++nextFieldNumber;
+      }
+      return { ...field, protobufFieldNumber: nextFieldNumber++ };
+    },
+  );
+
   const imports = new Set<string>();
-  const fields = schema.fields.map((field) => {
+  const fields = numberedFields.map((field) => {
     const lineComments: string[] = [];
     const qualifiers: string[] = [];
     if (field.array != undefined) {
@@ -70,7 +99,7 @@ export function generateProto(
       .trim()
       .split("\n")
       .map((line) => `  // ${line}\n`)
-      .join("")}  ${qualifiers.join(" ")} ${field.name} = ${fieldNumber++};${
+      .join("")}  ${qualifiers.join(" ")} ${field.name} = ${field.protobufFieldNumber};${
       lineComments.length > 0 ? " // " + lineComments.join(", ") : ""
     }`;
   });