[issue_tracker] Add Batch Mode #9339

ay-bh · 2024-09-15T19:43:57Z

Brief summary of changes

Implement new ~~"Debug View"~~ "Batch Mode" in Issue Tracker module
Add button to access the new view
Develop tabbed interface for organizing issues by criteria
Create issue management interface within new view

The following features will be implemented in a future PR:

Implement modal for adding comments and managing assignees/watchers
Create new permission issue_tracker_debug_mode_edit

Testing instructions (if applicable)

Navigate to the Issue Tracker module
Verify the presence of the new "Switch to Debug View" button
Access the new view and confirm the tabbed interface for different criteria
Test editing of issues, including changing description, status, priority, and category
Verify that changes made in the Debug View are reflected in the main Issue Tracker view

Link(s) to related issue(s)

Resolves [issue tracker] Alternative view for issue hunting #9268

Demo

Demo.mov

christinerogers · 2024-09-23T22:32:28Z

Great start Ayush! Could you please embed here (or else link) the video, or screenshots are fine.
My comments below are based off the video shared last week--

For the missing modal - could this be fixed before this work is presented to the larger team at the end of September, to avoid confusion and so Debug mode can be fully useful --:
What's missing is the ability to review past comments and add further comments -- Please see where this is visible in the sketches in #9268. This means the Edit Issue button should be called New Comment and it should trigger a modal per the bottom sketch provided.

The reason why --:
We don't really Edit the Issue Description because that would modify/overwrite the original report coming from the client-user research team. So instead the person debugging the issue must add new comments and also review prior comments -- we realize this was not detailed in the #9268 text though quite visible in the design sketch.

@racostas @regisoc let me know asap if this has already been discussed among you.

Thanks Ayush, it's looking solid otherwise.

racostas · 2024-09-26T14:48:16Z

Hi @ay-bh, I reviewed the PR and is looking like a good start indeed.
Yes, the functionality @christinerogers is mentioning it's important, I'm thinking now if it can be somehow be part if this same "view" in place of a new one ( do you think @regisoc that having the latest comments in this same view) will be defeating the purpose of the new view (because will be making the windows too big) or in facts can help to take the decision faster (without going throw the modal windows).

racostas · 2024-09-26T14:50:13Z

@SantiagoTG, your inputs here are also very welcome since you have been working a loot with issue tracker. If you have time to take a look to this proposal you opinion is very important. Thanks.

regisoc · 2024-09-26T14:54:38Z

@racostas @ay-bh to keep you updated, we did not have time to test that together with @SantiagoTG.
The video was looking good. We will try to update you later today.

regisoc · 2024-10-03T20:30:54Z

Hello @ay-bh great start indeed! Here are some comments from both me and @SantiagoTG.
There is a lot to say, but I tried to be exhaustive and integrated description/images/gif to be clear on the reasons behind each point, so don't be discouraged! I love the clean design, and those are more enhancements than problems.

I tried to group comments:

global view:
1. Number of card displayed: How many cards are displayed? Some projects have lots of issues (e.g. around 14k on HBCD right now). Even with a filter active, it might be a very long list. Paginating them could be a good idea.
2. Card ordering: Not thought at first but would be good: have an ordering system, e.g. order ASC/DESC by last comment date. Can be done later.
cards/individual issues: looks good! Good and simple design.
1. issue (?) card date not updating: I tried to update a card but the last update date was not updated. Maybe a bug on my end. Other data were updated.
2. Display last comments: Going back to what @christinerogers and @racostas mentioned: having a quick view on the last few comments is important. It can be up to 3 (maybe?) but would depend on the space required for it. We could split the card horizontally, with the left side = description and the right side = last 1-2-3 comments. I do not think we have a restriction on the maximum height a description can have but we do not want to have cards too big on a screen. So, it could be a fixed max height, if the text in height of the description is more than that, it should be managed as an overflow (collapsible text area).
3. Clearer disabled elements: if the ticket/issue is disabled, do not show it as a clickable dropdown element. it should be an unambiguously non-modifiable static text. Moreover, for each element, there should be a clear text to say which field it is i.e. category, priority, status. We only have 3 right now, but this will be changed.
4. New comment modal: Still missing the comment modal attached to the card, but this still looks good start.
filters: more things to say here. Globally still good, and we can enhance than side.
1. filter checkboxes with lots of items: having an inline list of elements works when there are few, but not on some projects with dozens of them. It will not be ergonomic (e.g. see gif after). A collapsible with a max height, overflow, and listed elements could alleviate that (see issue).
2. Issue redimensioning text area: description label goes wild.
3. Active filters indication: because we can travel from one filter on one tab to another, we can lose the active list of filters. E.g. activating a filter in status tab, then going to another tab category. The first filter is still active but we are not able to see it.
  
  Two things here to help on that side:
  - active filter tracking: something like a number of active filters on each tab title will be a good first step. Something like a badge/pill maybe.
  - reset filter button: a quick way of resetting all filters to the default (no active filters).
