Contrib.social

Clean up gutenberg.settings config

Open on Drupal.org →
Created on 17 January 2024, about 1 year ago

Problem/Motivation

Everytime the relevant entity type for a Gutenberg enabled entity is save, it automatically adds in new changes in the config for every new block instance it finds, which can be annoying if you have loads of derivative fields e.g. block content blocks.

Steps to reproduce

Enable Gutenberg on your Node entity type, save then export the configuration.

Then introduce a new block type instance, e.g. an exposed filter block or a new content block.

Then once you resave the Node entity type, it'll automatically add those new block instances into the config like this in your config diff:

+  'block_content:f5c762e6-962a-42cf-841b-611e5ee40204': 0
+  'block_content:ced96c38-d1a0-4d34-ba1f-946de1291938': 0
+  'block_content:b5bfb9e5-8a8f-4db3-a343-7e3d8522feb6': 0
+  'block_content:59437793-d207-4182-bf96-52fa8c04755a': 0

Proposed resolution

Remove irrelevant config on save, as well as a post update hook to clean up the existing config.

We should ideally store these inside the individual Node entity's third_party_settings, that way it can be modelled consistently in the config schema, just like it was previously done in 📌 Make Gutenberg entity-type-agnostic Needs work , but that's work to be in a future major release since it's a big change to the current data structure.

Remaining tasks

Provide update hook and MR.

User interface changes

N/A

API changes

N/A

Data model changes

Inactive blocks will no longer be exported in the config.

📌 Task
Status

Active

Version

3.0

Component

Code

Created by

codebymikey

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Pipeline finished with Failed
    over 1 year ago
    Total: 182s
    #61203
  • Issue created by @codebymikey
  • Status changed to Needs review about 1 year ago
  • Comment about 1 year ago →
    codebymikey

    Pushed an update normalizing the config, providing an update hook to apply it, as well as removing the redundant gutenberg.mediaedit config.

    The current and new configuration schema can be reviewed using the https://www.drupal.org/project/config_inspector →

  • Merge request !95Issue #3415218: Normalize the gutenberg config → (Closed) created by codebymikey
  • First commit to issue fork.
  • Pipeline finished with Failed
    about 1 year ago
    #79974
  • Merge request !1Revert "Merge branch gutenberg:8.x-2.x into 3415218-clean-up-gutenberg.settings" → (Closed) created by marcofernandes
  • Comment about 1 year ago →
    🇵🇹Portugal marcofernandes

    Hmm.. something went wrong when merging dev. It updated from 2.x. I'll try to revert and do things properly.

  • Pipeline finished with Failed
    about 1 year ago
    #80658
  • Merge request !96Revert "Merge branch gutenberg:8.x-2.x into 3.0.x" → (Closed) created by marcofernandes
  • Comment about 1 year ago →
    System Message
  • Comment about 1 year ago →
    System Message
  • Status changed to Needs work about 1 year ago
  • Comment about 1 year ago →
    🇵🇹Portugal marcofernandes

    This change affects the way the editor loads the configuration to register the blocks. Ex: /js/overrides/register-core-blocks.jsx

  • Merge request !104Issue #3415218: Normalize the gutenberg config → (Merged) created by marcofernandes
  • Comment about 1 year ago →
    🇵🇹Portugal marcofernandes

    marcofernandes → changed the visibility of the branch 3415218-clean-up-gutenberg.settings to hidden.

  • Comment about 1 year ago →
    🇵🇹Portugal marcofernandes

    marcofernandes → changed the visibility of the branch 3415218-clean-up-gutenberg.settings to active.

  • Comment about 1 year ago →
    🇵🇹Portugal marcofernandes

    marcofernandes → changed the visibility of the branch revert-93c85c9e to hidden.

  • Comment about 1 year ago →
    🇵🇹Portugal marcofernandes

    marcofernandes → changed the visibility of the branch 3.0.x to hidden.

  • Pipeline finished with Failed
    about 1 year ago
    Total: 420s
    #83552
  • Pipeline finished with Success
    about 1 year ago
    #84200
  • Pipeline finished with Success
    about 1 year ago
    Total: 189s
    #84787
  • Pipeline finished with Success
    about 1 year ago
    Total: 220s
    #86819
  • Status changed to Fixed about 1 year ago
  • Comment about 1 year ago →
    🇵🇹Portugal marcofernandes

    Because of these changes on the config structure, UpdateAddMediaTest::testMediaUpdate() had to be disabled for now. Follow-up on https://www.drupal.org/project/gutenberg/issues/3418917 📌 Check UpdateAddMediaTest::testMediaUpdate() Active

  • Pipeline finished with Success
    about 1 year ago
    Total: 447s
    #86830
  • Comment about 1 year ago →
    System Message
  • Pipeline finished with Success
    about 1 year ago
    Total: 1111s
    #87143
  • Pipeline finished with Failed
    about 1 year ago
    Total: 916s
    #87421
  • Pipeline finished with Success
    about 1 year ago
    Total: 130s
    #89587
  • Pipeline finished with Success
    about 1 year ago
    Total: 145s
    #89620
  • Pipeline finished with Success
    about 1 year ago
    Total: 204s
    #89659
  • Comment about 1 year ago →
    System Message
  • Pipeline finished with Failed
    about 1 year ago
    #93716
  • Pipeline finished with Failed
    about 1 year ago
    #97284
  • Pipeline finished with Failed
    about 1 year ago
    Total: 272s
    #98974
  • Pipeline finished with Success
    about 1 year ago
    Total: 167s
    #103732
  • Comment about 1 year ago →
    System Message

    Automatically closed - issue fixed for 2 weeks with no activity.

  • Pipeline finished with Failed
    about 1 year ago
    Total: 136s
    #125584
  • Pipeline finished with Success
    about 1 year ago
    Total: 137s
    #126092
  • Pipeline finished with Failed
    about 1 year ago
    #126698
  • Pipeline finished with Failed
    about 1 year ago
    Total: 228s
    #127112
  • Pipeline finished with Success
    about 1 year ago
    Total: 331s
    #127199
  • Pipeline finished with Canceled
    about 1 year ago
    Total: 75s
    #129582
  • Pipeline finished with Success
    about 1 year ago
    Total: 591s
    #130859
  • Pipeline finished with Success
    12 months ago
    #150287
  • Pipeline finished with Failed
    12 months ago
    Total: 273s
    #154793
  • Pipeline finished with Success
    11 months ago
    Total: 191s
    #176971
  • Pipeline finished with Success
    10 months ago
    Total: 1650s
    #193530
  • Pipeline finished with Success
    10 months ago
    Total: 206s
    #204112
  • Pipeline finished with Success
    10 months ago
    Total: 144s
    #204782
  • Pipeline finished with Failed
    9 months ago
    Total: 251s
    #213337
  • Pipeline finished with Success
    9 months ago
    Total: 243s
    #217542
  • Pipeline finished with Success
    9 months ago
    Total: 218s
    #217559
  • Pipeline finished with Canceled
    9 months ago
    #217598
  • Pipeline finished with Failed
    9 months ago
    Total: 311s
    #224662
  • Pipeline finished with Success
    9 months ago
    Total: 282s
    #224850
  • Pipeline finished with Success
    8 months ago
    Total: 172s
    #234263
  • Pipeline finished with Skipped
    8 months ago
    #249823
  • Pipeline finished with Failed
    8 months ago
    Total: 479s
    #250624
  • Pipeline finished with Failed
    8 months ago
    #250668
  • Pipeline finished with Failed
    8 months ago
    Total: 148s
    #260582
  • Pipeline finished with Failed
    8 months ago
    Total: 152s
    #260675
  • Pipeline finished with Failed
    8 months ago
    Total: 169s
    #260683
  • Pipeline finished with Failed
    8 months ago
    #261258
  • Pipeline finished with Success
    8 months ago
    #261303
  • Pipeline finished with Success
    8 months ago
    #261355
  • Pipeline finished with Success
    8 months ago
    #261367
  • Pipeline finished with Success
    7 months ago
    Total: 5243s
    #263398
  • Pipeline finished with Success
    7 months ago
    Total: 4822s
    #264973
  • Pipeline finished with Success
    7 months ago
    Total: 195s
    #270979
  • Pipeline finished with Failed
    7 months ago
    Total: 513s
    #273133
  • Pipeline finished with Failed
    7 months ago
    Total: 339s
    #273373
  • Pipeline finished with Failed
    7 months ago
    Total: 403s
    #273395
  • Pipeline finished with Success
    7 months ago
    Total: 151s
    #280619
  • Pipeline finished with Success
    7 months ago
    Total: 148s
    #280663
  • Pipeline finished with Success
    7 months ago
    Total: 259s
    #281369
  • Pipeline finished with Success
    7 months ago
    Total: 851s
    #281378
  • Pipeline finished with Success
    7 months ago
    #280698
  • Pipeline finished with Success
    7 months ago
    Total: 147s
    #281660
  • Pipeline finished with Success
    7 months ago
    Total: 136s
    #281757
  • Pipeline finished with Success
    7 months ago
    Total: 144s
    #282724
  • Pipeline finished with Success
    7 months ago
    Total: 147s
    #284794
  • Pipeline finished with Success
    7 months ago
    Total: 210s
    #284816
  • Pipeline finished with Success
    7 months ago
    Total: 162s
    #286510
  • Pipeline finished with Success
    7 months ago
    Total: 172s
    #287664
  • Pipeline finished with Success
    7 months ago
    Total: 206s
    #288174
  • Pipeline finished with Canceled
    6 months ago
    Total: 328s
    #291856
  • Pipeline finished with Success
    6 months ago
    Total: 572s
    #291858
  • Pipeline finished with Success
    6 months ago
    Total: 156s
    #291906
  • Pipeline finished with Success
    6 months ago
    Total: 212s
    #291933
  • Pipeline finished with Failed
    6 months ago
    Total: 307s
    #294128
  • Pipeline finished with Failed
    6 months ago
    Total: 152s
    #297383
  • Pipeline finished with Failed
    6 months ago
    Total: 159s
    #300151
  • Pipeline finished with Success
    6 months ago
    Total: 196s
    #301753
  • Pipeline finished with Failed
    6 months ago
    Total: 388s
    #309278
  • Pipeline finished with Failed
    6 months ago
    Total: 405s
    #309279
  • Pipeline finished with Failed
    6 months ago
    Total: 421s
    #309277
  • Merge request !206Issue #3415218 by codebymikey: Normalize the gutenberg.settings config → (Closed) created by codebymikey
  • Pipeline finished with Failed
    6 months ago
    Total: 237s
    #309475
  • Comment 6 months ago →
    codebymikey

    Reopened to address some config normalization issues related to the ✨ Limit available image styles for image related blocks Fixed feature which was added, but doesn't currently have a valid schema.

  • Comment 6 months ago →
    codebymikey

    codebymikey → changed the visibility of the branch 8.x-2.x to hidden.

  • Comment 6 months ago →
    codebymikey

    codebymikey → changed the visibility of the branch 3415218-clean-up-gutenberg.settings-2.x to hidden.

  • Comment 6 months ago →
    codebymikey

    codebymikey → changed the visibility of the branch 3415218-clean-up-gutenberg.settings-2.8 to hidden.

  • Comment 6 months ago →
    codebymikey

    codebymikey → changed the visibility of the branch 3415218-clean-up-gutenberg.settings to hidden.

  • Pipeline finished with Failed
    6 months ago
    Total: 197s
    #310019
  • Comment 6 months ago →
    🇬🇧United Kingdom GHaddon
  • Comment 6 months ago →
    🇪🇪Estonia hkirsman
  • Comment 6 months ago →
    codebymikey

    In the spirit of making the image size support more complete, I've added a commit to the merge request which incorporates changes from ✨ Allow API to restrict which image styles are available to users Active and 📌 Followup: SVG's should not use image styles Active

  • Pipeline finished with Success
    6 months ago
    Total: 255s
    #313501
  • Pipeline finished with Canceled
    5 months ago
    Total: 424s
    #320966
  • Pipeline finished with Success
    5 months ago
    #324430
  • Pipeline finished with Success
    5 months ago
    #332268
  • Pipeline finished with Success
    5 months ago
    #332275
  • Pipeline finished with Skipped
    5 months ago
    #339388
  • Pipeline finished with Success
    5 months ago
    Total: 130s
    #344705
  • Pipeline finished with Success
    4 months ago
    Total: 266s
    #349259
  • Pipeline finished with Failed
    4 months ago
    Total: 173s
    #359324
  • Pipeline finished with Skipped
    4 months ago
    #359382
  • Pipeline finished with Failed
    4 months ago
    Total: 256s
    #368075
  • Pipeline finished with Failed
    4 months ago
    Total: 232s
    #368173
  • Pipeline finished with Canceled
    4 months ago
    Total: 353s
    #368177
  • Pipeline finished with Canceled
    4 months ago
    Total: 212s
    #369663
  • Pipeline finished with Failed
    4 months ago
    Total: 250s
    #369666
  • Pipeline finished with Success
    4 months ago
    Total: 169s
    #371584
  • Pipeline finished with Success
    4 months ago
    Total: 277s
    #373565
  • Pipeline finished with Success
    4 months ago
    Total: 159s
    #373950
  • Pipeline finished with Success
    3 months ago
    Total: 203s
    #394576
  • Pipeline finished with Success
    3 months ago
    Total: 387s
    #394658
  • Pipeline finished with Success
    3 months ago
    Total: 175s
    #394683
  • Pipeline finished with Success
    3 months ago
    Total: 161s
    #394737
  • Pipeline finished with Success
    3 months ago
    Total: 530s
    #397977
  • Pipeline finished with Canceled
    3 months ago
    Total: 102s
    #398212
  • Merge request !215Issue #3415218 by codebymikey: Normalize the gutenberg.settings config → (Open) created by codebymikey
  • Status changed to Needs review about 1 month ago
  • Comment about 1 month ago →
    System Message
  • Pipeline finished with Success
    12 days ago
    Total: 664s
    #455703
contrib.social Blog FAQ Discussions
Production build 0.71.5 2024