Merge pull request #1313 from Shopify/liz/only-return-user-when-online

Only return user when online

Author: lizkenyon

.changeset/nasty-trees-sing.md

@@ -0,0 +1,5 @@
+---
+"@shopify/shopify-api": patch
+---
+
+Fixes bug, that is returning the onlineAccessInfo field on the session, when the session if offline

packages/shopify-api/lib/session/__tests__/session.test.ts

@@ -571,5 +571,20 @@ describe('toPropertyArray and fromPropertyArray', () => {
         ).toBeUndefined();
       }
     });
+    const describe = test.session.isOnline ? 'Does' : 'Does not';
+    const isOnline = test.session.isOnline ? 'online' : 'offline';
+
+    it(`${describe} have online access info when the token is ${isOnline}`, () => {
+      const session = new Session(test.session);
+      const sessionCopy = Session.fromPropertyArray(
+        session.toPropertyArray(test.returnUserData),
+        test.returnUserData,
+      );
+      if (test.session.isOnline) {
+        expect(sessionCopy.onlineAccessInfo).toBeDefined();
+      } else {
+        expect(sessionCopy.onlineAccessInfo).toBeUndefined();
+      }
+    });
   });
 });

packages/shopify-api/lib/session/session.ts

@@ -58,11 +58,10 @@ export class Session {
         }),
     );
 
-    const sessionData = {
-      onlineAccessInfo: {
-        associated_user: {},
-      },
-    } as SessionParams;
+    const sessionData = {} as SessionParams;
+    const onlineAccessInfo = {
+      associated_user: {},
+    } as OnlineAccessInfo;
     Object.entries(obj).forEach(([key, value]) => {
       switch (key) {
         case 'isOnline':
@@ -81,59 +80,56 @@ export class Session {
           sessionData[key] = value ? new Date(Number(value)) : undefined;
           break;
         case 'onlineAccessInfo':
-          sessionData.onlineAccessInfo!.associated_user.id = Number(value);
+          onlineAccessInfo.associated_user.id = Number(value);
           break;
         case 'userId':
           if (returnUserData) {
-            sessionData.onlineAccessInfo!.associated_user.id = Number(value);
+            onlineAccessInfo.associated_user.id = Number(value);
             break;
           }
         case 'firstName':
           if (returnUserData) {
-            sessionData.onlineAccessInfo!.associated_user.first_name =
-              String(value);
+            onlineAccessInfo.associated_user.first_name = String(value);
             break;
           }
         case 'lastName':
           if (returnUserData) {
-            sessionData.onlineAccessInfo!.associated_user.last_name =
-              String(value);
+            onlineAccessInfo.associated_user.last_name = String(value);
             break;
           }
         case 'email':
           if (returnUserData) {
-            sessionData.onlineAccessInfo!.associated_user.email = String(value);
+            onlineAccessInfo.associated_user.email = String(value);
             break;
           }
         case 'accountOwner':
           if (returnUserData) {
-            sessionData.onlineAccessInfo!.associated_user.account_owner =
-              Boolean(value);
+            onlineAccessInfo.associated_user.account_owner = Boolean(value);
             break;
           }
         case 'locale':
           if (returnUserData) {
-            sessionData.onlineAccessInfo!.associated_user.locale =
-              String(value);
+            onlineAccessInfo.associated_user.locale = String(value);
             break;
           }
         case 'collaborator':
           if (returnUserData) {
-            sessionData.onlineAccessInfo!.associated_user.collaborator =
-              Boolean(value);
+            onlineAccessInfo.associated_user.collaborator = Boolean(value);
             break;
           }
         case 'emailVerified':
           if (returnUserData) {
-            sessionData.onlineAccessInfo!.associated_user.email_verified =
-              Boolean(value);
+            onlineAccessInfo.associated_user.email_verified = Boolean(value);
             break;
           }
         // Return any user keys as passed in
         default:
           sessionData[key] = value;
       }
     });
+    if (sessionData.isOnline) {
+      sessionData.onlineAccessInfo = onlineAccessInfo;
+    }
     const session = new Session(sessionData);
     return session;
   }