Dont make empty authScopes object if scopes is undefined

Shopify · Apr 17, 2024 · 0704100 · 0704100
1 parent a86df65
commit 0704100
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 7 deletions.
diff --git a/packages/apps/shopify-api/lib/config.ts b/packages/apps/shopify-api/lib/config.ts
@@ -66,12 +66,18 @@ export function validateConfig<Params extends ConfigParams>(
     ...mandatoryParams
   } = params;
 
+  let scopes;
+  if (params.scopes === undefined) {
+    scopes = undefined;
+  } else if (params.scopes instanceof AuthScopes) {
+    scopes = params.scopes;
+  } else {
+    scopes = new AuthScopes(params.scopes);
+  }
+
   Object.assign(config, mandatoryParams, {
     hostName: params.hostName.replace(/\/$/, ''),
-    scopes:
-      params.scopes instanceof AuthScopes
-        ? params.scopes
-        : new AuthScopes(params.scopes),
+    scopes,
     hostScheme: hostScheme ?? config.hostScheme,
     isCustomStoreApp: isCustomStoreApp ?? config.isCustomStoreApp,
     adminApiAccessToken: adminApiAccessToken ?? config.adminApiAccessToken,

diff --git a/packages/apps/shopify-api/lib/session/__tests__/session.test.ts b/packages/apps/shopify-api/lib/session/__tests__/session.test.ts
@@ -1,6 +1,7 @@
 import {Session} from '../session';
 import {testConfig} from '../../__tests__/test-config';
 import {shopifyApi} from '../..';
+import {AuthScopes} from '../../auth';
 
 describe('session', () => {
   it('can create a session from another session', () => {
@@ -60,7 +61,7 @@ describe('isActive', () => {
   });
 });
 
-it('returns true when scopes that passed in empty and scopes are not equal', () => {
+it('returns true when scopes that passed in undefined and scopes are not equal', () => {
   const session = new Session({
     id: 'active',
     shop: 'active-shop',
@@ -71,7 +72,22 @@ it('returns true when scopes that passed in empty and scopes are not equal', ()
     expires: new Date(Date.now() + 86400),
   });
 
-  expect(session.isActive('')).toBeTruthy();
+  expect(session.isActive(undefined)).toBeTruthy();
+});
+
+it('returns false when scopes that passed in empty and scopes are not equal', () => {
+  const session = new Session({
+    id: 'active',
+    shop: 'active-shop',
+    state: 'test_state',
+    isOnline: true,
+    scope: 'test_scope',
+    accessToken: 'indeed',
+    expires: new Date(Date.now() + 86400),
+  });
+
+  const scopes = new AuthScopes([]);
+  expect(session.isActive(scopes)).toBeFalsy();
 });
 
 it('returns false if session is not active', () => {

diff --git a/packages/apps/shopify-api/lib/session/session.ts b/packages/apps/shopify-api/lib/session/session.ts
@@ -190,7 +190,7 @@ export class Session {
   ): boolean {
     const scopesObject =
       scopes instanceof AuthScopes ? scopes : new AuthScopes(scopes);
-    if (typeof scopes === undefined || scopesObject.toArray().length === 0) {
+    if (typeof scopes === 'undefined') {
       return false;
     }