Filesystem Management with Flysystem at PHP UK 2023

Filesystem Management
with Flysystem
Mark Niebergall

👏 Thank you!
• Organisers
• Delegates
• Speakers
• Sponsors
- Nucleus Security

🧑💻 PHP Community
• You are amazing
• Attending a conference
- Learn
- Network
- Have fun
- Apply what you learned

🧑💻 PHP Community
• You made it to Thursday afternoon! 🤯

• 🙋 Poll: Who is already using Flysystem?

Filesystem Management with Flysystem at PHP UK 2023

https://img
fl
ip.com/i/779qzd

🤔 Question
• How do you e
ff
ectively manage
fi
les with code?

🤔 Question
• Common solution
- fopen
-
fi
le_get_contents
-
fi
le_put_contents
- delete
- chmod

fl
ip.com/i/778h2c

AwsS3Service
Local
In Memory
AWS S3
Azure
SFTP
File
LocalService
InMemoryService
AzureService
SftpService
😵💫 The Problem

• “Flysystem is a
fi
le storage library for PHP. It provides one
interface to interact with many di
ff
erent types of
fi
lesystems. When you use Flysystem, you’re not only
protected from vendor lock-in, you’ll also have a
consistent experience for which ever storage is right for
you.”

Flysystem
Local
In Memory
AWS S3
Azure
SFTP
File

✅ Objective
• Familiarity with Flysystem API
• Ideas on implementation
• Improved
fi
lesystem interactions

📋 Overview
• Adapters
• Flysystem API
• Implementation Strategies
• Testing

https://gifer.com/en/EgDb

Adapters
• Traditional
- Di
ff
erent code for local vs external
- Di
ff
erent code for each adapter

Adapters
• Use case
- Local for development
- SFTP for QA
- S3 storage for Production

Adapters
• Use case
- Variety of
fi
le types

Adapters
public function readLocal(string $location): string
{
return file_get_contents($location);
}
public function readS3(string $location): string
{
// read file from S3 storage
return 'File Contents';
}
public function getContents(string $storage, string $location): string
{
return match ($storage) {
'local' => $this->readLocal($location),
'awss3' => $this->readS3($location),
default => throw new InvalidArgumentException('Not configured'),
};
}

Adapters
• Flysystem is con
fi
gurable
- Local
- External services

Adapters
• O
ffi
cial Adapters - Local
- Local
- InMemory

Adapters
• O
ffi
cial Adapters - External
- AWS S3
- AsyncAws S3
- Azure Blob Storage
- Google Cloud Storage
- SFTP
- WebDAV

Adapters
• Community Adapters
- GitLab

Adapters
• Decorators
- Read-Only
‣ $adapter = new
InMemoryFilesystemAdapter();
$readOnlyAdapter = new
LeagueFlysystemReadOnlyReadOnlyFile
systemAdapter($adapter);
$filesystem = new Filesystem($adapter);

Adapters
• Decorators
- Path Pre
fi
xing
‣ $pathPrefixedAdapter = new
LeagueFlysystemPathPrefixngPathPref
ixedAdapter($adapter, 'a/path/prefix');

http://www.quickmeme.com/meme/3uywoc

Flysystem API
• Decent documentation online
- https://
fl
ysystem.thephpleague.com/docs/
- Make sure you are on the correction version of
documentation!

Flysystem API
• Exists
- fileExists(string $location): bool
- directoryExists(string $location): bool
- has(string $location): bool
‣ $this->adapter->fileExists(
$path
)
|| $this->adapter->directoryExists(
$path
);

Flysystem API
• File CRUD
- C: Write
- R: Read
- U: Move
- D: Delete

Flysystem API
• Write
- write(
string $location,
string $contents,
array $config = []
): void
- writeStream(
string $location,
$contents,
array $config = []
): void

Flysystem API
• Read
- read(string $location): string
- readStream(string $location)

Flysystem API
• Delete
- delete(string $location): void
- deleteDirectory(string $location): void

Flysystem API
• Directory
- createDirectory(
string $location,
array $config = []
): void
- listContents(
string $location,
bool $deep = self::LIST_SHALLOW
): DirectoryListing

Flysystem API
• Files
- move(
string $source,
string $destination,
array $config = []
): void
- copy(
string $source,
string $destination,
array $config = []
): void

Flysystem API
• Metadata
- lastModified(string $path): int
- fileSize(string $path): int
- mimeType(string $path): string
- checksum(
string $path,
array $config = []
): string

Flysystem API
• Permissions
- setVisibility(
string $path,
string $visibility
): void
- visibility(string $path): string

Flysystem API
• URLs
- S3, Azure, Google Cloud, WebDAV
‣ publicUrl(
string $path,
array $config = []
): string
‣ temporaryUrl(
string $path,
DateTimeInterface $expiresAt,
array $config = []
): string

Flysystem API
• Frameworks
- Bundled with Laravel
- Available with Symfony
- Can be used with other frameworks too

https://makeameme.org/meme/and-then-we-5b7d94

Implementation Strategies
• Con
fi
guration
• Exception Handling
• Wrapper
• Mount Manager

• Con
fi
guration
- Injectable con
fi
guration for adapters
'filesystem' => [
'local' => [
'directory' => '/tmp/filesystem/files/',
],
'awss3' => [
'client' => [
'credentials' => [
'key' => 'key...',
'secret' => 'secret...',
],
'region' => 'us‑west‑1',
'version' => 'latest',
],
'bucket' => 'my-bucket-name',
],
],

• Con
fi
guration
- Application
fl
exibility
- Variety of sources
‣ Database
‣ PHP con
fi
guration
fi
les

• Con
fi
guration
- UI interface to con
fi
gure
- Scalability

- Generic exception
‣ FilesystemException
- Speci
fi
c exceptions
‣ UnableToReadFile
‣ UnableToWriteFile
‣ UnableToDeleteFile
‣ UnableToCheckExistence
‣ ...

- Full list of exceptions
‣ https://
fl
ysystem.thephpleague.com/docs/usage/
fi
lesystem-api/

1. Catch Flysystem speci
fi
c exceptions
2. Handle the exception
3. Throw own meaningful exception

public function read(string $location): string
{
try {
$contents = $this->filesystem->read($location);
} catch (UnableToReadFile $exception) {
// handle unable to read exception
// throw an exception
} catch (FilesystemException $exception) {
// handle general error
// throw an exception
}
return $contents;
}

• Wrapper
- Wrapper or Facade Pattern
- Abstracts away underlying package
- Swappable package
- Unit testable

• Wrapper
- Useful pattern for many services
‣ Filesystem
‣ Email
‣ SMS
‣ Database
‣ Queue system

class FileStorageService
{
public function __construct(
protected Filesystem $filesystem
) {}
{
return $this->filesystem->read($location);
}

• Mount Manager
- Scenario
‣ Retrieve
fi
les from an external service
‣ Write locally for processing

• Mount Manager
- Scenario
‣ Move
fi
les between external adapters upon an event

• Mount Manager
- Scenario
‣ Many customers
‣ Reports created, stored locally
‣ Reports delivered based on con
fi
guration
‣ Variety of
fi
le storage locations

• Mount Manager
- Interact with
fi
les in many storage services
- Specify adapter in location
‣ awss3://subfolder/
fi
le.txt
‣ local://path/to/
fi
le.txt

MountManager
Local
In Memory
AWS S3
Azure
SFTP

class FileManager
{
protected MountManager $mountManager
) {}
{
return $this->mountManager->read($location);
}

class FileManagerFactory
{
protected FileStorageAdapterFactory $adapterFactory
) {}
public function create(array $mounts): FileManager
{
$mountManageConfig = [];
foreach ($mounts as $storage => $config) {
$mountManageConfig[$storage] = new Filesystem(
$this->adapterFactory->create($storage, $config)
);
}
return new FileManager(new MountManager($mountManageConfig));
}

class FileStorageAdapterFactory
{
public function create(string $adapter, array $config): FilesystemAdapter
{
return match ($adapter) {
'awss3' => new AwsS3V3Adapter($config['client'], $config['bucket']),
'local' => new LocalFilesystemAdapter($config['directory']),
};
}

fl
ip.com/i/7ami3u

Testing
• Historically problematic testing
fi
le interactions
- Test
fi
les
- Inject
fi
le content
- git ignore directory for testing
fi
les
- Skip testing that code
- Integration tests vs Unit tests

Testing
public function testRead(): void
{
$file = __DIR__ . '/TestingFile.txt';
$service = new FileStorageLocalLegacyService();
$contents = $service->read($file);
$this->assertSame(
'Test file contents 123 ...',
$contents
);
}

Testing
• Flysystem abstraction layer allows for testing
- Mock calls to
fi
le interactions
- Pushes for single purpose code
- Centralized
fi
lesystem management

Testing
public function testRead(): void
{
$text = 'Test text!';
$testPath = uniqid('/tmp/test/') . '.txt';
$filesystemMock = $this->getMockBuilder(Filesystem::class)
->disableOriginalConstructor()
->onlyMethods(['read'])
->getMock();
$filesystemMock->method('read')
->with($testPath)
->willReturn($text);
$service = new FileStorageService($filesystemMock);
$contents = $service->read($testPath);
$this->assertSame($text, $contents);
}

🗣 Discussion
• Bene
fi
ts of Flysystem?
• Cons of Flysystem?

🗣 Discussion
• Security
• Credentials

🗣 Discussion
• Conversion cost
• Scalability
• Maintenance

📋 Review
• External Services
• Flysystem API
• Implementation Strategies
• Testing

Mark Niebergall @mbniebergall
• PHP since 2005
• Masters degree in MIS
• Senior Software Engineer
• Vulnerability Management project (security scans)
• Utah PHP Co-Organizer
• CSSLP, SSCP Certi
fi
ed and Exam Developer
• Endurance sports, outdoors

Filesystem Management with Flysystem
• Questions?
• I’ll stay after to answer more questions, help with setup
and con
fi
gs

👀 References
• https://
fl
ysystem.thephpleague.com/docs/usage/
fi
lesystem-api/
• https://github.com/thephpleague/
fl
ysystem

Filesystem Management with Flysystem at PHP UK 2023

Recommended

More Related Content

What's hot (20)

Similar to Filesystem Management with Flysystem at PHP UK 2023 (20)

More from Mark Niebergall (20)

Recently uploaded (20)

Filesystem Management with Flysystem at PHP UK 2023