by default, lock editing of decomposed productions in the IDE

Author: isc-pbarton

cls/SourceControl/Git/Extension.cls

@@ -408,7 +408,11 @@ ClassMethod FullExternalName(InternalName As %String) As %String
 
 Method IsReadOnly(InternalName As %String) As %Boolean
 {
-    quit ##class(SourceControl.Git.Utils).Locked()
+    set settings = ##class(SourceControl.Git.Settings).%New()
+    quit ##class(SourceControl.Git.Utils).Locked() 
+        || (##class(SourceControl.Git.Utils).ItemIsProductionToDecompose($get(InternalName))
+            && 'settings.decomposeProdAllowIDE
+            && '##class(SourceControl.Git.Production).IsEnsPortal())
 }
 
 /// Called before the item is saved to the database it is passed
@@ -439,7 +443,7 @@ Method OnBeforeSave(InternalName As %String, Location As %String = "", Object As
 Method GetStatus(ByRef InternalName As %String, ByRef IsInSourceControl As %Boolean, ByRef Editable As %Boolean, ByRef IsCheckedOut As %Boolean, ByRef UserCheckedOut As %String) As %Status
 {
     set context = ##class(SourceControl.Git.PackageManagerContext).ForInternalName(.InternalName)
-    set Editable='..IsReadOnly(),IsCheckedOut=1,UserCheckedOut=""
+    set Editable='..IsReadOnly($get(InternalName)),IsCheckedOut=1,UserCheckedOut=""
     set filename=##class(SourceControl.Git.Utils).FullExternalName(.InternalName)
     set IsInSourceControl=(filename'=""&&($$$FileExists(filename)))
     if filename="" quit $$$OK
@@ -505,4 +509,3 @@ Method CheckCommitterIdentity(Settings As SourceControl.Git.Settings, ByRef Acti
 }
 
 }
-

cls/SourceControl/Git/Settings.cls

@@ -26,6 +26,9 @@ Property settingsUIReadOnly As %Boolean [ InitialExpression = {##class(SourceCon
 /// Interoperability productions are source-controlled under separate files for each configuration item
 Property decomposeProductions As %Boolean [ InitialExpression = {##class(SourceControl.Git.Utils).DecomposeProductions()} ];
 
+/// Allow editing a decomposed production class in an IDE
+Property decomposeProdAllowIDE As %Boolean [ InitialExpression = {##class(SourceControl.Git.Utils).DecomposeProdAllowIDE()} ];
+
 /// Attribution: Git username for user ${username}
 Property gitUserName As %String(MAXLEN = 255) [ InitialExpression = {##class(SourceControl.Git.Utils).GitUserName()} ];
 
@@ -156,6 +159,7 @@ Method %Save() As %Status
     if (..decomposeProductions & ($data(..Mappings("PTD"))<10)) {
         set ..Mappings("PTD","*") = "ptd/" // configure a default mapping for PTD items
     }
+    set @storage@("settings","decomposeProdAllowIDE") = ..decomposeProdAllowIDE
 
     kill @##class(SourceControl.Git.Utils).MappingsNode()
     merge @##class(SourceControl.Git.Utils).MappingsNode() = ..Mappings

cls/SourceControl/Git/Utils.cls

@@ -77,6 +77,11 @@ ClassMethod DecomposeProductions() As %Boolean [ CodeMode = expression ]
 $Get(@..#Storage@("settings","decomposeProductions"), 0)
 }
 
+ClassMethod DecomposeProdAllowIDE() As %Boolean [ CodeMode = expression ]
+{
+$Get(@..#Storage@("settings","decomposeProdAllowIDE"), 0)
+}
+
 /// Returns the current (or previous) value of the flag.
 ClassMethod Locked(newFlagValue As %Boolean) As %Boolean
 {

csp/gitprojectsettings.csp

@@ -96,6 +96,7 @@ body {
 
         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)
 
         if ($Get(%request.Data("basicMode", 1)) = 1) {
             set settings.basicMode = 1
@@ -384,6 +385,18 @@ body {
                 </div>
             </div>
         </div>
+        <div class="form-group row mb-3">
+            <label for="decomposeProdAllowIDE" class="offset-sm-1 col-sm-3 col-form-label" data-toggle="tooltip" data-placement="top" 
+                title="If true, a decomposed production class may be edited through VS Code or Studio">
+                Decomposed Productions Allow IDE</label>
+            <div class="col-sm-7">
+                <div class="custom-control custom-switch custom-switch-no-border">
+                    <input class="custom-control-input" name="decomposeProdAllowIDE" type="checkbox" 
+                        id="decomposeProdAllowIDE" #($select(settings.decomposeProdAllowIDE:"checked",1:""))# value="1">
+                    <label class="custom-control-label" for="decomposeProdAllowIDE"></label>
+                </div>
+            </div>
+        </div>
 
         <div class="form-group row mb-3 mapping-input-group">
             <div class="offset-sm-1 col-sm-3">

docs/production-decomposition.md

@@ -6,7 +6,12 @@ The feature may be enabled by checking the "Decompose Productions" box in the Gi
 
 If there are existing productions in the namespace, they should be migrated to the new decomposed format by running `do ##class(SourceControl.Git.API).BaselineProductions()`. You may then use the Git Web UI to view, commit, and push the corresponding changes. This method should be run in a single namespace and then deployed to other namespaces through normal git-source-control deployment mechanisms.
 
+## Editing productions in the IDE
+There are a couple of limitations related to editing a production class directly in an integrated development environment (Studio or VS Code).
+- Any elements of the class definition other than the production definition (for example, methods, parameters, or a custom superclass) are not source controlled if production decomposition is enabled. A recommended workaround is to move these items to a separate utility class.
+- The hooks in the IDE are not able to detect which specific production items are being edited. As a result, if any item has an uncommitted change from a different user, you will be blocked from editing the production in the IDE entirely.
+As a result of these limitations, editing decomposed productions in the IDE is prohibited by default. To enable it, enable the "Decomposed Productions Allow IDE" setting on the settings page.
+
 ## Known Limitations
-- The source control hooks for Production Decomposition are currently only supported when editing via the Interoperability Portal. Editing the production class directly in VS Code or Studio may overwrite other users' changes.
 - Any custom methods, parameters, etc. in the production class will not be source controlled if Production Decomposition is enabled. A recommended workaround is to move these items to a separate utility class.
 - Production Decomposition is not supported for deployment of changes to productions using the InterSystems Package Manager.