Initial Commit

Author: terodox

.gitignore

@@ -0,0 +1,65 @@
+# WebStorm
+.idea
+
+# Created by .ignore support plugin (hsz.mobi)
+### Node template
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+

.tavis.yml

@@ -0,0 +1,7 @@
+language: node_js
+install:
+  - npm install
+node_js:
+  - "4"
+  - "5"
+  - "6"

index.d.ts

@@ -0,0 +1 @@
+export declare function addPromiseSegment<T>(subSegmentName: string, promiseToWrap: Promise<T>);

index.js

@@ -0,0 +1,23 @@
+"use strict";
+
+const XRay = require("aws-xray-sdk");
+
+module.exports.addPromiseSegment = function (segmentName, inputPromise) {
+    if(!(inputPromise instanceof Promise)) {
+        return Promise.reject(new Error("First parameter must be of type Promise"));
+    }
+    return new Promise((resolve, reject) => {
+        XRay.captureAsyncFunc(segmentName, (subSegment) => {
+            inputPromise
+                .then(val => {
+                    resolve(val);
+                    subSegment.close();
+                })
+                .catch(err => {
+                    reject(err);
+                    subSegment.addErrorFlag();
+                    subSegment.close();
+                });
+        });
+    });
+};

package.json

@@ -0,0 +1,42 @@
+{
+  "name": "aws-xray-lambda-promise-subsegment",
+  "version": "1.0.0",
+  "description": "Allows adding a subsegment to XRay around any promise",
+  "main": "index.js",
+  "scripts": {
+    "test": "mocha ./test/**/*.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/terodox/aws-xray-lambda-promise-subsegment.git"
+  },
+  "keywords": [
+    "aws",
+    "lambda",
+    "xray",
+    "sdk",
+    "promise",
+    "segment",
+    "subsegment",
+    "tracing",
+    "awslambda",
+    "awsxray",
+    "awssdk"
+  ],
+  "author": "Andy Desmarais <[email protected]>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/terodox/aws-xray-lambda-promise-subsegment/issues"
+  },
+  "homepage": "https://github.com/terodox/aws-xray-lambda-promise-subsegment#readme",
+  "devDependencies": {
+    "chai": "^3.5.0",
+    "chai-as-promised": "^6.0.0",
+    "mocha": "^3.4.1",
+    "proxyquire": "^1.8.0",
+    "sinon": "^2.3.1"
+  },
+  "dependencies": {
+    "aws-xray-sdk": "^1.1.1"
+  }
+}

test/index.spec.js

@@ -0,0 +1,104 @@
+"use strict";
+
+let captureAsyncFuncValidation;
+require("proxyquire")(
+    "../index", {
+        "aws-xray-sdk" : {
+            captureAsyncFunc: (name, func) => {
+                captureAsyncFuncValidation(name, func);
+            }
+        }
+    }
+);
+
+const mocha = require("mocha");
+const chai = require("chai");
+const chaiAsPromised = require("chai-as-promised");
+const addPromiseSegment = require("../index").addPromiseSegment;
+
+const describe = mocha.describe;
+const it = mocha.it;
+
+chai.use(chaiAsPromised);
+const assert = chai.assert;
+
+describe("addPromiseSegment", function () {
+    const segmentName = "woohoo";
+
+    before(() => {
+        const subSegment = {
+            addErrorFlag: () => {},
+            close: () => {}
+        };
+        captureAsyncFuncValidation = (name, funcToInvoke) => { funcToInvoke(subSegment); };
+    });
+
+    it("is a function", () => {
+        assert.equal(typeof addPromiseSegment, typeof function () {});
+    });
+
+    it("rejects if second param is not a promise", () => {
+        return assert.isRejected(addPromiseSegment(segmentName, "nope nope nope"));
+    });
+
+    it("returns a promise", () => {
+        assert.instanceOf(addPromiseSegment(segmentName, Promise.resolve()), Promise);
+    });
+
+    it("rejects if passed promise rejects", () => {
+        return assert.isRejected(addPromiseSegment(segmentName, Promise.reject()));
+    });
+
+    it("resolves if passed promise resolves", () => {
+        return assert.isFulfilled(addPromiseSegment(segmentName, Promise.resolve()));
+    });
+
+    it("calls XRay.captureAsyncFunc", (done) => {
+        captureAsyncFuncValidation = () => {
+            done();
+        };
+        return assert.isFulfilled(addPromiseSegment(segmentName, Promise.resolve()));
+    });
+
+    it("call close on subSegment when promise rejects", (done) => {
+        const subSegment = {
+            addErrorFlag: () => {},
+            close: () => {
+                done();
+            }
+        };
+        captureAsyncFuncValidation = (name, func) => {
+            func(subSegment);
+        };
+
+        addPromiseSegment(segmentName, Promise.reject());
+    });
+
+    it("call addErrorFlag on subSegment when promise rejects", (done) => {
+        const subSegment = {
+            addErrorFlag: () => {
+                done();
+            },
+            close: () => {}
+        };
+        captureAsyncFuncValidation = (name, func) => {
+            func(subSegment);
+        };
+
+        addPromiseSegment(segmentName, Promise.reject());
+    });
+
+    it("call close on subSegment when promise resolves", (done) => {
+        const subSegment = {
+            addErrorFlag: () => {},
+            close: () => {
+                done();
+            }
+        };
+        captureAsyncFuncValidation = (name, func) => {
+            func(subSegment);
+        };
+
+        addPromiseSegment(segmentName, Promise.resolve());
+    });
+});