Skip to content

[Cache] Reserve numeric keys when doing memory leak prevention #47884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

simoheinonen
Copy link
Contributor

@simoheinonen simoheinonen commented Oct 17, 2022

Q A
Branch? 4.4
Bug fix? yes
New feature? no
Deprecations? no
Tickets
License MIT
Doc PR

getItem() started to return invalid entries after 1000 calls because array_slice() doesn't preserve numeric keys

<?php

require_once 'vendor/autoload.php';

use Symfony\Component\Cache\Adapter\FilesystemAdapter;

// works:
$cache = new FilesystemAdapter('foo-namespace');
$keys = range(0, 999);
foreach ($keys as $key) {
    $cacheItem = $cache->getItem((string) $key);
    $cacheItem->set('value: ' . $key);
    $cache->save($cacheItem);
}
echo $cache->getItem('25')->get() . PHP_EOL; // "value: 25"

// doesn't work:
$cache = new FilesystemAdapter('xyz-namespace');
$keys = range(0, 1000);
foreach ($keys as $key) {
    $cacheItem = $cache->getItem((string) $key);
    $cacheItem->set('value: ' . $key);
    $cache->save($cacheItem);
}
echo $cache->getItem('25')->get() . PHP_EOL; // "value: 525"

after:

// works:
$cache = new FilesystemAdapter('xyz-namespace');
$keys = range(0, 1000);
foreach ($keys as $key) {
    $cacheItem = $cache->getItem((string) $key);
    $cacheItem->set('value: ' . $key);
    $cache->save($cacheItem);
}
echo $cache->getItem('25')->get() . PHP_EOL; // "value: 25"

@carsonbot
Copy link

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (see https://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
  • Features and deprecations must be submitted against the 6.2 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

@simoheinonen simoheinonen force-pushed the invalid_cache_keys_after_memory_leak_prevention branch from 7a0ff86 to 5c61350 Compare October 17, 2022 09:42
@nicolas-grekas
Copy link
Member

Good catch, thanks @simoheinonen.

@nicolas-grekas nicolas-grekas merged commit dbbf46c into symfony:4.4 Oct 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants