Skip to content

[C-5026] Optimistic UI tweaks (web only for now)#9816

Merged
DejayJD merged 5 commits intomainfrom
jd/optimistic-ui-tweaks
Sep 20, 2024
Merged

[C-5026] Optimistic UI tweaks (web only for now)#9816
DejayJD merged 5 commits intomainfrom
jd/optimistic-ui-tweaks

Conversation

@DejayJD
Copy link
Contributor

@DejayJD DejayJD commented Sep 20, 2024

Description

Per our discussion with design, we want all comment actions to be optimistic. This seemed "easy" at first but got a little trickier as I needed to tweak some a-query things and a bit of how we structure comments.

Main complications I had to solve after doing this:

  • If a comment is being shown optimistically, we need to disable actions (reacts/etc) happen until its confirmed or these will get blown away
  • We need to determine the ID for the new comment ahead of calling the SDK (previously was in the SDK) - I also needed to pass that through the different a query lifecycle hooks

More TODOs here:

  • Mobile needs the change to disable actions. Will send through in a follow up PR
  • Design mentioned an animation for the optimistic comment appearing would be good
  • Not use a random number for the id

How Has This Been Tested?

web:stage

@changeset-bot
Copy link

changeset-bot bot commented Sep 20, 2024

⚠️ No Changeset found

Latest commit: 397fe0c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

