chore: reorg in prep for merging rivetkit in to monorepo

[NathanFlurry]

No description provided.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
rivet-site	Error			Oct 22, 2025 4:41am

2 Skipped Deployments

Project	Deployment	Preview	Comments	Updated (UTC)
rivet-cloud	Ignored			Oct 22, 2025 4:41am
rivet-inspector	Ignored	Preview		Oct 22, 2025 4:41am

[NathanFlurry]

• chore: merge rivetkit #3240
• chore: reorg in prep for merging rivetkit in to monorepo #3239 👈 (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.

[claude]

PR Review: Reorganization for RivetKit Merge

This PR reorganizes the codebase structure in preparation for merging RivetKit into the monorepo. Overall, this is a well-executed reorganization with consistent patterns. Here's my detailed review:

✅ Strengths

1. Consistent Path Structure: All workspace dependencies have been systematically moved under the engine/ prefix:

   • packages/* → engine/packages/*
   • sdks/rust/* → engine/sdks/rust/*
   • All 49 workspace member paths follow this pattern

2. Workspace Integrity: The workspace structure maintains proper organization:

   • All package paths in Cargo.toml correctly reference engine/packages/*
   • Workspace dependencies are properly configured with .workspace = true
   • No broken package references detected

3. Documentation Updates: README files have been split appropriately:

   • README.rivet.tpl.md for the Rivet Engine
   • README.rivetkit.tpl.md for RivetKit
   • Clear separation of concerns between the two projects

4. Artifacts Organization: Error artifacts (67 files) have been moved to engine/artifacts/errors/, maintaining the error handling system's structure

5. Docker Development Environment: The engine/docker/dev-host/ structure is preserved with all necessary configuration files

🔍 Things to Verify

1. Build Verification:

   • It would be good to confirm that cargo build --workspace and cargo test --workspace pass successfully
   • Verify that all internal path references in individual package Cargo.toml files are still correct

2. CI/CD Updates:

   • Check if any CI/CD workflows need path updates to reference engine/ subdirectory
   • GitHub Actions workflows may need to update their working directories

3. Documentation Links:

   • In engine/README.md:49-51, the links reference packages/services/pegboard/ and packages/core/guard/, but based on the workspace structure, these should be engine/packages/pegboard/ and engine/packages/guard/
   • Similarly, engine/README.md:45 references /site/src/content/docs but the root shows /website/src/content/docs

4. Git History:

   • Ensure that git properly tracked these as file moves (not delete + add) to preserve history
   • Run git log --follow on a few key files to verify

5. IDE/Tooling Configuration:

   • Check if any IDE configuration files (.vscode/, .idea/) need updates for the new paths
   • Verify rust-analyzer can still find all workspace members

📋 Minor Observations

1. Duplicate Path Definitions: In Cargo.toml:

   • Lines 314-318: gasoline package is defined twice (once as gasoline, once as gas alias)
   • Lines 384-388: rivet-util package is defined twice (once as rivet-util, once as util alias)

   This appears intentional to provide both the full name and shorthand alias, which is fine.

2. Workspace Member Count: 49 members listed in the workspace, all following the new engine/ prefix pattern

3. .gitignore Considerations: The .gitignore file maintains general patterns, which should work with the new structure

🎯 Recommendations

1. Test Coverage: Run the full test suite to ensure no path-related breakages
2. Link Audit: Update internal documentation links that reference the old paths
3. Script Updates: Check if any scripts in /scripts/ need path updates
4. Verify justfile: Ensure any just commands that reference package paths are updated

Summary

This is a clean reorganization that sets up the monorepo structure well for merging RivetKit. The changes are systematic and follow a clear pattern. Once the items in the "Things to Verify" section are confirmed, this should be safe to merge.

Approval Status: ✅ Approved pending verification of build/test success

Great work on maintaining consistency throughout this large reorganization! 🚀

[claude]

PR Review: Repository Reorganization

Overview

This PR reorganizes the repository structure in preparation for merging RivetKit into the monorepo. The changes primarily involve moving all engine-related code into an engine/ subdirectory.

Summary of Changes

• File Reorganization: All packages moved from packages/* to engine/packages/*
• Workspace Configuration: Updated Cargo.toml workspace members to reflect new paths
• Documentation Updates: Updated README templates to reference the new structure
• Scope: 100 files changed (96 file moves, 4 files with content changes)
  • .gitignore: 7 additions, 7 deletions
  • Cargo.toml: 94 additions, 94 deletions (path updates)
  • README.rivet.tpl.md: 1 addition, 1 deletion
  • README.rivetkit.tpl.md: 1 addition, 1 deletion

Code Quality & Best Practices ✅

Strengths:

• Clean, systematic reorganization with consistent naming
• All workspace dependencies properly updated in Cargo.toml
• Workspace member paths correctly reference new engine/ prefix
• File moves preserve all artifacts, documentation, and Docker configurations
• Package structure remains intact and logical

Potential Issues ⚠️

1. Outdated Path References in Documentation

Several documentation files still reference the old path structure and need updating:

CLAUDE.md (lines 79-83, 89, 138):

- **Core Engine** (`packages/core/engine/`) - Should be `engine/packages/engine/`
- **Workflow Engine** (`packages/common/gasoline/`) - Should be `engine/packages/gasoline/`
- **Pegboard** (`packages/core/pegboard/`) - Should be `engine/packages/pegboard/`
- **Common Packages** (`/packages/common/`) - Should be `/engine/packages/`
- **Core Packages** (`/packages/core/`) - Should be `/engine/packages/`
- Custom error system at `packages/common/error/` - Should be `engine/packages/error/`
- Connection pooling through `packages/common/pools/` - Should be `engine/packages/pools/`

README.rivet.tpl.md (lines 43-45):

- **[Pegboard](packages/services/pegboard/)** - Should be `engine/packages/pegboard/`
- **[Guard](packages/core/guard/)** - Should be `engine/packages/guard/`
- **[Gasoline](packages/common/gasoline/)** - Should be `engine/packages/gasoline/`

Other files with old references:

• engine/contrib-docs/SDKS.md
• engine/contrib-docs/API.md
• engine/README.md
• website/src/content/docs/drivers/build-your-own.mdx
• website/src/content/docs/self-hosting/configuration.mdx
• website/scripts/generateApi.js
• engine/docker/template/src/services/edge/rivet-engine.ts

2. Code Reference in metrics/src/buckets.rs

The file engine/packages/metrics/src/buckets.rs contains a reference to the old path structure that should be reviewed for accuracy.

Performance Considerations ✅

• No performance impact expected
• This is purely a structural reorganization
• Build paths updated correctly in workspace configuration

Security Concerns ✅

• No security issues identified
• No changes to authentication, authorization, or data handling logic
• File permissions and gitignore patterns appropriately maintained

Test Coverage 📋

Recommendations:

1. Verify that cargo build --workspace completes successfully
2. Run cargo test --workspace to ensure all tests still pass
3. Confirm that Docker development environment still builds correctly
4. Test that documentation generation scripts work with new paths

Recommendations

High Priority

1. Update all documentation files to reference the new engine/ prefixed paths
2. Verify workspace builds with cargo build --workspace
3. Run full test suite to ensure no broken imports or path references

Medium Priority

1. Update any CI/CD configurations that may reference old paths
2. Check if any deployment scripts need path updates
3. Verify that the generated OpenAPI spec and error artifacts are created in the correct locations

Low Priority

1. Consider adding a note in the PR description about the path migration for future reference
2. Update any developer onboarding documentation to reflect new structure

Conclusion

This is a well-executed reorganization PR that sets up the repository structure for the RivetKit merge. The main issue is outdated documentation references that need updating to prevent confusion for developers. Once the documentation is updated and tests are verified, this should be safe to merge.

Recommendation: Request changes to update documentation paths before merging.