fix: add rules for video conversion by dominictb · Pull Request #703 · Expensify/expensify-common

dominictb · 2024-05-22T09:04:27Z

Fixed Issues

$ Expensify/App#41952

Tests

Unit tests added in the PR

QA

Add a comment with both text + video in a chat report
Confirm that the video is displayed accordingly
Edit comment
Expected: The video still shows correctly after editing comment

Signed-off-by: dominictb <tb-dominic@outlook.com>

github-actions · 2024-05-22T09:04:39Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

dominictb · 2024-05-22T09:05:31Z

I have read the CLA Document and I hereby sign the CLA

dominictb · 2024-05-22T09:05:40Z

recheck

Signed-off-by: dominictb <tb-dominic@outlook.com>

deetergp · 2024-06-06T21:09:11Z

@DylanDylann for whatever reason, I can't add you as a reviewer, but think you should review this one since it ties closely with Expensify/App#42463.

Signed-off-by: dominictb <tb-dominic@outlook.com>

DylanDylann · 2024-06-13T10:54:35Z

@dominictb Also please help to format code by the "npm run prettier" command

Signed-off-by: dominictb <tb-dominic@outlook.com>

DylanDylann

Some minor comments. Everything else is fine. Thanks for your work

DylanDylann · 2024-06-13T11:27:47Z

             */
            {
-                name: 'image',
+                name: 'imageOrVideo',


NAB: We might consider breaking this down into two separate rules: image and video. By doing this, we could differentiate between videos and images using the specified REGEX.

Anyway, the current code also looks good to me

I agree that this should be split into two different rules if that's easily doable.

DylanDylann · 2024-06-13T11:37:21Z

+                    }
+                    return `<img src="${Str.sanitizeURL(g2)}"${g1 ? ` alt="${this.escapeAttributeContent(g1)}"` : ''} />`;
+                },
+                // will need to update this similarly


I think we can remove this comment 😄

DylanDylann · 2024-06-13T11:40:08Z

+                    return `!(${g2})`;
+                },
+            },
+


Suggested change

DylanDylann · 2024-06-13T12:08:26Z

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
- MacOS: Chrome / Safari
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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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

MacOS: Chrome / Safari

Screen.Recording.2024-06-13.at.19.05.38.mov

DylanDylann · 2024-06-13T12:12:03Z

@tgolen Ping you here because Melvin isn't assigned

