Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use basenamePrefix instead of suffix when creating temporary file in overwrite save mode #1165

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

use function Flow\ETL\Adapter\JSON\from_json;
use function Flow\ETL\Adapter\Json\to_json;
use function Flow\ETL\DSL\df;
use function Flow\ETL\DSL\{df, overwrite};
use function Flow\Filesystem\DSL\path;
use Flow\ETL\Adapter\JSON\JsonLoader;
use Flow\ETL\Tests\Double\FakeExtractor;
Expand Down Expand Up @@ -53,4 +53,31 @@ public function test_json_loader_loading_empty_string() : void
\unlink($path);
}
}

public function test_json_loader_overwrite_mode() : void
{

df()
->read(new FakeExtractor(100))
->write(to_json($path = __DIR__ . '/var/test_json_loader.json'))
->run();

df()
->read(new FakeExtractor(100))
->mode(overwrite())
->write(to_json($path = __DIR__ . '/var/test_json_loader.json'))
->run();

$content = \file_get_contents($path);
self::stringEndsWith(']', $content);

self::assertEquals(
100,
df()->read(from_json($path))->count()
);

if (\file_exists($path)) {
\unlink($path);
}
}
}
8 changes: 4 additions & 4 deletions src/core/etl/src/Flow/ETL/Filesystem/FilesystemStreams.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
*/
final class FilesystemStreams implements \Countable, \IteratorAggregate
{
public const FLOW_TMP_SUFFIX = '._flow_tmp';
public const FLOW_TMP_FILE_PREFIX = '._flow_php_tmp.';

private SaveMode $saveMode;

Expand Down Expand Up @@ -47,7 +47,7 @@ public function closeWriters(Path $path) : void
$partitionFilesPatter = new Path($fileStream->path()->parentDirectory()->path() . '/*', $fileStream->path()->options());

foreach ($fs->list($partitionFilesPatter) as $partitionFile) {
if (\str_ends_with($partitionFile->path->path(), self::FLOW_TMP_SUFFIX)) {
if (\str_contains($partitionFile->path->path(), self::FLOW_TMP_FILE_PREFIX)) {
continue;
}

Expand All @@ -58,7 +58,7 @@ public function closeWriters(Path $path) : void
$fs->mv(
$fileStream->path(),
new Path(
\str_replace(self::FLOW_TMP_SUFFIX, '', $fileStream->path()->uri()),
\str_replace(self::FLOW_TMP_FILE_PREFIX, '', $fileStream->path()->uri()),
$fileStream->path()->options()
)
);
Expand Down Expand Up @@ -199,7 +199,7 @@ public function writeTo(Path $path, array $partitions = []) : DestinationStream
}

if ($this->saveMode === SaveMode::Overwrite) {
$outputPath = new Path($outputPath->uri() . self::FLOW_TMP_SUFFIX, $outputPath->options());
$outputPath = $outputPath->basenamePrefix(self::FLOW_TMP_FILE_PREFIX);
}

if ($this->saveMode === SaveMode::ExceptionIfExists) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public function test_open_stream_for_existing_file() : void
]);

$fileStream = $streams->writeTo($path = $this->getPath(__FUNCTION__ . '/existing-file.txt'));
self::assertStringEndsWith(FilesystemStreams::FLOW_TMP_SUFFIX, $fileStream->path()->path());
self::assertStringContainsString(FilesystemStreams::FLOW_TMP_FILE_PREFIX, $fileStream->path()->path());
$fileStream->append('some other content');
self::assertSame('some content', \file_get_contents($path->path()));

Expand Down
8 changes: 8 additions & 0 deletions src/lib/filesystem/src/Flow/Filesystem/Path.php
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,14 @@ public function basename() : string
return $this->basename;
}

public function basenamePrefix(string $prefix) : self
{
return new self(
$this->parentDirectory()->uri() . DIRECTORY_SEPARATOR . $prefix . $this->basename(),
$this->options()
);
}

public function context() : ResourceContext
{
return ResourceContext::from($this);
Expand Down
33 changes: 33 additions & 0 deletions src/lib/filesystem/tests/Flow/Filesystem/Tests/Unit/PathTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,39 @@ public function test_extension() : void
self::assertFalse((new Path(__DIR__))->extension());
}

public function test_file_prefix() : void
{
$path = new Path('flow-file://var/dir/file.csv', []);

self::assertSame(
'flow-file://var/dir/._flow_tmp.file.csv',
$path->basenamePrefix('._flow_tmp.')->uri()
);
self::assertSame('csv', $path->extension());
}

public function test_file_prefix_on_directory() : void
{
$path = new Path('flow-file://var/dir/', []);

self::assertSame(
'flow-file://var/._flow_tmp.dir',
$path->basenamePrefix('._flow_tmp.')->uri()
);
self::assertFalse($path->extension());
}

public function test_file_prefix_on_root_directory() : void
{
$path = new Path('flow-file://', []);

self::assertSame(
'flow-file://._flow_tmp.',
$path->basenamePrefix('._flow_tmp.')->uri()
);
self::assertFalse($path->extension());
}

#[DataProvider('paths_with_static_parts')]
public function test_finding_static_part_of_the_path(string $staticPart, string $uri) : void
{
Expand Down