Extract Initializer #757

dahlbyk · 2017-10-16T19:20:26Z

Griddle major version

1.x

Changes proposed in this pull request

Pulls the default+plugin+props composition out of the Griddle constructor into a testable initializer.

This is really just prep to work on supporting function plugins for #733.

Why these changes are made

Tests are good, especially for this sort of composition (which seems likely to get more complex).

Are there tests?

Lots!

dahlbyk · 2017-10-16T19:32:49Z

src/utils/__tests__/initilizerTests.js

+ },
+ };
+ const defaults = {
+ // TODO: bug that defaultEvents is not used?


@joellanciaux unclear from history, but I'm pretty sure you created defaultEvents but it was never used. Thoughts?

Yikes. I'm having a hard time following what was happening going off the blame. 😅

I think it was related to some composition updates I was wanting at the time, but I'm positive it's a perfect candidate for removal.

✅ 764a47e

joellanciaux

I have one comment regarding the removal of pageProperties + sortProperties prop values, but this is huge!

I am seeing some issues on the TS front in storybook that I'm having a hard time tracking down. I might need to lean on @ryanlanciaux to investigate that bit. Are you seeing anything?

joellanciaux · 2017-10-19T01:38:28Z

src/index.js

- const mergedStyleConfig = _.merge({}, defaultStyleConfig, ...plugins.map(p => p.styleConfig), styleConfig);
-
- const pageProperties = Object.assign({}, {
+ pageProperties: {


It looks like the pageProperties and sortProperties properties were removed. Can this be re-added?

As far as I could/can tell, there's actually nothing special about pageProperties and sortProperties relative to any other "extra" properties that are treated as initialState: note tests don't change in d69275a and 0cbc7d8.

dahlbyk · 2017-10-19T02:10:27Z

I am seeing some issues on the TS front in storybook that I'm having a hard time tracking down. I might need to lean on @ryanlanciaux to investigate that bit. Are you seeing anything?

I don't recall any issues from a month ago when I was working on this, but I can take another look.

I take it you approve of this direction? If so, I'll rebase on master to account for evolution since then.

dahlbyk

I have rebased on master and brought part of the listeners setup into initializer.

It seems like we could refactor StoreListener a bit to get the rest of the initialization out of the constructor (and more testable), but that's a more substantial change than the rest here.

I've left two notes related to spots where the general defaults < plugins < user props precedence is currently violated. Fixing them would technically be a breaking change, but I'm all about the principle of least surprise.

dahlbyk · 2017-10-19T13:53:48Z

src/utils/__tests__/initilizerTests.js

+
+ assert.deepEqual(ctx.events, {
+ Plugin: 1,
+ User: false, // TODO: bug that plugins overwrite user events?


@joellanciaux @ryanlanciaux is it intentional that events provided in <Griddle events={...}> are overwritten by events from plugins?

dahlbyk · 2017-10-19T13:55:22Z

src/utils/__tests__/initilizerTests.js

+
+ assert.false('defaults' in ctx.listeners);
+ assert.deepEqual(ctx.listeners.plugin(), 1);
+ assert.deepEqual(ctx.listeners.user(), false); // TODO: bug that plugins overwrite user listeners?


@joellanciaux @ryanlanciaux again: should <Griddle listeners={...}> be overwritten by plugins?

cc @shorja

dahlbyk · 2017-10-20T19:31:46Z

Inspired by #760, I've added commits to pull the current defaults into a CorePlugin of sorts that can be replaced (or omitted) via <Griddle core={...} />. Not sure if core is the right name for it, but it does seem a useful extra seem to adjust Griddle default behavior.

I did not bring in @shorja's core support for accepting a function from props, so parsing renderProperties from children (RowDefinition/ColumnDefinition) is the only behavior that's really not extensible. I'm not thrilled with core as function-of-props because for #733 I have been thinking of plugins as more of a reducer. But I'm not sure what a better pattern for handling renderProperties would be.

shorja · 2017-10-20T22:47:35Z

@dahlbyk Yeah now that I look at the core plugin taking in props, that's probably not a great way to handle stuff, especially since the pattern seems to be passing in init config to a plugin is done outside griddle -> . So really anything that should go into core really should be passed in like that, props should have nothing to do with it.

Is the idea of plugins as reducers to basically chain the output of built plugins into the next plugin to build and then each one can do what it wants to wrap components? I've also been thinking about refactoring the component composition logic, included in my mega PR was a change to allow enhancers to 'stack' but I was planning on revisiting it. I drew up a diagram that explains the behaviour I was thinking about.

dahlbyk · 2017-10-21T06:18:13Z

Is the idea of plugins as reducers to basically chain the output of built plugins into the next plugin to build and then each one can do what it wants to wrap components? I've also been thinking about refactoring the component composition logic, included in my mega PR was a change to allow enhancers to 'stack' but I was planning on revisiting it.

Yeah, given a series of function plugins, you can think of initializer as essentially plugins.reduce((config, plugin) => plugin(config), core). My first commit in this direction was e3f9481, but I wanted to land this initial refactoring first.

I like the idea of being able to apply multiple enhancers, as your diagram explains, but explaining "enhancers cleared by a new component" rules might be less intuitive than making (function) plugins decide how old/new enhancers should compose (c.f. #733 (comment)). I'd suggest the plugin composition conversation continue over there.

ryanlanciaux · 2017-10-27T09:59:31Z

I like this direction and definitely wonder if pushing the enhancer registration logic to the plugins themselves would make the logic easier to understand for anyone using the library.

dahlbyk · 2017-11-07T23:15:44Z

I am seeing some issues on the TS front in storybook that I'm having a hard time tracking down. I might need to lean on @ryanlanciaux to investigate that bit. Are you seeing anything?

I don't recall any issues from a month ago when I was working on this, but I can take another look.

@joellanciaux are you still seeing this? Thoughts on the pageProperties/sortProperties change?

ryanlanciaux · 2017-11-08T16:23:07Z

I'm in favor of moving this one forward. If there are no storybook + typescript issues (I'm not seeing any atm) I will merge this. Sound good? :D

dahlbyk mentioned this pull request Oct 16, 2017

Composable selectors #743

Open

dahlbyk commented Oct 16, 2017

View reviewed changes

joellanciaux requested changes Oct 19, 2017

View reviewed changes

dahlbyk added 24 commits October 18, 2017 23:13

Enable Storybook source-map

73db68b

Extract initializer util from Griddle constructor

82bde75

Add basic initializer tests

0d83e0c

Fix reducer composition for tests

75bcb8d

Attach individual reducers to Griddle reducer to help debugging/testing

a2a53eb

Test initialState.data

df08a82

Test initialState.renderProperties

e48f427

Test initialState.pageProperties

b8e45b9

Test initialState.sortProperties

9704acf

Test initialState.styleConfig

4c15ac7

Test extra initialState props

c4c6728

Avoid initialState key in init defaults

24f27cc

Avoid special treatment for pageProperties

5acfc42

Avoid special treatment for sortProperties

5e6b457

Test initializer reducers

8bff341

Test initializer reduxMiddleware

9eec496

Guard against invalid props-specified reduxMiddleware

bc60559

Test initializer components

1c0e5b2

Test initializer settingsComponentObjects

cee63fb

Test initializer events (bugs?!)

0576fbb

Test initializer selectors

3811319

Remove unused defaultEvents

764a47e

Test initializer listeners

5f1e8ed

Fix deferred load setState warning

227e35b

dahlbyk force-pushed the initializer branch from 65ff192 to 227e35b Compare October 19, 2017 13:46

dahlbyk commented Oct 19, 2017

View reviewed changes

dahlbyk added 3 commits October 20, 2017 13:37

Extract core plugin-ish

3577f8f

Handle null core

1ddd84f

Export CorePlugin; add to types

d2931e9

dahlbyk mentioned this pull request Oct 20, 2017

M major refactor #760

Open

ryanlanciaux merged commit c1ce993 into GriddleGriddle:master Nov 16, 2017

dahlbyk deleted the initializer branch November 17, 2017 16:55

ryanlanciaux mentioned this pull request Dec 23, 2017

Reconcile reducer/reducers #783

Merged

dahlbyk mentioned this pull request Mar 8, 2018

Settings Toggle is broken #801

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extract Initializer #757

Extract Initializer #757

dahlbyk commented Oct 16, 2017

dahlbyk Oct 16, 2017

joellanciaux Oct 18, 2017

dahlbyk Oct 19, 2017

joellanciaux left a comment

joellanciaux Oct 19, 2017

dahlbyk Oct 19, 2017

dahlbyk commented Oct 19, 2017

dahlbyk left a comment

dahlbyk Oct 19, 2017

dahlbyk Oct 19, 2017

dahlbyk commented Oct 20, 2017

shorja commented Oct 20, 2017

dahlbyk commented Oct 21, 2017

ryanlanciaux commented Oct 27, 2017

dahlbyk commented Nov 7, 2017

ryanlanciaux commented Nov 8, 2017

Extract Initializer #757

Extract Initializer #757

Conversation

dahlbyk commented Oct 16, 2017

Griddle major version

Changes proposed in this pull request

Why these changes are made

Are there tests?

dahlbyk Oct 16, 2017

Choose a reason for hiding this comment

joellanciaux Oct 18, 2017

Choose a reason for hiding this comment

dahlbyk Oct 19, 2017

Choose a reason for hiding this comment

joellanciaux left a comment

Choose a reason for hiding this comment

joellanciaux Oct 19, 2017

Choose a reason for hiding this comment

dahlbyk Oct 19, 2017

Choose a reason for hiding this comment

dahlbyk commented Oct 19, 2017

dahlbyk left a comment

Choose a reason for hiding this comment

dahlbyk Oct 19, 2017

Choose a reason for hiding this comment

dahlbyk Oct 19, 2017

Choose a reason for hiding this comment

dahlbyk commented Oct 20, 2017

shorja commented Oct 20, 2017

dahlbyk commented Oct 21, 2017

ryanlanciaux commented Oct 27, 2017

dahlbyk commented Nov 7, 2017

ryanlanciaux commented Nov 8, 2017