Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(parent structure): add method that return note parent structure #276

Merged
merged 32 commits into from
Oct 26, 2024
Merged
Show file tree
Hide file tree
Changes from 28 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
df44b32
feat(parent structure): add method that return note parent structure
dependentmadani Aug 29, 2024
0551b9f
update: start doing the search in team storage
dependentmadani Sep 1, 2024
a5adcc2
update: first part of code review is done
dependentmadani Sep 4, 2024
bccf7b1
fix: finish the review modifications
dependentmadani Sep 4, 2024
42cb421
update: first part of modification after review
dependentmadani Sep 6, 2024
bb6caff
fix: build problem fixed
dependentmadani Sep 6, 2024
a11d1f8
update(note request): update the content send in get request of note …
dependentmadani Sep 7, 2024
0e3e8f0
update(tests): add different tests for the note parent structure
dependentmadani Sep 8, 2024
3adff28
update(tests): tests are now functional
dependentmadani Sep 9, 2024
d6c9ded
update (parents note): modification based on the reviews, still tests…
dependentmadani Sep 14, 2024
6bdc56a
update: fix lint
dependentmadani Sep 14, 2024
6cf3d4c
update (note parents): few modification in the return value type, add…
dependentmadani Sep 15, 2024
1809ca1
update: add a test
dependentmadani Sep 15, 2024
ca7a9a2
update (note parents): modifications based on reviews, use test.each …
dependentmadani Sep 18, 2024
e14d948
update (parent note test): modification based on previous reviews
dependentmadani Sep 19, 2024
5c6cfc0
update (parent notes): few modification done, still work to be done
dependentmadani Sep 23, 2024
5bb6be5
update (note parents): fix the issue of tests, working good
dependentmadani Sep 24, 2024
fee9bbf
update (note parents): modification based on previous review, chore m…
dependentmadani Sep 26, 2024
d65c589
update (note parents tests): the issue of test failure is fixed
dependentmadani Sep 26, 2024
14234a1
udpate (note parents): based on last review
dependentmadani Sep 27, 2024
c09ad3a
Merge branch 'feat/return-note' of github.com:codex-team/notes.api in…
dependentmadani Sep 27, 2024
9872d5e
update (test cases): the issue is fixed due to missing an id
dependentmadani Sep 28, 2024
5a9fad2
update (test case): change the naming of a test case
dependentmadani Sep 29, 2024
4ccb075
update(note parents): based on last review, still work on sql
dependentmadani Oct 13, 2024
aa93ee2
update (parent note): add sql query to retrieve all the parents note …
dependentmadani Oct 15, 2024
ed49e60
update (note parents): only include the parents note without the main…
dependentmadani Oct 15, 2024
7bfe0eb
update (note parents): modify based on last review
dependentmadani Oct 16, 2024
dd1bcdc
update (note relation): return noteId and parentId from the sql query
dependentmadani Oct 16, 2024
92c8569
update (note parents): update the search of note ids to respect the o…
dependentmadani Oct 17, 2024
7efadf5
update (note parents): add comment about the query
dependentmadani Oct 22, 2024
47680d6
update (note parents): small modification of function description and…
dependentmadani Oct 24, 2024
31aeb92
remove (note parents test): an unecessary test case has been removed
dependentmadani Oct 24, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docker-compose.yml
neSpecc marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
version: "3.2"
version: '3.2'

services:
api:
build:
Expand Down
13 changes: 13 additions & 0 deletions src/domain/service/note.ts
Original file line number Diff line number Diff line change
Expand Up @@ -441,4 +441,17 @@ export default class NoteService {

return noteHistoryPublic;
}

/**
* Get note parent structure recursively by note id and user id
* and check if user has access to the parent note.
neSpecc marked this conversation as resolved.
Show resolved Hide resolved
* @param noteId - id of the note to get parent structure
* @returns - array of notes that are parent structure of the note
*/
public async getNoteParents(noteId: NoteInternalId): Promise<Note[]> {
const noteIds: NoteInternalId[] = await this.noteRelationsRepository.getNoteParentsIds(noteId);
const noteParents = await this.noteRepository.getNotesByIds(noteIds);

return noteParents;
}
}
198 changes: 198 additions & 0 deletions src/presentation/http/router/note.test.ts
neSpecc marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -518,6 +518,204 @@ describe('Note API', () => {

expect(response?.json().message).toStrictEqual(expectedMessage);
});

e11sy marked this conversation as resolved.
Show resolved Hide resolved
test('Returns one parents note in case when note has one parent', async () => {
/** Create test user */
const user = await global.db.insertUser();

/** Create access token for the user */
const accessToken = global.auth(user.id);

/** Create test note - a parent note */
const parentNote = await global.db.insertNote({
creatorId: user.id,
});

/** Create test note - a child note */
const childNote = await global.db.insertNote({
creatorId: user.id,
});

/** Create test note settings */
await global.db.insertNoteSetting({
noteId: childNote.id,
isPublic: true,
});

/** Create test note relation */
await global.db.insertNoteRelation({
parentId: parentNote.id,
noteId: childNote.id,
});

const response = await global.api?.fakeRequest({
method: 'GET',
headers: {
authorization: `Bearer ${accessToken}`,
},
url: `/note/${childNote.publicId}`,
});

expect(response?.statusCode).toBe(200);

expect(response?.json()).toMatchObject({
parents: [
{
id: parentNote.publicId,
content: parentNote.content,
},
],
});
});

