bin/magento setup:db:status does not recognize JSON type

[MTheProgrammer]

Preconditions and environment

• Magento 2.4.6-p3
• MariaDB:10.6

Command setup:db:status is useful for deployment tools to determine whether setup:upgrade should be run.

Steps to reproduce

Create a module with a new table with JSON column:

db_schema.xml:

    <table name="example_table" engine="innodb" resource="default">
        <column xsi:type="int" name="entity_id" identity="true" nullable="false" unsigned="true"/>
        <column xsi:type="json" name="content" nullable="false"/>
        <constraint referenceId="PRIMARY" xsi:type="primary">
            <column name="feed_missing_id"/>
        </constraint>
    </table>

Run

bin/magento setup:db-declaration:generate-whitelist --module-name Sample_Module
bin/magento setup:upgrade
bin/magento setup:db:status

Expected result

Reported schema is up to date

Actual result

Declarative Schema is not up to date
Run 'setup:upgrade' to update your DB schema and data.

Additional information

You can debug results with breakpoint or var_dump in
\Magento\Framework\Setup\Declaration\Schema\UpToDateDeclarativeSchema::isUpToDate

Search for old and new phrases, e.g. bin/magento setup:db:status | grep old -n10. Following results indicate that the column type is resolved from the database as longtext but the new value is json. JSON is stored as longtext and the diff will always report that columns differ.

Perhaps this is only an issue in MariaDB because JSON is an alias for LONGTEXT and should work fine on MySQL.

Sample output:

bin/magento setup:db:status | grep old -n10
12467:    ["old":"Magento\Framework\Setup\Declaration\Schema\ElementHistory":private]=>
12468-    object(Magento\Framework\Setup\Declaration\Schema\Dto\Columns\Text)#14665 (6) {
12469-      ["type":"Magento\Framework\Setup\Declaration\Schema\Dto\GenericElement":private]=>
12470-      string(8) "longtext"
12471-      ["name":"Magento\Framework\Setup\Declaration\Schema\Dto\GenericElement":private]=>
12472-      string(7) "content"
12473-      ["table":"Magento\Framework\Setup\Declaration\Schema\Dto\Column":private]=>
12474-      object(Magento\Framework\Setup\Declaration\Schema\Dto\Table)#14661 (13) {
12475-        ["type":"Magento\Framework\Setup\Declaration\Schema\Dto\GenericElement":private]=>
12476-        string(5) "table"
12477-        ["name":"Magento\Framework\Setup\Declaration\Schema\Dto\GenericElement":private]=>

bin/magento setup:db:status | grep new -n10
1-array(1) {
2-  [0]=>
3-  object(Magento\Framework\Setup\Declaration\Schema\ElementHistory)#15359 (2) {
4:    ["new":"Magento\Framework\Setup\Declaration\Schema\ElementHistory":private]=>
5-    object(Magento\Framework\Setup\Declaration\Schema\Dto\Columns\Blob)#8029 (6) {
6-      ["type":"Magento\Framework\Setup\Declaration\Schema\Dto\GenericElement":private]=>
7-      string(4) "json"
8-      ["name":"Magento\Framework\Setup\Declaration\Schema\Dto\GenericElement":private]=>
9-      string(7) "content"
10-      ["table":"Magento\Framework\Setup\Declaration\Schema\Dto\Column":private]=>
11-      object(Magento\Framework\Setup\Declaration\Schema\Dto\Table)#8025 (13) {
12-        ["type":"Magento\Framework\Setup\Declaration\Schema\Dto\GenericElement":private]=>
13-        string(5) "table"
14-        ["name":"Magento\Framework\Setup\Declaration\Schema\Dto\GenericElement":private]=>

Workaround: use longtext instead of json.

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 @MTheProgrammer. 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. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

• @magento give me 2.4-develop instance - upcoming 2.4.x release
• 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-November. 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

  - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
  - 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-November]

Hello @MTheProgrammer,

Thank you for the report and collaboration!

We tried to reproduce this issue on 2.4-develop, but in our case it is not reproducible.
Created a db_schema.xml with JSON column in a custom module, generated db_schema_whitelist and ran setup:upgrade and setup:db:status, and got the expected result.
Please take a look at the screenshot:

Please find the custom module used here, and let us know if we are missing anything.
DbVendor.zip

Thank you.

[MTheProgrammer]

Hello, thank you for the quick response. Have you tested with MySQL or MariaDB? The problem only affects MariaDB.

You can use Mark Shust's docker for Magento to quickly setup the infrastructure.

I was able to reproduce the issue with your custom module.

[engcom-November]

Hello @MTheProgrammer,

Thank you for the quick response!

We were able to verify this issue on 2.4-develop with MariaDB as database.
After setup:upgrade when running setup:db:status we got the result as Declarative Schema is not up to date.
Please take a look at the screenshot below:

Hence confirming the issue.

Thank you.