Add docs for new local/session storage commands #4876

chrisbreiding · 2022-11-29T15:38:08Z

vercel · 2022-11-29T15:40:05Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
cypress-documentation	✅ Ready (Inspect)	Visit Preview	Nov 29, 2022 at 6:45PM (UTC)

emilyrohrbough · 2022-11-29T16:24:17Z

content/api/commands/clearalllocalstorage.md

+## Examples
+
+### Clear all localStorage
+
+```javascript
+cy.clearAllLocalStorage()
+```


I'm not sure this section adds value since it's the same as the usage example.

Addressed in 837c4ad

emilyrohrbough · 2022-11-29T16:28:00Z

content/api/commands/clearalllocalstorage.md

+title: clearAllLocalStorage
+---
+
+Clear localStorage data for all origins with which the test has interacted.


Suggested change

Clear localStorage data for all origins with which the test has interacted.

Clear [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) data for all origins with which the test has interacted.

Addressed in 837c4ad

emilyrohrbough · 2022-11-29T16:31:20Z

content/api/commands/clearalllocalstorage.md

+
+<Alert type="warning">
+
+Cypress automatically runs this command _before_ each test to prevent state from


Suggested change

Cypress automatically runs this command _before_ each test to prevent state from

Cypress automatically runs this command _before_ each test, when [test isolation](/guides/core-concepts/writing-and-organizing-tests#Test-Isolation) is `on`, to prevent state from

Addressed in 837c4ad

emilyrohrbough · 2022-11-29T16:31:35Z

content/api/commands/clearalllocalstorage.md

+
+Cypress automatically runs this command _before_ each test to prevent state from
+being shared across tests. You shouldn't need to use this command unless you're
+using it to clear localStorage inside a single test.


Suggested change

using it to clear localStorage inside a single test.

using it to clear localStorage inside a single test or test isolation is `off`.

Addressed in 837c4ad

emilyrohrbough · 2022-11-29T16:32:47Z

content/api/commands/getalllocalstorage.md

+title: getAllLocalStorage
+---
+
+Get data in localStorage for all origins with which the test has interacted.


Suggested change

Get data in localStorage for all origins with which the test has interacted.

Get data in [`localStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) for all origins with which the test has interacted.

Addressed in 837c4ad

emilyrohrbough · 2022-11-29T16:32:50Z

content/api/commands/getalllocalstorage.md

+### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management)
+
+`cy.getAllLocalStorage()` yields an object where the keys are origins and the
+values are key-value pairs of localStorage data.


Suggested change

values are key-value pairs of localStorage data.

values are key-value pairs of `localStorage` data.

Addressed in 837c4ad

chrisbreiding · 2022-11-29T17:59:13Z

I force-pushed to rebase this against the v12 branch, but none of the content changed.

* Remove pages and references to functionality obsoleted by multidomain GA * fix: Explain error thrown when cypress commands in .should() callback (#4755) * fix: Explain error thrown when cypress commands in .should() callback * Improve layout of previous changes and provide second example of how to fix * Update content/api/commands/should.md Co-authored-by: Rachel <[email protected]> * Apply suggestions from code review Co-authored-by: Zach Bloomquist <[email protected]> * Run prettier * Run prettier again...? * One more prettier run... :/ Co-authored-by: Rachel <[email protected]> Co-authored-by: Zach Bloomquist <[email protected]> * docs: removing Cookies.defaults/preserveOnce (#4779) * docs: remove experimentalSessionAndOrigin (#4807) * Update cookie commands domain option description (#4861) * docs: Queries, Detached DOM, and Retry-Ability (#4835) * First rework of retryability guide * Update each command's Yields section, and all guides, with information about queries vs commands * Add Custom Queries page * Minor formatting tweaks * Review changes * Review updates * Update based on review + last week meetings * More review updates * Fix tests * breaking: drop node 12, 13, 15 and 17 support (#4879) * Add docs for new local/session storage commands (#4876) * feat: update okta login guide for realworld app (#4883) * feat: update okta login guide for realworld app * chore: make changes to okta to have parity with cognito changes * chore: address code review comments * feat: update cognito login guide for realworld app (#4882) * feat: update cognito login guide for realworld app * chore: update guide from comments in code review * properly close alert tag * Update content/guides/end-to-end-testing/amazon-cognito-authentication.md * chore: address comments from code review * fix linting * v12 Migration Guide (#4862) Co-authored-by: Matt Schile <[email protected]> Co-authored-by: Blue F <[email protected]> Co-authored-by: DEBRIS APRON <[email protected]> Co-authored-by: Ben M <[email protected]> Closes undefined * Small update to cy.origin API docs for v12 * Update auth examples for v12 on custom commands page * 12: update test isolation docs to use true/false instead of on/off (#4890) Co-authored-by: Chris Breiding <[email protected]> Co-authored-by: Matt Henkes <[email protected]> Co-authored-by: Bill Glesias <[email protected]> * docs: add documentation for experimentalOriginDependencies (#4897) * Documentation updates for v12 (#4880) * re-add websecurity, links to websecurity, and trade-offs guides * chore: revamp documentation around web security page * chore: update same-origin tradeoff to be new navigation rules, including our SD chart, to help paint users a clear picture with cy.origin * chore: link to the experimental modify obstructive third party code doc in web security from origin * chore: update Error Messages section to reflect allowing cross origin visiting * update best practices: visiting external sites * remove node 12 from installing cypress section * chore: update key differences to plug session and origin over programmatic login * chore: update with suggestions from code review * add okta/amazon guide links in trade-offs and update workarounds * feat: add cross origin testing guide * update image for command time out with visit * chore: readd legacy errors and add a Note section to explain that this is only for cypress v11 and under * chore: update suggestions from code review * chore: add suggestions from code review * fix: fix okta alert banner (needed a new line) * fix: broken image in error messages * chore: update error header for on link to address cypress-io/cypress-services#5040 (comment) * Update cy.session API docs for v12 (#4851) Co-authored-by: Emily Rohrbough <[email protected]> Closes #4507 * Remove pages and references to functionality obsoleted by multidomain GA * fix: Explain error thrown when cypress commands in .should() callback (#4755) * fix: Explain error thrown when cypress commands in .should() callback * Improve layout of previous changes and provide second example of how to fix * Update content/api/commands/should.md Co-authored-by: Rachel <[email protected]> * Apply suggestions from code review Co-authored-by: Zach Bloomquist <[email protected]> * Run prettier * Run prettier again...? * One more prettier run... :/ Co-authored-by: Rachel <[email protected]> Co-authored-by: Zach Bloomquist <[email protected]> * docs: removing Cookies.defaults/preserveOnce (#4779) * docs: remove experimentalSessionAndOrigin (#4807) * Update cookie commands domain option description (#4861) * docs: Queries, Detached DOM, and Retry-Ability (#4835) * First rework of retryability guide * Update each command's Yields section, and all guides, with information about queries vs commands * Add Custom Queries page * Minor formatting tweaks * Review changes * Review updates * Update based on review + last week meetings * More review updates * Fix tests * breaking: drop node 12, 13, 15 and 17 support (#4879) * Add docs for new local/session storage commands (#4876) * feat: update okta login guide for realworld app (#4883) * feat: update okta login guide for realworld app * chore: make changes to okta to have parity with cognito changes * chore: address code review comments * feat: update cognito login guide for realworld app (#4882) * feat: update cognito login guide for realworld app * chore: update guide from comments in code review * properly close alert tag * Update content/guides/end-to-end-testing/amazon-cognito-authentication.md * chore: address comments from code review * fix linting * v12 Migration Guide (#4862) Co-authored-by: Matt Schile <[email protected]> Co-authored-by: Blue F <[email protected]> Co-authored-by: DEBRIS APRON <[email protected]> Co-authored-by: Ben M <[email protected]> Closes undefined * 12: update test isolation docs to use true/false instead of on/off (#4890) Co-authored-by: Chris Breiding <[email protected]> Co-authored-by: Matt Henkes <[email protected]> Co-authored-by: Bill Glesias <[email protected]> * docs: add documentation for experimentalOriginDependencies (#4897) * Documentation updates for v12 (#4880) * re-add websecurity, links to websecurity, and trade-offs guides * chore: revamp documentation around web security page * chore: update same-origin tradeoff to be new navigation rules, including our SD chart, to help paint users a clear picture with cy.origin * chore: link to the experimental modify obstructive third party code doc in web security from origin * chore: update Error Messages section to reflect allowing cross origin visiting * update best practices: visiting external sites * remove node 12 from installing cypress section * chore: update key differences to plug session and origin over programmatic login * chore: update with suggestions from code review * add okta/amazon guide links in trade-offs and update workarounds * feat: add cross origin testing guide * update image for command time out with visit * chore: readd legacy errors and add a Note section to explain that this is only for cypress v11 and under * chore: update suggestions from code review * chore: add suggestions from code review * fix: fix okta alert banner (needed a new line) * fix: broken image in error messages * chore: update error header for on link to address cypress-io/cypress-services#5040 (comment) * Update auth examples for v12 on custom commands page * Small update to cy.origin API docs for v12 * Update cy.session API docs for v12 (#4851) Co-authored-by: Emily Rohrbough <[email protected]> Closes #4507 * chore: address docs feedback post merge (#4899) * .within() now throws an error if given more than one subject (#4898) * .within() now throws error when passed more than one subject. * Add migration guide, update based on reviews * Update Logging In section of Testing Your App page (#4885) Co-authored-by: Emily Rohrbough <[email protected]> Closes #4498 * Update End-to-End Testing -> Auth0 Authentication docs for v12 (#4895) Co-authored-by: Bill Glesias <[email protected]> * Cypress.Session Cypress API (#4900) * docs around Cypress.session api * data not date * Update content/api/cypress-api/session.md Co-authored-by: Matt Henkes <[email protected]> * Update content/api/cypress-api/session.md Co-authored-by: Matt Henkes <[email protected]> * Update content/api/cypress-api/session.md Co-authored-by: Matt Henkes <[email protected]> * Update content/api/cypress-api/session.md Co-authored-by: Matt Henkes <[email protected]> * fix markdown * Update content/api/cypress-api/session.md * Apply suggestions from code review Co-authored-by: Matt Henkes <[email protected]> * V12 ChangeLog (#4896) Co-authored-by: Matt Schile <[email protected]> Co-authored-by: Blue F <[email protected]> Co-authored-by: DEBRIS APRON <[email protected]> Co-authored-by: Ben M <[email protected]> Co-authored-by: Ryan Manuel <[email protected]> Co-authored-by: Chris Breiding <[email protected]> Co-authored-by: DEBRIS APRON <[email protected]> Co-authored-by: Blue F <[email protected]> Co-authored-by: Rachel <[email protected]> Co-authored-by: Zach Bloomquist <[email protected]> Co-authored-by: Matt Schile <[email protected]> Co-authored-by: Matt Henkes <[email protected]> Co-authored-by: Chris Breiding <[email protected]> Co-authored-by: Bill Glesias <[email protected]> Co-authored-by: Ben M <[email protected]> Co-authored-by: Ryan Manuel <[email protected]>

chrisbreiding mentioned this pull request Nov 29, 2022

feat: Add new local and session storage commands cypress-io/cypress#24859

Merged

5 tasks

vercel bot deployed to Preview November 29, 2022 15:40 View deployment

emilyrohrbough reviewed Nov 29, 2022

View reviewed changes

vercel bot deployed to Preview November 29, 2022 16:56 View deployment

chrisbreiding requested a review from emilyrohrbough November 29, 2022 16:59

vercel bot deployed to Preview November 29, 2022 17:00 View deployment

chrisbreiding changed the base branch from master to v12 November 29, 2022 17:54

chrisbreiding added 3 commits November 29, 2022 12:57

add docs for new local/session storage commands

485fc33

apply feedback suggestions

837c4ad

remove cannot be chained further lines

03ccc1b

chrisbreiding force-pushed the new-storage-commands branch from ba4d5bf to 03ccc1b Compare November 29, 2022 17:58

vercel bot deployed to Preview November 29, 2022 18:00 View deployment

fix sidebar

76d952a

vercel bot deployed to Preview November 29, 2022 18:45 View deployment

emilyrohrbough approved these changes Nov 30, 2022

View reviewed changes

chrisbreiding merged commit ab17765 into v12 Dec 2, 2022

chrisbreiding deleted the new-storage-commands branch December 2, 2022 14:48

debrisapron pushed a commit that referenced this pull request Dec 6, 2022

Add docs for new local/session storage commands (#4876)

94d1f2c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add docs for new local/session storage commands #4876

Add docs for new local/session storage commands #4876

Uh oh!

chrisbreiding commented Nov 29, 2022

Uh oh!

vercel bot commented Nov 29, 2022 •

edited

Loading

Uh oh!

emilyrohrbough Nov 29, 2022

Uh oh!

chrisbreiding Nov 29, 2022 •

edited

Loading

Uh oh!

emilyrohrbough Nov 29, 2022

Uh oh!

chrisbreiding Nov 29, 2022 •

edited

Loading

Uh oh!

emilyrohrbough Nov 29, 2022

Uh oh!

chrisbreiding Nov 29, 2022 •

edited

Loading

Uh oh!

emilyrohrbough Nov 29, 2022

Uh oh!

chrisbreiding Nov 29, 2022 •

edited

Loading

Uh oh!

emilyrohrbough Nov 29, 2022

Uh oh!

chrisbreiding Nov 29, 2022 •

edited

Loading

Uh oh!

emilyrohrbough Nov 29, 2022

Uh oh!

chrisbreiding Nov 29, 2022 •

edited

Loading

Uh oh!

chrisbreiding commented Nov 29, 2022

Uh oh!

Uh oh!

	Clear localStorage data for all origins with which the test has interacted.
	Clear [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) data for all origins with which the test has interacted.


		<Alert type="warning">

		Cypress automatically runs this command _before_ each test to prevent state from

	using it to clear localStorage inside a single test.
	using it to clear localStorage inside a single test or test isolation is `off`.

	Get data in localStorage for all origins with which the test has interacted.
	Get data in [`localStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) for all origins with which the test has interacted.

	values are key-value pairs of localStorage data.
	values are key-value pairs of `localStorage` data.

Add docs for new local/session storage commands #4876

Add docs for new local/session storage commands #4876

Uh oh!

Conversation

chrisbreiding commented Nov 29, 2022

Uh oh!

vercel bot commented Nov 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

emilyrohrbough Nov 29, 2022

Choose a reason for hiding this comment

Uh oh!

chrisbreiding Nov 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

emilyrohrbough Nov 29, 2022

Choose a reason for hiding this comment

Uh oh!

chrisbreiding Nov 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

emilyrohrbough Nov 29, 2022

Choose a reason for hiding this comment

Uh oh!

chrisbreiding Nov 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

emilyrohrbough Nov 29, 2022

Choose a reason for hiding this comment

Uh oh!

chrisbreiding Nov 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

emilyrohrbough Nov 29, 2022

Choose a reason for hiding this comment

Uh oh!

chrisbreiding Nov 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

emilyrohrbough Nov 29, 2022

Choose a reason for hiding this comment

Uh oh!

chrisbreiding Nov 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chrisbreiding commented Nov 29, 2022

Uh oh!

Uh oh!

vercel bot commented Nov 29, 2022 •

edited

Loading

chrisbreiding Nov 29, 2022 •

edited

Loading

chrisbreiding Nov 29, 2022 •

edited

Loading

chrisbreiding Nov 29, 2022 •

edited

Loading

chrisbreiding Nov 29, 2022 •

edited

Loading

chrisbreiding Nov 29, 2022 •

edited

Loading

chrisbreiding Nov 29, 2022 •

edited

Loading