Mark TODOs in the code

smartarch · Jun 13, 2024 · 2f13a26 · 2f13a26
1 parent fd9de92
commit 2f13a26
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/client/src/lib/page-common.js b/client/src/lib/page-common.js
@@ -392,6 +392,7 @@ class SubRoute extends Component {
 
         const render = (resolved, permissions) => {
             if (resolved && permissions) {
+                // TODO: update the following code for the new react router (v6), see also root-trusted.js (`getStructure`)
                 const subStructure = route.structure(resolved, permissions, params);
                 const routes = getRoutes(subStructure, route);
                 const childRoute = routes[0];

diff --git a/client/src/lib/page.js b/client/src/lib/page.js
@@ -410,7 +410,8 @@ class SectionContentBase extends Component {
     }
 
     componentDidMount() {
-        /*window.addEventListener('beforeunload', this.beforeUnloadHandler);
+        /* TODO: update this code for the new router (v6), possibly with https://reactrouter.com/en/main/hooks/use-blocker
+        window.addEventListener('beforeunload', this.beforeUnloadHandler);
         this.historyUnblock = this.props.navigate.block('Changes you made may not be saved. Are you sure you want to leave this page?');
         */
     }

diff --git a/client/src/root-trusted.js b/client/src/root-trusted.js
@@ -97,7 +97,8 @@ const getStructure = t => {
         },
         panelRender: props => <WorkspacePanel panel={props.resolved.panel}/>
 
-        /*structure: (resolved, params) => {
+        /* TODO: update the following code for the new react router (v6), see also page-common.js (`SubRoute`)
+        structure: (resolved, params) => {
             if (resolved.panel.template) {
                 console.log("resolved.panel.template ok")
                 return {

diff --git a/server/models/signal-sets.js b/server/models/signal-sets.js
@@ -485,7 +485,9 @@ async function getLastId(context, sigSet) {
     return lastId;
 }
 
-/* queries = [
+/** Query the data from signal sets. Basic query description is below, see also https://github.com/smartarch/ivis-core/wiki/Data-Access-from-Templates-(Queries) for more details.
+ *
+ * queries = [
     {
         params: {
             withId: <true returns also _id field>
@@ -539,7 +541,7 @@ async function getLastId(context, sigSet) {
 
         <OR>
 
-        docs: { // TODO: Not implemented yet
+        docs: {
             limit: <max no. of records>,
             sort: [
                 {