k2safe/go-omni
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add generic phased background shutdown to managed services

Browse Source
This commit is contained in:
k2safe
2026-09-25 00:35:59 +08:00
parent adcb6f60b6
commit 16deead70e
37 changed files with 1330 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
scripts/testdata/phasedMySQL_test.go vendored Normal file
View File

@@ -0,0 +1,85 @@
package main
import (
"context"
"errors"
"example.com/mysqlAcceptance/internal/config"
"example.com/mysqlAcceptance/internal/svc"
"git.yuntuo.hk/k2safe/go-omni/lifecycle"
"git.yuntuo.hk/k2safe/go-omni/logx"
"io"
"testing"
"time"
)
func TestGeneratedMySQLBackgroundDrain(t *testing.T) {
cfg, err := config.Load("etc/config.yaml")
if err != nil {
t.Fatal(err)
}
logger, err := logx.New(logx.Config{Writer: io.Discard})
if err != nil {
t.Fatal(err)
}
defer logger.Close()
parent, cancel := context.WithCancel(context.Background())
defer cancel()
c, err := svc.New(parent, logger, cfg)
if err != nil {
t.Fatal(err)
}
defer c.Close()
stop := make(chan struct{})
finished := make(chan error, 1)
c.OnStop("writer", func(context.Context) error { close(stop); return nil })
c.OnDrain("writer", func(context.Context) error { return <-finished })
go func() {
<-stop
result := func() (err error) {
ctx, end := context.WithTimeout(c.WorkContext(), 3*time.Second)
defer end()
conn, err := c.DB.Conn(ctx)
if err != nil {
return err
}
defer func() { err = errors.Join(err, conn.Close()) }()
for _, query := range []string{"CREATE TEMPORARY TABLE omni_phase_records (id INT)", "INSERT INTO omni_phase_records VALUES (42)"} {
if _, err = conn.ExecContext(ctx, query); err != nil {
return err
}
}
var n int
if err = conn.QueryRowContext(ctx, "SELECT id FROM omni_phase_records").Scan(&n); err != nil {
return err
}
if n != 42 {
return errors.New("final background write missing")
}
_, err = conn.ExecContext(ctx, "DROP TEMPORARY TABLE omni_phase_records")
return err
}()
// Completion follows release of the borrowed connection, including failures.
finished <- result
}()
cancel()
if err = c.Finish(nil); err != nil {
t.Fatal(err)
}
if err = c.DB.PingContext(context.Background()); err == nil {
t.Fatal("pool not closed after worker finished")
}
held, err := svc.New(context.Background(), logger, cfg)
if err != nil {
t.Fatal(err)
}
defer held.DB.Close() // This test owns recovery and has no outstanding work.
cause := errors.New("worker completion unproven")
held.OnDrain("unjoined", func(context.Context) error { return cause })
if err = held.Finish(nil); !errors.Is(err, cause) || !errors.Is(err, lifecycle.ErrResourcesRetained) {
t.Fatal(err)
}
if err = held.DB.Health(context.Background()); err != nil {
t.Fatal("unjoined worker lost shared database", err)
}
}

11
scripts/verifyConnector.py
View File

@@ -44,6 +44,7 @@ def main():
parser.add_argument("--report", type=Path, required=True)
parser.add_argument("--image", default="mysql:8.4")
parser.add_argument("--gorm", action="store_true", help="also verify the optional GORM adapter and generated svc extension")
parser.add_argument("--phases", action="store_true", help="verify final background writes before generated pool cleanup (v0.15+)")
args = parser.parse_args()
if args.version and not re.fullmatch(r"v\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?", args.version):
parser.error("a fixed release version is required")
@@ -71,7 +72,7 @@ def main():
path.chmod(0o644) # Disposable fixtures, readable by the container's mysql uid.
project = temp / "consumer"
project.mkdir()
version = args.version or "v0.14.1-preview"
version = args.version or "v0.15.0-preview"
(project / "go.mod").write_text(f"module example.com/connectorAcceptance\n\ngo 1.22.0\n\nrequire {MODULE} {version}\n")
if args.local:
run(["go", "mod", "edit", f"-replace={MODULE}={ROOT}"], project, env)
@@ -102,6 +103,8 @@ def main():
command += ["--framework-dir", ROOT]
run([*command, generated], temp, env)
shutil.copyfile(ROOT / "scripts/testdata/mysqlGenerated_test.go", generated / "mysql_test.go")
if args.phases:
shutil.copyfile(ROOT / "scripts/testdata/phasedMySQL_test.go", generated / "phases_test.go")
if args.gorm:
# Only the documented project-owned extension is customized.
service = generated / "internal/svc/serviceContext.go"
@@ -169,6 +172,8 @@ def main():
generated_events = [json.loads(line) for line in output.splitlines() if line.startswith("{")]
generated_passed = [e["Test"] for e in generated_events if e.get("Action") == "pass" and "Test" in e]
assert "TestGeneratedMySQLConfigurationAndLifecycle" in generated_passed, output
if args.phases:
assert "TestGeneratedMySQLBackgroundDrain" in generated_passed, output
if args.gorm:
assert "TestGeneratedOptionalGORM" in generated_passed, output
assert not any(e.get("Action") == "fail" or (e.get("Action") == "skip" and "Test" in e) for e in generated_events), output
@@ -178,9 +183,11 @@ def main():
if created:
run(["docker", "rm", "--force", "--volumes", name], temp, env)
report_sources = sources + ["scripts/verifyConnector.py", "scripts/testdata/mysqlGenerated_test.go"]
if args.phases:
report_sources += ["scripts/testdata/phasedMySQL_test.go", "lifecycle/runtime.go", "lifecycle/phases.go"]
if args.gorm:
report_sources += ["scripts/testdata/gormGenerated_test.go", "database/gormx/gorm.go", "database/gormx/pool.go", "database/gormx/logger.go"]
report = {"passed": True, "frameworkVersion": version, "localSource": args.local, "gormAdapter": args.gorm,
report = {"passed": True, "frameworkVersion": version, "localSource": args.local, "gormAdapter": args.gorm, "phasedLifecycle": args.phases,
"frameworkSum": module.get("Sum"), "freshModuleCache": not args.local,
"noLocalReplace": not bool(module.get("Replace")), "mysqlImage": image,
"mysqlLimits": {"cpus": 1, "memoryMiB": 768, "pids": 128},

4
scripts/verifyManagedRelease.py
View File

@@ -81,9 +81,9 @@ def main():
evidence = "".join(e.get("Output", "") for e in events)
sums = re.findall(r"checksum (h1:\S+); no local replace", evidence)
assert len(sums) == len(tests) and all(s == dependency["Sum"] for s in sums), "remote consumer checksum mismatch"
checks += ["initializationAndListenFailureCleanup", "drainBeforeDependencyClose", "generatedConsumerRaceTests", "errorParamsAndInheritance", "manualHooksAndScalars", "dependencyFatalShutdown", "fatalProcessExitCode", "initializationShutdownNotification", "configuredBuiltinEndpoints", "projectHealthEnvelope", "endpointConflictCleanup", "responseArrayNullableNull", "strictRequestPolicies", "declarativeMultipartBinding"]
checks += ["initializationAndListenFailureCleanup", "drainBeforeDependencyClose", "generatedConsumerRaceTests", "errorParamsAndInheritance", "manualHooksAndScalars", "dependencyFatalShutdown", "fatalProcessExitCode", "initializationShutdownNotification", "configuredBuiltinEndpoints", "projectHealthEnvelope", "endpointConflictCleanup", "responseArrayNullableNull", "strictRequestPolicies", "declarativeMultipartBinding", "backgroundStopDrainResourceOrder", "backgroundInitAndListenFailureCleanup", "backgroundTimeoutRetainsResourcesAndExits"]
sources = ["lifecycle/runtime.go", "config/project.go", "contract/bind.go", "contract/policy.go", "contract/multipart.go", "contract/file.go", "cmd/go-omni/apigen/business_test.go", "cmd/go-omni/apigen/generate.go", "lifecycle/controller.go", "config/endpoints.go", "health/health.go", "httpx/response.go", "app/app.go", "app/transport.go", "scripts/verifyManagedRelease.py", "scripts/verifyManagedProject.py", "cmd/go-omni/apigen/managed_test.go"]
sources = ["lifecycle/runtime.go", "lifecycle/phases.go", "config/lifecycle_test.go", "task/task.go", "cmd/go-omni/scaffold/templates/api-runtime.go.tmpl", "cmd/go-omni/apigen/templates.go", "config/project.go", "contract/bind.go", "contract/policy.go", "contract/multipart.go", "contract/file.go", "cmd/go-omni/apigen/business_test.go", "cmd/go-omni/apigen/generate.go", "lifecycle/controller.go", "config/endpoints.go", "health/health.go", "httpx/response.go", "app/app.go", "app/transport.go", "scripts/verifyManagedRelease.py", "scripts/verifyManagedProject.py", "cmd/go-omni/apigen/managed_test.go"]
sources += [str(p.relative_to(ROOT)) for p in (ROOT / "cmd/go-omni/apigen/testdata/managed").glob("*.go")]
sources += [str(p.relative_to(ROOT)) for p in (ROOT / "cmd/go-omni/apigen/testdata/business").glob("*.go")]
report = {"passed": True, "frameworkVersion": args.version, "frameworkSum": dependency["Sum"],