feat: expose displayName in createInstance (#798)

* feat: expose displayName in createInstance

* tests: remove unnecessary casts in tests

Author: AVaksman

handwritten/spanner/src/index.ts

@@ -90,6 +90,7 @@ export interface RequestConfig {
 export interface CreateInstanceRequest {
   config: string;
   nodes?: number;
+  displayName?: string;
   labels?: {[k: string]: string} | null;
 }
 /**
@@ -277,6 +278,11 @@ class Spanner extends GrpcService {
    *     be used to control how resource metrics are aggregated. And they can
    *     be used as arguments to policy management rules (e.g. route,
    *     firewall, load balancing, etc.).
+   * @property {string} [displayName] The descriptive name for this instance
+   *     as it appears in UIs. Must be unique per project and between 4 and 30
+   *     characters in length.
+   *     Defaults to the instance unique identifier '<instance>' of the full
+   *     instance name of the form 'projects/<project>/instances/<instance>'.
    */
   /**
    * @typedef {array} CreateInstanceResponse
@@ -359,14 +365,14 @@ class Spanner extends GrpcService {
       );
     }
     const formattedName = Instance.formatName_(this.projectId, name);
-    const shortName = formattedName.split('/').pop();
+    const displayName = config.displayName || formattedName.split('/').pop();
     const reqOpts = {
       parent: 'projects/' + this.projectId,
-      instanceId: shortName,
+      instanceId: displayName,
       instance: extend(
         {
           name: formattedName,
-          displayName: shortName,
+          displayName,
           nodeCount: config.nodes || 1,
         },
         config

handwritten/spanner/test/index.ts

@@ -525,25 +525,29 @@ describe('Spanner', () => {
         });
         done();
       };
-      spanner.createInstance(
-        NAME,
-        CONFIG as CreateInstanceRequest,
-        assert.ifError
-      );
+      spanner.createInstance(NAME, CONFIG, assert.ifError);
     });
 
     it('should accept a path', () => {
       const stub = sandbox.stub(FakeInstance, 'formatName_').callThrough();
-      spanner.createInstance(
-        PATH,
-        CONFIG as CreateInstanceRequest,
-        assert.ifError
-      );
+      spanner.createInstance(PATH, CONFIG, assert.ifError);
 
       const [, name] = stub.lastCall.args;
       assert.strictEqual(name, PATH);
     });
 
+    it('should accept the displayName', done => {
+      const displayName = 'my-instance';
+      const config = Object.assign({}, CONFIG, {displayName});
+
+      spanner.request = config => {
+        assert.strictEqual(config.reqOpts.instance.displayName, displayName);
+        done();
+      };
+
+      spanner.createInstance(NAME, config, assert.ifError);
+    });
+
     describe('config.nodes', () => {
       it('should rename to nodeCount', () => {
         const config = extend({}, CONFIG, {nodes: 10});
@@ -586,17 +590,13 @@ describe('Spanner', () => {
       });
 
       it('should execute callback with error & API response', done => {
-        spanner.createInstance(
-          NAME,
-          CONFIG as CreateInstanceRequest,
-          (err, instance, op, resp) => {
-            assert.strictEqual(err, ERROR);
-            assert.strictEqual(instance, null);
-            assert.strictEqual(op, null);
-            assert.strictEqual(resp, API_RESPONSE);
-            done();
-          }
-        );
+        spanner.createInstance(NAME, CONFIG, (err, instance, op, resp) => {
+          assert.strictEqual(err, ERROR);
+          assert.strictEqual(instance, null);
+          assert.strictEqual(op, null);
+          assert.strictEqual(resp, API_RESPONSE);
+          done();
+        });
       });
     });
 
@@ -618,19 +618,15 @@ describe('Spanner', () => {
           .stub(spanner, 'instance')
           .returns(fakeInstanceInstance);
 
-        spanner.createInstance(
-          NAME,
-          CONFIG as CreateInstanceRequest,
-          (err, instance, op, resp) => {
-            assert.ifError(err);
-            const [instanceName] = instanceStub.lastCall.args;
-            assert.strictEqual(instanceName, formattedName);
-            assert.strictEqual(instance, fakeInstanceInstance);
-            assert.strictEqual(op, OPERATION);
-            assert.strictEqual(resp, API_RESPONSE);
-            done();
-          }
-        );
+        spanner.createInstance(NAME, CONFIG, (err, instance, op, resp) => {
+          assert.ifError(err);
+          const [instanceName] = instanceStub.lastCall.args;
+          assert.strictEqual(instanceName, formattedName);
+          assert.strictEqual(instance, fakeInstanceInstance);
+          assert.strictEqual(op, OPERATION);
+          assert.strictEqual(resp, API_RESPONSE);
+          done();
+        });
       });
     });
   });