sharp: Cannot find module '../build/Release/sharp-{platformAndArch}.node on typescript project

@SayefReyadh I found a good solution that should be added to the sharp docs, I think.

You can set this up quite easily by using the NodejsFunction from aws-cdk-lib/aws-lambda-nodejs. It has esbuild as bundler built in and allows for some useful bundling configurations, which help in this case:

1. You can tell the bundler to keep certain packages in their node_modules file and not bundle them into the final .js file
2. You can force the bundler to always run inside a docker container which aligns with the target architecture. So no need to additionally call SHARP_IGNORE_GLOBAL_LIBVIPS=1 npm install --arch= arm64 --platform=linux --libc=glibc sharp. I tested it with setting the Lambda architecture to Architecture.ARM_64 and it worked

Just as a reminder, this is for cdk Lambda projects using sharp

Here is a code snippet:

new NodejsFunction(this, 'Lambda', {
            role: someRole,
            handler: 'handler',
            entry: 'path/to/handlerFile.ts',
            functionName: 'sharpImageProcessingLambda',
            runtime: Runtime.NODEJS_14_X,
            architecture: Architecture.ARM_64,
            bundling: {
                externalModules: ['aws-sdk', 'sharp'],
                sourceMap: true,
                nodeModules: ['sharp'],
                forceDockerBundling: true
            }
        });

For AWS lambda deployment with Sharp module from win32-x64 OS, the following worked for me when using serverless, esbuild and serverless-esbuild. Changed the serverless.yml file with the below configuration. It is basically telling esbuild to download sharp again with the following --arch=x64 --platform=linux considering your lambda uses x64 arch. Check serverless-esbuild packager and packagerOptions options for more understanding.

esbuild:
    # keep existing configurations
    external:
      - sharp
    packagerOptions:
      scripts:
        - npm install --arch=x64 --platform=linux sharp

Note: If you are using AWS code build for automatic deployment no other additional script was needed for my end. Also, you need to comment out the script npm install --arch=x64 --platform=linux sharp while testing with serverless-offline from win32-x64 OS

@SayefReyadh Thanks for the hint. As far as I can see the mentioned PR is not relevant here. The cdk setup with esbuild seems to be different from serverless.

I managed to get it to work which also made me realized what is missing. Since we have to mark sharp as external dependency with esbuild, we have to make sure the lib the present in the lambda function. For this I had to change the Lambda setup in cdk from using a single js file (which was the whole point for using esbuild) to create an S3 asset with all the files (including the node_modules). In the end I did a hybrid version. I created the single js file bundle with esbuild but excluded sharp and then added another package.json that only has sharp as dependency to create a node_modules only with sharp and its dependencies (I then also had to run the code that installs sharp for the right target architecture) and upload all of that to S3 as my Lambda code.

Not a great solution, I think. Ideally I would like to just use esbuild without marking sharp as external but I guess that is not possible due to the compiled source files. Another option would be to offer a lambda layer with sharp and all it’s dependencies installed. I saw that people created this but it wasn’t very well maintained. Would be better to offer this from the main maintainer.

Thank you, this pins down the challenge I was having. Thank you for your amazing library!

I’ve just added a section to the docs (not published yet) about use with esbuild - see https://github.com/lovell/sharp/blob/main/docs/install.md#esbuild