[No QA] [TS migration] Migrate 'Link.js' lib to TypeScript #28257

kubabutkiewicz · 2023-09-26T13:00:50Z

Details

Fixed Issues

$ 24912

Tests

Go to Settings > About > App download links
Click one of menu items (Android / iOS / macOS)
Verify that it's redirected to correct app download site

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to Settings > About > App download links
Click one of menu items (Android / iOS / macOS)
Verify that it's redirected to correct app download site

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

adhorodyski · 2023-09-26T13:06:04Z

src/libs/actions/Link.ts

-
-    const params = _.compact([authTokenParam, emailParam]).join('&');
+    const paramsArray = [authTokenParam, emailParam];
+    const params = paramsArray.filter(Boolean).join('&');


i love this pattern, congrats @kubabutkiewicz 🔥

fabioh8010 · 2023-09-26T13:13:43Z

src/libs/actions/Link.ts

 });

-let currentUserEmail;
+let currentUserEmail: string;


Suggested change

let currentUserEmail: string;

let currentUserEmail: string | undefined;

I would be more safe if we specify that this variable can be undefined, because it's only populated in the callback of Onyx, so before that happens it's undefined and we should consider this possibility.

Or if we only care about the string type, maybe we can default it to ''? Wdyt?

It is an option too, @kubabutkiewicz We can change this one to:

let currentUserEmail = '';

fabioh8010 · 2023-09-26T13:13:55Z

src/libs/actions/Link.ts

@@ -10,29 +8,23 @@ import * as Url from '../Url';
 let isNetworkOffline = false;


Suggested change

let isNetworkOffline = false;

let isNetworkOffline: boolean | undefined = false;

Same.

actually here it would stay false before this callback fires 🤔

You are right @adhorodyski! Sorry @kubabutkiewicz , but could you revert this one?

melvin-bot · 2023-09-26T13:24:14Z

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

dangrous

One change (I think) and one clarification, looks good otherwise!

Can you also add some testing steps please just so I can double check? Thanks!

src/libs/actions/Link.ts

kubabutkiewicz · 2023-09-28T10:35:24Z

@dangrous Added testing steps , answered and make this one change :)

dangrous

Cool, looks good! @fabioh8010 do you mind filling out the checklist so we can get this merged? Thank you!

fabioh8010 · 2023-09-29T05:49:17Z

@dangrous This one must be filled by SWM engineers as part of our cross-review strategy, they will review it soon.

blazejkustra

LGTM

blazejkustra · 2023-10-02T14:35:22Z

@dangrous Just so you know, TS process was changed recently and now C+ are responsible for the reviewer checklist.

dangrous · 2023-10-02T14:59:35Z

Got it, let me see if I can grab one for this!

kubabutkiewicz · 2023-10-11T07:23:35Z

Hi @dangrous @aimane-chnaif are you able to review this and do reviewer check list?

aimane-chnaif · 2023-10-11T07:39:34Z

On it now. Was reviewing yesterday

aimane-chnaif · 2023-10-11T07:46:33Z

Code looks good. Can you update QA Steps like this?

Go to Settings > About > App download links
Click one of menu items (Android / iOS / macOS)
Verify that it's redirected to correct app download site

aimane-chnaif · 2023-10-11T08:01:16Z

src/libs/actions/Link.ts

+    const paramsArray = [authTokenParam, emailParam];
+    const params = paramsArray.filter(Boolean).join('&');


NAB: I don't see the need of introducing new variable

Suggested change

const paramsArray = [authTokenParam, emailParam];

const params = paramsArray.filter(Boolean).join('&');

const params = [authTokenParam, emailParam].filter(Boolean).join('&');

Any feedback?

bump, though not blocker

for me it was looking more clear when did that, should I revert that?

That's fine

aimane-chnaif · 2023-10-11T08:02:55Z

Code looks good. Can you update QA Steps like this?

Go to Settings > About > App download links

Click one of menu items (Android / iOS / macOS)

Verify that it's redirected to correct app download site

Apply this to Test step as well. And add numbers 1. 2. 3.

kubabutkiewicz · 2023-10-13T12:54:43Z

@aimane-chnaif can you look again?

kubabutkiewicz · 2023-10-18T09:27:13Z

@aimane-chnaif Hi, are you able to look at this PR ?

aimane-chnaif · 2023-10-18T09:28:20Z

reviewing today

aimane-chnaif · 2023-10-22T15:55:25Z

@kubabutkiewicz I got lint error after pulling main

…s-migration/Link-lib

kubabutkiewicz · 2023-10-30T08:24:18Z

@aimane-chnaif PR updated

aimane-chnaif · 2023-10-30T10:22:09Z

@kubabutkiewicz please also fix lint

kubabutkiewicz · 2023-10-30T11:22:51Z

@aimane-chnaif fixed.

dangrous · 2023-11-02T14:12:41Z

@aimane-chnaif do you have time to re-review today?

aimane-chnaif · 2023-11-02T14:45:41Z

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

Android: Native

android.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

aimane-chnaif

LGTM 🎉

melvin-bot · 2023-11-02T14:49:47Z

🎯 @aimane-chnaif, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #30783.

dangrous

Just one comment - looks great otherwise!

dangrous · 2023-11-02T19:18:17Z

src/libs/actions/Link.ts

@@ -42,18 +34,11 @@ function buildOldDotURL(url, shortLivedAuthToken) {
    });
 }

