papermark icon indicating copy to clipboard operation
papermark copied to clipboard

feat: folder shows recursive count of nested folders and documents

Open Aashish-Upadhyay-101 opened this issue 7 months ago • 8 comments

Summary by CodeRabbit

  • New Features

    • Folder listings in datarooms now display total document and subfolder counts, including all nested levels, for a more comprehensive overview.
  • Bug Fixes

    • Counts for documents and subfolders now accurately reflect all contents within each folder, not just immediate children.

Aashish-Upadhyay-101 avatar May 21 '25 16:05 Aashish-Upadhyay-101

@Aashish-Upadhyay-101 is attempting to deploy a commit to the mftsio Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar May 21 '25 16:05 vercel[bot]

Walkthrough

A new utility function was introduced to recursively count documents and child folders within a folder hierarchy. The API endpoints for fetching folders now use this function to provide recursive counts of documents and child folders for each folder in their responses, replacing the previous direct counts.

Changes

File(s) Change Summary
lib/dataroom/get-recursive-folder-docs-count.ts Added getRecursiveFolderCounts, an async function to recursively count documents and child folders in a folder.
pages/api/teams/[teamId]/datarooms/[id]/folders/[...name].ts,
.../folders/index.ts
Updated API handlers to use getRecursiveFolderCounts for recursive counts in folder responses.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API_Handler
    participant DB
    participant RecursiveCounter

    Client->>API_Handler: GET /folders (root or by name)
    API_Handler->>DB: Fetch folders
    loop For each folder
        API_Handler->>RecursiveCounter: getRecursiveFolderCounts(db, folderId)
        RecursiveCounter->>DB: Query folder, docs, and children
        alt Has child folders
            RecursiveCounter->>RecursiveCounter: Recursively count children
        end
        RecursiveCounter-->>API_Handler: Return aggregated counts
    end
    API_Handler-->>Client: Respond with folders (recursive counts)

Poem

In burrows deep, the folders grow,
With docs and children far below.
Now every warren’s count is true—
Recursive hops, from old to new!
The data fields now tell the tale,
Of every doc and bunny trail. 🐇📂✨

[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm warn config production Use --omit=dev instead. npm error Exit handler never called! npm error This is an error with npm itself. Please report this error at: npm error https://github.com/npm/cli/issues npm error A complete log of this run can be found in: /.npm/_logs/2025-05-21T17_24_14_259Z-debug-0.log

[!NOTE]

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Learn more here.


[!NOTE]

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings. Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro Cache: Disabled due to data retention organization setting Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between f8e6933cbb33b41d25028e2f369272d898652aab and 173e8a3b844c3b5ec188a9361722d3c266f407eb.

📒 Files selected for processing (3)
  • lib/dataroom/get-recursive-folder-docs-count.ts (1 hunks)
  • pages/api/teams/[teamId]/datarooms/[id]/folders/[...name].ts (2 hunks)
  • pages/api/teams/[teamId]/datarooms/[id]/folders/index.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • pages/api/teams/[teamId]/datarooms/[id]/folders/index.ts
  • pages/api/teams/[teamId]/datarooms/[id]/folders/[...name].ts
  • lib/dataroom/get-recursive-folder-docs-count.ts
✨ Finishing Touches
  • [ ] 📝 Docstrings were successfully generated. (🔄 Check again to generate docstrings again)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar May 21 '25 16:05 coderabbitai[bot]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
papermark ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 21, 2025 5:13pm

vercel[bot] avatar May 21 '25 17:05 vercel[bot]

@mfts removed unused parameter!

Aashish-Upadhyay-101 avatar May 21 '25 17:05 Aashish-Upadhyay-101

https://github.com/mfts/papermark/pull/1667#discussion_r2100778206

@Aashish-Upadhyay-101 can you also add the suggestion about the memoization of the foldercount.

mfts avatar May 21 '25 18:05 mfts

@mfts @Aashish-Upadhyay-101 Recursion for nested folder/document count can get expensive as depth grows. Would it make sense to add stored fields (e.g., totalDocuments, totalChildFolders) on the folder model and update them? What do you think?

AshishViradiya153 avatar May 22 '25 06:05 AshishViradiya153

Would it make sense to add stored fields (e.g., totalDocuments, totalChildFolders) on the folder model and update them? What do you think?

That's a good suggestions. I kinda like how clean the model is right now, but understand that traversing the folder tree every time is just super expensive.

mfts avatar May 22 '25 08:05 mfts

[!NOTE] Generated docstrings for this pull request at https://github.com/mfts/papermark/pull/1673

coderabbitai[bot] avatar May 23 '25 10:05 coderabbitai[bot]