Skip to content

fix: use inline style when calling workspaces api #1845

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

Conversation

riccardo-forina
Copy link
Contributor

@riccardo-forina riccardo-forina commented Jun 3, 2025

The current version of the rbac-client is buggy
and its types are wrong when using the object passing style

Description


Screenshots

Before:

After:


Checklist ☑️

  • PR only fixes one issue or story
  • Change reviewed for extraneous code
  • UI best practices adhered to
  • Commits squashed and meaningfully named
  • All PR checks pass locally (build, lint, test, E2E)

  • (Optional) QE: Needs QE attention (OUIA changed, perceived impact to tests, no test coverage)
  • (Optional) QE: Has been mentioned
  • (Optional) UX: Needs UX attention (end user UX modified, missing designs)
  • (Optional) UX: Has been mentioned

Summary by Sourcery

Align helper methods with updated rbac-client API by replacing object parameters with positional arguments and setting default values inline.

Bug Fixes:

  • Fix type errors and incorrect behavior in workspaces API calls by using inline parameter style for list, get, create, update, and delete operations.

Enhancements:

  • Simplify helper functions by removing nested request objects and passing default pagination, filter, and options directly.

The current version of the rbac-client is buggy
and its types are wrong when using the object passing style
@riccardo-forina riccardo-forina requested a review from a team as a code owner June 3, 2025 16:39
Copy link
Contributor

sourcery-ai bot commented Jun 3, 2025

Reviewer's Guide

This PR refactors all Workspaces API helper functions to switch from the deprecated object-parameter style to the new inline, positional-parameter style supported by the updated rbac-client types.

Sequence Diagram: Updated getWorkspaces Call to workspacesApi

sequenceDiagram
    actor UserCode
    participant WH as "workspaces-helper"
    participant WApi as "workspacesApi"

    UserCode->>+WH: getWorkspaces(config)
    WH->>+WApi: listWorkspaces(limit, offset, type, options)
    WApi-->>-WH: Promise<WorkspacesList>
    WH-->>-UserCode: Promise<WorkspacesList>
Loading

Sequence Diagram: Updated createWorkspace Call to workspacesApi

sequenceDiagram
    actor UserCode
    participant WH as "workspaces-helper"
    participant WApi as "workspacesApi"

    UserCode->>+WH: createWorkspace(config)
    WH->>+WApi: createWorkspace(payloadObject, optionsObject)
    WApi-->>-WH: Promise<Workspace>
    WH-->>-UserCode: Promise<Workspace>
Loading

Class Diagram: workspacesApi New Method Invocation Signatures

classDiagram
    class workspacesApi {
        +listWorkspaces(limit: number, offset: number, type: string, queryOptions: object): Promise~any~
        +getWorkspace(id: string, someFlag: boolean, queryOptions: object): Promise~any~
        +createWorkspace(payload: object, queryOptions: object): Promise~any~
        +updateWorkspace(id: string, payload: object, queryOptions: object): Promise~any~
        +deleteWorkspace(id: string, queryOptions: object): Promise~any~
    }
Loading

File-Level Changes

Change Details Files
Refactored listWorkspaces call to use inline parameters
  • Replaced object spread for limit, offset, type, options with direct positional arguments
  • Defaulted limit to 10000, offset to 0, type to 'default', options to {}
src/helpers/workspaces/workspaces-helper.ts
Updated getWorkspace invocation to positional arguments
  • Removed object parameter with id property
  • Passed workspaceId as first argument
  • Added default flags (false) and empty options object
src/helpers/workspaces/workspaces-helper.ts
Simplified createWorkspace call signature
  • Removed wrapping object with workspacesCreateWorkspaceRequest key
  • Passed parent_id, name, description inline
  • Added empty options object as second parameter
src/helpers/workspaces/workspaces-helper.ts
Changed updateWorkspace to inline argument style
  • Replaced passing full config object with config.id and patch body
  • Added empty options object as third parameter
src/helpers/workspaces/workspaces-helper.ts
Converted deleteWorkspace to use inline parameters
  • Removed object-based parameter passing
  • Supplied config.id directly
  • Appended empty options object
src/helpers/workspaces/workspaces-helper.ts

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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

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
Contributor

@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 @riccardo-forina - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 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.

@karelhala karelhala merged commit 3cdae15 into RedHatInsights:master Jun 4, 2025
8 of 9 checks passed
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