Skip to content
This repository was archived by the owner on Oct 22, 2025. It is now read-only.

Commit 1df6f03

Browse files
NathanFlurryjog1t
NathanFlurry
authored and
jog1t
committed
chore: implement Registry.run 
1 parent a08ff6e commit 1df6f03

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+1856
-805
lines changed

‎CLAUDE.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
- **Build:** `pnpm build` - Production build using Turbopack
2626
- **Build specific package:** `pnpm build -F rivetkit` - Build only specified package
2727
- **Format:** `pnpm fmt` - Format code with Biome
28-
- Do not run the format command automatically.
28+
- Do not run the format command automatically.
2929

3030
## Core Concepts
3131

@@ -44,6 +44,7 @@ Driver interfaces define the contract between rivetkit and various backends:
4444
- **WorkerDriver:** Manages worker state, lifecycle, and persistence
4545
- **ManagerDriver:** Manages worker discovery, routing, and scaling
4646
- **CoordinateDriver:** Handles peer-to-peer communication between worker instances
47+
- Only applicable in coordinate topologies
4748

4849
### Driver Implementations
4950

@@ -75,6 +76,7 @@ This ensures imports resolve correctly across different build environments and p
7576
## Code Style Guidelines
7677

7778
- **Formatting:** Uses Biome for consistent formatting
79+
- See biome.json for reference on formatting rules
7880
- **Imports:** Organized imports enforced, unused imports warned
7981
- **TypeScript:** Strict mode enabled, target ESNext
8082
- **Naming:**
@@ -83,26 +85,28 @@ This ensures imports resolve correctly across different build environments and p
8385
- UPPER_CASE for constants
8486
- Use `#` prefix for private class members (not `private` keyword)
8587
- **Error Handling:**
86-
- Extend from `WorkerError` base class
88+
- Extend from `WorkerError` base class (packages/core/src/worker/errors.ts)
8789
- Use `UserError` for client-safe errors
8890
- Use `InternalError` for internal errors
8991
- Don't try to fix type issues by casting to unknown or any. If you need to do this, then stop and ask me to manually intervene.
9092
- Write log messages in lowercase
91-
- Instead of returning raw HTTP responses with c.json, use or write an error in packages/rivetkit/src/worker/errors.ts and throw that instead. The middleware will automatically serialize the response for you.
93+
- Use `logger()` to log messages
94+
- Do not store `logger()` as a variable, always call it using `logger().info("...")`
95+
- Use structured logging where it makes sense, for example: `logger().info("foo", { bar: 5, baz: 10 })`
96+
- Supported logging methods are: trace, debug, info, warn, error, critical
97+
- Instead of returning errors as raw HTTP responses with c.json, use or write an error in packages/rivetkit/src/worker/errors.ts and throw that instead. The middleware will automatically serialize the response for you.
9298

9399
## Project Structure
94100

95101
- Monorepo with pnpm workspaces and Turborepo
96-
- Core code in `packages/rivetkit/`
102+
- Core code in `packages/core/`
97103
- Platform implementations in `packages/platforms/`
98104
- Driver implementations in `packages/drivers/`
99105

100106
## Development Notes
101107

102-
- Prefer classes over factory functions
103108
- Use zod for runtime type validation
104109
- Use `assertUnreachable(x: never)` for exhaustive type checking in switch statements
105-
- Follow existing patterns for P2P networking
106110
- Add proper JSDoc comments for public APIs
107111
- Ensure proper error handling with descriptive messages
108112
- Run `pnpm check-types` regularly during development to catch type errors early. Prefer `pnpm check-types` instead of `pnpm build`.

‎examples/elysia/package.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"name": "example-elysia",
3+
"version": "0.9.0-rc.1",
4+
"private": true,
5+
"type": "module",
6+
"scripts": {
7+
"dev": "bun --watch src/server.ts",
8+
"check-types": "tsc --noEmit"
9+
},
10+
"devDependencies": {
11+
"@types/node": "^22.13.9",
12+
"rivetkit": "workspace:*",
13+
"typescript": "^5.5.2"
14+
},
15+
"dependencies": {
16+
"@rivetkit/memory": "workspace:0.9.0-rc.1",
17+
"@rivetkit/react": "workspace:0.9.0-rc.1",
18+
"elysia": "^1.3.5",
19+
"react": "^18.2.0",
20+
"react-dom": "^18.2.0"
21+
},
22+
"example": {
23+
"platforms": ["*"]
24+
},
25+
"stableVersion": "0.8.0"
26+
}

