Refactor xapi-storage-script to use modules #6191
Open
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
psafont
reviewed
Dec 20, 2024
ocaml/xapi-storage-script/main.ml
Outdated
| let module RuntimeMeta = struct | ||
| let volume_script_dir = volume_script_dir | ||
|
|
||
| let version = version |
There was a problem hiding this comment.
If I understood correctly, version is shared among all the modules that implement storage functions. Why is it needed in RuntimeMeta? It looks like it depends on the global variable anyway, so why bother with the indirection?
For volume_script_dir it makes sense because the value is passed when calling bind, but for version, the value is set after calling bind.
There was a problem hiding this comment.
That is a good point, in fact, I don't think version should be global, each plugin would need its own version, as set by Query.query. I have updated the code to create a new module (with a version ref) each time bind is called.
Vincent-lau
force-pushed
the
private/shul2/storage-script-modules
branch
from
25fcecf to
d779a25
Compare
The `bind` function in xapi-storage-script has lots of implementaions all over the place, making it hard to maintain. Use module abstractions to separate different storage functions. The tricky bit of this is the need to pass `version` and `volume_script_dir` into each storage function calls, and these two variables are determined at runtime. Hence functors are used for this purpose, once the `volume_script_dir` is determined when `bind` is called, pass this as inside the `RuntimeMeta` module to the relevant implementations. The `version` ref cell is populated when `Query.query` is called, which should be the first call of each plugin. Once it is populated, it will then be used by different plugin functions. We do need a separate version for each plugin though, so create a new module (which contains a new version) each time bind is called, just as before. Signed-off-by: Vincent Liu <[email protected]>
Vincent-lau
force-pushed
the
private/shul2/storage-script-modules
branch
from
d779a25 to
35948a7
Compare
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.
The
bindfunction in xapi-storage-script has lots of implementaions all over the place, making it hard to maintain. Use module abstractions to separate different storage functions.The tricky bit of this is the need to pass
versionandvolume_script_dirinto each storage function calls, and these two variables are determined at runtime. Hence functors are used for this purpose, once thevolume_script_diris determined whenbindis called, pass this as inside theRuntimeMetamodule to the relevant implementations. Theversionglobal variable, however, is populated whenQuery.queryis called, so create an alias in theRuntimeMetamodule so that it can be used in the storage function implementations.