FIX wrong-index-generation-on-some-number-fields (pubkey#4605)

* TRY fix * FIX * FIX logs
jeromepochat · Mar 31, 2023 · 6c5337c · 6c5337c
1 parent 98178e2
commit 6c5337c
Show file tree

Hide file tree

Showing 5 changed files with 104 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 # RxDB Changelog
 
 <!-- CHANGELOG NEWEST -->
-
+- FIX wrong index generation on some number fields that do not have decimals.
 <!-- ADD new changes here! -->
 
 <!-- /CHANGELOG NEWEST -->

diff --git a/docs-src/index.html b/docs-src/index.html
@@ -82,7 +82,10 @@
             </div>
         </a>
 
-        <div class="right" style="display: flex;">
+        <div
+            class="right"
+            style="display: flex;"
+        >
             <a
                 href="/premium.html"
                 target="_blank"
@@ -141,8 +144,9 @@ <h2>
                     <li>Realtime Queries</li>
                     <li>Realtime Replication</li>
                     <li>Works Offline</li>
-                    <li>Great performance</li>
                     <li>Supports all major JavaScript runtimes</li>
+                    <li>Fast as F<b>*</b>ck</li>
+                    <li>Easy to learn</li>
                 </ul>
                 <!-- 
                     <div class="text">
@@ -973,7 +977,10 @@ <h2>
     <div class="clear"></div>
 
     <footer>
-        <a href="./imprint.html" target="_blank">Imprint</a>
+        <a
+            href="./imprint.html"
+            target="_blank"
+        >Imprint</a>
     </footer>
 </body>
 

diff --git a/src/custom-index.ts b/src/custom-index.ts
@@ -104,9 +104,6 @@ export function getIndexableStringMonad<RxDocType>(
             } else {
                 // is number
                 const parsedLengths = props.parsedLengths as ParsedLengths;
-                if (!fieldValue) {
-                    fieldValue = 0;
-                }
                 str += getNumberIndexString(
                     parsedLengths,
                     fieldValue
@@ -118,7 +115,11 @@ export function getIndexableStringMonad<RxDocType>(
     return ret;
 }
 
+
+
 declare type ParsedLengths = {
+    minimum: number;
+    maximum: number;
     nonDecimals: number;
     decimals: number;
     roundedMinimum: number;
@@ -139,6 +140,8 @@ export function getStringLengthOfIndexNumber(
         decimals = multipleOfParts[1].length;
     }
     return {
+        minimum,
+        maximum,
         nonDecimals,
         decimals,
         roundedMinimum: minimum
@@ -183,14 +186,35 @@ export function getNumberIndexString(
     parsedLengths: ParsedLengths,
     fieldValue: number
 ): string {
+    /**
+     * Ensure that the given value is in the boundaries
+     * of the schema, otherwise it would create a broken index string.
+     * This can happen for example if you have a minimum of 0
+     * and run a query like
+     * selector {
+     *  numField: { $gt: -1000 }
+     * }
+     */
+    if (typeof fieldValue === 'undefined') {
+        fieldValue = 0;
+    }
+    if (fieldValue < parsedLengths.minimum) {
+        fieldValue = parsedLengths.minimum;
+    }
+    if (fieldValue > parsedLengths.maximum) {
+        fieldValue = parsedLengths.maximum;
+    }
+
     let str: string = '';
     const nonDecimalsValueAsString = (Math.floor(fieldValue) - parsedLengths.roundedMinimum).toString();
     str += nonDecimalsValueAsString.padStart(parsedLengths.nonDecimals, '0');
 
     const splitByDecimalPoint = fieldValue.toString().split('.');
     const decimalValueAsString = splitByDecimalPoint.length > 1 ? splitByDecimalPoint[1] : '0';
 
-    str += decimalValueAsString.padEnd(parsedLengths.decimals, '0');
+    if (parsedLengths.decimals > 0) {
+        str += decimalValueAsString.padEnd(parsedLengths.decimals, '0');
+    }
     return str;
 }
 

diff --git a/src/plugins/utils/utils-array.ts b/src/plugins/utils/utils-array.ts
@@ -114,3 +114,7 @@ export function sumNumberArray(array: number[]): number {
     }
     return count;
 }
+
+export function maxOfNumbers(arr: number[]): number {
+    return Math.max(...arr);
+}
diff --git a/test/unit/custom-index.test.ts b/test/unit/custom-index.test.ts
@@ -273,6 +273,67 @@ config.parallel('custom-index.test.ts', () => {
                 assert.strictEqual(indexString.length, length);
             });
         });
+        it('issue did not work with this numberValue', () => {
+            const testIndex = ['numberValue', 'key'];
+            const testSchema: RxJsonSchema<RxDocumentData<any>> = fillWithDefaultSettings({
+                version: 0,
+                type: 'object',
+                primaryKey: 'key',
+                properties: {
+                    key: {
+                        type: 'string',
+                        maxLength: 50
+                    },
+                    numberValue: {
+                        type: 'number',
+                        minimum: -10,
+                        maximum: 1000,
+                        multipleOf: 1
+                    }
+                },
+                required: [
+                    'key',
+                    'numberValue'
+                ],
+                indexes: [
+                    testIndex
+                ],
+                additionalProperties: false
+            });
+            const length = getIndexStringLength(
+                testSchema,
+                testIndex
+            );
+            const testDocs: RxDocumentData<any>[] = [
+                {
+                    id: randomString(10),
+                    numberValue: 17,
+                    _deleted: false,
+                    _attachments: {},
+                    _meta: {
+                        lwt: new Date().getTime()
+                    },
+                    _rev: EXAMPLE_REVISION_1
+                },
+                {
+                    id: randomString(10),
+                    numberValue: -5,
+                    _deleted: false,
+                    _attachments: {},
+                    _meta: {
+                        lwt: new Date().getTime()
+                    },
+                    _rev: EXAMPLE_REVISION_1
+                }
+            ];
+            testDocs.forEach(docData => {
+                const indexString = getIndexableStringMonad(
+                    testSchema,
+                    testIndex
+                )(docData);
+                assert.strictEqual(indexString.length, length);
+            });
+        });
     });
     describe('.getPrimaryKeyFromIndexableString()', () => {
         it('get the correct id', () => {