chore: refactor faro (CE) #40350

dvj1988 · 2025-04-23T05:04:19Z

Description

Tip

Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).

Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags="@tag.All"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/14664226456
Commit: caaee4b
Cypress dashboard.
Tags: @tag.All
Spec:

Fri, 25 Apr 2025 13:20:56 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

Yes
No

Summary by CodeRabbit

Refactor
- Unified all error and telemetry reporting to use a centralized telemetry utility for improved consistency.
- Replaced legacy error reporting imports and methods with a new singleton telemetry interface across the application.
- Removed obsolete telemetry and error reporting files and classes.
- Simplified telemetry initialization by removing conditional tracing checks.
- No changes to user-facing functionality or workflows.
Tests
- Updated test mocks to use the new telemetry interface.

coderabbitai · 2025-04-23T05:04:26Z

Walkthrough

This change refactors the application's telemetry and error reporting system by centralizing all error capturing and user identification through a new AppsmithTelemetry singleton class. The previous standalone error capturing utility (captureException from instrumentation/sendFaroErrors) and the FaroUtil class are removed. All error reporting calls across the codebase are updated to use the appsmithTelemetry.captureException method. The telemetry initialization, trace context retrieval, and user identification are now encapsulated within the new class. Additionally, the conditional dynamic import for tracing in the entry point is simplified to always attempt the import. The PageLoadInstrumentation and related legacy utilities are deleted.

Changes

Files/Paths (Grouped)	Change Summary
`app/client/src/instrumentation/index.ts`	Introduces `AppsmithTelemetry` singleton class, encapsulating telemetry setup, error capture, tracing, and user identification. Removes global `faro` and window augmentation.
`app/client/src/instrumentation/sendFaroErrors.ts`, `app/client/src/utils/Analytics/sentry.ts`, `app/client/src/instrumentation/PageLoadInstrumentation.ts`	Deletes legacy error capturing utility, Faro integration class, and page load instrumentation.
`app/client/src/instrumentation/generateTraces.ts`	Refactors to use `appsmithTelemetry.getTraceAndContext()` instead of standalone function.
Most files in `app/client/src/` and subdirectories (e.g., `sagas/`, `widgets/`, `pages/`, `reducers/`, `api/`, `components/`, `utils/`)	Replaces all imports and usages of `captureException` (from `instrumentation/sendFaroErrors`) with `appsmithTelemetry.captureException` from `instrumentation`. No logic changes.
`app/client/src/ce/utils/AnalyticsUtil.tsx`	Replaces `FaroUtil.identifyUser` with `appsmithTelemetry.identifyUser`.
`app/client/src/index.tsx`	Removes conditional check for tracing before importing instrumentation; always attempts import.
`app/client/src/utils/helpers.test.ts`	Updates test mocks and imports to use `appsmithTelemetry` instead of `sendFaroErrors`.

Sequence Diagram(s)

sequenceDiagram
    participant AppCode as Application Code
    participant Telemetry as AppsmithTelemetry
    participant Faro as Faro (Telemetry Backend)

    AppCode->>Telemetry: captureException(error, context)
    Telemetry->>Faro: pushError(error, context)
    Faro-->>Telemetry: eventId
    Telemetry-->>AppCode: eventId

    AppCode->>Telemetry: identifyUser(userId, userData)
    Telemetry->>Faro: setUser(userId, userData)

Possibly related PRs

appsmithorg/appsmith#40220: Refactors error capturing from Sentry to a standalone captureException function; related as both PRs change error reporting mechanisms.
appsmithorg/appsmith#40170: Modifies error handling logic in EvalErrorHandler.ts where this PR also updates telemetry calls.
appsmithorg/appsmith#40270: Replaces Sentry with Faro in EvalErrorHandler.ts; both PRs update error reporting in the same file.

Suggested reviewers

dvj1988
vsvamsi1

Poem

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 4

🔭 Outside diff range comments (2)

app/client/src/utils/getPathAndValueFromActionDiffObject.ts (1)

39-49: ⚠️ Potential issue

Critical Bug: Wrong variable used in path reducer
Inside the reduce callback you reference the outer path variable instead of the accumulator (acc), leading to incorrect or repeated segments.

Apply this diff to correctly build the path from the accumulator:

- path = actionObjectDiff[i].path.reduce(
-   (acc: string, item: number | string) => {
-     try {
-       if (typeof item === "string" && acc) {
-         acc += `${path}.${item}`;
-       } else if (typeof item === "string" && !acc) {
-         acc += `${item}`;
-       } else acc += `${path}[${item}]`;
-
-       return acc;
-     } catch (error) {
-       appsmithTelemetry.captureException(
-         {
-           message: `Adding key: where failed, cannot create path`,
-           oldData: actionObjectDiff,
-         },
-         { errorName: "ActionDiffPathError" },
-       );
-     }
-   },
-   "",
- );
+ path = actionObjectDiff[i].path.reduce(
+   (acc: string, item: number | string) => {
+     try {
+       if (typeof item === "string" && acc) {
+         return `${acc}.${item}`;
+       } else if (typeof item === "string") {
+         return `${item}`;
+       }
+       return `${acc}[${item}]`;
+     } catch (error) {
+       appsmithTelemetry.captureException(
+         {
+           message: `Adding key: where failed, cannot create path`,
+           oldData: actionObjectDiff,
+         },
+         { errorName: "ActionDiffPathError" },
+       );
+       return acc;
+     }
+   },
+   "",
+ );

app/client/src/utils/helpers.test.ts (1)

🧹 Nitpick comments (4)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d7d59c6 and 0cf2b56.

📒 Files selected for processing (50)

app/client/src/AppErrorBoundry.tsx (2 hunks)
app/client/src/PluginActionEditor/components/PluginActionForm/components/UQIEditor/FormRender.tsx (2 hunks)
app/client/src/actions/pageActions.tsx (2 hunks)
app/client/src/api/helpers/validateJsonResponseMeta.ts (2 hunks)
app/client/src/api/interceptors/response/failureHandlers/handleMissingResponseMeta.ts (1 hunks)
app/client/src/api/interceptors/response/failureHandlers/handleNotFoundError.ts (2 hunks)
app/client/src/api/interceptors/response/failureHandlers/handleUnauthorizedError.ts (2 hunks)
app/client/src/ce/sagas/PageSagas.tsx (2 hunks)
app/client/src/ce/utils/AnalyticsUtil.tsx (2 hunks)
app/client/src/components/editorComponents/CodeEditor/EvaluatedValuePopup.tsx (2 hunks)
app/client/src/components/editorComponents/ErrorBoundry.tsx (2 hunks)
app/client/src/components/propertyControls/TabControl.tsx (2 hunks)
app/client/src/ee/sagas/index.tsx (2 hunks)
app/client/src/git/sagas/helpers/handleApiErrors.ts (2 hunks)
app/client/src/index.tsx (1 hunks)
app/client/src/instrumentation/PageLoadInstrumentation.ts (0 hunks)
app/client/src/instrumentation/generateTraces.ts (1 hunks)
app/client/src/instrumentation/index.ts (4 hunks)
app/client/src/instrumentation/sendFaroErrors.ts (0 hunks)
app/client/src/pages/Editor/Canvas.tsx (2 hunks)
app/client/src/pages/UserAuth/Login.tsx (2 hunks)
app/client/src/pages/UserAuth/SignUp.tsx (2 hunks)
app/client/src/pages/UserAuth/VerifyUser.tsx (2 hunks)
app/client/src/pages/UserAuth/helpers.ts (2 hunks)
app/client/src/reducers/evaluationReducers/treeReducer.ts (2 hunks)
app/client/src/sagas/ActionExecution/PluginActionSaga.ts (2 hunks)
app/client/src/sagas/AppThemingSaga.tsx (2 hunks)
app/client/src/sagas/ErrorSagas.tsx (2 hunks)
app/client/src/sagas/EvalErrorHandler.ts (5 hunks)
app/client/src/sagas/EvaluationsSaga.ts (3 hunks)
app/client/src/sagas/FormEvaluationSaga.ts (2 hunks)
app/client/src/sagas/InitSagas.ts (4 hunks)
app/client/src/sagas/ReplaySaga.ts (4 hunks)
app/client/src/sagas/WidgetLoadingSaga.ts (2 hunks)
app/client/src/sagas/layoutConversionSagas.ts (2 hunks)
app/client/src/utils/Analytics/sentry.ts (0 hunks)
app/client/src/utils/getPathAndValueFromActionDiffObject.ts (2 hunks)
app/client/src/utils/helpers.test.ts (2 hunks)
app/client/src/utils/helpers.tsx (2 hunks)
app/client/src/widgets/CurrencyInputWidget/widget/index.tsx (4 hunks)
app/client/src/widgets/JSONFormWidget/fields/CurrencyInputField.tsx (2 hunks)
app/client/src/widgets/JSONFormWidget/fields/useRegisterFieldValidity.ts (2 hunks)
app/client/src/widgets/MapChartWidget/component/utilities.ts (2 hunks)
app/client/src/widgets/PhoneInputWidget/widget/index.tsx (2 hunks)
app/client/src/widgets/TableWidgetV2/component/cellComponents/InlineCellEditor.tsx (2 hunks)
app/client/src/widgets/TableWidgetV2/component/cellComponents/PlainTextCell.tsx (2 hunks)
app/client/src/widgets/TabsMigrator/widget/index.tsx (2 hunks)
app/client/src/widgets/wds/WDSCurrencyInputWidget/widget/index.tsx (4 hunks)
app/client/src/widgets/wds/WDSPhoneInputWidget/widget/index.tsx (2 hunks)
app/client/src/workers/Evaluation/errorModifier.ts (2 hunks)

💤 Files with no reviewable changes (3)

app/client/src/instrumentation/sendFaroErrors.ts
app/client/src/utils/Analytics/sentry.ts
app/client/src/instrumentation/PageLoadInstrumentation.ts

🧰 Additional context used

🧬 Code Graph Analysis (45)

app/client/src/pages/UserAuth/SignUp.tsx (1)

app/client/src/pages/UserAuth/VerifyUser.tsx (1)

app/client/src/instrumentation/generateTraces.ts (1)

app/client/src/components/propertyControls/TabControl.tsx (1)

app/client/src/api/interceptors/response/failureHandlers/handleNotFoundError.ts (1)

app/client/src/sagas/FormEvaluationSaga.ts (1)

app/client/src/api/helpers/validateJsonResponseMeta.ts (1)

app/client/src/PluginActionEditor/components/PluginActionForm/components/UQIEditor/FormRender.tsx (1)

app/client/src/components/editorComponents/CodeEditor/EvaluatedValuePopup.tsx (1)

app/client/src/pages/Editor/Canvas.tsx (1)

app/client/src/widgets/MapChartWidget/component/utilities.ts (1)

app/client/src/ce/utils/AnalyticsUtil.tsx (1)

app/client/src/git/sagas/helpers/handleApiErrors.ts (1)

app/client/src/components/editorComponents/ErrorBoundry.tsx (1)

app/client/src/reducers/evaluationReducers/treeReducer.ts (1)

app/client/src/sagas/layoutConversionSagas.ts (1)

app/client/src/widgets/JSONFormWidget/fields/CurrencyInputField.tsx (1)

app/client/src/utils/getPathAndValueFromActionDiffObject.ts (1)

app/client/src/widgets/PhoneInputWidget/widget/index.tsx (1)

app/client/src/workers/Evaluation/errorModifier.ts (1)

app/client/src/sagas/ActionExecution/PluginActionSaga.ts (1)

app/client/src/widgets/TableWidgetV2/component/cellComponents/InlineCellEditor.tsx (1)

app/client/src/widgets/TableWidgetV2/component/cellComponents/PlainTextCell.tsx (1)

app/client/src/api/interceptors/response/failureHandlers/handleMissingResponseMeta.ts (2)

app/client/src/actions/pageActions.tsx (1)

app/client/src/widgets/wds/WDSCurrencyInputWidget/widget/index.tsx (1)

app/client/src/widgets/wds/WDSPhoneInputWidget/widget/index.tsx (1)

app/client/src/pages/UserAuth/helpers.ts (1)

app/client/src/sagas/EvaluationsSaga.ts (1)

app/client/src/widgets/JSONFormWidget/fields/useRegisterFieldValidity.ts (1)

app/client/src/widgets/CurrencyInputWidget/widget/index.tsx (1)

