Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 18 additions & 3 deletions packages/core/lib/context_utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,19 @@ var Subsegment = require('./segments/attributes/subsegment');
var cls_mode = true;
var NAMESPACE ='AWSXRay';
var SEGMENT = 'segment';
var isLambda = !!process.env.LAMBDA_TASK_ROOT;
var lambdaEnv;

var contextOverride = false;

function getLambdaInvocationContext() {
// The Lambda module also imports contextUtils, so load it on first use.
if (!lambdaEnv) {
lambdaEnv = require('./env/aws_lambda');
}
return lambdaEnv.getInvocationContext();
}

var contextUtils = {
CONTEXT_MISSING_STRATEGY: {
RUNTIME_ERROR: {
Expand Down Expand Up @@ -95,11 +105,13 @@ var contextUtils = {

getSegment: function getSegment() {
if (cls_mode) {
var segment = contextUtils.getNamespace(NAMESPACE).get(SEGMENT);
var namespace = contextUtils.getNamespace(NAMESPACE);
var invocation = isLambda && getLambdaInvocationContext();
var segment = invocation ? invocation.getSegment(namespace.active) : namespace.get(SEGMENT);

if (!segment) {
contextUtils.contextMissingStrategy.contextMissing('Failed to get the current sub/segment from the context.');
} else if (segment instanceof Segment && process.env.LAMBDA_TASK_ROOT && segment.facade == true) {
} else if (segment instanceof Segment && isLambda && segment.facade == true) {
segment.resolveLambdaTraceData();
}

Expand All @@ -118,7 +130,10 @@ var contextUtils = {

setSegment: function setSegment(segment) {
if (cls_mode) {
if (!contextUtils.getNamespace(NAMESPACE).set(SEGMENT, segment)) {
var namespace = contextUtils.getNamespace(NAMESPACE);
var invocation = isLambda && getLambdaInvocationContext();
var segmentSet = invocation ? invocation.setSegment(namespace.active, segment) : namespace.set(SEGMENT, segment);
if (!segmentSet) {
logger.getLogger().warn('Failed to set the current sub/segment on the context.');
}
} else {
Expand Down
47 changes: 43 additions & 4 deletions packages/core/lib/env/aws_lambda.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,44 @@ const TraceID = require('../segments/attributes/trace_id');
* @namespace
* @ignore
*/
var xAmznTraceIdPrev = null;
// Weak keys let completed invocations (and their tracing state) be collected.
var invocationContexts = new WeakMap();

module.exports.getInvocationContext = function getInvocationContext() {
var invokeStore = globalThis.awslambda?.InvokeStore;
var invocation = invokeStore?.getContext?.();
if (!invocation) {
return;
}

var context = invocationContexts.get(invocation);
if (!context) {
var segment = facadeSegment(invokeStore.getXRayTraceId() ?? process.env._X_AMZN_TRACE_ID);
var segments = new WeakMap();
context = {
getSegment: function(active) {
// CLS child contexts inherit their parent's segment. Keep those slots
// inside the invocation, including the shared Lambda bootstrap context.
while (active) {
if (segments.has(active)) {
return segments.get(active);
}
active = Object.getPrototypeOf(active);
}
return segment;
},
setSegment: function(active, current) {
if (!active) {
return false;
}
segments.set(active, current);
return true;
}
};
invocationContexts.set(invocation, context);
}
return context;
};

/**
* Used to initialize segments on AWS Lambda with extra data from the context.
Expand All @@ -35,14 +72,16 @@ module.exports.init = function init() {

var namespace = contextUtils.getNamespace();
namespace.enter(namespace.createContext());
contextUtils.setSegment(facadeSegment());
// Initialize only the legacy slot, even if the SDK is loaded in a handler.
// Invocation state is created lazily from InvokeStore by get/setSegment.
namespace.set('segment', facadeSegment(process.env._X_AMZN_TRACE_ID));
};

var facadeSegment = function facadeSegment() {
var facadeSegment = function facadeSegment(xAmznTraceId) {
var segment = new Segment('facade');
var whitelistFcn = ['addNewSubsegment', 'addSubsegment', 'removeSubsegment', 'toString', 'addSubsegmentWithoutSampling', 'addNewSubsegmentWithoutSampling'];
var silentFcn = ['incrementCounter', 'decrementCounter', 'isClosed', 'close', 'format', 'flush'];
var xAmznTraceId = process.env._X_AMZN_TRACE_ID;
var xAmznTraceIdPrev = null;

for (var key in segment) {
if (typeof segment[key] === 'function' && whitelistFcn.indexOf(key) === -1) {
Expand Down
9 changes: 5 additions & 4 deletions packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"semver": "^7.5.3"
},
"devDependencies": {
"@aws/lambda-invoke-store": "^0.2.0"
"@aws/lambda-invoke-store": "^0.2.2"
},
"scripts": {
"prepare": "npm run compile",
Expand All @@ -40,12 +40,13 @@
"copy-test": "find test -name '*.json' | xargs -I % ../../scripts/cp-with-structure.sh % dist",
"lint": "eslint .",
"lint:fix": "eslint . --fix",
"test": "npm run compile && mocha --recursive ./dist/test/ -R spec && tsd && mocha --recursive ./dist/test_async/ -R spec",
"test": "npm run compile && mocha --recursive ./dist/test/ -R spec && tsd && npm run test-async:run",
"test-d": "tsd",
"test-async": "npm run compile && mocha --recursive ./dist/test_async/ -R spec",
"test-async": "npm run compile && npm run test-async:run",
"clean": "rm -rf dist && rm -rf node_modules",
"testcov": "nyc npm run test",
"reportcov": "nyc report --reporter=text-lcov > coverage.lcov"
"reportcov": "nyc report --reporter=text-lcov > coverage.lcov",
"test-async:run": "mocha --recursive ./dist/test_async/ --exclude dist/test_async/lambda_invocation_isolation.test.js -R spec && mocha ./dist/test_async/lambda_invocation_isolation.test.js -R spec"
},
"keywords": [
"amazon",
Expand Down
31 changes: 16 additions & 15 deletions packages/core/test/unit/env/aws_lambda.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ describe('AWSLambda', function () {
sandbox = sinon.createSandbox();
sandbox.stub(contextUtils, 'getNamespace').returns({
enter: function () { },
createContext: function () { }
createContext: function () { },
set: function () { }
});
});

Expand All @@ -61,7 +62,7 @@ describe('AWSLambda', function () {
disableCentralizedSamplingStub = sandbox.stub(mwUtils, 'disableCentralizedSampling');
validateStub = sandbox.stub(LambdaUtils, 'validTraceData').returns(true);
populateStub = sandbox.stub(LambdaUtils, 'populateTraceData').returns(true);
setSegmentStub = sandbox.stub(contextUtils, 'setSegment');
setSegmentStub = sandbox.stub(contextUtils.getNamespace(), 'set');
});

afterEach(function () {
Expand All @@ -86,9 +87,9 @@ describe('AWSLambda', function () {
it('should set a facade segment on the context', function () {
Lambda.init();
setSegmentStub.should.have.been.calledOnce;
setSegmentStub.should.have.been.calledWith(sinon.match.instanceOf(Segment));
setSegmentStub.should.have.been.calledWith('segment', sinon.match.instanceOf(Segment));

var facade = setSegmentStub.args[0][0];
var facade = setSegmentStub.args[0][1];
assert.equal(facade.name, 'facade');
assert.equal(facade.trace_id, TraceID.Invalid().toString());
});
Expand Down Expand Up @@ -130,7 +131,7 @@ describe('AWSLambda', function () {

sandbox.stub(LambdaUtils, 'validTraceData').returns(true);
populateStub = sandbox.stub(LambdaUtils, 'populateTraceData').returns(true);
setSegmentStub = sandbox.stub(contextUtils, 'setSegment');
setSegmentStub = sandbox.stub(contextUtils.getNamespace(), 'set');
});

afterEach(function () {
Expand All @@ -141,7 +142,7 @@ describe('AWSLambda', function () {
it('should check reset the facade', function () {
Lambda.init();

var facade = setSegmentStub.args[0][0];
var facade = setSegmentStub.args[0][1];
facade.trace_id = 'traceIdHere';
facade.id = 'parentIdHere';
facade.subsegments = [{ subsegment: 'here' }];
Expand Down Expand Up @@ -172,7 +173,7 @@ describe('AWSLambda', function () {
Lambda.init();
populateStub.reset();

var facade = setSegmentStub.args[0][0];
var facade = setSegmentStub.args[0][1];
assert.throws(facade.resolveLambdaTraceData);
populateStub.should.have.not.been.called;
});
Expand All @@ -182,7 +183,7 @@ describe('AWSLambda', function () {
Lambda.init();
process.env._X_AMZN_TRACE_ID = 'xAmznTraceId2';
populateStub.reset();
var facade = setSegmentStub.args[0][0];
var facade = setSegmentStub.args[0][1];
facade.resolveLambdaTraceData();

populateStub.should.have.been.calledOnce;
Expand All @@ -192,7 +193,7 @@ describe('AWSLambda', function () {
process.env._X_AMZN_TRACE_ID = traceId;
Lambda.init();
process.env._X_AMZN_TRACE_ID = 'xAmznTraceId2';
var facade = setSegmentStub.args[0][0];
var facade = setSegmentStub.args[0][1];
var resetStub = sandbox.stub(facade, 'reset');

facade.resolveLambdaTraceData();
Expand All @@ -204,7 +205,7 @@ describe('AWSLambda', function () {
Lambda.init();
populateStub.reset();

var facade = setSegmentStub.args[0][0];
var facade = setSegmentStub.args[0][1];
facade.resolveLambdaTraceData();
populateStub.should.have.not.been.called;
});
Expand All @@ -220,7 +221,7 @@ describe('AWSLambda', function () {

populateStub.reset();

var facade = setSegmentStub.args[0][0];
var facade = setSegmentStub.args[0][1];
facade.resolveLambdaTraceData();

getXRayTraceIdStub.should.have.been.calledOnce;
Expand All @@ -237,7 +238,7 @@ describe('AWSLambda', function () {

populateStub.reset();

var facade = setSegmentStub.args[0][0];
var facade = setSegmentStub.args[0][1];
facade.resolveLambdaTraceData();

getXRayTraceIdStub.should.have.been.calledOnce;
Expand All @@ -257,7 +258,7 @@ describe('AWSLambda', function () {

populateStub.reset();

var facade = setSegmentStub.args[0][0];
var facade = setSegmentStub.args[0][1];
facade.resolveLambdaTraceData();

getXRayTraceIdStub.should.have.been.calledOnce;
Expand All @@ -274,7 +275,7 @@ describe('AWSLambda', function () {
sandbox.stub(SegmentEmitter, 'disableReusableSocket');
sandbox.stub(LambdaUtils, 'validTraceData').returns(true);

setSegmentStub = sandbox.stub(contextUtils, 'setSegment');
setSegmentStub = sandbox.stub(contextUtils.getNamespace(), 'set');
});

afterEach(function () {
Expand All @@ -288,7 +289,7 @@ describe('AWSLambda', function () {
Lambda.init();
await setupInvokeStore();

var facade = setSegmentStub.args[0][0];
var facade = setSegmentStub.args[0][1];
facade.resolveLambdaTraceData();
var additionalTraceData = facade.additionalTraceData;
assert.equal(additionalTraceData['Lineage'], '1234abcd:4|3456abcd:6');
Expand Down
Loading
Loading