@atlaskit/media-file-preview 0.11.5 → 0.11.6

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/media-file-preview
 
+## 0.11.6
+
+### Patch Changes
+
+- [#187759](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/187759)
+  [`cb2080ec93b3c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/cb2080ec93b3c) -
+  Add UFO hold to reduce TTAI blindspot gap
+
 ## 0.11.5
 
 ### Patch Changes

package/dist/cjs/useFilePreview.js

@@ -11,6 +11,8 @@ var _react = require("react");
 var _mediaClient = require("@atlaskit/media-client");
 var _mediaClientReact = require("@atlaskit/media-client-react");
 var _mediaCommon = require("@atlaskit/media-common");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _interactionContext = require("@atlaskit/react-ufo/interaction-context");
 var _analytics = require("./analytics");
 var _errors = require("./errors");
 var _getPreview = require("./getPreview");
@@ -61,6 +63,16 @@ var useFilePreview = exports.useFilePreview = function useFilePreview(_ref) {
       status: 'unknown'
     }
   });
+  var ufoContext = (0, _interactionContext.useInteractionContext)();
+  var _useState1 = (0, _react.useState)(false),
+    _useState10 = (0, _slicedToArray2.default)(_useState1, 2),
+    isLoading = _useState10[0],
+    setIsLoading = _useState10[1];
+  (0, _react.useLayoutEffect)(function () {
+    if (isLoading && (0, _platformFeatureFlags.fg)('platform_close_image_blindspot_2')) {
+      return ufoContext === null || ufoContext === void 0 ? void 0 : ufoContext.hold('img-loading');
+    }
+  }, [ufoContext, isLoading]);
   var requestDimensions = (0, _react.useMemo)(function () {
     return dimensions ? (0, _helpers.createRequestDimensions)(dimensions) : undefined;
   }, [dimensions]);
@@ -107,10 +119,10 @@ var useFilePreview = exports.useFilePreview = function useFilePreview(_ref) {
       }
     }
   };
-  var _useState1 = (0, _react.useState)(previewInitializer),
-    _useState10 = (0, _slicedToArray2.default)(_useState1, 2),
-    preview = _useState10[0],
-    setPreview = _useState10[1];
+  var _useState11 = (0, _react.useState)(previewInitializer),
+    _useState12 = (0, _slicedToArray2.default)(_useState11, 2),
+    preview = _useState12[0],
+    setPreview = _useState12[1];
 
   //----------------------------------------------------------------
   // FILE STATE
@@ -176,6 +188,7 @@ var useFilePreview = exports.useFilePreview = function useFilePreview(_ref) {
       // We block any possible future call to this method regardless of the outcome (success or fail)
       // If it fails, the normal preview fetch should occur after the file state is fetched anyways
       setUpfrontPreviewStatus('resolving');
+      setIsLoading(true);
       var fetchedDimensions = _objectSpread({}, requestDimensions);
       getAndCacheRemotePreviewRef.current().then(function (newPreview) {
         // If there are new and bigger dimensions in the props, and the upfront preview is still resolving,
@@ -186,6 +199,7 @@ var useFilePreview = exports.useFilePreview = function useFilePreview(_ref) {
       }).catch(function () {
         // NO need to log error. If this call fails, a refetch will happen after
       }).finally(function () {
+        setIsLoading(false);
         setUpfrontPreviewStatus('resolved');
       });
     }
@@ -208,17 +222,20 @@ var useFilePreview = exports.useFilePreview = function useFilePreview(_ref) {
       // Local preview is available only if it's supported by browser and supported by Media Card (isSupportedLocalPreview)
       // For example, SVGs are mime type NOT supported by browser but media type supported by Media Card (image)
       // Then, local Preview NOT available
-
+      setIsLoading(true);
       (0, _getPreview.getAndCacheLocalPreview)(identifier.id, localBinary, requestDimensions || {}, resizeMode, mediaBlobUrlAttrsRef.current).then(setPreview).catch(function (e) {
         setIsBannedLocalPreview(true);
         // CXP-2723 TODO: We might have to wrap this error in MediaCardError
         setNonCriticalError(e);
+      }).finally(function () {
+        setIsLoading(false);
       });
     }
     // Remote Preview ----------------------------------------------------------------
     else if (!error && !nonCriticalError && (!preview || (0, _helpers.isBigger)(preview.dimensions, requestDimensions) ||
     // We always refetch SSR preview to be able to browser-cache a version without the token in the query parameters
     (0, _getPreview.isSSRPreview)(preview)) && !skipRemote && upfrontPreviewStatus === 'resolved' && isBackendPreviewReady) {
+      setIsLoading(true);
       getAndCacheRemotePreviewRef.current().then(setPreview).catch(function (e) {
         var wrappedError = (0, _errors.ensureMediaFilePreviewError)('preview-fetch', e);
         if (!preview) {
@@ -228,6 +245,8 @@ var useFilePreview = exports.useFilePreview = function useFilePreview(_ref) {
           // If there is already a preview, we consider it a non-critical error
           setNonCriticalError(wrappedError);
         }
+      }).finally(function () {
+        setIsLoading(false);
       });
     }
   }, [error, nonCriticalError, getAndCacheRemotePreviewRef, identifier.id, resizeMode, isBannedLocalPreview, mediaBlobUrlAttrsRef, preview, requestDimensions, skipRemote, isBackendPreviewReady, localBinary, mediaType, mimeType, upfrontPreviewStatus]);

package/dist/es2019/useFilePreview.js

@@ -1,7 +1,9 @@
-import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
+import { useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState } from 'react';
 import { isImageRepresentationReady, toCommonMediaClientError } from '@atlaskit/media-client';
 import { useCopyIntent, useFileState, useMediaClient } from '@atlaskit/media-client-react';
 import { isMimeTypeSupportedByBrowser } from '@atlaskit/media-common';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { useInteractionContext } from '@atlaskit/react-ufo/interaction-context';
 import { createFailedSSRObject, extractErrorInfo } from './analytics';
 import { ensureMediaFilePreviewError, ImageLoadError, MediaFilePreviewError } from './errors';
 import { getAndCacheLocalPreview, getAndCacheRemotePreview, getSSRPreview, isLocalPreview, isRemotePreview, isSSRClientPreview, isSSRDataPreview, isSSRPreview, isSupportedLocalPreview, mediaFilePreviewCache } from './getPreview';
@@ -35,6 +37,13 @@ export const useFilePreview = ({
       status: 'unknown'
     }
   });
+  const ufoContext = useInteractionContext();
+  const [isLoading, setIsLoading] = useState(false);
+  useLayoutEffect(() => {
+    if (isLoading && fg('platform_close_image_blindspot_2')) {
+      return ufoContext === null || ufoContext === void 0 ? void 0 : ufoContext.hold('img-loading');
+    }
+  }, [ufoContext, isLoading]);
   const requestDimensions = useMemo(() => dimensions ? createRequestDimensions(dimensions) : undefined, [dimensions]);
   const requestDimensionsRef = useCurrentValueRef(requestDimensions);
   let imageURLParams = {
@@ -149,6 +158,7 @@ export const useFilePreview = ({
       // We block any possible future call to this method regardless of the outcome (success or fail)
       // If it fails, the normal preview fetch should occur after the file state is fetched anyways
       setUpfrontPreviewStatus('resolving');
+      setIsLoading(true);
       const fetchedDimensions = {
         ...requestDimensions
       };
@@ -161,6 +171,7 @@ export const useFilePreview = ({
       }).catch(() => {
         // NO need to log error. If this call fails, a refetch will happen after
       }).finally(() => {
+        setIsLoading(false);
         setUpfrontPreviewStatus('resolved');
       });
     }
@@ -183,17 +194,20 @@ export const useFilePreview = ({
       // Local preview is available only if it's supported by browser and supported by Media Card (isSupportedLocalPreview)
       // For example, SVGs are mime type NOT supported by browser but media type supported by Media Card (image)
       // Then, local Preview NOT available
-
+      setIsLoading(true);
       getAndCacheLocalPreview(identifier.id, localBinary, requestDimensions || {}, resizeMode, mediaBlobUrlAttrsRef.current).then(setPreview).catch(e => {
         setIsBannedLocalPreview(true);
         // CXP-2723 TODO: We might have to wrap this error in MediaCardError
         setNonCriticalError(e);
+      }).finally(() => {
+        setIsLoading(false);
       });
     }
     // Remote Preview ----------------------------------------------------------------
     else if (!error && !nonCriticalError && (!preview || isBigger(preview.dimensions, requestDimensions) ||
     // We always refetch SSR preview to be able to browser-cache a version without the token in the query parameters
     isSSRPreview(preview)) && !skipRemote && upfrontPreviewStatus === 'resolved' && isBackendPreviewReady) {
+      setIsLoading(true);
       getAndCacheRemotePreviewRef.current().then(setPreview).catch(e => {
         const wrappedError = ensureMediaFilePreviewError('preview-fetch', e);
         if (!preview) {
@@ -203,6 +217,8 @@ export const useFilePreview = ({
           // If there is already a preview, we consider it a non-critical error
           setNonCriticalError(wrappedError);
         }
+      }).finally(() => {
+        setIsLoading(false);
       });
     }
   }, [error, nonCriticalError, getAndCacheRemotePreviewRef, identifier.id, resizeMode, isBannedLocalPreview, mediaBlobUrlAttrsRef, preview, requestDimensions, skipRemote, isBackendPreviewReady, localBinary, mediaType, mimeType, upfrontPreviewStatus]);

package/dist/esm/useFilePreview.js

@@ -2,10 +2,12 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
+import { useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState } from 'react';
 import { isImageRepresentationReady, toCommonMediaClientError } from '@atlaskit/media-client';
 import { useCopyIntent, useFileState, useMediaClient } from '@atlaskit/media-client-react';
 import { isMimeTypeSupportedByBrowser } from '@atlaskit/media-common';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { useInteractionContext } from '@atlaskit/react-ufo/interaction-context';
 import { createFailedSSRObject, extractErrorInfo } from './analytics';
 import { ensureMediaFilePreviewError, ImageLoadError, MediaFilePreviewError } from './errors';
 import { getAndCacheLocalPreview, getAndCacheRemotePreview, getSSRPreview, isLocalPreview, isRemotePreview, isSSRClientPreview, isSSRDataPreview, isSSRPreview, isSupportedLocalPreview, mediaFilePreviewCache } from './getPreview';
@@ -54,6 +56,16 @@ export var useFilePreview = function useFilePreview(_ref) {
       status: 'unknown'
     }
   });
+  var ufoContext = useInteractionContext();
+  var _useState1 = useState(false),
+    _useState10 = _slicedToArray(_useState1, 2),
+    isLoading = _useState10[0],
+    setIsLoading = _useState10[1];
+  useLayoutEffect(function () {
+    if (isLoading && fg('platform_close_image_blindspot_2')) {
+      return ufoContext === null || ufoContext === void 0 ? void 0 : ufoContext.hold('img-loading');
+    }
+  }, [ufoContext, isLoading]);
   var requestDimensions = useMemo(function () {
     return dimensions ? createRequestDimensions(dimensions) : undefined;
   }, [dimensions]);
@@ -100,10 +112,10 @@ export var useFilePreview = function useFilePreview(_ref) {
       }
     }
   };
-  var _useState1 = useState(previewInitializer),
-    _useState10 = _slicedToArray(_useState1, 2),
-    preview = _useState10[0],
-    setPreview = _useState10[1];
+  var _useState11 = useState(previewInitializer),
+    _useState12 = _slicedToArray(_useState11, 2),
+    preview = _useState12[0],
+    setPreview = _useState12[1];
 
   //----------------------------------------------------------------
   // FILE STATE
@@ -169,6 +181,7 @@ export var useFilePreview = function useFilePreview(_ref) {
       // We block any possible future call to this method regardless of the outcome (success or fail)
       // If it fails, the normal preview fetch should occur after the file state is fetched anyways
       setUpfrontPreviewStatus('resolving');
+      setIsLoading(true);
       var fetchedDimensions = _objectSpread({}, requestDimensions);
       getAndCacheRemotePreviewRef.current().then(function (newPreview) {
         // If there are new and bigger dimensions in the props, and the upfront preview is still resolving,
@@ -179,6 +192,7 @@ export var useFilePreview = function useFilePreview(_ref) {
       }).catch(function () {
         // NO need to log error. If this call fails, a refetch will happen after
       }).finally(function () {
+        setIsLoading(false);
         setUpfrontPreviewStatus('resolved');
       });
     }
@@ -201,17 +215,20 @@ export var useFilePreview = function useFilePreview(_ref) {
       // Local preview is available only if it's supported by browser and supported by Media Card (isSupportedLocalPreview)
       // For example, SVGs are mime type NOT supported by browser but media type supported by Media Card (image)
       // Then, local Preview NOT available
-
+      setIsLoading(true);
       getAndCacheLocalPreview(identifier.id, localBinary, requestDimensions || {}, resizeMode, mediaBlobUrlAttrsRef.current).then(setPreview).catch(function (e) {
         setIsBannedLocalPreview(true);
         // CXP-2723 TODO: We might have to wrap this error in MediaCardError
         setNonCriticalError(e);
+      }).finally(function () {
+        setIsLoading(false);
       });
     }
     // Remote Preview ----------------------------------------------------------------
     else if (!error && !nonCriticalError && (!preview || isBigger(preview.dimensions, requestDimensions) ||
     // We always refetch SSR preview to be able to browser-cache a version without the token in the query parameters
     isSSRPreview(preview)) && !skipRemote && upfrontPreviewStatus === 'resolved' && isBackendPreviewReady) {
+      setIsLoading(true);
       getAndCacheRemotePreviewRef.current().then(setPreview).catch(function (e) {
         var wrappedError = ensureMediaFilePreviewError('preview-fetch', e);
         if (!preview) {
@@ -221,6 +238,8 @@ export var useFilePreview = function useFilePreview(_ref) {
           // If there is already a preview, we consider it a non-critical error
           setNonCriticalError(wrappedError);
         }
+      }).finally(function () {
+        setIsLoading(false);
       });
     }
   }, [error, nonCriticalError, getAndCacheRemotePreviewRef, identifier.id, resizeMode, isBannedLocalPreview, mediaBlobUrlAttrsRef, preview, requestDimensions, skipRemote, isBackendPreviewReady, localBinary, mediaType, mimeType, upfrontPreviewStatus]);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/media-file-preview",
-	"version": "0.11.5",
+	"version": "0.11.6",
 	"description": "A React Hook to fetch and render file previews. It's overloaded with fancy features like SSR, lazy loading, memory cache and local preview.",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -38,6 +38,7 @@
 		"@atlaskit/media-common": "^12.3.0",
 		"@atlaskit/media-ui": "^28.6.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
+		"@atlaskit/react-ufo": "^4.0.0",
 		"@babel/runtime": "^7.0.0",
 		"eventemitter2": "^4.1.0",
 		"lru_map": "^0.4.1"
@@ -95,5 +96,9 @@
 			]
 		}
 	},
-	"platform-feature-flags": {}
+	"platform-feature-flags": {
+		"platform_close_image_blindspot_2": {
+			"type": "boolean"
+		}
+	}
 }