feat(folder): improve folder structure management

apps/core/src/resources/folders/queries/list-directory.ts

@@ -6,7 +6,7 @@ export const listDirectory: QueryResolvers['listDirectory'] = async (_parent, ar
 
  const folders = await context.db.folder.findSubFolders(userId, args.folderId);
  const snippets = await context.db.snippet.findByFolder(args.folderId);
- const paths = await context.db.folder.generateDirectoryPath(args.folderId);
+ const paths = await context.db.folder.generateBreadcrumb(args.folderId);
 
  return {
  folders,

apps/core/src/resources/snippets/queries/find-snippet.ts

@@ -8,7 +8,7 @@ export const findSnippet: QueryResolvers['findSnippet'] = async (_parent, args,
 
  try {
  const snippet = await context.db.snippet.findById(args.snippetId);
- const paths = await context.db.folder.generateDirectoryPath(snippet.folderId);
+ const paths = await context.db.folder.generateBreadcrumb(snippet.folderId);
 
  return {
  paths,

packages/database/package.json

@@ -9,6 +9,7 @@
  "build": "tsc --project tsconfig.prod.json",
  "clean": "rm -rf .turbo dist",
  "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:stop": "docker kill sharingan-shadow-db && docker container prune -f",

packages/database/prisma/schema.test.prisma

@@ -67,6 +67,7 @@ model Folder {
  userId String @map("user_id") @db.VarChar(50)
  parentId String? @map("parent_id")
  name String @db.VarChar(255)
+ path String? @db.Text
  isFavorite Boolean @default(false) @map("is_favorite")
  createdAt DateTime @default(now()) @map("created_at")
  updatedAt DateTime @updatedAt @map("updated_at")

packages/database/tsconfig.json

@@ -5,10 +5,10 @@
  "outDir": "./dist",
  "declaration": true,
  "composite": true,
- "sourceMap": true
+ "sourceMap": false
  },
  "files": ["env.d.ts"],
- "include": ["./src/**/*", "./tests/**/*", "index.ts"],
+ "include": ["src", "__tests__", "index.ts"],
  "exclude": [
  "node_modules"
  ]

packages/database/tsconfig.prod.json

@@ -3,5 +3,7 @@
  "compilerOptions": {
  "sourceMap": false
  },
- "exclude": ["tests"]
+ "exclude": [
+ "__tests__"
+ ]
 }

packages/domain/tests/services/folders/dtos/create-folder-dto.test.ts → packages/domain/__tests__/services/folders/dtos/create-folder-dto.test.ts

@@ -21,6 +21,7 @@ describe('Test Create Folder DTO', () => {
  isFavorite: false,
  name: 'blogs',
  parentId: 'cl23rzwe5000002czaedc8sll',
+ path: null,
  updatedAt: expect.any(Date),
  userId: 'dm34saxf6111113dabfed9tmm',
  });

packages/domain/tests/services/folders/dtos/create-user-root-folder-dto.test.ts → packages/domain/__tests__/services/folders/dtos/create-user-root-folder-dto.test.ts

@@ -14,6 +14,7 @@ describe('Test Create User Root Folder DTO', () => {
  isFavorite: false,
  name: '__dm34saxf6111113dabfed9tmm__',
  parentId: null,
+ path: null,
  updatedAt: expect.any(Date),
  userId: 'dm34saxf6111113dabfed9tmm',
  });

packages/domain/__tests__/services/folders/dtos/update-folder-dto.test.ts

@@ -0,0 +1,34 @@
+import { Folder } from '@sharingan/database';
+
+import { UpdateFolderDto } from '../../../../index';
+import { createTestFolderDto, generateTestId } from '../../../setup/test-utils';
+
+describe('Test Update Folder DTO', () => {
+ it('should return the folder to update', () => {
+ const parentId = generateTestId();
+ const userId = generateTestId();
+
+ const dto = new UpdateFolderDto({
+ creatorId: userId,
+ folderId: parentId,
+ name: 'folder updated',
+ });
+
+ const currentFolder = createTestFolderDto({ parentId, userId }).toFolder();
+
+ const folderToUpdate = dto.toFolder(currentFolder);
+
+ const expectedFolder: Folder = {
+ createdAt: currentFolder.createdAt,
+ id: currentFolder.id,
+ isFavorite: currentFolder.isFavorite,
+ name: 'folder updated',
+ parentId: currentFolder.parentId,
+ path: currentFolder.path,
+ updatedAt: currentFolder.updatedAt,
+ userId: currentFolder.userId,
+ };
+
+ expect(folderToUpdate).toMatchObject(expectedFolder);
+ });
+});

packages/domain/tests/services/folders/folder.service.test.ts → packages/domain/__tests__/services/folders/folder.service.test.ts

@@ -5,6 +5,7 @@ import { CreateUserRootFolderDto } from '../../../index';
 import CreateFolderDto from '../../../src/folders/dtos/create-folder-dto';
 import {
  createManyTestFolders,
+ createTestFolderDto,
  createTestUser,
  createUserWithRootFolder,
  deleteTestFoldersById,
@@ -248,4 +249,47 @@ describe('Test Folder service', () => {
  await deleteTestUsersById([user1.id]);
  await deleteTestUsersById([user2.id]);
  });
+
+ it('should generate the breadcrumb path of a folder', async () => {
+ // GIVEN
+ const [user, rootFolder] = await createUserWithRootFolder();
+
+ const gistFolderDto = createTestFolderDto({
+ name: 'My gist',
+ parentId: rootFolder.id,
+ userId: user.id,
+ });
+ const gistFolder = await folderService.create(gistFolderDto);
+
+ const nodeFolderDto = createTestFolderDto({
+ name: 'Node.js',
+ parentId: gistFolder.id,
+ userId: user.id,
+ });
+ const nodeFolder = await folderService.create(nodeFolderDto);
+
+ // WHEN
+ const subFolders = await folderService.generateBreadcrumb(nodeFolder.id);
+
+ // THEN
+ expect(subFolders).toHaveLength(2);
+ expect(subFolders.map((folder) => folder.name)).toEqual(['My gist', 'Node.js']);
+
+ await deleteTestFoldersById([nodeFolder.id, gistFolder.id, rootFolder.id]);
+ await deleteTestUsersById([user.id]);
+ });
+
+ it('should generate the breadcrumb path of the root folder', async () => {
+ // GIVEN
+ const [user, rootFolder] = await createUserWithRootFolder();
+
+ // WHEN
+ const subFolders = await folderService.generateBreadcrumb(rootFolder.id);
+
+ // THEN
+ expect(subFolders).toHaveLength(0);
+
+ await deleteTestFoldersById([rootFolder.id]);
+ await deleteTestUsersById([user.id]);
+ });
 });

packages/domain/__tests__/services/snippets/dtos/delete-snippet-dto.test.ts

@@ -0,0 +1,20 @@
+import DeleteSnippetDto from '../../../../src/snippets/dtos/delete-snippet-dto';
+import { generateTestId } from '../../../setup/test-utils';
+
+describe('Test Delete Snippet DTO', () => {
+ it('should have the right property defined', () => {
+ const snippetId = generateTestId();
+ const userId = generateTestId();
+
+ // GIVEN
+ const dto = new DeleteSnippetDto({
+ creatorId: userId,
+ snippetId,
+ });
+
+ // WHEN
+ // THEN
+ expect(dto.snippetId).toEqual(snippetId);
+ expect(dto.creatorId).toEqual(userId);
+ });
+});

packages/domain/__tests__/services/snippets/dtos/update-snippet-dto.test.ts

@@ -0,0 +1,53 @@
+import { Snippet } from '@sharingan/database';
+
+import { UpdateSnippetDto } from '../../../../index';
+import { createTestSnippetDto, generateTestId } from '../../../setup/test-utils';
+
+describe('Test Update Snippet DTO', () => {
+ it('should have the right property defined to update the snippet', () => {
+ const snippetId = generateTestId();
+ const userId = generateTestId();
+
+ 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};',
+ creatorId: userId,
+ description: 'Basic react component updated',
+ language: 'tsx',
+ lineHighlight: '[[1, "diff-add"]]',
+ name: 'app-updated.tsx',
+ snippetId,
+ theme: 'one-dark-pro',
+ visibility: 'private',
+ });
+
+ const folderId = generateTestId();
+ const currentSnippet = createTestSnippetDto({
+ folderId,
+ name: 'app.tsx',
+ userId,
+ visibility: 'public',
+ }).toSnippet();
+
+ const snippetToUpdate = dto.toSnippet(currentSnippet);
+
+ 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};',
+ createdAt: currentSnippet.createdAt,
+ description: 'Basic react component updated',
+ folderId: snippetToUpdate.folderId,
+ id: currentSnippet.id,
+ language: 'tsx',
+ lineHighlight: '[[1, "diff-add"]]',
+ name: 'app-updated.tsx',
+ size: expect.any(Number),
+ theme: 'one-dark-pro',
+ updatedAt: currentSnippet.updatedAt,
+ userId,
+ visibility: 'private',
+ };
+
+ expect(snippetToUpdate).toMatchObject(expectedSnippet);
+ });
+});

packages/domain/tests/setup/test-utils.ts → packages/domain/__tests__/setup/test-utils.ts

@@ -135,9 +135,9 @@ export const createManyTestFolders = async ({
 
 export const generateTestId = (): string => dbId.generate();
 
-export const createTestFolderDto = (args?: { parentId?: string; userId?: string }): CreateFolderDto => {
+export const createTestFolderDto = (args?: { name?: string; parentId?: string; userId?: string }): CreateFolderDto => {
  return new CreateFolderDto({
- name: randWord(),
+ name: args?.name ?? randWord(),
  parentId: args?.parentId ?? generateTestId(),
  userId: args?.userId ?? generateTestId(),
  });

packages/domain/jest.config.ts

@@ -8,16 +8,13 @@ const config: Config.InitialOptions = {
  clearMocks: true,
  maxWorkers: 1,
  snapshotFormat: {
- "printBasicPrototype": false
+ printBasicPrototype: false,
  },
- globalSetup: './tests/setup/global-setup.ts',
- setupFilesAfterEnv: ['./tests/setup/test-setup.ts'],
+ globalSetup: './__tests__/setup/global-setup.ts',
+ setupFilesAfterEnv: ['./__tests__/setup/test-setup.ts'],
  coverageDirectory: 'coverage',
  collectCoverage: false, // When set to true, coverage is performed even if coverage flag isn't provided
- collectCoverageFrom: [
- 'src/**/*.ts',
- '!src/index.ts',
- ],
+ collectCoverageFrom: ['src/**/*.ts', '!src/index.ts'],
  coverageThreshold: {
  global: {
  branches: 40,

packages/domain/src/folders/dtos/create-folder-dto.ts

@@ -32,6 +32,7 @@ export default class CreateFolderDto {
  isFavorite: false,
  name: this._input.name,
  parentId: this._input.parentId,
+ path: null,
  updatedAt: new Date(),
  userId: this._input.userId,
  };

packages/domain/src/folders/dtos/create-user-root-folder-dto.ts

@@ -14,6 +14,7 @@ export default class CreateUserRootFolderDto {
  isFavorite: false,
  name: `__${this._userId}__`,
  parentId: null,
+ path: null,
  updatedAt: new Date(),
  userId: this._userId,
  };

packages/domain/src/folders/folder.service.ts

@@ -111,15 +111,30 @@ export default class FolderService {
  });
  }
 
- async generateDirectoryPath(folderId: string): Promise<Folder[]> {
- const folders: Folder[] = [];
+ async generateBreadcrumb(folderId: string): Promise<Folder[]> {
+ const folder = await this.findById(folderId);
 
- await this.listParentFolderRecursively(folderId, folders);
+ const parentFolderIds = folder.path?.split('/') ?? [];
+
+ if (parentFolderIds.length === 0) {
+ return [];
+ }
+
+ const parentFoldersOrdered = await dbClient.folder.findMany({
+ orderBy: {
+ createdAt: 'asc',
+ },
+ where: {
+ id: {
+ in: parentFolderIds,
+ },
+ },
+ });
 
  // Remove the user root folder
- folders.pop();
+ parentFoldersOrdered.shift();
 
- return folders.reverse();
+ return parentFoldersOrdered.concat(folder);
  }
 
  async update(updateFolderDto: UpdateFolderDto): Promise<Folder> {
@@ -163,18 +178,6 @@ export default class FolderService {
  return [parentFolder.path, parentFolder.id].join('/');
  }
 
- private async listParentFolderRecursively(folderId: string, result: Folder[] = []): Promise<Folder[]> {
- const folder = await dbClient.folder.findFirstOrThrow({ where: { id: folderId } });
-
- result.push(folder);
-
- if (!folder.parentId) {
- return result;
- }
-
- return this.listParentFolderRecursively(folder.parentId, result);
- }
-
  private findFolderSubFolders(folderId: string, userId: string): Promise<Folder[]> {
  return dbClient.folder.findMany({
  where: {

packages/domain/tsconfig.json

@@ -7,7 +7,7 @@
  "sourceMap": true
  },
  "files": ["env.d.ts"],
- "include": ["src", "tests", "index.ts"],
+ "include": ["src", "__tests__", "index.ts"],
  "exclude": [
  "node_modules"
  ],

packages/domain/tsconfig.prod.json

@@ -3,5 +3,7 @@
  "compilerOptions": {
  "sourceMap": false
  },
- "exclude": ["tests"]
+ "exclude": [
+ "__tests__"
+ ]
 }

packages/embed/src/oembed/tests/generate-metadata.test.ts → packages/embed/__tests__/oembed/generate-metadata.test.ts

@@ -1,4 +1,4 @@
-import { generateOembedMetadata } from '../index';
+import { generateOembedMetadata } from '../../src/oembed';
 
 describe('Test Generate Oembed metadata', () => {
  it('should generate Oembed metadata for a code snippet', () => {

packages/embed/src/renderer/content/tests/html-generator.test.ts → packages/embed/__tests__/renderer/content/html-generator.test.ts

@@ -1,4 +1,4 @@
-import { generateNoSnippetHtmlContent } from '../html-generator';
+import { generateNoSnippetHtmlContent } from '../../../src/renderer/content/html-generator';
 
 describe('Test HTML generator functions', () => {
  it.only('should generates html content for a non existing code snippet', () => {

packages/embed/src/renderer/content/tests/preview-template.test.ts → packages/embed/__tests__/renderer/content/preview-template.test.ts

@@ -1,6 +1,6 @@
-import { Args, generateHTMLPreview } from '../preview-template';
+import { Args, generateHTMLPreview } from '../../../src/renderer/content/preview-template';
 
-jest.mock('../utils', () => {
+jest.mock('../../../src/renderer/content/utils', () => {
  return {
  generateRandomString: () => 'random-id',
  };

packages/embed/src/renderer/content/tests/utils.test.ts → packages/embed/__tests__/renderer/content/utils.test.ts

@@ -1,4 +1,8 @@
-import { addWhitespaceForEmptyLine, generateLineHighlightOptions, parseHTMLSnippetCode } from '../utils';
+import {
+ addWhitespaceForEmptyLine,
+ generateLineHighlightOptions,
+ parseHTMLSnippetCode,
+} from '../../../src/renderer/content/utils';
 
 describe('Test utils functions', () => {
  describe('Test addWhitespaceForEmptyLine()', () => {