KAFKA-12648: basic skeleton API for NamedTopology

streams/src/main/java/org/apache/kafka/streams/processor/TaskId.java

@@ -22,30 +22,63 @@
 import java.io.DataOutputStream;
 import java.io.IOException;
 import java.nio.ByteBuffer;
+import java.util.Objects;
+import java.util.Optional;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import static org.apache.kafka.streams.processor.internals.assignment.StreamsAssignmentProtocolVersions.MIN_NAMED_TOPOLOGY_VERSION;
 
 /**
  * The task ID representation composed as topic group ID plus the assigned partition ID.
  */
 public class TaskId implements Comparable<TaskId> {
 
+    private static final Logger LOG = LoggerFactory.getLogger(TaskId.class);
+
     /** The ID of the topic group. */
     public final int topicGroupId;
     /** The ID of the partition. */
     public final int partition;
+    /** The namedTopology that this task belongs to, or null if it does not belong to one */
+    private final String namedTopology;
 
     public TaskId(final int topicGroupId, final int partition) {
+        this(topicGroupId, partition, null);
+    }
+
+    public TaskId(final int topicGroupId, final int partition, final String namedTopology) {
         this.topicGroupId = topicGroupId;
         this.partition = partition;
+        if (namedTopology != null && namedTopology.length() == 0) {
+            LOG.warn("Empty string passed in for task's namedTopology, since NamedTopology name cannot be empty, we "
+                         + "assume this task does not belong to a NamedTopology and downgrade this to null");
+            this.namedTopology = null;
+        } else {
+            this.namedTopology = namedTopology;
+        }
+    }
+
+    public Optional<String> namedTopology() {
+        return namedTopology == null ? Optional.empty() : Optional.of(namedTopology);
     }
 
+    @Override
     public String toString() {
+        return namedTopology != null ? namedTopology + "_" + topicGroupId + "_" + partition : topicGroupId + "_" + partition;
+    }
+
+    public String toTaskDirString() {
         return topicGroupId + "_" + partition;
     }
 
     /**
-     * @throws TaskIdFormatException if the taskIdStr is not a valid {@link TaskId}
+     *  Parse the task directory name (of the form topicGroupId_partition) and construct the TaskId with the
+     *  optional namedTopology (may be null)
+     *
+     *  @throws TaskIdFormatException if the taskIdStr is not a valid {@link TaskId}
      */
-    public static TaskId parse(final String taskIdStr) {
+    public static TaskId parseTaskDirectoryName(final String taskIdStr, final String namedTopology) {
         final int index = taskIdStr.indexOf('_');
         if (index <= 0 || index + 1 >= taskIdStr.length()) {
             throw new TaskIdFormatException(taskIdStr);
@@ -55,7 +88,7 @@ public static TaskId parse(final String taskIdStr) {
             final int topicGroupId = Integer.parseInt(taskIdStr.substring(0, index));
             final int partition = Integer.parseInt(taskIdStr.substring(index + 1));
 
-            return new TaskId(topicGroupId, partition);
+            return new TaskId(topicGroupId, partition, namedTopology);
         } catch (final Exception e) {
             throw new TaskIdFormatException(taskIdStr);
         }
@@ -64,50 +97,118 @@ public static TaskId parse(final String taskIdStr) {
     /**
      * @throws IOException if cannot write to output stream
      */
-    public void writeTo(final DataOutputStream out) throws IOException {
+    public void writeTo(final DataOutputStream out, final int version) throws IOException {
         out.writeInt(topicGroupId);
         out.writeInt(partition);
+        if (version >= MIN_NAMED_TOPOLOGY_VERSION) {
+            if (namedTopology != null) {
+                out.writeInt(namedTopology.length());
+                out.writeChars(namedTopology);
+            } else {
+                out.writeInt(0);
+            }
+        }
     }
 
     /**
      * @throws IOException if cannot read from input stream
      */
-    public static TaskId readFrom(final DataInputStream in) throws IOException {
-        return new TaskId(in.readInt(), in.readInt());
+    public static TaskId readFrom(final DataInputStream in, final int version) throws IOException {
+        final int topicGroupId = in.readInt();
+        final int partition = in.readInt();
+        final String namedTopology;
+        if (version >= MIN_NAMED_TOPOLOGY_VERSION) {
+            final int numNamedTopologyChars = in.readInt();
+            final StringBuilder namedTopologyBuilder = new StringBuilder();
+            for (int i = 0; i < numNamedTopologyChars; ++i) {
+                namedTopologyBuilder.append(in.readChar());
+            }
+            namedTopology = namedTopologyBuilder.toString();
+        } else {
+            namedTopology = null;
+        }
+        return new TaskId(topicGroupId, partition, getNamedTopologyOrElseNull(namedTopology));
     }
 
-    public void writeTo(final ByteBuffer buf) {
+    public void writeTo(final ByteBuffer buf, final int version) {
         buf.putInt(topicGroupId);
         buf.putInt(partition);
+        if (version >= MIN_NAMED_TOPOLOGY_VERSION) {
+            if (namedTopology != null) {
+                buf.putInt(namedTopology.length());
+                for (final char c : namedTopology.toCharArray()) {
+                    buf.putChar(c);
+                }
+            } else {
+                buf.putInt(0);
+            }
+        }
     }
 
-    public static TaskId readFrom(final ByteBuffer buf) {
-        return new TaskId(buf.getInt(), buf.getInt());
+    public static TaskId readFrom(final ByteBuffer buf, final int version) {
+        final int topicGroupId = buf.getInt();
+        final int partition = buf.getInt();
+        final String namedTopology;
+        if (version >= MIN_NAMED_TOPOLOGY_VERSION) {
+            final int numNamedTopologyChars = buf.getInt();
+            final StringBuilder namedTopologyBuilder = new StringBuilder();
+            for (int i = 0; i < numNamedTopologyChars; ++i) {
+                namedTopologyBuilder.append(buf.getChar());
+            }
+            namedTopology = namedTopologyBuilder.toString();
+        } else {
+            namedTopology = null;
+        }
+        return new TaskId(topicGroupId, partition, getNamedTopologyOrElseNull(namedTopology));
+    }
+
+    /**
+     * @return the namedTopology name, or null if the passed in namedTopology is null or the empty string
+     */
+    private static String getNamedTopologyOrElseNull(final String namedTopology) {
+        return (namedTopology == null || namedTopology.length() == 0) ?
+            null :
+            namedTopology;
     }
 
     @Override
     public boolean equals(final Object o) {
         if (this == o) {
             return true;
         }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        final TaskId taskId = (TaskId) o;
 
-        if (o instanceof TaskId) {
-            final TaskId other = (TaskId) o;
-            return other.topicGroupId == this.topicGroupId && other.partition == this.partition;
-        } else {
+        if (topicGroupId != taskId.topicGroupId || partition != taskId.partition) {
             return false;
         }
+
+        if (namedTopology != null && taskId.namedTopology != null) {
+            return namedTopology.equals(taskId.namedTopology);
+        } else {
+            return namedTopology == null && taskId.namedTopology == null;
+        }
     }
 
     @Override
     public int hashCode() {
-        final long n = ((long) topicGroupId << 32) | (long) partition;
-        return (int) (n % 0xFFFFFFFFL);
+        return Objects.hash(topicGroupId, partition, namedTopology);
     }
 
     @Override
     public int compareTo(final TaskId other) {
-        final int compare = Integer.compare(this.topicGroupId, other.topicGroupId);
-        return compare != 0 ? compare : Integer.compare(this.partition, other.partition);
+        if (namedTopology != null && other.namedTopology != null) {
+            final int comparingNamedTopologies = namedTopology.compareTo(other.namedTopology);
+            if (comparingNamedTopologies != 0) {
+                return comparingNamedTopologies;
+            }
+        } else if (namedTopology != null || other.namedTopology != null) {
+            LOG.error("Tried to compare this = {} with other = {}, but only one had a valid named topology", this, other);
+            throw new IllegalStateException("Can't compare a TaskId with a namedTopology to one without");
+        }
+        final int comparingTopicGroupId = Integer.compare(this.topicGroupId, other.topicGroupId);
+        return comparingTopicGroupId != 0 ? comparingTopicGroupId : Integer.compare(this.partition, other.partition);
     }
 }

streams/src/main/java/org/apache/kafka/streams/processor/internals/StateDirectory.java

@@ -388,7 +388,7 @@ public synchronized void cleanRemovedTasks(final long cleanupDelayMs) {
     private void cleanRemovedTasksCalledByCleanerThread(final long cleanupDelayMs) {
         for (final File taskDir : listNonEmptyTaskDirectories()) {
             final String dirName = taskDir.getName();
-            final TaskId id = TaskId.parse(dirName);
+            final TaskId id = TaskId.parseTaskDirectoryName(dirName, null);
             if (!lockedTasksToOwner.containsKey(id)) {
                 try {
                     if (lock(id)) {
@@ -417,7 +417,7 @@ private void cleanRemovedTasksCalledByUser() throws Exception {
         final AtomicReference<Exception> firstException = new AtomicReference<>();
         for (final File taskDir : listAllTaskDirectories()) {
             final String dirName = taskDir.getName();
-            final TaskId id = TaskId.parse(dirName);
+            final TaskId id = TaskId.parseTaskDirectoryName(dirName, null);
             if (!lockedTasksToOwner.containsKey(id)) {
                 try {
                     if (lock(id)) {

streams/src/main/java/org/apache/kafka/streams/processor/internals/TaskManager.java

@@ -683,7 +683,7 @@ private void tryToLockAllNonEmptyTaskDirectories() {
 
         for (final File dir : stateDirectory.listNonEmptyTaskDirectories()) {
             try {
-                final TaskId id = TaskId.parse(dir.getName());
+                final TaskId id = TaskId.parseTaskDirectoryName(dir.getName(), null);
                 if (stateDirectory.lock(id)) {
                     lockedTaskDirectories.add(id);
                     if (!tasks.owned(id)) {

streams/src/main/java/org/apache/kafka/streams/processor/internals/assignment/AssignmentInfo.java

@@ -21,6 +21,7 @@
 import org.apache.kafka.streams.errors.TaskAssignmentException;
 import org.apache.kafka.streams.processor.TaskId;
 import org.apache.kafka.streams.state.HostInfo;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -206,14 +207,14 @@ private void encodeActiveAndStandbyTaskAssignment(final DataOutputStream out) th
         // encode active tasks
         out.writeInt(activeTasks.size());
         for (final TaskId id : activeTasks) {
-            id.writeTo(out);
+            id.writeTo(out, usedVersion);
         }
 
         // encode standby tasks
         out.writeInt(standbyTasks.size());
         for (final Map.Entry<TaskId, Set<TopicPartition>> entry : standbyTasks.entrySet()) {
             final TaskId id = entry.getKey();
-            id.writeTo(out);
+            id.writeTo(out, usedVersion);
 
             final Set<TopicPartition> partitions = entry.getValue();
             writeTopicPartitions(out, partitions);
@@ -382,7 +383,7 @@ private static void decodeActiveTasks(final AssignmentInfo assignmentInfo,
         final int count = in.readInt();
         assignmentInfo.activeTasks = new ArrayList<>(count);
         for (int i = 0; i < count; i++) {
-            assignmentInfo.activeTasks.add(TaskId.readFrom(in));
+            assignmentInfo.activeTasks.add(TaskId.readFrom(in, assignmentInfo.usedVersion));
         }
     }
 
@@ -391,7 +392,7 @@ private static void decodeStandbyTasks(final AssignmentInfo assignmentInfo,
         final int count = in.readInt();
         assignmentInfo.standbyTasks = new HashMap<>(count);
         for (int i = 0; i < count; i++) {
-            final TaskId id = TaskId.readFrom(in);
+            final TaskId id = TaskId.readFrom(in, assignmentInfo.usedVersion);
             assignmentInfo.standbyTasks.put(id, readTopicPartitions(in));
         }
     }

streams/src/main/java/org/apache/kafka/streams/processor/internals/assignment/StreamsAssignmentProtocolVersions.java

@@ -19,9 +19,11 @@
 public final class StreamsAssignmentProtocolVersions {
     public static final int UNKNOWN = -1;
     public static final int EARLIEST_PROBEABLE_VERSION = 3;
+    public static final int MIN_NAMED_TOPOLOGY_VERSION = 10;
     public static final int LATEST_SUPPORTED_VERSION = 9;
-    //When changing the versions update this test: streams_upgrade_test.py::StreamsUpgradeTest.test_version_probing_upgrade
-    //Add add a unit test in SubscriptionInfoTest
+    // When changing the versions:
+    // 1) Update the version_probing_message and end_of_upgrade_message in streams_upgrade_test.py::StreamsUpgradeTest.test_version_probing_upgrade
+    // 2) Add a unit test in SubscriptionInfoTest and/or AssignmentInfoTest
 
     private StreamsAssignmentProtocolVersions() {}
 }

streams/src/main/java/org/apache/kafka/streams/processor/internals/namedtopology/KafkaStreamsNamedTopologyWrapper.java

@@ -0,0 +1,41 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.kafka.streams.processor.internals.namedtopology;
+
+import org.apache.kafka.streams.KafkaClientSupplier;
+import org.apache.kafka.streams.KafkaStreams;
+
+import java.util.Properties;
+
+public class KafkaStreamsNamedTopologyWrapper extends KafkaStreams {
+
+    public KafkaStreamsNamedTopologyWrapper(final NamedTopology topology, final Properties props, final KafkaClientSupplier clientSupplier) {
+        super(topology.topology(), props, clientSupplier);
+    }
+
+    public NamedTopology getTopologyByName(final String name) {
+        throw new UnsupportedOperationException();
+    }
+
+    public void addNamedTopology(final NamedTopology topology) {
+        throw new UnsupportedOperationException();
+    }
+
+    public void removeNamedTopology(final NamedTopology topology) {
+        throw new UnsupportedOperationException();
+    }
+}

streams/src/main/java/org/apache/kafka/streams/processor/internals/namedtopology/NamedTopology.java

@@ -0,0 +1,42 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.kafka.streams.processor.internals.namedtopology;
+
+import org.apache.kafka.streams.Topology;
+
+public class NamedTopology {
+
+    private final Topology topology;
+    private final String name;
+
+    private NamedTopology(final Topology topology, final String name) {
+        this.topology = topology;
+        this.name = name;
+    }
+
+    public static NamedTopology fromTopologyWithName(final Topology topology, final String name) {
+        return new NamedTopology(topology, name);
+    }
+
+    public Topology topology() {
+        return topology;
+    }
+
+    public String name() {
+        return name;
+    }
+}