Packages: Move data module to the package maintained by Lerna #6828

gziolo · 2018-05-18T12:23:08Z

Description

Related issues: #3955, #6594.
Similar: #6658, #6756, #6758.

This PR tries to provide Lerna setup similar to what we have in WordPress/packages. This would allow publishing source code of individual modules to npm to make them available for all plugin developers.

After moving date and element, this PR moves data module to packages folder maintained by Lerna.

This is the first time where a package depends on another Gutenberg package (element).

Open question

data module uses window.localStorage which won't work in non-browser environments. Are we fine with having it included in the initial release? Should we add guard which disable persistence when local storage is not provided?

How has this been tested?

Manually:

Removed node_modules folder.
npm install
npm test
npm run dev
npm run build
npm run package-plugin

Types of changes

Refactoring.

Checklist:

My code is tested.
My code follows the WordPress code style.
My code has proper inline documentation.

youknowriad · 2018-05-18T13:39:42Z

data module uses window.localStorage which won't work in non-browser environments. Are we fine with having it included in the initial release?

For me it's fine. I think it's not even used by default unless you explicitly import the persisting helper.

youknowriad · 2018-05-18T13:42:50Z

This is the first time where a package depends on another Gutenberg package (element).

Since this is the first packages that users element I think we should discuss how we do JSX. At the moment we're relying on the wp.element.createElement pragma (global variable) but the @wordpress/element package don't generate the global by default and even if does it needs to be imported at least once to generate the global.

So what I propose is to do something similar to React:

require import { createElement } from '@wordpress/element' in all files using JSX
Update the eslint pragma config to match this change

travislopes · 2018-05-18T17:09:58Z

packages/data/README.md

@@ -1,9 +1,17 @@
-# Data
+# @wordpress/date


Should be @wordpress/data

Copy pasta 😃

gziolo · 2018-05-21T10:10:29Z

For me it's fine. I think it's not even used by default unless you explicitly import the persisting helper.

True, however, I added a way to override the default persistence storage with 04e52b0 :)

gziolo · 2018-05-21T10:12:55Z

So what I propose is to do something similar to React:

require import { createElement } from '@wordpress/element'` in all files using JSX
Update the eslint pragma config to match this change

Sounds like a good idea. With the small exception, we should limit Eslint check to packages folder. We also need to make sure Eslint doesn't complain when createElement is included when used with JSX powered file.

gziolo · 2018-05-23T11:56:51Z

require import { createElement } from '@wordpress/element' in all files using JSX
Update the eslint pragma config to match this change

Done with 6c26c4b.

There is one more thing which popped up after rebase. We need to move deprecated util to its own package.

gziolo · 2018-05-23T12:41:12Z

There is one more thing which popped up after rebase. We need to move deprecated util to its own package.

Introduced also @wordpress/devtools package. We might want to find a better name for it. I'm happy to update it if you have better ideas.

youknowriad · 2018-05-23T12:43:00Z

@gziolo Do you think it's possible to extract the devtools package to its own PR, I feel it could make it way quicker than the data one?

gziolo · 2018-05-23T12:44:08Z

@gziolo Do you think it's possible to extract the devtools package to its own PR, I feel it could make it way quicker than the data one?

Sure thing - it is in its own commit - doing it now.

gziolo · 2018-05-23T12:53:31Z

@youknowriad - I opened #6914 with devtools part, I will rebase this PR as soon as the other one lands.

gziolo · 2018-05-28T06:29:06Z

deprecated packages is now merged into master and this PR was rebased to use it.

youknowriad · 2018-05-28T08:28:16Z

eslint/config.js

+				},
+			},
+		},
+	],


I believe we still need a similar config for babel to generate the Right JS (instead of using the global)

Confirmed, I will look into it.

It should be fixed with f7afc46.

youknowriad

LGTM 👍 I'd appreciate a confirmation from @mtias or @aduth That the explicit import.

aduth

I'm fine with explicit createElement pragma. Would hope we'd apply it consistently eventually.

aduth · 2018-05-29T20:40:54Z

bin/packages/build.js

@@ -36,6 +36,8 @@ const DONE = chalk.reset.inverse.bold.green( ' DONE ' );
 */
 const babelDefaultConfig = require( '@wordpress/babel-preset-default' );
 babelDefaultConfig.babelrc = false;
+// TODO: It should become the default value when all modules are moved to packages.
+babelDefaultConfig.plugins[ 1 ][ 1 ].pragma = 'createElement';


Must we mutate? Can we assign into a new object? Not sure what would break, but certainly seems prone to cause breakage as implemented.

Similarly, the [ 1 ][ 1 ] assumes a very specific order which, while we maintain and is unlikely to change anytime soon, is certainly incredibly fragile.

I opted for a quick fix with the hope that it won't last for long. I guess it is going to be around for a couple of weeks at least so I'm happy to provide more solid processing of default Babel config.

fdb107e - done

aduth · 2018-05-29T20:41:26Z

packages/data/README.md

+Install the module
+
+```bash
+npm install @wordpress/data@next --save


Why do we @next ?

You are right, we can publish alpha without using dev :)

aduth · 2018-05-29T20:42:48Z

packages/data/package.json

+		"url": "https://github.com/WordPress/gutenberg/issues"
+	},
+	"main": "src/index.js",
+	"dependencies": {


Tests use deep-freeze and enzyme. Do we need to reflect that anywhere in this file as a dependency?

Given that we are going to move those packages elsewhere one day, let's keep all dependencies listed. I will add them.

I forgot that enzyme is already included in @wordpress/scripts by design.

I think we should be explicit :) If we use enzyme directly here in our tests, it should be a direct dependency

aduth · 2018-05-29T20:43:48Z

packages/data/package.json

+{
+	"name": "@wordpress/data",
+	"version": "0.0.1",
+	"description": "Data Redux module for WordPress",


The documentation clearly states:

The data module is built upon and shares many of the same core principles of Redux, but shouldn't be mistaken as merely Redux for WordPress

Is this not in contradiction?

It is, I will update.

aduth · 2018-05-29T20:47:40Z

packages/data/src/persist.js

@@ -8,6 +8,18 @@ import deprecated from '@wordpress/deprecated';
 */
 import { get } from 'lodash';

+// Defaults to the local storage.


So we default to a broken (error-throwing) state for Node environments where this package is used?

It's probably a larger dependency than we'd want, but something like Store.js is a good abstraction for this sort of thing.

Not really, you can make it work by using setter method introduced in this PR:

import store from 'store'; setPersistenceStorage( store );

It isn't ideal, needs to be documented but should allow us to move forward. I will add the following example in the README file.

Let's tackle it seperately as we don't have any docs for loadAndPersist anyways.

Opened #7015 to solve it.

gziolo · 2018-05-30T17:58:48Z

Let's get it in and see how it goes 🎉

gziolo self-assigned this May 18, 2018

gziolo requested review from ntwb and youknowriad May 18, 2018 12:23

gziolo added this to the 3.0 milestone May 18, 2018

gziolo added npm Packages Related to npm packages [Type] Refactoring [Package] Data /packages/data labels May 18, 2018

gziolo requested a review from a team May 18, 2018 12:27

travislopes reviewed May 18, 2018

View reviewed changes

gziolo force-pushed the update/data-package branch from 0f721cd to 04e52b0 Compare May 21, 2018 10:09

gziolo requested a review from mtias May 21, 2018 10:09

gziolo force-pushed the update/data-package branch from 04e52b0 to d458cb9 Compare May 22, 2018 14:06

gziolo force-pushed the update/data-package branch from 075da81 to d1f6717 Compare May 23, 2018 12:39

gziolo mentioned this pull request May 23, 2018

Deprecated: Introduce new module with depreaction util #6914

Merged

4 tasks

gziolo mentioned this pull request May 24, 2018

Packages: Move element to packages maintained by Lerna #6756

Merged

3 tasks

gziolo force-pushed the update/data-package branch from d1f6717 to 169ae93 Compare May 27, 2018 14:21

youknowriad reviewed May 28, 2018

View reviewed changes

gziolo mentioned this pull request May 28, 2018

Blob: Extract new blob package out of utils module #6973

Merged

3 tasks

gziolo added 2 commits May 28, 2018 16:26

Packages: Move data module to the package maintained by Lerna

39e01f4

Data: Add a way to override the persistence storage

dcdbcc4

gziolo added 3 commits May 28, 2018 16:26

Data: Enforce JSX pragma for packages

3a6450e

Devtools: Introduce new module with depreacted util

fa597be

Packages: Update Babel config to use createElement as pragma for JSX

f7afc46

gziolo force-pushed the update/data-package branch from 169ae93 to f7afc46 Compare May 28, 2018 15:11

youknowriad approved these changes May 28, 2018

View reviewed changes

Shelob9 mentioned this pull request May 29, 2018

Packages: Publish all modules as independent npm packages #3955

Closed

19 tasks

youknowriad modified the milestones: 3.0, 3.1 May 29, 2018

aduth reviewed May 29, 2018

View reviewed changes

gziolo added 4 commits May 30, 2018 10:29

Packages: Remove @next from README files

decc7b5

Packages: Make Babel config less fragile

fdb107e

Data: Add deep-freeze as dev dependency

889b45f

Data: Update depscription in package.json

3dcc655

youknowriad approved these changes May 30, 2018

View reviewed changes

Packages: Add enzyme as dev dependency

3eae5a3

gziolo merged commit c1fffb1 into master May 30, 2018

gziolo deleted the update/data-package branch May 30, 2018 17:58

gziolo modified the milestones: 3.1, 3.0 May 30, 2018

ellatrix added [Type] Code Quality Issues or PRs that relate to code quality and removed [Type] Code Quality Issues or PRs that relate to code quality labels Nov 27, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Packages: Move data module to the package maintained by Lerna #6828

Packages: Move data module to the package maintained by Lerna #6828

gziolo commented May 18, 2018 •

edited

Loading

youknowriad commented May 18, 2018

youknowriad commented May 18, 2018

travislopes May 18, 2018

gziolo May 18, 2018

gziolo commented May 21, 2018

gziolo commented May 21, 2018 •

edited

Loading

gziolo commented May 23, 2018

gziolo commented May 23, 2018

youknowriad commented May 23, 2018

gziolo commented May 23, 2018

gziolo commented May 23, 2018

gziolo commented May 28, 2018

youknowriad May 28, 2018

gziolo May 28, 2018

gziolo May 28, 2018

youknowriad left a comment

aduth left a comment

aduth May 29, 2018

gziolo May 30, 2018

gziolo May 30, 2018

aduth May 29, 2018

gziolo May 30, 2018

aduth May 29, 2018

gziolo May 30, 2018

gziolo May 30, 2018

youknowriad May 30, 2018

aduth May 29, 2018

gziolo May 30, 2018

aduth May 29, 2018

gziolo May 30, 2018

gziolo May 30, 2018

gziolo May 30, 2018

gziolo commented May 30, 2018

Packages: Move data module to the package maintained by Lerna #6828

Packages: Move data module to the package maintained by Lerna #6828

Conversation

gziolo commented May 18, 2018 • edited Loading

Description

Open question

How has this been tested?

Types of changes

Checklist:

youknowriad commented May 18, 2018

youknowriad commented May 18, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gziolo commented May 21, 2018

gziolo commented May 21, 2018 • edited Loading

gziolo commented May 23, 2018

gziolo commented May 23, 2018

youknowriad commented May 23, 2018

gziolo commented May 23, 2018

gziolo commented May 23, 2018

gziolo commented May 28, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

youknowriad left a comment

Choose a reason for hiding this comment

aduth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gziolo commented May 30, 2018

gziolo commented May 18, 2018 •

edited

Loading

gziolo commented May 21, 2018 •

edited

Loading