feat(web): initial work to setup root handler in the web component #2192

JGAntunes · 2025-05-27T11:23:36Z

What this PR does / why we need it:

Story: https://app.shortcut.com/replicated/story/124147/setup-template-enabled-web-handlers

The idea is to setup a root handler that we can template our initial HTML we serve with any needed state we need before rendering the app.

We should follow up with a way we can redirect requests to the vite dev server when running local dev for faster dev feedback loop.

Which issue(s) this PR fixes:

Does this PR require a test?

Does this PR require a release note?

Does this PR require documentation?

The base branch was changed.

JGAntunes · 2025-05-28T09:44:02Z

api/api.go

@@ -124,7 +124,6 @@ func (a *API) RegisterRoutes(router *mux.Router) {
 	router.PathPrefix("/swagger/").Handler(httpSwagger.WrapHandler)

 	router.HandleFunc("/auth/login", a.postAuthLogin).Methods("POST")
-	router.HandleFunc("/branding", a.getBranding).Methods("GET")


We no longer need the branding routes.

JGAntunes · 2025-05-28T13:38:57Z

#2201 should address the CI failures. It's probably better than creating a placeholder index.html file in the dist folder.

github-actions · 2025-05-28T16:19:07Z

This PR has been released (on staging) and is available for download with a embedded-cluster-smoke-test-staging-app license ID.

Online Installer:

curl "https://staging.replicated.app/embedded/embedded-cluster-smoke-test-staging-app/ci/appver-dev-5553e91" -H "Authorization: $EC_SMOKE_TEST_LICENSE_ID" -o embedded-cluster-smoke-test-staging-app-ci.tgz

Airgap Installer (may take a few minutes before the airgap bundle is built):

curl "https://staging.replicated.app/embedded/embedded-cluster-smoke-test-staging-app/ci-airgap/appver-dev-5553e91?airgap=true" -H "Authorization: $EC_SMOKE_TEST_LICENSE_ID" -o embedded-cluster-smoke-test-staging-app-ci.tgz

Happy debugging!

JGAntunes · 2025-05-28T17:54:01Z

cmd/installer/cli/install_test.go

@@ -581,7 +581,7 @@ func Test_runInstallAPI(t *testing.T) {
 		},
 	}
 	resp, err := httpClient.Get(url)
-	assert.NoError(t, err)
+	require.NoError(t, err)


Later it would panic leading to a red herring because there's no resp.

JGAntunes · 2025-05-29T09:39:21Z

api/types/errors_test.go

@@ -224,94 +223,3 @@ func TestAPIError_ErrorOrNil(t *testing.T) {
 		})
 	}
 }
-
-func TestAPIError_JSON(t *testing.T) {


Some mismatch between PRs that have been merged, this fixes some go vet issues:

https://github.com/replicatedhq/embedded-cluster/actions/runs/15310279418/job/43073071050#step:4:176

JGAntunes · 2025-05-29T09:39:47Z

Makefile

-		go test -tags $(GO_BUILD_TAGS) -v ./pkg/... ./cmd/...
+		go test -tags $(GO_BUILD_TAGS) -v ./pkg/... ./cmd/... ./api/... ./web/... ./pkg-new/...
 	$(MAKE) -C operator test


We haven't been running the full unit test suite in CI.

JGAntunes · 2025-05-29T09:40:27Z

cmd/installer/cli/install.go

+// webAssetsFS is the filesystem to be used by the web component. Defaults to nil allowing the web server to use the default assets embedded in the binary. Useful for testing.
+var webAssetsFS fs.FS = nil


Not particularly happy about this, unsure if we should keep this somewhere else, open to ideas.

Rather than that README.md hack could you have a stub index.html?

The main issue with that is when building the web assets, index.html will change and it's not gitignored so you'll end up with changes that shouldn't be staged for commit.

emosbaugh · 2025-05-29T13:36:36Z

cmd/installer/cli/install.go

+// webAssetsFS is the filesystem to be used by the web component. Defaults to nil allowing the web server to use the default assets embedded in the binary. Useful for testing.
+var webAssetsFS fs.FS = nil


Rather than that README.md hack could you have a stub index.html?

sgalsaleh · 2025-05-29T14:07:39Z

cmd/installer/cli/install_test.go

@@ -560,6 +561,29 @@ func Test_runInstallAPI(t *testing.T) {
 	certPool := x509.NewCertPool()
 	certPool.AddCert(cert.Leaf)

+	// We need a release object to pass over to the Web component.
+	dataMap := map[string][]byte{
+		"kots-app.yaml": []byte(`


should probably include an icon and a title

we can, albeit it's not really being used right now. Unless we also want to run some requests within this test against the web components?

sgalsaleh · 2025-05-29T16:45:14Z

Merging as the changes aren't related to the flaky e2e tests.

sgalsaleh force-pushed the salah/sc-123874/steelthread-configure-data-dir-in-the-new branch 2 times, most recently from ec30def to 50ef28e Compare May 27, 2025 14:49

JGAntunes force-pushed the feat/setup-root-handler branch from d0e9711 to 8ec8727 Compare May 27, 2025 16:36

sgalsaleh previously approved these changes May 27, 2025

View reviewed changes

Base automatically changed from salah/sc-123874/steelthread-configure-data-dir-in-the-new to main May 27, 2025 18:35

JGAntunes self-assigned this May 28, 2025

JGAntunes requested a review from sgalsaleh May 28, 2025 09:30

JGAntunes added type::feature type::chore and removed type::feature labels May 28, 2025

JGAntunes force-pushed the feat/setup-root-handler branch from 8ec8727 to d905503 Compare May 28, 2025 09:31

JGAntunes marked this pull request as ready for review May 28, 2025 09:32

JGAntunes commented May 28, 2025

View reviewed changes

JGAntunes added 9 commits May 28, 2025 17:06

feat(web): initial work to setup root handler

b891d92

chore: rework how we expose the web routes

5fa7eb6

fix: paths

edce3c0

chore: cleanup of unused logic

cd42d23

chore: add tests

e5314fb

chore: add removed web/dist/README.md by mistake

e3baabd

chore: s/README.md/.gitkeep

6c80056

chore: turns hidden files aren't cool for embedding

5c7fa49

chore: missed gofmt for wtv reason

bd6de36

JGAntunes force-pushed the feat/setup-root-handler branch from e931fe4 to bd6de36 Compare May 28, 2025 16:06

chore: refactor web a bit

bc5bf63

JGAntunes commented May 28, 2025

View reviewed changes

JGAntunes added 2 commits May 29, 2025 10:26

chore: allow overriding the web's fs

e44d3fd

chore: actually run all of the unit tests

5553e91

JGAntunes commented May 29, 2025

View reviewed changes

JGAntunes requested a review from emosbaugh May 29, 2025 09:42

JGAntunes mentioned this pull request May 29, 2025

chore: add tests to the console API #2204

Merged

JGAntunes changed the title ~~feat(web): initial work to setup root handler~~ feat(web): initial work to setup root handler in the web component May 29, 2025

emosbaugh requested changes May 29, 2025

View reviewed changes

sgalsaleh reviewed May 29, 2025

View reviewed changes

sgalsaleh approved these changes May 29, 2025

View reviewed changes

emosbaugh approved these changes May 29, 2025

View reviewed changes

sgalsaleh merged commit 8967af3 into main May 29, 2025
55 of 65 checks passed

sgalsaleh deleted the feat/setup-root-handler branch May 29, 2025 16:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(web): initial work to setup root handler in the web component #2192

feat(web): initial work to setup root handler in the web component #2192

Uh oh!

JGAntunes commented May 27, 2025 •

edited

Loading

Uh oh!

JGAntunes May 28, 2025

Uh oh!

JGAntunes commented May 28, 2025

Uh oh!

github-actions bot commented May 28, 2025 •

edited

Loading

Uh oh!

JGAntunes May 28, 2025

Uh oh!

JGAntunes May 29, 2025

Uh oh!

JGAntunes May 29, 2025

Uh oh!

JGAntunes May 29, 2025

Uh oh!

emosbaugh May 29, 2025

Uh oh!

JGAntunes May 29, 2025

Uh oh!

emosbaugh May 29, 2025

Uh oh!

sgalsaleh May 29, 2025

Uh oh!

JGAntunes May 29, 2025

Uh oh!

sgalsaleh commented May 29, 2025

Uh oh!

Uh oh!

Uh oh!

		// webAssetsFS is the filesystem to be used by the web component. Defaults to nil allowing the web server to use the default assets embedded in the binary. Useful for testing.
		var webAssetsFS fs.FS = nil

feat(web): initial work to setup root handler in the web component #2192

feat(web): initial work to setup root handler in the web component #2192

Uh oh!

Conversation

JGAntunes commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does / why we need it:

Which issue(s) this PR fixes:

Does this PR require a test?

Does this PR require a release note?

Does this PR require documentation?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JGAntunes commented May 28, 2025

Uh oh!

github-actions bot commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sgalsaleh commented May 29, 2025

Uh oh!

Uh oh!

Uh oh!

JGAntunes commented May 27, 2025 •

edited

Loading

github-actions bot commented May 28, 2025 •

edited

Loading