Merge pull request #5 from diogofcunha/circular-dependecy-improve

feat: 🎸 added dependent fields to circular dependency error

src/__tests__/editField.test.ts

@@ -1,4 +1,5 @@
 import { createFormulaStore } from "..";
+import { FormulaFieldCircularDependencyError } from "../errors";
 
 describe("edit field", () => {
   test("should fail if a listed dependency doesn`t exist", () => {
@@ -72,19 +73,34 @@ describe("edit field", () => {
       calculate: calculateSpyFieldD
     });
 
+    store.addField({
+      dependencies: ["d"],
+      id: "e",
+      value: 0,
+      calculate: () => 2
+    });
+
     calculateSpyFieldD.mockClear();
 
-    expect(() =>
+    let error: null | FormulaFieldCircularDependencyError = null;
+
+    try {
       store.editField({
         dependencies: ["a", "b", "d"],
         id: "d",
         value: 0,
         calculate: calculateSpyFieldD
-      })
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"Can't add field "d" due to circular dependency."`
+      });
+    } catch (ex) {
+      error = ex as FormulaFieldCircularDependencyError;
+    }
+
+    expect(error).toMatchInlineSnapshot(
+      `[Error: Can't add field "d" due to circular dependency.]`
     );
 
+    expect(error?.dependentFields).toEqual(["e"]);
+
     // Check if Field was removed.
     expect(() =>
       store.addField({

src/errors.ts

@@ -19,7 +19,7 @@ export class FormulaFieldNotFoundError extends Error {
 }
 
 export class FormulaFieldCircularDependencyError extends Error {
-  constructor(fieldId: string) {
+  constructor(fieldId: string, public readonly dependentFields: string[]) {
     super(`Can't add field "${fieldId}" due to circular dependency.`);
   }
 }

src/index.ts

@@ -85,9 +85,15 @@ export function createFormulaStore({
     try {
       dependencyTree = fieldGraph.kahnTopologicalSort();
     } catch (ex) {
+      const touchedNodes = getPossibleTouchedFieldsOnNodeChange(node);
+
+      touchedNodes.delete(node.id);
+
+      const dependentFields = [...touchedNodes];
+
       removeField(node.id);
 
-      throw new FormulaFieldCircularDependencyError(node.id);
+      throw new FormulaFieldCircularDependencyError(node.id, dependentFields);
     }
 
     addedFields.set(node.id, node);