[Bug]: Setting `animateOnMount={false}` and a non-zero `index` throws an out of bounds error

[seba1342]

Version

v5

Reanimated Version

v3

Gesture Handler Version

v2

Platforms

iOS

What happened?

When setting animateOnMount={false} and providing an index that is greater than 0 with an array of snapPoints that has at least 2 snap points it throws the following error:
'index' was provided but out of the provided snap points range! expected value to be between -1, 0

This is replicable while setting either enableDynamicSizing as true or false.

Reproduction steps

1. Render a BottomSheet with animateOnMount={false} and provide a couple snapPoints:

<BottomSheet
        enableDynamicSizing={false}
        animateOnMount={false}
        snapPoints={[200, 500]}
        index={1}>
        <BottomSheetScrollView>
        ...
        </BottomSheetScrollView>
      </BottomSheet>

2. Set index to be greater than 0 (but still a valid option in the snapPoint array.

3. Get 'index' was provided but out of the provided snap points range! expected value to be between -1, 0 error even though snapPoints[1] is a valid array option.

Reproduction sample

https://snack.expo.dev/@seba1342/bottom-sheet---issue-reproduction-template

Relevant log output

'index' was provided but out of the provided snap points range! expected value to be between -1, 0

[seba1342]

From some initial investigation this seems to be causes by the fact that the INITIAL_SNAP_POINT = -999 which breaks the .length lookup.

A patch I am trialling is to not only just check the animatedSnapPoints.value to determine a valid index but also to check the _providedSnapPoints length too.

diff --git a/node_modules/@gorhom/bottom-sheet/src/components/bottomSheet/BottomSheet.tsx b/node_modules/@gorhom/bottom-sheet/src/components/bottomSheet/BottomSheet.tsx
index a6f048e..9e06e8d 100644
--- a/node_modules/@gorhom/bottom-sheet/src/components/bottomSheet/BottomSheet.tsx
+++ b/node_modules/@gorhom/bottom-sheet/src/components/bottomSheet/BottomSheet.tsx
@@ -1028,8 +1040,9 @@ const BottomSheetComponent = forwardRef<BottomSheet, BottomSheetProps>(
       animationConfigs?: WithSpringConfig | WithTimingConfig
     ) {
       const snapPoints = animatedSnapPoints.value;
+
       invariant(
-        index >= -1 && index <= snapPoints.length - 1,
+        index >= -1 && (index <= snapPoints.length - 1 || (Array.isArray(_providedSnapPoints) && index <= _providedSnapPoints?.length -1)),
         `'index' was provided but out of the provided snap points range! expected value to be between -1, ${
           snapPoints.length - 1
         }`

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

[gorhom]

this should be fixed in the next release

[gorhom]

https://github.com/gorhom/react-native-bottom-sheet/releases/tag/v5.1.6

[seba1342]

@gorhom thank you 💕