@esri/solution-common 6.1.3 → 6.1.5

package/dist/esm/dependencies.js

@@ -0,0 +1,167 @@
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Provides common functions for organizing dependencies among items.
+ *
+ * @module dependencies
+ */
+import { getProp } from "./generalHelpers";
+import { findTemplateInList } from "./templatization";
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Topologically sorts a list of items into a build list.
+ *
+ * @param templates A collection of AGO item templates
+ * @returns An object containing three parts: a list of ids of items in the order in which they need to be built
+ * so that dependencies are built before items that require those dependencies, a list of item ids found in a
+ * template's dependencies but not present in the supplied list of templates, and a dictionary containing items
+ * that need to be post-processed due to dependency cycles.
+ */
+export function topologicallySortItems(templates) {
+    // Cormen, Thomas H.; Leiserson, Charles E.; Rivest, Ronald L.; Stein, Clifford (2009)
+    // Sections 22.3 (Depth-first search) & 22.4 (Topological sort), pp. 603-615
+    // Introduction to Algorithms (3rd ed.), The MIT Press, ISBN 978-0-262-03384-8
+    //
+    // DFS(G)
+    // 1 for each vertex u ∈ G,V
+    // 2     u.color = WHITE  (not yet visited)
+    // 3     u.π = NIL
+    // 4 time = 0
+    // 5 for each vertex u ∈ G,V
+    // 6     if u.color == WHITE
+    // 7         DFS-VISIT(G,u)
+    //
+    // DFS-VISIT(G,u)
+    // 1 time = time + 1  (white vertex u has just been discovered)
+    // 2 u.d = time
+    // 3 u.color = GRAY  (visited, in progress)
+    // 4 for each v ∈ G.Adj[u]  (explore edge (u,v))
+    // 5     if v.color == WHITE
+    // 6         v.π = u
+    // 7         DFS-VISIT(G,v)
+    // 8 u.color = BLACK  (blacken u; it is finished)
+    // 9 time = time + 1
+    // 10 u.f = time
+    //
+    // TOPOLOGICAL-SORT(G)
+    // 1 call DFS(G) to compute finishing times v.f for each vertex v
+    // 2 as each vertex is finished, insert it onto front of a linked list
+    // 3 return the linked list of vertices
+    let buildOrder = []; // list of ordered vertices--don't need linked list because
+    // we just want relative ordering
+    const missingDependencies = [];
+    const itemsToBePatched = {};
+    const verticesToVisit = {};
+    const vertexType = {};
+    templates.forEach(function (template) {
+        verticesToVisit[template.itemId] = ESortVisitState.NotYetVisited;
+        vertexType[template.itemId] =
+            template.item?.typeKeywords && template.item.typeKeywords.includes("View Service")
+                ? "View Service"
+                : template.item?.tags && template.item.tags.includes("Location Tracking Group")
+                    ? "Location Tracking Group"
+                    : template.type;
+    });
+    // Algorithm visits each vertex once. Don't need to record times or "from' nodes ("π" in pseudocode)
+    templates.forEach(function (template) {
+        if (verticesToVisit[template.itemId] === ESortVisitState.NotYetVisited) {
+            // if not yet visited
+            visit(template.itemId);
+        }
+    });
+    // Visit vertex
+    function visit(vertexId) {
+        verticesToVisit[vertexId] = ESortVisitState.InProgress; // visited, in progress
+        // Visit dependents if not already visited; template has to be in templates list because calls to visit()
+        // are based on verticiesToVisit[], which is initialized using the templates list
+        const template = findTemplateInList(templates, vertexId);
+        // There are two sources of dependencies
+        const dependencies = (template.dependencies || []).concat(getProp(template, "properties.syncViews") || []);
+        dependencies.forEach(function (dependencyId) {
+            if (verticesToVisit[dependencyId] === ESortVisitState.NotYetVisited) {
+                // if not yet visited
+                visit(dependencyId);
+            }
+            else if (verticesToVisit[dependencyId] === ESortVisitState.InProgress) {
+                // visited, in progress, therefore a cycle
+                // save the dependency that needs to be patched
+                if (itemsToBePatched[vertexId]) {
+                    itemsToBePatched[vertexId].push(dependencyId);
+                }
+                else {
+                    itemsToBePatched[vertexId] = [dependencyId];
+                }
+            }
+            else if (verticesToVisit[dependencyId] !== ESortVisitState.Finished) {
+                /* istanbul ignore else */
+                if (missingDependencies.indexOf(dependencyId) < 0) {
+                    missingDependencies.push(dependencyId);
+                }
+            }
+        });
+        verticesToVisit[vertexId] = ESortVisitState.Finished;
+        buildOrder.push(vertexId); // add to end of list of ordered vertices because we want dependents first
+    }
+    // Two special circumstances to deal with
+    // 1) Location Tracking Group needs to be created before its associated view because the groupId is used in the view name
+    //    - Move tracking groups to the front of the list
+    // 2) Feature Services need to be created before views that rely on them
+    //    - Move all of the feature services to the beginning of the build order while maintaining their relative ordering
+    //    - Distinguish between base feature services and view feature services
+    const trackerGroupIds = [];
+    const fsIds = [];
+    const fsViewIds = [];
+    const otherIds = [];
+    do {
+        const id = buildOrder.shift();
+        if (id) {
+            if (vertexType[id] === "Location Tracking Group") {
+                trackerGroupIds.push(id);
+            }
+            else if (vertexType[id] === "Feature Service") {
+                fsIds.push(id);
+            }
+            else if (vertexType[id] === "View Service") {
+                fsViewIds.push(id);
+            }
+            else {
+                otherIds.push(id);
+            }
+        }
+    } while (buildOrder.length > 0);
+    buildOrder = trackerGroupIds.concat(fsIds, fsViewIds, otherIds);
+    const orderingResults = {
+        buildOrder: buildOrder,
+        missingDependencies: missingDependencies,
+        itemsToBePatched: itemsToBePatched,
+    };
+    return orderingResults;
+}
+/**
+ * A visit flag used in the topological sort algorithm.
+ *
+ * @private
+ */
+var ESortVisitState;
+(function (ESortVisitState) {
+    /** not yet visited */
+    ESortVisitState[ESortVisitState["NotYetVisited"] = 0] = "NotYetVisited";
+    /** visited, in progress */
+    ESortVisitState[ESortVisitState["InProgress"] = 1] = "InProgress";
+    /** finished */
+    ESortVisitState[ESortVisitState["Finished"] = 2] = "Finished";
+})(ESortVisitState || (ESortVisitState = {}));
+//# sourceMappingURL=dependencies.js.map

package/dist/esm/dependencies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dependencies.js","sourceRoot":"","sources":["../../src/dependencies.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD,wHAAwH;AAExH;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB,CAAC,SAA0B;IAC/D,sFAAsF;IACtF,4EAA4E;IAC5E,8EAA8E;IAC9E,EAAE;IACF,SAAS;IACT,4BAA4B;IAC5B,2CAA2C;IAC3C,kBAAkB;IAClB,aAAa;IACb,4BAA4B;IAC5B,4BAA4B;IAC5B,2BAA2B;IAC3B,EAAE;IACF,iBAAiB;IACjB,+DAA+D;IAC/D,eAAe;IACf,2CAA2C;IAC3C,gDAAgD;IAChD,4BAA4B;IAC5B,oBAAoB;IACpB,2BAA2B;IAC3B,iDAAiD;IACjD,oBAAoB;IACpB,gBAAgB;IAChB,EAAE;IACF,sBAAsB;IACtB,iEAAiE;IACjE,sEAAsE;IACtE,uCAAuC;IAEvC,IAAI,UAAU,GAAa,EAAE,CAAC,CAAC,2DAA2D;IAC1F,iCAAiC;IACjC,MAAM,mBAAmB,GAAa,EAAE,CAAC;IACzC,MAAM,gBAAgB,GAAyB,EAAE,CAAC;IAElD,MAAM,eAAe,GAAgB,EAAE,CAAC;IACxC,MAAM,UAAU,GAAgB,EAAE,CAAC;IACnC,SAAS,CAAC,OAAO,CAAC,UAAU,QAAQ;QAClC,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC,aAAa,CAAC;QACjE,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC;YACzB,QAAQ,CAAC,IAAI,EAAE,YAAY,IAAI,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,cAAc,CAAC;gBAChF,CAAC,CAAC,cAAc;gBAChB,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC;oBAC7E,CAAC,CAAC,yBAAyB;oBAC3B,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,oGAAoG;IACpG,SAAS,CAAC,OAAO,CAAC,UAAU,QAAQ;QAClC,IAAI,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,eAAe,CAAC,aAAa,EAAE;YACtE,qBAAqB;YACrB,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SACxB;IACH,CAAC,CAAC,CAAC;IAEH,eAAe;IACf,SAAS,KAAK,CAAC,QAAgB;QAC7B,eAAe,CAAC,QAAQ,CAAC,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC,uBAAuB;QAE/E,yGAAyG;QACzG,iFAAiF;QACjF,MAAM,QAAQ,GAAG,kBAAkB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAEzD,wCAAwC;QACxC,MAAM,YAAY,GAAa,CAAC,QAAQ,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,MAAM,CACjE,OAAO,CAAC,QAAQ,EAAE,sBAAsB,CAAC,IAAI,EAAE,CAChD,CAAC;QAEF,YAAY,CAAC,OAAO,CAAC,UAAU,YAAY;YACzC,IAAI,eAAe,CAAC,YAAY,CAAC,KAAK,eAAe,CAAC,aAAa,EAAE;gBACnE,qBAAqB;gBACrB,KAAK,CAAC,YAAY,CAAC,CAAC;aACrB;iBAAM,IAAI,eAAe,CAAC,YAAY,CAAC,KAAK,eAAe,CAAC,UAAU,EAAE;gBACvE,0CAA0C;gBAC1C,+CAA+C;gBAC/C,IAAI,gBAAgB,CAAC,QAAQ,CAAC,EAAE;oBAC9B,gBAAgB,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;iBAC/C;qBAAM;oBACL,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;iBAC7C;aACF;iBAAM,IAAI,eAAe,CAAC,YAAY,CAAC,KAAK,eAAe,CAAC,QAAQ,EAAE;gBACrE,0BAA0B;gBAC1B,IAAI,mBAAmB,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;oBACjD,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;iBACxC;aACF;QACH,CAAC,CAAC,CAAC;QAEH,eAAe,CAAC,QAAQ,CAAC,GAAG,eAAe,CAAC,QAAQ,CAAC;QACrD,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,0EAA0E;IACvG,CAAC;IAED,yCAAyC;IACzC,yHAAyH;IACzH,qDAAqD;IACrD,wEAAwE;IACxE,sHAAsH;IACtH,2EAA2E;IAC3E,MAAM,eAAe,GAAa,EAAE,CAAC;IACrC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,GAAG;QACD,MAAM,EAAE,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC;QAC9B,IAAI,EAAE,EAAE;YACN,IAAI,UAAU,CAAC,EAAE,CAAC,KAAK,yBAAyB,EAAE;gBAChD,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aAC1B;iBAAM,IAAI,UAAU,CAAC,EAAE,CAAC,KAAK,iBAAiB,EAAE;gBAC/C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aAChB;iBAAM,IAAI,UAAU,CAAC,EAAE,CAAC,KAAK,cAAc,EAAE;gBAC5C,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aACpB;iBAAM;gBACL,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aACnB;SACF;KACF,QAAQ,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;IAChC,UAAU,GAAG,eAAe,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAEhE,MAAM,eAAe,GAAmB;QACtC,UAAU,EAAE,UAAU;QACtB,mBAAmB,EAAE,mBAAmB;QACxC,gBAAgB,EAAE,gBAAgB;KACnC,CAAC;IACF,OAAO,eAAe,CAAC;AACzB,CAAC;AA4BD;;;;GAIG;AACH,IAAK,eAOJ;AAPD,WAAK,eAAe;IAClB,sBAAsB;IACtB,uEAAa,CAAA;IACb,2BAA2B;IAC3B,iEAAU,CAAA;IACV,eAAe;IACf,6DAAQ,CAAA;AACV,CAAC,EAPI,eAAe,KAAf,eAAe,QAOnB"}