mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-10-31 08:00:36 -04:00
226 lines
8.6 KiB
TypeScript
226 lines
8.6 KiB
TypeScript
/*
|
|
* SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
|
|
*
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
|
*/
|
|
import request from 'supertest';
|
|
|
|
import { HistoryEntryImportDto } from '../../src/history/history-entry-import.dto';
|
|
import { HistoryEntry } from '../../src/history/history-entry.entity';
|
|
import { HistoryService } from '../../src/history/history.service';
|
|
import { IdentityService } from '../../src/identity/identity.service';
|
|
import { Note } from '../../src/notes/note.entity';
|
|
import { NotesService } from '../../src/notes/notes.service';
|
|
import { User } from '../../src/users/user.entity';
|
|
import { UsersService } from '../../src/users/users.service';
|
|
import { TestSetup, TestSetupBuilder } from '../test-setup';
|
|
|
|
describe('History', () => {
|
|
let testSetup: TestSetup;
|
|
let historyService: HistoryService;
|
|
let identityService: IdentityService;
|
|
let user: User;
|
|
let note: Note;
|
|
let note2: Note;
|
|
let forbiddenNoteId: string;
|
|
let content: string;
|
|
let agent: request.SuperAgentTest;
|
|
|
|
beforeAll(async () => {
|
|
testSetup = await TestSetupBuilder.create().build();
|
|
|
|
forbiddenNoteId =
|
|
testSetup.configService.get('noteConfig').forbiddenNoteIds[0];
|
|
|
|
const moduleRef = testSetup.moduleRef;
|
|
const username = 'hardcoded';
|
|
const password = 'AHardcodedStrongP@ssword123';
|
|
|
|
await testSetup.app.init();
|
|
content = 'This is a test note.';
|
|
historyService = moduleRef.get(HistoryService);
|
|
const userService = moduleRef.get(UsersService);
|
|
identityService = moduleRef.get(IdentityService);
|
|
user = await userService.createUser(username, 'Testy');
|
|
await identityService.createLocalIdentity(user, password);
|
|
const notesService = moduleRef.get(NotesService);
|
|
note = await notesService.createNote(content, user, 'note');
|
|
note2 = await notesService.createNote(content, user, 'note2');
|
|
agent = request.agent(testSetup.app.getHttpServer());
|
|
await agent
|
|
.post('/api/private/auth/local/login')
|
|
.send({ username: username, password: password })
|
|
.expect(201);
|
|
});
|
|
|
|
afterAll(async () => {
|
|
await testSetup.app.close();
|
|
await testSetup.cleanup();
|
|
});
|
|
|
|
it('GET /me/history', async () => {
|
|
const emptyResponse = await agent
|
|
.get('/api/private/me/history')
|
|
.expect('Content-Type', /json/)
|
|
.expect(200);
|
|
expect(emptyResponse.body.length).toEqual(0);
|
|
const entry = await testSetup.historyService.updateHistoryEntryTimestamp(
|
|
note,
|
|
user,
|
|
);
|
|
const entryDto = await testSetup.historyService.toHistoryEntryDto(entry);
|
|
const response = await agent
|
|
.get('/api/private/me/history')
|
|
.expect('Content-Type', /json/)
|
|
.expect(200);
|
|
expect(response.body.length).toEqual(1);
|
|
expect(response.body[0].identifier).toEqual(entryDto.identifier);
|
|
expect(response.body[0].title).toEqual(entryDto.title);
|
|
expect(response.body[0].tags).toEqual(entryDto.tags);
|
|
expect(response.body[0].pinStatus).toEqual(entryDto.pinStatus);
|
|
expect(response.body[0].lastVisitedAt).toEqual(
|
|
entryDto.lastVisitedAt.toISOString(),
|
|
);
|
|
});
|
|
|
|
describe('POST /me/history', () => {
|
|
it('works', async () => {
|
|
expect(
|
|
await testSetup.historyService.getEntriesByUser(user),
|
|
).toHaveLength(1);
|
|
const pinStatus = true;
|
|
const lastVisited = new Date('2020-12-01 12:23:34');
|
|
const postEntryDto = new HistoryEntryImportDto();
|
|
postEntryDto.note = (await note2.aliases).filter(
|
|
(alias) => alias.primary,
|
|
)[0].name;
|
|
postEntryDto.pinStatus = pinStatus;
|
|
postEntryDto.lastVisitedAt = lastVisited;
|
|
await agent
|
|
.post('/api/private/me/history')
|
|
.set('Content-Type', 'application/json')
|
|
.send(JSON.stringify({ history: [postEntryDto] }))
|
|
.expect(201);
|
|
const userEntries = await testSetup.historyService.getEntriesByUser(user);
|
|
expect(userEntries.length).toEqual(1);
|
|
expect((await (await userEntries[0].note).aliases)[0].name).toEqual(
|
|
(await note2.aliases)[0].name,
|
|
);
|
|
expect((await (await userEntries[0].note).aliases)[0].primary).toEqual(
|
|
(await note2.aliases)[0].primary,
|
|
);
|
|
expect((await (await userEntries[0].note).aliases)[0].id).toEqual(
|
|
(await note2.aliases)[0].id,
|
|
);
|
|
expect((await userEntries[0].user).username).toEqual(user.username);
|
|
expect(userEntries[0].pinStatus).toEqual(pinStatus);
|
|
expect(userEntries[0].updatedAt).toEqual(lastVisited);
|
|
});
|
|
describe('fails', () => {
|
|
let pinStatus: boolean;
|
|
let lastVisited: Date;
|
|
let postEntryDto: HistoryEntryImportDto;
|
|
let prevEntry: HistoryEntry;
|
|
beforeAll(async () => {
|
|
const previousHistory =
|
|
await testSetup.historyService.getEntriesByUser(user);
|
|
expect(previousHistory).toHaveLength(1);
|
|
prevEntry = previousHistory[0];
|
|
pinStatus = !previousHistory[0].pinStatus;
|
|
lastVisited = new Date('2020-12-01 23:34:45');
|
|
postEntryDto = new HistoryEntryImportDto();
|
|
postEntryDto.note = (await note2.aliases).filter(
|
|
(alias) => alias.primary,
|
|
)[0].name;
|
|
postEntryDto.pinStatus = pinStatus;
|
|
postEntryDto.lastVisitedAt = lastVisited;
|
|
});
|
|
it('with forbiddenId', async () => {
|
|
const brokenEntryDto = new HistoryEntryImportDto();
|
|
brokenEntryDto.note = forbiddenNoteId;
|
|
brokenEntryDto.pinStatus = pinStatus;
|
|
brokenEntryDto.lastVisitedAt = lastVisited;
|
|
await agent
|
|
.post('/api/private/me/history')
|
|
.set('Content-Type', 'application/json')
|
|
.send(JSON.stringify({ history: [brokenEntryDto] }))
|
|
.expect(400);
|
|
});
|
|
it('with non-existing note', async () => {
|
|
const brokenEntryDto = new HistoryEntryImportDto();
|
|
brokenEntryDto.note = 'i_dont_exist';
|
|
brokenEntryDto.pinStatus = pinStatus;
|
|
brokenEntryDto.lastVisitedAt = lastVisited;
|
|
await agent
|
|
.post('/api/private/me/history')
|
|
.set('Content-Type', 'application/json')
|
|
.send(JSON.stringify({ history: [brokenEntryDto] }))
|
|
.expect(404);
|
|
});
|
|
afterEach(async () => {
|
|
const historyEntries =
|
|
await testSetup.historyService.getEntriesByUser(user);
|
|
expect(historyEntries).toHaveLength(1);
|
|
expect(await (await historyEntries[0].note).aliases).toEqual(
|
|
await (
|
|
await prevEntry.note
|
|
).aliases,
|
|
);
|
|
expect((await historyEntries[0].user).username).toEqual(
|
|
(await prevEntry.user).username,
|
|
);
|
|
expect(historyEntries[0].pinStatus).toEqual(prevEntry.pinStatus);
|
|
expect(historyEntries[0].updatedAt).toEqual(prevEntry.updatedAt);
|
|
});
|
|
});
|
|
});
|
|
|
|
it('DELETE /me/history', async () => {
|
|
expect(
|
|
(await testSetup.historyService.getEntriesByUser(user)).length,
|
|
).toEqual(1);
|
|
await agent.delete('/api/private/me/history').expect(204);
|
|
expect(
|
|
(await testSetup.historyService.getEntriesByUser(user)).length,
|
|
).toEqual(0);
|
|
});
|
|
|
|
it('PUT /me/history/:note', async () => {
|
|
const entry = await testSetup.historyService.updateHistoryEntryTimestamp(
|
|
note2,
|
|
user,
|
|
);
|
|
expect(entry.pinStatus).toBeFalsy();
|
|
const alias = (await (await entry.note).aliases).filter(
|
|
(alias) => alias.primary,
|
|
)[0].name;
|
|
await agent
|
|
.put(`/api/private/me/history/${alias || 'null'}`)
|
|
.send({ pinStatus: true })
|
|
.expect(200);
|
|
const userEntries = await testSetup.historyService.getEntriesByUser(user);
|
|
expect(userEntries.length).toEqual(1);
|
|
expect(userEntries[0].pinStatus).toBeTruthy();
|
|
await testSetup.historyService.deleteHistoryEntry(note2, user);
|
|
});
|
|
|
|
it('DELETE /me/history/:note', async () => {
|
|
const entry = await historyService.updateHistoryEntryTimestamp(note2, user);
|
|
const alias = (await (await entry.note).aliases).filter(
|
|
(alias) => alias.primary,
|
|
)[0].name;
|
|
const entry2 = await historyService.updateHistoryEntryTimestamp(note, user);
|
|
const entryDto = await historyService.toHistoryEntryDto(entry2);
|
|
await agent
|
|
.delete(`/api/private/me/history/${alias || 'null'}`)
|
|
.expect(204);
|
|
const userEntries = await historyService.getEntriesByUser(user);
|
|
expect(userEntries.length).toEqual(1);
|
|
const userEntryDto = await historyService.toHistoryEntryDto(userEntries[0]);
|
|
expect(userEntryDto.identifier).toEqual(entryDto.identifier);
|
|
expect(userEntryDto.title).toEqual(entryDto.title);
|
|
expect(userEntryDto.tags).toEqual(entryDto.tags);
|
|
expect(userEntryDto.pinStatus).toEqual(entryDto.pinStatus);
|
|
expect(userEntryDto.lastVisitedAt).toEqual(entryDto.lastVisitedAt);
|
|
});
|
|
});
|