@mui/internal-test-utils 2.0.16 → 2.0.18-canary.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
-# Changelog
+# Versions
 
-## 1.0.0
+## 2.0.8
 
-Initial release as an npm package.
+Test release
+
+## 2.0.7
+
+Test release
+
+## 2.0.6
+
+Changelog start

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Call-Em-All
+Copyright (c) 2019 Material-UI SAS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,9 +1,55 @@
-# @mui/internal-test-utils
+# MUI Public
 
-This package contains test runner initialization functions and common tests shared between MUI packages.
-This is an internal package not meant for general use.
+Mono-repository for the MUI organization with code that can be public.
+See https://github.com/mui/mui-private for code that needs to be private.
 
-## Release
+## Documentation
 
-1. Build the project: `pnpm build`
-2. Publish the build artifacts to npm: `pnpm release:publish`
+You can [read the Infra documentation here](./docs/README.md).
+
+## Applications
+
+### [tools-public.mui.com](https://tools-public.mui.com/)
+
+- Folder: `/apps/tools-public/`
+- Hosting: https://dashboard.render.com/web/srv-d08mooq4d50c73fso49g
+- [Docs](./apps/tools-public/#readme)
+
+Internal public Toolpad apps that run the operations of MUI, built using https://github.com/mui/toolpad.
+
+### [Code infra dashboard](https://frontend-public.mui.com/)
+
+- URL: [frontend-public.mui.com](https://frontend-public.mui.com/)
+- Folder: `/apps/code-infra-dashboard/`
+- Hosting: https://app.netlify.com/sites/mui-frontend-public/overview
+- [Docs](./apps/code-infra-dashboard/#readme)
+
+## Packages
+
+### [docs-infra](./packages/docs-infra/)
+
+- Folder: `/packages/docs-infra/`
+- [Docs](./packages/docs-infra/README.md)
+
+### [code-infra](./packages/code-infra/)
+
+- Folder: `/packages/code-infra/`
+- [Docs](./packages/code-infra/README.md)
+
+## Versioning
+
+Steps:
+
+1. Checkout latest master
+1. Run `pnpm release:prepare`
+1. Run `pnpm release:version`
+1. Open PR with the changes
+
+## Publishing
+
+Steps:
+
+1. Merge versioning PR
+1. Checkout release commit on master
+1. Run `pnpm release:prepare`
+1. Run `pnpm release:publish`

package/chaiPlugin.d.ts

@@ -1,4 +1,3 @@
 import * as chai from 'chai';
-import "./chai.types.js";
 declare const chaiPlugin: Parameters<typeof chai.use>[0];
 export default chaiPlugin;

package/chaiPlugin.js

@@ -6,13 +6,14 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _dom = require("@testing-library/dom");
-var _pure = require("@testing-library/react/pure");
+var _pure = require("@testing-library/react/pure.js");
 var _domAccessibilityApi = require("dom-accessibility-api");
 var _formatUtil = _interopRequireDefault(require("format-util"));
 var _string = require("es-toolkit/string");
 var _assertionError = require("assertion-error");
-require("./chai.types");
 var _env = require("./env");
+// eslint-disable-next-line import/extensions
+
 // chai#utils.elToString that looks like stringified elements in testing-library
 function elementToString(element) {
   if (typeof element?.nodeType === 'number') {
@@ -147,7 +148,7 @@ const chaiPlugin = (chaiAPI, utils) => {
   chaiAPI.Assertion.addMethod('toHaveComputedStyle', function toHaveComputedStyle(expectedStyleUnnormalized) {
     const element = utils.flag(this, 'object');
     if (element?.nodeType !== 1) {
-      // Same pre-condition for negated and unnegated  assertion
+      // Same pre-condition for negated and unnegated assertion
       throw new _assertionError.AssertionError(`Expected an Element but got ${String(element)}`);
     }
     const computedStyle = element.ownerDocument.defaultView.getComputedStyle(element);
@@ -166,19 +167,17 @@ const chaiPlugin = (chaiAPI, utils) => {
     }
   });
   function addConsoleMatcher(matcherName, methodName) {
-    /**
-     * @param {string[]} expectedMessages
-     */
     function matcher(expectedMessagesInput = []) {
       // documented pattern to get the actual value of the assertion
       // eslint-disable-next-line no-underscore-dangle
       const callback = this._obj;
       if (process.env.NODE_ENV !== 'production') {
-        const expectedMessages = typeof expectedMessagesInput === 'string' ? [expectedMessagesInput] : expectedMessagesInput.slice();
+        const expectedMessages = Array.isArray(expectedMessagesInput) ? expectedMessagesInput.slice() : [expectedMessagesInput];
         const unexpectedMessages = [];
         // TODO Remove type once MUI X enables noImplicitAny
         let caughtError = null;
-        this.assert(expectedMessages.length > 0, `Expected to call console.${methodName} but didn't provide messages. ` + `If you don't expect any messages prefer \`expect().not.${matcherName}();\`.`, `Expected no call to console.${methodName} while also expecting messages.` + 'Expected no call to console.error but provided messages. ' + "If you want to make sure a certain message isn't logged prefer the positive. " + 'By expecting certain messages you automatically expect that no other messages are logged',
+        let result = null;
+        this.assert(expectedMessages.length > 0, `Expected to call console.${methodName} but didn't provide messages. ` + `If you don't expect any messages prefer \`expect().not.${matcherName}();\`.`, `Expected no call to console.${methodName} while also expecting messages. ` + "If you want to make sure a certain message isn't logged prefer the positive. " + 'By expecting certain messages you automatically expect that no other messages are logged',
         // Not interested in a diff but the typings require the 4th parameter.
         undefined);
 
@@ -204,7 +203,7 @@ const chaiPlugin = (chaiAPI, utils) => {
           let message = null;
           if (expectedMessage === undefined) {
             message = `Expected no more error messages but got:\n"${actualMessage}"`;
-          } else if (!actualMessage.includes(expectedMessage)) {
+          } else if (typeof expectedMessage === 'string' && !actualMessage.includes(expectedMessage) || expectedMessage instanceof RegExp && !expectedMessage.test(actualMessage)) {
             message = `Expected #${messagesMatched} "${expectedMessage}" to be included in \n"${actualMessage}"`;
           }
           if (message !== null) {
@@ -225,13 +224,10 @@ const chaiPlugin = (chaiAPI, utils) => {
         // eslint-disable-next-line no-console
         console[methodName] = consoleMatcher;
         try {
-          callback();
+          result = callback();
         } catch (error) {
           caughtError = error;
         } finally {
-          // eslint-disable-next-line no-console
-          console[methodName] = originalMethod;
-
           // unexpected thrown error takes precedence over unexpected console call
           if (caughtError !== null) {
             // not the same pattern as described in the block because we don't rethrow in the catch
@@ -248,31 +244,48 @@ const chaiPlugin = (chaiAPI, utils) => {
             });
             return `\n\n  - ${formattedMessages.join('\n\n-  ')}`;
           };
-          const shouldHaveWarned = utils.flag(this, 'negate') !== true;
+          const report = () => {
+            const shouldHaveWarned = utils.flag(this, 'negate') !== true;
 
-          // unreachable from expect().not.toWarnDev(messages)
-          if (unexpectedMessages.length > 0) {
-            const unexpectedMessageRecordedMessage = `Recorded unexpected console.${methodName} calls: ${formatMessages(unexpectedMessages)}`;
-            // chai will duplicate the stack frames from the unexpected calls in their assertion error
-            // it's not ideal but the test failure is located the second to last stack frame
-            // and the origin of the call is the second stackframe in the stack
-            this.assert(
-            // force chai to always trigger an assertion error
-            !shouldHaveWarned, unexpectedMessageRecordedMessage, unexpectedMessageRecordedMessage,
-            // Not interested in a diff but the typings require the 4th parameter.
-            undefined);
-          }
-          if (shouldHaveWarned) {
-            this.assert(remainingMessages.length === 0, `Could not match the following console.${methodName} calls. ` + `Make sure previous actions didn't call console.${methodName} by wrapping them in expect(() => {}).not.${matcherName}(): ${formatMessages(remainingMessages)}`, `Impossible state reached in \`expect().${matcherName}()\`. ` + `This is a bug in the matcher.`,
-            // Not interested in a diff but the typings require the 4th parameter.
-            undefined);
+            // unreachable from expect().not.toWarnDev(messages)
+            if (unexpectedMessages.length > 0) {
+              const unexpectedMessageRecordedMessage = `Recorded unexpected console.${methodName} calls: ${formatMessages(unexpectedMessages)}`;
+              // chai will duplicate the stack frames from the unexpected calls in their assertion error
+              // it's not ideal but the test failure is located the second to last stack frame
+              // and the origin of the call is the second stackframe in the stack
+              this.assert(
+              // force chai to always trigger an assertion error
+              !shouldHaveWarned, unexpectedMessageRecordedMessage, unexpectedMessageRecordedMessage,
+              // Not interested in a diff but the typings require the 4th parameter.
+              undefined);
+            }
+            if (shouldHaveWarned) {
+              this.assert(remainingMessages.length === 0, `Could not match the following console.${methodName} calls. ` + `Make sure previous actions didn't call console.${methodName} by wrapping them in expect(() => {}).not.${matcherName}(): ${formatMessages(remainingMessages)}`, `Impossible state reached in \`expect().${matcherName}()\`. ` + `This is a bug in the matcher.`,
+              // Not interested in a diff but the typings require the 4th parameter.
+              undefined);
+            }
+          };
+          if (result && typeof result === 'object' && 'then' in result && typeof result.then === 'function') {
+            // Handle async callbacks
+            result = Promise.resolve(result).then(value => {
+              report();
+              return value;
+            }).finally(() => {
+              // eslint-disable-next-line no-console
+              console[methodName] = originalMethod;
+            });
+          } else {
+            // eslint-disable-next-line no-console
+            console[methodName] = originalMethod;
+            report();
           }
         }
-      } else {
-        // nothing to do in prod
-        // If there are still console calls than our test setup throws.
-        callback();
+        return result;
       }
+
+      // nothing to do in prod
+      // If there are still console calls than our test setup throws.
+      return callback();
     }
     chaiAPI.Assertion.addMethod(matcherName, matcher);
   }

package/components.js

@@ -61,4 +61,5 @@ const RenderCounter = exports.RenderCounter = /*#__PURE__*/React.forwardRef(func
     },
     children: children
   });
-});
+});
+if (process.env.NODE_ENV !== "production") RenderCounter.displayName = "RenderCounter";

package/configure.d.ts

@@ -0,0 +1,9 @@
+export interface Configuration {
+  /**
+   * The emotion wrapper is optional.
+   * If your repository uses emotion, install `@emotion/react` and `@emotion/cache` and set this to true.
+   */
+  emotion: boolean;
+}
+export declare const config: Configuration;
+export declare function configure(newConfig?: Partial<Configuration>): void;

package/configure.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.config = void 0;
+exports.configure = configure;
+const defaultConfig = {
+  emotion: false
+};
+const config = exports.config = {
+  ...defaultConfig
+};
+function configure(newConfig = {}) {
+  Object.assign(config, newConfig);
+}

package/createDescribe.d.ts

@@ -1,7 +1,14 @@
-type MUIDescribe<P extends any[]> = {
+export type MUIDescribe<P extends any[]> = {
   (...args: P): void;
   skip: (...args: P) => void;
   only: (...args: P) => void;
 };
-declare const _default: <P extends any[]>(message: string, callback: (...args: P) => void) => MUIDescribe<P>;
-export default _default;
+/**
+ * Create a custom describe function with chainable skip and only methods.
+ * It is used to group conformance tests but still make the focusable/skippable.
+ *
+ * @param message - The message to display for the describe block.
+ * @param callback - The callback function containing the tests.
+ * @returns A custom describe function with skip and only methods.
+ */
+export default function createDescribe<P extends any[]>(message: string, callback: (...args: P) => void): MUIDescribe<P>;

package/createDescribe.js

@@ -3,9 +3,17 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.default = createDescribe;
 var _vitest = require("vitest");
-var _default = (message, callback) => {
+/**
+ * Create a custom describe function with chainable skip and only methods.
+ * It is used to group conformance tests but still make the focusable/skippable.
+ *
+ * @param message - The message to display for the describe block.
+ * @param callback - The callback function containing the tests.
+ * @returns A custom describe function with skip and only methods.
+ */
+function createDescribe(message, callback) {
   const muiDescribe = (...args) => {
     (0, _vitest.describe)(message, () => {
       callback(...args);
@@ -22,5 +30,4 @@ var _default = (message, callback) => {
     });
   };
   return muiDescribe;
-};
-exports.default = _default;
+}