fix e2e tests for helix-front by micahstubbs · Pull Request #2144 · apache/helix

micahstubbs · 2022-06-07T20:57:22Z

Issues

My PR addresses the following Helix issues and references them in the PR description:

fix #2075 #2148

Description

Here are some details about my PR, including screenshots of any UI changes:

This PR fixes the end to end tests by replacing the deprecated Protractor library with Cypress.

This PR also replaces karma and jasmine with Jest [Jest + Angular guide].

Tests

The following tests are written for this issue:

cypress/e2e/spec.cy.ts

[x] The following is the result of the "mvn test" command on the appropriate module:

N/A, helix-front only change. No Java changes.

Changes that Break Backward Compatibility

[x] No backwards incompatible changes

Documentation

[x] New commands documented in ./helix-front/README.md

Commits

[x] Commits match Apache style

Code Quality

[x] My diff has been formatted using helix-style.xml
(helix-style-intellij.xml if IntelliJ IDE is used)

N/A, helix-front only change. No Java changes. See #2143 for an effort to add automatic code formatting for helix-front.

micahstubbs · 2022-06-07T20:58:57Z

@somecodemonkey this PR is ready for your review. Thanks for sharing your frontend expertise!

micahstubbs · 2022-06-07T21:00:35Z

helix-front/angular.json

        },
        "test": {
-          "builder": "@angular-devkit/build-angular:karma",
+          "builder": "@angular-builders/jest:run",


I followed this guide to migrate, adjusting the paths to helix-front's existing paths along the way.

micahstubbs · 2022-06-07T21:02:00Z

helix-front/client/app/dashboard/dashboard.component.ts

      .subscribe(
        result => {
-          _.forEach(result, (resource) => {
+          lodashForEach(result, (resource) => {


A workaround for this TypeScript related error: https://stackoverflow.com/q/49256040/1732222

A secondary benefit of this approach is new contributors will be less likely to confuse lodash's forEach with the native TypeScript Array.forEach().

micahstubbs · 2022-06-07T21:07:15Z

helix-front/tsconfig.json

    "target": "es2015",
    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,


These two options are the other part of the solution to https://stackoverflow.com/q/49256040/1732222

micahstubbs

Self-review complete. I left some comments for other reviewers. LGTM.

helix-front/cypress/support/e2e.ts

…than root tsconfig

…arma-chrome-launcher karma-coverage-istanbul-reporter karma-cli karma-jasmine-html-reporter karma-phantomjs-launcher

… target once

micahstubbs · 2022-06-14T18:12:44Z

@somecodemonkey here is the test failure. It seems like installing this frontend dependency vis-network fails in the Ubuntu CI machine. This failure also appears on master:

[INFO] --- frontend-maven-plugin:1.12.1:yarn (yarn install) @ helix-front ---
[INFO] Running 'yarn install' in /home/runner/work/helix/helix/helix-front
[INFO] yarn install v1.22.18
[INFO] [1/5] Validating package.json...
[INFO] [2/5] Resolving packages...
[INFO] warning request > har-validator@5.1.5: this library is no longer supported
[INFO] [3/5] Fetching packages...
[INFO] [4/5] Linking dependencies...
[INFO] warning " > ngx-vis@3.1.0" has incorrect peer dependency "keycharm@^0.2.0".
[INFO] warning "@angular-builders/jest > jest-preset-angular > ts-jest@27.1.5" has incorrect peer dependency "jest@^27.0.0".
[INFO] warning " > @angular/compiler-cli@13.3.9" has incorrect peer dependency "@angular/compiler@13.3.9".
[INFO] warning nohoist config is ignored in "cypress" because it is not a private package. If you think nohoist should be allowed in public packages, please submit an issue for your use case.
[INFO] [5/5] Building fresh packages...
[INFO] info This package requires node-gyp, which is not currently installed. Yarn will attempt to automatically install it. If this fails, you can run "yarn global add node-gyp" to manually install it.
[INFO] error An unexpected error occurred: "/home/runner/work/helix/helix/helix-front/node_modules/vis-network: Cannot read property 'config' of undefined".
[INFO] error An unexpected error occurred: "/home/runner/work/helix/helix/helix-front/node_modules/vis-network: Cannot read property 'config' of undefined".info If you think this is a bug, please open a bug report with the information provided in "/home/runner/.config/yarn/global/yarn-error.log".****

[INFO] error An unexpected error occurred: "/home/runner/work/helix/helix/helix-front/node_modules/vis-network: Cannot read property 'config' of undefined". [INFO] error An unexpected error occurred: "/home/runner/work/helix/helix/helix-front/node_modules/vis-network: Cannot read property 'config' of undefined".info If you think this is a bug, please open a bug report with the information provided in "/home/runner/.config/yarn/global/yarn-error.log".****

https://github.com/apache/helix/runs/6820814450?check_suite_focus=true

logged as #2148

somecodemonkey · 2022-06-14T18:20:05Z

LGTM, please look into the failing build test as well

micahstubbs · 2022-06-14T22:19:37Z

This PR is ready to be merged, approved by @somecodemonkey
Final commit message:

fix e2e tests for helix-front (#2075)

Fix the helix-front end to end tests by replacing the deprecated Protractor testing library with Cypress

junkaixue · 2022-06-14T23:22:05Z

How was the failing test as Darby mentioned?

micahstubbs · 2022-06-14T23:31:18Z

@junkaixue good question. Details here: #2148

It looks like there is an OS specific failure during Javascript dependency installation.

micahstubbs · 2022-06-15T00:25:49Z

Based on conversation with @junkaixue will fix #2148 first.

micahstubbs · 2022-06-15T03:08:14Z

#2148 is now fixed.

micahstubbs · 2022-06-15T03:08:48Z

This PR is ready to be merged, approved by @somecodemonkey

Final commit message:

fix e2e tests for helix-front (#2075)
Fix the helix-front end to end tests by replacing the deprecated Protractor testing library with Cypress

micahstubbs commented Jun 7, 2022

View reviewed changes

somecodemonkey reviewed Jun 9, 2022

View reviewed changes

helix-front/cypress/support/e2e.ts Outdated Show resolved Hide resolved

somecodemonkey reviewed Jun 9, 2022

View reviewed changes

helix-front/cypress/support/e2e.ts Outdated Show resolved Hide resolved

micahstubbs added 23 commits June 9, 2022 13:49

yarn add -D @types/jest

c6b5ad7

update e2e tsconfig to match format of app tsconfig

0747341

move files to top level of tsconfig, do not specify different target …

4da4b1c

…than root tsconfig

remove trailing comma

6d46e14

try jest types

5e0d8ed

yarn remove @types/jasmine jasmine-core jasmine-spec-reporter karma k…

69a4814

…arma-chrome-launcher karma-coverage-istanbul-reporter karma-cli karma-jasmine-html-reporter karma-phantomjs-launcher

yarn add -D @types/jest jest jest-preset-angular @angular-builders/jest

e380853

add setupJest.ts and remove client/test.ts

3164d00

add jest.config.js

7ffcbfb

update angular.json

e7c7c36

set esModuleInterop to true in root tsconfig

14a0119

finish configuring jest: paths in arrays, test file, and only specify…

7fd6939

… target once

fix typescript errors related to import * pattern

180f77b

yarn add -D canvas

21082e0

yarn add -D jest-html-reporters

9c5ea7d

ng add @cypress/schematic

f655527

migrate test specs to cypress

b2688f9

remove old protractor files

db136c4

tell cypress to watch for file changes

fb6fd38

yarn add -D cypress

223f1c1

fix cypress dir

07c2738

use named imports for server/app.ts

5f37182

fix typescript config, ignore types from e2e tests

e429109

micahstubbs added 10 commits June 9, 2022 13:57

serve on port 4200

5f2f8f4

fix relative path to root tsconfig

8592a6e

add tests for title and footer

a33d7c3

yarn remove protractor

fdab1d5

specify config file and browser for Cypress

d8e292d

add missing newline

c887c92

remove trailing comma

0e700ed

add missing newline

777cefe

fix newline

845518c

delete cypress template files, rely on docs instead

cea3e24

micahstubbs force-pushed the 2075/e2e-tests-chrome-issue branch from 3b7a936 to cea3e24 Compare June 9, 2022 20:57

yarn add vis-network@7.10.2

71d53b4

micahstubbs mentioned this pull request Jun 15, 2022

helix-front: fix tsickle git hash bug #2151

Merged

11 tasks

junkaixue merged commit 1c16a6f into apache:master Jun 15, 2022

micahstubbs deleted the 2075/e2e-tests-chrome-issue branch June 15, 2022 18:51

micahstubbs mentioned this pull request Sep 7, 2022

[Failed CI Test] helix-front yarn install fails: helix-front/node_modules/vis-network: Cannot read property 'config' of undefined". #2148

Closed

Conversation

micahstubbs commented Jun 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issues

Description

Tests

Changes that Break Backward Compatibility

Documentation

Commits

Code Quality

Uh oh!

micahstubbs commented Jun 7, 2022

Uh oh!

micahstubbs Jun 7, 2022

Choose a reason for hiding this comment

Uh oh!

micahstubbs Jun 7, 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!

micahstubbs Jun 7, 2022

Choose a reason for hiding this comment

Uh oh!

micahstubbs left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

micahstubbs commented Jun 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

somecodemonkey commented Jun 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

micahstubbs commented Jun 14, 2022

fix e2e tests for helix-front (#2075)

Uh oh!

junkaixue commented Jun 14, 2022

Uh oh!

micahstubbs commented Jun 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

micahstubbs commented Jun 15, 2022

Uh oh!

micahstubbs commented Jun 15, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

micahstubbs commented Jun 15, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Final commit message:

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

micahstubbs commented Jun 7, 2022 •

edited

Loading

micahstubbs Jun 7, 2022 •

edited

Loading

micahstubbs commented Jun 14, 2022 •

edited

Loading

somecodemonkey commented Jun 14, 2022 •

edited

Loading

micahstubbs commented Jun 14, 2022 •

edited

Loading

micahstubbs commented Jun 15, 2022 •

edited

Loading

micahstubbs commented Jun 15, 2022 •

edited

Loading