Fix sorting of http only and partitionKey.

Fix types.
GoogleChromeLabs · Jul 29, 2024 · 998303c · 998303c
1 parent d2c6320
commit 998303c
Show file tree

Hide file tree

Showing 9 changed files with 78 additions and 40 deletions.
diff --git a/packages/analysis-utils/src/browserManagement/index.ts b/packages/analysis-utils/src/browserManagement/index.ts
@@ -18,7 +18,7 @@
  * External dependencies.
  */
 import puppeteer, { Browser, HTTPResponse, Page, Protocol } from 'puppeteer';
-import { parse } from 'simple-cookie';
+import { parse, type Cookie } from 'simple-cookie';
 import {
   type CookieData,
   type ScriptTagUnderCheck,
@@ -292,7 +292,7 @@ export class BrowserManagement {
     const cookies: CookieData[] = headersToBeParsed
       .split('\n')
       .map((headerLine) => {
-        const parsedCookie: CookieData['parsedCookie'] = parse(headerLine);
+        const parsedCookie: Cookie = parse(headerLine);
 
         const url = this.pageResponses[pageId][requestId]?.url;
 
@@ -338,6 +338,7 @@ export class BrowserManagement {
             expires: parsedCookie.expires || 'Session',
             httponly: parsedCookie.httponly || false,
             secure: parsedCookie.secure || false,
+            partitionKey: '',
           },
           networkEvents: {
             responseEvents: [
@@ -410,6 +411,7 @@ export class BrowserManagement {
           expires: associatedCookie.cookie.expires || 'Session',
           httpOnly: associatedCookie.cookie.httpOnly || false,
           secure: associatedCookie.cookie.secure || false,
+          partitionKey: '',
         },
         networkEvents: {
           requestEvents: [
@@ -429,6 +431,12 @@ export class BrowserManagement {
         url: this.pageRequests[pageId][requestId]?.url || '',
         headerType: 'request' as CookieData['headerType'],
       };
+
+      if (associatedCookie.cookie?.partitionKey) {
+        singleCookie.parsedCookie.partitionKey =
+          associatedCookie.cookie?.partitionKey?.topLevelSite;
+      }
+
       return singleCookie;
     });
 
@@ -553,7 +561,9 @@ export class BrowserManagement {
               cookie.domain = '.' + cookie.domain;
             }
             const key = cookie.name + ':' + cookie.domain + ':' + cookie.path;
-            frameCookies[key] = { parsedCookie: cookie };
+            frameCookies[key] = {
+              parsedCookie: { ...cookie, partitionKey: '' },
+            };
           });
 
           const frameUrl = new URL(frame.url()).origin;

diff --git a/packages/common/src/cookies.types.ts b/packages/common/src/cookies.types.ts
@@ -102,7 +102,7 @@ export type responseEvent = {
 
 export type CookieData = {
   parsedCookie: ParsedCookie & {
-    partitionKey?: string;
+    partitionKey: string;
     priority?: 'Low' | 'Medium' | 'High';
     size?: number;
   };
@@ -200,7 +200,7 @@ export type CookieJsonDataType = {
     name: string;
     value: string;
     domain: string;
-    partitionKey?: string;
+    partitionKey: string;
     path: string;
     expires: string;
     httpOnly: boolean;

diff --git a/packages/common/src/utils/parseRequestWillBeSentExtraInfo.ts b/packages/common/src/utils/parseRequestWillBeSentExtraInfo.ts
@@ -55,6 +55,8 @@ export default function parseRequestWillBeSentExtraInfo(
       cookie.expires
     );
 
+    const { partitionKey, ...cookieWithoutPartitionKey } = cookie;
+
     let domain;
 
     if (cookie?.domain) {
@@ -66,15 +68,11 @@ export default function parseRequestWillBeSentExtraInfo(
     const singleCookie: CookieData = {
       isBlocked: blockedReasons.length !== 0,
       parsedCookie: {
-        ...cookie,
+        ...cookieWithoutPartitionKey,
         expires: effectiveExpirationDate,
         samesite: cookie.sameSite?.toLowerCase() ?? '',
         domain,
-        partitionKey:
-          cookie?.partitionKey && typeof cookie?.partitionKey === 'string'
-            ? cookie?.partitionKey
-            : //@ts-ignore This is to handle both stable and canary version of Chrome.
-              cookie?.partitionKey?.topLevelSite,
+        partitionKey: '',
       },
       networkEvents: {
         requestEvents: [
@@ -100,6 +98,15 @@ export default function parseRequestWillBeSentExtraInfo(
           : undefined,
     };
 
+    if (partitionKey) {
+      if (typeof partitionKey === 'string') {
+        singleCookie.parsedCookie.partitionKey = partitionKey as string;
+      } else {
+        singleCookie.parsedCookie.partitionKey =
+          partitionKey?.topLevelSite as string;
+      }
+    }
+
     //Sometimes frameId comes empty so it shows data in other frames where cookie should not be shown.
     if (frameIds.length > 0) {
       singleCookie.frameIdList = [...frameIds];

diff --git a/packages/common/src/utils/parseResponseReceivedExtraInfo.ts b/packages/common/src/utils/parseResponseReceivedExtraInfo.ts
@@ -16,7 +16,7 @@
 /**
  * External dependencies.
  */
-import { parse } from 'simple-cookie';
+import { parse, type Cookie } from 'simple-cookie';
 import type { Protocol } from 'devtools-protocol';
 
 /**
@@ -59,7 +59,7 @@ export default function parseResponseReceivedExtraInfo(
   const responseToParse = headers['set-cookie'] ?? headers['Set-Cookie'];
 
   responseToParse?.split('\n').forEach((headerLine: string) => {
-    let parsedCookie: CookieData['parsedCookie'] = parse(headerLine);
+    const parsedCookie: Cookie = parse(headerLine);
 
     const blockedCookie = blockedCookies.find((c) => {
       if (c.cookie) {
@@ -81,17 +81,6 @@ export default function parseResponseReceivedExtraInfo(
       parsedCookie.expires
     );
 
-    if (headerLine.toLowerCase().includes('partitioned')) {
-      parsedCookie = {
-        ...parsedCookie,
-        partitionKey:
-          cookiePartitionKey && typeof cookiePartitionKey === 'string'
-            ? cookiePartitionKey
-            : //@ts-ignore This is to handle both stable and canary version of Chrome.
-              cookiePartitionKey?.topLevelSite,
-      };
-    }
-
     let domain;
 
     if (parsedCookie?.domain) {
@@ -108,6 +97,7 @@ export default function parseResponseReceivedExtraInfo(
         expires: effectiveExpirationDate,
         samesite: parsedCookie.samesite ?? '',
         domain,
+        partitionKey: '',
       },
       networkEvents: {
         requestEvents: [],
@@ -135,6 +125,15 @@ export default function parseResponseReceivedExtraInfo(
           : undefined,
     };
 
+    if (headerLine.toLowerCase().includes('partitioned')) {
+      if (typeof cookiePartitionKey === 'string') {
+        singleCookie.parsedCookie.partitionKey = cookiePartitionKey as string;
+      } else {
+        singleCookie.parsedCookie.partitionKey =
+          cookiePartitionKey?.topLevelSite as string;
+      }
+    }
+
     //Sometimes frameId comes empty so it shows data in other frames where cookie should not be shown.
     if (frameIds.length > 0) {
       singleCookie.frameIdList = [...frameIds];

diff --git a/packages/design-system/src/test-data/cookieMockData.ts b/packages/design-system/src/test-data/cookieMockData.ts
@@ -16,8 +16,7 @@
 /**
  * External dependencies.
  */
-import { type Cookie as ParsedCookie } from 'simple-cookie';
-import { TabCookies, TabFrames } from '@google-psat/common';
+import { CookieData, TabCookies, TabFrames } from '@google-psat/common';
 
 export const emptyAnalytics = {
   platform: '',
@@ -40,37 +39,38 @@ const emptyCookie = {
   httponly: false,
   path: '',
   expires: '',
+  partitionKey: '',
 };
 
-export const uncategorized1pCookie: ParsedCookie = {
+export const uncategorized1pCookie: CookieData['parsedCookie'] = {
   ...emptyCookie,
   name: '_cb',
   value: 'v1%3A168740954476563235',
   domain: '.cnn.com',
 };
 
-export const uncategorized3pCookie: ParsedCookie = {
+export const uncategorized3pCookie: CookieData['parsedCookie'] = {
   ...emptyCookie,
   name: 'pubsyncexp',
   value: 'uncategorized3pCookie',
   domain: '.ads.pubmatic.com',
 };
 
-export const known1pCookie: ParsedCookie = {
+export const known1pCookie: CookieData['parsedCookie'] = {
   ...emptyCookie,
   name: '__qca',
   value: 'known1pCookie',
   domain: '.cnn.com',
 };
 
-export const known3pCookie: ParsedCookie = {
+export const known3pCookie: CookieData['parsedCookie'] = {
   ...emptyCookie,
   name: 'KRTBCOOKIE_290',
   value: 'known3pCookie',
   domain: '.pubmatic.com',
 };
 
-export const known3pCookieWithValue: ParsedCookie = {
+export const known3pCookieWithValue: CookieData['parsedCookie'] = {
   ...emptyCookie,
   name: 'KRTBCOOKIE_290',
   value: 'known3p_Cookie-with%20value',

diff --git a/packages/extension/src/store/synchnorousCookieStore.ts b/packages/extension/src/store/synchnorousCookieStore.ts
@@ -632,14 +632,23 @@ class SynchnorousCookieStore {
           const parsedCookie = {
             ...this.tabsData[tabId][cookieKey].parsedCookie,
             ...cookie.parsedCookie,
+            httponly:
+              cookie.parsedCookie.httponly ??
+              this.tabsData[tabId][cookieKey].parsedCookie.httponly,
             priority:
               cookie.parsedCookie?.priority ??
               this.tabsData[tabId][cookieKey].parsedCookie?.priority ??
               'Medium',
-            partitionKey:
-              cookie.parsedCookie?.partitionKey ??
-              this.tabsData[tabId][cookieKey].parsedCookie?.partitionKey,
+            partitionKey: '',
           };
+          if (
+            cookie.parsedCookie?.partitionKey ||
+            this.tabsData[tabId][cookieKey].parsedCookie?.partitionKey
+          ) {
+            parsedCookie.partitionKey =
+              cookie.parsedCookie?.partitionKey ||
+              this.tabsData[tabId][cookieKey].parsedCookie?.partitionKey;
+          }
 
           const networkEvents: CookieData['networkEvents'] = {
             requestEvents: [

diff --git a/packages/extension/src/utils/parseNetworkCookies.ts b/packages/extension/src/utils/parseNetworkCookies.ts
@@ -45,18 +45,18 @@ export default function parseNetworkCookies(
     const effectiveExpirationDate = calculateEffectiveExpiryDate(
       cookie.expires
     );
+
+    const { partitionKey, ...cookieWithoutPartitionKey } = cookie;
+
     const singleCookie: CookieData = {
       isBlocked: false,
       blockedReasons: [],
       parsedCookie: {
-        ...cookie,
+        ...cookieWithoutPartitionKey,
+        httponly: cookie?.httpOnly ?? false,
         expires: effectiveExpirationDate,
         samesite: cookie.sameSite ?? '',
-        partitionKey:
-          cookie?.partitionKey && typeof cookie?.partitionKey === 'string'
-            ? cookie?.partitionKey
-            : //@ts-ignore This is to handle both stable and canary version of Chrome.
-              cookie?.partitionKey?.topLevelSite,
+        partitionKey: '',
       },
       networkEvents: {
         requestEvents: [],
@@ -69,6 +69,15 @@ export default function parseNetworkCookies(
       frameIdList: [frameId],
     };
 
+    if (partitionKey) {
+      if (typeof partitionKey === 'string') {
+        singleCookie.parsedCookie.partitionKey = partitionKey as string;
+      } else {
+        singleCookie.parsedCookie.partitionKey =
+          partitionKey?.topLevelSite as string;
+      }
+    }
+
     parsedCookies.push(singleCookie);
   });
 

diff --git a/packages/report/src/dashboard/components/utils/tests/data.mock.ts b/packages/report/src/dashboard/components/utils/tests/data.mock.ts
@@ -35,6 +35,7 @@ export const tempSinglePageData: CompleteJson = {
             expires: 'Session',
             httpOnly: false,
             secure: true,
+            partitionKey: '',
           },
           analytics: {
             platform: 'Unknown',
@@ -106,6 +107,7 @@ export const tempMultiPageData: CompleteJson[] = [
               expires: 'Session',
               httpOnly: false,
               secure: true,
+              partitionKey: '',
             },
             analytics: {
               platform: 'Unknown',
@@ -157,6 +159,7 @@ export const tempMultiPageData: CompleteJson[] = [
               expires: 'Session',
               httpOnly: false,
               secure: true,
+              partitionKey: '',
             },
             analytics: {
               platform: 'Unknown',

diff --git a/packages/report/src/dashboard/components/utils/tests/reshapeCookies.ts b/packages/report/src/dashboard/components/utils/tests/reshapeCookies.ts
@@ -37,6 +37,7 @@ describe('reshapeCookies', () => {
             expires: 'Session',
             httpOnly: false,
             secure: true,
+            partitionKey: '',
           },
           analytics: {
             platform: 'Unknown',