Reorder serve function call in run method

[RafsanNeloy]

What type of PR is this?
/kind cleanup

What this PR does / why we need it: The order of initialization was incorrectly starting the HTTP server before setting up the global dashboard configurations. This created a startup race condition where incoming requests could arrive and hit an uninitialized state in the dashboard configuration.

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

[karmada-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign samzong for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[gemini-code-assist]

Summary of Changes

Hello @RafsanNeloy, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request resolves a startup race condition by correcting the order of initialization for the HTTP server and global dashboard configurations. By ensuring that all necessary configurations are established before the server becomes active, it enhances the application's stability and prevents potential issues from uninitialized states during startup.

Highlights

• Initialization Order Fix: Reordered the serve function call to execute after config.InitDashboardConfig within the run method. This change ensures that global dashboard configurations are fully initialized before the HTTP server starts accepting requests, preventing a startup race condition.

Changelog

• cmd/api/app/api.go
  • Reordered the serve function call to execute after config.InitDashboardConfig to ensure proper initialization order.

Activity

• No specific activity has been recorded for this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[RafsanNeloy]

/cc @warjiang

[gemini-code-assist]

Code Review

This pull request correctly identifies and addresses a startup race condition by reordering the initialization sequence. Moving the serve() call to after config.InitDashboardConfig() is a necessary step. However, a more subtle race condition still exists because InitDashboardConfig is asynchronous and doesn't wait for the configuration to be loaded before returning. I've added a detailed comment on how to fully resolve this. Once that's addressed, this will be a solid fix.

[gemini-code-assist]

While moving the serve call after InitDashboardConfig is the correct direction, it doesn't fully resolve the race condition. The InitDashboardConfig function starts an informer to watch for the configuration, but it returns immediately without waiting for the initial configuration to be loaded. This means the server can still start and handle requests before the configuration is available.

To fully fix this, InitDashboardConfig should block until the informer has synced at least once. This can be achieved by waiting for the cache to sync. Since pkg/config/config.go is not part of this PR, a change would be needed there. Here is a suggested implementation:

// in pkg/config/config.go
import (
	"k8s.io/client-go/tools/cache"
	// ... other imports
)

func InitDashboardConfig(k8sClient kubernetes.Interface, stopper <-chan struct{}) {
	factory := informers.NewSharedInformerFactory(k8sClient, 0)
	resource, err := factory.ForResource(configmapGVR)
	if err != nil {
		klog.Fatalf("Failed to create resource: %v", err)
	}
	// ... (event handler setup)

	factory.Start(stopper)

	// Wait for the informer caches to sync
	klog.Info("Waiting for dashboard config cache to sync...")
	if !cache.WaitForCacheSync(stopper, resource.Informer().HasSynced) {
		klog.Fatalf("Failed to sync cache for configmap")
	}
	klog.Info("Dashboard config cache synced")
}

Without this change, the application is still susceptible to a startup race condition.

[warjiang]

@RafsanNeloy any ideas ? re-order the code seems reasonable. Maybe we solve the problem or open another PR ?

[warjiang]

/assign