Merge branch 'main' into production-change-control

Author: isc-pbarton

CHANGELOG.md

@@ -10,12 +10,45 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Added 'git push --force' in expert mode (#527)
 - Add remote repository to settings page (#448)
+- Added change context option to pull page (#468)
+- Added favorite namespaces setting for a user (#468, #510) 
 - Added environment awareness in configuration, and showing of environment name in UI (#124)
+- Warning on sync page if other users have unstaged changes (#493)
+- Added "Export System Default Settings" menu item (#544)
+- IRIS Business Intelligence items are mapped to the /dfi subdirectory by default (#428)
+- Intelligent merge conflict auto-resolution works for the common Business Rule case as well (#391)
+- All git commands run on the server, their output, and any associated sync output, are logged to a table for diagnostic purposes (#454)
+- Added API method to automatically add proper %ALL mappings for git-source-control (#214)
 - Production Decomposition mode allows controlling interoperability productions as individual files for each host (#469)
 
 ### Fixed
 - Fixed display of other users' username in workspace view on Unix (#530)
+- Fix left-sidebar spacing (#525)
 - Fixed slowness loading some CSP pages with multiple instances sharing a webserver (#540)
+- Prevent direct commits to default merge branch in basic mode (#484)
+- Fixed GetContexts utils function to exclude implied namespaces from the list of namespaces (#468)
+- Fixed git path configuration (#463)
+- Added feedback to settings page (#550)
+- Fix "Home" navigation to point to current namespace (#548)
+- Fixed issues when user checks out nonexistent branch (#549)
+- Fixed checking out branch with uncommitted work (#539)
+- Make sure more fetch calls prune the remote branches (#471)
+- Force export of item if it has been modified (#354)
+- Production configuration page no longer closes Sync/WebUI when operations there change the production (#542)
+- Remove leading/trailing spaces from input to Configure() (#356)
+- Fix branches with special characters not showing in GitUI (#523)
+- Fix filenames with spaces not showing correctly in workspace view (#551)
+- Removed inaccurate placeholder text for commit message in UI (#406)
+- Fixed regression that broke production conflict auto-resolve (#526)
+- Initialize repo in settings page now uses entered repo (#486)
+- Report error more clearly if you try to create a branch with an invalid name (#534)
+- Don't default to WINDOWS style paths (#357)
+- Fix errors when deleting non-existent files on import (#524)
+- Fix errors on commit when a file was added, never committed, then deleted from the repository (#481)
+- Fixed issue with saving multiple new no-folder mapping settings at the same time (#533)
+- Fixed sending OS error when git pull encounters error (#545)
+- Fixed suppressing editing of locked classes (#301)
+- Fixed importing CSP files (#251)
 
 ## [2.6.0] - 2024-10-07
 

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# How to contribute
+
+Thank you for your interest in contributing! While this project originated at InterSystems, it is our hope that the community will continue to extend and enhance it.
+
+## Submitting changes
+
+If you have made a change that you would like to contribute back to the community, please send a [GitHub Pull Request](/pull/new/main) explaining it. If your change fixes an issue that you or another user reported, please mention it in the pull request. You can find out more about pull requests [here](http://help.github.com/pull-requests/).
+
+Every pull request should include at least one entry in CHANGELOG.md - see [keepachangelog.com](https://keepachangelog.com/) for guidelines.
+
+We encourage use of [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+
+## Coding conventions
+
+Generally speaking, just try to match the conventions you see in the code you are reading. For this project, these include:
+
+* Do not use shortened command and function names - e.g., `s` instead of `set`, `$p` instead of `$piece`
+* One command per line
+* Do not use dot syntax
+* Indentation with tabs
+* Pascal case class and method names
+* Avoid using postconditionals
+* Local variables start with `t`; formal parameter names start with `p`
+* Always check %Status return values
+
+When making changes that involve JavaScript, ensure that your changes still work from Studio (which uses an old version of IE under the hood and therefore doesn't support various things you might take for granted).
+
+Thank you!

README.md

@@ -1,5 +1,5 @@
 # git-source-control
- Server-side source control extension for Git on InterSystems' platforms
+Embedded Git support for InterSystems platforms, supporting unified source control for changes made via IDEs (e.g., VSCode over isfs) and the Management Portal (Interoperability and Business Intelligence).
 
 ## Prerequisites/Dependencies
 
@@ -32,23 +32,43 @@
     }
     ```
 
+### Making available instance-wide via %ALL namespace
+
+To make git-source-control available to all namespaces on an instance without manually installing it in each, you can run:
+
+`do ##class(SourceControl.Git.API).MapEverywhere()`
+
+This will create the appropriate mappings to have all namespaces on the system use the version in the current namespace. Note, namespaces still must be configured independently. To undo this, you can delete the mappings from the %ALL namespace.
+
 ## Basic Use
 
+The point of Embedded Git is to intercept events made through all editors - both IDEs and the management portal - so that changes are reflected in the filesystem, in a git repo, and able to be shared with others. There are also source-control specific menus to help you do key tasks.
+
 ### Source Control
 
 For those with less experience using source control, we recommend this [page](/docs/scintro.md) for a quick introduction to source control / change control basics.
 
 ### Health Connect Cloud
-git-source control is the recommended source control for Health Connect Cloud. [This page](/docs/hcc.md) covers HCC specific usage of git-source-control, including the recommended development workflow, initial setup, and CICD pipelining.
+
+git-source control is the recommended source control for Health Connect Cloud. [This page](/docs/hcc.md) covers HCC specific usage of git-source-control, including the recommended development workflow, initial setup, and CI/CD pipelining.
+
+### VSCode
+
+Source control menus will appear under "Server Source Control..." when right-clicking in a file (in the editor) or on a file when exploring an isfs folder. The top level "source control" menu is accessible through the command palette or the source control icon in the top right of the editor.
+
+For full details on all of the menu items, see [this reference page](/docs/menu-items.md).
+
+### Management Portal Editors
+
+In relevant editors in the management portal, there are two icons that allow access to the same source control functionality as in IDEs. Click the source control icon to see the menu, and the clipboard to see output from previously run commands in your browser session.
+
+*Important*: if using source control for interoperability, check the "Permit Enabling Automatic Refresh of Management Portal Pages" box in the management portal, at the page: Interoperability > Manage > Configuration > Interoperability Settings. This mitigates a potential for lost work.
 
 ### Studio
-Add a file for tracking by right-clicking on it in the workspace/project view and choosing Git > Add.
-This same menu also has options to remove (stop tracking the file), discard changes (revert to the index), or commit changes.
 
-You can browse file history and commit changes through a user interface launched from the top level Git > "Launch Git UI" menu item. There is also a page for configuring settings.
+Note: Studio has been deprecated. VSCode is the IDE recommended by InterSystems.
 
-### VSCode
-The same right click menus as in Studio live under "Server Source Control..." when right-clicking in a file (in the editor) or on a file when exploring an isfs folder. The top level "source control" menu is accessible through the command palette or the source control icon in the top right of the editor.
+That said, the same menu items and editor behavior will also work in Studio. There is a top-level "Git" menu with access to various operations and pages dependent on the current editor context.
 
 ## Notes
 
@@ -67,10 +87,22 @@ This might look like:
 
 ### Pull Event Handlers
 
-The ##class(SourceControl.Git.PullEventHandler) is a base class that can be extended in order to develop functionality that should be run when the repository pulls from remote. The code placed inside the subclass' OnPull() method will be executed any time a pull occurs.
+The class `SourceControl.Git.PullEventHandler` is a base class that can be extended in order to develop functionality that should be run when the repository pulls from remote. The code placed inside the subclass' OnPull() method will be executed any time a pull occurs.
 
 A recommended way to implement CI/CD would be to use one of the pre-defined subclasses of PullEventHandler that are placed inside the PullEventHandler package. Additionally, custom load logic can be placed in that package following the model of the existing subclasses.
 
+### Use in Deployment
+
+To manually pull the latest code from the current configured branch into an IRIS instance, use the "Git Pull" favorite link that is added to the management portal automatically on installation or via the Settings page "Favorite Namespaces" option.
+
+To use git-source-control as part of automated deployment to a test/production environment with a running IRIS instance, the best approach is to call into the appropriate IRIS namespace to run:
+
+`do ##class(SourceControl.Git.API).Pull(1)`
+
+This is convenient for scripting because it will terminate with an OS-level error if anything goes wrong. Further automation and customization can live in your pull event handler, described above.
+
+[This Developer Community answer](https://community.intersystems.com/post/cache-unit-test-jenkins#comment-115146) has some helpful guidance on how to call in to IRIS from the OS level for CI/CD; there are other helpful resources on the Developer Community as well.
+
 ### Security
 
 #### Unsecured (http) connections
@@ -113,8 +145,14 @@ Assuming you have the local and remote repositories created,
    `git config core.sshCommand 'ssh -i ~/.ssh/<private key name>'`
 8. Test the refresh button for the remote branches on the WebUI, fetch from the source control menu in Studio or VS Code, and `git fetch` in Git Bash. All 3 should work without any issues.
 
+## Support
+
+If you find a bug or would like to request an enhancement, [report an issue](https://github.com/intersystems/git-source-control/issues/new). If you have a question, post it on the [InterSystems Developer Community](https://community.intersystems.com/) - consider using the "Git" and "Source Control" tags as appropriate.
+
+## Contributing
 
+Please read [contributing](CONTRIBUTING.md) for details on the process for submitting pull requests to us.
 
-## During Development
+### During Development
 
 :warning: Whenever any code in this project is updated outside the server (e.g. after every `git pull`), you _have_ to run `zpm "load <absolute path to git-source-control>"`. Otherwise, the changes won't be reflected on the server. However, if you load git-source-control via the InterSystems package manager and run `git pull` via the extension itself with the default pull event handler configured, it'll just work.

cls/SourceControl/Git/API.cls

@@ -44,9 +44,14 @@ ClassMethod Configure()
 }
 
 /// API for git pull - just wraps Utils
-ClassMethod Pull()
+/// - pTerminateOnError: if set to 1, this will terminate on error if there are any errors in the pull, otherwise will return status
+ClassMethod Pull(pTerminateOnError As %Boolean = 0)
 {
-    quit ##class(SourceControl.Git.Utils).Pull()
+    set st = ##class(SourceControl.Git.Utils).Pull(,pTerminateOnError)
+    if pTerminateOnError && $$$ISERR(st) {
+        Do $System.Process.Terminate($Job,1)
+    }
+    quit st
 }
 
 /// Locks the environment to prevent changes to code other than through git pull.
@@ -71,6 +76,11 @@ ClassMethod BaselineExport(pCommitMessage = "", pPushToRemote = "") As %Status
     quit ##class(SourceControl.Git.Utils).BaselineExport(pCommitMessage, pPushToRemote)
 }
 
+ClassMethod MapEverywhere()
+{
+    Quit ##class(SourceControl.Git.Installer).MapEverywhere()
+}
+
 /// Run to baseline all interoperability productions in the namespace to source control.
 /// This should be done after changing the value of the "decompose productions" setting.
 ClassMethod BaselineProductions()

cls/SourceControl/Git/Change.cls

@@ -177,6 +177,20 @@ ClassMethod RefreshUncommitted(Display = 0, IncludeRevert = 0, Output gitFiles,
             if $$$ISERR(sc) continue
         }
     }
+
+    // If a file was added to the index and then deleted, git status will show it as a delete but committing will fail.
+    // The solution is to git add each deleted file that has never been committed so it will be removed from the index.
+    set key = $order(gitFiles(""))
+    while (key '= "") {
+        if $listget(gitFiles(key),1) = "D" {
+            set filename = $listget(gitFiles(key),2)
+            do ##class(SourceControl.Git.Utils).RunGitCommandWithInput("log",,.errStream,.outStream,"--first-parent", "--", filename)
+            if (outStream.Size = 0) {
+                do ##class(SourceControl.Git.Utils).RunGitCommandWithInput("add",,errStream,outStream,filename)
+            }
+        }
+        set key = $order(gitFiles(key))
+    }
     set ^IRIS.Temp.gitsourcecontrol("Refresh") = $zdatetime($ztimestamp,-2)
     merge ^IRIS.Temp.gitsourcecontrol("LastUncommitted") = gitFiles
     quit sc

cls/SourceControl/Git/Extension.cls

@@ -29,6 +29,7 @@ XData Menu
 <MenuItem Name="NewBranch" />
 <MenuItem Name="SwitchBranch" />
 <MenuItem Separator="true"/>
+<MenuItem Name="ExportSystemDefaults" />
 <MenuItem Name="Export" />
 <MenuItem Name="ExportForce" />
 <MenuItem Name="Import" />
@@ -58,13 +59,18 @@ Method UserAction(Type As %Integer, Name As %String, InternalName As %String, Se
             // if item is being edited in a different namespace, opening it will display an alert. Editing in this namespace will remove the alert.
             set filename = ##class(SourceControl.Git.Utils).FullExternalName(.InternalName)
             do ##class(SourceControl.Git.Change).GetUncommitted(filename,.tAction)
+            do ..GetStatus(.InternalName, .isInSourceControl, .isEditable,.isCheckedOut,.userCheckedOut)
             if '$data(tAction) {
                 set user = "", inNamespace = ""
-                if ##class(SourceControl.Git.Utils).InstanceWideUncommittedCheck(InternalName, .user, .inNamespace) {
+                if 'isEditable || ##class(SourceControl.Git.Utils).Locked() {
+                    set Target = "Warning: Attempting to edit read-only file"
+                    write !, Target
+                    set Action = 6
+                } elseif ##class(SourceControl.Git.Utils).InstanceWideUncommittedCheck(InternalName, .user, .inNamespace) {
                     set Target = "Warning: Item " _ InternalName _ " is currently being modified by " _ user _ " in namespace " _ inNamespace _ "."
                     write !, Target
                     set Action = 6
-                }
+                } 
             }
         }
     }
@@ -81,6 +87,15 @@ Method UserAction(Type As %Integer, Name As %String, InternalName As %String, Se
         quit $$$OK
     }
 
+    if (menuItemName = "Commit") {
+        set defaultBasic = ##class(SourceControl.Git.Utils).InDefaultBranchBasicMode()
+        if (defaultBasic) {
+            Set Target = "WARNING: Please create a new branch before committing."
+            set Action = 6
+            quit $$$OK
+        }
+    }
+
     if (menuItemName = "Commit") || (menuItemName = "Sync") {
         if ..CheckCommitterIdentity(settings, .Action, .Target) {
             quit $$$OK
@@ -116,6 +131,7 @@ Method LocalizeName(name As %String) As %String
         "Settings":$$$Text("@Settings@Settings"),
         "Init":$$$Text("@Init@Initialize"),
         "GitWebUI":$$$Text("@GitWebUI@Launch Git UI"),
+        "ExportSystemDefaults":$$$Text("@ExportSystemDefaults@Export System Default Settings"),
         "Export":$$$Text("@Export@Export All"),
         "ExportForce":$$$Text("@ExportForce@Export All (Force)"),
         "Import":$$$Text("@Import@Import All"),
@@ -151,6 +167,11 @@ Method OnSourceMenuItem(name As %String, ByRef Enabled As %String, ByRef Display
             quit ..OnSourceMenuContextItem(InternalName,name,.Enabled,.DisplayName)
         }
 
+        if name = "ExportSystemDefaults" {
+            set Enabled = ##class(%Library.EnsembleMgr).IsEnsembleNamespace()
+            quit $$$OK
+        }
+
         if ##class(SourceControl.Git.Utils).BasicMode() {
             set Enabled = $CASE(name,
                 "Status": 1,
@@ -162,7 +183,6 @@ Method OnSourceMenuItem(name As %String, ByRef Enabled As %String, ByRef Display
                 "Sync": 1,
                 "": 1,
                 :-1
-            
             )
         } else {
             set Enabled = $CASE(name, 
@@ -340,7 +360,8 @@ Method OnAfterSave(InternalName As %String, Object As %RegisteredObject = {$$$NU
                 } else {
                     set filename = ##class(SourceControl.Git.Utils).FullExternalName(InternalName)
                     $$$ThrowOnError(##class(SourceControl.Git.Utils).RemoveRoutineTSH(InternalName))
-                    $$$ThrowOnError(##class(SourceControl.Git.Utils).ExportItem(InternalName))
+                    set forceExport = (InternalName'= "") && ($data(..Modified(InternalName)))
+                    $$$ThrowOnError(##class(SourceControl.Git.Utils).ExportItem(InternalName,,forceExport))
                     if '##class(SourceControl.Git.Change).IsUncommitted(filename) {
                         $$$ThrowOnError(##class(SourceControl.Git.Change).SetUncommitted(filename, "edit", InternalName, $username, "", 1, "", "", 0))
                     }

cls/SourceControl/Git/Installer.cls

@@ -0,0 +1,57 @@
+/// Mostly used from SourceControl.Git.API:MapEverywhere
+Class SourceControl.Git.Installer
+{
+
+ClassMethod MapEverywhere()
+{
+    set sc = $$$OK
+    try {
+        set ns = $namespace
+        set locDBDir = ##class(%SYS.Namespace).GetGlobalDest(ns,$Name(^IRIS.Msg("Studio")))
+        set vars("LocalizationDB") = ..DatabaseDirToName(locDBDir)
+        set codeDBDir = ##class(%SYS.Namespace).GetPackageDest(ns,"SourceControl.Git")
+        set vars("RoutineDB") = ..DatabaseDirToName(codeDBDir)
+        $$$ThrowOnError(..RunMapEverywhere(.vars))
+    } catch e {
+        set sc = e.AsStatus()
+        if '$quit {
+            write !,$System.Status.GetErrorText(sc)
+        }
+    }
+    quit sc
+}
+
+ClassMethod DatabaseDirToName(dbDir As %String) As %String [ Private ]
+{
+    New $Namespace
+    Set $Namespace = "%SYS"
+    Set tSC = ##class(Config.Databases).DatabasesByDirectory($Piece(dbDir,"^"),$Piece(dbDir,"^",2),.tDBList)
+    $$$ThrowOnError(tSC)
+    If ($ListLength(tDBList) '= 1) {
+        // This is highly unexpected, but worth checking for anyway.
+        $$$ThrowStatus($$$ERROR($$$GeneralError,$$$FormatText("Could not find database name for '%1'",tDBDir)))
+    }
+    $$$ThrowOnError(tSC)
+    Quit $ListGet(tDBList)
+}
+
+/// This is a method generator whose code is generated by XGL.
+ClassMethod RunMapEverywhere(ByRef pVars, pLogLevel As %Integer = 3, pInstaller As %Installer.Installer, pLogger As %Installer.AbstractLogger) As %Status [ CodeMode = objectgenerator, Internal, Private ]
+{
+	quit ##class(%Installer.Manifest).%Generate(%compiledclass, %code, "MapEverywhere")
+}
+
+XData MapEverywhere [ XMLNamespace = INSTALLER ]
+{
+<Manifest>
+<Namespace Name="%ALL" Create="yes" Ensemble="no" Code="%DEFAULTDB" Data="%DEFAULTDB">
+<Configuration>
+<GlobalMapping Global="IRIS.Msg" From="%DEFAULTDB" />
+<GlobalMapping Global="IRIS.Msg(&quot;Studio&quot;)" From="${LocalizationDB}" />
+<ClassMapping Package="SourceControl.Git" From="${RoutineDB}" />
+</Configuration>
+</Namespace>
+</Manifest>
+}
+
+}