25262918929

Committed 02 May 2026 09:45PM UTC coverage: 86.326% (-0.1%) from 86.427%

Build # 25262918929

Build Type

Pull #1558

github

Committed by

ClemRz

Commit Message

feat(notification): notify document author on validation and rejection

Pull Request Pull Request #1558: feat(notification): notify document author on validation and rejection

Coverage Stats

2973 of 3586 branches covered (82.91%)

Branch coverage included in aggregate %.

21 of 28 new or added lines in 3 files covered. (75.0%)

9 existing lines in 4 files now uncovered.

6175 of 7011 relevant lines covered (88.08%)

53.49 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

91.52

/api/services/NotificationService.js

const NameService = require('./NameService');
const CommonService = require('./CommonService');

const NOTIFICATION_ENTITIES = {
  CAVE: 'cave',
  COMMENT: 'comment',
  DESCRIPTION: 'description',
  DOCUMENT: 'document',
  ENTRANCE: 'entrance',
  HISTORY: 'history',
  LOCATION: 'location',
  MASSIF: 'massif',
  ORGANIZATION: 'organization',
  RIGGING: 'rigging',
};

const NOTIFICATION_TYPES = {
  CREATE: 'CREATE',
  DELETE: 'DELETE',
  PERMANENT_DELETE: 'PERMANENT_DELETE',
  UPDATE: 'UPDATE',
  VALIDATE: 'VALIDATE',
  RESTORE: 'RESTORE',
  REJECT: 'REJECT',
};

async function removeOlderNotifications() {
  const query = `DELETE
                 FROM t_notification
                 WHERE date_inscription < current_timestamp - interval '2 month';`;
  await CommonService.query(query);
}

const safeGetPropId = (prop, data) => {
  if (data && data[prop]) {
    if (data[prop] instanceof Object) {
      return data[prop].id;
    }
    return data[prop];
  }
  return undefined;
};

const sendNotificationEmail = async (
  entity,
  notificationType,
  notificationEntity,
  req,
  user
) => {
  // Get entity name (handle all cases)
  const getEntityName = (entityData) => {
    if (entityData.name) return entityData.name;
    if (entityData.names) return entityData.names[0]?.name;
    if (entityData.title) return entityData.title;
    if (entityData.titles) return entityData.titles[0]?.text;
    if (entityData.body) return `${entityData.body.slice(0, 50)}...`;
    if (entityData.descriptions) return entityData.descriptions[0].title;
    return '';
  };

  const entityName = getEntityName(entity);

  // Format action verb
  const actionVerbMap = {
    [NOTIFICATION_TYPES.CREATE]: 'created',
    [NOTIFICATION_TYPES.DELETE]: 'deleted',
    [NOTIFICATION_TYPES.PERMANENT_DELETE]: 'permanently deleted',
    [NOTIFICATION_TYPES.UPDATE]: 'updated',
    [NOTIFICATION_TYPES.VALIDATE]: 'validated',
    [NOTIFICATION_TYPES.RESTORE]: 'restored',
    [NOTIFICATION_TYPES.REJECT]: 'rejected',
  };

  const actionVerb = actionVerbMap[notificationType];
  if (!actionVerb) {
    throw Error(`Unknown notification type: ${notificationType}`);
  }

  // Format entity Link
  const baseUrl = `${sails.config.custom.baseUrl}/ui/`;
  const relatedCaveId = safeGetPropId('cave', entity);
  const relatedEntranceId = safeGetPropId('entrance', entity);
  const relatedMassifId = safeGetPropId('massif', entity);

  const getRelatedEntityLink = () => {
    if (relatedCaveId) return `caves/${relatedCaveId}`;
    if (relatedEntranceId) return `entrances/${relatedEntranceId}`;
    if (relatedMassifId) return `massifs/${relatedMassifId}`;
    return null;
  };

  const directLinkEntities = {
    [NOTIFICATION_ENTITIES.CAVE]: `caves/${entity.id}`,
    [NOTIFICATION_ENTITIES.DOCUMENT]: `documents/${entity.id}`,
    [NOTIFICATION_ENTITIES.ENTRANCE]: `entrances/${entity.id}`,
    [NOTIFICATION_ENTITIES.MASSIF]: `massifs/${entity.id}`,
    [NOTIFICATION_ENTITIES.ORGANIZATION]: `organizations/${entity.id}`,
  };

  let entityLink;
  if (directLinkEntities[notificationEntity]) {
    entityLink = baseUrl + directLinkEntities[notificationEntity];
  } else {
    const relatedLink = getRelatedEntityLink();
    if (!relatedLink) {
      const entityTypeName = notificationEntity.toLowerCase();
      let requiredEntities;
      if (notificationEntity === NOTIFICATION_ENTITIES.DESCRIPTION) {
        requiredEntities = 'cave, entrance or massif';
      } else if (notificationEntity === NOTIFICATION_ENTITIES.LOCATION) {
        requiredEntities = 'entrance';
      } else {
        requiredEntities = 'cave or entrance';
      }
      throw Error(
        `Can't find related entity (${requiredEntities}) of the ${entityTypeName} with id ${entity.id}`
      );
    }
    entityLink = baseUrl + relatedLink;
  }

  await sails.helpers.sendEmail
    .with({
      allowResponse: false,
      emailSubject: 'Notification',
      i18n: req.i18n,
      recipientEmail: user.mail,
      viewName: 'notification',
      viewValues: {
        actionVerb,
        entityLink,
        entityName,
        entityType: notificationEntity,
        recipientName: user.nickname,
        subscriptionName: user.subscriptionName,
        subscriptionType: user.subscriptionType,
        isAuthorNotification: user.isAuthorNotification || false,
        validationComment: user.validationComment || null,
      },
    })
    .intercept('sendSESEmailError', () => {
      sails.log.error(
        `The email service has encountered an error while trying to notify user ${user.nickname} (id=${user.id}).`
      );
      return false;
    });
};

const getCountryMassifAndRegionSubscribers = async (
  entityCountryId,
  entityMassifIds,
  entityRegionId
) => {
  const countrySubscribers = [];
  const massifsSubscribers = [];
  const regionSubscribers = [];
  if (entityCountryId) {
    const country =
      await TCountry.findOne(entityCountryId).populate('subscribedCavers');
    if (country) {
      countrySubscribers.push(
        ...country.subscribedCavers.map((caver) => ({
          ...caver,
          subscriptionName: country.nativeName,
          subscriptionType: 'country',
        }))
      );
    }
  }
  if (entityMassifIds) {
    await Promise.all(
      entityMassifIds.map(async (massifId) => {
        const massif =
          await TMassif.findOne(massifId).populate('subscribedCavers');
        if (massif) {
          await NameService.setNames([massif], 'massif');
          massifsSubscribers.push(
            ...massif.subscribedCavers.map((caver) => ({
              ...caver,
              subscriptionType: 'massif',
              subscriptionName: massif.names[0]?.name,
            }))
          );
        }
      })
    );
  }
  if (entityRegionId) {
    const region =
      await TISO31662.findOne(entityRegionId).populate('subscribedCavers');
    if (region) {
      regionSubscribers.push(
        ...region.subscribedCavers.map((caver) => ({
          ...caver,
          subscriptionName: region.name,
          subscriptionType: 'region',
        }))
      );
    }
  }
  return { countrySubscribers, massifsSubscribers, regionSubscribers };
};

