Merge branch 'main' into instance-wide-uncommitted-queue

Author: isc-etamarch

CHANGELOG.md

@@ -5,7 +5,13 @@ 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
+
+### Fixed
+- Changed prompts in configure from 0/1 to no/yes (#461)
+- 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)
@@ -24,6 +30,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - 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
 
@@ -172,4 +181,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - #201: fix behavior with CSP files
 
 ## [2.0.1] - 2022-06-02
-- Last released version before CHANGELOG existed.
+- 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/Settings.cls

@@ -156,7 +156,24 @@ ClassMethod Configure() As %Boolean [ CodeMode = objectgenerator ]
         set prompt = $$$comMemberKeyGet(%class.Name,$$$cCLASSproperty,property,$$$cPROPdescription)
         set promptQuoted = $$$QUOTE(prompt_":")
         set promptQuoted = $replace(promptQuoted,"${username}","'""_$Username_""'")
-        do %code.WriteLine(" set response = ##class(%Library.Prompt).GetString("_promptQuoted_",.value,,,,"_defaultPromptFlag_")")
+        set propertyDef = ##class(%Dictionary.PropertyDefinition).%OpenId("SourceControl.Git.Settings||"_property_"")
+        if ((propertyDef) && (propertyDef.Type = "%Boolean")) {
+            do %code.WriteLine(" set response = ##class(%Library.Prompt).GetYesNo("_promptQuoted_",.value,,"_defaultPromptFlag_")")
+        } elseif ((propertyDef) && (propertyDef.Name = "basicMode")) {
+            set basicModePromptFlag = defaultPromptFlag + $$$MatchExactArrayMask + $$$InitialDisplayMask
+            do %code.WriteLine(" set list(1) = ""Yes""")
+            do %code.WriteLine(" set list(2) = ""No""")
+            do %code.WriteLine(" set list(3) = ""System's Default Mode""")
+            do %code.WriteLine(" if inst.userBasicMode = ""system"" { set value = ""System's Default Mode""}")
+            do %code.WriteLine(" elseif inst.userBasicMode = 1 { set value = ""Yes""}")
+            do %code.WriteLine(" elseif inst.userBasicMode = 0 { set value = ""No""}")
+            do %code.WriteLine(" set response = ##class(%Library.Prompt).GetArray("_promptQuoted_",.value,.list,,,,"_basicModePromptFlag_")")
+            do %code.WriteLine(" if value = ""System's Default Mode"" { set value = ""system""}")
+            do %code.WriteLine(" elseif value = ""Yes"" { set value = 1}")
+            do %code.WriteLine(" elseif value = ""No"" { set value = 0}")
+        } else {
+            do %code.WriteLine(" set response = ##class(%Library.Prompt).GetString("_promptQuoted_",.value,,,,"_defaultPromptFlag_")")
+        }
         do %code.WriteLine(" if response '= $$$SuccessResponse { quit 0 }")
         do %code.WriteLine(" set inst."_property_" = value")
 

cls/SourceControl/Git/Utils.cls

