Update the version of the CloudEvents SDK to 2.0.0RC2. (GoogleCloudPlatform#79)

Since the API is hopefully stable now, rename `ExperimentalCloudEventsFunction`
to `CloudEventsFunction`.

Add support for a `FUNCTION_SIGNATURE_TYPE` of `cloudevent`. Treat it the same
as `background`. (We don't really need `FUNCTION_SIGNATURE_TYPE`, since the
interface implemented by the function class tells us what the signature is.)

Simplify the integration test slightly by removing some intermediary helper
methods.

Author: eamonnmcmanus

.gitignore

@@ -44,3 +44,4 @@ properties
 
 # IDE
 .vscode/
+/invoker/target/

functions-framework-api/pom.xml

@@ -52,7 +52,7 @@
     <dependency>
       <groupId>io.cloudevents</groupId>
       <artifactId>cloudevents-api</artifactId>
-      <version>2.0.0-milestone4</version>
+      <version>2.0.0.RC2</version>
     </dependency>
   </dependencies>
 

…ons/ExperimentalCloudEventsFunction.java …cloud/functions/CloudEventsFunction.javafunctions-framework-api/src/main/java/com/google/cloud/functions/ExperimentalCloudEventsFunction.java renamed to functions-framework-api/src/main/java/com/google/cloud/functions/CloudEventsFunction.java functions-framework-api/src/main/java/com/google/cloud/functions/ExperimentalCloudEventsFunction.java renamed to functions-framework-api/src/main/java/com/google/cloud/functions/CloudEventsFunction.java

@@ -4,12 +4,9 @@
 
 /**
  * Represents a Cloud Function that is activated by an event and parsed into a {@link CloudEvent} object.
- * Because the {@link CloudEvent} API is not yet stable, a function implemented using this class may not
- * build or work correctly with later versions of that API. Once the API is stable, this interface will
- * become {@code CloudEventsFunction} and will also be stable.
  */
 @FunctionalInterface
-public interface ExperimentalCloudEventsFunction {
+public interface CloudEventsFunction {
   /**
    * Called to service an incoming event. This interface is implemented by user code to
    * provide the action for a given background function. If this method throws any exception

invoker/core/pom.xml

@@ -52,17 +52,17 @@
     <dependency>
       <groupId>io.cloudevents</groupId>
       <artifactId>cloudevents-core</artifactId>
-      <version>2.0.0-milestone4</version>
+      <version>2.0.0.RC2</version>
     </dependency>
     <dependency>
       <groupId>io.cloudevents</groupId>
       <artifactId>cloudevents-http-basic</artifactId>
-      <version>2.0.0-milestone4</version>
+      <version>2.0.0.RC2</version>
     </dependency>
     <dependency>
       <groupId>io.cloudevents</groupId>
       <artifactId>cloudevents-json-jackson</artifactId>
-      <version>2.0.0-milestone4</version>
+      <version>2.0.0.RC2</version>
     </dependency>
     <dependency>
       <groupId>com.google.code.gson</groupId>

invoker/core/src/main/java/com/google/cloud/functions/invoker/BackgroundFunctionExecutor.java

@@ -20,7 +20,6 @@
 
 import com.google.cloud.functions.BackgroundFunction;
 import com.google.cloud.functions.Context;
-import com.google.cloud.functions.ExperimentalCloudEventsFunction;
 import com.google.cloud.functions.RawBackgroundFunction;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
@@ -46,6 +45,7 @@
 import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
+import com.google.cloud.functions.CloudEventsFunction;
 
 /** Executes the user's background function. */
 public final class BackgroundFunctionExecutor extends HttpServlet {
@@ -60,7 +60,7 @@ private BackgroundFunctionExecutor(FunctionExecutor<?> functionExecutor) {
   private enum FunctionKind {
     BACKGROUND(BackgroundFunction.class),
     RAW_BACKGROUND(RawBackgroundFunction.class),
-    CLOUD_EVENTS(ExperimentalCloudEventsFunction.class);
+    CLOUD_EVENTS(CloudEventsFunction.class);
 
     static final List<FunctionKind> VALUES = Arrays.asList(values());
 
@@ -79,7 +79,7 @@ static Optional<FunctionKind> forClass(Class<?> functionClass) {
   /**
    * Optionally makes a {@link BackgroundFunctionExecutor} for the given class, if it implements one
    * of {@link BackgroundFunction}, {@link RawBackgroundFunction}, or
-   * {@link ExperimentalCloudEventsFunction}. Otherwise returns {@link Optional#empty()}.
+   * {@link CloudEventsFunction}. Otherwise returns {@link Optional#empty()}.
    *
    * @param functionClass the class of a possible background function implementation.
    * @throws RuntimeException if the given class does implement one of the required interfaces, but we are
@@ -98,7 +98,7 @@ public static Optional<BackgroundFunctionExecutor> maybeForClass(Class<?> functi
    *
    * @throws RuntimeException if either the class does not implement one of
    *    {@link BackgroundFunction}, {@link RawBackgroundFunction}, or
-   *    {@link ExperimentalCloudEventsFunction}; or we are unable to construct an instance using its no-arg
+   *    {@link CloudEventsFunction}; or we are unable to construct an instance using its no-arg
    *     constructor.
    */
   public static BackgroundFunctionExecutor forClass(Class<?> functionClass) {
@@ -143,7 +143,7 @@ private static BackgroundFunctionExecutor forClass(Class<?> functionClass, Funct
         executor = new TypedFunctionExecutor<>(maybeTargetType.get(), backgroundFunction);
         break;
       case CLOUD_EVENTS:
-        executor = new CloudEventFunctionExecutor((ExperimentalCloudEventsFunction) instance);
+        executor = new CloudEventFunctionExecutor((CloudEventsFunction) instance);
         break;
       default: // can't happen, we've listed all the FunctionKind values already.
         throw new AssertionError(functionKind);
@@ -299,9 +299,9 @@ void serviceCloudEvent(CloudEvent cloudEvent) throws Exception {
   }
 
   private static class CloudEventFunctionExecutor extends FunctionExecutor<Void> {
-    private final ExperimentalCloudEventsFunction function;
+    private final CloudEventsFunction function;
 
-    CloudEventFunctionExecutor(ExperimentalCloudEventsFunction function) {
+    CloudEventFunctionExecutor(CloudEventsFunction function) {
       super(function.getClass());
       this.function = function;
     }

invoker/core/src/main/java/com/google/cloud/functions/invoker/runner/Invoker.java

@@ -19,10 +19,7 @@
 import com.beust.jcommander.JCommander;
 import com.beust.jcommander.Parameter;
 import com.beust.jcommander.ParameterException;
-import com.google.cloud.functions.BackgroundFunction;
-import com.google.cloud.functions.ExperimentalCloudEventsFunction;
 import com.google.cloud.functions.HttpFunction;
-import com.google.cloud.functions.RawBackgroundFunction;
 import com.google.cloud.functions.invoker.BackgroundFunctionExecutor;
 import com.google.cloud.functions.invoker.HttpFunctionExecutor;
 import com.google.cloud.functions.invoker.gcf.JsonLogHandler;
@@ -247,17 +244,24 @@ public void startServer() throws Exception {
     Class<?> functionClass = loadFunctionClass();
 
     HttpServlet servlet;
-    if ("http".equals(functionSignatureType)) {
-        servlet = HttpFunctionExecutor.forClass(functionClass);
-    } else if ("event".equals(functionSignatureType)) {
-        servlet = BackgroundFunctionExecutor.forClass(functionClass);
-    } else if (functionSignatureType == null) {
-        servlet = servletForDeducedSignatureType(functionClass);
+    if (functionSignatureType == null) {
+      servlet = servletForDeducedSignatureType(functionClass);
     } else {
-      String error = String.format(
-          "Function signature type %s is unknown; should be \"http\" or \"event\"",
-          functionSignatureType);
-      throw new RuntimeException(error);
+      switch (functionSignatureType) {
+        case "http":
+          servlet = HttpFunctionExecutor.forClass(functionClass);
+          break;
+        case "event":
+        case "cloudevent":
+          servlet = BackgroundFunctionExecutor.forClass(functionClass);
+          break;
+        default:
+          String error = String.format(
+              "Function signature type %s is unknown; should be \"http\", \"event\","
+                  + " or \"cloudevent\"",
+              functionSignatureType);
+          throw new RuntimeException(error);
+      }
     }
     ServletHolder servletHolder = new ServletHolder(servlet);
     servletHolder.getRegistration().setMultipartConfig(new MultipartConfigElement(""));

invoker/core/src/test/java/com/google/cloud/functions/invoker/IntegrationTest.java

@@ -364,6 +364,7 @@ private void backgroundTest(String target) throws Exception {
         .build();
 
     backgroundTest(
+        SignatureType.BACKGROUND,
         fullTarget(target),
         ImmutableList.of(gcfTestCase, cloudEventsStructuredTestCase, cloudEventsBinaryTestCase));
   }
@@ -401,6 +402,7 @@ public void nativeCloudEvent() throws Exception {
         .build();
 
     backgroundTest(
+        SignatureType.CLOUD_EVENT,
         fullTarget("CloudEventSnoop"),
         ImmutableList.of(cloudEventsStructuredTestCase, cloudEventsBinaryTestCase));
   }
@@ -472,7 +474,9 @@ public void classpathOptionHttp() throws Exception {
         .setUrl("/?class=" + INTERNAL_CLASS.getName())
         .setExpectedResponseText("OK")
         .build();
-    testHttpFunction("com.example.functionjar.Foreground",
+    testFunction(
+        SignatureType.HTTP,
+        "com.example.functionjar.Foreground",
         ImmutableList.of("--classpath", functionJarString()),
         ImmutableList.of(testCase));
   }
@@ -487,7 +491,9 @@ public void classpathOptionBackground() throws Exception {
     JsonObject json = gson.fromJson(originalJson, JsonObject.class);
     JsonObject jsonData = json.getAsJsonObject("data");
     jsonData.addProperty("class", INTERNAL_CLASS.getName());
-    testBackgroundFunction("com.example.functionjar.Background",
+    testFunction(
+        SignatureType.BACKGROUND,
+        "com.example.functionjar.Background",
         ImmutableList.of("--classpath", functionJarString()),
         ImmutableList.of(TestCase.builder().setRequestText(json.toString()).build()));
   }
@@ -497,11 +503,13 @@ public void classpathOptionBackground() throws Exception {
   // event. We start with a fixed body and insert into its JSON an extra property that tells the
   // function where to write what it received. We have to do this since background functions, by
   // design, don't return a value.
-  private void backgroundTest(String functionTarget, List<TestCase> testCases) throws Exception {
+  private void backgroundTest(
+      SignatureType signatureType, String functionTarget, List<TestCase> testCases)
+      throws Exception {
     for (TestCase testCase : testCases) {
       File snoopFile = testCase.snoopFile().get();
       snoopFile.delete();
-      testBackgroundFunction(functionTarget, ImmutableList.of(testCase));
+      testFunction(signatureType, functionTarget, ImmutableList.of(), ImmutableList.of(testCase));
       String snooped = new String(Files.readAllBytes(snoopFile.toPath()), StandardCharsets.UTF_8);
       Gson gson = new Gson();
       JsonObject snoopedJson = gson.fromJson(snooped, JsonObject.class);
@@ -522,23 +530,7 @@ private void checkSnoopFile(TestCase testCase) throws IOException {
   }
 
   private void testHttpFunction(String target, List<TestCase> testCases) throws Exception {
-    testHttpFunction(target, ImmutableList.of(), testCases);
-  }
-
-  private void testHttpFunction(
-      String target, ImmutableList<String> extraArgs, List<TestCase> testCases) throws Exception {
-    testFunction(SignatureType.HTTP, target, extraArgs, testCases);
-  }
-
-  private void testBackgroundFunction(String target, List<TestCase> testCases)
-      throws Exception {
-    testBackgroundFunction(target, ImmutableList.of(), testCases);
-  }
-
-  private void testBackgroundFunction(
-      String target, ImmutableList<String> extraArgs, List<TestCase> testCases)
-      throws Exception {
-    testFunction(SignatureType.BACKGROUND, target, extraArgs, testCases);
+    testFunction(SignatureType.HTTP, target, ImmutableList.of(), testCases);
   }
 
   private void testFunction(
@@ -584,7 +576,8 @@ private void testFunction(
 
   private enum SignatureType {
     HTTP("http"),
-    BACKGROUND("event");
+    BACKGROUND("event"),
+    CLOUD_EVENT("cloudevent");
 
     private final String name;
 

invoker/core/src/test/java/com/google/cloud/functions/invoker/testfunctions/CloudEventSnoop.java

@@ -2,16 +2,16 @@
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 
-import com.google.cloud.functions.ExperimentalCloudEventsFunction;
 import com.google.gson.Gson;
 import com.google.gson.JsonObject;
 import io.cloudevents.CloudEvent;
 import io.cloudevents.core.format.EventFormat;
 import io.cloudevents.core.provider.EventFormatProvider;
 import io.cloudevents.jackson.JsonFormat;
 import java.io.FileOutputStream;
+import com.google.cloud.functions.CloudEventsFunction;
 
-public class CloudEventSnoop implements ExperimentalCloudEventsFunction {
+public class CloudEventSnoop implements CloudEventsFunction {
   @Override
   public void accept(CloudEvent event) throws Exception {
     String payloadJson = new String(event.getData().toBytes(), UTF_8);

invoker/pom.xml

@@ -42,7 +42,7 @@
       <dependency>
         <groupId>com.google.cloud.functions</groupId>
         <artifactId>functions-framework-api</artifactId>
-        <version>1.0.3</version>
+        <version>1.0.4-SNAPSHOT</version>
       </dependency>
     </dependencies>
   </dependencyManagement>