add session utility for dirty state. Ensure this dirty state is set t…

…o true whenever session is changed. And set to false whenever session is commited. Then in server code, check if session is dirty, if its dirty, set cookie with sessin.commit.
Shopify · May 22, 2024 · 8f6a236 · 8f6a236
1 parent adc840f
commit 8f6a236
Show file tree

Hide file tree

Showing 42 changed files with 111 additions and 359 deletions.
diff --git a/examples/analytics/app/root.tsx b/examples/analytics/app/root.tsx
@@ -94,28 +94,21 @@ export async function loader({context}: LoaderFunctionArgs) {
     },
   });
 
-  return defer(
-    {
-      cart: cartPromise,
-      footer: footerPromise,
-      header: await headerPromise,
-      isLoggedIn: isLoggedInPromise,
-      publicStoreDomain,
-      shop: getShopAnalytics({
-        storefront,
-        publicStorefrontId: env.PUBLIC_STOREFRONT_ID
-      }),
-      consent: {
-        checkoutDomain: env.PUBLIC_CHECKOUT_DOMAIN,
-        storefrontAccessToken: env.PUBLIC_STOREFRONT_API_TOKEN,
-      },
-    },
-    {
-      headers: {
-        'Set-Cookie': await context.session.commit(),
-      },
+  return defer({
+    cart: cartPromise,
+    footer: footerPromise,
+    header: await headerPromise,
+    isLoggedIn: isLoggedInPromise,
+    publicStoreDomain,
+    shop: getShopAnalytics({
+      storefront,
+      publicStorefrontId: env.PUBLIC_STOREFRONT_ID,
+    }),
+    consent: {
+      checkoutDomain: env.PUBLIC_CHECKOUT_DOMAIN,
+      storefrontAccessToken: env.PUBLIC_STOREFRONT_API_TOKEN,
     },
-  );
+  });
 }
 
 export default function App() {

diff --git a/examples/analytics/app/routes/cart.tsx b/examples/analytics/app/routes/cart.tsx
@@ -67,8 +67,6 @@ export async function action({request, context}: ActionFunctionArgs) {
     headers.set('Location', redirectTo);
   }
 
-  headers.append('Set-Cookie', await context.session.commit());
-
   return json(
     {
       cart: cartResult,

diff --git a/examples/b2b/app/root.tsx b/examples/b2b/app/root.tsx
@@ -110,20 +110,13 @@ export async function loader({context}: LoaderFunctionArgs) {
     },
   });
 
-  return defer(
-    {
-      cart: cartPromise,
-      footer: footerPromise,
-      header: await headerPromise,
-      isLoggedIn: isLoggedInPromise,
-      publicStoreDomain,
-    },
-    {
-      headers: {
-        'Set-Cookie': await context.session.commit(),
-      },
-    },
-  );
+  return defer({
+    cart: cartPromise,
+    footer: footerPromise,
+    header: await headerPromise,
+    isLoggedIn: isLoggedInPromise,
+    publicStoreDomain,
+  });
 }
 
 export default function App() {

diff --git a/examples/b2b/app/routes/b2blocations.tsx b/examples/b2b/app/routes/b2blocations.tsx
@@ -30,14 +30,7 @@ export async function loader({context}: LoaderFunctionArgs) {
 
   const modalOpen = Boolean(company) && !companyLocationId;
 
-  return defer(
-    {company, companyLocationId, modalOpen},
-    {
-      headers: {
-        'Set-Cookie': await context.session.commit(),
-      },
-    },
-  );
+  return defer({company, companyLocationId, modalOpen});
 }
 
 export default function CartRoute() {

diff --git a/examples/classic-remix/app/root.tsx b/examples/classic-remix/app/root.tsx
@@ -90,20 +90,13 @@ export async function loader({context}: LoaderFunctionArgs) {
     },
   });
 
