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

Jump to bottom

Enforce type safety for ExtensionNamedWriteableRegistry #203

Merged
merged 3 commits into from
Oct 26, 2022
Merged

Enforce type safety for ExtensionNamedWriteableRegistry #203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
58872af
add generic type
mloufra Oct 25, 2022
a5826f4
move @SuppressWarnings at lowest scope possible
mloufra Oct 25, 2022
13cb748
remove @SuppressWarnings
mloufra Oct 26, 2022
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
8 changes: 5 additions & 3 deletions src/main/java/org/opensearch/sdk/ExtensionNamedWriteableRegistry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.opensearch.common.io.stream.InputStreamStreamInput;
import org.opensearch.common.io.stream.NamedWriteable;
import org.opensearch.common.io.stream.NamedWriteableAwareStreamInput;
import org.opensearch.common.io.stream.NamedWriteableRegistry;
import org.opensearch.common.io.stream.NamedWriteableRegistryParseRequest;
Expand Down Expand Up @@ -79,12 +80,13 @@ private List<NamedWriteableRegistry.Entry> getNamedWriteables() {
* @param request The OpenSearch request to handle.
* @return A response with a list of writeable names and fully qualified category class names to register within OpenSearch
*/
@SuppressWarnings("unchecked")
public NamedWriteableRegistryResponse handleNamedWriteableRegistryRequest(OpenSearchRequest request) {
logger.info("Registering Named Writeable Registry Request recieved from OpenSearch.");
// Iterate through Extensions's named writeables and add to extension entries
Map<String, Class> extensionEntries = new HashMap<>();
Map<String, Class<? extends NamedWriteable>> extensionEntries = new HashMap<>();
for (NamedWriteableRegistry.Entry entry : this.namedWriteables) {
extensionEntries.put(entry.name, entry.categoryClass);
extensionEntries.put(entry.name, (Class<? extends NamedWriteable>) entry.categoryClass);
dbwiddis marked this conversation as resolved.
Show resolved Hide resolved
}
NamedWriteableRegistryResponse namedWriteableRegistryResponse = new NamedWriteableRegistryResponse(extensionEntries);
return namedWriteableRegistryResponse;
Expand All @@ -105,7 +107,7 @@ public ExtensionBooleanResponse handleNamedWriteableRegistryParseRequest(NamedWr
boolean status = false;

// Extract data from request and procress fully qualified category class name into class instance
Class categoryClass = request.getCategoryClass();
Class<? extends NamedWriteable> categoryClass = request.getCategoryClass();
byte[] context = request.getContext();

// Transform byte array context into an input stream
Expand Down
4 changes: 2 additions & 2 deletions src/test/java/org/opensearch/sdk/TestNamedWriteableRegistryAPI.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,12 +135,12 @@ public void testInvalidCategoryClass() throws UnknownHostException, IOException
StreamInput in = new InputStreamStreamInput(input);

// Category Class ExtensionRunner is not registered
NamedWriteableRegistryParseRequest request = new NamedWriteableRegistryParseRequest(ExtensionsRunner.class, in);
NamedWriteableRegistryParseRequest request = new NamedWriteableRegistryParseRequest(NamedWriteable.class, in);
dbwiddis marked this conversation as resolved.
Show resolved Hide resolved
Exception e = expectThrows(
Exception.class,
() -> extensionNamedWriteableRegistry.handleNamedWriteableRegistryParseRequest(request)
);
assertEquals(e.getMessage(), "Unknown NamedWriteable category [" + ExtensionsRunner.class.getName() + "]");
assertEquals(e.getMessage(), "Unknown NamedWriteable category [" + NamedWriteable.class.getName() + "]");
}

@Test
Expand Down