Skip to content

Update isEqual for arrayUnion, arrayRemove, and increment #7861

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 3 commits into from
Dec 14, 2023
Merged

Update isEqual for arrayUnion, arrayRemove, and increment #7861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
865dfe3
update isEquals
milaGGL Dec 12, 2023
b4284ef
Update integration.test.ts
milaGGL Dec 12, 2023
0f64eeb
add changeset
milaGGL Dec 12, 2023
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
6 changes: 6 additions & 0 deletions .changeset/yellow-houses-happen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@firebase/firestore': patch
'firebase': patch
---

Update the `isEqual` function for arrayUnion, arrayRemove and increment.
22 changes: 14 additions & 8 deletions packages/firestore/src/lite-api/user_data_reader.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
FieldPath as PublicFieldPath,
SetOptions
} from '@firebase/firestore-types';
import { Compat, getModularInstance } from '@firebase/util';
import { Compat, deepEqual, getModularInstance } from '@firebase/util';

import { ParseContext } from '../api/parse_context';
import { DatabaseId } from '../core/database_info';
Expand Down Expand Up @@ -525,13 +525,15 @@ export class ArrayUnionFieldValueImpl extends FieldValue {
}

isEqual(other: FieldValue): boolean {
// TODO(mrschmidt): Implement isEquals
return this === other;
return (
other instanceof ArrayUnionFieldValueImpl &&
deepEqual(this._elements, other._elements)
);
}
}

export class ArrayRemoveFieldValueImpl extends FieldValue {
constructor(methodName: string, readonly _elements: unknown[]) {
constructor(methodName: string, private readonly _elements: unknown[]) {
super(methodName);
}

Expand All @@ -549,8 +551,10 @@ export class ArrayRemoveFieldValueImpl extends FieldValue {
}

isEqual(other: FieldValue): boolean {
// TODO(mrschmidt): Implement isEquals
return this === other;
return (
other instanceof ArrayRemoveFieldValueImpl &&
deepEqual(this._elements, other._elements)
);
}
}

Expand All @@ -568,8 +572,10 @@ export class NumericIncrementFieldValueImpl extends FieldValue {
}

isEqual(other: FieldValue): boolean {
// TODO(mrschmidt): Implement isEquals
return this === other;
return (
other instanceof NumericIncrementFieldValueImpl &&
this._operand === other._operand
);
}
}

Expand Down
10 changes: 10 additions & 0 deletions packages/firestore/test/lite/integration.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -883,6 +883,16 @@ describe('FieldValue', () => {
expect(deleteField().isEqual(deleteField())).to.be.true;
expect(serverTimestamp().isEqual(serverTimestamp())).to.be.true;
expect(deleteField().isEqual(serverTimestamp())).to.be.false;
expect(arrayUnion().isEqual(arrayUnion())).to.be.true;
expect(arrayUnion('a').isEqual(arrayUnion('a'))).to.be.true;
expect(arrayUnion('a').isEqual(arrayUnion('b'))).to.be.false;
expect(arrayUnion('a', 'b').isEqual(arrayUnion('b', 'a'))).to.be.false;
expect(arrayRemove().isEqual(arrayRemove())).to.be.true;
expect(arrayRemove('a').isEqual(arrayRemove('a'))).to.be.true;
expect(arrayRemove('a').isEqual(arrayRemove('b'))).to.be.false;
expect(arrayRemove('a', 'b').isEqual(arrayRemove('b', 'a'))).to.be.false;
expect(increment(1).isEqual(increment(1))).to.be.true;
expect(increment(1).isEqual(increment(2))).to.be.false;
});

it('support instanceof checks', () => {
Expand Down