limit number of attempts to generated suggested app name

Author: craigmichaelmartin

packages/cli-kit/src/public/node/fs.test.ts

@@ -219,6 +219,29 @@ describe('makeDirectoryWithRandomName', () => {
     })
   })
 
+  test('returns an empty string if unable to generate an available name', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      // Given
+      vi.mocked(takeRandomFromArray).mockReturnValueOnce('taken')
+      vi.mocked(takeRandomFromArray).mockReturnValueOnce('directory')
+      vi.mocked(takeRandomFromArray).mockReturnValueOnce('taken')
+      vi.mocked(takeRandomFromArray).mockReturnValueOnce('directory')
+      vi.mocked(takeRandomFromArray).mockReturnValueOnce('taken')
+      vi.mocked(takeRandomFromArray).mockReturnValueOnce('directory')
+
+      const content = 'test'
+      const filePath = joinPath(tmpDir, 'taken-directory-app')
+      await writeFile(filePath, content)
+
+      // When
+      const got = await generateRandomNameForSubdirectory({suffix: 'app', directory: tmpDir})
+
+      // Then
+      expect(got).toEqual('')
+      expect(takeRandomFromArray).toHaveBeenCalledTimes(6)
+    })
+  })
+
   test('rerolls the name if an invalid name is produced', async () => {
     await inTemporaryDirectory(async (tmpDir) => {
       // Given
@@ -239,6 +262,29 @@ describe('makeDirectoryWithRandomName', () => {
       expect(takeRandomFromArray).toHaveBeenCalledTimes(4)
     })
   })
+
+  test('returns an empty string if unable to generate a valid name', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      // Given
+      vi.mocked(takeRandomFromArray).mockReturnValueOnce('invalid')
+      vi.mocked(takeRandomFromArray).mockReturnValueOnce('name')
+      vi.mocked(takeRandomFromArray).mockReturnValueOnce('invalid')
+      vi.mocked(takeRandomFromArray).mockReturnValueOnce('name')
+      vi.mocked(takeRandomFromArray).mockReturnValueOnce('invalid')
+      vi.mocked(takeRandomFromArray).mockReturnValueOnce('name')
+
+      // When
+      const got = await generateRandomNameForSubdirectory({
+        suffix: 'app',
+        directory: tmpDir,
+        isValidName: (name: string) => name !== 'invalid-name-app',
+      })
+
+      // Then
+      expect(got).toEqual('')
+      expect(takeRandomFromArray).toHaveBeenCalledTimes(6)
+    })
+  })
 })
 
 describe('readFileSync', () => {

packages/cli-kit/src/public/node/fs.ts

@@ -469,7 +469,10 @@ interface GenerateRandomDirectoryOptions {
   /** Type of word to use for random name. */
   family?: RandomNameFamily
 
-  /** Criteria predicate for generated name */
+  /** Used to to track how many attempts have been made to generate the name. */
+  attempts?: number
+
+  /** Predicate for validating the generated name. */
   isValidName?: (name: string) => boolean
 }
 
@@ -483,6 +486,9 @@ const defaultIsValidName = () => true
  * @returns It returns the name of the directory.
  */
 export async function generateRandomNameForSubdirectory(options: GenerateRandomDirectoryOptions): Promise<string> {
+  options.attempts = (options.attempts || 0) + 1
+  if (options.attempts > 3) return ''
+
   const generated = `${getRandomName(options.family ?? 'business')}-${options.suffix}`
 
   const validName = (options.isValidName ?? defaultIsValidName)(generated)