feat(web): allow editing the hostname by dgdavid · Pull Request #2147 · agama-project/agama

dgdavid · 2025-03-11T17:57:37Z

Problem

Currently, users cannot edit the hostname through the web user interface.

Solution

Add a page that allows users to change the hostname directly from the web UI. Additionally, warn users at the registration form about hostname implications with a link to the section for changing it.

Tests

Tested manually
Added unit tests

Notes

This PR includes some cherry-picks from lvm-form branch to make forms looks a bit better. The motivation to do so is: a) LVM PR is taking longer than expected; b) this PR is no longer against a temporary branch but against master
Since updating the registration form was initially needed, this PR also takes the opportunity to improve the form. That's why Some commits are purely related to the registration form
A new "system" namespace has been introduced and the code place there. That's because the hostname entry will be moved to a "System" page when time permits. See comment feat(web): allow editing the hostname #2147 (comment) to know more

Screenshots

Not using static hostname	Using static hostname

Related to https://trello.com/c/bDToEZ43 (protected link)

Removed unnecessary spacing and section regions to streamline the form. These elements were redundant in simple pages where there is no need to distinguish between different sections or content.

This change is a step toward having forms display only "required" inputs. While not yet documented in developer guidelines, it has been discussed and agreed that forms should show only required inputs or inputs that will always have a value. Optional fields should be explicitly requested by the user, effectively making them required once displayed. In the registration form, this applies to the email input: if the user does not select "Provide email address," the email input field is neither rendered nor validated. However, if selected, it is displayed and validated accordingly.

The idea is to make it easier for users to set a hostname when registering a product, as the product will be registered with the specified hostname. Instead of adding warnings elsewhere, it’s more helpful to let users set the hostname directly from the registration form too, which will be prefilled with the current hostname value. NOTE: This commit only updates the interface. The logic for setting the hostname is not yet implemented. Tests are intentionally broken to prevent overlooking it.

This commit adds only the basic interface components. Logic for setting the hostname and its options still pending to be implemented.

Alert users that changing the hostname of an already registered product will not update the hostname used during registration.

dgdavid · 2025-03-12T16:20:38Z

After separate discussions with @teclator and @imobachgs, the following changes are planned:

