ai/live: Check for a required ManifestID

Help out SDK implementers in case they miss this, since the errors
are non-obvious: the orchestrator runs out of balance within a few
minutes, even if payments are being sent regularly.

Author: j0sh

server/remote_signer.go

@@ -249,7 +249,8 @@ func (ls *LivepeerServer) GenerateLivePayment(w http.ResponseWriter, r *http.Req
 		err   error
 	)
 	reqState, reqSig := req.State.State, req.State.Sig
-	if len(reqState) != 0 || len(reqSig) != 0 {
+	hasState := len(reqState) != 0 || len(reqSig) != 0
+	if hasState {
 		if err := verifyStateSignature(ls, reqState, reqSig); err != nil {
 			err = errors.New("invalid sig")
 			respondJsonError(ctx, w, err, http.StatusBadRequest)
@@ -279,6 +280,12 @@ func (ls *LivepeerServer) GenerateLivePayment(w http.ResponseWriter, r *http.Req
 
 	manifestID := req.ManifestID
 	if manifestID == "" {
+		if hasState {
+			// Required for lv2v so stateful requests stay tied to the same id.
+			err := errors.New("missing manifestID")
+			respondJsonError(ctx, w, err, http.StatusBadRequest)
+			return
+		}
 		manifestID = string(core.RandomManifestID())
 	}
 	ctx = clog.AddVal(ctx, "manifest_id", manifestID)

server/remote_signer_test.go

@@ -359,13 +359,40 @@ func TestGenerateLivePayment_StateValidationErrors(t *testing.T) {
 	}()
 
 	tests := []struct {
-		name       string
-		stateBytes []byte
-		stateSig   []byte
-		orchInfo   *net.OrchestratorInfo
-		wantStatus int
-		wantMsg    string
+		name           string
+		stateBytes     []byte
+		stateSig       []byte
+		orchInfo       *net.OrchestratorInfo
+		omitManifestID bool
+		wantStatus     int
+		wantMsg        string
 	}{
+		{
+			name: "missing manifest id with state",
+			stateBytes: func() []byte {
+				state, err := json.Marshal(RemotePaymentState{
+					StateID:              "state",
+					OrchestratorAddress:  ethcommon.BytesToAddress(orchInfo.Address),
+					InitialPricePerUnit:  1,
+					InitialPixelsPerUnit: 1,
+				})
+				require.NoError(err)
+				return state
+			}(),
+			stateSig: func() []byte {
+				state, err := json.Marshal(RemotePaymentState{
+					StateID:              "state",
+					OrchestratorAddress:  ethcommon.BytesToAddress(orchInfo.Address),
+					InitialPricePerUnit:  1,
+					InitialPixelsPerUnit: 1,
+				})
+				require.NoError(err)
+				return sign(state)
+			}(),
+			omitManifestID: true,
+			wantStatus:     http.StatusBadRequest,
+			wantMsg:        "missing manifestID",
+		},
 		{
 			name:       "invalid state signature",
 			stateBytes: []byte(`{"stateID":"state","orchestratorAddress":"0x1"}`),
@@ -459,8 +486,14 @@ func TestGenerateLivePayment_StateValidationErrors(t *testing.T) {
 			orchBlob, err := proto.Marshal(oInfo)
 			require.NoError(err)
 
+			var manifestID string
+			if !tt.omitManifestID {
+				manifestID = "manifest"
+			}
+
 			reqBody, err := json.Marshal(RemotePaymentRequest{
 				Orchestrator: orchBlob,
+				ManifestID:   manifestID,
 				InPixels:     1,
 				State:        RemotePaymentStateSig{State: tt.stateBytes, Sig: tt.stateSig},
 			})