dotCMS / dotCMS/core

[Spike]: Performance Analysis and Optimization Strategy for Folder API Operations

Open
#32,472 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Team : Scout Type : Spike
Dominant language
Java
Stars
970
Forks
486
Avg merge
3d 33m
Merged PRs (30d)
170

Description

Task

Purpose

Conduct a comprehensive performance evaluation of existing folder APIs and design optimization strategies for the new Folders REST API, especially for heavy operations involving large folder structures.

Goals

  • Performance test existing /api/v1/assets and /v1/folder endpoints with various folder sizes
  • Benchmark current deletion operations for large folder structures
  • Evaluate async processing capabilities for heavy operations
  • Analyze memory and CPU usage patterns during folder operations
  • Design performance optimization strategies for the new API

Acceptance Criteria

  • [ ] Performance test results for existing APIs with small, medium, and large folder structures
  • [ ] Benchmark analysis for operations on folders with 100K+ assets (as mentioned in comments)
  • [ ] Memory and CPU usage analysis during heavy operations
  • [ ] Performance comparison between different folder retrieval methods (URI vs path)
  • [ ] Async processing capability assessment for large deletions
  • [ ] Performance optimization recommendations for new API implementation
  • [ ] Caching strategy recommendations for frequently accessed operations

Parent Issue

Subtask of #32302

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing /api/v1/assets and /v1/folder endpoints and defining test cases for small, medium, and large folder structures. Benchmark retrieval and deletion, including folders with 100K+ assets, while recording CPU and memory usage. Done means documented comparisons, async and caching assessments, and optimization recommendations for the new Folders REST API.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend, performance
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.