Mark FormFlow as finished if the last step is skipped

Author: yceruto

Flow/FormFlow.php

@@ -221,6 +221,18 @@ private function move(\Closure $direction): bool
             if (!$this->config->getStep($newStep)->isSkipped($data)) {
                 break;
             }
+
+            if ($cursor->isLastStep()) {
+                $this->finished = true;
+
+                if ($this->config->isAutoReset()) {
+                    $this->reset();
+
+                    return true;
+                }
+
+                break;
+            }
         }
 
         $this->cursor = $cursor;

Tests/Fixtures/Flow/LastStepSkippedType.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\Tests\Fixtures\Flow;
+
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\Form\Flow\AbstractFlowType;
+use Symfony\Component\Form\Flow\FormFlowBuilderInterface;
+use Symfony\Component\Form\Flow\Type\NavigatorFlowType;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class LastStepSkippedType extends AbstractFlowType
+{
+    public function buildFormFlow(FormFlowBuilderInterface $builder, array $options): void
+    {
+        $builder->addStep('step1', TextType::class);
+        $builder->addStep('step2', skip: static fn () => true);
+
+        $builder->add('navigator', NavigatorFlowType::class);
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefaults([
+            'data_class' => null,
+            'step_property_path' => '[currentStep]',
+        ]);
+    }
+}

Tests/Flow/FormFlowTest.php

@@ -26,6 +26,7 @@
 use Symfony\Component\Form\Forms;
 use Symfony\Component\Form\Tests\Fixtures\Flow\Data\UserSignUp;
 use Symfony\Component\Form\Tests\Fixtures\Flow\Extension\UserSignUpTypeExtension;
+use Symfony\Component\Form\Tests\Fixtures\Flow\LastStepSkippedType;
 use Symfony\Component\Form\Tests\Fixtures\Flow\UserSignUpType;
 use Symfony\Component\Validator\Mapping\Factory\LazyLoadingMetadataFactory;
 use Symfony\Component\Validator\Mapping\Loader\AttributeLoader;
@@ -932,4 +933,40 @@ public function testStepValidationGroups()
         // Check that validation groups are updated
         self::assertEquals(['Default', 'professional'], $flow->getConfig()->getOption('validation_groups')($flow));
     }
+
+    public function testLastStepSkippedMarkFlowAsFinished()
+    {
+        $flow = $this->factory->create(LastStepSkippedType::class, ['currentStep' => 'step1']);
+
+        self::assertSame('step1', $flow->getCursor()->getCurrentStep());
+        self::assertFalse($flow->isSubmitted());
+        self::assertNull($flow->getClickedButton());
+        self::assertTrue($flow->has('step1'));
+        self::assertTrue($flow->has('navigator'));
+
+        $navigatorForm = $flow->get('navigator');
+        self::assertCount(1, $navigatorForm->all());
+        self::assertTrue($navigatorForm->has('next'));
+
+        $flow->submit([
+            'step1' => 'foo',
+            'navigator' => [
+                'next' => '',
+            ],
+        ]);
+
+        self::assertSame('step1', $flow->getCursor()->getCurrentStep());
+        self::assertTrue($flow->isSubmitted());
+        self::assertTrue($flow->isValid());
+        self::assertFalse($flow->isFinished());
+        self::assertNotNull($button = $flow->getClickedButton());
+        self::assertTrue($button->isNextAction());
+        self::assertTrue($button->isClicked());
+
+        $button->handle(); // $flow->moveNext() is called internally
+
+        self::assertTrue($flow->isFinished());
+        self::assertNotSame($flow, $flow->getStepForm());
+        self::assertSame(['currentStep' => 'step1', 'step1' => 'foo'], $flow->getData());
+    }
 }