Skip to content

Conversation

@TooTallNate
Copy link
Member

@TooTallNate TooTallNate commented Jan 19, 2026

NOTE: Keeping as a draft for now so we don't document this feature publicly until it's been :dogfood: internally.

Added documentation for custom class serialization in workflows with new @workflow/serde package.

What changed?

  • Added documentation for the new @workflow/serde package that provides serialization symbols for custom class serialization
  • Added a new section to the serialization docs explaining how to make custom classes serializable
  • Added the @workflow/serde package to the API reference navigation
  • Updated the docs-typecheck extractor to support MDX comments for expect-error annotations

Why make this change?

Custom class serialization is an important feature for workflows that need to work with complex data structures. This documentation explains how developers can make their own classes serializable using the WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols from the new @workflow/serde package, enabling seamless passing of class instances between workflow and step functions.

@changeset-bot
Copy link

changeset-bot bot commented Jan 19, 2026

🦋 Changeset detected

Latest commit: 4241b40

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Jan 19, 2026

🧪 E2E Test Results

Some tests failed

Summary

Passed Failed Skipped Total
✅ ▲ Vercel Production 435 0 38 473
✅ 💻 Local Development 398 0 32 430
✅ 📦 Local Production 398 0 32 430
✅ 🐘 Local Postgres 398 0 32 430
✅ 🪟 Windows 43 0 0 43
❌ 🌍 Community Worlds 163 21 0 184
Total 1835 21 134 1990

❌ Failed Tests

🌍 Community Worlds (21 failed)

mongodb (1 failed):

  • webhookWorkflow

starter (19 failed):

  • addTenWorkflow
  • addTenWorkflow
  • error handling error propagation workflow errors nested function calls preserve message and stack trace
  • error handling error propagation workflow errors cross-file imports preserve message and stack trace
  • error handling error propagation step errors basic step error preserves message and stack trace
  • error handling error propagation step errors cross-file step error preserves message and function names in stack
  • error handling retry behavior regular Error retries until success
  • error handling retry behavior FatalError fails immediately without retries
  • error handling catchability FatalError can be caught and detected with FatalError.is()
  • hookCleanupTestWorkflow - hook token reuse after workflow completion
  • stepFunctionPassingWorkflow - step function references can be passed as arguments (without closure vars)
  • stepFunctionWithClosureWorkflow - step function with closure variables passed as argument
  • spawnWorkflowFromStepWorkflow - spawning a child workflow using start() inside a step
  • pathsAliasWorkflow - TypeScript path aliases resolve correctly
  • Calculator.calculate - static workflow method using static step methods from another class
  • AllInOneService.processNumber - static workflow method using sibling static step methods
  • ChainableService.processWithThis - static step methods using this to reference the class
  • thisSerializationWorkflow - step function invoked with .call() and .apply()
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE

turso (1 failed):

  • webhookWorkflow

Details by Category

✅ ▲ Vercel Production
App Passed Failed Skipped
✅ astro 39 0 4
✅ example 39 0 4
✅ express 39 0 4
✅ fastify 39 0 4
✅ hono 39 0 4
✅ nextjs-turbopack 42 0 1
✅ nextjs-webpack 42 0 1
✅ nitro 39 0 4
✅ nuxt 39 0 4
✅ sveltekit 39 0 4
✅ vite 39 0 4
✅ 💻 Local Development
App Passed Failed Skipped
✅ astro-stable 39 0 4
✅ express-stable 39 0 4
✅ fastify-stable 39 0 4
✅ hono-stable 39 0 4
✅ nextjs-turbopack-stable 43 0 0
✅ nextjs-webpack-stable 43 0 0
✅ nitro-stable 39 0 4
✅ nuxt-stable 39 0 4
✅ sveltekit-stable 39 0 4
✅ vite-stable 39 0 4
✅ 📦 Local Production
App Passed Failed Skipped
✅ astro-stable 39 0 4
✅ express-stable 39 0 4
✅ fastify-stable 39 0 4
✅ hono-stable 39 0 4
✅ nextjs-turbopack-stable 43 0 0
✅ nextjs-webpack-stable 43 0 0
✅ nitro-stable 39 0 4
✅ nuxt-stable 39 0 4
✅ sveltekit-stable 39 0 4
✅ vite-stable 39 0 4
✅ 🐘 Local Postgres
App Passed Failed Skipped
✅ astro-stable 39 0 4
✅ express-stable 39 0 4
✅ fastify-stable 39 0 4
✅ hono-stable 39 0 4
✅ nextjs-turbopack-stable 43 0 0
✅ nextjs-webpack-stable 43 0 0
✅ nitro-stable 39 0 4
✅ nuxt-stable 39 0 4
✅ sveltekit-stable 39 0 4
✅ vite-stable 39 0 4
✅ 🪟 Windows
App Passed Failed Skipped
✅ nextjs-turbopack 43 0 0
❌ 🌍 Community Worlds
App Passed Failed Skipped
✅ mongodb-dev 3 0 0
❌ mongodb 42 1 0
✅ redis-dev 3 0 0
✅ redis 43 0 0
✅ starter-dev 3 0 0
❌ starter 24 19 0
✅ turso-dev 3 0 0
❌ turso 42 1 0

📋 View full workflow run

Copy link
Member Author

TooTallNate commented Jan 19, 2026

@vercel
Copy link
Contributor

vercel bot commented Jan 19, 2026

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

Project Deployment Review Updated (UTC)
example-nextjs-workflow-turbopack Ready Ready Preview, Comment Jan 19, 2026 11:42pm
example-nextjs-workflow-webpack Ready Ready Preview, Comment Jan 19, 2026 11:42pm
example-workflow Ready Ready Preview, Comment Jan 19, 2026 11:42pm
workbench-astro-workflow Ready Ready Preview, Comment Jan 19, 2026 11:42pm
workbench-express-workflow Ready Ready Preview, Comment Jan 19, 2026 11:42pm
workbench-fastify-workflow Ready Ready Preview, Comment Jan 19, 2026 11:42pm
workbench-hono-workflow Ready Ready Preview, Comment Jan 19, 2026 11:42pm
workbench-nitro-workflow Ready Ready Preview, Comment Jan 19, 2026 11:42pm
workbench-nuxt-workflow Ready Ready Preview, Comment Jan 19, 2026 11:42pm
workbench-sveltekit-workflow Ready Ready Preview, Comment Jan 19, 2026 11:42pm
workbench-vite-workflow Ready Ready Preview, Comment Jan 19, 2026 11:42pm
workflow-docs Ready Ready Preview, Comment Jan 19, 2026 11:42pm

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive documentation for the custom class serialization feature using the new @workflow/serde package. The documentation explains how developers can make their custom classes serializable in workflows by implementing WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols.

Changes:

  • Added a new "Custom Class Serialization" section to the serialization documentation with examples showing basic and complex usage patterns
  • Updated the docs-typecheck extractor to support MDX-style comments for @expect-error annotations in addition to HTML comments
  • Added the @workflow/serde package to the API reference navigation and index

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

Show a summary per file
File Description
packages/docs-typecheck/src/extractor.ts Enhanced regex to support both HTML and MDX comment formats for @expect-error annotations
docs/content/docs/foundations/serialization.mdx Added comprehensive documentation section explaining custom class serialization with code examples
docs/content/docs/api-reference/meta.json Added workflow-serde to the API reference pages list
docs/content/docs/api-reference/index.mdx Added Card component linking to the @workflow/serde package documentation
.changeset/smooth-nails-do.md Empty changeset file (acceptable for documentation-only changes)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@TooTallNate TooTallNate force-pushed the 01-19-add_documentation_for_custom_class_serialization branch from b08b6eb to 841ddee Compare January 19, 2026 23:39
@graphite-app graphite-app bot changed the base branch from graphite-base/810 to main January 19, 2026 23:40
@TooTallNate TooTallNate force-pushed the 01-19-add_documentation_for_custom_class_serialization branch from 841ddee to 4241b40 Compare January 19, 2026 23:40
@github-actions
Copy link
Contributor

github-actions bot commented Jan 19, 2026

📊 Benchmark Results

📈 Comparing against baseline from main branch. Green 🟢 = faster, Red 🔺 = slower.

workflow with no steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
🌐 Starter 🥇 Next.js (Turbopack) 0.039s (-1.8%) 1.014s (~) 0.975s 10 1.00x
💻 Local Next.js (Turbopack) 0.041s (~) 1.017s (~) 0.977s 10 1.04x
🌐 Redis Next.js (Turbopack) 0.042s (-5.4% 🟢) 1.017s (~) 0.975s 10 1.06x
💻 Local Nitro 0.044s (+42.3% 🔺) 1.006s (~) 0.963s 10 1.11x
💻 Local Express 0.044s (-13.8% 🟢) 1.007s (~) 0.963s 10 1.13x
🌐 MongoDB Next.js (Turbopack) 0.073s (-18.4% 🟢) 1.016s (~) 0.943s 10 1.86x
🌐 Turso Next.js (Turbopack) 0.104s (+0.7%) 1.014s (~) 0.910s 10 2.64x
🐘 Postgres Next.js (Turbopack) 0.179s (-15.3% 🟢) 1.019s (~) 0.840s 10 4.55x
🐘 Postgres Nitro 0.302s (-4.5%) 1.012s (~) 0.709s 10 7.70x
🐘 Postgres Express 0.351s (+2.7%) 1.014s (~) 0.663s 10 8.94x

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Next.js (Turbopack) 0.602s (-41.7% 🟢) 1.750s (+1.6%) 1.148s 10 1.00x
▲ Vercel Nitro 0.694s (-16.1% 🟢) 1.685s (+2.4%) 0.992s 10 1.15x
▲ Vercel Express 0.733s (+18.6% 🔺) 1.701s (+8.1% 🔺) 0.968s 10 1.22x

🔍 Observability: Next.js (Turbopack) | Nitro | Express

workflow with 1 step

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
🌐 Starter 🥇 Next.js (Turbopack) 1.090s (+0.8%) 2.010s (~) 0.920s 10 1.00x
💻 Local Next.js (Turbopack) 1.099s (~) 2.011s (~) 0.912s 10 1.01x
🌐 Redis Next.js (Turbopack) 1.106s (~) 2.013s (~) 0.907s 10 1.01x
💻 Local Nitro 1.113s (+3.6%) 2.006s (~) 0.893s 10 1.02x
💻 Local Express 1.116s (~) 2.008s (~) 0.892s 10 1.02x
🌐 MongoDB Next.js (Turbopack) 1.276s (-1.7%) 2.013s (~) 0.737s 10 1.17x
🌐 Turso Next.js (Turbopack) 1.278s (-3.3%) 2.012s (~) 0.734s 10 1.17x
🐘 Postgres Next.js (Turbopack) 1.849s (-2.3%) 2.116s (-12.4% 🟢) 0.268s 10 1.70x
🐘 Postgres Nitro 2.175s (~) 3.013s (~) 0.838s 10 2.00x
🐘 Postgres Express 2.192s (+2.0%) 3.014s (~) 0.823s 10 2.01x

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Nitro 2.747s (-15.9% 🟢) 3.784s (-2.8%) 1.036s 10 1.00x
▲ Vercel Express 2.858s (-11.3% 🟢) 3.790s (-7.4% 🟢) 0.932s 10 1.04x
▲ Vercel Next.js (Turbopack) 3.083s (+5.2% 🔺) 4.495s (+20.7% 🔺) 1.412s 10 1.12x

🔍 Observability: Nitro | Express | Next.js (Turbopack)

workflow with 10 sequential steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
🌐 Starter 🥇 Next.js (Turbopack) 10.621s (~) 11.012s (~) 0.391s 5 1.00x
💻 Local Next.js (Turbopack) 10.651s (~) 11.015s (~) 0.364s 5 1.00x
🌐 Redis Next.js (Turbopack) 10.681s (~) 11.020s (~) 0.338s 5 1.01x
💻 Local Nitro 10.781s (+2.6%) 11.012s (~) 0.231s 5 1.02x
💻 Local Express 10.794s (~) 11.013s (~) 0.220s 5 1.02x
🌐 MongoDB Next.js (Turbopack) 11.977s (-2.0%) 12.230s (-6.1% 🟢) 0.253s 5 1.13x
🌐 Turso Next.js (Turbopack) 12.197s (~) 13.025s (~) 0.828s 5 1.15x
🐘 Postgres Next.js (Turbopack) 15.324s (~) 16.039s (~) 0.715s 5 1.44x
🐘 Postgres Express 20.418s (~) 21.031s (~) 0.613s 5 1.92x
🐘 Postgres Nitro 20.436s (~) 21.028s (~) 0.592s 5 1.92x

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Next.js (Turbopack) 22.682s (-2.3%) 23.595s (-0.9%) 0.913s 5 1.00x
▲ Vercel Nitro 23.047s (-4.4%) 23.837s (-4.3%) 0.790s 5 1.02x
▲ Vercel Express 23.420s (-0.9%) 24.618s (~) 1.198s 5 1.03x

🔍 Observability: Next.js (Turbopack) | Nitro | Express

Promise.all with 10 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
🌐 Starter 🥇 Next.js (Turbopack) 1.350s (-0.6%) 2.008s (~) 0.658s 15 1.00x
🌐 Redis Next.js (Turbopack) 1.364s (-1.8%) 2.010s (~) 0.646s 15 1.01x
💻 Local Nitro 1.395s (+5.4% 🔺) 2.005s (~) 0.610s 15 1.03x
💻 Local Next.js (Turbopack) 1.402s (+0.6%) 2.012s (~) 0.610s 15 1.04x
💻 Local Express 1.423s (+0.9%) 2.006s (~) 0.583s 15 1.05x
🐘 Postgres Next.js (Turbopack) 2.010s (+2.4%) 2.410s (+7.7% 🔺) 0.400s 13 1.49x
🌐 MongoDB Next.js (Turbopack) 2.135s (~) 3.015s (~) 0.880s 10 1.58x
🌐 Turso Next.js (Turbopack) 2.223s (~) 3.015s (~) 0.791s 10 1.65x
🐘 Postgres Express 2.414s (-0.9%) 3.012s (~) 0.598s 10 1.79x
🐘 Postgres Nitro 2.446s (-2.9%) 3.010s (~) 0.564s 10 1.81x

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Next.js (Turbopack) 2.865s (-5.8% 🟢) 3.785s (+0.7%) 0.920s 8 1.00x
▲ Vercel Nitro 2.882s (+1.9%) 3.835s (+4.0%) 0.952s 8 1.01x
▲ Vercel Express 2.998s (-4.8%) 3.753s (-6.1% 🟢) 0.754s 8 1.05x

🔍 Observability: Next.js (Turbopack) | Nitro | Express

Promise.all with 25 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Next.js (Turbopack) 2.159s (-0.7%) 3.050s (-2.9%) 0.891s 10 1.00x
💻 Local Nitro 2.201s (+12.0% 🔺) 3.132s (+50.8% 🔺) 0.931s 10 1.02x
💻 Local Express 2.269s (-0.7%) 3.225s (~) 0.956s 10 1.05x
🌐 Starter Next.js (Turbopack) 2.478s (~) 3.010s (~) 0.532s 10 1.15x
🌐 Redis Next.js (Turbopack) 2.509s (-1.3%) 3.012s (~) 0.503s 10 1.16x
🐘 Postgres Next.js (Turbopack) 2.546s (-5.5% 🟢) 3.023s (~) 0.477s 10 1.18x
🐘 Postgres Nitro 2.722s (-6.6% 🟢) 3.011s (~) 0.289s 10 1.26x
🐘 Postgres Express 3.109s (+3.9%) 3.767s (+12.1% 🔺) 0.658s 8 1.44x
🌐 MongoDB Next.js (Turbopack) 4.701s (+1.3%) 5.182s (~) 0.481s 6 2.18x
🌐 Turso Next.js (Turbopack) 4.721s (+1.2%) 5.182s (~) 0.461s 6 2.19x

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Next.js (Turbopack) 3.074s (-10.9% 🟢) 3.675s (-4.3%) 0.601s 9 1.00x
▲ Vercel Nitro 3.184s (-2.4%) 3.897s (+6.1% 🔺) 0.713s 8 1.04x
▲ Vercel Express 3.610s (+6.2% 🔺) 4.436s (+7.2% 🔺) 0.825s 7 1.17x

🔍 Observability: Next.js (Turbopack) | Nitro | Express

Promise.race with 10 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
🌐 Redis 🥇 Next.js (Turbopack) 1.349s (-4.5%) 2.010s (~) 0.661s 15 1.00x
🌐 Starter Next.js (Turbopack) 1.368s (~) 2.007s (~) 0.639s 15 1.01x
💻 Local Next.js (Turbopack) 1.396s (-0.5%) 2.010s (~) 0.614s 15 1.03x
💻 Local Nitro 1.413s (+5.9% 🔺) 2.005s (~) 0.592s 15 1.05x
💻 Local Express 1.430s (~) 2.007s (~) 0.577s 15 1.06x
🐘 Postgres Nitro 1.735s (+0.8%) 2.009s (~) 0.273s 15 1.29x
🐘 Postgres Next.js (Turbopack) 1.775s (+5.2% 🔺) 2.012s (~) 0.238s 15 1.32x
🌐 MongoDB Next.js (Turbopack) 2.137s (-0.9%) 3.016s (~) 0.879s 10 1.58x
🌐 Turso Next.js (Turbopack) 2.221s (+1.2%) 3.012s (~) 0.791s 10 1.65x
🐘 Postgres Express 2.472s (+25.5% 🔺) 3.015s (+45.0% 🔺) 0.543s 10 1.83x

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Nitro 2.981s (+1.7%) 3.929s (+2.8%) 0.948s 8 1.00x
▲ Vercel Express 3.061s (+6.5% 🔺) 3.834s (+3.8%) 0.772s 8 1.03x
▲ Vercel Next.js (Turbopack) 3.112s (+6.0% 🔺) 4.033s (+8.8% 🔺) 0.921s 8 1.04x

🔍 Observability: Nitro | Express | Next.js (Turbopack)

Promise.race with 25 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Next.js (Turbopack) 2.168s (+3.9%) 3.036s (+4.4%) 0.869s 10 1.00x
💻 Local Nitro 2.226s (+10.2% 🔺) 3.172s (+25.1% 🔺) 0.946s 10 1.03x
💻 Local Express 2.258s (-4.1%) 3.192s (-3.0%) 0.934s 10 1.04x
🌐 Starter Next.js (Turbopack) 2.466s (-2.8%) 3.010s (-3.3%) 0.544s 10 1.14x
🌐 Redis Next.js (Turbopack) 2.478s (-3.4%) 3.011s (~) 0.533s 10 1.14x
🐘 Postgres Next.js (Turbopack) 2.495s (-3.1%) 3.021s (-1.3%) 0.526s 10 1.15x
🐘 Postgres Nitro 2.615s (-0.8%) 3.021s (~) 0.407s 10 1.21x
🐘 Postgres Express 2.812s (+1.2%) 3.016s (-4.1%) 0.204s 10 1.30x
🌐 MongoDB Next.js (Turbopack) 4.616s (-0.9%) 5.187s (~) 0.571s 6 2.13x
🌐 Turso Next.js (Turbopack) 4.739s (+1.9%) 5.182s (~) 0.443s 6 2.19x

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Next.js (Turbopack) 3.177s (-5.3% 🟢) 3.828s (-0.5%) 0.651s 8 1.00x
▲ Vercel Express 3.237s (+2.9%) 3.925s (+1.4%) 0.688s 8 1.02x
▲ Vercel Nitro 3.297s (+7.2% 🔺) 4.092s (+11.9% 🔺) 0.796s 8 1.04x

🔍 Observability: Next.js (Turbopack) | Express | Nitro

Stream Benchmarks (includes TTFB metrics)
workflow with stream

💻 Local Development

World Framework Workflow Time TTFB Slurp Wall Time Overhead Samples vs Fastest
🌐 Starter 🥇 Next.js (Turbopack) 0.130s (+0.8%) 1.006s (~) 0.000s (NaN%) 1.012s (~) 0.882s 10 1.00x
💻 Local Next.js (Turbopack) 0.137s (-3.9%) 1.002s (~) 0.017s (+1.9%) 1.027s (~) 0.890s 10 1.05x
🌐 Redis Next.js (Turbopack) 0.151s (-3.3%) 1.005s (~) 0.000s (+Infinity% 🔺) 1.014s (~) 0.862s 10 1.16x
💻 Local Express 0.177s (-2.8%) 0.993s (~) 0.016s (-9.2% 🟢) 1.023s (~) 0.846s 10 1.36x
💻 Local Nitro 0.180s (+69.8% 🔺) 0.992s (-0.8%) 0.016s (+40.5% 🔺) 1.022s (~) 0.841s 10 1.39x
🌐 Turso Next.js (Turbopack) 0.460s (-4.7%) 0.988s (+2.2%) 0.000s (+Infinity% 🔺) 1.012s (~) 0.553s 10 3.54x
🌐 MongoDB Next.js (Turbopack) 0.501s (-0.8%) 0.944s (~) 0.000s (NaN%) 1.014s (~) 0.513s 10 3.85x
🐘 Postgres Next.js (Turbopack) 1.114s (-3.5%) 1.931s (+2.1%) 0.000s (+Infinity% 🔺) 2.017s (~) 0.903s 10 8.57x
🐘 Postgres Express 2.331s (~) 2.711s (~) 0.000s (NaN%) 3.015s (~) 0.684s 10 17.93x
🐘 Postgres Nitro 2.365s (-2.2%) 2.676s (+2.0%) 0.000s (~) 3.012s (~) 0.647s 10 18.19x

▲ Production (Vercel)

World Framework Workflow Time TTFB Slurp Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Nitro 2.941s (-10.4% 🟢) 3.416s (-6.6% 🟢) 0.569s (+24.0% 🔺) 4.435s (-3.9%) 1.494s 10 1.00x
▲ Vercel Express 2.946s (+3.8%) 3.204s (-1.6%) 0.589s (-32.3% 🟢) 4.342s (-5.6% 🟢) 1.396s 10 1.00x
▲ Vercel Next.js (Turbopack) 3.028s (-3.3%) 3.297s (~) 0.736s (-6.8% 🟢) 4.495s (-3.0%) 1.467s 10 1.03x

🔍 Observability: Nitro | Express | Next.js (Turbopack)

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World 🥇 Fastest Framework Wins
💻 Local Next.js (Turbopack) 7/8
🐘 Postgres Next.js (Turbopack) 7/8
▲ Vercel Next.js (Turbopack) 5/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework 🥇 Fastest World Wins
Express 💻 Local 8/8
Next.js (Turbopack) 🌐 Starter 5/8
Nitro 💻 Local 8/8
Column Definitions
  • Workflow Time: Runtime reported by workflow (completedAt - createdAt) - primary metric
  • TTFB: Time to First Byte - time from workflow start until first stream byte received (stream benchmarks only)
  • Slurp: Time from first byte to complete stream consumption (stream benchmarks only)
  • Wall Time: Total testbench time (trigger workflow + poll for result)
  • Overhead: Testbench overhead (Wall Time - Workflow Time)
  • Samples: Number of benchmark iterations run
  • vs Fastest: How much slower compared to the fastest configuration for this benchmark

Worlds:

  • 💻 Local: In-memory filesystem world (local development)
  • 🐘 Postgres: PostgreSQL database world (local development)
  • ▲ Vercel: Vercel production/preview deployment
  • 🌐 Starter: Community world (local development)
  • 🌐 Turso: Community world (local development)
  • 🌐 MongoDB: Community world (local development)
  • 🌐 Redis: Community world (local development)
  • 🌐 Jazz: Community world (local development)

📋 View full workflow run

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.

2 participants