fix: jmespathQueryLanguage not working with non-native JSON data type…

…s like LosslessNumber
josdejong · Feb 22, 2023 · e2c8e3d · e2c8e3d
1 parent 09f2575
commit e2c8e3d
Show file tree

Hide file tree

Showing 18 changed files with 167 additions and 74 deletions.
diff --git a/README.md b/README.md
@@ -474,7 +474,7 @@ interface QueryLanguage {
   name: string
   description: string
   createQuery: (json: JSONValue, queryOptions: QueryLanguageOptions) => string
-  executeQuery: (json: JSONValue, query: string) => JSONValue
+  executeQuery: (json: JSONValue, query: string, parser: JSONParser) => JSONValue
 }
 
 interface QueryLanguageOptions {

diff --git a/src/lib/components/controls/JSONPreview.svelte b/src/lib/components/controls/JSONPreview.svelte
@@ -1,9 +1,9 @@
 <script lang="ts">
   import type { JSONParser } from '$lib/types'
-  import type { JSONValue } from 'lossless-json'
   import { truncate } from '$lib/utils/stringUtils.js'
   import { getText } from '$lib/utils/jsonUtils.js'
   import { MAX_CHARACTERS_TEXT_PREVIEW } from '$lib/constants.js'
+  import type { JSONValue } from 'immutable-json-patch'
 
   export let text: string | undefined
   export let json: JSONValue | undefined

diff --git a/src/lib/components/modals/TransformModal.svelte b/src/lib/components/modals/TransformModal.svelte
@@ -72,7 +72,7 @@
       : getSelectedQueryLanguage(queryLanguageId).createQuery(json, state.queryOptions || {})
   let isManual = state.isManual || false
 
-  let previewError = undefined
+  let previewError: string | undefined = undefined
   let previewContent: Content = { text: '' }
 
   function getSelectedQueryLanguage(queryLanguageId: string): QueryLanguage {
@@ -98,13 +98,17 @@
       debug('previewTransform', {
         query
       })
-      const jsonTransformed = getSelectedQueryLanguage(queryLanguageId).executeQuery(json, query)
+      const jsonTransformed = getSelectedQueryLanguage(queryLanguageId).executeQuery(
+        json,
+        query,
+        parser
+      )
 
       previewContent = { json: jsonTransformed }
       previewError = undefined
     } catch (err) {
       previewContent = { text: '' }
-      previewError = err
+      previewError = err.toString()
     }
   }
 
