Add support for rules per day

src/action/updatetimelimitrule.ts

@@ -31,10 +31,12 @@ export class UpdateTimelimitRuleAction extends ParentAction {
   readonly end: number
   readonly sessionDurationMilliseconds: number
   readonly sessionPauseMilliseconds: number
+  readonly perDay: boolean
 
   constructor ({
     ruleId, maximumTimeInMillis, dayMask, applyToExtraTimeUsage,
-    start, end, sessionDurationMilliseconds, sessionPauseMilliseconds
+    start, end, sessionDurationMilliseconds, sessionPauseMilliseconds,
+    perDay
   }: {
     ruleId: string
     maximumTimeInMillis: number
@@ -44,6 +46,7 @@ export class UpdateTimelimitRuleAction extends ParentAction {
     end: number
     sessionDurationMilliseconds: number
     sessionPauseMilliseconds: number
+    perDay: boolean
   }) {
     super()
 
@@ -55,6 +58,7 @@ export class UpdateTimelimitRuleAction extends ParentAction {
     this.end = end
     this.sessionDurationMilliseconds = sessionDurationMilliseconds
     this.sessionPauseMilliseconds = sessionPauseMilliseconds
+    this.perDay = perDay
 
     assertIdWithinFamily({ actionType, field: 'ruleId', value: ruleId })
 
@@ -90,7 +94,7 @@ export class UpdateTimelimitRuleAction extends ParentAction {
     }
   }
 
-  static parse = ({ ruleId, time, days, extraTime, start, end, dur, pause }: SerializedUpdateTimelimitRuleAction) => (
+  static parse = ({ ruleId, time, days, extraTime, start, end, dur, pause, perDay }: SerializedUpdateTimelimitRuleAction) => (
     new UpdateTimelimitRuleAction({
       ruleId,
       maximumTimeInMillis: time,
@@ -99,7 +103,8 @@ export class UpdateTimelimitRuleAction extends ParentAction {
       start: start ?? MinuteOfDay.MIN,
       end: end ?? MinuteOfDay.MAX,
       sessionDurationMilliseconds: dur ?? 0,
-      sessionPauseMilliseconds: pause ?? 0
+      sessionPauseMilliseconds: pause ?? 0,
+      perDay: perDay ?? false
     })
   )
 }
@@ -114,4 +119,5 @@ export interface SerializedUpdateTimelimitRuleAction {
   end?: number
   dur?: number
   pause?: number
+  perDay?: boolean
 }

src/api/validator.ts

@@ -330,6 +330,9 @@ const definitions = {
       },
       "pause": {
         "type": "number"
+      },
+      "perDay": {
+        "type": "boolean"
       }
     },
     "additionalProperties": false,
@@ -1300,6 +1303,9 @@ const definitions = {
       },
       "pause": {
         "type": "number"
+      },
+      "perDay": {
+        "type": "boolean"
       }
     },
     "additionalProperties": false,
@@ -2267,6 +2273,9 @@ const definitions = {
       },
       "pause": {
         "type": "number"
+      },
+      "perDay": {
+        "type": "boolean"
       }
     },
     "additionalProperties": false,
@@ -2277,6 +2286,7 @@ const definitions = {
       "id",
       "maxTime",
       "pause",
+      "perDay",
       "session",
       "start"
     ]

src/database/migration/migrations/20201123-add-per-day-rules.ts

@@ -0,0 +1,38 @@
+/*
+ * server component for the TimeLimit App
+ * Copyright (C) 2019 - 2020 Jonas Lochmann
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, version 3 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+import { QueryInterface, Sequelize, Transaction } from 'sequelize'
+import { attributesVersion3 as ruleAttributes } from '../../timelimitrule'
+
+export async function up (queryInterface: QueryInterface, sequelize: Sequelize) {
+  await sequelize.transaction({
+    type: Transaction.TYPES.EXCLUSIVE
+  }, async (transaction) => {
+    // timelimit rule table
+    await queryInterface.addColumn('TimelimitRules', 'perDay', {
+      ...ruleAttributes.perDay
+    }, { transaction })
+  })
+}
+
+export async function down (queryInterface: QueryInterface, sequelize: Sequelize) {
+  await sequelize.transaction({
+    type: Transaction.TYPES.EXCLUSIVE
+  }, async (transaction) => {
+    await queryInterface.removeColumn('TimelimitRules', 'perDay', { transaction })
+  })
+}

src/database/timelimitrule.ts

@@ -37,7 +37,12 @@ interface TimelimitRuleAttributesVersion2 {
   sessionPauseMilliseconds: number
 }
 
-type TimelimitRuleAttributes = TimelimitRuleAttributesVersion1 & TimelimitRuleAttributesVersion2
+interface TimelimitRuleAttributesVersion3 {
+  perDay: number
+}
+
+type TimelimitRuleAttributes = TimelimitRuleAttributesVersion1 &
+  TimelimitRuleAttributesVersion2 & TimelimitRuleAttributesVersion3
 
 export type TimelimitRuleModel = Sequelize.Model & TimelimitRuleAttributes
 export type TimelimitRuleModelStatic = typeof Sequelize.Model & {
@@ -120,9 +125,22 @@ export const attributesVersion2: SequelizeAttributes<TimelimitRuleAttributesVers
   }
 }
 
+export const attributesVersion3: SequelizeAttributes<TimelimitRuleAttributesVersion3> = {
+  perDay: {
+    type: Sequelize.INTEGER,
+    validate: {
+      min: 0,
+      max: 1
+    },
+    allowNull: false,
+    defaultValue: 0
+  }
+}
+
 export const attributes: SequelizeAttributes<TimelimitRuleAttributes> = {
   ...attributesVersion1,
-  ...attributesVersion2
+  ...attributesVersion2,
+  ...attributesVersion3
 }
 
 export const createTimelimitRuleModel = (sequelize: Sequelize.Sequelize): TimelimitRuleModelStatic => sequelize.define('TimelimitRule', attributes) as TimelimitRuleModelStatic

src/function/sync/apply-actions/dispatch-parent-action/createtimelimitrule.ts

@@ -54,7 +54,8 @@ export async function dispatchCreateTimeLimitRule ({ action, cache, fromChildSel
     startMinuteOfDay: action.rule.start,
     endMinuteOfDay: action.rule.end,
     sessionDurationMilliseconds: action.rule.sessionDurationMilliseconds,
-    sessionPauseMilliseconds: action.rule.sessionPauseMilliseconds
+    sessionPauseMilliseconds: action.rule.sessionPauseMilliseconds,
+    perDay: action.rule.perDay ? 1 : 0
   }, { transaction: cache.transaction })
 
   cache.categoriesWithModifiedTimeLimitRules.add(action.rule.categoryId)

src/function/sync/apply-actions/dispatch-parent-action/updatetimelimitrule.ts

@@ -42,6 +42,7 @@ export async function dispatchUpdateTimelimitRule ({ action, cache }: {
   ruleEntry.endMinuteOfDay = action.end
   ruleEntry.sessionDurationMilliseconds = action.sessionDurationMilliseconds
   ruleEntry.sessionPauseMilliseconds = action.sessionPauseMilliseconds
+  ruleEntry.perDay = action.perDay ? 1 : 0
 
   await ruleEntry.save({ transaction: cache.transaction })
 

src/function/sync/get-server-data-status/category/rules.ts

@@ -44,7 +44,8 @@ export async function getRules ({ database, transaction, categoryIdsToSyncRules,
       'startMinuteOfDay',
       'endMinuteOfDay',
       'sessionDurationMilliseconds',
-      'sessionPauseMilliseconds'
+      'sessionPauseMilliseconds',
+      'perDay'
     ],
     transaction
   })).map((item) => ({
@@ -56,7 +57,8 @@ export async function getRules ({ database, transaction, categoryIdsToSyncRules,
     startMinuteOfDay: item.startMinuteOfDay,
     endMinuteOfDay: item.endMinuteOfDay,
     sessionDurationMilliseconds: item.sessionDurationMilliseconds,
-    sessionPauseMilliseconds: item.sessionPauseMilliseconds
+    sessionPauseMilliseconds: item.sessionPauseMilliseconds,
+    perDay: item.perDay
   }))
 
   const getCategoryRulesVersion = (categoryId: string) => (
@@ -73,7 +75,8 @@ export async function getRules ({ database, transaction, categoryIdsToSyncRules,
       start: item.startMinuteOfDay,
       end: item.endMinuteOfDay,
       session: item.sessionDurationMilliseconds,
-      pause: item.sessionPauseMilliseconds
+      pause: item.sessionPauseMilliseconds,
+      perDay: item.perDay !== 0 ? true : false
     })),
     version: getCategoryRulesVersion(categoryId)
   }))

src/model/timelimitrule.ts

@@ -28,10 +28,12 @@ export class TimelimitRule {
   readonly end: number
   readonly sessionDurationMilliseconds: number
   readonly sessionPauseMilliseconds: number
+  readonly perDay: boolean
 
   constructor ({
     ruleId, categoryId, maxTimeInMillis, dayMask, applyToExtraTimeUsage,
-    start, end, sessionDurationMilliseconds, sessionPauseMilliseconds
+    start, end, sessionDurationMilliseconds, sessionPauseMilliseconds,
+    perDay
   }: {
     ruleId: string
     categoryId: string
@@ -42,6 +44,7 @@ export class TimelimitRule {
     end: number
     sessionDurationMilliseconds: number
     sessionPauseMilliseconds: number
+    perDay: boolean
   }) {
     this.ruleId = ruleId
     this.categoryId = categoryId
@@ -52,6 +55,7 @@ export class TimelimitRule {
     this.end = end
     this.sessionDurationMilliseconds = sessionDurationMilliseconds
     this.sessionPauseMilliseconds = sessionPauseMilliseconds
+    this.perDay = perDay
 
     assertIdWithinFamily(ruleId)
     assertIdWithinFamily(categoryId)
@@ -98,7 +102,7 @@ export class TimelimitRule {
     dur: this.sessionDurationMilliseconds
   })
 
-  static parse = ({ ruleId, categoryId, time, days, extraTime, start, end, dur, pause }: SerializedTimeLimitRule) => (
+  static parse = ({ ruleId, categoryId, time, days, extraTime, start, end, dur, pause, perDay }: SerializedTimeLimitRule) => (
     new TimelimitRule({
       ruleId,
       categoryId,
@@ -108,7 +112,8 @@ export class TimelimitRule {
       start: start ?? MinuteOfDay.MIN,
       end: end ?? MinuteOfDay.MAX,
       sessionDurationMilliseconds: dur ?? 0,
-      sessionPauseMilliseconds: pause ?? 0
+      sessionPauseMilliseconds: pause ?? 0,
+      perDay: perDay ?? false
     })
   )
 }
@@ -123,6 +128,7 @@ export interface SerializedTimeLimitRule {
   end?: number
   dur?: number
   pause?: number
+  perDay?: boolean
 }
 
 export class ParseTimeLimitRuleException extends Error {}

src/object/serverdatastatus.ts

@@ -187,6 +187,7 @@ export interface ServerTimeLimitRule {
   end: number         // endMinuteOfDay
   session: number     // maximum session duration
   pause: number       // session pause duration
+  perDay: boolean
 }
 
 export interface ServerUpdatedCategoryTasks {