Merge pull request #1284 from Bilb/fix-ttl-ugly-hack

ts/session/constants.ts

@@ -1,13 +1,18 @@
-import { NumberUtils } from './utils';
+import { DAYS, HOURS, MINUTES } from './utils/Number';
+// tslint:disable: binary-expression-operand-order
 
-// Default TTL
+/**
+ * FIXME The -1 hours is a hack to make the PN not trigger a Notification for those control message.
+ * Apple devices must show a Notification if a PN is received, and for those
+ * control message, there is nothing to display (yet).
+ */
 export const TTL_DEFAULT = {
-  PAIRING_REQUEST: NumberUtils.timeAsMs(2, 'minutes'),
+  PAIRING_REQUEST: 2 * MINUTES,
-  DEVICE_UNPAIRING: NumberUtils.timeAsMs(4, 'days'),
+  DEVICE_UNPAIRING: 4 * DAYS - 1 * HOURS,
-  SESSION_REQUEST: NumberUtils.timeAsMs(4, 'days'),
+  SESSION_REQUEST: 4 * DAYS - 1 * HOURS,
-  SESSION_ESTABLISHED: NumberUtils.timeAsMs(2, 'days'),
+  SESSION_ESTABLISHED: 2 * DAYS - 1 * HOURS,
-  END_SESSION_MESSAGE: NumberUtils.timeAsMs(4, 'days'),
+  END_SESSION_MESSAGE: 4 * DAYS - 1 * HOURS,
-  TYPING_MESSAGE: NumberUtils.timeAsMs(1, 'minute'),
+  TYPING_MESSAGE: 1 * MINUTES,
-  ONLINE_BROADCAST: NumberUtils.timeAsMs(1, 'minute'),
+  ONLINE_BROADCAST: 1 * MINUTES,
-  REGULAR_MESSAGE: NumberUtils.timeAsMs(2, 'days'),
+  REGULAR_MESSAGE: 2 * DAYS,
 };

ts/session/messages/outgoing/content/ContentMessage.ts

@@ -9,12 +9,4 @@ export abstract class ContentMessage extends Message {
 
   public abstract ttl(): number;
   protected abstract contentProto(): SignalService.Content;
-
-  /**
-   * If the message is not a message with a specific TTL,
-   * this value can be used in all child classes
-   */
-  protected getDefaultTTL(): number {
-    return Constants.TTL_DEFAULT.REGULAR_MESSAGE;
-  }
 }

ts/session/messages/outgoing/content/SessionRequestMessage.ts

@@ -25,14 +25,8 @@ export class SessionRequestMessage extends ContentMessage {
     this.preKeyBundle = params.preKeyBundle;
   }
 
