[No QA] fix: Allow private_ prefix lint rule for variable naming #54937

nkdengineer · 2025-01-08T07:25:47Z

Explanation of Change

Fixed Issues

$ #54822
PROPOSAL: #54822 (comment)

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

Verify that no errors appear in the JS console

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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2025-01-08T15:42:42Z

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

ZhenjaHorbach · 2025-01-08T16:32:47Z

src/libs/OptionsListUtils.ts

        return ReportUtils.shouldReportBeInOptionList({
            report,
-            currentReportId: topmostReportId,
+            currentReportId: topmostReportId ?? '',


Do we need these changes ?
After this PR, undefined is a valid value
#54936

so could you update the branch to the latest version of main and remove all unnecessary changes, please ?

thanks @ZhenjaHorbach, i updated

ZhenjaHorbach · 2025-01-08T16:40:01Z

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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

NA

Android: mWeb Chrome

NA

iOS: Native

NA

iOS: mWeb Safari

NA

MacOS: Chrome / Safari

NA

MacOS: Desktop

NA

ZhenjaHorbach · 2025-01-10T07:41:21Z

@nkdengineer
Could you check this comment ?

nkdengineer · 2025-01-13T03:19:52Z

Will give an update soon

ZhenjaHorbach · 2025-01-13T09:02:08Z

LGTM !

srikarparsi · 2025-01-13T22:18:02Z

Hi @nkdengineer, looks like there's a conflict.

nkdengineer · 2025-01-14T08:26:33Z

Oops, looks like we have a new lint rule here

nkdengineer · 2025-01-14T09:00:25Z

@srikarparsi @ZhenjaHorbach This problem requires too many code changes. I think we should create a new issue to fix it.

ZhenjaHorbach · 2025-01-14T10:40:27Z

@srikarparsi @ZhenjaHorbach This problem requires too many code changes. I think we should create a new issue to fix it.

We have a discussion about it
I think it should be fixed soon !

ZhenjaHorbach · 2025-01-14T11:32:43Z

@nkdengineer
But wait
Following this thread let's fix it

nkdengineer · 2025-01-14T15:38:09Z

This problem requires too many code changes. I think we should create a new issue to fix it.

@ZhenjaHorbach what do you think about my suggestion here, It can be up to more than 3000 changes. Because we need to fix all 19 files that we changed in this PR and there are some very long files like OptionsListUtils.ts and SidebarUtils.ts

ZhenjaHorbach · 2025-01-14T15:49:44Z

This problem requires too many code changes. I think we should create a new issue to fix it.

@ZhenjaHorbach what do you think about my suggestion here, It can be up to more than 3000 changes.

Oh
Yeah
Good question
I agree that it is better to create a separate issue for file utilities to fix imports
But on the other hand, we are already working on a technical task in this PR

@srikarparsi
What do you think ?

srikarparsi · 2025-01-14T23:02:43Z

@nkdengineer how did you come up with the 3000 changes number?

Also, can you please merge main and check if there are any other occurrences of disabling lint for private_isArchvied that's no longer needed? Checking because we recently merged this PR.

nkdengineer · 2025-01-15T07:57:44Z

@nkdengineer how did you come up with the 3000 changes number?

@srikarparsi I just tried to fix lint for OptionsListUtils.ts file and it has about 300 changes. And we have about 7 files to fix. I think it could be more than 1000 changes.

Also, can you please merge main and check if there are any other occurrences of disabling lint for private_isArchvied that's no longer needed? Checking because we recently merged this PR

I have merged the main branch, and there are no other occurrences of disabling lint for private_isArchived that need to be removed.

srikarparsi · 2025-01-16T16:09:16Z

Asked internally (Slack)

ZhenjaHorbach · 2025-01-21T09:51:26Z

@srikarparsi
Actually we have a similar case
And it looks like ok to just merge

ZhenjaHorbach · 2025-01-21T09:55:49Z

@nkdengineer
And we have conflicts
Could you please fix this?

srikarparsi · 2025-01-21T18:05:42Z

Yup, looks okay to merge (Slack) once conflicts are fixed

srikarparsi

code looks good, going to merge without eslint passing since it's a large number of files

melvin-bot · 2025-01-22T05:24:22Z

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

srikarparsi · 2025-01-22T05:25:20Z

Left comment here, ESLint on changed files wasn't passing

OSBotify · 2025-01-22T05:32:44Z

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

ZhenjaHorbach · 2025-01-22T11:41:24Z

@nkdengineer
You missed something when fixed conflicts
0738ac7#diff-7d43f3c3e4decdb0057928e895f456d51c0f4081837edd5e2c4ed7ddd570e274R774

I think there is no point in creating a new PR to fix this
But fix this in any other PR, please

github-actions · 2025-01-23T18:27:29Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 9.0.89-0 🚀

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

github-actions · 2025-01-28T01:50:53Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.89-8 🚀

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

fix: Allow private_ prefix lint rule for variable naming

15c19e7

nkdengineer changed the title ~~fix: Allow private_ prefix lint rule for variable naming~~ [No QA] fix: Allow private_ prefix lint rule for variable naming Jan 8, 2025

nkdengineer added 2 commits January 8, 2025 22:28

fix lint

7f38acc

fix lint

1929db1

nkdengineer marked this pull request as ready for review January 8, 2025 15:42

nkdengineer requested a review from a team as a code owner January 8, 2025 15:42

melvin-bot bot requested review from ZhenjaHorbach and removed request for a team January 8, 2025 15:42

ZhenjaHorbach reviewed Jan 8, 2025

View reviewed changes

nkdengineer added 2 commits January 13, 2025 10:28

Merge branch 'main' into fix/54822

8726d00

fix lint

c1eb41c

ZhenjaHorbach approved these changes Jan 13, 2025

View reviewed changes

melvin-bot bot requested a review from srikarparsi January 13, 2025 09:02

fix lint

4d82930

Merge branch 'main' into fix/54822

5905542

fix conflict

0738ac7

srikarparsi approved these changes Jan 22, 2025

View reviewed changes

srikarparsi merged commit 73f2714 into Expensify:main Jan 22, 2025
15 of 16 checks passed

melvin-bot bot added the Emergency label Jan 22, 2025

srikarparsi removed the Emergency label Jan 22, 2025

github-actions bot mentioned this pull request Jan 23, 2025

Deploy Checklist: New Expensify 2025-01-23 #55657

Closed

melvin-bot bot mentioned this pull request Jan 28, 2025

[Due for payment 2025-02-25] [HOLD for payment 2025-02-xx] Allow "private_" prefix lint rule for variable naming #54822

Closed

[No QA] fix: Allow private_ prefix lint rule for variable naming #54937

[No QA] fix: Allow private_ prefix lint rule for variable naming #54937

Uh oh!

Conversation

nkdengineer commented Jan 8, 2025

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Jan 8, 2025

Uh oh!

ZhenjaHorbach Jan 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nkdengineer Jan 13, 2025

Choose a reason for hiding this comment

Uh oh!

ZhenjaHorbach commented Jan 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

ZhenjaHorbach commented Jan 10, 2025

Uh oh!

nkdengineer commented Jan 13, 2025

Uh oh!

ZhenjaHorbach commented Jan 13, 2025

Uh oh!

srikarparsi commented Jan 13, 2025

Uh oh!

nkdengineer commented Jan 14, 2025

Uh oh!

nkdengineer commented Jan 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ZhenjaHorbach commented Jan 14, 2025

Uh oh!

ZhenjaHorbach commented Jan 14, 2025

Uh oh!

nkdengineer commented Jan 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ZhenjaHorbach commented Jan 14, 2025

Uh oh!

srikarparsi commented Jan 14, 2025

Uh oh!

nkdengineer commented Jan 15, 2025

Uh oh!

srikarparsi commented Jan 16, 2025

Uh oh!

ZhenjaHorbach commented Jan 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ZhenjaHorbach commented Jan 21, 2025

Uh oh!

srikarparsi commented Jan 21, 2025

Uh oh!

srikarparsi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

melvin-bot bot commented Jan 22, 2025

Uh oh!

srikarparsi commented Jan 22, 2025

Uh oh!

OSBotify commented Jan 22, 2025

Uh oh!

ZhenjaHorbach commented Jan 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jan 23, 2025

Uh oh!

github-actions bot commented Jan 28, 2025

Uh oh!

Reviewers

ZhenjaHorbach Jan 8, 2025 •

edited

Loading

ZhenjaHorbach commented Jan 8, 2025 •

edited

Loading

nkdengineer commented Jan 14, 2025 •

edited

Loading

nkdengineer commented Jan 14, 2025 •

edited

Loading

ZhenjaHorbach commented Jan 21, 2025 •

edited

Loading

ZhenjaHorbach commented Jan 22, 2025 •

edited

Loading