Add join table for software installs/uninstalls

server/datastore/mysql/migrations/tables/20250106162751_AddUnifiedQueueTable.go

@@ -26,7 +26,7 @@ CREATE TABLE upcoming_activities (
 
 	-- type of activity to be executed, currently we only support those, but as
 	-- more activity types get added, we can enrich the ENUM with an ALTER TABLE.
-	activity_type  ENUM('script', 'software_install', 'vpp_app_install') NOT NULL,
+	activity_type  ENUM('script', 'software_install', 'software_uninstall', 'vpp_app_install') NOT NULL,
 
 	-- execution_id is the identifier of the activity that will be used when
 	-- executed - e.g. scripts and software installs have an execution_id, and
@@ -42,7 +42,10 @@ CREATE TABLE upcoming_activities (
 
 	PRIMARY KEY (id),
 	UNIQUE KEY idx_upcoming_activities_execution_id (execution_id),
-	INDEX idx_upcoming_activities_host_id_activity_type (host_id, priority, created_at, activity_type),
+	-- index for the common access pattern to get the next activity to execute
+	INDEX idx_upcoming_activities_host_id_priority_created_at (host_id, priority, created_at),
+	-- index for the common access pattern to get by activity type (e.g. deleting pending scripts)
+	INDEX idx_upcoming_activities_host_id_activity_type (activity_type, host_id),
 	CONSTRAINT fk_upcoming_activities_user_id
 		FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE SET NULL
 ) ENGINE = InnoDB DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_unicode_ci
@@ -81,6 +84,38 @@ CREATE TABLE script_upcoming_activities (
 	CONSTRAINT fk_script_upcoming_activities_setup_experience_script_id
 		FOREIGN KEY (setup_experience_script_id) REFERENCES setup_experience_scripts (id) ON DELETE SET NULL
 ) ENGINE = InnoDB DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_unicode_ci
+`,
+	)
+	if err != nil {
+		return err
+	}
+
+	_, err = tx.Exec(`
+CREATE TABLE software_install_upcoming_activities (
+	upcoming_activity_id       BIGINT UNSIGNED NOT NULL,
+
+	-- those are all columns and not JSON fields because we need FKs on them to
+	-- do processing ON DELETE, otherwise we'd have to check for existence of
+	-- each one when executing the activity (we need the enqueue next activity
+	-- action to be efficient).
+	software_installer_id      INT UNSIGNED NULL,
+	policy_id                  INT UNSIGNED NULL,
+	software_title_id          INT UNSIGNED NULL,
+
+	-- Using DATETIME instead of TIMESTAMP to prevent future Y2K38 issues
+	created_at   DATETIME(6) NOT NULL DEFAULT NOW(6),
+	updated_at   DATETIME(6) NOT NULL DEFAULT NOW(6) ON UPDATE NOW(6),
+
+	PRIMARY KEY (upcoming_activity_id),
+	CONSTRAINT fk_software_install_upcoming_activities_upcoming_activity_id
+		FOREIGN KEY (upcoming_activity_id) REFERENCES upcoming_activities (id) ON DELETE CASCADE,
+	CONSTRAINT fk_software_install_upcoming_activities_software_installer_id
+		FOREIGN KEY (software_installer_id) REFERENCES software_installers (id) ON DELETE SET NULL ON UPDATE CASCADE,
+	CONSTRAINT fk_software_install_upcoming_activities_policy_id
+		FOREIGN KEY (policy_id) REFERENCES policies (id) ON DELETE SET NULL,
+	CONSTRAINT fk_software_install_upcoming_activities_software_title_id
+		FOREIGN KEY (software_title_id) REFERENCES software_titles (id) ON DELETE SET NULL ON UPDATE CASCADE
+) ENGINE = InnoDB DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_unicode_ci
 `,
 	)
 	if err != nil {

server/datastore/mysql/schema.sql

@@ -1819,6 +1819,25 @@ CREATE TABLE `software_host_counts` (
 /*!40101 SET character_set_client = @saved_cs_client */;
 /*!40101 SET @saved_cs_client     = @@character_set_client */;
 /*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `software_install_upcoming_activities` (
+  `upcoming_activity_id` bigint unsigned NOT NULL,
+  `software_installer_id` int unsigned DEFAULT NULL,
+  `policy_id` int unsigned DEFAULT NULL,
+  `software_title_id` int unsigned DEFAULT NULL,
+  `created_at` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6),
+  `updated_at` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6),
+  PRIMARY KEY (`upcoming_activity_id`),
+  KEY `fk_software_install_upcoming_activities_software_installer_id` (`software_installer_id`),
+  KEY `fk_software_install_upcoming_activities_policy_id` (`policy_id`),
+  KEY `fk_software_install_upcoming_activities_software_title_id` (`software_title_id`),
+  CONSTRAINT `fk_software_install_upcoming_activities_policy_id` FOREIGN KEY (`policy_id`) REFERENCES `policies` (`id`) ON DELETE SET NULL,
+  CONSTRAINT `fk_software_install_upcoming_activities_software_installer_id` FOREIGN KEY (`software_installer_id`) REFERENCES `software_installers` (`id`) ON DELETE SET NULL ON UPDATE CASCADE,
+  CONSTRAINT `fk_software_install_upcoming_activities_software_title_id` FOREIGN KEY (`software_title_id`) REFERENCES `software_titles` (`id`) ON DELETE SET NULL ON UPDATE CASCADE,
+  CONSTRAINT `fk_software_install_upcoming_activities_upcoming_activity_id` FOREIGN KEY (`upcoming_activity_id`) REFERENCES `upcoming_activities` (`id`) ON DELETE CASCADE
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+/*!40101 SET character_set_client = @saved_cs_client */;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
 CREATE TABLE `software_installer_labels` (
   `id` int unsigned NOT NULL AUTO_INCREMENT,
   `software_installer_id` int unsigned NOT NULL,
@@ -1939,14 +1958,15 @@ CREATE TABLE `upcoming_activities` (
   `priority` int NOT NULL DEFAULT '0',
   `user_id` int unsigned DEFAULT NULL,
   `fleet_initiated` tinyint(1) NOT NULL DEFAULT '0',
-  `activity_type` enum('script','software_install','vpp_app_install') COLLATE utf8mb4_unicode_ci NOT NULL,
+  `activity_type` enum('script','software_install','software_uninstall','vpp_app_install') COLLATE utf8mb4_unicode_ci NOT NULL,
   `execution_id` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
   `payload` json NOT NULL,
   `created_at` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6),
   `updated_at` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6),
   PRIMARY KEY (`id`),
   UNIQUE KEY `idx_upcoming_activities_execution_id` (`execution_id`),
-  KEY `idx_upcoming_activities_host_id_activity_type` (`host_id`,`priority`,`created_at`,`activity_type`),
+  KEY `idx_upcoming_activities_host_id_priority_created_at` (`host_id`,`priority`,`created_at`),
+  KEY `idx_upcoming_activities_host_id_activity_type` (`activity_type`,`host_id`),
   KEY `fk_upcoming_activities_user_id` (`user_id`),
   CONSTRAINT `fk_upcoming_activities_user_id` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`) ON DELETE SET NULL
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;