Fix/editor service functionality (#151)

* Fix auto save and validation logic

* Removed save latest model and fix update last saved rdf

Author: michelu89

core/libs/editor/src/lib/editor-toolbar/services/file-handling.service.ts

@@ -133,12 +133,11 @@ export class FileHandlingService {
         return of(null);
       }),
       finalize(() => {
+        this.modelSaveTracker.updateSavedModel(true);
         this.loadingScreenService.close();
-
         if (this.modelService.getLoadedAspectModel().rdfModel) {
           this.shapeSettingsStateService.closeShapeSettings();
         }
-
         this.sidebarService.workspace.close();
       }),
     );
@@ -226,6 +225,7 @@ export class FileHandlingService {
     }
 
     this.modelService.addAspect(null);
+    this.modelSaveTracker.updateSavedModel(true);
 
     const loadExternalModels$ = this.editorService
       .loadExternalModels(newRdfModel)
@@ -326,7 +326,6 @@ export class FileHandlingService {
       filter(overwrite => overwrite !== false),
       switchMap(() => (modelState.isNamespaceChanged ? this.handleNamespaceChange(modelState) : of(null))),
       map(() => {
-        this.editorService.updateLastSavedRdf(false, this.rdfService.serializeModel(this.rdfService.currentRdfModel), new Date());
         isChangeFileName = modelState.loadedFromWorkspace && modelState.isNameChanged && isOverwrite === null;
         isChangeNamespace = modelState.loadedFromWorkspace && modelState.isNamespaceChanged;
         return isChangeFileName || isChangeNamespace;

core/libs/editor/src/lib/editor.service.ts

@@ -34,14 +34,13 @@ import {
   delay,
   delayWhen,
   filter,
-  finalize,
   first,
   forkJoin,
   map,
   mergeMap,
   Observable,
   of,
-  retryWhen,
+  retry,
   Subscription,
   switchMap,
   tap,
@@ -86,9 +85,9 @@ export class EditorService {
   private filterAttributes: FilterAttributesService = inject(FILTER_ATTRIBUTES);
   private configurationService: ConfigurationService = inject(ConfigurationService);
 
-  private validateModel$ = new BehaviorSubject<boolean>(this.settings.autoValidationEnabled);
   private validateModelSubscription$: Subscription;
-  private lastSavedRDF$ = new BehaviorSubject<Partial<ILastSavedModel>>({});
+  private saveModelSubscription$: Subscription;
+
   private isAllShapesExpandedSubject = new BehaviorSubject<boolean>(true);
 
   public isAllShapesExpanded$ = this.isAllShapesExpandedSubject.asObservable();
@@ -123,7 +122,7 @@ export class EditorService {
     private titleService: TitleService,
     private sidebarService: SidebarStateService,
     private shapeSettingsStateService: ShapeSettingsStateService,
-    private modelSavingTrackerService: ModelSavingTrackerService,
+    private modelSavingTracker: ModelSavingTrackerService,
     private electronSignalsService: ElectronSignalsService,
     private largeFileWarningService: LargeFileWarningService,
     private loadingScreenService: LoadingScreenService,
@@ -137,22 +136,11 @@ export class EditorService {
     }
   }
 
-  removeLastSavedRdf() {
-    this.lastSavedRDF$.next({rdf: null, changed: true, date: null});
-  }
-
-  updateLastSavedRdf(changed: boolean, model: string, saveDate: Date) {
-    this.lastSavedRDF$.next({
-      changed: changed,
-      rdf: model,
-      date: saveDate,
-    });
-  }
-
   initCanvas(): void {
     this.mxGraphService.initGraph();
 
-    this.startValidateModel();
+    this.enableAutoValidation();
+    this.enableAutoSave();
 
     mxEvent.addMouseWheelListener(
       mxUtils.bind(this, (evt, up) => {
@@ -249,7 +237,6 @@ export class EditorService {
 
   loadNewAspectModel(payload: LoadModelPayload) {
     this.sidebarService.workspace.refresh();
-    this.removeLastSavedRdf();
     this.notificationsService.info({title: 'Loading model', timeout: 2000});
 
     let rdfModel: RdfModel = null;
@@ -266,7 +253,7 @@ export class EditorService {
         ),
       ),
       tap(() => {
-        this.modelSavingTrackerService.updateSavedModel();
+        this.modelSavingTracker.updateSavedModel();
         const [namespace, version, file] = (payload.namespaceFileName || this.rdfService.currentRdfModel.absoluteAspectModelFileName).split(
           ':',
         );
@@ -705,16 +692,14 @@ export class EditorService {
       });
   }
 
-  refreshValidateModel() {
-    this.validateModel$.next(this.settings.autoValidationEnabled);
+  enableAutoValidation() {
+    this.settings.autoValidationEnabled ? this.startValidateModel() : this.stopValidateModel();
   }
 
   startValidateModel() {
     this.stopValidateModel();
     localStorage.removeItem(ValidateStatus.validating);
-    if (this.settings.autoValidationEnabled) {
-      this.validateModelSubscription$ = this.validateModel().subscribe();
-    }
+    this.validateModelSubscription$ = this.autoValidateModel().subscribe();
   }
 
   stopValidateModel() {
@@ -724,30 +709,27 @@ export class EditorService {
     }
   }
 
-  validateModel(): Observable<ViolationError[]> {
-    return this.validateModel$.asObservable().pipe(
+  autoValidateModel(): Observable<ViolationError[]> {
+    return of({}).pipe(
       delayWhen(() => timer(this.settings.validationTimerSeconds * 1000)),
-      switchMap(() => this.validate().pipe(first())),
-      tap(() => {
-        localStorage.removeItem(ValidateStatus.validating);
-        this.refreshValidateModel();
+      switchMap(() => (this.namespaceCacheService.currentCachedFile.hasCachedElements() ? this.validate().pipe(first()) : of([]))),
+      tap(() => localStorage.removeItem(ValidateStatus.validating)),
+      tap(() => this.enableAutoValidation()),
+      retry({
+        delay: error => {
+          if (!Object.values(SaveValidateErrorsCodes).includes(error?.type)) {
+            this.logService.logError(`Error occurred while validating the current model (${error})`);
+            this.notificationsService.error({
+              title: this.translate.language.NOTIFICATION_SERVICE.VALIDATION_ERROR_TITLE,
+              message: this.translate.language.NOTIFICATION_SERVICE.VALIDATION_ERROR_MESSAGE,
+              timeout: 5000,
+            });
+          }
+          localStorage.removeItem(ValidateStatus.validating);
+
+          return timer(this.settings.validationTimerSeconds * 1000);
+        },
       }),
-      retryWhen(errors =>
-        errors.pipe(
-          tap(error => {
-            if (!Object.values(SaveValidateErrorsCodes).includes(error?.type)) {
-              this.logService.logError(`Error occurred while validating the current model (${error})`);
-              this.notificationsService.error({
-                title: this.translate.language.NOTIFICATION_SERVICE.VALIDATION_ERROR_TITLE,
-                message: this.translate.language.NOTIFICATION_SERVICE.VALIDATION_ERROR_MESSAGE,
-                timeout: 5000,
-              });
-            }
-            localStorage.removeItem(ValidateStatus.validating);
-          }),
-          delayWhen(() => timer(this.settings.validationTimerSeconds * 1000)),
-        ),
-      ),
     );
   }
 
@@ -770,9 +752,41 @@ export class EditorService {
     );
   }
 
-  saveModel() {
+  enableAutoSave(): void {
+    this.settings.autoSaveEnabled ? this.startSaveModel() : this.stopSaveModel();
+  }
+
+  startSaveModel(): void {
+    this.stopSaveModel();
+    this.saveModelSubscription$ = this.autoSaveModel().subscribe();
+  }
+
+  stopSaveModel() {
+    if (this.saveModelSubscription$) {
+      this.saveModelSubscription$.unsubscribe();
+    }
+  }
+
+  autoSaveModel(): Observable<RdfModel | object> {
+    return of({}).pipe(
+      delayWhen(() => timer(this.settings.saveTimerSeconds * 1000)),
+      switchMap(() =>
+        this.namespaceCacheService.currentCachedFile.hasCachedElements() &&
+        !this.rdfService.currentRdfModel.aspectModelFileName.includes('empty.ttl')
+          ? this.saveModel().pipe(first())
+          : of([]),
+      ),
+      tap(() => this.enableAutoSave()),
+      retry({
+        delay: () => timer(this.settings.saveTimerSeconds * 1000),
+      }),
+    );
+  }
+
+  saveModel(): Observable<RdfModel | object> {
     return this.modelService.saveModel().pipe(
       tap(() => {
+        this.modelSavingTracker.updateSavedModel();
         this.notificationsService.info({title: this.translate.language.NOTIFICATION_SERVICE.ASPECT_SAVED_SUCCESS});
         this.logService.logInfo('Aspect model was saved to the local folder');
         this.sidebarService.workspace.refresh();

core/libs/namespace-manager/src/lib/namespace-exporter/namespace-exporter-router.module.ts

@@ -13,7 +13,7 @@
 
 import {NgModule} from '@angular/core';
 import {RouterModule, Routes} from '@angular/router';
-import {ErrorComponent} from '../shared/components';
+import {ErrorComponent} from '../shared';
 import {SelectNamespacesComponent, ExportSummaryComponent, ExportValidateComponent} from './components';
 
 const routes: Routes = [

core/libs/rdf/src/lib/services/rdf.service.ts

@@ -27,12 +27,19 @@ import {LanguageTranslationService} from '@ame/translation';
   providedIn: 'root',
 })
 export class RdfService {
-  private _latestSavedRDF: string;
   private _rdfSerializer: RdfSerializerService;
   private _settings: Settings;
+  private _currentModel: RdfModel;
 
   public externalRdfModels: Array<RdfModel> = [];
-  public currentRdfModel: RdfModel;
+
+  get currentRdfModel(): RdfModel {
+    return this._currentModel;
+  }
+
+  set currentRdfModel(value: RdfModel) {
+    this._currentModel = value;
+  }
 
   constructor(
     private logService: LogService,
@@ -79,26 +86,6 @@ export class RdfService {
     );
   }
 
-  saveLatestModel(rdfModel: RdfModel): Observable<{serializedModel: string; savedDate: Date}> {
-    if (!rdfModel) {
-      this.logService.logInfo('Model is null. Skipping saving.');
-      return this.handleError(SaveValidateErrorsCodes.emptyModel);
-    }
-
-    const serializedModel = this.serializeModel(rdfModel);
-    if (this._latestSavedRDF === serializedModel) {
-      this.logService.logInfo('Model not changed. Skipping saving');
-      return this.handleError(SaveValidateErrorsCodes.notChangedModel);
-    }
-
-    return this.modelApiService.saveLatest(serializedModel).pipe(
-      map(() => {
-        this._latestSavedRDF = serializedModel;
-        return {serializedModel, savedDate: new Date()};
-      }),
-    );
-  }
-
   private handleError(errorCode: SaveValidateErrorsCodes): Observable<never> {
     return throwError(() => ({type: errorCode}));
   }

core/libs/rdf/src/lib/utils/rdf-model.ts

@@ -13,7 +13,7 @@
 
 import {DataFactory, NamedNode, Prefixes, Quad, Quad_Graph, Quad_Object, Quad_Predicate, Quad_Subject, Store, Util, Writer} from 'n3';
 import * as locale from 'locale-codes';
-import {InstantiatorListElement} from '../models/rdf-model.types';
+import {InstantiatorListElement} from '@ame/rdf/models';
 import {Samm, SammC, SammE, SammU} from '@ame/vocabulary';
 import {RdfModelUtil} from '@ame/rdf/utils/rdf-model-util';
 import {config} from '@ame/shared';

core/libs/settings-dialog/src/lib/services/configuration.service.ts

@@ -94,12 +94,6 @@ export class ConfigurationService {
     return this.settings || DEFAULT_SETTINGS;
   }
 
-  toggleEditorNavigation() {
-    // Mutates the original object. Can be removed once all components start relying on Observable stream.
-    this.settings.showEditorNav = !this.settings.showEditorNav;
-    this.setSettings(this.settings);
-  }
-
   toggleEditorMap() {
     // Mutates the original object. Can be removed once all components start relying on Observable stream.
     this.settings.showEditorMap = !this.settings.showEditorMap;

core/libs/settings-dialog/src/lib/strategy/automated-workflow-update.strategy.ts

@@ -33,6 +33,7 @@ export class AutomatedWorkflowUpdateStrategy implements SettingsUpdateStrategy {
     settings.validationTimerSeconds = automatedWorkflow.get('validationTimerSeconds')?.value;
     settings.autoFormatEnabled = automatedWorkflow.get('autoFormatEnabled')?.value;
 
-    if (settings.autoValidationEnabled) this.editorService.refreshValidateModel();
+    if (settings.autoValidationEnabled) this.editorService.enableAutoValidation();
+    if (settings.autoSaveEnabled) this.editorService.enableAutoSave();
   }
 }

core/libs/shared/src/lib/services/model-saving-tracker.service.ts

@@ -14,14 +14,15 @@
 import {ModelService, RdfService} from '@ame/rdf/services';
 import {MxGraphService} from '@ame/mx-graph';
 import {Injectable, inject} from '@angular/core';
-import {map, take} from 'rxjs';
+import {map, take, Timestamp} from 'rxjs';
 
 @Injectable({providedIn: 'root'})
 export class ModelSavingTrackerService {
   private modelService = inject(ModelService);
   private rdfService = inject(RdfService);
   private mxGraphService = inject(MxGraphService);
   private savedModel: string;
+  private firstLoad: boolean;
 
   private get currentModel$() {
     return this.modelService.synchronizeModelToRdf().pipe(
@@ -31,10 +32,15 @@ export class ModelSavingTrackerService {
   }
 
   public get isSaved$() {
-    return this.currentModel$.pipe(map(currentModel => this.savedModel === currentModel || !this.mxGraphService.getAllCells()?.length));
+    return this.currentModel$.pipe(
+      map(currentModel => (!this.firstLoad && this.savedModel === currentModel) || !this.mxGraphService.getAllCells()?.length),
+    );
   }
 
-  public updateSavedModel() {
-    this.currentModel$.subscribe(currentModel => (this.savedModel = currentModel));
+  public updateSavedModel(firstLoad = false) {
+    this.currentModel$.subscribe(currentModel => {
+      this.firstLoad = firstLoad;
+      this.savedModel = currentModel;
+    });
   }
 }

core/libs/sidebar/src/lib/workspace/workspace-file-list/workspace-file-list.component.ts

@@ -175,7 +175,6 @@ export class WorkspaceFileListComponent implements OnInit, OnDestroy {
       .subscribe(confirmed => {
         if (confirmed) {
           const serializeModel = this.rdfService.serializeModel(this.rdfService.currentRdfModel);
-          this.editorService.updateLastSavedRdf(false, serializeModel, new Date());
           this.editorService.saveModel().subscribe();
         }
         // TODO improve this functionality