[No QA] Add lint rule for functional component declaration style #20724

roryabraham · 2023-06-13T22:11:56Z

Details

This really should have no effect beyond enforcing code style. Very little of this was done manually. All I did here was:

npm install --save-dev eslint-config-expensify@latest
npm run lint -- --fix
npm run prettier

Then I ran npm run lint again, and noticed that many eslint-ignore comments were removed:

Logs from second run of `npm run lint`

App on  Rory-AddLintRuleForFunctionalStyle [$?] via ⬢ v16.15.1 via 💎 v2.7.5 
➜  npm run lint         

> new.expensify@1.3.27-5 lint
> eslint . --max-warnings=0 --cache --cache-location=node_modules/.cache/eslint


/Users/roryabraham/Expensidev/App/setupOctokit.js
   1:7   error  '_' is assigned a value but never used         no-unused-vars
  13:17  error  Unexpected console statement                   no-console
  17:21  error  Unexpected console statement                   no-console
  23:17  error  Unexpected console statement                   no-console
  29:7   error  'octokit' is assigned a value but never used   no-unused-vars
  30:7   error  'graphql' is assigned a value but never used   no-unused-vars
  31:7   error  'paginate' is assigned a value but never used  no-unused-vars

/Users/roryabraham/Expensidev/App/src/components/AutoCompleteSuggestions/index.native.js
  6:41  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/components/HTMLEngineProvider/HTMLRenderers/PreRenderer/index.native.js
  7:29  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/components/KeyboardAvoidingView/index.ios.js
  8:43  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/components/SignInPageForm/index.native.js
  6:25  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/pages/iou/IOURequestPage.js
  6:31  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/stories/Banner.stories.js
  16:20  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/stories/Button.stories.js
  16:20  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/stories/ButtonWithDropdownMenu.stories.js
  16:36  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/stories/Checkbox.stories.js
  16:22  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/stories/CheckboxWithLabel.stories.js
  18:31  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/stories/Datepicker.stories.js
  26:24  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/stories/FormAlertWithSubmitButton.stories.js
  16:39  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/stories/Header.stories.js
  16:20  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/stories/HeaderWithBackButton.stories.js
  16:34  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/stories/InlineSystemMessage.stories.js
  16:33  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/stories/MagicCodeInput.stories.js
  16:28  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/stories/MenuItem.stories.js
  18:22  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/stories/SubscriptAvatar.stories.js
  29:29  error  Prop spreading is forbidden  react/jsx-props-no-spreading

/Users/roryabraham/Expensidev/App/src/stories/TextInput.stories.js
  16:23  error  Prop spreading is forbidden  react/jsx-props-no-spreading

✖ 26 problems (26 errors, 0 warnings)

So I manually added back those eslint-ignore comments in 053e8a2, then lint was passing.

Fixed Issues

$ #20643
PROPOSAL: https://expensify.slack.com/archives/C02NK2DQWUX/p1686574009182619

Tests

This touches too many files to reasonably test them individually. We should run basic smoke tests here to see that the app runs and works as expected, but we need to have some faith that the eslint rules' auto-fixer works.

Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

None. This should be covered by regression testing.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

…e the function keyword

melvin-bot · 2023-06-13T22:12:00Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

melvin-bot · 2023-06-13T22:31:29Z

@parasharrajat @marcochavezf One of you needs to 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]

roryabraham · 2023-06-13T22:34:22Z

I'm removing the C+ review from this PR because we can't really reasonably test it beyond basic smoke tests. It will be subject to regression testing on staging, and ultimately seems very unlikely to introduce any bugs.

parasharrajat · 2023-06-13T22:35:13Z

__mocks__/react-native-safe-area-context.js

