Skip to content

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

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.

Sign up for GitHub

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

Merged
merged 10 commits into from
Nov 6, 2023
Merged

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

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e5cf992
ref: move Link lib to TS
kubabutkiewicz Sep 26, 2023
4662d7d
fix: resolve comments
kubabutkiewicz Sep 26, 2023
e36f442
Merge branch 'main' into ts-migration/Link-lib
kubabutkiewicz Sep 28, 2023
1df720f
ref: resolve comments
kubabutkiewicz Sep 28, 2023
d6b95ed
ref: resolve comments
kubabutkiewicz Sep 28, 2023
5d5f0ff
fix: removed unnecessay defaultin to ''
kubabutkiewicz Sep 28, 2023
4b8f24a
Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…
kubabutkiewicz Oct 30, 2023
9a22d2e
fix: linter
kubabutkiewicz Oct 30, 2023
2bad6b7
Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…
kubabutkiewicz Nov 3, 2023
f8a156d
fix: revert function param description
kubabutkiewicz Nov 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 10 additions & 25 deletions src/libs/actions/Link.js → src/libs/actions/Link.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
import Onyx from 'react-native-onyx';
import lodashGet from 'lodash/get';
import _ from 'underscore';
import ONYXKEYS from '../../ONYXKEYS';
import asyncOpenURL from '../asyncOpenURL';
import * as API from '../API';
Expand All @@ -10,29 +8,23 @@ import * as Url from '../Url';
let isNetworkOffline = false;
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
let isNetworkOffline = false;
let isNetworkOffline: boolean | undefined = false;

Same.

Copy link
Contributor

Choose a reason for hiding this comment

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

actually here it would stay false before this callback fires 🤔

Copy link
Contributor

Choose a reason for hiding this comment

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

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

Onyx.connect({
key: ONYXKEYS.NETWORK,
callback: (val) => (isNetworkOffline = lodashGet(val, 'isOffline', false)),
callback: (value) => (isNetworkOffline = value?.isOffline ?? false),
});

let currentUserEmail;
let currentUserEmail: string;
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Contributor

Choose a reason for hiding this comment

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

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

let currentUserEmail = '';

Onyx.connect({
key: ONYXKEYS.SESSION,
callback: (val) => (currentUserEmail = lodashGet(val, 'email', '')),
callback: (value) => (currentUserEmail = value?.email ?? ''),
});

/**
* @param {String} [url] the url path
* @param {String} [shortLivedAuthToken]
*
* @returns {Promise<string>}
*/
function buildOldDotURL(url, shortLivedAuthToken) {
const hasHashParams = url.indexOf('#') !== -1;
const hasURLParams = url.indexOf('?') !== -1;
function buildOldDotURL(url?: string, shortLivedAuthToken?: string): Promise<string> {
const hasHashParams = url?.indexOf('#') !== -1;
const hasURLParams = url?.indexOf('?') !== -1;

const authTokenParam = shortLivedAuthToken ? `authToken=${shortLivedAuthToken}` : '';
const emailParam = `email=${encodeURIComponent(currentUserEmail)}`;

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

Choose a reason for hiding this comment

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

i love this pattern, congrats @kubabutkiewicz 🔥

Comment on lines +26 to +27
Copy link
Contributor

Choose a reason for hiding this comment

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

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('&');

Copy link
Contributor

Choose a reason for hiding this comment

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

Any feedback?

Copy link
Contributor

Choose a reason for hiding this comment

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

bump, though not blocker

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

Copy link
Contributor

Choose a reason for hiding this comment

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

That's fine


return Environment.getOldDotEnvironmentURL().then((environmentURL) => {
const oldDotDomain = Url.addTrailingForwardSlash(environmentURL);
Expand All @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added @dangrous 😄

*/
function openExternalLink(url, shouldSkipCustomSafariLogic = false) {
function openExternalLink(url: string, shouldSkipCustomSafariLogic = false) {
asyncOpenURL(Promise.resolve(), url, shouldSkipCustomSafariLogic);
}

/**
* @param {String} url the url path
*/
function openOldDotLink(url) {
function openOldDotLink(url: string) {
if (isNetworkOffline) {
buildOldDotURL(url).then((oldDotURL) => openExternalLink(oldDotURL));
return;
Expand Down