‎examples/elysia/src/registry.ts‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
import { worker, setup } from "rivetkit";
2+
3+
export const counter = worker({
4+
onAuth: () => {
5+
// Configure auth here
6+
},
7+
state: { count: 0 },
8+
actions: {
9+
increment: (c, x: number) => {
10+
c.state.count += x;
11+
return c.state.count;
12+
},
13+
},
14+
});
15+
16+
export const registry = setup({
17+
workers: { counter },
18+
});
19+
20+
export type Registry = typeof registry;

‎examples/elysia/src/server.ts‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
import { registry } from "./registry";
2+
import { Elysia } from "elysia";
3+
import { createMemoryDriver } from "@rivetkit/memory";
4+
5+
// Start RivetKit
6+
const { client, handler } = registry.run({
7+
driver: createMemoryDriver(),
8+
});
9+
10+
// Setup router
11+
const app = new Elysia()
12+
// Expose RivetKit to the frontend (optional)
13+
.mount("/registry", handler)
14+
// Example HTTP endpoint
15+
.post("/increment/:name", async ({ params }) => {
16+
const name = params.name;
17+
18+
const counter = client.counter.getOrCreate(name);
19+
const newCount = await counter.increment(1);
20+
21+
return `New Count: ${newCount}`;
22+
})
23+
.listen(3001);
24+
25+
console.log("Listening at http://localhost:3001");

‎examples/elysia/tsconfig.json‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"compilerOptions": {
3+
/* Visit https://aka.ms/tsconfig.json to read more about this file */
4+
5+
/* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
6+
"target": "esnext",
7+
/* Specify a set of bundled library declaration files that describe the target runtime environment. */
8+
"lib": ["esnext"],
9+
/* Specify what JSX code is generated. */
10+
"jsx": "react-jsx",
11+
12+
/* Specify what module code is generated. */
13+
"module": "esnext",
14+
/* Specify how TypeScript looks up a file from a given module specifier. */
15+
"moduleResolution": "bundler",
16+
/* Specify type package names to be included without being referenced in a source file. */
17+
"types": ["node"],
18+
/* Enable importing .json files */
19+
"resolveJsonModule": true,
20+
21+
/* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
22+
"allowJs": true,
23+
/* Enable error reporting in type-checked JavaScript files. */
24+
"checkJs": false,
25+
26+
/* Disable emitting files from a compilation. */
27+
"noEmit": true,
28+
29+
/* Ensure that each file can be safely transpiled without relying on other imports. */
30+
"isolatedModules": true,
31+
/* Allow 'import x from y' when a module doesn't have a default export. */
32+
"allowSyntheticDefaultImports": true,
33+
/* Ensure that casing is correct in imports. */
34+
"forceConsistentCasingInFileNames": true,
35+
36+
/* Enable all strict type-checking options. */
37+
"strict": true,
38+
39+
/* Skip type checking all .d.ts files. */
40+
"skipLibCheck": true
41+
},
42+
"include": ["src/**/*"]
43+
}

‎examples/express/package.json‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"name": "example-express",
3+
"version": "0.9.0-rc.1",
4+
"private": true,
5+
"type": "module",
6+
"scripts": {
7+
"dev": "tsx --watch src/server.ts",
8+
"check-types": "tsc --noEmit"
9+
},
10+
"devDependencies": {
11+
"@types/express": "^4.17.21",
12+
"@types/node": "^22.13.9",
13+
"rivetkit": "workspace:*",
14+
"tsx": "^3.12.7",
15+
"typescript": "^5.5.2"
16+
},
17+
"dependencies": {
18+
"@rivetkit/memory": "workspace:0.9.0-rc.1",
19+
"@rivetkit/react": "workspace:0.9.0-rc.1",
20+
"express": "^5.1.0",
21+
"react": "^18.2.0",
22+
"react-dom": "^18.2.0"
23+
},
24+
"example": {
25+
"platforms": ["*"]
26+
},
27+
"stableVersion": "0.8.0"
28+
}

