Skip to content
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

add BloomFilter class #6795

Merged
merged 34 commits into from
Nov 30, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
7122bab
add md5.js package
milaGGL Nov 14, 2022
3c38d56
remove noises due to format
milaGGL Nov 14, 2022
eeef62f
remove changes to yarn lock
milaGGL Nov 14, 2022
389de2e
use crypto.js instead of md5.js
milaGGL Nov 15, 2022
dd2e42f
add mightContain method to BloomFilter
milaGGL Nov 16, 2022
3c273e9
discard string representation of md5 hash value, use byte array instead
milaGGL Nov 17, 2022
854195c
Use DateView instead of Buffer
milaGGL Nov 17, 2022
84ef93e
Added Md5 to webchannel-wrapper
dconeybe Nov 17, 2022
877afce
webchannel_wrapper.test.ts added with 1 test (that currently fails du…
dconeybe Nov 17, 2022
02f74ff
webchannel-wrapper/src/index.js: fix Md5 prototype definition
dconeybe Nov 18, 2022
398c166
webchannel_wrapper.test.ts added
dconeybe Nov 18, 2022
01de4cf
webchannel_wrapper.test.ts: fix imports to make lint happy
dconeybe Nov 18, 2022
c3b9b42
Merge remote-tracking branch 'origin/dconeybe/Md5FromClosure' into mi…
milaGGL Nov 18, 2022
ba8967a
Add golden test, use MD5 from google library
milaGGL Nov 18, 2022
5abbe86
Use number in bitmap instead of hexadecimal string representation
milaGGL Nov 18, 2022
dca8d99
add golden test files
milaGGL Nov 22, 2022
4a3fb11
REVERT ME: require() test for json/txt
dconeybe Nov 22, 2022
3a22a98
Revert "REVERT ME: require() test for json/txt"
dconeybe Nov 22, 2022
9ccde39
import golden tests without fs, use Integer instead of BigInt
milaGGL Nov 22, 2022
0d919c1
add the Integer library
milaGGL Nov 22, 2022
c5616d7
Merge branch 'master' into mila/BloomFilter-add-BloomFilter-class
milaGGL Nov 22, 2022
2ba1981
Use platform based 64base decoding function
milaGGL Nov 23, 2022
687a5b6
reformat to pass github check
milaGGL Nov 23, 2022
8529ae7
update constructor validation
milaGGL Nov 24, 2022
810d63b
Revert "Merge branch 'master' into mila/BloomFilter-add-BloomFilter-c…
milaGGL Nov 25, 2022
6490034
resolve comments
milaGGL Nov 25, 2022
01bd93e
Revert "Revert "Merge branch 'master' into mila/BloomFilter-add-Bloom…
milaGGL Nov 25, 2022
10b1b67
resolve comments
milaGGL Nov 26, 2022
06f6400
remove type casting on TEST_DATA
milaGGL Nov 27, 2022
b3a7784
resolve comments
milaGGL Nov 29, 2022
4aaecda
run yarn format
milaGGL Nov 29, 2022
9321eec
Merge branch 'master' into mila/BloomFilter-add-BloomFilter-class
milaGGL Nov 29, 2022
9a11614
resolve comments
milaGGL Nov 29, 2022
1440908
resolve comments
milaGGL Nov 30, 2022
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
55 changes: 29 additions & 26 deletions packages/firestore/src/remote/bloom_filter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,28 @@ import { Md5, Integer } from '@firebase/webchannel-wrapper';
import { newTextEncoder } from '../platform/serializer';
import { debugAssert } from '../util/assert';

const MAX_64_BIT_UNSIGNED_INTEGER = Integer.fromNumber(Math.pow(2, 64));
const MAX_64_BIT_UNSIGNED_INTEGER = new Integer([0xffffffff, 0xffffffff], 0);

// Hash a string using md5 hashing algorithm.
function getMd5HashValue(value: string): Uint8Array {
const encodedValue = newTextEncoder().encode(value);
const md5 = new Md5();
md5.update(encodedValue);
return new Uint8Array(md5.digest());
}

// Interpret the 16 bytes array as two 64-bit unsigned integers, encoded using
// 2’s complement using little endian.
function get64BitUints(Bytes: Uint8Array): [Integer, Integer] {
const dataView = new DataView(Bytes.buffer);
const chunk1 = dataView.getUint32(0, /* littleEndian= */ true);
const chunk2 = dataView.getUint32(4, /* littleEndian= */ true);
const chunk3 = dataView.getUint32(8, /* littleEndian= */ true);
const chunk4 = dataView.getUint32(12, /* littleEndian= */ true);
const integer1 = new Integer([chunk1, chunk2], 0);
const integer2 = new Integer([chunk3, chunk4], 0);
return [integer1, integer2];
}

export class BloomFilter {
readonly size: number;
Expand All @@ -45,30 +66,10 @@ export class BloomFilter {
}

this.size = bitmap.length * 8 - padding;
// Set the size in Integer to avoid repeated calculation in mightContain().
this.sizeInInteger = Integer.fromNumber(this.size);
dconeybe marked this conversation as resolved.
Show resolved Hide resolved
}

// Hash a string using md5 hashing algorithm.
private static getMd5HashValue(value: string): Uint8Array {
const md5 = new Md5();
const encodedValue = newTextEncoder().encode(value);
md5.update(encodedValue);
return new Uint8Array(md5.digest());
}

// Interpret the 16 bytes array as two 64-bit unsigned integers, encoded using 2’s
// complement using little endian.
private static get64BitUints(Bytes: Uint8Array): [Integer, Integer] {
const dataView = new DataView(Bytes.buffer);
const chunk1 = dataView.getUint32(0, /* littleEndian= */ true);
const chunk2 = dataView.getUint32(4, /* littleEndian= */ true);
const chunk3 = dataView.getUint32(8, /* littleEndian= */ true);
const chunk4 = dataView.getUint32(12, /* littleEndian= */ true);
const integer1 = new Integer([chunk1, chunk2], 0);
const integer2 = new Integer([chunk3, chunk4], 0);
return [integer1, integer2];
}

// Calculate the ith hash value based on the hashed 64bit integers,
// and calculate its corresponding bit index in the bitmap to be checked.
private getBitIndex(num1: Integer, num2: Integer, index: number): number {
Expand All @@ -85,17 +86,19 @@ export class BloomFilter {
private isBitSet(index: number): boolean {
// To retrieve bit n, calculate: (bitmap[n / 8] & (0x01 << (n % 8))).
const byte = this.bitmap[Math.floor(index / 8)];
return (byte & (0x01 << index % 8)) !== 0;
const offset = index % 8;
return (byte & (0x01 << offset)) !== 0;
}

mightContain(value: string): boolean {
// Empty bitmap and empty value should always return false on membership check.
// Empty bitmap and empty value should always return false on membership
// check.
if (this.size === 0 || value === '') {
return false;
}

const md5HashedValue = BloomFilter.getMd5HashValue(value);
const [hash1, hash2] = BloomFilter.get64BitUints(md5HashedValue);
const md5HashedValue = getMd5HashValue(value);
const [hash1, hash2] = get64BitUints(md5HashedValue);
for (let i = 0; i < this.hashCount; i++) {
const index = this.getBitIndex(hash1, hash2, i);
if (!this.isBitSet(index)) {
Expand Down
13 changes: 13 additions & 0 deletions packages/firestore/test/unit/core/webchannel_wrapper.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -348,4 +348,17 @@ describe('Integer', () => {
expect(Integer.fromString('125715', 8).toNumber()).equals(43981);
expect(Integer.fromString('1010101111001101', 2).toNumber()).equals(43981);
});

it('getBits() create a new Integer with the given value', () => {
expect(new Integer([1, 2], 0).getBits(0)).equals(1);
expect(new Integer([1, 2], 0).getBits(1)).equals(2);
expect(new Integer([-1, -2], -1).getBits(0)).equals(-1);
expect(new Integer([-1, -2], -1).getBits(1)).equals(-2);
expect(new Integer([0xff, 0xffff], 0).getBits(0)).equals(
Integer.fromNumber(0xff).toNumber()
dconeybe marked this conversation as resolved.
Show resolved Hide resolved
);
expect(new Integer([0xff, 0xffff], 0).getBits(1)).equals(
Integer.fromNumber(0xffff).toNumber()
);
});
});
45 changes: 26 additions & 19 deletions packages/firestore/test/unit/remote/bloom_filter.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,31 @@ describe('BloomFilter', () => {
});

it('can instantiate a non empty bloom filter', () => {
dconeybe marked this conversation as resolved.
Show resolved Hide resolved
const bloomFilter = new BloomFilter(new Uint8Array([255, 255, 124]), 3, 13);
expect(bloomFilter.size).to.equal(21);
const bloomFilter0 = new BloomFilter(new Uint8Array(1), 0, 1);
const bloomFilter1 = new BloomFilter(new Uint8Array(1), 1, 1);
const bloomFilter2 = new BloomFilter(new Uint8Array(1), 2, 1);
const bloomFilter3 = new BloomFilter(new Uint8Array(1), 3, 1);
const bloomFilter4 = new BloomFilter(new Uint8Array(1), 4, 1);
const bloomFilter5 = new BloomFilter(new Uint8Array(1), 5, 1);
const bloomFilter6 = new BloomFilter(new Uint8Array(1), 6, 1);
const bloomFilter7 = new BloomFilter(new Uint8Array(1), 7, 1);

expect(bloomFilter0.size).to.equal(8);
expect(bloomFilter1.size).to.equal(7);
expect(bloomFilter2.size).to.equal(6);
expect(bloomFilter3.size).to.equal(5);
expect(bloomFilter4.size).to.equal(4);
expect(bloomFilter5.size).to.equal(3);
expect(bloomFilter6.size).to.equal(2);
expect(bloomFilter7.size).to.equal(1);
});

it('should throw error if padding is invalid', () => {
expect(() => new BloomFilter(new Uint8Array(1), -1, 1)).to.throw(
'Invalid padding: -1'
);
expect(() => new BloomFilter(new Uint8Array(1), 9, 1)).to.throw(
'Invalid padding: 9'
expect(() => new BloomFilter(new Uint8Array(1), 8, 1)).to.throw(
'Invalid padding: 8'
);
});

Expand Down Expand Up @@ -102,40 +117,32 @@ describe('BloomFilter', () => {
const documentPrefix =
'projects/project-1/databases/database-1/documents/coll/doc';

interface TestDataType {
interface GoldenTestInput {
bits: {
bitmap: string;
padding: number;
};
hashCount: number;
}

interface TestResultType {
interface GoldenTestExpectedResult {
membershipTestResults: string;
}

function decodeBase64ToUint8Array(encoded: string): Uint8Array {
return ByteString.fromBase64String(encoded).toUint8Array();
}

function testBloomFilterAgainstExpectedResult(
bloomFilterInputs: TestDataType,
expectedResult: TestResultType
bloomFilterInputs: GoldenTestInput,
expectedResult: GoldenTestExpectedResult
): void {
const {
bits: { bitmap, padding },
hashCount
} = bloomFilterInputs;
const { membershipTestResults } = expectedResult;

const bloomFilter = new BloomFilter(
decodeBase64ToUint8Array(bitmap),
padding,
hashCount
);
const byteArray = ByteString.fromBase64String(bitmap).toUint8Array();
const bloomFilter = new BloomFilter(byteArray, padding, hashCount);
for (let i = 0; i < membershipTestResults.length; i++) {
const expectedMembershipResult =
membershipTestResults[i] === '1' ? true : false;
const expectedMembershipResult = membershipTestResults[i] === '1';
const mightContain = bloomFilter.mightContain(documentPrefix + i);
expect(mightContain).to.equal(expectedMembershipResult);
}
Expand Down
2 changes: 2 additions & 0 deletions packages/webchannel-wrapper/src/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,8 @@ export class FetchXmlHttpFactory {
}

// See https://google.github.io/closure-library/api/goog.crypt.Md5.html
// Unit test are written in
// packages/firestore/test/unit/core/webchannel_wrapper.test.ts
export class Md5 {
dconeybe marked this conversation as resolved.
Show resolved Hide resolved
reset(): void;
digest(): Array<number>;
Expand Down