Add a dashboard launcher by notoraptor · Pull Request #943 · Epistimio/orion

notoraptor · 2022-06-07T02:37:20Z

Description

Hi @bouthilx ! This is a PR to add a dashboard launcher.

Changes

Add a compiled code of dashboard into dashboard/build
Add a script orion frontend to run dashboard build.
Add a Github Actions to test dashboard build through orion frontend script, using selenium framework.

Checklist

Tests

I added corresponding tests for bug fixes and new features. If possible, the tests fail without the changes
All new and existing tests are passing ($ tox -e py38; replace 38 by your Python version if necessary)

Documentation

I have updated the relevant documentation related to my changes

Quality

I have read the CONTRIBUTING doc
My commits messages follow this format
My code follows the style guidelines ($ tox -e lint)

dashboard/src/public/index.html

src/orion/core/cli/frontend.py

notoraptor · 2022-06-09T01:16:41Z

Hi @bouthilx PR updated. Dashboard build test CI is moved to build.yml and makes a yarn build before testing. Testing script is also now splitted into unit tests and runs with pytest in CI.

In last commit, I try to include dashboard/build folder into Python package. I tested it on my computed. It is indeed included in tar.gz generated file using python setup.py sdist, but it is not included in orion package when package file is installed. At most, it created a dashboard folder in sys.prefix path (because of data_files added in setup.py, see commit), but it is outside the orion installed package folder.

It seems the best way to correctly include dashboard/build is to move it inside the src/orion folder. What do you think?

bouthilx · 2022-06-10T14:13:38Z

Thanks for the follow up! Do you think using sys.prefix could allow pointing to the dashboard folder?

.github/workflows/build.yml

bouthilx · 2022-06-14T18:37:04Z

src/orion/core/cli/frontend.py

+                "build",
+            )
+        )
+    assert os.path.isdir(dashboard_build_path)


This should be if-raise. What message could we provide the user to explain this error? That the folder is not present?

Ok, now it raises a runtime error with message "Cannot find dashboard static files to run frontend".

Maybe adding where it looked for it in the error message could be helpful for the user to understand what is the source of the issue.

src/orion/core/cli/frontend.py

notoraptor · 2022-06-15T11:08:34Z

@bouthilx all tests passed !

notoraptor · 2022-06-15T21:47:23Z

Tests succeed !

- Always build dashboard before running tests Rewrite dashboard build test as real pytest-compatible tests

Install dashboard build in `orion-dashboard` folder using setup.py data_files configuration Make sure to correctly locate dashboard build either in installation or in repository code

… pypi and conda jobs

… from PYPI package

Simplify checking on user-install case when we uninstall.

Check only if dashboard build files are removed on uninstall (root folder seems not deleted in any case when running CI)

…t found

notoraptor · 2022-06-17T13:42:59Z

Rebased!

bouthilx reviewed Jun 8, 2022

View reviewed changes

dashboard/src/public/index.html Outdated Show resolved Hide resolved

bouthilx reviewed Jun 8, 2022

View reviewed changes

src/orion/core/cli/frontend.py Outdated Show resolved Hide resolved

bouthilx reviewed Jun 8, 2022

View reviewed changes

src/orion/core/cli/frontend.py Outdated Show resolved Hide resolved

notoraptor force-pushed the dashboard-launcher branch 3 times, most recently from b1ce959 to 396fd37 Compare June 8, 2022 21:22

notoraptor force-pushed the dashboard-launcher branch 2 times, most recently from 205d133 to 16e8b48 Compare June 14, 2022 13:20

bouthilx reviewed Jun 14, 2022

View reviewed changes

.github/workflows/build.yml Show resolved Hide resolved

bouthilx reviewed Jun 14, 2022

View reviewed changes

src/orion/core/cli/frontend.py Outdated Show resolved Hide resolved

bouthilx approved these changes Jun 15, 2022

View reviewed changes

notoraptor added 14 commits June 17, 2022 09:39

Add a command to launch compiled Orion Dashboard from Orion code

8e91a79

Use dashboard/build folder for frontend compiled code

3df0c82

Remove old dashboard code in orion/core/cli

03458e0

Add testing to check dashboard build via orion frontend script

1b6ce62

Move selenium dependency to test extras.

82c407e

Revert typo changes from Orion to Oríon

9bac685

Reorganize imports in frontend script

b019cba

Move dashboard build test into build.yml

63de230

- Always build dashboard before running tests Rewrite dashboard build test as real pytest-compatible tests

Update MANIFEST to include dashboard build into package file

43f0a9a

Install dashboard build in `orion-dashboard` folder using setup.py data_files configuration Make sure to correctly locate dashboard build either in installation or in repository code

Github build workflow: add test-dashboard-build into dependencies for…

94e44db

… pypi and conda jobs

Raise a runtime error if dashboard build is not found.

87c9b5b

Github build workflow: test if dashboard build is correctly installed…

e5f6c42

… from PYPI package

Test if frontend script can find dashboard build.

e9e5735

Simplify checking on user-install case when we uninstall.

Add logging and checks when testing normal install

683779e

notoraptor added 3 commits June 17, 2022 09:41

Add logging

90bf98f

Check only if dashboard build files are removed on uninstall (root folder seems not deleted in any case when running CI)

Fix command to uninstall in user mode

b9292eb

Add expected dashboard build path to error message if dashboard is no…

6cfc500

…t found

notoraptor force-pushed the dashboard-launcher branch from 2f1a9b2 to 6cfc500 Compare June 17, 2022 13:42

bouthilx merged commit c1ae71b into Epistimio:develop Jun 17, 2022

notoraptor deleted the dashboard-launcher branch June 21, 2022 14:55

notoraptor mentioned this pull request Aug 2, 2022

Release 0.2.5rc #980

Merged

bouthilx added feature Introduces a new feature dashboard labels Aug 2, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a dashboard launcher#943

Add a dashboard launcher#943
bouthilx merged 17 commits intoEpistimio:developfrom
notoraptor:dashboard-launcher

notoraptor commented Jun 7, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

notoraptor commented Jun 9, 2022

Uh oh!

bouthilx commented Jun 10, 2022

Uh oh!

Uh oh!

bouthilx Jun 14, 2022

Uh oh!

notoraptor Jun 14, 2022

Uh oh!

bouthilx Jun 14, 2022

Uh oh!

notoraptor Jun 15, 2022

Uh oh!

Uh oh!

notoraptor commented Jun 15, 2022

Uh oh!

notoraptor commented Jun 15, 2022

Uh oh!

notoraptor commented Jun 17, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

notoraptor commented Jun 7, 2022

Description

Changes

Checklist

Tests

Documentation

Quality

Uh oh!

Uh oh!

Uh oh!

Uh oh!

notoraptor commented Jun 9, 2022

Uh oh!

bouthilx commented Jun 10, 2022

Uh oh!

Uh oh!

bouthilx Jun 14, 2022

Choose a reason for hiding this comment

Uh oh!

notoraptor Jun 14, 2022

Choose a reason for hiding this comment

Uh oh!

bouthilx Jun 14, 2022

Choose a reason for hiding this comment

Uh oh!

notoraptor Jun 15, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

notoraptor commented Jun 15, 2022

Uh oh!

notoraptor commented Jun 15, 2022

Uh oh!

notoraptor commented Jun 17, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants