google cloud adapter: allow to inject visibility handler

[syffer]

Hi,

This pr offers to simplify the configuration of the google adapter when there is a need to change the default visibility handler.

For example, when using a bucket with uniform acl, it is required to redefine the google adapter, the bucket, and the visibility handler like so:

flysystem:
    storages:
        storage.public.cdn:
            adapter: 'app.flysystem.adapter.public.cdn.custom'

services:
    app.flysystem.adapter.public.cdn.custom:
        class: League\Flysystem\GoogleCloudStorage\GoogleCloudStorageAdapter
        arguments:
            $bucket: '@app.uploads_cdn.gcloud_client_service.bucket'
            $prefix: '%uploads.cdn.gcp.storage.path_prefix%'
            $visibilityHandler: '@League\Flysystem\GoogleCloudStorage\UniformBucketLevelAccessVisibility' 

    League\Flysystem\GoogleCloudStorage\UniformBucketLevelAccessVisibility: ~

    app.uploads_cdn.gcloud_client_service:
        class: Google\Cloud\Storage\StorageClient
        arguments:
            $config:
                keyFilePath: '%uploads.cdn.gcp.authentication_file.path%'

    app.uploads_cdn.gcloud_client_service.bucket:
        class: Google\Cloud\Storage\Bucket
        factory: ['@app.uploads_cdn.gcloud_client_service', 'bucket']
        arguments:
            $name: '%uploads.cdn.gcp.storage.bucket_name%'

This pr would allow to do this instead :

flysystem:
    storages:
        storage.public.cdn:
            adapter: 'gcloud'
            options:
                client: 'app.uploads_cdn.gcloud_client_service'
                bucket: '%uploads.cdn.gcp.storage.bucket_name%'
                prefix: '%uploads.cdn.gcp.storage.path_prefix%'
                visibility_handler: League\Flysystem\GoogleCloudStorage\UniformBucketLevelAccessVisibility

services:
    app.uploads_cdn.gcloud_client_service:
        class: Google\Cloud\Storage\StorageClient
        arguments:
            $config:
                keyFilePath: '%uploads.cdn.gcp.authentication_file.path%'

At first, I wanted to add a VisibilityHandlerGuesser directlry in thephpleague/flysystem (by using the bucket's method info, as described here with the iamConfiguration, but the client might not have enough rights to do so).

[maxhelias]

That's great! Thank you for your contribution !

[maxhelias]

Is this CompilerPass necessary? I'm not sure we need it.

[syffer]

Thanks for your feedback.

I initially wanted to declare those services in the GcloudAdapterDefinitionBuilder (as they are only related to the google part), but it's obvious this class isn't where those services should be.

So, I added the services registrations in a CompilerPass to make it obvious it's only related to the google part, and in case other services would be needed for other parts as well (aws for example). So in my mind, it was just a question an organization purpose.

If you rather have the definition elsewhere (in the FlysystemBundle.php I assume), I would gladly modify this.

[maxhelias]

I see yes, in the current state of the builders it is not possible to register any other service.

More generally, the creation of storage shoud be reworked to extend the possibility of allowing external builders and also to register services according to the builders activated.
This last case is quite rare, because for exemple for other rights we register a new service like this :

flysystem-bundle/src/Adapter/Builder/AbstractAdapterDefinitionBuilder.php

Lines 67 to 84 in ad6ef9c

	protected function createUnixDefinition(array $permissions, string $defaultVisibilityForDirectories): Definition
	{
	return (new Definition(PortableVisibilityConverter::class))
	->setFactory([PortableVisibilityConverter::class, 'fromArray'])
	->addArgument([
	'file' => [
	'public' => (int) $permissions['file']['public'],
	'private' => (int) $permissions['file']['private'],
	],
	'dir' => [
	'public' => (int) $permissions['dir']['public'],
	'private' => (int) $permissions['dir']['private'],
	],
	])
	->addArgument($defaultVisibilityForDirectories)
	->setShared(false)
	;
	}

And this service is declared as no-shared to manage different rights per storage.

From what I can see for GCloud, it's a bit different. It uses predefined rights for these entities, I don't use GCloud and I don't know if these values can change in relation to its configuration.
So at first lok, I don't see any other way.

[syffer]

I also don't know about the predefined rights for GCloud, I only worked with GCloud recently in order to use it as a cdn, which has a uniform acl.

Maybe I thought too much about it, and doing as the other builders is enough (meaning creating a new visibility handler per GCloud adapter when it is given in the config), and not having to create 2 others "global" visibility handler services

[maxhelias]

Don't hesitate if you think you can improve it, in the meantime I'll merge it.

[maxhelias]

Thanks @syffer ! It's release : https://github.com/thephpleague/flysystem-bundle/releases/tag/3.3.3