-  public static defaultTTL(): number {
-    // Gets the default TTL for Session Request, as
-    // public static readonly ttl: number <-- cannot be assigned a non-literal
-    return Constants.TTL_DEFAULT.SESSION_REQUEST;
-  }
-
   public ttl(): number {
-    return SessionRequestMessage.defaultTTL();
+    return Constants.TTL_DEFAULT.SESSION_REQUEST;
   }
 
   protected getPreKeyBundleMessage(): SignalService.PreKeyBundleMessage {

ts/session/messages/outgoing/content/data/ChatMessage.ts

@@ -3,6 +3,7 @@ import { SignalService } from '../../../../../protobuf';
 import { MessageParams } from '../../Message';
 import { LokiProfile } from '../../../../../types/Message';
 import ByteBuffer from 'bytebuffer';
+import { Constants } from '../../../..';
 
 export interface AttachmentPointer {
   id?: number;
@@ -75,7 +76,7 @@ export class ChatMessage extends DataMessage {
   }
 
   public ttl(): number {
-    return this.getDefaultTTL();
+    return Constants.TTL_DEFAULT.REGULAR_MESSAGE;
   }
 
   public dataProto(): SignalService.DataMessage {

ts/session/messages/outgoing/content/data/ExpirationTimerUpdateMessage.ts

@@ -4,6 +4,7 @@ import { MessageParams } from '../../Message';
 import { StringUtils } from '../../../../utils';
 import { DataMessage } from './DataMessage';
 import { PubKey } from '../../../../types';
+import { Constants } from '../../../..';
 
 interface ExpirationTimerUpdateMessageParams extends MessageParams {
   groupId?: string | PubKey;
@@ -26,7 +27,7 @@ export class ExpirationTimerUpdateMessage extends DataMessage {
   }
 
   public ttl(): number {
-    return this.getDefaultTTL();
+    return Constants.TTL_DEFAULT.REGULAR_MESSAGE;
   }
 
   public dataProto(): SignalService.DataMessage {

ts/session/messages/outgoing/content/data/GroupInvitationMessage.ts

@@ -1,6 +1,7 @@
 import { DataMessage } from './DataMessage';
 import { SignalService } from '../../../../../protobuf';
 import { MessageParams } from '../../Message';
+import { Constants } from '../../../..';
 
 interface GroupInvitationMessageParams extends MessageParams {
   serverAddress: string;
@@ -21,7 +22,7 @@ export class GroupInvitationMessage extends DataMessage {
   }
 
   public ttl(): number {
-    return this.getDefaultTTL();
+    return Constants.TTL_DEFAULT.REGULAR_MESSAGE;
   }
 
   public dataProto(): SignalService.DataMessage {

ts/session/messages/outgoing/content/data/group/ClosedGroupChatMessage.ts

@@ -2,6 +2,7 @@ import { SignalService } from '../../../../../../protobuf';
 import { ChatMessage } from '../ChatMessage';
 import { ClosedGroupMessage } from './ClosedGroupMessage';
 import { PubKey } from '../../../../../types';
+import { Constants } from '../../../../..';
 
 interface ClosedGroupChatMessageParams {
   identifier?: string;
@@ -22,7 +23,7 @@ export class ClosedGroupChatMessage extends ClosedGroupMessage {
   }
 
   public ttl(): number {
-    return this.getDefaultTTL();
+    return Constants.TTL_DEFAULT.REGULAR_MESSAGE;
   }
 
   public dataProto(): SignalService.DataMessage {

ts/session/messages/outgoing/content/data/group/ClosedGroupMessage.ts

@@ -3,6 +3,7 @@ import { SignalService } from '../../../../../../protobuf';
 import { MessageParams } from '../../../Message';
 import { PubKey } from '../../../../../types';
 import { StringUtils } from '../../../../../utils';
+import { Constants } from '../../../../..';
 
 export interface ClosedGroupMessageParams extends MessageParams {
   groupId: string | PubKey;
@@ -20,7 +21,7 @@ export abstract class ClosedGroupMessage extends DataMessage {
   }
 
   public ttl(): number {
-    return this.getDefaultTTL();
+    return Constants.TTL_DEFAULT.REGULAR_MESSAGE;
   }
 
   public dataProto(): SignalService.DataMessage {

ts/session/messages/outgoing/content/data/mediumgroup/MediumGroupMessage.ts

@@ -3,6 +3,7 @@ import { SignalService } from '../../../../../../protobuf';
 import { MessageParams } from '../../../Message';
 import { PubKey } from '../../../../../types';
 import { StringUtils } from '../../../../../utils';
+import { Constants } from '../../../../..';
 
 export interface RatchetKey {
   chainKey: Uint8Array;
@@ -26,7 +27,7 @@ export abstract class MediumGroupMessage extends DataMessage {
   }
 
   public ttl(): number {
-    return this.getDefaultTTL();
+    return Constants.TTL_DEFAULT.REGULAR_MESSAGE;
   }
 
   public dataProto(): SignalService.DataMessage {

ts/session/messages/outgoing/content/receipt/ReceiptMessage.ts

@@ -1,6 +1,7 @@
 import { ContentMessage } from '../ContentMessage';
 import { SignalService } from '../../../../../protobuf';
 import { MessageParams } from '../../Message';
+import { Constants } from '../../../..';
 
 interface ReceiptMessageParams extends MessageParams {
   timestamps: Array<number>;
@@ -14,7 +15,7 @@ export abstract class ReceiptMessage extends ContentMessage {
   }
 
   public ttl(): number {
-    return this.getDefaultTTL();
+    return Constants.TTL_DEFAULT.REGULAR_MESSAGE;
   }
 
   public abstract getReceiptType(): SignalService.ReceiptMessage.Type;

ts/session/messages/outgoing/content/sync/RequestSyncMessage.ts

@@ -1,6 +1,7 @@
 import { SyncMessage } from './SyncMessage';
 import { SignalService } from '../../../../../protobuf';
 import { MessageParams } from '../../Message';
+import { Constants } from '../../../..';
 
 interface RequestSyncMessageParams extends MessageParams {
   requestType: SignalService.SyncMessage.Request.Type;
@@ -15,7 +16,7 @@ export abstract class RequestSyncMessage extends SyncMessage {
   }
 
   public ttl(): number {
-    return this.getDefaultTTL();
+    return Constants.TTL_DEFAULT.REGULAR_MESSAGE;
   }
 
   protected contentProto(): SignalService.Content {

ts/session/messages/outgoing/content/sync/SyncMessage.ts

@@ -1,10 +1,11 @@
 import { ContentMessage } from '../ContentMessage';
 import { SignalService } from '../../../../../protobuf';
 import * as crypto from 'crypto';
+import { Constants } from '../../../..';
 
 export abstract class SyncMessage extends ContentMessage {
   public ttl(): number {
-    return this.getDefaultTTL();
+    return Constants.TTL_DEFAULT.REGULAR_MESSAGE;
   }
 
   protected contentProto(): SignalService.Content {

ts/session/protocols/SessionProtocol.ts

@@ -3,6 +3,7 @@ import { createOrUpdateItem, getItemById } from '../../../js/modules/data';
 import { MessageSender } from '../sending';
 import { MessageUtils } from '../utils';
 import { PubKey } from '../types';
+import { Constants } from '..';
 
 interface StringToNumberMap {
   [key: string]: number;
@@ -81,7 +82,7 @@ export class SessionProtocol {
     const now = Date.now();
     const sentTimestamps = Object.entries(this.sentSessionsTimestamp);
     const promises = sentTimestamps.map(async ([device, sent]) => {
-      const expireTime = sent + SessionRequestMessage.defaultTTL();
+      const expireTime = sent + Constants.TTL_DEFAULT.SESSION_REQUEST;
       // Check if we need to send a session request
       if (now < expireTime) {
         return;

ts/session/utils/Number.ts

@@ -8,24 +8,10 @@ type TimeUnit =
   | 'day'
   | 'days';
 
-export const timeAsMs = (value: number, unit: TimeUnit) => {
+export const MINUTES = 60 * 1000; // in ms
-  // Converts a time to milliseconds
+// tslint:disable: binary-expression-operand-order
-  // Valid units: second, minute, hour, day
+export const HOURS = 60 * MINUTES; // in ms
-  const unitAsSingular = unit.replace(new RegExp('s?$'), '');
+export const DAYS = 24 * HOURS; // in ms
-
-  switch (unitAsSingular) {
-    case 'second':
-      return value * 1000;
-    case 'minute':
-      return value * 60 * 1000;
-    case 'hour':
-      return value * 60 * 60 * 1000;
-    case 'day':
-      return value * 24 * 60 * 60 * 1000;
-    default:
-      return value;
-  }
-};
 
 export const msAsUnit = (value: number, unit: TimeUnit) => {
   // Converts milliseconds to your preferred unit

ts/test/session/protocols/SessionProtocol_test.ts

@@ -7,6 +7,7 @@ import { SessionRequestMessage } from '../../../session/messages/outgoing';
 import { TextEncoder } from 'util';
 import { MessageSender } from '../../../session/sending';
 import { PubKey } from '../../../session/types';
+import { Constants } from '../../../session';
 
 // tslint:disable-next-line: max-func-body-length
 describe('SessionProtocol', () => {
@@ -124,7 +125,7 @@ describe('SessionProtocol', () => {
       });
 
       // Set the time just before expiry
-      clock.tick(SessionRequestMessage.defaultTTL() - 100);
+      clock.tick(Constants.TTL_DEFAULT.SESSION_REQUEST - 100);
 
       await SessionProtocol.checkSessionRequestExpiry();
       expect(getItemById.calledWith('sentSessionsTimestamp'));
@@ -140,7 +141,7 @@ describe('SessionProtocol', () => {
       });
 
       // Expire the request
-      clock.tick(SessionRequestMessage.defaultTTL() + 100);
+      clock.tick(Constants.TTL_DEFAULT.SESSION_REQUEST + 100);
 
       await SessionProtocol.checkSessionRequestExpiry();
       expect(getItemById.calledWith('sentSessionsTimestamp'));
@@ -159,7 +160,7 @@ describe('SessionProtocol', () => {
       sandbox.stub(SessionProtocol, 'sendSessionRequestIfNeeded').resolves();
 
       // Expire the request
-      clock.tick(SessionRequestMessage.defaultTTL() + 100);
+      clock.tick(Constants.TTL_DEFAULT.SESSION_REQUEST + 100);
 
       await SessionProtocol.checkSessionRequestExpiry();
       expect(getItemById.calledWith('sentSessionsTimestamp'));