Merge pull request #650 from k1LoW/fix-jsonschema

Fix JSON Schema
k1LoW · Jan 26, 2025 · 75fefd8 · 75fefd8
2 parents f542f95 + d7d5854
commit 75fefd8
Show file tree

Hide file tree

Showing 18 changed files with 62 additions and 29 deletions.
diff --git a/Makefile b/Makefile
@@ -152,6 +152,8 @@ test_ext_driver: build
 
 test_jsonschema:
 	cd scripts/jsonschema && go run main.go | diff -u ../../spec/tbls.schema.json_schema.json -
+	jv spec/tbls.schema.json_schema.json --assert-content sample/mysql/schema.json
+	jv spec/tbls.schema.json_schema.json --assert-content sample/postgres/schema.json
 
 generate_jsonschema:
 	cd scripts/jsonschema && go run main.go > ../../spec/tbls.schema.json_schema.json
@@ -172,6 +174,7 @@ depsdev:
 	go install github.com/xo/usql@latest
 	go install github.com/Songmu/gocredits/cmd/gocredits@latest
 	go install github.com/securego/gosec/v2/cmd/gosec@latest
+	go install github.com/santhosh-tekuri/jsonschema/cmd/jv@latest
 
 prerelease:
 	git pull origin --tag

diff --git a/sample/dict/schema.json b/sample/dict/schema.json
diff --git a/sample/exclude/schema.json b/sample/exclude/schema.json
diff --git a/sample/font/schema.json b/sample/font/schema.json
diff --git a/sample/hide/schema.json b/sample/hide/schema.json
diff --git a/sample/hide_not_related_column/schema.json b/sample/hide_not_related_column/schema.json
diff --git a/sample/mermaid/schema.json b/sample/mermaid/schema.json
diff --git a/sample/mssql/schema.json b/sample/mssql/schema.json
diff --git a/sample/mysql/schema.json b/sample/mysql/schema.json
diff --git a/sample/number/schema.json b/sample/number/schema.json
diff --git a/sample/png/schema.json b/sample/png/schema.json
diff --git a/sample/viewpoints/schema.json b/sample/viewpoints/schema.json
diff --git a/schema/json.go b/schema/json.go
@@ -12,7 +12,7 @@ type SchemaJSON struct {
 	Relations  []*RelationJSON `json:"relations,omitempty"`
 	Functions  []*Function     `json:"functions,omitempty"`
 	Enums      []*Enum         `json:"enums,omitempty"`
-	Driver     *Driver         `json:"driver,omitempty"`
+	Driver     *DriverJSON     `json:"driver,omitempty"`
 	Labels     Labels          `json:"labels,omitempty"`
 	Viewpoints Viewpoints      `json:"viewpoints,omitempty"`
 }
@@ -54,6 +54,18 @@ type RelationJSON struct {
 	Virtual           bool     `json:"virtual,omitempty"`
 }
 
+type DriverJSON struct {
+	Name            string          `json:"name"`
+	DatabaseVersion string          `json:"database_version,omitempty" yaml:"databaseVersion,omitempty"`
+	Meta            *DriverMetaJSON `json:"meta,omitempty"`
+}
+
+type DriverMetaJSON struct {
+	CurrentSchema string            `json:"current_schema,omitempty" yaml:"currentSchema,omitempty"`
+	SearchPaths   []string          `json:"search_paths,omitempty" yaml:"searchPaths,omitempty"`
+	Dict          map[string]string `json:"dict,omitempty"`
+}
+
 // ToJSONObjct convert schema.Schema to JSON object
 func (s Schema) ToJSONObject() SchemaJSON {
 	var tables []*TableJSON
@@ -73,7 +85,7 @@ func (s Schema) ToJSONObject() SchemaJSON {
 		Relations:  relations,
 		Functions:  s.Functions,
 		Enums:      s.Enums,
-		Driver:     s.Driver,
+		Driver:     s.Driver.ToJSONObject(),
 		Labels:     s.Labels,
 		Viewpoints: s.Viewpoints,
 	}
@@ -140,6 +152,31 @@ func (r Relation) ToJSONObject() RelationJSON {
 	}
 }
 
+func (d *Driver) ToJSONObject() *DriverJSON {
+	if d == nil {
+		return nil
+	}
+	return &DriverJSON{
+		Name:            d.Name,
+		DatabaseVersion: d.DatabaseVersion,
+		Meta:            d.Meta.ToJSONObject(),
+	}
+}
+
+func (d *DriverMeta) ToJSONObject() *DriverMetaJSON {
+	if d == nil {
+		return nil
+	}
+	m := &DriverMetaJSON{
+		CurrentSchema: d.CurrentSchema,
+		SearchPaths:   d.SearchPaths,
+	}
+	if d.Dict != nil {
+		m.Dict = d.Dict.Dump()
+	}
+	return m
+}
+
 // MarshalJSON return custom JSON byte
 func (s Schema) MarshalJSON() ([]byte, error) {
 	ss := s.ToJSONObject()

diff --git a/schema/schema.go b/schema/schema.go
@@ -102,7 +102,7 @@ type Constraint struct {
 	Def               string   `json:"def"`
 	Table             *string  `json:"table"`
 	ReferencedTable   *string  `json:"referenced_table,omitempty" yaml:"referencedTable,omitempty"`
-	Columns           []string `json:"columns"`
+	Columns           []string `json:"columns,omitempty"`
 	ReferencedColumns []string `json:"referenced_columns,omitempty" yaml:"referencedColumns,omitempty"`
 	Comment           string   `json:"comment,omitempty"`
 }

diff --git a/scripts/jsonschema/main.go b/scripts/jsonschema/main.go
@@ -31,7 +31,6 @@ func _main() error {
 	if err != nil {
 		return err
 	}
-	fmt.Println(string(b))
-	fmt.Println()
+	fmt.Print(string(b))
 	return nil
 }
diff --git a/spec/tbls.schema.json_schema.json b/spec/tbls.schema.json_schema.json
@@ -81,15 +81,9 @@
         "name",
         "type",
         "def",
-        "table",
-        "columns"
+        "table"
       ]
     },
-    "Dict": {
-      "properties": {},
-      "additionalProperties": false,
-      "type": "object"
-    },
     "Driver": {
       "properties": {
         "name": {
@@ -120,7 +114,10 @@
           "type": "array"
         },
         "dict": {
-          "$ref": "#/$defs/Dict"
+          "additionalProperties": {
+            "type": "string"
+          },
+          "type": "object"
         }
       },
       "additionalProperties": false,
@@ -475,5 +472,4 @@
       "type": "array"
     }
   }
-}
-
+}
diff --git a/testdata/json_output_schema.golden b/testdata/json_output_schema.golden
@@ -34,8 +34,7 @@
           "name": "PRIMARY",
           "type": "",
           "def": "PRIMARY KEY (a)",
-          "table": "a",
-          "columns": null
+          "table": "a"
         }
       ],
       "triggers": [

diff --git a/testdata/yaml_output_schema.golden b/testdata/yaml_output_schema.golden
@@ -23,7 +23,6 @@ tables:
     type: ""
     def: PRIMARY KEY (a)
     table: a
-    columns: []
   triggers:
   - name: update_a_a2
     def: CREATE CONSTRAINT TRIGGER update_a_a2 AFTER INSERT OR UPDATE ON a