path: root/tests/test-pearl-views.el

;;; test-pearl-views.el --- Tests for Linear Custom Views -*- lexical-binding: t; -*-

;; Copyright (C) 2026 Craig Jennings

;; Author: Craig Jennings <c@cjennings.net>

;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; Tests for reading and running Linear Custom Views: the cached views list,
;; the server-side `--query-view-async' run, `pearl-run-linear-view', the view
;; branch of refresh, and opening the active view in the browser.  HTTP is
;; stubbed.

;;; Code:

(require 'test-bootstrap (expand-file-name "test-bootstrap.el"))
(require 'testutil-request (expand-file-name "testutil-request.el"))
(require 'cl-lib)

;;; --query-view-async

(ert-deftest test-pearl-query-view-async-extracts-issues ()
  "Running a view extracts the server-side issue nodes into an ok result."
  (testutil-linear-with-response
      '((data (customView
               (issues (nodes . [((id . "i1") (identifier . "ENG-1") (title . "A"))])
                       (pageInfo (hasNextPage . :json-false) (endCursor . nil))))))
    (let (result)
      (pearl--query-view-async "view-1" (lambda (r) (setq result r)))
      (should (eq 'ok (pearl--query-result-status result)))
      (should (= 1 (length (pearl--query-result-issues result)))))))

;;; --custom-views (cached)

(ert-deftest test-pearl-custom-views-caches ()
  "The views list is fetched once and served from cache."
  (let ((pearl-api-key "test-key")
        (pearl--cache-views nil)
        (calls 0))
    (cl-letf (((symbol-function 'request)
               (lambda (_url &rest args)
                 (cl-incf calls)
                 (funcall (plist-get args :success) :data
                          '((data (customViews
                                   (nodes . [((id . "v1") (name . "My View"))])
                                   (pageInfo (hasNextPage . :json-false)))))))))
      (let ((views (pearl--custom-views)))
        (should (= 1 (length views)))
        (pearl--custom-views)
        (should (= 1 calls))))))

