fix(react-docgen): add ObjectMethod support to resolveName (#1036)

* fix(react-docgen): add ObjectMethod support to resolveName

Extend the resolveName function in getMemberExpressionValuePath.ts to
handle ObjectMethod nodes, preventing the error below from being thrown
during AST resolution of member expressions within object methods.

TypeError: Attempted to resolveName for an unsupported path. resolveName does not accept ObjectMethod.

Fix #902

* refactor: extract ObjectMethod handling to a dedicated condition

* ignore ObjectMethod

---------

Co-authored-by: Daniel Tschinder <[email protected]>

Author: DiogoDoreto

.changeset/tired-ideas-invent.md

@@ -0,0 +1,5 @@
+---
+'react-docgen': patch
+---
+
+Do not fail when resolving inside ObjectMethod nodes

packages/react-docgen/src/utils/__tests__/getMemberExpressionValuePath-test.ts

@@ -1,6 +1,8 @@
+import type { ObjectMethod, VariableDeclaration } from '@babel/types';
 import { parse } from '../../../tests/utils';
 import getMemberExpressionValuePath from '../getMemberExpressionValuePath.js';
 import { describe, expect, test } from 'vitest';
+import type { NodePath } from '@babel/traverse';
 
 describe('getMemberExpressionValuePath', () => {
   describe('MethodExpression', () => {
@@ -101,4 +103,23 @@ describe('getMemberExpressionValuePath', () => {
       );
     });
   });
+  describe('ObjectMethod', () => {
+    test('ignores ObjectMethod', () => {
+      const def = parse.statement<VariableDeclaration>(`
+        const slice = createSlice({
+          example(state, action) {
+          },
+        });
+      `);
+
+      // path to `action.payload.id`
+      const path = def
+        .get('declarations')[0]
+        .get('init')
+        .get('arguments')[0]
+        .get('properties')[0] as NodePath<ObjectMethod>;
+
+      expect(getMemberExpressionValuePath(path, 'images')).toBe(null);
+    });
+  });
 });

packages/react-docgen/src/utils/__tests__/resolveToValue-test.ts

@@ -269,4 +269,30 @@ describe('resolveToValue', () => {
       expect(resolveToValue(path)).toBe(path);
     });
   });
+
+  describe('ObjectMethod', () => {
+    test('does not throw', () => {
+      const def = parse.statement(
+        `const slice = createSlice({
+          example(state, action) {
+            state.images[action.payload.id] = action.payload.content;
+          },
+        });`,
+      );
+
+      // path to `action.payload.id`
+      const path = def
+        .get('declarations')[0]
+        .get('init')
+        .get('arguments')[0]
+        .get('properties')[0]
+        .get('body')
+        .get('body')[0]
+        .get('expression')
+        .get('left')
+        .get('property');
+
+      expect(() => resolveToValue(path)).not.toThrow();
+    });
+  });
 });

packages/react-docgen/src/utils/getMemberExpressionValuePath.ts

@@ -37,6 +37,12 @@ function resolveName(path: NodePath): string | undefined {
     return;
   }
 
+  // When we check ObjectMethod we simply ignore it as assigning
+  // to it is technicaly possible but rare
+  if (path.isObjectMethod()) {
+    return;
+  }
+
   if (
     path.isFunctionExpression() ||
     path.isArrowFunctionExpression() ||