Solves problems in "feat: Add Communication History PDF Report feature (#1978)" PR by magush27 · Pull Request #2080 · cboard-org/cboard

magush27 · 2025-12-11T23:04:42Z

Fixes in the communication history tracking functionality that was partially implemented in PR #1987. The original implementation only tracked symbol selections but was missing tracking for phrase spoken, clear action, and backspace events.

Issues Fixed
As noted in the #1987 (comment), the following tracking actions were not being called:

Phrase spoken events (when user plays output)
Clear action events (when user clears the output)
Backspace events (when user removes last symbol)

Additionally fixed:

PDF export font configuration error: File 'Roboto-Medium.ttf' not found in virtual file system

Testing

Navigate to a board and select multiple symbols
Click the play button to speak the phrase → Verify phrase is tracked in communication history
Click the clear button → Verify clear action is tracked
Select symbols and click backspace → Verify backspace action is tracked
Go to Settings → Communication History
Export PDF report → Verify PDF generates without font errors
Check that all event types appear in the report

Fixes #1987
Closes #1978

- Implement automatic tracking of symbol selections and phrases - Add PDF generation service with professional formatting - Create export dialog with date range and filtering options - Add Settings page for Communication History with statistics - Integrate with Redux store for persistent data storage - Include comprehensive test coverage - Add documentation and README This feature enables therapists and educators to: - Track AAC usage patterns over time - Generate professional PDF reports for documentation - Monitor communication progress with statistics - Export filtered reports by date range and user Closes cboard-org#1978

- Remove unused 'metadata' parameter in PDFReportService - Remove unused 'now' variable in ExportDialog - Remove unused 'trackBackspaceAction' import in test - Simplify PDF service test to remove unused 'testData'

… and backspace

…CommunicationHistory component and tests

…BoardContainer component

… formatting and improved readability

…borator

Copilot

Pull request overview

