mirror of
https://github.com/discourse/discourse.git
synced 2025-09-07 12:02:53 +08:00
REFACTOR: local dates to improve reliability with DST and recurrence (#9379)
This commit improves testing and separates local-date generation from dates with zone manipulations.
This commit is contained in:
Joffrey JAFFEUX
GitHub
parent
b824898f61
commit
25f95af418
8 changed files with 994 additions and 824 deletions
|
|
@ -0,0 +1,420 @@
|
|||
import LocalDateBuilder from "./local-date-builder";
|
||||
|
||||
const UTC = "Etc/UTC";
|
||||
const SYDNEY = "Australia/Sydney";
|
||||
const LOS_ANGELES = "America/Los_Angeles";
|
||||
const PARIS = "Europe/Paris";
|
||||
const LAGOS = "Africa/Lagos";
|
||||
const LONDON = "Europe/London";
|
||||
|
||||
QUnit.module("lib:local-date-builder");
|
||||
|
||||
const sandbox = sinon.createSandbox();
|
||||
|
||||
function freezeTime({ date, timezone }, cb) {
|
||||
date = date || "2020-01-22 10:34";
|
||||
const newTimezone = timezone || PARIS;
|
||||
const previousZone = moment.tz.guess();
|
||||
const now = moment.tz(date, newTimezone).valueOf();
|
||||
|
||||
sandbox.useFakeTimers(now);
|
||||
sandbox.stub(moment.tz, "guess");
|
||||
moment.tz.guess.returns(newTimezone);
|
||||
moment.tz.setDefault(newTimezone);
|
||||
|
||||
cb();
|
||||
|
||||
moment.tz.guess.returns(previousZone);
|
||||
moment.tz.setDefault(previousZone);
|
||||
sandbox.restore();
|
||||
}
|
||||
|
||||
QUnit.assert.buildsCorrectDate = function(options, expected, message) {
|
||||
const localTimezone = options.localTimezone || PARIS;
|
||||
delete options.localTimezone;
|
||||
|
||||
const localDateBuilder = new LocalDateBuilder(
|
||||
Object.assign(
|
||||
{},
|
||||
{
|
||||
date: "2020-03-22"
|
||||
},
|
||||
options
|
||||
),
|
||||
localTimezone
|
||||
);
|
||||
|
||||
if (expected.formated) {
|
||||
this.test.assert.equal(
|
||||
localDateBuilder.build().formated,
|
||||
expected.formated,
|
||||
message || "it formates the date correctly"
|
||||
);
|
||||
}
|
||||
|
||||
if (expected.previews) {
|
||||
this.test.assert.deepEqual(
|
||||
localDateBuilder.build().previews,
|
||||
expected.previews,
|
||||
message || "it formates the previews correctly"
|
||||
);
|
||||
}
|
||||
};
|
||||
|
||||
QUnit.test("date", assert => {
|
||||
freezeTime({ date: "2020-03-11" }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{ date: "2020-03-22", timezone: PARIS },
|
||||
{ formated: "March 22, 2020" },
|
||||
"it displays the date without time"
|
||||
);
|
||||
|
||||
assert.buildsCorrectDate(
|
||||
{ date: "2020-04-11", time: "11:00" },
|
||||
{ formated: "April 11, 2020 1:00 PM" },
|
||||
"it displays the date with time"
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
QUnit.test("option[format]", assert => {
|
||||
freezeTime({ date: "2020-03-11" }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{ format: "YYYY" },
|
||||
{ formated: "2020" },
|
||||
"it uses custom format"
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
QUnit.test("option[displayedTimezone]", assert => {
|
||||
freezeTime({}, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{ displayedTimezone: SYDNEY },
|
||||
{ formated: "March 22, 2020 (Sydney)" },
|
||||
"it displays the timezone if the timezone is different from the date"
|
||||
);
|
||||
});
|
||||
|
||||
freezeTime({}, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{ displayedTimezone: PARIS, timezone: PARIS },
|
||||
{ formated: "March 22, 2020" },
|
||||
"it doesn't display the timezone if the timezone is the same than the date"
|
||||
);
|
||||
});
|
||||
|
||||
freezeTime({}, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{ timezone: UTC, displayedTimezone: UTC },
|
||||
{ formated: "March 22, 2020 (UTC)" },
|
||||
"it replaces `Etc/`"
|
||||
);
|
||||
});
|
||||
|
||||
freezeTime({}, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{ timezone: LOS_ANGELES, displayedTimezone: LOS_ANGELES },
|
||||
{ formated: "March 22, 2020 (Los Angeles)" },
|
||||
"it removes prefix and replaces `_`"
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
QUnit.test("option[timezone]", assert => {
|
||||
freezeTime({}, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{ timezone: SYDNEY, displayedTimezone: PARIS },
|
||||
{ formated: "March 21, 2020" },
|
||||
"it correctly parses a date with the given timezone context"
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
QUnit.test("option[recurring]", assert => {
|
||||
freezeTime({ date: "2020-04-06 06:00", timezone: LAGOS }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{
|
||||
date: "2019-11-25",
|
||||
time: "11:00",
|
||||
timezone: PARIS,
|
||||
displayedTimezone: LAGOS,
|
||||
recurring: "1.weeks"
|
||||
},
|
||||
{
|
||||
formated: "April 6, 2020 10:00 AM (Lagos)"
|
||||
},
|
||||
"it correctly formats a recurring date starting from a !isDST timezone to a isDST timezone date when displayed to a user using a timezone with no DST"
|
||||
);
|
||||
});
|
||||
|
||||
freezeTime({ date: "2020-04-06 01:00", timezone: SYDNEY }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{
|
||||
date: "2020-03-09",
|
||||
time: "02:00",
|
||||
timezone: UTC,
|
||||
recurring: "1.weeks",
|
||||
calendar: false,
|
||||
displayedTimezone: SYDNEY
|
||||
},
|
||||
{
|
||||
formated: "April 6, 2020 12:00 PM (Sydney)"
|
||||
},
|
||||
"it correctly formats a recurring date spanning over weeks"
|
||||
);
|
||||
});
|
||||
|
||||
freezeTime({ date: "2020-04-07 22:00" }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{
|
||||
date: "2019-11-25",
|
||||
time: "11:00",
|
||||
recurring: "1.weeks",
|
||||
timezone: PARIS
|
||||
},
|
||||
{
|
||||
formated: "April 13, 2020 11:00 AM"
|
||||
},
|
||||
"it correctly adds from a !isDST date to a isDST date"
|
||||
);
|
||||
});
|
||||
|
||||
freezeTime({ date: "2020-04-06 10:59" }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{
|
||||
date: "2020-03-30",
|
||||
time: "11:00",
|
||||
recurring: "1.weeks",
|
||||
timezone: PARIS
|
||||
},
|
||||
{
|
||||
formated: "Today 11:00 AM"
|
||||
},
|
||||
"it works to the minute"
|
||||
);
|
||||
});
|
||||
|
||||
freezeTime({ date: "2020-04-06 11:01" }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{
|
||||
date: "2020-03-30",
|
||||
time: "11:00",
|
||||
recurring: "1.weeks",
|
||||
timezone: PARIS
|
||||
},
|
||||
{
|
||||
formated: "April 13, 2020 11:00 AM"
|
||||
},
|
||||
"it works to the minute"
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
QUnit.test("option[countown]", assert => {
|
||||
freezeTime({ date: "2020-03-21 23:59" }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{
|
||||
countdown: true,
|
||||
timezone: PARIS
|
||||
},
|
||||
{ formated: "a minute" },
|
||||
"it shows the time remaining"
|
||||
);
|
||||
});
|
||||
|
||||
freezeTime({ date: "2020-03-22 00:01" }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{
|
||||
countdown: true,
|
||||
timezone: PARIS
|
||||
},
|
||||
{
|
||||
formated: I18n.t(
|
||||
"discourse_local_dates.relative_dates.countdown.passed"
|
||||
)
|
||||
},
|
||||
"it shows the date has passed"
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
QUnit.test("option[calendar]", assert => {
|
||||
freezeTime({ date: "2020-03-23 23:00" }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{ date: "2020-03-22", time: "23:59", timezone: PARIS },
|
||||
{ formated: "Yesterday 11:59 PM" },
|
||||
"it drops calendar mode when event date is more than one day before current date"
|
||||
);
|
||||
});
|
||||
|
||||
freezeTime({ date: "2020-03-20 23:59" }, () =>
|
||||
assert.buildsCorrectDate(
|
||||
{ date: "2020-03-21", time: "00:00", timezone: PARIS },
|
||||
{ formated: "Tomorrow 12:00 AM" }
|
||||
)
|
||||
);
|
||||
|
||||
freezeTime({ date: "2020-03-20 23:59" }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{ date: "2020-03-21", time: "23:59", timezone: PARIS },
|
||||
{ formated: "Tomorrow 11:59 PM" }
|
||||
);
|
||||
});
|
||||
|
||||
freezeTime({ date: "2020-03-21 00:00" }, () =>
|
||||
assert.buildsCorrectDate(
|
||||
{ date: "2020-03-21", time: "23:00", timezone: PARIS },
|
||||
{ formated: "Today 11:00 PM" }
|
||||
)
|
||||
);
|
||||
|
||||
freezeTime({ date: "2020-03-22 23:59" }, () =>
|
||||
assert.buildsCorrectDate(
|
||||
{ date: "2020-03-21", time: "23:59", timezone: PARIS },
|
||||
{ formated: "Yesterday 11:59 PM" }
|
||||
)
|
||||
);
|
||||
|
||||
freezeTime({ date: "2020-03-22 23:59" }, () =>
|
||||
assert.buildsCorrectDate(
|
||||
{ date: "2020-03-21", time: "23:59", timezone: PARIS },
|
||||
{ formated: "Yesterday 11:59 PM" }
|
||||
)
|
||||
);
|
||||
|
||||
freezeTime({ date: "2020-03-22 23:59" }, () =>
|
||||
assert.buildsCorrectDate(
|
||||
{ calendar: false, date: "2020-03-21", time: "23:59", timezone: PARIS },
|
||||
{ formated: "March 21, 2020 11:59 PM" },
|
||||
"it doesn't use calendar when disabled"
|
||||
)
|
||||
);
|
||||
|
||||
freezeTime({ date: "2020-03-24 01:00" }, () =>
|
||||
assert.buildsCorrectDate(
|
||||
{ date: "2020-03-21", timezone: PARIS },
|
||||
{ formated: "March 21, 2020" },
|
||||
"it stops formating out of calendar range"
|
||||
)
|
||||
);
|
||||
});
|
||||
|
||||
QUnit.test("previews", assert => {
|
||||
freezeTime({ date: "2020-03-22" }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{ timezone: PARIS },
|
||||
{
|
||||
previews: [
|
||||
{
|
||||
current: true,
|
||||
formated: "March 22, 2020 → March 23, 2020",
|
||||
timezone: "Europe/Paris"
|
||||
}
|
||||
]
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
freezeTime({ date: "2020-03-22", timezone: PARIS }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{ timezone: PARIS, timezones: [SYDNEY] },
|
||||
{
|
||||
previews: [
|
||||
{
|
||||
current: true,
|
||||
formated: "March 22, 2020 → March 23, 2020",
|
||||
timezone: "Europe/Paris"
|
||||
},
|
||||
{
|
||||
formated: "March 23, 2020 → March 23, 2020",
|
||||
timezone: "Australia/Sydney"
|
||||
}
|
||||
]
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
freezeTime({ date: "2020-03-22", timezone: PARIS }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{ timezone: PARIS, displayedTimezone: LOS_ANGELES },
|
||||
{
|
||||
previews: [
|
||||
{
|
||||
current: true,
|
||||
formated: "March 22, 2020 → March 23, 2020",
|
||||
timezone: "Europe/Paris"
|
||||
}
|
||||
]
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
freezeTime({ date: "2020-03-22", timezone: PARIS }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{ timezone: PARIS, isplayedTimezone: PARIS },
|
||||
{
|
||||
previews: [
|
||||
{
|
||||
current: true,
|
||||
formated: "March 22, 2020 → March 23, 2020",
|
||||
timezone: "Europe/Paris"
|
||||
}
|
||||
]
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
freezeTime({ date: "2020-03-22", timezone: PARIS }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{ timezone: PARIS, timezones: [PARIS] },
|
||||
{
|
||||
previews: [
|
||||
{
|
||||
current: true,
|
||||
formated: "March 22, 2020 → March 23, 2020",
|
||||
timezone: "Europe/Paris"
|
||||
}
|
||||
]
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
freezeTime({ date: "2020-03-22", timezone: PARIS }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{ time: "11:34", timezone: PARIS, timezones: [PARIS] },
|
||||
{
|
||||
previews: [
|
||||
{
|
||||
current: true,
|
||||
formated: "March 22, 2020 11:34 AM",
|
||||
timezone: "Europe/Paris"
|
||||
}
|
||||
]
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
freezeTime({ date: "2020-04-06", timezone: PARIS }, () => {
|
||||
assert.buildsCorrectDate(
|
||||
{ timezone: PARIS, date: "2020-04-07", timezones: [LONDON, LAGOS] },
|
||||
{
|
||||
previews: [
|
||||
{
|
||||
current: true,
|
||||
formated: "April 7, 2020 → April 8, 2020",
|
||||
timezone: "Europe/Paris"
|
||||
},
|
||||
{
|
||||
formated: "April 7, 2020 → April 7, 2020",
|
||||
timezone: "Europe/London"
|
||||
},
|
||||
{
|
||||
formated: "April 7, 2020 → April 7, 2020",
|
||||
timezone: "Africa/Lagos"
|
||||
}
|
||||
]
|
||||
}
|
||||
);
|
||||
});
|
||||
});
|
||||
Loading…
Add table
Add a link
Reference in a new issue
