Formatters do not support weights like widgets do

Yeah I ran into this problem with Select (or other) #1953284: Increase module weight with random ordering of the widget list. I ended up having to increase my whole module weight got get it to drop below the other formatters. I thought it was a bit strange that I could change weight on widget but not formatter.

Makes sense, patch in #4 still applies fine.

I think we should adds tests for this...

Tagging

Going to take a stab at this one.

Okay. First attempt.

A bit new-ish at this: per Swentels' instructions:

a/ Patch with a test which should fail
b/ Patch with a test and a fix which should pass.

Suggested by Swentel: fix comment which exceeded the 80 character line.

Looks good. Patch was RTBC before. Now has passing tests. I gave it one more look so RTBC. Excited to have this so I can fix module weight issue over at Select (or Other)

1. +++ b/core/modules/field/lib/Drupal/field/Plugin/Type/Formatter/FormatterPluginManager.php
   @@ -173,9 +173,11 @@ public function prepareConfiguration($field_type, array $configuration) {
   +      uasort($formatter_types, 'drupal_sort_weight');
   

   We should use the Drupal\Component\Utility\SortArray::sortByWeightElement() here as this is OO code and we should call into common.inc unless absolutely necessary.

2. +++ b/core/modules/field_ui/lib/Drupal/field_ui/Tests/ManageDisplayTest.php
   @@ -57,6 +57,13 @@ function testFormatterUI() {
   +    // Check whether formatter weights are respected
   +    $result = $this->xpath('//select[@id=:id]/option[1]', array(':id' => 'edit-fields-field-test-type'));
   +    $options = array_map(function($item) {
   +      return (string) $item->attributes()->value[0];
   +    }, $result);
   +    $this->assertEqual($options, array('field_weight_test'), 'The expected formatter ordering is respected.');
   +
        // Change the formatter and check that the summary is updated.
   

   Testing sort order by only asserting on an array of one formatter seems odd.

1.

Changed the uasort compare callback.

2.

Yes. Tests for this should be fleshed out some more. I'm new at writing good tests, so not sure how this should practically look like. This test only works on an explicit formatter case (field_weight_test) with the weight parameter set. I could test a normal default case where no weight properties are set and we assume a default ordering.

Re-rolling.

Instead of adding a new formatter, adding weight to existing ones to test the ordering. Also adding same tests for widgets.

Regards.

+++ b/core/lib/Drupal/Core/Field/Annotation/FieldFormatter.php
@@ -74,4 +74,13 @@ class FieldFormatter extends Plugin {
+   * An integer to determine the weight of this formatter relative to other
+   * formatter in the Field UI when selecting a widget for a given field
+   * instance.
+   *

Hmm, this comment mixes formatters with widgets.

Other than that, this looks good to me.

Ups, I didn't remove all the widget references... :(

21: formatter_weight-1982776-21.patch queued for re-testing.

21: formatter_weight-1982776-21.patch queued for re-testing.

Let's hope this one doesn't run 14 days either.

Committed and pushed to 8.x. Thanks!

Backporting patch. Also adding tests for both widget and formatter weight.