tgolen · 2024-06-13T14:03:41Z

             */
            {
-                name: 'image',
+                name: 'imageOrVideo',


I agree that this should be split into two different rules if that's easily doable.

Signed-off-by: dominictb <tb-dominic@outlook.com>

dominictb · 2024-06-14T04:35:07Z

@tgolen @DylanDylann please help re-review!

DylanDylann

Look good to me 💯

Co-authored-by: DylanDylann <141406735+DylanDylann@users.noreply.github.com>

Signed-off-by: dominictb <tb-dominic@outlook.com>

DylanDylann · 2024-06-14T07:47:51Z

@tgolen All yours 🚀

tgolen · 2024-06-14T15:22:50Z

+                regex: MARKDOWN_VIDEO_REGEX,
+                /**
+                 * @param {string} match
+                 * @param {string} g1 - The first capture group - video name


Please rename these to group1 and group2. We should never have allowed other authors to get away with it in the other functions because it's against our style guide. Bonus points if you update the other method params so everything is consistent!

I've changed the variable name: instead of g1, g2 now we have videoSource, videoName,...

tgolen · 2024-06-14T15:23:58Z

+                regex: /<video[^><]*data-expensify-source\s*=\s*(['"])(\S*?)\1(.*?)>([^><]*)<\/video>*(?![^<][\s\S]*?(<\/pre>|<\/code>))/gi,
+                /**
+                 * @param {string} match The full match
+                 * @param {string} g1 {string} The first capture group


I like the comments, thank you! Something else I think we should consider is using named capture groups. I think that would really help clarify the variables.

Signed-off-by: dominictb <tb-dominic@outlook.com>

tgolen

Ah, I love the named parameters. Thank you!

github-actions · 2024-06-17T13:34:26Z

🚀Published to npm in v2.0.16

fix: add rules for video conversion

b11b7ce

Signed-off-by: dominictb <tb-dominic@outlook.com>

dominictb added 2 commits June 6, 2024 16:57

Merge remote-tracking branch 'origin/main' into fix/app-41952

1818c76

fix: add video extension const array

4c6218d

Signed-off-by: dominictb <tb-dominic@outlook.com>

dominictb marked this pull request as ready for review June 6, 2024 10:17

dominictb requested a review from a team as a code owner June 6, 2024 10:17

melvin-bot Bot requested review from deetergp and removed request for a team June 6, 2024 10:18

dominictb mentioned this pull request Jun 6, 2024

fix: cache extra attributes for video markdown conversion Expensify/App#42463

Merged

49 tasks

dominictb added 2 commits June 12, 2024 00:00

Merge remote-tracking branch 'origin/main' into fix/app-41952

c112086

chore: move fileHelpers to TS

3b69f12

Signed-off-by: dominictb <tb-dominic@outlook.com>

DylanDylann reviewed Jun 13, 2024

View reviewed changes

Comment thread lib/fileHelpers.ts Outdated

dominictb added 2 commits June 13, 2024 18:06

fix: prettier

cbd45d1

Signed-off-by: dominictb <tb-dominic@outlook.com>

fix: remove lodash usage

cb54da6

Signed-off-by: dominictb <tb-dominic@outlook.com>

DylanDylann reviewed Jun 13, 2024

View reviewed changes

DylanDylann approved these changes Jun 13, 2024

View reviewed changes

tgolen requested changes Jun 13, 2024

View reviewed changes

chore: extract video into a separate rule

d53d10f

Signed-off-by: dominictb <tb-dominic@outlook.com>

dominictb requested a review from tgolen June 14, 2024 04:34

DylanDylann approved these changes Jun 14, 2024

View reviewed changes

Comment thread __tests__/ExpensiMark-HTML-test.js Outdated

DylanDylann reviewed Jun 14, 2024

View reviewed changes

Comment thread lib/ExpensiMark.js Outdated

dominictb and others added 2 commits June 14, 2024 14:41

Update __tests__/ExpensiMark-HTML-test.js

4875393

Co-authored-by: DylanDylann <141406735+DylanDylann@users.noreply.github.com>

fix: update comments

fd35a4a

Signed-off-by: dominictb <tb-dominic@outlook.com>

fix: comment function

f2469e4

Signed-off-by: dominictb <tb-dominic@outlook.com>

tgolen requested changes Jun 14, 2024

View reviewed changes

tgolen mentioned this pull request Jun 14, 2024

[HOLD for payment 2024-06-28] [$500] HIGH: [Polish] Editing a comment with a video removes the video Expensify/App#41952

Closed

dominictb added 2 commits June 17, 2024 08:39

Merge remote-tracking branch 'origin/main' into fix/app-41952

4fd9abf

fix: update variable names

cb401e0

Signed-off-by: dominictb <tb-dominic@outlook.com>

dominictb requested a review from tgolen June 17, 2024 01:51

tgolen approved these changes Jun 17, 2024

View reviewed changes

tgolen merged commit 9f12ae6 into Expensify:main Jun 17, 2024

Uh oh!

Conversation

dominictb commented May 22, 2024

Fixed Issues

Tests

QA

Uh oh!

github-actions Bot commented May 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dominictb commented May 22, 2024

Uh oh!

dominictb commented May 22, 2024

Uh oh!

deetergp commented Jun 6, 2024

Uh oh!

Uh oh!

DylanDylann commented Jun 13, 2024

Uh oh!

DylanDylann left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

DylanDylann commented Jun 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

DylanDylann commented Jun 13, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dominictb commented Jun 14, 2024

Uh oh!

DylanDylann left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

DylanDylann commented Jun 14, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tgolen left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jun 17, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions Bot commented May 22, 2024 •

edited

Loading

DylanDylann commented Jun 13, 2024 •

edited

Loading