module.exports = {
  NOTIFICATION_ENTITIES,
  NOTIFICATION_TYPES,
  ...(process.env.NODE_ENV === 'test' ? { sendNotificationEmail } : undefined),

  /**
   *
   * @param {*} req
   * @param {*} entity
   * @param {Number} notifierId
   * @param {NOTIFICATION_TYPES} notificationType
   * @param {NOTIFICATION_ENTITIES} notificationEntity
   * @return {Boolean} true if everything went well, else false
   */
  notifySubscribers: async (
    req,
    entity,
    notifierId,
    notificationType,
    notificationEntity
  ) => {
    // Had to require in the function to avoid a circular dependency with notifySubscribers() in CaveService.createCave()
    // eslint-disable-next-line global-require
    const CaveService = require('./CaveService');

    // Check params and silently fail to avoid sending an error to the client
    if (!Object.values(NOTIFICATION_ENTITIES).includes(notificationEntity)) {
      throw new Error(`Invalid notification entity: ${notificationEntity}`);
    }
    if (!Object.values(NOTIFICATION_TYPES).includes(notificationType)) {
      throw new Error(`Invalid notification type: ${notificationType}`);
    }
    if (!notifierId) {
      throw new Error(`Missing notifier id`);
    }

    try {
      // For the populateEntities() method, must use "grotto" instead of "organization"
      const entityKey =
        notificationEntity === NOTIFICATION_ENTITIES.ORGANIZATION
          ? 'grotto'
          : notificationEntity;

      // Format notification and populate entity
      const notification = await module.exports.populateEntities({
        dateInscription: new Date(),
        notificationType: (
          await TNotificationType.findOne({
            name: notificationType,
          })
        ).id,
        notifier: notifierId,
        [entityKey]: entity,
      });

      const populatedEntity = notification[entityKey];

      const caveId = safeGetPropId('cave', populatedEntity);
      const entranceId = safeGetPropId('entrance', populatedEntity);
      const massifId = safeGetPropId('massif', populatedEntity);

      const getMassifIdsFromCave = async (id) =>
        (await CaveService.getMassifs(id)).map((m) => m.id);
      const getCountryId = (id) => safeGetPropId('country', id);
      const getRegionId = (entityData) => entityData?.iso_3166_2;

      const getCountryFromCaveEntrances = (cave) => {
        if (cave?.entrances?.length > 0) {
          return getCountryId(cave.entrances[0]);
        }
        return null;
      };

      const resolveLocationFromCaveOrEntrance = async (
        relatedCaveId,
        relatedEntranceId,
        entityData
      ) => {
        if (relatedCaveId) {
          return {
            countryId: getCountryFromCaveEntrances(entityData.cave),
            massifIds: await getMassifIdsFromCave(relatedCaveId),
            regionId: entityData.cave?.entrances?.[0]
              ? getRegionId(entityData.cave.entrances[0])
              : null,
          };
        }
        if (relatedEntranceId) {
          return {
            countryId: getCountryId(entityData.entrance),
            massifIds: await getMassifIdsFromCave(
              safeGetPropId('cave', entityData.entrance)
            ),
            regionId: getRegionId(entityData.entrance),
          };
        }
        return { countryId: null, massifIds: [], regionId: null };
      };

      // Entity-specific location resolution
      const entityResolvers = {
        [NOTIFICATION_ENTITIES.CAVE]: async () => ({
          countryId: getCountryFromCaveEntrances(populatedEntity),
          massifIds: await getMassifIdsFromCave(populatedEntity.id),
          regionId: populatedEntity?.entrances?.[0]
            ? getRegionId(populatedEntity.entrances[0])
            : null,
        }),

        [NOTIFICATION_ENTITIES.ENTRANCE]: async () => ({
          countryId: getCountryId(populatedEntity),
          massifIds: populatedEntity?.cave
            ? await getMassifIdsFromCave(safeGetPropId('cave', populatedEntity))
            : [],
          regionId: getRegionId(populatedEntity),
        }),

        [NOTIFICATION_ENTITIES.MASSIF]: async () => ({
          countryId: null,
          massifIds: [populatedEntity.id],
          regionId: null,
        }),

        [NOTIFICATION_ENTITIES.ORGANIZATION]: async () => ({
          countryId: getCountryId(populatedEntity),
          massifIds: [],
          regionId: getRegionId(populatedEntity),
        }),

        [NOTIFICATION_ENTITIES.LOCATION]: async () => {
          if (!entranceId)
            throw new Error(`Can't retrieve related entrance id.`);
          return {
            countryId: getCountryId(populatedEntity.entrance),
            massifIds: await getMassifIdsFromCave(
              safeGetPropId('cave', populatedEntity.entrance)
            ),
            regionId: getRegionId(populatedEntity.entrance),
          };
        },
      };

      // Entities that can relate to cave, entrance, or massif
      const multiRelationEntities = [
        NOTIFICATION_ENTITIES.COMMENT,
        NOTIFICATION_ENTITIES.DESCRIPTION,
        NOTIFICATION_ENTITIES.HISTORY,
        NOTIFICATION_ENTITIES.RIGGING,
      ];

      // Find massifs and country concerned about the notification
      let result;
      if (entityResolvers[notificationEntity]) {
        result = await entityResolvers[notificationEntity]();
      } else if (multiRelationEntities.includes(notificationEntity)) {
        result = await resolveLocationFromCaveOrEntrance(
          caveId,
          entranceId,
          populatedEntity
        );

        // Handle massif-only case for description and document
        if (!result.countryId && !result.massifIds.length && massifId) {
          result.massifIds = [safeGetPropId('massif', populatedEntity)];
        }

        // Require cave or entrance for most entities
        if (
          !caveId &&
          !entranceId &&
          ![
            NOTIFICATION_ENTITIES.DESCRIPTION,
            NOTIFICATION_ENTITIES.DOCUMENT,
          ].includes(notificationEntity)
        ) {
          throw new Error(`Can't retrieve related cave or entrance id.`);
        }
      } else if (notificationEntity === NOTIFICATION_ENTITIES.DOCUMENT) {
        result = await resolveLocationFromCaveOrEntrance(
          caveId,
          entranceId,
          populatedEntity
        );
        if (!result.countryId && !result.massifIds.length && massifId) {
          result.massifIds = [safeGetPropId('massif', populatedEntity)];
        }
      } else {
        throw new Error(
          `Can't find what to do with the following notification entity value: ${notificationEntity}`
        );
      }

      const entityCountryId = result.countryId;
      const entityMassifIds = result.massifIds;
      const entityRegionId = result.regionId;

      // Find subscribers to the entity.
      const { countrySubscribers, massifsSubscribers, regionSubscribers } =
        await getCountryMassifAndRegionSubscribers(
          entityCountryId,
          entityMassifIds,
          entityRegionId
        );
      // Consolidate subscribers by user ID and combine subscription types
      const subscriberMap = new Map();

      const addSubscribers = (subscribers) => {
        subscribers
          .filter((u) => u.id !== notifierId)
          .forEach((user) => {
            if (subscriberMap.has(user.id)) {
              const existing = subscriberMap.get(user.id);
              existing.subscriptionNames.push(user.subscriptionName);
              existing.subscriptionTypes.push(user.subscriptionType);
            } else {
              subscriberMap.set(user.id, {
                ...user,
                subscriptionNames: [user.subscriptionName],
                subscriptionTypes: [user.subscriptionType],
              });
            }
          });
      };

      addSubscribers(countrySubscribers);
      addSubscribers(massifsSubscribers);
      addSubscribers(regionSubscribers);

      const uniqueUsers = Array.from(subscriberMap.values()).map((user) => ({
        ...user,
        subscriptionName: user.subscriptionNames.join(' and '),
        subscriptionType: user.subscriptionTypes.join(', '),
      }));

      // Create notifications & optionally send email
      const res = await Promise.all(
        uniqueUsers.map(async (user) => {
          try {
            await TNotification.create({
              ...notification,
              notified: user.id,
              [entityKey]: notification[entityKey].id, // id only for the DB storage
            });
          } catch (e) {
            sails.log.error(
              `An error occured when trying to create a notification: ${e.message}`
            );
            return false;
          }

          if (user.sendNotificationByEmail) {
            await sendNotificationEmail(
              populatedEntity,
              notificationType,
              notificationEntity,
              req,
              user
            );
          }
          return true;
        })
      );

      // 5% chance to also remove older notifications
      if (process.env.NODE_ENV !== 'test' && Math.random() < 0.05) {
        try {
          await removeOlderNotifications();
        } catch (cleanupError) {
          sails.log.error(
            `Error during notification cleanup: ${cleanupError.message}`
          );
        }
      }

      return res;
    } catch (error) {
      // Fail silently to avoid sending an error to the user
      sails.log.error(
        `An error occurred when trying to notify subscribers: ${error.message} ${error.stack}`
      );
      return false;
    }
  },

  /**
   * Create an in-app notification for the document author and optionally send an email.
   *
   * @param {Object}  req              - Express request (carries i18n)
   * @param {Object}  document         - Populated TDocument (must have .author)
   * @param {Number}  moderatorId      - ID of the moderator who made the decision
   * @param {String}  notificationType - NOTIFICATION_TYPES.VALIDATE or NOTIFICATION_TYPES.REJECT
   * @param {String|null} validationComment - Moderator's comment (required for REJECT)
   * @returns {Boolean} true on success, false on silent failure
   */
  notifyAuthor: async (
    req,
    document,
    moderatorId,
    notificationType,
    validationComment
  ) => {
    const authorId = safeGetPropId('author', document);
    if (!authorId) {
      sails.log.debug(
        `notifyAuthor: document ${document.id} has no author, skipping notification`
      );
      return true;
    }
    if (authorId === moderatorId) {
      return true;
    }

    if (!Object.values(NOTIFICATION_TYPES).includes(notificationType)) {
      throw new Error(`Invalid notification type: ${notificationType}`);
    }

    try {
      const notificationTypeRecord = await TNotificationType.findOne({
        name: notificationType,
      });

      await TNotification.create({
        dateInscription: new Date(),
        notificationType: notificationTypeRecord.id,
        notifier: moderatorId,
        notified: authorId,
        document: document.id,
      });

      const author = await TCaver.findOne(authorId);

      if (author && author.sendNotificationByEmail) {
        await sendNotificationEmail(
          document,
          notificationType,
          NOTIFICATION_ENTITIES.DOCUMENT,
          req,
          {
            ...author,
            isAuthorNotification: true,
            validationComment,
          }
        );
      }

      return true;
    } catch (error) {
      sails.log.error(
        `An error occurred when trying to notify the document author: ${error.message} ${error.stack}`
      );
      return false;
    }
  },

  populateEntities: async (notification) => {
    const populatedNotification = notification;
    if (populatedNotification.cave) {
      await NameService.setNames([populatedNotification.cave], 'cave');
    }
    if (populatedNotification.comment) {
      populatedNotification.comment = await TComment.findOne(
        safeGetPropId('comment', notification)
      )
        .populate('cave')
        .populate('entrance');
    }
    if (populatedNotification.description) {
      populatedNotification.description = await TDescription.findOne(
        safeGetPropId('description', notification)
      )
        .populate('cave')
        .populate('document')
        .populate('entrance')
        .populate('massif');
    }
    if (populatedNotification.document) {
      // Had to require in the function to avoid a circular dependency with notifySubscribers() in DocumentService.createDocument()
      // eslint-disable-next-line global-require
      const DocumentService = require('./DocumentService');
      const populatedDocuments = await DocumentService.getDocuments([
        safeGetPropId('document', notification),
      ]);
      populatedNotification.document = populatedDocuments[0];
    }
    if (populatedNotification.entrance) {
      await NameService.setNames([populatedNotification.entrance], 'entrance');
    }
    if (populatedNotification.grotto) {
      await NameService.setNames([populatedNotification.grotto], 'grotto');
    }
    if (populatedNotification.history) {
      populatedNotification.history = await THistory.findOne(
        safeGetPropId('history', notification)
      )
        .populate('cave')
        .populate('entrance');
    }
    if (populatedNotification.location) {
      populatedNotification.location = await TLocation.findOne(
        safeGetPropId('location', notification)
      ).populate('entrance');
    }
    if (populatedNotification.massif) {
      await NameService.setNames([populatedNotification.massif], 'massif');
    }
    if (populatedNotification.rigging) {
      populatedNotification.rigging = await TRigging.findOne(
        safeGetPropId('rigging', notification)
      )
        .populate('entrance')
        .populate('cave');
    }
    return populatedNotification;
  },
};

