Class::disk(): Return value must be of type Illuminate\Filesystem\FilesystemAdapter, Sentry\Laravel\Features\Storage\SentryCloudFilesystem returned

[Gummibeer]

How do you use Sentry?

Sentry SaaS (sentry.io)

SDK version

3.7.0

Steps to reproduce

Have a method type-hinting for Illuminate\Filesystem\FilesystemAdapter and return Storage:disk('s3') or any other cloud disk.

Expected result

Type-hint before v3.7.0 still works as expected and a breaking change of the package i sonly introduced during a new major-release.

Actual result

TypeError is thrown with message:

Return value must be of type Illuminate\Filesystem\FilesystemAdapter, Sentry\Laravel\Features\Storage\SentryCloudFilesystem returned

[atypic-garrett]

Came across the same issue, had to update composer to use 3.6.* :(

[cleptric]

Could you share a full stack trace? This helps to resolve this quickly.

[Gummibeer]

There isn't anything helpful in the stacktrace - as the problem is the new sentry storage breadcrumbs and so on. And the rebind of the storages already in place.
Because of that the type of the resolved driver changes and this destroys all existing type-hints. To resolve that you will have to go back to v3.6 or do the work and type-hint the underlying interface instead of the precise class.

[cleptric]

In general, please assume that someone might not have all the necessary context to reproduce an issue immediately. In this case, a stack trace or your list of installed dependencies would have helped me verify that someone needs to install league/flysystem-aws-s3-v3 to reproduce the issue.

I'm seeing the problem now, and we'll get this fixed momentarily 🙂

[Gummibeer]

It's not related to S3 specifically. It's a problem with every single fileystem and related to your Sentry/Laravel/Features/Storage/Integration.php:40 logic which rebinds every single fileystem with a new precise class. Because of that every single place with a precise class type-hint will now fail.

sentry-laravel/src/Sentry/Laravel/Features/Storage/Integration.php

Lines 75 to 77 in 6c3e562

	return $originalFilesystem instanceof CloudFilesystem
	? new SentryCloudFilesystem($originalFilesystem, $defaultData, $recordSpans, $recordBreadcrumbs)
	: new SentryFilesystem($originalFilesystem, $defaultData, $recordSpans, $recordBreadcrumbs);

And as long as these classes don't extend the Laravel implementations and only share the interface it's a breaking change and there's nothing you can do about it except of changing the extended class or removing that feature till v4.