Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add purpose filter with trees, conservation and restoration #485

Merged
merged 2 commits into from
Jan 13, 2025

Conversation

norbertschuler
Copy link
Collaborator

@norbertschuler norbertschuler commented Jan 10, 2025

Additionally to @jmiridis having added some default filtering in case a filter is missing to the api endpoint to retrieve the project list as the app crashed with the latest results (e.g. not containing some tpo property for some projects), we maybe should add some filtering as well into the frontend. This is just a quick fix. Please review what kind of filter might be wanted for this application. I used the same now as done by @jmiridis in the backend. Compare this thread: https://planetfoundation.slack.com/archives/C02393H3GDC/p1736524954057429

(Also adapted faulty GitHub action for linting.)

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features
    • Enhanced project filtering in the application
    • Limited project selection to specific purposes (trees, restoration, conservation)
  • Chores
    • Updated Node.js environment setup in the ESLint workflow
    • Modified dependency installation process to improve compatibility

Copy link

vercel bot commented Jan 10, 2025

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

Name Status Preview Comments Updated (UTC)
donate-with-planet ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 11, 2025 9:07am

Copy link

coderabbitai bot commented Jan 10, 2025

Walkthrough

The pull request modifies the loadselectedProjects function in the QueryParamContext.tsx file by updating the API request URL. The change introduces a new filter parameter that restricts project retrieval to specific purposes: trees, restoration, and conservation. Additionally, the ESLint workflow configuration is updated to improve the setup for the Node.js environment and dependency installation, enhancing the overall development process without altering the existing logic.

Changes

File Change Summary
src/Layout/QueryParamContext.tsx Updated API request URL to include purpose-based filtering for projects
.github/workflows/eslint.yml Modified Node.js setup and dependency installation steps in ESLint workflow

Poem

🐰 Hopping through code with glee,
Projects filtered, now I see!
Trees and lands of green delight,
Conservation's purpose shines bright!
API calls, now precise and neat 🌿


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: 0

🧹 Nitpick comments (1)
src/Layout/QueryParamContext.tsx (1)

241-241: Consider making the purpose filter configurable.

While the current implementation fixes the immediate issue, consider making the purpose filter values configurable through environment variables or a configuration object. This would provide more flexibility for future changes without code modifications.

Example implementation:

- url: `/app/projects?_scope=map&filter[purpose]=trees,restoration,conservation`,
+ url: `/app/projects?_scope=map&filter[purpose]=${config.allowedPurposes || 'trees,restoration,conservation'}`,
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b35826d and bdfcddb.

📒 Files selected for processing (1)
  • src/Layout/QueryParamContext.tsx (1 hunks)
🔇 Additional comments (2)
src/Layout/QueryParamContext.tsx (2)

Line range hint 241-259: Implementation looks good!

The changes maintain proper error handling and data processing while adding the purpose filter. The existing functionality for filtering allowed donations and random project selection is preserved.


241-241: Change aligns well with PR objectives.

The implementation successfully addresses the API endpoint issues by adding the requested purpose filter for trees, conservation, and restoration. This serves as an effective quick fix while maintaining the possibility for future improvements.

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: 0

🧹 Nitpick comments (1)
.github/workflows/eslint.yml (1)

15-18: Document Node.js version choice

The Node.js setup looks good, using the latest action version and an LTS Node version. Consider adding a comment explaining why Node 18.x was chosen to help with future maintenance.

      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
+         # Using Node 18.x LTS for stability and long-term support
          node-version: '18.x'
🧰 Tools
🪛 actionlint (1.7.4)

16-16: the runner of "actions/setup-node@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bdfcddb and 2eb3d75.

📒 Files selected for processing (1)
  • .github/workflows/eslint.yml (1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/eslint.yml

16-16: the runner of "actions/setup-node@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

🔇 Additional comments (1)
.github/workflows/eslint.yml (1)

21-21: Review dependency conflicts requiring --legacy-peer-deps

The use of --legacy-peer-deps suggests there might be unresolved peer dependency conflicts in the project. While this flag works as a temporary solution, it's recommended to:

  1. Review the npm install logs to identify the specific conflicts
  2. Update dependencies to compatible versions where possible
  3. Document any conflicts that cannot be resolved immediately

Let's identify the specific dependency conflicts:

Copy link
Contributor

@mohitb35 mohitb35 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@mariahosfeld mariahosfeld left a comment

Choose a reason for hiding this comment

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

Functionality looks good to me.

@mariahosfeld mariahosfeld merged commit b749600 into develop Jan 13, 2025
5 checks passed
@mariahosfeld mariahosfeld deleted the feature/add_filter_to_projects_endpoint branch January 13, 2025 07:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants