Merge pull request #3 from phuongdnguyen/js-example

Add adapter & example for js/ts

Author: phuongdnguyen

.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 .idea/
 __debug_bin**
 **/__tdlv_debug_bin*
@@ -213,4 +214,13 @@ marimo/_lsp/
 __marimo__/
 
 # Streamlit
-.streamlit/secrets.toml
+.streamlit/secrets.toml
+
+
+#Nodejs
+
+node_modules
+build
+npm-debug.log
+.env
+js-debug

Makefile

@@ -1,5 +1,5 @@
 go-simple:
-	cd custom-debugger && go clean && go build -o ../tdlv.build && cd ../example/go//simple-workflow && ../../tdlv.build --lang=go
+	cd custom-debugger && go clean && go build -o ../tdlv.build && cd ../example/go/simple-workflow && ../../../tdlv.build --lang=go
 
 go-structured-ide-integrated:
 	cd custom-debugger && go clean && go build -o ../tdlv.build && cd ../example/go/structured-workflow/replay-debug-ide-integrated && ../../../../tdlv.build --lang=go
@@ -10,6 +10,10 @@ go-structured-standalone:
 python:
 	cd custom-debugger && go clean && go build -o ../tdlv.build && cd .. && ./tdlv.build --lang=python
 
+# Node.js/TypeScript replayer
+js:
+	cd custom-debugger && go clean && go build -o ../tdlv.build && cd ../example/js && ../../tdlv.build --lang=js
+
 build:
 	cd custom-debugger && go clean && go build -o ../tdlv.build
 

custom-debugger/main.go

@@ -34,6 +34,8 @@ func main() {
 		fmt.Fprintf(flag.CommandLine.Output(), "Usage: %s [options]\n\n", os.Args[0])
 		flag.PrintDefaults()
 	}
+	var install bool
+	flag.BoolVar(&install, "install", false, "install required language debugger if missing")
 
 	flag.Parse()
 
@@ -46,11 +48,13 @@ func main() {
 	debuggerStopCh := make(chan struct{}, 1)
 	switch lang {
 	case "go":
-		startDelve(debuggerStopCh)
+		startDelve(debuggerStopCh, install)
 	case "python":
-		startDebugPy(debuggerStopCh)
+		startDebugPy(debuggerStopCh, install)
+	case "js":
+		startJsDebug(debuggerStopCh, install)
 	default:
-		log.Fatalf("Unsupported lang: %s", lang)
+		log.Printf("Running with lang %s, expect a language debugger to be started on port 2345", lang)
 	}
 
 	addr := fmt.Sprintf(":%d", proxyPort)
@@ -91,7 +95,10 @@ func main() {
 	}
 }
 
-func startDelve(stopCh <-chan struct{}) {
+func startDelve(stopCh <-chan struct{}, install bool) {
+	if install {
+		// Install delve
+	}
 	// Listen on TCP port for Delve server
 	l, err := net.Listen("tcp", ":2345")
 	if err != nil {
@@ -154,30 +161,52 @@ func startDelve(stopCh <-chan struct{}) {
 	}()
 }
 
-func startDebugPy(debuggerStopCh <-chan struct{}) {
+func startDebugPy(stopCh <-chan struct{}, install bool) {
+	if install {
+		// Install debugpy
+	}
 	ctx := context.Background()
 	cmd := exec.CommandContext(ctx, "python", "-m", "debugpy", "--listen", "2345", "--wait-for-client", "standalone_replay.py")
 	cmd.Dir = "example/python" // Set working directory to the Python example
 	cmd.Stdout = os.Stdout
 	cmd.Stderr = os.Stderr
 	go func() {
-
 		log.Println("Starting Python debugpy server on :2345")
 		if err := cmd.Run(); err != nil {
 			log.Printf("Error running Python debugpy: %v", err)
 		}
 	}()
 	go func() {
-		select {
-		case <-debuggerStopCh:
-			if err := cmd.Process.Kill(); err != nil {
-				log.Printf("Error killing Python debugpy: %v", err)
-			}
-			log.Println("Python debugger stopped")
+		<-stopCh
+		if err := cmd.Process.Kill(); err != nil {
+			log.Printf("Error killing Python debugpy: %v", err)
 		}
+		log.Println("Python debugger stopped")
 	}()
 }
 
+func startJsDebug(stopCh <-chan struct{}, install bool) {
+	if install {
+		// Install js-debug
+	}
+	ctx := context.Background()
+	cmd := exec.CommandContext(ctx, "node", "dapDebugServer.js", "2345", "127.0.0.1")
+	go func() {
+		log.Println("Starting JS debug on :2345")
+		if err := cmd.Run(); err != nil {
+			log.Printf("Error running JS Debug: %v", err)
+		}
+	}()
+	go func() {
+		<-stopCh
+		if err := cmd.Process.Kill(); err != nil {
+			log.Printf("Error killing JS debug: %v", err)
+		}
+		log.Println("JS debug stopped")
+	}()
+
+}
+
 func init() {
 	log.SetOutput(os.Stdout)
 }

custom-debugger/pkg/dap-interceptors/response_interceptor.go

@@ -241,5 +241,4 @@ func (rir *ResponseInterceptingReader) handleStoppedEvent(event *dap.StoppedEven
 	}
 
 	return extractors.BuildDAPMessages(jsonObj, remaining)
-	return extractors.BuildDAPMessages(jsonObj, remaining)
 }

custom-debugger/pkg/locators/locators.go

@@ -34,7 +34,9 @@ func IsInAdapterCodeByPath(filePath string) bool {
 		strings.Contains(filePath, "/runtime/") ||
 		strings.Contains(filePath, "/reflect/") ||
 		strings.Contains(filePath, "replayer-adapter-python/") ||
-		strings.Contains(filePath, "replayer.py")
+		strings.Contains(filePath, "replayer.py") ||
+		strings.Contains(filePath, "replayer-adapter-nodejs/") ||
+		strings.Contains(filePath, "replayer.ts")
 }
 
 // Pwd returns the current working directory
@@ -81,6 +83,7 @@ func IsUserCodeFile(filePath, workingDir string) bool {
 	if strings.Contains(filePath, "replayer-adapter/") ||
 		strings.Contains(filePath, "custom-debugger/") ||
 		strings.Contains(filePath, "replayer-adapter-python/") ||
+		strings.Contains(filePath, "replayer-adapter-nodejs/") ||
 		strings.Contains(filePath, "vendor/") ||
 		strings.Contains(filePath, ".git/") {
 		return false

example/js/.vscode/launch.json

@@ -0,0 +1,22 @@
+{
+  "version": "0.2.0", // VS Code launch configuration schema version
+  "configurations": [
+    {
+      "name": "Debug with ts-node",
+      "type": "pwa-node",
+      "request": "launch",
+      "program": "${workspaceFolder}/main.ts",
+      "runtimeExecutable": "npx",
+      "runtimeArgs": ["ts-node"],
+      "console": "integratedTerminal",
+      "args": ["replay"],
+      "outputCapture": "console",
+      "stopOnEntry": false,
+      "trace": true,
+      "timeout": 5000,
+      "env": {
+        "TS_NODE_PROJECT": "${workspaceFolder}/tsconfig.json"
+      }
+    }
+  ]
+}

example/js/README.md

@@ -0,0 +1,173 @@
+# Temporal TypeScript Example
+
+This example demonstrates a complete Temporal workflow setup including:
+- **Workflow Definition**: A multi-step workflow with activities, signals, and queries
+- **Worker**: A worker that executes workflows and activities  
+- **Workflow Starter**: A client that starts and interacts with workflows
+- **Replayer**: Functionality to replay workflow history for testing and debugging
+
+## Prerequisites
+
+1. **Temporal Server**: Make sure you have Temporal server running locally
+   ```bash
+   # Using Temporal CLI (recommended)
+   temporal server start-dev
+   
+   # Or using Docker
+   git clone https://github.com/temporalio/docker-compose.git
+   cd docker-compose
+   docker-compose up
+   ```
+
+2. **Node.js**: Version 16 or higher
+
+## Setup
+
+1. Install dependencies:
+   ```bash
+   npm install
+   ```
+
+2. Build the TypeScript code:
+   ```bash
+   npm run build
+   ```
+
+## Usage
+
+### 1. Start the Worker
+
+In one terminal, start the worker to listen for workflow tasks:
+
+```bash
+npm run worker
+```
+
+You should see:
+```
+Starting worker...
+Worker started. Listening for workflows...
+```
+
+### 2. Start a Workflow
+
+In another terminal, start a workflow:
+
+```bash
+npm run start
+```
+
+This will:
+- Start a new workflow with a unique ID
+- Send signals to update the workflow state
+- Query the workflow status
+- Wait for the workflow to complete
+- Display the final result
+
+Expected output:
+```
+Starting workflow...
+Started workflow with ID: example-workflow-1234567890
+Sending signal to update name...
+Current status: name updated to Updated Developer
+Sending completion signal...
+Workflow result: Workflow completed successfully! Greeting: Hello, Updated Developer!, Result: 42, Data: Processed: SAMPLE WORKFLOW DATA
+```
+
+### 3. Replay a Workflow
+
+To replay a completed workflow for testing/debugging:
+
+```bash
+npm run replay <workflow-id>
+```
+
+For example:
+```bash
+npm run replay example-workflow-1234567890
+```
+
+## Workflow Features
+
+### Activities
+- **greetActivity**: Simple greeting with a name
+- **calculateActivity**: Performs a calculation with retry logic
+- **processDataActivity**: Processes and transforms data
+
+### Signals
+- **updateNameSignal**: Updates the name used in the workflow
+- **completeWorkflowSignal**: Triggers workflow completion
+
+### Queries
+- **getCurrentStatusQuery**: Returns the current workflow status
+
+### Workflow Flow
+1. **Greeting**: Calls the greet activity with the initial name
+2. **Calculation**: Performs a mathematical operation
+3. **Data Processing**: Transforms input data
+4. **Wait for Completion**: Waits for a signal or timeout (30 seconds)
+5. **Return Result**: Combines all results into a final message
+
+## Advanced Usage
+
+### Direct TypeScript Execution
+
+You can also run the commands directly with ts-node:
+
+```bash
+# Start worker
+npx ts-node main.ts worker
+
+# Start workflow  
+npx ts-node main.ts start
+
+# Replay workflow
+npx ts-node main.ts replay <workflow-id>
+```
+
+### Customizing the Example
+
+The workflow accepts input parameters that you can modify in the `startWorkflow()` function:
+
+```typescript
+const workflowInput: WorkflowInput = {
+  initialName: 'Your Name Here',
+  numbers: { a: 5, b: 10 },
+  data: 'your custom data',
+};
+```
+
+### Integration with Replayer Adapter
+
+This example is designed to work with the `replayer-adapter-nodejs` package for enhanced replay capabilities. You can integrate it by:
+
+1. Installing the replayer adapter:
+   ```bash
+   npm install ../../../replayer-adapter-nodejs
+   ```
+
+2. Using the replayer adapter in your workflow code for advanced debugging features.
+
+## Project Structure
+
+```
+example/js/
+├── main.ts           # Complete workflow example
+├── package.json      # Dependencies and scripts
+├── tsconfig.json     # TypeScript configuration
+├── README.md         # This file
+└── dist/            # Compiled JavaScript (after build)
+```
+
+## Troubleshooting
+
+1. **Connection Errors**: Make sure Temporal server is running on `localhost:7233`
+2. **Build Errors**: Ensure you have TypeScript installed and run `npm run build`
+3. **Worker Not Receiving Tasks**: Check that both worker and client use the same task queue name
+4. **Signal/Query Errors**: Ensure the workflow is running before sending signals or queries
+
+## Next Steps
+
+- Explore the [Temporal TypeScript SDK documentation](https://docs.temporal.io/typescript)
+- Check out more [Temporal samples](https://github.com/temporalio/samples-typescript)
+- Learn about [Temporal best practices](https://docs.temporal.io/typescript/best-practices) 

example/js/activities.ts

@@ -0,0 +1,19 @@
+// ====================
+// ACTIVITY DEFINITIONS
+// ====================
+
+export async function greetActivity(name: string): Promise<string> {
+  return `Hello, ${name}!`;
+}
+
+export async function calculateActivity(a: number, b: number): Promise<number> {
+  console.log(`Calculating ${a} + ${b}`);
+  await new Promise(resolve => setTimeout(resolve, 1000)); // Simulate work
+  return a + b;
+}
+
+export async function processDataActivity(data: string): Promise<string> {
+  console.log(`Processing data: ${data}`);
+  await new Promise(resolve => setTimeout(resolve, 2000)); // Simulate work
+  return `Processed: ${data.toUpperCase()}`;
+}