Page MenuHomePhabricator

[native] introduced flow type for @expo/react-native-action-sheet
ClosedPublic

Authored by ginsu on Nov 2 2022, 1:05 PM.
Tags
None
Referenced Files
Unknown Object (File)
Wed, Sep 11, 2:34 AM
Unknown Object (File)
Wed, Sep 11, 2:34 AM
Unknown Object (File)
Wed, Sep 11, 2:34 AM
Unknown Object (File)
Wed, Sep 11, 2:34 AM
Unknown Object (File)
Wed, Sep 11, 2:32 AM
Unknown Object (File)
Wed, Sep 11, 2:27 AM
Unknown Object (File)
Sat, Aug 31, 10:57 PM
Unknown Object (File)
Sat, Aug 31, 10:57 PM

Details

Summary

Now that we are using @expo/react-native-action-sheet we need to introduce the following flow types to use the action sheet in our codebase. I read through the source code, and used types.ts when writing the flow types.


Linear Task: ENG-2145

Test Plan

All the testing for this diff came from its use in D5524. In that diff I was able to implement the action sheet using the flow types I created in this diff, and I received no flow errors which I believe to be a good indicator that everything is correct. I noticed in the flow docs, there was a section to write tests; however, I also noticed that the other flow-typed library definitions in our code base also don't have any tests, but if this is something we want to get done, I will take a look into it

Diff Detail

Repository
rCOMM Comm
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

ginsu requested review of this revision.Nov 2 2022, 1:18 PM
ginsu edited the test plan for this revision. (Show Details)
ginsu added reviewers: ashoat, atul.
native/flow-typed/npm/@expo/react-native-action-sheet_vx.x.x.js
17–31 ↗(On Diff #18036)

This was taken from the flow typed library definitions of bottom-tabs_v6

atul requested changes to this revision.Nov 2 2022, 6:52 PM

Can we preface property names with + to mark them as ReadOnly and use $ReadOnlyArray instead of Array if possible.

native/flow-typed/npm/@expo/react-native-action-sheet_vx.x.x.js
4–14 ↗(On Diff #18036)

We can probably cut this comment

33–43 ↗(On Diff #18036)

Shouldn't we be prefacing the property names here with + to mark them as ReadOnly?

34 ↗(On Diff #18036)

Can we use $ReadOnlyArray instead of Array? (Here and elsewhere in the file)

This revision now requires changes to proceed.Nov 2 2022, 6:52 PM

addressed atul's comments

atul requested changes to this revision.Nov 3 2022, 7:14 AM
atul added 1 blocking reviewer(s): ashoat.

Looks close, it looks like we're missing a property in ActionSheetOptions (correct me if I'm wrong) and we can make the StyleObj comment a little more informative.

Preemptively adding @ashoat as blocking reviewer because he has a lot more experience with flow.

native/flow-typed/npm/@expo/react-native-action-sheet_vx.x.x.js
5–8 ↗(On Diff #18046)

Maybe it's just me, but I feel like I don't have the sufficient context for this comment to make sense here.

Maybe instead mention what you did in the annotation:

This was taken from the flow typed library definitions of bottom-tabs_v6

?

37–38 ↗(On Diff #18046)

Should we also include

+titleTextStyle?: TextStyleProp,

?

Looks like it's included in the TypeScript type: https://github.com/expo/react-native-action-sheet/blob/fc9cefa2c15dc54e0c7fa76b7a86c46bf06c67c2/src/types.ts#L30

This revision now requires changes to proceed.Nov 3 2022, 7:14 AM

Generally looks good!! Could be something we contribute upstream to flow-typed, although they'll want tests

native/flow-typed/npm/@expo/react-native-action-sheet_vx.x.x.js
5–8 ↗(On Diff #18046)

I think @ginsu grabbed this from the React Navigation libdef

native/flow-typed/npm/@expo/react-native-action-sheet_vx.x.x.js
5–8 ↗(On Diff #18046)

@ashoat

@atul and I were discussing what the comment on lines 5-8 should be, we were wondering if we should keep this as is or change it to

This was taken from the flow typed library definitions of bottom-tabs_v6

or use something else entirely. Since you originally wrote this comment in the React Navigation libdef, we would love to hear your thoughts

native/flow-typed/npm/@expo/react-native-action-sheet_vx.x.x.js
5–8 ↗(On Diff #18046)

Honestly either way is probably fine. flow-typed has some new mechanism to share types across libdefs... at some point I'll take a look at using that to avoid copy-pasting so much between libdefs

addressed atul's feedback

This revision is now accepted and ready to land.Nov 7 2022, 6:58 AM