fix: avoid unnecessary nesting when generating yaml

Also add more example snippets that can be used for testing
apigee · Apr 10, 2024 · d9f56f5 · d9f56f5
1 parent a71749d
commit d9f56f5
Show file tree

Hide file tree

Showing 4 changed files with 97 additions and 2 deletions.
diff --git a/examples/snippets/check-quota.xml b/examples/snippets/check-quota.xml
@@ -12,4 +12,4 @@
         <SyncIntervalInSeconds>20</SyncIntervalInSeconds>
         <SyncMessageCount>5</SyncMessageCount>
     </AsynchronousConfiguration>
-</Quota>
+</Quota>
diff --git a/examples/snippets/raise-fault.xml b/examples/snippets/raise-fault.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<RaiseFault async="false" continueOnError="true" enabled="true" name="RF-Example" >
+    <DisplayName>RF-Example</DisplayName>
+    <FaultResponse>
+        <AssignVariable >
+            <Name>flow.var</Name>
+            <Value>123</Value>
+        </AssignVariable>
+        <Add >
+            <Headers>
+                <Header name="user-agent" >example</Header>
+            </Headers>
+        </Add>
+        <Copy source="request" >
+            <Headers>
+                <Header name="header-name" ></Header>
+            </Headers>
+            <StatusCode>304</StatusCode>
+        </Copy>
+        <Remove >
+            <Headers>
+                <Header name="sample-header" ></Header>
+            </Headers>
+        </Remove>
+        <Set >
+            <Headers>
+                <Header name="user-agent" >{request.header.user-agent}</Header>
+            </Headers>
+            <Payload contentType="application/json" >{"name":"foo", "type":"bar"}</Payload>
+        </Set>
+        <Set >
+            <ReasonPhrase>Server Error</ReasonPhrase>
+            <StatusCode>500</StatusCode>
+        </Set>
+    </FaultResponse>
+    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
+    <ShortFaultReason>false</ShortFaultReason>
+</RaiseFault>
diff --git a/examples/snippets/raise-fault.yaml b/examples/snippets/raise-fault.yaml
@@ -0,0 +1,38 @@
+RaiseFault:
+  .async: false
+  .continueOnError: true
+  .enabled: true
+  .name: RF-Example
+  DisplayName: RF-Example
+  FaultResponse:
+    - AssignVariable:
+        Name: flow.var
+        Value: 123
+    - Add:
+        Headers:
+          Header:
+            .name: user-agent
+            .@: example
+    - Copy:
+        .source: request
+        Headers:
+          Header:
+            .name: header-name
+        StatusCode: 304
+    - Remove:
+        Headers:
+          Header:
+            .name: sample-header
+    - Set:
+        Headers:
+          Header:
+            .name: user-agent
+            .@: '{request.header.user-agent}'
+        Payload:
+          .contentType: application/json
+          .@: '{"name":"foo", "type":"bar"}'
+    - Set:
+        ReasonPhrase: Server Error
+        StatusCode: 500
+  IgnoreUnresolvedVariables: true
+  ShortFaultReason: false
diff --git a/pkg/utils/xml.go b/pkg/utils/xml.go
@@ -21,6 +21,7 @@ import (
 	"github.com/go-errors/errors"
 	"gopkg.in/yaml.v3"
 	"io"
+	"slices"
 	"strings"
 )
 
@@ -209,7 +210,7 @@ func XML2YAMLRecursive(ele *etree.Element) (key *yaml.Node, value *yaml.Node, er
 	}
 
 	if !allUnique {
-		//it's a sequence, parent has no attributes
+		//it's a sequence
 		sequence := &yaml.Node{Kind: yaml.SequenceNode}
 		sequence.Content = []*yaml.Node{}
 
@@ -222,15 +223,33 @@ func XML2YAMLRecursive(ele *etree.Element) (key *yaml.Node, value *yaml.Node, er
 		}
 
 		if nodeVal == children {
+			// parent has no attributes
 			nodeVal = sequence
 		} else {
+			// parent has
 			children.Kind = sequence.Kind
 			children.Content = sequence.Content
 		}
 
 		return nodeKey, nodeVal, nil
 	}
 
+	childrenIndex := slices.IndexFunc(nodeVal.Content, func(e *yaml.Node) bool {
+		return e.Value == ".@"
+	})
+
+	if childrenIndex > 0 && children != nodeVal &&
+		children.Kind == yaml.MappingNode &&
+		nodeVal.Kind == yaml.MappingNode &&
+		allUnique {
+		//remove unnecessary nesting
+		newContent := append([]*yaml.Node{}, nodeVal.Content[0:childrenIndex]...)
+		newContent = append(newContent, nodeVal.Content[childrenIndex+2:]...)
+		newContent = append(newContent, children.Content...)
+		nodeVal.Content = newContent
+		return nodeKey, nodeVal, nil
+	}
+
 	return nodeKey, nodeVal, nil
 
 }