@@ -1149,7 +1149,7 @@ ClassMethod NormalizeInternalName(ByRef name As %String, Output fromWebApp As %B
     if (name [ "/") && (type = "csp") {
         set cspFilename = $System.CSP.GetFileName(name)
         if (cspFilename '= "") && (cspFilename [ ..TempFolder()) {
-            set name = ..NameToInternalName(cspFilename)
+            set name = ..NameToInternalName(cspFilename,,,,0)
             set fromWebApp = 1
         } else {
             kill cspFilename
@@ -2195,7 +2195,7 @@ ClassMethod FileIsMapped(InternalName As %String) As %Boolean
 	NameToInternalName(name): given a Unix-style slash path relative to repo root, 
 	returns the internal name for that file (e.g., cls/SourceControl/Git/Utils.cls -> SourceControl.Git.Utils.CLS)
 */
-ClassMethod NameToInternalName(Name, IgnorePercent = 1, IgnoreNonexistent = 1, Verbose As %Boolean = 0) As %String
+ClassMethod NameToInternalName(Name, IgnorePercent = 1, IgnoreNonexistent = 1, Verbose As %Boolean = 0, normalize As %Boolean = 1) As %String
 {
     set InternalName=""
     set Deleted = 0
@@ -2211,7 +2211,7 @@ ClassMethod NameToInternalName(Name, IgnorePercent = 1, IgnoreNonexistent = 1, V
         set InternalName = ##class(SourceControl.Git.File).ExternalNameToInternalName(Name)
         if (InternalName '= "") && (context.IsInGitEnabledPackage) {
             // Don't need mappings!
-            return ..NormalizeInternalName(InternalName)
+            return $select(normalize:..NormalizeInternalName(InternalName),1:InternalName)
         }
     } else {
         // check for file in uncommitted queue
@@ -2354,7 +2354,7 @@ ClassMethod NameToInternalName(Name, IgnorePercent = 1, IgnoreNonexistent = 1, V
     }
     if ((IgnorePercent)&&($extract(InternalName)="%")) { set InternalName = "" }	// don't return a result for % items if instructed to ignore them
     if ((IgnoreNonexistent)&&('##class(%RoutineMgr).Exists(InternalName))&&('Deleted)) { set InternalName = "" }	// only return item names which exist in the DB
-    quit ..NormalizeInternalName(InternalName)
+    return $select(normalize:..NormalizeInternalName(InternalName),1:InternalName)
 }
 
 ClassMethod OutputConfigureMessage()

cls/SourceControl/Git/WebUIDriver.cls

@@ -20,6 +20,8 @@ ClassMethod HandleRequest(pagePath As %String, InternalName As %String = "", Out
             set responseJSON = ..GetSettingsURL(%request)
         } elseif $extract(pagePath, 6, *) = "get-package-version"{
             set responseJSON = ..GetPackageVersion()
+        } elseif $extract(pagePath, 6, *) = "git-version" {
+            set responseJSON = ..GetGitVersion()
         } else {
             set %response.Status = ##class(%CSP.REST).#HTTP404NOTFOUND
             set responseJSON = {"error":("invalid URI: " _ pagePath)}
@@ -331,4 +333,11 @@ ClassMethod GetPackageVersion() As %Library.DynamicObject
     quit {"version": (version)}
 }
 
+ClassMethod GetGitVersion() As %Library.DynamicObject
+{
+    set gitExists = ##class(SourceControl.Git.Utils).GitBinExists(.version)
+    set version = +$PIECE(version,"version ",2)
+    quit {"version": (version)}
+}
+
 }

cls/_zpkg/isc/sc/git/Socket.cls

@@ -16,7 +16,7 @@ ClassMethod Run()
 		Write !,"Current branch: ",branchName
 		Do ##class(SourceControl.Git.Utils).RunGitWithArgs(.errStream, .outStream, "fetch")
 		Kill errStream, outStream
-		Do ##class(SourceControl.Git.Utils).RunGitWithArgs(.errStream, .outStream, "log", "HEAD..origin", "--name-status")
+		Do ##class(SourceControl.Git.Utils).RunGitWithArgs(.errStream, .outStream, "log", "HEAD..origin/"_branchName, "--name-status")
 		Do ##class(SourceControl.Git.Utils).PrintStreams(errStream, outStream)
 		If (outStream.Size = 0) && (errStream.Size = 0) {
 			Write !,"Already up to date."

csp/gitprojectsettings.csp

@@ -665,6 +665,13 @@ function toggleNoFolders(e){
 
 $('[id^=noFoldersSwitch]').click(toggleNoFolders);
 
+// Check to persist state of no folder switches  
+$('.mapping-input-group').children('.voca').each(function(){
+    var currElement = $(this).children().children(".custom-control").children()[0]
+    if(!$(currElement).hasClass("active")) {
+        $(currElement).parent().siblings("#NoFolders")[0].value = "NoFolders";
+    }
+});
 </script>
 </body>
 </html>

docs/testing.md

@@ -0,0 +1,21 @@
+# git-source-control Testing Plan
+
+The following is a testing plan that should be followed prior to release of a new version.
+
+- Using a IRIS user with %All permissions, run `##class(SourceControl.Git.API).Configure()` in a terminal on a fresh namespace. Terminal prompts should describe each setting. Create an SSH key and use it to clone a remote repository.
+- The following steps should be run with an IRIS user with %Developer role (not %All).
+- Use VS Code to create a new class. Use the Source Control menu to Import All from the repository. Check the output to confirm that the contents of the repository were imported and compiled.
+- Test changing Git project settings in a web browser and in Studio. Input labels and tooltips should describe each setting.
+- In Expert Mode, test:
+  - Add a new item through Studio / VS Code. Use the Add option in the Source Control Menu. The item should show up in the Workspace view of the WebUI.
+  - Stash the item in the WebUI. It should be deleted from IRIS. Pop it from the stash. It should be imported and compiled. Discard the item in the WebUI. It should be deleted from IRIS.
+  - Add, delete, and modify some items in Studio / VS Code. Commit through the WebUI with a commit message and details. The commit should show with the expected commit message and differences in the branch view.
+  - Select the branch in the branch view and click "Push Branch". It should successfully push changes to the remote repository.
+  - Create a new local branch. Add a new item and commit it. Switch between the new branch and the old branch. The item should be added and deleted from IRIS. Test merging the new branch to the old branch in the web UI. The item should be added to IRIS.
+  - Edit a file on the remote repository. Use the "Git Pull" link from the System Management Portal favorites to pull. The preview should show the change without actually pulling it or loading it into IRIS. Confirming should do the pull and load the change into IRIS.
+  - Edit an item through Studio / VS Code. Log in with a different IRIS user and attempt to edit the same item. The edit should be prohibited. Open the WebUI. The workspace view should list that item and indicate that it is checked out by another user. Stash the item, then try to edit it again. This time the edit should succeed.
+- In Basic Mode, test:
+  - Add, edit, and delete items through Studio / VS Code. Use the Sync option. All changes should be committed and pushed to the remote.
+  - Add, edit, and delete items on the remote. Add, edit, and delete unrelated items through Studio/VSCode. All changes should be pulled, committed, and pushed.
+  - Add an item to an interoperability production and sync. Check out a new feature branch. The item should no longer exist in the production. Set the previous branch as the remote merge branch. Sync. The new item should exist in the production.
+  - Add an item to a production and sync. Check out a new feature branch. The item should no longer exist in the production. Set the previous branch as the remote merge branch. Add a new item to the production. Sync. The production should now have both new items, and the source control output should show it automatically resolved a conflict.

git-webui/release/share/git-webui/webui/js/git-webui.js

@@ -110,6 +110,15 @@ webui.showWarning = function(message) {
         '</div>').appendTo(messageBox);
 }
 
+webui.gitVersion = function() {
+    $.get("api/git-version", function(version) {
+        var ver = JSON.parse(version)["version"];
+        if (ver < 2.31) {
+            alert("Your git version is incompatible with git-source-control. Please upgrade to git 2.31.0 or greater.")
+        }
+    })
+}
+
 webui.git_command = function(command, callback) {
     $.ajax({
         url: "git-command",
@@ -313,6 +322,7 @@ webui.getNodeIndex = function(element) {
 
 webui.TabBox = function(buttons) {
 
+
     var self = this;
 
     self.itemClicked = function(event) {
@@ -2641,7 +2651,7 @@ webui.NewChangedFilesView = function(workspaceView) {
             }
 
             if ($(element).hasClass("other-user") && (selectedItemsFromOtherUser.indexOf(fileName) > -1)) {
-                selectedItemsFromOtherUser.splice(selectedItems.indexOf(fileName), 1);
+                selectedItemsFromOtherUser.splice(selectedItemsFromOtherUser.indexOf(fileName), 1);
             }
         }
         self.updateButtons();
@@ -2808,6 +2818,7 @@ webui.NewChangedFilesView = function(workspaceView) {
 function MainUi() {
 
     var self = this;
+    webui.gitVersion();
 
     self.switchTo = function(element) {
         webui.detachChildren(self.mainView);

git-webui/src/share/git-webui/webui/js/git-webui.js

@@ -110,6 +110,15 @@ webui.showWarning = function(message) {
         '</div>').appendTo(messageBox);
 }
 
+webui.gitVersion = function() {
+    $.get("api/git-version", function(version) {
+        var ver = JSON.parse(version)["version"];
+        if (ver < 2.31) {
+            alert("Your git version is incompatible with git-source-control. Please upgrade to git 2.31.0 or greater.")
+        }
+    })
+}
+
 webui.git_command = function(command, callback) {
     $.ajax({
         url: "git-command",
@@ -313,6 +322,7 @@ webui.getNodeIndex = function(element) {
 
 webui.TabBox = function(buttons) {
 
+
     var self = this;
 
     self.itemClicked = function(event) {
@@ -2641,7 +2651,7 @@ webui.NewChangedFilesView = function(workspaceView) {
             }
 
             if ($(element).hasClass("other-user") && (selectedItemsFromOtherUser.indexOf(fileName) > -1)) {
-                selectedItemsFromOtherUser.splice(selectedItems.indexOf(fileName), 1);
+                selectedItemsFromOtherUser.splice(selectedItemsFromOtherUser.indexOf(fileName), 1);
             }
         }
         self.updateButtons();
@@ -2808,6 +2818,7 @@ webui.NewChangedFilesView = function(workspaceView) {
 function MainUi() {
 
     var self = this;
+    webui.gitVersion();
 
     self.switchTo = function(element) {
         webui.detachChildren(self.mainView);

module.xml

@@ -3,7 +3,7 @@
   <Document name="git-source-control.ZPM">
     <Module>
       <Name>git-source-control</Name>
-      <Version>2.4.1</Version>
+      <Version>2.5.1</Version>
       <Description>Server-side source control extension for use of Git on InterSystems platforms</Description>
       <Keywords>git source control studio vscode</Keywords>
       <Packaging>module</Packaging>