Split messages if necessary (discord) (#2124)

* Implement and test byte-splitting helper function * Implement discord botuser message splitting * Implement discord webhooks message splitting
2024-05-24 00:14:45 +02:00
parent 0bb521512a
commit 4bf1c0450c
6 changed files with 264 additions and 83 deletions
--- a/bridge/helper/helper_test.go
+++ b/bridge/helper/helper_test.go
@@ -134,3 +134,105 @@ func TestConvertWebPToPNG(t *testing.T) {
 		t.Fail()
 	}
 }
+
+var clippingOrSplittingTestCases = map[string]struct {
+	inputText       string
+	clipSplitLength int
+	clippingMessage string
+	splitMax        int
+	expectedOutput  []string
+}{
+	"Short single-line message, split 3": {
+		inputText:       "short",
+		clipSplitLength: 20,
+		clippingMessage: "?!?!",
+		splitMax:        3,
+		expectedOutput:  []string{"short"},
+	},
+	"Short single-line message, split 1": {
+		inputText:       "short",
+		clipSplitLength: 20,
+		clippingMessage: "?!?!",
+		splitMax:        1,
+		expectedOutput:  []string{"short"},
+	},
+	"Short single-line message, split 0": {
+		// Mainly check that we don't crash.
+		inputText:       "short",
+		clipSplitLength: 20,
+		clippingMessage: "?!?!",
+		splitMax:        0,
+		expectedOutput:  []string{"short"},
+	},
+	"Long single-line message, noclip": {
+		inputText:       "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
+		clipSplitLength: 50,
+		clippingMessage: "?!?!",
+		splitMax:        10,
+		expectedOutput:  []string{
+			"Lorem ipsum dolor sit amet, consectetur adipiscing",
+			" elit, sed do eiusmod tempor incididunt ut labore ",
+			"et dolore magna aliqua.",
+		},
+	},
+	"Long single-line message, noclip tight": {
+		inputText:       "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
+		clipSplitLength: 50,
+		clippingMessage: "?!?!",
+		splitMax:        3,
+		expectedOutput:  []string{
+			"Lorem ipsum dolor sit amet, consectetur adipiscing",
+			" elit, sed do eiusmod tempor incididunt ut labore ",
+			"et dolore magna aliqua.",
+		},
+	},
+	"Long single-line message, clip custom": {
+		inputText:       "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
+		clipSplitLength: 50,
+		clippingMessage: "?!?!",
+		splitMax:        2,
+		expectedOutput:  []string{
+			"Lorem ipsum dolor sit amet, consectetur adipiscing",
+			" elit, sed do eiusmod tempor incididunt ut lab?!?!",
+		},
+	},
+	"Long single-line message, clip built-in": {
+		inputText:       "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
+		clipSplitLength: 50,
+		clippingMessage: "",
+		splitMax:        2,
+		expectedOutput:  []string{
+			"Lorem ipsum dolor sit amet, consectetur adipiscing",
+			" elit, sed do eiusmod tempor inc <clipped message>",
+		},
+	},
+	"Short multi-line message": {
+		inputText:       "I\ncan't\nget\nno\nsatisfaction!",
+		clipSplitLength: 50,
+		clippingMessage: "",
+		splitMax:        2,
+		expectedOutput:  []string{"I\ncan't\nget\nno\nsatisfaction!"},
+	},
+	"Long message containing UTF-8 multi-byte runes": {
+		inputText:       "人人生而自由，在尊嚴和權利上一律平等。 他們都具有理性和良知，應該以兄弟情誼的精神對待彼此。",
+		clipSplitLength: 50,
+		clippingMessage: "",
+		splitMax:        10,
+		expectedOutput:  []string{
+			"人人生而自由，在尊嚴和權利上一律", // Note: only 48 bytes!
+			"平等。 他們都具有理性和良知，應該", // Note: only 49 bytes!
+			"以兄弟情誼的精神對待彼此。",
+		},
+	},
+}
+
+func TestClipOrSplitMessage(t *testing.T) {
+	for testname, testcase := range clippingOrSplittingTestCases {
+		actualOutput := ClipOrSplitMessage(testcase.inputText, testcase.clipSplitLength, testcase.clippingMessage, testcase.splitMax)
+		assert.Equalf(t, testcase.expectedOutput, actualOutput, "'%s' testcase should give expected lines with clipping+splitting.", testname)
+		for _, splitLine := range testcase.expectedOutput {
+			byteLength := len([]byte(splitLine))
+			assert.True(t, byteLength <= testcase.clipSplitLength, "Splitted line '%s' of testcase '%s' should not exceed the maximum byte-length (%d vs. %d).", splitLine, testname, testcase.clipSplitLength, byteLength)
+		}
+	}
+}