fix: adapt to serverless artifact validation introduced in v2.51.1

BREAKING CHANGE: bundling flow modified, may affect older versions

Author: nolde

README.md

@@ -7,8 +7,9 @@ Serverless Browserifier Plugin
 [![NPM downloads][downloads-badge]][npm-url]
 [![standardjs][standardjs-badge]][standardjs-url]
 
-> A [Serverless](https://serverless.com) v1 plugin that uses [`browserify`][browserify-url] to bundle your Node.js Lambda functions.
+> A [Serverless](https://serverless.com) v1 and v2 plugin that uses [`browserify`][browserify-url] to bundle your Node.js Lambda functions.
 
+1. [Supported Commands](#supported-commands)
 1. [Motivation](#motivation)
 1. [Installation](#installation)
 1. [Basic Setup](#basic-setup)
@@ -18,6 +19,16 @@ Serverless Browserifier Plugin
 1. [License](#license)
 
 
+Supported Commands
+------------------
+
+- `serverless package`
+- `serverless deploy`
+- `serverless deploy function`
+- `serverless invoke local`
+    + the plugin will automatically build and use your bundle to execute the function locally; to avoid it, you can use the `--no-build` option, which will then use your handler file directly
+
+
 Motivation
 ----------
 
@@ -80,14 +91,17 @@ The base config can be overridden on a function-by-function basis.  Again, `cust
 custom:
   browserify:
     # any option defined in https://github.com/substack/node-browserify#browserifyfiles--opts
+    extensions:
+      - .js # default
 
 functions:
   usersGet:
     description: Get users
     handler: users/index.handler
     browserify:
+      # any option defined in https://github.com/substack/node-browserify#browserifyfiles--opts
       noParse:
-        - ./someBig.json  #browserify can't optimize json, will take long time to parse for nothing
+        - ./someBig.json  # browserify can't optimize json, will take long time to parse for nothing
 ```
 
 If you find a package that is not supported or does not behave well with browserify, you can still use function level `package.include` to include extra modules and files to your package. That said, you are encouraged to verify if you specific case can be dealt with by leveraging all available [browserify options][browserify-options] in your `serverless.yml` custom `browserify` section.
@@ -120,7 +134,7 @@ When this plugin is enabled, and `package.individually` is `true`, running `serv
 If you want to see more information about the process, simply set envvar `SLS_DEBUG=*` for full serverless debug output, or `SLS_BROWSERIFIER_DEBUG=*` for plugin only debug messages. Example:
 
 ```
-$ export SLS_DEBUG=*
+$ export SLS_BROWSERIFIER_DEBUG=*
 $ sls deploy function -v -f usersGet
 ```
 
@@ -174,7 +188,7 @@ const S3 = require('aws-sdk/clients/s3')
 const s3 = new S3()
 ```
 
-#### Ignore AWS SDK!
+#### Ignore AWS SDK v2!
 
 Although you can use discrete clients (see item above), AWS Lambda service always bundles up the latest SDK version in its Lambda container image. That means that, even if you don't add AWS SDK to your bundle, it will still be available in runtime.
 
@@ -194,7 +208,7 @@ To help you out, here's a script you can use to hide `aws-sdk` and all its clien
 # serverless.yml
 
 custom:
-  browserify: browserify: ${file(./custom.browserify.js)}
+  browserify: ${file(./custom.browserify.js)}
 ```
 
 ```js
@@ -230,9 +244,9 @@ __What about uglification? And babel?__
 
 You should be able to use [`uglify-es`][uglify-url] through [`uglifyify`][uglifyify-url]. For babel usage, [`babelify`][babelify-url] should do the trick. Refer back to [_Using browserify plugins_](#using-browserify-pluginstransforms) section to set it up.
 
-__Avoid mixing this plugin with other plugins that modify serverless' packaging behaviour!__
+__This other plugin I use is not playing ball with `serverless-plugin-browserifier`! What's up?__
 
-This plugin _hijacks_ the normal serverless packaging process, so it will probably conflict with other plugins that use similar mechanisms.
+This plugin _hijacks_ the normal serverless packaging process, so it will probably conflict with other plugins that use similar mechanisms. Please avoid mixing this plugin with other plugins that modify serverless' packaging behaviour.
 
 
 Useful Information

lib/bundle.js

@@ -1,14 +1,15 @@
 'use strict'
 
-const Promise = require('bluebird')
+const path = require('path')
+const Bb = require('bluebird')
 
 const archiver = require('archiver')
 const browserify = require('browserify')
 const filesize = require('filesize')
 const globby = require('globby')
-const path = require('path')
 const semver = require('semver')
 
+const errors = require('./errors')
 const fs = require('./fs')
 
 /// //////////////////////// exports && main functions
@@ -19,29 +20,33 @@ module.exports = {
 }
 
 function bundle (functionName) {
-  const data = this._b.functionConfigCache[functionName]
-  if (!data) {
-    return Promise.resolve()
+  if (this._b.debugOn) {
+    this._s.cli.log(`Browserifier: Bundling "${functionName}"...`)
   }
-  return Promise.bind(this)
-    .return(data)
-    .then(clean)
+  return Bb.bind(this)
+    .return(functionName)
+    .then(getConfigFromCache)
     .then(prepareIncludes)
     .then(runBrowserify)
-    .then(zipIt)
-    .then(clean)
+    .then(data => {
+      if (this._b.localInvoke === true) {
+        return data
+      }
+      return Bb.bind(this).return(data).then(zipIt).then(clean)
+    })
 }
 
 function bootstrap (functionName) {
   if (this._b.debugOn) {
-    this.S.cli.log(`Browserifier: Preparing "${functionName}"...`)
+    this._s.cli.log(`Browserifier: Preparing "${functionName}"...`)
   }
-  return Promise.bind(this)
+  return Bb.bind(this)
     .return(functionName)
     .then(prepareInitialData)
     .then(this._validateFunction)
     .then(cacheConfig)
     .then(fixServerlessConfig)
+    .then(clean)
 }
 
 /// //////////////////////// support functions
@@ -50,15 +55,23 @@ function prepareInitialData (functionName) {
   return {
     functionName,
     outputFolder: path.join(this._b.servicePath, functionName),
-    functionObject: this.S.service.getFunction(functionName),
+    functionObject: this._s.service.getFunction(functionName),
     functionBrowserifyConfig: this._getFunctionConfig(functionName),
     outputBundle: path.relative(
-      this.S.config.servicePath,
+      this._s.config.servicePath,
       path.join(this._b.servicePath, `${functionName}.zip`)
     )
   }
 }
 
+function getConfigFromCache (functionName) {
+  const data = this._b.functionConfigCache[functionName]
+  if (!data) {
+    throw new errors.SkipFunctionError(functionName + ' could not be found in config cache')
+  }
+  return data
+}
+
 function cacheConfig (data) {
   if (data) {
     this._b.functionConfigCache[data.functionName] = data
@@ -68,53 +81,59 @@ function cacheConfig (data) {
 
 function prepareIncludes (data) {
   const includeFiles = globby.sync(data.functionBrowserifyConfig.include, {
-    cwd: this.S.config.servicePath,
+    cwd: this._s.config.servicePath,
     dot: true,
     silent: true,
     follow: true
   })
   if (includeFiles && includeFiles.length) {
     if (this._b.debugOn) {
-      this.S.cli.log('Browserifier: Copying includes: ' + includeFiles)
+      this._s.cli.log('Browserifier: Copying includes: ' + includeFiles)
     }
     const copyFile = file => {
-      fs.copySync(path.join(this.S.config.servicePath, file), path.join(data.outputFolder, file))
+      fs.copySync(path.join(this._s.config.servicePath, file), path.join(data.outputFolder, file))
     }
-    return Promise.each(includeFiles, copyFile).return(data)
+    return Bb.each(includeFiles, copyFile).return(data)
   }
   return data
 }
 
 function runBrowserify (data) {
   if (this._b.debugOn) {
-    this.S.cli.log(`Browserifier: Browserifying ${data.functionName}...`)
+    this._s.cli.log(`Browserifier: Browserifying ${data.functionName}...`)
   }
   const cfg = data.functionBrowserifyConfig
   const b = browserify(cfg)
   cfg.exclude.forEach(file => b.exclude(file))
   cfg.ignore.forEach(file => b.ignore(file))
   cfg.external.forEach(file => b.external(file))
-  return Promise.fromCallback(cb => b.bundle(cb))
+  return Bb.fromCallback(cb => b.bundle(cb))
     .then(bundleBuffer => {
       if (this._b.debugOn) {
-        this.S.cli.log(`Browserifier: Writing browserified bundle to ${data.outputFolder}...`)
+        this._s.cli.log(`Browserifier: Writing browserified bundle to ${data.outputFolder}...`)
+      }
+      const [handlerPath, handlerFunction] = data.functionObject.handler.split('.')
+      let filePath = path.join(data.outputFolder, handlerPath)
+      if (this._b.localInvoke === true) {
+        const newHandlerPath = path.relative(this._s.config.servicePath, filePath)
+        data.functionObject.handler = newHandlerPath + '.' + handlerFunction
+        this._s.cli.log(`Browserifier: Function ${data.functionName} bundle generated...`)
       }
-      let handlerPath = data.functionObject.handler.split('.')[0] + '.js'
-      handlerPath = path.join(data.outputFolder, handlerPath)
-      this.S.utils.writeFileDir(handlerPath)
-      return Promise.fromCallback(cb => fs.writeFile(handlerPath, bundleBuffer, cb))
+      filePath += '.js'
+      this._s.utils.writeFileDir(filePath)
+      return Bb.fromCallback(cb => fs.writeFile(filePath, bundleBuffer, cb))
     })
     .tap(() => {
       if (this._b.debugOn) {
-        this.S.cli.log(`Browserifier: Browserified output dumped to ${data.outputFolder}...`)
+        this._s.cli.log(`Browserifier: Browserified output dumped to ${data.outputFolder}...`)
       }
     })
     .return(data)
 }
 
 function zipIt (data) {
   if (this._b.debugOn) {
-    this.S.cli.log(`Browserifier: Zipping ${data.outputFolder} to ${data.outputBundle}...`)
+    this._s.cli.log(`Browserifier: Zipping ${data.outputFolder} to ${data.outputBundle}...`)
   }
   const handleStream = (resolve, reject) => {
     const output = fs.getNewFileStream(data.outputBundle)
@@ -127,8 +146,8 @@ function zipIt (data) {
       zip.finalize()
     })
   }
-  return new Promise(handleStream).then(sizeInBytes => {
-    this.S.cli.log(`Browserifier: Created ${data.functionName}.zip (${filesize(sizeInBytes)})...`)
+  return new Bb(handleStream).then(sizeInBytes => {
+    this._s.cli.log(`Browserifier: Created ${data.functionName}.zip (${filesize(sizeInBytes)})...`)
     return data
   })
 }
@@ -141,7 +160,7 @@ function clean (data) {
 }
 
 function fixServerlessConfig (data) {
-  if (semver.lt(this.S.getVersion(), '1.18.0')) {
+  if (semver.lt(this._s.getVersion(), '1.18.0')) {
     data.functionObject.artifact = data.outputBundle
     data.functionObject.package = Object.assign({}, data.functionObject.package, { disable: true })
   } else {

lib/configure.js

@@ -10,27 +10,27 @@ module.exports = {
    */
   _computeGlobalConfig () {
     if (this._b.debugOn) {
-      this.S.cli.log('Browserifier: Computing global config...')
+      this._s.cli.log('Browserifier: Computing global config...')
     }
-    const globalCustom = get(this.S, 'service.custom.browserify', {})
+    const globalCustom = get(this._s, 'service.custom.browserify', {})
     const globalDefault = this._getBrowserifyDefaultConfig()
     this._b.globalBrowserifyConfig = Object.assign({}, globalDefault, globalCustom)
-    if (this.S.service.package) {
+    if (this._s.service.package) {
       // Merge together package.exclude and custom.browserify.exclude
-      if (this.S.service.package.exclude && this.S.service.package.exclude.length) {
+      if (this._s.service.package.exclude && this._s.service.package.exclude.length) {
         this._b.globalBrowserifyConfig.exclude = union(
-          this.S.service.package.exclude,
+          this._s.service.package.exclude,
           this._b.globalBrowserifyConfig.exclude
         )
       }
       // Save service package.include
-      if (this.S.service.package.include && this.S.service.package.include.length) {
-        this._b.globalBrowserifyConfig.include = this.S.service.package.include
+      if (this._s.service.package.include && this._s.service.package.include.length) {
+        this._b.globalBrowserifyConfig.include = this._s.service.package.include
       }
     }
     if (this._b.debugOn) {
       const computed = JSON.stringify(this._b.globalBrowserifyConfig)
-      this.S.cli.log('Browserifier: Computed globalBrowserifyConfig: ' + computed)
+      this._s.cli.log('Browserifier: Computed globalBrowserifyConfig: ' + computed)
     }
   },
 
@@ -41,9 +41,9 @@ module.exports = {
   _getBrowserifyDefaultConfig () {
     const version = this._getBrowserifyVersion()
     if (semver.lt(version, '13.3.0')) {
-      throw new this.S.classes.Error("Minimal 'browserify' version supported is v13.3.0.", 'skip')
+      throw new this._s.classes.Error("Minimal 'browserify' version supported is v13.3.0.", 'skip')
     }
-    this.S.cli.log('Browserifier: Using browserify@' + version)
+    this._s.cli.log('Browserifier: Using browserify@' + version)
     // Props disable, exclude, include, external and ignore are not browserify
     // options, but will be used for custom plugin settings if defined in yml
     const config = {
@@ -52,31 +52,32 @@ module.exports = {
       include: [],
       external: [],
       ignore: [],
-      basedir: this.S.config.servicePath,
+      basedir: this._s.config.servicePath,
       entries: [],
       bare: true,
       standalone: 'lambda',
+      extensions: ['.js'],
       ignoreMissing: true, // Do not fail on missing optional dependencies
       detectGlobals: true, // We don't care if its slower, we want more mods to work
       debug: this._b.debugOn
     }
     if (semver.gte(version, '16.1.0')) {
       if (this._b.debugOn) {
-        this.S.cli.log('Browserifier: Using browserify "node" option...')
+        this._s.cli.log('Browserifier: Using browserify "node" option...')
       }
       config.node = true
     } else {
       if (this._b.debugOn) {
-        this.S.cli.log('Browserifier: Using browserify "legacy" options...')
+        this._s.cli.log('Browserifier: Using browserify "legacy" options...')
       }
       Object.assign(config, {
         browserField: false, // Setup for node app (copy logic of --node in bin/args.js)
         builtins: false,
         commondir: false,
         insertGlobalVars: {
-          process: undefined,
-          global: undefined,
-          Buffer: undefined,
+          'process': undefined,
+          'global': undefined,
+          'Buffer': undefined,
           'Buffer.isBuffer': undefined
         }
       })
@@ -93,7 +94,7 @@ module.exports = {
       const pkg = require('browserify/package.json')
       return pkg.version
     } catch (err) {
-      throw new this.S.classes.Error('Required peer dependency "browserify" is not available.')
+      throw new this._s.classes.Error('Required peer dependency "browserify" is not available.')
     }
   },
 
@@ -104,18 +105,18 @@ module.exports = {
    * @returns {*}
    */
   _getFunctionConfig (functionName) {
-    const functionObject = this.S.service.getFunction(functionName)
+    const functionObject = this._s.service.getFunction(functionName)
     const functionBrowserifyConfig = Object.assign(
       {},
       this._b.globalBrowserifyConfig,
       functionObject.browserify || {}
     )
     if (this._b.debugOn) {
       const computed = JSON.stringify(functionObject)
-      this.S.cli.log(`Browserifier: functionObject for ${functionName}: ${computed}`)
+      this._s.cli.log(`Browserifier: functionObject for ${functionName}: ${computed}`)
     }
     if (!functionBrowserifyConfig.entries.length) {
-      const bundleEntryPt = functionObject.handler.split('.')[0] + '.js'
+      const bundleEntryPt = functionObject.handler.split('.')[0]
       functionBrowserifyConfig.entries = [bundleEntryPt]
     }
     if (functionObject.package) {
@@ -136,7 +137,7 @@ module.exports = {
     }
     if (this._b.debugOn) {
       const computed = JSON.stringify(functionBrowserifyConfig)
-      this.S.cli.log('Browserifier: Computed function BrowserifierConfig: ' + computed)
+      this._s.cli.log('Browserifier: Computed function BrowserifierConfig: ' + computed)
     }
     return functionBrowserifyConfig
   }