feat(rivetkit): expose getGatewayUrl #3975

NathanFlurry · 2026-01-19T17:58:32Z

No description provided.

railway-app · 2026-01-19T17:58:40Z

🚅 Environment rivet-pr-3975 in rivet-frontend has no services deployed.

NathanFlurry · 2026-01-19T17:58:52Z

chore(rivetkit): make actions optional #3977
feat: kv api #3976
feat(rivetkit): expose getGatewayUrl #3975 👈 (View in Graphite)
main

How to use the Graphite Merge Queue

Add the label merge-queue to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

_{An organization admin has enabled the Graphite Merge Queue in this repository.} _{Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.}

This stack of pull requests is managed by Graphite. Learn more about stacking.

pkg-pr-new · 2026-01-19T18:01:39Z

More templates

@rivetkit/virtual-websocket

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/virtual-websocket@3975

@rivetkit/cloudflare-workers

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/cloudflare-workers@3975

@rivetkit/db

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/db@3975

@rivetkit/framework-base

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/framework-base@3975

@rivetkit/next-js

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/next-js@3975

@rivetkit/react

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/react@3975

rivetkit

pnpm add https://pkg.pr.new/rivet-dev/rivet/rivetkit@3975

@rivetkit/sql-loader

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/sql-loader@3975

@rivetkit/engine-runner

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/engine-runner@3975

@rivetkit/engine-runner-protocol

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/engine-runner-protocol@3975

commit: 825c812

claude · 2026-01-19T18:02:09Z

PR Review: feat(rivetkit): expose getGatewayUrl

Summary

This PR adds a new getGatewayUrl() method to the ActorHandleRaw class, exposing the ability to retrieve the gateway URL for routing traffic to a specific Rivet Actor. The implementation adds a buildGatewayUrl method to the ManagerDriver interface and implements it across all driver implementations (Cloudflare Workers, FileSystem, and Remote).

Code Quality & Best Practices ✅

Strengths:

Clean interface design with the new method properly added to the ManagerDriver interface
Good code reuse: refactored existing URL building logic into buildActorGatewayUrl helper function
Consistent implementation across all three driver types
Properly handles URL encoding with encodeURIComponent
Follows existing patterns in the codebase (async methods, proper error handling via queryActor)

Minor Issues:

Documentation - Missing JSDoc on public API (actor-handle.ts:282)
- The new getGatewayUrl() method lacks a @returns tag
- Consider adding: @returns {Promise<string>} The gateway URL for the actor
Inconsistent documentation style (actor-handle.ts:242)
- The resolve() method comment was simplified but the new getGatewayUrl() comment does not follow the same pattern
- Both should be consistent in their level of detail

Potential Bugs or Issues 🔍

No Critical Issues Found

Minor observations:

The buildGatewayUrl implementations are all async, but most could be synchronous (FileSystem and Cloudflare). The Remote implementation needs to await metadataPromise, so keeping them all async for interface consistency is fine.
Token handling in buildActorGatewayUrl uses the @ symbol as a delimiter. This is an existing pattern, not introduced in this PR, but worth noting for security review if tokens could contain special characters.

Performance Considerations ⚡

Good:

The refactoring consolidates URL building logic, reducing code duplication
The RemoteManagerDriver.buildGatewayUrl properly awaits metadata initialization before building the URL, preventing race conditions

Note:

getGatewayUrl() calls queryActor() which may involve network calls in the Remote driver. This is expected behavior, but users should be aware this is not a purely synchronous property access.

Security Concerns 🔒

All Good:

Proper URL encoding via encodeURIComponent for both actorId and token parameters
Token is only included when defined (token !== undefined check)
No user input is directly concatenated into URLs without encoding

Test Coverage 🧪

Missing:

No tests added for the new getGatewayUrl() method
No tests for buildGatewayUrl() in any of the driver implementations

Recommendations:

Add tests for ActorHandleRaw.getGatewayUrl() in the appropriate test suites (e.g., driver-memory.test.ts, driver-file-system.test.ts)
Test cases should cover:
- URL format correctness
- Token inclusion/exclusion based on configuration
- Proper URL encoding of special characters in actor IDs
- Integration with different driver types

Architecture & Design 🏗️

Excellent:

The design properly separates concerns by putting URL building in the driver layer where runtime-specific details belong
The helper function buildActorGatewayUrl is well-factored and reusable
The public API on ActorHandleRaw provides a clean interface for users

Convention Compliance ✅

Based on CLAUDE.md guidelines:

✅ Uses workspace dependencies appropriately
✅ Code style appears consistent with existing patterns
✅ Follows existing import patterns
✅ Async/await usage is appropriate
⚠️ Missing tests (see Test Coverage section above)

Recommendations Summary

High Priority:
- Add test coverage for the new functionality
Medium Priority:
- Improve JSDoc documentation with @returns tag
- Ensure consistent documentation style across similar methods
Low Priority:
- Consider adding usage examples in comments or documentation

Conclusion

This is a clean, well-implemented feature addition. The code quality is good, follows existing patterns, and the refactoring improves code organization. The main gap is test coverage. Once tests are added, this PR will be ready to merge.

Status: Approve with recommendations ✅

Review generated by Claude Code

graphite-app · 2026-01-19T18:03:29Z

rivetkit-typescript/packages/rivetkit/src/remote-manager-driver/actor-http-client.ts

 import type { ClientConfig } from "@/client/config";
 import { HEADER_RIVET_TOKEN } from "@/common/actor-router-consts";
-import { combineUrlPath } from "@/utils";
+import { buildActorGatewayUrl } from "./actor-websocket-client";


Import statement needs to be sorted correctly according to Biome's rules. Run 'biome format --write .' to fix import sorting.

Spotted by Graphite Agent (based on CI logs)

Is this helpful? React 👍 or 👎 to let us know.

graphite-app · 2026-01-19T18:58:01Z

rivetkit-typescript/packages/rivetkit/src/remote-manager-driver/actor-websocket-client.ts

+export function buildActorGatewayUrl(
+	endpoint: string,
+	actorId: string,
+	token: string | undefined,
+	path = "",
+): string {
+	const tokenSegment =
+		token !== undefined ? `@${encodeURIComponent(token)}` : "";
+	const gatewayPath = `/gateway/${encodeURIComponent(actorId)}${tokenSegment}${path}`;
+	return combineUrlPath(endpoint, gatewayPath);
+}


The new buildActorGatewayUrl function might not be properly formatted according to Biome standards. Run the Biome formatter on this file to ensure proper spacing, indentation, and line breaks. Also, ensure the imports at the top of the file are properly sorted.

Spotted by Graphite Agent (based on CI logs)

Is this helpful? React 👍 or 👎 to let us know.

graphite-app · 2026-01-21T00:11:17Z

Merge activity

Jan 21, 12:11 AM UTC: NathanFlurry added this pull request to the Graphite merge queue.
Jan 21, 12:11 AM UTC: CI is running for this pull request on a draft pull request (#3988) due to your merge queue CI optimization settings.
Jan 21, 12:12 AM UTC: Merged by the Graphite merge queue via draft PR: #3988.

graphite-app bot reviewed Jan 19, 2026

View reviewed changes

NathanFlurry force-pushed the 01-19-feat_rivetkit_expose_getgatewayurl branch from fa8f73e to ed37d98 Compare January 19, 2026 18:54

NathanFlurry mentioned this pull request Jan 19, 2026

feat: kv api #3976

Closed

graphite-app bot reviewed Jan 19, 2026

View reviewed changes

NathanFlurry mentioned this pull request Jan 19, 2026

chore(rivetkit): make actions optional #3977

Closed

feat(rivetkit): expose getGatewayUrl

825c812

NathanFlurry force-pushed the 01-19-feat_rivetkit_expose_getgatewayurl branch from ed37d98 to 825c812 Compare January 20, 2026 19:48

graphite-app bot pushed a commit that referenced this pull request Jan 21, 2026

feat(rivetkit): expose getGatewayUrl (#3975)

009c231

graphite-app bot closed this Jan 21, 2026

graphite-app bot deleted the 01-19-feat_rivetkit_expose_getgatewayurl branch January 21, 2026 00:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(rivetkit): expose getGatewayUrl #3975

feat(rivetkit): expose getGatewayUrl #3975

Uh oh!

NathanFlurry commented Jan 19, 2026

Uh oh!

railway-app bot commented Jan 19, 2026

Uh oh!

NathanFlurry commented Jan 19, 2026 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Jan 19, 2026 •

edited

Loading

Uh oh!

claude bot commented Jan 19, 2026 •

edited

Loading

Uh oh!

graphite-app bot Jan 19, 2026

Uh oh!

graphite-app bot Jan 19, 2026

Uh oh!

graphite-app bot commented Jan 21, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feat(rivetkit): expose getGatewayUrl #3975

feat(rivetkit): expose getGatewayUrl #3975

Uh oh!

Conversation

NathanFlurry commented Jan 19, 2026

Uh oh!

railway-app bot commented Jan 19, 2026

Uh oh!

NathanFlurry commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How to use the Graphite Merge Queue

Uh oh!

pkg-pr-new bot commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

claude bot commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Review: feat(rivetkit): expose getGatewayUrl

Summary

Code Quality & Best Practices ✅

Potential Bugs or Issues 🔍

Performance Considerations ⚡

Security Concerns 🔒

Test Coverage 🧪

Architecture & Design 🏗️

Convention Compliance ✅

Recommendations Summary

Conclusion

Uh oh!

graphite-app bot Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

graphite-app bot Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

graphite-app bot commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

NathanFlurry commented Jan 19, 2026 •

edited

Loading

pkg-pr-new bot commented Jan 19, 2026 •

edited

Loading

claude bot commented Jan 19, 2026 •

edited

Loading

graphite-app bot commented Jan 21, 2026 •

edited

Loading