RDKEMW-15080: Log subtitle content when enabled by naveendude15 · Pull Request #699 · rdkcentral/rialto

naveendude15 · 2026-11-04T14:06:26Z

RDKEMW-15080: Log subtitle content when enabled

Reason for change: Add configurable capture of subtitle payloads for diagnosis. A configured RIALTO_SUBTITLE_LOG_PATH writes them to a separate file; otherwise RIALTO_SHOW_SUBTITLE_DATA enables the normal Rialto DEBUG log.

Test Procedure: https://ccp.sys.comcast.net/browse/RDKEMW-15080

github-actions · 2026-11-04T14:06:39Z

Pull request title must follow the pattern:
< JIRA TICKET >: < one line summary of change less than 65 characters >

Pull request description must follow the Commit message format for RDK-E:
https://etwiki.sys.comcast.net/spaces/RDKAR/pages/1407997180/Commit+Message+Format+For+RDKE

Associated JIRA ticket in format : < JIRA TICKET >: < one line summary of change less than 65 characters >
Detailed reason for change information
Test procedure. Only references links to Jira ticket or sub tickets where test steps and references are captured.

< JIRA TICKET >: < one line summary of change less than 65 characters >
< empty line >
Reason for change:
Test Procedure: < https://ccp.sys.comcast.net/browse/JIRA TICKET/url/to/test_step_section>

github-actions · 2026-11-04T14:15:57Z

Coverage statistics of your commit:
Lines coverage stays unchanged and is: 84.3%
Functions coverage stays unchanged and is: 92.7%

Copilot

🟡 Changes recommended

Both text-track logging paths silently truncate larger TTML/WebVTT payloads and need full-payload handling with tests confirming that payload tails are preserved.

1 open issue

Large TTML/WebVTT payloads are truncated in logging · New

What changed in this PR

Adds configurable subtitle payload capture to the media server’s text-track handling for diagnosis.

Changes:

Writes payloads to RIALTO_SUBTITLE_LOG_PATH when configured.
Enables normal DEBUG logging through RIALTO_SHOW_SUBTITLE_DATA, with DEBUG fallback when file writing fails.
Adds tests for logging configuration, file output, and write-failure fallback.

File	Description
tests/unittests/media/server/main/textTrackAccessor/TextTrackAccessorTest.cpp	Adds logging capture, environment cleanup, and subtitle-output tests.
media/server/main/source/TextTrackAccessor.cpp	Adds environment-controlled subtitle logging and synchronized file output.

_{Review effort: Balanced}

Copilot

🟡 Changes recommended

Subtitle capture ignores the documented path variable and silently truncates long payloads in both DEBUG and file-error fallback logging, while successful file output remains untested.

4 open issues

_{Review effort: Balanced}

github-actions · 2026-11-04T15:24:09Z

Coverage statistics of your commit:
Lines coverage stays unchanged and is: 84.3%
Functions coverage stays unchanged and is: 92.7%

Copilot

🟡 Changes recommended

Opening a pre-existing FIFO can block indefinitely while holding the logging mutex, stalling subtitle delivery and other file-logging calls.

3 open issues

3 resolved since last review

_{Review effort: Balanced}

Copilot

🟡 Changes recommended

Hard-linked targets can bypass the directory restriction, embedded NULs truncate logged payloads, and the FIFO test fails to detect blocking regressions.

3 open issues

Preserve embedded NUL bytes in debug output · New
Reject hard-linked targets before writing · New
Add a bounded FIFO-with-no-readers regression test · New

3 resolved since last review

_{Review effort: Balanced}

Copilot

🟡 Changes recommended

File-output failures bypass the normal-log capture opt-in, and DEBUG-log assertions fail in the default Release configuration because DEBUG calls are compiled out.

2 open issues

3 resolved since last review

_{Review effort: Balanced}

Copilot

🟡 Changes recommended

Subtitle logging still escapes the full payload and allocates chunks when DEBUG output is disabled, adding unnecessary work to synchronous sendData calls.

1 open issue

Skip subtitle payload processing when DEBUG logging is unavailable · New

2 resolved since last review

_{Review effort: Balanced}

github-actions · 2026-11-05T04:52:39Z

