Feature/use api hook 10

[mohitb35]

Replaces getAuthenticatedRequested with useApi().getApiAuthenticated in PlanetCash and PlantingLocation components

Pages affected

• /profile/planetcash
• /profile/treemapper/import (1st step)

[vercel]

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

Name	Status	Preview	Updated (UTC)
planet-webapp-multi-tenancy-setup	✅ Ready (Inspect)	Visit Preview	Apr 10, 2025 4:37am

[coderabbitai]

Walkthrough

The changes update the API request mechanism in two user-facing features. The refactor removes the getAuthenticatedRequest function (and the useTenant hook in one case) and replaces it with the getApiAuthenticated function via the useApi hook. Both components now initiate API calls by passing only the endpoint URL, simplifying the request signature while retaining existing error handling and sorting logic.

Changes

File(s)	Change Summary
src/features/user/PlanetCash/index.tsx, src/features/user/.../PlantingLocation.tsx	Removed getAuthenticatedRequest and replaced it with getApiAuthenticated using the useApi hook. Updated method signatures to use a simple URL parameter. Removed the useTenant hook in PlanetCash.

Sequence Diagram(s)

sequenceDiagram
  participant C as Component
  participant UA as useApi Hook
  participant GA as getApiAuthenticated
  participant S as API Server
  C->>UA: Initiate API request (e.g., "/app/planetCash")
  UA->>GA: Call getApiAuthenticated with URL
  GA->>S: Send API request
  S-->>GA: Return response data
  GA-->>UA: Relay data
  UA-->>C: Deliver API response

Loading

Possibly related PRs

• Feature/use api hook2 #2474: Involves a similar removal of getAuthenticatedRequest and its replacement with getApiAuthenticated for API handling.
• Feature/use api hook1 #2469: Implements a comparable API call refactor in another component.
• Feature/use server api hook #2466: Focuses on transitioning from the old API request function to the new approach across the application.

Suggested labels

PR: reviewed-approved

Poem

I'm a rabbit hopping through code with might,
Saying farewell to old functions in delight.
getApiAuthenticated now leads the way,
Simplifying calls throughout the day.
With whiskers twitching at each neat byte,
I celebrate changes in the moonlit night!
🥕🐇

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 93194cd and a1a6bc7.

📒 Files selected for processing (2)

• src/features/user/PlanetCash/index.tsx (3 hunks)
• src/features/user/TreeMapper/Import/components/PlantingLocation.tsx (5 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (2)

src/features/user/PlanetCash/index.tsx (2)

src/hooks/useApi.ts (1)

• useApi (93-320)

src/features/common/Layout/BulkCodeContext.tsx (1)

• PlanetCashAccount (11-15)

src/features/user/TreeMapper/Import/components/PlantingLocation.tsx (3)

src/hooks/useApi.ts (1)

• useApi (93-320)

src/features/common/types/projectv2.d.ts (1)

• MapProject (20-20)

src/features/common/types/plantLocation.d.ts (1)

• Species (162-169)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Analyze (javascript)
• GitHub Check: ESLint on Ubuntu

🔇 Additional comments (8)

src/features/user/TreeMapper/Import/components/PlantingLocation.tsx (4)

41-41: Good addition of useApi import for a cleaner authentication approach.

This change is part of the migration from the generic getAuthenticatedRequest function to the more specialized useApi hook, which centralizes authentication logic and simplifies API calls.

---

175-175: Good extraction of getApiAuthenticated from useApi hook.

This properly sets up the component to use the new API calling pattern, allowing for simplified API requests.

---

214-216: Simplified API call for loading projects.

The refactored code is more concise and maintainable, requiring only the endpoint URL rather than multiple authentication parameters.

---

225-227: Simplified API call for loading species.

Similar to the projects API call, this refactoring simplifies the code and centralizes authentication logic.

src/features/user/PlanetCash/index.tsx (4)

17-17: Good addition of useApi import for a cleaner authentication approach.

This change is part of the migration from the generic getAuthenticatedRequest function to the more specialized useApi hook, which centralizes authentication logic and simplifies API calls.

---

35-35: Good extraction of getApiAuthenticated from useApi hook.

This properly sets up the component to use the new API calling pattern, allowing for simplified API requests.

---

38-38: Properly removed unused logoutUser from destructuring.

Since the new getApiAuthenticated method from the useApi hook internally manages authentication failures and logout logic, this property is no longer needed in this component.

---

84-86: Simplified API call for fetching Planet Cash accounts.

The refactored code is more concise and maintainable, requiring only the endpoint URL rather than multiple authentication parameters. This also properly removes dependencies on tenant configuration which is now handled internally by the useApi hook.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[sunilsabatp]

LGTM