Calling serverless deploy with a --package flag argument starting with ./ does not work

[stephaneseng]

This is a Bug Report

Description

Calling serverless deploy with a --package flag argument starting with ./ does not work.

Here are the steps to reproduce this issue:

$ serverless create --template aws-nodejs
$ serverless package --package ./my-artifacts

$ tree
.
├── handler.js
├── my-artifacts
│   ├── cloudformation-template-create-stack.json
│   ├── cloudformation-template-update-stack.json
│   ├── sandbox-serverless.zip
│   └── serverless-state.json
└── serverless.yml

$ serverless deploy --package ./my-artifacts
 
  Serverless Error ---------------------------------------
 
  No serverless-state.json file found in the package path you provided.
 
  Get Support --------------------------------------------
     Docs:          docs.serverless.com
     Bugs:          github.com/serverless/serverless/issues
     Issues:        forum.serverless.com
 
  Your Environment Information ---------------------------
     Operating System:          linux
     Node Version:              10.16.2
     Serverless Version:        1.49.0
     Enterprise Plugin Version: 1.3.8
     Platform SDK Version:      2.1.0

However, serverless deploy --package my-artifacts works fine.

Cause

An unexpected behavior occurs when serverless tries to copy the already packaged artifacts from ./my-artificats in this case to the .serverless temporary folder, before the deploy.

This copy is triggered by the following calls:

• In the before:deploy:deploy hook, the aws:common:moveArtifactsToTemp is spawned: https://github.com/serverless/serverless/blob/v1.49.0/lib/plugins/aws/deploy/index.js#L83
• Which calls moveArtifactsToTemp(): https://github.com/serverless/serverless/blob/v1.49.0/lib/plugins/aws/common/index.js#L57
• Which calls copyDirContentsSync(): https://github.com/serverless/serverless/blob/v1.49.0/lib/plugins/aws/common/lib/artifacts.js#L47
• Which is implemented in copyDirContentsSync.js: https://github.com/serverless/serverless/blob/v1.49.0/lib/utils/fs/copyDirContentsSync.js

function fileExists(srcDir, destDir, options) {
  const fullFilesPaths = walkDirSync(srcDir, options);

  fullFilesPaths.forEach(fullFilePath => {
    const relativeFilePath = fullFilePath.replace(srcDir, '');
    fse.copySync(fullFilePath, path.join(destDir, relativeFilePath));
  });
}

With --package ./my-artifacts, this copy result in the following file structure:

$ tree ./.serverless/
./.serverless/
└── my-artifacts
    ├── cloudformation-template-create-stack.json
    ├── cloudformation-template-update-stack.json
    ├── sandbox-serverless.zip
    └── serverless-state.json

This differs with how the resulting file structure looks with --package my-artifacts:

$ tree ./.serverless/
./.serverless/
├── cloudformation-template-create-stack.json
├── cloudformation-template-update-stack.json
├── sandbox-serverless.zip
└── serverless-state.json

This is because, when --package ./my-artifacts is called, when attempting to copy the serverless-state.json file, fse.copySync(fullFilePath, path.join(destDir, relativeFilePath)) is invoked in the following context:

• fullFilePath = my-artifacts/serverless-state.json
• destDir = /tmp/my-project/.serverless
• relativeFilePath = my-artifacts/serverless-state.json
• srcDir = ./my-artifacts

Here, the intent was to have relativeFilePath = serverless-state.json but serverless could not remove srcDir = ./my-artifacts from
fullFilePath = my-artifacts/serverless-state.json.

Resolution proposal

This issue can be solved by calling https://github.com/jprichardson/node-fs-extra/blob/8.1.0/docs/copy-sync.md directly on the directories to copy from and to instead of calling it on the files to copy individually.

Similar or dependent issues

Issue with the same root cause:

• Windows deploy --package does not handle slashes in path (or in package.path of serverless.yml) #5172: Windows deploy --package does not handle slashes in path (or in package.path of serverless.yml)

Issues related to the serverless-state.json file path but I am unsure that these are due to the same root cause:

• sls deploy --package <package path> cannot find serverless-state.json if package is not under .serverless directory #5381: sls deploy --package cannot find serverless-state.json if package is not under .serverless directory
• Deploy is using the wrong path to read serverless-state.json #6179: Deploy is using the wrong path to read serverless-state.json

Additional data

• Serverless Framework Version: 1.49.0 (Enterprise Plugin: 1.3.8, Platform SDK: 2.1.0)
• Operating System: Ubuntu 18.04.3