[TS migration] Create centralized types for API params #34542

blazejkustra · 2024-01-15T22:12:19Z

Details

Currently, we're defining a type for API params before each use of that API endpoint. This could lead to inconsistent application of API params and might make it difficult to know the params (and associated types) accepted by each API endpoint.

This PR aims to fix it, define all commands and it's parameters in one global place.

Fixed Issues

$ #33965
PROPOSAL: N/A

Tests

Test the app throughly, ideally all features that use network requests.
Manually check commands defined in src/libs/API/types.ts, and compare it with what was used in API.write and API.read before

Offline tests

N/A

QA Steps

Same as tests

PR Author Checklist

Screenshots/Videos

Android: Native

android.webm

Android: mWeb Chrome

android-web.webm

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-web.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

…ping

kubabutkiewicz

lgtm, like that similar approach that we have in ONYXKEYS 😄

fabioh8010

Nice job! 🚀

melvin-bot · 2024-01-23T09:34:09Z

@s77rt Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

blazejkustra · 2024-01-23T09:37:36Z

@s77rt Have a look at this Pr once you find some time. We need to be careful for any regressions. Please check manually every API.write and API.read, that new values in src/libs/API/types.ts are correct. This touches all request in the app, so that's a lot to check.

blazejkustra · 2024-01-24T17:57:52Z

@s77rt Done!

blazejkustra · 2024-01-25T21:28:05Z

@s77rt Kind bump

s77rt · 2024-01-25T22:18:07Z

Missing commands:

WRITE:

CreateDistanceRequest
UpdateMoneyRequestDate
UpdateMoneyRequestBillable
UpdateMoneyRequestMerchant
UpdateMoneyRequestTag
UpdateMoneyRequestDistance
UpdateMoneyRequestCategory
UpdateMoneyRequestDescription
UpdateDistanceRequest
RequestMoney
SplitBill
SplitBillAndOpenReport
StartSplitBill
CompleteSplitBill
EditMoneyRequest
UpdateMoneyRequestAmountAndCurrency
DeleteMoneyRequest
SendMoneyElsewhere
SendMoneyWithWallet
ApproveMoneyRequest
SubmitReport
PayMoneyRequestWithWallet
PayMoneyRequest
DetachReceipt
ReplaceReceipt
RestartBankAccountSetup

Those commands are coming from js files. Are we planning to write types for those api endpoints once we need to? i.e. when we migrate the js files to ts

s77rt · 2024-01-25T23:28:34Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

mweb-chrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

mweb-safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

s77rt · 2024-01-25T23:32:07Z

Manually check commands defined in src/libs/API/types.ts

I don't think that's necessary since we are still sending the same data (any non-data errors should be caught by typescript)

blazejkustra · 2024-01-26T07:28:27Z

Those commands are coming from js files. Are we planning to write types for those api endpoints once we need to? i.e. when we migrate the js files to ts

Yes, that's the plan.

blazejkustra · 2024-01-26T07:28:46Z

