Merge pull request inveniosoftware-contrib#416 from harunurhan/fix-bugs

fix crash when config is changed on runtime and consistent undo

Author: harunurhan

src/json-editor.component.html

@@ -1,7 +1,7 @@
 <div id="ng2-json-editor" class="row editor-container" [ngClass]="shorterEditorContainerClass">
   <div *ngIf="!config.compact" class="col-md-2 menu-container">
-    <tree-menu [record]="_record" [schema]="schema"></tree-menu>
-    <add-field-dropdown [fields]="keys$ | async" [pathString]="pathString" [schema]="schema">Add field</add-field-dropdown>
+    <tree-menu [record]="_record" [schema]="fixedSchema"></tree-menu>
+    <add-field-dropdown [fields]="keys$ | async" [pathString]="pathString" [schema]="fixedSchema">Add field</add-field-dropdown>
     <hr>
     <div *ngIf="config.enableAdminModeSwitch" class="admin-mode" tooltip="Allows editing all fields (use with care)">
       <input id="admin-mode-checkbox" type="checkbox" [(ngModel)]="appGlobalsService.adminMode" />
@@ -11,13 +11,13 @@
     <bottom-console-badges (badgeClick)="openBottomConsole($event)"></bottom-console-badges>
   </div>
   <div id="middle-main-container" class="middle main-container" [ngClass]="middleContainerColMdClass" [shortcuts]="customShortcutKeys">
-    <add-field-dropdown *ngIf="config.compact" [fields]="keys$ | async" [pathString]="pathString" [schema]="schema">Add field</add-field-dropdown>    
+    <add-field-dropdown *ngIf="config.compact" [fields]="keys$ | async" [pathString]="pathString" [schema]="fixedSchema">Add field</add-field-dropdown>    
     <tabset *ngIf="config.tabsConfig">
       <tab *ngFor="let tabName of tabNames; trackBy:trackByElement" [heading]="tabName" (select)="activeTabName = tabName" [active]="isActiveTab(tabName)">
-        <sub-record [value]="_record" [tabName]="tabName" [schema]="schema" [keys]="keys$ | async" [pathString]="pathString"></sub-record>
+        <sub-record [value]="_record" [tabName]="tabName" [schema]="fixedSchema" [keys]="keys$ | async" [pathString]="pathString"></sub-record>
       </tab>
     </tabset>
-    <sub-record *ngIf="!config.tabsConfig" [value]="_record" [schema]="schema" [keys]="keys$ | async" [pathString]="pathString"></sub-record>
+    <sub-record *ngIf="!config.tabsConfig" [value]="_record" [schema]="fixedSchema" [keys]="keys$ | async" [pathString]="pathString"></sub-record>
   </div>
   <div id="right-main-container" *ngIf="!isPreviewerDisabled" [ngClass]="rightContainerColMdClass" class="main-container">
     <button id="btn-preview-toggle" type="button" class="btn btn-default btn-toggle" (click)="isPreviewerHidden = !isPreviewerHidden">{{isPreviewerHidden ? "Show Preview" : "Hide Preview"}}</button>

src/json-editor.component.ts

@@ -52,7 +52,13 @@ import {
   ErrorsService
 } from './shared/services';
 
-import { JsonEditorConfig, Preview, SchemaValidationErrors, JsonPatch, Shortcut, CustomShortcutKeys } from './shared/interfaces';
+import { JsonEditorConfig,
+  Preview,
+  SchemaValidationErrors,
+  JsonPatch,
+  Shortcut,
+  CustomShortcutKeys,
+  JSONSchema } from './shared/interfaces';
 
 
 @Component({
@@ -69,6 +75,7 @@ export class JsonEditorComponent extends AbstractTrackerComponent implements OnC
 
   @Input() config: JsonEditorConfig;
   @Input() record: object;
+  // original schema
   @Input() schema: any;
   @Input() errorMap: SchemaValidationErrors;
   @Input() jsonPatches: Array<JsonPatch>;
@@ -84,6 +91,8 @@ export class JsonEditorComponent extends AbstractTrackerComponent implements OnC
   isBottomConsoleOpen = false;
   bottomConsoleActiveTab = '';
   customShortcutKeys: CustomShortcutKeys;
+  // altered schema enchanced with configs
+  fixedSchema: JSONSchema;
 
   // used to decide if the [record] is change caused by recordChange.emit or parent component
   private lastEmittedRecord: object;
@@ -103,7 +112,7 @@ export class JsonEditorComponent extends AbstractTrackerComponent implements OnC
 
   ngOnInit() {
     this.appGlobalsService.adminMode$.subscribe(adminMode => {
-      this.keysStoreService.buildKeysMap(this._record, this.schema);
+      this.keysStoreService.buildKeysMap(this._record, this.fixedSchema);
     });
 
     // listen for all changes on json
@@ -146,15 +155,15 @@ export class JsonEditorComponent extends AbstractTrackerComponent implements OnC
     const schemaChanged = changes['schema'] || changes['config'];
 
     if (schemaChanged) {
-      this.schema = this.schemaFixerService.fixSchema(this.schema, this.config.schemaOptions);
-      this.jsonSchemaService.setSchema(this.schema);
+      this.fixedSchema = this.schemaFixerService.fixSchema(this.schema, this.config.schemaOptions);
+      this.jsonSchemaService.setSchema(this.fixedSchema);
     }
 
     if (schemaChanged || recordChanged) {
-      this.record = this.recordFixerService.fixRecord(this.record, this.schema);
+      this.record = this.recordFixerService.fixRecord(this.record, this.fixedSchema);
       this._record = fromJS(this.record);
       this.jsonStoreService.setJson(this._record);
-      this.keysStoreService.buildKeysMap(this._record, this.schema);
+      this.keysStoreService.buildKeysMap(this._record, this.fixedSchema);
     }
 
 

src/shared/services/json-store.service.ts

@@ -88,7 +88,8 @@ export class JsonStoreService {
       } else {
         list = list.insert(lastPathElement, value);
       }
-      this.setIn(pathWithoutIndex, list);
+      // allowUndo=false to avoid creating replace history patch when adding an item to a list.
+      this.setIn(pathWithoutIndex, list, false);
     } else {
       this.setIn(path, value);
     }

src/shared/services/schema-fixer.service.ts

@@ -40,7 +40,8 @@ export class SchemaFixerService {
    * @param config - schema specific options
    * @return {JSONSchema} - fixed schema
    */
-  fixSchema(schema: JSONSchema, config?: SchemaOptions): JSONSchema {
+  fixSchema(originalSchema: JSONSchema, config?: SchemaOptions): JSONSchema {
+    let schema = _.cloneDeep(originalSchema);
     if (config) {
       schema = this.enrichSchemaWithConfig(schema, config);
     }
@@ -114,7 +115,7 @@ export class SchemaFixerService {
     // fixes that needs above fixes to be done deeply for the current schema
     schema.componentType = this.componentTypeService.getComponentType(schema);
 
-    return Object.assign({}, schema);
+    return schema;
   }
 
   /**