[Instantsearch] Config refactor #769

Jade-GG · 2025-03-10T13:17:00Z

This PR refactors how the config files are used:

Store-specific values now go under /config/rapidez/stores/[store_code]/[config_file].
- This means that the themes and checkout_steps variables no longer have their own store-specific
Move window.config data to a separate web route
Move useAttributes data directly into the window.config data
All searchkit configuration now gets mapped and merged directly in php so that we don't have to do any mapping on the frontend
- Side effect of this is that sorting label translations are now managed in your json translations
indexer.php config has been removed:
- Adding custom models should be done by adding them to models.php
- Changing the indexed visibility can be done by extending product.php and overwriting the shouldBeSearchable() function.

…ntsearch-index-cleanup

…com/rapidez/core into feature/instantsearch-index-cleanup

…gs-refactor

…ntsearch-index-cleanup

…gs-refactor

resources/views/layouts/app.blade.php

routes/web.php

src/Http/ViewComposers/ConfigComposer.php

src/Models/Product.php

src/Rapidez.php

…/core into feature/configs-refactor

royduin

What are the pros and cons of this approach?

lang/en.json

royduin · 2025-03-18T15:18:47Z

resources/js/components/Listing/Listing.vue

-        this.loaded = Object.keys(this.attributes).length > 0
+        this.loaded = true


Where was this for?

this is probably unnecessary now as we also check for the searchClient (v-if="loaded && searchClient"). I've left it here for now just in case it broke something by removing it.

Can't we handle the searchClient check here so we don't have to do that in the template?

royduin · 2025-03-18T15:24:13Z

resources/views/layouts/config.blade.php

Do we need a view for this? Maybe just handle it with in the route file?

Maybe, I wanted to keep things flexible for now so that you can always add anything else you might need here.

royduin · 2025-03-18T15:51:27Z

routes/web.php

@@ -20,4 +21,11 @@
    Route::get('checkout/{step?}', config('rapidez.routing.controllers.checkout'))->middleware('auth:magento-cart')->name('checkout');
    Route::get('search', config('rapidez.routing.controllers.search'))->name('search');
    Route::fallback(config('rapidez.routing.controllers.fallback'));
+
+    Route::middleware('cache.headers:public;max_age=3600;s_maxage=3600;stale_while_revalidate=3600;etag')->group(function () {


Do we really want to cache this? We also do have a cachekey config which changes when the cache is cleared; on the frontend that key will be compared and flushes the local storage so outdated data will be refreshed. There are probably more cases where the config is dynamic?

@indykoning what do you think?

src/Models/Attribute.php

royduin · 2025-03-18T15:54:38Z

src/Models/Product.php

+        if (! in_array($this->visibility, [
+            static::VISIBILITY_IN_CATALOG,
+            static::VISIBILITY_IN_SEARCH,
+            static::VISIBILITY_BOTH,
+        ])) {


With this change it's not configurable anymore?

My take was that if you want to configure this, you can overwrite the function in your own product model. However with the searchable refactor that Indy did I'm not sure if this would still work. 🤔

src/Rapidez.php

royduin · 2025-03-18T16:02:26Z

src/RapidezServiceProvider.php

@@ -285,6 +262,19 @@ protected function registerConfigs(): self
            $this->mergeConfigFrom(__DIR__ . '/../config/rapidez/' . $configFile . '.php', 'rapidez.' . $configFile);
        }

+        // Find all store-specific config files and merge them in
+        // TODO: Add how to use this in the Rapidez documentation
+        foreach (glob(__DIR__ . '../config/rapidez/stores/*/*.php') as $configFile) {


Isn't this a heavy task? Does this work with the config caching?

Not really, at least not in my experience. You could, of course, theoretically put a million dummy files into the folder and then it'll definitely start getting a bit heavy. But under normal use I don't see this having any meaningful impact.

The caching will end up working the same, as the paths don't change dynamically. Essentially, if the caching works for the code above (which it does) then it also works for this.

Glob can actually be quite a heavy operation since it's an IO operation, as well as a recursive one.
We probably do not want this running on every web request. We might want to check wether the config is cached and if so skip this code.

Hmm, we could cache the list of config files we get out of the glob and the few lines after? Keeps the code relatively simple and saves on the performance cost of that part.

Doesn't Laravel provide something for this?

Maybe simply override the config part from Laravel and add a store check there?

Or reverse it; currently we're checking all files but we do know the stores from the database, maybe use that? Or keep a "custom store config list" somewhere?

This glob won't be executed from the core as from the core you will never have any store configs. That will be within your project.

…/core into feature/configs-refactor

Jade-GG and others added 15 commits March 6, 2025 11:34

Cleanup index usages

b7d1435

Merge branch 'feature/instantsearch-config-update' into feature/insta…

dda05cf

…ntsearch-index-cleanup

Use searchableAs & don't use static calling for now

f2693bc

Fix indexer types & simplify config for extra models

6a55b6d

Apply fixes from Duster

fd7879b

Use index name through model everywhere

1a3c659

Merge branch 'feature/instantsearch-index-cleanup' of https://github.…

9c23681

…com/rapidez/core into feature/instantsearch-index-cleanup

Merge branch 'feature/instantsearch-index-cleanup' into feature/confi…

7aa9813

…gs-refactor

Refactor config files

f30f748

Merge branch 'feature/instantsearch-config-update' into feature/insta…

f76d76d

…ntsearch-index-cleanup

Merge branch 'feature/instantsearch-index-cleanup' into feature/confi…

45eca3a

…gs-refactor

Merge branch 'feature/instantsearch-config-update' into feature/confi…

13d871f

…gs-refactor

Move sortings to php

7232049

Make facets come from php

6557c98

Apply fixes from Duster

d669982

Jade-GG requested review from royduin and indykoning as code owners March 10, 2025 13:17

Jade-GG added 4 commits March 10, 2025 14:22

Fix translations

5fa00c9

Add documentation todo

4cc9d14

Merge branch 'feature/instantsearch-config-update' into feature/confi…

5e049fb

…gs-refactor

Merge branch 'feature/instantsearch-config-update' into feature/confi…

a02f866

…gs-refactor

indykoning requested changes Mar 11, 2025

View reviewed changes

Jade-GG and others added 5 commits March 12, 2025 11:41

Feedback

75af11b

Add defaults to reset to when switching stores

8b6360d

Apply fixes from Duster

ed8369b

Re-add registerthemes to register function

c2ab9ec

Merge branch 'feature/configs-refactor' of https://github.com/rapidez…

3ce0983

…/core into feature/configs-refactor

royduin requested changes Mar 18, 2025

View reviewed changes

Jade-GG and others added 2 commits March 19, 2025 10:41

Use php translations & add proper fallbacks

7ddb3d2

Apply fixes from Duster

0d2f9ff

Jade-GG added 2 commits March 19, 2025 10:51

Add comment explaining loop

ffe28b6

Merge branch 'feature/configs-refactor' of https://github.com/rapidez…

3d4dd33

…/core into feature/configs-refactor

royduin mentioned this pull request Mar 25, 2025

Added config for success fail redirect path #780

Merged

Remove glob

ae03f59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Instantsearch] Config refactor #769

[Instantsearch] Config refactor #769

Jade-GG commented Mar 10, 2025 •

edited

Loading

royduin left a comment

royduin Mar 18, 2025

Jade-GG Mar 19, 2025

royduin Mar 20, 2025

royduin Mar 18, 2025

Jade-GG Mar 19, 2025

royduin Mar 18, 2025

Jade-GG Mar 19, 2025

royduin Mar 18, 2025

Jade-GG Mar 19, 2025

royduin Mar 18, 2025

Jade-GG Mar 19, 2025

indykoning Mar 24, 2025

Jade-GG Mar 25, 2025

royduin Mar 25, 2025

royduin Mar 25, 2025

		this.loaded = Object.keys(this.attributes).length > 0
		this.loaded = true

[Instantsearch] Config refactor #769

Are you sure you want to change the base?

[Instantsearch] Config refactor #769

Conversation

Jade-GG commented Mar 10, 2025 • edited Loading

royduin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jade-GG commented Mar 10, 2025 •

edited

Loading