clone/logseq
1
0
Fork 0
mirror of https://github.com/logseq/logseq.git synced 2026-04-24 22:25:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add tests for result related transform and grouping

Browse Source 
Also fixed two bugs related to new :group-by-page? option
This commit is contained in:
Gabriel Horner
2023-04-18 16:29:07 -04:00
committed by Tienson Qin
parent 4debd825ec
commit 7d801c0f10
4 changed files with 151 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.clj-kondo/config.edn
View File

@@ -39,6 +39,8 @@
electron.utils utils
"/electron/utils" js-utils
frontend.commands commands
frontend.components.query query
frontend.components.query.result query-result
frontend.config config
frontend.date date
frontend.db db

76
src/main/frontend/components/query.cljs
View File

@@ -3,18 +3,16 @@
[frontend.ui :as ui]
[frontend.util :as util]
[frontend.state :as state]
[frontend.search :as search]
[frontend.db :as db]
[frontend.db-mixins :as db-mixins]
[clojure.string :as string]
[frontend.db.query-dsl :as query-dsl]
[frontend.components.query-table :as query-table]
[frontend.db.utils :as db-utils]
[frontend.components.query.result :as query-result]
[lambdaisland.glogi :as log]
[frontend.extensions.sci :as sci]
[frontend.handler.editor :as editor-handler]
[logseq.graph-parser.util :as gp-util]
[promesa.core :as p]))
[logseq.graph-parser.util :as gp-util]))
(defn built-in-custom-query?
[title]
@@ -22,45 +20,6 @@
(when (seq queries)
(boolean (some #(= % title) (map :title queries))))))
(defn- trigger-custom-query!
[state *query-error *query-triggered?]
(let [[config query] (:rum/args state)
repo (state/get-current-repo)
result-atom (atom nil)
current-block-uuid (or (:block/uuid (:block config))
(:block/uuid config))
_ (reset! *query-error nil)
query-atom (try
(cond
(:dsl-query? config)
(let [q (:query query)
form (gp-util/safe-read-string q)]
(cond
;; Searches like 'foo' or 'foo bar' come back as symbols
;; and are meant to go directly to full text search
(and (util/electron?) (symbol? form)) ; full-text search
(p/let [blocks (search/block-search repo (string/trim (str form)) {:limit 30})]
(when (seq blocks)
(let [result (db/pull-many (state/get-current-repo) '[*] (map (fn [b] [:block/uuid (uuid (:block/uuid b))]) blocks))]
(reset! result-atom result))))
(symbol? form)
(atom nil)
:else
(query-dsl/query (state/get-current-repo) q)))
:else
(db/custom-query query {:current-block-uuid current-block-uuid}))
(catch :default e
(reset! *query-error e)
(atom nil)))]
(when *query-triggered?
(reset! *query-triggered? true))
(if (instance? Atom query-atom)
query-atom
result-atom)))
(rum/defc query-refresh-button
[query-time {:keys [on-mouse-down full-text-search?]}]
(ui/tippy
@@ -80,24 +39,6 @@
{:on-mouse-down on-mouse-down}
(ui/icon "refresh" {:style {:font-size 20}})]))
(defn- get-query-result
[state config *query-error *query-triggered? current-block-uuid q group-by-page?]
(or (when-let [*result (:query-result config)] @*result)
(let [query-atom (trigger-custom-query! state *query-error *query-triggered?)
query-result (and query-atom (rum/react query-atom))
;; exclude the current one, otherwise it'll loop forever
remove-blocks (if current-block-uuid [current-block-uuid] nil)
transformed-query-result (when query-result
(db/custom-query-result-transform query-result remove-blocks q))
result (if (and group-by-page? (:block/uuid (first transformed-query-result)))
(let [result (db-utils/group-by-page transformed-query-result)]
(if (map? result)
(dissoc result nil)
result))
transformed-query-result)]
(when query-atom
(util/safe-with-meta result (meta @query-atom))))))
(rum/defcs custom-query-inner < rum/reactive
[state config {:keys [query children? breadcrumb-show?]}
{:keys [query-error-atom
@@ -202,8 +143,7 @@
state)}
(rum/local nil ::query-result)
{:init (fn [state] (assoc state :query-error (atom nil)))}
[state config {:keys [title builder query view collapsed? table-view?
result-transform group-by-page?] :as q} *query-triggered?]
[state config {:keys [title builder query view collapsed? table-view?] :as q} *query-triggered?]
(let [*query-error (:query-error state)
built-in? (built-in-custom-query? title)
dsl-query? (:dsl-query? config)
@@ -227,12 +167,8 @@
full-text-search? (and dsl-query?
(util/electron?)
(symbol? (gp-util/safe-read-string query)))
group-by-page? (or group-by-page?
(and (not table?)
(not result-transform)
(not (and (string? query) (string/includes? query "(by-page false)")))))
result (when (or built-in-collapsed? (not collapsed?'))
(get-query-result state config *query-error *query-triggered? current-block-uuid q group-by-page?))
(query-result/get-query-result state config *query-error *query-triggered? current-block-uuid q {:table? table?}))
query-time (:query-time (meta result))
page-list? (and (seq result)
(some? (:block/name (first result))))
@@ -243,7 +179,7 @@
:view-f view-f
:page-list? page-list?
:result result
:group-by-page? group-by-page?}]
:group-by-page? (query-result/get-group-by-page q {:table? table?})}]
(if (:custom-query? config)
[:code (if dsl-query?
(util/format "{{query %s}}" query)
@@ -293,7 +229,7 @@
(query-refresh-button query-time {:full-text-search? full-text-search?
:on-mouse-down (fn [e]
(util/stop e)
(trigger-custom-query! state *query-error *query-triggered?))}))]])])
(query-result/trigger-custom-query! state *query-error *query-triggered?))}))]])])
(when dsl-query? builder)

78
src/main/frontend/components/query/result.cljs Normal file
View File

@@ -0,0 +1,78 @@
(ns frontend.components.query.result
"Query result related functionality for query components"
(:require [frontend.db.utils :as db-utils]
[frontend.search :as search]
[frontend.db :as db]
[frontend.db.query-dsl :as query-dsl]
[frontend.state :as state]
[logseq.graph-parser.util :as gp-util]
[frontend.util :as util]
[clojure.string :as string]
[promesa.core :as p]
[rum.core :as rum]))
(defn trigger-custom-query!
[state *query-error *query-triggered?]
(let [[config query] (:rum/args state)
repo (state/get-current-repo)
result-atom (atom nil)
current-block-uuid (or (:block/uuid (:block config))
(:block/uuid config))
_ (reset! *query-error nil)
query-atom (try
(cond
(:dsl-query? config)
(let [q (:query query)
form (gp-util/safe-read-string q)]
(cond
;; Searches like 'foo' or 'foo bar' come back as symbols
;; and are meant to go directly to full text search
(and (util/electron?) (symbol? form)) ; full-text search
(p/let [blocks (search/block-search repo (string/trim (str form)) {:limit 30})]
(when (seq blocks)
(let [result (db/pull-many (state/get-current-repo) '[*] (map (fn [b] [:block/uuid (uuid (:block/uuid b))]) blocks))]
(reset! result-atom result))))
(symbol? form)
(atom nil)
:else
(query-dsl/query (state/get-current-repo) q)))
:else
(db/custom-query query {:current-block-uuid current-block-uuid}))
(catch :default e
(reset! *query-error e)
(atom nil)))]
(when *query-triggered?
(reset! *query-triggered? true))
(if (instance? Atom query-atom)
query-atom
result-atom)))
(defn get-group-by-page [{:keys [result-transform query] :as q}
{:keys [table?]}]
(if table?
false ;; Immediately return false as table view can't handle grouping
(get q :group-by-page?
(and (not result-transform)
(not (and (string? query) (string/includes? query "(by-page false)")))))))
(defn get-query-result
[state config *query-error *query-triggered? current-block-uuid q options]
(or (when-let [*result (:query-result config)] @*result)
(let [query-atom (trigger-custom-query! state *query-error *query-triggered?)
query-result (and query-atom (rum/react query-atom))
;; exclude the current one, otherwise it'll loop forever
remove-blocks (if current-block-uuid [current-block-uuid] nil)
transformed-query-result (when query-result
(db/custom-query-result-transform query-result remove-blocks q))
group-by-page? (get-group-by-page q options)
result (if (and group-by-page? (:block/uuid (first transformed-query-result)))
(let [result (db-utils/group-by-page transformed-query-result)]
(if (map? result)
(dissoc result nil)
result))
transformed-query-result)]
(when query-atom
(util/safe-with-meta result (meta @query-atom))))))

65
src/test/frontend/components/query/result_test.cljs Normal file
View File

@@ -0,0 +1,65 @@
(ns frontend.components.query.result-test
(:require [clojure.test :refer [deftest are testing is]]
[rum.core :as rum]
[frontend.db :as db]
[frontend.db.model :as model]
[frontend.components.query.result :as query-result]))
(defn- mock-get-query-result
"Mocks get-query-result assuming custom queries are being tested. Db calls are
mocked to minimize setup"
[result query {:keys [table? current-block-uuid]}]
(with-redefs [db/custom-query (constantly (atom result))
model/with-pages identity]
(binding [rum/*reactions* (volatile! #{})]
(#'query-result/get-query-result {} {} (atom nil) (atom nil) current-block-uuid query {:table? table?}))))
(deftest get-query-result
(let [result [{:block/uuid (random-uuid) :block/scheduled 20230418 :block/page {:db/id 1}}
{:block/uuid (random-uuid) :block/scheduled 20230415 :block/page {:db/id 1}}
{:block/uuid (random-uuid) :block/scheduled 20230417 :block/page {:db/id 1}}]
sorted-result (sort-by :block/scheduled result)]
(testing "For list view"
(are [query expected]
(= expected (mock-get-query-result result query {:table? false}))
;; Default list behavior is to group result
{}
{{:db/id 1} result}
;; User overrides default behavior to return result
{:group-by-page? false}
result
;; Return transformed result for list view
{:result-transform '(partial sort-by :block/scheduled)}
sorted-result
; User overrides transform to return grouped result
{:result-transform '(partial sort-by :block/scheduled) :group-by-page? true}
{{:db/id 1} sorted-result})
(testing "For table view"
(are [query expected]
(= expected (mock-get-query-result result query {:table? true}))
;; Default table behavior is to return result
{}
result
;; Return transformed result
{:result-transform '(partial sort-by :block/scheduled)}
sorted-result
;; Ignore override and return normal result
{:group-by-page? true}
result))
(testing "current block in results"
(is (= result
(let [current-block {:block/uuid (random-uuid) :block/scheduled 20230420 :block/page {:db/id 1}}]
(mock-get-query-result (conj result current-block)
{:group-by-page? false}
{:table? false
:current-block-uuid (:block/uuid current-block)})))
"Current block is not included in results")))))