Skip to content

Test API #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
emoonrain wants to merge 3 commits into
base: dummy1
Choose a base branch
from
Open

Test API #4

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4cf4f23
RCasR initial commit to enrich GH details returned.
andrelkin Aug 27, 2022
bce7b0e
Intermediate commit.
andrelkin Sep 5, 2022
4d84c07
more details at fetching etc.
andrelkin Mar 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
283 changes: 266 additions & 17 deletions github-review.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,16 @@ return a deferred object"
(let ((query (format "query {
repository(name: \"%s\", owner: \"%s\") {
pullRequest(number: %s){
reviewThreads(first: 100) { edges { node {comments(first: 10) {
Copy link
Owner

@andrelkin andrelkin Sep 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1.1 reviewThreads view should be sufficient.

Copy link
Author

@emoonrain emoonrain Sep 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2.1 reply to the review's 1.1.

Copy link
Owner

@andrelkin andrelkin Sep 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A 5th(?) 5.0 multi-comment hopefully multi-commit review starts to reply 2.1.

Copy link
Author

@emoonrain emoonrain Sep 10, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2.0 Starts the 2nd view.

Copy link
Owner

@andrelkin andrelkin Sep 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A reply to 2.0 as solitary comment over the 1-2 commit range patch. Expected originalCommitId = HEAD.

Copy link
Owner

@andrelkin andrelkin Sep 11, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A solitary comment review reply via HEAD~1 commit to prove it'd be original-commit-id.

nodes {
pullRequestReview {
id
}
body
}
}
}}}
baseRef { target{ oid } }
headRef { target{ oid } }
title
bodyText
Expand All @@ -140,16 +150,31 @@ return a deferred object"
(query-with-comments (format "query {
repository(name: \"%s\", owner: \"%s\") {
pullRequest(number: %s){
reviewThreads(first: 100) { edges { node {comments(first: 10) {
nodes {
pullRequestReview {
id
}
body
}
}
}}}
baseRef { target{ oid } }
baseRefName
headRef { target{ oid } }
headRefName
commits(first:100) { nodes {
commit { message abbreviatedOid }
}}
title
bodyText
comments(first:50) {
nodes { author { login } bodyText }
nodes { author { login } bodyText}
}
reviews(first: 50) {
nodes { author { login } bodyText state
nodes { author { login } bodyText state databaseId commit { abbreviatedOid }
comments(first: 50)
{ nodes { bodyText originalPosition position outdated path databaseId} }}
{ nodes { createdAt author { login } updatedAt bodyText originalPosition position outdated path databaseId originalCommit { abbreviatedOid } replyTo { author { login } databaseId } resourcePath} }}
} }
Copy link
Owner

@andrelkin andrelkin Sep 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1.2. It's unclear how to make use of ReplyTo.

}
}" .repo .owner .num)))
Expand Down Expand Up @@ -374,17 +399,31 @@ ACC is an alist accumulating parsing state."
'repo (match-string 2 url)
'owner (match-string 1 url)))))

(defun github-review-save-diff (pr-alist diff)
(defun github-review-save-diff (pr-alist diff pr-base)
"Save a DIFF (string) to a temp file named after pr specified by PR-ALIST."
(let-alist pr-alist
(find-file (format "%s/%s___%s___%s___%s.diff" github-review-review-folder .owner .repo .num .sha))
(erase-buffer)
(insert diff)
(let ((inhibit-read-only t)
(erase-buffer)
(insert diff))
(let-alist pr-base
(insert
(concat "\n\n"
";;; Local Variables:\n" ";;; gh-base-id: "
.sha.baseRef.target.oid "\n"))
;; fetch .sha.baseRefName branch
;; check it out into a WT
;; for each commit in RCs
;; create the-branch
;; find and sort RCs(commit).comments into C[]
;; to apply C[i] one by one
))
(save-buffer)
(github-review-mode)
;; Use `C-c C-c' in diff-mode to go to source code
(setq default-directory forge-current-dir)
(goto-char (point-min))))
;;(setq default-directory forge-current-dir)
(goto-char (point-min))
))

(defun github-review-parsed-review-from-current-buffer ()
"Return a code review given the current buffer containing a diff."
Expand Down Expand Up @@ -555,6 +594,15 @@ Github API provides only the originalPosition in the query.")
gitdiff
comments))))

(defvar github-review-view-comments-in-code-lines-old-style nil "embed sources code comments into the total diff")
(defvar my-status-review-base nil "the review code branch magit status buffer")
(defvar my-ghr-worktree-path "/media/local_17/src/emacs/git/WTs/GHR_A")
(defclass my-ghr-comment ()
((gh-node :initarg :gh-node)
(commit-id :initarg :commit-id)
(parent :initarg :parent) ;; databaseId
(kids :initarg :kids)))

(defun github-review-format-diff (gitdiff pr)
"Formats a GITDIFF and PR to save it for review."
(let-alist pr
Expand All @@ -580,16 +628,206 @@ Github API provides only the originalPosition in the query.")
(-map #'github-review-format-review reviews)))
"\n"))
(if github-review-view-comments-in-code-lines
(progn
(let ((comment-tree '())
(commit-list)
(review-alist '()))
(save-excursion
;; (magit-fetch-branch REMOTE BRANCH ARGS)
;; (magit-fetch-branch "origin" (concat "+" .headRefName ":" .headRefName) '())
(magit-fetch-branch "origin" (concat "" .headRefName ":" .headRefName) '())
(setq my-status-review-base
(let ()
;; TODO: configure WTs
;;(magit-with-toplevel
;;(magit-worktree-checkout my-ghr-worktree-path .headRefName)
;;(magit-branch-create (concat .headRefName "-review") .headRefName) ;;"lc--mvp-review-commit__review"
;;(magit-reset-hard (concat .headRefName "-review"))
;; (magit-checkout (concat .headRefName "-review"))
;;(magit-worktree-branch my-ghr-worktree-path (concat .headRefName "-review") .headRefName t)

(magit-diff-visit-directory my-ghr-worktree-path nil)
;;(magit-reset-hard (concat .headRefName "-review"))
(current-buffer)
;; )
)))

(setq github-review-comment-pos ())
(setq github-review-pos->databaseid ())
(-reduce-from
(lambda (acc-gitdiff node)
(github-review-place-review-comments acc-gitdiff node))
(a-get gitdiff 'message)
.reviews.nodes))
;; TODO: sort .reviews.nodes
;; 1. build sorted commit-id list
(setq commit-list (seq-map #'(lambda (el) (a-get-in el (list 'commit 'abbreviatedOid))) .commits.nodes))
;; 2. ...d
;; (set-sort ...
(setq review-alist
(cl-loop for commit-id in commit-list collect
(list commit-id
(seq-sort #'(lambda (a b) (< (a-get-in a (list 'databaseId)) (a-get-in b (list 'databaseId))))
(cl-loop for r-node in .reviews.nodes append
(seq-filter
#'(lambda (el)
(when
(string=
commit-id
(a-get-in el (list 'originalCommit 'abbreviatedOid)))
(let ()
(nconc el (list (cons 'review-db-id (a-get r-node 'databaseId))))
t)))
;; cut other branches from type PullRequestReview includ databaseId
(a-get-in r-node (list 'comments 'nodes))))))))
(cl-loop for rev in review-alist do
(let ((commit-id (car rev))
(comment-s (car (cdr rev))))
(save-excursion
(set-buffer my-status-review-base)
(magit-reset-hard "HEAD") ; minor cleanup from past activities on this WT
(when
(magit-call-git "diff" "--exit-code" (concat commit-id "..." .headRefName))
;; internal commit
(if (magit-commit-p (concat .headRefName "-review-" commit-id))
(magit-checkout (concat .headRefName "-review-" commit-id))
(magit-branch-or-checkout (concat .headRefName "-review-" commit-id) commit-id))
(magit-show-commit commit-id)
;;(-map #'(lambda (comment) (handle-one-comment comment commit-id headrefname)) comments)
(message
(concat "Review commets over commit " commit-id " in the branch " .headRefName))
(cl-map nil #'(lambda (comment) (handle-one-comment comment commit-id .headRefName)) comment-s)
;;(basic-save-buffer nil)
;;(magit-refresh)
;;(let ((buffer-save-without-query t))
(magit-save-repository-buffers t)
(magit-stash-save (cl-concatenate 'string "Review comments for " commit-id) nil t nil t 'index)))))

(if github-review-view-comments-in-code-lines-old-style
(-reduce-from
(lambda (acc-gitdiff node)
(github-review-place-review-comments acc-gitdiff node))
(a-get gitdiff 'message)
.reviews.nodes) ;; could do better ... review-alist
;; else if old
(a-get gitdiff 'message)))
;; else if
(a-get gitdiff 'message)))))

;; commit-id determs the review branch, which original-commit-id
;; is to find the review comment anchor.
(defun handle-one-comment (comment commit-id headrefname)
(let* ((path (a-get comment 'path))
(reply-to-id (a-get-in comment (list 'replyTo 'databaseId)))
(id-comment (a-get-in comment (list 'databaseId)))
(updated-at (a-get comment 'updatedAt))
(author (a-get-in comment (list 'author 'login)))
;; todo/fixme: this is a wrong handling. orig-pos is for review-sub-branches
(original-pos (a-get comment 'originalPosition))
;;(-position (a-get comment 'position))
;;(position (when (numberp -position) -position))
(position (a-get comment 'position))
(outdated (a-get comment 'outdated))
(adjusted-pos)
;; todo: refine into review-sub-branches, one per original commit
(original-commit-id (a-get-in comment (list 'originalCommit 'abbreviatedOid)))
;;(buf-name (concat path "-" original-commit-id))
(buf-name (concat path "-" original-commit-id))
(comment-lines (split-string (a-get comment 'bodyText) "\n"))
(review-id (a-get comment 'review-db-id)))

;;;(if (null outdated)
(let ()
(setq adjusted-pos (+ original-pos 7)) ;; GH's + git "constant"

(message (concat "### Comment from review "
(number-to-string review-id)
" over " original-commit-id "id = "
(number-to-string id-comment)
(if (null reply-to-id) "" (concat " as reply-to " (number-to-string reply-to-id)))
" at " updated-at ": "
(let-alist comment .bodyText)
" applies on line " (number-to-string original-pos)))

;; todo/fixme set-buffer of the caller still holds
;; todo: support review per-commit sub-branches
;; (when (not (string= original-commit-id commit-id))
;; ;; assert original is parent
;; (magit-branch-or-checkout (concat headrefname "-review-" original-commit-id)))

(when (null (get-buffer buf-name))
(get-buffer-create buf-name)
(with-current-buffer buf-name
;;(magit-with-toplevel
(magit-git-insert "show" original-commit-id "--oneline" "--" "github-review.el")
;;)
(diff-mode)))
;; TODO: build review comment graph (a forest) with the ROOT message on the top.
;; Graph should be first complete "in memory" and inserted into the sources
;; at the end of all reviews processing.
(with-current-buffer buf-name
(goto-line adjusted-pos)
(save-excursion
(diff-goto-source) ;; TODO: account already created hunks that shift @@ base line
(let ((beg))
(newline)
(forward-line -1)
(insert comment-start)
(insert (concat "### Comment over " original-commit-id "id = "
(number-to-string id-comment)
" by " author
" at " updated-at
" adjusted pos = " (number-to-string adjusted-pos) ": "
(let-alist comment .bodyText)))
(setq beg (point))
(newline)
(mapcar #'(lambda (str) (insert str) (newline)) comment-lines)
(comment-region beg (point))
(basic-save-buffer nil)))
)
)
;; todo: handle with review-sub-branches
;; maybe (cl-assert (null position)) ?
;;;) ; outdated
)
)

(defun acc-diff-node (acc-gitdiff node)
(mygit-commit-node-to-review-branch node)
(github-review-place-review-comments acc-gitdiff node))

(defun insert-node-into-tree (tree node)
(let ((commit-id (a-get-in review (list 'commit 'abbreviatedOid))))
(if (null tree)
(setf (car tree) (list commit-id node))
(if ...)))

)

(defun mygit-commit-node-to-review-branch (review headrefname comment-tree)
(unless (not (a-get-in review (list 'comments 'nodes)))
(let* ((at (a-get-in review (list 'author 'login)))
(body (a-get review 'bodyText))
(body-lines (split-string body "\n"))
(state (a-get review 'state))
(comments (a-get-in review (list 'comments 'nodes)))
(default-shift-pos 1)
(commit-id (a-get-in review (list 'commit 'abbreviatedOid)))
(review-id (a-get-in review (list 'databaseId))))
;;( for each comment apply it )
(save-excursion
;; buffer may generally change with another review in the list
;; Todo: Sub-branch.
(set-buffer my-status-review-base)
(when (magit-call-git "diff" "--exit-code"
(concat commit-id "..." headrefname))
;; internal commit
(magit-branch-or-checkout (concat headrefname "-review-" commit-id) commit-id))

;; todo: for the review print (to where?) Author, createdAt, body-lines
(magit-show-commit commit-id)
(-map #'(lambda (comment) (handle-one-comment comment commit-id headrefname)) comments)
)
(message
(concat "Review of '" (or body "") "' having github id "
(number-to-string review-id) " over commit " commit-id
" in the branch " headrefname))
)))

;;;;;;;;;;;;;;;;;;;;;
;; User facing API ;;
;;;;;;;;;;;;;;;;;;;;;
Expand All @@ -601,15 +839,19 @@ Github API provides only the originalPosition in the query.")
(deferred:parallel
(lambda () (github-review-get-diff-deferred pr-alist))
(lambda () (github-review-get-pr-info-deferred pr-alist)))
;;(deferred:sync!
(deferred:nextc it
(lambda (x)
(let-alist (-second-item x)
(github-review-save-diff
(a-assoc pr-alist 'sha .data.repository.pullRequest.headRef.target.oid)
(github-review-format-diff (-first-item x) .data.repository.pullRequest)))))
(github-review-format-diff (-first-item x) .data.repository.pullRequest)
(a-assoc pr-alist 'sha .data.repository.pullRequest)))))
Copy link
Owner

@andrelkin andrelkin Sep 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A solitary commit review aka 3.0. Commit bc.. should reflect that in api call results.

Copy link
Owner

@andrelkin andrelkin Sep 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

5.1 on bc.. (to expect original-commit-id as that).

(deferred:error it
(lambda (err)
(message "Got an error from the GitHub API %S!" err)))))
(message "Got an error from the GitHub API %S!" err)))
;;) ;; sync!
))


;;;###autoload
Expand All @@ -632,7 +874,14 @@ Github API provides only the originalPosition in the query.")
(defun github-review-start (url)
"Start review given PR URL."
(interactive "sPR URL: ")
(github-review-start-internal (github-review-pr-from-url url)))
(let ((saved-frame (selected-frame))
(saved-win-conf (current-window-configuration)))
(window-configuration-to-register 99)
(github-review-start-internal (github-review-pr-from-url url))
(select-frame saved-frame)
(jump-to-register 99)
(set-window-configuration saved-win-conf))
)

;;;###autoload
(defun github-review-approve ()
Expand Down