feat(letMixin): support a let stage on all services

Author: mbroadst

src/services/aws/s3_service.js

@@ -1,4 +1,4 @@
-import { serviceResponse } from '../../util';
+import { serviceResponse, letMixin } from '../../util';
 
 /**
  * Convenience wrapper around AWS S3 service (not meant to be instantiated directly).
@@ -24,7 +24,7 @@ class S3Service {
    * @return {Promise}
    */
   put(bucket, key, acl, contentType) {
-    return serviceResponse(this.client, {
+    return serviceResponse(this, {
       service: this.serviceName,
       action: 'put',
       args: { bucket, key, acl, contentType }
@@ -41,12 +41,12 @@ class S3Service {
    * @return {Promise}
    */
   signPolicy(bucket, key, acl, contentType) {
-    return serviceResponse(this.client, {
+    return serviceResponse(this, {
       service: this.serviceName,
       action: 'signPolicy',
       args: { bucket, key, acl, contentType }
     });
   }
 }
 
-export default S3Service;
+export default letMixin(S3Service);

src/services/aws/ses_service.js

@@ -1,4 +1,4 @@
-import { serviceResponse } from '../../util';
+import { serviceResponse, letMixin } from '../../util';
 
 /**
  * Convenience wrapper around AWS SES service (not meant to be instantiated directly).
@@ -23,12 +23,12 @@ class SESService {
    * @return {Promise}
    */
   send(from, to, subject, body) {
-    return serviceResponse(this.client, {
+    return serviceResponse(this, {
       service: this.serviceName,
       action: 'send',
       args: { from, to, subject, body }
     });
   }
 }
 
-export default SESService;
+export default letMixin(SESService);

src/services/aws/sqs_service.js

@@ -1,4 +1,4 @@
-import { serviceResponse } from '../../util';
+import { serviceResponse, letMixin } from '../../util';
 
 /**
  * Convenience wrapper for AWS SQS (not meant to be instantiated directly).
@@ -7,7 +7,7 @@ import { serviceResponse } from '../../util';
  * @return {SQSService} a SQSService instance.
  */
 class SQSService {
-  constructor(stitchClient, serviceName) {
+  constructor(client, serviceName) {
     this.client = client;
     this.serviceName = serviceName;
   }
@@ -18,7 +18,7 @@ class SQSService {
    * @return {Promise}
    */
   send() {
-    return serviceResponse(this.client, {
+    return serviceResponse(this, {
       service: this.serviceName,
       action: 'send'
     });
@@ -30,11 +30,11 @@ class SQSService {
    * @return {Promise}
    */
   receive() {
-    return serviceResponse(this.client, {
+    return serviceResponse(this, {
       service: this.serviceName,
       action: 'receive'
     });
   }
 }
 
-export default SQSService;
+export default letMixin(SQSService);

src/services/http/http_service.js

@@ -1,4 +1,4 @@
-import { serviceResponse } from '../../util';
+import { serviceResponse, letMixin } from '../../util';
 
 /**
  * Convenience wrapper for HTTP service (not meant to be instantiated directly).
@@ -104,11 +104,11 @@ function buildArgs(urlOrOptions, options) {
 }
 
 function buildResponse(action, service, args) {
-  return serviceResponse(service.client, {
+  return serviceResponse(service, {
     service: service.serviceName,
     action: action,
     args: args
   });
 }
 
-export default HTTPService;
+export default letMixin(HTTPService);

src/services/mongodb/collection.js

@@ -164,7 +164,7 @@ function insertOp(self, docs, options) {
     }
   });
 
-  return serviceResponse(self.db.client, stages, response => {
+  return serviceResponse(self.db, stages, response => {
     return {
       insertedIds: response.result.map(doc => doc._id)
     };
@@ -178,7 +178,7 @@ function deleteOp(self, query, options) {
     query: query
   }, options);
 
-  return serviceResponse(self.db.client, {
+  return serviceResponse(self.db, {
     service: self.db.service,
     action: 'delete',
     args: args
@@ -197,7 +197,7 @@ function updateOp(self, query, update, options) {
     update: update
   }, options);
 
-  return serviceResponse(self.db.client, {
+  return serviceResponse(self.db, {
     service: self.db.service,
     action: 'update',
     args: args
@@ -218,7 +218,7 @@ function findOp(self, query, options, finalizer) {
     delete args.projection;
   }
 
-  return serviceResponse(self.db.client, {
+  return serviceResponse(self.db, {
     service: self.db.service,
     action: 'find',
     args: args

src/services/pubnub/pubnub_service.js

@@ -1,4 +1,4 @@
-import { serviceResponse } from '../../util';
+import { serviceResponse, letMixin } from '../../util';
 
 /**
  * Convenience wrapper around Pubnub API (not meant to be instantiated directly).
@@ -21,12 +21,12 @@ class PubnubService {
    * @return {Promise}
    */
   publish(channel, message) {
-    return serviceResponse(this.client, {
+    return serviceResponse(this, {
       service: this.serviceName,
       action: 'publish',
       args: { channel, message }
     });
   }
 }
 
-export default PubnubService;
+export default letMixin(PubnubService);

src/services/slack/slack_service.js

@@ -1,4 +1,4 @@
-import { serviceResponse } from '../../util';
+import { serviceResponse, letMixin } from '../../util';
 
 /**
  * Convenience wrapper around Slack API (not meant to be instantiated directly).
@@ -32,12 +32,12 @@ class SlackService {
     if (!!options.iconEmoji) args.iconEmoji = options.iconEmoji;
     if (!!options.attachments) args.attachments = options.attachments;
 
-    return serviceResponse(this.client, {
+    return serviceResponse(this, {
       service: this.serviceName,
       action: 'publish',
       args: args
     });
   }
 }
 
-export default SlackService;
+export default letMixin(SlackService);

src/services/twilio/twilio_service.js

@@ -1,4 +1,4 @@
-import { serviceResponse } from '../../util';
+import { serviceResponse, letMixin } from '../../util';
 
 /**
  * Create a new TwilioService instance (not meant to be instantiated directly).
@@ -22,12 +22,12 @@ class TwilioService {
    * @return {Promise}
    */
   send(from, to, body) {
-    return serviceResponse(this.client, {
+    return serviceResponse(this, {
       service: this.serviceName,
       action: 'send',
       args: { from, to, body }
     });
   }
 }
 
-export default TwilioService;
+export default letMixin(TwilioService);

src/util.js

@@ -29,15 +29,28 @@ function deprecate(fn, msg) {
  * API for calling helper methods (single-stage pipelines) and
  * pipeline building.
  *
- * @param {Object} client the client to execute the stages on
+ * @param {Object} service the service to execute the stages on
  * @param {Array} stages the pipeline stages to execute
  * @param {Function} [finalizer] optional function to call on the result of the response
  */
-function serviceResponse(client, stages, finalizer) {
+function serviceResponse(service, stages, finalizer) {
+  if (service && !service.client) {
+    throw new Error('Service has no client');
+  }
+
   if (finalizer && typeof finalizer !== 'function') {
     throw new Error('Service response finalizer must be a function');
   }
 
+  if (service.hasOwnProperty('__let__')) {
+    if (Array.isArray(stages)) {
+      // what do we do here?
+    } else {
+      stages.let = service.__let__;
+    }
+  }
+
+  const client = service.client;
   Object.defineProperties(stages, {
     then: {
       enumerable: false,
@@ -64,4 +77,22 @@ function serviceResponse(client, stages, finalizer) {
   return stages;
 }
 
-export { deprecate, serviceResponse };
+/**
+ * Mixin that allows a definition of an optional `let` stage for
+ * services is mixes in with.
+ *
+ * @param {*} Type the service to mixin
+ */
+function letMixin(Type) {
+  Type.prototype.let = function(options) {
+    Object.defineProperty(this, '__let__', {
+      enumerable: false, configurable: false, writable: false, value: options
+    });
+
+    return this;
+  };
+
+  return Type;
+}
+
+export { deprecate, serviceResponse, letMixin };

test/services/aws_s3.test.js

@@ -0,0 +1,26 @@
+const sinon = require('sinon');
+const S3Service = require('../../src/services/aws/s3_service');
+
+class TestFixture {}
+TestFixture.prototype.setup = function() {
+  this.client = { executePipeline: sinon.stub().resolves('foo') };
+  this.service = new S3Service(test.client, 'testS3');
+};
+
+const test = new TestFixture();
+describe('S3Service', function() {
+  describe('substages', () => {
+    beforeEach(() => test.setup());
+
+    it('should support a `let` argument', () => {
+      return test.service
+        .let({ test: '%%values.test' })
+        .put('bucket', 'key', 'acl', 'contentType')
+        .then(() => {
+          const stage = test.client.executePipeline.getCall(0).args[0][0];
+          expect(stage).toHaveProperty('let');
+          expect(stage.let).toEqual({ test: '%%values.test' });
+        });
+    });
+  });
+});