ssr-web-avo-inspector
Version:
Avo Inspector for web with SSR and web workers support
312 lines (311 loc) • 14.8 kB
JavaScript
"use strict";
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
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());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.AvoNetworkCallsHandler = void 0;
var AvoGuid_1 = require("./AvoGuid");
var AvoStreamId_1 = require("./AvoStreamId");
var AvoInspector_1 = require("./AvoInspector");
var AvoEncryption_1 = require("./AvoEncryption");
var AvoNetworkCallsHandler = /** @class */ (function () {
function AvoNetworkCallsHandler(apiKey, envName, appName, appVersion, libVersion, publicEncryptionKey) {
this.samplingRate = 1.0;
this.sending = false;
this.apiKey = apiKey;
this.envName = envName;
this.appName = appName;
this.appVersion = appVersion;
this.libVersion = libVersion;
this.publicEncryptionKey = publicEncryptionKey;
}
/**
* Determines whether encryption should be applied.
* Truth table:
* dev + key = true
* staging + key = true
* prod + key = false
* dev + null = false
* dev + empty = false
*/
AvoNetworkCallsHandler.prototype.shouldEncrypt = function () {
if (!this.publicEncryptionKey || this.publicEncryptionKey.trim().length === 0) {
return false;
}
// Only encrypt in dev and staging, never in prod
return this.envName !== "prod";
};
/**
* Adds encrypted property values to event properties.
* For each property that has a corresponding value in eventValues:
* - Skip list-type properties (omitted entirely)
* - Encrypt the value and set encryptedPropertyValue
* - On failure: console.warn, omit property value, continue
*/
AvoNetworkCallsHandler.prototype.addEncryptedValues = function (eventProperties, eventValues) {
return __awaiter(this, void 0, void 0, function () {
var result, _i, eventProperties_1, prop, newProp, value, _a, e_1;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
if (!this.shouldEncrypt()) {
return [2 /*return*/, eventProperties];
}
result = [];
_i = 0, eventProperties_1 = eventProperties;
_b.label = 1;
case 1:
if (!(_i < eventProperties_1.length)) return [3 /*break*/, 7];
prop = eventProperties_1[_i];
newProp = __assign({}, prop);
// Skip list-type properties entirely
if (prop.propertyType === "list" || prop.propertyType.startsWith("list(")) {
return [3 /*break*/, 6];
}
value = eventValues[prop.propertyName];
if (!(value != null)) return [3 /*break*/, 5];
_b.label = 2;
case 2:
_b.trys.push([2, 4, , 5]);
_a = newProp;
return [4 /*yield*/, (0, AvoEncryption_1.encryptValue)(value, this.publicEncryptionKey)];
case 3:
_a.encryptedPropertyValue = _b.sent();
return [3 /*break*/, 5];
case 4:
e_1 = _b.sent();
console.warn("[Avo Inspector] Warning: Failed to encrypt property \"".concat(prop.propertyName, "\". Property value will be omitted. Error: ").concat(e_1 instanceof Error ? e_1.message : String(e_1)));
return [3 /*break*/, 5];
case 5:
result.push(newProp);
_b.label = 6;
case 6:
_i++;
return [3 /*break*/, 1];
case 7: return [2 /*return*/, result];
}
});
});
};
AvoNetworkCallsHandler.prototype.callInspectorWithBatchBody = function (inEvents, onCompleted) {
var _this = this;
if (this.sending) {
onCompleted("Batch sending cancelled because another batch sending is in progress. Your events will be sent with next batch.");
return;
}
var events = inEvents.filter(function (x) { return x != null; });
if (events.length === 0) {
return;
}
if (Math.random() > this.samplingRate) {
if (AvoInspector_1.AvoInspector.shouldLog) {
console.log("Avo Inspector: last event schema dropped due to sampling rate.");
}
return;
}
if (AvoInspector_1.AvoInspector.shouldLog) {
console.log("Avo Inspector: events", events);
events.forEach(function (event) {
if (event.type === "sessionStarted") {
console.log("Avo Inspector: sending session started event.");
}
else if (event.type === "event") {
var schemaEvent = event;
console.log("Avo Inspector: sending event " + schemaEvent.eventName + " with schema " + JSON.stringify(schemaEvent.eventProperties));
}
});
}
this.sending = true;
fetch(AvoNetworkCallsHandler.trackingEndpoint, {
headers: { "Content-Type": "text/plain" },
method: "POST",
body: JSON.stringify(events),
}).then(function (response) {
if (response.status != 200) {
onCompleted("Error ".concat(response.status, ": ").concat(response.statusText));
}
else {
response.json().then(function (data) {
var samplingRate = data["samplingRate"];
if (samplingRate !== undefined) {
_this.samplingRate = samplingRate;
}
onCompleted(null);
});
}
}).catch(function (error) {
onCompleted(error instanceof Error ? error.message : String(error));
}).finally(function () {
_this.sending = false;
});
};
AvoNetworkCallsHandler.prototype.bodyForSessionStartedCall = function () {
var sessionBody = this.createBaseCallBody();
sessionBody.type = "sessionStarted";
return sessionBody;
};
AvoNetworkCallsHandler.prototype.bodyForEventSchemaCall = function (eventName, eventProperties, eventId, eventHash) {
var eventSchemaBody = this.createBaseCallBody();
eventSchemaBody.type = "event";
eventSchemaBody.eventName = eventName;
eventSchemaBody.eventProperties = eventProperties;
if (eventId != null) {
eventSchemaBody.avoFunction = true;
eventSchemaBody.eventId = eventId;
eventSchemaBody.eventHash = eventHash;
}
else {
eventSchemaBody.avoFunction = false;
eventSchemaBody.eventId = null;
eventSchemaBody.eventHash = null;
}
return eventSchemaBody;
};
/**
* Async version of bodyForEventSchemaCall that also encrypts property values.
* Used when event validation has been performed and we have access to the
* original event property values for encryption.
*
* @param eventName - Event name
* @param eventProperties - Schema properties (type info)
* @param eventId - Event ID (null if not from Avo function)
* @param eventHash - Event hash (null if not from Avo function)
* @param eventValues - Original property values to encrypt
* @returns Promise resolving to EventSchemaBody with encrypted values
*/
AvoNetworkCallsHandler.prototype.bodyForValidatedEventSchemaCall = function (eventName, eventProperties, eventId, eventHash, eventValues) {
return __awaiter(this, void 0, void 0, function () {
var eventSchemaBody, _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
eventSchemaBody = this.createBaseCallBody();
eventSchemaBody.type = "event";
eventSchemaBody.eventName = eventName;
// Add encrypted values to properties
_a = eventSchemaBody;
return [4 /*yield*/, this.addEncryptedValues(eventProperties, eventValues)];
case 1:
// Add encrypted values to properties
_a.eventProperties = _b.sent();
if (eventId != null) {
eventSchemaBody.avoFunction = true;
eventSchemaBody.eventId = eventId;
eventSchemaBody.eventHash = eventHash;
}
else {
eventSchemaBody.avoFunction = false;
eventSchemaBody.eventId = null;
eventSchemaBody.eventHash = null;
}
return [2 /*return*/, eventSchemaBody];
}
});
});
};
/**
* Calls Inspector API immediately with a single event (bypasses batching).
* Used when event spec validation is available.
* Note: Does not drop due to sampling - validated events are always sent.
*/
AvoNetworkCallsHandler.prototype.callInspectorImmediately = function (eventBody, onCompleted) {
var _this = this;
if (AvoInspector_1.AvoInspector.shouldLog) {
console.log("Avo Inspector: calling inspector immediately (with validation)", eventBody.eventName);
console.log("Avo Inspector: event body", eventBody);
}
fetch(AvoNetworkCallsHandler.trackingEndpoint, {
headers: { "Content-Type": "text/plain" },
method: "POST",
body: JSON.stringify([eventBody]),
})
.then(function (response) {
if (response.status !== 200) {
onCompleted("Error ".concat(response.status, ": ").concat(response.statusText));
}
else {
response.json().then(function (data) {
var samplingRate = data["samplingRate"];
if (samplingRate !== undefined) {
_this.samplingRate = samplingRate;
}
onCompleted(null);
}).catch(function () {
// Non-JSON response body — treat as success (event was accepted)
onCompleted(null);
});
}
})
.catch(function (error) {
onCompleted(error instanceof Error ? error.message : String(error));
});
};
AvoNetworkCallsHandler.prototype.createBaseCallBody = function () {
var _a;
var body = {
apiKey: this.apiKey,
appName: this.appName,
appVersion: this.appVersion,
libVersion: this.libVersion,
env: this.envName,
libPlatform: "web",
messageId: AvoGuid_1.default.newGuid(),
trackingId: "",
createdAt: new Date().toISOString(),
sessionId: "",
streamId: (_a = AvoStreamId_1.AvoStreamId.getAnonymousId()) !== null && _a !== void 0 ? _a : undefined,
samplingRate: this.samplingRate,
};
if (this.shouldEncrypt()) {
body.publicEncryptionKey = this.publicEncryptionKey;
}
return body;
};
AvoNetworkCallsHandler.trackingEndpoint = "https://api.avo.app/inspector/v1/track";
return AvoNetworkCallsHandler;
}());
exports.AvoNetworkCallsHandler = AvoNetworkCallsHandler;