Use the filter param in server-side disputes CSV export #9988
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Test the buildOption 1. Jetpack Beta
Option 2. Jurassic Ninja - available for logged-in A12s🚀 Launch a JN site with this branch 🚀 ℹ️ Install this Tampermonkey script to get more options. Build info:
Note: the build is updated when a new commit is pushed to this PR. |
|
Size Change: +59 B (0%) Total Size: 1.39 MB
ℹ️ View Unchanged
|
Jinksi
reviewed
Dec 18, 2024
client/data/disputes/resolvers.js
Outdated
Comment on lines
42
to
49
| const queryWithSearch = { | ||
| ...query, | ||
| search: | ||
| query.filter === 'awaiting_response' | ||
| ? disputeAwaitingResponseStatuses | ||
| : query.search, | ||
| }; | ||
|
|
There was a problem hiding this comment.
💭 it might be better for consistency to apply this in a single place for all /disputes/,/disputes/download,/disputes/summary API requests – I think formatQueryFilters in this file would be suitable since it is also where we are modifying the query in other ways.
const formatQueryFilters = ( query ) => ( {
user_email: query.userEmail,
match: query.match,
store_currency_is: query.storeCurrencyIs,
date_before: formatDateValue( query.dateBefore, true ),
date_after: formatDateValue( query.dateAfter ),
date_between: query.dateBetween && [
formatDateValue( query.dateBetween[ 0 ] ),
formatDateValue( query.dateBetween[ 1 ], true ),
],
- search: query.search,
+ // If `awaiting_response` filter is present, use the `search` query to select only those disputes awaiting a response.
+ search:
+ query.filter === 'awaiting_response'
+ ? disputeAwaitingResponseStatuses
+ : query.search,
status_is: query.statusIs,
status_is_not: query.statusIsNot,
locale: query.locale,
} );This would then mean we can apply the same filtering to all requests, reducing the chance of inconsistency bugs like the one we're solving in this PR.
We implemented (or really, I did, if looking at git blame) the following awaiting_response filtering in the useDisputes hook, which can be removed if we apply this logic across to all "dispute list" requests. We'd have to do some extra testing to make sure we don't break those endpoints, but it would be worth it IMO.
woocommerce-payments/client/data/disputes/hooks.ts
Lines 101 to 104 in a89f434
There was a problem hiding this comment.
Not to say your solution doesn't work, by the way! But it will mean we are applying this logic in different places for different endpoints (/disputes/, /disputes/download, /disputes/summary).
There was a problem hiding this comment.
Thanks for the review @Jinksi, I've consolidated the code into formatQueryFilters
Manual test✅ - Manual test passes I have 22 disputes on my test site. I enforced the code to always do endpoint export for the purpose of testing.
|
nagpai
approved these changes
Dec 18, 2024
6 tasks
Jinksi
approved these changes
Dec 19, 2024
There was a problem hiding this comment.
🌟 Thanks for applying this filter consistently across the /disputes, /disputes/summary, /disputes/download endpoints.
The disputes list view filtering works as expected for the:
Needs responsefilter ✅Advancedfilter ✅- no filter ✅
CSV exporting is also working as intended ✅
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #9987
Filtering for
awaiting_responsewas implemented separately foruseDisputesanduseDisputesSummaryand missing forgetDisputesCSV, causing the bug where the CSV was not filtered.Changes proposed in this Pull Request
awaiting_responseinformatQueryFiltershooks.tsfilterparam togetDisputesCSVTesting instructions
Needs Responseand advanced filters.npm run changelogto add a changelog file, choosepatchto leave it empty if the change is not significant. You can add multiple changelog files in one PR by running this command a few times.Post merge