This pull request addresses missing tracking functionality in the Communication History feature (originally implemented in PR #1987) and fixes a PDF font configuration issue. The changes add tracking for phrase spoken events, clear actions, and backspace events that were previously not being captured.

Changes:

Integrates tracking actions (trackPhraseSpoken, trackClearAction, trackBackspaceAction) into the Output container to capture user interactions when playing output, clearing, or using backspace
Integrates trackSymbolSelection into the Board container to capture symbol tile clicks
Adds Communication History reducer to Redux store configuration
Creates new Settings page for Communication History with statistics display and PDF export functionality
Implements comprehensive PDF report generation service with proper font configuration using existing FONTS constant
Adds extensive test coverage for actions, reducer, and integration scenarios
Includes detailed documentation in README explaining feature usage and architecture

Reviewed changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
src/services/PDFReportService.js	New service for generating PDF reports with proper font configuration using FONTS constant from Export.constants
src/reducers.js	Registers communicationHistory reducer in Redux store
src/components/Settings/Settings.wrapper.js	Adds routing for Communication History settings page
src/components/Settings/Settings.messages.js	Adds i18n message key for Communication History menu item
src/components/Settings/Settings.component.js	Adds Communication History menu item with Assessment icon
src/components/Settings/CommunicationHistory/*	New Settings page components for displaying statistics and exporting reports
src/components/CommunicationHistory/*	Core communication history components including actions, constants, reducer, and export dialog
src/components/Board/Output/Output.container.js	Integrates tracking for phrase spoken, clear, and backspace actions
src/components/Board/Board.container.js	Integrates tracking for symbol selection with enhanced tile metadata

Copilot · 2026-02-20T00:15:02Z

src/components/CommunicationHistory/CommunicationHistory.actions.js

+      metadata: {
+        symbolCount: output.length,
+        hasImages: output.some((s) => s.image),
+      },


The trackPhraseSpoken function doesn't capture vocalization metadata. The metadata object should include a vocalization field that represents what was actually spoken (concatenated vocalization or label fields from symbols), similar to how trackSymbolSelection includes vocalization in its metadata. Consider adding: metadata.vocalization = output.map((s) => s.vocalization || s.label || '').join(' ').

Copilot · 2026-02-20T00:15:02Z

src/components/CommunicationHistory/CommunicationHistory.test.js

+import {
+  addCommunicationEntry,
+  trackSymbolSelection,
+  trackPhraseSpoken,
+  trackClearAction,
+} from './CommunicationHistory.actions';


The test file imports trackBackspaceAction in the integration test at line 173 but doesn't explicitly test it as a standalone action (like trackSymbolSelection and trackPhraseSpoken are tested separately). Consider adding a dedicated test case for trackBackspaceAction to maintain test coverage consistency.

Copilot · 2026-02-20T00:15:02Z

src/components/Board/Output/Output.container.js

+    const { cancelSpeech, trackBackspaceAction } = this.props;
    cancelSpeech();
+    trackBackspaceAction();


The trackBackspaceAction is being called without userId and sessionId parameters. These parameters should be passed to ensure proper tracking and filtering of communication history per user and session. Similar to the trackPhraseSpoken issue, userData and sessionId should be added to mapStateToProps and then passed to this tracking function.

Suggested change

const { cancelSpeech, trackBackspaceAction } = this.props;

cancelSpeech();

trackBackspaceAction();

const { cancelSpeech, trackBackspaceAction, userData, sessionId } = this.props;

cancelSpeech();

trackBackspaceAction(userData && userData.id, sessionId);

Copilot · 2026-02-20T00:15:03Z

src/components/Board/Output/Output.container.js

+    const { cancelSpeech, trackClearAction } = this.props;
    cancelSpeech();
+    trackClearAction();


The trackClearAction is being called without userId and sessionId parameters. These parameters should be passed to ensure proper tracking and filtering of communication history per user and session. Similar to the trackPhraseSpoken issue, userData and sessionId should be added to mapStateToProps and then passed to this tracking function.

Suggested change

const { cancelSpeech, trackClearAction } = this.props;

cancelSpeech();

trackClearAction();

const { cancelSpeech, trackClearAction, userData, sessionId } = this.props;

cancelSpeech();

trackClearAction(userData, sessionId);

Copilot · 2026-02-20T00:15:03Z

src/components/Board/Output/Output.container.js

-    )
+        label: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
+      }),
+    ),


The PropTypes definition is missing validations for the new tracking action props (trackPhraseSpoken, trackClearAction, trackBackspaceAction) as well as userData and sessionId. These should be added to maintain type safety and documentation consistency with the rest of the codebase.

Suggested change

),

),

/**

* Tracking actions

*/

trackPhraseSpoken: PropTypes.func.isRequired,

trackClearAction: PropTypes.func.isRequired,

trackBackspaceAction: PropTypes.func.isRequired,

/**

* User/session metadata

*/

userData: PropTypes.object,

sessionId: PropTypes.string,

Copilot · 2026-02-20T00:15:03Z

src/components/Board/Board.container.js

    disableTour: PropTypes.func,
    isLiveMode: PropTypes.bool,
-    changeDefaultBoard: PropTypes.func
+    changeDefaultBoard: PropTypes.func,


The PropTypes definition is missing validations for the new tracking action props (trackSymbolSelection, trackPhraseSpoken, trackClearAction, trackBackspaceAction). These should be added to maintain type safety and documentation consistency with the rest of the codebase.

Suggested change

changeDefaultBoard: PropTypes.func,

changeDefaultBoard: PropTypes.func,

trackSymbolSelection: PropTypes.func,

trackPhraseSpoken: PropTypes.func,

trackClearAction: PropTypes.func,

trackBackspaceAction: PropTypes.func,

Copilot · 2026-02-20T00:15:03Z

src/components/Board/Board.container.js

+      trackSymbolSelection(
+        enhancedTile,
+        userData?.email || userData?.id || null,
+        this.props.sessionId || null,


The sessionId is being accessed via this.props.sessionId but it's not defined in mapStateToProps. Either add sessionId to mapStateToProps if it exists in the Redux state, or generate/manage it at the component level to ensure consistent session tracking across user interactions.

Suggested change

trackSymbolSelection(

enhancedTile,

userData?.email || userData?.id || null,

this.props.sessionId || null,

const sessionId =

this.props.sessionId || this.sessionId || shortid.generate();

if (!this.sessionId) {

this.sessionId = sessionId;

}

trackSymbolSelection(

enhancedTile,

userData?.email || userData?.id || null,

sessionId,

Copilot · 2026-02-20T00:15:04Z

src/components/Board/Output/Output.container.js

+    const { output, trackPhraseSpoken } = this.props;
+
    if (liveText) {
      await this.speakOutput(liveText);
    } else {
+      if (output.length > 0) {
+        trackPhraseSpoken(output);


The tracking actions (trackPhraseSpoken, trackClearAction, trackBackspaceAction) are being called without userId and sessionId parameters. These parameters should be passed to ensure proper tracking and filtering of communication history per user and session. The userData and sessionId should be added to mapStateToProps and then passed to these tracking functions.

Suggested change

const { output, trackPhraseSpoken } = this.props;

if (liveText) {

await this.speakOutput(liveText);

} else {

if (output.length > 0) {

trackPhraseSpoken(output);

const { output, trackPhraseSpoken, userData, sessionId } = this.props;

if (liveText) {

await this.speakOutput(liveText);

} else {

if (output.length > 0) {

trackPhraseSpoken(output, userData, sessionId);

Copilot · 2026-02-20T00:15:04Z

src/components/Board/Output/Output.container.js

    isLiveMode: board.isLiveMode,
    navigationSettings: app.navigationSettings,
-    increaseOutputButtons: app.displaySettings.increaseOutputButtons
+    increaseOutputButtons: app.displaySettings.increaseOutputButtons,


The mapStateToProps is missing userData and sessionId which are needed for the tracking actions. Add these to ensure proper tracking: userData from app.userData and consider adding sessionId if it's stored in state, or generate one at the component level.

Suggested change

increaseOutputButtons: app.displaySettings.increaseOutputButtons,

increaseOutputButtons: app.displaySettings.increaseOutputButtons,

userData: app.userData,

sessionId: app.sessionId,

…Container

…ve prop validation

…mmunication entry

…on-history-pdf-report

- Keep tracking actions (trackSymbolSelection, trackPhraseSpoken, trackClearAction, trackBackspaceAction) and add showPremiumRequired in Board.container.js mapDispatchToProps - Keep communicationHistoryReducer import in reducers.js Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Eshaan-byte and others added 9 commits August 26, 2025 04:01

fix: Remove unused variables to resolve Codacy issues

43e629d

- Remove unused 'metadata' parameter in PDFReportService - Remove unused 'now' variable in ExportDialog - Remove unused 'trackBackspaceAction' import in test - Simplify PDF service test to remove unused 'testData'

Update PDFReportService export to use a constant instance

ed8e3fe

Add to OutputContainer the tracking actions for phrase spoken, clear,…

30f2af8

… and backspace

Import font settings for PDF generation

3a0ee15

Add missing commas and deleted comments for consistent formatting in …

1770670

…CommunicationHistory component and tests

Add missing commas and deleted comments for consistent formatting in …

3a260cd

…BoardContainer component

Refactor CommunicationHistory actions and ExportDialog for consistent…

d82fc38

… formatting and improved readability

Delete unnecesarry automatic generated document by the previous colla…

d38ed94

…borator

magush27 requested a review from RodriSanchez1 December 11, 2025 23:07

tomivm requested a review from Copilot February 20, 2026 00:09

Copilot started reviewing on behalf of tomivm February 20, 2026 00:10 View session

Copilot AI reviewed Feb 20, 2026

View reviewed changes

magush27 and others added 6 commits March 4, 2026 14:56

Add tracking functions for symbol selection and user actions in Board…

493f1e9

…Container

Enhance OutputContainer to track user actions with metadata and impro…

38fcbda

…ve prop validation

Add vocalization metadata to trackPhraseSpoken action for enhanced co…

2b10aa4

…mmunication entry

Add test for tracking backspace action in CommunicationHistory

4331fa8

Merge remote-tracking branch 'origin/master' into feature/communicati…

1018177

…on-history-pdf-report

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Solves problems in "feat: Add Communication History PDF Report feature (#1978)" PR#2080

Solves problems in "feat: Add Communication History PDF Report feature (#1978)" PR#2080
magush27 wants to merge 15 commits intocboard-org:masterfrom
magush27:feature/communication-history-pdf-report

magush27 commented Dec 11, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 20, 2026

Uh oh!

Copilot AI Feb 20, 2026

Uh oh!

Copilot AI Feb 20, 2026

Uh oh!

Copilot AI Feb 20, 2026

Uh oh!

Copilot AI Feb 20, 2026

Uh oh!

Copilot AI Feb 20, 2026

Uh oh!

Copilot AI Feb 20, 2026

Uh oh!

Copilot AI Feb 20, 2026

Uh oh!

Copilot AI Feb 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

-    ),
+    ),
+    /**
+     * Tracking actions
+     */
+    trackPhraseSpoken: PropTypes.func.isRequired,
+    trackClearAction: PropTypes.func.isRequired,
+    trackBackspaceAction: PropTypes.func.isRequired,
+    /**
+     * User/session metadata
+     */
+    userData: PropTypes.object,
+    sessionId: PropTypes.string,

-    changeDefaultBoard: PropTypes.func,
+    changeDefaultBoard: PropTypes.func,
+    trackSymbolSelection: PropTypes.func,
+    trackPhraseSpoken: PropTypes.func,
+    trackClearAction: PropTypes.func,
+    trackBackspaceAction: PropTypes.func,

Uh oh!

Conversation

magush27 commented Dec 11, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants