feat(events): add maintenance events #356

SCedricThomas · 2023-07-28T13:46:38Z

Add a changelog entry

curzolapierre

By looking the event names, I'm wonder, did you succeed to test locally?

There are some changes that need to be done, probably on API side according to the user information, otherwise it should be good.

curzolapierre · 2023-09-12T14:46:35Z

CHANGELOG.md

@@ -2,6 +2,8 @@

 ## To Be Released

+* feat(events): add maintenance events"


Suggested change

* feat(events): add maintenance events"

* feat(events): add maintenance events

curzolapierre · 2023-09-12T14:52:00Z

events_structs.go

+func (ev *EventDatabaseMaintenancePlannedType) String() string {
+	return fmt.Sprintf("A maintenance has been scheduled on the %s addon (Maintenance ID: %s).", ev.TypeData.AddonName, ev.TypeData.MaintenanceID)
+}
+
+func (ev *EventDatabaseMaintenancePlannedType) Who() string {
+	if ev.TypeData.AddonName != "" {
+		return fmt.Sprintf("Addon %s", ev.TypeData.AddonName)
+	}
+	return ev.Event.Who()
+}


From slack discussion I talked more about the following format:

A maintenance (ID 65004006a8acb50076cf9c1b) has been scheduled on the Redis addon. <scalingo-platform (deploy@scalingo.com)>

Two things:

non-blocking: in order to make as small as possible the output, move the "Maintenance ID" right after "maintenance" using only (ID: 123)

blocking: The user is missing here

I updated the message format, but the user is well added here. Just not handled in this file.

curzolapierre · 2023-09-12T14:52:27Z

events_structs.go

+func (ev *EventDatabaseMaintenanceStartedType) String() string {
+	return fmt.Sprintf("A maintenance has started on the %s addon (Maintenance ID: %s).", ev.TypeData.AddonName, ev.TypeData.MaintenanceID)
+}
+
+func (ev *EventDatabaseMaintenanceStartedType) Who() string {
+	if ev.TypeData.AddonName != "" {
+		return fmt.Sprintf("Addon %s", ev.TypeData.AddonName)
+	}
+	return ev.Event.Who()
+}


Same as above

curzolapierre · 2023-09-12T14:52:36Z

events_structs.go

+func (ev *EventDatabaseMaintenanceCompletedType) String() string {
+	return fmt.Sprintf("A maintenance has been completed on the %s addon (Maintenance ID: %s).", ev.TypeData.AddonName, ev.TypeData.MaintenanceID)
+}
+
+func (ev *EventDatabaseMaintenanceCompletedType) Who() string {
+	if ev.TypeData.AddonName != "" {
+		return fmt.Sprintf("Addon %s", ev.TypeData.AddonName)
+	}
+	return ev.Event.Who()
+}


Same as above

Fixed as well

curzolapierre · 2023-09-12T14:55:25Z

events_structs.go

+	EventDatabaseMaintenancePlanned   EventTypeName = "database_maintenance_planned"
+	EventDatabaseMaintenanceStarted   EventTypeName = "database_maintenance_started"
+	EventDatabaseMaintenanceCompleted EventTypeName = "database_maintenance_completed"


These are not the right event names. You can find them from the API event.rake file.

yohann-bacha · 2023-09-14T14:53:14Z

Here is how it looks like in the CLI. There is still the user problem to fix.

curzolapierre

Nice, only need to take in account recent API changes and we'll ready to go 👍

curzolapierre · 2023-09-14T16:11:40Z

events_structs.go

+	AddonName     string `json:"addon_name"`
+	MaintenanceID string `json:"maintenance_id"`


Since the last update of the API we probably want to add all available information,
i.e. adding:

maintenance_type

maintenance_duration

maintenance_duration

curzolapierre · 2023-09-14T16:13:36Z

events_structs.go

+	if ev.TypeData.AddonName != "" {
+		return fmt.Sprintf("Database %s", ev.TypeData.AddonName)
+	}


We want to use the user from the payload. Either remove the condition completely or change the condition to fallback, as you wish.

You didn't take this comment into account

curzolapierre · 2023-09-14T16:13:50Z