test('Returns two note parents in case when note has two parents', async () => {
neSpecc marked this conversation as resolved.
Show resolved Hide resolved
/** Create test user */
const user = await global.db.insertUser();

/** Create access token for the user */
const accessToken = global.auth(user.id);

/** Create test note - a grand parent note */
const grandParentNote = await global.db.insertNote({
creatorId: user.id,
});

/** Create test note - a parent note */
const parentNote = await global.db.insertNote({
creatorId: user.id,
});

/** Create test note - a child note */
const childNote = await global.db.insertNote({
creatorId: user.id,
});

/** Create test note settings */
await global.db.insertNoteSetting({
noteId: childNote.id,
isPublic: true,
});

/** Create note relation between parent and grandParentNote */
await global.db.insertNoteRelation({
parentId: grandParentNote.id,
noteId: parentNote.id,
});

/** Create test note relation */
await global.db.insertNoteRelation({
parentId: parentNote.id,
noteId: childNote.id,
});

const response = await global.api?.fakeRequest({
method: 'GET',
headers: {
authorization: `Bearer ${accessToken}`,
},
url: `/note/${childNote.publicId}`,
});

expect(response?.statusCode).toBe(200);

expect(response?.json()).toMatchObject({
parents: [
{
id: grandParentNote.publicId,
content: grandParentNote.content,
},
{
id: parentNote.publicId,
content: parentNote.content,
},
],
});
});

test('Returns one parent note when the user is not in the parent note\'s team but has note relation', async () => {
neSpecc marked this conversation as resolved.
Show resolved Hide resolved
/** Create test user */
const user = await global.db.insertUser();

/** Create another user */
const anotherUser = await global.db.insertUser();

/** Create access token for the user */
const accessToken = global.auth(user.id);

/** Create test note - a parent note */
const parentNote = await global.db.insertNote({
creatorId: anotherUser.id,
});

/** Create test note - a child note */
const childNote = await global.db.insertNote({
creatorId: user.id,
});

/** Create test note settings */
await global.db.insertNoteSetting({
noteId: childNote.id,
isPublic: true,
});

/** Create test note relation */
await global.db.insertNoteRelation({
parentId: parentNote.id,
noteId: childNote.id,
});

const response = await global.api?.fakeRequest({
method: 'GET',
headers: {
authorization: `Bearer ${accessToken}`,
},
url: `/note/${childNote.publicId}`,
});

expect(response?.statusCode).toBe(200);

expect(response?.json()).toMatchObject({
parents: [
{
id: parentNote.publicId,
content: parentNote.content,
},
],
});
});

test('Returns empty array in case where there is no relation exist for the note with status 200', async () => {
neSpecc marked this conversation as resolved.
Show resolved Hide resolved
/** Create test user */
const user = await global.db.insertUser();

/** Create access token for the user */
const accessToken = global.auth(user.id);

/** Create test note - a child note */
const note = await global.db.insertNote({
creatorId: user.id,
});

/** Create test note settings */
await global.db.insertNoteSetting({
noteId: note.id,
isPublic: true,
});

const response = await global.api?.fakeRequest({
method: 'GET',
headers: {
authorization: `Bearer ${accessToken}`,
},
url: `/note/${note.publicId}`,
});

expect(response?.statusCode).toBe(200);

expect(response?.json()).toMatchObject({
parents: [],
});
});
});

describe('PATCH note/:notePublicId ', () => {
Expand Down
14 changes: 14 additions & 0 deletions src/presentation/http/router/note.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ const NoteRouter: FastifyPluginCallback<NoteRouterOptions> = (fastify, opts, don
canEdit: boolean;
};
tools: EditorTool[];
parents: NotePublic[];
} | ErrorResponse;
}>('/:notePublicId', {
config: {
Expand Down Expand Up @@ -123,6 +124,12 @@ const NoteRouter: FastifyPluginCallback<NoteRouterOptions> = (fastify, opts, don
$ref: 'EditorToolSchema',
},
},
parents: {
type: 'array',
items: {
$ref: 'NoteSchema',
},
},
},
},
},
Expand Down Expand Up @@ -172,11 +179,18 @@ const NoteRouter: FastifyPluginCallback<NoteRouterOptions> = (fastify, opts, don
*/
const canEdit = memberRole === MemberRole.Write;

const noteParentStructure = await noteService.getNoteParents(noteId);

const noteParentsPublic = noteParentStructure.map((notes) => {
return definePublicNote(notes);
});

return reply.send({
note: notePublic,
parentNote: parentNote,
accessRights: { canEdit: canEdit },
tools: noteTools,
parents: noteParentsPublic,
});
});

