Project config values changing between strings and boolean values in different environments #3695

aaronbushnell · 2019-01-23T15:02:03Z

Description

I've updated a project to the latest version of Craft and enabled project config control. When I make changes locally I'm seeing values such as...

siteSettings:
  215a576d-d6b9-41cf-bff5-d7306aa1d646:
    hasUrls: '1'

But when I apply this config to our staging environment these are changed to

siteSettings:
  215a576d-d6b9-41cf-bff5-d7306aa1d646:
    hasUrls: true

Because this change occurs I'm unable to set "allowAdminChanges" => false as I receive an error saying changes to the project config are "read-only".

Additional info

Craft version: 3.1.3
PHP version: 7.2.14
Database driver & version: MySQL 5.7.24
Plugins & versions:

The text was updated successfully, but these errors were encountered:

brandonkelly · 2019-01-23T15:51:01Z

Can you look for the read-only error in your staging server’s storage/logs/ folder and post the stack trace?

aaronbushnell · 2019-01-23T16:16:54Z

Sure! So when I first apply the project config I get this error in staging:

Then I receive the "Changes to the project config are not possible while in read-only mode" error when I choose "Use project.yaml"

And here's the stack trace:

2019-01-23 11:12:43 [-][1][-][error][yii\base\NotSupportedException] yii\base\NotSupportedException: Changes to the project config are not possible while in read-only mode. in /ROOT/vendor/craftcms/cms/src/services/ProjectConfig.php:330
Stack trace:
#0 /ROOT/vendor/craftcms/cms/src/services/Matrix.php(285): craft\services\ProjectConfig->set('matrixBlockType...', Array)
#1 /ROOT/vendor/craftcms/cms/src/services/Matrix.php(601): craft\services\Matrix->saveBlockType(Object(craft\models\MatrixBlockType), false)
#2 /ROOT/vendor/craftcms/cms/src/fields/Matrix.php(715): craft\services\Matrix->saveSettings(Object(craft\fields\Matrix), false)
#3 /ROOT/vendor/craftcms/cms/src/services/Fields.php(1519): craft\fields\Matrix->afterSave(false)
#4 /ROOT/vendor/craftcms/cms/src/services/Fields.php(817): craft\services\Fields->applyFieldSave('e6640bd5-e054-4...', Array, 'global')
#5 /ROOT/vendor/craftcms/cms/src/services/ProjectConfig.php(815): craft\services\Fields->handleChangedField(Object(craft\events\ConfigEvent))
#6 [internal function]: craft\services\ProjectConfig->craft\services\{closure}(Object(craft\events\ConfigEvent))
#7 /ROOT/vendor/yiisoft/yii2/base/Component.php(627): call_user_func(Object(Closure), Object(craft\events\ConfigEvent))
#8 /ROOT/vendor/craftcms/cms/src/services/ProjectConfig.php(517): yii\base\Component->trigger('updateItem', Object(craft\events\ConfigEvent))
#9 /ROOT/vendor/craftcms/cms/src/helpers/ProjectConfig.php(63): craft\services\ProjectConfig->processConfigChanges('fields.e6640bd5...')
#10 /ROOT/vendor/craftcms/cms/src/services/Matrix.php(305): craft\helpers\ProjectConfig::ensureAllFieldsProcessed()
#11 /ROOT/vendor/craftcms/cms/src/services/ProjectConfig.php(815): craft\services\Matrix->handleChangedBlockType(Object(craft\events\ConfigEvent))
#12 [internal function]: craft\services\ProjectConfig->craft\services\{closure}(Object(craft\events\ConfigEvent))
#13 /ROOT/vendor/yiisoft/yii2/base/Component.php(627): call_user_func(Object(Closure), Object(craft\events\ConfigEvent))
#14 /ROOT/vendor/craftcms/cms/src/services/ProjectConfig.php(517): yii\base\Component->trigger('updateItem', Object(craft\events\ConfigEvent))
#15 /ROOT/vendor/craftcms/cms/src/services/ProjectConfig.php(846): craft\services\ProjectConfig->processConfigChanges('matrixBlockType...')
#16 /ROOT/vendor/craftcms/cms/src/services/ProjectConfig.php(402): craft\services\ProjectConfig->_applyChanges(Array)
#17 /ROOT/vendor/craftcms/cms/src/controllers/ConfigSyncController.php(57): craft\services\ProjectConfig->applyYamlChanges()
#18 [internal function]: craft\controllers\ConfigSyncController->actionApplyYamlChanges()
#19 /ROOT/vendor/yiisoft/yii2/base/InlineAction.php(57): call_user_func_array(Array, Array)
#20 /ROOT/vendor/yiisoft/yii2/base/Controller.php(157): yii\base\InlineAction->runWithParams(Array)
#21 /ROOT/vendor/craftcms/cms/src/web/Controller.php(109): yii\base\Controller->runAction('apply-yaml-chan...', Array)
#22 /ROOT/vendor/yiisoft/yii2/base/Module.php(528): craft\web\Controller->runAction('apply-yaml-chan...', Array)
#23 /ROOT/vendor/craftcms/cms/src/web/Application.php(297): yii\base\Module->runAction('config-sync/app...', Array)
#24 /ROOT/vendor/craftcms/cms/src/web/Application.php(722): craft\web\Application->runAction('config-sync/app...')
#25 /ROOT/vendor/craftcms/cms/src/web/Application.php(248): craft\web\Application->_processConfigSyncLogic(Object(craft\web\Request))
#26 /ROOT/vendor/yiisoft/yii2/base/Application.php(386): craft\web\Application->handleRequest(Object(craft\web\Request))
#27 /ROOT/public/index.php(23): yii\base\Application->run()
#28 {main}
2019-01-23 11:12:43 [-][1][-][info][application] $_GET = [
    'p' => 'admin/actions/config-sync/apply-yaml-changes'
]

brandonkelly · 2019-01-23T19:28:36Z

Thanks! Just fixed this for the next release.

You can patch your local install by changing your craftcms/cms requirement in composer.json to:

"require": {
  "craftcms/cms": "dev-develop#6733f86f8a56f0dba61d84d2fa1124b3fad87aee as 3.1.3",
  "...": "..."
}

and then run composer update.

aaronbushnell · 2019-01-23T20:23:01Z

You guys are so dang fast, thanks a ton!

smcyr · 2019-01-23T20:36:05Z

When migrating from Craft 3 to 3.1, the values in project,yaml were like that:

required: '0'
sortOrder: '2'

But if I save a section, field or anything in the control panel in local, the values change to that:

required: false
sortOrder: 2

Why is there this inconsistency? Also, is there a way to regenerate all the project.yaml to have the same format everywhere in the file (boolean and int instead of strings)?
Thanks!

brandonkelly · 2019-01-23T21:25:22Z

It changes based on where the data is coming from. In the initial config generation it’s coming from the database, and if you’re using MySQL, then “boolean” values will be represented as '1' or '0' (as MySQL doesn’t have a boolean column type), and other numeric values will also come back as strings, despite having numeric column types.

If the data is coming from a POST request, then we tend to typecast the post data to actual booleans/numbers.

We have considered normalizing DB data when querying it, but it would be a ton of effort and/or it would slow everything down, depending on how we implemented it. (Active Record classes do a decent job of auto-typecasting for example, but it does so by running additional queries to the DB to learn about the schema, and storing all that data, so it comes at a performance cost.)

It’s only an issue for MySQL, whereas PostgreSQL always has the correct types, both because it does support a boolean column type, and because the PostgreSQL PDO implementation auto-typecasts the values as they’re sent to PHP, based on the column type.

And there’s good news on the horizon for MySQL installs: PHP 7.4 is going to have typed property support, which means that we will be able to normalize the values right at the property level, e.g.

public bool $required;
public int $sortOrder;

Which means the values will be typecasted correctly right as they are assigned to objects, regardless of what the PDO layer gave us.

smcyr · 2019-01-23T21:32:57Z

Ok, thanks a lot for the explanation!
From this and other comments you made on Github, it seems that PostgreSQL would be a good choice for new projects. I'm also excited for typed property support in PHP 7.4!

andris-sevcenko · 2019-01-24T09:36:34Z

@aaronbushnell head ups - I just edited @brandonkelly's comment above with the composer.json snippet to use Craft version "3.1.3" instead to "3.0.3", just FYI in case you already used the snippet.

aaronbushnell · 2019-01-24T12:13:18Z

Ah, thanks @andris-sevcenko!

brandonkelly · 2019-04-23T12:10:14Z

Just merged in #4167 which properly typecasts all core integer and boolean values as they’re saved to the project config. Up to plugin developers to follow suit, but this should take care of most of the awkwardness.

smcyr · 2019-04-23T17:35:19Z

@brandonkelly Thanks for the update, but it seems that some values are still string instead of boolean or integer. For example, after running php craft project-config/rebuild, for the settings for my fields (Assets, Redactor, PlainText, etc.), I have useSingleFolder: '1' or initialRows: '4'. Also, my plugins have enabled: '1'.

brandonkelly · 2019-04-23T18:23:49Z

Yeah good point, this change won’t affect custom field settings, plugin settings, etc.

This reverts commit c7d56db.

andris-sevcenko · 2019-04-24T13:12:49Z

