chore(api-status): add check for actor isolates

rivet-gg · Dec 17, 2024 · 3e224b1 · 3e224b1
1 parent cebd970
commit 3e224b1
Show file tree

Hide file tree

Showing 23 changed files with 969 additions and 185 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/docker/dev-full/rivet-server/config.yaml b/docker/dev-full/rivet-server/config.yaml
@@ -16,6 +16,12 @@ server:
       max_ingress_port_tcp: 7599
       min_ingress_port_udp: 7500
       max_ingress_port_udp: 7599
+
+    # Enable status checks if testing status check project
+    status:
+      token: local
+      system_test_isolate_project: default
+      system_test_isolate_environment: default
   cockroachdb:
     url: postgresql://cockroachdb:26257/defaultdb?sslmode=disable
     username: root

diff --git a/docker/dev-full/server.Dockerfile b/docker/dev-full/server.Dockerfile
@@ -38,5 +38,5 @@ RUN \
 	--mount=type=cache,target=/usr/local/cargo/registry,id=dev-full-server-cargo-registry \
 	--mount=type=cache,target=/app/target,id=dev-full-server-target \
 	RUSTFLAGS="--cfg tokio_unstable" cargo build --bin rivet-server && \
-	mv target/debug/rivet-server /usr/bin/rivet-server && \
+	cp target/debug/rivet-server /usr/bin/rivet-server && \
 	mkdir /etc/rivet-server
diff --git a/docs/src/content/docs/self-hosting/server-spec.json b/docs/src/content/docs/self-hosting/server-spec.json
@@ -134,7 +134,8 @@
       "default": {
         "api_edge": {
           "host": null,
-          "port": null
+          "port": null,
+          "traefik_provider_token": null
         },
         "api_public": {
           "host": null,
@@ -176,14 +177,11 @@
           "port": null
         },
         "provision": null,
+        "status": null,
         "telemetry": {
           "enable": true
         },
         "test_builds": {},
-        "token": {
-          "status": null,
-          "traefik_provider": null
-        },
         "tunnel": {
           "public_host": "127.0.0.1:8003"
         },
@@ -294,6 +292,14 @@
           "type": "integer",
           "format": "uint16",
           "minimum": 0.0
+        },
+        "traefik_provider_token": {
+          "description": "Token for the API Traefik provider.",
+          "allOf": [
+            {
+              "$ref": "#/definitions/Secret<String>"
+            }
+          ]
         }
       },
       "additionalProperties": false
@@ -1250,7 +1256,8 @@
         "api_edge": {
           "default": {
             "host": null,
-            "port": null
+            "port": null,
+            "traefik_provider_token": null
           },
           "allOf": [
             {
@@ -1398,6 +1405,14 @@
             }
           ]
         },
+        "status": {
+          "default": null,
+          "allOf": [
+            {
+              "$ref": "#/definitions/Status"
+            }
+          ]
+        },
         "telemetry": {
           "default": {
             "enable": true
@@ -1416,17 +1431,6 @@
             "$ref": "#/definitions/TestBuild"
           }
         },
-        "token": {
-          "default": {
-            "status": null,
-            "traefik_provider": null
-          },
-          "allOf": [
-            {
-              "$ref": "#/definitions/Tokens"
-            }
-          ]
-        },
         "tunnel": {
           "default": {
             "public_host": "127.0.0.1:8003"
@@ -1526,6 +1530,22 @@
       },
       "additionalProperties": false
     },
+    "Status": {
+      "description": "Configure the status check API.\n\nThese are different than the health check API since they check the internals of the Rivet system.",
+      "type": "object",
+      "required": [
+        "token"
+      ],
+      "properties": {
+        "system_test_isolate_project": {
+          "type": "string"
+        },
+        "token": {
+          "$ref": "#/definitions/Secret<String>"
+        }
+      },
+      "additionalProperties": false
+    },
     "Stripe": {
       "type": "object",
       "required": [
@@ -1631,29 +1651,6 @@
         "lets_encrypt_staging"
       ]
     },
