Add ping support

src/database/main.ts

@@ -1,6 +1,6 @@
 /*
  * server component for the TimeLimit App
- * Copyright (C) 2019 - 2022 Jonas Lochmann
+ * Copyright (C) 2019 - 2026 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
@@ -33,6 +33,7 @@ import { createKeyResponseModel, KeyResponseModelStatic } from './keyresponse'
 import { createMailLoginTokenModel, MailLoginTokenModelStatic } from './maillogintoken'
 import { createUmzug } from './migration/umzug'
 import { createOldDeviceModel, OldDeviceModelStatic } from './olddevice'
+import { createPingModel, PingModelStatic } from './ping'
 import { createPurchaseModel, PurchaseModelStatic } from './purchase'
 import { createSessionDurationModel, SessionDurationModelStatic } from './sessionduration'
 import { createTimelimitRuleModel, TimelimitRuleModelStatic } from './timelimitrule'
@@ -61,6 +62,7 @@ export interface Database {
   keyResponse: KeyResponseModelStatic
   mailLoginToken: MailLoginTokenModelStatic
   oldDevice: OldDeviceModelStatic
+  ping: PingModelStatic
   purchase: PurchaseModelStatic
   sessionDuration: SessionDurationModelStatic
   timelimitRule: TimelimitRuleModelStatic
@@ -97,6 +99,7 @@ const createDatabase = (sequelize: Sequelize.Sequelize): Database => ({
   keyResponse: createKeyResponseModel(sequelize),
   mailLoginToken: createMailLoginTokenModel(sequelize),
   oldDevice: createOldDeviceModel(sequelize),
+  ping: createPingModel(sequelize),
   purchase: createPurchaseModel(sequelize),
   sessionDuration: createSessionDurationModel(sequelize),
   timelimitRule: createTimelimitRuleModel(sequelize),

src/database/migration/migrations/20260329-add-pings.ts

@@ -0,0 +1,67 @@
+/*
+ * server component for the TimeLimit App
+ * Copyright (C) 2019 - 2026 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'
+
+export async function up (queryInterface: QueryInterface, sequelize: Sequelize) {
+  await sequelize.transaction({
+    type: Transaction.TYPES.EXCLUSIVE
+  }, async (transaction) => {
+    const dialect = sequelize.getDialect()
+    const isMysql = dialect === 'mysql' || dialect === 'mariadb'
+
+    if (isMysql) {
+      await sequelize.query(
+        'CREATE TABLE `Pings` ' +
+        '(`familyId` VARCHAR(10) NOT NULL,' +
+        '`receiverDeviceId` VARCHAR(6) NOT NULL,' +
+        '`senderDeviceId` VARCHAR(6) NOT NULL,' +
+        '`type` INTEGER NOT NULL,' +
+        '`token` VARCHAR(6) NOT NULL,' +
+        'PRIMARY KEY (`familyId`, `receiverDeviceId`, `senderDeviceId`, `type`),' +
+        'FOREIGN KEY (`familyId`, `receiverDeviceId`) REFERENCES `Devices` (`familyId`, `deviceId`) ON UPDATE CASCADE ON DELETE CASCADE,' +
+        'FOREIGN KEY (`familyId`, `senderDeviceId`) REFERENCES `Devices` (`familyId`, `deviceId`) ON UPDATE CASCADE ON DELETE CASCADE' +
+        ')',
+        { transaction }
+      )
+    } else {
+      await sequelize.query(
+        'CREATE TABLE "Pings" ' +
+        '("familyId" VARCHAR(10) NOT NULL,' +
+        '"receiverDeviceId" VARCHAR(6) NOT NULL,' +
+        '"senderDeviceId" VARCHAR(6) NOT NULL,' +
+        '"type" INTEGER NOT NULL,' +
+        '"token" VARCHAR(6) NOT NULL,' +
+        'PRIMARY KEY ("familyId", "receiverDeviceId", "senderDeviceId", "type"),' +
+        'FOREIGN KEY ("familyId", "receiverDeviceId") REFERENCES "Devices" ("familyId", "deviceId") ON UPDATE CASCADE ON DELETE CASCADE,' +
+        'FOREIGN KEY ("familyId", "senderDeviceId") REFERENCES "Devices" ("familyId", "deviceId") ON UPDATE CASCADE ON DELETE CASCADE' +
+        ')',
+        { transaction }
+      )
+    }
+
+    await queryInterface.addIndex('Pings', ['familyId', 'senderDeviceId'], { transaction })
+  })
+}
+
+export async function down (queryInterface: QueryInterface, sequelize: Sequelize) {
+  await sequelize.transaction({
+    type: Transaction.TYPES.EXCLUSIVE
+  }, async (transaction) => {
+    await queryInterface.dropTable('Pings', { transaction })
+  })
+}

src/database/ping.ts

@@ -0,0 +1,67 @@
+/*
+ * server component for the TimeLimit App
+ * Copyright (C) 2019 - 2026 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 * as Sequelize from 'sequelize'
+import { familyIdColumn, idWithinFamilyColumn } from './columns'
+import { SequelizeAttributes } from './types'
+
+export interface PingAttributes {
+  familyId: string
+  receiverDeviceId: string
+  senderDeviceId: string
+  type: number
+  token: string
+}
+
+export const types = {
+  ping: 1,
+  pong: 2,
+  all: [1, 2]
+}
+
+export type PingModel = Sequelize.Model<PingAttributes> & PingAttributes
+export type PingModelStatic = typeof Sequelize.Model & {
+  new (values?: object, options?: Sequelize.BuildOptions): PingModel;
+}
+
+export const attributes: SequelizeAttributes<PingAttributes> = {
+  familyId: {
+    ...familyIdColumn,
+    primaryKey: true
+  },
+  receiverDeviceId: {
+    ...idWithinFamilyColumn,
+    primaryKey: true
+  },
+  senderDeviceId: {
+    ...idWithinFamilyColumn,
+    primaryKey: true
+  },
+  type: {
+    type: Sequelize.INTEGER,
+    allowNull: false,
+    validate: {
+      isIn: [types.all]
+    },
+    primaryKey: true
+  },
+  token: {
+    ...idWithinFamilyColumn
+  }
+}
+
+export const createPingModel = (sequelize: Sequelize.Sequelize): PingModelStatic => sequelize.define('Ping', attributes) as PingModelStatic