Problem/Motivation
The 2.x branch and its commits violated semver and d.o rules, adding many unreviewed commits and regressions, causing mess and wasted resources.
This issue is about cleaning up the 2.x branch to bring it back inline with the work in the 1.x branch.
This issue is not about discussing accountability or governance impacts, please open other issues if needed.
Proposed resolution
- [X] Mark 2.x unsupported
- [X] Announce the cleanup on the project page
- [X] Create a 3.0.x branch to resume the 1.x work (so it is clear to people that they have to upgrade)
- [ ] Collect all 2.x commit issues
- [ ] Bulk assign all 2.x issues to 3.x
- [ ] Reopen issues committed to 2.x
- [ ] Finish the stable 1.x / now 3.0.x release
List of issues for more thorough review
- #3076005: Complex Widget selects wrong bundle when multiple bundles exist but user only has access to create one.
- #3197629: New API hooks to react on inline entity save/delete
- #3332376: Translated entity should be used for the table presentation in the widget
- #3088901: Can't add more than two items with simple inline entity form widget under some circumstances
- #3002628: Allow inline entity form submit handler to return the saved entity
- #3097411: Entity form simple weight duplicates
- #3358281: Wrong bundle form is displayed if user has permissions to create only one of the available bundles
- [#]
- [#]
List of issues to commit soon-ish
Approved (geek-merlin) in the process of cleanup.
- #2855627: Quick Edit not working for Inline Entity Form - Complex
- #3325698: Using 'migrate' without 'migrate_plus' leads to fatal PHP error
- #3204518: Change type hints in inline_entity_form.api.php to align with Drupal core
- #3263281: Drupal 10
- #3315720: TypeError: krsort(): Argument #1 ($array) must be of type array, null given in krsort()
- #3311501: Add label to weight select field for accessibility
- #3325698: Using 'migrate' without 'migrate_plus' leads to fatal PHP error
- #3359875: Memory allocation error
- #3224955: Allow themes to alter inline entity forms
- #3209349: Speed up FunctionalJavascriptTests tests
List of 1.x commite with no tag
# (tag: 2.0.0-rc8, tag: 2.0.0-rc6, origin/HEAD, origin/8.x-1.x, 8.x-1.x) Patch #9: let a user specify if her blog entries should be votable applied, Issue #2855627: Quick Edit not working for Inline Entity Form - Complex
List of closed 2.x issues not mentioned in commit message, and not obvious regression fix
- #3325698: Using 'migrate' without 'migrate_plus' leads to fatal PHP error
- #3043511: Pass context to canAddNew() and getCreateBundles()
- #3359875: Memory allocation error
- #3358281: Wrong bundle form is displayed if user has permissions to create only one of the available bundles
- #3358281: Wrong bundle form is displayed if user has permissions to create only one of the available bundles
- #3224955: Allow themes to alter inline entity forms
- #3209349: Speed up FunctionalJavascriptTests tests
List of 2.x commits
# Added the option to not open the default creation form for the required field
# fix: no need for core while we have info file
# docs: simple formatting
# Issue #3325698: Using 'migrate' without 'migrate_plus' leads to fatal PHP error by dsnopek, geek-merlin: Using 'migrate' without 'migrate_plus' leads to fatal PHP error
# Issue #2941274: Error: Call to a member function id() on boolean by mattjones86, Chris Matthews: Error: Call to a member function id() on boolean
# Issue #3076005: Complex Widget selects wrong bundle when multiple bundles exist but user only has access to create one. by rlmumford, Dinesh18: Complex Widget selects wrong bundle when multiple bundles exist but user only has access to create one
# Issue #3197629: New API hooks to react on inline entity save/delete by JordiK, Odai Atieh: New API hooks to react on inline entity save/delete
# Issue #3204518: Change type hints in inline_entity_form.api.php to align with Drupal core by stefan.korn: Change type hints in inline_entity_form.api.php to align with Drupal core
# Reworked ComplexWidgetRevisionsTest
# Only visual changes
# Allow themes to implement the hook_inline_entity_form_entity_form_alter() and hook_inline_entity_form_reference_form_alter() hooks
# Issue #2989028: Fix integration with content moderation in multi-lingual scenarios by andreyjan, rp7, nicrodgers, texas-bronius: Fix integration with content moderation in multi-lingual scenarios
# Issue #2637880: Ability to reference an entity and auto open its edit form by Charlie ChX Negyesi: Ability to reference an entity and auto open its edit form
# Issue #3263281: Drupal 10 by chr.fritsch,podarok: Drupal 10 - rector and CodeSniffer
# Update src/Form/NodeInlineForm.php
# Issue #3315720: TypeError: krsort(): Argument #1 ($array) must be of type array, null given in krsort() by gauravjeet: TypeError: krsort(): Argument [#1] ($array) must be of type array, null given in krsort()
# Issue #3030273: Allow hiding fieldset and title by Pancho, nevergone, ershov.andrey: Allow hiding fieldset and title
# (tag: 2.0.0-beta2, tag: 2.0.0-beta1) Issue #2581223: Support for configuration entities by Spokje, Dylan Donkersgoed, attisan, DieterHolvoet, jienckebd, Suresh Prabhu Parkala, KapilV, dwkitchen: Support for configuration entities
# (tag: 2.0.0-beta3) Issue[#3257479]: Rerolled patch againist 2.0.x
# Added the option to not open the default creation form for the required field
# Resolved merge conflicts during rebase.
# Updated the changes from the previous commit.
# Updated the patch changes for 2.0.x branch
# Issue #3358843: Multiple duplicated messages while validating the inline entity form fix multiple errors while validating entity
# When we don't know what bundle to use when adding a new entity, instead of selecting the first one from the configured target bundles, limit it to only the first one of the user's ALLOWED bundles.
# (tag: 2.0.0-beta5) Issue #3332376: Translated entity should be used for the table presentation in the widget: Translated entity should be used for the table presentation in the widget
# Avoid memory limit error when checking for referenceable entities
# (tag: 2.0.0-beta6) Issue #3247446: Auto-open inline entity forms (especially for cardinality: 1) by filsterjisah, bharath-kondeti, Anybody: Auto-open inline entity forms (especially for cardinality: 1)
# Issue #3088901: Can't add more than two items with simple inline entity form widget under some circumstances by AndyF, sanfair, Dylan Donkersgoed, andrei.vesterli, mlahde: Can't add more than two items with simple inline entity form widget under some circumstances
# Issue #3311501: Add label to weight select field for accessibility by edmund.dunn, geek-merlin: Add label to weight select field for accessibility
# Issue #3002628: Allow inline entity form submit handler to return the saved entity by jamiehollern, petar.gnjidic: Allow inline entity form submit handler to return the saved entity
# Issue #3097411: Entity form simple weight duplicates by tetranz, MorinLuc0, luizsgpetri: Entity form simple weight duplicates
# (tag: 2.0.0-beta7) Issue #3061620: D8: Multiple forms submit/cancel closes all child forms by paper boy, mrinalini9: D8: Multiple forms submit/cancel closes all child forms
# Patch #8 applied
# (tag: 2.0.0-beta8) fix: non needed suggestion
# Patch #2 Applied
# Patch #6 applied, Issue #3269087: Create/Update Labels buttons naming improvement
# Tried to fix test fail issue
# (tag: 2.0.0-rc2) Updated info.yml files according to modified deprecated code
# Removed deprecated code
# Patch #9 applied, Issue #2855627: Quick Edit not working for Inline Entity Form - Complex
# Patch #4 applied, Issue #3169590: Notice: Undefined index: label in modules/contrib/inline_entity_form/inline_entity_form.module on line 345
# (tag: 2.0.0-rc3) Patch #17 applied, Issue #2830136: Changes are not saved for some submit buttons
# Issue #3015323: Add hook_inline_entity_form_[entity|ENTITYTYPE]_prepare_form by ziomizar, eugene.brit, Musa.thomas: IEF does not invoke hook_entity_prepare_form
# Issue #3362087: Fix the issues reported by phpcs by urvashi_vora, apaderno: Fix the issues reported by phpcs
# (tag: 2.0.0-rc4) Issue #3136514: IEF complex widget: Re-ordering / weight sometimes not updated by mmaldonado, R_H-L, StryKaizer, Rajab Natshah, geek-merlin, artemboiko: IEF complex widget: Re-ordering / weight sometimes not updated
# Issue #2683125: Allow select widget for "Add existing items" by geek-merlin, arunkumark, Rithesh BK, almunnings, Goodmood, jennakoo, shivam_tiwari, the_glitch: Allow select widget for "Add existing items"
# Issue #3371257: Add support for the menu entity.: add submodule "Inline Entity Menu Form"
# (tag: 2.0.0-rc5) lost dependency
# Fix: default settings
# (tag: 2.0.0-rc7) #3375555: Add a FieldFormatter to display rendered menu: Add a new Field Formatter to display rendered menu
# (tag: 2.0.0-rc9) Issue #3386757: Inline entity form menu not working properly: fix ajax inline_entity_menu_form
# Issue #3398615: [Inline Entity Menu Form] Save is broken: fix form alter
# Fixing existing label not using label overrides.
# Reuse labels instead.
# (tag: 2.0.0-rc10, origin/2.0.x) Issue #3393551: Add the allow_new setting also for the simple widget: Simple Widget - allow_new setting
| Comment | File | Size | Author |
|---|---|---|---|
| #18 | AvailableUpdates-inline_entity_form.png | 42.02 KB | bsnodgrass |
Comments
Comment #2
geek-merlinComment #3
WebbehComment #4
core commentedYou'll have to forgive me... I'm a little confused about whats happening.
My D10 update says I have Inline Entity Form (Unsupported) 2.0.0-rc10 installed and recommends version 2.0.0-rc10 (Release notes https://www.drupal.org/project/inline_entity_form/releases/2.0.0-rc10). The version numbers are the same. I did the update as usual and nothing seemed to change, and the same recommended update information is still there. ??
Also, I did not see a 2x option listed on the projects page (https://www.drupal.org/project/inline_entity_form), so I don't even know (or recall) how it came to be that I have this version installed. I recently migrated from D9 to D10 so I'm sure it was part of this processes somehow, and it may have been listed in D9 as reccomended. I did see the 2x versions listed on the 'View all releases' link https://www.drupal.org/project/inline_entity_form/releases. And I read something about a 3x release??
The Project page (and link to issue) mentions cleaned up in #3401656: Clean up 2.x desaster. So it seems there is a cleanup in the works but there isn't enough 'plain speak' instruction (for laymen like me 😊) as to whats going on to make this clear.
I'm just wondering if I should:
Please advise,
Thank you.
Comment #5
geek-merlin@corE You should go back to the 1.x branch.
Comment #6
simeAre there any downgrade/data implications of rolling back? I suspect some people running platforms will want to double check this.
Comment #7
WebbehLogged an issue with GovCMS per #6: https://github.com/govCMS/GovCMS/issues/922
Comment #8
pandaski commentedWe, from GovCMS, noticed that the 2.x branch is no longer supported starting from yesterday.
Ideally, we would prefer a smooth transition from version 2.x to 3.x. We are willing to conduct tests and code reviews to make this transition as seamless as possible.
Another option is to revert to the 1.x branch, but we have concerns about potential data issues that may arise from downgrading at this time.
Our last option is to officially declare it as 'obsolete' in our distribution and patiently wait for version 3.x to be available.
Comment #9
jelle_sRE #5: Has this been tested? Is it possible to revert to 1.x without issues?
Comment #10
inst commentedHi,
I tried to go back from the 2.x to the 1.x branch by changing this simply in the composer.json
But it did not work. Nothing changes.
How can I maange this downgrade!
Thanks for any help.
Comment #11
Webbehcomposer require drupal/inline_entity_form:^1should do it.Comment #12
inst commentedHi,
not sure what the problem was before. Now I am able to go back to 1.x
May be a update/cache/refresh.
Anyhow - thanks for feedback!!
Comment #13
johnpitcairn commentedIs it possible to mark the composer package for 2.x as unsupported? Anyone running composer
require drupal/inline_entity_formis still going to get^2.0@RC.Comment #14
bsnodgrass commentedWorking on preparations to upgrade to 10.2.x I noticed inline_entity_form 2.x was unsupported.
Confirming, I was able to revert to use #8 to revert with no issues
composer require drupal/inline_entity_form:^1Thanks for all your work.
Comment #15
alisonWe've been using 2.x releases for a while, so I'm inclined to just downgrade to 2.0.0-rc9, rather than to 1.x.
But, I see others saying it went fine for them to go to 1.x (thank you for that!), I just feel anxious about it. Still thinking, just, sharing my "thinking out loud."
Comment #16
dqd@geek-merlin: Not sure if it makes sense to spot / bring up issues here which are possibly drawn by the branch confusion. But regarding the issue summary "[ ] Bulk assign all 2.x issues to 1.x or 3.0.x" here my comment over there in #2683125: Allow select widget for "Add existing items" if it helps:
Comment #17
lexsoft commentedWe have been utilizing the 2.x releases for quite some time, and our transition from 2.x to 1.x hinges on two critical features that the 2.x version provides:
1. #3247446: Auto-open inline entity forms (especially for cardinality: 1) : being the main reason for the switch
2. #3393551: Add the allow_new setting also for the simple widget
Furthermore, it has come to our attention that if additional submit buttons are introduced for the node, it becomes necessary to reinstate the inline_entity_form triggers. Here's an example of how to achieve this:
Comment #18
bsnodgrass commentedDoes it make sense to add a new issue to fix the Update Status report for this module? To change the recommended version to the version showing on the Project?
I was surprised it did not report the same recommended version on the project page and the available updates report.
Comment #19
geek-merlinOK, now i'm back at work here, coming from a lot of other urgent work.
As many say, the sanest way out of this is a 3.x release.
Moving on with this.
Comment #20
geek-merlinHabemus 3.0.0-rc15.
Comment #21
geek-merlinI marked 3.x recommended.
Comment #22
geek-merlinComment #23
geek-merlinAlso updated project page text (suggestions for improvement always appreciated):
Current version: 3.x
A problematic 2.x branch has been released erroneously, containing multiple regressions and unreviewed commits. This is currently cleaned up in #3401656: Clean up problematic 2.x branch. Help is appreciated.
If you are on 1.x, you can safely upgrade to 3.x.
If you are on 2.x, you can upgrade to 3.x, test well, and report back to #3407407: Clarify how to site-upgrade IEF 2.x => 1.x|3.x.
Comment #24
geek-merlinComment #25
geek-merlinComment #26
geek-merlinComment #27
geek-merlinComment #28
geek-merlinComment #29
geek-merlinComment #30
bsnodgrass commentedI attempted to upgrade to the 3.0.x recommended using
my attempt failed
composer why drupal/inline_entity_formreports
drupal/recommended-project dev-main requires drupal/inline_entity_form (^1.0@RC)I am on core 10.2.0-rc1
Comment #31
geek-merlinComment #32
geek-merlin@bsnodgrass: Please open a separate issue with a detailed report what you typed and what you got.
(What you should have done: `composer require drupal/inline_entity_form:^3@rc`)
Comment #33
bsnodgrass commentedComment #34
geek-merlinThanks for that issue!
Of course: People can only update to 3.x once ALL their projects that require IEF also allow 3.x. Sigh.
Comment #35
geek-merlinUpdated project page:
Comment #36
geek-merlinI worked through each and every issue that was linked in a 2.x commit.
Indeed most of them have been committed despite explicit needs-tests tags, but no tests.
It's really a pity that this got such a code monster that it can only be handled with tests, that coding tests is not so popular as guessing some lines of php code, and that not much paid work is being pumped into this. But that's where we are.
Comment #37
geek-merlinDid more archeology. There are some issues where the issue number is NOT in the commit message. So looking what closed issues are left with 2.x branch selected, and processing them too. Some of them are obviously fixes for regressions and fatal errors from previous commits, leaving them alone.
Comment #38
simeWe noticed multiple issues when editing embedded entities using complex widget, these went away on 1.x branch. If you are on GovCMS PaaS but using the distribution you can do this for now but note that we are in pre-production so we have plenty of space to manage the risk of going back.
Edit: I see 3.x continues on 1.x so this is better.
Comment #39
podarokI(and a large group of agencies) was actively working on this module as well as YMCA Website Services Community
All work will be moved to https://www.drupal.org/project/inline_entity_menu_form in Q1 2024
Please, do not remove tags of 2.x branch just yet from current module in order to avoid breaking 500+ sites.
Thank you and sorry for the inconvenience
Comment #40
geek-merlin