chore(sessions): break out sessions manager code and add unit tests #21268

emilyrohrbough · 2022-04-29T13:33:17Z

Apart of #20977

This refactor is prepping for updating changes with cy.session to use the new command group API and adding test coverage for GA support.

This PR breaks out the cy.session session manager functions into its own file and adds some missing unit tests -- there are a few that are still need to be added that I will update at a later time.

User facing changelog

n/a

PR Tasks

Have tests been added/updated?
[n/a] Has the original issue (or this PR, if no issue exists) been tagged with a release in ZenHub? (user-facing changes only)
[n/a] Has a PR for user-facing changes been opened in cypress-documentation?
[n/a] Have API changes been updated in the type definitions?
[n/a] Have new configuration options been added to the cypress.schema.json?

cypress-bot · 2022-04-29T13:33:19Z

Thanks for taking the time to open a PR!

Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.
Become familiar with the Code Review Checklist for guidelines on coding standards and what needs to be done before a PR can be merged.

# Conflicts: # packages/driver/src/cy/commands/sessions/index.ts

cypress · 2022-04-29T13:58:21Z

Test summary

577 • 0 • 0 • 0 • 1

Run details


Project	cypress
Status	Passed
Commit	`5712dc7`
Started	May 3, 2022 6:25 PM
Ended	May 3, 2022 6:35 PM
Duration	09:07 💡
OS	Linux Debian - 10.10
Browser	Electron 94

View run in Cypress Dashboard ➡️

Flakiness

	cypress/integration/settings_spec.js		1
1	Settings > file preference panel > loads preferred editor, available editors and shows spinner

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

mschile · 2022-04-29T16:06:36Z

packages/driver/src/cy/commands/sessions/manager.ts

@@ -0,0 +1,295 @@
+import _ from 'lodash'


Did you change any logic in this file?

Made comments on the changes.

packages/driver/cypress/integration/commands/sessions/manager_spec.ts

chrisbreiding · 2022-04-29T18:39:41Z

packages/driver/cypress/integration/commands/sessions/manager_spec.ts

+
+  describe('._setStorageOnOrigins()', () => {})
+
+  it('.getAllHtmlOrigins()', async () => {


Should this be a describe with an it that describes the method's behavior?

I don't think it matters. I can change it if you feel strongly.

Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com>

emilyrohrbough · 2022-05-02T13:34:01Z

packages/driver/src/cy/commands/sessions/manager.ts

+    const getOrigins = this.Cypress.Promise.map(
+      ([] as string[]).concat(origins), async (v) => {
+        if (v === '*') {
+          return await this.getAllHtmlOrigins()


Updated to use existing function that handled this logic

- return _.keys(await Cypress.backend('get:rendered:html:origins')).concat([currentOrigin]) + return await this.getAllHtmlOrigins()

emilyrohrbough · 2022-05-02T13:37:13Z

packages/driver/src/cy/commands/sessions/manager.ts

+      }
+
+      if (_.isEmpty(origins)) {
+        return results


Updates

- return getResults() + return results

emilyrohrbough · 2022-05-02T13:37:19Z

packages/driver/src/cy/commands/sessions/manager.ts

+        pushValue(val[0], val[1])
+      })
+
+      return results


Updates

- return getResults() + return results

emilyrohrbough · 2022-05-02T13:38:08Z

packages/driver/src/cy/commands/sessions/manager.ts

+      const currentOrigin = $Location.create(window.location.href).origin
+
+      const origins: Array<string> = await this.mapOrigins(opts.origin)
+


Removed

- const getResults = () => { - return results - }

mjhenkes · 2022-05-02T17:08:56Z

packages/driver/cypress/integration/commands/sessions/manager_spec.ts

+    })
+  })
+
+  describe('._setStorageOnOrigins()', () => {})


I assume you meant for this describe to wrap the test below?

no, I missed adding a // TO DO comment.

packages/driver/cypress/integration/commands/sessions/manager_spec.ts

…spec.ts

packages/driver/cypress/integration/commands/sessions/manager_spec.ts

AtofStryker · 2022-05-03T16:57:58Z

packages/driver/src/cy/commands/sessions/manager.ts

+    const getOrigins = this.Cypress.Promise.map(
+      ([] as string[]).concat(origins), async (v) => {
+        if (v === '*') {
+          return await this.getAllHtmlOrigins()


packages/driver/cypress/integration/commands/sessions/manager_spec.ts

Co-authored-by: Bill Glesias <bglesias@gmail.com>

* 10.0-release: (22 commits) fix: migrate multiples projects when in global mode (#21458) test: fix flaky cy-in-cy selector validity test (#21360) chore: remove unused codeGenGlobs (#21438) fix: use correct path for scaffolding spec on CT (#21411) fix: remove breaking options from testing type on migration (#21437) fix: test-recording instructions in Component Test mode (#21422) feat: distinguish app vs launchpad utm_source when using utm params (#21424) chore: update stubbed cloud types (#21451) chore: change to yarn registry fix(sessions): refactor flows, fix grouping bugs and align validation fail text (#21379) chore(sessions): more driver tests (#21378) chore: rename domain_fn to origin_fn (#21413) chore: release 9.6.1 (#21404) fix: ensure that proxy logs are updated after the xhr has actually completed (#21373) chore: Re-organize tests in assertions_spec.js (#21283) chore: Distribute tests to desktop-gui containers. Make `desktop-gui` tests faster! (#21305) chore(sessions): add additional tests (#21338) fix: Allow submit button to be outside of the form for implicit submission (#21279) fix(launcher): support Firefox as a snap (#21328) chore(sessions): break out sessions manager code and add unit tests (#21268) ...

emilyrohrbough added 10 commits April 25, 2022 17:23

chore(sessions): break out sessions manager code

203b2d6

manager manages registered sessions

e9a1a88

some unit tests

7321cfb

add more tests and some slight clean up

4002732

.

248b362

fix run mode issue.

690e889

bind correctly for spies

2f6062c

remove types. not sure on the return values.

d5e9137

Merge branch 'develop' into sessions-refactor-pt2

4a72be7

fix tests

845f80b

emilyrohrbough requested a review from a team as a code owner April 29, 2022 13:33

emilyrohrbough requested review from jennifer-shehane, AtofStryker, chrisbreiding, mjhenkes and mschile and removed request for a team and jennifer-shehane April 29, 2022 13:33

Merge branch 'develop' into sessions-refactor-pt2

9e0ac1f

# Conflicts: # packages/driver/src/cy/commands/sessions/index.ts

Merge branch 'develop' into sessions-refactor-pt2

e21ebf1

mschile reviewed Apr 29, 2022

View reviewed changes

chrisbreiding reviewed Apr 29, 2022

View reviewed changes

packages/driver/cypress/integration/commands/sessions/manager_spec.ts Outdated Show resolved Hide resolved

chrisbreiding reviewed Apr 29, 2022

View reviewed changes

packages/driver/cypress/integration/commands/sessions/manager_spec.ts Outdated Show resolved Hide resolved

chrisbreiding reviewed Apr 29, 2022

View reviewed changes

packages/driver/cypress/integration/commands/sessions/manager_spec.ts Outdated Show resolved Hide resolved

chrisbreiding reviewed Apr 29, 2022

View reviewed changes

Apply suggestions from code review

82d05f7

Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com>

emilyrohrbough commented May 2, 2022

View reviewed changes

emilyrohrbough requested review from mschile and chrisbreiding May 2, 2022 13:45

chrisbreiding approved these changes May 2, 2022

View reviewed changes

mjhenkes reviewed May 2, 2022

View reviewed changes

emilyrohrbough commented May 2, 2022

View reviewed changes

packages/driver/cypress/integration/commands/sessions/manager_spec.ts Show resolved Hide resolved

emilyrohrbough added 2 commits May 3, 2022 10:34

Update packages/driver/cypress/integration/commands/sessions/manager_…

1874658

…spec.ts

Merge branch 'develop' into sessions-refactor-pt2

fcce1d0

mjhenkes assigned emilyrohrbough May 3, 2022

mjhenkes approved these changes May 3, 2022

View reviewed changes

AtofStryker approved these changes May 3, 2022

View reviewed changes

emilyrohrbough commented May 3, 2022

View reviewed changes

packages/driver/cypress/integration/commands/sessions/manager_spec.ts Outdated Show resolved Hide resolved

emilyrohrbough commented May 3, 2022

View reviewed changes

packages/driver/cypress/integration/commands/sessions/manager_spec.ts Outdated Show resolved Hide resolved

emilyrohrbough commented May 3, 2022

View reviewed changes

packages/driver/cypress/integration/commands/sessions/manager_spec.ts Outdated Show resolved Hide resolved

emilyrohrbough commented May 3, 2022

View reviewed changes

packages/driver/cypress/integration/commands/sessions/manager_spec.ts Outdated Show resolved Hide resolved

add colon to todo comments per Bills suggestion

5712dc7

Co-authored-by: Bill Glesias <bglesias@gmail.com>

emilyrohrbough merged commit cb14ae6 into develop May 3, 2022

emilyrohrbough deleted the sessions-refactor-pt2 branch May 3, 2022 19:01

emilyrohrbough added this to the experimentalSessionAndOrigin GA milestone May 13, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(sessions): break out sessions manager code and add unit tests #21268

chore(sessions): break out sessions manager code and add unit tests #21268

emilyrohrbough commented Apr 29, 2022

cypress-bot bot commented Apr 29, 2022

cypress bot commented Apr 29, 2022 •

edited

Loading

mschile Apr 29, 2022

emilyrohrbough May 2, 2022

chrisbreiding Apr 29, 2022

emilyrohrbough May 2, 2022

emilyrohrbough May 2, 2022

AtofStryker May 3, 2022

emilyrohrbough May 2, 2022 •

edited

Loading

emilyrohrbough May 2, 2022 •

edited

Loading

emilyrohrbough May 2, 2022

mjhenkes May 2, 2022

emilyrohrbough May 2, 2022

AtofStryker May 3, 2022


		describe('._setStorageOnOrigins()', () => {})

		it('.getAllHtmlOrigins()', async () => {

		const currentOrigin = $Location.create(window.location.href).origin

		const origins: Array<string> = await this.mapOrigins(opts.origin)

chore(sessions): break out sessions manager code and add unit tests #21268

chore(sessions): break out sessions manager code and add unit tests #21268

Conversation

emilyrohrbough commented Apr 29, 2022

User facing changelog

PR Tasks

cypress-bot bot commented Apr 29, 2022

cypress bot commented Apr 29, 2022 • edited Loading

Test summary

Run details

Flakiness

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emilyrohrbough May 2, 2022 • edited Loading

Choose a reason for hiding this comment

emilyrohrbough May 2, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cypress bot commented Apr 29, 2022 •

edited

Loading

emilyrohrbough May 2, 2022 •

edited

Loading

emilyrohrbough May 2, 2022 •

edited

Loading