Required fields and default values #5835

davimacedo · 2019-07-22T07:46:10Z

This PR adds the capability for defining required fields and default values to the schema. For example:

         {
            className: 'NewClass',
            fields: {
              ACL: { type: 'ACL' },
              createdAt: { type: 'Date' },
              updatedAt: { type: 'Date' },
              objectId: { type: 'String' },
              newField: {
                type: 'String',
                required: true,
                defaultValue: 'some value',
              },
            },
         }

How it works:

When creating a new object, if the value of a field is not set, its default value is applied (in the case it has a default value). If the field turns out being null, undefined or empty string, and it is a required field, an error is thrown.
When updating an object, it a field is set to null, empty string or unset, and it is a required field, an error is thrown.

close #3587

codecov · 2019-07-22T08:35:00Z

Codecov Report

Merging #5835 into master will decrease coverage by 0.6%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #5835      +/-   ##
==========================================
- Coverage   93.75%   93.14%   -0.61%     
==========================================
  Files         148      150       +2     
  Lines       10304    10616     +312     
==========================================
+ Hits         9660     9888     +228     
- Misses        644      728      +84

Impacted Files	Coverage Δ
src/Adapters/Storage/Mongo/MongoStorageAdapter.js	`92.56% <100%> (+0.1%)`	⬆️
src/Controllers/SchemaController.js	`96.37% <100%> (-0.53%)`	⬇️
...rc/Adapters/Storage/Mongo/MongoSchemaCollection.js	`97.8% <100%> (+0.12%)`	⬆️
src/RestWrite.js	`93.72% <100%> (+0.04%)`	⬆️
...dapters/Cache/RedisCacheAdapter/KeyPromiseQueue.js	`0% <0%> (-95.46%)`	⬇️
src/Adapters/Cache/RedisCacheAdapter/index.js	`15.9% <0%> (-84.1%)`	⬇️
src/Adapters/Auth/apple.js	`89.65% <0%> (-10.35%)`	⬇️
src/Adapters/Auth/httpsRequest.js	`95.23% <0%> (-4.77%)`	⬇️
src/Controllers/LoggerController.js	`90.52% <0%> (-1.06%)`	⬇️
... and 15 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4fe0ff6...dd1d9a5. Read the comment docs.

dplewis

Thanks for getting started on this! I have a quick comment.

dplewis · 2019-07-24T15:25:15Z

src/Adapters/Storage/Mongo/MongoStorageAdapter.js

