Indexable keys (#20)

* add option to index specific keys for a model * remove * ignore vscode * add title to search terms * refactor search terms implementation * fix phpstan * revert settings --------- Co-authored-by: Albin N <[email protected]>
ikoncept · Jun 19, 2024 · 39fd896 · 39fd896
1 parent cb1778d
commit 39fd896
Show file tree

Hide file tree

Showing 9 changed files with 117 additions and 44 deletions.
diff --git a/database/migrations/2024_06_18_124121_add_column_title_to_table_search_terms.php b/database/migrations/2024_06_18_124121_add_column_title_to_table_search_terms.php
@@ -0,0 +1,28 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+ /**
+ * Run the migrations.
+ */
+ public function up(): void
+ {
+ Schema::table('search_terms', function (Blueprint $table) {
+ $table->string('title')->after('locale')->nullable();
+ });
+ }
+
+ /**
+ * Reverse the migrations.
+ */
+ public function down(): void
+ {
+ Schema::table('search_terms', function (Blueprint $table) {
+ $table->dropColumn('title');
+ });
+ }
+};
diff --git a/src/Actions/BustCacheWithWebhook.php b/src/Actions/BustCacheWithWebhook.php
@@ -7,8 +7,11 @@
 
 class BustCacheWithWebhook
 {
- public function handle(array $keysToForget, array $tagsToFlush = [])
+ public function handle(array $keysToForget, array $tagsToFlush = []): void
  {
+ if (! config('fabriq.webhooks.enabled')) {
+ return;
+ }
  // 1 per 5 seconds for the same key
  RateLimiter::attempt(
  key: hash('adler32', json_encode([$keysToForget, $tagsToFlush])),

diff --git a/src/Concerns/HasPaths.php b/src/Concerns/HasPaths.php
@@ -25,7 +25,7 @@ public function getAbsolutePath($path): string
  {
  return config('fabriq.front_end_domain')
  .$this->currentLocaleString()
- .($path ?? '/'.$this->latestSlug->slug);
+ .$path;
  }
 
  public function getPermalinkPath(): string
@@ -74,30 +74,39 @@ public function getPathsAttribute(): Collection
 
  $supportedLocales = Fabriq::getModelClass('locale')->cachedLocales();
 
- foreach ($supportedLocales as $locale => $item) {
- $localizedSlugs = $this->menuItems->map(function ($item) use ($locale) {
- if (! $item->ancestors->count()) {
- return '';
- }
-
- return collect($item->ancestors)->reduce(function ($carry, $subItem) use ($locale) {
- /** @var MenuItem $subItem * */
- if (! $subItem->page) {
- return;
+ if ($this->menuItems !== null && $this->menuItems->count()) {
+ foreach ($supportedLocales as $locale => $item) {
+ $localizedSlugs = $this->menuItems->map(function ($item) use ($locale) {
+ if (! $item->ancestors->count()) {
+ return '';
  }
 
- return $carry.'/'.$subItem->getSlugString($locale);
- }, '').'/'.$item->getSlugString($locale);
- })->unique();
+ return collect($item->ancestors)->reduce(function ($carry, $subItem) use ($locale) {
+ /** @var MenuItem $subItem * */
+ if (! $subItem->page) {
+ return;
+ }
+
+ return $carry.'/'.$subItem->getSlugString($locale);
+ }, '').'/'.$item->getSlugString($locale);
+ })->unique();
 
- if (! $localizedSlugs->count()) {
- $slugGroups->push([$locale => $this->slugs->where('locale', $locale)->pluck('slug')]);
- } else {
  $slugGroups->push([$locale => $localizedSlugs]);
  }
+
+ return $slugGroups;
+ }
+
+ foreach ($supportedLocales as $locale) {
+ $slugGroups->push([
+ $locale => $this->slugs->where('locale', $locale)->pluck('slug')->map(function ($item) {
+ return '/'.$item;
+ }),
+ ]);
  }
 
  return $slugGroups;
+
  }
 
  public function getLocalizedPathsAttribute(): Collection

diff --git a/src/EventServiceProvider.php b/src/EventServiceProvider.php
@@ -24,6 +24,7 @@ class EventServiceProvider extends ServiceProvider
  DefinitionsUpdated::class => [
  UpdateSlugListener::class,
  CallCacheBustingWebhook::class,
+ UpdateSearchTerms::class,
  ],
  DefinitionsPublished::class => [
  BustPageCacheListener::class,

diff --git a/src/Helpers/RecursiveArrayValues.php b/src/Helpers/RecursiveArrayValues.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Ikoncept\Fabriq\Helpers;
+
+use Illuminate\Support\Collection;
+
+class RecursiveArrayValues
+{
+ public static function fromCollection(Collection $collection, ?array $keys = null, bool $unique = true): array
+ {
+ $arr = $collection->toArray();
+ array_walk_recursive($arr, function ($v, $k) use ($keys, &$val) {
+ if (in_array($k, $keys)) {
+ $val[] = strip_tags($v);
+ }
+ });
+
+ return $unique ? array_unique($val ?? []) : $val ?? [];
+ }
+}
diff --git a/src/Listeners/UpdateSearchTerms.php b/src/Listeners/UpdateSearchTerms.php
@@ -2,9 +2,11 @@
 
 namespace Ikoncept\Fabriq\Listeners;
 
+use Ikoncept\Fabriq\Fabriq;
+use Ikoncept\Fabriq\Helpers\RecursiveArrayValues;
 use Ikoncept\Fabriq\Models\SearchTerm;
-use Illuminate\Support\Collection;
 use Infab\TranslatableRevisions\Events\DefinitionsPublished;
+use Infab\TranslatableRevisions\Events\DefinitionsUpdated;
 
 class UpdateSearchTerms
 {
@@ -13,34 +15,55 @@ class UpdateSearchTerms
  *
  * @return void
  */
- public function __construct()
- {
-
- }
+ public function __construct() {}
 
  /**
  * Handle the event.
  *
- * @param object $event
  * @return void
  */
- public function handle(DefinitionsPublished $event)
+ public function handle(DefinitionsUpdated|DefinitionsPublished $event)
  {
- if (! $event->model->getRevisionOptions()->isIndexable) {
+ $options = $event->model->getRevisionOptions();
+
+ if (! $options->isIndexable) {
  return;
  }
 
- $event->model->paths->each(function ($path) use ($event) {
+ if ($options->indexFunction) {
+ call_user_func_array($options->indexFunction, [
+ 'args' => [
+ 'definitions' => $event->definitions,
+ ],
+ ]);
+
+ return;
+ }
+
+ if (get_class($event) === DefinitionsUpdated::class && Fabriq::getFqnModel('page') === get_class($event->model)) {
+
+ return;
+ }
+
+ $event->model->paths->each(function ($path) use ($event, $options) {
+
+ /** @var array<string, string> $path */
  $locale = collect($path)->keys()->first();
 
- $indexableKeys = $this->array_value_recursive($event->definitions[$locale], $event->model->getRevisionOptions()->indexableKeys);
+ if (! isset($event->definitions[$locale][$options->titleKey])) {
+ return;
+ }
+
+ $indexedKeys = RecursiveArrayValues::fromCollection($event->definitions[$locale], $options->indexableKeys);
+ $title = $event->definitions[$locale][$options->titleKey];
 
  $data = [
  'model_id' => $event->model->id,
  'model_type' => get_class($event->model),
+ 'title' => $title,
  'locale' => $locale,
  'path' => collect($path)->flatten()->first(),
- 'search_string' => implode(' ', $indexableKeys),
+ 'search_string' => implode(' ', $indexedKeys),
  ];
 
  SearchTerm::updateOrCreate([
@@ -50,16 +73,4 @@ public function handle(DefinitionsPublished $event)
  ], $data);
  });
  }
-
- protected function array_value_recursive(Collection $collection, ?array $keys = null, bool $unique = true): array
- {
- $arr = $collection->toArray();
- array_walk_recursive($arr, function ($v, $k) use ($keys, &$val) {
- if (in_array($k, $keys)) {
- $val[] = strip_tags($v);
- }
- });
-
- return $unique ? array_unique($val ?? []) : $val ?? [];
- }
 }
diff --git a/src/Models/Page.php b/src/Models/Page.php
@@ -115,7 +115,7 @@ public function getRevisionOptions(): RevisionOptions
  'smartBlock' => 'getSmartBlock',
  ])
  ->registerCacheTagsToFlush(['fabriq_menu', 'fabriq_pages|slug'])
- ->setIndexable(true, ['page_title', 'header']);
+ ->setIndexable(indexable: true, indexableKeys: ['page_title', 'header'], titleKey: 'page_title');
  }
 
  /**

diff --git a/tests/AdminUserTestCase.php b/tests/AdminUserTestCase.php
@@ -64,6 +64,7 @@ public function setUpDatabase($app)
 
  protected function getEnvironmentSetUp($app)
  {
+ $app['config']->set('fabriq.webhooks.enabled', false);
  $app['config']->set('database.default', 'mysql');
  $app['config']->set('database.connections.mysql', [
  'driver' => 'mysql',

diff --git a/tests/SearchTermsFeatureTest.php b/tests/SearchTermsFeatureTest.php
@@ -65,15 +65,15 @@ public function test_it_can_include_content_for_a_single_page()
  'model_id' => $page->id,
  'model_type' => config('fabriq.models.page'),
  'locale' => 'dk',
- 'path' => 'en-siee-saom-skau-paublisers',
+ 'path' => '/en-siee-saom-skau-paublisers',
  'search_string' => 'DK fosta titeln! DK andra titeln! En siee saom skau paublisers',
  ]);
 
  $this->assertDatabaseHas('search_terms', [
  'model_id' => $page->id,
  'model_type' => config('fabriq.models.page'),
  'locale' => 'en',
- 'path' => 'the-page-title-for-the-page',
+ 'path' => '/the-page-title-for-the-page',
  'search_string' => 'EN Box 1 title! EN Box 2 title! EN Box 3 title! The page title for the page',
  ]);