From 3759ccc5224abe7a9ae6b736ff9c64a62479eb00 Mon Sep 17 00:00:00 2001
From: Josh Liburdi <liburdi.joshua@gmail.com>
Date: Tue, 21 May 2024 16:07:45 -0700
Subject: [PATCH] feat(transform): Add Customizable Errors to MetaErr (#174)

* feat(transform): Add Customizable Errors to MetaErr

* test(transform): Add RegExp Test
---
 build/config/substation.libsonnet |  2 +-
 transform/meta_err.go             | 37 ++++++++++++++++++++++++----
 transform/meta_err_test.go        | 40 +++++++++++++++++++++++++++++++
 3 files changed, 73 insertions(+), 6 deletions(-)

diff --git a/build/config/substation.libsonnet b/build/config/substation.libsonnet
index 95a9c189..b2ecb3a9 100644
--- a/build/config/substation.libsonnet
+++ b/build/config/substation.libsonnet
@@ -509,7 +509,7 @@
     },
     meta: {
       err(settings={}): {
-        local default = { transform: null },
+        local default = { transform: null, error_messages: null },
 
         type: 'meta_err',
         settings: std.prune(std.mergePatch(default, $.helpers.abbv(settings))),
diff --git a/transform/meta_err.go b/transform/meta_err.go
index 6dcdae50..6cc7d499 100644
--- a/transform/meta_err.go
+++ b/transform/meta_err.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"regexp"
 
 	"github.com/brexhq/substation/config"
 	iconfig "github.com/brexhq/substation/internal/config"
@@ -14,6 +15,11 @@ import (
 type metaErrConfig struct {
 	// Transform that is applied with error handling.
 	Transform config.Config `json:"transform"`
+	// ErrorMessages are regular expressions that match error messages and determine
+	// if the error should be caught.
+	//
+	// This is optional and defaults to an empty list (all errors are caught).
+	ErrorMessages []string `json:"error_messages"`
 }
 
 func (c *metaErrConfig) Decode(in interface{}) error {
@@ -43,9 +49,20 @@ func newMetaErr(ctx context.Context, cfg config.Config) (*metaErr, error) {
 		return nil, fmt.Errorf("transform: meta_err: %v", err)
 	}
 
+	errMsgs := make([]*regexp.Regexp, len(conf.ErrorMessages))
+	for i, eMsg := range conf.ErrorMessages {
+		r, err := regexp.Compile(eMsg)
+		if err != nil {
+			return nil, fmt.Errorf("transform: meta_err: %v", err)
+		}
+
+		errMsgs[i] = r
+	}
+
 	meta := metaErr{
-		conf: conf,
-		tf:   tf,
+		conf:          conf,
+		tf:            tf,
+		errorMessages: errMsgs,
 	}
 
 	return &meta, nil
@@ -54,14 +71,24 @@ func newMetaErr(ctx context.Context, cfg config.Config) (*metaErr, error) {
 type metaErr struct {
 	conf metaErrConfig
 
-	tf Transformer
+	tf            Transformer
+	errorMessages []*regexp.Regexp
 }
 
 func (tf *metaErr) Transform(ctx context.Context, msg *message.Message) ([]*message.Message, error) {
 	msgs, err := tf.tf.Transform(ctx, msg)
 	if err != nil {
-		//nolint: nilerr // ignore non-nil error
-		return []*message.Message{msg}, nil
+		if len(tf.errorMessages) == 0 {
+			return []*message.Message{msg}, nil
+		}
+
+		for _, e := range tf.errorMessages {
+			if e.MatchString(err.Error()) {
+				return []*message.Message{msg}, nil
+			}
+		}
+
+		return nil, fmt.Errorf("transform: meta_err: %v", err)
 	}
 
 	return msgs, nil
diff --git a/transform/meta_err_test.go b/transform/meta_err_test.go
index ea85bf4b..acb52764 100644
--- a/transform/meta_err_test.go
+++ b/transform/meta_err_test.go
@@ -34,6 +34,46 @@ var metaErrTests = []struct {
 			[]byte(`{"a":"b"}`),
 		},
 	},
+	{
+		"error_messages string",
+		config.Config{
+			Settings: map[string]interface{}{
+				"transform": config.Config{
+					Settings: map[string]interface{}{
+						"message": "test error",
+					},
+					Type: "utility_err",
+				},
+				"error_messages": []string{
+					"test error",
+				},
+			},
+		},
+		[]byte(`{"a":"b"}`),
+		[][]byte{
+			[]byte(`{"a":"b"}`),
+		},
+	},
+	{
+		"error_messages regex",
+		config.Config{
+			Settings: map[string]interface{}{
+				"transform": config.Config{
+					Settings: map[string]interface{}{
+						"message": "test error",
+					},
+					Type: "utility_err",
+				},
+				"error_messages": []string{
+					"^test",
+				},
+			},
+		},
+		[]byte(`{"a":"b"}`),
+		[][]byte{
+			[]byte(`{"a":"b"}`),
+		},
+	},
 }
 
 func TestMetaErr(t *testing.T) {