From d350e0ff2f3c68261fb6e9fd9c18dfc797ab25ab Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Mon, 14 Apr 2025 12:03:45 +0530
Subject: [PATCH 01/56] Author should be able to search pages by name in
navigation.
---
openapi.yml | 7 +++++++
src/Controller/ApiContentControllers.php | 14 +++++++++++++-
ui/src/components/pageInfo/PageInfo.tsx | 6 ++++--
ui/src/services/content.ts | 18 ++++++++++++++++--
4 files changed, 40 insertions(+), 5 deletions(-)
diff --git a/openapi.yml b/openapi.yml
index ebc01725a9..fbd72d9223 100644
--- a/openapi.yml
+++ b/openapi.yml
@@ -633,6 +633,13 @@ paths:
'/xb/api/content/xb_page':
get:
description: Provides api for page listing.
+ parameters:
+ - in: query
+ name: search
+ required: false
+ description: Search term to filter content by title
+ schema:
+ type: string
responses:
200:
description: Page list generated successfully.
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 4daa82d5eb..7b762aef36 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -14,6 +14,7 @@ use Drupal\Core\Render\RenderContext;
use Drupal\Core\Render\RendererInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Drupal\experience_builder\AutoSave\AutoSaveManager;
@@ -77,7 +78,7 @@ final class ApiContentControllers {
*
* @see https://www.drupal.org/project/experience_builder/issues/3500052#comment-15966496
*/
- public function list(): CacheableJsonResponse {
+ public function list(Request $request): CacheableJsonResponse {
// @todo introduce pagination in https://www.drupal.org/i/3502691
$storage = $this->entityTypeManager->getStorage('xb_page');
$query_cacheability = (new CacheableMetadata())
@@ -87,6 +88,16 @@ final class ApiContentControllers {
// We don't need to worry about the status of the page, as we need both
// published and unpublished pages on the frontend.
$entity_query = $storage->getQuery()->accessCheck(TRUE);
+
+ // Check if search parameter is present in the request
+ if ($request->query->has('search')) {
+ $search = $request->query->get('search');
+ $label_key = $storage->getEntityType()->getKey('label');
+ if ($label_key) {
+ $entity_query->condition($label_key, '%' . $search . '%', 'LIKE');
+ }
+ }
+
$ids = $this->executeQueryInRenderContext($entity_query, $query_cacheability);
/** @var \Drupal\Core\Entity\EntityPublishedInterface[] $content_entities */
$content_entities = $storage->loadMultiple($ids);
@@ -125,6 +136,7 @@ final class ApiContentControllers {
}
$json_response = new CacheableJsonResponse($content_list);
// @todo add cache contexts for query params when introducing pagination in https://www.drupal.org/i/3502691.
+ $query_cacheability->addCacheContexts(['url.query_args:search']);
$json_response->addCacheableDependency($query_cacheability)
->addCacheableDependency($url_cacheability);
if (isset($autoSaveData)) {
diff --git a/ui/src/components/pageInfo/PageInfo.tsx b/ui/src/components/pageInfo/PageInfo.tsx
index cf26b62fbf..2546eda823 100644
--- a/ui/src/components/pageInfo/PageInfo.tsx
+++ b/ui/src/components/pageInfo/PageInfo.tsx
@@ -31,6 +31,7 @@ import {
import { useCreateContentMutation } from '@/services/contentCreate';
import { useNavigationUtils } from '@/hooks/useNavigationUtils';
import { useErrorBoundary } from 'react-error-boundary';
+import { useState } from 'react';
import type { ContentStub } from '@/types/Content';
import PageStatus from '@/components/pageStatus/PageStatus';
import clsx from 'clsx';
@@ -65,11 +66,12 @@ const PageInfo = () => {
const title =
entity_form_fields[`${drupalSettings.xb.entityTypeKeys.label}[0][value]`];
+ const [searchTerm, setSearchTerm] = useState<string>('');
const {
data: pageItems,
isLoading: isPageItemsLoading,
error: pageItemsError,
- } = useGetContentListQuery('xb_page');
+ } = useGetContentListQuery({ entityType: 'xb_page', search: searchTerm });
const [
createContent,
@@ -159,7 +161,7 @@ const PageInfo = () => {
loading={isPageItemsLoading}
items={pageItems || []}
onNewPage={handleNewPage}
- onSearch={handleNonWorkingBtn}
+ onSearch={(value) => setSearchTerm(value)}
onSelect={handleOnSelect}
onRename={handleNonWorkingBtn}
onDuplicate={handleNonWorkingBtn}
diff --git a/ui/src/services/content.ts b/ui/src/services/content.ts
index e8bf5ff087..75e3804ca9 100644
--- a/ui/src/services/content.ts
+++ b/ui/src/services/content.ts
@@ -11,13 +11,27 @@ export interface DeleteContentRequest {
entityId: string;
}
+export interface ContentListParams {
+ entityType: string;
+ search?: string;
+}
+
export const contentApi = createApi({
reducerPath: 'contentApi',
baseQuery,
tagTypes: ['Content'],
endpoints: (builder) => ({
- getContentList: builder.query<ContentStub[], string>({
- query: (entityType) => `/xb/api/content/${entityType}`,
+ getContentList: builder.query<ContentStub[], ContentListParams>({
+ query: ({ entityType, search }) => {
+ const params = new URLSearchParams();
+ if (search) {
+ params.append('search', search);
+ }
+ return {
+ url: `/xb/api/content/${entityType}`,
+ params: search ? params : undefined,
+ };
+ },
transformResponse: (response: ContentListResponse) => {
return Object.values(response);
},
--
GitLab
From d8a928a5de76824b1c351a939916bd44940720fc Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Mon, 14 Apr 2025 13:43:09 +0530
Subject: [PATCH 02/56] update functional test to check search with query
param.
---
.../Functional/XbContentEntityHttpApiTest.php | 37 +++++++++++++++----
1 file changed, 30 insertions(+), 7 deletions(-)
diff --git a/tests/src/Functional/XbContentEntityHttpApiTest.php b/tests/src/Functional/XbContentEntityHttpApiTest.php
index e92009b830..26af3c9b57 100644
--- a/tests/src/Functional/XbContentEntityHttpApiTest.php
+++ b/tests/src/Functional/XbContentEntityHttpApiTest.php
@@ -82,7 +82,7 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
$user = $this->createUser([Page::EDIT_PERMISSION], 'administer_xb_page_user');
assert($user instanceof UserInterface);
$this->drupalLogin($user);
- $body = $this->assertExpectedResponse('GET', $url, [], 200, ['user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
+ $body = $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
$no_auto_save_expected_pages = [
// Page 1 has a path alias.
'1' => [
@@ -115,7 +115,30 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
$no_auto_save_expected_pages,
$body
);
- $this->assertExpectedResponse('GET', $url, [], 200, ['user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'HIT');
+ $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'HIT');
+
+ // Test searching by query parameter
+ $search_url = Url::fromUri('base:/xb/api/content/xb_page', ['query' => ['search' => 'Page 1']]);
+ // Confirm that the cache is not hit when a different request is made with query parameter.
+ $search_body = $this->assertExpectedResponse('GET', $search_url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
+
+ $search_expected_pages = [
+ '1' => [
+ 'id' => 1,
+ 'title' => 'Page 1',
+ 'status' => TRUE,
+ 'path' => base_path() . 'page-1',
+ 'autoSaveLabel' => NULL,
+ 'autoSavePath' => NULL,
+ ],
+ ];
+
+ $this->assertEquals(
+ $search_expected_pages,
+ $search_body
+ );
+ // Confirm that the cache is hit when the same request is made again.
+ $this->assertExpectedResponse('GET', $search_url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'HIT');
$autoSaveManager = $this->container->get(AutoSaveManager::class);
$page_1 = Page::load(1);
@@ -145,7 +168,7 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
]
);
- $body = $this->assertExpectedResponse('GET', $url, [], 200, ['user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
+ $body = $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
$auto_save_expected_pages = $no_auto_save_expected_pages;
$auto_save_expected_pages['1']['autoSaveLabel'] = 'The updated title.';
$auto_save_expected_pages['1']['autoSavePath'] = '/the-updated-path';
@@ -155,7 +178,7 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
$auto_save_expected_pages,
$body
);
- $this->assertExpectedResponse('GET', $url, [], 200, ['user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'HIT');
+ $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'HIT');
// Confirm that if path alias is empty, the system path is used, not the
// existing alias if set.
@@ -181,7 +204,7 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
],
]
);
- $body = $this->assertExpectedResponse('GET', $url, [], 200, ['user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
+ $body = $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
$auto_save_expected_pages['1']['autoSavePath'] = '/page/1';
$auto_save_expected_pages['2']['autoSavePath'] = '/page/2';
$this->assertEquals(
@@ -191,12 +214,12 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
$autoSaveManager->delete($page_1);
$autoSaveManager->delete($page_2);
- $body = $this->assertExpectedResponse('GET', $url, [], 200, ['user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
+ $body = $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
$this->assertEquals(
$no_auto_save_expected_pages,
$body
);
- $this->assertExpectedResponse('GET', $url, [], 200, ['user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'HIT');
+ $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'HIT');
}
public function testDelete(): void {
--
GitLab
From b44189ca02f299645451f4a4f81d34b5c7915077 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Mon, 14 Apr 2025 16:24:37 +0530
Subject: [PATCH 03/56] Added cypress test for navigation.
---
ui/tests/e2e/navigation.cy.js | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/ui/tests/e2e/navigation.cy.js b/ui/tests/e2e/navigation.cy.js
index 6244ff925c..b83a67c4a7 100644
--- a/ui/tests/e2e/navigation.cy.js
+++ b/ui/tests/e2e/navigation.cy.js
@@ -1,5 +1,6 @@
const navigationButtonTestId = 'xb-navigation-button';
const navigationContentTestId = 'xb-navigation-content';
+const navigationSearchTestId = 'xb-navigation-search';
const navigationNewButtonTestId = 'xb-navigation-new-button';
const navigationNewPageButtonTestId = 'xb-navigation-new-page-button';
@@ -102,6 +103,28 @@ describe('Navigation functionality', () => {
cy.url().should('contain', '/xb/xb_page/1');
});
+ it('Validates search functionality', () => {
+ cy.loadURLandWaitForXBLoaded({ url: 'xb/xb_page/1' });
+ cy.findByTestId(navigationButtonTestId).click();
+
+ // Enter a search term in the search input field
+ cy.findByTestId(navigationSearchTestId).type('Homepage');
+
+ // Assert that the search results contain the expected text
+ cy.findByTestId(navigationContentTestId)
+ .should('exist')
+ .and('contain.text', 'Homepage');
+
+ // Clear the search input field
+ cy.findByTestId(navigationSearchTestId).clear();
+
+ // Assert that all results are displayed again
+ cy.findByTestId(navigationSearchTestId)
+ .should('exist')
+ .and('contain.text', 'Homepage')
+ .and('contain.text', 'Empty Page');
+ });
+
it('Deleting pages through navigation', () => {
cy.loadURLandWaitForXBLoaded({ url: 'xb/xb_page/1' });
--
GitLab
From e5b1e1f7f0343f59103f30d230f628a1382ca90f Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Mon, 14 Apr 2025 21:41:09 +0530
Subject: [PATCH 04/56] Fix cypress e2e test.
---
ui/tests/e2e/navigation.cy.js | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/ui/tests/e2e/navigation.cy.js b/ui/tests/e2e/navigation.cy.js
index b83a67c4a7..6f1a401fa9 100644
--- a/ui/tests/e2e/navigation.cy.js
+++ b/ui/tests/e2e/navigation.cy.js
@@ -1,6 +1,5 @@
const navigationButtonTestId = 'xb-navigation-button';
const navigationContentTestId = 'xb-navigation-content';
-const navigationSearchTestId = 'xb-navigation-search';
const navigationNewButtonTestId = 'xb-navigation-new-button';
const navigationNewPageButtonTestId = 'xb-navigation-new-page-button';
@@ -103,12 +102,12 @@ describe('Navigation functionality', () => {
cy.url().should('contain', '/xb/xb_page/1');
});
- it('Validates search functionality', () => {
+ it('Verify if search works', () => {
cy.loadURLandWaitForXBLoaded({ url: 'xb/xb_page/1' });
cy.findByTestId(navigationButtonTestId).click();
// Enter a search term in the search input field
- cy.findByTestId(navigationSearchTestId).type('Homepage');
+ cy.get('input[id="xb-navigation-search"]').type('Homepage{enter}');
// Assert that the search results contain the expected text
cy.findByTestId(navigationContentTestId)
@@ -116,10 +115,11 @@ describe('Navigation functionality', () => {
.and('contain.text', 'Homepage');
// Clear the search input field
- cy.findByTestId(navigationSearchTestId).clear();
+ cy.get('input[id="xb-navigation-search"]').clear();
+ cy.get('input[id="xb-navigation-search"]').type('{enter}');
// Assert that all results are displayed again
- cy.findByTestId(navigationSearchTestId)
+ cy.findByTestId(navigationContentTestId)
.should('exist')
.and('contain.text', 'Homepage')
.and('contain.text', 'Empty Page');
--
GitLab
From 47e364b8a43901e0358109bb76d69b45dbb32893 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Tue, 15 Apr 2025 12:11:57 +0530
Subject: [PATCH 05/56] Feedback changes.
---
src/Controller/ApiContentControllers.php | 6 +++++-
ui/src/components/navigation/Navigation.tsx | 3 ++-
ui/src/components/pageInfo/PageInfo.tsx | 21 ++++++++++++++++++---
ui/tests/e2e/navigation.cy.js | 8 ++++----
4 files changed, 29 insertions(+), 9 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 7b762aef36..fbbbb50faa 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -6,6 +6,7 @@ namespace Drupal\experience_builder\Controller;
use Drupal\Core\Cache\CacheableJsonResponse;
use Drupal\Core\Cache\CacheableMetadata;
+use Drupal\Core\Entity\EntityAutocompleteMatcherInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
@@ -32,6 +33,7 @@ final class ApiContentControllers {
private readonly EntityTypeManagerInterface $entityTypeManager,
private readonly RendererInterface $renderer,
private readonly AutoSaveManager $autoSaveManager,
+ private readonly EntityAutocompleteMatcherInterface $entityAutocompleteMatcher,
) {}
public function post(): JsonResponse {
@@ -94,7 +96,9 @@ final class ApiContentControllers {
$search = $request->query->get('search');
$label_key = $storage->getEntityType()->getKey('label');
if ($label_key) {
- $entity_query->condition($label_key, '%' . $search . '%', 'LIKE');
+ $matching_titles = $this->entityAutocompleteMatcher->getMatches('xb_page', 'default', ['match_operator' => 'CONTAINS'], (string) $search);
+ $matching_titles = array_column($matching_titles, 'label');
+ $entity_query->condition($label_key, $matching_titles, 'IN');
}
}
diff --git a/ui/src/components/navigation/Navigation.tsx b/ui/src/components/navigation/Navigation.tsx
index 6119055ec3..90b4ea392e 100644
--- a/ui/src/components/navigation/Navigation.tsx
+++ b/ui/src/components/navigation/Navigation.tsx
@@ -223,7 +223,7 @@ const Navigation = ({
<Flex direction="row" gap="2" mb="4">
<form
className={styles.search}
- onSubmit={(event: FormEvent<HTMLFormElement>) => {
+ onChange={(event: FormEvent<HTMLFormElement>) => {
event.preventDefault();
const form = event.currentTarget;
const formElements = form.elements as typeof form.elements & {
@@ -236,6 +236,7 @@ const Navigation = ({
id="xb-navigation-search"
placeholder="Search…"
radius="medium"
+ aria-label="xb-navigation-search"
size="1"
>
<TextField.Slot>
diff --git a/ui/src/components/pageInfo/PageInfo.tsx b/ui/src/components/pageInfo/PageInfo.tsx
index 2546eda823..875db0bb0a 100644
--- a/ui/src/components/pageInfo/PageInfo.tsx
+++ b/ui/src/components/pageInfo/PageInfo.tsx
@@ -14,6 +14,7 @@ import {
Popover,
} from '@radix-ui/themes';
import { useAppSelector } from '@/app/hooks';
+import { debounce } from 'lodash';
import { selectPageData } from '@/features/pageData/pageDataSlice';
import type { ReactElement } from 'react';
import { useEffect } from 'react';
@@ -65,13 +66,27 @@ const PageInfo = () => {
const entity_form_fields = useAppSelector(selectPageData);
const title =
entity_form_fields[`${drupalSettings.xb.entityTypeKeys.label}[0][value]`];
+ const [debouncedSearchTerm, setDebouncedSearchTerm] = useState<string>('');
+ // Set up the debounced search function
+ useEffect(() => {
+ const debouncedSearch = debounce((term: string) => {
+ setDebouncedSearchTerm(term);
+ }, 400);
+
+ return () => {
+ debouncedSearch.cancel();
+ };
+ }, [debouncedSearchTerm]);
- const [searchTerm, setSearchTerm] = useState<string>('');
+ // Query for page items using the debounced search term
const {
data: pageItems,
isLoading: isPageItemsLoading,
error: pageItemsError,
- } = useGetContentListQuery({ entityType: 'xb_page', search: searchTerm });
+ } = useGetContentListQuery({
+ entityType: 'xb_page',
+ search: debouncedSearchTerm,
+ });
const [
createContent,
@@ -161,7 +176,7 @@ const PageInfo = () => {
loading={isPageItemsLoading}
items={pageItems || []}
onNewPage={handleNewPage}
- onSearch={(value) => setSearchTerm(value)}
+ onSearch={(value) => setDebouncedSearchTerm(value)}
onSelect={handleOnSelect}
onRename={handleNonWorkingBtn}
onDuplicate={handleNonWorkingBtn}
diff --git a/ui/tests/e2e/navigation.cy.js b/ui/tests/e2e/navigation.cy.js
index 6f1a401fa9..6be79eeba1 100644
--- a/ui/tests/e2e/navigation.cy.js
+++ b/ui/tests/e2e/navigation.cy.js
@@ -107,16 +107,16 @@ describe('Navigation functionality', () => {
cy.findByTestId(navigationButtonTestId).click();
// Enter a search term in the search input field
- cy.get('input[id="xb-navigation-search"]').type('Homepage{enter}');
+ cy.findByLabelText('xb-navigation-search').type('Homepage');
// Assert that the search results contain the expected text
cy.findByTestId(navigationContentTestId)
.should('exist')
- .and('contain.text', 'Homepage');
+ .and('contain.text', 'Homepage')
+ .and('not.contain.text', 'Empty Page');
// Clear the search input field
- cy.get('input[id="xb-navigation-search"]').clear();
- cy.get('input[id="xb-navigation-search"]').type('{enter}');
+ cy.findByLabelText('xb-navigation-search').clear();
// Assert that all results are displayed again
cy.findByTestId(navigationContentTestId)
--
GitLab
From e4bc30200c513d4cb00f38fd0327075ad058594f Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Fri, 18 Apr 2025 13:01:29 +0530
Subject: [PATCH 06/56] updating query to also search in auto saved entities.
---
src/Controller/ApiContentControllers.php | 16 ++++++++++++++-
ui/src/components/navigation/Navigation.tsx | 2 +-
ui/src/components/pageInfo/PageInfo.tsx | 22 ++++++++++-----------
ui/tests/e2e/navigation.cy.js | 5 +++--
4 files changed, 29 insertions(+), 16 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index fbbbb50faa..aa89237dac 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -91,6 +91,7 @@ final class ApiContentControllers {
// published and unpublished pages on the frontend.
$entity_query = $storage->getQuery()->accessCheck(TRUE);
+ $matching_unsaved_ids = [];
// Check if search parameter is present in the request
if ($request->query->has('search')) {
$search = $request->query->get('search');
@@ -98,12 +99,25 @@ final class ApiContentControllers {
if ($label_key) {
$matching_titles = $this->entityAutocompleteMatcher->getMatches('xb_page', 'default', ['match_operator' => 'CONTAINS'], (string) $search);
$matching_titles = array_column($matching_titles, 'label');
- $entity_query->condition($label_key, $matching_titles, 'IN');
+ $unsaved_entries = $this->autoSaveManager->getAllAutoSaveList();
+ foreach ($unsaved_entries as $id => $entry) {
+ if (str_contains($entry['label'], $search) !== FALSE) {
+ $matching_unsaved_ids[] = $entry['entity_id'];
+ }
+ }
+ // If no matches from either source, return early
+ if (empty($matching_titles) && empty($matching_unsaved_ids)) {
+ return new CacheableJsonResponse([]);
+ }
+ if (!empty($matching_titles)) {
+ $entity_query->condition($label_key, $matching_titles, 'IN');
+ }
}
}
$ids = $this->executeQueryInRenderContext($entity_query, $query_cacheability);
/** @var \Drupal\Core\Entity\EntityPublishedInterface[] $content_entities */
+ $ids = array_unique(array_merge($ids, $matching_unsaved_ids));
$content_entities = $storage->loadMultiple($ids);
$content_list = [];
diff --git a/ui/src/components/navigation/Navigation.tsx b/ui/src/components/navigation/Navigation.tsx
index 90b4ea392e..142d4438bd 100644
--- a/ui/src/components/navigation/Navigation.tsx
+++ b/ui/src/components/navigation/Navigation.tsx
@@ -236,7 +236,7 @@ const Navigation = ({
id="xb-navigation-search"
placeholder="Search…"
radius="medium"
- aria-label="xb-navigation-search"
+ aria-label="Search Pages"
size="1"
>
<TextField.Slot>
diff --git a/ui/src/components/pageInfo/PageInfo.tsx b/ui/src/components/pageInfo/PageInfo.tsx
index 875db0bb0a..f955c7dd83 100644
--- a/ui/src/components/pageInfo/PageInfo.tsx
+++ b/ui/src/components/pageInfo/PageInfo.tsx
@@ -67,18 +67,6 @@ const PageInfo = () => {
const title =
entity_form_fields[`${drupalSettings.xb.entityTypeKeys.label}[0][value]`];
const [debouncedSearchTerm, setDebouncedSearchTerm] = useState<string>('');
- // Set up the debounced search function
- useEffect(() => {
- const debouncedSearch = debounce((term: string) => {
- setDebouncedSearchTerm(term);
- }, 400);
-
- return () => {
- debouncedSearch.cancel();
- };
- }, [debouncedSearchTerm]);
-
- // Query for page items using the debounced search term
const {
data: pageItems,
isLoading: isPageItemsLoading,
@@ -118,6 +106,16 @@ const PageInfo = () => {
setEditorEntity('xb_page', String(item.id));
}
+ useEffect(() => {
+ const debouncedSearch = debounce((term: string) => {
+ setDebouncedSearchTerm(term);
+ }, 400);
+
+ return () => {
+ debouncedSearch.cancel();
+ };
+ }, [debouncedSearchTerm]);
+
useEffect(() => {
if (isCreateContentSuccess) {
setEditorEntity(
diff --git a/ui/tests/e2e/navigation.cy.js b/ui/tests/e2e/navigation.cy.js
index 6be79eeba1..fc4e3cbe17 100644
--- a/ui/tests/e2e/navigation.cy.js
+++ b/ui/tests/e2e/navigation.cy.js
@@ -107,7 +107,8 @@ describe('Navigation functionality', () => {
cy.findByTestId(navigationButtonTestId).click();
// Enter a search term in the search input field
- cy.findByLabelText('xb-navigation-search').type('Homepage');
+ cy.findByLabelText('Search Pages').type('Homepage');
+ cy.findByLabelText('Search Pages').type('ome');
// Assert that the search results contain the expected text
cy.findByTestId(navigationContentTestId)
@@ -116,7 +117,7 @@ describe('Navigation functionality', () => {
.and('not.contain.text', 'Empty Page');
// Clear the search input field
- cy.findByLabelText('xb-navigation-search').clear();
+ cy.findByLabelText('Search Pages').clear();
// Assert that all results are displayed again
cy.findByTestId(navigationContentTestId)
--
GitLab
From 9411aab8dd9473592c89708213a888d3e7da50f1 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Mon, 21 Apr 2025 15:57:21 +0530
Subject: [PATCH 07/56] refactor auto complete matcher and debouce effect.
---
src/Controller/ApiContentControllers.php | 19 ++++++++++++++-----
ui/src/components/pageInfo/PageInfo.tsx | 13 ++++++++-----
2 files changed, 22 insertions(+), 10 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index cce88aa221..95b8634217 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -18,6 +18,7 @@ use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Drupal\experience_builder\AutoSave\AutoSaveManager;
+use Drupal\Core\Cache\CacheTagsInvalidatorInterface;
/**
* HTTP API for interacting with XB-eligible Content entity types.
@@ -34,6 +35,7 @@ final class ApiContentControllers {
private readonly RendererInterface $renderer,
private readonly AutoSaveManager $autoSaveManager,
private readonly EntityAutocompleteMatcherInterface $entityAutocompleteMatcher,
+ private readonly CacheTagsInvalidatorInterface $cacheTagsInvalidator,
) {}
public function post(): JsonResponse {
@@ -67,6 +69,7 @@ final class ApiContentControllers {
*/
public function delete(ContentEntityInterface $xb_page): JsonResponse {
$xb_page->delete();
+
return new JsonResponse(status: Response::HTTP_NO_CONTENT);
}
@@ -116,11 +119,16 @@ final class ApiContentControllers {
}
}
- // Return early if no matches found
+ // Invalidate entity autocomplete matcher cache tags after search
+ $autocomplete_tags = ['entity_autocomplete'];
+ $this->cacheTagsInvalidator->invalidateTags($autocomplete_tags);
+
+ // Return an empty array with proper cache metadata when no matches found
if (empty($matching_titles) && empty($matching_unsaved_ids)) {
- return new CacheableJsonResponse([], 200, [
- 'X-Drupal-Cache-Tags' => 'xb_page_list',
- ]);
+ $json_response = new CacheableJsonResponse([]);
+ $query_cacheability->addCacheContexts(['url.query_args:search']);
+ $json_response->addCacheableDependency($query_cacheability);
+ return $json_response;
}
// Apply query conditions based on matches
@@ -131,7 +139,8 @@ final class ApiContentControllers {
if (empty($matching_titles)) {
// If we only have unsaved IDs, use those directly
$entity_query->condition('id', $matching_unsaved_ids, 'IN');
- } else {
+ }
+ else {
// If we have both, create OR condition group
$or_group = $entity_query->orConditionGroup()
->condition($label_key, $matching_titles, 'IN')
diff --git a/ui/src/components/pageInfo/PageInfo.tsx b/ui/src/components/pageInfo/PageInfo.tsx
index f955c7dd83..6d95717ca9 100644
--- a/ui/src/components/pageInfo/PageInfo.tsx
+++ b/ui/src/components/pageInfo/PageInfo.tsx
@@ -66,14 +66,14 @@ const PageInfo = () => {
const entity_form_fields = useAppSelector(selectPageData);
const title =
entity_form_fields[`${drupalSettings.xb.entityTypeKeys.label}[0][value]`];
- const [debouncedSearchTerm, setDebouncedSearchTerm] = useState<string>('');
+ const [searchTerm, setSearchTerm] = useState<string>('');
const {
data: pageItems,
isLoading: isPageItemsLoading,
error: pageItemsError,
} = useGetContentListQuery({
entityType: 'xb_page',
- search: debouncedSearchTerm,
+ search: searchTerm,
});
const [
@@ -108,13 +108,16 @@ const PageInfo = () => {
useEffect(() => {
const debouncedSearch = debounce((term: string) => {
- setDebouncedSearchTerm(term);
+ setSearchTerm(term);
}, 400);
+ // Set up the debounced search effect
+ debouncedSearch(searchTerm);
+
return () => {
debouncedSearch.cancel();
};
- }, [debouncedSearchTerm]);
+ }, [searchTerm]);
useEffect(() => {
if (isCreateContentSuccess) {
@@ -174,7 +177,7 @@ const PageInfo = () => {
loading={isPageItemsLoading}
items={pageItems || []}
onNewPage={handleNewPage}
- onSearch={(value) => setDebouncedSearchTerm(value)}
+ onSearch={(value) => setSearchTerm(value)}
onSelect={handleOnSelect}
onRename={handleNonWorkingBtn}
onDuplicate={handleNonWorkingBtn}
--
GitLab
From e84017e5c228d0a1f965809b4f8d1c5afcda7962 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Wed, 23 Apr 2025 11:13:04 +0530
Subject: [PATCH 08/56] using selection handler to retrieve id's.
---
src/Controller/ApiContentControllers.php | 54 +++++++++++-------------
1 file changed, 25 insertions(+), 29 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index c344c29056..fb6f22c8d0 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -7,7 +7,7 @@ namespace Drupal\experience_builder\Controller;
use Drupal\Core\Cache\CacheableJsonResponse;
use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\Entity\EntityPublishedInterface;
-use Drupal\Core\Entity\EntityAutocompleteMatcherInterface;
+use Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManagerInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
@@ -21,7 +21,6 @@ use Drupal\experience_builder\Plugin\DisplayVariant\XbPageVariant;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
-use Drupal\Core\Cache\CacheTagsInvalidatorInterface;
/**
* HTTP API for interacting with XB-eligible Content entity types.
@@ -37,8 +36,7 @@ final class ApiContentControllers {
private readonly EntityTypeManagerInterface $entityTypeManager,
private readonly RendererInterface $renderer,
private readonly AutoSaveManager $autoSaveManager,
- private readonly EntityAutocompleteMatcherInterface $entityAutocompleteMatcher,
- private readonly CacheTagsInvalidatorInterface $cacheTagsInvalidator,
+ private readonly SelectionPluginManagerInterface $selectionManager,
private readonly ClientDataToEntityConverter $clientDataToEntityConverter,
) {}
@@ -122,51 +120,46 @@ final class ApiContentControllers {
$label_key = $storage->getEntityType()->getKey('label');
if ($label_key && !empty($search)) {
+ /** @var \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface $selection_handler */
+ $selection_handler = $this->selectionManager->getInstance([
+ 'target_type' => $entity_type,
+ 'handler' => 'default',
+ 'match_operator' => 'CONTAINS',
+ ]);
// Find matching entities by title using autocomplete service
- $matching_titles_data = $this->entityAutocompleteMatcher->getMatches(
- 'xb_page',
- 'default',
- ['match_operator' => 'CONTAINS'],
- (string) $search
- );
- $matching_titles = array_column($matching_titles_data, 'label');
+ $matching_data = $selection_handler->getReferenceableEntities($search, 'CONTAINS', 10);
+ $matching_ids = !empty($matching_data[$entity_type]) ? array_keys($matching_data[$entity_type]) : [];
// Find matching unsaved entities
$unsaved_entries = $this->autoSaveManager->getAllAutoSaveList();
foreach ($unsaved_entries as $entry) {
if (isset($entry['label']) && isset($entry['entity_id']) &&
- str_contains(strtolower($entry['label']), $search)) {
+ str_contains(mb_strtolower($entry['label']), $search)) {
$matching_unsaved_ids[] = $entry['entity_id'];
}
}
- // Invalidate entity autocomplete matcher cache tags after search
- $autocomplete_tags = ['entity_autocomplete'];
- $this->cacheTagsInvalidator->invalidateTags($autocomplete_tags);
-
// Return an empty array with proper cache metadata when no matches found
- if (empty($matching_titles) && empty($matching_unsaved_ids)) {
+ if (empty($matching_ids) && empty($matching_unsaved_ids)) {
$json_response = new CacheableJsonResponse([]);
$query_cacheability->addCacheContexts(['url.query_args:search']);
+ $query_cacheability->addCacheTags([AutoSaveManager::CACHE_TAG]);
$json_response->addCacheableDependency($query_cacheability);
return $json_response;
}
-
- // Apply query conditions based on matches
- if (!empty($matching_titles)) {
- $entity_query->condition($label_key, $matching_titles, 'IN');
- }
- if (!empty($matching_unsaved_ids)) {
- if (empty($matching_titles)) {
- // If we only have unsaved IDs, use those directly
- $entity_query->condition('id', $matching_unsaved_ids, 'IN');
- }
- }
}
}
$ids = $this->executeQueryInRenderContext($entity_query, $query_cacheability);
- $ids = array_unique(array_merge($ids, $matching_unsaved_ids));
+ // If there are matching entities from search, filter the results
+ if (!empty($matching_ids)) {
+ $ids = array_intersect($ids, $matching_ids);
+ }
+ // Merge with matching unsaved IDs, ensuring uniqueness
+ if (!empty($matching_unsaved_ids)) {
+ $ids = array_unique(array_merge($ids, $matching_unsaved_ids));
+ }
+
/** @var \Drupal\Core\Entity\EntityPublishedInterface[] $content_entities */
$content_entities = $storage->loadMultiple($ids);
$content_list = [];
@@ -202,14 +195,17 @@ final class ApiContentControllers {
];
$url_cacheability->addCacheableDependency($generated_url);
}
+
$json_response = new CacheableJsonResponse($content_list);
// @todo add cache contexts for query params when introducing pagination in https://www.drupal.org/i/3502691.
$query_cacheability->addCacheContexts(['url.query_args:search']);
+ $query_cacheability->addCacheTags([AutoSaveManager::CACHE_TAG]);
$json_response->addCacheableDependency($query_cacheability)
->addCacheableDependency($url_cacheability);
if (isset($autoSaveData)) {
$json_response->addCacheableDependency($autoSaveData);
}
+
return $json_response;
}
--
GitLab
From 8d07322f66fde1e5646e9236d097a4b5c62b41e8 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Mon, 28 Apr 2025 13:09:36 +0530
Subject: [PATCH 09/56] update test and use children count for search.
---
ui/src/components/navigation/Navigation.tsx | 7 ++-
ui/tests/e2e/navigation.cy.js | 66 +++++++++++----------
2 files changed, 42 insertions(+), 31 deletions(-)
diff --git a/ui/src/components/navigation/Navigation.tsx b/ui/src/components/navigation/Navigation.tsx
index 142d4438bd..1a278b937a 100644
--- a/ui/src/components/navigation/Navigation.tsx
+++ b/ui/src/components/navigation/Navigation.tsx
@@ -56,7 +56,12 @@ const ContentGroup = ({
<Heading as="h5" size="1" color="gray">
{title}
</Heading>
- <Flex direction="column" gap="2" mt="2">
+ <Flex
+ data-testid="xb-navigation-results"
+ direction="column"
+ gap="2"
+ mt="2"
+ >
{items.map((item) => {
return (
<Flex
diff --git a/ui/tests/e2e/navigation.cy.js b/ui/tests/e2e/navigation.cy.js
index e4eefb7888..34d7f867aa 100644
--- a/ui/tests/e2e/navigation.cy.js
+++ b/ui/tests/e2e/navigation.cy.js
@@ -1,5 +1,6 @@
const navigationButtonTestId = 'xb-navigation-button';
const navigationContentTestId = 'xb-navigation-content';
+const navigationResultsTestId = 'xb-navigation-results';
const navigationNewButtonTestId = 'xb-navigation-new-button';
const navigationNewPageButtonTestId = 'xb-navigation-new-page-button';
@@ -43,6 +44,41 @@ describe('Navigation functionality', () => {
.and('contain.text', 'Empty Page');
});
+ it('Verify if search works', () => {
+ cy.loadURLandWaitForXBLoaded({ url: 'xb/xb_page/1' });
+ cy.findByTestId(navigationButtonTestId).click();
+ cy.findByLabelText('Search Pages').clear();
+ cy.findByLabelText('Search Pages').type('ome');
+ cy.findByTestId(navigationResultsTestId)
+ .children()
+ .should(($children) => {
+ const count = $children.length;
+ expect(count).to.be.eq(1);
+ expect($children.text()).to.contain('Homepage');
+ expect($children.text()).to.not.contain('Empty Page');
+ });
+ cy.findByLabelText('Search Pages').clear();
+ cy.findByLabelText('Search Pages').type('NonExistentPage');
+ cy.findByTestId(navigationResultsTestId)
+ .children()
+ .should(($children) => {
+ const count = $children.length;
+ expect(count).to.be.eq(0);
+ expect($children.text()).to.contain('No pages found');
+ expect($children.text()).to.not.contain('Homepage');
+ expect($children.text()).to.not.contain('Empty Page');
+ });
+ cy.findByLabelText('Search Pages').clear();
+ cy.findByTestId(navigationResultsTestId)
+ .children()
+ .should(($children) => {
+ const count = $children.length;
+ expect(count).to.be.eq(2);
+ expect($children.text()).to.contain('Homepage');
+ expect($children.text()).to.contain('Empty Page');
+ });
+ });
+
it('Clicking "New page" creates a new page and navigates to it', () => {
cy.loadURLandWaitForXBLoaded({ url: 'xb/xb_page/1' });
@@ -117,36 +153,6 @@ describe('Navigation functionality', () => {
.and('contain.text', 'Empty Page (Copy)');
});
- it('Verify if search works', () => {
- cy.loadURLandWaitForXBLoaded({ url: 'xb/xb_page/1' });
- cy.findByTestId(navigationButtonTestId).click();
- cy.findByLabelText('Search Pages').clear().type('Homepage');
- cy.wait(300);
- cy.findByTestId(navigationContentTestId)
- .should('exist')
- .and('contain.text', 'Homepage')
- .and('not.contain.text', 'Empty Page');
- cy.findByLabelText('Search Pages').clear().type('ome');
- cy.wait(300);
- cy.findByTestId(navigationContentTestId)
- .should('exist')
- .and('contain.text', 'Homepage')
- .and('not.contain.text', 'Empty Page');
- cy.findByLabelText('Search Pages').clear().type('NonExistentPage');
- cy.wait(300);
- cy.findByTestId(navigationContentTestId)
- .should('exist')
- .and('contain.text', 'No pages found')
- .and('not.contain.text', 'Homepage')
- .and('not.contain.text', 'Empty Page');
- cy.findByLabelText('Search Pages').clear();
- cy.wait(300);
- cy.findByTestId(navigationContentTestId)
- .should('exist')
- .and('contain.text', 'Homepage')
- .and('contain.text', 'Empty Page');
- });
-
it('Deleting pages through navigation', () => {
cy.loadURLandWaitForXBLoaded({ url: 'xb/xb_page/1' });
--
GitLab
From 2397ee76974df8cd896e6c8b2a58b6dd987bb964 Mon Sep 17 00:00:00 2001
From: Lee Rowlands <lee.rowlands@previousnext.com.au>
Date: Wed, 30 Apr 2025 15:54:08 +1000
Subject: [PATCH 10/56] Fix test
---
ui/src/components/navigation/Navigation.tsx | 4 +++-
ui/tests/e2e/navigation.cy.js | 12 ++++++------
2 files changed, 9 insertions(+), 7 deletions(-)
diff --git a/ui/src/components/navigation/Navigation.tsx b/ui/src/components/navigation/Navigation.tsx
index 1a278b937a..73a584f31b 100644
--- a/ui/src/components/navigation/Navigation.tsx
+++ b/ui/src/components/navigation/Navigation.tsx
@@ -42,7 +42,7 @@ const ContentGroup = ({
}) => {
if (items.length === 0) {
return (
- <Callout.Root size="1" color="gray">
+ <Callout.Root size="1" color="gray" data-testid="xb-navigation-results">
<Callout.Icon>
<InfoCircledIcon />
</Callout.Icon>
@@ -67,6 +67,7 @@ const ContentGroup = ({
<Flex
direction={'row'}
align={'center'}
+ role={'list'}
mr="4"
p="1"
pr="2"
@@ -74,6 +75,7 @@ const ContentGroup = ({
key={item.id}
>
<Flex
+ role={'listitem'}
className={styles.pageLink}
flexGrow="1"
onClick={onSelect ? () => onSelect(item) : undefined}
diff --git a/ui/tests/e2e/navigation.cy.js b/ui/tests/e2e/navigation.cy.js
index 1889059a5f..eab2c172af 100644
--- a/ui/tests/e2e/navigation.cy.js
+++ b/ui/tests/e2e/navigation.cy.js
@@ -50,7 +50,7 @@ describe('Navigation functionality', () => {
cy.findByLabelText('Search Pages').clear();
cy.findByLabelText('Search Pages').type('ome');
cy.findByTestId(navigationResultsTestId)
- .children()
+ .findAllByRole('listitem')
.should(($children) => {
const count = $children.length;
expect(count).to.be.eq(1);
@@ -60,17 +60,17 @@ describe('Navigation functionality', () => {
cy.findByLabelText('Search Pages').clear();
cy.findByLabelText('Search Pages').type('NonExistentPage');
cy.findByTestId(navigationResultsTestId)
- .children()
+ .findAllByRole('listitem')
.should(($children) => {
const count = $children.length;
expect(count).to.be.eq(0);
- expect($children.text()).to.contain('No pages found');
- expect($children.text()).to.not.contain('Homepage');
- expect($children.text()).to.not.contain('Empty Page');
});
+ cy.findByTestId(navigationResultsTestId)
+ .findByText('No pages found', { exact: false })
+ .should('exist');
cy.findByLabelText('Search Pages').clear();
cy.findByTestId(navigationResultsTestId)
- .children()
+ .findAllByRole('listitem')
.should(($children) => {
const count = $children.length;
expect(count).to.be.eq(2);
--
GitLab
From 6c920cbd27b0662f5e8031838a999325de5da155 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Wed, 30 Apr 2025 11:47:18 +0530
Subject: [PATCH 11/56] minor fix for url.
---
tests/src/Functional/XbContentEntityHttpApiTest.php | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/tests/src/Functional/XbContentEntityHttpApiTest.php b/tests/src/Functional/XbContentEntityHttpApiTest.php
index 1d9197f9fa..cb3de2f28b 100644
--- a/tests/src/Functional/XbContentEntityHttpApiTest.php
+++ b/tests/src/Functional/XbContentEntityHttpApiTest.php
@@ -120,7 +120,7 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
$this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'HIT');
// Test searching by query parameter
- $search_url = Url::fromUri('base:/xb/api/content/xb_page', ['query' => ['search' => 'Page 1']]);
+ $search_url = Url::fromUri('base:/xb/api/v0/content/xb_page', ['query' => ['search' => 'Page 1']]);
// Confirm that the cache is not hit when a different request is made with query parameter.
$search_body = $this->assertExpectedResponse('GET', $search_url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
--
GitLab
From fa4534f343276bd7bf887c8cc12f40709e534845 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Fri, 2 May 2025 20:38:27 +0530
Subject: [PATCH 12/56] added more coverage for accented characters.
---
src/Controller/ApiContentControllers.php | 42 +-
.../Functional/XbContentEntityHttpApiTest.php | 5 +
.../ApiContentControllersListTest.php | 369 ++++++++++++++++++
3 files changed, 407 insertions(+), 9 deletions(-)
create mode 100644 tests/src/Kernel/Controller/ApiContentControllersListTest.php
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index fb6f22c8d0..95e13e3b40 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -12,6 +12,7 @@ use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Entity\Query\QueryInterface;
+use Drupal\Core\Language\LanguageManagerInterface;
use Drupal\Core\Render\RenderContext;
use Drupal\Core\Render\RendererInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
@@ -32,12 +33,18 @@ use Symfony\Component\HttpFoundation\Response;
*/
final class ApiContentControllers {
+ /**
+ * The maximum number of entity search results to return.
+ */
+ private const int MAX_SEARCH_RESULTS = 10;
+
public function __construct(
private readonly EntityTypeManagerInterface $entityTypeManager,
private readonly RendererInterface $renderer,
private readonly AutoSaveManager $autoSaveManager,
private readonly SelectionPluginManagerInterface $selectionManager,
private readonly ClientDataToEntityConverter $clientDataToEntityConverter,
+ private readonly LanguageManagerInterface $languageManager,
) {}
public function post(Request $request, string $entity_type): JsonResponse {
@@ -119,22 +126,30 @@ final class ApiContentControllers {
$search = trim((string) $request->query->get('search'));
$label_key = $storage->getEntityType()->getKey('label');
- if ($label_key && !empty($search)) {
+ // @todo Remove this in https://www.drupal.org/project/experience_builder/issues/3498525.
+ if ($label_key === FALSE) {
+ throw new \LogicException('Unhandled.');
+ }
+
+ if (!empty($search)) {
/** @var \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface $selection_handler */
$selection_handler = $this->selectionManager->getInstance([
'target_type' => $entity_type,
'handler' => 'default',
'match_operator' => 'CONTAINS',
]);
- // Find matching entities by title using autocomplete service
- $matching_data = $selection_handler->getReferenceableEntities($search, 'CONTAINS', 10);
+ $matching_data = $selection_handler->getReferenceableEntities($search, 'CONTAINS', self::MAX_SEARCH_RESULTS);
$matching_ids = !empty($matching_data[$entity_type]) ? array_keys($matching_data[$entity_type]) : [];
// Find matching unsaved entities
$unsaved_entries = $this->autoSaveManager->getAllAutoSaveList();
+ $langcode = $this->languageManager->getCurrentLanguage()->getId();
+ // @phpstan-ignore-next-line
+ $trans = \Drupal::transliteration();
foreach ($unsaved_entries as $entry) {
- if (isset($entry['label']) && isset($entry['entity_id']) &&
- str_contains(mb_strtolower($entry['label']), $search)) {
+ $label = $trans->transliterate(mb_strtolower($entry['label']), $langcode);
+ if (isset($label) && isset($entry['entity_id']) &&
+ str_contains(mb_strtolower($label), $search)) {
$matching_unsaved_ids[] = $entry['entity_id'];
}
}
@@ -142,8 +157,7 @@ final class ApiContentControllers {
// Return an empty array with proper cache metadata when no matches found
if (empty($matching_ids) && empty($matching_unsaved_ids)) {
$json_response = new CacheableJsonResponse([]);
- $query_cacheability->addCacheContexts(['url.query_args:search']);
- $query_cacheability->addCacheTags([AutoSaveManager::CACHE_TAG]);
+ $this->addSearchCacheability($query_cacheability);
$json_response->addCacheableDependency($query_cacheability);
return $json_response;
}
@@ -198,8 +212,7 @@ final class ApiContentControllers {
$json_response = new CacheableJsonResponse($content_list);
// @todo add cache contexts for query params when introducing pagination in https://www.drupal.org/i/3502691.
- $query_cacheability->addCacheContexts(['url.query_args:search']);
- $query_cacheability->addCacheTags([AutoSaveManager::CACHE_TAG]);
+ $this->addSearchCacheability($query_cacheability);
$json_response->addCacheableDependency($query_cacheability)
->addCacheableDependency($url_cacheability);
if (isset($autoSaveData)) {
@@ -285,4 +298,15 @@ final class ApiContentControllers {
return new TranslatableMarkup('Untitled @singular_entity_type_label', ['@singular_entity_type_label' => $entity_type->getSingularLabel()]);
}
+ /**
+ * Adds search-related cache contexts and tags to cacheability metadata.
+ *
+ * @param \Drupal\Core\Cache\CacheableMetadata $query_cacheability
+ * The cacheability metadata object to add contexts and tags to.
+ */
+ private function addSearchCacheability(CacheableMetadata $query_cacheability): void {
+ $query_cacheability->addCacheContexts(['url.query_args:search']);
+ $query_cacheability->addCacheTags([AutoSaveManager::CACHE_TAG]);
+ }
+
}
diff --git a/tests/src/Functional/XbContentEntityHttpApiTest.php b/tests/src/Functional/XbContentEntityHttpApiTest.php
index cb3de2f28b..980f2aa134 100644
--- a/tests/src/Functional/XbContentEntityHttpApiTest.php
+++ b/tests/src/Functional/XbContentEntityHttpApiTest.php
@@ -142,6 +142,11 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
// Confirm that the cache is hit when the same request is made again.
$this->assertExpectedResponse('GET', $search_url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'HIT');
+ // Test searching by query parameter - substring match.
+ $substring_search_url = Url::fromUri('base:/xb/api/v0/content/xb_page', ['query' => ['search' => 'age']]);
+ $substring_search_body = $this->assertExpectedResponse('GET', $substring_search_url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
+ $this->assertEquals($no_auto_save_expected_pages, $substring_search_body);
+
$autoSaveManager = $this->container->get(AutoSaveManager::class);
$page_1 = Page::load(1);
$this->assertInstanceOf(Page::class, $page_1);
diff --git a/tests/src/Kernel/Controller/ApiContentControllersListTest.php b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
new file mode 100644
index 0000000000..a133cb143c
--- /dev/null
+++ b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
@@ -0,0 +1,369 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\Tests\experience_builder\Kernel\Controller;
+
+use Drupal\Core\Entity\ContentEntityInterface;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\experience_builder\AutoSave\AutoSaveManager;
+use Drupal\experience_builder\Controller\ApiContentControllers;
+use Drupal\experience_builder\Entity\Page;
+use Drupal\KernelTests\KernelTestBase;
+use Drupal\Tests\user\Traits\UserCreationTrait;
+use Drupal\user\UserInterface;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Tests the ApiContentControllers::list() method.
+ *
+ * @group experience_builder
+ * @coversDefaultClass \Drupal\experience_builder\Controller\ApiContentControllers
+ */
+class ApiContentControllersListTest extends KernelTestBase {
+ use UserCreationTrait;
+
+ /**
+ * Base path for the content API endpoint.
+ */
+ private const API_BASE_PATH = '/api/xb/content/xb_page';
+
+ /**
+ * {@inheritdoc}
+ */
+ protected static $modules = [
+ 'experience_builder',
+ 'system',
+ 'xb_test_page',
+ 'user',
+ 'field',
+ 'text',
+ 'filter',
+ 'path_alias',
+ 'path',
+ 'media',
+ 'image',
+ ];
+
+ /**
+ * The API Content controller service.
+ *
+ * @var \Drupal\experience_builder\Controller\ApiContentControllers
+ */
+ protected $apiContentController;
+
+ /**
+ * The AutoSaveManager service.
+ *
+ * @var \Drupal\experience_builder\AutoSave\AutoSaveManager
+ */
+ protected $autoSaveManager;
+
+ /**
+ * The entity type manager service.
+ *
+ * @var \Drupal\Core\Entity\EntityTypeManagerInterface
+ */
+ protected $entityTypeManager;
+
+ /**
+ * Test pages.
+ *
+ * @var \Drupal\experience_builder\Entity\Page[]
+ */
+ protected $pages = [];
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function setUp(): void {
+ parent::setUp();
+
+ $this->installEntitySchema('user');
+ $this->installEntitySchema('xb_page');
+ $this->installEntitySchema('path_alias');
+ $this->installEntitySchema('media');
+ $this->installSchema('system', ['sequences']);
+ $this->installConfig(['system', 'field', 'filter', 'path_alias']);
+
+ // Create a user with appropriate permissions.
+ $this->setUpCurrentUser([], ['access content', 'create xb_page', 'edit xb_page', 'delete xb_page']);
+
+ // Properly retrieve services.
+ $this->apiContentController = $this->container->get(ApiContentControllers::class);
+ $this->autoSaveManager = $this->container->get(AutoSaveManager::class);
+ $this->entityTypeManager = $this->container->get('entity_type.manager');
+
+ // Verify service class types.
+ $this->assertInstanceOf(ApiContentControllers::class, $this->apiContentController);
+ $this->assertInstanceOf(AutoSaveManager::class, $this->autoSaveManager);
+ $this->assertInstanceOf(EntityTypeManagerInterface::class, $this->entityTypeManager);
+
+ // Create test pages.
+ $this->createTestPages();
+ }
+
+ /**
+ * Asserts that a service exists in the container.
+ *
+ * @param string $service_id
+ * The service ID to check.
+ */
+ protected function assertServiceExists(string $service_id): void {
+ $this->assertTrue(
+ $this->container->has($service_id),
+ sprintf('Service "%s" exists in the container', $service_id)
+ );
+ }
+
+ /**
+ * Creates test pages for the tests.
+ */
+ protected function createTestPages(): void {
+ // Create published page.
+ $page1 = Page::create([
+ 'title' => "Published XB Page",
+ 'status' => TRUE,
+ 'path' => ['alias' => "/page-1"],
+ ]);
+ $page1->save();
+ $this->pages['published'] = $page1;
+
+ // Create unpublished page.
+ $page2 = Page::create([
+ 'title' => "Unpublished XB Page",
+ 'status' => FALSE,
+ ]);
+ $page2->save();
+ $this->pages['unpublished'] = $page2;
+
+ // Create page with unique searchable title.
+ $page3 = Page::create([
+ 'title' => "UniqueSearchTerm XB Page",
+ 'status' => TRUE,
+ 'path' => ['alias' => "/page-3"],
+ ]);
+ $page3->save();
+ $this->pages['searchable'] = $page3;
+
+ // Create a page with diacritical marks (accents) in title.
+ $page4 = Page::create([
+ // cspell:ignore Gàbor Hojtsy
+ 'title' => "Gàbor Hojtsy Page",
+ 'status' => TRUE,
+ 'path' => ['alias' => "/page-4"],
+ ]);
+ $page4->save();
+ $this->pages['accented'] = $page4;
+ }
+
+ /**
+ * Creates auto-save data for an entity.
+ *
+ * @param \Drupal\Core\Entity\ContentEntityInterface $entity
+ * The entity to create auto-save data for.
+ * @param string $label
+ * The label to use in auto-save data.
+ * @param string|null $path
+ * The path alias to use in auto-save data.
+ */
+ protected function createAutoSaveData(ContentEntityInterface $entity, string $label, ?string $path = NULL): void {
+ $form_data = [
+ 'entity_form_fields' => [
+ 'title[0][value]' => $label,
+ ],
+ 'layout' => [
+ [
+ 'id' => 'content',
+ 'components' => [],
+ ],
+ ],
+ 'model' => [
+ 'components' => [],
+ ],
+ ];
+
+ if ($path !== NULL) {
+ $form_data['entity_form_fields']['path[0][alias]'] = $path;
+ }
+ // Save the auto-save data.
+ $this->autoSaveManager->save($entity, $form_data);
+ }
+
+ /**
+ * Helper method to execute list request and return parsed response data.
+ *
+ * @param array $query
+ * Optional query parameters.
+ *
+ * @return array
+ * Parsed JSON response data.
+ */
+ protected function executeListRequest(array $query = []): array {
+ $request = Request::create(self::API_BASE_PATH, 'GET', $query);
+ $response = $this->apiContentController->list('xb_page', $request);
+ $this->assertInstanceOf(JsonResponse::class, $response);
+
+ $content = $response->getContent();
+ $this->assertNotEmpty($content);
+
+ return json_decode($content, TRUE);
+ }
+
+ /**
+ * Helper method to validate page data in response.
+ *
+ * @param array $response_data
+ * The response data to validate.
+ * @param \Drupal\experience_builder\Entity\Page $page
+ * The page to validate against.
+ * @param array $auto_save_data
+ * Optional auto-save data to validate.
+ */
+ protected function assertValidPageData(array $response_data, Page $page, array $auto_save_data = []): void {
+ $page_id = (int) $page->id();
+ $this->assertArrayHasKey($page_id, $response_data, "Response should contain page with ID $page_id");
+ $this->assertEquals($page_id, $response_data[$page_id]['id'], 'Page ID should match');
+ $this->assertEquals($page->label(), $response_data[$page_id]['title'], 'Page title should match');
+ $this->assertEquals($page->isPublished(), $response_data[$page_id]['status'], 'Page status should match');
+ $this->assertNotEmpty($response_data[$page_id]['path'], 'Page should have a path');
+
+ if (!empty($auto_save_data['label'])) {
+ $this->assertEquals(
+ $auto_save_data['label'],
+ $response_data[$page_id]['autoSaveLabel'],
+ 'Auto-save label should match'
+ );
+ }
+
+ if (isset($auto_save_data['path'])) {
+ $this->assertEquals(
+ $auto_save_data['path'],
+ $response_data[$page_id]['autoSavePath'],
+ 'Auto-save path should match'
+ );
+ }
+ }
+
+ /**
+ * Tests basic list functionality with no search parameter.
+ *
+ * @covers ::list
+ */
+ public function testBasicList(): void {
+ // Call the API directly and verify the response.
+ $response = $this->apiContentController->list('xb_page', Request::create(self::API_BASE_PATH, 'GET'));
+
+ // Validate response format.
+ $this->assertInstanceOf(JsonResponse::class, $response, 'Response should be a JsonResponse');
+ $content = $response->getContent();
+ $this->assertNotEmpty($content, 'Response content should not be empty');
+
+ // Decode and validate response data.
+ $data = json_decode($content, TRUE);
+ $this->assertIsArray($data, 'Response data should be an array');
+
+ // Check that all pages are returned.
+ $this->assertCount(count($this->pages), $data, 'Response should contain all test pages');
+
+ // Verify response structure and content for each page.
+ foreach ($this->pages as $page) {
+ $this->assertValidPageData($data, $page);
+ }
+
+ // Verify cache metadata.
+ $cache_metadata = $response->getCacheableMetadata();
+ $this->assertNotEmpty($cache_metadata->getCacheTags(), 'Response should have cache tags');
+ $this->assertContains('xb_page_list', $cache_metadata->getCacheTags(), 'Response should have xb_page_list cache tag');
+ $this->assertContains(AutoSaveManager::CACHE_TAG, $cache_metadata->getCacheTags(), 'Response should have auto-save cache tag');
+ $this->assertContains('url.query_args:search', $cache_metadata->getCacheContexts(), 'Response should vary by search parameter');
+ }
+
+ /**
+ * Tests list method with search parameter.
+ *
+ * @covers ::list
+ */
+ public function testListWithSearch(): void {
+ // Test with a search term that should match one page.
+ $data = $this->executeListRequest(['search' => 'UniqueSearchTerm']);
+
+ // Should only return the searchable page.
+ $this->assertCount(1, $data, 'Search should return exactly one result');
+ $this->assertValidPageData($data, $this->pages['searchable']);
+
+ // Test with a search term that should match multiple pages.
+ $data = $this->executeListRequest(['search' => 'XB Page']);
+ $this->assertGreaterThan(1, count($data), 'Search should return multiple results');
+
+ // Test with a search term that should match no pages.
+ $data = $this->executeListRequest(['search' => 'NoMatchingTerm']);
+ $this->assertEmpty($data, 'Search with no matches should return empty array');
+
+ // Test case insensitivity.
+ // cspell:ignore uniquesearchterm
+ $data = $this->executeListRequest(['search' => 'uniquesearchterm']);
+ $this->assertCount(1, $data, 'Search should be case-insensitive');
+
+ // Test accented character matching (with accent in search term).
+ // cspell:ignore Gàbor
+ $data = $this->executeListRequest(['search' => 'Gàbor']);
+ $this->assertCount(1, $data, 'Search with accented character should match page');
+ $this->assertValidPageData($data, $this->pages['accented']);
+
+ // Test accented character matching (without accent in search term).
+ $data = $this->executeListRequest(['search' => 'gabor']);
+ $this->assertCount(1, $data, 'Search without accent should match page with accented character');
+ $this->assertValidPageData($data, $this->pages['accented']);
+ }
+
+ /**
+ * Tests list method handles access control correctly.
+ *
+ * @covers ::list
+ */
+ public function testListWithAccessControl(): void {
+ // Create a page owned by another user that current user cannot access.
+ /** @var \Drupal\user\UserInterface $other_user */
+ $other_user = $this->createUser(['access content']);
+ $restricted_page = Page::create([
+ 'title' => 'Restricted Access Page',
+ 'status' => FALSE,
+ 'uid' => $other_user->id(),
+ ]);
+ $restricted_page->save();
+
+ // Request the list.
+ $data = $this->executeListRequest();
+
+ // The restricted page should be included in the results.
+ $page_id = (int) $restricted_page->id();
+ $this->assertArrayHasKey($page_id, $data, 'Page with restricted access should be included in the list');
+
+ // Verify that the API lists all content regardless of access restrictions.
+ $this->assertCount(count($this->pages) + 1, $data,
+ 'Response should contain all pages regardless of access restrictions');
+ }
+
+ /**
+ * Tests handling of entity types with no pages.
+ *
+ * @covers ::list
+ */
+ public function testEmptyEntityList(): void {
+ // Delete all pages.
+ foreach ($this->pages as $page) {
+ $page->delete();
+ }
+ $this->pages = [];
+
+ // Request the list.
+ $data = $this->executeListRequest();
+
+ // Should return empty array.
+ $this->assertEmpty($data, 'Empty page list should return empty array');
+ $this->assertIsArray($data, 'Empty result should still be an array');
+ }
+
+}
--
GitLab
From 3cb781925b9c8f801519b16468e5d3b17ac09186 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Tue, 6 May 2025 10:40:19 +0530
Subject: [PATCH 13/56] code refactor and readability fixes.
---
src/Controller/ApiContentControllers.php | 285 +++++++++++++++++------
1 file changed, 216 insertions(+), 69 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 5ba61474c9..51265ce0a3 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -113,21 +113,21 @@ final class ApiContentControllers {
$langcode = $this->languageManager->getCurrentLanguage()->getId();
// @phpstan-ignore-next-line
$trans = \Drupal::transliteration();
- // @todo introduce pagination in https://www.drupal.org/i/3502691
+ // @todo introduce pagination in https://www.drupal.org/i/3502691.
$storage = $this->entityTypeManager->getStorage($entity_type);
- $query_cacheability = (new CacheableMetadata())
- ->addCacheContexts($storage->getEntityType()->getListCacheContexts())
- ->addCacheTags($storage->getEntityType()->getListCacheTags());
+
+ // Setup cacheability metadata
+ $query_cacheability = $this->createInitialCacheability($storage);
$url_cacheability = new CacheableMetadata();
- // We don't need to worry about the status of the page, as we need both
- // published and unpublished pages on the frontend.
+
+ // Create entity query with access check
$entity_query = $storage->getQuery()->accessCheck(TRUE);
+ // Handle search functionality if search parameter is present
+ $matching_ids = [];
$matching_unsaved_ids = [];
- // Check if search parameter is present in the request
if ($request->query->has('search')) {
- $search = trim((string) $request->query->get('search'));
- $search = $trans->transliterate(mb_strtolower($search), $langcode);
+ $search = $this->prepareSearchTerm($request, $trans, $langcode);
$label_key = $storage->getEntityType()->getKey('label');
// @todo Remove this in https://www.drupal.org/project/experience_builder/issues/3498525.
@@ -136,93 +136,240 @@ final class ApiContentControllers {
}
if (!empty($search)) {
- /** @var \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface $selection_handler */
- $selection_handler = $this->selectionManager->getInstance([
- 'target_type' => $entity_type,
- 'handler' => 'default',
- 'match_operator' => 'CONTAINS',
- ]);
- $matching_data = $selection_handler->getReferenceableEntities($search, 'CONTAINS', self::MAX_SEARCH_RESULTS);
- $matching_ids = !empty($matching_data[$entity_type]) ? array_keys($matching_data[$entity_type]) : [];
+ // Get matching entity IDs through selection handler
+ $matching_ids = $this->getMatchingEntityIds($entity_type, $search);
// Find matching unsaved entities
- $unsaved_entries = $this->autoSaveManager->getAllAutoSaveList();
- foreach ($unsaved_entries as $entry) {
- $label = $trans->transliterate(mb_strtolower($entry['label']), $langcode);
- if (isset($label) && isset($entry['entity_id']) &&
- str_contains(mb_strtolower($label), $search)) {
- $matching_unsaved_ids[] = $entry['entity_id'];
- }
- }
+ $matching_unsaved_ids = $this->getMatchingUnsavedIds($search, $trans, $langcode);
- // Return an empty array with proper cache metadata when no matches found
+ // Return empty response if no matches found
if (empty($matching_ids) && empty($matching_unsaved_ids)) {
- $json_response = new CacheableJsonResponse([]);
- $this->addSearchCacheability($query_cacheability);
- $json_response->addCacheableDependency($query_cacheability);
- return $json_response;
+ return $this->createEmptyResponse($query_cacheability);
}
}
}
+ // Get entity IDs and filter by search results if needed
$ids = $this->executeQueryInRenderContext($entity_query, $query_cacheability);
- // If there are matching entities from search, filter the results
- if (!empty($matching_ids)) {
- $ids = array_intersect($ids, $matching_ids);
- }
- // Merge with matching unsaved IDs, ensuring uniqueness
- if (!empty($matching_unsaved_ids)) {
- $ids = array_unique(array_merge($ids, $matching_unsaved_ids));
- }
+ $ids = $this->filterAndMergeIds($ids, $matching_ids, $matching_unsaved_ids);
+ // Load entities and prepare content list
/** @var \Drupal\Core\Entity\EntityPublishedInterface[] $content_entities */
$content_entities = $storage->loadMultiple($ids);
$content_list = [];
foreach ($content_entities as $content_entity) {
- $id = (int) $content_entity->id();
- $generated_url = $content_entity->toUrl()->toString(TRUE);
-
- $autoSaveData = $this->autoSaveManager->getAutoSaveData($content_entity);
- $autoSavePath = NULL;
- // @todo Dynamically use the entity 'path' key to determine which field is
- // the path in https://drupal.org/i/3503446.
- $path_form_key = 'path[0][alias]';
- if (isset($autoSaveData->data['entity_form_fields'][$path_form_key])) {
- // If an alias is not set in the auto-save data, fall back to the
- // internal path as any alias in the saved entity will be removed.
- if (empty($autoSaveData->data['entity_form_fields'][$path_form_key])) {
- $autoSavePath = '/' . $content_entity->toUrl()->getInternalPath();
- }
- else {
- // The alias user input should always start with '/'.
- $autoSavePath = $autoSaveData->data['entity_form_fields'][$path_form_key];
- assert(str_starts_with($autoSavePath, '/'));
- }
- }
- $content_list[$id] = [
- 'id' => $id,
- 'title' => $content_entity->label(),
- 'status' => $content_entity->isPublished(),
- 'path' => $generated_url->getGeneratedUrl(),
- 'autoSaveLabel' => is_null($autoSaveData->data) ? NULL : AutoSaveManager::getLabelToSave($content_entity, $autoSaveData->data),
- 'autoSavePath' => $autoSavePath,
- ];
- $url_cacheability->addCacheableDependency($generated_url);
+ $entity_data = $this->prepareEntityData($content_entity, $url_cacheability);
+ $content_list[$entity_data['id']] = $entity_data;
}
+ // Create and configure the response
$json_response = new CacheableJsonResponse($content_list);
// @todo add cache contexts for query params when introducing pagination in https://www.drupal.org/i/3502691.
$this->addSearchCacheability($query_cacheability);
$json_response->addCacheableDependency($query_cacheability)
->addCacheableDependency($url_cacheability);
- if (isset($autoSaveData)) {
- $json_response->addCacheableDependency($autoSaveData);
+
+ return $json_response;
+ }
+
+ /**
+ * Creates initial cacheability metadata based on entity storage.
+ *
+ * @param \Drupal\Core\Entity\EntityStorageInterface $storage
+ * The entity storage.
+ *
+ * @return \Drupal\Core\Cache\CacheableMetadata
+ * The initialized cacheability metadata.
+ */
+ private function createInitialCacheability($storage): CacheableMetadata {
+ return (new CacheableMetadata())
+ ->addCacheContexts($storage->getEntityType()->getListCacheContexts())
+ ->addCacheTags($storage->getEntityType()->getListCacheTags());
+ }
+
+ /**
+ * Prepares and normalizes the search term from the request.
+ *
+ * @param \Symfony\Component\HttpFoundation\Request $request
+ * The HTTP request object.
+ * @param \Drupal\Component\Transliteration\TransliterationInterface $trans
+ * The transliteration service.
+ * @param string $langcode
+ * The language code to use for transliteration.
+ *
+ * @return string
+ * The normalized search term.
+ */
+ private function prepareSearchTerm(Request $request, $trans, string $langcode): string {
+ $search = trim((string) $request->query->get('search'));
+ return $trans->transliterate(mb_strtolower($search), $langcode);
+ }
+
+ /**
+ * Gets entity IDs matching the search term using selection handler.
+ *
+ * @param string $entity_type
+ * The entity type ID.
+ * @param string $search
+ * The search term to match against entities.
+ *
+ * @return array
+ * An array of entity IDs that match the search criteria.
+ */
+ private function getMatchingEntityIds(string $entity_type, string $search): array {
+ /** @var \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface $selection_handler */
+ $selection_handler = $this->selectionManager->getInstance([
+ 'target_type' => $entity_type,
+ 'handler' => 'default',
+ 'match_operator' => 'CONTAINS',
+ ]);
+
+ $matching_data = $selection_handler->getReferenceableEntities(
+ $search,
+ 'CONTAINS',
+ self::MAX_SEARCH_RESULTS
+ );
+
+ return !empty($matching_data[$entity_type]) ? array_keys($matching_data[$entity_type]) : [];
+ }
+
+ /**
+ * Gets unsaved entity IDs matching the search term.
+ *
+ * @param string $search
+ * The search term to match against entities.
+ * @param \Drupal\Component\Transliteration\TransliterationInterface $trans
+ * The transliteration service.
+ * @param string $langcode
+ * The language code to use for transliteration.
+ *
+ * @return array
+ * An array of entity IDs that match the search criteria.
+ */
+ private function getMatchingUnsavedIds(string $search, $trans, string $langcode): array {
+ $matching_unsaved_ids = [];
+ $unsaved_entries = $this->autoSaveManager->getAllAutoSaveList();
+
+ foreach ($unsaved_entries as $entry) {
+ $label = $trans->transliterate(mb_strtolower($entry['label']), $langcode);
+ if (isset($label) && isset($entry['entity_id']) &&
+ str_contains(mb_strtolower($label), $search)) {
+ $matching_unsaved_ids[] = $entry['entity_id'];
+ }
}
+ return $matching_unsaved_ids;
+ }
+
+ /**
+ * Creates an empty response with proper cacheability metadata.
+ *
+ * @param \Drupal\Core\Cache\CacheableMetadata $query_cacheability
+ * The cacheability metadata to attach to the response.
+ *
+ * @return \Drupal\Core\Cache\CacheableJsonResponse
+ * An empty JSON response with cacheability metadata attached.
+ */
+ private function createEmptyResponse(CacheableMetadata $query_cacheability): CacheableJsonResponse {
+ $json_response = new CacheableJsonResponse([]);
+ $this->addSearchCacheability($query_cacheability);
+ $json_response->addCacheableDependency($query_cacheability);
return $json_response;
}
+ /**
+ * Filters and merges entity IDs based on search results.
+ *
+ * @param array $ids
+ * The array of entity IDs from the database query.
+ * @param array $matching_ids
+ * The array of entity IDs that match the search term.
+ * @param array $matching_unsaved_ids
+ * The array of unsaved entity IDs that match the search term.
+ *
+ * @return array
+ * The filtered and merged array of entity IDs.
+ */
+ private function filterAndMergeIds(array $ids, array $matching_ids, array $matching_unsaved_ids): array {
+ // If there are matching entities from search, filter the results
+ if (!empty($matching_ids)) {
+ $ids = array_intersect($ids, $matching_ids);
+ }
+
+ // Merge with matching unsaved IDs, ensuring uniqueness
+ if (!empty($matching_unsaved_ids)) {
+ $ids = array_unique(array_merge($ids, $matching_unsaved_ids));
+ }
+
+ return $ids;
+ }
+
+ /**
+ * Prepares entity data for the response.
+ *
+ * @param \Drupal\Core\Entity\EntityPublishedInterface $content_entity
+ * The content entity to prepare data for.
+ * @param \Drupal\Core\Cache\CacheableMetadata $url_cacheability
+ * The cacheability metadata object to add URL dependencies to.
+ *
+ * @return array
+ * An associative array containing the prepared entity data.
+ */
+ private function prepareEntityData(EntityPublishedInterface $content_entity, CacheableMetadata $url_cacheability): array {
+ $id = (int) $content_entity->id();
+ $generated_url = $content_entity->toUrl()->toString(TRUE);
+
+ $autoSaveData = $this->autoSaveManager->getAutoSaveData($content_entity);
+ $autoSavePath = $this->determineAutoSavePath($content_entity, $autoSaveData);
+
+ $entity_data = [
+ 'id' => $id,
+ 'title' => $content_entity->label(),
+ 'status' => $content_entity->isPublished(),
+ 'path' => $generated_url->getGeneratedUrl(),
+ 'autoSaveLabel' => is_null($autoSaveData->data) ? NULL : AutoSaveManager::getLabelToSave($content_entity, $autoSaveData->data),
+ 'autoSavePath' => $autoSavePath,
+ ];
+
+ $url_cacheability->addCacheableDependency($generated_url);
+
+ return $entity_data;
+ }
+
+ /**
+ * Determines the auto-save path for an entity.
+ *
+ * @param \Drupal\Core\Entity\EntityPublishedInterface $content_entity
+ * The content entity to get the auto-save path for.
+ * @param object $autoSaveData
+ * The auto-save data object containing path information.
+ *
+ * @return string|null
+ * The auto-save path, or NULL if none exists.
+ */
+ private function determineAutoSavePath(EntityPublishedInterface $content_entity, $autoSaveData): ?string {
+ // @todo Dynamically use the entity 'path' key to determine which field is
+ // the path in https://drupal.org/i/3503446.
+ $path_form_key = 'path[0][alias]';
+
+ if (!isset($autoSaveData->data['entity_form_fields'][$path_form_key])) {
+ return NULL;
+ }
+
+ // If an alias is not set in the auto-save data, fall back to the
+ // internal path as any alias in the saved entity will be removed.
+ if (empty($autoSaveData->data['entity_form_fields'][$path_form_key])) {
+ return '/' . $content_entity->toUrl()->getInternalPath();
+ }
+
+ // The alias user input should always start with '/'.
+ $autoSavePath = $autoSaveData->data['entity_form_fields'][$path_form_key];
+ assert(str_starts_with($autoSavePath, '/'));
+
+ return $autoSavePath;
+ }
+
/**
* Duplicates entity.
*
--
GitLab
From cea5a9f7b3b9f44e63232a435279c44f02da55ee Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Wed, 7 May 2025 13:01:27 +0530
Subject: [PATCH 14/56] add test for mixed case.
---
.../src/Kernel/Controller/ApiContentControllersListTest.php | 6 ++++--
ui/src/services/content.ts | 3 ++-
2 files changed, 6 insertions(+), 3 deletions(-)
diff --git a/tests/src/Kernel/Controller/ApiContentControllersListTest.php b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
index 3523ec7810..2a2806bc6e 100644
--- a/tests/src/Kernel/Controller/ApiContentControllersListTest.php
+++ b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
@@ -286,8 +286,6 @@ class ApiContentControllersListTest extends KernelTestBase {
public function testListWithSearch(): void {
// Test with a search term that should match one page.
$data = $this->executeListRequest(['search' => 'UniqueSearchTerm']);
-
- // Should only return the searchable page.
$this->assertCount(1, $data, 'Search should return exactly one result');
$this->assertValidPageData($data, $this->pages['searchable']);
@@ -314,6 +312,10 @@ class ApiContentControllersListTest extends KernelTestBase {
$data = $this->executeListRequest(['search' => 'gabor']);
$this->assertCount(1, $data, 'Search without accent should match page with accented character');
$this->assertValidPageData($data, $this->pages['accented']);
+
+ // Test with mixed casing.
+ $data = $this->executeListRequest(['search' => 'puBliSHed']);
+ $this->assertCount(2, $data, 'Search with mixed case should match published and unpublished page');
}
/**
diff --git a/ui/src/services/content.ts b/ui/src/services/content.ts
index 3a97fb9f96..8f7cb3e5d1 100644
--- a/ui/src/services/content.ts
+++ b/ui/src/services/content.ts
@@ -35,7 +35,8 @@ export const contentApi = createApi({
query: ({ entityType, search }) => {
const params = new URLSearchParams();
if (search) {
- params.append('search', search);
+ const normalizedSearch = search.toLowerCase().trim();
+ params.append('search', normalizedSearch);
}
return {
url: `/xb/api/v0/content/${entityType}`,
--
GitLab
From fa0bcee8392b80698b338f16a68362c136afcd5b Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Thu, 8 May 2025 21:02:51 +0530
Subject: [PATCH 15/56] review changes.
---
src/Controller/ApiContentControllers.php | 12 +++-
.../ApiContentControllersListTest.php | 69 +++++--------------
ui/src/components/pageInfo/PageInfo.tsx | 4 +-
3 files changed, 29 insertions(+), 56 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 51265ce0a3..0ee08813a6 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -36,7 +36,7 @@ final class ApiContentControllers {
/**
* The maximum number of entity search results to return.
*/
- private const int MAX_SEARCH_RESULTS = 10;
+ private const int MAX_SEARCH_RESULTS = 50;
public function __construct(
private readonly EntityTypeManagerInterface $entityTypeManager,
@@ -120,8 +120,14 @@ final class ApiContentControllers {
$query_cacheability = $this->createInitialCacheability($storage);
$url_cacheability = new CacheableMetadata();
- // Create entity query with access check
- $entity_query = $storage->getQuery()->accessCheck(TRUE);
+ // Create entity query with access check, last updated first,
+ /** @var \Drupal\Core\Entity\ContentEntityTypeInterface $field_definition */
+ $field_definition = $this->entityTypeManager->getDefinition($entity_type);
+ $revision_created_field_name = $field_definition->getRevisionMetadataKey('revision_created');
+ $entity_query = $storage->getQuery()
+ ->sort((string) $revision_created_field_name, direction: 'DESC')
+ ->range(0, self::MAX_SEARCH_RESULTS)
+ ->accessCheck(TRUE);
// Handle search functionality if search parameter is present
$matching_ids = [];
diff --git a/tests/src/Kernel/Controller/ApiContentControllersListTest.php b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
index 2a2806bc6e..5e3ef735e4 100644
--- a/tests/src/Kernel/Controller/ApiContentControllersListTest.php
+++ b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
@@ -4,6 +4,8 @@ declare(strict_types=1);
namespace Drupal\Tests\experience_builder\Kernel\Controller;
+// cspell:ignore Gábor Hojtsy uniquesearchterm gàbor
+
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\experience_builder\AutoSave\AutoSaveManager;
@@ -50,21 +52,21 @@ class ApiContentControllersListTest extends KernelTestBase {
*
* @var \Drupal\experience_builder\Controller\ApiContentControllers
*/
- protected $apiContentController;
+ protected ApiContentControllers $apiContentController;
/**
* The AutoSaveManager service.
*
* @var \Drupal\experience_builder\AutoSave\AutoSaveManager
*/
- protected $autoSaveManager;
+ protected AutoSaveManager $autoSaveManager;
/**
* The entity type manager service.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
- protected $entityTypeManager;
+ protected EntityTypeManagerInterface $entityTypeManager;
/**
* Test pages.
@@ -91,35 +93,15 @@ class ApiContentControllersListTest extends KernelTestBase {
// Properly retrieve services.
$this->apiContentController = $this->container->get(ApiContentControllers::class);
$this->autoSaveManager = $this->container->get(AutoSaveManager::class);
- $this->entityTypeManager = $this->container->get('entity_type.manager');
-
- // Verify service class types.
- $this->assertInstanceOf(ApiContentControllers::class, $this->apiContentController);
- $this->assertInstanceOf(AutoSaveManager::class, $this->autoSaveManager);
- $this->assertInstanceOf(EntityTypeManagerInterface::class, $this->entityTypeManager);
+ $this->entityTypeManager = $this->container->get(EntityTypeManagerInterface::class);
- // Create test pages.
$this->createTestPages();
}
- /**
- * Asserts that a service exists in the container.
- *
- * @param string $service_id
- * The service ID to check.
- */
- protected function assertServiceExists(string $service_id): void {
- $this->assertTrue(
- $this->container->has($service_id),
- sprintf('Service "%s" exists in the container', $service_id)
- );
- }
-
/**
* Creates test pages for the tests.
*/
protected function createTestPages(): void {
- // Create published page.
$page1 = Page::create([
'title' => "Published XB Page",
'status' => TRUE,
@@ -128,7 +110,6 @@ class ApiContentControllersListTest extends KernelTestBase {
$page1->save();
$this->pages['published'] = $page1;
- // Create unpublished page.
$page2 = Page::create([
'title' => "Unpublished XB Page",
'status' => FALSE,
@@ -147,8 +128,7 @@ class ApiContentControllersListTest extends KernelTestBase {
// Create a page with diacritical marks (accents) in title.
$page4 = Page::create([
- // cspell:ignore Gàbor Hojtsy
- 'title' => "Gàbor Hojtsy Page",
+ 'title' => "Gábor Hojtsy Page",
'status' => TRUE,
'path' => ['alias' => "/page-4"],
]);
@@ -200,7 +180,7 @@ class ApiContentControllersListTest extends KernelTestBase {
*/
protected function executeListRequest(array $query = []): array {
$request = Request::create(self::API_BASE_PATH, 'GET', $query);
- $response = $this->apiContentController->list('xb_page', $request);
+ $response = $this->apiContentController->list(Page::ENTITY_TYPE_ID, $request);
$this->assertInstanceOf(JsonResponse::class, $response);
$content = $response->getContent();
@@ -215,32 +195,24 @@ class ApiContentControllersListTest extends KernelTestBase {
* @param array $response_data
* The response data to validate.
* @param \Drupal\experience_builder\Entity\Page $page
- * The page to validate against.
+ * The page is to validate against.
* @param array $auto_save_data
* Optional auto-save data to validate.
*/
protected function assertValidPageData(array $response_data, Page $page, array $auto_save_data = []): void {
$page_id = (int) $page->id();
- $this->assertArrayHasKey($page_id, $response_data, "Response should contain page with ID $page_id");
- $this->assertEquals($page_id, $response_data[$page_id]['id'], 'Page ID should match');
- $this->assertEquals($page->label(), $response_data[$page_id]['title'], 'Page title should match');
- $this->assertEquals($page->isPublished(), $response_data[$page_id]['status'], 'Page status should match');
- $this->assertNotEmpty($response_data[$page_id]['path'], 'Page should have a path');
+ $this->assertArrayHasKey($page_id, $response_data);
+ $this->assertEquals($page_id, $response_data[$page_id]['id']);
+ $this->assertEquals($page->label(), $response_data[$page_id]['title']);
+ $this->assertEquals($page->isPublished(), $response_data[$page_id]['status']);
+ $this->assertNotEmpty($response_data[$page_id]['path']);
if (!empty($auto_save_data['label'])) {
- $this->assertEquals(
- $auto_save_data['label'],
- $response_data[$page_id]['autoSaveLabel'],
- 'Auto-save label should match'
- );
+ $this->assertEquals($auto_save_data['label'], $response_data[$page_id]['autoSaveLabel']);
}
if (isset($auto_save_data['path'])) {
- $this->assertEquals(
- $auto_save_data['path'],
- $response_data[$page_id]['autoSavePath'],
- 'Auto-save path should match'
- );
+ $this->assertEquals($auto_save_data['path'], $response_data[$page_id]['autoSavePath']);
}
}
@@ -298,12 +270,10 @@ class ApiContentControllersListTest extends KernelTestBase {
$this->assertEmpty($data, 'Search with no matches should return empty array');
// Test case insensitivity.
- // cspell:ignore uniquesearchterm
$data = $this->executeListRequest(['search' => 'uniquesearchterm']);
$this->assertCount(1, $data, 'Search should be case-insensitive');
// Test accented character matching (with accent in search term).
- // cspell:ignore Gàbor
$data = $this->executeListRequest(['search' => 'Gàbor']);
$this->assertCount(1, $data, 'Search with accented character should match page');
$this->assertValidPageData($data, $this->pages['accented']);
@@ -352,18 +322,13 @@ class ApiContentControllersListTest extends KernelTestBase {
* @covers ::list
*/
public function testEmptyEntityList(): void {
- // Delete all pages.
foreach ($this->pages as $page) {
$page->delete();
}
$this->pages = [];
- // Request the list.
$data = $this->executeListRequest();
-
- // Should return empty array.
- $this->assertEmpty($data, 'Empty page list should return empty array');
- $this->assertIsArray($data, 'Empty result should still be an array');
+ $this->assertSame([], $data);
}
}
diff --git a/ui/src/components/pageInfo/PageInfo.tsx b/ui/src/components/pageInfo/PageInfo.tsx
index 647910c9a0..7aede48536 100644
--- a/ui/src/components/pageInfo/PageInfo.tsx
+++ b/ui/src/components/pageInfo/PageInfo.tsx
@@ -141,7 +141,9 @@ const PageInfo = () => {
useEffect(() => {
const debouncedSearch = debounce((term: string) => {
- setSearchTerm(term);
+ if (term.length === 0 || term.length >= 3) {
+ setSearchTerm(term);
+ }
}, 400);
// Set up the debounced search effect
--
GitLab
From 3b41590283b1e6d045f0106747689aa25268f974 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Mon, 19 May 2025 11:14:28 +0530
Subject: [PATCH 16/56] code refactoring and feedback changes.
---
experience_builder.services.yml | 4 +-
src/Controller/ApiContentControllers.php | 44 ++++++++------
.../Functional/XbContentEntityHttpApiTest.php | 23 ++++---
.../ApiContentControllersListTest.php | 60 +++++++++++++++++++
ui/src/services/content.ts | 7 ++-
ui/tests/e2e/navigation.cy.js | 2 +-
6 files changed, 105 insertions(+), 35 deletions(-)
diff --git a/experience_builder.services.yml b/experience_builder.services.yml
index 3e91baebf0..5949751550 100644
--- a/experience_builder.services.yml
+++ b/experience_builder.services.yml
@@ -117,7 +117,9 @@ services:
Drupal\experience_builder\Controller\ApiLayoutController: {}
Drupal\experience_builder\Controller\ApiLogController: {}
Drupal\experience_builder\Controller\ApiContentUpdateForDemoController: {}
- Drupal\experience_builder\Controller\ApiContentControllers: {}
+ Drupal\experience_builder\Controller\ApiContentControllers:
+ arguments:
+ $transliteration: '@transliteration'
Drupal\experience_builder\Controller\ComponentStatusController: {}
Drupal\experience_builder\Controller\ComponentAuditController: {}
Drupal\experience_builder\Controller\ExperienceBuilderController: {}
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 0ee08813a6..f4ade6123c 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -13,6 +13,7 @@ use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Entity\Query\QueryInterface;
use Drupal\Core\Language\LanguageManagerInterface;
+use Drupal\Component\Transliteration\TransliterationInterface;
use Drupal\Core\Render\RenderContext;
use Drupal\Core\Render\RendererInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
@@ -45,6 +46,7 @@ final class ApiContentControllers {
private readonly SelectionPluginManagerInterface $selectionManager,
private readonly ClientDataToEntityConverter $clientDataToEntityConverter,
private readonly LanguageManagerInterface $languageManager,
+ private readonly TransliterationInterface $transliteration,
) {}
public function post(Request $request, string $entity_type): JsonResponse {
@@ -111,29 +113,30 @@ final class ApiContentControllers {
*/
public function list(string $entity_type, Request $request): CacheableJsonResponse {
$langcode = $this->languageManager->getCurrentLanguage()->getId();
- // @phpstan-ignore-next-line
- $trans = \Drupal::transliteration();
- // @todo introduce pagination in https://www.drupal.org/i/3502691.
$storage = $this->entityTypeManager->getStorage($entity_type);
// Setup cacheability metadata
$query_cacheability = $this->createInitialCacheability($storage);
$url_cacheability = new CacheableMetadata();
- // Create entity query with access check, last updated first,
+ // Create entity query with access check
/** @var \Drupal\Core\Entity\ContentEntityTypeInterface $field_definition */
$field_definition = $this->entityTypeManager->getDefinition($entity_type);
$revision_created_field_name = $field_definition->getRevisionMetadataKey('revision_created');
- $entity_query = $storage->getQuery()
- ->sort((string) $revision_created_field_name, direction: 'DESC')
- ->range(0, self::MAX_SEARCH_RESULTS)
- ->accessCheck(TRUE);
+ $entity_query = $storage->getQuery()->accessCheck(TRUE);
+
+ // Only apply sorting and range limiting when not searching
+ $is_search = $request->query->has('search');
+ if (!$is_search) {
+ $entity_query->sort((string) $revision_created_field_name, direction: 'DESC')
+ ->range(0, self::MAX_SEARCH_RESULTS);
+ }
// Handle search functionality if search parameter is present
$matching_ids = [];
$matching_unsaved_ids = [];
if ($request->query->has('search')) {
- $search = $this->prepareSearchTerm($request, $trans, $langcode);
+ $search = $this->prepareSearchTerm($request, $langcode);
$label_key = $storage->getEntityType()->getKey('label');
// @todo Remove this in https://www.drupal.org/project/experience_builder/issues/3498525.
@@ -146,7 +149,7 @@ final class ApiContentControllers {
$matching_ids = $this->getMatchingEntityIds($entity_type, $search);
// Find matching unsaved entities
- $matching_unsaved_ids = $this->getMatchingUnsavedIds($search, $trans, $langcode);
+ $matching_unsaved_ids = $this->getMatchingUnsavedIds($search, $langcode);
// Return empty response if no matches found
if (empty($matching_ids) && empty($matching_unsaved_ids)) {
@@ -188,7 +191,7 @@ final class ApiContentControllers {
* @return \Drupal\Core\Cache\CacheableMetadata
* The initialized cacheability metadata.
*/
- private function createInitialCacheability($storage): CacheableMetadata {
+ private static function createInitialCacheability($storage): CacheableMetadata {
return (new CacheableMetadata())
->addCacheContexts($storage->getEntityType()->getListCacheContexts())
->addCacheTags($storage->getEntityType()->getListCacheTags());
@@ -199,17 +202,15 @@ final class ApiContentControllers {
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The HTTP request object.
- * @param \Drupal\Component\Transliteration\TransliterationInterface $trans
- * The transliteration service.
* @param string $langcode
* The language code to use for transliteration.
*
* @return string
* The normalized search term.
*/
- private function prepareSearchTerm(Request $request, $trans, string $langcode): string {
+ private function prepareSearchTerm(Request $request, string $langcode): string {
$search = trim((string) $request->query->get('search'));
- return $trans->transliterate(mb_strtolower($search), $langcode);
+ return $this->transliteration->transliterate(mb_strtolower($search), $langcode);
}
/**
@@ -245,20 +246,18 @@ final class ApiContentControllers {
*
* @param string $search
* The search term to match against entities.
- * @param \Drupal\Component\Transliteration\TransliterationInterface $trans
- * The transliteration service.
* @param string $langcode
* The language code to use for transliteration.
*
* @return array
* An array of entity IDs that match the search criteria.
*/
- private function getMatchingUnsavedIds(string $search, $trans, string $langcode): array {
+ private function getMatchingUnsavedIds(string $search, string $langcode): array {
$matching_unsaved_ids = [];
$unsaved_entries = $this->autoSaveManager->getAllAutoSaveList();
foreach ($unsaved_entries as $entry) {
- $label = $trans->transliterate(mb_strtolower($entry['label']), $langcode);
+ $label = $this->transliteration->transliterate(mb_strtolower($entry['label']), $langcode);
if (isset($label) && isset($entry['entity_id']) &&
str_contains(mb_strtolower($label), $search)) {
$matching_unsaved_ids[] = $entry['entity_id'];
@@ -308,6 +307,13 @@ final class ApiContentControllers {
$ids = array_unique(array_merge($ids, $matching_unsaved_ids));
}
+ // Apply the limit to search results
+ if (!empty($matching_ids) || !empty($matching_unsaved_ids)) {
+ // Sort by newest first (keys will be numeric IDs) and limit to max results
+ arsort($ids);
+ $ids = array_slice($ids, 0, self::MAX_SEARCH_RESULTS, TRUE);
+ }
+
return $ids;
}
diff --git a/tests/src/Functional/XbContentEntityHttpApiTest.php b/tests/src/Functional/XbContentEntityHttpApiTest.php
index 7a4a737a7d..79017c1bb0 100644
--- a/tests/src/Functional/XbContentEntityHttpApiTest.php
+++ b/tests/src/Functional/XbContentEntityHttpApiTest.php
@@ -123,20 +123,17 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
$search_url = Url::fromUri('base:/xb/api/v0/content/xb_page', ['query' => ['search' => 'Page 1']]);
// Confirm that the cache is not hit when a different request is made with query parameter.
$search_body = $this->assertExpectedResponse('GET', $search_url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
-
- $search_expected_pages = [
- '1' => [
- 'id' => 1,
- 'title' => 'Page 1',
- 'status' => TRUE,
- 'path' => base_path() . 'page-1',
- 'autoSaveLabel' => NULL,
- 'autoSavePath' => NULL,
- ],
- ];
-
$this->assertEquals(
- $search_expected_pages,
+ [
+ '1' => [
+ 'id' => 1,
+ 'title' => 'Page 1',
+ 'status' => TRUE,
+ 'path' => base_path() . 'page-1',
+ 'autoSaveLabel' => NULL,
+ 'autoSavePath' => NULL,
+ ],
+ ],
$search_body
);
// Confirm that the cache is hit when the same request is made again.
diff --git a/tests/src/Kernel/Controller/ApiContentControllersListTest.php b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
index 5e3ef735e4..df881f9e79 100644
--- a/tests/src/Kernel/Controller/ApiContentControllersListTest.php
+++ b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
@@ -6,6 +6,7 @@ namespace Drupal\Tests\experience_builder\Kernel\Controller;
// cspell:ignore Gábor Hojtsy uniquesearchterm gàbor
+use Drupal\Component\Transliteration\TransliterationInterface;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\experience_builder\AutoSave\AutoSaveManager;
@@ -68,6 +69,13 @@ class ApiContentControllersListTest extends KernelTestBase {
*/
protected EntityTypeManagerInterface $entityTypeManager;
+ /**
+ * The transliteration service.
+ *
+ * @var \Drupal\Component\Transliteration\TransliterationInterface
+ */
+ protected TransliterationInterface $transliteration;
+
/**
* Test pages.
*
@@ -94,6 +102,7 @@ class ApiContentControllersListTest extends KernelTestBase {
$this->apiContentController = $this->container->get(ApiContentControllers::class);
$this->autoSaveManager = $this->container->get(AutoSaveManager::class);
$this->entityTypeManager = $this->container->get(EntityTypeManagerInterface::class);
+ $this->transliteration = $this->container->get('transliteration');
$this->createTestPages();
}
@@ -331,4 +340,55 @@ class ApiContentControllersListTest extends KernelTestBase {
$this->assertSame([], $data);
}
+ /**
+ * Tests that search results are sorted by most recently updated first.
+ *
+ * @covers ::list
+ * @covers ::filterAndMergeIds
+ */
+ public function testSearchSortOrder(): void {
+ // Create test pages with the same search term but different titles
+ $pages_data = [
+ 'page1' => "XB Search Term One",
+ 'page2' => "XB Search Term Two",
+ 'page3' => "XB Search Term Three",
+ ];
+
+ $page_ids = [];
+
+ // Create the pages in sequence
+ foreach ($pages_data as $key => $title) {
+ $page = Page::create([
+ 'title' => $title,
+ 'status' => TRUE,
+ ]);
+ $page->save();
+ $this->pages[$key] = $page;
+ $page_ids[$key] = (int) $page->id();
+ }
+
+ // Update the pages in reverse order to change their revision timestamps
+ // This ensures page1 is most recently updated, followed by page2, then page3
+ $update_order = array_reverse(array_keys($pages_data));
+ foreach ($update_order as $key) {
+ $this->pages[$key]->set('title', "{$pages_data[$key]} Updated");
+ $this->pages[$key]->save();
+ }
+
+ $data = $this->executeListRequest(['search' => 'XB Search Term']);
+ $this->assertCount(3, $data, 'Search should return all three matching pages');
+
+ // Get the IDs in order they appear in the results
+ $result_ids = array_map(function ($item) {
+ return $item['id'];
+ }, $data);
+
+ $result_ids = array_keys($result_ids);
+
+ // Verify the order is by most recently updated (page1, page2, page3)
+ $this->assertSame($page_ids['page1'], $result_ids[2]);
+ $this->assertSame($page_ids['page2'], $result_ids[1]);
+ $this->assertSame($page_ids['page3'], $result_ids[0]);
+ }
+
}
diff --git a/ui/src/services/content.ts b/ui/src/services/content.ts
index 8f7cb3e5d1..4b9ac8742d 100644
--- a/ui/src/services/content.ts
+++ b/ui/src/services/content.ts
@@ -44,7 +44,12 @@ export const contentApi = createApi({
};
},
transformResponse: (response: ContentListResponse) => {
- return Object.values(response);
+ // Convert response object to array while preserving order
+ // Sort by ID in descending order to maintain newest first order
+ return Object.values(response).sort((a, b) => {
+ // Convert IDs to numbers for comparison, newer IDs are typically higher
+ return Number(b.id) - Number(a.id);
+ });
},
providesTags: [{ type: 'Content', id: 'LIST' }],
}),
diff --git a/ui/tests/e2e/navigation.cy.js b/ui/tests/e2e/navigation.cy.js
index 03cca06d7b..b36a141fea 100644
--- a/ui/tests/e2e/navigation.cy.js
+++ b/ui/tests/e2e/navigation.cy.js
@@ -236,7 +236,7 @@ describe('Navigation functionality', () => {
// Wait for the GET request to the list endpoint which should be triggered by the deletion of a page.
cy.wait('@getList').its('response.statusCode').should('eq', 200);
cy.url().should('not.contain', '/xb/xb_page/3');
- cy.url().should('contain', '/xb/xb_page/1');
+ cy.url().should('contain', '/xb/xb_page/4');
cy.findByTestId(navigationButtonTestId).click();
cy.findByTestId(navigationContentTestId)
.should('exist')
--
GitLab
From 1218b3cd6a4c6e8124136d5898269b5df37117c2 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Fri, 30 May 2025 00:17:13 +0530
Subject: [PATCH 17/56] transilteration doesn't work well with sqlite.
---
.gitlab-ci.yml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 0b71c1f9bb..bd539ad6e5 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -222,14 +222,14 @@ phpunit:
_TARGET_DB_VERSION: '3'
# @see https://git.drupalcode.org/project/drupal/-/commit/10466dba9d7322ed55165dd9224edb2153c9b27a
_TARGET_PHP: '8.3-ubuntu'
- _FOR_EVERY_MR_COMMIT: 'true'
+ _FOR_EVERY_MR_COMMIT: 'false'
- _TARGET_DB_TYPE: 'mariadb'
_TARGET_DB_VERSION: '10.6'
_FOR_EVERY_MR_COMMIT: 'false'
- _TARGET_DB_TYPE: 'mysql'
# @todo Delete this when https://www.drupal.org/project/gitlab_templates/issues/3447105 lands.
_TARGET_DB_VERSION: '8'
- _FOR_EVERY_MR_COMMIT: 'false'
+ _FOR_EVERY_MR_COMMIT: 'true'
- _TARGET_DB_TYPE: 'pgsql'
_TARGET_DB_VERSION: '16'
_FOR_EVERY_MR_COMMIT: 'false'
--
GitLab
From 19ae5a071e3f2632e470d08003474607194f5d7c Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Mon, 16 Jun 2025 17:36:34 +0530
Subject: [PATCH 18/56] code refactor and minor nits.
---
src/Controller/ApiContentControllers.php | 84 +++++-----
.../ApiContentControllersListTest.php | 151 ++++++++++++------
2 files changed, 150 insertions(+), 85 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 938461e194..f4701c01a7 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -167,27 +167,35 @@ final class ApiContentControllers {
}
}
- // Get entity IDs and filter by search results if needed
+ // Get entity IDs and filter by search results if needed.
$ids = $this->executeQueryInRenderContext($entity_query, $query_cacheability);
$ids = $this->filterAndMergeIds($ids, $matching_ids, $matching_unsaved_ids);
- // Load entities and prepare content list
+ // Load entities and prepare content list.
/** @var \Drupal\Core\Entity\EntityPublishedInterface[] $content_entities */
$content_entities = $storage->loadMultiple($ids);
$content_list = [];
+ $entity_cache_tags = [];
foreach ($content_entities as $content_entity) {
- $entity_data = $this->prepareEntityData($content_entity, $url_cacheability);
- $content_list[$entity_data['id']] = $entity_data;
+ $id = (int) $content_entity->id();
+ $entity_data = $this->prepareEntityData($content_entity, $url_cacheability, $id);
+ $content_list[$id] = $entity_data[$id];
+ // Collect all cache tags from the loaded entities.
+ if (method_exists($content_entity, 'getCacheTags')) {
+ $entity_cache_tags = array_merge($entity_cache_tags, $content_entity->getCacheTags());
+ }
}
+ $entity_cache_tags = array_unique($entity_cache_tags);
// Create and configure the response.
$json_response = new CacheableJsonResponse($content_list);
+ $this->addSearchCacheability($query_cacheability);
// @todo add cache contexts for query params when introducing pagination in https://www.drupal.org/i/3502691.
$json_response->addCacheableDependency($query_cacheability)
->addCacheableDependency($url_cacheability);
- if (isset($autoSaveData)) {
- $json_response->addCacheableDependency($autoSaveData);
+ if (!empty($entity_cache_tags)) {
+ $json_response->addCacheableDependency((new CacheableMetadata())->setCacheTags($entity_cache_tags));
}
return $json_response;
}
@@ -334,12 +342,13 @@ final class ApiContentControllers {
* The content entity to prepare data for.
* @param \Drupal\Core\Cache\CacheableMetadata $url_cacheability
* The cacheability metadata object to add URL dependencies to.
+ * @param int $id
+ * The entity ID.
*
* @return array
* An associative array containing the prepared entity data.
*/
- private function prepareEntityData(EntityPublishedInterface $content_entity, CacheableMetadata $url_cacheability): array {
- $id = (int) $content_entity->id();
+ private function prepareEntityData(EntityPublishedInterface $content_entity, CacheableMetadata $url_cacheability, int $id): array {
$generated_url = $content_entity->toUrl()->toString(TRUE);
$autoSaveData = $this->autoSaveManager->getAutoSaveData($content_entity);
@@ -359,43 +368,44 @@ final class ApiContentControllers {
'links' => $linkCollection->asArray(),
];
$url_cacheability->addCacheableDependency($generated_url)
- ->addCacheableDependency($linkCollection);
+ ->addCacheableDependency($linkCollection)
+ ->addCacheableDependency($autoSaveData);
return $content_list;
}
-/**
- * Determines the auto-save path for an entity.
- *
- * @param \Drupal\Core\Entity\EntityPublishedInterface $content_entity
- * The content entity to get the auto-save path for.
- * @param object $autoSaveData
- * The auto-save data object containing path information.
- *
- * @return string|null
- * The auto-save path, or NULL if none exists.
- */
-private function determineAutoSavePath(EntityPublishedInterface $content_entity, $autoSaveData): ?string {
- // @todo Dynamically use the entity 'path' key to determine which field is
- // the path in https://drupal.org/i/3503446.
- $path_form_key = 'path[0][alias]';
+ /**
+ * Determines the auto-save path for an entity.
+ *
+ * @param \Drupal\Core\Entity\EntityPublishedInterface $content_entity
+ * The content entity to get the auto-save path for.
+ * @param object $autoSaveData
+ * The auto-save data object containing path information.
+ *
+ * @return string|null
+ * The auto-save path, or NULL if none exists.
+ */
+ private function determineAutoSavePath(EntityPublishedInterface $content_entity, $autoSaveData): ?string {
+ // @todo Dynamically use the entity 'path' key to determine which field is
+ // the path in https://drupal.org/i/3503446.
+ $path_form_key = 'path[0][alias]';
- if (!isset($autoSaveData->data['entity_form_fields'][$path_form_key])) {
- return NULL;
- }
+ if (!isset($autoSaveData->data['entity_form_fields'][$path_form_key])) {
+ return NULL;
+ }
- // If an alias is not set in the auto-save data, fall back to the
- // internal path as any alias in the saved entity will be removed.
- if (empty($autoSaveData->data['entity_form_fields'][$path_form_key])) {
- return '/' . $content_entity->toUrl()->getInternalPath();
- }
+ // If an alias is not set in the auto-save data, fall back to the
+ // internal path as any alias in the saved entity will be removed.
+ if (empty($autoSaveData->data['entity_form_fields'][$path_form_key])) {
+ return '/' . $content_entity->toUrl()->getInternalPath();
+ }
- // The alias user input should always start with '/'.
- $autoSavePath = $autoSaveData->data['entity_form_fields'][$path_form_key];
- assert(str_starts_with($autoSavePath, '/'));
+ // The alias user input should always start with '/'.
+ $autoSavePath = $autoSaveData->data['entity_form_fields'][$path_form_key];
+ assert(str_starts_with($autoSavePath, '/'));
- return $autoSavePath;
-}
+ return $autoSavePath;
+ }
/**
* Duplicates entity.
diff --git a/tests/src/Kernel/Controller/ApiContentControllersListTest.php b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
index df881f9e79..29a1d6ebbe 100644
--- a/tests/src/Kernel/Controller/ApiContentControllersListTest.php
+++ b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
@@ -4,7 +4,7 @@ declare(strict_types=1);
namespace Drupal\Tests\experience_builder\Kernel\Controller;
-// cspell:ignore Gábor Hojtsy uniquesearchterm gàbor
+// cspell:ignore Gábor Hojtsy uniquesearchterm gàbor autosave searchterm
use Drupal\Component\Transliteration\TransliterationInterface;
use Drupal\Core\Entity\ContentEntityInterface;
@@ -89,6 +89,12 @@ class ApiContentControllersListTest extends KernelTestBase {
protected function setUp(): void {
parent::setUp();
+ // Skip the test for PostgreSQL and SQLite databases.
+ $database_type = $this->container->get('database')->driver();
+ if ($database_type === 'pgsql' || $database_type === 'sqlite') {
+ $this->markTestSkipped('This test is only for MySQL/MariaDB database drivers.');
+ }
+
$this->installEntitySchema('user');
$this->installEntitySchema('xb_page');
$this->installEntitySchema('path_alias');
@@ -98,7 +104,6 @@ class ApiContentControllersListTest extends KernelTestBase {
// Create a user with appropriate permissions.
$this->setUpCurrentUser([], ['access content', 'create xb_page', 'edit xb_page', 'delete xb_page']);
- // Properly retrieve services.
$this->apiContentController = $this->container->get(ApiContentControllers::class);
$this->autoSaveManager = $this->container->get(AutoSaveManager::class);
$this->entityTypeManager = $this->container->get(EntityTypeManagerInterface::class);
@@ -190,10 +195,10 @@ class ApiContentControllersListTest extends KernelTestBase {
protected function executeListRequest(array $query = []): array {
$request = Request::create(self::API_BASE_PATH, 'GET', $query);
$response = $this->apiContentController->list(Page::ENTITY_TYPE_ID, $request);
- $this->assertInstanceOf(JsonResponse::class, $response);
+ self::assertInstanceOf(JsonResponse::class, $response);
$content = $response->getContent();
- $this->assertNotEmpty($content);
+ self::assertNotEmpty($content);
return json_decode($content, TRUE);
}
@@ -205,23 +210,23 @@ class ApiContentControllersListTest extends KernelTestBase {
* The response data to validate.
* @param \Drupal\experience_builder\Entity\Page $page
* The page is to validate against.
- * @param array $auto_save_data
+ * @param array $expected_auto_save_data
* Optional auto-save data to validate.
*/
- protected function assertValidPageData(array $response_data, Page $page, array $auto_save_data = []): void {
+ protected function assertValidPageData(array $response_data, Page $page, array $expected_auto_save_data = []): void {
$page_id = (int) $page->id();
- $this->assertArrayHasKey($page_id, $response_data);
- $this->assertEquals($page_id, $response_data[$page_id]['id']);
- $this->assertEquals($page->label(), $response_data[$page_id]['title']);
- $this->assertEquals($page->isPublished(), $response_data[$page_id]['status']);
- $this->assertNotEmpty($response_data[$page_id]['path']);
-
- if (!empty($auto_save_data['label'])) {
- $this->assertEquals($auto_save_data['label'], $response_data[$page_id]['autoSaveLabel']);
+ self::assertArrayHasKey($page_id, $response_data);
+ self::assertSame($page_id, $response_data[$page_id]['id']);
+ self::assertSame($page->label(), $response_data[$page_id]['title']);
+ self::assertSame($page->isPublished(), $response_data[$page_id]['status']);
+ self::assertNotEmpty($response_data[$page_id]['path']);
+
+ if (!empty($expected_auto_save_data['label'])) {
+ self::assertSame($expected_auto_save_data['label'], $response_data[$page_id]['autoSaveLabel']);
}
- if (isset($auto_save_data['path'])) {
- $this->assertEquals($auto_save_data['path'], $response_data[$page_id]['autoSavePath']);
+ if (isset($expected_auto_save_data['path'])) {
+ self::assertSame($expected_auto_save_data['path'], $response_data[$page_id]['autoSavePath']);
}
}
@@ -235,28 +240,50 @@ class ApiContentControllersListTest extends KernelTestBase {
$response = $this->apiContentController->list('xb_page', Request::create(self::API_BASE_PATH, 'GET'));
// Validate response format.
- $this->assertInstanceOf(JsonResponse::class, $response, 'Response should be a JsonResponse');
+ self::assertInstanceOf(JsonResponse::class, $response, 'Response should be a JsonResponse');
$content = $response->getContent();
- $this->assertNotEmpty($content, 'Response content should not be empty');
+ self::assertNotEmpty($content, 'Response content should not be empty');
// Decode and validate response data.
$data = json_decode($content, TRUE);
- $this->assertIsArray($data, 'Response data should be an array');
+ self::assertIsArray($data, 'Response data should be an array');
// Check that all pages are returned.
- $this->assertCount(count($this->pages), $data, 'Response should contain all test pages');
+ self::assertCount(count($this->pages), $data, 'Response should contain all test pages');
// Verify response structure and content for each page.
foreach ($this->pages as $page) {
$this->assertValidPageData($data, $page);
}
- // Verify cache metadata.
+ // Verify complete cache metadata.
$cache_metadata = $response->getCacheableMetadata();
- $this->assertNotEmpty($cache_metadata->getCacheTags(), 'Response should have cache tags');
- $this->assertContains('xb_page_list', $cache_metadata->getCacheTags(), 'Response should have xb_page_list cache tag');
- $this->assertContains(AutoSaveManager::CACHE_TAG, $cache_metadata->getCacheTags(), 'Response should have auto-save cache tag');
- $this->assertContains('url.query_args:search', $cache_metadata->getCacheContexts(), 'Response should vary by search parameter');
+
+ // Expected cache tags should include entity list tag, auto-save tag,
+ // and individual entity tags
+ $expected_cache_tags = [
+ 'xb_page_list',
+ AutoSaveManager::CACHE_TAG,
+ ];
+ // Add cache tags for each page entity.
+ foreach ($this->pages as $page) {
+ $expected_cache_tags[] = 'xb_page:' . $page->id();
+ }
+ sort($expected_cache_tags);
+ $actual_cache_tags = $cache_metadata->getCacheTags();
+ sort($actual_cache_tags);
+
+ // Expected cache contexts for the response
+ $expected_cache_contexts = [
+ 'url.query_args:search',
+ 'user.permissions',
+ ];
+ sort($expected_cache_contexts);
+ $actual_cache_contexts = $cache_metadata->getCacheContexts();
+ sort($actual_cache_contexts);
+
+ self::assertEmpty(array_diff($expected_cache_tags, $actual_cache_tags), 'All expected cache tags should be present');
+ self::assertEmpty(array_diff($expected_cache_contexts, $actual_cache_contexts), 'All expected cache contexts should be present');
}
/**
@@ -265,36 +292,29 @@ class ApiContentControllersListTest extends KernelTestBase {
* @covers ::list
*/
public function testListWithSearch(): void {
- // Test with a search term that should match one page.
$data = $this->executeListRequest(['search' => 'UniqueSearchTerm']);
- $this->assertCount(1, $data, 'Search should return exactly one result');
+ self::assertCount(1, $data, 'Search should return exactly one result');
$this->assertValidPageData($data, $this->pages['searchable']);
- // Test with a search term that should match multiple pages.
$data = $this->executeListRequest(['search' => 'XB Page']);
- $this->assertGreaterThan(1, count($data), 'Search should return multiple results');
+ self::assertGreaterThan(1, count($data), 'Search should return multiple results');
- // Test with a search term that should match no pages.
$data = $this->executeListRequest(['search' => 'NoMatchingTerm']);
- $this->assertEmpty($data, 'Search with no matches should return empty array');
+ self::assertEmpty($data, 'Search with no matches should return empty array');
- // Test case insensitivity.
$data = $this->executeListRequest(['search' => 'uniquesearchterm']);
- $this->assertCount(1, $data, 'Search should be case-insensitive');
+ self::assertCount(1, $data, 'Search should be case-insensitive');
- // Test accented character matching (with accent in search term).
- $data = $this->executeListRequest(['search' => 'Gàbor']);
- $this->assertCount(1, $data, 'Search with accented character should match page');
+ $data = $this->executeListRequest(['search' => 'Gábor']);
+ self::assertCount(1, $data, 'Search with accented character should match page');
$this->assertValidPageData($data, $this->pages['accented']);
- // Test accented character matching (without accent in search term).
$data = $this->executeListRequest(['search' => 'gabor']);
- $this->assertCount(1, $data, 'Search without accent should match page with accented character');
+ self::assertCount(1, $data, 'Search without accent should match page with accented character');
$this->assertValidPageData($data, $this->pages['accented']);
- // Test with mixed casing.
$data = $this->executeListRequest(['search' => 'puBliSHed']);
- $this->assertCount(2, $data, 'Search with mixed case should match published and unpublished page');
+ self::assertCount(2, $data, 'Search with mixed case should match published and unpublished page');
}
/**
@@ -318,15 +338,15 @@ class ApiContentControllersListTest extends KernelTestBase {
// The restricted page should be included in the results.
$page_id = (int) $restricted_page->id();
- $this->assertArrayHasKey($page_id, $data, 'Page with restricted access should be included in the list');
+ self::assertArrayHasKey($page_id, $data, 'Page with restricted access should be included in the list');
// Verify that the API lists all content regardless of access restrictions.
- $this->assertCount(count($this->pages) + 1, $data,
+ self::assertCount(count($this->pages) + 1, $data,
'Response should contain all pages regardless of access restrictions');
}
/**
- * Tests handling of entity types with no pages.
+ * Tests search when no searchable content entities (currently only pages) exist yet.
*
* @covers ::list
*/
@@ -337,7 +357,7 @@ class ApiContentControllersListTest extends KernelTestBase {
$this->pages = [];
$data = $this->executeListRequest();
- $this->assertSame([], $data);
+ self::assertSame([], $data);
}
/**
@@ -376,7 +396,7 @@ class ApiContentControllersListTest extends KernelTestBase {
}
$data = $this->executeListRequest(['search' => 'XB Search Term']);
- $this->assertCount(3, $data, 'Search should return all three matching pages');
+ self::assertCount(3, $data, 'Search should return all three matching pages');
// Get the IDs in order they appear in the results
$result_ids = array_map(function ($item) {
@@ -386,9 +406,44 @@ class ApiContentControllersListTest extends KernelTestBase {
$result_ids = array_keys($result_ids);
// Verify the order is by most recently updated (page1, page2, page3)
- $this->assertSame($page_ids['page1'], $result_ids[2]);
- $this->assertSame($page_ids['page2'], $result_ids[1]);
- $this->assertSame($page_ids['page3'], $result_ids[0]);
+ self::assertSame($page_ids['page1'], $result_ids[2]);
+ self::assertSame($page_ids['page2'], $result_ids[1]);
+ self::assertSame($page_ids['page3'], $result_ids[0]);
+ }
+
+ /**
+ * Tests auto-save entries in search results.
+ *
+ * @covers ::list
+ * @covers ::filterAndMergeIds
+ */
+ public function testSearchWithAutoSave(): void {
+ // Create a page with basic title
+ $page = Page::create([
+ 'title' => "Original Title Page",
+ 'status' => TRUE,
+ 'path' => ['alias' => "/original-page"],
+ ]);
+ $page->save();
+
+ // Create auto-save data with a searchable term
+ $this->createAutoSaveData($page, "AutoSave SearchTerm Title", "/autosave-path");
+ $data = $this->executeListRequest(['search' => 'AutoSave SearchTerm']);
+ self::assertCount(5, $data, 'Search should find the page with matching auto-save data');
+
+ // Verify that both original and auto-save data are correctly included
+ $page_id = (int) $page->id();
+ self::assertArrayHasKey($page_id, $data);
+ self::assertSame($page_id, $data[$page_id]['id']);
+ self::assertSame($page->label(), $data[$page_id]['title']);
+ self::assertSame("AutoSave SearchTerm Title", $data[$page_id]['autoSaveLabel']);
+ self::assertSame("/autosave-path", $data[$page_id]['autoSavePath']);
+
+ $data = $this->executeListRequest(['search' => 'autosave searchterm']);
+ self::assertCount(5, $data, 'Search should be case-insensitive for auto-save data');
+
+ $data = $this->executeListRequest(['search' => 'Original Title']);
+ self::assertCount(1, $data, 'Search should find original title when auto-save exists');
}
}
--
GitLab
From 2b0b6f152db405c48870586ba31985b8c563a9e7 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Mon, 16 Jun 2025 19:57:19 +0530
Subject: [PATCH 19/56] phpunit fixes.
---
src/Controller/ApiContentControllers.php | 9 ---------
tests/src/Functional/XbContentEntityHttpApiTest.php | 7 ++++++-
.../Controller/ApiContentControllersListTest.php | 13 ++-----------
3 files changed, 8 insertions(+), 21 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index f4701c01a7..eed0ed88b0 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -175,18 +175,12 @@ final class ApiContentControllers {
/** @var \Drupal\Core\Entity\EntityPublishedInterface[] $content_entities */
$content_entities = $storage->loadMultiple($ids);
$content_list = [];
- $entity_cache_tags = [];
foreach ($content_entities as $content_entity) {
$id = (int) $content_entity->id();
$entity_data = $this->prepareEntityData($content_entity, $url_cacheability, $id);
$content_list[$id] = $entity_data[$id];
- // Collect all cache tags from the loaded entities.
- if (method_exists($content_entity, 'getCacheTags')) {
- $entity_cache_tags = array_merge($entity_cache_tags, $content_entity->getCacheTags());
- }
}
- $entity_cache_tags = array_unique($entity_cache_tags);
// Create and configure the response.
$json_response = new CacheableJsonResponse($content_list);
@@ -194,9 +188,6 @@ final class ApiContentControllers {
// @todo add cache contexts for query params when introducing pagination in https://www.drupal.org/i/3502691.
$json_response->addCacheableDependency($query_cacheability)
->addCacheableDependency($url_cacheability);
- if (!empty($entity_cache_tags)) {
- $json_response->addCacheableDependency((new CacheableMetadata())->setCacheTags($entity_cache_tags));
- }
return $json_response;
}
diff --git a/tests/src/Functional/XbContentEntityHttpApiTest.php b/tests/src/Functional/XbContentEntityHttpApiTest.php
index b6e6f8172d..4b26ae0c92 100644
--- a/tests/src/Functional/XbContentEntityHttpApiTest.php
+++ b/tests/src/Functional/XbContentEntityHttpApiTest.php
@@ -149,6 +149,11 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
'path' => base_path() . 'page-1',
'autoSaveLabel' => NULL,
'autoSavePath' => NULL,
+ 'links' => [
+ // @todo https://www.drupal.org/i/3498525 should standardize arguments.
+ XbUriDefinitions::LINK_REL_EDIT => Url::fromUri('base:/xb/xb_page/1')->toString(),
+ XbUriDefinitions::LINK_REL_DUPLICATE => Url::fromUri('base:/xb/api/v0/content/xb_page')->toString(),
+ ],
],
],
$search_body
@@ -259,7 +264,7 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
assert($user instanceof UserInterface);
$this->drupalLogin($user);
- $body = $this->assertExpectedResponse('GET', $url, [], 200, Cache::mergeContexts(['user.permissions'], $extraCacheContexts), Cache::mergeTags([AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], $extraCacheTags), 'UNCACHEABLE (request policy)', 'MISS');
+ $body = $this->assertExpectedResponse('GET', $url, [], 200, Cache::mergeContexts(['url.query_args:search', 'user.permissions'], $extraCacheContexts), Cache::mergeTags([AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], $extraCacheTags), 'UNCACHEABLE (request policy)', 'MISS');
assert(\is_array($body));
assert(\array_key_exists('1', $body) && \array_key_exists('links', $body['1']));
$this->assertEquals(
diff --git a/tests/src/Kernel/Controller/ApiContentControllersListTest.php b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
index 29a1d6ebbe..ffeef883ff 100644
--- a/tests/src/Kernel/Controller/ApiContentControllersListTest.php
+++ b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
@@ -265,25 +265,16 @@ class ApiContentControllersListTest extends KernelTestBase {
'xb_page_list',
AutoSaveManager::CACHE_TAG,
];
- // Add cache tags for each page entity.
- foreach ($this->pages as $page) {
- $expected_cache_tags[] = 'xb_page:' . $page->id();
- }
- sort($expected_cache_tags);
$actual_cache_tags = $cache_metadata->getCacheTags();
- sort($actual_cache_tags);
// Expected cache contexts for the response
$expected_cache_contexts = [
'url.query_args:search',
'user.permissions',
];
- sort($expected_cache_contexts);
$actual_cache_contexts = $cache_metadata->getCacheContexts();
- sort($actual_cache_contexts);
-
- self::assertEmpty(array_diff($expected_cache_tags, $actual_cache_tags), 'All expected cache tags should be present');
- self::assertEmpty(array_diff($expected_cache_contexts, $actual_cache_contexts), 'All expected cache contexts should be present');
+ self::assertEquals($expected_cache_tags, $actual_cache_tags, 'All expected cache tags should be present');
+ self::assertEquals($expected_cache_contexts, $actual_cache_contexts, 'All expected cache contexts should be present');
}
/**
--
GitLab
From edfe89554e9811bbd12f364254a8411ccc3cc352 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Fri, 20 Jun 2025 14:37:43 +0530
Subject: [PATCH 20/56] fix cypress test.
---
ui/tests/e2e/navigation.cy.js | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/ui/tests/e2e/navigation.cy.js b/ui/tests/e2e/navigation.cy.js
index 913784dd82..01e81f0170 100644
--- a/ui/tests/e2e/navigation.cy.js
+++ b/ui/tests/e2e/navigation.cy.js
@@ -73,7 +73,7 @@ describe('Navigation functionality', () => {
.findAllByRole('listitem')
.should(($children) => {
const count = $children.length;
- expect(count).to.be.eq(2);
+ expect(count).to.be.eq(3);
expect($children.text()).to.contain('Homepage');
expect($children.text()).to.contain('Empty Page');
});
@@ -251,7 +251,7 @@ describe('Navigation functionality', () => {
// Wait for the GET request to the list endpoint which should be triggered by the deletion of a page.
cy.wait('@getList').its('response.statusCode').should('eq', 200);
cy.url().should('not.contain', '/xb/xb_page/3');
- cy.url().should('contain', '/xb/xb_page/4');
+ cy.url().should('contain', '/xb/xb_page/5');
cy.findByTestId(navigationButtonTestId).click();
cy.findByTestId(navigationContentTestId)
.should('exist')
--
GitLab
From 25ff29a98a3df164f5d47a3bc434386130ee3fb7 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Fri, 20 Jun 2025 19:17:05 +0530
Subject: [PATCH 21/56] refactor ApiContentControllersListTest class.
---
.../ApiContentControllersListTest.php | 125 ++++++++++--------
1 file changed, 69 insertions(+), 56 deletions(-)
diff --git a/tests/src/Kernel/Controller/ApiContentControllersListTest.php b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
index ffeef883ff..b6b43825bf 100644
--- a/tests/src/Kernel/Controller/ApiContentControllersListTest.php
+++ b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
@@ -102,7 +102,7 @@ class ApiContentControllersListTest extends KernelTestBase {
$this->installConfig(['system', 'field', 'filter', 'path_alias']);
// Create a user with appropriate permissions.
- $this->setUpCurrentUser([], ['access content', 'create xb_page', 'edit xb_page', 'delete xb_page']);
+ $this->setUpCurrentUser([], ['access content', Page::CREATE_PERMISSION, Page::EDIT_PERMISSION, Page::DELETE_PERMISSION]);
$this->apiContentController = $this->container->get(ApiContentControllers::class);
$this->autoSaveManager = $this->container->get(AutoSaveManager::class);
@@ -179,7 +179,6 @@ class ApiContentControllersListTest extends KernelTestBase {
if ($path !== NULL) {
$form_data['entity_form_fields']['path[0][alias]'] = $path;
}
- // Save the auto-save data.
$this->autoSaveManager->save($entity, $form_data);
}
@@ -208,25 +207,24 @@ class ApiContentControllersListTest extends KernelTestBase {
*
* @param array $response_data
* The response data to validate.
- * @param \Drupal\experience_builder\Entity\Page $page
- * The page is to validate against.
+ * @param array $expected_search_result_data
+ * Expected search result data to validate against.
* @param array $expected_auto_save_data
* Optional auto-save data to validate.
*/
- protected function assertValidPageData(array $response_data, Page $page, array $expected_auto_save_data = []): void {
- $page_id = (int) $page->id();
- self::assertArrayHasKey($page_id, $response_data);
- self::assertSame($page_id, $response_data[$page_id]['id']);
- self::assertSame($page->label(), $response_data[$page_id]['title']);
- self::assertSame($page->isPublished(), $response_data[$page_id]['status']);
- self::assertNotEmpty($response_data[$page_id]['path']);
+ protected function assertValidPageData(array $response_data, array $expected_search_result_data, array $expected_auto_save_data = []): void {
+ // Assert that all expected fields are present and correct
+ foreach ($expected_search_result_data as $key => $expected_value) {
+ self::assertArrayHasKey($key, $response_data, "Response should contain key: {$key}");
+ self::assertSame($expected_value, $response_data[$key], "Value for {$key} should match expected value");
+ }
if (!empty($expected_auto_save_data['label'])) {
- self::assertSame($expected_auto_save_data['label'], $response_data[$page_id]['autoSaveLabel']);
+ self::assertSame($expected_auto_save_data['label'], $response_data['autoSaveLabel']);
}
if (isset($expected_auto_save_data['path'])) {
- self::assertSame($expected_auto_save_data['path'], $response_data[$page_id]['autoSavePath']);
+ self::assertSame($expected_auto_save_data['path'], $response_data['autoSavePath']);
}
}
@@ -236,27 +234,23 @@ class ApiContentControllersListTest extends KernelTestBase {
* @covers ::list
*/
public function testBasicList(): void {
- // Call the API directly and verify the response.
$response = $this->apiContentController->list('xb_page', Request::create(self::API_BASE_PATH, 'GET'));
- // Validate response format.
self::assertInstanceOf(JsonResponse::class, $response, 'Response should be a JsonResponse');
$content = $response->getContent();
self::assertNotEmpty($content, 'Response content should not be empty');
- // Decode and validate response data.
$data = json_decode($content, TRUE);
self::assertIsArray($data, 'Response data should be an array');
- // Check that all pages are returned.
self::assertCount(count($this->pages), $data, 'Response should contain all test pages');
- // Verify response structure and content for each page.
foreach ($this->pages as $page) {
- $this->assertValidPageData($data, $page);
+ $page_id = (int) $page->id();
+ self::assertArrayHasKey($page_id, $data, "Page {$page_id} should be in the results");
+ $this->assertValidPageData($data[$page_id], $this->getPageData($page));
}
- // Verify complete cache metadata.
$cache_metadata = $response->getCacheableMetadata();
// Expected cache tags should include entity list tag, auto-save tag,
@@ -267,7 +261,6 @@ class ApiContentControllersListTest extends KernelTestBase {
];
$actual_cache_tags = $cache_metadata->getCacheTags();
- // Expected cache contexts for the response
$expected_cache_contexts = [
'url.query_args:search',
'user.permissions',
@@ -285,7 +278,9 @@ class ApiContentControllersListTest extends KernelTestBase {
public function testListWithSearch(): void {
$data = $this->executeListRequest(['search' => 'UniqueSearchTerm']);
self::assertCount(1, $data, 'Search should return exactly one result');
- $this->assertValidPageData($data, $this->pages['searchable']);
+ $page_id = (int) $this->pages['searchable']->id();
+ self::assertArrayHasKey($page_id, $data, "Searchable page should be in the results");
+ $this->assertValidPageData($data[$page_id], $this->getPageData($this->pages['searchable']));
$data = $this->executeListRequest(['search' => 'XB Page']);
self::assertGreaterThan(1, count($data), 'Search should return multiple results');
@@ -298,44 +293,20 @@ class ApiContentControllersListTest extends KernelTestBase {
$data = $this->executeListRequest(['search' => 'Gábor']);
self::assertCount(1, $data, 'Search with accented character should match page');
- $this->assertValidPageData($data, $this->pages['accented']);
+ $page_id = (int) $this->pages['accented']->id();
+ self::assertArrayHasKey($page_id, $data, "Accented page should be in the results");
+ $this->assertValidPageData($data[$page_id], $this->getPageData($this->pages['accented']));
$data = $this->executeListRequest(['search' => 'gabor']);
self::assertCount(1, $data, 'Search without accent should match page with accented character');
- $this->assertValidPageData($data, $this->pages['accented']);
+ $page_id = (int) $this->pages['accented']->id();
+ self::assertArrayHasKey($page_id, $data, "Accented page should be in the results");
+ $this->assertValidPageData($data[$page_id], $this->getPageData($this->pages['accented']));
$data = $this->executeListRequest(['search' => 'puBliSHed']);
self::assertCount(2, $data, 'Search with mixed case should match published and unpublished page');
}
- /**
- * Tests list method handles access control correctly.
- *
- * @covers ::list
- */
- public function testListWithAccessControl(): void {
- // Create a page owned by another user that current user cannot access.
- /** @var \Drupal\user\UserInterface $other_user */
- $other_user = $this->createUser(['access content']);
- $restricted_page = Page::create([
- 'title' => 'Restricted Access Page',
- 'status' => FALSE,
- 'uid' => $other_user->id(),
- ]);
- $restricted_page->save();
-
- // Request the list.
- $data = $this->executeListRequest();
-
- // The restricted page should be included in the results.
- $page_id = (int) $restricted_page->id();
- self::assertArrayHasKey($page_id, $data, 'Page with restricted access should be included in the list');
-
- // Verify that the API lists all content regardless of access restrictions.
- self::assertCount(count($this->pages) + 1, $data,
- 'Response should contain all pages regardless of access restrictions');
- }
-
/**
* Tests search when no searchable content entities (currently only pages) exist yet.
*
@@ -348,7 +319,34 @@ class ApiContentControllersListTest extends KernelTestBase {
$this->pages = [];
$data = $this->executeListRequest();
- self::assertSame([], $data);
+ self::assertSame([], $data, 'Search should return empty array when no entities exist');
+
+ // Now create a temporary page with auto-save data and then delete it
+ // to test interaction with orphaned auto-save data
+ $temp_page = Page::create([
+ 'title' => "Temporary Page for AutoSave",
+ 'status' => TRUE,
+ ]);
+ $temp_page->save();
+
+ $this->createAutoSaveData($temp_page, "AutoSave Only Content", "/autosave-only");
+
+ // Verify auto-save data was created by checking that it would be found if entity existed
+ $temp_page_id = (int) $temp_page->id();
+ $data = $this->executeListRequest(['search' => 'AutoSave Only Content']);
+ self::assertCount(1, $data, 'Auto-save data should be found when entity exists');
+ self::assertArrayHasKey($temp_page_id, $data, 'Page with auto-save data should be in results');
+
+ // Now delete the page, leaving orphaned auto-save data
+ $temp_page->delete();
+
+ // Test search with no entities but orphaned auto-save data should return empty
+ $data = $this->executeListRequest(['search' => 'AutoSave Only Content']);
+ self::assertSame([], $data, 'Search should return empty results when auto-save data exists but no entities exist');
+
+ // Test search with general term should also return empty
+ $data = $this->executeListRequest(['search' => 'Temporary']);
+ self::assertSame([], $data, 'Search should return empty results when searching for deleted entity content');
}
/**
@@ -367,7 +365,6 @@ class ApiContentControllersListTest extends KernelTestBase {
$page_ids = [];
- // Create the pages in sequence
foreach ($pages_data as $key => $title) {
$page = Page::create([
'title' => $title,
@@ -409,7 +406,6 @@ class ApiContentControllersListTest extends KernelTestBase {
* @covers ::filterAndMergeIds
*/
public function testSearchWithAutoSave(): void {
- // Create a page with basic title
$page = Page::create([
'title' => "Original Title Page",
'status' => TRUE,
@@ -417,7 +413,6 @@ class ApiContentControllersListTest extends KernelTestBase {
]);
$page->save();
- // Create auto-save data with a searchable term
$this->createAutoSaveData($page, "AutoSave SearchTerm Title", "/autosave-path");
$data = $this->executeListRequest(['search' => 'AutoSave SearchTerm']);
self::assertCount(5, $data, 'Search should find the page with matching auto-save data');
@@ -437,4 +432,22 @@ class ApiContentControllersListTest extends KernelTestBase {
self::assertCount(1, $data, 'Search should find original title when auto-save exists');
}
+ /**
+ * Extracts essential data from a Page entity for test assertions.
+ *
+ * @param \Drupal\experience_builder\Entity\Page $page
+ * The Page entity to extract data from.
+ *
+ * @return array
+ * An array containing the page's ID, title, status, and path.
+ */
+ private function getPageData(Page $page) {
+ return [
+ 'id' => (int) $page->id(),
+ 'title' => $page->label(),
+ 'status' => $page->isPublished(),
+ 'path' => $page->toUrl()->toString(),
+ ];
+ }
+
}
--
GitLab
From 5e5b9f1543b137d0281d0e4614b7ab3ed39634ce Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Mon, 23 Jun 2025 16:22:27 +0530
Subject: [PATCH 22/56] remove unused variables.
---
src/Controller/ApiContentControllers.php | 37 +++++++++++-------------
1 file changed, 17 insertions(+), 20 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index eed0ed88b0..af3d130a6e 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -128,24 +128,23 @@ final class ApiContentControllers {
$query_cacheability = $this->createInitialCacheability($storage);
$url_cacheability = new CacheableMetadata();
- // Create entity query with access check
+ // Create an entity query with access check
/** @var \Drupal\Core\Entity\ContentEntityTypeInterface $field_definition */
$field_definition = $this->entityTypeManager->getDefinition($entity_type);
$revision_created_field_name = $field_definition->getRevisionMetadataKey('revision_created');
$entity_query = $storage->getQuery()->accessCheck(TRUE);
- // Only apply sorting and range limiting when not searching
- $is_search = $request->query->has('search');
- if (!$is_search) {
+ // Prepare search term and determine if we're performing a search
+ $search = $this->prepareSearchTerm($request, $langcode);
+ $matching_ids = $matching_unsaved_ids = [];
+
+ if ($search === '') {
+ // Only apply sorting and range limiting when not searching
$entity_query->sort((string) $revision_created_field_name, direction: 'DESC')
->range(0, self::MAX_SEARCH_RESULTS);
}
-
- // Handle search functionality if search parameter is present
- $matching_ids = [];
- $matching_unsaved_ids = [];
- if ($request->query->has('search')) {
- $search = $this->prepareSearchTerm($request, $langcode);
+ else {
+ // Handle search functionality when search term is not empty
$label_key = $storage->getEntityType()->getKey('label');
// @todo Remove this in https://www.drupal.org/project/experience_builder/issues/3498525.
@@ -153,17 +152,15 @@ final class ApiContentControllers {
throw new \LogicException('Unhandled.');
}
- if (!empty($search)) {
- // Get matching entity IDs through selection handler
- $matching_ids = $this->getMatchingEntityIds($entity_type, $search);
+ // Get matching entity IDs through selection handler
+ $matching_ids = $this->getMatchingEntityIds($entity_type, $search);
- // Find matching unsaved entities
- $matching_unsaved_ids = $this->getMatchingUnsavedIds($search, $langcode);
+ // Find matching unsaved entities
+ $matching_unsaved_ids = $this->getMatchingUnsavedIds($search, $langcode);
- // Return empty response if no matches found
- if (empty($matching_ids) && empty($matching_unsaved_ids)) {
- return $this->createEmptyResponse($query_cacheability);
- }
+ // Return empty response if no matches found
+ if (empty($matching_ids) && empty($matching_unsaved_ids)) {
+ return $this->createEmptyResponse($query_cacheability);
}
}
@@ -247,7 +244,7 @@ final class ApiContentControllers {
self::MAX_SEARCH_RESULTS
);
- return !empty($matching_data[$entity_type]) ? array_keys($matching_data[$entity_type]) : [];
+ return isset($matching_data[$entity_type]) ? array_keys($matching_data[$entity_type]) : [];
}
/**
--
GitLab
From 1cc542d9d65015ca2a8f5cbc18aa7b29dbbbc640 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Tue, 24 Jun 2025 16:10:29 +0530
Subject: [PATCH 23/56] minor code refactoring.
---
src/Controller/ApiContentControllers.php | 40 +++++++------------
.../ApiContentControllersListTest.php | 4 +-
2 files changed, 16 insertions(+), 28 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index af3d130a6e..4d12b43ff6 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -136,7 +136,7 @@ final class ApiContentControllers {
// Prepare search term and determine if we're performing a search
$search = $this->prepareSearchTerm($request, $langcode);
- $matching_ids = $matching_unsaved_ids = [];
+ $search_ids = [];
if ($search === '') {
// Only apply sorting and range limiting when not searching
@@ -158,6 +158,8 @@ final class ApiContentControllers {
// Find matching unsaved entities
$matching_unsaved_ids = $this->getMatchingUnsavedIds($search, $langcode);
+ $search_ids = $this->filterAndMergeIds($matching_ids, $matching_unsaved_ids);
+
// Return empty response if no matches found
if (empty($matching_ids) && empty($matching_unsaved_ids)) {
return $this->createEmptyResponse($query_cacheability);
@@ -165,8 +167,7 @@ final class ApiContentControllers {
}
// Get entity IDs and filter by search results if needed.
- $ids = $this->executeQueryInRenderContext($entity_query, $query_cacheability);
- $ids = $this->filterAndMergeIds($ids, $matching_ids, $matching_unsaved_ids);
+ $ids = !empty($search_ids) ? $search_ids : $this->executeQueryInRenderContext($entity_query, $query_cacheability);
// Load entities and prepare content list.
/** @var \Drupal\Core\Entity\EntityPublishedInterface[] $content_entities */
@@ -263,10 +264,11 @@ final class ApiContentControllers {
$unsaved_entries = $this->autoSaveManager->getAllAutoSaveList();
foreach ($unsaved_entries as $entry) {
- $label = $this->transliteration->transliterate(mb_strtolower($entry['label']), $langcode);
- if (isset($label) && isset($entry['entity_id']) &&
- str_contains(mb_strtolower($label), $search)) {
- $matching_unsaved_ids[] = $entry['entity_id'];
+ if (\array_key_exists('label', $entry)) {
+ $label = $this->transliteration->transliterate(mb_strtolower($entry['label']), $langcode);
+ if (isset($entry['entity_id']) && str_contains(mb_strtolower($label), $search)) {
+ $matching_unsaved_ids[] = $entry['entity_id'];
+ }
}
}
@@ -292,8 +294,6 @@ final class ApiContentControllers {
/**
* Filters and merges entity IDs based on search results.
*
- * @param array $ids
- * The array of entity IDs from the database query.
* @param array $matching_ids
* The array of entity IDs that match the search term.
* @param array $matching_unsaved_ids
@@ -302,23 +302,11 @@ final class ApiContentControllers {
* @return array
* The filtered and merged array of entity IDs.
*/
- private function filterAndMergeIds(array $ids, array $matching_ids, array $matching_unsaved_ids): array {
- // If there are matching entities from search, filter the results
- if (!empty($matching_ids)) {
- $ids = array_intersect($ids, $matching_ids);
- }
-
- // Merge with matching unsaved IDs, ensuring uniqueness
- if (!empty($matching_unsaved_ids)) {
- $ids = array_unique(array_merge($ids, $matching_unsaved_ids));
- }
-
- // Apply the limit to search results
- if (!empty($matching_ids) || !empty($matching_unsaved_ids)) {
- // Sort by newest first (keys will be numeric IDs) and limit to max results
- arsort($ids);
- $ids = array_slice($ids, 0, self::MAX_SEARCH_RESULTS, TRUE);
- }
+ private function filterAndMergeIds(array $matching_ids, array $matching_unsaved_ids): array {
+ // Sort by newest first (keys will be numeric IDs) and limit to max results
+ $ids = array_unique(array_merge($matching_ids, $matching_unsaved_ids));
+ arsort($ids);
+ $ids = array_slice($ids, 0, self::MAX_SEARCH_RESULTS, TRUE);
return $ids;
}
diff --git a/tests/src/Kernel/Controller/ApiContentControllersListTest.php b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
index b6b43825bf..fad9d7bd3c 100644
--- a/tests/src/Kernel/Controller/ApiContentControllersListTest.php
+++ b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
@@ -415,7 +415,7 @@ class ApiContentControllersListTest extends KernelTestBase {
$this->createAutoSaveData($page, "AutoSave SearchTerm Title", "/autosave-path");
$data = $this->executeListRequest(['search' => 'AutoSave SearchTerm']);
- self::assertCount(5, $data, 'Search should find the page with matching auto-save data');
+ self::assertCount(1, $data, 'Search should find the page with matching auto-save data');
// Verify that both original and auto-save data are correctly included
$page_id = (int) $page->id();
@@ -426,7 +426,7 @@ class ApiContentControllersListTest extends KernelTestBase {
self::assertSame("/autosave-path", $data[$page_id]['autoSavePath']);
$data = $this->executeListRequest(['search' => 'autosave searchterm']);
- self::assertCount(5, $data, 'Search should be case-insensitive for auto-save data');
+ self::assertCount(1, $data, 'Search should be case-insensitive for auto-save data');
$data = $this->executeListRequest(['search' => 'Original Title']);
self::assertCount(1, $data, 'Search should find original title when auto-save exists');
--
GitLab
From c3f7688ede154326f6e186d01588b21dd819847f Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Thu, 26 Jun 2025 11:32:45 +0530
Subject: [PATCH 24/56] minor nits.
---
src/Controller/ApiContentControllers.php | 32 +++++++++++-------------
1 file changed, 14 insertions(+), 18 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 594369e4e2..3fae7f0403 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -124,7 +124,6 @@ final class ApiContentControllers {
// Setup cacheability metadata
$query_cacheability = $this->createInitialCacheability($storage);
- $url_cacheability = new CacheableMetadata();
// Create an entity query with access check
/** @var \Drupal\Core\Entity\ContentEntityTypeInterface $field_definition */
@@ -156,12 +155,11 @@ final class ApiContentControllers {
// Find matching unsaved entities
$matching_unsaved_ids = $this->getMatchingUnsavedIds($search, $langcode);
- $search_ids = $this->filterAndMergeIds($matching_ids, $matching_unsaved_ids);
-
// Return empty response if no matches found
if (empty($matching_ids) && empty($matching_unsaved_ids)) {
return $this->createEmptyResponse($query_cacheability);
}
+ $search_ids = $this->filterAndMergeIds($matching_ids, $matching_unsaved_ids);
}
// Get entity IDs and filter by search results if needed.
@@ -174,18 +172,14 @@ final class ApiContentControllers {
foreach ($content_entities as $content_entity) {
$id = (int) $content_entity->id();
- $entity_data = $this->prepareEntityData($content_entity, $url_cacheability, $id);
- $content_list[$id] = $entity_data[$id];
+ $content_list[$id] = $this->prepareEntityData($content_entity, $query_cacheability, $id);
}
$json_response = new CacheableJsonResponse($content_list);
$this->addSearchCacheability($query_cacheability);
// @todo add cache contexts for query params when introducing pagination in https://www.drupal.org/i/3502691.
- $json_response->addCacheableDependency($query_cacheability)
- ->addCacheableDependency($url_cacheability);
- if (isset($autoSaveData)) {
- $json_response->addCacheableDependency($autoSaveData);
- }
+ $json_response->addCacheableDependency($query_cacheability);
+
return $json_response;
}
@@ -217,7 +211,11 @@ final class ApiContentControllers {
$autoSavePath = $autoSaveEntity->get('path')->first()?->getValue()['alias'] ?? \sprintf('/%s', \ltrim($autoSaveEntity->toUrl()->getInternalPath(), '/'));
}
- $content_list[$id] = [
+ $url_cacheability->addCacheableDependency($generated_url)
+ ->addCacheableDependency($linkCollection)
+ ->addCacheableDependency($autoSaveData);
+
+ return [
'id' => $id,
'title' => $content_entity->label(),
'status' => $content_entity->isPublished(),
@@ -227,11 +225,6 @@ final class ApiContentControllers {
// @see https://jsonapi.org/format/#document-links
'links' => $linkCollection->asArray(),
];
- $url_cacheability->addCacheableDependency($generated_url)
- ->addCacheableDependency($linkCollection)
- ->addCacheableDependency($autoSaveData);
-
- return $content_list;
}
/**
@@ -261,8 +254,11 @@ final class ApiContentControllers {
* The normalized search term.
*/
private function prepareSearchTerm(Request $request, string $langcode): string {
- $search = trim((string) $request->query->get('search'));
- return $this->transliteration->transliterate(mb_strtolower($search), $langcode);
+ if ($request->query->has('search')) {
+ $search = trim((string)$request->query->get('search'));
+ return $this->transliteration->transliterate(mb_strtolower($search), $langcode);
+ }
+ return '';
}
/**
--
GitLab
From eb7357236583136217bf5ef82718e6343618f244 Mon Sep 17 00:00:00 2001
From: Lee Rowlands <lee.rowlands@previousnext.com.au>
Date: Thu, 26 Jun 2025 16:24:28 +1000
Subject: [PATCH 25/56] Allow auto-save manager to return loaded entities from
::getAllAutoSaveList
---
src/AutoSave/AutoSaveManager.php | 7 ++++---
src/Controller/ApiAutoSaveController.php | 11 +++++------
src/Controller/ApiContentControllers.php | 21 ++++++++++-----------
3 files changed, 19 insertions(+), 20 deletions(-)
diff --git a/src/AutoSave/AutoSaveManager.php b/src/AutoSave/AutoSaveManager.php
index b4c54825c6..136731cb4c 100644
--- a/src/AutoSave/AutoSaveManager.php
+++ b/src/AutoSave/AutoSaveManager.php
@@ -175,16 +175,17 @@ class AutoSaveManager implements EventSubscriberInterface {
/**
* Gets all auto-save data.
*
- * @return array<string, array{data: array, owner: int, updated: int, entity_type: string, entity_id: string|int, label: string, langcode: ?string}>
+ * @return array<string, array{data: array, owner: int, updated: int, entity_type: string, entity_id: string|int, label: string, langcode: ?string, entity: ?EntityInterface}>
* All auto-save data entries.
*/
- public function getAllAutoSaveList(): array {
- return \array_map(static fn (object $entry) => $entry->data +
+ public function getAllAutoSaveList(bool $with_entities = FALSE): array {
+ return \array_map(fn (object $entry) => $entry->data +
// Append the owner and updated data into each entry.
[
// Remove the unique session key for anonymous users.
'owner' => \is_numeric($entry->owner) ? (int) $entry->owner : 0,
'updated' => $entry->updated,
+ 'entity' => $with_entities ? $this->entityTypeManager->getStorage($entry->data['entity_type'])->create($entry->data['data']) : NULL,
], $this->getTempStore()->getAll());
}
diff --git a/src/Controller/ApiAutoSaveController.php b/src/Controller/ApiAutoSaveController.php
index 95519bf5a1..7ca044f729 100644
--- a/src/Controller/ApiAutoSaveController.php
+++ b/src/Controller/ApiAutoSaveController.php
@@ -108,9 +108,9 @@ final class ApiAutoSaveController extends ApiControllerBase {
// User display names depend on configuration.
$cache->addCacheableDependency($this->configFactory->get('user.settings'));
- // Remove 'data' key because this will reduce the amount of data sent to the
- // client and back to the server.
- $all = \array_map(fn(array $item) => \array_diff_key($item, ['data' => '']), $all);
+ // Remove 'data' and 'entity' key because this will reduce the amount of
+ // data sent to the client and back to the server.
+ $all = \array_map(fn(array $item) => \array_diff_key($item, \array_flip(['data', 'entity'])), $all);
$withUserDetails = \array_map(fn(array $item) => [
// @phpstan-ignore-next-line
@@ -135,7 +135,7 @@ final class ApiAutoSaveController extends ApiControllerBase {
public function post(Request $request): JsonResponse {
$client_auto_saves = \json_decode($request->getContent(), TRUE);
\assert(\is_array($client_auto_saves));
- $all_auto_saves = $this->autoSaveManager->getAllAutoSaveList();
+ $all_auto_saves = $this->autoSaveManager->getAllAutoSaveList(TRUE);
if ($validation_response = self::validateExpectedAutoSaves($client_auto_saves, $all_auto_saves)) {
return $validation_response;
}
@@ -156,8 +156,7 @@ final class ApiAutoSaveController extends ApiControllerBase {
$access_error_labels = [];
$access_error_cache = new CacheableMetadata();
$loadedEntities = [];
- foreach ($publish_auto_saves as $autoSaveKey => $auto_save) {
- $entity = $this->entityTypeManager->getStorage($auto_save['entity_type'])->create($auto_save['data']);
+ foreach ($publish_auto_saves as $autoSaveKey => ['entity' => $entity]) {
assert($entity instanceof EntityInterface);
$loadedEntities[$autoSaveKey] = $entity;
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 3fae7f0403..95a744d1a3 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -153,7 +153,7 @@ final class ApiContentControllers {
$matching_ids = $this->getMatchingEntityIds($entity_type, $search);
// Find matching unsaved entities
- $matching_unsaved_ids = $this->getMatchingUnsavedIds($search, $langcode);
+ $matching_unsaved_ids = $this->getMatchingUnsavedIds($search, $langcode, $entity_type);
// Return empty response if no matches found
if (empty($matching_ids) && empty($matching_unsaved_ids)) {
@@ -255,7 +255,7 @@ final class ApiContentControllers {
*/
private function prepareSearchTerm(Request $request, string $langcode): string {
if ($request->query->has('search')) {
- $search = trim((string)$request->query->get('search'));
+ $search = trim((string) $request->query->get('search'));
return $this->transliteration->transliterate(mb_strtolower($search), $langcode);
}
return '';
@@ -300,16 +300,15 @@ final class ApiContentControllers {
* @return array
* An array of entity IDs that match the search criteria.
*/
- private function getMatchingUnsavedIds(string $search, string $langcode): array {
+ private function getMatchingUnsavedIds(string $search, string $langcode, string $entity_type_id): array {
$matching_unsaved_ids = [];
- $unsaved_entries = $this->autoSaveManager->getAllAutoSaveList();
-
- foreach ($unsaved_entries as $entry) {
- if (\array_key_exists('label', $entry)) {
- $label = $this->transliteration->transliterate(mb_strtolower($entry['label']), $langcode);
- if (isset($entry['entity_id']) && str_contains(mb_strtolower($label), $search)) {
- $matching_unsaved_ids[] = $entry['entity_id'];
- }
+ $unsaved_entries = \array_filter($this->autoSaveManager->getAllAutoSaveList(TRUE), static fn (array $entry): bool => $entry['entity_type'] === $entity_type_id);
+
+ foreach ($unsaved_entries as ['entity' => $entity]) {
+ \assert($entity instanceof EntityInterface);
+ $label = $this->transliteration->transliterate(mb_strtolower((string) $entity->label()), $langcode);
+ if (str_contains(mb_strtolower($label), $search)) {
+ $matching_unsaved_ids[] = $entity->id();
}
}
--
GitLab
From 4faf09d6b04a7c19f146de2b068c72476e43df28 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Thu, 26 Jun 2025 12:09:05 +0530
Subject: [PATCH 26/56] test fixes.
---
tests/src/Kernel/Controller/ApiContentControllersListTest.php | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/tests/src/Kernel/Controller/ApiContentControllersListTest.php b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
index 91296c7635..e33bf71a27 100644
--- a/tests/src/Kernel/Controller/ApiContentControllersListTest.php
+++ b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
@@ -249,8 +249,8 @@ class ApiContentControllersListTest extends KernelTestBase {
$actual_cache_tags = $cache_metadata->getCacheTags();
$expected_cache_contexts = [
- 'url.query_args:search',
'user.permissions',
+ 'url.query_args:search',
];
$actual_cache_contexts = $cache_metadata->getCacheContexts();
self::assertEquals($expected_cache_tags, $actual_cache_tags, 'All expected cache tags should be present');
--
GitLab
From 2541a894d404b80e4eb89254aa8e356222b0b75f Mon Sep 17 00:00:00 2001
From: Wim Leers <44946-wimleers@users.noreply.drupalcode.org>
Date: Thu, 26 Jun 2025 13:22:21 +0000
Subject: [PATCH 27/56] `static` nits.
---
src/Controller/ApiContentControllers.php | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 95a744d1a3..4335e046bc 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -324,7 +324,7 @@ final class ApiContentControllers {
* @return \Drupal\Core\Cache\CacheableJsonResponse
* An empty JSON response with cacheability metadata attached.
*/
- private function createEmptyResponse(CacheableMetadata $query_cacheability): CacheableJsonResponse {
+ private static function createEmptyResponse(CacheableMetadata $query_cacheability): CacheableJsonResponse {
$json_response = new CacheableJsonResponse([]);
$this->addSearchCacheability($query_cacheability);
$json_response->addCacheableDependency($query_cacheability);
@@ -342,7 +342,7 @@ final class ApiContentControllers {
* @return array
* The filtered and merged array of entity IDs.
*/
- private function filterAndMergeIds(array $matching_ids, array $matching_unsaved_ids): array {
+ private static function filterAndMergeIds(array $matching_ids, array $matching_unsaved_ids): array {
// Sort by newest first (keys will be numeric IDs) and limit to max results
$ids = array_unique(array_merge($matching_ids, $matching_unsaved_ids));
arsort($ids);
@@ -423,7 +423,7 @@ final class ApiContentControllers {
* @param \Drupal\Core\Cache\CacheableMetadata $query_cacheability
* The cacheability metadata object to add contexts and tags to.
*/
- private function addSearchCacheability(CacheableMetadata $query_cacheability): void {
+ private static function addSearchCacheability(CacheableMetadata $query_cacheability): void {
$query_cacheability->addCacheContexts(['url.query_args:search']);
$query_cacheability->addCacheTags([AutoSaveManager::CACHE_TAG]);
}
--
GitLab
From e45a11b1b544d11278027de557cb3a32a0c2ce42 Mon Sep 17 00:00:00 2001
From: Wim Leers <44946-wimleers@users.noreply.drupalcode.org>
Date: Thu, 26 Jun 2025 13:23:01 +0000
Subject: [PATCH 28/56] Minimize information in `*.services.yml`.
---
experience_builder.services.yml | 4 +---
src/Controller/ApiContentControllers.php | 1 +
2 files changed, 2 insertions(+), 3 deletions(-)
diff --git a/experience_builder.services.yml b/experience_builder.services.yml
index a708ee59c2..e53ca7831e 100644
--- a/experience_builder.services.yml
+++ b/experience_builder.services.yml
@@ -127,9 +127,7 @@ services:
Drupal\experience_builder\Controller\ApiLayoutController: {}
Drupal\experience_builder\Controller\ApiLogController: {}
Drupal\experience_builder\Controller\ApiContentUpdateForDemoController: {}
- Drupal\experience_builder\Controller\ApiContentControllers:
- arguments:
- $transliteration: '@transliteration'
+ Drupal\experience_builder\Controller\ApiContentControllers: {}
Drupal\experience_builder\Controller\ComponentStatusController: {}
Drupal\experience_builder\Controller\ComponentAuditController: {}
Drupal\experience_builder\Controller\ExperienceBuilderController: {}
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 4335e046bc..05b9003432 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -53,6 +53,7 @@ final class ApiContentControllers {
private readonly SelectionPluginManagerInterface $selectionManager,
private readonly RouteProviderInterface $routeProvider,
private readonly LanguageManagerInterface $languageManager,
+ #[Autowire(service: 'transliteration')]
private readonly TransliterationInterface $transliteration,
) {}
--
GitLab
From d6f0001cd49440e631cddf63b99a4117b31af46e Mon Sep 17 00:00:00 2001
From: Wim Leers <44946-wimleers@users.noreply.drupalcode.org>
Date: Thu, 26 Jun 2025 13:48:54 +0000
Subject: [PATCH 29/56] Point to the future generalization at #3498525 from
more places, to make that future generalization work simpler.
---
tests/src/Functional/XbContentEntityHttpApiTest.php | 2 +-
tests/src/Kernel/Controller/ApiContentControllersListTest.php | 2 ++
ui/src/components/pageInfo/PageInfo.tsx | 1 +
3 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/tests/src/Functional/XbContentEntityHttpApiTest.php b/tests/src/Functional/XbContentEntityHttpApiTest.php
index d83359c504..56821174db 100644
--- a/tests/src/Functional/XbContentEntityHttpApiTest.php
+++ b/tests/src/Functional/XbContentEntityHttpApiTest.php
@@ -150,7 +150,7 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
'autoSaveLabel' => NULL,
'autoSavePath' => NULL,
'links' => [
- // @todo https://www.drupal.org/i/3498525 should standardize arguments.
+ // @todo https://www.drupal.org/i/3498525 should remove the hardcoded `xb_page` from these.
XbUriDefinitions::LINK_REL_EDIT => Url::fromUri('base:/xb/xb_page/1')->toString(),
XbUriDefinitions::LINK_REL_DUPLICATE => Url::fromUri('base:/xb/api/v0/content/xb_page')->toString(),
],
diff --git a/tests/src/Kernel/Controller/ApiContentControllersListTest.php b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
index e33bf71a27..cc2586cbf1 100644
--- a/tests/src/Kernel/Controller/ApiContentControllersListTest.php
+++ b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
@@ -28,6 +28,8 @@ class ApiContentControllersListTest extends KernelTestBase {
/**
* Base path for the content API endpoint.
+ *
+ * @todo Strip `xb_page` in https://www.drupal.org/i/3498525, and add test coverage for other content entity types.
*/
private const API_BASE_PATH = '/api/xb/content/xb_page';
diff --git a/ui/src/components/pageInfo/PageInfo.tsx b/ui/src/components/pageInfo/PageInfo.tsx
index b9c24bfd41..9bf9aaea0f 100644
--- a/ui/src/components/pageInfo/PageInfo.tsx
+++ b/ui/src/components/pageInfo/PageInfo.tsx
@@ -76,6 +76,7 @@ const PageInfo = () => {
isLoading: isPageItemsLoading,
error: pageItemsError,
} = useGetContentListQuery({
+ // @todo Generalize in https://www.drupal.org/i/3498525
entityType: 'xb_page',
search: searchTerm,
});
--
GitLab
From 37f7983efcc3dc968c8c6f0271796302b44962a5 Mon Sep 17 00:00:00 2001
From: Wim Leers <wim.leers@acquia.com>
Date: Thu, 26 Jun 2025 15:51:44 +0200
Subject: [PATCH 30/56] =?UTF-8?q?Fix=20two=20bits=20I=20missed=20in=20the?=
=?UTF-8?q?=20suggestions=20for=202541a894d404b80e4eb89254aa8e356222b0b75f?=
=?UTF-8?q?=20+=20e45a11b1b544d11278027de557cb3a32a0c2ce42=20=F0=9F=98=85?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
src/Controller/ApiContentControllers.php | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 05b9003432..6501fe4d60 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -27,6 +27,7 @@ use Drupal\experience_builder\Resource\XbResourceLink;
use Drupal\experience_builder\Resource\XbResourceLinkCollection;
use Drupal\experience_builder\XbUriDefinitions;
use http\Exception\InvalidArgumentException;
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
@@ -327,7 +328,7 @@ final class ApiContentControllers {
*/
private static function createEmptyResponse(CacheableMetadata $query_cacheability): CacheableJsonResponse {
$json_response = new CacheableJsonResponse([]);
- $this->addSearchCacheability($query_cacheability);
+ self::addSearchCacheability($query_cacheability);
$json_response->addCacheableDependency($query_cacheability);
return $json_response;
}
--
GitLab
From 7cf3b3201ccebccd9221e2e6ce2f319f63167187 Mon Sep 17 00:00:00 2001
From: Lee Rowlands <lee.rowlands@previousnext.com.au>
Date: Fri, 27 Jun 2025 08:13:22 +1000
Subject: [PATCH 31/56] Issue #3529622: Fixes on pgsql/mysql
(cherry picked from commit 1296d88b189e19e2aeac62c6fea8fffb0ff77871)
---
src/AutoSave/AutoSaveManager.php | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/src/AutoSave/AutoSaveManager.php b/src/AutoSave/AutoSaveManager.php
index 136731cb4c..01695da0a3 100644
--- a/src/AutoSave/AutoSaveManager.php
+++ b/src/AutoSave/AutoSaveManager.php
@@ -20,6 +20,7 @@ use Drupal\Core\TypedData\TypedDataInterface;
use Drupal\experience_builder\AutoSaveEntity;
use Drupal\experience_builder\Controller\ApiContentControllers;
use Drupal\experience_builder\Entity\XbHttpApiEligibleConfigEntityInterface;
+use Drupal\experience_builder\Plugin\Field\FieldType\ComponentTreeItem;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Validator\ConstraintViolationList;
use Symfony\Component\Validator\ConstraintViolationListInterface;
@@ -66,6 +67,16 @@ class AutoSaveManager implements EventSubscriberInterface {
$data = self::normalizeEntity($entity);
$data_hash = self::generateHash($data);
$original_hash = $this->getUnchangedHash($entity);
+ // 💡 If you are debugging why an entry is being created, but you didn't
+ // expect one to be, the code below can be evaluated in a debugger and will
+ // show you which field varies.
+ // @code
+ // $original = self::normalizeEntity($this->entityTypeManager->getStorage($entity->getEntityTypeId())->loadUnchanged($entity->id()))
+ // $data_hash = \array_map(self::generateHash(...), $data)
+ // $original_hash = \array_map(self::generateHash(...), $original)
+ // \array_diff($data_hash, $original_hash)
+ // \array_diff($original_hash, $data_hash)
+ // @endcode
if ($original_hash !== NULL && \hash_equals($original_hash, $data_hash)) {
// We've reset back to the original values. Clear the auto-save entry but
// keep the hash.
@@ -126,6 +137,10 @@ class AutoSaveManager implements EventSubscriberInterface {
}
$normalized[$name] = \array_map(
static function (FieldItemInterface $item): array {
+ if ($item instanceof ComponentTreeItem) {
+ // Trigger post-save so that component inputs can be optimized.
+ $item->preSave();
+ }
$value = $item->toArray();
foreach (\array_filter($item->getProperties(), static fn (TypedDataInterface $property) => $property instanceof PrimitiveInterface) as $property) {
\assert($property instanceof PrimitiveInterface);
--
GitLab
From 240306034375d6cb59584d0d0749c3b76833e33e Mon Sep 17 00:00:00 2001
From: Lee Rowlands <lee.rowlands@previousnext.com.au>
Date: Fri, 27 Jun 2025 08:26:05 +1000
Subject: [PATCH 32/56] =?UTF-8?q?Linty=20fresh=20=F0=9F=8C=B1?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
tests/src/Kernel/Controller/ApiContentControllersListTest.php | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/tests/src/Kernel/Controller/ApiContentControllersListTest.php b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
index cc2586cbf1..2ae183c2d3 100644
--- a/tests/src/Kernel/Controller/ApiContentControllersListTest.php
+++ b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
@@ -28,7 +28,7 @@ class ApiContentControllersListTest extends KernelTestBase {
/**
* Base path for the content API endpoint.
- *
+ *
* @todo Strip `xb_page` in https://www.drupal.org/i/3498525, and add test coverage for other content entity types.
*/
private const API_BASE_PATH = '/api/xb/content/xb_page';
--
GitLab
From 1030c35b7a7e5d509581a63fac6ba2b2ebc35241 Mon Sep 17 00:00:00 2001
From: Lee Rowlands <lee.rowlands@previousnext.com.au>
Date: Fri, 27 Jun 2025 08:54:42 +1000
Subject: [PATCH 33/56] Issue #3529622: Fixes on pgsql/mysql
---
src/AutoSave/AutoSaveManager.php | 5 +++--
.../Field/FieldType/ComponentTreeItem.php | 18 +++++++++++-------
2 files changed, 14 insertions(+), 9 deletions(-)
diff --git a/src/AutoSave/AutoSaveManager.php b/src/AutoSave/AutoSaveManager.php
index 01695da0a3..1f98ec4ee3 100644
--- a/src/AutoSave/AutoSaveManager.php
+++ b/src/AutoSave/AutoSaveManager.php
@@ -138,8 +138,9 @@ class AutoSaveManager implements EventSubscriberInterface {
$normalized[$name] = \array_map(
static function (FieldItemInterface $item): array {
if ($item instanceof ComponentTreeItem) {
- // Trigger post-save so that component inputs can be optimized.
- $item->preSave();
+ // Optimize component inputs to ensure the normalized value is
+ // determinative.
+ $item->optimizeInputs();
}
$value = $item->toArray();
foreach (\array_filter($item->getProperties(), static fn (TypedDataInterface $property) => $property instanceof PrimitiveInterface) as $property) {
diff --git a/src/Plugin/Field/FieldType/ComponentTreeItem.php b/src/Plugin/Field/FieldType/ComponentTreeItem.php
index a809da6a8f..c86f044d20 100644
--- a/src/Plugin/Field/FieldType/ComponentTreeItem.php
+++ b/src/Plugin/Field/FieldType/ComponentTreeItem.php
@@ -591,13 +591,7 @@ class ComponentTreeItem extends FieldItemBase {
if ($input_values === NULL && $source->requiresExplicitInput()) {
throw new \LogicException(sprintf('Missing input for component instance with UUID %s', $component_instance_uuid));
}
-
- // Allow component source plugins to normalize the stored data.
- $inputs = $this->getInputs();
- if ($inputs !== NULL && $source = $this->getComponent()?->getComponentSource()) {
- $inputs = $source->optimizeExplicitInput($inputs);
- $this->setInput($inputs);
- }
+ $this->optimizeInputs();
// @todo Omit defaults that are stored at the content type template level, e.g. in core.entity_view_display.node.article.default.yml
// $template_tree = '@todo';
// $template_inputs = '@todo';
@@ -652,4 +646,14 @@ class ComponentTreeItem extends FieldItemBase {
return $changed;
}
+ public function optimizeInputs(): void {
+ // Allow component source plugins to normalize the stored data.
+ $inputs = $this->getInputs();
+ if ($inputs !== NULL && $source = $this->getComponent()
+ ?->getComponentSource()) {
+ $inputs = $source->optimizeExplicitInput($inputs);
+ $this->setInput($inputs);
+ }
+ }
+
}
--
GitLab
From 49f1fdf04d20f71f94616a91a5d36f17d8af9464 Mon Sep 17 00:00:00 2001
From: Lee Rowlands <lee.rowlands@previousnext.com.au>
Date: Fri, 27 Jun 2025 09:17:50 +1000
Subject: [PATCH 34/56] Fix merge conflict related fails
---
.../Functional/XbContentEntityHttpApiTest.php | 31 ++++++++++++-------
1 file changed, 20 insertions(+), 11 deletions(-)
diff --git a/tests/src/Functional/XbContentEntityHttpApiTest.php b/tests/src/Functional/XbContentEntityHttpApiTest.php
index a6de5673a0..a529cc16db 100644
--- a/tests/src/Functional/XbContentEntityHttpApiTest.php
+++ b/tests/src/Functional/XbContentEntityHttpApiTest.php
@@ -93,7 +93,14 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
$this->drupalLogin($user);
// We have a cache tag for page 2 as it's the homepage, set in system.site
// config.
- $body = $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'config:system.site', 'http_response', 'xb_page:2', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
+ $expected_tags = [
+ AutoSaveManager::CACHE_TAG,
+ 'config:system.site',
+ 'http_response',
+ 'xb_page:2',
+ 'xb_page_list',
+ ];
+ $body = $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], $expected_tags, 'UNCACHEABLE (request policy)', 'MISS');
$no_auto_save_expected_pages = [
// Page 1 has a path alias.
'1' => [
@@ -141,12 +148,14 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
$no_auto_save_expected_pages,
$body
);
- $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'config:system.site', 'http_response', 'xb_page:2'], 'UNCACHEABLE (request policy)', 'HIT');
+ $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], $expected_tags, 'UNCACHEABLE (request policy)', 'HIT');
// Test searching by query parameter
$search_url = Url::fromUri('base:/xb/api/v0/content/xb_page', ['query' => ['search' => 'Page 1']]);
+ // Because page 2 isn't in these results, we don't get its cache tag.
+ $expected_tags_without_page_2 = \array_diff($expected_tags, ['xb_page:2']);
// Confirm that the cache is not hit when a different request is made with query parameter.
- $search_body = $this->assertExpectedResponse('GET', $search_url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
+ $search_body = $this->assertExpectedResponse('GET', $search_url, [], 200, ['url.query_args:search', 'user.permissions'], $expected_tags_without_page_2, 'UNCACHEABLE (request policy)', 'MISS');
$this->assertEquals(
[
'1' => [
@@ -166,11 +175,11 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
$search_body
);
// Confirm that the cache is hit when the same request is made again.
- $this->assertExpectedResponse('GET', $search_url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'HIT');
+ $this->assertExpectedResponse('GET', $search_url, [], 200, ['url.query_args:search', 'user.permissions'], $expected_tags_without_page_2, 'UNCACHEABLE (request policy)', 'HIT');
// Test searching by query parameter - substring match.
$substring_search_url = Url::fromUri('base:/xb/api/v0/content/xb_page', ['query' => ['search' => 'age']]);
- $substring_search_body = $this->assertExpectedResponse('GET', $substring_search_url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'http_response', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
+ $substring_search_body = $this->assertExpectedResponse('GET', $substring_search_url, [], 200, ['url.query_args:search', 'user.permissions'], $expected_tags, 'UNCACHEABLE (request policy)', 'MISS');
$this->assertEquals($no_auto_save_expected_pages, $substring_search_body);
$autoSaveManager = $this->container->get(AutoSaveManager::class);
@@ -186,7 +195,7 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
$page_2->set('path', ['alias' => "/the-new-path"]);
$autoSaveManager->saveEntity($page_2);
- $body = $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'config:system.site', 'http_response', 'xb_page:2', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
+ $body = $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], $expected_tags, 'UNCACHEABLE (request policy)', 'MISS');
$auto_save_expected_pages = $no_auto_save_expected_pages;
$auto_save_expected_pages['1']['autoSaveLabel'] = 'The updated title.';
$auto_save_expected_pages['1']['autoSavePath'] = '/the-updated-path';
@@ -196,7 +205,7 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
$auto_save_expected_pages,
$body
);
- $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'config:system.site', 'http_response', 'xb_page:2', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'HIT');
+ $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], $expected_tags, 'UNCACHEABLE (request policy)', 'HIT');
// Confirm that if path alias is empty, the system path is used, not the
// existing alias if set.
@@ -208,7 +217,7 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
$page_2->set('path', NULL);
$autoSaveManager->saveEntity($page_2);
- $body = $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'config:system.site', 'http_response', 'xb_page:2', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
+ $body = $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], $expected_tags, 'UNCACHEABLE (request policy)', 'MISS');
$auto_save_expected_pages['1']['autoSavePath'] = '/page/1';
$auto_save_expected_pages['2']['autoSavePath'] = '/page/2';
$this->assertEquals(
@@ -218,12 +227,12 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
$autoSaveManager->delete($page_1);
$autoSaveManager->delete($page_2);
- $body = $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'config:system.site', 'http_response', 'xb_page:2', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
+ $body = $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], $expected_tags, 'UNCACHEABLE (request policy)', 'MISS');
$this->assertEquals(
$no_auto_save_expected_pages,
$body
);
- $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'config:system.site', 'http_response', 'xb_page:2', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'HIT');
+ $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], $expected_tags, 'UNCACHEABLE (request policy)', 'HIT');
}
/**
@@ -321,7 +330,7 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
$user = $this->createUser([Page::EDIT_PERMISSION, Page::DELETE_PERMISSION], 'administer_xb_page_user');
assert($user instanceof UserInterface);
$this->drupalLogin($user);
- $body = $this->assertExpectedResponse('GET', $url, [], 200, ['user.permissions'], [AutoSaveManager::CACHE_TAG, 'config:system.site', 'http_response', 'xb_page:2', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
+ $body = $this->assertExpectedResponse('GET', $url, [], 200, ['url.query_args:search', 'user.permissions'], [AutoSaveManager::CACHE_TAG, 'config:system.site', 'http_response', 'xb_page:2', 'xb_page_list'], 'UNCACHEABLE (request policy)', 'MISS');
assert(\is_array($body));
assert(\array_key_exists('2', $body) && \array_key_exists('links', $body['2']));
$this->assertEquals(
--
GitLab
From 1deacc442e3b69012c9465784c52f27689713613 Mon Sep 17 00:00:00 2001
From: Lee Rowlands <lee.rowlands@previousnext.com.au>
Date: Fri, 27 Jun 2025 09:19:53 +1000
Subject: [PATCH 35/56] Issue #3529622: Fixes on pgsql/mysql
---
src/Plugin/Field/FieldType/ComponentTreeItem.php | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/src/Plugin/Field/FieldType/ComponentTreeItem.php b/src/Plugin/Field/FieldType/ComponentTreeItem.php
index c86f044d20..8eb5d74c49 100644
--- a/src/Plugin/Field/FieldType/ComponentTreeItem.php
+++ b/src/Plugin/Field/FieldType/ComponentTreeItem.php
@@ -647,10 +647,16 @@ class ComponentTreeItem extends FieldItemBase {
}
public function optimizeInputs(): void {
+ $source = $this->getComponent()?->getComponentSource();
+ if ($source === NULL) {
+ // This could be running against data that has not been validated, in
+ // which case there is nothing we can do without a valid component or
+ // source.
+ return;
+ }
// Allow component source plugins to normalize the stored data.
$inputs = $this->getInputs();
- if ($inputs !== NULL && $source = $this->getComponent()
- ?->getComponentSource()) {
+ if ($inputs !== NULL) {
$inputs = $source->optimizeExplicitInput($inputs);
$this->setInput($inputs);
}
--
GitLab
From 641db4441793e946d029693814f60107422d8a6c Mon Sep 17 00:00:00 2001
From: Lee Rowlands <lee.rowlands@previousnext.com.au>
Date: Fri, 27 Jun 2025 10:02:14 +1000
Subject: [PATCH 36/56] Fix ApiContentControllersListTest
---
src/Controller/ApiContentControllers.php | 2 +-
.../ApiContentControllersListTest.php | 35 +++++++++----------
2 files changed, 18 insertions(+), 19 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 6501fe4d60..17c51b7f10 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -288,7 +288,7 @@ final class ApiContentControllers {
self::MAX_SEARCH_RESULTS
);
- return isset($matching_data[$entity_type]) ? array_keys($matching_data[$entity_type]) : [];
+ return array_keys($matching_data[$entity_type] ?? []);
}
/**
diff --git a/tests/src/Kernel/Controller/ApiContentControllersListTest.php b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
index 2ae183c2d3..b036bbdf2a 100644
--- a/tests/src/Kernel/Controller/ApiContentControllersListTest.php
+++ b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
@@ -91,12 +91,6 @@ class ApiContentControllersListTest extends KernelTestBase {
protected function setUp(): void {
parent::setUp();
- // Skip the test for PostgreSQL and SQLite databases.
- $database_type = $this->container->get('database')->driver();
- if ($database_type === 'pgsql' || $database_type === 'sqlite') {
- $this->markTestSkipped('This test is only for MySQL/MariaDB database drivers.');
- }
-
$this->installEntitySchema('user');
$this->installEntitySchema('xb_page');
$this->installEntitySchema('path_alias');
@@ -246,6 +240,8 @@ class ApiContentControllersListTest extends KernelTestBase {
// and individual entity tags
$expected_cache_tags = [
'xb_page_list',
+ // Access check on home-page adds this.
+ 'config:system.site',
AutoSaveManager::CACHE_TAG,
];
$actual_cache_tags = $cache_metadata->getCacheTags();
@@ -280,18 +276,21 @@ class ApiContentControllersListTest extends KernelTestBase {
$data = $this->executeListRequest(['search' => 'uniquesearchterm']);
self::assertCount(1, $data, 'Search should be case-insensitive');
- $data = $this->executeListRequest(['search' => 'Gábor']);
- self::assertCount(1, $data, 'Search with accented character should match page');
- $page_id = (int) $this->pages['accented']->id();
- self::assertArrayHasKey($page_id, $data, "Accented page should be in the results");
- $this->assertValidPageData($data[$page_id], $this->getPageData($this->pages['accented']));
-
- $data = $this->executeListRequest(['search' => 'gabor']);
- self::assertCount(1, $data, 'Search without accent should match page with accented character');
- $page_id = (int) $this->pages['accented']->id();
- self::assertArrayHasKey($page_id, $data, "Accented page should be in the results");
- $this->assertValidPageData($data[$page_id], $this->getPageData($this->pages['accented']));
-
+ $database_type = $this->container->get('database')->driver();
+ if ($database_type !== 'pgsql' && $database_type !== 'sqlite') {
+ // LIKE queries that perform transliteration are MYSQL/MariaDB specific.
+ $data = $this->executeListRequest(['search' => 'Gábor']);
+ self::assertCount(1, $data, 'Search with accented character should match page');
+ $page_id = (int) $this->pages['accented']->id();
+ self::assertArrayHasKey($page_id, $data, "Accented page should be in the results");
+ $this->assertValidPageData($data[$page_id], $this->getPageData($this->pages['accented']));
+
+ $data = $this->executeListRequest(['search' => 'gabor']);
+ self::assertCount(1, $data, 'Search without accent should match page with accented character');
+ $page_id = (int) $this->pages['accented']->id();
+ self::assertArrayHasKey($page_id, $data, "Accented page should be in the results");
+ $this->assertValidPageData($data[$page_id], $this->getPageData($this->pages['accented']));
+ }
$data = $this->executeListRequest(['search' => 'puBliSHed']);
self::assertCount(2, $data, 'Search with mixed case should match published and unpublished page');
}
--
GitLab
From 4538227e54a55bff744f6581656ebd4065348516 Mon Sep 17 00:00:00 2001
From: Lee Rowlands <lee.rowlands@previousnext.com.au>
Date: Fri, 27 Jun 2025 10:08:43 +1000
Subject: [PATCH 37/56] Make test even more generic
---
.../ApiContentControllersListTest.php | 27 ++++++++++---------
1 file changed, 14 insertions(+), 13 deletions(-)
diff --git a/tests/src/Kernel/Controller/ApiContentControllersListTest.php b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
index b036bbdf2a..4a6d6365e9 100644
--- a/tests/src/Kernel/Controller/ApiContentControllersListTest.php
+++ b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
@@ -8,6 +8,7 @@ namespace Drupal\Tests\experience_builder\Kernel\Controller;
use Drupal\Component\Transliteration\TransliterationInterface;
use Drupal\Core\Entity\ContentEntityInterface;
+use Drupal\Core\Entity\EntityPublishedInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\experience_builder\AutoSave\AutoSaveManager;
use Drupal\experience_builder\Controller\ApiContentControllers;
@@ -195,7 +196,7 @@ class ApiContentControllersListTest extends KernelTestBase {
* @param array $expected_auto_save_data
* Optional auto-save data to validate.
*/
- protected function assertValidPageData(array $response_data, array $expected_search_result_data, array $expected_auto_save_data = []): void {
+ protected function assertValidResultData(array $response_data, array $expected_search_result_data, array $expected_auto_save_data = []): void {
// Assert that all expected fields are present and correct
foreach ($expected_search_result_data as $key => $expected_value) {
self::assertArrayHasKey($key, $response_data, "Response should contain key: {$key}");
@@ -231,7 +232,7 @@ class ApiContentControllersListTest extends KernelTestBase {
foreach ($this->pages as $page) {
$page_id = (int) $page->id();
self::assertArrayHasKey($page_id, $data, "Page {$page_id} should be in the results");
- $this->assertValidPageData($data[$page_id], $this->getPageData($page));
+ $this->assertValidResultData($data[$page_id], $this->getEntityData($page));
}
$cache_metadata = $response->getCacheableMetadata();
@@ -265,7 +266,7 @@ class ApiContentControllersListTest extends KernelTestBase {
self::assertCount(1, $data, 'Search should return exactly one result');
$page_id = (int) $this->pages['searchable']->id();
self::assertArrayHasKey($page_id, $data, "Searchable page should be in the results");
- $this->assertValidPageData($data[$page_id], $this->getPageData($this->pages['searchable']));
+ $this->assertValidResultData($data[$page_id], $this->getEntityData($this->pages['searchable']));
$data = $this->executeListRequest(['search' => 'XB Page']);
self::assertGreaterThan(1, count($data), 'Search should return multiple results');
@@ -283,13 +284,13 @@ class ApiContentControllersListTest extends KernelTestBase {
self::assertCount(1, $data, 'Search with accented character should match page');
$page_id = (int) $this->pages['accented']->id();
self::assertArrayHasKey($page_id, $data, "Accented page should be in the results");
- $this->assertValidPageData($data[$page_id], $this->getPageData($this->pages['accented']));
+ $this->assertValidResultData($data[$page_id], $this->getEntityData($this->pages['accented']));
$data = $this->executeListRequest(['search' => 'gabor']);
self::assertCount(1, $data, 'Search without accent should match page with accented character');
$page_id = (int) $this->pages['accented']->id();
self::assertArrayHasKey($page_id, $data, "Accented page should be in the results");
- $this->assertValidPageData($data[$page_id], $this->getPageData($this->pages['accented']));
+ $this->assertValidResultData($data[$page_id], $this->getEntityData($this->pages['accented']));
}
$data = $this->executeListRequest(['search' => 'puBliSHed']);
self::assertCount(2, $data, 'Search with mixed case should match published and unpublished page');
@@ -423,18 +424,18 @@ class ApiContentControllersListTest extends KernelTestBase {
/**
* Extracts essential data from a Page entity for test assertions.
*
- * @param \Drupal\experience_builder\Entity\Page $page
- * The Page entity to extract data from.
+ * @param \Drupal\Core\Entity\EntityPublishedInterface $entity
+ * The entity to extract data from.
*
* @return array
- * An array containing the page's ID, title, status, and path.
+ * An array containing the entity's ID, title, status, and path.
*/
- private function getPageData(Page $page) {
+ private function getEntityData(EntityPublishedInterface $entity) {
return [
- 'id' => (int) $page->id(),
- 'title' => $page->label(),
- 'status' => $page->isPublished(),
- 'path' => $page->toUrl()->toString(),
+ 'id' => (int) $entity->id(),
+ 'title' => $entity->label(),
+ 'status' => $entity->isPublished(),
+ 'path' => $entity->toUrl()->toString(),
];
}
--
GitLab
From 117d29ccab362f5cbe31448dec200ece0d4f0870 Mon Sep 17 00:00:00 2001
From: Lee Rowlands <lee.rowlands@previousnext.com.au>
Date: Fri, 27 Jun 2025 10:10:30 +1000
Subject: [PATCH 38/56] Revert gitlab change
---
.gitlab-ci.yml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 2c0466ca80..44b114152e 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -310,14 +310,14 @@ phpunit:
_TARGET_DB_VERSION: '3'
# @see https://git.drupalcode.org/project/drupal/-/commit/10466dba9d7322ed55165dd9224edb2153c9b27a
_TARGET_PHP: '8.3-ubuntu'
- _FOR_EVERY_MR_COMMIT: 'false'
+ _FOR_EVERY_MR_COMMIT: 'true'
- _TARGET_DB_TYPE: 'mariadb'
_TARGET_DB_VERSION: '10.6'
_FOR_EVERY_MR_COMMIT: 'false'
- _TARGET_DB_TYPE: 'mysql'
# @todo Delete this when https://www.drupal.org/project/gitlab_templates/issues/3447105 lands.
_TARGET_DB_VERSION: '8'
- _FOR_EVERY_MR_COMMIT: 'true'
+ _FOR_EVERY_MR_COMMIT: 'false'
- _TARGET_DB_TYPE: 'pgsql'
_TARGET_DB_VERSION: '16'
_FOR_EVERY_MR_COMMIT: 'false'
--
GitLab
From d8fdfc0b56ef02a29f9d3e7849e0375d5d7c9413 Mon Sep 17 00:00:00 2001
From: Lee Rowlands <lee.rowlands@previousnext.com.au>
Date: Fri, 27 Jun 2025 10:15:17 +1000
Subject: [PATCH 39/56] Add example to openapi
---
openapi.yml | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/openapi.yml b/openapi.yml
index 9ffe8fefec..2ef2f5793d 100644
--- a/openapi.yml
+++ b/openapi.yml
@@ -862,6 +862,11 @@ paths:
description: Search term to filter content by title
schema:
type: string
+ examples:
+ Find content with title 'My page':
+ value: 'My page'
+ Search for marketing update content:
+ value: 'Marketing update'
responses:
200:
description: Page list generated successfully.
--
GitLab
From adff4a5edd4cdca0a2b104d08400f137d5fb1b0e Mon Sep 17 00:00:00 2001
From: Lee Rowlands <lee.rowlands@previousnext.com.au>
Date: Fri, 27 Jun 2025 10:16:08 +1000
Subject: [PATCH 40/56] Update aria label
---
ui/src/components/navigation/Navigation.tsx | 2 +-
ui/tests/e2e/navigation.cy.js | 10 +++++-----
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/ui/src/components/navigation/Navigation.tsx b/ui/src/components/navigation/Navigation.tsx
index 3175637f86..d6bfdbf4dd 100644
--- a/ui/src/components/navigation/Navigation.tsx
+++ b/ui/src/components/navigation/Navigation.tsx
@@ -244,7 +244,7 @@ const Navigation = ({
id="xb-navigation-search"
placeholder="Search…"
radius="medium"
- aria-label="Search Pages"
+ aria-label="Search content"
size="1"
>
<TextField.Slot>
diff --git a/ui/tests/e2e/navigation.cy.js b/ui/tests/e2e/navigation.cy.js
index 01e81f0170..3729f58213 100644
--- a/ui/tests/e2e/navigation.cy.js
+++ b/ui/tests/e2e/navigation.cy.js
@@ -47,8 +47,8 @@ describe('Navigation functionality', () => {
it('Verify if search works', () => {
cy.loadURLandWaitForXBLoaded({ url: 'xb/xb_page/1' });
cy.findByTestId(navigationButtonTestId).click();
- cy.findByLabelText('Search Pages').clear();
- cy.findByLabelText('Search Pages').type('ome');
+ cy.findByLabelText('Search content').clear();
+ cy.findByLabelText('Search content').type('ome');
cy.findByTestId(navigationResultsTestId)
.findAllByRole('listitem')
.should(($children) => {
@@ -57,8 +57,8 @@ describe('Navigation functionality', () => {
expect($children.text()).to.contain('Homepage');
expect($children.text()).to.not.contain('Empty Page');
});
- cy.findByLabelText('Search Pages').clear();
- cy.findByLabelText('Search Pages').type('NonExistentPage');
+ cy.findByLabelText('Search content').clear();
+ cy.findByLabelText('Search content').type('NonExistentPage');
cy.findByTestId(navigationResultsTestId)
.findAllByRole('listitem')
.should(($children) => {
@@ -68,7 +68,7 @@ describe('Navigation functionality', () => {
cy.findByTestId(navigationResultsTestId)
.findByText('No pages found', { exact: false })
.should('exist');
- cy.findByLabelText('Search Pages').clear();
+ cy.findByLabelText('Search content').clear();
cy.findByTestId(navigationResultsTestId)
.findAllByRole('listitem')
.should(($children) => {
--
GitLab
From a069f1cb1503410043b80f1ff36d5d17bd7c6457 Mon Sep 17 00:00:00 2001
From: Lee Rowlands <lee.rowlands@previousnext.com.au>
Date: Fri, 27 Jun 2025 10:21:11 +1000
Subject: [PATCH 41/56] Revert change
---
src/Controller/ApiAutoSaveController.php | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/Controller/ApiAutoSaveController.php b/src/Controller/ApiAutoSaveController.php
index 62fc8a9bed..325d8e4188 100644
--- a/src/Controller/ApiAutoSaveController.php
+++ b/src/Controller/ApiAutoSaveController.php
@@ -112,9 +112,9 @@ final class ApiAutoSaveController extends ApiControllerBase {
// User display names depend on configuration.
$cache->addCacheableDependency($this->configFactory->get('user.settings'));
- // Remove 'data' and 'entity' key because this will reduce the amount of
- // data sent to the client and back to the server.
- $all = \array_map(fn(array $item) => \array_diff_key($item, \array_flip(['data', 'entity'])), $all);
+ // Remove 'data' key because this will reduce the amount of data sent to the
+ // client and back to the server.
+ $all = \array_map(fn(array $item) => \array_diff_key($item, ['data' => '']), $all);
$withUserDetails = \array_map(fn(array $item) => [
// @phpstan-ignore-next-line
--
GitLab
From 9d6100b996a8f5b620930ee00bc591c82690fd20 Mon Sep 17 00:00:00 2001
From: Lee Rowlands <lee.rowlands@previousnext.com.au>
Date: Fri, 27 Jun 2025 11:03:21 +1000
Subject: [PATCH 42/56] Reinstate removing entity
---
src/Controller/ApiAutoSaveController.php | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/Controller/ApiAutoSaveController.php b/src/Controller/ApiAutoSaveController.php
index 325d8e4188..62fc8a9bed 100644
--- a/src/Controller/ApiAutoSaveController.php
+++ b/src/Controller/ApiAutoSaveController.php
@@ -112,9 +112,9 @@ final class ApiAutoSaveController extends ApiControllerBase {
// User display names depend on configuration.
$cache->addCacheableDependency($this->configFactory->get('user.settings'));
- // Remove 'data' key because this will reduce the amount of data sent to the
- // client and back to the server.
- $all = \array_map(fn(array $item) => \array_diff_key($item, ['data' => '']), $all);
+ // Remove 'data' and 'entity' key because this will reduce the amount of
+ // data sent to the client and back to the server.
+ $all = \array_map(fn(array $item) => \array_diff_key($item, \array_flip(['data', 'entity'])), $all);
$withUserDetails = \array_map(fn(array $item) => [
// @phpstan-ignore-next-line
--
GitLab
From dc20455f0a3a3e8724ddb1e14e799ceef0231892 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Fri, 27 Jun 2025 08:41:35 +0530
Subject: [PATCH 43/56] remove sorting by neweset first.
---
ui/src/services/content.ts | 7 +------
1 file changed, 1 insertion(+), 6 deletions(-)
diff --git a/ui/src/services/content.ts b/ui/src/services/content.ts
index 4b9ac8742d..8f7cb3e5d1 100644
--- a/ui/src/services/content.ts
+++ b/ui/src/services/content.ts
@@ -44,12 +44,7 @@ export const contentApi = createApi({
};
},
transformResponse: (response: ContentListResponse) => {
- // Convert response object to array while preserving order
- // Sort by ID in descending order to maintain newest first order
- return Object.values(response).sort((a, b) => {
- // Convert IDs to numbers for comparison, newer IDs are typically higher
- return Number(b.id) - Number(a.id);
- });
+ return Object.values(response);
},
providesTags: [{ type: 'Content', id: 'LIST' }],
}),
--
GitLab
From 89cdda08e4ee6f88965578701fef705d9bbd93e4 Mon Sep 17 00:00:00 2001
From: Deepak Mishra <deepak.mishra@acquia.com>
Date: Fri, 27 Jun 2025 09:27:23 +0530
Subject: [PATCH 44/56] cypress test fixes.
---
ui/tests/e2e/navigation.cy.js | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/ui/tests/e2e/navigation.cy.js b/ui/tests/e2e/navigation.cy.js
index 3729f58213..f224b0b232 100644
--- a/ui/tests/e2e/navigation.cy.js
+++ b/ui/tests/e2e/navigation.cy.js
@@ -250,8 +250,8 @@ describe('Navigation functionality', () => {
cy.wait('@deletePage').its('response.statusCode').should('eq', 204);
// Wait for the GET request to the list endpoint which should be triggered by the deletion of a page.
cy.wait('@getList').its('response.statusCode').should('eq', 200);
- cy.url().should('not.contain', '/xb/xb_page/3');
- cy.url().should('contain', '/xb/xb_page/5');
+ cy.url().should('not.contain', '/xb/xb_page/4');
+ cy.url().should('contain', '/xb/xb_page/1');
cy.findByTestId(navigationButtonTestId).click();
cy.findByTestId(navigationContentTestId)
.should('exist')
--
GitLab
From 3f12d93443e9349864ef2c4884d8089169e72812 Mon Sep 17 00:00:00 2001
From: Wim Leers <wim.leers@acquia.com>
Date: Mon, 30 Jun 2025 11:39:48 +0200
Subject: [PATCH 45/56] Refactor away pointless
`::createInitialCacheability()`. Addresses
https://git.drupalcode.org/project/experience_builder/-/merge_requests/887#note_543234
---
src/Controller/ApiContentControllers.php | 20 +++-----------------
1 file changed, 3 insertions(+), 17 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 17c51b7f10..77d3501393 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -124,8 +124,9 @@ final class ApiContentControllers {
$langcode = $this->languageManager->getCurrentLanguage()->getId();
$storage = $this->entityTypeManager->getStorage($entity_type);
- // Setup cacheability metadata
- $query_cacheability = $this->createInitialCacheability($storage);
+ $query_cacheability = (new CacheableMetadata())
+ ->addCacheContexts($storage->getEntityType()->getListCacheContexts())
+ ->addCacheTags($storage->getEntityType()->getListCacheTags());
// Create an entity query with access check
/** @var \Drupal\Core\Entity\ContentEntityTypeInterface $field_definition */
@@ -229,21 +230,6 @@ final class ApiContentControllers {
];
}
- /**
- * Creates initial cacheability metadata based on entity storage.
- *
- * @param \Drupal\Core\Entity\EntityStorageInterface $storage
- * The entity storage.
- *
- * @return \Drupal\Core\Cache\CacheableMetadata
- * The initialized cacheability metadata.
- */
- private static function createInitialCacheability($storage): CacheableMetadata {
- return (new CacheableMetadata())
- ->addCacheContexts($storage->getEntityType()->getListCacheContexts())
- ->addCacheTags($storage->getEntityType()->getListCacheTags());
- }
-
/**
* Prepares and normalizes the search term from the request.
*
--
GitLab
From 296d11da8671cfa615630868c7a4763ba9ee7981 Mon Sep 17 00:00:00 2001
From: Wim Leers <wim.leers@acquia.com>
Date: Mon, 30 Jun 2025 11:49:10 +0200
Subject: [PATCH 46/56] Refactor away `::prepareSearchTerm()`, introduce
`::transliterate()`, let it handle all language negotiation cacheability. In
doing so, the search term logic became more explicit, and *its* cacheability
became co-located. Addresses
https://git.drupalcode.org/project/experience_builder/-/merge_requests/887#note_543233
and
https://git.drupalcode.org/project/experience_builder/-/merge_requests/887#note_543235
and
https://git.drupalcode.org/project/experience_builder/-/merge_requests/887#note_543236.
---
src/Controller/ApiContentControllers.php | 46 ++++++++++++------------
1 file changed, 24 insertions(+), 22 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 77d3501393..a622e4024d 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -7,6 +7,7 @@ namespace Drupal\experience_builder\Controller;
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Cache\CacheableJsonResponse;
use Drupal\Core\Cache\CacheableMetadata;
+use Drupal\Core\Cache\RefinableCacheableDependencyInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityPublishedInterface;
use Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManagerInterface;
@@ -15,6 +16,7 @@ use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Entity\FieldableEntityInterface;
use Drupal\Core\Entity\Query\QueryInterface;
+use Drupal\Core\Language\LanguageInterface;
use Drupal\Core\Language\LanguageManagerInterface;
use Drupal\Component\Transliteration\TransliterationInterface;
use Drupal\Core\Render\RenderContext;
@@ -121,7 +123,6 @@ final class ApiContentControllers {
* @see https://www.drupal.org/project/experience_builder/issues/3500052#comment-15966496
*/
public function list(string $entity_type, Request $request): CacheableJsonResponse {
- $langcode = $this->languageManager->getCurrentLanguage()->getId();
$storage = $this->entityTypeManager->getStorage($entity_type);
$query_cacheability = (new CacheableMetadata())
@@ -135,10 +136,14 @@ final class ApiContentControllers {
$entity_query = $storage->getQuery()->accessCheck(TRUE);
// Prepare search term and determine if we're performing a search
- $search = $this->prepareSearchTerm($request, $langcode);
+ $search = $request->query->get('search', default: NULL);
+ $query_cacheability->addCacheContexts(['url.query_args:search']);
+ if ($search !== NULL) {
+ assert(is_string($search));
+ $search = $this->transliterate(trim($search), $query_cacheability);
+ }
$search_ids = [];
-
- if ($search === '') {
+ if ($search === NULL) {
// Only apply sorting and range limiting when not searching
$entity_query->sort((string) $revision_created_field_name, direction: 'DESC')
->range(0, self::MAX_SEARCH_RESULTS);
@@ -156,7 +161,7 @@ final class ApiContentControllers {
$matching_ids = $this->getMatchingEntityIds($entity_type, $search);
// Find matching unsaved entities
- $matching_unsaved_ids = $this->getMatchingUnsavedIds($search, $langcode, $entity_type);
+ $matching_unsaved_ids = $this->getMatchingUnsavedIds($search, $entity_type);
// Return empty response if no matches found
if (empty($matching_ids) && empty($matching_unsaved_ids)) {
@@ -231,22 +236,21 @@ final class ApiContentControllers {
}
/**
- * Prepares and normalizes the search term from the request.
+ * Transliterates a string using the negotiated content language.
*
- * @param \Symfony\Component\HttpFoundation\Request $request
- * The HTTP request object.
- * @param string $langcode
- * The language code to use for transliteration.
+ * @param string $string
+ * The string to transliterate.
+ * @param \Drupal\Core\Cache\RefinableCacheableDependencyInterface $cacheability
+ * The cacheability of the given query, to be refined to match the
+ * refinements made to the query.
*
* @return string
- * The normalized search term.
+ * The transliterated string.
*/
- private function prepareSearchTerm(Request $request, string $langcode): string {
- if ($request->query->has('search')) {
- $search = trim((string) $request->query->get('search'));
- return $this->transliteration->transliterate(mb_strtolower($search), $langcode);
- }
- return '';
+ private function transliterate(string $string, RefinableCacheableDependencyInterface $cacheability): string {
+ $langcode = $this->languageManager->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)->getId();
+ $cacheability->addCacheContexts(['languages:' . LanguageInterface::TYPE_CONTENT]);
+ return $this->transliteration->transliterate(mb_strtolower($string), $langcode);
}
/**
@@ -282,19 +286,18 @@ final class ApiContentControllers {
*
* @param string $search
* The search term to match against entities.
- * @param string $langcode
- * The language code to use for transliteration.
*
* @return array
* An array of entity IDs that match the search criteria.
*/
- private function getMatchingUnsavedIds(string $search, string $langcode, string $entity_type_id): array {
+ private function getMatchingUnsavedIds(string $search, string $entity_type_id): array {
$matching_unsaved_ids = [];
$unsaved_entries = \array_filter($this->autoSaveManager->getAllAutoSaveList(TRUE), static fn (array $entry): bool => $entry['entity_type'] === $entity_type_id);
foreach ($unsaved_entries as ['entity' => $entity]) {
\assert($entity instanceof EntityInterface);
- $label = $this->transliteration->transliterate(mb_strtolower((string) $entity->label()), $langcode);
+ // @todo refactor this method to pass the query cacheability
+ $label = $this->transliterate((string) $entity->label(), (new CacheableMetadata()));
if (str_contains(mb_strtolower($label), $search)) {
$matching_unsaved_ids[] = $entity->id();
}
@@ -412,7 +415,6 @@ final class ApiContentControllers {
* The cacheability metadata object to add contexts and tags to.
*/
private static function addSearchCacheability(CacheableMetadata $query_cacheability): void {
- $query_cacheability->addCacheContexts(['url.query_args:search']);
$query_cacheability->addCacheTags([AutoSaveManager::CACHE_TAG]);
}
--
GitLab
From 3476fa3ebb5d9cc2624ca4ca6dc931fa343d9826 Mon Sep 17 00:00:00 2001
From: Wim Leers <wim.leers@acquia.com>
Date: Mon, 30 Jun 2025 12:14:21 +0200
Subject: [PATCH 47/56] Address
https://git.drupalcode.org/project/experience_builder/-/merge_requests/887/diffs#note_543261.
---
src/Controller/ApiContentControllers.php | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index a622e4024d..25b4a985b8 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -4,6 +4,7 @@ declare(strict_types=1);
namespace Drupal\experience_builder\Controller;
+use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Cache\CacheableJsonResponse;
use Drupal\Core\Cache\CacheableMetadata;
@@ -278,7 +279,7 @@ final class ApiContentControllers {
self::MAX_SEARCH_RESULTS
);
- return array_keys($matching_data[$entity_type] ?? []);
+ return array_keys(NestedArray::mergeDeepArray($matching_data, TRUE));
}
/**
--
GitLab
From 95d5f35e5c722940cb15aec3c002fd93cfa9de02 Mon Sep 17 00:00:00 2001
From: Wim Leers <wim.leers@acquia.com>
Date: Mon, 30 Jun 2025 12:14:54 +0200
Subject: [PATCH 48/56] Update test expectations.
---
tests/src/Functional/XbContentEntityHttpApiTest.php | 7 ++++---
.../Kernel/Controller/ApiContentControllersListTest.php | 2 +-
2 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/tests/src/Functional/XbContentEntityHttpApiTest.php b/tests/src/Functional/XbContentEntityHttpApiTest.php
index a529cc16db..be1ea568d9 100644
--- a/tests/src/Functional/XbContentEntityHttpApiTest.php
+++ b/tests/src/Functional/XbContentEntityHttpApiTest.php
@@ -7,6 +7,7 @@ namespace Drupal\Tests\experience_builder\Functional;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Language\LanguageInterface;
use Drupal\Core\Url;
use Drupal\experience_builder\AutoSave\AutoSaveManager;
use Drupal\experience_builder\Entity\Page;
@@ -155,7 +156,7 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
// Because page 2 isn't in these results, we don't get its cache tag.
$expected_tags_without_page_2 = \array_diff($expected_tags, ['xb_page:2']);
// Confirm that the cache is not hit when a different request is made with query parameter.
- $search_body = $this->assertExpectedResponse('GET', $search_url, [], 200, ['url.query_args:search', 'user.permissions'], $expected_tags_without_page_2, 'UNCACHEABLE (request policy)', 'MISS');
+ $search_body = $this->assertExpectedResponse('GET', $search_url, [], 200, ['languages:' . LanguageInterface::TYPE_CONTENT, 'url.query_args:search', 'user.permissions'], $expected_tags_without_page_2, 'UNCACHEABLE (request policy)', 'MISS');
$this->assertEquals(
[
'1' => [
@@ -175,11 +176,11 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
$search_body
);
// Confirm that the cache is hit when the same request is made again.
- $this->assertExpectedResponse('GET', $search_url, [], 200, ['url.query_args:search', 'user.permissions'], $expected_tags_without_page_2, 'UNCACHEABLE (request policy)', 'HIT');
+ $this->assertExpectedResponse('GET', $search_url, [], 200, ['languages:' . LanguageInterface::TYPE_CONTENT, 'url.query_args:search', 'user.permissions'], $expected_tags_without_page_2, 'UNCACHEABLE (request policy)', 'HIT');
// Test searching by query parameter - substring match.
$substring_search_url = Url::fromUri('base:/xb/api/v0/content/xb_page', ['query' => ['search' => 'age']]);
- $substring_search_body = $this->assertExpectedResponse('GET', $substring_search_url, [], 200, ['url.query_args:search', 'user.permissions'], $expected_tags, 'UNCACHEABLE (request policy)', 'MISS');
+ $substring_search_body = $this->assertExpectedResponse('GET', $substring_search_url, [], 200, ['languages:' . LanguageInterface::TYPE_CONTENT, 'url.query_args:search', 'user.permissions'], $expected_tags, 'UNCACHEABLE (request policy)', 'MISS');
$this->assertEquals($no_auto_save_expected_pages, $substring_search_body);
$autoSaveManager = $this->container->get(AutoSaveManager::class);
diff --git a/tests/src/Kernel/Controller/ApiContentControllersListTest.php b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
index 4a6d6365e9..83fa9c1ac4 100644
--- a/tests/src/Kernel/Controller/ApiContentControllersListTest.php
+++ b/tests/src/Kernel/Controller/ApiContentControllersListTest.php
@@ -248,8 +248,8 @@ class ApiContentControllersListTest extends KernelTestBase {
$actual_cache_tags = $cache_metadata->getCacheTags();
$expected_cache_contexts = [
- 'user.permissions',
'url.query_args:search',
+ 'user.permissions',
];
$actual_cache_contexts = $cache_metadata->getCacheContexts();
self::assertEquals($expected_cache_tags, $actual_cache_tags, 'All expected cache tags should be present');
--
GitLab
From fc94bc1178200b15ea852047896c19acd22718b4 Mon Sep 17 00:00:00 2001
From: Wim Leers <wim.leers@acquia.com>
Date: Mon, 30 Jun 2025 12:24:32 +0200
Subject: [PATCH 49/56] Since neither `/xb/api/v0/content/node` nor
`/xb/api/v0/content/node?search=word` work, provide an explicit error
response instead of failing hard. (The protection this MR is adding is
broken.) Addresses
https://git.drupalcode.org/project/experience_builder/-/merge_requests/887/diffs#note_543273
---
src/Controller/ApiContentControllers.php | 13 +++++--------
1 file changed, 5 insertions(+), 8 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 25b4a985b8..7591ff9448 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -26,6 +26,7 @@ use Drupal\Core\Routing\RouteProviderInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\Core\Url;
use Drupal\experience_builder\AutoSave\AutoSaveManager;
+use Drupal\experience_builder\Entity\Page;
use Drupal\experience_builder\Resource\XbResourceLink;
use Drupal\experience_builder\Resource\XbResourceLinkCollection;
use Drupal\experience_builder\XbUriDefinitions;
@@ -34,6 +35,7 @@ use Symfony\Component\DependencyInjection\Attribute\Autowire;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
/**
* HTTP API for interacting with XB-eligible Content entity types.
@@ -125,6 +127,9 @@ final class ApiContentControllers {
*/
public function list(string $entity_type, Request $request): CacheableJsonResponse {
$storage = $this->entityTypeManager->getStorage($entity_type);
+ if ($entity_type !== Page::ENTITY_TYPE_ID) {
+ throw new BadRequestHttpException('Only the `xb_page` content entity type is supported right now, will be generalized in a child issue of https://www.drupal.org/project/experience_builder/issues/3498525.');
+ }
$query_cacheability = (new CacheableMetadata())
->addCacheContexts($storage->getEntityType()->getListCacheContexts())
@@ -150,14 +155,6 @@ final class ApiContentControllers {
->range(0, self::MAX_SEARCH_RESULTS);
}
else {
- // Handle search functionality when search term is not empty
- $label_key = $storage->getEntityType()->getKey('label');
-
- // @todo Remove this in https://www.drupal.org/project/experience_builder/issues/3498525.
- if ($label_key === FALSE) {
- throw new \LogicException('Unhandled.');
- }
-
// Get matching entity IDs through selection handler
$matching_ids = $this->getMatchingEntityIds($entity_type, $search);
--
GitLab
From fc31d29bd2899fa6b1503baeb37279d0424fd884 Mon Sep 17 00:00:00 2001
From: Wim Leers <wim.leers@acquia.com>
Date: Mon, 30 Jun 2025 12:43:06 +0200
Subject: [PATCH 50/56] Move all the non-search-specific logic into the "no
search" branch", and simply have both branches generate an `$ids` array.
Addresses
https://git.drupalcode.org/project/experience_builder/-/merge_requests/887/diffs#note_543280.
---
src/Controller/ApiContentControllers.php | 38 +++++++++++++-----------
1 file changed, 21 insertions(+), 17 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 7591ff9448..ac4f06ffb4 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -9,6 +9,7 @@ use Drupal\Core\Access\AccessResult;
use Drupal\Core\Cache\CacheableJsonResponse;
use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\Cache\RefinableCacheableDependencyInterface;
+use Drupal\Core\Entity\ContentEntityTypeInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityPublishedInterface;
use Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManagerInterface;
@@ -135,26 +136,32 @@ final class ApiContentControllers {
->addCacheContexts($storage->getEntityType()->getListCacheContexts())
->addCacheTags($storage->getEntityType()->getListCacheTags());
- // Create an entity query with access check
- /** @var \Drupal\Core\Entity\ContentEntityTypeInterface $field_definition */
- $field_definition = $this->entityTypeManager->getDefinition($entity_type);
- $revision_created_field_name = $field_definition->getRevisionMetadataKey('revision_created');
- $entity_query = $storage->getQuery()->accessCheck(TRUE);
-
// Prepare search term and determine if we're performing a search
$search = $request->query->get('search', default: NULL);
$query_cacheability->addCacheContexts(['url.query_args:search']);
- if ($search !== NULL) {
- assert(is_string($search));
- $search = $this->transliterate(trim($search), $query_cacheability);
- }
- $search_ids = [];
+
+ // Get the (ordered) list of content entity IDs to load, either:
+ // - without a search term: get the N newest content entities
if ($search === NULL) {
- // Only apply sorting and range limiting when not searching
- $entity_query->sort((string) $revision_created_field_name, direction: 'DESC')
+ $content_entity_type = $this->entityTypeManager->getDefinition($entity_type);
+ assert($content_entity_type instanceof ContentEntityTypeInterface);
+ $revision_created_field_name = $content_entity_type->getRevisionMetadataKey('revision_created');
+ // @todo Ensure this is one of the required characteristics in https://www.drupal.org/project/experience_builder/issues/3498525.
+ assert(is_string($revision_created_field_name));
+
+ $entity_query = $storage->getQuery()
+ ->accessCheck(TRUE)
+ ->sort($revision_created_field_name, direction: 'DESC')
->range(0, self::MAX_SEARCH_RESULTS);
+
+ $ids = $this->executeQueryInRenderContext($entity_query, $query_cacheability);
}
+ // - with a search term: transliterate, get the N best matches using the
+ // entity reference selection plugin
else {
+ assert(is_string($search));
+ $search = $this->transliterate(trim($search), $query_cacheability);
+
// Get matching entity IDs through selection handler
$matching_ids = $this->getMatchingEntityIds($entity_type, $search);
@@ -165,12 +172,9 @@ final class ApiContentControllers {
if (empty($matching_ids) && empty($matching_unsaved_ids)) {
return $this->createEmptyResponse($query_cacheability);
}
- $search_ids = $this->filterAndMergeIds($matching_ids, $matching_unsaved_ids);
+ $ids = $this->filterAndMergeIds($matching_ids, $matching_unsaved_ids);
}
- // Get entity IDs and filter by search results if needed.
- $ids = !empty($search_ids) ? $search_ids : $this->executeQueryInRenderContext($entity_query, $query_cacheability);
-
// Load entities and prepare content list.
/** @var \Drupal\Core\Entity\EntityPublishedInterface[] $content_entities */
$content_entities = $storage->loadMultiple($ids);
--
GitLab
From 829567e398b42eaa40f9778b634c04dd8aed90e0 Mon Sep 17 00:00:00 2001
From: Wim Leers <wim.leers@acquia.com>
Date: Mon, 30 Jun 2025 13:06:37 +0200
Subject: [PATCH 51/56] Rename `::getMatchingEntityIds()` and
`::getMatchingUnsavedIds()` to illustrate their contrast/complementarity. Let
the latter be responsible for its own cacheability. This allows removing 2
helper methods: `::createEmptyResponse()` and `::addSearchCacheability()`.
---
src/Controller/ApiContentControllers.php | 64 +++++++-----------------
1 file changed, 18 insertions(+), 46 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index ac4f06ffb4..c405ebb3b1 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -12,6 +12,7 @@ use Drupal\Core\Cache\RefinableCacheableDependencyInterface;
use Drupal\Core\Entity\ContentEntityTypeInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityPublishedInterface;
+use Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface;
use Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManagerInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Entity\ContentEntityInterface;
@@ -162,17 +163,11 @@ final class ApiContentControllers {
assert(is_string($search));
$search = $this->transliterate(trim($search), $query_cacheability);
- // Get matching entity IDs through selection handler
- $matching_ids = $this->getMatchingEntityIds($entity_type, $search);
+ $matching_ids = $this->getMatchingStoredEntityIds($entity_type, $search);
+ $query_cacheability->addCacheTags([AutoSaveManager::CACHE_TAG]);
+ $matching_auto_saved_ids = $this->getMatchingAutoSavedEntityIds($search, $entity_type, $query_cacheability);
- // Find matching unsaved entities
- $matching_unsaved_ids = $this->getMatchingUnsavedIds($search, $entity_type);
-
- // Return empty response if no matches found
- if (empty($matching_ids) && empty($matching_unsaved_ids)) {
- return $this->createEmptyResponse($query_cacheability);
- }
- $ids = $this->filterAndMergeIds($matching_ids, $matching_unsaved_ids);
+ $ids = $this->filterAndMergeIds($matching_ids, $matching_auto_saved_ids);
}
// Load entities and prepare content list.
@@ -186,7 +181,6 @@ final class ApiContentControllers {
}
$json_response = new CacheableJsonResponse($content_list);
- $this->addSearchCacheability($query_cacheability);
// @todo add cache contexts for query params when introducing pagination in https://www.drupal.org/i/3502691.
$json_response->addCacheableDependency($query_cacheability);
@@ -256,24 +250,24 @@ final class ApiContentControllers {
}
/**
- * Gets entity IDs matching the search term using selection handler.
+ * Gets N first saved ("live") entity IDs matching the search term.
*
* @param string $entity_type
* The entity type ID.
* @param string $search
- * The search term to match against entities.
+ * The (transliterated) search term to match against entities.
*
* @return array
- * An array of entity IDs that match the search criteria.
+ * An array of entity IDs that match the search term.
*/
- private function getMatchingEntityIds(string $entity_type, string $search): array {
+ private function getMatchingStoredEntityIds(string $entity_type, string $search): array {
/** @var \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface $selection_handler */
$selection_handler = $this->selectionManager->getInstance([
'target_type' => $entity_type,
'handler' => 'default',
'match_operator' => 'CONTAINS',
]);
-
+ assert($selection_handler instanceof SelectionInterface);
$matching_data = $selection_handler->getReferenceableEntities(
$search,
'CONTAINS',
@@ -284,22 +278,26 @@ final class ApiContentControllers {
}
/**
- * Gets unsaved entity IDs matching the search term.
+ * Gets N first auto-saved ("draft") entity IDs matching the search term.
*
* @param string $search
* The search term to match against entities.
+ * @param \Drupal\Core\Cache\RefinableCacheableDependencyInterface $cacheability
+ * The cacheability of the given query, to be refined to match the
+ * refinements made to the query.
*
* @return array
* An array of entity IDs that match the search criteria.
*/
- private function getMatchingUnsavedIds(string $search, string $entity_type_id): array {
+ private function getMatchingAutoSavedEntityIds(string $search, string $entity_type_id, RefinableCacheableDependencyInterface $cacheability): array {
+ $cacheability->addCacheTags([AutoSaveManager::CACHE_TAG]);
+
$matching_unsaved_ids = [];
$unsaved_entries = \array_filter($this->autoSaveManager->getAllAutoSaveList(TRUE), static fn (array $entry): bool => $entry['entity_type'] === $entity_type_id);
foreach ($unsaved_entries as ['entity' => $entity]) {
\assert($entity instanceof EntityInterface);
- // @todo refactor this method to pass the query cacheability
- $label = $this->transliterate((string) $entity->label(), (new CacheableMetadata()));
+ $label = $this->transliterate((string) $entity->label(), $cacheability);
if (str_contains(mb_strtolower($label), $search)) {
$matching_unsaved_ids[] = $entity->id();
}
@@ -308,22 +306,6 @@ final class ApiContentControllers {
return $matching_unsaved_ids;
}
- /**
- * Creates an empty response with proper cacheability metadata.
- *
- * @param \Drupal\Core\Cache\CacheableMetadata $query_cacheability
- * The cacheability metadata to attach to the response.
- *
- * @return \Drupal\Core\Cache\CacheableJsonResponse
- * An empty JSON response with cacheability metadata attached.
- */
- private static function createEmptyResponse(CacheableMetadata $query_cacheability): CacheableJsonResponse {
- $json_response = new CacheableJsonResponse([]);
- self::addSearchCacheability($query_cacheability);
- $json_response->addCacheableDependency($query_cacheability);
- return $json_response;
- }
-
/**
* Filters and merges entity IDs based on search results.
*
@@ -410,16 +392,6 @@ final class ApiContentControllers {
return new TranslatableMarkup('Untitled @singular_entity_type_label', ['@singular_entity_type_label' => $entity_type->getSingularLabel()]);
}
- /**
- * Adds search-related cache contexts and tags to cacheability metadata.
- *
- * @param \Drupal\Core\Cache\CacheableMetadata $query_cacheability
- * The cacheability metadata object to add contexts and tags to.
- */
- private static function addSearchCacheability(CacheableMetadata $query_cacheability): void {
- $query_cacheability->addCacheTags([AutoSaveManager::CACHE_TAG]);
- }
-
public function getEntityOperations(EntityPublishedInterface $content_entity): XbResourceLinkCollection {
$links = new XbResourceLinkCollection([]);
// Link relation type => route name.
--
GitLab
From e9c6b8e417e6815744ab04cd8369f0cb89926309 Mon Sep 17 00:00:00 2001
From: Wim Leers <44946-wimleers@users.noreply.drupalcode.org>
Date: Mon, 30 Jun 2025 11:07:03 +0000
Subject: [PATCH 52/56] Remove dead code.
---
src/Controller/ApiContentControllers.php | 1 -
1 file changed, 1 deletion(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index c405ebb3b1..7ff8cd3ec5 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -265,7 +265,6 @@ final class ApiContentControllers {
$selection_handler = $this->selectionManager->getInstance([
'target_type' => $entity_type,
'handler' => 'default',
- 'match_operator' => 'CONTAINS',
]);
assert($selection_handler instanceof SelectionInterface);
$matching_data = $selection_handler->getReferenceableEntities(
--
GitLab
From 1580417ac523d99137b37d76a34df369555620ec Mon Sep 17 00:00:00 2001
From: Wim Leers <wim.leers@acquia.com>
Date: Mon, 30 Jun 2025 13:43:56 +0200
Subject: [PATCH 53/56] The transliteration is only necessary for matching
auto-saved entity labels. Refactor, and drop `::translate()`.
---
src/Controller/ApiContentControllers.php | 52 +++++++++---------------
1 file changed, 20 insertions(+), 32 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 7ff8cd3ec5..492d14930b 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -157,17 +157,15 @@ final class ApiContentControllers {
$ids = $this->executeQueryInRenderContext($entity_query, $query_cacheability);
}
- // - with a search term: transliterate, get the N best matches using the
- // entity reference selection plugin
+ // - with a search term: get the N best matches using the entity reference
+ // selection plugin, get all auto-save matches, and combine both
else {
assert(is_string($search));
- $search = $this->transliterate(trim($search), $query_cacheability);
-
- $matching_ids = $this->getMatchingStoredEntityIds($entity_type, $search);
- $query_cacheability->addCacheTags([AutoSaveManager::CACHE_TAG]);
- $matching_auto_saved_ids = $this->getMatchingAutoSavedEntityIds($search, $entity_type, $query_cacheability);
-
- $ids = $this->filterAndMergeIds($matching_ids, $matching_auto_saved_ids);
+ $search = trim($search);
+ $ids = $this->filterAndMergeIds(
+ $this->getMatchingStoredEntityIds($entity_type, $search),
+ $this->getMatchingAutoSavedEntityIds($search, $entity_type, $query_cacheability)
+ );
}
// Load entities and prepare content list.
@@ -231,24 +229,6 @@ final class ApiContentControllers {
];
}
- /**
- * Transliterates a string using the negotiated content language.
- *
- * @param string $string
- * The string to transliterate.
- * @param \Drupal\Core\Cache\RefinableCacheableDependencyInterface $cacheability
- * The cacheability of the given query, to be refined to match the
- * refinements made to the query.
- *
- * @return string
- * The transliterated string.
- */
- private function transliterate(string $string, RefinableCacheableDependencyInterface $cacheability): string {
- $langcode = $this->languageManager->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)->getId();
- $cacheability->addCacheContexts(['languages:' . LanguageInterface::TYPE_CONTENT]);
- return $this->transliteration->transliterate(mb_strtolower($string), $langcode);
- }
-
/**
* Gets N first saved ("live") entity IDs matching the search term.
*
@@ -281,6 +261,8 @@ final class ApiContentControllers {
*
* @param string $search
* The search term to match against entities.
+ * @param string $entity_type_id
+ * The entity type ID.
* @param \Drupal\Core\Cache\RefinableCacheableDependencyInterface $cacheability
* The cacheability of the given query, to be refined to match the
* refinements made to the query.
@@ -290,14 +272,20 @@ final class ApiContentControllers {
*/
private function getMatchingAutoSavedEntityIds(string $search, string $entity_type_id, RefinableCacheableDependencyInterface $cacheability): array {
$cacheability->addCacheTags([AutoSaveManager::CACHE_TAG]);
+ $auto_saved_entities_of_type = \array_filter($this->autoSaveManager->getAllAutoSaveList(TRUE), static fn (array $entry): bool => $entry['entity_type'] === $entity_type_id);
- $matching_unsaved_ids = [];
- $unsaved_entries = \array_filter($this->autoSaveManager->getAllAutoSaveList(TRUE), static fn (array $entry): bool => $entry['entity_type'] === $entity_type_id);
+ // Transliterate the search term using the negotiated content language.
+ $cacheability->addCacheContexts(['languages:' . LanguageInterface::TYPE_CONTENT]);
+ $langcode = $this->languageManager->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)->getId();
+ $transliterated_search = $this->transliteration->transliterate(mb_strtolower($search), $langcode);
- foreach ($unsaved_entries as ['entity' => $entity]) {
+ // Check if the transliterated search term is contained by any of the auto-
+ // saved entities of this type.
+ $matching_unsaved_ids = [];
+ foreach ($auto_saved_entities_of_type as ['entity' => $entity]) {
\assert($entity instanceof EntityInterface);
- $label = $this->transliterate((string) $entity->label(), $cacheability);
- if (str_contains(mb_strtolower($label), $search)) {
+ $transliterated_label = $this->transliteration->transliterate(mb_strtolower((string) $entity->label()), $langcode);
+ if (str_contains($transliterated_label, $transliterated_search)) {
$matching_unsaved_ids[] = $entity->id();
}
}
--
GitLab
From 0dfed6bf7c4c8434ad4b22198e51e6f89f372b80 Mon Sep 17 00:00:00 2001
From: Wim Leers <wim.leers@acquia.com>
Date: Mon, 30 Jun 2025 14:02:16 +0200
Subject: [PATCH 54/56] Refactor `::prepareEntityData()` to `::normalize()` and
refactor away useless parameter.
---
src/Controller/ApiContentControllers.php | 15 ++++++---------
1 file changed, 6 insertions(+), 9 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index 492d14930b..c241494fed 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -173,9 +173,8 @@ final class ApiContentControllers {
$content_entities = $storage->loadMultiple($ids);
$content_list = [];
- foreach ($content_entities as $content_entity) {
- $id = (int) $content_entity->id();
- $content_list[$id] = $this->prepareEntityData($content_entity, $query_cacheability, $id);
+ foreach ($content_entities as $id => $content_entity) {
+ $content_list[$id] = $this->normalize($content_entity, $query_cacheability);
}
$json_response = new CacheableJsonResponse($content_list);
@@ -186,19 +185,17 @@ final class ApiContentControllers {
}
/**
- * Prepares entity data for the response.
+ * Normalizes content entity.
*
* @param \Drupal\Core\Entity\EntityPublishedInterface $content_entity
* The content entity to prepare data for.
* @param \Drupal\Core\Cache\CacheableMetadata $url_cacheability
* The cacheability metadata object to add URL dependencies to.
- * @param int $id
- * The entity ID.
*
* @return array
- * An associative array containing the prepared entity data.
+ * An associative array containing the normalized entity.
*/
- private function prepareEntityData(EntityPublishedInterface $content_entity, CacheableMetadata $url_cacheability, int $id): array {
+ private function normalize(EntityPublishedInterface $content_entity, CacheableMetadata $url_cacheability): array {
$generated_url = $content_entity->toUrl()->toString(TRUE);
$autoSaveData = $this->autoSaveManager->getAutoSaveEntity($content_entity);
@@ -218,7 +215,7 @@ final class ApiContentControllers {
->addCacheableDependency($autoSaveData);
return [
- 'id' => $id,
+ 'id' => (int) $content_entity->id(),
'title' => $content_entity->label(),
'status' => $content_entity->isPublished(),
'path' => $generated_url->getGeneratedUrl(),
--
GitLab
From 1707753b987f04a3a20facfc6b1228d9dd22b310 Mon Sep 17 00:00:00 2001
From: Wim Leers <wim.leers@acquia.com>
Date: Mon, 30 Jun 2025 13:59:27 +0200
Subject: [PATCH 55/56] Clean-up.
---
src/Controller/ApiContentControllers.php | 20 +++++++++-----------
1 file changed, 9 insertions(+), 11 deletions(-)
diff --git a/src/Controller/ApiContentControllers.php b/src/Controller/ApiContentControllers.php
index c241494fed..a18a351aad 100644
--- a/src/Controller/ApiContentControllers.php
+++ b/src/Controller/ApiContentControllers.php
@@ -128,10 +128,10 @@ final class ApiContentControllers {
* @see https://www.drupal.org/project/experience_builder/issues/3500052#comment-15966496
*/
public function list(string $entity_type, Request $request): CacheableJsonResponse {
- $storage = $this->entityTypeManager->getStorage($entity_type);
if ($entity_type !== Page::ENTITY_TYPE_ID) {
throw new BadRequestHttpException('Only the `xb_page` content entity type is supported right now, will be generalized in a child issue of https://www.drupal.org/project/experience_builder/issues/3498525.');
}
+ $storage = $this->entityTypeManager->getStorage($entity_type);
$query_cacheability = (new CacheableMetadata())
->addCacheContexts($storage->getEntityType()->getListCacheContexts())
@@ -163,16 +163,15 @@ final class ApiContentControllers {
assert(is_string($search));
$search = trim($search);
$ids = $this->filterAndMergeIds(
+ // TRICKY: covered by the "list cacheability" at the top.
$this->getMatchingStoredEntityIds($entity_type, $search),
- $this->getMatchingAutoSavedEntityIds($search, $entity_type, $query_cacheability)
+ $this->getMatchingAutoSavedEntityIds($entity_type, $search, $query_cacheability)
);
}
- // Load entities and prepare content list.
/** @var \Drupal\Core\Entity\EntityPublishedInterface[] $content_entities */
$content_entities = $storage->loadMultiple($ids);
$content_list = [];
-
foreach ($content_entities as $id => $content_entity) {
$content_list[$id] = $this->normalize($content_entity, $query_cacheability);
}
@@ -229,7 +228,7 @@ final class ApiContentControllers {
/**
* Gets N first saved ("live") entity IDs matching the search term.
*
- * @param string $entity_type
+ * @param string $entity_type_id
* The entity type ID.
* @param string $search
* The (transliterated) search term to match against entities.
@@ -237,10 +236,10 @@ final class ApiContentControllers {
* @return array
* An array of entity IDs that match the search term.
*/
- private function getMatchingStoredEntityIds(string $entity_type, string $search): array {
+ private function getMatchingStoredEntityIds(string $entity_type_id, string $search): array {
/** @var \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface $selection_handler */
$selection_handler = $this->selectionManager->getInstance([
- 'target_type' => $entity_type,
+ 'target_type' => $entity_type_id,
'handler' => 'default',
]);
assert($selection_handler instanceof SelectionInterface);
@@ -256,10 +255,10 @@ final class ApiContentControllers {
/**
* Gets N first auto-saved ("draft") entity IDs matching the search term.
*
- * @param string $search
- * The search term to match against entities.
* @param string $entity_type_id
* The entity type ID.
+ * @param string $search
+ * The search term to match against entities.
* @param \Drupal\Core\Cache\RefinableCacheableDependencyInterface $cacheability
* The cacheability of the given query, to be refined to match the
* refinements made to the query.
@@ -267,7 +266,7 @@ final class ApiContentControllers {
* @return array
* An array of entity IDs that match the search criteria.
*/
- private function getMatchingAutoSavedEntityIds(string $search, string $entity_type_id, RefinableCacheableDependencyInterface $cacheability): array {
+ private function getMatchingAutoSavedEntityIds(string $entity_type_id, string $search, RefinableCacheableDependencyInterface $cacheability): array {
$cacheability->addCacheTags([AutoSaveManager::CACHE_TAG]);
$auto_saved_entities_of_type = \array_filter($this->autoSaveManager->getAllAutoSaveList(TRUE), static fn (array $entry): bool => $entry['entity_type'] === $entity_type_id);
@@ -306,7 +305,6 @@ final class ApiContentControllers {
$ids = array_unique(array_merge($matching_ids, $matching_unsaved_ids));
arsort($ids);
$ids = array_slice($ids, 0, self::MAX_SEARCH_RESULTS, TRUE);
-
return $ids;
}
--
GitLab
From b3dbb0bfbed32fca0ef8d571a0529984dcad0ea0 Mon Sep 17 00:00:00 2001
From: Wim Leers <44946-wimleers@users.noreply.drupalcode.org>
Date: Mon, 30 Jun 2025 12:10:28 +0000
Subject: [PATCH 56/56] MR nits.
---
src/AutoSave/AutoSaveManager.php | 3 ++-
tests/src/Functional/XbContentEntityHttpApiTest.php | 3 ++-
ui/src/components/pageInfo/PageInfo.tsx | 1 +
ui/tests/e2e/navigation.cy.js | 2 +-
4 files changed, 6 insertions(+), 3 deletions(-)
diff --git a/src/AutoSave/AutoSaveManager.php b/src/AutoSave/AutoSaveManager.php
index 1f98ec4ee3..0d579a49ca 100644
--- a/src/AutoSave/AutoSaveManager.php
+++ b/src/AutoSave/AutoSaveManager.php
@@ -196,7 +196,8 @@ class AutoSaveManager implements EventSubscriberInterface {
*/
public function getAllAutoSaveList(bool $with_entities = FALSE): array {
return \array_map(fn (object $entry) => $entry->data +
- // Append the owner and updated data into each entry.
+ // Append the owner and updated data into each entry, and an entity object
+ // upon request.
[
// Remove the unique session key for anonymous users.
'owner' => \is_numeric($entry->owner) ? (int) $entry->owner : 0,
diff --git a/tests/src/Functional/XbContentEntityHttpApiTest.php b/tests/src/Functional/XbContentEntityHttpApiTest.php
index be1ea568d9..95dd9b9072 100644
--- a/tests/src/Functional/XbContentEntityHttpApiTest.php
+++ b/tests/src/Functional/XbContentEntityHttpApiTest.php
@@ -251,7 +251,8 @@ final class XbContentEntityHttpApiTest extends HttpApiTestBase {
$user = $this->createUser($permissions);
assert($user instanceof UserInterface);
$this->drupalLogin($user);
-
+ // We have a cache tag for page 2 as it's the homepage, set in system.site
+ // config.
$body = $this->assertExpectedResponse('GET', $url, [], 200, Cache::mergeContexts(['url.query_args:search', 'user.permissions'], $extraCacheContexts), Cache::mergeTags([AutoSaveManager::CACHE_TAG, 'config:system.site', 'http_response', 'xb_page:2', 'xb_page_list'], $extraCacheTags), 'UNCACHEABLE (request policy)', 'MISS');
assert(\is_array($body));
assert(\array_key_exists('1', $body) && \array_key_exists('links', $body['1']));
diff --git a/ui/src/components/pageInfo/PageInfo.tsx b/ui/src/components/pageInfo/PageInfo.tsx
index 9bf9aaea0f..5bf15cd1ce 100644
--- a/ui/src/components/pageInfo/PageInfo.tsx
+++ b/ui/src/components/pageInfo/PageInfo.tsx
@@ -142,6 +142,7 @@ const PageInfo = () => {
setEditorEntity('xb_page', String(item.id));
}
+ // @todo Fix in https://www.drupal.org/project/experience_builder/issues/3533096
useEffect(() => {
const debouncedSearch = debounce((term: string) => {
if (term.length === 0 || term.length >= 3) {
diff --git a/ui/tests/e2e/navigation.cy.js b/ui/tests/e2e/navigation.cy.js
index f224b0b232..4196b00e9a 100644
--- a/ui/tests/e2e/navigation.cy.js
+++ b/ui/tests/e2e/navigation.cy.js
@@ -44,7 +44,7 @@ describe('Navigation functionality', () => {
.and('contain.text', 'Empty Page');
});
- it('Verify if search works', () => {
+ it('Verify that search works', () => {
cy.loadURLandWaitForXBLoaded({ url: 'xb/xb_page/1' });
cy.findByTestId(navigationButtonTestId).click();
cy.findByLabelText('Search content').clear();
--
GitLab