change font size for code block in H1 #30876

yakupafsin · 2023-11-03T20:42:41Z

Details

Created a new function to check if there is an ancestor node with the name 'h1' and applied on CodeRenderer.js to change code block font-size if it is inside h1 tag.

Fixed Issues

$ #30203
PROPOSAL: #30203 (comment)

Tests

Open the app
Open any report
Send a normal message and observe its font size
Send a heading message (add # in beginning)
Verify that the font size of the heading message is bigger than that of the normal message
Send a normal single backtick code block e.g. Hello and observe its font size
Send a heading single backtick code block eg: # Hello
Verify that the font size of the heading message is bigger than that of the normal message

Verify that no errors appear in the JS console

Offline tests

Not connectivity related.

QA Steps

Open the app
Open any report
Send a normal message and observe its font size
Send a heading message (add # in beginning)
Verify that the font size of the heading message is bigger than that of the normal message
Send a normal single backtick code block e.g. Hello and observe its font size
Send a heading single backtick code block eg: # Hello
Verify that the font size of the heading message is bigger than that of the normal message

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

3dcfd030-8871-4fd6-871e-f5170f9a26a4.mp4

MacOS: Desktop

melvin-bot · 2023-11-03T20:42:46Z

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

github-actions · 2023-11-03T20:42:56Z

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

yakupafsin · 2023-11-03T20:46:30Z

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

src/components/HTMLEngineProvider/HTMLRenderers/CodeRenderer.js

src/components/HTMLEngineProvider/htmlEngineUtils.js

src/components/HTMLEngineProvider/HTMLRenderers/CodeRenderer.js

s77rt · 2023-11-06T15:06:11Z

Please update the test steps to the following:

Open the app
Open any report
Send a normal message and observe its font size
Send a heading message (add # in beginning)
Verify that the font size of the heading message is bigger than that of the normal message
Send a normal single backtick code block e.g. Hello and observe its font size
Send a heading single backtick code block eg: # Hello
Verify that the font size of the heading message is bigger than that of the normal message

src/components/HTMLEngineProvider/HTMLRenderers/CodeRenderer.js

src/styles/StyleUtils.ts

s77rt · 2023-11-06T15:54:33Z

Please run npm run prettier

src/components/HTMLEngineProvider/htmlEngineUtils.js

src/styles/StyleUtils.ts

s77rt · 2023-11-06T16:27:06Z

Please update the tests and the qa tests as mentioned above. Also please complete the screenshots for the rest of the platforms

s77rt · 2023-11-06T16:31:55Z

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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

s77rt · 2023-11-07T12:48:06Z

@yakupafsin Thank you!

PS: Next time please tag me after making such changes because there is no notification for those actions (change title, change description, etc.)

yakupafsin · 2023-11-07T13:17:37Z

@s77rt sorry, I've totally forgotten about it. Thank you for your time. And sorry for the hassle :). It was my first PR with Expensify. I'll try to do it more professionally next time.

roryabraham · 2023-11-07T16:34:48Z

@yakupafsin I will not be able to merge this PR since it contains unsigned commits. Please retroactively sign all the commits for this PR so that I can merge it

roryabraham · 2023-11-07T16:43:09Z

You've also got lint errors it seems

yakupafsin · 2023-11-07T16:46:21Z

@roryabraham because last 2 commits are co-authered woth @s77rt I guess that's why it looks unsigned. We need to undo that 2 commit and re-commit them.

yakupafsin · 2023-11-07T17:32:16Z

@roryabraham I've removed that 2 commits and pushed 2 new commits. I guess all will be signed now.

yakupafsin · 2023-11-07T21:22:15Z

@roryabraham I've double-checked but couldn't find any lint errors.

Mentioned that fontSize controlled by getCodeFontSize function in `StyleUtils.js` Signed-off-by: Yakup Afsin <[email protected]>

Signed-off-by: Yakup Afsin <[email protected]>

yakupafsin · 2023-11-08T00:47:13Z

Hi @roryabraham, I've signed all the commits. Because I've changed my device I forgot change my gitconfig file. Sorry about that. But I've signed them now.

roryabraham · 2023-11-08T03:31:07Z

@yakupafsin looks like we've got some lint errors here: https://github.com/Expensify/App/actions/runs/6792085078/job/18467959217?pr=30876

Also, NAB but if you don't mind I think we could generalize HTMLEngineUtils.isInsideH1 to be something like isChildOfNode:

/**
 * Check if there is an ancestor node for which the predicate returns true.
 *
 * @param {TNode} tnode
 * @param {Function} predicate
 * @returns {Boolean}
 */
function isChildOfNode(tnode, predicate) {
    let currentNode = tnode.parent;
    while (currentNode) {
        if (predicate(currentNode)) {
            return true;
        }
        currentNode = currentNode.parent;
    }
    return false;
}

/**
 * Check if node is a child of a comment tag.
 *
 * @param {TNode} tnode
 * @returns {Boolean}
 */
function isChildOfComment(tnode) {
    return isChildOfNode(tnode, (node) => isCommentTag(node.domNode.name));
}

/**
 * Check if node is a child of an h1 tag.
 *
 * @param {TNode} tnode
 * @returns {Boolean}
 */
function isChildOfH1(tnode) {
    return isChildOfNode(tnode, (node) => node.domNode.name.toLowerCase() === 'h1');
}

yakupafsin · 2023-11-08T09:25:27Z

@roryabraham I was planning to do something like this, but I decided not to touch someone else's code 😅. But yes, that looks better. Let me change it.

yakupafsin · 2023-11-08T10:49:03Z

Hi @roryabraham, I've found the lint error. And also applied the changes on htmlEngineUtils.js

roryabraham · 2023-11-08T15:19:28Z

@yakupafsin please run npm run lint or npm run lint-changed (which is generally faster) to find and address the lint errors.

yakupafsin · 2023-11-08T19:08:47Z

@roryabraham now it's ready to merge I guess :)

OSBotify · 2023-11-08T19:47:27Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

src/components/HTMLEngineProvider/htmlEngineUtils.js

OSBotify · 2023-11-10T15:42:42Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.97-7 🚀

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

OSBotify · 2023-11-10T16:00:33Z

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

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

OSBotify · 2023-11-14T21:54:00Z

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

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

yakupafsin requested a review from a team as a code owner November 3, 2023 20:42

melvin-bot bot requested review from s77rt and removed request for a team November 3, 2023 20:42

yakupafsin changed the title ~~30203 change font size for code block on bold~~ change font size for code block on bold Nov 3, 2023

s77rt reviewed Nov 4, 2023

View reviewed changes

src/components/HTMLEngineProvider/HTMLRenderers/CodeRenderer.js Outdated Show resolved Hide resolved

s77rt reviewed Nov 4, 2023

View reviewed changes

src/components/HTMLEngineProvider/HTMLRenderers/CodeRenderer.js Outdated Show resolved Hide resolved

s77rt suggested changes Nov 4, 2023

View reviewed changes

src/components/HTMLEngineProvider/htmlEngineUtils.js Outdated Show resolved Hide resolved

src/components/HTMLEngineProvider/HTMLRenderers/CodeRenderer.js Outdated Show resolved Hide resolved

s77rt suggested changes Nov 6, 2023

View reviewed changes

src/components/HTMLEngineProvider/HTMLRenderers/CodeRenderer.js Outdated Show resolved Hide resolved

src/styles/StyleUtils.ts Outdated Show resolved Hide resolved

s77rt suggested changes Nov 6, 2023

View reviewed changes

src/components/HTMLEngineProvider/htmlEngineUtils.js Outdated Show resolved Hide resolved

src/styles/StyleUtils.ts Outdated Show resolved Hide resolved

s77rt approved these changes Nov 7, 2023

View reviewed changes

melvin-bot bot requested a review from roryabraham November 7, 2023 12:48

roryabraham changed the title ~~change font size for code block on bold~~ change font size for code block in H1 Nov 7, 2023

roryabraham previously approved these changes Nov 7, 2023

View reviewed changes

yakupafsin dismissed roryabraham’s stale review via da842ee November 7, 2023 17:14

yakupafsin force-pushed the 30203-change-font-size-for-code-block-on-bold branch from aa882a4 to da842ee Compare November 7, 2023 17:14

roryabraham approved these changes Nov 7, 2023

View reviewed changes

yakupafsin added 4 commits November 8, 2023 00:32

Mentioned fontSize controlled in another function

3222677

Mentioned that fontSize controlled by getCodeFontSize function in `StyleUtils.js` Signed-off-by: Yakup Afsin <[email protected]>

Run Prettier for code formatting

4780950

Signed-off-by: Yakup Afsin <[email protected]>

Update htmlEngineUtils.js

2f6b481

Signed-off-by: Yakup Afsin <[email protected]>

Update StyleUtils.ts

2f4fe78

yakupafsin force-pushed the 30203-change-font-size-for-code-block-on-bold branch from 7abef85 to 2f4fe78 Compare November 8, 2023 00:33

yakupafsin requested a review from roryabraham November 8, 2023 00:49

roryabraham previously approved these changes Nov 8, 2023

View reviewed changes

yakupafsin added 2 commits November 8, 2023 10:44

Optimize with isChildOfNode function

e149093

Resolve lint error

29b4d95

yakupafsin dismissed roryabraham’s stale review via 29b4d95 November 8, 2023 10:47

yakupafsin requested a review from roryabraham November 8, 2023 10:52

Using boolean instead Boolean

a4c0db1

roryabraham approved these changes Nov 8, 2023

View reviewed changes

roryabraham merged commit fac5b04 into Expensify:main Nov 8, 2023

OSBotify mentioned this pull request Nov 8, 2023

Deploy Checklist: New Expensify 2023-11-08 #31077

Closed

tgolen reviewed Nov 8, 2023

View reviewed changes

src/components/HTMLEngineProvider/htmlEngineUtils.js Show resolved Hide resolved

yakupafsin mentioned this pull request Nov 8, 2023

Resolving the issue on Merged Pull Request #31081

Closed

59 tasks

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

[HOLD for payment 2023-11-17] [$500] No text size change on bold on single backtick code block #30203

Closed

6 tasks

OSBotify mentioned this pull request Nov 10, 2023

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

Closed

ikevin127 mentioned this pull request Feb 4, 2024

[PAID] [$500] Chat - Font size is smaller in single backtick code block #35746

Closed

6 tasks

change font size for code block in H1 #30876

change font size for code block in H1 #30876

Uh oh!

Conversation

yakupafsin commented Nov 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Nov 3, 2023

Uh oh!

github-actions bot commented Nov 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yakupafsin commented Nov 3, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

s77rt commented Nov 6, 2023

Uh oh!

Uh oh!

Uh oh!

s77rt commented Nov 6, 2023

Uh oh!

Uh oh!

Uh oh!

s77rt commented Nov 6, 2023

Uh oh!

s77rt commented Nov 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

s77rt commented Nov 7, 2023

Uh oh!

yakupafsin commented Nov 7, 2023

Uh oh!

roryabraham commented Nov 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

roryabraham commented Nov 7, 2023

Uh oh!

yakupafsin commented Nov 7, 2023

Uh oh!

yakupafsin commented Nov 7, 2023

Uh oh!

yakupafsin commented Nov 7, 2023

Uh oh!

yakupafsin commented Nov 8, 2023

Uh oh!

roryabraham commented Nov 8, 2023

Uh oh!

yakupafsin commented Nov 8, 2023

Uh oh!

yakupafsin commented Nov 8, 2023

Uh oh!

roryabraham commented Nov 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yakupafsin commented Nov 8, 2023

Uh oh!

OSBotify commented Nov 8, 2023

Uh oh!

Uh oh!

OSBotify commented Nov 10, 2023

Uh oh!

OSBotify commented Nov 10, 2023

Uh oh!

OSBotify commented Nov 14, 2023

Uh oh!

Reviewers

Assignees

Labels

yakupafsin commented Nov 3, 2023 •

edited

Loading

github-actions bot commented Nov 3, 2023 •

edited

Loading

s77rt commented Nov 6, 2023 •

edited

Loading

roryabraham commented Nov 7, 2023 •

edited

Loading

roryabraham commented Nov 8, 2023 •

edited

Loading