feat: add Inngest framework#440
Open
Linell wants to merge 2 commits intoTanStack:mainfrom
Open
Conversation
Add Inngest as a framework selectable for installation during `create`. Adds a new 'workflows' category because Inngest didn't fit cleanly into the others .
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds a new Inngest add-on for the React template: client initialization, typed event + function, API route handler, demo UI route, docs and env guidance, package manifest, and a small types update to classify add-ons as 'workflows'. Changes
Sequence DiagramsequenceDiagram
actor User
participant Browser as "React Component"
participant Server as "Server Function (/demo/inngest)"
participant API as "API Route (/api/inngest)"
participant Inngest as "Inngest Client"
participant InngestSvc as "Inngest Dev/Service"
User->>Browser: Enter name & click "Send Event"
Browser->>Server: POST { name }
activate Server
Server->>Server: Validate input
Server->>API: Forward request (if using edge) / call inngest.send(...)
API->>Inngest: Pass request to handler
Inngest->>InngestSvc: Dispatch event (demo/hello.world)
InngestSvc-->>Inngest: Return eventId
Inngest-->>API: Return eventId
API-->>Server: Return eventId
deactivate Server
Server-->>Browser: { eventId }
Browser->>User: Display eventId / success
Estimated Code Review Effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
packages/create/src/frameworks/react/add-ons/inngest/assets/src/routes/demo/inngest.tsx (1)
84-88: Make async error updates screen-reader friendly.Add live-region semantics so failures are announced when this block appears.
Accessibility tweak
- {error && ( - <div className="rounded-xl border border-[rgba(200,70,70,0.3)] bg-[rgba(200,70,70,0.08)] p-4 text-sm text-[`#c04646`]"> + {error && ( + <div + role="alert" + aria-live="assertive" + className="rounded-xl border border-[rgba(200,70,70,0.3)] bg-[rgba(200,70,70,0.08)] p-4 text-sm text-[`#c04646`]" + > {error} </div> )}🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/create/src/frameworks/react/add-ons/inngest/assets/src/routes/demo/inngest.tsx` around lines 84 - 88, The error display block currently renders plain markup so screen readers may not announce new errors; update the JSX where {error && ( ... )} is rendered to include ARIA live-region attributes (e.g., aria-live="assertive" and aria-atomic="true") or role="alert" on the container so failures are announced to assistive tech when it appears; ensure you add these attributes to the same element that wraps {error} (the rounded-xl div) so the message is announced immediately.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@packages/create/src/frameworks/react/add-ons/inngest/assets/src/routes/demo/inngest.tsx`:
- Around line 97-99: Fix the copy typo in the demo Inngest route: locate the JSX
text containing "Cloud.You" and insert a space after the period so it reads
"Cloud. You" (the string appears in the demo route's paragraph in the
inngest.tsx content).
- Around line 7-12: sendHelloEvent's inputValidator is a passthrough and handler
blindly returns ids[0], so validate the incoming name (e.g., require a non-empty
string, trim and check length) in createServerFn.inputValidator and in the
handler check the result of inngest.send(helloWorld.create(...)) for a populated
ids array; if ids is empty or undefined, throw or return a clear error instead
of returning eventId: undefined (reference sendHelloEvent, inputValidator,
handler, inngest.send, and helloWorld.create).
In `@packages/create/src/frameworks/react/add-ons/inngest/info.json`:
- Around line 15-16: jsName is set to "InngestDemo" but the target file exports
the symbol "Route", causing import failures; update jsName to match the exported
symbol or change the export to match jsName. Fix by either setting jsName to
"Route" in the info.json entry (so generated imports use the existing exported
symbol Route) or alter the route module to export default InngestDemo (so the
current jsName is valid); refer to the jsName property and the exported symbol
Route when making the change.
---
Nitpick comments:
In
`@packages/create/src/frameworks/react/add-ons/inngest/assets/src/routes/demo/inngest.tsx`:
- Around line 84-88: The error display block currently renders plain markup so
screen readers may not announce new errors; update the JSX where {error && ( ...
)} is rendered to include ARIA live-region attributes (e.g.,
aria-live="assertive" and aria-atomic="true") or role="alert" on the container
so failures are announced to assistive tech when it appears; ensure you add
these attributes to the same element that wraps {error} (the rounded-xl div) so
the message is announced immediately.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 7644bcd4-a57a-469b-af7a-765f9643a0da
⛔ Files ignored due to path filters (2)
packages/create/src/frameworks/react/add-ons/inngest/logo.svgis excluded by!**/*.svgpackages/create/src/frameworks/react/add-ons/inngest/small-logo.svgis excluded by!**/*.svg
📒 Files selected for processing (9)
packages/create/src/frameworks/react/add-ons/inngest/README.mdpackages/create/src/frameworks/react/add-ons/inngest/assets/_dot_env.local.appendpackages/create/src/frameworks/react/add-ons/inngest/assets/src/inngest/client.ts.ejspackages/create/src/frameworks/react/add-ons/inngest/assets/src/inngest/functions.tspackages/create/src/frameworks/react/add-ons/inngest/assets/src/routes/api/inngest.tspackages/create/src/frameworks/react/add-ons/inngest/assets/src/routes/demo/inngest.tsxpackages/create/src/frameworks/react/add-ons/inngest/info.jsonpackages/create/src/frameworks/react/add-ons/inngest/package.jsonpackages/create/src/types.ts
Comment on lines
+15
to
+16
| "path": "src/routes/demo/inngest.tsx", | ||
| "jsName": "InngestDemo" |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify how routes[].jsName is consumed and whether the target symbol is exported.
set -euo pipefail
echo "1) Find jsName consumers:"
rg -n -C3 '\bjsName\b'
echo
echo "2) Check declared jsName in this add-on:"
sed -n '1,120p' packages/create/src/frameworks/react/add-ons/inngest/info.json
echo
echo "3) Check exports in target route file:"
rg -n -C2 'export\s+(const|function|class)\s+' \
packages/create/src/frameworks/react/add-ons/inngest/assets/src/routes/demo/inngest.tsxRepository: TanStack/cli
Length of output: 50368
🏁 Script executed:
cat packages/create/src/frameworks/react/add-ons/inngest/assets/src/routes/demo/inngest.tsxRepository: TanStack/cli
Length of output: 4858
jsName "InngestDemo" does not match the exported symbol "Route" in the target file.
The route file exports Route, but jsName is set to "InngestDemo". When templates are generated, this will produce import InngestDemo from '...' which will fail because that export does not exist.
💡 Proposed fix
- "jsName": "InngestDemo"
+ "jsName": "Route"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| "path": "src/routes/demo/inngest.tsx", | |
| "jsName": "InngestDemo" | |
| "path": "src/routes/demo/inngest.tsx", | |
| "jsName": "Route" |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/create/src/frameworks/react/add-ons/inngest/info.json` around lines
15 - 16, jsName is set to "InngestDemo" but the target file exports the symbol
"Route", causing import failures; update jsName to match the exported symbol or
change the export to match jsName. Fix by either setting jsName to "Route" in
the info.json entry (so generated imports use the existing exported symbol
Route) or alter the route module to export default InngestDemo (so the current
jsName is valid); refer to the jsName property and the exported symbol Route
when making the change.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add Inngest as a framework selectable for installation during
create.Adds a new 'workflows' category because Inngest didn't fit cleanly into the others .
Summary by CodeRabbit
New Features
Documentation