[No QA] [TS migration] Migrate 'Pusher' lib to TypeScript#28116
Merged
marcochavezf merged 14 commits intoExpensify:mainfrom Oct 13, 2023
Merged
[No QA] [TS migration] Migrate 'Pusher' lib to TypeScript#28116marcochavezf merged 14 commits intoExpensify:mainfrom
marcochavezf merged 14 commits intoExpensify:mainfrom
Conversation
rezkiy37
reviewed
Sep 25, 2023
src/libs/Pusher/pusher.ts
Outdated
|
|
||
| // Listen for connection errors and log them | ||
| socket.connection.bind('error', (error) => { | ||
| // TODO: check if true |
Contributor
There was a problem hiding this comment.
Do we need this TODO in prod?
rezkiy37
reviewed
Sep 25, 2023
| let data: EventData; | ||
| try { | ||
| data = _.isObject(eventData) ? eventData : JSON.parse(eventData); | ||
| data = isObject(eventData) ? eventData : JSON.parse(eventData); |
Contributor
There was a problem hiding this comment.
Are we migrating from lodash in a scope of TS migration?
Suggested change
| data = isObject(eventData) ? eventData : JSON.parse(eventData); | |
| data = typeof eventData === 'object' ? eventData : JSON.parse(eventData); |
Contributor
Author
There was a problem hiding this comment.
Lodash usage is allowed, we are migrating from underscore. And I think usage of lodash here is more safe, because if data will be Array type then typeof data will still be object for example same if data would be a Date
rezkiy37
reviewed
Sep 25, 2023
Contributor
rezkiy37
left a comment
rezkiy37
left a comment
There was a problem hiding this comment.
Left a couple comments.
fabioh8010
reviewed
Sep 25, 2023
fabioh8010
approved these changes
Sep 28, 2023
melvin-bot
bot
requested review from
marcochavezf
and removed request for
a team
|
@marcochavezf 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] |
blazejkustra
suggested changes
Oct 2, 2023
src/libs/Pusher/pusher.ts
Outdated
| * @param {Object} payload | ||
| */ | ||
| function sendEvent(channelName, eventName, payload) { | ||
| function sendEvent<T>(channelName: string, eventName: PusherEventName, payload: T) { |
Contributor
There was a problem hiding this comment.
What is the purpose of generic type here? We need to better type payload or at least limit the generic type so it extends Record.
| import Pusher from './types'; | ||
|
|
||
| export default Pusher; | ||
| export default PusherNative satisfies Pusher; |
Contributor
There was a problem hiding this comment.
From TS guidelines:
Do not use
satisfiesoperator for platform-specific implementations, always define shared types that complies with all variants.
Contributor
Author
There was a problem hiding this comment.
Hmm , do you have an idea how to type it then? in this case platform specific files exports classes not functions , I dont see better solution for that 🤔
Contributor
There was a problem hiding this comment.
How about this:
import type Pusher from './types.ts';
import PusherImplementation from 'pusher-js/with-encryption';
const PusherWeb: Pusher = PusherImplementation;
export default PusherWeb;
src/libs/Pusher/pusher.ts
Outdated
| */ | ||
| function registerSocketEventCallback(cb) { | ||
| socketEventCallbacks.push(cb); | ||
| function registerSocketEventCallback<T>(cb: SocketEventCallback<T>) { |
Contributor
There was a problem hiding this comment.
Same here, why a generic type?
Contributor
Author
|
@blazejkustra fixed :) |
blazejkustra
approved these changes
Oct 11, 2023
Contributor
blazejkustra
left a comment
blazejkustra
left a comment
There was a problem hiding this comment.
TS check is failing, other than that LGTM
Contributor
Author
|
@marcochavezf are you able to review this? |
marcochavezf
approved these changes
Oct 12, 2023
Contributor
marcochavezf
left a comment
marcochavezf
left a comment
There was a problem hiding this comment.
LGTM, just a NAB comment
Comment on lines
-37
to
-40
| * @param {Object} args | ||
| * @param {String} args.appKey | ||
| * @param {String} args.cluster | ||
| * @param {String} args.authEndpoint |
Contributor
There was a problem hiding this comment.
NAB: Sorry if I'm not up to date with the latest guidelines, but shouldn't we add a type for args if we already defined the types in JSDoc?
Contributor
Author
There was a problem hiding this comment.
No, for typescript migrations we are removing all JSDocs types we are leaving only params descriptions
Contributor
Author
|
@marcochavezf Are you able to do PR reviewer checklist or assign someone to do that? |
Contributor
Reviewer Checklist
Screenshots/VideosWebMobile Web - ChromeMobile Web - SafariDesktopiOSAndroid |
Contributor
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
github-actions
bot
added
the
DeployBlockerCash
Contributor
Performance Comparison Report 📊Significant Changes To Duration
Show details
Meaningless Changes To DurationShow entries
Show details
|
Contributor
|
@Expensify/mobile-deployers 📣 Please look into this performance regression as it's a deploy blocker. |
97 tasks
Contributor
|
🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.3.84-0 🚀
|
Contributor
|
🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀
|
Contributor
|
🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀
|
Contributor
|
🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.3.85-0 🚀
|
Contributor
|
🚀 Deployed to production by https://github.com/francoisl in version: 1.3.85-4 🚀
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Details
Fixed Issues
$ 24896
Tests
Offline tests
QA Steps
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)/** comment above it */thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor)thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android