Trouble with specific npm module dependency in Node Function

Sorry to hear you had trouble with TypeScript with Functions. I was able to reproduce the issue you encountered by creating projects with the starter template and changing them in the way you describe. When I used the starter TypeScript template to deploy a function that used just @aws-sdk/client-s3, it worked. And when I used that same template to deploy a function used just @protobuf-ts/runtime, it didn’t work, with the exact same error message you posted here. I was also able to get a function working using @protobuf-ts/runtime by changing a few files.

This is happening because the starter template includes just enough to get you going. In this case, it’s enough for when your function consists of one TypeScript file. This consists of the default TypeScript compiler settings, which output the single built file into the lib directory, the .include file which ensures that doctl includes that directory and only that directory in what’s uploaded to our servers during a deployment, and the line "main": "lib/index.js" in package.json, which tells our runtime to look in that directory for the file it should import to run your function.

But your project has outgrown this starter template. You’re using an NPM library. So you need to update a few things to make this work:

1. Update the .include file to reflect what now needs to be included in the artifact uploaded to our servers during the deployment. Add the lines node_modules (so that your NPM library is included) and package.json (because function upload artifacts that both consist of more than one file and use NPM libraries must include a package.json file at the top level).

2. Rename the hello.ts file to index.ts and update package.json to change "main": "lib/hello.js", to "main": "lib/index.js", (because function upload artifacts that both consist of more than one file and use NPM libraries must have an entry point named index.js or index.mjs).

3. Increase the memory higher than the default 256 MB (I found that for this particular library, 256 MB was not enough for the function to run and import this code successfully).

You did not have to complete these steps when you were trying this with @aws-sdk/client-s3 because that NPM library happens to be included already in our runtime. So doctl was uploading just the hello.js file, which had the line const client_s3_1 = require("@aws-sdk/client-s3");, which had no problem being executed because the library was already on the runtime and could be imported that way.

I understand this could be confusing because this isn’t in our product documentation. We don’t officially support these included libraries. We plan to begin officially supporting libraries included in the runtimes so that customers can use them in their functions without them contributing to the 48 MB function size limit. For Node.js, this could happen when we publish the Node.js 20 runtime. We don’t yet have a planned date for publishing this runtime. Keep an eye on Functions release notes for that.

One thing I want to add is that what helped me troubleshoot this was using the --remote-build flag while I deployed the function. This is an optional way to deploy standalone functions, and it’s the only way to deploy functions when you deploy them using App Platform. When you deploy this way, instead of the build taking place on your computer and then the built code being uploaded to our servers, the source code is first uploaded to our servers and then the build takes place there. This helps you troubleshoot that your .include file is correct, because it needs to be correct in order for all of the required source code files to be included in what is uploaded when the deployment begins.