From 6adfd01eb3d9eaae75bf519de2af558f683a70ab Mon Sep 17 00:00:00 2001 From: Favour Ohanekwu Date: Mon, 4 Sep 2023 10:02:57 +0100 Subject: [PATCH] chore: Log only potential system generated cyclic dependency errors to sentry (#26828) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Description This PR ensures that only potential system-generated cyclic dependency errors are logged on sentry. #### PR fixes following issue(s) Fixes #25687 #### Media > A video or a GIF is preferred. when using Loom, don’t embed because it looks like it’s a GIF. instead, just link to the video > > #### Type of change > Please delete options that are not relevant. - Bug fix (non-breaking change which fixes an issue) - New feature (non-breaking change which adds functionality) - Breaking change (fix or feature that would cause existing functionality to not work as expected) - Chore (housekeeping or task changes that don't impact user perception) - This change requires a documentation update > > > ## Testing > #### How Has This Been Tested? > Please describe the tests that you ran to verify your changes. Also list any relevant details for your test configuration. > Delete anything that is not relevant - [ ] Manual - [ ] JUnit - [ ] Jest - [ ] Cypress > > #### Test Plan > Add Testsmith test cases links that relate to this PR > > #### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) > > > ## Checklist: #### Dev activity - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag #### QA activity: - [ ] [Speedbreak features](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-) have been covered - [ ] Test plan covers all impacted features and [areas of interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#areas-of-interest-) - [ ] Test plan has been peer reviewed by project stakeholders and other QA members - [ ] Manually tested functionality on DP - [ ] We had an implementation alignment call with stakeholders post QA Round 2 - [ ] Cypress test cases have been added and approved by SDET/manual QA - [ ] Added `Test Plan Approved` label after Cypress tests were reviewed - [ ] Added `Test Plan Approved` label after JUnit tests were reviewed --- app/client/src/sagas/PostEvaluationSagas.ts | 29 ++++++++++--------- .../workers/common/DataTreeEvaluator/index.ts | 10 ++++++- .../src/workers/common/DependencyMap/index.ts | 6 ++-- 3 files changed, 29 insertions(+), 16 deletions(-) diff --git a/app/client/src/sagas/PostEvaluationSagas.ts b/app/client/src/sagas/PostEvaluationSagas.ts index ea4256aef1..afd8716cb3 100644 --- a/app/client/src/sagas/PostEvaluationSagas.ts +++ b/app/client/src/sagas/PostEvaluationSagas.ts @@ -252,19 +252,22 @@ export function* evalErrorHandler( AppsmithConsole.error({ text: `${error.message} Node was: ${node}`, }); - // Send the generic error message to sentry for better grouping - Sentry.captureException(new Error(error.message), { - tags: { - node, - entityType, - }, - extra: { - dependencyMap, - diffs, - }, - // Level is warning because it could be a user error - level: Sentry.Severity.Warning, - }); + if (error.context.logToSentry) { + // Send the generic error message to sentry for better grouping + Sentry.captureException(new Error(error.message), { + tags: { + node, + entityType, + }, + extra: { + dependencyMap, + diffs, + }, + // Level is warning because it could be a user error + level: Sentry.Severity.Warning, + }); + } + // Log an analytics event for cyclical dep errors AnalyticsUtil.logEvent("CYCLICAL_DEPENDENCY_ERROR", { node, diff --git a/app/client/src/workers/common/DataTreeEvaluator/index.ts b/app/client/src/workers/common/DataTreeEvaluator/index.ts index 9b995cd64b..b9c3b15b8c 100644 --- a/app/client/src/workers/common/DataTreeEvaluator/index.ts +++ b/app/client/src/workers/common/DataTreeEvaluator/index.ts @@ -1207,7 +1207,7 @@ export default class DataTreeEvaluator { sortDependencies( dependencyMap: DependencyMap, - diffs?: (DataTreeDiff | DataTreeDiff[])[], + diffs?: DataTreeDiff[], ): Array { const result = DependencyMapUtils.sortDependencies(dependencyMap); if (result.success) { @@ -1226,6 +1226,13 @@ export default class DataTreeEvaluator { entityType = entity.ENTITY_TYPE; } const dependencies = dependencyMap.dependencies; + + // We are only interested in logging potential system-generated cyclic dependency errors to Sentry + // If a cyclic dependency error occurs without a user editing a dynamic field, that is a potential system-generated cyclic dependency error + + const logToSentry = !diffs + ? false + : !diffs.some((val) => val.event === DataTreeDiffEvent.EDIT); this.errors.push({ type: EvalErrorTypes.CYCLICAL_DEPENDENCY_ERROR, message: "Cyclic dependency found while evaluating.", @@ -1234,6 +1241,7 @@ export default class DataTreeEvaluator { entityType, dependencyMap: dependencies, diffs, + logToSentry, }, }); logError("CYCLICAL DEPENDENCY MAP", dependencies); diff --git a/app/client/src/workers/common/DependencyMap/index.ts b/app/client/src/workers/common/DependencyMap/index.ts index 924d26d60e..4ea60b8914 100644 --- a/app/client/src/workers/common/DependencyMap/index.ts +++ b/app/client/src/workers/common/DependencyMap/index.ts @@ -309,8 +309,10 @@ export const updateDependencyMap = ({ if (didUpdateDependencyMap) { DependencyMapUtils.makeParentsDependOnChildren(dependencyMap); - dataTreeEvalRef.sortedDependencies = - dataTreeEvalRef.sortDependencies(dependencyMap); + dataTreeEvalRef.sortedDependencies = dataTreeEvalRef.sortDependencies( + dependencyMap, + translatedDiffs, + ); } if (didUpdateValidationDependencyMap) { dataTreeEvalRef.sortedValidationDependencies =