NEOS-1765: update slack hooks to link to neosync resources (#3333)

Author: nickzelei

backend/internal/cmds/mgmt/serve/connect/cmd.go

@@ -524,7 +524,7 @@ func serve(ctx context.Context) error {
 	if cascadelicense.IsValid() {
 		slogger.Debug("enabling account hooks service")
 
-		accountHookOptions := []accounthooks.Option{}
+		accountHookOptions := []accounthooks.Option{accounthooks.WithAppBaseUrl(getAppBaseUrl())}
 		var slackClient ee_slack.Interface
 		if viper.GetBool("SLACK_ACCOUNT_HOOKS_ENABLED") {
 			encryptor, err := sym_encrypt.NewEncryptor(viper.GetString("NEOSYNC_SYM_ENCRYPTION_PASSWORD"))

backend/internal/ee/hooks/accounts/service.go

@@ -47,6 +47,7 @@ type Interface interface {
 type config struct {
 	isSlackEnabled bool
 	slackClient    ee_slack.Interface
+	appBaseUrl     string
 }
 
 type Option func(*config)
@@ -58,6 +59,12 @@ func WithSlackClient(slackClient ee_slack.Interface) Option {
 	}
 }
 
+func WithAppBaseUrl(appBaseUrl string) Option {
+	return func(c *config) {
+		c.appBaseUrl = appBaseUrl
+	}
+}
+
 func New(
 	db *neosyncdb.NeosyncDb,
 	userdataclient userdata.Interface,
@@ -685,7 +692,12 @@ func (s *Service) SendSlackMessage(
 		return nil, fmt.Errorf("unable to unmarshal event: %w", err)
 	}
 
-	blocks := getSlackBlocksByEvent(event, logger)
+	account, err := s.db.Q.GetAccount(ctx, s.db.Db, accountId)
+	if err != nil {
+		return nil, fmt.Errorf("unable to get account: %w", err)
+	}
+
+	blocks := getSlackBlocksByEvent(event, s.cfg.appBaseUrl, account.AccountSlug, logger)
 
 	if len(blocks) == 0 {
 		logger.Warn("received event that generated no slack blocks")
@@ -701,7 +713,19 @@ func (s *Service) SendSlackMessage(
 	return &mgmtv1alpha1.SendSlackMessageResponse{}, nil
 }
 
-func getSlackBlocksByEvent(event *accounthook_events.Event, logger *slog.Logger) []slack.Block {
+func buildJobIdUrlForSlack(appBaseUrl, accountName, jobId string) string {
+	return fmt.Sprintf("<%s/jobs/%s|%s>", buildAccountBaseUrl(appBaseUrl, accountName), jobId, jobId)
+}
+
+func buildJobRunUrlForSlack(appBaseUrl, accountName, jobRunId string) string {
+	return fmt.Sprintf("<%s/runs/%s|%s>", buildAccountBaseUrl(appBaseUrl, accountName), jobRunId, jobRunId)
+}
+
+func buildAccountBaseUrl(appBaseUrl, accountName string) string {
+	return fmt.Sprintf("%s/%s", appBaseUrl, accountName)
+}
+
+func getSlackBlocksByEvent(event *accounthook_events.Event, appBaseUrl, accountName string, logger *slog.Logger) []slack.Block {
 	switch event.Name {
 	case mgmtv1alpha1.AccountHookEvent_ACCOUNT_HOOK_EVENT_JOB_RUN_CREATED:
 		if event.JobRunCreated == nil {
@@ -713,9 +737,9 @@ func getSlackBlocksByEvent(event *accounthook_events.Event, logger *slog.Logger)
 		headerSection := slack.NewHeaderBlock(headerText)
 
 		jobFields := []*slack.TextBlockObject{
-			slack.NewTextBlockObject(slack.MarkdownType, "*Job ID:*\n"+event.JobRunCreated.JobId, false, false),
-			slack.NewTextBlockObject(slack.MarkdownType, "*Job Run ID:*\n"+event.JobRunCreated.JobRunId, false, false),
-			slack.NewTextBlockObject(slack.MarkdownType, "*Started At:*\n<!date^"+fmt.Sprint(event.Timestamp.Unix())+"^{date_short_pretty} at {time}|"+event.Timestamp.Format(time.RFC3339)+">", false, false),
+			slack.NewTextBlockObject(slack.MarkdownType, fmt.Sprintf("*Job ID:*\n%s", buildJobIdUrlForSlack(appBaseUrl, accountName, event.JobRunCreated.JobId)), false, false),
+			slack.NewTextBlockObject(slack.MarkdownType, fmt.Sprintf("*Job Run ID:*\n%s", buildJobRunUrlForSlack(appBaseUrl, accountName, event.JobRunCreated.JobRunId)), false, false),
+			slack.NewTextBlockObject(slack.MarkdownType, fmt.Sprintf("*Started At:*\n<!date^%d^{date_short_pretty} at {time}|%s>", event.Timestamp.Unix(), event.Timestamp.Format(time.RFC3339)), false, false),
 		}
 		fieldsSection := slack.NewSectionBlock(nil, jobFields, nil)
 
@@ -739,9 +763,9 @@ func getSlackBlocksByEvent(event *accounthook_events.Event, logger *slog.Logger)
 		headerSection := slack.NewHeaderBlock(headerText)
 
 		jobFields := []*slack.TextBlockObject{
-			slack.NewTextBlockObject(slack.MarkdownType, "*Job ID:*\n"+event.JobRunFailed.JobId, false, false),
-			slack.NewTextBlockObject(slack.MarkdownType, "*Job Run ID:*\n"+event.JobRunFailed.JobRunId, false, false),
-			slack.NewTextBlockObject(slack.MarkdownType, "*Failed At:*\n<!date^"+fmt.Sprint(event.Timestamp.Unix())+"^{date_short_pretty} at {time}|"+event.Timestamp.Format(time.RFC3339)+">", false, false),
+			slack.NewTextBlockObject(slack.MarkdownType, fmt.Sprintf("*Job ID:*\n%s", buildJobIdUrlForSlack(appBaseUrl, accountName, event.JobRunFailed.JobId)), false, false),
+			slack.NewTextBlockObject(slack.MarkdownType, fmt.Sprintf("*Job Run ID:*\n%s", buildJobRunUrlForSlack(appBaseUrl, accountName, event.JobRunFailed.JobRunId)), false, false),
+			slack.NewTextBlockObject(slack.MarkdownType, fmt.Sprintf("*Failed At:*\n<!date^%d^{date_short_pretty} at {time}|%s>", event.Timestamp.Unix(), event.Timestamp.Format(time.RFC3339)), false, false),
 		}
 		fieldsSection := slack.NewSectionBlock(nil, jobFields, nil)
 
@@ -765,9 +789,9 @@ func getSlackBlocksByEvent(event *accounthook_events.Event, logger *slog.Logger)
 		headerSection := slack.NewHeaderBlock(headerText)
 
 		jobFields := []*slack.TextBlockObject{
-			slack.NewTextBlockObject(slack.MarkdownType, "*Job ID:*\n"+event.JobRunSucceeded.JobId, false, false),
-			slack.NewTextBlockObject(slack.MarkdownType, "*Job Run ID:*\n"+event.JobRunSucceeded.JobRunId, false, false),
-			slack.NewTextBlockObject(slack.MarkdownType, "*Succeeded At:*\n<!date^"+fmt.Sprint(event.Timestamp.Unix())+"^{date_short_pretty} at {time}|"+event.Timestamp.Format(time.RFC3339)+">", false, false),
+			slack.NewTextBlockObject(slack.MarkdownType, fmt.Sprintf("*Job ID:*\n%s", buildJobIdUrlForSlack(appBaseUrl, accountName, event.JobRunSucceeded.JobId)), false, false),
+			slack.NewTextBlockObject(slack.MarkdownType, fmt.Sprintf("*Job Run ID:*\n%s", buildJobRunUrlForSlack(appBaseUrl, accountName, event.JobRunSucceeded.JobRunId)), false, false),
+			slack.NewTextBlockObject(slack.MarkdownType, fmt.Sprintf("*Succeeded At:*\n<!date^%d^{date_short_pretty} at {time}|%s>", event.Timestamp.Unix(), event.Timestamp.Format(time.RFC3339)), false, false),
 		}
 		fieldsSection := slack.NewSectionBlock(nil, jobFields, nil)
 

compose.dev.yml

@@ -52,7 +52,7 @@ services:
       - POSTGRES_PASSWORD=foofar
       - PGUSER=postgres
     healthcheck:
-      test: ["CMD", "pg_isready"]
+      test: ['CMD', 'pg_isready']
       interval: 10s
       timeout: 5s
       retries: 5
@@ -73,6 +73,7 @@ services:
       - HOST=0.0.0.0
       - PORT=8080
       - NUCLEUS_ENV=dev
+      - APP_BASEURL=http://localhost:3000
       - TEMPORAL_URL=temporal:7233
       - DB_AUTO_MIGRATE=true
       - DB_SCHEMA_DIR=/workspace/backend/sql/postgresql/schema

compose.yml

@@ -61,6 +61,7 @@ services:
       - HOST=0.0.0.0
       - PORT=8080
       - NUCLEUS_ENV=dev
+      - APP_BASEURL=http://localhost:3000
       - TEMPORAL_URL=temporal:7233
       - DB_AUTO_MIGRATE=true
       - DB_SCHEMA_DIR=/migrations

worker/pkg/workflows/ee/account_hooks/activities/execute/activity.go

@@ -122,7 +122,7 @@ func executeSlackMessage(
 		Event:         bits,
 	}))
 	if err != nil {
-		return fmt.Errorf("unable to send slack message: %w", err)
+		return fmt.Errorf("unable to send slack message to api: %w", err)
 	}
 	return nil
 }