epsagon / serverless-package-external

Add external folders to the deploy package 📦

serverless-package-external 📦

Deploy a Serverless Python Function services with external code

Before deploying, this plugin symlinks folders containing shared code into the root directory of your Serverless function. This plugin works also with serverless-offline plugin.

Installation

npm i serverless-package-external --save-dev

Usage

service: service-name

plugins:
  - serverless-package-external

functions:
  # Your functions here

custom:
  packageExternal:
    external:
      - '../common'
      - '../service-a/module'

Example Directory Structure

└── common
    └── resource.py
└── service-a
    └── handler.py
    └── serverless.yml
    └── module
        └── main.py
└── service-b
    └── handler.py
    └── serverless.yml

In handler.py, external code can be imported:

from common.resource import shared_resource

Licensing

serverless-package-external is licensed under the MIT License.

It is originally based on serverless-package-common.

serverless-package-external's Issues

Not working in serverless-offline

from jwt.basic import get_cors_configured_response ModuleNotFoundError: No module named 'jwt.basic'
But the Lambda works when it is deployed.
I'm using python virutal environment while working in offline

EPERM: operation not permitted, scandir

just installed the plugin and currently using it in with windows. and I have encountered this issue with the library.

`Serverless: [serverless-package-external] Symlinking ../shared_code
Serverless: [serverless-package-external] is complete
Serverless: Packaging service...

Error --------------------------------------------------

EPERM: operation not permitted, scandir 'C:\mydir\shared_code'`

serverless-package-external deleted my project folder

Running serverless package with this plugin. it deletes my project folders with unpushed source codes...

This is the only error I got. I don't have any source code to show what config I set LOL.

Serverless: [serverless-package-external] Symlinking utils/**
Serverless: [serverless-package-external] Symlinking keys/**
Serverless: [serverless-package-external] Symlinking gql/**

  Error --------------------------------------------------

  Error: ENOENT: no such file or directory, symlink 'utils/**' -> '/Users/x/xx/xxx-lambda/**'
      at Object.symlinkSync (fs.js:1005:3)
      at /Users/x/xx/xx-lambda/node_modules/serverless-package-external/src/symlink.js:45:10
      at async Promise.all (index 0)

Not creating symlink when deploying just one function

It seems when I'm testing code and I use:

sls deploy function -f someFunction

the plugin doesn't symlink the directory.

How does Serverless-Offline integration work?

The readme indicates the package works with serverless-offline, but I see no indication of any symlinks being created when invoking serverless-offline, nor does importing a local package from elsewhere work (a error about missing module is given). Is there a manual step I'm missing?

The package works fine when actually packaging to deploy, just not for offline testing.

Support for nodejs

In your description it seems like this only works with python, is that correct ?
if this is the case, how about supporting nodejs ?

No symlink when deploying locally

Hi,

Is it possible to symlink the folders when running locally (sls deploy local -f xxxxx)?
Sometimes it's useful to do some tests by deploying directly but with serverless-package-external active I'm unable to deploy local changes.

Thanks

does not work with sls offline (without start)

some plugins like serverless-s3-local , serverless-dynamodb-local follow different lifecycle and they do stop for offline:start:end - the only way to use them is to do sls offline without start param. Also start triggers daemon mode while no start runs offline in pending mode waiting for Ctrl-C which is useful in some cases

to make this great plugin working also without start param there should be added

"before:offline:start": this.beforeDeploy.bind(this)

local testing

Hello,

Is there anyway to test locally with this? Such as running test cases the paths don't resolve since it's only done when packaged.

Thank you

Difference between this and using a lambda layer

Is it better to use a lambda layer?