mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-05-19 09:45:37 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #943 from hedgedoc/refactor/getNoteContent

Browse source
This commit is contained in:
David Mehren 2021-02-23 21:05:25 +01:00 • committed by GitHub
commit 3fabf2596a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/api/public/notes/notes.controller.ts
View file

@ -176,7 +176,7 @@ export class NotesController {
if (!this.permissionsService.mayRead(req.user, note)) { if (!this.permissionsService.mayRead(req.user, note)) {
throw new UnauthorizedException('Reading note denied!'); throw new UnauthorizedException('Reading note denied!');
} }
return await this.noteService.getNoteContentByNote(note); return await this.noteService.getNoteContent(note);
} catch (e) { } catch (e) {
if (e instanceof NotInDBError) { if (e instanceof NotInDBError) {
throw new NotFoundException(e.message); throw new NotFoundException(e.message);

20
src/notes/notes.service.spec.ts
View file

@ -180,7 +180,7 @@ describe('NotesService', () => {
}); });
}); });
describe('getNoteContentByNote', () => { describe('getNoteContent', () => {
it('works', async () => { it('works', async () => {
const content = 'testContent'; const content = 'testContent';
jest jest
@ -189,7 +189,7 @@ describe('NotesService', () => {
const newNote = await service.createNote(content); const newNote = await service.createNote(content);
const revisions = await newNote.revisions; const revisions = await newNote.revisions;
jest.spyOn(revisionRepo, 'findOne').mockResolvedValueOnce(revisions[0]); jest.spyOn(revisionRepo, 'findOne').mockResolvedValueOnce(revisions[0]);
service.getNoteContentByNote(newNote).then((result) => { service.getNoteContent(newNote).then((result) => {
expect(result).toEqual(content); expect(result).toEqual(content);
}); });
}); });
@ -575,22 +575,6 @@ describe('NotesService', () => {
}); });
}); });
describe('getNoteContentByIdOrAlias', () => {
it('works', async () => {
const content = 'testContent';
jest
.spyOn(noteRepo, 'save')
.mockImplementation(async (note: Note): Promise<Note> => note);
const newNote = await service.createNote(content);
const revisions = await newNote.revisions;
jest.spyOn(noteRepo, 'findOne').mockResolvedValueOnce(newNote);
jest.spyOn(revisionRepo, 'findOne').mockResolvedValueOnce(revisions[0]);
service.getNoteContentByIdOrAlias('noteThatExists').then((result) => {
expect(result).toEqual(content);
});
});
});
describe('toTagList', () => { describe('toTagList', () => {
it('works', async () => { it('works', async () => {
const note = {} as Note; const note = {} as Note;

15
src/notes/notes.service.ts
View file

@ -112,7 +112,7 @@ export class NotesService {
* @param {Note} note - the note to use * @param {Note} note - the note to use
* @return {string} the content of the note * @return {string} the content of the note
*/ */
async getNoteContentByNote(note: Note): Promise<string> { async getNoteContent(note: Note): Promise<string> {
return (await this.getLatestRevision(note)).content; return (await this.getLatestRevision(note)).content;
} }
@ -266,17 +266,6 @@ export class NotesService {
return await this.noteRepository.save(note); return await this.noteRepository.save(note);
} }
/**
* @async
* Get the current content of the note by either their id or alias.
* @param {string} noteIdOrAlias - the notes id or alias
* @return {string} the content of the note
*/
async getNoteContentByIdOrAlias(noteIdOrAlias: string): Promise<string> {
const note = await this.getNoteByIdOrAlias(noteIdOrAlias);
return this.getNoteContentByNote(note);
}
/** /**
* @async * @async
* Calculate the updateUser (for the NoteDto) for a Note. * Calculate the updateUser (for the NoteDto) for a Note.
@ -360,7 +349,7 @@ export class NotesService {
*/ */
async toNoteDto(note: Note): Promise<NoteDto> { async toNoteDto(note: Note): Promise<NoteDto> {
return { return {
content: await this.getNoteContentByNote(note), content: await this.getNoteContent(note),
metadata: await this.toNoteMetadataDto(note), metadata: await this.toNoteMetadataDto(note),
editedByAtPosition: [], editedByAtPosition: [],
}; };

6
test/public-api/notes.e2e-spec.ts
View file

@ -74,7 +74,7 @@ describe('Notes', () => {
.expect(201); .expect(201);
expect(response.body.metadata?.id).toBeDefined(); expect(response.body.metadata?.id).toBeDefined();
expect( expect(
await notesService.getNoteContentByNote( await notesService.getNoteContent(
await notesService.getNoteByIdOrAlias(response.body.metadata.id), await notesService.getNoteByIdOrAlias(response.body.metadata.id),
), ),
).toEqual(content); ).toEqual(content);
@ -109,7 +109,7 @@ describe('Notes', () => {
.expect(201); .expect(201);
expect(response.body.metadata?.id).toBeDefined(); expect(response.body.metadata?.id).toBeDefined();
return expect( return expect(
await notesService.getNoteContentByNote( await notesService.getNoteContent(
await notesService.getNoteByIdOrAlias(response.body.metadata?.id), await notesService.getNoteByIdOrAlias(response.body.metadata?.id),
), ),
).toEqual(content); ).toEqual(content);
@ -150,7 +150,7 @@ describe('Notes', () => {
.send(changedContent) .send(changedContent)
.expect(200); .expect(200);
await expect( await expect(
await notesService.getNoteContentByNote( await notesService.getNoteContent(
await notesService.getNoteByIdOrAlias('test4'), await notesService.getNoteByIdOrAlias('test4'),
), ),
).toEqual(changedContent); ).toEqual(changedContent);