Add CI

Author: raphael

.env

@@ -1 +1,2 @@
-export REDIS_PASSWORD=redispassword
+export REDIS_PASSWORD=redispassword
+export TIMEOUT=1s

.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: Run Static Checks and Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  ci:
+    strategy:
+      fail-fast: true
+      matrix:
+        go: ['1.22']
+        os: ['ubuntu-latest', 'windows-latest']
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up Go ${{ matrix.go }}
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go }}
+        id: go
+
+      - name: Build
+        run: scripts/cibuild

.github/workflows/codeql.yml

@@ -0,0 +1,62 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'go' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version-file: 'go.mod'
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    #- name: Autobuild
+    #  uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/dependency-review.yml

@@ -0,0 +1,20 @@
+# Dependency Review Action
+#
+# This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
+#
+# Source repository: https://github.com/actions/dependency-review-action
+# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v4
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v4

examples/pool/scheduler/main.go

@@ -28,7 +28,10 @@ func main() {
 	}
 
 	// Create node for pool "example".
-	node, err := pool.AddNode(ctx, "example", rdb, pool.WithLogger(logger))
+	node, err := pool.AddNode(ctx, "example", rdb,
+		pool.WithJobSinkBlockDuration(100*time.Millisecond), // Shutdown faster
+		pool.WithLogger(logger),
+	)
 	if err != nil {
 		panic(err)
 	}

examples/pool/worker/main.go

@@ -51,7 +51,10 @@ func main() {
 	}
 
 	// Create node for pool "example".
-	node, err := pool.AddNode(ctx, "example", rdb, pool.WithLogger(logger))
+	node, err := pool.AddNode(ctx, "example", rdb,
+		pool.WithJobSinkBlockDuration(100*time.Millisecond), // Shutdown faster
+		pool.WithLogger(logger),
+	)
 	if err != nil {
 		panic(err)
 	}
@@ -62,15 +65,31 @@ func main() {
 		panic(err)
 	}
 
-	// Wait for jobs to complete.
-	log.Infof(ctx, "Waiting for jobs... CTRL+C to stop.")
+	// Check if a timeout is set
+	var timeout time.Duration
+	if t := os.Getenv("TIMEOUT"); t != "" {
+		timeout, err = time.ParseDuration(t)
+		if err != nil {
+			panic(err)
+		}
+	} else {
+		timeout = 10 * time.Minute
+	}
+	log.Infof(ctx, "timeout set to %s", timeout)
 
-	// Close done channel on CTRL-C.
+	// Wait for CTRL-C or timeout.
+	log.Infof(ctx, "Waiting for jobs... CTRL+C to stop.")
 	sigc := make(chan os.Signal, 1)
+	defer close(sigc)
 	signal.Notify(sigc, os.Interrupt)
-	<-sigc
-	close(sigc)
+	select {
+	case <-sigc:
+		log.Infof(ctx, "interrupted")
+	case <-time.After(timeout):
+		log.Infof(ctx, "timeout")
+	}
 
+	// Shutdown node.
 	if err := node.Shutdown(ctx); err != nil {
 		panic(err)
 	}

examples/streaming/multi-readers/main.go

@@ -28,7 +28,11 @@ func main() {
 	}
 
 	// Don't forget to destroy the stream when done
-	defer stream.Destroy(ctx)
+	defer func() {
+		if err := stream.Destroy(ctx); err != nil {
+			panic(err)
+		}
+	}()
 
 	// Write 2 events to the stream
 	id1, err := stream.Add(ctx, "event 1", []byte("payload 1"))

scripts/run-examples

@@ -1,17 +1,31 @@
 #!/bin/bash
 
+# Find the Git root directory
+git_root=$(git rev-parse --show-toplevel 2>/dev/null)
+
+if [ -z "$git_root" ]; then
+  echo "Error: Not in a Git repository" >&2
+  exit 1
+fi
+
+# Load environment variables from .env file in the Git root
+if [ -f "$git_root/.env" ]; then
+  export $(grep -v '^#' "$git_root/.env" | xargs)
+fi
+
+# Update file paths to use absolute paths from Git root
 files=(
-  "examples/pool/worker/main.go"
-  "examples/pool/producer/main.go"
-  "examples/rmap/basics/main.go"
-  "examples/rmap/multi-nodes/main.go"
-  "examples/rmap/multi-nodes/main.go"
-  "examples/streaming/single-reader/main.go"
-  "examples/streaming/single-sink/main.go"
-  "examples/streaming/multi-readers/main.go"
-  "examples/streaming/multi-sinks/main.go"
-  "examples/streaming/multi-streams/main.go"
-  "examples/streaming/pub-sub/main.go"
+  "$git_root/examples/pool/worker/main.go"
+  "$git_root/examples/pool/producer/main.go"
+  "$git_root/examples/rmap/basics/main.go"
+  "$git_root/examples/rmap/multi-nodes/main.go"
+  "$git_root/examples/rmap/multi-nodes/main.go"
+  "$git_root/examples/streaming/single-reader/main.go"
+  "$git_root/examples/streaming/single-sink/main.go"
+  "$git_root/examples/streaming/multi-readers/main.go"
+  "$git_root/examples/streaming/multi-sinks/main.go"
+  "$git_root/examples/streaming/multi-streams/main.go"
+  "$git_root/examples/streaming/pub-sub/main.go"
 )
 
 args=(
@@ -30,7 +44,7 @@ run_example() {
   shift
   local args=("$@")
   echo "Running: $file ${args[*]}"
-  output=$(timeout "$timeout_sec" go run -v "$file" "${args[@]}" 2>&1)
+  output=$(cd "$git_root" && timeout "$timeout_sec" go run -v "$file" "${args[@]}" 2>&1)
   local exit_status=$?
   if [[ $exit_status -ne 0 ]]; then
     echo "Example '${file}' exited with an error or exceeded the timeout:"
@@ -55,4 +69,4 @@ for pid in "${pids[@]}"; do
   fi
 done
 
-exit "$status"
+exit "$status"