Merge branch 'main' into safeguard-discard

Author: isc-etamarch

.github/workflows/main.yml

@@ -85,7 +85,7 @@ jobs:
           ls $GITHUB_WORKSPACE/$artifact_dir
           
       - name: Attach CE Artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: always()
         with:
           name: "PreIRISInstallationPackage"
@@ -103,7 +103,7 @@ jobs:
           fail: false
 
       - name: Attach the report
-        uses: actions/upload-artifact@v1
+        uses: actions/upload-artifact@v4
         if: always()
         with:
           name: ${{ steps.xunit-viewer.outputs.report-name }}

CHANGELOG.md

@@ -5,11 +5,36 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [2.5.0] - Unreleased
+## [2.5.1] - Unreleased
 
 ### Added
 - Discards safeguarded by discard stash and warning modal (#455)
 
+### Fixed
+- Added warnings when user is using incompatible git version (#488)
+
+## [2.5.0] - 2024-09-24
+
+### Added
+- New UI for the basic mode Sync (#415)
+- Allow changing namespaces and IPM package context from web UI (#280)
+- Support for editing repo from filesystem perspective via web application (#464)
+- Support for downloading a VSCode workspace file from web UI
+- IncrementalLoad pull event handler will update the running production, if any (#473)
+
+### Fixed
+- Instance wide settings are placed in proper global (#444)
+- Avoid delay/errors in loading interop JS when there is a URL prefix (e.g., instance name in multi-instance webserver configuration)
+- Added proper JS escaping in sync output
+- Added support to switch branch in basic mode from menu (#451)
+- Pull event handler will not fail when change set includes unmapped files (#453)
+- Pull event handler will attempt compile even if there are failures to load (#457)
+- Improved logging in preview and when errors occur via WebSocket commands (#467)
+- Fixed pull event handler handling of extremely long class names from diff (#467)
+- Fixed Git web UI prompt to update file list when file selected/unselected (#478)
+- Fixed folder settings in mappings to be saved and persist (#483)
+- Preview on the pull.csp page now shows commits from the correct branch (#490)
+
 ## [2.4.1] - 2024-08-02
 
 ### Added
@@ -158,4 +183,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [2.0.1] - 2022-06-02
 - Last released version before CHANGELOG existed.
-

cls/SourceControl/Git/API.cls

@@ -17,6 +17,13 @@ ClassMethod Configure()
         }
         set gitExists = ##class(SourceControl.Git.Utils).GitBinExists(.version)
         set gitBinPath = ##class(SourceControl.Git.Utils).GitBinPath(.isDefault)
+
+        // Make sure they are using an appropriate git version
+        if (+$PIECE(version,"version ",2))<2.31 {
+            write !!, "WARNING: You are using an older version of git which is not compatible with git-source-control. Please upgrade to git version 2.31.0 or greater to continue"
+            write !!, "Cancelling git-source-control configuration..."
+            quit
+        }
         if gitExists && isDefault {
             // Note: version starts with "git version"
             write !,version," is available via PATH. You may enter a path to a different version if needed."
@@ -65,4 +72,3 @@ ClassMethod BaselineExport(pCommitMessage = "", pPushToRemote = "") As %Status
 }
 
 }
-

cls/SourceControl/Git/Change.cls

@@ -238,4 +238,3 @@ Storage Default
 }
 
 }
-

cls/SourceControl/Git/Extension.cls

@@ -74,9 +74,13 @@ Method AfterUserAction(Type As %Integer, Name As %String, InternalName As %Strin
     if menu '= "%SourceMenu", menu'="%SourceContext" {
         quit $$$OK
     }
-    set InternalName = ##class(SourceControl.Git.Utils).NormalizeInternalName(InternalName)
+    set InternalName = ##class(SourceControl.Git.Utils).NormalizeInternalName(InternalName, .fromWebApp)
     set context = ##class(SourceControl.Git.PackageManagerContext).ForInternalName(InternalName)
     set ec = ##class(SourceControl.Git.Utils).AfterUserAction(Type, Name, InternalName, .Answer, .Msg, .Reload)
+    if fromWebApp {
+        // Force reload and compile of actual item if underlying file has changed
+        do ..OnBeforeLoad(InternalName,1,1)
+    }
     quit ec
 }
 
@@ -125,6 +129,7 @@ Method OnSourceMenuItem(name As %String, ByRef Enabled As %String, ByRef Display
                 "Status": 1,
                 "GitWebUI" : 1,
                 "NewBranch": 1,
+                "SwitchBranch": 1,
                 "Sync": 1,
                 "": 1,
                 :-1
@@ -234,12 +239,12 @@ Method OnMenuItem(MenuName As %String, InternalName As %String, SelectedText As
 
 /// This is called before the actual load of data to give the chance
 /// to load the item from an external format.
-Method OnBeforeLoad(InternalName As %String, verbose As %Boolean) As %Status
+Method OnBeforeLoad(InternalName As %String, verbose As %Boolean, compile As %Boolean = 0) As %Status
 {
     set context = ##class(SourceControl.Git.PackageManagerContext).ForInternalName(InternalName)
     set InternalName = ##class(SourceControl.Git.Utils).NormalizeInternalName(InternalName)
     if ##class(SourceControl.Git.Utils).IsInSourceControl(InternalName) {
-        quit ##class(SourceControl.Git.Utils).ImportItem(InternalName,,0)
+        quit ##class(SourceControl.Git.Utils).ImportItem(InternalName,,0,compile)
     }
     quit $$$OK
 }
@@ -273,14 +278,21 @@ Method OnAfterSave(InternalName As %String, Object As %RegisteredObject = {$$$NU
 {
     set sc = $$$OK
     try {
-        set InternalName = ##class(SourceControl.Git.Utils).NormalizeInternalName(.InternalName)
+        set InternalName = ##class(SourceControl.Git.Utils).NormalizeInternalName(.InternalName,.fromWebApp,.fullExternalName)
         set context = ##class(SourceControl.Git.PackageManagerContext).ForInternalName(InternalName)
         if ##class(SourceControl.Git.Utils).IsNamespaceInGit() && ..IsInSourceControl(InternalName) {
-            set filename = ##class(SourceControl.Git.Utils).FullExternalName(InternalName)
-            $$$ThrowOnError(##class(SourceControl.Git.Utils).RemoveRoutineTSH(InternalName))
-            $$$ThrowOnError(##class(SourceControl.Git.Utils).ExportItem(InternalName))
-            if '##class(SourceControl.Git.Change).IsUncommitted(filename) {
-                $$$ThrowOnError(##class(SourceControl.Git.Change).SetUncommitted(filename, "edit", InternalName, $username, "", 1, "", "", 0))
+            if fromWebApp {
+                if fullExternalName = ##class(SourceControl.Git.Utils).FullExternalName(InternalName) {
+                    // Reimport item into database
+                    $$$ThrowOnError(##class(SourceControl.Git.Utils).ImportItem(InternalName,,1,1))
+                }
+            } else {
+                set filename = ##class(SourceControl.Git.Utils).FullExternalName(InternalName)
+                $$$ThrowOnError(##class(SourceControl.Git.Utils).RemoveRoutineTSH(InternalName))
+                $$$ThrowOnError(##class(SourceControl.Git.Utils).ExportItem(InternalName))
+                if '##class(SourceControl.Git.Change).IsUncommitted(filename) {
+                    $$$ThrowOnError(##class(SourceControl.Git.Change).SetUncommitted(filename, "edit", InternalName, $username, "", 1, "", "", 0))
+                }
             }
         }
     } catch e {
@@ -403,4 +415,3 @@ Method AddToSourceControl(InternalName As %String, Description As %String = "")
 }
 
 }
-

cls/SourceControl/Git/PullEventHandler/IncrementalLoad.cls

@@ -9,33 +9,38 @@ Parameter DESCRIPTION = "Performs an incremental load and compile of all changes
 
 Method OnPull() As %Status
 {
-    set loadSC = $$$OK
+    set sc = $$$OK
     set nFiles = 0
 
     for i=1:1:$get(..ModifiedFiles){
         set internalName = ..ModifiedFiles(i).internalName
         if ((internalName = "") && (..ModifiedFiles(i).changeType '= "D")) {
             write !, ..ModifiedFiles(i).externalName, " was not imported into the database and will not be compiled. "
         } elseif (..ModifiedFiles(i).changeType = "D") {
-            set sc = ..DeleteFile(internalName)
-            if sc {
+            set delSC = ..DeleteFile(internalName)
+            if delSC {
                 write !, ..ModifiedFiles(i).externalName, " was deleted."
             } else {
                 write !, "WARNING: Deletion of ", ..ModifiedFiles(i).externalName, " failed."
             }
         } else {
             set compilelist(internalName) = ""
             set nFiles = nFiles + 1
-            set loadSC = $$$ADDSC(loadSC,##class(SourceControl.Git.Utils).ImportItem(internalName, 1))
-            $$$ThrowOnError(loadSC)
+            set sc = $$$ADDSC(sc,##class(SourceControl.Git.Utils).ImportItem(internalName, 1))
         }
     }
 
     if (nFiles = 0) {
         write !, "Nothing to compile."
         quit $$$OK
     }
-    quit $system.OBJ.CompileList(.compilelist, "ck")
+    set sc = $$$ADDSC(sc,$system.OBJ.CompileList(.compilelist, "ck"))
+    if $$$comClassDefined("Ens.Director") && ##class(Ens.Director).IsProductionRunning() {
+        write !,"Updating production... "
+        set sc = $$$ADDSC(sc,##class(Ens.Director).UpdateProduction())
+        write "done."
+    }
+    quit sc
 }
 
 Method DeleteFile(item As %String) As %Status
@@ -71,4 +76,3 @@ Method DeleteFile(item As %String) As %Status
 }
 
 }
-

cls/SourceControl/Git/Settings.cls

@@ -47,6 +47,9 @@ Property defaultMergeBranch As %String [ InitialExpression = {##class(SourceCont
 /// Compile using the configured pull event handler when "Import All" is run
 Property compileOnImport As %Boolean [ InitialExpression = {##class(SourceControl.Git.Utils).CompileOnImport()} ];
 
+/// Define a namespace-level web application allowing access to multiple git repos across separate namespaces
+Property namespaceLevelGitWebApp As %Boolean [ InitialExpression = {##class(SourceControl.Git.Settings).HasNamespaceWebApp()} ];
+
 Property Mappings [ MultiDimensional ];
 
 Method %OnNew() As %Status
@@ -160,6 +163,75 @@ ClassMethod Configure() As %Boolean [ CodeMode = objectgenerator ]
     do %code.WriteLine(" quit 1")
 }
 
+Method ConfigureNamespaceWebApplication()
+{
+    Set root = ##class(%Library.File).NormalizeDirectory(##class(SourceControl.Git.Utils).TempFolder())
+    Set deleteWebApp = ..HasNamespaceWebApp(.appDirectory) && '..namespaceLevelGitWebApp
+    Set createWebApp = ..namespaceLevelGitWebApp && '..HasNamespaceWebApp()
+    Do ..WebAppOperation("/git/"_$Namespace_"/", createWebApp, deleteWebApp, root)
+}
+
+Method WebAppOperation(name, create As %Boolean, delete As %Boolean, root As %String) [ Private ]
+{
+    Set namespace = $Namespace
+    New $Namespace
+    Set $Namespace = "%SYS"
+    If $Extract(name) = "/" {
+        Set name = $Extract(name,1,*-1)
+    }
+    If delete {
+        If ##class(Security.Applications).Exists(name) {
+            $$$ThrowOnError(##class(Security.Applications).Delete(name))
+            Write !,"Removed web application "_name
+        }
+        Quit
+    }
+
+    // These are the only things we want to coerce.
+    Set props("AutheEnabled")=0 // No auth methods enabled = impossible to use
+    Set props("InbndWebServicesEnabled")=0
+    Set props("ServeFiles")=0
+    Set props("Enabled")=1
+    Set props("Name")=name
+    Set props("NameSpace")=namespace
+    Set props("Path")=root
+    Set props("Type")=2
+    Set props("Recurse")=1
+    If create {
+        Write !,"Creating web application: "_name_"... "
+        $$$ThrowOnError(##class(Security.Applications).Create(name,.props))
+        Write "done."
+    } ElseIf ##class(Security.Applications).Exists(name) {
+        Write !,"Web application '"_name_"' already exists."
+        $$$ThrowOnError(##class(Security.Applications).Get(name,.existingProps))
+        Set changes = 0
+        Set key = ""
+        For {
+            Set key = $Order(props(key),1,value)
+            Quit:key=""
+            If (value '= $Get(existingProps(key))) {
+                Write !,"Changing "_key_": "_$Get(existingProps(key))_" -> "_value
+                Set changes = 1
+            }
+        }
+        If changes {
+            $$$ThrowOnError(##class(Security.Applications).Modify(name,.props))
+            Write !,"Web application '"_name_"' updated."
+        } Else {
+            Write !,"No changes made to web application."
+        }
+    }
+}
+
+ClassMethod HasNamespaceWebApp(Output webAppDirectory) As %Boolean
+{
+    Set webAppDirectory = $System.CSP.GetFileName("/git/"_$Namespace_"/")
+    If (webAppDirectory '= "") {
+        Set webAppDirectory = ##class(%Library.File).NormalizeDirectory(webAppDirectory)
+    }
+    Quit (webAppDirectory '= "")
+}
+
 Method OnAfterConfigure() As %Boolean
 {
     set defaultPromptFlag = $$$DisableBackupCharMask + $$$TrapCtrlCMask + $$$EnableQuitCharMask + $$$DisableHelpCharMask + $$$DisableHelpContextCharMask + $$$TrapErrorMask
@@ -186,6 +258,8 @@ Method OnAfterConfigure() As %Boolean
         }
     }
 
+    do ..ConfigureNamespaceWebApplication()
+
     set gitDir = ##class(%File).NormalizeDirectory(..namespaceTemp)_".git"
     if '##class(%File).DirectoryExists(gitDir) {
         set list(1) = "Initialize empty repo"

cls/SourceControl/Git/StreamServer.cls

@@ -7,7 +7,7 @@ Class SourceControl.Git.StreamServer Extends %CSP.StreamServer
 ClassMethod OnPage() As %Status
 {
     if (%stream '= $$$NULLOREF) && $data(%base)#2 {
-        set sourceControlInclude = ##class(SourceControl.Git.Utils).GetSourceControlInclude()
+        set sourceControlInclude = ##class(SourceControl.Git.Utils).GetSourceControlInclude(%request.URLPrefix)
         while '%stream.AtEnd {
             set text = %stream.Read()
             set text = $replace(text,"{{baseHref}}",..EscapeHTML(%base))
@@ -19,4 +19,3 @@ ClassMethod OnPage() As %Status
 }
 
 }
-