fix: locate Terraform entrypoint file #16753
Conversation
| if (filename === defaultMainTerraformFile) { | ||
| initialFile = path; | ||
| skip = true; | ||
| return; | ||
| } |
There was a problem hiding this comment.
What is the order in which traverse() will traverse the nodes of fileTree? Are child paths sorted prior to being added to the frontier? In other words, if you have both a/main.tf and z/main.tf, which will get chosen? I know you have a test above, but is the output dependant on the ordering of the nodes? Is it just "first found wins"?
There was a problem hiding this comment.
Let me expand traverse() with sorting capabilities.
| @@ -90,7 +90,7 @@ export const TemplateVersionEditorPage: FC = () => { | |||
| // File navigation | |||
| // It can be undefined when a selected file is deleted | |||
| const activePath: string | undefined = | |||
| searchParams.get("path") ?? findInitialFile(fileTree ?? {}); | |||
| searchParams.get("path") ?? findEntrypointFile(fileTree ?? {}); | |||
There was a problem hiding this comment.
Do you know what happens if searchParams.get returns an empty string or a string that isn't a valid filename?
That would short-circuit the nullish expression and prevent findEntrypointFile from ever being called, and as far as I can tell, activePath gets fed directly into the editor without any additional data massaging
There was a problem hiding this comment.
nice catch! let me look into this 👍
| // 1. If "main.tf" exists in root, return it. | ||
| // 2. Traverse through sub-directories. | ||
| // 3. If "main.tf" exists in a sub-directory, skip further browsing, and return the path. | ||
| // 4. If "main.tf" was not found, return the last reviewed "".tf" file. |
There was a problem hiding this comment.
With the sorting in place now, I feel like it would've helped to clarify what "last reviewed" means, especially to help make it clear that the tests are actually deterministic
Fixes: #16360
This PR updates the template version editor code to accurately identify the Terraform entrypoint file.