[No QA][TS migration] Migrate 'Visibility' lib to TypeScript #27437

Skalakid · 2023-09-14T13:05:48Z

Details

Fixed Issues

$ #24844
PROPOSAL: #24844

Tests

Log in
Enter any chat room
Open console and select verbose logs
Leave application and verify if "Flushing logs as app is going inactive - {}" appears
Come back to the app and verify if many new logs appear

Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as tests

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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 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 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.mov

Mobile Web - Chrome

chrome.mov

Mobile Web - Safari

safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

blazejkustra · 2023-09-19T08:36:07Z

src/libs/Visibility/index.desktop.ts

 */
 function isVisible() {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return


I think electron is typed as 'any', we have to change this @Skalakid

blazejkustra · 2023-09-19T08:36:38Z

src/libs/Visibility/index.desktop.ts

    return window.electron.sendSync(ELECTRON_EVENTS.REQUEST_VISIBILITY);
 }

-/**
- * @returns {Boolean}
- */
 function hasFocus() {


Please create types.ts file with shared types, similar to this PR

blazejkustra · 2023-09-19T08:36:52Z

src/types/modules/electron.d.ts

+declare global {
+    // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+    interface Window {
+        electron: Electron;


In my IDE Electron is of type any

blazejkustra

Either way LGTM.

blazejkustra · 2023-09-19T10:38:20Z

src/types/modules/electron.d.ts

+declare global {
+    // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+    interface Window {
+        electron: Electron.IpcRenderer;


NAB: This type might be too extensive, we should probably create a type based on the implementation here. Article that explains it well.

melvin-bot · 2023-09-19T11:08:05Z

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

s77rt · 2023-09-19T12:07:35Z

src/libs/Visibility/index.desktop.ts

-function isVisible() {
-    return window.electron.sendSync(ELECTRON_EVENTS.REQUEST_VISIBILITY);
-}
+const isVisible: IsVisible = () => !!window.electron.sendSync(ELECTRON_EVENTS.REQUEST_VISIBILITY);


I don't think we had to remove the named function here.

function isVisible(): boolean would be fine I guess.

From TS guidelines:

In modules with platform-specific implementations, create types.ts to define shared types. For platform-specific implementations, always define shared types that complies with all variants.

That's why IsVisible type was created in the first place and used here. I think the change was necessary.

s77rt

Approving for engineer review

melvin-bot · 2023-09-19T12:07:49Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #24844 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

fabioh8010

LGTM, CK still need to do the checklist.

fabioh8010 · 2023-09-19T18:09:36Z

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

Screen.Recording.2023-09-19.at.18.59.43.mov

Screen.Recording.2023-09-19.at.19.00.44.mov

Desktop

Screen.Recording.2023-09-19.at.19.02.28.mov

Mobile Web - Chrome

Screen.Recording.2023-09-19.at.19.04.17.mov

Android

Screen.Recording.2023-09-19.at.19.05.36.mov

Mobile Web - Safari

Screen.Recording.2023-09-19.at.19.08.00.mov

iOS

Screen.Recording.2023-09-19.at.19.08.37.mov

flodnv · 2023-09-20T02:59:55Z

src/types/modules/electron.d.ts

@@ -0,0 +1,18 @@
+// TODO: Move this type to desktop/contextBridge.js once it is converted to TS


Can we link to the tracking issue for this?

Yes, here is a link to desktop files migration issue: #25333

Cool thanks, we could also link it here for clarity

OSBotify · 2023-09-20T09:35:14Z

✋ 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 · 2023-09-22T14:02:05Z

🚀 Deployed to staging by https://github.com/flodnv in version: 1.3.73-0 🚀

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

OSBotify · 2023-09-25T09:36:56Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀

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

OSBotify · 2023-09-25T10:09:06Z

🚀 Deployed to staging by https://github.com/flodnv in version: 1.3.74-0 🚀

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

OSBotify · 2023-09-28T18:51:27Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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

Skalakid added 2 commits September 14, 2023 15:00

migrate Visibility files to TypeScript

b7b8a65

Merge branch 'main' into @Skalakid/ts/Visibility

4a20581

Skalakid changed the title ~~[TS migration] Migrate 'Visibility' lib to TypeScript~~ [No QA][TS migration] Migrate 'Visibility' lib to TypeScript Sep 18, 2023

blazejkustra suggested changes Sep 19, 2023

View reviewed changes

review changes

fd4fa9f

blazejkustra approved these changes Sep 19, 2023

View reviewed changes

retype electron.d.ts

5a9f707

Skalakid marked this pull request as ready for review September 19, 2023 11:07

Skalakid requested a review from a team as a code owner September 19, 2023 11:08

melvin-bot bot requested review from s77rt and removed request for a team September 19, 2023 11:08

s77rt reviewed Sep 19, 2023

View reviewed changes

s77rt approved these changes Sep 19, 2023

View reviewed changes

melvin-bot bot requested a review from flodnv September 19, 2023 12:07

Skalakid mentioned this pull request Sep 19, 2023

[TS migration] Migrate 'generateDeviceID' lib to TypeScript #27706

Closed

59 tasks

fabioh8010 approved these changes Sep 19, 2023

View reviewed changes

flodnv reviewed Sep 20, 2023

View reviewed changes

flodnv mentioned this pull request Sep 20, 2023

[HOLD for payment 2024-03-26] [TS migration] Migrate 'Desktop' files to TypeScript #25333

Closed

flodnv approved these changes Sep 20, 2023

View reviewed changes

flodnv merged commit b028686 into Expensify:main Sep 20, 2023
16 of 20 checks passed

OSBotify mentioned this pull request Sep 22, 2023

Deploy Checklist: New Expensify 2023-09-22 #28013

Closed

96 tasks

melvin-bot bot mentioned this pull request Sep 25, 2023

[HOLD for payment 2023-10-02] [TS migration] Migrate 'Visibility' lib to TypeScript #24844

Closed

This was referenced Sep 25, 2023

Deploy Checklist: New Expensify DUPE 2023-09-25 #28118

Closed

Deploy Checklist: New Expensify 2023-09-25 #28119

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA][TS migration] Migrate 'Visibility' lib to TypeScript #27437

[No QA][TS migration] Migrate 'Visibility' lib to TypeScript #27437

Skalakid commented Sep 14, 2023 •

edited

Loading

blazejkustra Sep 19, 2023

blazejkustra Sep 19, 2023

blazejkustra Sep 19, 2023

blazejkustra left a comment

blazejkustra Sep 19, 2023

melvin-bot bot commented Sep 19, 2023

s77rt Sep 19, 2023

blazejkustra Sep 19, 2023

s77rt left a comment

melvin-bot bot commented Sep 19, 2023

fabioh8010 left a comment

fabioh8010 commented Sep 19, 2023

flodnv Sep 20, 2023

Skalakid Sep 20, 2023

flodnv Sep 20, 2023

OSBotify commented Sep 20, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

		@@ -0,0 +1,18 @@
		// TODO: Move this type to desktop/contextBridge.js once it is converted to TS

[No QA][TS migration] Migrate 'Visibility' lib to TypeScript #27437

[No QA][TS migration] Migrate 'Visibility' lib to TypeScript #27437

Conversation

Skalakid commented Sep 14, 2023 • edited 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

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

melvin-bot bot commented Sep 19, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s77rt left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 19, 2023

fabioh8010 left a comment

Choose a reason for hiding this comment

fabioh8010 commented Sep 19, 2023

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Sep 20, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

Skalakid commented Sep 14, 2023 •

edited

Loading