[TS migration] Migrate 'SelectionScraper' lib to TypeScript #27796
Conversation
There was a problem hiding this comment.
Add types.ts file with common types for getCurrentSelection
src/libs/SelectionScraper/index.ts
Outdated
| const domElement = dom as Element; | ||
| let domName = domElement.name; | ||
| let domChildren: Node[] = []; | ||
| const domAttribs = {} as Element['attribs']; |
There was a problem hiding this comment.
| const domAttribs = {} as Element['attribs']; | |
| const domAttribs: Element['attribs'] = {}; |
| @@ -64,17 +64,17 @@ const getHTMLOfSelection = () => { | |||
| // and finally commonAncestorContainer.parentNode.closest('data-testid') is targeted dom. | |||
| if (range.commonAncestorContainer instanceof HTMLElement) { | |||
| parent = range.commonAncestorContainer.closest(`[${tagAttribute}]`); | |||
There was a problem hiding this comment.
Type parent, now it's of type any
|
|
||
| const elementsWillBeSkipped = ['html', 'body']; | ||
| const tagAttribute = 'data-testid'; | ||
|
|
||
| /** | ||
| * Reads html of selection. If browser doesn't support Selection API, returns empty string. | ||
| * @returns {String} HTML of selection as String |
There was a problem hiding this comment.
| * @returns {String} HTML of selection as String | |
| * @returns HTML of selection as String |
melvin-bot
bot
requested review from
parasharrajat
and removed request for
a team
|
@parasharrajat 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] |
|
We did not find an internal engineer to review this PR, trying to assign a random engineer to #24879 as well as to this PR... Please reach out for help on Slack if no one gets assigned! |
|
@blazejkustra can you please do the checklist? |
| // If browser doesn't support Selection API, return an empty string. | ||
| if (!window.getSelection) { | ||
| const selection = window.getSelection(); |
There was a problem hiding this comment.
won't this throw if we don't have window.getSelection(); ?
There was a problem hiding this comment.
@Skalakid is OOO this week, he will adjust it once he's back
There was a problem hiding this comment.
According to the Window types, getSelection should be always present. So I think it won't throw
|
@danieldoglas Because this PR is from SWM, Callstack engineers will make the checklist for us. cc @fabioh8010 |
src/libs/SelectionScraper/index.ts
Outdated
| } else if (range.commonAncestorContainer.parentNode) { | ||
| parent = (range.commonAncestorContainer.parentNode as HTMLElement).closest(`[${tagAttribute}]`); | ||
| } |
There was a problem hiding this comment.
| } else if (range.commonAncestorContainer.parentNode) { | |
| parent = (range.commonAncestorContainer.parentNode as HTMLElement).closest(`[${tagAttribute}]`); | |
| } | |
| } else { | |
| parent = (range.commonAncestorContainer.parentNode as HTMLElement | null)?.closest(`[${tagAttribute}]`) ?? null; | |
| } |
Would be safer if we do like this, in this way we are not changing conditional flow.
src/libs/SelectionScraper/index.ts
Outdated
|
|
||
| parent = parent.parentNode.closest(`[${tagAttribute}]`); | ||
| parent = (parent.parentNode as HTMLElement).closest(`[${tagAttribute}]`); |
There was a problem hiding this comment.
| parent = (parent.parentNode as HTMLElement).closest(`[${tagAttribute}]`); | |
| parent = (parent.parentNode as HTMLElement | null)?.closest(`[${tagAttribute}]`) ?? null; |
parentNode can be null.
There was a problem hiding this comment.
Good catch, thanks!
src/libs/SelectionScraper/index.ts
Outdated
| if (data) { | ||
| return { | ||
| ...dom, | ||
| data, | ||
| } as DataNode; | ||
| } | ||
|
|
||
| return { | ||
| ...dom, | ||
| data, | ||
| name: domName, | ||
| attribs: domAttribs, | ||
| children: domChildren, | ||
| }; | ||
| } as Element; |
There was a problem hiding this comment.
I didn't fully understand why this change was made.
There was a problem hiding this comment.
I made this change because replaceNodes function should return Node type elements. Node type is a general type and there are many more specific ones that extend it. The problem was that children can be different types of Nodes. According to the domhandler types there isn't any type that have both data and attribs/children attributes. So if there is Node have data I'm returning DataNode, if no I'm returning Element type Node
|
@Skalakid is OOO this week, he will respond & adjust the code once he is back |
src/libs/SelectionScraper/index.ts
Outdated
| // Encoding HTML chars '< >' in the text, because any HTML will be removed in stripHTML method. | ||
| if (dom.type === 'text') { | ||
| data = Str.htmlEncode(dom.data); | ||
| const domDataNode = dom as DataNode; |
There was a problem hiding this comment.
@Skalakid Why this logic was moved up?
There was a problem hiding this comment.
I wouldn't change logic as it looks quite fragile 😅
src/libs/SelectionScraper/index.ts
Outdated
| @@ -138,16 +143,15 @@ const replaceNodes = (dom, isChildOfEditorElement) => { | |||
| name: domName, | |||
| attribs: domAttribs, | |||
| children: domChildren, | |||
| }; | |||
| } as unknown as Node; | |||
There was a problem hiding this comment.
@fabioh8010 This assertion was my idea, other thing that we could do is to return new Element(...) or new DataNode(...) instead of assertion, but I didn't want to change the logic that much, wdyt?
There was a problem hiding this comment.
| } as unknown as Node; | |
| } as Element & DataNode; |
How about this? I tested and it's working :) @blazejkustra @Skalakid
|
@parasharrajat with the new process, can you do the final tests and checklist for this? |
| let domChildren; | ||
| const domAttribs = {}; | ||
| let data; | ||
| const replaceNodes = (dom: Node, isChildOfEditorElement: boolean): Node => { |
There was a problem hiding this comment.
The return type does not match the return value. Let's use one type.
There was a problem hiding this comment.
Node is a parent class of DataNode and Element, this function has to be more generic that's why Node is the return type
| @@ -0,0 +1,3 @@ | |||
| type GetCurrentSelection = () => string; | |||
|
|
|||
| export default GetCurrentSelection; | |||
There was a problem hiding this comment.
Normally, the name of the file matches with the default export but here it isn't. Let's convert it to named export.
There was a problem hiding this comment.
Usually in other libstypes.ts files we used default export, so for consistency I would leave it as is @parasharrajat
src/libs/SelectionScraper/index.ts
Outdated
| if (dom.attribs && dom.attribs[tagAttribute]) { | ||
| if (!elementsWillBeSkipped.includes(dom.attribs[tagAttribute])) { | ||
| domName = dom.attribs[tagAttribute]; | ||
| if (dom instanceof Element) { |
There was a problem hiding this comment.
we shouldn't add this condition here. This will allow the function to return garbage value. It is better if it errors instead.
There was a problem hiding this comment.
This condition is added to narrow down the type so we can use some of the properties in the if body.
This will allow the function to return garbage value
Not exactly sure what you mean by this? We tested the logic and the argument is either DataNode or Element, so depending on the argument type the code from first/second if is executed
There was a problem hiding this comment.
Previously, if the dom was not in proper structure, the logic will throw now, if it is not Element, it will return a DataNode with empty or undefined properties.
There was a problem hiding this comment.
We need to narrow the type, but you point is also valid. I'm proposing something like this:
if (dom.type === ElementType.Text && dom instanceof DataNode) {
...
} else if (dom instanceof Element) {
...
} else {
throw new Error(`Unknown dom type: ${dom.type}`);
}We would have to test it thoroughly. Any other ideas? @parasharrajat @Skalakid
|
|
||
| // Encoding HTML chars '< >' in the text, because any HTML will be removed in stripHTML method. | ||
| if (dom.type === 'text') { | ||
| if (dom.type.toString() === 'text' && dom instanceof DataNode) { |
There was a problem hiding this comment.
Previously we were strictly matching type property. Now we are doing a type conversion before matching it. I don't know if it changes anything logically but why do we have to change this condition? I don't think we should change it just to satisfy type checks.
We defined dom as Node on the function definition and now we are checking the type of DataNode. Either we should define the correct type or not.
There was a problem hiding this comment.
Previously we were strictly matching type property. Now we are doing a type conversion before matching it. I don't know if it changes anything logically but why do we have to change this condition?
@Skalakid Use this instead:
import { ElementType } from "domelementtype";
...
if (dom.type === ElementType.Text && dom instanceof DataNode) {We defined dom as Node on the function definition and now we are checking the type of DataNode. Either we should define the correct type or not.
DataNode is a child of Node, so it's perfectly fine to narrow down the type like we do in the if statement dom instanceof DataNode @parasharrajat, wdyt?
dom instanceof DataNode is needed to narrow down the type & use its additional properties that aren't available on Node
| */ | ||
| const replaceNodes = (dom, isChildOfEditorElement) => { | ||
| let domName = dom.name; |
There was a problem hiding this comment.
Any reason for this change?
There was a problem hiding this comment.
name is only available on Element
|
@Skalakid Please let us know your thoughts on #27796 (comment) ? |
|
Sorry, I missed the notification about this PR, thanks @blazejkustra for answering the comments. I've aded proposed changes |
Screenshots🔲 iOS / nativeScreen.Recording.2023-10-08.at.6.17.47.PM.mov🔲 iOS / SafariScreen.Recording.2023-10-08.at.6.14.16.PM.mov🔲 MacOS / DesktopScreen.Recording.2023-10-08.at.6.06.36.PM.mov🔲 MacOS / ChromeScreen.Recording.2023-10-08.at.3.56.50.PM.mov🔲 Android / ChromeScreen.Recording.2023-10-08.at.6.03.53.PM.mov🔲 Android / nativeScreen.Recording.2023-10-08.at.6.32.33.PM.mov |
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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.
toggleReportand notonIconClick). - 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 Copylabel 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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
Avataris modified, I verified thatAvataris 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
ScrollViewcomponent to make it scrollable when more elements are added to the page. - If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
🎀 👀 🎀 C+ reviewed
|
@danieldoglas Gentle reminder to merge this. |
|
@danieldoglas bump :D |
|
Hey guys, I'm back from OOO now. We're in a conference at this moment, so I'll hold for 3 more days to merge this since I don't want to risk generating any regressions in the middle of a conference. Sorry for the long delay here! |
|
oops, lint is failing after merge. Let's merge this today, sorry for the delay! |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.3.94-0 🚀
|
1 similar comment
|
🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.3.94-0 🚀
|
|
🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.94-2 🚀
|
|
🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.3.95-0 🚀
|
|
🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.95-9 🚀
|
Details
Migrated SelectionScraper files to TypeScript
Fixed Issues
$ #24879
PROPOSAL: #24879
Tests
Offline tests
Same as Text
QA Steps
Same as Text
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
web.mov
Mobile Web - Chrome
N/A
Mobile Web - Safari
N/A
Desktop
desktop.mov
iOS
N/A
Android
N/A