Merge pull request #46 from 40ants/lct-changes

A few features I've added during the latest hackathon

.github/workflows/linter.yml

@@ -62,12 +62,12 @@
         },
         {
           "name": "Install SBLint wrapper",
-          "run": "qlot exec ros install 40ants-linter",
+          "run": "qlot exec ros install 40ants-asdf-system 40ants-linter",
           "shell": "bash"
         },
         {
           "name": "Run Linter",
-          "run": "qlot exec 40ants-linter --system \"reblocks\"",
+          "run": "qlot exec 40ants-linter --system \"reblocks\" --imports",
           "shell": "bash"
         }
       ]

.gitignore

@@ -5,5 +5,4 @@
 /libssl.dylib
 /lispapp
 .DS_Store
-
-
+*.fasl

qlfile.lock

@@ -1,8 +1,8 @@
 ("quicklisp" .
  (:class qlot/source/dist:source-dist
   :initargs (:distribution "http://beta.quicklisp.org/dist/quicklisp.txt" :%version :latest)
-  :version "2023-02-15"))
+  :version "2023-10-21"))
 ("ultralisp" .
  (:class qlot/source/dist:source-dist
   :initargs (:distribution "http://dist.ultralisp.org" :%version :latest)
-  :version "20230527224500"))
+  :version "20231205205000"))

reblocks.asd

@@ -37,6 +37,8 @@
                ;; This package defines an :around method for reblocks/widgets:render
                ;; which adds a wrapper around widget body
                "reblocks/widgets/render-methods"
+               "reblocks/routes-error-handler"
+               "reblocks/dependencies-impl"
                ;; we need to depend on this package, because
                ;; lack:builder will try to find `LACK.MIDDLEWARE.SESSION`
                ;; package

src/ci.lisp

@@ -11,7 +11,8 @@
 (defworkflow linter
   :on-pull-request t
   :cache t
-  :jobs ((40ants-ci/jobs/linter:linter)))
+  :jobs ((40ants-ci/jobs/linter:linter
+          :check-imports t)))
 
 
 (defworkflow ci

src/default-init.lisp

@@ -16,8 +16,7 @@
   (:import-from #:reblocks/widgets/string-widget
                 #:make-string-widget)
   (:import-from #:reblocks/app
-                #:*current-app*)
-  (:import-from #:spinneret/cl-markdown))
+                #:*current-app*))
 (in-package #:reblocks/default-init)
 
 
@@ -43,8 +42,10 @@ CL-USER> (defmethod reblocks/page:init-page ((app ~A) (url-path string) expire-a
 CL-USER> (reblocks/debug:reset-latest-session)"))
 
        (:p "Then reload the page.")
-       (:p ("Read more in [documentation](~A)."
-            quickstart-url)))
+       (:p "Read more in "
+           (:a :href quickstart-url
+               "documentation")
+           "."))
      :escape-p nil)))
 
 

src/dependencies-impl.lisp

@@ -1,5 +1,6 @@
 (uiop:define-package #:reblocks/dependencies-impl
   (:use #:cl)
+  (:import-from #:log)
   (:import-from #:reblocks/response
                 #:send-script)
   (:import-from #:parenscript

src/dependencies.lisp

@@ -2,7 +2,6 @@
   (:use #:cl)
   (:import-from #:cl-ppcre)
   (:import-from #:cl-fad)
-  (:import-from #:parenscript)
   (:import-from #:routes)
   (:import-from #:puri)
   (:import-from #:serapeum
@@ -52,7 +51,11 @@ be stored.")
   ((type :type (member :css :js :png :jpg :gif)
          :initarg :type
          :initform (error ":type argument is required.")
-         :reader get-type))
+         :reader get-type)
+   (defer :type boolean
+          :initarg :defer
+          :initform nil
+          :reader defer))
   (:documentation "This class represents a web-dependency. It could be CSS, JS or an image.
 
                    All dependencies are divided into REMOTE-DEPENDENCY or LOCAL-DEPENDENCY."))
@@ -185,7 +188,9 @@ as a response to some action.")
     (:js
      (with-html
        (:script :src (get-url dependency)
-                :type "text/javascript" "")))
+                :type "text/javascript"
+                :defer (defer dependency)
+                "")))
 
     (:css
      (with-html
@@ -210,7 +215,8 @@ as a response to some action.")
        (:script :src (get-url dependency)
                 :type "text/javascript"
                 :integrity (get-integrity dependency)
-                :crossorigin (get-crossorigin dependency))))
+                :crossorigin (get-crossorigin dependency)
+                :defer (defer dependency))))
     ;; CSS
     (:css
      (with-html
@@ -317,7 +323,8 @@ by infering it from URL or a path"))
                                       type
                                       integrity
                                       crossorigin
-                                      cache-in-memory)
+                                      cache-in-memory
+                                      defer)
   "Creates a JavaScript dependency, served from the disk.
 
 If the system's name is given, then the path is calculated relatively
@@ -348,7 +355,8 @@ to this system's source root."
                       :type type
                       :remote-url path-or-url
                       :integrity integrity
-                      :crossorigin crossorigin))
+                      :crossorigin crossorigin
+                      :defer defer))
       (pathname
        (let ((path path-or-url))
          (when system

src/doc/changelog.lisp

@@ -33,6 +33,20 @@
                                                    "REBLOCKS/SESSION:INIT")
                                     :external-links (("Ultralisp" . "https://ultralisp.org"))
                                     :external-docs ("https://40ants.com/log4cl-extras/"))
+  (0.55.0 2023-12-05
+          """
+Added
+=====
+
+* Optional argument :defer was added to javascript dependencies.
+* Argument BASE-URI was added to REBLOCKS/RESPONSE:MAKE-URI function.
+* Now Reblocks responds with Server-Timing and this performance information can be
+  viewed in the browser. Read more about this header at
+  [Mozilla's docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing).
+* Generic-function REBLOCKS/WIDGET:UPDATE now has an optional argument REMOVED.
+  You can set it to T to remove widget from the DOM tree.
+
+""")
   (0.54.0 2023-10-22
           """
 Added

src/doc/debug.lisp

@@ -14,7 +14,14 @@
 
 
 (defsection @debug (:title "Debugging Reblocks"
-                    :ignore-words ("REBLOCKS"))
+                    :ignore-words ("REBLOCKS"
+                                   "HTTP"))
+  "# Performance
+
+   Reblocks return response timing in the Server-Timing HTTP header.
+   This performance information can be viewed in the browser.
+   Read more about it at [Mozilla's docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing).
+"
 
   "# API"
   (status function)

src/doc/widgets.lisp

@@ -12,6 +12,7 @@
 (defsection @widgets (:title "Widgets"
                       :ignore-words ("CSS"
                                      "API"
+                                     "DOM"
                                      "JS"
                                      "HTML"
                                      "DIV"))

src/error-handler.lisp

@@ -10,8 +10,6 @@
   (:import-from #:reblocks/variables
                 #:*current-app*
                 #:*invoke-debugger-on-error*)
-  (:import-from #:alexandria
-                #:with-gensyms)
   (:import-from #:reblocks/html
                 #:with-html-string)
   (:import-from #:reblocks/page

src/hooks.lisp

@@ -9,7 +9,6 @@
                 #:symbolicate
                 #:ensure-symbol
                 #:with-gensyms)
-  (:import-from #:40ants-doc)
   (:import-from #:40ants-doc/ignored-words
                 #:ignore-words-in-package)
 

src/js/jquery/jquery.js

@@ -225,6 +225,11 @@ window.commandHandlers = {
         var target = jQuery('#' + params.domId);
         target.replaceWith(widget);
     },
+    'removeWidget': function(params) {
+        var widget = jQuery(params.widget);
+        var target = jQuery('#' + params.domId);
+        target.remove();
+    },
     'insertWidget': function(params) {
         console.log('inserting widget' + params);
 

src/page-dependencies.lisp

@@ -4,6 +4,7 @@
                 #:app)
   (:import-from #:serapeum
                 #:defvar-unbound)
+  (:import-from #:log)
   (:import-from #:reblocks/dependencies
                 #:dependency-equal
                 #:get-url)

src/preview.lisp

@@ -5,12 +5,12 @@
   (:import-from #:log)
   (:import-from #:reblocks/app)
   (:import-from #:reblocks/server)
-  (:import-from #:reblocks/session)
   (:import-from #:trivial-open-browser
                 #:open-browser)
   (:import-from #:reblocks/widget
                 #:create-widget-from
                 #:defwidget)
+  (:import-from #:reblocks/page)
   (:export #:preview
            #:stop))
 (in-package #:reblocks/preview)

src/request-handler.lisp

@@ -46,8 +46,6 @@
                 #:*timing-level*
                 #:*timing-report-fn*
                 #:timing)
-  (:import-from #:bordeaux-threads
-                #:with-lock-held)
   (:import-from #:jonathan
                 #:to-json)
   (:import-from #:trivial-timeout

src/request.lisp

@@ -23,7 +23,6 @@
                 #:query-string->alist)
 
   ;; Just to add dependency
-  (:import-from #:reblocks/session)
   (:import-from #:quri)
   (:import-from #:str
                 #:split)

src/response.lisp

@@ -6,13 +6,9 @@
                 #:get-uri
                 #:ajax-request-p
                 #:get-header)
-  (:import-from #:reblocks/variables
-                #:*ignore-missing-actions*)
   (:import-from #:reblocks/js/base
                 #:with-javascript-to-string
                 #:with-javascript)
-  (:import-from #:reblocks/app
-                #:get-prefix)
   (:import-from #:reblocks/commands
                 #:add-command)
   (:import-from #:quri)
@@ -162,15 +158,20 @@
   (lack.response:response-set-cookies response))
 
 
-(defun make-uri (new-path)
+(defun make-uri (new-path &key base-uri)
   "Makes a new URL, based on the current request's URL.
 
-   If new-path can be absolute, like /logout or relative,
+   Argument NEW-PATH can be absolute, like /logout or relative,
    like ./stories.
 
-   Also, it can contain a query params like /login?code=100500"
-  (let* ((base (get-uri))
-         (parsed-base (quri:uri base))
+   Also, it can contain a query params like /login?code=100500
+
+   By default, function takes a base-uri from the current request,
+   bun in case if you want to call the function in a context where
+   request is not available, you can pass BASE-URI argument explicitly."
+  (let* ((base-uri (or base-uri
+                       (get-uri)))
+         (parsed-base (quri:uri base-uri))
          (parsed-new-path (quri:uri new-path))
          (new-url (quri:merge-uris parsed-new-path
                                    parsed-base)))
@@ -293,7 +294,16 @@
                         ;; show the old state of the page in case of caching.
                         :cache-control "no-cache, no-store, must-revalidate"))
          (*response* (lack.response:make-response 200 headers ""))
-         (result (funcall thunk)))
+         (started-at (get-internal-real-time))
+         (result (funcall thunk))
+         (ended-at (get-internal-real-time))
+         (duration (float (/ (- ended-at started-at)
+                             internal-time-units-per-second))))
+
+    ;; Timing header according to
+    ;; https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing
+    (add-header :server-timing
+                (format nil "render;dur=~A" duration))
 
     (cond
       ((and result (listp result))

src/server.lisp

@@ -13,7 +13,6 @@
                 #:get-route
                 #:add-route
                 #:add-routes)
-  (:import-from #:reblocks/routes-error-handler)
   (:import-from #:reblocks/app
                 #:get-prefix
                 #:app-serves-hostname-p
@@ -29,16 +28,14 @@
   (:import-from #:reblocks/request-handler
                 #:handle-request)
 
-  (:import-from #:lack.request
+  (:import-from #:lack/request
                 #:make-request)
-  (:import-from #:lack
-                #:builder)
+  (:import-from #:lack/response)
   (:import-from #:clack
                 #:clackup)
   (:import-from #:cl-strings
                 #:starts-with)
   ;; Just dependencies
-  (:import-from #:reblocks/dependencies-impl)
   (:import-from #:reblocks/debug)
   (:import-from #:log)
   (:import-from #:reblocks/welcome/app
@@ -213,8 +210,8 @@ Make instance, then start it with ``start`` method."
 
 (defun make-response-for-clack (response)
   (etypecase response
-    (lack.response:response
-     (lack.response:finalize-response response))
+    (lack/response:response
+     (lack/response:finalize-response response))
     (list response)
     (function response)))
 

src/session.lisp

@@ -17,8 +17,6 @@
                 #:make-weak-hash-table)
   (:import-from #:alexandria
                 #:ensure-gethash)
-  (:import-from #:metatilities
-                #:deprecated)
   (:import-from #:lack.session.store
                 #:remove-session)
 

src/welcome/widget.lisp

@@ -3,7 +3,6 @@
   (:import-from #:reblocks/server
                 #:get-port
                 #:get-interface)
-  (:import-from #:reblocks/session)
   (:import-from #:reblocks/html
                 #:with-html)
   (:import-from #:reblocks/widget
@@ -15,7 +14,8 @@
                 #:get-prefix
                 #:webapp-name
                 #:*current-app*)
-  (:import-from #:local-time))
+  (:import-from #:local-time)
+  (:import-from #:reblocks/page))
 (in-package #:reblocks/welcome/widget)