baldwin/magento2-module-url-data-integrity-checker

Magento 2 module which can find potential url related problems in your catalog data

Maintainers

Details

github.com/baldwin-agency/magento2-module-url-data-integrity-checker

Source

Issues

Installs: 528 506

Dependents: 1

Suggesters: 1

Security: 0

Stars: 263

Watchers: 14

Forks: 29

Open Issues: 8

Type:magento2-module

v1.5.3 2024-03-22 16:45 UTC

Requires

  • php: ~7.0.0 || ~7.1.0 || ~7.2.0 || ~7.3.0 || ~7.4.0 || ~8.1.0 || ~8.2.0 || ~8.3.0
  • magento/framework: ^100.1 || ^101.0 || ^102.0 || ^103.0
  • magento/module-backend: ^100.1 || ^101.0 || ^102.0
  • magento/module-catalog: ^101.0 || ^102.0 || ^103.0 || ^104.0
  • magento/module-config: ^100.1 || ^101.0
  • magento/module-cron: ^100.1
  • magento/module-store: ^100.1 || ^101.0
  • magento/module-theme: ^100.1 || ^101.0
  • magento/module-ui: ^100.1 || ^101.0
  • symfony/console: ^2.5 || ^3.0 || ^4.0 || ^5.0 || ^6.0

Requires (Dev)

MIT 6ab34483c1e4c3b79ce379424b8f7bed4d2eef6f

  • Pieter Hoste <pieter.woop@baldwin.be>

This package is auto-updated.

Last update: 2024-11-06 16:39:23 UTC

README

Purpose

The purpose of this module is to give store owners of a Magento 2 shop insight into what url-related problems they have in their products, categories and url rewrites.
It was explicitly chosen not to have automated fixers for these problems, since fixing these issues can have a significant SEO impact.
It should be up to the store owner to figure out how he/she wants to fix these problems. Doing this with an automated tool might have a negative impact on SEO rankings, hence why it only reports problems and doesn't try to fix them.

Implemented features

  • It can detect categories having incorrect url_path attribute values
  • It can detect categories having duplicated url_key attribute values within the same parent
  • It can detect categories having an empty url_key attribute value
  • It can detect products having non-empty url_path attribute values
  • It can detect products having duplicated url_key attribute values on the same store view
  • It can detect products having an empty url_key attribute value

Roadmap

  • Detecting incorrectly generated url rewrites
  • Making cronjob execution times configurable
  • Increasing performance of checkers, these are currently written for accuracy and not for speed
  • Add a legend above the admin grids with a mapping of store view id's with their names
  • Improve tests
  • ...

Compatibility

This module should be compatible with Magento 2.1.x, 2.2.x, 2.3.x and 2.4.x versions.
Some code in this module is using old ways of doing things. It could have been written in a more modern way (using message queues instead of cronjobs, use newer syntax for UI components, ...). But we wanted this module to be compatible with older versions of Magento, so we've chosen this route for now.

The module should be compatible with PHP 7.1, 7.2, 7.3, 7.4, 8.1, 8.2 and 8.3

Installation

You can use composer to install this module:

composer require baldwin/magento2-module-url-data-integrity-checker

Or download the code and put all the files in the directory app/code/Baldwin/UrlDataIntegrityChecker

After which you can then activate it in Magento using:

bin/magento setup:upgrade

Usage

There are some automatic cronjobs running every night at 02:10, 02:15, 02:20 and 02:30 which will run the various checkers of this module.
You can also opt to manually refresh one of the checkers in the Magento admin, which will schedule one of the cronjobs to be ran the next minute. You'll have to wait a few minutes (depending on the number of problems and how big your catalog is) before you'll see the results appearing. You'll need to refresh the page yourself btw, it won't happen by itself.

There are also some cli commands you can execute, which will give you instant feedback about found problems, and will also store that data so you can see them in the Magento admin:

  • bin/magento catalog:category:integrity:urlkey
  • bin/magento catalog:category:integrity:urlpath
  • bin/magento catalog:product:integrity:urlkey
  • bin/magento catalog:product:integrity:urlpath

In the Magento admin, you can find the results in:

  • for Magento 2.1.x: Products > Data Integrity Checker
  • for Magento 2.2.0 and higher: Catalog > Data Integrity Checker

The results of the checkers are currently stored by default in the directory var/tmp as .json files.
But you can change the path in the backend settings under Stores > Configuration > Catalog > Url Data Integrity Checker by entering a relative path starting from the Magento installation directory or an absolute path. The directory you enter there needs to exist before it will work.

You can configure this module to ignore problems with invisible products (via Stores > Configuration > Catalog > Url Data Integrity Checker). Because in recent versions of Magento, url rewrites for invisible products are not being generated, so if there are problems with the url_path or url_key attributes of such products, they should not cause issues with url rewrites. An additional benefit of this option is that it will use less time and less memory to run the product checkers. This option is disabled by default, so you'll need to enable it.

Some screenshots

Example of backend report for product url key problems

Backend example for product url keys

Example of cli report for category url path problems

CLI example for category url paths

Contributing

After cloning your fork:

  1. Create an auth.json file with your credentials for https://repo.magento.com/
  2. Run composer install
  3. Make sure running make check doesn't report problems with proposed changes