mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-10-27 20:44:07 +00:00
(core) Fix missing sum column after a summary table update
Summary: Description of the problem can be found here: https://grist.slack.com/archives/C069RUP71/p1634899282005600 - users removing a group by column that is of type numeric was resulting in the column missing from the summary table. Where instead is should be present as a 'SUM($group.${col.colId})' formula column - this diff fixes that issue and adds unit test Test Plan: Should not break anything. Adds not test case. Reviewers: alexmojaki Reviewed By: alexmojaki Subscribers: alexmojaki Differential Revision: https://phab.getgrist.com/D3351
This commit is contained in:
parent
251d79704b
commit
a6ba40558a
@ -20,6 +20,11 @@ def _make_col_info(col=None, **values):
|
||||
values.setdefault(key, getattr(col, key) if col else None)
|
||||
return ColInfo(**values)
|
||||
|
||||
def _make_sum_col_info(col):
|
||||
"""Return a ColInfo() for the sum formula column for column col."""
|
||||
return _make_col_info(col=col, isFormula=True,
|
||||
formula='SUM($group.%s)' % col.colId)
|
||||
|
||||
|
||||
def _get_colinfo_dict(col_info, with_id=False):
|
||||
"""Return a dict suitable to use with AddColumn or AddTable (when with_id=True) actions."""
|
||||
@ -195,14 +200,18 @@ class SummaryActions(object):
|
||||
prev_fields = list(view_section.fields)
|
||||
|
||||
# Go through fields figuring out which ones we'll keep.
|
||||
prev_group_fields, formula_fields, delete_fields = [], [], []
|
||||
prev_group_fields, formula_fields, delete_fields, missing_colinfo = [], [], [], []
|
||||
for field in prev_fields:
|
||||
srcCol = field.colRef.summarySourceCol
|
||||
# Records implement __hash__, so we can look them up in sets.
|
||||
if field.colRef.summarySourceCol in source_groupby_colset:
|
||||
if srcCol in source_groupby_colset:
|
||||
prev_group_fields.append(field)
|
||||
elif field.colRef.isFormula and field.colRef.colId not in groupby_colids:
|
||||
formula_fields.append(field)
|
||||
else:
|
||||
# if user is removing a numeric column from the group by columns we must add it back as a
|
||||
# sum formula column
|
||||
self._append_sister_column_if_any(missing_colinfo, source_table, srcCol)
|
||||
delete_fields.append(field)
|
||||
|
||||
# Prepare ColInfo for all columns we want to keep.
|
||||
@ -233,6 +242,14 @@ class SummaryActions(object):
|
||||
# Delete fields no longer relevant.
|
||||
self.docmodel.remove(delete_fields)
|
||||
|
||||
# Add missing sum column
|
||||
for ci in missing_colinfo:
|
||||
col = self.useractions.AddColumn(summary_table.tableId, ci.colId,
|
||||
_get_colinfo_dict(ci, with_id=False))
|
||||
# AddColumn user action did not add the fields as the view section was not yet updated with
|
||||
# new table, hence adds it manually
|
||||
self.docmodel.add(view_section.fields, colRef=[col['colRef']])
|
||||
|
||||
# Update fields for all formula fields and reused group-by fields to point to new columns.
|
||||
source_col_map = dict(zip(source_groupby_columns, groupby_columns))
|
||||
prev_group_columns = [source_col_map[f.colRef.summarySourceCol] for f in prev_group_fields]
|
||||
@ -274,6 +291,17 @@ class SummaryActions(object):
|
||||
return c
|
||||
return None
|
||||
|
||||
def _append_sister_column_if_any(self, all_colinfo, source_table, col):
|
||||
"""
|
||||
Appends a col info for one sister column of col (in source_table) if it finds one, else, and if
|
||||
col is of numeric type appends the col info for the sum col, else do nothing.
|
||||
"""
|
||||
c = self._find_sister_column(source_table, col.colId)
|
||||
if c:
|
||||
all_colinfo.append(_make_col_info(col=c))
|
||||
elif col.type in ('Int', 'Numeric'):
|
||||
all_colinfo.append(_make_sum_col_info(col))
|
||||
|
||||
|
||||
def _create_summary_colinfo(self, source_table, source_groupby_columns):
|
||||
"""Come up automatically with a list of columns to include into a summary table."""
|
||||
@ -287,12 +315,7 @@ class SummaryActions(object):
|
||||
for col in source_table.columns:
|
||||
if col.colId in groupby_col_ids or col.colId == 'group' or not is_visible_column(col.colId):
|
||||
continue
|
||||
c = self._find_sister_column(source_table, col.colId)
|
||||
if c:
|
||||
all_colinfo.append(_make_col_info(col=c))
|
||||
elif col.type in ('Int', 'Numeric'):
|
||||
all_colinfo.append(_make_col_info(col=col, isFormula=True,
|
||||
formula='SUM($group.%s)' % col.colId))
|
||||
self._append_sister_column_if_any(all_colinfo, source_table, col)
|
||||
|
||||
# Add a default 'count' column for the number of records in the group, unless a different
|
||||
# 'count' was already added (which we would then prefer as presumably more useful). We add the
|
||||
|
@ -664,6 +664,48 @@ class TestSummary2(test_engine.EngineTestCase):
|
||||
])])
|
||||
self.assertEqual(get_helper_cols('Address'), ['#summary#GristSummary_7_Address'])
|
||||
|
||||
# Change the section to add and then remove the "amount" to the group-by column; check that
|
||||
# column "amount" was correctly restored
|
||||
self.apply_user_action(["UpdateSummaryViewSection", 1, [11, 12, 13]])
|
||||
self.assertTables([
|
||||
self.starting_table,
|
||||
Table(7, "GristSummary_7_Address2", 0, 1, columns=[
|
||||
Column(35, "city", "Text", False, "", 11),
|
||||
Column(36, "state", "Text", False, "", 12),
|
||||
Column(37, "amount", "Numeric", False, "", 13),
|
||||
Column(38, "count", "Int", True, "len($group)", 0),
|
||||
Column(39, "group", "RefList:Address", True, "table.getSummarySourceGroup(rec)", 0),
|
||||
]),
|
||||
])
|
||||
self.assertViews([View(1, sections=[
|
||||
Section(1, parentKey="record", tableRef=7, fields=[
|
||||
Field(6, colRef=35),
|
||||
Field(5, colRef=36),
|
||||
Field(7, colRef=37),
|
||||
Field(3, colRef=38),
|
||||
])
|
||||
])])
|
||||
self.apply_user_action(["UpdateSummaryViewSection", 1, [11,12]])
|
||||
self.assertTables([
|
||||
self.starting_table,
|
||||
Table(8, "GristSummary_7_Address", 0, 1, columns=[
|
||||
Column(40, "city", "Text", False, "", 11),
|
||||
Column(41, "state", "Text", False, "", 12),
|
||||
Column(42, "count", "Int", True, "len($group)", 0),
|
||||
Column(43, "group", "RefList:Address", True, "table.getSummarySourceGroup(rec)", 0),
|
||||
Column(44, "amount", "Numeric", True, "SUM($group.amount)", 0),
|
||||
|
||||
]),
|
||||
])
|
||||
self.assertViews([View(1, sections=[
|
||||
Section(1, parentKey="record", tableRef=8, fields=[
|
||||
Field(6, colRef=40),
|
||||
Field(5, colRef=41),
|
||||
Field(3, colRef=42),
|
||||
Field(7, colRef=44),
|
||||
])
|
||||
])])
|
||||
|
||||
# Delete source table, and ensure its summary table is also gone.
|
||||
self.apply_user_action(["RemoveTable", "Address"])
|
||||
self.assertTables([])
|
||||
|
Loading…
Reference in New Issue
Block a user