Turns out the added complexity is not really worth it. The settings are stored as a json string, so it wouldn't suddenly change from 0 to false between environments or usage scenarios.

This reverts commit 3bef91d.

smcyr · 2019-04-24T15:54:24Z

I did a project-config/rebuild and the sections still had:

enableVersioning: '1'
propagateEntries: '1'

So maybe the rebuild didn't do the sections or these values are not always typecasted.

andris-sevcenko · 2019-04-24T16:36:14Z

@smcyr Doh. Should be all better with the next release

This reverts commit c7d56db.

brandonkelly closed this as completed in 6733f86 Jan 23, 2019

brandonkelly mentioned this issue Jan 23, 2019

Craft migration throws "Changes to the project config are not possible while in read-only mode" error #3653

Closed

brandonkelly mentioned this issue Feb 20, 2019

Project.yaml - Required and Searchable properties not saved correctly #3872

Closed

nettum mentioned this issue Mar 20, 2019

Project config sync error: Changes to the project config are not possible while in read-only mode. #3957

Open

andris-sevcenko self-assigned this Apr 24, 2019

andris-sevcenko added a commit that referenced this issue Apr 24, 2019

Address #3695

c7d56db

andris-sevcenko reopened this Apr 24, 2019

andris-sevcenko added a commit to craftcms/redactor that referenced this issue Apr 24, 2019

Address craftcms/cms#3695

3bef91d

andris-sevcenko added a commit that referenced this issue Apr 24, 2019

Revert "Address #3695"

bf89e44

This reverts commit c7d56db.

andris-sevcenko closed this as completed Apr 24, 2019

andris-sevcenko added a commit to craftcms/redactor that referenced this issue Apr 24, 2019

Revert "Address craftcms/cms#3695"

018a67e

This reverts commit 3bef91d.

andris-sevcenko added a commit that referenced this issue Apr 24, 2019

Fix #3695 some more.

661389a

angrybrad pushed a commit that referenced this issue May 6, 2019

Address #3695

74483d1

angrybrad pushed a commit that referenced this issue May 6, 2019

Revert "Address #3695"

8c10ce9

This reverts commit c7d56db.

angrybrad pushed a commit that referenced this issue May 6, 2019

Fix #3695 some more.

76213b1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Project config values changing between strings and boolean values in different environments #3695

Project config values changing between strings and boolean values in different environments #3695

aaronbushnell commented Jan 23, 2019 •

edited

Loading

brandonkelly commented Jan 23, 2019

aaronbushnell commented Jan 23, 2019 •

edited

Loading

brandonkelly commented Jan 23, 2019 •

edited by andris-sevcenko

Loading

aaronbushnell commented Jan 23, 2019

smcyr commented Jan 23, 2019 •

edited

Loading

brandonkelly commented Jan 23, 2019

smcyr commented Jan 23, 2019 •

edited

Loading

andris-sevcenko commented Jan 24, 2019 •

edited

Loading

aaronbushnell commented Jan 24, 2019

brandonkelly commented Apr 23, 2019

smcyr commented Apr 23, 2019

brandonkelly commented Apr 23, 2019

andris-sevcenko commented Apr 24, 2019

smcyr commented Apr 24, 2019

andris-sevcenko commented Apr 24, 2019

Project config values changing between strings and boolean values in different environments #3695

Project config values changing between strings and boolean values in different environments #3695

Comments

aaronbushnell commented Jan 23, 2019 • edited Loading

Description

Additional info

brandonkelly commented Jan 23, 2019

aaronbushnell commented Jan 23, 2019 • edited Loading

brandonkelly commented Jan 23, 2019 • edited by andris-sevcenko Loading

aaronbushnell commented Jan 23, 2019

smcyr commented Jan 23, 2019 • edited Loading

brandonkelly commented Jan 23, 2019

smcyr commented Jan 23, 2019 • edited Loading

andris-sevcenko commented Jan 24, 2019 • edited Loading

aaronbushnell commented Jan 24, 2019

brandonkelly commented Apr 23, 2019

smcyr commented Apr 23, 2019

brandonkelly commented Apr 23, 2019

andris-sevcenko commented Apr 24, 2019

smcyr commented Apr 24, 2019

andris-sevcenko commented Apr 24, 2019

aaronbushnell commented Jan 23, 2019 •

edited

Loading

aaronbushnell commented Jan 23, 2019 •

edited

Loading

brandonkelly commented Jan 23, 2019 •

edited by andris-sevcenko

Loading

smcyr commented Jan 23, 2019 •

edited

Loading

smcyr commented Jan 23, 2019 •

edited

Loading

andris-sevcenko commented Jan 24, 2019 •

edited

Loading