chore(snippet): create the column to save the highlighted snippet

tericcabrel · Nov 1, 2023 · d0ad6c9 · d0ad6c9
1 parent c47db3c
commit d0ad6c9
Show file tree

Hide file tree

Showing 12 changed files with 55 additions and 7 deletions.
diff --git a/packages/database/package.json b/packages/database/package.json
@@ -11,7 +11,7 @@
  "lint": "eslint src index.ts",
  "test": "jest",
  "db:dev": "pscale connect sharingan dev --port 3311",
- "db:shadow": "docker run -d --rm -e MYSQL_ROOT_PASSWORD=secret -e MYSQL_DATABASE=sharingan --name sharingan-shadow-db -p 3312:3306 mysql:8.0",
+ "db:shadow": "docker run -d --rm -e MYSQL_ROOT_PASSWORD=secret -e MYSQL_DATABASE=sharingan --name sharingan-shadow-db -p 3312:3306 mysql:8.0.23",
  "db:shadow:stop": "docker kill sharingan-shadow-db && docker container prune -f",
  "db:deploy:create": "pscale deploy-request create sharingan dev",
  "db:generate": "prisma generate --schema=./prisma/schema.prisma",

diff --git a/...atabase/prisma/migrations/20221030113708_add_content_html_in_snippets_table/migration.sql b/...atabase/prisma/migrations/20221030113708_add_content_html_in_snippets_table/migration.sql
@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE `snippets` ADD COLUMN `content_html` TEXT NULL;
diff --git a/packages/database/prisma/schema.prisma b/packages/database/prisma/schema.prisma
@@ -91,6 +91,7 @@ model Snippet {
  folderId String @map("folder_id")
  name String @db.VarChar(255)
  content String @db.Text
+ contentHtml String? @db.Text @map("content_html")
  language String @db.VarChar(20)
  size Int @default(0) @db.Int
  visibility SnippetVisibility @default(public)

diff --git a/packages/database/prisma/schema.test.prisma b/packages/database/prisma/schema.test.prisma
@@ -90,6 +90,7 @@ model Snippet {
  folderId String @map("folder_id")
  name String @db.VarChar(255)
  content String @db.Text
+ contentHtml String? @db.Text @map("content_html")
  language String @db.VarChar(20)
  size Int @default(0) @db.Int
  visibility SnippetVisibility @default(public)

diff --git a/packages/domain/__tests__/services/snippets/dtos/create-snippet-dto.test.ts b/packages/domain/__tests__/services/snippets/dtos/create-snippet-dto.test.ts
@@ -11,6 +11,8 @@ describe('Test Create Snippet DTO', () => {
  // GIVEN
  const dto = new CreateSessionDto({
  content: 'import React from "react";\n\nexport const App = () => {\n\n\treturn(\n\t\t<div>Hello</div>\n\t);\n};',
+ contentHighlighted:
+ 'import React from "react";\n\nexport const App = () => {\n\n\treturn(\n\t\t<div>Hello</div>\n\t);\n}; highlighted',
  description: 'Basic react component',
  folderId,
  language: 'tsx',
@@ -27,6 +29,8 @@ describe('Test Create Snippet DTO', () => {
  // THEN
  expect(folder).toMatchObject<Snippet>({
  content: 'import React from "react";\n\nexport const App = () => {\n\n\treturn(\n\t\t<div>Hello</div>\n\t);\n};',
+ contentHtml:
+ 'import React from "react";\n\nexport const App = () => {\n\n\treturn(\n\t\t<div>Hello</div>\n\t);\n}; highlighted',
  createdAt: expect.any(Date),
  description: 'Basic react component',
  folderId,

diff --git a/packages/domain/__tests__/services/snippets/dtos/update-snippet-dto.test.ts b/packages/domain/__tests__/services/snippets/dtos/update-snippet-dto.test.ts
@@ -11,6 +11,8 @@ describe('Test Update Snippet DTO', () => {
  const dto = new UpdateSnippetDto({
  content:
  'import React from "react";\n\nexport const App = () => {\n\n\treturn(\n\t\t<div>Hello Updated</div>\n\t);\n};',
+ contentHighlighted:
+ 'import React from "react";\n\nexport const App = () => {\n\n\treturn(\n\t\t<div>Hello Updated</div>\n\t);\n}; highlighted',
  creatorId: userId,
  description: 'Basic react component updated',
  language: 'tsx',
@@ -34,6 +36,8 @@ describe('Test Update Snippet DTO', () => {
  const expectedSnippet: Snippet = {
  content:
  'import React from "react";\n\nexport const App = () => {\n\n\treturn(\n\t\t<div>Hello Updated</div>\n\t);\n};',
+ contentHtml:
+ 'import React from "react";\n\nexport const App = () => {\n\n\treturn(\n\t\t<div>Hello Updated</div>\n\t);\n}; highlighted',
  createdAt: currentSnippet.createdAt,
  description: 'Basic react component updated',
  folderId: snippetToUpdate.folderId,

diff --git a/packages/domain/__tests__/services/snippets/snippet.service.test.ts b/packages/domain/__tests__/services/snippets/snippet.service.test.ts
@@ -27,6 +27,7 @@ describe('Test Snippet service', () => {
  // THEN
  expect(expectedSnippet).toMatchObject<Snippet>({
  content: createSnippetDto.toSnippet().content,
+ contentHtml: createSnippetDto.toSnippet().contentHtml,
  createdAt: expect.any(Date),
  description: createSnippetDto.toSnippet().description,
  folderId: rootFolder.id,
@@ -64,7 +65,7 @@ describe('Test Snippet service', () => {
  await deleteTestUsersById([user.id]);
  });
 
- it('should find all public snippets', async () => {
+ it('should retrieve all public snippets', async () => {
  // GIVEN
  const [user, rootFolder] = await createUserWithRootFolder();
  const existingSnippets = await Promise.all([
@@ -77,10 +78,37 @@ describe('Test Snippet service', () => {
  ]);
 
  // WHEN
- const publicSnippets = await snippetService.findPublicSnippet();
+ const publicSnippets = await snippetService.findPublicSnippet({ itemPerPage: 10 });
 
  // THEN
- await expect(publicSnippets).toHaveLength(4);
+ await expect(publicSnippets.hasMore).toEqual(false);
+ await expect(publicSnippets.nextCursor).toEqual(null);
+ await expect(publicSnippets.items).toHaveLength(4);
+
+ await deleteTestSnippetsById(existingSnippets.map((snippet) => snippet.id));
+ await deleteTestFoldersById([rootFolder.id]);
+ await deleteTestUsersById([user.id]);
+ });
+
+ it('should retrieve a subset of public snippets', async () => {
+ // GIVEN
+ const [user, rootFolder] = await createUserWithRootFolder();
+ const existingSnippets = await Promise.all([
+ createTestSnippet({ folderId: rootFolder.id, userId: user.id, visibility: 'public' }),
+ createTestSnippet({ folderId: rootFolder.id, userId: user.id, visibility: 'private' }),
+ createTestSnippet({ folderId: rootFolder.id, userId: user.id, visibility: 'public' }),
+ createTestSnippet({ folderId: rootFolder.id, userId: user.id, visibility: 'private' }),
+ createTestSnippet({ folderId: rootFolder.id, userId: user.id, visibility: 'public' }),
+ createTestSnippet({ folderId: rootFolder.id, userId: user.id, visibility: 'public' }),
+ ]);
+
+ // WHEN
+ const publicSnippets = await snippetService.findPublicSnippet({ itemPerPage: 3 });
+
+ // THEN
+ await expect(publicSnippets.hasMore).toEqual(true);
+ await expect(publicSnippets.nextCursor).toEqual(expect.any(String));
+ await expect(publicSnippets.items).toHaveLength(3);
 
  await deleteTestSnippetsById(existingSnippets.map((snippet) => snippet.id));
  await deleteTestFoldersById([rootFolder.id]);

diff --git a/packages/domain/__tests__/setup/test-utils.ts b/packages/domain/__tests__/setup/test-utils.ts
@@ -153,8 +153,11 @@ export const createTestSnippetDto = (
  const languageIndex = randNumber({ max: languages.length - 1, min: 0 });
  const themeIndex = randNumber({ max: themes.length - 1, min: 0 });
 
+ const snippetContent = randWord({ length: randNumber({ max: 30, min: 5 }) }).join('\n');
+
  return new CreateSnippetDto({
- content: randWord({ length: randNumber({ max: 30, min: 5 }) }).join('\n'),
+ content: snippetContent,
+ contentHighlighted: `${snippetContent} highlighted`,
  description: randWord({ length: randNumber({ max: 20, min: 10 }) }).join(' '),
  folderId: args?.folderId ?? generateTestId(),
  language: languages[languageIndex],

diff --git a/packages/domain/package.json b/packages/domain/package.json
@@ -9,8 +9,8 @@
  "build": "tsc --project tsconfig.prod.json",
  "clean": "rm -rf .turbo dist",
  "lint": "eslint --fix",
- "db:test": "docker run -d --rm -e MYSQL_ROOT_PASSWORD=secret -e MYSQL_DATABASE=sharingan --name sharingandb -p 3313:3306 mysql:8.0",
- "db:test:stop": "docker container kill sharingandb",
+ "db:test": "docker run -d --rm -e MYSQL_ROOT_PASSWORD=secret -e MYSQL_DATABASE=sharingan --name sharingandb -p 3313:3306 mysql:8.0.23",
+ "db:test:stop": "docker container kill sharingandb && docker container prune -f",
  "db:test:migration": "npx prisma migrate dev --schema=../database/prisma/schema.test.prisma",
  "test": "TEST_WITH_DB=true IS_LOCAL=false jest",
  "test:unit": "jest",

diff --git a/packages/domain/src/snippets/dtos/create-snippet-dto.ts b/packages/domain/src/snippets/dtos/create-snippet-dto.ts
@@ -2,6 +2,7 @@ import { Snippet, SnippetVisibility, dbId } from '@sharingan/database';
 
 type Input = {
  content: string;
+ contentHighlighted: string;
  description: string | null;
  folderId: string;
  language: string;
@@ -30,6 +31,7 @@ export default class CreateSnippetDto {
  toSnippet(): Snippet {
  return {
  content: this._input.content,
+ contentHtml: this._input.contentHighlighted,
  createdAt: new Date(),
  description: this._input.description,
  folderId: this._input.folderId,

diff --git a/packages/domain/src/snippets/dtos/update-snippet-dto.ts b/packages/domain/src/snippets/dtos/update-snippet-dto.ts
@@ -2,6 +2,7 @@ import { Snippet, SnippetVisibility } from '@sharingan/database';
 
 type Input = {
  content: string;
+ contentHighlighted: string;
  creatorId: string;
  description: string | null;
  language: string;
@@ -31,6 +32,7 @@ export default class UpdateSnippetDto {
  return {
  ...currentSnippet,
  content: this._input.content,
+ contentHtml: this._input.contentHighlighted,
  description: this._input.description,
  language: this._input.language,
  lineHighlight: this._input.lineHighlight,

diff --git a/packages/domain/src/snippets/snippet.service.ts b/packages/domain/src/snippets/snippet.service.ts
@@ -20,6 +20,7 @@ export default class SnippetService {
  return dbClient.snippet.create({
  data: {
  content: input.content,
+ contentHtml: input.contentHtml,
  description: input.description,
  folderId: input.folderId,
  id: input.id,