expo-web-browser 10.2.1 → 12.0.0

package/src/WebBrowser.ts

@@ -1,5 +1,12 @@
 import { UnavailabilityError } from 'expo-modules-core';
-import { AppState, AppStateStatus, Linking, Platform } from 'react-native';
+import {
+  AppState,
+  AppStateStatus,
+  Linking,
+  Platform,
+  EmitterSubscription,
+  processColor,
+} from 'react-native';
 
 import ExponentWebBrowser from './ExpoWebBrowser';
 import {
@@ -177,7 +184,7 @@ export async function openBrowserAsync(
 
   let result: WebBrowserResult;
   try {
-    result = await ExponentWebBrowser.openBrowserAsync(url, browserParams);
+    result = await ExponentWebBrowser.openBrowserAsync(url, _processOptions(browserParams));
   } finally {
     // WebBrowser session complete, unset lock
     browserLocked = false;
@@ -203,9 +210,8 @@ export function dismissBrowser(): void {
 // @needsAudit
 /**
  * # On iOS:
- * Opens the url with Safari in a modal using `SFAuthenticationSession` on iOS 11 and greater,
- * and falling back on a `SFSafariViewController`. The user will be asked whether to allow the app
- * to authenticate using the given url.
+ * Opens the url with Safari in a modal using `ASWebAuthenticationSession`. The user will be asked
+ * whether to allow the app to authenticate using the given url.
  *
  * # On Android:
  * This will be done using a "custom Chrome tabs" browser, [AppState](../react-native/appstate/),
@@ -220,7 +226,7 @@ export function dismissBrowser(): void {
  *
  * How this works on web:
  * - A crypto state will be created for verifying the redirect.
- *   - This means you need to run with `expo start:web --https`
+ *   - This means you need to run with `npx expo start --https`
  * - The state will be added to the window's `localstorage`. This ensures that auth cannot complete
  *   unless it's done from a page running with the same origin as it was started.
  *   Ex: if `openAuthSessionAsync` is invoked on `https://localhost:19006`, then `maybeCompleteAuthSession`
@@ -234,7 +240,8 @@ export function dismissBrowser(): void {
  * after a user interaction. If the event is blocked, an error with code [`ERR_WEB_BROWSER_BLOCKED`](#errwebbrowserblocked) will be thrown.
  *
  * @param url The url to open in the web browser. This should be a login page.
- * @param redirectUrl _Optional_ - The url to deep link back into your app. By default, this will be [`Constants.linkingUrl`](./constants/#expoconstantslinkinguri).
+ * @param redirectUrl _Optional_ - The url to deep link back into your app.
+ * On web, this defaults to the output of [`Linking.createURL("")`](./linking/#linkingcreateurlpath-namedparameters).
  * @param options _Optional_ - An object extending the [`WebBrowserOpenOptions`](#webbrowseropenoptions).
  * If there is no native AuthSession implementation available (which is the case on Android)
  * these params will be used in the browser polyfill. If there is a native AuthSession implementation,
@@ -248,7 +255,7 @@ export function dismissBrowser(): void {
  */
 export async function openAuthSessionAsync(
   url: string,
-  redirectUrl: string,
+  redirectUrl?: string | null,
   options: AuthSessionOpenOptions = {}
 ): Promise<WebBrowserAuthSessionResult> {
   if (_authSessionIsNativelySupported()) {
@@ -256,7 +263,7 @@ export async function openAuthSessionAsync(
       throw new UnavailabilityError('WebBrowser', 'openAuthSessionAsync');
     }
     if (['ios', 'web'].includes(Platform.OS)) {
-      return ExponentWebBrowser.openAuthSessionAsync(url, redirectUrl, options);
+      return ExponentWebBrowser.openAuthSessionAsync(url, redirectUrl, _processOptions(options));
     }
     return ExponentWebBrowser.openAuthSessionAsync(url, redirectUrl);
   } else {
@@ -317,6 +324,15 @@ export function maybeCompleteAuthSession(
   return { type: 'failed', message: 'Not supported on this platform' };
 }
 
+function _processOptions(options: WebBrowserOpenOptions) {
+  return {
+    ...options,
+    controlsColor: processColor(options.controlsColor),
+    toolbarColor: processColor(options.toolbarColor),
+    secondaryToolbarColor: processColor(options.secondaryToolbarColor),
+  };
+}
+
 /* iOS <= 10 and Android polyfill for SFAuthenticationSession flow */
 
 function _authSessionIsNativelySupported(): boolean {
@@ -330,7 +346,7 @@ function _authSessionIsNativelySupported(): boolean {
   return versionNumber >= 11;
 }
 
-let _redirectHandler: ((event: RedirectEvent) => void) | null = null;
+let _redirectSubscription: EmitterSubscription | null = null;
 
 /*
  * openBrowserAsync on Android doesn't wait until closed, so we need to polyfill
@@ -389,10 +405,10 @@ async function _openBrowserAndWaitAndroidAsync(
 
 async function _openAuthSessionPolyfillAsync(
   startUrl: string,
-  returnUrl: string,
+  returnUrl: string | null | undefined,
   browserParams: WebBrowserOpenOptions = {}
 ): Promise<WebBrowserAuthSessionResult> {
-  if (_redirectHandler) {
+  if (_redirectSubscription) {
     throw new Error(
       `The WebBrowser's auth session is in an invalid state with a redirect handler set when it should not be`
     );
@@ -426,24 +442,27 @@ async function _openAuthSessionPolyfillAsync(
 }
 
 function _stopWaitingForRedirect() {
-  if (!_redirectHandler) {
+  if (!_redirectSubscription) {
     throw new Error(
       `The WebBrowser auth session is in an invalid state with no redirect handler when one should be set`
     );
   }
 
-  Linking.removeEventListener('url', _redirectHandler);
-  _redirectHandler = null;
+  _redirectSubscription.remove();
+  _redirectSubscription = null;
 }
 
-function _waitForRedirectAsync(returnUrl: string): Promise<WebBrowserRedirectResult> {
+function _waitForRedirectAsync(
+  returnUrl: string | null | undefined
+): Promise<WebBrowserRedirectResult> {
+  // Note that this Promise never resolves when `returnUrl` is nullish
   return new Promise((resolve) => {
-    _redirectHandler = (event: RedirectEvent) => {
-      if (event.url.startsWith(returnUrl)) {
+    const redirectHandler = (event: RedirectEvent) => {
+      if (returnUrl && event.url.startsWith(returnUrl)) {
         resolve({ url: event.url, type: 'success' });
       }
     };
 
-    Linking.addEventListener('url', _redirectHandler);
+    _redirectSubscription = Linking.addEventListener('url', redirectHandler);
   });
 }

package/src/WebBrowser.types.ts

@@ -8,7 +8,7 @@ export type WebBrowserWindowFeatures = Record<string, number | boolean | string>
 // @needsAudit
 export type WebBrowserOpenOptions = {
   /**
-   * Color of the toolbar in either `#AARRGGBB` or `#RRGGBB` format.
+   * Color of the toolbar. Supports React Native [color formats](https://reactnative.dev/docs/colors).
    */
   toolbarColor?: string;
   /**
@@ -22,7 +22,7 @@ export type WebBrowserOpenOptions = {
    */
   enableBarCollapsing?: boolean;
   /**
-   * Color of the secondary toolbar in either `#AARRGGBB` or `#RRGGBB` format.
+   * Color of the secondary toolbar. Supports React Native [color formats](https://reactnative.dev/docs/colors).
    * @platform android
    */
   secondaryToolbarColor?: string;
@@ -51,7 +51,7 @@ export type WebBrowserOpenOptions = {
    */
   createTask?: boolean;
   /**
-   * Tint color for controls in SKSafariViewController in `#AARRGGBB` or `#RRGGBB` format.
+   * Tint color for controls in SKSafariViewController. Supports React Native [color formats](https://reactnative.dev/docs/colors).
    * @platform ios
    */
   controlsColor?: string;

package/tsconfig.json

@@ -5,5 +5,5 @@
     "outDir": "./build"
   },
   "include": ["./src"],
-  "exclude": ["**/__mocks__/*", "**/__tests__/*"]
+  "exclude": ["**/__mocks__/*", "**/__tests__/*", "**/__stories__/*"]
 }

package/android/src/main/java/expo/modules/webbrowser/CustomTabsActivitiesHelper.java

@@ -1,33 +0,0 @@
-package expo.modules.webbrowser;
-
-import android.content.Intent;
-import android.content.pm.ResolveInfo;
-
-import expo.modules.core.errors.CurrentActivityNotFoundException;
-import expo.modules.core.interfaces.InternalModule;
-
-import java.util.ArrayList;
-import java.util.List;
-
-import androidx.annotation.NonNull;
-import androidx.annotation.Nullable;
-import expo.modules.webbrowser.error.PackageManagerNotFoundException;
-
-public interface CustomTabsActivitiesHelper extends InternalModule {
-
-  @NonNull
-  ArrayList<String> getCustomTabsResolvingActivities() throws PackageManagerNotFoundException, CurrentActivityNotFoundException;
-
-  @NonNull
-  ArrayList<String> getCustomTabsResolvingServices() throws PackageManagerNotFoundException, CurrentActivityNotFoundException;
-
-  @Nullable
-  String getPreferredCustomTabsResolvingActivity(@Nullable List<String> packages) throws PackageManagerNotFoundException, CurrentActivityNotFoundException;
-
-  @Nullable
-  String getDefaultCustomTabsResolvingActivity() throws PackageManagerNotFoundException, CurrentActivityNotFoundException;
-
-  void startCustomTabs(Intent intent) throws CurrentActivityNotFoundException;
-
-  boolean canResolveIntent(Intent intent) throws PackageManagerNotFoundException, CurrentActivityNotFoundException;
-}

package/android/src/main/java/expo/modules/webbrowser/CustomTabsConnectionHelper.java

@@ -1,13 +0,0 @@
-package expo.modules.webbrowser;
-
-import android.net.Uri;
-
-import expo.modules.core.interfaces.InternalModule;
-
-public interface CustomTabsConnectionHelper extends InternalModule {
-  void warmUp(String packageName);
-
-  void mayInitWithUrl(String packageName, Uri uri);
-
-  boolean coolDown(String packageName);
-}

package/android/src/main/java/expo/modules/webbrowser/DeferredClientActionsQueue.java

@@ -1,50 +0,0 @@
-package expo.modules.webbrowser;
-
-import expo.modules.core.interfaces.Consumer;
-
-import java.util.LinkedList;
-import java.util.Queue;
-
-
-public class DeferredClientActionsQueue<T> {
-
-  private Queue<Consumer<T>> actions = new LinkedList<>();
-  private T client;
-
-  public void executeOrQueueAction(Consumer<T> action) {
-    if (client != null) {
-      action.apply(client);
-    } else {
-      addActionToQueue(action);
-    }
-  }
-
-  public void setClient(T client) {
-    this.client = client;
-    executeQueuedActions();
-  }
-
-  public void clear() {
-    this.client = null;
-    this.actions.clear();
-  }
-
-  public boolean hasClient() {
-    return client != null;
-  }
-
-  private void executeQueuedActions() {
-    if (client != null) {
-      Consumer<T> action = actions.poll();
-      while (action != null) {
-        action.apply(client);
-        action = actions.poll();
-      }
-    }
-  }
-
-  private void addActionToQueue(Consumer<T> consumer) {
-    actions.add(consumer);
-  }
-
-}

package/android/src/main/java/expo/modules/webbrowser/InternalCustomTabsActivitiesHelper.java

@@ -1,127 +0,0 @@
-package expo.modules.webbrowser;
-
-import android.app.Activity;
-import android.content.Intent;
-import android.content.pm.PackageManager;
-import android.content.pm.ResolveInfo;
-import android.net.Uri;
-
-import expo.modules.core.ModuleRegistry;
-import expo.modules.core.errors.CurrentActivityNotFoundException;
-import expo.modules.core.interfaces.ActivityProvider;
-import expo.modules.core.interfaces.Function;
-import expo.modules.core.interfaces.InternalModule;
-
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.LinkedHashSet;
-import java.util.List;
-
-import androidx.annotation.NonNull;
-import androidx.annotation.Nullable;
-import androidx.browser.customtabs.CustomTabsClient;
-import androidx.browser.customtabs.CustomTabsIntent;
-import expo.modules.webbrowser.error.PackageManagerNotFoundException;
-
-import static androidx.browser.customtabs.CustomTabsService.ACTION_CUSTOM_TABS_CONNECTION;
-
-class InternalCustomTabsActivitiesHelper implements CustomTabsActivitiesHelper {
-
-
-  private final static String DUMMY_URL = "https://expo.io";
-
-  private ModuleRegistry mModuleRegistry;
-
-  @NonNull
-  public static <T, R> ArrayList<R> mapCollectionToDistinctArrayList(Collection<? extends T> toMap, Function<T, R> mapper) {
-    LinkedHashSet<R> resultSet = new LinkedHashSet<>();
-    for (T element : toMap) {
-      resultSet.add(mapper.apply(element));
-    }
-    return new ArrayList<>(resultSet);
-  }
-
-  @Override
-  public void onCreate(ModuleRegistry moduleRegistry) {
-    this.mModuleRegistry = moduleRegistry;
-  }
-
-  @Override
-  @NonNull
-  public ArrayList<String> getCustomTabsResolvingActivities() throws PackageManagerNotFoundException, CurrentActivityNotFoundException {
-    return mapCollectionToDistinctArrayList(getResolvingActivities(createDefaultCustomTabsIntent()), resolveInfo -> resolveInfo.activityInfo.packageName);
-  }
-
-  @Override
-  @NonNull
-  public ArrayList<String> getCustomTabsResolvingServices() throws PackageManagerNotFoundException, CurrentActivityNotFoundException {
-    return mapCollectionToDistinctArrayList(getPackageManager().queryIntentServices(createDefaultCustomTabsServiceIntent(), 0), resolveInfo -> resolveInfo.serviceInfo.packageName);
-  }
-
-  @Override
-  @Nullable
-  public String getPreferredCustomTabsResolvingActivity(@Nullable List<String> packages) throws PackageManagerNotFoundException, CurrentActivityNotFoundException {
-    if (packages == null) packages = getCustomTabsResolvingActivities();
-    return CustomTabsClient.getPackageName(getCurrentActivity(), packages);
-  }
-
-  @Override
-  @Nullable
-  public String getDefaultCustomTabsResolvingActivity() throws PackageManagerNotFoundException, CurrentActivityNotFoundException {
-    ResolveInfo info = getPackageManager().resolveActivity(createDefaultCustomTabsIntent(), 0);
-    return info == null ? null : info.activityInfo.packageName;
-  }
-
-  @Override
-  public boolean canResolveIntent(@NonNull Intent intent) throws PackageManagerNotFoundException, CurrentActivityNotFoundException {
-    return getResolvingActivities(intent).size() > 0;
-  }
-
-  public void startCustomTabs(Intent intent) throws CurrentActivityNotFoundException {
-    getCurrentActivity().startActivity(intent);
-  }
-
-  private List<ResolveInfo> getResolvingActivities(@NonNull Intent intent) throws PackageManagerNotFoundException, CurrentActivityNotFoundException {
-    return getPackageManager().queryIntentActivities(intent, 0);
-  }
-
-  private PackageManager getPackageManager() throws PackageManagerNotFoundException, CurrentActivityNotFoundException {
-    PackageManager pm = getCurrentActivity().getPackageManager();
-    if (pm == null) throw new PackageManagerNotFoundException();
-    else return pm;
-  }
-
-  private Activity getCurrentActivity() throws CurrentActivityNotFoundException {
-    ActivityProvider activityProvider = mModuleRegistry.getModule(ActivityProvider.class);
-    if (activityProvider == null || activityProvider.getCurrentActivity() == null) {
-      throw new CurrentActivityNotFoundException();
-    }
-    return activityProvider.getCurrentActivity();
-  }
-
-  private Intent createDefaultCustomTabsIntent() {
-    CustomTabsIntent.Builder builder = new CustomTabsIntent.Builder();
-    CustomTabsIntent customTabsIntent = builder.build();
-
-    Intent intent = customTabsIntent.intent;
-    intent.setData(Uri.parse(DUMMY_URL));
-    return intent;
-  }
-
-  private Intent createDefaultCustomTabsServiceIntent() {
-    Intent serviceIntent = new Intent();
-    serviceIntent.setAction(ACTION_CUSTOM_TABS_CONNECTION);
-    return serviceIntent;
-  }
-
-  @Override
-  public void onDestroy() {
-
-  }
-
-  @Override
-  public List<? extends Class> getExportedInterfaces() {
-    return Collections.singletonList(CustomTabsActivitiesHelper.class);
-  }
-}

package/android/src/main/java/expo/modules/webbrowser/InternalCustomTabsConnectionHelper.java

@@ -1,126 +0,0 @@
-package expo.modules.webbrowser;
-
-import android.content.ComponentName;
-import android.content.Context;
-import android.net.Uri;
-import androidx.browser.customtabs.CustomTabsClient;
-import androidx.browser.customtabs.CustomTabsServiceConnection;
-import androidx.browser.customtabs.CustomTabsSession;
-
-import expo.modules.core.interfaces.InternalModule;
-import expo.modules.core.interfaces.LifecycleEventListener;
-
-import java.util.Collections;
-import java.util.List;
-
-public class InternalCustomTabsConnectionHelper extends CustomTabsServiceConnection implements LifecycleEventListener, CustomTabsConnectionHelper {
-
-  private Context mContext;
-  private String mPackageName;
-  private DeferredClientActionsQueue<CustomTabsClient> clientActions = new DeferredClientActionsQueue<>();
-  private DeferredClientActionsQueue<CustomTabsSession> sessionActions = new DeferredClientActionsQueue<>();
-
-  InternalCustomTabsConnectionHelper(Context context) {
-    this.mContext = context;
-  }
-
-  @Override
-  public void warmUp(String packageName) {
-    clientActions.executeOrQueueAction(client -> client.warmup(0));
-    ensureConnection(packageName);
-  }
-
-  @Override
-  public void mayInitWithUrl(String packageName, Uri uri) {
-    sessionActions.executeOrQueueAction(session -> session.mayLaunchUrl(uri, null, null));
-    ensureConnection(packageName);
-    ensureSession();
-  }
-
-  private void ensureSession() {
-    if (!sessionActions.hasClient()) {
-      clientActions.executeOrQueueAction(
-          client ->
-              sessionActions.setClient(client.newSession(null)));
-    }
-  }
-
-  @Override
-  public boolean coolDown(String packageName) {
-    if (packageName.equals(this.mPackageName)) {
-      unbindService();
-      return true;
-    }
-    return false;
-  }
-
-  private void ensureConnection(String packageName) {
-    if (this.mPackageName != null && !this.mPackageName.equals(packageName)) {
-      clearConnection();
-    }
-    if (!connectionStarted(packageName)) {
-      CustomTabsClient.bindCustomTabsService(getContext(), packageName, this);
-      this.mPackageName = packageName;
-    }
-  }
-
-  private boolean connectionStarted(String packageName) {
-    return packageName.equals(this.mPackageName);
-  }
-
-  @Override
-  public void onBindingDied(ComponentName componentName) {
-    if (componentName.getPackageName().equals(this.mPackageName)) {
-      clearConnection();
-    }
-  }
-
-  @Override
-  public void onCustomTabsServiceConnected(ComponentName componentName, CustomTabsClient client) {
-    if (componentName.getPackageName().equals(mPackageName)) {
-      clientActions.setClient(client);
-    }
-  }
-
-  @Override
-  public void onServiceDisconnected(ComponentName componentName) {
-    if (componentName.getPackageName().equals(this.mPackageName)) {
-      clearConnection();
-    }
-  }
-
-  @Override
-  public void onHostResume() {
-    // do nothing
-  }
-
-  @Override
-  public void onHostPause() {
-    // do nothing
-  }
-
-  @Override
-  public void onHostDestroy() {
-    unbindService();
-  }
-
-  private void unbindService() {
-    getContext().unbindService(this);
-    clearConnection();
-  }
-
-  private void clearConnection() {
-    this.mPackageName = null;
-    clientActions.clear();
-    sessionActions.clear();
-  }
-
-  private Context getContext() {
-    return mContext;
-  }
-
-  @Override
-  public List<? extends Class> getExportedInterfaces() {
-    return Collections.singletonList(CustomTabsConnectionHelper.class);
-  }
-}