minor fixes for #33 and #34

.dockerignore

@@ -0,0 +1,2 @@
+build-for-zpm/*
+readme.md

Dockerfile-build-npm

@@ -0,0 +1,30 @@
+FROM ubuntu:latest
+ARG NODE_VERSION=10
+
+# install curl
+RUN apt update && apt install curl -y
+
+# install nvm
+RUN curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
+
+# set env
+ENV NVM_DIR=/root/.nvm
+
+# install node
+RUN bash -c "source $NVM_DIR/nvm.sh && nvm install ${NODE_VERSION} && nvm use ${NODE_VERSION}"
+
+# copy code
+WORKDIR /opt/irisapp
+COPY src ./src
+COPY gulpfile.js .
+COPY package.json .
+
+# build npm
+RUN bash -c "source $NVM_DIR/nvm.sh && npm install && npm run gulp"
+
+
+# set ENTRYPOINT for reloading nvm-environment
+ENTRYPOINT ["bash", "-c", "source $NVM_DIR/nvm.sh && exec \"$@\"", "--"]
+
+# set cmd to bash
+CMD ["/bin/bash"]

build-for-zpm/ClassExplorer/ClassView.cls

@@ -112,6 +112,16 @@ ClassMethod fillClassData(oData As %ZEN.proxyObject, className As %String, level
     if (oData.restrictPackage) && ('..inPackage(oData.basePackageName, package)) quit oClass
     set oClass.Super = ..correctInheritance(oData, classDefinition, package) // now expand super names
 
+    // prebuild a list of properties that are part of an FK
+    kill propToFK
+    for i = 1:1:classDefinition.ForeignKeys.Count() {
+        set fk = classDefinition.ForeignKeys.GetAt(i)
+        for j = 1:1:$l(fk.Properties,",") {
+            set prop = $piece(fk.Properties,",")
+            set propToFK(prop) = fk
+        }
+    }
+
     set oClass.properties = oProperties
     set count = classDefinition.Properties.Count()
     set props = ##class(%Dictionary.ClassDefinition).%OpenId("%Dictionary.PropertyDefinition")
@@ -127,14 +137,26 @@ ClassMethod fillClassData(oData As %ZEN.proxyObject, className As %String, level
                 // Skip private properties that InterSystems may add in any future versions
             }
         }
-        if (..classExists(package _ "." _ p.Type)) {
-            set oProp.Type = package _ "." _ p.Type
-            do ..fillClassData(oData, package _ "." _ p.Type, level, currLevel)
-        } elseif (..classExists(..extendClassFromType(p.Type))) {
-            set oProp.Type = ..extendClassFromType(p.Type)
-            do ..fillClassData(oData, ..extendClassFromType(p.Type), level, currLevel)
+
+        set pType = p.Type
+
+        // check if this property has an outgoing FK reference
+        if $d(propToFK(p.Name), fk) {
+            // if so, override target type and class relationship traits
+            set pType = fk.ReferencedClass,
+                oProp.Relationship = 1,
+                oProp.Cardinality = "one",
+                oProp.Inverse = "[foreign key]"
+        }
+
+        if (..classExists(package _ "." _ pType)) {
+            set oProp.Type = package _ "." _ pType
+            do ..fillClassData(oData, package _ "." _ pType, level, currLevel)
+        } elseif (..classExists(..extendClassFromType(pType))) {
+            set oProp.Type = ..extendClassFromType(pType)
+            do ..fillClassData(oData, ..extendClassFromType(pType), level, currLevel)
         }  else {
-            set oProp.Type = ..extendClassFromType(p.Type)
+            set oProp.Type = ..extendClassFromType(pType)
         }
     }
 
@@ -321,14 +343,25 @@ ClassMethod getBaseOData(packageName As %String, baseNamespace As %String, saved
 
     set ns = $namespace
     zn baseNamespace
-    if $get(^ClassExplorer("savedView", ns_":"_savedName)) '= "" {
-        set oData.savedView = $get(^ClassExplorer("savedView", ns_":"_savedName))
+    set shortName = ..shortenSavedName(ns_":"_savedName)
+    if $get(^ClassExplorer("savedView", shortName)) '= "" {
+        set oData.savedView = $get(^ClassExplorer("savedView", shortName))
     }
     zn ns
 
     quit oData
 }
 
+/// Shorten the saved name to avoid SUBSCRIPT errors when saving into ^ClassExplorer
+ClassMethod shortenSavedName(savedName as %String) As %String [ Internal ]
+{
+    // this is not watertight, but should be sufficient for this use case
+    if $l(savedName)>100 {
+        return $e(savedName, 1, 100) _ $zcrc(savedName, 7)
+    }
+    return savedName
+}
+
 /// Returns if class with given name exists.
 ClassMethod classExists(className As %String) As %Boolean
 {

build-for-zpm/ClassExplorer/Router.cls

@@ -42,7 +42,7 @@ ClassMethod SaveView() As %Status
 {
     set name = %request.Get("name")
     set content = %request.Content.Read($$$MaxStringLength) // ~ 7mb
-    set ^ClassExplorer("savedView", name) = content
+    set ^ClassExplorer("savedView", ##class(ClassExplorer.ClassView).shortenSavedName(name)) = content
     write "{""OK"":true}"
     return $$$OK
 }
@@ -51,7 +51,7 @@ ClassMethod SaveView() As %Status
 ClassMethod ResetView() As %Status
 {
     set name = %request.Get("name")
-    kill ^ClassExplorer("savedView", name)
+    kill ^ClassExplorer("savedView", ##class(ClassExplorer.ClassView).shortenSavedName(name))
     write "{""OK"":true}"
     return $$$OK
 }

module.xml

@@ -3,12 +3,12 @@
   <Document name="classexplorer.ZPM">
     <Module>
       <Name>classexplorer</Name>
-      <Version>1.21.4</Version>
+      <Version>1.21.5</Version>
       <Description>UML Class Diagram Builder for InterSystems Data Platforms</Description>
       <Packaging>module</Packaging>
       <SourcesRoot>build-for-zpm</SourcesRoot>
       <Resource Name="ClassExplorer.PKG"/>
-       <CSPApplication 
+       <WebApplication 
         Url="/ClassExplorer"
         DispatchClass="ClassExplorer.Router"
         MatchRoles=":{$dbrole}"

readme.md

@@ -46,6 +46,8 @@ application.
 
 ## Development
 
+### Local
+
 To build project, you need [NodeJS](https://nodejs.org) platform to be installed. Then, clone source
 code and run <code>npm install</code> from the root of the project. This will install all necessary
 modules from NPM for the project.
@@ -61,6 +63,19 @@ One can import/export the built source to the local Cache/URIS instance (see `im
 
 This will bring `ClassExplorer-v*.*.*.xml` to the `build` directory, which you can then package with `npm run zip`.
 
+### Using docker
+
+:warning: The following is a rather naive way of building the web app for ZPM packaging using an [nvm docker script](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-in-docker), starting the image as a daemon, and then manually copying the files back out.
+
+```Shell
+docker build -f ./Dockerfile-build-npm -t build-npm .
+docker run --rm -d --name build-npm build-npm /bin/bash -c 'while true; do sleep 30; done'
+docker cp build-npm:/opt/irisapp/build/cls/ClassExplorer.ClassView.cls ./build-for-zpm/ClassExplorer/ClassView.cls
+docker cp build-npm:/opt/irisapp/build/cls/ClassExplorer.Router.cls ./build-for-zpm/ClassExplorer/Router.cls
+docker cp build-npm:/opt/irisapp/build/cls/ClassExplorer.StaticContent.cls ./build-for-zpm/ClassExplorer/StaticContent.cls
+docker stop build-npm
+```
+
 ### ZPM
 
 [ZPM](https://github.com/intersystems-community/zpm) is the package manager for InterSystems products. Currently,

src/cls/ClassExplorer/ClassView.cls

@@ -112,6 +112,16 @@ ClassMethod fillClassData(oData As %ZEN.proxyObject, className As %String, level
     if (oData.restrictPackage) && ('..inPackage(oData.basePackageName, package)) quit oClass
     set oClass.Super = ..correctInheritance(oData, classDefinition, package) // now expand super names
 
+    // prebuild a list of properties that are part of an FK
+    kill propToFK
+    for i = 1:1:classDefinition.ForeignKeys.Count() {
+        set fk = classDefinition.ForeignKeys.GetAt(i)
+        for j = 1:1:$l(fk.Properties,",") {
+            set prop = $piece(fk.Properties,",")
+            set propToFK(prop) = fk
+        }
+    }
+
     set oClass.properties = oProperties
     set count = classDefinition.Properties.Count()
     set props = ##class(%Dictionary.ClassDefinition).%OpenId("%Dictionary.PropertyDefinition")
@@ -127,14 +137,26 @@ ClassMethod fillClassData(oData As %ZEN.proxyObject, className As %String, level
                 // Skip private properties that InterSystems may add in any future versions
             }
         }
-        if (..classExists(package _ "." _ p.Type)) {
-            set oProp.Type = package _ "." _ p.Type
-            do ..fillClassData(oData, package _ "." _ p.Type, level, currLevel)
-        } elseif (..classExists(..extendClassFromType(p.Type))) {
-            set oProp.Type = ..extendClassFromType(p.Type)
-            do ..fillClassData(oData, ..extendClassFromType(p.Type), level, currLevel)
+
+        set pType = p.Type
+
+        // check if this property has an outgoing FK reference
+        if $d(propToFK(p.Name), fk) {
+            // if so, override target type and class relationship traits
+            set pType = fk.ReferencedClass,
+                oProp.Relationship = 1,
+                oProp.Cardinality = "one",
+                oProp.Inverse = "[foreign key]"
+        }
+
+        if (..classExists(package _ "." _ pType)) {
+            set oProp.Type = package _ "." _ pType
+            do ..fillClassData(oData, package _ "." _ pType, level, currLevel)
+        } elseif (..classExists(..extendClassFromType(pType))) {
+            set oProp.Type = ..extendClassFromType(pType)
+            do ..fillClassData(oData, ..extendClassFromType(pType), level, currLevel)
         }  else {
-            set oProp.Type = ..extendClassFromType(p.Type)
+            set oProp.Type = ..extendClassFromType(pType)
         }
     }
 
@@ -321,14 +343,25 @@ ClassMethod getBaseOData(packageName As %String, baseNamespace As %String, saved
 
     set ns = $namespace
     zn baseNamespace
-    if $get(^ClassExplorer("savedView", ns_":"_savedName)) '= "" {
-        set oData.savedView = $get(^ClassExplorer("savedView", ns_":"_savedName))
+    set shortName = ..shortenSavedName(ns_":"_savedName)
+    if $get(^ClassExplorer("savedView", shortName)) '= "" {
+        set oData.savedView = $get(^ClassExplorer("savedView", shortName))
     }
     zn ns
 
     quit oData
 }
 
+/// Shorten the saved name to avoid SUBSCRIPT errors when saving into ^ClassExplorer
+ClassMethod shortenSavedName(savedName as %String) As %String [ Internal ]
+{
+    // this is not watertight, but should be sufficient for this use case
+    if $l(savedName)>100 {
+        return $e(savedName, 1, 100) _ $zcrc(savedName, 7)
+    }
+    return savedName
+}
+
 /// Returns if class with given name exists.
 ClassMethod classExists(className As %String) As %Boolean
 {

src/cls/ClassExplorer/Router.cls

@@ -42,7 +42,7 @@ ClassMethod SaveView() As %Status
 {
     set name = %request.Get("name")
     set content = %request.Content.Read($$$MaxStringLength) // ~ 7mb
-    set ^ClassExplorer("savedView", name) = content
+    set ^ClassExplorer("savedView", ##class(ClassExplorer.ClassView).shortenSavedName(name)) = content
     write "{""OK"":true}"
     return $$$OK
 }
@@ -51,7 +51,7 @@ ClassMethod SaveView() As %Status
 ClassMethod ResetView() As %Status
 {
     set name = %request.Get("name")
-    kill ^ClassExplorer("savedView", name)
+    kill ^ClassExplorer("savedView", ##class(ClassExplorer.ClassView).shortenSavedName(name))
     write "{""OK"":true}"
     return $$$OK
 }

src/web/js/Source.js

@@ -1,7 +1,19 @@
 var Source = function (cacheUMLExplorer) {
 
+    // need to figure out path prefix when not at /ClassExplorer
+    var prefix = '';
+    try {
+        var path = window.location.pathname.split('/');
+        for (var i = 1; i < path.length; i++) {
+            if (path[i]=='ClassExplorer') break;
+            prefix += '/'+path[i];
+        }
+    } catch (ex) {
+        // shrug it off
+    }
+
     this.URL = window.location.protocol + "//" + window.location.hostname + ":" +
-        57772/*build.replace:window.location.port*/ + "/ClassExplorer";
+        57772/*build.replace:window.location.port*/ + prefix + "/ClassExplorer";
 
     this.cue = cacheUMLExplorer;