Expand Down
9 changes: 9 additions & 0 deletions src/repository/note.repository.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,13 @@ export default class NoteRepository {
public async getNoteListByUserId(id: number, offset: number, limit: number): Promise<Note[]> {
return await this.storage.getNoteListByUserId(id, offset, limit);
}

/**
* Get all notes based on their ids
* @param noteIds : list of note ids
* @returns an array of notes
*/
public async getNotesByIds(noteIds: NoteInternalId[]): Promise<Note[]> {
neSpecc marked this conversation as resolved.
Show resolved Hide resolved
return await this.storage.getNotesByIds(noteIds);
}
}
9 changes: 9 additions & 0 deletions src/repository/noteRelations.repository.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,13 @@ export default class NoteRelationsRepository {
public async hasRelation(noteId: NoteInternalId): Promise<boolean> {
return await this.storage.hasRelation(noteId);
}

/**
* Get all note parents based on note id
* @param noteId : note id to get all its parents
* @returns an array of note parents ids
*/
public async getNoteParentsIds(noteId: NoteInternalId): Promise<NoteInternalId[]> {
return await this.storage.getNoteParentsIds(noteId);
}
}
25 changes: 20 additions & 5 deletions src/repository/storage/postgres/orm/sequelize/note.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
import type { CreationOptional, InferAttributes, InferCreationAttributes, ModelStatic, NonAttribute, Sequelize } from 'sequelize';
import { DataTypes, Model } from 'sequelize';
import { DataTypes, Model, Op } from 'sequelize';
import type Orm from '@repository/storage/postgres/orm/sequelize/index.js';
import type { Note, NoteCreationAttributes, NoteInternalId, NotePublicId } from '@domain/entities/note.js';
import { UserModel } from '@repository/storage/postgres/orm/sequelize/user.js';
import type { NoteSettingsModel } from './noteSettings.js';
import type { NoteVisitsModel } from './noteVisits.js';
import { DomainError } from '@domain/entities/DomainError.js';
import type { NoteHistoryModel } from './noteHistory.js';

/* eslint-disable @typescript-eslint/naming-convention */
Expand Down Expand Up @@ -233,11 +232,11 @@ export default class NoteSequelizeStorage {
*/
public async getNoteListByUserId(userId: number, offset: number, limit: number): Promise<Note[]> {
if (this.visitsModel === null) {
throw new DomainError('NoteVisit model should be defined');
throw new Error('NoteStorage: NoteVisit model should be defined');
}

if (!this.settingsModel) {
throw new Error('Note settings model not initialized');
throw new Error('NoteStorage: Note settings model not initialized');
}

const reply = await this.model.findAll({
Expand Down Expand Up @@ -293,7 +292,7 @@ export default class NoteSequelizeStorage {
*/
public async getNoteByHostname(hostname: string): Promise<Note | null> {
if (!this.settingsModel) {
throw new Error('Note settings model not initialized');
throw new Error('NoteStorage: Note settings model not initialized');
}

/**
Expand Down Expand Up @@ -324,4 +323,20 @@ export default class NoteSequelizeStorage {
},
});
};

/**
* Get all notes based on their ids
neSpecc marked this conversation as resolved.
Show resolved Hide resolved
* @param noteIds - list of note ids
*/
public async getNotesByIds(noteIds: NoteInternalId[]): Promise<Note[]> {
const notes: Note[] = await this.model.findAll({
where: {
id: {
[Op.in]: noteIds,
},
},
});
neSpecc marked this conversation as resolved.
Show resolved Hide resolved

return notes;
}
}
33 changes: 33 additions & 0 deletions src/repository/storage/postgres/orm/sequelize/noteRelations.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { CreationOptional, InferAttributes, InferCreationAttributes, ModelStatic, Sequelize } from 'sequelize';
import { QueryTypes } from 'sequelize';
import { Op } from 'sequelize';
import { NoteModel } from '@repository/storage/postgres/orm/sequelize/note.js';
import type Orm from '@repository/storage/postgres/orm/sequelize/index.js';
Expand Down Expand Up @@ -209,4 +210,36 @@ export default class NoteRelationsSequelizeStorage {

return foundNote !== null;
};

/**
* Get all parent notes of a note that a user has access to,
* where the user has access to.
* @param noteId - the ID of the note.
*/
public async getNoteParentsIds(noteId: NoteInternalId): Promise<NoteInternalId[]> {
// get all note ids via a singe sql query instead of many
const query = `
slaveeks marked this conversation as resolved.
Show resolved Hide resolved
WITH RECURSIVE note_parents AS (
SELECT np.note_id, np.parent_id
FROM ${String(this.database.literal(this.tableName).val)} np
WHERE np.note_id = :startNoteId
UNION ALL
SELECT nr.note_id, nr.parent_id
FROM ${String(this.database.literal(this.tableName).val)} nr
INNER JOIN note_parents np ON np.parent_id = nr.note_id
)
SELECT np.note_id AS "noteId", np.parent_id AS "parentId"
FROM note_parents np;`;

const result = await this.model.sequelize?.query(query, {
replacements: { startNoteId: noteId },
type: QueryTypes.SELECT,
});

let noteParents = (result as { noteId: number; parentId: number }[])?.map(note => note.parentId) ?? [];

noteParents.reverse();

return noteParents;
}
}
Loading
Loading