test(dashboard): regression for widget removal sync (#15390)

[Ibochkarev]

What does it do?

Adds testRemovedWidgetsNotShownAfterUpdate() in _build/test/Tests/Model/Dashboard/modDashboardTest.php: after saving a customizable dashboard template (user=0) with fewer widgets, user-specific placements stay in sync and render() output matches.

Why is it needed?

Per review on this PR: runtime behavior is already covered by #15390. This test documents and guards that path. #14753 remains the original report context.

How to test

With a configured test DB:

core/vendor/bin/phpunit -c _build/test/phpunit.xml --filter testRemovedWidgetsNotShownAfterUpdate

Related issue(s)/PR(s)

• Related: MODX3 - Default dashboard not respecting removal of widgets #14753
• Behavior under test: Adjust user customized dashboards #15390

[biz87]

Code Review

Summary

Fixes the default dashboard not respecting widget removal (#14753). When a template dashboard (user=0) is updated and a widget is removed, user-specific placements are now also updated. The Dashboard Update processor's setWidgets() is refactored to track added/removed widgets and propagate changes to user placements. The addUserWidgets() method in modDashboard is fixed to sort by rank and use getCollection() instead of getMany(). Includes a comprehensive regression test.

Assessment

Well-structured fix. The setWidgets() refactoring properly separates concerns: syncTemplatePlacements() for the template, propagateAddedWidgets() and propagateRemovedWidgets() for user-specific placements. The test is thorough — creates dashboard, widgets, placements, verifies initial state, performs update, and checks that removed widgets disappear from both template and user placements. Proper cleanup in the test ensures no test data leaks.

Verdict: Approve

[mkschell]

This solution does not appear to take into account the discussion and the lack of consensus on the solution in #14753 . It looks like a low resolution shortcut to resolve the issue as stated, without considering the nuance of the issue.

[mkschell]

On further exploration, I could not reproduce the issue. It appears to have already been solved in 2021 via #15390

The new test testRemovedWidgetsNotShownAfterUpdate is defensible, so perhaps re-submitting the PR with a test that covers the 2021 change would be welcome.

Thanks!

[Ibochkarev]

@mkschell Thanks for the detailed review. I agree the runtime behavior is already covered by #15390 in Dashboard\\Update::setWidgets().

Following your suggestion, I narrowed this PR to a regression test only (testRemovedWidgetsNotShownAfterUpdate), with the docblock explicitly referencing #15390 as the behavior under test and #14753 as the original report context. The earlier refactor, addUserWidgets / getCollection change, and empty-widgets handling are removed so the diff does not duplicate the 2021 fix.

If we want to follow up on the edge case where widgets is an empty array (the old if ($widgets) guard), I am happy to propose that as a separate small PR after maintainer consensus.