ci: fail on note and use mirai (#183)

be-marc · web-flow · commit 3edf039ce9ce · 2025-07-10T11:02:46.000+02:00
* ci: fail on note and use mirai

* ...

* ...

* ...

* ...
diff --git a/.github/workflows/dev-cmd-check.yml b/.github/workflows/dev-cmd-check.yml
@@ -1,7 +1,14 @@
-# dev cmd check workflow of the mlr3 ecosystem v0.2.0
+# dev cmd check workflow of the mlr3 ecosystem v0.4.0
 # https://github.com/mlr-org/actions
+# modified to use supercharge/redis-github-action@1.7.0
 on:
   workflow_dispatch:
+    inputs:
+      debug_enabled:
+        type: boolean
+        description: 'Run the build with tmate debugging enabled'
+        required: false
+        default: false
   push:
     branches:
       - main
@@ -26,8 +33,9 @@ jobs:
         config:
           - {os: ubuntu-latest, r: 'release', dev-package: 'mlr-org/bbotk'}
           - {os: ubuntu-latest, r: 'release', dev-package: 'mlr-org/mlr3'}
+          - {os: ubuntu-latest, r: 'release', dev-package: 'mlr-org/mlr3misc'}
           - {os: ubuntu-latest, r: 'release', dev-package: 'mlr-org/mlr3tuning'}
-          - {os: ubuntu-latest, r: 'release', dev-package: "mlr-org/mlr3tuning', 'mlr-org/mlr3learners', 'mlr-org/mlr3pipelines', 'mlr-org/bbotk', 'mlr-org/paradox"}
+          - {os: ubuntu-latest, r: 'release', dev-package: 'mlr-org/paradox'}
 
     steps:
       - uses: actions/checkout@v3
@@ -46,12 +54,17 @@ jobs:
         with:
           extra-packages: any::rcmdcheck
           needs: check
+          error-on: '"note"'
 
       - name: Install dev versions
-        run: pak::pkg_install(c('${{ matrix.config.dev-package }}'))
+        run: pak::pkg_install('${{ matrix.config.dev-package }}')
         shell: Rscript {0}
 
-      - uses: r-lib/actions/check-r-package@v2
+      - uses: mxschmitt/action-tmate@v3
+        if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
         with:
-          args: 'c("--no-manual")' # "--as-cran" prevents to start external processes
+          limit-access-to-actor: true
 
+      - uses: r-lib/actions/check-r-package@v2
+        with:
+          args: 'c("--no-manual", "--as-cran")'
diff --git a/.github/workflows/no-suggest-cmd-check.yml b/.github/workflows/no-suggest-cmd-check.yml
@@ -1,7 +1,14 @@
-# r cmd check workflow of the mlr3 ecosystem v0.2.0
+# r cmd check workflow without suggests of the mlr3 ecosystem v0.1.0 
 # https://github.com/mlr-org/actions
+# modified to use supercharge/redis-github-action@1.7.0
 on:
   workflow_dispatch:
+    inputs:
+      debug_enabled:
+        type: boolean
+        description: 'Run the build with tmate debugging enabled'
+        required: false
+        default: false
   push:
     branches:
       - main
@@ -12,7 +19,7 @@ on:
 name: no-suggest-cmd-check
 
 jobs:
-  r-cmd-check:
+  no-suggest-cmd-check:
     runs-on: ${{ matrix.config.os }}
 
     name: ${{ matrix.config.os }} (${{ matrix.config.r }})
@@ -43,8 +50,14 @@ jobs:
         with:
           extra-packages: any::rcmdcheck
           needs: check
+          error-on: '"note"'
           dependencies: '"hard"'
 
+      - uses: mxschmitt/action-tmate@v3
+        if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
+        with:
+          limit-access-to-actor: true
+
       - uses: r-lib/actions/check-r-package@v2
         with:
-          args: 'c("--no-manual")' # "--as-cran" prevents to start external processes
+          args: 'c("--no-manual", "--as-cran")'
diff --git a/.github/workflows/r-cmd-check.yml b/.github/workflows/r-cmd-check.yml
@@ -1,7 +1,14 @@
-# r cmd check workflow of the mlr3 ecosystem v0.2.0
+# r cmd check workflow of the mlr3 ecosystem v0.4.0
 # https://github.com/mlr-org/actions
+# modified to use supercharge/redis-github-action@1.7.0
 on:
   workflow_dispatch:
+    inputs:
+      debug_enabled:
+        type: boolean
+        description: 'Run the build with tmate debugging enabled'
+        required: false
+        default: false
   push:
     branches:
       - main
@@ -44,7 +51,13 @@ jobs:
         with:
           extra-packages: any::rcmdcheck
           needs: check
+          error-on: '"note"'
+
+      - uses: mxschmitt/action-tmate@v3
+        if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
+        with:
+          limit-access-to-actor: true
 
       - uses: r-lib/actions/check-r-package@v2
         with:
-          args: 'c("--no-manual")' # "--as-cran" prevents to start external processes
+          args: 'c("--no-manual", "--as-cran")'
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -56,6 +56,7 @@ Suggests:
     emoa,
     fastGHQuad,
     lhs,
+    mirai,
     mlr3learners (>= 0.7.0),
     mlr3pipelines (>= 0.5.2),
     nloptr,
diff --git a/R/OptimizerADBO.R b/R/OptimizerADBO.R
@@ -67,11 +67,13 @@
 #'       objective = objective,
 #'       terminator = trm("evals", n_evals = 10))
 #'
-#'     rush::rush_plan(n_workers=2)
+#'     mirai::daemons(2)
+#'     rush::rush_plan(n_workers=2, worker_type = "remote")
 #'
 #'     optimizer = opt("adbo", design_size = 4, n_workers = 2)
 #'
 #'     optimizer$optimize(instance)
+#'     mirai::daemons(0)
 #'   } else {
 #'     message("Redis server is not available.\nPlease set up Redis prior to running the example.")
 #'   }
diff --git a/R/OptimizerAsyncMbo.R b/R/OptimizerAsyncMbo.R
@@ -82,11 +82,13 @@
 #'       objective = objective,
 #'       terminator = trm("evals", n_evals = 10))
 #'
-#'     rush::rush_plan(n_workers=2)
+#'     mirai::daemons(2)
+#'     rush::rush_plan(n_workers=2, worker_type = "remote")
 #'
 #'     optimizer = opt("async_mbo", design_size = 4, n_workers = 2)
 #'
 #'     optimizer$optimize(instance)
+##'     mirai::daemons(0)
 #'   } else {
 #'     message("Redis server is not available.\nPlease set up Redis prior to running the example.")
 #'   }
diff --git a/R/TunerADBO.R b/R/TunerADBO.R
@@ -57,9 +57,11 @@
 #'       measure = measure,
 #'       terminator = trm("evals", n_evals = 10))
 #'
-#'     rush::rush_plan(n_workers=2)
+#'     mirai::daemons(2)
+#'     rush::rush_plan(n_workers=2, worker_type = "remote")
 #'
 #'     tnr("adbo", design_size = 4, n_workers = 2)$optimize(instance)
+#'     mirai::daemons(0)
 #'   } else {
 #'     message("Redis server is not available.\nPlease set up Redis prior to running the example.")
 #'   }
diff --git a/R/TunerAsyncMbo.R b/R/TunerAsyncMbo.R
@@ -55,9 +55,11 @@
 #'       measure = measure,
 #'       terminator = trm("evals", n_evals = 10))
 #'
-#'     rush::rush_plan(n_workers=2)
+#'     mirai::daemons(2)
+#'     rush::rush_plan(n_workers=2, worker_type = "remote")
 #'
 #'     tnr("async_mbo", design_size = 4, n_workers = 2)$optimize(instance)
+#'     mirai::daemons(0)
 #'   } else {
 #'     message("Redis server is not available.\nPlease set up Redis prior to running the example.")
 #'   }
diff --git a/man/mlr_optimizers_adbo.Rd b/man/mlr_optimizers_adbo.Rd
diff --git a/man/mlr_optimizers_async_mbo.Rd b/man/mlr_optimizers_async_mbo.Rd
diff --git a/man/mlr_tuners_adbo.Rd b/man/mlr_tuners_adbo.Rd
diff --git a/man/mlr_tuners_async_mbo.Rd b/man/mlr_tuners_async_mbo.Rd
diff --git a/tests/testthat/helper.R b/tests/testthat/helper.R
@@ -219,25 +219,20 @@ expect_acqfunction = function(acqf) {
   expect_man_exists(acqf$man)
 }
 
+flush_redis = function() {
+  config = redux::redis_config()
+  r = redux::hiredis(config)
+  r$FLUSHDB()
+}
+
 expect_rush_reset = function(rush, type = "kill") {
-  processes = if (exists("processes", rush)) {
-    rush$processes
-  } else {
-    rush$processes_processx %??% rush$processes_mirai
-  }
   rush$reset(type = type)
-  Sys.sleep(1L)
+  Sys.sleep(1)
   keys = rush$connector$command(c("KEYS", "*"))
   if (!test_list(keys, len = 0)) {
     stopf("Found keys in redis after reset: %s", keys)
   }
-  walk(processes, function(p) p$kill())
-}
-
-flush_redis = function() {
-  config = redux::redis_config()
-  r = redux::hiredis(config)
-  r$FLUSHDB()
+  mirai::daemons(0)
 }
 
 sortnames = function(x) {
diff --git a/tests/testthat/test_AcqFunctionStochasticCB.R b/tests/testthat/test_AcqFunctionStochasticCB.R
@@ -4,7 +4,8 @@ test_that("AcqFunctionStochasticCB works in defaults", {
   skip_if_not(redis_available())
   flush_redis()
 
-  rush::rush_plan(n_workers = 1L)
+  mirai::daemons(1L)
+  rush::rush_plan(n_workers = 1L, worker_type = "remote")
   instance = oi_async(
     objective = OBJ_2D,
     search_space = PS_2D,
@@ -31,7 +32,8 @@ test_that("AcqFunctionStochasticCB works with uniform sampling", {
   skip_if_not(redis_available())
   flush_redis()
 
-  rush::rush_plan(n_workers = 2L)
+  mirai::daemons(2L)
+  rush::rush_plan(n_workers = 2L, worker_type = "remote")
   instance = oi_async(
     objective = OBJ_2D,
     search_space = PS_2D,
@@ -59,7 +61,8 @@ test_that("AcqFunctionStochasticCB works with exponential sampling", {
   skip_if_not(redis_available())
   flush_redis()
 
-  rush::rush_plan(n_workers = 2L)
+  mirai::daemons(2L)
+  rush::rush_plan(n_workers = 2L, worker_type = "remote")
   instance = oi_async(
     objective = OBJ_2D,
     search_space = PS_2D,
@@ -88,7 +91,8 @@ test_that("AcqFunctionStochasticCB works with lambda decay", {
   skip_if_not(redis_available())
   flush_redis()
 
-  rush::rush_plan(n_workers = 1L)
+  mirai::daemons(1L)
+  rush::rush_plan(n_workers = 1L, worker_type = "remote")
   instance = oi_async(
     objective = OBJ_2D,
     search_space = PS_2D,
@@ -117,7 +121,8 @@ test_that("AcqFunctionStochasticCB works with periodic lambda decay", {
   skip_if_not(redis_available())
   flush_redis()
 
-  rush::rush_plan(n_workers = 1L)
+  mirai::daemons(1L)
+  rush::rush_plan(n_workers = 1L, worker_type = "remote")
   instance = oi_async(
     objective = OBJ_2D,
     search_space = PS_2D,
diff --git a/tests/testthat/test_AcqFunctionStochasticEI.R b/tests/testthat/test_AcqFunctionStochasticEI.R
@@ -4,7 +4,8 @@ test_that("AcqFunctionStochasticEI works in defaults", {
   skip_if_not(redis_available())
   flush_redis()
 
-  rush::rush_plan(n_workers = 1L)
+  mirai::daemons(1L)
+  rush::rush_plan(n_workers = 1L, worker_type = "remote")
   instance = oi_async(
     objective = OBJ_2D,
     search_space = PS_2D,
@@ -32,7 +33,8 @@ test_that("AcqFunctionStochasticEI works with multiple workers", {
   skip_if_not(redis_available())
   flush_redis()
 
-  rush::rush_plan(n_workers = 2L)
+  mirai::daemons(2L)
+  rush::rush_plan(n_workers = 2L, worker_type = "remote")
   instance = oi_async(
     objective = OBJ_2D,
     search_space = PS_2D,
@@ -60,7 +62,8 @@ test_that("AcqFunctionStochasticEI works with periodic epsilon decay", {
   skip_if_not(redis_available())
   flush_redis()
 
-  rush::rush_plan(n_workers = 1L)
+  mirai::daemons(2L)
+  rush::rush_plan(n_workers = 2L, worker_type = "remote")
   instance = oi_async(
     objective = OBJ_2D,
     search_space = PS_2D,
diff --git a/tests/testthat/test_OptimizerADBO.R b/tests/testthat/test_OptimizerADBO.R
@@ -4,7 +4,8 @@ test_that("OptimizerADBO works in defaults", {
   skip_if_not(redis_available())
   flush_redis()
 
-  rush::rush_plan(n_workers = 2L)
+  mirai::daemons(2L)
+  rush::rush_plan(n_workers = 2L, worker_type = "remote")
   instance = oi_async(
     objective = OBJ_2D,
     search_space = PS_2D,
diff --git a/tests/testthat/test_OptimizerAsyncMbo.R b/tests/testthat/test_OptimizerAsyncMbo.R
@@ -4,7 +4,8 @@ test_that("OptimizerAsyncMbo works in defaults", {
   skip_if_not(redis_available())
   flush_redis()
 
-  rush::rush_plan(n_workers = 2L)
+  mirai::daemons(2L)
+  rush::rush_plan(n_workers = 2L, worker_type = "remote")
   instance = oi_async(
     objective = OBJ_2D,
     search_space = PS_2D,
@@ -25,7 +26,8 @@ test_that("OptimizerAsyncMbo works with evaluations in archive", {
   skip_if_not(redis_available())
   flush_redis()
 
-  rush::rush_plan(n_workers = 2L)
+  mirai::daemons(2L)
+  rush::rush_plan(n_workers = 2L, worker_type = "remote")
   instance = oi_async(
     objective = OBJ_2D,
     search_space = PS_2D,
diff --git a/tests/testthat/test_TunerADBO.R b/tests/testthat/test_TunerADBO.R
@@ -8,7 +8,8 @@ test_that("TunerADBO works", {
     minsplit  = to_tune(2L, 128L),
     cp        = to_tune(1e-04, 1e-1))
 
-  rush::rush_plan(n_workers = 4L)
+  mirai::daemons(4L)
+  rush::rush_plan(n_workers = 4L, worker_type = "remote")
   instance = ti_async(
     task = tsk("pima"),
     learner = learner,
diff --git a/tests/testthat/test_TunerAsyncMbo.R b/tests/testthat/test_TunerAsyncMbo.R
