Skip to content

Commit

Permalink
Sonar cloud "Cognitive Complexity" warnings are now enforced. Had to …
Browse files Browse the repository at this point in the history 
…split some functions.

        This seems to be a complicated way to reduce complexity. Most methods are, and should be, a "single task" leaf, but some are
        skeletons/trunks - and implementing a certain "storyline" agorithm. Spreading this algorithm among multiple functions makes it
        anything but more readable.
  • Loading branch information
@jjezra
jjezra committed Oct 12, 2021
1 parent 95abfc3 commit 13d361d
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 33 deletions.
74 changes: 45 additions & 29 deletions ...-core/src/main/java/com/apple/foundationdb/record/provider/foundationdb/IndexingBase.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -389,26 +389,7 @@ private CompletableFuture<Void> setIndexingTypeOrThrow(FDBRecordStore store, boo
IndexBuildProto.IndexBuildIndexingStamp.Method.BY_RECORDS) {
// backward compatibility - maybe continuing an old BY_RECORD session
return isWriteOnlyButNoRecordScanned(store, index)
.thenCompose(noRecordScanned -> {
if (noRecordScanned) {
// an empty type stamp, and nothing was indexed - it is safe to write stamp
if (LOGGER.isInfoEnabled()) {
LOGGER.info(KeyValueLogMessage.build("no scanned ranges - continue indexing")
.addKeysAndValues(common.indexLogMessageKeyValues())
.toString());
}
transaction.set(stampKey, indexingTypeStamp.toByteArray());
return AsyncUtil.DONE;
}
// Here: there is no type stamp, but indexing is ongoing. For backward compatibility reasons, we'll consider it a BY_RECORDS stamp
if (LOGGER.isInfoEnabled()) {
LOGGER.info(KeyValueLogMessage.build("continuation with null type stamp, assuming previous by-records scan")
.addKeysAndValues(common.indexLogMessageKeyValues())
.toString());
}
final IndexBuildProto.IndexBuildIndexingStamp fakeSavedStamp = IndexingByRecords.compileIndexingTypeStamp();
throw newPartlyBuildException(true, fakeSavedStamp, indexingTypeStamp, index);
});
.thenCompose(noRecordScanned -> throwAsByRecordsUnlessNoRecordWasScanned(noRecordScanned, transaction, index, stampKey, indexingTypeStamp));
}
// Here: either not a continuedBuild (new session), or a BY_RECORD session (allowed to overwrite the null stamp)
transaction.set(stampKey, indexingTypeStamp.toByteArray());
Expand All @@ -430,21 +411,56 @@ private CompletableFuture<Void> setIndexingTypeOrThrow(FDBRecordStore store, boo
if (forceStampOverwrite) { // and a continued Build
// check if partly built
return isWriteOnlyButNoRecordScanned(store, index)
.thenCompose(noRecordScanned -> {
if (noRecordScanned) {
// we can safely overwrite the previous type stamp
transaction.set(stampKey, indexingTypeStamp.toByteArray());
return AsyncUtil.DONE;
}
// A force overwrite cannot be allowed when partly built
throw newPartlyBuildException(continuedBuild, savedStamp, indexingTypeStamp, index);
});
.thenCompose(noRecordScanned ->
throwUnlessNoRecordWasScanned(noRecordScanned, transaction, index, stampKey, indexingTypeStamp,
savedStamp, continuedBuild));
}
// fall down to exception
throw newPartlyBuildException(continuedBuild, savedStamp, indexingTypeStamp, index);
});
}

@Nonnull
private CompletableFuture<Void> throwAsByRecordsUnlessNoRecordWasScanned(boolean noRecordScanned, Transaction transaction,
Index index, byte[] stampKey,
IndexBuildProto.IndexBuildIndexingStamp indexingTypeStamp) {
// A complicated way to reduce complexity.
if (noRecordScanned) {
// an empty type stamp, and nothing was indexed - it is safe to write stamp
if (LOGGER.isInfoEnabled()) {
LOGGER.info(KeyValueLogMessage.build("no scanned ranges - continue indexing")
.addKeysAndValues(common.indexLogMessageKeyValues())
.toString());
}
transaction.set(stampKey, indexingTypeStamp.toByteArray());
return AsyncUtil.DONE;
}
// Here: there is no type stamp, but indexing is ongoing. For backward compatibility reasons, we'll consider it a BY_RECORDS stamp
if (LOGGER.isInfoEnabled()) {
LOGGER.info(KeyValueLogMessage.build("continuation with null type stamp, assuming previous by-records scan")
.addKeysAndValues(common.indexLogMessageKeyValues())
.toString());
}
final IndexBuildProto.IndexBuildIndexingStamp fakeSavedStamp = IndexingByRecords.compileIndexingTypeStamp();
throw newPartlyBuildException(true, fakeSavedStamp, indexingTypeStamp, index);
}

@Nonnull
private CompletableFuture<Void> throwUnlessNoRecordWasScanned(boolean noRecordScanned, Transaction transaction,
Index index, byte[] stampKey,
IndexBuildProto.IndexBuildIndexingStamp indexingTypeStamp,
IndexBuildProto.IndexBuildIndexingStamp savedStamp,
boolean continuedBuild) {
// Ditto (a complicated way to reduce complexity)
if (noRecordScanned) {
// we can safely overwrite the previous type stamp
transaction.set(stampKey, indexingTypeStamp.toByteArray());
return AsyncUtil.DONE;
}
// A force overwrite cannot be allowed when partly built
throw newPartlyBuildException(continuedBuild, savedStamp, indexingTypeStamp, index);
}

@Nonnull
private CompletableFuture<Void> setScrubberTypeOrThrow(FDBRecordStore store) {
// HERE: The index must be readable, checked by the caller
Expand Down
12 changes: 8 additions & 4 deletions ...core/src/main/java/com/apple/foundationdb/record/provider/foundationdb/OnlineIndexer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1841,13 +1841,14 @@ private void determineIndexingPolicy() {
}

private void validate() {
validateIndexesAndTypes();
final RecordMetaData metaData = getRecordMetaData();
validateIndexes(metaData);
validateTypes(metaData);
validateLimits();
}

private void validateIndexesAndTypes() {
final RecordMetaData metaData = getRecordMetaData();
if (this.targetIndexes == null || this.targetIndexes.isEmpty()) {
private void validateIndexes(RecordMetaData metaData) {
if (this.targetIndexes.isEmpty()) {
throw new MetaDataException("index must be set");
}
// Remove duplications (if any)
Expand All @@ -1867,6 +1868,9 @@ private void validateIndexesAndTypes() {
throw new MetaDataException("Index " + index.getName() + " not contained within specified metadata");
}
}
}

private void validateTypes(RecordMetaData metaData) {
if (recordTypes != null) {
for (RecordType recordType : recordTypes) {
if (recordType != metaData.getIndexableRecordType(recordType.getName())) {
Expand Down

0 comments on commit 13d361d

Please sign in to comment.