permit environment variables in watchlist

pull/218/head
Matthew Butterick 5 years ago
parent 875becbff7
commit 5bcb70a7be

@ -7,6 +7,7 @@
racket/file racket/file
racket/path racket/path
racket/list racket/list
racket/string
racket/serialize racket/serialize
sugar/coerce sugar/coerce
sugar/test sugar/test
@ -22,6 +23,7 @@
;; because cache validity is not sensitive to mod date of output path ;; because cache validity is not sensitive to mod date of output path
;; (in fact we would expect it to be earlier, since we want to rely on an earlier version) ;; (in fact we would expect it to be earlier, since we want to rely on an earlier version)
(define (paths->key source-path [template-path #false] [output-path #false]) (define (paths->key source-path [template-path #false] [output-path #false])
(define-values (env-watchlist path-watchlist) (partition bytes? (setup:cache-watchlist source-path)))
(define path-strings-to-track (define path-strings-to-track
(list* source-path (list* source-path
;; if template has a source file, track that instead ;; if template has a source file, track that instead
@ -29,8 +31,10 @@
;; is either list of files or (list #f) ;; is either list of files or (list #f)
(append (->list (get-directory-require-files source-path)) (append (->list (get-directory-require-files source-path))
;; user-designated files to track ;; user-designated files to track
(map ->string (setup:cache-watchlist source-path))))) (map ->string path-watchlist))))
(define pollen-env (getenv default-env-name)) (define pollen-env (getenv default-env-name))
(define env-rec (for/list ([env-name (in-list (sort env-watchlist bytes<?))])
(cons env-name (environment-variables-ref (current-environment-variables) env-name))))
(define poly-flag (and (has-inner-poly-ext? source-path) (current-poly-target))) (define poly-flag (and (has-inner-poly-ext? source-path) (current-poly-target)))
(define path+mod-time-pairs (define path+mod-time-pairs
(for/list ([ps (in-list path-strings-to-track)]) (for/list ([ps (in-list path-strings-to-track)])
@ -40,7 +44,7 @@
(message (format "watchlist file /~a does not exist" (find-relative-path (current-project-root) cp)))) (message (format "watchlist file /~a does not exist" (find-relative-path (current-project-root) cp))))
(cons (path->string cp) (file-or-directory-modify-seconds cp #false (λ () 0)))] (cons (path->string cp) (file-or-directory-modify-seconds cp #false (λ () 0)))]
[else #false]))) [else #false])))
(list* pollen-env poly-flag (and output-path (path->string output-path)) path+mod-time-pairs)) (append env-rec (list pollen-env poly-flag (and output-path (path->string output-path))) path+mod-time-pairs))
(define (key->source-path key) (car (fourth key))) (define (key->source-path key) (car (fourth key)))
(define (key->output-path key) (third key)) (define (key->output-path key) (third key))

@ -1 +1 @@
1565713996 1566497695

@ -106,9 +106,9 @@ Default separators used in decoding.
@defoverridable[compile-cache-max-size exact-positive-integer?]{Maximum size of the compile cache.} @defoverridable[compile-cache-max-size exact-positive-integer?]{Maximum size of the compile cache.}
@defoverridable[cache-watchlist (listof (or/c path? path-string?))]{List of extra files that the cache (= render cache + compile cache, collectively) watches during a project-server session. If one of the files on the watchlist changes, the cache is invalidated (just as it would be if @racket["pollen.rkt"] changed). @defoverridable[cache-watchlist (listof (or/c path? path-string? bytes?))]{List of extra things that the cache (= render cache + compile cache, collectively) watches during a project-server session, which can be files (each given as a @racket[path?] or @racket[path-string?]) and environment variables (each given as @racket[bytes?]).
If the cache can't find a certain file on the watchlist, no error will arise. The file will simply be ignored. Therefore, to avoid unexpected behavior, the best policy is to use complete paths (or path strings). One way to generate a complete path to a local file is with @racket[define-runtime-path]. Another way, if you're using a module that's already installed as part of a package, is with @racket[resolve-module-path]: Here's how files on the watchlist are handled. If one of the files on the watchlist changes, the cache is invalidated (just as it would be if @racket["pollen.rkt"] changed). If the cache can't find a certain file on the watchlist, no error will arise. The file will simply be ignored. Therefore, to avoid unexpected behavior, the best policy is to use complete paths (or path strings). One way to generate a complete path to a local file is with @racket[define-runtime-path]. Another way, if you're using a module that's already installed as part of a package, is with @racket[resolve-module-path]:
@fileblock["pollen.rkt" @fileblock["pollen.rkt"
@codeblock{ @codeblock{
@ -120,6 +120,8 @@ If the cache can't find a certain file on the watchlist, no error will arise. Th
(define cache-watchlist (list my-local-mod my-installed-mod))) (define cache-watchlist (list my-local-mod my-installed-mod)))
}] }]
Here's how environment variables on the watchlist are handled. Ordinarily the cache only watches the default @racket[#"POLLEN"] environment variable. By listing other environment variables in the watchlist, Pollen will watch those too. Unlike files, environment variables don't change during a session. But separate caches will be maintained for each distinct value of an environment variable.
@history[#:added "1.4"] @history[#:added "1.4"]
} }

Loading…
Cancel
Save