CRM-21776: Ensure from clause adds custom table when search query is …

[jitendrapurohit]

…ordered by a custom field

Overview

Fix DB error displayed after performing any task on advanced search results sorted by custom field

Before

Performing any task on Advanced Search returns DB error when the search results are sorted by a custom field. To replicate - See JIRA issue description.

After

DB error is fixed. All tasks are performed correctly.

Technical Details

Custom table is not included as no return property is sent from the selector to improve the performance in #7566. The function prepareOrderBy() seems to be correctly adding specific table values to $this->_tables[]. This misses the assignment for custom tables which is added in this PR.

Comments

Added unit test.

---

• CRM-21776: DB Error when printing advanced search results sorted by custom field

[eileenmcnaughton]

I could replicate this bug but this didn't work for me as it this was never true when the line was hit !array_key_exists($cfID, $this->_cfIDs)

I struggle with the logic of this - it seems like these lines in the select clause

    if ($cfID) {
      // add to cfIDs array if not present
      if (!array_key_exists($cfID, $this->_cfIDs)) {
        $this->_cfIDs[$cfID] = array();
      }
    }

should be adding those tables

[jitendrapurohit]

@eileenmcnaughton Hmm, I get a DB error before replicating this issue now. When I did this PR, sorting on the custom field column worked correctly and the action task used to give me the error as mentioned in the JIRA issue description.

This seems to be another recent regression maybe due to changes done here. Your latest PR #11829 should be able to avoid that and I think it needs to be applied with this PR to verify the above comment.

I struggle with the logic of this - it seems like these lines in the select clause should be adding those tables

The selectClause() lines don't add the table as NO_RETURN_PROPERTIES is sent from the selector and prepareOrderBy() is meant to add all the required tables from the orderBy fields.

[eileenmcnaughton]

@jitendrapurohit when I last looked at this I could replicate the bug but not the fix. I just attempted now & I did not replicate the bug - although the unit test did fail without the rest of the patch. Screen cast attached

[jitendrapurohit]

@eileenmcnaughton Performing any task after the search results are sorted will lead to an error. I just tried on dmaster and it replicates there too.

The screencast looks good. What missing is the user needs to select a task after ordering it by marriage date field.

[eileenmcnaughton]

I confirm that I was able to replicate the bug taking the additional step described by @jitendrapurohit & that this fixed that error. Merging