Determine app health status for plugin architecture

[ffjlabo]

What this PR does:

Added a method to determine application health state.

Why we need it:

In the pipedv0, there is a similar method called DetermineAppHealthStatus, but I don't want to use it to avoid implementation logic based on the kind.

pipecd/pkg/model/application_live_state.go

Lines 62 to 74 in 6734011

	// DetermineAppHealthStatus updates its own health status, which is determined based on its resources status.
	func (s *ApplicationLiveStateSnapshot) DetermineAppHealthStatus() {
	switch s.Kind {
	case ApplicationKind_KUBERNETES:
	s.determineKubernetesAppHealthStatus()
	case ApplicationKind_CLOUDRUN:
	s.determineCloudRunAppHealthStatus()
	case ApplicationKind_ECS:
	s.determineECSAppHealthStatus()
	case ApplicationKind_LAMBDA:
	s.determineLambdaAppHealthStatus()
	}
	}

Which issue(s) this PR fixes:

Part of #5363

Does this PR introduce a user-facing change?:

• How are users affected by this change:
• Is this breaking change:
• How to migrate (if breaking change):

[ffjlabo]

We decided to use UNHEALTHY instead of OTHER in pipedv1

[codecov]

Codecov Report

Attention: Patch coverage is 96.42857% with 1 line in your changes missing coverage. Please review.

Project coverage is 26.14%. Comparing base (f6a472e) to head (a236221).
Report is 3 commits behind head on master.

Files with missing lines	Patch %	Lines
...app/pipedv1/livestatereporter/livestatereporter.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5454      +/-   ##
==========================================
+ Coverage   26.09%   26.14%   +0.05%     
==========================================
  Files         457      457              
  Lines       49081    49107      +26     
==========================================
+ Hits        12808    12841      +33     
+ Misses      35251    35244       -7     
  Partials     1022     1022              

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

[ffjlabo]

lint/web is failed, so will fix it.

[t-kikuc]

[IMO] How about prioritizing UNHEALTHY?

