reduce the number of functions iterating on pages

Author: emad-elsaid

build.go

@@ -3,6 +3,7 @@ package xlog
 import (
 	"context"
 	"errors"
+	"fmt"
 	"io"
 	"io/fs"
 	"log/slog"
@@ -30,7 +31,7 @@ func RegisterBuildPage(p string, encloseInDir bool) {
 	}
 }
 
-func buildStaticSite(dest string) error {
+func build(dest string) error {
 	srv := server()
 
 	// building Index separately
@@ -45,7 +46,7 @@ func buildStaticSite(dest string) error {
 		slog.Error("Index Page may not exist, make sure your Index Page exists", "index", Config.Index, "error", err)
 	}
 
-	EachPageCon(context.Background(), func(p Page) {
+	errs := MapPage(context.Background(), func(p Page) error {
 		err := buildRoute(
 			srv,
 			"/"+p.Name(),
@@ -54,10 +55,16 @@ func buildStaticSite(dest string) error {
 		)
 
 		if err != nil {
-			slog.Error("Failed to process", "page", p.Name(), "error", err)
+			return fmt.Errorf("Failed to process page: %s, error: %w", p.Name(), err)
 		}
+
+		return nil
 	})
 
+	if err := errors.Join(errs...); err != nil {
+		slog.Error(err.Error())
+	}
+
 	// If we render 404 page
 	// Copy 404 page from dest/404/index.html to /dest/404.html
 	if in, err := os.Open(path.Join(dest, Config.NotFoundPage, "index.html")); err == nil {

each.go

@@ -2,6 +2,7 @@ package xlog
 
 import (
 	"context"
+	"reflect"
 	"regexp"
 	"runtime"
 	"sync"
@@ -61,30 +62,9 @@ func EachPage(ctx context.Context, f func(Page)) {
 
 var concurrency = runtime.NumCPU() * 4
 
-// EachPageCon Similar to EachPage but iterates concurrently
-func EachPageCon(ctx context.Context, f func(Page)) {
-	if pages == nil {
-		populatePagesCache(ctx)
-	}
-
-	grp, ctx := errgroup.WithContext(ctx)
-	grp.SetLimit(concurrency)
-
-	currentPages := pages
-	for _, p := range currentPages {
-		select {
-		case <-ctx.Done():
-			break
-		default:
-			grp.Go(func() (err error) { f(p); return })
-		}
-	}
-
-	grp.Wait()
-}
-
-// MapPageCon Similar to EachPage but iterates concurrently
-func MapPageCon[T any](ctx context.Context, f func(Page) T) []T {
+// MapPage Similar to EachPage but iterates concurrently and accumulates
+// returns in a slice
+func MapPage[T any](ctx context.Context, f func(Page) T) []T {
 	if pages == nil {
 		populatePagesCache(ctx)
 	}
@@ -103,7 +83,7 @@ func MapPageCon[T any](ctx context.Context, f func(Page) T) []T {
 		default:
 			grp.Go(func() (err error) {
 				val := f(p)
-				if any(val) == nil {
+				if isNil(val) {
 					return
 				}
 
@@ -121,6 +101,20 @@ func MapPageCon[T any](ctx context.Context, f func(Page) T) []T {
 	return output
 }
 
+// From https://stackoverflow.com/a/77341451/22401486
+func isNil[T any](t T) bool {
+	v := reflect.ValueOf(t)
+	kind := v.Kind()
+	// Must be one of these types to be nillable
+	return (kind == reflect.Ptr ||
+		kind == reflect.Interface ||
+		kind == reflect.Slice ||
+		kind == reflect.Map ||
+		kind == reflect.Chan ||
+		kind == reflect.Func) &&
+		v.IsNil()
+}
+
 func clearPagesCache(p Page) (err error) {
 	pages = nil
 	return nil

extensions/autolink_pages/autolink_pages.go

@@ -56,7 +56,7 @@ func backlinksSection(p Page) template.HTML {
 		return ""
 	}
 
-	pages := MapPageCon(context.Background(), func(a Page) Page {
+	pages := MapPage(context.Background(), func(a Page) Page {
 		_, tree := a.AST()
 		if a.Name() == p.Name() || !containLinkTo(tree, p) {
 			return nil

extensions/date/handlers.go

@@ -17,7 +17,7 @@ func dateHandler(r Request) Output {
 		return BadRequest(err.Error())
 	}
 
-	pages := MapPageCon(r.Context(), func(p Page) Page {
+	pages := MapPage(r.Context(), func(p Page) Page {
 		_, tree := p.AST()
 		allDates := FindAllInAST[*DateNode](tree)
 		for _, d := range allDates {

extensions/hashtags/hashtags.go

@@ -120,8 +120,7 @@ func tagsHandler(r Request) Output {
 	tags := map[string][]Page{}
 	var lck sync.Mutex
 
-	EachPageCon(context.Background(), func(a Page) {
-
+	MapPage(context.Background(), func(a Page) bool {
 		set := map[string]bool{}
 		_, tree := a.AST()
 		hashes := FindAllInAST[*HashTag](tree)
@@ -143,6 +142,8 @@ func tagsHandler(r Request) Output {
 			}
 			lck.Unlock()
 		}
+
+		return true
 	})
 
 	return Render("tags", Locals{
@@ -161,7 +162,7 @@ func tagHandler(r Request) Output {
 }
 
 func tagPages(ctx context.Context, keyword string) []Page {
-	return MapPageCon(ctx, func(p Page) Page {
+	return MapPage(ctx, func(p Page) Page {
 		if p.Name() == Config.Index {
 			return nil
 		}
@@ -190,7 +191,7 @@ func relatedPages(p Page) template.HTML {
 		hashtags[strings.ToLower(string(v.value))] = true
 	}
 
-	pages := MapPageCon(context.Background(), func(rp Page) Page {
+	pages := MapPage(context.Background(), func(rp Page) Page {
 		if rp.Name() == p.Name() {
 			return nil
 		}

extensions/search/search.go

@@ -48,32 +48,31 @@ type searchResult struct {
 	Line string
 }
 
-func search(ctx context.Context, keyword string) []searchResult {
-	results := []searchResult{}
+func search(ctx context.Context, keyword string) []*searchResult {
+	results := []*searchResult{}
 	if len(keyword) < MIN_SEARCH_KEYWORD {
 		return results
 	}
 
 	reg := regexp.MustCompile(`(?imU)^(.*` + regexp.QuoteMeta(keyword) + `.*)$`)
 
-	EachPage(ctx, func(p Page) {
+	return MapPage(ctx, func(p Page) *searchResult {
 		match := reg.FindString(p.Name())
 		if len(match) > 0 {
-			results = append(results, searchResult{
+			return &searchResult{
 				Page: p.Name(),
 				Line: "Matches the file name",
-			})
-			return
+			}
 		}
 
 		match = reg.FindString(string(p.Content()))
 		if len(match) > 0 {
-			results = append(results, searchResult{
+			return &searchResult{
 				Page: p.Name(),
 				Line: match,
-			})
+			}
 		}
-	})
 
-	return results
+		return nil
+	})
 }

extensions/sitemap/sitemap.go

@@ -4,6 +4,7 @@ import (
 	"flag"
 	"fmt"
 	"net/url"
+	"strings"
 
 	. "github.com/emad-elsaid/xlog"
 )
@@ -24,13 +25,13 @@ func (Sitemap) Init() {
 }
 
 func handler(r Request) Output {
-	output := `<?xml version="1.0" encoding="UTF-8"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">`
+	output := []string{`<?xml version="1.0" encoding="UTF-8"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">`}
 
-	EachPage(r.Context(), func(p Page) {
-		output += fmt.Sprintf("<url><loc>https://%s/%s</loc></url>", SITEMAP_DOMAIN, url.PathEscape(p.Name()))
-	})
+	output = append(output, MapPage(r.Context(), func(p Page) string {
+		return fmt.Sprintf("<url><loc>https://%s/%s</loc></url>", SITEMAP_DOMAIN, url.PathEscape(p.Name()))
+	})...)
 
-	output += `</urlset>`
+	output = append(output, `</urlset>`)
 
-	return PlainText(output)
+	return PlainText(strings.Join(output, "\n"))
 }

handlers.go

@@ -47,7 +47,7 @@ func Start(ctx context.Context) {
 	}
 
 	if len(Config.Build) > 0 {
-		if err := buildStaticSite(Config.Build); err != nil {
+		if err := build(Config.Build); err != nil {
 			slog.Error("Failed to build static pages", "error", err)
 			os.Exit(1)
 		}

server.go

@@ -48,7 +48,6 @@ func defaultMiddlewares() (middlewares []func(http.Handler) http.Handler) {
 		}
 
 		middlewares = append(middlewares,
-			methodOverrideHandler,
 			csrf.Protect(sessionSecret, crsfOpts...))
 	}
 
@@ -164,19 +163,6 @@ func Render(path string, data Locals) Output {
 	}
 }
 
-// Derived from Gorilla middleware https://github.com/gorilla/handlers/blob/v1.5.1/handlers.go#L134
-func methodOverrideHandler(h http.Handler) http.Handler {
-	return http.HandlerFunc(func(w Response, r Request) {
-		if r.Method == "POST" {
-			om := r.FormValue("_method")
-			if om == "PUT" || om == "PATCH" || om == "DELETE" {
-				r.Method = om
-			}
-		}
-		h.ServeHTTP(w, r)
-	})
-}
-
 func requestLoggerHandler(h http.Handler) http.Handler {
 	return http.HandlerFunc(func(w Response, r Request) {
 		start := time.Now()
@@ -193,9 +179,7 @@ func Cache(out Output) Output {
 	}
 }
 
-type funcStringer struct {
-	any
-}
+type funcStringer struct{ any }
 
 func (f funcStringer) String() string {
 	const xlogPrefix = "emad-elsaid/xlog/"