Skip to content

determinism-protection.md

Latest commit

 

History

History
70 lines (60 loc) · 4.73 KB

determinism-protection.md

File metadata and controls

70 lines (60 loc) · 4.73 KB

determinism-protection.md

Section Inventory

Section Core Python Py# TypeScript TS# Ruby Rb# Go Go#
Overview — ✓ 1 ✓ 1 TODO 1 ✓ 1
How the Sandbox Works — ✓ 2 — — — — — —
How Illegal Call Tracing Works — — — — — TODO 2 — —
Import Blocking — — — ✓ 2 — — — —
Forbidden Operations — ✓ 3 — — TODO 3 — —
Function Replacement — — — ✓ 3 — — — —
Durable Fiber Scheduler — — — — — TODO 4 — —
workflowcheck Static Analysis — — — — — — — ✓ 2
Determinism Rules — — — — — — — ✓ 3
Pass-Through Pattern — ✓ 4 — — — — — —
Importing Activities — ✓ 5 — — — — — —
Disabling the Sandbox — ✓ 6 — — — — — —
Disabling Illegal Call Tracing — — — — — TODO 5 — —
Customizing Invalid Module Members — ✓ 7 — — — — — —
Customizing Illegal Calls — — — — — TODO 6 — —
Import Notification Policy — ✓ 8 — — — — — —
Disable Lazy sys.modules Passthrough — ✓ 9 — — — — — —
File Organization — ✓ 10 — — — — — —
Common Issues — ✓ 11 — — TODO 7 — —
Best Practices — ✓ 12 — — TODO 8 ✓ 4

Style Compliance

Language Status Notes
Python ✓ reference Comprehensive (12 sections)
TypeScript ✓ aligned Minimal (3 sections) — V8 is automatic
Ruby — Not started
Go ✓ aligned Minimal (4 sections) — no runtime sandbox, convention + static analysis

Status

Ruby notes:

  • Ruby's approach is fundamentally different from Python (sandbox) and TS (V8): uses TracePoint for illegal call tracing + custom Fiber::Scheduler for durable fibers
  • "How Illegal Call Tracing Works": TracePoint catches illegal calls on workflow thread, configurable via illegal_workflow_calls worker param
  • "Durable Fiber Scheduler": Custom Fiber::Scheduler makes fibers deterministic; Kernel.sleep, Mutex etc. are disabled by default
  • "Disabling Illegal Call Tracing": Temporalio::Workflow::Unsafe.illegal_call_tracing_disabled block
  • "Customizing Illegal Calls": illegal_workflow_calls parameter on worker, Temporalio::Worker.default_illegal_workflow_calls
  • durable_scheduler_disabled (implies illegal_call_tracing_disabled), io_enabled for IO wait
  • Python's Import/Module sections don't apply (Ruby doesn't have module-level sandbox)
  • Ruby estimated ~8 sections (moderate — more than TS's 3, less than Python's 12)

Go-specific notes:

  • Go has NO runtime sandbox (unlike Python's import-restricting sandbox or TS's V8 isolate)
  • Determinism enforcement is purely by developer convention + optional static analysis
  • workflowcheck tool: go.temporal.io/sdk/contrib/tools/workflowcheck — detects non-deterministic function calls, channel ops, goroutines, map range
  • The tool flags: time.Now, time.Sleep, math/rand.globalRand, crypto/rand.Reader, os.Stdin/Stdout/Stderr, native goroutines, channel send/receive/range, map range iteration
  • Determinism Rules section: covers what developers must avoid (unique to Go since no sandbox catches these)
  • Overview: brief explanation that Go relies on convention rather than sandboxing
  • Best Practices: use workflowcheck in CI, follow workflow.* API conventions

Intentionally missing (—):

  • Core column: no core file (sandbox implementation is language-specific)
  • Most Python sections (sandbox internals, import blocking, pass-through, customization): Not applicable to Go (no sandbox)
  • TS sections (Import Blocking, Function Replacement): Not applicable to Go (no V8 isolate)
  • Go doesn't need sandbox customization sections because there's no sandbox to customize

Order alignment: N/A — files have completely different structures per language

Style alignment: ⚠️ Very different structures (intentional, different protection mechanisms)

  • Python: Comprehensive (12 sections) — complex sandbox with many customization options
  • TypeScript: Minimal (3 sections) — V8 sandbox is mostly automatic
  • Ruby: Moderate (~8 sections) — TracePoint + Fiber Scheduler with customization options
  • Go: Minimal (4 sections) — no sandbox, convention-based with static analysis tool