Merge pull request #380 from Shopify/kos/add_saving_param_to_serialize

Adds support for read-only attributes to serialize

Author: mkevinosullivan

CHANGELOG.md

@@ -7,6 +7,8 @@ and adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
 
+- Add optional `saving` parameter to `serialize` of `Base` class - default is `false` and will include read-only attributes in returned object; `true` used for `save` when committing via API to Shopify.
+
 ### Fixed
 - Fixes [#363](https://github.com/Shopify/shopify-node-api/issues/363)
   - Webhooks `register` now checks for any attempt to register a GDPR topic (not done via API but by Partner Dashboard), provides an error message in response

src/__tests__/base-rest-resource.test.ts

@@ -198,7 +198,10 @@ describe('Base REST resource', () => {
         id: 1,
         attribute: 'attribute',
         has_one_attribute: {attribute: 'attribute1'},
-        has_many_attribute: [{attribute: 'attribute2'}],
+        has_many_attribute: [
+          {attribute: 'attribute2'},
+          {attribute: 'attribute3'},
+        ],
       },
     };
     fetchMock.mockResponseOnce(JSON.stringify({}));
@@ -209,11 +212,14 @@ describe('Base REST resource', () => {
     const child2 = new FakeResource({session});
     child2.attribute = 'attribute2';
 
+    const child3 = new FakeResource({session});
+    child3.attribute = 'attribute3';
+
     const resource = new FakeResource({session});
     resource.id = 1;
     resource.attribute = 'attribute';
     resource.has_one_attribute = child1;
-    resource.has_many_attribute = [child2];
+    resource.has_many_attribute = [child2, child3];
 
     await resource.save();
 
@@ -446,4 +452,29 @@ describe('Base REST resource', () => {
       ),
     );
   });
+
+  it('includes unsaveable attributes when default serialize called', async () => {
+    const resource = new FakeResource({session});
+    resource.attribute = 'attribute';
+    resource.unsaveable_attribute = 'unsaveable_attribute';
+
+    const hash = resource.serialize();
+
+    expect(hash).toHaveProperty('unsaveable_attribute', 'unsaveable_attribute');
+    expect(hash).toHaveProperty('attribute', 'attribute');
+  });
+
+  it('excludes unsaveable attributes when serialize called for saving', async () => {
+    const resource = new FakeResource({session});
+    resource.attribute = 'attribute';
+    resource.unsaveable_attribute = 'unsaveable_attribute';
+
+    const hash = resource.serialize(true);
+
+    expect(hash).not.toHaveProperty(
+      'unsaveable_attribute',
+      'unsaveable_attribute',
+    );
+    expect(hash).toHaveProperty('attribute', 'attribute');
+  });
 });

src/auth/session/storage/__tests__/mongodb.test.ts

@@ -15,7 +15,7 @@ const dbName = 'shopitest';
 
 // SORRY NOT SORRY. Docker containers can take quite a while to get ready,
 // especially on CI. This is hopefully enough.
-jest.setTimeout(20000);
+jest.setTimeout(25000);
 
 describe('MongoDBSessionStorage', () => {
   let storage: MongoDBSessionStorage;

src/auth/session/storage/__tests__/mysql.test.ts

@@ -14,7 +14,7 @@ const dbURL = new URL('mysql://shopify:passify@localhost/shopitest');
 
 // SORRY NOT SORRY. Docker containers can take quite a while to get ready,
 // especially on CI. This is hopefully enough.
-jest.setTimeout(20000);
+jest.setTimeout(25000);
 
 describe('MySQLSessionStorage', () => {
   let storage: MySQLSessionStorage;

src/auth/session/storage/__tests__/postgresql.test.ts

@@ -14,7 +14,7 @@ const dbURL = new URL('postgres://shopify:passify@localhost/shopitest');
 
 // SORRY NOT SORRY. Docker containers can take quite a while to get ready,
 // especially on CI. This is hopefully enough.
-jest.setTimeout(20000);
+jest.setTimeout(25000);
 
 describe('PostgreSQLSessionStorage', () => {
   let storage: PostgreSQLSessionStorage;

src/auth/session/storage/__tests__/redis.test.ts

@@ -14,7 +14,7 @@ const dbURL = new URL('redis://shopify:passify@localhost/1');
 
 // SORRY NOT SORRY. Docker containers can take quite a while to get ready,
 // especially on CI. This is hopefully enough.
-jest.setTimeout(20000);
+jest.setTimeout(25000);
 
 describe('RedisSessionStorage', () => {
   let storage: RedisSessionStorage | undefined;

src/base-rest-resource.ts

@@ -256,7 +256,7 @@ class Base {
     const {PRIMARY_KEY, NAME} = this.resource();
     const method = this[PRIMARY_KEY] ? 'put' : 'post';
 
-    const data = this.serialize();
+    const data = this.serialize(true);
 
     const response = await this.resource().request({
       http_method: method,
@@ -288,25 +288,24 @@ class Base {
     });
   }
 
-  public serialize(): Body {
+  public serialize(saving = false): Body {
     const {HAS_MANY, HAS_ONE, READ_ONLY_ATTRIBUTES} = this.resource();
 
     return Object.entries(this).reduce((acc: Body, [attribute, value]) => {
       if (
-        ['session'].includes(attribute) ||
-        READ_ONLY_ATTRIBUTES.includes(attribute)
+        saving &&
+        (['session'].includes(attribute) ||
+          READ_ONLY_ATTRIBUTES.includes(attribute))
       ) {
         return acc;
       }
 
       if (attribute in HAS_MANY && value) {
-        acc[attribute] = value.reduce(
-          (attrAcc: Body, entry: Base) =>
-            attrAcc.concat(entry.serialize ? entry.serialize() : entry),
-          [],
-        );
-      } else if (attribute in HAS_ONE && value && value.serialize) {
-        acc[attribute] = (value as Base).serialize();
+        acc[attribute] = value.reduce((attrAcc: Body, entry: Base) => {
+          return attrAcc.concat(this.serializeSubAttribute(entry, saving));
+        }, []);
+      } else if (attribute in HAS_ONE && value) {
+        acc[attribute] = this.serializeSubAttribute(value, saving);
       } else {
         acc[attribute] = value;
       }
@@ -342,6 +341,14 @@ class Base {
   private resource(): typeof Base {
     return this.constructor as unknown as typeof Base;
   }
+
+  private serializeSubAttribute(attribute: Base, saving: boolean): Body {
+    return attribute.serialize
+      ? attribute.serialize(saving)
+      : this.resource()
+          .createInstance(this.session, attribute)
+          .serialize(saving);
+  }
 }
 
 export default Base;