@instructure/ui-react-utils/src/experimental.ts

A React utility library made by Instructure Inc.

/*
 * 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.
 */
import { decorator } from '@instructure/ui-decorator'
import { logWarn as warn } from '@instructure/console'
import { ComponentClass } from 'react'

/**
 * ---
 * category: utilities/react
 * ---
 * Flag React component and component props as experimental.
 * Warnings will display in the console when experimental components/props
 * props are used.
 *
 * ```js-code
 *  class Example extends Component {
 *    static propTypes = {
 *      currentProp: PropTypes.func
 *    }
 *  }
 *  export default experimental(['experimentalProp'])(Example)
 * ```
 *
 * @module experimental
 * @param {array} experimentalProps (if this argument is null or undefined, the entire component is flagged)
 * @param {string} message
 * @return {function} React component flagged as experimental
 */
const experimental =
  process.env.NODE_ENV == 'production'
    ? () => (ReactComponent: ComponentClass<any>) => ReactComponent
    : decorator(
        (ComposedComponent, experimentalProps: string[], message: string) => {
          return class ExperimentalComponent<
            P extends Readonly<any>,
            S extends Readonly<any>,
            SS
          > extends ComposedComponent {
            componentDidMount() {
              if (
                !(this.props as any).__dangerouslyIgnoreExperimentalWarnings
              ) {
                if (experimentalProps) {
                  warnExperimentalProps(
                    ComposedComponent.name,
                    this.props,
                    experimentalProps,
                    message
                  )
                } else {
                  warnExperimentalComponent(ComposedComponent.name, message)
                }
              }

              if (super.componentDidMount) {
                super.componentDidMount()
              }
            }

            componentDidUpdate(prevProps: P, prevState: S, prevContext: SS) {
              if (
                !(this.props as any).__dangerouslyIgnoreExperimentalWarnings
              ) {
                if (experimentalProps) {
                  warnExperimentalProps(
                    ComposedComponent.name,
                    this.props,
                    experimentalProps,
                    message
                  )
                } else {
                  warnExperimentalComponent(ComposedComponent.name, message)
                }
              }

              if (super.componentDidUpdate) {
                super.componentDidUpdate(prevProps, prevState, prevContext)
              }
            }
          }
        }
      )

function warnExperimentalProps(
  name: string,
  props: Record<string, any>,
  experimentalProps: string[],
  message = ''
) {
  experimentalProps.forEach((experimentalProp) => {
    warn(
      typeof props[experimentalProp] === 'undefined',
      `[${name}] The \`${experimentalProp}\` prop is experimental and its API could change significantly in a future release. ${message}`
    )
  })
}

function warnExperimentalComponent(name: string, message = '') {
  warn(
    false,
    `[${name}] is experimental and its API could change significantly in a future release. ${message}`
  )
}

export default experimental
export { experimental }