events_structs.go

+	AddonName     string `json:"addon_name"`
+	MaintenanceID string `json:"maintenance_id"`


Same as above

curzolapierre · 2023-09-14T16:13:55Z

events_structs.go

+	if ev.TypeData.AddonName != "" {
+		return fmt.Sprintf("Database %s", ev.TypeData.AddonName)
+	}


Same as above

You didn't take this comment into account

Fixed as well

curzolapierre · 2023-09-14T16:13:58Z

events_structs.go

+	AddonName     string `json:"addon_name"`
+	MaintenanceID string `json:"maintenance_id"`


Same as above

curzolapierre · 2023-09-14T16:14:03Z

events_structs.go

+	if ev.TypeData.AddonName != "" {
+		return fmt.Sprintf("Database %s", ev.TypeData.AddonName)
+	}


Same as above

You didn't take this comment into account

curzolapierre

The user is still the addon name. We want to use the one from the payload

curzolapierre · 2023-09-15T11:20:58Z

events_structs.go

+	if ev.TypeData.AddonName != "" {
+		return fmt.Sprintf("Database %s", ev.TypeData.AddonName)
+	}


You didn't take this comment into account

curzolapierre · 2023-09-15T11:21:01Z

events_structs.go

+	if ev.TypeData.AddonName != "" {
+		return fmt.Sprintf("Database %s", ev.TypeData.AddonName)
+	}


You didn't take this comment into account

curzolapierre · 2023-09-15T11:21:05Z

events_structs.go

+	if ev.TypeData.AddonName != "" {
+		return fmt.Sprintf("Database %s", ev.TypeData.AddonName)
+	}


You didn't take this comment into account

yohann-bacha · 2023-09-19T15:00:58Z

Here is a screen shot of the CLI:

curzolapierre

Just a remaining typo and we are good to go

curzolapierre · 2023-09-21T09:18:19Z

events_structs.go

@@ -855,3 +858,69 @@ func (ev *EventStackChangedType) String() string {
 	d := ev.TypeData
 	return fmt.Sprintf("Stack changed from '%s' to %s", d.PreviousStackName, d.CurrentStackName)
 }
+
+// Database maintenance planned
+type EventPlanDatabaseMaintenancedTypeData struct {


Suggested change

type EventPlanDatabaseMaintenancedTypeData struct {

type EventPlanDatabaseMaintenanceTypeData struct {

oh damn you're completely right, fixed

curzolapierre · 2023-09-21T09:18:30Z

events_structs.go

+
+type EventPlanDatabaseMaintenanceType struct {
+	Event
+	TypeData EventPlanDatabaseMaintenancedTypeData `json:"type_data"`


Suggested change

TypeData EventPlanDatabaseMaintenancedTypeData `json:"type_data"`

TypeData EventPlanDatabaseMaintenanceTypeData `json:"type_data"`

same, fixed

feat(event): add event structs

6072885

SCedricThomas self-assigned this Jul 28, 2023

SCedricThomas added 2 commits July 28, 2023 15:49

chore(CHANGELOG): add entry about maintenance events

9b8e3d9

chore: lint

2aeb4f3

curzolapierre assigned curzolapierre and unassigned SCedricThomas Sep 12, 2023

feat(maintenances): right messages for events [STORY-64 STORY-73 STOR…

146fe3d

…Y-74]

yohann-bacha self-assigned this Sep 12, 2023

yohann-bacha requested a review from curzolapierre September 12, 2023 14:43

yohann-bacha marked this pull request as ready for review September 12, 2023 14:43

curzolapierre requested changes Sep 12, 2023

View reviewed changes

fix(maintenance): event names

49ec28c

curzolapierre removed their assignment Sep 12, 2023

yohann-bacha added 3 commits September 13, 2023 09:01

pierre reviews

114d702

fix: unnecessary quote

8dc5ffa

fix: bad boiletplate

7219d49

yohann-bacha requested a review from curzolapierre September 13, 2023 08:12

yohann-bacha marked this pull request as draft September 13, 2023 08:17

yohann-bacha changed the title ~~feat(event): add event structs~~ feat(event): add event structs [STORY64 STORY-73 STORY-74] Sep 13, 2023

yohann-bacha changed the title ~~feat(event): add event structs [STORY64 STORY-73 STORY-74]~~ feat(event): add event structs [STORY-64 STORY-73 STORY-74] Sep 13, 2023

curzolapierre removed their request for review September 13, 2023 16:02

yohann-bacha requested a review from curzolapierre September 14, 2023 14:52

yohann-bacha marked this pull request as ready for review September 14, 2023 14:52

curzolapierre requested changes Sep 14, 2023

View reviewed changes

feat(maintenance): new type data for maintenance related events

ebbc2fa

yohann-bacha requested a review from curzolapierre September 15, 2023 09:44

curzolapierre requested changes Sep 15, 2023

View reviewed changes

fix: database maintenance events user

25a1f4a

yohann-bacha requested a review from curzolapierre September 19, 2023 14:59

curzolapierre requested changes Sep 21, 2023

View reviewed changes

fix: typo in struct name

6ae53f3

yohann-bacha requested a review from curzolapierre September 21, 2023 10:10

Merge branch 'master' into feat/354/maintenance-events

8c9e048

yohann-bacha enabled auto-merge (squash) September 21, 2023 10:12

curzolapierre approved these changes Sep 21, 2023

View reviewed changes

yohann-bacha merged commit ca178da into master Sep 21, 2023
2 checks passed

yohann-bacha deleted the feat/354/maintenance-events branch September 21, 2023 12:28

EtienneM changed the title ~~feat(event): add event structs [STORY-64 STORY-73 STORY-74]~~ feat(events): add maintenance events Sep 21, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(events): add maintenance events #356

feat(events): add maintenance events #356

SCedricThomas commented Jul 28, 2023 •

edited by yohann-bacha

Loading

curzolapierre left a comment

curzolapierre Sep 12, 2023

curzolapierre Sep 12, 2023

yohann-bacha Sep 14, 2023

curzolapierre Sep 12, 2023

yohann-bacha Sep 19, 2023

curzolapierre Sep 12, 2023

yohann-bacha Sep 19, 2023

curzolapierre Sep 12, 2023

yohann-bacha commented Sep 14, 2023

curzolapierre left a comment

curzolapierre Sep 14, 2023

curzolapierre Sep 14, 2023

curzolapierre Sep 15, 2023

yohann-bacha Sep 19, 2023

curzolapierre Sep 14, 2023

curzolapierre Sep 14, 2023

curzolapierre Sep 15, 2023

yohann-bacha Sep 19, 2023

curzolapierre Sep 14, 2023

curzolapierre Sep 14, 2023

curzolapierre Sep 15, 2023

curzolapierre left a comment

curzolapierre Sep 15, 2023

curzolapierre Sep 15, 2023

curzolapierre Sep 15, 2023

yohann-bacha commented Sep 19, 2023

curzolapierre left a comment

curzolapierre Sep 21, 2023

yohann-bacha Sep 21, 2023

curzolapierre Sep 21, 2023

yohann-bacha Sep 21, 2023

		@@ -2,6 +2,8 @@

		## To Be Released

		* feat(events): add maintenance events"

	* feat(events): add maintenance events"
	* feat(events): add maintenance events

		AddonName string `json:"addon_name"`
		MaintenanceID string `json:"maintenance_id"`

	type EventPlanDatabaseMaintenancedTypeData struct {
	type EventPlanDatabaseMaintenanceTypeData struct {

	TypeData EventPlanDatabaseMaintenancedTypeData `json:"type_data"`
	TypeData EventPlanDatabaseMaintenanceTypeData `json:"type_data"`

feat(events): add maintenance events #356

feat(events): add maintenance events #356

Conversation

SCedricThomas commented Jul 28, 2023 • edited by yohann-bacha Loading

curzolapierre left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yohann-bacha commented Sep 14, 2023

curzolapierre left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

curzolapierre left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yohann-bacha commented Sep 19, 2023

curzolapierre left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SCedricThomas commented Jul 28, 2023 •

edited by yohann-bacha

Loading