fix: identify propertyName (#614)

* fix: identify propertyName

* test: add system-test

* fix: unit tests

Author: AVaksman

handwritten/datastore/src/entity.ts

@@ -708,6 +708,7 @@ export namespace entity {
     // tslint:disable-next-line forin
     for (const property in properties) {
       const value = properties[property];
+      value.propertyName = property;
       entityObject[property] = entity.decodeValueProto(value, wrapNumbers);
     }
 

handwritten/datastore/system-test/datastore.ts

@@ -257,6 +257,31 @@ describe('Datastore', () => {
       await datastore.delete(postKey);
     });
 
+    it('should wrap specified properties via IntegerTypeCastOptions.properties', async () => {
+      const postKey = datastore.key('Scores');
+      const largeIntValueAsString = '9223372036854775807';
+      const panthers = Datastore.int(largeIntValueAsString);
+      const broncos = 922337203;
+      let integerTypeCastFunctionCalled = 0;
+      await datastore.save({key: postKey, data: {panthers, broncos}});
+      const [entity] = await datastore.get(postKey, {
+        wrapNumbers: {
+          // tslint:disable-next-line no-any
+          integerTypeCastFunction: (value: any) => {
+            integerTypeCastFunctionCalled++;
+            return value.toString();
+          },
+          properties: 'panthers',
+        },
+      });
+      // verify that value of property 'panthers' was converted via 'integerTypeCastFunction'.
+      assert.strictEqual(entity.panthers, largeIntValueAsString);
+      assert.strictEqual(integerTypeCastFunctionCalled, 1);
+      // verify that value of the property broncos was converted to int by default logic.
+      assert.strictEqual(entity.broncos, broncos);
+      await datastore.delete(postKey);
+    });
+
     it('should save/get/delete with a key name', async () => {
       const postKey = datastore.key(['Post', 'post1']);
       await datastore.save({key: postKey, data: post});

handwritten/datastore/test/entity.ts

@@ -997,6 +997,12 @@ describe('entity', () => {
         decodeValueProtoStub.restore();
       });
 
+      it('should identify entity propertyName', () => {
+        entity.entityFromEntityProto(entityProto);
+        const valueProto = decodeValueProtoStub.getCall(0).args[0];
+        assert.strictEqual(valueProto.propertyName, 'number');
+      });
+
       it('should pass `wrapNumbers` to decodeValueProto as undefined by default', () => {
         entity.entityFromEntityProto(entityProto);
         wrapNumbers = decodeValueProtoStub.getCall(0).args[1];

handwritten/datastore/test/request.ts

@@ -377,13 +377,14 @@ describe('Request', () => {
 
       it('should emit an error from results decoding', done => {
         const largeInt = '922337203685477850';
+        const propertyName = 'points';
         request.request_ = (config: RequestConfig, callback: Function) => {
           callback(null, {
             found: [
               {
                 entity: {
                   properties: {
-                    points: {
+                    [propertyName]: {
                       integerValue: largeInt,
                       valueType: 'integerValue',
                     },
@@ -401,7 +402,7 @@ describe('Request', () => {
           .on('error', (err: Error) => {
             assert.deepStrictEqual(
               err,
-              outOfBoundsError({integerValue: largeInt})
+              outOfBoundsError({integerValue: largeInt, propertyName})
             );
             setImmediate(() => {
               assert.strictEqual(stream.destroyed, true);
@@ -990,6 +991,7 @@ describe('Request', () => {
 
       it('should emit an error from results decoding', done => {
         const largeInt = '922337203685477850';
+        const propertyName = 'points';
         sandbox.stub(entity, 'queryToQueryProto');
 
         request.request_ = (config: RequestConfig, callback: Function) => {
@@ -999,7 +1001,7 @@ describe('Request', () => {
                 {
                   entity: {
                     properties: {
-                      points: {
+                      [propertyName]: {
                         integerValue: largeInt,
                         valueType: 'integerValue',
                       },
@@ -1017,7 +1019,7 @@ describe('Request', () => {
           .on('error', (err: Error) => {
             assert.deepStrictEqual(
               err,
-              outOfBoundsError({integerValue: largeInt})
+              outOfBoundsError({integerValue: largeInt, propertyName})
             );
             setImmediate(() => {
               assert.strictEqual(stream.destroyed, true);