Update to give more preference to operation with outputs

Author: joviegas

codegen/src/main/java/software/amazon/awssdk/codegen/poet/crac/WarmUpOperationSelector.java

@@ -0,0 +1,124 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.codegen.poet.crac;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.List;
+import java.util.Optional;
+import software.amazon.awssdk.codegen.model.intermediate.IntermediateModel;
+import software.amazon.awssdk.codegen.model.intermediate.MemberModel;
+import software.amazon.awssdk.codegen.model.intermediate.OperationModel;
+import software.amazon.awssdk.codegen.model.intermediate.ShapeModel;
+import software.amazon.awssdk.utils.CollectionUtils;
+import software.amazon.awssdk.utils.NumericUtils;
+
+/**
+ * Selects the operation used for the CRaC warm-up call: filters out streaming/event-stream and deprecated
+ * operations, then ranks the rest (see {@link #warmUpPreference}).
+ */
+public final class WarmUpOperationSelector {
+
+    private static final List<String> PREFERRED_VERBS = Arrays.asList("List", "Describe", "Get");
+
+    private static final Comparator<OperationModel> BY_EMPTY_REQUEST_FIRST =
+        Comparator.comparing(op -> !acceptsEmptyRequest(op));
+
+    private static final Comparator<OperationModel> BY_FEWEST_REQUIRED_INPUTS =
+        Comparator.comparingInt(WarmUpOperationSelector::requiredInputMemberCount);
+
+    private static final Comparator<OperationModel> BY_HAS_OUTPUT_FIRST =
+        Comparator.comparing(op -> !hasOutput(op));
+
+    private static final Comparator<OperationModel> BY_PREFERRED_VERB =
+        Comparator.comparingInt(WarmUpOperationSelector::verbRank);
+
+    private static final Comparator<OperationModel> BY_NAME_ALPHABETICAL =
+        Comparator.comparing(OperationModel::getOperationName);
+
+    private WarmUpOperationSelector() {
+    }
+
+    /**
+     * Selects the warm-up operation for the given service, or {@link Optional#empty()} if no operation is safe to
+     * call as a warm-up.
+     */
+    public static Optional<OperationModel> selectWarmUpOperation(IntermediateModel model) {
+        List<String> verifiedSimpleMethods = model.getCustomizationConfig().getVerifiedSimpleMethods();
+        Comparator<OperationModel> preference = warmUpPreference(verifiedSimpleMethods);
+
+        return model.getOperations().values().stream()
+                    .filter(WarmUpOperationSelector::passesHardGates)
+                    .min(preference);
+    }
+
+    /**
+     * Preference order: returns output (so the unmarshaller is primed too), verified simple method, accepts an
+     * empty request, fewest required input members, read-only verb, then operation name as the deterministic
+     * tie-break.
+     */
+    private static Comparator<OperationModel> warmUpPreference(List<String> verifiedSimpleMethods) {
+        Comparator<OperationModel> byVerifiedSimpleFirst =
+            Comparator.comparing(op -> !verifiedSimpleMethods.contains(op.getMethodName()));
+
+        return BY_HAS_OUTPUT_FIRST
+            .thenComparing(byVerifiedSimpleFirst)
+            .thenComparing(BY_EMPTY_REQUEST_FIRST)
+            .thenComparing(BY_FEWEST_REQUIRED_INPUTS)
+            .thenComparing(BY_PREFERRED_VERB)
+            .thenComparing(BY_NAME_ALPHABETICAL);
+    }
+
+    private static boolean passesHardGates(OperationModel operation) {
+        return !isStreamingOrEventStream(operation)
+               && !operation.isDeprecated();
+    }
+
+    private static boolean isStreamingOrEventStream(OperationModel operation) {
+        return operation.isStreaming() || operation.hasEventStreamInput() || operation.hasEventStreamOutput();
+    }
+
+    private static boolean acceptsEmptyRequest(OperationModel operation) {
+        return requiredInputMemberCount(operation) == 0;
+    }
+
+    private static boolean hasOutput(OperationModel operation) {
+        return operation.getOutputShape() != null;
+    }
+
+    private static int requiredInputMemberCount(OperationModel operation) {
+        return NumericUtils.saturatedCast(inputMembers(operation).stream().filter(MemberModel::isRequired).count());
+    }
+
+    private static List<MemberModel> inputMembers(OperationModel operation) {
+        ShapeModel inputShape = operation.getInputShape();
+        if (inputShape == null || CollectionUtils.isNullOrEmpty(inputShape.getMembers())) {
+            return Collections.emptyList();
+        }
+        return inputShape.getMembers();
+    }
+
+    private static int verbRank(OperationModel operation) {
+        String operationName = operation.getOperationName();
+        for (int i = 0; i < PREFERRED_VERBS.size(); i++) {
+            if (operationName.startsWith(PREFERRED_VERBS.get(i))) {
+                return i;
+            }
+        }
+        return Integer.MAX_VALUE;
+    }
+}