fix local tz usage in MonthlyPaymentSchedule.CurrentMonth

Author: sotnikov-s

x/revenue/types/payment_schedule.go

@@ -46,7 +46,7 @@ type PaymentScheduleI interface {
 // ends when the month of the block creation is different from the current month of the payment
 // schedule.
 func (s *MonthlyPaymentSchedule) PeriodEnded(ctx sdktypes.Context) bool {
-	return s.currentMonth() != ctx.BlockTime().Month()
+	return s.CurrentMonth() != ctx.BlockTime().Month()
 }
 
 // EffectivePeriodProgress returns the proportion of the current payment period that has elapsed
@@ -55,12 +55,13 @@ func (s *MonthlyPaymentSchedule) PeriodEnded(ctx sdktypes.Context) bool {
 // has fully elapsed from the very beginning to the very end. Otherwise the result equals to the
 // ratio of time passed since the start of the current period to the whole duration of the month.
 func (s *MonthlyPaymentSchedule) EffectivePeriodProgress(ctx sdktypes.Context) math.LegacyDec {
+	t := s.currentMonthStartBlockTime()
 	// source: https://www.brandur.org/fragments/go-days-in-month
 	daysInCurrentMonth := time.Date(
-		ctx.BlockTime().Year(),
-		s.currentMonth()+1,
+		t.Year(),
+		t.Month()+1,
 		0, 0, 0, 0, 0,
-		ctx.BlockTime().Location(),
+		t.Location(),
 	).Day()
 	secondsInCurrentMonth := int64(daysInCurrentMonth * 24 * 60 * 60)
 	secondsPassed := ctx.BlockTime().Unix() - int64(s.CurrentMonthStartBlockTs) //nolint:gosec
@@ -97,8 +98,14 @@ func (s *MonthlyPaymentSchedule) IntoPaymentSchedule() *PaymentSchedule {
 	return &PaymentSchedule{PaymentSchedule: &PaymentSchedule_MonthlyPaymentSchedule{MonthlyPaymentSchedule: s}}
 }
 
-func (s *MonthlyPaymentSchedule) currentMonth() time.Month {
-	return time.Unix(int64(s.CurrentMonthStartBlockTs), 0).Month() //nolint:gosec
+// CurrentMonth returns the time.Month of the current payment period.
+func (s *MonthlyPaymentSchedule) CurrentMonth() time.Month {
+	return s.currentMonthStartBlockTime().Month()
+}
+
+// currentMonthStartBlockTime returns the UTC time.Time of the current month start block.
+func (s *MonthlyPaymentSchedule) currentMonthStartBlockTime() time.Time {
+	return time.Unix(int64(s.CurrentMonthStartBlockTs), 0).UTC() //nolint:gosec
 }
 
 // PeriodEnded checks whether the end of the current payment period has come. The current period

x/revenue/types/payment_schedule_test.go

@@ -97,6 +97,72 @@ func TestMonthlyPaymentSchedule(t *testing.T) {
 		assert.NotEqual(t, math.LegacyOneDec(), s.EffectivePeriodProgress(ctx.WithBlockTime(time.Date(2000, time.Month(startMonth), daysInCurrentMonth, 23, 59, 59, 0, time.UTC))))
 		assert.Equal(t, math.LegacyOneDec(), s.EffectivePeriodProgress(ctx.WithBlockTime(time.Date(2000, time.Month(startMonth)+1, 1, 0, 0, 0, 0, time.UTC))))
 	}
+
+	for _, loc := range []*time.Location{
+		time.FixedZone("BakerIsland", -12*3600),
+		time.FixedZone("AzoresIslands", -1*3600),
+		time.UTC,
+		time.FixedZone("Berlin", 1*3600),
+		time.FixedZone("LineIslands", 14*3600),
+	} {
+		t.Run("TimezoneOperations"+loc.String(), func(t *testing.T) {
+			time.Local = loc // set the timezone for the test
+
+			t.Run("BeginningOfMonth", func(t *testing.T) {
+				// timestamp is in the beginning of the month: 2000-01-01 00:00:01
+				s = &revenuetypes.MonthlyPaymentSchedule{
+					CurrentMonthStartBlockTs: uint64(time.Date(2000, time.January, 1, 0, 0, 0, 0, time.UTC).Unix()), //nolint:gosec
+				}
+
+				// check that the current month is January regardless of the timezone
+				assert.Equal(t, time.January, s.CurrentMonth())
+
+				// make sure period end edge cases result in the same regardless of the timezone
+				assert.Equal(t, false, s.PeriodEnded(ctx.WithBlockTime(time.Date(2000, time.January, 1, 0, 0, 0, 0, time.UTC))))
+				assert.Equal(t, false, s.PeriodEnded(ctx.WithBlockTime(time.Date(2000, time.January, 31, 23, 59, 59, 0, time.UTC))))
+				assert.Equal(t, true, s.PeriodEnded(ctx.WithBlockTime(time.Date(2000, time.February, 1, 0, 0, 1, 0, time.UTC))))
+
+				// make sure effective period progress edge cases result in the same regardless of the timezone
+				assert.Equal(t, math.LegacyZeroDec(), s.EffectivePeriodProgress(ctx.WithBlockTime(time.Date(2000, time.January, 1, 0, 0, 0, 0, time.UTC))))
+				assert.Equal(t, math.LegacyNewDecWithPrec(5, 1), s.EffectivePeriodProgress(ctx.WithBlockTime(time.Date(2000, time.January, 16, 12, 0, 0, 0, time.UTC))))
+				assert.Equal(t, math.LegacyNewDecWithPrec(1344086021505376, 18), s.EffectivePeriodProgress(ctx.WithBlockTime(time.Date(2000, time.January, 1, 1, 0, 0, 0, time.UTC))))
+				assert.Equal(t, math.LegacyNewDecWithPrec(999977598566308244, 18), s.EffectivePeriodProgress(ctx.WithBlockTime(time.Date(2000, time.January, 31, 23, 59, 0, 0, time.UTC))))
+				assert.Equal(t, math.LegacyOneDec(), s.EffectivePeriodProgress(ctx.WithBlockTime(time.Date(2000, time.February, 1, 0, 0, 0, 0, time.UTC))))
+
+				// make sure the next period start timestamp and month are the same regardless of the timezone
+				nextPeriodStartDate := time.Date(2000, time.February, 1, 0, 0, 0, 0, time.UTC)
+				s.StartNewPeriod(ctx.WithBlockTime(nextPeriodStartDate))
+				assert.Equal(t, time.February, s.CurrentMonth())
+				assert.Equal(t, uint64(nextPeriodStartDate.Unix()), s.CurrentMonthStartBlockTs) //nolint:gosec
+			})
+
+			t.Run("EndOfMonth", func(t *testing.T) {
+				// timestamp is in the end of the month: 2000-01-31 23:59:00
+				s = &revenuetypes.MonthlyPaymentSchedule{
+					CurrentMonthStartBlockTs: uint64(time.Date(2000, time.January, 31, 23, 59, 0, 0, time.UTC).Unix()), //nolint:gosec
+				}
+
+				// check that the current month is January regardless of the timezone
+				assert.Equal(t, time.January, s.CurrentMonth())
+
+				// make sure period end edge cases result in the same regardless of the timezone
+				assert.Equal(t, false, s.PeriodEnded(ctx.WithBlockTime(time.Date(2000, time.January, 31, 23, 59, 0, 0, time.UTC))))
+				assert.Equal(t, false, s.PeriodEnded(ctx.WithBlockTime(time.Date(2000, time.January, 31, 23, 59, 59, 0, time.UTC))))
+				assert.Equal(t, true, s.PeriodEnded(ctx.WithBlockTime(time.Date(2000, time.February, 1, 0, 0, 1, 0, time.UTC))))
+
+				// make sure effective period progress edge cases result in the same regardless of the timezone
+				assert.Equal(t, math.LegacyZeroDec(), s.EffectivePeriodProgress(ctx.WithBlockTime(time.Date(2000, time.January, 31, 23, 59, 0, 0, time.UTC))))
+				assert.Equal(t, math.LegacyNewDecWithPrec(22028076463560, 18), s.EffectivePeriodProgress(ctx.WithBlockTime(time.Date(2000, time.January, 31, 23, 59, 59, 0, time.UTC))))
+				assert.Equal(t, math.LegacyNewDecWithPrec(22401433691756, 18), s.EffectivePeriodProgress(ctx.WithBlockTime(time.Date(2000, time.February, 1, 0, 0, 0, 0, time.UTC))))
+
+				// make sure the next period start timestamp and month are the same regardless of the timezone
+				nextPeriodStartDate := time.Date(2000, time.February, 1, 0, 0, 0, 0, time.UTC)
+				s.StartNewPeriod(ctx.WithBlockTime(nextPeriodStartDate))
+				assert.Equal(t, time.February, s.CurrentMonth())
+				assert.Equal(t, uint64(nextPeriodStartDate.Unix()), s.CurrentMonthStartBlockTs) //nolint:gosec
+			})
+		})
+	}
 }
 
 func TestBlockBasedPaymentSchedule(t *testing.T) {