Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

Fix internal comment checkbox state not persisting across tab navigation

Kabiru Mwenja61d1ddea4caa
diff --git a/frontend/src/stimulus/controllers/dynamic/work-packages/activities-tab/internal-comment.controller.ts b/frontend/src/stimulus/controllers/dynamic/work-packages/activities-tab/internal-comment.controller.ts
index 39f88eff383..7d03f392ccd 100644
--- a/frontend/src/stimulus/controllers/dynamic/work-packages/activities-tab/internal-comment.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/work-packages/activities-tab/internal-comment.controller.ts
@@ -54,6 +54,11 @@ export default class InternalCommentController extends BaseController {
declare isInternalValue:boolean;
+ connect():void {
+ super.connect();
+ this.restoreInternalState();
+ }
+
onSubmitEnd(_event:CustomEvent):void {
if (this.hasInternalCheckboxTarget) {
this.toggleInternal();
@@ -62,7 +67,7 @@ export default class InternalCommentController extends BaseController {
toggleInternal():void {
const isChecked = this.internalCheckboxTarget.checked;
- this.setInternalState(isChecked);
+ this.setInternalStateWithPersistence(isChecked);
if (isChecked) {
void this.sanitizeInternalMentions();
@@ -83,17 +88,16 @@ export default class InternalCommentController extends BaseController {
this.editorOutlet.focusEditor();
} else {
this.internalCheckboxTarget.checked = true;
- this.setInternalState(this.internalCheckboxTarget.checked);
+ this.setInternalStateWithPersistence(this.internalCheckboxTarget.checked);
this.editorOutlet.focusEditor();
}
}
}
}
- private setInternalState(isChecked:boolean):void {
- this.formContainerTarget.classList.toggle(this.highlightClass, isChecked);
- this.toggleLearnMoreLink(isChecked);
- this.isInternalValue = isChecked;
+ private setInternalStateWithPersistence(isChecked:boolean):void {
+ this.setInternalStateWithoutPersistence(isChecked);
+ this.persistInternalState(isChecked);
}
private toggleLearnMoreLink(isChecked:boolean):void {
@@ -107,7 +111,7 @@ export default class InternalCommentController extends BaseController {
const editorData = this.ckEditorInstance.getData({ trim: false });
if (editorData.length === 0) return;
- const sanitizePath = `/work_packages/${this.indexOutlet.workPackageIdValue}/activities/sanitize_internal_mentions`;
+ const sanitizePath = `/work_packages/${this.workPackageId}/activities/sanitize_internal_mentions`;
try {
const response = await fetch(sanitizePath, {
@@ -149,7 +153,44 @@ export default class InternalCommentController extends BaseController {
});
}
+ private persistInternalState(isChecked:boolean):void {
+ try {
+ localStorage.setItem(this.storageKey, JSON.stringify(isChecked));
+ } catch (error) {
+ console.warn('Failed to persist internal comment state:', error);
+ }
+ }
+
+ private restoreInternalState():void {
+ if (!this.hasInternalCheckboxTarget) return;
+
+ try {
+ const storedState = localStorage.getItem(this.storageKey);
+ if (storedState !== null) {
+ const isChecked = JSON.parse(storedState) as boolean;
+ this.internalCheckboxTarget.checked = isChecked;
+ this.setInternalStateWithoutPersistence(isChecked);
+ }
+ } catch (error) {
+ console.warn('Failed to restore internal comment state:', error);
+ }
+ }
+
+ private setInternalStateWithoutPersistence(isChecked:boolean):void {
+ this.formContainerTarget.classList.toggle(this.highlightClass, isChecked);
+ this.toggleLearnMoreLink(isChecked);
+ this.isInternalValue = isChecked;
+ }
+
private get ckEditorInstance() {
return this.editorOutlet.ckEditorInstance;
}
+
+ private get storageKey():string {
+ return `work-package-${this.workPackageId}-internal-comment-state`;
+ }
+
+ private get workPackageId():string {
+ return String(this.indexOutlet.workPackageIdValue);
+ }
}
diff --git a/spec/features/activities/work_package/internal_comments_spec.rb b/spec/features/activities/work_package/internal_comments_spec.rb
index ee887f732dc..2ea0613b263 100644
--- a/spec/features/activities/work_package/internal_comments_spec.rb
+++ b/spec/features/activities/work_package/internal_comments_spec.rb
@@ -317,6 +317,66 @@ RSpec.describe "Work package internal comments",
end
end
+ describe "internal comment checkbox state persistence" do
+ current_user { project_admin }
+
+ let(:second_work_package) { create(:work_package, project:, author: admin) }
+ let(:second_wp_page) { Pages::FullWorkPackage.new(second_work_package, project) }
+
+ before do
+ wp_page.visit!
+ wp_page.wait_for_activity_tab
+ end
+
+ it "persists checkbox state when switching between work package tabs" do
+ activity_tab.open_new_comment_editor
+ activity_tab.check_internal_comment_checkbox
+ activity_tab.expect_internal_comment_checked
+
+ wp_page.switch_to_tab tab: "relations"
+ wp_page.switch_to_tab tab: "activity"
+ wp_page.wait_for_activity_tab
+
+ activity_tab.open_new_comment_editor
+ activity_tab.expect_internal_comment_checked
+ end
+
+ it "isolates checkbox state between different work packages" do
+ activity_tab.open_new_comment_editor
+ activity_tab.check_internal_comment_checkbox
+ activity_tab.expect_internal_comment_checked
+
+ second_wp_page.visit!
+ second_wp_page.wait_for_activity_tab
+
+ second_wp_activity_tab = Components::WorkPackages::Activities.new(second_work_package)
+ second_wp_activity_tab.open_new_comment_editor
+ second_wp_activity_tab.expect_internal_comment_unchecked
+
+ wp_page.visit!
+ wp_page.wait_for_activity_tab
+
+ activity_tab.open_new_comment_editor
+ activity_tab.expect_internal_comment_checked
+ end
+
+ it "handles localStorage errors gracefully" do
+ page.execute_script(<<~JS)
+ localStorage.setItem = function() {
+ throw new Error('Storage quota exceeded');
+ };
+ JS
+
+ activity_tab.open_new_comment_editor
+ activity_tab.check_internal_comment_checkbox
+ activity_tab.expect_internal_comment_checked
+
+ page.execute_script(<<~JS)
+ localStorage.setItem = Storage.prototype.setItem;
+ JS
+ end
+ end
+
describe "making internal comments public" do
current_user { project_admin }