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 Deprecated SimpleFS #1639

Merged
merged 2 commits into from
Dec 3, 2021
Merged

Remove Deprecated SimpleFS #1639

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f1d95e
Remove Deprecated SimpleFS
nknize Dec 1, 2021
811ddc2
Add javadocs and fix SIMPLEFS enum order
nknize Dec 1, 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
42 changes: 0 additions & 42 deletions ...s/store-smb/src/internalClusterTest/java/org/opensearch/index/store/SmbSimpleFsTests.java
View file
Open in desktop

This file was deleted.

65 changes: 0 additions & 65 deletions ...smb/src/main/java/org/opensearch/index/store/smbsimplefs/SmbSimpleFsDirectoryFactory.java
View file
Open in desktop

This file was deleted.

10 changes: 0 additions & 10 deletions plugins/store-smb/src/main/java/org/opensearch/plugin/store/smb/SMBStorePlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,8 @@

package org.opensearch.plugin.store.smb;

import org.opensearch.common.logging.DeprecationLogger;
import org.opensearch.index.IndexModule;
import org.opensearch.index.store.smbmmapfs.SmbMmapFsDirectoryFactory;
import org.opensearch.index.store.smbniofs.SmbNIOFsDirectoryFactory;
import org.opensearch.index.store.smbsimplefs.SmbSimpleFsDirectoryFactory;
import org.opensearch.plugins.IndexStorePlugin;
import org.opensearch.plugins.Plugin;

Expand All @@ -46,17 +43,10 @@

public class SMBStorePlugin extends Plugin implements IndexStorePlugin {

private static final DeprecationLogger DEPRECATION_LOGGER = DeprecationLogger.getLogger(SMBStorePlugin.class);

@Override
public Map<String, DirectoryFactory> getDirectoryFactories() {
final Map<String, DirectoryFactory> indexStoreFactories = new HashMap<>(2);
indexStoreFactories.put("smb_mmap_fs", new SmbMmapFsDirectoryFactory());
DEPRECATION_LOGGER.deprecate(
IndexModule.Type.SIMPLEFS.getSettingsKey(),
IndexModule.Type.SIMPLEFS.getSettingsKey() + " is deprecated and will be removed in 2.0"
);
indexStoreFactories.put("smb_simple_fs", new SmbSimpleFsDirectoryFactory());
indexStoreFactories.put("smb_nio_fs", new SmbNIOFsDirectoryFactory());
return Collections.unmodifiableMap(indexStoreFactories);
}
Expand Down
54 changes: 0 additions & 54 deletions plugins/store-smb/src/test/java/org/opensearch/index/store/SmbSimpleFSDirectoryTests.java
View file
Open in desktop

This file was deleted.

13 changes: 1 addition & 12 deletions server/src/main/java/org/opensearch/index/store/FsDirectoryFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,7 @@
import org.apache.lucene.store.MMapDirectory;
import org.apache.lucene.store.NIOFSDirectory;
import org.apache.lucene.store.NativeFSLockFactory;
import org.apache.lucene.store.SimpleFSDirectory;
import org.apache.lucene.store.SimpleFSLockFactory;
import org.opensearch.common.logging.DeprecationLogger;
import org.opensearch.common.settings.Setting;
import org.opensearch.common.settings.Setting.Property;
import org.opensearch.core.internal.io.IOUtils;
Expand All @@ -61,8 +59,6 @@

public class FsDirectoryFactory implements IndexStorePlugin.DirectoryFactory {

private static final DeprecationLogger DEPRECATION_LOGGER = DeprecationLogger.getLogger(FsDirectoryFactory.class);

public static final Setting<LockFactory> INDEX_LOCK_FACTOR_SETTING = new Setting<>("index.store.fs.fs_lock", "native", (s) -> {
switch (s) {
case "native":
Expand Down Expand Up @@ -104,15 +100,8 @@ protected Directory newFSDirectory(Path location, LockFactory lockFactory, Index
}
case MMAPFS:
return setPreload(new MMapDirectory(location, lockFactory), lockFactory, preLoadExtensions);
// simplefs was removed in Lucene 9; support for enum is maintained for bwc
case SIMPLEFS:
Copy link
Collaborator

@reta reta Dec 1, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Should we throw the exception here that SIMPLEFS is not supported anymore? Or may be, to not break bwc, log a warning that SIMPLEFS is not supported, NIOFS will be used instead?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe add an assert instead as an invariant?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It's not needed here since this is for bwc only.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The deprecation logging is already handled in MetadataUpdateSettingsService

DEPRECATION_LOGGER.deprecate(
IndexModule.Type.SIMPLEFS.getSettingsKey(),
IndexModule.Type.SIMPLEFS.getSettingsKey()
+ " is no longer supported and will be removed in 2.0. Use ["
+ IndexModule.Type.NIOFS.getSettingsKey()
+ "], which offers equal or better performance, instead."
);
return new SimpleFSDirectory(location, lockFactory);
case NIOFS:
return new NIOFSDirectory(location, lockFactory);
default:
Expand Down
12 changes: 2 additions & 10 deletions server/src/test/java/org/opensearch/index/store/FsDirectoryFactoryTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@
import org.apache.lucene.store.MMapDirectory;
import org.apache.lucene.store.NIOFSDirectory;
import org.apache.lucene.store.NoLockFactory;
import org.apache.lucene.store.SimpleFSDirectory;
import org.apache.lucene.store.SleepingLockWrapper;
import org.apache.lucene.util.Constants;
import org.opensearch.Version;
Expand Down Expand Up @@ -157,24 +156,17 @@ private void doTestStoreDirectory(Path tempDir, String typeSettingValue, IndexMo
case HYBRIDFS:
assertTrue(FsDirectoryFactory.isHybridFs(directory));
break;
// simplefs was removed in Lucene 9; support for enum is maintained for bwc
case SIMPLEFS:
case NIOFS:
assertTrue(type + " " + directory.toString(), directory instanceof NIOFSDirectory);
break;
case MMAPFS:
assertTrue(type + " " + directory.toString(), directory instanceof MMapDirectory);
break;
case SIMPLEFS:
assertWarnings(
"simplefs is no longer supported and will be removed in 2.0. Use [niofs], which offers equal "
+ "or better performance, instead."
);
assertTrue(type + " " + directory.toString(), directory instanceof SimpleFSDirectory);
break;
case FS:
if (Constants.JRE_IS_64BIT && MMapDirectory.UNMAP_SUPPORTED) {
assertTrue(FsDirectoryFactory.isHybridFs(directory));
} else if (Constants.WINDOWS) {
assertTrue(directory.toString(), directory instanceof SimpleFSDirectory);
} else {
assertTrue(directory.toString(), directory instanceof NIOFSDirectory);
}
Expand Down