Allow passing `variables` via raw YAML #354

nkaretnikov · 2024-01-08T00:22:37Z

Fixes #350.

Description

This pull request:

is a companion PR to Pass CONDA_OVERRIDE_CUDA to with_cuda of conda-lock conda-store#721
allows passing variables via raw YAML, see:
https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-virtual.html#overriding-detected-packages
doesn't create new GUI elements (like the ones we have for channels and dependencies) because the conda-store server currently supports only CONDA_OVERRIDE_CUDA due to a conda-lock limitation (GUI elements can be added later once we have a chance to discuss how that should look like).

Tested manually:

variables is present and equal to {} when creating an environment
variables can be edited when creating an environment and the result can be later seen again via the new or admin UI
variables can be edited after the environment was created, the new result is saved and can be seen again via the new or admin UI (as part of the new build)
the server receives the provided variables value in action_solve_lockfile (in all of the above cases).

Pull request checklist

Did you test this change locally?
Did you update the documentation (if required)?
Did you add/update relevant tests for this change (if required)?

Additional information

These tests should pass locally:

yarn run test test/environmentDetails/SpecificationEdit.test.tsx --coverage=false
yarn run test test/environmentCreate/SpecificationCreate.test.tsx --coverage=false

src/features/environmentCreate/components/Specification/SpecificationCreate.tsx

src/features/variables/variablesSlice.ts

src/store/selectors/condaSpecificationSelector.ts

src/features/environmentCreate/components/Specification/SpecificationCreate.tsx

gabalafou

What is the urgency on this? Would it be too much to ask for some tests?

I'm just thinking that the repo already has a nice base of test files, and you already wrote up a set of manual tests, so maybe it wouldn't be too hard to turn some of those into automated tests. What do you think?

src/features/environmentDetails/components/Specification/SpecificationEdit.tsx

gabalafou

I haven't tested any of this, but I carefully reviewed the code. It looks great. I only spotted one thing, and I left an inline question.

But I also have a more general question. Are we sure about the word choice for variables? I'm concerned that the name might be a little too generic, and we may come to regret the word choice later.

trallard · 2024-01-31T12:23:04Z

But I also have a more general question. Are we sure about the word choice for variables? I'm concerned that the name might be a little too generic, and we may come to regret the word choice later.

Agree with you here @gabalafou we should be favouring descriptive variable names, so I suggest something like conda_env_variable or the such @nkaretnikov

src/features/environmentCreate/components/Specification/SpecificationCreate.tsx

This reverts commit 5f08435.

gabalafou

Thanks @nkaretnikov!

nkaretnikov · 2024-02-28T18:01:05Z

@trallard this is ready, but it needs your approval before I can merge.

* Allow passing `variables` via raw YAML Fixes conda-incubator#350. * Replace `formatCode` with `stringify` * Use `variables` from the global state * Do not repeat `variables` twice * Get back to using `formatCode` The custom pretty-printer is there to avoid printing `[]` when no data is available, which is not very user-friendly. * Rename `variables` to `environmentVariables` * Check if text input is working in playwright tests * Fixup: serialize as `variables` * Add tests * Add more tests * Fixup: serialize as `variables` on create * Update tests * Fixup: serialize as `variables` on edit * Fixup: serialize as `variables` on edit * Rename back to `variables` in `CondaSpecification` * Fixup: rename back to `variables` to avoid serialization bugs * Fix the test * Revert "Check if text input is working in playwright tests" This reverts commit 5f08435. * Update tests * Create a new test * Check siblings * Add waitFor * Run linter * Save variables on toggle on create env * Save variables on toggle on edit env * Revert all test changes * Remove redundant dispatch * Fix a broken test