github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-11-21 20:47:08 -05:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #16307 from overleaf/ab-split-tests-never-throw

Browse source 
[web] Guarantee split test assignments can never throw and cleanup boilterplate error handling

GitOrigin-RevId: ab50abde6e0632c5a9625b5c3d3e98f3383cc56c
This commit is contained in:
Alexandre Bourdin 2024-01-18 15:25:01 +01:00 committed by Copybot
parent 29d41497ef
commit 3b9eb4e8aa
5 changed files with 149 additions and 317 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

114
services/web/app/src/Features/Project/ProjectController.js
View file

@ -542,78 +542,31 @@ const ProjectController = {
req,
res,
'project-share-modal-paywall',
{},
() => {
// do not fail editor load if assignment fails
cb()
}
cb
)
},
sharingModalNullTest(cb) {
// null test targeting logged in users, for front-end side
SplitTestHandler.getAssignment(
req,
res,
'null-test-share-modal',
{},
() => {
// do not fail editor load if assignment fails
cb()
}
)
SplitTestHandler.getAssignment(req, res, 'null-test-share-modal', cb)
},
pdfjsAssignment(cb) {
SplitTestHandler.getAssignment(
req,
res,
'pdfjs-40',
{},
(error, assignment) => {
// do not fail editor load if assignment fails
if (error) {
cb(null, { variant: 'default' })
} else {
cb(null, assignment)
}
}
)
SplitTestHandler.getAssignment(req, res, 'pdfjs-40', cb)
},
latexLogParserAssignment(cb) {
SplitTestHandler.getAssignment(
req,
res,
'latex-log-parser',
(error, assignment) => {
// do not fail editor load if assignment fails
if (error) {
cb(null, { variant: 'default' })
} else {
cb(null, assignment)
}
}
)
SplitTestHandler.getAssignment(req, res, 'latex-log-parser', cb)
},
trackPdfDownloadAssignment(cb) {
SplitTestHandler.getAssignment(req, res, 'track-pdf-download', () => {
// We'll pick up the assignment from the res.locals assignment.
cb()
})
SplitTestHandler.getAssignment(req, res, 'track-pdf-download', cb)
},
pdfCachingModeAssignment(cb) {
SplitTestHandler.getAssignment(req, res, 'pdf-caching-mode', () => {
// We'll pick up the assignment from the res.locals assignment.
cb()
})
SplitTestHandler.getAssignment(req, res, 'pdf-caching-mode', cb)
},
pdfCachingPrefetchingAssignment(cb) {
SplitTestHandler.getAssignment(
req,
res,
'pdf-caching-prefetching',
() => {
// We'll pick up the assignment from the res.locals assignment.
cb()
}
cb
)
},
pdfCachingPrefetchLargeAssignment(cb) {
@ -621,10 +574,7 @@ const ProjectController = {
req,
res,
'pdf-caching-prefetch-large',
() => {
// We'll pick up the assignment from the res.locals assignment.
cb()
}
cb
)
},
pdfCachingCachedUrlLookupAssignment(cb) {
@ -632,10 +582,7 @@ const ProjectController = {
req,
res,
'pdf-caching-cached-url-lookup',
() => {
// We'll pick up the assignment from the res.locals assignment.
cb()
}
cb
)
},
tableGeneratorPromotionAssignment(cb) {
@ -643,52 +590,17 @@ const ProjectController = {
req,
res,
'table-generator-promotion',
() => {
// We'll pick up the assignment from the res.locals assignment.
cb()
}
cb
)
},
personalAccessTokenAssignment(cb) {
SplitTestHandler.getAssignment(
req,
res,
'personal-access-token',
(error, assignment) => {
// do not fail editor load if assignment fails
if (error) {
cb(null, { variant: 'default' })
} else {
cb(null, assignment)
}
}
)
SplitTestHandler.getAssignment(req, res, 'personal-access-token', cb)
},
idePageAssignment(cb) {
SplitTestHandler.getAssignment(
req,
res,
'ide-page',
(error, assignment) => {
// do not fail editor load if assignment fails
if (error) {
cb(null, { variant: 'default' })
} else {
cb(null, assignment)
}
}
)
SplitTestHandler.getAssignment(req, res, 'ide-page', cb)
},
writefullIntegrationAssignment(cb) {
SplitTestHandler.getAssignment(
req,
res,
'writefull-integration',
() => {
// We'll pick up the assignment from the res.locals assignment.
cb()
}
)
SplitTestHandler.getAssignment(req, res, 'writefull-integration', cb)
},
projectTags(cb) {
if (!userId) {

49
services/web/app/src/Features/Project/ProjectListController.js
View file

@ -326,19 +326,13 @@ async function projectListPage(req, res, next) {
)
}
}
try {
// The assignment will be picked up via 'ol-splitTestVariants' in react.
await SplitTestHandler.promises.getAssignment(
req,
res,
'download-pdf-dashboard'
)
} catch (err) {
logger.error(
{ err },
'failed to get "download-pdf-dashboard" split test assignment'
)
}
const hasPaidAffiliation = userAffiliations.some(
affiliation => affiliation.licence && affiliation.licence !== 'free'
@ -370,18 +364,11 @@ async function projectListPage(req, res, next) {
}
}
try {
await SplitTestHandler.promises.getAssignment(
req,
res,
'writefull-integration'
)
} catch (err) {
logger.warn(
{ err },
'failed to get "writefull-integration" split test assignment'
)
}
let showInrGeoBanner, inrGeoBannerSplitTestName
let inrGeoBannerVariant = 'default'
@ -390,24 +377,10 @@ async function projectListPage(req, res, next) {
if (usersBestSubscription?.type === 'free') {
const { currencyCode, countryCode } =
await GeoIpLookup.promises.getCurrencyCode(req.ip)
let inrGeoPricingVariant = 'default'
try {
// Split test is kept active, but all users geolocated in India can
// now use the INR currency (See #13507)
const inrGeoPricingAssignment =
await SplitTestHandler.promises.getAssignment(
req,
res,
'geo-pricing-inr'
)
inrGeoPricingVariant = inrGeoPricingAssignment.variant
} catch (error) {
logger.error(
{ err: error },
'Failed to get geo-pricing-inr split test assignment'
)
}
try {
const { variant: inrGeoPricingVariant } =
await SplitTestHandler.promises.getAssignment(req, res, 'geo-pricing-inr')
const latamGeoPricingAssignment =
await SplitTestHandler.promises.getAssignment(
req,
@ -421,32 +394,18 @@ async function projectListPage(req, res, next) {
if (showLATAMBanner) {
recommendedCurrency = currencyCode
}
} catch (error) {
logger.error(
{ err: error },
'Failed to get geo-pricing-latam split test assignment'
)
}
if (countryCode === 'IN') {
inrGeoBannerSplitTestName =
inrGeoPricingVariant === 'inr'
? 'geo-banners-inr-2'
: 'geo-banners-inr-1'
try {
const geoBannerAssignment =
await SplitTestHandler.promises.getAssignment(
const geoBannerAssignment = await SplitTestHandler.promises.getAssignment(
req,
res,
inrGeoBannerSplitTestName
)
showInrGeoBanner = true
inrGeoBannerVariant = geoBannerAssignment.variant
} catch (error) {
logger.error(
{ err: error },
`Failed to get INR geo banner lookup or assignment (${inrGeoBannerSplitTestName})`
)
}
}
}

19
services/web/app/src/Features/SplitTests/SplitTestHandler.js
View file

@ -13,6 +13,7 @@ const Features = require('../../infrastructure/Features')
const SplitTestUtils = require('./SplitTestUtils')
const Settings = require('@overleaf/settings')
const SessionManager = require('../Authentication/SessionManager')
const logger = require('@overleaf/logger')
const DEFAULT_VARIANT = 'default'
const ALPHA_PHASE = 'alpha'
@ -54,6 +55,7 @@ async function getAssignment(req, res, splitTestName, { sync = false } = {}) {
const query = req.query || {}
let assignment
try {
if (!Features.hasFeature('saas')) {
assignment = _getNonSaasAssignment(splitTestName)
} else {
@ -86,6 +88,10 @@ async function getAssignment(req, res, splitTestName, { sync = false } = {}) {
_collectSessionStats(req.session)
}
}
} catch (error) {
logger.error({ err: error }, 'Failed to get split test assignment')
assignment = DEFAULT_ASSIGNMENT
}
LocalsHelper.setSplitTestVariant(
res.locals,
@ -112,12 +118,17 @@ async function getAssignmentForUser(
splitTestName,
{ sync = false } = {}
) {
try {
if (!Features.hasFeature('saas')) {
return _getNonSaasAssignment(splitTestName)
}
const analyticsId = await UserAnalyticsIdCache.get(userId)
return _getAssignment(splitTestName, { analyticsId, userId, sync })
} catch (error) {
logger.error({ err: error }, 'Failed to get split test assignment for user')
return DEFAULT_ASSIGNMENT
}
}
/**
@ -136,6 +147,7 @@ async function getAssignmentForMongoUser(
splitTestName,
{ sync = false } = {}
) {
try {
if (!Features.hasFeature('saas')) {
return _getNonSaasAssignment(splitTestName)
}
@ -146,6 +158,13 @@ async function getAssignmentForMongoUser(
user,
userId: user._id.toString(),
})
} catch (error) {
logger.error(
{ err: error },
'Failed to get split test assignment for mongo user'
)
return DEFAULT_ASSIGNMENT
}
}
/**

63
services/web/app/src/Features/Subscription/SubscriptionController.js
View file

@ -76,7 +76,6 @@ async function plansPage(req, res) {
geoPricingINRTestVariant === 'inr'
? 'geo-banners-inr-2'
: 'geo-banners-inr-1'
try {
const geoBannerAssignment = await SplitTestHandler.promises.getAssignment(
req,
res,
@ -86,29 +85,14 @@ async function plansPage(req, res) {
if (inrGeoBannerVariant !== 'default') {
showInrGeoBanner = true
}
} catch (error) {
logger.error(
{ err: error },
`Failed to get INR geo banner lookup or assignment (${inrGeoBannerSplitTestName})`
)
}
}
// annual plans with the free trial option split test - nudge variant
let annualTrialsAssignment = { variant: 'default' }
try {
annualTrialsAssignment = await SplitTestHandler.promises.getAssignment(
const annualTrialsAssignment = await SplitTestHandler.promises.getAssignment(
req,
res,
'annual-trials'
)
} catch (error) {
logger.error(
{ err: error },
'failed to get "annualTrialsAssignment" split test assignment'
)
}
const websiteRedesignVariant =
res.locals.splitTestVariants?.['website-redesign']
@ -285,9 +269,7 @@ async function interstitialPaymentPage(req, res) {
geoPricingINRTestVariant === 'inr'
? 'geo-banners-inr-2'
: 'geo-banners-inr-1'
try {
const geoBannerAssignment =
await SplitTestHandler.promises.getAssignment(
const geoBannerAssignment = await SplitTestHandler.promises.getAssignment(
req,
res,
inrGeoBannerSplitTestName
@ -296,29 +278,11 @@ async function interstitialPaymentPage(req, res) {
if (inrGeoBannerVariant !== 'default') {
showInrGeoBanner = true
}
} catch (error) {
logger.error(
{ err: error },
`Failed to get INR geo banner lookup or assignment (${inrGeoBannerSplitTestName})`
)
}
}
// annual plans with the free trial option split test - nudge variant
let annualTrialsAssignment = { variant: 'default' }
try {
annualTrialsAssignment = await SplitTestHandler.promises.getAssignment(
req,
res,
'annual-trials'
)
} catch (error) {
logger.error(
{ err: error },
'failed to get "annualTrialsAssignment" split test assignment'
)
}
const annualTrialsAssignment =
await SplitTestHandler.promises.getAssignment(req, res, 'annual-trials')
const paywallPlansPageViewSegmentation = {
currency: recommendedCurrency,
@ -680,36 +644,21 @@ async function _getRecommendedCurrency(req, res) {
}
const currencyLookup = await GeoIpLookup.promises.getCurrencyCode(ip)
const countryCode = currencyLookup.countryCode
let assignmentINR, assignmentLATAM
let recommendedCurrency = currencyLookup.currencyCode
// for #12703
try {
// Split test is kept active, but all users geolocated in India can
// now use the INR currency (See #13507)
assignmentINR = await SplitTestHandler.promises.getAssignment(
const assignmentINR = await SplitTestHandler.promises.getAssignment(
req,
res,
'geo-pricing-inr'
)
} catch (error) {
logger.error(
{ err: error },
'Failed to get assignment for geo-pricing-inr test'
)
}
// for #13559
try {
assignmentLATAM = await SplitTestHandler.promises.getAssignment(
const assignmentLATAM = await SplitTestHandler.promises.getAssignment(
req,
res,
'geo-pricing-latam'
)
} catch (error) {
logger.error(
{ err: error },
'Failed to get assignment for geo-pricing-latam test'
)
}
if (
['BRL', 'MXN', 'COP', 'CLP', 'PEN'].includes(recommendedCurrency) &&
assignmentLATAM?.variant !== 'latam'

11
services/web/app/src/Features/User/UserPagesController.js
View file

@ -74,23 +74,16 @@ async function settingsPage(req, res) {
// if not already enabled, use a split test to determine whether to offer personal access tokens
let optionalPersonalAccessToken = false
if (!showPersonalAccessToken) {
try {
const { variant } = await SplitTestHandler.promises.getAssignment(
req,
res,
'personal-access-token'
)
optionalPersonalAccessToken = variant === 'enabled' // `?personal-access-token=enabled`
} catch (error) {
logger.error(
{ err: error },
'Failed to get personal-access-token split test assignment'
)
}
}
// eslint-disable-next-line no-unused-vars -- getAssignment sets res.locals, which will pass to the splitTest context
const writefullSplitTest = await SplitTestHandler.promises.getAssignment(
// getAssignment sets res.locals, which will pass to the splitTest context
await SplitTestHandler.promises.getAssignment(
req,
res,
'writefull-integration'