fix(IStorage): Use false instead of bool intersection type to match implementations #48219
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
provokateurin
requested review from
ArtificialOwl,
icewind1991,
artonge,
skjnldsv,
sorbaugh and
come-nc
provokateurin
changed the title
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
There was a problem hiding this comment.
Psalm found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.
provokateurin
force-pushed
the
fix/istorage/return-types
branch
from
80f8557 to
03e9653
Compare
|
I hope I fixed all the weird typings, but please take another look. |
come-nc
reviewed
Sep 20, 2024
provokateurin
force-pushed
the
fix/istorage/return-types
branch
from
03e9653 to
27d8eff
Compare
come-nc
approved these changes
Sep 20, 2024
provokateurin
force-pushed
the
fix/istorage/return-types
branch
from
27d8eff to
19faaa3
Compare
Altahrim
approved these changes
Sep 25, 2024
come-nc
reviewed
Sep 26, 2024
Signed-off-by: provokateurin <[email protected]>
Signed-off-by: provokateurin <[email protected]>
Signed-off-by: provokateurin <[email protected]>
Signed-off-by: provokateurin <[email protected]>
provokateurin
force-pushed
the
fix/istorage/return-types
branch
from
19faaa3 to
ad548d7
Compare
Signed-off-by: provokateurin <[email protected]>
…mplementations Signed-off-by: provokateurin <[email protected]>
provokateurin
force-pushed
the
fix/istorage/return-types
branch
from
ad548d7 to
227609a
Compare
|
This breaks all apps that have a storage wrapper. At least it should be documented |
nickvergessen
added
the
pending documentation
come-nc
reviewed
Sep 30, 2024
| @@ -823,7 +750,7 @@ public function writeStream(string $path, $stream, ?int $size = null): int { | |||
| return $count; | |||
| } | |||
|
|
|||
| public function getDirectoryContent($directory): \Traversable { | |||
| public function getDirectoryContent($directory): \Traversable|false { | |||
There was a problem hiding this comment.
I missed this change, can you explain why the |false?
There is no return false in there.
There was a problem hiding this comment.
Ok I thought I remembered that one of the implementations returns false so every implementation has to handle it, but I was wrong. The only error handling I could find was done using exceptions, so I will revert this.
4 tasks
vitormattos
added a commit
to vitormattos/groupquota
that referenced
this pull request
Oct 7, 2024
After the PR nextcloud/server#48219 the signatore of this method was changed and now is necessary to have return typing. Problem fixed: ``` Declaration of OCA\\GroupQuota\\Wrapper\\GroupQuotaWrapper::getCache($path = '', $storage = null) must be compatible with OC\\Files\\Storage\\Wrapper\\Wrapper::getCache($path = '', $storage = null): OCP\\Files\\Cache\\ICache at /var/www/html/apps-writable/groupquota/lib/Wrapper/GroupQuotaWrapper.php#35 ``` Server version affected: >= 31 Signed-off-by: Vitor Mattos <[email protected]>
provokateurin
removed
the
pending documentation
icewind1991
pushed a commit
to vitormattos/groupquota
that referenced
this pull request
Dec 9, 2024
After the PR nextcloud/server#48219 the signatore of this method was changed and now is necessary to have return typing. Problem fixed: ``` Declaration of OCA\\GroupQuota\\Wrapper\\GroupQuotaWrapper::getCache($path = '', $storage = null) must be compatible with OC\\Files\\Storage\\Wrapper\\Wrapper::getCache($path = '', $storage = null): OCP\\Files\\Cache\\ICache at /var/www/html/apps-writable/groupquota/lib/Wrapper/GroupQuotaWrapper.php#35 ``` Server version affected: >= 31 Signed-off-by: Vitor Mattos <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This adds strong return types to all implementations to match the interface.
The changes escalated a bit, but everything should be fixed at once.
It also fixes some bugs in poorly implemented storages.
Technically this is a breaking change due to changing the signature, but I only did that for private classes and the fix is completely backwards compatible.
The temporary pain of adding the return types to all implementations is justified by fixing all these type mismatches for once.
This change should also allow us to actually add the strong return types to IStorage since all implementations should also be extending Common which already has them.
Please don't hate me for this change 🙈
I was not able to test files_external due to the terrible test setup which I can not get working locally, so let's see what CI has to say.
Checklist