feat: make the `include` option of `Model.create` default to all provided associations #16922

sakupan102 · 2024-01-01T10:57:43Z

Pull Request Checklist

Have you added new tests to prevent regressions?
If a documentation update is necessary, have you opened a PR to the documentation repository?
Did you update the typescript typings accordingly (if applicable)?
Does the description below contain a link to an existing issue (Closes #[issue]) or a description of the issue you are solving?
Does the name of your PR follow our conventions?

Description Of Change

Its a feature request opened by #15233

Todos

Add tests for Models.create

ephys

Thank you for the PR!

ephys · 2024-02-10T19:09:02Z

packages/core/src/model.js

@@ -1759,6 +1763,18 @@ ${associationOwner._getAssociationDebugList()}`);
    }).save(options);
  }

+  static _searchInclude(values) {


New functions like this one should go in model-internals.ts instead

I think getDefaultCreateInclude may be a more explicit name

ephys · 2024-02-10T19:09:08Z

packages/core/src/model.js

@@ -1759,6 +1763,18 @@ ${associationOwner._getAssociationDebugList()}`);
    }).save(options);
  }

+  static _searchInclude(values) {
+    const association = [];


Suggested change

const association = [];

const associations = [];

ephys · 2024-02-10T19:12:01Z

packages/core/src/model.js

@@ -1749,6 +1749,10 @@ ${associationOwner._getAssociationDebugList()}`);
   */
  static async create(values, options) {
    options = cloneDeep(options) ?? {};
+    const association = this._searchInclude(values);
+    if (association.length > 0 && !options.include) {
+      options.include = association;


only call _searchInclude if options.include is not set, to avoid computing it if not necessary

The association.length > 0 check should not be necessary and can be removed

association should be plural, but entire code can be simplified to this:

options.include ??= getDefaultCreateInclude(this, values);

ephys · 2024-02-10T19:13:35Z

packages/core/src/model.js

@@ -1759,6 +1763,18 @@ ${associationOwner._getAssociationDebugList()}`);
    }).save(options);
  }

