@instructure/ui-react-utils/lib/__new-tests__/experimental.test.js

A React utility library made by Instructure Inc.

"use strict";

var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
var _react = require("react");
var _vitest = require("vitest");
var _propTypes = _interopRequireDefault(require("prop-types"));
var _react2 = require("@testing-library/react");
require("@testing-library/jest-dom");
var _experimental = require("../experimental");
var _jsxRuntime = require("@emotion/react/jsx-runtime");
/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 - present Instructure, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

class TestComponent extends _react.Component {
  render() {
    return (0, _jsxRuntime.jsxs)("div", {
      children: [this.props.qux, " ", this.props.bar]
    });
  }
}
TestComponent.displayName = "TestComponent";
TestComponent.propTypes = {
  bar: _propTypes.default.string,
  qux: _propTypes.default.string
};
TestComponent.defaultProps = {
  bar: void 0,
  qux: 'Hello'
};
describe('@experimental', () => {
  describe('experimental props', () => {
    var _ExperimentalComponen, _ExperimentalComponen2, _ExperimentalComponen3;
    const ExperimentalComponent = (0, _experimental.experimental)(['bar'])(TestComponent);
    it('should warn when using an experimental prop', () => {
      const consoleWarningSpy = _vitest.vi.spyOn(console, 'warn').mockImplementation(() => {});
      (0, _react2.render)(_ExperimentalComponen || (_ExperimentalComponen = (0, _jsxRuntime.jsx)(ExperimentalComponent, {
        bar: "Jane"
      })));
      const expectedWarningMessage = 'Warning: [TestComponent] The `bar` prop is experimental and its API could change significantly in a future release.';
      expect(consoleWarningSpy).toHaveBeenCalledWith(expect.stringContaining(expectedWarningMessage), expect.any(String));
      consoleWarningSpy.mockRestore();
    });
    it('should not output a warning using a non-experimental prop', () => {
      const consoleWarningSpy = _vitest.vi.spyOn(console, 'warn').mockImplementation(() => {});
      (0, _react2.render)(_ExperimentalComponen2 || (_ExperimentalComponen2 = (0, _jsxRuntime.jsx)(ExperimentalComponent, {
        qux: "Jane"
      })));
      expect(consoleWarningSpy).not.toHaveBeenCalled();
      consoleWarningSpy.mockRestore();
    });
    it('should not output a warning for an experimental prop when dangerously ignored', () => {
      const consoleWarningSpy = _vitest.vi.spyOn(console, 'warn').mockImplementation(() => {});
      (0, _react2.render)(_ExperimentalComponen3 || (_ExperimentalComponen3 = (0, _jsxRuntime.jsx)(ExperimentalComponent, {
        qux: "Jane",
        __dangerouslyIgnoreExperimentalWarnings: true
      })));
      expect(consoleWarningSpy).not.toHaveBeenCalled();
      consoleWarningSpy.mockRestore();
    });
  });
  describe('experimental component', () => {
    var _ExperimentalComponen4, _ExperimentalComponen5;
    const ExperimentalComponent = (0, _experimental.experimental)()(TestComponent);
    it('should warn that the entire component is experimental if no props are supplied', () => {
      const consoleWarningSpy = _vitest.vi.spyOn(console, 'warn').mockImplementation(() => {});
      (0, _react2.render)(_ExperimentalComponen4 || (_ExperimentalComponen4 = (0, _jsxRuntime.jsx)(ExperimentalComponent, {})));
      const expectedWarningMessage = 'Warning: [TestComponent] is experimental and its API could change significantly in a future release.';
      expect(consoleWarningSpy).toHaveBeenCalledWith(expect.stringContaining(expectedWarningMessage), expect.any(String));
      consoleWarningSpy.mockRestore();
    });
    it('should not output a warning for a component when dangerously ignored', () => {
      const consoleWarningSpy = _vitest.vi.spyOn(console, 'warn').mockImplementation(() => {});
      (0, _react2.render)(_ExperimentalComponen5 || (_ExperimentalComponen5 = (0, _jsxRuntime.jsx)(ExperimentalComponent, {
        __dangerouslyIgnoreExperimentalWarnings: true
      })));
      expect(consoleWarningSpy).not.toHaveBeenCalled();
      consoleWarningSpy.mockRestore();
    });
  });
});