@optimizely-opal/opal-tool-ocp-sdk 1.0.0-beta.1 → 1.0.0-beta.10

package/dist/logging/ToolLogger.js

@@ -0,0 +1,255 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolLogger = void 0;
+const app_sdk_1 = require("@zaiusinc/app-sdk");
+const MAX_PARAM_LOG_LENGTH = 128;
+const MAX_BODY_LOG_LENGTH = 256;
+const MAX_ARRAY_ITEMS = 2;
+/**
+ * Utility class for logging Opal tool requests and responses with security considerations
+ */
+class ToolLogger {
+    static SENSITIVE_FIELDS = [
+        // Authentication / secrets
+        'password',
+        'pass',
+        'secret',
+        'key',
+        'token',
+        'auth',
+        'credentials',
+        'access_token',
+        'refresh_token',
+        'api_key',
+        'private_key',
+        'client_secret',
+        'session_token',
+        'authorization',
+        // Payment-related
+        'card_number',
+        'credit_card',
+        'cvv',
+        'expiry_date',
+        // Personal info
+        'ssn', // social security number
+        'nid', // national ID
+        'passport',
+        'dob', // date of birth
+        'email',
+        'phone',
+        'address',
+        // Misc / environment
+        'otp',
+        'pin',
+        'security_answer',
+        'security_question',
+        'signing_key',
+        'encryption_key',
+        'jwt',
+        'bearer_token'
+    ];
+    /**
+     * Redacts sensitive data from an object
+     */
+    static redactSensitiveDataAndTruncate(data, maxDepth = 5, accumulatedLength = 0) {
+        if (accumulatedLength > MAX_BODY_LOG_LENGTH) {
+            return '';
+        }
+        if (maxDepth <= 0) {
+            return '[MAX_DEPTH_EXCEEDED]';
+        }
+        if (data === null || data === undefined) {
+            return data;
+        }
+        if (typeof data === 'string') {
+            if (data.length > MAX_PARAM_LOG_LENGTH) {
+                const lead = data.substring(0, MAX_PARAM_LOG_LENGTH - 10);
+                const tail = data.substring(data.length - 10);
+                return `${lead}...[${data.length - MAX_PARAM_LOG_LENGTH} truncated]...${tail}`;
+            }
+            else {
+                return data;
+            }
+        }
+        if (typeof data === 'number' || typeof data === 'boolean') {
+            return data;
+        }
+        if (Array.isArray(data)) {
+            const truncated = data.slice(0, MAX_ARRAY_ITEMS);
+            const result = truncated.map((item) => this.redactSensitiveDataAndTruncate(item, maxDepth, accumulatedLength));
+            if (data.length > MAX_ARRAY_ITEMS) {
+                result.push(`... (${data.length - MAX_ARRAY_ITEMS} more items truncated)`);
+            }
+            return result;
+        }
+        if (typeof data === 'object') {
+            const result = {};
+            for (const [key, value] of Object.entries(data)) {
+                if (accumulatedLength > MAX_BODY_LOG_LENGTH) {
+                    break;
+                }
+                // Check if this field contains sensitive data
+                const isSensitive = this.isSensitiveField(key);
+                if (isSensitive) {
+                    result[key] = '[REDACTED]';
+                }
+                else {
+                    result[key] = this.redactSensitiveDataAndTruncate(value, maxDepth - 1, accumulatedLength);
+                }
+                if (result[key]) {
+                    accumulatedLength += JSON.stringify(result[key]).length;
+                }
+            }
+            return result;
+        }
+        return data;
+    }
+    /**
+     * Checks if a field name is considered sensitive
+     */
+    static isSensitiveField(fieldName) {
+        const lowerKey = fieldName.toLowerCase();
+        return this.SENSITIVE_FIELDS.some((sensitiveField) => lowerKey.includes(sensitiveField));
+    }
+    /**
+     * Creates a summary of request parameters
+     */
+    static createParameterSummary(params) {
+        if (!params) {
+            return null;
+        }
+        return this.redactSensitiveDataAndTruncate(params);
+    }
+    /**
+     * Calculates content length of response data
+     */
+    static calculateContentLength(response) {
+        if (!response) {
+            return 0;
+        }
+        try {
+            return response.bodyAsU8Array?.length || 'unknown';
+        }
+        catch {
+            return 'unknown';
+        }
+    }
+    /**
+     * Extracts the response body as a string or parsed JSON object
+     */
+    static getResponseBody(response) {
+        if (!response) {
+            return null;
+        }
+        try {
+            const contentType = response.headers?.get('content-type') || '';
+            const isJson = contentType.includes('application/json') || contentType.includes('application/problem+json');
+            const isText = contentType.startsWith('text/');
+            if (!isJson && !isText) {
+                return null;
+            }
+            // Try to access bodyAsU8Array - this may throw
+            const bodyData = response.bodyAsU8Array;
+            if (!bodyData) {
+                return null;
+            }
+            // Convert Uint8Array to string
+            const bodyString = Buffer.from(bodyData).toString();
+            if (!bodyString) {
+                return null;
+            }
+            // Try to parse as JSON if content-type indicates JSON
+            if (isJson) {
+                try {
+                    return JSON.parse(bodyString);
+                }
+                catch {
+                    // If JSON parsing fails, return as string
+                    return bodyString;
+                }
+            }
+            // Return as plain text for non-JSON content types
+            return bodyString;
+        }
+        catch {
+            return null;
+        }
+    }
+    /**
+     * Creates a summary of response body with security redaction and truncation
+     * For failed responses (4xx, 5xx): returns full body with redacted sensitive data
+     * For successful responses (2xx): returns first 100 chars with redacted sensitive data
+     */
+    static createResponseBodySummary(response, success) {
+        const body = this.getResponseBody(response);
+        if (body === null || body === undefined) {
+            return null;
+        }
+        // For objects (parsed JSON), apply redaction
+        if (typeof body === 'object') {
+            // For failed responses, don't truncate strings within the object
+            const redactedBody = this.redactSensitiveDataAndTruncate(body, 5);
+            // For successful responses, truncate to first MAX_BODY_LOG_LENGTH chars
+            if (success) {
+                const bodyString = JSON.stringify(redactedBody);
+                if (bodyString.length > MAX_BODY_LOG_LENGTH) {
+                    const truncated = bodyString.substring(0, MAX_BODY_LOG_LENGTH);
+                    return `${truncated}... (truncated)`;
+                }
+                return redactedBody;
+            }
+            // For failed responses, return full redacted body
+            return redactedBody;
+        }
+        // For strings (plain text or unparseable JSON)
+        if (typeof body === 'string') {
+            // For successful responses, truncate to first 100 chars
+            if (success) {
+                if (body.length > MAX_BODY_LOG_LENGTH) {
+                    return `${body.substring(0, MAX_BODY_LOG_LENGTH)}... (truncated)`;
+                }
+                return body;
+            }
+            // For failed responses, return full body
+            return body;
+        }
+        return body;
+    }
+    /**
+     * Logs an incoming request
+     */
+    static logRequest(req) {
+        const params = req.bodyJSON && req.bodyJSON.parameters ? req.bodyJSON.parameters : req.bodyJSON;
+        const requestLog = {
+            event: 'opal_tool_request',
+            path: req.path,
+            method: req.method,
+            parameters: this.createParameterSummary(params)
+        };
+        // Log with Zaius audience so developers only see requests for accounts they have access to
+        app_sdk_1.logger.info(app_sdk_1.LogVisibility.Zaius, JSON.stringify(requestLog));
+    }
+    /**
+     * Logs a successful response
+     */
+    static logResponse(req, response, processingTimeMs) {
+        const success = response.status >= 200 && response.status < 300;
+        const responseLog = {
+            event: 'opal_tool_response',
+            path: req.path,
+            duration: processingTimeMs ? `${processingTimeMs}ms` : undefined,
+            status: response.status,
+            contentType: response.headers?.get('content-type') || 'unknown',
+            contentLength: this.calculateContentLength(response),
+            success
+        };
+        const responseBodySummary = this.createResponseBodySummary(response, success);
+        if (responseBodySummary) {
+            responseLog.responseBody = responseBodySummary;
+        }
+        // Log with Zaius audience so developers only see requests for accounts they have access to
+        app_sdk_1.logger.info(app_sdk_1.LogVisibility.Zaius, JSON.stringify(responseLog));
+    }
+}
+exports.ToolLogger = ToolLogger;
+//# sourceMappingURL=ToolLogger.js.map

