Full-stack: Make "Server url" validation conditions consistent across Fleet, update Web Address form validation and submission logic per Fleet best practices (`frontend/docs/patterns.md`) #27455

jacobshandling · 2025-03-24T16:37:59Z

For #27454

Consider Fleet web URL to be valid if it:

(Front end and back end): uses “https://” or “http://” scheme
and
(Front end) accepts only valid or "localhost" hosts (e.g., "a.b.cc" or "localhost", but not "a.b")
(Back end) accepts any host (e.g., "localhost", "a.b.cc", or even "a.b")

Setup flow UI URL validation:

Org settings UI URL validation:

Server URL validation:

Invalid Fleet server URL in DB error:

Changes file added for user-visible changes in changes/,
Added/updated automated tests
A detailed QA plan exists on the associated ticket (if it isn't there, work with the product group's QA engineer to add it)
Manual QA for all new/changed functionality

frontend/components/forms/RegistrationForm/FleetDetails/helpers.js

server/service/validation_setup.go

…rm is invalid

codecov · 2025-03-24T16:56:57Z

Codecov Report

Attention: Patch coverage is 60.86957% with 9 lines in your changes missing coverage. Please review.

Project coverage is 63.76%. Comparing base (67e5541) to head (96be402).
Report is 49 commits behind head on main.

Files with missing lines	Patch %	Lines
server/service/validation_setup.go	45.45%	3 Missing and 3 partials ⚠️
server/service/appconfig.go	57.14%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #27455      +/-   ##
==========================================
- Coverage   63.78%   63.76%   -0.03%     
==========================================
  Files        1742     1746       +4     
  Lines      165562   165854     +292     
  Branches     4534     4536       +2     
==========================================
+ Hits       105605   105756     +151     
- Misses      51731    51836     +105     
- Partials     8226     8262      +36

