Skip to content

Yearly companion updates #502

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
merged 4 commits into from
Jul 28, 2025
Merged

Yearly companion updates #502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6429494
use current date as default scope
gqcorneby Jul 4, 2025
5df35ac
only show required year and add group by type
gqcorneby Jul 10, 2025
d84140d
clean up unused references
gqcorneby Jul 16, 2025
d71c5b5
update summary page
gqcorneby Jul 16, 2025
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
20 changes: 8 additions & 12 deletions src/webapp/components/dataset-wizard/IndicatorsDataSet.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ export const IndicatorsDataSet = React.memo((props: IndicatorsDataSetProps) => {
const [hasCompanionTable, hasCompanionTableActions] = useBooleanState(false);
const [search, setSearch] = React.useState<string>("");

const { selectedCompanionScope, updateCompanionFilter, companionScopes, hasCompanionScopes } =
const { selectedCompanionScope, updateCompanionFilter, companionScopes } =
useCompanionIndicatorFilter(dataSet);

const companionIndicators = useGetCompanionIndicators({
Expand Down Expand Up @@ -133,7 +133,6 @@ export const IndicatorsDataSet = React.memo((props: IndicatorsDataSetProps) => {
const columns = useIndicatorsTableColumns({
showCompanionColumn: hasCompanionTable,
statusIndicator: indicator => <StatusIndicator status={indicator.status} />,
hasCompanionScopes,
});

const openFilters = React.useCallback(() => setShowFilterModal(true), []);
Expand Down Expand Up @@ -225,7 +224,7 @@ export const IndicatorsDataSet = React.memo((props: IndicatorsDataSetProps) => {
<FilterIndicatorsContainer
showCloseButton={!isLargeDesktop}
onClose={() => setShowFilterModal(false)}
hideFilter={hasCompanionTable && !hasCompanionScopes}
hideFilter={hasCompanionTable}
>
<FilterIndicators
measures={allMeasures}
Expand Down Expand Up @@ -253,7 +252,7 @@ export const IndicatorsDataSet = React.memo((props: IndicatorsDataSetProps) => {
onFilterChange={updateCompanionFilter}
scopes={companionScopes}
scopeValue={selectedCompanionScope}
hidden={!hasCompanionTable || !hasCompanionScopes}
hidden={!hasCompanionTable}
/>
</FilterIndicatorsContainer>
</>
Expand Down Expand Up @@ -583,13 +582,11 @@ function useCompanionIndicatorFilter(dataSet: DataSet) {
const companionScopes = dataSet.indicators.flatMap(indicator =>
indicator.getCompanionScopes()
);
return companionScopes.length > 1
? _(companionScopes)
.uniq()
.sort()
.map(scope => ({ text: scope, value: scope }))
.value()
: [];
return _(companionScopes)
.uniq()
.sort()
.map(scope => ({ text: scope, value: scope }))
.value();
}, [dataSet]);

const updateCompanionFilter = React.useCallback((value: ChipItem[]) => {
Expand All @@ -601,7 +598,6 @@ function useCompanionIndicatorFilter(dataSet: DataSet) {
companionScopes,
selectedCompanionScope,
updateCompanionFilter,
hasCompanionScopes: !!companionScopes.length,
};
}

Expand Down
128 changes: 58 additions & 70 deletions src/webapp/components/dataset-wizard/SummaryDataSet.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import React from "react";
import { Grid, Typography } from "@material-ui/core";
import capitalize from "lodash/capitalize";

import { DataSet } from "$/domain/entities/DataSet";
import i18n from "$/utils/i18n";
Expand Down Expand Up @@ -51,8 +52,11 @@ export const SummaryList = React.memo((props: { dataSet: DataSet }) => {

const regionsCodes = dataSet.getRegionCodesFromAccess();
const selectedRegions = config.regions.filter(region => regionsCodes.includes(region.code));
const requiredScope = Indicator.buildCompanionScope(
dataSet.project?.startDate ? new Date(dataSet.project.startDate) : undefined
);

const { missingSelectedCompanion } = useGetMissingSelectedCompanion({ dataSet });
const { missingSelectedCompanion } = useGetMissingSelectedCompanion({ dataSet, requiredScope });

return (
<Grid item xs={12}>
Expand All @@ -75,7 +79,7 @@ export const SummaryList = React.memo((props: { dataSet: DataSet }) => {
<SummaryItem label={i18n.t("Companion Indicators")} value="" />
<MissingCompanionAlert
indicator={missingSelectedCompanion}
scopeDate={dataSet.project?.startDate}
requiredScope={requiredScope}
/>
</>
)}
Expand All @@ -85,58 +89,45 @@ export const SummaryList = React.memo((props: { dataSet: DataSet }) => {
});

const MissingCompanionAlert = React.memo(
(props: { indicator: MissingCompanionIndicator; scopeDate: Maybe<string> }) => {
const { indicator, scopeDate } = props;
(props: { indicator: MissingCompanionIndicator; requiredScope: string }) => {
const { indicator, requiredScope } = props;

const requiredScope = Indicator.buildCompanionScope(
scopeDate ? new Date(scopeDate) : undefined
);
const companionIndicatorTypes = indicator.keys();

const scopes = indicator.keys();

const scopeText = React.useCallback(
(scope: string) => {
return scope === requiredScope && scope !== "default" ? (
<strong>
<span>{scope}</span> ({i18n.t("The companion rules for this year need to be satisfied")}):
</strong>
) : (
<span>{scope}</span>
);
},
[requiredScope]
);
const allAllValid = indicator
.values()
.every(item => item.every(validation => validation.isValid));

if (scopes.length === 1) {
const validationMessages = indicator.get(scopes[0] || "");
if (allAllValid) {
return (
validationMessages && (
<MissingCompanionAlertContainer>
{validationMessages?.map((validationMessage, index) => (
<SummaryItem
label={validationMessage.code}
value={validationMessage.message}
key={index}
/>
))}
</MissingCompanionAlertContainer>
)
<MissingCompanionAlertContainer>
<strong>{i18n.t("All companions are satisfied")}</strong>
</MissingCompanionAlertContainer>
);
}

return (
<MissingCompanionAlertContainer>
{scopes.map(scope => (
<strong>
<span>
{requiredScope} ({i18n.t("These companion rules need to be satisfied")})
</span>
</strong>
{companionIndicatorTypes.map(type => (
<>
{scopeText(scope)}
<ul key={scope}>
{indicator.get(scope)?.map((validationMessage, index) => (
<SummaryItem
label={validationMessage.code}
value={validationMessage.message}
key={index}
/>
))}
<ul>
<li>
<span>{capitalize(type)}:</span>
<ul key={type}>
{indicator.get(type)?.map((validationMessage, index) => (
<SummaryItem
label={validationMessage.code}
value={validationMessage.message}
key={index}
/>
))}
</ul>
</li>
</ul>
</>
))}
Expand All @@ -153,8 +144,8 @@ export const SummaryItem = React.memo((props: { label: string; value: string })
);
});

const useGetMissingSelectedCompanion = (props: { dataSet: DataSet }) => {
const { dataSet } = props;
const useGetMissingSelectedCompanion = (props: { dataSet: DataSet; requiredScope: string }) => {
const { dataSet, requiredScope } = props;

const indicatorByCodes = React.useMemo(
() =>
Expand All @@ -165,7 +156,7 @@ const useGetMissingSelectedCompanion = (props: { dataSet: DataSet }) => {
);

const missingSelectedCompanion: Maybe<MissingCompanionIndicator> = React.useMemo(() => {
const allIndicatorValidations = _(dataSet.indicators)
const scopeIndicatorValidations = _(dataSet.indicators)
.filter(indicator => indicator.getAllCompanionCodesFromRules().length > 0)
.map(indicator => {
const { outcomeRulesValid, outputRulesValid } =
Expand All @@ -188,22 +179,25 @@ const useGetMissingSelectedCompanion = (props: { dataSet: DataSet }) => {
}),
];
})
.flatten();
.flatten()
.filter(validation => validation.scope === requiredScope);

const areAllValid = allIndicatorValidations.every(validation => validation.isValid);
if (areAllValid) return undefined;

return allIndicatorValidations
.groupBy(validation => validation.scope)
return scopeIndicatorValidations
.groupBy(validation => validation.type)
.mapValues(([_scope, validations]) =>
validations.map(validation => ({
code: validation.code,
message: validation.message,
isValid: validation.isValid,
}))
);
}, [dataSet, indicatorByCodes]);
}, [dataSet, indicatorByCodes, requiredScope]);

return { missingSelectedCompanion };
if (missingSelectedCompanion.values().length > 0) {
return { missingSelectedCompanion };
} else {
return { missingSelectedCompanion: undefined };
}
};

function buildValidationItemsByType(props: {
Expand All @@ -219,35 +213,29 @@ function buildValidationItemsByType(props: {
scope,
type: type,
isValid,
message: buildValidationMessages(isValid, companionRulesMessage.get(scope), "outcomes"),
message: buildValidationMessages(isValid, companionRulesMessage.get(scope)),
})
);
}

function buildValidationMessages(
isValid: boolean,
message: Maybe<string>,
type: "outcomes" | "outputs"
) {
const prefix =
type === "outcomes"
? i18n.t("Outcome companion rule not satisfied")
: i18n.t("Output companion rule not satisfied");
const allRulesSatisfied = i18n.t("All rules satisfied");
return isValid ? allRulesSatisfied : `${prefix}: ${message}`;
function buildValidationMessages(isValid: boolean, message: Maybe<string>) {
const allRulesSatisfied = i18n.t("All rules are satisfied");
return isValid ? allRulesSatisfied : `${i18n.t("Rules not satisfied")}: ${message}`;
}

type CompanionRuleType = "outcomes" | "outputs";

type ValidationItem = {
code: string;
scope: IndicatorCompanionScope;
type: "outcomes" | "outputs";
type: CompanionRuleType;
isValid: boolean;
message: string;
};

type ValidationMessage = Pick<ValidationItem, "code" | "message">;
type ValidationMessage = Pick<ValidationItem, "code" | "message" | "isValid">;

type MissingCompanionIndicator = HashMap<IndicatorCompanionScope, Maybe<ValidationMessage[]>>;
type MissingCompanionIndicator = HashMap<CompanionRuleType, ValidationMessage[]>;

const MissingCompanionAlertContainer = styled("div")`
padding-inline: 1rem;
Expand Down
7 changes: 3 additions & 4 deletions src/webapp/hooks/useIndicators.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,8 @@ export function useGetCompanionIndicators(props: {
export function useIndicatorsTableColumns(props: {
showCompanionColumn: boolean;
statusIndicator: (indicator: Indicator) => React.ReactNode;
hasCompanionScopes: boolean;
}): IndicatorColumns {
const { showCompanionColumn, statusIndicator, hasCompanionScopes } = props;
const { showCompanionColumn, statusIndicator } = props;
return React.useMemo(() => {
return [
{
Expand All @@ -93,7 +92,7 @@ export function useIndicatorsTableColumns(props: {
{
name: "suggestedScope",
text: i18n.t("Suggested year(s)"),
hidden: !showCompanionColumn || !hasCompanionScopes,
hidden: !showCompanionColumn,
},
{
name: "theme",
Expand All @@ -113,7 +112,7 @@ export function useIndicatorsTableColumns(props: {
text: i18n.t("Disaggregation"),
},
];
}, [showCompanionColumn, statusIndicator, hasCompanionScopes]);
}, [showCompanionColumn, statusIndicator]);
}

export type IndicatorColumns = ObjectsTableProps<IndicatorColumn>["columns"];
Expand Down
Loading