4. Site as a base filter/tab: sending issue to people in different site, we could automatically apply some filters based on people location. Site should be a new tab.

That was a lot more to write than expected, but I tried to describe each point.
This PR is good work, and I am eager to see the next steps!

racostas · 2024-10-03T21:20:09Z

Hi @regisoc, very good review in facts. I'm sure @ay-bh can address all of this points before the end of the coding period (end of October). Maybe he can present some of the advances he had been making in two weeks from now. (then do a second final presentation in November 5). I will keep you posted with more details after consulting it with him because he have other commitments in the school as well.
I'm very happy with this first review. What he (and @christinerogers and myself) wanted the most if to have a work that users find useful... and as you mention there are already some steps in this direction.

driusan · 2024-10-04T12:57:01Z

Can we also make sure this has a more descriptive name than "Debug View"? I suggest something like "Batch Mode" since that seems to be what it's doing.

regisoc · 2024-10-04T12:58:18Z

@driusan @ay-bh oh yes I forgot this one :) Good point, batch mode is a good one.
I did not have any good idea the moment I created this ticket.

ay-bh · 2024-10-06T13:19:59Z

Thank you all for your detailed feedback and suggestions. I'll start working on implementing these improvements.

racostas · 2024-10-08T15:22:48Z

Hi @ay-bh, this two changes are looking good. Thanks for the update !
I will be continuously testing, feel free to push any change as soon as its ready since this PR can get big very fast and will be not to easy to test if we wait until all is addressed.

Great work !

racostas

Hi @ay-bh, very nice work !
I have been testing the new modifications and they look great.
I have a couple of comments nevertheless we can address:

I think pagination at the end of the cards will be very useful, right now we have it in the top, can we have it on both (top and bottom) ? This way the user don't have to go to the beginning of the page to go to the next pages or to change the quantity of cards it wants to consult if changes it mind when arriving at the end of the page

Also regarding pagination, by default we start at 20 in most of the LORIS modules, but since the design of this one is particular and the cards to take more screen area I think we can start in 10 as an option for the user. What do yo think ?

I like very much the way you had addressed how to show the comments inside the card ( very nice ). Do you think it will be possible to add a button, or link to show all the comments ? ( this will help the user to decide in long living issues without having to go to the standard view to see all of then)

Again @ay-bh, very good progress !! Looking forward for the new features !!

christinerogers · 2024-10-15T15:46:10Z

Great progress @ay-bh - looking forward to seeing this presented.

Just to check the outstanding permission for issue_tracker_batch_mode_edit (see PR description at top) -- Is this still needed @regisoc @racostas ?
If so, @racostas should it go in this PR or could you help create a new followup issue?
Thanks

regisoc · 2024-10-16T14:00:57Z

@ay-bh I will try to do another review before the end of the week.
@christinerogers good question. Maybe a bit of context: when I thought about it at first, I wanted to have a clear separation between people viewing/editing in "classical" mode (i.e. doing punctual and few assigned tasks), and those who can "batch" process a lot of issues (i.e. reviewing/solving issues, coordinating with people, closing issues). This is because HBCD has quite a number, and the main page takes some time to load i.e. ~10 seconds (can be longer when pressuring the server).
In my mind, "batch" mode is always for editing (and acting on several tickets), there is no big incentive in only viewing (searching information should be done in "classical" mode with numerous filters).
So to answer you, not sure if that is needed, but I am still in favour of having this separation for now.
Maybe you and @racostas have another view on that? I am not strongly attached to it anyway.

regisoc

To add with @racostas previous review:

pagination change at the bottom.
pagination starts at 10 (yes!).
link to all comments. Could be nice, but I think this one is less a priority. All comments can be accessed by clicking the issue ID/title for the full issue view.

Points to be addressed (previous review):

issues pagination: looks ok, but do not have enough issues to test. Maybe easier to test with a pagination at 10 ;)
issues ordering. Not a priority.
bug: issue timestamp not updating: resolved.
display last comments: looks nice!
clearer disabled elements: if possible, change dropdown to a label when it is disabled + add the actual label (category,priority,status). i.e. seomthing like category: aaa.
new modal for comments: partially done. Still needs to modify assigned/watchers but it looks simple and great. Tested with 5 paragraphs of lorem ipsum and still looks nice!
filter block: more genral comment here. The actual design is better but we still cannot track how many filters are selected. I was more thinking about something like this where: we can direct access to all filter in one click, have a visual hint on which filters have selected criteria (badge/number), and collapse the full filter section to focus on issues.

bug: issue with description text area: ok.
filter reset button.
Site filters.

racostas · 2024-10-21T18:27:50Z

Hi @ay-bh, very nice.
Now that we have the possibility of filtering by Site we might want to be able to edit this in the card as we are doing for Category, Priority and Status.

The rest very nice !
Great work !

ay-bh · 2024-10-21T19:08:02Z

Hi @ay-bh, very nice. Now that we have the possibility of filtering by Site we might want to be able to edit this in the card as we are doing for Category, Priority and Status.

The rest very nice ! Great work !

Thank you for reviewing, @racostas. Since @regisoc didn't mention it, and I felt it is not something that is updated regularly, I decided not to include it there to keep the UI clean. Instead, I added it just below the assignee on the top-right.

racostas · 2024-10-22T13:48:34Z

Hi @ay-bh, very nice. Now that we have the possibility of filtering by Site we might want to be able to edit this in the card as we are doing for Category, Priority and Status.
The rest very nice ! Great work !

Thank you for reviewing, @racostas. Since @regisoc didn't mention it, and I felt it is not something that is updated regularly, I decided not to include it there to keep the UI clean. Instead, I added it just below the assignee on the top-right.

@regisoc, according to your experience the site is something the change frequently ? I kind of agree with @ay-bh in this point but I want your inputs since you deal more with users than myself.

I other fronts, the rest of the PR looks good to me. All core functionalities and issues were addressed (in my opinion ). I thinks this PR is ready to be merged. The functionalities that were not high priority could be part of a second PR since this one is getting already big, what do you think @regisoc , @christinerogers ?

racostas

LGTM.
I reviewed and seems to be working fine. I think other functionalities could be addressed in a second PR.
Approved by my end !

christinerogers · 2024-10-22T15:39:05Z

Great work @ay-bh in your Demo today and discussion with the whole LORIS team, this feature is well done and greatly appreciated.

Notes from today: nice to haves and issues for follow-up:

