is there a way to get the list URL with all default options? or could the change to add default options be exempted from history?

[dbu]

when linking to a data-table view, the url generated by symfony does not contain the default options. when the page is loaded, the URL is immediately replaced with the default options. the issue with that is that this change is added to the browser history, which means i need to go back twice if i want to use browser navigation to return. my workaround is to generate the url with all default options, but that is cumbersome.

it would be nice to either have "something" in this bundle that generates me the default url directly. or it would imho make sense to not add the change to add default parameters into the browser history.

[Kreyu]

Hey @dbu. Currently, the URL is modified by the state.js Stimulus controller from the bundle. This controller receives parameters to merge in the URL from the data table's url_query_parameters variable, which comes from the base DataTableType itself:

data-table-bundle/src/Type/DataTableType.php

Lines 399 to 437 in 6d02efb

	private function getUrlQueryParameters(DataTableView $view, DataTableInterface $dataTable): array
	{
	$parameters = [];
	if ($dataTable->getConfig()->isFiltrationEnabled()) {
	foreach ($view->filters as $filterView) {
	$value = null;
	if ($formView = $view->vars['filtration_form'][$filterView->vars['name']]['value'] ?? null) {
	$value = FormUtil::getFormViewValueRecursive($formView);
	}
	if (empty($value)) {
	continue;
	}
	$filterParameter = ['value' => $value];
	if ($filterView->vars['operator_selectable']) {
	$filterParameter['operator'] = $filterView->data->getOperator()?->value;
	}
	$parameters[$dataTable->getConfig()->getFiltrationParameterName()][$filterView->vars['name']] = $filterParameter;
	}
	}
	if ($dataTable->getConfig()->isPaginationEnabled()) {
	$parameters[$dataTable->getConfig()->getPageParameterName()] = $dataTable->getPagination()->getCurrentPageNumber();
	$parameters[$dataTable->getConfig()->getPerPageParameterName()] = $dataTable->getPagination()->getItemNumberPerPage();
	}
	if ($dataTable->getConfig()->isSortingEnabled() && $sortingData = $dataTable->getSortingData()) {
	foreach ($sortingData->getColumns() as $sortingColumnData) {
	$parameters[$dataTable->getConfig()->getSortParameterName()][$sortingColumnData->getName()] = $sortingColumnData->getDirection();
	}
	}
	return $parameters;
	}

Theoretically, you could use this logic to achieve your goal, but I'm open for better ideas on how to "load" the data table state into URL. The current implementation is kinda... buggy, because (I think) we cannot accurately convert Symfony's form into array of parameters and it breaks on some fields (e.g. #213).

[dbu]

if we could distinguish initial load of data from data after filters have been changed, we could simply not add the initial load to the browser history. imho that would be a clean solution.

[Kreyu]

I double checked on demo app:

• opened new tab
• navigated to the demo app (in my case https://127.0.0.1:8001/)
• the URL has updated to https://127.0.0.1:8001/?filter_homepage[birthDate][value][from]=&filter_homepage[birthDate][value][to]=&page_homepage=1&limit_homepage=10
• my browser navigation history has two elements:
  • empty tab
  • https://127.0.0.1:8001/?filter_homepage[birthDate][value][from]=&filter_homepage[birthDate][value][to]=&page_homepage=1&limit_homepage=10

I've also tried navigating between pages with data tables. The app navigation links does not include the additional URL parameters. I cannot replicate the need of "going back" twice. What browser are you using? I've tried on Brave 1.75.175 (Chromium 133.0.6943.54).

The state.js controller is using window.history.replaceState instead of window.history.pushState, so in theory it should work properly.

[dbu]

replaceState sounds correct, thats what i suspected to be the problem. so it must be something else.

i use symfony ux which "simulates" a single-page app. maybe there is some interaction between the 2. i usually work with firefox, but tried with google chrome to see if its a browser issue. observed the same behaviour. looking at the chrome history, i do get 2 entries for the list, the first one without query string, the second one with.

i did a screen recording - the url does not change on the first back button click, we just have nothing happen:

out.mp4

i can try to build a reproducer if you would be ok to investigate the issue further.

[maciazek]

Hey @dbu @Kreyu,

I was able to reproduce this double-entry problem in my demo app, but only in async (Turbo) mode. My demo is not async by default, but it can be enabled using a button with bolt icon in top bar.
After that:

• Open homepage in a new tab;
• Click on some menu entries - it's ok;
• Then click back button - it's still ok;
• Then click on some other menu entry - and then the problem occurs (boolean entry is twice in navigation history):

[Kreyu]

Thank you both, that makes sense. Currently, if state controller detected the Turbo, it was pushing the URL to its history, instead of replacing it:

if (typeof Turbo !== 'undefined' && null !== Turbo) {
    Turbo.navigator.history.push(url); // should be "replace" instead of "push"
}

Should be all working fine in 0.31.2! If you're not using asset mapper, remember to reinstall and rebuild the assets, as the change was in the bundle's state Stimulus controller.

[maciazek]

Updated my demo app - now I don't see these double entries anymore 👍