chore: fixup json types for diagnostics

Author: Emyrk

extract/parameter.go

@@ -78,7 +78,7 @@ func ParameterFromBlock(block *terraform.Block) (*types.Parameter, hcl.Diagnosti
 	}
 
 	// Diagnostics are scoped to the parameter
-	p.Diagnostics = diags
+	p.Diagnostics = types.Diagnostics(diags)
 
 	return &p, nil
 }

types/diagnostics.go

@@ -0,0 +1,41 @@
+package types
+
+import (
+	"encoding/json"
+
+	"github.com/hashicorp/hcl/v2"
+)
+
+// Diagnostics is a JSON friendly form of hcl.Diagnostics.
+// Data is lost when doing a json marshal.
+type Diagnostics hcl.Diagnostics
+
+func (d Diagnostics) MarshalJSON() ([]byte, error) {
+	cpy := make([]FriendlyDiagnostic, 0, len(d))
+	for _, diag := range d {
+		severity := DiagnosticSeverityError
+		if diag.Severity == hcl.DiagWarning {
+			severity = DiagnosticSeverityWarning
+		}
+
+		cpy = append(cpy, FriendlyDiagnostic{
+			Severity: severity,
+			Summary:  diag.Summary,
+			Detail:   diag.Detail,
+		})
+	}
+	return json.Marshal(cpy)
+}
+
+type DiagnosticSeverityString string
+
+const (
+	DiagnosticSeverityError   DiagnosticSeverityString = "error"
+	DiagnosticSeverityWarning DiagnosticSeverityString = "warning"
+)
+
+type FriendlyDiagnostic struct {
+	Severity DiagnosticSeverityString `json:"severity"`
+	Summary  string                   `json:"summary"`
+	Detail   string                   `json:"detail"`
+}

types/parameter.go

@@ -1,13 +1,10 @@
 package types
 
 import (
-	"crypto/sha256"
-	"encoding/json"
 	"fmt"
 	"slices"
 	"strings"
 
-	"github.com/hashicorp/hcl/v2"
 	"github.com/zclconf/go-cty/cty"
 )
 
@@ -38,7 +35,7 @@ type Parameter struct {
 
 	// Diagnostics is used to store any errors that occur during parsing
 	// of the parameter.
-	Diagnostics hcl.Diagnostics `json:"-" hcl:"-"`
+	Diagnostics Diagnostics `json:"diagnostics"`
 }
 
 type RichParameter struct {
@@ -73,17 +70,6 @@ type ParameterOption struct {
 	Icon        string `json:"icon"`
 }
 
-// Hash can be used to compare two RichParameter objects at a glance.
-func (r *RichParameter) Hash() ([32]byte, error) {
-	// Option order matters, so just json marshal the whole thing.
-	data, err := json.Marshal(r)
-	if err != nil {
-		return [32]byte{}, fmt.Errorf("marshal: %w", err)
-	}
-
-	return sha256.Sum256(data), nil
-}
-
 // CtyType returns the cty.Type for the RichParameter.
 // A fixed set of types are supported.
 func (r *RichParameter) CtyType() (cty.Type, error) {

web/diagnostic.go

@@ -9,6 +9,7 @@ import (
 	"golang.org/x/xerrors"
 
 	"github.com/coder/guts"
+	"github.com/coder/guts/bindings"
 	"github.com/coder/guts/config"
 )
 
@@ -85,7 +86,15 @@ func TsMutations(ts *guts.Typescript) {
 func TypeMappings(gen *guts.GoParser) error {
 	gen.IncludeCustomDeclaration(config.StandardMappings())
 
-	gen.IncludeCustomDeclaration(map[string]guts.TypeOverride{})
+	gen.IncludeCustomDeclaration(map[string]guts.TypeOverride{
+		"github.com/hashicorp/hcl/v2.Diagnostic": func() bindings.ExpressionType {
+			return bindings.Reference(bindings.Identifier{
+				Name:    "FriendlyDiagnostic",
+				Package: nil,
+				Prefix:  "",
+			})
+		},
+	})
 
 	err := gen.IncludeCustom(map[string]string{
 		"github.com/coder/preview/types.HCLString": "string",

web/genweb/main.go

@@ -18,7 +18,7 @@ type Request struct {
 
 type Response struct {
 	ID          int               `json:"id"`
-	Diagnostics Diagnostics       `json:"diagnostics"`
+	Diagnostics types.Diagnostics `json:"diagnostics"`
 	Parameters  []types.Parameter `json:"parameters"`
 	// TODO: Workspace tags
 }
@@ -73,7 +73,7 @@ func (s *Session) preview(ctx context.Context, req *Request) Response {
 
 	r := Response{
 		ID:          req.ID,
-		Diagnostics: FromHCLDiagnostics(diags),
+		Diagnostics: types.Diagnostics(diags),
 	}
 	if output == nil {
 		return r

web/session.go

@@ -1,23 +1,24 @@
 // Code generated by 'guts'. DO NOT EDIT.
 
-// From web/diagnostic.go
-export interface Diagnostic {
-    readonly severity: DiagnosticSeverity;
-    readonly summary: string;
-    readonly detail: string;
-}
+// From types/diagnostics.go
+export type DiagnosticSeverityString = "error" | "warning";
 
-// From web/diagnostic.go
-export type DiagnosticSeverity = "error" | "warning";
+export const DiagnosticSeverityStrings: DiagnosticSeverityString[] = ["error", "warning"];
 
-export const DiagnosticSeveritys: DiagnosticSeverity[] = ["error", "warning"];
+// From types/diagnostics.go
+export type Diagnostics = readonly (FriendlyDiagnostic)[];
 
-// From web/diagnostic.go
-export type Diagnostics = readonly Diagnostic[];
+// From types/diagnostics.go
+export interface FriendlyDiagnostic {
+    readonly severity: DiagnosticSeverityString;
+    readonly summary: string;
+    readonly detail: string;
+}
 
 // From types/parameter.go
 export interface Parameter extends RichParameter {
     readonly value: string;
+    readonly diagnostics: Diagnostics;
 }
 
 // From types/parameter.go
@@ -44,12 +45,13 @@ export interface ParameterValidation {
 
 // From web/session.go
 export interface Request {
-    readonly ID: number;
-    readonly Inputs: Record<string, string>;
+    readonly id: number;
+    readonly inputs: Record<string, string>;
 }
 
 // From web/session.go
 export interface Response {
+    readonly id: number;
     readonly diagnostics: Diagnostics;
     readonly parameters: readonly Parameter[];
 }