-    "Tokens": {
-      "description": "Configuration for various tokens used in the system.",
-      "type": "object",
-      "properties": {
-        "status": {
-          "description": "Token for API status checks.",
-          "allOf": [
-            {
-              "$ref": "#/definitions/Secret<String>"
-            }
-          ]
-        },
-        "traefik_provider": {
-          "description": "Token for the API Traefik provider.",
-          "allOf": [
-            {
-              "$ref": "#/definitions/Secret<String>"
-            }
-          ]
-        }
-      },
-      "additionalProperties": false
-    },
     "Tunnel": {
       "description": "Configuration for the tunnel service.",
       "type": "object",

diff --git a/docs/src/content/docs/troubleshooting.mdx b/docs/src/content/docs/troubleshooting.mdx
@@ -55,3 +55,28 @@ To look up the location `file:///index.js:3754:17`, you can:
                 ^
     ```
 
+## `Bad Gateway` when making request to actor
+
+This indicates that your actor's HTTP server is:
+
+- Not responding to requests
+- Is respondign with invalid data
+- Your actor is crashing when receing the request or on startup
+
+Validate that:
+
+- Your server is listening on the correct port (e.g. for port `http`, read the port from `PORT_HTTP`)
+- Your server starts immediately when the actor starts (i.e. don't run async code before starting the HTTP server)
+- You're not using HTTPS for your server (Rivet Guard handles this for you)
+
+If using the actor SDK, this likely an issue with the underlying Rivet library and should be reported on GitHub [here](https://github.com/rivet-gg/rivet/issues/new/choose).
+
+## `404 page not found` when making request to actor
+
+This indicates that there is no actor running for the given address. This often indicates that your actor has crashed and no longer exists.
+
+Validate that:
+
+- Your actor is not crashing by checking the logs
+- The address is exactly what's returned from the Rivet API
+
diff --git a/examples/counter/README.md b/examples/counter/README.md
@@ -1,4 +1,4 @@
-# Counter
+# Sandbox (Isolate)
 
 A bare bones example of RPC & events using a counter as an example.
 

diff --git a/examples/counter/counter.ts b/examples/counter/counter.ts
diff --git a/examples/counter/counter_test.ts b/examples/counter/counter_test.ts
diff --git a/examples/system-test/README.md b/examples/system-test/README.md
@@ -0,0 +1,21 @@
+# System Test
+
+Actors for simple tests of E2E system functionality.
+
+## Prerequisites
+
+- [Rivet CLI](https://rivet.gg/docs/setup)
+
+## Deploying
+
+```sh
+rivet login
+rivet deploy
+```
+
+## Testing
+
+```sh
+rivet deno --populate-env run -A ws_test.ts
+```
+
diff --git a/examples/system-test/deno.json b/examples/system-test/deno.json
@@ -0,0 +1,17 @@
+{
+  "imports": {
+    "@core/asyncutil": "jsr:@core/asyncutil@^1.2.0",
+		"@cross/env": "jsr:@cross/env@^1.0.2",
+		"@rivet-gg/api": "npm:@rivet-gg/api@0.0.1-rc.5",
+		"@std/assert": "jsr:@std/assert@^1.0.8",
+		"@std/async": "jsr:@std/async@^1.0.9",
+		"@std/cbor": "jsr:@std/cbor@^0.1.3",
+		"@std/log": "jsr:@std/log@^0.224.11",
+		"hono": "jsr:@hono/hono@^4.6.12",
+		"@rivet-gg/actors-core": "../../sdks/actors/core/src/mod.ts",
+		"@rivet-gg/actors": "../../sdks/actors/runtime/src/mod.ts",
+		"on-change": "npm:on-change@^5.0.1",
+		"zod": "npm:zod@^3.24.1"
+
+  }
+}