Tidy up typing in OC\Files\View #36836

come-nc · 2023-02-23T15:32:15Z

Summary

Add return types and fix psalm complaints in View and related classes.

Checklist

Code is properly formatted
Sign-off message is added to all commits
Tests (unit, integration, api and/or acceptance) are included
Screenshots before/after for front-end changes
Documentation (manuals or wiki) has been updated or is not required
Backports requested where applicable (ex: critical bugfixes)

lib/private/Files/Filesystem.php

lib/private/Files/Storage/Wrapper/Encoding.php

come-nc · 2023-03-14T09:28:31Z

Needs Fix return type of wrap method to resource|false instead of resource|bool icewind1991/Streams#17

come-nc · 2023-03-27T15:31:16Z

/rebase

come-nc · 2023-03-30T10:08:23Z

@icewind1991 https://github.com/nextcloud/server/blob/master/apps/dav/lib/Connector/Sabre/Directory.php#L139-L141 this is blowing up because it puts null in non-nullable parameters.
Any idea how to refactor this properly?

come-nc · 2023-03-30T12:51:24Z

@icewind1991 https://github.com/nextcloud/server/blob/master/apps/dav/lib/Connector/Sabre/Directory.php#L139-L141 this is blowing up because it puts null in non-nullable parameters. Any idea how to refactor this properly?

For now I went back to weak typing for internalPath in FileInfo.

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

It’s not used and not in any OCP interface/class. Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

Applications are calling methods from the class which are not from the public interface, and which cannot be added easily to public interface because Node interface extends FileInfo. Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

ChristophWurst

👍 looks ok but I'm not familiar enough with this area of the code to given an approval

icewind1991

Good work otherwise 👍

icewind1991 · 2023-04-04T15:20:35Z

lib/private/Files/View.php

-	 * @param string $path
-	 * @return string
-	 */
-	public function getLocalFolder($path) {


is deleting this intentional?

Yes, the only place it was used was a test.

icewind1991 · 2023-04-04T15:22:25Z

@icewind1991 https://github.com/nextcloud/server/blob/master/apps/dav/lib/Connector/Sabre/Directory.php#L139-L141 this is blowing up because it puts null in non-nullable parameters. Any idea how to refactor this properly?

probably makes most sense to change those nulls to empty strings. But it probably makes more sense to do a that in a separate PR

lib/private/Files/View.php

blizzz · 2023-04-04T21:29:43Z

lib/public/Files/FileInfo.php

@@ -250,7 +250,7 @@ public function getMountPoint();
 	/**
 	 * Get the owner of the file
 	 *
-	 * @return \OCP\IUser
+	 * @return ?\OCP\IUser


should be added to critical changes (even if not a de-facto change to raise awareness)

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

juliusknorr · 2023-04-05T16:13:26Z

Causing some test failures on office by stricter typing that might be related to version handling in server. First investigation in nextcloud/richdocuments#2896, to be continued tomorrow.

DaphneMuller · 2023-05-30T09:38:43Z

Hello!
Thank you for your work on this! I noticed that your PR still has the label 'documentation'. I'm not sure if you already had a look at the documentation for your PR, but at Nextcloud we strive to document changes that affect other app developers or other admins before the release takes place, and I'm pinging you with the hope to get this done.

Are you familiar with our documentation process already?
Changes that affect app developers should be documented here:
https://docs.nextcloud.com/server/27/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_27.html

Changes that affect administrators should be documented here:
https://docs.nextcloud.com/server/latest/admin_manual/release_notes/upgrade_to_27.html

While I understand sometimes it's handy to merge fast to get your changes in, it would be great if next time you could try to add the documentation before merging. You can find more information on that here:
https://docs.nextcloud.com/server/27/developer_manual/prologue/compatibility_app_ecosystem.html#documentation-procedures-of-changes-that-affect-app-developers

If all your documentation efforts are done, please remove the label 'documentation' and check the checkbox in your opening note and I'll stop bugging you :)

Many thanks in advance and thanks again for your work!

blizzz · 2023-06-02T17:40:18Z

lib/private/Files/Filesystem.php

-	 * @param string $path
-	 * @return string
-	 */
-	public static function getLocalFolder($path) {


Almost. Used in https://github.com/nextcloud/workflow_script/blob/master/lib/Operation.php#L200

come-nc added the 2. developing Work in progress label Feb 23, 2023

come-nc added this to the Nextcloud 27 milestone Feb 23, 2023

come-nc self-assigned this Feb 23, 2023

github-advanced-security bot found potential problems Feb 23, 2023

View reviewed changes

lib/private/Files/Filesystem.php Fixed Show fixed Hide fixed

come-nc mentioned this pull request Feb 28, 2023

Make sure to never trigger files hooks on a null path #36893

Merged

4 tasks

come-nc force-pushed the fix/view-type-cleanup branch from 8845976 to 73a0066 Compare March 13, 2023 17:34

github-advanced-security bot found potential problems Mar 13, 2023

View reviewed changes

lib/private/Files/Storage/Wrapper/Encoding.php Fixed Show fixed Hide fixed

nextcloud-command force-pushed the fix/view-type-cleanup branch from 2cc56d8 to 67a408d Compare March 27, 2023 15:37

come-nc added 7 commits April 3, 2023 10:52

Tidy up typing in OC\Files\View

966a3e6

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

Remove unused method getLocalFolder

4393b96

It’s not used and not in any OCP interface/class. Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

Improve typing for fopen/toTmpFile

f974281

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

Fix return type of methods returning false on error

ea05544

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

More type cleanup in View and FileInfo

0b3dad8

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

Fix dav application tests

8f26a5d

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

come-nc force-pushed the fix/view-type-cleanup branch from e618668 to 8f26a5d Compare April 3, 2023 08:52

come-nc marked this pull request as ready for review April 3, 2023 13:02

come-nc requested review from ChristophWurst, provokateurin, a team, ArtificialOwl, icewind1991 and blizzz and removed request for a team April 3, 2023 13:03

ChristophWurst reviewed Apr 4, 2023

View reviewed changes

icewind1991 approved these changes Apr 4, 2023

View reviewed changes

provokateurin removed their request for review April 4, 2023 16:13

blizzz approved these changes Apr 4, 2023

View reviewed changes

Remove unecessary fully qualified namespaces from phpdoc

6633b4c

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

come-nc added 3. to review Waiting for reviews pending documentation This pull request needs an associated documentation update and removed 2. developing Work in progress labels Apr 5, 2023

come-nc merged commit 8f55039 into master Apr 5, 2023

come-nc deleted the fix/view-type-cleanup branch April 5, 2023 08:14

come-nc mentioned this pull request May 30, 2023

Document some phpdoc return type changes in OCP in 27 nextcloud/documentation#10513

Merged

come-nc removed the pending documentation This pull request needs an associated documentation update label Jun 1, 2023

blizzz mentioned this pull request Jun 2, 2023

View::getLocalFolder() was removed nextcloud/workflow_script#171

Closed

blizzz reviewed Jun 2, 2023

View reviewed changes

blizzz mentioned this pull request Mar 21, 2024

fix(Operation): getLocalFile returns false meanwhile nextcloud/workflow_script#268

Merged

artonge mentioned this pull request Jul 1, 2024

Ensure that the hash method does not return null #46218

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tidy up typing in OC\Files\View #36836

Tidy up typing in OC\Files\View #36836

come-nc commented Feb 23, 2023 •

edited

Loading

come-nc commented Mar 14, 2023 •

edited

Loading

come-nc commented Mar 27, 2023

come-nc commented Mar 30, 2023

come-nc commented Mar 30, 2023

ChristophWurst left a comment

icewind1991 left a comment

icewind1991 Apr 4, 2023

come-nc Apr 4, 2023

icewind1991 commented Apr 4, 2023

blizzz Apr 4, 2023

juliusknorr commented Apr 5, 2023

DaphneMuller commented May 30, 2023

blizzz Jun 2, 2023

Tidy up typing in OC\Files\View #36836

Tidy up typing in OC\Files\View #36836

Conversation

come-nc commented Feb 23, 2023 • edited Loading

Summary

Checklist

come-nc commented Mar 14, 2023 • edited Loading

come-nc commented Mar 27, 2023

come-nc commented Mar 30, 2023

come-nc commented Mar 30, 2023

ChristophWurst left a comment

Choose a reason for hiding this comment

icewind1991 left a comment

Choose a reason for hiding this comment

icewind1991 Apr 4, 2023

Choose a reason for hiding this comment

come-nc Apr 4, 2023

Choose a reason for hiding this comment

icewind1991 commented Apr 4, 2023

blizzz Apr 4, 2023

Choose a reason for hiding this comment

juliusknorr commented Apr 5, 2023

DaphneMuller commented May 30, 2023

blizzz Jun 2, 2023

Choose a reason for hiding this comment

come-nc commented Feb 23, 2023 •

edited

Loading

come-nc commented Mar 14, 2023 •

edited

Loading