Skip to content
This repository was archived by the owner on Mar 16, 2026. It is now read-only.

[FIX] Make required respect dependsOn on Relationship fields too #4685

Open
nicolas-guichard wants to merge 2 commits into
base: master
Choose a base branch
from
Open

[FIX] Make required respect dependsOn on Relationship fields too #4685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e27b7b
require and dependsOn in Relationships
Jun 26, 2018
ac13e25
test for dependsOn and require and Relationship
Jun 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions fields/types/relationship/RelationshipType.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ relationship.prototype.addToSchema = function (schema) {
var def = {
type: this._nativeType,
ref: this.options.ref,
index: (this.options.index ? true : false),
required: (this.options.required ? true : false),
unique: (this.options.unique ? true : false),
index: (this.options.index ? this.options.index : false),
Copy link
Copy Markdown
Contributor

@stennie stennie Jun 27, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The values for these 3 options (index, required, and unique) are either true or false and the conditional (ternary) should already be setting these correctly.

Can you clarify the motivation for changing these?

Copy link
Copy Markdown
Author

@nicolas-guichard nicolas-guichard Jun 27, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The desired values are not necessarily true or false, in the case described by keystonejs/keystone#2200, if dependsOn is set, this.option.required may actually be a function (see below), which is then used by Mongoose. I changed the three of them for consistency.

https://github.com/keystonejs/keystone/blob/d34f45662eb359e2cb18b397f2ffea21f9883141/fields/types/Type.js#L74

required: (this.options.required ? this.options.required : false),
unique: (this.options.unique ? this.options.unique : false),
};
this.paths = {
refList: this.options.refListPath || this.path + 'RefList',
Expand Down
1 change: 1 addition & 0 deletions test/models/DependsOn.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ DependsOn.add({
title: { type: String, required: true, default: '' },
state: { type: Types.Select, options: 'draft, published, archived', default: 'draft' },
publishedDate: { type: Types.Date, dependsOn: {state: 'published'}, required: true, initial: false },
relativeDependsOn: { type: Types.Relationship, ref: 'DependsOn', dependsOn: {state: 'published'}, required: true, initial: false },
});

DependsOn.register();
57 changes: 44 additions & 13 deletions test/unit/lib/list/dependsOn.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,24 @@ var DependsOn = keystone.list('DependsOn');
describe('Test dependsOn and required', function () {

it('Ignore required if evalDependsOn is not `true` by setting `state` to `draft`', function (done) {
// remove any Post documents
// remove any DependsOn documents
DependsOn.model.find({}).remove(function (error) {
if (error) {
done(error);
}

var newPost = new DependsOn.model({
var newDependsOn = new DependsOn.model({
Copy link
Copy Markdown
Contributor

@stennie stennie Jun 27, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be an arbitrary rename without changing any functionality for relationships.

Copy link
Copy Markdown
Author

@nicolas-guichard nicolas-guichard Jun 27, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, I should have done a separate commit for the renaming, which is there to clarify that this test does not use the Post model. The new test case is lines 58-84: it fails without commit 4e27b7b and passes with it.

title: 'new post',
state: 'draft'
});

newPost.save(done);
newDependsOn.save(done);

});
});



it('Save will fail if `state` set to `published` and `publishedDate` is not defined', function (done) {
// remove any Post documents
// remove any DependsOn documents
DependsOn.model.find({}).remove(function (error) {
if (error) {
done(error);
Expand All @@ -39,13 +37,43 @@ describe('Test dependsOn and required', function () {
const backupLog = console.error;
console.error = () => null;

var newPost = new DependsOn.model({
var newDependsOn = new DependsOn.model({
title: 'new post',
state: 'published',
publishedDate: undefined,
});

newDependsOn.relativeDependsOn = newDependsOn._id;

newDependsOn.save(function (err) {
demand(err).be.a.object();

console.error = backupLog;
done();
});
});

});

it('Save will fail if `state` set to `published` and `relativeDependsOn` is not defined', function (done) {
// remove any DependsOn documents
DependsOn.model.find({}).remove(function (error) {
if (error) {
done(error);
}

// suppressing console log output
const backupLog = console.error;
console.error = () => null;

var newDependsOn = new DependsOn.model({
title: 'new post',
state: 'published',
publishedDate: new Date(),
relativeDependsOn: undefined,
});

newPost.save(function (err) {
newDependsOn.save(function (err) {
demand(err).be.a.object();

console.error = backupLog;
Expand All @@ -55,20 +83,23 @@ describe('Test dependsOn and required', function () {

});

it('Save will succeed if `state` set to `published` and `publishedDate` is defined', function (done) {
it('Save will succeed if `state` set to `published` and `publishedDate` and `relativeDependsOn` are defined', function (done) {

// remove any Post documents
// remove any DependsOn documents
DependsOn.model.find({}).remove(function (error) {
if (error) {
done(error);
}

var newPost = new DependsOn.model({
var newDependsOn = new DependsOn.model({
title: 'new post',
state: 'published',
publishedDate: new Date()
publishedDate: new Date(),
});
newPost.save(done);

newDependsOn.relativeDependsOn = newDependsOn._id;

newDependsOn.save(done);

});
});
Expand Down