Nav output appears to query entire entries and any related values, when using the Eloquent driver

[justindantzer]

Bug description

When outputting a nav, using the standard nav:name_here tag, it appears that all associated data to the nav entries are queried for, including related assets or relationships attached via Bard sets. This is resulting in many extra queries on all pages, depending on the size and context of your content. I would have expected that only fields needed to build the structure would be queried, such as parent relationship, url slug, title, and any custom fields included.

As an example, my site has ~20 pages, each with a few images or references to PDF files, resulting in ~100 extra queries on each page.

Edit: Current usage
{{ nav:main_navigation select="title|url" }}

How to reproduce

• Setup Eloquent Driver
• Setup collections to store with Eloquent
• Create a collection with a bard field that uses sets, and include a set with an asset field
• create a few entries, being sure to include attached assets
• Add the collection items to a nav
• Output the nav on a template
• View queries issued on the page (Laravel Debugbar helped)

Logs

Environment

Environment
Laravel Version: 12.51.0
PHP Version: 8.5.2
Composer Version: 2.9.3
Environment: local
Debug Mode: ENABLED
Maintenance Mode: OFF
Locale: en

Cache
Config: NOT CACHED
Events: NOT CACHED
Routes: NOT CACHED
Views: CACHED

Drivers
Broadcasting: log
Cache: redis
Database: mysql
Logs: stack / single, daily
Mail: smtp
Queue: database
Session: file

Storage
public/storage: LINKED

Nova
Authentication: ENABLED
Authentication Guard: web
Authentication User: App\Models\User
Currency: USD
Global Debounce: 0.5s
Global Search: ENABLED
Notification Center: ENABLED
Notification Polling: 7s
Pagination: simple
Password Reset: ENABLED
Password Reset Broker: null
RTL Enabled: OFF
Storage Disk: public
Theme Switcher: ENABLED
Version: 5.7.7 (Silver Surfer)

Spatie Permissions
Features Enabled: Default
Version: 6.24.1

Statamic
Addons: 5
Sites: 1
Stache Watcher: Enabled (auto)
Static Caching: Disabled
Version: 5.73.6 PRO

Statamic Addons
anakadote/statamic-recaptcha: 2.0
rias/statamic-redirect: 3.14.1
statamic-rad-pack/runway: 8.9.0
statamic/eloquent-driver: 4.36.0
statamic/seo-pro: 6.11.7

Statamic Eloquent Driver
Asset Containers: eloquent
Assets: eloquent
Blueprints: eloquent
Collection Trees: eloquent
Collections: eloquent
Entries: eloquent
Fieldsets: eloquent
Form Submissions: eloquent
Forms: eloquent
Global Sets: eloquent
Global Variables: eloquent
Navigation Trees: eloquent
Navigations: eloquent
Revisions: file
Sites: eloquent
Taxonomies: eloquent
Terms: eloquent
Tokens: eloquent

Additional details

No response

[ryanmitchell]

That's not unique to eloquent driver. The stache implementation does the same and it's documented behaviour.

You can use the select parameter:
https://statamic.dev/tags/nav#overview

[justindantzer]

@ryanmitchell I should have noted that I am actively using the select parameter like:

{{ nav:main_navigation select="title|url" }}

The select parameter seems to only affect what data is returned, not what data is selected from the data source.

[ryanmitchell]

Again from what I can see (happy to be proven wrong!) thats how core/stache works. We can only offer a different storage layer - to maintain compatibility we can't change behaviour. From what I can see there is no 'select' or equivalent which goes through to the query layer on nav tags.

[justindantzer]

@ryanmitchell I can appreciate wanting to keep the behavior the same across the various storage options.

FWIW, I've been able to overcome some of the extraneous queries by overriding Statamic\Tags\Nav and extending the default Statamic\Eloquent\Entries\Entry.

At the end of the Entry::fromModel() method, syncOriginal() is called on the returned entry, which results in a second query for each entry and filling any missing data that may have been intentionally omitted. Removing that in my extension helped reduce the overall queries on each page.

As for the Nav override, with my currently limited knowledge of the nav tree building, it looks like I can pre-load the Blink cache for entries, with limited data selected. In doing so, I've cut ~100 queries on each page. I've still got a few to look into, but this has made a big difference. I'm sure there are improvements to be made, but I am hopeful with this solution. Unsure of any potential issues as of yet.

<?php

namespace App\Tags;

use App\Statamic\NavEntry;
use Statamic\Eloquent\Entries\EntryModel;
use Statamic\Facades\Site;
use Statamic\Facades\Blink;
use Statamic\Tags\Nav as StatamicNav;
use Statamic\Facades\Nav as NavFacade;

class Nav extends StatamicNav
{
    protected function structure($handle)
    {
        $this->preloadLightweightEntries($handle);

        return parent::structure($handle);
    }

    protected function preloadLightweightEntries(string $handle): void
    {
        $nav = NavFacade::findByHandle($handle);
        if (! $nav) {
            return;
        }

        $site = $this->params->get('site', Site::current()->handle());
        $tree = $nav->in($site);
        if (! $tree) {
            return;
        }

        $refs = $this->extractEntryRefs($tree->tree());
        if (empty($refs)) {
            return;
        }

        $blink = Blink::store('structure-entries');
        $unloaded = collect($refs)->reject(fn($ref) => $blink->has($ref))->values()->all();
        if (empty($unloaded)) {
            return;
        }

        $models = EntryModel::query()
            ->whereIn('id', $unloaded)
            ->select(['id', 'site', 'origin_id', 'published', 'slug', 'uri', 'collection', 'blueprint', 'date', 'order'])
            ->selectRaw(
                "JSON_OBJECT('title', JSON_UNQUOTE(JSON_EXTRACT(data, '$.title'))) as data"
            )
            ->get();

        foreach ($models as $model) {
            $entry = NavEntry::fromModel($model);
            $blink->put($entry->id(), $entry);
        }
    }

    private function extractEntryRefs(array $branches): array
    {
        $refs = [];
        foreach ($branches as $branch) {
            if (! empty($branch['entry'])) {
                $refs[] = $branch['entry'];
            }
            if (! empty($branch['children'])) {
                $refs = array_merge($refs, $this->extractEntryRefs($branch['children']));
            }
        }

        return $refs;
    }
}