Skip to content
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

#1727: Introduce internal class wrapping SplFileInfo #29461

Conversation

joweecaquicla
Copy link

@joweecaquicla joweecaquicla commented Aug 10, 2020

Description (*)

This PR will introduce an internal class wrapping SplFileInfo.

Related Pull Requests

N/A

Fixed Issues (if relevant)

  1. 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:

  1. Uploading an image
  2. Saving image from Adobe Stock
  3. 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
Copy link

m2-assistant bot commented Aug 10, 2020

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:

  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE,
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. 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
Copy link
Author

@magento run all tests

Copy link
Member

@sivaschenko sivaschenko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR @joweecaquicla ! Please see my comments

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@ghost ghost assigned sivaschenko Aug 11, 2020
@sivaschenko sivaschenko added the Priority: P3 May be fixed according to the position in the backlog. label Aug 11, 2020
@sivaschenko 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
…ng SplFileInfo - fix static and mftf fails, added integration tets
@joweecaquicla
Copy link
Author

@magento run all tests

@joweecaquicla
Copy link
Author

@magento run all tests

*
* @SuppressWarnings(PHPMD.TooManyFields)
*/
class FileInfo extends \SplFileInfo
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be better to use ccomposition instead of inheritance

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

/**
* @inheritDoc
*/
public function getRealPath()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Strict type is missing

int $mTime,
int $cTime,
string $type,
$realPath
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

strict type is missing

Copy link
Member

@sivaschenko sivaschenko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for update @joweecaquicla ! Please see review comments

*
* @SuppressWarnings(PHPMD.TooManyFields)
*/
class FileInfo extends \SplFileInfo
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

/**
* @inheritDoc
*/
public function getInode(): int
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

$path = $this->getImageFilePath($file);

$fileInfo = $this->getFileInfo->execute($path);
$this->assertNotEmpty($fileInfo->getPath());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

@joweecaquicla
Copy link
Author

@magento run all tests

@magento-engcom-team
Copy link
Contributor

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

@sivaschenko
Copy link
Member

@magento run all tests

@sivaschenko sivaschenko added the Auto-Tests: Covered All changes in Pull Request is covered by auto-tests label Aug 14, 2020
@engcom-Lima engcom-Lima self-assigned this Aug 14, 2020
@engcom-Lima
Copy link
Contributor

✔️ 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
Screenshot_103

@engcom-Lima engcom-Lima added the QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope label Aug 14, 2020
@engcom-Lima engcom-Lima removed the QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope label Aug 14, 2020
@magento-engcom-team magento-engcom-team merged commit c49766f into magento:2.4-develop Aug 19, 2020
@m2-assistant
Copy link

m2-assistant bot commented Aug 19, 2020

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.

@sidolov sidolov added this to the 2.4.2 milestone Aug 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Component: MediaGallerySynchronization Priority: P3 May be fixed according to the position in the backlog. Progress: accept Project: ASI Release Line: 2.4 Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Introduce internal class wrapping SplFileInfo
5 participants