From 2ac9b262576c0f2765341b6335a34364cd8903f4 Mon Sep 17 00:00:00 2001 From: Bruno Windels Date: Mon, 15 Oct 2018 16:40:51 +0200 Subject: [PATCH 1/6] phased rollout expired function --- src/PhasedRollOut.js | 62 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 src/PhasedRollOut.js diff --git a/src/PhasedRollOut.js b/src/PhasedRollOut.js new file mode 100644 index 0000000000..db91f8ab76 --- /dev/null +++ b/src/PhasedRollOut.js @@ -0,0 +1,62 @@ +/* +Copyright 2015, 2016 OpenMarket Ltd +Copyright 2017 Vector Creations Ltd +Copyright 2018 New Vector Ltd + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +import SdkConfig from './SdkConfig'; + +function hashCode(str) { + var hash = 0, i, chr; + if (str.length === 0) return hash; + for (i = 0; i < str.length; i++) { + chr = str.charCodeAt(i); + hash = ((hash << 5) - hash) + chr; + hash |= 0; + } + return Math.abs(hash); +} + +export function phasedRollOutExpiredForUser(username, feature, now, rollOutConfig = SdkConfig.get().phasedRollOut) { + if (!rollOutConfig) { + console.log(`no phased rollout configuration, so enabling ${feature}`); + return true; + } + const featureConfig = rollOutConfig[feature]; + if (!featureConfig) { + console.log(`${feature} doesn't have phased rollout configured, so enabling`); + return true; + } + if (!Number.isFinite(featureConfig.offset) || !Number.isFinite(featureConfig.period)) { + console.error(`phased rollout of ${feature} is misconfigured, offset and/or period are not numbers, so disabling`, featureConfig); + return false; + } + + const hash = hashCode(username); + //ms -> min, enable users at minute granularity + const bucketRatio = 1000 * 60; + const bucketCount = featureConfig.period / bucketRatio; + const userBucket = hash % bucketCount; + const userMs = userBucket * bucketRatio; + const enableAt = featureConfig.offset + userMs; + const result = now >= enableAt; + const bucketStr = `(bucket ${userBucket}/${bucketCount})`; + if (result) { + console.log(`${feature} enabled for ${username} ${bucketStr}`) + } else { + console.log(`${feature} will be enabled for ${username} in ${Math.ceil((enableAt - now)/1000)}s ${bucketStr}`); + } + return result; +} From f717c5697bf14b141dcda71b5c51ee532250ff43 Mon Sep 17 00:00:00 2001 From: Bruno Windels Date: Mon, 15 Oct 2018 16:41:04 +0200 Subject: [PATCH 2/6] tests for phased rollout function --- test/PhasedRollOut-test.js | 75 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 test/PhasedRollOut-test.js diff --git a/test/PhasedRollOut-test.js b/test/PhasedRollOut-test.js new file mode 100644 index 0000000000..918fe87543 --- /dev/null +++ b/test/PhasedRollOut-test.js @@ -0,0 +1,75 @@ +/* +Copyright 2018 New Vector Ltd +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +import expect from 'expect'; +import {phasedRollOutExpiredForUser} from '../src/PhasedRollOut'; + +const OFFSET = 6000000; +// phasedRollOutExpiredForUser enables users in bucks of 1 minute +const MS_IN_MINUTE = 60 * 1000; + +describe('PhasedRollOut', function() { + it('should return true if phased rollout is not configured', function() { + expect(phasedRollOutExpiredForUser("@user:hs", "feature_test", 0, null)).toBeTruthy(); + }); + + it('should return true if phased rollout feature is not configured', function() { + expect(phasedRollOutExpiredForUser("@user:hs", "feature_test", 0, { + "feature_other": {offset: 0, period: 0} + })).toBeTruthy(); + }); + + it('should return false if phased rollout for feature is misconfigured', function() { + expect(phasedRollOutExpiredForUser("@user:hs", "feature_test", 0, { + "feature_test": {} + })).toBeFalsy(); + }); + + it("should return false if phased rollout hasn't started yet", function() { + expect(phasedRollOutExpiredForUser("@user:hs", "feature_test", 5000000,{ + "feature_test": {offset: OFFSET, period: MS_IN_MINUTE} + })).toBeFalsy(); + }); + + it("should start to return true in bucket 2/10 for '@user:hs'", function() { + expect(phasedRollOutExpiredForUser("@user:hs", "feature_test", + OFFSET + (MS_IN_MINUTE * 2) - 1, { + "feature_test": {offset: OFFSET, period: MS_IN_MINUTE * 10} + })).toBeFalsy(); + expect(phasedRollOutExpiredForUser("@user:hs", "feature_test", + OFFSET + (MS_IN_MINUTE * 2), { + "feature_test": {offset: OFFSET, period: MS_IN_MINUTE * 10} + })).toBeTruthy(); + }); + + it("should start to return true in bucket 4/10 for 'alice@other-hs'", function() { + expect(phasedRollOutExpiredForUser("alice@other-hs", "feature_test", + OFFSET + (MS_IN_MINUTE * 4) - 1, { + "feature_test": {offset: OFFSET, period: MS_IN_MINUTE * 10} + })).toBeFalsy(); + expect(phasedRollOutExpiredForUser("alice@other-hs", "feature_test", + OFFSET + (MS_IN_MINUTE * 4), { + "feature_test": {offset: OFFSET, period: MS_IN_MINUTE * 10} + })).toBeTruthy(); + }); + + it("should return true after complete rollout period'", function() { + expect(phasedRollOutExpiredForUser("user:hs", "feature_test", + OFFSET + (MS_IN_MINUTE * 20), { + "feature_test": {offset: OFFSET, period: MS_IN_MINUTE * 10} + })).toBeTruthy(); + }); + + + +}); From ef204b6e99b2cbd253c71fe00781c287796db459 Mon Sep 17 00:00:00 2001 From: Bruno Windels Date: Mon, 15 Oct 2018 16:41:24 +0200 Subject: [PATCH 3/6] check if phased rollout has expired before trying to enable LL --- src/MatrixClientPeg.js | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/MatrixClientPeg.js b/src/MatrixClientPeg.js index f02c751a2c..04b3b47e43 100644 --- a/src/MatrixClientPeg.js +++ b/src/MatrixClientPeg.js @@ -26,6 +26,7 @@ import EventTimelineSet from 'matrix-js-sdk/lib/models/event-timeline-set'; import createMatrixClient from './utils/createMatrixClient'; import SettingsStore from './settings/SettingsStore'; import MatrixActionCreators from './actions/MatrixActionCreators'; +import {phasedRollOutExpiredForUser} from "./PhasedRollOut"; interface MatrixClientCreds { homeserverUrl: string, @@ -124,8 +125,12 @@ class MatrixClientPeg { // the react sdk doesn't work without this, so don't allow opts.pendingEventOrdering = "detached"; - if (SettingsStore.isFeatureEnabled('feature_lazyloading')) { - opts.lazyLoadMembers = true; + const LAZY_LOADING_FEATURE = "feature_lazyloading"; + if (SettingsStore.isFeatureEnabled(LAZY_LOADING_FEATURE)) { + const userId = this.matrixClient.credentials.userId; + if (phasedRollOutExpiredForUser(userId, LAZY_LOADING_FEATURE, Date.now())) { + opts.lazyLoadMembers = true; + } } // Connect the matrix client to the dispatcher From 478c06c32ea5d9d64bb3c506a303a88c7cb27b69 Mon Sep 17 00:00:00 2001 From: Bruno Windels Date: Mon, 15 Oct 2018 16:43:52 +0200 Subject: [PATCH 4/6] this file starts in 2018 --- src/PhasedRollOut.js | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/PhasedRollOut.js b/src/PhasedRollOut.js index db91f8ab76..c0e01110ea 100644 --- a/src/PhasedRollOut.js +++ b/src/PhasedRollOut.js @@ -1,6 +1,4 @@ /* -Copyright 2015, 2016 OpenMarket Ltd -Copyright 2017 Vector Creations Ltd Copyright 2018 New Vector Ltd Licensed under the Apache License, Version 2.0 (the "License"); From f9f7abb0d1ae413bf79f9fb67959c1e04427cb34 Mon Sep 17 00:00:00 2001 From: Bruno Windels Date: Mon, 15 Oct 2018 17:01:30 +0200 Subject: [PATCH 5/6] fix lint --- src/PhasedRollOut.js | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/src/PhasedRollOut.js b/src/PhasedRollOut.js index c0e01110ea..a9029d07e6 100644 --- a/src/PhasedRollOut.js +++ b/src/PhasedRollOut.js @@ -17,14 +17,18 @@ limitations under the License. import SdkConfig from './SdkConfig'; function hashCode(str) { - var hash = 0, i, chr; - if (str.length === 0) return hash; - for (i = 0; i < str.length; i++) { - chr = str.charCodeAt(i); - hash = ((hash << 5) - hash) + chr; - hash |= 0; - } - return Math.abs(hash); + let hash = 0; + let i; + let chr; + if (str.length === 0) { + return hash; + } + for (i = 0; i < str.length; i++) { + chr = str.charCodeAt(i); + hash = ((hash << 5) - hash) + chr; + hash |= 0; + } + return Math.abs(hash); } export function phasedRollOutExpiredForUser(username, feature, now, rollOutConfig = SdkConfig.get().phasedRollOut) { @@ -38,7 +42,8 @@ export function phasedRollOutExpiredForUser(username, feature, now, rollOutConfi return true; } if (!Number.isFinite(featureConfig.offset) || !Number.isFinite(featureConfig.period)) { - console.error(`phased rollout of ${feature} is misconfigured, offset and/or period are not numbers, so disabling`, featureConfig); + console.error(`phased rollout of ${feature} is misconfigured, ` + + `offset and/or period are not numbers, so disabling`, featureConfig); return false; } @@ -52,7 +57,7 @@ export function phasedRollOutExpiredForUser(username, feature, now, rollOutConfi const result = now >= enableAt; const bucketStr = `(bucket ${userBucket}/${bucketCount})`; if (result) { - console.log(`${feature} enabled for ${username} ${bucketStr}`) + console.log(`${feature} enabled for ${username} ${bucketStr}`); } else { console.log(`${feature} will be enabled for ${username} in ${Math.ceil((enableAt - now)/1000)}s ${bucketStr}`); } From 63f1c41d18ca028ef33f2547021d3ffa47f823ed Mon Sep 17 00:00:00 2001 From: Bruno Windels Date: Mon, 15 Oct 2018 17:15:22 +0200 Subject: [PATCH 6/6] fix test lint --- test/PhasedRollOut-test.js | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/test/PhasedRollOut-test.js b/test/PhasedRollOut-test.js index 918fe87543..600b9051f7 100644 --- a/test/PhasedRollOut-test.js +++ b/test/PhasedRollOut-test.js @@ -25,51 +25,48 @@ describe('PhasedRollOut', function() { it('should return true if phased rollout feature is not configured', function() { expect(phasedRollOutExpiredForUser("@user:hs", "feature_test", 0, { - "feature_other": {offset: 0, period: 0} + "feature_other": {offset: 0, period: 0}, })).toBeTruthy(); }); it('should return false if phased rollout for feature is misconfigured', function() { expect(phasedRollOutExpiredForUser("@user:hs", "feature_test", 0, { - "feature_test": {} + "feature_test": {}, })).toBeFalsy(); }); it("should return false if phased rollout hasn't started yet", function() { - expect(phasedRollOutExpiredForUser("@user:hs", "feature_test", 5000000,{ - "feature_test": {offset: OFFSET, period: MS_IN_MINUTE} + expect(phasedRollOutExpiredForUser("@user:hs", "feature_test", 5000000, { + "feature_test": {offset: OFFSET, period: MS_IN_MINUTE}, })).toBeFalsy(); }); it("should start to return true in bucket 2/10 for '@user:hs'", function() { expect(phasedRollOutExpiredForUser("@user:hs", "feature_test", OFFSET + (MS_IN_MINUTE * 2) - 1, { - "feature_test": {offset: OFFSET, period: MS_IN_MINUTE * 10} + "feature_test": {offset: OFFSET, period: MS_IN_MINUTE * 10}, })).toBeFalsy(); expect(phasedRollOutExpiredForUser("@user:hs", "feature_test", OFFSET + (MS_IN_MINUTE * 2), { - "feature_test": {offset: OFFSET, period: MS_IN_MINUTE * 10} + "feature_test": {offset: OFFSET, period: MS_IN_MINUTE * 10}, })).toBeTruthy(); }); it("should start to return true in bucket 4/10 for 'alice@other-hs'", function() { expect(phasedRollOutExpiredForUser("alice@other-hs", "feature_test", OFFSET + (MS_IN_MINUTE * 4) - 1, { - "feature_test": {offset: OFFSET, period: MS_IN_MINUTE * 10} + "feature_test": {offset: OFFSET, period: MS_IN_MINUTE * 10}, })).toBeFalsy(); expect(phasedRollOutExpiredForUser("alice@other-hs", "feature_test", OFFSET + (MS_IN_MINUTE * 4), { - "feature_test": {offset: OFFSET, period: MS_IN_MINUTE * 10} + "feature_test": {offset: OFFSET, period: MS_IN_MINUTE * 10}, })).toBeTruthy(); }); it("should return true after complete rollout period'", function() { expect(phasedRollOutExpiredForUser("user:hs", "feature_test", OFFSET + (MS_IN_MINUTE * 20), { - "feature_test": {offset: OFFSET, period: MS_IN_MINUTE * 10} + "feature_test": {offset: OFFSET, period: MS_IN_MINUTE * 10}, })).toBeTruthy(); }); - - - });