In your code, the app's health status depends on resource order.
(e.g. If an Unknown resource is found earlier than an Unhealthy resource, then it's Unknown)

In the following code,
1. If any Unhealthy is found, then the app is Unhealthy.
2. If no Unhealthy was found and any Unknown is found, then the app is Unknown

Suggested change

	for _, r := range app.Resources {
	if r.HealthStatus == ResourceState_UNHEALTHY {
	s.HealthStatus = ApplicationLiveStateSnapshot_UNHEALTHY
	return
	}
	if r.HealthStatus == ResourceState_UNKNOWN {
	s.HealthStatus = ApplicationLiveStateSnapshot_UNKNOWN
	return
	}
	}
	for _, r := range app.Resources {
	if r.HealthStatus == ResourceState_UNHEALTHY {
	s.HealthStatus = ApplicationLiveStateSnapshot_UNHEALTHY
	return
	}
	}
	for _, r := range app.Resources {
	if r.HealthStatus == ResourceState_UNKNOWN {
	s.HealthStatus = ApplicationLiveStateSnapshot_UNKNOWN
	return
	}
	}

[ffjlabo]

@t-kikuc
Thanks, I agree with it.
Fixed at b723484

[ffjlabo]

Use OtherIcon similar to OTHER's one as the UNHEALTHY icon for now.

This is a fix for lint/web.

[t-kikuc]

Thank you!!

[khanhtc1202]

Suggested change

	func (s *ApplicationLiveStateSnapshot) DetermineApplicationHealthStatus() {
	app := s.ApplicationLiveState
	if app == nil {
	return
	}
	for _, r := range app.Resources {
	if r.HealthStatus == ResourceState_UNHEALTHY {
	s.HealthStatus = ApplicationLiveStateSnapshot_UNHEALTHY
	return
	}
	}
	for _, r := range app.Resources {
	if r.HealthStatus == ResourceState_UNKNOWN {
	s.HealthStatus = ApplicationLiveStateSnapshot_UNKNOWN
	return
	}
	}
	s.HealthStatus = ApplicationLiveStateSnapshot_HEALTHY
	}
	func (s *ApplicationLiveStateSnapshot) DetermineApplicationHealthStatus() {
	app := s.ApplicationLiveState
	if app == nil {
	return
	}
	unhealthy := false
	unknown := false
	for _, r := range app.Resources {
	if r.HealthStatus == ResourceState_UNHEALTHY {
	unhealthy = true
	}
	if r.HealthStatus == ResourceState_UNKNOWN {
	unknown = true
	}
	}
	s.HealthStatus = ApplicationLiveStateSnapshot_HEALTHY
	if unhealthy {
	s.HealthStatus = ApplicationLiveStateSnapshot_UNHEALTHY
	}
	if unknown {
	s.HealthStatus = ApplicationLiveStateSnapshot_UNKNOWN
	}
	}

@ffjlabo @t-kikuc ok, let's me suggest a clear version of what you both trying to do 😄

[khanhtc1202]

Suggested change

	func (s *ApplicationLiveStateSnapshot) DetermineApplicationHealthStatus() {
	app := s.ApplicationLiveState
	if app == nil {
	return
	}
	for _, r := range app.Resources {
	if r.HealthStatus == ResourceState_UNHEALTHY {
	s.HealthStatus = ApplicationLiveStateSnapshot_UNHEALTHY
	return
	}
	}
	for _, r := range app.Resources {
	if r.HealthStatus == ResourceState_UNKNOWN {
	s.HealthStatus = ApplicationLiveStateSnapshot_UNKNOWN
	return
	}
	}
	s.HealthStatus = ApplicationLiveStateSnapshot_HEALTHY
	}
	func (s *ApplicationLiveStateSnapshot) DetermineApplicationHealthStatus() {
	app := s.ApplicationLiveState
	if app == nil {
	return
	}
	s.HealthStatus = ApplicationLiveStateSnapshot_HEALTHY
	for _, r := range app.Resources {
	if r.HealthStatus == ResourceState_UNHEALTHY {
	s.HealthStatus = ApplicationLiveStateSnapshot_UNHEALTHY
	return
	}
	}
	for _, r := range app.Resources {
	if r.HealthStatus == ResourceState_UNKNOWN {
	s.HealthStatus = ApplicationLiveStateSnapshot_UNKNOWN
	return
	}
	}
	}

Or another version at least could be this to avoid miss set health status.

[ffjlabo]

Thanks both @khanhtc1202 @t-kikuc
I fixed it to reduce one for statement.
5aec9a7

[khanhtc1202]

What happen if ApplicationLiveState = nil, not a dummy pointer?

[ffjlabo]

@khanhtc1202
The case is ApplicationLiveStateSnapshot_UNKNOWN as the last of the testcases, similar to the current implementation.

[khanhtc1202]

Thanks for clarify, commented in https://github.com/pipe-cd/pipecd/pull/5454/files#r1898201564

[khanhtc1202]

Suggested change

	if app == nil {
	return
	}
	if app == nil {
	s.HealthStatus = ApplicationLiveStateSnapshot_UNKNOWN
	return
	}

We should trickly assign the UNKNOWN stage here. The current logic looks like if this live state is nill, then the state will be kept "as is", which is unclearly UNKNOWN since UNKOWN is 0 in the enum. We should make it clear to avoid misunderstanding.

[ffjlabo]

FIxed at f3bbedd

[khanhtc1202]

Move this to L169, to make reading scope smaller.

[ffjlabo]

Fixed at 400e581

Fixed at a236221

[ffjlabo]

@khanhtc1202 I fixed them 🙏

[khanhtc1202]

Thank you 👍

[ffjlabo]

@t-kikuc Sorry, plz re-approve 🙏