Scan body redirects and refs (#135)

Author: FollowTheProcess

internal/syntax/scanner/v2/scanner.go

@@ -611,7 +611,17 @@ func scanHTTPVersion(s *Scanner) stateFn {
 
 	s.emit(token.HTTPVersion)
 
-	return scanHeaders
+	s.skip(unicode.IsSpace)
+
+	if isIdent(s.peek()) {
+		return scanHeaders
+	}
+
+	if s.atEOF() || s.restHasPrefix("###") {
+		return scanStart
+	}
+
+	return scanBody
 }
 
 // scanHeaders scans a request header.
@@ -656,9 +666,91 @@ func scanHeaders(s *Scanner) stateFn {
 
 // scanBody scans a HTTP request body.
 func scanBody(s *Scanner) stateFn {
-	s.takeUntil(eof, '#')
+	// Reading the request body from a file
+	if s.take("<") {
+		return scanLeftAngle
+	}
+
+	// Redirecting the response without specifying a body
+	// e.g. in a GET request
+	if s.take(">") {
+		return scanRightAngle
+	}
+
+	s.takeUntil('#', '>', '<', eof)
 	s.emit(token.Text)
 
+	s.skip(unicode.IsSpace)
+
+	// Are we doing the response reference pattern e.g. '<> response.json'
+	if s.take("<") {
+		return scanLeftAngle
+	}
+
+	// Are we redirecting the response *after* a body has been specified
+	// e.g. in a POST request, there may be a body *and* a redirect
+	if s.take(">") {
+		return scanRightAngle
+	}
+
+	return scanStart
+}
+
+// scanLeftAngle scans a '<' in the context of reading a request
+// body from the filepath specified next.
+//
+// It assumes the '<' has already been consumed.
+func scanLeftAngle(s *Scanner) stateFn {
+	if s.take(">") {
+		// It's a response reference '<>'
+		s.emit(token.ResponseRef)
+	} else {
+		s.emit(token.LeftAngle)
+	}
+
+	s.skip(isLineSpace)
+
+	// TODO(@FollowTheProcess): Interps here too
+
+	if isFilePath(s.peek()) {
+		s.takeWhile(isText)
+		s.emit(token.Text)
+	}
+
+	s.skip(unicode.IsSpace)
+
+	// Is the next thing a response ref '<>', which would be the case
+	// if a request has a body file *and* a response ref
+	if s.take("<") {
+		return scanLeftAngle
+	}
+
+	// Are we redirecting the response *after* a body has been specified by a file
+	if s.take(">") {
+		return scanRightAngle
+	}
+
+	// Back to start because this marks the end of the request
+	return scanStart
+}
+
+// scanRightAngle scans a '>' in the context of redirecting a response body
+// to a filepath specified next.
+//
+// It assumes the '>' has already been consumed.
+func scanRightAngle(s *Scanner) stateFn {
+	s.emit(token.RightAngle)
+
+	s.skip(isLineSpace)
+
+	// TODO(@FollowTheProcess): Interp here too
+
+	if isFilePath(s.peek()) {
+		s.takeWhile(isText)
+		s.emit(token.Text)
+	}
+
+	// Back to start because this marks the end of the request
 	return scanStart
 }
 
@@ -708,3 +800,8 @@ func isText(r rune) bool {
 func isURL(r rune) bool {
 	return isAlphaNumeric(r) || strings.ContainsRune("$-_.+!*'(),:/?#[]@&;=", r)
 }
+
+// isFilePath reports whether r could be a valid first character in a filepath.
+func isFilePath(r rune) bool {
+	return isIdent(r) || r == '.' || r == '/' || r == '\\'
+}

internal/syntax/scanner/v2/testdata/valid/body-file-redirect.txtar

@@ -0,0 +1,17 @@
+-- src.http --
+### Body File
+POST https://api.somewhere.com/items/1
+
+< ./request.json
+
+> ./response.json
+-- tokens.txt --
+<Token::Separator start=0, end=3>
+<Token::Comment start=4, end=13>
+<Token::MethodPost start=14, end=18>
+<Token::Text start=19, end=52>
+<Token::LeftAngle start=54, end=55>
+<Token::Text start=56, end=70>
+<Token::RightAngle start=72, end=73>
+<Token::Text start=74, end=89>
+<Token::EOF start=90, end=90>

internal/syntax/scanner/v2/testdata/valid/body-file-reference.txtar

@@ -0,0 +1,18 @@
+-- src.http --
+### Body File
+POST https://api.somewhere.com/items/1 HTTP/1.2
+
+< ./input.json
+
+<> ./output.json
+-- tokens.txt --
+<Token::Separator start=0, end=3>
+<Token::Comment start=4, end=13>
+<Token::MethodPost start=14, end=18>
+<Token::Text start=19, end=52>
+<Token::HTTPVersion start=53, end=61>
+<Token::LeftAngle start=63, end=64>
+<Token::Text start=65, end=77>
+<Token::ResponseRef start=79, end=81>
+<Token::Text start=82, end=95>
+<Token::EOF start=96, end=96>

internal/syntax/scanner/v2/testdata/valid/body-file.txtar

@@ -0,0 +1,12 @@
+-- src.http --
+###
+POST https://api.something.com/items
+
+< ../requests/input.json
+-- tokens.txt --
+<Token::Separator start=0, end=3>
+<Token::MethodPost start=4, end=8>
+<Token::Text start=9, end=40>
+<Token::LeftAngle start=42, end=43>
+<Token::Text start=44, end=66>
+<Token::EOF start=67, end=67>

internal/syntax/scanner/v2/testdata/valid/body-redirect.txtar

@@ -0,0 +1,18 @@
+-- src.http --
+### Body
+POST https://api.somewhere.com/items/1
+
+{
+  "something": "here"
+}
+
+> ./response.json
+-- tokens.txt --
+<Token::Separator start=0, end=3>
+<Token::Comment start=4, end=8>
+<Token::MethodPost start=9, end=13>
+<Token::Text start=14, end=47>
+<Token::Text start=49, end=76>
+<Token::RightAngle start=76, end=77>
+<Token::Text start=78, end=93>
+<Token::EOF start=94, end=94>

internal/syntax/scanner/v2/testdata/valid/body-reference.txtar

@@ -0,0 +1,18 @@
+-- src.http --
+### Body
+POST https://api.somewhere.com/items/1
+
+{
+  "something": "here"
+}
+
+<> response.json
+-- tokens.txt --
+<Token::Separator start=0, end=3>
+<Token::Comment start=4, end=8>
+<Token::MethodPost start=9, end=13>
+<Token::Text start=14, end=47>
+<Token::Text start=49, end=76>
+<Token::ResponseRef start=76, end=78>
+<Token::Text start=79, end=92>
+<Token::EOF start=93, end=93>