Fix ISSUE-141: edi reader stuck in a dead-loop with unrecognized raw segment at the end of the input.

extensions/omniv21/fileformat/edi/.snapshots/TestRead-multiple_root_level_segments,_success

@@ -0,0 +1,7 @@
+{
+	"Records": [
+		"{'IEA':{},'ISA':{}}",
+		"{'IEA':{},'ISA':{}}"
+	],
+	"FinalErr": "EOF"
+}

extensions/omniv21/fileformat/edi/.snapshots/TestRead-unprocessed_raw_segment,_failure

@@ -0,0 +1,6 @@
+{
+	"Records": [
+		"{}"
+	],
+	"FinalErr": "input 'test' at segment no.2 (char[13,13]): segment 'UNKNOWN' is either not declared in schema or appears in an invalid order"
+}

extensions/omniv21/fileformat/edi/reader.go

@@ -231,8 +231,20 @@ func (r *ediReader) Read() (*idr.Node, error) {
 		if err != nil {
 			return nil, err
 		}
+		if len(r.stack) <= 1 {
+			// we have a raw segment waiting for processing but currently
+			// the decl stack is effectively empty (with only the artificial
+			// #root decl on it. We can get into this situation two ways:
+			// 1.
+		}
 		cur := r.stackTop()
 		if !cur.segDecl.matchSegName(rawSeg.Name) {
+			if len(r.stack) <= 1 {
+				return nil, ErrInvalidEDI(r.fmtErrStr2(
+					r.r.SegCount(), r.r.RuneEnd(), r.r.RuneEnd(),
+					"segment '%s' is either not declared in schema or appears in an invalid order",
+					rawSeg.Name))
+			}
 			err = r.segNext()
 			if err != nil {
 				return nil, err

extensions/omniv21/fileformat/edi/reader_test.go

@@ -586,11 +586,11 @@ func TestSegDoneSegNext(t *testing.T) {
 
 func TestRead(t *testing.T) {
 	for _, test := range []struct {
-		name     string
-		input    string
-		declJSON string
-		xpath    string
-		err      string
+		name              string
+		input             string
+		declJSON          string
+		xpath             string
+		readerCreationErr string
 	}{
 		{
 			name:  "invalid target xpath, failure",
@@ -603,8 +603,8 @@ func TestRead(t *testing.T) {
 						{ "name": "ISA", "min": 0 }
 					]
 				}`,
-			xpath: "[",
-			err:   `invalid target xpath '[', err: expression must evaluate to a node-set`,
+			xpath:             "[",
+			readerCreationErr: `invalid target xpath '[', err: expression must evaluate to a node-set`,
 		},
 		{
 			name:  "empty input, success",
@@ -617,8 +617,8 @@ func TestRead(t *testing.T) {
 						{ "name": "ISA", "min": 0 }
 					]
 				}`,
-			xpath: "",
-			err:   "",
+			xpath:             "",
+			readerCreationErr: "",
 		},
 		{
 			name:  "single seg decl, multiple seg instances, success",
@@ -640,8 +640,8 @@ func TestRead(t *testing.T) {
 						}
 					]
 				}`,
-			xpath: "",
-			err:   "",
+			xpath:             "",
+			readerCreationErr: "",
 		},
 		{
 			name:  "2 seg decls, success",
@@ -669,8 +669,8 @@ func TestRead(t *testing.T) {
 						}
 					]
 				}`,
-			xpath: "",
-			err:   "",
+			xpath:             "",
+			readerCreationErr: "",
 		},
 		{
 			name:  "2 seg groups, filtered target, success",
@@ -711,8 +711,8 @@ func TestRead(t *testing.T) {
 						}
 					]
 				}`,
-			xpath: ".[e1 != '6']",
-			err:   "",
+			xpath:             ".[e1 != '6']",
+			readerCreationErr: "",
 		},
 		{
 			name:  "seg min not satisfied before EOF, failure",
@@ -740,8 +740,8 @@ func TestRead(t *testing.T) {
 						}
 					]
 				}`,
-			xpath: "",
-			err:   "",
+			xpath:             "",
+			readerCreationErr: "",
 		},
 		{
 			name:  "missing raw seg name, failure",
@@ -762,8 +762,8 @@ func TestRead(t *testing.T) {
 						}
 					]
 				}`,
-			xpath: "",
-			err:   "",
+			xpath:             "",
+			readerCreationErr: "",
 		},
 		{
 			name:  "raw seg processing wrong, failure",
@@ -784,8 +784,8 @@ func TestRead(t *testing.T) {
 						}
 					]
 				}`,
-			xpath: "",
-			err:   "",
+			xpath:             "",
+			readerCreationErr: "",
 		},
 		{
 			name:  "seg min not satisfied before next seg appearance, failure",
@@ -810,18 +810,62 @@ func TestRead(t *testing.T) {
 						}
 					]
 				}`,
-			xpath: "",
-			err:   "",
+			xpath:             "",
+			readerCreationErr: "",
+		},
+		{
+			name:  "unprocessed raw segment, failure",
+			input: "ISA\nUNKNOWN\n",
+			declJSON: `
+				{
+					"segment_delimiter": "\n",
+					"element_delimiter": "*",
+					"segment_declarations": [
+						{
+							"name": "ISA",
+							"is_target": true,
+                            "min": 0
+						}
+					]
+				}`,
+			xpath:             "",
+			readerCreationErr: "",
+		},
+		{
+			name:  "multiple root level segments, success",
+			input: "ISA\nIEA\nISA\nIEA\n",
+			declJSON: `
+				{
+					"segment_delimiter": "\n",
+					"element_delimiter": "*",
+					"segment_declarations": [
+						{
+							"name": "group1",
+							"type": "segment_group",
+							"is_target": true,
+							"child_segments": [
+								{
+									"name": "ISA"
+								},
+								{
+									"name": "IEA"
+								}
+							]
+						}
+					]
+				}`,
+			xpath:             "",
+			readerCreationErr: "",
 		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
 			var decl FileDecl
 			err := json.Unmarshal([]byte(test.declJSON), &decl)
 			assert.NoError(t, err)
 			reader, err := NewReader("test", strings.NewReader(test.input), &decl, test.xpath)
-			if test.err != "" {
+			if test.readerCreationErr != "" {
 				assert.Error(t, err)
-				assert.Equal(t, test.err, err.Error())
+				assert.Equal(t, test.readerCreationErr, err.Error())
 				assert.Nil(t, reader)
 				return
 			}