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

Setup App for TypeScript #20179

Merged

Conversation

blazejkustra
Copy link
Contributor

@blazejkustra blazejkustra commented Jun 5, 2023

Details

  • TSConfig, Eslint, webpack, babel configured
  • Github actions for type checking
  • Installed all typescript dependencies
  • Removed unused “save” dependency
  • Install dependencies that are used but weren’t installed before

Related Issue

$ #20626

Tests

This touches the project globally, there are no files to reasonably test individually. We should run basic smoke tests here to see that the app runs and works as expected.

Check that all scripts listed in package.json works as expected.

  • 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

  • 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 / Chrome
    • iOS / native
    • iOS / 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
web.1.mov
Mobile Web - Chrome
android-web.mov
Mobile Web - Safari
iphone-web.mov
Desktop
desktop.mov
iOS
iphone.mov
Android
android.mov

@github-actions
Copy link
Contributor

github-actions bot commented Jun 5, 2023

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@blazejkustra
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@blazejkustra
Copy link
Contributor Author

Closing it for now.

@blazejkustra blazejkustra reopened this Jun 6, 2023
@blazejkustra blazejkustra reopened this Jun 7, 2023
@blazejkustra blazejkustra reopened this Jun 7, 2023
@blazejkustra blazejkustra changed the title [WIP]: Create early Typescript configuration Typescript configuration Jun 7, 2023
@blazejkustra blazejkustra reopened this Jun 7, 2023
.eslintrc.js Show resolved Hide resolved
.eslintrc.js Outdated Show resolved Hide resolved
.eslintrc.js Show resolved Hide resolved
.eslintrc.js Outdated Show resolved Hide resolved
.eslintrc.js Outdated Show resolved Hide resolved
.eslintrc.js Outdated Show resolved Hide resolved
tsconfig.json Show resolved Hide resolved
tsconfig.json Show resolved Hide resolved
tsconfig.json Show resolved Hide resolved
babel.config.js Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
@blazejkustra blazejkustra reopened this Jun 12, 2023
@hayata-suenaga hayata-suenaga linked an issue Jun 12, 2023 that may be closed by this pull request
package.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
@blazejkustra blazejkustra changed the title Typescript configuration Setup App for TypeScript Jun 13, 2023
@blazejkustra blazejkustra marked this pull request as ready for review June 16, 2023 11:50
@blazejkustra blazejkustra requested a review from a team as a code owner June 16, 2023 11:50
@melvin-bot melvin-bot bot requested review from cead22 and removed request for a team June 16, 2023 11:50
@melvin-bot
Copy link

melvin-bot bot commented Jun 16, 2023

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

@hayata-suenaga
Copy link
Contributor

Added @neil-marcellini @mountiny as they're part of TS migration team

Copy link
Contributor

@fabioh8010 fabioh8010 left a comment

Choose a reason for hiding this comment

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

Besides comments LGTM @blazejkustra! 🚀

package.json Show resolved Hide resolved
.github/actions/javascript/bumpVersion/index.js Outdated Show resolved Hide resolved
Copy link
Contributor

@fabioh8010 fabioh8010 left a comment

Choose a reason for hiding this comment

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

I've tested with my Onyx POC branch and several ESLint rules, all working correctly!

@blazejkustra Could we also disable this rule? It's causing several Onyx methods which return Promise<void> to raise errors, but there is nothing wrong with this.

src/components/LottieAnimations.js Show resolved Hide resolved
.eslintrc.js Outdated Show resolved Hide resolved
@hayata-suenaga
Copy link
Contributor

@blazejkustra this is somewhat unrelated question but do you know why we're building github actions code?

@blazejkustra
Copy link
Contributor Author

@hayata-suenaga That's a good question, I don't know exactly. I'm assuming it was a package that was updated and it influenced github actions somehow 🤷‍♂️ A similar answer here

@roryabraham
Copy link
Contributor

do you know why we're building github actions code?

Yep exactly as @blazejkustra mentioned updating packages can sometime cause a diff in compiled actions

@hayata-suenaga
Copy link
Contributor

@blazejkustra thank you so much for your work on this 🙇 🎆 🥳 🎊

@hayata-suenaga hayata-suenaga merged commit cd95905 into Expensify:main Aug 1, 2023
16 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Aug 1, 2023

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

Woo typescript!

@OSBotify
Copy link
Contributor

OSBotify commented Aug 2, 2023

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.49-0 🚀

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

@gadhiyamanan
Copy link
Contributor

i think this PR cause the regression
we need to use Fireworks and ReviewingBankInfo instead of FireworksAnimation and ReviewingBankInfoAnimation in ActivateStep.js and ReimbursementAccountLoadingIndicator.js

cc: @blazejkustra @hayata-suenaga @roryabraham

@blazejkustra
Copy link
Contributor Author

@gadhiyamanan You are right, I'm working on a fix.

I'm so used to Typescript preventing such issues that I didn't notice that I used the wrong name 🤦

@OSBotify
Copy link
Contributor

OSBotify commented Aug 3, 2023

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.50-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 3, 2023

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.49-3 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 7, 2023

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.50-3 🚀

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

@hayata-suenaga
Copy link
Contributor

@blazejkustra some internal engineers realized that the curly ESLint rule that is on for JavaScript files are not working in TS files. I thing some configuration we added in this PR somehow turned off that rule. Could you investigate this and make a PR if necessary to fix 🙇 ?

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

Successfully merging this pull request may close these issues.

Setup App for TypeScript
9 participants