/* * SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file) * * SPDX-License-Identifier: AGPL-3.0-only */ import request from 'supertest'; import { AuthConfig } from '../../src/config/auth.config'; import { AliasCreateDto } from '../../src/notes/alias-create.dto'; import { AliasUpdateDto } from '../../src/notes/alias-update.dto'; import { User } from '../../src/users/user.entity'; import { setupSessionMiddleware } from '../../src/utils/session'; import { TestSetup } from '../test-setup'; describe('Alias', () => { let testSetup: TestSetup; let user: User; let content: string; let forbiddenNoteId: string; let agent: request.SuperAgentTest; beforeAll(async () => { testSetup = await TestSetup.create(); forbiddenNoteId = testSetup.configService.get('appConfig').forbiddenNoteIds[0]; const authConfig = testSetup.configService.get('authConfig') as AuthConfig; setupSessionMiddleware(testSetup.app, authConfig); await testSetup.app.init(); user = await testSetup.userService.createUser('hardcoded', 'Testy'); await testSetup.identityService.createLocalIdentity(user, 'test'); content = 'This is a test note.'; agent = request.agent(testSetup.app.getHttpServer()); await agent .post('/api/private/auth/local/login') .send({ username: 'hardcoded', password: 'test' }) .expect(201); }); describe('POST /alias', () => { const testAlias = 'aliasTest'; const newAliasDto: AliasCreateDto = { noteIdOrAlias: testAlias, newAlias: '', }; let publicId = ''; beforeAll(async () => { const note = await testSetup.notesService.createNote( content, user, testAlias, ); publicId = note.publicId; }); it('create with normal alias', async () => { const newAlias = 'normalAlias'; newAliasDto.newAlias = newAlias; const metadata = await agent .post(`/api/private/alias`) .set('Content-Type', 'application/json') .send(newAliasDto) .expect(201); expect(metadata.body.name).toEqual(newAlias); expect(metadata.body.primaryAlias).toBeFalsy(); expect(metadata.body.noteId).toEqual(publicId); const note = await agent .get(`/api/private/notes/${newAlias}`) .expect(200); expect(note.body.metadata.aliases).toContain(newAlias); expect(note.body.metadata.primaryAlias).toBeTruthy(); expect(note.body.metadata.id).toEqual(publicId); }); describe('does not create an alias', () => { it('because of a forbidden alias', async () => { newAliasDto.newAlias = forbiddenNoteId; await agent .post(`/api/private/alias`) .set('Content-Type', 'application/json') .send(newAliasDto) .expect(400); }); it('because of a alias that is a public id', async () => { newAliasDto.newAlias = publicId; await agent .post(`/api/private/alias`) .set('Content-Type', 'application/json') .send(newAliasDto) .expect(400); }); }); }); describe('PUT /alias/{alias}', () => { const testAlias = 'aliasTest2'; const newAlias = 'normalAlias2'; const changeAliasDto: AliasUpdateDto = { primaryAlias: true, }; let publicId = ''; beforeAll(async () => { const note = await testSetup.notesService.createNote( content, user, testAlias, ); publicId = note.publicId; await testSetup.aliasService.addAlias(note, newAlias); }); it('updates a note with a normal alias', async () => { const metadata = await agent .put(`/api/private/alias/${newAlias}`) .set('Content-Type', 'application/json') .send(changeAliasDto) .expect(200); expect(metadata.body.name).toEqual(newAlias); expect(metadata.body.primaryAlias).toBeTruthy(); expect(metadata.body.noteId).toEqual(publicId); const note = await agent .get(`/api/private/notes/${newAlias}`) .expect(200); expect(note.body.metadata.aliases).toContain(newAlias); expect(note.body.metadata.primaryAlias).toBeTruthy(); expect(note.body.metadata.id).toEqual(publicId); }); describe('does not update', () => { it('a note with unknown alias', async () => { await agent .put(`/api/private/alias/i_dont_exist`) .set('Content-Type', 'application/json') .send(changeAliasDto) .expect(404); }); it('if the property primaryAlias is false', async () => { changeAliasDto.primaryAlias = false; await agent .put(`/api/private/alias/${newAlias}`) .set('Content-Type', 'application/json') .send(changeAliasDto) .expect(400); }); }); }); describe('DELETE /alias/{alias}', () => { const testAlias = 'aliasTest3'; const newAlias = 'normalAlias3'; beforeAll(async () => { const note = await testSetup.notesService.createNote( content, user, testAlias, ); await testSetup.aliasService.addAlias(note, newAlias); }); it('deletes a normal alias', async () => { await agent.delete(`/api/private/alias/${newAlias}`).expect(204); await agent.get(`/api/private/notes/${newAlias}`).expect(404); }); it('does not delete an unknown alias', async () => { await agent.delete(`/api/private/alias/i_dont_exist`).expect(404); }); it('does not delete an primary alias (if it is not the only one)', async () => { const note = await testSetup.notesService.getNoteByIdOrAlias(testAlias); await testSetup.aliasService.addAlias(note, newAlias); await agent.delete(`/api/private/alias/${testAlias}`).expect(400); await agent.get(`/api/private/notes/${newAlias}`).expect(200); }); it('deletes a primary alias (if it is the only one)', async () => { await agent.delete(`/api/private/alias/${newAlias}`).expect(204); await agent.delete(`/api/private/alias/${testAlias}`).expect(204); }); }); });