[FEATURE] Make EXT:solrdebogtools plug-and-play installable

dkd-kaehm · dkd-kaehm · commit 816877a9971c · 2025-10-10T12:10:20.000+02:00
This change provides a placeholder Fluid partials to be able to use EXT:solrdebugtools as plug&play addon with default EXT:solr templates. Fixes: #4237
diff --git a/Resources/Private/Partials/Debug/Explain.html b/Resources/Private/Partials/Debug/Explain.html
@@ -0,0 +1,22 @@
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en"
+			xmlns:f="http://typo3.org/ns/TYPO3/Fluid/ViewHelpers"
+			xmlns:s="http://typo3.org/ns/ApacheSolrForTypo3/Solr/ViewHelpers"
+			data-namespace-typo3-fluid="true"
+>
+<f:comment><!--
+This file is a placeholder to allow EXT:solrdebugtools work as plug&play addon.
+
+Explain addon
+
+With Apache Solr you have the possibility get a detailed explain output, that explains how the score was calculated for a certain document.
+In the end this helps to understand why which document is on the first position of the results page.
+
+What does it do?
+
+Apache Solr's explain-output is very technical and detailed but also hard to understand.
+Inspired by explain.solr.pl we created a library to calculate the impact of each field.
+This data can be visualized e.g. in a chart to make it easier to understand that information.
+
+--></f:comment>
+<f:section name="Explain"><s:debug.documentScoreAnalyzer document="{document}" /></f:section>
+</html>
diff --git a/Resources/Private/Partials/Debug/Query.html b/Resources/Private/Partials/Debug/Query.html
@@ -0,0 +1,17 @@
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en"
+			xmlns:f="http://typo3.org/ns/TYPO3/Fluid/ViewHelpers"
+			data-namespace-typo3-fluid="true"
+>
+<f:comment><!--
+This file is a placeholder to allow EXT:solrdebugtools work as plug&play addon.
+
+EXT:solr generates a query for Apache Solr based on configuration and user input.
+This query is important for debugging.
+It helps to understand the order or to manually execute this query on the solr server.
+You can try the query-settings in Apache Solr admin UI and then transfer them into TypoScript configurations or implement new features.
+
+NOTE: The debug-query may not work properly if POST-Big-Request solarium plugin is enabled. See: TYPO3-Solr/ext-solr#3115 (comment)
+
+--></f:comment>
+<f:section name="Query"/>
+</html>
diff --git a/Resources/Private/Partials/Result/Document.html b/Resources/Private/Partials/Result/Document.html
@@ -44,7 +44,7 @@ <h3 class="results-topic"><a href="{s:uri.result.addSearchWordList(url:document.
 				</p>
 			</f:if>
 
-			<f:variable name="documentScoreAnalyze"><s:debug.documentScoreAnalyzer document="{document}" /></f:variable>
+			<f:variable name="documentScoreAnalyze"><f:render partial="Debug/Explain" section="Explain" arguments="{document: document, resultSet: resultSet}" /></f:variable>
 			<f:if condition="{documentScoreAnalyze}">
 				<div class="query-debug alert alert-info" role="alert"><f:format.raw>{documentScoreAnalyze}</f:format.raw></div>
 			</f:if>
diff --git a/Resources/Private/Templates/Search/Results.html b/Resources/Private/Templates/Search/Results.html
@@ -9,6 +9,12 @@
 <f:section name="content">
 	<div id="tx-solr-search" class="d-grid gap-3">
 
+		<div class="row">
+			<div class="col-12">
+				<f:render partial="Debug/Query" section="Query" arguments="{resultSet: resultSet}" />
+			</div>
+		</div>
+
 		<div class="row">
 			<div class="tx-solr-search-form col-lg-8">
 				<f:render partial="Search/Form" section="Form" arguments="{search:search, additionalFilters:additionalFilters, pluginNamespace: pluginNamespace, resultSet: resultSet}" />
