aaron/mattermost-desktop
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Improve notification logging (#3040) (#3058)

Browse source 
(cherry picked from commit 9c6d809682)

Co-authored-by: Devin Binnie <52460000+devinbinnie@users.noreply.github.com>
This commit is contained in:
Mattermost Build 2024-06-10 17:03:37 +03:00 committed by GitHub
parent af3b1d262e
commit 84a3a1596c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/main/notifications/index.ts
View file

@ -28,7 +28,7 @@ class NotificationManager {
private restartToUpgradeNotification?: UpgradeNotification; private restartToUpgradeNotification?: UpgradeNotification;
public async displayMention(title: string, body: string, channelId: string, teamId: string, url: string, silent: boolean, webcontents: Electron.WebContents, soundName: string) { public async displayMention(title: string, body: string, channelId: string, teamId: string, url: string, silent: boolean, webcontents: Electron.WebContents, soundName: string) {
log.debug('displayMention', {title, body, channelId, teamId, url, silent, soundName}); log.debug('displayMention', {title, channelId, teamId, url, silent, soundName});
if (!Notification.isSupported()) { if (!Notification.isSupported()) {
log.error('notification not supported'); log.error('notification not supported');
@ -36,17 +36,20 @@ class NotificationManager {
} }
if (await getDoNotDisturb()) { if (await getDoNotDisturb()) {
log.debug('do not disturb is on, will not send');
return {status: 'not_sent', reason: 'os_dnd'}; return {status: 'not_sent', reason: 'os_dnd'};
} }
const view = ViewManager.getViewByWebContentsId(webcontents.id); const view = ViewManager.getViewByWebContentsId(webcontents.id);
if (!view) { if (!view) {
log.error('missing view', webcontents.id);
return {status: 'error', reason: 'missing_view'}; return {status: 'error', reason: 'missing_view'};
} }
const serverName = view.view.server.name;
if (!view.view.shouldNotify) { if (!view.view.shouldNotify) {
log.debug('should not notify for this view', webcontents.id);
return {status: 'not_sent', reason: 'view_should_not_notify'}; return {status: 'not_sent', reason: 'view_should_not_notify'};
} }
const serverName = view.view.server.name;
const options = { const options = {
title: `${serverName}: ${title}`, title: `${serverName}: ${title}`,
@ -56,15 +59,15 @@ class NotificationManager {
}; };
if (!await PermissionsManager.doPermissionRequest(webcontents.id, 'notifications', {requestingUrl: view.view.server.url.toString(), isMainFrame: false})) { if (!await PermissionsManager.doPermissionRequest(webcontents.id, 'notifications', {requestingUrl: view.view.server.url.toString(), isMainFrame: false})) {
log.verbose('permissions disallowed', webcontents.id, serverName, view.view.server.url.toString());
return {status: 'not_sent', reason: 'notifications_permission_disallowed'}; return {status: 'not_sent', reason: 'notifications_permission_disallowed'};
} }
const mention = new Mention(options, channelId, teamId); const mention = new Mention(options, channelId, teamId);
const mentionKey = `${mention.teamId}:${mention.channelId}`;
this.allActiveNotifications.set(mention.uId, mention); this.allActiveNotifications.set(mention.uId, mention);
mention.on('click', () => { mention.on('click', () => {
log.debug('notification click', serverName, mention); log.debug('notification click', serverName, mention.uId);
this.allActiveNotifications.delete(mention.uId); this.allActiveNotifications.delete(mention.uId);
@ -86,14 +89,16 @@ class NotificationManager {
return new Promise((resolve) => { return new Promise((resolve) => {
// If mention never shows somehow, resolve the promise after 10s // If mention never shows somehow, resolve the promise after 10s
const timeout = setTimeout(() => { const timeout = setTimeout(() => {
log.debug('notification timeout', serverName, mention.uId);
resolve({status: 'error', reason: 'notification_timeout'}); resolve({status: 'error', reason: 'notification_timeout'});
}, 10000); }, 10000);
mention.on('show', () => { mention.on('show', () => {
log.debug('displayMention.show'); log.debug('displayMention.show', serverName, mention.uId);
// On Windows, manually dismiss notifications from the same channel and only show the latest one // On Windows, manually dismiss notifications from the same channel and only show the latest one
if (process.platform === 'win32') { if (process.platform === 'win32') {
const mentionKey = `${mention.teamId}:${mention.channelId}`;
if (this.mentionsPerChannel.has(mentionKey)) { if (this.mentionsPerChannel.has(mentionKey)) {
log.debug(`close ${mentionKey}`); log.debug(`close ${mentionKey}`);
this.mentionsPerChannel.get(mentionKey)?.close(); this.mentionsPerChannel.get(mentionKey)?.close();
@ -113,6 +118,7 @@ class NotificationManager {
mention.on('failed', (_, error) => { mention.on('failed', (_, error) => {
this.allActiveNotifications.delete(mention.uId); this.allActiveNotifications.delete(mention.uId);
clearTimeout(timeout); clearTimeout(timeout);
log.error('notification failed to show', serverName, mention.uId, error);
resolve({status: 'error', reason: 'electron_notification_failed', data: error}); resolve({status: 'error', reason: 'electron_notification_failed', data: error});
}); });
mention.show(); mention.show();