fix: provideEmbeddedHeaders results in failing fetch for img

jsamr · jsamr · commit 54882596c78a · 2021-11-03T14:07:50.000-03:00
fix #533
diff --git a/packages/render-html/src/__mocks__/react-native.js b/packages/render-html/src/__mocks__/react-native.js
@@ -32,11 +32,11 @@ export class Image extends RNImage {
    * be extracted, it will use 640x360.
    */
   static getSizeWithHeaders(uri, headers, success, failure) {
-    getSizeWithHeaders(uri, headers, callback, failure);
+    getSizeWithHeaders(uri, headers, success, failure);
   }
 
-  static getSize(uri, callback, failure) {
-    getSizeWithHeaders(uri, undefined, callback, failure);
+  static getSize(uri, success, failure) {
+    getSizeWithHeaders(uri, undefined, success, failure);
   }
 }
 
diff --git a/packages/render-html/src/__tests__/component.render-html.test.tsx b/packages/render-html/src/__tests__/component.render-html.test.tsx
@@ -856,7 +856,9 @@ describe('RenderHTML', () => {
       expect(image.props.source.headers).toBe(headers);
       expect(getSizeWithHeaders).toHaveBeenCalledWith(
         'https://custom.domain/',
-        headers
+        headers,
+        expect.anything(),
+        expect.anything()
       );
     });
   });
diff --git a/packages/render-html/src/elements/getIMGState.ts b/packages/render-html/src/elements/getIMGState.ts
@@ -14,7 +14,7 @@ interface GetStateProps<C> extends Omit<IMGElementStateBase, 'dimensions'> {
   error: Error | null;
   initialDimensions: ImageDimensions;
   objectFit: UseIMGElementStateProps['objectFit'];
-  onError: (e: Error) => void;
+  onError?: (e: Error) => void;
 }
 
 export function getIMGState(
diff --git a/packages/render-html/src/elements/img-types.ts b/packages/render-html/src/elements/img-types.ts
@@ -154,3 +154,11 @@ export interface IMGElementStateError extends IMGElementStateBase {
   error: Error;
   type: 'error';
 }
+
+/**
+ * Partial image dimensions.
+ */
+export interface IncompleteImageDimensions {
+  height: number | null;
+  width: number | null;
+}
diff --git a/packages/render-html/src/elements/useIMGElementState.ts b/packages/render-html/src/elements/useIMGElementState.ts
@@ -1,12 +1,16 @@
-import { useEffect } from 'react';
-import { Image } from 'react-native';
-import type { UseIMGElementStateProps, IMGElementState } from './img-types';
-import useImageNaturalDimensions from './useImageNaturalDimensions';
-import useImageConcreteDimensions from './useImageConcreteDimensions';
+import { useEffect, useState } from 'react';
+import { Image, ImageURISource } from 'react-native';
+import {
+  UseIMGElementStateProps,
+  IMGElementState,
+  IncompleteImageDimensions
+} from './img-types';
 import defaultImageInitialDimensions from './defaultInitialImageDimensions';
+import useIMGNormalizedSource from './useIMGNormalizedSource';
 import { ImageDimensions } from '../shared-types';
+import useImageConcreteDimensions from './useImageConcreteDimensions';
 import { getIMGState } from './getIMGState';
-import useIMGNormalizedSource from './useIMGNormalizedSource';
+import useImageSpecifiedDimensions from './useImageSpecifiedDimensions';
 
 function getImageSizeAsync({
   uri,
@@ -26,16 +30,47 @@ function getImageSizeAsync({
   });
 }
 
-function useFetchedNaturalDimensions(props: UseIMGElementStateProps) {
+function useImageNaturalDimensions<P extends UseIMGElementStateProps>(props: {
+  cachedNaturalDimensions?: ImageDimensions;
+  source: ImageURISource;
+  specifiedDimensions: IncompleteImageDimensions;
+}) {
   const { source, cachedNaturalDimensions } = props;
-  const {
-    error,
-    flatStyle,
+  const [naturalDimensions, setNaturalDimensions] = useState<
+    P['cachedNaturalDimensions'] extends ImageDimensions
+      ? ImageDimensions
+      : ImageDimensions | null
+  >((cachedNaturalDimensions as any) || null);
+  const { width: cachedNaturalWidth, height: cachedNaturalHeight } =
+    cachedNaturalDimensions || {};
+  const [error, setError] = useState<null | Error>(null);
+  useEffect(
+    function resetOnURIChange() {
+      setNaturalDimensions(
+        (cachedNaturalWidth != null && cachedNaturalHeight != null
+          ? { width: cachedNaturalWidth, height: cachedNaturalHeight }
+          : null) as any
+      );
+      setError(null);
+    },
+    [cachedNaturalHeight, cachedNaturalWidth, source.uri]
+  );
+  return {
+    onNaturalDimensions: setNaturalDimensions,
+    onError: setError,
     naturalDimensions,
-    specifiedDimensions,
-    onError,
-    onNaturalDimensions
-  } = useImageNaturalDimensions(props);
+    error
+  };
+}
+
+function useFetchedNaturalDimensions(props: {
+  cachedNaturalDimensions?: ImageDimensions;
+  source: ImageURISource;
+  specifiedDimensions: IncompleteImageDimensions;
+}) {
+  const { source, cachedNaturalDimensions } = props;
+  const { error, naturalDimensions, onError, onNaturalDimensions } =
+    useImageNaturalDimensions(props);
   const hasCachedDimensions = !!cachedNaturalDimensions;
   useEffect(
     function fetchPhysicalDimensions() {
@@ -58,8 +93,6 @@ function useFetchedNaturalDimensions(props: UseIMGElementStateProps) {
     ]
   );
   return {
-    specifiedDimensions,
-    flatStyle,
     naturalDimensions,
     error,
     onError,
@@ -85,21 +118,27 @@ export default function useIMGElementState(
     contentWidth,
     computeMaxWidth,
     objectFit,
-    initialDimensions = defaultImageInitialDimensions
+    initialDimensions = defaultImageInitialDimensions,
+    cachedNaturalDimensions
   } = props;
-  const { naturalDimensions, specifiedDimensions, flatStyle, onError, error } =
-    useFetchedNaturalDimensions(props);
+  const { flatStyle, specifiedDimensions } = useImageSpecifiedDimensions(props);
+  const nomalizedSource = useIMGNormalizedSource({
+    specifiedDimensions,
+    source
+  });
+  const { naturalDimensions, onError, error } = useFetchedNaturalDimensions({
+    source: nomalizedSource,
+    specifiedDimensions,
+    cachedNaturalDimensions
+  });
   const concreteDimensions = useImageConcreteDimensions({
     flatStyle,
     naturalDimensions,
     specifiedDimensions,
     computeMaxWidth,
     contentWidth
   });
-  const nomalizedSource = useIMGNormalizedSource({
-    concreteDimensions,
-    source
-  });
+
   return getIMGState({
     error,
     alt,
diff --git a/packages/render-html/src/elements/useIMGElementStateWithCache.ts b/packages/render-html/src/elements/useIMGElementStateWithCache.ts
@@ -6,7 +6,7 @@ import type {
   IMGElementStateSuccess
 } from './img-types';
 import useImageConcreteDimensions from './useImageConcreteDimensions';
-import useImageNaturalDimensions from './useImageNaturalDimensions';
+import useImageSpecifiedDimensions from './useImageSpecifiedDimensions';
 import useIMGNormalizedSource from './useIMGNormalizedSource';
 
 /**
@@ -24,28 +24,28 @@ export default function useIMGElementStateWithCache(
     contentWidth,
     computeMaxWidth,
     objectFit,
-    initialDimensions = defaultImageInitialDimensions
+    initialDimensions = defaultImageInitialDimensions,
+    cachedNaturalDimensions
   } = props;
-  const { naturalDimensions, specifiedDimensions, flatStyle, error, onError } =
-    useImageNaturalDimensions(props);
+  const { flatStyle, specifiedDimensions } = useImageSpecifiedDimensions(props);
+  const nomalizedSource = useIMGNormalizedSource({
+    specifiedDimensions,
+    source
+  });
   const concreteDimensions = useImageConcreteDimensions({
     flatStyle,
-    naturalDimensions,
+    naturalDimensions: cachedNaturalDimensions,
     specifiedDimensions,
     computeMaxWidth,
     contentWidth
   });
-  const nomalizedSource = useIMGNormalizedSource({
-    concreteDimensions,
-    source
-  });
+
   return getIMGState({
-    error,
+    error: null,
     concreteDimensions,
     containerStyle: flatStyle,
     initialDimensions,
     objectFit,
-    onError,
     source: nomalizedSource,
     alt,
     altColor
diff --git a/packages/render-html/src/elements/useIMGNormalizedSource.ts b/packages/render-html/src/elements/useIMGNormalizedSource.ts
@@ -1,21 +1,23 @@
 import { useMemo, useRef } from 'react';
 import { useSharedProps } from '../context/SharedPropsProvider';
-import { ImageDimensions } from '../shared-types';
-import { UseIMGElementStateProps } from './img-types';
+import {
+  IncompleteImageDimensions,
+  UseIMGElementStateProps
+} from './img-types';
 
 export default function useIMGNormalizedSource({
   source,
-  concreteDimensions
+  specifiedDimensions
 }: Pick<UseIMGElementStateProps, 'source'> & {
-  concreteDimensions: ImageDimensions | null;
+  specifiedDimensions: IncompleteImageDimensions;
 }) {
-  const cachedDimensions = useRef(concreteDimensions);
+  const cachedDimensions = useRef(specifiedDimensions);
   const { provideEmbeddedHeaders } = useSharedProps();
   return useMemo(() => {
     if (source.uri && typeof provideEmbeddedHeaders === 'function') {
       const headers = provideEmbeddedHeaders(source.uri, 'img', {
-        printWidth: cachedDimensions.current?.width,
-        printHeight: cachedDimensions.current?.height
+        printWidth: cachedDimensions.current?.width || undefined,
+        printHeight: cachedDimensions.current?.height || undefined
       });
       if (headers) {
         return {
diff --git a/packages/render-html/src/elements/useImageConcreteDimensions.ts b/packages/render-html/src/elements/useImageConcreteDimensions.ts
@@ -1,13 +1,16 @@
 import { useMemo } from 'react';
+import { ImageStyle } from 'react-native';
 import { ImageDimensions } from '../shared-types';
-import { UseIMGElementStateProps } from './img-types';
-import useImageNaturalDimensions from './useImageNaturalDimensions';
+import {
+  IncompleteImageDimensions,
+  UseIMGElementStateProps
+} from './img-types';
 
-export type ConcreteDimensionsProps = Pick<
-  ReturnType<typeof useImageNaturalDimensions>,
-  'flatStyle' | 'naturalDimensions' | 'specifiedDimensions'
-> &
-  Pick<UseIMGElementStateProps, 'computeMaxWidth' | 'contentWidth'>;
+export type ConcreteDimensionsProps = {
+  flatStyle: ImageStyle;
+  naturalDimensions: ImageDimensions | null;
+  specifiedDimensions: IncompleteImageDimensions;
+} & Pick<UseIMGElementStateProps, 'computeMaxWidth' | 'contentWidth'>;
 
 function extractHorizontalSpace({
   marginHorizontal,
diff --git a/packages/render-html/src/elements/useImageSpecifiedDimensions.ts b/packages/render-html/src/elements/useImageSpecifiedDimensions.ts
@@ -1,13 +1,10 @@
-import { useState, useMemo, useEffect } from 'react';
-import { StyleSheet } from 'react-native';
-import { ImageDimensions } from '../shared-types';
+import { useMemo } from 'react';
+import {
+  UseIMGElementStateProps,
+  IncompleteImageDimensions
+} from './img-types';
 import getDimensionsWithAspectRatio from './getDimensionsWithAspectRatio';
-import { UseIMGElementStateProps } from './img-types';
-
-interface IncompleteImageDimensions {
-  height: number | null;
-  width: number | null;
-}
+import { StyleSheet } from 'react-native';
 
 function normalizeSize(
   dimension: string | number | null | undefined,
@@ -71,26 +68,12 @@ function deriveSpecifiedDimensionsFromProps({
   );
 }
 
-export default function useImageNaturalDimensions<
-  P extends UseIMGElementStateProps
->(props: P) {
-  const {
-    source,
-    contentWidth,
-    enableExperimentalPercentWidth,
-    width,
-    height,
-    style,
-    cachedNaturalDimensions
-  } = props;
-  const [naturalDimensions, setNaturalDimensions] = useState<
-    P['cachedNaturalDimensions'] extends ImageDimensions
-      ? ImageDimensions
-      : ImageDimensions | null
-  >((cachedNaturalDimensions as any) || null);
+export default function useImageSpecifiedDimensions(
+  props: UseIMGElementStateProps
+) {
+  const { contentWidth, enableExperimentalPercentWidth, style, width, height } =
+    props;
   const flatStyle = useMemo(() => StyleSheet.flatten(style) || {}, [style]);
-  const { width: cachedNaturalWidth, height: cachedNaturalHeight } =
-    cachedNaturalDimensions || {};
   const specifiedDimensions = useMemo(
     () =>
       deriveSpecifiedDimensionsFromProps({
@@ -102,24 +85,5 @@ export default function useImageNaturalDimensions<
       }),
     [contentWidth, enableExperimentalPercentWidth, flatStyle, height, width]
   );
-  const [error, setError] = useState<null | Error>(null);
-  useEffect(
-    function resetOnURIChange() {
-      setNaturalDimensions(
-        (cachedNaturalWidth != null && cachedNaturalHeight != null
-          ? { width: cachedNaturalWidth, height: cachedNaturalHeight }
-          : null) as any
-      );
-      setError(null);
-    },
-    [cachedNaturalHeight, cachedNaturalWidth, source.uri]
-  );
-  return {
-    onNaturalDimensions: setNaturalDimensions,
-    onError: setError,
-    naturalDimensions,
-    specifiedDimensions,
-    flatStyle,
-    error
-  };
+  return { flatStyle, specifiedDimensions };
 }

Original file line number	Diff line number	Diff line change
`@@ -32,11 +32,11 @@ export class Image extends RNImage {`
`32`	`32`	`* be extracted, it will use 640x360.`
`33`	`33`	`*/`
`34`	`34`	`static getSizeWithHeaders(uri, headers, success, failure) {`
`35`		`- getSizeWithHeaders(uri, headers, callback, failure);`
	`35`	`+ getSizeWithHeaders(uri, headers, success, failure);`
`36`	`36`	`}`
`37`	`37`
`38`		`- static getSize(uri, callback, failure) {`
`39`		`- getSizeWithHeaders(uri, undefined, callback, failure);`
	`38`	`+ static getSize(uri, success, failure) {`
	`39`	`+ getSizeWithHeaders(uri, undefined, success, failure);`
`40`	`40`	`}`
`41`	`41`	`}`
`42`	`42`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ interface GetStateProps<C> extends Omit<IMGElementStateBase, 'dimensions'> {`
`14`	`14`	`error: Error \| null;`
`15`	`15`	`initialDimensions: ImageDimensions;`
`16`	`16`	`objectFit: UseIMGElementStateProps['objectFit'];`
`17`		`- onError: (e: Error) => void;`
	`17`	`+ onError?: (e: Error) => void;`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`export function getIMGState(`