Skip to content

Fix: avoid ZSTD codec from overriding service codec factory. #7037

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

Merged
merged 3 commits into from
Apr 13, 2023
Merged

Fix: avoid ZSTD codec from overriding service codec factory. #7037

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc037e2
Fix: enable ZSTD codec only if index.codec is set to ZSTD.
mulugetam Apr 6, 2023
a76ed95
Removed custom CodecService and CodecServiceFactory classes.
mulugetam Apr 7, 2023
0cf7be4
Bump zstd-jni version from 1.5.4-1 to 1.5.5-1.
mulugetam Apr 13, 2023
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
15 changes: 13 additions & 2 deletions ...ustom-codecs/src/main/java/org/opensearch/index/codec/customcodecs/CustomCodecPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import org.opensearch.plugins.EnginePlugin;
import org.opensearch.index.codec.CodecServiceFactory;
import org.opensearch.index.IndexSettings;
import org.opensearch.index.engine.EngineConfig;

import java.util.Optional;

Expand All @@ -26,15 +27,25 @@
*/
public final class CustomCodecPlugin extends Plugin implements EnginePlugin {

/** ZSTD compression with dictionary */
protected static final String ZSTD_CODEC_NAME = "ZSTD";

/** ZSTD compression without dictionary */
protected static final String ZSTDNODICT_CODEC_NAME = "ZSTDNODICT";

/** Creates a new instance */
public CustomCodecPlugin() {}

/**
* @param indexSettings is the default indexSettings
* @return the engine factory
* @return the custom-codec service factory
*/
@Override
public Optional<CodecServiceFactory> getCustomCodecServiceFactory(final IndexSettings indexSettings) {
return Optional.of(new CustomCodecServiceFactory());
String codec = indexSettings.getValue(EngineConfig.INDEX_CODEC_SETTING);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add unit test for this class.

if (codec.equals(ZSTD_CODEC_NAME) || codec.equals(ZSTDNODICT_CODEC_NAME)) {
return Optional.of(new CustomCodecServiceFactory());
}
return Optional.empty();
}
}
10 changes: 8 additions & 2 deletions ...tom-codecs/src/main/java/org/opensearch/index/codec/customcodecs/Lucene95CustomCodec.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,14 @@ abstract class Lucene95CustomCodec extends FilterCodec {

/** Each mode represents a compression algorithm. */
public enum Mode {
ZSTD,
ZSTDNODICT
ZSTD(CustomCodecPlugin.ZSTD_CODEC_NAME),
ZSTDNODICT(CustomCodecPlugin.ZSTDNODICT_CODEC_NAME);

private final String name;

Mode(String name) {
this.name = name;
}
}

private final StoredFieldsFormat storedFieldsFormat;
Expand Down