Flag	Coverage Δ
backend	`64.57% <50.00%> (-0.03%)`	⬇️
frontend	`54.28% <100.00%> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

…faction

jacobshandling · 2025-03-24T20:31:27Z

Okay, so: PR currently has everywhere on front and backend following the same rules, and validation + submission logic on the Web Address org settings form up-to-date with Fleet's best practices

Before these updates, there were different conditions enforced in different places. The conditions for validation are now, everywhere:

must have “https://” or “http://” scheme with host (e.g. "http://a.b.cc")
OR
Must begin with “localhost” (e.g. "localhost:8080", "http://localhost:8080", "https://localhost:8080" are all okay)

If we want to refine these conditions, we can.

Significantly - this adds the requirement of a valid scheme to the Web Address org settings form, unless the URL begins with "localhost". An alternative is to not require a scheme more generally, and apply that to all 4 places outlined in this PR description. Another alternative is to only require a scheme. This could interfere with any users who have saved Fleet server URLs without schemes, which @sgress454 and I confirmed is, while not a great practice and pretty unlikely, a possible scenario.

server/service/validation_setup.go

sgress454

LGTM, may as well hold off merging until after meeting w/ product later today.

sgress454 · 2025-03-25T18:33:26Z

frontend/components/forms/validators/valid_url/valid_url.ts

+  protocols,
+  allowAnyLocalHost = false,
+}: IValidUrl): boolean => {
+  if (allowAnyLocalHost && url.includes("localhost")) return true;


This still allows "localhost.com" etc., which would then be blocked by the back end. I don't think it's worth the effort to handle that here before we talk to the product team about this though.

- Front and backend validation - Any users with now invalid Fleet server URLs, e.g. "localhost:8080" (no protocol) now get an informative error whenever they try to change another setting

jacobshandling · 2025-03-26T16:17:30Z

frontend/utilities/error_messages.ts

@@ -1,3 +1,3 @@
-const INVALID_SERVER_URL_MESSAGE = `Fleet server URL must use “https” or “http”.`;
+const INVALID_SERVER_URL_MESSAGE = `Fleet server address must be a valid “https” or “http” URL.`;


This is because the frontend actually does validate both the scheme and a valid hostname

changes/27454-validation

frontend/components/forms/validators/valid_url/valid_url.ts

jacobshandling added 4 commits March 24, 2025 09:30

remove Fleet URL validation on settings page

2c04413

remove https validation from the server

880ab3e

remove https URL validation from setup flow

5d91eb3

change file

9044315

jacobshandling requested review from a team as code owners March 24, 2025 16:38

jacobshandling assigned sgress454 Mar 24, 2025

jacobshandling had a problem deploying to Docker Hub March 24, 2025 16:38 — with GitHub Actions Error

sharon-fdm reviewed Mar 24, 2025

View reviewed changes

frontend/components/forms/RegistrationForm/FleetDetails/helpers.js Show resolved Hide resolved

sgress454 reviewed Mar 24, 2025

View reviewed changes

server/service/validation_setup.go Outdated Show resolved Hide resolved

update frontend patterns doc to prevent all form submission when a fo…

883400c

…rm is invalid

jacobshandling had a problem deploying to Docker Hub March 24, 2025 16:43 — with GitHub Actions Error

update FE test

00efbad

jacobshandling temporarily deployed to Docker Hub March 24, 2025 16:49 — with GitHub Actions Inactive

clean up server check

66567e1

jacobshandling temporarily deployed to Docker Hub March 24, 2025 17:31 — with GitHub Actions Inactive

jacobshandling added 5 commits March 24, 2025 10:44

add comments

133ba40

update all 3 validation locations to use the same conditions of satis…

2d12dc4

…faction

disable submit by all means when invalid

48b09b3

improve server validation

bc033b5

Update org settings WebAddress form validation to Fleet-standard

c70141f

jacobshandling temporarily deployed to Docker Hub March 24, 2025 20:20 — with GitHub Actions Inactive

jacobshandling changed the title ~~Full-stack: Remove server url validations~~ Full-stack: Make "Server url" validation conditions consistent across Fleet, update Web Address form validation and submission logic per Fleet best practices (frontend/patterns.md) Mar 24, 2025

jacobshandling marked this pull request as draft March 24, 2025 20:24

jacobshandling requested a review from sgress454 March 24, 2025 20:32

jacobshandling mentioned this pull request Mar 24, 2025

Make Fleet server URL validation consistent across the system #27454

Closed

21 tasks

Tune backend validation

05e0c06

jacobshandling temporarily deployed to Docker Hub March 25, 2025 00:31 — with GitHub Actions Inactive

manually parse URL

7d39817

jacobshandling had a problem deploying to Docker Hub March 25, 2025 17:04 — with GitHub Actions Error

add todo

478820b

jacobshandling temporarily deployed to Docker Hub March 25, 2025 17:06 — with GitHub Actions Inactive

adjust

9b7a2f4

jacobshandling temporarily deployed to Docker Hub March 25, 2025 17:57 — with GitHub Actions Inactive

sgress454 reviewed Mar 25, 2025

View reviewed changes

server/service/validation_setup.go Outdated Show resolved Hide resolved

adjust

30ba820

jacobshandling had a problem deploying to Docker Hub March 25, 2025 18:14 — with GitHub Actions Error

adjust

d9e830f

jacobshandling temporarily deployed to Docker Hub March 25, 2025 18:16 — with GitHub Actions Inactive

sgress454 previously approved these changes Mar 25, 2025

View reviewed changes

jacobshandling added 2 commits March 25, 2025 13:17

update backend validation per finalized specs

7e48d93

Only allow Fleet server URLs with "https://" or "http://"

d5ddf5e

- Front and backend validation - Any users with now invalid Fleet server URLs, e.g. "localhost:8080" (no protocol) now get an informative error whenever they try to change another setting

jacobshandling dismissed sgress454’s stale review via d5ddf5e March 25, 2025 21:20

jacobshandling had a problem deploying to Docker Hub March 25, 2025 21:20 — with GitHub Actions Error

Update frontend error message to reflect actual validation conditions

312e7b2

jacobshandling temporarily deployed to Docker Hub March 25, 2025 21:24 — with GitHub Actions Inactive

jacobshandling requested a review from sgress454 March 25, 2025 21:50

jacobshandling commented Mar 26, 2025

View reviewed changes

sgress454 reviewed Mar 27, 2025

View reviewed changes

changes/27454-validation Outdated Show resolved Hide resolved

sgress454 reviewed Mar 27, 2025

View reviewed changes

frontend/components/forms/validators/valid_url/valid_url.ts Outdated Show resolved Hide resolved

updates

96be402

jacobshandling temporarily deployed to Docker Hub March 27, 2025 20:19 — with GitHub Actions Inactive

jacobshandling requested a review from sgress454 March 27, 2025 20:19

sgress454 approved these changes Mar 27, 2025

View reviewed changes

jacobshandling merged commit 748b5bc into main Mar 27, 2025
38 checks passed

jacobshandling deleted the 27454-remove-server-url-validations branch March 27, 2025 20:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Full-stack: Make "Server url" validation conditions consistent across Fleet, update Web Address form validation and submission logic per Fleet best practices (`frontend/docs/patterns.md`) #27455

Full-stack: Make "Server url" validation conditions consistent across Fleet, update Web Address form validation and submission logic per Fleet best practices (`frontend/docs/patterns.md`) #27455

Uh oh!

jacobshandling commented Mar 24, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Mar 24, 2025 •

edited

Loading

Uh oh!

jacobshandling commented Mar 24, 2025 •

edited

Loading

Uh oh!

Uh oh!

sgress454 left a comment

Uh oh!

sgress454 Mar 25, 2025

Uh oh!

jacobshandling Mar 26, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		@@ -1,3 +1,3 @@
		const INVALID_SERVER_URL_MESSAGE = `Fleet server URL must use “https” or “http”.`;
		const INVALID_SERVER_URL_MESSAGE = `Fleet server address must be a valid “https” or “http” URL.`;

Full-stack: Make "Server url" validation conditions consistent across Fleet, update Web Address form validation and submission logic per Fleet best practices (frontend/docs/patterns.md) #27455

Full-stack: Make "Server url" validation conditions consistent across Fleet, update Web Address form validation and submission logic per Fleet best practices (frontend/docs/patterns.md) #27455

Uh oh!

Conversation

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

Uh oh!

For #27454

Setup flow UI URL validation:

Org settings UI URL validation:

Server URL validation:

Invalid Fleet server URL in DB error:

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

sgress454 left a comment

Choose a reason for hiding this comment

Uh oh!

sgress454 Mar 25, 2025

Choose a reason for hiding this comment

Uh oh!

jacobshandling Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Full-stack: Make "Server url" validation conditions consistent across Fleet, update Web Address form validation and submission logic per Fleet best practices (`frontend/docs/patterns.md`) #27455

Full-stack: Make "Server url" validation conditions consistent across Fleet, update Web Address form validation and submission logic per Fleet best practices (`frontend/docs/patterns.md`) #27455

jacobshandling commented Mar 24, 2025 •

edited

Loading

codecov bot commented Mar 24, 2025 •

edited

Loading

jacobshandling commented Mar 24, 2025 •

edited

Loading