catalog-ui/src/app/ng2/pages/attributes-outputs/services/attributes.utils.ts

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2021 Nordix Foundation. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 import * as _ from "lodash";
  22 import { Injectable } from '@angular/core';
  23 import { DataTypeService } from "app/ng2/services/data-type.service";
  24 import { PROPERTY_TYPES } from "app/utils";
  25 import { AttributesService } from "app/ng2/services/attributes.service";
  26 import { InstanceBeAttributesMap, InstanceFeAttributesMap } from "app/models/attributes-outputs/attribute-fe-map";
  27 import { InstanceBePropertiesMap } from "app/models/properties-inputs/property-fe-map";
  28 import {OutputFEModel} from "../../../../models/attributes-outputs/output-fe-model";
  29 import { AttributeBEModel, DerivedAttributeType } from "app/models/attributes-outputs/attribute-be-model";
  30 import { AttributeFEModel } from "app/models/attributes-outputs/attribute-fe-model";
  31 import { DerivedFEAttribute } from "app/models/attributes-outputs/derived-fe-attribute";
  32 import { DataTypeModel } from "app/models";
  33
  34 @Injectable()
  35 export class AttributesUtils {
  36
  37     constructor(private dataTypeService:DataTypeService, private attributesService: AttributesService) {}
  38
  39     /**
  40      * Entry point when getting attributes from server
  41      * For each instance, loop through each property, and:
  42      * 1. Create flattened children
  43      * 2. Check against outputs to see if any props are declared and disable them
  44      * 3. Initialize valueObj (which also creates any new list/map flattened children as needed)
  45      * Returns InstanceFeAttributesMap
  46      */
  47     public convertAttributesMapToFEAndCreateChildren = (instanceAttributesMap:InstanceBeAttributesMap | InstanceBePropertiesMap, isVF:boolean, outputs?:Array<OutputFEModel>): InstanceFeAttributesMap => {
  48         let instanceFeAttributesMap:InstanceFeAttributesMap = new InstanceFeAttributesMap();
  49         angular.forEach(instanceAttributesMap, (attributes:Array<AttributeBEModel>, instanceId:string) => {
  50             let propertyFeArray: Array<AttributeFEModel> = [];
  51             _.forEach(attributes, (property: AttributeBEModel) => {
  52
  53                 if (this.dataTypeService.getDataTypeByTypeName(property.type)) { // if type not exist in data types remove property from list
  54
  55                     let newFEAttrib: AttributeFEModel = new AttributeFEModel(property); //Convert property to FE
  56
  57                     this.initValueObjectRef(newFEAttrib); //initialize valueObj AND creates flattened children
  58                     propertyFeArray.push(newFEAttrib);
  59                     newFEAttrib.updateExpandedChildAttributeId(newFEAttrib.name); //display only the first level of children
  60
  61                     //if this prop (or any children) are declared, set isDeclared and disable checkbox on parents/children
  62                     if (newFEAttrib.getOutputValues && newFEAttrib.getOutputValues.length) {
  63                         newFEAttrib.getOutputValues.forEach(propOutputDetail => {
  64                             let outputPath = propOutputDetail.outputPath;
  65                             if (!outputPath) { //TODO: this is a workaround until Marina adds outputPath
  66                                 let output = outputs.find(output => output.uniqueId == propOutputDetail.outputId);
  67                                 if (!output) { console.log("CANNOT FIND INPUT FOR " + propOutputDetail.outputId); return; }
  68                                 else outputPath = output.outputPath;
  69                             }
  70                             if (outputPath == newFEAttrib.name) outputPath = undefined; // if not complex we need to remove the outputPath from FEModel so we not look for a child
  71                             newFEAttrib.setAsDeclared(outputPath); //if a path is sent, its a child prop. this param is optional
  72                             this.attributesService.disableRelatedAttributes(newFEAttrib, outputPath);
  73                         });
  74                     }
  75                 }
  76             });
  77             instanceFeAttributesMap[instanceId] = propertyFeArray;
  78
  79         });
  80         return instanceFeAttributesMap;
  81     }
  82
  83     public convertAddAttributeBEToAttributeFE = (property: AttributeBEModel): AttributeFEModel => {
  84         const newFEProp: AttributeFEModel = new AttributeFEModel(property); //Convert property to FE
  85         this.initValueObjectRef(newFEProp);
  86         newFEProp.updateExpandedChildAttributeId(newFEProp.name); //display only the first level of children
  87         return newFEProp;
  88     }
  89
  90     public createListOrMapChildren = (property:AttributeFEModel | DerivedFEAttribute, key: string, valueObj: any): Array<DerivedFEAttribute> => {
  91         let newProps: Array<DerivedFEAttribute> = [];
  92         let parentProp = new DerivedFEAttribute(property, property.attributesName, true, key, valueObj);
  93         newProps.push(parentProp);
  94
  95         if (!property.schema.property.isSimpleType) {
  96             let additionalChildren:Array<DerivedFEAttribute> = this.createFlattenedChildren(property.schema.property.type, parentProp.attributesName);
  97             this.assignFlattenedChildrenValues(parentProp.valueObj, additionalChildren, parentProp.attributesName);
  98             additionalChildren.forEach(prop => prop.canBeDeclared = false);
  99             newProps.push(...additionalChildren);
 100         }
 101         return newProps;
 102     }
 103
 104     /**
 105      * Creates derivedFEAttributes of a specified type and returns them.
 106      */
 107     private createFlattenedChildren = (type: string, parentName: string):Array<DerivedFEAttribute> => {
 108         let tempProps: Array<DerivedFEAttribute> = [];
 109         let dataTypeObj: DataTypeModel = this.dataTypeService.getDataTypeByTypeName(type);
 110         this.dataTypeService.getDerivedDataTypeAttributes(dataTypeObj, tempProps, parentName);
 111         return _.sortBy(tempProps, ['propertiesName']);
 112     }
 113
 114     /* Sets the valueObj of parent property and its children.
 115     * Note: This logic is different than assignflattenedchildrenvalues - here we merge values, there we pick either the parents value, props value, or default value - without merging.
 116     */
 117     public initValueObjectRef = (attribute: AttributeFEModel): void => {
 118         attribute.resetValueObjValidation();
 119         if (attribute.isDeclared) { //if attribute is declared, it gets a simple output instead. List and map values and pseudo-children will be handled in attribute component
 120             attribute.valueObj = attribute.value || attribute.defaultValue || null;  // use null for empty value object
 121             if (attribute.valueObj && typeof attribute.valueObj == 'object') {
 122                 attribute.valueObj = JSON.stringify(attribute.valueObj);
 123             }
 124         } else {
 125             attribute.valueObj = attribute.getValueObj();
 126             if (attribute.derivedDataType == DerivedAttributeType.LIST || attribute.derivedDataType == DerivedAttributeType.MAP) {
 127                 attribute.flattenedChildren = [];
 128                 Object.keys(attribute.valueObj).forEach((key) => {
 129                     attribute.flattenedChildren.push(...this.createListOrMapChildren(attribute, key, attribute.valueObj[key]))
 130                 });
 131             } else if (attribute.derivedDataType === DerivedAttributeType.COMPLEX) {
 132                 attribute.flattenedChildren = this.createFlattenedChildren(attribute.type, attribute.name);
 133                 this.assignFlattenedChildrenValues(attribute.valueObj, attribute.flattenedChildren, attribute.name);
 134                 attribute.flattenedChildren.forEach((childProp) => {
 135                     attribute.childPropUpdated(childProp);
 136                 });
 137             }
 138         }
 139         attribute.updateValueObjOrig();
 140     };
 141
 142     /*
 143     * Loops through flattened attributes array and to assign values
 144     * Then, convert any neccessary strings to objects, and vis-versa
 145     * For list or map property, creates new children props if valueObj has values
 146     */
 147     public assignFlattenedChildrenValues = (parentValueJSON: any, derivedPropArray: Array<DerivedFEAttribute>, parentName: string) => {
 148         if (!derivedPropArray || !parentName) return;
 149         let propsToPushMap: Map<number, Array<DerivedFEAttribute>> = new Map<number, Array<DerivedFEAttribute>>();
 150         derivedPropArray.forEach((prop, index) => {
 151
 152             let propNameInObj = prop.attributesName.substring(prop.attributesName.indexOf(parentName) + parentName.length + 1).split('#').join('.'); //extract everything after parent name
 153             prop.valueObj = _.get(parentValueJSON, propNameInObj, prop.value || prop.defaultValue || null); //assign value -first value of parent if exists. If not, prop.value if not, prop.defaultvalue
 154             prop.value = (prop.valueObj !== null && (typeof prop.valueObj) != 'string') ? JSON.stringify(prop.valueObj) : prop.valueObj;
 155
 156             if ((prop.isDeclared || prop.type == PROPERTY_TYPES.STRING || prop.type == PROPERTY_TYPES.JSON)) { //Stringify objects of items that are declared or from type string/json
 157                 prop.valueObj = (prop.valueObj !== null && typeof prop.valueObj == 'object') ? JSON.stringify(prop.valueObj) : prop.valueObj;
 158             } else if(prop.type == PROPERTY_TYPES.INTEGER || prop.type == PROPERTY_TYPES.FLOAT || prop.type == PROPERTY_TYPES.BOOLEAN){ //parse ints and non-string simple types
 159                 prop.valueObj = (prop.valueObj !== null && typeof prop.valueObj == PROPERTY_TYPES.STRING) ? JSON.parse(prop.valueObj) : prop.valueObj;
 160             } else { //parse strings that should be objects
 161                 if (prop.derivedDataType == DerivedAttributeType.COMPLEX) {
 162                     prop.valueObj = (prop.valueObj === null || typeof prop.valueObj != 'object') ? JSON.parse(prop.valueObj || '{}') : prop.valueObj;
 163                 } else if (prop.derivedDataType == DerivedAttributeType.LIST) {
 164                     prop.valueObj = (prop.valueObj === null || typeof prop.valueObj != 'object') ? JSON.parse(prop.valueObj || '[]') : prop.valueObj;
 165                 } else if (prop.derivedDataType == DerivedAttributeType.MAP) {
 166                     if (!prop.isChildOfListOrMap || !prop.schema.property.isSimpleType) {
 167                         prop.valueObj = (prop.valueObj === null || typeof prop.valueObj != 'object') ? JSON.parse(prop.valueObj || '{}') : prop.valueObj;
 168                     }
 169                 }
 170                 if ((prop.derivedDataType == DerivedAttributeType.LIST || prop.derivedDataType == DerivedAttributeType.MAP) && typeof prop.valueObj == 'object' && prop.valueObj !== null && Object.keys(prop.valueObj).length) {
 171                     let newProps: Array<DerivedFEAttribute> = [];
 172                     Object.keys(prop.valueObj).forEach((key) => {
 173                         newProps.push(...this.createListOrMapChildren(prop, key, prop.valueObj[key]));//create new children, assign their values, and then add to array
 174                     });
 175                     propsToPushMap[index + 1] = newProps;
 176                 }
 177             }
 178
 179             prop.valueObj = AttributeFEModel.cleanValueObj(prop.valueObj);
 180         });
 181
 182         //add props after we're done looping (otherwise our loop gets messed up). Push in reverse order, so we dont mess up indexes.
 183         Object.keys(propsToPushMap).reverse().forEach((indexToInsert) => {
 184             derivedPropArray.splice(+indexToInsert, 0, ...propsToPushMap[indexToInsert]); //slacker parsing
 185         });
 186     }
 187
 188     public resetAttributeValue = (attribute: AttributeFEModel, newValue: string, nestedPath?: string): void => {
 189         attribute.value = newValue;
 190         if (nestedPath) {
 191             let newAttrib = attribute.flattenedChildren.find(attrib => attrib.attributesName == nestedPath);
 192             newAttrib && this.assignFlattenedChildrenValues(JSON.parse(newValue), [newAttrib], attribute.name);
 193             attribute.updateValueObjOrig();
 194         } else {
 195             this.initValueObjectRef(attribute);
 196         }
 197     }
 198
 199 }