Update UseCounter::deprecationMessage() cases to use the replacedBy function

Source/core/frame/UseCounter.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 651 matching lines @@
     UseCounter::countDeprecation(document.frame(), feature);
 }
 
 void UseCounter::countDeprecationIfNotPrivateScript(v8::Isolate* isolate, ExecutionContext* context, Feature feature)
 {
     if (DOMWrapperWorld::current(isolate).isPrivateScriptIsolatedWorld())
         return;
     UseCounter::countDeprecation(context, feature);
 }
 
-// FIXME: Update other UseCounter::deprecationMessage() cases to use this.
-static String replacedBy(const char* oldString, const char* newString)
+static String replacedBy(const char* deprecatedItem, const char* firstAlternative, const char* secondAlternative = nullptr)

[jsbell, 2014/12/18 20:05:50]

This is fine, but IMHO it would be more readable to have two methods rather the
default value for the second arg, since the if/else block and replacementMessage
variable can go away.

(I realize the patch used to be more complex made this function variadic.)

 {
-    return String::format("'%s' is deprecated. Please use '%s' instead.", oldString, newString);
+    String replacementMessage;
+    if (secondAlternative)
+        replacementMessage = String::format("'%s' or '%s'", firstAlternative, secondAlternative);
+    else
+        replacementMessage = String::format("'%s'", firstAlternative);
+
+    return String::format("'%s' is deprecated. Please use %s instead.", deprecatedItem, replacementMessage.utf8().data());
 }
 
 String UseCounter::deprecationMessage(Feature feature)
 {
     switch (feature) {
     // Quota
     case PrefixedStorageInfo:
-        return "'window.webkitStorageInfo' is deprecated. Please use 'navigator.webkitTemporaryStorage' or 'navigator.webkitPersistentStorage' instead.";
+        return replacedBy("window.webkitStorageInfo", "navigator.webkitTemporaryStorage", "navigator.webkitPersistentStorage");
 
     // Keyboard Event (DOM Level 3)
     case KeyboardEventKeyLocation:
         return replacedBy("KeyboardEvent.keyLocation", "KeyboardEvent.location");
 
     case ConsoleMarkTimeline:
-        return "console.markTimeline is deprecated. Please use the console.timeStamp instead.";
+        return replacedBy("console.markTimeline", "console.timeStamp");
 
     case FileError:
         return "FileError is deprecated. Please use the 'name' or 'message' attributes of DOMError rather than 'code'.";
 
     case ShowModalDialog:
-        return "showModalDialog is deprecated. Please use window.open and postMessage instead.";
+        return replacedBy("showModalDialog", "window.open", "postMessage");

[jsbell, 2014/12/18 20:05:50]

The new message is a bit misleading. You don't use window.open *OR* postMessage,
you'd use them both together.

So I'd leave this one alone, or perhaps ask on chromium-dev if anyone has a
better message here. (e.g. we could actually include the URL of a document like
https://dev.opera.com/blog/showmodaldialog/ that gives advice)

 
     case CSSStyleSheetInsertRuleOptionalArg:
         return "Calling CSSStyleSheet.insertRule() with one argument is deprecated. Please pass the index argument as well: insertRule(x, 0).";
 
     case PrefixedVideoSupportsFullscreen:
         return "'HTMLVideoElement.webkitSupportsFullscreen' is deprecated. Its value is true if the video is loaded.";
 
     case PrefixedVideoDisplayingFullscreen:
-        return "'HTMLVideoElement.webkitDisplayingFullscreen' is deprecated. Please use the 'fullscreenchange' and 'webkitfullscreenchange' events instead.";
+        return replacedBy("HTMLVideoElement.webkitDisplayingFullscreen", "fullscreenchange", "webkitfullscreenchange");

[jsbell, 2014/12/18 20:05:50]

Can we skip recommending webkitfullscreenchange and only recommend the
standardized version?

Also, this change drops the key word 'events'. Not sure how critical that
context is.

 
     case PrefixedVideoEnterFullscreen:
-        return "'HTMLVideoElement.webkitEnterFullscreen()' is deprecated. Please use 'Element.requestFullscreen()' and 'Element.webkitRequestFullscreen()' instead.";
+        return replacedBy("HTMLVideoElement.webkitEnterFullscreen()", "Element.requestFullscreen()", "Element.webkitRequestFullscreen()");

[jsbell, 2014/12/18 20:05:50]

Can we skip recommending the nonstandard prefixed version and only recommend the
standardized version?

 
     case PrefixedVideoExitFullscreen:
-        return "'HTMLVideoElement.webkitExitFullscreen()' is deprecated. Please use 'Document.exitFullscreen()' and 'Document.webkitExitFullscreen()' instead.";
+        return replacedBy("HTMLVideoElement.webkitExitFullscreen()", "Document.exitFullscreen()", "Document.webkitExitFullscreen()");

[jsbell, 2014/12/18 20:05:50]

Can we skip recommending the nonstandard prefixed version and only recommend the
standardized version?

 
     case PrefixedVideoEnterFullScreen:
-        return "'HTMLVideoElement.webkitEnterFullScreen()' is deprecated. Please use 'Element.requestFullscreen()' and 'Element.webkitRequestFullscreen()' instead.";
+        return replacedBy("HTMLVideoElement.webkitEnterFullScreen()", "Element.requestFullscreen()", "Element.webkitRequestFullscreen()");

[jsbell, 2014/12/18 20:05:50]

Can we skip recommending the nonstandard prefixed version and only recommend the
standardized version?

 
     case PrefixedVideoExitFullScreen:
-        return "'HTMLVideoElement.webkitExitFullScreen()' is deprecated. Please use 'Document.exitFullscreen()' and 'Document.webkitExitFullscreen()' instead.";
+        return replacedBy("HTMLVideoElement.webkitExitFullScreen()", "Document.exitFullscreen()", "Document.webkitExitFullscreen()");

[jsbell, 2014/12/18 20:05:50]

Can we skip recommending the nonstandard prefixed version and only recommend the
standardized version?

 
     case PrefixedIndexedDB:
         return replacedBy("webkitIndexedDB", "indexedDB");
 
     case PrefixedIDBCursorConstructor:
         return replacedBy("webkitIDBCursor", "IDBCursor");
 
     case PrefixedIDBDatabaseConstructor:
         return replacedBy("webkitIDBDatabase", "IDBDatabase");
 
@@ skipping 30 matching lines @@
     case RangeDetach:
         return "'Range.detach' is now a no-op, as per DOM (http://dom.spec.whatwg.org/#dom-range-detach).";
 
     case OverflowChangedEvent:
         return "The 'overflowchanged' event is deprecated and may be removed. Please do not use it.";
 
     case SyncXHRWithCredentials:
         return "Setting 'XMLHttpRequest.withCredentials' for synchronous requests is deprecated.";
 
     case EventSourceURL:
-        return "'EventSource.URL' is deprecated. Please use 'EventSource.url' instead.";
+        return replacedBy("EventSource.URL", "EventSource.url");
 
     case WebSocketURL:
-        return "'WebSocket.URL' is deprecated. Please use 'WebSocket.url' instead.";
+        return replacedBy("WebSocket.URL", "WebSocket.url");
 
     case HTMLTableElementVspace:
-        return "The 'vspace' attribute on table is deprecated. Please use CSS instead.";
+        return "The 'vspace' attribute on table is deprecated. Please use CSS margin-top and margin-bottom property instead.";
 
     case HTMLTableElementHspace:
-        return "The 'hspace' attribute on table is deprecated. Please use CSS instead.";
+        return "The 'hspace' attribute on table is deprecated. Please use CSS margin-left and margin-right property instead.";
 
     case PictureSourceSrc:
         return "<source src> with a <picture> parent is invalid and therefore ignored. Please use <source srcset> instead.";
 
     case XHRProgressEventPosition:
         return "The XMLHttpRequest progress event property 'position' is deprecated. Please use 'loaded' instead.";
 
     case XHRProgressEventTotalSize:
         return "The XMLHttpRequest progress event property 'totalSize' is deprecated. Please use 'total' instead.";
 
     case ConsoleTimeline:
-        return "console.timeline is deprecated. Please use the console.time instead.";
+        return replacedBy("console.timeline", "console.time");
 
     case ConsoleTimelineEnd:
-        return "console.timelineEnd is deprecated. Please use the console.timeEnd instead.";
+        return replacedBy("console.timelineEnd", "console.timeEnd");
 
     case XMLHttpRequestSynchronousInNonWorkerOutsideBeforeUnload:
         return "Synchronous XMLHttpRequest on the main thread is deprecated because of its detrimental effects to the end user's experience. For more help, check http://xhr.spec.whatwg.org/.";
 
     case FontFaceSetReady:
         return "document.fonts.ready() method is going to be replaced with document.fonts.ready attribute in future releases. Please be prepared. For more help, check https://code.google.com/p/chromium/issues/detail?id=392077#c3 .";
 
     case DOMImplementationHasFeatureReturnFalse:
         return "'DOMImplementation.hasFeature()' returning false is deprecated. Please do not use it, as per DOM it should always return true (https://dom.spec.whatwg.org/#dom-domimplementation-hasfeature).";
 
@@ skipping 74 matching lines @@
 UseCounter* UseCounter::getFrom(const StyleSheetContents* sheetContents)
 {
     // FIXME: We may want to handle stylesheets that have multiple owners
     //        http://crbug.com/242125
     if (sheetContents && sheetContents->hasSingleOwnerNode())
         return getFrom(sheetContents->singleOwnerDocument());
     return 0;
 }
 
 } // namespace blink