Merge branch '5.2' into 5.3

* 5.2:
  [5.2] Add missing `@return` annotations
  [4.4] Add missing `@return` annotations
  Handle lock with long key
  #42227 update phpdoc to recommend createIndex over ensureIndex

Author: nicolas-grekas

Lock.php

@@ -49,6 +49,9 @@ public function __construct(Key $key, PersistingStoreInterface $store, float $tt
         $this->logger = new NullLogger();
     }
 
+    /**
+     * @return array
+     */
     public function __sleep()
     {
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);

Store/FlockStore.php

@@ -100,7 +100,7 @@ private function lock(Key $key, bool $read, bool $blocking)
         if (!$handle) {
             $fileName = sprintf('%s/sf.%s.%s.lock',
                 $this->lockPath,
-                preg_replace('/[^a-z0-9\._-]+/i', '-', $key),
+                substr(preg_replace('/[^a-z0-9\._-]+/i', '-', $key), 0, 50),
                 strtr(substr(base64_encode(hash('sha256', $key, true)), 0, 7), '/', '_')
             );
 

Store/MongoDbStore.php

@@ -168,7 +168,7 @@ private function skimUri(string $uri): string
      *
      * Alternatively the TTL index can be created manually on the database:
      *
-     *  db.lock.ensureIndex(
+     *  db.lock.createIndex(
      *      { "expires_at": 1 },
      *      { "expireAfterSeconds": 0 }
      *  )

Tests/Store/FlockStoreTest.php

@@ -83,4 +83,25 @@ public function testSaveSanitizeName()
 
         $store->delete($key);
     }
+
+    public function testSaveSanitizeLongName()
+    {
+        $store = $this->getStore();
+
+        $key = new Key(str_repeat(__CLASS__, 100));
+
+        $file = sprintf(
+            '%s/sf.Symfony-Component-Lock-Tests-Store-FlockStoreTestS.%s.lock',
+            sys_get_temp_dir(),
+            strtr(substr(base64_encode(hash('sha256', $key, true)), 0, 7), '/', '_')
+        );
+        // ensure the file does not exist before the store
+        @unlink($file);
+
+        $store->save($key);
+
+        $this->assertFileExists($file);
+
+        $store->delete($key);
+    }
 }