Merge branch 'main' into production-change-control

Author: isc-pbarton

CHANGELOG.md

@@ -9,9 +9,12 @@ 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 environment awareness in configuration, and showing of environment name in UI (#124)
 
 ### Fixed
 - Fixed display of other users' username in workspace view on Unix (#530)
+- Fixed slowness loading some CSP pages with multiple instances sharing a webserver (#540)
 
 ## [2.6.0] - 2024-10-07
 

README.md

@@ -34,6 +34,13 @@
 
 ## Basic Use
 
+### 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.
+
 ### 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.

cls/SourceControl/Git/Settings.cls

@@ -59,6 +59,9 @@ Property namespaceLevelGitWebApp As %Boolean [ InitialExpression = {##class(Sour
 /// Warn when an item has uncommitted changes in a different namespace in this instance
 Property warnInstanceWideUncommitted As %Boolean [ InitialExpression = {##class(SourceControl.Git.Utils).WarnInstanceWideUncommitted()} ];
 
+/// The name of the environment (DEVELOPMENT, TEST, LIVE)
+Property environmentName As %String(MAXLEN = "") [ InitialExpression = {##class(SourceControl.Git.Utils).EnvironmentName()} ];
+
 Property Mappings [ MultiDimensional ];
 
 Method %OnNew() As %Status
@@ -146,11 +149,19 @@ Method %Save() As %Status
     set @storage@("settings", "compileOnImport") = ..compileOnImport
     set @storage@("settings", "warnInstanceWideUncommitted") = ..warnInstanceWideUncommitted
     set @storage@("settings", "basicMode") = ..systemBasicMode
+    set @storage@("settings", "environmentName") = ..environmentName
     if ..basicMode = "system" {
         kill @storage@("settings", "user", $username, "basicMode")
     } else {
         set @storage@("settings", "user", $username, "basicMode") = ..basicMode
     } 
+    try {
+        do $SYSTEM.Version.SystemMode(..environmentName)
+    } catch e {
+        // no-op; user might not have privileges.
+    }
+
+    
 
     // update value of basicUserMode to reflect the updated setting for basicMode
     set ..userBasicMode = ##class(SourceControl.Git.Utils).UserBasicMode()
@@ -257,6 +268,13 @@ ClassMethod Configure() As %Boolean [ CodeMode = objectgenerator ]
             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}")
+        } elseif ((propertyDef) && (propertyDef.Name = "environmentName")) {
+            do %code.WriteLine(" set list(1) = ""DEVELOPMENT""")
+            do %code.WriteLine(" set list(2) = ""TEST""")
+            do %code.WriteLine(" set list(3) = ""LIVE""")
+            do %code.WriteLine(" set list(4) = ""FAILOVER""")
+            do %code.WriteLine(" set list(5) = """"")
+            do %code.WriteLine(" set response = ##class(%Library.Prompt).GetArray("_promptQuoted_",.value,.list,,,,"_defaultPromptFlag_")")
         } else {
             do %code.WriteLine(" set response = ##class(%Library.Prompt).GetString("_promptQuoted_",.value,,,,"_defaultPromptFlag_")")
         }

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(%request.URLPrefix)
+        set sourceControlInclude = ##class(SourceControl.Git.Utils).GetSourceControlInclude()
         while '%stream.AtEnd {
             set text = %stream.Read()
             set text = $replace(text,"{{baseHref}}",..EscapeHTML(%base))

cls/SourceControl/Git/Utils.cls

@@ -173,6 +173,16 @@ ClassMethod WarnInstanceWideUncommitted() As %Boolean
     quit $get(@..#Storage@("settings","warnInstanceWideUncommitted"),1)
 }
 
+ClassMethod EnvironmentName() As %String
+{
+    quit $SYSTEM.Version.SystemMode()
+}
+
+ClassMethod IsLIVE() As %Boolean
+{
+    quit ..EnvironmentName()="LIVE"
+}
+
 ClassMethod NeedSettings() As %Boolean [ CodeMode = expression ]
 {
 (..TempFolder() = "") || (..GitBinPath() = "") ||  (..GitBinPath() = """")
@@ -2639,7 +2649,7 @@ ClassMethod GetPackageVersion() As %String [ CodeMode = objectgenerator ]
     quit $$$OK
 }
 
-ClassMethod GetSourceControlInclude(prefix As %String = "") As %String
+ClassMethod GetSourceControlInclude(prefix As %String = {%request.URLPrefix}) As %String
 {
     quit $select(##class(%Library.EnsembleMgr).IsEnsembleInstalled():
         "<script type=""text/javascript"" src="""_prefix_"/isc/studio/templates/ensemble/Ens_SourceControl.js""></script>",
@@ -2877,4 +2887,28 @@ ClassMethod BaselineExport(pCommitMessage = "", pPushToRemote = "") As %Status
     return sc
 }
 
+/// Returns the url for the remote repository (censoring the username)
+ClassMethod GetConfiguredRemote() As %String
+{
+    d ..RunGitCommand("remote",.err,.out,"-v")
+    set line = out.ReadLine()
+    set url = $piece($piece(line,$char(9),2)," ",1)
+    return url
+}
+
+ClassMethod GetRedactedRemote() As %String
+{
+    set url = ..GetConfiguredRemote()
+    set username= $piece($piece(url,":",3),"@",1)
+    set censoredUrl = $replace(url, username,"*******")
+    return censoredUrl
+}
+
+ClassMethod SetConfiguredRemote(url) As %String
+{
+    do ##class(SourceControl.Git.Utils).RunGitCommandWithInput("remote",,.errStream,.outStream,"set-url","origin",url)
+    set output = outStream.ReadLine(outStream.Size)
+    quit output
+}
+
 }

cls/SourceControl/Git/WebUIDriver.cls

@@ -26,6 +26,12 @@ ClassMethod HandleRequest(pagePath As %String, InternalName As %String = "", Out
             set responseJSON = {
                 "url": (..GetHomeURL())
             }
+        } elseif $extract(pagePath,6,*) = "remote" {
+            set responseJSON = ..GetRemote()   
+        } elseif $extract(pagePath,6,*) = "environment" {
+            set responseJSON = {
+                "environment": (##class(SourceControl.Git.Utils).EnvironmentName()) 
+            }
         } else {
             set %response.Status = ##class(%CSP.REST).#HTTP404NOTFOUND
             set responseJSON = {"error":("invalid URI: " _ pagePath)}
@@ -407,4 +413,10 @@ ClassMethod GetHomeURL() As %String
     quit prefix_"/csp/sys/UtilHome.csp"
 }
 
+ClassMethod GetRemote() As %Library.DynamicObject
+{
+    set remote = ##class(SourceControl.Git.Utils).GetRedactedRemote()
+    quit {"remote": (remote)}
+}
+
 }

csp/gitprojectsettings.csp

@@ -79,12 +79,14 @@ body {
  set homeURL = ##class(SourceControl.Git.WebUIDriver).GetHomeURL()
 
  set settings = ##class(SourceControl.Git.Settings).%New()
+ set remote = ##class(SourceControl.Git.Utils).GetRedactedRemote()
+ /// After Save
  if (%request.Method="POST") && $Data(%request.Data("gitsettings",1)) {
     for param="gitUserName","gitUserEmail" {
         set $Property(settings,param) = $Get(%request.Data(param,1))
     }
     if ('settings.settingsUIReadOnly) {
-        for param="gitBinPath","namespaceTemp","privateKeyFile","pullEventClass","percentClassReplace", "defaultMergeBranch" {
+        for param="gitBinPath","namespaceTemp","privateKeyFile","pullEventClass","percentClassReplace", "defaultMergeBranch","environmentName" {
             set $Property(settings,param) = $Get(%request.Data(param,1))
         }
 
@@ -94,6 +96,12 @@ body {
             set settings.mappedItemsReadOnly = 0
         }
 
+        set newRemote = $Get(%request.Data("remoteRepo",1))
+        // If entry was modified, set new remote repo
+        if (newRemote '= ##class(SourceControl.Git.Utils).GetRedactedRemote()) {
+            do ##class(SourceControl.Git.Utils).SetConfiguredRemote(newRemote)
+        }
+
         set settings.compileOnImport = ($Get(%request.Data("compileOnImport", 1)) = 1)
         set settings.decomposeProductions = ($Get(%request.Data("decomposeProductions", 1)) = 1)
         set settings.decomposeProdAllowIDE = ($Get(%request.Data("decomposeProdAllowIDE", 1)) = 1)
@@ -308,6 +316,20 @@ body {
             </div>
         </div>
 
+        <div class="form-group row mb-3">
+            <label for="environmentName" class="offset-sm-1 col-sm-3 col-form-label"  data-toggle="tooltip" data-placement="top" title="Environment Name">Environment Name</label>
+            <div class="col-sm-7">
+                <select class="form-control" id="environmentName" name="environmentName">
+                    <server>
+                        for envName = "TEST","DEVELOPMENT","LIVE","FAILOVER","" {
+                            // create option with envName, set selected if envName == current environmentName
+                            &html<<option #($CASE(envName, settings.environmentName: "selected", :""))# value=#(envName)#>#(envName)# </option>>
+                        }
+                    </server>
+                </select>
+            </div>
+        </div>
+
         <div class="form-group row mb-3">
             <label for="percentClassReplace" class="offset-sm-1 col-sm-3 col-form-label"  data-toggle="tooltip" data-placement="top" title="Character(s) to replace '%' with for percent classes while exporting them out to the filesystem. By default, the '%' is removed.">'%' Replacement on Export</label>
             <div class="col-sm-7">
@@ -342,6 +364,16 @@ body {
                 <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="remoteRepo" class="offset-sm-1 col-sm-3 col-form-label"  data-toggle="tooltip" data-placement="top" title="Url to Remote repository">Remote Repository</label>
+            <div class="col-sm-7">
+                <input type="text" class="form-control" id="remoteRepo" name="remoteRepo" value='#(..EscapeHTML(remote))#' placeholder="ex. [email protected]:User/UserRepo.git"/>
+                <div class = "neutral-feedback">
+                    (Username is redacted)
+                </div>
+            </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>

docs/expert.md

@@ -0,0 +1,42 @@
+### Feature branches
+
+The first step in making changes in Health Connect Cloud using git-source-control is making a feature branch. In order for changes to be tracked by source control properly, each change (also called a feature) should be made on it's own branch, so as to not interfere with other changes, and allow for testing of its effects on the production environment. To create a new feature branch, navigate to the Git UI in the namespace you plan on doing development. 
+
+First, make sure that you are in the development branch. It should be bolded and at the top of the Local Branches in the sidebar. If it is not, as pictured below, click on the "development" branch and press checkout branch.
+
+![Development branch in Git UI Sidebar](images/hcc/developmentsidebar.png)
+
+Once you are in the development branch, press the "+" next the the Local Branches tab, and create a new branch by typing out a name for it. (No spaces or special characters are allowed in branch names).
+
+![Creating a new via sidebar](images/hcc/newbranch.png)
+![Naming new branch](images/hcc/newbranchnaming.png)
+
+Finally, you should click on the new branch you just made in the sidebar, and then press "Push".
+
+![Push your new branch](images/hcc/pushbranch.png)
+
+This makes sure that your branch will be tracked in Gitlab, so that other users can checkout your branch to test your changes on their own namespaces.
+
+After this, you can start working on the change.
+
+### Merge Requests
+
+Once you have made all the changes for the specific feature you are working on, and have tested in your namespace, it will be time to merge all of these changes into the development branch. To start, make sure that all your changes have been commited to your feature branch. To do this, navigate to the Git UI, and after making sure you are in the right feature branch, press the "Workspace" tab at the top of the sidebar. 
+
+![Workspace tab in the sidebar](images/hcc/sidebar.png)
+
+This will bring you to the workspace view. All the changes you made to files should be in the bottom left of the workspace view. ![Changed files in workspace](images/hcc/workspacechanges.png)
+
+Clicking on one of these files will bring up a line by line view of the changes that have been made. Make sure that these are the changes you want to make, and then select all the files. Next, enter a commit message that should describe that changes that have been made. 
+
+![Enter commit message](images/hcc/commitmessage.png)
+
+You can enter more details below, and then press the commit button underneath. This will commit the changes you have made to your feature branch. Once all of your changes have been committed, you should be ready to merge into the development branch.
+
+In the Git UI, first checkout the development branch, by selecting it from the Local Branches and pressing "Checkout branch". Next, find the feature branch that you have been working on, select it from the local branches, and press "Merge Branch". 
+
+![Merge Branch](images/hcc/mergebranch.png)
+
+
+
+

docs/hcc.md

@@ -0,0 +1,53 @@
+# git-source-control for Health Connect Cloud Overview
+
+## Development Workflow
+
+git-source-control has two main use modes: Basic and Expert. For Health Connect Cloud, we recommend beginning with Basic Mode, since it includes all of the necessary functionality for proper source control development while being easy to use for those with less Git experience. The recommended workflow for Health Connect Cloud is to create interface branches, create merge requests into development, and then pull the changes into the main dev development namespace.
+
+A Health Connect Cloud Dev deployment will have a main namespace (which is also present in Test and Prod) and should also have a dedicated namespace for each developer contributing. These namespaces can be configured via the Cloud Portal. It is important for changes to originate in developer-specific namespaces; the main namespace in the dev deployment should always be kept up to date with the development branch in GitLab, either through a CI/CD pipeline or by use of the Git Pull page from git-source-control.
+
+### Interface Branches
+
+The first step in making changes in Health Connect Cloud using git-source-control is making an interface (feature) branch. To start out, you should be in your own personal development namespace. In order for changes to be tracked by source control properly, each change (also called a feature) should be made on it's own branch, so as to not interfere with other changes, and allow for testing of its effects on the production environment. To create a new feature branch, use the source control menu and select "Create new branch".
+
+![Creating a new branch](images/hcc/newbranchmenu.png)
+
+You will be prompted to enter a name for your new branch (no spaces or special characters), after which your environment will switch to that new branch. All new branches are fresh copies of the development branch. We recommend that you name branches descriptively based on a reference to the issue/bug that you are trying to fix - a GitLab issue number, Jira, ServiceNow ticket reference, etc.
+
+### Making Changes
+
+Now that you are in your new branch (you can see your current branch in the first item in the source control menu), you can start making changes. As you make changes to different business processes, rules, and productions, make sure that all of these changes are saved properly and any new items are added to source control (via the "Add" menu item) before you continue to sync and merge.
+
+### Syncing and Merge Requests
+
+Once you have made all the changes for the specific feature you are working on, and have tested in your namespace, it will be time to merge all of these changes into the development branch.
+
+To start, press the sync button from the source control menu. 
+
+![Sync option in menu](images/hcc/sync.png)
+
+This will bring up the sync interface, where you are able to see all the of the files you have changed, as well as add a descriptive comment for the changes you made. When you sync, these changes will be pushed to the git remote.
+
+![Sync Interface](images/hcc/syncinterface.png)
+
+Use the link in the output of the sync in order to create a merge request in the git remote (don't worry if you close out of the sync tab, you can also navigate to GitLab manually). Here, you should make sure that you are merging your interface branch into the development environment, and notify / add the relevant reviewers. Once this merge request is approved, it will be merged into the development branch, so that all of your changes will now be a part of development.
+
+### Switching Branches
+
+Suppose you begin working on a larger project in one branch, and then need to shift to something else. The proper approach to this in git-source-control is to commit your in-progress work on the first interface, and then to switch to a new branch. This branch will be based on the development branch and may be missing components from the first project, but that's OK. You can always switch back to the first interface branch to continue work there.
+
+## Deploying Changes to the Main Dev Namespace
+
+If you are using a CI/CD pipeline in GitLab, simply merging the feature branch to development is enough; your change will be deployed to the main development namespace automatically.
+
+If you are not using a CI/CD pipeline, you can get merged changes into the main development namespace using the "Git Pull" link from the Favorites section in the Health Connect Cloud home page. This will load and compile the incremental set of changes from new commits to the development branch.
+
+## Deploying Changes to Test and Prod
+
+### Deploying using CI/CD Pipelines
+
+With CI/CD pipelines in place, the most important thing is that there is a branch in GitLab that corresponds to the main namespace in Test and another that corresponds to the main namespace on Prod, so that you can see exactly when changes made it to each branch/environment. With CI/CD pipelines, there's no action needed to move the change forward - merging the merge request is sufficient. The recommended workflow for this is to create additional merge requests from the interface branch to each of Test and Prod. Other Git branching and change flows may be appropriate if you have a strong opinion about them.
+
+### Deploying using the Deployment Manager
+
+Another way to move work from the main Dev namespace to the corresponding namespace in Test and Prod environments is using the Deployment Manager to move from Dev to Test, then Test to Prod. This loses the traceability of a clean branch-to-environment mapping, but is perhaps simpler technically and involves less time wrangling merge requests in GitLab. For guidance on using the deployment manager, see [InterSystems Documentation](https://docs.intersystems.com/irisforhealthlatest/csp/docbook/Doc.View.cls?KEY=EGDV_deploying).