From 4be9ca3f7368738206882456ae3ccb7c20feec0f Mon Sep 17 00:00:00 2001 From: Sarah Gillespie <73313222+gillespi314@users.noreply.github.com> Date: Tue, 9 Jan 2024 14:10:20 -0600 Subject: [PATCH] Fix database migration to preserve updated at timestamp for MDM profiles (#15993) --- .../15725-fix-profile-updated-at-migration | 22 ++++++ ...5427_AlterMacOSProfilesPrimaryKeyToUUID.go | 10 +-- ...AlterMacOSProfilesPrimaryKeyToUUID_test.go | 71 ++++++++++++------- 3 files changed, 72 insertions(+), 31 deletions(-) create mode 100644 changes/15725-fix-profile-updated-at-migration diff --git a/changes/15725-fix-profile-updated-at-migration b/changes/15725-fix-profile-updated-at-migration new file mode 100644 index 0000000000..e2fe454e98 --- /dev/null +++ b/changes/15725-fix-profile-updated-at-migration @@ -0,0 +1,22 @@ +- Fixed a database migration issue introduced in v4.42.0 that caused Fleet to consider + previously installed MDM profiles as outdated, which in turn can cause MDM profiles for macOS + hosts to become stuck in the "failed" state in some cases. Users who have not yet upgraded to + v4.42.0 should upgrade to v4.43.0 directly. Users who have already upgraded to v4.42.0 and find + one or more hosts that are affected by this issue can mitigate the issue by directly updating the + Fleet database with the following SQL statement, which will cause the failed profiles to be + redelivered to the host: + + ```sql + UPDATE + host_mdm_apple_profiles + SET + status = NULL, + retries = 0 + WHERE + status = 'failed' AND + (detail = 'Failed, was verifying' OR detail = 'Failed, was verified') AND + host_uuid = ?; + ``` + + Replace the `?` in the above statement with the UUID of the affected host, which can be found + by enabling the UUID column of the hosts table in the Fleet UI. diff --git a/server/datastore/mysql/migrations/tables/20231204155427_AlterMacOSProfilesPrimaryKeyToUUID.go b/server/datastore/mysql/migrations/tables/20231204155427_AlterMacOSProfilesPrimaryKeyToUUID.go index dd5f5f53a2..db46e4fe48 100644 --- a/server/datastore/mysql/migrations/tables/20231204155427_AlterMacOSProfilesPrimaryKeyToUUID.go +++ b/server/datastore/mysql/migrations/tables/20231204155427_AlterMacOSProfilesPrimaryKeyToUUID.go @@ -30,9 +30,10 @@ ALTER TABLE mdm_windows_configuration_profiles // add the 'w' prefix to the windows profiles table _, err = tx.Exec(` UPDATE - mdm_windows_configuration_profiles + mdm_windows_configuration_profiles mwcp SET - profile_uuid = CONCAT('w', profile_uuid) + profile_uuid = CONCAT('w', profile_uuid), + updated_at = mwcp.updated_at `) if err != nil { return fmt.Errorf("failed to update mdm_windows_configuration_profiles table: %w", err) @@ -61,10 +62,11 @@ ALTER TABLE mdm_apple_configuration_profiles // generate the uuids for the apple profiles table _, err = tx.Exec(` UPDATE - mdm_apple_configuration_profiles + mdm_apple_configuration_profiles macp SET -- see https://stackoverflow.com/a/51393124/1094941 - profile_uuid = CONCAT('a', CONVERT(uuid() USING utf8mb4)) + profile_uuid = CONCAT('a', CONVERT(uuid() USING utf8mb4)), + updated_at = macp.updated_at `) if err != nil { return fmt.Errorf("failed to update mdm_apple_configuration_profiles table: %w", err) diff --git a/server/datastore/mysql/migrations/tables/20231204155427_AlterMacOSProfilesPrimaryKeyToUUID_test.go b/server/datastore/mysql/migrations/tables/20231204155427_AlterMacOSProfilesPrimaryKeyToUUID_test.go index 23a3772f75..4123d5c55c 100644 --- a/server/datastore/mysql/migrations/tables/20231204155427_AlterMacOSProfilesPrimaryKeyToUUID_test.go +++ b/server/datastore/mysql/migrations/tables/20231204155427_AlterMacOSProfilesPrimaryKeyToUUID_test.go @@ -2,6 +2,7 @@ package tables import ( "testing" + "time" "github.com/google/uuid" "github.com/jmoiron/sqlx" @@ -11,11 +12,13 @@ import ( func TestUp_20231204155427(t *testing.T) { db := applyUpToPrev(t) + threeDayAgo := time.Now().UTC().Add(-72 * time.Hour).Truncate(time.Second) + // create some Windows profiles idwA, idwB, idwC := uuid.New().String(), uuid.New().String(), uuid.New().String() - execNoErr(t, db, `INSERT INTO mdm_windows_configuration_profiles (profile_uuid, team_id, name, syncml) VALUES (?, 0, 'A', 'A')`, idwA) - execNoErr(t, db, `INSERT INTO mdm_windows_configuration_profiles (profile_uuid, team_id, name, syncml) VALUES (?, 1, 'B', 'B')`, idwB) - execNoErr(t, db, `INSERT INTO mdm_windows_configuration_profiles (profile_uuid, team_id, name, syncml) VALUES (?, 0, 'C', 'C')`, idwC) + execNoErr(t, db, `INSERT INTO mdm_windows_configuration_profiles (profile_uuid, team_id, name, syncml, created_at, updated_at) VALUES (?, 0, 'A', 'A', ?, ?)`, idwA, threeDayAgo, threeDayAgo) + execNoErr(t, db, `INSERT INTO mdm_windows_configuration_profiles (profile_uuid, team_id, name, syncml, created_at, updated_at) VALUES (?, 1, 'B', 'B', ?, ?)`, idwB, threeDayAgo, threeDayAgo) + execNoErr(t, db, `INSERT INTO mdm_windows_configuration_profiles (profile_uuid, team_id, name, syncml, created_at, updated_at) VALUES (?, 0, 'C', 'C', ?, ?)`, idwC, threeDayAgo, threeDayAgo) nonExistingWID := uuid.New().String() // create some Windows hosts profiles with one not related to an existing profile @@ -25,9 +28,9 @@ func TestUp_20231204155427(t *testing.T) { execNoErr(t, db, `INSERT INTO host_mdm_windows_profiles (host_uuid, profile_uuid, command_uuid) VALUES ('h2', ?, 'c4')`, idwA) // create some Apple profiles - idaA := execNoErrLastID(t, db, `INSERT INTO mdm_apple_configuration_profiles (team_id, identifier, name, mobileconfig, checksum) VALUES (0, 'IA', 'NA', '', '')`) - idaB := execNoErrLastID(t, db, `INSERT INTO mdm_apple_configuration_profiles (team_id, identifier, name, mobileconfig, checksum) VALUES (1, 'IB', 'NB', '', '')`) - idaC := execNoErrLastID(t, db, `INSERT INTO mdm_apple_configuration_profiles (team_id, identifier, name, mobileconfig, checksum) VALUES (0, 'IC', 'NC', '', '')`) + idaA := execNoErrLastID(t, db, `INSERT INTO mdm_apple_configuration_profiles (team_id, identifier, name, mobileconfig, checksum, created_at, updated_at) VALUES (0, 'IA', 'NA', '', '', ?, ?)`, threeDayAgo, threeDayAgo) + idaB := execNoErrLastID(t, db, `INSERT INTO mdm_apple_configuration_profiles (team_id, identifier, name, mobileconfig, checksum, created_at, updated_at) VALUES (1, 'IB', 'NB', '', '', ?, ?)`, threeDayAgo, threeDayAgo) + idaC := execNoErrLastID(t, db, `INSERT INTO mdm_apple_configuration_profiles (team_id, identifier, name, mobileconfig, checksum, created_at, updated_at) VALUES (0, 'IC', 'NC', '', '', ?, ?)`, threeDayAgo, threeDayAgo) nonExistingAID := idaC + 1000 // create some Apple hosts profiles with one not related to an existing profile @@ -40,41 +43,55 @@ func TestUp_20231204155427(t *testing.T) { applyNext(t, db) // Windows profile uuids were updated with the prefix - var wprofUUIDs []string - err := sqlx.Select(db, &wprofUUIDs, `SELECT profile_uuid FROM mdm_windows_configuration_profiles ORDER BY name`) + var wprofs []struct { + ProfileUUID string `db:"profile_uuid"` + UpdatedAt time.Time `db:"updated_at"` + } + err := sqlx.Select(db, &wprofs, `SELECT profile_uuid, updated_at FROM mdm_windows_configuration_profiles ORDER BY name`) require.NoError(t, err) - require.Len(t, wprofUUIDs, 3) - require.Equal(t, "w"+idwA, wprofUUIDs[0]) - require.Equal(t, "w"+idwB, wprofUUIDs[1]) - require.Equal(t, "w"+idwC, wprofUUIDs[2]) + require.Len(t, wprofs, 3) + require.Equal(t, "w"+idwA, wprofs[0].ProfileUUID) + require.Equal(t, "w"+idwB, wprofs[1].ProfileUUID) + require.Equal(t, "w"+idwC, wprofs[2].ProfileUUID) + for _, wprof := range wprofs { + // updated_at did not change + require.Equal(t, threeDayAgo, wprof.UpdatedAt) + } // Apple profiles were assigned uuids in addition to identifier - var aprofUUIDs []string - err = sqlx.Select(db, &aprofUUIDs, `SELECT profile_uuid FROM mdm_apple_configuration_profiles ORDER BY name`) + var aprofs []struct { + ProfileUUID string `db:"profile_uuid"` + UpdatedAt time.Time `db:"updated_at"` + } + err = sqlx.Select(db, &aprofs, `SELECT profile_uuid, updated_at FROM mdm_apple_configuration_profiles ORDER BY name`) require.NoError(t, err) - require.Len(t, aprofUUIDs, 3) - require.Len(t, aprofUUIDs[0], 37) - require.Len(t, aprofUUIDs[1], 37) - require.Len(t, aprofUUIDs[2], 37) - require.Equal(t, "a", string(aprofUUIDs[0][0])) - require.Equal(t, "a", string(aprofUUIDs[1][0])) - require.Equal(t, "a", string(aprofUUIDs[2][0])) + require.Len(t, aprofs, 3) + require.Len(t, aprofs[0].ProfileUUID, 37) + require.Len(t, aprofs[1].ProfileUUID, 37) + require.Len(t, aprofs[2].ProfileUUID, 37) + require.Equal(t, "a", string(aprofs[0].ProfileUUID[0])) + require.Equal(t, "a", string(aprofs[1].ProfileUUID[0])) + require.Equal(t, "a", string(aprofs[2].ProfileUUID[0])) + for _, aprof := range aprofs { + // updated_at did not change + require.Equal(t, threeDayAgo, aprof.UpdatedAt) + } var hostUUIDs []string // get Windows hosts with profile A - err = sqlx.Select(db, &hostUUIDs, `SELECT host_uuid FROM host_mdm_windows_profiles WHERE profile_uuid = ? ORDER BY host_uuid`, wprofUUIDs[0]) + err = sqlx.Select(db, &hostUUIDs, `SELECT host_uuid FROM host_mdm_windows_profiles WHERE profile_uuid = ? ORDER BY host_uuid`, wprofs[0].ProfileUUID) require.NoError(t, err) require.Equal(t, []string{"h1", "h2"}, hostUUIDs) // get Windows hosts with profile B hostUUIDs = hostUUIDs[:0] - err = sqlx.Select(db, &hostUUIDs, `SELECT host_uuid FROM host_mdm_windows_profiles WHERE profile_uuid = ? ORDER BY host_uuid`, wprofUUIDs[1]) + err = sqlx.Select(db, &hostUUIDs, `SELECT host_uuid FROM host_mdm_windows_profiles WHERE profile_uuid = ? ORDER BY host_uuid`, wprofs[1].ProfileUUID) require.NoError(t, err) require.Equal(t, []string{"h2"}, hostUUIDs) // get Windows hosts with profile C hostUUIDs = hostUUIDs[:0] - err = sqlx.Select(db, &hostUUIDs, `SELECT host_uuid FROM host_mdm_windows_profiles WHERE profile_uuid = ? ORDER BY host_uuid`, wprofUUIDs[2]) + err = sqlx.Select(db, &hostUUIDs, `SELECT host_uuid FROM host_mdm_windows_profiles WHERE profile_uuid = ? ORDER BY host_uuid`, wprofs[2].ProfileUUID) require.NoError(t, err) require.Empty(t, hostUUIDs) @@ -94,19 +111,19 @@ func TestUp_20231204155427(t *testing.T) { // get Apple hosts with profile NA hostUUIDs = hostUUIDs[:0] - err = sqlx.Select(db, &hostUUIDs, `SELECT host_uuid FROM host_mdm_apple_profiles WHERE profile_uuid = ? ORDER BY host_uuid`, aprofUUIDs[0]) + err = sqlx.Select(db, &hostUUIDs, `SELECT host_uuid FROM host_mdm_apple_profiles WHERE profile_uuid = ? ORDER BY host_uuid`, aprofs[0].ProfileUUID) require.NoError(t, err) require.Equal(t, []string{"h1", "h2"}, hostUUIDs) // get Apple hosts with profile NB hostUUIDs = hostUUIDs[:0] - err = sqlx.Select(db, &hostUUIDs, `SELECT host_uuid FROM host_mdm_apple_profiles WHERE profile_uuid = ? ORDER BY host_uuid`, aprofUUIDs[1]) + err = sqlx.Select(db, &hostUUIDs, `SELECT host_uuid FROM host_mdm_apple_profiles WHERE profile_uuid = ? ORDER BY host_uuid`, aprofs[1].ProfileUUID) require.NoError(t, err) require.Equal(t, []string{"h2"}, hostUUIDs) // get Apple hosts with profile C hostUUIDs = hostUUIDs[:0] - err = sqlx.Select(db, &hostUUIDs, `SELECT host_uuid FROM host_mdm_apple_profiles WHERE profile_uuid = ? ORDER BY host_uuid`, aprofUUIDs[2]) + err = sqlx.Select(db, &hostUUIDs, `SELECT host_uuid FROM host_mdm_apple_profiles WHERE profile_uuid = ? ORDER BY host_uuid`, aprofs[2].ProfileUUID) require.NoError(t, err) require.Empty(t, hostUUIDs)