Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: off-by-one error in cron periods #ntrn-451 #824

Merged
merged 1 commit into from
Feb 21, 2025
Merged

fix: off-by-one error in cron periods #ntrn-451 #824

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion x/cron/keeper/keeper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ func (k *Keeper) scheduleExists(ctx sdk.Context, name string) bool {
}

func (k *Keeper) intervalPassed(ctx sdk.Context, schedule types.Schedule) bool {
return uint64(ctx.BlockHeight()) > (schedule.LastExecuteHeight + schedule.Period) //nolint:gosec
return uint64(ctx.BlockHeight()) >= (schedule.LastExecuteHeight + schedule.Period) //nolint:gosec
}

func (k *Keeper) changeTotalCount(ctx sdk.Context, incrementAmount int32) {
Expand Down
87 changes: 87 additions & 0 deletions x/cron/keeper/keeper_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,93 @@ func TestKeeperExecuteReadySchedules(t *testing.T) {
require.Equal(t, uint64(4), unready2.LastExecuteHeight)
require.Equal(t, uint64(6), ready3.LastExecuteHeight)
require.Equal(t, uint64(7), ready4.LastExecuteHeight)

// reset context to 0 block
ctx = ctx.WithBlockHeight(0)
everyTimeSchedule := types.Schedule{
Name: "every_block",
Period: 1,
Msgs: []types.MsgExecuteContract{
{
Contract: "every_block",
Msg: "every_block",
},
},
LastExecuteHeight: 0,
ExecutionStage: types.ExecutionStage_EXECUTION_STAGE_BEGIN_BLOCKER,
}
err = k.AddSchedule(ctx, everyTimeSchedule.Name, everyTimeSchedule.Period, everyTimeSchedule.Msgs, everyTimeSchedule.ExecutionStage)

s, _ := k.GetSchedule(ctx, "every_block")
require.Equal(t, s.LastExecuteHeight, uint64(0))
require.NoError(t, err)

// expect it to not executed right away

k.ExecuteReadySchedules(ctx, types.ExecutionStage_EXECUTION_STAGE_BEGIN_BLOCKER)
// LastExecuteHeight should still be at 0
s, _ = k.GetSchedule(ctx, "every_block")
require.Equal(t, s.LastExecuteHeight, uint64(0))

ctx = ctx.WithBlockHeight(1)
// expect it to be executed again
wasmMsgServer.EXPECT().ExecuteContract(gomock.Any(), &wasmtypes.MsgExecuteContract{
Sender: testutil.TestOwnerAddress,
Contract: "every_block",
Msg: []byte("every_block"),
Funds: sdk.NewCoins(),
}).Return(&wasmtypes.MsgExecuteContractResponse{}, nil)
k.ExecuteReadySchedules(ctx, types.ExecutionStage_EXECUTION_STAGE_BEGIN_BLOCKER)
// last execute height changed to 1
s, _ = k.GetSchedule(ctx, "every_block")
require.Equal(t, s.LastExecuteHeight, uint64(1))

k.RemoveSchedule(ctx, "every_block")

// test schedule with period 2
ctx = ctx.WithBlockHeight(0)
onceTwoBlocksSchedule := types.Schedule{
Name: "once_in_two",
Period: 2,
Msgs: []types.MsgExecuteContract{
{
Contract: "once_in_two",
Msg: "once_in_two",
},
},
LastExecuteHeight: 0,
ExecutionStage: types.ExecutionStage_EXECUTION_STAGE_BEGIN_BLOCKER,
}
err = k.AddSchedule(ctx, onceTwoBlocksSchedule.Name, onceTwoBlocksSchedule.Period, onceTwoBlocksSchedule.Msgs, onceTwoBlocksSchedule.ExecutionStage)

s, _ = k.GetSchedule(ctx, "once_in_two")
require.Equal(t, s.LastExecuteHeight, uint64(0))
require.NoError(t, err)

// expect it to not executed on 0 and 1 blocks
k.ExecuteReadySchedules(ctx, types.ExecutionStage_EXECUTION_STAGE_BEGIN_BLOCKER)
// LastExecuteHeight should still be at 0
s, _ = k.GetSchedule(ctx, "once_in_two")
require.Equal(t, s.LastExecuteHeight, uint64(0))

ctx = ctx.WithBlockHeight(1)
k.ExecuteReadySchedules(ctx, types.ExecutionStage_EXECUTION_STAGE_BEGIN_BLOCKER)
s, _ = k.GetSchedule(ctx, "once_in_two")
require.Equal(t, s.LastExecuteHeight, uint64(0))

// expect it to be executed on 2 block
ctx = ctx.WithBlockHeight(2)
// expect it to be executed again
wasmMsgServer.EXPECT().ExecuteContract(gomock.Any(), &wasmtypes.MsgExecuteContract{
Sender: testutil.TestOwnerAddress,
Contract: "once_in_two",
Msg: []byte("once_in_two"),
Funds: sdk.NewCoins(),
}).Return(&wasmtypes.MsgExecuteContractResponse{}, nil)
k.ExecuteReadySchedules(ctx, types.ExecutionStage_EXECUTION_STAGE_BEGIN_BLOCKER)
// last execute height changed to 2
s, _ = k.GetSchedule(ctx, "once_in_two")
require.Equal(t, s.LastExecuteHeight, uint64(2))
}

func TestAddSchedule(t *testing.T) {
Expand Down
Loading