fix(api-arg): js clients has broken arguments so we have to use list of args #1844

karelhala · 2025-05-30T08:09:33Z

Description

Currently JS clients have bug in which we have to pass full list of arguments with v2 client. Object does not work at all, so let's use this for workspaces.

This PR also fixes bad configuration on workspaces requests in cypress which started to fail because of increased limit to 10000 workspaces.

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

Use full positional arguments for v2 workspaces JS client methods and update Cypress tests to handle increased workspace limit and dynamic endpoint URLs.

Bug Fixes:

Fix workspaces helper functions to pass positional arguments to JS v2 API methods instead of object parameters.

Tests:

Increase mocked workspace pagination limit to 10000 in Cypress tests and switch intercepts to wildcard URL patterns for workspace endpoints.

sourcery-ai · 2025-05-30T08:09:40Z

Reviewer's Guide

This PR fixes broken JS client argument handling by refactoring workspace helper functions to pass explicit positional parameters to the v2 API methods and updates Cypress tests to accommodate the increased workspace limit (10000) and wildcard endpoint patterns.

Sequence Diagram: Updated `getWorkspace` API Call

sequenceDiagram
    participant WH as WorkspacesHelper
    participant WA as workspacesApi
    WH->>WA: getWorkspace(workspaceId, false, {})
    WA-->>WH: Workspace Data

Sequence Diagram: Updated `updateWorkspace` API Call

sequenceDiagram
    participant WH as WorkspacesHelper
    participant WA as workspacesApi
    WH->>WA: updateWorkspace(config.id, config.workspacesPatchWorkspaceRequest, {})
    WA-->>WH: Update Confirmation

Sequence Diagram: Updated `deleteWorkspace` API Call

sequenceDiagram
    participant WH as WorkspacesHelper
    participant WA as workspacesApi
    WH->>WA: deleteWorkspace(config.id, {})
    WA-->>WH: Deletion Confirmation

File-Level Changes

Change	Details	Files
Refactor workspace helpers for JS v2 client argument list	Changed getWorkspace to call api.getWorkspace(workspaceId, false, {}) Updated updateWorkspace to invoke api.updateWorkspace(id, requestBody, {}) Modified deleteWorkspace to use api.deleteWorkspace(id, {})	`src/helpers/workspaces/workspaces-helper.ts`
Update Cypress tests for new limit and endpoint patterns	Increased mock meta.limit from 100 to 10000 Replaced fixed query interceptions with wildcard URL patterns for list and detail routes	`cypress/e2e/workspaces-detail.cy.ts` `cypress/e2e/filter-workspaces.cy.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

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @karelhala - I've reviewed your changes - here's some feedback:

Consider refactoring the helper methods to define default values for the extra parameters so callers don’t need to pass false and {} every time.
The Cypress intercept patterns using **/api/rbac/v2/workspaces/* are quite broad—narrowing them to the exact endpoints (e.g. including query parameters or specific path segments) will help avoid unintended matches.

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.}

sourcery-ai · 2025-05-30T08:16:13Z

cypress/e2e/workspaces-detail.cy.ts

      statusCode: 200,
      body: mockWorkspaces,
    }).as('getWorkspaces');

    // mock the workspace
-    cy.intercept('GET', '**/api/rbac/v2/workspaces/asd-sda-asd-dsa-asd', {
+    cy.intercept('GET', '**/api/rbac/v2/workspaces/asd-sda-asd-dsa-asd/*', {


suggestion (bug_risk): Detail intercept may not match the actual endpoint

The appended /* pattern requires an extra path segment and won't match /workspaces/:id. Use **/workspaces/asd-sda-asd-dsa-asd* or explicitly handle query parameters to ensure correct interception.

karelhala · 2025-05-30T08:41:39Z

/retest

karelhala · 2025-05-30T10:23:00Z

/retest

…of args

karelhala · 2025-06-04T07:04:26Z

/retest

karelhala requested a review from a team as a code owner May 30, 2025 08:09

riccardo-forina approved these changes May 30, 2025

View reviewed changes

sourcery-ai bot reviewed May 30, 2025

View reviewed changes

fix(api-arg): js clients has broken arguments so we have to use list …

dfd67ad

…of args

karelhala force-pushed the fix-api-args branch from b5ea6ed to dfd67ad Compare June 4, 2025 04:55

karelhala merged commit e3f2d4a into RedHatInsights:master Jun 4, 2025
8 of 9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(api-arg): js clients has broken arguments so we have to use list of args #1844

fix(api-arg): js clients has broken arguments so we have to use list of args #1844

Uh oh!

karelhala commented May 30, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented May 30, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

sourcery-ai bot May 30, 2025

Uh oh!

karelhala commented May 30, 2025

Uh oh!

karelhala commented May 30, 2025

Uh oh!

karelhala commented Jun 4, 2025

Uh oh!

Uh oh!

Uh oh!

fix(api-arg): js clients has broken arguments so we have to use list of args #1844

fix(api-arg): js clients has broken arguments so we have to use list of args #1844

Uh oh!

Conversation

karelhala commented May 30, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Screenshots

Before:

After:

Checklist ☑️

Summary by Sourcery

Uh oh!

sourcery-ai bot commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Sequence Diagram: Updated getWorkspace API Call

Sequence Diagram: Updated updateWorkspace API Call

Sequence Diagram: Updated deleteWorkspace API Call

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot May 30, 2025

Choose a reason for hiding this comment

Uh oh!

karelhala commented May 30, 2025

Uh oh!

karelhala commented May 30, 2025

Uh oh!

karelhala commented Jun 4, 2025

Uh oh!

Uh oh!

Uh oh!

karelhala commented May 30, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented May 30, 2025 •

edited

Loading

Sequence Diagram: Updated `getWorkspace` API Call

Sequence Diagram: Updated `updateWorkspace` API Call

Sequence Diagram: Updated `deleteWorkspace` API Call