feat: Package JSON Schema with plugins (#1494)

Add the JSON schema if exists during plugin `package` command

---

Author: erezrokah

plugin/plugin.go

@@ -126,6 +126,10 @@ func (p *Plugin) Version() string {
 	return p.version
 }
 
+func (p *Plugin) JSONSchema() string {
+	return p.schema
+}
+
 func (p *Plugin) Meta() Meta {
 	return Meta{
 		Team:            p.team,

serve/package.go

@@ -234,6 +234,14 @@ func (s *PluginServe) writePackageJSON(dir, version, message string, targets []T
 	return os.WriteFile(outputPath, buffer.Bytes(), 0644)
 }
 
+func (s *PluginServe) writeSpecJSONSchema(dir string) error {
+	if s.plugin.JSONSchema() == "" {
+		return nil
+	}
+
+	return os.WriteFile(filepath.Join(dir, "spec_json_schema.json"), []byte(s.plugin.JSONSchema()), 0644)
+}
+
 func (*PluginServe) copyDocs(distPath, docsPath string) error {
 	err := os.MkdirAll(filepath.Join(distPath, "docs"), 0755)
 	if err != nil {
@@ -427,6 +435,9 @@ func (s *PluginServe) newCmdPluginPackage() *cobra.Command {
 			if err := s.copyDocs(distPath, docsPath); err != nil {
 				return fmt.Errorf("failed to copy docs: %w", err)
 			}
+			if err := s.writeSpecJSONSchema(distPath); err != nil {
+				return fmt.Errorf("failed to write spec json schema: %w", err)
+			}
 			return nil
 		},
 	}

serve/package_test.go

@@ -21,6 +21,12 @@ import (
 //go:embed testdata/memdbtables.json
 var memDBPackageJSON string
 
+//go:embed testdata/source_spec_schema.json
+var sourceSpecSchema string
+
+//go:embed testdata/destination_spec_schema.json
+var destinationSpecSchema string
+
 func TestPluginPackage_Source(t *testing.T) {
 	_, filename, _, ok := runtime.Caller(0)
 	if !ok {
@@ -39,6 +45,7 @@ func TestPluginPackage_Source(t *testing.T) {
 		}),
 		plugin.WithKind("source"),
 		plugin.WithTeam("test-team"),
+		plugin.WithJSONSchema(sourceSpecSchema),
 	)
 	msg := `Test message
 with multiple lines and **markdown**`
@@ -78,6 +85,7 @@ with multiple lines and **markdown**`
 				"package.json",
 				"plugin-test-plugin-v1.2.3-linux-amd64.zip",
 				"plugin-test-plugin-v1.2.3-windows-amd64.zip",
+				"spec_json_schema.json",
 				"tables.json",
 			}
 			if diff := cmp.Diff(expect, fileNames(files)); diff != "" {
@@ -112,6 +120,7 @@ with multiple lines and **markdown**`
 			}
 			checkDocs(t, filepath.Join(distDir, "docs"), expectDocs)
 			checkTables(t, distDir)
+			checkFileContent(t, filepath.Join(distDir, "spec_json_schema.json"), sourceSpecSchema)
 		})
 	}
 }
@@ -134,6 +143,7 @@ func TestPluginPackage_Destination(t *testing.T) {
 		}),
 		plugin.WithKind("destination"),
 		plugin.WithTeam("test-team"),
+		plugin.WithJSONSchema(destinationSpecSchema),
 	)
 	msg := `Test message
 with multiple lines and **markdown**`
@@ -173,6 +183,7 @@ with multiple lines and **markdown**`
 				"package.json",
 				"plugin-test-plugin-v1.2.3-darwin-amd64.zip",
 				"plugin-test-plugin-v1.2.3-windows-amd64.zip",
+				"spec_json_schema.json",
 			}
 			if diff := cmp.Diff(expect, fileNames(files)); diff != "" {
 				t.Fatalf("unexpected files in dist directory (-want +got):\n%s", diff)
@@ -205,6 +216,7 @@ with multiple lines and **markdown**`
 				"overview.md",
 			}
 			checkDocs(t, filepath.Join(distDir, "docs"), expectDocs)
+			checkFileContent(t, filepath.Join(distDir, "spec_json_schema.json"), destinationSpecSchema)
 		})
 	}
 }
@@ -327,6 +339,21 @@ func checkPackageJSONContents(t *testing.T, filename string, expect PackageJSON)
 	}
 }
 
+func checkFileContent(t *testing.T, filename string, expect string) {
+	f, err := os.Open(filename)
+	if err != nil {
+		t.Fatalf("failed to open %s: %v", filename, err)
+	}
+	defer f.Close()
+	b, err := io.ReadAll(f)
+	if err != nil {
+		t.Fatalf("failed to read %s: %v", filename, err)
+	}
+	if diff := cmp.Diff(expect, string(b)); diff != "" {
+		t.Fatalf("%s contents mismatch (-want +got):\n%s", filename, diff)
+	}
+}
+
 func fileNames(files []os.DirEntry) []string {
 	names := make([]string, 0, len(files))
 	for _, file := range files {

serve/testdata/destination_spec_schema.json

@@ -0,0 +1,15 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$ref": "#/$defs/Spec",
+    "$defs": {
+      "Spec": {
+        "properties": {
+          "connection_string": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": false,
+        "type": "object"
+      }
+    }
+  }

serve/testdata/source_spec_schema.json

@@ -0,0 +1,15 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$ref": "#/$defs/Spec",
+    "$defs": {
+      "Spec": {
+        "properties": {
+          "concurrency": {
+            "type": "integer"
+          }
+        },
+        "additionalProperties": false,
+        "type": "object"
+      }
+    }
+  }