Address GitHub CI issues #5465

gilluminate · 2024-11-05T22:01:08Z

Cypress tests are inconsistent, randomly fail, are quite slow. To help address this, lets:

Upgrade older versions of Cypress and Turbo
Upgrade cypress-io/github-action to v6
Update lots of Cypress stubs to avoid ECONNREFUSED errors with no BE running (/api/v1/system/, /health, etc)
Fix error handling on Privacy Center to avoid crashes during fides-js tests with no BE running
Minimize run time by avoiding redundant builds

vercel · 2024-11-05T22:01:13Z

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

Name	Status	Preview	Comments	Updated (UTC)
fides-plus-nightly	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 13, 2024 9:42pm

cypress · 2024-11-05T22:17:13Z

fides Run #10989

Run Properties: Passed #10989 • 87bc0b7332 ℹ️: Merge 8617dfcc9745530125636d458b91b32ebff739d5 into aa9155af32f1885f831006010eee...

Project	`fides`
Branch Review	`refs/pull/5465/merge`
Run status	`Passed #10989`
Run duration	`00m 37s`
Commit	`87bc0b7332 ℹ️: Merge 8617dfcc9745530125636d458b91b32ebff739d5 into aa9155af32f1885f831006010eee...`
Committer	`Jason Gill`
View all properties for this run ↗︎

Test results
Failures	`0`
Flaky	`0`
Pending	`0`
Skipped	`0`
Passing	`4`
⚠️ You've recorded test results over your free plan limit. Upgrade your plan to view test results.
View all changes introduced in this branch ↗︎

codecov · 2024-11-05T22:31:41Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.47%. Comparing base (44054e7) to head (70911eb).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5465   +/-   ##
=======================================
  Coverage   85.47%   85.47%           
=======================================
  Files         384      384           
  Lines       24119    24119           
  Branches     2625     2625           
=======================================
  Hits        20615    20615           
  Misses       2950     2950           
  Partials      554      554

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

lucanovera

Great work Jason! We can now get into the habit of making tests that are fully autonomous. I have ran every test without the backend running and they're all passing.
I left a question about a change I don't understand.

lucanovera · 2024-11-13T13:15:26Z

clients/admin-ui/cypress/e2e/config-wizard.cy.ts

-        },
-      ).as("postGenerate");
+      cy.intercept("POST", "/api/v1/generate", {
+        delay: 1000,


Nice cleanup

lucanovera · 2024-11-13T13:15:57Z

clients/admin-ui/cypress/e2e/datamap-report.cy.ts

@@ -79,7 +81,7 @@ describe("Data map report table", () => {

  it("can render empty datamap report", () => {
    cy.intercept("GET", "/api/v1/plus/datamap/minimal*", {
-      body: { items: [], page: 1, pages: 0, size: 25, total: 0 },
+      fixture: "empty-pagination.json",


very reusable

lucanovera · 2024-11-13T13:18:25Z

clients/admin-ui/cypress/e2e/privacy-experiences.cy.ts

-      fixture: "privacy-experiences/experienceConfig.json",
-    }).as("getExperienceDetail");
-    stubPlus(true);
+    stubProperties();


We had so many missing stubs, thanks for taking care of this.

lucanovera · 2024-11-13T13:21:39Z

clients/fides-js/src/services/api.ts

-  if (!response.ok) {
+  let response: Response;
+
+  try {


Nice improvement on error handleling

lucanovera · 2024-11-13T13:24:13Z

clients/admin-ui/src/features/plus/plus.slice.ts

+      transformResponse: (
+        response: CustomFieldDefinitionWithId[] | { detail: string },
+      ) => {
+        if ("detail" in response) {


I don't get the context for this change. Could you explain?

That's a great question that I'm trying to investigate and remember...

@lucanovera I updated this code with a comment to explain why. For some reason, instead of an error code or an empty list, the BE is returning { detail: "No custom metadata fields found with resource type system" } which was causing a console error in this original piece of code.

Thanks for the research! It's definitely a weird response by the BE, not a pattern we usually follow. I've created a tech debt ticket for it (https://ethyca.atlassian.net/browse/LA-142). After that is done, we won't need this custom handling. But for now, this is great.

Good idea! Thanks for doing that.

lucanovera

Great work! All questions cleared, all tests passing. Approved!

jpople

Everything is passing for me-- great job cleaning all this up.

jpople · 2024-11-13T17:37:49Z

clients/admin-ui/cypress/e2e/privacy-requests.cy.ts

        body: { access_result_urls: ["https://example.com/"] },
      }).as("getAccessResultURL");
-      cy.wait("@getPrivacyRequest");
+      stubPrivacyRequests(PrivacyRequestStatus.COMPLETE);
+      // cy.wait("@getPrivacyRequest");


Can this be removed?

jpople

Looks good and passing all tests for me.

cypress · 2024-11-13T21:56:19Z

fides Run #10990

Run Properties: Passed #10990 • d14d031e3d: Address GitHub CI issues (#5465)

Project	`fides`
Branch Review	`main`
Run status	`Passed #10990`
Run duration	`00m 38s`
Commit	`d14d031e3d: Address GitHub CI issues (#5465)`
Committer	`Jason Gill`
View all properties for this run ↗︎

Test results
Failures	`0`
Flaky	`0`
Pending	`0`
Skipped	`0`
Passing	`4`
⚠️ You've recorded test results over your free plan limit. Upgrade your plan to view test results.
View all changes introduced in this branch ↗︎

gilluminate force-pushed the gill/HJ-150/address-git-hub-ci-issues branch from 00f6df7 to 70911eb Compare November 5, 2024 23:26

vercel bot deployed to Preview November 5, 2024 23:31 View deployment

vercel bot deployed to Preview November 7, 2024 03:44 View deployment

gilluminate force-pushed the gill/HJ-150/address-git-hub-ci-issues branch from 7f4dcd5 to 7ba9f9a Compare November 7, 2024 17:21

vercel bot deployed to Preview November 7, 2024 17:29 View deployment

gilluminate added 6 commits November 7, 2024 17:04

similar to PC, run a quick typecheck during unit test

a98a092

upgrade cypress' CI runner to latest

3d4f90f

also clean .next with npm run clean

de6c5a8

upgrade Turbo

4aa8be6

update, fix, reuse stubs in all the tests

e8bcfc7

upgrade Cypress

79035eb

gilluminate force-pushed the gill/HJ-150/address-git-hub-ci-issues branch 2 times, most recently from 335cebe to 6af41f1 Compare November 8, 2024 00:07

minimize build time

ee68312

gilluminate force-pushed the gill/HJ-150/address-git-hub-ci-issues branch from 6af41f1 to ee68312 Compare November 8, 2024 00:13

fix issues with privacy center tests

4bbdff3

gilluminate marked this pull request as ready for review November 9, 2024 00:04

gilluminate requested review from jpople and lucanovera November 12, 2024 20:08

lucanovera reviewed Nov 13, 2024

View reviewed changes

add comment explaining reason for checking a "detail" response

cb7cb65

vercel bot deployed to Preview November 13, 2024 16:24 View deployment

lucanovera approved these changes Nov 13, 2024

View reviewed changes

jpople approved these changes Nov 13, 2024

View reviewed changes

Update privacy-requests.cy.ts

8617dfc

gilluminate merged commit d14d031 into main Nov 13, 2024
10 of 11 checks passed

gilluminate deleted the gill/HJ-150/address-git-hub-ci-issues branch November 13, 2024 21:39

vercel bot deployed to Preview November 13, 2024 21:42 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Address GitHub CI issues #5465

Address GitHub CI issues #5465

gilluminate commented Nov 5, 2024 •

edited

Loading

vercel bot commented Nov 5, 2024 •

edited

Loading

cypress bot commented Nov 5, 2024 •

edited

Loading

codecov bot commented Nov 5, 2024 •

edited

Loading

lucanovera left a comment

lucanovera Nov 13, 2024

lucanovera Nov 13, 2024

lucanovera Nov 13, 2024

lucanovera Nov 13, 2024

lucanovera Nov 13, 2024

gilluminate Nov 13, 2024

gilluminate Nov 13, 2024

lucanovera Nov 13, 2024

gilluminate Nov 13, 2024

lucanovera left a comment

jpople left a comment

jpople Nov 13, 2024

jpople left a comment

cypress bot commented Nov 13, 2024

Address GitHub CI issues #5465

Address GitHub CI issues #5465

Conversation

gilluminate commented Nov 5, 2024 • edited Loading

vercel bot commented Nov 5, 2024 • edited Loading

cypress bot commented Nov 5, 2024 • edited Loading

codecov bot commented Nov 5, 2024 • edited Loading

Codecov Report

lucanovera 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lucanovera left a comment

Choose a reason for hiding this comment

jpople left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jpople left a comment

Choose a reason for hiding this comment

cypress bot commented Nov 13, 2024

gilluminate commented Nov 5, 2024 •

edited

Loading

vercel bot commented Nov 5, 2024 •

edited

Loading

cypress bot commented Nov 5, 2024 •

edited

Loading

codecov bot commented Nov 5, 2024 •

edited

Loading