fix: Merge pull request #70 from waoai/feat/cors-fix-plus

fix: CORs loading errors (and other loading errors) give helpful message

Author: seveibar

src/Annotator/index.story.js

@@ -647,3 +647,23 @@ storiesOf("Annotator", module)
       </HotKeys>
     )
   })
+  .add("CORs Error (Pixel Segmentation)", () => (
+    <Annotator
+      onExit={actionAddon("onExit")}
+      middlewares={[
+        (store) => (next) => (action) => {
+          actionAddon(action.type)(action)
+          return next(action)
+        },
+      ]}
+      labelImages
+      fullImageSegmentationMode
+      regionClsList={["Alpha", "Beta", "Charlie", "Delta"]}
+      images={[
+        {
+          src: "https://placebear.com/200/300",
+          name: "Frame 0036",
+        },
+      ]}
+    />
+  ))

src/VideoOrImageCanvasBackground/index.js

@@ -1,6 +1,6 @@
 // @flow weak
 
-import React, { useRef, useEffect, useMemo } from "react"
+import React, { useRef, useEffect, useMemo, useState } from "react"
 import { styled } from "@material-ui/core/styles"
 import useEventCallback from "use-event-callback"
 import { useSettings } from "../SettingsProvider"
@@ -15,6 +15,20 @@ const StyledImage = styled("img")({
   position: "absolute",
 })
 
+const Error = styled("div")({
+  zIndex: 0,
+  position: "absolute",
+  left: 0,
+  right: 0,
+  bottom: 0,
+  top: 0,
+  backgroundColor: "rgba(255,0,0,0.2)",
+  color: "#ff0000",
+  fontWeight: "bold",
+  whiteSpace: "pre-wrap",
+  padding: 50,
+})
+
 export default ({
   imagePosition,
   mouseEvents,
@@ -30,6 +44,7 @@ export default ({
   const settings = useSettings()
   const videoRef = useRef()
   const imageRef = useRef()
+  const [error, setError] = useState()
 
   useEffect(() => {
     if (!videoPlaying && videoRef.current) {
@@ -93,6 +108,17 @@ export default ({
         imageElm,
       })
   })
+  const onImageError = useEventCallback((event) => {
+    setError(
+      `Could not load image\n\nMake sure your image works by visiting ${
+        imageSrc || videoSrc
+      } in a web browser. If that URL works, the server hosting the URL may be not allowing you to access the image from your current domain. Adjust server settings to enable the image to be viewed.${
+        !useCrossOrigin
+          ? ""
+          : `\n\nYour image may be blocked because it's not being sent with CORs headers. To do pixel segmentation, browser web security requires CORs headers in order for the algorithm to read the pixel data from the image. CORs headers are easy to add if you're using an S3 bucket or own the server hosting your images.`
+      }\n\n If you need a hand, reach out to the community at universaldatatool.slack.com`
+    )
+  })
 
   const stylePosition = useMemo(() => {
     let width = imagePosition.bottomRight.x - imagePosition.topLeft.x
@@ -111,7 +137,10 @@ export default ({
     imagePosition.bottomRight.y,
   ])
 
-  if (!videoSrc && !imageSrc) return "No imageSrc or videoSrc provided"
+  if (!videoSrc && !imageSrc)
+    return <Error>No imageSrc or videoSrc provided</Error>
+
+  if (error) return <Error>{error}</Error>
 
   return imageSrc && videoTime === undefined ? (
     <StyledImage
@@ -120,6 +149,7 @@ export default ({
       ref={imageRef}
       style={stylePosition}
       onLoad={onImageLoaded}
+      onError={onImageError}
       crossOrigin={useCrossOrigin ? "anonymous" : undefined}
     />
   ) : (