@momo-kits/foundation 0.89.5 → 0.92.1-tracking.2

package/Application/BottomTab.tsx

@@ -8,7 +8,7 @@ import {NavigationContainer} from '@react-navigation/native';
 import {Icon} from '../Icon';
 import {Text} from '../Text';
 import {ApplicationContext} from './index';
-import {getStackOptions} from './utils';
+import {getAccessibilityID, getStackOptions} from './utils';
 import StackScreen from './StackScreen';
 
 const Tab = createBottomTabNavigator();
@@ -58,8 +58,11 @@ const BottomTab: React.FC<BottomTabProps> = ({
     });
   }, []);
 
+  const accessibilityID = getAccessibilityID("tbr_main_bottom")
+
   return (
     <Tab.Navigator
+        {...accessibilityID}
       initialRouteName={initialRouteName}
       backBehavior={'firstRoute'}
       tabBarOptions={{
@@ -72,8 +75,10 @@ const BottomTab: React.FC<BottomTabProps> = ({
         },
       }}>
       {tabs.map(item => {
+          const itemAccessibilityID = getAccessibilityID(`btn_tabbar_${item.name}`)
         return (
           <Tab.Screen
+              {...itemAccessibilityID}
             key={item.name}
             name={item.name}
             component={TabScreen}

package/Application/Components.tsx

@@ -29,6 +29,7 @@ import {scaleSize, Text} from '../Text';
 import {Icon} from '../Icon';
 import {PopupNotify} from '../Popup';
 import {Badge, BadgeDot} from '../Badge';
+import {getAccessibilityID} from "./utils";
 
 const NavigationButton: React.FC<NavigationButtonProps> = ({
   icon,
@@ -37,6 +38,7 @@ const NavigationButton: React.FC<NavigationButtonProps> = ({
   useBorder = true,
   badgeType,
   badgeValue,
+    accessibilityID = ''
 }) => {
   const {theme} = useContext(ApplicationContext);
   let buttonStyle: ViewStyle = {backgroundColor: '#00000066'};
@@ -63,8 +65,9 @@ const NavigationButton: React.FC<NavigationButtonProps> = ({
     }
   }, [badgeType, badgeValue]);
 
+  const ID = getAccessibilityID(accessibilityID)
   return (
-    <View style={{width: scaleSize(28)}}>
+    <View {...ID} style={{width: scaleSize(28)}}>
       <TouchableOpacity
         style={[styles.navigationButton, buttonStyle]}
         onPress={onPress}>
@@ -120,13 +123,19 @@ const HeaderLeft: React.FC<HeaderBackProps> = ({
     const goBack = () => {
       const canGoBack = navigator?.ref.current?.canGoBack();
       if (!canGoBack) {
-        const currentRoute = navigator?.ref?.current.getCurrentRoute();
-        navigator?.maxApi?.trackEvent?.('service_icon_clicked', {
+        const currentRoute = navigator?.ref?.current?.getCurrentRoute?.();
+        const params = {
           ...context,
           screen_name: currentRoute?.params?.screen?.name ?? currentRoute?.name,
           trigger_id: '111154000000000000',
           icon_name: 'back',
+        };
+        navigator?.maxApi?.showToastDebug?.({
+          appId: context.appId,
+          message: 'service_icon_clicked',
+          params,
         });
+        navigator?.maxApi?.trackEvent?.('service_icon_clicked', params);
       }
       if (canGoBack) {
         navigator?.ref.current?.goBack();
@@ -160,10 +169,10 @@ const HeaderLeft: React.FC<HeaderBackProps> = ({
     }
     return true;
   };
-
   return (
-    <View style={styles.headerLeft}>
+    <View  style={styles.headerLeft}>
       <NavigationButton
+          accessibilityID = "btn_navigation_back"
         icon="ic_back"
         tintColor={tintColor}
         onPress={goBackSafe}
@@ -363,6 +372,7 @@ const HeaderToolkitAction: React.FC<any> = ({
     if (pinTool)
       return (
         <NavigationButton
+            accessibilityID  = "btn_navigation_pin"
           icon={pinTool.icon as string}
           tintColor={tintColor}
           badgeValue={badgeValue}
@@ -380,7 +390,6 @@ const HeaderToolkitAction: React.FC<any> = ({
         />
       );
   };
-
   if (toolConfig) {
     return (
       <View style={styles.headerRightButton}>
@@ -393,11 +402,15 @@ const HeaderToolkitAction: React.FC<any> = ({
               borderWidth: backgroundColor ? 0.5 : 0,
             },
           ]}>
-          <TouchableOpacity onPress={onMore}>
+          <TouchableOpacity
+              {...getAccessibilityID("btn_navigation_more")}
+              onPress={onMore}>
             <Icon color={tintColor} source="navigation_more_horiz" size={20} />
           </TouchableOpacity>
           <View style={[styles.divider, {backgroundColor: tintColor}]} />
-          <TouchableOpacity onPress={onClose}>
+          <TouchableOpacity
+              {...getAccessibilityID("btn_navigation_close")}
+              onPress={onClose}>
             <Icon
               color={tintColor}
               source="16_navigation_close_circle"

package/Application/NavigationContainer.tsx

@@ -23,10 +23,12 @@ const NavigationContainer: React.FC<NavigationContainerProps> = ({
   options,
   maxApi,
   localization,
+  params,
 }) => {
   const context = useContext(MiniAppContext);
-  const navigationRef = React.useRef<NavigationContainerRef>(null);
-  const navigator = useRef(new Navigator(navigationRef));
+  const navigationRef = useRef<NavigationContainerRef>(null);
+  const isReady = useRef(false);
+  const navigator = useRef(new Navigator(navigationRef, isReady));
   const [showGrid, setShowGrid] = useState(false);
   const config = useRef<any>();
 
@@ -89,12 +91,15 @@ const NavigationContainer: React.FC<NavigationContainerProps> = ({
               },
             }}
             ref={navigator.current?.ref}
+            onReady={() => {
+              isReady.current = true;
+            }}
             independent={true}>
             <Stack.Navigator initialRouteName="Stack" headerMode="screen">
               <Stack.Screen
                 name="Stack"
                 component={StackScreen}
-                initialParams={{screen}}
+                initialParams={{screen, params}}
                 options={{...getStackOptions(), ...options}}
               />
               <Stack.Screen

package/Application/Navigator.ts

@@ -8,13 +8,15 @@ import {
 
 class Navigator {
   ref?: any;
+  isReady?: any;
   toolkitConfig?: HeaderToolkitProps;
   maxApi?: any;
   dismissData?: any;
   toolkitCallback?: (item: any) => void;
 
-  constructor(navigation: any) {
+  constructor(navigation: any, isReady: any) {
     this.ref = navigation;
+    this.isReady = isReady;
   }
 
   /**
@@ -22,7 +24,9 @@ class Navigator {
    * @param params
    */
   push = (params: ScreenParams) => {
-    this.ref.current.dispatch(StackActions.push('Stack', params));
+    if (this.isReady.current) {
+      this.ref.current.dispatch(StackActions.push('Stack', params));
+    }
   };
 
   /**
@@ -30,14 +34,18 @@ class Navigator {
    * @param params
    */
   replace = (params: ScreenParams) => {
-    this.ref.current.dispatch(StackActions.replace('Stack', params));
+    if (this.isReady.current) {
+      this.ref.current.dispatch(StackActions.replace('Stack', params));
+    }
   };
   /**
    * pop to dismiss a screen
    * @param count
    */
   pop = (count?: number) => {
-    this.ref.current.dispatch(StackActions.pop(count ?? 1));
+    if (this.isReady.current) {
+      this.ref.current.dispatch(StackActions.pop(count ?? 1));
+    }
   };
 
   /**
@@ -45,7 +53,9 @@ class Navigator {
    * @param params
    */
   present = (params: ScreenParams) => {
-    this.ref.current.dispatch(StackActions.push('Dialog', params));
+    if (this.isReady.current) {
+      this.ref.current.dispatch(StackActions.push('Dialog', params));
+    }
   };
 
   /**
@@ -53,7 +63,9 @@ class Navigator {
    * @param params
    */
   showModal = (params: ModalParams) => {
-    this.ref.current.dispatch(StackActions.push('Modal', params));
+    if (this.isReady.current) {
+      this.ref.current.dispatch(StackActions.push('Modal', params));
+    }
   };
 
   /**
@@ -61,19 +73,23 @@ class Navigator {
    * @param params
    */
   showBottomSheet = (params: BottomSheetParams) => {
-    this.ref.current.dispatch(
-      StackActions.push('Modal', {
-        ...params,
-        isBottomSheet: true,
-      }),
-    );
+    if (this.isReady.current) {
+      this.ref.current.dispatch(
+        StackActions.push('Modal', {
+          ...params,
+          isBottomSheet: true,
+        }),
+      );
+    }
   };
 
   /**
    * pop all screen route
    */
   popToTop = () => {
-    this.ref.current.dispatch(StackActions.popToTop());
+    if (this.isReady.current) {
+      this.ref.current.dispatch(StackActions.popToTop());
+    }
   };
 
   /**
@@ -82,12 +98,14 @@ class Navigator {
    * @param params
    */
   navigate = (name: string, params: any) => {
-    this.ref.current.dispatch(
-      CommonActions.navigate({
-        name,
-        params,
-      }),
-    );
+    if (this.isReady.current) {
+      this.ref.current.dispatch(
+        CommonActions.navigate({
+          name,
+          params,
+        }),
+      );
+    }
   };
 
   /**
@@ -95,18 +113,20 @@ class Navigator {
    * @param params
    */
   reset = (params: ScreenParams) => {
-    this.ref.current.dispatch(
-      CommonActions.reset({
-        index: 0,
-        routes: [
-          {
-            name: 'Stack',
-            key: `Stack_${new Date().getTime()}`,
-            params,
-          },
-        ],
-      }),
-    );
+    if (this.isReady.current) {
+      this.ref.current.dispatch(
+        CommonActions.reset({
+          index: 0,
+          routes: [
+            {
+              name: 'Stack',
+              key: `Stack_${new Date().getTime()}`,
+              params,
+            },
+          ],
+        }),
+      );
+    }
   };
 
   /**

package/Application/StackScreen.tsx

@@ -1,29 +1,49 @@
-import React, {useContext, useEffect, useLayoutEffect} from 'react';
+import React, {useContext, useEffect, useLayoutEffect, useRef} from 'react';
 import {ScreenParams} from './types';
 import Navigation from './Navigation';
 import {ApplicationContext, MiniAppContext} from './index';
 import {GridSystem} from '../Layout';
 import {useHeaderHeight} from '@react-navigation/stack';
+import {Alert, InteractionManager} from 'react-native';
+
+const {
+  ScreenContext,
+} = require('react-native/Libraries/Components/ScreenContext');
 
 const StackScreen: React.FC<ScreenParams> = props => {
   const {theme, showGrid, navigator} = useContext(ApplicationContext);
+  const startTime = useRef(Date.now());
+  const endTime = useRef(Date.now());
+  const timeLoad = useRef(0);
+  const timeout = useRef<any>();
+
   const context = useContext(MiniAppContext);
 
-  const {screen: Component, options}: ScreenParams = props.route.params;
+  const {screen: Component, options, params}: ScreenParams = props.route.params;
   const navigation = new Navigation(props.navigation, theme);
   const heightHeader = useHeaderHeight();
 
-  const params = {
+  const data = {
     ...props.route.params,
+    params,
     navigation,
   };
 
-  delete params.screen;
+  delete data.screen;
 
   /**
    * set options for screen
    */
   useLayoutEffect(() => {
+    startTime.current = Date.now();
+    InteractionManager.runAfterInteractions(() => {
+      navigator?.maxApi?.showToastDebug?.({
+        appId: context.appId,
+        message: `${Component.name} screen_interaction_time ${
+          Date.now() - startTime.current
+        }`,
+      });
+    });
     if (options) {
       navigation.setOptions(options);
     }
@@ -33,6 +53,15 @@ const StackScreen: React.FC<ScreenParams> = props => {
    * tracking for screen
    */
   useEffect(() => {
+    if (__DEV__) {
+      if (!Component.name || Component.name === 'screen') {
+        Alert.alert(
+          'Design system',
+          `Unvalidated screen name "${Component.name}" !`,
+        );
+      }
+    }
+
     const tracking = {
       ...context,
       screen_name: Component.name,
@@ -45,26 +74,57 @@ const StackScreen: React.FC<ScreenParams> = props => {
       pre_screen_name = routes[routesLength - 2]?.params?.screen?.name;
     }
 
-    navigator?.maxApi?.trackEvent?.('service_frame_displayed', {
+    const params = {
       ...tracking,
       pre_screen_name,
       trigger_id: '111378000000000000',
+    };
+    navigator?.maxApi?.trackEvent?.('service_frame_displayed', params);
+    navigator?.maxApi?.showToastDebug?.({
+      appId: context.appId,
+      message: `${Component.name} service_frame_displayed`,
+      params,
     });
 
     return props.navigation.addListener('beforeRemove', () => {
-      navigator?.maxApi?.trackEvent?.('service_icon_clicked', {
+      const params = {
         ...tracking,
         trigger_id: '111154000000000000',
         icon_name: 'back',
+      };
+      navigator?.maxApi?.trackEvent?.('service_icon_clicked', params);
+      navigator?.maxApi?.showToastDebug?.({
+        appId: context.appId,
+        message: `${Component.name} service_icon_clicked`,
+        params,
       });
     });
   }, []);
 
   return (
-    <>
-      <Component heightHeader={heightHeader} {...params} />
+    <ScreenContext.Provider
+      value={{
+        appId: context.appId,
+        code: context.code,
+        screenName: Component.name,
+        autoTracking: (data: any) => {
+          navigator?.maxApi?.dispatchFunction?.('autoTracking', data);
+        },
+        onElementLoad: () => {
+          endTime.current = Date.now();
+          clearTimeout(timeout.current);
+          timeout.current = setTimeout(() => {
+            timeLoad.current = endTime.current - startTime.current;
+            navigator?.maxApi?.showToastDebug?.({
+              appId: context.appId,
+              message: `${Component.name} screen_load_time ${timeLoad.current}`,
+            });
+          }, 1000);
+        },
+      }}>
+      <Component heightHeader={heightHeader} {...data} />
       {showGrid && <GridSystem />}
-    </>
+    </ScreenContext.Provider>
   );
 };
 

package/Application/types.ts

@@ -94,6 +94,7 @@ export type NavigationContainerProps = {
   options?: NavigationOptions;
   theme: Theme;
   maxApi: any;
+  params: Record<string, any>;
   localization?: LocalizationObject;
 };
 
@@ -129,6 +130,7 @@ export type NavigationButtonProps = {
   onPress: () => void;
   badgeType?: 'dot' | 'number';
   badgeValue?: number;
+  accessibilityID?: string;
 };
 
 export type PinnedToolType = {

package/Application/utils.tsx

@@ -12,7 +12,8 @@ import {
 } from './Components';
 import {NavigationOptions, Theme} from './types';
 import {Colors} from '../Consts';
-
+import {Platform} from 'react-native';
+const isIOS = Platform.OS === 'ios';
 /**
  * default options for stack screen
  */
@@ -126,6 +127,7 @@ const getOptions = (params: NavigationOptions, theme: Theme) => {
     };
   }
 
+  if (params.toolkitParams) {
     options = {
       ...options,
       headerRight: (props: any) => {
@@ -139,6 +141,7 @@ const getOptions = (params: NavigationOptions, theme: Theme) => {
         );
       },
     };
+  }
 
   return {
     ...params,
@@ -146,4 +149,60 @@ const getOptions = (params: NavigationOptions, theme: Theme) => {
   };
 };
 
-export {getStackOptions, getDialogOptions, getModalOptions, getOptions};
+const getAccessibilityID = (key = '') => {
+  if (isIOS) {
+    return {
+      accessible: true,
+      testID: key,
+    };
+  } else {
+    return {
+      accessibilityLabel: key,
+    };
+  }
+};
+
+const formatComponentName = (word: string) => {
+  const accentsMap = {
+    a: 'á|à|ả|ã|ạ|â|ấ|ầ|ẩ|ẫ|ậ|ă|ắ|ằ|ẳ|ẵ|ặ',
+    A: 'Á|À|Ả|Ã|Ạ|Â|Ấ|Ầ|Ẩ|Ẫ|Ậ|Ă|Ắ|Ằ|Ẳ|Ẵ|Ặ',
+    e: 'é|è|ẻ|ẽ|ẹ|ê|ế|ề|ể|ễ|ệ',
+    E: 'É|È|Ẻ|Ẽ|Ẹ|Ê|Ế|Ề|Ể|Ễ|Ệ',
+    i: 'í|ì|ỉ|ĩ|ị',
+    I: 'Í|Ì|Ỉ|Ĩ|Ị',
+    o: 'ó|ò|ỏ|õ|ọ|ô|ố|ồ|ổ|ỗ|ộ|ơ|ớ|ờ|ở|ỡ|ợ',
+    O: 'Ó|Ò|Ỏ|Õ|Ọ|Ô|Ố|Ồ|Ổ|Ỗ|Ộ|Ơ|Ớ|Ờ|Ở|Ỡ|Ợ',
+    u: 'ú|ù|ủ|ũ|ụ|ư|ứ|ừ|ử|ữ|ự',
+    U: 'Ú|Ù|Ủ|Ũ|Ụ|Ư|Ứ|Ừ|Ử|Ữ|Ự',
+    y: 'ý|ỳ|ỷ|ỹ|ỵ',
+    Y: 'Ý|Ỳ|Ỷ|Ỹ|Ỵ',
+    d: 'đ',
+    D: 'Đ',
+  };
+
+  for (const [nonAccent, accentGroup] of Object.entries(accentsMap)) {
+    const accents = new RegExp(accentGroup, 'g');
+    word = word.replace(accents, nonAccent);
+  }
+
+  word = word.replace(/\s+/g, '_').toLowerCase();
+
+  return word;
+};
+
+const formatNameLength = (name: string) => {
+  let formattedName = name;
+  if (formattedName.length > 100) {
+    formattedName = formattedName.substring(0, 100);
+  }
+  return formattedName;
+};
+export {
+  getStackOptions,
+  getDialogOptions,
+  getModalOptions,
+  getOptions,
+  formatComponentName,
+  formatNameLength,
+  getAccessibilityID,
+};

package/Button/index.tsx

@@ -6,15 +6,19 @@ import {
   TouchableOpacityProps,
   View,
 } from 'react-native';
-
 import LinearGradient from 'react-native-linear-gradient';
-import {ApplicationContext} from '../Application';
+import {ApplicationContext, MiniAppContext} from '../Application';
 import {Text} from '../Text';
 import {Typography} from '../Text/types';
 import {Colors, Spacing} from '../Consts';
 import styles from './styles';
 import {Icon} from '../Icon';
 import {Loader} from '../Loader';
+import {formatComponentName, getAccessibilityID} from '../Application/utils';
+
+const {
+  ScreenContext,
+} = require('react-native/Libraries/Components/ScreenContext');
 
 const AnimationLinear = Animated.createAnimatedComponent(LinearGradient);
 
@@ -70,6 +74,10 @@ export interface ButtonProps extends TouchableOpacityProps {
    *  A callback function that is called when the button is pressed.
    */
   onPress: () => void;
+
+  params?: any;
+
+  componentId?: string;
 }
 
 const Button: FC<ButtonProps> = ({
@@ -82,9 +90,13 @@ const Button: FC<ButtonProps> = ({
   loading = false,
   title = 'Button',
   onPress,
+  params,
+  componentId,
+  accessibilityLabel,
   ...rest
 }) => {
   const {theme, config} = useContext(ApplicationContext);
+  const {appId, code} = useContext(MiniAppContext)
   const {gradient, color} = config?.navigationBar?.buttonColors ?? {};
   let gradientPros;
   if (gradient?.length > 0 && type == 'primary') {
@@ -94,6 +106,8 @@ const Button: FC<ButtonProps> = ({
       end: {x: 0, y: 0.5},
     };
   }
+
+  const screenInfo = useContext<any>(ScreenContext);
   const getSizeStyle = () => {
     const styleSheet: {[key: string]: any} = styles;
     return styleSheet[size ?? 'small'];
@@ -289,21 +303,37 @@ const Button: FC<ButtonProps> = ({
   };
 
   const activeOpacity = type === 'disabled' ? 0.75 : 0.5;
-
+  const accessibilityID = getAccessibilityID(`${appId}|${screenInfo.screenName}|btn_${title}`)
   return (
-    <TouchableOpacity
-      {...rest}
-      activeOpacity={activeOpacity}
-      onPress={onPressButton}
-      style={buttonStyle}>
-      {renderLeading()}
-      {renderTitle()}
-      {renderTrailing()}
-      {gradientPros && (
-        <AnimationLinear {...gradientPros} style={styles.gradientView} />
-      )}
-      {gradientPros && <View style={styles.strokeView} />}
-    </TouchableOpacity>
+    <ScreenContext.Provider
+      value={{
+        ...screenInfo,
+        componentName: 'Button',
+        params,
+        state: loading
+          ? 'loading'
+          : type === 'disabled'
+          ? 'disabled'
+          : 'enabled',
+        componentId,
+        componentValue: formatComponentName(title),
+        action: 'click',
+      }}>
+      <TouchableOpacity
+        {...rest}
+        {...accessibilityID}
+        activeOpacity={activeOpacity}
+        onPress={onPressButton}
+        style={buttonStyle}>
+        {renderLeading()}
+        {renderTitle()}
+        {renderTrailing()}
+        {gradientPros && (
+          <AnimationLinear {...gradientPros} style={styles.gradientView} />
+        )}
+        {gradientPros && <View style={styles.strokeView} />}
+      </TouchableOpacity>
+    </ScreenContext.Provider>
   );
 };