[datatables] Column templates work initially but are no longer applied after filtering the table or navigating through the tablepages if limit is set

[simontaurus]

Setup

• MW version: 1.39.5
• DB (MySQL etc.): MySQL 8.0.17, blazegraph
• PHP version: 8.1.27 (apache2handler)
• SMW version: 4.1.3
• SRF version: 4.2.1
• Browsers and versions (if applicable): Firefox

Issue

Column templates work initially but are no longer applied after filtering the table or navigating through the tablepages if limit is set

Steps to reproduce

1. Create a template, e.g. DataTableTestTemplate with content Template called with "{{{1}}}"
2. Create a query, e.g.

{{#ask: [[Category:OSW92cc6b1a2e6b4bb7bad470dfdcfdaf26]]
|?HasOswId # - =|+ template = DataTableTestTemplate
|?
|?HasLabel
|?HasDescription
|mainlabel=
|format=datatable
|limit=3
}}

3. Safe the page. First collumn shows Template called with "Item:OSW..." as expected
   

4. Type something in the table search bar or navigate to the second result page

5. First column shows only Item:OSW... => template is no longer called
   

Example see: https://demo.open-semantic-lab.org/wiki/Item:OSWa59c91666913493a81ecc3539746ba4a

Expected result: Template should always be applied

Observed result: Template is no longer applied after filtering the table or navigating through the tablepages

Workaround: removing |limit=3 leads to the correct result. Documentation states that

Use printout parameters only with a single or a couple of columns in the table, with an undefined or low defer-each parameter, with an undefined or low limit, and with a low datatables-pagelength for it to work properly

Suggestion: Update this to "... with an undefined limit ..."

[simontaurus]

@thomas-topway-it: It seems like templates are not applied to defered results

[simontaurus]

Digging a little bit deeper:
Templates are handled if result format is SMW_OUTPUT_WIKI or SMW_OUTPUT_HTML:

SemanticResultFormats/formats/datatables/DataTables.php

Line 444 in 520927e

if ( $outputMode !== SMW_OUTPUT_FILE ) {

but the API request SMW_OUTPUT_FILE, leaving templates unhandled

SemanticResultFormats/formats/datatables/Api.php

Line 277 in 520927e

$res = $printer->getResult( $results, $queryParams, SMW_OUTPUT_FILE );

See also https://doc.semantic-mediawiki.org/interfaceSMW_1_1Query_1_1ResultPrinter.html

[thomas-topway-it]

@simontaurus I'm sorry for the delay, I was about to look at that. That's correct, however doesn't that affect only the html prepended or appended to the table or the table itself ? The function getCellContent seems independent from that, it could be also related to this variable $this->printoutsParameters[$label]['template'] ) which is not passed correctly using Ajax

[thomas-topway-it]

I have created a branch to handle this https://github.com/SemanticMediaWiki/SemanticResultFormats/compare/master...Knowledge-Wiki:SemanticResultFormats:datatables-fix-template-parameter-ajax?expand=1

after testing (if it works) we can merge it

[simontaurus]

@thomas-topway-it:

however doesn't that affect only the html prepended or appended to the table or the table itself ?

in my case the table itself.

I have created a branch to handle this https://github.com/SemanticMediaWiki/SemanticResultFormats/compare/master...Knowledge-Wiki:SemanticResultFormats:datatables-fix-template-parameter-ajax?expand=1

Great! This solved the issue

I added your changes to my changes (see #861) here OpenSemanticLab:SemanticResultFormats:dev. Together with SemanticMediaWiki/SemanticMediaWiki#5747 all issues are fixed.

[thomas-topway-it]

@simontaurus perfect, thank you, if you finalize the pull request we will merge it

[krabina]

What is the status of this, @simontaurus @thomas-topway-it ?

[thomas-topway-it]

@simontaurus we have to merge either this https://github.com/SemanticMediaWiki/SemanticResultFormats/compare/master...OpenSemanticLab:SemanticResultFormats:dev?expand=1 or this
https://github.com/SemanticMediaWiki/SemanticResultFormats/compare/master...Knowledge-Wiki:SemanticResultFormats:datatables-fix-template-parameter-ajax?expand=1

[thomas-topway-it]

@simontaurus I've added a more robust template expansion method, do this still needs to be merged ?

	public function getSearchPanes( array $printRequests, array $searchPanesOptions ): array {
		if ( $this->datatables->store instanceof \SMW\SPARQLStore\SPARQLStore ) {
			// we got a SPARQLStore, which is not subclass of SQLStore
			// dirty hack to access the private member baseStore, which is an instance of SQLStore
			// this can be simplified once SPARQLStore is refactored to make this member public
			// see https://github.com/SemanticMediaWiki/SemanticResultFormats/issues/827
			$closure = \Closure::bind( function &( \SMW\SPARQLStore\SPARQLStore $class ) {
				return $class->baseStore;
			}, null, \SMW\SPARQLStore\SPARQLStore::class );
			$this->datatables->store = &$closure( $this->datatables->store );
		}