Skip to content

refactor GateType #1416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shtukas merged 1 commit into from
Aug 26, 2025
Merged

refactor GateType #1416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 14 additions & 15 deletions src/server/signin-gate/lib.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import {
userTreatmentsEnvelopToProxyGetTreatmentsAnswerData,
} from './libPure';
import type { GetTreatmentsRequestPayload } from './types';
import { GateType } from './types';

describe('buildGetTreatmentsRequestPayload', () => {
it('should return return the right payload', () => {
Expand Down Expand Up @@ -341,7 +340,7 @@ describe('decideGateTypeFromGetTreatmentsRequestPayload', () => {
gateDisplayCount: 0,
};
const gateType = getTreatmentsRequestPayloadToGateType(body);
expect(gateType).toStrictEqual(GateType.GuDismissible);
expect(gateType).toStrictEqual('GuDismissible');
});

it('test shouldServeDismissible and showDefaultGate:dismissible interacting together', () => {
Expand All @@ -364,7 +363,7 @@ describe('decideGateTypeFromGetTreatmentsRequestPayload', () => {
gateDisplayCount: 0,
};
const gateType = getTreatmentsRequestPayloadToGateType(body);
expect(gateType).toStrictEqual(GateType.GuDismissible);
expect(gateType).toStrictEqual('GuDismissible');
});

it('showDefaultGate:mandatory overrides any other behavior', () => {
Expand All @@ -387,7 +386,7 @@ describe('decideGateTypeFromGetTreatmentsRequestPayload', () => {
gateDisplayCount: 0,
};
const gateType = getTreatmentsRequestPayloadToGateType(body);
expect(gateType).toStrictEqual(GateType.GuMandatory);
expect(gateType).toStrictEqual('GuMandatory');
});

it('showDefaultGate:dismissible overrides any other behavior', () => {
Expand All @@ -410,7 +409,7 @@ describe('decideGateTypeFromGetTreatmentsRequestPayload', () => {
gateDisplayCount: 0,
};
const gateType = getTreatmentsRequestPayloadToGateType(body);
expect(gateType).toStrictEqual(GateType.GuDismissible);
expect(gateType).toStrictEqual('GuDismissible');
});

it('non consenting users in Ireland, low dailyArticleCount', () => {
Expand All @@ -433,7 +432,7 @@ describe('decideGateTypeFromGetTreatmentsRequestPayload', () => {
gateDisplayCount: 0,
};
const gateType = getTreatmentsRequestPayloadToGateType(body);
expect(gateType).toStrictEqual(GateType.AuxiaAnalyticThenNone);
expect(gateType).toStrictEqual('AuxiaAnalyticThenNone');
});

it('non consenting users in Ireland, low dailyArticleCount=3 (start of gate showing)', () => {
Expand All @@ -456,7 +455,7 @@ describe('decideGateTypeFromGetTreatmentsRequestPayload', () => {
gateDisplayCount: 0,
};
const gateType = getTreatmentsRequestPayloadToGateType(body);
expect(gateType).toStrictEqual(GateType.GuDismissible);
expect(gateType).toStrictEqual('GuDismissible');
});

it('non consenting users in Ireland, low gateDisplayCount: 1 (still dismissible)', () => {
Expand All @@ -479,7 +478,7 @@ describe('decideGateTypeFromGetTreatmentsRequestPayload', () => {
gateDisplayCount: 1,
};
const gateType = getTreatmentsRequestPayloadToGateType(body);
expect(gateType).toStrictEqual(GateType.AuxiaAnalyticThenGuDismissible);
expect(gateType).toStrictEqual('AuxiaAnalyticThenGuDismissible');
});

it('non consenting users in Ireland, low gateDisplayCount: 3 (mandatory from now on)', () => {
Expand All @@ -502,7 +501,7 @@ describe('decideGateTypeFromGetTreatmentsRequestPayload', () => {
gateDisplayCount: 3,
};
const gateType = getTreatmentsRequestPayloadToGateType(body);
expect(gateType).toStrictEqual(GateType.AuxiaAnalyticThenGuMandatory);
expect(gateType).toStrictEqual('AuxiaAnalyticThenGuMandatory');
});

it('non consenting users in Ireland, low gateDisplayCount: 4 (mandatory from now on)', () => {
Expand All @@ -525,7 +524,7 @@ describe('decideGateTypeFromGetTreatmentsRequestPayload', () => {
gateDisplayCount: 4,
};
const gateType = getTreatmentsRequestPayloadToGateType(body);
expect(gateType).toStrictEqual(GateType.AuxiaAnalyticThenGuMandatory);
expect(gateType).toStrictEqual('AuxiaAnalyticThenGuMandatory');
});

it('invalid attribute: contentType', () => {
Expand All @@ -548,7 +547,7 @@ describe('decideGateTypeFromGetTreatmentsRequestPayload', () => {
gateDisplayCount: 0,
};
const gateType = getTreatmentsRequestPayloadToGateType(body);
expect(gateType).toStrictEqual(GateType.None);
expect(gateType).toStrictEqual('None');
});

it('invalid attribute: sectionId', () => {
Expand All @@ -571,7 +570,7 @@ describe('decideGateTypeFromGetTreatmentsRequestPayload', () => {
gateDisplayCount: 0,
};
const gateType = getTreatmentsRequestPayloadToGateType(body);
expect(gateType).toStrictEqual(GateType.None);
expect(gateType).toStrictEqual('None');
});

it('invalid attribute: tagIds', () => {
Expand All @@ -594,7 +593,7 @@ describe('decideGateTypeFromGetTreatmentsRequestPayload', () => {
gateDisplayCount: 0,
};
const gateType = getTreatmentsRequestPayloadToGateType(body);
expect(gateType).toStrictEqual(GateType.None);
expect(gateType).toStrictEqual('None');
});

it('invalid attribute: articleIdentifier', () => {
Expand All @@ -617,7 +616,7 @@ describe('decideGateTypeFromGetTreatmentsRequestPayload', () => {
gateDisplayCount: 0,
};
const gateType = getTreatmentsRequestPayloadToGateType(body);
expect(gateType).toStrictEqual(GateType.None);
expect(gateType).toStrictEqual('None');
});

it('should return a gate in the case of the Giulia experiment', () => {
Expand All @@ -640,6 +639,6 @@ describe('decideGateTypeFromGetTreatmentsRequestPayload', () => {
gateDisplayCount: 0,
};
const gateType = getTreatmentsRequestPayloadToGateType(body);
expect(gateType).toStrictEqual(GateType.GuDismissible);
expect(gateType).toStrictEqual('GuDismissible');
});
});
22 changes: 13 additions & 9 deletions src/server/signin-gate/libEffect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,12 @@ import {
guDismissibleUserTreatment,
guMandatoryUserTreatment,
} from './libPure';
import type { GetTreatmentsRequestPayload, UserTreatment, UserTreatmentsEnvelop } from './types';
import { GateType } from './types';
import type {
GateType,
GetTreatmentsRequestPayload,
UserTreatment,
UserTreatmentsEnvelop,
} from './types';

export const callAuxiaGetTreatments = async (
apiKey: string,
Expand Down Expand Up @@ -81,19 +85,19 @@ export const gateTypeToUserTreatmentsEnvelop = async (
getTreatmentsRequestPayload: GetTreatmentsRequestPayload,
): Promise<UserTreatmentsEnvelop | undefined> => {
switch (gateType) {
case GateType.None:
case 'None':
return Promise.resolve(undefined);
case GateType.GuDismissible:
case 'GuDismissible':
return {
responseId: '',
userTreatments: [guDismissibleUserTreatment()],
};
case GateType.GuMandatory:
case 'GuMandatory':
return {
responseId: '',
userTreatments: [guDismissibleUserTreatment()],
};
case GateType.Auxia:
case 'AuxiaAPI':
return await callAuxiaGetTreatments(
config.apiKey,
config.projectId,
Expand All @@ -106,7 +110,7 @@ export const gateTypeToUserTreatmentsEnvelop = async (
getTreatmentsRequestPayload.hasConsented,
getTreatmentsRequestPayload.shouldServeDismissible,
);
case GateType.AuxiaAnalyticThenNone:
case 'AuxiaAnalyticThenNone':
await callAuxiaGetTreatments(
config.apiKey,
config.projectId,
Expand All @@ -120,7 +124,7 @@ export const gateTypeToUserTreatmentsEnvelop = async (
getTreatmentsRequestPayload.shouldServeDismissible,
);
return Promise.resolve(undefined);
case GateType.AuxiaAnalyticThenGuDismissible:
case 'AuxiaAnalyticThenGuDismissible':
await callAuxiaGetTreatments(
config.apiKey,
config.projectId,
Expand All @@ -137,7 +141,7 @@ export const gateTypeToUserTreatmentsEnvelop = async (
responseId: '',
userTreatments: [guDismissibleUserTreatment()],
};
case GateType.AuxiaAnalyticThenGuMandatory:
case 'AuxiaAnalyticThenGuMandatory':
await callAuxiaGetTreatments(
config.apiKey,
config.projectId,
Expand Down
26 changes: 13 additions & 13 deletions src/server/signin-gate/libPure.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
import type {
AuxiaAPIGetTreatmentsRequestPayload,
AuxiaAPILogTreatmentInteractionRequestPayload,
GateType,
GetTreatmentsRequestPayload,
ProxyGetTreatmentsAnswerData,
UserTreatment,
UserTreatmentsEnvelop,
} from './types';
import { GateType } from './types';

export const buildGetTreatmentsRequestPayload = (
projectId: string,
Expand Down Expand Up @@ -315,13 +315,13 @@ export const decideGateTypeNoneOrDismissible = (gateDismissCount: number): GateT
// (We do not want users to have to dismiss the gate 6 times)

if (gateDismissCount > 5) {
return GateType.None;
return 'None';
}

// -----------------------------------------------------------------------
// We are now clear to show the default (dismissible) gu gate.

return GateType.GuDismissible;
return 'GuDismissible';
};

export const decideGuGateTypeNonConsentedIreland = (
Expand All @@ -332,7 +332,7 @@ export const decideGuGateTypeNonConsentedIreland = (
// If we reach this point, we are in Ireland

if (dailyArticleCount < 3) {
return GateType.AuxiaAnalyticThenNone;
return 'AuxiaAnalyticThenNone';
}

// gateDisplayCount was introduced to enrich the behavior of the default gate.
Expand All @@ -348,10 +348,10 @@ export const decideGuGateTypeNonConsentedIreland = (
// -------------------------------------------------------------------------

if (gateDisplayCount >= 3) {
return GateType.AuxiaAnalyticThenGuMandatory;
return 'AuxiaAnalyticThenGuMandatory';
}

return GateType.AuxiaAnalyticThenGuDismissible;
return 'AuxiaAnalyticThenGuDismissible';
};

export const getTreatmentsRequestPayloadToGateType = (
Expand Down Expand Up @@ -382,17 +382,17 @@ export const getTreatmentsRequestPayloadToGateType = (
getTreatmentsRequestPayload.showDefaultGate !== undefined &&
getTreatmentsRequestPayload.shouldServeDismissible
) {
return GateType.GuDismissible;
return 'GuDismissible';
}

// --------------------------------------------------------------
// The attribute showDefaultGate overrides any other behavior

if (getTreatmentsRequestPayload.showDefaultGate) {
if (getTreatmentsRequestPayload.showDefaultGate == 'mandatory') {
return GateType.GuMandatory;
return 'GuMandatory';
} else {
return GateType.GuDismissible;
return 'GuDismissible';
}
}

Expand All @@ -408,7 +408,7 @@ export const getTreatmentsRequestPayloadToGateType = (
!isValidTagIdCollection(getTreatmentsRequestPayload.tagIds) ||
!articleIdentifierIsAllowed(getTreatmentsRequestPayload.articleIdentifier)
) {
return GateType.None;
return 'None';
}

// --------------------------------------------------------------
Expand All @@ -419,7 +419,7 @@ export const getTreatmentsRequestPayloadToGateType = (

if (getTreatmentsRequestPayload.countryCode === 'IE') {
if (mvtIdIsAuxiaAudienceShare(getTreatmentsRequestPayload.mvtId)) {
return GateType.Auxia;
return 'AuxiaAPI';
} else {
return decideGuGateTypeNonConsentedIreland(
getTreatmentsRequestPayload.dailyArticleCount,
Expand All @@ -444,12 +444,12 @@ export const getTreatmentsRequestPayloadToGateType = (
if (getTreatmentsRequestPayload.should_show_legacy_gate_tmp) {
return decideGateTypeNoneOrDismissible(getTreatmentsRequestPayload.gateDismissCount);
} else {
return GateType.None;
return 'None';
}
}

// --------------------------------------------------------------
// Auxia share of the audience (outside Ireland)

return GateType.Auxia;
return 'AuxiaAPI';
};
17 changes: 8 additions & 9 deletions src/server/signin-gate/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,14 @@ export interface UserTreatmentsEnvelop {
userTreatments: UserTreatment[];
}

export enum GateType {
None, // [1]
GuDismissible, // [2]
GuMandatory, // [3]
Auxia, // [4]
AuxiaAnalyticThenNone, // [5]
AuxiaAnalyticThenGuDismissible, // [6]
AuxiaAnalyticThenGuMandatory, // [7]
}
export type GateType =
| 'None' // [1]
| 'GuDismissible' // [2]
| 'GuMandatory' // [3]
| 'AuxiaAPI' // [4]
| 'AuxiaAnalyticThenNone' // [5]
| 'AuxiaAnalyticThenGuDismissible' // [6]
| 'AuxiaAnalyticThenGuMandatory'; // [7]

// [1] Signals no gate to display
// [2] Signals the Gu Dismissible gate
Expand Down