Only allow a single target_keys key value pair #90
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
annakrystalli
commented
Dec 18, 2024
| "target_id": "wk ahead inc flu hosp", | ||
| "target_name": "weekly influenza hospitalization incidence", | ||
| "target_units": "rate per 100,000 population", | ||
| "target_keys": null, |
There was a problem hiding this comment.
section relevant to test
annakrystalli
commented
Dec 18, 2024
Comment on lines
+145
to
+148
| "target_keys": { | ||
| "target": "wk flu hosp", | ||
| "target_metric": "rate change" | ||
| }, |
There was a problem hiding this comment.
section relevant to tests
annakrystalli
commented
Dec 18, 2024
Comment on lines
+14
to
+21
| #' @param target_keys named list or `NULL`. The `target_keys` value defines a | ||
| #' single target. | ||
| #' Should be `NULL`, in the case where the target is not specified as a task_id | ||
| #' but is specified solely through the `target_id` argument. | ||
| #' Otherwise, should be a named list containing a single character string element. | ||
| #' The name of the element should match a `task_id` | ||
| #' variable name within the same `model_tasks` object and the value should match | ||
| #' a single value of that variable. |
There was a problem hiding this comment.
Although in the code I only apply the restriction to configs with version v4.0.1 and greater, I've gone ahead an just updated the docs with what's allowed going forward. Otherwise I think the docs would be too complex and prehaps confusing when I don't belivee anyone was using the feature anyways.
annakrystalli
commented
Dec 18, 2024
Comment on lines
+154
to
+167
| is_gte_v4_0_1 <- hubUtils::version_gte( | ||
| "v4.0.1", | ||
| schema_version = schema_version | ||
| ) | ||
| target_key_n <- length(target_keys) | ||
| if (is_gte_v4_0_1 && target_key_n > 1L) { | ||
| cli::cli_abort( | ||
| c( | ||
| "!" = "{.arg target_keys} must be a named {.cls list} of | ||
| length {.val {1L}} not {.val {target_key_n}}." | ||
| ), | ||
| call = call | ||
| ) | ||
| } |
There was a problem hiding this comment.
I restricted this to the relevant versions to ensure it matches what's actually described in earlier schema
…o the default value anyways.
A weird bug just popped up and I don't know where it's coming from, but
effectively, when a value with a class of "error" is passed to
`encodeString()`, it fails with:
Error in UseMethod("conditionMessage") :
no applicable method for 'conditionMessage' applied to an object of class "error"
This never used to happen, so I'm fixing it here.
annakrystalli
commented
Dec 18, 2024
| @@ -6,7 +6,7 @@ test_that("Missing files returns an invalid config with an immediate message", { | |||
| "File does not exist" | |||
| ) | |||
| }) | |||
| expect_false(out) | |||
| expect_false(unclass(out)) | |||
There was a problem hiding this comment.
Fixes new errors from changes in testthat. Cherry picked from 8e8ed51
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR resolves #89 and is related to hubverse-org/schemas#118
Specifically In v4.0.1, we are only allowing a single
target_keyskey value pair.To ensure
hubAdminfunctionality conform to this pattern this PR:target_keyskey value pair when validating task.json files withvalidate_config()target_keyswith more that 1 key value pair programmatically for configs using schema versions v4.0.1 and abovehubAdmin.branchoption specification. This didn't affect tests though as it was setting it to the default value anyways.Note: unrelated test failures still exist and will need resolving before mergingFound solution @zkamvar had applied in #86 (8e8ed51) and cherry picked into here!