[No QA][TS Migration] Add comments for remaining properties in Onyx types #41956

pac-guerreiro · 2024-05-09T21:19:04Z

Details

This PR aims to add descriptions for every Onyx type and property in the codebase. It also add a ESLint rule to enforces every Onyx type and its properties to have a comment explaining its purpose.

As discussed here, QBO and Xero typings will be handled in a follow up issue.

Fixed Issues

$ #39129
PROPOSAL: N/A

Tests

N/A

Offline tests

N/A

QA Steps

N/A

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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.

Screenshots/Videos

Android: Native

N/A

Android: mWeb Chrome

N/A

iOS: Native

N/A

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

N/A

MacOS: Desktop

N/A

src/pages/settings/Wallet/ExpensifyCardPage.tsx

src/types/onyx/BankAccount.ts

src/types/onyx/BlockedFromConcierge.ts

src/types/onyx/Fund.ts

src/types/onyx/IOU.ts

fabioh8010 · 2024-05-12T18:37:58Z

src/types/onyx/Policy.ts

 name: string;
 };

 /**
 * Data imported from QuickBooks Online.
 */
 type QBOConnectionData = {
+ /** TODO: I think this value can be changed to `ValueOf<CONST.COUNTRY>` */


Putting comment here for me to get back to this later.

Let's test it or leave as it is

src/types/onyx/Policy.ts

src/types/onyx/WalletOnfido.ts

…-remaining-onyx-types # Conflicts: # src/types/onyx/Policy.ts # src/types/onyx/Report.ts # src/types/onyx/ReportAction.ts

…-remaining-onyx-types # Conflicts: # src/types/onyx/IOU.ts

…-remaining-onyx-types

blazejkustra

Overall a massive improvement, let's aim to get rid of all TODOs in the code and have some internal eyes on the PR 🙌

src/types/onyx/WalletAdditionalDetails.ts

src/types/onyx/TransactionViolation.ts

src/types/onyx/Transaction.ts

src/types/onyx/Response.ts

src/libs/ReportUtils.ts

src/pages/settings/Wallet/ExpensifyCardPage.tsx

…-remaining-onyx-types

blazejkustra

Almost LGTM, let's aim to remove all TODOs by either removing the properties or adding minimal context on them.

blazejkustra · 2024-05-28T07:01:14Z

src/types/onyx/IOU.ts

 isSender?: boolean;
+
+ /** TODO: I think this type could be changes to `IOUType` */


Let's try it then 👍

blazejkustra · 2024-05-28T07:01:48Z

src/types/onyx/Report.ts

+ /** TODO: Doesn't exist in the app */
 managerEmail?: string;
+
+ /** TODO: Doesn't exist in the app */
 parentReportActionIDs?: number[];


I think you can remove these fields

blazejkustra · 2024-05-28T07:02:17Z

src/types/onyx/Report.ts

 text?: string;
+
+ /** TODO: Doesn't exist in the app */


Not used in the app, let's remove

blazejkustra · 2024-05-28T07:03:19Z

src/types/onyx/ReportAction.ts

+ /** TODO: Only used in tests */
 whisperedTo?: number[];
+
+ /** TODO: Only used in tests */
 reactions?: Reaction[];


It's used in src/libs/ReportActionsUtils.ts, let's add the context for these props

blazejkustra · 2024-05-28T07:27:02Z

src/types/onyx/ReportAction.ts

+ /** TODO: not enough context, seems to be used in tests only */
 automatic?: boolean;

+ /** TODO: Not enough context, seems to be used in tests only */
 shouldShow?: boolean;


I'm pretty sure we could remove both, but it would take a lot of refactor in ReportUtils.ts and tests. How about marking these as @depracated with explanation?

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

src/types/onyx/ReportAction.ts

@@ -169,25 +192,52 @@ type ReportActionBase = OnyxCommon.OnyxValueWithOfflineFeedback<{
 /** The user's ID */
 accountID?: number;

+ /** TODO: Doesn't exist in the app */


Let's remove if it's not used, same for other TODOs like this

fabioh8010

Looking real good, but there are still many properties with TODOs, let's solve them

Confirming if they need to be there or just remove them
For the testing properties, remove TODO word and make it clear is used for testing purposes
For the ones that could be a different type, either test it or leave as it is

src/types/onyx/IOU.ts

fabioh8010 · 2024-05-28T08:47:31Z

src/types/onyx/OriginalMessage.ts

 type OriginalMessageApproved = {
 actionName: typeof CONST.REPORT.ACTIONS.TYPE.APPROVED;
+
+ /** TODO: I think the type should match the scructure of `originalMessage` in `buildOptimisticApprovedReportAction` */


Let's test this or if not possible, leave unknown

fabioh8010 · 2024-05-28T08:48:00Z

src/types/onyx/OriginalMessage.ts

 type ReimbursementDeQueuedMessage = {
+ /** TODO: I'd replace this type with `ValueOf<typeof CONST.REPORT.CANCEL_PAYMENT_REASONS>` */


Could you test this?

fabioh8010 · 2024-05-28T08:48:44Z

src/types/onyx/OriginalMessage.ts

+ /** TODO: Doesn't exist in the app */
 edits?: string[];
+
+ /** TODO: Doesn't exist in the app */
 childReportID?: string;
+
+ /** TODO: Doesn't exist in the app */
 isDeletedParentAction?: boolean;
+
+ /** TODO: Doesn't exist in the app */
 flags?: Record<FlagSeverityName, FlagSeverity[]>;
+
+ /** TODO: Doesn't exist in the app */
 moderationDecisions?: Decision[];
+
+ /** TODO: Only used in tests */
 whisperedTo: number[];
+
+ /** TODO: Doesn't exist in the app */
 reactions?: Reaction[];


Let's confirm if they have some purpose or just remove from the App, expect whisperedTo (change the comment to remove TODO)

fabioh8010 · 2024-05-28T08:52:14Z

src/types/onyx/OriginalMessage.ts

+ /** TODO: I think this type could be changed to `ValueOf<typeof CONST.REPORT.ACTIONABLE_MENTION_JOIN_WORKSPACE_RESOLUTION>` */
+ /** What was the invited user decision */
 choice: string;
+
+ /** TODO: Doesn't exist in the app */
 email: string;
+
+ /** TODO: Doesn't exist in the app */
 inviterEmail: string;
+
+ /** TODO: Only used in tests */
 lastModified: string;
+
+ /** TODO: Doesn't exist in the app */
 policyID: string;


Same for the TODOs, confirm to remove the unused, remove TODO word from testing ones

fabioh8010 · 2024-05-28T08:52:27Z

src/types/onyx/OriginalMessage.ts

 transactionID: string;
+
+ /** TODO: Only used in tests */


Remove TODO word from testing ones

fabioh8010 · 2024-05-28T08:52:54Z

src/types/onyx/OriginalMessage.ts

 type OriginalMessageReimbursementDequeued = {
 actionName: typeof CONST.REPORT.ACTIONS.TYPE.REIMBURSEMENT_DEQUEUED;
+
+ /** TODO: I think this type should be `ReimbursementDeQueuedMessage` */


Either test it or leave as it is

fabioh8010 · 2024-05-28T08:57:16Z

src/types/onyx/Policy.ts

 type TaxCode = {
+ /** TODO: Not used in app */
 totalTaxRateVal: string;
+
+ /** TODO: Not used in app */
 simpleName: string;
+
+ /** TODO: Not used in app */
 taxCodeRef: string;
+
+ /** TODO: Not used in app */
 taxRateRefs: Record<string, string>;
+
+ /** TODO: Not used in app */
+ /** Name of the tax code */
 name: string;
 };


Nothing is used here? Is this type even being used at all?

fabioh8010 · 2024-05-28T08:57:32Z

src/types/onyx/Policy.ts

 name: string;
 };

 /**
 * Data imported from QuickBooks Online.
 */
 type QBOConnectionData = {
+ /** TODO: I think this value can be changed to `ValueOf<CONST.COUNTRY>` */


Let's test it or leave as it is

…-remaining-onyx-types # Conflicts: # src/types/onyx/Policy.ts

…-remaining-onyx-types

pac-guerreiro · 2024-06-03T22:36:20Z

@cead22 do you know anyone that can help by providing descriptions to the remaining Xero and Quickbooks online type declarations? Thanks 🙌

hayata-suenaga · 2024-06-04T14:00:56Z

For properties in Policy that are related to QBO and Xero, I can add comments to them in a follow up PP as discussed here

Issue created -> #43033

…-remaining-onyx-types # Conflicts: # src/types/onyx/OriginalMessage.ts # src/types/onyx/Transaction.ts

fabioh8010

@pac-guerreiro There are still TODOs on these three files, let's get them done and open the PR asap

fabioh8010 · 2024-06-05T18:50:27Z

src/libs/ReportActionsUtils.ts

@@ -1205,7 +1205,7 @@ function isActionableJoinRequest(reportAction: OnyxEntry<ReportAction>): reportA
 */
 function isActionableJoinRequestPending(reportID: string): boolean {
 const sortedReportActions = getSortedReportActions(Object.values(getAllReportActions(reportID)));
- const findPendingRequest = sortedReportActions.find((reportActionItem) => isActionableJoinRequest(reportActionItem) && reportActionItem.originalMessage.choice === '');
+ const findPendingRequest = sortedReportActions.find((reportActionItem) => isActionableJoinRequest(reportActionItem) && reportActionItem.originalMessage.choice === '' as ValueOf<typeof CONST.REPORT.ACTIONABLE_MENTION_JOIN_WORKSPACE_RESOLUTION>);


Lets create a type for ValueOf<typeof CONST.REPORT.ACTIONABLE_MENTION_JOIN_WORKSPACE_RESOLUTION> and use it here.

fabioh8010 · 2024-06-05T18:50:40Z

src/pages/home/report/ReportActionItem.tsx

- if (!isActionableWhisper && (!ReportActionsUtils.isActionableJoinRequest(action) || action.originalMessage.choice !== '')) {
+ if (
+ !isActionableWhisper &&
+ (!ReportActionsUtils.isActionableJoinRequest(action) || action.originalMessage.choice !== ('' as ValueOf<typeof CONST.REPORT.ACTIONABLE_MENTION_JOIN_WORKSPACE_RESOLUTION>))


…comments

…-remaining-onyx-types # Conflicts: # src/pages/home/report/ReportFooter.tsx

…eir properties

…-remaining-onyx-types # Conflicts: # src/types/onyx/IOU.ts

…-remaining-onyx-types

…r/39129-add-comments-to-remaining-onyx-types

melvin-bot · 2024-06-07T17:11:26Z

@getusha 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]

mountiny

@pac-guerreiro Thank you very much, this must have been hard to put together. I am going to merge this now to avoid conflicts but please address my comments in a new PR

mountiny · 2024-06-07T20:31:50Z

src/types/onyx/OriginalMessage.ts

 amount: number;
+
+ /** Optional comment */
 comment?: string;


NAB: I think the comment is optional so it can be an empty string but the property would be returned always

Suggested change

comment?: string;

comment: string;

mountiny · 2024-06-07T20:33:15Z

src/types/onyx/OriginalMessage.ts

 decision: DecisionName;
+
+ /** When was the decision name */


Suggested change

/** When was the decision name */

/** When was the decision made */

mountiny · 2024-06-07T20:36:03Z

src/types/onyx/OriginalMessage.ts

+ /** Currency of the approved expense amount */
+ currency: string;
+
+ /** Report ID of the expense */


I think we have to be a bit careful with use of expense / expense report. Expense = transaction and you can have a transaction thread.

In this case the report action refers to the expense report so we should make it clear to remove any doubts

Suggested change

/** Report ID of the expense */

/** Report ID of the expense report*/

mountiny · 2024-06-07T20:36:10Z

src/types/onyx/OriginalMessage.ts

+
+ /** Content of the original message */
+ originalMessage: {
+ /** Approved expense amount */


Suggested change

/** Approved expense amount */

/** Approved expense report amount */

mountiny · 2024-06-07T20:36:16Z

src/types/onyx/OriginalMessage.ts

+ /** Approved expense amount */
+ amount: number;
+
+ /** Currency of the approved expense amount */


Suggested change

/** Currency of the approved expense amount */

/** Currency of the approved expense report amount */

mountiny · 2024-06-07T20:47:44Z

src/types/onyx/TransactionViolation.ts

 type TransactionViolation = {
+ /** Type of transaction violation ('violation', 'notice', 'warning', ...) */


Lets add these into CONST to get stricter here

mountiny · 2024-06-07T20:51:18Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

OSBotify · 2024-06-07T21:05:42Z

✋ 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-06-11T23:31:37Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.81-11 🚀

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

docs: add onyx types descriptions

5b9433c

fabioh8010 reviewed May 12, 2024

View reviewed changes

fabioh8010 mentioned this pull request May 13, 2024

[HOLD for payment 2024-06-20] [HOLD for payment 2024-06-18] [TS Migration] Add comments for remaining properties in Onyx types #39129

Closed

pac-guerreiro added 6 commits May 14, 2024 00:23

docs: add missing onyx types descriptions

4dac52f

Merge branch 'main' into pac-guerreiro/refactor/39129-add-comments-to…

ee11f2e

…-remaining-onyx-types # Conflicts: # src/types/onyx/Policy.ts # src/types/onyx/Report.ts # src/types/onyx/ReportAction.ts

Merge branch 'main' into pac-guerreiro/refactor/39129-add-comments-to…

8631fa8

…-remaining-onyx-types # Conflicts: # src/types/onyx/IOU.ts

docs: add missing type descriptions

13029ae

Merge branch 'main' into pac-guerreiro/refactor/39129-add-comments-to…

3494545

…-remaining-onyx-types

docs: apply pull request suggestions

96f6955

blazejkustra suggested changes May 21, 2024

View reviewed changes

pac-guerreiro added 5 commits May 22, 2024 10:14

refactor: apply pull request suggestions

65022fb

refactor: apply pull request suggestions

f3e1c8f

refactor: remove unused property from wallet additional details

530d6d6

docs: add missing type description

9a50d43

Merge branch 'main' into pac-guerreiro/refactor/39129-add-comments-to…

611266d

…-remaining-onyx-types

pac-guerreiro changed the title ~~[TS Migration] Add comments for remaining properties in Onyx types~~ [No QA][TS Migration] Add comments for remaining properties in Onyx types May 24, 2024

pac-guerreiro added 4 commits May 24, 2024 13:15

chore: resolve pending descriptions

a4d4102

Merge branch 'main' into pac-guerreiro/refactor/39129-add-comments-to…

8025926

…-remaining-onyx-types

docs: apply suggestions

5599455

docs: apply suggestions

2d91475

pac-guerreiro requested review from fabioh8010 and blazejkustra May 27, 2024 22:37

blazejkustra suggested changes May 28, 2024

View reviewed changes

fabioh8010 reviewed May 28, 2024

View reviewed changes

pac-guerreiro added 3 commits May 31, 2024 12:42

Merge branch 'main' into pac-guerreiro/refactor/39129-add-comments-to…

da515a8

…-remaining-onyx-types # Conflicts: # src/types/onyx/Policy.ts

Merge branch 'main' into pac-guerreiro/refactor/39129-add-comments-to…

530b1ce

…-remaining-onyx-types

refactor: apply pull request suggestions

68ce115

hayata-suenaga mentioned this pull request Jun 4, 2024

Add comments to the properties in Policy that are related to QBO and Xero #43033

Open

Merge branch 'main' into pac-guerreiro/refactor/39129-add-comments-to…

279e50a

…-remaining-onyx-types # Conflicts: # src/types/onyx/OriginalMessage.ts # src/types/onyx/Transaction.ts

pac-guerreiro changed the title ~~[No QA][TS Migration] Add comments for remaining properties in Onyx types~~ [WIP][No QA][TS Migration] Add comments for remaining properties in Onyx types Jun 5, 2024

fabioh8010 reviewed Jun 5, 2024

View reviewed changes

pac-guerreiro added 5 commits June 5, 2024 21:05

chore: apply pull request suggestions and address types with missing …

9fe6712

…comments

Merge branch 'main' into pac-guerreiro/refactor/39129-add-comments-to…

c46d709

…-remaining-onyx-types # Conflicts: # src/pages/home/report/ReportFooter.tsx

chore: enable eslint rule that requires comments on onyx types and th…

6dabcc0

…eir properties

Merge branch 'main' into pac-guerreiro/refactor/39129-add-comments-to…

11090bd

…-remaining-onyx-types # Conflicts: # src/types/onyx/IOU.ts

refactor: apply pull request suggestions

453343e

fabioh8010 approved these changes Jun 7, 2024

View reviewed changes

Merge branch 'main' into pac-guerreiro/refactor/39129-add-comments-to…

98fa483

…-remaining-onyx-types

pac-guerreiro changed the title ~~[WIP][No QA][TS Migration] Add comments for remaining properties in Onyx types~~ [No QA][TS Migration] Add comments for remaining properties in Onyx types Jun 7, 2024

fabioh8010 added 2 commits June 7, 2024 18:03

Fix lint errors and improve comments

a354239

Merge remote-tracking branch 'origin/main' into pac-guerreiro/refacto…

199e228

…r/39129-add-comments-to-remaining-onyx-types

pac-guerreiro marked this pull request as ready for review June 7, 2024 17:11

pac-guerreiro requested a review from a team as a code owner June 7, 2024 17:11

melvin-bot bot requested review from getusha and removed request for a team June 7, 2024 17:11

mountiny assigned pac-guerreiro Jun 7, 2024

mountiny approved these changes Jun 7, 2024

View reviewed changes

mountiny removed the request for review from getusha June 7, 2024 20:51

mountiny merged commit 5297302 into Expensify:main Jun 7, 2024
16 of 17 checks passed

github-actions bot mentioned this pull request Jun 10, 2024

Deploy Checklist: New Expensify 2024-06-10 #43344

Closed

pac-guerreiro mentioned this pull request Jun 11, 2024

[No QA][TS Migration] Follow up - Add comments for remaining properties in Onyx types #43499

Merged

48 tasks

		isSender?: boolean;

		/** TODO: I think this type could be changes to `IOUType` */

		type ReimbursementDeQueuedMessage = {
		/** TODO: I'd replace this type with `ValueOf<typeof CONST.REPORT.CANCEL_PAYMENT_REASONS>` */

	/** When was the decision name */
	/** When was the decision made */

	/** Report ID of the expense */
	/** Report ID of the expense report*/

	/** Approved expense amount */
	/** Approved expense report amount */

	/** Currency of the approved expense amount */
	/** Currency of the approved expense report amount */

		type TransactionViolation = {
		/** Type of transaction violation ('violation', 'notice', 'warning', ...) */

[No QA][TS Migration] Add comments for remaining properties in Onyx types #41956

[No QA][TS Migration] Add comments for remaining properties in Onyx types #41956

Conversation

pac-guerreiro commented May 9, 2024 • edited by mountiny Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blazejkustra left a comment

Choose a reason for hiding this comment

blazejkustra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabioh8010 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pac-guerreiro commented Jun 3, 2024

hayata-suenaga commented Jun 4, 2024 • edited Loading

fabioh8010 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

melvin-bot bot commented Jun 7, 2024

mountiny left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mountiny commented Jun 7, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Jun 7, 2024

OSBotify commented Jun 11, 2024

pac-guerreiro commented May 9, 2024 •

edited by mountiny

Loading

hayata-suenaga commented Jun 4, 2024 •

edited

Loading

mountiny commented Jun 7, 2024 •

edited

Loading