Skip to content

Commit

Permalink
Add check before delete comment (#165)
Browse files Browse the repository at this point in the history 
* Add check before delete comment

* revert lint change

* fix lint

---------

Co-authored-by: jdickson <[email protected]>
  • Loading branch information
@joeldickson @dicko2
joeldickson and dicko2 authored Dec 18, 2024
1 parent c5b338f commit f429092
Show file tree
Hide file tree
Showing 3 changed files with 122 additions and 61 deletions.
105 changes: 66 additions & 39 deletions src/Provider/GitLab/GitLab.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,24 @@ import { GitLabAdapter } from './GitLabAdapter';
import { AnalyzerBot } from '../../AnalyzerBot/AnalyzerBot';

const mockCurrentUserId = 123456;
const mockNoteIdToBeDeleted = 6544321;

// Create helper function to generate consistent comment keys
const generateCommentKey = (file: string, line: number | undefined, text: string) =>
`${file}:${line}:${text}`;

const mockNotes = [
{ id: 1, author: { id: mockCurrentUserId }, system: true },
{ id: mockNoteIdToBeDeleted, author: { id: mockCurrentUserId }, system: false }, // only one to be deleted
{ id: 3, author: { id: 99 }, system: false },
{
id: 1,
author: { id: mockCurrentUserId },
system: true,
body: 'system message',
},
{
id: 2,
author: { id: mockCurrentUserId },
system: false,
body: 'existing comment',
},
] as MergeRequestNoteSchema[];

const mockVersionId = 3425234;
Expand Down Expand Up @@ -47,7 +59,11 @@ function createGitLab(service: IGitLabMRService, configs: ConfigArgument) {
}

describe('VCS: GitLab', () => {
it('should returns true when there is no error', async () => {
beforeEach(() => {
jest.clearAllMocks();
});

it('should return true when there is no error', async () => {
const service = new MrServiceMock();
const gitLab = createGitLab(service, configs);

Expand All @@ -60,7 +76,7 @@ describe('VCS: GitLab', () => {
expect(result).toBe(true);
});

it('should returns false when there is some error', async () => {
it('should return false when there is some error', async () => {
const service = new MrServiceMock();
const gitLab = createGitLab(service, configs);

Expand All @@ -74,40 +90,32 @@ describe('VCS: GitLab', () => {
expect(result).toBe(false);
});

it('should remove old self comments and reviews and post new ones', async () => {
it('should not create duplicate comments and should create new unique comments', async () => {
const service = new MrServiceMock();
const gitLab = createGitLab(service, { ...configs, removeOldComment: true });

await gitLab.report([
touchFileError,
touchFileWarning,
untouchedError,
untouchedWarning,
// Pre-populate with an existing comment for the error
const existingErrorText = `${touchFileError.source}:${touchFileError.line}::rotating_light: ${touchFileError.msg} \n`;

service.listAllNotes.mockResolvedValue([
...mockNotes,
{
id: 4,
author: { id: mockCurrentUserId },
system: false,
body: existingErrorText,
},
]);

expect(service.listAllNotes).toHaveBeenCalledTimes(1);
expect(service.getCurrentUserId).toHaveBeenCalledTimes(1);

expect(service.deleteNote).toHaveBeenCalledTimes(1);
expect(service.deleteNote).toHaveBeenCalledWith(mockNoteIdToBeDeleted);

expect(service.createMRDiscussion).toHaveBeenNthCalledWith(
1,
mockVersion,
touchFileError.source,
touchFileError.line,
expect.any(String),
);
const gitLab = createGitLab(service, configs);
await gitLab.report([touchFileError, touchFileWarning]);

expect(service.createMRDiscussion).toHaveBeenNthCalledWith(
2,
expect(service.createMRDiscussion).toHaveBeenCalledTimes(1);
expect(service.createMRDiscussion).toHaveBeenCalledWith(
mockVersion,
touchFileWarning.source,
touchFileWarning.line,
expect.any(String),
);

expect(service.createNote).toHaveBeenCalledTimes(1);
});

it('should not comment if there is no relevant lint issue', async () => {
Expand All @@ -120,39 +128,58 @@ describe('VCS: GitLab', () => {
expect(service.createNote).not.toHaveBeenCalled();
});

it('should not create comments that already exist', async () => {
const service = new MrServiceMock();
const gitLab = createGitLab(service, configs);

// Set up mock with existing summary comment
const existingSummaryComment =
'## CodeCoach reports 1 issue\n:rotating_light: 0 error\n:warning: 1 warning';
service.listAllNotes.mockResolvedValue([
{
id: 1,
author: { id: mockCurrentUserId },
system: false,
body: existingSummaryComment,
},
]);

await gitLab.report([touchFileWarning]);
expect(service.createNote).not.toHaveBeenCalled();
});

describe('when failOnWarnings is true', () => {
it('should returns true when there is no error or warning', async () => {
const warningConfigs = { ...configs, failOnWarnings: true };

it('should return true when there is no error or warning', async () => {
const service = new MrServiceMock();
const gitLab = createGitLab(service, { ...configs, failOnWarnings: true });
const gitLab = createGitLab(service, warningConfigs);

const result = await gitLab.report([untouchedError, untouchedWarning]);

expect(result).toBe(true);
});

it('should returns false when there is some error', async () => {
it('should return false when there is some error', async () => {
const service = new MrServiceMock();
const gitLab = createGitLab(service, { ...configs, failOnWarnings: true });
const gitLab = createGitLab(service, warningConfigs);

const result = await gitLab.report([
touchFileError,
untouchedError,
untouchedWarning,
]);

expect(result).toBe(false);
});

it('should returns false when there is some warnings', async () => {
it('should return false when there is some warnings', async () => {
const service = new MrServiceMock();
const gitLab = createGitLab(service, { ...configs, failOnWarnings: true });
const gitLab = createGitLab(service, warningConfigs);

const result = await gitLab.report([
touchFileWarning,
untouchedError,
untouchedWarning,
]);

expect(result).toBe(false);
});
});
Expand Down
77 changes: 56 additions & 21 deletions src/Provider/GitLab/GitLabAdapter.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,68 @@ import { VCSAdapter } from '../@interfaces/VCSAdapter';
import { Diff } from '../../Git/@types/PatchTypes';
import { Log } from '../../Logger';
import { IGitLabMRService } from './IGitLabMRService';
import { MergeRequestDiffVersionsSchema } from '@gitbeaker/core';
import { MergeRequestDiffVersionsSchema, MergeRequestNoteSchema } from '@gitbeaker/core';
import { IAnalyzerBot } from '../../AnalyzerBot/@interfaces/IAnalyzerBot';

export class GitLabAdapter implements VCSAdapter {
private latestMrVersion: MergeRequestDiffVersionsSchema;
private existingComments: Set<string> = new Set();

constructor(private readonly mrService: IGitLabMRService) {}

async init(): Promise<void> {
this.latestMrVersion = await this.mrService.getLatestVersion();
const [latestVersion, userId, notes] = await Promise.all([
this.mrService.getLatestVersion(),
this.mrService.getCurrentUserId(),
this.mrService.listAllNotes(),
]);

this.latestMrVersion = latestVersion;

// Store existing bot comments
notes
.filter(
(note: { author: { id: any }; system: any }) =>
note.author.id === userId && !note.system,
)
.forEach((note: { body: string }) => this.existingComments.add(note.body));

Log.debug(`Found ${this.existingComments.size} existing CodeCoach comments`);
}

private generateCommentKey(
file: string,
line: number | undefined,
text: string,
): string {
return `${file}:${line}:${text}`;
}

async createComment(comment: string): Promise<void> {
if (!this.existingComments.has(comment)) {
await this.mrService.createNote(comment);
this.existingComments.add(comment);
Log.debug('Created new comment');
} else {
Log.debug('Skipped creating duplicate comment');
}
}

async createReviewComment(
text: string,
file: string,
line: number,
nLines?: number,
): Promise<void> {
const commentKey = this.generateCommentKey(file, line, text);

if (!this.existingComments.has(commentKey)) {
await this.mrService.createMRDiscussion(this.latestMrVersion, file, line, text);
this.existingComments.add(commentKey);
Log.debug('Created new review comment');
} else {
Log.debug('Skipped creating duplicate review comment');
}
}

async wrapUp(analyzer: IAnalyzerBot): Promise<boolean> {
Expand All @@ -28,26 +81,8 @@ export class GitLabAdapter implements VCSAdapter {
diff(): Promise<Diff[]> {
return this.mrService.diff();
}
createComment(comment: string): Promise<void> {
return this.mrService.createNote(comment);
}

createReviewComment(text: string, file: string, line: number): Promise<void> {
return this.mrService.createMRDiscussion(this.latestMrVersion, file, line, text);
}

async removeExistingComments(): Promise<void> {
const [userId, notes] = await Promise.all([
this.mrService.getCurrentUserId(),
this.mrService.listAllNotes(),
]);
Log.debug('Get existing CodeCoach comments completed');

const deleteNotes = notes
.filter((note) => note.author.id === userId && !note.system)
.map((note) => this.mrService.deleteNote(note.id));

await Promise.all([...deleteNotes]);
Log.debug('Delete CodeCoach comments completed');
Log.debug('Skipping comment removal as we now handle duplicates on creation');
}
}
1 change: 0 additions & 1 deletion src/Provider/GitLab/IGitLabMRService.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ export interface IGitLabMRService {
deleteNote(noteId: number): Promise<void>;
getCurrentUserId(): Promise<number>;
diff(): Promise<Diff[]>;

getLatestVersion(): Promise<MergeRequestDiffVersionsSchema>;
createMRDiscussion(
latestVersion: MergeRequestDiffVersionsSchema,
Expand Down

0 comments on commit f429092

Please sign in to comment.