-
Notifications
You must be signed in to change notification settings - Fork 2
/
plugin.R
277 lines (253 loc) · 10.1 KB
/
plugin.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
##' Create an orderly plugin. A plugin is typically defined by a
##' package and is used to extend orderly by enabling new
##' functionality, declared in `orderly_config.yml` and your orderly file,
##' and affecting the running of reports primarily by creating new
##' objects in the report environment. This system is discussed in
##' more detail in `vignette("plugins")`, but will be expanded (likely
##' in breaking ways) soon.
##'
##' @title Register an orderly plugin
##'
##' @param name The name of the plugin, typically the package name
##'
##' @param config A function to read, check and process the
##' configuration section in `orderly_config.yml`. This function
##' will be passed the deserialised data from the plugin's section
##' of `orderly_config.yml`, and the full path to that file. As the
##' order of loading of plugins is not defined, each plugin must
##' standalone and should not try and interact with other plugins at
##' load. It should return a processed copy of the configuration
##' data, to be passed in as the second argument to `read`.
##'
##' @param serialise A function to serialise any metadata added by the
##' plugin's functions to the outpack metadata. It will be passed a
##' list of all entries pushed in via
##' [`orderly2::orderly_plugin_add_metadata()`]; this is a named
##' list with names corresponding to the `field` argument to
##' `orderly_plugin_add_metadata` and each list element being an
##' unnamed list with values corresponding to `data`. If `NULL`,
##' then no serialisation is done, and no metadata from your plugin
##' will be added.
##'
##' @param deserialise A function to deserialise any metadata
##' serialised by the `serialise` function. This is intended to help
##' deal with issues disambiguating unserialising objects from json
##' (scalars vs arrays of lenth 1, data.frames vs lists-of-lists
##' etc), and will make your plugin nicer to work with
##' [orderly2::orderly_metadata_extract()]. This function will be
##' given a single argument `data` which is the data from
##' `jsonlite::fromJSON(..., simplifyVector = FALSE)` and you should
##' apply any required simplifications yourself, returning a
##' modified copy of the argument.
##'
##' @param cleanup Optionally, a function to clean up any state that
##' your plugin uses. You can call `orderly_plugin_context` from
##' within this function and access anything you need from that. If
##' not given, then no cleanup is done.
##'
##' @param schema Optionally a path, within the package, to a schema
##' for the metadata created by this plugin; you should omit the
##' `.json` extension. So if your file contains in its sources the
##' file `inst/plugin/myschema.json` you would pass
##' `plugin/myschema`. See `vignette("plugins")` for details.
##'
##' @return Nothing, this function is called for its side effect of
##' registering a plugin.
##'
##' @export
orderly_plugin_register <- function(name, config, serialise = NULL,
deserialise = NULL, cleanup = NULL,
schema = NULL) {
assert_scalar_character(name, call = environment())
plugin <- orderly_plugin(name, config, serialise, deserialise, cleanup,
schema)
.plugins[[name]] <- plugin
}
load_orderly_plugin <- function(name) {
assert_scalar_character(name)
if (!(name %in% names(.plugins))) {
loadNamespace(name)
}
plugin <- .plugins[[name]]
if (is.null(plugin)) {
stop(sprintf("Plugin '%s' not found", name))
}
plugin
}
.plugins <- new.env(parent = emptyenv())
orderly_plugin <- function(package, config, serialise, deserialise, cleanup,
schema, call = NULL) {
assert_is(config, "function", call = call)
if (is.null(cleanup)) {
cleanup <- plugin_no_cleanup
}
if (!is.null(schema)) {
if (is.null(serialise)) {
cli::cli_abort(
"If 'schema' is given, then 'serialise' must be non-NULL",
call = call)
}
path_pkg <- pkg_root(package)
if (!file.exists(file.path(path_pkg, schema))) {
cli::cli_abort(
"Expected schema file '{schema}' to exist in package '{package}'",
call = call)
}
schema <- sprintf("%s/%s", package, schema)
}
if (!is.null(deserialise) && is.null(serialise)) {
cli::cli_abort(
"If 'deserialise' is given, then 'serialise' must be non-NULL",
call = call)
}
assert_is(cleanup, "function", call = call)
ret <- list(package = package,
config = config,
serialise = serialise %||% plugin_no_serialise,
deserialise = deserialise %||% plugin_no_deserialise,
cleanup = cleanup,
schema = schema)
class(ret) <- "orderly_plugin"
ret
}
##' Fetch the running context, for use within a plugin. The intention
##' here is that within free functions that your plugin makes
##' available, you will call this function to get information about
##' the state of a packet. You will then typically call
##' [`orderly2::orderly_plugin_add_metadata()`] afterwards.
##'
##' When a plugin function is called, orderly2 will be running in one
##' of two modes; (1) from within [`orderly2::orderly_run()`], in
##' which case we're part way through creating a packet in a brand new
##' directory, and possibly using a special environment for
##' evaluation, or (2) interactively, with a user developing their
##' report. The plugin needs to be able to support both modes, and
##' this function will return information about the state to help you
##' cope with either case.
##'
##' @title Fetch plugin context
##'
##' @param name Name of the plugin
##'
##' @param envir The environment of the calling function. You can
##' typically pass `parent.frame()` (or `rlang::caller_env()`) here
##' if the function calling `orderly_plugin_context()` is the
##' function that would be called by a user. This argument only has
##' an effect in interactive use (where `envir` is almost certainly
##' the global environment).
##'
##' @return A list with elements:
##'
##' * `is_active`: a logical, indicating if we're running under
##' [`orderly2::orderly_run()`]; you may need to change behaviour
##' depending on this value.
##'
##' * `path`: the path of the running packet. This is almost always the
##' working directory, unless the packet contains calls to [`setwd()`]
##' or similar. You may create files here.
##'
##' * `config`: the configuration for this plugin, after processing
##' with the plugin's `read` function (see
##' [`orderly2::orderly_plugin_register`])
##'
##' * `envir`: the environment that the packet is running in. Often this
##' will be the global environment, but do not assume this! You may
##' read and write from this environment.
##'
##' * `src`: the path to the packet source directory. This is
##' different to the current directory when the packet is running,
##' but the same when the user is interactively working with a
##' report. You may *read* from this directory but *must not write
##' to it*
##'
##' * `parameters`: the parameters as passed through to the run the
##' report.
##'
##' @seealso [orderly2::orderly_plugin_register],
##' [orderly2::orderly_plugin_add_metadata]
##' @export
orderly_plugin_context <- function(name, envir) {
assert_scalar_character(name, call = environment())
ctx <- orderly_context(envir)
check_plugin_enabled(name, ctx$config)
## Narrower view on configuration - can only see the config for the
## plugin itself:
ctx$config <- ctx$config$plugins[[name]]$config
## No direct access to the full packet
ctx$packet <- NULL
ctx
}
##' Add plugin-specific metadata to a running packet. This will take
##' some describing. You accumulate any number of bits of metadata
##' into arbitrary fields, and then later on serialise these to json.
##'
##' @title Add metadata from plugin
##'
##' @param name The name of the plugin; must be the same as used in
##' [orderly2::orderly_plugin_register] and
##' [orderly2::orderly_plugin_context]
##'
##' @param field The name of a field to add the data to. This is
##' required even if your plugin only produces one sort of data, in
##' which case you can remove it later on within your serialisation
##' function.
##'
##' @param data Arbitrary data to be added to the currently running
##' packet
##'
##' @return Nothing, called only for its side effects
##'
##' @export
orderly_plugin_add_metadata <- function(name, field, data) {
assert_scalar_character(name, call = environment())
assert_scalar_character(field, call = environment())
p <- get_active_packet()
if (!is.null(p)) {
check_plugin_enabled(name, p$orderly2$config, call = environment())
p$plugins[[name]][[field]] <- c(p$plugins[[name]][[field]], list(data))
}
}
check_plugin_enabled <- function(name, config, call) {
if (is.null(config$plugins[[name]])) {
cli::cli_abort("Plugin '{name}' not enabled in 'orderly_config.yml'",
call = call)
}
}
plugin_run_cleanup <- function(path, plugins) {
for (p in plugins) {
withr::with_dir(path, p$cleanup())
}
}
plugin_no_cleanup <- function() {
}
plugin_no_serialise <- function(data) {
empty <- is.null(data) || all(vlapply(data, is.null))
if (!empty) {
stop(paste("Your plugin produced output to be serialise but",
"has no serialise method"))
}
to_json(NULL, NULL)
}
plugin_no_deserialise <- function(data) {
data
}
## Some careful work here is required to cope with the case where
## orderly2 and the plugin package are installed directly or in dev
## mode
##
## If orderly or both are loaded in dev mode we can just use
## system_file as the devtools shim is picked up by orderly.
##
## If both are installed properly, then system_file works because the
## base version gives the right answer.
##
## However, in the case where orderly is properly installed but the
## plugin is not (which is reasonably likely) then we need to find the
## true root, in which case we need to build the path manually.
pkg_root <- function(package) {
root <- find.package(package)
if (is_dev_package(package)) file.path(root, "inst") else root
}
is_dev_package <- function(package) {
"pkgload" %in% loadedNamespaces() && pkgload::is_dev_package(package)
}