Merge branch 'master' into 9.2.0-release

chrisbreiding · chrisbreiding · commit 4b6b3cf26aaf · 2021-12-13T09:50:21.000-05:00
diff --git a/assets/img/guides/rule-application-selection.png b/assets/img/guides/rule-application-selection.png
diff --git a/assets/img/guides/vcxsrv-extra-settings.png b/assets/img/guides/vcxsrv-extra-settings.png
diff --git a/assets/img/guides/windows-firewall-disable-vcxsrv.png b/assets/img/guides/windows-firewall-disable-vcxsrv.png
diff --git a/content/_changelogs/5.4.0.md b/content/_changelogs/5.4.0.md
@@ -27,7 +27,7 @@ _Released 10/14/2020_
   [#8624](https://github.com/cypress-io/cypress/issues/8624)
 - When there is a new version of Cypress available, the update modal has a new
   design with 'copy to clipboard' buttons to copy the upgrade commands.
-  Addressed in [#8751](https://github.com/cypress-io/cypress/issues/8751).
+  Addressed in [#8751](https://github.com/cypress-io/cypress/pull/8751).
 - The [Command Log](/guides/core-concepts/test-runner#Command-Log) can be hidden
   by passing the `CYPRESS_NO_COMMAND_LOG=1` environment variable during
   `cypress open` or `cypress run` to be used as a tool to debug performance
diff --git a/content/_changelogs/5.5.0.md b/content/_changelogs/5.5.0.md
@@ -13,7 +13,7 @@ _Released 10/26/2020_
 **Bugfixes:**
 
 - Updated the Cypress proxy layer to proxy HTTPS traffic from non-AUT origins.
-  Addressed in [#8827](https://github.com/cypress-io/cypress/issues/8827).
+  Addressed in [#8827](https://github.com/cypress-io/cypress/pull/8827).
   - This fixed an issue with [`cy.route2()`](http) where HTTPS requests to a
     non-AUT origin would not be intercepted as expected.
 - [`cy.route2()`](http) now properly handles passing a method as its first
diff --git a/content/_changelogs/6.0.0.md b/content/_changelogs/6.0.0.md
@@ -62,7 +62,7 @@ deprecations.
   support for `cy.server()` and `cy.route()` will be removed. We encourage you
   to use [cy.intercept()](/api/commands/intercept) instead. See our guide on
   [Migrating `cy.route()` to `cy.intercept()`](/guides/references/migration-guide#Migrating-cy-route-to-cy-intercept).
-  Addressed in [#9185](https://github.com/cypress-io/cypress/issues/9185).
+  Addressed in [#9185](https://github.com/cypress-io/cypress/pull/9185).
 - `experimentalFetchPolyfill` has been deprecated. We encourage you to use
   [cy.intercept()](/api/commands/intercept) to intercept requests using the
   Fetch API instead.
diff --git a/content/_changelogs/6.1.0.md b/content/_changelogs/6.1.0.md
@@ -35,7 +35,7 @@ _Released 12/07/2020_
   [#8999](https://github.com/cypress-io/cypress/issues/8999).
 - We fixed an issue where HTTP redirects could not be awaited using
   [cy.intercept()](/api/commands/intercept) unless dynamically intercepted.
-  Addressed in [#9097](https://github.com/cypress-io/cypress/issues/9097).
+  Addressed in [#9097](https://github.com/cypress-io/cypress/pull/9097).
 - Tests will no longer hang in certain situations when there's an error in a
   `before()` hook. Fixes
   [#9162](https://github.com/cypress-io/cypress/issues/9162).
diff --git a/content/_changelogs/6.2.0.md b/content/_changelogs/6.2.0.md
@@ -7,14 +7,14 @@ _Released 12/21/2020_
 - You can now listen to `before:run`, `after:run`, `before:spec` and
   `after:spec` events in the plugins file when setting the
   [experimentalRunEvents](/guides/references/experiments) configuration option
-  to `true`. See the [before:run](/api/plugins/before-run-api),
-  [after:run](/api/plugins/after-run-api),
-  [before:spec](/api/plugins/before-spec-api) and
-  [after:spec](/api/plugins/after-spec-api) docs for more information. Addressed
-  in [#9646](https://github.com/cypress-io/cypress/issues/9646),
-  [#14178](https://github.com/cypress-io/cypress/issues/14178)
-  [#14238](https://github.com/cypress-io/cypress/issues/14238) and
-  [#14263](https://github.com/cypress-io/cypress/issues/14263).
+  to `true`. See the [`before:run`](/api/plugins/before-run-api),
+  [`after:run`](/api/plugins/after-run-api),
+  [`before:spec`](/api/plugins/before-spec-api) and
+  [`after:spec`](/api/plugins/after-spec-api) docs for more information.
+  Addressed in [#9646](https://github.com/cypress-io/cypress/pull/9646),
+  [#14178](https://github.com/cypress-io/cypress/pull/14178)
+  [#14238](https://github.com/cypress-io/cypress/pull/14238) and
+  [#14263](https://github.com/cypress-io/cypress/pull/14263).
 - The `Timed out retrying` error message now displays the amount of time Cypress
   retried. Addresses [#5781](https://github.com/cypress-io/cypress/issues/5781).
 - The RouteMatcher argument for [cy.intercept()](/api/commands/intercept) has a
diff --git a/content/_changelogs/6.7.0.md b/content/_changelogs/6.7.0.md
@@ -8,11 +8,11 @@ _Released 3/15/2021_
   listen to `before:run`, `after:run`, `before:spec` and `after:spec` events in
   the plugins file without needing the
   [experimentalRunEvents](/guides/references/experiments) configuration option.
-  See the [before:run](/api/plugins/before-run-api),
-  [after:run](/api/plugins/after-run-api),
-  [before:spec](/api/plugins/before-spec-api) and
-  [after:spec](/api/plugins/after-spec-api) docs for more information. Addressed
-  in [#15276](https://github.com/cypress-io/cypress/issues/15276).
+  See the [`before:run`](/api/plugins/before-run-api),
+  [`after:run`](/api/plugins/after-run-api),
+  [`before:spec`](/api/plugins/before-spec-api) and
+  [`after:spec`](/api/plugins/after-spec-api) docs for more information.
+  Addressed in [#15276](https://github.com/cypress-io/cypress/pull/15276).
 - When canceling a run from the Dashboard, previously only parallelized runs
   would cancel correctly. Now all recorded runs will respect cancelation and
   exit early. Addresses
@@ -25,7 +25,7 @@ _Released 3/15/2021_
   upfront. Addressed in
   [#14925](https://github.com/cypress-io/cypress/issues/14925).
 - The full stack trace from errors thrown in the preprocessor are now displayed.
-  Addressed in [#15198](https://github.com/cypress-io/cypress/issues/15198).
+  Addressed in [#15198](https://github.com/cypress-io/cypress/pull/15198).
 - Configuration values which are changed at runtime prior to tests running are
   now properly shown as resolved from the spec code within the Module API to
   indicate where the change originated from. Addresses
diff --git a/content/_changelogs/7.0.0.md b/content/_changelogs/7.0.0.md
@@ -75,7 +75,7 @@ in more detail and how to change your code to migrate to Cypress 7.0.**
   [`redirectionLimit`](guides/references/configuration#Global) config. Addresses
   [#14445](https://github.com/cypress-io/cypress/issues/14445).
 - The default preprocessor now targets a more modern version of ECMAScript.
-  Addressed in [#15274](https://github.com/cypress-io/cypress/issues/15274).
+  Addressed in [#15274](https://github.com/cypress-io/cypress/pull/15274).
 - We now enable
   [`contextIsolation`](https://www.electronjs.org/docs/tutorial/context-isolation)
   by default in the Electron browser. You can override this option if needed
diff --git a/content/_changelogs/8.3.0.md b/content/_changelogs/8.3.0.md
@@ -5,7 +5,7 @@ _Released 08/16/2021_
 **Features:**
 
 - The instructions for recording a run have been updated for some users.
-  Addressed in [#17317](https://github.com/cypress-io/cypress/issues/17317).
+  Addressed in [#17317](https://github.com/cypress-io/cypress/pull/17317).
 
 **Performance:**
 
diff --git a/content/_changelogs/9.1.0.md b/content/_changelogs/9.1.0.md
@@ -25,3 +25,5 @@ _Released 11/22/2021_
   [#18644](https://github.com/cypress-io/cypress/issues/18644).
 - Cypress commands that rely on `this` context now have access to `this` when
   overridden. Fixes [#18899](https://github.com/cypress-io/cypress/pull/18899).
+- Test configuration is now correctly applied when using `only`. Fixes
+  [#18959](https://github.com/cypress-io/cypress/issues/18959).
diff --git a/content/_changelogs/9.1.1.md b/content/_changelogs/9.1.1.md
@@ -0,0 +1,40 @@
+## 9.1.1
+
+_Released 12/03/2021_
+
+**Bugfixes:**
+
+- Fixed a regression in [9.1.0](/guides/references/changelog#9-1-0) where our
+  built binary didn't contain patches to some dependencies. Addressed in
+  [#19239](https://github.com/cypress-io/cypress/pull/19239). This fixed some
+  issues including:
+  - Requests containing `~` will no longer be improperly encoded. Fixes
+    [#19083](https://github.com/cypress-io/cypress/issues/19083),
+    [#19084](https://github.com/cypress-io/cypress/issues/19084),
+    [#19115](https://github.com/cypress-io/cypress/issues/19115),
+    [#19096](https://github.com/cypress-io/cypress/issues/19096),
+    [#19178](https://github.com/cypress-io/cypress/issues/19178).
+  - A TypeError displaying `data.hasOwnProperty is not a function` will no
+    longer throw in some situations. Fixes
+    [#19091](https://github.com/cypress-io/cypress/issues/19091).
+  - Empty extra hooks will no longer be sent as data when recording to the
+    Dashboard. Fixes
+    [#19087](https://github.com/cypress-io/cypress/issues/19087).
+  - The Runner hanging when baseUrl is set to null to load a local file. Fixes
+    [#19105](https://github.com/cypress-io/cypress/issues/19105)
+- When using the default configuration of `"nodeVersion": "system"` with an
+  installed system node >=17, Cypress will now work properly rather than throw
+  an error incorrectly pointing to the user's plugin file. Fixes
+  [#18914](https://github.com/cypress-io/cypress/issues/18914).
+- Shadow DOM elements no longer error as hidden during actionability when the
+  element is covered by its parent shadow root. Fixes
+  [#18008](https://github.com/cypress-io/cypress/issues/18008).
+- When using `.type()` events now correctly propagate out of the shadow DOM.
+  Fixes [#17531](https://github.com/cypress-io/cypress/issues/17531).
+- The `this` context is now properly preserved when overwriting `cy.clock()`.
+  Fixes [#19158](https://github.com/cypress-io/cypress/issues/19158).
+
+**Dependencies:**
+
+- Upgraded `@cypress/request` from `2.88.7` to `2.88.10`. Addressed in
+  [#19099](https://github.com/cypress-io/cypress/issues/19099).
diff --git a/content/api/cypress-api/dom.md b/content/api/cypress-api/dom.md
@@ -11,7 +11,7 @@ documented below. These methods are used internally by Cypress in nearly every
 single built in command.
 
 We suggest
-[reading through the source code here](https://github.com/cypress-io/cypress/blob/develop/packages/driver/src/dom/index.js)
+[reading through the source code here](https://github.com/cypress-io/cypress/blob/develop/packages/driver/src/dom/index.ts)
 to see all of the methods and what they do.
 
 </Alert>
diff --git a/content/api/plugins/writing-a-plugin.md b/content/api/plugins/writing-a-plugin.md
@@ -80,7 +80,7 @@ please [refer to the docs for each one](#List-of-events).
 This configuration contains all of the values that get passed into the browser
 for your project.
 
-[For a comprehensive list of all configuration values look here.](https://github.com/cypress-io/cypress/blob/master/packages/server/lib/config.js)
+[For a comprehensive list of all configuration values look here.](https://github.com/cypress-io/cypress/blob/master/packages/server/lib/config.ts)
 
 Some plugins may utilize or require these values, so they can take certain
 actions based on the configuration.
diff --git a/content/guides/getting-started/installing-cypress.md b/content/guides/getting-started/installing-cypress.md
@@ -9,6 +9,7 @@ title: Installing Cypress
 - How to install Cypress via `npm`
 - How to install Cypress via direct download
 - How to version and run Cypress via `package.json`
+- How to run Cypress on `wsl2` in windows
 
 </Alert>
 
@@ -515,3 +516,76 @@ Notes on pre-releases:
   release over a pre-release - if you have a pre-release of Cypress vX.Y.Z
   installed, the official release of Cypress vX.Y.Z will not install until you
   do `cypress cache clear`.
+
+### Windows Subsystem for Linux
+
+#### WSL2
+
+First, install the prerequisite packages using the command that relates to your
+linux distribution ([Ubuntu/Debian](#Ubuntu-Debian) or [CentOS](#CentOS)).
+
+We need to have an [X-server](https://en.wikipedia.org/wiki/X.Org_Server) to
+display the Cypress UI from the linux subsystem. There are a variety of
+X-servers available, here we are going to use VcXsrv, you can use any other
+similar tool.
+
+Download [VcXsrv](https://sourceforge.net/projects/vcxsrv/) and install. You can
+set the settings to your preference ("Multiple windows" and "Start no client"
+are recommended), but on the page that lets you enable extra settings, be sure
+to select "Disable access control" which is required as WSL2 has its own IP
+address, which changes often.
+
+<DocsImage src="/img/guides/vcxsrv-extra-settings.png" alt="Disable access control in vcxsrv" ></DocsImage>
+
+In your `.bashrc` (or equivalent such as `.zshrc`) set the `DISPLAY` environment
+variable.
+
+```shell
+# set DISPLAY variable to the IP automatically assigned to WSL2
+export DISPLAY=$(cat /etc/resolv.conf | grep nameserver | awk '{print $2; exit;}'):0.0
+```
+
+To confirm `DISPLAY` variable has been set, print it out in the terminal. You
+may need to restart your terminal to see this change.
+
+```shell
+echo $DISPLAY
+# something like 172.17.224.1:0.0
+```
+
+The VcXsrv GUI uses [D-Bus](https://www.freedesktop.org/wiki/Software/dbus/) to
+internally communicate. After the `export DISPLAY` line in your `.bashrc`, add
+the following:
+
+```shell
+sudo /etc/init.d/dbus start &> /dev/null
+```
+
+Now your user needs to be granted access to run `sudo dbus` without needing to
+enter a password. To do so, use the `visido` command:
+
+```shell
+sudo visudo -f /etc/sudoers.d/dbus
+```
+
+In the editor that launches, add the following line, replacing `<your_username>`
+with your username (you can use the `whoami` command to print your username if
+you don't know it).
+
+```
+<your_username> ALL = (root) NOPASSWD: /etc/init.d/dbus
+```
+
+Go to Control Panel > System and Security > Windows Defender Firewall > Inbound
+Rules > New Rule.
+
+<DocsImage src="/img/guides/windows-firewall-disable-vcxsrv.png" alt="Add rule to allow connections for vcxsrv" ></DocsImage>
+
+Select Program and click on next. On the This program path, browse and select
+path to VcxSrv. On the next page select allow the connection and click next. On
+the next page, select all three options (Domain, Private, Public).
+
+<DocsImage src="/img/guides/rule-application-selection.png" alt="Select inbound rule application cases for vcxsrv" ></DocsImage>
+
+Give the rule a suitable name and description and click finish. WSL2 should now
+be able to open a GUI from shell.
diff --git a/content/guides/getting-started/testing-your-app.md b/content/guides/getting-started/testing-your-app.md
@@ -350,7 +350,7 @@ a much more thorough analysis and approach to accomplishing this.
 ### Logging in
 
 One of the first (and arguably one of the hardest) hurdles you'll have to
-overcome is testing logging into your application.
+overcome in testing is logging into your application.
 
 Nothing slows a test suite down like having to log in, but all the good parts of
 your application most likely require an authenticated user! Here are some tips.
diff --git a/content/guides/references/best-practices.md b/content/guides/references/best-practices.md
@@ -913,27 +913,29 @@ We have
 
 </Alert>
 
-By adding a [baseUrl](/guides/references/configuration#Global) in your configuration
-Cypress will attempt to prefix the `baseUrl` any URL provided to commands like [cy.visit()](/api/commands/visit)
-and [cy.request()](/api/commands/request) that are not fully qualified domain name (FQDN) URLs.
+By adding a [baseUrl](/guides/references/configuration#Global) in your
+configuration Cypress will attempt to prefix the `baseUrl` any URL provided to
+commands like [cy.visit()](/api/commands/visit) and
+[cy.request()](/api/commands/request) that are not fully qualified domain name
+(FQDN) URLs.
 
-This allows you to omit hard-coding fully qualified domain name (FQDN) URLs
-in commands. For example,
+This allows you to omit hard-coding fully qualified domain name (FQDN) URLs in
+commands. For example,
 
 ```javascript
- cy.visit('http://localhost:8080/index.html')
+cy.visit('http://localhost:8080/index.html')
 ```
 
 can be shortened to
 
 ```javascript
- cy.visit('index.html')
+cy.visit('index.html')
 ```
 
-Not only does this create tests that can easily switch between domains, i.e. running a dev server on
-`http:localhost:8080` vs a deployed production server domain, but adding a `baseUrl` can also save some time
-during the initial startup of your Cypress tests.
-
+Not only does this create tests that can easily switch between domains, i.e.
+running a dev server on `http://localhost:8080` vs a deployed production server
+domain, but adding a `baseUrl` can also save some time during the initial
+startup of your Cypress tests.
 
 When you start running your tests, Cypress does not know the url of the app you
 plan to test. So, Cypress initially opens on `https://localhost` + a random
@@ -974,4 +976,5 @@ We also display an error if your server is not running at the specified
 
 ### Usage of `baseUrl` in depth
 
-This [short video](https://www.youtube.com/watch?v=f5UaXuAc52c) explains in depth how to use `baseUrl` correctly.
+This [short video](https://www.youtube.com/watch?v=f5UaXuAc52c) explains in
+depth how to use `baseUrl` correctly.
