@applicaster/zapp-react-native-ui-components 16.0.0-alpha.1334507601 → 16.0.0-alpha.1444784746

package/Components/Transitioner/Transitioner.tsx

@@ -1,6 +1,6 @@
 import * as React from "react";
 import { View } from "react-native";
-import { append, compose, identity, tail, take, update } from "ramda";
+import { append, compose, identity, tail, update } from "ramda";
 
 import { AnimationManager } from "./AnimationManager";
 import { Scene } from "./Scene";
@@ -18,11 +18,23 @@ export const NAV_ACTION_REPLACE = "REPLACE";
 
 export const NAV_ACTION_BACK = "POP";
 
-type SceneProps = {
-  children: React.ReactNode;
-  overlayStyle: any;
-  style: any;
-  animating: boolean;
+const RIVER_SEGMENT_REGEX = /river\//g;
+
+// Number of "river/" segments in the route, i.e. its depth in the navigation stack
+function countRiverSegments(route?: string): number {
+  return (route?.match(RIVER_SEGMENT_REGEX) || []).length;
+}
+
+// The screen element rendered for the current route
+type SceneChild = React.ReactElement<{
+  pathname: string;
+  screenData: NavigationScreenData;
+}>;
+
+type TransitionerScene = {
+  children: SceneChild;
+  key: string;
+  screenUniqueId: string;
 };
 
 /**
@@ -31,7 +43,7 @@ type SceneProps = {
  * @param {Object} children
  * @returns { children: Object, key: string }
  */
-function prepareScene(children) {
+function prepareScene(children: SceneChild): TransitionerScene {
   return {
     children,
     key: children.props.pathname,
@@ -45,7 +57,10 @@ function prepareScene(children) {
  * @param {any} props Component's props
  * @param {any} state Component's state
  */
-function scenesForBackTransition(props: SceneProps, { scenes }) {
+function scenesForBackTransition(
+  props: Pick<Props, "children">,
+  { scenes }: Pick<State, "scenes">
+): TransitionerScene[] {
   return scenes.length > 1
     ? identity(scenes)
     : [prepareScene(props.children), scenes[0]];
@@ -53,7 +68,8 @@ function scenesForBackTransition(props: SceneProps, { scenes }) {
 
 type Props = {
   transitionConfig: any;
-  children: React.ReactNode;
+  isRTL?: boolean;
+  children: SceneChild;
   navigator: {
     previousAction: string;
     currentRoute: string;
@@ -78,13 +94,12 @@ type Props = {
 };
 
 type State = {
-  animatedValue: any;
   animating: boolean;
   duration: number;
   easing: any;
   from: any;
   to: any;
-  scenes: any;
+  scenes: TransitionerScene[];
 };
 
 const styles = {
@@ -92,11 +107,18 @@ const styles = {
 } as const;
 
 export class TransitionerComponent extends React.PureComponent<Props, State> {
+  private animationManager: AnimationManager;
+
+  private transitionId: number;
+
   constructor(props: Props) {
     super(props);
 
     this.animationManager = new AnimationManager(props);
 
+    // Bumped by every animated transition; end callbacks of older ones are ignored
+    this.transitionId = 0;
+
     this.state = {
       scenes: [prepareScene(props.children)], // starting with index: 0
       ...this.animationManager.initialState(),
@@ -113,29 +135,36 @@ export class TransitionerComponent extends React.PureComponent<Props, State> {
    * and trigger push animation with callbacks.
    */
   pushTransitionStart() {
+    const transitionId = ++this.transitionId;
+
     this.setState(
       {
-        scenes: append(prepareScene(this.props.children), this.state.scenes),
+        // Append right after the visible scene: stateForAction(PUSH) animates to.index + 1
+        scenes: [
+          ...this.state.scenes.slice(0, this.state.to.index + 1),
+          prepareScene(this.props.children),
+        ],
         ...this.animationManager.stateForAction(this.state, NAV_ACTION_PUSH),
       },
       () => {
-        this.animationManager.animate(this.state, this.pushTransitionEnd);
+        this.animationManager.animate(this.state, () =>
+          this.pushTransitionEnd(transitionId)
+        );
       }
     );
   }
 
   /**
    * Trigger back animation.
-   * The last scene in the array is removed in the "backTransitionEnd" callback,
+   * The scenes after the target one are removed in the "backTransitionEnd" callback,
    * only after the animation is complete.
    */
-  backTransitionStart() {
-    const previousRoute = this.props.navigator?.currentRoute;
+  backTransitionStart(previousRoute: string) {
+    const transitionId = ++this.transitionId;
     const currentRoute = this.props.navigator?.currentRoute;
 
     const diffLengthRoutes =
-      (previousRoute?.match(/river\//g) || []).length -
-      (currentRoute?.match(/river\//g) || []).length;
+      countRiverSegments(previousRoute) - countRiverSegments(currentRoute);
 
     const stepsBack =
       diffLengthRoutes && diffLengthRoutes > 0 ? diffLengthRoutes : 1;
@@ -151,30 +180,32 @@ export class TransitionerComponent extends React.PureComponent<Props, State> {
       },
       () => {
         this.animationManager.animate(this.state, () =>
-          this.backTransitionEnd(stepsBack)
+          this.backTransitionEnd(transitionId)
         );
       }
     );
   }
 
-  shouldSkipAnimationForRoute(route) {
+  shouldSkipAnimationForRoute(route: string) {
     // We are skipping animations for some routes, likes hooks & the player mainly
 
     return route.includes("/playable") || route.includes("/hook");
   }
 
-  shouldResetStateForRoute(route) {
+  shouldResetStateForRoute(route: string) {
     // We are resetting the transitioner state for root routes
 
-    return (route?.match(/river\//g) || []).length === 1;
+    return countRiverSegments(route) === 1;
   }
 
-  transitionWithoutAnimation(resetState) {
-    const { scenes } = this.state;
+  transitionWithoutAnimation(resetState?: boolean) {
+    // Scenes after the visible one are only leaving (back animation in flight),
+    // so the new scene replaces the one being backed to
+    const scenes = this.state.scenes.slice(0, this.state.to.index + 1);
     const newScene = prepareScene(this.props.children);
     const isLastSceneHook = scenes[scenes.length - 1].key.startsWith("/hook");
 
-    let newState;
+    let newState: Pick<State, "scenes"> | Pick<State, "scenes" | "to">;
 
     if (resetState) {
       newState = {
@@ -242,7 +273,7 @@ export class TransitionerComponent extends React.PureComponent<Props, State> {
           break;
 
         case NAV_ACTION_BACK: {
-          this.backTransitionStart();
+          this.backTransitionStart(previousRoute);
           break;
         }
 
@@ -264,20 +295,27 @@ export class TransitionerComponent extends React.PureComponent<Props, State> {
     }
   }
 
-  // Sets state.animating to false
-  pushTransitionEnd() {
+  // Sets state.animating to false,
+  // unless a newer transition has started since this one
+  pushTransitionEnd(transitionId: number) {
+    if (transitionId !== this.transitionId) return;
+
     this.setState({
       animating: false,
     });
   }
 
   // Sets state.animating to false
-  // and remove last scene from scenes stack
-  backTransitionEnd(stepsBack) {
-    this.setState({
+  // and drops every scene after the target one. Reads the latest state,
+  // so it's correct however many backs were merged into this animation.
+  // Ignored if a newer transition has started since this one
+  backTransitionEnd(transitionId: number) {
+    if (transitionId !== this.transitionId) return;
+
+    this.setState(({ scenes, to }) => ({
       animating: false,
-      scenes: take(this.state.scenes.length - stepsBack, this.state.scenes),
-    });
+      scenes: scenes.slice(0, to.index + 1),
+    }));
   }
 
   // On initial state, both "to" and "from" point to a single scene

package/Components/Transitioner/__tests__/transitioner.test.js

@@ -1,8 +1,15 @@
 import React from "react";
-import { Text, View } from "react-native";
+import { Animated, Text, View } from "react-native";
+import { v4 as uuidV4 } from "uuid";
 
-import { TransitionerComponent } from "../Transitioner";
-import { render } from "@testing-library/react-native";
+import { AnimationManager } from "../AnimationManager";
+import {
+  NAV_ACTION_BACK,
+  NAV_ACTION_PUSH,
+  NAV_ACTION_REPLACE,
+  TransitionerComponent,
+} from "../Transitioner";
+import { act, render } from "@testing-library/react-native";
 
 jest.mock("../Scene", () => {
   const View = jest.requireActual("react-native").View;
@@ -40,6 +47,47 @@ const transitionerComponentProps = {
 
 jest.mock("uuid");
 
+const sceneTransitionConfig = () => ({
+  push: {
+    duration: 0,
+    easing: jest.fn(),
+    from: { style: {} },
+    to: { style: {} },
+  },
+  back: {
+    duration: 0,
+    easing: jest.fn(),
+    from: { style: {} },
+    to: { style: {} },
+  },
+});
+
+const sceneFor = (route) => (
+  <View pathname={route}>
+    <Text>{route}</Text>
+  </View>
+);
+
+const root = "/river/root";
+const child = `${root}/river/child`;
+const grandchild = `${child}/river/grandchild`;
+
+const propsFor = (route, previousAction, children = sceneFor(route)) => ({
+  navigator: {
+    previousAction,
+    currentRoute: route,
+    screenData: {},
+  },
+  transitionConfig: sceneTransitionConfig,
+  layoutData: {
+    isTablet: false,
+    isTabletPortrait: false,
+  },
+  children,
+});
+
+const sceneKeys = (ref) => ref.current.state.scenes.map((scene) => scene.key);
+
 describe("<TransitionerComponent />", () => {
   it("renders correctly", () => {
     const wrapper = render(
@@ -50,4 +98,325 @@ describe("<TransitionerComponent />", () => {
 
     expect(wrapper.toJSON()).toMatchSnapshot();
   });
+
+  it("removes both intermediate scenes when backing out to the tab root", () => {
+    jest
+      .spyOn(AnimationManager.prototype, "animate")
+      .mockImplementation((_, done) => done());
+
+    const ref = React.createRef();
+
+    const { rerender } = render(
+      <TransitionerComponent
+        ref={ref}
+        {...propsFor(root, NAV_ACTION_REPLACE)}
+      />
+    );
+
+    act(() => {
+      rerender(
+        <TransitionerComponent
+          ref={ref}
+          {...propsFor(child, NAV_ACTION_PUSH)}
+        />
+      );
+    });
+
+    act(() => {
+      rerender(
+        <TransitionerComponent
+          ref={ref}
+          {...propsFor(grandchild, NAV_ACTION_PUSH)}
+        />
+      );
+    });
+
+    act(() => {
+      rerender(
+        <TransitionerComponent ref={ref} {...propsFor(root, NAV_ACTION_BACK)} />
+      );
+    });
+
+    expect(sceneKeys(ref)).toEqual([root]);
+  });
+
+  describe("with interruptible animations", () => {
+    // End callback of the animation that is currently "running"
+    let runningAnimationEnd = null;
+
+    const finishAnimation = () => {
+      act(() => {
+        const done = runningAnimationEnd;
+        runningAnimationEnd = null;
+        done?.();
+      });
+    };
+
+    const mountTransitioner = ({
+      initialRoute = root,
+      renderScene = sceneFor,
+    } = {}) => {
+      const ref = React.createRef();
+
+      const transitioner = (route, action) => (
+        <TransitionerComponent
+          ref={ref}
+          {...propsFor(route, action, renderScene(route))}
+        />
+      );
+
+      const { rerender } = render(
+        transitioner(initialRoute, NAV_ACTION_REPLACE)
+      );
+
+      const navigate = (route, action) => {
+        act(() => {
+          rerender(transitioner(route, action));
+        });
+      };
+
+      return { ref, navigate };
+    };
+
+    beforeEach(() => {
+      let sceneCount = 0;
+      uuidV4.mockImplementation(() => `scene-${++sceneCount}`);
+
+      jest
+        .spyOn(AnimationManager.prototype, "animate")
+        .mockImplementation((_, done) => {
+          runningAnimationEnd = done;
+        });
+
+      const setValue = Animated.Value.prototype.setValue;
+
+      // RN 0.77: setValue() stops the running animation, which calls
+      // its end callback synchronously with { finished: false }
+      jest
+        .spyOn(Animated.Value.prototype, "setValue")
+        .mockImplementation(function (value) {
+          const interrupted = runningAnimationEnd;
+          runningAnimationEnd = null;
+          interrupted?.();
+
+          return setValue.call(this, value);
+        });
+    });
+
+    afterEach(() => {
+      runningAnimationEnd = null;
+      jest.restoreAllMocks();
+      uuidV4.mockReset();
+    });
+
+    it("drops interrupted scenes when going back twice during a back animation", () => {
+      const { ref, navigate } = mountTransitioner();
+
+      navigate(child, NAV_ACTION_PUSH);
+      finishAnimation();
+      navigate(grandchild, NAV_ACTION_PUSH);
+      finishAnimation();
+
+      navigate(child, NAV_ACTION_BACK);
+      navigate(root, NAV_ACTION_BACK);
+
+      expect(ref.current.state.animating).toBe(true);
+
+      finishAnimation();
+
+      expect(sceneKeys(ref)).toEqual([root]);
+      expect(ref.current.state.animating).toBe(false);
+    });
+
+    it("remounts the screen when revisiting it after a quick double back", () => {
+      const mounts = {};
+
+      const MountProbe = ({ pathname }) => {
+        React.useEffect(() => {
+          mounts[pathname] = (mounts[pathname] || 0) + 1;
+        }, [pathname]);
+
+        return <Text>{pathname}</Text>;
+      };
+
+      const { ref, navigate } = mountTransitioner({
+        renderScene: (route) => <MountProbe pathname={route} />,
+      });
+
+      navigate(child, NAV_ACTION_PUSH);
+      finishAnimation();
+
+      const originalChildId = ref.current.state.scenes[1].screenUniqueId;
+
+      navigate(grandchild, NAV_ACTION_PUSH);
+      finishAnimation();
+      navigate(child, NAV_ACTION_BACK);
+      navigate(root, NAV_ACTION_BACK);
+      finishAnimation();
+
+      navigate(child, NAV_ACTION_PUSH);
+      finishAnimation();
+
+      const { scenes, to } = ref.current.state;
+
+      expect(scenes).toHaveLength(2);
+      expect(to.index).toBe(1);
+      expect(scenes[1].screenUniqueId).not.toBe(originalChildId);
+      expect(mounts[child]).toBe(2);
+    });
+
+    it("keeps a single scene when going back from the first scene", () => {
+      const { ref, navigate } = mountTransitioner({ initialRoute: child });
+
+      navigate(root, NAV_ACTION_BACK);
+      finishAnimation();
+
+      expect(sceneKeys(ref)).toEqual([root]);
+      expect(ref.current.state.to.index).toBe(0);
+      expect(ref.current.state.animating).toBe(false);
+    });
+
+    it("pushes a fresh scene after a completed single back", () => {
+      const { ref, navigate } = mountTransitioner();
+
+      navigate(child, NAV_ACTION_PUSH);
+      finishAnimation();
+
+      const originalChildId = ref.current.state.scenes[1].screenUniqueId;
+
+      navigate(root, NAV_ACTION_BACK);
+      finishAnimation();
+      navigate(child, NAV_ACTION_PUSH);
+      finishAnimation();
+
+      const { scenes, to } = ref.current.state;
+
+      expect(sceneKeys(ref)).toEqual([root, child]);
+      expect(to.index).toBe(1);
+      expect(scenes[1].screenUniqueId).not.toBe(originalChildId);
+    });
+
+    it("ignores the end of a back animation that a newer back superseded", () => {
+      const { ref, navigate } = mountTransitioner();
+
+      navigate(child, NAV_ACTION_PUSH);
+      finishAnimation();
+      navigate(grandchild, NAV_ACTION_PUSH);
+      finishAnimation();
+
+      navigate(child, NAV_ACTION_BACK);
+
+      const supersededEnd = runningAnimationEnd;
+
+      // Deliver the interrupted animation's end late, after the newer one started
+      Animated.Value.prototype.setValue.mockImplementation(() => {});
+
+      navigate(root, NAV_ACTION_BACK);
+
+      act(() => {
+        supersededEnd();
+      });
+
+      expect(ref.current.state.animating).toBe(true);
+      expect(sceneKeys(ref)).toEqual([root, child, grandchild]);
+
+      finishAnimation();
+
+      expect(sceneKeys(ref)).toEqual([root]);
+      expect(ref.current.state.animating).toBe(false);
+    });
+
+    it("drops the pushed scene when going back before its push animation ends", () => {
+      const { ref, navigate } = mountTransitioner();
+
+      navigate(child, NAV_ACTION_PUSH);
+      navigate(root, NAV_ACTION_BACK);
+
+      expect(ref.current.state.animating).toBe(true);
+
+      finishAnimation();
+
+      expect(sceneKeys(ref)).toEqual([root]);
+      expect(ref.current.state.animating).toBe(false);
+    });
+
+    it("pushes right after the visible scene even when stale scenes are left behind", () => {
+      const { ref, navigate } = mountTransitioner();
+
+      navigate(child, NAV_ACTION_PUSH);
+      finishAnimation();
+
+      // Leftover past to.index, as some other path could leave behind
+      act(() => {
+        ref.current.setState(({ scenes }) => ({
+          scenes: [
+            ...scenes,
+            {
+              ...scenes[1],
+              key: `${root}/river/stale`,
+              screenUniqueId: "stale",
+            },
+          ],
+        }));
+      });
+
+      navigate(grandchild, NAV_ACTION_PUSH);
+      finishAnimation();
+
+      const { scenes, to } = ref.current.state;
+
+      expect(sceneKeys(ref)).toEqual([root, child, grandchild]);
+      expect(scenes[to.index].key).toBe(grandchild);
+    });
+
+    it("shows the replaced screen when going home during a back animation", () => {
+      const home = "/river/home";
+      const { ref, navigate } = mountTransitioner();
+
+      navigate(child, NAV_ACTION_PUSH);
+      finishAnimation();
+
+      navigate(root, NAV_ACTION_BACK);
+      navigate(home, NAV_ACTION_REPLACE);
+
+      const { scenes, to } = ref.current.state;
+
+      expect(scenes[to.index].key).toBe(home);
+
+      finishAnimation();
+
+      expect(sceneKeys(ref)).toEqual([home]);
+      expect(ref.current.state.animating).toBe(false);
+    });
+
+    it("shows the pushed screen when pushing during a back animation", () => {
+      const sibling = `${root}/river/sibling`;
+      const { ref, navigate } = mountTransitioner();
+
+      navigate(child, NAV_ACTION_PUSH);
+      finishAnimation();
+
+      navigate(root, NAV_ACTION_BACK);
+      navigate(sibling, NAV_ACTION_PUSH);
+
+      const { scenes, to } = ref.current.state;
+
+      expect(scenes[to.index].key).toBe(sibling);
+
+      finishAnimation();
+
+      expect(sceneKeys(ref)).not.toContain(child);
+      expect(ref.current.state.animating).toBe(false);
+    });
+
+    it("keeps both scenes when pushing during a push animation", () => {
+      const { ref, navigate } = mountTransitioner();
+
+      navigate(child, NAV_ACTION_PUSH);
+      navigate(grandchild, NAV_ACTION_PUSH);
+
+      expect(sceneKeys(ref)).toEqual([child, grandchild]);
+      expect(ref.current.state.to.index).toBe(1);
+    });
+  });
 });

package/Components/VideoLive/LiveImageManager.ts

@@ -213,10 +213,16 @@ export class LiveImageManager implements PlayerLifecycleListener {
       log_debug(
         `pauseItem: live-image not ready, ${item.playerId} - ${item.tag}`
       );
-    } else {
-      item.player.pause();
     }
 
+    // Pause even when the player is not ready yet: the underlying player may
+    // still be loading and would otherwise start playing on its own once it
+    // has buffered, leaving the live-image audible underneath the primary
+    // player. Note this is best effort - the web controller's pause() only
+    // logs while the player component is unmounted - so the player itself also
+    // refuses buffer-driven starts when it was never asked to play.
+    item.player.pause();
+
     // Fake close event, because we unmount native view
     item.player.onPlayerClose();
     item.setMode?.(LiveImageType.Image);

package/Components/VideoLive/__tests__/LiveImageManager.test.ts

@@ -1,6 +1,8 @@
 const { LiveImageManager } = require("../LiveImageManager");
 
 describe("LiveImageManager", () => {
+  const flushPromises = () => new Promise(setImmediate);
+
   it("should subscribe to LiveImageManager events", () => {
     const sampleListener = {
       id: "1",
@@ -78,4 +80,61 @@ describe("LiveImageManager", () => {
     expect(mockOnEnd1).toHaveBeenCalledWith(eventBody);
     expect(mockOnEnd2).toHaveBeenCalledWith(eventBody);
   });
+
+  it("should start a prepared live image when the mounted player loads", async () => {
+    const manager = new LiveImageManager();
+
+    const item = {
+      playerId: "live-image",
+      tag: "Live image",
+      player: {
+        playerId: "live-image",
+        playerState: { isReadyToPlay: false },
+        getEntry: jest.fn(),
+        play: jest.fn(),
+      },
+      getPlayer: jest.fn(),
+      prepareForPlayback: jest.fn().mockResolvedValue(true),
+      setMode: jest.fn(),
+    };
+
+    manager.playLiveImage(item);
+    await flushPromises();
+
+    expect(item.setMode).toHaveBeenCalledWith("video");
+    expect(item.player.play).not.toHaveBeenCalled();
+
+    manager.onLiveImageVideoLoaded(item);
+
+    expect(item.player.play).toHaveBeenCalledTimes(1);
+  });
+
+  it("should not start a live image that was paused before the player loaded", async () => {
+    const manager = new LiveImageManager();
+
+    const item = {
+      playerId: "live-image",
+      tag: "Live image",
+      player: {
+        playerId: "live-image",
+        playerState: { isReadyToPlay: false },
+        getEntry: jest.fn(),
+        play: jest.fn(),
+        pause: jest.fn(),
+        onPlayerClose: jest.fn(),
+      },
+      getPlayer: jest.fn(),
+      prepareForPlayback: jest.fn().mockResolvedValue(true),
+      setMode: jest.fn(),
+    };
+
+    manager.playLiveImage(item);
+    await flushPromises();
+    manager.pauseLiveImage(item);
+    manager.onLiveImageVideoLoaded(item);
+
+    expect(item.player.pause).toHaveBeenCalledTimes(1);
+    expect(item.player.play).not.toHaveBeenCalled();
+    expect(item.setMode).toHaveBeenLastCalledWith("image");
+  });
 });