-/**
- * @param {String} url
- * @param {Boolean} shouldSkipCustomSafariLogic When true, we will use `Linking.openURL` even if the browser is Safari.


Can we leave this note in? It might be useful for the future!

Added @dangrous 😄

…s-migration/Link-lib

OSBotify · 2023-11-06T22:16:56Z

✋ 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-11-08T08:31:45Z

🚀 Deployed to staging by https://github.com/dangrous in version: 1.3.96-6 🚀

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

OSBotify · 2023-11-09T22:47:07Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

OSBotify · 2023-11-10T16:03:24Z

🚀 Deployed to staging by https://github.com/dangrous in version: 1.3.98-0 🚀

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

OSBotify · 2023-11-14T21:56:51Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.98-5 🚀

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

ref: move Link lib to TS

e5cf992

adhorodyski reviewed Sep 26, 2023

View reviewed changes

fabioh8010 reviewed Sep 26, 2023

View reviewed changes

fix: resolve comments

4662d7d

fabioh8010 approved these changes Sep 26, 2023

View reviewed changes

kubabutkiewicz marked this pull request as ready for review September 26, 2023 13:23

kubabutkiewicz requested a review from a team as a code owner September 26, 2023 13:23

melvin-bot bot requested review from dangrous and removed request for a team September 26, 2023 13:24

dangrous requested changes Sep 27, 2023

View reviewed changes

src/libs/actions/Link.ts Outdated Show resolved Hide resolved

src/libs/actions/Link.ts Outdated Show resolved Hide resolved

kubabutkiewicz added 2 commits September 28, 2023 12:26

Merge branch 'main' into ts-migration/Link-lib

e36f442

ref: resolve comments

1df720f

kubabutkiewicz added 2 commits September 28, 2023 13:17

ref: resolve comments

d6b95ed

fix: removed unnecessay defaultin to ''

5d5f0ff

dangrous previously approved these changes Sep 29, 2023

View reviewed changes

blazejkustra approved these changes Oct 2, 2023

View reviewed changes

dangrous requested a review from aimane-chnaif October 2, 2023 15:13

aimane-chnaif reviewed Oct 11, 2023

View reviewed changes

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

4b8f24a

…s-migration/Link-lib

kubabutkiewicz dismissed dangrous’s stale review via 4b8f24a October 30, 2023 08:23

fix: linter

9a22d2e

aimane-chnaif approved these changes Nov 2, 2023

View reviewed changes

melvin-bot bot mentioned this pull request Nov 2, 2023

[payment due 2023-11-16] Payment issue for E/App PR#28257 #30783

Closed

dangrous requested changes Nov 2, 2023

View reviewed changes

kubabutkiewicz added 2 commits November 3, 2023 08:03

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

2bad6b7

…s-migration/Link-lib

fix: revert function param description

f8a156d

dangrous approved these changes Nov 6, 2023

View reviewed changes

dangrous merged commit 278bb5d into Expensify:main Nov 6, 2023

OSBotify mentioned this pull request Nov 8, 2023

Deploy Checklist: New Expensify 2023-11-06 #30929

Closed

OSBotify mentioned this pull request Nov 10, 2023

Deploy Checklist: New Expensify 2023-11-10 #31187

Closed

	let currentUserEmail: string;
	let currentUserEmail: string \| undefined;

		@@ -10,29 +8,23 @@ import * as Url from '../Url';
		let isNetworkOffline = false;

	let isNetworkOffline = false;
	let isNetworkOffline: boolean \| undefined = false;

		const paramsArray = [authTokenParam, emailParam];
		const params = paramsArray.filter(Boolean).join('&');

	const paramsArray = [authTokenParam, emailParam];
	const params = paramsArray.filter(Boolean).join('&');
	const params = [authTokenParam, emailParam].filter(Boolean).join('&');

[No QA] [TS migration] Migrate 'Link.js' lib to TypeScript #28257

[No QA] [TS migration] Migrate 'Link.js' lib to TypeScript #28257

Conversation

kubabutkiewicz commented Sep 26, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 26, 2023

dangrous left a comment

Choose a reason for hiding this comment

kubabutkiewicz commented Sep 28, 2023

dangrous left a comment

Choose a reason for hiding this comment

fabioh8010 commented Sep 29, 2023

blazejkustra left a comment

Choose a reason for hiding this comment

blazejkustra commented Oct 2, 2023

dangrous commented Oct 2, 2023

kubabutkiewicz commented Oct 11, 2023

aimane-chnaif commented Oct 11, 2023

aimane-chnaif commented Oct 11, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aimane-chnaif commented Oct 11, 2023

kubabutkiewicz commented Oct 13, 2023

kubabutkiewicz commented Oct 18, 2023

aimane-chnaif commented Oct 18, 2023

aimane-chnaif commented Oct 22, 2023

kubabutkiewicz commented Oct 30, 2023

aimane-chnaif commented Oct 30, 2023 • edited Loading

kubabutkiewicz commented Oct 30, 2023

dangrous commented Nov 2, 2023

aimane-chnaif commented Nov 2, 2023

Reviewer Checklist

Screenshots/Videos

aimane-chnaif left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Nov 2, 2023

dangrous left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Nov 6, 2023

OSBotify commented Nov 8, 2023

OSBotify commented Nov 9, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 14, 2023

kubabutkiewicz commented Sep 26, 2023 •

edited

Loading

aimane-chnaif commented Oct 30, 2023 •

edited

Loading