Staticfile provider

core/providers/provider.go

@@ -6,6 +6,7 @@ import (
 	"github.com/railwayapp/railpack/core/providers/node"
 	"github.com/railwayapp/railpack/core/providers/php"
 	"github.com/railwayapp/railpack/core/providers/python"
+	"github.com/railwayapp/railpack/core/providers/staticfile"
 )
 
 type Provider interface {
@@ -20,6 +21,7 @@ func GetLanguageProviders() []Provider {
 		&node.NodeProvider{},
 		&python.PythonProvider{},
 		&golang.GoProvider{},
+		&staticfile.StaticfileProvider{},
 	}
 }
 

core/providers/staticfile/Caddyfile.template

@@ -0,0 +1,58 @@
+{
+	admin off
+	persist_config off
+	auto_https off
+
+	log {
+		format json
+	}
+
+	servers {
+		trusted_proxies static private_ranges
+	}
+}
+
+:{$PORT:80} {
+	log {
+		format json
+	}
+
+	respond /health 200
+
+# Security headers
+	header {
+		# Enable cross-site filter (XSS) and tell browsers to block detected attacks
+		X-XSS-Protection "1; mode=block"
+		# Prevent some browsers from MIME-sniffing a response away from the declared Content-Type
+		X-Content-Type-Options "nosniff"
+		# Keep referrer data off of HTTP connections
+		Referrer-Policy "strict-origin-when-cross-origin"
+		# Enable strict Content Security Policy
+		Content-Security-Policy "default-src 'self'; img-src 'self' data: https: *; style-src 'self' 'unsafe-inline' https: *; script-src 'self' 'unsafe-inline' https: *; font-src 'self' data: https: *; connect-src 'self' https: *; media-src 'self' https: *; object-src 'none'; frame-src 'self' https: *;"
+		# Remove Server header
+		-Server
+	}
+
+	root * {{.STATIC_FILE_ROOT}}
+
+	# Handle static files
+	file_server {
+		hide .git
+		hide .env*
+	}
+
+	# Compression with more formats
+	encode {
+		gzip
+		zstd
+	}
+
+	# Try files with HTML extension and handle SPA routing
+	try_files {path} {path}.html {path}/index.html /index.html
+
+	# Handle 404 errors
+	handle_errors {
+		rewrite * /{err.status_code}.html
+		file_server
+	}
+}

core/providers/staticfile/staticfile.go

@@ -0,0 +1,138 @@
+package staticfile
+
+import (
+	"bytes"
+	_ "embed"
+	"fmt"
+	"text/template"
+
+	"github.com/railwayapp/railpack/core/generate"
+	"github.com/railwayapp/railpack/core/plan"
+)
+
+//go:embed Caddyfile.template
+var caddyfileTemplate string
+
+const (
+	StaticfileConfigName = "Staticfile"
+	CaddyfilePath        = "Caddyfile"
+)
+
+type StaticfileConfig struct {
+	RootDir string `yaml:"root"`
+}
+
+type StaticfileProvider struct{}
+
+func (p *StaticfileProvider) Name() string {
+	return "staticfile"
+}
+
+func (p *StaticfileProvider) Detect(ctx *generate.GenerateContext) (bool, error) {
+	rootDir, err := p.getRootDir(ctx)
+
+	if rootDir != "" && err == nil {
+		return true, nil
+	}
+
+	return false, nil
+}
+
+func (p *StaticfileProvider) Plan(ctx *generate.GenerateContext) error {
+	p.Packages(ctx)
+
+	rootDir, err := p.getRootDir(ctx)
+	if err != nil {
+		return err
+	}
+
+	setupStep, err := p.SetupCaddy(ctx, rootDir)
+	if err != nil {
+		return err
+	}
+
+	setupStep.DependsOn = append(setupStep.DependsOn, ctx.GetMiseStepBuilder().DisplayName)
+
+	ctx.Start.AddOutputs([]string{"."})
+	ctx.Start.Command = p.CaddyStartCommand(ctx, rootDir)
+
+	return nil
+}
+
+func (p *StaticfileProvider) CaddyStartCommand(ctx *generate.GenerateContext, rootDir string) string {
+	return "caddy run --config " + CaddyfilePath + " --adapter caddyfile 2>&1"
+}
+
+func (p *StaticfileProvider) SetupCaddy(ctx *generate.GenerateContext, rootDir string) (*generate.CommandStepBuilder, error) {
+	data := map[string]interface{}{
+		"STATIC_FILE_ROOT": rootDir,
+	}
+
+	caddyfile, err := p.getCaddyfile(data)
+	if err != nil {
+		return nil, err
+	}
+
+	setupStep := ctx.NewCommandStep("setup")
+	setupStep.AddCommands([]plan.Command{
+		plan.NewFileCommand(CaddyfilePath, "Caddyfile"),
+		plan.NewExecCommand("caddy fmt --overwrite Caddyfile"),
+	})
+
+	setupStep.Assets = map[string]string{
+		"Caddyfile": caddyfile,
+	}
+
+	return setupStep, nil
+}
+
+func (p *StaticfileProvider) Packages(ctx *generate.GenerateContext) {
+	miseStep := ctx.GetMiseStepBuilder()
+	miseStep.Default("caddy", "latest")
+}
+
+func (p *StaticfileProvider) getRootDir(ctx *generate.GenerateContext) (string, error) {
+	if rootDir, _ := ctx.Env.GetConfigVariable("STATIC_FILE_ROOT"); rootDir != "" {
+		return rootDir, nil
+	}
+
+	staticfileConfig, err := p.getStaticfileConfig(ctx)
+	if staticfileConfig != nil && err == nil {
+		return staticfileConfig.RootDir, nil
+	}
+
+	if ctx.App.HasMatch("public") {
+		return "public", nil
+	} else if ctx.App.HasMatch("index.html") {
+		return ".", nil
+	}
+
+	return "", fmt.Errorf("no static file root dir found")
+}
+
+func (p *StaticfileProvider) getStaticfileConfig(ctx *generate.GenerateContext) (*StaticfileConfig, error) {
+	if !ctx.App.HasMatch(StaticfileConfigName) {
+		return nil, nil
+	}
+
+	staticfileData := StaticfileConfig{}
+	if err := ctx.App.ReadYAML(StaticfileConfigName, &staticfileData); err != nil {
+		return nil, err
+	}
+
+	return &staticfileData, nil
+}
+
+func (p *StaticfileProvider) getCaddyfile(data map[string]interface{}) (string, error) {
+	tmpl, err := template.New("Caddyfile").Parse(caddyfileTemplate)
+	if err != nil {
+		return "", err
+	}
+
+	var buf bytes.Buffer
+	if err := tmpl.Execute(&buf, data); err != nil {
+		return "", err
+	}
+
+	return buf.String(), nil
+}

core/providers/staticfile/staticfile_test.go

@@ -0,0 +1,102 @@
+package staticfile
+
+import (
+	"testing"
+
+	testingUtils "github.com/railwayapp/railpack/core/testing"
+	"github.com/stretchr/testify/require"
+)
+
+func TestDetect(t *testing.T) {
+	tests := []struct {
+		name string
+		path string
+		want bool
+	}{
+		{
+			name: "index",
+			path: "../../../examples/staticfile-index",
+			want: true,
+		},
+		{
+			name: "config",
+			path: "../../../examples/staticfile-config",
+			want: true,
+		},
+		{
+			name: "npm",
+			path: "../../../examples/node-npm",
+			want: false,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			ctx := testingUtils.CreateGenerateContext(t, tt.path)
+			provider := StaticfileProvider{}
+			got, err := provider.Detect(ctx)
+			require.NoError(t, err)
+			require.Equal(t, tt.want, got)
+		})
+	}
+}
+
+func TestGetRootDir(t *testing.T) {
+	tests := []struct {
+		name        string
+		path        string
+		envVars     map[string]string
+		want        string
+		expectError bool
+	}{
+		{
+			name: "from env var",
+			path: "../../../examples/staticfile-index",
+			envVars: map[string]string{
+				"RAILPACK_STATIC_FILE_ROOT": "/custom/path",
+			},
+			want:        "/custom/path",
+			expectError: false,
+		},
+		{
+			name:        "from staticfile config",
+			path:        "../../../examples/staticfile-config",
+			envVars:     map[string]string{},
+			want:        "hello",
+			expectError: false,
+		},
+		{
+			name:        "from index.html",
+			path:        "../../../examples/staticfile-index",
+			envVars:     map[string]string{},
+			want:        ".",
+			expectError: false,
+		},
+		{
+			name:        "no root dir",
+			path:        "../../../examples/node-npm",
+			envVars:     map[string]string{},
+			want:        "",
+			expectError: true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			ctx := testingUtils.CreateGenerateContext(t, tt.path)
+			for k, v := range tt.envVars {
+				ctx.Env.SetVariable(k, v)
+			}
+
+			provider := StaticfileProvider{}
+			got, err := provider.getRootDir(ctx)
+
+			if tt.expectError {
+				require.Error(t, err)
+			} else {
+				require.NoError(t, err)
+				require.Equal(t, tt.want, got)
+			}
+		})
+	}
+}

docs/astro.config.mjs

@@ -63,6 +63,7 @@ export default defineConfig({
             { label: "Python", link: "/languages/python" },
             { label: "Go", link: "/languages/golang" },
             { label: "PHP", link: "/languages/php" },
+            { label: "Staticfile", link: "/languages/staticfile" },
           ],
         },
         {