[Bugfix:Forum] Sync forum toggle text by Ash092016 · Pull Request #12568 · Submitty/Submitty

Ash092016 · 2026-03-11T15:03:16Z

Why is this Change Important & Necessary?

Currently, the global "Show/Hide Attachments" toggle in the discussion forum functions independently of the individual post "Attachments" buttons. If a user manually opens or closes attachments on a per-post basis, the global menu text and browser cookie become inaccurate (e.g., the menu might show "Show Attachments" even if the user has already manually opened all of them). This PR ensures the UI remains consistent by synchronizing the global state with individual actions.

What is the New Behavior?

Every time an individual post's attachment is toggled, the page is scanned to check if any attachments are currently visible. The global "More" -> "Show/Hide Attachments" button text and the show_forum_attachments cookie are then updated to reflect the actual state of the page.

If at least one attachment is visible, the global button will say "Hide attachments".
If all attachments are closed, the global button will say "Show attachments".

What steps should a reviewer take to reproduce or test the bug or new feature?

Open a forum thread that has multiple posts with attachments.
Click the "More" button and observe the state (default is usually "Show attachments").
Manually click the "Attachments" button on an individual post to show its images.
Open the "More" dropdown again; it should now automatically say "Hide attachments".
Manually hide that post's attachments. The "More" dropdown should now revert to saying "Show attachments".

Automated Testing & Documentation

This is a client-side UI synchronization fix. It has been manually verified to ensure correctly functioning toggles and accurate cookie state updates. No changes to documentation or new automated tests were required for this specific UI patch.

Other information

Breaking Change- No.
Migrations- No.
Security Concerns- None.

…al post toggles

roye2

I did a code & functionality review:

The changes to the code look good and I agree with the method of the implementation (syncing the button with the image loading).
The functionality appears to work in that the button correctly hides and displays all attachments in the forum.

I did however notice that there is a number included on the button, that seems to display whether there are attachments present on the specific forum post you are viewing. I observed that the button will say 0 if there are no images or 1 if there is at least one image.

This may be outside the scope of this pr, but I wonder if it would be possible to update the number associated with the button s.t. it correctly displays the number of attachments in the forum as a whole (since the button is show/hide all for all posts.)

Screenshots attached depict the issue.

codecov · 2026-03-13T03:40:22Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 21.66%. Comparing base (9cb25d6) to head (3e5e05e).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##               main   #12568   +/-   ##
=========================================
  Coverage     21.66%   21.66%           
  Complexity     9637     9637           
=========================================
  Files           268      268           
  Lines         36222    36222           
  Branches        487      487           
=========================================
  Hits           7847     7847           
  Misses        27892    27892           
  Partials        483      483

