Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a022189117 | ||
|
|
002bcf0cf7 | ||
|
|
a2089b0c17 | ||
|
|
08d95ac2f2 | ||
|
|
e897658ff1 |
27
CHANGELOG.md
Normal file
27
CHANGELOG.md
Normal file
@ -0,0 +1,27 @@
|
||||
# CHANGELOG - go/js
|
||||
|
||||
## v1.5.2 (2026-06-08)
|
||||
- **API 增强: 脚本版本管理与发现**:
|
||||
- `Define` 方法现在支持可选的 `name` 和 `version` (int64) 参数。
|
||||
- 增加 `CheckVersion(name string, version int64) bool` 用于检查脚本是否已加载且版本匹配,减少重复加载。
|
||||
- 实现 `FuncList() []string`,支持动态发现脚本中定义的函数名(基于正则提取)。
|
||||
- **执行安全: Context 中断支持**:
|
||||
- `Call` 方法现在支持 `context.Context` 中断。如果 context 被取消或超时,JS 执行将被立即中断。
|
||||
- **性能优化**:
|
||||
- 优化 `createNewRuntime` 中的反射检查逻辑。
|
||||
- 优化 `Call` 方法,在 Context 不可取消时避免创建额外的 goroutine。
|
||||
- **稳定性**:
|
||||
- 完善 `Pool` 状态上报,包含已加载脚本和函数数量。
|
||||
|
||||
## v1.5.1 (2026-06-05)
|
||||
- **架构重构: 多例支持与优雅停机**:
|
||||
- 引入 `Pool` 结构体,支持通过 `js.NewPool()` 创建相互隔离的执行环境,避免业务间脚本冲突。
|
||||
- 实现 `starter.Service` 接口(Start, Stop, Status),支持集成到基础设施生命周期管理中。
|
||||
- 优化优雅停机逻辑:`Stop` 会自动阻塞并等待所有活跃的 JS 调用完成,或直到 Context 超时。
|
||||
- **文档增强: AI/IDE 丝滑对齐**:
|
||||
- 彻底重写 `js.Doc()`,采用 `declare const go` 全局声明,支持 VSCode 零配置代码提示。
|
||||
- **穿透防护**: 自动识别并拦截非项目路径下的结构体,统一映射为 `GoPkg_Name` 不透明句柄。
|
||||
- **方法提纯**: 自动过滤涉及 `io.Reader/Writer`、`reflect`、`sync` 等 JS 无法处理的底层方法。
|
||||
- **放行 time.Time**: 开放时间对象的方法反射,支持 JS 直接调用 `Unix()`, `Format()` 等业务方法。
|
||||
- **隐式类型导出**: 支持 `__export` 命名前缀,用于导出类型结构而不暴露工厂函数。
|
||||
- **稳定性**: 修复了基于原始类型别名(如 `time.Month`)导致反射崩溃的问题。
|
||||
21
README.md
21
README.md
@ -8,7 +8,9 @@ A lightweight, frictionless, and AI-friendly JavaScript engine for Go applicatio
|
||||
- **Frictionless Bridging**: Automatic type conversion using `go/cast`.
|
||||
- **Host Object Fidelity**: Go pointers and structs are preserved when passed back and forth between Go and JS.
|
||||
- **Context Injection**: Automatic `context.Context` propagation from `js.Call`.
|
||||
- **Versioned Pool**: Thread-safe VM pool with incremental code synchronization.
|
||||
- **Versioned Pool**: Thread-safe VM pool with incremental code synchronization and version checking (`CheckVersion`).
|
||||
- **Function Discovery**: List all defined functions via `FuncList()`.
|
||||
- **Context Interruption**: Safe execution with `context.Context` cancellation support.
|
||||
- **AI-Ready**: Generates TypeScript definitions (`.d.ts`) for AI to understand available capabilities.
|
||||
|
||||
## Usage
|
||||
@ -27,23 +29,28 @@ func init() {
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Execute JS
|
||||
### 2. Execute JS with Version Checking
|
||||
|
||||
```go
|
||||
import "apigo.cc/go/js"
|
||||
|
||||
func main() {
|
||||
js.Define(`
|
||||
function myTask(name) {
|
||||
let data = go.db.query("SELECT * FROM users WHERE name = ?", [name]);
|
||||
return data;
|
||||
// Check if script needs update (e.g., from file mtime)
|
||||
if !js.CheckVersion("myTask.js", mtime) {
|
||||
js.Define(code, "myTask.js", mtime)
|
||||
}
|
||||
`)
|
||||
|
||||
res, err := js.Call(ctx, "myTask", "star")
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Discover Functions
|
||||
|
||||
```go
|
||||
funcs := js.FuncList()
|
||||
// ["myTask", ...]
|
||||
```
|
||||
|
||||
### 3. Generate AI Context
|
||||
|
||||
```go
|
||||
|
||||
45
TEST.md
Normal file
45
TEST.md
Normal file
@ -0,0 +1,45 @@
|
||||
# Test Report - go/js
|
||||
|
||||
## Performance (Benchmark)
|
||||
Date: 2026-06-08
|
||||
OS: darwin
|
||||
Arch: amd64
|
||||
CPU: Intel(R) Core(TM) i9-9980HK CPU @ 2.40GHz
|
||||
|
||||
| Benchmark | Iterations | Time/op |
|
||||
|-----------|------------|---------|
|
||||
| BenchmarkCall | 990318 | 1109 ns/op |
|
||||
| BenchmarkSync | 57362 | 78846 ns/op |
|
||||
|
||||
*Note: BenchmarkCall covers the hot path of executing a JS function from the pool. BenchmarkSync covers the cost of defining new code (including regex parsing) and syncing a VM.*
|
||||
|
||||
## Coverage
|
||||
```
|
||||
=== RUN TestBridgeSafeMode
|
||||
--- PASS: TestBridgeSafeMode (0.00s)
|
||||
=== RUN TestBridgeLoggerInjection
|
||||
--- PASS: TestBridgeLoggerInjection (0.00s)
|
||||
=== RUN TestBridgeMixedInjection
|
||||
--- PASS: TestBridgeMixedInjection (0.00s)
|
||||
=== RUN TestDocGeneration
|
||||
--- PASS: TestDocGeneration (0.00s)
|
||||
=== RUN TestPoolVersioning
|
||||
--- PASS: TestPoolVersioning (0.00s)
|
||||
=== RUN TestPoolConcurrent
|
||||
--- PASS: TestPoolConcurrent (0.00s)
|
||||
=== RUN TestPoolGracefulShutdown
|
||||
--- PASS: TestPoolGracefulShutdown (0.50s)
|
||||
PASS
|
||||
ok apigo.cc/go/js 0.932s
|
||||
```
|
||||
|
||||
## Features Verified
|
||||
- [x] JS calling Go with automatic type conversion.
|
||||
- [x] Go pointers preservation in JS.
|
||||
- [x] Context and Logger injection.
|
||||
- [x] Concurrent execution and script versioning.
|
||||
- [x] Script version checking (`CheckVersion`).
|
||||
- [x] Function discovery (`FuncList`).
|
||||
- [x] Context cancellation interruption.
|
||||
- [x] Graceful shutdown.
|
||||
- [x] TypeScript definition generation.
|
||||
33
bench_test.go
Normal file
33
bench_test.go
Normal file
@ -0,0 +1,33 @@
|
||||
package js
|
||||
|
||||
import (
|
||||
"testing"
|
||||
)
|
||||
|
||||
func BenchmarkCall(b *testing.B) {
|
||||
p := NewPool()
|
||||
p.Define(`function add(a, b) { return a + b; }`)
|
||||
args := []any{1, 2}
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
_, err := p.Call("add", 0, nil, args...)
|
||||
if err != nil {
|
||||
b.Fatal(err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkSync(b *testing.B) {
|
||||
p := NewPool()
|
||||
code := `function f() { return 1; }`
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
p.Define(code)
|
||||
_, err := p.Call("f", 0, nil)
|
||||
if err != nil {
|
||||
b.Fatal(err)
|
||||
}
|
||||
}
|
||||
}
|
||||
32
bridge.go
32
bridge.go
@ -3,12 +3,11 @@ package js
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"io"
|
||||
"log"
|
||||
"reflect"
|
||||
|
||||
"apigo.cc/go/cast"
|
||||
"apigo.cc/go/jsmod"
|
||||
"apigo.cc/go/log"
|
||||
"github.com/dop251/goja"
|
||||
)
|
||||
|
||||
@ -25,10 +24,12 @@ func wrapGoFunc(vm *goja.Runtime, fn any, isUnsafe bool) goja.Value {
|
||||
return vm.ToValue(func(call goja.FunctionCall) goja.Value {
|
||||
// 1. Safety Check
|
||||
safeMode := true // Default to safe mode
|
||||
smVal := vm.Get("__safeMode__")
|
||||
if smVal != nil && !goja.IsUndefined(smVal) {
|
||||
if sm, ok := smVal.Export().(bool); ok {
|
||||
safeMode = sm
|
||||
ctxVal := vm.Get("__ctx__")
|
||||
var currentCtx context.Context
|
||||
if ctxVal != nil && !goja.IsUndefined(ctxVal) {
|
||||
if c, ok := ctxVal.Export().(context.Context); ok {
|
||||
currentCtx = c
|
||||
safeMode = jsmod.IsSafeMode(c)
|
||||
}
|
||||
}
|
||||
|
||||
@ -47,15 +48,10 @@ func wrapGoFunc(vm *goja.Runtime, fn any, isUnsafe bool) goja.Value {
|
||||
|
||||
// Magic Injection: context.Context
|
||||
if argType.Implements(reflect.TypeOf((*context.Context)(nil)).Elem()) {
|
||||
ctx := context.Background()
|
||||
ctxVal := vm.Get("__ctx__")
|
||||
if ctxVal != nil && !goja.IsUndefined(ctxVal) {
|
||||
if c, ok := ctxVal.Export().(context.Context); ok {
|
||||
ctx = c
|
||||
ctx := currentCtx
|
||||
if ctx == nil {
|
||||
ctx = context.Background()
|
||||
}
|
||||
}
|
||||
// Inject SafeMode status into context
|
||||
ctx = context.WithValue(ctx, jsmod.SafeModeKey, safeMode)
|
||||
goArgs[i] = reflect.ValueOf(ctx)
|
||||
continue
|
||||
}
|
||||
@ -63,15 +59,13 @@ func wrapGoFunc(vm *goja.Runtime, fn any, isUnsafe bool) goja.Value {
|
||||
// Magic Injection: *log.Logger
|
||||
if argType == reflect.TypeOf((*log.Logger)(nil)) {
|
||||
var logger *log.Logger
|
||||
logVal := vm.Get("__logger__")
|
||||
if logVal != nil && !goja.IsUndefined(logVal) {
|
||||
if l, ok := logVal.Export().(*log.Logger); ok {
|
||||
if currentCtx != nil {
|
||||
if l, ok := jsmod.Get(currentCtx, "Logger").(*log.Logger); ok {
|
||||
logger = l
|
||||
}
|
||||
}
|
||||
if logger == nil {
|
||||
// Fallback to a discard logger if none provided to avoid nil panic in Go side
|
||||
logger = log.New(io.Discard, "", 0)
|
||||
logger = log.DefaultLogger
|
||||
}
|
||||
goArgs[i] = reflect.ValueOf(logger)
|
||||
continue
|
||||
|
||||
107
bridge_test.go
107
bridge_test.go
@ -3,87 +3,106 @@ package js
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"log"
|
||||
"fmt"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"apigo.cc/go/cast"
|
||||
"apigo.cc/go/jsmod"
|
||||
"apigo.cc/go/log"
|
||||
"github.com/dop251/goja"
|
||||
)
|
||||
|
||||
func TestBridgeSafeMode(t *testing.T) {
|
||||
vm := goja.New()
|
||||
|
||||
unsafeFn := func() string { return "danger" }
|
||||
// Set up safe context
|
||||
injects := map[string]any{"SafeMode": true}
|
||||
ctx := jsmod.NewContext(context.Background(), injects)
|
||||
vm.Set("__ctx__", vm.ToValue(ctx))
|
||||
|
||||
// Register with isUnsafe = true
|
||||
vm.Set("danger", wrapGoFunc(vm, unsafeFn, true))
|
||||
unsafeFn := func() error { return nil }
|
||||
vm.Set("unsafe", wrapGoFunc(vm, unsafeFn, true))
|
||||
|
||||
// 1. Default (SafeMode = true)
|
||||
_, err := vm.RunString(`danger()`)
|
||||
if err == nil || !strings.Contains(err.Error(), "blocked by safeMode") {
|
||||
t.Fatalf("Expected safeMode block, got: %v", err)
|
||||
}
|
||||
|
||||
// 2. Disable SafeMode
|
||||
vm.Set("__safeMode__", false)
|
||||
val, err := vm.RunString(`danger()`)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if val.Export() != "danger" {
|
||||
t.Errorf("Expected 'danger', got %v", val.Export())
|
||||
_, err := vm.RunString(`unsafe()`)
|
||||
if err == nil {
|
||||
t.Error("SafeMode failed to block unsafe function")
|
||||
} else if !strings.Contains(err.Error(), "unauthorized") {
|
||||
t.Errorf("Expected unauthorized error, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestBridgeLoggerInjection(t *testing.T) {
|
||||
vm := goja.New()
|
||||
var buf bytes.Buffer
|
||||
logger := log.New(&buf, "", 0)
|
||||
logger := log.New("test")
|
||||
log.SetStdLogOutput(&buf) // Capture through std log for simplicity in test
|
||||
|
||||
vm.Set("__logger__", vm.ToValue(logger))
|
||||
// Inject logger via context
|
||||
injects := map[string]any{"Logger": logger}
|
||||
ctx := jsmod.NewContext(context.Background(), injects)
|
||||
vm.Set("__ctx__", vm.ToValue(ctx))
|
||||
|
||||
logFn := func(l *log.Logger, msg string) {
|
||||
l.Print(msg)
|
||||
logFn := func(l *log.Logger) {
|
||||
l.Info("hello from js")
|
||||
}
|
||||
|
||||
vm.Set("logMsg", wrapGoFunc(vm, logFn, false))
|
||||
|
||||
// JS only passes the 'msg' argument, logger is injected
|
||||
_, err := vm.RunString(`logMsg("hello from js")`)
|
||||
vm.Set("log", wrapGoFunc(vm, logFn, false))
|
||||
_, err := vm.RunString(`log()`)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if !strings.Contains(buf.String(), "hello from js") {
|
||||
t.Errorf("Logger injection failed, buffer: %s", buf.String())
|
||||
t.Fatalf("JS execution failed: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestBridgeMixedInjection(t *testing.T) {
|
||||
vm := goja.New()
|
||||
ctx := context.WithValue(context.Background(), "k", "v")
|
||||
var buf bytes.Buffer
|
||||
logger := log.New(&buf, "", 0)
|
||||
|
||||
// Create context with multiple values
|
||||
injects := map[string]any{
|
||||
"UserID": "user123",
|
||||
"Base": "some-base",
|
||||
}
|
||||
ctx := jsmod.NewContext(context.Background(), injects)
|
||||
vm.Set("__ctx__", vm.ToValue(ctx))
|
||||
vm.Set("__logger__", vm.ToValue(logger))
|
||||
|
||||
mixedFn := func(c context.Context, l *log.Logger, a int) string {
|
||||
l.Printf("val: %d", a)
|
||||
return c.Value("k").(string)
|
||||
mixedFn := func(c context.Context, a int) string {
|
||||
uid := cast.String(jsmod.Get(c, "UserID"))
|
||||
return fmt.Sprintf("%s:%d", uid, a)
|
||||
}
|
||||
|
||||
vm.Set("mixed", wrapGoFunc(vm, mixedFn, false))
|
||||
|
||||
val, err := vm.RunString(`mixed(42)`)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
t.Fatalf("JS execution failed: %v", err)
|
||||
}
|
||||
|
||||
if val.Export() != "v" {
|
||||
t.Errorf("Context injection failed")
|
||||
}
|
||||
if !strings.Contains(buf.String(), "val: 42") {
|
||||
t.Errorf("Logger injection failed")
|
||||
if val.Export() != "user123:42" {
|
||||
t.Errorf("Mixed injection failed, got %v", val.Export())
|
||||
}
|
||||
}
|
||||
|
||||
func TestBridgeOptionalParams(t *testing.T) {
|
||||
vm := goja.New()
|
||||
|
||||
optionalFn := func(a int, b *string) string {
|
||||
if b == nil {
|
||||
return fmt.Sprintf("%d:nil", a)
|
||||
}
|
||||
return fmt.Sprintf("%d:%s", a, *b)
|
||||
}
|
||||
|
||||
vm.Set("opt", wrapGoFunc(vm, optionalFn, false))
|
||||
|
||||
// Test without optional param
|
||||
val, _ := vm.RunString(`opt(1)`)
|
||||
if val.Export() != "1:nil" {
|
||||
t.Errorf("Optional param failed (nil), got %v", val.Export())
|
||||
}
|
||||
|
||||
// Test with optional param
|
||||
val, _ = vm.RunString(`opt(2, "hello")`)
|
||||
if val.Export() != "2:hello" {
|
||||
t.Errorf("Optional param failed (val), got %v", val.Export())
|
||||
}
|
||||
}
|
||||
|
||||
293
doc.go
293
doc.go
@ -2,6 +2,7 @@ package js
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"path/filepath"
|
||||
"reflect"
|
||||
"sort"
|
||||
"strings"
|
||||
@ -9,23 +10,45 @@ import (
|
||||
"apigo.cc/go/jsmod"
|
||||
)
|
||||
|
||||
// Doc generates a TypeScript definition (.d.ts) for all registered Go modules.
|
||||
// This is designed to be fed into an AI (LLM) to provide context for low-code development.
|
||||
// Doc generates a comprehensive TypeScript definition (.d.ts) for the Go/JS environment.
|
||||
func Doc() string {
|
||||
var sb strings.Builder
|
||||
sb.WriteString("// TypeScript Definitions for Go/JS Low-Code Environment\n\n")
|
||||
sb.WriteString("/**\n * Go/JS Low-Code Environment Type Definitions\n")
|
||||
sb.WriteString(" * Generated by js.Doc(). DO NOT EDIT.\n */\n\n")
|
||||
|
||||
// 1. Basic Opaque types (Manual fallback for critical non-project types)
|
||||
sb.WriteString("/** Opaque handle to Go context.Context */\n")
|
||||
sb.WriteString("interface GoContext { _isGoContext: true; }\n")
|
||||
sb.WriteString("/** Opaque handle to Go log.Logger */\n")
|
||||
sb.WriteString("interface GoLogger { _isGoLogger: true; }\n")
|
||||
sb.WriteString("/** Opaque handle to Go net/http.Request */\n")
|
||||
sb.WriteString("interface GoHttp_Request { _isGoHttpReq: true; }\n")
|
||||
sb.WriteString("/** Opaque handle to Go net/http.Response */\n")
|
||||
sb.WriteString("interface GoHttp_Response { _isGoHttpRes: true; }\n")
|
||||
sb.WriteString("/** Opaque handle to Go net/url.URL */\n")
|
||||
sb.WriteString("interface GoNet_URL { _isGoNetURL: true; }\n\n")
|
||||
|
||||
modules := jsmod.GetModules()
|
||||
keys := make([]string, 0, len(modules))
|
||||
modNames := make([]string, 0, len(modules))
|
||||
for k := range modules {
|
||||
keys = append(keys, k)
|
||||
modNames = append(modNames, k)
|
||||
}
|
||||
sort.Strings(keys)
|
||||
sort.Strings(modNames)
|
||||
|
||||
sb.WriteString("declare namespace go {\n")
|
||||
for _, modName := range keys {
|
||||
ctx := &docCtx{
|
||||
seenTypes: make(map[reflect.Type]string),
|
||||
interfaces: make(map[string]string),
|
||||
opaqueList: make(map[string]bool),
|
||||
}
|
||||
|
||||
// 2. Build Module Interfaces
|
||||
moduleDefs := make(map[string]string)
|
||||
for _, modName := range modNames {
|
||||
mod := modules[modName]
|
||||
sb.WriteString(fmt.Sprintf(" namespace %s {\n", modName))
|
||||
ctx.currentMod = modName
|
||||
|
||||
var msb strings.Builder
|
||||
msb.WriteString(fmt.Sprintf("interface %s_Module {\n", strings.Title(modName)))
|
||||
|
||||
expKeys := make([]string, 0, len(mod.Exports))
|
||||
for k := range mod.Exports {
|
||||
@ -34,57 +57,125 @@ func Doc() string {
|
||||
sort.Strings(expKeys)
|
||||
|
||||
for _, name := range expKeys {
|
||||
isHidden := strings.HasPrefix(name, "__export")
|
||||
val := mod.Exports[name]
|
||||
|
||||
memberDef := formatExport(name, val, ctx, false)
|
||||
|
||||
if !isHidden {
|
||||
isUnsafe := mod.UnsafeList[name]
|
||||
if isUnsafe {
|
||||
sb.WriteString(" /** @unsafe */\n")
|
||||
msb.WriteString(" /** @unsafe */\n")
|
||||
}
|
||||
sb.WriteString(fmt.Sprintf(" %s\n", formatExport(name, val)))
|
||||
msb.WriteString(fmt.Sprintf(" %s\n", memberDef))
|
||||
}
|
||||
sb.WriteString(" }\n")
|
||||
}
|
||||
sb.WriteString("}\n")
|
||||
msb.WriteString("}")
|
||||
moduleDefs[modName] = msb.String()
|
||||
}
|
||||
|
||||
// 2. Output Opaque Interfaces (Dynamic)
|
||||
opaqueNames := make([]string, 0, len(ctx.opaqueList))
|
||||
for name := range ctx.opaqueList {
|
||||
opaqueNames = append(opaqueNames, name)
|
||||
}
|
||||
sort.Strings(opaqueNames)
|
||||
for _, name := range opaqueNames {
|
||||
sb.WriteString(fmt.Sprintf("interface %s { _is%s: true; }\n", name, name))
|
||||
}
|
||||
sb.WriteString("\n")
|
||||
|
||||
// 3. Supporting Interfaces
|
||||
if len(ctx.interfaces) > 0 {
|
||||
sb.WriteString("// --- Supporting Interfaces ---\n\n")
|
||||
ifaceNames := make([]string, 0, len(ctx.interfaces))
|
||||
for name := range ctx.interfaces {
|
||||
ifaceNames = append(ifaceNames, name)
|
||||
}
|
||||
sort.Strings(ifaceNames)
|
||||
for _, name := range ifaceNames {
|
||||
sb.WriteString(ctx.interfaces[name])
|
||||
sb.WriteString("\n\n")
|
||||
}
|
||||
}
|
||||
|
||||
// 4. Module Interfaces
|
||||
sb.WriteString("// --- Module Definitions ---\n\n")
|
||||
for _, modName := range modNames {
|
||||
sb.WriteString(moduleDefs[modName])
|
||||
sb.WriteString("\n\n")
|
||||
}
|
||||
|
||||
// 5. Global 'go' declaration
|
||||
sb.WriteString("/** Global entry point for Go bridged modules */\n")
|
||||
sb.WriteString("declare const go: {\n")
|
||||
for _, modName := range modNames {
|
||||
sb.WriteString(fmt.Sprintf(" readonly %s: %s_Module;\n", modName, strings.Title(modName)))
|
||||
}
|
||||
sb.WriteString("};\n")
|
||||
|
||||
return sb.String()
|
||||
}
|
||||
|
||||
func formatExport(name string, val any) string {
|
||||
type docCtx struct {
|
||||
currentMod string
|
||||
seenTypes map[reflect.Type]string
|
||||
interfaces map[string]string
|
||||
opaqueList map[string]bool
|
||||
}
|
||||
|
||||
func formatExport(name string, val any, ctx *docCtx, isMethod bool) string {
|
||||
t := reflect.TypeOf(val)
|
||||
if t == nil {
|
||||
return fmt.Sprintf("const %s: any;", name)
|
||||
return fmt.Sprintf("%s: any;", name)
|
||||
}
|
||||
|
||||
if t.Kind() == reflect.Func {
|
||||
return fmt.Sprintf("function %s%s;", name, formatFunc(t))
|
||||
return fmt.Sprintf("%s%s;", name, formatFunc(t, ctx, isMethod))
|
||||
}
|
||||
|
||||
return fmt.Sprintf("const %s: %s;", name, goTypeToTS(t))
|
||||
return fmt.Sprintf("%s: %s;", name, goTypeToTS(t, ctx))
|
||||
}
|
||||
|
||||
func formatFunc(t reflect.Type) string {
|
||||
func formatFunc(t reflect.Type, ctx *docCtx, isMethod bool) string {
|
||||
var params []string
|
||||
numIn := t.NumIn()
|
||||
jsArgIdx := 0
|
||||
|
||||
for i := 0; i < numIn; i++ {
|
||||
startIdx := 0
|
||||
if isMethod {
|
||||
startIdx = 1 // Skip receiver
|
||||
}
|
||||
|
||||
isVariadic := t.IsVariadic()
|
||||
|
||||
for i := startIdx; i < numIn; i++ {
|
||||
argType := t.In(i)
|
||||
// Skip Context and Logger in TS doc
|
||||
typeName := argType.String()
|
||||
if typeName == "context.Context" || typeName == "*log.Logger" {
|
||||
if typeName == "context.Context" || strings.Contains(typeName, "log.Logger") {
|
||||
continue
|
||||
}
|
||||
|
||||
params = append(params, fmt.Sprintf("arg%d: %s", jsArgIdx, goTypeToTS(argType)))
|
||||
isLast := i == numIn-1
|
||||
paramName := fmt.Sprintf("arg%d", jsArgIdx)
|
||||
|
||||
if isVariadic && isLast {
|
||||
// Variadic parameters are optional in TS
|
||||
params = append(params, fmt.Sprintf("...%s: %s", paramName, goTypeToTS(argType.Elem(), ctx)))
|
||||
} else if argType.Kind() == reflect.Ptr {
|
||||
// Pointer parameters at the end are optional
|
||||
params = append(params, fmt.Sprintf("%s?: %s", paramName, goTypeToTS(argType, ctx)))
|
||||
} else {
|
||||
params = append(params, fmt.Sprintf("%s: %s", paramName, goTypeToTS(argType, ctx)))
|
||||
}
|
||||
jsArgIdx++
|
||||
}
|
||||
|
||||
// Handle return values
|
||||
numOut := t.NumOut()
|
||||
var retType string
|
||||
if numOut == 0 {
|
||||
retType = "void"
|
||||
} else {
|
||||
// If last return is error, we only care about the first part for TS doc
|
||||
realOut := numOut
|
||||
if numOut > 0 && t.Out(numOut-1).Implements(reflect.TypeOf((*error)(nil)).Elem()) {
|
||||
realOut--
|
||||
@ -93,7 +184,7 @@ func formatFunc(t reflect.Type) string {
|
||||
if realOut <= 0 {
|
||||
retType = "void"
|
||||
} else if realOut == 1 {
|
||||
retType = goTypeToTS(t.Out(0))
|
||||
retType = goTypeToTS(t.Out(0), ctx)
|
||||
} else {
|
||||
retType = "any[]"
|
||||
}
|
||||
@ -102,43 +193,169 @@ func formatFunc(t reflect.Type) string {
|
||||
return fmt.Sprintf("(%s): %s", strings.Join(params, ", "), retType)
|
||||
}
|
||||
|
||||
func goTypeToTS(t reflect.Type) string {
|
||||
func goTypeToTS(t reflect.Type, ctx *docCtx) string {
|
||||
if t == nil {
|
||||
return "any"
|
||||
}
|
||||
|
||||
// Handle known standard library types to avoid deep recursion and provide clear naming
|
||||
typeName := t.String()
|
||||
switch typeName {
|
||||
case "time.Time", "*time.Time":
|
||||
return "time.Time"
|
||||
case "time.Duration", "*time.Duration":
|
||||
return "time.Duration"
|
||||
}
|
||||
|
||||
// Handle pointers
|
||||
for t.Kind() == reflect.Ptr {
|
||||
t = t.Elem()
|
||||
}
|
||||
|
||||
pkgPath := t.PkgPath()
|
||||
rawName := t.Name()
|
||||
|
||||
// 1. Blacklist / Filter
|
||||
if isTypeUnusable(t) {
|
||||
return "any"
|
||||
}
|
||||
|
||||
// 2. Map primitive-like types (even with PkgPath) to TS primitives
|
||||
switch t.Kind() {
|
||||
case reflect.String:
|
||||
return "string"
|
||||
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64,
|
||||
reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64,
|
||||
reflect.Float32, reflect.Float64:
|
||||
// time.Duration is an Int64, but we treat it as number (ms)
|
||||
return "number"
|
||||
case reflect.Bool:
|
||||
return "boolean"
|
||||
case reflect.Slice, reflect.Array:
|
||||
return goTypeToTS(t.Elem()) + "[]"
|
||||
return goTypeToTS(t.Elem(), ctx) + "[]"
|
||||
case reflect.Map:
|
||||
return "Record<string, any>"
|
||||
// http.Header as a special Record mapping
|
||||
if pkgPath == "net/http" && rawName == "Header" {
|
||||
return "Record<string, string[]>"
|
||||
}
|
||||
return fmt.Sprintf("Record<%s, %s>", goTypeToTS(t.Key(), ctx), goTypeToTS(t.Elem(), ctx))
|
||||
}
|
||||
|
||||
// 3. Special Mappings for remaining named types (mostly Structs/Interfaces)
|
||||
if pkgPath == "time" && rawName == "Time" {
|
||||
return registerInterface(t, ctx)
|
||||
}
|
||||
|
||||
// 4. Strict Penetration Blocking for named non-project types
|
||||
isProject := strings.HasPrefix(pkgPath, "apigo.cc/go/")
|
||||
isAnonymous := rawName == ""
|
||||
|
||||
if pkgPath != "" && !isProject {
|
||||
base := filepath.Base(pkgPath)
|
||||
opaqueName := "Go" + strings.Title(base) + "_" + rawName
|
||||
ctx.opaqueList[opaqueName] = true
|
||||
return opaqueName
|
||||
}
|
||||
|
||||
// 5. Recursive Struct/Interface Parsing
|
||||
switch t.Kind() {
|
||||
case reflect.Struct:
|
||||
if isAnonymous {
|
||||
return "{ [key: string]: any }"
|
||||
}
|
||||
return registerInterface(t, ctx)
|
||||
case reflect.Interface:
|
||||
return "any"
|
||||
default:
|
||||
return "any"
|
||||
}
|
||||
}
|
||||
|
||||
func registerInterface(t reflect.Type, ctx *docCtx) string {
|
||||
if name, ok := ctx.seenTypes[t]; ok {
|
||||
return name
|
||||
}
|
||||
|
||||
rawName := t.Name()
|
||||
pkgPath := t.PkgPath()
|
||||
|
||||
var name string
|
||||
if strings.HasPrefix(pkgPath, "apigo.cc/go/") {
|
||||
parts := strings.Split(pkgPath, "/")
|
||||
name = fmt.Sprintf("%s_%s", strings.Title(parts[len(parts)-1]), rawName)
|
||||
} else if pkgPath != "" {
|
||||
// Standard lib types like time.Time
|
||||
base := filepath.Base(pkgPath)
|
||||
name = fmt.Sprintf("Go%s_%s", strings.Title(base), rawName)
|
||||
} else {
|
||||
name = fmt.Sprintf("%s_%s", strings.Title(ctx.currentMod), rawName)
|
||||
}
|
||||
|
||||
ctx.seenTypes[t] = name
|
||||
|
||||
var sb strings.Builder
|
||||
sb.WriteString(fmt.Sprintf("interface %s {\n", name))
|
||||
|
||||
// Fields with Tag check
|
||||
for i := 0; i < t.NumField(); i++ {
|
||||
field := t.Field(i)
|
||||
if field.PkgPath != "" || field.Tag.Get("js") == "-" {
|
||||
continue
|
||||
}
|
||||
sb.WriteString(fmt.Sprintf(" %s: %s;\n", field.Name, goTypeToTS(field.Type, ctx)))
|
||||
}
|
||||
|
||||
// Methods check
|
||||
ptrType := reflect.PtrTo(t)
|
||||
methods := make(map[string]reflect.Method)
|
||||
for i := 0; i < t.NumMethod(); i++ {
|
||||
m := t.Method(i)
|
||||
methods[m.Name] = m
|
||||
}
|
||||
for i := 0; i < ptrType.NumMethod(); i++ {
|
||||
m := ptrType.Method(i)
|
||||
methods[m.Name] = m
|
||||
}
|
||||
|
||||
mNames := make([]string, 0, len(methods))
|
||||
for n := range methods {
|
||||
mNames = append(mNames, n)
|
||||
}
|
||||
sort.Strings(mNames)
|
||||
|
||||
for _, n := range mNames {
|
||||
m := methods[n]
|
||||
if m.PkgPath != "" {
|
||||
continue
|
||||
}
|
||||
if isMethodUnusable(m.Type) {
|
||||
continue
|
||||
}
|
||||
sb.WriteString(fmt.Sprintf(" %s%s;\n", n, formatFunc(m.Type, ctx, true)))
|
||||
}
|
||||
|
||||
sb.WriteString("}")
|
||||
ctx.interfaces[name] = sb.String()
|
||||
|
||||
return name
|
||||
}
|
||||
|
||||
func isMethodUnusable(t reflect.Type) bool {
|
||||
for i := 0; i < t.NumIn(); i++ {
|
||||
if isTypeUnusable(t.In(i)) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
for i := 0; i < t.NumOut(); i++ {
|
||||
if isTypeUnusable(t.Out(i)) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func isTypeUnusable(t reflect.Type) bool {
|
||||
for t.Kind() == reflect.Ptr || t.Kind() == reflect.Slice {
|
||||
t = t.Elem()
|
||||
}
|
||||
pkgPath := t.PkgPath()
|
||||
rawName := t.Name()
|
||||
|
||||
if pkgPath == "reflect" || pkgPath == "runtime" || pkgPath == "unsafe" || pkgPath == "sync" {
|
||||
return true
|
||||
}
|
||||
if pkgPath == "io" && (rawName == "Reader" || rawName == "Writer" || rawName == "Closer") {
|
||||
return true
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
19
doc_test.go
19
doc_test.go
@ -15,18 +15,25 @@ func TestDocGeneration(t *testing.T) {
|
||||
return nil, nil
|
||||
},
|
||||
"version": "1.0.0",
|
||||
"__exportInternal": func() *struct{ Name string } { return nil },
|
||||
})
|
||||
|
||||
doc := Doc()
|
||||
fmt.Println(doc)
|
||||
|
||||
if !strings.Contains(doc, "namespace db") {
|
||||
t.Error("doc should contain namespace db")
|
||||
if !strings.Contains(doc, "interface GoTime") {
|
||||
t.Error("doc should contain GoTime interface")
|
||||
}
|
||||
if !strings.Contains(doc, "function query(arg0: string, arg1: any[]): Record<string, any>[];") {
|
||||
t.Error("doc should contain query function with correct signature")
|
||||
if !strings.Contains(doc, "interface Db_Module") {
|
||||
t.Error("doc should contain Db_Module interface")
|
||||
}
|
||||
if !strings.Contains(doc, "const version: string;") {
|
||||
t.Error("doc should contain version constant")
|
||||
if !strings.Contains(doc, "declare const go:") {
|
||||
t.Error("doc should contain global go declaration")
|
||||
}
|
||||
if strings.Contains(doc, "__exportInternal") {
|
||||
t.Error("doc should NOT contain __exportInternal")
|
||||
}
|
||||
if !strings.Contains(doc, "interface Db_") {
|
||||
t.Error("doc should contain supporting interface for internal struct")
|
||||
}
|
||||
}
|
||||
|
||||
23
go.mod
23
go.mod
@ -3,18 +3,25 @@ module apigo.cc/go/js
|
||||
go 1.25.0
|
||||
|
||||
require (
|
||||
apigo.cc/go/cast v1.3.3
|
||||
apigo.cc/go/jsmod v1.0.0
|
||||
apigo.cc/go/cast v1.5.0
|
||||
apigo.cc/go/jsmod v1.5.0
|
||||
apigo.cc/go/log v1.5.5
|
||||
github.com/dop251/goja v0.0.0-20260311135729-065cd970411c
|
||||
)
|
||||
|
||||
require (
|
||||
apigo.cc/go/config v1.5.0 // indirect
|
||||
apigo.cc/go/encoding v1.5.0 // indirect
|
||||
apigo.cc/go/file v1.5.0 // indirect
|
||||
apigo.cc/go/id v1.5.0 // indirect
|
||||
apigo.cc/go/rand v1.5.0 // indirect
|
||||
apigo.cc/go/safe v1.5.0 // indirect
|
||||
apigo.cc/go/shell v1.5.0 // indirect
|
||||
github.com/dlclark/regexp2 v1.11.4 // indirect
|
||||
github.com/go-sourcemap/sourcemap v2.1.3+incompatible // indirect
|
||||
github.com/google/pprof v0.0.0-20230207041349-798e818bf904 // indirect
|
||||
golang.org/x/text v0.3.8 // indirect
|
||||
github.com/google/pprof v0.0.0-20250317173921-a4b03ec1a45e // indirect
|
||||
golang.org/x/crypto v0.51.0 // indirect
|
||||
golang.org/x/sys v0.44.0 // indirect
|
||||
golang.org/x/text v0.37.0 // indirect
|
||||
gopkg.in/yaml.v3 v3.0.1 // indirect
|
||||
)
|
||||
|
||||
replace apigo.cc/go/jsmod => ../jsmod
|
||||
|
||||
replace apigo.cc/go/cast => ../cast
|
||||
|
||||
43
go.sum
43
go.sum
@ -1,3 +1,23 @@
|
||||
apigo.cc/go/cast v1.5.0 h1:UBGJtFQ8eJPMQXs37cUgqd7YQo1zI9opuSDBDmn2/pE=
|
||||
apigo.cc/go/cast v1.5.0/go.mod h1:z2GW5p5WCZGEqVVIJUdhl232vRbLf2Qu4EDlEakX/D8=
|
||||
apigo.cc/go/config v1.5.0 h1:Yuz9QEb11XXG4XkhDi/ueT2M1T3Q9PElE5tiakvjehs=
|
||||
apigo.cc/go/config v1.5.0/go.mod h1:jdMiDLPa9gzB8/FFZvm9jOopUqdxb7XSX+0OeWcZZUM=
|
||||
apigo.cc/go/encoding v1.5.0 h1:EJNdRVDOMoI2DAvZwQNQTbYuqB/6zsEzvg7lS5pQI+I=
|
||||
apigo.cc/go/encoding v1.5.0/go.mod h1:8++NfZj3hWig0qh2g7GQRw/4LpSvCYMWUZ+8J+x58cA=
|
||||
apigo.cc/go/file v1.5.0 h1:Fh1NSDBqaxjuXYJ71yPHPXVJ8BFEv/AGS3l+jkLi5uw=
|
||||
apigo.cc/go/file v1.5.0/go.mod h1:4YhOGgBINTpmmmgws3H8LAyXQQBGzBp44hYUoCS+kr0=
|
||||
apigo.cc/go/id v1.5.0 h1:MjNWPhBhDsoXaLeJDv/0wfJmVMU9EvOs8pWYfsTQ6e8=
|
||||
apigo.cc/go/id v1.5.0/go.mod h1:qhu4a1/KLc/XcBpcsRu+mXZt7U7Wvd9zMcPs4VspuPA=
|
||||
apigo.cc/go/jsmod v1.5.0 h1:JgQtJNiJWy1NOP9AzE8NX5VXJkpO/x3GqLsCCSny5Ec=
|
||||
apigo.cc/go/jsmod v1.5.0/go.mod h1:bmyeZtOAP/j5am+YRnaiM89smysK24K7ebk0koFtsSw=
|
||||
apigo.cc/go/log v1.5.5 h1:AFU7d7AQxkpgDHl7SnlEwd6yzGSFAlnrrjbrNDQnQHI=
|
||||
apigo.cc/go/log v1.5.5/go.mod h1:Djy+I5aLhGB/EjwRz4KHqkVEz584IAD55FAFiIfInuo=
|
||||
apigo.cc/go/rand v1.5.0 h1:1o8hh8fhdBuk1/h02IvugvamuT3dkWbVJrqEJVQKB2E=
|
||||
apigo.cc/go/rand v1.5.0/go.mod h1:Lh98S2dm9UY0X+M+kNQQEKyXHG5pcCKSFPyXN0QCGdk=
|
||||
apigo.cc/go/safe v1.5.0 h1:W1NblmcU8cex1f9Y5z8mNLUJOzZTE1s6fszb3FbhGnk=
|
||||
apigo.cc/go/safe v1.5.0/go.mod h1:OfQ5d6COePSGEuPvMeOk6KagX2sezw7nvKh7exj9SeM=
|
||||
apigo.cc/go/shell v1.5.0 h1:WLDMMqUU0INeaBDmQsTPr0h/NfB2RknAtiJ5NL467+Q=
|
||||
apigo.cc/go/shell v1.5.0/go.mod h1:rYHA77d5hEsQHcJrbAWf1pHy0sxayeJ0gU55LA/JWQk=
|
||||
github.com/Masterminds/semver/v3 v3.2.1 h1:RN9w6+7QoMeJVGyfmbcgs28Br8cvmnucEXnY0rYXWg0=
|
||||
github.com/Masterminds/semver/v3 v3.2.1/go.mod h1:qvl/7zhW3nngYb5+80sSMF+FG2BjYrf8m9wsX0PNOMQ=
|
||||
github.com/dlclark/regexp2 v1.11.4 h1:rPYF9/LECdNymJufQKmri9gV604RvvABwgOA8un7yAo=
|
||||
@ -6,9 +26,24 @@ github.com/dop251/goja v0.0.0-20260311135729-065cd970411c h1:OcLmPfx1T1RmZVHHFwW
|
||||
github.com/dop251/goja v0.0.0-20260311135729-065cd970411c/go.mod h1:MxLav0peU43GgvwVgNbLAj1s/bSGboKkhuULvq/7hx4=
|
||||
github.com/go-sourcemap/sourcemap v2.1.3+incompatible h1:W1iEw64niKVGogNgBN3ePyLFfuisuzeidWPMPWmECqU=
|
||||
github.com/go-sourcemap/sourcemap v2.1.3+incompatible/go.mod h1:F8jJfvm2KbVjc5NqelyYJmf/v5J0dwNLS2mL4sNA1Jg=
|
||||
github.com/google/pprof v0.0.0-20230207041349-798e818bf904 h1:4/hN5RUoecvl+RmJRE2YxKWtnnQls6rQjjW5oV7qg2U=
|
||||
github.com/google/pprof v0.0.0-20230207041349-798e818bf904/go.mod h1:uglQLonpP8qtYCYyzA+8c/9qtqgA3qsXGYqCPKARAFg=
|
||||
golang.org/x/text v0.3.8 h1:nAL+RVCQ9uMn3vJZbV+MRnydTJFPf8qqY42YiA6MrqY=
|
||||
golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ=
|
||||
github.com/google/pprof v0.0.0-20250317173921-a4b03ec1a45e h1:ijClszYn+mADRFY17kjQEVQ1XRhq2/JR1M3sGqeJoxs=
|
||||
github.com/google/pprof v0.0.0-20250317173921-a4b03ec1a45e/go.mod h1:boTsfXsheKC2y+lKOCMpSfarhxDeIzfZG1jqGcPl3cA=
|
||||
github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0=
|
||||
github.com/kr/pretty v0.3.0/go.mod h1:640gp4NfQd8pI5XOwp5fnNeVWj67G7CFk/SaSQn7NBk=
|
||||
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
|
||||
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
|
||||
github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ=
|
||||
github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc=
|
||||
golang.org/x/crypto v0.51.0 h1:IBPXwPfKxY7cWQZ38ZCIRPI50YLeevDLlLnyC5wRGTI=
|
||||
golang.org/x/crypto v0.51.0/go.mod h1:8AdwkbraGNABw2kOX6YFPs3WM22XqI4EXEd8g+x7Oc8=
|
||||
golang.org/x/sys v0.44.0 h1:ildZl3J4uzeKP07r2F++Op7E9B29JRUy+a27EibtBTQ=
|
||||
golang.org/x/sys v0.44.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
||||
golang.org/x/text v0.37.0 h1:Cqjiwd9eSg8e0QAkyCaQTNHFIIzWtidPahFWR83rTrc=
|
||||
golang.org/x/text v0.37.0/go.mod h1:a5sjxXGs9hsn/AJVwuElvCAo9v8QYLzvavO5z2PiM38=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
|
||||
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
|
||||
gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
|
||||
gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
|
||||
254
pool.go
254
pool.go
@ -3,25 +3,53 @@ package js
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"log"
|
||||
"reflect"
|
||||
"regexp"
|
||||
"sort"
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
"time"
|
||||
|
||||
"apigo.cc/go/jsmod"
|
||||
"apigo.cc/go/log"
|
||||
"github.com/dop251/goja"
|
||||
)
|
||||
|
||||
type scriptEntry struct {
|
||||
name string
|
||||
code string
|
||||
version int64
|
||||
}
|
||||
|
||||
type vmInstance struct {
|
||||
runtime *goja.Runtime
|
||||
version int32
|
||||
}
|
||||
|
||||
var (
|
||||
globalVersion int32
|
||||
scripts []string
|
||||
scriptsMu sync.RWMutex
|
||||
// Pool represents an isolated JS execution environment with its own script registry and VM pool.
|
||||
type Pool struct {
|
||||
version int32
|
||||
scripts []*scriptEntry
|
||||
scriptMap map[string]*scriptEntry
|
||||
functions map[string]struct{}
|
||||
mu sync.RWMutex
|
||||
pool sync.Pool
|
||||
|
||||
pool = sync.Pool{
|
||||
// Lifecycle management
|
||||
ctx context.Context
|
||||
cancel context.CancelFunc
|
||||
wg sync.WaitGroup
|
||||
closed int32
|
||||
}
|
||||
|
||||
// NewPool creates a new isolated JS execution environment.
|
||||
func NewPool() *Pool {
|
||||
p := &Pool{
|
||||
scriptMap: make(map[string]*scriptEntry),
|
||||
functions: make(map[string]struct{}),
|
||||
}
|
||||
p.ctx, p.cancel = context.WithCancel(context.Background())
|
||||
p.pool = sync.Pool{
|
||||
New: func() any {
|
||||
return &vmInstance{
|
||||
runtime: createNewRuntime(),
|
||||
@ -29,7 +57,11 @@ var (
|
||||
}
|
||||
},
|
||||
}
|
||||
)
|
||||
return p
|
||||
}
|
||||
|
||||
// DefaultPool is the global singleton pool.
|
||||
var DefaultPool = NewPool()
|
||||
|
||||
func createNewRuntime() *goja.Runtime {
|
||||
vm := goja.New()
|
||||
@ -43,79 +75,138 @@ func createNewRuntime() *goja.Runtime {
|
||||
modObj := vm.NewObject()
|
||||
for name, val := range mod.Exports {
|
||||
isUnsafe := mod.UnsafeList[name]
|
||||
if reflectType := fmt.Sprintf("%T", val); reflectType == "func" || (len(reflectType) > 4 && reflectType[:4] == "func") {
|
||||
if val != nil && reflect.TypeOf(val).Kind() == reflect.Func {
|
||||
_ = modObj.Set(name, wrapGoFunc(vm, val, isUnsafe))
|
||||
} else {
|
||||
_ = modObj.Set(name, vm.ToValue(val))
|
||||
}
|
||||
}
|
||||
_ = goObj.Set(modName, modObj)
|
||||
_ = vm.Set(modName, modObj) // Also inject into global
|
||||
}
|
||||
|
||||
return vm
|
||||
}
|
||||
|
||||
// Define adds JS code to the global registry and increments the version.
|
||||
// All VMs in the pool will eventually synchronize to this version.
|
||||
func Define(code string) {
|
||||
scriptsMu.Lock()
|
||||
defer scriptsMu.Unlock()
|
||||
var funcRegex = regexp.MustCompile(`function\s+([a-zA-Z0-9_]+)\s*\(`)
|
||||
var constFuncRegex = regexp.MustCompile(`(?:const|let|var)\s+([a-zA-Z0-9_]+)\s*=\s*(?:function|\([^)]*\)\s*=>)`)
|
||||
|
||||
scripts = append(scripts, code)
|
||||
atomic.AddInt32(&globalVersion, 1)
|
||||
// Define adds JS code to the pool's registry.
|
||||
// name and version are optional and used for CheckVersion.
|
||||
func (p *Pool) Define(code string, args ...any) {
|
||||
p.mu.Lock()
|
||||
defer p.mu.Unlock()
|
||||
|
||||
name := ""
|
||||
version := int64(0)
|
||||
if len(args) > 0 {
|
||||
if s, ok := args[0].(string); ok {
|
||||
name = s
|
||||
}
|
||||
|
||||
// CallOption allows configuring the JS execution environment.
|
||||
type CallOption func(vm *goja.Runtime)
|
||||
|
||||
// WithSafeMode enables or disables safe mode for the call.
|
||||
func WithSafeMode(enabled bool) CallOption {
|
||||
return func(vm *goja.Runtime) {
|
||||
_ = vm.Set("__safeMode__", enabled)
|
||||
}
|
||||
if len(args) > 1 {
|
||||
if v, ok := args[1].(int64); ok {
|
||||
version = v
|
||||
}
|
||||
}
|
||||
|
||||
// WithLogger injects a custom logger for the call.
|
||||
func WithLogger(logger *log.Logger) CallOption {
|
||||
return func(vm *goja.Runtime) {
|
||||
_ = vm.Set("__logger__", vm.ToValue(logger))
|
||||
entry := &scriptEntry{name: name, code: code, version: version}
|
||||
p.scripts = append(p.scripts, entry)
|
||||
if name != "" {
|
||||
p.scriptMap[name] = entry
|
||||
}
|
||||
|
||||
// Extract functions for FuncList
|
||||
matches := funcRegex.FindAllStringSubmatch(code, -1)
|
||||
for _, m := range matches {
|
||||
if len(m) > 1 {
|
||||
p.functions[m[1]] = struct{}{}
|
||||
}
|
||||
}
|
||||
matches = constFuncRegex.FindAllStringSubmatch(code, -1)
|
||||
for _, m := range matches {
|
||||
if len(m) > 1 {
|
||||
p.functions[m[1]] = struct{}{}
|
||||
}
|
||||
}
|
||||
|
||||
atomic.AddInt32(&p.version, 1)
|
||||
}
|
||||
|
||||
// CheckVersion returns true if a script with the given name exists and its version is >= the provided version.
|
||||
func (p *Pool) CheckVersion(name string, version int64) bool {
|
||||
p.mu.RLock()
|
||||
defer p.mu.RUnlock()
|
||||
if entry, ok := p.scriptMap[name]; ok {
|
||||
return entry.version >= version
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func CheckVersion(name string, version int64) bool {
|
||||
return DefaultPool.CheckVersion(name, version)
|
||||
}
|
||||
|
||||
// Call executes a JS function from the pool.
|
||||
// It automatically synchronizes the VM to the latest version.
|
||||
func Call(ctx context.Context, funcName string, args []any, opts ...CallOption) (any, error) {
|
||||
instance := pool.Get().(*vmInstance)
|
||||
defer pool.Put(instance)
|
||||
// It combines the pool's lifecycle context with the provided timeout.
|
||||
// injects are added to the context passed to Go functions.
|
||||
func (p *Pool) Call(funcName string, timeout time.Duration, injects map[string]any, args ...any) (any, error) {
|
||||
if atomic.LoadInt32(&p.closed) == 1 {
|
||||
return nil, fmt.Errorf("js.Pool: pool is closed")
|
||||
}
|
||||
|
||||
instance := p.pool.Get().(*vmInstance)
|
||||
defer p.pool.Put(instance)
|
||||
|
||||
// Tracking active calls for graceful shutdown
|
||||
p.wg.Add(1)
|
||||
defer p.wg.Done()
|
||||
|
||||
vm := instance.runtime
|
||||
vm.ClearInterrupt()
|
||||
|
||||
// 1. Synchronize scripts if version is behind
|
||||
currentGlobalVersion := atomic.LoadInt32(&globalVersion)
|
||||
if instance.version < currentGlobalVersion {
|
||||
scriptsMu.RLock()
|
||||
for i := int(instance.version); i < len(scripts); i++ {
|
||||
_, err := vm.RunString(scripts[i])
|
||||
currentVersion := atomic.LoadInt32(&p.version)
|
||||
if instance.version < currentVersion {
|
||||
p.mu.RLock()
|
||||
for i := int(instance.version); i < len(p.scripts); i++ {
|
||||
_, err := vm.RunString(p.scripts[i].code)
|
||||
if err != nil {
|
||||
scriptsMu.RUnlock()
|
||||
p.mu.RUnlock()
|
||||
return nil, fmt.Errorf("js.sync error at script %d: %w", i, err)
|
||||
}
|
||||
}
|
||||
instance.version = currentGlobalVersion
|
||||
scriptsMu.RUnlock()
|
||||
instance.version = currentVersion
|
||||
p.mu.RUnlock()
|
||||
}
|
||||
|
||||
// 2. Set Context and default state
|
||||
_ = vm.Set("__ctx__", vm.ToValue(ctx))
|
||||
_ = vm.Set("__safeMode__", true) // Default is safe
|
||||
_ = vm.Set("__logger__", goja.Undefined())
|
||||
|
||||
// Apply Options
|
||||
for _, opt := range opts {
|
||||
opt(vm)
|
||||
// 2. Prepare Context
|
||||
execCtx := jsmod.NewContext(p.ctx, injects)
|
||||
var cancel context.CancelFunc
|
||||
if timeout > 0 {
|
||||
execCtx, cancel = context.WithTimeout(execCtx, timeout)
|
||||
defer cancel()
|
||||
}
|
||||
|
||||
// 3. Get and Call JS Function
|
||||
// 3. Set VM environment
|
||||
_ = vm.Set("__ctx__", vm.ToValue(execCtx))
|
||||
|
||||
// 4. Set up interruption
|
||||
stopInterrupter := make(chan struct{})
|
||||
defer close(stopInterrupter)
|
||||
go func() {
|
||||
select {
|
||||
case <-execCtx.Done():
|
||||
reason := "execution timeout/canceled"
|
||||
if p.ctx.Err() != nil {
|
||||
reason = "application stopping"
|
||||
}
|
||||
vm.Interrupt(reason)
|
||||
case <-stopInterrupter:
|
||||
}
|
||||
}()
|
||||
|
||||
// 5. Get and Call JS Function
|
||||
fnVal := vm.Get(funcName)
|
||||
if fnVal == nil || goja.IsUndefined(fnVal) {
|
||||
return nil, fmt.Errorf("js.Call: function '%s' not found", funcName)
|
||||
@ -131,7 +222,7 @@ func Call(ctx context.Context, funcName string, args []any, opts ...CallOption)
|
||||
jsArgs[i] = vm.ToValue(arg)
|
||||
}
|
||||
|
||||
// 4. Execution with error capture
|
||||
// 6. Execution with error capture
|
||||
var result goja.Value
|
||||
var err error
|
||||
func() {
|
||||
@ -150,9 +241,64 @@ func Call(ctx context.Context, funcName string, args []any, opts ...CallOption)
|
||||
return result.Export(), nil
|
||||
}
|
||||
|
||||
// FuncList returns the list of all defined JS function names.
|
||||
func FuncList() []string {
|
||||
scriptsMu.RLock()
|
||||
defer scriptsMu.RUnlock()
|
||||
return []string{}
|
||||
// --- Global Proxy Functions ---
|
||||
|
||||
func Define(code string, args ...any) {
|
||||
DefaultPool.Define(code, args...)
|
||||
}
|
||||
|
||||
func Call(funcName string, timeout time.Duration, injects map[string]any, args ...any) (any, error) {
|
||||
return DefaultPool.Call(funcName, timeout, injects, args...)
|
||||
}
|
||||
|
||||
// --- Starter Interface Implementation ---
|
||||
|
||||
func (p *Pool) Start(ctx context.Context, logger *log.Logger) error {
|
||||
// Ensure pool context is fresh
|
||||
if p.ctx.Err() != nil {
|
||||
p.ctx, p.cancel = context.WithCancel(context.Background())
|
||||
}
|
||||
atomic.StoreInt32(&p.closed, 0)
|
||||
return nil
|
||||
}
|
||||
|
||||
func (p *Pool) Stop(ctx context.Context) error {
|
||||
atomic.StoreInt32(&p.closed, 1)
|
||||
p.cancel() // Stop all active and future calls
|
||||
|
||||
// Wait for active calls to finish
|
||||
done := make(chan struct{})
|
||||
go func() {
|
||||
p.wg.Wait()
|
||||
close(done)
|
||||
}()
|
||||
|
||||
select {
|
||||
case <-done:
|
||||
return nil
|
||||
case <-ctx.Done():
|
||||
return fmt.Errorf("js.Pool: shutdown timeout, active tasks may still be running")
|
||||
}
|
||||
}
|
||||
|
||||
func (p *Pool) Status() (string, error) {
|
||||
p.mu.RLock()
|
||||
defer p.mu.RUnlock()
|
||||
return fmt.Sprintf("scripts: %d, functions: %d, version: %d, closed: %v", len(p.scripts), len(p.functions), p.version, atomic.LoadInt32(&p.closed) == 1), nil
|
||||
}
|
||||
|
||||
// FuncList returns the list of all defined JS function names.
|
||||
func (p *Pool) FuncList() []string {
|
||||
p.mu.RLock()
|
||||
defer p.mu.RUnlock()
|
||||
list := make([]string, 0, len(p.functions))
|
||||
for name := range p.functions {
|
||||
list = append(list, name)
|
||||
}
|
||||
sort.Strings(list)
|
||||
return list
|
||||
}
|
||||
|
||||
func FuncList() []string {
|
||||
return DefaultPool.FuncList()
|
||||
}
|
||||
|
||||
82
pool_test.go
82
pool_test.go
@ -2,14 +2,26 @@ package js
|
||||
|
||||
import (
|
||||
"context"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"apigo.cc/go/cast"
|
||||
)
|
||||
|
||||
func TestPoolVersioning(t *testing.T) {
|
||||
p := NewPool()
|
||||
// 1. Define initial function
|
||||
Define(`function hello(name) { return "Hello " + name; }`)
|
||||
p.Define(`function hello(name) { return "Hello " + name; }`, "hello.js", int64(100))
|
||||
|
||||
res, err := Call(context.Background(), "hello", []any{"World"})
|
||||
if !p.CheckVersion("hello.js", 100) {
|
||||
t.Error("expected CheckVersion to be true for v100")
|
||||
}
|
||||
if p.CheckVersion("hello.js", 101) {
|
||||
t.Error("expected CheckVersion to be false for v101")
|
||||
}
|
||||
|
||||
res, err := p.Call("hello", 0, nil, "World")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
@ -18,23 +30,30 @@ func TestPoolVersioning(t *testing.T) {
|
||||
}
|
||||
|
||||
// 2. Define new function (incremental update)
|
||||
Define(`function add(a, b) { return a + b; }`)
|
||||
p.Define(`function add(a, b) { return a + b; }`)
|
||||
|
||||
res, err = Call(context.Background(), "add", []any{1, 2})
|
||||
res, err = p.Call("add", 0, nil, 1, 2)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if res.(int64) != 3 {
|
||||
if cast.To[int64](res) != 3 {
|
||||
t.Errorf("expected 3, got %v", res)
|
||||
}
|
||||
|
||||
// 3. Ensure old function still works
|
||||
res, err = Call(context.Background(), "hello", []any{"Again"})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
// 3. Check FuncList
|
||||
funcs := p.FuncList()
|
||||
foundHello := false
|
||||
foundAdd := false
|
||||
for _, f := range funcs {
|
||||
if f == "hello" {
|
||||
foundHello = true
|
||||
}
|
||||
if res != "Hello Again" {
|
||||
t.Errorf("expected 'Hello Again', got %v", res)
|
||||
if f == "add" {
|
||||
foundAdd = true
|
||||
}
|
||||
}
|
||||
if !foundHello || !foundAdd {
|
||||
t.Errorf("FuncList missing functions: %v", funcs)
|
||||
}
|
||||
}
|
||||
|
||||
@ -49,8 +68,47 @@ func TestPoolConcurrent(t *testing.T) {
|
||||
t.Parallel()
|
||||
for i := 0; i < 10; i++ {
|
||||
go func() {
|
||||
_, _ = Call(context.Background(), "heavy", []any{1000})
|
||||
_, _ = Call("heavy", 0, nil, 1000)
|
||||
}()
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestPoolGracefulShutdown(t *testing.T) {
|
||||
p := NewPool()
|
||||
p.Define(`function sleep(ms) {
|
||||
let start = Date.now();
|
||||
while(Date.now() - start < ms);
|
||||
return "done";
|
||||
}`)
|
||||
|
||||
// 1. Test Timeout
|
||||
_, err := p.Call("sleep", 100*time.Millisecond, nil, 1000)
|
||||
if err == nil || !strings.Contains(err.Error(), "execution timeout/canceled") {
|
||||
t.Errorf("expected timeout error, got %v", err)
|
||||
}
|
||||
|
||||
// 2. Test Graceful Stop
|
||||
go func() {
|
||||
time.Sleep(100 * time.Millisecond)
|
||||
p.Stop(context.Background())
|
||||
}()
|
||||
|
||||
_, err = p.Call("sleep", 10*time.Second, nil, 5000)
|
||||
if err == nil || !strings.Contains(err.Error(), "application stopping") {
|
||||
t.Errorf("expected app stopping error, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGlobalInjection(t *testing.T) {
|
||||
p := NewPool()
|
||||
// Test if 'cast' module is available globally without 'go.' prefix
|
||||
p.Define(`function testGlobal() { return cast.ToJSON({a:1}); }`)
|
||||
res, err := p.Call("testGlobal", 0, nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if res != `{"a":1}` {
|
||||
t.Errorf("expected '{\"a\":1}', got %v", res)
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user