Multilingual workflow bugs

Extended the testParagraphsTranslation() for:

• (Case 0): Check the paragraphs buttons in TRANSLATION after changing the NODE language:
  1. default site langcode in en
  2. original node langcode in EN,
  3. translated in FR,
  4. changed node langcode to DE;

Added multilingual test coverage for:

• Case 1: Check the paragraphs buttons after changing the NODE language (original node langcode in DE, default site langcode in en)
• Case 2: Check the paragraphs buttons after changing the NODE language (original node langcode in EN, default site langcode in en)
• Case 3: Check the paragraphs buttons after changing the SITE language (original node langcode in en, default site langcode in DE)

+ small refactor on the previous patch.

As suggested above:

1. done
2. no test coverage for rebuild yet, since we have changed the approach (after another debug session with miro_dietiker and Berdir, dropped the isRebuilding() check)
3. done
4. done
5. done, but somehow sometimes it does the loop correctly, but my last checks (on my local machine) do not assert for each buttons. I left the debug statement there to see what happens in testbot

Rerolled.

1. Rebuild problem: I've added the multi value text field to the Paragraphed article content type, checked for Add another item button for every test cases, but used this "refresh helper" only in the translation test. Not sure if it's fine or we should drop this button existence assertion in the multilingual test (since the refresh thing is already triggered by adding the paragraph items, so this new field is not needed in the multilingual test cases).
2. isTranslating initialisation: not sure where we should call this initIsTranslating(). Didn't investigated too much. Any suggestion ?
3. assertParagraphsButtons(): I think it's more reliable if we check for the exact buttons we want to assert. I've changed how I add the new buttons to be checked and now it works fine. If you still think that it's not needed (because now we know that this fix works as expected and there is no need to check for the specific cases), then I'll change that!
4. assertMultilingualParagraph() message: added.
5. Nested paragraph test coverage: not done yet. As I hear from the ongoing discussion here in the office, there are some problem writing this test. I'll wait for good news about this and I'll add the test (or yongt9412).

Changes are way bigger than the patch, thus no interdiff...

• Rebuild: as discussed, after that we've noticed that the multi value text field (separate form the paragraphs) is not rebuilding the whole form (updating also paragraphs) as we expected, so now we have decided to use the Images paragraph types. Even with this change, the rebuild thing is no properly working... I've left the check after the "upload images rebuild" anyway and see if it's different for testbot...
• initIsTranslating: done
• assertParagraphsButtons: done

1. I've moved our paragraphs buttons multilingual in translation test to a new test method with:
   • Case 1: original node langcode in EN, translate in FR, change to DE
   • Case 2: original node langcode in DE, change site langcode to DE, change node langcode to EN
2. added expected langcode as parameter of assertParagraphsLangcode

Reviewed this test too many times. Need some couple of eyes more to check if everything makes sense and also if the comments are consistent and sensible...

About the paragraph items langcode check in translation that we have discussed (it was supposed to be just a temporary additional check), it went to "Fatal error: Allowed memory size of 536878912 bytes exhausted (tried to allocate 42847834 bytes)", so I've just drop it, but if you want to work with it, here is the code:

  protected function assertParagraphsLangcodes($node_id, $source_lang = 'en', $trans_lang = NULL) {
    // Update the outdated node and check all the paragraph items langcodes.
    \Drupal::entityTypeManager()->getStorage('node')->resetCache([$node_id]);
    /** @var \Drupal\node\NodeInterface $node */
    $node = Node::load($node_id);
    $node_langcode = $node->langcode->value;
    $this->assertEqual($source_lang, $node_langcode, 'Host lang');

    foreach ($node->field_paragraphs_demo->referencedEntities() as $paragraph) {
      $paragraph_langcode = $paragraph->language()->getId();
      $message = new FormattableMarkup('Node langcode is "@node", paragraph item langcode is "@item".', ['@node' => $source_lang, '@item' => $paragraph_langcode]);
      $this->assertEqual($source_lang, $paragraph_langcode, $message);
    }

    if ($trans_lang) {
      $trans_node = $node->getTranslation($trans_lang);
      foreach ($trans_node->field_paragraphs_demo->referencedEntities() as $paragraph) {
        $item_trans = $paragraph->getTranslation($trans_lang);
        $paragraph_langcode = $item_trans->language()->getId();
        $message = new FormattableMarkup('Node langcode is "@node", paragraph item langcode is "@item".', ['@node' => $source_lang, '@item' => $paragraph_langcode]);
        $this->assertEqual($trans_node, $paragraph_langcode, $message);
      }

    }
  }

The failing testParagraphsMultilingualWorkflow is related to #27-Rebuild. I wanted to ensure it does not work also for testbot and share it in d.o. So either we should just drop these checks right after the rebuild (since I've checked them anyway right after saving the changes made during the steps, knowing this would have failed) or we should think of something more reliable to have a proper rebuild form to check for the langcode changes after triggering the rebuild. Otherwise the fix works as expected

The failing testParagraphTranslationMultilingual is related to the assertion of some images (children paragraph items of a nested paragraph added from the translated node) that are supposed not to be shown in the original node, but because of the parent thing/ERR not committed/included to the patch yet, then it failed. Again just wanted to share this here, but I thing it will be a follow up or will be discussed later/somewhere else. So maybe we should remove the images checks since here we are just interested to the paragraphs buttons and the langcodes.

ahaha, really bad thing ;) didn't noticed that. I'll check it tomorrow, but for today, abort!

+++ b/src/Plugin/Field/FieldWidget/InlineParagraphsWidget.php
@@ -1097,4 +1113,26 @@ class InlineParagraphsWidget extends WidgetBase {
+  protected function initIsTranslating(FormStateInterface $form_state, Entity $host) {
+    if (isset($this->isTranslating)) {
+      return;
+    }

Oopss, maybe this should be if ($this->isTranslating != NULL) ...

Changes initIsTranslating check to early exit if called multiple times.

Added check for translated paragraphs.

Ah, forgot to mention that while checking for the paragraphs langcode of the translated node, if you add a nested paragraph, the check does not detect and cannot check the langcode of the nested paragraph until you save the node. So if you run the test, from the assertParagraphLangcode you can see (e.g.) 2 checks of the paragraphs from the original node, but only 1 check of the paragraphs form the translated node. I guess the reason of this behaviour is that as long as you don't save the translation yet, the paragraph is still not translated, so getTranslation() cannot find the translation of that paragraph, or is there anything so special for nested paragraph (I mean the paragraph type itself, not its children) ?

Anyway, I thought that adding a new paragraph should trigger the rebuild form but saw that it actually does not update the form now. If you have changed the source langcode and then add a new paragraph, this does not change the langcode until you don't save the node. I think this worked previously (until #22) but don't know why it changes now.

BTW, now we have tests with nested paragraph (since #27), but we only check the nested langcode and not for its children langcode. Do we need to check for them too (here/now) ?

Set status to "Needs review" for feedback about the notes posted in this comment and in #35.

• from :
  • failing testParagraphTranslationMultilingual: discussed with yongt9412 and agreed dropping the images check since it's not relevant for our issue.
  • failing testParagraphsMultilingualWorkflow: figured out it did not actually work previously as I thought/wrote above. When you change the original node langcode and then add a new paragraph, this rebuild the paragraphs form but node and paragraphs have still the previous langcode set. Only after saving the node everything is properly updated. Fixed these checks.
• from :
  • new nested paragraph added is not detected thus no langcode check possible: saw that it doesn't work also for "Images", you need to save the node first to actually get the new paragraph entity to check for its langcode.
  • need to check for nested children paragraphs langcode?: if we want to check them as well, I guess it will be a follow up.

I've checked the code again, do some refactoring, fixed comment and other clean ups.