cd cmd/caddy && go run main.go run to print info to see detail. and caddyabc module

Author: farwish

admin.go

@@ -270,11 +270,14 @@ func (admin *AdminConfig) newAdminHandler(addr NetworkAddress, remote bool) admi
 	for _, m := range GetModules("admin.api") {
 		router := m.New().(AdminRouter)
 		handlerLabel := m.ID.Name()
+		fmt.Println("[newAdminHandler] handlerLabel is", handlerLabel)
 		for _, route := range router.Routes() {
+			fmt.Println("[newAdminHandler] route.Pattern is", route.Pattern)
 			addRoute(route.Pattern, handlerLabel, route.Handler)
 		}
 		admin.routers = append(admin.routers, router)
 	}
+	fmt.Println("[newAdminHandler] admin.routers is", admin.routers)
 
 	return muxWrap
 }
@@ -382,6 +385,7 @@ func (admin AdminConfig) allowedOrigins(addr NetworkAddress) []*url.URL {
 // that there is always an admin server (unless it is explicitly
 // configured to be disabled).
 func replaceLocalAdminServer(cfg *Config) error {
+	fmt.Println("[replaceLocalAdminServer] Into")
 	// always* be sure to close down the old admin endpoint
 	// as gracefully as possible, even if the new one is
 	// disabled -- careful to use reference to the current
@@ -423,7 +427,10 @@ func replaceLocalAdminServer(cfg *Config) error {
 		return err
 	}
 
+	fmt.Println("[replaceLocalAdminServer] newAdminHandler() into")
 	handler := cfg.Admin.newAdminHandler(addr, false)
+	fmt.Println("[replaceLocalAdminServer] newAdminHandler() out")
+	fmt.Println("-----------")
 
 	ln, err := addr.Listen(context.TODO(), 0, net.ListenConfig{})
 	if err != nil {
@@ -461,6 +468,9 @@ func replaceLocalAdminServer(cfg *Config) error {
 			zap.String("address", addr.String()))
 	}
 
+	fmt.Println("[replaceLocalAdminServer] Out")
+	fmt.Println("-----------")
+
 	return nil
 }
 
@@ -1131,6 +1141,17 @@ func unsyncedConfigAccess(method, path string, body []byte, out io.Writer) error
 
 	var ptr any = rawCfg
 
+	fmt.Println("=============")
+	fmt.Println("[unsyncedConfigAccess] Before traverseLoop:");
+	fmt.Println("body:", string(body)) 		// 配置的完整json字符串
+	fmt.Println("method:", method)			// POST
+	fmt.Println("parts:", parts)			// [config]
+	fmt.Println("len(parts):", len(parts)) 	// 1
+	fmt.Println("ptr:", ptr)				// map[config:<nil>]
+	fmt.Println("rawCfg:", rawCfg)			// map[config:<nil>]
+	fmt.Println("val:", val)				// 配置的完整json对象(GO的数据结构)
+	fmt.Println("=============")
+
 traverseLoop:
 	for i, part := range parts {
 		switch v := ptr.(type) {
@@ -1206,6 +1227,10 @@ traverseLoop:
 							v[part] = append(arr, val)
 						}
 					} else {
+						fmt.Println("[unsyncedConfigAccess] In traverseLoop:");
+						fmt.Println("arr,ok:", arr, ok)
+						fmt.Println("val:", val)
+						fmt.Println("=============")
 						v[part] = val
 					}
 				case http.MethodPut:
@@ -1262,6 +1287,12 @@ traverseLoop:
 		}
 	}
 
+	fmt.Println("[unsyncedConfigAccess] After traverseLoop:");
+	fmt.Println("ptr:", ptr)
+	fmt.Println("=============")
+	fmt.Println("rawCfg:", rawCfg)	// 此函数最终是为了，填充成 map["config":val] 这种形式
+	fmt.Println("=============")
+
 	return nil
 }
 

caddy.go

@@ -315,6 +315,8 @@ func indexConfigObjects(ptr any, configPath string, index map[string]string) err
 // allowPersist is false, it will not be persisted to disk,
 // even if it is configured to.
 func unsyncedDecodeAndRun(cfgJSON []byte, allowPersist bool) error {
+	fmt.Println("[unsyncedDecodeAndRun] Into")
+
 	// remove any @id fields from the JSON, which would cause
 	// loading to break since the field wouldn't be recognized
 	strippedCfgJSON := RemoveMetaFields(cfgJSON)
@@ -339,21 +341,31 @@ func unsyncedDecodeAndRun(cfgJSON []byte, allowPersist bool) error {
 		return fmt.Errorf("recursive config loading detected: pulled configs cannot pull other configs without positive load_delay")
 	}
 
+	fmt.Println("[unsyncedDecodeAndRun] before run()")
+
 	// run the new config and start all its apps
 	ctx, err := run(newCfg, true)
 	if err != nil {
 		return err
 	}
 
+	fmt.Println("[unsyncedDecodeAndRun] after run()")
+	fmt.Println("[unsyncedDecodeAndRun] newCfg:", newCfg)
+
 	// swap old context (including its config) with the new one
 	currentCtxMu.Lock()
 	oldCtx := currentCtx
 	currentCtx = ctx
 	currentCtxMu.Unlock()
 
+	fmt.Println("[unsyncedDecodeAndRun] before unsyncedStop(), oldCtx:", oldCtx)
+
 	// Stop, Cleanup each old app
 	unsyncedStop(oldCtx)
 
+	fmt.Println("[unsyncedDecodeAndRun] after unsyncedStop()")
+	fmt.Println("=============")
+
 	// autosave a non-nil config, if not disabled
 	if allowPersist &&
 		newCfg != nil &&
@@ -379,6 +391,9 @@ func unsyncedDecodeAndRun(cfgJSON []byte, allowPersist bool) error {
 		}
 	}
 
+	fmt.Println("[unsyncedDecodeAndRun] after autosave config")
+	fmt.Println("=============/")
+
 	return nil
 }
 
@@ -397,7 +412,22 @@ func unsyncedDecodeAndRun(cfgJSON []byte, allowPersist bool) error {
 // will want to use Run instead, which also
 // updates the config's raw state.
 func run(newCfg *Config, start bool) (Context, error) {
+	fmt.Println("----------")
+	fmt.Println("[run] Into")
+
+	fmt.Println("----------")
+	fmt.Println("Before provisionContext()")
+	fmt.Println("----------")
+
 	ctx, err := provisionContext(newCfg, start)
+
+	fmt.Println("----------")
+	fmt.Println("After provisionContext()")
+	fmt.Println("----------")
+
+	// {context.Background.WithCancel map[events:[0xc0007039e0] http:[0xc0003f86c0] http.matchers.host:[0xc0002a4240] tls:[0xc0000cfe00]] 0xc0003a08a0 [] [] []}
+	fmt.Println("[run] ctx:", ctx)
+
 	if err != nil {
 		return ctx, err
 	}
@@ -413,11 +443,18 @@ func run(newCfg *Config, start bool) (Context, error) {
 		return ctx, err
 	}
 
+	fmt.Println("[run] provisionAdminRouters after")
+	fmt.Println("----------")
+
 	// Start
 	err = func() error {
 		started := make([]string, 0, len(ctx.cfg.apps))
 		for name, a := range ctx.cfg.apps {
 			err := a.Start()
+
+			fmt.Println("[run]", name, "Started")
+			fmt.Println("----------/")
+
 			if err != nil {
 				// an app failed to start, so we need to stop
 				// all other apps that were already started
@@ -438,6 +475,9 @@ func run(newCfg *Config, start bool) (Context, error) {
 		return ctx, err
 	}
 
+	fmt.Println("[run] Before finishSettingUp")
+	fmt.Println("[run] ctx.cfg ：", ctx.cfg)
+
 	// now that the user's config is running, finish setting up anything else,
 	// such as remote admin endpoint, config loader, etc.
 	return ctx, finishSettingUp(ctx, ctx.cfg)
@@ -509,6 +549,8 @@ func provisionContext(newCfg *Config, replaceAdminServer bool) (Context, error)
 	// prepare the new config for use
 	newCfg.apps = make(map[string]App)
 
+	fmt.Println("[provisionContext] set up global storage Before")
+
 	// set up global storage and make it CertMagic's default storage, too
 	err = func() error {
 		if newCfg.StorageRaw != nil {
@@ -534,15 +576,22 @@ func provisionContext(newCfg *Config, replaceAdminServer bool) (Context, error)
 		return ctx, err
 	}
 
+	fmt.Println("[provisionContext] set up global storage After")
+	fmt.Println("[provisionContext] Load and Provision each app and their submodules Before")
+
 	// Load and Provision each app and their submodules
 	err = func() error {
 		for appName := range newCfg.AppsRaw {
+			fmt.Println("appName:", appName)
 			if _, err := ctx.App(appName); err != nil {
 				return err
 			}
 		}
 		return nil
 	}()
+
+	fmt.Println("[provisionContext] Load and Provision each app and their submodules After")
+
 	return ctx, err
 }
 
@@ -557,6 +606,9 @@ func ProvisionContext(newCfg *Config) (Context, error) {
 
 // finishSettingUp should be run after all apps have successfully started.
 func finishSettingUp(ctx Context, cfg *Config) error {
+	fmt.Println("----====----")
+	fmt.Println("[finishSettingUp] Into")
+
 	// establish this server's identity (only after apps are loaded
 	// so that cert management of this endpoint doesn't prevent user's
 	// servers from starting which likely also use HTTP/HTTPS ports;
@@ -566,14 +618,23 @@ func finishSettingUp(ctx Context, cfg *Config) error {
 		return fmt.Errorf("provisioning remote admin endpoint: %v", err)
 	}
 
+	fmt.Println("[finishSettingUp] replaceRemoteAdminServer before")
+
 	// replace any remote admin endpoint
 	err = replaceRemoteAdminServer(ctx, cfg)
 	if err != nil {
 		return fmt.Errorf("provisioning remote admin endpoint: %v", err)
 	}
 
+	fmt.Println("[finishSettingUp] replaceRemoteAdminServer after")
+	fmt.Println("[finishSettingUp] The cfg:", cfg)
+	fmt.Println("[finishSettingUp] cfg.Admin:", cfg.Admin)
+	fmt.Println("[finishSettingUp] cfg.Admin.Config:", cfg.Admin.Config)
+
 	// if dynamic config is requested, set that up and run it
 	if cfg != nil && cfg.Admin != nil && cfg.Admin.Config != nil && cfg.Admin.Config.LoadRaw != nil {
+		fmt.Println("[finishSettingUp] cfg.Admin.Config.LoadDelay =", cfg.Admin.Config.LoadDelay)
+
 		val, err := ctx.LoadModule(cfg.Admin.Config, "LoadRaw")
 		if err != nil {
 			return fmt.Errorf("loading config loader module: %s", err)
@@ -639,6 +700,8 @@ func finishSettingUp(ctx Context, cfg *Config) error {
 		}
 	}
 
+	fmt.Println("----====----/")
+
 	return nil
 }
 

caddyabc/README.md

@@ -0,0 +1,3 @@
+# caddyabc
+
+A custom module for plugged in.

caddyabc/a.go

@@ -0,0 +1,53 @@
+package caddyabc
+
+import (
+	"github.com/caddyserver/caddy/v2"
+)
+
+func init() {
+	caddy.Log().Info("init() caddyabc")
+	caddy.RegisterModule(A{})
+	caddy.RegisterModule(B{})
+}
+
+// A只是一个例子；可以是你自己的类型
+type A struct {
+	MyField string `json:"my_field,omitempty"`
+	Number  int    `json:"number,omitempty"`
+}
+
+// 通过CaddyModule方法返回Caddy模块的信息
+func (A) CaddyModule() caddy.ModuleInfo {
+	caddy.Log().Info("into A CaddyModule()")
+	return caddy.ModuleInfo{
+		ID:  "caddy.abc.a",   // namespace is caddy.abc, module_name is a
+		New: func() caddy.Module { return new(A) },
+	}
+}
+
+func (a *A) Start() error {
+	caddy.Log().Info("A is started")
+
+	return nil
+}
+
+// Provision sets up the module.
+func (g *A) Provision(ctx caddy.Context) error {
+	// TODO: set up the module
+
+	// ctx.Logger() is a *zap.Logger
+	ctx.Logger().Info("into A Provision()")
+	return nil
+}
+
+// Validate validates that the module has a usable config.
+func (g A) Validate() error {
+	// TODO: validate the module's setup
+	return nil
+}
+
+// Interface guards
+var (
+	_ caddy.Provisioner           = (*A)(nil)
+	_ caddy.Validator             = (*A)(nil)
+)

caddyabc/b.go

@@ -0,0 +1,49 @@
+package caddyabc
+
+import (
+	"github.com/caddyserver/caddy/v2"
+)
+
+// B只是一个例子；可以是你自己的类型
+type B struct {
+	MyField string `json:"my_field,omitempty"`
+	Number  int    `json:"number,omitempty"`
+}
+
+// 通过CaddyModule方法返回Caddy模块的信息
+func (B) CaddyModule() caddy.ModuleInfo {
+	caddy.Log().Info("into B CaddyModule()")
+	return caddy.ModuleInfo{
+		ID:  "caddy.abc.b",   // namespace is caddy.abc, module_name is b
+		New: func() caddy.Module { return new(B) },
+	}
+}
+
+func (b *B) Start() error {
+	caddy.Log().Info("B is started")
+
+	return nil
+}
+
+
+// Provision sets up the module.
+func (g *B) Provision(ctx caddy.Context) error {
+	// TODO: set up the module
+
+	// ctx.Logger() is a *zap.Logger
+	ctx.Logger().Info("into A Provision()")
+	return nil
+}
+
+// Validate validates that the module has a usable config.
+func (g B) Validate() error {
+	// TODO: validate the module's setup
+	return nil
+}
+
+// Interface guards
+var (
+	_ caddy.Provisioner           = (*B)(nil)
+	_ caddy.Validator             = (*B)(nil)
+)
+

cmd/caddy/main.go

@@ -32,6 +32,8 @@ import (
 	caddycmd "github.com/caddyserver/caddy/v2/cmd"
 
 	// plug in Caddy modules here
+	_ "github.com/caddyserver/caddy/v2/caddyabc"
+
 	_ "github.com/caddyserver/caddy/v2/modules/standard"
 )
 

cmd/main.go

@@ -214,6 +214,10 @@ func loadConfigWithLogger(logger *zap.Logger, configFile, adapterName string) ([
 			return nil, "", fmt.Errorf("adapting config using %s: %v", adapterName, err)
 		}
 		logger.Info("adapted config to JSON", zap.String("adapter", adapterName))
+		// logger.Info(string(config))
+		// logger.Info(string(configFile))
+		// logger.Info(string(adaptedConfig))
+		// os.Exit(1)
 		for _, warn := range warnings {
 			msg := warn.Message
 			if warn.Directive != "" {