node-lambda 1.3.0 → 2.0.0-alpha.0

package/lib/s3_events.js

@@ -1,20 +1,16 @@
 'use strict'
 
+const { S3Client, PutBucketNotificationConfigurationCommand } = require('@aws-sdk/client-s3')
+const { LambdaClient, AddPermissionCommand } = require('@aws-sdk/client-lambda')
+
 /**
  * Do not create S3 bucket.
  * Put the Notification Configuration in the existing Bucket.
  */
 class S3Events {
-  constructor (aws, region) {
-    // Authenticated `aws` object in `lib/main.js`
-    this.lambda = new aws.Lambda({
-      region,
-      apiVersion: '2015-03-31'
-    })
-    this.s3 = new aws.S3({
-      region,
-      apiVersion: '2006-03-01'
-    })
+  constructor (config) {
+    this.s3Client = new S3Client(config)
+    this.lambdaClient = new LambdaClient(config)
   }
 
   _functionName (params) {
@@ -36,17 +32,14 @@ class S3Events {
   }
 
   _addPermission (params) {
-    return new Promise((resolve, reject) => {
-      const _params = this._addPermissionParams(params)
-      this.lambda.addPermission(_params, (err, data) => {
-        if (err) {
-          if (err.code !== 'ResourceConflictException') reject(err)
-          // If it exists it will result in an error but there is no problem.
-          resolve('Permission already set')
-        }
-        resolve(data)
-      })
-    })
+    const _params = this._addPermissionParams(params)
+    try {
+      return this.lambdaClient.send(new AddPermissionCommand(_params))
+    } catch (err) {
+      if (err.code !== 'ResourceConflictException') throw err
+      // If it exists it will result in an error but there is no problem.
+      return 'Permission already set'
+    }
   }
 
   _lambdaFunctionConfiguration (params) {
@@ -86,12 +79,8 @@ class S3Events {
   }
 
   _putBucketNotificationConfiguration (putBucketNotificationConfigurationParams) {
-    return new Promise((resolve, reject) => {
-      this.s3.putBucketNotificationConfiguration(putBucketNotificationConfigurationParams, (err, data) => {
-        if (err) reject(err)
-        resolve(data)
-      })
-    })
+    return this.s3Client.send(
+      new PutBucketNotificationConfigurationCommand(putBucketNotificationConfigurationParams))
   }
 
   add (paramsList) {

package/lib/schedule_events.js

@@ -1,15 +1,12 @@
 'use strict'
 
+const { CloudWatchEventsClient, PutRuleCommand, PutTargetsCommand } = require('@aws-sdk/client-cloudwatch-events')
+const { LambdaClient, AddPermissionCommand } = require('@aws-sdk/client-lambda')
+
 class ScheduleEvents {
-  constructor (aws, region) {
-    // Authenticated `aws` object in `lib/main.js`
-    this.lambda = new aws.Lambda({
-      region,
-      apiVersion: '2015-03-31'
-    })
-    this.cloudwatchevents = new aws.CloudWatchEvents({
-      apiVersion: '2015-10-07'
-    })
+  constructor (config) {
+    this.cweClient = new CloudWatchEventsClient(config)
+    this.lambdaClient = new LambdaClient(config)
   }
 
   _ruleDescription (params) {
@@ -34,13 +31,9 @@ class ScheduleEvents {
 
   _putRule (params) {
     // return RuleArn if created
-    return new Promise((resolve, reject) => {
-      const _params = this._putRulePrams(params)
-      this.cloudwatchevents.putRule(_params, (err, rule) => {
-        if (err) reject(err)
-        resolve(rule)
-      })
-    })
+    return this.cweClient.send(
+      new PutRuleCommand(this._putRulePrams(params))
+    )
   }
 
   _addPermissionParams (params) {
@@ -54,17 +47,14 @@ class ScheduleEvents {
   }
 
   _addPermission (params) {
-    return new Promise((resolve, reject) => {
-      const _params = this._addPermissionParams(params)
-      this.lambda.addPermission(_params, (err, data) => {
-        if (err) {
-          if (err.code !== 'ResourceConflictException') reject(err)
-          // If it exists it will result in an error but there is no problem.
-          resolve('Permission already set')
-        }
-        resolve(data)
-      })
-    })
+    const _params = this._addPermissionParams(params)
+    try {
+      return this.lambdaClient.send(new AddPermissionCommand(_params))
+    } catch (err) {
+      if (err.code !== 'ResourceConflictException') throw err
+      // If it exists it will result in an error but there is no problem.
+      return 'Permission already set'
+    }
   }
 
   _putTargetsParams (params) {
@@ -79,14 +69,10 @@ class ScheduleEvents {
   }
 
   _putTargets (params) {
-    return new Promise((resolve, reject) => {
-      const _params = this._putTargetsParams(params)
-      this.cloudwatchevents.putTargets(_params, (err, data) => {
-        // even if it is already registered, it will not be an error.
-        if (err) reject(err)
-        resolve(data)
-      })
-    })
+    // even if it is already registered, it will not be an error.
+    return this.cweClient.send(
+      new PutTargetsCommand(this._putTargetsParams(params))
+    )
   }
 
   add (params) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-lambda",
-  "version": "1.3.0",
+  "version": "2.0.0-alpha.0",
   "description": "Command line tool for locally running and remotely deploying your node.js applications to Amazon Lambda.",
   "main": "lib/main.js",
   "directories": {
@@ -32,23 +32,26 @@
   "author": "motdotla",
   "license": "BSD-2-Clause",
   "engines": {
-    "node": ">= 10.0.0"
+    "node": ">= 18.0.0"
   },
   "dependencies": {
-    "archiver": "^6.0.0",
-    "aws-sdk": "^2.1377.0",
+    "@aws-sdk/client-cloudwatch-events": "^3.797.0",
+    "@aws-sdk/client-cloudwatch-logs": "^3.782.0",
+    "@aws-sdk/client-lambda": "^3.670.0",
+    "@aws-sdk/client-s3": "^3.782.0",
+    "@dotenvx/dotenvx": "^1.14.0",
+    "archiver": "^7.0.0",
     "aws-xray-sdk-core": "^3.5.0",
-    "commander": "^11.0.0",
+    "commander": "^12.0.0",
     "continuation-local-storage": "^3.2.1",
-    "dotenv": "^16.0.3",
     "fs-extra": "^11.1.1",
     "klaw": "^4.1.0",
-    "minimatch": "^9.0.0",
+    "minimatch": "^10.0.1",
     "proxy-agent": "^6.2.0"
   },
   "devDependencies": {
-    "aws-sdk-mock": "^5.8.0",
-    "chai": "^4.3.7",
+    "aws-sdk-client-mock": "^4.1.0",
+    "chai": "^5.0.0",
     "mocha": "^10.1.0",
     "node-zip": "^1.1.1",
     "standard": "^17.0.0"

package/tea.yaml

@@ -0,0 +1,6 @@
+# https://tea.xyz/what-is-this-file
+---
+version: 1.0.0
+codeOwners:
+  - '0x248c5A7855A8861e3277341A1285c5D7dE64ba73'
+quorum: 1

package/test/cloudwatch_logs.js

@@ -1,11 +1,20 @@
 'use strict'
 
-const assert = require('chai').assert
+let assert
+import('chai').then(chai => {
+  assert = chai.assert
+})
 const path = require('path')
-const aws = require('aws-sdk-mock')
-aws.setSDK(path.resolve('node_modules/aws-sdk'))
 const CloudWatchLogs = require(path.join('..', 'lib', 'cloudwatch_logs'))
 
+const {
+  CloudWatchLogsClient,
+  CreateLogGroupCommand,
+  PutRetentionPolicyCommand
+} = require('@aws-sdk/client-cloudwatch-logs')
+const { mockClient } = require('aws-sdk-client-mock')
+const mockCloudWatchLogsClient = mockClient(CloudWatchLogsClient)
+
 const mockResponse = {
   createLogGroup: {
     testCreateLogGroupResponse: 'An empty object is returned in the actual API'
@@ -23,21 +32,16 @@ const params = {
 
 let logs = null
 
-/* global before, after, describe, it */
+/* global before, describe, it */
 describe('lib/cloudwatch_logs', () => {
   before(() => {
-    aws.mock('CloudWatchLogs', 'createLogGroup', (params, callback) => {
-      callback(null, mockResponse.createLogGroup)
-    })
-    aws.mock('CloudWatchLogs', 'putRetentionPolicy', (params, callback) => {
-      callback(null, mockResponse.putRetentionPolicy)
-    })
+    mockCloudWatchLogsClient.reset()
+    mockCloudWatchLogsClient.on(CreateLogGroupCommand).resolves(mockResponse.createLogGroup)
+    mockCloudWatchLogsClient.on(PutRetentionPolicyCommand).resolves(mockResponse.putRetentionPolicy)
 
-    logs = new CloudWatchLogs(require('aws-sdk'))
+    logs = new CloudWatchLogs({ region: 'us-east-1' })
   })
 
-  after(() => aws.restore('CloudWatchLogs'))
-
   describe('_logGroupName', () => {
     it('correct value', () => {
       assert.equal(

package/test/main.js

@@ -7,9 +7,52 @@ const fs = require('fs-extra')
 const { execFileSync } = require('child_process')
 const lambda = require(path.join(__dirname, '..', 'lib', 'main'))
 const Zip = require('node-zip')
-const { assert } = require('chai')
-const awsMock = require('aws-sdk-mock')
-awsMock.setSDK(path.resolve('node_modules/aws-sdk'))
+let assert
+import('chai').then(chai => {
+  assert = chai.assert
+})
+
+const { mockClient } = require('aws-sdk-client-mock')
+
+const {
+  LambdaClient,
+  AddPermissionCommand,
+  CreateEventSourceMappingCommand,
+  CreateFunctionCommand,
+  DeleteEventSourceMappingCommand,
+  GetFunctionCommand,
+  ListEventSourceMappingsCommand,
+  ListTagsCommand,
+  TagResourceCommand,
+  UntagResourceCommand,
+  UpdateEventSourceMappingCommand,
+  UpdateFunctionCodeCommand,
+  UpdateFunctionConfigurationCommand
+} = require('@aws-sdk/client-lambda')
+const mockLambdaClient = mockClient(LambdaClient)
+const lambdaClient = new LambdaClient({ region: 'us-east-1' })
+
+const {
+  CloudWatchLogsClient,
+  CreateLogGroupCommand,
+  PutRetentionPolicyCommand
+} = require('@aws-sdk/client-cloudwatch-logs')
+const mockCloudWatchLogsClient = mockClient(CloudWatchLogsClient)
+
+const {
+  CloudWatchEventsClient,
+  PutRuleCommand,
+  PutTargetsCommand
+} = require('@aws-sdk/client-cloudwatch-events')
+const mockCloudWatchEventsClient = mockClient(CloudWatchEventsClient)
+
+const {
+  S3Client,
+  CreateBucketCommand,
+  PutBucketNotificationConfigurationCommand,
+  PutObjectCommand
+} = require('@aws-sdk/client-s3')
+const mockS3Client = mockClient(S3Client)
 
 const originalProgram = {
   packageManager: 'npm',
@@ -19,7 +62,7 @@ const originalProgram = {
   sessionToken: 'token',
   functionName: '___node-lambda',
   handler: 'index.handler',
-  role: 'some:arn:aws:iam::role',
+  role: 'arn:aws:iam::999999999999:role/test',
   memorySize: 128,
   timeout: 3,
   description: '',
@@ -97,70 +140,59 @@ const lambdaMockSettings = {
   tagResource: {}
 }
 
-const _mockSetting = () => {
-  awsMock.mock('CloudWatchEvents', 'putRule', (params, callback) => {
-    callback(null, {})
-  })
-  awsMock.mock('CloudWatchEvents', 'putTargets', (params, callback) => {
-    callback(null, {})
-  })
-  awsMock.mock('CloudWatchLogs', 'createLogGroup', (params, callback) => {
-    callback(null, {})
-  })
-  awsMock.mock('CloudWatchLogs', 'putRetentionPolicy', (params, callback) => {
-    callback(null, {})
-  })
-  awsMock.mock('S3', 'putBucketNotificationConfiguration', (params, callback) => {
-    callback(null, {})
-  })
-  awsMock.mock('S3', 'putObject', (params, callback) => {
-    callback(null, { test: 'putObject' })
-  })
-
-  Object.keys(lambdaMockSettings).forEach((method) => {
-    awsMock.mock('Lambda', method, (params, callback) => {
-      callback(null, lambdaMockSettings[method])
-    })
-  })
-
-  return require('aws-sdk')
-}
-
-const _awsRestore = () => {
-  awsMock.restore('CloudWatchEvents')
-  awsMock.restore('CloudWatchLogs')
-  awsMock.restore('S3')
-  awsMock.restore('Lambda')
-}
-
 /* global before, after, beforeEach, afterEach, describe, it */
 describe('lib/main', function () {
-  if (['win32', 'darwin'].includes(process.platform)) {
-    // It seems that it takes time for file operation in Windows and Mac.
+  if (process.platform === 'win32') {
+    // It seems that it takes very long time for file operation in Windows.
+    // So set `timeout(300000)` for the whole test.
+    this.timeout(300000)
+  } else if (process.platform === 'darwin') {
+    // It seems that it takes time for file operation in Mac.
     // So set `timeout(120000)` for the whole test.
     this.timeout(120000)
   }
 
-  let aws = null // mock
-  let awsLambda = null // mock
   before(() => {
-    aws = _mockSetting()
-    awsLambda = new aws.Lambda({ apiVersion: '2015-03-31' })
-
     if (process.platform === 'win32') {
       execFileSync('cmd.exe', ['/c', 'npm', 'ci'], { cwd: sourceDirectoryForTest })
       return
     }
     execFileSync('npm', ['ci'], { cwd: sourceDirectoryForTest })
   })
-  after(() => _awsRestore())
 
   beforeEach(() => {
     program = Object.assign({}, originalProgram) // clone
+
+    mockLambdaClient.reset()
+    mockLambdaClient.on(AddPermissionCommand).resolves(lambdaMockSettings.addPermission)
+    mockLambdaClient.on(CreateEventSourceMappingCommand).resolves(lambdaMockSettings.createEventSourceMapping)
+    mockLambdaClient.on(CreateFunctionCommand).resolves(lambdaMockSettings.createFunction)
+    mockLambdaClient.on(DeleteEventSourceMappingCommand).resolves(lambdaMockSettings.deleteEventSourceMapping)
+    mockLambdaClient.on(GetFunctionCommand).resolves(lambdaMockSettings.getFunction)
+    mockLambdaClient.on(ListEventSourceMappingsCommand).resolves(lambdaMockSettings.listEventSourceMappings)
+    mockLambdaClient.on(ListTagsCommand).resolves(lambdaMockSettings.listTags)
+    mockLambdaClient.on(TagResourceCommand).resolves(lambdaMockSettings.tagResource)
+    mockLambdaClient.on(UntagResourceCommand).resolves(lambdaMockSettings.untagResource)
+    mockLambdaClient.on(UpdateEventSourceMappingCommand).resolves(lambdaMockSettings.updateEventSourceMapping)
+    mockLambdaClient.on(UpdateFunctionCodeCommand).resolves(lambdaMockSettings.updateFunctionCode)
+    mockLambdaClient.on(UpdateFunctionConfigurationCommand).resolves(lambdaMockSettings.updateFunctionConfiguration)
+
+    mockCloudWatchLogsClient.reset()
+    mockCloudWatchLogsClient.on(CreateLogGroupCommand).resolves({})
+    mockCloudWatchLogsClient.on(PutRetentionPolicyCommand).resolves({})
+
+    mockCloudWatchEventsClient.reset()
+    mockCloudWatchEventsClient.on(PutRuleCommand).resolves({})
+    mockCloudWatchEventsClient.on(PutTargetsCommand).resolves({})
+
+    mockS3Client.reset()
+    mockS3Client.on(CreateBucketCommand).resolves({})
+    mockS3Client.on(PutBucketNotificationConfigurationCommand).resolves({})
+    mockS3Client.on(PutObjectCommand).resolves({})
   })
 
   it('version should be set', () => {
-    assert.equal(lambda.version, '1.3.0')
+    assert.equal(lambda.version, '2.0.0-alpha.0')
   })
 
   describe('_codeDirectory', () => {
@@ -1333,7 +1365,7 @@ describe('lib/main', function () {
   describe('_listEventSourceMappings', () => {
     it('simple test with mock', () => {
       return lambda._listEventSourceMappings(
-        awsLambda,
+        lambdaClient,
         { FunctionName: 'test-func' }
       ).then((results) => {
         assert.deepEqual(
@@ -1397,7 +1429,7 @@ describe('lib/main', function () {
       program.eventSourceFile = ''
       const eventSourceList = lambda._eventSourceList(program)
       return lambda._updateEventSources(
-        awsLambda,
+        lambdaClient,
         '',
         [],
         eventSourceList.EventSourceMappings
@@ -1410,7 +1442,7 @@ describe('lib/main', function () {
       program.eventSourceFile = 'event_sources.json'
       const eventSourceList = lambda._eventSourceList(program)
       return lambda._updateEventSources(
-        awsLambda,
+        lambdaClient,
         'functionName',
         [],
         eventSourceList.EventSourceMappings
@@ -1421,7 +1453,7 @@ describe('lib/main', function () {
 
     it('simple test with mock (In case of deletion)', () => {
       return lambda._updateEventSources(
-        awsLambda,
+        lambdaClient,
         'functionName',
         lambdaMockSettings.listEventSourceMappings.EventSourceMappings,
         {}
@@ -1434,7 +1466,7 @@ describe('lib/main', function () {
       program.eventSourceFile = 'event_sources.json'
       const eventSourceList = lambda._eventSourceList(program)
       return lambda._updateEventSources(
-        awsLambda,
+        lambdaClient,
         'functionName',
         lambdaMockSettings.listEventSourceMappings.EventSourceMappings,
         eventSourceList.EventSourceMappings
@@ -1462,7 +1494,7 @@ describe('lib/main', function () {
         'event_sources.json',
         JSON.stringify(eventSourcesJsonValue)
       )
-      schedule = new ScheduleEvents(aws)
+      schedule = new ScheduleEvents({ region: 'us-east-1' })
     })
 
     after(() => fs.unlinkSync('event_sources.json'))
@@ -1514,7 +1546,7 @@ describe('lib/main', function () {
         'event_sources.json',
         JSON.stringify(eventSourcesJsonValue)
       )
-      s3Events = new S3Events(aws)
+      s3Events = new S3Events({ region: 'us-east-1' })
     })
 
     after(() => fs.unlinkSync('event_sources.json'))
@@ -1552,7 +1584,7 @@ describe('lib/main', function () {
   describe('_uploadNew', () => {
     it('simple test with mock', () => {
       const params = lambda._params(program, null)
-      return lambda._uploadNew(awsLambda, params, (results) => {
+      return lambda._uploadNew(lambdaClient, params, (results) => {
         assert.deepEqual(results, lambdaMockSettings.createFunction)
       })
     })
@@ -1561,7 +1593,7 @@ describe('lib/main', function () {
   describe('_uploadExisting', () => {
     it('simple test with mock', () => {
       const params = lambda._params(program, null)
-      return lambda._uploadExisting(awsLambda, params).then((results) => {
+      return lambda._uploadExisting(lambdaClient, params).then((results) => {
         assert.deepEqual(results, lambdaMockSettings.updateFunctionConfiguration)
       })
     })
@@ -1572,7 +1604,7 @@ describe('lib/main', function () {
     it('simple test with mock', () => {
       const params = lambda._params(program, null)
       return lambda._setLogsRetentionPolicy(
-        new CloudWatchLogs(aws),
+        new CloudWatchLogs({ region: 'us-east-1' }),
         program,
         params.FunctionName
       ).then((results) => {
@@ -1649,7 +1681,7 @@ describe('lib/main', function () {
   describe('Lambda.prototype._updateTags()', () => {
     it('simple test with mock', () => {
       return lambda._updateTags(
-        awsLambda,
+        lambdaClient,
         'arn:aws:lambda:eu-central-1:1234567:function:test',
         { tagKey: 'tagValue' }).then((result) => {
         assert.deepEqual(

package/test/node-lambda.js

@@ -1,6 +1,9 @@
 'use strict'
 
-const assert = require('chai').assert
+let assert
+import('chai').then(chai => {
+  assert = chai.assert
+})
 const process = require('process')
 const path = require('path')
 const fs = require('fs-extra')
@@ -8,6 +11,11 @@ const spawn = require('child_process').spawn
 const execSync = require('child_process').execSync
 const nodeLambdaPath = path.join(__dirname, '..', 'bin', 'node-lambda')
 
+const removeDotenvLog = (str) => {
+  // eslint-disable-next-line no-control-regex
+  return str.replace(/^\u001b\[38;5;142m\[dotenvx@.+\]injectingenv\(.+\)from.env\u001b\[39m/, '')
+}
+
 /* global before, after, describe, it */
 // The reason for specifying the node command in this test is to support Windows.
 describe('bin/node-lambda', () => {
@@ -257,7 +265,7 @@ describe('bin/node-lambda', () => {
             '{asyncTest:false,callbackWaitsForEmptyEventLoop:true,callbackCode:\'callback(null);\',no:3}]' +
             '==================================Stoppingindex.handlerSuccess:'
 
-          assert.equal(stdoutString, expected)
+          assert.equal(removeDotenvLog(stdoutString), expected)
           assert.equal(code, 0)
           done()
         })
@@ -289,7 +297,7 @@ describe('bin/node-lambda', () => {
             '!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!Runningindex.handler==================================event' +
             '{body:\'{"asyncTest":false,"callbackWaitsForEmptyEventLoop":true,"callbackCode":"callback(null);"}\'}' +
             '==================================Stoppingindex.handlerSuccess:'
-          assert.equal(stdoutString, expected)
+          assert.equal(removeDotenvLog(stdoutString), expected)
           assert.equal(code, 0)
           done()
         })
@@ -313,7 +321,7 @@ describe('bin/node-lambda', () => {
             'event{asyncTest:false,callbackWaitsForEmptyEventLoop:true,callbackCode:\'callback(null);\'}' +
             '==================================' +
             'Stoppingindex.handler(mjs)Success:'
-          assert.equal(stdoutString, expected)
+          assert.equal(removeDotenvLog(stdoutString), expected)
           assert.equal(code, 0)
           done()
         })
@@ -336,7 +344,7 @@ describe('bin/node-lambda', () => {
         })
 
         run.on('exit', (code) => {
-          assert.equal(stdoutString, '')
+          assert.equal(removeDotenvLog(stdoutString), '')
           assert.match(stderrString, /Handler file not found\./)
           assert.equal(code, 255)
           done()
@@ -380,7 +388,10 @@ describe('bin/node-lambda', () => {
     const packageJson = require(path.join(__dirname, '..', 'package.json'))
     it('The current version is displayed', () => {
       const ret = execSync(`node ${nodeLambdaPath} --version`)
-      assert.equal(ret.toString().trim(), packageJson.version)
+      assert.equal(
+        ret.toString().trim().split('\n').pop(),
+        packageJson.version
+      )
     })
   })
 })

package/test/s3_deploy.js

@@ -1,10 +1,17 @@
 'use strict'
 
-const { assert } = require('chai')
+let assert
+import('chai').then(chai => {
+  assert = chai.assert
+})
 const process = require('process')
-const path = require('path')
-const aws = require('aws-sdk-mock')
-aws.setSDK(path.resolve('node_modules/aws-sdk'))
+const {
+  S3Client,
+  CreateBucketCommand,
+  PutObjectCommand
+} = require('@aws-sdk/client-s3')
+const { mockClient } = require('aws-sdk-client-mock')
+const mockS3Client = mockClient(S3Client)
 const S3Deploy = require('../lib/s3_deploy')
 
 const mockResponse = {
@@ -17,18 +24,11 @@ let s3Deploy = null
 /* global describe, it, before, after */
 describe('lib/s3_deploy', () => {
   before(() => {
-    aws.mock('S3', 'putObject', (params, callback) => {
-      callback(null, mockResponse.putObject)
-    })
-    aws.mock('S3', 'createBucket', (params, callback) => {
-      callback(null, mockResponse.createBucket)
-    })
-
-    s3Deploy = new S3Deploy(require('aws-sdk'))
-  })
+    mockS3Client.reset()
+    mockS3Client.on(CreateBucketCommand).resolves(mockResponse.createBucket)
+    mockS3Client.on(PutObjectCommand).resolves(mockResponse.putObject)
 
-  after(() => {
-    aws.restore('S3')
+    s3Deploy = new S3Deploy({ region: 'us-west-1' })
   })
 
   describe('_md5', () => {