package/dist/logging/ToolLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolLogger.js","sourceRoot":"","sources":["../../src/logging/ToolLogger.ts"],"names":[],"mappings":";;;AAAA,+CAA0D;AAG1D,MAAM,oBAAoB,GAAG,GAAG,CAAC;AACjC,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAChC,MAAM,eAAe,GAAG,CAAC,CAAC;AAE1B;;GAEG;AACH,MAAa,UAAU;IACb,MAAM,CAAU,gBAAgB,GAAG;QACzC,2BAA2B;QAC3B,UAAU;QACV,MAAM;QACN,QAAQ;QACR,KAAK;QACL,OAAO;QACP,MAAM;QACN,aAAa;QACb,cAAc;QACd,eAAe;QACf,SAAS;QACT,aAAa;QACb,eAAe;QACf,eAAe;QACf,eAAe;QAEf,kBAAkB;QAClB,aAAa;QACb,aAAa;QACb,KAAK;QACL,aAAa;QAEb,gBAAgB;QAChB,KAAK,EAAE,yBAAyB;QAChC,KAAK,EAAE,cAAc;QACrB,UAAU;QACV,KAAK,EAAE,gBAAgB;QACvB,OAAO;QACP,OAAO;QACP,SAAS;QAET,qBAAqB;QACrB,KAAK;QACL,KAAK;QACL,iBAAiB;QACjB,mBAAmB;QACnB,aAAa;QACb,gBAAgB;QAChB,KAAK;QACL,cAAc;KACf,CAAC;IAEF;;OAEG;IACK,MAAM,CAAC,8BAA8B,CAAC,IAAS,EAAE,QAAQ,GAAG,CAAC,EAAE,iBAAiB,GAAG,CAAC;QAC1F,IAAI,iBAAiB,GAAG,mBAAmB,EAAE,CAAC;YAC5C,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,QAAQ,IAAI,CAAC,EAAE,CAAC;YAClB,OAAO,sBAAsB,CAAC;QAChC,CAAC;QAED,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,IAAI,IAAI,CAAC,MAAM,GAAG,oBAAoB,EAAE,CAAC;gBACvC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,oBAAoB,GAAG,EAAE,CAAC,CAAC;gBAC1D,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;gBAC9C,OAAO,GAAG,IAAI,OAAO,IAAI,CAAC,MAAM,GAAG,oBAAoB,iBAAiB,IAAI,EAAE,CAAC;YACjF,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QAED,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE,CAAC;YAC1D,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;YACjD,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,8BAA8B,CAAC,IAAI,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC;YAC/G,IAAI,IAAI,CAAC,MAAM,GAAG,eAAe,EAAE,CAAC;gBAClC,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,MAAM,GAAG,eAAe,wBAAwB,CAAC,CAAC;YAC7E,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAQ,EAAE,CAAC;YACvB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAChD,IAAI,iBAAiB,GAAG,mBAAmB,EAAE,CAAC;oBAC5C,MAAM;gBACR,CAAC;gBACD,8CAA8C;gBAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;gBAE/C,IAAI,WAAW,EAAE,CAAC;oBAChB,MAAM,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;gBAC7B,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,8BAA8B,CAAC,KAAK,EAAE,QAAQ,GAAG,CAAC,EAAE,iBAAiB,CAAC,CAAC;gBAC5F,CAAC;gBAED,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;oBAChB,iBAAiB,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC;gBAC1D,CAAC;YACH,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,gBAAgB,CAAC,SAAiB;QAC/C,MAAM,QAAQ,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,EAAE,CACnD,QAAQ,CAAC,QAAQ,CAAC,cAAc,CAAC,CAClC,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,sBAAsB,CAAC,MAAW;QAC/C,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,sBAAsB,CAAC,QAAuB;QAC3D,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,CAAC,CAAC;QACX,CAAC;QAED,IAAI,CAAC;YACH,OAAO,QAAQ,CAAC,aAAa,EAAE,MAAM,IAAI,SAAS,CAAC;QACrD,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,eAAe,CAAC,QAAuB;QACpD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;YAChE,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC;YAC5G,MAAM,MAAM,GAAG,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAE/C,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;gBACvB,OAAO,IAAI,CAAC;YACd,CAAC;YAED,+CAA+C;YAC/C,MAAM,QAAQ,GAAG,QAAQ,CAAC,aAAa,CAAC;YACxC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,OAAO,IAAI,CAAC;YACd,CAAC;YAED,+BAA+B;YAC/B,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;YACpD,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,OAAO,IAAI,CAAC;YACd,CAAC;YAED,sDAAsD;YACtD,IAAI,MAAM,EAAE,CAAC;gBACX,IAAI,CAAC;oBACH,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBAChC,CAAC;gBAAC,MAAM,CAAC;oBACP,0CAA0C;oBAC1C,OAAO,UAAU,CAAC;gBACpB,CAAC;YACH,CAAC;YAED,kDAAkD;YAClD,OAAO,UAAU,CAAC;QACpB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,yBAAyB,CAAC,QAAuB,EAAE,OAAiB;QACjF,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,6CAA6C;QAC7C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,iEAAiE;YACjE,MAAM,YAAY,GAAG,IAAI,CAAC,8BAA8B,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YAElE,wEAAwE;YACxE,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;gBAChD,IAAI,UAAU,CAAC,MAAM,GAAG,mBAAmB,EAAE,CAAC;oBAC5C,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC;oBAC/D,OAAO,GAAG,SAAS,iBAAiB,CAAC;gBACvC,CAAC;gBACD,OAAO,YAAY,CAAC;YACtB,CAAC;YAED,kDAAkD;YAClD,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,+CAA+C;QAC/C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,wDAAwD;YACxD,IAAI,OAAO,EAAE,CAAC;gBACZ,IAAI,IAAI,CAAC,MAAM,GAAG,mBAAmB,EAAE,CAAC;oBACtC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,mBAAmB,CAAC,iBAAiB,CAAC;gBACpE,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;YAED,yCAAyC;YACzC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,UAAU,CACtB,GAAgB;QAEhB,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC;QAChG,MAAM,UAAU,GAAG;YACjB,KAAK,EAAE,mBAAmB;YAC1B,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,UAAU,EAAE,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC;SAChD,CAAC;QAEF,2FAA2F;QAC3F,gBAAM,CAAC,IAAI,CAAC,uBAAa,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,WAAW,CACvB,GAAgB,EAChB,QAAsB,EACtB,gBAAyB;QAEzB,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC;QAChE,MAAM,WAAW,GAAQ;YACvB,KAAK,EAAE,oBAAoB;YAC3B,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,QAAQ,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,gBAAgB,IAAI,CAAC,CAAC,CAAC,SAAS;YAChE,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,WAAW,EAAE,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,cAAc,CAAC,IAAI,SAAS;YAC/D,aAAa,EAAE,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC;YACpD,OAAO;SACR,CAAC;QAEF,MAAM,mBAAmB,GAAG,IAAI,CAAC,yBAAyB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC9E,IAAI,mBAAmB,EAAE,CAAC;YACxB,WAAW,CAAC,YAAY,GAAG,mBAAmB,CAAC;QACjD,CAAC;QAED,2FAA2F;QAC3F,gBAAM,CAAC,IAAI,CAAC,uBAAa,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;IAChE,CAAC;;AAxRH,gCAyRC"}

package/dist/logging/ToolLogger.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ToolLogger.test.d.ts.map

package/dist/logging/ToolLogger.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolLogger.test.d.ts","sourceRoot":"","sources":["../../src/logging/ToolLogger.test.ts"],"names":[],"mappings":""}