Common reorg (#8025)

* Re-organize common folder * fix: Correct paths in tests * fix: move new content to proper folder * chore: Move audio folder to assets * Move sprites to sprites assets directory * Move css sprites to assets directory * Split out readmes for common code and sprites * Move images to assets directory * Move destinatin of shared browserified file * remove unused file * move compiled js to client-old * Fix karma tests * fix: Correct paths for sprites
2025-12-18 07:07:35 +01:00 · 2016-09-16 10:18:07 -05:00
parent d971e673af
commit 81b7eeeb71
5956 changed files with 269 additions and 270 deletions
--- a/website/common/script/cron.js
+++ b/website/common/script/cron.js
@@ -0,0 +1,124 @@
+// TODO what can be moved to /website/server?
+/*
+  ------------------------------------------------------
+  Cron and time / day functions
+  ------------------------------------------------------
+ */
+import _ from 'lodash';
+import moment from 'moment';
+
+export const DAY_MAPPING = {
+  0: 'su',
+  1: 'm',
+  2: 't',
+  3: 'w',
+  4: 'th',
+  5: 'f',
+  6: 's',
+};
+
+/*
+  Each time we perform date maths (cron, task-due-days, etc), we need to consider user preferences.
+  Specifically {dayStart} (custom day start) and {timezoneOffset}. This function sanitizes / defaults those values.
+  {now} is also passed in for various purposes, one example being the test scripts scripts testing different "now" times.
+ */
+
+function sanitizeOptions (o) {
+  let ref = Number(o.dayStart || 0);
+  let dayStart = !_.isNaN(ref) && ref >= 0 && ref <= 24 ? ref : 0;
+
+  let timezoneOffset;
+  let timezoneOffsetDefault = Number(moment().zone());
+  if (_.isFinite(o.timezoneOffsetOverride)) {
+    timezoneOffset = Number(o.timezoneOffsetOverride);
+  } else if (_.isFinite(o.timezoneOffset)) {
+    timezoneOffset = Number(o.timezoneOffset);
+  } else {
+    timezoneOffset = timezoneOffsetDefault;
+  }
+  if (timezoneOffset > 720 || timezoneOffset < -840) {
+    // timezones range from -12 (offset +720) to +14 (offset -840)
+    timezoneOffset = timezoneOffsetDefault;
+  }
+
+  let now = o.now ? moment(o.now).zone(timezoneOffset) : moment().zone(timezoneOffset);
+
+  // return a new object, we don't want to add "now" to user object
+  return {
+    dayStart,
+    timezoneOffset,
+    now,
+  };
+}
+
+export function startOfWeek (options = {}) {
+  let o = sanitizeOptions(options);
+
+  return moment(o.now).startOf('week');
+}
+
+/*
+  This is designed for use with any date that has an important time portion (e.g., when comparing the current date-time with the previous cron's date-time for determing if cron should run now).
+  It changes the time portion of the date-time to be the Custom Day Start hour, so that the date-time is now the user's correct start of day.
+  It SUBTRACTS a day if the date-time's original hour is before CDS (e.g., if your CDS is 5am and it's currently 4am, it's still the previous day).
+  This is NOT suitable for manipulating any dates that are displayed to the user as a date with no time portion, such as a Daily's Start Dates (e.g., a Start Date of today shows only the date, so it should be considered to be today even if the hidden time portion is before CDS).
+ */
+
+export function startOfDay (options = {}) {
+  let o = sanitizeOptions(options);
+  let dayStart = moment(o.now).startOf('day').add({ hours: o.dayStart });
+
+  if (moment(o.now).hour() < o.dayStart) {
+    dayStart.subtract({ days: 1 });
+  }
+  return dayStart;
+}
+
+/*
+  Absolute diff from "yesterday" till now
+ */
+
+export function daysSince (yesterday, options = {}) {
+  let o = sanitizeOptions(options);
+
+  return startOfDay(_.defaults({ now: o.now }, o)).diff(startOfDay(_.defaults({ now: yesterday }, o)), 'days');
+}
+
+/*
+  Should the user do this task on this date, given the task's repeat options and user.preferences.dayStart?
+ */
+
+export function shouldDo (day, dailyTask, options = {}) {
+  if (dailyTask.type !== 'daily') {
+    return false;
+  }
+  let o = sanitizeOptions(options);
+  let startOfDayWithCDSTime = startOfDay(_.defaults({ now: day }, o));
+
+  // The time portion of the Start Date is never visible to or modifiable by the user so we must ignore it.
+  // Therefore, we must also ignore the time portion of the user's day start (startOfDayWithCDSTime), otherwise the date comparison will be wrong for some times.
+  // NB: The user's day start date has already been converted to the PREVIOUS day's date if the time portion was before CDS.
+  let taskStartDate = moment(dailyTask.startDate).zone(o.timezoneOffset);
+
+  taskStartDate = moment(taskStartDate).startOf('day');
+  if (taskStartDate > startOfDayWithCDSTime.startOf('day')) {
+    return false; // Daily starts in the future
+  }
+  if (dailyTask.frequency === 'daily') { // "Every X Days"
+    if (!dailyTask.everyX) {
+      return false; // error condition
+    }
+    let daysSinceTaskStart = startOfDayWithCDSTime.startOf('day').diff(taskStartDate, 'days');
+
+    return daysSinceTaskStart % dailyTask.everyX === 0;
+  } else if (dailyTask.frequency === 'weekly') { // "On Certain Days of the Week"
+    if (!dailyTask.repeat) {
+      return false; // error condition
+    }
+    let dayOfWeekNum = startOfDayWithCDSTime.day(); // e.g., 0 for Sunday
+
+    return dailyTask.repeat[DAY_MAPPING[dayOfWeekNum]];
+  } else {
+    return false; // error condition - unexpected frequency string
+  }
+}