media/server/main/source/TextTrackAccessor.cpp:94:9: style: Condition '!isSubtitleDebugLoggingEnabled()' is always true [knownConditionTrueFalse]
if (!isSubtitleDebugLoggingEnabled())
^
media/server/main/source/TextTrackAccessor.cpp:94:39: note: Calling function 'isSubtitleDebugLoggingEnabled' returns 0
if (!isSubtitleDebugLoggingEnabled())
^
media/server/main/source/TextTrackAccessor.cpp:94:9: note: Condition '!isSubtitleDebugLoggingEnabled()' is always true
if (!isSubtitleDebugLoggingEnabled())
^
nofile:0:0: information: Active checkers: 161/592 (use --checkers-report= to see details) [checkersReport]

Copilot

🟡 Changes recommended

A critical ownership-validation gap allows another user to pre-create an accepted file in /tmp and control captured diagnostics when kernel-level protected_regular enforcement is absent.

1 open issue

Reject diagnostic files not owned by the service user · New

1 resolved since last review

Skip subtitle payload processing when DEBUG logging is unavailable

_{Review effort: Balanced}

github-actions · 2026-11-05T05:05:38Z

Coverage statistics of your commit:
Lines coverage stays unchanged and is: 84.3%
Functions coverage stays unchanged and is: 92.7%

github-actions · 2026-11-05T06:27:07Z

media/server/main/source/TextTrackAccessor.cpp:94:9: style: Condition '!isSubtitleDebugLoggingEnabled()' is always true [knownConditionTrueFalse]
if (!isSubtitleDebugLoggingEnabled())
^
media/server/main/source/TextTrackAccessor.cpp:94:39: note: Calling function 'isSubtitleDebugLoggingEnabled' returns 0
if (!isSubtitleDebugLoggingEnabled())
^
media/server/main/source/TextTrackAccessor.cpp:94:9: note: Condition '!isSubtitleDebugLoggingEnabled()' is always true
if (!isSubtitleDebugLoggingEnabled())
^
nofile:0:0: information: Active checkers: 161/592 (use --checkers-report= to see details) [checkersReport]

Copilot

🟢 Approval recommended

No active review issues block approval of the configurable subtitle payload logging change.

No open issues 🎉

1 resolved since last review

Reject diagnostic files not owned by the service user

_{Review effort: Balanced}

github-actions · 2026-11-05T06:37:39Z

Coverage statistics of your commit:
Lines coverage stays unchanged and is: 84.3%
Functions coverage stays unchanged and is: 92.7%

Reason for change: Add configurable capture of subtitle payloads passed to Rialto. When a dedicated path is supplied, payloads are appended there; without a path, RIALTO_SHOW_SUBTITLE_DATA controls whether they are included in Rialto DEBUG logs. This helps diagnose subtitle delivery while allowing content to be kept out of the general log stream. Test Procedure: https://ccp.sys.comcast.net/browse/RDKEMW-15080

github-actions · 2026-11-05T07:27:41Z

Coverage statistics of your commit:
Lines coverage stays unchanged and is: 84.3%
Functions coverage stays unchanged and is: 92.7%

Copilot

🟢 Approval recommended

No active review issues were identified for the configurable subtitle payload logging change.

No open issues 🎉

_{Review effort: Balanced}

github-advanced-security Bot found potential problems Nov 4, 2026

View reviewed changes

Comment thread media/server/main/source/TextTrackAccessor.cpp Fixed

naveendude15 requested a balanced review from Copilot November 4, 2026 14:17

Copilot started reviewing on behalf of naveendude15 November 4, 2026 14:18

View session

Copilot AI reviewed Nov 4, 2026

View reviewed changes

Comment thread media/server/main/source/TextTrackAccessor.cpp Resolved

naveendude15 force-pushed the feature/RDKEMW-15080_env branch 2 times, most recently from 4956c89 to c35f6bf Compare November 4, 2026 15:12

naveendude15 requested a balanced review from Copilot November 4, 2026 15:19

Copilot started reviewing on behalf of naveendude15 November 4, 2026 15:19

View session

Copilot AI reviewed Nov 4, 2026

View reviewed changes

Comment thread media/server/main/source/TextTrackAccessor.cpp Resolved

Comment thread media/server/main/source/TextTrackAccessor.cpp Resolved

Comment thread tests/unittests/media/server/main/textTrackAccessor/TextTrackAccessorTest.cpp Resolved

naveendude15 force-pushed the feature/RDKEMW-15080_env branch 3 times, most recently from 6cfb3f7 to 9d05076 Compare November 4, 2026 20:19

naveendude15 requested a balanced review from Copilot November 4, 2026 20:46

Copilot started reviewing on behalf of naveendude15 November 4, 2026 20:46

View session

Copilot AI reviewed Nov 4, 2026

View reviewed changes

Comment thread media/server/main/source/TextTrackAccessor.cpp Resolved

Comment thread media/server/main/source/TextTrackAccessor.cpp Resolved

naveendude15 force-pushed the feature/RDKEMW-15080_env branch from 9d05076 to ef1805f Compare November 4, 2026 21:07

naveendude15 requested a balanced review from Copilot November 4, 2026 21:09

Copilot started reviewing on behalf of naveendude15 November 4, 2026 21:09

View session

Copilot AI reviewed Nov 4, 2026

View reviewed changes

Comment thread media/server/main/source/TextTrackAccessor.cpp Resolved

Comment thread media/server/main/source/TextTrackAccessor.cpp Resolved

Comment thread tests/unittests/media/server/main/textTrackAccessor/TextTrackAccessorTest.cpp Resolved

naveendude15 force-pushed the feature/RDKEMW-15080_env branch from ef1805f to 488355c Compare November 5, 2026 03:32

naveendude15 requested a balanced review from Copilot November 5, 2026 03:34

Copilot started reviewing on behalf of naveendude15 November 5, 2026 03:34

View session

Copilot AI reviewed Nov 5, 2026

View reviewed changes

Comment thread tests/unittests/media/server/main/textTrackAccessor/TextTrackAccessorTest.cpp Resolved

Comment thread media/server/main/source/TextTrackAccessor.cpp Resolved

naveendude15 force-pushed the feature/RDKEMW-15080_env branch from 488355c to 603f08a Compare November 5, 2026 03:57

naveendude15 requested a balanced review from Copilot November 5, 2026 04:21

Copilot started reviewing on behalf of naveendude15 November 5, 2026 04:21

View session

Copilot AI reviewed Nov 5, 2026

View reviewed changes

Comment thread media/server/main/source/TextTrackAccessor.cpp Resolved

naveendude15 force-pushed the feature/RDKEMW-15080_env branch from 603f08a to e0e0eac Compare November 5, 2026 04:52

naveendude15 requested a balanced review from Copilot November 5, 2026 04:56

Copilot started reviewing on behalf of naveendude15 November 5, 2026 04:57

View session

Copilot AI reviewed Nov 5, 2026

View reviewed changes

Comment thread media/server/main/source/TextTrackAccessor.cpp Resolved

naveendude15 force-pushed the feature/RDKEMW-15080_env branch from e0e0eac to d991657 Compare November 5, 2026 06:26

github-advanced-security Bot found potential problems Nov 5, 2026

View reviewed changes

Comment thread tests/unittests/media/server/main/textTrackAccessor/TextTrackAccessorTest.cpp Fixed

naveendude15 requested a balanced review from Copilot November 5, 2026 06:29

Copilot started reviewing on behalf of naveendude15 November 5, 2026 06:29

View session

Copilot AI reviewed Nov 5, 2026

View reviewed changes

naveendude15 force-pushed the feature/RDKEMW-15080_env branch from d991657 to 2ea0ea4 Compare November 5, 2026 07:19

naveendude15 requested a balanced review from Copilot November 5, 2026 07:33

Copilot started reviewing on behalf of naveendude15 November 5, 2026 07:34

View session

Copilot AI reviewed Nov 5, 2026

View reviewed changes

Conversation

naveendude15 commented Nov 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Nov 4, 2026

Uh oh!

Uh oh!

github-actions Bot commented Nov 4, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Nov 4, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

github-actions Bot commented Nov 5, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

github-actions Bot commented Nov 5, 2026

Uh oh!

github-actions Bot commented Nov 5, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟢 Approval recommended

Uh oh!

github-actions Bot commented Nov 5, 2026

Uh oh!

github-actions Bot commented Nov 5, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟢 Approval recommended

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

naveendude15 commented Nov 4, 2026 •

edited

Loading