KC: Stop Connectors and Reset Connector Offsets

[Dugong42]

What changes did you make? (Give an overview)

This brings a few features to the "Connector" pages (list and detail), related to Connector Offsets management (#183)

Added

• Added a dropdown option to "Stop" a connector
• Added a dropdown option to "Reset Connector Offsets". It requires a confirmation as for the "Delete" action.
• Added a new permission "RESET_OFFSETS" for connect
• Displayed the "Pause" and "Resume" actions in the Connectors list page dropdown (previously only on the connector detail page)

Changes

• The "Restart" menu of the detail page is disabled during connector state changes, instead of its individual items being disable, to give a better visual feedback of the ongoing operation.
• The "Remove Connector" action on the connector list page is renamed as "Delete" to match the same action on the detail page and other similar actions on other resources.

Fixed

• edit2: On the detail page, Connector actions now behave as expected, triggering a data refresh

Misc

Given I'm working behind a corporate proxy which was a pain to configure, I added a few tweaks to improve the dev experience.

• Added some configuration to be able to build behind a corporate proxy with minimal config (for instance proxies/mirrors in .npmrc and .m2/settings.xml and system proxies)
• Reduced maven dependency fetch time: Moved the declaration of the more specific Confluent repository after the more common Apache repo. This matters in my experience because maven tries them in order for every package.

edit1 with screenshots

The "Reset" button is disabled if the connector is not STOPPED

On the detail page, the "Restart" dropdown now contains the new "Stop" action

The other dropdown contains the Reset and Delete actions

Confirmation dialog

Is there anything you'd like reviewers to focus on?

• Not too sure about the UX of the "Restart" dropdown. It's a bit weird to have part of the actions in it and part in the other dropdown.
• Not sure about the current unit test policy, did not see many tests for other similar features.
• VSCode applied some formatting changes. I hope that's not a bother to review.
• I tested manually but was unable to run java unit tests locally, I have an 8GB RAM toaster which apparently is not enough to run WSL + the tests, as they kept getting killed by OOM errors.

How Has This Been Tested? (put an "x" (case-sensitive!) next to an item)

• No need to
• Manually (please, describe, if necessary)
• Unit checks
• Integration checks
• Covered by existing automation

Checklist (put an "x" (case-sensitive!) next to all the items, otherwise the build will fail)

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation (e.g. ENVIRONMENT VARIABLES)
• My changes generate no new warnings (e.g. Sonar is happy)
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
  • Frontend tests are passing
  • Backend tests kept crashing because of out of memory errors. My toaster with 8GB RAM was not enough to run WSL + the tests apparently.
• Any dependent changes have been merged
  • Needs some documentation for the new permission

A picture of a cute animal (not mandatory but encouraged)

[github-actions]

Hi Dugong42! 👋

Welcome, and thank you for opening your first PR in the repo!

Please wait for triaging by our maintainers.

Please take a look at our contributing guide.

[yeikel]

@Dugong42 FYI: #710 (comment)

The workaround that you implemented should not be needed after that pull request is merged

Thank you for helping me during my analysis indirectly :)

[fallen-up]

tested and

1. it's strange that acl doesn't fit into a unified formula.
   now you need to do an acl like this (uppercase):

          - resource: connect
            value: ".*"
            actions: ["view", "restart", "RESET_OFFSETS"]

2. After stopping connector - Error 500

JSON decoding error: Cannot construct instance of `io.kafbat.ui.connect.model.ConnectorStatusConnector$StateEnum`, problem: Unexpected value 'STOPPED'

[Haarolean]

1. now you need to do an acl like this (uppercase):

@fallen-up this shouldn't be a case, it's case insensitive for all the enums. Can you confirm please?

[Haarolean]

@Dugong42 hi, can you take a look at the 2nd issue @fallen-up mentioned? And I guess we don't need the workaround for the KC anymore considering @yeikel's changes

[fallen-up]

@fallen-up this shouldn't be a case, it's case insensitive for all the enums. Can you confirm please?

@Haarolean yep, looks like my bad. register is insensitive

[Dugong42]

@yeikel thanks for the proper fix!

@Haarolean I've rolled back my workaround and taken the retry mechanic into account.

I've tested different values for the actions and could not replicate the case issue.
As @fallen-up said in the end it seems to work as expected.

It should be ready to merge :)

[Haarolean]

@Dugong42 could you please refrain from force-pushing a PR branch that has been previously reviewed in the future? This marks multiple files as unreviewed without a clear diff even if there are none since the last review.

[yeikel]

Thank you! (I can only comment as my approval does not count)

[Haarolean]

Thank you! (I can only comment as my approval does not count)

yep, this is a limitation to prevent random users LGTMing on PRs (yes, it's actually a thing)

[Haarolean]

@Dugong42 thanks for your first contribution to kafbat UI! 🎉

[fallen-up]

finally managed to do a full test.
@Dugong42
it seems that the initial description of the PR, including the names of the buttons and other elements, was incorrect. here are my reasons:

• "Reset offset" suggests resetting to a specific value. In other functionalities of kafka-ui, "reset" clearly means triggering a reset of one type (earliest, latest, timestamp, offset).
• there is also an option to delete a consumer group.
• in FE: Add Search Functionality to ACLs page #636, the deletion of offsets for a single topic within a group is implemented, and in the menu, it appears as "Delete offsets".
• this PR simply performs a Delete, not Patch/Reset. it can easily lead to confusion. and at a minimum the button labels, acl changes should be changed.

[yeikel]

finally managed to do a full test.
@Dugong42
it seems that the initial description of the PR, including the names of the buttons and other elements, was incorrect. here are my reasons:

• "Reset offset" suggests resetting to a specific value. In other functionalities of kafka-ui, "reset" clearly means triggering a reset of one type (earliest, latest, timestamp, offset).
• there is also an option to delete a consumer group.
• in FE: Add Search Functionality to ACLs page #636, the deletion of offsets for a single topic within a group is implemented, and in the menu, it appears as "Delete offsets".
• this PR simply performs a Delete, not Patch/Reset. it can easily lead to confusion. and at a minimum the button labels, acl changes should be changed.

Is the challenge that the name is misleading?

The original API also uses the "delete" terminology, while what it does is to "reset it". For the context of offset tracking delete and reset seem to be the same thing here

[fallen-up]

Is the challenge that the name is misleading?

The original API also uses the "delete" terminology, while what it does is to "reset it". For the context of offset tracking delete and reset seem to be the same thing here

let's go the other way around.
suppose there is a kind person who implements "PATCH /connectors/{connector}/offsets" - how should he call the button? "patch"?
if so, why can't the current one be called "delete"? and then you won't need to look at the documentation to understand what it does.