otel-tools
Version:
OpenTelemetry Tools
324 lines • 15.5 kB
JavaScript
;
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
};
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 (_) 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 });
var api_1 = require("@opentelemetry/api");
var src_1 = require("../src");
// TODO: Test passing a name
// TODO: Test `this` value with class decorator
var mockTracer = {
startSpan: jest.fn(),
startActiveSpan: jest.fn(),
};
var TargetClass = /** @class */ (function () {
function TargetClass() {
}
TargetClass.prototype.syncAdd = function (a, b) {
return a + b;
};
TargetClass.prototype.asyncAdd = function (a, b) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, a + b];
});
});
};
TargetClass.prototype.syncThrow = function (errorMessage) {
if (errorMessage === void 0) { errorMessage = 'error'; }
throw new Error(errorMessage);
};
TargetClass.prototype.asyncThrow = function (errorMessage) {
if (errorMessage === void 0) { errorMessage = 'error'; }
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
throw new Error(errorMessage);
});
});
};
__decorate([
(0, src_1.TraceMethod)({ tracer: mockTracer })
], TargetClass.prototype, "syncAdd", null);
__decorate([
(0, src_1.TraceMethod)({ tracer: mockTracer })
], TargetClass.prototype, "asyncAdd", null);
__decorate([
(0, src_1.TraceMethod)({ tracer: mockTracer })
], TargetClass.prototype, "syncThrow", null);
__decorate([
(0, src_1.TraceMethod)({ tracer: mockTracer })
], TargetClass.prototype, "asyncThrow", null);
return TargetClass;
}());
var mockSpan = {
end: jest.fn(),
recordException: jest.fn(),
setStatus: jest.fn(),
};
describe('@TraceMethod decorator', function () {
beforeEach(function () {
jest.resetAllMocks();
mockTracer.startActiveSpan.mockImplementation(function (name, fn) {
return fn(mockSpan);
});
});
it('should return function value, given no error', function () {
var target = new TargetClass();
var result = target.syncAdd(1, 1);
expect(result).toBe(2);
});
it('should set correct span status, given no error', function () {
var target = new TargetClass();
target.syncAdd(1, 1);
expect(mockSpan.setStatus).toHaveBeenCalledWith({
code: api_1.SpanStatusCode.OK,
});
expect(mockSpan.setStatus).toHaveBeenCalledTimes(1);
expect(mockSpan.end).toHaveBeenCalledTimes(1);
});
it('should set correct span name, given no name argument', function () {
var target = new TargetClass();
target.syncAdd(1, 1);
expect(mockTracer.startActiveSpan).toHaveBeenCalledWith(target.constructor.name + "." + target.syncAdd.name, expect.any(Function));
});
it('should throw error, given exception in sync method', function () {
var target = new TargetClass();
var expectedErrorMessage = 'expected error message';
expect(function () {
target.syncThrow(expectedErrorMessage);
}).toThrow(new Error(expectedErrorMessage));
});
it('should record error, given exception in sync method', function () {
var target = new TargetClass();
var expectedErrorMessage = 'expected error message';
expect(function () { return target.syncThrow(expectedErrorMessage); }).toThrow();
expect(mockSpan.recordException).toHaveBeenLastCalledWith(new Error(expectedErrorMessage));
expect(mockSpan.setStatus).toHaveBeenCalledWith({
code: api_1.SpanStatusCode.ERROR,
message: expectedErrorMessage,
});
expect(mockSpan.end).toHaveBeenCalledTimes(1);
});
it('should resolve correctly, given async method', function () { return __awaiter(void 0, void 0, void 0, function () {
var target, result;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
target = new TargetClass();
return [4 /*yield*/, target.asyncAdd(1, 1)];
case 1:
result = _a.sent();
expect(result).toBe(2);
return [2 /*return*/];
}
});
}); });
it('should set span status correctly, given async method without error', function () { return __awaiter(void 0, void 0, void 0, function () {
var target;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
target = new TargetClass();
return [4 /*yield*/, target.asyncAdd(1, 1)];
case 1:
_a.sent();
expect(mockSpan.setStatus).toHaveBeenCalledWith({
code: api_1.SpanStatusCode.OK,
});
expect(mockSpan.setStatus).toHaveBeenCalledTimes(1);
expect(mockSpan.end).toHaveBeenCalledTimes(1);
return [2 /*return*/];
}
});
}); });
it('should record error, given exception in async method', function () { return __awaiter(void 0, void 0, void 0, function () {
var target, expectedErrorMessage;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
target = new TargetClass();
expectedErrorMessage = 'expected error message';
return [4 /*yield*/, expect(target.asyncThrow(expectedErrorMessage)).rejects.toEqual(new Error(expectedErrorMessage))];
case 1:
_a.sent();
expect(mockSpan.recordException).toHaveBeenLastCalledWith(new Error(expectedErrorMessage));
expect(mockSpan.setStatus).toHaveBeenCalledWith({
code: api_1.SpanStatusCode.ERROR,
message: expectedErrorMessage,
});
expect(mockSpan.end).toHaveBeenCalledTimes(1);
return [2 /*return*/];
}
});
}); });
});
describe('traceMethod function wrapper', function () {
beforeEach(function () {
jest.resetAllMocks();
mockTracer.startActiveSpan.mockImplementation(function (name, fn) {
return fn(mockSpan);
});
});
it('should return function value, given no error', function () {
var syncAdd = (0, src_1.traceMethod)({ tracer: mockTracer }, function syncAdd(a, b) {
return a + b;
});
var result = syncAdd(1, 1);
expect(result).toBe(2);
});
it('should use correct context, given invocation with context', function () {
var returnName = (0, src_1.traceMethod)({ tracer: mockTracer }, function returnName() {
return this.name;
});
var result = returnName.call({ name: 'carl' });
expect(result).toBe('carl');
});
it('should set correct span status, given no error', function () {
var syncAdd = (0, src_1.traceMethod)({ tracer: mockTracer }, function syncAdd(a, b) {
return a + b;
});
syncAdd(1, 1);
expect(mockSpan.setStatus).toHaveBeenCalledWith({
code: api_1.SpanStatusCode.OK,
});
expect(mockSpan.setStatus).toHaveBeenCalledTimes(1);
expect(mockSpan.end).toHaveBeenCalledTimes(1);
});
it('should set correct span name, given no name argument', function () {
var syncAdd = (0, src_1.traceMethod)({ tracer: mockTracer }, function syncAdd(a, b) {
return a + b;
});
syncAdd(1, 1);
expect(mockTracer.startActiveSpan).toHaveBeenCalledWith('syncAdd', expect.any(Function));
});
it('should throw error, given exception in sync method', function () {
var expectedErrorMessage = 'expected error message';
var syncThrow = (0, src_1.traceMethod)({ tracer: mockTracer }, function syncThrow() {
throw new Error(expectedErrorMessage);
});
expect(function () { return syncThrow(); }).toThrow(new Error(expectedErrorMessage));
});
it('should record error, given exception in sync method', function () {
var expectedErrorMessage = 'expected error message';
var syncThrow = (0, src_1.traceMethod)({ tracer: mockTracer }, function syncThrow() {
throw new Error(expectedErrorMessage);
});
expect(function () { return syncThrow(); }).toThrow();
expect(mockSpan.recordException).toHaveBeenLastCalledWith(new Error(expectedErrorMessage));
expect(mockSpan.setStatus).toHaveBeenCalledWith({
code: api_1.SpanStatusCode.ERROR,
message: expectedErrorMessage,
});
expect(mockSpan.end).toHaveBeenCalledTimes(1);
});
it('should resolve correctly, given async method', function () { return __awaiter(void 0, void 0, void 0, function () {
var asyncAdd, result;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
asyncAdd = (0, src_1.traceMethod)({ tracer: mockTracer }, function asyncAdd(a, b) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, a + b];
});
});
});
return [4 /*yield*/, asyncAdd(1, 1)];
case 1:
result = _a.sent();
expect(result).toBe(2);
return [2 /*return*/];
}
});
}); });
it('should set span status correctly, given async method without error', function () { return __awaiter(void 0, void 0, void 0, function () {
var asyncAdd;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
asyncAdd = (0, src_1.traceMethod)({ tracer: mockTracer }, function asyncAdd(a, b) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, a + b];
});
});
});
return [4 /*yield*/, asyncAdd(1, 1)];
case 1:
_a.sent();
expect(mockSpan.setStatus).toHaveBeenCalledWith({
code: api_1.SpanStatusCode.OK,
});
expect(mockSpan.setStatus).toHaveBeenCalledTimes(1);
expect(mockSpan.end).toHaveBeenCalledTimes(1);
return [2 /*return*/];
}
});
}); });
it('should record error, given exception in async method', function () { return __awaiter(void 0, void 0, void 0, function () {
var expectedErrorMessage, asyncThrow;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
expectedErrorMessage = 'expected error message';
asyncThrow = (0, src_1.traceMethod)({ tracer: mockTracer }, function asyncThrow() {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
throw new Error(expectedErrorMessage);
});
});
});
return [4 /*yield*/, expect(asyncThrow()).rejects.toEqual(new Error(expectedErrorMessage))];
case 1:
_a.sent();
expect(mockSpan.recordException).toHaveBeenLastCalledWith(new Error(expectedErrorMessage));
expect(mockSpan.setStatus).toHaveBeenCalledWith({
code: api_1.SpanStatusCode.ERROR,
message: expectedErrorMessage,
});
expect(mockSpan.end).toHaveBeenCalledTimes(1);
return [2 /*return*/];
}
});
}); });
});
//# sourceMappingURL=decorator.spec.js.map