chore: add internal log group API and update log group styles #20857

emilyrohrbough · 2022-03-30T23:15:01Z

Closes Add internal log group API #20433

User facing changelog

n/a - this is an internal API that will be used in the coming experimental multi-domain command.

Details

Added log group api to be consumed internally by Cypress commands.
Update Reporter's Command UI
- Group to be open by default for parent or child commands This will remain closed for Sessions commands.
  - When closed, will display number of logs within the group
- Group cannot be pinned or render snapshots. This will be updated and allowed in 10.0+
  - The pin icon will not show on a command group.
  - A snapshot will not display when a group is hovered.

Screen.Recording.2022-04-01.at.12.17.56.PM.mov

PR Tasks

Have tests been added/updated?
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-03-30T23:15:04Z

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.

cypress · 2022-03-31T13:19:44Z

Test summary

19363 • 0 • 218 • 0 • 3

Run details


Project	cypress
Status	Passed
Commit	`6c56096`
Started	Apr 5, 2022 9:18 PM
Ended	Apr 5, 2022 9:30 PM
Duration	11:53 💡
OS	Linux Debian - 10.10
Browser	Multiple

View run in Cypress Dashboard ➡️

Flakiness

	settings_spec.js	1
1	Settings > file preference panel > loads preferred editor, available editors and shows spinner
	commands/net_stubbing_spec.ts	1
1	network stubbing > waiting and aliasing > should handle aborted requests
	commands/navigation_spec.js	1
1	src/cy/commands/navigation > #visit > window immediately resolves and doesn't reload when visiting the same URL with hashes

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

…ress into new-cmd-group-9.x

packages/driver/src/cy/logGroup.ts

chrisbreiding · 2022-04-05T13:43:40Z

packages/driver/src/cypress/log.ts

@@ -202,18 +202,18 @@ const defaults = function (state, config, obj) {
    },
  })

-  const logGroup = _.last(state('logGroup'))
+  const logGroups = state('logGroup') || []


Suggested change

const logGroups = state('logGroup') || []

const logGroupIds = state('logGroupIds') || []

I think this might make it a little clearer what the state holds. I won't add comments for each one, but of course, this also means updating other references as well.

7b982c4 (#20857)

packages/runner-shared/src/event-manager.js

chrisbreiding · 2022-04-05T13:57:00Z

packages/reporter/src/commands/command-model.ts

+  @computed get isInvisible () {
+    return this.visible !== undefined && !this.visible
+  }


I find it confusing and a little redundant for the command model to have both visible and isInvisible properties. Could we add logic in constructor and update to ensure model.invisible is a boolean, based on whatever default makes sense, then use that instead of adding an extra property?

👍🏻 Sure I can slip the logic to in the constructor to handle this.

a84a054 (#20857)

mjhenkes · 2022-04-05T16:24:52Z

packages/reporter/src/commands/command-model.ts

@@ -9,7 +9,7 @@ const LONG_RUNNING_THRESHOLD = 1000

 interface RenderProps {
  message?: string
-  indicator?: string
+  indicator?: 'successful' | 'pending' | 'aborted' | 'bad'


What does the status 'bad' mean?

This is set in three places and meant to represent the response status code however it's been pulled into sessions to indicate if a session failed (we intend to update this later on)

xhr - a status code that does not start with 2

requests proxy-logging - a non-200 status code

sessions - failed on session validation

packages/reporter/src/commands/command-model.ts

mjhenkes · 2022-04-05T16:36:02Z

packages/reporter/src/commands/command-model.ts

  @computed get numChildren () {
-    // and one to include self so it's the total number of same events
-    return this.children.length + 1
+    if (this.event) {


add a comment about why if this.event exists we return? it's not evident in the name.

does the comment below explain this?

does this help? 7b0746a (#20857)

Yes thanks!

chrisbreiding · 2022-04-05T18:23:05Z

packages/reporter/src/commands/command-model.ts

-    this.visible = props.visible
+    // command log that are not associated with elements will not have a visibility
+    // attribute set. i.e. cy.visit(), cy.readFile() or cy.log()
+    this.isInvisible = props.visible !== undefined && !props.visible


While this gets rid of the redundancy, how about sticking with model.visible since it mirrors the props? So here and in update, it could be this.visible = props.visible === true || props.visible === undefined instead.

I originally changed it to reflect the boolean value and to reflect it's usage in the UI, but I change it back: 6f5a7d9 (#20857)

commit 17e6bf4 Author: Matt Henkes <mjhenkes@gmail.com> Date: Wed Apr 6 11:26:03 2022 -0500 chore: [Multi-domain] Rename switchToDomain to origin (#20927) * chore: [Multi-domain] Rename switchToDomain to origin * Regenerate system tests snapshots * Update cli/schema/cypress.schema.json Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com> * Update cli/types/cypress.d.ts Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com> commit 0772f85 Merge: 81e9283 d0fc93b Author: mjhenkes <mjhenkes@gmail.com> Date: Wed Apr 6 09:51:49 2022 -0500 Merge branch 'develop' into feature-multidomain commit d0fc93b Author: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Date: Tue Apr 5 17:18:39 2022 -0500 chore: add internal log group API and update log group styles (#20857) Co-authored-by: Matt Henkes <mjhenkes@gmail.com> commit ee7495f Author: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Date: Tue Apr 5 15:45:12 2022 -0500 fix: fix flaky report test (#20886) commit 81e9283 Merge: f45be5e edf9c11 Author: Matt Henkes <mjhenkes@gmail.com> Date: Tue Apr 5 11:40:02 2022 -0500 Merge branch 'develop' into feature-multidomain commit f45be5e Author: Matt Henkes <mjhenkes@gmail.com> Date: Tue Apr 5 11:39:53 2022 -0500 chore: [Multi-domain] Resolve flaky test (#20917) * chore: [Multi-domain] Resolve flaky test * remove ts ignore * update comment * remove dead code * Updated comment commit edf9c11 Author: Chris Breiding <chrisbreiding@users.noreply.github.com> Date: Tue Apr 5 12:07:56 2022 -0400 fix: Resend *.enable commands on CDP reconnect (#20916) Co-authored-by: Zach Bloomquist <git@chary.us> Co-authored-by: Matt Henkes <mjhenkes@gmail.com> commit 0cce18a Author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue Apr 5 10:04:55 2022 -0500 chore: Update Chrome (stable) to 100.0.4896.75 (#20909) Co-authored-by: cypress-bot[bot] <2f0651858c6e38e0+cypress-bot[bot]@users.noreply.github.com> commit e0ebd08 Merge: 2e48f85 94fa50d Author: Blue F <blue@cypress.io> Date: Mon Apr 4 14:39:23 2022 -0700 Merge pull request #20839 from sainthkh/issue-20562 fix: `cy.type()` + `{enter}` or ` ` should work with Firefox 98+ commit 2e48f85 Author: David Munechika <david.munechika@gatech.edu> Date: Mon Apr 4 11:47:02 2022 -0400 fix: --spec with glob incorrectly splits filename (#20848) Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> commit c0d638c Author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon Apr 4 06:33:59 2022 +1000 chore: Update Chrome (beta) to 101.0.4951.15 (#20882) Co-authored-by: cypress-bot[bot] <2f0651858c6e38e0+cypress-bot[bot]@users.noreply.github.com> commit 0df0d7a Author: Jon Koops <jonkoops@gmail.com> Date: Fri Apr 1 03:08:22 2022 +0200 fix(types): add correct type for preserve cookie callback (#20513) Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com> commit 94fa50d Author: KHeo <sainthkh@naver.com> Date: Thu Mar 31 15:03:48 2022 +0900 feedback commit c66a23e Author: KHeo <sainthkh@naver.com> Date: Wed Mar 30 16:18:26 2022 +0900 fix: `cy.type()` should work with Firefox 98+

feat: implement log group API and update log group styles

6ef4b25

emilyrohrbough and others added 3 commits March 30, 2022 19:02

rd 2 of pulling changes forward

db96829

diffpr

b73c932

Merge branch 'develop' into new-cmd-group-9.x

b6db5ec

emilyrohrbough and others added 12 commits March 31, 2022 08:54

fix types; fix flakey test; update cmd log bkg color

88d32c3

Merge branch 'new-cmd-group-9.x' of https://github.com/cypress-io/cyp…

bce9908

…ress into new-cmd-group-9.x

fix types

ae620b4

final tweaks and fix tests

31f48a8

fix types

6fecb14

whoops! pull fwd the end-group on err logic

638e8a4

account for cmds that might yeild a diff subject

129bb6a

fix flaky test

7855305

fix pinning icon

2fb976e

Merge branch 'develop' into new-cmd-group-9.x

e50b10d

remove snapshot message when group

90616a6

Merge branch 'new-cmd-group-9.x' of https://github.com/cypress-io/cyp…

e966ef6

…ress into new-cmd-group-9.x

emilyrohrbough changed the title ~~feat: add internal log group API and update log group styles~~ chore: add internal log group API and update log group styles Apr 1, 2022

update tooltip message to account for pluralization

8286f61

mjhenkes assigned mjhenkes and emilyrohrbough and unassigned mjhenkes Apr 1, 2022

mjhenkes requested review from AtofStryker and mjhenkes April 1, 2022 19:44

emilyrohrbough marked this pull request as ready for review April 1, 2022 19:45

emilyrohrbough requested a review from a team as a code owner April 1, 2022 19:45

mjhenkes requested review from chrisbreiding and mschile and removed request for a team April 1, 2022 19:45

emilyrohrbough and others added 2 commits April 1, 2022 15:04

nit

2a14670

Merge branch 'develop' into new-cmd-group-9.x

26d1eea

chrisbreiding requested changes Apr 5, 2022

View reviewed changes

emilyrohrbough added 2 commits April 5, 2022 11:09

change visible attr to isInvisible on command model

a84a054

remove changes that are in review on a diff pr

b87099c

mjhenkes reviewed Apr 5, 2022

View reviewed changes

pr feedback to change state key to logGroupIds from logGroup

7b982c4

mjhenkes reviewed Apr 5, 2022

View reviewed changes

packages/reporter/src/commands/command-model.ts Outdated Show resolved Hide resolved

mjhenkes reviewed Apr 5, 2022

View reviewed changes

pr feedback

7b0746a

mjhenkes previously approved these changes Apr 5, 2022

View reviewed changes

emilyrohrbough mentioned this pull request Apr 5, 2022

feat(Unification): add internal log group api and consume in .within() #20474

Closed

2 tasks

Merge branch 'develop' into new-cmd-group-9.x

250812b

emilyrohrbough requested a review from chrisbreiding April 5, 2022 17:12

chrisbreiding requested changes Apr 5, 2022

View reviewed changes

use attribute visible instead of isInvisible

6f5a7d9

emilyrohrbough dismissed mjhenkes’s stale review via 6f5a7d9 April 5, 2022 20:36

emilyrohrbough requested review from chrisbreiding and mjhenkes April 5, 2022 20:37

chrisbreiding approved these changes Apr 5, 2022

View reviewed changes

Merge branch 'develop' into new-cmd-group-9.x

6c56096

mjhenkes approved these changes Apr 5, 2022

View reviewed changes

emilyrohrbough changed the title ~~chore: add internal log group API and update log group styles~~ chore: add internal log group API and update log group styles Apr 5, 2022

emilyrohrbough merged commit d0fc93b into develop Apr 5, 2022

emilyrohrbough deleted the new-cmd-group-9.x branch April 5, 2022 22:18

cypress-bot bot mentioned this pull request Apr 5, 2022

Add internal log group API #20433

Closed

emilyrohrbough mentioned this pull request Apr 6, 2022

chore: merge dev into 10.0 release #20950

Merged

emilyrohrbough added the type: chore Work is required w/ no deliverable to end user label Apr 11, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: add internal log group API and update log group styles #20857

chore: add internal log group API and update log group styles #20857

emilyrohrbough commented Mar 30, 2022 •

edited

cypress-bot bot commented Mar 30, 2022

cypress bot commented Mar 31, 2022 •

edited

chrisbreiding Apr 5, 2022

emilyrohrbough Apr 5, 2022

chrisbreiding Apr 5, 2022

emilyrohrbough Apr 5, 2022

emilyrohrbough Apr 5, 2022

mjhenkes Apr 5, 2022

emilyrohrbough Apr 5, 2022

mjhenkes Apr 5, 2022

emilyrohrbough Apr 5, 2022

emilyrohrbough Apr 5, 2022

mjhenkes Apr 5, 2022

chrisbreiding Apr 5, 2022

emilyrohrbough Apr 5, 2022

	const logGroups = state('logGroup') \|\| []
	const logGroupIds = state('logGroupIds') \|\| []

chore: add internal log group API and update log group styles #20857

chore: add internal log group API and update log group styles #20857

Conversation

emilyrohrbough commented Mar 30, 2022 • edited

User facing changelog

Details

PR Tasks

cypress-bot bot commented Mar 30, 2022

cypress bot commented Mar 31, 2022 • edited

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

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

Choose a reason for hiding this comment

emilyrohrbough commented Mar 30, 2022 •

edited

cypress bot commented Mar 31, 2022 •

edited