refactor(api): Move EventListener and dependent classes to echo-api, remove previous RestEventParser

echo-api/README.md

@@ -1,12 +1,6 @@
 # echo-api
 
-A module for defining plugin extension interfaces.
+This module provides API interfaces and models.  In particular, it offers the following PF4J
+`ExtensionPoint` interfaces for runtime extension:
 
-WARNING: This is an Alpha module and is not stable.  Consider this an experiment.
-
-Currently there is one extension point `RestEventParser` which is limited to parsing events 
-in echo's `RestEventListener`.  This is primarily for early iteration and testing purposes.
-
-The more powerful extension point for Echo is likely to be `EchoEventListener` - this would enable a plugin
-ecosystem for Echo and also allow us to break existing implementations of `EchoEventListener` 
-(echo-rest, echo-notifications, echo-telemetry, etc) up into discrete plugins.
+- [EventListener](src/main/java/com/netflix/spinnaker/echo/api/events/EventListener.java)

echo-api/echo-api.gradle

@@ -1,3 +1,10 @@
+/*
+ * DO NOT ADD ANY ADDITIONAL NON-TEST DEPENDENCIES HERE!
+ *
+ * This module should be the only thing required by plugin implementors. In order to
+ * avoid dependency conflicts we should bring the bare minimum of transitive
+ * dependencies along for the ride -- ideally nothing besides kork-plugins-api.
+ */
 dependencies {
   api "com.netflix.spinnaker.kork:kork-plugins-api"
 

echo-model/src/main/java/com/netflix/spinnaker/echo/model/Event.java → echo-api/src/main/java/com/netflix/spinnaker/echo/api/events/Event.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2015 Netflix, Inc.
+ * Copyright 2020 Netflix, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *    http://www.apache.org/licenses/LICENSE-2.0
+ *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,9 +14,8 @@
  * limitations under the License.
  */
 
-package com.netflix.spinnaker.echo.model;
+package com.netflix.spinnaker.echo.api.events;
 
-import com.fasterxml.jackson.annotation.JsonInclude;
 import java.util.Map;
 import java.util.UUID;
 import lombok.Data;
@@ -25,11 +24,9 @@
 @Data
 public class Event {
   public Metadata details;
-  public Map content;
+  public Map<String, Object> content;
   public String rawContent;
-
-  @JsonInclude(JsonInclude.Include.NON_NULL)
-  public Map payload;
+  public Map<String, Object> payload;
 
   public String eventId = UUID.randomUUID().toString();
 }

echo-api/src/main/java/com/netflix/spinnaker/echo/api/events/EventListener.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2020 Netflix, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License 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 com.netflix.spinnaker.echo.api.events;
+
+import org.pf4j.ExtensionPoint;
+
+/**
+ * This is the main touch point for Echo. Implementations of `EventListener` will, if wired up as a
+ * Spring bean, process all events that are posted into Echo.
+ */
+public interface EventListener extends ExtensionPoint {
+
+  /** Process an Echo {@link Event} */
+  void processEvent(Event event);
+}

echo-model/src/main/java/com/netflix/spinnaker/echo/model/Metadata.java → echo-api/src/main/java/com/netflix/spinnaker/echo/api/events/Metadata.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2015 Netflix, Inc.
+ * Copyright 2020 Netflix, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *    http://www.apache.org/licenses/LICENSE-2.0
+ *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,12 +14,15 @@
  * limitations under the License.
  */
 
-package com.netflix.spinnaker.echo.model;
+package com.netflix.spinnaker.echo.api.events;
 
 import java.util.Date;
+import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
-import lombok.*;
-import org.springframework.http.HttpHeaders;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
 
 /** Represents event metadata */
 @Data
@@ -33,6 +36,6 @@ public class Metadata {
   private String project;
   private String application;
   private String _content_id;
-  private Map attributes;
-  private HttpHeaders requestHeaders = new HttpHeaders();
+  private Map<String, String> attributes;
+  private Map<String, List<String>> requestHeaders = new HashMap<>();
 }

echo-core/echo-core.gradle

@@ -15,6 +15,7 @@
  */
 
 dependencies {
+    api project(":echo-api")
     implementation project(":echo-model")
 
     api "com.netflix.spinnaker.kork:kork-plugins"

echo-core/src/main/java/com/netflix/spinnaker/echo/build/BuildInfoService.java

@@ -18,6 +18,7 @@
 
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.netflix.spinnaker.echo.jackson.EchoObjectMapper;
 import com.netflix.spinnaker.echo.model.Trigger;
 import com.netflix.spinnaker.echo.model.trigger.BuildEvent;
 import com.netflix.spinnaker.echo.services.IgorService;
@@ -39,7 +40,7 @@
 public class BuildInfoService {
   private final IgorService igorService;
   private final RetrySupport retrySupport;
-  private final ObjectMapper objectMapper = new ObjectMapper();
+  private final ObjectMapper objectMapper = EchoObjectMapper.getInstance();
 
   // Manual triggers try to replicate actual events (and in some cases build events) but rather than
   // pass the event to

echo-core/src/main/java/com/netflix/spinnaker/echo/config/EchoCoreConfig.java

@@ -17,8 +17,8 @@
 package com.netflix.spinnaker.echo.config;
 
 import com.netflix.spinnaker.config.PluginsAutoConfiguration;
+import com.netflix.spinnaker.echo.api.events.EventListener;
 import com.netflix.spinnaker.echo.discovery.DiscoveryPollingConfiguration;
-import com.netflix.spinnaker.echo.events.EchoEventListener;
 import com.netflix.spinnaker.echo.events.EventPropagator;
 import com.netflix.spinnaker.kork.PlatformComponents;
 import com.netflix.spinnaker.kork.artifacts.parsing.DefaultJinjavaFactory;
@@ -55,7 +55,7 @@ public EchoCoreConfig(ApplicationContext context) {
   @Bean
   public EventPropagator propagator() {
     EventPropagator instance = new EventPropagator();
-    for (EchoEventListener e : context.getBeansOfType(EchoEventListener.class).values()) {
+    for (EventListener e : context.getBeansOfType(EventListener.class).values()) {
       instance.addListener(e);
     }
     return instance;

echo-core/src/main/java/com/netflix/spinnaker/echo/events/EventPropagator.java

@@ -16,7 +16,8 @@
 
 package com.netflix.spinnaker.echo.events;
 
-import com.netflix.spinnaker.echo.model.Event;
+import com.netflix.spinnaker.echo.api.events.Event;
+import com.netflix.spinnaker.echo.api.events.EventListener;
 import com.netflix.spinnaker.security.AuthenticatedRequest;
 import java.util.ArrayList;
 import java.util.List;
@@ -29,10 +30,10 @@
 @Slf4j
 @SuppressWarnings({"CatchException"})
 public class EventPropagator {
-  private List<EchoEventListener> listeners = new ArrayList<>();
+  private List<EventListener> listeners = new ArrayList<>();
   private Scheduler scheduler = Schedulers.io();
 
-  public void addListener(EchoEventListener listener) {
+  public void addListener(EventListener listener) {
     listeners.add(listener);
     log.info("Added listener " + listener.getClass().getSimpleName());
   }

echo-core/src/main/java/com/netflix/spinnaker/echo/jackson/EchoObjectMapper.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2020 Netflix, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License 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 com.netflix.spinnaker.echo.jackson;
+
+import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL;
+import static com.fasterxml.jackson.databind.DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+import com.netflix.spinnaker.echo.api.events.Event;
+import com.netflix.spinnaker.echo.jackson.mixin.EventMixin;
+
+public class EchoObjectMapper {
+  private EchoObjectMapper() {}
+
+  private static final ObjectMapper INSTANCE = newInstance();
+
+  public static ObjectMapper newInstance() {
+    return new ObjectMapper()
+        .addMixIn(Event.class, EventMixin.class)
+        .registerModule(new Jdk8Module())
+        .registerModule(new JavaTimeModule())
+        .disable(FAIL_ON_UNKNOWN_PROPERTIES)
+        .setSerializationInclusion(NON_NULL);
+  }
+
+  /**
+   * Return an ObjectMapper instance that can be reused. Do not change the configuration of this
+   * instance as it will be shared across the entire application, use {@link #newInstance()}
+   * instead.
+   *
+   * @return Reusable ObjectMapper instance
+   */
+  public static ObjectMapper getInstance() {
+    return INSTANCE;
+  }
+}

echo-model/src/main/java/com/netflix/spinnaker/echo/events/EchoEventListener.java → echo-core/src/main/java/com/netflix/spinnaker/echo/jackson/mixin/EventMixin.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2015 Netflix, Inc.
+ * Copyright 2020 Netflix, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *    http://www.apache.org/licenses/LICENSE-2.0
+ *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,10 +14,15 @@
  * limitations under the License.
  */
 
-package com.netflix.spinnaker.echo.events;
+package com.netflix.spinnaker.echo.jackson.mixin;
 
-import com.netflix.spinnaker.echo.model.Event;
+import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL;
 
-public interface EchoEventListener {
-  void processEvent(Event event);
+import com.fasterxml.jackson.annotation.JsonInclude;
+import java.util.Map;
+
+public abstract class EventMixin {
+
+  @JsonInclude(NON_NULL)
+  public Map<String, Object> payload;
 }

echo-core/src/test/groovy/com/netflix/spinnaker/echo/events/EventPropagationSpec.groovy

@@ -15,7 +15,8 @@
  */
 package com.netflix.spinnaker.echo.events
 
-import com.netflix.spinnaker.echo.model.Event
+import com.netflix.spinnaker.echo.api.events.EventListener
+import com.netflix.spinnaker.echo.api.events.Event
 import rx.schedulers.Schedulers
 import spock.lang.Specification
 
@@ -29,8 +30,8 @@ class EventPropagationSpec extends Specification {
         given:
         EventPropagator propagator = new EventPropagator()
         propagator.scheduler = Schedulers.immediate()
-        EchoEventListener l1 = Mock(EchoEventListener)
-        EchoEventListener l2 = Mock(EchoEventListener)
+        EventListener l1 = Mock(EventListener)
+        EventListener l2 = Mock(EventListener)
 
         when:
         propagator.addListener(l1)