TypeScriptify reporter. #5666

sainthkh · 2019-11-12T09:36:59Z

Part of #2690
Preparation for #678

Notes

Couldn't TypeScriptify integration tests because currently webpack config files are all typescript files. plugins/index.js cannot parse them.

PR Tasks

Have tests been added/updated?
Has a PR for user-facing changes been opened in cypress-documentation?
Have API changes been updated in the type definitions?
Have new configuration options been added to the cypress.schema.json?

cypress-bot · 2019-11-12T09:37:03Z

Thanks for the contribution! Below are some guidelines Cypress uses when doing PR reviews.

Please write [WIP] in the title of your Pull Request if your PR is not ready for review - someone will review your PR as soon as the [WIP] is removed.
Please familiarize yourself with the PR Review Checklist and feel free to make updates on your PR based on these guidelines.

PR Review Checklist

If any of the following requirements can't be met, leave a comment in the review selecting 'Request changes', otherwise 'Approve'.

User Experience

The feature/bugfix is self-documenting from within the product.
The change provides the end user with a way to fix their problem (no dead ends).

Functionality

The code works and performs its intended function with the correct logic.
Performance has been factored in (for example, the code cleans up after itself to not cause memory leaks).
The code guards against edge cases and invalid input and has tests to cover it.

Maintainability

The code is readable (too many nested 'if's are a bad sign).
Names used for variables, methods, etc, clearly describe their function.
The code is easy to understood and there are relevant comments explaining.
New algorithms are documented in the code with link(s) to external docs (flowcharts, w3c, chrome, firefox).
There are comments containing link(s) to the addressed issue (in tests and code).

Quality

The change does not reimplement code.
There's not a module from the ecosystem that should be used instead.
There is no redundant or duplicate code.
There are no irrelevant comments left in the code.
Tests are testing the code’s intended functionality in the best way possible.

Internal

The original issue has been tagged with a release in ZenHub.

sainthkh · 2019-11-18T08:50:45Z

It seems that the failure was because of a flaky test.

dmtrKovalenko · 2019-11-20T12:10:17Z

LGTM. Overall, there are some problems in the overall codebase, but they are coming from previous source. 👍

kuceb · 2019-11-20T16:08:21Z

packages/reporter/src/.eslintrc.json

@@ -3,9 +3,23 @@
    "plugin:@cypress/dev/react",
    "plugin:@cypress/dev/tests"
  ],
+  "parser": "@typescript-eslint/parser",


good to know we don't need parser: babel-eslint. If this works, after this gets merged we can update https://github.com/cypress-io/eslint-plugin-dev/blob/master/lib/index.js#L308 and remove babel-eslint

kuceb

@sainthkh you have outdone yourself here, this is great. There are a few files that got renamed and had enough changes to where they show up as deleted/added instead of renamed, but I don't think it's a big deal.

I still need to pull this down and run it locally

sainthkh · 2019-11-21T08:11:44Z

Fixed a few type errors. It seems that we need a type check process in our CI. Maybe we need another PR for this.

+ Another failure caused by flaky test.

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

chrisbreiding

I see now that eslint's no-unused-vars is superceded by TypeScript's, so that's why it has to be turned off, because it marks type declarations as unused vars.

packages/reporter/src/.eslintrc.json

* Turn on strict mode for ts files. * Tsified lib/app-state. * Tsified lib/err-model * Fixed eslint setting for tsx files. * Installed typings for classnames, chai-enzyme. * Tsified header/controls.jsx. Fixed app-state.ts for it. * Changed parser to typescript-eslint. * Tsified header/stats-store * Turn off no-unused-vars because it is checked by typescript compiler. * Removed Omit because we use typescript parser for eslint. * Tsified header/stats * Created Props interfaces. * Tsified header/header * Tsified hooks/hook-model * Tsified routes/route-model * Tsified lib/util * Tsified collapsible/collapsible * Tsified lib/flash-on-click * Tsified instrument-model and agent. * Tsified command/command-model.ts * Made hook-model use command-model types. * Tsified runnable/runnable-model and suite-model * Tsified lib/scroller. * Tsified test/test-model. * Tsified runnable-store and fixed related files. * Tsified shortcuts * Renamed events.ts * Tsified lib/events * Added typings * Tsified command/command.tsx. * Added more types to command.tsx * Tsified AnError and TestError * Tsified Hooks. * Tsified Routes. * Tsified test.tsx. * Tsified runnable-and-suite.tsx. * Tsified runnables.tsx * Added react-dom types. * Tsified main.jsx. * Fixed for build. * Fixed "Definition was not found" error. * Fixed sinon name imports. * Fixed Agents test types. * Removed IAppState. * Renamed for clarity. * Fixed model type in test-error. * Removed IStatsStore * Fixed HookModel. * Removed !. in events. * Fixed RouteModel. * Fixed runnables-store. * Fixed TestModel-related things. * Removed anys. * Fixed lint error. * Fixed AppState.pinnedSnapshotId type. * Fixed more types. * Removed NodeJS.TimeOut. * Fixed unit test failures. * fix lint script * used warn instead of 1

sainthkh added 20 commits November 12, 2019 11:19

Turn on strict mode for ts files.

0402b0e

Tsified lib/app-state.

19408e0

Tsified lib/err-model

5a451d1

Fixed eslint setting for tsx files.

b67fab7

Installed typings for classnames, chai-enzyme.

742455f

Tsified header/controls.jsx. Fixed app-state.ts for it.

624dd16

Changed parser to typescript-eslint.

f3ea8cc

Tsified header/stats-store

bc01a98

Turn off no-unused-vars because it is checked by typescript compiler.

3f89d9b

Removed Omit because we use typescript parser for eslint.

e2e290c

Tsified header/stats

fb67246

Created Props interfaces.

9f2aa92

Tsified header/header

704800b

Tsified hooks/hook-model

97a6460

Tsified routes/route-model

46bd7ac

Tsified lib/util

88af96c

Tsified collapsible/collapsible

b9387a3

Tsified lib/flash-on-click

9be0a45

Tsified instrument-model and agent.

efef633

Tsified command/command-model.ts

637bb07

sainthkh added 5 commits November 13, 2019 08:02

Merge branch 'develop' into ts-reporter

da56dfb

Made hook-model use command-model types.

afddd94

Tsified runnable/runnable-model and suite-model

95d1807

Tsified lib/scroller.

3c3844d

Tsified test/test-model.

0409329

sainthkh force-pushed the ts-reporter branch from 7fa8810 to 0409329 Compare November 13, 2019 01:46

sainthkh added 3 commits November 13, 2019 15:23

Tsified runnable-store and fixed related files.

76b9b94

Tsified shortcuts

dabddc2

Renamed events.ts

d0e60f4

sainthkh changed the title ~~wip TypeScriptify reporter.~~ TypeScriptify reporter. Nov 18, 2019

sainthkh marked this pull request as ready for review November 18, 2019 06:50

sainthkh added 2 commits November 18, 2019 16:02

Removed anys.

4b31a69

Fixed lint error.

8733fbb

jennifer-shehane requested a review from a team November 18, 2019 23:13

dmtrKovalenko previously approved these changes Nov 20, 2019

View reviewed changes

kuceb reviewed Nov 20, 2019

View reviewed changes

kuceb previously approved these changes Nov 20, 2019

View reviewed changes

Fixed AppState.pinnedSnapshotId type.

a64f7ee

sainthkh dismissed stale reviews from kuceb and dmtrKovalenko via a64f7ee November 21, 2019 07:59

Fixed more types.

1b1aff9

This was referenced Nov 21, 2019

Fix Object{N} + options mutation + command display names + big array/object message #5762

Closed

CI needs TypeScript type checker. #5772

Closed

kuceb requested a review from chrisbreiding November 25, 2019 20:14

chrisbreiding reviewed Nov 25, 2019

View reviewed changes

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

sainthkh added 3 commits November 26, 2019 10:00

Merge remote-tracking branch 'upstream/develop' into ts-reporter

461c0aa

Removed NodeJS.TimeOut.

0874fef

Fixed unit test failures.

d2dbc4c

jennifer-shehane added the process: code label Nov 26, 2019

Merge branch 'develop' into ts-reporter-local

a5cb42b

chrisbreiding reviewed Nov 27, 2019

View reviewed changes

packages/reporter/src/.eslintrc.json Show resolved Hide resolved

packages/reporter/src/.eslintrc.json Outdated Show resolved Hide resolved

chrisbreiding added 2 commits November 27, 2019 12:57

fix lint script

a967d89

used warn instead of 1

70faba9

chrisbreiding approved these changes Nov 27, 2019

View reviewed changes

chrisbreiding merged commit 0311c58 into cypress-io:develop Nov 27, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TypeScriptify reporter. #5666

TypeScriptify reporter. #5666

sainthkh commented Nov 12, 2019 •

edited

cypress-bot bot commented Nov 12, 2019

sainthkh commented Nov 18, 2019

dmtrKovalenko commented Nov 20, 2019

kuceb Nov 20, 2019

kuceb left a comment •

edited

sainthkh commented Nov 21, 2019 •

edited

chrisbreiding left a comment

TypeScriptify reporter. #5666

TypeScriptify reporter. #5666

Conversation

sainthkh commented Nov 12, 2019 • edited

Notes

PR Tasks

cypress-bot bot commented Nov 12, 2019

PR Review Checklist

User Experience

Functionality

Maintainability

Quality

Internal

sainthkh commented Nov 18, 2019

dmtrKovalenko commented Nov 20, 2019

kuceb Nov 20, 2019

Choose a reason for hiding this comment

kuceb left a comment • edited

Choose a reason for hiding this comment

sainthkh commented Nov 21, 2019 • edited

chrisbreiding left a comment

Choose a reason for hiding this comment

sainthkh commented Nov 12, 2019 •

edited

kuceb left a comment •

edited

sainthkh commented Nov 21, 2019 •

edited