Fix build file

Author: xynicole

analyze_test.go

@@ -2110,7 +2110,7 @@ func TestAnalyze_lua(t *testing.T) {
 			err := analyze("nginx.conf", tc.stmt, ";", tc.ctx, &ParseOptions{
 				MatchFuncs: []MatchFunc{MatchLua},
 				LexOptions: LexOptions{
-					ExternalLexers: []ExtLexer{
+					ExternalLexers: []ExternalLexer{
 						&LuaLexer{},
 					},
 				},

build.go

@@ -10,6 +10,7 @@ package crossplane
 import (
 	"bytes"
 	"io"
+	"log"
 	"os"
 	"path/filepath"
 	"strings"
@@ -18,15 +19,22 @@ import (
 )
 
 type BuildOptions struct {
-	Indent        int
-	Tabs          bool
-	Header        bool
-	ExternalBuild []ExtBuild // handle specific directives
+	Indent         int
+	Tabs           bool
+	Header         bool
+	ExternalBuilds []ExternalBuilder // handle specific directives
 }
 
-type ExtBuild interface {
-	ExtDirectives() []string
-	BuildLuaBlock(sb io.StringWriter, directive string, stmt *Directive)
+// ExternalBuilder is the interface that provides an abstraction for implementing builders that
+// can handle external and custom NGINXdirectives during the build process of NGINX configurations
+// from JSON payloads.
+type ExternalBuilder interface {
+	// RegisterExternalBuilder allows the build system to identify which NGINX directives are supported
+	// by the external builder and routes the build process of those directives to this builder.
+	RegisterExternalBuilder() []string
+	// Builder is responsible for constructing the configuration block for a specific directive.
+	// It is called during the configuration building process whenever a registered directive is encountered.
+	Builder(sb io.StringWriter, directive string, stmt *Directive) error
 }
 
 const MaxIndent = 100
@@ -45,7 +53,7 @@ const header = `# This config was built from JSON using NGINX crossplane.
 
 type LuaBuild struct{}
 
-func (lb *LuaBuild) ExtDirectives() []string {
+func (lb *LuaBuild) RegisterExternalBuilder() []string {
 	return []string{
 		"init_by_lua_block",
 		"init_worker_by_lua_block",
@@ -66,19 +74,41 @@ func (lb *LuaBuild) ExtDirectives() []string {
 	}
 }
 
-func (lb *LuaBuild) BuildLuaBlock(sb io.StringWriter, directive string, stmt *Directive) {
+func (lb *LuaBuild) Builder(sb io.StringWriter, directive string, stmt *Directive) error {
+	// helper function to write to sb and check for an error
+	writeAndCheck := func(s string) error {
+		_, err := sb.WriteString(s)
+		return err
+	}
 	// special handling for'set_by_lua_block' directive
 	if directive == "set_by_lua_block" {
-		_, _ = sb.WriteString(" ")
-		_, _ = sb.WriteString(stmt.Args[0]) // argument for return value
-		_, _ = sb.WriteString(" {")
-		_, _ = sb.WriteString(stmt.Args[1]) // argument containing block content
-		_, _ = sb.WriteString("}")
+		if err := writeAndCheck(" "); err != nil {
+			return err
+		}
+		if err := writeAndCheck(stmt.Args[0]); err != nil { // argument for return value
+			return err
+		}
+		if err := writeAndCheck(" {"); err != nil {
+			return err
+		}
+		if err := writeAndCheck(stmt.Args[1]); err != nil { // argument containing block content
+			return err
+		}
+		if err := writeAndCheck("}"); err != nil {
+			return err
+		}
 	} else {
-		_, _ = sb.WriteString(" {")
-		_, _ = sb.WriteString(stmt.Args[0])
-		_, _ = sb.WriteString("}")
+		if err := writeAndCheck(" {"); err != nil {
+			return err
+		}
+		if err := writeAndCheck(stmt.Args[0]); err != nil { // argument for return value
+			return err
+		}
+		if err := writeAndCheck("}"); err != nil {
+			return err
+		}
 	}
+	return nil
 }
 
 // BuildFiles builds all of the config files in a crossplane.Payload and
@@ -152,7 +182,7 @@ func Build(w io.Writer, config Config, options *BuildOptions) error {
 	return err
 }
 
-//nolint:funlen,gocognit
+//nolint:funlen,gocognit,gocyclo
 func buildBlock(sb io.StringWriter, parent *Directive, block Directives, depth int, lastLine int, options *BuildOptions) {
 	for i, stmt := range block {
 		// if the this statement is a comment on the same line as the preview, do not emit EOL for this stmt
@@ -176,16 +206,18 @@ func buildBlock(sb io.StringWriter, parent *Directive, block Directives, depth i
 			directive := Enquote(stmt.Directive)
 			_, _ = sb.WriteString(directive)
 
-			if options.ExternalBuild != nil {
-				extDirectivesMap := make(map[string]ExtBuild)
-				for _, ext := range options.ExternalBuild {
-					directives := ext.ExtDirectives()
+			if options.ExternalBuilds != nil {
+				extDirectivesMap := make(map[string]ExternalBuilder)
+				for _, ext := range options.ExternalBuilds {
+					directives := ext.RegisterExternalBuilder()
 					for _, d := range directives {
 						extDirectivesMap[d] = ext
 					}
 
 					if ext, ok := extDirectivesMap[directive]; ok {
-						ext.BuildLuaBlock(sb, directive, stmt)
+						if err := ext.Builder(sb, directive, stmt); err != nil {
+							log.Printf("Failed to write externaller block: %v", err)
+						}
 					}
 				}
 			} else {

build_test.go

@@ -260,7 +260,7 @@ var buildFixtures = []buildFixture{
 	},
 	{
 		name:    "lua block",
-		options: BuildOptions{ExternalBuild: []ExtBuild{&LuaBuild{}}},
+		options: BuildOptions{ExternalBuilds: []ExternalBuilder{&LuaBuild{}}},
 		parsed: Directives{
 			{
 				Directive: "content_by_lua_block",
@@ -273,7 +273,7 @@ var buildFixtures = []buildFixture{
 	},
 	{
 		name:    "set_by_lua_block",
-		options: BuildOptions{ExternalBuild: []ExtBuild{&LuaBuild{}}},
+		options: BuildOptions{ExternalBuilds: []ExternalBuilder{&LuaBuild{}}},
 		parsed: Directives{
 			{
 				Directive: "set_by_lua_block",

lex.go

@@ -45,8 +45,8 @@ func SetTokenChanCap(size int) {
 	tokChanCap = size
 }
 
-type ExtLexer interface {
-	Register(scanner *extScanner) []string
+type ExternalLexer interface {
+	RegisterExternalLexer(scanner *extScanner) []string
 	Lex(matchedToken string) <-chan NgxToken
 }
 
@@ -55,7 +55,7 @@ type ExtLexer interface {
 // external lexers can ensure that these directives are processed separately
 // from the general lexical analysis logic.
 type LexOptions struct {
-	ExternalLexers []ExtLexer
+	ExternalLexers []ExternalLexer
 }
 
 func LexWithOptions(r io.Reader, options LexOptions) chan NgxToken {
@@ -111,18 +111,18 @@ func tokenize(reader io.Reader, tokenCh chan NgxToken, options LexOptions) {
 		lexState = skipSpace
 	}
 
-	var externalLexers map[string]ExtLexer
+	var externalLexers map[string]ExternalLexer
 	var externalScanner *extScanner
 	for _, ext := range options.ExternalLexers {
 		if externalLexers == nil {
-			externalLexers = make(map[string]ExtLexer)
+			externalLexers = make(map[string]ExternalLexer)
 		}
 
 		if externalScanner == nil {
 			externalScanner = &extScanner{scanner: scanner, tokenLine: tokenLine}
 		}
 
-		for _, d := range ext.Register(externalScanner) {
+		for _, d := range ext.RegisterExternalLexer(externalScanner) {
 			if _, ok := externalLexers[d]; ok {
 				// Handle the duplicate token name, emitting an error token and exit
 				tokenCh <- NgxToken{Value: "Duplicate token name", Line: tokenLine, IsQuoted: false, Error: errors.New("duplicate token name handled")}
@@ -164,15 +164,11 @@ func tokenize(reader io.Reader, tokenCh chan NgxToken, options LexOptions) {
 
 		if token.Len() > 0 {
 			tokenStr := token.String()
-			if ext, ok := externalLexers[tokenStr]; ok {
-				if nextTokenIsDirective {
+			if nextTokenIsDirective {
+				if ext, ok := externalLexers[tokenStr]; ok {
 					// saving lex state before emitting tokenStr to know if we encountered start quote
 					lastLexState := lexState
-					if lexState == inQuote {
-						emit(tokenStartLine, true, nil)
-					} else {
-						emit(tokenStartLine, false, nil)
-					}
+					emit(tokenStartLine, lexState == inQuote, nil)
 
 					externalScanner.tokenLine = tokenLine
 					extTokenCh := ext.Lex(tokenStr)
@@ -324,7 +320,7 @@ type LuaLexer struct {
 	s *extScanner
 }
 
-func (ll *LuaLexer) Register(s *extScanner) []string {
+func (ll *LuaLexer) RegisterExternalLexer(s *extScanner) []string {
 	ll.s = s
 	return []string{
 		"init_by_lua_block",

lex_test.go

@@ -430,7 +430,7 @@ func TestLex(t *testing.T) {
 			}
 			defer file.Close()
 			options := LexOptions{
-				ExternalLexers: []ExtLexer{
+				ExternalLexers: []ExternalLexer{
 					&LuaLexer{},
 				},
 			}

parse_test.go

@@ -1707,7 +1707,7 @@ var parseFixtures = []parseFixture{
 		ErrorOnUnknownDirectives: true,
 		MatchFuncs:               []MatchFunc{MatchLua},
 		LexOptions: LexOptions{
-			ExternalLexers: []ExtLexer{
+			ExternalLexers: []ExternalLexer{
 				&LuaLexer{},
 			},
 		},
@@ -1838,7 +1838,7 @@ var parseFixtures = []parseFixture{
 		ErrorOnUnknownDirectives: true,
 		MatchFuncs:               []MatchFunc{MatchLua},
 		LexOptions: LexOptions{
-			ExternalLexers: []ExtLexer{
+			ExternalLexers: []ExternalLexer{
 				&LuaLexer{},
 			},
 		},
@@ -1932,7 +1932,7 @@ var parseFixtures = []parseFixture{
 		ParseComments:            true,
 		MatchFuncs:               []MatchFunc{MatchLua},
 		LexOptions: LexOptions{
-			ExternalLexers: []ExtLexer{
+			ExternalLexers: []ExternalLexer{
 				&LuaLexer{},
 			},
 		},