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

package/uoaHttps.ts

@@ -3,6 +3,8 @@ import * as http from "http";
 import { URL } from "url";
 import {context, propagation} from "@opentelemetry/api";
 import {RequestOptions} from "https";
+import {ClientRequest} from "http";
+import {XMLParser} from "fast-xml-parser";
 
 function request(options: RequestOptions | string | URL, callback?: (res: http.IncomingMessage) => void): http.ClientRequest;
 function request(url: string | URL, options: RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest;
@@ -27,24 +29,7 @@ async function doGetRequest(hostname: string, path: string, headers: any, port:
         }
         propagation.inject(context.active(), options.headers);
 
-        const req = https.request(options, function (response) {
-            const chunks: any[] = [];
-
-            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);
-            })
-        });
-
+        const req = doHttpsRequest(options, resolve, reject);
         req.end();
     });
 }
@@ -60,42 +45,8 @@ async function doPostRequest(hostname: string, path: string, headers: any, data:
         }
         propagation.inject(context.active(), options.headers);
 
-        const req = https.request(options, function (response) {
-            const chunks: any[] = [];
-
-            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: any = 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);
-            }
-        }
+        const req = doHttpsRequest(options, resolve, reject);
+        setRequestBody(req, data);
         req.end();
     });
 }
@@ -111,42 +62,8 @@ async function doPutRequest(hostname: string, path: string, headers: any, data:
         }
         propagation.inject(context.active(), options.headers);
 
-        const req = https.request(options, function (response) {
-            const chunks: any[] = [];
-
-            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: any = 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);
-            }
-        }
+        const req = doHttpsRequest(options, resolve, reject);
+        setRequestBody(req, data);
         req.end();
     });
 }
@@ -162,37 +79,72 @@ async function doDeleteRequest(hostname: string, path: string, headers: any, por
         }
         propagation.inject(context.active(), options.headers);
 
-        const req = https.request(options, function (response) {
-            const chunks: any[] = [];
-
-            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: any = Buffer.concat(chunks);
-                    if (!('Content-Type' in options.headers) || options.headers['Content-Type'] === 'application/json') {
-                        body = JSON.parse(body.toString());
+        const req = doHttpsRequest(options, resolve, reject);
+        req.end();
+    });
+}
+
+function doHttpsRequest(options: RequestOptions, resolve: any, reject: any): ClientRequest {
+    return https.request(options, function (response) {
+        const chunks: any[] = [];
+
+        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 = Buffer.concat(chunks);
+                    let parsedBody: any = body.toString();
+
+                    //Get the response content-type header value so we can apply different parsing methods
+                    const responseContentType: string = 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 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 {
-                        body = body.toString();
+                        reject(parsedBody);
                     }
-                    resolve(body);
+                } catch (e: any) {
+                    reject(e);
                 }
-            });
-
-            response.on("error", function (e) {
-                reject(e);
-            })
+            }
         });
 
-        req.end();
+        response.on("error", function (e) {
+            reject(e);
+        })
     });
 }
 
