fix: Update phishingSafelistStream to send origin as a parameter for safelistPhishingDomain

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Changed
+- **BREAKING**: Update `phishingSafelistStream` to send `origin` instead of `hostname` as a parameter for `safelistPhishingDomain` method ([#165](https://github.com/MetaMask/phishing-warning/pull/165))
 
 ## [3.0.4]
 ### Changed

src/index.ts

@@ -145,20 +145,20 @@ async function isBlockedByMetamask(href: string) {
  * @param href - The href value to check.
  */
 function getSuspect(href = ''): {
-  suspectHostname: string;
   suspectHostnameUnicode: string;
   suspectHref: string;
   suspectHrefUnicode: string;
+  suspectOrigin: string;
 } {
   try {
     const url = new URL(href);
     const unicodeHostname = toUnicode(url.hostname);
     const unicodeHref = `${url.protocol}//${unicodeHostname}${url.pathname}${url.search}${url.hash}`;
     return {
-      suspectHostname: url.hostname,
       suspectHostnameUnicode: unicodeHostname,
       suspectHref: url.href,
       suspectHrefUnicode: unicodeHref,
+      suspectOrigin: url.origin,
     };
   } catch (error) {
     throw new Error(`Invalid 'href' query parameter`);
@@ -200,10 +200,10 @@ function start() {
   const hashQueryString = new URLSearchParams(hashContents);
 
   const {
-    suspectHostname,
     suspectHref,
     suspectHostnameUnicode,
     suspectHrefUnicode,
+    suspectOrigin,
   } = getSuspect(hashQueryString.get('href'));
 
   const suspectLink = document.getElementById('suspect-link');
@@ -242,7 +242,7 @@ function start() {
     phishingSafelistStream.write({
       jsonrpc: '2.0',
       method: 'safelistPhishingDomain',
-      params: [suspectHostname],
+      params: [suspectOrigin],
       id: createRandomId(),
     });
 

tests/bypass.spec.ts

@@ -6,7 +6,7 @@ test.beforeEach(async ({ context }) => {
   await setupDefaultMocks(context);
 });
 
-test('allows the user to bypass the warning and add the site to the allowlist', async ({
+test('allows the user to bypass the warning and add the site origin to the allowlist', async ({
   page,
 }) => {
   const postMessageLogs = await setupStreamInitialization(page);
@@ -24,7 +24,7 @@ test('allows the user to bypass the warning and add the site to the allowlist',
       id: expect.any(Number),
       jsonrpc: '2.0',
       method: 'safelistPhishingDomain',
-      params: ['test.com'],
+      params: ['https://test.com'],
     },
     name: 'metamask-phishing-safelist',
   });