chore(v2): upgrade dependencies + require Node 12 by lex111 · Pull Request #4223 · facebook/docusaurus

lex111 · 2021-02-14T22:19:21Z

Motivation

Follow-up of #4148

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

Preview/E2E/Local dev.

Related PRs

(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)

netlify · 2021-02-14T22:20:25Z

Deploy preview for docusaurus-2 ready!

Built with commit dae33ca

https://deploy-preview-4223--docusaurus-2.netlify.app

netlify · 2021-02-14T22:20:34Z

[V1] Deploy preview success

Built with commit dae33ca

https://deploy-preview-4223--docusaurus-1.netlify.app

lex111 · 2021-02-14T22:20:39Z

package.json

-    "postinstall": "yarn lock:update && yarn build:packages",
+    "postinstall": "run-p postinstall:**",
+    "postinstall:main": "yarn lock:update && yarn build:packages",
+    "postinstall:dev": "is-ci || husky install",


Upgrade Husky (see https://dev.to/typicode/what-s-new-in-husky-5-32g5 for more details)

lex111 · 2021-02-14T22:21:34Z

packages/docusaurus-plugin-sitemap/src/createSitemap.ts

 */

-import sitemap, {Sitemap, SitemapItemOptions} from 'sitemap';
+import {SitemapStream, streamToPromise} from 'sitemap';


See https://github.com/ekalinin/sitemap.js/blob/master/CHANGELOG.md#500

This release is heavily focused on converting the core methods of this library to use streams. Why? Overall its made the API ~20% faster and uses only 10% or less of the memory.

lex111 · 2021-02-14T22:22:32Z

packages/docusaurus-plugin-sitemap/src/pluginOptionSchema.ts


 export const PluginOptionSchema = Joi.object({
-  cacheTime: Joi.number().positive().default(DEFAULT_OPTIONS.cacheTime),
+  cacheTime: Joi.number().positive().default(DEFAULT_OPTIONS.cacheTime), // deprecated


How do we manage deprecated fields? Should we notify the user about this (via console.log)?

cacheTime is being dropped from createSitemapIndex - This didn't actually cache the way it was written so this should be a non-breaking change in effect.

We have some examples in classic theme:

disableDarkMode: Joi.any().forbidden(false).messages({ 'any.unknown': 'disableDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.disableSwitch = true', }),

(not sure why there's a "false", looks like a typo btw)

lex111 · 2021-02-14T22:25:50Z

packages/docusaurus/src/server/translations/translationsExtractor.ts

        path.node.openingElement.name.name === 'Translate'
      ) {
        // We only handle the optimistic case where we have a single non-empty content
-        const singleChildren: NodePath | undefined = path


After bump of @babel/core, apparently type NodePath has been "extended", so I removed its using in two places so that the build succeeds again.

looks fine to me.

I think I added the types because TS complained otherwise so if it still compiles... ;)

github-actions · 2021-02-14T22:28:23Z

Size Change: +8 B (0%)

Total Size: 158 kB

ℹ️ View Unchanged

Filename	Size	Change
`website/build/assets/css/styles.********.css`	17.6 kB	0 B
`website/build/assets/js/main.********.js`	111 kB	+9 B (0%)
`website/build/blog/2017/12/14/introducing-docusaurus/index.html`	21.7 kB	-1 B (0%)
`website/build/docs/introduction/index.html`	180 B	0 B
`website/build/index.html`	6.95 kB	0 B

_{compressed-size-action}

lex111 · 2021-02-14T22:35:19Z

1:20:23 AM: error human-signals@2.1.0: The engine "node" is incompatible with this module. Expected version ">=10.17.0".

Hmm, one of the execa v5 dependencies requires node >=10.17.0, maybe we should switch to this version as minimum node version for our packages (given the EOL of 10.x ends in April https://github.com/nodejs/Release#release-schedule)?

slorber · 2021-02-15T18:02:25Z

packages/docusaurus-plugin-content-docs/src/__tests__/lastUpdate.test.ts

    expect(consoleMock).toHaveBeenCalledWith(
      new Error(
-        `Command failed with exit code 128: git log -1 --format=%ct, %an ${nonExistingFilePath}`,
+        `Command failed with exit code 128: git log -1 --format=%ct, %an ${nonExistingFilePath}\nfatal: ambiguous argument '${nonExistingFilePath}': unknown revision or path not in the working tree.\nUse '--' to separate paths from revisions, like this:\n'git <command> [<revision>...] -- [<file>...]'`,


any reason for this change?

The Windows CI does not seem too happy

To pass the tests, apparently something has changed in execa v5 🤷‍♂️

Not sure what's the easiest way to do that with Jest, but I think just matching the error message beginning should be fine.

Done this in another place:

expect(consoleSpy.mock.calls[0][0].message).toMatch(/^Command failed with exit code 128/);

I did it a little differently, the test passed, but Windows CI still failed.

slorber · 2021-02-15T18:05:23Z

Hmm, one of the execa v5 dependencies requires node >=10.17.0, maybe we should switch to this version as minimum node version for our packages (given the EOL of 10.x ends in April https://github.com/nodejs/Release#release-schedule)?

Yes, I think it's a good time to move to Node 12 min

github-actions · 2021-02-15T19:21:33Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟠 Performance	78
🟢 Accessibility	96
🟢 Best practices	100
🟢 SEO	100
🟢 PWA	95

Lighthouse ran on https://deploy-preview-4223--docusaurus-2.netlify.app/classic/

lex111 · 2021-02-17T12:48:18Z

A strange bug on WIndows CI - all tests pass, but exit code 1 is returned (see jestjs/jest#9324).

Test Suites: 68 passed, 68 total
Tests:       499 passed, 499 total
Snapshots:   254 passed, 254 total

slorber · 2021-02-17T14:03:37Z

this is weird, don't know why.
Maybe it's Jest 26 behavior?

We have this line in logs.

ReferenceError: You are trying to import a file after the Jest environment has been torn down.

Also someone reported this here: jestjs/jest#9324 (comment)

Maybe worth trying to fix this error and see?

slorber · 2021-02-17T14:29:25Z

Giving it a try. I think it's related to bad async tests in Jest that leak resources.

yarn test packages/lqip-loader/src/__tests__/index.test.ts --detectOpenHandles

Running Jest with --detectOpenHandles should not produce errors

lex111 · 2021-02-17T14:44:45Z

@slorber awesome, CI passed, thanks!

lex111 · 2021-02-17T14:59:33Z

Do we need to install the new version of immer via resolutions field to fix #4191? When react-dev-utils updates this package, we can remove this resolution. WDYT?

slorber · 2021-02-17T15:08:00Z

I don't think resolutions applies to dependencies, only our own repo, and it's yarn only so it's unlikely to solve any problem imho

lex111 · 2021-02-17T15:20:03Z

Alright, so I think the PR is ready for a merge.

slorber · 2021-02-18T14:11:06Z

thanks, LGTM

chore(v2): upgrade dependencies

665d9da

lex111 requested a review from slorber as a code owner February 14, 2021 22:19

facebook-github-bot added the CLA Signed Signed Facebook CLA label Feb 14, 2021

lex111 commented Feb 14, 2021

View reviewed changes

slorber reviewed Feb 15, 2021

View reviewed changes

lex111 added 5 commits February 15, 2021 21:38

Set minimum Node.js version to 12.13

1cbe6f8

Fix test

cb40cf0

Upgrade copy-text-to-clipboard

88b9734

Bump Node versions

2a2c3a7

Update .nvmrc

61f770d

mark cacheTime as forbidded field

f2dc18a

slorber changed the title ~~chore(v2): upgrade dependencies~~ chore(v2): upgrade dependencies + require Node 12 Feb 16, 2021

slorber added the pr: breaking change Existing sites may not build successfully in the new version. Description contains more details. label Feb 16, 2021

lex111 added 5 commits February 16, 2021 16:20

Downgrade jest to v25.2.7

27e6768

Increase Node version for Windows CI

4ad4851

Test fix

08f8401

Attempt to fix Windows CI

26fd0cc

Downgrade execa

568680c

fix async test errors

4e4d612

Upgrade execa

dae33ca

slorber merged commit f13448d into master Feb 18, 2021

lex111 deleted the lex111/deps1302 branch February 19, 2021 18:20

lex111 added this to the v2.0.0-alpha.71 milestone Mar 1, 2021

slorber mentioned this pull request May 25, 2022

RFC: Node support, browser support #7455

Open

2 tasks

Uh oh!

Conversation

lex111 commented Feb 14, 2021

Motivation

Have you read the Contributing Guidelines on pull requests?

Test Plan

Related PRs

Uh oh!

netlify bot commented Feb 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Feb 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lex111 Feb 14, 2021 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lex111 commented Feb 14, 2021

Uh oh!

slorber Feb 15, 2021 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

slorber commented Feb 15, 2021

Uh oh!

github-actions bot commented Feb 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lex111 commented Feb 17, 2021

Uh oh!

slorber commented Feb 17, 2021

Uh oh!

slorber commented Feb 17, 2021

Uh oh!

lex111 commented Feb 17, 2021

Uh oh!

lex111 commented Feb 17, 2021

Uh oh!

slorber commented Feb 17, 2021

Uh oh!

lex111 commented Feb 17, 2021

Uh oh!

slorber commented Feb 18, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

netlify bot commented Feb 14, 2021 •

edited

Loading

netlify bot commented Feb 14, 2021 •

edited

Loading

lex111 Feb 14, 2021 •

edited

Loading

github-actions bot commented Feb 14, 2021 •

edited

Loading

slorber Feb 15, 2021 •

edited

Loading

github-actions bot commented Feb 15, 2021 •

edited

Loading