Disambiguate Address.state_province_id:abbr

[totten]

Overview

The test ContactJoinTest::testCreateWithPrimaryAndBilling is flaky. This stems from following:

  'address_billing.state_province_id:abbr' => 'AK',

The symbol 'AK' can resolve to three places: Akwa Ibom (Nigeria), Atakora (Benin), and Alaska (USA). This is an ambiguous choice. It should be resolved in a consistent way.

ping @colemanw

Before

There are two layers of flakiness:

• MySQL: When it fetches civicrm_state_province records, it uses ORDER BY abbreviation. This is ambiguous.
• PHP: After receiving the list, it maps the results into various arrays and does some extra sorts. This provides a similar ordering. However, depending on the PHP version, it may swap around equivalent abbreviations. (Thus, Akwa Ibom and Alaska can flip-flop their relative positions.)

The PHP flakiness is more apparent than the MySQL flakiness. You can easily switch PHP versions to observe the difference (which is why testCreateWithPrimaryAndBilling usually fails on min and usually passes on max). For MySQL, the problem depends more on internal/arbitrary details, and the test-assertions match the usual behavior -- so failures there are less common.

After

Both layers should be consistent:

• MySQL: It fetches civicrm_state_province with ORDER BY abbreviation, id. This is unambiguous.
• PHP: PHP 7 now uses a different sort method - one which comes closer to the PHP 8 behavior.

[civibot]

(Standard links)

• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[totten]

The PHP aspect seems to be easier than the MySQL aspect. I've extracted that as a separate PR (#25552).

[totten]

Rebased to build on top of PHP-only PR (25552).

Changed the approach on the MySQL fix.

(The earlier patch had filled in the <orderColumn>, because there were some hints in the code toward using orderColumn. However, there were test-failures which suggest that orderColumn is a bit nonsensical: the "pseudoconstant" has several flavors -- name, label, id, abbreviation, etc. You can't use a singular orderColumn for all flavors.)

Pushed up a simpler approach that doesn't require extra metadata.

[eileenmcnaughton]

Maybe check that the id is in the fields? Import tables do not have an _id field -

It looks like you can use some variant of

   if (in_array('id', $availableFields), TRUE) {
     ...
    }

[totten]

@eileenmcnaughton Good idea. Updated.

Also, rebased on top of current master. (Since the related PR was merged, the diff should now look smaller.)

[totten]

civibot, test this please

[eileenmcnaughton]

It looks very small indeed. This seems safe & sensible to me