Skip to content

refactor: reduce payload size for homepage request #303

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.

Sign up for GitHub

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

Open
7eliassen wants to merge 2 commits into
base: main
Choose a base branch
from
+29 −7
Open

refactor: reduce payload size for homepage request #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8fa105b
refactor: reduced content size
7eliassen Jun 26, 2026
085c7a2
chore: lint
7eliassen Jul 9, 2026
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
26 changes: 24 additions & 2 deletions src/domain/entities/notePublic.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { Note } from '@domain/entities/note.js';
import type { Note, NoteContent } from '@domain/entities/note.js';

type NotePublicProperties = 'content' | 'createdAt' | 'updatedAt' | 'creatorId' | 'cover';

Expand All @@ -10,7 +10,7 @@ export interface NotePublic extends Pick<Note, NotePublicProperties> {
}

/**
*Change Note to NotePublic
* Change Note to NotePublic
* @param note - Note data to compose a public note
*/
export function definePublicNote(note: Note): NotePublic {
Expand All @@ -25,3 +25,25 @@ export function definePublicNote(note: Note): NotePublic {

return notePublic;
}

/**
* Change Note to a trimmed NotePublic for list responses.
* Content only includes the first block as a preview.
* @param note - Note data to compose a note list item
*/
export function defineNoteListItem(note: Note): NotePublic {
const trimmedContent: NoteContent = {
blocks: note.content.blocks.slice(0, 1),
};

const notePublic: NotePublic = {
id: note.publicId,
content: trimmedContent,
createdAt: note.createdAt,
updatedAt: note.updatedAt,
creatorId: note.creatorId,
cover: note.cover,
};

return notePublic;
}
Comment on lines +34 to +49

@Reversean Reversean Jul 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No test currently asserts that content is trimmed to a single block for the list endpoints.

Could you please add one in noteList.test.ts so the trimming behavior doesn't regress silently?

10 changes: 5 additions & 5 deletions src/presentation/http/router/noteList.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type { FastifyPluginCallback } from 'fastify';
import type NoteService from '@domain/service/note.js';
import { definePublicNote, type NotePublic } from '@domain/entities/notePublic.js';
import { defineNoteListItem, type NotePublic } from '@domain/entities/notePublic.js';
import type { NoteListPublic } from '@domain/entities/noteList.js';

/**
Expand Down Expand Up @@ -51,7 +51,7 @@ const NoteListRouter: FastifyPluginCallback<NoteListRouterOptions> = (fastify, o
properties: {
items: {
id: { type: 'string' },
content: { type: 'string' },
content: { type: 'object' },
createdAt: { type: 'string' },
creatorId: { type: 'string' },
updatedAt: { type: 'string' },
Expand All @@ -68,7 +68,7 @@ const NoteListRouter: FastifyPluginCallback<NoteListRouterOptions> = (fastify, o
/**
* Wrapping Notelist for public use
*/
const noteListItemsPublic: NotePublic[] = noteList.items.map(definePublicNote);
const noteListItemsPublic: NotePublic[] = noteList.items.map(defineNoteListItem);

const noteListPublic: NoteListPublic = {
items: noteListItemsPublic,
Expand Down Expand Up @@ -105,7 +105,7 @@ const NoteListRouter: FastifyPluginCallback<NoteListRouterOptions> = (fastify, o
properties: {
items: {
id: { type: 'string' },
content: { type: 'string' },
content: { type: 'object' },
createdAt: { type: 'string' },
creatorId: { type: 'string' },
updatedAt: { type: 'string' },
Expand All @@ -122,7 +122,7 @@ const NoteListRouter: FastifyPluginCallback<NoteListRouterOptions> = (fastify, o
/**
* Wrapping Notelist for public use
*/
const noteListItemsPublic: NotePublic[] = noteList.items.map(definePublicNote);
const noteListItemsPublic: NotePublic[] = noteList.items.map(defineNoteListItem);

const noteListPublic: NoteListPublic = {
items: noteListItemsPublic,
Expand Down
Loading