Search reset button not working properly

[josegar74]

Describe the bug
Search reset button should clean up the search fields and trigger a search to show all the results.

In some cases, the button is clicked and nothing happens. Clicking it a second time, works fine.

The issue happens in 3.12.x and main branches.

To Reproduce
Steps to reproduce the behavior:

Case 1:

1. In the home page, filter by a topic category.
2. In the search page, click the reset button --> Search is executed and shows all results
3. Go (with the application logo in the top bar) to the home page and select the same topic category
4. In the search page, click the Reset button, nothing happens.
5. Click the Reset button a second time and then it works

Case 2:

1. In the search page, click the search button for an empty search
2. Write a search filter and click the search button
3. Click reset --> First time doesn't work, second works

Expected behavior
Clicking the Reset button once, cleanups the search fields and executes an empty search to return all the results.

Additional context

The code involved it's

core-geonetwork/web-ui/src/main/resources/catalog/components/search/searchmanager/SearchFormDirective.js

Lines 321 to 325 in 2731e56

	if (angular.equals(params, gnSearchLocation.getParams())) {
	triggerSearchFn(false);
	} else {
	gnSearchLocation.setSearch(params);
	}

When it doesn't work, executes:

core-geonetwork/web-ui/src/main/resources/catalog/components/search/searchmanager/SearchFormDirective.js

Line 324 in 2731e56

gnSearchLocation.setSearch(params);

the next time, that works, enters in:

core-geonetwork/web-ui/src/main/resources/catalog/components/search/searchmanager/SearchFormDirective.js

Line 322 in 2731e56

triggerSearchFn(false);

But if you go directly to the search page, do a search and click reset (that seems working), executes also:

core-geonetwork/web-ui/src/main/resources/catalog/components/search/searchmanager/SearchFormDirective.js

Line 324 in 2731e56

gnSearchLocation.setSearch(params);

A bit unclear what is causing this wrong behaviour.

[josegar74]

@fxprunayre

I have done some tests, changing this code:

core-geonetwork/web-ui/src/main/resources/catalog/components/search/searchmanager/SearchFormDirective.js

Lines 321 to 325 in 2731e56

	if (angular.equals(params, gnSearchLocation.getParams())) {
	triggerSearchFn(false);
	} else {
	gnSearchLocation.setSearch(params);
	}

Test 1:

if (angular.equals(params, gnSearchLocation.getParams())) {
  triggerSearchFn(false);
} else {
  triggerSearchFn(false);
  //gnSearchLocation.setSearch(params);
}

When clicking the Reset button, this seems working cleaning the search fields in the form and issuing a new search, but the URL hash keeps old values.

Doing a search, looks ok.

Test 2:

if (angular.equals(params, gnSearchLocation.getParams())) {
  triggerSearchFn(false);
} else {
  triggerSearchFn(false);
  gnSearchLocation.setSearch(params);
}

When clicking the Reset button, this seems working cleaning the search fields in the form and issuing a new search, updates the URL hash value. And only issues 1 search to the backend (A bit surprising as initially I was expecting 2).

But doing a search, issues 2 searches to the backend.

---

It's a bit unclear why it seems sometimes the search triggers a function that prepares and executes the query to ElasticSearch:

core-geonetwork/web-ui/src/main/resources/catalog/components/search/searchmanager/SearchFormDirective.js

