refactor: implement _safeLog method for consistent logging in S3 and SQS

refactor: simplify S3 constructor by removing destructuring of log parameter

Author: agnusha

packages/serverless-offline-s3/README.md

@@ -26,6 +26,22 @@ plugins:
 
 [See example](../../tests/serverless-plugins-integration/README.md#s3)
 
+## Migrating from v7 to v8
+
+This version requires Serverless Framework v4 and serverless-offline v14.4.0+.
+
+### Breaking Changes
+
+- Requires `serverless-offline: "^14.4.0 || >=14"`
+- Uses new Serverless v4 plugin API for logging
+- Node.js 18+ required
+
+### Upgrade Steps
+
+1. Update serverless to v4: `npm install serverless@^4.0.0`
+2. Update serverless-offline to v14.4.0+: `npm install serverless-offline@^14.4.0`
+3. Update this plugin: `npm install serverless-offline-s3@^8.0.0`
+
 ## How it works?
 
 To be able to emulate AWS S3 Bucket on local machine there should be some bucket system actually running. One of the existing implementations suitable for the task is [Minio](https://github.com/minio/minio).

packages/serverless-offline-s3/package.json

@@ -44,4 +44,4 @@
     "serverless-offline",
     "lambda"
   ]
-}
+}

packages/serverless-offline-s3/src/index.js

@@ -15,7 +15,7 @@ const defaultOptions = {
 const omitUndefined = omitBy(isUndefined);
 
 class ServerlessOfflineS3 {
-  constructor(serverless, cliOptions, {log}) {
+  constructor(serverless, cliOptions, {log} = {}) {
     this.cliOptions = null;
     this.options = null;
     this.s3 = null;
@@ -25,7 +25,11 @@ class ServerlessOfflineS3 {
 
     this.cliOptions = cliOptions;
     this.serverless = serverless;
-    this.log = log;
+    this.log = log || {
+      debug: console.debug.bind(console),
+      notice: console.log.bind(console),
+      warning: console.warn.bind(console)
+    };
 
     this.hooks = {
       'offline:start:init': this.start.bind(this),

packages/serverless-offline-s3/src/s3.js

@@ -9,8 +9,14 @@ const delay = timeout =>
     setTimeout(resolve, timeout);
   });
 
+const defaultLog = {
+  debug: console.debug.bind(console),
+  notice: console.log.bind(console),
+  warning: console.warn.bind(console)
+};
+
 class S3 {
-  constructor(lambda, resources, options, {log}) {
+  constructor(lambda, resources, options, log = defaultLog) {
     this.lambda = null;
     this.resources = null;
     this.options = null;
@@ -19,7 +25,7 @@ class S3 {
     this.lambda = lambda;
     this.resources = resources;
     this.options = options;
-    this.log = log;
+    this.log = log || defaultLog;
 
     const s3Endpoint = this.options.endpoint ? new URL(this.options.endpoint) : {};
     this.client = new Minio.Client(
@@ -34,6 +40,14 @@ class S3 {
     this.listeners = [];
   }
 
+  _safeLog(level, message) {
+    if (this.log && typeof this.log[level] === 'function') {
+      this.log[level](message);
+    } else if (console[level]) {
+      console[level](message);
+    }
+  }
+
   create(events) {
     this.events = events;
     return Promise.all(
@@ -86,7 +100,7 @@ class S3 {
     );
   }
 
-  stop(timeout) {
+  stop(_timeout) {
     this.listeners.forEach(listener => listener.stop());
     this.listeners = [];
   }
@@ -124,7 +138,7 @@ class S3 {
 
           await lambdaFunction.runHandler();
         } catch (err) {
-          this.log.warning(err.stack);
+          this._safeLog('warning', err.stack);
         }
       }
     });

packages/serverless-offline-sqs/README.md

@@ -26,6 +26,22 @@ plugins:
 
 [See example](../../tests/serverless-plugins-integration/README.md#sqs)
 
+## Migrating from v8 to v9
+
+This version requires Serverless Framework v4 and serverless-offline v14.4.0+.
+
+### Breaking Changes
+
+- Requires `serverless-offline: "^14.4.0 || >=14"`
+- Uses new Serverless v4 plugin API for logging
+- Node.js 18+ required
+
+### Upgrade Steps
+
+1. Update serverless to v4: `npm install serverless@^4.0.0`
+2. Update serverless-offline to v14.4.0+: `npm install serverless-offline@^14.4.0`
+3. Update this plugin: `npm install serverless-offline-sqs@^9.0.0`
+
 ## How it works?
 
 To be able to emulate AWS SQS queue on local machine there should be some queue system actually running. One of the existing implementations suitable for the task is [ElasticMQ](https://github.com/adamw/elasticmq).

packages/serverless-offline-sqs/package.json

@@ -44,4 +44,4 @@
     "serverless-offline",
     "lambda"
   ]
-}
+}

packages/serverless-offline-sqs/src/index.js

@@ -30,7 +30,7 @@ const defaultOptions = {
 const omitUndefined = omitBy(isUndefined);
 
 class ServerlessOfflineSQS {
-  constructor(serverless, cliOptions, {log}) {
+  constructor(serverless, cliOptions, {log} = {}) {
     this.cliOptions = null;
     this.options = null;
     this.log = null;
@@ -40,7 +40,11 @@ class ServerlessOfflineSQS {
 
     this.cliOptions = cliOptions;
     this.serverless = serverless;
-    this.log = log;
+    this.log = log || {
+      debug: console.debug.bind(console),
+      notice: console.log.bind(console),
+      warning: console.warn.bind(console)
+    };
 
     this.hooks = {
       'offline:start:init': this.start.bind(this),

packages/serverless-offline-sqs/src/sqs.js

@@ -20,8 +20,14 @@ const delay = timeout =>
     setTimeout(resolve, timeout);
   });
 
+const defaultLog = {
+  debug: console.debug.bind(console),
+  notice: console.log.bind(console),
+  warning: console.warn.bind(console)
+};
+
 class SQS {
-  constructor(lambda, resources, options, log) {
+  constructor(lambda, resources, options, log = defaultLog) {
     this.lambda = null;
     this.resources = null;
     this.options = null;
@@ -30,13 +36,21 @@ class SQS {
     this.lambda = lambda;
     this.resources = resources;
     this.options = options;
-    this.log = log;
+    this.log = log || defaultLog;
 
     this.client = new SQSClient(this.options);
 
     this.queue = new PQueue({autoStart: false});
   }
 
+  _safeLog(level, message) {
+    if (this.log && typeof this.log[level] === 'function') {
+      this.log[level](message);
+    } else if (console[level]) {
+      console[level](message);
+    }
+  }
+
   create(events) {
     return Promise.all(events.map(({functionKey, sqs}) => this._create(functionKey, sqs)));
   }
@@ -139,7 +153,7 @@ class SQS {
             )
           );
         } catch (err) {
-          this.log.warning(err.stack);
+          this._safeLog('warning', err.stack);
         }
       }
 
@@ -171,7 +185,7 @@ class SQS {
     } catch (err) {
       if (remainingTry > 0 && err.name === 'AWS.SimpleQueueService.NonExistentQueue')
         return this._createQueue({queueName}, remainingTry - 1);
-      this.log.warning(err.stack);
+      this._safeLog('warning', err.stack);
     }
   }
 }