Skip to content
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.

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

Cirrus has enrolments as an array #5509

Merged
merged 6 commits into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 8 additions & 20 deletions src/app/hooks/useGlean.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { useExperiments } from "../../contextProviders/experiments";

export const useGlean = () => {
const session = useSession();
const experimentData = useExperiments();
const experiments = useExperiments();
// Telemetry recording is mocked in our unit tests, therefore we
// do not have test coverage for this method.
/* c8 ignore start */
Expand Down Expand Up @@ -44,31 +44,19 @@ export const useGlean = () => {
// Record the `nimbus_*` keys on all events.
// `nimbus_*` is set on every metric, but it's too much work for TypeScript
// to infer that — hence the type assertion.

if (
experimentData &&
typeof experimentData["Enrollments"] !== "undefined"
) {
(data as GleanMetricMap["button"]["click"]).nimbus_user_id =
experimentData["Enrollments"]["nimbus_user_id"];
(data as GleanMetricMap["button"]["click"]).nimbus_app_id =
experimentData["Enrollments"]["app_id"];
(data as GleanMetricMap["button"]["click"]).nimbus_experiment =
experimentData["Enrollments"]["experiment"];
(data as GleanMetricMap["button"]["click"]).nimbus_branch =
experimentData["Enrollments"]["branch"];
(data as GleanMetricMap["button"]["click"]).nimbus_experiment_type =
experimentData["Enrollments"]["experiment_type"];
(data as GleanMetricMap["button"]["click"]).nimbus_is_preview =
experimentData["Enrollments"]["is_preview"].toString();
if (experiments === null) {
console.warn(
"`useGlean` is used in a component that is not a (grand)child of <ExperimentsProvider>",
);
} else {
console.warn("No experiment data available for Glean");
(data as GleanMetricMap["button"]["click"]).nimbus_user_id =
experiments.experimentationId;
}

// eslint-disable-next-line @typescript-eslint/no-explicit-any
mod[event].record(data as any);
},
[isPremiumUser, experimentData],
[isPremiumUser, experiments],
);
/* c8 ignore end */

Expand Down
16 changes: 9 additions & 7 deletions src/app/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,12 @@ export default async function RootLayout({
previewMode: nimbusPreviewMode === "true",
});

const nimbus_user_id = experimentData["Enrollments"]?.nimbus_user_id;
if (
typeof nimbus_user_id !== "undefined" &&
nimbus_user_id !== experimentationId
) {
const enrollmentWithConflictingUserId = (
experimentData.Enrollments ?? []
).find((enrollment) => enrollment.nimbus_user_id !== experimentationId);
if (typeof enrollmentWithConflictingUserId !== "undefined") {
Sentry.captureMessage(
`Nimbus user ID from Cirrus: [${nimbus_user_id}] did not match experimentationId: [${experimentationId}]`,
`Nimbus user ID from Cirrus: [${enrollmentWithConflictingUserId.nimbus_user_id}] did not match experimentationId: [${experimentationId}]`,
);
}

Expand All @@ -97,7 +96,10 @@ export default async function RootLayout({
data-ga4-measurement-id={CONST_GA4_MEASUREMENT_ID}
data-node-env={process.env.NODE_ENV}
>
<ExperimentsProvider experimentData={experimentData}>
<ExperimentsProvider
experimentData={experimentData}
experimentationId={experimentationId}
>
<SessionProvider session={session}>{children}</SessionProvider>
</ExperimentsProvider>
</body>
Expand Down
5 changes: 4 additions & 1 deletion src/contextProviders/experiments.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@ describe("Experiment context provider", () => {
return <div />;
};
const { container } = render(
<ExperimentsProvider experimentData={defaultExperimentData}>
<ExperimentsProvider
experimentData={defaultExperimentData}
experimentationId="-1"
>
<TestComponent />
</ExperimentsProvider>,
);
Expand Down
21 changes: 13 additions & 8 deletions src/contextProviders/experiments.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,23 @@ import { ExperimentData_V2_Or_V2LikeV1 } from "../app/functions/server/getExperi
interface ExperimentsProviderProps {
children: ReactNode;
experimentData: ExperimentData_V2_Or_V2LikeV1;
experimentationId: string;
}

export const ExperimentsContext =
createContext<ExperimentData_V2_Or_V2LikeV1 | null>(null);
export const ExperimentsContext = createContext<{
experimentData: ExperimentData_V2_Or_V2LikeV1;
experimentationId: string;
} | null>(null);

export const ExperimentsProvider = ({
children,
experimentData,
}: ExperimentsProviderProps) => {
export const ExperimentsProvider = (props: ExperimentsProviderProps) => {
return (
<ExperimentsContext.Provider value={experimentData}>
{children}
<ExperimentsContext.Provider
value={{
experimentData: props.experimentData,
experimentationId: props.experimentationId,
}}
>
{props.children}
</ExperimentsContext.Provider>
);
};
Expand Down
58 changes: 31 additions & 27 deletions src/scripts/build/nimbusTypes.js
Original file line number Diff line number Diff line change
Expand Up @@ -96,17 +96,19 @@ function getFallbackObject(nimbusConfig) {
);

const defaultExperimentData = `
"Features": {
Features: {
${featureFallbackDefs.join("\n")}
},
"Enrollments": {
"nimbus_user_id": "-1",
"app_id": "-1",
"experiment": "-1",
"branch": "-1",
"experiment_type": "-1",
"is_preview": false
}`;
Enrollments: [
{
nimbus_user_id: "-1",
app_id: "-1",
experiment: "-1",
branch: "-1",
experiment_type: "-1",
is_preview: false
}
]`;
return `export const defaultExperimentData: ExperimentData = {\n${defaultExperimentData}};\n`;
}

Expand All @@ -129,17 +131,19 @@ function getLocalOverrides(nimbusConfig) {
);

const localExperimentData = `
"Features": {
Features: {
${featureLocalOverridesDefs.join("\n")}
},
"Enrollments": {
"nimbus_user_id": "-1",
"app_id": "-1",
"experiment": "-1",
"branch": "-1",
"experiment_type": "-1",
"is_preview": false
}`;
Enrollments: [
{
nimbus_user_id: "-1",
app_id: "-1",
experiment: "-1",
branch: "-1",
experiment_type: "-1",
is_preview: false
}
]`;

return `export const localExperimentData: ExperimentData = {\n${localExperimentData}};\n`;
}
Expand All @@ -160,15 +164,15 @@ function getFeaturesTypeDef(nimbusConfig) {
});

const experimentDataType = `{
"Features": {${featureDefs.join("")}};
"Enrollments": {
"nimbus_user_id": string,
"app_id": string,
"experiment": string,
"branch": string,
"experiment_type": string,
"is_preview": boolean
};
Features: {${featureDefs.join("")}};
Enrollments: Array<{
nimbus_user_id: string,
app_id: string,
experiment: string,
branch: string,
experiment_type: string,
is_preview: boolean
}>;
};`;

const experimentDataTypeDef = `/** Status of experiments, as setup in Experimenter */\nexport type ExperimentData = ${experimentDataType}`;
Expand Down
Loading
Loading