;;; tvl.el --- description -*- lexical-binding: t; -*-
;;
;; Copyright (C) 2020 Griffin Smith
;; Copyright (C) 2020 The TVL Contributors
;;
;; Author: Griffin Smith <grfn@gws.fyi>
;; Version: 0.0.1
;; Package-Requires: (cl s magit)
;;
;; This file is not part of GNU Emacs.
;;
;;; Commentary:
;;
;; This file provides shared utilities for interacting with the TVL monorepo
;;
;;; Code:
(require 'magit)
(require 's)
(require 'cl) ; TODO(tazjin): replace lexical-let* with non-deprecated alternative
(defgroup tvl nil
"Customisation options for TVL functionality.")
(defcustom tvl-gerrit-remote "origin"
"Name of the git remote for gerrit"
:type '(string)
:group 'tvl)
(defcustom tvl-depot-path "/depot"
"Location at which the TVL depot is checked out."
:type '(string)
:group 'tvl)
(defcustom tvl-target-branch "canon"
"Branch to use to target CLs"
:group 'tvl
:type '(string)
:safe (lambda (_) t))
(defun tvl--gerrit-ref (target-branch &optional flags)
(let ((flag-suffix (if flags (format "%%%s" (s-join "," flags))
"")))
(format "HEAD:refs/for/%s%s" target-branch flag-suffix)))
(transient-define-suffix magit-gerrit-push-for-review ()
"Push to Gerrit for review."
(interactive)
(magit-push-refspecs tvl-gerrit-remote
(tvl--gerrit-ref tvl-target-branch)
nil))
(transient-append-suffix
#'magit-push ["r"]
(list "R" "push to Gerrit for review" #'magit-gerrit-push-for-review))
(transient-define-suffix magit-gerrit-push-wip ()
"Push to Gerrit as a work-in-progress."
(interactive)
(magit-push-refspecs tvl-gerrit-remote
(tvl--gerrit-ref tvl-target-branch '("wip"))
nil))
(transient-append-suffix
#'magit-push ["r"]
(list "W" "push to Gerrit as a work-in-progress" #'magit-gerrit-push-wip))
(transient-define-suffix magit-gerrit-push-autosubmit ()
"Push to Gerrit with autosubmit enabled."
(interactive)
(magit-push-refspecs tvl-gerrit-remote
(tvl--gerrit-ref tvl-target-branch '("l=Autosubmit+1"))
nil))
(transient-append-suffix
#'magit-push ["r"]
(list "A" "push to Gerrit with autosubmit enabled" #'magit-gerrit-push-autosubmit))
(transient-define-suffix magit-gerrit-submit ()
"Push to Gerrit for review."
(interactive)
(magit-push-refspecs tvl-gerrit-remote
(tvl--gerrit-ref tvl-target-branch '("submit"))
nil))
(transient-append-suffix
#'magit-push ["r"]
(list "S" "push to Gerrit to submit" #'magit-gerrit-submit))
(transient-define-suffix magit-gerrit-rubberstamp ()
"Push, approve and autosubmit to Gerrit. CLs created via this
rubberstamp method will automatically be submitted after CI
passes. This is potentially dangerous, use with care."
(interactive)
(magit-push-refspecs tvl-gerrit-remote
(tvl--gerrit-ref tvl-target-branch
'("l=Code-Review+2"
"l=Autosubmit+1"
"publish-comments"))
nil))
(transient-append-suffix
#'magit-push ["r"]
(list "P" "push & rubberstamp to Gerrit" #'magit-gerrit-rubberstamp))
(transient-define-suffix magit-gerrit-push-private ()
"Push a private change to Gerrit."
(interactive)
(magit-push-refspecs tvl-gerrit-remote
(tvl--gerrit-ref tvl-target-branch
'("private"
"publish-comments"))
nil))
(transient-append-suffix
#'magit-push ["r"]
(list "Q" "push private change to Gerrit" #'magit-gerrit-push-private))
(defvar magit-cl-history nil)
(defun magit-read-cl (prompt remote)
(let* ((refs (prog2 (message "Determining available refs...")
(magit-remote-list-refs remote)
(message "Determining available refs...done")))
(change-refs (-filter
(apply-partially #'string-prefix-p "refs/changes/")
refs))
(cl-number-to-refs
(-group-by
(lambda (change-ref)
;; refs/changes/34/1234/1
;; ^ ^ ^ ^ ^
;; 1 2 3 4 5
;; ^-- this one
(cadddr
(split-string change-ref (rx "/"))))
change-refs))
(cl-numbers
(-map
(lambda (cl-to-refs)
(let ((latest-patchset-ref
(-max-by
(-on #'> (lambda (ref)
(string-to-number
(nth 4 (split-string ref (rx "/"))))))
(-remove
(apply-partially #'s-ends-with-p "meta")
(cdr cl-to-refs)))))
(propertize (car cl-to-refs) 'ref latest-patchset-ref)))
cl-number-to-refs)))
(get-text-property
0
'ref
(magit-completing-read
prompt cl-numbers nil t nil 'magit-cl-history))))
(transient-define-suffix magit-gerrit-checkout (remote cl-refspec)
"Prompt for a CL number and checkout the latest patchset of that CL with
detached HEAD"
(interactive
(let* ((remote tvl-gerrit-remote)
(cl (magit-read-cl "Checkout CL" remote)))
(list remote cl)))
(magit-fetch-refspec remote cl-refspec (magit-fetch-arguments))
;; That runs async, so wait for it to finish (this is how magit does it)
(while (and magit-this-process
(eq (process-status magit-this-process) 'run))
(sleep-for 0.005))
(magit-checkout "FETCH_HEAD" (magit-branch-arguments))
(message "HEAD detached at %s" cl-refspec))
(transient-append-suffix
#'magit-branch ["l"]
(list "g" "gerrit CL" #'magit-gerrit-checkout))
(transient-define-suffix magit-gerrit-cherry-pick (remote cl-refspec)
"Prompt for a CL number and cherry-pick the latest patchset of that CL"
(interactive
(let* ((remote tvl-gerrit-remote)
(cl (magit-read-cl "Cherry-pick CL" remote)))
(list remote cl)))
(magit-fetch-refspec remote cl-refspec (magit-fetch-arguments))
;; That runs async, so wait for it to finish (this is how magit does it)
(while (and magit-this-process
(eq (process-status magit-this-process) 'run))
(sleep-for 0.005))
(magit-cherry-copy (list "FETCH_HEAD"))
(message "HEAD detached at %s" cl-refspec))
(transient-append-suffix
#'magit-cherry-pick ["m"]
(list "g" "Gerrit CL" #'magit-gerrit-cherry-pick))
(defun tvl-depot-status ()
"Open the TVL monorepo in magit."
(interactive)
(magit-status-setup-buffer tvl-depot-path))
(eval-after-load 'sly
'(defun tvl-sly-from-depot (attribute only-deps)
"Start a Sly REPL configured with a Lisp matching a derivation
from the depot.
The derivation invokes nix.buildLisp.sbclWith and is built
asynchronously. The build output is included in the error
thrown on build failures."
;; TODO(sterni): this function asumes that we are using SBCL
;; - for determining the resulting wrapper's location
;; - for creating the dep-only wrapper
(interactive (list (read-string "Attribute: ")
(yes-or-no-p "Only include dependencies? ")))
(lexical-let* ((outbuf (get-buffer-create (format "*depot-out/%s*" attribute)))
(errbuf (get-buffer-create (format "*depot-errors/%s*" attribute)))
(attr-display (if only-deps attribute (format "dependencies of %s" attribute)))
(expression (if only-deps
(format "let d = import <depot> {}; in d.nix.buildLisp.sbcl.lispWith d.%s.lispDeps"
attribute)
(format "(import <depot> {}).%s.repl" attribute)))
(command (list "nix-build" "--no-out-link" "-I" (format "depot=%s" tvl-depot-path) "-E" expression)))
(message "Acquiring Lisp for <depot>.%s" attr-display)
(make-process :name (format "depot-nix-build/%s" attribute)
:buffer outbuf
:stderr errbuf
:command command
:sentinel
(lambda (process event)
(unwind-protect
(pcase event
("finished\n"
(let* ((outpath (s-trim (with-current-buffer outbuf (buffer-string))))
(lisp-path (s-concat outpath "/bin/sbcl")))
(message "Acquired Lisp for <depot>.%s at %s" attr-display lisp-path)
(sly lisp-path)))
(_ (with-current-buffer errbuf
(error "Failed to build %s:\nTried building '%s':\n%s" attr-display expression (buffer-string)))))
(kill-buffer outbuf)
(kill-buffer errbuf)))))))
(provide 'tvl)
;;; tvl.el ends here