The Enable DHCP option will be removed for now (see Hostname handling #2142 and Hostname handling #2142 (comment))
Removing the above option makes having a dedicated page for setting the hostname a bit overkill.
While the hostname field at registration form could be helpful for users, it might give the false impression it is something that can be updated later. To avoid confusion, it will be replaced with useful information about the hostname being part of the registration and a link to the page where it can be managed.
The hostname could be actually tied to a "System" page, which doesn’t exist yet. We have agree to plan combine the hostname and localization settings (language, keyboard, timezone) into a new "System" page. Additionally, we’re considering merging such a page and the current Overview to make the later really useful. However, this will need careful planning for a future PBI.

Thus, below changes will be performed for considering this PR ready

Add a "Hostname" menu entry that links to a simple hostname page. Such an entry will eventually evolve into the future "System" page.
Replace the hostname input in the registration form with helpful information and a link to previous page.

On the registration page, the hostname input is replaced with an alert to provide helpful information to users about hostname implications during registration, without giving the impression that it can be updated later.

And more unit testing.

The option to enable DHCP hostname is removed since it will not be implemented by now. This commit also includes additional unit tests, which are intentionally broken to serve as a reminder to update them once the actual hooks are implemented.

By adding hte missing pieces for communicating with the server.

coveralls · 2025-03-14T14:59:45Z

Pull Request Test Coverage Report for Build 13856030764

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall first build on hostname-ui at 72.338%

Totals
Change from base Build 13837957018:	72.3%
Covered Lines:	20021
Relevant Lines:	27677

💛 - Coveralls

imobachgs

The code looks good. However, the wording might be improved.

web/src/components/product/ProductRegistrationPage.tsx

web/src/components/system/HostnamePage.tsx

imobachgs · 2025-03-14T21:17:08Z

web/src/components/system/HostnamePage.tsx

Please, FIXIT 😉

I need help for fix it. I do not have an idea of a good text for helping users there. I'm a bit lost with transient and static stuff. So, I hope @teclator (or anyone else) can help me with it.

After a chat with @teclator I realize that actually it was desired to allow the user unset the static hostname too. Thus, the form has changed a bit and this explanation now belongs to a checkbox in which a final sentence has been added. Unless somebody suggest something better.

web/src/components/system/HostnamePage.test.tsx

Co-authored-by: Imobach González Sosa <igonzalezsosa@suse.com>

For using real useHostname hook and display the proper hostname value to users.

Introduces a custom alert at the top of the hostname page to provide users with both the current hostname value and the mode (permanent or temporary). The goal is to ensure users not only know the current hostname but also understand the meaning and implications of each mode, helping them make an informed choice. While there’s room for improvement, further refinements will be addressed in future updates when moving toward a system page. This will help unblock the current work and enable users to set the hostname via the web interface as soon as possible.

dgdavid · 2025-03-17T12:57:40Z

@teclator, re-ready for a review.

@imobachgs ^^^ (just in case this still opens when you are back. Hope it will not).

Override PatternFly styles to ensure that a FormGroup aligns to the start of its flex container instead of stretching to fill all available space by default. https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content#normal

Among others (out of the scope of the feature this commit belongs), storage/EncryptionSettingsPage form no longer requires individual tweaks to prevent fields from stretching to match the widest one.

To make them a bit more bigger.

@teclator

Suggested by @teclator in an "pair-review" session.

teclator

LGTM

bittin · 2025-03-18T05:56:22Z

Swedish translation for this updated

The registration form was updated in PR #2147 to make the email field optional, neither rendering nor validating it unless the user opts to provide an email address. However, the process was failing silently due to the backend complaining about a malformed JSON. > Failed to deserialize the JSON body into the target type: missing > field `email` at line 1 column 16 This commit fixes the issue by sending the email as an empty string when the user chooses not to provide it.

The registration form was updated in PR #2147 to make the email field optional, neither rendering nor validating it unless the user opts to provide an email address. However, the process was failing silently due to the backend complaining about a malformed JSON. > Failed to deserialize the JSON body into the target type: missing > field `email` at line 1 column 16 This PR fixes the issue by sending the email as an empty string when the user chooses not to provide it.

Follow up to #2147 (and #2183) This PR includes few improvements for the hostname page/form. Go commit by commit to know more. Please, add as many changes you want and merge it when it is in a shape you think is acceptable. To see the final result run it locally and test by yourself.

Prepare for releasing Agama 13: - #2041 - #2074 - #2088 - #2089 - #2094 - #2097 - #2098 - #2100 - #2101 - #2104 - #2106 - #2107 - #2108 - #2113 - #2115 - #2116 - #2117 - #2118 - #2120 - #2121 - #2122 - #2123 - #2124 - #2125 - #2126 - #2128 - #2132 - #2135 - #2136 - #2137 - #2139 - #2142 - #2145 - #2146 - #2147 - #2148 - #2151 - #2153 - #2155 - #2156 - #2157 - #2158 - #2159 - #2160 - #2161 - #2163 - #2165 - #2172 - #2174 - #2177 - #2179 - #2180 - #2181 - #2182 - #2183 - #2184 - #2186 - #2187 - #2188 - #2191 - #2192 - #2193 - #2195 - #2197 - #2198 - #2199 - #2200 - #2201 - #2203 - #2204 - #2205 - #2206 - #2207 - #2209 - #2212 - #2213 - #2214 - #2215 - #2216

dgdavid added 5 commits March 11, 2025 13:40

fix(web): simplify registration form layout

b26773c

Removed unnecessary spacing and section regions to streamline the form. These elements were redundant in simple pages where there is no need to distinguish between different sections or content.

feat(web): add form to set hostname and its options

3cc3807

This commit adds only the basic interface components. Logic for setting the hostname and its options still pending to be implemented.

feat(web): warn when editing hostname of registered product

de2c6ff

Alert users that changing the hostname of an already registered product will not update the hostname used during registration.

dgdavid requested a review from teclator March 11, 2025 17:57

dgdavid added 5 commits March 12, 2025 22:53

fix(web): replace hostname input with an alert

7604d6a

On the registration page, the hostname input is replaced with an alert to provide helpful information to users about hostname implications during registration, without giving the impression that it can be updated later.

fix(web): use ts-expect-error instead ts-ignore

76e5f0a

fix(web): registration form internal enhancements

fd074a7

And more unit testing.

feat(web): add menu entry for hostname

6d8ee94

dgdavid changed the title ~~feat(web): allow editing the hostname and its options~~ feat(web): allow editing the hostname Mar 12, 2025

dgdavid added 3 commits March 14, 2025 09:43

Merge branch 'after-release-beta2' into hostname-ui

dbc52ec

feat(web): allow updating the hostname from web interfac3

deff439

By adding hte missing pieces for communicating with the server.

doc(web): add entry to changes file

f04909e

dgdavid marked this pull request as ready for review March 14, 2025 11:56

This comment was marked as outdated.

Sign in to view

Base automatically changed from after-release-beta2 to master March 14, 2025 15:25

This comment was marked as outdated.

Sign in to view

This comment was marked as resolved.

Sign in to view

imobachgs reviewed Mar 14, 2025

View reviewed changes

dgdavid and others added 2 commits March 14, 2025 21:36

fix(web): wording improvements from code review

cb8dda4

Co-authored-by: Imobach González Sosa <igonzalezsosa@suse.com>

fix(web): adapt ProductRegistrationPage

f79e28a

For using real useHostname hook and display the proper hostname value to users.

dgdavid requested a review from imobachgs March 14, 2025 22:06

refactor(web): allow both, set and unset hostname

60738b2

dgdavid added 5 commits March 17, 2025 13:01

fix(web): wording improvements

7197f13

fix(web): prevent PF/FormGroup from filling full width

82a0560

Override PatternFly styles to ensure that a FormGroup aligns to the start of its flex container instead of stretching to fill all available space by default. https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content#normal

fix(web): remove obsolete layout form hacks

b87c1f1

Among others (out of the scope of the feature this commit belongs), storage/EncryptionSettingsPage form no longer requires individual tweaks to prevent fields from stretching to match the widest one.

feat(web): override checkboxes size

1e0d091

To make them a bit more bigger.

fix(web): wording improvements

d946d58

Suggested by @teclator in an "pair-review" session.

teclator approved these changes Mar 17, 2025

View reviewed changes

dgdavid merged commit c7377a8 into master Mar 17, 2025
7 checks passed

dgdavid deleted the hostname-ui branch March 17, 2025 14:00

kobliha mentioned this pull request Mar 18, 2025

Desktop improvement: don't use localhost.localdomain #2169

Open

dgdavid mentioned this pull request Mar 18, 2025

fix(web): allow registering system without providing an email #2172

Merged

mvidner mentioned this pull request Mar 25, 2025

refactor(web): hostname page improvemnts. #2198

Merged

imobachgs mentioned this pull request Mar 27, 2025

Update to release 13 #2217

Merged

dgdavid mentioned this pull request Apr 2, 2025

[bsc#1233162] There is no option to set the hostname #1783

Closed

Conversation

dgdavid commented Mar 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

Tests

Notes

Screenshots

Uh oh!

dgdavid commented Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

coveralls commented Mar 14, 2025

Pull Request Test Coverage Report for Build 13856030764

Details

💛 - Coveralls

Uh oh!

This comment was marked as outdated.

This comment was marked as resolved.

imobachgs left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

imobachgs Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

dgdavid Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

dgdavid Mar 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dgdavid commented Mar 17, 2025

Uh oh!

teclator left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bittin commented Mar 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Comments

dgdavid commented Mar 11, 2025 •

edited

Loading

dgdavid commented Mar 12, 2025 •

edited

Loading