-
Notifications
You must be signed in to change notification settings - Fork 652
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(pubsub): Encapsulate logic for creating events (#523)
* feat(pubsub): Send pubsub events through eventPropagator Currently all pubsub events are sent directly to the trigger event listener, rather than to the general eventPropagator (which notifies all event listeners). This means that pubsub events can never do anything other than start pipelines. (Other incoming events, such as webhooks or build notifications are sent to the general eventPropagator.) In order to allow pubsub messages to do other things than start pipelines, send the resulting event to the eventPropagator so that other listeners can act on these events. * refactor(pubsub): Encapsulate logic for creating events The logic for extracting artifacts from pubsub events and for creating events from the message is embedded in the logic for handling these messages. In order to allow more general events to be created from pubsub messages, create an interface EventCreator that handles creating an event from a pubsub MessageDescription. The initial implementation of EventCreator will extract artifacts and create exactly the same event as prior to this change, allowing us to remove the code from the pubsub subscribers and handler. When setting up a subscription it is now possible to pass in a custom EventCreator so that messages read from that subscription create arbitrary event types.
- Loading branch information
Showing
9 changed files
with
203 additions
and
135 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
90 changes: 90 additions & 0 deletions
90
echo-pubsub-core/src/main/java/com/netflix/spinnaker/echo/pubsub/PubsubEventCreator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| /* | ||
| * Copyright 2019 Google, 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.pubsub; | ||
|
|
||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import com.hubspot.jinjava.interpret.FatalTemplateErrorsException; | ||
| import com.netflix.spinnaker.echo.artifacts.MessageArtifactTranslator; | ||
| import com.netflix.spinnaker.echo.model.Event; | ||
| import com.netflix.spinnaker.echo.model.Metadata; | ||
| import com.netflix.spinnaker.echo.model.pubsub.MessageDescription; | ||
| import com.netflix.spinnaker.echo.pipelinetriggers.eventhandlers.PubsubEventHandler; | ||
| import com.netflix.spinnaker.echo.pubsub.model.EventCreator; | ||
| import com.netflix.spinnaker.kork.artifacts.model.Artifact; | ||
| import lombok.extern.slf4j.Slf4j; | ||
| import org.springframework.util.CollectionUtils; | ||
| import org.springframework.util.StringUtils; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.*; | ||
|
|
||
| /** | ||
| * An EventCreator that extracts artifacts from an incoming message and creates an event of type pubsub from the | ||
| * message and artifacts. | ||
| */ | ||
| @Slf4j | ||
| public class PubsubEventCreator implements EventCreator { | ||
| private final ObjectMapper objectMapper = new ObjectMapper(); | ||
| private final Optional<MessageArtifactTranslator> messageArtifactTranslator; | ||
|
|
||
| public PubsubEventCreator(Optional<MessageArtifactTranslator> messageArtifactTranslator) { | ||
| this.messageArtifactTranslator = messageArtifactTranslator; | ||
| } | ||
|
|
||
| public Event createEvent(MessageDescription description) { | ||
| log.trace("Processing pubsub event with payload {}", description.getMessagePayload()); | ||
|
|
||
| try { | ||
| description.setArtifacts(parseArtifacts(description.getMessagePayload())); | ||
| } catch (FatalTemplateErrorsException e) { | ||
| log.error("Template failed to process artifacts for message {}", description, e); | ||
| } | ||
|
|
||
| Event event = new Event(); | ||
| Map<String, Object> content = new HashMap<>(); | ||
| Metadata details = new Metadata(); | ||
|
|
||
| try { | ||
| event.setPayload(objectMapper.readValue(description.getMessagePayload(), Map.class)); | ||
| } catch (IOException e) { | ||
| log.warn("Could not parse message payload as JSON", e); | ||
| } | ||
|
|
||
| content.put("messageDescription", description); | ||
| details.setType(PubsubEventHandler.PUBSUB_TRIGGER_TYPE); | ||
|
|
||
| if (description.getMessageAttributes() != null) { | ||
| details.setAttributes(description.getMessageAttributes()); | ||
| } | ||
|
|
||
| event.setContent(content); | ||
| event.setDetails(details); | ||
| return event; | ||
| } | ||
|
|
||
| private List<Artifact> parseArtifacts(String messagePayload) { | ||
| if (!messageArtifactTranslator.isPresent()) { | ||
| return Collections.emptyList(); | ||
| } | ||
| List<Artifact> artifacts = messageArtifactTranslator.get().parseArtifacts(messagePayload); | ||
| // Artifact must have at least a reference defined. | ||
| if (CollectionUtils.isEmpty(artifacts) || StringUtils.isEmpty(artifacts.get(0).getReference())) { | ||
| return Collections.emptyList(); | ||
| } | ||
| return artifacts; | ||
| } | ||
| } |
Oops, something went wrong.