Skip to content

[NoQA] [Insights] Draw Average mode baseline on Spend over time - #103989

Merged
luacmartins merged 17 commits into
Expensify:mainfrom
software-mansion-labs:insights/average-baseline
Oct 16, 2026
Merged

luacmartins merged 17 commits into
Expensify:mainfrom
software-mansion-labs:insights/average-baseline

Conversation

@mhawryluk

@mhawryluk mhawryluk commented Oct 14, 2026 •

Copy link
Copy Markdown
Member

Explanation of Change

Adds the Average compare mode to the Spend over time chart, behind the insightsCompare beta. When Compare is set to Average, the chart draws the backend-sent average as a second line on the chart. The tooltip shows both amounts and how far the hovered bucket is above or below the average.

  • useInsightsChartData reads the chart's own snapshot and the one stored under averageSnapshotHash. If the average snapshot is loading, failed or offline, the chart shows that state instead of drawing one line and adding the second later.
  • buildChartSeries takes an optional comparison and pairs each compared row with the plotted group that has the same keyForList
  • LineChartContent draws one line per series. The area gradient and the dashed in-progress segment stay on the primary line only.
  • Hovering shows a dot on each line. The tooltip sits above the highest line, so it doesn't cover the other one.
  • The compared line uses the 200 shade of the primary color's hue, or the 700 shade in dark mode, through the new VictoryTheme.colors.getComparisonColor.
  • ChartTooltip now takes its body as children. ChartTooltipSummary keeps the existing amount, share and expense count. ChartTooltipComparison shows a row for each series with a colored dot, then the change with an arrow: red for an increase, green for a decrease. The comparison text is built by formatTooltipComparison.

Fixed Issues

$ #103767
PROPOSAL: N/A

Tests

  1. Enable the insightsPage and insightsCompare beta.
  2. Go to Insights. With Compare off, check that Spend over time draws one green line and the tooltip shows the amount, share and expense count, same as before.
  3. Set Compare to Average. Check that a second, lighter horizontal green line appears from the first point to the last.
  4. Hover a point. Check that there's a dot on both lines, the tooltip sits above both lines, the tooltip lists the bucket's amount with its share, then "Average:" with the average amount and a change line shows the difference and percentage, with a red up arrow when the bucket is above the average and a green down arrow when it's below.
  5. Hover the in-progress bucket. Check that its dot is hollow and only the main line is dashed into it.
  6. Switch to dark mode. Check that the Average line uses a darker green.
  7. Set Compare to Previous period. Check that the Average line disappears.
  8. Change Group by, Date range or Workspace while on Average. Check that the chart shows loading, then both lines again.
  9. Check that the bar and pie charts on the page are unchanged with Compare set to Average.

Offline tests

  1. With Compare set to Average and both lines drawn, go offline. Check that the chart keeps showing both lines and the tooltip still works.
  2. While offline, change Date range so neither snapshot is cached. Check that the chart shows the offline state.
  3. Go back online. Check that the chart loads and draws both lines.
  4. Go online. Clear cache and restart. Go to Home and load Spend over time. Go offline. Go to Insights, select Compare:Average. Verify Spend over time shows an offline state.

QA Steps

No tests.

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I verified any copy / text that was added to the app is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If the PR adds or modifies the UI:
    • I asked an AI agent to review the changes for accessibility issues and addressed its findings.
    • I tested with a screen reader (VoiceOver on macOS) and verified all new/changed elements are reachable with a logical focus order.
    • I verified all new/changed elements have meaningful accessible names and roles.
    • I verified state changes are announced (e.g. checked/unchecked, expanded/collapsed, selected).
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
Nagranie.z.ekranu.2026-10-14.o.15.29.24.mov

@codecov

codecov Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
src/components/Charts/VictoryTheme.ts 100.00% <100.00%> (ø)
...rc/components/Charts/hooks/useChartInteractions.ts 47.51% <ø> (ø)
src/components/Charts/utils/getPrimaryValue.ts 100.00% <100.00%> (ø)
...er/components/VictoryChartCartesianInteractive.tsx 5.88% <ø> (ø)
src/components/Search/SearchChartView.tsx 83.33% <100.00%> (+0.83%) ⬆️
src/components/Search/buildChartSeries.ts 100.00% <100.00%> (ø)
src/pages/Insights/InsightsDashboard.tsx 82.35% <100.00%> (+0.42%) ⬆️
src/pages/Insights/charts/InsightsChartWidget.tsx 95.65% <100.00%> (-0.35%) ⬇️
src/pages/Insights/insightsQueries.ts 93.02% <100.00%> (+0.16%) ⬆️
src/pages/Insights/resolveDashboardState.ts 100.00% <ø> (ø)
... and 15 more
... and 16 files with indirect coverage changes

@dannymcclain

Copy link
Copy Markdown
Contributor

Mentioned in Expensify, but let's reduce the size of these compare dots inside the tooltip:
CleanShot 2026-10-14 at 8 45 17 AM@2x

Not sure what they are right now, but let's make them 8x8px
CleanShot 2026-10-14 at 8 46 14 AM@2x

(The arrow icon for the change should also be 8x8px)

@mhawryluk

Copy link
Copy Markdown
Member Author

@MelvinBot review

@MelvinBot

Copy link
Copy Markdown
Contributor

I found no blocking issues. The series wiring, snapshot hash, loading and offline gating, and the dashed in-progress segment all look correct. Two small fixes and one product question:

  1. A bucket with no average gets a stripped-down tooltip. formatTooltipComparison.ts:65-86 returns a comparison whenever 2 series exist, even when the bucket has no compared value. This happens when the average snapshot is EMPTY, because useInsightsChartData.ts:66 doesn't block on EMPTY. It also happens when a keyForList has no match. The tooltip then shows one unlabeled dot row and drops the expense count. Fix: return undefined when the compared value is missing, so ChartTooltipLayer falls back to ChartTooltipSummary.
  2. Nit: the colon is hardcoded. ChartTooltipComparison.tsx:41 builds ${label}: ${amount} in code. French puts a space before the colon (“Moyenne : …”). Consider a translation key that takes the amount as a parameter.
  3. Question: should the in-progress bucket show a change? That bucket holds only part of a period, so it will almost always show a green “below average” arrow. You could hide the change line for that point.

@mhawryluk

Copy link
Copy Markdown
Member Author
  1. A bucket with no average gets a stripped-down tooltip.

okay, changed

  1. Nit: the colon is hardcoded.

it's like that in multiple places in the app and the French translations don't even put the space before the colon, so I'm not sure about this

  1. Question: should the in-progress bucket show a change? That bucket holds only part of a period, so it will almost always show a green “below average” arrow. You could hide the change line for that point.

good question, I'll ask

@mhawryluk
mhawryluk marked this pull request as ready for review October 14, 2026 15:03
@mhawryluk
mhawryluk requested review from a team as code owners October 14, 2026 15:03
@melvin-bot
melvin-bot Bot requested review from JmillsExpensify and truph01 and removed request for a team October 14, 2026 15:03
@melvin-bot

melvin-bot Bot commented Oct 14, 2026

Copy link
Copy Markdown

@truph01 Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@melvin-bot
melvin-bot Bot removed the request for review from a team October 14, 2026 15:03
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-14T15:22:00.980627Z a20e5cd Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@mhawryluk

Copy link
Copy Markdown
Member Author

Mentioned in Expensify, but let's reduce the size of these compare dots inside the tooltip:
Not sure what they are right now, but let's make them 8x8px
(The arrow icon for the change should also be 8x8px)

done!

Zrzut ekranu 2026-10-14 o 17 02 50

@dannymcclain @JmillsExpensify I have a few questions about some design details:

what should we display for the last row in the tooltip showing the change when the amount and the average are equal? for now I made it so that we skip that row:

Zrzut ekranu 2026-10-14 o 17 05 29

and what about that last row for an in-progress bucket. should we skip it, so that we don't show a positive change which may be due to the bucket having just started?

Zrzut ekranu 2026-10-14 o 17 07 57

and what's the expected behavior for when we have data for the chart, but we don't have the average or previous-period snapshot (like when we only fetched it through Search and GetInsights hasn't arrived yet). I made it so that we show loading/offline/error instead of showing the chart without the second line, is that okay?

Nagranie.z.ekranu.2026-10-14.o.15.28.25.mov

@dannymcclain

Copy link
Copy Markdown
Contributor

what should we display for the last row in the tooltip showing the change when the amount and the average are equal? for now I made it so that we skip that row:

I think it makes sense to just display nothing like you're doing, since there's no change to call out.

and what about that last row for an in-progress bucket. should we skip it, so that we don't show a positive change which may be due to the bucket having just started?

I'm not sure we should skip this one, since it might make sense to want to see "how am I doing compared to the average so far". Since the label already includes "so far", I'm inclined to just show it exactly as you have it.

But if we feel like we need something extra to call out that this is in progress, maybe we could just also add "so far" to the change (i.e. ↑ $40 so far) but I'm not totally sure that's necessary.

and what's the expected behavior for when we have data for the chart, but we don't have the average or previous-period snapshot

Not sure about this one... It doesn't feel great to make the data we have disappear, but obviously we can't exactly do what the user is asking here. Curious for @JmillsExpensify's take on this (and the rest above too haha)

@dannymcclain

Copy link
Copy Markdown
Contributor

When the main line aligns exactly with the average line, the average line overlaps the main line. Is this expected? I think the main line should be displayed on top of the average line in this case.

Agree—nothing wrong with them being on top of each other in this case, but lets always keep the main line on top 👍

Copy link
Copy Markdown
Contributor

Second that.

@mhawryluk

Copy link
Copy Markdown
Member Author

Thanks! I changed the order of the series, so that the Average line sits below the main one.
And I addressed the review comments, @truph01 back to you!

@github-actions

Copy link
Copy Markdown
Contributor

🚧 JmillsExpensify has triggered a test Expensify/App build. You can view the workflow run here.

@github-actions

This comment has been minimized.

@JmillsExpensify JmillsExpensify left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Latest PR is looking really great. Product approved.

@JmillsExpensify

Copy link
Copy Markdown
Contributor

@truph01 let's prioritize this when you're back online. We need to get R2 released next week.

@truph01

truph01 commented Oct 16, 2026

Copy link
Copy Markdown
Contributor

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained """"why"""" the code was doing something instead of only explaining """"what"""" the code was doing.
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp
Screen.Recording.2026-10-16.at.18.32.21.mov
Android: mWeb Chrome
Screen.Recording.2026-10-16.at.18.34.15.mov
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari
Screen.Recording.2026-10-16.at.18.23.28.mov

@melvin-bot
melvin-bot Bot requested a review from luacmartins October 16, 2026 11:35
@luacmartins
luacmartins merged commit e14dd69 into Expensify:main Oct 16, 2026
42 of 50 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

🚧 luacmartins has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify

Copy link
Copy Markdown
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.5.14-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/grgia in version: 9.5.14-3 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

Bundle Size Analysis (Sentry):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants