Feature/QueryGroup Add CRUD APIs in plugin

CHANGELOG-3.0.md

@@ -24,6 +24,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Add task completion count in search backpressure stats API ([#10028](https://github.com/opensearch-project/OpenSearch/pull/10028/))
 - Deprecate CamelCase `PathHierarchy` tokenizer name in favor to lowercase `path_hierarchy` ([#10894](https://github.com/opensearch-project/OpenSearch/pull/10894))
 - Breaking change: Do not request "search_pipelines" metrics by default in NodesInfoRequest ([#12497](https://github.com/opensearch-project/OpenSearch/pull/12497))
+- [Query Sandbox] Add Resource Limit Group CRUD APIs ([#13315](https://github.com/opensearch-project/OpenSearch/pull/13315))
 
 ### Deprecated
 

plugins/query-group/build.gradle

@@ -0,0 +1,18 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+opensearchplugin {
+  description 'OpenSearch QueryGroup Plugin.'
+  classname 'org.opensearch.plugin.qg.QueryGroupPlugin'
+}
+
+dependencies {
+}

plugins/query-group/src/main/java/org/opensearch/plugin/qg/CreateQueryGroupAction.java

@@ -0,0 +1,36 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.plugin.qg;
+
+import org.opensearch.action.ActionType;
+
+/**
+ * Rest action to create QueryGroup
+ *
+ * @opensearch.api
+ */
+public class CreateQueryGroupAction extends ActionType<CreateQueryGroupResponse> {
+
+    /**
+     * An instance of CreateQueryGroupAction
+     */
+    public static final CreateQueryGroupAction INSTANCE = new CreateQueryGroupAction();
+
+    /**
+     * Name for CreateQueryGroupAction
+     */
+    public static final String NAME = "cluster:admin/opensearch/query_group/_create";
+
+    /**
+     * Default constructor
+     */
+    private CreateQueryGroupAction() {
+        super(NAME, CreateQueryGroupResponse::new);
+    }
+}

plugins/query-group/src/main/java/org/opensearch/plugin/qg/CreateQueryGroupRequest.java

@@ -0,0 +1,321 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.plugin.qg;
+
+import org.opensearch.action.ActionRequest;
+import org.opensearch.action.ActionRequestValidationException;
+import org.opensearch.cluster.metadata.QueryGroup;
+import org.opensearch.cluster.metadata.QueryGroup.QueryGroupMode;
+import org.opensearch.common.UUIDs;
+import org.opensearch.core.common.io.stream.StreamInput;
+import org.opensearch.core.common.io.stream.StreamOutput;
+import org.opensearch.core.common.io.stream.Writeable;
+import org.opensearch.core.xcontent.XContentParser;
+import org.joda.time.Instant;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.opensearch.cluster.metadata.QueryGroup.ALLOWED_RESOURCES;
+import static org.opensearch.cluster.metadata.QueryGroup.MAX_CHARS_ALLOWED_IN_NAME;
+
+/**
+ * A request for create QueryGroup
+ * User input schema:
+ *  {
+ *    "jvm": 0.4,
+ *    "mode": "enforced",
+ *    "name": "analytics"
+ *  }
+ *
+ * @opensearch.internal
+ */
+public class CreateQueryGroupRequest extends ActionRequest implements Writeable.Reader<CreateQueryGroupRequest> {
+    private String name;
+    private String _id;
+    private QueryGroupMode mode;
+    private Map<String, Object> resourceLimits;
+    private long updatedAtInMillis;
+
+    /**
+     * Default constructor for CreateQueryGroupRequest
+     */
+    public CreateQueryGroupRequest() {}
+
+    /**
+     * Constructor for CreateQueryGroupRequest
+     * @param queryGroup - A {@link QueryGroup} object
+     */
+    public CreateQueryGroupRequest(QueryGroup queryGroup) {
+        this.name = queryGroup.getName();
+        this._id = queryGroup.get_id();
+        this.resourceLimits = queryGroup.getResourceLimits();
+        this.mode = queryGroup.getMode();
+        this.updatedAtInMillis = queryGroup.getUpdatedAtInMillis();
+        verifyCreateQueryGroupRequest(name, _id, mode, resourceLimits, updatedAtInMillis);
+    }
+
+    /**
+     * Constructor for CreateQueryGroupRequest
+     * @param name - QueryGroup name for CreateQueryGroupRequest
+     * @param _id - QueryGroup _id for CreateQueryGroupRequest
+     * @param mode - QueryGroup mode for CreateQueryGroupRequest
+     * @param resourceLimits - QueryGroup resourceLimits for CreateQueryGroupRequest
+     * @param updatedAtInMillis - QueryGroup updated time in millis for CreateQueryGroupRequest
+     */
+    public CreateQueryGroupRequest(
+        String name,
+        String _id,
+        QueryGroupMode mode,
+        Map<String, Object> resourceLimits,
+        long updatedAtInMillis
+    ) {
+        this.name = name;
+        this._id = _id;
+        this.resourceLimits = resourceLimits;
+        this.mode = mode;
+        this.updatedAtInMillis = updatedAtInMillis;
+        verifyCreateQueryGroupRequest(name, _id, mode, resourceLimits, updatedAtInMillis);
+    }
+
+    /**
+     * Constructor for CreateQueryGroupRequest
+     * @param in - A {@link StreamInput} object
+     */
+    public CreateQueryGroupRequest(StreamInput in) throws IOException {
+        super(in);
+        name = in.readString();
+        _id = in.readString();
+        mode = QueryGroupMode.fromName(in.readString());
+        resourceLimits = in.readMap();
+        updatedAtInMillis = in.readLong();
+        verifyCreateQueryGroupRequest(name, _id, mode, resourceLimits, updatedAtInMillis);
+    }
+
+    /**
+     * Verification for CreateQueryGroupRequest
+     * @param name - QueryGroup name for CreateQueryGroupRequest
+     * @param _id - QueryGroup _id for CreateQueryGroupRequest
+     * @param mode - QueryGroup mode for CreateQueryGroupRequest
+     * @param resourceLimits - QueryGroup resourceLimits for CreateQueryGroupRequest
+     * @param updatedAtInMillis - QueryGroup updated time in millis for CreateQueryGroupRequest
+     */
+    private void verifyCreateQueryGroupRequest(
+        String name,
+        String _id,
+        QueryGroupMode mode,
+        Map<String, Object> resourceLimits,
+        long updatedAtInMillis
+    ) {
+        Objects.requireNonNull(_id, "QueryGroup._id can't be null");
+        Objects.requireNonNull(name, "QueryGroup.name can't be null");
+        Objects.requireNonNull(resourceLimits, "QueryGroup.resourceLimits can't be null");
+        Objects.requireNonNull(mode, "QueryGroup.mode can't be null");
+        Objects.requireNonNull(updatedAtInMillis, "QueryGroup.updatedAtInMillis can't be null");
+
+        validateName(name);
+        validateResourceLimits(resourceLimits);
+        validateUpdatedAtInMillis(updatedAtInMillis);
+    }
+
+    /**
+     * Verification for CreateQueryGroupRequest.name
+     * @param name - name to be verified
+     */
+    public static void validateName(String name) {
+        if (name.isEmpty()) {
+            throw new IllegalArgumentException("QueryGroup.name cannot be empty");
+        }
+        if (name.length() > MAX_CHARS_ALLOWED_IN_NAME) {
+            throw new IllegalArgumentException("QueryGroup.name shouldn't be more than 50 chars long");
+        }
+        if (name.startsWith("-") || name.startsWith("_")) {
+            throw new IllegalArgumentException("QueryGroup.name cannot start with '_' or '-'.");
+        }
+        if (name.matches(".*[ ,:\"*+/\\\\|?#><].*")) {
+            throw new IllegalArgumentException("QueryGroup.name can't contain spaces, commas, quotes, slashes, :, *, +, |, ?, #, >, or <");
+        }
+    }
+
+    /**
+     * Verification for CreateQueryGroupRequest.resourceLimits
+     * @param resourceLimits - resourceLimits to be verified
+     */
+    public static void validateResourceLimits(Map<String, Object> resourceLimits) {
+        if (resourceLimits.isEmpty()) {
+            throw new IllegalArgumentException("QueryGroup.resourceLimits should at least have 1 resource limit.");
+        }
+        for (Map.Entry<String, Object> resource : resourceLimits.entrySet()) {
+            String resourceName = resource.getKey();
+            Double threshold = (Double) resource.getValue();
+            Objects.requireNonNull(resourceName, "resourceName can't be null");
+            Objects.requireNonNull(threshold, "resource value can't be null");
+
+            if (threshold < 0 || threshold > 1) {
+                throw new IllegalArgumentException("Resource value should be between 0 and 1");
+            }
+            String str = String.valueOf(threshold);
+            if (str.contains(".") && str.split("\\.")[1].length() > 2) {
+                throw new IllegalArgumentException("Resource value should have at most two digits after the decimal point");
+            }
+            if (!ALLOWED_RESOURCES.contains(resourceName.toLowerCase(Locale.ROOT))) {
+                throw new IllegalArgumentException(
+                    "resource has to be valid, valid resources are: " + ALLOWED_RESOURCES.stream().reduce((x, e) -> x + ", " + e).get()
+                );
+            }
+        }
+    }
+
+    /**
+     * Verification for CreateQueryGroupRequest.updatedAtInMillis
+     * @param updatedAt - updated time to be verified
+     */
+    public static void validateUpdatedAtInMillis(long updatedAt) {
+        long minValidTimestamp = Instant.ofEpochMilli(0L).getMillis();
+        long currentSeconds = Instant.now().getMillis();
+        if (minValidTimestamp > updatedAt || updatedAt > currentSeconds) {
+            throw new IllegalArgumentException("QueryGroup.updatedAtInMillis is not a valid epoch");
+        }
+    }
+
+    @Override
+    public CreateQueryGroupRequest read(StreamInput in) throws IOException {
+        return new CreateQueryGroupRequest(in);
+    }
+
+    /**
+     * Generate a CreateQueryGroupRequest from XContent
+     * @param parser - A {@link XContentParser} object
+     */
+    public static CreateQueryGroupRequest fromXContent(XContentParser parser) throws IOException {
+
+        while (parser.currentToken() != XContentParser.Token.START_OBJECT) {
+            parser.nextToken();
+        }
+
+        if (parser.currentToken() != XContentParser.Token.START_OBJECT) {
+            throw new IllegalArgumentException("expected start object but got a " + parser.currentToken());
+        }
+
+        XContentParser.Token token;
+        String fieldName = "";
+        String name = null;
+        String _id = UUIDs.randomBase64UUID();
+        QueryGroupMode mode = null;
+        long updatedAtInMillis = Instant.now().getMillis();
+
+        // Map to hold resources
+        final Map<String, Object> resourceLimits_ = new HashMap<>();
+        while ((token = parser.nextToken()) != null) {
+            if (token == XContentParser.Token.FIELD_NAME) {
+                fieldName = parser.currentName();
+            } else if (token.isValue()) {
+                if (fieldName.equals("name")) {
+                    name = parser.text();
+                } else if (fieldName.equals("mode")) {
+                    mode = QueryGroupMode.fromName(parser.text());
+                } else if (ALLOWED_RESOURCES.contains(fieldName)) {
+                    resourceLimits_.put(fieldName, parser.doubleValue());
+                } else {
+                    throw new IllegalArgumentException("unrecognised [field=" + fieldName + " in QueryGroup");
+                }
+            }
+        }
+        return new CreateQueryGroupRequest(name, _id, mode, resourceLimits_, updatedAtInMillis);
+    }
+
+    @Override
+    public ActionRequestValidationException validate() {
+        return null;
+    }
+
+    /**
+     * name getter
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * name setter
+     * @param name - name to be set
+     */
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    /**
+     * resourceLimits getter
+     */
+    public Map<String, Object> getResourceLimits() {
+        return resourceLimits;
+    }
+
+    /**
+     * resourceLimits setter
+     * @param resourceLimits - resourceLimit to be set
+     */
+    public void setResourceLimits(Map<String, Object> resourceLimits) {
+        this.resourceLimits = resourceLimits;
+    }
+
+    /**
+     * mode getter
+     */
+    public QueryGroupMode getMode() {
+        return mode;
+    }
+
+    /**
+     * mode setter
+     * @param mode - mode to be set
+     */
+    public void setMode(QueryGroupMode mode) {
+        this.mode = mode;
+    }
+
+    @Override
+    public void writeTo(StreamOutput out) throws IOException {
+        super.writeTo(out);
+        QueryGroup.writeToOutputStream(out, name, _id, mode, resourceLimits, updatedAtInMillis);
+    }
+
+    /**
+     * _id getter
+     */
+    public String get_id() {
+        return _id;
+    }
+
+    /**
+     * UUID setter
+     * @param _id - _id to be set
+     */
+    public void set_id(String _id) {
+        this._id = _id;
+    }
+
+    /**
+     * updatedAtInMillis getter
+     */
+    public long getUpdatedAtInMillis() {
+        return updatedAtInMillis;
+    }
+
+    /**
+     * updatedAtInMillis setter
+     * @param updatedAtInMillis - updatedAtInMillis to be set
+     */
+    public void setUpdatedAtInMillis(long updatedAtInMillis) {
+        this.updatedAtInMillis = updatedAtInMillis;
+    }
+}