Merge pull request #3883 from DanielLeone/fix_base_url_no_longer_working

fix for the base URL server replacement

Author: k8s-ci-robot

backend/cmd/headlamp.go

@@ -126,35 +126,27 @@ func fileExists(filename string) bool {
 	return !info.IsDir()
 }
 
-// copy a file, whilst doing some search/replace on the data.
-func copyReplace(src string, dst string,
-	search []byte, replace []byte,
-	search2 []byte, replace2 []byte,
-) {
-	data, err := os.ReadFile(src)
+func mustReadFile(path string) []byte {
+	data, err := os.ReadFile(path)
 	if err != nil {
 		// Error Reading the file
 		logger.Log(logger.LevelError, nil, err, "reading file")
 		os.Exit(1)
 	}
 
-	data1 := bytes.ReplaceAll(data, search, replace)
-	data2 := bytes.ReplaceAll(data1, search2, replace2)
-	fileMode := 0o600
+	return data
+}
 
-	err = os.WriteFile(dst, data2, fs.FileMode(fileMode))
+func mustWriteFile(path string, data []byte) {
+	err := os.WriteFile(path, data, fs.FileMode(0o600))
 	if err != nil {
 		// Error writing the file
 		logger.Log(logger.LevelError, nil, err, "writing file")
 		os.Exit(1)
 	}
 }
 
-// make sure the base-url is updated in the index.html file.
-func baseURLReplace(staticDir string, baseURL string) {
-	indexBaseURL := path.Join(staticDir, "index.baseUrl.html")
-	index := path.Join(staticDir, "index.html")
-
+func makeBaseURLReplacements(data []byte, baseURL string) []byte {
 	replaceURL := baseURL
 	if baseURL == "" {
 		// We have to do the replace when baseURL == "" because of the case when
@@ -163,20 +155,45 @@ func baseURLReplace(staticDir string, baseURL string) {
 		replaceURL = "/"
 	}
 
-	if !fileExists(indexBaseURL) {
-		copyReplace(index, indexBaseURL, []byte(""), []byte(""), []byte(""), []byte(""))
-	}
+	// Replacement for headlampBaseUrl - matched from the known index.html content
+	data = bytes.ReplaceAll(
+		data,
+		[]byte("headlampBaseUrl = __baseUrl__"),
+		[]byte(fmt.Sprintf("headlampBaseUrl = '%s'", replaceURL)),
+	)
 
-	copyReplace(indexBaseURL,
-		index,
-		[]byte("headlampBaseUrl = './'"),
-		[]byte("headlampBaseUrl = '"+replaceURL+"'"),
-		// Replace any resource that has "./" in it
+	// Replace any resource that has "./" in it
+	data = bytes.ReplaceAll(
+		data,
 		[]byte("./"),
-		[]byte(baseURL+"/"))
+		[]byte(fmt.Sprintf("%s/", baseURL)),
+	)
 
 	// Insert baseURL in css url() imports, they don't have "./" in them
-	copyReplace(index, index, []byte("url("), []byte("url("+baseURL+"/"), []byte(""), []byte(""))
+	data = bytes.ReplaceAll(
+		data,
+		[]byte("url("),
+		[]byte(fmt.Sprintf("url(%s/", baseURL)),
+	)
+
+	return data
+}
+
+// make sure the base-url is updated in the index.html file.
+func baseURLReplace(staticDir string, baseURL string) {
+	indexBaseURL := path.Join(staticDir, "index.baseUrl.html")
+	index := path.Join(staticDir, "index.html")
+
+	// keep a copy of the untouched index.html file as the source for replacements
+	if !fileExists(indexBaseURL) {
+		d := mustReadFile(index)
+		mustWriteFile(indexBaseURL, d)
+	}
+
+	// replace baseURL starting from the original copy, incase we run this multiple times
+	data := mustReadFile(indexBaseURL)
+	output := makeBaseURLReplacements(data, baseURL)
+	mustWriteFile(index, output)
 }
 
 func getOidcCallbackURL(r *http.Request, config *HeadlampConfig) string {

backend/cmd/headlamp_test.go

@@ -769,35 +769,6 @@ func TestFileExists(t *testing.T) {
 		"fileExists() should return false for directory")
 }
 
-func TestCopyReplace(t *testing.T) {
-	// Create temporary source and destination files
-	srcFile, err := os.CreateTemp("", "src_file_*")
-	require.NoError(t, err)
-
-	defer os.Remove(srcFile.Name())
-
-	dstFile, err := os.CreateTemp("", "dst_file_*")
-	require.NoError(t, err)
-
-	defer os.Remove(dstFile.Name())
-
-	// Write test content to source file
-	_, err = srcFile.WriteString("Hello, World! This is a test.")
-	require.NoError(t, err)
-
-	srcFile.Close()
-
-	// Test successful copy and replace
-	copyReplace(srcFile.Name(), dstFile.Name(),
-		[]byte("Hello"), []byte("Hi"),
-		[]byte("test"), []byte("example"))
-
-	dstContent, err := os.ReadFile(dstFile.Name())
-	require.NoError(t, err)
-
-	assert.Equal(t, "Hi, World! This is a example.", string(dstContent), "copyReplace() should correctly replace content")
-}
-
 //nolint:funlen
 func TestBaseURLReplace(t *testing.T) {
 	// Create a temporary directory for testing
@@ -810,7 +781,7 @@ func TestBaseURLReplace(t *testing.T) {
 	indexContent := []byte(`<!DOCTYPE html>
 <html>
 <head>
-    <script>var headlampBaseUrl = './';</script>
+    <script>var headlampBaseUrl = __baseUrl__;</script>
     <link rel="stylesheet" href="./styles.css">
 </head>
 <body>
@@ -874,6 +845,36 @@ func TestBaseURLReplace(t *testing.T) {
 	}
 }
 
+func TestBaseURLReplaceWithCurrentIndexHTMLContentAndRSPackBuild(t *testing.T) {
+	// This is the current contents of index.html given the recent changes to support both rsbuild and webpack
+	// after the front-end is built, one of the BASE_URL variables will have been replaced with string contents
+	// depending on which build system was used. In either case though, if the server knows the base URL,
+	// we want to ensure it is used, so headlampBaseUrl will be forced to the value we want
+	output := makeBaseURLReplacements([]byte(`
+<!DOCTYPE html>
+<html>
+<head>
+    <script>
+        __baseUrl__ = '%BASE_URL%<%= BASE_URL %>'.replace('%BASE_' + 'URL%', '').replace('<' + '%= BASE_URL %>', '');
+        headlampBaseUrl = __baseUrl__;
+    </script>
+</head>
+</html>
+`), "/headlamp")
+
+	assert.Equal(t, string(output), `
+<!DOCTYPE html>
+<html>
+<head>
+    <script>
+        __baseUrl__ = '%BASE_URL%<%= BASE_URL %>'.replace('%BASE_' + 'URL%', '').replace('<' + '%= BASE_URL %>', '');
+        headlampBaseUrl = '/headlamp';
+    </script>
+</head>
+</html>
+`)
+}
+
 func TestGetOidcCallbackURL(t *testing.T) {
 	tests := []struct {
 		name           string

frontend/index.html

@@ -24,7 +24,10 @@
     -->
     <title>Headlamp</title>
     <script>
-      headlampBaseUrl = '%BASE_URL%<%= BASE_URL %>'.replace('%BASE_' + 'URL%', '').replace('<' + '%= BASE_URL %>', '');
+        // handles both webpack and rspack build systems
+        __baseUrl__ = '%BASE_URL%<%= BASE_URL %>'.replace('%BASE_' + 'URL%', '').replace('<' + '%= BASE_URL %>', '');
+        // the syntax of the following line is special - it will be matched and replaced by the server if a base URL is set by the server
+        headlampBaseUrl = __baseUrl__;
     </script>
     <style>
       .splash {

frontend/rsbuild.config.ts

@@ -25,7 +25,7 @@ export default defineConfig({
   html: {
     template: './index.html',
     templateParameters: {
-      BASE_URL: process.env.BASE_URL || './',
+      BASE_URL: process.env.BASE_URL || '/',
     },
   },
   server: {