Make drivers more consistent / reduce driver API

[enumag]

No description provided.

[enumag]

ping @kelunik

[enumag]

@kelunik Most likely chown needs the same treatment with if ($this->priorVersion) { as most of the other methods. This might apply to chmod and possibly other methods that are not covered by tests as well.

[kelunik]

@enumag The test won't work that way due to umask.

[enumag]

@kelunik Is there a way to fix it or do I have to remove it?

[kelunik]

@enumag I guess $old = umask(0) + umask($old) is needed, as it's used here: https://www.php.net/manual/en/function.umask.php

[enumag]

@kelunik Actually umask wasn't the problem. Missing clearstatcache was. Second call to fileperms returned wrong result.

[enumag]

@bwoebi Could you take a look what's wrong with UvDriver::link() please? It still hangs the tests and I can't figure it out. I actually kinda suspect there might be something wrong in ext-uv.

[kelunik]

@enumag I've fixed UvDriver::link, it had a parameter too much.

@trowski Please review, I'd like to finally merge this.

[enumag]

@kelunik @trowski Could we have a release with these changes?

[kelunik]

@enumag Yes, we should indeed finally tag v2. I guess the code is ready, we just need to write a changelog. I originally wanted to wrap stat into an object, but probably won't do that. Do you want to help with the changelog?

[enumag]

@kelunik Well the notable changes are these:

- Added AsyncFileMutex (#43)
- Consistent and reduced drivers API (#38)
- Redesigned API (#53)

Then it depends on if you want to

• list all the renamed functions from your API redesign
• list which methods were removed from drivers when reducing their API
• describing the philosophy behind consistent API (Make drivers more consistent / reduce driver API #38 (comment))
  • also this change was a part of it

[kelunik]

That's a good starting point, yes. I think listing the renames makes senses, as it only needs to be done once, otherwise everybody will have to spend time looking things up. I'm not sure whether detailed changelogs for the driver interface makes sense, as there probably aren't many people who implemented their own driver. Do you want to work on that?

[enumag]

@kelunik here is what I gathered:

Renamed:
open -> openFile
stat -> getStatus
lstat -> getLinkStatus
size -> getSize
isdir -> isDirectory
isfile -> isFile
mtime -> getModificationTime
atime -> getAccessTime
ctime -> getCreationTime
symlink -> createSymlink
link -> createHardlink
readlink -> resolveSymlink
rename -> move
unlink -> deleteFile
rmdir -> deleteDirectory
scandir -> listFiles
chmod -> changePermissions
get -> read
put -> write

Added:
isSymlink

Changed:
mkdir split to createDirectory and createDirectoryRecursively
chown renamed to changeOwner, $uid and $gid now accept null instead of -1 to ignore

[enumag]

ping @kelunik Anything else I can help with here?

[kelunik]

No, thank you! I'll get it tagged in the coming days. Sorry about the delay.

[kelunik]

I finally got to my notebook and tagged the release, thank you so much!

[enumag]

Thanks @kelunik!

I noticed a few things when browsing the latest commits.

1. You're apparently using a dev version of ext-uv (f45eb11). How are things looking there? Could we have a new release?

2. Also noticed that you're ignoring ext-eio on PHP 8 (90f9550). However iirc there is already a PHP 8 compatible RC release of ext-eio.

I'll try to find some time to update amphp/cache and amphp/http-client.

[kelunik]

I'm using the current master branch of ext-uv, yes. I'm not sure what changes from the last release there.

I'm ignoring eio, because the setup-php script doesn't install it currently. If you have a fix for that, please send a PR.