GCLOUD_PROJECT instead of GCLOUD_PROJECT_NUM

Matt Loring · Matt Loring · commit 2bc75d8f1825 · 2016-04-13T14:57:52.000-07:00
Fixes #90
diff --git a/README.md b/README.md
@@ -13,41 +13,19 @@ This module provides Cloud Debug support for Node.js applications. [Google Cloud
 [![Cloud Debugger Intro](http://img.youtube.com/vi/tyHcK_kAOpw/0.jpg)](https://www.youtube.com/watch?v=tyHcK_kAOpw)
 
 ## Prerequisites
-* Your application will need to be using Node.js version 0.12 or greater. Node.js v5+ is recommended. (Node.js v5.2.0 is not supported on account of [this bug](https://github.com/nodejs/node/issues/4297))
+* Your application will need to be using Node.js version 0.12 or greater. Node.js v5+ is recommended.
 * The source of your application is uploaded to a [cloud source repository](https://cloud.google.com/tools/cloud-repositories/docs/). The Debugger UI needs the source to be available in order to set breakpoints.
 
 ## Quick Start (Node.js v4.x+)
 ```shell
 # Install with `npm` or add to your `package.json`.
 npm install --save @google/cloud-debug
 
-# Change the start command of your application in package.json
-   ...
-   "scripts" {
-     "start": "node --require @google/cloud-debug server.js"
-   ...
+# Require the agent at the top of your main script.
+require('@google/cloud-debug');
 ```
 Deploy your application, and navigate to the [Debug tab][debug-tab] within the [Google Developers Console][dev-console] to set breakpoints and start debugging.
 
-## Installation
-
-1. Install the debug agent module via `npm` or add it to your `package.json`.
-
-   ```shell
-   npm install --save @google/cloud-debug
-   ```
-1. Ensure that the module gets loaded during your application's startup. The best way to do this is via the `--require` command line option available in Node.js v4. You should add this option to the startup script section in your `package.json`.
-
-   ```
-   "scripts": {
-      "start": "node --require @google/cloud-debug server.js",
-   ```
-   If you are using Node.js v0.12.x, you will not be able to use the `--require` command line option. Instead you will have to manually load the debug agent module in the startup script of your application. For example, you may want to add the following
-   to your `server.js`:
-   ```javascript
-   require('@google/cloud-debug');
-   ```
-
 ## Running on Google Cloud Platform
 
 There are three different services that can host Node.js application to Google Cloud Platform.
@@ -72,13 +50,13 @@ Container Engine nodes need to also be created with the `cloud-platform` scope,
 
 If your application is running outside of Google Cloud Platform, such as locally, on-premise, or on another cloud provider, you can still use Cloud Debug.
 
-1. You will need to specify the numeric project ID of your project. Your numeric project ID, or project number, is visible the Project information section on your project's [dashboard][dashboard].
+1. You will need to specify your project name. Your project name is visible in the [Google Cloud Console][cloud-console-projects], it may be something like `particular-future-12345`. If your application is [running on Google Cloud Platform](running-on-google-cloud-platform), you don't need to specify the project name.
 
-        export GCLOUD_PROJECT_NUM=<your numeric project id>
+        export GCLOUD_PROJECT=<project name>
 
-2. You need to provide service account credentials to your application. The recommended way is via [Application Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials).
+2. You need to provide service account credentials to your application. The recommended way is via [Application Default Credentials][app-default-credentials].
 
-  1. [Create a new JSON service account key](https://console.developers.google.com/apis/credentials/serviceaccountkey).
+  1. [Create a new JSON service account key][service-account].
   2. Copy the key somewhere your application can access it. Be sure not to expose the key publicly.
   3. Set the environment variable `GOOGLE_APPLICATION_CREDENTIALS` to the full path to the key. The debug agent will automatically look for this environment variable.
 
@@ -110,10 +88,12 @@ As soon as that line of code is reached in any of the running instances of your
 
 
 [cloud-debugger]: https://cloud.google.com/tools/cloud-debugger/
-[dev-console]: https://console.developers.google.com/
-[dashboard]: https://console.developers.google.com/dashboard
+[dev-console]: https://console.cloud.google.com/
 [debug-tab]: https://console.developers.google.com/debug
 [gcloud-sdk]: https://cloud.google.com/sdk/gcloud/
+[cloud-console-projects]: https://console.cloud.google.com/iam-admin/projects
+[app-default-credentials]: https://developers.google.com/identity/protocols/application-default-credentials
+[service-account]: https://console.developers.google.com/apis/credentials/serviceaccountkey
 [npm-image]: https://img.shields.io/npm/v/@google/cloud-debug.svg
 [npm-url]: https://npmjs.org/package/@google/cloud-debug
 [travis-image]: https://travis-ci.org/GoogleCloudPlatform/cloud-debug-nodejs.svg?branch=master
diff --git a/lib/debugletapi.js b/lib/debugletapi.js
@@ -46,7 +46,7 @@ function DebugletApi() {
   this.request_ = utils.authorizedRequestFactory(SCOPES);
 
   /** @private {string} numeric project id */
-  this.projectNumber_ = null;
+  this.project_ = null;
 
   /** @private {string} debuggee id provided by the server once registered */
   this.debuggeeId_ = null;
@@ -66,12 +66,12 @@ DebugletApi.prototype.init = function(uid, logger, callback) {
   that.uid_ = uid;
   that.nextWaitToken_ = null;
 
-  function complete(err, projectNumber) {
+  function complete(err, project) {
     if (err) {
       callback(err);
       return;
     }
-    that.projectNumber_ = projectNumber;
+    that.project_ = project;
 
     fs.readFile('source-contexts.json', 'utf8', function(err, data) {
       try {
@@ -84,14 +84,11 @@ DebugletApi.prototype.init = function(uid, logger, callback) {
     });
   }
 
-  if (process.env.GCLOUD_PROJECT_NUM) {
-    var projectNumber = process.env.GCLOUD_PROJECT_NUM;
-    var err = /^\d+$/.test(projectNumber) ?
-      null :
-      new Error('GCLOUD_PROJECT_NUM should be numeric');
+  if (process.env.GCLOUD_PROJECT) {
+    var project = process.env.GCLOUD_PROJECT;
 
     setImmediate(function() {
-      complete(err, projectNumber);
+      complete(null, project);
     });
   } else {
     utils.getProjectNumber(complete);
@@ -159,7 +156,7 @@ DebugletApi.prototype.register_ = function(errorMessage, callback) {
   uniquifier  = crypto.createHash('sha1').update(uniquifier).digest('hex');
 
   var debuggee = {
-    project: that.projectNumber_,
+    project: that.project_,
     uniquifier: uniquifier,
     description: desc,
     agentVersion: version,
diff --git a/test/e2e/test-capture-time.js b/test/e2e/test-capture-time.js
@@ -34,7 +34,7 @@ var debuglet;
 
 describe(__filename, function(){
   beforeEach(function() {
-    process.env.GCLOUD_PROJECT_NUM = 0;
+    process.env.GCLOUD_PROJECT = 0;
     debuglet = new Debuglet(
       config, logger.create(config.logLevel, '@google/cloud-debug'));
     debuglet.once('started', function() {
diff --git a/test/e2e/test-error-message.js b/test/e2e/test-error-message.js
@@ -31,7 +31,7 @@ describe(__filename, function() {
     var debuglet = new Debuglet(
       config, logger.create(config.logLevel, '@google/cloud-debug'));
 
-    process.env.GCLOUD_PROJECT_NUM=0;
+    process.env.GCLOUD_PROJECT=0;
 
     var API = 'https://clouddebugger.googleapis.com';
 
diff --git a/test/e2e/test.js b/test/e2e/test.js
@@ -63,7 +63,7 @@ module.exports.runTest = function runTest() {
     assert.ok(api.debuggeeId_, 'debuglet has registered');
 
     var debuggee = api.debuggeeId_;
-    var project = api.projectNumber_;
+    var project = api.project_;
 
     // Get our own credentials because we need an extra scope
     var auth = new GoogleAuth();
diff --git a/test/standalone/test-debuglet.js b/test/standalone/test-debuglet.js
@@ -37,7 +37,7 @@ var bp = {
 
 describe(__filename, function(){
   beforeEach(function() {
-    process.env.GCLOUD_PROJECT_NUM = 0;
+    process.env.GCLOUD_PROJECT = 0;
     debuglet = new Debuglet(
       config, logger.create(config.logLevel, '@google/cloud-debug'));
     debuglet.once('started', function() {
@@ -50,7 +50,7 @@ describe(__filename, function(){
   });
 
   it('should not start unless we know the project num', function(done) {
-    delete process.env.GCLOUD_PROJECT_NUM;
+    delete process.env.GCLOUD_PROJECT;
     var scope = nock('http://metadata.google.internal')
       .get('/computeMetadata/v1/project/numeric-project-id')
       .reply(404);
@@ -66,17 +66,23 @@ describe(__filename, function(){
     debuglet.start();
   });
 
-  it('should complain if GCLOUD_PROJECT_NUM is not numeric', function(done) {
-    process.env.GCLOUD_PROJECT_NUM='11020304f2934';
+  it('should accept non-numeric GCLOUD_PROJECT', function(done) {
+    process.env.GCLOUD_PROJECT='11020304f2934';
 
-    debuglet.once('error', function(err) {
-      assert(err);
-      assert(err.message.indexOf('should be numeric') !== -1);
+    var scope = nock(API)
+      .post(REGISTER_PATH)
+      .reply(200, {
+        debuggee: {
+          id: DEBUGGEE_ID
+        }
+      });
+
+    debuglet.once('registered', function(id) {
+      assert(id === DEBUGGEE_ID);
+      scope.done();
       done();
     });
-    debuglet.once('started', function() {
-      assert.fail();
-    });
+
     debuglet.start();
   });
 
diff --git a/test/standalone/test-env-relative-repository-path.js b/test/standalone/test-env-relative-repository-path.js
@@ -16,7 +16,7 @@
 
 'use strict';
 
-process.env.GCLOUD_PROJECT_NUM = 0;
+process.env.GCLOUD_PROJECT = 0;
 process.env.GCLOUD_DEBUG_REPO_APP_PATH = '/my/project/root';
 
 var assert = require('assert');
