File space leak in the lock provider

[Sgeleon2000]

Preconditions and environment

• Magento version 2.4.7

Steps to reproduce

When using file mode in the file lock provider, the system does not remove the file after use. If there are many variations of the cache hash, the directory size can become very large.

Expected result

The directory where cache files are saved should be small.

Actual result

If there are many variations of the cache hash, the directory size can become very large.

Additional information

To fix this, we can use the following patch:

Index: vendor/magento/framework/Lock/Backend/FileLock.php
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/vendor/magento/framework/Lock/Backend/FileLock.php b/vendor/magento/framework/Lock/Backend/FileLock.php
--- a/vendor/magento/framework/Lock/Backend/FileLock.php
+++ b/vendor/magento/framework/Lock/Backend/FileLock.php	(date 1738945943083)
@@ -147,6 +147,9 @@

         if (isset($this->locks[$lockFile]) && $this->tryToUnlock($this->locks[$lockFile])) {
             unset($this->locks[$lockFile]);
+
+            $this->fileDriver->deleteFile($lockFile);
+
             return true;
         }

Release note

No response

Triage and priority

• Severity: S0 - Affects critical data or functionality and leaves users without workaround.
• Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
• Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
• Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
• Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

[m2-assistant]

Hi @Sgeleon2000. Thank you for your report.
To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce.

• For more details, review the Magento Contributor Assistant documentation.
• Add a comment to assign the issue: @magento I am working on this
• To learn more about issue processing workflow, refer to the Code Contributions.

---

Join Magento Community Engineering Slack and ask your questions in #github channel.
⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.
🕙 You can find the schedule on the Magento Community Calendar page.
📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

[hostep]

#39372 already fixes this. It didn't get merged in time to be shipped with Magento 2.4.8, so it will be for Magento 2.4.9 next year unfortunately.

There are also some interesting finds documented in #39369, like this change: 65d8985 (which we reverted in a custom patch on our shops to keep lock files under control and having these block generation locks still use the database locking mechanism like how it was in Magento 2.4.6)

[m2-assistant]

Hi @engcom-Hotel. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
• 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
• 4. Verify that the issue is reproducible on 2.4-develop branch
  Details

  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
• 5. Add label Issue: Confirmed once verification is complete.
• 6. Make sure that automatic system confirms that report has been added to the backlog.

[engcom-Hotel]

Thanks @hostep for highlighting the PR which fixes this issue. We are closing this issue as it is duplicate of #39369.