Merge branch 'main' into sync-iris-codebase-change

Author: isc-tleavitt

CHANGELOG.md

@@ -17,10 +17,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Now skips files belonging to other git enabled packages in `##class(SourceControl.Git.Change).RefreshUncommitted()` (#347)
 - Added a new "Branch" parameter to `##class(SourceControl.Git.PullEventHandler)` (#351)
 - Command-line utility to do a baseline export of items in a namespace
+- 'New Branch' menu option in basic now will create new branches from the configured default merge branch (#366)
+- Merging back with the default merge branch is now a part of the basic mode's Sync flow (#366)
 
 ### Fixed
-- Modifications to local repo files are now synced with IRIS
-
+- Modifications to local repo files are now synced with IRIS (#153)
+- Menu items names are properly translated from internal name in VSCode, Management Portal (#372)
 
 ## [2.3.1] - 2024-04-30
 

README.md

@@ -86,7 +86,9 @@ It is important for the namespace temp folder to be owned by the user IRIS runs
 If you want to interact with remotes from VSCode/Studio directly (e.g., to push/pull), you must use ssh (rather than https), create a public/private key pair to identify the instance (not yourself), configure the private key file for use in Settings, and configure the public key as a deploy key in the remote(s).
 
 #### IRIS Privileges
-For developers to be able to run this extension, they'll need the USE privilege on %System_Callout.
+For developers to be able to run this extension, they'll need the following privileges:
+- the USE privilege on %System_Callout
+- SQL SELECT privileges on %Studio_SourceControl.Change and SourceControl_Git.Change
 
 ### Setting up multiple GitHub deploy keys on one machine
 

cls/SourceControl/Git/Extension.cls

@@ -106,7 +106,6 @@ Method LocalizeName(name As %String) As %String
 
 Method OnSourceMenuItem(name As %String, ByRef Enabled As %String, ByRef DisplayName As %String, InternalName As %String) As %Status
 {
-    
     if name = "Settings" {
         set Enabled = 1
         quit $$$OK
@@ -125,6 +124,7 @@ Method OnSourceMenuItem(name As %String, ByRef Enabled As %String, ByRef Display
             set Enabled = $CASE(name,
                 "Status": 1,
                 "GitWebUI" : 1,
+                "NewBranch": 1,
                 "Sync": 1,
                 "": 1,
                 :-1
@@ -159,6 +159,9 @@ Method OnSourceMenuItem(name As %String, ByRef Enabled As %String, ByRef Display
     } else {
         set Enabled = -1
     }
+    if (name '= "") {
+	    set DisplayName = ..LocalizeName(name)
+    }
     quit $$$OK
 }
 
@@ -187,6 +190,9 @@ Method OnSourceMenuContextItem(itemName As %String, menuItemName As %String, ByR
     } else {
         set Enabled = $case(menuItemName, "AddToSC":1,:-1)
     }
+    if (menuItemName '= "") {
+	    set DisplayName = ..LocalizeName(menuItemName)
+    }
     quit $$$OK
 }
 

cls/SourceControl/Git/Settings.cls

@@ -41,6 +41,9 @@ Property userBasicMode As %String [ InitialExpression = {##class(SourceControl.G
 /// The system's default mode. If true, the system defaults to basic mode
 Property systemBasicMode As %Boolean [ InitialExpression = {##class(SourceControl.Git.Utils).SystemBasicMode()} ];
 
+/// In Basic mode, Sync will merge changes from this remote branch
+Property defaultMergeBranch As %String [ InitialExpression = {##class(SourceControl.Git.Utils).DefaultMergeBranch()} ];
+
 Property Mappings [ MultiDimensional ];
 
 Method %OnNew() As %Status
@@ -93,6 +96,7 @@ Method %Save() As %Status
     set @storage@("settings","percentClassReplace") = ..percentClassReplace
     set @storage@("settings","settingsUIReadOnly") = ..settingsUIReadOnly
     set @storage@("settings", "mappedItemsReadOnly") = ..mappedItemsReadOnly
+    set @storage@("settings", "defaultMergeBranch") = ..defaultMergeBranch
     set @storage@("settings", "basicMode") = ..systemBasicMode
     if ..basicMode = "system" {
         kill @storage@("settings", "user", $username, "basicMode")

cls/SourceControl/Git/Utils.cls

@@ -128,6 +128,11 @@ ClassMethod SystemBasicMode() As %Boolean
     quit $get(@..#Storage@("settings", "basicMode"), 0)
 }
 
+ClassMethod DefaultMergeBranch() As %String
+{
+    quit $get(@..#Storage@("settings", "defaultMergeBranch"), "")
+}
+
 ClassMethod MappedItemsReadOnly() As %Boolean
 {
     quit $get(@..#Storage@("settings", "mappedItemsReadOnly"), 1)
@@ -335,6 +340,16 @@ ClassMethod Commit(InternalName As %String, Message As %String = "example commit
 
 ClassMethod NewBranch(newBranchName As %String) As %Status
 {
+    set settings = ##class(SourceControl.Git.Settings).%New()
+    if (settings.basicMode) && (settings.defaultMergeBranch '= ""){
+        do ..RunGitWithArgs(.errStream, .outStream, "checkout", settings.defaultMergeBranch)
+        do ..PrintStreams(errStream, outStream)
+        kill errStream, outStream
+        do ..RunGitWithArgs(.errStream, .outStream, "pull")
+        do ..PrintStreams(errStream, outStream)
+        kill errStream, outStream
+    }
+    
     do ..RunGitWithArgs(.errStream, .outStream, "checkout", "-b", newBranchName)
     do ..PrintStreams(errStream, outStream)
     quit $$$OK
@@ -379,6 +394,17 @@ ClassMethod StageAddedFiles()
     }
 }
 
+/// Merges the files from the configured branch as part of the Sync operation
+ClassMethod MergeDefaultRemoteBranch()
+{
+    set settings = ##class(SourceControl.Git.Settings).%New()
+    set defaultMergeBranch = settings.defaultMergeBranch
+    if defaultMergeBranch '= "" {
+        do ..RunGitWithArgs(.errStream, .outStream, "rebase", defaultMergeBranch)
+        do ..PrintStreams(errStream, outStream)
+    }
+}
+
 /// Converts the DynamicArray into a list and calls the SourceControl.Git.Change RemoveUncommitted method on the newly created list
 ClassMethod ClearUncommitted(filesWithActions) As %Status
 {
@@ -405,6 +431,9 @@ ClassMethod Sync(Msg As %String) As %Status
         do ..Pull()
         do ..SyncCommit(Msg)
         do ..Push()
+        do ..MergeDefaultRemoteBranch()
+        do ..Push()
+        
     }
 
     quit $$$OK

csp/gitprojectsettings.csp

@@ -80,7 +80,7 @@ body {
         set $Property(settings,param) = $Get(%request.Data(param,1))
     }
     if ('settings.settingsUIReadOnly) {
-        for param="gitBinPath","namespaceTemp","privateKeyFile","pullEventClass","percentClassReplace" {
+        for param="gitBinPath","namespaceTemp","privateKeyFile","pullEventClass","percentClassReplace", "defaultMergeBranch" {
             set $Property(settings,param) = $Get(%request.Data(param,1))
         }
 
@@ -308,6 +308,13 @@ body {
 
 
         </div>
+
+        <div class="form-group row mb-3">
+            <label for="defaultMergeBranch" class="offset-sm-1 col-sm-3 col-form-label" data-toggle="tooltip" data-placement="top" title="In basic mode, the Sync operation will merge changes from this remote branch (leave blank for no branch)">Default merge branch</label>
+            <div class="col-sm-7">
+                <input type="text" class="form-control" id="defaultMergeBranch" name="defaultMergeBranch" value='#(..EscapeHTML(settings.defaultMergeBranch))#' placeholder="sample-remote-branch">
+            </div>
+        </div>
 
         <div class="form-group row mb-3">
             <label for="mappedItemsReadOnly" class="offset-sm-1 col-sm-3 col-form-label" data-toggle="tooltip" data-placement="top" title="Whether items mapped from a database other than this namespace's default routine database should be read-only. If enabled, mapped items won't be saved to source control or exported. NOTE: These are different from the mappings configured in this settings page"> Treat Mapped Items as Read-only</label>