more testing

Author: carldunham

v2/pkg/engine/resolve/multipart_json_writer.go

@@ -38,48 +38,48 @@ func (w *MultipartJSONWriter) Write(p []byte) (n int, err error) {
 	return n, nil
 }
 
-func (w *MultipartJSONWriter) Flush(path []any) error {
+func (w *MultipartJSONWriter) Flush(path []any) (err error) {
 	if w.buf.Len() == 0 {
 		return nil
 	}
 
+	var part incrementalPart
+
+	if err := json.Unmarshal(w.buf.Bytes(), &part); err != nil {
+		return fmt.Errorf("unmarshaling data: %w", err)
+	}
+	part.HasNext = true
+
 	if _, err := w.Writer.Write(w.partHeader()); err != nil {
 		return fmt.Errorf("writing part header: %w", err)
 	}
 	defer w.buf.Reset()
 
 	if w.wroteInitial {
-		if _, err := w.Writer.Write([]byte(`{"hasNext":true,"incremental":[`)); err != nil {
-			return fmt.Errorf("writing increment preamble: %w", err)
+		part.Incremental = []incrementalDataPart{
+			{
+				Data: part.Data,
+				Path: path,
+			},
 		}
-	}
+		part.Data = nil
 
-	if _, err := w.buf.WriteTo(w.Writer); err != nil {
-		return fmt.Errorf("writing incremental data: %w", err)
-	}
-
-	if w.wroteInitial {
 		if len(path) > 0 {
-			if _, err := w.Writer.Write([]byte(`,"path":`)); err != nil {
-				return fmt.Errorf("writing incremental trailer: %w", err)
-			}
-
-			var buf bytes.Buffer
-			if err := json.NewEncoder(&buf).Encode(path); err != nil {
-				return fmt.Errorf("encoding path: %w", err)
-			}
-			if buf.Len() > 0 {
-				buf.Truncate(buf.Len() - 1) // remove trailing newline
-			}
-			if _, err := buf.WriteTo(w.Writer); err != nil {
-				return fmt.Errorf("writing path: %w", err)
-			}
+			part.Incremental[0].Path = path
 		}
+	}
 
-		if _, err := w.Writer.Write([]byte(`]}`)); err != nil {
-			return fmt.Errorf("writing incremental trailer: %w", err)
-		}
+	var buf bytes.Buffer
+	if err := json.NewEncoder(&buf).Encode(part); err != nil {
+		return fmt.Errorf("encoding part body: %w", err)
 	}
+	if buf.Len() > 0 {
+		buf.Truncate(buf.Len() - 1) // remove trailing newline
+	}
+	if _, err := buf.WriteTo(w.Writer); err != nil {
+		return fmt.Errorf("writing part body: %w", err)
+	}
+
 	if _, err := w.Writer.Write([]byte("\r\n")); err != nil {
 		return fmt.Errorf("writing part terminator: %w", err)
 	}
@@ -111,3 +111,20 @@ func (w *MultipartJSONWriter) boundaryToken() string {
 	}
 	return w.BoundaryToken
 }
+
+// incrementalPart is a part of a multipart response.
+// It can contain a full response (for the first or only part) in `data`, or an incremental part in `incremental`.
+type incrementalPart struct {
+	HasNext bool `json:"hasNext"`
+
+	Data        json.RawMessage       `json:"data,omitempty"`
+	Incremental []incrementalDataPart `json:"incremental,omitempty"`
+
+	Errors     json.RawMessage `json:"errors,omitempty"`
+	Extensions json.RawMessage `json:"extensions,omitempty"`
+}
+
+type incrementalDataPart struct {
+	Data json.RawMessage `json:"data"`
+	Path []any           `json:"path,omitempty"`
+}

v2/pkg/engine/resolve/multipart_json_writer_test.go

@@ -25,19 +25,19 @@ func TestMultipartJSONWriter(t *testing.T) {
 			name:          "simple case",
 			boundaryToken: "boundary",
 			path:          []any{"path", "to", "part"},
-			parts:         [][]string{[]string{`"part1"`}, []string{`"part2"`}, []string{`"part3"`}},
+			parts:         [][]string{[]string{`{"data":"part1"}`}, []string{`{"data":"part2"}`}, []string{`{"data":"part3"}`}},
 			expected: strings.ReplaceAll(`--boundary
 Content-Type: application/json; charset=utf-8
 
-"part1"
+{"hasNext":true,"data":"part1"}
 --boundary
 Content-Type: application/json; charset=utf-8
 
-{"hasNext":true,"incremental":["part2","path":["path","to","part"]]}
+{"hasNext":true,"incremental":[{"data":"part2","path":["path","to","part"]}]}
 --boundary
 Content-Type: application/json; charset=utf-8
 
-{"hasNext":true,"incremental":["part3","path":["path","to","part"]]}
+{"hasNext":true,"incremental":[{"data":"part3","path":["path","to","part"]}]}
 --boundary
 Content-Type: application/json; charset=utf-8
 
@@ -49,19 +49,19 @@ Content-Type: application/json; charset=utf-8
 			name:          "multiple writes",
 			boundaryToken: "boundary",
 			path:          []any{"path", 4, "part"},
-			parts:         [][]string{[]string{`"part1a`, `part1b"`}, []string{`"part2"`}, []string{`"part3a`, `part3b"`}},
+			parts:         [][]string{[]string{`{"data":`, `"part1a`, `part1b"}`}, []string{`{"data":"part2"}`}, []string{`{"data":"part3a`, `part3b"}`}},
 			expected: strings.ReplaceAll(`--boundary
 Content-Type: application/json; charset=utf-8
 
-"part1apart1b"
+{"hasNext":true,"data":"part1apart1b"}
 --boundary
 Content-Type: application/json; charset=utf-8
 
-{"hasNext":true,"incremental":["part2","path":["path",4,"part"]]}
+{"hasNext":true,"incremental":[{"data":"part2","path":["path",4,"part"]}]}
 --boundary
 Content-Type: application/json; charset=utf-8
 
-{"hasNext":true,"incremental":["part3apart3b","path":["path",4,"part"]]}
+{"hasNext":true,"incremental":[{"data":"part3apart3b","path":["path",4,"part"]}]}
 --boundary
 Content-Type: application/json; charset=utf-8
 
@@ -139,7 +139,7 @@ func TestMultipartJSONWriter_Flush(t *testing.T) {
 	}{
 		{
 			name:        "successful flush",
-			input:       []byte("test data"),
+			input:       []byte(`{"data":"test data"}`),
 			expectedErr: nil,
 		},
 		{
@@ -149,7 +149,7 @@ func TestMultipartJSONWriter_Flush(t *testing.T) {
 		},
 		{
 			name:        "flush with error",
-			input:       []byte("error data"),
+			input:       []byte(`{"error": "data"}`),
 			expectedErr: errors.New("flush error"),
 		},
 	}

v2/pkg/engine/resolve/resolve_test.go

@@ -4865,11 +4865,11 @@ func TestResolver_ResolveGraphQLIncrementalResponse(t *testing.T) {
 			expected: strings.ReplaceAll(`--graphql-go-tools
 Content-Type: application/json; charset=utf-8
 
-{"data":{"hero":{"name":"Luke"}}}
+{"hasNext":true,"data":{"hero":{"name":"Luke"}}}
 --graphql-go-tools
 Content-Type: application/json; charset=utf-8
 
-{"hasNext":true,"incremental":[{"data":{"__typename":"Droid","primaryFunction":"Astromech","favoriteEpisode":"NEWHOPE"}},"path":["hero"]]}
+{"hasNext":true,"incremental":[{"data":{"__typename":"Droid","primaryFunction":"Astromech","favoriteEpisode":"NEWHOPE"},"path":["hero"]}]}
 --graphql-go-tools
 Content-Type: application/json; charset=utf-8