@roryabraham Back to you (before merging let's sync main, please ping me on slack)

blazejkustra · 2024-01-26T09:36:42Z

Manually check commands defined in src/libs/API/types.ts

I don't think that's necessary since we are still sending the same data (any non-data errors should be caught by typescript)

@s77rt I think that is crucial to check every command in READ_COMMANDS, WRITE_COMMANDS and SIDE_EFFECT_REQUEST_COMMANDS that the values are the same as before. Such mistake could cause api calls to fail in runtime, we need to double check that.

s77rt · 2024-01-26T10:20:25Z

@blazejkustra I did check the commands names. In the previous comment I meant to refer to the command parameters.

blazejkustra · 2024-01-26T10:27:33Z

Thank you! We should be good then, I also run some regexes and scripts to check that names are indeed the same.

roryabraham

ok, played with this a bit and it all seems to make sense and work as expected. Thanks @blazejkustra

As a reviewer, I did kind of regret conceding to do this in one big PR. I'm a bit more nervous merging this and not as confident that we didn't miss some small mistake somewhere. In the future let's try to take the time to break things up better.

roryabraham · 2024-01-26T17:42:51Z

Pretty sure the reassure failure is a red herring / not caused by this PR.

melvin-bot · 2024-01-26T17:43:01Z

@roryabraham looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

OSBotify · 2024-01-26T17:47:02Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-01-29T19:24:15Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.33-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	cancelled 🔪
🕸 web 🕸	success ✅

OSBotify · 2024-01-31T02:31:06Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.33-5 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

blazejkustra added 13 commits January 15, 2024 22:31

Prepare centralized setup for API

dce5acc

Add all read commands

44c85c5

Fix lint

d6bd5f2

Add remaining write commands

feb1d36

Change write string commands

c2f3bc0

Remove all Params types

25e962a

Add Write params to separate files

240994a

Fix parameters files

dd6068d

Add remaining write commands values to the WriteCommandParameters map…

fa5891d

…ping

Merge branch 'main' into ts/centralized-api-types

0a994a9

Correct some of the files manually

b996dda

Add remaining write params

7dd5f0b

Fix typecheck

e98c37c

This was referenced Jan 17, 2024

Add full screen engagement modal to NewDot #32154

Merged

[$250] [HOLD for payment 2024-02-07] Create centralized types for API params #33965

Closed

filip-solecki approved these changes Jan 18, 2024

View reviewed changes

kubabutkiewicz approved these changes Jan 18, 2024

View reviewed changes

fabioh8010 approved these changes Jan 18, 2024

View reviewed changes

blazejkustra added 2 commits January 23, 2024 09:47

Merge branch 'main' into ts/centralized-api-types

bc873ab

Final API refactors, use const commands

8444a4d

blazejkustra marked this pull request as ready for review January 23, 2024 09:34

blazejkustra requested a review from a team as a code owner January 23, 2024 09:34

melvin-bot bot requested review from s77rt and removed request for a team January 23, 2024 09:34

blazejkustra added 4 commits January 23, 2024 10:43

Cast to string[]

7e2f4b6

Create Policy API params

3d1cc81

Add missing policy params

7261fc2

Update api mapping after adding Policy

263b558

blazejkustra added 4 commits January 24, 2024 19:14

Merge branch 'main' into ts/centralized-api-types

38dea6e

Add new write commands

57c421f

Retrigger actions

4a1e5a4

Merge branch 'main' into ts/centralized-api-types

66d668b

s77rt approved these changes Jan 25, 2024

View reviewed changes

melvin-bot bot requested a review from roryabraham January 25, 2024 23:36

Merge branch 'main' into ts/centralized-api-types

c5aac10

Merge branch 'main' into ts/centralized-api-types

c8f663a

roryabraham approved these changes Jan 26, 2024

View reviewed changes

roryabraham merged commit d4db5fc into Expensify:main Jan 26, 2024
14 of 15 checks passed

melvin-bot bot added the Emergency label Jan 26, 2024

roryabraham removed the Emergency label Jan 26, 2024

github-actions bot mentioned this pull request Jan 29, 2024

Deploy Checklist: New Expensify 2024-01-29 #35328

Closed

fabioh8010 mentioned this pull request Feb 6, 2024

[TS Migration] Improve Form #35584

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Create centralized types for API params #34542

[TS migration] Create centralized types for API params #34542

blazejkustra commented Jan 15, 2024 •

edited

Loading

kubabutkiewicz left a comment

fabioh8010 left a comment

melvin-bot bot commented Jan 23, 2024

blazejkustra commented Jan 23, 2024 •

edited

Loading

blazejkustra commented Jan 24, 2024

blazejkustra commented Jan 25, 2024

s77rt commented Jan 25, 2024

s77rt commented Jan 25, 2024

s77rt commented Jan 25, 2024 •

edited

Loading

blazejkustra commented Jan 26, 2024

blazejkustra commented Jan 26, 2024 •

edited

Loading

blazejkustra commented Jan 26, 2024

s77rt commented Jan 26, 2024

blazejkustra commented Jan 26, 2024

roryabraham left a comment

roryabraham commented Jan 26, 2024

melvin-bot bot commented Jan 26, 2024

OSBotify commented Jan 26, 2024

OSBotify commented Jan 29, 2024

OSBotify commented Jan 31, 2024

[TS migration] Create centralized types for API params #34542

[TS migration] Create centralized types for API params #34542

Conversation

blazejkustra commented Jan 15, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

kubabutkiewicz left a comment

Choose a reason for hiding this comment

fabioh8010 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jan 23, 2024

blazejkustra commented Jan 23, 2024 • edited Loading

blazejkustra commented Jan 24, 2024

blazejkustra commented Jan 25, 2024

s77rt commented Jan 25, 2024

s77rt commented Jan 25, 2024

Reviewer Checklist

Screenshots/Videos

s77rt commented Jan 25, 2024 • edited Loading

blazejkustra commented Jan 26, 2024

blazejkustra commented Jan 26, 2024 • edited Loading

blazejkustra commented Jan 26, 2024

s77rt commented Jan 26, 2024

blazejkustra commented Jan 26, 2024

roryabraham left a comment

Choose a reason for hiding this comment

roryabraham commented Jan 26, 2024

melvin-bot bot commented Jan 26, 2024

OSBotify commented Jan 26, 2024

OSBotify commented Jan 29, 2024

OSBotify commented Jan 31, 2024

blazejkustra commented Jan 15, 2024 •

edited

Loading

blazejkustra commented Jan 23, 2024 •

edited

Loading

s77rt commented Jan 25, 2024 •

edited

Loading

blazejkustra commented Jan 26, 2024 •

edited

Loading