Fix migration of PractitionerRole and history to match new role names (#9991)

* Modified and added migration to set new role name for role and history

Nobody has gone live with v1.7 yet so the changes to the migration will still work on all live installations

* Update changelog

Author: tumbledwyer

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [1.7.4](https://github.com/opencrvs/opencrvs-core/compare/v1.7.3...v1.7.4)
+
+### Bug fixes
+
+- Fixed historical roles displaying incorrectly in task history after migration to v1.7 [#9989](https://github.com/opencrvs/opencrvs-core/issues/9989)
+
 ## [1.7.3](https://github.com/opencrvs/opencrvs-core/compare/v1.7.2...v1.7.3)
 
 ### New features
@@ -10,7 +16,6 @@
 - Fix international to local number conversion from failing if the number was already local [#9634](https://github.com/opencrvs/opencrvs-core/issues/9634)
 - Pre-select default certificate option in print certificate collector form [#9935](https://github.com/opencrvs/opencrvs-core/issues/9935)
 
-
 ## [1.7.2](https://github.com/opencrvs/opencrvs-core/compare/v1.7.1...v1.7.2)
 
 ### New features

packages/migration/src/migrations/hearth/20240812142943-update-practitioner-role-collection-for-new-userroles.ts

@@ -9,6 +9,7 @@
  * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
  */
 
+import { transformRoleCodes } from '../../utils/role-helper.js'
 import { Db, MongoClient } from 'mongodb'
 
 export const up = async (db: Db, client: MongoClient) => {
@@ -18,11 +19,12 @@ export const up = async (db: Db, client: MongoClient) => {
     .toArray()
 
   for (const doc of documents) {
-    const filteredCode = doc.code.filter((c: any) =>
-      c.coding.find(
-        (cod: any) => cod.system !== 'http://opencrvs.org/specs/types'
-      )
-    )
+    if (!doc.code) {
+      console.warn(`Document ${doc._id}: No code field, skipping`)
+      continue
+    }
+
+    const filteredCode = transformRoleCodes(doc)
 
     await db
       .collection('PractitionerRole')

packages/migration/src/migrations/hearth/20250716162802-update-practitioner-role-history-collection-for-new-userroles.ts

@@ -0,0 +1,36 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * OpenCRVS is also distributed under the terms of the Civil Registration
+ * & Healthcare Disclaimer located at http://opencrvs.org/license.
+ *
+ * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
+ */
+
+import { transformRoleCodes } from '../../utils/role-helper.js'
+import { Db, MongoClient } from 'mongodb'
+
+export const up = async (db: Db, client: MongoClient) => {
+  const documents = await db
+    .collection('PractitionerRole_history')
+    .find({ 'code.coding.system': 'http://opencrvs.org/specs/types' })
+    .toArray()
+
+  for (const doc of documents) {
+    if (!doc.code) {
+      console.warn(`Document ${doc._id}: No code field, skipping`)
+      continue
+    }
+
+    const filteredCode = transformRoleCodes(doc)
+
+    await db
+      .collection('PractitionerRole_history')
+      .updateOne({ _id: doc._id }, { $set: { code: filteredCode } })
+  }
+  console.log('Documents updated.')
+}
+
+export const down = async (db: Db, client: MongoClient) => {}

packages/migration/src/utils/role-helper.ts

@@ -145,3 +145,66 @@ export const updatePractitionerRoleCodeAggregate = [
     }
   }
 ]
+
+/**
+ * Transform role code based on the english label to match how the scripts will generate new roles from aliases
+ */
+export const transformRoleCodes = (doc: any) => {
+  const updatedCode = [...doc.code]
+
+  // Find the types system code and extract the English label
+  const typesCodeEntry = doc.code.find((c: any) =>
+    c?.coding?.find((cod: any) => cod?.system === typeSystemUrl)
+  )
+
+  const typesCoding = typesCodeEntry?.coding?.find(
+    (cod: any) => cod?.system === typeSystemUrl
+  )
+
+  if (typesCoding?.code) {
+    try {
+      const labelArray = JSON.parse(typesCoding.code)
+
+      const englishLabel = labelArray?.find(
+        (item: any) => item?.lang === 'en' && item?.label
+      )
+
+      if (englishLabel?.label) {
+        const transformedLabel = englishLabel.label
+          .toUpperCase()
+          .replace(/ /g, '_')
+
+        // Find and update the roles system code
+        const rolesCodeIndex = updatedCode.findIndex((c: any) =>
+          c?.coding?.find((cod: any) => cod?.system === roleSystemUrl)
+        )
+
+        if (rolesCodeIndex !== -1) {
+          const rolesCodingIndex = updatedCode[rolesCodeIndex].coding.findIndex(
+            (cod: any) => cod?.system === roleSystemUrl
+          )
+
+          if (rolesCodingIndex !== -1) {
+            updatedCode[rolesCodeIndex].coding[rolesCodingIndex].code =
+              transformedLabel
+          }
+        }
+      } else {
+        console.warn(
+          `Document ${doc._id}: No valid English label found in types code`
+        )
+      }
+    } catch (parseError) {
+      console.warn(
+        `Document ${doc._id}: Could not parse types code as JSON, skipping role update:`,
+        parseError
+      )
+    }
+  }
+
+  // Remove the types system from the code array
+  const filteredCode = updatedCode.filter((c: any) =>
+    c?.coding?.find((cod: any) => cod?.system !== typeSystemUrl)
+  )
+  return filteredCode
+}