Skip to content
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.

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

fix base url not showing for leave messages + minor refactoring #35525

Merged
merged 3 commits into from
Feb 1, 2024

Conversation

blimpich
Copy link
Contributor

@blimpich blimpich commented Jan 31, 2024

Details

This change makes it so that any policychangelog actions will be correctly processed to include the %baseUrl in their messages, including the leave room action. Additionally I refactored the function to be more concise, and to automatically add new policy change actions in the future.

cc: @jasperhuangg

Fixed Issues

$ #35475
PROPOSAL: n/a

Tests

  1. I opened a workspace admins channel that had leave messages in it and clicked on the hyperlinked room text

Offline tests

QA Steps

Same as test.

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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.

Screenshots/Videos

Screenshot 2024-01-31 at 3 10 45 PM

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

and refactor this function so this doesn't happen again and so this
function is more readable
@blimpich blimpich requested a review from a team as a code owner January 31, 2024 23:12
@melvin-bot melvin-bot bot requested review from alitoshmatov and removed request for a team January 31, 2024 23:12
Copy link

melvin-bot bot commented Jan 31, 2024

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

@blimpich blimpich removed the request for review from alitoshmatov January 31, 2024 23:16
src/libs/ReportActionsUtils.ts Show resolved Hide resolved
src/libs/ReportActionsUtils.ts Outdated Show resolved Hide resolved
src/libs/ReportActionsUtils.ts Outdated Show resolved Hide resolved
src/libs/ReportActionsUtils.ts Show resolved Hide resolved
Copy link
Contributor

@jasperhuangg jasperhuangg left a comment

Choose a reason for hiding this comment

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

minor NAB stuff

@@ -39,6 +39,8 @@ type MemberChangeMessageRoomReferenceElement = {

type MemberChangeMessageElement = MessageTextElement | MemberChangeMessageUserMentionElement | MemberChangeMessageRoomReferenceElement;

const policyChangeActionsSet = new Set<string>(Object.values(CONST.REPORT.ACTIONS.TYPE.POLICYCHANGELOG));
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 really think this needs to be a const, why don't we just use new Set<string>(Object.values(CONST.REPORT.ACTIONS.TYPE.POLICYCHANGELOG)) directly?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

See this thread: #35525 (comment).

@blimpich blimpich merged commit c9f7ec3 into main Feb 1, 2024
14 of 20 checks passed
@blimpich blimpich deleted the blimpich-fixBaseUrlForLeaveMsgs branch February 1, 2024 19:25
@blimpich
Copy link
Contributor Author

blimpich commented Feb 1, 2024

I don't think we need the PR reviewer checklist here. I'm still learning when this is and isn't needed, seems like we use it for pretty much every contributor PR and for some Expensify employee created PRs depending on the situation. If anyone thinks this is bad judgement please let me know so that I can learn how and when we think the PR checklist should be applied.

@OSBotify
Copy link
Contributor

OSBotify commented Feb 1, 2024

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

@marcaaron
Copy link
Contributor

No worries @blimpich. My understanding is that we should use it for every PR. Next time, I'd recommend one of these actions:

  • Get an internal engineer to agree to do the checklist + unassign the C+
  • Just let the C+ do the checklist (I usually do this as the checklist can be quite time consuming to work through)
  • Get some sort of confirmation from internal engineers that the checklist can be skipped before merging (e.g. sometimes we skip it for a "straight revert")

@blimpich
Copy link
Contributor Author

blimpich commented Feb 1, 2024

Sounds good! Thank you for the tips Marc! I will make sure to follow that going forward 🙂

@OSBotify
Copy link
Contributor

OSBotify commented Feb 5, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.36-5 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants