Add journal storage loader

[gen740]

Contributor License Agreement

This repository (optuna-dashboard) and Goptuna share common code.
This pull request may therefore be ported to Goptuna.
Make sure that you understand the consequences concerning licenses and check the box below if you accept the term before creating this pull request.

• I agree this patch may be ported to Goptuna by other Goptuna contributors.

Reference Issues/PRs

None

What does this implement/fix? Explain your changes.

• Add journalStorage.ts into standalone app, enabling journal storage support.

[codecov]

Codecov Report

Attention: 26 lines in your changes are missing coverage. Please review.

Comparison is base (1203501) 68.22% compared to head (48629d3) 68.22%.
Report is 196 commits behind head on main.

Files	Patch %	Lines
optuna_dashboard/artifact/_backend.py	31.42%	24 Missing ⚠️
optuna_dashboard/_app.py	94.59%	2 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #732   +/-   ##
=======================================
  Coverage   68.22%   68.22%           
=======================================
  Files          35       35           
  Lines        2329     2329           
=======================================
  Hits         1589     1589           
  Misses        740      740           

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

[nabenabe0928]

@c-bata Could you review this PR?

[nabenabe0928]

@c-bata I removed you from the assignee of this PR.
@keisuke-umezawa Could you review this PR?

[keisuke-umezawa]

This is early review comment. I checked PR other than JournalStorage implementation. I will check it later 🙏
Btw, I hope we can add some tests for it. At least, can you add e2e test for this one similar to this test?

optuna-dashboard/e2e_tests/test_standalone/test_study_list.py

Lines 28 to 74 in 38cc928

	def test_load_storage(
	page: Page,
	server_url: str,
	) -> None:
	study_name = "single-objective"
	url = f"{server_url}"
	def create_storage_file(filename: str):
	import optuna
	storage = optuna.storages.RDBStorage(f"sqlite:///{filename}")
	study = optuna.create_study(study_name=study_name, storage=storage)
	def objective(trial: optuna.Trial) -> float:
	x1 = trial.suggest_float("x1", 0, 10)
	x2 = trial.suggest_float("x2", 0, 10)
	return (x1 - 2) ** 2 + (x2 - 5) ** 2
	study.optimize(objective, n_trials=100)
	with tempfile.TemporaryDirectory() as dir:
	with tempfile.NamedTemporaryFile() as fp:
	filename = fp.name
	path = os.path.join(dir, filename)
	create_storage_file(filename)
	page.goto(url)
	with page.expect_file_chooser() as fc_info:
	page.get_by_role(
	"button",
	name="Load an Optuna Storage Drag your SQLite3 file here or click to browse.",
	).click()
	file_chooser = fc_info.value
	file_chooser.set_files(path)
	page.get_by_role("link", name=study_name).click()
	def count_components(page: Page, component_name: str):
	component_count = page.evaluate(
	f"""() => {{
	const components = document.querySelectorAll('.{component_name}');
	return components.length;
	}}"""
	)
	return component_count
	count = count_components(page, "MuiCard-root")
	assert count == 4

[keisuke-umezawa]

[question] Do you have any way to check that the file is compatible with JournalStorage? If yes, we can add "else if" to check it.

[gen740]

Unfortunately, there is no "header" or special "flag" in the JournalStorage log. The only requirement for JournalStorage is a JSON line file. We can detect the format by parsing the first line of the log, but I believe this should be handled in the JournalStorage class.

[keisuke-umezawa]

ditto.

[gen740]

@keisuke-umezawa Thank you for your comments!
Currently, Optuna-dashboard's standalone app lacks a test system. Consequently, there is no way to implement tests at this time. However, I plan to develop and add a testing system for the standalone app as a follow-up.

[keisuke-umezawa]

@gen740
Ok. In that case, I will quickly check this PR weather it will not break the entire system. If not, I will merge it soon.

[keisuke-umezawa]

I confirmed that it also works well in my env. I merge it. Let's add some tests later.