Additional fixes to Clone Command (CO-479)

app/availableplugins/ApiConnector/src/Model/Entity/ApiSourceRecord.php

@@ -48,4 +48,6 @@ class ApiSourceRecord extends Entity {
     'id' => false,
     'slug' => false,
   ];
+
+  public array $_supportedMetadata = ['clonable-related'];
 }

app/plugins/CoreAssigner/config/plugin.json

@@ -34,7 +34,8 @@
           "format_assigner_sequences_i1": { "columns": [ "format_assigner_id", "affix" ], "unique": true },
           "format_assigner_sequences_i2": { "needed": false, "columns": [ "format_assigner_id" ] }
         },
-        "changelog": false
+        "changelog": false,
+        "clone_relation": true
       },
       "sql_assigners": {
         "columns": {

app/plugins/CoreAssigner/src/Model/Entity/FormatAssignerSequence.php

@@ -48,4 +48,6 @@ class FormatAssignerSequence extends Entity {
     'id' => false,
     'slug' => false,
   ];
+
+  public array $_supportedMetadata = ['clonable-related'];
 }

app/plugins/CoreServer/config/plugin.json

@@ -68,8 +68,7 @@
         },
         "indexes": {
           "oauth2_servers_i1": { "columns": [ "server_id" ] }
-        },
-        "clone_relation": true
+        }
       },
       "smtp_servers": {
         "columns": {
@@ -86,8 +85,7 @@
         },
         "indexes": {
           "smtp_servers_i1": { "columns": [ "server_id" ] }
-        },
-        "clone_relation": true
+        }
       },
       "sql_servers": {
         "columns": {
@@ -102,8 +100,7 @@
         },
         "indexes": {
           "sql_servers_i1": { "columns": [ "server_id" ]}
-        },
-        "clone_relation": true
+        }
       }
     }
   }

app/plugins/CoreServer/src/Model/Entity/MatchServerAttribute.php

@@ -48,4 +48,6 @@ class MatchServerAttribute extends Entity {
     'id' => false,
     'slug' => false,
   ];
+
+  public array $_supportedMetadata = ['clonable-related'];
 }

app/resources/locales/en_US/field.po

@@ -243,6 +243,9 @@ msgstr "Order"
 msgid "organization"
 msgstr "Organization"
 
+msgid "originalid"
+msgstr "Original Record ID"
+
 msgid "parameters"
 msgstr "Parameters"
 

app/src/Command/CloneCommand.php

@@ -474,11 +474,25 @@ protected function cloneEntity(
 
       if(!empty($hasOne)) {
         if($targetDataSource != 'default') {
-          // Prefix the hasOne relations (we're assuming only one level for now,
-          // so no recursion) with the data source label.
-
           foreach($hasOne as $h) {
+            // Prefix the hasOne relations (we're assuming only one level for now,
+            // so no recursion) with the data source label.
+
             $targetHasOne[] = $prefix.$h;
+
+            // Also, while we're here prefix the property, if set.
+            // (eg: $copy['api_source'] -> $copy['remote_api_source'])
+            // (This could arguably be done in filterMetadataForCopy, but as a general
+            // rule we seem to be managing datasource-specific prefixing here in
+            // CloneCommand.)
+
+            $property = Inflector::singularize(Inflector::underscore($h));
+            $targetProperty = $targetDataSource . "_" . $property;
+
+            if(array_key_exists($property, $copy)) {
+              $copy[$targetProperty] = $copy[$property];
+              unset($copy[$property]);
+            }
           }
         } else {
           $targetHasOne = $hasOne;
@@ -657,9 +671,8 @@ protected function cloneEntity(
               $this->io->out($sourceIterator->count() . " records in source to sync");
 
               foreach($sourceIterator as $srcent) {
-
                 $targetent = $TargetRelatedTable->find()
-                                                ->where(['original_id' => $srcent->id])
+                                                ->where(['originalid' => $srcent->id])
                                                 // There should be at most one
                                                 ->first();
 
@@ -734,8 +747,8 @@ protected function cloneEntity(
                   // correct it, but this is clearer)
                   $targetent->$parent_key = $cloneId;
 
-                  // Insert original_id, _after_ fixing the foreign keys
-                  $targetent->original_id = $srcent->id;
+                  // Insert originalid, _after_ fixing the foreign keys
+                  $targetent->originalid = $srcent->id;
 
                   $TargetRelatedTable->saveOrFail($targetent);
 
@@ -810,7 +823,20 @@ protected function cloneEntity(
         }
       }
 
-      $tcxn->commit();
+      // Perform any table specific follow up tasks. Unlike checkCloneDependencies
+      // this call may perform work.
+
+      if(method_exists($TargetTable, "postClone")) {
+        try {
+          $TargetTable->postClone($clone, $targetDataSource);
+        }
+        catch(\Exception $e) {
+          // We catch the Exception to provide context
+          throw new \Exception($clone->uuid . ": postClone failed: " . $e->getMessage());
+        }
+      }
+
+      $tcxn->commit();  
     }
     catch(\Exception $e) {
       $this->io->err($e->getMessage());
@@ -819,6 +845,43 @@ protected function cloneEntity(
         $tcxn->rollback();
       }
     }
+
+    if(method_exists($Table, "getCloneSuccessors")) {
+      // Now clone any successor entities
+
+      $uuids = $Table->getCloneSuccessors($original);
+
+      // We accept both UUIDs and PaginatedSqlIterators in the array. We have to accept
+      // multiple PaginatedSqlIterators because each one can only handle a single model.
+      // Failure to clone a successor entity does _not_ fail the primary clone action,
+      // and does not prevent other successors from being cloned.
+
+      $this->io->out("== Processing Successor Entities ==");
+
+      foreach($uuids as $uuid) {
+        if(is_string($uuid)) {
+          // Simple UUID
+          try {
+            $this->cloneByUuid($uuid, $sourceCoId, $targetCoId, $targetDataSource);
+          }
+          catch(\Exception $e) {
+            $this->io->err($uuid . ": " . $e->getMessage());
+          }
+        } else {
+          // PaginatedSqlIterator
+          foreach($uuid as $entity) {
+            try {
+              $this->cloneByUuid($entity->uuid, $sourceCoId, $targetCoId, $targetDataSource);
+            }
+            catch(\Exception $e) {
+              $this->io->err($uuid . ": " . $e->getMessage());
+            }
+          }
+        }
+      }
+
+      $this->io->out("== Finished Processing Successor Entities ==");
+    }
   }
 
   /**

app/src/Lib/Traits/PluggableModelTrait.php

@@ -123,29 +123,21 @@ public function checkCloneDependencies(
       // model (attached to the remote data source) at save(). (For further discussion, see
       // the comments in CloneCommand::execute().) We don't actually need the Table
       // objects here, we just want to make sure the TableRegistry is correctly set up.
-
-      $related = TableUtilities::normalizeAssociationArray($this->getCloneHasMany());
-
-      $fn = function($related, $targetDataSource, $pluginName) use (&$fn) {
-        foreach($related as $rm => $ra) {
-          TableUtilities::getTableWithDataSource(
-            tableName: $pluginName.".".$rm,
-            connectionName: $targetDataSource
-          );
 
-          $fn($ra, $targetDataSource, $pluginName);
-        }
-      };
-
-      // getCloneRelations() will return all possible relations for all plugins for the
-      // current model (eg if $original is ExternalIdentitySource, we'll get back an
-      // array of all EIS plugins), but we only want to instantiate related models
-      // for $plugin.
+      // We now only need to handle hasOne relations because hasMany relations are
+      // handled by iteration
+
+      $related = TableUtilities::normalizeAssociationArray($this->getCloneHasOne());
 
-      $pluginModel = StringUtilities::pluginPlugin($original->plugin);
+      if(array_key_exists($original->plugin, $related)) {
+        // getCloneRelations() will return all possible relations for all plugins for the
+        // current model (eg if $original is ExternalIdentitySource, we'll get back an
+        // array of all EIS plugins), but we only want to instantiate the active model
 
-      if(!empty($related[$pluginModel])) {
-        $fn($related[$pluginModel], $targetDataSource, $pluginName);
+        TableUtilities::getTableWithDataSource(
+          tableName: $original->plugin,
+          connectionName: $targetDataSource
+        );
       }
     }
   }
@@ -188,40 +180,12 @@ public function getCloneHasOne(): array {
     $ret = [];
 
     foreach($this->_pluginModels as $entryPoint) {
-      $ret[] = $entryPoint; //StringUtilities::pluginModel($entryPoint);
+      $ret[] = $entryPoint;
     }
 
     return $ret;
   }
 
-  /**
-   * Get the set of entities that are to be cloned after $original.
-   * 
-   * The returned array may include both UUIDs (strings) and PaginatedSqlIterators,
-   * where the Iterator returns only clonable entities.
-   * 
-   * @since  COmanage Registry v5.2.0
-   * @param   EntityInterface $original Current entity being cloned
-   * @return  array                     Array of UUIDs and/or PaginatedSqlIterators
-   */
-
-  public function getCloneSuccessors(
-    \Cake\Datasource\EntityInterface $original
-  ): array {
-    // We don't really know whether we need to use PaginatedSqlIterator for every
-    // hasMany relation (without adding annotations of some form), and indeed in most
-    // cases we probably don't need it (smaller deployments, models with only a few
-    // related entities), but for the cases where we need it we really need it
-    // (ApiSourceRecords, EnvSourceIdentities) so we always use it. (The overhead
-    // for smoller data sets should be marginal.)
-
-    // Because PaginatedSqlIterators only operate over a single table, we need to
-    // return one per hasMany relation.
-    $ret = [];
-
-    return $ret;
-  }
-
   /**
    * Determine the plugin type used by this Pluggable Model. This is the lowercased
    * singular prefix of the Pluggable Model Table name. eg: For "ReportsTable" the

app/src/Lib/Util/SchemaManager.php

@@ -272,10 +272,11 @@ protected function processSchema(
         // Add metadata fields for Clonable Related Models. Eventually this setting
         // should probably be the default, and disabled when not needed (like changelog).
 
-        // original_id is _not_ given a foreign key constraint because the Original
-        // Object may be in a different database.
-        $table->addColumn("original_id", "integer", ['notnull' => false]);
-        $table->addIndex(["original_id"], $tablePrefix.$tName."_icb", [], []);
+        // We call this "originalid" and not "original_id" because it's not a proper
+        // foreign key, since minimally it crosses a CO (which would violate AR-GMR-2)
+        // and maybe crosses CMPs (in which case it's a foreign key to another database).
+        $table->addColumn("originalid", "integer", ['notnull' => false]);
+        $table->addIndex(["originalid"], $tablePrefix.$tName."_icb", [], []);
       }
 
       // (For Registry) If MVEA models are specified, emit the appropriate

app/src/Model/Entity/ApiUser.php

@@ -44,6 +44,8 @@ class ApiUser extends Entity {
     // can set api_key. (AR-ApiUser-4)
     'api_key' => false
   ];
+
+  public array $_supportedMetadata = ['clonable'];
 
   /**
    * Hash (bcrypt) an API Key on save.

app/src/Model/Entity/Cou.php

@@ -39,4 +39,6 @@ class Cou extends Entity {
     'id' => false,
     'slug' => false, 
   ];
+
+  public array $_supportedMetadata = ['clonable'];
 }

app/src/Model/Entity/ExternalIdentitySource.php

@@ -39,4 +39,6 @@ class ExternalIdentitySource extends Entity {
     'id' => false,
     'slug' => false, 
   ];
+
+  public array $_supportedMetadata = ['clonable'];
 }

app/src/Model/Entity/Group.php

@@ -42,6 +42,8 @@ class Group extends Entity {
     'id' => false,
     'slug' => false, 
   ];
+
+  public array $_supportedMetadata = ['clonable'];
 
   /**
    * Determine if this entity record can be deleted.
@@ -73,6 +75,7 @@ public function isAllMembers(): bool {
    */
 
   public function isAutomatic(): bool {
+    // If this list is updated, CousTable::getCloneSuccessors will need to be updated as well
     return in_array($this->group_type, [GroupTypeEnum::ActiveMembers, GroupTypeEnum::AllMembers]);
   }
 

app/src/Model/Entity/IdentifierAssignment.php

@@ -39,4 +39,6 @@ class IdentifierAssignment extends Entity {
     'id' => false,
     'slug' => false, 
   ];
+
+  public array $_supportedMetadata = ['clonable'];
 }

app/src/Model/Entity/Pipeline.php

@@ -39,4 +39,6 @@ class Pipeline extends Entity {
     'id' => false,
     'slug' => false, 
   ];
+
+  public array $_supportedMetadata = ['clonable'];
 }

app/src/Model/Entity/ProvisioningTarget.php

@@ -41,6 +41,8 @@ class ProvisioningTarget extends Entity {
     'slug' => false, 
   ];
 
+  public array $_supportedMetadata = ['clonable'];
+
   /**
    * Determine if this entity is Active.
    * 

app/src/Model/Entity/Server.php

@@ -39,4 +39,6 @@ class Server extends Entity {
     'id' => false,
     'slug' => false, 
   ];
+
+  public array $_supportedMetadata = ['clonable'];
 }

app/src/Model/Entity/Type.php

@@ -39,4 +39,6 @@ class Type extends Entity {
     'id' => false,
     'slug' => false, 
   ];
+
+  public array $_supportedMetadata = ['clonable'];
 }