chore(build): use new config format for mocha v6.x #2309

raymondfeng · 2019-01-30T18:01:50Z

Supersedes #2281.

Checklist

npm test passes on your machine
New tests added or existing tests modified to cover all changes
Code conforms with the style guide
API Documentation in code was updated
Documentation in /docs/site was updated
Affected artifact templates in packages/cli were updated
Affected example projects in examples/* were updated

raymondfeng · 2019-02-01T16:02:40Z

Need to investigate why (node:1888) ExperimentalWarning: The http2 module is an experimental API. is printed on Windows. Maybe the node version is too low.

bajtos · 2019-02-04T12:53:14Z

Need to investigate why (node:1888) ExperimentalWarning: The http2 module is an experimental API. is printed on Windows. Maybe the node version is too low.

IIRC, AppVeyor is running an old version of Node.js 8.x. HTTP2 API was marked as stable at the time when 8.x was already in LTS state. We are also not able to upgrade to the latest version of Node.js 10.x because the tests are freezing - see #1431

bajtos · 2019-02-04T12:54:46Z

packages/build/package.json

@@ -20,7 +20,7 @@
    "debug": "^4.0.1",
    "fs-extra": "^7.0.0",
    "glob": "^7.1.2",
-    "mocha": "^5.1.1",
+    "mocha": "^6.0.0-1",


As commented in the original PR, I am reluctant to use pre-release versions. Can we wait until 6.0.0 is released please, and then use that version instead?

Sure. The PR was created to test out 6.x.

bajtos · 2019-02-04T12:58:01Z

packages/build/bin/run-mocha.js

@@ -31,8 +31,8 @@ function run(argv, options) {
  if (typeof options === 'boolean') options = {dryRun: options};
  options = options || {};
  if (setMochaOpts) {


setMochaOpts is checking for presence of --opts. So IIUC the current implementation, if --opts is not provided, we add --config. Which means that lb-mocha --config my.json will add --config .mocharc.json to the command line, ending up with two --config flags. Is that desirable? I think it's not. Either way, please add a test to verify how lb-mocha behaves in this scenario.

How about backwards compatibility? If we replace --opts with --config in our check and stop detecting --opts, then I think this is a breaking change requiring a semver-major release. It may be more conventient for our users if we keep support for both --opts and --config options. Either way, please add a test to verify what happens when lb-mocha is invoked with --opts only: do we add --config or not?

Maybe it's better to bump @loopback/build to the next major version. Using --opts for mocha@6.x seems to be add confusion.

I am fine with publishing a new semver-major version of @loopback/build. See https://github.com/strongloop/loopback-next/blob/master/docs/site/DEVELOPING.md#making-breaking-changes for a check-list.

It turns out that mocha 6.x continues to support mocha.opts. I have improved the PR to respect --opts and mocha.opts in addition to .mocharc.* formats. It should be now backward compatible.

bajtos · 2019-02-26T11:23:35Z

FWIW, mocha@6.0.0 is public: https://github.com/mochajs/mocha/releases/tag/v6.0.0

bajtos · 2019-02-26T16:58:27Z

@raymondfeng what's the status of this pull request? How is it different from #2422 which you have already landed?

raymondfeng · 2019-02-26T17:00:04Z

I would like to land this PR, which converts to the new --config and mocharc.json.

bajtos · 2019-02-28T15:29:59Z

I would like to land this PR

Sounds good to me. We need to follow the process for a new major version now.

Quoting from https://github.com/strongloop/loopback-next/blob/master/docs/site/DEVELOPING.md#making-breaking-changes

Describe incompatibilites for release notes

Look for more breaking changes to include in the release

Update list of supported versions

Most importantly, the commit message introducing the breaking change must include BREAKING CHANGE: footer - see https://github.com/strongloop/loopback-next/blob/master/docs/site/DEVELOPING.md#footer-optional.

We will need to update build's README to add a table listing supported major versions, I am ok to do that outside of this pull request if you prefer.

As for other breaking changes to include in the release, I am not really aware of any.

bajtos · 2019-02-28T15:31:30Z

We will need to update build's README to add a table listing supported major versions.

Let's apply the same format we use in LB3 repositories, see e.g.
https://github.com/strongloop/loopback#module-long-term-support-policy

raymondfeng · 2019-03-05T16:30:16Z

@bajtos I think I have made it backward compatible except breaking changes from mocha 6.x itself.

bajtos · 2019-03-05T16:37:18Z

packages/build/bin/utils.js

+    '.mocharc.json',
+    '.mocharc.yaml',
+    '.mocharc.yml',
+    'mocha.opts',


I believe the default config file is test/mocha.opts, not mocha.opts. Has this changed in mocha@6?

/cc @boneskull

Good catch. I fixed it.

raymondfeng requested a review from bajtos as a code owner January 30, 2019 18:01

raymondfeng mentioned this pull request Jan 30, 2019

build(build): upgrade Mocha to v6 prerelease #2281

Closed

7 tasks

raymondfeng force-pushed the boneskull-mocha-v6 branch from 2109e07 to 3f57b1f Compare January 30, 2019 21:36

bajtos suggested changes Feb 4, 2019

View reviewed changes

raymondfeng force-pushed the boneskull-mocha-v6 branch from 3f57b1f to 946993e Compare February 21, 2019 21:15

raymondfeng changed the title ~~[DO NOT MERGE] Upgrade to mocha v6.x~~ chore(build): upgrade to mocha v6.x Feb 25, 2019

raymondfeng force-pushed the boneskull-mocha-v6 branch from 946993e to 49febdd Compare February 25, 2019 22:09

raymondfeng force-pushed the boneskull-mocha-v6 branch from 49febdd to ea68719 Compare February 26, 2019 17:04

raymondfeng changed the title ~~chore(build): upgrade to mocha v6.x~~ chore(build): use new config format for mocha v6.x Feb 26, 2019

raymondfeng force-pushed the boneskull-mocha-v6 branch 2 times, most recently from fe4ab2d to 71d7696 Compare March 5, 2019 16:27

bajtos approved these changes Mar 5, 2019

View reviewed changes

bajtos requested a review from a team March 5, 2019 16:39

bajtos added Internal Tooling Issues related to our tooling and monorepo infrastructore developer-experience Issues affecting ease of use and overall experience of LB users labels Mar 5, 2019

raymondfeng force-pushed the boneskull-mocha-v6 branch from 71d7696 to 097ab71 Compare March 5, 2019 16:54

chore(build): replaces legacy mocha.opts with new .mocharc.json

4f8e2f8

raymondfeng force-pushed the boneskull-mocha-v6 branch from 097ab71 to 4f8e2f8 Compare March 5, 2019 16:59

raymondfeng merged commit c3d8007 into master Mar 5, 2019

raymondfeng deleted the boneskull-mocha-v6 branch March 5, 2019 20:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(build): use new config format for mocha v6.x #2309

chore(build): use new config format for mocha v6.x #2309

raymondfeng commented Jan 30, 2019 •

edited

raymondfeng commented Feb 1, 2019

bajtos commented Feb 4, 2019

bajtos Feb 4, 2019

raymondfeng Feb 4, 2019

bajtos Feb 4, 2019 •

edited

raymondfeng Feb 4, 2019

bajtos Feb 5, 2019

raymondfeng Mar 5, 2019

bajtos commented Feb 26, 2019

bajtos commented Feb 26, 2019

raymondfeng commented Feb 26, 2019

bajtos commented Feb 28, 2019

bajtos commented Feb 28, 2019

raymondfeng commented Mar 5, 2019

bajtos Mar 5, 2019 •

edited

raymondfeng Mar 5, 2019

chore(build): use new config format for mocha v6.x #2309

chore(build): use new config format for mocha v6.x #2309

Conversation

raymondfeng commented Jan 30, 2019 • edited

Checklist

raymondfeng commented Feb 1, 2019

bajtos commented Feb 4, 2019

bajtos Feb 4, 2019

Choose a reason for hiding this comment

raymondfeng Feb 4, 2019

Choose a reason for hiding this comment

bajtos Feb 4, 2019 • edited

Choose a reason for hiding this comment

raymondfeng Feb 4, 2019

Choose a reason for hiding this comment

bajtos Feb 5, 2019

Choose a reason for hiding this comment

raymondfeng Mar 5, 2019

Choose a reason for hiding this comment

bajtos commented Feb 26, 2019

bajtos commented Feb 26, 2019

raymondfeng commented Feb 26, 2019

bajtos commented Feb 28, 2019

bajtos commented Feb 28, 2019

raymondfeng commented Mar 5, 2019

bajtos Mar 5, 2019 • edited

Choose a reason for hiding this comment

raymondfeng Mar 5, 2019

Choose a reason for hiding this comment

raymondfeng commented Jan 30, 2019 •

edited

bajtos Feb 4, 2019 •

edited

bajtos Mar 5, 2019 •

edited