Review main Merged Breaking

73835[!!!][TASK] Remove "TCEforms" wrapper in FlexForm definitions

Nikita Hovratov CR +2 V +2 Expert +1037 −1049 updated 09/28/22, 08:50

Commit message

In order to further simplify FlexForm definitions,
the superfluous array key "TCEforms" is now removed
and not evaluated anymore. Its sole purpose was to
wrap real TCA definitions.

The automatic removal of this key was already done
in FormEngine context. This is now always done, when
parsing FlexForm definitions with FlexFormTools
(parseDataStructureByIdentifier).

Review

  • Code review CR +2 Done
    • Nikita Hovratov +2
    • Christian Kuhn +1
    • Benni Mack +1
  • Verified V +2 Done
    • Nikita Hovratov +2
    • Christian Kuhn +1
    • Benni Mack +1
    • core-ci +1 CI

Issues 1

Files 36

Show 16 more files

Review log 4358

Show 2233 earlier messages
  1. Nikita Hovratov uploaded patch set 1 03/07/22, 07:53

  2. Nikita Hovratov uploaded patch set 2 03/07/22, 08:04

  3. core-ci voted on patch set 1 V -1 03/07/22, 08:13 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/24650

  4. core-ci voted on patch set 2 V +1 03/07/22, 08:15 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/24651

  5. Nikita Hovratov uploaded patch set 3 03/07/22, 19:06

  6. core-ci voted on patch set 3 V -1 03/07/22, 19:16 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/24685

  7. Nikita Hovratov uploaded patch set 4 03/07/22, 19:31

  8. core-ci voted on patch set 4 V +1 03/07/22, 19:40 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/24686

  9. Stefan Bürk commented on patch set 4 03/07/22, 22:10

    Just first thoughts after a first quick look through (not deepl/intensivly review). I would say that this is a hard breaking patch. FlexFormTools is not internal, and I have seen some extensions using it, and used it myself in some constellations. That means, that with this changed behaviour it breaks hard for extensions. At least it must be a breaking change, not sure about a compat layer for that. And as breaking it is a break in the core promis too (as long as im correct). Maybe we have more sideeffects not seen on a first lookthrough.
  10. Nikita Hovratov commented on patch set 4 03/08/22, 08:12

    Reply

    You mean extensions use FlexFormTools directly without calling parseDataStructureByIdentifier? Feeding it PHP arrays directly? Can you find any example for me?
  11. Benni Mack commented on patch set 4 03/09/22, 21:47

    Seems like there are a lot of implications (also in EXT:form, where people need to migrate their yaml syntax somehow), we should at least document this in the migration (e.g. can people use "both" at the same time?). Also, is there a fallback layer that we might allow in v11 already? So in v11 both is possible without a deprecation?
  12. Nikita Hovratov commented on patch set 4 03/10/22, 08:18

    Reply

    Will add migration for EXT:form yaml definitely, too. In v11 I believe it was already possible in FormEngine context, because of the automatic migration. But I need to have a deeper thought about this.
  13. Nikita Hovratov uploaded patch set 5 03/24/22, 16:52

  14. core-ci voted on patch set 5 V +1 03/24/22, 17:06 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25105

  15. Christian Kuhn commented on patch set 5 03/28/22, 15:23

    I agree on this patch: This simplifies flex DS quite a bit, the removal of that odd TCEforms sub-array is good. I think this is mostly non-breaking for "casual" usages: For existing flex DS, this will be transparently migrated away. So the only breaking part is if you have PHP code that operates on the result array, which is probably relatively rare. I think it would be good to mark the patch [!!!] and add a breaking.rst that result of getDataStructureByIdentifier can be different, now. Extensions that really fiddle here, should then handle both 'TCEforms' exists (v11) and 'TCEforms does not exist' (v12) to keep compat with v11 & v12. Also note that FormEngine related code already *always* removed that thing. For ext:form, I think, this should be mostly transparent, too, but we should still play around a bit on this, and maybe also mention a use case for ext:form in the deprecated.rst. So: In general fine from my side. Let's do some more cosmetics and documentation and tests to get things even more clear, then go with it.
  16. Georg Ringer commented on patch set 5 03/28/22, 16:05

  17. Christian Kuhn commented on patch set 5 03/28/22, 16:25

    Reply

    Good point georg! So we should really have some breaking.rst to document how to look for this (just searching for string 'TCEforms' and then looking at matches), and outlines possible solutions.
  18. Nikita Hovratov commented on patch set 5 03/28/22, 17:09

    Reply

    At least for Github this is really the only use case, which is found in executing code. But, yes of course this needs a breaking rst then, this is for sure.
  19. Nikita Hovratov uploaded patch set 6 03/29/22, 11:34

  20. Nikita Hovratov commented on patch set 6 03/29/22, 11:36

    Reply

    Added a breaking rst and a form yaml example in the deprecation rst. I don't know if additional tests are necessary, as the existing tests would already break, if something would be off.

    Reply

    Done
  21. core-ci voted on patch set 6 V -1 03/29/22, 11:45 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25258

  22. Nikita Hovratov uploaded patch set 7 03/29/22, 12:46

  23. core-ci voted on patch set 7 V +1 03/29/22, 13:00 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25261

  24. Nikita Hovratov uploaded patch set 8 04/08/22, 21:09

  25. core-ci voted on patch set 8 V -1 04/08/22, 21:17 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25865

  26. Nikita Hovratov uploaded patch set 9 04/08/22, 21:22

  27. core-ci voted on patch set 9 V +1 04/08/22, 21:33 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25867

  28. Simon Schaufelberger commented on patch set 9 09/24/22, 23:12

    can this make it into v12?
  29. Nikita Hovratov uploaded patch set 10 09/26/22, 15:07

  30. core-ci voted on patch set 10 V -1 09/26/22, 15:19 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/31544

  31. Nikita Hovratov uploaded patch set 11 09/26/22, 18:43

  32. core-ci voted on patch set 11 V -1 09/26/22, 18:53 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/31550

  33. Nikita Hovratov uploaded patch set 12 09/26/22, 19:30

  1. Oliver Klee commented on patch set 12 09/26/22, 19:34

    Reply

    Ack
  2. core-ci voted on patch set 12 V +1 09/26/22, 19:38 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/31553

  3. Georg Ringer voted on patch set 12 V +1 CR +1 09/26/22, 19:39

  4. Simon Schaufelberger commented on patch set 12 CR -1 09/26/22, 20:57

    EmailToSender.yaml:46

    this doesn't look right. the indentation of the following lines should be one level higher.
  5. Simon Schaufelberger commented on patch set 12 09/26/22, 20:58

    EmailToReceiver.yaml:47

    same here
  6. Nikita Hovratov uploaded patch set 13 09/27/22, 07:21

  7. Nikita Hovratov commented on patch set 13 09/27/22, 07:22

    EmailToReceiver.yaml:47 Reply

    Done

    EmailToSender.yaml:46 Reply

    Done
  8. core-ci voted on patch set 13 V +1 09/27/22, 07:30 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/31564

  9. Simon Schaufelberger voted on patch set 13 CR +1 09/27/22, 08:32

  10. Benni Mack voted on patch set 13 CR +1 09/27/22, 13:24

  11. Andreas Kienast commented on patch set 13 CR -1 09/27/22, 13:31

    EmailToReceiver.yaml:47

    This is still documented as such in the ReST files in EXT:form.
  12. Oliver Klee wrote 09/27/22, 13:46

    Removed cc Oliver Klee.
  13. Andreas Kienast uploaded patch set 14 09/27/22, 13:50

  14. Andreas Kienast voted on patch set 14 CR +1 09/27/22, 13:50

  15. core-ci voted on patch set 14 V +1 09/27/22, 13:58 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/31594

  16. Nikita Hovratov commented on patch set 14 09/27/22, 16:23

    EmailToReceiver.yaml:47 Reply

    Thanks!
  17. Simon Schaufelberger voted on patch set 14 CR +1 09/27/22, 16:27

  18. Christian Kuhn commented on patch set 14 09/28/22, 05:26

    look good in general. minor remarks only.

    FlexFormTools.php:1013

    I think we should mark this method @internal and state that it will be removed with v13.

    FlexFormTools.php:1020

    Let's state this compat layer will be removed in v13

    FlexFormTools.php:1030

    another deprecation here?
  19. Nikita Hovratov uploaded patch set 15 09/28/22, 07:38

  20. Nikita Hovratov commented on patch set 15 09/28/22, 07:42

    FlexFormTools.php:1013 Reply

    Done

    FlexFormTools.php:1020 Reply

    Done

    FlexFormTools.php:1030 Reply

    Done
  21. core-ci voted on patch set 15 V +1 09/28/22, 07:45 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/31635

  22. Christian Kuhn voted on patch set 15 V +1 CR +1 09/28/22, 07:54

  23. Benni Mack voted on patch set 15 V +1 CR +1 09/28/22, 08:24

  24. Nikita Hovratov voted on patch set 15 V +2 CR +2 09/28/22, 08:49

  25. Nikita Hovratov merged patch set 16 09/28/22, 08:50