fix: Give useful message with unresolved projectID (#360)

DominicKramer · web-flow · commit 6e0088e5bffe · 2017-11-14T11:23:55.000-08:00
Fixes: #357
diff --git a/src/agent/debuglet.ts b/src/agent/debuglet.ts
@@ -268,7 +268,7 @@ export class Debuglet extends EventEmitter {
       try {
         project = await Debuglet.getProjectId(that.debug.options);
       } catch (err) {
-        that.logger.error(err.message);
+        that.logger.error('The project ID could not be determined: ' + err.message);
         that.emit('initError', err);
         return;
       }
diff --git a/test/test-debuglet.ts b/test/test-debuglet.ts
@@ -397,6 +397,34 @@ describe('Debuglet', function() {
       debuglet.start();
     });
 
+    it('should give a useful error message when projectId is not available', function(done) {
+      const savedGetProjectId = Debuglet.getProjectId;
+      Debuglet.getProjectId = () => {
+        return Promise.reject(new Error('no project id'));
+      };
+
+      const debug = new Debug({}, packageInfo);
+      const debuglet = new Debuglet(debug, defaultConfig);
+
+      let message = '';
+      const savedLoggerError = debuglet.logger.error;
+      debuglet.logger.error = (text: string) => {
+        message += text;
+      };
+
+      debuglet.once('initError', function(err) {
+        Debuglet.getProjectId = savedGetProjectId;
+        debuglet.logger.error = savedLoggerError;
+        assert.ok(err);
+        assert(message.startsWith('The project ID could not be determined:'));
+        done();
+      });
+      debuglet.once('started', function() {
+        assert.fail('The debuglet should fail to start without a projectId');
+      });
+      debuglet.start();
+    });
+
     it('should not crash without project num', function(done) {
       const savedGetProjectId = Debuglet.getProjectId;
       Debuglet.getProjectId = () => {

Original file line number	Diff line number	Diff line change
`@@ -268,7 +268,7 @@ export class Debuglet extends EventEmitter {`
`268`	`268`	`try {`
`269`	`269`	`project = await Debuglet.getProjectId(that.debug.options);`
`270`	`270`	`} catch (err) {`
`271`		`- that.logger.error(err.message);`
	`271`	`+ that.logger.error('The project ID could not be determined: ' + err.message);`
`272`	`272`	`that.emit('initError', err);`
`273`	`273`	`return;`
`274`	`274`	`}`