FileVisibility stores full entity objects, causing memory accumulation (#3583772) · Issues · project / file_visibility

FileVisibility stores full entity objects, causing memory accumulation

>>> [!note] Migrated issue   Reported by: [herved](https://www.drupal.org/user/2197136) Related to !15 >>> <h3 id="summary-problem-motivation">Problem/Motivation</h3> FileVisibility::updateFilesVisibility() queues full entity objects in $entities[] for deferred processing via KernelEvents::RESPONSE. In long-lived processes (Drush, Behat, cron,...), these objects accumulate over the entire process lifetime, consuming significant memory since they are not garbage collected. For historical context, the defer was introduced in <a href="https://git.drupalcode.org/project/file_visibility/-/work_items/3536831" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/file_visibility/-/work_items/3536831</a>. track_usage's Recorder service, which has the same deferred processing pattern, already handles this correctly by storing lightweight identifiers (entity type, ID, revision) instead of full objects. <h4 id="summary-steps-reproduce">Steps to reproduce</h4> 1. Fresh Drupal install <pre>ddev drush si standard -y ddev drush en file_visibility_track_usage -y</pre>2. Create a TrackConfig and point file_visibility_track_usage at it. <pre>ddev drush php:eval "   \Drupal\track_usage\Entity\TrackConfig::create([     'id'                => 'file_visibility',     'label'             => 'File Visibility',     'realTimeRecording' => TRUE,     'activeRevision'    => FALSE,     'source'            => ['node' => []],     'traversable'       => [],     'target'            => ['file' => []],     'status'            => TRUE,   ])->save();   \Drupal::configFactory()     ->getEditable('file_visibility_track_usage.settings')     ->set('track_usage_config', 'file_visibility')     ->save();   echo 'Done.' . PHP_EOL; "</pre>3. Save the following script below as memory_hog.php. <pre><?php gc_collect_cycles(); $before = memory_get_usage(FALSE); $storage = \Drupal::entityTypeManager()->getStorage('node'); for ($i = 0; $i < 1000; $i++) {   $node = \Drupal\node\Entity\Node::create([     'type'   => 'page',     'title'  => 'memtest_' . $i,     'status' => 1,     'uid'    => 1,   ]);   $node->save();   $storage->delete([$node]); } gc_collect_cycles(); $after = memory_get_usage(FALSE); printf("before: %.1f MB\n", $before / 1048576); printf("after:  %.1f MB\n", $after  / 1048576); printf("delta:  %.1f MB\n", ($after - $before) / 1048576);</pre>4. Execute it <code>ddev drush php:script memory_hog.php</code> Notice the memory consumption is high, on my machine: <pre>before: 8.5 MB after:  58.3 MB delta:  49.8 MB</pre>After provided fix: <pre>before: 8.5 MB after:  13.3 MB delta:  4.8 MB</pre><h3 id="summary-proposed-resolution">Proposed resolution</h3> Store entity type/ID/revision in FileVisibility::$entities instead of full entity objects, consistent with track_usage's Recorder. <h3 id="summary-remaining-tasks">Remaining tasks</h3> ? <h3 id="summary-ui-changes">User interface changes</h3> None <h3 id="summary-api-changes">API changes</h3> None <h3 id="summary-data-model-changes">Data model changes</h3> None

issue