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

How to use Sharp library in API with Vercel? #60409

Closed
1 task done
rwecho opened this issue Jan 9, 2024 · 3 comments
Closed
1 task done

How to use Sharp library in API with Vercel? #60409

rwecho opened this issue Jan 9, 2024 · 3 comments
Labels
bug Issue was opened via the bug report template. please add a complete reproduction The issue lacks information for further investigation Runtime Related to Node.js or Edge Runtime with Next.js.

Comments

@rwecho
Copy link

rwecho commented Jan 9, 2024

Link to the code that reproduces this issue

https://github.com/rwecho/portal

To Reproduce

I reference the Sharp library by pnpm add sharp and enable the API to resize the image with it.

It's working well locally. But when I deployed it to the Vercel, the API returned with 500 status.

The detailed log:

image

Error: Could not load the "sharp" module using the linux-x64 runtime

I searched for the issue, and could not distinguish that the sharp library is build-in.

Current vs. Expected behavior

In the app, we can use the Image component to optimize the image, how to handle it in API? thanks

Verify canary release

  • I verified that the issue exists in the latest Next.js canary release

Provide environment information

The vercel environment, how to get the vercel info?

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

Middleware / Edge (API routes, runtime)

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

Vercel (Deployed)

Additional context

No response

@rwecho rwecho added the bug Issue was opened via the bug report template. label Jan 9, 2024
@github-actions github-actions bot added the Runtime Related to Node.js or Edge Runtime with Next.js. label Jan 9, 2024
@Cow258
Copy link
Contributor

Cow258 commented Jan 15, 2024

// next.config.js
const nextConfig = {
  webpack: (cfg, options = {}) => {
    cfg.externals.push('sharp')
    const { webpack } = options
    const regex = /^sharp$/
    cfg.plugins.push(new webpack.IgnorePlugin({
      resourceRegExp: regex,
    }))
  }
}

p.s. sharp unable to run on Edge runtime, sharp only can run on serverless function

@mwawrusch
Copy link

mwawrusch commented Aug 1, 2024

Ran into this again today, with a working system (and using the workaround from above to no avail).

@samcx samcx added the please add a complete reproduction The issue lacks information for further investigation label Sep 25, 2024
Copy link
Contributor

We cannot recreate the issue with the provided information. Please add a reproduction in order for us to be able to investigate.

Why was this issue marked with the please add a complete reproduction label?

To be able to investigate, we need access to a reproduction to identify what triggered the issue. We prefer 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.

To make sure the issue is resolved as quickly as possible, please make sure that the reproduction is as minimal as possible. This means that you should remove unnecessary code, files, and dependencies that do not contribute to the issue. Ensure your reproduction does not depend on secrets, 3rd party registries, private dependencies, or any other data that cannot be made public. Avoid a reproduction including a whole monorepo (unless relevant to the issue). The easier it is to reproduce the issue, the quicker we can help.

Please test your reproduction against the latest version of Next.js (next@canary) to make sure your issue has not already been fixed.

If you cannot create a clean reproduction, another way you can help the maintainers' job is to pinpoint the canary version of next that introduced the issue. Check out our releases, and try to find the first canary release that introduced the issue. This will help us narrow down the scope of the issue, and possibly point to the PR/code change that introduced it. You can install a specific version of next by running npm install next@<version>.

I added a link, why was it still marked?

Ensure the link is pointing to a codebase that is accessible (e.g. not a private repository). "example.com", "n/a", "will add later", etc. are not acceptable links -- we need to see a public codebase. See the above section for accepted links.

What happens if I don't provide a sufficient minimal reproduction?

Issues with the please add a complete reproduction label that receives no meaningful activity (e.g. new comments with a reproduction link) are automatically closed and locked after 30 days.

If your issue has not been resolved in that time and it has been closed/locked, please open a new issue with the required reproduction.

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. Furthermore, you can upvote the issue using the 👍 reaction on the topmost comment (please do not comment "I have the same issue" without reproduction steps). Then, we can sort issues by votes to prioritize.

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

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

@samcx samcx closed this as completed Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issue was opened via the bug report template. please add a complete reproduction The issue lacks information for further investigation Runtime Related to Node.js or Edge Runtime with Next.js.
Projects
None yet
Development

No branches or pull requests

4 participants