feat: Special launcher for training projects #1133

amolenaar · 2023-10-26T13:36:47Z

This MR introduces a special launcher for training sessions:

This launcher will launch all models in the training project.

TODO:

Mount persistent workspace
Load models in special folders for the tool/version.
slug for tools and versions. Slug should not change when tool/version is renamed

See #1004.

Open questions

Should the backend error on misconfigured models, or just skip them? (E.g. models without a primary git model, tooling with no readonly image). Outcome: ignore mis-/incompletely configured models

Out of scope

Clicking the launch button currently directs you to the sessions view. It should direct you to the session viewer eventually, but we cannot show that one yet for starting sessions.
The new card is only for training projects. General projects still have the current "read-only" card.

codecov · 2023-10-26T13:36:54Z

Codecov Report

Attention: Patch coverage is 72.72727% with 15 lines in your changes missing coverage. Please review.

Project coverage is 72.86%. Comparing base (02ce4dc) to head (ec9725a).
Report is 763 commits behind head on main.

Files with missing lines	Patch %	Lines
backend/capellacollab/sessions/routes.py	67.39%	8 Missing and 7 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1133      +/-   ##
==========================================
+ Coverage   72.83%   72.86%   +0.02%     
==========================================
  Files         162      162              
  Lines        5345     5391      +46     
  Branches      601      611      +10     
==========================================
+ Hits         3893     3928      +35     
- Misses       1321     1327       +6     
- Partials      131      136       +5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

backend/capellacollab/sessions/routes.py

dominik003

Thank you very much for this nice PR. There are a few comments from my side, hopefully all more or less understandable and sensible.
Also, there are a few things in Sonar that should be addressed as well (some of them are somehow included in my suggestions). So it might make sense to go through the comments first and see if there are any outstanding points from Sonar at the end.

backend/capellacollab/alembic/versions/2827788b8d2d_add_slugs_for_tools_and_versions.py

backend/capellacollab/sessions/exceptions.py

backend/capellacollab/sessions/models.py

backend/capellacollab/sessions/routes.py

backend/tests/sessions/test_sessions_routes.py

frontend/src/app/projects/project-detail/project-details.component.html

...s/user-sessions-wrapper/create-session/provision-workspace/provision-workspace.component.css

...ns/user-sessions-wrapper/create-session/provision-workspace/provision-workspace.component.ts

sonarqubecloud · 2023-11-23T08:53:54Z

SonarCloud Quality Gate failed.

2 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

MoritzWeber0 · 2023-12-15T15:51:51Z

backend/capellacollab/sessions/routes.py

@@ -542,6 +566,149 @@ def create_database_and_guacamole_session(
    )


+@project_router.post(


The new endpoint is good, however, we should merge it with the read-only endpoint. They have many lines in common and we should reduce code duplication as best as possible.

As described in #1004, pre-provisioned sessions shall replace read-only sessions. pre-provisioned sessions have the same logic like read-only sessions. The only difference is that no persistent volume is passed.

This doesn't apply to the backend route. Also, the frontend components shall be merged.

I like to keep them separate endpoints for now. This PR focuses on spawning training sessions. Doing a rewrite of read-only sessions will blow up the scope of this PR.

I don't like the two endpoints due to the code duplication, which we try to avoid. The duplication increases future code maintainability and the effort to merge those is not too high. The provision endpoint is very similar to the read-only endpoint. The provision endpoint shall take a list of models instead of the project name anyway as decided in #1004.

Given this, there is only one flag to add: persistent, which is a boolean that can be set to true or false. With this flag, we get rid of the code duplication and have one merged endpoint.

Since this PR implements #1004, which explicitly mentions that we want to merge both endpoints, I don't see it out of scope.

dominik003

Some last comments from my side and also saw one open comment from @MoritzWeber0
Unfortunately, I am currently getting an error when building the backend image. Rebasing on main should resolve this. So after the rebase I will try out the functionality and when everything works fine, I'll approve it.

backend/capellacollab/tools/models.py

.../user-sessions-wrapper/create-session/provision-workspace/provision-workspace.component.html

dominik003 · 2023-12-19T13:13:29Z

.../user-sessions-wrapper/create-session/provision-workspace/provision-workspace.component.html

In addition to my below comments I have two other more general comments/questions:

Currently, this component is only shown in case projectType === 'training'. By the components name I suspect that we do want to either use this component somewhere else or also for general projects in the future?

Currently the button text is fixed to Start this training. In case we do want to also use the component for non training projects, we should make this text conditional on whether we have a training or general project.

I do not want to make to many assumptions on what we're going to do with this component. It supports starting training sessions.

Co-authored-by: dominik003 <[email protected]>

So the flow of the provision route is more clear.

So we do not spin up a lot of sessions.

Co-authored-by: dominik003 <[email protected]>

github-actions · 2024-01-26T08:20:24Z

The pull request does not conform to the conventional commit specification. Please ensure that your commit messages follow the spec: https://www.conventionalcommits.org/.
We also strongly recommend that you set up your development environment with pre-commit, as described in our Developer documentation. This will run all the important checks right before you commit your changes, and avoids lengthy CI wait time and round trips.

This is the commit validation log:

⧗   input: fix: clean up provision workspace component
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: Remove unneeded ids

Co-authored-by: dominik003 <[email protected]>
✖   subject may not be empty [subject-empty]
✖   type may not be empty [type-empty]

✖   found 2 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: Remove redundant nullable column mapper

Co-authored-by: dominik003 <[email protected]>
✖   subject may not be empty [subject-empty]
✖   type may not be empty [type-empty]

✖   found 2 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: Remove redundant nullable column mapper

Co-authored-by: dominik003 <[email protected]>
✖   subject may not be empty [subject-empty]
✖   type may not be empty [type-empty]

✖   found 2 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: Remove fieldset around Persistent workspace toggle

Co-authored-by: dominik003 <[email protected]>
✖   subject may not be empty [subject-empty]
✖   type may not be empty [type-empty]

✖   found 2 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: remove fieldset around Start training button

Co-authored-by: dominik003 <[email protected]>
✖   subject may not be empty [subject-empty]
✖   type may not be empty [type-empty]

✖   found 2 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: fix: disable start button once pressed

So we do not spin up a lot of sessions.
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: fix: move validation to a separate function

So the flow of the provision route is more clear.
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: fix: clean up duplicate code
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: fix: refactor session launching
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: fix: model selection for provisioned sessions
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: fix: remove ununsed model
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: fix: remove unused css file for provision-workspace component
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: fix: clean up dependent fields in provision endpoint
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: fix: remove unused exception
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: fix: make tool slug column unique
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: fix: set warnings
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: fix: use project in frontend directly from service

Co-authored-by: dominik003 <[email protected]>
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: fix: remove print statement

Co-authored-by: dominik003 <[email protected]>
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: fix: no need for model config in post request

Co-authored-by: dominik003 <[email protected]>
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: feat: use slugs for workspace folders
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

⧗   input: feat: show special launcher card for trainings
✖   subject must be sentence-case [subject-case]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

Here are some examples of valid commit messages:

build: Bump frontend versions
docs(user): Add model creation workflow
feat: Add a monitoring dashboard

sonarqubecloud · 2024-01-26T08:20:48Z

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

MoritzWeber0 · 2024-03-05T14:24:01Z

We'll wait for the web-based tool support, which has merged the persistent and read-only routes, but also prepared the interface for pre-provisioned workspaces. After #1355 is merged, we can rebase this PR.

MoritzWeber0 · 2024-08-02T10:41:17Z

Due to the number of conflicts and the status of the PR, I will close the PR. It can still be used as inspiration for an implementation in the future.

amolenaar requested a review from MoritzWeber0 as a code owner October 26, 2023 13:36

amolenaar marked this pull request as draft October 26, 2023 13:36

amolenaar force-pushed the training-projects branch 2 times, most recently from 88dd108 to 4007c43 Compare October 26, 2023 15:03

amolenaar force-pushed the launch-training branch 2 times, most recently from 1d0d6ec to f9db517 Compare October 27, 2023 18:19

amolenaar changed the title ~~Show special launcher card for trainings~~ feat: Special launcher for training projects Nov 2, 2023

amolenaar force-pushed the training-projects branch 2 times, most recently from 352aeaf to 336fe63 Compare November 8, 2023 09:48

amolenaar force-pushed the launch-training branch from 8e02c2a to eea4952 Compare November 8, 2023 09:53

amolenaar marked this pull request as ready for review November 13, 2023 07:59

amolenaar requested a review from dominik003 November 13, 2023 07:59

MoritzWeber0 reviewed Nov 13, 2023

View reviewed changes

backend/capellacollab/sessions/routes.py Outdated Show resolved Hide resolved

dominik003 suggested changes Nov 13, 2023

View reviewed changes

amolenaar force-pushed the launch-training branch from 29d5a40 to ddbb960 Compare November 13, 2023 17:05

amolenaar force-pushed the training-projects branch from 8d4d93e to fccb578 Compare November 21, 2023 16:38

amolenaar force-pushed the launch-training branch from 8dc8674 to 8705102 Compare November 21, 2023 16:41

Base automatically changed from training-projects to main December 15, 2023 14:16

amolenaar requested a review from dominik003 December 15, 2023 15:16

MoritzWeber0 reviewed Dec 15, 2023

View reviewed changes

dominik003 reviewed Dec 19, 2023

View reviewed changes

amolenaar force-pushed the launch-training branch 3 times, most recently from bdb75f3 to 5a9d6d9 Compare January 22, 2024 13:00

amolenaar added 4 commits January 26, 2024 09:18

feat: show special launcher card for trainings

4dfed83

feat: Add backend code to launch training sessions

9bfa086

feat: Add API endpoint to launch any model

a3b5c63

feat: Launch both Capella and Jupyter sessions for trainings

a5d10dd

amolenaar and others added 22 commits January 26, 2024 09:18

feat: use slugs for workspace folders

218752e

fix: no need for model config in post request

4933de9

Co-authored-by: dominik003 <[email protected]>

fix: remove print statement

39c96a2

Co-authored-by: dominik003 <[email protected]>

fix: use project in frontend directly from service

3f28090

Co-authored-by: dominik003 <[email protected]>

fix: set warnings

1d58bb3

fix: make tool slug column unique

8f23ffa

fix: remove unused exception

c549b45

fix: clean up dependent fields in provision endpoint

a7f26ce

fix: remove unused css file for provision-workspace component

eb345db

fix: remove ununsed model

864ee4b

fix: model selection for provisioned sessions

1ddb76e

fix: refactor session launching

e0175b2

fix: clean up duplicate code

df9656e

fix: move validation to a separate function

b3132fd

So the flow of the provision route is more clear.

fix: disable start button once pressed

701645d

So we do not spin up a lot of sessions.

remove fieldset around Start training button

b7b3f09

Co-authored-by: dominik003 <[email protected]>

Remove fieldset around Persistent workspace toggle

c449ec0

Co-authored-by: dominik003 <[email protected]>

Remove redundant nullable column mapper

8f832df

Co-authored-by: dominik003 <[email protected]>

Remove redundant nullable column mapper

6d91439

Co-authored-by: dominik003 <[email protected]>

Remove unneeded ids

fdf5d76

Co-authored-by: dominik003 <[email protected]>

fix: clean up provision workspace component

eae1426

fix: TS linting issues

ec9725a

amolenaar force-pushed the launch-training branch from 6d7514c to ec9725a Compare January 26, 2024 08:20

MoritzWeber0 marked this pull request as draft March 5, 2024 14:23

MoritzWeber0 closed this Aug 2, 2024

MoritzWeber0 deleted the launch-training branch September 2, 2024 14:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Special launcher for training projects #1133

feat: Special launcher for training projects #1133

amolenaar commented Oct 26, 2023 •

edited

Loading

codecov bot commented Oct 26, 2023 •

edited

Loading

dominik003 left a comment

sonarqubecloud bot commented Nov 23, 2023

MoritzWeber0 Dec 15, 2023 •

edited

Loading

amolenaar Jan 22, 2024

MoritzWeber0 Jan 22, 2024 •

edited

Loading

dominik003 left a comment

dominik003 Dec 19, 2023

amolenaar Jan 22, 2024

github-actions bot commented Jan 26, 2024

sonarqubecloud bot commented Jan 26, 2024

MoritzWeber0 commented Mar 5, 2024

MoritzWeber0 commented Aug 2, 2024

		@@ -542,6 +566,149 @@ def create_database_and_guacamole_session(
		)


		@project_router.post(

feat: Special launcher for training projects #1133

feat: Special launcher for training projects #1133

Conversation

amolenaar commented Oct 26, 2023 • edited Loading

Open questions

Out of scope

codecov bot commented Oct 26, 2023 • edited Loading

Codecov Report

dominik003 left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Nov 23, 2023

MoritzWeber0 Dec 15, 2023 • edited Loading

Choose a reason for hiding this comment

amolenaar Jan 22, 2024

Choose a reason for hiding this comment

MoritzWeber0 Jan 22, 2024 • edited Loading

Choose a reason for hiding this comment

dominik003 left a comment

Choose a reason for hiding this comment

dominik003 Dec 19, 2023

Choose a reason for hiding this comment

amolenaar Jan 22, 2024

Choose a reason for hiding this comment

github-actions bot commented Jan 26, 2024

sonarqubecloud bot commented Jan 26, 2024

Quality Gate passed

MoritzWeber0 commented Mar 5, 2024

MoritzWeber0 commented Aug 2, 2024

amolenaar commented Oct 26, 2023 •

edited

Loading

codecov bot commented Oct 26, 2023 •

edited

Loading

MoritzWeber0 Dec 15, 2023 •

edited

Loading

MoritzWeber0 Jan 22, 2024 •

edited

Loading