chore: add batch execution to CloudDataSource #22457

tgriesser · 2022-06-22T17:24:10Z

Additional details

Addresses @flotwig comment on #21250 re: network queries, batching multiple GraphQL requests into a single remote request with rewritten variables, using @graphql-tools/batch-execute. This makes it simpler to batch on the remote server.

The documentation here explains how the merging works: https://www.graphql-tools.com/docs/batch-execution

Additionally only does this in situations where we have multiple requests to batch, so we don't end up with rewritten queries on every request, but just the ones where we have multiple requests. Limits the batching to max 20 items per-query

Steps to test

Checkout the branch
Observe fewer network requests

How has the user experience changed?

Before:

dashboard.-.22.June.2022.mp4

After:

dashboard.-.22.June.2022.1.mp4

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)
Has a PR for user-facing changes been opened in cypress-documentation?
Have API changes been updated in the type definitions?

cypress-bot · 2022-06-22T17:24:13Z

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-06-22T17:35:54Z

1 flaky tests on run #43438 ↗︎

0	78	0	0	1

Details:

Merge branch 'develop' into tgriesser/CLOUD-577-spec-list-display-latest-runs-batching
Project: cypress	Commit: `2d851aaed2`
Status: Passed	Duration: 15:31 💡
Started: Jan 25, 2023 6:45 PM	Ended: Jan 25, 2023 7:01 PM

cypress/e2e/next.cy.ts • 1 flaky test • webpack-dev-server

View Output Video

Test
Working with next-12 > should show compilation errors on src changes		`Screenshot`

_{This comment has been generated by cypress-bot as a result of this
project's GitHub integration settings.}

tbiethman

Everything seems to work well. There are tests failing here that don't seem flaky and don't seem to be failing in the feature branch, are you going to address those before merging down?

tgriesser · 2022-06-27T20:39:56Z

There are tests failing here that don't seem flaky and don't seem to be failing in the feature branch, are you going to address those before merging down?

Yeah I was missing the merge with the last commit

mike-plummer

🤯 Very cool! Works well on my local

mike-plummer · 2022-06-27T20:41:46Z

packages/frontend-shared/cypress/e2e/support/e2eSupport.ts

@@ -133,6 +143,10 @@ declare global {
       * Gives the ability to intercept the remote GraphQL request & respond accordingly
       */
      remoteGraphQLIntercept: typeof remoteGraphQLIntercept
+      /**
+       * Gives the ability to intercept the remote GraphQL request & respond accordingly


Nitpick - "intercept a batched remote Graph request"?

mike-plummer · 2022-06-27T20:46:49Z

packages/frontend-shared/cypress/e2e/e2ePluginSetup.ts

+              const re = /^_(\d+)_(.*?)$/.exec(key)
+
+              if (!re) {
+                finalVal[key] = val
+                continue
+              }
+
+              const [, capture1, capture2] = re
+              const subqueryVariables = _.transform(_.pickBy(variables, (val, key) => key.startsWith(`_${capture1}_`)), (acc, val, k) => {
+                acc[k.replace(`_${capture1}_`, '')] = val
+              }, {})


This section could use a few comments

mike-plummer · 2022-06-27T20:50:56Z

packages/frontend-shared/cypress/e2e/e2ePluginSetup.ts

+              values.push(Promise.resolve().then(() => {
+                return fn({
+                  key,
+                  index: Number(capture1),
+                  field: capture2,
+                  variables: subqueryVariables,
+                  result: result[key],
+                }, testState)
+              }))


Could this be simplified by just resolving the call to fn? Or is the then needed to not block processing in this loop?

values.push(Promise.resolve( fn({ key, index: Number(capture1), field: capture2, variables: subqueryVariables, result: result[key], }, testState), ))

The then is to make it so that if fn is sync an an error is thrown it's it's caught & rejected promise on the field level, rather than being thrown at the top level

Added explicit handling for the errors though so that it does what was intended here

mike-plummer · 2022-06-27T20:54:05Z

packages/frontend-shared/cypress/e2e/support/e2eSupport.ts

 export type RemoteGraphQLInterceptor = (obj: RemoteGraphQLInterceptPayload, testState: Record<string, any>) => ExecutionResult | Promise<ExecutionResult> | Response

+export type RemoteGraphQLBatchInterceptor = (obj: RemoteGraphQLBatchInterceptPayload, testState: Record<string, any>) => any | Promise<any>


Can we make the return type any more specific? Does the batch return an ExecutionResult similar to the non-batch signature above?

Yeah, let me make it a generic so we can add it to the signature if we want

…tch-execute

…est-runs-batching

mike-plummer

Thanks for the updates!

lmiller1990 · 2022-06-30T00:22:23Z

packages/frontend-shared/cypress/e2e/e2ePluginSetup.ts

+            const finalVal: Record<string, any> = {}
+            const errors: GraphQLError[] = []
+
+            // The batch execution plugin (https://www.graphql-tools.com/docs/batch-execution) batches the


Nice, this is neat.

lmiller1990

I did not pull it down but I grok the general idea. I haven't written an ACI code yet, hoping to do so soon to get my hands dirty in this area of the code base and really internalize it + the dev workflow.

…est-runs-batching

emilyrohrbough · 2022-12-27T19:41:36Z

@tgriesser Looks like there may be some legit test failures that need to be fixed so this can merge.

…est-runs-batching

…ing' of https://github.com/cypress-io/cypress into tgriesser/CLOUD-577-spec-list-display-latest-runs-batching

…est-runs-batching

estrada9166 · 2022-12-28T16:11:47Z

I moved it to draft - waiting some changes on the cloud side so this can be properly handle

…est-runs-batching

emilyrohrbough · 2023-01-24T15:56:18Z

@estrada9166 Can you link to the cloud side PR or issue we need to track to determine when this is ready?

estrada9166 · 2023-01-24T15:57:05Z

Cloud PR: https://github.com/cypress-io/cypress-services/pull/5045

…est-runs-batching

* develop: (27 commits) refactor: remove unused cloud routes (#25584) chore: fix issue template formatting issue (#25587) fix: fixed issue with CT + electron + run mode not exiting properly (#25585) chore(deps): update dependency ua-parser-js to v0.7.33 [security] (#25561) fix: add alternative binary names for edge-beta (#25456) chore: add batch execution to CloudDataSource (#22457) chore: End a/b campaigns for aci smart banners (#25504) chore: release @cypress/schematic-v2.5.0 fix(cypress-schematic): do not disable e2e support file (#25400) chore: adding memory issue template (#25559) feat: Add Angular CT Schematic (#24374) chore: enforce changelog entries on PR reviews (#25459) chore: bump package.json to 12.4.0 [run ci] (#25556) feat: Add 'type' option to `.as` to store aliases by value (#25251) chore: release @cypress/webpack-dev-server-v3.2.3 feat: Display line break in cy.log (#25467) chore: update types (#25538) fix: Revert "fix: adding emergency garbage collection for chromium-based browsers" (#25546) fix: percy - wait to take snapshot until previous tooltips are gone (#25522) feat: support data-qa selector in selector playground (#25475) ...

cypress-bot · 2023-01-27T15:39:46Z

Released in 12.4.1.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v12.4.1, please open a new issue.

tgriesser marked this pull request as ready for review June 24, 2022 20:30

tgriesser requested review from mike-plummer and flotwig June 24, 2022 20:30

tgriesser mentioned this pull request Jun 27, 2022

feat: Display Cypress Dashboard metrics in the Specs Explorer #21250

Merged

3 tasks

tgriesser requested review from lmiller1990 and tbiethman June 27, 2022 19:35

tbiethman approved these changes Jun 27, 2022

View reviewed changes

mike-plummer reviewed Jun 27, 2022

View reviewed changes

Base automatically changed from muaz/CLOUD-577-spec-list-display-latest-runs to develop June 27, 2022 22:37

mike-plummer requested review from a team as code owners June 27, 2022 22:37

tgriesser requested a review from mike-plummer June 28, 2022 13:45

tgriesser added 5 commits June 28, 2022 09:49

feat: add batch execution to CloudDataSource, using @graphql-tools/ba…

33c9394

…tch-execute

more wip on batching

603ff80

add remoteGraphQLInterceptBatched for testing batched loading

a29449b

Don't change the overscan

0943be7

follow up re: @mike-plummer review

2ad75e1

tgriesser force-pushed the tgriesser/CLOUD-577-spec-list-display-latest-runs-batching branch from 2802981 to 2ad75e1 Compare June 28, 2022 13:53

tgriesser and others added 2 commits June 28, 2022 09:58

fix typing for RemoteGraphQLBatchInterceptor

cb10649

Merge branch 'develop' into tgriesser/CLOUD-577-spec-list-display-lat…

6d76285

…est-runs-batching

mike-plummer approved these changes Jun 28, 2022

View reviewed changes

BlueWinds removed the request for review from a team June 29, 2022 20:04

lmiller1990 reviewed Jun 30, 2022

View reviewed changes

Merge branch 'develop' into tgriesser/CLOUD-577-spec-list-display-lat…

1202eb5

…est-runs-batching

mike-plummer mentioned this pull request Jul 11, 2022

Spec data request batching #22599

Closed

flotwig approved these changes Jul 25, 2022

View reviewed changes

estrada9166 and others added 5 commits December 27, 2022 14:46

Merge branch 'develop' into tgriesser/CLOUD-577-spec-list-display-lat…

e328197

…est-runs-batching

bump snapshots

b0dd617

Merge branch 'tgriesser/CLOUD-577-spec-list-display-latest-runs-batch…

d858f6f

…ing' of https://github.com/cypress-io/cypress into tgriesser/CLOUD-577-spec-list-display-latest-runs-batching

Merge branch 'develop' into tgriesser/CLOUD-577-spec-list-display-lat…

1c5ff93

…est-runs-batching

Fix Cy tests

728be1f

estrada9166 marked this pull request as draft December 28, 2022 16:02

estrada9166 added 2 commits January 12, 2023 15:21

Merge branch 'develop' into tgriesser/CLOUD-577-spec-list-display-lat…

c038447

…est-runs-batching

Merge branch 'develop' into tgriesser/CLOUD-577-spec-list-display-lat…

e8bb513

…est-runs-batching

estrada9166 marked this pull request as ready for review January 13, 2023 18:33

estrada9166 marked this pull request as draft January 13, 2023 20:24

Merge branch 'develop' into tgriesser/CLOUD-577-spec-list-display-lat…

10e95ad

…est-runs-batching

estrada9166 marked this pull request as ready for review January 24, 2023 01:35

estrada9166 added 2 commits January 23, 2023 21:45

Merge branch 'develop' into tgriesser/CLOUD-577-spec-list-display-lat…

a700f8b

…est-runs-batching

Merge branch 'develop' into tgriesser/CLOUD-577-spec-list-display-lat…

dc6e16b

…est-runs-batching

estrada9166 marked this pull request as draft January 24, 2023 15:42

estrada9166 marked this pull request as ready for review January 25, 2023 15:15

estrada9166 and others added 5 commits January 25, 2023 10:15

Merge branch 'develop' into tgriesser/CLOUD-577-spec-list-display-lat…

fa50b1f

…est-runs-batching

Merge branch 'develop' into tgriesser/CLOUD-577-spec-list-display-lat…

eeadcc5

…est-runs-batching

Merge branch 'develop' into tgriesser/CLOUD-577-spec-list-display-lat…

d181241

…est-runs-batching

Merge branch 'develop' into tgriesser/CLOUD-577-spec-list-display-lat…

1587d73

…est-runs-batching

Merge branch 'develop' into tgriesser/CLOUD-577-spec-list-display-lat…

2d851aa

…est-runs-batching

emilyrohrbough merged commit 84d07a1 into develop Jan 25, 2023

emilyrohrbough deleted the tgriesser/CLOUD-577-spec-list-display-latest-runs-batching branch January 25, 2023 19:23

cypress-bot bot locked as resolved and limited conversation to collaborators Jan 27, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: add batch execution to CloudDataSource #22457

chore: add batch execution to CloudDataSource #22457

tgriesser commented Jun 22, 2022 •

edited

Loading

cypress-bot bot commented Jun 22, 2022

cypress bot commented Jun 22, 2022 •

edited

Loading

tbiethman left a comment

tgriesser commented Jun 27, 2022

mike-plummer left a comment

mike-plummer Jun 27, 2022

mike-plummer Jun 27, 2022

mike-plummer Jun 27, 2022

tgriesser Jun 28, 2022

tgriesser Jun 28, 2022

mike-plummer Jun 27, 2022

tgriesser Jun 28, 2022

mike-plummer left a comment

lmiller1990 Jun 30, 2022

lmiller1990 left a comment

emilyrohrbough commented Dec 27, 2022

estrada9166 commented Dec 28, 2022

emilyrohrbough commented Jan 24, 2023

estrada9166 commented Jan 24, 2023

cypress-bot bot commented Jan 27, 2023

		export type RemoteGraphQLInterceptor = (obj: RemoteGraphQLInterceptPayload, testState: Record<string, any>) => ExecutionResult \| Promise<ExecutionResult> \| Response

		export type RemoteGraphQLBatchInterceptor = (obj: RemoteGraphQLBatchInterceptPayload, testState: Record<string, any>) => any \| Promise<any>

chore: add batch execution to CloudDataSource #22457

chore: add batch execution to CloudDataSource #22457

Conversation

tgriesser commented Jun 22, 2022 • edited Loading

Additional details

Steps to test

How has the user experience changed?

PR Tasks

cypress-bot bot commented Jun 22, 2022

cypress bot commented Jun 22, 2022 • edited Loading

1 flaky tests on run #43438 ↗︎

tbiethman left a comment

Choose a reason for hiding this comment

tgriesser commented Jun 27, 2022

mike-plummer left a 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

mike-plummer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lmiller1990 left a comment

Choose a reason for hiding this comment

emilyrohrbough commented Dec 27, 2022

estrada9166 commented Dec 28, 2022

emilyrohrbough commented Jan 24, 2023

estrada9166 commented Jan 24, 2023

cypress-bot bot commented Jan 27, 2023

tgriesser commented Jun 22, 2022 •

edited

Loading

cypress bot commented Jun 22, 2022 •

edited

Loading