Cecile/Regis: batch-close multiple issues at once
Ayush's next PR will add ability to change assignee (also discussed above in this thread, among other minor features to add), as time permits
Old Issue Tracker page: will still keep because it allows sorting, Download in CSV, public view (so they don't file repeated issues)

Otherwise, no current blockers to getting this merged.
Next steps to ensure this gets merged by Nov. 4 (end of GSOC period):

re-review requested from @regisoc (oct 22)
@driusan to review (starting oct22) and go from there

regisoc

Hello all @ay-bh @racostas @christinerogers, I am happy with this result.
As I said in LORIS meeting, it is a really strong start for a feature that will be useful and is already waited in some cases/projects.

@racostas in my experience, no, site are not changing frequently, not an issue immediately, can be done later on. Already told Ayush that is the case.

I added comments. To sum up: 1/ finish the missing parts, then 2/ stress test this feature. The main goal of this feature was to have a new front-end i.e. an alternative view, but I suspect it can be long to load with lots of issues. Waiting elements to load is one of the main source of frustration.

From what I can see, points for next PR, ordered by priority:

assignee/watchers changes in comment modal.
permission to access this feature, as I do not see it required nor useful for all users (can be discussed).
Change the switch mode button to another, more convenient location. Maybe close to new issue (button only appearing with the right permission).

site change in card main panel.

Points later on (because not part of the original ticket/issue, but still important):

stress test i.e. push 1k, 5k, 10k, 20k, 50k issues with various number of comments and see how the feature behaves.
order card elements in main panel.
batch-close multiple issues at once.

Still, big thanks @ay-bh for this PR, great work!

regisoc · 2024-10-22T20:20:17Z

modules/issue_tracker/php/edit.class.inc

+
+        if ($batch_mode) {
+            // Fetch all issues
+            $allIssues = $this->_getAllIssues($user);


Do we reload all issues every time the batch mode is selected? Maybe something to memoize for both sides or use a lazy loading strategy.

It's a different endpoint with different fields, for e.g. top 3 comments, So memoizing might not make sense. Also the user may not toggle between the modes frequently.

You might be right on the fact they will not change frequently.
I just want to make sure it does not affect too much the wait time.
Good for now.

regisoc · 2024-10-23T13:28:31Z

modules/issue_tracker/jsx/IssueCard.js

+import PropTypes from 'prop-types';
+import swal from 'sweetalert2';
+import Modal from 'jsx/Modal';
+import '../css/issue_card.css';


Normally we inject css from php, but no php backend specific to these new elements, looks ok.

regisoc · 2024-10-23T13:31:49Z

modules/issue_tracker/jsx/IssueCard.js

+IssueCard.propTypes = {
+  issue: PropTypes.shape({
+    issueID: PropTypes.number.isRequired,
+    title: PropTypes.string.isRequired,
+    reporter: PropTypes.string.isRequired,
+    assignee: PropTypes.string,
+    status: PropTypes.string.isRequired,
+    priority: PropTypes.string.isRequired,
+    module: PropTypes.number,
+    dateCreated: PropTypes.string.isRequired,
+    lastUpdate: PropTypes.string,
+    lastUpdatedBy: PropTypes.string,
+    sessionID: PropTypes.number,
+    centerID: PropTypes.number,
+    candID: PropTypes.number,
+    category: PropTypes.string,
+    instrument: PropTypes.string,
+    description: PropTypes.string,
+    PSCID: PropTypes.string,
+    visitLabel: PropTypes.string,
+    topComments: PropTypes.arrayOf(
+      PropTypes.shape({
+        issueComment: PropTypes.string.isRequired,
+        dateAdded: PropTypes.string.isRequired,
+        addedBy: PropTypes.string.isRequired,
+      })
+    ).isRequired,
+  }).isRequired,
+  onUpdate: PropTypes.func.isRequired,
+  statuses: PropTypes.object.isRequired,
+  priorities: PropTypes.object.isRequired,
+  categories: PropTypes.object.isRequired,
+  sites: PropTypes.object.isRequired,
+};


That is a chunky element!

Yeah, it's actually all the data that's coming in issuecard. I wrote it this way so it's clear what all we have. If it's too big, I could maybe just write issue: PropTypes.something, but this way someone else working on this in future may not know what all we are receiving.

No issues, that is fine. Having all in one place is actually very representative of the central element.
I just did not realize it was that big :)

regisoc · 2024-10-23T13:44:26Z

modules/issue_tracker/php/edit.class.inc

Maybe a picky question: why using this file (i.e. edit.class.inc) instead of issue.class.inc for retrieving all issues? Not important, just curious.

The get issue logic for an individual issue (when editing the issue through traditional view) is in the same file.

racostas · 2024-10-24T14:57:28Z

Hi @driusan. This one it's ready for final review.
@ay-bh will be working in the "not priority" features in a second PR. @regisoc made a summary issue here #9418

If you have time to final review this one it will be great since he have less than 2 weeks now to wrap up all his work (including a PR for the "not priority" issues)

Thank you @driusan and sorry for this been need with a bit of pressure from our side.

christinerogers

this comment is relevant to #9422, should not block this PR @ay-bh

christinerogers · 2024-10-28T18:23:45Z

modules/issue_tracker/jsx/issueTrackerIndex.js

-        actions={actions}
-        getFormattedCell={this.formatColumn}
+      <div>
+      <div className="view-toggle">


add condition on this Div -- for #9422, like how permissions are used to show/hide buttons in other modules

ay-bh and others added 12 commits July 16, 2024 11:02

add new issue tracker view

a743530

Add debug mode endpoint

e510526

Integrate the debug endpoint

c4c379d

Improve UI for debug mode

50dd7a6

Add no result message

fc0e9ac

Fix naming conventions

bdc4ecd

Add loader

5c9b1d5

Fix lint issues

05b2537

Merge branch 'aces:main' into feature-issue-hunting

1abe20d

Fix linting issues

3067c74

Fix _getAllIssues return type

74c860d

Fix JS lint issues

0ab2287

ay-bh and others added 2 commits September 26, 2024 16:01

Add temp state for issues to update UI only after backend success

092fe92

Merge branch 'aces:main' into feature-issue-hunting

9a5cc18

cmadjar assigned regisoc Oct 1, 2024

ay-bh changed the title ~~[issue_tracker] Add Debug View~~ [issue_tracker] Add Batch Mode Oct 6, 2024

ay-bh added 2 commits October 6, 2024 09:53

Rename 'Debug View' to 'Batch Mode'

4f4f5c9

Implement client-side pagination

8dc2ae8

racostas added the GSOC Google Summer of Code related label Oct 8, 2024

Merge branch 'aces:main' into feature-issue-hunting

ece25a7

racostas self-requested a review October 15, 2024 13:47

racostas requested changes Oct 15, 2024

View reviewed changes

racostas added the Needs Work PR awaiting additional changes by the author or contains issues that the author needs to fix label Oct 15, 2024

Fix description overflow

12d5816

Refactor filter UI using Panel component

41299c8

regisoc reviewed Oct 17, 2024

View reviewed changes

ay-bh added 6 commits October 17, 2024 14:45

Add pagination row controls at bottom

48e4bd5

Update the minimum rows per page to 10

01bc333

Implement tabbed filters with badges

b05bf16

Add filter reset functionality

1941c2b

Add site filters

822466f

Add labels and spans to improve dropdown UI

498f1fe

racostas self-requested a review October 22, 2024 13:49

racostas approved these changes Oct 22, 2024

View reviewed changes

racostas added Passed Manual Tests PR has undergone proper testing by at least one peer and removed Needs Work PR awaiting additional changes by the author or contains issues that the author needs to fix labels Oct 22, 2024

racostas requested review from regisoc and christinerogers October 22, 2024 14:18

regisoc approved these changes Oct 23, 2024

View reviewed changes

regisoc mentioned this pull request Oct 23, 2024

[issue_tracker] batch mode - follow up #9418

Open

9 tasks

christinerogers mentioned this pull request Oct 25, 2024

[Issue tracker] make Batch mode visible only with developer permission #9422

Open

1 task

christinerogers added the Priority: High PR or issue should be prioritised over others for review and testing label Oct 25, 2024

christinerogers reviewed Oct 28, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[issue_tracker] Add Batch Mode #9339

[issue_tracker] Add Batch Mode #9339

ay-bh commented Sep 15, 2024 •

edited

Loading

christinerogers commented Sep 23, 2024 •

edited

Loading

racostas commented Sep 26, 2024

racostas commented Sep 26, 2024

regisoc commented Sep 26, 2024

regisoc commented Oct 3, 2024

racostas commented Oct 3, 2024

driusan commented Oct 4, 2024

regisoc commented Oct 4, 2024

ay-bh commented Oct 6, 2024

racostas commented Oct 8, 2024

racostas left a comment

christinerogers commented Oct 15, 2024

regisoc commented Oct 16, 2024

regisoc left a comment •

edited by ay-bh

Loading

racostas commented Oct 21, 2024

ay-bh commented Oct 21, 2024

racostas commented Oct 22, 2024

racostas left a comment

christinerogers commented Oct 22, 2024 •

edited

Loading

regisoc left a comment

regisoc Oct 22, 2024

ay-bh Oct 24, 2024

regisoc Oct 24, 2024

regisoc Oct 23, 2024

regisoc Oct 23, 2024

ay-bh Oct 24, 2024

regisoc Oct 24, 2024

regisoc Oct 23, 2024

ay-bh Oct 24, 2024

racostas commented Oct 24, 2024

christinerogers left a comment

christinerogers Oct 28, 2024

[issue_tracker] Add Batch Mode #9339

Are you sure you want to change the base?

[issue_tracker] Add Batch Mode #9339

Conversation

ay-bh commented Sep 15, 2024 • edited Loading

Brief summary of changes

The following features will be implemented in a future PR:

Testing instructions (if applicable)

Link(s) to related issue(s)

Demo

christinerogers commented Sep 23, 2024 • edited Loading

racostas commented Sep 26, 2024

racostas commented Sep 26, 2024

regisoc commented Sep 26, 2024

regisoc commented Oct 3, 2024

racostas commented Oct 3, 2024

driusan commented Oct 4, 2024

regisoc commented Oct 4, 2024

ay-bh commented Oct 6, 2024

racostas commented Oct 8, 2024

racostas left a comment

Choose a reason for hiding this comment

christinerogers commented Oct 15, 2024

regisoc commented Oct 16, 2024

regisoc left a comment • edited by ay-bh Loading

Choose a reason for hiding this comment

racostas commented Oct 21, 2024

ay-bh commented Oct 21, 2024

racostas commented Oct 22, 2024

racostas left a comment

Choose a reason for hiding this comment

christinerogers commented Oct 22, 2024 • edited Loading

regisoc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

racostas commented Oct 24, 2024

christinerogers left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ay-bh commented Sep 15, 2024 •

edited

Loading

christinerogers commented Sep 23, 2024 •

edited

Loading

regisoc left a comment •

edited by ay-bh

Loading

christinerogers commented Oct 22, 2024 •

edited

Loading