+  static _searchInclude(values) {
+    const association = [];
+    const associationKeys = Object.keys(this.associations);


Suggested change

const associationKeys = Object.keys(this.associations);

const associationNames = Object.keys(this.associations);

ephys · 2024-02-10T20:00:15Z

packages/core/src/model.js

+    const associationKeys = Object.keys(this.associations);
+    for (const value in values) {
+      if (associationKeys.includes(value)) {
+        association.push({ association: value });


Also I think you can just push value and that the { association } wrapper is redundant

sakupan102 · 2024-03-12T09:39:41Z

@ephys I made several corrections. This is ready to review.

WikiRik · 2024-03-13T14:30:58Z

Can you fix the prettier issue? We like to review PRs once CI has passed.

sakupan102 · 2024-03-13T17:15:05Z

@WikiRik @ephys fixed prettier issue. Could you please review this?

ephys

Thank you for your work on this

ephys · 2024-03-16T18:06:58Z

packages/core/src/model.js

@@ -1916,6 +1917,7 @@ ${associationOwner._getAssociationDebugList()}`);
   */
  static async create(values, options) {
    options = cloneDeep(options) ?? {};
+    options.include ??= getDefaultCreateInclude(this, values);


I think belongs inside of save when isNewRecord is true, because calling build then save should work too

ephys · 2024-03-16T18:07:31Z

packages/core/src/model-internals.ts

+export function getDefaultCreateInclude(model: ModelStatic, values: Object) {
+  const associations = [];
+  const associationNames = Object.keys(model.associations);
+  if (values) {


based on the typing, this condition is always true

ephys · 2024-03-16T18:07:37Z

packages/core/src/model-internals.ts

@@ -273,3 +273,17 @@ Either add a primary key to this model, or use one of the following alternatives
    );
  }
 }
+
+export function getDefaultCreateInclude(model: ModelStatic, values: Object) {


Suggested change

export function getDefaultCreateInclude(model: ModelStatic, values: Object) {

export function getDefaultCreateInclude(model: ModelStatic, values: UnknownRecord) {

ephys · 2024-03-16T18:08:00Z

packages/core/test/integration/model/create.test.js

@@ -1593,6 +1593,37 @@ describe(Support.getTestDialectTeaser('Model'), () => {
        });
      });
    });
+    it('should create associated objects without include option', async function () {
+      const Player = this.customSequelize.define('player', {


Suggested change

const Player = this.customSequelize.define('player', {

const Player = this.customSequelize.define('Player', {

ephys · 2024-03-16T18:08:07Z

packages/core/test/integration/model/create.test.js

+          type: DataTypes.INTEGER,
+        },
+      });
+      const Team = this.customSequelize.define('team', {


Suggested change

const Team = this.customSequelize.define('team', {

const Team = this.customSequelize.define('Team', {

ephys · 2024-03-16T18:08:14Z

packages/core/test/integration/model/create.test.js

+          type: DataTypes.STRING,
+        },
+      });
+      Player.team = Player.belongsTo(Team, {


Suggested change

Player.team = Player.belongsTo(Team, {

Player.belongsTo(Team, {

sakupan102 added 4 commits January 1, 2024 19:48

feat: Add a method to find keys of objects related to associations.

275c554

Merge branch 'main' into feature/remove-include-option

612e1a6

Add tests for model.create without 'include' option

cf9c7fa

Merge branch 'main' into feature/remove-include-option

83a3310

ephys requested changes Feb 10, 2024

View reviewed changes

ephys reviewed Feb 10, 2024

View reviewed changes

sakupan102 added 2 commits February 22, 2024 20:24

Move the function "searchInclude" to model-internals.ts

fe99ba6

Rename the function "searchInclude"

8663f07

sakupan102 requested a review from a team as a code owner February 22, 2024 11:26

ephys self-requested a review February 22, 2024 15:48

Merge branch 'main' into feature/remove-include-option

1b56469

sakupan102 requested a review from a team as a code owner March 13, 2024 11:27

sakupan102 requested a review from WikiRik March 13, 2024 11:27

fix: format

34727c7

ephys changed the title ~~feat: Remove the include option from Model.create~~ feat: make the include option of Model.create default to all provided associations Mar 16, 2024

ephys requested changes Mar 16, 2024

View reviewed changes

sequelize-bot bot added the conflicted This PR has merge conflicts and will not be present in the list of PRs to review label Apr 10, 2024

jacobmendoza mentioned this pull request Apr 12, 2024

Remove the include option from Model.create #15233

Open

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: make the `include` option of `Model.create` default to all provided associations #16922

feat: make the `include` option of `Model.create` default to all provided associations #16922

sakupan102 commented Jan 1, 2024 •

edited

ephys left a comment

ephys Feb 10, 2024

ephys Feb 10, 2024

ephys Feb 10, 2024

ephys Feb 10, 2024

ephys Feb 10, 2024

sakupan102 commented Mar 12, 2024

WikiRik commented Mar 13, 2024

sakupan102 commented Mar 13, 2024

ephys left a comment

ephys Mar 16, 2024

ephys Mar 16, 2024

ephys Mar 16, 2024

ephys Mar 16, 2024

ephys Mar 16, 2024

ephys Mar 16, 2024

	const associationKeys = Object.keys(this.associations);
	const associationNames = Object.keys(this.associations);

	export function getDefaultCreateInclude(model: ModelStatic, values: Object) {
	export function getDefaultCreateInclude(model: ModelStatic, values: UnknownRecord) {

	const Player = this.customSequelize.define('player', {
	const Player = this.customSequelize.define('Player', {

	const Team = this.customSequelize.define('team', {
	const Team = this.customSequelize.define('Team', {

	Player.team = Player.belongsTo(Team, {
	Player.belongsTo(Team, {

feat: make the include option of Model.create default to all provided associations #16922

Are you sure you want to change the base?

feat: make the include option of Model.create default to all provided associations #16922

Conversation

sakupan102 commented Jan 1, 2024 • edited

Pull Request Checklist

Description Of Change

Todos

ephys 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

sakupan102 commented Mar 12, 2024

WikiRik commented Mar 13, 2024

sakupan102 commented Mar 13, 2024

ephys 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

feat: make the `include` option of `Model.create` default to all provided associations #16922

feat: make the `include` option of `Model.create` default to all provided associations #16922

sakupan102 commented Jan 1, 2024 •

edited