Scripting: Remove file scripts (#24627)

This commit removes file scripts, which were deprecated in 5.5.

closes #21798

buildSrc/src/main/groovy/org/elasticsearch/gradle/doc/RestTestsFromSnippetsTask.groovy

@@ -180,12 +180,14 @@ public class RestTestsFromSnippetsTask extends SnippetsTask {
             }
             if (test.setup != null) {
                 // Insert a setup defined outside of the docs
-                String setup = setups[test.setup]
-                if (setup == null) {
-                    throw new InvalidUserDataException("Couldn't find setup "
-                        + "for $test")
+                for (String setupName : test.setup.split(',')) {
+                    String setup = setups[setupName]
+                    if (setup == null) {
+                        throw new InvalidUserDataException("Couldn't find setup "
+                                + "for $test")
+                    }
+                    current.println(setup)
                 }
-                current.println(setup)
             }
 
             body(test, false)

client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/QueryDSLDocumentationTests.java

@@ -338,7 +338,7 @@ public void testScript() {
         Map<String, Object> parameters = new HashMap<>();
         parameters.put("param1", 5);
         scriptQuery(new Script(
-                ScriptType.FILE,                                     // <1>
+                ScriptType.STORED,                                   // <1>
                 "painless",                                          // <2>
                 "myscript",                                          // <3>
                 singletonMap("param1", 5)));                         // <4>

core/src/main/java/org/elasticsearch/bootstrap/Security.java

@@ -256,7 +256,6 @@ static void addFilePermissions(Permissions policy, Environment environment) {
         addPath(policy, Environment.PATH_HOME_SETTING.getKey(), environment.modulesFile(), "read,readlink");
         addPath(policy, Environment.PATH_HOME_SETTING.getKey(), environment.pluginsFile(), "read,readlink");
         addPath(policy, Environment.PATH_CONF_SETTING.getKey(), environment.configFile(), "read,readlink");
-        addPath(policy, Environment.PATH_SCRIPTS_SETTING.getKey(), environment.scriptsFile(), "read,readlink");
         // read-write dirs
         addPath(policy, "java.io.tmpdir", environment.tmpFile(), "read,readlink,write,delete");
         addPath(policy, Environment.PATH_LOGS_SETTING.getKey(), environment.logsFile(), "read,readlink,write,delete");

core/src/main/java/org/elasticsearch/common/settings/ClusterSettings.java

@@ -302,7 +302,6 @@ public void apply(Settings value, Settings current, Settings previous) {
                     IndexSettings.QUERY_STRING_ALLOW_LEADING_WILDCARD,
                     ScriptService.SCRIPT_CACHE_SIZE_SETTING,
                     ScriptService.SCRIPT_CACHE_EXPIRE_SETTING,
-                    ScriptService.SCRIPT_AUTO_RELOAD_ENABLED_SETTING,
                     ScriptService.SCRIPT_MAX_SIZE_IN_BYTES,
                     ScriptService.SCRIPT_MAX_COMPILATIONS_PER_MINUTE,
                     IndicesService.INDICES_CACHE_CLEAN_INTERVAL_SETTING,
@@ -321,7 +320,6 @@ public void apply(Settings value, Settings current, Settings previous) {
                     Environment.DEFAULT_PATH_LOGS_SETTING,
                     Environment.PATH_LOGS_SETTING,
                     Environment.PATH_REPO_SETTING,
-                    Environment.PATH_SCRIPTS_SETTING,
                     Environment.PATH_SHARED_DATA_SETTING,
                     Environment.PIDFILE_SETTING,
                     NodeEnvironment.NODE_ID_SEED_SETTING,

core/src/main/java/org/elasticsearch/env/Environment.java

@@ -55,8 +55,6 @@ public class Environment {
     public static final Setting<String> DEFAULT_PATH_CONF_SETTING = Setting.simpleString("default.path.conf", Property.NodeScope);
     public static final Setting<String> PATH_CONF_SETTING =
             new Setting<>("path.conf", DEFAULT_PATH_CONF_SETTING, Function.identity(), Property.NodeScope);
-    public static final Setting<String> PATH_SCRIPTS_SETTING =
-        Setting.simpleString("path.scripts", Property.NodeScope, Property.Deprecated);
     public static final Setting<List<String>> DEFAULT_PATH_DATA_SETTING =
             Setting.listSetting("default.path.data", Collections.emptyList(), Function.identity(), Property.NodeScope);
     public static final Setting<List<String>> PATH_DATA_SETTING =
@@ -79,8 +77,6 @@ public class Environment {
 
     private final Path configFile;
 
-    private final Path scriptsFile;
-
     private final Path pluginsFile;
 
     private final Path modulesFile;
@@ -116,12 +112,6 @@ public Environment(Settings settings) {
             configFile = homeFile.resolve("config");
         }
 
-        if (PATH_SCRIPTS_SETTING.exists(settings)) {
-            scriptsFile = PathUtils.get(cleanPath(PATH_SCRIPTS_SETTING.get(settings)));
-        } else {
-            scriptsFile = configFile.resolve("scripts");
-        }
-
         pluginsFile = homeFile.resolve("plugins");
 
         List<String> dataPaths = PATH_DATA_SETTING.get(settings);
@@ -281,13 +271,6 @@ public Path configFile() {
         return configFile;
     }
 
-    /**
-     * Location of on-disk scripts
-     */
-    public Path scriptsFile() {
-        return scriptsFile;
-    }
-
     public Path pluginsFile() {
         return pluginsFile;
     }
@@ -332,7 +315,6 @@ public static void assertEquivalent(Environment actual, Environment expected) {
         assertEquals(actual.dataWithClusterFiles(), expected.dataWithClusterFiles(), "dataWithClusterFiles");
         assertEquals(actual.repoFiles(), expected.repoFiles(), "repoFiles");
         assertEquals(actual.configFile(), expected.configFile(), "configFile");
-        assertEquals(actual.scriptsFile(), expected.scriptsFile(), "scriptsFile");
         assertEquals(actual.pluginsFile(), expected.pluginsFile(), "pluginsFile");
         assertEquals(actual.binFile(), expected.binFile(), "binFile");
         assertEquals(actual.libFile(), expected.libFile(), "libFile");

core/src/main/java/org/elasticsearch/node/Node.java

@@ -325,8 +325,7 @@ protected Node(final Environment environment, Collection<Class<? extends Plugin>
             }
             client = new NodeClient(settings, threadPool);
             final ResourceWatcherService resourceWatcherService = new ResourceWatcherService(settings, threadPool);
-            final ScriptModule scriptModule = ScriptModule.create(settings, this.environment, resourceWatcherService,
-                pluginsService.filterPlugins(ScriptPlugin.class));
+            final ScriptModule scriptModule = ScriptModule.create(settings, pluginsService.filterPlugins(ScriptPlugin.class));
             AnalysisModule analysisModule = new AnalysisModule(this.environment, pluginsService.filterPlugins(AnalysisPlugin.class));
             additionalSettings.addAll(scriptModule.getSettings());
             // this is as early as we can validate settings at this point. we already pass them to ScriptModule as well as ThreadPool

core/src/main/java/org/elasticsearch/script/NativeScriptEngine.java

@@ -57,11 +57,6 @@ public String getType() {
         return NAME;
     }
 
-    @Override
-    public String getExtension() {
-        return ""; // Native scripts have no extensions
-    }
-
     @Override
     public Object compile(String scriptName, String scriptSource, Map<String, String> params) {
         NativeScriptFactory scriptFactory = scripts.get(scriptSource);

core/src/main/java/org/elasticsearch/script/Script.java

@@ -74,15 +74,6 @@
  * <li> {@link Script#params}   - {@link Map} of user-defined parameters; must not be {@code null},
  *                                use an empty {@link Map} to specify no params
  * </ul>
- * <li> {@link ScriptType#FILE}
- * <ul>
- * <li> {@link Script#lang}     - specifies the language for look up, defaults to {@link Script#DEFAULT_SCRIPT_LANG}
- * <li> {@link Script#idOrCode} - specifies the id of the file script to be looked up, must not be {@code null}
- * <li> {@link Script#options}  - compiler options will be specified when a file script is loaded,
- *                                so they have no meaning here and must be {@code null}
- * <li> {@link Script#params}   - {@link Map} of user-defined parameters; must not be {@code null},
- *                                use an empty {@link Map} to specify no params
- * </ul>
  * </ul>
  */
 public final class Script implements ToXContentObject, Writeable {
@@ -193,26 +184,13 @@ private void setStored(String idOrCode) {
             this.idOrCode = idOrCode;
         }
 
-        /**
-         * Set both the id and the type of the file script.
-         */
-        private void setFile(String idOrCode) {
-            if (type != null) {
-                throwOnlyOneOfType();
-            }
-
-            type = ScriptType.FILE;
-            this.idOrCode = idOrCode;
-        }
-
         /**
          * Helper method to throw an exception if more than one type of {@link Script} is specified.
          */
         private void throwOnlyOneOfType() {
             throw new IllegalArgumentException("must only use one of [" +
-                ScriptType.INLINE.getParseField().getPreferredName() + " + , " +
-                ScriptType.STORED.getParseField().getPreferredName() + " + , " +
-                ScriptType.FILE.getParseField().getPreferredName() + "]" +
+                ScriptType.INLINE.getParseField().getPreferredName() + ", " +
+                ScriptType.STORED.getParseField().getPreferredName() + "]" +
                 " when specifying a script");
         }
 
@@ -242,8 +220,7 @@ private Script build(String defaultLang) {
             if (type == null) {
                 throw new IllegalArgumentException(
                     "must specify either code for an [" + ScriptType.INLINE.getParseField().getPreferredName() + "] script " +
-                        "or an id for a [" + ScriptType.STORED.getParseField().getPreferredName() + "] script " +
-                        "or [" + ScriptType.FILE.getParseField().getPreferredName() + "] script");
+                        "or an id for a [" + ScriptType.STORED.getParseField().getPreferredName() + "] script");
             }
 
             if (type == ScriptType.INLINE) {
@@ -283,22 +260,6 @@ private Script build(String defaultLang) {
                     throw new IllegalArgumentException("field [" + OPTIONS_PARSE_FIELD.getPreferredName() + "] " +
                         "cannot be specified using a [" + ScriptType.STORED.getParseField().getPreferredName() + "] script");
                 }
-            } else if (type == ScriptType.FILE) {
-                if (lang == null) {
-                    lang = defaultLang;
-                }
-
-                if (idOrCode == null) {
-                    throw new IllegalArgumentException(
-                        "must specify <code> for an [" + ScriptType.FILE.getParseField().getPreferredName() + "] script");
-                }
-
-                if (options.isEmpty()) {
-                    options = null;
-                } else {
-                    throw new IllegalArgumentException("field [" + OPTIONS_PARSE_FIELD.getPreferredName() + "] " +
-                        "cannot be specified using a [" + ScriptType.FILE.getParseField().getPreferredName() + "] script");
-                }
             }
 
             return new Script(type, lang, idOrCode, options, params);
@@ -311,7 +272,6 @@ private Script build(String defaultLang) {
         // Defines the fields necessary to parse a Script as XContent using an ObjectParser.
         PARSER.declareField(Builder::setInline, parser -> parser, ScriptType.INLINE.getParseField(), ValueType.OBJECT_OR_STRING);
         PARSER.declareString(Builder::setStored, ScriptType.STORED.getParseField());
-        PARSER.declareString(Builder::setFile, ScriptType.FILE.getParseField());
         PARSER.declareString(Builder::setLang, LANG_PARSE_FIELD);
         PARSER.declareField(Builder::setOptions, XContentParser::mapStrings, OPTIONS_PARSE_FIELD, ValueType.OBJECT);
         PARSER.declareField(Builder::setParams, XContentParser::map, PARAMS_PARSE_FIELD, ValueType.OBJECT);
@@ -425,10 +385,10 @@ public Script(String idOrCode) {
     /**
      * Constructor for a script that does not need to use compiler options.
      * @param type     The {@link ScriptType}.
-     * @param lang     The language for this {@link Script} if the {@link ScriptType} is {@link ScriptType#INLINE} or
-     *                 {@link ScriptType#FILE}.  For {@link ScriptType#STORED} scripts this should be null, but can
+     * @param lang     The language for this {@link Script} if the {@link ScriptType} is {@link ScriptType#INLINE}.
+     *                 For {@link ScriptType#STORED} scripts this should be null, but can
      *                 be specified to access scripts stored as part of the stored scripts deprecated API.
-     * @param idOrCode The id for this {@link Script} if the {@link ScriptType} is {@link ScriptType#FILE} or {@link ScriptType#STORED}.
+     * @param idOrCode The id for this {@link Script} if the {@link ScriptType} is {@link ScriptType#STORED}.
      *                 The code for this {@link Script} if the {@link ScriptType} is {@link ScriptType#INLINE}.
      * @param params   The user-defined params to be bound for script execution.
      */
@@ -439,10 +399,10 @@ public Script(ScriptType type, String lang, String idOrCode, Map<String, Object>
     /**
      * Constructor for a script that requires the use of compiler options.
      * @param type     The {@link ScriptType}.
-     * @param lang     The language for this {@link Script} if the {@link ScriptType} is {@link ScriptType#INLINE} or
-     *                 {@link ScriptType#FILE}.  For {@link ScriptType#STORED} scripts this should be null, but can
+     * @param lang     The language for this {@link Script} if the {@link ScriptType} is {@link ScriptType#INLINE}.
+     *                 For {@link ScriptType#STORED} scripts this should be null, but can
      *                 be specified to access scripts stored as part of the stored scripts deprecated API.
-     * @param idOrCode The id for this {@link Script} if the {@link ScriptType} is {@link ScriptType#FILE} or {@link ScriptType#STORED}.
+     * @param idOrCode The id for this {@link Script} if the {@link ScriptType} is {@link ScriptType#STORED}.
      *                 The code for this {@link Script} if the {@link ScriptType} is {@link ScriptType#INLINE}.
      * @param options  The map of compiler options for this {@link Script} if the {@link ScriptType}
      *                 is {@link ScriptType#INLINE}, {@code null} otherwise.
@@ -464,15 +424,6 @@ public Script(ScriptType type, String lang, String idOrCode, Map<String, String>
                     "options must be null for [" + ScriptType.STORED.getParseField().getPreferredName() + "] scripts");
             }
 
-            this.options = null;
-        } else if (type == ScriptType.FILE) {
-            this.lang = Objects.requireNonNull(lang);
-
-            if (options != null) {
-                throw new IllegalStateException(
-                    "options must be null for [" + ScriptType.FILE.getParseField().getPreferredName() + "] scripts");
-            }
-
             this.options = null;
         } else {
             throw new IllegalStateException("unknown script type [" + type.getName() + "]");
@@ -701,16 +652,16 @@ public ScriptType getType() {
     }
 
     /**
-     * @return The language for this {@link Script} if the {@link ScriptType} is {@link ScriptType#INLINE} or
-     *         {@link ScriptType#FILE}.  For {@link ScriptType#STORED} scripts this should be null, but can
+     * @return The language for this {@link Script} if the {@link ScriptType} is {@link ScriptType#INLINE}.
+     *         For {@link ScriptType#STORED} scripts this should be null, but can
      *         be specified to access scripts stored as part of the stored scripts deprecated API.
      */
     public String getLang() {
         return lang;
     }
 
     /**
-     * @return The id for this {@link Script} if the {@link ScriptType} is {@link ScriptType#FILE} or {@link ScriptType#STORED}.
+     * @return The id for this {@link Script} if the {@link ScriptType} is {@link ScriptType#STORED}.
      *         The code for this {@link Script} if the {@link ScriptType} is {@link ScriptType#INLINE}.
      */
     public String getIdOrCode() {

core/src/main/java/org/elasticsearch/script/ScriptEngine.java

@@ -35,13 +35,6 @@ public interface ScriptEngine extends Closeable {
      */
     String getType();
 
-    /**
-     * The extension for file scripts in this language.
-     */
-    default String getExtension() {
-        return getType();
-    }
-
     /**
      * Compiles a script.
      * @param scriptName name of the script. {@code null} if it is anonymous (inline).

core/src/main/java/org/elasticsearch/script/ScriptModule.java

@@ -42,10 +42,9 @@ public class ScriptModule {
 
     /**
      * Build from {@linkplain ScriptPlugin}s. Convenient for normal use but not great for tests. See
-     * {@link ScriptModule#ScriptModule(Settings, Environment, ResourceWatcherService, List, List)} for easier use in tests.
+     * {@link ScriptModule#ScriptModule(Settings, List, List)} for easier use in tests.
      */
-    public static ScriptModule create(Settings settings, Environment environment,
-                                      ResourceWatcherService resourceWatcherService, List<ScriptPlugin> scriptPlugins) {
+    public static ScriptModule create(Settings settings, List<ScriptPlugin> scriptPlugins) {
         Map<String, NativeScriptFactory> factoryMap = scriptPlugins.stream().flatMap(x -> x.getNativeScripts().stream())
             .collect(Collectors.toMap(NativeScriptFactory::getName, Function.identity()));
         NativeScriptEngine nativeScriptEngineService = new NativeScriptEngine(settings, factoryMap);
@@ -54,21 +53,19 @@ public static ScriptModule create(Settings settings, Environment environment,
         scriptEngines.add(nativeScriptEngineService);
         List<ScriptContext.Plugin> plugins = scriptPlugins.stream().map(x -> x.getCustomScriptContexts()).filter(Objects::nonNull)
                 .collect(Collectors.toList());
-        return new ScriptModule(settings, environment, resourceWatcherService, scriptEngines, plugins);
+        return new ScriptModule(settings, scriptEngines, plugins);
     }
 
     /**
      * Build {@linkplain ScriptEngine} and {@linkplain ScriptContext.Plugin}.
      */
-    public ScriptModule(Settings settings, Environment environment,
-                        ResourceWatcherService resourceWatcherService, List<ScriptEngine> scriptEngines,
+    public ScriptModule(Settings settings, List<ScriptEngine> scriptEngines,
                         List<ScriptContext.Plugin> customScriptContexts) {
         ScriptContextRegistry scriptContextRegistry = new ScriptContextRegistry(customScriptContexts);
         ScriptEngineRegistry scriptEngineRegistry = new ScriptEngineRegistry(scriptEngines);
         scriptSettings = new ScriptSettings(scriptEngineRegistry, scriptContextRegistry);
         try {
-            scriptService = new ScriptService(settings, environment, resourceWatcherService, scriptEngineRegistry, scriptContextRegistry,
-                    scriptSettings);
+            scriptService = new ScriptService(settings, scriptEngineRegistry, scriptContextRegistry, scriptSettings);
         } catch (IOException e) {
             throw new RuntimeException("Couldn't setup ScriptService", e);
         }