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

Commit

Permalink
Add project detection and unit testing
Browse files Browse the repository at this point in the history
  • Loading branch information
@mctavish
mctavish committed May 9, 2022
1 parent 22e255a commit 842690f
Show file tree
Hide file tree
Showing 3 changed files with 425 additions and 80 deletions.
135 changes: 66 additions & 69 deletions src/agent/debuglet.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ export class Debuglet extends EventEmitter {
private v8debug: DebugApi | null;
private running: boolean;
private project: string | null;
private controller: Controller;
private controller: Controller | null;
private completedBreakpointMap: {[key: string]: boolean};

// breakpointFetchedTimestamp represents the last timestamp when
Expand Down Expand Up @@ -255,17 +255,7 @@ export class Debuglet extends EventEmitter {
level: Debuglet.logLevelToName(this.config.logLevel),
});

/** @private {DebugletApi} */
if (config.useFirebase) {
// TODO: This shouldn't be on the critical path.
const firebaseDb = FirebaseController.initialize({
keyPath: config.firebaseKeyPath,
databaseUrl: config.firebaseDbUrl,
});
this.controller = new FirebaseController(firebaseDb);
} else {
this.controller = new OnePlatformController(this.debug, this.config);
}
this.controller = null;

/** @private {Debuggee} */
this.debuggee = null;
Expand Down Expand Up @@ -434,8 +424,19 @@ export class Debuglet extends EventEmitter {

let project: string;
if (this.config.useFirebase) {
// Project id was discovered during initialization of the app.
project = (this.controller as FirebaseController).getProjectId();
try {
const firebaseDb = await FirebaseController.initialize({
keyPath: this.config.firebaseKeyPath,
databaseUrl: this.config.firebaseDbUrl,
projectId: this.config.projectId,
});
this.controller = new FirebaseController(firebaseDb);
project = (this.controller as FirebaseController).getProjectId();
} catch (err) {
this.logger.error('Unable to connect to Firebase: ' + err.message);
this.emit('initError', err);
return;
}
} else {
try {
project = await this.debug.authClient.getProjectId();
Expand All @@ -446,6 +447,7 @@ export class Debuglet extends EventEmitter {
this.emit('initError', err);
return;
}
this.controller = new OnePlatformController(this.debug, this.config);
}

if (
Expand Down Expand Up @@ -723,6 +725,7 @@ export class Debuglet extends EventEmitter {
}

setTimeout(() => {
assert(that.controller);
if (!that.running) {
onError(new Error('Debuglet not running'));
return;
Expand Down Expand Up @@ -773,8 +776,7 @@ export class Debuglet extends EventEmitter {
}

startListeningForBreakpoints_(): void {
// eslint-disable-next-line @typescript-eslint/no-this-alias
const that = this;
assert(this.controller);
// TODO: Handle the case where this.debuggee is null or not properly registered.
this.controller.subscribeToBreakpoints(
this.debuggee!,
Expand All @@ -785,11 +787,11 @@ export class Debuglet extends EventEmitter {
const delay =
err.name === 'RegistrationExpiredError'
? 0
: that.config.internal.registerDelayOnFetcherErrorSec;
that.scheduleRegistration_(delay);
: this.config.internal.registerDelayOnFetcherErrorSec;
this.scheduleRegistration_(delay);
}

that.updateActiveBreakpoints_(breakpoints);
this.updateActiveBreakpoints_(breakpoints);
}
);
}
Expand All @@ -814,30 +816,28 @@ export class Debuglet extends EventEmitter {
* @private
*/
updateActiveBreakpoints_(breakpoints: stackdriver.Breakpoint[]): void {
// eslint-disable-next-line @typescript-eslint/no-this-alias
const that = this;
const updatedBreakpointMap = this.convertBreakpointListToMap_(breakpoints);

if (breakpoints.length) {
that.logger.info(
this.logger.info(
formatBreakpoints('Server breakpoints: ', updatedBreakpointMap)
);
}
breakpoints.forEach((breakpoint: stackdriver.Breakpoint) => {
// TODO: Address the case when `breakpoint.id` is `undefined`.
if (
!that.completedBreakpointMap[breakpoint.id as string] &&
!that.activeBreakpointMap[breakpoint.id as string]
!this.completedBreakpointMap[breakpoint.id as string] &&
!this.activeBreakpointMap[breakpoint.id as string]
) {
// New breakpoint
that.addBreakpoint_(breakpoint, err => {
this.addBreakpoint_(breakpoint, err => {
if (err) {
that.completeBreakpoint_(breakpoint, false);
this.completeBreakpoint_(breakpoint, false);
}
});

// Schedule the expiry of server breakpoints.
that.scheduleBreakpointExpiry_(breakpoint);
this.scheduleBreakpointExpiry_(breakpoint);
}
});

Expand All @@ -850,7 +850,7 @@ export class Debuglet extends EventEmitter {
// field. It is possible that breakpoint.id is always
// undefined!
// TODO: Make sure the use of `that` here is correct.
delete that.completedBreakpointMap[(breakpoint as {} as {id: number}).id];
delete this.completedBreakpointMap[(breakpoint as {} as {id: number}).id];
});

// Remove active breakpoints that the server no longer care about.
Expand Down Expand Up @@ -906,14 +906,11 @@ export class Debuglet extends EventEmitter {
breakpoint: stackdriver.Breakpoint,
cb: (ob: Error | string) => void
): void {
// eslint-disable-next-line @typescript-eslint/no-this-alias
const that = this;

if (
!that.config.allowExpressions &&
!this.config.allowExpressions &&
(breakpoint.condition || breakpoint.expressions)
) {
that.logger.error(ALLOW_EXPRESSIONS_MESSAGE);
this.logger.error(ALLOW_EXPRESSIONS_MESSAGE);
breakpoint.status = new StatusMessage(
StatusMessage.UNSPECIFIED,
ALLOW_EXPRESSIONS_MESSAGE,
Expand All @@ -927,7 +924,7 @@ export class Debuglet extends EventEmitter {

if (utils.satisfies(process.version, '5.2 || <4')) {
const message = NODE_VERSION_MESSAGE;
that.logger.error(message);
this.logger.error(message);
breakpoint.status = new StatusMessage(
StatusMessage.UNSPECIFIED,
message,
Expand All @@ -939,41 +936,41 @@ export class Debuglet extends EventEmitter {
return;
}

// TODO: Address the case when `that.v8debug` is `null`.
(that.v8debug as DebugApi).set(breakpoint, err1 => {
// TODO: Address the case when `this.v8debug` is `null`.
(this.v8debug as DebugApi).set(breakpoint, err1 => {
if (err1) {
cb(err1);
return;
}
that.logger.info('\tsuccessfully added breakpoint ' + breakpoint.id);
this.logger.info('\tsuccessfully added breakpoint ' + breakpoint.id);
// TODO: Address the case when `breakpoint.id` is `undefined`.
that.activeBreakpointMap[breakpoint.id as string] = breakpoint;
this.activeBreakpointMap[breakpoint.id as string] = breakpoint;

if (breakpoint.action === 'LOG') {
// TODO: Address the case when `that.v8debug` is `null`.
(that.v8debug as DebugApi).log(
// TODO: Address the case when `this.v8debug` is `null`.
(this.v8debug as DebugApi).log(
breakpoint,
(fmt: string, exprs: string[]) => {
that.config.log.logFunction(
this.config.log.logFunction(
`LOGPOINT: ${Debuglet.format(fmt, exprs)}`
);
},
() => {
// TODO: Address the case when `breakpoint.id` is `undefined`.
return that.completedBreakpointMap[breakpoint.id as string];
return this.completedBreakpointMap[breakpoint.id as string];
}
);
} else {
// TODO: Address the case when `that.v8debug` is `null`.
(that.v8debug as DebugApi).wait(breakpoint, err2 => {
// TODO: Address the case when `this.v8debug` is `null`.
(this.v8debug as DebugApi).wait(breakpoint, err2 => {
if (err2) {
that.logger.error(err2);
this.logger.error(err2);
cb(err2);
return;
}

that.logger.info('Breakpoint hit!: ' + breakpoint.id);
that.completeBreakpoint_(breakpoint);
this.logger.info('Breakpoint hit!: ' + breakpoint.id);
this.completeBreakpoint_(breakpoint);
});
}
});
Expand All @@ -989,21 +986,24 @@ export class Debuglet extends EventEmitter {
breakpoint: stackdriver.Breakpoint,
deleteFromV8 = true
): void {
// eslint-disable-next-line @typescript-eslint/no-this-alias
const that = this;
assert(this.controller);

that.logger.info('\tupdating breakpoint data on server', breakpoint.id);
that.controller.updateBreakpoint(
// TODO: Address the case when `that.debuggee` is `null`.
that.debuggee as Debuggee,
this.logger.info('\tupdating breakpoint data on server', breakpoint.id);
this.controller.updateBreakpoint(
// TODO: Address the case when `this.debuggee` is `null`.
this.debuggee as Debuggee,
breakpoint,
(err /*, body*/) => {
if (err) {
that.logger.error('Unable to complete breakpoint on server', err);
} else {
this.logger.error('Unable to complete breakpoint on server', err);
return;
}
// The Firebase controller will remove the breakpoint during the update
// by removing it from the database.
if (!this.config.useFirebase) {
// TODO: Address the case when `breakpoint.id` is `undefined`.
that.completedBreakpointMap[breakpoint.id as string] = true;
that.removeBreakpoint_(breakpoint, deleteFromV8);
this.completedBreakpointMap[breakpoint.id as string] = true;
this.removeBreakpoint_(breakpoint, deleteFromV8);
}
}
);
Expand All @@ -1015,16 +1015,15 @@ export class Debuglet extends EventEmitter {
* @private
*/
rejectBreakpoint_(breakpoint: stackdriver.Breakpoint): void {
// eslint-disable-next-line @typescript-eslint/no-this-alias
const that = this;
assert(this.controller);

// TODO: Address the case when `that.debuggee` is `null`.
that.controller.updateBreakpoint(
that.debuggee as Debuggee,
// TODO: Address the case when `this.debuggee` is `null`.
this.controller.updateBreakpoint(
this.debuggee as Debuggee,
breakpoint,
(err /*, body*/) => {
if (err) {
that.logger.error('Unable to complete breakpoint on server', err);
this.logger.error('Unable to complete breakpoint on server', err);
}
}
);
Expand All @@ -1039,23 +1038,20 @@ export class Debuglet extends EventEmitter {
* @private
*/
scheduleBreakpointExpiry_(breakpoint: stackdriver.Breakpoint): void {
// eslint-disable-next-line @typescript-eslint/no-this-alias
const that = this;

const now = Date.now() / 1000;
const createdTime = breakpoint.createdTime
? Number(breakpoint.createdTime.seconds)
: now;
const expiryTime = createdTime + that.config.breakpointExpirationSec;
const expiryTime = createdTime + this.config.breakpointExpirationSec;

setTimeout(() => {
that.logger.info('Expiring breakpoint ' + breakpoint.id);
this.logger.info('Expiring breakpoint ' + breakpoint.id);
breakpoint.status = {
description: {format: 'The snapshot has expired'},
isError: true,
refersTo: StatusMessage.BREAKPOINT_AGE,
};
that.completeBreakpoint_(breakpoint);
this.completeBreakpoint_(breakpoint);
}, (expiryTime - now) * 1000).unref();
}

Expand All @@ -1066,6 +1062,7 @@ export class Debuglet extends EventEmitter {
* pending operations.
*/
stop(): void {
assert(this.controller);
assert.ok(this.running, 'stop can only be called on a running agent');
this.logger.debug('Stopping Debuglet');
this.running = false;
Expand Down
Loading

0 comments on commit 842690f

Please sign in to comment.