Improve Scoped Disk Configuration with Statamic in Laravel

[okaufmann]

Hello Laravel Community,

We've been building numerous Statamic websites. Statamic facilitates the definition of Containers to store Assets, like images. These Containers reference a disk as defined in config/filesystem.php. As our websites grow, we find ourselves defining an increasing number of disks. Thankfully, Laravel's Scoped Disks means we no longer need to repetitively copy configurations.

Previously, we had configurations like:

'assets' => [
    'driver' => 's3',
    'key' => env('S3_ASSETS_ACCESS_KEY_ID'),
    'secret' => env('S3_ASSETS_SECRET_ACCESS_KEY'),
    'region' => env('S3_ASSETS_DEFAULT_REGION', 'eu-central-2'),
    'bucket' => env('S3_ASSETS_BUCKET'),
    'url' => env('S3_ASSETS_URL'),
    'endpoint' => env('S3_ASSETS_ENDPOINT'),
    'use_path_style_endpoint' => env('S3_ASSETS_USE_PATH_STYLE_ENDPOINT', false),
    'root' => env('S3_ASSETS_ROOT_PATH'). '/assets',
    'throw' => true,
    
    'visibility' => 'public',
],

'secret-downloads' => [
    'driver' => 's3',
    'key' => env('S3_ASSETS_ACCESS_KEY_ID'),
    'secret' => env('S3_ASSETS_SECRET_ACCESS_KEY'),
    'region' => env('S3_ASSETS_DEFAULT_REGION', 'eu-central-2'),
    'bucket' => env('S3_ASSETS_BUCKET'),
    'url' => env('S3_ASSETS_URL'),
    'endpoint' => env('S3_ASSETS_ENDPOINT'),
    'use_path_style_endpoint' => env('S3_ASSETS_USE_PATH_STYLE_ENDPOINT', false),
    'root' => env('S3_ASSETS_ROOT_PATH'). '/secret-downloads',
    'throw' => true,

    'visibility' => 'private',
],

Now, with scoped disks, we can simplify it to:

's3' => [
    'driver' => 's3',
    'key' => env('S3_ASSETS_ACCESS_KEY_ID'),
    'secret' => env('S3_ASSETS_SECRET_ACCESS_KEY'),
    'region' => env('S3_ASSETS_DEFAULT_REGION', 'eu-central-2'),
    'bucket' => env('S3_ASSETS_BUCKET'),
    'url' => env('S3_ASSETS_URL'),
    'endpoint' => env('S3_ASSETS_ENDPOINT'),
    'use_path_style_endpoint' => env('S3_ASSETS_USE_PATH_STYLE_ENDPOINT', false),
    'root' => env('S3_ASSETS_ROOT_PATH'), 
    'throw' => true,
],

'assets' => [
    'driver' => 'scoped',
    'disk' => 's3',
    'prefix' => 'assets',
    
    'visibility' => 'public', // <-- does not work here, only when defined in a normal disk.
],

'secret-downloads' => [
    'driver' => 'scoped',
    'disk' => 's3',
    'prefix' => 'secret-downloads',
    
    'visibility' => 'private', // <-- does not work here, only when defined in a normal disk.
],

There's a visibility config key in the filesystem configurations, a Statamic-specific attribute, which defines if the saved files on an S3 bucket should be publicly visible or private.

The Challenge

When Laravel generates a scoped disk, it exclusively considers the config values driver, disk, and prefix. This is entirely logical for a vanilla Laravel project. However, when incorporating packages like Statamic, having the ability to include additional config keys in a scoped disk configuration would be beneficial.

Recognizing that this may be a niche concern, I'm reaching out to gauge the community's thoughts. Laravel is renowned for its adaptability, so I'm hopeful there's a way to address this need without compromising the framework's elegance. If there's consensus or a roadmap, I'm more than happy to contribute a Pull Request.

Thank you for your consideration.

[okaufmann]

Of course this is a Flysystem Feature since ever 🤦‍♂️

I've created a PR to support the visibility key on scoped disks in Laravel: #48186