fix: renew now cares about if the fs ttl was 30s

Author: Bilb

ts/interactions/avatar-interactions/nts-avatar-interactions.ts

@@ -10,7 +10,7 @@ import {
   UserConfigWrapperActions,
 } from '../../webworker/workers/browser/libsession_worker_interface';
 import { UserUtils } from '../../session/utils';
-import { fromBase64ToArray } from '../../session/utils/String';
+import { fromHexToArray } from '../../session/utils/String';
 
 export async function uploadAndSetOurAvatarShared({
   decryptedAvatarData,
@@ -43,10 +43,10 @@ export async function uploadAndSetOurAvatarShared({
     encryptionKey = encryptedContent.encryptionKey;
   } else {
     // if this is a reupload, reuse the current profile key. Otherwise generate a new one
-    const existingProfileKey = ourConvo.getProfileKey();
+    const existingProfileKeyHex = ourConvo.getProfileKeyHex();
     const profileKey =
-      context === 'reuploadAvatar' && existingProfileKey
-        ? fromBase64ToArray(existingProfileKey)
+      context === 'reuploadAvatar' && existingProfileKeyHex
+        ? fromHexToArray(existingProfileKeyHex)
         : randombytes_buf(32);
     encryptedData = await encryptProfile(mainAvatarDetails.outputBuffer, profileKey);
     encryptionKey = profileKey;
@@ -103,6 +103,6 @@ export async function uploadAndSetOurAvatarShared({
 
   return {
     avatarPointer: ourConvo.getAvatarPointer(),
-    profileKey: ourConvo.getProfileKey(),
+    profileKey: ourConvo.getProfileKeyHex(),
   };
 }

ts/models/conversation.ts

@@ -215,16 +215,9 @@ type SetSessionProfileReturn = {
  * We need to do some extra processing for private actions, as they have a updatedAtSeconds field.
  */
 function isSetProfileWithUpdatedAtSeconds<T extends SetSessionProfileDetails>(
-  _action: T
-): _action is Extract<T, { profileUpdatedAtSeconds: number }> {
-  /**
-   * We temporarily want to not write the profileUpdatedAtSeconds as we want this behavior to
-   * be used only once a user has updated their profile picture (and resized it).
-   */
-  window.log.debug('isSetProfileWithUpdatedAtSeconds forced to return false for now');
-  return false;
-
-  // return 'profileUpdatedAtSeconds' in action;
+  action: T
+): action is Extract<T, { profileUpdatedAtSeconds: number }> {
+  return 'profileUpdatedAtSeconds' in action;
 }
 
 /**
@@ -1545,7 +1538,7 @@ export class ConversationModel extends Model<ConversationAttributes> {
             this.getAvatarInProfilePath() ||
             this.getFallbackAvatarInProfilePath() ||
             this.getAvatarPointer() ||
-            this.getProfileKey()
+            this.getProfileKeyHex()
           ) {
             this.set({
               avatarInProfile: undefined,
@@ -1573,7 +1566,7 @@ export class ConversationModel extends Model<ConversationAttributes> {
           : to_hex(newProfile.profileKey);
 
         const existingAvatarPointer = this.getAvatarPointer();
-        const existingProfileKeyHex = this.getProfileKey();
+        const existingProfileKeyHex = this.getProfileKeyHex();
         const hasAvatarInNewProfile = !!newProfile.avatarPointer || !!newProfileKeyHex;
         // if no changes are needed, return early
         if (
@@ -1603,7 +1596,7 @@ export class ConversationModel extends Model<ConversationAttributes> {
           : to_hex(newProfile.profileKey);
 
         const existingAvatarPointer = this.getAvatarPointer();
-        const existingProfileKeyHex = this.getProfileKey();
+        const existingProfileKeyHex = this.getProfileKeyHex();
         const originalAvatar = this.getAvatarInProfilePath();
         const originalFallbackAvatar = this.getFallbackAvatarInProfilePath();
 
@@ -1730,7 +1723,7 @@ export class ConversationModel extends Model<ConversationAttributes> {
    * Returns the profile key attributes of this instance.
    * If the attribute is unset, empty, or not a string, returns `undefined`.
    */
-  public getProfileKey(): string | undefined {
+  public getProfileKeyHex(): string | undefined {
     const profileKey = this.get('profileKey');
     if (!profileKey || !isString(profileKey)) {
       return undefined;
@@ -1768,11 +1761,11 @@ export class ConversationModel extends Model<ConversationAttributes> {
     }
     const avatarPointer = this.getAvatarPointer() ?? null;
     const displayName = this.getRealSessionUsername() ?? '';
-    const profileKey = this.getProfileKey() ?? null;
+    const profileKeyHex = this.getProfileKeyHex() ?? null;
     const updatedAtSeconds = this.getProfileUpdatedSeconds();
 
     return new OutgoingUserProfile({
-      profilePic: { url: avatarPointer, key: profileKey ? from_hex(profileKey) : null },
+      profilePic: { url: avatarPointer, key: profileKeyHex ? from_hex(profileKeyHex) : null },
       displayName,
       updatedAtSeconds,
     });

ts/session/apis/file_server_api/FileServerApi.ts

@@ -197,30 +197,28 @@ export const getLatestReleaseFromFileServer = async (
  *
  */
 export const extendFileExpiry = async (fileId: string, fsTarget: FILE_SERVER_TARGET_TYPE) => {
-  // TODO: remove this once QA is done
-
-  if (!FS.supportsFsExtend(fsTarget)) {
-    throw new Error('extendFileExpiry: only works with potato for now');
-  }
   if (window.sessionFeatureFlags?.debugServerRequests) {
     window.log.info(`about to renew expiry of file: "${fileId}"`);
   }
 
   const method = 'POST';
   const endpoint = `/file/${fileId}/extend`;
+  const headers: Record<string, string> = window.sessionFeatureFlags.fsTTL30s
+    ? { 'X-FS-TTL': '30' }
+    : {};
   const params = {
     abortSignal: new AbortController().signal,
     endpoint,
     method,
     stringifiedBody: null,
-    headers: {},
+    headers,
     timeoutMs: 10 * DURATION.SECONDS,
     target: fsTarget,
   };
 
   const result = await OnionSending.sendJsonViaOnionV4ToFileServer(params);
 
-  if (!batchGlobalIsSuccess(result) || OnionV4.parseStatusCodeFromV4Request(result) !== 200) {
+  if (!batchGlobalIsSuccess(result)) {
     return null;
   }
 

ts/session/apis/snode_api/swarm_polling_config/SwarmPollingGroupConfig.ts

@@ -279,7 +279,7 @@ async function scheduleAvatarDownloadJobIfNeeded(groupPk: GroupPubkeyType) {
 
     if (!profileUrl || !profileKeyHex) {
       // no avatar set for this group: make sure we also remove the one we might have locally.
-      if (conversation.getAvatarPointer() || conversation.getProfileKey()) {
+      if (conversation.getAvatarPointer() || conversation.getProfileKeyHex()) {
         await conversation.setSessionProfile({
           type: 'resetAvatarGroup',
           displayName: null,
@@ -291,7 +291,7 @@ async function scheduleAvatarDownloadJobIfNeeded(groupPk: GroupPubkeyType) {
 
     // here, an avatar for this group is set. First we need to make sure if that's the same as we already have
     const prevPointer = conversation.getAvatarPointer();
-    const prevProfileKey = conversation.getProfileKey();
+    const prevProfileKey = conversation.getProfileKeyHex();
 
     if (prevPointer !== profileUrl || prevProfileKey !== profileKeyHex) {
       // set the avatar for this group, it will be downloaded by the job scheduled below

ts/session/utils/job_runners/jobs/AvatarDownloadJob.ts

@@ -36,7 +36,7 @@ export function shouldAddAvatarDownloadJob({ conversationId }: { conversationId:
     return false;
   }
   const prevPointer = conversation.getAvatarPointer();
-  const profileKey = conversation.getProfileKey();
+  const profileKey = conversation.getProfileKeyHex();
   const hasNoAvatar = isEmpty(prevPointer) || isEmpty(profileKey);
 
   if (hasNoAvatar) {
@@ -111,7 +111,7 @@ class AvatarDownloadJob extends PersistedJob<AvatarDownloadPersistedData> {
     }
     let changes = false;
     const toDownloadPointer = conversation.getAvatarPointer();
-    const toDownloadProfileKey = conversation.getProfileKey();
+    const toDownloadProfileKey = conversation.getProfileKeyHex();
 
     // if there is an avatar and profileKey for that user/group ('', null and undefined excluded), download, decrypt and save the avatar locally.
     if (toDownloadPointer && toDownloadProfileKey) {

ts/session/utils/job_runners/jobs/AvatarMigrateJob.ts

@@ -109,7 +109,7 @@ class AvatarMigrateJob extends PersistedJob<AvatarMigratePersistedData> {
       window.log.warn('AvatarMigrateJob: no avatar pointer found for conversation');
       return RunJobResult.Success;
     }
-    const existingProfileKeyHex = conversation.getProfileKey();
+    const existingProfileKeyHex = conversation.getProfileKeyHex();
     if (!existingProfileKeyHex) {
       window.log.warn('AvatarMigrateJob: no profileKey found for conversation');
       return RunJobResult.Success;

ts/session/utils/job_runners/jobs/AvatarReuploadJob.ts

@@ -1,3 +1,4 @@
+import { from_hex } from 'libsodium-wrappers-sumo';
 import { isNumber } from 'lodash';
 import { v4 } from 'uuid';
 import { UserUtils } from '../..';
@@ -19,7 +20,6 @@ import { maxAvatarDetails } from '../../../../util/attachment/attachmentSizes';
 import { UserConfigWrapperActions } from '../../../../webworker/workers/browser/libsession_worker_interface';
 import { extendFileExpiry } from '../../../apis/file_server_api/FileServerApi';
 import { fileServerUrlToFileId } from '../../../apis/file_server_api/types';
-import { NetworkTime } from '../../../../util/NetworkTime';
 import { DURATION, DURATION_SECONDS } from '../../../constants';
 import { uploadAndSetOurAvatarShared } from '../../../../interactions/avatar-interactions/nts-avatar-interactions';
 import { FS } from '../../../apis/file_server_api/FileServerTarget';
@@ -63,6 +63,39 @@ async function fetchLocalAvatarDetails(currentMainPath: string) {
   }
 }
 
+/**
+ * Returns the current timestamp in seconds.
+ * Note: this is not the network time, but our local time with an offset, potentially.
+ * We want to use that one here, as the UserProfile actions are not based on the network timestamp either.k
+ */
+function nowSeconds() {
+  return Math.floor(Date.now() / 1000);
+}
+
+function shouldSkipRenew({
+  ourProfileLastUpdatedSeconds,
+}: {
+  ourProfileLastUpdatedSeconds: number;
+}) {
+  if (window.sessionFeatureFlags.fsTTL30s) {
+    // this is in dev
+    return Date.now() / 1000 - ourProfileLastUpdatedSeconds <= 10 * DURATION_SECONDS.SECONDS;
+  }
+  // this is in prod
+  return nowSeconds() - ourProfileLastUpdatedSeconds <= 2 * DURATION_SECONDS.HOURS;
+}
+
+function shouldSkipReupload({
+  ourProfileLastUpdatedSeconds,
+}: {
+  ourProfileLastUpdatedSeconds: number;
+}) {
+  if (window.sessionFeatureFlags.fsTTL30s) {
+    return nowSeconds() - ourProfileLastUpdatedSeconds <= 10 * DURATION_SECONDS.SECONDS;
+  }
+  return nowSeconds() - ourProfileLastUpdatedSeconds <= 12 * DURATION_SECONDS.DAYS;
+}
+
 class AvatarReuploadJob extends PersistedJob<AvatarReuploadPersistedData> {
   constructor({
     conversationId,
@@ -91,7 +124,7 @@ class AvatarReuploadJob extends PersistedJob<AvatarReuploadPersistedData> {
   public async run(): Promise<RunJobResult> {
     const convoId = this.persistedData.conversationId;
     window.log.debug(
-      `running job ${this.persistedData.jobType} id:"${this.persistedData.identifier}" `
+      `[avatarReupload] running job ${this.persistedData.jobType} id:"${this.persistedData.identifier}" `
     );
 
     if (!this.persistedData.identifier) {
@@ -104,14 +137,14 @@ class AvatarReuploadJob extends PersistedJob<AvatarReuploadPersistedData> {
     let conversation = ConvoHub.use().get(convoId);
     if (!conversation || !conversation.isMe()) {
       // Note: if we add the groupv2 case here, we'd need to add a profile_updated timestamp to the metagroup wrapper
-      window.log.warn('AvatarReuploadJob did not find corresponding conversation, or not us');
+      window.log.warn('[avatarReupload] did not find corresponding conversation, or not us');
 
       return RunJobResult.PermanentFailure;
     }
     const ourProfileLastUpdatedSeconds = await UserConfigWrapperActions.getProfileUpdatedSeconds();
     const currentMainPath = conversation.getAvatarInProfilePath();
     const avatarPointer = conversation.getAvatarPointer();
-    const profileKey = conversation.getProfileKey();
+    const profileKey = conversation.getProfileKeyHex();
     const { fileId, fullUrl } = fileServerUrlToFileId(avatarPointer);
     if (!currentMainPath || !avatarPointer || !profileKey || !fullUrl) {
       // we do not have an avatar to reupload, nothing to do.
@@ -130,58 +163,84 @@ class AvatarReuploadJob extends PersistedJob<AvatarReuploadPersistedData> {
       if (
         ourProfileLastUpdatedSeconds !== 0 &&
         metadata.width <= maxAvatarDetails.maxSidePlanReupload &&
-        metadata.height <= maxAvatarDetails.maxSidePlanReupload &&
-        metadata.format === 'webp'
+        metadata.height <= maxAvatarDetails.maxSidePlanReupload
       ) {
         const target = FS.fileUrlToFileTarget(fullUrl?.toString());
         window.log.debug(
-          `[avatarReupload] main avatar is already the right size and format for ${ed25519Str(conversation.id)}, just renewing it on fs: ${target}`
+          `[avatarReupload] main avatar is already the right size for ${ed25519Str(conversation.id)} target:${target}`
+        );
+        if (shouldSkipRenew({ ourProfileLastUpdatedSeconds })) {
+          // we don't want to call `renew` too often. Only once every 2hours (or more when the fsTTL30s feature is enabled)
+          window.log.debug(
+            `[avatarReupload] not trying to renew avatar for ${ed25519Str(conversation.id)} of file ${fileId} as we did one recently`
+          );
+          // considering this to be a success
+          return RunJobResult.Success;
+        }
+        window.log.debug(
+          `[avatarReupload] renewing avatar on fs: ${target} for ${ed25519Str(conversation.id)} and file:${fileId}`
         );
         const expiryRenewResult = await extendFileExpiry(fileId, target);
 
         if (expiryRenewResult) {
           window.log.debug(
-            `[avatarReupload] expiry renew for ${ed25519Str(conversation.id)} of file ${fileId} was successful`
+            `[avatarReupload] expiry renew for ${ed25519Str(conversation.id)} of file:${fileId} on fs: ${target} was successful`
           );
+
+          await UserConfigWrapperActions.getProfilePic();
+
+          await UserConfigWrapperActions.setReuploadProfilePic({
+            key: from_hex(profileKey),
+            url: avatarPointer,
+          });
+
           return RunJobResult.Success;
         }
+        window.log.debug(
+          `[avatarReupload] expiry renew for ${ed25519Str(conversation.id)} of file:${fileId} on fs: ${target} failed`
+        );
+
+        // AUDRIC: expiry renew for (...efb27b5b) of file:Ff1CvAQIo1BXCeoV3DwTjYEzSoBPZW56FeExk8qij79h on fs: POTATO failed
+        // keep failing even whe it shouldnt
 
-        if (ourProfileLastUpdatedSeconds > NetworkTime.nowSeconds() - 12 * DURATION_SECONDS.DAYS) {
-          // `renew` failed but our last reupload was less than 12 days ago, so we don't want to retry
+        if (shouldSkipReupload({ ourProfileLastUpdatedSeconds })) {
           window.log.debug(
-            `[avatarReupload] expiry renew for ${ed25519Str(conversation.id)} of file ${fileId} failed but our last reupload was less than 12 days ago, so we don't want to retry`
+            `[avatarReupload] ${ed25519Str(conversation.id)} last reupload was recent enough, so we don't want to reupload it`
           );
           // considering this to be a success
           return RunJobResult.Success;
         }
-        // renew failed, but our last reupload was more than 12 days ago, so we want to reprocess and
-        // reupload our current avatar, see below
+        // renew failed, and our last reupload was not too recent, so we want to reprocess and
+        // reupload our current avatar, see below...
       }
 
       // here,
       // - either the format or the size is wrong
       // - or we do not have a ourProfileLastUpdatedSeconds yet
-      // - or the expiry renew failed and our last reupload was more than 12 days ago
+      // - or the expiry renew failed and our last reupload not recent
       // In all those cases, we want to reprocess our current avatar, and reupload it.
 
-      window.log.info(`[profileupdate] about to auto scale avatar for convo ${conversation.id}`);
+      window.log.info(
+        `[avatarReupload] about to auto scale avatar for convo ${ed25519Str(conversation.id)}`
+      );
 
       conversation = ConvoHub.use().getOrThrow(convoId);
 
       // Reprocess the avatar content, and reupload it
       // This will pick the correct file server depending on the env variables set.
-      await uploadAndSetOurAvatarShared({
+      const details = await uploadAndSetOurAvatarShared({
         decryptedAvatarData,
         ourConvo: conversation,
         context: 'reuploadAvatar',
       });
+      window.log.info(
+        `[avatarReupload] reupload done for ${ed25519Str(conversation.id)}: ${details?.avatarPointer}`
+      );
+      return RunJobResult.Success;
     } catch (e) {
-      window.log.warn(`[profileReupload] failed with ${e.message}`);
+      window.log.warn(`[avatarReupload] failed with ${e.message}`);
       return RunJobResult.RetryJobIfPossible;
     }
-
-    // return true so this job is marked as a success
-    return RunJobResult.Success;
   }
 
   public serializeJob(): AvatarReuploadPersistedData {

ts/session/utils/libsession/libsession_utils_contacts.ts

@@ -62,7 +62,7 @@ async function insertContactFromDBIntoWrapperAndRefresh(
   const dbName = foundConvo.getRealSessionUsername() || undefined;
   const dbNickname = foundConvo.get('nickname');
   const dbProfileUrl = foundConvo.getAvatarPointer() || undefined;
-  const dbProfileKey = foundConvo.getProfileKey() || undefined;
+  const dbProfileKey = foundConvo.getProfileKeyHex() || undefined;
   const dbApproved = !!foundConvo.get('isApproved');
   const dbApprovedMe = !!foundConvo.get('didApproveMe');
   const dbBlocked = foundConvo.isBlocked();

ts/state/ducks/metaGroups.ts

@@ -1120,7 +1120,7 @@ async function handleClearAvatarFromUI({ groupPk }: WithGroupPubkey) {
     isNil(convo.getAvatarPointer()) &&
     isNil(convo.getAvatarInProfilePath()) &&
     isNil(convo.getFallbackAvatarInProfilePath()) &&
-    isNil(convo.getProfileKey())
+    isNil(convo.getProfileKeyHex())
   ) {
     return;
   }

ts/state/ducks/user.ts

@@ -69,7 +69,7 @@ const clearOurAvatar = createAsyncThunk('user/clearOurAvatar', async () => {
     isNil(convo.getAvatarPointer()) &&
     isNil(convo.getAvatarInProfilePath()) &&
     isNil(convo.getFallbackAvatarInProfilePath()) &&
-    isNil(convo.getProfileKey())
+    isNil(convo.getProfileKeyHex())
   ) {
     return;
   }