Allow and ignore the googLeakyBucket constraint.

third_party/WebKit/Source/modules/mediastream/MediaConstraintsImpl.cpp

 /*
  * Copyright (C) 2012 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
@@ skipping 16 matching lines @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #include "modules/mediastream/MediaConstraintsImpl.h"
 
 #include "bindings/core/v8/ArrayValue.h"
 #include "bindings/core/v8/Dictionary.h"
 #include "bindings/core/v8/ExceptionState.h"
 #include "core/dom/ExceptionCode.h"
+#include "core/dom/ExecutionContext.h"
 #include "core/frame/UseCounter.h"
+#include "core/inspector/ConsoleMessage.h"
 #include "modules/mediastream/MediaTrackConstraintSet.h"
 #include "platform/Logging.h"
 #include "platform/RuntimeEnabledFeatures.h"
 #include "wtf/HashMap.h"
 #include "wtf/Vector.h"
 #include "wtf/text/StringHash.h"
 
 namespace blink {
 
 namespace MediaConstraintsImpl {
@@ skipping 68 matching lines @@
 const char kScreencastMinBitrate[] = "googScreencastMinBitrate";
 const char kCpuOveruseDetection[] = "googCpuOveruseDetection";
 const char kCpuUnderuseThreshold[] = "googCpuUnderuseThreshold";
 const char kCpuOveruseThreshold[] = "googCpuOveruseThreshold";
 const char kCpuUnderuseEncodeRsdThreshold[] = "googCpuUnderuseEncodeRsdThreshold";
 const char kCpuOveruseEncodeRsdThreshold[] = "googCpuOveruseEncodeRsdThreshold";
 const char kCpuOveruseEncodeUsage[] = "googCpuOveruseEncodeUsage";
 const char kHighStartBitrate[] = "googHighStartBitrate";
 const char kPayloadPadding[] = "googPayloadPadding";
 // End of names from libjingle
+// Names that have been used in the past, but should now be ignored.
+// Kept around for backwards compatibility.
+// https://crbug.com/579729
+const char kGoogLeakyBucket[] = "googLeakyBucket";
 
 // Names used for testing.
 const char kTestConstraint1[] = "valid_and_supported_1";
 const char kTestConstraint2[] = "valid_and_supported_2";
 
 static bool parseMandatoryConstraintsDictionary(const Dictionary& mandatoryConstraintsDictionary, WebVector<WebMediaConstraint>& mandatory)
 {
     Vector<WebMediaConstraint> mandatoryConstraintsVector;
     HashMap<String, String> mandatoryConstraintsHashMap;
     bool ok = mandatoryConstraintsDictionary.getOwnPropertiesAsStringHashMap(mandatoryConstraintsHashMap);
@@ skipping 104 matching lines @@
     return true;
 }
 
 static bool toBoolean(const WebString& asWebString)
 {
     return asWebString.equals("true");
     // TODO(hta): Check against "false" and return error if it's neither.
     // https://crbug.com/576582
 }
 
-static void parseOldStyleNames(const WebVector<WebMediaConstraint>& oldNames, WebMediaTrackConstraintSet& result, MediaErrorState& errorState)
+static void parseOldStyleNames(ExecutionContext* context, const WebVector<WebMediaConstraint>& oldNames, bool reportUnknownNames, WebMediaTrackConstraintSet& result, MediaErrorState& errorState)
 {
     for (const WebMediaConstraint& constraint : oldNames) {
         if (constraint.m_name.equals(kMinAspectRatio)) {
             result.aspectRatio.setMin(atof(constraint.m_value.utf8().c_str()));
         } else if (constraint.m_name.equals(kMaxAspectRatio)) {
             result.aspectRatio.setMax(atof(constraint.m_value.utf8().c_str()));
         } else if (constraint.m_name.equals(kMaxWidth)) {
             result.width.setMax(atoi(constraint.m_value.utf8().c_str()));
         } else if (constraint.m_name.equals(kMinWidth)) {
             result.width.setMin(atoi(constraint.m_value.utf8().c_str()));
@@ skipping 85 matching lines @@
         } else if (constraint.m_name.equals(kCpuUnderuseEncodeRsdThreshold)) {
             result.googCpuUnderuseEncodeRsdThreshold.setExact(atoi(constraint.m_value.utf8().c_str()));
         } else if (constraint.m_name.equals(kCpuOveruseEncodeRsdThreshold)) {
             result.googCpuOveruseEncodeRsdThreshold.setExact(atoi(constraint.m_value.utf8().c_str()));
         } else if (constraint.m_name.equals(kCpuOveruseEncodeUsage)) {
             result.googCpuOveruseEncodeUsage.setExact(toBoolean(constraint.m_value));
         } else if (constraint.m_name.equals(kHighStartBitrate)) {
             result.googHighStartBitrate.setExact(atoi(constraint.m_value.utf8().c_str()));
         } else if (constraint.m_name.equals(kPayloadPadding)) {
             result.googPayloadPadding.setExact(toBoolean(constraint.m_value));
+        } else if (constraint.m_name.equals(kGoogLeakyBucket)) {
+            context->addConsoleMessage(ConsoleMessage::create(DeprecationMessageSource, WarningMessageLevel,
+                "Obsolete constraint named " + String(constraint.m_name)
+                + " is ignored. Please stop using it."));
         } else if (constraint.m_name.equals(kTestConstraint1)
             || constraint.m_name.equals(kTestConstraint2)) {
             // These constraints are only for testing parsing.
             // Values 0 and 1 are legal, all others are a ConstraintError.
-            if (!constraint.m_value.equals("0") && !constraint.m_value.equals("1"))
+            if (!constraint.m_value.equals("0") && !constraint.m_value.equals("1")) {
                 errorState.throwConstraintError("Illegal value for constraint", constraint.m_name);
+            }
         } else {
-            // TODO(hta): UMA stats for unknown constraints passed.
-            // https://crbug.com/576613
-            WTF_LOG(Media, "Unknown constraint name detected");
-            errorState.throwConstraintError("Unknown name of constraint detected", constraint.m_name);
+            if (reportUnknownNames) {
+                // TODO(hta): UMA stats for unknown constraints passed.
+                // https://crbug.com/576613
+                context->addConsoleMessage(
+                    ConsoleMessage::create(
+                        DeprecationMessageSource,
+                        WarningMessageLevel,
+                        "Unknown constraint named "
+                        + String(constraint.m_name) + " rejected"));
+                errorState.throwConstraintError("Unknown name of constraint detected", constraint.m_name);
+            }
         }
     }
 }
 
-static WebMediaConstraints createFromNamedConstraints(WebVector<WebMediaConstraint>& mandatory, const WebVector<WebMediaConstraint>& optional, MediaErrorState& errorState)
+static WebMediaConstraints createFromNamedConstraints(ExecutionContext* context, WebVector<WebMediaConstraint>& mandatory, const WebVector<WebMediaConstraint>& optional, MediaErrorState& errorState)
 {
     WebMediaTrackConstraintSet basic;
     WebMediaTrackConstraintSet advanced;
     WebMediaConstraints constraints;
-    parseOldStyleNames(mandatory, basic, errorState);
+    parseOldStyleNames(context, mandatory, true, basic, errorState);
     if (errorState.hadException())
         return constraints;
-    // We ignore errors in optional constraints.
+    // We ignore unknow names and syntax errors in optional constraints.
     MediaErrorState ignoredErrorState;
-    parseOldStyleNames(optional, advanced, ignoredErrorState);
+    parseOldStyleNames(context, optional, false, advanced, ignoredErrorState);
     WebVector<WebMediaTrackConstraintSet> advancedVector(&advanced, 1);
     // Use the 4-argument initializer until Chrome has been converted.
     constraints.initialize(optional, mandatory, basic, advancedVector);
     return constraints;
 }
 
 // Deprecated.
-WebMediaConstraints create(const ExecutionContext* context, const Dictionary& constraintsDictionary, MediaErrorState& errorState)
+WebMediaConstraints create(ExecutionContext* context, const Dictionary& constraintsDictionary, MediaErrorState& errorState)
 {
     WebVector<WebMediaConstraint> optional;
     WebVector<WebMediaConstraint> mandatory;
     if (!parse(constraintsDictionary, optional, mandatory)) {
         errorState.throwTypeError("Malformed constraints object.");
         return WebMediaConstraints();
     }
     UseCounter::count(context, UseCounter::MediaStreamConstraintsFromDictionary);
-    return createFromNamedConstraints(mandatory, optional, errorState);
+    return createFromNamedConstraints(context, mandatory, optional, errorState);
 }
 
 void copyLongConstraint(const ConstrainLongRange& blinkForm, LongConstraint& webForm)
 {
     if (blinkForm.hasMin()) {
         webForm.setMin(blinkForm.min());
     }
     if (blinkForm.hasMax()) {
         webForm.setMax(blinkForm.max());
     }
@@ skipping 77 matching lines @@
         copyLongConstraint(constraintsIn.channelCount(), constraintBuffer.channelCount);
     }
     if (constraintsIn.hasDeviceId()) {
         copyStringConstraint(constraintsIn.deviceId(), constraintBuffer.deviceId);
     }
     if (constraintsIn.hasGroupId()) {
         copyStringConstraint(constraintsIn.groupId(), constraintBuffer.groupId);
     }
 }
 
-WebMediaConstraints create(const ExecutionContext* context, const MediaTrackConstraintSet& constraintsIn, MediaErrorState& errorState)
+WebMediaConstraints create(ExecutionContext* context, const MediaTrackConstraintSet& constraintsIn, MediaErrorState& errorState)
 {
     WebMediaConstraints constraints;
     WebMediaTrackConstraintSet constraintBuffer;
     WebVector<WebMediaTrackConstraintSet> advancedBuffer;
     copyConstraints(constraintsIn, constraintBuffer);
     // TODO(hta): Add initialization of advanced constraints once present.
     // https://crbug.com/253412
     if (constraintsIn.hasOptional() || constraintsIn.hasMandatory()) {
         if (!constraintBuffer.isEmpty()) {
             errorState.throwTypeError("Malformed constraint: Cannot use both optional/mandatory and specific constraints.");
             return WebMediaConstraints();
         }
         WebVector<WebMediaConstraint> optional;
         WebVector<WebMediaConstraint> mandatory;
         if (!parse(constraintsIn, optional, mandatory)) {
             errorState.throwTypeError("Malformed constraints object.");
             return WebMediaConstraints();
         }
         UseCounter::count(context, UseCounter::MediaStreamConstraintsNameValue);
-        return createFromNamedConstraints(mandatory, optional, errorState);
+        return createFromNamedConstraints(context, mandatory, optional, errorState);
     }
     UseCounter::count(context, UseCounter::MediaStreamConstraintsConformant);
     constraints.initialize(constraintBuffer, advancedBuffer);
     return constraints;
 }
 
 WebMediaConstraints create()
 {
     WebMediaConstraints constraints;
     constraints.initialize();
     return constraints;
 }
 
 } // namespace MediaConstraintsImpl
 } // namespace blink