catflow: catch errors at setting parameters of JsonObject at restore()

backend: track if model is valid

Author: JeyRunner

README.md

@@ -8,6 +8,7 @@ To see api documentation look at: [catflow/README.md](catflow/README.md)
 ## Install
 Download [install-packages](https://gitlab.com/PancakeSoftware/openHabAI/-/jobs/artifacts/master/download?job=install-packages) from artifacts. Extract it and install the .deb package.
 ```bash
+cd build/pack
 dpkg --install OpenHabAI-0.0.0-Linux.deb
 # resolve deps 
 apt-get install -f 
@@ -39,5 +40,7 @@ The compiled trainSever executable can be found in build/bin. <br>
 To run frontend: ```make frontendRun``` or see in [README of frontend](frontend-angular/README.md)
 
 
-#### Protocol
-See backend-frontend [protocol definition](./doc/README.md).
+#### Development
+To use the Websocket Api see backend-frontend [protocol definition](./doc/README.md).
+##### Report Bugs and Improvements
+If you found a bug or have a good idea for new a feature just [open a new issue at gitlab](https://gitlab.com/PancakeSoftware/openHabAI/issues/new).

catflow/cpp/include/ApiJsonObject.h

@@ -40,7 +40,7 @@ class ApiJsonObject : protected virtual Log, public virtual ApiSubscribable, pub
  * @see JsonObject::params()
  * @return vector of changed param names
  */
- vector<string> fromJson(Json params) override;
+ vector<string> fromJson(Json params, bool catchParameterErrors = false) override;
 
  /**
  * set configured class attributes to values in params

catflow/cpp/include/JsonList.h

@@ -110,7 +110,6 @@ class JsonList : public ApiJsonObject, public __JsonList
  function<T *(Json params)> createItemFunc = [](Json params) -> T *
  {
  auto *t = new T();
- t->fromJson(params);
  return t;
  };
 

catflow/cpp/include/JsonObject.h

@@ -83,15 +83,17 @@ namespace internal
  class JsonParamReadOnly: public AJsonParam{
  public:
  T* valuePtr;
+ string key;
  JsonParamReadOnly(T &value, string key)
- {this->valuePtr = &value;}
+ {this->valuePtr = &value; this->key = key;}
 
  Json toJson() const override {
  return Json(*valuePtr);
  }
 
- void fromJson(Json j) override
- {}
+ void fromJson(Json j) override {
+ throw JsonObjectException("can't set '"+key+"' because it is readonly");
+ }
 
  bool isPrimitive() override;
  };
@@ -163,7 +165,7 @@ class JsonObject
  * @see JsonObject::params()
  * @return vector of changed param names
  */
- virtual vector<string> fromJson(Json params) {
+ virtual vector<string> fromJson(Json params, bool catchParameterErrors = false) {
  /* refresh param pointers
  * this is very inefficient but necessary (rebuild whole param list):
  * when the object is copied all param pointers have to be redefined (change pointer address) */
@@ -202,9 +204,13 @@ class JsonObject
  }
  catch (Json::type_error &e) {
  l.err("can't set jsonObject key '" + key +"' : " + e.what());
- throw JsonObjectException("can't set jsonObject key '" + key +"' because of wrong type : " + e.what());
+ if (!catchParameterErrors)
+ throw JsonObjectException("can't set jsonObject key '" + key +"' because of wrong type : " + e.what());
  } catch (JsonObjectException &e) {
- throw JsonObjectException("can't set jsonObject key '" + key +"' because of JsonObjectException : " + e.what());
+ if (!catchParameterErrors)
+ throw JsonObjectException("can't set jsonObject key '" + key +"' because of JsonObjectException : " + e.what());
+ else
+ l.err("can't set jsonObject key '" + key +"' because of JsonObjectException : " + e.what());
  }
  }
 

catflow/cpp/source/ApiJsonObject.cpp

@@ -25,9 +25,9 @@ ApiJsonObject::ApiJsonObject(Json params)
  fromJson(params);
 }
 
-vector<string> ApiJsonObject::fromJson(Json params)
+vector<string> ApiJsonObject::fromJson(Json params, bool catchParameterErrors)
 {
- vector<string> changedParams = JsonObject::fromJson(params);
+ vector<string> changedParams = JsonObject::fromJson(params, catchParameterErrors);
 
  // save all
  storeMe();
@@ -102,7 +102,7 @@ bool ApiJsonObject::load(string path, string fileName)
  return false;
  }
 
- fromJson(params);
+ fromJson(params, true /*catch param assignment errors*/);
  ok("load from " + full);
  return true;
 }

catflow/cpp/source/JsonList.tpp

@@ -106,6 +106,7 @@ ApiRespond* JsonList<T>::processApi(ApiRequest request)
  T* n = createItemFunc(j);
  if (n != nullptr)
  {
+ n->fromJson(j, true /*catch param assignment errors*/);
  items.insert({idAutoIncrement, n});
  if (route.is_initialized() && is_base_of<ApiJsonObject, T>::value)
  {
@@ -268,50 +269,60 @@ void JsonList<T>::restore()
  /*
  * get id by directory name */
  string id = directory_iterator->path().filename().string();
- int idNum;
  try
  {
- idNum = stoi(id);
- } catch (invalid_argument& e)
- {
- err("entity's id (in directoryName '" + directory_iterator->path().string() + "') is not a number", e.what());
- continue;
- }
- //info("... restore: " + storePath.get() + "/" + id);
 
- /*
- * read item.json */
- Json params;
- try
- {
- ifstream item{this->route.get().toStringStorePath() + id + "/item.json"};
- stringstream sItem;
- sItem << item.rdbuf();
- params = Json::parse(sItem.str());
+ int idNum;
+ try
+ {
+ idNum = stoi(id);
+ } catch (invalid_argument &e)
+ {
+ err("entity's id (in directoryName '" + directory_iterator->path().string() + "') is not a number", e.what());
+ continue;
+ }
+ //info("... restore: " + storePath.get() + "/" + id);
+
+ /*
+ * read item.json */
+ Json params;
+ try
+ {
+ ifstream item{this->route.get().toStringStorePath() + id + "/item.json"};
+ stringstream sItem;
+ sItem << item.rdbuf();
+ params = Json::parse(sItem.str());
+ }
+ catch (exception &e)
+ {
+ err("read item '" + this->route.get().toStringStorePath() + id + "/item.json" + "' : " + string(e.what()));
+ directory_iterator++;
+ continue;
+ }
+
+ /*
+ * add item */
+ T *n = createItemFunc(params);
+ ApiMessageRoute nRoute = route.get();
+ nRoute.push(id); // set entity id
+ n->setRoute(nRoute);
+ items.insert({idNum, n});
+ n->restore();
+
+ // next
+ if (idNum >= idAutoIncrement)
+ idAutoIncrement = idNum + 1;
+ directory_iterator++;
  }
- catch (exception& e) {
- err("read item '"+ this->route.get().toStringStorePath() + id + "/item.json" +"' : " + string(e.what()));
+ catch (exception &e)
+ {
+ err("restore (" + this->route.get().toStringStorePath() + " id(" + id + ")): " + string(e.what()));
  directory_iterator++;
- continue;
  }
-
- /*
- * add item */
- T *n = createItemFunc(params);
- ApiMessageRoute nRoute = route.get();
- nRoute.push(id); // set entity id
- n->setRoute(nRoute);
- items.insert({idNum, n});
- n->restore();
-
- // next
- if (idNum >= idAutoIncrement)
- idAutoIncrement = idNum + 1;
- directory_iterator++;
  }
  }
  catch (exception &e){
- err("restore ("+this->route.get().toStringStorePath()+"): " + string(e.what()));
+ err("restore ("+this->route.get().toStringStorePath()+" all list items): " + string(e.what()));
  }
 }
 

catflow/cpp/test/ApiTest.cpp

@@ -77,7 +77,7 @@ class RootRoute : public ApiRoute
 TEST(ApiRouteTest, progressListAddGetRemove)
 {
  RootRoute root;
- root.setStorePath("../test/apiTest/");
+ root.setStorePath("./test/apiTest/");
 
  /*
  * Add tow courses: SystemParallelProgramming, and Math1
@@ -121,7 +121,7 @@ TEST(ApiRouteTest, progressListAddGetRemove)
  */
  root.store();
  RootRoute rootRestored;
- rootRestored.setStorePath("../test/apiTest/");
+ rootRestored.setStorePath("./test/apiTest/");
  rootRestored.restore();
  EXPECT_EQ(2, rootRestored.courses.length());
  EXPECT_EQ(3, rootRestored.courses.get(0).students.length());

catflow/cpp/test/JsonObjectTest.cpp

@@ -73,14 +73,14 @@ TEST(JsonObjectTest, saveLoad)
 
  MyObject myObject;
  myObject.fromJson(val);
- myObject.save("../test/", "testJsonObject.json");
+ myObject.save("./test/", "testJsonObject.json");
  cout << "save finish" << endl;
 
 
  MyObject myObjectNew;
 
  cout << "now load" << endl;
- myObjectNew.load("../test/", "testJsonObject.json");
+ myObjectNew.load("./test/", "testJsonObject.json");
 
 
  EXPECT_EQ(20, myObjectNew.i);
@@ -221,7 +221,7 @@ TEST(JsonObjectTest, notifyParamsChanged)
  EXPECT_EQ(0, Catflow::requestsToSend.size());
 
  MyObject obj;
- obj.setStorePath("../test/jsonObjectTest");
+ obj.setStorePath("./test/jsonObjectTest");
  ApiRequest sub("", "subscribe");
  sub.client = new VoidClient();
  obj.processApi(sub);

frontend-angular/src/app/project/model-edit/model-editor/model-editor.component.html

@@ -18,6 +18,10 @@ <h5>Add Layer</h5>
  <div style="margin-top: 40px">
  <div class="btn waves-effect green" (click)="saveModel()">Save Model <i class="material-icons right">save</i></div>
  </div>
+
+ <a style="margin-top: 10px;" [ngClass]="modelValid ? 'green-text' : 'red-text'" class="btn white btn-flat no-select">{{modelValid ? 'Model is valid' : 'Model is invalid'}}
+ <i [ngClass]="modelValid ? 'green-text' : 'red-text'" class="material-icons red-text right">{{modelValid ? 'done' : 'warning'}}</i></a>
+
  <pre>{{modelJson | json}}</pre>
  </div>
 

frontend-angular/src/app/project/model-edit/model-editor/model-editor.component.ts

@@ -32,6 +32,7 @@ export class ModelEditorComponent implements OnInit, AfterViewInit, OnDestroy {
  nodes: ModelEditorNodeComponent[] = [];
  connections: ModelEditorConnectionComponent[] = [];
  modelJson: any[] = [];
+ modelValid: boolean = false;
 
  constructor(
  private el: ElementRef,
@@ -162,11 +163,16 @@ export class ModelEditorComponent implements OnInit, AfterViewInit, OnDestroy {
  this.networkObj = obj;
 
  // load graph
- this.networkObj.object().takeUntil(componentDestroyed(this)).takeUntil(this.onRefresh).subscribe((obj) => {
- if (obj == null)
+ this.networkObj.objectChanged().takeUntil(componentDestroyed(this)).takeUntil(this.onRefresh).subscribe((changed) => {
+ if (changed == null)
  return;
- this.modelJson = obj.modelDefinition;
- this.modelFromJson(this.modelJson);
+ if (changed.changedKeys.includes('modelDefinition')) {
+ this.modelJson = changed.object.modelDefinition;
+ this.modelFromJson(this.modelJson);
+ }
+ if (changed.changedKeys.includes('modelValid')) {
+ this.modelValid = changed.object.modelValid;
+ }
  });
  this.networkObj.subscribe();
  }