+function setRequestBody(request: ClientRequest, data: any) {
+    if (data) {
+        const requestContentType: string = 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,
@@ -200,3 +152,4 @@ module.exports = {
     doPutRequest,
     doDeleteRequest
 }
+

package/dist/zipkin/platform/index.d.ts

@@ -1,4 +0,0 @@
-/**
- * Copied from https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-exporter-zipkin/src/platform/index.ts
- */
-export * from './node';

package/dist/zipkin/platform/index.js

@@ -1,35 +0,0 @@
-"use strict";
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Copied from https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-exporter-zipkin/src/platform/index.ts
- */
-__exportStar(require("./node"), exports);

package/dist/zipkin/platform/node/index.d.ts

@@ -1,4 +0,0 @@
-/**
- * Copied from https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-exporter-zipkin/src/platform/node/index.ts
- */
-export * from './util';

package/dist/zipkin/platform/node/index.js

@@ -1,35 +0,0 @@
-"use strict";
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Copied from https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-exporter-zipkin/src/platform/node/index.ts
- */
-__exportStar(require("./util"), exports);

package/dist/zipkin/platform/node/util.d.ts

@@ -1,8 +0,0 @@
-import * as zipkinTypes from '../../types';
-/**
- * Prepares send function that will send spans to the remote Zipkin service.
- * @param urlStr - url to send spans
- * @param headers - headers
- * send
- */
-export declare function prepareSend(urlStr: string, headers?: Record<string, string>): zipkinTypes.SendFn;

package/dist/zipkin/platform/node/util.js

@@ -1,105 +0,0 @@
-"use strict";
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.prepareSend = void 0;
-/**
- * Copied from https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-exporter-zipkin/src/platform/node/util.ts
- */
-const api_1 = require("@opentelemetry/api");
-const core_1 = require("@opentelemetry/core");
-const http = __importStar(require("http"));
-const https = __importStar(require("https"));
-const url = __importStar(require("url"));
-/**
- * Prepares send function that will send spans to the remote Zipkin service.
- * @param urlStr - url to send spans
- * @param headers - headers
- * send
- */
-function prepareSend(urlStr, headers) {
-    const urlOpts = url.parse(urlStr);
-    const reqOpts = Object.assign({
-        method: 'POST',
-        headers: Object.assign({ 'Content-Type': 'application/json' }, headers),
-    }, urlOpts);
-    /**
-     * Send spans to the remote Zipkin service.
-     */
-    return function send(zipkinSpans, done) {
-        if (zipkinSpans.length === 0) {
-            api_1.diag.debug('Zipkin send with empty spans');
-            return done({ code: core_1.ExportResultCode.SUCCESS });
-        }
-        const { request } = reqOpts.protocol === 'http:' ? http : https;
-        const req = request(reqOpts, (res) => {
-            let rawData = '';
-            res.on('data', chunk => {
-                rawData += chunk;
-            });
-            res.on('end', () => {
-                const statusCode = res.statusCode || 0;
-                api_1.diag.debug(`Zipkin response status code: ${statusCode}, body: ${rawData}`);
-                // Consider 2xx and 3xx as success.
-                if (statusCode < 400) {
-                    return done({ code: core_1.ExportResultCode.SUCCESS });
-                    // Consider 4xx as failed non-retriable.
-                }
-                else {
-                    return done({
-                        code: core_1.ExportResultCode.FAILED,
-                        error: new Error(`Got unexpected status code from zipkin: ${statusCode}`),
-                    });
-                }
-            });
-        });
-        req.on('error', error => {
-            return done({
-                code: core_1.ExportResultCode.FAILED,
-                error,
-            });
-        });
-        // Issue request to remote service
-        const payload = JSON.stringify(zipkinSpans);
-        api_1.diag.debug(`Zipkin request payload: ${payload}`);
-        req.write(payload, 'utf8');
-        req.end();
-    };
-}
-exports.prepareSend = prepareSend;

package/dist/zipkin/transform.d.ts

@@ -1,22 +0,0 @@
-/**
- * Copied from https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-exporter-zipkin/src/transform.ts
- *
- * Modified to handle our traceId length being either 16 or 32 characters, and to send the correct Parent Span ID
- */
-import * as api from '@opentelemetry/api';
-import { ReadableSpan, TimedEvent } from '@opentelemetry/sdk-trace-base';
-import * as zipkinTypes from './types';
-import { Resource } from '@opentelemetry/resources';
-export declare const defaultStatusCodeTagName = "otel.status_code";
-export declare const defaultStatusErrorTagName = "error";
-/**
- * Translate OpenTelemetry ReadableSpan to ZipkinSpan format
- * @param span Span to be translated
- */
-export declare function toZipkinSpan(span: ReadableSpan, serviceName: string, statusCodeTagName: string, statusErrorTagName: string): zipkinTypes.Span;
-/** Converts OpenTelemetry SpanAttributes and SpanStatus to Zipkin Tags format. */
-export declare function _toZipkinTags(attributes: api.SpanAttributes, status: api.SpanStatus, statusCodeTagName: string, statusErrorTagName: string, resource: Resource): zipkinTypes.Tags;
-/**
- * Converts OpenTelemetry Events to Zipkin Annotations format.
- */
-export declare function _toZipkinAnnotations(events: TimedEvent[]): zipkinTypes.Annotation[];

package/dist/zipkin/transform.js

@@ -1,113 +0,0 @@
-"use strict";
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports._toZipkinAnnotations = exports._toZipkinTags = exports.toZipkinSpan = exports.defaultStatusErrorTagName = exports.defaultStatusCodeTagName = void 0;
-/**
- * Copied from https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-exporter-zipkin/src/transform.ts
- *
- * Modified to handle our traceId length being either 16 or 32 characters, and to send the correct Parent Span ID
- */
-const api = __importStar(require("@opentelemetry/api"));
-const core_1 = require("@opentelemetry/core");
-const zipkinTypes = __importStar(require("./types"));
-const api_1 = require("@opentelemetry/api");
-const UoaB3Propagator_1 = require("../UoaB3Propagator");
-const ZIPKIN_SPAN_KIND_MAPPING = {
-    [api.SpanKind.CLIENT]: zipkinTypes.SpanKind.CLIENT,
-    [api.SpanKind.SERVER]: zipkinTypes.SpanKind.SERVER,
-    [api.SpanKind.CONSUMER]: zipkinTypes.SpanKind.CONSUMER,
-    [api.SpanKind.PRODUCER]: zipkinTypes.SpanKind.PRODUCER,
-    // When absent, the span is local.
-    //@ts-ignore
-    [api.SpanKind.INTERNAL]: undefined,
-};
-exports.defaultStatusCodeTagName = 'otel.status_code';
-exports.defaultStatusErrorTagName = 'error';
-/**
- * Translate OpenTelemetry ReadableSpan to ZipkinSpan format
- * @param span Span to be translated
- */
-function toZipkinSpan(span, serviceName, statusCodeTagName, statusErrorTagName) {
-    const traceIdLength = api_1.context.active().getValue(UoaB3Propagator_1.B3_TRACE_ID_LENGTH_KEY);
-    let traceId = span.spanContext().traceId.slice(span.spanContext().traceId.length - traceIdLength);
-    const parentSpanId = api_1.context.active().getValue(UoaB3Propagator_1.B3_PARENT_SPAN_ID_KEY);
-    const zipkinSpan = {
-        traceId: traceId,
-        parentId: parentSpanId || span.parentSpanId,
-        name: span.name,
-        id: span.spanContext().spanId,
-        kind: ZIPKIN_SPAN_KIND_MAPPING[span.kind],
-        timestamp: (0, core_1.hrTimeToMicroseconds)(span.startTime),
-        duration: (0, core_1.hrTimeToMicroseconds)(span.duration),
-        localEndpoint: { serviceName },
-        tags: _toZipkinTags(span.attributes, span.status, statusCodeTagName, statusErrorTagName, span.resource),
-        annotations: span.events.length
-            ? _toZipkinAnnotations(span.events)
-            : undefined,
-    };
-    return zipkinSpan;
-}
-exports.toZipkinSpan = toZipkinSpan;
-/** Converts OpenTelemetry SpanAttributes and SpanStatus to Zipkin Tags format. */
-function _toZipkinTags(attributes, status, statusCodeTagName, statusErrorTagName, resource) {
-    const tags = {};
-    for (const key of Object.keys(attributes)) {
-        tags[key] = String(attributes[key]);
-    }
-    if (status.code !== api.SpanStatusCode.UNSET) {
-        tags[statusCodeTagName] = String(api.SpanStatusCode[status.code]);
-    }
-    if (status.code === api.SpanStatusCode.ERROR && status.message) {
-        tags[statusErrorTagName] = status.message;
-    }
-    Object.keys(resource.attributes).forEach(name => (tags[name] = String(resource.attributes[name])));
-    return tags;
-}
-exports._toZipkinTags = _toZipkinTags;
-/**
- * Converts OpenTelemetry Events to Zipkin Annotations format.
- */
-function _toZipkinAnnotations(events) {
-    return events.map(event => ({
-        timestamp: (0, core_1.hrTimeToMicroseconds)(event.time),
-        value: event.name,
-    }));
-}
-exports._toZipkinAnnotations = _toZipkinAnnotations;