@jetshop/ui 6.3.8-alpha.20 → 6.3.8-alpha.25

package/CloudflareImage/FlightImage.test.js

@@ -0,0 +1,277 @@
+import { ChannelProvider } from '@jetshop/core/components/ChannelContext';
+import t from '@jetshop/intl';
+import testImage from '@jetshop/ui/test-utils/fixtures/test-image.png';
+import { fireEvent, queryByText, render } from '@testing-library/react';
+import React from 'react';
+import { useInView } from 'react-intersection-observer';
+import Image from './FlightImage';
+import { ChannelHandler } from '@jetshop/core/ChannelHandler/ChannelHandler';
+import { selectedChannel, channels } from '@jetshop/core/test-utils/variables';
+import { ConfigProvider } from '@jetshop/core/components/ConfigProvider';
+import mockShopConfig from '@jetshop/core/test-utils/mockShopConfig';
+
+// Mock intersection observer so we can always return true/false
+jest.mock('react-intersection-observer');
+// Suppress warnings from translations
+jest.mock('@jetshop/intl');
+t.mockImplementation((t) => t);
+
+// browser mocks
+global.IntersectionObserver = jest.fn(function () {
+  this.observe = jest.fn();
+  this.unobserve = jest.fn();
+  this.disconnect = jest.fn();
+});
+
+const transparent =
+  'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=';
+
+global.__IN_SERVER__ = false;
+
+describe('Hooks image component', () => {
+  describe('on initial load', () => {
+    beforeAll(() => {
+      useInView.mockImplementation(() => [null, false]);
+    });
+    it('renders a lqip version of the image by default', () => {
+      const { placeholderImage } = setup();
+
+      const src = placeholderImage.getAttribute('src');
+
+      expect(src).toEqual(expect.stringContaining('sigma=2.5'));
+      expect(src).toEqual(expect.stringContaining('minampl=0.5'));
+    });
+
+    it('sets the lqip to the smallest of the calculated sizes', () => {
+      const { placeholderImage } = setup({ sizes: [0.5, 0.85, 1] });
+      // Should be 160
+      // The smallest breakpoint is 20rem, which is 360px.
+      // 0.5 x 360 = 160
+
+      const src = placeholderImage.getAttribute('src');
+
+      expect(src).toEqual(expect.stringContaining('width=160'));
+    });
+
+    it('does not render an lqip if critical is true', () => {
+      const { placeholderImage } = setup({ critical: true });
+
+      const src = placeholderImage.getAttribute('src');
+
+      // Sets the src to transaprent data image instead
+      expect(src).toEqual(expect.stringContaining('data:image'));
+    });
+
+    it('accepts sizes as pixel values', () => {
+      const { placeholderImage } = setup({ sizes: [123] });
+
+      const src = placeholderImage.getAttribute('src');
+
+      expect(src).toEqual(expect.stringContaining('width=123'));
+    });
+
+    it('sets opacity to 0.6 while image has not loaded', () => {
+      const { placeholderImage } = setup();
+
+      expect(placeholderImage).toHaveStyle('opacity: 0.6');
+    });
+  });
+
+  describe('sets the sizing method', () => {
+    it('to thumbnail if no aspect ratio is provided', () => {
+      const { placeholderImage } = setup();
+    });
+    it('to fit if an aspect ratio is provided', () => {
+      const { placeholderImage } = setup({ aspect: '1:1' });
+
+      expect(placeholderImage.getAttribute('src')).toEqual(
+        expect.stringContaining('&height=320')
+      );
+      expect(placeholderImage.getAttribute('src')).toEqual(
+        expect.stringContaining('&width=320')
+      );
+    });
+    it('to crop if crop prop is true', () => {
+      const { placeholderImage } = setup({ aspect: '1:1', crop: true });
+
+      expect(placeholderImage.getAttribute('src')).toEqual(
+        expect.stringContaining('&method=crop')
+      );
+    });
+    it('warns if gravity is provided without crop', () => {
+      console.warn = jest.fn();
+      setup({ aspect: '1:1', crop: false, gravity: 'north' });
+      expect(console.warn).toHaveBeenCalled();
+    });
+  });
+
+  describe('when image is in view', () => {
+    beforeAll(() => {
+      useInView.mockImplementation(() => [null, true]);
+    });
+
+    it('renders full image', () => {
+      const { image } = setup({
+        imageSrc: testImage
+      });
+
+      expect(image).toHaveAttribute('src', 'test-image.png');
+    });
+
+    it('applies the given alt as an aria-label', () => {
+      const { image } = setup({
+        alt: 'test alt'
+      });
+
+      expect(image).toHaveAttribute('alt', 'test alt');
+    });
+
+    it('defaults aspect to 1:1', () => {
+      const { imageContainer } = setup();
+
+      expect(imageContainer).toHaveStyle('padding-bottom : 100%');
+    });
+
+    it('sets aspect ratio using padding if aspect is passed', () => {
+      const { imageContainer } = setup({ aspect: '3:2' });
+
+      expect(imageContainer).toHaveStyle('padding-bottom : 66.6667%');
+    });
+
+    it('defaults to background-size contain', () => {
+      const { image } = setup();
+
+      expect(image).toHaveStyle('object-fit : contain');
+    });
+
+    it('sets background-size to cover if `cover` is passed', () => {
+      const { image } = setup({ cover: true });
+
+      expect(image).toHaveStyle('object-fit : cover');
+    });
+
+    it('sets up image to fill available space if `fillAvailableSpace` is passed', () => {
+      const { image } = setup({ fillAvailableSpace: true });
+
+      expect(image).toHaveStyle('object-fit : cover');
+      expect(image).toHaveStyle('padding-top : 0');
+    });
+
+    it('sets opacity to 1 when image loads', () => {
+      const { image } = setup();
+      fireEvent.load(image);
+
+      expect(image).toHaveStyle('opacity: 1');
+    });
+
+    it('fades lqip when image loads', () => {
+      const { image, placeholderImage } = setup();
+      fireEvent.load(image);
+
+      expect(placeholderImage).toHaveStyle('opacity: 0');
+    });
+
+    test('sets quality to quality prop', () => {
+      const { image } = setup({ quality: 1 });
+
+      expect(image.getAttribute('srcSet')).toEqual(
+        expect.stringContaining('&quality=1')
+      );
+    });
+  });
+
+  describe('when there is an image error', () => {
+    beforeAll(() => {
+      useInView.mockImplementation(() => [null, true]);
+    });
+
+    it('renders default error', () => {
+      const { image, getByText } = setup();
+      fireEvent.error(image);
+
+      expect(getByText('Image Not Found'));
+    });
+
+    it('renders error component', () => {
+      const { image, getByText, container } = setup({
+        error: () => <div>some error found</div>
+      });
+      fireEvent.error(image);
+
+      expect(getByText('some error found'));
+      expect(queryByText(container, 'Image Not Found')).not.toBeInTheDocument();
+    });
+  });
+
+  describe('when image url is falsy', () => {
+    it('renders a transparent background image when null', () => {
+      const { image } = setup({ falsySrc: true, imageSrc: null });
+
+      expect(image).toHaveAttribute(`src`, transparent);
+      expect(image).toHaveStyle('opacity : 1');
+    });
+    it('renders a transparent background image when undefined', () => {
+      const { image } = setup({ falsySrc: true, imageSrc: undefined });
+
+      expect(image).toHaveAttribute(`src`, transparent);
+      expect(image).toHaveStyle('opacity: 1');
+    });
+    it('renders nothing and warns if false', () => {
+      console.warn = jest.fn();
+      const { image } = setup({ falsySrc: true, imageSrc: false });
+
+      expect(image).not.toBeInTheDocument();
+      expect(console.warn).toHaveBeenCalled();
+    });
+  });
+
+  it('renders a webp and jpeg source', () => {
+    const { imageContainer } = setup();
+
+    const sources = imageContainer.querySelectorAll('source');
+    expect(sources.length).toBe(2);
+    expect(sources[0]).toHaveAttribute('type', 'image/webp');
+  });
+});
+
+function setup({
+  imageSrc,
+  falsySrc = false,
+  error,
+  alt,
+  sizes,
+  aspect,
+  cover,
+  ...rest
+} = {}) {
+  const channelHandler = new ChannelHandler({
+    selectedChannel,
+    channels
+  });
+  const utils = render(
+    <ChannelProvider channelHandler={channelHandler}>
+      <ConfigProvider config={mockShopConfig}>
+        <Image
+          src={falsySrc ? imageSrc : imageSrc || 'default.png'}
+          error={error}
+          alt={alt}
+          sizes={sizes}
+          aspect={aspect}
+          cover={cover}
+          {...rest}
+        />
+      </ConfigProvider>
+    </ChannelProvider>
+  );
+
+  return {
+    ...utils,
+    image: utils.container.querySelector('[data-flight-image] img'),
+    placeholderImage: utils.container.querySelector(
+      '[data-flight-image-placeholder] img'
+    ),
+    imageContainer: utils.container.querySelector(
+      '[data-flight-image-container]'
+    )
+  };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jetshop/ui",
-  "version": "6.3.8-alpha.20+d68acfe9a",
+  "version": "6.3.8-alpha.25+54a210697",
   "license": "MIT",
   "files": [
     "**/*.js",
@@ -60,5 +60,5 @@
     "react": "^18",
     "react-dom": "^18"
   },
-  "gitHead": "d68acfe9a9720e09b3ffa8288a355b70765752d5"
+  "gitHead": "54a2106975949d242f2ced3121792b836a463c3c"
 }