Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions src/components/Image/getImageSource.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
import {isExpiredSession} from '@libs/actions/Session';
import CONST from '@src/CONST';
import type Session from '@src/types/onyx/Session';
import type {ImageProps} from './types';

type GetImageSourceParams = {
propsSource: ImageProps['source'];
session: Session | undefined;
isAuthTokenRequired: boolean;
isOffline: boolean;
};

type GetImageSourceReturn = {
source: ImageProps['source'];
shouldReauthenticate: boolean;
};

export default function getImageSource({propsSource, session, isAuthTokenRequired, isOffline}: GetImageSourceParams): GetImageSourceReturn {
if (typeof propsSource === 'object' && propsSource !== null && 'uri' in propsSource) {
if (typeof propsSource.uri === 'number') {
return {source: propsSource.uri, shouldReauthenticate: false};
}

const authToken = session?.encryptedAuthToken ?? null;
if (isAuthTokenRequired && authToken) {
if (isOffline || (!!session?.creationDate && !isExpiredSession(session.creationDate))) {
return {
source: {
...propsSource,
cacheKey: propsSource.uri,
headers: {
[CONST.CHAT_ATTACHMENT_TOKEN_KEY]: authToken,
},
},
shouldReauthenticate: false,
};
}

return {source: undefined, shouldReauthenticate: !!session};
}
}

return {source: propsSource, shouldReauthenticate: false};
}
37 changes: 15 additions & 22 deletions src/components/Image/index.tsx
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
import React, {useCallback, useContext, useEffect, useMemo, useRef, useState} from 'react';
import LoadingIndicator from '@components/LoadingIndicator';
import {useSession} from '@components/OnyxListItemProvider';
import useNetwork from '@hooks/useNetwork';
import {isExpiredSession} from '@libs/actions/Session';
import activateReauthenticator from '@libs/actions/Session/AttachmentImageReauthenticator';
import CONST from '@src/CONST';
import BaseImage from './BaseImage';
import getImageSource from './getImageSource';
import {ImageBehaviorContext} from './ImageBehaviorContextProvider';
import type {ImageOnLoadEvent, ImageProps} from './types';

Expand All @@ -23,6 +25,7 @@ function Image({
const [aspectRatio, setAspectRatio] = useState<string | number | null>(null);
const isObjectPositionTop = objectPosition === CONST.IMAGE_OBJECT_POSITION.TOP;
const session = useSession();
const {isOffline} = useNetwork();

const {shouldSetAspectRatioInStyle} = useContext(ImageBehaviorContext);

Expand Down Expand Up @@ -114,33 +117,23 @@ function Image({
* to the source.
*/
const source = useMemo(() => {
if (typeof propsSource === 'object' && 'uri' in propsSource) {
if (typeof propsSource.uri === 'number') {
return propsSource.uri;
}
const authToken = session?.encryptedAuthToken ?? null;
if (isAuthTokenRequired && authToken) {
if (!!session?.creationDate && !isExpiredSession(session.creationDate)) {
return {
...propsSource,
cacheKey: propsSource.uri,
headers: {
[CONST.CHAT_ATTACHMENT_TOKEN_KEY]: authToken,
},
};
}
if (session) {
activateReauthenticator(session);
}
return undefined;
}
const resolvedImageSource = getImageSource({
propsSource,
session,
isAuthTokenRequired,
isOffline,
});

if (resolvedImageSource.shouldReauthenticate && session) {
activateReauthenticator(session);
}
return propsSource;

return resolvedImageSource.source;
// The session prop is not required, as it causes the image to reload whenever the session changes. For more information, please refer to issue #26034.
// but we still need the image to reload sometimes (example : when the current session is expired)
// by forcing a recalculation of the source (which value could indeed change) through the modification of the variable validSessionAge
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [propsSource, isAuthTokenRequired, validSessionAge]);
}, [propsSource, isAuthTokenRequired, validSessionAge, isOffline]);
useEffect(() => {
if (!isAuthTokenRequired || source !== undefined) {
return;
Expand Down
111 changes: 111 additions & 0 deletions tests/unit/components/Image/getImageSource.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
import getImageSource from '@components/Image/getImageSource';
import CONST from '@src/CONST';
import type Session from '@src/types/onyx/Session';

const NOW = new Date('2026-04-15T00:00:00Z');
const MOCK_URI = 'https://example.com/receipt.jpg';
const MOCK_TOKEN = 'encrypted-token';
type GetImageSourceParams = Parameters<typeof getImageSource>[0];

describe('getImageSource', () => {
beforeAll(() => {
jest.useFakeTimers();
jest.setSystemTime(NOW);
});

afterAll(() => {
jest.useRealTimers();
});

it('returns the original source for images that do not require auth', () => {
const source = {uri: MOCK_URI};

expect(
getImageSource({
propsSource: source,
session: undefined,
isAuthTokenRequired: false,
isOffline: false,
}),
).toEqual({source, shouldReauthenticate: false});
});

it('returns an authenticated source with cacheKey when the session is fresh', () => {
const propsSource = {uri: MOCK_URI};
const session: Session = {
encryptedAuthToken: MOCK_TOKEN,
creationDate: NOW.getTime(),
};

expect(
getImageSource({
propsSource,
session,
isAuthTokenRequired: true,
isOffline: false,
}),
).toEqual({
source: {
...propsSource,
cacheKey: MOCK_URI,
headers: {
[CONST.CHAT_ATTACHMENT_TOKEN_KEY]: MOCK_TOKEN,
},
},
shouldReauthenticate: false,
});
});

it('returns an authenticated source offline even when the session is expired', () => {
const propsSource = {uri: MOCK_URI};
const session: Session = {
encryptedAuthToken: MOCK_TOKEN,
creationDate: NOW.getTime() - CONST.SESSION_EXPIRATION_TIME_MS - 1,
};

expect(
getImageSource({
propsSource,
session,
isAuthTokenRequired: true,
isOffline: true,
}),
).toEqual({
source: {
...propsSource,
cacheKey: MOCK_URI,
headers: {
[CONST.CHAT_ATTACHMENT_TOKEN_KEY]: MOCK_TOKEN,
},
},
shouldReauthenticate: false,
});
});

it('returns undefined and requests reauthentication online when the session is expired', () => {
const session: Session = {
encryptedAuthToken: MOCK_TOKEN,
creationDate: NOW.getTime() - CONST.SESSION_EXPIRATION_TIME_MS - 1,
};

expect(
getImageSource({
propsSource: {uri: MOCK_URI},
session,
isAuthTokenRequired: true,
isOffline: false,
}),
).toEqual({source: undefined, shouldReauthenticate: true});
});

it('preserves numeric image sources', () => {
expect(
getImageSource({
propsSource: {uri: 42} as unknown as GetImageSourceParams['propsSource'],
session: undefined,
isAuthTokenRequired: true,
isOffline: false,
}),
).toEqual({source: 42, shouldReauthenticate: false});
});
});
Loading