commentsApi.util.updateQueryData(
'getCommentsByTrackId',
{ entityId, userId, limit: 5, offset: page },
{ entityId, userId, limit: 5, offset: page, sortMethod },
Copy link
Contributor Author

@DejayJD DejayJD Sep 20, 2024

Choose a reason for hiding this comment

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

Note: This was missing after our last sort update.
With this addition our optimistic update system is even more brittle than before so once again I'm tempted to refactor our store 💀

Copy link
Contributor

Choose a reason for hiding this comment

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

💀

Copy link
Contributor Author

Choose a reason for hiding this comment

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

😅
I did also observe some bugs with sort data so thats a next week task for me to dig into lol

…jd/optimistic-ui-tweaks

# Conflicts:
#	packages/web/src/components/comments/CommentBlock.tsx
@gitguardian
Copy link

gitguardian bot commented Sep 20, 2024

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
9412812 Triggered Generic Password e91b46a packages/discovery-provider/ddl/docker-compose.yml View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

userId?: number,
page: number = 0
page: number = 0,
sortMethod: TrackCommentsSortMethodEnum = TrackCommentsSortMethodEnum.Top
Copy link
Contributor

Choose a reason for hiding this comment

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

Would we have different sort methods for other comments or could CommentsSortMethodEnum suffice instead of TrackCommentsSortMethodEnum?

Copy link
Contributor Author

@DejayJD DejayJD Sep 20, 2024

Choose a reason for hiding this comment

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

edit: wait I read that wrong, I realize you're just recommending trimming the Tracks word? I believe this was auto-generated so the name is just a bit unfortunate

@audius-infra
Copy link
Collaborator

Preview this change https://demo.audius.co/jd/optimistic-ui-tweaks

Copy link
Contributor

@Kyle-Shanks Kyle-Shanks left a comment

Choose a reason for hiding this comment

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

LGTM, great comments

Copy link
Contributor

@sliptype sliptype left a comment

Choose a reason for hiding this comment

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

Nice work!

const [deleteComment] = useDeleteComment()

// TODO: whats a better way to package this?
// Need to get the status of this comment regardless of where the usePostComment hook was called
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we do usePostCommentStatus(id) or something?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

hmm yeah I'll set that up. Gonna merge this for now and continue on the mobile side

@DejayJD DejayJD merged commit c9f1142 into main Sep 20, 2024
@DejayJD DejayJD deleted the jd/optimistic-ui-tweaks branch September 20, 2024 21:27
audius-infra pushed a commit that referenced this pull request Sep 21, 2024
[e28b82b] Add client support for single transaction reward claiming (#9801) Marcus Pasell
[1696b04] Version Packages (#9772) github-actions[bot]
[1c2edae] Reapply libs split (#9817) Sebastian Klingler
[c9f1142] [C-5026] Optimistic UI tweaks (web only for now) (#9816) JD Francis
[7c4b196] Don't show empty chat prompt for blasts (#9815) Reed
[7ef38cd] [QA-1732] Undo test code to fix unread pill check for notifications (#9814) Kyle Shanks
[ad274d8] [PAY-3214] Add CreateBlast CTA to followers and supporters user lists (web) (#9804) Andrew Mendelsohn
[3f862a8] UDF for chat_allowed (#9789) Steve Perkins
[fa1da71] revert max width on chats (#9806) Andrew Mendelsohn
[6074a68] [PAY-3216] Update upload share buttons (#9805) Andrew Mendelsohn
[b9a8c0b] Revert libs split (#9802) Sebastian Klingler
[8c80712] Fix merge issue (#9800) Sebastian Klingler
[0ea3a11] [QA-1731] Fix key filter label (#9798) Kyle Shanks
[bc28909] Separate libs from main sdk bundle (#9791) Sebastian Klingler
[4d8ad95] Add comment email and push (#9784) Dylan Jeffers
[734f766] [QA-1717] Fix empty unfurl messages for tracks and playlists (#9795) Kyle Shanks
[2faf2e0] Add CHAT routes to static_routes (#9796) Reed
[8b28228] [C-4969] Comment tombstones (#9790) JD Francis
[e613a0b] [PAY-3215] ChatBlastCTA in own followers and supporters screens (#9793) Andrew Mendelsohn
[123403b] [PAY-3211] Chat blast audience display (mobile) (#9792) Andrew Mendelsohn
[d93fcab] [PAY-3210, PAY-3346] Chat blast audience tile (web) (#9778) Andrew Mendelsohn
[32f758d] [QA-1730] Add sort back to the search query (#9787) Kyle Shanks
[2359e1a] Chat fix quicktype (#9782) Steve Perkins
[9be9c3a] [PAY-3209] Chat blast mobile header (#9777) Reed
[9f05224] Use Harmony Artwork for ChatBlastHeader (#9785) Reed
[2d838c5] [C-5024] Add comment notification (#9781) Dylan Jeffers
[a6850d4] Handle dupe comment thread indexing (#9574) Isaac Solo
[c27a040] [C-4826] (web) Comment action confirmation modals & toasts (#9766) JD Francis
[079cd5d] Remove direct only and add noQuote error (#9780) Raymond Jacobson
[68c4084] Fix usdc-usdc purchase (#9779) Raymond Jacobson
[839e1e8] Fix harmony tests (#9775) Sebastian Klingler
[93c216b] [PAY-3367] Mobile chat blast audience/content selection (#9683) Reed
[c6bb074] [PAY-3208] Web chat blast header (#9767) Reed
[bfd9c38] Version Packages (#8915) github-actions[bot]
[afc5416] [C-4970, C-4825] Add comment reports (#9680) Dylan Jeffers
[f38fb31] Improve mobile profile spacing (#9758) Dylan Jeffers
[74ed02a] Fix typecheck (#9768) Sebastian Klingler
[38a5f29] [C-1601] Fix verified badge, Improve text-link (#9757) Dylan Jeffers
[b6b0827] [C-5014] Remove search input auto-correct (#9756) Dylan Jeffers
[d7c8a4c] [C-4973] Add edit comment e2e (#9679) Dylan Jeffers
[5c839b9] Harmonize web challenge UI (#9762) Reed
[94f614d] Fix composer input error and styling for DMs (#9765) Kyle Shanks
[99fb10f] [C-4971] Add comment pin e2e (#9678) Dylan Jeffers
[59c2d6e] [C-4988] Update mobile TrackScreen layout for remixes + comments (#9657) Sebastian Klingler
[66b1b2c] [C-4943] Add comment sort (#9672) Dylan Jeffers
[be35c44] Fixing lint from bad merge (#9764) Kyle Shanks
[85be4f0] [QA-1326] Update challenge button labels to match spec (#9743) Reed
[8e4f02b] [C-4871] Add timestamp highlighting for composer input (#9761) Kyle Shanks
[0a67586] Add tab completion for compose UI autocomplete (#9682) Kyle Shanks
[85b27c4] [C-5020] Search filter fixes for FilterButton (#9763) Sebastian Klingler
[921f74d] Revert "[PAY-3388] Migrate feed to SDK (#9593)" (#9754) Randy Schott
[fc257e1] Fix challenge summary table (#9755) Reed
[ab45d0e] [QA-1713] Add filter input to feature flag modal (#9740) Dylan Jeffers
schottra added a commit that referenced this pull request Sep 23, 2024
* origin/main: (161 commits)
  Audius Client (Web and Mobile) v1.5.100
  Add client support for single transaction reward claiming (#9801)
  Enable audiusd workflow in main release (#9820)
  Version Packages (#9772)
  Add audius-d to monorepo (#9808)
  push cmds for core (#9807)
  Reapply libs split (#9817)
  [C-5026] Optimistic UI tweaks (web only for now) (#9816)
  Reactions also unset is_hidden for blast sender (#9813)
  Don't show empty chat prompt for blasts (#9815)
  [QA-1732] Undo test code to fix unread pill check for notifications (#9814)
  [PAY-3214] Add CreateBlast CTA to followers and supporters user lists (web) (#9804)
  [PAY-3426] Set unread count when seeding chats with blasts (#9812)
  [C-5033] Prevent notification when artist comments (#9799)
  Add back /d route, aka /uptime (#9809)
  UDF for chat_allowed (#9789)
  Audius Protocol v0.6.195
  revert max width on chats (#9806)
  [PAY-3216] Update upload share buttons (#9805)
  Revert libs split (#9802)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants