Skip to content

docs(rivetkit): raise serverless start payload limit#4911

Closed
NathanFlurry wants to merge 1 commit intosqlite-soak/kitchen-harnessfrom
sqlite-soak/serverless-start-limits
Closed

docs(rivetkit): raise serverless start payload limit#4911
NathanFlurry wants to merge 1 commit intosqlite-soak/kitchen-harnessfrom
sqlite-soak/serverless-start-limits

Conversation

@NathanFlurry
Copy link
Copy Markdown
Member

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Copy link
Copy Markdown
Member Author

NathanFlurry commented May 3, 2026

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

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

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 3, 2026

PR Review: docs(rivetkit): raise serverless start payload limit

Summary

This PR raises the default serverless.maxStartPayloadBytes limit from 1 MiB to 16 MiB. In serverless mode, the /api/rivet/start request body carries actor config plus preloaded KV and SQLite startup data. Since the default preload budget can already reach 1 MiB and SQLite startup page preloads can be larger, the old 1 MiB limit was easily exhausted. The PR also adds a dev:serverless npm script to the kitchen-sink example and updates documentation.


Should Fix

Stale artifact in rivetkit-typescript/artifacts/registry-config.json

Line 152 still shows "Default: 1048576". The DocServerlessConfigSchema description now uses ${DEFAULT_SERVERLESS_MAX_START_PAYLOAD_BYTES} (= 16777216), but the checked-in artifact has not been regenerated. Per project convention, artifacts should be regenerated in the same change. Run:

cd rivetkit-typescript/packages/rivetkit && pnpm run registry-config-schema-gen

Nice to Fix

examples/kitchen-sink-vercel not updated

examples/kitchen-sink-vercel/src/index.ts does not include the serverless.maxStartPayloadBytes config added to examples/kitchen-sink/src/index.ts. Since the Vercel example is a mirror of the kitchen-sink, it should be regenerated via scripts/vercel-examples/generate-vercel-examples.ts.


Optional

Hardcoded value in kitchen-sink example

In examples/kitchen-sink/src/index.ts, the fallback value 16 * 1024 * 1024 is hardcoded rather than importing DEFAULT_SERVERLESS_MAX_START_PAYLOAD_BYTES from rivetkit. Minor DRY concern: if the default changes again, the example won't track it automatically.


Looks Good

  • Named constant DEFAULT_SERVERLESS_MAX_START_PAYLOAD_BYTES is the right approach, eliminating previous duplication.
  • Documentation additions in limits.mdx and production-checklist.mdx are accurate and actionable.
  • All CLAUDE.md conventions followed: correct domain (rivet.dev), no em dashes, conventional commit format, no wildcard match arms.
  • No test changes needed — this is a configuration default change validated at runtime via Zod schema.

@NathanFlurry NathanFlurry force-pushed the sqlite-soak/serverless-start-limits branch from 87495c3 to 309e96c Compare May 3, 2026 22:50
@NathanFlurry NathanFlurry force-pushed the sqlite-soak/kitchen-harness branch from b6516dd to fc4d9c4 Compare May 3, 2026 22:50
@NathanFlurry NathanFlurry force-pushed the sqlite-soak/kitchen-harness branch from fc4d9c4 to 534a0e9 Compare May 4, 2026 00:04
@NathanFlurry NathanFlurry force-pushed the sqlite-soak/serverless-start-limits branch from 309e96c to 1b8918f Compare May 4, 2026 00:04
@NathanFlurry NathanFlurry marked this pull request as ready for review May 4, 2026 00:31
@NathanFlurry NathanFlurry force-pushed the sqlite-soak/serverless-start-limits branch from 1b8918f to b90bbe3 Compare May 4, 2026 00:32
@NathanFlurry NathanFlurry force-pushed the sqlite-soak/kitchen-harness branch from 534a0e9 to 1d7905a Compare May 4, 2026 00:32
@NathanFlurry NathanFlurry marked this pull request as draft May 4, 2026 00:49
@NathanFlurry NathanFlurry force-pushed the sqlite-soak/serverless-start-limits branch from b90bbe3 to 7256a9c Compare May 4, 2026 02:45
@NathanFlurry
Copy link
Copy Markdown
Member Author

Landed in main via stack-merge fast-forward push. Commits are in main; closing to match.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant