From 14e5bf958bb2b114e3e7d8876bd6f031900c79ec Mon Sep 17 00:00:00 2001 From: ToineSiebelink Date: Thu, 27 Oct 2022 17:29:04 +0100 Subject: Ensure prefix is correct module prefix - Moved Prefix logic from RI to Service layer - Prefix is no PREFIX propety, not the moduel name! == RI (DB Layer) Changes - Removed prefix logic incl hazelcast - Added new basic ri-test for getDataNode and assert prefix is null - Updated exsiting ri-test to us getDataNode - Updated existing ri-test to only use " where really needed == CPS Service Layer Changes - Introduced PrefixResolver with clear and limited responsibility - Use PrefixResolver where needed - Cache prefix map per anchor, use cached entry when available - Disabled SONAR on new Regex == REST Layer - Use PrefixResolver where needed Issue-ID: CPS-1353 Signed-off-by: ToineSiebelink Change-Id: Ie16f0e1ee1c280f3eb69c9e64fab69a780fb692a --- .../onap/cps/spi/cache/AnchorDataCacheConfig.java | 72 ---------------------- .../onap/cps/spi/cache/AnchorDataCacheEntry.java | 44 ------------- .../spi/impl/CpsDataPersistenceServiceImpl.java | 59 +----------------- 3 files changed, 3 insertions(+), 172 deletions(-) delete mode 100644 cps-ri/src/main/java/org/onap/cps/spi/cache/AnchorDataCacheConfig.java delete mode 100644 cps-ri/src/main/java/org/onap/cps/spi/cache/AnchorDataCacheEntry.java (limited to 'cps-ri/src/main') diff --git a/cps-ri/src/main/java/org/onap/cps/spi/cache/AnchorDataCacheConfig.java b/cps-ri/src/main/java/org/onap/cps/spi/cache/AnchorDataCacheConfig.java deleted file mode 100644 index f956120e4a..0000000000 --- a/cps-ri/src/main/java/org/onap/cps/spi/cache/AnchorDataCacheConfig.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * ============LICENSE_START======================================================== - * Copyright (C) 2022 Nordix Foundation - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.cps.spi.cache; - -import com.hazelcast.config.Config; -import com.hazelcast.config.MapConfig; -import com.hazelcast.config.NamedConfig; -import com.hazelcast.core.Hazelcast; -import com.hazelcast.core.HazelcastInstance; -import com.hazelcast.map.IMap; -import java.util.concurrent.TimeUnit; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; - -/** - * Core infrastructure of the hazelcast distributed cache for anchor data config use cases. - */ -@Configuration -public class AnchorDataCacheConfig { - - public static final long ANCHOR_DATA_CACHE_TTL_SECS = TimeUnit.HOURS.toSeconds(1); - private static final MapConfig anchorDataCacheMapConfig = createMapConfig("anchorDataCacheMapConfig"); - - /** - * Distributed instance of anchor data cache that contains module prefix by anchor name as properties. - * - * @return configured map of anchor data cache - */ - @Bean - public IMap anchorDataCache() { - return createHazelcastInstance("hazelCastInstanceCpsRi", anchorDataCacheMapConfig) - .getMap("anchorDataCache"); - } - - private HazelcastInstance createHazelcastInstance(final String hazelcastInstanceName, - final NamedConfig namedConfig) { - return Hazelcast.newHazelcastInstance(initializeConfig(hazelcastInstanceName, namedConfig)); - } - - private Config initializeConfig(final String instanceName, final NamedConfig namedConfig) { - final Config config = new Config(instanceName); - config.addMapConfig((MapConfig) namedConfig); - config.setClusterName("cps-ri-caches"); - return config; - } - - private static MapConfig createMapConfig(final String configName) { - final MapConfig mapConfig = new MapConfig(configName); - mapConfig.setBackupCount(3); - mapConfig.setAsyncBackupCount(3); - return mapConfig; - } - -} diff --git a/cps-ri/src/main/java/org/onap/cps/spi/cache/AnchorDataCacheEntry.java b/cps-ri/src/main/java/org/onap/cps/spi/cache/AnchorDataCacheEntry.java deleted file mode 100644 index 98f6ec3f13..0000000000 --- a/cps-ri/src/main/java/org/onap/cps/spi/cache/AnchorDataCacheEntry.java +++ /dev/null @@ -1,44 +0,0 @@ -/* - * ============LICENSE_START======================================================== - * Copyright (C) 2022 Nordix Foundation - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.cps.spi.cache; - -import java.io.Serializable; -import java.util.HashMap; -import java.util.Map; - -public class AnchorDataCacheEntry implements Serializable { - - private static final long serialVersionUID = 2111243947810370698L; - - private Map properties = new HashMap<>(); - - public Object getProperty(final String propertyName) { - return properties.get(propertyName); - } - - public void setProperty(final String propertyName, final Object value) { - properties.put(propertyName, value); - } - - public boolean hasProperty(final String propertyName) { - return properties.containsKey(propertyName); - } -} diff --git a/cps-ri/src/main/java/org/onap/cps/spi/impl/CpsDataPersistenceServiceImpl.java b/cps-ri/src/main/java/org/onap/cps/spi/impl/CpsDataPersistenceServiceImpl.java index 2a4a192260..5fe646ff82 100644 --- a/cps-ri/src/main/java/org/onap/cps/spi/impl/CpsDataPersistenceServiceImpl.java +++ b/cps-ri/src/main/java/org/onap/cps/spi/impl/CpsDataPersistenceServiceImpl.java @@ -24,7 +24,6 @@ package org.onap.cps.spi.impl; import com.google.common.collect.ImmutableSet; import com.google.common.collect.ImmutableSet.Builder; -import com.hazelcast.map.IMap; import java.util.ArrayList; import java.util.Collection; import java.util.Collections; @@ -33,7 +32,6 @@ import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Set; -import java.util.concurrent.TimeUnit; import java.util.regex.Matcher; import java.util.regex.Pattern; import java.util.stream.Collectors; @@ -46,15 +44,11 @@ import org.onap.cps.cpspath.parser.CpsPathUtil; import org.onap.cps.cpspath.parser.PathParsingException; import org.onap.cps.spi.CpsDataPersistenceService; import org.onap.cps.spi.FetchDescendantsOption; -import org.onap.cps.spi.cache.AnchorDataCacheConfig; -import org.onap.cps.spi.cache.AnchorDataCacheEntry; import org.onap.cps.spi.entities.AnchorEntity; import org.onap.cps.spi.entities.DataspaceEntity; import org.onap.cps.spi.entities.FragmentEntity; import org.onap.cps.spi.entities.FragmentEntityArranger; import org.onap.cps.spi.entities.FragmentExtract; -import org.onap.cps.spi.entities.SchemaSetEntity; -import org.onap.cps.spi.entities.YangResourceEntity; import org.onap.cps.spi.exceptions.AlreadyDefinedException; import org.onap.cps.spi.exceptions.AlreadyDefinedExceptionBatch; import org.onap.cps.spi.exceptions.ConcurrencyException; @@ -68,8 +62,6 @@ import org.onap.cps.spi.repository.DataspaceRepository; import org.onap.cps.spi.repository.FragmentRepository; import org.onap.cps.spi.utils.SessionManager; import org.onap.cps.utils.JsonObjectMapper; -import org.onap.cps.yang.YangTextSchemaSourceSetBuilder; -import org.opendaylight.yangtools.yang.model.api.SchemaContext; import org.springframework.dao.DataIntegrityViolationException; import org.springframework.stereotype.Service; @@ -83,7 +75,6 @@ public class CpsDataPersistenceServiceImpl implements CpsDataPersistenceService private final FragmentRepository fragmentRepository; private final JsonObjectMapper jsonObjectMapper; private final SessionManager sessionManager; - private final IMap anchorDataCache; private static final String REG_EX_FOR_OPTIONAL_LIST_INDEX = "(\\[@[\\s\\S]+?]){0,1})"; private static final Pattern REG_EX_PATTERN_FOR_LIST_ELEMENT_KEY_PREDICATE = @@ -225,9 +216,7 @@ public class CpsDataPersistenceServiceImpl implements CpsDataPersistenceService final FetchDescendantsOption fetchDescendantsOption) { final FragmentEntity fragmentEntity = getFragmentByXpath(dataspaceName, anchorName, xpath, fetchDescendantsOption); - final DataNode dataNode = toDataNode(fragmentEntity, fetchDescendantsOption); - dataNode.setModuleNamePrefix(getRootModuleNamePrefix(fragmentEntity.getAnchor())); - return dataNode; + return toDataNode(fragmentEntity, fetchDescendantsOption); } private FragmentEntity getFragmentWithoutDescendantsByXpath(final String dataspaceName, @@ -285,12 +274,8 @@ public class CpsDataPersistenceServiceImpl implements CpsDataPersistenceService fragmentEntities = ancestorXpaths.isEmpty() ? Collections.emptyList() : fragmentRepository.findAllByAnchorAndXpathIn(anchorEntity, ancestorXpaths); } - return fragmentEntities.stream() - .map(fragmentEntity -> { - final DataNode dataNode = toDataNode(fragmentEntity, fetchDescendantsOption); - dataNode.setModuleNamePrefix(getRootModuleNamePrefix(anchorEntity)); - return dataNode; - }).collect(Collectors.toUnmodifiableList()); + return fragmentEntities.stream().map(fragmentEntity -> toDataNode(fragmentEntity, fetchDescendantsOption)) + .collect(Collectors.toUnmodifiableList()); } @Override @@ -337,44 +322,6 @@ public class CpsDataPersistenceServiceImpl implements CpsDataPersistenceService .withChildDataNodes(childDataNodes).build(); } - private String getRootModuleNamePrefix(final AnchorEntity anchorEntity) { - final String cachedModuleNamePrefix = getModuleNamePrefixFromCache(anchorEntity.getName()); - if (cachedModuleNamePrefix != null) { - return cachedModuleNamePrefix; - } - final String moduleNamePrefix = buildSchemaContextAndRetrieveModulePrefix(anchorEntity); - cacheModuleNamePrefix(anchorEntity.getName(), moduleNamePrefix); - return moduleNamePrefix; - } - - private String buildSchemaContextAndRetrieveModulePrefix(final AnchorEntity anchorEntity) { - final SchemaSetEntity schemaSetEntity = anchorEntity.getSchemaSet(); - final Map yangResourceNameToContent = - schemaSetEntity.getYangResources().stream().collect( - Collectors.toMap(YangResourceEntity::getFileName, YangResourceEntity::getContent)); - final SchemaContext schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent) - .getSchemaContext(); - return schemaContext.getModules().iterator().next().getName(); - } - - private void cacheModuleNamePrefix(final String anchorName, final String moduleNamePrefix) { - final AnchorDataCacheEntry anchorDataCacheEntry = new AnchorDataCacheEntry(); - anchorDataCacheEntry.setProperty(TOP_LEVEL_MODULE_PREFIX_PROPERTY_NAME, moduleNamePrefix); - if (anchorDataCache.putIfAbsent(anchorName, anchorDataCacheEntry, - AnchorDataCacheConfig.ANCHOR_DATA_CACHE_TTL_SECS, TimeUnit.SECONDS) == null) { - log.debug("Module name prefix for an anchor {} is cached", anchorName); - } - } - - private String getModuleNamePrefixFromCache(final String anchorName) { - if (anchorDataCache.containsKey(anchorName)) { - final AnchorDataCacheEntry anchorDataCacheEntry = anchorDataCache.get(anchorName); - return anchorDataCacheEntry.hasProperty(TOP_LEVEL_MODULE_PREFIX_PROPERTY_NAME) - ? anchorDataCacheEntry.getProperty(TOP_LEVEL_MODULE_PREFIX_PROPERTY_NAME).toString() : null; - } - return null; - } - private List getChildDataNodes(final FragmentEntity fragmentEntity, final FetchDescendantsOption fetchDescendantsOption) { if (fetchDescendantsOption.hasNext()) { -- cgit 1.2.3-korg