Rejecting custom types from the API surface #137
Conversation
ghost
added
the
cla: yes
schmidt-sebastian
force-pushed
the
nonplaintypes
branch
from
820986f to
5953eac
Compare
schmidt-sebastian
changed the title
Codecov Report
@@ Coverage Diff @@
## master #137 +/- ##
==========================================
- Coverage 100% 99.94% -0.06%
==========================================
Files 12 12
Lines 1668 1689 +21
==========================================
+ Hits 1668 1688 +20
- Misses 0 1 +1
Continue to review full report at Codecov.
|
src/document.js
Outdated
| options.allowDeletes === 'none' | ||
| ) { | ||
| throw new Error( | ||
| 'Deletes must appear at the top-level and can only be used in update() or set() with {merge:true}.' |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
src/document.js
Outdated
| } else if (obj === FieldValue.SERVER_TIMESTAMP_SENTINEL) { | ||
| if (!options.allowServerTimestamps) { | ||
| throw new Error( | ||
| 'ServerTimestamps can only be used in update(), set() and create().' |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
src/document.js
Outdated
| Object.prototype.toString.call(val) + | ||
| ') to a Firestore Value' | ||
| ); | ||
| validate.throwCustomObjectError(val); |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
src/path.js
Outdated
| @@ -484,7 +484,7 @@ class FieldPath extends Path { | |||
| static validateFieldPath(fieldPath) { | |||
| if (!is.instanceof(fieldPath, FieldPath)) { | |||
| if (!is.string(fieldPath)) { | |||
| throw new Error(`Paths must be strings or FieldPath objects.`); | |||
| validate.throwCustomObjectError(fieldPath); | |||
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
ghost
removed
the
cla: yes
This cleans up our error handling for field values and adds better error messages for users that use types from other instances of the Firestore SDK.
As part of this (to get to 100% coverage), I re-added the test that transforms allPlainTypesObject into allPlainTypesProtobufJs. Along with the changes for #105, this meant adding support for missing (empty) array and object values.