Adding Api for Plugin using smaple_data in api
This is api for fethching Plugin from SampleData
Related to : https://github.com/PalisadoesFoundation/talawa-admin/issues/3559
Summary by CodeRabbit
-
New Features
- The GraphQL API now enables you to retrieve plugin details. You can query for an individual plugin by name or fetch a list of all plugins.
- Plugin data now includes key metadata such as creator, description, and a list of organizations that have uninstalled the plugin.
- A new mutation allows you to update the installation status of a plugin for a specific organization.
-
Documentation
- Updated documentation to reflect the new
Plugintype and associated queries in the GraphQL schema.
- Updated documentation to reflect the new
-
Tests
- Enhanced schema tests ensure the new plugin queries and related validations perform as expected.
Walkthrough
This pull request introduces a new GraphQL entity for plugins. A Plugin type is added with fields for creator, description, name, and a list of uninstalled organizations. Two new query fields (getPlugins and plugin) and an associated input type (QueryPluginInput) have been added, with input validation implemented using the Zod library. Additionally, sample plugin data is provided in a JSON file, and the corresponding GraphQL schema and test type definitions have been updated. The plugin queries also include authentication checks and structured error handling.
Changes
| File(s) | Change Summary |
|---|---|
schema.graphql, test/routes/graphql/gql.tada.d.ts |
Added new Plugin type with fields pluginCreatedBy, pluginDesc, pluginName, and uninstalledOrgs; introduced new query fields getPlugins: [Plugin!] and plugin(input: QueryPluginInput!): Plugin; and added the QueryPluginInput input type. |
src/graphql/inputs/QueryPluginInput.ts |
Introduced a new Zod schema and input reference for QueryPluginInput, enforcing a non-empty string for pluginName. |
src/graphql/types/Plugins/Plugins.ts, src/graphql/types/Plugins/pluginData.json |
Defined a new Plugin type with a Zod validation schema and GraphQL builder reference; added a JSON file containing an array of sample plugin objects. |
src/graphql/types/Query/index.ts, src/graphql/types/Query/plugin.ts |
Added an import of the new plugin module in the query index and implemented new query resolvers for getPlugins and plugin with authentication checks, input validation, and structured error handling. |
Possibly related PRs
- PalisadoesFoundation/talawa-api#3260: The changes in the main PR are related to the addition of the
QueryPluginInputinput type, which is also defined in the retrieved PR as part of thegetPluginsquery, indicating a direct connection at the code level. - PalisadoesFoundation/talawa-api#3218: The changes in the main PR are related to the introduction of the
QueryPluginInputtype, which is also referenced in the retrieved PR's context, indicating a connection through the GraphQL schema modifications. - PalisadoesFoundation/talawa-api#3279: The changes in the main PR are related to the introduction of the
QueryPluginInputtype, which is also referenced in the retrieved PR's modifications to the GraphQL schema, specifically in the context of querying plugins.
Suggested labels
ignore-sensitive-files-pr
Suggested reviewers
- palisadoes
- xoldd
✨ 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?
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR. (Beta)@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
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.
Our Pull Request Approval Process
Thanks for contributing!
Testing Your Code
Remember, your PRs won't be reviewed until these criteria are met:
- We don't merge PRs with poor code quality.
- Follow coding best practices such that CodeRabbit.ai approves your PR.
- We don't merge PRs with failed tests.
- When tests fail, click on the
Detailslink to learn more. - Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
- Tests may fail if you edit sensitive files. Ask to add the
ignore-sensitive-files-prlabel if the edits are necessary.
- When tests fail, click on the
- We cannot merge PRs with conflicting files. These must be fixed.
Our policies make our code better.
Reviewers
Do not assign reviewers. Our Queue Monitors will review your PR and assign them. When your PR has been assigned reviewers contact them to get your code reviewed and approved via:
- comments in this PR or
- our slack channel
Reviewing Your Code
Your reviewer(s) will have the following roles:
- arbitrators of future discussions with other contributors about the validity of your changes
- point of contact for evaluating the validity of your work
- person who verifies matching issues by others that should be closed.
- person who gives general guidance in fixing your tests
CONTRIBUTING.md
Read our CONTRIBUTING.md file. Most importantly:
- PRs with issues not assigned to you will be closed by the reviewer
- Fix the first comment in the PR so that each issue listed automatically closes
Other
- :dart: Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
- Read the CONTRIBUTING.md file make
Codecov Report
Attention: Patch coverage is 46.44550% with 113 lines in your changes missing coverage. Please review.
Project coverage is 49.43%. Comparing base (
4f56a53) to head (825fbb2).
| Files with missing lines | Patch % | Lines |
|---|---|---|
| src/graphql/types/Query/plugin.ts | 26.62% | 113 Missing :warning: |
Additional details and impacted files
@@ Coverage Diff @@
## develop-postgres #3294 +/- ##
====================================================
- Coverage 49.45% 49.43% -0.02%
====================================================
Files 462 465 +3
Lines 34776 34987 +211
Branches 1038 1043 +5
====================================================
+ Hits 17199 17297 +98
- Misses 17577 17690 +113
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
- Please make coderabbit.ai approves your work.
- Make sure all tests pass and are valid.
- Ensure the test code coverage for your patch reaches as close to 100% as possible.
@MayankJha014 Please fix the first comment so that each issue listed automatically closes. The PR_GUIDELINES.md file has details.
Please also fill in the template for the pull request as completely as you can. Please make sure all checks are passed.
ok sir
started working on it
@MayankJha014 this is no longer the requirement. Closing this PR & please go through the project idea list once. you will get the intent of the project. We are trying to change the whole architecture of the plugin in talawa. This apis adheres to the old design which is not very streamlines.