codama-idl · lorisleiva · Nov 4, 2024 · Oct 31, 2024
diff --git a/.changeset/red-plants-collect.md b/.changeset/red-plants-collect.md
@@ -0,0 +1,5 @@
+---
+'@codama/visitors-core': minor
+---
+
+Record and resolve `NodePaths` instead of `Nodes` in `LinkableDictionary`
diff --git a/packages/errors/src/context.ts b/packages/errors/src/context.ts
@@ -75,7 +75,7 @@ export type CodamaErrorContext = DefaultUnspecifiedErrorContextToUndefined<{
         kind: LinkNode['kind'];
         linkNode: LinkNode;
         name: CamelCaseString;
-        stack: Node[];
+        path: readonly Node[];
     };
     [CODAMA_ERROR__NODE_FILESYSTEM_FUNCTION_UNAVAILABLE]: {
         fsFunction: string;
@@ -169,7 +169,7 @@ type ValidationItem = {
     level: 'debug' | 'error' | 'info' | 'trace' | 'warn';
     message: string;
     node: Node;
-    stack: Node[];
+    path: Node[];
 };
 
 export function decodeEncodedContext(encodedContext: string): object {

diff --git a/packages/renderers-js-umi/src/getRenderMapVisitor.ts b/packages/renderers-js-umi/src/getRenderMapVisitor.ts
@@ -204,7 +204,7 @@ export function getRenderMapVisitor(options: GetRenderMapOptions = {}): Visitor<
                     }
 
                     // Seeds.
-                    const pda = node.pda ? linkables.get(node.pda, stack) : undefined;
+                    const pda = node.pda ? linkables.get([...stack.getPath(), node.pda]) : undefined;
                     const pdaSeeds = pda?.seeds ?? [];
                     const seeds = pdaSeeds.map(seed => {
                         if (isNode(seed, 'variablePdaSeedNode')) {

diff --git a/packages/renderers-js-umi/src/getTypeManifestVisitor.ts b/packages/renderers-js-umi/src/getTypeManifestVisitor.ts
@@ -429,7 +429,7 @@ export function getTypeManifestVisitor(input: {
                     const importFrom = getImportFrom(node.enum);
 
                     // FIXME(loris): No program node can ever be in this stack.
-                    const enumNode = linkables.get(node.enum, stack)?.type;
+                    const enumNode = linkables.get([...stack.getPath(), node.enum])?.type;
                     const isScalar =
                         enumNode && isNode(enumNode, 'enumTypeNode')
                             ? isScalarEnum(enumNode)

diff --git a/packages/renderers-js/src/fragments/accountPdaHelpers.ts b/packages/renderers-js/src/fragments/accountPdaHelpers.ts
@@ -13,7 +13,7 @@ export function getAccountPdaHelpersFragment(
     },
 ): Fragment {
     const { accountNode, accountStack, nameApi, linkables, customAccountData, typeManifest } = scope;
-    const pdaNode = accountNode.pda ? linkables.get(accountNode.pda, accountStack) : undefined;
+    const pdaNode = accountNode.pda ? linkables.get([...accountStack.getPath(), accountNode.pda]) : undefined;
     if (!pdaNode) {
         return fragment('');
     }

diff --git a/packages/renderers-js/src/fragments/instructionAccountTypeParam.ts b/packages/renderers-js/src/fragments/instructionAccountTypeParam.ts
@@ -43,9 +43,8 @@ function getDefaultAddress(
         case 'publicKeyValueNode':
             return `"${defaultValue.publicKey}"`;
         case 'programLinkNode':
-            // FIXME(loris): No need for a stack here.
             // eslint-disable-next-line no-case-declarations
-            const programNode = linkables.get(defaultValue, new NodeStack());
+            const programNode = linkables.get([defaultValue]);
             return programNode ? `"${programNode.publicKey}"` : 'string';
         case 'programIdValueNode':
             return `"${programId}"`;

diff --git a/packages/renderers-js/src/getTypeManifestVisitor.ts b/packages/renderers-js/src/getTypeManifestVisitor.ts
@@ -355,7 +355,7 @@ export function getTypeManifestVisitor(input: {
                     const importFrom = getImportFrom(node.enum);
 
                     // FIXME(loris): No program node can ever be in this stack.
-                    const enumNode = linkables.get(node.enum, stack)?.type;
+                    const enumNode = linkables.get([...stack.getPath(), node.enum])?.type;
                     const isScalar =
                         enumNode && isNode(enumNode, 'enumTypeNode')
                             ? isScalarEnum(enumNode)

diff --git a/packages/renderers-rust/src/getRenderMapVisitor.ts b/packages/renderers-rust/src/getRenderMapVisitor.ts
@@ -64,7 +64,7 @@ export function getRenderMapVisitor(options: GetRenderMapOptions = {}) {
 
                     // Seeds.
                     const seedsImports = new ImportMap();
-                    const pda = node.pda ? linkables.get(node.pda, stack) : undefined;
+                    const pda = node.pda ? linkables.get([...stack.getPath(), node.pda]) : undefined;
                     const pdaSeeds = pda?.seeds ?? [];
                     const seeds = pdaSeeds.map(seed => {
                         if (isNode(seed, 'variablePdaSeedNode')) {

diff --git a/packages/validators/README.md b/packages/validators/README.md
@@ -36,8 +36,8 @@ type ValidationItem = {
     message: string;
     // The node that the validation item is related to.
     node: Node;
-    // The stack of nodes that led to the node above.
-    stack: readonly Node[];
+    // The path of nodes that led to the node above (including the node itself).
+    path: readonly Node[];
 };
 ```
 

diff --git a/packages/validators/src/ValidationItem.ts b/packages/validators/src/ValidationItem.ts
@@ -8,7 +8,7 @@ export type ValidationItem = {
     level: LogLevel;
     message: string;
     node: Node;
-    stack: readonly Node[];
+    path: readonly Node[];
 };
 
 export function validationItem(
@@ -21,7 +21,7 @@ export function validationItem(
         level,
         message,
         node,
-        stack: Array.isArray(stack) ? [...stack] : stack.all(),
+        path: Array.isArray(stack) ? [...stack] : stack.all(),
     };
 }
 

diff --git a/packages/validators/src/getValidationItemsVisitor.ts b/packages/validators/src/getValidationItemsVisitor.ts
@@ -47,7 +47,7 @@ export function getValidationItemsVisitor(): Visitor<readonly ValidationItem[]>
                     const items = [] as ValidationItem[];
                     if (!node.name) {
                         items.push(validationItem('error', 'Pointing to a defined type with no name.', node, stack));
-                    } else if (!linkables.has(node, stack)) {
+                    } else if (!linkables.has(stack.getPath())) {
                         items.push(
                             validationItem(
                                 'error',

diff --git a/packages/visitors-core/README.md b/packages/visitors-core/README.md
@@ -653,11 +653,8 @@ It offers the following API:
 ```ts
 const linkables = new LinkableDictionary();
 
-// Record program nodes.
-linkables.record(programNode, stack);
-
-// Record other linkable nodes with their associated program node.
-linkables.record(accountNode, stack);
+// Record linkable nodes via their full path.
+linkables.recordPath([rootNode, programNode, accountNode]);
 
 // Get a linkable node using a link node, or throw an error if it is not found.
 const programNode = linkables.getOrThrow(programLinkNode, stack);