mediawiki.user: Rename stickyRandomId to getPageviewToken

New name is more descriptive and consistent with
how we use it.

Given the couple of usages in code, deprecate
the old method

Bug: T201124
Change-Id: Id43e9d3f3e687133c98017d24c10c307a5a855a1

diff --git a/RELEASE-NOTES-1.32 b/RELEASE-NOTES-1.32
index 3a1cc88..0ad2e41 100644 (file)
--- a/RELEASE-NOTES-1.32
+++ b/RELEASE-NOTES-1.32
@@ -375,6 +375,8 @@ because of Phabricator reports.
 * All SpecialPageFactory static methods are deprecated. Instead, call the
   methods on a SpecialPageFactory instance, which may be obtained from
   MediaWikiServices.
+* mw.user.stickyRandomId was renamed to the more explicit
+  mw.user.getPageviewToken to better capture its function.
 
 === Other changes in 1.32 ===
 * (T198811) The following tables have had their UNIQUE indexes turned into

diff --git a/resources/src/mediawiki.user.js b/resources/src/mediawiki.user.js
index 5fc1990..b2985d1 100644 (file)
--- a/resources/src/mediawiki.user.js
+++ b/resources/src/mediawiki.user.js
@@ -4,7 +4,7 @@
  */
 /* global Uint32Array */
 ( function ( mw, $ ) {
-       var userInfoPromise, stickyRandomSessionId;
+       var userInfoPromise, pageviewRandomId;
 
        /**
         * Get the current user's groups or rights
@@ -73,16 +73,17 @@
 
                /**
                 * A sticky generateRandomSessionId for the current JS execution context,
-                * cached within this class.
+                * cached within this class (also known as a page view token).
                 *
+                * @since 1.32
                 * @return {string} 64 bit integer in hex format, padded
                 */
-               stickyRandomId: function () {
-                       if ( !stickyRandomSessionId ) {
-                               stickyRandomSessionId = mw.user.generateRandomSessionId();
+               getPageviewToken: function () {
+                       if ( !pageviewRandomId ) {
+                               pageviewRandomId = mw.user.generateRandomSessionId();
                        }
 
-                       return stickyRandomSessionId;
+                       return pageviewRandomId;
                },
 
                /**
@@ -186,4 +187,10 @@
                }
        } );
 
+       /**
+        * @method stickyRandomId
+        * @deprecated since 1.32 use getPageviewToken instead
+        */
+       mw.log.deprecate( mw.user, 'stickyRandomId', mw.user.getPageviewToken, 'Please use getPageviewToken instead' );
+
 }( mediaWiki, jQuery ) );

diff --git a/tests/qunit/suites/resources/mediawiki/mediawiki.user.test.js b/tests/qunit/suites/resources/mediawiki/mediawiki.user.test.js
index f0a3543..7044069 100644 (file)
--- a/tests/qunit/suites/resources/mediawiki/mediawiki.user.test.js
+++ b/tests/qunit/suites/resources/mediawiki/mediawiki.user.test.js
@@ -97,9 +97,9 @@
                assert.notEqual( result, result2, 'different when called multiple times' );
        } );
 
-       QUnit.test( 'stickyRandomId', function ( assert ) {
-               var result = mw.user.stickyRandomId(),
-                       result2 = mw.user.stickyRandomId();
+       QUnit.test( 'getPageviewToken', function ( assert ) {
+               var result = mw.user.getPageviewToken(),
+                       result2 = mw.user.getPageviewToken();
                assert.strictEqual( typeof result, 'string', 'type' );
                assert.strictEqual( /^[a-f0-9]{16}$/.test( result ), true, '16 HEX symbols string' );
                assert.strictEqual( result2, result, 'sticky' );