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

queries added for env status update #329

Merged
merged 1 commit into from
Nov 12, 2024

Conversation

nxtcoder36
Copy link
Contributor

@nxtcoder36 nxtcoder36 commented Nov 6, 2024

Summary by Sourcery

Add new GraphQL operations for updating environment details and retrieving BYOK cluster information, and enhance existing queries with additional fields for improved environment status tracking.

New Features:

  • Add a new GraphQL mutation 'cli_updateEnvironment' to update environment details.
  • Introduce a new GraphQL query 'cli_getBYOKCluster' to retrieve BYOK cluster information.

Enhancements:

  • Extend existing GraphQL queries to include 'isArchived' and 'suspend' fields for better environment status tracking.

Copy link

sourcery-ai bot commented Nov 6, 2024

Reviewer's Guide by Sourcery

This PR adds new GraphQL queries and updates existing ones to support environment status updates. The changes primarily involve adding new fields to existing queries and introducing new mutations/queries for environment and BYOK cluster management.

Class diagram for updated GraphQL queries

classDiagram
    class cliQueries {
        +cli_getEnvironment()
        +cli_updateEnvironment()
        +cli_cloneEnvironment()
        +cli_listEnvironments()
        +cli_getBYOKCluster()
        +cli_createClusterReference()
    }

    cliQueries : +isArchived
    cliQueries : +suspend

    class gql {
        +query authCli_getEnvironment()
        +mutation authCli_updateEnvironment()
        +mutation authCli_cloneEnvironment()
        +query authCli_listEnvironments()
        +query authCli_getBYOKCluster()
        +mutation authCli_createClusterReference()
    }

    gql : +isArchived
    gql : +suspend

    note for cliQueries "New fields and queries added for environment and BYOK cluster management"
    note for gql "New fields and queries added for environment and BYOK cluster management"
Loading

File-Level Changes

Change Details Files
Enhanced environment-related GraphQL queries with additional fields
  • Added 'isArchived' field to environment queries
  • Added 'suspend' field to environment spec
  • Added new mutation for updating environment details
src/apps/auth/server/gql/cli-queries.ts
gql-queries-generator/doc/queries.graphql
Added new BYOK cluster query functionality
  • Implemented new query to fetch BYOK cluster details
  • Added fields for cluster token, display name, online status, and metadata
src/apps/auth/server/gql/cli-queries.ts
gql-queries-generator/doc/queries.graphql

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @nxtcoder36 - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

`,
{
transformer: (data: any) => data.core_updateEnvironment,
vars(_: any) {},
Copy link

Choose a reason for hiding this comment

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

issue: The vars function should handle the required 'env' parameter for the mutation

The GraphQL mutation requires an 'env' parameter but the vars function isn't processing any inputs. This could cause runtime failures.

@abdheshnayak abdheshnayak merged commit 9f632de into release-v1.1.1 Nov 12, 2024
5 checks passed
@abdheshnayak abdheshnayak deleted the ref/cli-queries-updated branch November 12, 2024 06:15
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.

2 participants