chore: added profileUpdatedAt sql column and convo attrs

Author: Bilb

ts/data/data.ts

@@ -35,7 +35,6 @@ import {
   FindAllMessageHashesInConversationTypeArgs,
 } from './sharedDataTypes';
 import { GuardNode, Snode } from './types';
-import { makeMessageModels } from '../models/models';
 
 const ERASE_SQL_KEY = 'erase-sql-key';
 const ERASE_ATTACHMENTS_KEY = 'erase-attachments';
@@ -324,6 +323,10 @@ async function filterAlreadyFetchedOpengroupMessage(
   return msgDetailsNotAlreadyThere || [];
 }
 
+function makeMessageModels(modelsOrAttrs: Array<MessageAttributes>) {
+  return modelsOrAttrs.map(a => new MessageModel(a));
+}
+
 /**
  * Fetch all messages that match the sender pubkey and sent_at timestamp
  * @param propsList An array of objects containing a source (the sender id) and timestamp of the message - not to be confused with the serverTimestamp. This is equivalent to sent_at

ts/models/conversation.ts

@@ -149,6 +149,7 @@ import type {
   ConversationInteractionType,
 } from '../interactions/types';
 import type { LastMessageStatusType } from '../state/ducks/types';
+import { OutgoingUserProfile } from '../types/message';
 
 type InMemoryConvoInfos = {
   mentionedUs: boolean;
@@ -1596,14 +1597,59 @@ export class ConversationModel extends Model<ConversationAttributes> {
     return this.isPrivate() ? this.get('nickname') || undefined : undefined;
   }
 
+  /**
+   * Returns the profile key attributes of this instance.
+   * If the attribute is unset, empty, or not a string, returns `undefined`.
+   */
   public getProfileKey(): string | undefined {
-    return this.get('profileKey');
+    const profileKey = this.get('profileKey');
+    if (!profileKey || !isString(profileKey)) {
+      return undefined;
+    }
+    return profileKey;
   }
 
   public getAvatarPointer(): string | undefined {
     return this.get('avatarPointer');
   }
 
+  public getProfileUpdatedSeconds() {
+    if (!this.isPrivate()) {
+      throw new Error('Cannot call profileUpdatedSeconds for a non private conversation');
+    }
+    const profileUpdatedSeconds = this.get('profileUpdatedSeconds');
+    if (
+      !isNumber(profileUpdatedSeconds) ||
+      !isFinite(profileUpdatedSeconds) ||
+      profileUpdatedSeconds < 0
+    ) {
+      return 0;
+    }
+
+    return profileUpdatedSeconds;
+  }
+
+  /**
+   * A private profile can have name and profileUpdatedSeconds unset,
+   * but it must have both profilePicture and profileKey set for it to be returned
+   */
+  public getPrivateProfileDetails(): OutgoingUserProfile {
+    if (!this.isPrivate()) {
+      throw new Error('getPrivateProfileDetails can only be called on private conversations');
+    }
+    const avatarPointer = this.getAvatarPointer() ?? null;
+    const displayName = this.getRealSessionUsername() ?? '';
+    const profileKey = this.getProfileKey() ?? null;
+    const updatedAtSeconds = this.getProfileUpdatedSeconds();
+
+    return new OutgoingUserProfile({
+      avatarPointer,
+      displayName,
+      profileKey,
+      updatedAtSeconds,
+    });
+  }
+
   public setAvatarPointer(avatarPointer: string | undefined) {
     if (avatarPointer === this.getAvatarPointer()) {
       return;

ts/models/conversationAttributes.ts

@@ -92,21 +92,37 @@ export interface ConversationAttributes {
 
   displayNameInProfile?: string; // no matter the type of conversation, this is the real name as set by the user/name of the open or closed group
   nickname?: string; // this is the name WE gave to that user (only applicable to private chats, not closed group neither opengroups)
-  profileKey?: string; // Consider this being a hex string if it is set
-  triggerNotificationsFor: ConversationNotificationSettingType;
+  profileKey?: string; // If set, this is a hex string.
 
   /**
    * This is the url of the avatar on the file server v2 or sogs server.
    * We use this to detect if we need to re-download the avatar from someone/ a community.
    */
   avatarPointer?: string;
+  /**
+   * This is the timestamp of the last time the profile of that user was updated.
+   * Only used for private chats (or blinded), but not for groups avatars nor communities.
+   * An incoming avatarPointer & profileKey will only be applied if the provided
+   * profileUpdatedSeconds is more recent than the currently stored one.
+   */
+  profileUpdatedSeconds?: number;
+  triggerNotificationsFor: ConversationNotificationSettingType;
   /** in seconds, 0 means no expiration */
   expireTimer: number;
 
-  members: Array<string>; // groups only members are all members for this group (not used for communities)
-  groupAdmins: Array<string>; // for sogs and closed group: the unique admins of that group
+  /**
+   * Members of 03-groups and legacy groups until we remove them entirely (not used for communities)
+   */
+  members: Array<string>;
+  /**
+   * For sogs and closed group: the unique admins of that group
+   */
+  groupAdmins: Array<string>;
 
-  priority: number; // -1 = hidden (contact and NTS only), 0 = normal, 1 = pinned
+  /**
+   * -1 = hidden (contact and NTS only), 0 = normal, 1 = pinned
+   */
+  priority: number;
 
   isApproved: boolean; // if we sent a message request or sent a message to this contact, we approve them. If isApproved & didApproveMe, a message request becomes a contact
   didApproveMe: boolean; // if our message request was approved already (or they've sent us a message request/message themselves). If isApproved & didApproveMe, a message request becomes a contact

ts/models/models.ts

@@ -1,6 +1,4 @@
 import { assign, cloneDeep } from 'lodash';
-import { MessageModel } from './message';
-import type { MessageAttributes } from './messageType';
 
 export type ModelAttributes = Record<string, any> & { id: string };
 
@@ -45,7 +43,3 @@ export abstract class Model<T extends ModelAttributes> {
     return cloneDeep(this._attributes);
   }
 }
-
-export function makeMessageModels(modelsOrAttrs: Array<MessageAttributes>) {
-  return modelsOrAttrs.map(a => new MessageModel(a));
-}

ts/node/database_utility.ts

@@ -1,5 +1,5 @@
 import * as BetterSqlite3 from '@signalapp/better-sqlite3';
-import { difference, isNumber, omit, pick } from 'lodash';
+import { difference, isFinite, isNumber, omit, pick } from 'lodash';
 import {
   ConversationAttributes,
   ConversationAttributesWithNotSavedOnes,
@@ -59,6 +59,7 @@ const allowedKeysFormatRowOfConversation = [
   'lastMessageInteractionType',
   'lastMessageInteractionStatus',
   'triggerNotificationsFor',
+  'profileUpdatedSeconds',
   'unreadCount',
   'lastJoinedTimestamp',
   'expireTimer',
@@ -139,10 +140,14 @@ export function formatRowOfConversation(
     convo.lastMessageStatus = undefined;
   }
 
-  if (!isNumber(convo.blocksSogsMsgReqsTimestamp)) {
+  if (!isNumber(convo.blocksSogsMsgReqsTimestamp) || !isFinite(convo.blocksSogsMsgReqsTimestamp)) {
     convo.blocksSogsMsgReqsTimestamp = 0;
   }
 
+  if (!isNumber(convo.profileUpdatedSeconds) || !isFinite(convo.profileUpdatedSeconds)) {
+    convo.profileUpdatedSeconds = 0;
+  }
+
   if (!convo.lastMessageInteractionType) {
     convo.lastMessageInteractionType = null;
   }
@@ -189,6 +194,7 @@ const allowedKeysOfConversationAttributes = [
   'lastMessageInteractionType',
   'lastMessageInteractionStatus',
   'triggerNotificationsFor',
+  'profileUpdatedSeconds',
   'lastJoinedTimestamp',
   'expireTimer',
   'active_at',

ts/node/migration/sessionMigrations.ts

@@ -120,6 +120,7 @@ const LOKI_SCHEMA_VERSIONS: Array<
   updateToSessionSchemaVersion45,
   updateToSessionSchemaVersion46,
   updateToSessionSchemaVersion47,
+  updateToSessionSchemaVersion48,
 ];
 
 function updateToSessionSchemaVersion1(currentVersion: number, db: BetterSqlite3.Database) {
@@ -2181,6 +2182,24 @@ async function updateToSessionSchemaVersion47(currentVersion: number, db: Better
   console.log(`updateToSessionSchemaVersion${targetVersion}: success!`);
 }
 
+async function updateToSessionSchemaVersion48(currentVersion: number, db: BetterSqlite3.Database) {
+  const targetVersion = 48;
+  if (currentVersion >= targetVersion) {
+    return;
+  }
+  console.log(`updateToSessionSchemaVersion${targetVersion}: starting...`);
+
+  db.transaction(() => {
+    db.exec(`
+          ALTER TABLE ${CONVERSATIONS_TABLE} ADD COLUMN profileUpdatedSeconds INTEGER;
+         `);
+
+    writeSessionSchemaVersion(targetVersion, db);
+  })();
+
+  console.log(`updateToSessionSchemaVersion${targetVersion}: success!`);
+}
+
 export function printTableColumns(table: string, db: BetterSqlite3.Database) {
   console.info(db.pragma(`table_info('${table}');`));
 }

ts/node/sql.ts

@@ -476,6 +476,7 @@ function saveConversation(data: ConversationAttributes): SaveConversationReturn
     groupAdmins,
     avatarPointer,
     triggerNotificationsFor,
+    profileUpdatedSeconds,
     isTrustedForAttachmentDownload,
     isApproved,
     didApproveMe,
@@ -528,6 +529,7 @@ function saveConversation(data: ConversationAttributes): SaveConversationReturn
       groupAdmins: groupAdmins && groupAdmins.length ? arrayStrToJson(groupAdmins) : '[]',
       avatarPointer,
       triggerNotificationsFor,
+      profileUpdatedSeconds,
       isTrustedForAttachmentDownload: toSqliteBoolean(isTrustedForAttachmentDownload),
       priority,
       isApproved: toSqliteBoolean(isApproved),

ts/test/session/unit/models/ConversationModels_test.ts

@@ -129,6 +129,23 @@ describe('fillConvoAttributesWithDefaults', () => {
     });
   });
 
+  describe('profileUpdatedSeconds', () => {
+    it('initialize profileUpdatedSeconds if not given', () => {
+      expect(fillConvoAttributesWithDefaults({} as ConversationAttributes)).to.have.deep.property(
+        'profileUpdatedSeconds',
+        0
+      );
+    });
+
+    it('do not override profileUpdatedSeconds if given', () => {
+      expect(
+        fillConvoAttributesWithDefaults({
+          profileUpdatedSeconds: 1234,
+        } as ConversationAttributes)
+      ).to.have.deep.property('profileUpdatedSeconds', 1234);
+    });
+  });
+
   describe('isTrustedForAttachmentDownload', () => {
     it('initialize isTrustedForAttachmentDownload if not given', () => {
       expect(fillConvoAttributesWithDefaults({} as ConversationAttributes)).to.have.deep.property(

ts/types/message/index.ts

@@ -15,9 +15,12 @@ function extractPicDetailsFromUrl(src: string | null): ProfilePicture {
   }
   const url = urlParts[0];
   const key = urlParts[1];
+
+  // throwing here, as if src is not empty we expect a key to be set
   if (!isEmpty(key) && !isString(key)) {
     throw new Error('extractPicDetailsFromUrl: profileKey is set but not a string');
   }
+  // throwing here, as if src is not empty we expect an url to be set
   if (!isEmpty(url) && !isString(url)) {
     throw new Error('extractPicDetailsFromUrl: avatarPointer is set but not a string');
   }
@@ -46,7 +49,7 @@ class OutgoingUserProfile {
     updatedAtSeconds: number;
   } & (
     | { picUrlWithProfileKey: string | null }
-    | { profileKey: Uint8Array | null; avatarPointer: string | null }
+    | { profileKey: Uint8Array | string | null; avatarPointer: string | null }
   )) {
     if (!isString(displayName)) {
       throw new Error('displayName is not a string');
@@ -80,16 +83,21 @@ class OutgoingUserProfile {
   }
 
   private initFromPicDetails({
-    profileKey,
+    profileKey: profileKeyIn,
     avatarPointer,
   }: {
-    profileKey: Uint8Array | null;
+    profileKey: Uint8Array | string | null;
     avatarPointer: string | null;
   }) {
-    if (!profileKey && !avatarPointer) {
+    if (!profileKeyIn && !avatarPointer) {
       this.picUrlWithProfileKey = null;
       return;
     }
+    if (profileKeyIn && !isString(profileKeyIn) && !isTypedArray(profileKeyIn)) {
+      throw new Error('profileKey must be a string or a Uint8Array if set');
+    }
+    // check if the profileKey is a string, and if so, convert it to a Uint8Array
+    const profileKey = isString(profileKeyIn) ? from_hex(profileKeyIn) : profileKeyIn;
     if (
       !profileKey ||
       isEmpty(profileKey) ||