chore(aws-lambda): fixed and improved zip utility (#1608)

Extracted from #1315

- fixed bugs, cleaned up and clarified

Author: kirrg001

packages/aws-lambda/lambdas/README.md

@@ -3,10 +3,19 @@ Example Lambdas
 
 Contains a few trivial example lambdas, mainly used to set up quick experiments.
 
+Manually creating the empty Lambda function
+-------------------------------------------
+
+First, you need to manually create the lambda function in the target region. 
+The name of the new function and the name of the zip file needs to match.
+
 
 Building The Lambda Zip Files
 -----------------------------
 
+Add `.dont-add-npm-instana` file to the target folder to avoid adding the Instana npm packages and to use the layer instead.
+
+Go to `cd packages/aws-lambda`.
 Run `bin/create-zip.sh <lambda-folder-name>` to create deployment zip files for one of Lambda functions in this folder. The resulting zip files can be found in the `zip` subfolder. They can be uploaded to AWS as Lambda functions. There is also a script to deploy the resulting zip file via the `aws` command line tool.
 
 The environment variable `BUILD_LAMBDAS_WITH` controls how the Lambda zip files are being built:
@@ -21,11 +30,11 @@ Deploying Lambda Zip Files
 
 Before you deploy zip files, you need to actually build them, see above.
 
-Use `bin/deploy-zip.sh <lambda-folder-name>` to deploy a Lambda zip files. They will be deployed to region `us-east-2` by default. You can repeat that step as often as you like if the Lambda code has changed or you want to deploy zip files with a more recent npm package/local package/Lambda layer.
+Use `bin/deploy-zip.sh <zip-file>` to deploy a Lambda zip files. They will be deployed to region `us-east-2` by default. You can repeat that step as often as you like if the Lambda code has changed or you want to deploy zip files with a more recent npm package/local package/Lambda layer.
 
 If you have built the zip files with `BUILD_LAMBDAS_WITH=layer`, the script will try to add the Lambda layer "instana-nodejs" to the deployed Lambda function. The script will try to figure out the latest version of the Instana Node.js Lambda layer. Alternatively, you can also use `LAYER_VERSION` and `LAYER_ARN` to specifiy which layer you want to have added. Checkout the latest layers here: https://www.ibm.com/docs/en/instana-observability/current?topic=lambda-aws-native-tracing-nodejs
 
-E.g. run something like `LAYER_VERSION=167 LAYER_ARN=arn:aws:lambda:ap-southeast-1:767398002385:layer:instana-nodejs:167 bin/deploy-zip.sh`.
+E.g. run something like `LAYER_VERSION=167 LAYER_ARN=arn:aws:lambda:ap-southeast-1:767398002385:layer:instana-nodejs:167 bin/deploy-zip.sh <zip-file>`.
 
 Note that if you have use `BUILD_LAMBDAS_WITH=npm` or `BUILD_LAMBDAS_WITH=local` and the function already has the Instana Lambda layer, the deploy script will try to remove it and revert the handler back to `index.handler`.
 

packages/aws-lambda/lambdas/bin/create-zip-util

@@ -1,6 +1,6 @@
 function createZip {
   name=${PWD##*/}
-  echo "creating $name.zip"
+  echo "create-zip-util: $name.zip with build option '$BUILD_LAMBDAS_WITH'"
   rm -f $name.zip
   mkdir -p ../zip
   rm -f ../zip/$name.zip
@@ -16,7 +16,12 @@ function createZip {
       cp package-lock.json package-lock.json.backup
     fi
 
-    if [[ "${BUILD_LAMBDAS_WITH-}" == "layer" ]]; then
+    # if package-lock.json.backup exists, the script crashed. Bring it back
+    if [[ -f package-lock.json.backup ]]; then
+      cp package-lock.json.backup package-lock.json
+    fi
+
+    if [[ "${BUILD_LAMBDAS_WITH}" == "layer" ]]; then
       # We want to use the lambda layer and not the locally build npm package tar file.
       # If the lambda's package.json currently contains a dependency to the local tar files, like:
       # "dependencies": {
@@ -30,7 +35,7 @@ function createZip {
       npm uninstall --production -S @instana/serverless
       npm uninstall --production -S instana-aws-lambda-auto-wrap
 
-    elif [[ "${BUILD_LAMBDAS_WITH-}" == "local" ]]; then
+    elif [[ "${BUILD_LAMBDAS_WITH}" == "local" ]]; then
       # The lambda's package.json might or might not already have a dependency to the local tar files:
       # "dependencies": {
       #   "@instana/aws-lambda": "file:../../instana-aws-lambda.tgz",
@@ -44,12 +49,14 @@ function createZip {
       # We have to remove the lock file otherwise the integrity will fail.
       rm package-lock.json
 
+      echo "Installing local instana packages in folder $PWD"
+
       npm --loglevel=warn --production install -S "../../instana-core.tgz"
       npm --loglevel=warn --production install -S "../../instana-aws-lambda-auto-wrap.tgz"
       npm --loglevel=warn --production install -S "../../instana-aws-lambda.tgz"
       npm --loglevel=warn --production install -S "../../instana-serverless.tgz"
 
-    elif [[ "${BUILD_LAMBDAS_WITH-npm}" == "npm" ]]; then
+    elif [[ "${BUILD_LAMBDAS_WITH}" == "npm" ]]; then
       # The lambda's package.json might or might not already have a dependency to the local tar files:
       # "dependencies": {
       #   "@instana/serverless": "file:../../instana-serverless.tgz",

packages/aws-lambda/lambdas/bin/create-zip.sh

@@ -7,7 +7,7 @@
 
 set -eEuo pipefail
 
-cd `dirname $BASH_SOURCE`/..
+cd `dirname $BASH_SOURCE`/.. && pwd
 
 pushd .. > /dev/null
 
@@ -27,47 +27,48 @@ rm -rf instana-aws-lambda*.tgz
 # - BUILD_LAMBDAS_WITH=layer
 # See ../README.md for details.
 
-# Note: ${BUILD_LAMBDAS_WITH-xyz} -> default expansion with default xyz, to avoid bash error "unbound variable"
-# when set -u is active.
-
 echo
 echo NOTE: When switching between BUILD_LAMBDAS_WITH=layer on one hand and BUILD_LAMBDAS_WITH=npm or BUILD_LAMBDAS_WITH=local on the other hand, you might need to add \(or remove\) instana.wrap\(\) to \(from\) the individual Lambda handler functions!
 echo
 
 echo Building all local tar.gz files.
 
-if [[ -z "${BUILD_LAMBDAS_WITH-}" ]]; then
-  echo "Environmant variable BUILD_LAMBDAS_WITH has not been provided, assuming \"npm\" (build with latest npm package)."
+if [[ -z "${BUILD_LAMBDAS_WITH}" ]]; then
+  echo "Environment variable BUILD_LAMBDAS_WITH has not been provided, assuming \"local\"."
+  BUILD_LAMBDAS_WITH=local
 fi
 
 # We will want to install/uninstall local npm package tar files, which means we need to build them first. Note: Even for
 # options BUILD_LAMBDAS_WITH=layer or BUILD_LAMBDAS_WITH=npm, we need to build the packages, because we for all three
 # packages we will call "npm uninstall -S $package-name"  and if the package.json points to the tar file it needs
 # to exist so npm can uninstall it and all its transitive dependencies.
+
+version=$(jq -r '.version' package.json)
+
 echo "Building local tar.gz for @instana/serverless."
 cd ../serverless
 npm --loglevel=warn pack
-mv instana-serverless-*.tgz ../aws-lambda/instana-serverless.tgz
+mv instana-serverless-${version}.tgz ../aws-lambda/instana-serverless.tgz
 
 echo "Building local tar.gz for @instana/core."
 cd ../core
 npm --loglevel=warn pack
-mv instana-core-*.tgz ../aws-lambda/instana-core.tgz
+mv instana-core-${version}.tgz ../aws-lambda/instana-core.tgz
 
 echo "Building local tar.gz for @instana/aws-lambda."
 cd ../aws-lambda
 npm --loglevel=warn pack
-mv instana-aws-lambda-*.tgz instana-aws-lambda.tgz
+mv instana-aws-lambda-${version}.tgz instana-aws-lambda.tgz
 
 echo "Building local tar.gz for instana-aws-lambda-auto-wrap."
 cd ../aws-lambda-auto-wrap
 npm --loglevel=warn pack
-mv instana-aws-lambda-auto-wrap*.tgz ../aws-lambda/instana-aws-lambda-auto-wrap.tgz
+mv instana-aws-lambda-auto-wrap-${version}.tgz ../aws-lambda/instana-aws-lambda-auto-wrap.tgz
 cd ../aws-lambda
 
-if [[ "${BUILD_LAMBDAS_WITH-npm}" == "npm" ]]; then
+if [[ "${BUILD_LAMBDAS_WITH}" == "npm" ]]; then
   echo "Building Lambda zip file(s) with the latest npm packages."
-elif [[ "${BUILD_LAMBDAS_WITH-}" == "local" ]]; then
+elif [[ "${BUILD_LAMBDAS_WITH}" == "local" ]]; then
   echo "Building Lambda zip file(s) with the local tar.gz files."
 elif [[ "$BUILD_LAMBDAS_WITH" == "layer" ]]; then
   echo "Building Lambda zip file(s) without @instana/aws-lambda, assuming the AWS Lambda layer \"instana-nodejs\" is (or will be) configured."
@@ -79,10 +80,11 @@ fi
 
 popd > /dev/null
 
-echo "Creating $1.zip"
+echo "Creating $1.zip with build option $BUILD_LAMBDAS_WITH."
+
 lambda_directory=$1
 if [[ -d "$lambda_directory" && ! -L "$lambda_directory" && -e "$lambda_directory/bin/create-zip.sh" ]]; then
-  $lambda_directory/bin/create-zip.sh
+  BUILD_LAMBDAS_WITH=$BUILD_LAMBDAS_WITH $lambda_directory/bin/create-zip.sh
 else
   echo "Cannot create zip file for $lambda_directory, either the directory does not exist or is a symlink or it has no bin/create-zip.sh script."
 fi