remove dependency of magento sequence library

Author: manjusha729

composer.json

@@ -13,7 +13,6 @@
         "aws/aws-sdk-php": "^3.132",
         "codeception/codeception": "^5.0",
         "codeception/module-asserts": "^3.0",
-        "codeception/module-sequence": "^3.0",
         "codeception/module-webdriver": "^4.0",
         "composer/composer": "^1.9||^2.0,!=2.2.16",
         "csharpru/vault-php": "^4.2.1",

composer.lock

@@ -0,0 +1,134 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Magento\FunctionalTestingFramework\Codeception\Module;
+
+use Codeception\Module;
+use Codeception\Exception\ModuleException;
+use Codeception\TestInterface;
+
+/**
+ * Sequence solves data cleanup issue in alternative way.
+ * Instead cleaning up the database between tests,
+ * you can use generated unique names, that should not conflict.
+ * When you create article on a site, for instance, you can assign it a unique name and then check it.
+ *
+ * This module has no actions, but introduces a function `sq` for generating unique sequences within test and
+ * `sqs` for generating unique sequences across suite.
+ *
+ * ### Usage
+ *
+ * Function `sq` generates sequence, the only parameter it takes, is id.
+ * You can get back to previously generated sequence using that id:
+ *
+ * ``` php
+ * <?php
+ * sq('post1'); // post1_521fbc63021eb
+ * sq('post2'); // post2_521fbc6302266
+ * sq('post1'); // post1_521fbc63021eb
+ * ```
+ *
+ * Example:
+ *
+ * ``` php
+ * <?php
+ * $I->wantTo('create article');
+ * $I->click('New Article');
+ * $I->fillField('Title', sq('Article'));
+ * $I->fillField('Body', 'Demo article with Lorem Ipsum');
+ * $I->click('save');
+ * $I->see(sq('Article') ,'#articles')
+ * ```
+ *
+ * Populating Database:
+ *
+ * ``` php
+ * <?php
+ *
+ * for ($i = 0; $i<10; $i++) {
+ *      $I->haveInDatabase('users', array('login' => sq("user$i"), 'email' => sq("user$i").'@email.com');
+ * }
+ * ```
+ *
+ * Cest Suite tests:
+ *
+ * ``` php
+ * <?php
+ * class UserTest
+ * {
+ *     public function createUser(AcceptanceTester $I)
+ *     {
+ *         $I->createUser(sqs('user') . '@mailserver.com', sqs('login'), sqs('pwd'));
+ *     }
+ *
+ *     public function checkEmail(AcceptanceTester $I)
+ *     {
+ *         $I->seeInEmailTo(sqs('user') . '@mailserver.com', sqs('login'));
+ *     }
+ *
+ *     public function removeUser(AcceptanceTester $I)
+ *     {
+ *         $I->removeUser(sqs('user') . '@mailserver.com');
+ *     }
+ * }
+ * ```
+ *
+ * ### Config
+ *
+ * By default produces unique string with param as a prefix:
+ *
+ * ```
+ * sq('user') => 'user_876asd8as87a'
+ * ```
+ *
+ * This behavior can be configured using `prefix` config param.
+ *
+ * Old style sequences:
+ *
+ * ```yaml
+ * Sequence:
+ *     prefix: '_'
+ * ```
+ *
+ * Using id param inside prefix:
+ *
+ * ```yaml
+ * Sequence:
+ *     prefix: '{id}.'
+ * ```
+ */
+class Sequence extends Module
+{
+    /**
+     * @var array<int|string,string>
+     */
+    public static array $hash = [];
+
+    /**
+     * @var array<int|string,string>
+     */
+    public static array $suiteHash = [];
+
+    public static string $prefix = '';
+
+    /**
+     * @var array<string, string>
+     */
+    protected array $config = ['prefix' => '{id}_'];
+
+    public function _initialize(): void
+    {
+        static::$prefix = $this->config['prefix'];
+    }
+
+    public function _after(TestInterface $test): void
+    {
+        self::$hash = [];
+    }
+
+    public function _afterSuite(): void
+    {
+        self::$suiteHash = [];
+    }
+}

