fix: Exclude empty strings when listing failure message

ipfs-force-community · Mar 21, 2023 · e4a2b9d · e4a2b9d
1 parent 10c4188
commit e4a2b9d
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 13 deletions.
diff --git a/integration_test/message_test.go b/integration_test/message_test.go
@@ -422,7 +422,7 @@ func testListMessageByAddress(ctx context.Context, t *testing.T, api, apiSign me
 
 func testListFailedMessage(ctx context.Context, t *testing.T, api, apiSign messager.IMessager, addrs []address.Address, blockDelay time.Duration) {
 	msgs := genMessageWithAddress(addrs)
-	for _, msg := range msgs {
+	for i, msg := range msgs {
 		msg.Message.GasLimit = -1
 		id, err := api.PushMessageWithId(ctx, msg.ID, &msg.Message, nil)
 		assert.NoError(t, err)
@@ -431,6 +431,12 @@ func testListFailedMessage(ctx context.Context, t *testing.T, api, apiSign messa
 		res, err := api.GetMessageByUid(ctx, id)
 		assert.NoError(t, err)
 		checkUnsignedMsg(t, &msg.Message, &res.Message)
+
+		if i%3 == 0 {
+			failedMsg, err := api.ListFailedMessage(ctx)
+			assert.NoError(t, err)
+			assert.Len(t, failedMsg, 0)
+		}
 	}
 
 	time.Sleep(blockDelay * 2)

diff --git a/models/mysql/message.go b/models/mysql/message.go
@@ -429,7 +429,7 @@ func (m *mysqlMessageRepo) ListFailedMessage(p *repo.MsgQueryParams) ([]*types.M
 	var sqlMsgs []*mysqlMessage
 	p.State = []types.MessageState{types.UnFillMsg}
 	paramsMap := p.ToMap()
-	err := m.DB.Order("created_at").Where(paramsMap).Find(&sqlMsgs, "error_msg is not null").Error
+	err := m.DB.Order("created_at").Where(paramsMap).Find(&sqlMsgs, "error_msg != ?", "").Error
 	if err != nil {
 		return nil, err
 	}

diff --git a/models/mysql/message_test.go b/models/mysql/message_test.go
@@ -399,17 +399,17 @@ func TestListFailedMessage(t *testing.T) {
 	ids := []string{"msg1", "msg2"}
 
 	t.Run("no param", func(t *testing.T) {
-		mock.ExpectQuery(regexp.QuoteMeta("SELECT * FROM `messages` WHERE `state` = ? AND (error_msg is not null) ORDER BY created_at")).
-			WillReturnRows(sqlmock.NewRows([]string{"id"}).AddRow(ids[0]).AddRow(ids[1]))
+		mock.ExpectQuery(regexp.QuoteMeta("SELECT * FROM `messages` WHERE `state` = ? AND (error_msg != ?) ORDER BY created_at")).
+			WithArgs(types.UnFillMsg, "").WillReturnRows(sqlmock.NewRows([]string{"id"}).AddRow(ids[0]).AddRow(ids[1]))
 
 		res, err := r.MessageRepo().ListFailedMessage(&repo.MsgQueryParams{})
 		assert.NoError(t, err)
 		checkMsgWithIDs(t, res, ids)
 	})
 
 	t.Run("state cover", func(t *testing.T) {
-		mock.ExpectQuery(regexp.QuoteMeta("SELECT * FROM `messages` WHERE `state` = ? AND (error_msg is not null) ORDER BY created_at")).
-			WillReturnRows(sqlmock.NewRows([]string{"id"}).AddRow(ids[0]).AddRow(ids[1]))
+		mock.ExpectQuery(regexp.QuoteMeta("SELECT * FROM `messages` WHERE `state` = ? AND (error_msg != ?) ORDER BY created_at")).
+			WithArgs(types.UnFillMsg, "").WillReturnRows(sqlmock.NewRows([]string{"id"}).AddRow(ids[0]).AddRow(ids[1]))
 
 		res, err := r.MessageRepo().ListFailedMessage(&repo.MsgQueryParams{State: []types.MessageState{types.OnChainMsg}})
 		assert.NoError(t, err)
@@ -418,8 +418,8 @@ func TestListFailedMessage(t *testing.T) {
 
 	t.Run("indicate from", func(t *testing.T) {
 		addr := testutil.AddressProvider()(t)
-		mock.ExpectQuery(regexp.QuoteMeta("SELECT * FROM `messages` WHERE `from_addr` = ? AND `state` = ? AND (error_msg is not null) ORDER BY created_at")).
-			WillReturnRows(sqlmock.NewRows([]string{"id"}).AddRow(ids[0]).AddRow(ids[1]))
+		mock.ExpectQuery(regexp.QuoteMeta("SELECT * FROM `messages` WHERE `from_addr` = ? AND `state` = ? AND (error_msg != ?) ORDER BY created_at")).
+			WithArgs(addr.String(), types.UnFillMsg, "").WillReturnRows(sqlmock.NewRows([]string{"id"}).AddRow(ids[0]).AddRow(ids[1]))
 
 		res, err := r.MessageRepo().ListFailedMessage(&repo.MsgQueryParams{From: []address.Address{addr}})
 		assert.NoError(t, err)

diff --git a/models/sqlite/message.go b/models/sqlite/message.go
@@ -431,7 +431,7 @@ func (m *sqliteMessageRepo) ListFailedMessage(p *repo.MsgQueryParams) ([]*types.
 	var sqlMsgs []*sqliteMessage
 	p.State = []types.MessageState{types.UnFillMsg}
 	paramsMap := p.ToMap()
-	err := m.DB.Order("created_at").Where(paramsMap).Find(&sqlMsgs, "error_msg is not null").Error
+	err := m.DB.Order("created_at").Where(paramsMap).Find(&sqlMsgs, "error_msg != ?", "").Error
 	if err != nil {
 		return nil, err
 	}

diff --git a/models/sqlite/message_test.go b/models/sqlite/message_test.go
@@ -390,12 +390,18 @@ func TestListFailedMessage(t *testing.T) {
 	msgCount := 100
 	failedMsgCount := 0
 	msgs := testhelper.NewMessages(msgCount)
-	for _, msg := range msgs {
-		msg.State = types.MessageState(rand.Intn(7))
+	addrs := make([]address.Address, 0)
+	for i, msg := range msgs {
+		msg.State = types.MessageState(rand.Intn(6))
 		if msg.State == types.UnFillMsg {
-			msg.ErrorMsg = "gas over limit"
-			failedMsgCount++
+			if i%2 == 0 {
+				msg.ErrorMsg = "gas over limit"
+				failedMsgCount++
+
+				addrs = append(addrs, msg.From)
+			}
 		}
+
 		assert.NoError(t, messageRepo.CreateMessage(msg))
 	}
 
@@ -408,6 +414,10 @@ func TestListFailedMessage(t *testing.T) {
 		return msgList[i].CreatedAt.Before(msgList[j].CreatedAt)
 	})
 	assert.True(t, sorted)
+
+	msgList, err = messageRepo.ListFailedMessage(&repo.MsgQueryParams{From: addrs})
+	assert.NoError(t, err)
+	assert.Equal(t, failedMsgCount, len(msgList))
 }
 
 func TestListBlockedMessage(t *testing.T) {