Flag	Coverage Δ
autograder	`21.32% <ø> (ø)`
js	`2.04% <ø> (ø)`
migrator	`100.00% <ø> (ø)`
php	`20.68% <ø> (ø)`
python_submitty_utils	`80.08% <ø> (ø)`
submitty_daemon_jobs	`91.13% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Ash092016 · 2026-03-13T04:31:12Z

Hi @roye2, I have updated the branch with the requested changes. A new review is required to verify the fixes and to check if the previous CI failures persist.

Regarding the failure in late_submission_warning_messages.spec.js (Cypress Gradeable tests), it appears to be unrelated to my forum changes, as it specifically involves late day calculations. Once the review is complete, we can confirm if this was an intermittent failure or a separate issue.

Ash092016 · 2026-03-13T04:45:21Z

Hi @roye2 , I checked the logic and it looks like the backend is already sending the correct total through {{total_attachments }} in ForumBar.twig.

The issue is actually in forum.js. Inside showAttachmentsOnload(), there's a line that manually overwrites the badge text with $('.attachment-btn').length. Since that only counts what’s currently rendered, it messes up the global total.

If I just pull out this line, it should stay synced with the backend value:
$('#toggle-attachments-button').find('.attachment-badge').text($('.attachment-btn').length);

Should I go ahead and include that fix in this PR, or would you prefer it in a separate one?

roye2 · 2026-03-13T12:05:23Z

@Ash092016 It is fine with me if you add that change to this PR as well, it seems like it is still sort of in the scope of the main issue. I will run the tests once you've done that. The cypress Gradeable test is flaky, there is a PR about a fix currently as far as I am aware :)

Ash092016 · 2026-03-14T14:28:47Z

Hi @roye2 , I've just pushed the fix for the attachment badge count. It now relies on the backend value from the template and won't be overwritten by the JS count anymore.

roye2

I see that you have added the changes to the button, but upon testing I found that the count listed on the button still only references the page / post currently rendered, and not the whole forum. For example, when I am on a post with no attachments, the button says 0. Or, when I am on a post with multiple attachments, the button says 1. (In my test, I have multiple posts with multiple attachments.)

It seems like it may not be a simple fix to actually make the count display properly, so if you determine that the change is too complicated, we can move it to it's own PR and I will approve this one.

Ash092016 · 2026-03-17T15:38:24Z

Hi @roye2, thank you for the detailed feedback!
You're absolutely right—the current count is tied to the backend rendering process, which makes it "context-sensitive" (only counting what's on the page) rather than truly global. I agree that making this count globally accurate while respecting all permission checks is a more complex task than originally anticipated.
I'll look into addressing the global attachment count in a separate, dedicated PR so we can handle the database logic properly there. Looking forward to your approval on this one!

roye2

Aside from reverting the previous change, I approve of the changes made in this PR.

Ash092016 · 2026-03-19T17:24:49Z

Hi @roye2 , I have revert the changes and have added the same!

### Why is this Change Important & Necessary? Fixes Submitty#12477. Currently, the global "Show/Hide Attachments" toggle in the discussion forum functions independently of the individual post "Attachments" buttons. If a user manually opens or closes attachments on a per-post basis, the global menu text and browser cookie become inaccurate (e.g., the menu might show "Show Attachments" even if the user has already manually opened all of them). This PR ensures the UI remains consistent by synchronizing the global state with individual actions. ### What is the New Behavior? Every time an individual post's attachment is toggled, the page is scanned to check if any attachments are currently visible. The global "More" -> "Show/Hide Attachments" button text and the `show_forum_attachments` cookie are then updated to reflect the actual state of the page. - If at least one attachment is visible, the global button will say **"Hide attachments"**. - If all attachments are closed, the global button will say **"Show attachments"**. ### What steps should a reviewer take to reproduce or test the bug or new feature? 1. Open a forum thread that has multiple posts with attachments. 2. Click the **"More"** button and observe the state (default is usually "Show attachments"). 3. Manually click the **"Attachments"** button on an individual post to show its images. 4. Open the **"More"** dropdown again; it should now automatically say **"Hide attachments"**. 5. Manually hide that post's attachments. The **"More"** dropdown should now revert to saying **"Show attachments"**. ### Automated Testing & Documentation This is a client-side UI synchronization fix. It has been manually verified to ensure correctly functioning toggles and accurate cookie state updates. No changes to documentation or new automated tests were required for this specific UI patch. ### Other information - **Breaking Change-** No. - **Migrations-** No. - **Security Concerns-** None.

Fix Submitty#12477: Sync global attachment toggle state with individu…

ddcecb1

…al post toggles

github-project-automation Bot added this to Submitty Development Mar 11, 2026

github-project-automation Bot moved this to Seeking Reviewer in Submitty Development Mar 11, 2026

roye2 self-requested a review March 13, 2026 02:23

roye2 self-assigned this Mar 13, 2026

automateprojectmangement Bot moved this from Seeking Reviewer to In Review in Submitty Development Mar 13, 2026

roye2 reviewed Mar 13, 2026

View reviewed changes

Merge branch 'main' into bugfix/forum-attachment-toggle-sync

ca5923b

Ash092016 requested a review from roye2 March 13, 2026 04:45

Ash092016 added 2 commits March 14, 2026 19:55

Fix forum attachment badge to display global count

c760770

Merge branch 'main' into bugfix/forum-attachment-toggle-sync

b1d88b4

roye2 reviewed Mar 17, 2026

View reviewed changes

Merge branch 'main' into bugfix/forum-attachment-toggle-sync

cf9f4d2

Ash092016 requested a review from roye2 March 17, 2026 15:41

roye2 requested changes Mar 17, 2026

View reviewed changes

Comment thread site/public/js/forum.js

github-project-automation Bot moved this from In Review to Work in Progress in Submitty Development Mar 17, 2026

Update forum attachment badge count logic during thread load

3e5e05e

Ash092016 requested a review from roye2 March 19, 2026 17:24

automateprojectmangement Bot moved this from Work in Progress to In Review in Submitty Development Mar 19, 2026

roye2 approved these changes Mar 20, 2026

View reviewed changes

github-project-automation Bot moved this from In Review to Awaiting Maintainer Review in Submitty Development Mar 20, 2026

bmcutler merged commit a853d1b into Submitty:main Mar 22, 2026
26 checks passed

github-project-automation Bot moved this from Awaiting Maintainer Review to Done in Submitty Development Mar 22, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Bugfix:Forum] Sync forum toggle text#12568

[Bugfix:Forum] Sync forum toggle text#12568
bmcutler merged 6 commits into
Submitty:mainfrom
Ash092016:bugfix/forum-attachment-toggle-sync

Ash092016 commented Mar 11, 2026

Uh oh!

roye2 left a comment

Uh oh!

codecov Bot commented Mar 13, 2026 •

edited

Loading

Uh oh!

Ash092016 commented Mar 13, 2026

Uh oh!

Ash092016 commented Mar 13, 2026

Uh oh!

roye2 commented Mar 13, 2026

Uh oh!

Ash092016 commented Mar 14, 2026

Uh oh!

roye2 left a comment

Uh oh!

Ash092016 commented Mar 17, 2026

Uh oh!

roye2 left a comment

Uh oh!

Uh oh!

Ash092016 commented Mar 19, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

Ash092016 commented Mar 11, 2026

Why is this Change Important & Necessary?

What is the New Behavior?

What steps should a reviewer take to reproduce or test the bug or new feature?

Automated Testing & Documentation

Other information

Uh oh!

roye2 left a comment

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Ash092016 commented Mar 13, 2026

Uh oh!

Ash092016 commented Mar 13, 2026

Uh oh!

roye2 commented Mar 13, 2026

Uh oh!

Ash092016 commented Mar 14, 2026

Uh oh!

roye2 left a comment

Choose a reason for hiding this comment

Uh oh!

Ash092016 commented Mar 17, 2026

Uh oh!

roye2 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Ash092016 commented Mar 19, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov Bot commented Mar 13, 2026 •

edited

Loading