refactor: Swap ports of runner and launcher (#25)

n8n-io · Nov 27, 2024 · a763510 · a763510
1 parent 1429429
commit a763510
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ CLI utility to launch [n8n task runners](https://docs.n8n.io/PENDING).
 
 ### Install
 
-- Install Node.js >=18.17 
+- Install Node.js >=18.17
 - Install n8n >= PENDING_VERSION
 - Download launcher binary from [releases page](https://github.com/n8n-io/task-runner-launcher/releases)
 
@@ -39,9 +39,7 @@ Sample config file:
       "runner-type": "javascript",
       "workdir": "/usr/local/bin",
       "command": "/usr/local/bin/node",
-      "args": [
-        "/usr/local/lib/node_modules/n8n/node_modules/@n8n/task-runner/dist/start.js"
-      ],
+      "args": ["/usr/local/lib/node_modules/n8n/node_modules/@n8n/task-runner/dist/start.js"],
       "allowed-env": [
         "PATH",
         "N8N_RUNNERS_GRANT_TOKEN",
@@ -75,15 +73,15 @@ To control the launcher's log level, set the `N8N_LAUNCHER_LOG_LEVEL` env var to
 
 ### Idle timeout
 
-If idle for 15 seconds, the runner will exit. To override this duration, set the `N8N_RUNNERS_AUTO_SHUTDOWN_TIMEOUT` to a number of seconds, or `0` to disable it. After runner exit on idle timeout, the launcher will re-launch the runner on demand, i.e. when the next task comes in.   
+If idle for 15 seconds, the runner will exit. To override this duration, set the `N8N_RUNNERS_AUTO_SHUTDOWN_TIMEOUT` to a number of seconds, or `0` to disable it. After runner exit on idle timeout, the launcher will re-launch the runner on demand, i.e. when the next task comes in.
 
 ## Usage
 
 Once setup is complete, start the launcher:
 
 ```sh
 export N8N_RUNNERS_AUTH_TOKEN=...
-export N8N_RUNNERS_N8N_URI=... 
+export N8N_RUNNERS_N8N_URI=...
 ./task-runner-launcher javascript
 ```
 
@@ -106,7 +104,7 @@ sudo mv config.json /etc/n8n-task-runners.json
 
 ```sh
 export N8N_RUNNERS_ENABLED=true
-export N8N_RUNNERS_MODE=external 
+export N8N_RUNNERS_MODE=external
 export N8N_RUNNERS_LAUNCHER_PATH=...  # i.e. path/to/launcher/binary
 export N8N_RUNNERS_AUTH_TOKEN=...     # i.e. random string
 pnpm start
@@ -123,9 +121,9 @@ make run
 
 ## Health check
 
-The launcher exposes a health check endpoint at `/healthz` on port `5681` for liveness checks. 
+The launcher exposes a health check endpoint at `/healthz` on port `5680` for liveness checks.
 
-To override the launcher health check port, set the `N8N_LAUNCHER_HEALTCHECK_PORT` env var. When overriding the default health check port, be mindful of port conflicts - the n8n main instance uses `5678` by default for its HTTP server and `5679` for its task runner server, and the runner uses `5680` by default for its healthcheck server.
+To override the launcher health check port, set the `N8N_LAUNCHER_HEALTCHECK_PORT` env var. When overriding the default health check port, be mindful of port conflicts - the n8n main instance uses `5678` by default for its HTTP server and `5679` for its task runner server, and the runner uses `5681` by default for its healthcheck server.
 
 ## Release
 
@@ -138,5 +136,5 @@ git push origin v1.2.0
 
 2. Publish a [GitHub release](https://github.com/n8n-io/task-runner-launcher/releases/new) with the tag. The [`release` workflow](./.github/workflows/release.yml) will build binaries for arm64 and amd64 and upload them to the release in the [releases page](https://github.com/n8n-io/task-runner-launcher/releases).
 
-> [!IMPORTANT]  
-> Mark the GitHub release as `latest` and NOT as `pre-release` or the `release` workflow will not run.
+> [!IMPORTANT]
+> Mark the GitHub release as `latest` and NOT as `pre-release` or the `release` workflow will not run.
diff --git a/internal/env/env.go b/internal/env/env.go
@@ -41,7 +41,7 @@ const (
 	// ------------------------
 
 	// EnvVarRunnerServerURI is the env var for the URI of the runner's server.
-	// Used for monitoring the runner's health, typically at http://127.0.0.1:5680.
+	// Used for monitoring the runner's health, typically at http://127.0.0.1:5681.
 	EnvVarRunnerServerURI = "N8N_RUNNER_URI"
 
 	// EnvVarRunnerServerEnabled is the env var for whether the runner's health
@@ -57,7 +57,7 @@ const (
 	defaultIdleTimeoutValue    = "15" // seconds
 	DefaultMainServerURI       = "http://127.0.0.1:5678"
 	DefaultTaskBrokerServerURI = "http://127.0.0.1:5679"
-	DefaultRunnerServerURI     = "http://127.0.0.1:5680"
+	DefaultRunnerServerURI     = "http://127.0.0.1:5681"
 )
 
 // AllowedOnly filters the current environment down to only those

diff --git a/internal/env/env_test.go b/internal/env/env_test.go
@@ -171,7 +171,7 @@ func TestFromEnv(t *testing.T) {
 			envVars: map[string]string{
 				EnvVarMainServerURI:       "http://localhost:5678",
 				EnvVarTaskBrokerServerURI: "http://localhost:5679",
-				EnvVarRunnerServerURI:     "http://localhost:5680",
+				EnvVarRunnerServerURI:     "http://localhost:5681",
 			},
 			expectError: true,
 		},
@@ -181,7 +181,7 @@ func TestFromEnv(t *testing.T) {
 				EnvVarAuthToken:           "token123",
 				EnvVarMainServerURI:       "http://\\invalid:5678",
 				EnvVarTaskBrokerServerURI: "http://localhost:5679",
-				EnvVarRunnerServerURI:     "http://localhost:5680",
+				EnvVarRunnerServerURI:     "http://localhost:5681",
 			},
 			expectError: true,
 		},
@@ -190,13 +190,13 @@ func TestFromEnv(t *testing.T) {
 			envVars: map[string]string{
 				EnvVarAuthToken:           "token123",
 				EnvVarTaskBrokerServerURI: "http://localhost:5679",
-				EnvVarRunnerServerURI:     "http://localhost:5680",
+				EnvVarRunnerServerURI:     "http://localhost:5681",
 			},
 			expected: &EnvConfig{
 				AuthToken:           "token123",
 				MainServerURI:       DefaultMainServerURI,
 				TaskBrokerServerURI: "http://localhost:5679",
-				RunnerServerURI:     "http://localhost:5680",
+				RunnerServerURI:     "http://localhost:5681",
 			},
 		},
 		{
@@ -205,7 +205,7 @@ func TestFromEnv(t *testing.T) {
 				EnvVarAuthToken:           "token123",
 				EnvVarMainServerURI:       "http://localhost:5678",
 				EnvVarTaskBrokerServerURI: "http://\\invalid:5679",
-				EnvVarRunnerServerURI:     "http://localhost:5680",
+				EnvVarRunnerServerURI:     "http://localhost:5681",
 			},
 			expectError: true,
 		},
@@ -214,13 +214,13 @@ func TestFromEnv(t *testing.T) {
 			envVars: map[string]string{
 				EnvVarAuthToken:       "token123",
 				EnvVarMainServerURI:   "http://localhost:5678",
-				EnvVarRunnerServerURI: "http://localhost:5680",
+				EnvVarRunnerServerURI: "http://localhost:5681",
 			},
 			expected: &EnvConfig{
 				AuthToken:           "token123",
 				MainServerURI:       "http://localhost:5678",
 				TaskBrokerServerURI: DefaultTaskBrokerServerURI,
-				RunnerServerURI:     "http://localhost:5680",
+				RunnerServerURI:     "http://localhost:5681",
 			},
 		},
 		{
@@ -229,7 +229,7 @@ func TestFromEnv(t *testing.T) {
 				EnvVarAuthToken:           "token123",
 				EnvVarMainServerURI:       "http://localhost:5678",
 				EnvVarTaskBrokerServerURI: "http://localhost:5679",
-				EnvVarRunnerServerURI:     "http://\\invalid:5680",
+				EnvVarRunnerServerURI:     "http://\\invalid:5681",
 			},
 			expectError: true,
 		},
@@ -253,7 +253,7 @@ func TestFromEnv(t *testing.T) {
 				EnvVarAuthToken:           "token123",
 				EnvVarMainServerURI:       "127.0.0.1:5678",
 				EnvVarTaskBrokerServerURI: "http://localhost:5679",
-				EnvVarRunnerServerURI:     "http://localhost:5680",
+				EnvVarRunnerServerURI:     "http://localhost:5681",
 			},
 			expectError: true,
 		},
@@ -263,7 +263,7 @@ func TestFromEnv(t *testing.T) {
 				EnvVarAuthToken:           "token123",
 				EnvVarMainServerURI:       "localhost:5678",
 				EnvVarTaskBrokerServerURI: "http://localhost:5679",
-				EnvVarRunnerServerURI:     "http://localhost:5680",
+				EnvVarRunnerServerURI:     "http://localhost:5681",
 			},
 			expectError: true,
 		},
@@ -273,7 +273,7 @@ func TestFromEnv(t *testing.T) {
 				EnvVarAuthToken:           "token123",
 				EnvVarMainServerURI:       "http://localhost:5678",
 				EnvVarTaskBrokerServerURI: "http://localhost:5679",
-				EnvVarRunnerServerURI:     "http://localhost:5680",
+				EnvVarRunnerServerURI:     "http://localhost:5681",
 				EnvVarIdleTimeout:         "invalid",
 			},
 			expectError: true,
@@ -284,7 +284,7 @@ func TestFromEnv(t *testing.T) {
 				EnvVarAuthToken:           "token123",
 				EnvVarMainServerURI:       "http://localhost:5678",
 				EnvVarTaskBrokerServerURI: "http://localhost:5679",
-				EnvVarRunnerServerURI:     "http://localhost:5680",
+				EnvVarRunnerServerURI:     "http://localhost:5681",
 				EnvVarIdleTimeout:         "-1",
 			},
 			expectError: true,

diff --git a/internal/http/healthcheck_server.go b/internal/http/healthcheck_server.go
@@ -11,7 +11,7 @@ import (
 )
 
 const (
-	defaultPort     = 5681
+	defaultPort     = 5680
 	portEnvVar      = "N8N_LAUNCHER_HEALTCHECK_PORT"
 	healthCheckPath = "/healthz"
 	readTimeout     = 1 * time.Second