update(comment-list): This PR migrates the comment-list component from Classic Ember to Glimmer/Octane architecture, includes extensive refactoring for code quality and maintainability, and adds comprehensive integration tests.

[aadhakal]

Description

This PR migrates the comment-list component from Classic Ember to Glimmer/Octane architecture, includes extensive refactoring for code quality and maintainability, and adds comprehensive integration tests.

What's in this PR

Component Migration (app/components/comment-list.js):

• Replaced Component.extend(ErrorHandlingMixin) with native ES6 class extending @glimmer/component
• Removed Classic Ember properties: elementId, classNames, classNameBindings
• Removed lifecycle hooks: didInsertElement, willDestroyElement (dead code)
• Converted init() to constructor()
• Changed service injections from inject as service to @service decorators:
  • sweet-alert, utility-methods, loading-display, workspace-permissions, currentUser, store, errorHandling
• Replaced ErrorHandlingMixin with error-handling service (3 getters: createRecordErrors, queryErrors, updateRecordErrors)
• Converted 22 computed properties to native getters:
  • Error handling: createRecordErrors, queryErrors, updateRecordErrors
  • Layout: isBipaneled, isTripaneled, showComposeButtons, myCommentsOnly
  • Content: newCommentPlaceholder, filteredComments, displayList, tags, onSelection
  • Permissions: canComment
  • Filters: filterOptions, emptyResultsMessage, resultsDescription, showResultsDescription
  • Date: showApplyDate, sinceDateFormatted
  • Display: sortedDisplayList, showPaginationControl
  • Internal: _isSearchMode
• Converted 13 actions from actions: {} hash to @action decorators:
  • cancelComment, madeSelection, createComment, deleteComment, reuseComment
  • hideComments, updateFilter, searchComments, updateSinceDate
  • initiatePageChange, applySinceDate, superScroll, clearSearchResults
• Replaced this.set/get() with direct property access
• Replaced this.send() with direct method calls
• Replaced this.sendAction() with optional chaining on args
• Removed moment.js: imported date-fns (subYears, format, parseISO), used native Date API
• Removed lodash: replaced with Array.isArray(), Number.isNaN(), Math.random()
• Removed jQuery: replaced with document.querySelector(), native scrollTo()
• CurrentUser Pattern: this.currentUser.id for comparisons, this.currentUser.user for DB relationships

Code Refactoring & Dead Code Removal:

Removed 6 unused items (dead code from Classic Ember):

• @tracked showFilter, isSearching, isChangingPage (never referenced)
• toggleDisplayText getter (never used)
• setCommentLabel, toggleFilter, toggleSearch actions (never called)

Created reusable helper methods:

• updateCommentRelationships() - handle comment relationship updates
• buildSearchOptions() - construct search query options
• _startLoadingSearch() / _endLoadingSearch() - manage loading state

Refactored filteredComments getter for separation of concerns:

• _matchesOwnerFilter() - ownership check
• _matchesSubmissionFilter() - submission match
• _matchesWorkspaceFilter() - workspace match
• _matchesSearchQuery() - search text match
• _sortByDateDescending() - date sorting
• _getFilteredAndSortedComments() - filtered workflow
• _getSelectionComments() - selection workflow

Refactored resultsDescription getter:

• _isSearchMode - mode detection
• _getSearchResultsDescription() - search message
• _getFilterResultsDescription() - filter message

Refactored createComment action:

• _buildCommentData() - data construction
• _handleCommentCreated() - post-save operations

Refactored deleteComment action:

• _handleCommentDeletion() - deletion workflow
• _handleUndoOption() - undo functionality

Improved searchComments action:

• Replace duplicate Date.parse with buildSearchOptions()
• Add finally block for cleanup

Code Cleanup & Optimization:

• Removed showToast wrapper method, use alert.showToast() directly with service defaults
• Removed textContainsTag getter, inlined as this.tags.length > 0
• Removed unused relatedProp field from filterOptions
• Inlined isSinceDateValid getter into showApplyDate
• Use template literal in reuseComment instead of string concatenation
• Fixed comment header to accurately list @arguments vs services
• Updated sinceDate handling for better date validation

Template Changes (app/components/comment-list.hbs):

• Added wrapper div with id='comment-list' and conditional classes
• Replaced {{action}} with {{on "click"}} (10+ instances)
• Replaced {{action (mut)}} with {{fn (mut)}}
• Replaced onclick={{action}} with {{on "click"}}
• Fixed @classBinding to class attribute
• Updated parent-passed args to @ prefix: @isParentWorkspace, @comments, @currentWorkspace, @currentSelection, @containerLayoutClass, @isHidden
• Updated action references: @reuseComment={{this.reuseComment}}, @deleteComment={{this.deleteComment}}, @initiatePageChange={{this.initiatePageChange}}
• Added this. prefix to component properties
• Removed inline jQuery script (scroll visibility logic)
• Updated error loops to use error-handling service getters
• Template file moved from app/templates/components/ (Classic location) to app/components/ (Glimmer location)

Added Comprehensive Integration Tests

New file: tests/integration/components/comment-list-test.js

Test coverage:

• Basic Rendering: Component renders with empty comments, handles null currentSelection, handles empty comments array
• UI Elements & Icons: Shows comment textarea, filter options, scroll icon, label select, hide comments icon, search bar, since date filter; scroll icon toggles between up/down chevrons on click
• Filter Functionality: Workspace and submission filters checked by default, myCommentsOnly filter checked when not parent workspace, workspace filter disabled when isParentWorkspace
• Permissions & Error Messages: Shows parent workspace message when isParentWorkspace and cannot comment, shows permission error when cannot comment and not parent workspace, hides compose buttons/label select/textarea when cannot comment
• Layout Classes: Adds bi-paneled class when containerLayoutClass is hsc, adds tri-paneled class when containerLayoutClass is fsc, adds on-selection class when currentSelection exists, adds can-comment class when user can comment, adds hidden class when isHidden is true
• Compose Actions: Shows cancel and save buttons when on selection, cancel button clears textarea, hides compose buttons when no selection, save button calls createComment when text is entered, does not create comment when textarea is empty or has only whitespace
• Comment Text Validation: Tags extracts hashtags from comment text, validates hashtag presence in comment text
• Loading & Search States: Shows loading message when searching, does not show results description when loading, shows apply button when since date is valid and checked
• Edge Cases: Shows empty message when no comments, label select has notice class by default

All tests passing

Files Changed

• app/components/comment-list.js - Edited
• app/components/comment-list.hbs - Moved from app/templates/components/
• tests/integration/components/comment-list-test.js - Created

[exidy80]

None of the tests pass when I'm on this branch.

[aadhakal]

None of the tests pass when I'm on this branch.

Ah! The tests fail because comment-list depends on workspace-comment and search-bar, and search bar still being migrated to Glimmer. Tests pass with Classic Ember mocks but fail with the real WIP components. Once those dependencies are merged, I'll retest and we can merge comment-list.