url [nfc]: Use isUrlOnRealm where the logic calls for it

Instead of repeating its implementation everywhere.

Author: chrisbobbe

src/notification/notifOpen.js

@@ -11,7 +11,7 @@ import type { Account, GlobalThunkAction, Narrow, Stream, UserId, UserOrBot } fr
 import { topicNarrow, pm1to1NarrowFromUser, pmNarrowFromRecipients } from '../utils/narrow';
 import * as logging from '../utils/logging';
 import { fromPushNotificationIOS } from './extract';
-import { tryParseUrl } from '../utils/url';
+import { isUrlOnRealm, tryParseUrl } from '../utils/url';
 import { pmKeyRecipientsFromIds } from '../utils/recipient';
 import { makeUserId } from '../api/idTypes';
 import { getStreamsByName } from '../selectors';
@@ -49,7 +49,7 @@ export const getAccountFromNotificationData = (
 
   const urlMatches = [];
   accounts.forEach((account, i) => {
-    if (account.realm.origin === realmUrl.origin) {
+    if (isUrlOnRealm(account.realm, realmUrl)) {
       urlMatches.push(i);
     }
   });

src/sentry.js

@@ -10,6 +10,7 @@ import isAppOwnDomain from './isAppOwnDomain';
 import store from './boot/store';
 import { getAccountStatuses } from './account/accountsSelectors';
 import { sentryKey } from './sentryConfig';
+import { isUrlOnRealm } from './utils/url';
 
 export const isSentryActive = (): boolean => {
   // Hub#getClient() is documented as possibly returning undefined, but the
@@ -81,7 +82,7 @@ function shouldScrubHost(url: URL, accountStatuses: $ReadOnlyArray<AccountStatus
     return true;
   }
 
-  if (accountStatuses.some(({ realm }) => url.origin === realm.origin)) {
+  if (accountStatuses.some(({ realm }) => isUrlOnRealm(url, realm))) {
     // Definitely a request to a Zulip realm. Will catch requests to realms
     // in the account-statuses state, including those without `/api/v1`,
     // like `/avatar/{user_id}` (zulip/zulip@0f9970fd3 confirms that this

src/start/webAuth.js

@@ -4,7 +4,7 @@ import * as WebBrowser from 'expo-web-browser';
 
 import type { Auth } from '../types';
 import { openLinkEmbedded } from '../utils/openLink';
-import { tryParseUrl } from '../utils/url';
+import { isUrlOnRealm, tryParseUrl } from '../utils/url';
 import { base64ToHex, hexToAscii, xorHexStrings } from '../utils/encoding';
 
 /*
@@ -78,7 +78,7 @@ export const authFromCallbackUrl = (callbackUrl: string, otp: string, realm: URL
     return null;
   }
   const callbackRealm = tryParseUrl(callbackRealmStr);
-  if (!callbackRealm || callbackRealm.origin !== realm.origin) {
+  if (!callbackRealm || !isUrlOnRealm(callbackRealm, realm)) {
     return null;
   }
 

src/utils/internalLinks.js

@@ -6,6 +6,7 @@ import type { Narrow, Stream, UserId } from '../types';
 import { topicNarrow, streamNarrow, specialNarrow, pmNarrowFromRecipients } from './narrow';
 import { pmKeyRecipientsFromIds } from './recipient';
 import { ensureUnreachable } from '../generics';
+import { isUrlOnRealm } from './url';
 
 /**
  * For narrow URL https://zulip.example/#narrow/foo/bar, split the part of
@@ -54,7 +55,7 @@ const getHashSegmentsFromNarrowLink = (url: string, realm: URL) => {
 export const isNarrowLink = (url: string, realm: URL): boolean => {
   const resolved = new URL(url, realm);
   return (
-    resolved.origin === realm.origin
+    isUrlOnRealm(resolved, realm)
     && resolved.pathname === '/'
     && resolved.search === ''
     && /^#narrow\//i.test(resolved.hash)

src/utils/url.js

@@ -92,6 +92,8 @@ export const tryParseUrl = (url: string, base?: string | URL): URL | void => {
 /**
  * Test if the given URL is within the given realm.
  */
+// This is used in and out of the WebView, so it must work with the native
+// URL implementation and also the polyfill we use in React Native land.
 export const isUrlOnRealm = (url: URL, realm: URL): boolean => url.origin === realm.origin;
 
 export const getFileExtension = (filename: string): string => filename.split('.').pop();

src/webview/js/generatedEs3.js

@@ -170,6 +170,8 @@ var compiledWebviewJs = (function (exports) {
     }
   }
 
+  const isUrlOnRealm = (url, realm) => url.origin === realm.origin;
+
   const inlineApiRoutes = ['^/user_uploads/', '^/thumbnail$', '^/avatar/'].map(r => new RegExp(r));
 
   const rewriteImageUrls = (auth, element) => {
@@ -191,7 +193,7 @@ var compiledWebviewJs = (function (exports) {
         return;
       }
 
-      if (fixedSrc.origin === realm.origin) {
+      if (isUrlOnRealm(fixedSrc, realm)) {
         if (inlineApiRoutes.some(regexp => regexp.test(fixedSrc.pathname))) {
           const delimiter = fixedSrc.search ? '&' : '';
           fixedSrc.search += "".concat(delimiter, "api_key=").concat(auth.apiKey);

src/webview/js/rewriteHtml.js

@@ -2,6 +2,8 @@
 
 import type { Auth } from '../../types';
 
+import { isUrlOnRealm } from '../../utils/url';
+
 /** List of routes which accept the API key appended as a GET parameter. */
 const inlineApiRoutes: $ReadOnlyArray<RegExp> = [
   '^/user_uploads/',
@@ -49,7 +51,7 @@ const rewriteImageUrls = (auth: Auth, element: Element | Document) => {
     }
 
     // 2: Inject the API key where needed.
-    if (fixedSrc.origin === realm.origin) {
+    if (isUrlOnRealm(fixedSrc, realm)) {
       if (inlineApiRoutes.some(regexp => regexp.test(fixedSrc.pathname))) {
         // Ideally we'd just use `searchParams`, but that was new in Chrome 51
         // (and Safari 10).