Add @fedify/nuxt package for Nuxt integration#674
Open
2chanhaeng wants to merge 12 commits intofedify-dev:mainfrom
Open
Add @fedify/nuxt package for Nuxt integration#6742chanhaeng wants to merge 12 commits intofedify-dev:mainfrom
@fedify/nuxt package for Nuxt integration#6742chanhaeng wants to merge 12 commits intofedify-dev:mainfrom
Conversation
issues-auto-labeler
bot
added
component/build
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds a new Changes
Sequence DiagramsequenceDiagram
participant Client
participant Nitro as Nitro/H3_Event_Handler
participant FedifyMiddleware as Fedify_Middleware
participant FedifyFetch as fetchWithFedify
participant Federation as Federation_Instance
participant Framework as Nuxt_Handler
participant Plugin as Deferred_Response_Plugin
Client->>Nitro: HTTP Request
Nitro->>FedifyMiddleware: Invoke handler (H3 event)
FedifyMiddleware->>FedifyMiddleware: toWebRequest / compute contextData
FedifyMiddleware->>FedifyFetch: fetchWithFedify(fetch, request, contextData)
FedifyFetch->>Federation: federation.fetch(request, { onNotFound, onNotAcceptable, ... })
alt federation handled (ActivityPub)
Federation-->>FedifyFetch: ActivityPub Response (e.g., 200, application/activity+json)
FedifyFetch-->>FedifyMiddleware: { kind: "handled", response }
FedifyMiddleware->>Nitro: return federation response
Nitro-->>Client: federation response
else not-found
Federation-->>FedifyFetch: NotFound sentinel (internal)
FedifyFetch-->>FedifyMiddleware: { kind: "not-found" }
FedifyMiddleware->>Nitro: return undefined (delegate)
Nitro->>Framework: continue to Nuxt handler
Framework-->>Nitro: framework response
Nitro-->>Client: framework response
else not-acceptable
Federation-->>FedifyFetch: NotAcceptable sentinel (internal)
FedifyFetch-->>FedifyMiddleware: { kind: "not-acceptable" }
FedifyMiddleware->>FedifyMiddleware: set deferred flag in event.context
FedifyMiddleware->>Nitro: return undefined (delegate)
Nitro->>Framework: continue to Nuxt handler
Framework-->>Nitro: framework response
Nitro->>Plugin: beforeResponse hook
Plugin->>Plugin: resolveDeferredNotAcceptable(deferred, frameworkStatus)
alt returns 406
Plugin->>Nitro: set status, headers, body -> 406 Not Acceptable
else undefined
Plugin->>Nitro: leave framework response intact
end
Nitro-->>Client: final response
end
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested reviewers
🚥 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)
Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces the @fedify/nuxt package to integrate Fedify with the Nuxt framework, providing a module, Nitro middleware, and a plugin for deferred 406 Not Acceptable handling. It also updates documentation, agent skills, and workspace configurations. Feedback recommends improving TypeScript type safety by using specific types from @nuxt/kit and h3, and suggests extracting the "Not acceptable" response body into a shared constant to prevent duplication across the runtime logic and plugin.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.agents/skills/create-example-app-with-integration/SKILL.md (1)
180-193:⚠️ Potential issue | 🟠 MajorClose the bash fence immediately after the curl example.
Line 180 opens a fence, but it is only closed at Line 193. That makes the “Lint, format, and final checks” section render as code.
Suggested fix
~~~~ bash curl -H "Accept: application/activity+json" http://localhost:0000/users/demo +~~~~ Lint, format, and final checks ------------------------------ @@ -~~~~🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.agents/skills/create-example-app-with-integration/SKILL.md around lines 180 - 193, The markdown code fence opened with "~~~~ bash" around the curl example is left open; close that fence immediately after the curl command so the following "Lint, format, and final checks" section is not rendered as code—i.e., move or add the matching closing fence "~~~~" directly after the line with `curl -H "Accept: application/activity+json" http://localhost:0000/users/demo` (refer to the fenced block starting with "~~~~ bash" in SKILL.md) and ensure subsequent text is plain markdown outside the fence.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.agents/skills/create-example-app-with-integration/SKILL.md:
- Line 178: Update the wording in SKILL.md where the sentence reads "If the
`test:examples` can not be run, just run the server and test with curl:" to use
the standard single-word form "cannot" (i.e., change "can not" to "cannot") so
the line becomes "If the `test:examples` cannot be run, just run the server and
test with curl:".
In `@docs/manual/integration.md`:
- Around line 397-418: The Nuxt docs use inconsistent path styling; update the
Nuxt section so all file and module paths are wrapped in asterisks instead of
underscores or backticks—replace occurrences like _server/federation.ts_,
_nuxt.config.ts_, and `~/server/federation` with *server/federation.ts*,
*nuxt.config.ts*, and *~/server/federation* respectively (in the block that
shows createFederation / MemoryKvStore and the module enablement) so path
styling matches the repo guideline.
In `@packages/nuxt/README.md`:
- Around line 71-72: Replace the inline code backticks around the default module
path with asterisks: change the instance that reads "`@fedify/nuxt` loads your
Federation instance from `~/server/federation`" so that the module and path use
asterisk wrapping (e.g., *@fedify/nuxt* and *~/server/federation*) to comply
with the repo Markdown rule; update the README line containing "@fedify/nuxt"
and "~/server/federation" accordingly.
In `@packages/nuxt/src/mod.test.ts`:
- Line 2: Replace the runtime-specific import of the test entrypoint by
importing the test function from the runtime-agnostic package: change the import
of test from "node:test" to "@fedify/fixture" (i.e., replace the existing import
statement that references node:test with one that imports test from
`@fedify/fixture`), ensuring any usages of the test identifier remain unchanged.
In `@packages/nuxt/src/runtime/server/logic.ts`:
- Around line 47-53: Add a JSDoc block above the exported function
resolveDeferredNotAcceptable that documents its purpose (handle deferred
requests that should return a 406 Not Acceptable when the framework routed to
404), describes parameters isDeferred:boolean and frameworkStatus:number,
explains the return type Response|undefined and the conditions when
createNotAcceptableResponse() is returned, and notes that this is part of the
deferred 406 handling pattern for public API consumers; keep the comment concise
and follow existing project JSDoc style.
- Around line 22-45: Add a JSDoc block to the exported function fetchWithFedify
describing its purpose, parameters (fetcher: (request: Request, options:
FederationFetchOptions<unknown>) => Promise<Response>, request: Request,
contextData: unknown) and return value (Promise<FetchResult>), and note the
behavior/assumption that a response equal to DUMMY_NOT_FOUND_RESPONSE maps to {
kind: "not-found" } and any Response with status 406 is treated as { kind:
"not-acceptable" } (which relies on user handlers not returning 406 for
unrelated reasons); reference DUMMY_NOT_FOUND_RESPONSE and
createNotAcceptableResponse in the doc so callers understand the special-case
mappings.
In `@packages/nuxt/src/runtime/server/middleware.ts`:
- Around line 20-23: Add a JSDoc block above the exported createFedifyMiddleware
function that documents its parameters and return value: describe the
"federation" parameter type/expected shape (unknown but clarify expected usage),
the optional "contextDataFactory" callback signature ((event: unknown, request:
Request) => unknown) and when it is invoked, the middleware behavior (what the
returned function does, side effects, and that it returns a
Connect/Node/Fetch-style middleware handler), and the return type expectations
(e.g., middleware function or handler). Use the function name
createFedifyMiddleware and mention the contextDataFactory callback to make the
doc discoverable.
---
Outside diff comments:
In @.agents/skills/create-example-app-with-integration/SKILL.md:
- Around line 180-193: The markdown code fence opened with "~~~~ bash" around
the curl example is left open; close that fence immediately after the curl
command so the following "Lint, format, and final checks" section is not
rendered as code—i.e., move or add the matching closing fence "~~~~" directly
after the line with `curl -H "Accept: application/activity+json"
http://localhost:0000/users/demo` (refer to the fenced block starting with "~~~~
bash" in SKILL.md) and ensure subsequent text is plain markdown outside the
fence.
🪄 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: Repository UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 833b06e0-e342-4d98-af3c-fa0f0c532116
⛔ Files ignored due to path filters (2)
deno.lockis excluded by!**/*.lockpnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (24)
.agents/skills/add-to-fedify-init/SKILL.md.agents/skills/create-example-app-with-integration/SKILL.md.agents/skills/create-example-app-with-integration/example/README.md.agents/skills/create-example-app-with-integration/example/src/logging.ts.agents/skills/create-integration-package/SKILL.md.hongdown.tomlAGENTS.mdCHANGES.mdCONTRIBUTING.mdcspell.jsondeno.jsondocs/manual/integration.mdmise.tomlpackages/fedify/README.mdpackages/nuxt/README.mdpackages/nuxt/deno.jsonpackages/nuxt/package.jsonpackages/nuxt/src/mod.test.tspackages/nuxt/src/mod.tspackages/nuxt/src/runtime/server/logic.tspackages/nuxt/src/runtime/server/middleware.tspackages/nuxt/src/runtime/server/plugin.tspackages/nuxt/tsdown.config.tspnpm-workspace.yaml
Codecov Report❌ Patch coverage is
🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.agents/skills/add-to-fedify-init/SKILL.md:
- Around line 37-39: Replace the inline link and plain file paths in the
sentence that mentions WebFrameworkDescription, changing `./init/framework.ts`
and `packages/init/src/types.ts` to wrapped paths (*./init/framework.ts*,
*packages/init/src/types.ts*) and convert the inline link to a reference-style
link (e.g., [init/framework.ts][init-framework]) with the corresponding
reference entry placed at the end of the section; update the sentence to refer
to the reference label and ensure the symbol WebFrameworkDescription remains
mentioned so you can find the exact line to edit.
In `@packages/nuxt/deno.json`:
- Line 24: The "check" npm script currently only runs deno check on "src/*.ts"
which skips nested runtime files (e.g., src/runtime/server/); update the "check"
script (the "check" key value that currently contains "deno fmt --check && deno
lint && deno check src/*.ts") to use a recursive glob such as "src/**/*.ts" or
explicitly include the runtime folder (for example add
"src/runtime/server/**/*.ts") so that deno check covers all nested runtime
TypeScript files.
🪄 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: Repository UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 44c494fa-0e71-490b-ad31-ac3a6bde1a5c
⛔ Files ignored due to path filters (2)
deno.lockis excluded by!**/*.lockpnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (25)
.agents/skills/add-to-fedify-init/SKILL.md.agents/skills/create-example-app-with-integration/SKILL.md.agents/skills/create-example-app-with-integration/example/README.md.agents/skills/create-example-app-with-integration/example/src/logging.ts.agents/skills/create-integration-package/SKILL.md.hongdown.tomlAGENTS.mdCHANGES.mdCONTRIBUTING.mdcspell.jsondeno.jsondocs/manual/integration.mdmise.tomlpackages/fedify/README.mdpackages/nuxt/README.mdpackages/nuxt/deno.jsonpackages/nuxt/package.jsonpackages/nuxt/src/mod.test.tspackages/nuxt/src/mod.tspackages/nuxt/src/runtime/server/lib.tspackages/nuxt/src/runtime/server/logic.tspackages/nuxt/src/runtime/server/middleware.tspackages/nuxt/src/runtime/server/plugin.tspackages/nuxt/tsdown.config.tspnpm-workspace.yaml
- Use @fedify/fixture instead of node:test in mod.test.ts - Type event parameter as H3Event instead of unknown in middleware.ts Co-Authored-By: Claude (claude-opus-4-20250514)
Move NOT_ACCEPTABLE_BODY and DEFERRED_NOT_ACCEPTABLE_CONTEXT_KEY into a shared lib.ts to avoid string duplication across logic.ts and plugin.ts. Co-Authored-By: Claude (claude-opus-4-20250514)
…chema` to `@fedify/nuxt`
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/nuxt/src/mod.ts`:
- Around line 87-93: The current contextFactoryResolver silently treats a
non-function export from contextDataFactoryModule as undefined, causing hidden
misconfiguration; update the resolver logic around contextFactoryResolver to
check whether contextDataFactoryModule.default ??
contextDataFactoryModule.contextDataFactory is present and is a function, and if
it exists but is not a function throw a descriptive Error (mentioning
contextDataFactoryModule and the expected function export) instead of assigning
undefined, otherwise assign the function to contextDataFactory as before.
🪄 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: Repository UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: d6eaeee1-e713-4a85-9ec6-0ff5fd614e21
📒 Files selected for processing (2)
packages/nuxt/deno.jsonpackages/nuxt/src/mod.ts
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
packages/nuxt/src/mod.ts (1)
87-93:⚠️ Potential issue | 🟠 MajorValidate
contextDataFactoryModuleexport type instead of silently ignoring bad config.At Line 90–93, a non-function export is accepted and later treated as
undefined, which hides configuration errors and drops context data unexpectedly.🔧 Proposed fix
const contextFactoryResolver = contextDataFactoryModule == null ? "const contextDataFactory = undefined;" : [ "const contextDataFactory =", " contextFactoryModule.default ??", " contextFactoryModule.contextDataFactory;", + "if (contextDataFactory != null && typeof contextDataFactory !== 'function') {", + " throw new TypeError(", + " '@fedify/nuxt: contextDataFactoryModule must export a function as default export or named export \"contextDataFactory\".',", + " );", + "}", ].join("\n");🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/nuxt/src/mod.ts` around lines 87 - 93, The current resolver silently treats a non-function export from contextDataFactoryModule as undefined; update the contextFactoryResolver logic to validate that the resolved export (contextDataFactoryModule.default ?? contextDataFactoryModule.contextDataFactory) is a function and throw a clear error (or call Nuxt's logger/error) if it's not; specifically, in the code that builds contextFactoryResolver, replace the unconditional assignment to contextDataFactory with a runtime type-check that verifies typeof contextDataFactory === "function" and fails fast referencing contextDataFactoryModule/contextDataFactory to surface misconfiguration instead of silently dropping context data.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.agents/skills/create-integration-package/SKILL.md:
- Line 250: Update the final validation command text that currently reads "mise
run fmt && mise run check" to the repository-standard "mise run fmt && mise
check"; locate the string in SKILL.md (the sentence starting "After
implementation, run") and replace the second invocation "mise run check" without
changing surrounding wording or formatting so the documented convention matches
the CI-style check.
In `@packages/nuxt/src/runtime/server/plugin.ts`:
- Around line 32-43: The current deferred 406 rewrite uses only the final status
(via resolveDeferredNotAcceptable/getResponseStatus) and thus converts
legitimate downstream 404 responses into 406; change the logic to only apply the
negotiated 406 when there is an actual route-miss signal rather than any 404.
Concretely, update the call/site using resolveDeferredNotAcceptable/deferred
(and related code paths) so you first check a route-miss indicator (e.g., a
boolean on deferred such as deferred.routeMiss or an explicit framework "not
found" flag on the event/context) and only proceed to setResponseStatus,
setResponseHeader and payload.body = NOT_ACCEPTABLE_BODY when negotiatedResponse
is non-null AND that route-miss flag is true; leave responses alone when a
downstream handler legitimately returned 404 but the route was matched.
---
Duplicate comments:
In `@packages/nuxt/src/mod.ts`:
- Around line 87-93: The current resolver silently treats a non-function export
from contextDataFactoryModule as undefined; update the contextFactoryResolver
logic to validate that the resolved export (contextDataFactoryModule.default ??
contextDataFactoryModule.contextDataFactory) is a function and throw a clear
error (or call Nuxt's logger/error) if it's not; specifically, in the code that
builds contextFactoryResolver, replace the unconditional assignment to
contextDataFactory with a runtime type-check that verifies typeof
contextDataFactory === "function" and fails fast referencing
contextDataFactoryModule/contextDataFactory to surface misconfiguration instead
of silently dropping context data.
🪄 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: Repository UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: c7d0ca7b-05f4-4d60-9211-cd5a98f3de04
⛔ Files ignored due to path filters (2)
deno.lockis excluded by!**/*.lockpnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (25)
.agents/skills/add-to-fedify-init/SKILL.md.agents/skills/create-example-app-with-integration/SKILL.md.agents/skills/create-example-app-with-integration/example/README.md.agents/skills/create-example-app-with-integration/example/src/logging.ts.agents/skills/create-integration-package/SKILL.md.hongdown.tomlAGENTS.mdCHANGES.mdCONTRIBUTING.mdcspell.jsondeno.jsondocs/manual/integration.mdmise.tomlpackages/fedify/README.mdpackages/nuxt/README.mdpackages/nuxt/deno.jsonpackages/nuxt/package.jsonpackages/nuxt/src/mod.test.tspackages/nuxt/src/mod.tspackages/nuxt/src/runtime/server/lib.tspackages/nuxt/src/runtime/server/logic.tspackages/nuxt/src/runtime/server/middleware.tspackages/nuxt/src/runtime/server/plugin.tspackages/nuxt/tsdown.config.tspnpm-workspace.yaml
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.
Closes #149
Tip
Of the 4,315 lines of additions, 3,349 lines are pnpm-lock.yaml
changes. The actual code to review is under 1,000 lines.
Changes
@fedify/nuxtpackage that provides a Nuxt module integratingFedify into Nitro middleware with deferred
406 Not Acceptablehandling for content negotiation.
Assisted-by: GPT-5.3-codex