search

lfglabs-dev / starknet.quest

The on-chain quest tool of Starknet
https://starknet.quest
33 stars 121 forks source link

feat: add custom api task type #844

Closed od-hunter closed 1 month ago

od-hunter commented 1 month ago

Pull Request type

Please add the labels corresponding to the type of changes your PR introduces:

Resolves: #835

Other information

Summary by CodeRabbit

vercel[bot] commented 1 month ago

@od-hunter is attempting to deploy a commit to the LFG Labs Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes introduce a new task type, CustomApi, in the admin dashboard, enhancing the existing functionality to handle custom API tasks. This includes updates to various components and services to manage the creation and updating of custom API configurations, alongside modifications to type definitions to accommodate the new task structure.

Changes

Files Change Summary
app/admin/quests/dashboard/[questId]/page.tsx, components/admin/formSteps/TaskDetailsForm.tsx, components/admin/taskSteps/customApiStep.tsx Introduced a new type CustomApi in StepMap and updated the Page function to handle custom_api tasks. Added conditional rendering for CustomApi in TaskDetailsForm, and created a new CustomApiStep component to manage API-related fields.
constants/admin.ts Added "CustomApi" to TASK_OPTIONS and created CustomApiInput with several properties. Updated getDefaultValues function to return CustomApiInput for the new task type.
services/authService.ts Introduced createCustomApi and updateCustomApi functions for handling API task creation and updates, with error handling and integration into the AdminService.
types/backTypes.d.ts, types/frontTypes.d.ts Modified UserTask to include optional properties api_url and regex. Added new types CreateCustomApi and UpdateCustomApi for task creation and updates. Updated StepMap and TaskType to incorporate CustomApi.

Assessment against linked issues

Objective Addressed Explanation
Add a new task type in the admin dashboard: custom_api (Issue #835) ✅
Implement the creation process of this new task type in the front ✅
Use fields from the balance task as an example for the new task type ❌ The implementation does not reuse fields from balance.
Ensure both URL and API URL fields are included in the new task type ✅

Possibly related PRs

Suggested reviewers

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Marchand-Nicolas commented 1 month ago

Also, there is an issue because customApi starts with the word "custom", and it makes both tabs shown as selected: image You can fix it really easily in components\admin\formSteps\TaskDetailsForm.tsx by updating lines 179 and 184: replace the .includes( by a simple ===

Marchand-Nicolas commented 1 month ago

Also, changes are missing in app\admin\quests\create\page.tsx