From: Tim Otten <totten@civicrm.org>
Date: Tue, 24 May 2022 00:20:11 +0000 (-0700)
Subject: CRM/Upgrade - Snapshots should have name `snap_{OWNER}_{VERSION}_{NAME}`
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=1602aa08f85d12d70fd4ff5fd19d0f5c1092ff8e;p=civicrm-core.git

CRM/Upgrade - Snapshots should have name `snap_{OWNER}_{VERSION}_{NAME}`

1. Prevents the trigger-based logging system from hitting the snapshots.
2. Makes the de-facto table names shorter (less likely to hit 64 char limit)
3. In practice, it should be easier to skim
4. Use the same pseudo-extension name that we use elsewhere (`civicrm`)
---

diff --git a/CRM/Upgrade/Form.php b/CRM/Upgrade/Form.php
index 7e9a706024..8a92589f6b 100644
--- a/CRM/Upgrade/Form.php
+++ b/CRM/Upgrade/Form.php
@@ -539,7 +539,7 @@ SET    version = '$version'
     if (empty(CRM_Upgrade_Snapshot::getActivationIssues())) {
       $task = new CRM_Queue_Task(
         ['CRM_Upgrade_Snapshot', 'cleanupTask'],
-        ['core'],
+        ['civicrm'],
         "Cleanup old upgrade snapshots"
       );
       $queue->createItem($task, ['weight' => 0]);
diff --git a/CRM/Upgrade/Incremental/Base.php b/CRM/Upgrade/Incremental/Base.php
index f178187125..b109b5772f 100644
--- a/CRM/Upgrade/Incremental/Base.php
+++ b/CRM/Upgrade/Incremental/Base.php
@@ -172,7 +172,7 @@ class CRM_Upgrade_Incremental_Base {
    * @throws \CRM_Core_Exception
    */
   protected function addSnapshotTask(string $name, CRM_Utils_SQL_Select $select): void {
-    CRM_Upgrade_Snapshot::createTableName('core', $this->getMajorMinor(), $name);
+    CRM_Upgrade_Snapshot::createTableName('civicrm', $this->getMajorMinor(), $name);
     // ^^ To simplify QA -- we should always throw an exception for bad snapshot names, even if the local policy doesn't use snapshots.
 
     if (!empty(CRM_Upgrade_Snapshot::getActivationIssues())) {
@@ -183,7 +183,7 @@ class CRM_Upgrade_Incremental_Base {
       'type' => 'Sql',
       'name' => CRM_Upgrade_Form::QUEUE_NAME,
     ]);
-    foreach (CRM_Upgrade_Snapshot::createTasks('core', $this->getMajorMinor(), $name, $select) as $task) {
+    foreach (CRM_Upgrade_Snapshot::createTasks('civicrm', $this->getMajorMinor(), $name, $select) as $task) {
       $queue->createItem($task, ['weight' => -1]);
     }
   }
diff --git a/CRM/Upgrade/Snapshot.php b/CRM/Upgrade/Snapshot.php
index b1c263aa8e..fd52b602ff 100644
--- a/CRM/Upgrade/Snapshot.php
+++ b/CRM/Upgrade/Snapshot.php
@@ -81,13 +81,13 @@ class CRM_Upgrade_Snapshot {
    *
    * @param string $owner
    *   Name of the component/module/extension that owns the snapshot.
-   *   Ex: 'core', 'sequentialcreditnotes', 'oauth_client'
+   *   Ex: 'civicrm', 'sequentialcreditnotes', 'oauth_client'
    * @param string $version
    *   Ex: '5.50'
    * @param string $name
    *   Ex: 'dates'
    * @return string
-   *   Ex: 'civicrm_snap_v5_50_dates'
+   *   Ex: 'snap_civicrm_v5_50_dates'
    * @throws \CRM_Core_Exception
    *   If the resulting table name would be invalid, then this throws an exception.
    */
@@ -101,7 +101,7 @@ class CRM_Upgrade_Snapshot {
     }
     $versionExpr = ($versionParts[0] . '_' . $versionParts[1]);
 
-    $table = sprintf('civicrm_snap_%s_v%s_%s', $owner, $versionExpr, $name);
+    $table = sprintf('snap_%s_v%s_%s', $owner, $versionExpr, $name);
     if (!preg_match(';^[a-z0-9_]+$;', $table)) {
       throw new CRM_Core_Exception("Malformed snapshot name ($table)");
     }
@@ -117,7 +117,7 @@ class CRM_Upgrade_Snapshot {
    *
    * @param string $owner
    *   Name of the component/module/extension that owns the snapshot.
-   *   Ex: 'core', 'sequentialcreditnotes', 'oauth_client'
+   *   Ex: 'civicrm', 'sequentialcreditnotes', 'oauth_client'
    * @param string $version
    *   Ex: '5.50'
    * @param string $name
@@ -170,7 +170,7 @@ class CRM_Upgrade_Snapshot {
    *
    * @param CRM_Queue_TaskContext|null $ctx
    * @param string $owner
-   *   Ex: 'core', 'sequentialcreditnotes', 'oauth_client'
+   *   Ex: 'civicrm', 'sequentialcreditnotes', 'oauth_client'
    * @param string|null $version
    *   The current version of CiviCRM.
    * @param int|null $cleanupAfter
@@ -178,7 +178,7 @@ class CRM_Upgrade_Snapshot {
    *   Time is measured in terms of MINOR versions - eg "4" means "retain for 4 MINOR versions".
    *   Thus, on v5.60, you could delete any snapshots predating 5.56.
    */
-  public static function cleanupTask(?CRM_Queue_TaskContext $ctx = NULL, string $owner = 'core', ?string $version = NULL, ?int $cleanupAfter = NULL): void {
+  public static function cleanupTask(?CRM_Queue_TaskContext $ctx = NULL, string $owner = 'civicrm', ?string $version = NULL, ?int $cleanupAfter = NULL): void {
     $version = $version ?: CRM_Core_BAO_Domain::version();
     $cleanupAfter = $cleanupAfter ?: static::$cleanupAfter;
 
@@ -194,11 +194,11 @@ class CRM_Upgrade_Snapshot {
     ";
     $tables = CRM_Core_DAO::executeQuery($query, [
       1 => [$dao->database(), 'String'],
-      2 => ["civicrm_snap_{$owner}_v%", 'String'],
+      2 => ["snap_{$owner}_v%", 'String'],
     ])->fetchMap('tableName', 'tableName');
 
     $oldTables = array_filter($tables, function($table) use ($owner, $cutoff) {
-      if (preg_match(";^civicrm_snap_{$owner}_v(\d+)_(\d+)_;", $table, $m)) {
+      if (preg_match(";^snap_{$owner}_v(\d+)_(\d+)_;", $table, $m)) {
         $generatedVer = $m[1] . '.' . $m[2];
         return (bool) version_compare($generatedVer, $cutoff, '<');
       }
diff --git a/tests/phpunit/CRM/Upgrade/SnapshotTest.php b/tests/phpunit/CRM/Upgrade/SnapshotTest.php
index 5a99fa0bb2..1097972ffa 100644
--- a/tests/phpunit/CRM/Upgrade/SnapshotTest.php
+++ b/tests/phpunit/CRM/Upgrade/SnapshotTest.php
@@ -13,22 +13,22 @@ class CRM_Upgrade_SnapshotTest extends CiviUnitTestCase {
   }
 
   public function testTableNames_good() {
-    $this->assertEquals('civicrm_snap_core_v5_45_stuff', CRM_Upgrade_Snapshot::createTableName('core', '5.45', 'stuff'));
-    $this->assertEquals('civicrm_snap_core_v5_50_stuffy_things', CRM_Upgrade_Snapshot::createTableName('core', '5.50', 'stuffy_things'));
-    $this->assertEquals('civicrm_snap_oauth_client_v12_34_ext_things', CRM_Upgrade_Snapshot::createTableName('oauth_client', '12.34', 'ext_things'));
-    $this->assertEquals('civicrm_snap_oauth_client_v0_1234_ext_things', CRM_Upgrade_Snapshot::createTableName('oauth_client', '0.1234', 'ext_things'));
+    $this->assertEquals('snap_civicrm_v5_45_stuff', CRM_Upgrade_Snapshot::createTableName('civicrm', '5.45', 'stuff'));
+    $this->assertEquals('snap_civicrm_v5_50_stuffy_things', CRM_Upgrade_Snapshot::createTableName('civicrm', '5.50', 'stuffy_things'));
+    $this->assertEquals('snap_oauth_client_v12_34_ext_things', CRM_Upgrade_Snapshot::createTableName('oauth_client', '12.34', 'ext_things'));
+    $this->assertEquals('snap_oauth_client_v0_1234_ext_things', CRM_Upgrade_Snapshot::createTableName('oauth_client', '0.1234', 'ext_things'));
   }
 
   public function testTableNames_bad() {
     try {
-      CRM_Upgrade_Snapshot::createTableName('core', '5.45', 'ab&cd');
+      CRM_Upgrade_Snapshot::createTableName('civicrm', '5.45', 'ab&cd');
       $this->fail('Accepted invalid name');
     }
     catch (CRM_Core_Exception $e) {
       $this->assertRegExp('/Malformed snapshot name/', $e->getMessage());
     }
     try {
-      CRM_Upgrade_Snapshot::createTableName('core', '5.45', 'loremipsumdolorsitametconsecteturadipiscingelitseddoeiusmod');
+      CRM_Upgrade_Snapshot::createTableName('civicrm', '5.45', 'loremipsumdolorsitametconsecteturadipiscingelitseddoeiusmod');
       $this->fail('Accepted excessive name');
     }
     catch (CRM_Core_Exception $e) {
@@ -50,25 +50,25 @@ class CRM_Upgrade_SnapshotTest extends CiviUnitTestCase {
       $this->organizationCreate([], $i);
     }
 
-    $this->runAll(CRM_Upgrade_Snapshot::createTasks('core', '5.45', 'names', CRM_Utils_SQL_Select::from('civicrm_contact')
+    $this->runAll(CRM_Upgrade_Snapshot::createTasks('civicrm', '5.45', 'names', CRM_Utils_SQL_Select::from('civicrm_contact')
       ->select('id, display_name, sort_name, modified_date')
       ->where('contact_type = "Individual"')
     ));
-    $this->assertTrue(CRM_Core_DAO::checkTableExists('civicrm_snap_core_v5_45_names'));
-    $this->assertSameSchema('civicrm_contact.display_name', 'civicrm_snap_core_v5_45_names.display_name');
-    $this->assertSameSchema('civicrm_contact.sort_name', 'civicrm_snap_core_v5_45_names.sort_name');
-    $this->assertSameSchema('civicrm_contact.modified_date', 'civicrm_snap_core_v5_45_names.modified_date');
+    $this->assertTrue(CRM_Core_DAO::checkTableExists('snap_civicrm_v5_45_names'));
+    $this->assertSameSchema('civicrm_contact.display_name', 'snap_civicrm_v5_45_names.display_name');
+    $this->assertSameSchema('civicrm_contact.sort_name', 'snap_civicrm_v5_45_names.sort_name');
+    $this->assertSameSchema('civicrm_contact.modified_date', 'snap_civicrm_v5_45_names.modified_date');
     $this->assertTrue(CRM_Core_BAO_SchemaHandler::checkIfFieldExists('civicrm_contact', 'legal_name'));
-    $this->assertFalse(CRM_Core_BAO_SchemaHandler::checkIfFieldExists('civicrm_snap_core_v5_45_names', 'legal_name'));
+    $this->assertFalse(CRM_Core_BAO_SchemaHandler::checkIfFieldExists('snap_civicrm_v5_45_names', 'legal_name'));
 
     $liveContacts = CRM_Core_DAO::singleValueQuery('SELECT count(*) FROM civicrm_contact');
     $liveIndividuals = CRM_Core_DAO::singleValueQuery('SELECT count(*) FROM civicrm_contact WHERE contact_type = "Individual"');
-    $snapCount = CRM_Core_DAO::singleValueQuery('SELECT count(*) FROM civicrm_snap_core_v5_45_names');
+    $snapCount = CRM_Core_DAO::singleValueQuery('SELECT count(*) FROM snap_civicrm_v5_45_names');
     $this->assertEquals($liveIndividuals, $snapCount, 'The snapshot should have as many records as live table.');
     $this->assertTrue($liveContacts > $liveIndividuals);
     $this->assertGreaterThan(CRM_Upgrade_Snapshot::$pageSize, $snapCount, "There should be more than 1 page of data in the snapshot. Found $snapCount records.");
 
-    CRM_Core_DAO::executeQuery('DROP TABLE civicrm_snap_core_v5_45_names');
+    CRM_Core_DAO::executeQuery('DROP TABLE snap_civicrm_v5_45_names');
   }
 
   /**
@@ -83,28 +83,28 @@ class CRM_Upgrade_SnapshotTest extends CiviUnitTestCase {
     $this->eventCreate([]);
     $this->eventCreate([]);
 
-    $this->runAll(CRM_Upgrade_Snapshot::createTasks('core', '5.45', 'names', CRM_Utils_SQL_Select::from('civicrm_contact')
+    $this->runAll(CRM_Upgrade_Snapshot::createTasks('civicrm', '5.45', 'names', CRM_Utils_SQL_Select::from('civicrm_contact')
       ->select('id, display_name, sort_name')
       ->where('contact_type = "Individual"')
     ));
-    $this->assertTrue(CRM_Core_DAO::checkTableExists('civicrm_snap_core_v5_45_names'));
-    $this->assertSameSchema('civicrm_contact.display_name', 'civicrm_snap_core_v5_45_names.display_name');
-    $this->assertGreaterThan(1, CRM_Core_DAO::singleValueQuery('SELECT count(*) FROM civicrm_snap_core_v5_45_names'));
+    $this->assertTrue(CRM_Core_DAO::checkTableExists('snap_civicrm_v5_45_names'));
+    $this->assertSameSchema('civicrm_contact.display_name', 'snap_civicrm_v5_45_names.display_name');
+    $this->assertGreaterThan(1, CRM_Core_DAO::singleValueQuery('SELECT count(*) FROM snap_civicrm_v5_45_names'));
 
-    $this->runAll(CRM_Upgrade_Snapshot::createTasks('core', '5.50', 'dates', CRM_Utils_SQL_Select::from('civicrm_event')
+    $this->runAll(CRM_Upgrade_Snapshot::createTasks('civicrm', '5.50', 'dates', CRM_Utils_SQL_Select::from('civicrm_event')
       ->select('id, start_date, end_date, registration_start_date, registration_end_date')
     ));
-    $this->assertTrue(CRM_Core_DAO::checkTableExists('civicrm_snap_core_v5_50_dates'));
-    $this->assertSameSchema('civicrm_event.start_date', 'civicrm_snap_core_v5_50_dates.start_date');
-    $this->assertGreaterThan(1, CRM_Core_DAO::singleValueQuery('SELECT count(*) FROM civicrm_snap_core_v5_50_dates'));
+    $this->assertTrue(CRM_Core_DAO::checkTableExists('snap_civicrm_v5_50_dates'));
+    $this->assertSameSchema('civicrm_event.start_date', 'snap_civicrm_v5_50_dates.start_date');
+    $this->assertGreaterThan(1, CRM_Core_DAO::singleValueQuery('SELECT count(*) FROM snap_civicrm_v5_50_dates'));
 
-    CRM_Upgrade_Snapshot::cleanupTask(NULL, 'core', '5.52', 6);
-    $this->assertFalse(CRM_Core_DAO::checkTableExists('civicrm_snap_core_v5_45_names'));
-    $this->assertTrue(CRM_Core_DAO::checkTableExists('civicrm_snap_core_v5_50_dates'));
+    CRM_Upgrade_Snapshot::cleanupTask(NULL, 'civicrm', '5.52', 6);
+    $this->assertFalse(CRM_Core_DAO::checkTableExists('snap_civicrm_v5_45_names'));
+    $this->assertTrue(CRM_Core_DAO::checkTableExists('snap_civicrm_v5_50_dates'));
 
-    CRM_Upgrade_Snapshot::cleanupTask(NULL, 'core', '5.58', 6);
-    $this->assertFalse(CRM_Core_DAO::checkTableExists('civicrm_snap_core_v5_45_names'));
-    $this->assertFalse(CRM_Core_DAO::checkTableExists('civicrm_snap_core_v5_50_dates'));
+    CRM_Upgrade_Snapshot::cleanupTask(NULL, 'civicrm', '5.58', 6);
+    $this->assertFalse(CRM_Core_DAO::checkTableExists('snap_civicrm_v5_45_names'));
+    $this->assertFalse(CRM_Core_DAO::checkTableExists('snap_civicrm_v5_50_dates'));
   }
 
   /**