-            insets={insets}
-        />
-    );
+    function WithSafeAreaInsets(props) {


Are we also changing the nested functions? Logically this is a component.

Not sure I understand ... the outer function withSafeAreaInsets is a plain function, and the inner on WithSafeAreaInsets is a functional component (because it returns a JSX element).

So the inner functional component should follow our functional component style.

So the inner functions that returns JSX should also be using function keyboard.

I can't think of why we'd make an exception here. This change looks good to me.

parasharrajat · 2023-06-13T22:48:17Z

How should this be written using function keyboard?

const EmojiPicker = forwardRef((props, ref) => {

function EmojiPicker(props) {

...
} 


export default React.forwardRef((props, ref) => (
    <EmojiPicker
        // eslint-disable-next-line react/jsx-props-no-spreading
        {...props}
        innerRef={ref}
    />
));

marcaaron · 2023-06-13T22:56:01Z

@parasharrajat I think we are only concerned about named functions and not anonymous functions. Anonymous functions should always use the arrow function syntax.

parasharrajat · 2023-06-13T23:04:29Z

Ok, Thanks. But my general question is that EmojiPicker is a class component and we are refactoring this into a functional component in #20187. Should we be following a syntax like

const EmojiPicker = forwardRef((props, ref) => { which has forwarding ref? or define the component using the function keyword and fowardRef separately as mentioned in the above comment.

marcochavezf · 2023-06-14T00:10:14Z

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 / Chrome
- iOS / native
- iOS / 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(themeColors.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 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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

marcochavezf

I scanned all the files quickly, and the changes LGTM. Also did some smoke tests and looks good.

OSBotify · 2023-06-14T00:23:29Z

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

roryabraham · 2023-06-14T00:26:36Z

@parasharrajat My inclination would be that we do this:

function EmojiPicker() {
    ...
}

export default React.forwardRef((props, ref) => (
    <EmojiPicker
        // eslint-disable-next-line react/jsx-props-no-spreading
        {...props}
        innerRef={ref}
    />
));

But I think technically either can be valid. As @marcaaron said, anonymous function components like the one passed as an argument to React.forwardRef should be arrow functions.

marcaaron · 2023-06-14T01:31:06Z

@parasharrajat my 2 cents are that forwardRef() is a function that returns a component which gets assigned to a variable. Not really same thing as a function definition.

OSBotify · 2023-06-14T21:25:59Z

🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.3.28-0 🚀

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

OSBotify · 2023-06-16T18:41:07Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

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

roryabraham added 2 commits June 13, 2023 15:02

Update eslint-config-expensify to latest

f371f02

Use eslint --fix and prettier to update all function components to us…

b8aeec0

…e the function keyword

roryabraham self-assigned this Jun 13, 2023

Manually add back eslint-ignore comments for props spreading

053e8a2

roryabraham marked this pull request as ready for review June 13, 2023 22:30

roryabraham requested a review from a team as a code owner June 13, 2023 22:30

melvin-bot bot requested review from marcochavezf and parasharrajat and removed request for a team June 13, 2023 22:31

roryabraham removed the request for review from parasharrajat June 13, 2023 22:34

parasharrajat reviewed Jun 13, 2023

View reviewed changes

roryabraham mentioned this pull request Jun 13, 2023

[HOLD for payment 2023-06-23] Standardize our functional component declaration style via a lint rule #20643

Closed

parasharrajat mentioned this pull request Jun 13, 2023

Refactor the EmojiPicker to a functional component #20187

Merged

57 tasks

marcochavezf approved these changes Jun 14, 2023

View reviewed changes

marcochavezf merged commit a275e3d into main Jun 14, 2023

marcochavezf deleted the Rory-AddLintRuleForFunctionalStyle branch June 14, 2023 00:16

OSBotify mentioned this pull request Jun 14, 2023

Deploy Checklist: New Expensify 2023-06-14 #20782

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Add lint rule for functional component declaration style #20724

[No QA] Add lint rule for functional component declaration style #20724

roryabraham commented Jun 13, 2023 •

edited

Loading

melvin-bot bot commented Jun 13, 2023

melvin-bot bot commented Jun 13, 2023

roryabraham commented Jun 13, 2023

parasharrajat Jun 13, 2023 •

edited

Loading

roryabraham Jun 13, 2023

parasharrajat Jun 13, 2023

marcaaron Jun 13, 2023 •

edited

Loading

parasharrajat commented Jun 13, 2023 •

edited

Loading

marcaaron commented Jun 13, 2023

parasharrajat commented Jun 13, 2023

marcochavezf commented Jun 14, 2023 •

edited

Loading

marcochavezf left a comment

OSBotify commented Jun 14, 2023

roryabraham commented Jun 14, 2023

marcaaron commented Jun 14, 2023

OSBotify commented Jun 14, 2023

OSBotify commented Jun 16, 2023

[No QA] Add lint rule for functional component declaration style #20724

[No QA] Add lint rule for functional component declaration style #20724

Conversation

roryabraham commented Jun 13, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 13, 2023

melvin-bot bot commented Jun 13, 2023

roryabraham commented Jun 13, 2023

parasharrajat Jun 13, 2023 • edited Loading

Choose a reason for hiding this comment

roryabraham Jun 13, 2023

Choose a reason for hiding this comment

parasharrajat Jun 13, 2023

Choose a reason for hiding this comment

marcaaron Jun 13, 2023 • edited Loading

Choose a reason for hiding this comment

parasharrajat commented Jun 13, 2023 • edited Loading

marcaaron commented Jun 13, 2023

parasharrajat commented Jun 13, 2023

marcochavezf commented Jun 14, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

marcochavezf left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 14, 2023

roryabraham commented Jun 14, 2023

marcaaron commented Jun 14, 2023

OSBotify commented Jun 14, 2023

OSBotify commented Jun 16, 2023

roryabraham commented Jun 13, 2023 •

edited

Loading

parasharrajat Jun 13, 2023 •

edited

Loading

marcaaron Jun 13, 2023 •

edited

Loading

parasharrajat commented Jun 13, 2023 •

edited

Loading

marcochavezf commented Jun 14, 2023 •

edited

Loading