fix: use correct query params for message index endpoint in integration tests

The searchMessages helper was using 'owners' (plural) param and missing 'contact',
but the GET /v1/messages endpoint requires 'owner' (singular) and 'contact' fields.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: AchoArnold

api/go.mod

@@ -33,6 +33,7 @@ require (
 	github.com/jordan-wright/email v4.0.1-0.20210109023952-943e75fe5223+incompatible
 	github.com/jszwec/csvutil v1.10.0
 	github.com/lib/pq v1.12.3
+	github.com/matoous/go-nanoid/v2 v2.1.0
 	github.com/nyaruka/phonenumbers v1.7.2
 	github.com/palantir/stacktrace v0.0.0-20161112013806-78658fd2d177
 	github.com/patrickmn/go-cache v2.1.0+incompatible

api/go.sum

@@ -237,6 +237,8 @@ github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/lib/pq v1.12.3 h1:tTWxr2YLKwIvK90ZXEw8GP7UFHtcbTtty8zsI+YjrfQ=
 github.com/lib/pq v1.12.3/go.mod h1:/p+8NSbOcwzAEI7wiMXFlgydTwcgTr3OSKMsD2BitpA=
+github.com/matoous/go-nanoid/v2 v2.1.0 h1:P64+dmq21hhWdtvZfEAofnvJULaRR1Yib0+PnU669bE=
+github.com/matoous/go-nanoid/v2 v2.1.0/go.mod h1:KlbGNQ+FhrUNIHUxZdL63t7tl4LaPkZNpUULS8H4uVM=
 github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE=
 github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8=
 github.com/mattn/go-isatty v0.0.22 h1:j8l17JJ9i6VGPUFUYoTUKPSgKe/83EYU2zBC7YNKMw4=

api/pkg/entities/bulk_message.go

@@ -4,7 +4,7 @@ import "time"
 
 // BulkMessage represents a summary of a bulk message batch
 type BulkMessage struct {
-	RequestID      string    `json:"request_id" example:"bulk-32343a19-da5e-4b1b-a767-3298a73703cb"`
+	RequestID      string    `json:"request_id" example:"bulk-csv-a1B2c3D4e5"`
 	Total          int64     `json:"total" example:"150"`
 	ScheduledCount int64     `json:"scheduled_count" example:"50"`
 	PendingCount   int64     `json:"pending_count" example:"30"`

api/pkg/handlers/bulk_message_handler.go

@@ -1,18 +1,18 @@
 package handlers
 
 import (
+	"crypto/rand"
 	"fmt"
 	"sync"
 	"sync/atomic"
 
 	"github.com/NdoleStudio/httpsms/pkg/requests"
-	"github.com/google/uuid"
-
 	"github.com/NdoleStudio/httpsms/pkg/services"
 	"github.com/NdoleStudio/httpsms/pkg/telemetry"
 	"github.com/NdoleStudio/httpsms/pkg/validators"
 	"github.com/davecgh/go-spew/spew"
 	"github.com/gofiber/fiber/v2"
+	gonanoid "github.com/matoous/go-nanoid/v2"
 	"github.com/palantir/stacktrace"
 )
 
@@ -99,7 +99,7 @@ func (h *BulkMessageHandler) Store(c *fiber.Ctx) error {
 		return h.responseBadRequest(c, err)
 	}
 
-	messages, validationErrors := h.validator.ValidateStore(ctx, h.userIDFomContext(c), file)
+	messages, fileType, validationErrors := h.validator.ValidateStore(ctx, h.userIDFomContext(c), file)
 	if len(validationErrors) != 0 {
 		msg := fmt.Sprintf("validation errors [%s], while sending bulk sms from CSV file [%s] for [%s]", spew.Sdump(validationErrors), file.Filename, h.userIDFomContext(c))
 		ctxLogger.Warn(stacktrace.NewError(msg))
@@ -111,7 +111,7 @@ func (h *BulkMessageHandler) Store(c *fiber.Ctx) error {
 		return h.responsePaymentRequired(c, *msg)
 	}
 
-	requestID := uuid.New()
+	requestID := h.generateRequestID(fileType, "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz")
 	wg := sync.WaitGroup{}
 	count := atomic.Int64{}
 
@@ -144,3 +144,22 @@ func (h *BulkMessageHandler) Store(c *fiber.Ctx) error {
 	wg.Wait()
 	return h.responseAccepted(c, fmt.Sprintf("Added %d out of %d messages to the queue", count.Load(), len(messages)))
 }
+
+func (h *BulkMessageHandler) generateRequestID(fileType string, alphabet string) string {
+	id, err := gonanoid.Generate(alphabet, 10)
+	if err != nil {
+		id = h.randomAlphaNum(10, alphabet)
+	}
+	return fmt.Sprintf("bulk-%s-%s", fileType, id)
+}
+
+func (h *BulkMessageHandler) randomAlphaNum(length int, alphabet string) string {
+	b := make([]byte, length)
+	if _, err := rand.Read(b); err != nil {
+		return alphabet[:length]
+	}
+	for i := range b {
+		b[i] = alphabet[int(b[i])%len(alphabet)]
+	}
+	return string(b)
+}

api/pkg/requests/bulk_message_request.go

@@ -1,29 +1,28 @@
 package requests
 
 import (
-	"fmt"
 	"strings"
 	"time"
 
 	"github.com/NdoleStudio/httpsms/pkg/entities"
 	"github.com/NdoleStudio/httpsms/pkg/services"
-	"github.com/google/uuid"
 	"github.com/nyaruka/phonenumbers"
 )
 
 // BulkMessage represents a single message in a bulk SMS request
 type BulkMessage struct {
 	request
+	FileType        string `json:"type"`
 	FromPhoneNumber string `csv:"FromPhoneNumber"`
 	ToPhoneNumber   string `csv:"ToPhoneNumber"`
 	Content         string `csv:"Content"`
-	SendTimeRaw     string `csv:"SendTime(optional)"`
+	SendTime        string `csv:"SendTime(optional)"`
 	AttachmentURLs  string `csv:"AttachmentURLs(optional)" validate:"optional"` // Comma separated list of URLs
 }
 
 // GetSendTime parses the raw SendTime string into a *time.Time
 func (input *BulkMessage) GetSendTime() *time.Time {
-	raw := strings.TrimSpace(input.SendTimeRaw)
+	raw := strings.TrimSpace(input.SendTime)
 	if raw == "" {
 		return nil
 	}
@@ -61,13 +60,13 @@ func (input *BulkMessage) Sanitize() *BulkMessage {
 }
 
 // ToMessageSendParams converts BulkMessage to services.MessageSendParams
-func (input *BulkMessage) ToMessageSendParams(userID entities.UserID, requestID uuid.UUID, source string, index int) services.MessageSendParams {
+func (input *BulkMessage) ToMessageSendParams(userID entities.UserID, requestID string, source string, index int) services.MessageSendParams {
 	from, _ := phonenumbers.Parse(input.FromPhoneNumber, phonenumbers.UNKNOWN_REGION)
 
 	return services.MessageSendParams{
 		Source:            source,
 		Owner:             from,
-		RequestID:         input.sanitizeStringPointer(fmt.Sprintf("bulk-%s", requestID.String())),
+		RequestID:         input.sanitizeStringPointer(requestID),
 		UserID:            userID,
 		SendAt:            input.GetSendTime(),
 		RequestReceivedAt: time.Now().UTC(),

api/pkg/validators/bulk_message_handler_validator.go

@@ -52,7 +52,7 @@ func NewBulkMessageHandlerValidator(
 }
 
 // ValidateStore validates the requests.BillingUsageHistory request
-func (v *BulkMessageHandlerValidator) ValidateStore(ctx context.Context, userID entities.UserID, header *multipart.FileHeader) ([]*requests.BulkMessage, url.Values) {
+func (v *BulkMessageHandlerValidator) ValidateStore(ctx context.Context, userID entities.UserID, header *multipart.FileHeader) ([]*requests.BulkMessage, string, url.Values) {
 	ctx, span, ctxLogger := v.tracer.StartWithLogger(ctx, v.logger)
 	defer span.End()
 
@@ -61,22 +61,22 @@ func (v *BulkMessageHandlerValidator) ValidateStore(ctx context.Context, userID
 		result := url.Values{}
 		result.Add("document", "Cannot load your account. Please try again later or contact support.")
 		ctxLogger.Error(v.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, fmt.Sprintf("cannot load user [%s]", userID))))
-		return nil, result
+		return nil, "", result
 	}
 
-	messages, result := v.parseFile(ctxLogger, user, header)
+	messages, fileType, result := v.parseFile(ctxLogger, user, header)
 	if len(result) != 0 {
-		return messages, result
+		return messages, fileType, result
 	}
 
 	if len(messages) == 0 {
 		result.Add("document", "The uploaded file doesn't contain any valid records. Make sure you are using the official httpSMS template.")
-		return messages, result
+		return messages, fileType, result
 	}
 
 	if len(messages) > 1000 {
 		result.Add("document", "The uploaded file must contain less than 1000 records.")
-		return messages, result
+		return messages, fileType, result
 	}
 
 	for index, message := range messages {
@@ -85,30 +85,32 @@ func (v *BulkMessageHandlerValidator) ValidateStore(ctx context.Context, userID
 
 	result = v.validateMessages(ctx, messages)
 	if len(result) != 0 {
-		return messages, result
+		return messages, fileType, result
 	}
 
 	result = v.validateOwners(ctx, userID, messages)
 	if len(result) != 0 {
-		return messages, result
+		return messages, fileType, result
 	}
 
-	return messages, result
+	return messages, fileType, result
 }
 
-func (v *BulkMessageHandlerValidator) parseFile(ctxLogger telemetry.Logger, user *entities.User, header *multipart.FileHeader) ([]*requests.BulkMessage, url.Values) {
+func (v *BulkMessageHandlerValidator) parseFile(ctxLogger telemetry.Logger, user *entities.User, header *multipart.FileHeader) ([]*requests.BulkMessage, string, url.Values) {
 	if header.Header.Get("Content-Type") == "text/csv" || strings.HasSuffix(header.Filename, ".csv") {
-		return v.parseCSV(ctxLogger, user, header)
+		messages, result := v.parseCSV(ctxLogger, user, header)
+		return messages, "csv", result
 	}
 	if header.Header.Get("Content-Type") == "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" || strings.HasSuffix(header.Filename, ".xlsx") {
-		return v.parseXlsx(ctxLogger, user, header)
+		messages, result := v.parseXlsx(ctxLogger, user, header)
+		return messages, "xls", result
 	}
 
 	ctxLogger.Error(stacktrace.NewError(fmt.Sprintf("cannot parse file [%s] for user [%s] with content type [%s]", header.Filename, user.ID, header.Header.Get("Content-Type"))))
 
 	result := url.Values{}
 	result.Add("document", fmt.Sprintf("The file [%s] is not a valid CSV or Excel file.", header.Filename))
-	return nil, result
+	return nil, "", result
 }
 
 func (v *BulkMessageHandlerValidator) parseXlsx(ctxLogger telemetry.Logger, user *entities.User, header *multipart.FileHeader) ([]*requests.BulkMessage, url.Values) {
@@ -158,7 +160,7 @@ func (v *BulkMessageHandlerValidator) parseXlsx(ctxLogger telemetry.Logger, user
 			FromPhoneNumber: strings.TrimSpace(row[0]),
 			ToPhoneNumber:   strings.TrimSpace(row[1]),
 			Content:         row[2],
-			SendTimeRaw:     sendTimeRaw,
+			SendTime:        sendTimeRaw,
 			AttachmentURLs:  attachmentURLs,
 		})
 	}
@@ -266,10 +268,10 @@ func (v *BulkMessageHandlerValidator) validateMessages(_ context.Context, messag
 			result.Add("document", fmt.Sprintf("Row [%d]: The message content must be less than 1024 characters.", index+2))
 		}
 
-		if strings.TrimSpace(message.SendTimeRaw) != "" {
+		if strings.TrimSpace(message.SendTime) != "" {
 			sendTime := message.GetSendTime()
 			if sendTime == nil {
-				result.Add("document", fmt.Sprintf("Row [%d]: The SendTime [%s] is not a valid date format. Use RFC3339 (e.g. 2023-11-11T02:10:01Z) or YYYY-MM-DDTHH:MM:SS.", index+2, message.SendTimeRaw))
+				result.Add("document", fmt.Sprintf("Row [%d]: The SendTime [%s] is not a valid date format. Use RFC3339 (e.g. 2023-11-11T02:10:01Z) or YYYY-MM-DDTHH:MM:SS.", index+2, message.SendTime))
 			} else if sendTime.After(time.Now().Add(420 * time.Hour)) {
 				result.Add("document", fmt.Sprintf("Row [%d]: The SendTime [%s] cannot be more than 20 days (420 hours) in the future.", index+2, sendTime.Format(time.RFC3339)))
 			}

tests/helpers_test.go

@@ -381,10 +381,10 @@ func fetchBulkMessages(ctx context.Context, t *testing.T) []BulkMessageEntry {
 	return result.Data
 }
 
-func searchMessages(ctx context.Context, t *testing.T, query string, owner string) []httpsms.Message {
+func searchMessages(ctx context.Context, t *testing.T, contact string, owner string) []httpsms.Message {
 	t.Helper()
 
-	url := fmt.Sprintf("%s/v1/messages?query=%s&owners=%s&limit=10&skip=0", apiBaseURL, query, owner)
+	url := fmt.Sprintf("%s/v1/messages?contact=%s&owner=%s&limit=20&skip=0", apiBaseURL, contact, owner)
 	req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
 	require.NoError(t, err)
 	req.Header.Set("x-api-key", userAPIKey)

tests/integration_test.go

@@ -409,8 +409,9 @@ func TestBulkSMS_CSV(t *testing.T) {
 	phone := setupPhone(ctx, t, 60)
 
 	// Build CSV content with 1 message
+	contact := randomPhoneNumber()
 	csvContent := fmt.Sprintf("FromPhoneNumber,ToPhoneNumber,Content,SendTime(optional)\n%s,%s,CSV bulk test message,\n",
-		phone.PhoneNumber, randomPhoneNumber())
+		phone.PhoneNumber, contact)
 
 	// Upload CSV
 	statusCode, respBody := uploadBulkFile(ctx, t, "test.csv", []byte(csvContent))
@@ -428,7 +429,7 @@ func TestBulkSMS_CSV(t *testing.T) {
 	time.Sleep(2 * time.Second)
 
 	// Search for the bulk message by owner to get message IDs
-	messages := searchMessages(ctx, t, "", phone.PhoneNumber)
+	messages := searchMessages(ctx, t, contact, phone.PhoneNumber)
 	require.GreaterOrEqual(t, len(messages), 1, "expected at least 1 message for phone %s", phone.PhoneNumber)
 
 	// Find the message with bulk- request_id prefix
@@ -510,8 +511,10 @@ func TestBulkSMS_Excel(t *testing.T) {
 	// Wait for messages to be persisted
 	time.Sleep(2 * time.Second)
 
-	// Search for bulk messages by owner
-	messages := searchMessages(ctx, t, "", phone.PhoneNumber)
+	// Search for bulk messages by owner and each contact
+	messages1 := searchMessages(ctx, t, contact1, phone.PhoneNumber)
+	messages2 := searchMessages(ctx, t, contact2, phone.PhoneNumber)
+	messages := append(messages1, messages2...)
 	require.GreaterOrEqual(t, len(messages), 2, "expected at least 2 messages for phone %s", phone.PhoneNumber)
 
 	// Find messages with bulk- request_id prefix

web/pages/bulk-messages/index.vue

@@ -101,19 +101,19 @@
             <h4 class="text-h4 mb-3">Bulk Message History</h4>
             <p class="text--secondary">
               Your 10 most recent bulk SMS uploads are shown below, including a
-              delivery status breakdown for each batch. Click
-              <code>View</code> to see individual messages on the search page
+              delivery status breakdown for each batch. Click on a row to see
+              individual messages on the search page.
             </p>
             <v-progress-linear
               v-if="loadingHistory"
               indeterminate
               class="mb-4"
             ></v-progress-linear>
-            <v-simple-table>
+            <v-simple-table v-else>
               <template #default>
                 <thead>
                   <tr class="text-uppercase subtitle-2">
-                    <th class="text-left">Name</th>
+                    <th class="text-left">ID</th>
                     <th class="text-center">Created At</th>
                     <th class="text-center">Total</th>
                     <th class="text-center">Pending</th>
@@ -122,13 +122,19 @@
                     <th class="text-center">Delivered</th>
                     <th class="text-center">Failed</th>
                     <th class="text-center">Expired</th>
-                    <th class="text-center">Action</th>
                   </tr>
                 </thead>
                 <tbody>
-                  <tr v-for="order in bulkOrders" :key="order.request_id">
-                    <td class="text-left font-weight-medium">
-                      {{ order.request_id }}
+                  <tr
+                    v-for="order in bulkOrders"
+                    :key="order.request_id"
+                    class="clickable-row"
+                    @click="
+                      $router.push(`/search-messages?query=${order.request_id}`)
+                    "
+                  >
+                    <td class="text-left">
+                      {{ cleanName(order.request_id) }}
                     </td>
                     <td class="text-center">
                       {{ order.created_at | timestamp }}
@@ -140,16 +146,6 @@
                     <td class="text-center">{{ order.delivered_count }}</td>
                     <td class="text-center">{{ order.failed_count }}</td>
                     <td class="text-center">{{ order.expired_count }}</td>
-                    <td class="text-center">
-                      <v-btn
-                        small
-                        color="primary"
-                        :to="`/search-messages?query=${order.request_id}`"
-                      >
-                        <v-icon small left>{{ mdiEye }}</v-icon>
-                        View
-                      </v-btn>
-                    </td>
                   </tr>
                 </tbody>
               </template>
@@ -224,6 +220,15 @@ export default Vue.extend({
     this.fetchBulkOrders()
   },
   methods: {
+    cleanName(requestId: string): string {
+      if (requestId.startsWith('bulk-csv-')) {
+        return requestId.replace(/^bulk-csv-/, '') + '.csv'
+      }
+      if (requestId.startsWith('bulk-xls-')) {
+        return requestId.replace(/^bulk-xls-/, '') + '.xlsx'
+      }
+      return requestId.replace(/^bulk-/, '')
+    },
     fetchBulkOrders() {
       this.loadingHistory = true
       this.$store
@@ -263,3 +268,12 @@ export default Vue.extend({
   },
 })
 </script>
+
+<style scoped>
+.clickable-row {
+  cursor: pointer;
+}
+.clickable-row:hover {
+  background-color: rgba(0, 0, 0, 0.04);
+}
+</style>