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

Add typeguard for filtering out undefined #2502

Merged
merged 3 commits into from
May 16, 2024
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
9 changes: 4 additions & 5 deletions packages/back-end/src/controllers/experiments.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
import { Response } from "express";

import uniqid from "uniqid";
import format from "date-fns/format";
import cloneDeep from "lodash/cloneDeep";
import { DEFAULT_SEQUENTIAL_TESTING_TUNING_PARAMETER } from "shared/constants";
import { getValidDate } from "shared/dates";
import { getAffectedEnvsForExperiment } from "shared/util";
import { getAffectedEnvsForExperiment, isDefined } from "shared/util";
import { getAllMetricSettingsForSnapshot } from "shared/experiments";
import { getScopedSettings } from "shared/settings";
import { v4 as uuidv4 } from "uuid";
import uniq from "lodash/uniq";
import { getAllMetricSettingsForSnapshot } from "shared/experiments";
import { DataSourceInterface } from "@back-end/types/datasource";
import { AuthRequest, ResponseWithStatusAndError } from "../types/AuthRequest";
import {
Expand All @@ -21,7 +20,7 @@ import {
getExperimentMetricById,
getLinkedFeatureInfo,
} from "../services/experiments";
import { MetricInterface, MetricStats } from "../../types/metric";
import { MetricStats } from "../../types/metric";
import {
createExperiment,
deleteExperimentByIdForOrganization,
Expand Down Expand Up @@ -1819,7 +1818,7 @@ async function createExperimentSnapshot({
await Promise.all(
denominatorMetricIds.map((m) => getMetricById(context, m))
)
).filter(Boolean) as MetricInterface[];
).filter(isDefined);

const {
settingsForSnapshotMetrics,
Expand Down
6 changes: 3 additions & 3 deletions packages/back-end/src/services/experiments.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import {
getMatchingRules,
MatchingRule,
validateCondition,
isDefined,
} from "shared/util";
import {
ExperimentMetricInterface,
Expand All @@ -39,7 +40,6 @@ import {
ExperimentSnapshotAnalysisSettings,
ExperimentSnapshotInterface,
ExperimentSnapshotSettings,
MetricForSnapshot,
SnapshotVariation,
} from "../../types/experiment-snapshot";
import {
Expand Down Expand Up @@ -404,7 +404,7 @@ export function getSnapshotSettings({
experiment.metricOverrides
)
)
.filter(Boolean) as MetricForSnapshot[];
.filter(isDefined);

return {
manual: !experiment.datasource,
Expand Down Expand Up @@ -1967,7 +1967,7 @@ export async function getSettingsForSnapshotMetrics(
]);
const allExperimentMetrics = allExperimentMetricIds
.map((id) => metricMap.get(id))
.filter(Boolean);
.filter(isDefined);

const denominatorMetrics = allExperimentMetrics
.filter((m) => m && !isFactMetric(m) && m.denominator)
Expand Down
8 changes: 4 additions & 4 deletions packages/back-end/src/services/features.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ import {
FeatureRule as FeatureDefinitionRule,
AutoExperiment,
GrowthBook,
ParentConditionInterface,
} from "@growthbook/growthbook";
import {
evalDeterministicPrereqValue,
evaluatePrerequisiteState,
isDefined,
PrerequisiteStateResult,
validateCondition,
validateFeatureValue,
Expand Down Expand Up @@ -192,7 +192,7 @@ export function generateAutoExperimentsPayload({
condition,
};
})
.filter(Boolean) as ParentConditionInterface[];
.filter(isDefined);

if (!phase) return null;

Expand Down Expand Up @@ -774,7 +774,7 @@ export function evaluateFeature({
const rulesWithPrereqs: FeatureDefinitionRule[] = [];
if (scrubPrerequisites) {
definition.rules = definition.rules
? (definition?.rules
? definition?.rules
?.map((rule) => {
if (rule?.parentConditions?.length) {
rulesWithPrereqs.push(rule);
Expand All @@ -790,7 +790,7 @@ export function evaluateFeature({
}
return rule;
})
.filter(Boolean) as FeatureDefinitionRule[])
.filter(isDefined)
: undefined;
}

Expand Down
3 changes: 2 additions & 1 deletion packages/back-end/src/services/reports.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
isBinomialMetric,
ExperimentMetricInterface,
} from "shared/experiments";
import { isDefined } from "shared/util";
import {
ExperimentReportArgs,
ExperimentReportVariation,
Expand Down Expand Up @@ -147,7 +148,7 @@ export function getSnapshotSettingsFromReportArgs(
args.metricOverrides
)
)
.filter(Boolean) as MetricForSnapshot[],
.filter(isDefined),
activationMetric: args.activationMetric || null,
attributionModel: args.attributionModel || "firstExposure",
datasourceId: args.datasource,
Expand Down
7 changes: 3 additions & 4 deletions packages/back-end/src/util/features.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import isEqual from "lodash/isEqual";
import {
ConditionInterface,
ParentConditionInterface,
FeatureRule as FeatureDefinitionRule,
} from "@growthbook/growthbook";
import { includeExperimentInPayload } from "shared/util";
import { includeExperimentInPayload, isDefined } from "shared/util";
import {
FeatureInterface,
FeatureRule,
Expand Down Expand Up @@ -354,7 +353,7 @@ export function getFeatureDefinition({
],
};
})
.filter(Boolean) as FeatureDefinitionRule[];
.filter(isDefined);

const isRule = (
rule: FeatureDefinitionRule | null
Expand Down Expand Up @@ -477,7 +476,7 @@ export function getFeatureDefinition({
condition,
};
})
.filter(Boolean) as ParentConditionInterface[];
.filter(isDefined);
if (prerequisites?.length) {
rule.parentConditions = prerequisites;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
StatsEngine,
} from "back-end/types/stats";
import { ExperimentMetricInterface } from "shared/experiments";
import { isDefined } from "shared/util";
import { useDefinitions } from "@/services/DefinitionsContext";
import {
applyMetricOverrides,
Expand Down Expand Up @@ -112,7 +113,7 @@ const BreakDownResults: FC<{

const metricDefs = [...metrics, ...(guardrails || [])]
.map((metricId) => getExperimentMetricById(metricId))
.filter(Boolean) as ExperimentMetricInterface[];
.filter(isDefined);
const sortedFilteredMetrics = sortAndFilterMetricsByTags(
metricDefs,
metricFilter
Expand Down
9 changes: 5 additions & 4 deletions packages/front-end/components/Experiment/CompactResults.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import Link from "next/link";
import { FaAngleRight, FaTimes, FaUsers } from "react-icons/fa";
import Collapsible from "react-collapsible";
import { ExperimentMetricInterface, getMetricLink } from "shared/experiments";
import { isDefined } from "shared/util";
import { useDefinitions } from "@/services/DefinitionsContext";
import {
applyMetricOverrides,
Expand Down Expand Up @@ -168,26 +169,26 @@ const CompactResults: FC<{

const metricDefs = metrics
.map((metricId) => getExperimentMetricById(metricId))
.filter(Boolean) as ExperimentMetricInterface[];
.filter(isDefined);
const sortedFilteredMetrics = sortAndFilterMetricsByTags(
metricDefs,
metricFilter
);

const guardrailDefs = guardrails
.map((metricId) => getExperimentMetricById(metricId))
.filter(Boolean) as ExperimentMetricInterface[];
.filter(isDefined);
const sortedFilteredGuardrails = sortAndFilterMetricsByTags(
guardrailDefs,
metricFilter
);

const retMetrics = sortedFilteredMetrics
.map((metricId) => getRow(metricId, false))
.filter((row) => row?.metric) as ExperimentTableRow[];
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked the type definition for what row could be (other than undefined) and it looks like row.metric is always present, so the definition check is just on row itself, hence isDefined should be a drop-in replacement

.filter(isDefined);
const retGuardrails = sortedFilteredGuardrails
.map((metricId) => getRow(metricId, true))
.filter((row) => row?.metric) as ExperimentTableRow[];
.filter(isDefined);
return [...retMetrics, ...retGuardrails];
}, [
results,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ import { VisualChangesetInterface } from "back-end/types/visual-changeset";
import { SDKConnectionInterface } from "back-end/types/sdk-connection";
import Link from "next/link";
import { useRouter } from "next/router";
import { MetricInterface } from "back-end/types/metric";
import { DifferenceType } from "back-end/types/stats";
import { getAllMetricSettingsForSnapshot } from "shared/experiments";
import { isDefined } from "shared/util";
import { useDefinitions } from "@/services/DefinitionsContext";
import { useUser } from "@/services/UserContext";
import useOrgSettings from "@/hooks/useOrgSettings";
Expand Down Expand Up @@ -120,7 +120,7 @@ export default function ResultsTab({
);
const denominatorMetrics = denominatorMetricIds
.map((m) => getMetricById(m as string))
.filter(Boolean) as MetricInterface[];
.filter(isDefined);

const orgSettings = useOrgSettings();

Expand Down
6 changes: 3 additions & 3 deletions packages/front-end/components/Experiment/TabbedPage/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {
} from "back-end/types/experiment";
import { IdeaInterface } from "back-end/types/idea";
import { VisualChangesetInterface } from "back-end/types/visual-changeset";
import { includeExperimentInPayload } from "shared/util";
import { includeExperimentInPayload, isDefined } from "shared/util";
import { useCallback, useEffect, useState } from "react";
import { FaChartBar } from "react-icons/fa";
import clsx from "clsx";
Expand Down Expand Up @@ -178,8 +178,8 @@ export default function TabbedPage({
// Get name or email of all active users watching this experiment
const usersWatching = (watcherIds?.data?.userIds || [])
.map((id) => users.get(id))
.filter(Boolean)
.map((u) => u?.name || u?.email);
.filter(isDefined)
.map((u) => u.name || u.email);

const safeToEdit = experiment.status !== "running" || !hasLiveLinkedChanges;

Expand Down
3 changes: 2 additions & 1 deletion packages/front-end/components/Features/ConditionDisplay.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
SavedGroupTargeting,
} from "back-end/types/feature";
import Link from "next/link";
import { isDefined } from "shared/util";
import { useDefinitions } from "@/services/DefinitionsContext";
import { Condition, jsonToConds, useAttributeMap } from "@/services/features";
import Tooltip from "@/components/Tooltip/Tooltip";
Expand Down Expand Up @@ -315,7 +316,7 @@ export default function ConditionDisplay({
});
return cond;
})
.filter(Boolean) as ConditionWithParentId[][];
.filter(isDefined);

const prereqConds =
prereqConditionsGrouped.reduce(
Expand Down
5 changes: 2 additions & 3 deletions packages/front-end/components/Forms/MultiSelectField.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import {
} from "react-sortable-hoc";
import { arrayMove } from "@dnd-kit/sortable";
import CreatableSelect from "react-select/creatable";
import { isDefined } from "shared/util";
import {
GroupedValue,
ReactSelectProps,
Expand Down Expand Up @@ -112,7 +113,7 @@ const MultiSelectField: FC<
...otherProps
}) => {
const [map, sorted] = useSelectOptions(options, initialOption, sort);
const selected = value.map((v) => map.get(v)).filter(Boolean);
const selected = value.map((v) => map.get(v)).filter(isDefined);

// eslint-disable-next-line
const fieldProps = otherProps as any;
Expand All @@ -122,7 +123,6 @@ const MultiSelectField: FC<
const onSortEnd: SortEndHandler = ({ oldIndex, newIndex }) => {
onChange(
arrayMove(
// @ts-expect-error TS(2532) If you come across this, please fix it!: Object is possibly 'undefined'.
selected.map((v) => v.value),
oldIndex,
newIndex
Expand Down Expand Up @@ -164,7 +164,6 @@ const MultiSelectField: FC<
}}
closeMenuOnSelect={closeMenuOnSelect}
autoFocus={autoFocus}
// @ts-expect-error TS(2322) If you come across this, please fix it!: Type '(SingleValue | undefined)[]' is not assignab... Remove this comment to see the full error message
value={selected}
placeholder={initialOption ?? placeholder}
{...{ ...ReactSelectProps, ...mergeStyles }}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,9 @@ export default function GuidedGetStarted({
learnMoreLink: "Learn more about our SDKs.",
docSection: "sdks",
completed:
// @ts-expect-error TS(2532) If you come across this, please fix it!: Object is possibly 'undefined'.
SDKData?.connections.length > 0 || skippedSteps["install-sdk"] || false,
(SDKData?.connections?.length || 0) > 0 ||
skippedSteps["install-sdk"] ||
false,
render: (
<InitialSDKConnectionForm
inline={true}
Expand Down
14 changes: 5 additions & 9 deletions packages/front-end/components/Ideas/ImpactModal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import Field from "@/components/Forms/Field";
import SelectField from "@/components/Forms/SelectField";

const ImpactModal: FC<{
idea?: IdeaInterface;
idea: IdeaInterface;
estimate?: ImpactEstimateInterface;
close: () => void;
mutate: () => void;
Expand All @@ -23,12 +23,9 @@ const ImpactModal: FC<{
defaultValues: {
metric: estimate?.metric || metrics[0]?.id || "",
segment: estimate?.segment || "",
// @ts-expect-error TS(2532) If you come across this, please fix it!: Object is possibly 'undefined'.
userAdjustment: idea.estimateParams?.userAdjustment || 100,
// @ts-expect-error TS(2532) If you come across this, please fix it!: Object is possibly 'undefined'.
numVariations: idea.estimateParams?.numVariations || 2,
// @ts-expect-error TS(2532) If you come across this, please fix it!: Object is possibly 'undefined'.
improvement: idea.estimateParams?.improvement || 10,
userAdjustment: idea.estimateParams.userAdjustment || 100,
numVariations: idea.estimateParams.numVariations || 2,
improvement: idea.estimateParams.improvement || 10,
},
});

Expand Down Expand Up @@ -61,7 +58,7 @@ const ImpactModal: FC<{
body: JSON.stringify({
metric: value.metric,
segment: value.segment || null,
ideaId: idea?.id || null,
ideaId: idea.id || null,
}),
}
);
Expand Down Expand Up @@ -100,7 +97,6 @@ const ImpactModal: FC<{
},
};

// @ts-expect-error TS(2532) If you come across this, please fix it!: Object is possibly 'undefined'.
await apiCall(`/idea/${idea.id}`, {
method: "POST",
body: JSON.stringify(data),
Expand Down
3 changes: 2 additions & 1 deletion packages/front-end/components/Report/ConfigureReport.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import { getScopedSettings } from "shared/settings";
import { MetricInterface } from "back-end/types/metric";
import { DifferenceType } from "@back-end/types/stats";
import { getMetricSnapshotSettings } from "shared/experiments";
import { isDefined } from "shared/util";
import { useAuth } from "@/services/auth";
import { useDefinitions } from "@/services/DefinitionsContext";
import { getExposureQuery } from "@/services/datasources";
Expand Down Expand Up @@ -96,7 +97,7 @@ export default function ConfigureReport({
const denominatorMetrics: MetricInterface[] = useMemo(() => {
return denominatorMetricIds
.map((m) => getMetricById(m as string))
.filter(Boolean) as MetricInterface[];
.filter(isDefined);
}, [denominatorMetricIds, getMetricById]);

// todo: type this form
Expand Down
3 changes: 1 addition & 2 deletions packages/front-end/components/Segments/SegmentForm.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,7 @@ const SegmentForm: FC<{
}))}
className="portal-overflow-ellipsis"
/>
{/* @ts-expect-error TS(2532) If you come across this, please fix it!: Object is possibly 'undefined'. */}
{datasource?.properties.userIds && (
{datasource?.properties?.userIds && (
<SelectField
label="Identifier Type"
required
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,8 @@ export const AddEditIdentityJoinModal: FC<AddEditIdentityJoinModalProps> = ({
dataSource.settings.userIdTypes,
]);
const existingIdentityJoins = useMemo(
// @ts-expect-error TS(2532) If you come across this, please fix it!: Object is possibly 'undefined'.
() => dataSource.settings.queries.identityJoins || [],
// @ts-expect-error TS(2532) If you come across this, please fix it!: Object is possibly 'undefined'.
[dataSource.settings.queries.identityJoins]
() => dataSource.settings.queries?.identityJoins || [],
[dataSource.settings.queries?.identityJoins]
);

const defaultQuery = useMemo(() => {
Expand Down
Loading
Loading