Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@react-pdf/renderer doesn't work when used in React Server Components #61313

Closed
wojtekmaj opened this issue Jan 29, 2024 · 1 comment · Fixed by #61317
Closed

@react-pdf/renderer doesn't work when used in React Server Components #61313

wojtekmaj opened this issue Jan 29, 2024 · 1 comment · Fixed by #61317
Labels
bug Issue was opened via the bug report template. invalid link The issue was auto-closed due to a missing/invalid reproduction link. A new issue should be opened.

Comments

@wojtekmaj
Copy link
Contributor

Link to the code that reproduces this issue

see below

To Reproduce

API:

route.ts:

import { NextResponse } from 'next/server';

import getPdf from './pdf';

export async function GET() {
  const pdf = await getPdf();

  return new NextResponse(pdf, {
    headers: {
      'Content-Type': 'application/pdf',
    },
  });
}

pdf.tsx:

import { Document, Page, Text, renderToBuffer } from '@react-pdf/renderer';

export default function getPdf() {
  return renderToBuffer(
    <Document>
      <Page>
        <Text>Hello world</Text>
      </Page>
    </Document>,
  );
}

Current vs. Expected behavior

Current:

 ✓ Ready in 1085ms
 ○ Compiling /api/pdf ...
 ✓ Compiled /api/pdf in 1569ms (163 modules)
 ⨯ TypeError: ba.Component is not a constructor
    at $$$reconciler (webpack-internal:///(rsc)/./node_modules/@react-pdf/renderer/lib/react-pdf.js:648:50)
    at createRenderer (webpack-internal:///(rsc)/./node_modules/@react-pdf/renderer/lib/react-pdf.js:3906:12)
    at pdf (webpack-internal:///(rsc)/./node_modules/@react-pdf/renderer/lib/react-pdf.js:4115:28)
    at _callee$ (webpack-internal:///(rsc)/./node_modules/@react-pdf/renderer/lib/react-pdf.js:4310:32)
    at tryCatch (webpack-internal:///(rsc)/./node_modules/@babel/runtime/helpers/regeneratorRuntime.js:36:24)
    at Generator.eval (webpack-internal:///(rsc)/./node_modules/@babel/runtime/helpers/regeneratorRuntime.js:123:25)
    at Generator.eval [as next] (webpack-internal:///(rsc)/./node_modules/@babel/runtime/helpers/regeneratorRuntime.js:64:29)
    at asyncGeneratorStep (webpack-internal:///(rsc)/./node_modules/@babel/runtime/helpers/asyncToGenerator.js:4:28)
    at _next (webpack-internal:///(rsc)/./node_modules/@babel/runtime/helpers/asyncToGenerator.js:22:17)
    at eval (webpack-internal:///(rsc)/./node_modules/@babel/runtime/helpers/asyncToGenerator.js:27:13)
    at new Promise (<anonymous>)
    at eval (webpack-internal:///(rsc)/./node_modules/@babel/runtime/helpers/asyncToGenerator.js:19:16)
    at renderToStream (webpack-internal:///(rsc)/./node_modules/@react-pdf/renderer/lib/react-pdf.js:4323:21)
    at renderToBuffer (webpack-internal:///(rsc)/./node_modules/@react-pdf/renderer/lib/react-pdf.js:4363:12)
    at getPdf (webpack-internal:///(rsc)/./src/app/api/pdf/pdf.tsx:11:79)
    at GET (webpack-internal:///(rsc)/./src/app/api/pdf/route.ts:10:71)
    at /Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/compiled/next-server/app-route.runtime.dev.js:6:63815
    at /Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/server/lib/trace/tracer.js:133:36
    at NoopContextManager.with (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:7062)
    at ContextAPI.with (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:518)
    at NoopTracer.startActiveSpan (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:18093)
    at ProxyTracer.startActiveSpan (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:18854)
    at /Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/server/lib/trace/tracer.js:122:103
    at NoopContextManager.with (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:7062)
    at ContextAPI.with (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:518)
    at NextTracerImpl.trace (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/server/lib/trace/tracer.js:122:28)
    at /Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/compiled/next-server/app-route.runtime.dev.js:6:56866
    at AsyncLocalStorage.run (node:async_hooks:346:14)
    at Object.wrap (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/compiled/next-server/app-route.runtime.dev.js:6:37102)
    at /Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/compiled/next-server/app-route.runtime.dev.js:6:54639
    at AsyncLocalStorage.run (node:async_hooks:346:14)
    at Object.wrap (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/compiled/next-server/app-route.runtime.dev.js:6:36351)
    at /Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/compiled/next-server/app-route.runtime.dev.js:6:54601
    at AsyncLocalStorage.run (node:async_hooks:346:14)
    at eU.execute (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/compiled/next-server/app-route.runtime.dev.js:6:53994)
    at eU.handle (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/compiled/next-server/app-route.runtime.dev.js:6:65073)
    at doRender (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/server/base-server.js:1333:60)
    at cacheEntry.responseCache.get.routeKind (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/server/base-server.js:1555:34)
    at ResponseCache.get (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/server/response-cache/index.js:49:26)
    at DevServer.renderToResponseWithComponentsImpl (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/server/base-server.js:1463:53)
    at /Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/server/base-server.js:992:121
    at NextTracerImpl.trace (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/server/lib/trace/tracer.js:104:20)
    at DevServer.renderToResponseWithComponents (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/server/base-server.js:992:41)
    at DevServer.renderPageComponent (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/server/base-server.js:1856:35)
    at async DevServer.renderToResponseImpl (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/server/base-server.js:1894:32)
    at async DevServer.pipeImpl (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/server/base-server.js:911:25)
    at async NextNodeServer.handleCatchallRenderRequest (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/server/next-server.js:271:17)
    at async DevServer.handleRequestImpl (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/server/base-server.js:807:17)
    at async /Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/server/dev/next-dev-server.js:331:20
    at async Span.traceAsyncFn (/Users/wmaj/Projekty/Neste/RRTPartnerPortal/node_modules/next/dist/trace/trace.js:151:20)

Expected:
PDF with "Hello world" displayed.

Provide environment information

Operating System:
  Platform: darwin
  Arch: arm64
  Version: Darwin Kernel Version 23.2.0: Wed Nov 15 21:59:33 PST 2023; root:xnu-10002.61.3~2/RELEASE_ARM64_T8112
Binaries:
  Node: 20.9.0
  npm: 10.1.0
  Yarn: 4.0.2
  pnpm: N/A
Relevant Packages:
  next: 14.1.0
  eslint-config-next: 14.0.0
  react: 18.2.0
  react-dom: 18.2.0
  typescript: 5.3.2
Next.js Config:
  output: N/A

Which area(s) are affected? (Select all that apply)

App Router

Which stage(s) are affected? (Select all that apply)

next dev (local)

Additional context

  experimental: {
    serverComponentsExternalPackages: ['@react-pdf/renderer'],
  },

Fixes that, as @react-pdf/renderer depends on certain React features that were stripped from RSC.

@wojtekmaj wojtekmaj added the bug Issue was opened via the bug report template. label Jan 29, 2024
@github-actions github-actions bot added the invalid link The issue was auto-closed due to a missing/invalid reproduction link. A new issue should be opened. label Jan 29, 2024
Copy link
Contributor

We could not detect a valid reproduction link. Make sure to follow the bug report template carefully.

Why was this issue closed?

To be able to investigate, we need access to a reproduction to identify what triggered the issue. We need a link to a public GitHub repository (template for App Router, template for Pages Router), but you can also use these templates: CodeSandbox: App Router or CodeSandbox: Pages Router.

The bug template that you filled out has a section called "Link to the code that reproduces this issue", which is where you should provide the link to the reproduction.

  • If you did not provide a link or the link you provided is not valid, we will close the issue.
  • If you provide a link to a private repository, we will close the issue.
  • If you provide a link to a repository but not in the correct section, we will close the issue.

What should I do?

Depending on the reason the issue was closed, you can do the following:

  • If you did not provide a link, please open a new issue with a link to a reproduction.
  • If you provided a link to a private repository, please open a new issue with a link to a public repository.
  • If you provided a link to a repository but not in the correct section, please open a new issue with a link to a reproduction in the correct section.

In general, assume that we should not go through a lengthy onboarding process at your company code only to be able to verify an issue.

My repository is private and cannot make it public

In most cases, a private repo will not be a sufficient minimal reproduction, as this codebase might contain a lot of unrelated parts that would make our investigation take longer. Please do not make it public. Instead, create a new repository using the templates above, adding the relevant code to reproduce the issue. Common things to look out for:

  • Remove any code that is not related to the issue. (pages, API routes, components, etc.)
  • Remove any dependencies that are not related to the issue.
  • Remove any third-party service that would require us to sign up for an account to reproduce the issue.
  • Remove any environment variables that are not related to the issue.
  • Remove private packages that we do not have access to.
  • If the issue is not related to a monorepo specifically, try to reproduce the issue without a complex monorepo setup

I did not open this issue, but it is relevant to me, what can I do to help?

Anyone experiencing the same issue is welcome to provide a minimal reproduction following the above steps by opening a new issue.

I think my reproduction is good enough, why aren't you looking into it quickly?

We look into every Next.js issue and constantly monitor open issues for new comments.

However, sometimes we might miss one or two due to the popularity/high traffic of the repository. We apologize, and kindly ask you to refrain from tagging core maintainers, as that will usually not result in increased priority.

Upvoting issues to show your interest will help us prioritize and address them as quickly as possible. That said, every issue is important to us, and if an issue gets closed by accident, we encourage you to open a new one linking to the old issue and we will look into it.

Useful Resources

@github-actions github-actions bot locked and limited conversation to collaborators Jan 29, 2024
ijjk added a commit that referenced this issue Feb 4, 2024
<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change
-->

### What?

Fixes @react-pdf/renderer not working in RSC.

### Why?

Next.js RSC version of React does not include features necessary for
@react-pdf/renderer to work.

### How?

Adding @react-pdf/renderer to serverComponentsExternalPackages by
default.

Fixes #61313

Co-authored-by: JJ Kasper <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Issue was opened via the bug report template. invalid link The issue was auto-closed due to a missing/invalid reproduction link. A new issue should be opened.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant