EntityMetadataWrapperException: Parent Data Structure Not Set

I can confirm the same scenario as #1

Actually upon further debugging, I've a slightly different scenario and can now reproduce it consistently:

1. Add a product to cart and proceed to checkout
2. Fill in billing customer profile pane [the customer profile is an entity]
3. Continue to Review step.
4. Go back to checkout step
5. Unset one of the required billing fields - e.g. set state or city to empty.
6. Continue to Review step again.

At this point you would expect to receive a missing required field error. Instead I get:

EntityMetadataWrapperException: Unable to get the data property type as the parent data structure is not set. in EntityStructureWrapper->getPropertyValue() (line 442 of entity/includes/entity.wrapper.inc).

I'm not sure if this is for the Entity API module or for Drupal Commerce, but the error message is coming from the entity module so leaving it in this queue.

I had this problem too, and it was caused by some custom code, which caused entity API to through this exception, when a field is not available.

Accessing the body value like this, was throwing the exception, if body is not set at all.

$bla = $wrapper->body->value->raw();

An if-condition helps..

if(!empty($node->body)){
  $bla = $wrapper->body->value->raw();
}

@Stella This fixed it for me - https://www.drupal.org/node/2275495

The entity README.txt suggests you can do this:

$wrapper->body->value->value(array('decode' => TRUE));

But when the body field is empty, the first value is NULL and this exception occurs.

Here is a test only patch to prove this.

Ok that test should fail but false positives... this is a better test.

I created a note without $this->drupalCreateNode() method because it was messing too much with the output of body and I needed something that got closer to what I get in a real environment.

Also for a manual test:

1. Install entity module
2. Create a custom module with this block definition:
   

   /**
    * Implements hook_block_info().
    */
   function custom_block_info() {
     $blocks['testimonials'] = array(
       'info' => t('TEST'),
       'cache' => DRUPAL_CACHE_GLOBAL,
     );
     return $blocks;
   }
   /**
    * Implements hook_block_view().
    */
   function custom_block_view($delta = '') {
     switch ($delta) {
       case 'testimonials':
         $node = menu_get_object();
         $node_wrapper = $node ? entity_metadata_wrapper('node', $node) : NULL;
         if ($node_wrapper) {
           $description = $node_wrapper->body->value->value(array('decode' => TRUE));
         }
     }
   }
   

3. Add that block to the content region
4. Create a node with an empty body.

.

Same patch as #8 but with a possible solution. Likely people won't agree with this but seems to pass tests locally, let's see what testbot says.

I really think NULL values are acceptable values and shouldn't throw exceptions. And it seems they are sent that way from fields api, so let's see...

I can confirm this issue with Drupal 7.32 and Entity API 7.x-1.5+7-dev (just updated) for Long Text fields in a normal node content type.

Working with try..catch blocks isn't a nice solution when you're in a template and just want to output the content, e. g.

  <div class="description">
    <?php print $entity->field_description->value->value(); ?>
    <span class="read-more><!-- ... --></span>
  </div>

Google brought me here. One of our sites is running a daily import with the migrate module. The following error occured today when trying to view a specific node:

EntityMetadataWrapperException:
Unable to get the data property field_com_type as the parent data structure is not set. in EntityStructureWrapper->getPropertyValue() (Zeile 442 von /var/data/vhosts/drupal/sites/all/modules/entity/includes/entity.wrapper.inc).

After I opened the node manually with node/x/edit and then saved it again the problem was gone.

I am using Drupal 7.19, Entity API 7.x-1.0-rc3 and Field Collection 7.x-1.0-beta4

Yeah, this exception is pretty annoying. As someone said above, a null field isn't an error. Can we make this break a bit more gracefully? I may have a go at patching it myself but if anyone who knows this module a bit better can look into it, I'm sure you'll make a lot of people happy.

@welly that was what I was trying to do in #9 though there is a test that expects the exception thrown which is why it says 1 fail from the testbot.

@joelpitter I've used your patch and it's all working fine - far better than throwing exceptions for null values although I am curious as to whether this has any repercussions. From what I can tell it shouldn't but we'll see!

Cheers!

@welly as am I curious:) I'm not a fan of throwing exceptions on missing dynamic properties, but I could be wrong in this thinking.

I am also getting this exception. I have term reference in my node and if there is no term selected page refuses to load and I'm getting exception in Drupal logs. Workaround in #9 fixes it.

Have you noticed removing the statements casing problems elsewhere?

I just added a reply to a forum topic. No custom parts used. (Drupal 7.34 with Forum and Advanced Forum)

EntityMetadataWrapperException: Unable to get the data property format as the parent data structure is not set. in EntityStructureWrapper->getPropertyValue() (line 438 of /.../sites/all/modules/entity/includes/entity.wrapper.inc).

Thanks for the patch. I probably need a more long term solution, but I'm grateful that this at least allows my site to load.

Me too. Is there a solution to this?

The patch worked for us as well. We have a Commerce site where this started happening, seemingly out of the blue, we haven't figured out yet why. Thanks!

Do we know why the patch is failing testing? I've run into this problem now on a few sites so it seems like it's pretty significant... Curious why it hasn't received more attention.

@deggertsen yes check out what I mentioned in #23 I think that's why.

Hi,

I run into this very same issue which is exist for about 3 years now.

This is how it happened to me:
I used to use commerce_node_checkout modules earlier version that used references module. I updated it. (Current version needs its fields to be converted to entity_reference module.)

Since I am getting the very same error:
EntityMetadataWrapperException: Unable to get the data property currency_code as the parent data structure is not set. in EntityStructureWrapper->getPropertyValue()

Is there anything that might help?

@bsandor Try my patch in #9 Let us know what you think

@joelpittet I am using commece_node _checkout module. When I create my first product with it I have no errors while if that is the second product i run into this issue.
Because of that I am not sure if my issue belong to this ticket.
I opened another ticket there.

Is there any way to make the error thrown more descriptive so that we can actually find where the data is not being set? For me that is what keeps me returning to this issue and using the patch in #9 that simply removes throw new EntityMetadataWrapperException('Unable to get the data property ' . check_plain($name) . ' as the parent data structure is not set.');

This probably gives way too much info but it helps debug this kind of error.

$backtrace = debug_backtrace();
$debug = '<pre>' . json_encode($backtrace, JSON_PRETTY_PRINT) . '</pre>';
throw new EntityMetadataWrapperException('Unable to get the data property ' . check_plain($name) . ' as the parent data structure is not set. ' . $debug);

I encountered this issue when I tried to delete field collection item with Rules module. Field collection entity iself is deleted, but the field table still has entry pointing to it.

Updated the issue summary with a description of the core problem and what to do about it.

The first patch is the same tests from #9. The following patches include both ways of solving it. The first of these makes the dataAvailable method public so that developers can check whether the data is available before trying to use it.

if ($entity->field_entity_reference->field->property->dataAvailable()) {
  // do something with the value.
  $value = $entity->field_entity_reference->field->property->value();
}

The second of the solution patches makes getPropertyValue return null instead of an exception.

In my case I think something is producing a commerce line item wrapper with the correct type property but a null bundle, and the exception is thrown when code checks $entity_wrapper->type->value(), preventing customers from continuing to payment. Tracking down the code that is producing the malformed line item is proving difficult and I need to move on.

The no-exception patch works for me, thanks.

I used 1596594-41-no_exception.patch with services_entity to prevent the error when updating an entity with a file field.

My vote here is that we go the route of dataAvailable(). Wrappers can be chained and returning NULL in the middle of a chained series of calls across entity reference fields is just going to lead to this issue cropping up in yet another way. Marking dataAvailable public seems less invasive to the API. Folks /might/ already have try/catch out there and built in logic to handle accordingly. If we remove the exception, that effectively breaks their logic.

I am getting this problem too. I have a Commerce Kickstart 7.x-2.37 installation and with Commerce Discount 7.x-1.0-alpha8 (the one that comes with Commerce Kickstart is 7.x-1.0-alpha7 and also gives the error) enabled and several discounts created. When I enable Commerce MOA 7.x.1.6 and go from the cart to the checkout, I get this error:

EntityMetadataWrapperException: Unable to get the data property type as the parent data structure is not set. in EntityStructureWrapper->getPropertyValue() (line 438 of /var/www/commerce_kickstart/profiles/commerce_kickstart/modules/contrib/entity/includes/entity.wrapper.inc).

After much reading I got it working changing

      if (!isset($data)) {
        throw new EntityMetadataWrapperException('Unable to get the data property ' . check_plain($name) . ' as the parent data structure is not set.');
      }

to

      if (!isset($data)) {
        return NULL;
      }

I agree with heddn that it needs a better solution, but I don't have the knowledge and I need it to work :)
I add the patch for people that could need it. Thanks for your work!

@candelas want to see if my test in #9 will hold up with that (my bet is that it does)

Setting to needs review for the testbot to pickup the patch as is.

Thanks @joelpittet. I don't understand why it fails the test :)

Confirming this error with entity 7.x-1.x-dev trying to run FB Oauth

EntityMetadataWrapperException: Unable to get the data property profile_id as the parent data structure is not set. in EntityStructureWrapper->getPropertyValue() (line 457 of /home/siteX/public_html/sites/all/modules/entity/includes/entity.wrapper.inc).

Why does it throw exceptions instead of just returning a blank value? Unfilled fields should never generate exceptions, in my opinion, and it doesn't make sense that the logic for ensuring unfilled fields are not attempted should be left to external checks instead of contained inside of the wrapper. It's annoying to have to duck type everything

Hello,

I created the field in Line item Type using Customizable Product module.
While creating the line item type for this newly added field to add in order the same error appears for me.

Can anybody suggest the solution?

I am also experiencing this issue whenever I remove a value from a term reference field. Which patch should I test? :)

Tested patch in #49 and it works without any side effects for me. :)

Recently started to see this error as well, and had been working just fine. For me, it's getting triggered by a rule which checks for the condition commerce_order_contains_product. The exception gets thrown after the following warnings:

Unable to get a data value. Error: Unable to get the data property sku as the parent data structure is not set.

Unable to evaluate condition commerce_order_contains_product.

EntityMetadataWrapperException: Unable to get the data property product_id as the parent data structure is not set. in EntityStructureWrapper->getPropertyValue() (line 457 of /sitename/sites/all/modules/entity/includes/entity.wrapper.inc).

#49 works for me

I'm sure it might have other far reaching issues, but being unable to work with blank values without my site throwing a hissy-fit and crashing, is ridiculous.

I really hope we're not celebrating this issue's fifth birthday in a few months...

Finding myself doing the same as #49. :(

I applied patch in #49. Have not noticed a problem for two months now.

Looks like the only reason the patch in #49 failed is because there was a test to ensure that getting an nonexistent property value threw an Exception.
The attached path is identical to #49 (with the additional test updates) and when contributed should be contributed to candelas.

@anthonyleach Patch failed testing. :(

Chirs,

That's right, the test file isn't patched before running the tests against the patch. It has to be manually ran, rather than relying on the automated testing procedure :(

Thanks
Anthony

Is this rtbc?

Test needs to pass before rtbc

If someone can explain how to manually run a test, I can try to do it. :)

1. Enable the simpletest "Testing" module.
2. Under configuration > development > testing >Find the test that is failing by name
3. Run it

Also on the command line: https://www.drupal.org/docs/7/testing/running-tests-through-command-line

How shall we qualify/quantifying if the fix is good to be merged in? Do we just each run the test locally and report back, or is/will there be another gate necessary for validation?

We need to address the feedback in #48. Are we doing the right thing here or is returning NULL just masking the problem.

#49 works for me. At least for a temporary solution

#49 works for me. My problem was with Commerce Fees. EntityMetadataWrapperException:... EntityStructureWrapper->getPropertyValue() (line 457...

+ 1 to #48
Returning NULL may change logic with try/catch. Used this way a few times to fallback to some default values inside catch.

I have a taxonomy term reference field. On the entity edit form I want to loop over all parents:

if (isset($node_wrapper->field_term)) {
  foreach ($node_wrapper->field_term->parents_all as $parent) {
    // do something
  }
}

If no term was selected I get the error

EntityMetadataWrapperException: Unable to get the data property parents_all as the parent data structure is not set. in EntityStructureWrapper->getPropertyValue() (line 460 of .../sites/all/modules/contrib/entity/includes/entity.wrapper.inc).

Making dataAvailable() function public won't help, as it returns TRUE, or maybe I am using it the wrong way?

if (isset($node_wrapper->field_term) $node_wrapper->field_term->parents_all->dataAvailable()) {...

Returning NULL in EntityStructureWrapper::getPropertyValue() as in #49 does not help either, because than I get the following warning and error:

Warning: array_keys() expects parameter 1 to be array, null given in EntityListWrapper->getIterator() (line 1124 of .../sites/all/modules/contrib/entity/includes/entity.wrapper.inc).
Recoverable fatal error: Argument 2 passed to EntityMetadataWrapperIterator::__construct() must be of the type array, null given, called in .../sites/all/modules/contrib/entity/includes/entity.wrapper.inc on line 1124 and defined in EntityMetadataWrapperIterator->__construct() (line 1202 of .../sites/all/modules/contrib/entity/includes/entity.wrapper.inc).

So finally I had to first check if a term value is present, to get it work:

if (isset($node_wrapper->field_term) $node_wrapper->field_term->value()) {...

Thanks,
also facing this issue and using patch from #49 is solving this for me until now.

I have a custom module that programmatically adds existing commerce product to order as a line item like so:

      // Save product as line item.
      $line_item = commerce_product_line_item_new($product, 1, $order->order_id);
      commerce_line_item_save($line_item);
      $order_wrapper = entity_metadata_wrapper('commerce_order', $order);
      $order_wrapper->commerce_line_items[] = $line_item;
      commerce_line_item_save($line_item);
      $order_wrapper->commerce_line_items[] = $line_item;
      commerce_order_save($order);

Everything looks ok on order view page, but as soon as I click on order edit page it is throwing the following notices:

Notice: Undefined index: label in field_multiple_value_form() (line 196 of /home/domain/public_html/modules/field/field.form.inc).
Notice: Undefined index: description in field_multiple_value_form() (line 197 of /home/domain/public_html/modules/field/field.form.inc).
Notice: Undefined index: commerce_unit_price in commerce_line_item_field_widget_form() (line 1063 of /home/domain/public_html/sites/all/modules/commerce/modules/line_item/commerce_line_item.module).

and the log pages is showing:

EntityMetadataWrapperException: Unable to get the data property amount as the parent data structure is not set. in EntityStructureWrapper->getPropertyValue() (line 457 of /home/domain/public_html/sites/all/modules/entity/includes/entity.wrapper.inc).

And I couldn't do anything to the order because the edit page was not opening at all, now after applying #49 at least I am able to edit orders, but the notices on the page are still there, though error on the log page is gone.

Patch #49 works for me as well. Thanks.

Patch #49 works for me as well.

Patch #49 works for me as well, it solves my issue in local, however, I did not try it in production.

So what we need here is for a maintainer to answer #48.

I agree with #48. Breaking changes bad.

Making dataAvailable() available sounds useful and the simplest solution all-around.

Added patch making the function public. Not tested.

Retesting due to code changed in entity.test.

Older versions tested with $this->assertException($wrapper->source, 'title'); in testNodeProperties().
This changed to $this->assertNull($wrapper->source, 'title'); in dev, so retesting the patch.

This is still an issue, empty values should just return NULL i guess, or at least not throw an exception. I guess it will now pass, but lets see.