@uoa/lambda-tracing 2.0.1 → 2.1.0-beta.2

package/changelog.md

@@ -0,0 +1,41 @@
+# Changelog
+
+## 2.1.0
+- Unexpected errors are now caught within the library. When this occurs, the request promise will reject with the error.
+- http response promises will now be rejected if the response code is not in the 2xx range
+- The response content-type header is now correctly checked to convert the response body. Previously the response transformation was checking the content-type header of the request. If the content-type header is not present, it will attempt to transform the response to JSON.
+- Added support for XML responses - these will be parsed to an object
+- Added support for Image responses - these will be parsed to a base64 string
+
+## [Deprecated] 2.0.0, 2.0.1, 2.0.2
+- Changes for Zipkin which have since been removed
+- Do not use these versions
+
+## 1.6.0
+- Fix error when logged message was undefined
+
+## 1.5.0
+- Generate a new span ID instead of using that of the incoming request.
+- Use the incoming request's span ID as the current span's parent span ID.
+
+## 1.4.0
+- Add support for 16 and 32 character trace IDs
+- Add function to allow getting and setting the X-B3-Info header
+
+## 1.3.0
+- Add optional port parameter to all functions in uoaHttps module. Defaults to 443 if not specified
+
+## 1.2.0
+- Fix newlines not logging correctly in logging module
+
+## 1.1.1
+- Update readme with information on Kong plugin requirements
+
+## 1.1.0
+- Add uoaHttps module to propagate tracing headers through http requests
+
+## 1.0.1
+- Fix formatting in readme
+
+## 1.0.0
+- Initial release with Lambda tracing & logging functionality

package/dist/tracing.d.ts

@@ -1,3 +1,3 @@
-export declare function initializeTracing(serviceName: string): void;
+export declare function initializeTracing(): void;
 export declare function getTraceInfoHeader(): string;
 export declare function setTraceInfoHeader(info: string): void;

package/dist/tracing.js

@@ -7,15 +7,9 @@ const instrumentation_1 = require("@opentelemetry/instrumentation");
 const UoaB3Propagator_1 = require("./UoaB3Propagator");
 const api_1 = require("@opentelemetry/api");
 const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
-const zipkin_1 = require("./zipkin/zipkin");
 const provider = new sdk_trace_node_1.NodeTracerProvider({ sampler: new sdk_trace_base_1.AlwaysOnSampler() });
 let infoHeader;
