refactor(tests): API tests #32643

tassoevan · 2024-06-20T01:14:20Z

Proposed changes (including videos or screenshots)

It migrates integration tests to TypeScript.

Issue(s)

Steps to test or reproduce

Further comments

The goal of this changes is to raise the maintenance rate and, subsequently, the quality of these tests.

Before

🟠 JavaScript files: 333
🔵 TypeScript files: 6465
      🧪 Conversion: 95.10%

🟠 JavaScript LOCs: 55515
🔵 TypeScript LOCs: 409232
      🧪 Conversion: 88.05%

  JavaScript biggest files:
    apps/meteor/tests/end-to-end/api/01-users.js (125.04kb)
    apps/meteor/server/models/raw/Users.js (56.83kb)
    apps/meteor/app/slackbridge/server/SlackAdapter.js (43.78kb)
    apps/meteor/app/markdown/lib/hljs.js (19.49kb)
    packages/node-poplib/src/index.js (18.83kb)
    packages/eslint-config/style/index.js (15.81kb)
    packages/eslint-config/imports/index.js (10.80kb)
    packages/eslint-config/best-practices/index.js (9.15kb)
    apps/meteor/public/enc.js (2.99kb)
    packages/message-parser/webpack.config.js (1.79kb)

After


🟠 JavaScript files: 292
🔵 TypeScript files: 6500
      🧪 Conversion: 95.70%

🟠 JavaScript LOCs: 30317
🔵 TypeScript LOCs: 434714
      🧪 Conversion: 93.48%

  JavaScript biggest files:
    apps/meteor/server/models/raw/Users.js (56.83kb)
    apps/meteor/app/slackbridge/server/SlackAdapter.js (43.78kb)
    apps/meteor/app/markdown/lib/hljs.js (19.49kb)
    packages/node-poplib/src/index.js (18.83kb)
    packages/eslint-config/style/index.js (15.81kb)
    packages/eslint-config/imports/index.js (10.80kb)
    packages/eslint-config/best-practices/index.js (9.15kb)
    apps/meteor/public/enc.js (2.99kb)
    packages/message-parser/webpack.config.js (1.79kb)
    packages/eslint-config/react.js (0.97kb)

dionisio-bot · 2024-06-20T01:14:24Z

Looks like this PR is not ready to merge, because of the following issues:

This PR is targeting the wrong base branch. It should target 6.11.0, but it targets 6.10.0

Please fix the issues and try again

If you have any trouble, please check the PR guidelines

changeset-bot · 2024-06-20T01:14:24Z

⚠️ No Changeset found

Latest commit: 191e534

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

codecov · 2024-06-20T01:47:23Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.72%. Comparing base (1827e95) to head (b654f09).
Report is 3 commits behind head on develop.

❗ Current head b654f09 differs from pull request most recent head 191e534

Please upload reports for the commit 191e534 to get more accurate results.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #32643      +/-   ##
===========================================
- Coverage    56.73%   56.72%   -0.01%     
===========================================
  Files         2496     2496              
  Lines        55360    55359       -1     
  Branches     11455    11455              
===========================================
- Hits         31407    31403       -4     
+ Misses       21255    21253       -2     
- Partials      2698     2703       +5

Flag	Coverage Δ
e2e	`56.47% <ø> (-0.01%)`	⬇️
unit	`71.85% <100.00%> (-0.03%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

apps/meteor/tests/data/users.helper.ts

sampaiodiego · 2024-06-24T20:33:08Z

apps/meteor/tests/data/uploads.helper.ts

 				expect(res.body).to.have.property('success', true);
 				expect(res.body).to.have.property('files').and.to.be.an('array');
 			})
 			.end(done);
 	});

-	it('should not return thumbnails', async function () {
+	it('should not return thumbnails', async () => {


are these changes because of our eslint rules? just want to point this out https://mochajs.org/#arrow-functions

I wonder if should have a mix of arrow and non-arrow functions when the this context is needed, or if we should stick to one or the other

ESLint rules. However, @typescript-eslint ensures functions are converted to arrow functions only when there is no references to this.
Personally, it feels like there is very little situations where we need to use the Mocha context e.g. this.retries(n) was redudant with the current configuration and calls to this.skip() are rare and easily replaced with it.skip/describe.skip.

sampaiodiego · 2024-06-24T20:35:06Z

do you have a before/after of JS/TS files? I'm just curious about the new stats

tassoevan force-pushed the refactor/api-tests branch 6 times, most recently from 8f8cb55 to a7a6016 Compare June 22, 2024 20:09

tassoevan added 17 commits June 22, 2024 18:31

Remove unused module

525c84a

Enable ESLint on /tests/data

e9fa237

Remove file extension from imports

a75265c

Export Credentials type

4c501e5

Migrate some modules to TS

cb0858e

Migrate some modules to TS

6fd08dd

Upgrade @types/chai

d45147b

Add missing field to IUser

e547792

Migrate some modules to TS

05c31ea

Remove obsolete field from IRoom

5a3e7fc

Migrate some modules to TS

9eda776

Migrate some modules to TS

a47482b

Migrate some modules to TS

1f98aaa

Migrate some modules to TS

fd79348

Migrate some modules to TS

f48eddc

Migrate some modules to TS

83e4c17

Absorb helpers

951d24d

tassoevan force-pushed the refactor/api-tests branch from a7a6016 to 951d24d Compare June 22, 2024 21:32

github-advanced-security bot found potential problems Jun 22, 2024

View reviewed changes

apps/meteor/tests/data/users.helper.ts Dismissed Show dismissed Hide dismissed

tassoevan added 2 commits June 22, 2024 23:10

Type-check the endpoints referred

d88904e

Remove this.retries(0)

191e534

tassoevan force-pushed the refactor/api-tests branch 2 times, most recently from b654f09 to 191e534 Compare June 23, 2024 12:29

tassoevan added this to the 6.10 milestone Jun 24, 2024

tassoevan marked this pull request as ready for review June 24, 2024 15:43

tassoevan requested review from a team as code owners June 24, 2024 15:43

tassoevan modified the milestones: 6.10, 7.0 Jun 24, 2024

sampaiodiego reviewed Jun 24, 2024

View reviewed changes

tassoevan modified the milestones: 7.0, 6.11 Jun 24, 2024

ggazzo approved these changes Jun 24, 2024

View reviewed changes

ggazzo added the stat: QA assured Means it has been tested and approved by a company insider label Jun 24, 2024

dionisio-bot bot added the stat: ready to merge PR tested and approved waiting for merge label Jun 24, 2024

ggazzo merged commit e07a515 into develop Jun 24, 2024
60 of 77 checks passed

ggazzo deleted the refactor/api-tests branch June 24, 2024 21:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(tests): API tests #32643

refactor(tests): API tests #32643

tassoevan commented Jun 20, 2024 •

edited

Loading

dionisio-bot bot commented Jun 20, 2024 •

edited

Loading

changeset-bot bot commented Jun 20, 2024 •

edited

Loading

codecov bot commented Jun 20, 2024 •

edited

Loading

sampaiodiego Jun 24, 2024

tassoevan Jun 24, 2024

sampaiodiego commented Jun 24, 2024

refactor(tests): API tests #32643

refactor(tests): API tests #32643

Conversation

tassoevan commented Jun 20, 2024 • edited Loading

Proposed changes (including videos or screenshots)

Issue(s)

Steps to test or reproduce

Further comments

Before

After

dionisio-bot bot commented Jun 20, 2024 • edited Loading

changeset-bot bot commented Jun 20, 2024 • edited Loading

⚠️ No Changeset found

codecov bot commented Jun 20, 2024 • edited Loading

Codecov Report

sampaiodiego Jun 24, 2024

Choose a reason for hiding this comment

tassoevan Jun 24, 2024

Choose a reason for hiding this comment

sampaiodiego commented Jun 24, 2024

tassoevan commented Jun 20, 2024 •

edited

Loading

dionisio-bot bot commented Jun 20, 2024 •

edited

Loading

changeset-bot bot commented Jun 20, 2024 •

edited

Loading

codecov bot commented Jun 20, 2024 •

edited

Loading