@exodus/react-native-webview 11.26.1-exodus.9 → 13.16.0-exodus.1

package/src/WebView.android.tsx

@@ -0,0 +1,345 @@
+import React, {
+  forwardRef,
+  ReactElement,
+  useCallback,
+  useEffect,
+  useImperativeHandle,
+  useRef,
+} from 'react';
+
+import { Image, View, ImageSourcePropType, HostComponent } from 'react-native';
+
+import BatchedBridge from 'react-native/Libraries/BatchedBridge/BatchedBridge';
+import EventEmitter from 'react-native/Libraries/vendor/emitter/EventEmitter';
+
+import invariant from 'invariant';
+
+import RNCWebView, { Commands, NativeProps } from './RNCWebViewNativeComponent';
+import RNCWebViewModule from './NativeRNCWebViewModule';
+import {
+  defaultOriginWhitelist,
+  defaultDeeplinkWhitelist,
+  defaultRenderError,
+  defaultRenderLoading,
+  useWebViewLogic,
+} from './WebViewShared';
+import {
+  AndroidWebViewProps,
+  WebViewSourceUri,
+  type WebViewMessageEvent,
+  type ShouldStartLoadRequestEvent,
+} from './WebViewTypes';
+
+import styles from './WebView.styles';
+
+const { resolveAssetSource } = Image;
+
+const directEventEmitter = new EventEmitter();
+
+const registerCallableModule: (name: string, module: Object) => void =
+  // `registerCallableModule()` is available in React Native 0.74 and above.
+  // Fallback to use `BatchedBridge.registerCallableModule()` for older versions.
+
+  require('react-native').registerCallableModule ??
+  BatchedBridge.registerCallableModule.bind(BatchedBridge);
+
+registerCallableModule('RNCWebViewMessagingModule', {
+  onShouldStartLoadWithRequest: (
+    event: ShouldStartLoadRequestEvent & { messagingModuleName?: string }
+  ) => {
+    directEventEmitter.emit('onShouldStartLoadWithRequest', event);
+  },
+  onMessage: (
+    event: WebViewMessageEvent & { messagingModuleName?: string }
+  ) => {
+    directEventEmitter.emit('onMessage', event);
+  },
+});
+
+/**
+ * A simple counter to uniquely identify WebView instances. Do not use this for anything else.
+ */
+let uniqueRef = 0;
+
+const WebViewComponent = forwardRef<{}, AndroidWebViewProps>(
+  (
+    {
+      overScrollMode = 'always',
+      javaScriptEnabled = true,
+      thirdPartyCookiesEnabled = true,
+      scalesPageToFit = true,
+      allowsFullscreenVideo = false,
+      allowFileAccess = false,
+      saveFormDataDisabled = false,
+      cacheEnabled = true,
+      androidLayerType = 'none',
+      originWhitelist = defaultOriginWhitelist,
+      deeplinkWhitelist = defaultDeeplinkWhitelist,
+      setSupportMultipleWindows = true,
+      setBuiltInZoomControls = true,
+      setDisplayZoomControls = false,
+      nestedScrollEnabled = false,
+      startInLoadingState,
+      onNavigationStateChange,
+      onLoadStart,
+      onError,
+      onLoad,
+      onLoadEnd,
+      onLoadSubResourceError,
+      onLoadProgress,
+      onHttpError: onHttpErrorProp,
+      onRenderProcessGone: onRenderProcessGoneProp,
+      onMessage: onMessageProp,
+      onOpenWindow: onOpenWindowProp,
+      renderLoading,
+      renderError,
+      style,
+      containerStyle,
+      source,
+      nativeConfig,
+      onShouldStartLoadWithRequest: onShouldStartLoadWithRequestProp,
+      injectedJavaScriptObject,
+      validateMeta,
+      validateData,
+      ...otherProps
+    },
+    ref
+  ) => {
+    const messagingModuleName = useRef<string>(
+      `WebViewMessageHandler${(uniqueRef += 1)}`
+    ).current;
+    const webViewRef = useRef<React.ComponentRef<
+      HostComponent<NativeProps>
+    > | null>(null);
+
+    const onShouldStartLoadWithRequestCallback = useCallback(
+      (shouldStart: boolean, url: string, lockIdentifier?: number) => {
+        if (lockIdentifier) {
+          RNCWebViewModule.shouldStartLoadWithLockIdentifier(
+            shouldStart,
+            lockIdentifier
+          );
+        } else if (shouldStart && webViewRef.current) {
+          Commands.loadUrl(webViewRef.current, url);
+        }
+      },
+      []
+    );
+
+    const {
+      onLoadingStart,
+      onShouldStartLoadWithRequest,
+      onMessage,
+      viewState,
+      setViewState,
+      lastErrorEvent,
+      onHttpError,
+      onLoadingError,
+      onLoadingSubResourceError,
+      onLoadingFinish,
+      onLoadingProgress,
+      onOpenWindow,
+      onRenderProcessGone,
+    } = useWebViewLogic({
+      onNavigationStateChange,
+      onLoad,
+      onError,
+      onHttpErrorProp,
+      onLoadSubResourceError,
+      onLoadEnd,
+      onLoadProgress,
+      onLoadStart,
+      onRenderProcessGoneProp,
+      onMessageProp,
+      onOpenWindowProp,
+      startInLoadingState,
+      originWhitelist,
+      deeplinkWhitelist,
+      onShouldStartLoadWithRequestProp,
+      onShouldStartLoadWithRequestCallback,
+      validateMeta,
+      validateData,
+    });
+
+    useImperativeHandle(
+      ref,
+      () => ({
+        goForward: () =>
+          webViewRef.current && Commands.goForward(webViewRef.current),
+        goBack: () => webViewRef.current && Commands.goBack(webViewRef.current),
+        reload: () => {
+          setViewState('LOADING');
+          if (webViewRef.current) {
+            Commands.reload(webViewRef.current);
+          }
+        },
+        stopLoading: () =>
+          webViewRef.current && Commands.stopLoading(webViewRef.current),
+        postMessage: (data: string) =>
+          webViewRef.current && Commands.postMessage(webViewRef.current, data),
+        injectJavaScript: (data: string) =>
+          webViewRef.current &&
+          Commands.injectJavaScript(webViewRef.current, data),
+        requestFocus: () =>
+          webViewRef.current && Commands.requestFocus(webViewRef.current),
+        clearFormData: () =>
+          webViewRef.current && Commands.clearFormData(webViewRef.current),
+        clearCache: (includeDiskFiles: boolean) =>
+          webViewRef.current &&
+          Commands.clearCache(webViewRef.current, includeDiskFiles),
+        clearHistory: () =>
+          webViewRef.current && Commands.clearHistory(webViewRef.current),
+      }),
+      [setViewState, webViewRef]
+    );
+
+    useEffect(() => {
+      const onShouldStartLoadWithRequestSubscription =
+        directEventEmitter.addListener(
+          'onShouldStartLoadWithRequest',
+          (
+            event: ShouldStartLoadRequestEvent & {
+              messagingModuleName?: string;
+            }
+          ) => {
+            if (event.messagingModuleName === messagingModuleName) {
+              // eslint-disable-next-line @typescript-eslint/no-unused-vars
+              const { messagingModuleName: _, ...rest } = event;
+              onShouldStartLoadWithRequest(rest);
+            }
+          }
+        );
+
+      const onMessageSubscription = directEventEmitter.addListener(
+        'onMessage',
+        (event: WebViewMessageEvent & { messagingModuleName?: string }) => {
+          if (event.messagingModuleName === messagingModuleName) {
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            const { messagingModuleName: _, ...rest } = event;
+            onMessage(rest);
+          }
+        }
+      );
+
+      return () => {
+        onShouldStartLoadWithRequestSubscription.remove();
+        onMessageSubscription.remove();
+      };
+    }, [messagingModuleName, onMessage, onShouldStartLoadWithRequest]);
+
+    let otherView: ReactElement | undefined;
+    if (viewState === 'LOADING') {
+      otherView = (renderLoading || defaultRenderLoading)();
+    } else if (viewState === 'ERROR') {
+      invariant(
+        lastErrorEvent != null,
+        'lastErrorEvent expected to be non-null'
+      );
+      if (lastErrorEvent) {
+        otherView = (renderError || defaultRenderError)(
+          lastErrorEvent.domain,
+          lastErrorEvent.code,
+          lastErrorEvent.description
+        );
+      }
+    } else if (viewState !== 'IDLE') {
+      console.error(`RNCWebView invalid state encountered: ${viewState}`);
+    }
+
+    const webViewStyles = [styles.container, styles.webView, style];
+    const webViewContainerStyle = [styles.container, containerStyle];
+
+    if (typeof source !== 'number' && source && 'method' in source) {
+      if (source.method === 'POST' && source.headers) {
+        console.warn(
+          'WebView: `source.headers` is not supported when using POST.'
+        );
+      } else if (source.method === 'GET' && source.body) {
+        console.warn('WebView: `source.body` is not supported when using GET.');
+      }
+    }
+
+    const NativeWebView =
+      (nativeConfig?.component as typeof RNCWebView | undefined) || RNCWebView;
+
+    const sourceResolved = resolveAssetSource(source as ImageSourcePropType);
+    const newSource =
+      typeof sourceResolved === 'object'
+        ? Object.entries(sourceResolved as WebViewSourceUri).reduce(
+            (prev, [currKey, currValue]) => {
+              return {
+                ...prev,
+                [currKey]:
+                  currKey === 'headers' &&
+                  currValue &&
+                  typeof currValue === 'object'
+                    ? Object.entries(currValue).map(([key, value]) => {
+                        return {
+                          name: key,
+                          value,
+                        };
+                      })
+                    : currValue,
+              };
+            },
+            {}
+          )
+        : sourceResolved;
+
+    const webView = (
+      <NativeWebView
+        key="webViewKey"
+        {...otherProps}
+        messagingEnabled={typeof onMessageProp === 'function'}
+        messagingModuleName={messagingModuleName}
+        hasOnScroll={!!otherProps.onScroll}
+        onLoadingError={onLoadingError}
+        onLoadingSubResourceError={onLoadingSubResourceError}
+        onLoadingFinish={onLoadingFinish}
+        onLoadingProgress={onLoadingProgress}
+        onLoadingStart={onLoadingStart}
+        onHttpError={onHttpError}
+        onRenderProcessGone={onRenderProcessGone}
+        onMessage={onMessage}
+        onOpenWindow={onOpenWindow}
+        hasOnOpenWindowEvent={onOpenWindowProp !== undefined}
+        onShouldStartLoadWithRequest={onShouldStartLoadWithRequest}
+        ref={webViewRef}
+        // TODO: find a better way to type this.
+        // @ts-expect-error source is old arch
+        source={sourceResolved}
+        newSource={newSource}
+        style={webViewStyles}
+        overScrollMode={overScrollMode}
+        javaScriptEnabled={javaScriptEnabled}
+        thirdPartyCookiesEnabled={thirdPartyCookiesEnabled}
+        scalesPageToFit={scalesPageToFit}
+        allowsFullscreenVideo={allowsFullscreenVideo}
+        allowFileAccess={allowFileAccess}
+        saveFormDataDisabled={saveFormDataDisabled}
+        cacheEnabled={cacheEnabled}
+        androidLayerType={androidLayerType}
+        setSupportMultipleWindows={setSupportMultipleWindows}
+        setBuiltInZoomControls={setBuiltInZoomControls}
+        setDisplayZoomControls={setDisplayZoomControls}
+        nestedScrollEnabled={nestedScrollEnabled}
+        injectedJavaScriptObject={JSON.stringify(injectedJavaScriptObject)}
+        {...nativeConfig?.props}
+      />
+    );
+
+    return (
+      <View style={webViewContainerStyle}>
+        {webView}
+        {otherView}
+      </View>
+    );
+  }
+);
+
+// native implementation should return "true" only for Android 5+
+const { isFileUploadSupported } = RNCWebViewModule;
+
+const WebView = Object.assign(WebViewComponent, { isFileUploadSupported });
+
+export default WebView;

package/src/WebView.ios.tsx

@@ -0,0 +1,341 @@
+import React, {
+  forwardRef,
+  useCallback,
+  useImperativeHandle,
+  useRef,
+} from 'react';
+import {
+  Image,
+  View,
+  Text,
+  Platform,
+  ImageSourcePropType,
+  HostComponent,
+} from 'react-native';
+import invariant from 'invariant';
+
+import RNCWebView, { Commands, NativeProps } from './RNCWebViewNativeComponent';
+import RNCWebViewModule from './NativeRNCWebViewModule';
+
+import {
+  defaultOriginWhitelist,
+  defaultDeeplinkWhitelist,
+  defaultRenderError,
+  defaultRenderLoading,
+  useWebViewLogic,
+  versionPasses,
+} from './WebViewShared';
+import {
+  IOSWebViewProps,
+  DecelerationRateConstant,
+  WebViewSourceUri,
+} from './WebViewTypes';
+
+import styles from './WebView.styles';
+
+const { resolveAssetSource } = Image;
+const processDecelerationRate = (
+  decelerationRate: DecelerationRateConstant | number | undefined
+) => {
+  let newDecelerationRate = decelerationRate;
+  if (newDecelerationRate === 'normal') {
+    newDecelerationRate = 0.998;
+  } else if (newDecelerationRate === 'fast') {
+    newDecelerationRate = 0.99;
+  }
+  return newDecelerationRate;
+};
+
+// Exodus: Hardcoded minimum iOS versions for security
+// Format: "minVersion <maxVersion, ..." means minVersion <= iOS < maxVersion
+// Last entry has no upper bound
+const hardMinimumIOSVersion = '12.5.6 <13, 13.6.1 <14, 14.8.1 <15, 15.7.1';
+
+const useWarnIfChanges = <T extends unknown>(value: T, name: string) => {
+  const ref = useRef(value);
+  if (ref.current !== value) {
+    console.warn(
+      `Changes to property ${name} do nothing after the initial render.`
+    );
+    ref.current = value;
+  }
+};
+
+const WebViewComponent = forwardRef<{}, IOSWebViewProps>(
+  (
+    {
+      fraudulentWebsiteWarningEnabled = true,
+      javaScriptEnabled = true,
+      cacheEnabled = true,
+      originWhitelist = defaultOriginWhitelist,
+      deeplinkWhitelist = defaultDeeplinkWhitelist,
+      useSharedProcessPool = true,
+      textInteractionEnabled = true,
+      injectedJavaScript,
+      injectedJavaScriptBeforeContentLoaded,
+      injectedJavaScriptForMainFrameOnly = true,
+      injectedJavaScriptBeforeContentLoadedForMainFrameOnly = true,
+      injectedJavaScriptObject,
+      startInLoadingState,
+      onNavigationStateChange,
+      onLoadStart,
+      onError,
+      onLoad,
+      onLoadEnd,
+      onLoadProgress,
+      onContentProcessDidTerminate: onContentProcessDidTerminateProp,
+      onFileDownload,
+      onHttpError: onHttpErrorProp,
+      onMessage: onMessageProp,
+      onOpenWindow: onOpenWindowProp,
+      renderLoading,
+      renderError,
+      style,
+      containerStyle,
+      source,
+      nativeConfig,
+      allowsInlineMediaPlayback,
+      allowsPictureInPictureMediaPlayback = true,
+      allowsAirPlayForMediaPlayback,
+      mediaPlaybackRequiresUserAction,
+      dataDetectorTypes,
+      incognito,
+      decelerationRate: decelerationRateProp,
+      onShouldStartLoadWithRequest: onShouldStartLoadWithRequestProp,
+      validateMeta,
+      validateData,
+      minimumIOSVersion,
+      unsupportedVersionComponent: UnsupportedVersionComponent,
+      ...otherProps
+    },
+    ref
+  ) => {
+    const webViewRef = useRef<React.ComponentRef<
+      HostComponent<NativeProps>
+    > | null>(null);
+
+    const onShouldStartLoadWithRequestCallback = useCallback(
+      (shouldStart: boolean, _url: string, lockIdentifier = 0) => {
+        RNCWebViewModule.shouldStartLoadWithLockIdentifier(
+          shouldStart,
+          lockIdentifier
+        );
+      },
+      []
+    );
+
+    const {
+      onLoadingStart,
+      onShouldStartLoadWithRequest,
+      onMessage,
+      viewState,
+      setViewState,
+      lastErrorEvent,
+      onHttpError,
+      onLoadingError,
+      onLoadingFinish,
+      onLoadingProgress,
+      onOpenWindow,
+      onContentProcessDidTerminate,
+    } = useWebViewLogic({
+      onNavigationStateChange,
+      onLoad,
+      onError,
+      onHttpErrorProp,
+      onLoadEnd,
+      onLoadProgress,
+      onLoadStart,
+      onMessageProp,
+      onOpenWindowProp,
+      startInLoadingState,
+      originWhitelist,
+      deeplinkWhitelist,
+      onShouldStartLoadWithRequestProp,
+      onShouldStartLoadWithRequestCallback,
+      onContentProcessDidTerminateProp,
+      validateMeta,
+      validateData,
+    });
+
+    useImperativeHandle(
+      ref,
+      () => ({
+        goForward: () =>
+          webViewRef.current && Commands.goForward(webViewRef.current),
+        goBack: () => webViewRef.current && Commands.goBack(webViewRef.current),
+        reload: () => {
+          setViewState('LOADING');
+          if (webViewRef.current) {
+            Commands.reload(webViewRef.current);
+          }
+        },
+        stopLoading: () =>
+          webViewRef.current && Commands.stopLoading(webViewRef.current),
+        postMessage: (data: string) =>
+          webViewRef.current && Commands.postMessage(webViewRef.current, data),
+        injectJavaScript: (data: string) =>
+          webViewRef.current &&
+          Commands.injectJavaScript(webViewRef.current, data),
+        requestFocus: () =>
+          webViewRef.current && Commands.requestFocus(webViewRef.current),
+        clearCache: (includeDiskFiles: boolean) =>
+          webViewRef.current &&
+          Commands.clearCache(webViewRef.current, includeDiskFiles),
+      }),
+      [setViewState, webViewRef]
+    );
+
+    useWarnIfChanges(allowsInlineMediaPlayback, 'allowsInlineMediaPlayback');
+    useWarnIfChanges(
+      allowsPictureInPictureMediaPlayback,
+      'allowsPictureInPictureMediaPlayback'
+    );
+    useWarnIfChanges(
+      allowsAirPlayForMediaPlayback,
+      'allowsAirPlayForMediaPlayback'
+    );
+    useWarnIfChanges(incognito, 'incognito');
+    useWarnIfChanges(
+      mediaPlaybackRequiresUserAction,
+      'mediaPlaybackRequiresUserAction'
+    );
+    useWarnIfChanges(dataDetectorTypes, 'dataDetectorTypes');
+
+    // Exodus: Check iOS version against minimum requirements
+    const iosVersion = String(Platform.Version);
+    const passesMinimum = minimumIOSVersion
+      ? versionPasses(iosVersion, minimumIOSVersion)
+      : true;
+    const passesHardMinimum = versionPasses(iosVersion, hardMinimumIOSVersion);
+
+    if (!passesMinimum || !passesHardMinimum) {
+      if (UnsupportedVersionComponent) {
+        return <UnsupportedVersionComponent />;
+      }
+      return (
+        <View style={{ alignSelf: 'flex-start' }}>
+          <Text style={{ color: 'red' }}>
+            iOS version is outdated and insecure. Update it to continue.
+          </Text>
+        </View>
+      );
+    }
+
+    let otherView = null;
+    if (viewState === 'LOADING') {
+      otherView = (renderLoading || defaultRenderLoading)();
+    } else if (viewState === 'ERROR') {
+      invariant(
+        lastErrorEvent != null,
+        'lastErrorEvent expected to be non-null'
+      );
+      otherView = (renderError || defaultRenderError)(
+        lastErrorEvent?.domain,
+        lastErrorEvent?.code ?? 0,
+        lastErrorEvent?.description ?? ''
+      );
+    } else if (viewState !== 'IDLE') {
+      console.error(`RNCWebView invalid state encountered: ${viewState}`);
+    }
+
+    const webViewStyles = [styles.container, styles.webView, style];
+    const webViewContainerStyle = [styles.container, containerStyle];
+
+    const decelerationRate = processDecelerationRate(decelerationRateProp);
+
+    const NativeWebView =
+      (nativeConfig?.component as typeof RNCWebView | undefined) || RNCWebView;
+
+    const sourceResolved = resolveAssetSource(source as ImageSourcePropType);
+    const newSource =
+      typeof sourceResolved === 'object'
+        ? Object.entries(sourceResolved as WebViewSourceUri).reduce(
+            (prev, [currKey, currValue]) => {
+              return {
+                ...prev,
+                [currKey]:
+                  currKey === 'headers' &&
+                  currValue &&
+                  typeof currValue === 'object'
+                    ? Object.entries(currValue).map(([key, value]) => {
+                        return {
+                          name: key,
+                          value,
+                        };
+                      })
+                    : currValue,
+              };
+            },
+            {}
+          )
+        : sourceResolved;
+
+    const webView = (
+      <NativeWebView
+        key="webViewKey"
+        {...otherProps}
+        fraudulentWebsiteWarningEnabled={fraudulentWebsiteWarningEnabled}
+        javaScriptEnabled={javaScriptEnabled}
+        cacheEnabled={cacheEnabled}
+        useSharedProcessPool={useSharedProcessPool}
+        textInteractionEnabled={textInteractionEnabled}
+        decelerationRate={decelerationRate}
+        messagingEnabled={typeof onMessageProp === 'function'}
+        messagingModuleName="" // android ONLY
+        onLoadingError={onLoadingError}
+        onLoadingFinish={onLoadingFinish}
+        onLoadingProgress={onLoadingProgress}
+        onFileDownload={onFileDownload}
+        onLoadingStart={onLoadingStart}
+        onHttpError={onHttpError}
+        onMessage={onMessage}
+        onOpenWindow={onOpenWindowProp && onOpenWindow}
+        hasOnOpenWindowEvent={onOpenWindowProp !== undefined}
+        onShouldStartLoadWithRequest={onShouldStartLoadWithRequest}
+        onContentProcessDidTerminate={onContentProcessDidTerminate}
+        injectedJavaScript={injectedJavaScript}
+        injectedJavaScriptBeforeContentLoaded={
+          injectedJavaScriptBeforeContentLoaded
+        }
+        injectedJavaScriptForMainFrameOnly={injectedJavaScriptForMainFrameOnly}
+        injectedJavaScriptBeforeContentLoadedForMainFrameOnly={
+          injectedJavaScriptBeforeContentLoadedForMainFrameOnly
+        }
+        injectedJavaScriptObject={JSON.stringify(injectedJavaScriptObject)}
+        dataDetectorTypes={
+          !dataDetectorTypes || Array.isArray(dataDetectorTypes)
+            ? dataDetectorTypes
+            : [dataDetectorTypes]
+        }
+        allowsAirPlayForMediaPlayback={allowsAirPlayForMediaPlayback}
+        allowsInlineMediaPlayback={allowsInlineMediaPlayback}
+        allowsPictureInPictureMediaPlayback={
+          allowsPictureInPictureMediaPlayback
+        }
+        incognito={incognito}
+        mediaPlaybackRequiresUserAction={mediaPlaybackRequiresUserAction}
+        newSource={newSource}
+        style={webViewStyles}
+        hasOnFileDownload={!!onFileDownload}
+        ref={webViewRef}
+        // @ts-expect-error old arch only
+        source={sourceResolved}
+        {...nativeConfig?.props}
+      />
+    );
+
+    return (
+      <View style={webViewContainerStyle}>
+        {webView}
+        {otherView}
+      </View>
+    );
+  }
+);
+
+// no native implementation for iOS, depends only on permissions
+const isFileUploadSupported: () => Promise<boolean> = async () => true;
+
+const WebView = Object.assign(WebViewComponent, { isFileUploadSupported });
+
+export default WebView;