Add Request ID to new messages (facebookexperimental#53)

Summary:

There's a marginally gross hack here where I keep a single map of "FullTrackName" to RequestID for legacy verions.  For TrackStatus its the real FTN, for ANNOUNCE and SUB_ANNOUNCES it's a fake FTN with eg (NS, "announce").  It could break if someone has a track name or namespace tuple called "announce" or "subannounce".

Reviewed By: sharmafb

Differential Revision: D74147358

Author: afrind

moxygen/MoQFramer.cpp

@@ -967,6 +967,17 @@ folly::Expected<Announce, ErrorCode> MoQFrameParser::parseAnnounce(
     folly::io::Cursor& cursor,
     size_t length) const noexcept {
   Announce announce;
+  if (getDraftMajorVersion(*version_) >= 11) {
+    auto requestID = quic::decodeQuicInteger(cursor, length);
+    if (!requestID) {
+      return folly::makeUnexpected(ErrorCode::PARSE_UNDERFLOW);
+    }
+    length -= requestID->second;
+    announce.requestID = requestID->first;
+  } else {
+    announce.requestID = 0;
+  }
+
   auto res = parseFixedTuple(cursor, length);
   if (!res) {
     return folly::makeUnexpected(res.error());
@@ -992,11 +1003,21 @@ folly::Expected<AnnounceOk, ErrorCode> MoQFrameParser::parseAnnounceOk(
     folly::io::Cursor& cursor,
     size_t length) const noexcept {
   AnnounceOk announceOk;
-  auto res = parseFixedTuple(cursor, length);
-  if (!res) {
-    return folly::makeUnexpected(res.error());
+  if (getDraftMajorVersion(*version_) >= 11) {
+    auto requestID = quic::decodeQuicInteger(cursor, length);
+    if (!requestID) {
+      return folly::makeUnexpected(ErrorCode::PARSE_UNDERFLOW);
+    }
+    length -= requestID->second;
+    announceOk.requestID = requestID->first;
+  } else {
+    announceOk.requestID = 0;
+    auto res = parseFixedTuple(cursor, length);
+    if (!res) {
+      return folly::makeUnexpected(res.error());
+    }
+    announceOk.trackNamespace = TrackNamespace(std::move(res.value()));
   }
-  announceOk.trackNamespace = TrackNamespace(std::move(res.value()));
   if (length > 0) {
     return folly::makeUnexpected(ErrorCode::PROTOCOL_VIOLATION);
   }
@@ -1007,11 +1028,21 @@ folly::Expected<AnnounceError, ErrorCode> MoQFrameParser::parseAnnounceError(
     folly::io::Cursor& cursor,
     size_t length) const noexcept {
   AnnounceError announceError;
-  auto res = parseFixedTuple(cursor, length);
-  if (!res) {
-    return folly::makeUnexpected(res.error());
+  if (getDraftMajorVersion(*version_) >= 11) {
+    auto requestID = quic::decodeQuicInteger(cursor, length);
+    if (!requestID) {
+      return folly::makeUnexpected(ErrorCode::PARSE_UNDERFLOW);
+    }
+    length -= requestID->second;
+    announceError.requestID = requestID->first;
+  } else {
+    announceError.requestID = 0;
+    auto res = parseFixedTuple(cursor, length);
+    if (!res) {
+      return folly::makeUnexpected(res.error());
+    }
+    announceError.trackNamespace = TrackNamespace(std::move(res.value()));
   }
-  announceError.trackNamespace = TrackNamespace(std::move(res.value()));
 
   auto errorCode = quic::decodeQuicInteger(cursor, length);
   if (!errorCode) {
@@ -1080,6 +1111,16 @@ MoQFrameParser::parseTrackStatusRequest(
       << "version_ needs to be set to parse TrackStatusRequest";
 
   TrackStatusRequest trackStatusRequest;
+  if (getDraftMajorVersion(*version_) >= 11) {
+    auto requestID = quic::decodeQuicInteger(cursor, length);
+    if (!requestID) {
+      return folly::makeUnexpected(ErrorCode::PARSE_UNDERFLOW);
+    }
+    length -= requestID->second;
+    trackStatusRequest.requestID = requestID->first;
+  } else {
+    trackStatusRequest.requestID = 0;
+  }
   auto res = parseFullTrackName(cursor, length);
   if (!res) {
     return folly::makeUnexpected(res.error());
@@ -1110,11 +1151,21 @@ folly::Expected<TrackStatus, ErrorCode> MoQFrameParser::parseTrackStatus(
   CHECK(version_.hasValue()) << "version_ needs to be set to parse TrackStatus";
 
   TrackStatus trackStatus;
-  auto res = parseFullTrackName(cursor, length);
-  if (!res) {
-    return folly::makeUnexpected(res.error());
+  if (getDraftMajorVersion(*version_) >= 11) {
+    auto requestID = quic::decodeQuicInteger(cursor, length);
+    if (!requestID) {
+      return folly::makeUnexpected(ErrorCode::PARSE_UNDERFLOW);
+    }
+    length -= requestID->second;
+    trackStatus.requestID = requestID->first;
+  } else {
+    trackStatus.requestID = 0;
+    auto res = parseFullTrackName(cursor, length);
+    if (!res) {
+      return folly::makeUnexpected(res.error());
+    }
+    trackStatus.fullTrackName = res.value();
   }
-  trackStatus.fullTrackName = res.value();
   auto statusCode = quic::decodeQuicInteger(cursor, length);
   if (!statusCode) {
     return folly::makeUnexpected(ErrorCode::PARSE_UNDERFLOW);
@@ -1390,7 +1441,7 @@ MoQFrameParser::parseSubscribeAnnounces(
     return folly::makeUnexpected(res.error());
   }
   return SubscribeAnnounces(
-      {std::move(res->trackNamespace), std::move(res->params)});
+      {res->requestID, std::move(res->trackNamespace), std::move(res->params)});
 }
 
 folly::Expected<SubscribeAnnouncesOk, ErrorCode>
@@ -1401,7 +1452,7 @@ MoQFrameParser::parseSubscribeAnnouncesOk(
   if (!res) {
     return folly::makeUnexpected(res.error());
   }
-  return SubscribeAnnouncesOk({std::move(res->trackNamespace)});
+  return SubscribeAnnouncesOk({res->requestID, std::move(res->trackNamespace)});
 }
 
 folly::Expected<SubscribeAnnouncesError, ErrorCode>
@@ -1413,7 +1464,8 @@ MoQFrameParser::parseSubscribeAnnouncesError(
     return folly::makeUnexpected(res.error());
   }
   return SubscribeAnnouncesError(
-      {std::move(res->trackNamespace),
+      {res->requestID,
+       std::move(res->trackNamespace),
        SubscribeAnnouncesErrorCode(folly::to_underlying(res->errorCode)),
        std::move(res->reasonPhrase)});
 }
@@ -1422,11 +1474,17 @@ folly::Expected<UnsubscribeAnnounces, ErrorCode>
 MoQFrameParser::parseUnsubscribeAnnounces(
     folly::io::Cursor& cursor,
     size_t length) const noexcept {
-  auto res = parseAnnounceOk(cursor, length);
+  UnsubscribeAnnounces unsubscribeAnnounces;
+  auto res = parseFixedTuple(cursor, length);
   if (!res) {
     return folly::makeUnexpected(res.error());
   }
-  return UnsubscribeAnnounces({std::move(res->trackNamespace)});
+  unsubscribeAnnounces.trackNamespacePrefix =
+      TrackNamespace(std::move(res.value()));
+  if (length > 0) {
+    return folly::makeUnexpected(ErrorCode::PROTOCOL_VIOLATION);
+  }
+  return unsubscribeAnnounces;
 }
 
 folly::Expected<FullTrackName, ErrorCode> MoQFrameParser::parseFullTrackName(
@@ -2304,6 +2362,9 @@ WriteResult MoQFrameWriter::writeAnnounce(
   size_t size = 0;
   bool error = false;
   auto sizePtr = writeFrameHeader(writeBuf, FrameType::ANNOUNCE, error);
+  if (getDraftMajorVersion(*version_) >= 11) {
+    writeVarint(writeBuf, announce.requestID.value, size, error);
+  }
   writeTrackNamespace(writeBuf, announce.trackNamespace, size, error);
   writeTrackRequestParams(writeBuf, announce.params, size, error);
   writeSize(sizePtr, size, error, *version_);
@@ -2320,7 +2381,11 @@ WriteResult MoQFrameWriter::writeAnnounceOk(
   size_t size = 0;
   bool error = false;
   auto sizePtr = writeFrameHeader(writeBuf, FrameType::ANNOUNCE_OK, error);
-  writeTrackNamespace(writeBuf, announceOk.trackNamespace, size, error);
+  if (getDraftMajorVersion(*version_) >= 11) {
+    writeVarint(writeBuf, announceOk.requestID.value, size, error);
+  } else {
+    writeTrackNamespace(writeBuf, announceOk.trackNamespace, size, error);
+  }
   writeSize(sizePtr, size, error, *version_);
   if (error) {
     return folly::makeUnexpected(quic::TransportErrorCode::INTERNAL_ERROR);
@@ -2336,7 +2401,11 @@ WriteResult MoQFrameWriter::writeAnnounceError(
   size_t size = 0;
   bool error = false;
   auto sizePtr = writeFrameHeader(writeBuf, FrameType::ANNOUNCE_ERROR, error);
-  writeTrackNamespace(writeBuf, announceError.trackNamespace, size, error);
+  if (getDraftMajorVersion(*version_) >= 11) {
+    writeVarint(writeBuf, announceError.requestID.value, size, error);
+  } else {
+    writeTrackNamespace(writeBuf, announceError.trackNamespace, size, error);
+  }
   writeVarint(
       writeBuf, folly::to_underlying(announceError.errorCode), size, error);
   writeFixedString(writeBuf, announceError.reasonPhrase, size, error);
@@ -2391,6 +2460,9 @@ WriteResult MoQFrameWriter::writeTrackStatusRequest(
   bool error = false;
   auto sizePtr =
       writeFrameHeader(writeBuf, FrameType::TRACK_STATUS_REQUEST, error);
+  if (getDraftMajorVersion(*version_) >= 11) {
+    writeVarint(writeBuf, trackStatusRequest.requestID.value, size, error);
+  }
   writeFullTrackName(writeBuf, trackStatusRequest.fullTrackName, size, error);
   if (getDraftMajorVersion(*version_) >= 11) {
     writeTrackRequestParams(writeBuf, trackStatusRequest.params, size, error);
@@ -2410,7 +2482,11 @@ WriteResult MoQFrameWriter::writeTrackStatus(
   size_t size = 0;
   bool error = false;
   auto sizePtr = writeFrameHeader(writeBuf, FrameType::TRACK_STATUS, error);
-  writeFullTrackName(writeBuf, trackStatus.fullTrackName, size, error);
+  if (getDraftMajorVersion(*version_) >= 11) {
+    writeVarint(writeBuf, trackStatus.requestID.value, size, error);
+  } else {
+    writeFullTrackName(writeBuf, trackStatus.fullTrackName, size, error);
+  }
   writeVarint(
       writeBuf, folly::to_underlying(trackStatus.statusCode), size, error);
   if (trackStatus.statusCode == TrackStatusCode::IN_PROGRESS) {
@@ -2455,6 +2531,9 @@ WriteResult MoQFrameWriter::writeSubscribeAnnounces(
   bool error = false;
   auto sizePtr =
       writeFrameHeader(writeBuf, FrameType::SUBSCRIBE_ANNOUNCES, error);
+  if (getDraftMajorVersion(*version_) >= 11) {
+    writeVarint(writeBuf, subscribeAnnounces.requestID.value, size, error);
+  }
   writeTrackNamespace(
       writeBuf, subscribeAnnounces.trackNamespacePrefix, size, error);
   writeTrackRequestParams(writeBuf, subscribeAnnounces.params, size, error);
@@ -2474,8 +2553,12 @@ WriteResult MoQFrameWriter::writeSubscribeAnnouncesOk(
   bool error = false;
   auto sizePtr =
       writeFrameHeader(writeBuf, FrameType::SUBSCRIBE_ANNOUNCES_OK, error);
-  writeTrackNamespace(
-      writeBuf, subscribeAnnouncesOk.trackNamespacePrefix, size, error);
+  if (getDraftMajorVersion(*version_) >= 11) {
+    writeVarint(writeBuf, subscribeAnnouncesOk.requestID.value, size, error);
+  } else {
+    writeTrackNamespace(
+        writeBuf, subscribeAnnouncesOk.trackNamespacePrefix, size, error);
+  }
   writeSize(sizePtr, size, error, *version_);
   if (error) {
     return folly::makeUnexpected(quic::TransportErrorCode::INTERNAL_ERROR);
@@ -2492,8 +2575,12 @@ WriteResult MoQFrameWriter::writeSubscribeAnnouncesError(
   bool error = false;
   auto sizePtr =
       writeFrameHeader(writeBuf, FrameType::SUBSCRIBE_ANNOUNCES_ERROR, error);
-  writeTrackNamespace(
-      writeBuf, subscribeAnnouncesError.trackNamespacePrefix, size, error);
+  if (getDraftMajorVersion(*version_) >= 11) {
+    writeVarint(writeBuf, subscribeAnnouncesError.requestID.value, size, error);
+  } else {
+    writeTrackNamespace(
+        writeBuf, subscribeAnnouncesError.trackNamespacePrefix, size, error);
+  }
   writeVarint(
       writeBuf,
       folly::to_underlying(subscribeAnnouncesError.errorCode),

moxygen/MoQFramer.h

@@ -672,15 +672,18 @@ struct SubscribeDone {
 };
 
 struct Announce {
+  RequestID requestID;
   TrackNamespace trackNamespace;
   std::vector<TrackRequestParameter> params;
 };
 
 struct AnnounceOk {
+  RequestID requestID;
   TrackNamespace trackNamespace;
 };
 
 struct AnnounceError {
+  RequestID requestID;
   TrackNamespace trackNamespace;
   AnnounceErrorCode errorCode;
   std::string reasonPhrase;
@@ -697,11 +700,13 @@ struct AnnounceCancel {
 };
 
 struct TrackStatusRequest {
+  RequestID requestID;
   FullTrackName fullTrackName;
   std::vector<TrackRequestParameter> params; // draft-11 and later
 };
 
 struct TrackStatus {
+  RequestID requestID;
   FullTrackName fullTrackName;
   TrackStatusCode statusCode;
   folly::Optional<AbsoluteLocation> latestGroupAndObject;
@@ -827,15 +832,18 @@ struct FetchError {
 };
 
 struct SubscribeAnnounces {
+  RequestID requestID;
   TrackNamespace trackNamespacePrefix;
   std::vector<TrackRequestParameter> params;
 };
 
 struct SubscribeAnnouncesOk {
+  RequestID requestID;
   TrackNamespace trackNamespacePrefix;
 };
 
 struct SubscribeAnnouncesError {
+  RequestID requestID;
   TrackNamespace trackNamespacePrefix;
   SubscribeAnnouncesErrorCode errorCode;
   std::string reasonPhrase;