REFACTOR hashing (pubkey#4316)

Author: pubkey

package.json

@@ -392,6 +392,7 @@
     "mingo": "6.2.7",
     "modifyjs": "0.3.1",
     "oblivious-set": "1.1.1",
+    "ohash": "1.0.0",
     "pouchdb-selector-core": "8.0.0",
     "reconnecting-websocket": "4.4.0",
     "simple-peer": "9.11.1",
@@ -506,4 +507,4 @@
     "webpack-dev-server": "4.11.1",
     "wrtc": "0.4.7"
   }
-}
+}

src/plugin-helpers.ts

@@ -19,7 +19,7 @@ import type {
     RxStorageWriteErrorConflict
 } from './types';
 import {
-    fastUnsecureHash,
+    defaultHashSha256,
     flatClone,
     getFromMapOrThrow,
     requestIdleCallbackIfAvailable
@@ -67,7 +67,7 @@ export function wrappedValidateStorageFactory(
     function initValidator(
         schema: RxJsonSchema<any>
     ): ValidatorFunction {
-        const hash = fastUnsecureHash(JSON.stringify(schema));
+        const hash = defaultHashSha256(JSON.stringify(schema));
         if (!VALIDATOR_CACHE.has(hash)) {
             const validator = getValidator(schema);
             VALIDATOR_CACHE.set(hash, validator);

src/plugins/dev-mode/check-schema.ts

@@ -30,7 +30,7 @@ export function checkFieldNameRegex(fieldName: string) {
         return;
     }
 
-    if (['properties', 'language'].includes(fieldName)) {
+    if (['properties'].includes(fieldName)) {
         throw newRxError('SC23', {
             fieldName
         });

src/plugins/migration/data-migrator.ts

@@ -263,7 +263,7 @@ export async function createOldCollection(
         dataMigrator,
         newestCollection: dataMigrator.newestCollection,
         database,
-        schema: createRxSchema(schemaObj, false),
+        schema: createRxSchema(schemaObj, database.hashFunction, false),
         storageInstance
     };
 

src/plugins/replication-couchdb/index.ts

@@ -4,7 +4,6 @@
 import {
     ensureNotFalsy,
     errorToPlainJson,
-    fastUnsecureHash,
     flatClone,
     getFromMapOrThrow,
     lastOfArray
@@ -204,7 +203,7 @@ export function replicateCouchDB<RxDocType>(
     const replicationState = new RxCouchDBReplicationState<RxDocType>(
         options.url,
         options.fetch ? options.fetch : getDefaultFetch(),
-        COUCHDB_NEW_REPLICATION_PLUGIN_IDENTITY_PREFIX + fastUnsecureHash(options.url),
+        COUCHDB_NEW_REPLICATION_PLUGIN_IDENTITY_PREFIX + options.collection.database.hashFunction(options.url),
         collection,
         replicationPrimitivesPull,
         replicationPrimitivesPush,

src/plugins/replication-firestore/index.ts

@@ -1,7 +1,6 @@
 import {
     ensureNotFalsy,
     errorToPlainJson,
-    fastUnsecureHash,
     flatClone,
     lastOfArray
 } from '../../plugins/utils';
@@ -304,7 +303,7 @@ export function replicateFirestore<RxDocType>(
 
     const replicationState = new RxFirestoreReplicationState<RxDocType>(
         options.firestore,
-        FIRESTORE_REPLICATION_PLUGIN_IDENTITY_PREFIX + fastUnsecureHash(options.firestore.projectId),
+        FIRESTORE_REPLICATION_PLUGIN_IDENTITY_PREFIX + options.collection.database.hashFunction(options.firestore.projectId),
         collection,
         replicationPrimitivesPull,
         replicationPrimitivesPush,

src/plugins/replication-graphql/index.ts

@@ -4,7 +4,6 @@
  */
 import {
     ensureNotFalsy,
-    fastUnsecureHash,
     getProperty
 } from '../../plugins/utils';
 
@@ -174,7 +173,7 @@ export function replicateGraphQL<RxDocType, CheckpointType>(
     const graphqlReplicationState = new RxGraphQLReplicationState(
         url,
         mutateableClientState,
-        GRAPHQL_REPLICATION_PLUGIN_IDENTITY_PREFIX + fastUnsecureHash(url.http ? url.http : url.ws as any),
+        GRAPHQL_REPLICATION_PLUGIN_IDENTITY_PREFIX + collection.database.hashFunction(url.http ? url.http : url.ws as any),
         collection,
         deletedField,
         replicationPrimitivesPull,

src/plugins/replication/index.ts

@@ -33,7 +33,6 @@ import { RxDBLeaderElectionPlugin } from '../leader-election';
 import {
     ensureNotFalsy,
     errorToPlainJson,
-    fastUnsecureHash,
     flatClone,
     PROMISE_RESOLVE_FALSE,
     PROMISE_RESOLVE_TRUE,
@@ -426,7 +425,7 @@ export function replicateRxCollection<RxDocType, CheckpointType>(
     }: ReplicationOptions<RxDocType, CheckpointType>
 ): RxReplicationState<RxDocType, CheckpointType> {
     addRxPlugin(RxDBLeaderElectionPlugin);
-    const replicationIdentifierHash = fastUnsecureHash(
+    const replicationIdentifierHash = collection.database.hashFunction(
         [
             collection.database.name,
             collection.name,

src/plugins/utils/utils-hash.ts

@@ -1,70 +1,11 @@
-
+import { sha256 } from 'ohash';
 /**
- * This is a very fast hash method
- * but it is not cryptographically secure.
- * For each run it will append a number between 0 and 2147483647 (=biggest 32 bit int).
- * @link http://stackoverflow.com/questions/7616461/generate-a-hash-from-string-in-javascript-jquery
- * @return a string as hash-result
- */
-export function fastUnsecureHash(
-    inputString: string,
-    // used to test the polyfill
-    doNotUseTextEncoder?: boolean
-): string {
-    let hashValue = 0,
-        i, chr, len;
-
-    /**
-     * For better performance we first transform all
-     * chars into their ascii numbers at once.
-     *
-     * This is what makes the murmurhash implementation such fast.
-     * @link https://github.com/perezd/node-murmurhash/blob/master/murmurhash.js#L4
-     */
-    let encoded: Uint8Array | number[];
-
-    /**
-     * All modern browsers support the TextEncoder
-     * @link https://caniuse.com/textencoder
-     * But to make RxDB work in other JavaScript runtimes,
-     * like when using it in flutter or QuickJS, we need to
-     * make it work even when there is no TextEncoder.
-     *
-     * TODO is a text encoder really faster then using charCodeAt?
-     */
-    if (typeof TextEncoder !== 'undefined' && !doNotUseTextEncoder) {
-        encoded = new TextEncoder().encode(inputString);
-    } else {
-        encoded = [];
-        for (let j = 0; j < inputString.length; j++) {
-            encoded.push(inputString.charCodeAt(j));
-        }
-    }
-
-    for (i = 0, len = inputString.length; i < len; i++) {
-        chr = encoded[i];
-        hashValue = ((hashValue << 5) - hashValue) + chr;
-        hashValue |= 0; // Convert to 32bit integer
-    }
-    if (hashValue < 0) {
-        hashValue = hashValue * -1;
-    }
-
-    /**
-     * To make the output smaller
-     * but still have it to represent the same value,
-     * we use the biggest radix of 36 instead of just
-     * transforming it into a hex string.
-     */
-    return hashValue.toString(36);
-}
-
-/**
- * Default hash method used to create revision hashes
- * that do not have to be cryptographically secure.
+ * Default hash method used to hash
+ * strings and do equal comparisons.
+ *
  * IMPORTANT: Changing the default hashing method
  * requires a BREAKING change!
  */
-export function defaultHashFunction(input: string): string {
-    return fastUnsecureHash(input);
+export function defaultHashSha256(input: string): string {
+    return sha256(input);
 }

src/replication-protocol/checkpoint.ts

@@ -10,7 +10,6 @@ import type {
 import {
     createRevision,
     ensureNotFalsy,
-    fastUnsecureHash,
     getDefaultRevision,
     getDefaultRxDocumentMeta,
     getFromObjectOrThrow,
@@ -143,7 +142,7 @@ export async function setCheckpoint<RxDocType, CheckpointType>(
 export function getCheckpointKey<RxDocType>(
     input: RxStorageInstanceReplicationInput<RxDocType>
 ): string {
-    const hash = fastUnsecureHash([
+    const hash = input.hashFunction([
         input.identifier,
         input.forkInstance.databaseName,
         input.forkInstance.collectionName