app/client/src/pages/UserAuth/Login.tsx (1)

app/client/src/api/interceptors/response/failureHandlers/handleUnauthorizedError.ts (1)

app/client/src/sagas/InitSagas.ts (1)

app/client/src/AppErrorBoundry.tsx (1)

app/client/src/utils/helpers.test.ts (1)

app/client/src/sagas/AppThemingSaga.tsx (1)

app/client/src/widgets/TabsMigrator/widget/index.tsx (1)

app/client/src/sagas/WidgetLoadingSaga.ts (1)

app/client/src/ce/sagas/PageSagas.tsx (1)

app/client/src/ee/sagas/index.tsx (1)

app/client/src/sagas/ErrorSagas.tsx (1)

app/client/src/sagas/ReplaySaga.ts (1)

app/client/src/utils/helpers.tsx (1)

app/client/src/sagas/EvalErrorHandler.ts (1)

🪛 GitHub Actions: Quality checks

app/client/src/utils/helpers.test.ts

[error] 12-12: Test suite failed to run due to TypeError: Cannot destructure property 'context' of undefined returned by appsmithTelemetry.getTraceAndContext().

🔇 Additional comments (83)

app/client/src/sagas/ErrorSagas.tsx

app/client/src/instrumentation/index.ts

coderabbitai

Actionable comments posted: 0

♻️ Duplicate comments (3)

🧹 Nitpick comments (6)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 7118c0a and caaee4b.

📒 Files selected for processing (1)

app/client/src/instrumentation/index.ts (4 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (7)

GitHub Check: perform-test / rts-build / build
GitHub Check: perform-test / server-build / server-unit-tests
GitHub Check: client-unit-tests / client-unit-tests
GitHub Check: client-prettier / prettier-check
GitHub Check: client-lint / client-lint
GitHub Check: client-build / client-build
GitHub Check: client-check-cyclic-deps / check-cyclic-dependencies

chore: refactor faro

bccb31c

github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Apr 23, 2025

reorder imports

0cf2b56

dvj1988 changed the title ~~chore: refactor faro~~ chore: refactor faro (CE) Apr 23, 2025

dvj1988 added the ok-to-test Required label for CI label Apr 23, 2025

ApekshaBhosale self-assigned this Apr 23, 2025

ApekshaBhosale marked this pull request as ready for review April 25, 2025 09:57

ApekshaBhosale requested review from ApekshaBhosale, ayushpahwa and a team as code owners April 25, 2025 09:57

ApekshaBhosale requested review from rahulbarwal and removed request for a team April 25, 2025 09:57

coderabbitai bot reviewed Apr 25, 2025

View reviewed changes

app/client/src/sagas/ErrorSagas.tsx Show resolved Hide resolved

app/client/src/instrumentation/index.ts Show resolved Hide resolved

app/client/src/instrumentation/index.ts Outdated Show resolved Hide resolved

app/client/src/instrumentation/index.ts Show resolved Hide resolved

ApekshaBhosale added 5 commits April 25, 2025 16:13

fixed unit test case

ad3d785

Merge branch 'release' into chore/refactor-faro

b02e7fe

check if hint is present

797d2c1

fixing context suggested by codeRabbit

7118c0a

added wrapper for pushMeasurement

caaee4b

coderabbitai bot reviewed Apr 25, 2025

View reviewed changes

ApekshaBhosale approved these changes Apr 29, 2025

View reviewed changes

ApekshaBhosale merged commit 7239cdd into release Apr 29, 2025
83 checks passed

ApekshaBhosale deleted the chore/refactor-faro branch April 29, 2025 05:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: refactor faro (CE) #40350

chore: refactor faro (CE) #40350

Uh oh!

dvj1988 commented Apr 23, 2025 •

edited by github-actions bot

Loading

Uh oh!

coderabbitai bot commented Apr 23, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

chore: refactor faro (CE) #40350

chore: refactor faro (CE) #40350

Uh oh!

Conversation

dvj1988 commented Apr 23, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Automation

🔍 Cypress test results

Communication

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dvj1988 commented Apr 23, 2025 •

edited by github-actions bot

Loading

coderabbitai bot commented Apr 23, 2025 •

edited

Loading