Skip to content
This repository has been archived by the owner on Apr 3, 2024. It is now read-only.

Commit

Permalink
debuglet: stop can only be called on running agents (#209)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ofrobots
ofrobots committed Dec 23, 2016
1 parent a680d87 commit 5e3a0ef
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 51 deletions.
18 changes: 12 additions & 6 deletions src/agent/debuglet.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,13 @@ module.exports = Debuglet;
/**
* @param {Debug} debug - A Debug instance.
* @param {object=} config - The option parameters for the Debuglet.
* @event 'error' on startup errors
* @event 'started' once the startup tasks are completed
* @event 'registered' once successfully registered to the debug api
* @event 'stopped' if the agent stops due to a fatal error after starting
* @event 'remotelyDisabled' if the debuggee is disabled by the server.
* @event 'started' once the startup tasks are completed. Only called once.
* @event 'stopped' if the agent stops due to a fatal error after starting. Only
* called once.
* @event 'registered' once successfully registered to the debug api. May be
* emitted multiple times.
* @event 'remotelyDisabled' if the debuggee is disabled by the server. May be
* called multiple times.
* @constructor
*/
function Debuglet(debug, config) {
Expand Down Expand Up @@ -596,9 +598,13 @@ Debuglet.prototype.scheduleBreakpointExpiry_ = function(breakpoint) {
};

/**
* Stops the Debuglet
* Stops the Debuglet. This is for testing purposes only. Stop should only be
* called on a agent that has started (i.e. emitted the 'started' event).
* Calling this while the agent is initializing may not necessarily stop all
* pending operations.
*/
Debuglet.prototype.stop = function() {
assert.ok(this.running_, 'stop can only be called on a running agent');
this.logger_.debug('Stopping Debuglet');
this.running_ = false;
this.emit('stopped');
Expand Down
92 changes: 47 additions & 45 deletions test/standalone/test-debuglet.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,20 +43,13 @@ var errorBp = {
};

describe(__filename, function() {
var debuglet;

beforeEach(function() {
delete process.env.GCLOUD_PROJECT;
});

afterEach(function() {
assert.ok(debuglet);
debuglet.stop();
});

it('should not start when projectId is not available', function(done) {
var debug = require('../..')();
debuglet = new Debuglet(debug, defaultConfig);
var debuglet = new Debuglet(debug, defaultConfig);

// The following mock is neccessary for the case when the test is running
// on GCP. In that case we will get the projectId from the metadata service.
Expand All @@ -66,6 +59,7 @@ describe(__filename, function() {

debuglet.once('initError', function(err) {
assert.ok(err);
// no need to stop the debuggee.
scope.done();
done();
});
Expand All @@ -77,7 +71,7 @@ describe(__filename, function() {

it('should not crash without project num', function(done) {
var debug = require('../..')();
debuglet = new Debuglet(debug, defaultConfig);
var debuglet = new Debuglet(debug, defaultConfig);

// The following mock is neccessary for the case when the test is running
// on GCP. In that case we will get the projectId from the metadata service.
Expand All @@ -88,17 +82,17 @@ describe(__filename, function() {
debuglet.once('started', function() {
assert.fail();
});
setTimeout(function() {
debuglet.once('initError', function() {
scope.done();
done();
}, 1500);
});
debuglet.start();
});

it('should accept non-numeric GCLOUD_PROJECT', function(done) {
var debug = require('../..')(
{projectId: '11020304f2934', credentials: fakeCredentials});
debuglet = new Debuglet(debug, defaultConfig);
var debuglet = new Debuglet(debug, defaultConfig);

nocks.oauth2();
var scope = nock(API)
Expand All @@ -111,6 +105,7 @@ describe(__filename, function() {

debuglet.once('registered', function(id) {
assert.equal(id, DEBUGGEE_ID);
debuglet.stop();
scope.done();
done();
});
Expand All @@ -122,7 +117,7 @@ describe(__filename, function() {
this.timeout(10000);
process.env.GCLOUD_PROJECT='11020304f2934';
var debug = require('../..')({credentials: fakeCredentials});
debuglet = new Debuglet(debug, defaultConfig);
var debuglet = new Debuglet(debug, defaultConfig);

nocks.oauth2();
var scope = nock(API)
Expand All @@ -139,6 +134,7 @@ describe(__filename, function() {

debuglet.once('registered', function(id) {
assert.equal(id, DEBUGGEE_ID);
debuglet.stop();
scope.done();
done();
});
Expand All @@ -150,7 +146,7 @@ describe(__filename, function() {
var debug = require('../..')(
{projectId: 'fake-project', credentials: fakeCredentials});
var config = extend({}, defaultConfig, {workingDirectory: __dirname});
debuglet = new Debuglet(debug, config);
var debuglet = new Debuglet(debug, config);

nocks.oauth2();
debuglet.once('initError', function(err) {
Expand All @@ -164,14 +160,15 @@ describe(__filename, function() {
it('should register successfully otherwise', function(done) {
var debug = require('../..')(
{projectId: 'fake-project', credentials: fakeCredentials});
debuglet = new Debuglet(debug, defaultConfig);
var debuglet = new Debuglet(debug, defaultConfig);

nocks.oauth2();
var scope =
nock(API).post(REGISTER_PATH).reply(200, {debuggee: {id: DEBUGGEE_ID}});

debuglet.once('registered', function(id) {
assert.equal(id, DEBUGGEE_ID);
debuglet.stop();
scope.done();
done();
});
Expand All @@ -185,7 +182,7 @@ describe(__filename, function() {

var debug = require('../..')(
{projectId: 'fake-project', credentials: fakeCredentials});
debuglet = new Debuglet(debug, defaultConfig);
var debuglet = new Debuglet(debug, defaultConfig);

nocks.oauth2();
var scope = nock(API)
Expand All @@ -201,6 +198,7 @@ describe(__filename, function() {

debuglet.once('registered', function(id) {
assert.equal(id, DEBUGGEE_ID);
debuglet.stop();
scope.done();
process.chdir('../..');
done();
Expand All @@ -209,36 +207,34 @@ describe(__filename, function() {
debuglet.start();
});

it('should de-activate when the server responds with isDisabled', function(done) {
this.timeout(4000);
var debug = require('../..')(
{projectId: 'fake-project', credentials: fakeCredentials});
debuglet = new Debuglet(debug, defaultConfig);

nocks.oauth2();
var scope = nock(API)
.post(REGISTER_PATH)
.reply(200, {
debuggee: {
id: DEBUGGEE_ID,
isDisabled: true
}
});

debuglet.once('remotelyDisabled', function() {
assert.ok(!debuglet.fetcherActive_);
scope.done();
done();
});
it('should de-activate when the server responds with isDisabled',
function(done) {
this.timeout(4000);
var debug = require('../..')(
{projectId: 'fake-project', credentials: fakeCredentials});
var debuglet = new Debuglet(debug, defaultConfig);

nocks.oauth2();
var scope =
nock(API)
.post(REGISTER_PATH)
.reply(200, {debuggee: {id: DEBUGGEE_ID, isDisabled: true}});

debuglet.once('remotelyDisabled', function() {
assert.ok(!debuglet.fetcherActive_);
debuglet.stop();
scope.done();
done();
});

debuglet.start();
});
debuglet.start();
});

it('should retry after a isDisabled request', function(done) {
this.timeout(4000);
var debug = require('../..')(
{projectId: 'fake-project', credentials: fakeCredentials});
debuglet = new Debuglet(debug, defaultConfig);
var debuglet = new Debuglet(debug, defaultConfig);

nocks.oauth2();
var scope = nock(API)
Expand All @@ -265,6 +261,7 @@ describe(__filename, function() {
debuglet.once('registered', function(id) {
assert.ok(gotDisabled);
assert.equal(id, DEBUGGEE_ID);
debuglet.stop();
scope.done();
done();
});
Expand All @@ -275,7 +272,7 @@ describe(__filename, function() {
it('should re-register when registration expires', function(done) {
var debug = require('../..')(
{projectId: 'fake-project', credentials: fakeCredentials});
debuglet = new Debuglet(debug, defaultConfig);
var debuglet = new Debuglet(debug, defaultConfig);

nocks.oauth2();
var scope = nock(API)
Expand All @@ -298,6 +295,7 @@ describe(__filename, function() {
assert.equal(id, DEBUGGEE_ID);
debuglet.once('registered', function(id) {
assert.equal(id, DEBUGGEE_ID);
debuglet.stop();
scope.done();
done();
});
Expand All @@ -310,7 +308,7 @@ describe(__filename, function() {
this.timeout(2000);
var debug = require('../..')(
{projectId: 'fake-project', credentials: fakeCredentials});
debuglet = new Debuglet(debug, defaultConfig);
var debuglet = new Debuglet(debug, defaultConfig);

nocks.oauth2();
var scope = nock(API)
Expand All @@ -329,6 +327,7 @@ describe(__filename, function() {
assert.equal(id, DEBUGGEE_ID);
setTimeout(function() {
assert.deepEqual(debuglet.activeBreakpointMap_.test, bp);
debuglet.stop();
scope.done();
done();
}, 1000);
Expand All @@ -342,7 +341,7 @@ describe(__filename, function() {

var debug = require('../..')(
{projectId: 'fake-project', credentials: fakeCredentials});
debuglet = new Debuglet(debug, defaultConfig);
var debuglet = new Debuglet(debug, defaultConfig);

nocks.oauth2();
var scope = nock(API)
Expand Down Expand Up @@ -380,6 +379,7 @@ describe(__filename, function() {
setTimeout(function() {
assert.deepEqual(debuglet.activeBreakpointMap_.test, bp);
assert(!debuglet.activeBreakpointMap_.testLog);
debuglet.stop();
scope.done();
done();
}, 1000);
Expand Down Expand Up @@ -412,13 +412,14 @@ describe(__filename, function() {
})
.reply(200);

debuglet = new Debuglet(debug, config);
var debuglet = new Debuglet(debug, config);
debuglet.once('registered', function(id) {
assert.equal(id, DEBUGGEE_ID);
setTimeout(function() {
assert.deepEqual(debuglet.activeBreakpointMap_.test, bp);
setTimeout(function() {
assert(!debuglet.activeBreakpointMap_.test);
debuglet.stop();
scope.done();
done();
}, 1100);
Expand Down Expand Up @@ -466,7 +467,7 @@ describe(__filename, function() {
breakpoints: [bp]
});

debuglet = new Debuglet(debug, config);
var debuglet = new Debuglet(debug, config);
debuglet.once('registered', function(id) {
assert.equal(id, DEBUGGEE_ID);
setTimeout(function() {
Expand All @@ -475,6 +476,7 @@ describe(__filename, function() {
assert(!debuglet.activeBreakpointMap_.test);
// Fetcher disables if we re-update since endpoint isn't mocked twice
assert(debuglet.fetcherActive_);
debuglet.stop();
scope.done();
done();
}, 4500);
Expand Down

0 comments on commit 5e3a0ef

Please sign in to comment.