add expansion module support to rhai #3240
Merged
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
fixes: #1744 This refactors existing functionality within `Expansion` to add support for a default rhai expander and to expose a new function for environment variable access. This leverages the existing mechanism for limiting access to environment variables. This functionality is then exposed to rhai scripts as in this example code: ``` let expander = expansion::create(); try { print(`LANG: ${expansion::env(expander, "LANG")}`); } catch(err) { print(`exception: ${err}`); } ``` In the sample, we use the new expansion module to create an expander. We then use the expander to access environment variables, in this case "LANG".
This comment has been minimized.
This comment has been minimized.
|
CI performance tests
|
Introduce private prefix() fn to use from default() and default_rhai().
BrynCooke
reviewed
Jun 8, 2023
BrynCooke
reviewed
Jun 8, 2023
| @@ -142,6 +144,18 @@ impl Expansion { | |||
| } | |||
| } | |||
|
|
|||
| pub(crate) fn expand_env(&self, key: &str) -> Result<Option<String>, ConfigurationError> { | |||
There was a problem hiding this comment.
I feel that the error message in here is targeted at config expansion.
The rhai expansion should have it's own error message.
There was a problem hiding this comment.
I want the Rhai functionality to look/smell the same, so I think this message is perfect. In the future we may add more configuration/expansion capabilities into Rhai, so deviation is probably not a good thing.
Adding the global flag to the env method resolves the object method invocation problem. also: add docs and unit tests for the new methods.
bnjjj
reviewed
Jun 19, 2023
The expansion module is now exposed as the `router_env` module. The `create()` function is removed and the `env()` method is replaced by the `get()` function. Docs are updated.
BrynCooke
approved these changes
Jun 29, 2023
Merged
BrynCooke
pushed a commit
that referenced
this pull request
Jul 12, 2023
This refactors existing functionality within `Expansion` to expose a new
function for environment variable access. This leverages the existing
mechanism for limiting access to environment variables.
This functionality is then exposed to rhai scripts as in this example
code:
```
try {
print(`LANG: ${env::get("LANG")}`);
} catch(err) {
print(`exception: ${err}`);
}
```
In the sample, we use the new env module to access environment
variables, in this case "LANG".
fixes: #1744
<!-- start metadata -->
**Checklist**
Complete the checklist (and note appropriate exceptions) before a final
PR is raised.
- [x] Changes are compatible[^1]
- [x] Documentation[^2] completed
- [x] Performance impact assessed and acceptable
- Tests added and passing[^3]
- [x] Unit Tests
- [ ] Integration Tests
- [ ] Manual Tests
**Exceptions**
*Note any exceptions here*
**Notes**
[^1]. It may be appropriate to bring upcoming changes to the attention
of other (impacted) groups. Please endeavour to do this before seeking
PR approval. The mechanism for doing this will vary considerably, so use
your judgement as to how and when to do this.
[^2]. Configuration is an important part of many changes. Where
applicable please try to document configuration examples.
[^3]. Tick whichever testing boxes are applicable. If you are adding
Manual Tests:
- please document the manual testing (extensively) in the Exceptions.
- please raise a separate issue to automate the test and label it (or
ask for it to be labeled) as `manual test`
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 refactors existing functionality within
Expansionto expose a new function for environment variable access. This leverages the existing mechanism for limiting access to environment variables.This functionality is then exposed to rhai scripts as in this example code:
In the sample, we use the new env module to access environment variables, in this case "LANG".
fixes: #1744
Checklist
Complete the checklist (and note appropriate exceptions) before a final PR is raised.
Exceptions
Note any exceptions here
Notes
[^1]. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this.
[^2]. Configuration is an important part of many changes. Where applicable please try to document configuration examples.
[^3]. Tick whichever testing boxes are applicable. If you are adding Manual Tests:
- please document the manual testing (extensively) in the Exceptions.
- please raise a separate issue to automate the test and label it (or ask for it to be labeled) as
manual test