1	const NameService = require('./NameService');	8✔
2	const CommonService = require('./CommonService');	8✔
3
4	const NOTIFICATION_ENTITIES = {	8✔
5	CAVE: 'cave',
6	COMMENT: 'comment',
7	DESCRIPTION: 'description',
8	DOCUMENT: 'document',
9	ENTRANCE: 'entrance',
10	HISTORY: 'history',
11	LOCATION: 'location',
12	MASSIF: 'massif',
13	ORGANIZATION: 'organization',
14	RIGGING: 'rigging',
15	};
16
17	const NOTIFICATION_TYPES = {	8✔
18	CREATE: 'CREATE',
19	DELETE: 'DELETE',
20	PERMANENT_DELETE: 'PERMANENT_DELETE',
21	UPDATE: 'UPDATE',
22	VALIDATE: 'VALIDATE',
23	RESTORE: 'RESTORE',
24	REJECT: 'REJECT',
25	};
26
27	async function removeOlderNotifications() {
28	const query = `DELETE	×
29	FROM t_notification
30	WHERE date_inscription < current_timestamp - interval '2 month';`;
31	await CommonService.query(query);	×
32	}
33
34	const safeGetPropId = (prop, data) => {	8✔
35	if (data && data[prop]) {	1,908✔
36	if (data[prop] instanceof Object) {	556✔
37	return data[prop].id;	187✔
38	}
39	return data[prop];	369✔
40	}
41	return undefined;	1,352✔
42	};
43
44	const sendNotificationEmail = async (	8✔
45	entity,
46	notificationType,
47	notificationEntity,
48	req,
49	user
50	) => {
51	// Get entity name (handle all cases)
52	const getEntityName = (entityData) => {	301✔
53	if (entityData.name) return entityData.name;	301✔
54	if (entityData.names) return entityData.names[0]?.name;	31✔
55	if (entityData.title) return entityData.title;	30✔
56	if (entityData.titles) return entityData.titles[0]?.text;	16✔
57	if (entityData.body) return `${entityData.body.slice(0, 50)}...`;	15✔
58	if (entityData.descriptions) return entityData.descriptions[0].title;	14✔
59	return '';	13✔
60	};
61
62	const entityName = getEntityName(entity);	301✔
63
64	// Format action verb
65	const actionVerbMap = {	301✔
66	[NOTIFICATION_TYPES.CREATE]: 'created',
67	[NOTIFICATION_TYPES.DELETE]: 'deleted',
68	[NOTIFICATION_TYPES.PERMANENT_DELETE]: 'permanently deleted',
69	[NOTIFICATION_TYPES.UPDATE]: 'updated',
70	[NOTIFICATION_TYPES.VALIDATE]: 'validated',
71	[NOTIFICATION_TYPES.RESTORE]: 'restored',
72	[NOTIFICATION_TYPES.REJECT]: 'rejected',
73	};
74
75	const actionVerb = actionVerbMap[notificationType];	301✔
76	if (!actionVerb) {	301✔
77	throw Error(`Unknown notification type: ${notificationType}`);	1✔
78	}
79
80	// Format entity Link
81	const baseUrl = `${sails.config.custom.baseUrl}/ui/`;	300✔
82	const relatedCaveId = safeGetPropId('cave', entity);	300✔
83	const relatedEntranceId = safeGetPropId('entrance', entity);	300✔
84	const relatedMassifId = safeGetPropId('massif', entity);	300✔
85
86	const getRelatedEntityLink = () => {	300✔
87	if (relatedCaveId) return `caves/${relatedCaveId}`;	22✔
88	if (relatedEntranceId) return `entrances/${relatedEntranceId}`;	20✔
89	if (relatedMassifId) return `massifs/${relatedMassifId}`;	5✔
90	return null;	4✔
91	};
92
93	const directLinkEntities = {	300✔
94	[NOTIFICATION_ENTITIES.CAVE]: `caves/${entity.id}`,
95	[NOTIFICATION_ENTITIES.DOCUMENT]: `documents/${entity.id}`,
96	[NOTIFICATION_ENTITIES.ENTRANCE]: `entrances/${entity.id}`,
97	[NOTIFICATION_ENTITIES.MASSIF]: `massifs/${entity.id}`,
98	[NOTIFICATION_ENTITIES.ORGANIZATION]: `organizations/${entity.id}`,
99	};
100
101	let entityLink;
102	if (directLinkEntities[notificationEntity]) {	300✔
103	entityLink = baseUrl + directLinkEntities[notificationEntity];	278✔
104	} else {
105	const relatedLink = getRelatedEntityLink();	22✔
106	if (!relatedLink) {	22✔
107	const entityTypeName = notificationEntity.toLowerCase();	4✔
108	let requiredEntities;
109	if (notificationEntity === NOTIFICATION_ENTITIES.DESCRIPTION) {	4✔
110	requiredEntities = 'cave, entrance or massif';	1✔
111	} else if (notificationEntity === NOTIFICATION_ENTITIES.LOCATION) {	3✔
112	requiredEntities = 'entrance';	1✔
113	} else {
114	requiredEntities = 'cave or entrance';	2✔
115	}
116	throw Error(	4✔
117	`Can't find related entity (${requiredEntities}) of the ${entityTypeName} with id ${entity.id}`
118	);
119	}
120	entityLink = baseUrl + relatedLink;	18✔
121	}
122
123	await sails.helpers.sendEmail	296✔
124	.with({
125	allowResponse: false,
126	emailSubject: 'Notification',
127	i18n: req.i18n,
128	recipientEmail: user.mail,
129	viewName: 'notification',
130	viewValues: {
131	actionVerb,
132	entityLink,
133	entityName,
134	entityType: notificationEntity,
135	recipientName: user.nickname,
136	subscriptionName: user.subscriptionName,
137	subscriptionType: user.subscriptionType,
138	isAuthorNotification: user.isAuthorNotification \|\| false,	387✔
139	validationComment: user.validationComment \|\| null,	420✔
140	},
141	})
142	.intercept('sendSESEmailError', () => {
143	sails.log.error(	×
144	`The email service has encountered an error while trying to notify user ${user.nickname} (id=${user.id}).`
145	);
146	return false;	×
147	});
148	};
149
150	const getCountryMassifAndRegionSubscribers = async (	8✔
151	entityCountryId,
152	entityMassifIds,
153	entityRegionId
154	) => {
155	const countrySubscribers = [];	143✔
156	const massifsSubscribers = [];	143✔
157	const regionSubscribers = [];	143✔
158	if (entityCountryId) {	143✔
159	const country =
160	await TCountry.findOne(entityCountryId).populate('subscribedCavers');	10✔
161	if (country) {	10!
162	countrySubscribers.push(	10✔
163	...country.subscribedCavers.map((caver) => ({	10✔
164	...caver,
165	subscriptionName: country.nativeName,
166	subscriptionType: 'country',
167	}))
168	);
169	}
170	}
171	if (entityMassifIds) {	143!
172	await Promise.all(	143✔
173	entityMassifIds.map(async (massifId) => {
174	const massif =
175	await TMassif.findOne(massifId).populate('subscribedCavers');	76✔
176	if (massif) {	76✔
177	await NameService.setNames([massif], 'massif');	72✔
178	massifsSubscribers.push(	72✔
179	...massif.subscribedCavers.map((caver) => ({	63✔
180	...caver,
181	subscriptionType: 'massif',
182	subscriptionName: massif.names[0]?.name,
183	}))
184	);
185	}
186	})
187	);
188	}
189	if (entityRegionId) {	143✔
190	const region =
191	await TISO31662.findOne(entityRegionId).populate('subscribedCavers');	17✔
192	if (region) {	17✔
193	regionSubscribers.push(	3✔
194	...region.subscribedCavers.map((caver) => ({	×
195	...caver,
196	subscriptionName: region.name,
197	subscriptionType: 'region',
198	}))
199	);
200	}
201	}
202	return { countrySubscribers, massifsSubscribers, regionSubscribers };	143✔
203	};
204
205	module.exports = {	8✔
206	NOTIFICATION_ENTITIES,
207	NOTIFICATION_TYPES,
208	...(process.env.NODE_ENV === 'test' ? { sendNotificationEmail } : undefined),	8!
209
210	/**
211	*
212	* @param {*} req
213	* @param {*} entity
214	* @param {Number} notifierId
215	* @param {NOTIFICATION_TYPES} notificationType
216	* @param {NOTIFICATION_ENTITIES} notificationEntity
217	* @return {Boolean} true if everything went well, else false
218	*/
219	notifySubscribers: async (
220	req,
221	entity,
222	notifierId,
223	notificationType,
224	notificationEntity
225	) => {
226	// Had to require in the function to avoid a circular dependency with notifySubscribers() in CaveService.createCave()
227	// eslint-disable-next-line global-require
228	const CaveService = require('./CaveService');	154✔
229
230	// Check params and silently fail to avoid sending an error to the client
231	if (!Object.values(NOTIFICATION_ENTITIES).includes(notificationEntity)) {	154✔
232	throw new Error(`Invalid notification entity: ${notificationEntity}`);	1✔
233	}
234	if (!Object.values(NOTIFICATION_TYPES).includes(notificationType)) {	153✔
235	throw new Error(`Invalid notification type: ${notificationType}`);	1✔
236	}
237	if (!notifierId) {	152✔
238	throw new Error(`Missing notifier id`);	1✔
239	}
240
241	try {	151✔
242	// For the populateEntities() method, must use "grotto" instead of "organization"
243	const entityKey =
244	notificationEntity === NOTIFICATION_ENTITIES.ORGANIZATION	151✔
245	? 'grotto'
246	: notificationEntity;
247
248	// Format notification and populate entity
249	const notification = await module.exports.populateEntities({	151✔
250	dateInscription: new Date(),
251	notificationType: (
252	await TNotificationType.findOne({
253	name: notificationType,
254	})
255	).id,
256	notifier: notifierId,
257	[entityKey]: entity,
258	});
259
260	const populatedEntity = notification[entityKey];	151✔
261
262	const caveId = safeGetPropId('cave', populatedEntity);	151✔
263	const entranceId = safeGetPropId('entrance', populatedEntity);	151✔
264	const massifId = safeGetPropId('massif', populatedEntity);	151✔
265
266	const getMassifIdsFromCave = async (id) =>	151✔
267	(await CaveService.getMassifs(id)).map((m) => m.id);	75✔
268	const getCountryId = (id) => safeGetPropId('country', id);	151✔
269	const getRegionId = (entityData) => entityData?.iso_3166_2;	151✔
270
271	const getCountryFromCaveEntrances = (cave) => {	151✔
272	if (cave?.entrances?.length > 0) {	16✔
273	return getCountryId(cave.entrances[0]);	5✔
274	}
275	return null;	11✔
276	};
277
278	const resolveLocationFromCaveOrEntrance = async (	151✔
279	relatedCaveId,
280	relatedEntranceId,
281	entityData
282	) => {
283	if (relatedCaveId) {	62✔
284	return {	3✔
285	countryId: getCountryFromCaveEntrances(entityData.cave),
286	massifIds: await getMassifIdsFromCave(relatedCaveId),
287	regionId: entityData.cave?.entrances?.[0]	3!
288	? getRegionId(entityData.cave.entrances[0])
289	: null,
290	};
291	}
292	if (relatedEntranceId) {	59✔
293	return {	19✔
294	countryId: getCountryId(entityData.entrance),
295	massifIds: await getMassifIdsFromCave(
296	safeGetPropId('cave', entityData.entrance)
297	),
298	regionId: getRegionId(entityData.entrance),
299	};
300	}
301	return { countryId: null, massifIds: [], regionId: null };	40✔
302	};
303
304	// Entity-specific location resolution
305	const entityResolvers = {	151✔
306	[NOTIFICATION_ENTITIES.CAVE]: async () => ({	13✔
307	countryId: getCountryFromCaveEntrances(populatedEntity),
308	massifIds: await getMassifIdsFromCave(populatedEntity.id),
309	regionId: populatedEntity?.entrances?.[0]	13✔
310	? getRegionId(populatedEntity.entrances[0])
311	: null,
312	}),
313
314	[NOTIFICATION_ENTITIES.ENTRANCE]: async () => ({	39✔
315	countryId: getCountryId(populatedEntity),
316	massifIds: populatedEntity?.cave	39✔
317	? await getMassifIdsFromCave(safeGetPropId('cave', populatedEntity))
318	: [],
319	regionId: getRegionId(populatedEntity),
320	}),
321
322	[NOTIFICATION_ENTITIES.MASSIF]: async () => ({	10✔
323	countryId: null,
324	massifIds: [populatedEntity.id],
325	regionId: null,
326	}),
327
328	[NOTIFICATION_ENTITIES.ORGANIZATION]: async () => ({	16✔
329	countryId: getCountryId(populatedEntity),
330	massifIds: [],
331	regionId: getRegionId(populatedEntity),
332	}),
333
334	[NOTIFICATION_ENTITIES.LOCATION]: async () => {
335	if (!entranceId)	11✔
336	throw new Error(`Can't retrieve related entrance id.`);	2✔
337	return {	9✔
338	countryId: getCountryId(populatedEntity.entrance),
339	massifIds: await getMassifIdsFromCave(
340	safeGetPropId('cave', populatedEntity.entrance)
341	),
342	regionId: getRegionId(populatedEntity.entrance),
343	};
344	},
345	};
346
347	// Entities that can relate to cave, entrance, or massif
348	const multiRelationEntities = [	151✔
349	NOTIFICATION_ENTITIES.COMMENT,
350	NOTIFICATION_ENTITIES.DESCRIPTION,
351	NOTIFICATION_ENTITIES.HISTORY,
352	NOTIFICATION_ENTITIES.RIGGING,
353	];
354
355	// Find massifs and country concerned about the notification
356	let result;
357	if (entityResolvers[notificationEntity]) {	151✔
358	result = await entityResolvers[notificationEntity]();	89✔
359	} else if (multiRelationEntities.includes(notificationEntity)) {	62✔
360	result = await resolveLocationFromCaveOrEntrance(	30✔
361	caveId,
362	entranceId,
363	populatedEntity
364	);
365
366	// Handle massif-only case for description and document
367	if (!result.countryId && !result.massifIds.length && massifId) {	30!
368	result.massifIds = [safeGetPropId('massif', populatedEntity)];	×
369	}
370
371	// Require cave or entrance for most entities
372	if (	30✔
373	!caveId &&	65✔
374	!entranceId &&
375	![
376	NOTIFICATION_ENTITIES.DESCRIPTION,
377	NOTIFICATION_ENTITIES.DOCUMENT,
378	].includes(notificationEntity)
379	) {
380	throw new Error(`Can't retrieve related cave or entrance id.`);	6✔
381	}
382	} else if (notificationEntity === NOTIFICATION_ENTITIES.DOCUMENT) {	32!
383	result = await resolveLocationFromCaveOrEntrance(	32✔
384	caveId,
385	entranceId,
386	populatedEntity
387	);
388	if (!result.countryId && !result.massifIds.length && massifId) {	32!
389	result.massifIds = [safeGetPropId('massif', populatedEntity)];	×
390	}
391	} else {
392	throw new Error(	×
393	`Can't find what to do with the following notification entity value: ${notificationEntity}`
394	);
395	}
396
397	const entityCountryId = result.countryId;	143✔
398	const entityMassifIds = result.massifIds;	143✔
399	const entityRegionId = result.regionId;	143✔
400
401	// Find subscribers to the entity.
402	const { countrySubscribers, massifsSubscribers, regionSubscribers } =
403	await getCountryMassifAndRegionSubscribers(	143✔
404	entityCountryId,
405	entityMassifIds,
406	entityRegionId
407	);
408	// Consolidate subscribers by user ID and combine subscription types
409	const subscriberMap = new Map();	143✔
410
411	const addSubscribers = (subscribers) => {	143✔
412	subscribers	429✔
413	.filter((u) => u.id !== notifierId)	73✔
414	.forEach((user) => {
415	if (subscriberMap.has(user.id)) {	73✔
416	const existing = subscriberMap.get(user.id);	9✔
417	existing.subscriptionNames.push(user.subscriptionName);	9✔
418	existing.subscriptionTypes.push(user.subscriptionType);	9✔
419	} else {
420	subscriberMap.set(user.id, {	64✔
421	...user,
422	subscriptionNames: [user.subscriptionName],
423	subscriptionTypes: [user.subscriptionType],
424	});
425	}
426	});
427	};
428
429	addSubscribers(countrySubscribers);	143✔
430	addSubscribers(massifsSubscribers);	143✔
431	addSubscribers(regionSubscribers);	143✔
432
433	const uniqueUsers = Array.from(subscriberMap.values()).map((user) => ({	143✔
434	...user,
435	subscriptionName: user.subscriptionNames.join(' and '),
436	subscriptionType: user.subscriptionTypes.join(', '),
437	}));
438
439	// Create notifications & optionally send email
440	const res = await Promise.all(	143✔
441	uniqueUsers.map(async (user) => {
442	try {	64✔
443	await TNotification.create({	64✔
444	...notification,
445	notified: user.id,
446	[entityKey]: notification[entityKey].id, // id only for the DB storage
447	});
448	} catch (e) {
449	sails.log.error(	×
450	`An error occured when trying to create a notification: ${e.message}`
451	);
452	return false;	×
453	}
454
455	if (user.sendNotificationByEmail) {	64!
456	await sendNotificationEmail(	×
457	populatedEntity,
458	notificationType,
459	notificationEntity,
460	req,
461	user
462	);
463	}
464	return true;	64✔
465	})
466	);
467
468	// 5% chance to also remove older notifications
469	if (process.env.NODE_ENV !== 'test' && Math.random() < 0.05) {	143!
470	try {	×
471	await removeOlderNotifications();	×
472	} catch (cleanupError) {
473	sails.log.error(	×
474	`Error during notification cleanup: ${cleanupError.message}`
475	);
476	}
477	}
478
479	return res;	143✔
480	} catch (error) {
481	// Fail silently to avoid sending an error to the user
482	sails.log.error(	8✔
483	`An error occurred when trying to notify subscribers: ${error.message} ${error.stack}`
484	);
485	return false;	8✔
486	}
487	},
488
489	/**
490	* Create an in-app notification for the document author and optionally send an email.
491	*
492	* @param {Object} req - Express request (carries i18n)
493	* @param {Object} document - Populated TDocument (must have .author)
494	* @param {Number} moderatorId - ID of the moderator who made the decision
495	* @param {String} notificationType - NOTIFICATION_TYPES.VALIDATE or NOTIFICATION_TYPES.REJECT
496	* @param {String\|null} validationComment - Moderator's comment (required for REJECT)
497	* @returns {Boolean} true on success, false on silent failure
498	*/
499	notifyAuthor: async (
500	req,
501	document,
502	moderatorId,
503	notificationType,
504	validationComment
505	) => {
506	const authorId = safeGetPropId('author', document);	323✔
507	if (!authorId) {	323✔
508	sails.log.debug(	1✔
509	`notifyAuthor: document ${document.id} has no author, skipping notification`
510	);
511	return true;	1✔
512	}
513	if (authorId === moderatorId) {	322✔
514	return true;	103✔
515	}
516
517	if (!Object.values(NOTIFICATION_TYPES).includes(notificationType)) {	219!
NEW 518	throw new Error(`Invalid notification type: ${notificationType}`);	×
519	}
520
521	try {	219✔
522	const notificationTypeRecord = await TNotificationType.findOne({	219✔
523	name: notificationType,
524	});
525
526	await TNotification.create({	219✔
527	dateInscription: new Date(),
528	notificationType: notificationTypeRecord.id,
529	notifier: moderatorId,
530	notified: authorId,
531	document: document.id,
532	});
533
534	const author = await TCaver.findOne(authorId);	219✔
535
536	if (author && author.sendNotificationByEmail) {	219✔
537	await sendNotificationEmail(	57✔
538	document,
539	notificationType,
540	NOTIFICATION_ENTITIES.DOCUMENT,
541	req,
542	{
543	...author,
544	isAuthorNotification: true,
545	validationComment,
546	}
547	);
548	}
549
550	return true;	219✔
551	} catch (error) {
NEW 552	sails.log.error(	×
553	`An error occurred when trying to notify the document author: ${error.message} ${error.stack}`
554	);
NEW 555	return false;	×
556	}
557	},
558
559	populateEntities: async (notification) => {
560	const populatedNotification = notification;	201✔
561	if (populatedNotification.cave) {	201✔
562	await NameService.setNames([populatedNotification.cave], 'cave');	15✔
563	}
564	if (populatedNotification.comment) {	201✔
565	populatedNotification.comment = await TComment.findOne(	11✔
566	safeGetPropId('comment', notification)
567	)
568	.populate('cave')
569	.populate('entrance');
570	}
571	if (populatedNotification.description) {	201✔
572	populatedNotification.description = await TDescription.findOne(	10✔
573	safeGetPropId('description', notification)
574	)
575	.populate('cave')
576	.populate('document')
577	.populate('entrance')
578	.populate('massif');
579	}
580	if (populatedNotification.document) {	201✔
581	// Had to require in the function to avoid a circular dependency with notifySubscribers() in DocumentService.createDocument()
582	// eslint-disable-next-line global-require
583	const DocumentService = require('./DocumentService');	39✔
584	const populatedDocuments = await DocumentService.getDocuments([	39✔
585	safeGetPropId('document', notification),
586	]);
587	populatedNotification.document = populatedDocuments[0];	39✔
588	}
589	if (populatedNotification.entrance) {	201✔
590	await NameService.setNames([populatedNotification.entrance], 'entrance');	55✔
591	}
592	if (populatedNotification.grotto) {	201✔
593	await NameService.setNames([populatedNotification.grotto], 'grotto');	16✔
594	}
595	if (populatedNotification.history) {	201✔
596	populatedNotification.history = await THistory.findOne(	7✔
597	safeGetPropId('history', notification)
598	)
599	.populate('cave')
600	.populate('entrance');
601	}
602	if (populatedNotification.location) {	201✔
603	populatedNotification.location = await TLocation.findOne(	12✔
604	safeGetPropId('location', notification)
605	).populate('entrance');
606	}
607	if (populatedNotification.massif) {	201✔
608	await NameService.setNames([populatedNotification.massif], 'massif');	10✔
609	}
610	if (populatedNotification.rigging) {	201✔
611	populatedNotification.rigging = await TRigging.findOne(	6✔
612	safeGetPropId('rigging', notification)
613	)
614	.populate('entrance')
615	.populate('cave');
616	}
617	return populatedNotification;	201✔
618	},
619	};

GrottoCenter / grottocenter-api / 25262918929

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous