Player does not work with jest

[ghost]

Overview

When importing import { DotLottieReact } from "@lottiefiles/dotlottie-react";

To use the player jest will error with this:

  ● Test suite failed to run

    Jest encountered an unexpected token

    Jest failed to parse a file. This happens e.g. when your code or its dependencies use non-standard JavaScript syntax, or when Jest is not configured to support such syntax.

    Out of the box Jest supports Babel, which will be used to transform your files into valid JS based on your Babel configuration.

    By default "node_modules" folder is ignored by transformers.

    Here's what you can do:
     • If you are trying to use ECMAScript Modules, see https://jestjs.io/docs/ecmascript-modules for how to enable it.
     • If you are trying to use TypeScript, see https://jestjs.io/docs/getting-started#using-typescript
     • To have some of your "node_modules" files transformed, you can specify a custom "transformIgnorePatterns" in your config.
     • If you need a custom transformation specify a "transform" option in your config.
     • If you simply want to mock your non-JS modules (e.g. binary assets) you can stub them out with the "moduleNameMapper" config option.

    You'll find more details and examples of these config options in the docs:
    https://jestjs.io/docs/configuration
    For information about custom transformations, see:
    https://jestjs.io/docs/code-transformation

    Details:

    /Users/juzorensen/WebstormProjects/forbole-website/node_modules/@lottiefiles/dotlottie-react/dist/index.js:1
    ({"Object.<anonymous>":function(module,exports,require,__dirname,__filename,jest){import React, { useState, useRef, useCallback, useMemo, useEffect, useLayoutEffect } from 'react';
                                                                                      ^^^^^^

    SyntaxError: Cannot use import statement outside a module

Consuming repo

dotlottie-web

Labels

• [ ] Add the Type: Bug label to this issue.

[theashraf]

Hi @0x7u, we don't ship CJS for dotLottie-react, only ESM. You might want to check out how to mock the dotLottie-react module in Jest: https://jestjs.io/docs/ecmascript-modules#module-mocking-in-esm. By the way, which version of Jest are you using?

[ghost]

Hey @theashraf, thanks for the reply.

I am Jest version 29.7.0.

I've just tried the workaround you suggested it did not work for me, maybe I am not doing something right. I also lazy-loaded the component with nextjs dynamic helper (to disable SSR), and I met with even more nonsense 😅.

    Warning: An update to ForwardRef(LoadableComponent) inside a test was not wrapped in act(...).
    
    When testing, code that causes React state updates should be wrapped into act(...):
    
    act(() => {
      /* fire events that update state */
    });
    /* assert on the output */

[theashraf]

@0x7u I see. I'll investigate further and let you know.

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs.

[mpedersen15]

I was running into the same issue and mocking ended up being the key. I used this simple mock in my setup-tests.js script and that prevented the Cannot use import statement outside a module error I was seeing:

jest.mock('@lottiefiles/dotlottie-react', () => {
  return {
    DotLottieReact: () => null, // I'm not concerned with testing our animations themselves
  };
});

Hopefully this helps someone else in need!

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs.