Node.js应用部署Azure最佳实践及Azure Functions依赖部署疑问

Hey there! Let me walk you through the key details of the recommended approach for deploying your Node.js Azure Functions project—installing dependencies during the build phase and deploying the node_modules directory directly. This is indeed the best practice to avoid the headaches you ran into with serverless plugins.

1. Why Build Dependencies First? #

• Azure Functions' hosting environments (especially the Consumption Plan) have limited resources. Installing dependencies on-the-fly during deployment can cause slow deployments, or even timeouts if the process takes too long.
• It eliminates version mismatches between your local dev environment and Azure's runtime. For native modules (like bcrypt or sharp), which compile against the host OS, building locally for the same OS as Azure (most often Linux now) ensures they work correctly in production.
• Reduces network calls during deployment, making the process more stable and reliable.

2. Step-by-Step Implementation #

Install Dependencies in Your Build Environment #

• First, lock your Node.js version to match Azure's runtime. Check your Function App's configuration in the Azure Portal, then use a .nvmrc or .node-version file to enforce this locally (or in your CI/CD pipeline).
• Run npm install --production for production deployments—this skips devDependencies and keeps your node_modules lean.
• For native modules:
  • If you're using a Linux-based Azure plan, build dependencies in a Linux environment (WSL, a Docker container matching Azure's Ubuntu version, or your CI/CD pipeline's Linux runner). Alternatively, use npm rebuild --target_platform=linux --target_arch=x64 to cross-compile for Azure's environment.

Deploy with node_modules Included #

• Using Azure Functions Core Tools: Run func azure functionapp publish <your-function-app-name>. By default, this will include node_modules unless you've explicitly excluded it in .funcignore—so double-check that file!
• Using CI/CD pipelines (GitHub Actions, Azure DevOps): Add a step to install dependencies during the build stage, then package and deploy the entire project directory (including node_modules) to Azure.

3. Critical Configuration Checks #

• .funcignore file: Make sure node_modules is not listed here. The default .funcignore might include it, so remove that line to ensure the directory gets deployed.
• package.json engines field: Add "node": ">=18.x" (adjust to the version Azure supports for your plan) to enforce version consistency between build and runtime.
• Avoid local links: Don't use npm link for local packages—ensure all dependencies in node_modules are pulled directly from the npm registry, or properly packaged for deployment.

4. Troubleshooting Common Issues #

• Cannot find module errors:
  • Verify node_modules isn't excluded in .funcignore.
  • Confirm your build Node.js version matches Azure's—this is especially critical for native modules.
  • Check that all dependencies in package.json are installed correctly (no missing packages).
• Slow deployments:
  • Use npm install --production to minimize the size of node_modules.
  • Enable caching for node_modules in your CI/CD pipeline to speed up subsequent builds.

内容的提问来源于stack exchange，提问作者Rashad Ibrahimov