-function initializeTracing(serviceName) {
-    const options = {
-        url: process.env.zipkinUrl ? process.env.zipkinUrl : 'http://internal-zipkin-uoa-its-nonprod-internal-1407434909.ap-southeast-2.elb.amazonaws.com:443/api/v2/spans',
-        serviceName: serviceName
-    };
-    provider.addSpanProcessor(new sdk_trace_node_1.BatchSpanProcessor(new zipkin_1.ZipkinExporter(options)));
+function initializeTracing() {
     provider.register({
         propagator: new UoaB3Propagator_1.UoaB3Propagator()
     });

package/dist/uoaHttps.js

@@ -22,18 +22,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 const https = __importStar(require("https"));
 const api_1 = require("@opentelemetry/api");
+const fast_xml_parser_1 = require("fast-xml-parser");
 function request(...args) {
     if (args[2]) {
         api_1.propagation.inject(api_1.context.active(), args[1].headers);
@@ -44,175 +36,124 @@ function request(...args) {
         return https.request(args[0], args[1]);
     }
 }
-function doGetRequest(hostname, path, headers, port = 443) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return new Promise(function (resolve, reject) {
-            const options = {
-                "method": "GET",
-                "hostname": hostname,
-                "path": path,
-                "headers": headers,
-                "port": port
-            };
-            api_1.propagation.inject(api_1.context.active(), options.headers);
-            const req = https.request(options, function (response) {
-                const chunks = [];
-                response.on("data", function (chunk) {
-                    chunks.push(chunk);
-                });
-                response.on("end", function () {
-                    let body = Buffer.concat(chunks);
-                    body = JSON.parse(body.toString());
-                    resolve(body);
-                });
-                response.on("error", function (e) {
-                    reject(e);
-                });
-            });
-            req.end();
-        });
+async function doGetRequest(hostname, path, headers, port = 443) {
+    return new Promise(function (resolve, reject) {
+        const options = {
+            "method": "GET",
+            "hostname": hostname,
+            "path": path,
+            "headers": headers,
+            "port": port
+        };
+        api_1.propagation.inject(api_1.context.active(), options.headers);
+        const req = doHttpsRequest(options, resolve, reject);
+        req.end();
     });
 }
-function doPostRequest(hostname, path, headers, data, port = 443) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return new Promise(function (resolve, reject) {
-            const options = {
-                "method": "POST",
-                "hostname": hostname,
-                "path": path,
-                "headers": headers,
-                "port": port
-            };
-            api_1.propagation.inject(api_1.context.active(), options.headers);
-            const req = https.request(options, function (response) {
-                const chunks = [];
-                response.on("data", function (chunk) {
-                    chunks.push(chunk);
-                });
-                response.on("end", function () {
-                    if (response.statusCode == 204) {
-                        //204 is no content, and most JSON parses blow up on an empty string
-                        resolve(null);
-                    }
-                    else {
-                        let body = Buffer.concat(chunks);
-                        if (!('Content-Type' in options.headers) || options.headers['Content-Type'] === 'application/json') {
-                            body = JSON.parse(body.toString());
-                        }
-                        else {
-                            body = body.toString();
-                        }
-                        resolve(body);
-                    }
-                });
-                response.on("error", function (e) {
-                    reject(e);
-                });
-            });
-            if (data) {
-                if (!('Content-Type' in options.headers) || options.headers['Content-Type'] === 'application/json') {
-                    //We serialize using JSON.stringify as a default, or if a JSON is specified
-                    req.write(JSON.stringify(data));
-                }
-                else {
-                    // If another content-type is specified however, we respect the serialization provided
-                    req.write(data);
-                }
-            }
-            req.end();
-        });
+async function doPostRequest(hostname, path, headers, data, port = 443) {
+    return new Promise(function (resolve, reject) {
+        const options = {
+            "method": "POST",
+            "hostname": hostname,
+            "path": path,
+            "headers": headers,
+            "port": port
+        };
+        api_1.propagation.inject(api_1.context.active(), options.headers);
+        const req = doHttpsRequest(options, resolve, reject);
+        setRequestBody(req, data);
+        req.end();
+    });
+}
+async function doPutRequest(hostname, path, headers, data, port = 443) {
+    return new Promise(function (resolve, reject) {
+        const options = {
+            "method": "PUT",
+            "hostname": hostname,
+            "path": path,
+            "headers": headers,
+            "port": port
+        };
+        api_1.propagation.inject(api_1.context.active(), options.headers);
+        const req = doHttpsRequest(options, resolve, reject);
+        setRequestBody(req, data);
+        req.end();
+    });
+}
+async function doDeleteRequest(hostname, path, headers, port = 443) {
+    return new Promise(function (resolve, reject) {
+        const options = {
+            "method": "DELETE",
+            "hostname": hostname,
+            "path": path,
+            "headers": headers,
+            "port": port
+        };
+        api_1.propagation.inject(api_1.context.active(), options.headers);
+        const req = doHttpsRequest(options, resolve, reject);
+        req.end();
     });
 }
-function doPutRequest(hostname, path, headers, data, port = 443) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return new Promise(function (resolve, reject) {
-            const options = {
-                "method": "PUT",
-                "hostname": hostname,
-                "path": path,
-                "headers": headers,
-                "port": port
-            };
-            api_1.propagation.inject(api_1.context.active(), options.headers);
-            const req = https.request(options, function (response) {
-                const chunks = [];
-                response.on("data", function (chunk) {
-                    chunks.push(chunk);
-                });
-                response.on("end", function () {
-                    if (response.statusCode == 204) {
-                        //204 is no content, and most JSON parses blow up on an empty string
-                        resolve(null);
+function doHttpsRequest(options, resolve, reject) {
+    return https.request(options, function (response) {
+        const chunks = [];
+        response.on("data", function (chunk) {
+            chunks.push(chunk);
+        });
+        response.on("end", function () {
+            if (response.statusCode === 204) {
+                //204 is no content, and most JSON parses blow up on an empty string
+                resolve(null);
+            }
+            else {
+                try {
+                    let body = Buffer.concat(chunks);
+                    let parsedBody = body.toString();
+                    //Get the response content-type header value so we can apply different parsing methods
+                    const responseContentType = response.headers["content-type"]?.toLowerCase() ?? '';
+                    if (responseContentType === '' || responseContentType.includes('application/json')) {
+                        parsedBody = JSON.parse(body.toString());
+                    }
+                    else if (responseContentType.includes('application/xml') || responseContentType.includes('text/xml')) {
+                        const parser = new fast_xml_parser_1.XMLParser({
+                            ignoreDeclaration: true,
+                            ignorePiTags: true
+                        });
+                        parsedBody = parser.parse(body.toString());
+                    }
+                    else if (responseContentType.includes('image/')) {
+                        parsedBody = body.toString('base64');
+                    }
+                    if (response.statusCode !== undefined && response.statusCode >= 200 && response.statusCode < 300) {
+                        resolve(parsedBody);
                     }
                     else {
-                        let body = Buffer.concat(chunks);
-                        if (!('Content-Type' in options.headers) || options.headers['Content-Type'] === 'application/json') {
-                            body = JSON.parse(body.toString());
-                        }
-                        else {
-                            body = body.toString();
-                        }
-                        resolve(body);
+                        reject(parsedBody);
                     }
-                });
-                response.on("error", function (e) {
-                    reject(e);
-                });
-            });
-            if (data) {
-                if (!('Content-Type' in options.headers) || options.headers['Content-Type'] === 'application/json') {
-                    //We serialize using JSON.stringify as a default, or if a JSON is specified
-                    req.write(JSON.stringify(data));
                 }
-                else {
-                    // If another content-type is specified however, we respect the serialization provided
-                    req.write(data);
+                catch (e) {
+                    reject(e);
                 }
             }
-            req.end();
         });
-    });
-}
-function doDeleteRequest(hostname, path, headers, port = 443) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return new Promise(function (resolve, reject) {
-            const options = {
-                "method": "DELETE",
-                "hostname": hostname,
-                "path": path,
-                "headers": headers,
-                "port": port
-            };
-            api_1.propagation.inject(api_1.context.active(), options.headers);
-            const req = https.request(options, function (response) {
-                const chunks = [];
-                response.on("data", function (chunk) {
-                    chunks.push(chunk);
-                });
-                response.on("end", function () {
-                    if (response.statusCode == 204) {
-                        //204 is no content, and most JSON parses blow up on an empty string
-                        resolve(null);
-                    }
-                    else {
-                        let body = Buffer.concat(chunks);
-                        if (!('Content-Type' in options.headers) || options.headers['Content-Type'] === 'application/json') {
-                            body = JSON.parse(body.toString());
-                        }
-                        else {
-                            body = body.toString();
-                        }
-                        resolve(body);
-                    }
-                });
-                response.on("error", function (e) {
-                    reject(e);
-                });
-            });
-            req.end();
+        response.on("error", function (e) {
+            reject(e);
         });
     });
 }
+function setRequestBody(request, data) {
+    if (data) {
+        const requestContentType = request.getHeader('content-type')?.toString() ?? '';
+        if (requestContentType === '' || requestContentType.includes('application/json')) {
+            //We serialize using JSON.stringify as a default, or if JSON is specified
+            request.write(JSON.stringify(data));
+        }
+        else {
+            // If another content-type is specified however, we respect the serialization provided
+            request.write(data);
+        }
+    }
+}
 module.exports = {
     request,
     doGetRequest,

package/package.json

@@ -1,43 +1,45 @@
-{
-  "name": "@uoa/lambda-tracing",
-  "version": "2.0.1",
-  "description": "Library for logging & distributed tracing in UoA Lambda projects",
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@bitbucket.org/uoa/lambda-tracing.git"
-  },
-  "author": "Mitchell Faulconbridge <mitchell.faulconbridge@auckland.ac.nz>",
-  "license": "MIT",
-  "homepage": "https://bitbucket.org/uoa/lambda-tracing#readme",
-  "keywords": [
-    "uoa",
-    "lambda",
-    "logging",
-    "distributed-tracing"
-  ],
-  "main": "dist/tracing.js",
-  "types": "dist/tracing.d.ts",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "prepare": "tsc"
-  },
-  "exports": {
-    ".": "./dist/tracing.js",
-    "./tracing": "./dist/tracing.js",
-    "./uoaHttps": "./dist/uoaHttps.js",
-    "./logging": "./dist/logging.js"
-  },
-  "dependencies": {
-    "@opentelemetry/api": "^1.1.0",
-    "@opentelemetry/core": "^1.8.0",
-    "@opentelemetry/instrumentation": "^0.28.0",
-    "@opentelemetry/instrumentation-aws-lambda": "^0.31.0",
-    "@opentelemetry/sdk-trace-node": "^1.8.0",
-    "moment": "^2.29.3",
-    "winston": "^3.7.2"
-  },
-  "devDependencies": {
-    "@types/node": "^17.0.35",
-    "typescript": "^4.7.2"
-  }
-}
+{
+  "name": "@uoa/lambda-tracing",
+  "version": "2.1.0-beta.2",
+  "description": "Library for logging & distributed tracing in UoA Lambda projects",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@bitbucket.org/uoa/lambda-tracing.git"
+  },
+  "author": "Mitchell Faulconbridge <mitchell.faulconbridge@auckland.ac.nz>",
+  "license": "MIT",
+  "homepage": "https://bitbucket.org/uoa/lambda-tracing#readme",
+  "keywords": [
+    "uoa",
+    "lambda",
+    "logging",
+    "distributed-tracing"
+  ],
+  "main": "dist/tracing.js",
+  "types": "dist/tracing.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepare": "tsc",
+    "prepack": "tsc"
+  },
+  "exports": {
+    ".": "./dist/tracing.js",
+    "./tracing": "./dist/tracing.js",
+    "./uoaHttps": "./dist/uoaHttps.js",
+    "./logging": "./dist/logging.js"
+  },
+  "dependencies": {
+    "@opentelemetry/api": "^1.1.0",
+    "@opentelemetry/core": "^1.8.0",
+    "@opentelemetry/instrumentation": "^0.28.0",
+    "@opentelemetry/instrumentation-aws-lambda": "^0.31.0",
+    "@opentelemetry/sdk-trace-node": "^1.8.0",
+    "fast-xml-parser": "^4.3.4",
+    "moment": "^2.29.3",
+    "winston": "^3.7.2"
+  },
+  "devDependencies": {
+    "@types/node": "^17.0.35",
+    "typescript": "^4.7.2"
+  }
+}

package/tracing.ts

@@ -1,21 +1,14 @@
-import {NodeTracerProvider, BatchSpanProcessor} from '@opentelemetry/sdk-trace-node';
+import {NodeTracerProvider} from '@opentelemetry/sdk-trace-node';
 import {AwsLambdaInstrumentation} from '@opentelemetry/instrumentation-aws-lambda';
 import {registerInstrumentations} from '@opentelemetry/instrumentation';
 import {B3_INFO_KEY, UoaB3Propagator} from "./UoaB3Propagator";
 import {context} from "@opentelemetry/api";
 import {AlwaysOnSampler} from "@opentelemetry/sdk-trace-base";
-import {ZipkinExporter} from "./zipkin/zipkin";
 
 const provider = new NodeTracerProvider({sampler: new AlwaysOnSampler()});
 let infoHeader: string | undefined;
 
-export function initializeTracing(serviceName: string) {
-    const options = {
-        url: process.env.zipkinUrl ? process.env.zipkinUrl : 'http://internal-zipkin-uoa-its-nonprod-internal-1407434909.ap-southeast-2.elb.amazonaws.com:443/api/v2/spans',
-        serviceName: serviceName
-    }
-    provider.addSpanProcessor(new BatchSpanProcessor(new ZipkinExporter(options)));
-
+export function initializeTracing() {
     provider.register({
         propagator: new UoaB3Propagator()
     });
@@ -34,8 +27,7 @@ export function initializeTracing(serviceName: string) {
                 disableAwsContextPropagation: true
             })
         ]
-    })
-
+    });
 }
 
 export function getTraceInfoHeader(): string {

package/tsconfig.json

@@ -11,7 +11,7 @@
     // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
 
     /* Language and Environment */
-    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "target": "ES2020",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
     // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
     // "jsx": "preserve",                                /* Specify what JSX code is generated. */
     // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
@@ -25,7 +25,7 @@
     // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
 
     /* Modules */
-    "module": "commonjs",                                /* Specify what module code is generated. */
+    "module": "CommonJS",                                /* Specify what module code is generated. */
     // "rootDir": "./",                                  /* Specify the root folder within your source files. */
     // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
     // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */