mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2025-05-30 23:05:30 -04:00
Merge pull request #1130 from hedgedoc/history/transaction
This commit is contained in:
David Mehren
GitHub
commit
7adbc72a5f
10 changed files with 252 additions and 196 deletions
|
|
@ -9,7 +9,7 @@ import { LoggerModule } from '../logger/logger.module';
|
|||
import { HistoryService } from './history.service';
|
||||
import { UsersModule } from '../users/users.module';
|
||||
import { NotesModule } from '../notes/notes.module';
|
||||
import { getRepositoryToken } from '@nestjs/typeorm';
|
||||
import { getConnectionToken, getRepositoryToken } from '@nestjs/typeorm';
|
||||
import { Identity } from '../users/identity.entity';
|
||||
import { User } from '../users/user.entity';
|
||||
import { AuthorColor } from '../notes/author-color.entity';
|
||||
|
|
@ -19,23 +19,39 @@ import { Note } from '../notes/note.entity';
|
|||
import { Tag } from '../notes/tag.entity';
|
||||
import { AuthToken } from '../auth/auth-token.entity';
|
||||
import { Revision } from '../revisions/revision.entity';
|
||||
import { Repository } from 'typeorm';
|
||||
import { Connection, Repository } from 'typeorm';
|
||||
import { NotInDBError } from '../errors/errors';
|
||||
import { NoteGroupPermission } from '../permissions/note-group-permission.entity';
|
||||
import { NoteUserPermission } from '../permissions/note-user-permission.entity';
|
||||
import { Group } from '../groups/group.entity';
|
||||
import { ConfigModule } from '@nestjs/config';
|
||||
import appConfigMock from '../config/mock/app.config.mock';
|
||||
import { HistoryEntryImportDto } from './history-entry-import.dto';
|
||||
|
||||
describe('HistoryService', () => {
|
||||
let service: HistoryService;
|
||||
let historyRepo: Repository<HistoryEntry>;
|
||||
let connection;
|
||||
let noteRepo: Repository<Note>;
|
||||
|
||||
type MockConnection = {
|
||||
transaction: () => void;
|
||||
};
|
||||
|
||||
function mockConnection(): MockConnection {
|
||||
return {
|
||||
transaction: jest.fn(),
|
||||
};
|
||||
}
|
||||
|
||||
beforeEach(async () => {
|
||||
const module: TestingModule = await Test.createTestingModule({
|
||||
providers: [
|
||||
HistoryService,
|
||||
{
|
||||
provide: getConnectionToken(),
|
||||
useFactory: mockConnection,
|
||||
},
|
||||
{
|
||||
provide: getRepositoryToken(HistoryEntry),
|
||||
useClass: Repository,
|
||||
|
|
@ -79,6 +95,7 @@ describe('HistoryService', () => {
|
|||
historyRepo = module.get<Repository<HistoryEntry>>(
|
||||
getRepositoryToken(HistoryEntry),
|
||||
);
|
||||
connection = module.get<Connection>(Connection);
|
||||
noteRepo = module.get<Repository<Note>>(getRepositoryToken(Note));
|
||||
});
|
||||
|
||||
|
|
@ -143,10 +160,8 @@ describe('HistoryService', () => {
|
|||
describe('works', () => {
|
||||
const user = {} as User;
|
||||
const alias = 'alias';
|
||||
const pinStatus = true;
|
||||
const lastVisited = new Date('2020-12-01 12:23:34');
|
||||
const historyEntry = HistoryEntry.create(user, Note.create(user, alias));
|
||||
it('without an preexisting entry, without pinStatus and without lastVisited', async () => {
|
||||
it('without an preexisting entry', async () => {
|
||||
jest.spyOn(historyRepo, 'findOne').mockResolvedValueOnce(undefined);
|
||||
jest
|
||||
.spyOn(historyRepo, 'save')
|
||||
|
|
@ -163,65 +178,7 @@ describe('HistoryService', () => {
|
|||
expect(createHistoryEntry.pinStatus).toEqual(false);
|
||||
});
|
||||
|
||||
it('without an preexisting entry, with pinStatus and without lastVisited', async () => {
|
||||
jest.spyOn(historyRepo, 'findOne').mockResolvedValueOnce(undefined);
|
||||
jest
|
||||
.spyOn(historyRepo, 'save')
|
||||
.mockImplementation(
|
||||
async (entry: HistoryEntry): Promise<HistoryEntry> => entry,
|
||||
);
|
||||
const createHistoryEntry = await service.createOrUpdateHistoryEntry(
|
||||
Note.create(user, alias),
|
||||
user,
|
||||
pinStatus,
|
||||
);
|
||||
expect(createHistoryEntry.note.alias).toEqual(alias);
|
||||
expect(createHistoryEntry.note.owner).toEqual(user);
|
||||
expect(createHistoryEntry.user).toEqual(user);
|
||||
expect(createHistoryEntry.pinStatus).toEqual(pinStatus);
|
||||
});
|
||||
|
||||
it('without an preexisting entry, without pinStatus and with lastVisited', async () => {
|
||||
jest.spyOn(historyRepo, 'findOne').mockResolvedValueOnce(undefined);
|
||||
jest
|
||||
.spyOn(historyRepo, 'save')
|
||||
.mockImplementation(
|
||||
async (entry: HistoryEntry): Promise<HistoryEntry> => entry,
|
||||
);
|
||||
const createHistoryEntry = await service.createOrUpdateHistoryEntry(
|
||||
Note.create(user, alias),
|
||||
user,
|
||||
undefined,
|
||||
lastVisited,
|
||||
);
|
||||
expect(createHistoryEntry.note.alias).toEqual(alias);
|
||||
expect(createHistoryEntry.note.owner).toEqual(user);
|
||||
expect(createHistoryEntry.user).toEqual(user);
|
||||
expect(createHistoryEntry.pinStatus).toEqual(false);
|
||||
expect(createHistoryEntry.updatedAt).toEqual(lastVisited);
|
||||
});
|
||||
|
||||
it('without an preexisting entry, with pinStatus and with lastVisited', async () => {
|
||||
jest.spyOn(historyRepo, 'findOne').mockResolvedValueOnce(undefined);
|
||||
jest
|
||||
.spyOn(historyRepo, 'save')
|
||||
.mockImplementation(
|
||||
async (entry: HistoryEntry): Promise<HistoryEntry> => entry,
|
||||
);
|
||||
const createHistoryEntry = await service.createOrUpdateHistoryEntry(
|
||||
Note.create(user, alias),
|
||||
user,
|
||||
pinStatus,
|
||||
lastVisited,
|
||||
);
|
||||
expect(createHistoryEntry.note.alias).toEqual(alias);
|
||||
expect(createHistoryEntry.note.owner).toEqual(user);
|
||||
expect(createHistoryEntry.user).toEqual(user);
|
||||
expect(createHistoryEntry.pinStatus).toEqual(pinStatus);
|
||||
expect(createHistoryEntry.updatedAt).toEqual(lastVisited);
|
||||
});
|
||||
|
||||
it('with an preexisting entry, without pinStatus and without lastVisited', async () => {
|
||||
it('with an preexisting entry', async () => {
|
||||
jest.spyOn(historyRepo, 'findOne').mockResolvedValueOnce(historyEntry);
|
||||
jest
|
||||
.spyOn(historyRepo, 'save')
|
||||
|
|
@ -240,67 +197,6 @@ describe('HistoryService', () => {
|
|||
historyEntry.updatedAt.getTime(),
|
||||
);
|
||||
});
|
||||
|
||||
it('with an preexisting entry, with pinStatus and without lastVisited', async () => {
|
||||
jest.spyOn(historyRepo, 'findOne').mockResolvedValueOnce(historyEntry);
|
||||
jest
|
||||
.spyOn(historyRepo, 'save')
|
||||
.mockImplementation(
|
||||
async (entry: HistoryEntry): Promise<HistoryEntry> => entry,
|
||||
);
|
||||
const createHistoryEntry = await service.createOrUpdateHistoryEntry(
|
||||
Note.create(user, alias),
|
||||
user,
|
||||
pinStatus,
|
||||
);
|
||||
expect(createHistoryEntry.note.alias).toEqual(alias);
|
||||
expect(createHistoryEntry.note.owner).toEqual(user);
|
||||
expect(createHistoryEntry.user).toEqual(user);
|
||||
expect(createHistoryEntry.pinStatus).not.toEqual(pinStatus);
|
||||
expect(createHistoryEntry.updatedAt.getTime()).toBeGreaterThanOrEqual(
|
||||
historyEntry.updatedAt.getTime(),
|
||||
);
|
||||
});
|
||||
|
||||
it('with an preexisting entry, without pinStatus and with lastVisited', async () => {
|
||||
jest.spyOn(historyRepo, 'findOne').mockResolvedValueOnce(historyEntry);
|
||||
jest
|
||||
.spyOn(historyRepo, 'save')
|
||||
.mockImplementation(
|
||||
async (entry: HistoryEntry): Promise<HistoryEntry> => entry,
|
||||
);
|
||||
const createHistoryEntry = await service.createOrUpdateHistoryEntry(
|
||||
Note.create(user, alias),
|
||||
user,
|
||||
undefined,
|
||||
lastVisited,
|
||||
);
|
||||
expect(createHistoryEntry.note.alias).toEqual(alias);
|
||||
expect(createHistoryEntry.note.owner).toEqual(user);
|
||||
expect(createHistoryEntry.user).toEqual(user);
|
||||
expect(createHistoryEntry.pinStatus).toEqual(false);
|
||||
expect(createHistoryEntry.updatedAt).not.toEqual(lastVisited);
|
||||
});
|
||||
|
||||
it('with an preexisting entry, with pinStatus and with lastVisited', async () => {
|
||||
jest.spyOn(historyRepo, 'findOne').mockResolvedValueOnce(historyEntry);
|
||||
jest
|
||||
.spyOn(historyRepo, 'save')
|
||||
.mockImplementation(
|
||||
async (entry: HistoryEntry): Promise<HistoryEntry> => entry,
|
||||
);
|
||||
const createHistoryEntry = await service.createOrUpdateHistoryEntry(
|
||||
Note.create(user, alias),
|
||||
user,
|
||||
pinStatus,
|
||||
lastVisited,
|
||||
);
|
||||
expect(createHistoryEntry.note.alias).toEqual(alias);
|
||||
expect(createHistoryEntry.note.owner).toEqual(user);
|
||||
expect(createHistoryEntry.user).toEqual(user);
|
||||
expect(createHistoryEntry.pinStatus).not.toEqual(pinStatus);
|
||||
expect(createHistoryEntry.updatedAt).not.toEqual(lastVisited);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
|
|
@ -431,6 +327,44 @@ describe('HistoryService', () => {
|
|||
});
|
||||
});
|
||||
|
||||
describe('setHistory', () => {
|
||||
it('works', async () => {
|
||||
const user = {} as User;
|
||||
const alias = 'alias';
|
||||
const note = Note.create(user, alias);
|
||||
const historyEntry = HistoryEntry.create(user, note);
|
||||
const historyEntryImport: HistoryEntryImportDto = {
|
||||
lastVisited: new Date('2020-12-01 12:23:34'),
|
||||
note: alias,
|
||||
pinStatus: true,
|
||||
};
|
||||
const newlyCreatedHistoryEntry: HistoryEntry = {
|
||||
...historyEntry,
|
||||
pinStatus: historyEntryImport.pinStatus,
|
||||
updatedAt: historyEntryImport.lastVisited,
|
||||
};
|
||||
const mockedManager = {
|
||||
find: jest.fn().mockResolvedValueOnce([historyEntry]),
|
||||
findOne: jest.fn().mockResolvedValueOnce(note),
|
||||
remove: jest.fn().mockImplementationOnce((entry: HistoryEntry) => {
|
||||
expect(entry.note.alias).toEqual(alias);
|
||||
expect(entry.pinStatus).toEqual(false);
|
||||
}),
|
||||
save: jest.fn().mockImplementationOnce((entry: HistoryEntry) => {
|
||||
expect(entry.note.alias).toEqual(newlyCreatedHistoryEntry.note.alias);
|
||||
expect(entry.pinStatus).toEqual(newlyCreatedHistoryEntry.pinStatus);
|
||||
expect(entry.updatedAt).toEqual(newlyCreatedHistoryEntry.updatedAt);
|
||||
}),
|
||||
};
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
|
||||
connection.transaction.mockImplementation((cb) => {
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
|
||||
cb(mockedManager);
|
||||
});
|
||||
await service.setHistory(user, [historyEntryImport]);
|
||||
});
|
||||
});
|
||||
|
||||
describe('toHistoryEntryDto', () => {
|
||||
describe('works', () => {
|
||||
it('with aliased note', async () => {
|
||||
|
|
|
|||
|
|
@ -8,19 +8,22 @@ import { Injectable } from '@nestjs/common';
|
|||
import { ConsoleLoggerService } from '../logger/console-logger.service';
|
||||
import { HistoryEntryUpdateDto } from './history-entry-update.dto';
|
||||
import { HistoryEntryDto } from './history-entry.dto';
|
||||
import { InjectRepository } from '@nestjs/typeorm';
|
||||
import { Repository } from 'typeorm';
|
||||
import { InjectConnection, InjectRepository } from '@nestjs/typeorm';
|
||||
import { Connection, Repository } from 'typeorm';
|
||||
import { HistoryEntry } from './history-entry.entity';
|
||||
import { UsersService } from '../users/users.service';
|
||||
import { NotesService } from '../notes/notes.service';
|
||||
import { User } from '../users/user.entity';
|
||||
import { Note } from '../notes/note.entity';
|
||||
import { NotInDBError } from '../errors/errors';
|
||||
import { HistoryEntryImportDto } from './history-entry-import.dto';
|
||||
|
||||
@Injectable()
|
||||
export class HistoryService {
|
||||
constructor(
|
||||
private readonly logger: ConsoleLoggerService,
|
||||
@InjectConnection()
|
||||
private connection: Connection,
|
||||
@InjectRepository(HistoryEntry)
|
||||
private historyEntryRepository: Repository<HistoryEntry>,
|
||||
private usersService: UsersService,
|
||||
|
|
@ -80,25 +83,15 @@ export class HistoryService {
|
|||
* Create or update a history entry by the user and note. If the entry is merely updated the updatedAt date is set to the current date.
|
||||
* @param {Note} note - the note that the history entry belongs to
|
||||
* @param {User} user - the user that the history entry belongs to
|
||||
* @param {boolean} pinStatus - if the pinStatus of the history entry should be set
|
||||
* @param {Date} lastVisited - the last time the associated note was accessed
|
||||
* @return {HistoryEntry} the requested history entry
|
||||
*/
|
||||
async createOrUpdateHistoryEntry(
|
||||
note: Note,
|
||||
user: User,
|
||||
pinStatus?: boolean,
|
||||
lastVisited?: Date,
|
||||
): Promise<HistoryEntry> {
|
||||
let entry = await this.getEntryByNote(note, user);
|
||||
if (!entry) {
|
||||
entry = HistoryEntry.create(user, note);
|
||||
if (pinStatus !== undefined) {
|
||||
entry.pinStatus = pinStatus;
|
||||
}
|
||||
if (lastVisited !== undefined) {
|
||||
entry.updatedAt = lastVisited;
|
||||
}
|
||||
} else {
|
||||
entry.updatedAt = new Date();
|
||||
}
|
||||
|
|
@ -158,6 +151,54 @@ export class HistoryService {
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @async
|
||||
* Replace the user history with the provided history
|
||||
* @param {User} user - the user that get's their history replaces
|
||||
* @param {HistoryEntryImportDto[]} history
|
||||
* @throws {ForbiddenIdError} one of the note ids or alias in the new history are forbidden
|
||||
*/
|
||||
async setHistory(
|
||||
user: User,
|
||||
history: HistoryEntryImportDto[],
|
||||
): Promise<void> {
|
||||
await this.connection.transaction(async (manager) => {
|
||||
const currentHistory = await manager.find<HistoryEntry>(HistoryEntry, {
|
||||
where: { user: user },
|
||||
relations: ['note', 'user'],
|
||||
});
|
||||
for (const entry of currentHistory) {
|
||||
await manager.remove<HistoryEntry>(entry);
|
||||
}
|
||||
for (const historyEntry of history) {
|
||||
this.notesService.checkNoteIdOrAlias(historyEntry.note);
|
||||
const note = await manager.findOne<Note>(Note, {
|
||||
where: [
|
||||
{
|
||||
id: historyEntry.note,
|
||||
},
|
||||
{
|
||||
alias: historyEntry.note,
|
||||
},
|
||||
],
|
||||
});
|
||||
if (note === undefined) {
|
||||
this.logger.debug(
|
||||
`Could not find note '${historyEntry.note}'`,
|
||||
'setHistory',
|
||||
);
|
||||
throw new NotInDBError(
|
||||
`Note with id/alias '${historyEntry.note}' not found.`,
|
||||
);
|
||||
}
|
||||
const entry = HistoryEntry.create(user, note);
|
||||
entry.pinStatus = historyEntry.pinStatus;
|
||||
entry.updatedAt = historyEntry.lastVisited;
|
||||
await manager.save<HistoryEntry>(entry);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Build HistoryEntryDto from a history entry.
|
||||
* @param {HistoryEntry} entry - the history entry to use
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue