Add notification sending and an alarm when a reminder is triggered (#31)

Author: floflo0

README.md

@@ -51,3 +51,7 @@ make swagger
 ```
 
 This will open the swagger interface in your browser.
+
+## Credits
+
+Alarm sound from <https://pixabay.com/fr/sound-effects/phone-ringtone-clean-273554/>.

pill_mate/backend/assets/alarm.mp3

@@ -17,6 +17,7 @@ export default tseslint.config(
             globals: globals.node,
         },
         rules: {
+            'no-console': 'error',
             'max-len': ['error', { code: 100 }],
             indent: ['error', 4],
             semi: ['error', 'always'],

pill_mate/backend/eslint.config.mjs

@@ -2,6 +2,7 @@ import express from 'express';
 import morgan from 'morgan';
 
 import { createLogger } from './logger';
+import homeAssistantRoutes from './routes/homeAssistantRoutes';
 import medicationRoutes from './routes/medicationRoutes';
 import reminderRoutes from './routes/reminderRoutes';
 import userRoutes from './routes/userRoutes';
@@ -19,11 +20,14 @@ app.use(morgan('dev', {
     },
 }));
 
+app.use('/static', express.static('assets'));
+
 app.use(applicationJson);
 app.use(express.json());
 
 app.use(homeAssistantHeaders);
 
+app.use('/homeassistant', homeAssistantRoutes);
 app.use('/medication', medicationRoutes);
 app.use('/reminder', reminderRoutes);
 app.use('/user', userRoutes);

pill_mate/backend/src/app.ts

@@ -0,0 +1,20 @@
+import assert from 'assert';
+
+import { Request, Response } from 'express';
+
+import { HTTP_200_OK } from '../status';
+import { asyncErrorHandler } from '../utils';
+import { HomeAssistantService } from '../services/HomeAssistantService';
+
+export const getMobileAppDevices = asyncErrorHandler(async (
+    request: Request,
+    response: Response,
+) => {
+    assert(request.user !== undefined);
+
+    const devies = await HomeAssistantService.getMobileAppDevices();
+
+    response
+        .status(HTTP_200_OK)
+        .json(devies.map(device => device.name));
+});

pill_mate/backend/src/controllers/homeAssistantController.ts

@@ -12,6 +12,7 @@ import {
     HTTP_404_NOT_FOUND,
 } from '../status';
 import { asyncErrorHandler, checkUnexpectedKeys } from '../utils';
+import { HomeAssistantService } from '../services/HomeAssistantService';
 
 export const me = asyncErrorHandler(async (request: Request, response: Response) => {
     assert(request.user !== undefined);
@@ -21,6 +22,7 @@ export const me = asyncErrorHandler(async (request: Request, response: Response)
         userName: request.homeAssistantUserName,
         userDisplayName: request.homeAssistantUserDisplayName,
         role: request.user.role,
+        mobileAppDevice: request.user.mobileAppDevice,
     });
 });
 
@@ -35,15 +37,25 @@ export const me = asyncErrorHandler(async (request: Request, response: Response)
  *       properties:
  *         role:
  *           $ref: '#/components/schemas/UserRole'
+ *         mobileAppDevice:
+ *           type: string
+ *           nullable: true
+ *           description: The devices where notifications will be send.
+ *           example: Redmi Note 8T
  */
 type CreateUserBody = {
     role: unknown,
+    mobileAppDevice: unknown,
 };
 
 export const createUser = asyncErrorHandler(async (request: Request, response: Response) => {
-    if (!checkUnexpectedKeys<CreateUserBody>(request.body, ['role'], response)) return;
+    if (!checkUnexpectedKeys<CreateUserBody>(
+        request.body,
+        ['role', 'mobileAppDevice'],
+        response,
+    )) return;
 
-    const { role } = request.body as CreateUserBody;
+    const { role, mobileAppDevice } = request.body as CreateUserBody;
 
     if (role === undefined) {
         response
@@ -59,6 +71,19 @@ export const createUser = asyncErrorHandler(async (request: Request, response: R
         return;
     }
 
+    if ((mobileAppDevice !== undefined &&
+         mobileAppDevice !== null &&
+         typeof mobileAppDevice !== 'string') ||
+        (typeof mobileAppDevice === 'string' &&
+         (await HomeAssistantService.getMobileAppDevices()).find(
+             device => device.name === mobileAppDevice,
+         ) === undefined)) {
+        response
+            .status(HTTP_400_BAD_REQUEST)
+            .json({ message: 'Invalid mobileAppDevice.' });
+        return;
+    }
+
     const user = await User.findOne({
         where: {
             homeAssistantUserId: request.homeAssistantUserId,
@@ -75,6 +100,7 @@ export const createUser = asyncErrorHandler(async (request: Request, response: R
     const newUser = await User.create({
         homeAssistantUserId: request.homeAssistantUserId,
         role,
+        mobileAppDevice,
     });
 
     response
@@ -85,6 +111,7 @@ export const createUser = asyncErrorHandler(async (request: Request, response: R
             userName: request.homeAssistantUserName,
             userDisplayName: request.homeAssistantUserDisplayName,
             role: newUser.role,
+            mobileAppDevice: newUser.mobileAppDevice,
         });
 });
 

pill_mate/backend/src/controllers/userController.ts

@@ -3,9 +3,9 @@ import { config } from 'dotenv';
 config({ path: '../.env' });
 
 import app from './app';
-import { HomeAssistantService } from './services/homeAssistantService';
+import { HomeAssistantService } from './services/HomeAssistantService';
 import { createLogger } from './logger';
-import { ReminderService } from './services/reminderService';
+import { ReminderService } from './services/ReminderService';
 import { sequelize } from './sequelize';
 
 const SUPERVISOR_TOKEN = process.env.SUPERVISOR_TOKEN;
@@ -20,9 +20,10 @@ const logger = createLogger('backend');
     }
 
     await Promise.all([
-        sequelize.sync({ alter: { drop: false } }).then(() => ReminderService.initAllTimeouts()),
+        sequelize.sync({ alter: { drop: false } }),
         HomeAssistantService.init(SUPERVISOR_TOKEN),
     ]);
+    await ReminderService.initAllTimeouts();
 
     app.listen(PORT, () => {
         logger.info(`Server running at http://localhost:${PORT}`);

pill_mate/backend/src/index.ts

@@ -59,7 +59,7 @@ export class Medication extends Model {
     declare indication: string | null;
 
     @AllowNull(false)
-    @Min(0.01)
+    @Min(0.0)
     @Column({
         type: DataType.DECIMAL(6, 2),
         allowNull: false,

pill_mate/backend/src/models/Medication.ts

@@ -1,3 +1,4 @@
+import assert from 'assert';
 /**
  * @openapi
  * components:
@@ -25,3 +26,20 @@ export enum MedicationUnit {
 export const isMedicationUnit = (value: unknown): value is MedicationUnit => {
     return typeof value === 'number' && value in MedicationUnit;
 };
+
+export const medicationUnitToString = (medicationUnit: MedicationUnit, plural: boolean) => {
+    switch (medicationUnit) {
+    case MedicationUnit.TABLET:
+        return plural ? 'comprimés' : 'comprimé';
+    case MedicationUnit.PILL:
+        return plural ? 'pilules' : 'pilule';
+    case MedicationUnit.ML:
+        return plural ? 'millilitres' : 'millilitre';
+    case MedicationUnit.DROPS:
+        return 'gouttes';
+    case MedicationUnit.UNIT:
+        return plural ? 'unités' : 'unité';
+    default:
+        assert(false, 'unreachable');
+    }
+};

pill_mate/backend/src/models/MedicationUnit.ts

@@ -1,6 +1,11 @@
 import {
+    BelongsToCreateAssociationMixin,
+    BelongsToGetAssociationMixin,
+    BelongsToSetAssociationMixin,
+} from 'sequelize';
+import {
+    AfterCreate,
     AllowNull,
-    BeforeCreate,
     BeforeDestroy,
     BeforeUpdate,
     BelongsTo,
@@ -12,7 +17,7 @@ import {
     Table,
 } from 'sequelize-typescript';
 
-import { ReminderService } from '../services/reminderService';
+import { ReminderService } from '../services/ReminderService';
 import { Medication } from './Medication';
 import { User } from './User';
 
@@ -74,14 +79,18 @@ export class Reminder extends Model {
     @Column(DataType.DATEONLY)
     declare nextDate: string;
 
-    @BelongsTo(() => Medication)
-    declare medication: Medication;
-
     @ForeignKey(() => Medication)
     @AllowNull(false)
     @Column
     declare medicationId: number;
 
+    @BelongsTo(() => Medication)
+    declare medication: Medication;
+
+    declare getMedication: BelongsToGetAssociationMixin<Medication>;
+    declare setMedication: BelongsToSetAssociationMixin<Medication, number>;
+    declare createMedication: BelongsToCreateAssociationMixin<Medication>;
+
     @ForeignKey(() => User)
     @AllowNull(false)
     @Column
@@ -90,6 +99,10 @@ export class Reminder extends Model {
     @BelongsTo(() => User)
     declare user: User;
 
+    declare getUser: BelongsToGetAssociationMixin<User>;
+    declare setUser: BelongsToSetAssociationMixin<User, number>;
+    declare createUser: BelongsToCreateAssociationMixin<User>;
+
     /**
      * Computes the exact `Date` object when the reminder should trigger.
      *
@@ -102,7 +115,7 @@ export class Reminder extends Model {
         return nextDate;
     }
 
-    @BeforeCreate
+    @AfterCreate
     static onCreate(instance: Reminder) {
         ReminderService.setUpTimeout(instance);
     }