New category saved from the repository has an invalid path

[thomas-kl1]

Preconditions and environment

• Magento version : 2.4.7

Steps to reproduce

Simplified version:

<?php

declare(strict_types=1);

namespace Foo;

use Magento\Catalog\Api\CategoryRepositoryInterface;
use Magento\Catalog\Model\Category;
use Magento\Catalog\Model\ResourceModel\Category\Collection;
use Magento\Catalog\Model\ResourceModel\Category\CollectionFactory;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Setup\Patch\DataPatchInterface;

class Bar
{
    public function __construct(
        private CollectionFactory $collectionFactory,
        private CategoryRepositoryInterface $categoryRepository
    ) {}

    /**
     * @throws LocalizedException
     */
    public function apply(): void
    {
        /** @var Collection $collection */
        $collection = $this->collectionFactory->create();

        /** @var Category $category */
        $category = $collection->getNewEmptyItem();
        $category->setName($name);
        $category->setIsActive(true);
        $category->setParentId(Category::TREE_ROOT_ID);

        // If we use the repository, the path is not correctly setup on 
        $this->categoryRepository->save($category);

        // If we use the save method of the model, the path is correctly set
        //$category->save();
    }
}

Expected result

Path is like : 1/256 (where 256 is the freshly created category ID)

Actual result

Path is: 1

Additional information

It seems that

magento2/app/code/Magento/Catalog/Model/ResourceModel/Category.php

Line 310 in 727294d

$object->setPath($object->getPath() . '/');

is never reached.

$object->setPath($object->getPath() . '/');

So the following is called

magento2/app/code/Magento/Catalog/Model/ResourceModel/Category.php

Line 335 in 727294d

if (substr((string)$object->getPath(), -1) == '/') {

        /**
         * Add identifier for new category
         */
        if (substr((string)$object->getPath(), -1) == '/') {
            $object->setPath($object->getPath() . $object->getId());
            $this->_savePath($object);
        }

Release note

No response

Triage and priority

• Severity: S0 - Affects critical data or functionality and leaves users without workaround.
• Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
• Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
• Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
• Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

[m2-assistant]

Hi @thomas-kl1. Thank you for your report.
To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce.

• For more details, review the Magento Contributor Assistant documentation.
• Add a comment to assign the issue: @magento I am working on this
• To learn more about issue processing workflow, refer to the Code Contributions.

---

Join Magento Community Engineering Slack and ask your questions in #github channel.
⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.
🕙 You can find the schedule on the Magento Community Calendar page.
📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

[m2-assistant]

Hi @engcom-Hotel. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
• 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
• 4. Verify that the issue is reproducible on 2.4-develop branch
  Details

  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
• 5. Add label Issue: Confirmed once verification is complete.
• 6. Make sure that automatic system confirms that report has been added to the backlog.

[engcom-Hotel]

Hello @thomas-kl1,

Thanks for the report and collaboration!

We have tried to reproduce the issue in the latest development branch i.e. 2.4-develop but the issue is not reproducible for us. In order to reproduce it we have created a console command, the code for the same is as follows:

<?php
/**
 * Copyright ©  All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Magz\Issues39738\Console\Command;

use Magento\Setup\Exception;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Magento\Catalog\Api\CategoryRepositoryInterface;
use Magento\Catalog\Model\Category;
use Magento\Catalog\Model\ResourceModel\Category\Collection;
use Magento\Catalog\Model\ResourceModel\Category\CollectionFactory;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Setup\Patch\DataPatchInterface;

class Addnewcat extends Command
{

    private const NAME_ARGUMENT = "name";
    private const NAME_OPTION = "option";

    public function __construct(
        private CollectionFactory           $collectionFactory,
        private CategoryRepositoryInterface $categoryRepository
    )
    {
        parent::__construct();

    }

    /**
     * @inheritdoc
     */
    protected function execute(
        InputInterface  $input,
        OutputInterface $output
    ): int
    {
        try {
            /** @var Collection $collection */
            $collection = $this->collectionFactory->create();

            /** @var Category $category */
            $category = $collection->getNewEmptyItem();
            $name = "Test Category " . time();
            $category->setName($name);
            $category->setIsActive(true);
            $category->setParentId(Category::TREE_ROOT_ID);

            // If we use the repository, the path is not correctly setup on
            $this->categoryRepository->save($category);

            // If we use the save method of the model, the path is correctly set
            //$category->save();
        } catch (Exception $exception) {
            $output->writeln("<error>Exception: {$exception->getMessage()}</error>");
            return Command::FAILURE;
        } catch (LocalizedException $exception) {
            $output->writeln("<error>LocalizedException: {$exception->getMessage()}</error>");
            return Command::FAILURE;
        } catch (\Throwable $exception) {
            $output->writeln("<error>Throwable: {$exception->getMessage()}</error>");
            return Command::FAILURE;
        }
        $output->writeln("<info>Category created successfully</info>");
        return Command::SUCCESS;
    }

    /**
     * @inheritdoc
     */
    protected function configure(): void
    {
        $this->setName("magz_issues39738:addnewcat");
        $this->setDescription("Add New Category");
        parent::configure();
    }
}

And the new category has been created successfully, please refer to the below screenshot:

Let us know if we missed anything.

Thanks

[thomas-kl1]

Did you checked the path value in db?

[engcom-Hotel]

Yes @thomas-kl1,

Checked in the catalog_category_entity table it shows path like this 1/35 and 1/36. Please refer to the below screenshot:

[ananth-iyer]

@thomas-kl1 Here is code to create category:

/** @var \Magento\Catalog\Model\Category $category */
$category = $this->categoryFactory->create();
$parentCategory = $this->categoryFactory->create()->load($parentId);
$parentPath = $parentCategory->getPath();

$category->setName($categoryName);
$category->setIsActive(true);
$category->setParentId($parentId);
$category->setLevel(null);
$category->setIncludeInMenu(true);
$category->setAttributeSetId($category->getDefaultAttributeSetId());
$category->setStoreId(0);
$category->setIsAnchor(1);
$category->setUrlKey($urlKey);

try {
    $category->setPath($parentPath . $category->getId());
    $category->save();
    return $category->getId();
} catch (\Exception $e) {
    throw new \Magento\Framework\Exception\LocalizedException(__('Error creating category: ' . $e->getMessage()));
}```

[thomas-kl1]

I don't get your point @ananth-iyer, what do you want to mean?

I'm reporting an issue I have on 2.4.6, it may seems fixed on 2.4.7 (2.4-develop). Hence I need to confirm it is ok now

[ananth-iyer]

@thomas-kl1 Yes, tested it on 2.4.6. There are some extra lines which I found in M2 core files while creating the categories.

We were having the same lines that you shared in first message. After adding missing lines the categories are created properly.
Regards.