Skip to content

feat: Avoid setting a relation as required or with a defaultValue #5922

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 21, 2019
Merged

feat: Avoid setting a relation as required or with a defaultValue #5922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b2ff2e8
feat: Avoid setting a relation as required or with a defaultValue
alencarlucas Aug 15, 2019
d2a2909
chore: Test to update a class with a relation field with options
alencarlucas Aug 20, 2019
2a36dc5
Merge remote-tracking branch 'upstream/master' into default-required-…
alencarlucas Aug 20, 2019
e14dcce
chore: Improve tests
alencarlucas Aug 20, 2019
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
100 changes: 100 additions & 0 deletions spec/schemas.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,7 @@ describe('schemas', () => {
defaultValue: false,
},
defaultZero: { type: 'Number', defaultValue: 0 },
relation: { type: 'Relation', targetClass: 'SomeClass' }
},
},
}).then(async response => {
Expand All @@ -457,6 +458,7 @@ describe('schemas', () => {
defaultValue: false,
},
defaultZero: { type: 'Number', defaultValue: 0 },
relation: { type: 'Relation', targetClass: 'SomeClass' }
},
classLevelPermissions: defaultClassLevelPermissions,
});
Expand All @@ -479,10 +481,108 @@ describe('schemas', () => {
expect(obj.get('defaultFalse')).toEqual(false);
expect(obj.get('defaultZero')).toEqual(0);
expect(obj.get('ptr')).toBeUndefined();
expect(obj.get('relation')).toBeUndefined();
done();
});
});

it('try to set a relation field as a required field', async (done) => {
try {
await request({
url: 'http://localhost:8378/1/schemas',
method: 'POST',
headers: masterKeyHeaders,
json: true,
body: {
className: 'NewClassWithRelationRequired',
fields: {
foo: { type: 'String' },
relation: { type: 'Relation', targetClass: 'SomeClass', required: true }
},
},
});
fail('should fail');
} catch (e) {
expect(e.data.code).toEqual(111);
}
done();
});

it('try to set a relation field with a default value', async (done) => {
try {
await request({
url: 'http://localhost:8378/1/schemas',
method: 'POST',
headers: masterKeyHeaders,
json: true,
body: {
className: 'NewClassRelationWithOptions',
fields: {
foo: { type: 'String' },
relation: { type: 'Relation', targetClass: 'SomeClass', defaultValue: { __type: 'Relation', className: '_User' } }
},
},
});
fail('should fail');
} catch (e) {
expect(e.data.code).toEqual(111);
}
done();
});

it('try to update schemas with a relation field with options', async (done) => {
await request({
url: 'http://localhost:8378/1/schemas',
method: 'POST',
headers: masterKeyHeaders,
json: true,
body: {
className: 'NewClassRelationWithOptions',
fields: {
foo: { type: 'String' }
},
},
});
try {
await request({
url: 'http://localhost:8378/1/schemas/NewClassRelationWithOptions',
method: 'POST',
headers: masterKeyHeaders,
json: true,
body: {
className: 'NewClassRelationWithOptions',
fields: {
relation: { type: 'Relation', targetClass: 'SomeClass', required: true }
},
_method: "PUT"
}
});
fail('should fail');
} catch (e) {
expect(e.data.code).toEqual(111);
}

try {
await request({
url: 'http://localhost:8378/1/schemas/NewClassRelationWithOptions',
method: 'POST',
headers: masterKeyHeaders,
json: true,
body: {
className: 'NewClassRelationWithOptions',
fields: {
relation: { type: 'Relation', targetClass: 'SomeClass', defaultValue: { __type: 'Relation', className: '_User' } }
},
_method: "PUT"
}
});
fail('should fail');
} catch (e) {
expect(e.data.code).toEqual(111);
}
done();
});

it('validated the data type of default values when creating a new class', async () => {
try {
await request({
Expand Down
24 changes: 18 additions & 6 deletions src/Controllers/SchemaController.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -898,22 +898,34 @@ export default class SchemaController {
error: 'field ' + fieldName + ' cannot be added',
};
}
const type = fields[fieldName];
const error = fieldTypeIsInvalid(type);
const fieldType = fields[fieldName];
const error = fieldTypeIsInvalid(fieldType);
if (error) return { code: error.code, error: error.message };
if (type.defaultValue !== undefined) {
let defaultValueType = getType(type.defaultValue);
if (fieldType.defaultValue !== undefined) {
let defaultValueType = getType(fieldType.defaultValue);
if (typeof defaultValueType === 'string') {
defaultValueType = { type: defaultValueType };
} else if (typeof defaultValueType === 'object' && fieldType.type === 'Relation') {
return {
code: Parse.Error.INCORRECT_TYPE,
error: `The 'default value' option is not applicable for ${typeToString(fieldType)}`
};
}
if (!dbTypeMatchesObjectType(type, defaultValueType)) {
if (!dbTypeMatchesObjectType(fieldType, defaultValueType)) {
return {
code: Parse.Error.INCORRECT_TYPE,
error: `schema mismatch for ${className}.${fieldName} default value; expected ${typeToString(
type
fieldType
)} but got ${typeToString(defaultValueType)}`,
};
}
} else if (fieldType.required) {
if (typeof fieldType === 'object' && fieldType.type === 'Relation') {
return {
code: Parse.Error.INCORRECT_TYPE,
error: `The 'required' option is not applicable for ${typeToString(fieldType)}`
};
}
}
}
}
Expand Down