Skip to content

Conversation

@DrCloy
Copy link
Collaborator

@DrCloy DrCloy commented Feb 20, 2025

#️⃣ 연관된 이슈

📝 작업 내용

  • 교수 유저 데이터 캐싱 추가

Summary by CodeRabbit

  • New Features
    • Improved performance by caching professor data, resulting in faster load times.
    • Profile updates are now reflected immediately, and cached data clears automatically on logout or account deletion.
  • Removed Features
    • The option to view professor PDFs has been removed.

@DrCloy DrCloy added ✨ Feat 새로운 기능 추가 (기능 개발 및 신규 기능 구현) ⚛️ FE 프론트엔드 관련 labels Feb 20, 2025
@DrCloy DrCloy requested a review from wwweric12 February 20, 2025 09:59
@coderabbitai
Copy link

coderabbitai bot commented Feb 20, 2025

Walkthrough

The changes enhance the professor data management in the repository by introducing a caching mechanism. The ProfessorCache property now temporarily stores professor details. Methods such as getProfessor, getProfessorProfile, updateProfessorName, updateProfessorProfile, as well as logout and deleteProfessor, have been modified to use or clear this cache appropriately. Additionally, the getProfessorPDF method has been removed, reducing unnecessary API calls.

Changes

File Path Change Summary
front-end/src/.../professorRepository.ts - Added private property ProfessorCache for caching professor data.
- Modified getProfessor and getProfessorProfile to first check the cache.
- Updated updateProfessorName and updateProfessorProfile to amend cached data.
- logout and deleteProfessor now clear the cache.
- Removed getProfessorPDF.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant PR as ProfessorRepository
    participant API as External API

    C->>PR: getProfessor()
    alt Cache available
        PR-->>C: Return cached professor data
    else Cache empty
        PR->>API: Fetch professor data
        API-->>PR: Return professor data
        PR->>PR: Update ProfessorCache
        PR-->>C: Return fetched data
    end
Loading

Suggested Reviewers

  • wwweric12

Poem

I'm a rabbit in a code-filled glade,
Hoping through changes that have been made.
Caching professor info with a nimble leap,
Saving API calls, so data's cheap.
In fields of logic, I happily bound,
Where swift changes and cool code abound!
🐇🌟

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (3)
front-end/src/repository/professorRepository.ts (3)

5-5: Follow TypeScript naming conventions for private properties.

Rename ProfessorCache to professorCache to follow TypeScript naming conventions for private properties (camelCase).

-  private ProfessorCache: Professor | null = null;
+  private professorCache: Professor | null = null;

41-43: Consider implementing a cache invalidation strategy.

While the cache implementation is correct, consider adding:

  1. Time-to-live (TTL) for cache entries
  2. Cache invalidation on error responses
  3. Cache refresh mechanism for stale data

This helps prevent serving stale data and manages memory efficiently.

Example implementation:

interface CachedProfessor extends Professor {
  timestamp: number;
}

private professorCache: CachedProfessor | null = null;
private readonly CACHE_TTL = 5 * 60 * 1000; // 5 minutes

private isCacheValid(): boolean {
  return this.professorCache && 
         (Date.now() - this.professorCache.timestamp) < this.CACHE_TTL;
}

Also applies to: 67-69


127-131: Refactor cache updates to reduce duplication and improve type safety.

The cache update logic is duplicated and could be simplified. Also, consider adding type guards for API responses.

private updateCache(partial: Partial<Professor>): void {
  this.professorCache = {
    name: '',
    email: '',
    profileURL: '',
    ...this.professorCache,
    ...partial,
  };
}

// Usage in updateProfessorName:
this.updateCache({ name: json.data.name.toString() });

// Usage in updateProfessorProfile:
this.updateCache({ profileURL: json.data.imageUrl.toString() });

Also applies to: 156-160

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d6117eb and 0a6d93b.

📒 Files selected for processing (1)
  • front-end/src/repository/professorRepository.ts (7 hunks)
🔇 Additional comments (1)
front-end/src/repository/professorRepository.ts (1)

4-181: Overall implementation looks good with suggested improvements.

The caching implementation successfully reduces API calls and improves performance. The suggested improvements around naming conventions, cache invalidation, error handling, and code reusability will make the implementation more robust and maintainable.


await throwError(response);

this.ProfessorCache = null;
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Improve error handling for cache clearing operations.

Move cache clearing after successful response handling to prevent cache inconsistency if the API call fails.

// In logout method
-    await throwError(response);
-    this.professorCache = null;
+    await throwError(response);
     if (response.redirected) {
+      this.professorCache = null;
       window.location.href = response.url;
     }
+    this.professorCache = null;

// In deleteProfessor method
-    await throwError(response);
-    this.professorCache = null;
+    await throwError(response);
     if (response.redirected) {
+      this.professorCache = null;
       window.location.href = response.url;
     }
+    this.professorCache = null;

Also applies to: 175-175

Copy link
Collaborator

@wwweric12 wwweric12 left a comment

Choose a reason for hiding this comment

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

캐싱하는거 좋은거 같습니다! 고생하셨습니다!

@wwweric12 wwweric12 merged commit 23bef6c into dev Feb 20, 2025
2 checks passed
@wwweric12 wwweric12 deleted the feat/fe/professor-user-cache branch February 20, 2025 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

⚛️ FE 프론트엔드 관련 ✨ Feat 새로운 기능 추가 (기능 개발 및 신규 기능 구현)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants