ec542a924b
Server side of agent comment suggestions.
- CreateCommentDto gains optional suggestedText (<=2000). CommentService.create
accepts it ONLY for a top-level inline comment with a non-empty selection,
requires it be non-empty and differ from selection (else BadRequest), and
stores it.
- POST /comments/apply-suggestion (ApplySuggestionDto { commentId }): authorizes
with validateCanEdit (applying edits page text) BEFORE any structural check or
mutation, then CommentService.applySuggestion:
- runs the phase-3 collab event applyCommentSuggestion on `page.<pageId>` to
atomically check-and-replace the marked text, returning { applied, currentText };
- applied → stamp suggestion_applied_at/by, auto-resolve the thread, ws
commentUpdated, audit COMMENT_SUGGESTION_APPLIED;
- already-applied (DB) → idempotent success (no re-apply), self-healing the
resolve if it was missed — satisfies the issue's double-click / two-user
race requirement;
- collab verdict applied:false && currentText===suggestedText → idempotent
success (crash between doc mutation and DB write);
- text changed → 409 ConflictException carrying currentText;
- gateway undefined/throw → hard error, never a silent success.
- audit-events: COMMENT_SUGGESTION_APPLIED.
Tests: create validation (reply/no-selection/equal-to-selection rejected;
valid stored) + applySuggestion verdict branches incl. both idempotent paths.
jest src/core/comment: 33 passed.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
292 lines
8.9 KiB
TypeScript
292 lines
8.9 KiB
TypeScript
import {
|
|
Controller,
|
|
Post,
|
|
Body,
|
|
HttpCode,
|
|
HttpStatus,
|
|
UseGuards,
|
|
Inject,
|
|
NotFoundException,
|
|
ForbiddenException,
|
|
BadRequestException,
|
|
} from '@nestjs/common';
|
|
import { CommentService } from './comment.service';
|
|
import { CreateCommentDto } from './dto/create-comment.dto';
|
|
import { UpdateCommentDto } from './dto/update-comment.dto';
|
|
import { ResolveCommentDto } from './dto/resolve-comment.dto';
|
|
import { ApplySuggestionDto } from './dto/apply-suggestion.dto';
|
|
import { PageIdDto, CommentIdDto } from './dto/comments.input';
|
|
import { AuthUser } from '../../common/decorators/auth-user.decorator';
|
|
import { AuthWorkspace } from '../../common/decorators/auth-workspace.decorator';
|
|
import {
|
|
AuthProvenance,
|
|
AuthProvenanceData,
|
|
} from '../../common/decorators/auth-provenance.decorator';
|
|
import { JwtAuthGuard } from '../../common/guards/jwt-auth.guard';
|
|
import { PaginationOptions } from '@docmost/db/pagination/pagination-options';
|
|
import { User, Workspace } from '@docmost/db/types/entity.types';
|
|
import SpaceAbilityFactory from '../casl/abilities/space-ability.factory';
|
|
import { PageRepo } from '@docmost/db/repos/page/page.repo';
|
|
import {
|
|
SpaceCaslAction,
|
|
SpaceCaslSubject,
|
|
} from '../casl/interfaces/space-ability.type';
|
|
import { CommentRepo } from '@docmost/db/repos/comment/comment.repo';
|
|
import { PageAccessService } from '../page/page-access/page-access.service';
|
|
import { AuditEvent, AuditResource } from '../../common/events/audit-events';
|
|
import {
|
|
AUDIT_SERVICE,
|
|
IAuditService,
|
|
} from '../../integrations/audit/audit.service';
|
|
import { WsService } from '../../ws/ws.service';
|
|
|
|
@UseGuards(JwtAuthGuard)
|
|
@Controller('comments')
|
|
export class CommentController {
|
|
constructor(
|
|
private readonly commentService: CommentService,
|
|
private readonly commentRepo: CommentRepo,
|
|
private readonly pageRepo: PageRepo,
|
|
private readonly spaceAbility: SpaceAbilityFactory,
|
|
private readonly pageAccessService: PageAccessService,
|
|
private readonly wsService: WsService,
|
|
@Inject(AUDIT_SERVICE) private readonly auditService: IAuditService,
|
|
) {}
|
|
|
|
@HttpCode(HttpStatus.OK)
|
|
@Post('create')
|
|
async create(
|
|
@Body() createCommentDto: CreateCommentDto,
|
|
@AuthUser() user: User,
|
|
@AuthWorkspace() workspace: Workspace,
|
|
@AuthProvenance() provenance: AuthProvenanceData,
|
|
) {
|
|
const page = await this.pageRepo.findById(createCommentDto.pageId);
|
|
if (!page || page.deletedAt) {
|
|
throw new NotFoundException('Page not found');
|
|
}
|
|
|
|
await this.pageAccessService.validateCanComment(page, user, workspace.id);
|
|
|
|
const comment = await this.commentService.create(
|
|
{
|
|
page,
|
|
workspaceId: workspace.id,
|
|
user,
|
|
},
|
|
createCommentDto,
|
|
provenance,
|
|
);
|
|
|
|
this.auditService.log({
|
|
event: AuditEvent.COMMENT_CREATED,
|
|
resourceType: AuditResource.COMMENT,
|
|
resourceId: comment.id,
|
|
spaceId: page.spaceId,
|
|
metadata: {
|
|
pageId: page.id,
|
|
},
|
|
});
|
|
|
|
return comment;
|
|
}
|
|
|
|
@HttpCode(HttpStatus.OK)
|
|
@Post('/')
|
|
async findPageComments(
|
|
@Body() input: PageIdDto,
|
|
@Body()
|
|
pagination: PaginationOptions,
|
|
@AuthUser() user: User,
|
|
) {
|
|
const page = await this.pageRepo.findById(input.pageId);
|
|
if (!page) {
|
|
throw new NotFoundException('Page not found');
|
|
}
|
|
|
|
await this.pageAccessService.validateCanView(page, user);
|
|
|
|
return this.commentService.findByPageId(page.id, pagination);
|
|
}
|
|
|
|
@HttpCode(HttpStatus.OK)
|
|
@Post('info')
|
|
async findOne(@Body() input: CommentIdDto, @AuthUser() user: User) {
|
|
const comment = await this.commentRepo.findById(input.commentId);
|
|
if (!comment) {
|
|
throw new NotFoundException('Comment not found');
|
|
}
|
|
|
|
const page = await this.pageRepo.findById(comment.pageId);
|
|
if (!page) {
|
|
throw new NotFoundException('Page not found');
|
|
}
|
|
|
|
await this.pageAccessService.validateCanView(page, user);
|
|
|
|
return comment;
|
|
}
|
|
|
|
@HttpCode(HttpStatus.OK)
|
|
@Post('update')
|
|
async update(@Body() dto: UpdateCommentDto, @AuthUser() user: User, @AuthWorkspace() workspace: Workspace) {
|
|
const comment = await this.commentRepo.findById(dto.commentId, {
|
|
includeCreator: true,
|
|
includeResolvedBy: true,
|
|
});
|
|
if (!comment) {
|
|
throw new NotFoundException('Comment not found');
|
|
}
|
|
|
|
const page = await this.pageRepo.findById(comment.pageId);
|
|
if (!page) {
|
|
throw new NotFoundException('Page not found');
|
|
}
|
|
|
|
await this.pageAccessService.validateCanComment(page, user, workspace.id);
|
|
|
|
return this.commentService.update(comment, dto, user);
|
|
}
|
|
|
|
@HttpCode(HttpStatus.OK)
|
|
@Post('resolve')
|
|
async resolve(
|
|
@Body() dto: ResolveCommentDto,
|
|
@AuthUser() user: User,
|
|
@AuthWorkspace() workspace: Workspace,
|
|
@AuthProvenance() provenance: AuthProvenanceData,
|
|
) {
|
|
const comment = await this.commentRepo.findById(dto.commentId, {
|
|
includeCreator: true,
|
|
includeResolvedBy: true,
|
|
});
|
|
if (!comment) {
|
|
throw new NotFoundException('Comment not found');
|
|
}
|
|
|
|
// Only top-level comments can be resolved; replies follow their parent.
|
|
if (comment.parentCommentId) {
|
|
throw new BadRequestException('Only parent comments can be resolved');
|
|
}
|
|
|
|
const page = await this.pageRepo.findById(comment.pageId);
|
|
if (!page) {
|
|
throw new NotFoundException('Page not found');
|
|
}
|
|
|
|
await this.pageAccessService.validateCanComment(page, user, workspace.id);
|
|
|
|
const updated = await this.commentService.resolveComment(
|
|
comment,
|
|
dto.resolved,
|
|
user,
|
|
provenance,
|
|
);
|
|
|
|
this.auditService.log({
|
|
event: dto.resolved
|
|
? AuditEvent.COMMENT_RESOLVED
|
|
: AuditEvent.COMMENT_REOPENED,
|
|
resourceType: AuditResource.COMMENT,
|
|
resourceId: comment.id,
|
|
spaceId: comment.spaceId,
|
|
metadata: {
|
|
pageId: comment.pageId,
|
|
},
|
|
});
|
|
|
|
return updated;
|
|
}
|
|
|
|
@HttpCode(HttpStatus.OK)
|
|
@Post('apply-suggestion')
|
|
async applySuggestion(
|
|
@Body() dto: ApplySuggestionDto,
|
|
@AuthUser() user: User,
|
|
@AuthWorkspace() workspace: Workspace,
|
|
@AuthProvenance() provenance: AuthProvenanceData,
|
|
) {
|
|
const comment = await this.commentRepo.findById(dto.commentId, {
|
|
includeCreator: true,
|
|
includeResolvedBy: true,
|
|
});
|
|
if (!comment) {
|
|
throw new NotFoundException('Comment not found');
|
|
}
|
|
|
|
const page = await this.pageRepo.findById(comment.pageId);
|
|
if (!page || page.deletedAt) {
|
|
throw new NotFoundException('Page not found');
|
|
}
|
|
|
|
// Authorize BEFORE revealing any structural detail about the comment
|
|
// (metadata-disclosure hygiene). Applying a suggestion rewrites the page
|
|
// text, so require edit access (NOT just comment access). Running this
|
|
// first means a cross-workspace user with a guessed comment UUID gets a
|
|
// uniform 403 regardless of the comment's type or suggestion state — it can
|
|
// never distinguish those before the access check. The structural 400s
|
|
// (top-level / has-a-suggested-edit) are re-checked by the service below.
|
|
await this.pageAccessService.validateCanEdit(page, user);
|
|
|
|
// The service re-validates the comment's state, returns idempotent success
|
|
// for an already-applied suggestion, and lets ConflictException (409, with
|
|
// currentText in the payload) propagate untouched.
|
|
return this.commentService.applySuggestion(comment, user, provenance);
|
|
}
|
|
|
|
@HttpCode(HttpStatus.OK)
|
|
@Post('delete')
|
|
async delete(@Body() input: CommentIdDto, @AuthUser() user: User, @AuthWorkspace() workspace: Workspace) {
|
|
const comment = await this.commentRepo.findById(input.commentId);
|
|
if (!comment) {
|
|
throw new NotFoundException('Comment not found');
|
|
}
|
|
|
|
const page = await this.pageRepo.findById(comment.pageId);
|
|
if (!page) {
|
|
throw new NotFoundException('Page not found');
|
|
}
|
|
|
|
await this.pageAccessService.validateCanComment(page, user, workspace.id);
|
|
|
|
// Check if user is the comment owner
|
|
const isOwner = comment.creatorId === user.id;
|
|
|
|
if (isOwner) {
|
|
await this.commentRepo.deleteComment(comment.id);
|
|
} else {
|
|
const ability = await this.spaceAbility.createForUser(
|
|
user,
|
|
comment.spaceId,
|
|
);
|
|
|
|
// Space admin can delete any comment
|
|
if (ability.cannot(SpaceCaslAction.Manage, SpaceCaslSubject.Settings)) {
|
|
throw new ForbiddenException(
|
|
'You can only delete your own comments',
|
|
);
|
|
}
|
|
await this.commentRepo.deleteComment(comment.id);
|
|
}
|
|
|
|
this.wsService.emitCommentEvent(comment.spaceId, comment.pageId, {
|
|
operation: 'commentDeleted',
|
|
pageId: comment.pageId,
|
|
commentId: comment.id,
|
|
});
|
|
|
|
this.auditService.log({
|
|
event: AuditEvent.COMMENT_DELETED,
|
|
resourceType: AuditResource.COMMENT,
|
|
resourceId: comment.id,
|
|
spaceId: comment.spaceId,
|
|
changes: {
|
|
before: {
|
|
pageId: comment.pageId,
|
|
creatorId: comment.creatorId,
|
|
},
|
|
},
|
|
});
|
|
}
|
|
}
|