src/Codeception/Module/Sequence.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+namespace Magento\FunctionalTestingFramework\Codeception\Util;
+
+
+use Magento\FunctionalTestingFramework\Codeception\Module\Sequence;
+
+function sq(int|string|null $id = null): string
+{
+    if ($id && isset(Sequence::$hash[$id])) {
+        return Sequence::$hash[$id];
+    }
+
+    $prefix = str_replace('{id}', (string)$id, Sequence::$prefix);
+    $sequence = $prefix . uniqid((string)$id);
+    if ($id) {
+        Sequence::$hash[$id] = $sequence;
+    }
+
+    return $sequence;
+}
+
+function sqs(int|string|null $id = null): string
+{
+    if ($id && isset(Sequence::$suiteHash[$id])) {
+        return Sequence::$suiteHash[$id];
+    }
+
+    $prefix = str_replace('{id}', (string)$id, Sequence::$prefix);
+    $sequence = $prefix . uniqid((string)$id);
+    if ($id) {
+        Sequence::$suiteHash[$id] = $sequence;
+    }
+
+    return $sequence;
+}

src/Codeception/Util/sq.php

@@ -7,7 +7,7 @@
 // @codingStandardsIgnoreFile
 namespace Magento\FunctionalTestingFramework\Module;
 
-use Codeception\Module\Sequence;
+use Magento\FunctionalTestingFramework\Codeception\Module\Sequence;
 use Codeception\Exception\ModuleException;
 
 /**

src/Magento/FunctionalTestingFramework/Codeception/Module/Sequence.php

@@ -1,28 +1,34 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
- 
+
 use Magento\FunctionalTestingFramework\Module\MagentoSequence;
 
 if (!function_exists('msq')) {
     /**
      * Return unique sequence within test.
      *
-     * @param null $id
-     * @return string
+     * @param int|string|null $id Optional identifier for the sequence.
+     * @return string The generated unique sequence.
      */
-    function msq($id = null)
+    function msq(int|string|null $id = null): string
     {
-        if ($id and isset(MagentoSequence::$hash[$id])) {
+        if ($id !== null && isset(MagentoSequence::$hash[$id])) {
             return MagentoSequence::$hash[$id];
         }
-        $prefix = MagentoSequence::$prefix;
-        $sequence = $prefix . uniqid();
-        if ($id) {
-            MagentoSequence::$hash[$id] = $sequence;
+
+        $prefix = MagentoSequence::$prefix ?? '';
+        $sequence = $prefix . uniqid('', true); // Use true for high-entropy ID
+
+        if ($id !== null) {
+            MagentoSequence::$hash[$id] = $sequence; // Avoid dynamic properties
         }
+
         return $sequence;
     }
 }
@@ -31,19 +37,22 @@ function msq($id = null)
     /**
      * Return unique sequence within suite.
      *
-     * @param null $id
-     * @return string
+     * @param int|string|null $id Optional identifier for the suite sequence.
+     * @return string The generated unique suite sequence.
      */
-    function msqs($id = null)
+    function msqs(int|string|null $id = null): string
     {
-        if ($id and isset(MagentoSequence::$suiteHash[$id])) {
+        if ($id !== null && isset(MagentoSequence::$suiteHash[$id])) {
             return MagentoSequence::$suiteHash[$id];
         }
-        $prefix = MagentoSequence::$prefix;
-        $sequence = $prefix . uniqid();
-        if ($id) {
-            MagentoSequence::$suiteHash[$id] = $sequence;
+
+        $prefix = MagentoSequence::$prefix ?? '';
+        $sequence = $prefix . uniqid('', true); // Use true for high-entropy ID
+
+        if ($id !== null) {
+            MagentoSequence::$suiteHash[$id] = $sequence; // Avoid dynamic properties
         }
+
         return $sequence;
     }
 }