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

Upgrade flysystem to version ^2.0 #32534

Closed
wants to merge 6 commits into from

Conversation

engcom-Kilo
Copy link
Contributor

@engcom-Kilo engcom-Kilo commented Mar 17, 2021

Description (*)

Related Pull Requests

https://github.com/magento/partners-magento2ee/pull/530

Fixed Issues (if relevant)

Resolves #31177

Manual testing scenarios (*)

  1. ...
  2. ...

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)

@m2-assistant
Copy link

m2-assistant bot commented Mar 17, 2021

Hi @engcom-Kilo. 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 php8-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
  13. 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

@engcom-Kilo engcom-Kilo changed the title Upgrade flysystem to version ^2.0 [WIP] Upgrade flysystem to version ^2.0 Mar 17, 2021
@engcom-Kilo engcom-Kilo force-pushed the Flysystem branch 4 times, most recently from 84dc243 to 8013bea Compare March 18, 2021 12:39
@engcom-Kilo
Copy link
Contributor Author

@magento run all tests

@m2-community-project m2-community-project bot added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Mar 19, 2021
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 pull request! Please see my comments

app/code/Magento/AwsS3/Driver/AwsS3.php Outdated Show resolved Hide resolved
app/code/Magento/AwsS3/Model/Cached/CachedAdapter.php Outdated Show resolved Hide resolved
/**
* Get file metadata.
*
* @deplacated There is no getMetadata() method in FilesystemAdapter anymore.
Copy link
Member

Choose a reason for hiding this comment

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

Do we need to introduce this deplacated method?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There are several clients for this method:
Magento\Eav\Model\Attribute\Data\Image, Magento\MediaGallerySynchronization\Model\CreateAssetFromFile, Magento\Framework\File\Mime.

Copy link
Member

Choose a reason for hiding this comment

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

The comment and @deplacated annotation should be removed.

Is implementing League\Flysystem\FilesystemAdapter necessary?

/**
* Remote storage cache interface.
*/
interface CacheInterface extends FilesystemReader
Copy link
Member

@sivaschenko sivaschenko Mar 19, 2021

Choose a reason for hiding this comment

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

I wouldn't introduce extension points (interfaces) if that is not necessary

Copy link
Contributor Author

@engcom-Kilo engcom-Kilo Mar 19, 2021

Choose a reason for hiding this comment

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

Moved Reader interface methods to Cache interface. Removed inheritance

app/code/Magento/RemoteStorage/Model/GetPathInfo.php Outdated Show resolved Hide resolved
# Conflicts:
#	composer.lock
@engcom-Kilo engcom-Kilo force-pushed the Flysystem branch 3 times, most recently from 7a88b70 to 81fd686 Compare March 22, 2021 10:06
@engcom-Kilo
Copy link
Contributor Author

@magento run all tests

@engcom-Kilo engcom-Kilo changed the title [WIP] Upgrade flysystem to version ^2.0 Upgrade flysystem to version ^2.0 Mar 23, 2021
@@ -3,7 +3,8 @@
"description": "N/A",
"require": {
"php": "~7.3.0||~7.4.0",
"magento/framework": "*"
"magento/framework": "*",
"predis/predis": "*"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"predis/predis": "*"
"predis/predis": "^1.1"

@@ -14,8 +15,7 @@
"magento/module-media-storage": "*",
"magento/module-import-export": "*",
"magento/module-catalog-import-export": "*",
"magento/module-downloadable-import-export": "*",
"predis/predis": "*"
"magento/module-downloadable-import-export": "*"
Copy link
Member

Choose a reason for hiding this comment

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

Documentation should be updated as there is no need to require predis/predis package https://devdocs.magento.com/guides/v2.4/config-guide/remote-storage/config-remote-storage-caching.html

/**
* Remote storage cache interface.
*/
interface CacheInterface
Copy link
Member

Choose a reason for hiding this comment

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

The interface should be removed. There is only one implementation and I wouldn't introduce a new extension point in the patch release

/**
* Get file metadata.
*
* @deplacated There is no getMetadata() method in FilesystemAdapter anymore.
Copy link
Member

Choose a reason for hiding this comment

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

The comment and @deplacated annotation should be removed.

Is implementing League\Flysystem\FilesystemAdapter necessary?

/**
* Redis cache model.
*/
class Predis implements CacheStorageHandlerInterface
Copy link
Member

Choose a reason for hiding this comment

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

Introduced classes should be covered by integration tests

@sivaschenko
Copy link
Member

Flysystem is now updated in 2.4-develop

@m2-assistant
Copy link

m2-assistant bot commented Apr 15, 2021

Hi @engcom-Kilo, 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Project: PHP8
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants