Skip to content

Commit

Permalink
fix(cache): cache does not update correctly when an ontology is modif…
Browse files Browse the repository at this point in the history 
…ied (DEV-939) (#2068)

* tests: write test to reproduce the bug at hand (should fail for now)

* feat: use new cacheUpdatedOntology method

* fix: update subclasses in case of editing an ontology

* refactor: make direct cache access private to enforce using a clean API

* refactor: rename method

* ensure to avoid race conditions in cache

* docs: add docstrings

* refactor: remove some code duplication

* remove unused code

* use correct cache method for class deletion

* restore original makeOntologyCache method

* fix typo

Co-authored-by: Marcin Procyk <marcin.procyk@dasch.swiss>

Co-authored-by: irinaschubert <irina.schubert@dasch.swiss>
Co-authored-by: Marcin Procyk <marcin.procyk@dasch.swiss>
  • Loading branch information
@BalduinLandolt @mpro7
3 people committed May 25, 2022
1 parent 179ad19 commit 8541519
Show file tree
Hide file tree
Showing 8 changed files with 498 additions and 215 deletions.
198 changes: 40 additions & 158 deletions webapi/src/main/scala/org/knora/webapi/responders/v2/OntologyResponderV2.scala
View file
Expand Up @@ -20,6 +20,7 @@ import org.knora.webapi.messages.store.triplestoremessages.SmartIriLiteralV2
import org.knora.webapi.messages.store.triplestoremessages.SparqlUpdateRequest
import org.knora.webapi.messages.store.triplestoremessages.SparqlUpdateResponse
import org.knora.webapi.messages.store.triplestoremessages.StringLiteralV2
import scala.concurrent.duration._
import org.knora.webapi.messages.util.ErrorHandlingMap
import org.knora.webapi.messages.util.ResponderData
import org.knora.webapi.messages.v2.responder.CanDoResponseV2
Expand All @@ -37,6 +38,10 @@ import org.knora.webapi.util._

import java.time.Instant
import scala.concurrent.Future
import scala.concurrent.Await
import org.knora.webapi.messages.util.KnoraSystemInstances
import org.knora.webapi.feature.TestFeatureFactoryConfig
import org.knora.webapi.feature.KnoraSettingsFeatureFactoryConfig

/**
* Responds to requests dealing with ontologies.
Expand Down Expand Up @@ -585,13 +590,10 @@ class OntologyResponderV2(responderData: ResponderData) extends Responder(respon

// Update the ontology cache with the unescaped metadata.

_ =
Cache.storeCacheData(
cacheData.copy(
ontologies =
cacheData.ontologies + (internalOntologyIri -> ReadOntologyV2(ontologyMetadata = unescapedNewMetadata))
)
)
_ <- Cache.cacheUpdatedOntologyWithoutUpdatingMaps(
internalOntologyIri,
ReadOntologyV2(ontologyMetadata = unescapedNewMetadata)
)

} yield ReadOntologyMetadataV2(ontologies = Set(unescapedNewMetadata))

Expand Down Expand Up @@ -741,14 +743,13 @@ class OntologyResponderV2(responderData: ResponderData) extends Responder(respon
}

// Update the ontology cache with the unescaped metadata.

_ = Cache.storeCacheData(
cacheData.copy(
ontologies = cacheData.ontologies + (internalOntologyIri -> cacheData
.ontologies(internalOntologyIri)
.copy(ontologyMetadata = unescapedNewMetadata))
)
)
updatedOntology = cacheData
.ontologies(internalOntologyIri)
.copy(ontologyMetadata = unescapedNewMetadata)
_ <- Cache.cacheUpdatedOntologyWithoutUpdatingMaps(
internalOntologyIri,
updatedOntology
)

} yield ReadOntologyMetadataV2(ontologies = Set(unescapedNewMetadata))

Expand Down Expand Up @@ -840,13 +841,10 @@ class OntologyResponderV2(responderData: ResponderData) extends Responder(respon

// Update the ontology cache with the unescaped metadata.

_ = Cache.storeCacheData(
cacheData.copy(
ontologies = cacheData.ontologies + (internalOntologyIri -> cacheData
.ontologies(internalOntologyIri)
.copy(ontologyMetadata = unescapedNewMetadata))
)
)
updatedOntology = cacheData
.ontologies(internalOntologyIri)
.copy(ontologyMetadata = unescapedNewMetadata)
_ <- Cache.cacheUpdatedOntologyWithoutUpdatingMaps(internalOntologyIri, updatedOntology)

} yield ReadOntologyMetadataV2(ontologies = Set(unescapedNewMetadata))

Expand Down Expand Up @@ -1036,23 +1034,14 @@ class OntologyResponderV2(responderData: ResponderData) extends Responder(respon

// Update the cache.

updatedSubClassOfRelations = cacheData.subClassOfRelations + (internalClassIri -> allBaseClassIris)
updatedSuperClassOfRelations = OntologyHelpers.calculateSuperClassOfRelations(updatedSubClassOfRelations)

updatedOntology = ontology.copy(
ontologyMetadata = ontology.ontologyMetadata.copy(
lastModificationDate = Some(currentTime)
),
classes = ontology.classes + (internalClassIri -> readClassInfo)
)

_ = Cache.storeCacheData(
cacheData.copy(
ontologies = cacheData.ontologies + (internalOntologyIri -> updatedOntology),
subClassOfRelations = updatedSubClassOfRelations,
superClassOfRelations = updatedSuperClassOfRelations
)
)
_ <- Cache.cacheUpdatedOntologyWithClass(internalOntologyIri, updatedOntology, internalClassIri)

// Read the data back from the cache.

Expand Down Expand Up @@ -1234,14 +1223,7 @@ class OntologyResponderV2(responderData: ResponderData) extends Responder(respon

// Update subclasses and write the cache.

_ = Cache.storeCacheData(
Cache.updateSubClasses(
baseClassIri = internalClassIri,
cacheData = cacheData.copy(
ontologies = cacheData.ontologies + (internalOntologyIri -> updatedOntology)
)
)
)
_ <- Cache.cacheUpdatedOntologyWithClass(internalOntologyIri, updatedOntology, internalClassIri)

// Read the data back from the cache.

Expand Down Expand Up @@ -1481,14 +1463,7 @@ class OntologyResponderV2(responderData: ResponderData) extends Responder(respon
classes = ontology.classes + (internalClassIri -> readClassInfo)
)

_ = Cache.storeCacheData(
Cache.updateSubClasses(
baseClassIri = internalClassIri,
cacheData = cacheData.copy(
ontologies = cacheData.ontologies + (internalOntologyIri -> updatedOntology)
)
)
)
_ <- Cache.cacheUpdatedOntologyWithClass(internalOntologyIri, updatedOntology, internalClassIri)

// Read the data back from the cache.

Expand Down Expand Up @@ -1739,11 +1714,7 @@ class OntologyResponderV2(responderData: ResponderData) extends Responder(respon
classes = ontology.classes + (internalClassIri -> readClassInfo)
)

_ = Cache.storeCacheData(
cacheData.copy(
ontologies = cacheData.ontologies + (internalOntologyIri -> updatedOntology)
)
)
_ <- Cache.cacheUpdatedOntologyWithClass(internalOntologyIri, updatedOntology, internalClassIri)

// Read the data back from the cache.

Expand Down Expand Up @@ -1964,20 +1935,8 @@ class OntologyResponderV2(responderData: ResponderData) extends Responder(respon
classes = ontology.classes - internalClassIri
)

updatedSubClassOfRelations =
(cacheData.subClassOfRelations - internalClassIri).map { case (subClass, baseClasses) =>
subClass -> (baseClasses.toSet - internalClassIri).toSeq
}

updatedSuperClassOfRelations = OntologyHelpers.calculateSuperClassOfRelations(updatedSubClassOfRelations)
_ <- Cache.cacheUpdatedOntology(internalOntologyIri, updatedOntology)

_ = Cache.storeCacheData(
cacheData.copy(
ontologies = cacheData.ontologies + (internalOntologyIri -> updatedOntology),
subClassOfRelations = updatedSubClassOfRelations,
superClassOfRelations = updatedSuperClassOfRelations
)
)
} yield ReadOntologyMetadataV2(Set(updatedOntology.ontologyMetadata))

for {
Expand Down Expand Up @@ -2141,24 +2100,16 @@ class OntologyResponderV2(responderData: ResponderData) extends Responder(respon

propertiesToRemoveFromCache = Set(internalPropertyIri) ++ maybeInternalLinkValuePropertyIri

updatedOntology = ontology.copy(
ontologyMetadata = ontology.ontologyMetadata.copy(
lastModificationDate = Some(currentTime)
),
properties = ontology.properties -- propertiesToRemoveFromCache
)
updatedOntology =
ontology.copy(
ontologyMetadata = ontology.ontologyMetadata.copy(
lastModificationDate = Some(currentTime)
),
properties = ontology.properties -- propertiesToRemoveFromCache
)

updatedSubPropertyOfRelations =
(cacheData.subPropertyOfRelations -- propertiesToRemoveFromCache).map { case (subProperty, baseProperties) =>
subProperty -> (baseProperties -- propertiesToRemoveFromCache)
}
_ <- Cache.cacheUpdatedOntology(internalOntologyIri, updatedOntology)

_ = Cache.storeCacheData(
cacheData.copy(
ontologies = cacheData.ontologies + (internalOntologyIri -> updatedOntology),
subPropertyOfRelations = updatedSubPropertyOfRelations
)
)
} yield ReadOntologyMetadataV2(Set(updatedOntology.ontologyMetadata))

for {
Expand Down Expand Up @@ -2274,35 +2225,7 @@ class OntologyResponderV2(responderData: ResponderData) extends Responder(respon
}

// Remove the ontology from the cache.

updatedSubClassOfRelations = cacheData.subClassOfRelations.filterNot { case (subClass, _) =>
subClass.getOntologyFromEntity == internalOntologyIri
}.map { case (subClass, baseClasses) =>
subClass -> baseClasses.filterNot(_.getOntologyFromEntity == internalOntologyIri)
}

updatedSuperClassOfRelations = OntologyHelpers.calculateSuperClassOfRelations(updatedSubClassOfRelations)

updatedSubPropertyOfRelations = cacheData.subPropertyOfRelations.filterNot { case (subProperty, _) =>
subProperty.getOntologyFromEntity == internalOntologyIri
}.map { case (subProperty, baseProperties) =>
subProperty -> baseProperties.filterNot(
_.getOntologyFromEntity == internalOntologyIri
)
}

updatedStandoffProperties =
cacheData.standoffProperties.filterNot(_.getOntologyFromEntity == internalOntologyIri)

updatedCacheData = cacheData.copy(
ontologies = cacheData.ontologies - internalOntologyIri,
subClassOfRelations = updatedSubClassOfRelations,
superClassOfRelations = updatedSuperClassOfRelations,
subPropertyOfRelations = updatedSubPropertyOfRelations,
standoffProperties = updatedStandoffProperties
)

_ = Cache.storeCacheData(updatedCacheData)
_ <- Cache.deleteOntology(internalOntologyIri)
} yield SuccessResponseV2(s"Ontology ${internalOntologyIri.toOntologySchema(ApiV2Complex)} has been deleted")

for {
Expand Down Expand Up @@ -2644,28 +2567,7 @@ class OntologyResponderV2(responderData: ResponderData) extends Responder(respon
ontology.properties ++ maybeLinkValuePropertyCacheEntry + (internalPropertyIri -> readPropertyInfo)
)

// if a link value property was created, add its subproperty relation to the ontology's subPropertyOfRelations map
// note: this is only needed for the special case of link properties that are subproperties of custom link properties

maybeSubPropertyOfRelationsForLinkValueProperty: Option[(SmartIri, Set[SmartIri])] =
maybeLinkValuePropertyCacheEntry.map { case (smartIri: SmartIri, readPropertyInfoV2: ReadPropertyInfoV2) =>
smartIri -> readPropertyInfoV2.entityInfoContent.subPropertyOf
}

newSubPropertyOfRelations: Map[SmartIri, Set[SmartIri]] =
maybeSubPropertyOfRelationsForLinkValueProperty match {
case Some(smartIriSetOfSmartIris: (SmartIri, Set[SmartIri])) =>
Map(internalPropertyIri -> allKnoraSuperPropertyIris, smartIriSetOfSmartIris)
case None =>
Map(internalPropertyIri -> allKnoraSuperPropertyIris)
}

_ = Cache.storeCacheData(
cacheData.copy(
ontologies = cacheData.ontologies + (internalOntologyIri -> updatedOntology),
subPropertyOfRelations = cacheData.subPropertyOfRelations ++ newSubPropertyOfRelations
)
)
_ <- Cache.cacheUpdatedOntology(internalOntologyIri, updatedOntology)

// Read the data back from the cache.
response <- getPropertyDefinitionsFromOntologyV2(
Expand Down Expand Up @@ -2888,11 +2790,7 @@ class OntologyResponderV2(responderData: ResponderData) extends Responder(respon
ontology.properties ++ maybeLinkValuePropertyCacheEntry + (internalPropertyIri -> newReadPropertyInfo)
)

_ = Cache.storeCacheData(
cacheData.copy(
ontologies = cacheData.ontologies + (internalOntologyIri -> updatedOntology)
)
)
_ <- Cache.cacheUpdatedOntology(internalOntologyIri, updatedOntology)

// Read the data back from the cache.

Expand Down Expand Up @@ -3096,11 +2994,7 @@ class OntologyResponderV2(responderData: ResponderData) extends Responder(respon
ontology.properties ++ maybeLinkValuePropertyCacheEntry + (internalPropertyIri -> newReadPropertyInfo)
)

_ = Cache.storeCacheData(
cacheData.copy(
ontologies = cacheData.ontologies + (internalOntologyIri -> updatedOntology)
)
)
_ <- Cache.cacheUpdatedOntologyWithoutUpdatingMaps(internalOntologyIri, updatedOntology)

// Read the data back from the cache.

Expand Down Expand Up @@ -3238,11 +3132,7 @@ class OntologyResponderV2(responderData: ResponderData) extends Responder(respon
classes = ontology.classes + (internalClassIri -> newReadClassInfo)
)

_ = Cache.storeCacheData(
cacheData.copy(
ontologies = cacheData.ontologies + (internalOntologyIri -> updatedOntology)
)
)
_ <- Cache.cacheUpdatedOntologyWithoutUpdatingMaps(internalOntologyIri, updatedOntology)

// Read the data back from the cache.

Expand Down Expand Up @@ -3436,11 +3326,7 @@ class OntologyResponderV2(responderData: ResponderData) extends Responder(respon
ontology.properties ++ maybeLinkValuePropertyCacheEntry + (internalPropertyIri -> newReadPropertyInfo)
)

_ = Cache.storeCacheData(
cacheData.copy(
ontologies = cacheData.ontologies + (internalOntologyIri -> updatedOntology)
)
)
_ <- Cache.cacheUpdatedOntologyWithoutUpdatingMaps(internalOntologyIri, updatedOntology)

// Read the data back from the cache.

Expand Down Expand Up @@ -3595,11 +3481,7 @@ class OntologyResponderV2(responderData: ResponderData) extends Responder(respon
classes = ontology.classes + (internalClassIri -> newReadClassInfo)
)

_ = Cache.storeCacheData(
cacheData.copy(
ontologies = cacheData.ontologies + (internalOntologyIri -> updatedOntology)
)
)
_ <- Cache.cacheUpdatedOntologyWithoutUpdatingMaps(internalOntologyIri, updatedOntology)

// Read the data back from the cache.

Expand Down

0 comments on commit 8541519

Please sign in to comment.