Rename performance (#2250)

* fix: entries droping metadata during rename

* refactor: optimize rename performance

- removed deprecated code

* fix: fragile website tests

Author: norberttech

src/core/etl/src/Flow/ETL/DSL/functions.php

@@ -144,7 +144,6 @@
     Sprintf,
     StringAggregate,
     StructureFunctions,
-    StyleConverter\StringStyles as OldStringStyles,
     Sum,
     ToDate,
     ToDateTime,
@@ -210,7 +209,7 @@
 use Flow\ETL\Transformation\AddRowIndex\StartFrom;
 use Flow\ETL\Transformation\{AddRowIndex, BatchSize, Drop, Limit, MaskColumns, Select};
 use Flow\ETL\Transformer\OrderEntries\{CombinedComparator, Comparator, NameComparator, Order, TypeComparator, TypePriorities};
-use Flow\ETL\Transformer\Rename\{RenameCaseEntryStrategy, RenameReplaceEntryStrategy};
+use Flow\ETL\Transformer\Rename\{RenameCaseEntryStrategy, RenameMapEntryStrategy, RenameReplaceEntryStrategy};
 use Flow\Filesystem\{Filesystem, Local\NativeLocalFilesystem, Partition, Partitions, Path};
 use Flow\Filesystem\Stream\Mode;
 use Flow\Filesystem\Telemetry\FilesystemTelemetryOptions;
@@ -497,7 +496,7 @@ function to_branch(ScalarFunction $condition, Loader $loader) : BranchingLoader
 }
 
 #[DocumentationDSL(module: Module::CORE, type: DSLType::TRANSFORMER)]
-function rename_style(OldStringStyles|StringStyles $style) : RenameCaseEntryStrategy
+function rename_style(StringStyles $style) : RenameCaseEntryStrategy
 {
     return new RenameCaseEntryStrategy($style);
 }
@@ -512,6 +511,15 @@ function rename_replace(string|array $search, string|array $replace) : RenameRep
     return new RenameReplaceEntryStrategy($search, $replace);
 }
 
+/**
+ * @param array<string, string> $renames Map of old_name => new_name
+ */
+#[DocumentationDSL(module: Module::CORE, type: DSLType::TRANSFORMER)]
+function rename_map(array $renames) : RenameMapEntryStrategy
+{
+    return new RenameMapEntryStrategy($renames);
+}
+
 /**
  * @return Entry<?bool>
  */
@@ -1297,12 +1305,8 @@ function array_key_rename(ScalarFunction $ref, ScalarFunction|string $path, Scal
 }
 
 #[DocumentationDSL(module: Module::CORE, type: DSLType::SCALAR_FUNCTION)]
-function array_keys_style_convert(ScalarFunction $ref, OldStringStyles|StringStyles|string $style = StringStyles::SNAKE) : ArrayKeysStyleConvert
+function array_keys_style_convert(ScalarFunction $ref, StringStyles|string $style = StringStyles::SNAKE) : ArrayKeysStyleConvert
 {
-    if ($style instanceof OldStringStyles) {
-        $style = StringStyles::fromString($style->value);
-    }
-
     return new ArrayKeysStyleConvert($ref, $style instanceof StringStyles ? $style : StringStyles::fromString($style));
 }
 

src/core/etl/src/Flow/ETL/DataFrame.php

@@ -15,7 +15,6 @@
 use Flow\ETL\Function\{AggregatingFunction,
     ExecutionMode,
     ScalarFunction,
-    StyleConverter\StringStyles as OldStringStyles,
     WindowFunction};
 use Flow\ETL\Join\{Expression, Join};
 use Flow\ETL\Loader\SchemaValidationLoader;
@@ -35,7 +34,6 @@
 use Flow\ETL\Row\{EntryReference, Formatter\ASCIISchemaFormatter, Reference, References};
 use Flow\ETL\Schema\{Definition, SchemaFormatter};
 use Flow\ETL\Schema\Validator\StrictValidator;
-use Flow\ETL\String\StringStyles;
 use Flow\ETL\Transformer\{AutoCastTransformer,
     CallbackRowTransformer,
     CrossJoinRowsTransformer,
@@ -50,9 +48,7 @@
     OrderEntries\TypeComparator,
     RenameEachEntryTransformer,
     RenameEntryTransformer,
-    Rename\RenameCaseEntryStrategy,
     Rename\RenameEntryStrategy,
-    Rename\RenameReplaceEntryStrategy,
     ScalarFunctionFilterTransformer,
     ScalarFunctionTransformer,
     SelectEntriesTransformer,
@@ -724,85 +720,6 @@ public function rename(string $from, string $to) : self
         return $this;
     }
 
