Split queries.sql into multiple files for better readability and maintainability. Closes #2738. (#2776)

Co-authored-by: 13unk0wn <n0b0dy0.000729@gmail.com>

Author: knadh

Makefile

@@ -33,12 +33,15 @@ FRONTEND_EMAIL_BUILDER_DEPS = \
 
 BIN := listmonk
 STATIC := config.toml.sample \
-	schema.sql queries.sql permissions.json \
+	schema.sql queries:/queries permissions.json \
 	static/public:/public \
 	static/email-templates \
 	frontend/dist:/admin \
 	i18n:/i18n
 
+SQL := $(shell find . -type f -name "*.sql") $(shell find queries -type f -name "*.sql")
+SRC := $(shell find . -type f -name "*.go")
+
 .PHONY: build
 build: $(BIN)
 
@@ -54,7 +57,7 @@ $(FRONTEND_EMAIL_BUILDER_YARN_MODULES): frontend/package.json frontend/yarn.lock
 	touch -c $(FRONTEND_EMAIL_BUILDER_YARN_MODULES)
 
 # Build the backend to ./listmonk.
-$(BIN): $(shell find . -type f -name "*.go") go.mod go.sum schema.sql queries.sql permissions.json
+$(BIN): $(SRC) go.mod go.sum schema.sql $(SQL) permissions.json
 	CGO_ENABLED=0 go build -o ${BIN} -ldflags="-s -w -X 'main.buildString=${BUILDSTR}' -X 'main.versionString=${VERSION}'" cmd/*.go
 
 # Run the backend in dev mode. The frontend assets in dev mode are loaded from disk from frontend/dist.

cmd/init.go

@@ -54,8 +54,10 @@ import (
 )
 
 const (
-	queryFilePath = "queries.sql"
-	emailMsgr     = "email"
+	// Path to the SQL queries directory in the embedded FS.
+	queryFilePath = "/queries"
+
+	emailMsgr = "email"
 )
 
 // UrlConfig contains various URL constants used in the app.
@@ -199,7 +201,7 @@ func initFS(appDir, frontendDir, staticDir, i18nDir string) stuffbin.FileSystem
 		// These paths are joined with appDir.
 		appFiles = []string{
 			"./config.toml.sample:config.toml.sample",
-			"./queries.sql:queries.sql",
+			"./queries:queries",
 			"./schema.sql:schema.sql",
 			"./permissions.json:permissions.json",
 		}
@@ -333,19 +335,35 @@ func initDB() *sqlx.DB {
 	return db.Unsafe()
 }
 
-// readQueries reads named SQL queries from the SQL queries file into a query map.
-func readQueries(sqlFile string, fs stuffbin.FileSystem) goyesql.Queries {
-	// Load SQL queries.
-	qB, err := fs.Read(sqlFile)
+func readQueries(dir string, fs stuffbin.FileSystem) goyesql.Queries {
+	out := goyesql.Queries{}
+
+	// Glob all the .sql files in the queries directory.
+	qPath := path.Join(dir, "/*.sql")
+	files, err := fs.Glob(qPath)
 	if err != nil {
-		lo.Fatalf("error reading SQL file %s: %v", sqlFile, err)
+		lo.Fatalf("error reading *.sql query files from %s: %v", qPath, err)
 	}
-	qMap, err := goyesql.ParseBytes(qB)
-	if err != nil {
-		lo.Fatalf("error parsing SQL queries: %v", err)
+
+	// Read and merge queries from all files into one map.
+	for _, file := range files {
+		// Read the SQL file.
+		b, err := fs.Read(file)
+		if err != nil {
+			lo.Fatalf("error reading SQL file %s: %v", file, err)
+		}
+
+		// Parse queries in it into a map.
+		mp, err := goyesql.ParseBytes(b)
+		if err != nil {
+			lo.Fatalf("error parsing SQL queries: %v", err)
+		}
+
+		// Merge into the main query map.
+		maps.Copy(out, mp)
 	}
 
-	return qMap
+	return out
 }
 
 // prepareQueries queries prepares a query map and returns a *Queries