+      type,
+      targetClass,
+    });
+    if (fieldOptions && Object.keys(fieldOptions).length > 0) {


Can you add a test for setting required fields and defaults when you create a new class / new class schema?

done
https://github.com/parse-community/parse-server/pull/5835/files#diff-062f88bd150cc9bdbefd675f4267241cR409

dplewis · 2019-07-25T00:58:23Z

Are the default values validated? Can I set a number to a type String

davimacedo · 2019-07-25T01:25:33Z

@dplewis It is a good question. They aren't validated. I will work on this.

dplewis · 2019-07-25T14:16:18Z

The StorageAdapters should handle the validation for you no? Can you write a test for this?

davimacedo · 2019-07-25T16:27:06Z

No. I've written a test and it is not validating. I'm fixing it and should push new commits by the end of the day.

davimacedo · 2019-07-25T22:47:23Z

@dplewis it is now validating. Can you please take a look again? Note that I also fixed a bug. Currently, when the addClassIfNotExists is called, any validation error (for example, invalid class name) are returned in a wrong format (not a Parse.Error). As a result, the API is returning Internal Server Error instead of the right codes and messages.

dplewis · 2019-07-25T22:53:39Z

How would this work with beforeSave trigger? I think you should be good as it looks like changes made in a beforeSave would override default values.

davimacedo · 2019-07-25T22:58:14Z

I think that the beforeSave trigger run before the validations and default assignments. So, if you set something in beforeSave, it will stay. On the other hand, if you set a required field to null in the beforeSave trigger, it will set the default value or return an error in the case it is a required field. This is the behavior I planned and I think it's consistent. Do you agree? I will add some tests to check.

…use of unset in the beforeSave trigger

davimacedo · 2019-07-25T23:36:36Z

@dplewis Added some tests for beforeSave trigger and fixed a bug. The default value was not applied if you unset in beforeSave.

joaovqm1 · 2019-07-26T12:46:43Z

That will help me a lot. Thanks @davimacedo.

A little suggestion for later: the strings fields should have a uppercase or lowercase option to automatically converts it. What do you think?

davimacedo · 2019-07-26T16:22:30Z

@joaovq there is a lot of things that we can still do here, as regular expression validation, formatted output (I think the lowercase/uppercase scenario goes here), etc. I will probably try to address some of these features in the future. But each of these features requires a lot of work not only in the Parse Server side, but also in docs, Parse Dashboard, and SDK. So, any help here would be very appreciated. Would you be able to tackle some of these tasks?

joaovqm1 · 2019-07-26T21:29:40Z

I agree with you. It's really a lot to do and time flies. I had to a lot of things on my own to overcome some obstacles that I had so I think I would be able to tackle some of these if a short deadline is not required. Em sex, 26 de jul de 2019 às 13:23, Antonio Davi Macedo Coelho de Castro < [email protected]> escreveu:

…

@joaovq <https://github.com/joaovq> there is a lot of things that we can still do here, as regular expression validation, formatted output (I think the lowercase/uppercase scenario goes here), etc. I will probably try to address some of these features in the future. But each of these features requires a lot of work not only in the Parse Server side, but also in docs, Parse Dashboard, and SDK. So, any help here would be very appreciated. Would you be able to tackle some of these tasks? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#5835?email_source=notifications&email_token=ABJGV4TJ4VKNLVA3I2NF5OTQBMQGNA5CNFSM4IFVYO7KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD25CJ7Y#issuecomment-515515647>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABJGV4V47VQZVKKZ3TLA263QBMQGNANCNFSM4IFVYO7A> .

davimacedo · 2019-07-26T22:19:09Z

That's nice @joaovq . There is no short deadline. Any effort that you can put to help on this is very welcome!

joaovqm1 · 2019-07-27T14:59:40Z

Well then I'm in. What do I have to do to start? I've never did this before. Em sex, 26 de jul de 2019 às 19:19, Antonio Davi Macedo Coelho de Castro < [email protected]> escreveu:

…

That's nice @joaovq <https://github.com/joaovq> . There is no short deadline. Any effort that you can put to help on this is very welcome! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#5835?email_source=notifications&email_token=ABJGV4QL4Y6FF2TARXJ7MODQBNZ7VA5CNFSM4IFVYO7KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD2522YQ#issuecomment-515616098>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABJGV4WHY5NRWFE6Q2NA53LQBNZ7VANCNFSM4IFVYO7A> .

davimacedo · 2019-07-29T05:04:40Z

@joaovq

Here it goes few things that I see as next steps:

Add the required and defaultValue options in the dashboard when creating a new column - I think @alencarlucas is already working on this
Improve GraphQL server to use required and defaultValue options when generating the schema - I will probably tackle this soon
Modify the docs explaining about these new options
Include in Parse Server the possibility of changing these settings (currently it is not possible to modify a schema field)
Include in Parse Dashboard the option to modify a schema field

Then we should do similar steps for each new option we want to include in a schema field.

What do you think? If you agree with this plan I can open a project with these tasks so we can keep track of what we have already done.

joaovqm1 · 2019-07-30T09:41:09Z

Nice. I agree with it. You can open the project Do you wanna know what I want to do? Or can I do it and then tell to you? Em seg, 29 de jul de 2019 às 02:05, Antonio Davi Macedo Coelho de Castro < [email protected]> escreveu:

…

@joaovq <https://github.com/joaovq> Here it goes few things that I see as next steps: - Add the required and defaultValue options in the dashboard when creating a new column - I think @alencarlucas <https://github.com/alencarlucas> is already working on this - Improve GraphQL server to use required and defaultValue options when generating the schema - I will probably tackle this soon - Modify the docs explaining about these new options - Include in Parse Server the possibility of changing these settings (currently it is not possible to modify a schema field) - Include in Parse Dashboard the option to modify a schema field Then we should do similar steps for each new option we want to include in a schema field. What do you think? If you agree with this plan I can open a project with these tasks so we can keep track of what we have already done. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#5835?email_source=notifications&email_token=ABJGV4WPWTPDFW47CQEVWTLQBZ3ANA5CNFSM4IFVYO7KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD27S5HQ#issuecomment-515845790>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABJGV4TQPSYVFUSURHYQUX3QBZ3ANANCNFSM4IFVYO7A> .

davimacedo · 2019-07-30T21:45:47Z

Here is the project: https://github.com/parse-community/parse-server/projects/7

Feel free to just do whatever task you want and send the PR, then some of the maintainers will review. But, you might want to move the task you are working on, so it will avoid other developer working in the same issue.

Thanks for your help!

joaovqm1 · 2019-07-31T00:34:13Z

Nice. I will fork the project and take a look at it. I guess I should see the changes you made to figure out that part of the code, otherwise I'll be completely lost. What do you think? As soon as I get the idea I'll start. Em ter, 30 de jul de 2019 às 18:46, Antonio Davi Macedo Coelho de Castro < [email protected]> escreveu:

…

Here is the project: https://github.com/parse-community/parse-server/projects/7 Feel free to just do whatever task you want and send the PR, then some of the maintainers will review. But, you might want to move the task you are working on, so it will avoid other developer working in the same issue. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#5835?email_source=notifications&email_token=ABJGV4SOGLFDH6U5UYNXXSTQCCZCVA5CNFSM4IFVYO7KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD3FNBZA#issuecomment-516608228>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABJGV4V5FHAVO36MHBP3DDDQCCZCVANCNFSM4IFVYO7A> .

davimacedo · 2019-07-31T00:38:19Z

Sure. That's a good way to get started. Also let me know if you have any question.

joaovqm1 · 2019-07-31T13:51:31Z

Ok, I probably will haha. Thank you Em ter, 30 de jul de 2019 às 21:38, Antonio Davi Macedo Coelho de Castro < [email protected]> escreveu:

…

Sure. That's a good way to get started. Also let me know if you have any question. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#5835?email_source=notifications&email_token=ABJGV4VILKXJDDZPOOTGYPDQCDNJVA5CNFSM4IFVYO7KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD3FWUQA#issuecomment-516647488>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABJGV4WGFUF64JZPUUZ4V2TQCDNJVANCNFSM4IFVYO7A> .

JeromeDeLeon · 2019-08-21T15:54:11Z

Just wanted to ask if this change will be included in the parse-dashboard?

alencarlucas · 2019-08-21T16:32:53Z

@JeromeDeLeon It's already included, take a look in this PR.

JeromeDeLeon · 2019-08-22T13:19:47Z

How about parse-js-sdk?

davimacedo · 2019-08-22T18:16:09Z

What do you have in mind for the JS SDK?

JeromeDeLeon · 2019-08-23T13:26:12Z

Nah, nvm. I just thought of it but then I realized that using parse-dashboard is fine.

santiagosemhan · 2019-09-05T00:16:54Z

Is this feature documented yet?

@davimacedo

Closes: #930 Requires Parse Server 3.7.0+ Feature: parse-community/parse-server#5835 I added a FieldOption to addField and its counter parts. This will allow for future options like uppercase / lowercase for example. I keep getting a schema mismatch when I use dates and pointers. @davimacedo Maybe you know why?

@davimacedo

* Parse.Schema required fields and defaultValues Closes: #930 Requires Parse Server 3.7.0+ Feature: parse-community/parse-server#5835 I added a FieldOption to addField and its counter parts. This will allow for future options like uppercase / lowercase for example. I keep getting a schema mismatch when I use dates and pointers. @davimacedo Maybe you know why? * improve coverage * fix date and pointer fields * print tests * fix utc date test * Documentation * nit test

* Add field options to mongo schema metadata * Add/fix test with fields options * Add required validation failing test * Add more tests * Only set default value if field is undefined * Fix redis test * Fix tests * Test for creating a new class with field options * Validate default value type * fix lint (weird) * Fix lint another way * Add tests for beforeSave trigger and solve small issue regarding the use of unset in the beforeSave trigger

rasool1994 · 2020-05-29T19:46:28Z

and who can I remove the required flag from the field without data loss?

bahaa-kallas · 2021-02-01T23:24:02Z

@rasool1994 You can remove it from the database without any data loss. Just connect to your mongoDB instance and go to SCHEMA collection see example below:

 "_id" : "PostCategory", 
    "objectId" : "string", 
    "updatedAt" : "date", 
    "createdAt" : "date", 
    "_metadata" : {
        "fields_options" : {
            "arName" : {
                "required" : true
            }, 
            "enName" : {
                "required" : true
            }, 
            "channelName" : {
                "required" : false
            }
        },

davimacedo added 6 commits July 21, 2019 22:48

Add field options to mongo schema metadata

15969e4

Add/fix test with fields options

bbebcf7

Add required validation failing test

984ddbc

Add more tests

9ad0387

Only set default value if field is undefined

84033fb

Fix redis test

39e0e81

davimacedo requested a review from dplewis July 22, 2019 08:36

Fix tests

fa0dbbb

dplewis suggested changes Jul 24, 2019

View reviewed changes

Merge branch 'upstream' into requiredFields

f38fa81

Test for creating a new class with field options

c0f373d

davimacedo requested a review from dplewis July 25, 2019 01:23

Validate default value type

39780a3

fix lint (weird)

82006d9

davimacedo added 2 commits July 25, 2019 16:06

Fix lint another way

d8d6144

Add tests for beforeSave trigger and solve small issue regarding the …

dd1d9a5

…use of unset in the beforeSave trigger

dplewis approved these changes Jul 26, 2019

View reviewed changes

davimacedo merged commit fd637ff into parse-community:master Jul 26, 2019

alencarlucas mentioned this pull request Jul 30, 2019

feat: Add required and default value options parse-community/parse-dashboard#1193

Merged

dplewis mentioned this pull request Oct 16, 2019

Parse.Schema required fields and defaultValues parse-community/Parse-SDK-JS#961

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Required fields and default values #5835

Required fields and default values #5835

davimacedo commented Jul 22, 2019

codecov bot commented Jul 22, 2019 •

edited

Loading

dplewis left a comment

dplewis Jul 24, 2019

davimacedo Jul 25, 2019

dplewis commented Jul 25, 2019

davimacedo commented Jul 25, 2019

dplewis commented Jul 25, 2019

davimacedo commented Jul 25, 2019

davimacedo commented Jul 25, 2019

dplewis commented Jul 25, 2019

davimacedo commented Jul 25, 2019

davimacedo commented Jul 25, 2019

joaovqm1 commented Jul 26, 2019

davimacedo commented Jul 26, 2019

joaovqm1 commented Jul 26, 2019 via email

davimacedo commented Jul 26, 2019

joaovqm1 commented Jul 27, 2019 via email

davimacedo commented Jul 29, 2019

joaovqm1 commented Jul 30, 2019 via email

davimacedo commented Jul 30, 2019 •

edited

Loading

joaovqm1 commented Jul 31, 2019 via email

davimacedo commented Jul 31, 2019

joaovqm1 commented Jul 31, 2019 via email

JeromeDeLeon commented Aug 21, 2019

alencarlucas commented Aug 21, 2019

JeromeDeLeon commented Aug 22, 2019

davimacedo commented Aug 22, 2019

JeromeDeLeon commented Aug 23, 2019

santiagosemhan commented Sep 5, 2019

rasool1994 commented May 29, 2020

bahaa-kallas commented Feb 1, 2021

Required fields and default values #5835

Required fields and default values #5835

Conversation

davimacedo commented Jul 22, 2019

codecov bot commented Jul 22, 2019 • edited Loading

Codecov Report

dplewis left a comment

Choose a reason for hiding this comment

dplewis Jul 24, 2019

Choose a reason for hiding this comment

davimacedo Jul 25, 2019

Choose a reason for hiding this comment

dplewis commented Jul 25, 2019

davimacedo commented Jul 25, 2019

dplewis commented Jul 25, 2019

davimacedo commented Jul 25, 2019

davimacedo commented Jul 25, 2019

dplewis commented Jul 25, 2019

davimacedo commented Jul 25, 2019

davimacedo commented Jul 25, 2019

joaovqm1 commented Jul 26, 2019

davimacedo commented Jul 26, 2019

joaovqm1 commented Jul 26, 2019 via email

davimacedo commented Jul 26, 2019

joaovqm1 commented Jul 27, 2019 via email

davimacedo commented Jul 29, 2019

joaovqm1 commented Jul 30, 2019 via email

davimacedo commented Jul 30, 2019 • edited Loading

joaovqm1 commented Jul 31, 2019 via email

davimacedo commented Jul 31, 2019

joaovqm1 commented Jul 31, 2019 via email

JeromeDeLeon commented Aug 21, 2019

alencarlucas commented Aug 21, 2019

JeromeDeLeon commented Aug 22, 2019

davimacedo commented Aug 22, 2019

JeromeDeLeon commented Aug 23, 2019

santiagosemhan commented Sep 5, 2019

rasool1994 commented May 29, 2020

bahaa-kallas commented Feb 1, 2021

codecov bot commented Jul 22, 2019 •

edited

Loading

davimacedo commented Jul 30, 2019 •

edited

Loading