Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: Update eslint-config-expensify to 2.0.49 #42650

Conversation

kacper-mikolajczak
Copy link
Contributor

@kacper-mikolajczak kacper-mikolajczak commented May 27, 2024

Details

Introduces new custom eslint rule Expensify/eslint-config-expensify#97

Fixed Issues

$ #42414
PROPOSAL: https://callstack-hq.slack.com/archives/C05LX9D6E07/p1715847620457489

Tests

  • Verify that no errors appear in the console

Considering nature of this PR, I would not rely on any specific manual test suite.

Offline tests

QA Steps

  • Verify that no errors appear in the JS console

Considering nature of this PR, I would not rely on any specific manual test suite.

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 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 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 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.

Screenshots/Videos

Android: Native
android.mp4
Android: mWeb Chrome
android_web.mp4
iOS: Native
iOS: mWeb Safari
ios_web.mp4
MacOS: Chrome / Safari
web.mp4
MacOS: Desktop
desktop.mp4

@mountiny
Copy link
Contributor

Thanks! lets get through the failing linter cases tomorrow

@fabioh8010
Copy link
Contributor

@kacper-mikolajczak Here's a diff to fix the TS errors

diff --git a/src/libs/actions/Policy.ts b/src/libs/actions/Policy.ts
index 0ff60458bd..6521497eae 100644
--- a/src/libs/actions/Policy.ts
+++ b/src/libs/actions/Policy.ts
@@ -2115,7 +2115,7 @@ function createDraftInitialWorkspace(policyOwnerEmail = '', policyName = '', pol
 }
 
 function buildOptimisticPolicyCategories(policyID: string, categories: readonly string[]) {
-    const optimisticCategoryMap = categories.reduce((acc, category) => {
+    const optimisticCategoryMap = categories.reduce<Record<string, Partial<PolicyCategory>>>((acc, category) => {
         acc[category] = {
             name: category,
             enabled: true,
@@ -2125,7 +2125,7 @@ function buildOptimisticPolicyCategories(policyID: string, categories: readonly
         return acc;
     }, {});
 
-    const successCategoryMap = categories.reduce((acc, category) => {
+    const successCategoryMap = categories.reduce<Record<string, Partial<PolicyCategory>>>((acc, category) => {
         acc[category] = {
             errors: null,
             pendingAction: null,
@@ -2133,7 +2133,7 @@ function buildOptimisticPolicyCategories(policyID: string, categories: readonly
         return acc;
     }, {});
 
-    const failureCategoryMap = categories.reduce((acc, category) => {
+    const failureCategoryMap = categories.reduce<Record<string, Partial<PolicyCategory>>>((acc, category) => {
         acc[category] = {
             errors: ErrorUtils.getMicroSecondOnyxError('workspace.categories.createFailureMessage'),
             pendingAction: null,
@@ -2510,7 +2510,7 @@ function createDraftWorkspace(policyOwnerEmail = '', makeMeAdmin = false, policy
         {
             onyxMethod: Onyx.METHOD.SET,
             key: `${ONYXKEYS.COLLECTION.POLICY_CATEGORIES_DRAFT}${policyID}`,
-            value: CONST.POLICY.DEFAULT_CATEGORIES.reduce((acc, category) => {
+            value: CONST.POLICY.DEFAULT_CATEGORIES.reduce<Record<string, PolicyCategory>>((acc, category) => {
                 acc[category] = {
                     name: category,
                     enabled: true,
diff --git a/src/pages/ReimbursementAccount/utils/getSubstepValues.ts b/src/pages/ReimbursementAccount/utils/getSubstepValues.ts
index 442e7d72bd..f89625c613 100644
--- a/src/pages/ReimbursementAccount/utils/getSubstepValues.ts
+++ b/src/pages/ReimbursementAccount/utils/getSubstepValues.ts
@@ -3,15 +3,19 @@ import type {ReimbursementAccountForm} from '@src/types/form';
 import type {ReimbursementAccount} from '@src/types/onyx';
 import type {ACHData} from '@src/types/onyx/ReimbursementAccount';
 
-function getSubstepValues<T extends keyof ReimbursementAccountForm>(
-    inputKeys: Record<string, T>,
+type SubstepValues<TProps extends keyof ReimbursementAccountForm> = {
+    [TKey in TProps]: ReimbursementAccountForm[TKey];
+};
+
+function getSubstepValues<TProps extends keyof ReimbursementAccountForm>(
+    inputKeys: Record<string, TProps>,
     reimbursementAccountDraft: OnyxEntry<ReimbursementAccountForm>,
     reimbursementAccount: OnyxEntry<ReimbursementAccount>,
-): {[K in T]: ReimbursementAccountForm[K]} {
+): SubstepValues<TProps> {
     return Object.entries(inputKeys).reduce((acc, [, value]) => {
-        acc[value] = reimbursementAccountDraft?.[value] ?? reimbursementAccount?.achData?.[value as keyof ACHData] ?? '';
+        acc[value] = (reimbursementAccountDraft?.[value] ?? reimbursementAccount?.achData?.[value as keyof ACHData] ?? '') as ReimbursementAccountForm[TProps];
         return acc;
-    }, {} as {[K in T]: ReimbursementAccountForm[K]});
+    }, {} as SubstepValues<TProps>);
 }
 
 export default getSubstepValues;
diff --git a/src/types/onyx/PolicyCategory.ts b/src/types/onyx/PolicyCategory.ts
index d65d507656..d4162bfdcd 100644
--- a/src/types/onyx/PolicyCategory.ts
+++ b/src/types/onyx/PolicyCategory.ts
@@ -5,23 +5,23 @@ type PolicyCategory = OnyxCommon.OnyxValueWithOfflineFeedback<{
     name: string;
 
     /** Unencoded name of a category */
-    unencodedName: string;
+    unencodedName?: string;
 
     /** Flag that determines if a category is active and able to be selected */
     enabled: boolean;
 
     /** If true, not adding a comment to a transaction with this category will trigger a violation */
-    areCommentsRequired: boolean;
+    areCommentsRequired?: boolean;
 
     /** "General Ledger code" that corresponds to this category in an accounting system. Similar to an ID. */
     // eslint-disable-next-line @typescript-eslint/naming-convention
     'GL Code'?: string;
 
     /** An ID for this category from an external accounting system */
-    externalID: string;
+    externalID?: string;
 
     /** The external accounting service that this category comes from */
-    origin: string;
+    origin?: string;
 
     /** The old category name of the category when we edit the category name */
     previousCategoryName?: string;

@kacper-mikolajczak kacper-mikolajczak marked this pull request as ready for review May 29, 2024 13:33
@kacper-mikolajczak kacper-mikolajczak requested a review from a team as a code owner May 29, 2024 13:33
@melvin-bot melvin-bot bot removed the request for review from a team May 29, 2024 13:33
Copy link

melvin-bot bot commented May 29, 2024

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

@melvin-bot melvin-bot bot requested a review from DylanDylann May 29, 2024 13:33
@kacper-mikolajczak
Copy link
Contributor Author

@mountiny PR is ready for review 👍

@mountiny
Copy link
Contributor

@DylanDylann lets get this reviewed

@DylanDylann
Copy link
Contributor

DylanDylann commented May 31, 2024

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

@DylanDylann
Copy link
Contributor

@mountiny I think we need to add label [No QA] in the title for this PR

Copy link
Contributor

@DylanDylann DylanDylann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything look good

@kacper-mikolajczak
Copy link
Contributor Author

Thanks for review @DylanDylann!

@mountiny before we merge this one, I am going to check the results of reassure tests because they seem off a bit.

@mountiny
Copy link
Contributor

Thanks, let us know how the analysis will go, they seem to show a bit of a slow down

@kacper-mikolajczak
Copy link
Contributor Author

kacper-mikolajczak commented May 31, 2024

@mountiny if it is possible, could you please share results from reassure dashboard view? I wonder how tests fluctuate between different commits. Thanks!

I've checked different PRs (1 & 2) and the results there seem to be quite different every time.

Also, when re-running the tests in this PR the outcome is different from the initial run.

Throughout the time, do you know how stable the measurments were? If the tests are not reliable then it's quite hard to base anything on them.

After re-running the tests I'd say PR is ready for the next step, but I am still interested in what's up with reassure tests. Thanks!

@mountiny
Copy link
Contributor

mountiny commented Jun 2, 2024

This is how it looks like @kacper-mikolajczak

image

I think there are some fluctuations, I have noticed that the PR number graph is not correct, there is one jump I can see now in the list at 17:40 but the PR number in the graph is not the actual PR number

image

#42355 is an issue @rinej

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will move this ahead, but we still have work to be done with the reassure to be of a better use for us I think

Watch out for any regressions

thank you!

@mountiny mountiny merged commit f701c3e into Expensify:main Jun 2, 2024
17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jun 2, 2024

✋ 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
Copy link
Contributor

OSBotify commented Jun 6, 2024

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.79-11 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants