#1727: Introduce internal class wrapping SplFileInfo #29461

joweecaquicla · 2020-08-10T18:03:49Z

Description (*)

This PR will introduce an internal class wrapping SplFileInfo.

Related Pull Requests

N/A

Fixed Issues (if relevant)

Fixes Introduce internal class wrapping SplFileInfo adobe-stock-integration#1727: Introduce internal class wrapping SplFileInfo

Manual testing scenarios (*)

Verify Image details in the media gallery after:

Uploading an image
Saving image from Adobe Stock
Clearing the media_gallery_asset table in database and running bin/magento media-gallery:sync command

Questions or comments

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)
All automated tests passed successfully (all builds are green)

…ng SplFileInfo - implement class wrapping SplFileInfo and modified the files to use the newly added classes

m2-assistant · 2020-08-10T18:03:52Z

Hi @joweecaquicla. Thank you for your contribution
Here is 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

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

joweecaquicla · 2020-08-10T18:04:58Z

@magento run all tests

…ntroduce-internal-class-wrapping-splfileinfo

sivaschenko

Thanks for the PR @joweecaquicla ! Please see my comments

sivaschenko · 2020-08-11T10:41:06Z

app/code/Magento/MediaGallerySynchronization/Model/Filesystem/FileInfo.php

+    /**
+     * @inheritDoc
+     */
+    public function getFileInfo($class_name = null): \SplFileInfo


Please remove the functions that are not currently needed (additional functions can be added to this class later if they will be required). Also please remove the \SplFileInfo references from this class

app/code/Magento/MediaGallerySynchronization/Model/Filesystem/GetFileInfo.php

…ng SplFileInfo - fix static and mftf fails, added integration tets

joweecaquicla · 2020-08-11T17:38:51Z

@magento run all tests

…ng SplFileInfo - fix static test

joweecaquicla · 2020-08-11T19:36:09Z

@magento run all tests

sidolov · 2020-08-12T16:22:04Z

app/code/Magento/MediaGallerySynchronization/Model/Filesystem/FileInfo.php

+ *
+ * @SuppressWarnings(PHPMD.TooManyFields)
+ */
+class FileInfo extends \SplFileInfo


It would be better to use ccomposition instead of inheritance

This class does not need to extend \SplFileInfo please remove the inheritance

sidolov · 2020-08-12T16:22:41Z

app/code/Magento/MediaGallerySynchronization/Model/Filesystem/FileInfo.php

+    /**
+     * @inheritDoc
+     */
+    public function getRealPath()


Strict type is missing

sidolov · 2020-08-12T16:22:58Z

app/code/Magento/MediaGallerySynchronization/Model/Filesystem/FileInfo.php

+        int $mTime,
+        int $cTime,
+        string $type,
+        $realPath


strict type is missing

sivaschenko

Thanks for update @joweecaquicla ! Please see review comments

sivaschenko · 2020-08-12T16:29:38Z

app/code/Magento/MediaGallerySynchronization/Model/Filesystem/FileInfo.php

+ *
+ * @SuppressWarnings(PHPMD.TooManyFields)
+ */
+class FileInfo extends \SplFileInfo


This class does not need to extend \SplFileInfo please remove the inheritance

sivaschenko · 2020-08-12T16:35:58Z

app/code/Magento/MediaGallerySynchronization/Model/Filesystem/FileInfo.php

+    /**
+     * @inheritDoc
+     */
+    public function getInode(): int


I don't think Inode method is used, please keep only properties/methods that are required

sivaschenko · 2020-08-12T16:37:51Z

...de/Magento/MediaGallerySynchronization/Test/Integration/Model/Filesystem/GetFileInfoTest.php

+        $path = $this->getImageFilePath($file);
+
+        $fileInfo = $this->getFileInfo->execute($path);
+        $this->assertNotEmpty($fileInfo->getPath());


Please add more strict verification $this->assertEquals($path, $fileInfo->getPath());, $this->assertEquals($mtime, $fileInfo-> getMTime());

The expected data can be retrieved from new \SplFileInfo($path)

…ng SplFileInfo - apply requested changes

joweecaquicla · 2020-08-13T10:49:42Z

@magento run all tests

magento-engcom-team · 2020-08-14T09:16:42Z

Hi @sivaschenko, thank you for the review.
ENGCOM-8011 has been created to process this Pull Request
✳️ @sivaschenko, could you please add one of the following labels to the Pull Request?

Label	Description
`Auto-Tests: Covered`	All changes in Pull Request is covered by auto-tests
`Auto-Tests: Not Covered`	Changes in Pull Request requires coverage by auto-tests
`Auto-Tests: Not Required`	Changes in Pull Request does not require coverage by auto-tests

…g-splfileinfo

sivaschenko · 2020-08-14T09:17:38Z

@magento run all tests

engcom-Lima · 2020-08-14T14:44:54Z

✔️ QA Passed
After successfully running the bin/magento media-gallery:sync command all images are displaying in the Media Gallery.
The number of images has not changed

m2-assistant · 2020-08-19T10:43:09Z

Hi @joweecaquicla, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

magento/adobe-stock-integration#1727: Introduce internal class wrappi…

5a500f3

…ng SplFileInfo - implement class wrapping SplFileInfo and modified the files to use the newly added classes

joweecaquicla added the Project: ASI label Aug 10, 2020

joweecaquicla requested a review from sivaschenko August 10, 2020 18:03

ghost added the Progress: pending review label Aug 10, 2020

magento-engcom-team added Component: MediaGallerySynchronization Release Line: 2.4 labels Aug 10, 2020

Merge branch '2.4-develop' of github.com:magento/magento2 into 1727-i…

bc24c44

…ntroduce-internal-class-wrapping-splfileinfo

sivaschenko requested changes Aug 11, 2020

View reviewed changes

ghost assigned sivaschenko Aug 11, 2020

sivaschenko added the Priority: P3 May be fixed according to the position in the backlog. label Aug 11, 2020

ghost added Progress: needs update and removed Progress: pending review labels Aug 11, 2020

sivaschenko added Progress: pending review Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. and removed Progress: needs update labels Aug 11, 2020

magento/adobe-stock-integration#1727: Introduce internal class wrappi…

9f02257

…ng SplFileInfo - fix static and mftf fails, added integration tets

magento/adobe-stock-integration#1727: Introduce internal class wrappi…

0b6ba91

…ng SplFileInfo - fix static test

sidolov requested changes Aug 12, 2020

View reviewed changes

ghost assigned sidolov Aug 12, 2020

ghost added Progress: needs update and removed Progress: pending review labels Aug 12, 2020

sivaschenko requested changes Aug 12, 2020

View reviewed changes

magento/adobe-stock-integration#1727: Introduce internal class wrappi…

89e7f22

…ng SplFileInfo - apply requested changes

joweecaquicla requested review from sivaschenko and sidolov August 13, 2020 10:49

sivaschenko approved these changes Aug 14, 2020

View reviewed changes

ghost added Progress: ready for testing and removed Progress: needs update labels Aug 14, 2020

sivaschenko added 2 commits August 14, 2020 10:16

Fixed static test

beae26b

Merge branch '2.4-develop' into 1727-introduce-internal-class-wrappin…

3752c1e

…g-splfileinfo

sivaschenko added the Auto-Tests: Covered All changes in Pull Request is covered by auto-tests label Aug 14, 2020

ghost added Progress: testing in progress and removed Progress: ready for testing labels Aug 14, 2020

engcom-Lima self-assigned this Aug 14, 2020

engcom-Lima added the QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope label Aug 14, 2020

ghost added Progress: extended testing and removed Progress: testing in progress labels Aug 14, 2020

engcom-Lima removed the QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope label Aug 14, 2020

ghost added Progress: accept and removed Progress: extended testing labels Aug 17, 2020

magento-engcom-team pushed a commit that referenced this pull request Aug 19, 2020

ENGCOM-8011: #1727: Introduce internal class wrapping SplFileInfo #29461

54633c4

magento-engcom-team merged commit c49766f into magento:2.4-develop Aug 19, 2020

sidolov added this to the 2.4.2 milestone Aug 20, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#1727: Introduce internal class wrapping SplFileInfo #29461

#1727: Introduce internal class wrapping SplFileInfo #29461

joweecaquicla commented Aug 10, 2020 •

edited by sivaschenko

Loading

m2-assistant bot commented Aug 10, 2020

joweecaquicla commented Aug 10, 2020

sivaschenko left a comment

sivaschenko Aug 11, 2020

joweecaquicla commented Aug 11, 2020

joweecaquicla commented Aug 11, 2020

sidolov Aug 12, 2020

sivaschenko Aug 12, 2020

sidolov Aug 12, 2020

sidolov Aug 12, 2020

sivaschenko left a comment

sivaschenko Aug 12, 2020

sivaschenko Aug 12, 2020

sivaschenko Aug 12, 2020

joweecaquicla commented Aug 13, 2020

magento-engcom-team commented Aug 14, 2020

sivaschenko commented Aug 14, 2020

engcom-Lima commented Aug 14, 2020

m2-assistant bot commented Aug 19, 2020

#1727: Introduce internal class wrapping SplFileInfo #29461

#1727: Introduce internal class wrapping SplFileInfo #29461

Conversation

joweecaquicla commented Aug 10, 2020 • edited by sivaschenko Loading

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

m2-assistant bot commented Aug 10, 2020

joweecaquicla commented Aug 10, 2020

sivaschenko left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joweecaquicla commented Aug 11, 2020

joweecaquicla commented Aug 11, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sivaschenko left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joweecaquicla commented Aug 13, 2020

magento-engcom-team commented Aug 14, 2020

sivaschenko commented Aug 14, 2020

engcom-Lima commented Aug 14, 2020

m2-assistant bot commented Aug 19, 2020

joweecaquicla commented Aug 10, 2020 •

edited by sivaschenko

Loading