fix: print indent once per level by default (#1147)

For v1 and v2 this fixes the default behaviour of the PrintIndent and
PrintStringIndent functions of astprinter. Instead of printing indent
twice for every depth level, it prints it once per level.

The fix does not alter output for other parts, golden tests
are intact. Tests were modified by passing correctly sized indent.

Fixes #405

Co-authored-by: Yury Smolski <yury@smolsky.by>

Author: ysmolski

execution/graphql/normalization_test.go

@@ -48,7 +48,7 @@ func TestRequest_Normalize(t *testing.T) {
         name
     }
 }`
-		op, _ := astprinter.PrintStringIndent(&request.document, "  ")
+		op, _ := astprinter.PrintStringIndent(&request.document, "    ")
 		assert.Equal(t, normalizedOperation, op)
 	})
 
@@ -64,7 +64,7 @@ func TestRequest_Normalize(t *testing.T) {
 		assert.True(t, result.Successful)
 		assert.True(t, request.isNormalized)
 
-		op, _ := astprinter.PrintStringIndent(&request.document, "  ")
+		op, _ := astprinter.PrintStringIndent(&request.document, "    ")
 		assert.Equal(t, expectedNormalizedOperation, op)
 	}
 

execution/graphql/schema.go

@@ -105,7 +105,7 @@ func (s *Schema) Normalize() (result NormalizationResult, err error) {
 	}
 
 	normalizedSchemaBuffer := &bytes.Buffer{}
-	err = astprinter.PrintIndent(&s.document, []byte("  "), normalizedSchemaBuffer)
+	err = astprinter.PrintIndent(&s.document, []byte("    "), normalizedSchemaBuffer)
 	if err != nil {
 		return NormalizationResult{
 			Successful: false,
@@ -402,7 +402,7 @@ func createSchema(schemaContent []byte, mergeWithBaseSchema bool) (*Schema, erro
 		}
 
 		rawSchemaBuffer := &bytes.Buffer{}
-		err = astprinter.PrintIndent(&document, []byte("  "), rawSchemaBuffer)
+		err = astprinter.PrintIndent(&document, []byte("    "), rawSchemaBuffer)
 		if err != nil {
 			return nil, err
 		}

execution/graphql/schema_test.go

@@ -292,7 +292,7 @@ func TestSchema_Document(t *testing.T) {
 	require.NoError(t, err)
 
 	expectedSchemaBytesBuffer := &bytes.Buffer{}
-	err = astprinter.PrintIndent(&document, []byte("  "), expectedSchemaBytesBuffer)
+	err = astprinter.PrintIndent(&document, []byte("    "), expectedSchemaBytesBuffer)
 	require.NoError(t, err)
 
 	assert.Equal(t, expectedSchemaBytesBuffer.Bytes(), schema.RawSchema())

pkg/ast/ast_description.go

@@ -45,7 +45,6 @@ func (d *Document) PrintDescription(description Description, indent []byte, dept
 				skippedWhitespace += 1
 				continue
 			case runes.SPACE:
-				skippedWhitespace += 0.5
 				continue
 			}
 		}

pkg/ast/ast_test.go

@@ -182,7 +182,7 @@ func TestCopying(t *testing.T) {
 		}
 	}
 
-	out, err := astprinter.PrintStringIndent(&doc, nil, "  ")
+	out, err := astprinter.PrintStringIndent(&doc, nil, "    ")
 
 	assert.NoError(t, err)
 

pkg/astprinter/astprinter.go

@@ -18,6 +18,7 @@ func Print(document, definition *ast.Document, out io.Writer) error {
 }
 
 // PrintIndent is the same as Print but accepts an additional indent parameter to set indentation.
+// Indent is written once for every depth level.
 func PrintIndent(document, definition *ast.Document, indent []byte, out io.Writer) error {
 	printer := Printer{
 		indent: indent,
@@ -93,12 +94,12 @@ func (p *printVisitor) indentationDepth() (depth int) {
 	case ast.NodeKindOperationDefinition,
 		ast.NodeKindFragmentDefinition:
 	default:
-		return 2
+		return 1
 	}
 
 	for i := range p.Ancestors {
 		if p.Ancestors[i].Kind == ast.NodeKindSelectionSet {
-			depth += 2
+			depth += 1
 		}
 	}
 

pkg/astprinter/astprinter_test.go

@@ -516,7 +516,7 @@ func TestPrintSchemaDefinition(t *testing.T) {
 	doc := unsafeparser.ParseGraphqlDocumentFile("./testdata/starwars.schema.graphql")
 
 	buff := bytes.Buffer{}
-	err := PrintIndent(&doc, nil, []byte("  "), &buff)
+	err := PrintIndent(&doc, nil, []byte("    "), &buff)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -540,7 +540,7 @@ func TestPrintOperationDefinition(t *testing.T) {
 	operation := unsafeparser.ParseGraphqlDocumentFile("./testdata/introspectionquery.graphql")
 
 	buff := bytes.Buffer{}
-	err := PrintIndent(&operation, &schema, []byte("  "), &buff)
+	err := PrintIndent(&operation, &schema, []byte("    "), &buff)
 	if err != nil {
 		t.Fatal(err)
 	}

pkg/asttransform/baseschema_test.go

@@ -20,7 +20,7 @@ func runTestMerge(definition, fixtureName string) func(t *testing.T) {
 			panic(err)
 		}
 		buf := bytes.Buffer{}
-		err = astprinter.PrintIndent(&doc, nil, []byte("  "), &buf)
+		err = astprinter.PrintIndent(&doc, nil, []byte("    "), &buf)
 		if err != nil {
 			panic(err)
 		}

pkg/astvalidation/reference/testsgo/harness_test.go

@@ -248,7 +248,7 @@ func ExtendSchema(schema string, sdlStr string) string {
 	report := operationreport.Report{}
 	parser.Parse(&definition, &report)
 
-	res, _ := astprinter.PrintStringIndent(&definition, nil, "  ")
+	res, _ := astprinter.PrintStringIndent(&definition, nil, "    ")
 
 	return res
 }

pkg/engine/datasourcetesting/datasourcetesting.go

@@ -40,11 +40,11 @@ func RunTest(definition, operation, operationName string, expectedPlan plan.Plan
 		p := plan.NewPlanner(ctx, config)
 		actualPlan := p.Plan(&op, &def, operationName, &report)
 		if report.HasErrors() {
-			_, err := astprinter.PrintStringIndent(&def, nil, "  ")
+			_, err := astprinter.PrintStringIndent(&def, nil, "    ")
 			if err != nil {
 				t.Fatal(err)
 			}
-			_, err = astprinter.PrintStringIndent(&op, &def, "  ")
+			_, err = astprinter.PrintStringIndent(&op, &def, "    ")
 			if err != nil {
 				t.Fatal(err)
 			}