Move code removing old mappings to installer

Author: isc-dchui

preload/cls/IPM/Installer.cls

@@ -416,4 +416,37 @@ ClassMethod CreateTempDir() As %String
     return ##class(%File).NormalizeDirectory(tDir)
 }
 
+/// This method is called directly in LoadNewModule() instead of with an <Invoke> in the module.xml
+/// because the old mappings break load/install before any <Invokes> can be run.
+ClassMethod CleanupOldMappings() As %Status
+{
+    set sc = $$$OK
+    // Cleanup old mappings from oddStudioDocument
+    set key = ""
+    for {
+        set key = $order(^oddStudioDocument(key))
+        quit:key=""
+        if (key["%ZPM.PackageManager") || (key["%ZHSLIB.PackageManager") {
+            kill ^oddStudioDocument(key)
+        }
+    }
+
+    // These mappings were suggested as a temporary workaround for IRIS 2023.x,
+    // but whose underlying issues have been resolved in 2024.1 and later.
+    set status = ##class(%IPM.Utils.Module).RemoveGlobalMapping($namespace,"oddStudioDocument:(BEGIN):(""%ZP"")","IRISLIB")
+    if $$$ISERR(status) {
+        set sc = $$$ADDSC(sc, status)
+    }
+    set status = ##class(%IPM.Utils.Module).RemoveGlobalMapping($namespace,"oddStudioDocument:(""%ZP""):(""A"")","IRISSYS")
+    if $$$ISERR(status) {
+        set sc = $$$ADDSC(sc, status)
+    }
+    set status = ##class(%IPM.Utils.Module).RemoveGlobalMapping($namespace,"oddStudioDocument:(""Ens""):(""Ent"")","ENSLIB")
+    if $$$ISERR(status) {
+        set sc = $$$ADDSC(sc, status)
+    }
+
+    return sc
+}
+
 }

src/cls/IPM/Lifecycle/Base.cls

@@ -1322,6 +1322,7 @@ Method %Verify(ByRef pParams) As %Status
 
                 // Map the package manager itself equivalently in the VERIFY namespace.
                 $$$ThrowOnError(##class(%IPM.Utils.Build).MapRoutineEquivalently("%IPM.*",tInitNS,,tNewNamespace))
+                $$$ThrowOnError(##class(%IPM.Utils.Build).MapRoutineEquivalently("IPM.*",tInitNS,,tNewNamespace))
                 $$$ThrowOnError(##class(%IPM.Utils.Build).MapPackageEquivalently("%IPM",tInitNS,tNewNamespace))
 
                 // Map globals for %IPM.Repo.Definition and %IPM.Repo.Filesystem.Cache

src/cls/IPM/Utils/Module.cls

@@ -1100,7 +1100,7 @@ ClassMethod LoadNewModule(
 
             // If installing new version of IPM, clean up old mappings
             if newModuleObj.Name=$$$IPMModuleName {
-                $$$ThrowOnError(..CleanupOldMappings())
+                $$$ThrowOnError(##class(IPM.Installer).CleanupOldMappings())
             }
         }
         if moduleCurrent '= "" {
@@ -2420,35 +2420,4 @@ ClassMethod GetDeployedProjectName(moduleName As %String) As %String [ CodeMode
 moduleName_$$$DeployedProjectSuffix
 }
 
-/// This method is called directly in LoadNewModule() instead of with an <Invoke> in the module.xml
-/// because the old mappings break load/install before any <Invokes> can be run.
-ClassMethod CleanupOldMappings() As %Status
-{
-    set sc = $$$OK
-    // Cleanup old mappings from oddStudioDocument
-    set key = ""
-    for {
-        set key = $order(^oddStudioDocument(key))
-        quit:key=""
-        if (key["%ZPM.PackageManager") || (key["%ZHSLIB.PackageManager") {
-            kill ^oddStudioDocument(key)
-        }
-    }
-
-    set status = ##class(%IPM.Utils.Module).RemoveGlobalMapping($namespace,"oddStudioDocument:(BEGIN):(""%ZP"")","IRISLIB")
-    if $$$ISERR(status) {
-        set sc = $$$ADDSC(sc, status)
-    }
-    set status = ##class(%IPM.Utils.Module).RemoveGlobalMapping($namespace,"oddStudioDocument:(""%ZP""):(""A"")","IRISSYS")
-    if $$$ISERR(status) {
-        set sc = $$$ADDSC(sc, status)
-    }
-    set status = ##class(%IPM.Utils.Module).RemoveGlobalMapping($namespace,"oddStudioDocument:(""Ens""):(""Ent"")","ENSLIB")
-    if $$$ISERR(status) {
-        set sc = $$$ADDSC(sc, status)
-    }
-
-    return sc
-}
-
 }