Use tmp folder from Magento installation to prevent path collisions #34272

alinalexandru · 2021-10-07T11:19:29Z

Description (*)

Use tmp folder relative to magento installation, instead of using the system tmp.
SYS_TMP is defined \Magento\Framework\Filesystem\DirectoryList, but \Magento\Framework\App\Filesystem\DirectoryList is used in \Magento\Analytics\Model\ExportDataHandler, so it means we can us TMP constant.
In this way, every magento2 installation will not interfere with each other.

Fixed Issues (if relevant)

Fixes Hardcoded path causes collisions #29373

Manual testing scenarios (*)

I see 2 ways to do manual test, as cron cleans everything during execution

Follow the steps from Hardcoded path causes collisions #29373 (comment)
Comment the finaly block from \Magento\Analytics\Model\ExportDataHandler

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
All automated tests passed successfully (all builds are green)

m2-assistant · 2021-10-07T11:19:32Z

Hi @alinalexandru. Thank you for your contribution
Here are some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
Semantic Version Checker

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests 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 Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

alinalexandru · 2021-10-07T11:23:34Z

@magento run all tests

magento-automated-testing · 2021-10-07T11:23:41Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

ihor-sviziev · 2021-10-07T12:52:49Z

@magento run all tests

magento-automated-testing · 2021-10-07T12:52:56Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

alinalexandru · 2021-10-07T15:14:48Z

@magento run all tests

magento-automated-testing · 2021-10-07T15:15:21Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

ihor-sviziev

Please fix failing static tests

alinalexandru · 2021-10-07T18:45:17Z

@magento run Static Tests

magento-automated-testing · 2021-10-07T18:45:21Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

alinalexandru · 2021-10-07T19:29:57Z

@ihor-sviziev Fixed

ihor-sviziev · 2021-10-07T20:15:54Z

@magento run all tests

magento-automated-testing · 2021-10-07T20:16:02Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

Den4ik

Hi @alinalexandru
Thanks for PR. Please look at my comment

Den4ik · 2021-10-07T21:15:20Z

app/code/Magento/Analytics/Model/ExportDataHandler.php

@@ -106,8 +106,10 @@ public function prepareExportData()
                $this->cryptographer->encode($tmpDirectory->readFile($this->getArchiveRelativePath()))
            );
        } finally {
-            $tmpDirectory->delete($this->getTmpFilesDirRelativePath());
-            $tmpDirectory->delete($this->getArchiveRelativePath());
+            if (isset($tmpDirectory) && $tmpDirectory instanceof WriteInterface) {


$tmpDirecory always will be WriteInterface and check $tmpDirectory instanceof WriteInterface is unnecessary

magento-engcom-team · 2021-10-08T13:30:42Z

Hi @ihor-sviziev, thank you for the review.
ENGCOM-9245 has been created to process this Pull Request

Den4ik

✅ Looks good for me. All tests passed

magento-engcom-team · 2021-10-10T17:55:33Z

Hi @Den4ik, thank you for the review.
ENGCOM-9245 has been created to process this Pull Request

sidolov · 2021-11-03T22:11:04Z

@magento convert to patch for 2.4.3

m2-github-services · 2021-11-03T22:11:56Z

@sidolov changes has been successfully converted for 2.4.3 version and pushed to the converted-magento-magento2-2.4.3 branch.

You may submit a pull request using the link: 2.4.3-release...magento:converted-magento-magento2-2.4.3

m2-github-services · 2021-11-03T22:12:37Z

@sidolov changes has been successfully converted for 2.4.3 version and pushed to the converted-magento-magento2-2.4.3 branch.

You may submit a pull request using the link: 2.4.3-release...magento:converted-magento-magento2-2.4.3

slavvka · 2021-11-10T19:14:16Z

@magento run all tests

magento-automated-testing · 2021-11-10T19:14:25Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

magento-automated-testing · 2021-11-11T07:56:49Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

Den4ik · 2021-11-12T14:00:11Z

@magento run Functional Tests EE

magento-automated-testing · 2021-11-12T14:00:18Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Lima · 2022-05-13T10:25:33Z

Hi @alinalexandru , @Den4ik , @ihor-sviziev Thanks for your contribution and collaboration .
Tried reproducing the issue in 2.4-develop version before testing the given PR fix code referring PR description/ comments.
Issue is not reproducible and below is the information on this:

Pre Conditions

Installed two magento instances with 2.4-develop version in my local with sample data.
Used PHP 7.4.29 version in my ubuntu system.

Reproducible steps

Followed the given steps in first magento instance issue comment
Repeated same steps in 2nd Magento instance as well.
Commented the finally block from \Magento\Analytics\Model\ExportDataHandler in both the instances.
Cross checked the given path /tmp/analytics/tmp/ in the local system .

Observation - Analytics folder was not found in the given path /tmp/analytics/tmp/

Kindly let me know based on what factors files will get generated in given path, So, that we can proceed further in our testing.

engcom-Alfa · 2022-06-03T11:26:17Z

✔️ QA Passed

Preconditions:

Should use the local system in which we should have all Magento instance relevant installed.
We should have 2 Magento latest versioned instances in the same system to test.

Manual testing scenario:

There are code changes done in 2 of the php files commented here, we should do the same code changes in both the instances of our Magento local code.
Download the n98-magerun2-latest.phar file from here.
Rename the file n98-magerun2-latest.phar to n98-magerun2.phar.
Copy the downloaded file inside both the local Magento instances' root folder.
Run the command php -d upload_tmp_dir=/tmp n98-magerun2.phar sys:cron:run analytics_collect_data from the Magento root folder of both instances one by one.

Before: ✖️ The responded command used to return the folder path from both the instances which is a common local system TEMP folder.

After: ✔️ The responded command returns the folder path from both the instances which is a unique <Magento_root>/var/ folder of each Magento instance only.

Since it is a specific case where the reporting folder has been changed, and so no additional regression test case are required for this case.
Note: I think, it is good to have the Magento doc to be updated with this information, even I couldn't find any info relevant to it as of now.

magento-engcom-team added the Release Line: 2.4 label Oct 7, 2021

paras89 added the mmro-contribution-day2021 label Oct 7, 2021

alinalexandru force-pushed the bugfix/issue-29373 branch from 1e57e3f to cc97c27 Compare October 7, 2021 12:39

ihor-sviziev self-assigned this Oct 7, 2021

m2-community-project bot added the Progress: review label Oct 7, 2021

ihor-sviziev changed the title ~~#29373: Hardcoded path causes collisions~~ Use tmp folder from Magento installation to prevent path collisions Oct 7, 2021

alinalexandru force-pushed the bugfix/issue-29373 branch from cc97c27 to c71461b Compare October 7, 2021 15:11

ihor-sviziev requested changes Oct 7, 2021

View reviewed changes

m2-community-project bot added Progress: needs update and removed Progress: review labels Oct 7, 2021

alinalexandru force-pushed the bugfix/issue-29373 branch from c71461b to 2907c0b Compare October 7, 2021 18:20

Den4ik requested changes Oct 7, 2021

View reviewed changes

m2-community-project bot assigned Den4ik Oct 7, 2021

m2-community-project bot added Progress: ready for testing and removed Progress: needs update labels Oct 8, 2021

magento-engcom-team added the Component: Analytics label Oct 8, 2021

Den4ik approved these changes Oct 10, 2021

View reviewed changes

sidolov added the Priority: P3 May be fixed according to the position in the backlog. label Oct 28, 2021

sidolov added Priority: P1 Once P0 defects have been fixed, a defect having this priority is the next candidate for fixing. and removed Priority: P3 May be fixed according to the position in the backlog. labels Apr 21, 2022

engcom-Alfa self-assigned this Apr 27, 2022

m2-community-project bot added Progress: testing in progress and removed Progress: ready for testing labels Apr 27, 2022

engcom-Lima self-assigned this May 13, 2022

m2-community-project bot added Progress: ready for testing Progress: testing in progress and removed Progress: testing in progress Progress: ready for testing labels May 13, 2022

m2-community-project bot added Progress: accept and removed Progress: testing in progress labels Jun 3, 2022

magento-devops-reposync-svc merged commit b03df92 into magento:2.4-develop Jun 11, 2022

Use tmp folder from Magento installation to prevent path collisions #34272

Use tmp folder from Magento installation to prevent path collisions #34272

Uh oh!

Conversation

alinalexandru commented Oct 7, 2021

Description (*)

Fixed Issues (if relevant)

Manual testing scenarios (*)

Contribution checklist (*)

Uh oh!

m2-assistant bot commented Oct 7, 2021

Uh oh!

alinalexandru commented Oct 7, 2021

Uh oh!

magento-automated-testing bot commented Oct 7, 2021

Uh oh!

ihor-sviziev commented Oct 7, 2021

Uh oh!

magento-automated-testing bot commented Oct 7, 2021

Uh oh!

alinalexandru commented Oct 7, 2021

Uh oh!

magento-automated-testing bot commented Oct 7, 2021

Uh oh!

ihor-sviziev left a comment

Choose a reason for hiding this comment

Uh oh!

alinalexandru commented Oct 7, 2021

Uh oh!

magento-automated-testing bot commented Oct 7, 2021

Uh oh!

alinalexandru commented Oct 7, 2021

Uh oh!

ihor-sviziev commented Oct 7, 2021

Uh oh!

magento-automated-testing bot commented Oct 7, 2021

Uh oh!

Den4ik left a comment

Choose a reason for hiding this comment

Uh oh!

Den4ik Oct 7, 2021

Choose a reason for hiding this comment

Uh oh!

magento-engcom-team commented Oct 8, 2021

Uh oh!

Den4ik left a comment

Choose a reason for hiding this comment

Uh oh!

magento-engcom-team commented Oct 10, 2021

Uh oh!

sidolov commented Nov 3, 2021

Uh oh!

m2-github-services commented Nov 3, 2021

Uh oh!

m2-github-services commented Nov 3, 2021

Uh oh!

slavvka commented Nov 10, 2021

Uh oh!

magento-automated-testing bot commented Nov 10, 2021

Uh oh!

magento-automated-testing bot commented Nov 11, 2021

Uh oh!

Den4ik commented Nov 12, 2021

Uh oh!

magento-automated-testing bot commented Nov 12, 2021

Uh oh!

engcom-Lima commented May 13, 2022

Uh oh!

engcom-Alfa commented Jun 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

engcom-Alfa commented Jun 3, 2022 •

edited

Loading