Skip to content

Commit

Permalink
SearchKit - Fix in-place editing custom relationship fields for relat…
Browse files Browse the repository at this point in the history 
…ed contacts

Before: In-place edit updates the wrong record for custom relationship fields
After: Fixed
  • Loading branch information
@colemanw
colemanw committed May 20, 2022
1 parent bb6f5a0 commit dff1b93
Show file tree
Hide file tree
Showing 5 changed files with 346 additions and 15 deletions.
4 changes: 3 additions & 1 deletion Civi/Api4/Service/Schema/Joinable/CustomGroupJoinable.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
namespace Civi\Api4\Service\Schema\Joinable;

use Civi\Api4\CustomField;
use Civi\Api4\Utils\CoreUtil;

class CustomGroupJoinable extends Joinable {

Expand Down Expand Up @@ -52,12 +53,13 @@ public function getEntityFields() {
$cacheKey = 'APIv4_CustomGroupJoinable-' . $this->getTargetTable();
$entityFields = (array) \Civi::cache('metadata')->get($cacheKey);
if (!$entityFields) {
$baseEntity = CoreUtil::getApiNameFromTableName($this->getBaseTable());
$fields = CustomField::get(FALSE)
->setSelect(['custom_group_id.name', 'custom_group_id.extends', 'custom_group_id.table_name', 'custom_group_id.title', '*'])
->addWhere('custom_group_id.table_name', '=', $this->getTargetTable())
->execute();
foreach ($fields as $field) {
$entityFields[] = \Civi\Api4\Service\Spec\SpecFormatter::arrayToField($field, self::getEntityFromExtends($field['custom_group_id.extends']));
$entityFields[] = \Civi\Api4\Service\Spec\SpecFormatter::arrayToField($field, $baseEntity);
}
\Civi::cache('metadata')->set($cacheKey, $entityFields);
}
Expand Down
17 changes: 16 additions & 1 deletion ext/search_kit/Civi/Api4/Action/SearchDisplay/AbstractRunAction.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ private function formatEditableColumn($column, $data) {
$editable['value'] = $data[$editable['value_path']];
}
// Generate params to create new record, if applicable
elseif ($editable['explicit_join']) {
elseif ($editable['explicit_join'] && !$this->getJoin($editable['explicit_join'])['bridge']) {
$editable['action'] = 'create';
$editable['value'] = NULL;
$editable['nullable'] = FALSE;
Expand Down Expand Up @@ -577,6 +577,21 @@ private function formatEditableColumn($column, $data) {
}
}
}
// Ensure all required values exist for create action
$vals = array_keys(array_filter($editable['record']));
$vals[] = $editable['value_key'];
$missingRequiredFields = civicrm_api4($editable['entity'], 'getFields', [
'action' => 'create',
'where' => [
['type', '=', 'Field'],
['required', '=', TRUE],
['default_value', 'IS NULL'],
['name', 'NOT IN', $vals],
],
]);
if ($missingRequiredFields->count() || count($vals) === 1) {
return NULL;
}
}
// Ensure current user has access
if ($editable['record']) {
Expand Down
139 changes: 139 additions & 0 deletions ext/search_kit/tests/phpunit/api/v4/SearchDisplay/SearchRunTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
use Civi\Api4\Contact;
use Civi\Api4\ContactType;
use Civi\Api4\Email;
use Civi\Api4\Phone;
use Civi\Api4\SavedSearch;
use Civi\Api4\SearchDisplay;
use Civi\Api4\UFMatch;
Expand Down Expand Up @@ -309,6 +310,144 @@ public function testRunWithSmartyRewrite() {
}
}

/**
* Test in-place editable for update and create.
*/
public function testInPlaceEditAndCreate() {
$lastName = uniqid(__FUNCTION__);
$sampleData = [
['first_name' => 'One', 'last_name' => $lastName],
['last_name' => $lastName],
];
$contacts = Contact::save(FALSE)->setRecords($sampleData)->execute()->column('id');
$email = Email::create(FALSE)
->addValue('contact_id', $contacts[0])
->addValue('email', 'testmail@unit.test')
->execute()->single()['id'];
$phone = Phone::create(FALSE)
->addValue('contact_id', $contacts[1])
->addValue('phone', '123456')
->execute()->single()['id'];

$params = [
'checkPermissions' => FALSE,
'return' => 'page:1',
'savedSearch' => [
'api_entity' => 'Contact',
'api_params' => [
'version' => 4,
'select' => ['first_name', 'Contact_Email_contact_id_01.email', 'Contact_Phone_contact_id_01.phone'],
'where' => [['last_name', '=', $lastName]],
'join' => [
[
"Email AS Contact_Email_contact_id_01",
"LEFT",
["id", "=", "Contact_Email_contact_id_01.contact_id"],
["Contact_Email_contact_id_01.is_primary", "=", TRUE],
],
[
"Phone AS Contact_Phone_contact_id_01",
"LEFT",
["id", "=", "Contact_Phone_contact_id_01.contact_id"],
],
],
],
],
'display' => [
'type' => 'table',
'label' => '',
'settings' => [
'limit' => 20,
'pager' => FALSE,
'columns' => [
[
'key' => 'first_name',
'label' => 'Name',
'type' => 'field',
'editable' => TRUE,
],
[
'key' => 'Contact_Email_contact_id_01.email',
'label' => 'Email',
'type' => 'field',
'editable' => TRUE,
],
[
'key' => 'Contact_Phone_contact_id_01.phone',
'label' => 'Phone',
'type' => 'field',
'editable' => TRUE,
],
],
'sort' => [
['id', 'ASC'],
],
],
],
];
$result = civicrm_api4('SearchDisplay', 'run', $params);

// Contact 1 first name can be updated
$this->assertEquals('One', $result[0]['columns'][0]['val']);
$this->assertEquals($contacts[0], $result[0]['columns'][0]['edit']['record']['id']);
$this->assertEquals('Contact', $result[0]['columns'][0]['edit']['entity']);
$this->assertEquals('Text', $result[0]['columns'][0]['edit']['input_type']);
$this->assertEquals('String', $result[0]['columns'][0]['edit']['data_type']);
$this->assertEquals('first_name', $result[0]['columns'][0]['edit']['value_key']);
$this->assertEquals('update', $result[0]['columns'][0]['edit']['action']);
$this->assertEquals('One', $result[0]['columns'][0]['edit']['value']);

// Contact 1 email can be updated
$this->assertEquals('testmail@unit.test', $result[0]['columns'][1]['val']);
$this->assertEquals($email, $result[0]['columns'][1]['edit']['record']['id']);
$this->assertEquals('Email', $result[0]['columns'][1]['edit']['entity']);
$this->assertEquals('Text', $result[0]['columns'][1]['edit']['input_type']);
$this->assertEquals('String', $result[0]['columns'][1]['edit']['data_type']);
$this->assertEquals('email', $result[0]['columns'][1]['edit']['value_key']);
$this->assertEquals('update', $result[0]['columns'][1]['edit']['action']);
$this->assertEquals('testmail@unit.test', $result[0]['columns'][1]['edit']['value']);

// Contact 1 - new phone can be created
$this->assertNull($result[0]['columns'][2]['val']);
$this->assertEquals(['contact_id' => $contacts[0]], $result[0]['columns'][2]['edit']['record']);
$this->assertEquals('Phone', $result[0]['columns'][2]['edit']['entity']);
$this->assertEquals('Text', $result[0]['columns'][2]['edit']['input_type']);
$this->assertEquals('String', $result[0]['columns'][2]['edit']['data_type']);
$this->assertEquals('phone', $result[0]['columns'][2]['edit']['value_key']);
$this->assertEquals('create', $result[0]['columns'][2]['edit']['action']);
$this->assertNull($result[0]['columns'][2]['edit']['value']);

// Contact 2 first name can be added
$this->assertNull($result[1]['columns'][0]['val']);
$this->assertEquals($contacts[1], $result[1]['columns'][0]['edit']['record']['id']);
$this->assertEquals('Contact', $result[1]['columns'][0]['edit']['entity']);
$this->assertEquals('Text', $result[1]['columns'][0]['edit']['input_type']);
$this->assertEquals('String', $result[1]['columns'][0]['edit']['data_type']);
$this->assertEquals('first_name', $result[1]['columns'][0]['edit']['value_key']);
$this->assertEquals('update', $result[1]['columns'][0]['edit']['action']);
$this->assertNull($result[1]['columns'][0]['edit']['value']);

// Contact 2 - new email can be created
$this->assertNull($result[1]['columns'][1]['val']);
$this->assertEquals(['contact_id' => $contacts[1], 'is_primary' => TRUE], $result[1]['columns'][1]['edit']['record']);
$this->assertEquals('Email', $result[1]['columns'][1]['edit']['entity']);
$this->assertEquals('Text', $result[1]['columns'][1]['edit']['input_type']);
$this->assertEquals('String', $result[1]['columns'][1]['edit']['data_type']);
$this->assertEquals('email', $result[1]['columns'][1]['edit']['value_key']);
$this->assertEquals('create', $result[1]['columns'][1]['edit']['action']);
$this->assertNull($result[1]['columns'][1]['edit']['value']);

// Contact 2 phone can be updated
$this->assertEquals('123456', $result[1]['columns'][2]['val']);
$this->assertEquals($phone, $result[1]['columns'][2]['edit']['record']['id']);
$this->assertEquals('Phone', $result[1]['columns'][2]['edit']['entity']);
$this->assertEquals('Text', $result[1]['columns'][2]['edit']['input_type']);
$this->assertEquals('String', $result[1]['columns'][2]['edit']['data_type']);
$this->assertEquals('phone', $result[1]['columns'][2]['edit']['value_key']);
$this->assertEquals('update', $result[1]['columns'][2]['edit']['action']);
$this->assertEquals('123456', $result[1]['columns'][2]['edit']['value']);
}

/**
* Test running a searchDisplay as a restricted user.
*/
Expand Down
Loading

0 comments on commit dff1b93

Please sign in to comment.