(ert-deftest test-pearl-custom-views-query-omits-url ()
  "The Custom Views list query must not select the unsupported `url' field.
Linear's `CustomView' type has no `url'; requesting it 400s the whole query
and leaves the run-view picker empty (the 2026-06-02 regression)."
  (should-not (string-match-p "\\burl\\b" (pearl--custom-views-query))))

;;; --org-url-key (cached) and --view-url (reconstructed)

(ert-deftest test-pearl-org-url-key-caches ()
  "The workspace url key is fetched once and served from cache."
  (let ((pearl-api-key "test-key")
        (pearl--cache-org-url-key nil)
        (calls 0))
    (cl-letf (((symbol-function 'request)
               (lambda (_url &rest args)
                 (cl-incf calls)
                 (funcall (plist-get args :success) :data
                          '((data (organization (urlKey . "deepsat"))))))))
      (should (string= "deepsat" (pearl--org-url-key)))
      (pearl--org-url-key)
      (should (= 1 calls)))))

(ert-deftest test-pearl-view-url-builds-from-urlkey ()
  "A view's web URL is reconstructed from the workspace url key and view id."
  (cl-letf (((symbol-function 'pearl--org-url-key) (lambda (&optional _) "deepsat")))
    (should (string= "https://linear.app/deepsat/view/abc123"
                     (pearl--view-url "abc123")))))

(ert-deftest test-pearl-view-url-nil-when-no-urlkey ()
  "With no workspace url key, the view URL is nil so callers degrade gracefully."
  (cl-letf (((symbol-function 'pearl--org-url-key) (lambda (&optional _) nil)))
    (should-not (pearl--view-url "abc123"))))

(ert-deftest test-pearl-view-url-nil-when-empty-view-id ()
  "A nil or empty view id yields no URL rather than a malformed link."
  (cl-letf (((symbol-function 'pearl--org-url-key) (lambda (&optional _) "deepsat")))
    (should-not (pearl--view-url nil))
    (should-not (pearl--view-url ""))))

;;; view sort — match the Linear view's configured ordering

(ert-deftest test-pearl-view-sort-arg-maps-priority-desc ()
  "A priority ordering with desc direction maps to an IssueSortInput list."
  (should (equal (vector '(("priority" ("order" . "Descending"))))
                 (pearl--view-sort-arg "priority" "desc"))))

(ert-deftest test-pearl-view-sort-arg-honors-asc-direction ()
  "An asc direction maps to Ascending."
  (should (equal (vector '(("accumulatedStateUpdatedAt" ("order" . "Ascending"))))
                 (pearl--view-sort-arg "accumulatedStateUpdatedAt" "asc"))))

(ert-deftest test-pearl-view-sort-arg-defaults-nil-direction-to-descending ()
  "A nil direction defaults to Descending — the field's natural order, and what
Linear's UI shows for a priority view with no explicit direction."
  (should (equal (vector '(("priority" ("order" . "Descending"))))
                 (pearl--view-sort-arg "priority" nil))))

(ert-deftest test-pearl-view-sort-arg-unsupported-ordering-is-nil ()
  "An ordering with no IssueSortInput key yields nil, so the caller falls back
to the default sort rather than sending an invalid sort key."
  (should-not (pearl--view-sort-arg "someExoticOrdering" "asc")))

(ert-deftest test-pearl-view-issues-query-accepts-sort ()
  "The view issues query declares the sort variable and forwards it to the
issues connection, so a view runs under a chosen order."
  (let ((q (pearl--view-issues-query)))
    (should (string-match-p "\\$sort: \\[IssueSortInput!\\]" q))
    (should (string-match-p "sort: \\$sort" q))))

;;; --view-completed-filter (showCompletedIssues -> IssueFilter)

(ert-deftest test-pearl-view-completed-filter-all-is-nil ()
  "showCompletedIssues \"all\" means show everything, so no extra filter is
added — today's behavior, and the open clause never hides anything."
  (should-not (pearl--view-completed-filter "all")))

(ert-deftest test-pearl-view-completed-filter-nil-is-nil ()
  "A view with no recorded preference adds no filter."
  (should-not (pearl--view-completed-filter nil)))

(ert-deftest test-pearl-view-completed-filter-unknown-is-nil ()
  "An unrecognized preference value adds no filter rather than risk hiding open
work — pearl degrades to showing everything, the same as \"all\"."
  (should-not (pearl--view-completed-filter "someFutureValue")))

(ert-deftest test-pearl-view-completed-filter-none-excludes-closed-types ()
  "showCompletedIssues \"none\" restricts to open issues by excluding the closed
state types (completed, canceled, duplicate) that Linear's UI hides."
  (should (equal '(("state" ("type" ("nin" . ["completed" "canceled" "duplicate"]))))
                 (pearl--view-completed-filter "none"))))

(ert-deftest test-pearl-view-completed-filter-window-ors-open-and-recent ()
  "A recency window (e.g. \"week\") shows open issues OR issues completed or
canceled within the window, mirroring Linear's \"completed in the past week\"."
  (let* ((now (date-to-time "2026-06-08T12:00:00Z"))
         (f (pearl--view-completed-filter "week" now)))
    (should (equal
             '(("or" . [(("state" ("type" ("nin" . ["completed" "canceled" "duplicate"]))))
                        (("completedAt" ("gte" . "2026-06-01T12:00:00.000Z")))
                        (("canceledAt" ("gte" . "2026-06-01T12:00:00.000Z")))]))
             f))))

(ert-deftest test-pearl-view-issues-query-accepts-filter ()
  "The view issues query declares the filter variable and forwards it to the
issues connection, so a view can drop completed issues server-side."
  (let ((q (pearl--view-issues-query)))
    (should (string-match-p "\\$filter: IssueFilter" q))
    (should (string-match-p "filter: \\$filter" q))))

(ert-deftest test-pearl-query-view-async-forwards-filter ()
  "A non-nil filter is sent as the `filter' GraphQL variable."
  (let ((sent 'unset))
    (cl-letf (((symbol-function 'pearl--graphql-request-async)
               (lambda (_q vars success &optional _err)
                 (setq sent (cdr (assoc "filter" vars)))
                 (funcall success
                          '((data (customView
                                   (issues (nodes . [])
                                           (pageInfo (hasNextPage . :json-false)
                                                     (endCursor))))))))))
      (pearl--query-view-async "v1" #'ignore nil '(("state" "x")))
      (should (equal '(("state" "x")) sent)))))

(ert-deftest test-pearl-query-view-async-omits-nil-filter ()
  "With no filter, no `filter' variable is sent (the connection sees no filter,
matching a view whose preference shows all issues)."
  (let ((had-key 'unset))
    (cl-letf (((symbol-function 'pearl--graphql-request-async)
               (lambda (_q vars success &optional _err)
                 (setq had-key (and (assoc "filter" vars) t))
                 (funcall success
                          '((data (customView
                                   (issues (nodes . [])
                                           (pageInfo (hasNextPage . :json-false)
                                                     (endCursor))))))))))
      (pearl--query-view-async "v1" #'ignore nil nil)
      (should-not had-key))))

(ert-deftest test-pearl-query-view-async-defaults-sort-to-updated-desc ()
  "With no explicit sort, a view runs under updatedAt-desc rather than Linear's
createdAt-desc API default, so its order matches the rest of pearl."
  (let ((sent 'unset))
    (cl-letf (((symbol-function 'pearl--graphql-request-async)
               (lambda (_q vars success &optional _err)
                 (setq sent (cdr (assoc "sort" vars)))
                 (funcall success
                          '((data (customView
                                   (issues (nodes . [])
                                           (pageInfo (hasNextPage . :json-false)
                                                     (endCursor))))))))))
      (pearl--query-view-async "v1" #'ignore)
      (should (equal pearl--default-issue-sort sent)))))

;;; run-view

(ert-deftest test-pearl-run-view-renders-with-view-source ()
  "Running a view resolves its id and renders with a view-typed source."
  (let ((ran-id nil) (rendered-source nil))
    (cl-letf (((symbol-function 'pearl--custom-views)
               (lambda (&optional _force)
                 ;; Nodes carry no `url' -- Linear's CustomView has none; the
                 ;; source URL is reconstructed from the workspace url key.
                 '(((id . "v1") (name . "My View")))))
              ((symbol-function 'pearl--org-url-key) (lambda (&optional _) "deepsat"))
              ((symbol-function 'pearl--query-view-async)
               (lambda (id cb &optional _sort _filter) (setq ran-id id)
                 (funcall cb (pearl--make-query-result 'ok :issues nil))))
              ((symbol-function 'pearl--render-query-result)
               (lambda (_result source) (setq rendered-source source))))
      (pearl-run-linear-view "My View")
      (should (string= "v1" ran-id))
      (should (eq 'view (plist-get rendered-source :type)))
      (should (string= "v1" (plist-get rendered-source :id)))
      (should (string= "https://linear.app/deepsat/view/v1"
                       (plist-get rendered-source :url))))))

(ert-deftest test-pearl-run-view-applies-and-stamps-view-sort ()
  "Running a view resolves its configured ordering, passes it to the query, and
records it on the source so a later refresh reuses the same order."
  (let ((passed-sort 'unset) (rendered-source nil))
    (cl-letf (((symbol-function 'pearl--custom-views)
               (lambda (&optional _force)
                 '(((id . "v1") (name . "My View")
                    (viewPreferencesValues (viewOrdering . "priority")
                                           (viewOrderingDirection . "desc"))))))
              ((symbol-function 'pearl--org-url-key) (lambda (&optional _) "deepsat"))
              ((symbol-function 'pearl--query-view-async)
               (lambda (_id cb &optional sort _filter) (setq passed-sort sort)
                 (funcall cb (pearl--make-query-result 'ok :issues nil))))
              ((symbol-function 'pearl--render-query-result)
               (lambda (_result source) (setq rendered-source source))))
      (pearl-run-linear-view "My View")
      (should (equal (vector '(("priority" ("order" . "Descending")))) passed-sort))
      (should (equal (vector '(("priority" ("order" . "Descending"))))
                     (plist-get rendered-source :sort))))))

(ert-deftest test-pearl-run-view-applies-and-stamps-show-completed ()
  "Running a view reads its showCompletedIssues preference, passes the matching
filter to the query, and records the raw preference on the source so a later
refresh rebuilds the window relative to the refresh time."
  (let ((passed-filter 'unset) (rendered-source nil))
    (cl-letf (((symbol-function 'pearl--custom-views)
               (lambda (&optional _force)
                 '(((id . "v1") (name . "My View")
                    (viewPreferencesValues (showCompletedIssues . "none"))))))
              ((symbol-function 'pearl--org-url-key) (lambda (&optional _) "deepsat"))
              ((symbol-function 'pearl--query-view-async)
               (lambda (_id cb &optional _sort filter) (setq passed-filter filter)
                 (funcall cb (pearl--make-query-result 'ok :issues nil))))
              ((symbol-function 'pearl--render-query-result)
               (lambda (_result source) (setq rendered-source source))))
      (pearl-run-linear-view "My View")
      (should (equal '(("state" ("type" ("nin" . ["completed" "canceled" "duplicate"]))))
                     passed-filter))
      (should (string= "none" (plist-get rendered-source :show-completed))))))

;;; --view-node-prefs and --run-view-source (favorited view dispatch)

(ert-deftest test-pearl-view-node-prefs-extracts-sort-and-show-completed ()
  "A Custom View node's preferences resolve to its IssueSortInput sort and raw
showCompletedIssues string."
  (let ((prefs (pearl--view-node-prefs
                '((id . "v1")
                  (viewPreferencesValues (viewOrdering . "priority")
                                         (viewOrderingDirection . "desc")
                                         (showCompletedIssues . "none"))))))
    (should (equal (vector '(("priority" ("order" . "Descending"))))
                   (plist-get prefs :sort)))
    (should (string= "none" (plist-get prefs :show-completed)))))

(ert-deftest test-pearl-view-node-prefs-nil-node-is-all-nil ()
  "A nil node (a favorite referencing a view the list query didn't return) yields
nil sort and nil show-completed, so the caller falls back to house defaults."
  (let ((prefs (pearl--view-node-prefs nil)))
    (should-not (plist-get prefs :sort))
    (should-not (plist-get prefs :show-completed))))

(ert-deftest test-pearl-run-view-source-resolves-prefs-by-id-and-stamps ()
  "A favorited view source (no preferences of its own) resolves the view's sort
and showCompletedIssues from the cached Custom Views, forwards both to the query,
and stamps them on the source so a refresh reuses them — closing the gap where
the pick-source path showed a view's completed/canceled issues and ignored sort."
  (let ((passed-sort 'unset) (passed-filter 'unset) (rendered-source nil))
    (cl-letf (((symbol-function 'pearl--custom-views)
               (lambda (&optional _force)
                 '(((id . "v1") (name . "My View")
                    (viewPreferencesValues (viewOrdering . "priority")
                                           (viewOrderingDirection . "desc")
                                           (showCompletedIssues . "none"))))))
              ((symbol-function 'pearl--query-view-async)
               (lambda (_id cb &optional sort filter)
                 (setq passed-sort sort passed-filter filter)
                 (funcall cb (pearl--make-query-result 'ok :issues nil))))
              ((symbol-function 'pearl--render-query-result)
               (lambda (_result source) (setq rendered-source source))))
      (pearl--run-view-source '(:type view :name "My View" :id "v1" :url "https://x"))
      (should (equal (vector '(("priority" ("order" . "Descending")))) passed-sort))
      (should (equal '(("state" ("type" ("nin" . ["completed" "canceled" "duplicate"]))))
                     passed-filter))
      (should (string= "none" (plist-get rendered-source :show-completed)))
      ;; The favorite's own keys survive the enrichment.
      (should (string= "https://x" (plist-get rendered-source :url))))))

;;; --view-grouping-active-p / --view-group-label / --group-issues

(ert-deftest test-pearl-view-grouping-active-p-supported-types ()
  "The single-valued grouping dimensions are active in v1."
  (dolist (g '("workflowState" "project" "assignee" "priority" "cycle"))
    (should (pearl--view-grouping-active-p g))))

(ert-deftest test-pearl-view-grouping-active-p-deferred-and-none ()
  "Label-grouping (multi-valued, deferred), none, nil, and unknown values are
inactive, so the view renders flat."
  (dolist (g '("label" "none" nil "someFutureGrouping"))
    (should-not (pearl--view-grouping-active-p g))))

(ert-deftest test-pearl-view-group-label-by-dimension ()
  "Each supported grouping resolves an issue to its group label."
  (let ((issue '(:state (:name "In Progress" :type "started")
                 :project (:name "Orchestration")
                 :assignee (:name "Eric")
                 :priority 1
                 :cycle (:number 4 :name "Sprint 4"))))
    (should (string= "In Progress" (pearl--view-group-label issue "workflowState")))
    (should (string= "Orchestration" (pearl--view-group-label issue "project")))
    (should (string= "Eric" (pearl--view-group-label issue "assignee")))
    (should (string= "Urgent" (pearl--view-group-label issue "priority")))
    (should (string= "Sprint 4" (pearl--view-group-label issue "cycle")))))

(ert-deftest test-pearl-view-group-label-missing-values ()
  "A missing dimension value gets a stable \"No X\" bucket label, matching how
Linear shows unset issues in a grouped view."
  (let ((issue '(:priority 0)))
    (should (string= "No status" (pearl--view-group-label issue "workflowState")))
    (should (string= "No project" (pearl--view-group-label issue "project")))
    (should (string= "No assignee" (pearl--view-group-label issue "assignee")))
    (should (string= "No cycle" (pearl--view-group-label issue "cycle")))
    (should (string= "None" (pearl--view-group-label issue "priority")))))

(ert-deftest test-pearl-view-group-label-cycle-number-fallback ()
  "A cycle with no name falls back to its number."
  (should (string= "Cycle 7"
                   (pearl--view-group-label '(:cycle (:number 7)) "cycle"))))

(ert-deftest test-pearl-group-issues-inactive-is-nil ()
  "An inactive grouping returns nil, signaling the caller to render flat."
  (should-not (pearl--group-issues '((:id "a" :state (:name "Todo"))) "none"))
  (should-not (pearl--group-issues '((:id "a" :state (:name "Todo"))) nil)))

(ert-deftest test-pearl-group-issues-orders-by-first-appearance ()
  "Groups appear in the order their first issue does; issues keep their input
order within a group (the layer-1 sort is preserved inside each section)."
  (let* ((issues '((:id "1" :state (:name "Started"))
                   (:id "2" :state (:name "Backlog"))
                   (:id "3" :state (:name "Started"))
                   (:id "4" :state (:name "Backlog"))))
         (groups (pearl--group-issues issues "workflowState")))
    (should (equal '("Started" "Backlog") (mapcar #'car groups)))
    (should (equal '("1" "3") (mapcar (lambda (i) (plist-get i :id))
                                      (cdr (assoc "Started" groups)))))
    (should (equal '("2" "4") (mapcar (lambda (i) (plist-get i :id))
                                      (cdr (assoc "Backlog" groups)))))))

;;; --view-node-prefs carries grouping

(ert-deftest test-pearl-view-node-prefs-extracts-grouping ()
  "The view node's issueGrouping is read into :group alongside sort and
show-completed, so run/refresh can section the issues."
  (let ((prefs (pearl--view-node-prefs
                '((id . "v1")
                  (viewPreferencesValues (issueGrouping . "workflowState"))))))
    (should (string= "workflowState" (plist-get prefs :group)))))

;;; refresh-current-view, view branch

(ert-deftest test-pearl-refresh-current-view-runs-view-source ()
  "Refresh on a view source calls the view query, not the filter query."
  (let ((view-ran nil)
        (source '(:type view :name "My View" :id "v1" :url "https://x")))
    (with-temp-buffer
      (insert (format "#+title: Linear — My View\n#+LINEAR-SOURCE: %s\n\n"
                      (prin1-to-string source)))
      (org-mode)
      (cl-letf (((symbol-function 'pearl--query-view-async)
                 (lambda (id cb &optional _sort _filter) (setq view-ran id)
                   (funcall cb (pearl--make-query-result 'ok :issues nil))))
                ((symbol-function 'pearl--merge-query-result)
                 (lambda (&rest _) nil)))
        (pearl-refresh-current-view)
        (should (string= "v1" view-ran))))))

(ert-deftest test-pearl-refresh-current-view-passes-stored-sort ()
  "Refreshing a view source forwards the :sort recorded on it, so the refreshed
list keeps the order the view was run under."
  (let ((passed-sort 'unset)
        (source '(:type view :name "My View" :id "v1"
                  :sort [(("priority" ("order" . "Descending")))])))
    (with-temp-buffer
      (insert (format "#+LINEAR-SOURCE: %s\n\n" (prin1-to-string source)))
      (org-mode)
      (cl-letf (((symbol-function 'pearl--query-view-async)
                 (lambda (_id cb &optional sort _filter) (setq passed-sort sort)
                   (funcall cb (pearl--make-query-result 'ok :issues nil))))
                ((symbol-function 'pearl--merge-query-result)
                 (lambda (&rest _) nil)))
        (pearl-refresh-current-view)
        (should (equal [(("priority" ("order" . "Descending")))] passed-sort))))))

(ert-deftest test-pearl-refresh-current-view-rebuilds-show-completed-filter ()
  "Refreshing a view source rebuilds the completed-issues filter from the raw
`:show-completed' it recorded, so an open-only view stays open-only on refresh."
  (let ((passed-filter 'unset)
        (source '(:type view :name "My View" :id "v1" :show-completed "none")))
    (with-temp-buffer
      (insert (format "#+LINEAR-SOURCE: %s\n\n" (prin1-to-string source)))
      (org-mode)
      (cl-letf (((symbol-function 'pearl--query-view-async)
                 (lambda (_id cb &optional _sort filter) (setq passed-filter filter)
                   (funcall cb (pearl--make-query-result 'ok :issues nil))))
                ((symbol-function 'pearl--merge-query-result)
                 (lambda (&rest _) nil)))
        (pearl-refresh-current-view)
        (should (equal '(("state" ("type" ("nin" . ["completed" "canceled" "duplicate"]))))
                       passed-filter))))))

;;; open-current-view-in-linear

(ert-deftest test-pearl-open-current-view-visits-url ()
  "Opening the active view visits the source's url."
  (let ((visited nil)
        (source '(:type view :name "My View" :id "v1" :url "https://linear.app/view/v1")))
    (with-temp-buffer
      (insert (format "#+LINEAR-SOURCE: %s\n" (prin1-to-string source)))
      (org-mode)
      (cl-letf (((symbol-function 'browse-url) (lambda (u &rest _) (setq visited u))))
        (pearl-open-current-view-in-linear)
        (should (string= "https://linear.app/view/v1" visited))))))

(ert-deftest test-pearl-open-current-view-no-url-errors ()
  "Opening a non-view or url-less source signals a user error."
  (let ((source '(:type filter :name "My open issues" :filter (:assignee :me))))
    (with-temp-buffer
      (insert (format "#+LINEAR-SOURCE: %s\n" (prin1-to-string source)))
      (org-mode)
      (should-error (pearl-open-current-view-in-linear) :type 'user-error))))

;;; the view query fetches comments too

(ert-deftest test-pearl-view-issues-query-requests-comments ()
  "The Custom View query selects capped, newest-first comments by default."
  (let ((pearl-fetch-comments-in-list t)
        (pearl-list-comments-count-cap 25))
    (should (string-match-p "comments(first: 26, orderBy: createdAt)[[:space:]]*{[[:space:]]*nodes"
                            (pearl--view-issues-query)))))

(provide 'test-pearl-views)
;;; test-pearl-views.el ends here