Skip to content

Provide document path context for input validation errors. #3189

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.

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
Jun 24, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
16 changes: 13 additions & 3 deletions packages/firestore/lite/src/api/reference.ts
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,12 @@ export function setDoc<T>(
ref.firestore._settings!
);

const parsed = dataReader.parseSetData('setDoc', convertedValue, options);
const parsed = dataReader.parseSetData(
'setDoc',
ref._key,
convertedValue,
options
);

return configureClient.then(datastore =>
invokeCommitRpc(
Expand Down Expand Up @@ -349,12 +354,17 @@ export function updateDoc(
) {
parsed = dataReader.parseUpdateVarargs(
'updateDoc',
ref._key,
fieldOrUpdateData,
value,
moreFieldsAndValues
);
} else {
parsed = dataReader.parseUpdateData('updateDoc', fieldOrUpdateData);
parsed = dataReader.parseUpdateData(
'updateDoc',
ref._key,
fieldOrUpdateData
);
}

return configureClient.then(datastore =>
Expand Down Expand Up @@ -406,7 +416,7 @@ export function addDoc<T>(
collRef.firestore._databaseId,
collRef.firestore._settings!
);
const parsed = dataReader.parseSetData('addDoc', convertedValue);
const parsed = dataReader.parseSetData('addDoc', docRef._key, convertedValue);

return configureClient
.then(datastore =>
Expand Down
3 changes: 3 additions & 0 deletions packages/firestore/lite/src/api/transaction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ export class Transaction implements firestore.Transaction {
);
const parsed = this._dataReader.parseSetData(
'Transaction.set',
ref._key,
convertedValue,
options
);
Expand Down Expand Up @@ -140,13 +141,15 @@ export class Transaction implements firestore.Transaction {
) {
parsed = this._dataReader.parseUpdateVarargs(
'Transaction.update',
ref._key,
fieldOrUpdateData,
value,
moreFieldsAndValues
);
} else {
parsed = this._dataReader.parseUpdateData(
'Transaction.update',
ref._key,
fieldOrUpdateData
);
}
Expand Down
3 changes: 3 additions & 0 deletions packages/firestore/lite/src/api/write_batch.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ export class WriteBatch implements firestore.WriteBatch {

const parsed = this._dataReader.parseSetData(
'WriteBatch.set',
ref._key,
convertedValue,
options
);
Expand Down Expand Up @@ -109,13 +110,15 @@ export class WriteBatch implements firestore.WriteBatch {
) {
parsed = this._dataReader.parseUpdateVarargs(
'WriteBatch.update',
ref._key,
fieldOrUpdateData,
value,
moreFieldsAndValues
);
} else {
parsed = this._dataReader.parseUpdateData(
'WriteBatch.update',
ref._key,
fieldOrUpdateData
);
}
Expand Down
13 changes: 12 additions & 1 deletion packages/firestore/src/api/database.ts
Original file line number Diff line number Diff line change
Expand Up @@ -738,6 +738,7 @@ export class Transaction implements firestore.Transaction {
);
const parsed = this._firestore._dataReader.parseSetData(
functionName,
ref._key,
convertedValue,
options
);
Expand Down Expand Up @@ -776,6 +777,7 @@ export class Transaction implements firestore.Transaction {
);
parsed = this._firestore._dataReader.parseUpdateVarargs(
'Transaction.update',
ref._key,
fieldOrUpdateData,
value,
moreFieldsAndValues
Expand All @@ -789,6 +791,7 @@ export class Transaction implements firestore.Transaction {
);
parsed = this._firestore._dataReader.parseUpdateData(
'Transaction.update',
ref._key,
fieldOrUpdateData
);
}
Expand Down Expand Up @@ -835,6 +838,7 @@ export class WriteBatch implements firestore.WriteBatch {
);
const parsed = this._firestore._dataReader.parseSetData(
functionName,
ref._key,
convertedValue,
options
);
Expand Down Expand Up @@ -877,6 +881,7 @@ export class WriteBatch implements firestore.WriteBatch {
);
parsed = this._firestore._dataReader.parseUpdateVarargs(
'WriteBatch.update',
ref._key,
fieldOrUpdateData,
value,
moreFieldsAndValues
Expand All @@ -890,6 +895,7 @@ export class WriteBatch implements firestore.WriteBatch {
);
parsed = this._firestore._dataReader.parseUpdateData(
'WriteBatch.update',
ref._key,
fieldOrUpdateData
);
}
Expand Down Expand Up @@ -1029,6 +1035,7 @@ export class DocumentReference<T = firestore.DocumentData>
);
const parsed = this.firestore._dataReader.parseSetData(
functionName,
this._key,
convertedValue,
options
);
Expand Down Expand Up @@ -1057,6 +1064,7 @@ export class DocumentReference<T = firestore.DocumentData>
validateAtLeastNumberOfArgs('DocumentReference.update', arguments, 2);
parsed = this.firestore._dataReader.parseUpdateVarargs(
'DocumentReference.update',
this._key,
fieldOrUpdateData,
value,
moreFieldsAndValues
Expand All @@ -1065,6 +1073,7 @@ export class DocumentReference<T = firestore.DocumentData>
validateExactNumberOfArgs('DocumentReference.update', arguments, 1);
parsed = this.firestore._dataReader.parseUpdateData(
'DocumentReference.update',
this._key,
fieldOrUpdateData
);
}
Expand Down Expand Up @@ -1369,7 +1378,9 @@ export class DocumentSnapshot<T = firestore.DocumentData>
if (this._document) {
const value = this._document
.data()
.field(fieldPathFromArgument('DocumentSnapshot.get', fieldPath));
.field(
fieldPathFromArgument('DocumentSnapshot.get', fieldPath, this._key)
);
if (value !== null) {
const userDataWriter = new UserDataWriter(
this._firestore._databaseId,
Expand Down
78 changes: 46 additions & 32 deletions packages/firestore/src/api/field_value.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,40 @@ export class DeleteFieldValueImpl extends SerializableFieldValue {
}
}

/**
* Creates a child context for parsing SerializableFieldValues.
*
* This is different than calling `ParseContext.contextWith` because it keeps
* the fieldTransforms and fieldMask separate.
*
* The created context has its `dataSource` set to `UserDataSource.Argument`.
* Although these values are used with writes, any elements in these FieldValues
* are not considered writes since they cannot contain any FieldValue sentinels,
* etc.
*
* @param fieldValue The sentinel FieldValue for which to create a child
* context.
* @param context The parent context.
* @param arrayElement Whether or not the FieldValue has an array.
*/
function createSentinelChildContext(
fieldValue: SerializableFieldValue,
context: ParseContext,
arrayElement: boolean
): ParseContext {
return new ParseContext(
{
dataSource: UserDataSource.Argument,
targetDoc: context.settings.targetDoc,
methodName: fieldValue._methodName,
arrayElement
},
context.databaseId,
context.serializer,
context.ignoreUndefinedProperties
);
}

export class ServerTimestampFieldValueImpl extends SerializableFieldValue {
constructor(readonly _methodName: string) {
super();
Expand All @@ -106,18 +140,10 @@ export class ArrayUnionFieldValueImpl extends SerializableFieldValue {
}

_toFieldTransform(context: ParseContext): FieldTransform {
// Although array transforms are used with writes, the actual elements
// being uniomed or removed are not considered writes since they cannot
// contain any FieldValue sentinels, etc.
const parseContext = new ParseContext(
{
dataSource: UserDataSource.Argument,
methodName: this._methodName,
arrayElement: true
},
context.databaseId,
context.serializer,
context.ignoreUndefinedProperties
const parseContext = createSentinelChildContext(
this,
context,
/*array=*/ true
);
const parsedElements = this._elements.map(
element => parseData(element, parseContext)!
Expand All @@ -138,18 +164,10 @@ export class ArrayRemoveFieldValueImpl extends SerializableFieldValue {
}

_toFieldTransform(context: ParseContext): FieldTransform {
// Although array transforms are used with writes, the actual elements
// being unioned or removed are not considered writes since they cannot
// contain any FieldValue sentinels, etc.
const parseContext = new ParseContext(
{
dataSource: UserDataSource.Argument,
methodName: this._methodName,
arrayElement: true
},
context.databaseId,
context.serializer,
context.ignoreUndefinedProperties
const parseContext = createSentinelChildContext(
this,
context,
/*array=*/ true
);
const parsedElements = this._elements.map(
element => parseData(element, parseContext)!
Expand All @@ -170,14 +188,10 @@ export class NumericIncrementFieldValueImpl extends SerializableFieldValue {
}

_toFieldTransform(context: ParseContext): FieldTransform {
const parseContext = new ParseContext(
{
dataSource: UserDataSource.Argument,
methodName: this._methodName
},
context.databaseId,
context.serializer,
context.ignoreUndefinedProperties
const parseContext = createSentinelChildContext(
this,
context,
/*array=*/ false
);
const operand = parseData(this._operand, parseContext)!;
const numericIncrement = new NumericIncrementTransformOperation(
Expand Down
Loading