mirai 2.5.2

Author: shikokuchuo

.github/workflows/test-coverage.yaml

@@ -24,11 +24,7 @@ jobs:
 
       - uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          extra-packages: |
-            any::covr
-            any::xml2
-            any::rlang
-            otelsdk=?ignore-before-r=4.3.0
+          extra-packages: any::covr, any::xml2, any::rlang
           needs: coverage
 
       - name: Test coverage

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: mirai
 Title: Minimalist Async Evaluation Framework for R
-Version: 2.5.1.9000
+Version: 2.5.2
 Authors@R: c(
     person("Charlie", "Gao", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0002-0750-061X")),

NEWS.md

@@ -1,9 +1,9 @@
-# mirai (development version)
+# mirai 2.5.2
 
 #### Updates
 
 * The default daemons `autoexit = TRUE` behaviour has been updated for OpenTelemetry compatibility (#500).
-  + Introduces a 200ms grace period for processes to exit gracefully before a forceful termination.
+  + Introduces a 200ms grace period for processes to exit normally before a forceful termination.
   + The behavioural changes announced in mirai 2.4.0 are now enforced for all daemon types - eliminating a bug that previously caused this to only be applied to ephemeral daemons.
 * OpenTelemetry span names and attributes have been upgraded to be more informative and better follow semantic conventions (#481).
 * `require_daemons()` updates:

R/daemon.R

@@ -61,7 +61,7 @@
 #' The `autoexit` argument governs persistence settings for the daemon. The
 #' default `TRUE` ensures that it exits as soon as its socket connection with
 #' the host process drops. A 200ms grace period allows the daemon process to
-#' exit gracefully, after which it will be forcefully terminated.
+#' exit normally, after which it will be forcefully terminated.
 #'
 #' Supplying `NA` ensures that a daemon always exits cleanly after its socket
 #' connection with the host drops. This means that it can temporarily outlive

R/otel.R

@@ -2,17 +2,23 @@ otel_tracer_name <- "org.r-lib.mirai"
 otel_is_tracing <- FALSE
 otel_tracer <- NULL
 
+# generic otel helpers ---------------------------------------------------------
+
 # nocov start
 # tested implicitly on package load
 
-otel_cache_tracer = function() {
+otel_cache_tracer <- function() {
   requireNamespace("otel", quietly = TRUE) || return()
   otel_tracer <<- otel::get_tracer(otel_tracer_name)
   otel_is_tracing <<- tracer_enabled(otel_tracer)
 }
 
 # nocov end
 
+tracer_enabled <- function(tracer) {
+  .subset2(tracer, "is_enabled")()
+}
+
 otel_refresh_tracer <- function(pkgname) {
   requireNamespace("otel", quietly = TRUE) || return()
   tracer <- otel::get_tracer()
@@ -22,16 +28,14 @@ otel_refresh_tracer <- function(pkgname) {
   )
 }
 
-tracer_enabled <- function(tracer) {
-  .subset2(tracer, "is_enabled")()
-}
-
 modify_binding <- function(env, lst) {
   lapply(names(lst), unlockBinding, env)
   list2env(lst, envir = env)
   lapply(names(lst), lockBinding, env)
 }
 
+# mirai-specific helpers -------------------------------------------------------
+
 otel_active_span <- function(
   name,
   cond = TRUE,
@@ -55,13 +59,11 @@ otel_active_span <- function(
 }
 
 otel_set_span_id <- function(span, id) {
-  otel_is_tracing || return()
-  span$set_attribute("mirai.id", id)
+  otel_is_tracing && return(span$set_attribute("mirai.id", id))
 }
 
 otel_set_span_error <- function(span, type) {
-  otel_is_tracing && length(span) || return()
-  span$set_status("error", type)
+  otel_is_tracing && length(span) && return(span$set_status("error", type))
 }
 
 otel_daemon_attrs <- function(url) {

README.Rmd

@@ -21,7 +21,6 @@ knitr::opts_chunk$set(
 [![R-universe status](https://r-lib.r-universe.dev/badges/mirai)](https://r-lib.r-universe.dev/mirai)
 [![R-CMD-check](https://github.com/r-lib/mirai/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/mirai/actions/workflows/R-CMD-check.yaml)
 [![Codecov test coverage](https://codecov.io/gh/r-lib/mirai/graph/badge.svg)](https://app.codecov.io/gh/r-lib/mirai)
-[![DOI](https://zenodo.org/badge/459341940.svg)](https://doi.org/10.5281/zenodo.7912722)
 [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/r-lib/mirai)
 <!-- badges: end -->
 
@@ -84,12 +83,12 @@ daemons(0)
 → **Dynamic Architecture**
 
 - Inverted topology, where daemons connect to host, enables true dynamic scaling
-- Optimal load balancing through FIFO dispatcher scheduling
-- Event-driven promises complete with zero latency and no polling overhead
+- Optimal load balancing through efficient FIFO dispatcher scheduling
+- Event-driven promises complete with zero latency (and no polling overhead)
 
 → **Modern Foundation**
 
-- Built on [NNG](https://nng.nanomsg.org/) via [nanonext](https://nanonext.r-lib.org/) for scaling to millions of tasks over thousands of processes
+- Built on [NNG](https://nng.nanomsg.org/) via [nanonext](https://nanonext.r-lib.org/), scales reliably to millions of tasks / thousands of processes
 - High performance, with round-trip times measured in microseconds, not milliseconds
 - Native support for IPC, TCP, and zero-config TLS with automatic certificate generation
 
@@ -103,7 +102,7 @@ daemons(0)
 
 - Local, network / cloud (via SSH, SSH tunnelling) or HPC (via Slurm, SGE, PBS, LSF)
 - Modular compute profiles direct tasks to the most suitable resources
-- Flexibility to combine local, remote, and HPC resources in a single compute profile
+- Combine local, remote, and HPC resources in a single compute profile
 
 ### Powers the R Ecosystem
 

README.md

@@ -12,7 +12,6 @@ status](https://r-lib.r-universe.dev/badges/mirai)](https://r-lib.r-universe.dev
 [![R-CMD-check](https://github.com/r-lib/mirai/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/mirai/actions/workflows/R-CMD-check.yaml)
 [![Codecov test
 coverage](https://codecov.io/gh/r-lib/mirai/graph/badge.svg)](https://app.codecov.io/gh/r-lib/mirai)
-[![DOI](https://zenodo.org/badge/459341940.svg)](https://doi.org/10.5281/zenodo.7912722)
 [![Ask
 DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/r-lib/mirai)
 <!-- badges: end -->
@@ -77,15 +76,15 @@ daemons(0)
 
 - Inverted topology, where daemons connect to host, enables true dynamic
   scaling
-- Optimal load balancing through FIFO dispatcher scheduling
-- Event-driven promises complete with zero latency and no polling
-  overhead
+- Optimal load balancing through efficient FIFO dispatcher scheduling
+- Event-driven promises complete with zero latency (and no polling
+  overhead)
 
 → **Modern Foundation**
 
 - Built on [NNG](https://nng.nanomsg.org/) via
-  [nanonext](https://nanonext.r-lib.org/) for scaling to millions of
-  tasks over thousands of processes
+  [nanonext](https://nanonext.r-lib.org/), scales reliably to millions
+  of tasks / thousands of processes
 - High performance, with round-trip times measured in microseconds, not
   milliseconds
 - Native support for IPC, TCP, and zero-config TLS with automatic
@@ -105,8 +104,7 @@ daemons(0)
 - Local, network / cloud (via SSH, SSH tunnelling) or HPC (via Slurm,
   SGE, PBS, LSF)
 - Modular compute profiles direct tasks to the most suitable resources
-- Flexibility to combine local, remote, and HPC resources in a single
-  compute profile
+- Combine local, remote, and HPC resources in a single compute profile
 
 ### Powers the R Ecosystem
 

cran-comments.md

@@ -1,10 +1,3 @@
 ## R CMD check results
 
 0 errors | 0 warnings | 0 notes
-
-## revdepcheck results
-
-We checked 33 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
-
- * We saw 0 new problems
- * We failed to check 3 packages

dev/vignettes/_v05-opentelemetry.Rmd

@@ -32,10 +32,10 @@ This enables detailed monitoring of:
 
 Tracing is automatically enabled when:
 
-1. The `otel` and `otelsdk` packages are installed and available
+1. The `otel` and `otelsdk` packages are installed; and
 2. OpenTelemetry tracing is configured and enabled (see <https://otelsdk.r-lib.org/reference/collecting.html>)
 
-No additional configuration is required - mirai will automatically detect the presence of OpenTelemetry and begin tracing.
+No additional action is required - mirai will automatically detect the presence of OpenTelemetry and begin tracing.
 
 ### 3. Span Types and Hierarchy