Skip to content
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

Remove SchemaRegistryClient caching #24380

Merged
merged 4 commits into from
Sep 28, 2021
Merged

Remove SchemaRegistryClient caching #24380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c04596f
Remove builder caching references.
conniey Sep 27, 2021
5da18c9
Remove caching from SchemaRegistryAsyncClient.
conniey Sep 27, 2021
db777a0
Remove cached tests.
conniey Sep 27, 2021
04babba
Adding service annotation.
conniey Sep 27, 2021
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
84 changes: 24 additions & 60 deletions ...schemaregistry/src/main/java/com/azure/data/schemaregistry/SchemaRegistryAsyncClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,7 @@
import java.net.URI;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.Map;
import java.util.Objects;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentSkipListMap;
import java.util.function.Function;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

Expand Down Expand Up @@ -53,20 +49,9 @@ public final class SchemaRegistryAsyncClient {
private static final Pattern SCHEMA_PATTERN = Pattern.compile("/\\$schemagroups/(?<schemaGroup>.+)/schemas/(?<schemaName>.+?)/");
private final ClientLogger logger = new ClientLogger(SchemaRegistryAsyncClient.class);
private final AzureSchemaRegistry restService;
private final Integer maxSchemaMapSize;
private final ConcurrentSkipListMap<String, Function<String, Object>> typeParserMap;
private final Map<String, SchemaProperties> idCache;
private final Map<String, SchemaProperties> schemaStringCache;

SchemaRegistryAsyncClient(
AzureSchemaRegistry restService,
int maxSchemaMapSize,
ConcurrentSkipListMap<String, Function<String, Object>> typeParserMap) {
SchemaRegistryAsyncClient(AzureSchemaRegistry restService) {
this.restService = restService;
this.maxSchemaMapSize = maxSchemaMapSize;
this.typeParserMap = typeParserMap;
this.idCache = new ConcurrentHashMap<>();
this.schemaStringCache = new ConcurrentHashMap<>();
}

/**
Expand Down Expand Up @@ -119,11 +104,6 @@ Mono<Response<SchemaProperties>> registerSchemaWithResponse(String groupName, St
name,
content.getBytes(SCHEMA_REGISTRY_SERVICE_ENCODING));

schemaStringCache.putIfAbsent(getSchemaStringCacheKey(groupName, name, content),
registered);
idCache.putIfAbsent(schemaId.getId(), registered);

logger.verbose("Cached schema string. Group: '{}', name: '{}'", groupName, name);
SimpleResponse<SchemaProperties> schemaRegistryObjectSimpleResponse = new SimpleResponse<>(
response.getRequest(), response.getStatusCode(),
response.getHeaders(), registered);
Expand All @@ -140,10 +120,6 @@ Mono<Response<SchemaProperties>> registerSchemaWithResponse(String groupName, St
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<SchemaProperties> getSchema(String id) {
if (idCache.containsKey(id)) {
logger.verbose("Cache hit for schema id '{}'", id);
return Mono.fromCallable(() -> idCache.get(id));
}
return getSchemaWithResponse(id).map(Response::getValue);
}

Expand All @@ -154,7 +130,8 @@ public Mono<SchemaProperties> getSchema(String id) {
*
* @return The {@link SchemaProperties} associated with the given {@code id} along with the HTTP response.
*/
Mono<Response<SchemaProperties>> getSchemaWithResponse(String id) {
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<Response<SchemaProperties>> getSchemaWithResponse(String id) {
return FluxUtil.withContext(context -> getSchemaWithResponse(id, context));
}

Expand All @@ -174,21 +151,12 @@ Mono<Response<SchemaProperties>> getSchemaWithResponse(String id, Context contex
return;
}

final String schemaGroup = matcher.group("schemaGroup");
final String schemaName = matcher.group("schemaName");
final SchemaProperties schemaObject = new SchemaProperties(id,
serializationType,
schemaName,
response.getValue());
final String schemaCacheKey = getSchemaStringCacheKey(schemaGroup, schemaName,
new String(response.getValue(), SCHEMA_REGISTRY_SERVICE_ENCODING));

schemaStringCache.putIfAbsent(schemaCacheKey, schemaObject);
idCache.putIfAbsent(id, schemaObject);

logger.verbose("Cached schema object. Path: '{}'", id);

SimpleResponse<SchemaProperties> schemaResponse = new SimpleResponse<>(
final SimpleResponse<SchemaProperties> schemaResponse = new SimpleResponse<>(
response.getRequest(), response.getStatusCode(),
response.getHeaders(), schemaObject);

Expand All @@ -210,16 +178,6 @@ Mono<Response<SchemaProperties>> getSchemaWithResponse(String id, Context contex
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<String> getSchemaId(String groupName, String name, String content,
SerializationType serializationType) {

String schemaStringCacheKey = getSchemaStringCacheKey(groupName, name, content);

if (schemaStringCache.containsKey(schemaStringCacheKey)) {
return Mono.fromCallable(() -> {
logger.verbose("Cache hit schema string. Group: '{}', name: '{}'", groupName, name);
return schemaStringCache.get(schemaStringCacheKey).getSchemaId();
});
}

return getSchemaIdWithResponse(groupName, name, content, serializationType)
.map(response -> response.getValue());
}
Expand All @@ -234,7 +192,8 @@ public Mono<String> getSchemaId(String groupName, String name, String content,
*
* @return The unique identifier for this schema.
*/
Mono<Response<String>> getSchemaIdWithResponse(String groupName, String name, String content,
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<Response<String>> getSchemaIdWithResponse(String groupName, String name, String content,
SerializationType serializationType) {

return FluxUtil.withContext(context ->
Expand All @@ -256,27 +215,32 @@ Mono<Response<String>> getSchemaIdWithResponse(String groupName, String name, St
SerializationType serializationType, Context context) {

return this.restService.getSchemas()
.queryIdByContentWithResponseAsync(groupName, name,
com.azure.data.schemaregistry.implementation.models.SerializationType.AVRO, content)
.queryIdByContentWithResponseAsync(groupName, name, getSerialization(serializationType), content)
.handle((response, sink) -> {
SchemaId schemaId = response.getValue();
SchemaProperties properties = new SchemaProperties(schemaId.getId(), serializationType, name,
content.getBytes(SCHEMA_REGISTRY_SERVICE_ENCODING));

schemaStringCache.putIfAbsent(
getSchemaStringCacheKey(groupName, name, content), properties);
idCache.putIfAbsent(schemaId.getId(), properties);

logger.verbose("Cached schema string. Group: '{}', name: '{}'", groupName, name);

SimpleResponse<String> schemaIdResponse = new SimpleResponse<>(
response.getRequest(), response.getStatusCode(),
response.getHeaders(), schemaId.getId());

sink.next(schemaIdResponse);
});
}

private static String getSchemaStringCacheKey(String groupName, String name, String content) {
return groupName + name + content;
/**
* Gets the matching implementation class serialization type.
*
* @param serializationType Model serialization type.
*
* @return Implementation serialization type.
*
* @throws UnsupportedOperationException if the serialization type is not supported.
*/
private static com.azure.data.schemaregistry.implementation.models.SerializationType getSerialization(
SerializationType serializationType) {
if (serializationType == SerializationType.AVRO) {
return com.azure.data.schemaregistry.implementation.models.SerializationType.AVRO;
} else {
throw new UnsupportedOperationException("Serialization type is not supported: " + serializationType);
}
}
}
36 changes: 2 additions & 34 deletions ...hemaregistry/src/main/java/com/azure/data/schemaregistry/SchemaRegistryClientBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,6 @@
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.concurrent.ConcurrentSkipListMap;
import java.util.function.Function;

/**
* Fluent builder for interacting with the Schema Registry service via {@link SchemaRegistryAsyncClient} and
Expand All @@ -54,11 +52,8 @@
* <p><strong>Instantiating with custom retry policy and HTTP log options</strong></p>
* {@codesnippet com.azure.data.schemaregistry.schemaregistryasyncclient.retrypolicy.instantiation}
*/
@ServiceClientBuilder(serviceClients = SchemaRegistryAsyncClient.class)
@ServiceClientBuilder(serviceClients = {SchemaRegistryAsyncClient.class, SchemaRegistryClient.class})
public class SchemaRegistryClientBuilder {
static final int MAX_SCHEMA_MAP_SIZE_DEFAULT = 1000;
static final int MAX_SCHEMA_MAP_SIZE_MINIMUM = 10;

private final ClientLogger logger = new ClientLogger(SchemaRegistryClientBuilder.class);

private static final String DEFAULT_SCOPE = "https://eventhubs.azure.net/.default";
Expand All @@ -69,8 +64,6 @@ public class SchemaRegistryClientBuilder {
private static final AddHeadersPolicy API_HEADER_POLICY = new AddHeadersPolicy(new HttpHeaders()
.set("api-version", "2020-09-01-preview"));

private final ConcurrentSkipListMap<String, Function<String, Object>> typeParserMap;

private final List<HttpPipelinePolicy> perCallPolicies = new ArrayList<>();
private final List<HttpPipelinePolicy> perRetryPolicies = new ArrayList<>();

Expand All @@ -80,7 +73,6 @@ public class SchemaRegistryClientBuilder {
private String endpoint;
private String host;
private HttpClient httpClient;
private Integer maxSchemaMapSize;
private TokenCredential credential;
private ClientOptions clientOptions;
private HttpLogOptions httpLogOptions;
Expand All @@ -93,8 +85,6 @@ public class SchemaRegistryClientBuilder {
*/
public SchemaRegistryClientBuilder() {
this.httpLogOptions = new HttpLogOptions();
this.maxSchemaMapSize = null;
this.typeParserMap = new ConcurrentSkipListMap<>(String.CASE_INSENSITIVE_ORDER);
this.httpClient = null;
this.credential = null;
this.retryPolicy = new RetryPolicy("retry-after-ms", ChronoUnit.MILLIS);
Expand Down Expand Up @@ -132,24 +122,6 @@ public SchemaRegistryClientBuilder endpoint(String endpoint) {
return this;
}

/**
* Sets schema cache size limit. If limit is exceeded on any cache, all caches are recycled.
*
* @param maxCacheSize max size for internal schema caches in {@link SchemaRegistryAsyncClient}
* @return The updated {@link SchemaRegistryClientBuilder} object.
* @throws IllegalArgumentException on invalid maxCacheSize value
*/
SchemaRegistryClientBuilder maxCacheSize(int maxCacheSize) {
if (maxCacheSize < MAX_SCHEMA_MAP_SIZE_MINIMUM) {
throw logger.logExceptionAsError(new IllegalArgumentException(
String.format("Schema map size must be greater than %s entries",
MAX_SCHEMA_MAP_SIZE_MINIMUM)));
}

this.maxSchemaMapSize = maxCacheSize;
return this;
}

/**
* Sets the HTTP client to use for sending and receiving requests to and from the service.
*
Expand Down Expand Up @@ -333,11 +305,7 @@ public SchemaRegistryAsyncClient buildAsyncClient() {
.pipeline(buildPipeline)
.buildClient();

int buildMaxSchemaMapSize = (maxSchemaMapSize == null)
? MAX_SCHEMA_MAP_SIZE_DEFAULT
: maxSchemaMapSize;

return new SchemaRegistryAsyncClient(restService, buildMaxSchemaMapSize, typeParserMap);
return new SchemaRegistryAsyncClient(restService);
}

/**
Expand Down
29 changes: 0 additions & 29 deletions ...aregistry/src/test/java/com/azure/data/schemaregistry/SchemaRegistryAsyncClientTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,35 +222,6 @@ public void registerBadRequest() {
}).verify();
}

/**
* Verifies that we can register a schema and then get it by its schemaId.
*/
@Test
public void registerAndGetCachedSchema() {
// Arrange
final String schemaName = testResourceNamer.randomName("sch", RESOURCE_LENGTH);
final SchemaRegistryAsyncClient client1 = builder.buildAsyncClient();

final AtomicReference<String> schemaId = new AtomicReference<>();

// Act & Assert
StepVerifier.create(client1.registerSchema(schemaGroup, schemaName, SCHEMA_CONTENT, SerializationType.AVRO))
.assertNext(response -> {
assertSchemaProperties(response, null, schemaName, SCHEMA_CONTENT);
schemaId.set(response.getSchemaId());
}).verifyComplete();

// Assert that we can get a schema based on its id. We registered a schema with client1 and its response is
// cached, so it won't make a network call when getting the schema. client2 will not have this information.
final String schemaIdToGet = schemaId.get();
assertNotNull(schemaIdToGet);

// Act & Assert
StepVerifier.create(client1.getSchema(schemaIdToGet))
.assertNext(schema -> assertSchemaProperties(schema, schemaIdToGet, schemaName, SCHEMA_CONTENT))
.verifyComplete();
}

/**
* Verifies that we get 404 when non-existent schema returned.
*/
Expand Down
23 changes: 0 additions & 23 deletions ...schemaregistry/src/test/java/com/azure/data/schemaregistry/SchemaRegistryClientTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,29 +184,6 @@ public void registerBadRequest() {
assertEquals(400, exception.getResponse().getStatusCode());
}

/**
* Verifies that we can register a schema and then get it by its schemaId.
*/
@Test
public void registerAndGetCachedSchema() {
// Arrange
final String schemaName = testResourceNamer.randomName("sch", RESOURCE_LENGTH);
final SchemaRegistryClient client1 = builder.buildClient();

// Act & Assert
final SchemaProperties response = client1.registerSchema(schemaGroup, schemaName, SCHEMA_CONTENT,
SerializationType.AVRO);
assertSchemaProperties(response, null, schemaName, SCHEMA_CONTENT);

// Assert that we can get a schema based on its id. We registered a schema with client1 and its response is
// cached, so it won't make a network call when getting the schema.
final String schemaIdToGet = response.getSchemaId();

// Act & Assert
final SchemaProperties response2 = client1.getSchema(schemaIdToGet);
assertSchemaProperties(response2, schemaIdToGet, schemaName, SCHEMA_CONTENT);
}

/**
* Verifies that we get 404 when non-existent schema returned.
*/
Expand Down
29 changes: 0 additions & 29 deletions .../resources/session-records/SchemaRegistryAsyncClientTests.registerAndGetCachedSchema.json
View file
Open in desktop

This file was deleted.

29 changes: 0 additions & 29 deletions .../test/resources/session-records/SchemaRegistryClientTests.registerAndGetCachedSchema.json
View file
Open in desktop

This file was deleted.