D7 EFQ Finder to D8 Entity finder

I recommend to rename this plugin to "Entity finder", as I think that name makes more sense to the end user. "EFQ" is more a developer term and it refers to the technique that is used to find the entity.

Note to @myself - WIP Patch

Looks ok!

Tagging for DrupalCamp Asheville

Tagging for the next to North American contrib days, Asheville and Colorado

DrupalCamp Asheville contrib days are July 13-14, 2019
DrupalCamp Colorado contrib day is Aug 4, 2019

any other movement on this? I installed the patch but it doesn't seem to be complete. I don't see Entity Finder in the list of available plugins in the feeds tamper.

What still needs to be implemented to make this work?

ok, I dug into this a bit...I think I see the components that are missing or wrong. I'm going to take a crack at finishing it and will share here when I am done.

Here is the new EntityFinder.php file. I was able to use it to import members into my OG groups, ie, it was able to create OG Membership entities using this tamper plugin to convert the 'group title' to an entity_id.

<?php

namespace Drupal\tamper\Plugin\Tamper;

use Drupal\Core\Form\FormStateInterface;
use Drupal\tamper\Exception\TamperException;
use Drupal\tamper\TamperableItemInterface;
use Drupal\tamper\TamperBase;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\Component\Utility\SafeMarkup;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Component\Utility\NestedArray;

/**
 * Plugin implementation of the explode plugin.
 *
 * @Tamper(
 *   id = "entity_finder",
 *   label = @Translation("Entity Finder"),
 *   description = @Translation("Finds an Entity based on properties and fields.  Returns the ID of the entity"),
 *   category = "Other",
 *   handle_multiples = TRUE
 * )
 */
class EntityFinder extends TamperBase {

  const SETTING_ENTITY_TYPE = 'entity_type';
  const SETTING_BUNDLE = 'bundle';
  const SETTING_FIELD = 'field';

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $config = parent::defaultConfiguration();
    $config[self::SETTING_ENTITY_TYPE] = '';
    $config[self::SETTING_BUNDLE] = '';
    $config[self::SETTING_FIELD] = '';
    return $config;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {

    $form['#prefix'] = '<div id="feeds-tamper-entity-finder-wrapper">';
    $form['#suffix'] = '</div>';

    // $form_state->setCached(FALSE);

    // Gets the button that triggers the ajax call
    $triggering_element = $form_state->getTriggeringElement();

    // Retrieve the parents, so we can climb back up the tree and do not have to hard code the unknown position of our subform
    $parents = array_slice($triggering_element['#array_parents'], 0, -1);
    if($parents) {
      $all_values = $form_state->getCompleteFormState()->getValues();
      $values = NestedArray::getValue($all_values, $parents);
    }

    $entityTypes = $this->getEntityTypes();

    $form[self::SETTING_ENTITY_TYPE] = [
      '#type' => 'select',
      '#title' => $this->t('Entity type'),
      '#options' => $entityTypes,
      '#default_value' => $this->getSetting(self::SETTING_ENTITY_TYPE),
      '#ajax' => array(
         'callback' => [$this,'changeSelect'],
         'event' => 'change',
         'wrapper' => 'feeds-tamper-entity-finder-wrapper',
      ),
      '#required' => TRUE,
      '#empty_option' => t('-- Select --'),
    ];

    // Set EntityType to the value in the config settings, or populate it with the form_state (from ajax)
    $entityType = $values[self::SETTING_ENTITY_TYPE] ? $values[self::SETTING_ENTITY_TYPE] : $this->getSetting(self::SETTING_ENTITY_TYPE);
    $bundles =  $this->getBundles($entityType);

    $form[self::SETTING_BUNDLE] = array(
      '#type' => 'select',
      '#title' => $this->t('Bundle'),
      '#options' => $bundles,
      '#default_value' => $this->getSetting(self::SETTING_BUNDLE),
      '#ajax' => array(
          'callback' => [$this,'changeSelect'],
          'event' => 'change',
          'wrapper' => 'feeds-tamper-entity-finder-wrapper',
      ),
      '#empty_option' => t('-- Select --'),
    );

    // Set bundle to the value in the config settings, or populate it with the form_state (from ajax)
    $bundle = $values[self::SETTING_BUNDLE] ? $values[self::SETTING_BUNDLE] : $this->getSetting(self::SETTING_BUNDLE);

    // Gather field definitions.
    $fields = $this->getFields($entityType, $bundle);

    $form[self::SETTING_FIELD] = array(
      '#type' => 'select',
      '#title' => $this->t('Field'),
      '#options' => $fields,
      '#default_value' => $this->getSetting(self::SETTING_FIELD),
      '#empty_option' => t('-- Select --'),
    );

    return $form;
  }

  /**
   * Ajax callback for form changes.
   */
  public function changeSelect(array &$form, FormStateInterface $form_state) {
    // Gets the button that triggers the ajax call
    $triggering_element = $form_state->getTriggeringElement();
    // Retrieve the parents, so we can climb back up the tree and do not have to hard code the unknown position of our subform
    $parents = array_slice($triggering_element['#array_parents'], 0, -1);

    // Use NestedArray to get the element in `$form` at the path that `$parents` describes.
    return NestedArray::getValue($form, $parents);
  }

  /**
   * Get all Entity types.
   *
   * @return array
   *   A list of Entity Types.
   */
  protected function getEntityTypes() {
    // Get some info on entity types.
    $entity_types = array();
    $definitions = \Drupal::entityTypeManager()->getDefinitions();
    foreach ($definitions as $machine_name => $info) {
      $entity_types[$machine_name] = SafeMarkup::checkPlain($info->getLabel());
    }
    return $entity_types;
  }

  /**
   * Get the bundles for an entity type
   *
   * @return array
   *   A list of Bundles
   */
  protected function getBundles($entity_type) {
    if ($entity_type) {
      $bundle_info = \Drupal::service('entity_type.bundle.info')->getBundleInfo($entity_type);
      foreach ($bundle_info as $machine_name => $info) {
        $bundles[$machine_name] = SafeMarkup::checkPlain($info['label']);
      }
      return $bundles;
    } else {
      return array();
    }
  }


  /**
   * Get the fields for an entity type and bundle
   *
   * @return array
   *   A list of Bundles
   */
  protected function getfields($entity_type, $bundle) {
    if ($entity_type && $bundle) {
      $field_info = \Drupal::service('entity_field.manager')->getFieldDefinitions($entity_type, $bundle);
      foreach ($field_info as $field_name => $field_definition) {
        $fields[$field_name] = SafeMarkup::checkPlain($field_definition->getLabel());
      }
      return $fields;
    } else {
      return array();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    // Test the regex.
    // $test = @preg_replace($form_state->getValue(self::SETTING_ENTITY_TYPE), '', 'asdfsadf');
    // if ($test === NULL) {
    //   $form_state->setErrorByName(self::SETTING_FIND, $this->t('Invalid regular expression.'));
    // }
  }


  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->setConfiguration([
      self::SETTING_ENTITY_TYPE => $form_state->getValue(self::SETTING_ENTITY_TYPE),
      self::SETTING_BUNDLE => $form_state->getValue(self::SETTING_BUNDLE),
      self::SETTING_FIELD => $form_state->getValue(self::SETTING_FIELD),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function tamper($data, TamperableItemInterface $item = NULL) {
    $entityType = $this->getSetting(self::SETTING_ENTITY_TYPE);
    $bundle = $this->getSetting(self::SETTING_BUNDLE);
    $field = $this->getSetting(self::SETTING_FIELD);
    if ($field === 'uuid') {
      if (NULL !== ($entity = \Drupal::entityRepository()->loadEntityByUuid($entityType, $data))) {
        return $entity->id();
      }
    }
    else {
      //$query = $this->queryFactory->get($entityType);
      $query = \Drupal::entityTypeManager()->getStorage($entityType)->getQuery();

      if ($bundle) {
        $query->condition($this->getBundleKey($entityType), $bundle, '=');
      }

      $ids = array_filter($query->condition($field, $data)->range(0, 1)->execute());
      if ($ids) {
        return reset($ids);
      }
    }
  }

  /**
   * Returns the entity type's bundle key.
   *
   * @return string
   *   The bundle key of the entity type.
   */
  protected function getBundleKey($entity) {
    return \Drupal::entityTypeManager()->getDefinition($entity)->getKey('bundle');
  }

}

This works great (patch above + revision in comment #12)! +1 for adding it to Tamper. There is one error saying that the $value variable is undefined in line 97 of this EntityFinder.php file, but it seems to work anyway.

This does work, but still a few warnings and notices that need to be cleaned up and a re-rolled patch which includes comment #12.

Warning: array_slice() expects parameter 1 to be array, null given in Drupal\tamper\Plugin\Tamper\EntityFinder->buildConfigurationForm() (line 57 of modules/contrib/tamper/src/Plugin/Tamper/EntityFinder.php).

Notice: Undefined variable: values in Drupal\tamper\Plugin\Tamper\EntityFinder->buildConfigurationForm() (line 80 of modules/contrib/tamper/src/Plugin/Tamper/EntityFinder.php).

Notice: Undefined variable: values in Drupal\tamper\Plugin\Tamper\EntityFinder->buildConfigurationForm() (line 97 of modules/contrib/tamper/src/Plugin/Tamper/EntityFinder.php).

It would be cool if the changes from #12 are incorporated in the patch and that the tests cover the issues noted in #14.

Here's a start anyway:
- The first interdiff is the differences between the patch in #6 and the plugin file from the text in comment #12.
- The second interdiff is an untested attempt to fix the errors from #14 (which also cover the errors I mentioned in #13).
- The new patch has both of these changes.

I'm not currently sitting on the machine where I can run tests, so let's see if we can get the test bot to respond...

@jhodgdon
Thanks for giving it a go.

A few things I see in the patch:

1. The provided tests make no sense. This seems to be a copy of the tests for the implode plugin. Check the tests from the D7 version of Feeds Tamper and see if you can port these to a kernel test: FeedsTamperEfqFinderTestCase.
2. An unit test is needed as well for a patch to be accepted.
3. Since AJAX is involved here, we might need a Javascript test as well.
4. There are coding standard issues.
5. There are references to \Drupal in the code that needs to be replaced with dependency injection. This is required to get a useful unit test.

6. +++ b/src/Plugin/Tamper/EntityFinder.php
   @@ -0,0 +1,241 @@
   +      $entity_types[$machine_name] = SafeMarkup::checkPlain($info->getLabel());
   

   SafeMarkup::checkPlain() is deprecated.

7. +++ b/config/schema/tamper.schema.yml
   @@ -136,3 +136,21 @@ tamper.truncate_text:
   +    update:
   +      type: string
   +      label: 'Update'
   

   'update' is not a configuration option for the plugin, so this can be removed.

I know this is not the easiest Tamper plugin to port. Keep up the good work!

Yeah, I didn't really look at the tests, or the code... I tested the plugin with the code in #12 and it seemed to work, so we used it. And I at least made the existing working (probably? mostly?) code into a patch, so anyone needing this functionality can at least use it for now. But definitely, it needs some work!

Getting this totally viable is probably not my highest priority right now. I'm kind of in the middle of about 3 other fairly intensive efforts with my Drupal contribution time... so hopefully someone else will take it on.

Curious what release this patch is against. I know it should be against -dev; but -dev is older than the beta2 release (how does that happen?) and the patch doesn't apply there. So wondering what is lost if using -dev and applying patch there?

I'll look at manually applying changes to beta2 as i assume it is more recent than -dev.

ah.. my bad.. this is on Tamper, not Feeds Tamper.

now that i have patched the correct module....

- i have a feed value for Email that i want to match to a user account (Authored By for the Node i cam trying to create), it shows as this in Mapping: Authored by (uid): The username of the content author. Reference by: User ID
- I see the tamper action: Entity Finder and UI seems to work as i'd expect.
- in EF tamper i set entity/bundle to User and set field to Email

when i try to import, i get this error:

Drupal\Core\Entity\Query\QueryException: '' not found in Drupal\Core\Entity\Query\Sql\Tables->ensureEntityTable() (line 367 of core\lib\Drupal\Core\Entity\Query\Sql\Tables.php).

i think i have found the issue.

in the tamper you add a query condition like this:

$query->condition($this->getBundleKey($entityType), $bundle, '=');

and getBundleKey is this:

\Drupal::entityTypeManager()->getDefinition($entity)->getKey('bundle');

For "node" bundles this returns "type", which is a filter on the items in the node table to limit search to this bundle. For "user", this returns "" and causes the error I reported above.

I made a small tweak to the code such that if there is no bundleKey then don't include that condition. Not sure this will work for all entity types; but it now allows it to work with users (which is probably a pretty popular one to set content ownership).

Hello @jamesdixon,

As far as I know patch-23 addon (not independent) to patch-16. Why does patch 23 not include 16....

Sure we can merge them, but patch 23 not passed.

Just for clear understanding to complete the issue we need to
1. Apply and test patch 16
2. If it needs to be fixed do it and retest.
3. If it passed successfully then merge a code from patch 23.
4. Name should be like entity-lookup-2976175-xx.patch

And a question about interdiff. Should it be compared with 16?

Will be thanks full for any comment

I combined the two patches. The first one did not apply any more against 8.x-1.x, so I re-created. Not sure what to make an interdiff against since this is combined so will leave that alone.

@jamesdixon,

I've cleaned the code and add several fixes here. But there still exits an error with Drupal::setContainer().
I will talk with @megaChriz

There were 2 errors:

1) Drupal\Tests\tamper\Unit\Plugin\Tamper\EntityFinderTest::testEntityFinderWithMultipleValues
Drupal\Core\DependencyInjection\ContainerNotInitializedException: \Drupal::$container is not initialized yet. \Drupal::setContainer() must be called with a real container.

/home/jedi/structured/code/feedsmigrates2/web/core/lib/Drupal.php:130
/home/jedi/structured/code/feedsmigrates2/web/core/lib/Drupal.php:291
/home/jedi/structured/code/feedsmigrates2/web/modules/contrib/tamper/src/Plugin/Tamper/EntityFinder.php:225
/home/jedi/structured/code/feedsmigrates2/web/modules/contrib/tamper/tests/src/Unit/Plugin/Tamper/EntityFinderTest.php:41

Screenshot is attached.

@jamesdixon updated code

When I added fourth parameter ($this->getMockSourceDefinition()) creating new object of EntityFinder class

  protected function instantiatePlugin() {
        $config = [
            EntityFinder::SETTING_GLUE => ',',
          ];
    return new EntityFinder($config, 'entity_finder', [], $this->getMockSourceDefinition());
  }

There appears error:

1) Drupal\Tests\tamper\Unit\Plugin\Tamper\EntityFinderTest::testEntityFinderWithMultipleValues
Drupal\Core\DependencyInjection\ContainerNotInitializedException: \Drupal::$container is not initialized yet. \Drupal::setContainer() must be called with a real container.

It is the same for

testEntityFinderWithSingleValue
as well as
testBuildConfigurationForm
methods. The last one out of the test file.

The error links to the lines in EntityFinder.php file

...
$definitions = \Drupal::entityTypeManager()->getDefinitions();
...
$query = \Drupal::entityTypeManager()->getStorage($entityType)->getQuery();

in EntityFinderTest.php

...
$this->plugin->tamper($original);
....
$this->assertEquals($expected, $this->plugin->tamper($original));
...

I've made online search around the similar issues.

https://drupal.stackexchange.com/questions/258233/how-to-create-a-test-c...
Based on the link above I guess it is something around declaration and access to particular methods from test class and from tamper class to drupal core. Need help and advice of more experienced developers.

I've added the patch derived from the comment #29. Fixed code style there following drupal linter and const SETTING_GLUE constant

+++ b/src/Plugin/Tamper/EntityFinder.php
@@ -0,0 +1,249 @@
+  /**
+   * Returns the entity type's bundle key.
+   *
+   * @return string
+   *   The bundle key of the entity type.
+   */
+  protected function getBundleKey($entity) {
+    return \Drupal::entityTypeManager()->getDefinition($entity)->getKey('bundle');
+  }

The entity type manager should be injected into this class. This way you could do $this->entityTypeManager->getDefinition() instead of \Drupal::entityTypeManager()->getDefinition().

To inject the entity type manager, you need to:

1. In the class, define a property called $entityTypeManager.
2. Override the constructor and add a parameter typehinting EntityTypeManagerInterface.
3. Add a create() method - Implement \Drupal\Core\Plugin\ContainerFactoryPluginInterface.

For an example, see \Drupal\feeds\Feeds\Target\EntityReference, which is also injecting the entity type manager.

Next, in the unit test, you would need to mock \Drupal\Core\Entity\EntityTypeManagerInterface and make sure that it returns the correct thing for getDefinition(). That thing may also be a mock that should return something for the call to getKey().
You could take a look at what the unit test for \Drupal\feeds\Feeds\Target\EntityReference does in \Drupal\Tests\feeds\Unit\Feeds\Target\EntityReferenceTest, though it could look a bit overwhelming when seeing that code for the first time. (I remember it being a bit overwhelming to me when I saw it for the first time.)

Hello @megachriz,
We've generate such a code (attached). Is it a right direction on you opinion?

Test gives the 8 errors. We continue to work on it

Testing Drupal\Tests\tamper\Unit\Plugin\Tamper\EntityFinderTest EEEEEEEE 8 / 8 (100%)

Time: 464 ms, Memory: 6.00 MB

There were 8 errors:

1) Drupal\Tests\tamper\Unit\Plugin\Tamper\EntityFinderTest::testEntityFinderWithSingleValue
Error: Call to a member function setStringTranslation() on null

/.../web/modules/contrib/tamper/tests/src/Unit/Plugin/Tamper/TamperPluginTestBase.php:27
/.../web/modules/contrib/tamper/tests/src/Unit/Plugin/Tamper/EntityFinderTest.php:34

...

@zabej

1. Only looking at how the entity type manager is injected, then yes - this is a step in the right direction. The create() method does need to pass a SourceDefinition object as well to the constructor. Looking at TamperManager that object appears to be in $configuration['source_definition']:

   /**
    * {@inheritdoc}
    */
   public function createInstance($plugin_id, array $configuration = []) {
     $plugin_definition = $this->getDefinition($plugin_id);
     $plugin_class = DefaultFactory::getPluginClass($plugin_id, $plugin_definition);
   
     // If the plugin provides a factory method, pass the container to it.
     if (is_subclass_of($plugin_class, 'Drupal\Core\Plugin\ContainerFactoryPluginInterface')) {
       return $plugin_class::create(\Drupal::getContainer(), $configuration, $plugin_id, $plugin_definition);
     }
   
     return new $plugin_class($configuration, $plugin_id, $plugin_definition, $configuration['source_definition']);
   }
   

2. SourceDefinitionInterface need to be imported at the top of the file: use Drupal\tamper\SourceDefinitionInterface;

3. +++ b/tests/src/Unit/Plugin/Tamper/EntityFinderTest.php
   @@ -14,13 +14,58 @@
   +    // Entity type manager.
   +    $this->entityTypeManager = $this->prophesize(EntityTypeManagerInterface::class);
   +
   +    // Entity storage (needed for entity query's).
   +    $this->entityStorage = $this->prophesize(EntityStorageInterface::class);
   +    $this->entityTypeManager->getStorage('referenceable_entity_type')->willReturn($this->entityStorage);
   +
   +    // Made-up entity type that we are referencing to.
   +    $referenceable_entity_type = $this->prophesize(EntityTypeInterface::class);
   +    $referenceable_entity_type->entityClassImplements('\Drupal\Core\Entity\ContentEntityInterface')->willReturn(TRUE)->shouldBeCalled();
   +    $referenceable_entity_type->getKey('label')->willReturn('referenceable_entity_type label');
   +    $this->entityTypeManager->getDefinition('referenceable_entity_type')->willReturn($referenceable_entity_type)->shouldBeCalled();
   +
   +    // EntityReference::prepareTarget() accesses the entity type manager from
   +    // the global container.
   +    // @see \Drupal\feeds\Feeds\Target\EntityReference::prepareTarget()
   +    $container = new ContainerBuilder();
   +    $container->set('entity_type.manager', $this->entityTypeManager->reveal());
   +    $container->set('string_translation', $this->getStringTranslationStub());
   +    \Drupal::setContainer($container);
   

   I think you won't need all of this code (but you do need some of it), but I suppose you're were still working on this bit?

@jamesdixon thanks for the advice I tried both suggestions but they do not work

The error move to

1) Drupal\Tests\tamper\Unit\Plugin\Tamper\EntityFinderTest::testEntityFinderWithSingleValue
Prophecy\Exception\Doubler\MethodNotFoundException: Method `Double\stdClass\P1::getStorage()` is not defined.

for tests are absent in the EntityFinderTest directly:

For example,

3) Drupal\Tests\tamper\Unit\Plugin\Tamper\EntityFinderTest::testGetPluginId
Prophecy\Exception\Doubler\MethodNotFoundException: Method `Double\stdClass\P1::getStorage()` is not defined.

/home/jedi/structured/code/feedsmigrates2/web/modules/contrib/tamper/tests/src/Unit/Plugin/Tamper/EntityFinderTest.php:41

4) Drupal\Tests\tamper\Unit\Plugin\Tamper\EntityFinderTest::testGetPluginDefinition
Prophecy\Exception\Doubler\MethodNotFoundException: Method `Double\stdClass\P1::getStorage()` is not defined.

/home/jedi/structured/code/feedsmigrates2/web/modules/contrib/tamper/tests/src/Unit/Plugin/Tamper/EntityFinderTest.php:41

5) Drupal\Tests\tamper\Unit\Plugin\Tamper\EntityFinderTest::testGetConfiguration
Prophecy\Exception\Doubler\MethodNotFoundException: Method `Double\stdClass\P1::getStorage()` is not defined.

/home/jedi/structured/code/feedsmigrates2/web/modules/contrib/tamper/tests/src/Unit/Plugin/Tamper/EntityFinderTest.php:41

6) Drupal\Tests\tamper\Unit\Plugin\Tamper\EntityFinderTest::testDefaultConfiguration
Prophecy\Exception\Doubler\MethodNotFoundException: Method `Double\stdClass\P1::getStorage()` is not defined.

@megachriz
I'm a bit confused with you remark.

1.1. In the create method we pass the $configuration array. Do we need put this in the constructor directly as a separate parameter?
1.2 Or we need to add createInstance method where provides Factory method and pass all the parameter as they are in it?
1.3 Is it not enough to SourceDefinitionInterface in the constructor having the parameter already?

3. Honestly, I would be delete almost all, because a lot of code is not familiar what it does
Remain only like this

  public function setUp() {

    // Entity type manager.
    $this->entityTypeManager = $this->prophesize(EntityTypeManagerInterface::class);

    // EntityReference::prepareTarget() accesses the entity type manager from
    // the global container.
    // @see \Drupal\feeds\Feeds\Target\EntityReference::prepareTarget()
    $container = new ContainerBuilder();
    $container->set('entity_type.manager', $this->entityTypeManager->reveal());
    $container->set('string_translation', $this->getStringTranslationStub());
    \Drupal::setContainer($container);

    $config = [
      EntityFinder::SETTING_GLUE => ',',
    ];

    $this->targetPlugin = new EntityFinder($config, 'entity_finder', [], $this->getMockSourceDefinition(), $this->entityTypeManager->reveal());

    parent::setUp();
  }

1.1. In the create method we pass the $configuration array. Do we need put this in the constructor directly as a separate parameter?

1. +++ b/src/Plugin/Tamper/EntityFinder.php
   @@ -0,0 +1,280 @@
   +    parent::__construct($configuration, $plugin_id, $plugin_definition);
   

   $source_definition needs to be passed to the parent.

2. +++ b/src/Plugin/Tamper/EntityFinder.php
   @@ -0,0 +1,280 @@
   +  /**
   +   * {@inheritdoc}
   +   */
   +  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
   +    return new static(
   +      $configuration,
   +      $plugin_id,
   +      $plugin_definition,
   +      $container->get('entity_type.manager')
   +    );
   +  }
   

   This needs an extra line between $plugin_definition and $container->get('entity_type.manager').
   Most likely this should be $configuration['source_definition'], based on the code from TamperManager::createInstance().

1.2 Or we need to add createInstance method where provides Factory method and pass all the parameter as they are in it?

Not sure if I understood this question, but we don't need a new factory or createInstance() method.

1.3 Is it not enough to SourceDefinitionInterface in the constructor having the parameter already?

SourceDefinitionInterface does not exist in the current namespace and thus it needs to be referenced at the top of the file. SourceDefinitionInterface lives in the namespace Drupal\tamper and the plugin's namespace is Drupal\tamper\Plugin\Tamper
Add the following line:
use Drupal\tamper\SourceDefinitionInterface;

3. Honestly, I would be delete almost all, because a lot of code is not familiar what it does

That's the hard part indeed. Try if you can break it down in parts so it becomes somewhat understandable.

I've applied this patch but I'm now getting this error when editing any of my feeds that previously used the entity finder.

ArgumentCountError: Too few arguments to function Drupal\tamper\Plugin\Tamper\EntityFinder::__construct(), 4 passed in /app/web/modules/contrib/tamper/src/TamperManager.php on line 50 and exactly 5 expected in Drupal\tamper\Plugin\Tamper\EntityFinder->__construct() (line 46 of modules/contrib/tamper/src/Plugin/Tamper/EntityFinder.php).

Yes, i had this patch installed and working for a while; but haven't touched the importer in a while. Since then i migrated all contrib over to composer install and tried to make sure i included all the patches. Missed this one. Now that i have added the latest patch i get the same reported in #43.

.. and by "editing any feed", i think @danharper likely means when going to Tamper tab of any Feed Type.

#29 still works.

tried #50 but still getting error reported in #43

tried #29 in D9 (last patch i know still works for D8) but now getting this error:

Error: Class 'Drupal\Component\Utility\SafeMarkup' not found in Drupal\tamper\Plugin\Tamper\EntityFinder->getEntityTypes() (line 138 of modules/contrib/tamper/src/Plugin/Tamper/EntityFinder.php).

due to use of deprecated SafeMarkup.

would provide patch to fix this but unclear the direction since #29 as i don't think any of those work.

Any update for drupal 9.3

Went back to patch from #29 and fixed the deprecated method issues and it worked with D9.5

Hello all.

Firstly I wanted to say thank you to everybody who has contributed to this issue. It has been a very long slog and so many people have contributed.

I have taken a quick look and made some tidy ups.

Please consider this a work in progress, and I have removed a bunch of stuff to get the tests going. I am not trying to discourage those ideas, I just wanted to share progress before I put them down.

Namely
- removed entity repository. Querying by uuid still works with entity query, I couldn't see why we needed to introduce another service for this field
- used a Kernel test. We can maybe revisit this, but this is a complicate plugin - the current state of the unit test was not complete, and being unfamiliar with the work so far it was easier for me to look at this with a kernel test.

Now a warning - I only looked at this via tests - I have not even looked at the UI or how that renders.

Adding patch now but it is still needs a few improvements. I will try tidy up the issue summary and remaining steps soon.

1. +++ b/src/Plugin/Tamper/EntityFinder.php
   @@ -0,0 +1,280 @@
   +    // $form_state->setCached(FALSE);
   

   I need to revisit the form side - this should either be there or removed, advice welcomed on what this is for and what other plugins are doing.

2. +++ b/src/Plugin/Tamper/EntityFinder.php
   @@ -0,0 +1,280 @@
   +      '#empty_option' => t('-- Select --'),
   

   Should be $this->t

3. +++ b/src/Plugin/Tamper/EntityFinder.php
   @@ -0,0 +1,280 @@
   +  protected function getfields($entity_type, $bundle) {
   

   Case needs to match where this is called

Oops - wrong namespace in test - ignore 54

Ok cool, green test! A few coding standard violations in the plugin and test noted in ci

Thank you for the work you're doing to finally take tamper out of alpha stability! 🙏🏻 Unfortunately I'm not skilled enough to help directly with code but I'm with you emotionally and can test when ready 💪🏻

Does not work with current DEV branch.

I'm hiding all the patches. Work should continue in the MR.

And I wonder if this plugin should support config entity types? I limited it to content entity types for now, because I accidentally selected a config entity type and it resulted into the error that the entity type did not have base field definitions.

FYI I've created a similar tamper module: https://github.com/hepabolu/feeds_tamper_lookup_entity

This one works for me, but since this is my first Drupal module feel free to correct and improve or assimilate into your version.

Tests are passing! This looks ready for a new review!

Highlights of the changes:

• Column selection: if a field has more than one 'column', you can select a column. For example, a link field has "uri" and "title"; a body field has "value", "summary" and "format".
• Selecting a bundle is optional. A field can be chosen without needing to select a bundle first. Selecting a bundle does narrow down the list of available fields.
• The list of entity types are grouped by provider (usually the module defining them), making it easier to find the one you need.
• Made updating the form via AJAX work outside of Feeds Tamper context.
• Lots of automated tests.

@hepabolu
Thanks for your contribution 🙂. I see that your plugin has one feature that looks useful that Entity Finder currently doesn't have: a return field. Entity Finder now always returns the entity ID, but being able to select a different field to return sounds very useful.
I'm not sure yet if we should add it to Entity Finder right now (since this issue has been open for a very long time already) or if it would be better to add it in a follow-up. Do you want to help adding that feature here?

I merged the code! Thanks all who contributed to this issue.

I've opened a follow-up for adding an additional configuration option (called "Return field") for the Entity Finder plugin: #3509334: Entity Finder: add return field option

The idea comes from @hepabolu who added this option to a plugin similar to Entity Finder in https://github.com/hepabolu/feeds_tamper_lookup_entity, so it would be great if we could port that option to the Entity Finder plugin.