com.uber.cadence.internal.replay.MarkerHandler Maven / Gradle / Ivy

Go to download
/*
 *  Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 *  Modifications copyright (C) 2017 Uber Technologies, Inc.
 *
 *  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 com.uber.cadence.internal.replay;

import com.uber.cadence.EventType;
import com.uber.cadence.Header;
import com.uber.cadence.HistoryEvent;
import com.uber.cadence.MarkerRecordedEventAttributes;
import com.uber.cadence.converter.DataConverter;
import com.uber.cadence.workflow.Functions.Func1;
import com.uber.m3.util.ImmutableMap;
import java.nio.ByteBuffer;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;

class MarkerHandler {
  // Including mutable side effect and version marker.
  private static final String MUTABLE_MARKER_HEADER_KEY = "MutableMarkerHeader";

  private static final class MarkerResult {

    private final byte[] data;

    /**
     * Count of how many times handle was called since the last marker recorded. It is used to
     * ensure that an updated value is returned after the same exact number of times during a
     * replay.
     */
    private int accessCount;

    private MarkerResult(byte[] data) {
      this.data = data;
    }

    public byte[] getData() {
      accessCount++;
      return data;
    }

    int getAccessCount() {
      return accessCount;
    }
  }

  interface MarkerInterface {
    String getId();

    long getEventId();

    int getAccessCount();

    byte[] getData();

    static MarkerInterface fromEventAttributes(
        MarkerRecordedEventAttributes attributes, DataConverter converter) {
      if (attributes.getHeader() != null
          && attributes.getHeader().getFields() != null
          && attributes.getHeader().getFields().containsKey(MUTABLE_MARKER_HEADER_KEY)) {
        ByteBuffer byteBuffer = attributes.getHeader().getFields().get(MUTABLE_MARKER_HEADER_KEY);
        byte[] bytes = org.apache.thrift.TBaseHelper.byteBufferToByteArray(byteBuffer);
        MarkerData.MarkerHeader header =
            converter.fromData(bytes, MarkerData.MarkerHeader.class, MarkerData.MarkerHeader.class);
        return new MarkerData(header, attributes.getDetails());
      }

      return converter.fromData(
          attributes.getDetails(), PlainMarkerData.class, PlainMarkerData.class);
    }
  }

  static final class MarkerData implements MarkerInterface {

    private static final class MarkerHeader {
      private final String id;
      private final long eventId;
      private final int accessCount;

      MarkerHeader(String id, long eventId, int accessCount) {
        this.id = id;
        this.eventId = eventId;
        this.accessCount = accessCount;
      }
    }

    private final MarkerHeader header;
    private final byte[] data;

    MarkerData(String id, long eventId, byte[] data, int accessCount) {
      this.header = new MarkerHeader(id, eventId, accessCount);
      this.data = data;
    }

    MarkerData(MarkerHeader header, byte[] data) {
      this.header = header;
      this.data = data;
    }

    @Override
    public String getId() {
      return header.id;
    }

    @Override
    public long getEventId() {
      return header.eventId;
    }

    @Override
    public byte[] getData() {
      return data;
    }

    @Override
    public int getAccessCount() {
      return header.accessCount;
    }

    Header getHeader(DataConverter converter) {
      byte[] headerData = converter.toData(header);
      Header header = new Header();
      header.setFields(ImmutableMap.of(MUTABLE_MARKER_HEADER_KEY, ByteBuffer.wrap(headerData)));
      return header;
    }
  }

  static final class PlainMarkerData implements MarkerInterface {

    private final String id;
    private final long eventId;
    private final byte[] data;
    private final int accessCount;

    PlainMarkerData(String id, long eventId, byte[] data, int accessCount) {
      this.id = id;
      this.eventId = eventId;
      this.data = data;
      this.accessCount = accessCount;
    }

    @Override
    public String getId() {
      return id;
    }

    @Override
    public long getEventId() {
      return eventId;
    }

    @Override
    public byte[] getData() {
      return data;
    }

    @Override
    public int getAccessCount() {
      return accessCount;
    }
  }

  private final DecisionsHelper decisions;
  private final String markerName;
  private final ReplayAware replayContext;

  // Key is marker id
  private final Map mutableMarkerResults = new HashMap<>();

  MarkerHandler(DecisionsHelper decisions, String markerName, ReplayAware replayContext) {
    this.decisions = decisions;
    this.markerName = markerName;
    this.replayContext = replayContext;
  }

  /**
   * @param id marker id
   * @param func given the value from the last marker returns value to store. If result is empty
   *     nothing is recorded into the history.
   * @return the latest value returned by func
   */
  Optional handle(
      String id, DataConverter converter, Func1, Optional> func) {
    MarkerResult result = mutableMarkerResults.get(id);
    Optional stored;
    if (result == null) {
      stored = Optional.empty();
    } else {
      stored = Optional.of(result.getData());
    }
    long eventId = decisions.getNextDecisionEventId();
    int accessCount = result == null ? 0 : result.getAccessCount();

    if (replayContext.isReplaying()) {
      Optional data = getMarkerDataFromHistory(eventId, id, accessCount, converter);
      if (data.isPresent()) {
        // Need to insert marker to ensure that eventId is incremented
        recordMutableMarker(id, eventId, data.get(), accessCount, converter);
        return data;
      }
      return stored;
    }
    Optional toStore = func.apply(stored);
    if (toStore.isPresent()) {
      byte[] data = toStore.get();
      recordMutableMarker(id, eventId, data, accessCount, converter);
      return toStore;
    }
    return stored;
  }

  private Optional getMarkerDataFromHistory(
      long eventId, String markerId, int expectedAcccessCount, DataConverter converter) {
    Optional event = decisions.getOptionalDecisionEvent(eventId);
    if (!event.isPresent() || event.get().getEventType() != EventType.MarkerRecorded) {
      return Optional.empty();
    }

    MarkerRecordedEventAttributes attributes = event.get().getMarkerRecordedEventAttributes();
    String name = attributes.getMarkerName();
    if (!markerName.equals(name)) {
      return Optional.empty();
    }

    MarkerInterface markerData = MarkerInterface.fromEventAttributes(attributes, converter);
    // access count is used to not return data from the marker before the recorded number of calls
    if (!markerId.equals(markerData.getId())
        || markerData.getAccessCount() > expectedAcccessCount) {
      return Optional.empty();
    }
    return Optional.of(markerData.getData());
  }

  private void recordMutableMarker(
      String id, long eventId, byte[] data, int accessCount, DataConverter converter) {
    MarkerData marker = new MarkerData(id, eventId, data, accessCount);
    mutableMarkerResults.put(id, new MarkerResult(data));
    decisions.recordMarker(markerName, marker.getHeader(converter), data);
  }
}