Lines 143 to 283 in 2731e56

	this.triggerSearchFn = function (keepPagination) {
	$scope.searching++;
	$scope.searchObj.params = angular.extend(
	{},
	$scope.searchObj.defaultParams || defaultParams,
	$scope.searchObj.params,
	defaultParams
	);
	// Set default pagination if not set
	if (
	(!keepPagination && !$scope.searchObj.permalink) ||
	angular.isUndefined($scope.searchObj.params.from) ||
	angular.isUndefined($scope.searchObj.params.to)
	) {
	self.resetPagination();
	}
	// Set default sortBy
	if (angular.isUndefined($scope.searchObj.params.sortBy)) {
	angular.extend($scope.searchObj.params, $scope.searchObj.sortbyDefault);
	}
	var params = angular.copy($scope.searchObj.params);
	var finalParams = angular.extend(params, hiddenParams);
	$scope.finalParams = finalParams;
	var esParams = gnESService.generateEsRequest(
	finalParams,
	$scope.searchObj.state,
	$scope.searchObj.configId,
	$scope.searchObj.filters
	);
	function buildSearchKey(esParams) {
	var param = angular.copy(esParams, {});
	["from", "size", "sort"].forEach(function (k) {
	delete param[k];
	});
	return md5.createHash(JSON.stringify(param));
	}
	// Compute facet only if search is reset or new filters apply
	// When moving in pages or changing sort,
	// no need to compute aggregations again and again
	var searchKey = buildSearchKey(esParams),
	dontComputeAggs = $scope.searchResults.searchKey === searchKey,
	lastSearchAggs = undefined;
	if (dontComputeAggs) {
	lastSearchAggs = $scope.searchResults.facets;
	delete esParams.aggregations;
	}
	// console.log(dontComputeAggs, $scope.searchResults.searchKey, searchKey);
	$scope.searchResults.searchKey = searchKey;
	// For now, only the list result template renders related records
	// based on UI config.
	var template =
	$scope.resultTemplate && $scope.resultTemplate.endsWith("list.html")
	? "grid"
	: "",
	templateConfig = gnGlobalSettings.gnCfg.mods.search[template],
	types = templateConfig && templateConfig.related ? templateConfig.related : [];
	gnESClient
	.search(
	esParams,
	$scope.searchResults.selectionBucket || "metadata",
	$scope.searchObj.configId,
	types
	)
	.then(
	function (data) {
	// data is not an object: this is an error
	if (typeof data !== "object") {
	console.warn(
	"An error occurred while searching. Response is not an object.",
	esParams,
	data.data
	);
	if ($scope.showHealthIndexError !== true) {
	// Index status already displayed
	gnAlertService.addAlert({
	id: "searchError",
	msg: $translate.instant("searchInvalidResponse"),
	type: "danger"
	});
	}
	return;
	}
	// make sure we have a hits object if ES did not give back anything
	data.hits = data.hits || { hits: [], total: 0 };
	var records = data.hits.hits.map(function (r) {
	return new Metadata(r);
	});
	$scope.searchResults.records = records;
	$scope.searchResults.count = data.hits.total.value;
	$scope.searchResults.facets = dontComputeAggs
	? lastSearchAggs
	: data.facets || {};
	// compute page number for pagination
	if ($scope.hasPagination) {
	var paging = $scope.paginationInfo;
	// Means the `from` and `to` params come from permalink
	if ((paging.currentPage - 1) * paging.hitsPerPage + 1 != params.from) {
	paging.currentPage = (params.from - 1) / paging.hitsPerPage + 1;
	}
	paging.resultsCount = $scope.searchResults.count;
	paging.to = Math.min(
	$scope.searchResults.count,
	paging.currentPage * paging.hitsPerPage
	);
	paging.pages = Math.ceil(
	$scope.searchResults.count / paging.hitsPerPage,
	0
	);
	paging.from = (paging.currentPage - 1) * paging.hitsPerPage + 1;
	}
	$scope.$emit("searchFinished", { count: $scope.searchResults.count });
	},
	function (data) {
	console.warn(
	"An error occurred while searching. Bad request.",
	esParams,
	data.data
	);
	gnAlertService.addAlert({
	id: "searchError",
	msg: $translate.instant("searchBadRequest"),
	type: "danger"
	});
	}
	)
	.then(function () {
	$scope.searching--;
	});
	};

And in some other cases, it seems doing that using the $location directive. What is the criteria for this?

[fxprunayre]

I would reset lastSearchUrl

gnSearchLocation.lastSearchUrl = null;

in https://github.com/geonetwork/core-geonetwork/blob/main/web-ui/src/main/resources/catalog/components/search/searchmanager/SearchFormDirective.js#L357

to avoid
https://github.com/geonetwork/core-geonetwork/blob/main/web-ui/src/main/resources/catalog/components/search/searchmanager/SearchFormDirective.js#L332-L333

What do you think ?

[josegar74]

@fxprunayre I've tried and it seems working.

I don't fully understand the logic to handle this, but apparently the change works.