Adds error states to story images

_locales/en/messages.json

@@ -7481,9 +7481,19 @@
     "message": "Hide",
     "description": "Action button for the confirmation dialog to hide a story"
   },
-  "StoryImage__error": {
+  "StoryImage__error2": {
-    "message": "Error displaying image",
+    "message": "Can’t download story. $name$ will need to share it again.",
-    "description": "aria-label for image errors"
+    "description": "Description for image errors",
+    "placeholders": {
+      "name": {
+        "content": "$1",
+        "example": "Clara"
+      }
+    }
+  },
+  "StoryImage__error--you": {
+    "message": "Can’t download story. You will need to share it again.",
+    "description": "Description for image errors but when it is your own image"
   },
   "StoryCreator__text-bg": {
     "message": "Toggle text background color",

stylesheets/components/StoryImage.scss

@@ -33,6 +33,18 @@
     width: 100%;
   }
 
+  &__error {
+    @include color-svg(
+      '../images/full-screen-flow/alert-outline.svg',
+      $color-white
+    );
+    align-items: center;
+    display: flex;
+    height: 32px;
+    justify-content: center;
+    width: 32px;
+  }
+
   &__spinner-bubble {
     align-items: center;
     background-color: $color-gray-75;

ts/components/MyStories.tsx

@@ -92,7 +92,9 @@ export const MyStories = ({
                   >
                     <StoryImage
                       attachment={story.attachment}
+                      firstName={i18n('you')}
                       i18n={i18n}
+                      isMe
                       isThumbnail
                       label={i18n('MyStories__story')}
                       moduleClassName="MyStories__story__preview"

ts/components/MyStoriesButton.tsx

@@ -83,7 +83,9 @@ export const MyStoriesButton = ({
           {newestStory ? (
             <StoryImage
               attachment={newestStory.attachment}
+              firstName={i18n('you')}
               i18n={i18n}
+              isMe
               isThumbnail
               label=""
               moduleClassName="StoryListItem__previews--image"

ts/components/StoryImage.stories.tsx

@@ -27,6 +27,7 @@ function getDefaultProps(): PropsType {
       url: '/fixtures/nathan-anderson-316188-unsplash.jpg',
       thumbnail: fakeThumbnail('/fixtures/nathan-anderson-316188-unsplash.jpg'),
     }),
+    firstName: 'Charlie',
     i18n,
     label: 'A story',
     queueStoryDownload: action('queueStoryDownload'),
@@ -129,3 +130,39 @@ export const Video = (): JSX.Element => (
     })}
   />
 );
+
+export const ErrorImage = (): JSX.Element => (
+  <StoryImage
+    {...getDefaultProps()}
+    attachment={fakeAttachment({
+      error: true,
+      url: '/this/path/does/not/exist.jpg',
+    })}
+  />
+);
+
+export const ErrorImageThumbnail = (): JSX.Element => (
+  <StoryImage
+    {...getDefaultProps()}
+    attachment={fakeAttachment({
+      error: true,
+      url: '/this/path/does/not/exist.jpg',
+    })}
+    isThumbnail
+  />
+);
+
+ErrorImageThumbnail.story = {
+  name: 'Error Image (thumbnail)',
+};
+
+export const ErrorImageYou = (): JSX.Element => (
+  <StoryImage
+    {...getDefaultProps()}
+    isMe
+    attachment={fakeAttachment({
+      error: true,
+      url: '/this/path/does/not/exist.jpg',
+    })}
+  />
+);

ts/components/StoryImage.tsx

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 
 import type { ReactNode } from 'react';
-import React, { useEffect, useRef } from 'react';
+import React, { useEffect, useRef, useState } from 'react';
 import classNames from 'classnames';
 import { Blurhash } from 'react-blurhash';
 
@@ -13,6 +13,7 @@ import { TextAttachment } from './TextAttachment';
 import { ThemeType } from '../types/Util';
 import {
   defaultBlurHash,
+  hasFailed,
   hasNotResolved,
   isDownloaded,
   isDownloading,
@@ -24,7 +25,9 @@ import { isVideoTypeSupported } from '../util/GoogleChrome';
 export type PropsType = {
   readonly attachment?: AttachmentType;
   readonly children?: ReactNode;
+  readonly firstName: string;
   readonly i18n: LocalizerType;
+  readonly isMe?: boolean;
   readonly isMuted?: boolean;
   readonly isPaused?: boolean;
   readonly isThumbnail?: boolean;
@@ -37,7 +40,9 @@ export type PropsType = {
 export const StoryImage = ({
   attachment,
   children,
+  firstName,
   i18n,
+  isMe,
   isMuted,
   isPaused,
   isThumbnail,
@@ -50,6 +55,7 @@ export const StoryImage = ({
     (!isDownloaded(attachment) && !isDownloading(attachment)) ||
     hasNotResolved(attachment);
 
+  const [hasImgError, setHasImgError] = useState(false);
   const videoRef = useRef<HTMLVideoElement | null>(null);
 
   useEffect(() => {
@@ -74,8 +80,10 @@ export const StoryImage = ({
     return null;
   }
 
-  const isPending = Boolean(attachment.pending) && !attachment.textAttachment;
+  const hasError = hasImgError || hasFailed(attachment);
-  const isNotReadyToShow = hasNotResolved(attachment) || isPending;
+  const isPending =
+    Boolean(attachment.pending) && !attachment.textAttachment && !hasError;
+  const isNotReadyToShow = hasNotResolved(attachment) || isPending || hasError;
   const isSupportedVideo = isVideoTypeSupported(attachment.contentType);
 
   const getClassName = getClassNamesFor('StoryImage', moduleClassName);
@@ -118,6 +126,7 @@ export const StoryImage = ({
       <img
         alt={label}
         className={getClassName('__image')}
+        onError={() => setHasImgError(true)}
         src={
           isThumbnail && attachment.thumbnail
             ? attachment.thumbnail.url
@@ -136,6 +145,17 @@ export const StoryImage = ({
         </div>
       </div>
     );
+  } else if (hasError) {
+    let content = <div className="StoryImage__error" />;
+    if (!isThumbnail) {
+      if (isMe) {
+        content = <>{i18n('StoryImage__error--you')}</>;
+      } else {
+        content = <>{i18n('StoryImage__error2', [firstName])}</>;
+      }
+    }
+
+    overlay = <div className="StoryImage__overlay-container">{content}</div>;
   }
 
   return (

ts/components/StoryListItem.tsx

@@ -179,6 +179,7 @@ export const StoryListItem = ({
         <div className="StoryListItem__previews">
           <StoryImage
             attachment={attachment}
+            firstName={firstName || title}
             i18n={i18n}
             isThumbnail
             label=""

ts/components/StoryViewer.tsx

@@ -471,6 +471,7 @@ export const StoryViewer = ({
           <div className="StoryViewer__container">
             <StoryImage
               attachment={attachment}
+              firstName={firstName || title}
               i18n={i18n}
               isPaused={shouldPauseViewing}
               isMuted={isStoryMuted}

ts/messageModifiers/AttachmentDownloads.ts

@@ -222,7 +222,7 @@ async function _maybeStartJob(): Promise<void> {
 
           delete _activeAttachmentDownloadJobs[job.id];
           try {
-            await removeAttachmentDownloadJob(job.id);
+            await _markAttachmentAsFailed(job);
           } catch (deleteError) {
             log.error(
               `${logId}: Failed to delete attachment job`,
@@ -261,20 +261,10 @@ async function _runJob(job?: AttachmentDownloadJobType): Promise<void> {
     const pending = true;
     await setAttachmentDownloadJobPending(id, pending);
 
-    message = window.MessageController.getById(messageId);
+    message = await _getMessageById(id, messageId);
-    if (!message) {
-      const messageAttributes = await getMessageById(messageId);
-      if (!messageAttributes) {
-        logger.error(
-          `attachment_downloads/_runJob(${id}): ` +
-            'Source message not found, deleting job'
-        );
-        await _finishJob(null, id);
-        return;
-      }
 
-      strictAssert(messageId === messageAttributes.id, 'message id mismatch');
+    if (!message) {
-      message = window.MessageController.register(messageId, messageAttributes);
+      return;
     }
 
     await _addAttachmentToMessage(
@@ -370,6 +360,48 @@ async function _runJob(job?: AttachmentDownloadJobType): Promise<void> {
   }
 }
 
+async function _markAttachmentAsFailed(
+  job: AttachmentDownloadJobType
+): Promise<void> {
+  const { id, messageId, attachment, type, index } = job;
+  const message = await _getMessageById(id, messageId);
+
+  if (!message) {
+    return;
+  }
+
+  await _addAttachmentToMessage(
+    message,
+    _markAttachmentAsPermanentError(attachment),
+    { type, index }
+  );
+  await _finishJob(message, id);
+}
+
+async function _getMessageById(
+  id: string,
+  messageId: string
+): Promise<MessageModel | undefined> {
+  const message = window.MessageController.getById(messageId);
+
+  if (message) {
+    return message;
+  }
+
+  const messageAttributes = await getMessageById(messageId);
+  if (!messageAttributes) {
+    logger.error(
+      `attachment_downloads/_runJob(${id}): ` +
+        'Source message not found, deleting job'
+    );
+    await _finishJob(null, id);
+    return;
+  }
+
+  strictAssert(messageId === messageAttributes.id, 'message id mismatch');
+  return window.MessageController.register(messageId, messageAttributes);
+}
+
 async function _finishJob(
   message: MessageModel | null | undefined,
   id: string

ts/state/ducks/stories.ts

@@ -34,6 +34,7 @@ import { replaceIndex } from '../../util/replaceIndex';
 import { sendDeleteForEveryoneMessage } from '../../util/sendDeleteForEveryoneMessage';
 import { showToast } from '../../util/showToast';
 import {
+  hasFailed,
   hasNotResolved,
   isDownloaded,
   isDownloading,
@@ -378,7 +379,10 @@ function markStoryRead(
       return;
     }
 
-    if (!isDownloaded(matchingStory.attachment)) {
+    if (
+      !isDownloaded(matchingStory.attachment) &&
+      !hasFailed(matchingStory.attachment)
+    ) {
       return;
     }
 
@@ -449,6 +453,10 @@ function queueStoryDownload(
       return;
     }
 
+    if (hasFailed(attachment)) {
+      return;
+    }
+
     if (isDownloaded(attachment)) {
       if (!attachment.path) {
         return;
@@ -1001,6 +1009,8 @@ export function reducer(
       const hasAttachmentDownloaded =
         !isDownloaded(prevStory.attachment) &&
         isDownloaded(newStory.attachment);
+      const hasAttachmentFailed =
+        hasFailed(newStory.attachment) && !hasFailed(prevStory.attachment);
       const readStatusChanged = prevStory.readStatus !== newStory.readStatus;
       const reactionsChanged =
         prevStory.reactions?.length !== newStory.reactions?.length;
@@ -1014,6 +1024,7 @@ export function reducer(
       const shouldReplace =
         isDownloadingAttachment ||
         hasAttachmentDownloaded ||
+        hasAttachmentFailed ||
         hasBeenDeleted ||
         hasSendStateChanged ||
         readStatusChanged ||

ts/types/Attachment.ts

@@ -768,6 +768,10 @@ export function isDownloading(attachment?: AttachmentType): boolean {
   return Boolean(attachment && attachment.downloadJobId && attachment.pending);
 }
 
+export function hasFailed(attachment?: AttachmentType): boolean {
+  return Boolean(attachment && attachment.error);
+}
+
 export function hasVideoBlurHash(attachments?: Array<AttachmentType>): boolean {
   const firstAttachment = attachments ? attachments[0] : null;
 

ts/util/getStoryDuration.ts

@@ -3,6 +3,7 @@
 
 import type { AttachmentType } from '../types/Attachment';
 import {
+  hasFailed,
   hasNotResolved,
   isDownloaded,
   isGIF,
@@ -18,6 +19,10 @@ const MIN_TEXT_DURATION = 3 * SECOND;
 export async function getStoryDuration(
   attachment: AttachmentType
 ): Promise<number | undefined> {
+  if (hasFailed(attachment)) {
+    return DEFAULT_DURATION;
+  }
+
   if (!isDownloaded(attachment) || hasNotResolved(attachment)) {
     return;
   }