Merge branch 'master' into system-reqs-support

Author: jeff-matthews

src/_data/whats-new.yml

@@ -4,8 +4,36 @@ description: This page contains recent changes that we think you'd like to know
   We exclude from this list proofreading, spelling checks, and all minor updates.
 link: "/whats-new.html"
 thread: "/whatsnew-feed.xml"
-updated: Mon Jan 3 15:38:47 2022
+updated: Mon Jan 10 15:38:44 2022
 entries:
+- description: Added new supported versions of Elasticsearch, OpenSearch, Redis, RabbitMQ,
+    and Varnish to the [system requirements](https://devdocs.magento.com/guides/v2.4/install-gde/system-requirements.html)
+    for 2.4.4 and 2.4.5
+  versions: 2.4.4
+  type: Major Update
+  date: January 7, 2022
+  link: https://github.com/magento-commerce/devdocs/pull/2726
+  merge_commit: 98c3b406f2275faac00f8fa7a24a04bf315ed961
+  contributor: jeff-matthews
+  membership: true
+  labels:
+  - Major Update
+  - 2.4.4
+- description: Added new [parameterized data fixture](https://devdocs.magento.com/guides/v2.4/test/integration/parameterized_data_fixture.html)
+    and [data fixture data provider annotation](https://devdocs.magento.com/guides/v2.4/test/integration/annotations/magento-data-fixture-data-provider.html)
+    documentation for writing tests.
+  versions: 2.4.x
+  type: New Topic
+  date: January 4, 2022
+  link: https://github.com/magento/devdocs/pull/9273
+  merge_commit: ad816f5435223fd1bbdf8187f458fe1582193cb0
+  contributor: thiaramus
+  membership: true
+  labels:
+  - Internal Dev
+  - New Topic
+  - 2.4.x
+  - 'Progress: done'
 - description: Published [release notes](https://devdocs.magento.com/quality-patches/release-notes.html)
     for the 1.1.8 Quality Patches Tool (QPT) package release.
   versions: 2.x

src/_includes/upgrade/uct-error-reference.md

@@ -186,6 +186,11 @@ Custom code errors are raised when custom code is using the Adobe Commerce entry
 | 6006 | `jQuery.size()` removed | Use `jQuery.length`. |
 | 6007 | `jQuery.trim` is deprecated | Use `String.prototype.trim`. |
 | 6008 | (`addButton`, `addContextToolbar`, `addMenuItem`, `addSidebar`, `file_browser_callback`, `insert_button_items`, 'inlite' theme, 'mobile' theme, 'modern' theme) is removed | Update code to be compatible with tinymce5. |
+| 6009 | `jQuery.isFunction()` is deprecated | In most cases, it can be replaced by [typeof x === "function"]. |
+| 6009 | `jQuery.type()` is deprecated | Replace with an appropriate type check like [typeof x === "function"]. |
+| 6009 | `jQuery.isArray()` is deprecated | Use the native Array.isArray method instead. |
+| 6009 | `jQuery.parseJSON()` is deprecated | To parse JSON strings, use the native JSON.parse method instead. |
+| 6010 | (`jQuery.expr[":"]`, `jQuery.expr.filters`) is deprecated | Use jQuery.expr.pseudos instead. |
 
 ## Warnings
 

src/upgrade-compatibility-tool/developer.md

@@ -12,7 +12,7 @@ This topic contains information for developers who work closely with the {{site.
 
 ## {{site.data.var.ee}} API index integration
 
-{{site.data.var.ee}} API index integration is an internal integration solution that encompasses a set of tools to explore {{site.data.var.ee}} extensions developed by Adobe, {{site.data.var.ee}} Partners, and 3rd-party vendors based on static code analysis.
+{{site.data.var.ee}} API index integration is an internal integration solution that encompasses a set of tools to explore {{site.data.var.ee}} extensions developed by Adobe, {{site.data.var.ee}} Partners, and third-party vendors based on static code analysis.
 
 The integration with the {{site.data.var.ee}} API index is done through:
 
@@ -59,14 +59,14 @@ To run the integration tests, execute one of the following commands:
    *  `vendor/bin/phpunit -c tests/acceptance/phpunit.xml tests/acceptance`
    *  `vendor/bin/phpunit -c tests/acceptance/phpunit.xml --testsuite=acceptance-tests`
 
-## GraphQL unit testing and Eslint code analysis
+## GraphQL unit testing and ESLint code analysis
 
 ### Requirements
 
 {:.bs-callout-info}
 You must have Node.js on your system, see the [documentation](https://nodejs.dev/learn/how-to-install-nodejs).
 
-The following instructions are for MacOS systems:
+The following instructions are for macOS systems:
 
 1. Open a terminal and navigate to the root directory of the project.
 1. Install project dependencies:
@@ -76,6 +76,7 @@ The following instructions are for MacOS systems:
    ```
 
 ### GraphQL unit testing
+
 The [Jest](https://jestjs.io/docs/en/getting-started.html) framework was used to create these JS unit tests:
 
 The tests are inside `dev/tests/Js`.
@@ -85,15 +86,17 @@ The string schemas for testing are inside `dev/tests/Acceptance/_files/graphql_s
 Run unit tests or `jest` as follows:
 
    ```bash
-   npm run unit-test
+  ./node_modules/.bin/jest --verbose --rootDir=dev/tests/Js/
    ```
-### Eslint code analysis
-[Eslint](https://eslint.org/docs/user-guide/getting-started) is a static code analysis tool for identifying problematic patterns found in JavaScript code, with the goal of making code more consistent and avoiding bugs.
+### ESLint code analysis
+
+[ESLint](https://eslint.org/docs/user-guide/getting-started) is a static code analysis tool for identifying problematic patterns found in JavaScript code, with the goal of making code more consistent and avoiding bugs.
 
 Run `eslint` code analysis as follows:
 
    ```bash
    npm run eslint -- path/to/analyse
+   ./node_modules/.bin/eslint -c dev/tests/Static/.eslintrc --rulesdir vendor/magento/magento-coding-standard/eslint/rules path/to/analyse
    ```
 
 ## Complexity score
@@ -112,7 +115,7 @@ The {{site.data.var.uct}} calculates this score according to the complexity scor
 
 ### Complexity score formula
 
-`Complexity Score = ({{site.data.var.ee}} core errors) * 4 + (Critical errors) * 4 + [(PHP and JS errors)+(GraphQL errors)] * 2 + [(PHP and JS warnings)+(GraphQL warnings)] * 1`
+`Complexity Score = (Critical issues * 3) + (Errors * 2) + Warnings`
 
 {:.bs-callout-warning}
 These are absolute values.

src/upgrade-compatibility-tool/img/uct-html-details.png

@@ -28,9 +28,7 @@ The `upgrade:check` command runs the {{site.data.var.uct}} and checks an {{site.
 {:.bs-callout-warning}
 Execute only when the project root (or main) directory is provided.
 
-This command checks for core code changes for that specific {{site.data.var.ee}} instance, as well as all custom code changes installed in it.
-
-However, you can run the `core:code:changes` command to analyze only core code changes for that specific {{site.data.var.ee}} instance. See [Core code changes]({{site.baseurl}}/upgrade-compatibility-tool/run.html#core-code) section for more information.
+You can run the `core:code:changes` command to analyze only core code changes for that specific {{site.data.var.ee}} instance. See [Core code changes]({{site.baseurl}}/upgrade-compatibility-tool/run.html#core-code) section for more information.
 
 While you can use the `graphql:compare` command to compare two GraphQL schemas to check for any changes between them. See [GraphQL schema compatibility verification]({{site.baseurl}}/upgrade-compatibility-tool/run.html#graphql-schema-compatibility-verification) section for more information.
 
@@ -64,40 +62,118 @@ bin/uct upgrade:check --help
 
 Available `--help` options for the `upgrade:check` command:
 
-*  `--raw`: Outputs raw information.
-*  `--format=FORMAT`: Output format (txt, xml, json, md).
-*  `--short`: Skip arguments description.
-*  `-o, --output[=OUTPUT]`: Path directory to export the `.json` output file.
-*  `-m, --module-path[=MODULE-PATH]`: Modules path directory .
-*  `--schema1[=SCHEMA1]`: Endpoint URL for the existing installation.
-*  `--schema2[=SCHEMA2]`: Endpoint URL for the vanilla installation.
-*  `--vanilla-dir`: {{site.data.var.ee}} vanilla installation directory.
+*  `-m, --module-path[=MODULE-PATH]`: Path of the modules to be analysed
+*  `-a, --current-version[=CURRENT-VERSION]`: Current {{site.data.var.ee}} version, version of the {{site.data.var.ee}} installation will be used if omitted.
+*  `-c, --coming-version[=COMING-VERSION]`: Target {{site.data.var.ee}} version, version of the {{site.data.var.ee}} installation will be used if omitted.
+*  `--json-output-path[=JSON-OUTPUT-PATH]`: Path of the file where the output will be exported in json format
+*  `--html-output-path[=HTML-OUTPUT-PATH]`: Path of the file where the output will be exported in HTML format
 *  `--min-issue-level`: Minimum issue level to show in report. Default is [WARNING].
 *  `--ignore-current-version-compatibility-issues`: Use this option when you do not want to include known critical issues, errors and warnings in your {{site.data.var.uct}} report.
-*  `-h, --help`: Display help for that specific command. If no command is provided, `list` command is the default result.
-*  `-q, --quiet`: Do not outputs any message while executing the command.
-*  `-v, --version`: Display app version.
+*  `--context=CONTEXT`: Execution context. This option is for integration purposes and does not affect the execution result.
+*  `-h, --help`: Display help for the given command. If no command is provided, `list` command is the default result.
+*  `-q, --quiet`: Do not output any message while executing the command.
+*  `-v, --version`: Display application version.
 *  `--ansi, --no-ansi`: Enable ANSI output.
 *  `-n, --no-interaction`: Do not ask any interactive question while executing the command.
 *  `-v, --vv, --vvv, --verbose`: Increase verbosity of output communications. 1 for normal output, 2 for verbose output, and 3 for DEBUG output.
 
 ### Output
 
-The {{site.data.var.uct}} exports a `json` file report identifying the affected code or modules, and the severity and description of the problem for every issue encountered.
+As a result of the analysis performed, the {{site.data.var.uct}} exports a report that contains a list of issues for each file specifying its severity, error code and error description.
+
+See the example below:
+
+```terminal
+File: /app/code/Custom/CatalogExtension/Controller/Index/Index.php
+------------------------------------------------------------------
+
+ * [WARNING][1131] Line 23: Extending from class 'Magento\Framework\App\Action\Action' that is @deprecated on version '2.4.2'
+ * [ERROR][1429] Line 103: Call method 'Magento\Framework\Api\SearchCriteriaBuilder::addFilters' that is non API on version '2.4.2'
+ * [CRITICAL][1110] Line 60: Instantiating class/interface 'Magento\Catalog\Model\ProductRepository' that does not exist on version '2.4.2'
+```
+
+Check the [Error message reference]({{site.baseurl}}/upgrade-compatibility-tool/errors.html) topic for more information.
+
+The report also includes a detailed summary that shows:
+
+*  *Current version*: the version currently installed.
+*  *Target Version*: the version you want to upgrade to.
+*  *Execution time*: the amount of time the analysis took to build the report (mm:ss).
+*  *Modules that require update*: the percentage of modules that contain compatibility issues and require update.
+*  *Files that require update*: the percentage of files that contain compatibility issues and require update.
+*  *Total critical errors*: the number of critical errors found.
+*  *Total errors*: the number of errors found.
+*  *Total warnings*: the number of warnings found.
+
+See the example below:
+
+```terminal
+ ----------------------------- ------------------
+  Current version               2.4.2
+  Target version                2.4.3
+  Execution time                1m:10s
+  Modules that require update   78.33% (47/60)
+  Files that require update     21.62% (115/532)
+  Total critical issues         35
+  Total errors                  201
+  Total warnings                103
+ ----------------------------- ------------------
+```
+
+{:.bs-callout-warning}
+By default, the {{site.data.var.uct}} exports the report into 2 different formats: `json` and `html`.
+
+#### JSON
+
+The JSON file contains exactly the same information shown on output:
+
+*  List of the identified issues.
+*  Summary of the analysis.
+
+For each encountered issue, the report provides detailed information such as the severity and description of the problem.
+
+{:.bs-callout-info}
+The default path for the output folder is `var/output/[TIME]-results.json`.
 
 To export this report into a different output folder, run:
 
 ```bash
-bin/uct upgrade:check <dir> --output[=OUTPUT]
+bin/uct upgrade:check <dir> --json-output-path[=JSON-OUTPUT-PATH]
 ```
 
 Where arguments are as follows:
 
 *  `<dir>`: {{site.data.var.ee}} installation directory.
-*  `[=OUTPUT]`: Path directory to export the `.json` output file.
+*  `[=JSON-OUTPUT-PATH]`: Path directory to export the `.json` output file.
+
+#### HTML
+
+The HTML file will also contain the list of identified issues and the summary of the analysis. But on top of this, it will include 4 different charts that makes the report more visually understandable:
+
+*  *Modules by issue severity*: shows a severity distribution by modules.
+*  *Files by issue severity*: shows a severity distribution by files.
+*  *Modules ordered by total number of issues*: shows the 10 most compromised modules taking into account warnings, errors and critical errors.
+*  *Modules with relative sizes and issues*: The more files a module contains, the bigger its circle. The more issues a module has, the more red its circle appears.
+
+These charts will allow you to identify the parts are most compromised and the ones that require more work to perform the upgrade to a later version with just a glance.
+
+![HTML report - Summary](img/uct-html-summary.png){:height="80%" width="80%"}
+
+![HTML report - Details](img/uct-html-details.png){:height="80%" width="80%"}
 
 {:.bs-callout-info}
-The default path for the output folder is `var/output/[TIME]-results.json`.
+The default path for the output folder is `var/output/[TIME]-results.html`.
+
+To export this report into a different output folder run:
+
+```bash
+bin/uct upgrade:check <dir> --html-output-path[=HTML-OUTPUT-PATH]
+```
+
+Where arguments are as follows:
+
+*  `<dir>`: {{site.data.var.ee}} installation directory.
+*  `[=HTML-OUTPUT-PATH]`: Path directory to export the `.html` output file.
 
 ### Use the `--ignore-current-version-compatibility-issues` option
 
@@ -108,7 +184,7 @@ bin/uct upgrade:check --ignore-current-version-compatibility-issues <dir>
 ```
 
 {:.bs-callout-info}
-This applies only to PHP API validations. Core code validations are compared only with the same version.
+This applies only to PHP API validations.
 
 ### Vanilla installation
 
@@ -222,81 +298,9 @@ Available `--help` options for the `graphql:compare` command:
 
 See [Developer information]({{site.baseurl}}/upgrade-compatibility-tool/developer.html) for more information.
 
-### Full report
-
-You can also get a full report containing both _PHP-related_ errors and GraphQL. In this case, you must provide at least the following options:
-
-*  `--schema1=SCHEMA1`: Endpoint URL for the existing installation.
-*  `--schema2=SCHEMA2`: Endpoint URL for the vanilla installation.
-*  `<dir>`: {{site.data.var.ee}} installation directory.
-
-> Example:
-
-```bash
-bin/uct upgrade:check --schema1=https://domain1.com/graphql --schema2=https://domain2.com/graphql -c 2.4.3 <dir>
-```
-
-## Example with a list of critical issues, errors, and warnings
-
-```terminal
-File: /app/code/Custom/CatalogExtension/Controller/Index/Index.php
-------------------------------------------------------------------
-
- * [WARNING][1131] Line 23: Extending from class 'Magento\Framework\App\Action\Action' that is @deprecated on version '2.4.2'
- * [ERROR][1429] Line 103: Call method 'Magento\Framework\Api\SearchCriteriaBuilder::addFilters' that is non API on version '2.4.2'
- * [CRITICAL][1110] Line 60: Instantiating class/interface 'Magento\Catalog\Model\ProductRepository' that does not exist on version '2.4.2'
-```
-
-The report also includes a detailed summary:
-
-*  *Installed Version*: the version currently installed.
-*  *{{site.data.var.ee}} Version*: the version you want to upgrade to.
-*  *Running time*: amount of time the analysis took to build the report (mm:ss).
-*  *{{site.data.var.ee}} core checked modules*: amount of core checked modules.
-*  *{{site.data.var.ee}} core modified files*: amount of core modified file.
-*  *{{site.data.var.ee}} % core modified files*: percentage of core modified files.
-*  *{{site.data.var.ee}} checked modules*: amount of checked modules.
-*  *Compatibility errors found*: amount of compatibility errors.
-*  *Compatibility warnings found*: amount of compatibility warnings.
-*  *Compatibility critical errors found*: amount of compatibility critical errors.
-*  *GraphQL critical errors found*: amount of GraphQL critical errors.
-*  *GraphQL warnings found*: amount of GraphQL warnings.
-*  *Total errors found*: total amount of errors found.
-*  *Total warnings found*: total amount of warnings found.
-*  *Complexity score*: a figure that indicates how difficult is to upgrade from the current version to the new one.
-
-The lower this number is, the easier is to perform the upgrade.
-
-See the [Error message reference]({{site.baseurl}}/upgrade-compatibility-tool/errors.html) topic for more information.
-
-## Example of a general summary report
-
-```terminal
- ------------------------------------- -------
-  Installed version                    2.4.2
-  {{site.data.var.ee}} version               2.4.3
-  Running time                         0m:48s
-  Core files checked                   0
-  Core files modified                  0
-  % of files modified                  0.00
-  Checked modules                      14
-  Compatibility errors found           109
-  Compatibility warnings found         0
-  Compatibility critical errors found  0
-  GraphQL critical errors found        0
-  GraphQL warnings found               0
-  Total errors found                   109
-  Total warnings found                 0
-  Total critical errors found          0
-  Complexity score                     218
- ------------------------------------- -------
-```
-
-Regarding the GraphQL schema compatibility comparison, the output would be very similar:
-
-## Run {{site.data.var.uct}} via PHPstorm plugin
+## Run {{site.data.var.uct}} via PhpStorm plugin
 
-You can run the {{site.data.var.uct}} with a run configuration via the PHPstorm plugin. See the [Upgrade Compatibility Tool Run Configuration]({{site.baseurl}}/guides/v2.3/ext-best-practices/phpstorm/uct-run-configuration.html) topic for more information.
+You can run the {{site.data.var.uct}} with a run configuration via the PhpStorm plugin. See the [{{site.data.var.uct}} Run Configuration]({{site.baseurl}}/guides/v2.3/ext-best-practices/phpstorm/uct-run-configuration.html) topic for more information.
 
 ## Troubleshooting
 
@@ -311,7 +315,7 @@ If after running this command:
 bin/uct upgrade:check INSTALLATION_DIR -c M2_VERSION
 ```
 
-The only output is `Upgrade compatibility tool`:
+The only output is `{{site.data.var.uct}}`:
 
 ```terminal
 bin/uct upgrade:check /var/www/project/magento/ -c 2.4.1