[ADF-5580] emit commentAdded event from adf-comments component (#10966)

* [ADF-5580] emit commentAdded event from adf-comments component

* [ADF-5580] Emit commentAdded event from adf-comments and expose it in adf-node-comments

* [ADF-5580] Emit commentAdded event from NodeCommentsComponent, add unit test, and update docs

* [ADF-5580] Add unit test for commentAdded output in NodeCommentsComponent, update docs and create testing utils

* [ADF-5580] Mark debugElement as readOnly

* [ADF-5580] Add mock services and fix unit test setup

* [ADF-5580] Reuse shared comment mocks across multiple test files

* [ADF-5580] Align comments component documentation

* [ADF-5580] Remove redundant setup and use ContentTestingModule in comment components tests
This commit is contained in:
Shivangi Shree
2025-07-01 13:54:07 +05:30
committed by GitHub
parent 5d043e6987
commit 6dafcb4447
7 changed files with 126 additions and 15 deletions

View File

@@ -15,7 +15,8 @@ Displays comments from users involved in a specified content and allows an invol
```html
<adf-node-comments
[nodeId]="YOUR_NODE_ID"
[readOnly]="YOUR_READ_ONLY_FLAG">
[readOnly]="YOUR_READ_ONLY_FLAG"
(commentAdded)="onCommentAdded($event)">
</adf-node-comments>
```
@@ -24,6 +25,12 @@ Displays comments from users involved in a specified content and allows an invol
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| -------- | --------- | ------------- | ----------------------------------------------------------------------------------- |
| nodeId | `string` | | nodeId of the document that has comments |
| readOnly | `boolean` | | make the [comments component](../../core/components/comments.component.md) readOnly |
### Events
| Name | Type | Description |
| ------------ | ------------------------------------------------------------------------ | ------------------------------------------------- |
| commentAdded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)<CommentModel> | Emitted when a new comment is successfully added. |

View File

@@ -15,7 +15,8 @@ Displays comments from users involved in a specified environment and allows an i
```html
<adf-comments
[id]="YOUR_ID"
[readOnly]="YOUR_READ_ONLY_FLAG">
[readOnly]="YOUR_READ_ONLY_FLAG"
(commentAdded)="onCommentAdded($event)">
</adf-comments>
```
@@ -24,12 +25,13 @@ Displays comments from users involved in a specified environment and allows an i
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| -------- | --------- | ------------- | --------------------------- |
| id | `string` | | The numeric ID of the task. |
| readOnly | `boolean` | false | Are the comments read only? |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| ------------ | --------------------------------------------------------------------------- | --------------------------------------------------------------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs while displaying/adding a comment. |
| commentAdded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<CommentModel>` | Emitted when a new comment is successfully added. |

View File

@@ -1,4 +1,5 @@
<adf-comments
[readOnly]="readOnly"
[id]="nodeId"
(commentAdded)="commentAdded.emit($event)"
/>

View File

@@ -0,0 +1,65 @@
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { ComponentFixture, TestBed } from '@angular/core/testing';
import { NodeCommentsComponent } from './node-comments.component';
import { CommentsComponent } from '../../../../core/src/lib/comments/comments.component';
import { CommentModel } from '../../../../core/src/lib/models';
import { UnitTestingUtils } from '../../../../core/src/lib/testing/unit-testing-utils';
import { ContentTestingModule } from '../testing/content.testing.module';
describe('NodeCommentsComponent', () => {
let fixture: ComponentFixture<NodeCommentsComponent>;
let component: NodeCommentsComponent;
let testingUtils: UnitTestingUtils;
beforeEach(async () => {
await TestBed.configureTestingModule({
imports: [NodeCommentsComponent, ContentTestingModule]
}).compileComponents();
fixture = TestBed.createComponent(NodeCommentsComponent);
component = fixture.componentInstance;
testingUtils = new UnitTestingUtils(fixture.debugElement);
component.nodeId = 'test-node-id';
fixture.detectChanges();
});
it('should emit commentAdded when CommentsComponent emits', () => {
const mockComment: CommentModel = {
id: '123',
message: 'Sample comment',
created: new Date(),
createdBy: {
id: 'user1',
displayName: 'User 1',
avatarId: 'avatar-123'
},
isSelected: false,
hasAvatarPicture: true,
userDisplayName: 'User 1',
userInitials: 'U1'
};
spyOn(component.commentAdded, 'emit');
const commentsComponent: CommentsComponent = testingUtils.getByDirective(CommentsComponent).componentInstance;
commentsComponent.commentAdded.emit(mockComment);
expect(component.commentAdded.emit).toHaveBeenCalledWith(mockComment);
});
});

View File

@@ -15,8 +15,8 @@
* limitations under the License.
*/
import { Component, Input, ViewEncapsulation } from '@angular/core';
import { ADF_COMMENTS_SERVICE, CommentsComponent } from '@alfresco/adf-core';
import { Component, EventEmitter, Input, Output, ViewEncapsulation } from '@angular/core';
import { ADF_COMMENTS_SERVICE, CommentModel, CommentsComponent } from '@alfresco/adf-core';
import { NodeCommentsService } from './services/node-comments.service';
@Component({
@@ -40,4 +40,8 @@ export class NodeCommentsComponent {
/** make the comments component readOnly */
@Input()
readOnly: boolean;
/** Emits when a new comment is added */
@Output()
commentAdded = new EventEmitter<CommentModel>();
}

View File

@@ -26,6 +26,7 @@ import { NoopAnimationsModule } from '@angular/platform-browser/animations';
import { NoopTranslateModule } from '../testing/noop-translate.module';
import { UnitTestingUtils } from '../testing/unit-testing-utils';
import { MatError } from '@angular/material/form-field';
import { CommentModel } from '../models';
describe('CommentsComponent', () => {
let component: CommentsComponent;
@@ -122,6 +123,32 @@ describe('CommentsComponent', () => {
expect(testingUtils.getByCSS('#comment-input')).not.toBeNull();
});
it('should emit commentAdded when a new comment is added successfully', () => {
const emitSpy = spyOn(component.commentAdded, 'emit');
const mockComment: CommentModel = {
id: 'comment-123',
message: 'New test comment',
created: new Date(),
createdBy: {
id: 'user-1',
displayName: 'John Doe',
avatarId: 'avatar-001'
},
isSelected: false,
hasAvatarPicture: false,
userDisplayName: 'John Doe',
userInitials: 'JD'
};
component.id = '123';
component.commentControl.setValue('New test comment');
addCommentSpy.and.returnValue(of(mockComment));
component.addComment();
expect(emitSpy).toHaveBeenCalledWith(mockComment);
});
it('should not display comments input when the entity is readonly', async () => {
component.readOnly = true;

View File

@@ -57,6 +57,10 @@ export class CommentsComponent implements OnChanges {
@Output()
error = new EventEmitter<any>();
/** Emits when a new comment is added */
@Output()
commentAdded = new EventEmitter<CommentModel>();
comments: CommentModel[] = [];
beingAdded: boolean = false;
@@ -113,6 +117,7 @@ export class CommentsComponent implements OnChanges {
next: (res) => {
this.addToComments(res);
this.commentControl.reset();
this.commentAdded.emit(res);
},
error: (err) => {
this.error.emit(err);