‎examples/express/src/registry.ts‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
import { worker, setup } from "rivetkit";
2+
3+
export const counter = worker({
4+
onAuth: () => {
5+
// Configure auth here
6+
},
7+
state: { count: 0 },
8+
actions: {
9+
increment: (c, x: number) => {
10+
c.state.count += x;
11+
return c.state.count;
12+
},
13+
},
14+
});
15+
16+
export const registry = setup({
17+
workers: { counter },
18+
});
19+
20+
export type Registry = typeof registry;

‎examples/express/src/server.ts‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
import { registry } from "./registry";
2+
import express from "express";
3+
import { createMemoryDriver } from "@rivetkit/memory";
4+
5+
// Start RivetKit
6+
const { client, handler } = registry.run({
7+
driver: createMemoryDriver(),
8+
});
9+
10+
// Setup router
11+
const app = express();
12+
13+
// Expose RivetKit to the frontend (optional)
14+
app.use("/registry", handler);
15+
16+
// Example HTTP endpoint
17+
app.post("/increment/:name", async (req, res) => {
18+
const name = req.params.name;
19+
20+
const counter = client.counter.getOrCreate(name);
21+
const newCount = await counter.increment(1);
22+
23+
res.send(`New Count: ${newCount}`);
24+
});
25+
26+
app.listen(3001, () => {
27+
console.log("Listening at http://localhost:3001");
28+
});

‎examples/express/tsconfig.json‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"compilerOptions": {
3+
/* Visit https://aka.ms/tsconfig.json to read more about this file */
4+
5+
/* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
6+
"target": "esnext",
7+
/* Specify a set of bundled library declaration files that describe the target runtime environment. */
8+
"lib": ["esnext"],
9+
/* Specify what JSX code is generated. */
10+
"jsx": "react-jsx",
11+
12+
/* Specify what module code is generated. */
13+
"module": "esnext",
14+
/* Specify how TypeScript looks up a file from a given module specifier. */
15+
"moduleResolution": "bundler",
16+
/* Specify type package names to be included without being referenced in a source file. */
17+
"types": ["node"],
18+
/* Enable importing .json files */
19+
"resolveJsonModule": true,
20+
21+
/* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
22+
"allowJs": true,
23+
/* Enable error reporting in type-checked JavaScript files. */
24+
"checkJs": false,
25+
26+
/* Disable emitting files from a compilation. */
27+
"noEmit": true,
28+
29+
/* Ensure that each file can be safely transpiled without relying on other imports. */
30+
"isolatedModules": true,
31+
/* Allow 'import x from y' when a module doesn't have a default export. */
32+
"allowSyntheticDefaultImports": true,
33+
/* Ensure that casing is correct in imports. */
34+
"forceConsistentCasingInFileNames": true,
35+
36+
/* Enable all strict type-checking options. */
37+
"strict": true,
38+
39+
/* Skip type checking all .d.ts files. */
40+
"skipLibCheck": true
41+
},
42+
"include": ["src/**/*"]
43+
}

‎examples/hono-react/package.json‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
{
2+
"name": "example-hono-react",
3+
"version": "0.9.0-rc.1",
4+
"private": true,
5+
"type": "module",
6+
"scripts": {
7+
"dev": "concurrently \"npm run dev:backend\" \"npm run dev:frontend\"",
8+
"dev:backend": "tsx --watch src/backend/server.ts",
9+
"dev:frontend": "vite",
10+
"build": "vite build",
11+
"check-types": "tsc --noEmit",
12+
"test": "vitest run"
13+
},
14+
"devDependencies": {
15+
"@types/node": "^22.13.9",
16+
"@types/react": "^18.2.0",
17+
"@types/react-dom": "^18.2.0",
18+
"@vitejs/plugin-react": "^4.2.0",
19+
"concurrently": "^8.2.2",
20+
"rivetkit": "workspace:*",
21+
"tsx": "^3.12.7",
22+
"typescript": "^5.5.2",
23+
"vite": "^5.0.0",
24+
"vitest": "^3.1.1"
25+
},
26+
"dependencies": {
27+
"@hono/node-server": "^1.14.4",
28+
"@rivetkit/memory": "workspace:0.9.0-rc.1",
29+
"@rivetkit/react": "workspace:0.9.0-rc.1",
30+
"hono": "^4.7.0",
31+
"react": "^18.2.0",
32+
"react-dom": "^18.2.0"
33+
},
34+
"example": {
35+
"platforms": [
36+
"*"
37+
]
38+
},
39+
"stableVersion": "0.8.0"
40+
}

0 commit comments

Comments
 (0)