-
Notifications
You must be signed in to change notification settings - Fork 937
Add FieldValue methods to the Lite SDK #3135
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
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
a957d31
Add FieldValue methods to the Lite SDK
schmidt-sebastian 6a29c6e
Try to reduce code size
schmidt-sebastian 7ce99ba
Add ()
schmidt-sebastian fe34ecb
Update index.node.ts
schmidt-sebastian c9589ed
Add tests
schmidt-sebastian 5297799
Merge branch 'mrschmidt/fieldvalue' of github.com:firebase/firebase-j…
schmidt-sebastian 6121239
Review
schmidt-sebastian d1727da
Fix test
schmidt-sebastian 7862dc4
Lint
schmidt-sebastian File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
/** | ||
* @license | ||
* Copyright 2020 Google LLC | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
import * as firestore from '../../'; | ||
|
||
import { validateAtLeastNumberOfArgs } from '../../../src/util/input_validation'; | ||
import { | ||
ArrayRemoveFieldValueImpl, | ||
ArrayUnionFieldValueImpl, | ||
DeleteFieldValueImpl, | ||
NumericIncrementFieldValueImpl, | ||
SerializableFieldValue, | ||
ServerTimestampFieldValueImpl | ||
} from '../../../src/api/field_value'; | ||
import { ParseContext } from '../../../src/api/user_data_reader'; | ||
import { FieldTransform } from '../../../src/model/mutation'; | ||
|
||
/** The public FieldValue class of the lite API. */ | ||
export abstract class FieldValue extends SerializableFieldValue | ||
implements firestore.FieldValue {} | ||
|
||
/** | ||
* A delegate class that allows the FieldValue implementations returned by | ||
* deleteField(), serverTimestamp(), arrayUnion(), arrayRemove() and | ||
* increment() to be an instance of the lite FieldValue class declared above. | ||
* | ||
* We don't directly subclass `FieldValue` in the various field value | ||
* implementations as the base FieldValue class differs between the lite, full | ||
* and legacy SDK. | ||
*/ | ||
class FieldValueDelegate extends FieldValue implements firestore.FieldValue { | ||
readonly _methodName: string; | ||
|
||
constructor(readonly _delegate: SerializableFieldValue) { | ||
super(); | ||
this._methodName = _delegate._methodName; | ||
} | ||
|
||
_toFieldTransform(context: ParseContext): FieldTransform | null { | ||
return this._delegate._toFieldTransform(context); | ||
} | ||
|
||
isEqual(other: firestore.FieldValue): boolean { | ||
if (!(other instanceof FieldValueDelegate)) { | ||
return false; | ||
} | ||
return this._delegate.isEqual(other._delegate); | ||
} | ||
} | ||
|
||
export function deleteField(): firestore.FieldValue { | ||
return new FieldValueDelegate(new DeleteFieldValueImpl('delete')); | ||
} | ||
|
||
export function serverTimestamp(): firestore.FieldValue { | ||
return new FieldValueDelegate( | ||
new ServerTimestampFieldValueImpl('serverTimestamp') | ||
); | ||
} | ||
|
||
export function arrayUnion(...elements: unknown[]): firestore.FieldValue { | ||
validateAtLeastNumberOfArgs('arrayUnion()', arguments, 1); | ||
// NOTE: We don't actually parse the data until it's used in set() or | ||
// update() since we'd need the Firestore instance to do this. | ||
return new FieldValueDelegate( | ||
new ArrayUnionFieldValueImpl('arrayUnion', elements) | ||
); | ||
} | ||
|
||
export function arrayRemove(...elements: unknown[]): firestore.FieldValue { | ||
validateAtLeastNumberOfArgs('arrayRemove()', arguments, 1); | ||
// NOTE: We don't actually parse the data until it's used in set() or | ||
// update() since we'd need the Firestore instance to do this. | ||
return new FieldValueDelegate( | ||
new ArrayRemoveFieldValueImpl('arrayRemove', elements) | ||
); | ||
} | ||
|
||
export function increment(n: number): firestore.FieldValue { | ||
return new FieldValueDelegate( | ||
new NumericIncrementFieldValueImpl('increment', n) | ||
); | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a test case to exercise the
if (!(other instanceof FieldValueDelegate))
block ofisEqual()
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added TODO to do this when documentId() is merged into master.