Skip to content

NIFI-15889 Cache Parameter Context name mapping to fix O(N_PG x N_PC^2) startup synchronization #11295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
venkateshwaracholan wants to merge 1 commit into
base: main
Choose a base branch
from
+161 −15
Open

NIFI-15889 Cache Parameter Context name mapping to fix O(N_PG x N_PC^2) startup synchronization #11295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...ain/java/org/apache/nifi/flow/synchronization/StandardVersionedComponentSynchronizer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1854,7 +1854,7 @@ public void synchronize(final ParameterContext parameterContext, final Versioned
}

parameterContext.setParameters(updatedParameters);
parameterContext.setName(proposed.getName());
contextManager.setParameterContextName(parameterContext.getIdentifier(), proposed.getName());
parameterContext.setDescription(proposed.getDescription());
parameterContext.setInheritedParameterContexts(inheritedContexts);
LOG.info("Successfully synchronized {} by updating it to match the proposed version", parameterContext);
Expand Down
61 changes: 48 additions & 13 deletions ...k-components/src/main/java/org/apache/nifi/parameter/StandardParameterContextManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,20 @@
*/
package org.apache.nifi.parameter;

import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.function.Function;
import java.util.stream.Collectors;

public class StandardParameterContextManager implements ParameterContextManager {
private final Map<String, ParameterContext> parameterContexts = new HashMap<>();
private final Map<String, ParameterContext> nameIndex = new HashMap<>();
private volatile Map<String, ParameterContext> cachedNameMapping = Collections.emptyMap();

@Override
public boolean hasParameterContext(final String id) {
public synchronized boolean hasParameterContext(final String id) {
return parameterContexts.get(id) != null;
}

Expand All @@ -41,25 +42,55 @@ public synchronized ParameterContext getParameterContext(final String id) {
public synchronized void addParameterContext(final ParameterContext parameterContext) {
Objects.requireNonNull(parameterContext);

if (parameterContexts.containsKey(parameterContext.getIdentifier())) {
if (!(parameterContexts.get(parameterContext.getIdentifier()) instanceof ReferenceOnlyParameterContext)) {
throw new IllegalStateException("Cannot add Parameter Context because another Parameter Context already exists with the same ID");
}
final ParameterContext existingById = parameterContexts.get(parameterContext.getIdentifier());
if (existingById != null && !(existingById instanceof ReferenceOnlyParameterContext)) {
throw new IllegalStateException("Cannot add Parameter Context because another Parameter Context already exists with the same ID");
}

for (final ParameterContext context : parameterContexts.values()) {
if (context.getName().equals(parameterContext.getName())) {
throw new IllegalStateException("Cannot add Parameter Context because another Parameter Context already exists with the name '" + parameterContext + "'");
}
final ParameterContext existingByName = nameIndex.get(parameterContext.getName());
if (existingByName != null && existingByName != existingById) {
throw new IllegalStateException("Cannot add Parameter Context because another Parameter Context already exists with the name '" + parameterContext + "'");
}

if (existingById instanceof ReferenceOnlyParameterContext) {
nameIndex.remove(existingById.getName(), existingById);
}

parameterContexts.put(parameterContext.getIdentifier(), parameterContext);
nameIndex.put(parameterContext.getName(), parameterContext);
updateCachedNameMapping();
}

@Override
public synchronized ParameterContext removeParameterContext(final String parameterContextId) {
Objects.requireNonNull(parameterContextId);
return parameterContexts.remove(parameterContextId);
final ParameterContext removed = parameterContexts.remove(parameterContextId);
if (removed != null) {
nameIndex.remove(removed.getName(), removed);
updateCachedNameMapping();
}
return removed;
}

@Override
public synchronized void setParameterContextName(final String parameterContextId, final String name) {
Objects.requireNonNull(parameterContextId);
Objects.requireNonNull(name);

final ParameterContext parameterContext = parameterContexts.get(parameterContextId);
if (parameterContext == null) {
throw new IllegalStateException("Cannot rename Parameter Context because no Parameter Context exists with the specified ID");
}

final ParameterContext existingByName = nameIndex.get(name);
if (existingByName != null && existingByName != parameterContext) {
throw new IllegalStateException("Cannot rename Parameter Context because another Parameter Context already exists with the name '" + name + "'");
}

nameIndex.remove(parameterContext.getName(), parameterContext);
parameterContext.setName(name);
nameIndex.put(parameterContext.getName(), parameterContext);
updateCachedNameMapping();
}

@Override
Expand All @@ -69,6 +100,10 @@ public synchronized Set<ParameterContext> getParameterContexts() {

@Override
public Map<String, ParameterContext> getParameterContextNameMapping() {
return parameterContexts.values().stream().collect(Collectors.toMap(ParameterContext::getName, Function.identity()));
return cachedNameMapping;
}

private void updateCachedNameMapping() {
cachedNameMapping = Collections.unmodifiableMap(new HashMap<>(nameIndex));
}
}
102 changes: 102 additions & 0 deletions ...mponents/src/test/java/org/apache/nifi/parameter/TestStandardParameterContextManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
package org.apache.nifi.parameter;

import org.junit.jupiter.api.Test;

import java.util.Map;

import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

public class TestStandardParameterContextManager {

@Test
public void testNameMappingUpdatedOnAddRemoveAndRename() {
final StandardParameterContextManager manager = new StandardParameterContextManager();
final ParameterContext firstContext = createParameterContext("id-1", "Context 1");

manager.addParameterContext(firstContext);

final Map<String, ParameterContext> initialNameMapping = manager.getParameterContextNameMapping();
assertSame(firstContext, initialNameMapping.get("Context 1"));
assertThrows(UnsupportedOperationException.class, () -> initialNameMapping.put("Other", firstContext));
assertSame(initialNameMapping, manager.getParameterContextNameMapping());

manager.setParameterContextName("id-1", "Renamed");

final Map<String, ParameterContext> renamedMapping = manager.getParameterContextNameMapping();
assertFalse(renamedMapping.containsKey("Context 1"));
assertSame(firstContext, renamedMapping.get("Renamed"));

final ParameterContext secondContext = createParameterContext("id-2", "Context 2");
manager.addParameterContext(secondContext);
assertThrows(IllegalStateException.class, () -> manager.setParameterContextName("id-2", "Renamed"));

assertSame(firstContext, manager.removeParameterContext("id-1"));
final Map<String, ParameterContext> removedMapping = manager.getParameterContextNameMapping();
assertFalse(removedMapping.containsKey("Renamed"));
assertSame(secondContext, removedMapping.get("Context 2"));
}

@Test
public void testReferenceOnlyParameterContextReplacementRemovesPlaceholderName() {
final StandardParameterContextManager manager = new StandardParameterContextManager();
final ReferenceOnlyParameterContext referenceOnlyContext = new ReferenceOnlyParameterContext("id-1");

manager.addParameterContext(referenceOnlyContext);
final String placeholderName = referenceOnlyContext.getName();
assertSame(referenceOnlyContext, manager.getParameterContextNameMapping().get(placeholderName));

final ParameterContext realContext = createParameterContext("id-1", "Real Context");
manager.addParameterContext(realContext);

final Map<String, ParameterContext> nameMapping = manager.getParameterContextNameMapping();
assertFalse(nameMapping.containsKey(placeholderName));
assertSame(realContext, nameMapping.get("Real Context"));
assertSame(realContext, manager.getParameterContext("id-1"));

assertSame(realContext, manager.removeParameterContext("id-1"));
assertTrue(manager.getParameterContextNameMapping().isEmpty());
}

@Test
public void testDuplicateNameRejected() {
final StandardParameterContextManager manager = new StandardParameterContextManager();
manager.addParameterContext(createParameterContext("id-1", "Context"));

assertThrows(IllegalStateException.class, () -> manager.addParameterContext(createParameterContext("id-2", "Context")));
}

@Test
public void testDuplicateIdentifierRejected() {
final StandardParameterContextManager manager = new StandardParameterContextManager();
manager.addParameterContext(createParameterContext("id-1", "Context 1"));

assertThrows(IllegalStateException.class, () -> manager.addParameterContext(createParameterContext("id-1", "Context 2")));
}

private static ParameterContext createParameterContext(final String id, final String name) {
return new StandardParameterContext.Builder()
.id(id)
.name(name)
.parameterReferenceManager(ParameterReferenceManager.EMPTY)
.build();
}
}
9 changes: 9 additions & 0 deletions ...i-framework-core-api/src/main/java/org/apache/nifi/parameter/ParameterContextManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,15 @@ public interface ParameterContextManager extends ParameterContextLookup {

ParameterContext removeParameterContext(String parameterContextId);

default void setParameterContextName(final String parameterContextId, final String name) {
final ParameterContext parameterContext = getParameterContext(parameterContextId);
if (parameterContext == null) {
throw new IllegalStateException("Cannot rename Parameter Context because no Parameter Context exists with the specified ID");
}

parameterContext.setName(name);
}

Set<ParameterContext> getParameterContexts();

Map<String, ParameterContext> getParameterContextNameMapping();
Expand Down
2 changes: 1 addition & 1 deletion .../nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardParameterContextDAO.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ public ParameterContext updateParameterContext(final ParameterContextDTO paramet

if (parameterContextDto.getName() != null) {
verifyNoNamingConflict(parameterContextDto.getName(), parameterContextDto.getId());
context.setName(parameterContextDto.getName());
flowManager.getParameterContextManager().setParameterContextName(parameterContextDto.getId(), parameterContextDto.getName());
}

if (parameterContextDto.getDescription() != null) {
Expand Down
Loading