@@ -132,7 +136,8 @@
       debug('handleTransform', { query })
       const jsonTransformed = getSelectedQueryLanguage(queryLanguageId).executeQuery(
         selectedJson,
-        query
+        query,
+        parser
       )
 
       onTransform([
@@ -308,7 +313,7 @@
               />
             {:else}
               <div class="jse-preview jse-error">
-                {previewError.toString()}
+                {previewError}
               </div>
             {/if}
           </div>

diff --git a/src/lib/components/modes/tablemode/TableModeWelcome.svelte b/src/lib/components/modes/tablemode/TableModeWelcome.svelte
@@ -1,11 +1,10 @@
 <script lang="ts">
-  import type { JSONValue } from 'lossless-json'
+  import type { JSONPath, JSONValue } from 'immutable-json-patch'
+  import { getIn, isJSONArray, isJSONObject } from 'immutable-json-patch'
   import type { JSONParser, OnChangeMode } from '$lib/types'
   import { Mode } from '$lib/types'
   import { valueType } from '$lib/utils/typeUtils'
   import { findNestedArrays } from '$lib/logic/table'
-  import type { JSONPath } from 'immutable-json-patch'
-  import { getIn, isJSONArray, isJSONObject } from 'immutable-json-patch'
   import { isEmpty } from 'lodash-es'
   import { stringifyJSONPath, stripRootObject } from '$lib/utils/pathUtils.js'
 

diff --git a/src/lib/components/modes/tablemode/tag/InlineValue.svelte b/src/lib/components/modes/tablemode/tag/InlineValue.svelte
@@ -1,7 +1,5 @@
 <script lang="ts">
-  import type { JSONArray, JSONObject } from 'lossless-json'
-  import { isJSONArray } from 'immutable-json-patch'
-  import type { JSONPath } from 'immutable-json-patch'
+  import type { isJSONArray, JSONArray, JSONObject, JSONPath } from 'immutable-json-patch'
   import type { JSONParser } from '$lib/types'
   import { truncate } from '$lib/utils/stringUtils.js'
   import { MAX_INLINE_OBJECT_CHARS } from '$lib/constants.js'

diff --git a/src/lib/logic/actions.ts b/src/lib/logic/actions.ts
@@ -29,7 +29,6 @@ import type {
   OnPatch,
   OnSelect
 } from '$lib/types'
-import type { JSONValue } from 'lossless-json'
 import { createDebug } from '$lib/utils/debug'
 import {
   getIn,
@@ -38,6 +37,7 @@ import {
   isJSONPatchReplace,
   type JSONArray,
   type JSONPath,
+  type JSONValue,
   parsePath
 } from 'immutable-json-patch'
 import { isObject, isObjectOrArray } from '$lib/utils/typeUtils'

diff --git a/src/lib/logic/selection.test.ts b/src/lib/logic/selection.test.ts
@@ -1,4 +1,4 @@
-import { test, describe } from 'vitest'
+import { describe, test } from 'vitest'
 import assert from 'assert'
 import {
   createAfterSelection,
@@ -20,7 +20,7 @@ import {
 } from './selection.js'
 import { createDocumentState } from './documentState.js'
 import { type DocumentState, type JSONSelection, SelectionType } from '../types.js'
-import type { JSONValue } from 'lossless-json'
+import type { JSONValue } from 'immutable-json-patch'
 
 describe('selection', () => {
   const json = {

diff --git a/src/lib/plugins/query/javascriptQueryLanguage.test.ts b/src/lib/plugins/query/javascriptQueryLanguage.test.ts
@@ -2,6 +2,8 @@ import { test, describe } from 'vitest'
 import assert from 'assert'
 import { javascriptQueryLanguage } from './javascriptQueryLanguage.js'
 import { cloneDeep } from 'lodash-es'
+import { LosslessNumber } from 'lossless-json'
+import type { JSONValue } from 'immutable-json-patch'
 
 const { createQuery, executeQuery } = javascriptQueryLanguage
 
@@ -16,7 +18,7 @@ describe('javascriptQueryLanguage', () => {
   describe('createQuery and executeQuery', () => {
     test('should create a and execute an empty query', () => {
       const query = createQuery(users, {})
-      const result = executeQuery(users, query)
+      const result = executeQuery(users, query, JSON)
       assert.deepStrictEqual(query, 'function query (data) {\n  return data\n}')
       assert.deepStrictEqual(result, users)
       assert.deepStrictEqual(users, originalUsers) // must not touch the original users
@@ -38,7 +40,7 @@ describe('javascriptQueryLanguage', () => {
           '}'
       )
 
-      const result = executeQuery(users, query)
+      const result = executeQuery(users, query, JSON)
       assert.deepStrictEqual(result, [user2])
       assert.deepStrictEqual(users, originalUsers) // must not touch the original data
     })
@@ -62,7 +64,7 @@ describe('javascriptQueryLanguage', () => {
           '}'
       )
 
-      const result = executeQuery(data, query)
+      const result = executeQuery(data, query, JSON)
       assert.deepStrictEqual(result, [{ 'user name!': 'Bob' }])
       assert.deepStrictEqual(data, originalData) // must not touch the original data
     })
@@ -85,7 +87,7 @@ describe('javascriptQueryLanguage', () => {
           '}'
       )
 
-      const result = executeQuery(data, query)
+      const result = executeQuery(data, query, JSON)
       assert.deepStrictEqual(result, [1])
       assert.deepStrictEqual(data, originalData) // must not touch the original data
     })
@@ -106,7 +108,7 @@ describe('javascriptQueryLanguage', () => {
           '}'
       )
 
-      const result = executeQuery(users, query)
+      const result = executeQuery(users, query, JSON)
       assert.deepStrictEqual(result, [user1, user2])
       assert.deepStrictEqual(users, originalUsers) // must not touch the original users
     })
@@ -127,7 +129,7 @@ describe('javascriptQueryLanguage', () => {
           '}'
       )
 
-      const result = executeQuery(users, query)
+      const result = executeQuery(users, query, JSON)
       assert.deepStrictEqual(result, [user2])
       assert.deepStrictEqual(users, originalUsers) // must not touch the original users
     })
@@ -148,7 +150,7 @@ describe('javascriptQueryLanguage', () => {
           '}'
       )
 
-      const result = executeQuery(users, query)
+      const result = executeQuery(users, query, JSON)
       assert.deepStrictEqual(result, [user2])
       assert.deepStrictEqual(users, originalUsers) // must not touch the original users
     })
@@ -173,7 +175,7 @@ describe('javascriptQueryLanguage', () => {
           '}'
       )
 
-      const result = executeQuery(users, query)
+      const result = executeQuery(users, query, JSON)
       assert.deepStrictEqual(result, [user1, user2, user3])
       assert.deepStrictEqual(users, originalUsers) // must not touch the original users
     })
@@ -198,7 +200,7 @@ describe('javascriptQueryLanguage', () => {
           '}'
       )
 
-      const result = executeQuery(users, query)
+      const result = executeQuery(users, query, JSON)
       assert.deepStrictEqual(result, [user3, user2, user1])
       assert.deepStrictEqual(users, originalUsers) // must not touch the original users
     })
@@ -218,7 +220,7 @@ describe('javascriptQueryLanguage', () => {
           '}'
       )
 
-      const result = executeQuery(users, query)
+      const result = executeQuery(users, query, JSON)
       assert.deepStrictEqual(result, ['Stuart', 'Kevin', 'Bob'])
       assert.deepStrictEqual(users, originalUsers) // must not touch the original users
     })
@@ -241,7 +243,7 @@ describe('javascriptQueryLanguage', () => {
           '}'
       )
 
-      const result = executeQuery(users, query)
+      const result = executeQuery(users, query, JSON)
       assert.deepStrictEqual(result, [
         { name: 'Stuart', _id: '1' },
         { name: 'Kevin', _id: '3' },
@@ -281,7 +283,7 @@ describe('javascriptQueryLanguage', () => {
           '}'
       )
 
-      const result = executeQuery(users, query)
+      const result = executeQuery(users, query, JSON)
       assert.deepStrictEqual(result, ['Bob', 'Stuart'])
       assert.deepStrictEqual(users, originalUsers) // must not touch the original users
     })
@@ -295,23 +297,40 @@ describe('javascriptQueryLanguage', () => {
         '  return square(data)\n' +
         '};'
       const data = 4
-      const result = executeQuery(data, query)
+      const result = executeQuery(data, query, JSON)
       assert.deepStrictEqual(result, 16)
     })
 
+    test('should work with alternative parsers and non-native JSON data types', () => {
+      const data = [new LosslessNumber('4'), new LosslessNumber('7'), new LosslessNumber('5')]
+      const query = createQuery(data as unknown as JSONValue, {
+        sort: {
+          path: [],
+          direction: 'asc'
+        }
+      })
+
+      const result = executeQuery(data as unknown as JSONValue, query, JSON)
+      assert.deepStrictEqual(result, [
+        new LosslessNumber('4'),
+        new LosslessNumber('5'),
+        new LosslessNumber('7')
+      ])
+    })
+
     test('should throw an exception when function query is not defined in the query', () => {
       assert.throws(() => {
         const query = 'function test (data) { return 42 }'
         const data = {}
 
-        executeQuery(data, query)
+        executeQuery(data, query, JSON)
       }, /Error: Cannot execute query: expecting a function named 'query' but is undefined/)
     })
 
     test('should return null when property is not found', () => {
       const query = 'function query (data) {\n' + '  return data.foo\n' + '}'
       const data = {}
-      const result = executeQuery(data, query)
+      const result = executeQuery(data, query, JSON)
       assert.deepStrictEqual(result, null)
     })
   })