-    /**
-     * @lazy
-     * Iterate over all entry names and replace the given search string with replace string.
-     *
-     * @deprecated use DataFrame::renameEach() with a RenameReplaceStrategy
-     */
-    public function renameAll(string $search, string $replace) : self
-    {
-        $this->renameEach(new RenameReplaceEntryStrategy($search, $replace));
-
-        return $this;
-    }
-
-    /**
-     * @lazy
-     *
-     * @deprecated use DataFrame::renameEach() with a selected StringStyles
-     */
-    public function renameAllLowerCase() : self
-    {
-        $this->renameEach(new RenameCaseEntryStrategy(StringStyles::LOWER));
-
-        return $this;
-    }
-
-    /**
-     * @lazy
-     * Rename all entries to a given style.
-     * Please look into \Flow\ETL\Function\StyleConverter\StringStyles class for all available styles.
-     *
-     * @deprecated use DataFrame::renameEach() with a selected Style
-     */
-    public function renameAllStyle(OldStringStyles|StringStyles|string $style) : self
-    {
-        if ($style instanceof OldStringStyles) {
-            $style = StringStyles::fromString($style->value);
-        }
-
-        $this->renameEach(new RenameCaseEntryStrategy(\is_string($style) ? StringStyles::fromString($style) : $style));
-
-        return $this;
-    }
-
-    /**
-     * @lazy
-     *
-     * @deprecated use DataFrame::renameEach() with a selected Style
-     */
-    public function renameAllUpperCase() : self
-    {
-        $this->renameEach(new RenameCaseEntryStrategy(StringStyles::UPPER));
-
-        return $this;
-    }
-
-    /**
-     * @lazy
-     *
-     * @deprecated use DataFrame::renameEach() with a selected Style
-     */
-    public function renameAllUpperCaseFirst() : self
-    {
-        $this->renameEach(new RenameCaseEntryStrategy(StringStyles::UCFIRST));
-
-        return $this;
-    }
-
-    /**
-     * @lazy
-     *
-     * @deprecated use DataFrame::renameEach() with a selected Style
-     */
-    public function renameAllUpperCaseWord() : self
-    {
-        $this->renameEach(new RenameCaseEntryStrategy(StringStyles::UCWORDS));
-
-        return $this;
-    }
-
     public function renameEach(RenameEntryStrategy ...$strategies) : self
     {
         $this->pipeline->add(new RenameEachEntryTransformer(...$strategies));

src/core/etl/src/Flow/ETL/Function/ArrayKeysStyleConvert.php

@@ -6,22 +6,15 @@
 
 use Flow\ETL\Exception\InvalidArgumentException;
 use Flow\ETL\{FlowContext, Row};
-use Flow\ETL\Function\StyleConverter\{ArrayKeyConverter, StringStyles as OldStringStyles};
+use Flow\ETL\Function\StyleConverter\ArrayKeyConverter;
 use Flow\ETL\String\StringStyles;
 
 final class ArrayKeysStyleConvert extends ScalarFunctionChain
 {
-    private StringStyles $style;
-
     public function __construct(
         private readonly ScalarFunction $ref,
-        OldStringStyles|StringStyles $style,
+        private readonly StringStyles $style,
     ) {
-        if ($style instanceof OldStringStyles) {
-            $this->style = StringStyles::fromString($style->value);
-        } else {
-            $this->style = $style;
-        }
     }
 
     public function eval(Row $row, FlowContext $context) : mixed

src/core/etl/src/Flow/ETL/Function/ScalarFunctionChain.php

@@ -11,7 +11,6 @@
 use Flow\ETL\Function\ArrayExpand\ArrayExpand;
 use Flow\ETL\Function\ArraySort\Sort;
 use Flow\ETL\Function\Between\Boundary;
-use Flow\ETL\Function\StyleConverter\StringStyles as OldStringStyles;
 use Flow\ETL\Hash\{Algorithm, NativePHPHash};
 use Flow\ETL\String\StringStyles;
 use Flow\Types\Type;
@@ -676,7 +675,7 @@ public function stringNormalize(ScalarFunction|int $form = \Normalizer::NFC) : S
      * Covert string to a style from enum list, passed in parameter.
      * Can be string "upper" or StringStyles::UPPER for Upper (example).
      */
-    public function stringStyle(ScalarFunction|string|OldStringStyles|StringStyles $style) : StringStyle
+    public function stringStyle(ScalarFunction|string|StringStyles $style) : StringStyle
     {
         return new StringStyle($this, $style);
     }

src/core/etl/src/Flow/ETL/Function/StringStyle.php

@@ -7,21 +7,20 @@
 use function Flow\Types\DSL\{type_enum, type_string};
 use Flow\ETL\Exception\InvalidArgumentException;
 use Flow\ETL\{FlowContext, Row};
-use Flow\ETL\Function\StyleConverter\StringStyles as OldStringStyles;
 use Flow\ETL\String\StringStyles;
 
 final class StringStyle extends ScalarFunctionChain
 {
     public function __construct(
         private readonly ScalarFunction|string $string,
-        private readonly ScalarFunction|string|OldStringStyles|StringStyles $style,
+        private readonly ScalarFunction|string|StringStyles $style,
     ) {
     }
 
     public function eval(Row $row, FlowContext $context) : ?string
     {
         $string = (new Parameter($this->string))->asString($row, $context);
-        $style = (new Parameter($this->style))->as($row, $context, type_string(), type_enum(StringStyles::class), type_enum(OldStringStyles::class));
+        $style = (new Parameter($this->style))->as($row, $context, type_string(), type_enum(StringStyles::class));
 
         if ($string === null) {
             return $context->functions()->invalidResult(new InvalidArgumentException('StringStyle function requires non-null value'));
@@ -33,8 +32,6 @@ public function eval(Row $row, FlowContext $context) : ?string
 
         if (is_string($style)) {
             $style = StringStyles::fromString($style);
-        } elseif ($style instanceof OldStringStyles) {
-            $style = StringStyles::fromString($style->value);
         }
 
         if (!$style instanceof StringStyles) {

src/core/etl/src/Flow/ETL/Function/StyleConverter/StringStyles.php

@@ -10,12 +10,9 @@
 use Flow\ETL\Processor\{BatchingProcessor, CollectingProcessor, VoidProcessor};
 use Flow\ETL\Transformer\{CallbackRowTransformer,
     DropEntriesTransformer,
-    EntryNameStyleConverterTransformer,
     LimitTransformer,
-    RenameAllCaseTransformer,
     RenameEachEntryTransformer,
     RenameEntryTransformer,
-    RenameStrReplaceAllEntriesTransformer,
     ScalarFunctionTransformer,
     SelectEntriesTransformer};
 
@@ -38,13 +35,10 @@ final class LimitOptimization implements Optimization
     private array $nonExpandingTransformers = [
         CallbackRowTransformer::class,
         ScalarFunctionTransformer::class,
-        EntryNameStyleConverterTransformer::class,
         SelectEntriesTransformer::class,
         DropEntriesTransformer::class,
-        RenameAllCaseTransformer::class,
         RenameEachEntryTransformer::class,
         RenameEntryTransformer::class,
-        RenameStrReplaceAllEntriesTransformer::class,
         LimitTransformer::class,
     ];
 

src/core/etl/src/Flow/ETL/Pipeline/Optimizer/LimitOptimization.php

@@ -134,6 +134,20 @@ public function rename(string $currentName, string $newName) : self
         return new self($this->entries->rename($currentName, $newName));
     }
 
+    /**
+     * Rename multiple entries in a single pass.
+     *
+     * @param array<string, string> $renames Map of old_name => new_name
+     */
+    public function renameMany(array $renames) : self
+    {
+        if ($renames === []) {
+            return $this;
+        }
+
+        return new self($this->entries->renameMany($renames));
+    }
+
     /**
      * @return Schema
      */

src/core/etl/src/Flow/ETL/Row.php

@@ -330,6 +330,36 @@ public function rename(string|Reference $current, string|Reference $new) : self
         return self::recreate($entries);
     }
 
+    /**
+     * Rename multiple entries in a single pass.
+     *
+     * @param array<string, string> $renames Map of old_name => new_name
+     */
+    public function renameMany(array $renames) : self
+    {
+        if ($renames === []) {
+            return $this;
+        }
+
+        $entries = $this->entries;
+
+        foreach ($renames as $from => $to) {
+            if ($from === $to) {
+                continue;
+            }
+
+            if (!\array_key_exists($from, $entries)) {
+                throw InvalidLogicException::because(\sprintf('Entry "%s" does not exist', $from));
+            }
+
+            $entry = $entries[$from];
+            unset($entries[$from]);
+            $entries[$to] = $entry->rename($to);
+        }
+
+        return self::recreate($entries);
+    }
+
     /**
      * @param Entry<mixed> ...$entries
      */

src/core/etl/src/Flow/ETL/Row/Entries.php

@@ -76,7 +76,7 @@ public function name() : string
      */
     public function rename(string $name) : static
     {
-        return new self($name, $this->value);
+        return new self($name, $this->value, $this->definition->metadata());
     }
 
     public function toString() : string