-  return defer(
-    {
-      cart: cartPromise,
-      footer: footerPromise,
-      header: await headerPromise,
-      isLoggedIn: isLoggedInPromise,
-      publicStoreDomain,
-    },
-    {
-      headers: {
-        'Set-Cookie': await context.session.commit(),
-      },
-    },
-  );
+  return defer({
+    cart: cartPromise,
+    footer: footerPromise,
+    header: await headerPromise,
+    isLoggedIn: isLoggedInPromise,
+    publicStoreDomain,
+  });
 }
 
 export default function App() {

diff --git a/examples/custom-cart-method/app/routes/cart.tsx b/examples/custom-cart-method/app/routes/cart.tsx
@@ -94,8 +94,6 @@ export async function action({request, context}: ActionFunctionArgs) {
     headers.set('Location', redirectTo);
   }
 
-  headers.append('Set-Cookie', await context.session.commit());
-
   return json(
     {
       cart: cartResult,

diff --git a/examples/legacy-customer-account-flow/app/root.tsx b/examples/legacy-customer-account-flow/app/root.tsx
@@ -201,7 +201,6 @@ async function validateCustomerAccessToken(
 
   if (customerAccessTokenExpired) {
     session.unset('customerAccessToken');
-    headers.append('Set-Cookie', await session.commit());
   } else {
     isLoggedIn = true;
   }

diff --git a/examples/legacy-customer-account-flow/app/routes/account.profile.tsx b/examples/legacy-customer-account-flow/app/routes/account.profile.tsx
@@ -94,14 +94,7 @@ export async function action({request, context}: ActionFunctionArgs) {
       );
     }
 
-    return json(
-      {error: null, customer: updated.customerUpdate?.customer},
-      {
-        headers: {
-          'Set-Cookie': await session.commit(),
-        },
-      },
-    );
+    return json({error: null, customer: updated.customerUpdate?.customer});
   } catch (error: any) {
     return json({error: error.message, customer: null}, {status: 400});
   }

diff --git a/examples/legacy-customer-account-flow/app/routes/account.tsx b/examples/legacy-customer-account-flow/app/routes/account.tsx
@@ -20,11 +20,7 @@ export async function loader({request, context}: LoaderFunctionArgs) {
   if (!isLoggedIn) {
     if (isPrivateRoute || isAccountHome) {
       session.unset('customerAccessToken');
-      return redirect('/account/login', {
-        headers: {
-          'Set-Cookie': await session.commit(),
-        },
-      });
+      return redirect('/account/login');
     } else {
       // public subroute such as /account/login...
       return json({
@@ -67,11 +63,7 @@ export async function loader({request, context}: LoaderFunctionArgs) {
     // eslint-disable-next-line no-console
     console.error('There was a problem loading account', error);
     session.unset('customerAccessToken');
-    return redirect('/account/login', {
-      headers: {
-        'Set-Cookie': await session.commit(),
-      },
-    });
+    return redirect('/account/login');
   }
 }
 

diff --git a/examples/legacy-customer-account-flow/app/routes/account_.activate.$id.$activationToken.tsx b/examples/legacy-customer-account-flow/app/routes/account_.activate.$id.$activationToken.tsx
@@ -70,11 +70,7 @@ export async function action({request, context, params}: ActionFunctionArgs) {
     }
     session.set('customerAccessToken', customerAccessToken);
 
-    return redirect('/account', {
-      headers: {
-        'Set-Cookie': await session.commit(),
-      },
-    });
+    return redirect('/account');
   } catch (error: unknown) {
     if (error instanceof Error) {
       return json({error: error.message}, {status: 400});

diff --git a/examples/legacy-customer-account-flow/app/routes/account_.login.tsx b/examples/legacy-customer-account-flow/app/routes/account_.login.tsx
@@ -54,11 +54,7 @@ export async function action({request, context}: ActionFunctionArgs) {
     const {customerAccessToken} = customerAccessTokenCreate;
     session.set('customerAccessToken', customerAccessToken);
 
-    return redirect('/account', {
-      headers: {
-        'Set-Cookie': await session.commit(),
-      },
-    });
+    return redirect('/account');
   } catch (error: unknown) {
     if (error instanceof Error) {
       return json({error: error.message}, {status: 400});

diff --git a/examples/legacy-customer-account-flow/app/routes/account_.logout.tsx b/examples/legacy-customer-account-flow/app/routes/account_.logout.tsx
@@ -17,11 +17,7 @@ export async function action({request, context}: ActionFunctionArgs) {
     return json({error: 'Method not allowed'}, {status: 405});
   }
 
-  return redirect('/', {
-    headers: {
-      'Set-Cookie': await session.commit(),
-    },
-  });
+  return redirect('/');
 }
 
 export default function Logout() {

diff --git a/examples/legacy-customer-account-flow/app/routes/account_.register.tsx b/examples/legacy-customer-account-flow/app/routes/account_.register.tsx
@@ -89,10 +89,6 @@ export async function action({request, context}: ActionFunctionArgs) {
       {error: null, newCustomer},
       {
         status: 302,
-        headers: {
-          'Set-Cookie': await session.commit(),
-          Location: '/account',
-        },
       },
     );
   } catch (error: unknown) {

diff --git a/examples/legacy-customer-account-flow/app/routes/account_.reset.$id.$resetToken.tsx b/examples/legacy-customer-account-flow/app/routes/account_.reset.$id.$resetToken.tsx
@@ -47,11 +47,7 @@ export async function action({request, context, params}: ActionFunctionArgs) {
     }
     session.set('customerAccessToken', customerReset.customerAccessToken);
 
-    return redirect('/account', {
-      headers: {
-        'Set-Cookie': await session.commit(),
-      },
-    });
+    return redirect('/account');
   } catch (error: unknown) {
     if (error instanceof Error) {
       return json({error: error.message}, {status: 400});

diff --git a/examples/legacy-customer-account-flow/app/routes/cart.tsx b/examples/legacy-customer-account-flow/app/routes/cart.tsx
@@ -72,8 +72,6 @@ export async function action({request, context}: ActionFunctionArgs) {
     headers.set('Location', redirectTo);
   }
 
-  headers.append('Set-Cookie', await context.session.commit());
-
   return json(
     {
       cart: cartResult,

diff --git a/examples/metaobjects/app/root.tsx b/examples/metaobjects/app/root.tsx
@@ -89,25 +89,18 @@ export async function loader({context}: LoaderFunctionArgs) {
     },
   });
 
-  return defer(
-    {
-      cart: cartPromise,
-      footer: footerPromise,
-      header: await headerPromise,
-      isLoggedIn: isLoggedInPromise,
-      publicStoreDomain,
-      /***********************************************/
-      /**********  EXAMPLE UPDATE STARTS  ************/
-      publictoreSubdomain: context.env.PUBLIC_SHOPIFY_STORE_DOMAIN,
-      /**********   EXAMPLE UPDATE END   ************/
-      /***********************************************/
-    },
-    {
-      headers: {
-        'Set-Cookie': await context.session.commit(),
-      },
-    },
-  );
+  return defer({
+    cart: cartPromise,
+    footer: footerPromise,
+    header: await headerPromise,
+    isLoggedIn: isLoggedInPromise,
+    publicStoreDomain,
+    /***********************************************/
+    /**********  EXAMPLE UPDATE STARTS  ************/
+    publictoreSubdomain: context.env.PUBLIC_SHOPIFY_STORE_DOMAIN,
+    /**********   EXAMPLE UPDATE END   ************/
+    /***********************************************/
+  });
 }
 
 export default function App() {

diff --git a/examples/multipass/app/root.tsx b/examples/multipass/app/root.tsx
@@ -201,7 +201,6 @@ async function validateCustomerAccessToken(
 
   if (customerAccessTokenExpired) {
     session.unset('customerAccessToken');
-    headers.append('Set-Cookie', await session.commit());
   } else {
     isLoggedIn = true;
   }

diff --git a/examples/multipass/app/routes/account.profile.tsx b/examples/multipass/app/routes/account.profile.tsx
@@ -94,14 +94,7 @@ export async function action({request, context}: ActionFunctionArgs) {
       );
     }
 
-    return json(
-      {error: null, customer: updated.customerUpdate?.customer},
-      {
-        headers: {
-          'Set-Cookie': await session.commit(),
-        },
-      },
-    );
+    return json({error: null, customer: updated.customerUpdate?.customer});
   } catch (error: any) {
     return json({error: error.message, customer: null}, {status: 400});
   }

diff --git a/examples/multipass/app/routes/account.tsx b/examples/multipass/app/routes/account.tsx
@@ -20,11 +20,7 @@ export async function loader({request, context}: LoaderFunctionArgs) {
   if (!isLoggedIn) {
     if (isPrivateRoute || isAccountHome) {
       session.unset('customerAccessToken');
-      return redirect('/account/login', {
-        headers: {
-          'Set-Cookie': await session.commit(),
-        },
-      });
+      return redirect('/account/login');
     } else {
       // public subroute such as /account/login...
       return json({
@@ -67,11 +63,7 @@ export async function loader({request, context}: LoaderFunctionArgs) {
     // eslint-disable-next-line no-console
     console.error('There was a problem loading account', error);
     session.unset('customerAccessToken');
-    return redirect('/account/login', {
-      headers: {
-        'Set-Cookie': await session.commit(),
-      },
-    });
+    return redirect('/account/login');
   }
 }
 

diff --git a/examples/multipass/app/routes/account_.activate.$id.$activationToken.tsx b/examples/multipass/app/routes/account_.activate.$id.$activationToken.tsx
@@ -70,11 +70,7 @@ export async function action({request, context, params}: ActionFunctionArgs) {
     }
     session.set('customerAccessToken', customerAccessToken);
 
-    return redirect('/account', {
-      headers: {
-        'Set-Cookie': await session.commit(),
-      },
-    });
+    return redirect('/account');
   } catch (error: unknown) {
     if (error instanceof Error) {
       return json({error: error.message}, {status: 400});

diff --git a/examples/multipass/app/routes/account_.login.tsx b/examples/multipass/app/routes/account_.login.tsx
@@ -54,11 +54,7 @@ export async function action({request, context}: ActionFunctionArgs) {
     const {customerAccessToken} = customerAccessTokenCreate;
     session.set('customerAccessToken', customerAccessToken);
 
-    return redirect('/account', {
-      headers: {
-        'Set-Cookie': await session.commit(),
-      },
-    });
+    return redirect('/account');
   } catch (error: unknown) {
     if (error instanceof Error) {
       return json({error: error.message}, {status: 400});

diff --git a/examples/multipass/app/routes/account_.logout.tsx b/examples/multipass/app/routes/account_.logout.tsx
@@ -17,11 +17,7 @@ export async function action({request, context}: ActionFunctionArgs) {
     return json({error: 'Method not allowed'}, {status: 405});
   }
 
-  return redirect('/', {
-    headers: {
-      'Set-Cookie': await session.commit(),
-    },
-  });
+  return redirect('/');
 }
 
 export default function Logout() {

diff --git a/examples/multipass/app/routes/account_.register.tsx b/examples/multipass/app/routes/account_.register.tsx
@@ -90,7 +90,6 @@ export async function action({request, context}: ActionFunctionArgs) {
       {
         status: 302,
         headers: {
-          'Set-Cookie': await session.commit(),
           Location: '/account',
         },
       },