Initialize model with default values

[kestarumper]

Closes #1066.

Changes

• Model is initialized with the initialValues taken from schema (Bridge) -
• Model results from a shallow merge of schema.model and props.model and the latter one takes precedence
• (__tests__ only) render(...) changed wrapper from <context.Provider> to <AutoForm> because it changed behavior of <ListField> (the list of child fields was incorrect)

Notes

• BREAKING: This changes the initial render and doesn't trigger the Field.onChange of the fields that set their initialValue on the first render. However, the fields that are rendered after, e.g., after adding another field in an Array, or due to conditional rendering, will still trigger Field.onChange.
• BREAKING: Optional / Required doesn't affect setting the model

Example

• Playground (localhost)

// SimpleSchema2Bridge
{
  string1: {
    type: String,
    defaultValue: "yooo"
  },
  string2: {
    type: String,
    defaultValue: "yooo2",
    optional: true
  },
  friends: { type: Array, defaultValue: [{ name: "John Doe", age: 42 }] },
  'friends.$': Object,
  'friends.$.name': String,
  'friends.$.age': { type: Number, defaultValue: 99 },
  'friends.$.address': Object,
  'friends.$.address.street': { type: String, defaultValue: 'Sesame' },
  'friends.$.favoriteNumbers': { type: Array, defaultValue: [21, 37] },
  'friends.$.favoriteNumbers.$': { type: Number },
}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.19%. Comparing base (d2b924a) to head (f51be5f).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1343      +/-   ##
==========================================
+ Coverage   94.18%   94.19%   +0.01%     
==========================================
  Files         226      226              
  Lines        3664     3672       +8     
  Branches      989      988       -1     
==========================================
+ Hits         3451     3459       +8     
  Misses         81       81              
  Partials      132      132              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[kestarumper]

• add test to check if it works correctly with optional fields added during runtime

[piotrpospiech]

Playground link doesn't work for me (I installed dependencies, built everything and started doc website). I've got this error:

TypeError: Cannot read properties of undefined (reading 'length')

[piotrpospiech]

Shouldn't we also change the render-zod function?

[kestarumper]

Good call. It also showed some flaws in our tests. I fixed them.

[piotrpospiech]

Maybe it's just me, but I would use a different name 😛

[piotrpospiech]

contextValueExtension is no longer needed. It is used only for the onChange function. Just create the onChange param.

The whole render could also be refactored. schema, onChange and model are optional. They can be moved to an object param. We could avoid these kind of uses:

render(
  <ListField name="x">
    <Child />
    PlainText
  </ListField>,
  { x: Array, 'x.$': String },
  undefined,
  { x: [undefined, undefined] },
);

However, this is a big refactor because we use render many times, so maybe we can do it in another PR.

[kestarumper]

Yep, it is too much for this PR (for me). But if you want to refactor, you can commit to this PR.

[piotrpospiech]

Let's do this in another PR. Maybe just write TODO comment.

[kestarumper]

@piotrpospiech

Playground link doesn't work for me (I installed dependencies, built everything and started doc website). I've got this error:

TypeError: Cannot read properties of undefined (reading 'length')

Works for me.
I run npm run reset && npm ci (node v20.10.0).

[piotrpospiech]

@kestarumper I tried it with Node v20.10 and npm 10.2.5. I ran npm run reset && npm ci. Still the same issue:

TypeError: Cannot read properties of undefined (reading 'length')

However, it is working for @Monteth.

[piotrpospiech]

Let's do this in another PR. Maybe just write TODO comment.

[Monteth]

It is a great change. I'd like to see what is the impact on first render time 🤔

[Monteth]

Suggested change

	* Get initial model value recursively.
	* Get the initial model value walking the tree recursively.

Maybe it is nitpicking, but you do not recursively run the getInitialModel function.