Add refresh button to widgets UI

[ChristianZaccaria]

Issue link

Jira: https://issues.redhat.com/browse/RHOAIENG-14057

What changes have been made

• Added a refresh button to the UI:

  When the button is clicked, the DataFrame is refreshed. Refreshing the list of RayClusters, the spec, and the status of the RayClusters in the DataFrame.

  Additionally, when the button is clicked, the button is disabled until the K8s API request for the list of RayClusters has returned. - This usually takes around 1 second.

• Removed redundant code. - Using self.namespace variable as opposed to retrieving the namespace from the dataframe.

• Updated Sphinx docs.

• Added UI e2e test case.

• Small refactor to separate concerns.

Verification steps

1. Checkout this PR and run poetry build to generate a new wheel.
2. Install the wheel with pip install.
3. Run through the widgets notebook.
4. Create a RayCluster.
5. Run view_clusters()
6. Create a 2nd RayCluster.
7. Click the button to refresh the DataFrame.

We can also test to refresh the DataFrame while the RayCluster has the status Failed. Once ready we can refresh the DataFrame to show current status, eventually being Ready.

Checks

• I've made sure the tests are passing.
• Testing Strategy
  • Unit tests
  • Manual tests
  • Testing is not required for this change

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@ec72303). Learn more about missing BASE report.
Report is 3 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #741   +/-   ##
=======================================
  Coverage        ?   94.12%           
=======================================
  Files           ?       36           
  Lines           ?     2417           
  Branches        ?        0           
=======================================
  Hits            ?     2275           
  Misses          ?      142           
  Partials        ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Bobbins228]

@ChristianZaccaria I thought that we were also going to add polling as well as the refresh button?

[ChristianZaccaria]

@Bobbins228 I left a comment in the Jira summarizing the team discussion. TLDR: Option 0 and 1 are preferred.

• Option 0 [For RayClusters]: offering a button used to refresh the list of RayClusters and its spec in the DataFrame, on demand without the need to be waiting *30 seconds to refresh the data (as done in Option 1). - Being more straightforward, practical, and faster/on-demand for the user.

• Option 1 [For i.e., RayJobs and KFTO Jobs]: can be used in future to refresh data on Job statuses as they progress which include RayJobs, KFTO Jobs, etc. Eventhough we would be polling every *30 seconds, a single List API request would be made per kind of Job resource, and not per each Job, reducing the load on API requests made.

Although thinking about it, we could definitely alter option 0 to continue to refresh for 1min, then enable the refresh button again. WDYT? - It would be like having real-time data flowing for a minute on-demand, and not indefinitely.

I.e.,:

    def _on_refresh_data_button_click(self, b):
        """
        _on_refresh_button_click handles the event when the Refresh Data button is clicked, refreshing the list of Ray Clusters.
        """
        self.refresh_data_button.disabled = True
        start_time = time.time()
        while True:
            elapsed_time = time.time() - start_time
            if elapsed_time < 60:
                self._refresh_dataframe()
            else:
                break
        self.refresh_data_button.disabled = False

[Bobbins228]

@ChristianZaccaria nevermind we should stick to our initial vote of option 0

[Bobbins228]

/lgtm tested this out and works as intended

[KPostOffice]

/lgtm Tested and worked as expected

[Bobbins228]

@ChristianZaccaria can you rebase this when you get the chance and we can approve again?

[ChristianZaccaria]

Rebased

[Bobbins228]

/lgtm
/approve

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Bobbins228, KPostOffice

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [Bobbins228,KPostOffice]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment