one 1.17.2 → 1.17.4

package/src/vite/plugins/fileSystemRouterPlugin.test.ts

@@ -0,0 +1,106 @@
+import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs'
+import { tmpdir } from 'node:os'
+import path from 'node:path'
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
+
+vi.mock('vite', async () => {
+  const actual = await vi.importActual<typeof import('vite')>('vite')
+  return {
+    ...actual,
+    createServerModuleRunner: vi.fn(() => ({
+      clearCache: vi.fn(),
+      import: vi.fn(),
+    })),
+  }
+})
+
+describe('createFileSystemRouterPlugin', () => {
+  const previousIsVxrnCli = process.env.IS_VXRN_CLI
+  let previousVxrnPluginConfig: unknown
+  let tempRoot: string | undefined
+
+  beforeEach(() => {
+    previousVxrnPluginConfig = (globalThis as any).__vxrnPluginConfig__
+  })
+
+  afterEach(() => {
+    if (tempRoot) {
+      rmSync(tempRoot, { recursive: true, force: true })
+      tempRoot = undefined
+    }
+
+    if (previousIsVxrnCli === undefined) {
+      delete process.env.IS_VXRN_CLI
+    } else {
+      process.env.IS_VXRN_CLI = previousIsVxrnCli
+    }
+
+    if (previousVxrnPluginConfig === undefined) {
+      delete (globalThis as any).__vxrnPluginConfig__
+    } else {
+      ;(globalThis as any).__vxrnPluginConfig__ = previousVxrnPluginConfig
+    }
+    vi.restoreAllMocks()
+  })
+
+  it('keeps route watcher rebuild errors handled', async () => {
+    process.env.IS_VXRN_CLI = '1'
+    tempRoot = mkdtempSync(path.join(tmpdir(), 'one-router-watch-'))
+    const appDir = path.join(tempRoot, 'app')
+    writeFileSync(path.join(tempRoot, 'package.json'), '{}\n')
+    mkdirSync(appDir)
+    writeFileSync(
+      path.join(appDir, 'index.tsx'),
+      'export default function Index() { return null }\n'
+    )
+
+    ;(globalThis as any).__vxrnPluginConfig__ = {
+      web: {
+        defaultRenderMode: 'ssg',
+      },
+    }
+
+    const { createFileSystemRouterPlugin } = await import('./fileSystemRouterPlugin')
+    const plugin = createFileSystemRouterPlugin({
+      router: {
+        root: appDir,
+      },
+    })
+
+    let watcherListener:
+      | ((event: string, changedPath: string) => void | Promise<void>)
+      | undefined
+    const server = {
+      environments: {
+        ssr: {},
+      },
+      watcher: {
+        addListener: vi.fn((event: string, listener: typeof watcherListener) => {
+          if (event === 'all') {
+            watcherListener = listener
+          }
+        }),
+        on: vi.fn(),
+      },
+    }
+
+    ;(plugin as any).configureServer(server)
+    expect(watcherListener).toBeDefined()
+
+    const warn = vi.spyOn(console, 'warn').mockImplementation(() => {})
+    delete (globalThis as any).__vxrnPluginConfig__
+
+    if (!watcherListener) {
+      throw new Error('Expected route watcher listener to be registered')
+    }
+
+    await expect(
+      Promise.resolve(watcherListener('add', path.join(appDir, 'new-route.tsx')))
+    ).resolves.toBeUndefined()
+
+    expect(warn).toHaveBeenCalledWith(
+      expect.stringContaining('[one] Failed to rebuild routes'),
+      expect.any(Error)
+    )
+  })
+})

package/src/vite/plugins/fileSystemRouterPlugin.tsx

@@ -14,6 +14,7 @@ import { getRouterRootFromOneOptions } from '../../utils/getRouterRootFromOneOpt
 import { isResponse } from '../../utils/isResponse'
 import { isStatusRedirect } from '../../utils/isStatus'
 import { promiseWithResolvers } from '../../utils/promiseWithResolvers'
+import { isRouteFileWatchEvent } from '../../utils/routeFileWatch'
 import { trackLoaderDependencies } from '../../utils/trackLoaderDependencies'
 import { LoaderDataCache } from '../../vite/constants'
 import { replaceLoader } from '../../vite/replaceLoader'
@@ -524,6 +525,14 @@ export function createFileSystemRouterPlugin(options: One.PluginOptions): Plugin
     )
   }
 
+  function recreateRequestHandler(changedPath: string) {
+    try {
+      handleRequest = createRequestHandler()
+    } catch (error) {
+      console.warn(`[one] Failed to rebuild routes after ${changedPath} changed.`, error)
+    }
+  }
+
   return {
     name: `one-router-fs`,
     enforce: 'post',
@@ -585,21 +594,20 @@ export function createFileSystemRouterPlugin(options: One.PluginOptions): Plugin
         USE_SERVER_ENV ? server.environments.server : server.environments.ssr
       )
 
-      const appDir = path.join(process.cwd(), getRouterRootFromOneOptions(options))
+      const appDir = path.resolve(process.cwd(), getRouterRootFromOneOptions(options))
 
       // on change ./app stuff lets reload this to pick up any route changes
-      const fileWatcherChangeListener = debounce(
-        async (type: string, changedPath: string) => {
-          if (type === 'add' || type === 'delete') {
-            // resolve to absolute path since watcher may emit relative paths
-            const absolutePath = path.resolve(changedPath)
-            if (absolutePath.startsWith(appDir)) {
-              handleRequest = createRequestHandler()
-            }
-          }
-        },
-        100
-      )
+      const fileWatcherChangeListener = debounce((type: string, changedPath: string) => {
+        if (
+          isRouteFileWatchEvent({
+            event: type,
+            filePath: changedPath,
+            routerRoot: appDir,
+          })
+        ) {
+          recreateRequestHandler(changedPath)
+        }
+      }, 100)
 
       server.watcher.addListener('all', fileWatcherChangeListener)
 

package/src/vite/plugins/generateFileSystemRouteTypesPlugin.tsx

@@ -3,6 +3,7 @@ import { debounce } from 'perfect-debounce'
 import type { Plugin } from 'vite'
 import { generateRouteTypes } from '../../typed-routes/generateRouteTypes'
 import { getRouterRootFromOneOptions } from '../../utils/getRouterRootFromOneOptions'
+import { isRouteFileWatchEvent } from '../../utils/routeFileWatch'
 import type { One } from '../types'
 
 export function generateFileSystemRouteTypesPlugin(options: One.PluginOptions): Plugin {
@@ -12,7 +13,7 @@ export function generateFileSystemRouteTypesPlugin(options: One.PluginOptions):
     apply: 'serve',
 
     configureServer(server) {
-      const appDir = join(process.cwd(), getRouterRootFromOneOptions(options))
+      const appDir = resolve(process.cwd(), getRouterRootFromOneOptions(options))
       // Generate routes.d.ts inside the app directory to keep it organized
       const outFile = join(appDir, 'routes.d.ts')
 
@@ -22,22 +23,20 @@ export function generateFileSystemRouteTypesPlugin(options: One.PluginOptions):
 
       // on change ./app stuff lets reload this to pick up any route changes
       const fileWatcherChangeListener = debounce(async (type: string, path: string) => {
-        if (type === 'add' || type === 'delete' || type === 'change') {
-          // resolve to absolute path since watcher may emit relative paths
-          const absolutePath = resolve(path)
-          // skip routes.d.ts itself to avoid infinite loop
-          if (absolutePath === outFile) {
-            return
-          }
-          if (absolutePath.startsWith(appDir)) {
-            // generate
-            generateRouteTypes(
-              outFile,
-              routerRoot,
-              options.router?.ignoredRouteFiles,
-              typedRoutesGeneration
-            )
-          }
+        if (
+          isRouteFileWatchEvent({
+            event: type,
+            filePath: path,
+            routerRoot: appDir,
+            includeChangeEvents: true,
+          })
+        ) {
+          generateRouteTypes(
+            outFile,
+            routerRoot,
+            options.router?.ignoredRouteFiles,
+            typedRoutesGeneration
+          )
         }
       }, 100)
 

package/types/cli/build.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../src/cli/build.ts"],"names":[],"mappings":"AAmUA,wBAAsB,KAAK,CAAC,IAAI,EAAE;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,SAAS,CAAA;IACpC,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,iBA0uCA"}
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../src/cli/build.ts"],"names":[],"mappings":"AA4UA,wBAAsB,KAAK,CAAC,IAAI,EAAE;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,SAAS,CAAA;IACpC,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,iBA2uCA"}

package/types/typed-routes/generateRouteTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generateRouteTypes.d.ts","sourceRoot":"","sources":["../../src/typed-routes/generateRouteTypes.ts"],"names":[],"mappings":"AAWA,wBAAsB,kBAAkB,CACtC,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,iBAAiB,CAAC,EAAE,MAAM,EAAE,EAC5B,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,iBA8DrC"}
+{"version":3,"file":"generateRouteTypes.d.ts","sourceRoot":"","sources":["../../src/typed-routes/generateRouteTypes.ts"],"names":[],"mappings":"AAWA,wBAAsB,kBAAkB,CACtC,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,iBAAiB,CAAC,EAAE,MAAM,EAAE,EAC5B,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,iBAyErC"}

package/types/typed-routes/generateRouteTypes.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=generateRouteTypes.test.d.ts.map

package/types/typed-routes/generateRouteTypes.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateRouteTypes.test.d.ts","sourceRoot":"","sources":["../../src/typed-routes/generateRouteTypes.test.ts"],"names":[],"mappings":""}

package/types/typed-routes/getTypedRoutesDeclarationFile.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=getTypedRoutesDeclarationFile.test.d.ts.map

package/types/typed-routes/getTypedRoutesDeclarationFile.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getTypedRoutesDeclarationFile.test.d.ts","sourceRoot":"","sources":["../../src/typed-routes/getTypedRoutesDeclarationFile.test.ts"],"names":[],"mappings":""}

package/types/utils/routeFileWatch.d.ts

@@ -0,0 +1,9 @@
+export declare function isRouteFilePath(filePath: string): boolean;
+export declare function isPathInsideDirectory(filePath: string, directory: string): boolean;
+export declare function isRouteFileWatchEvent({ event, filePath, routerRoot, includeChangeEvents, }: {
+    event: string;
+    filePath: string;
+    routerRoot: string;
+    includeChangeEvents?: boolean;
+}): boolean;
+//# sourceMappingURL=routeFileWatch.d.ts.map

package/types/utils/routeFileWatch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routeFileWatch.d.ts","sourceRoot":"","sources":["../../src/utils/routeFileWatch.ts"],"names":[],"mappings":"AAIA,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,WAE/C;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,WAOxE;AAED,wBAAgB,qBAAqB,CAAC,EACpC,KAAK,EACL,QAAQ,EACR,UAAU,EACV,mBAA2B,GAC5B,EAAE;IACD,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B,WAYA"}

package/types/utils/routeFileWatch.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=routeFileWatch.test.d.ts.map

package/types/utils/routeFileWatch.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routeFileWatch.test.d.ts","sourceRoot":"","sources":["../../src/utils/routeFileWatch.test.ts"],"names":[],"mappings":""}

package/types/vite/plugins/fileSystemRouterPlugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fileSystemRouterPlugin.d.ts","sourceRoot":"","sources":["../../../src/vite/plugins/fileSystemRouterPlugin.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAW,MAAM,EAAiB,MAAM,MAAM,CAAA;AAe1D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAiB3C,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,GAAG,CAAC,aAAa,GAAG,MAAM,CA8tB/E"}
+{"version":3,"file":"fileSystemRouterPlugin.d.ts","sourceRoot":"","sources":["../../../src/vite/plugins/fileSystemRouterPlugin.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAW,MAAM,EAAiB,MAAM,MAAM,CAAA;AAgB1D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAiB3C,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,GAAG,CAAC,aAAa,GAAG,MAAM,CAquB/E"}

package/types/vite/plugins/fileSystemRouterPlugin.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=fileSystemRouterPlugin.test.d.ts.map

package/types/vite/plugins/fileSystemRouterPlugin.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileSystemRouterPlugin.test.d.ts","sourceRoot":"","sources":["../../../src/vite/plugins/fileSystemRouterPlugin.test.ts"],"names":[],"mappings":""}

package/types/vite/plugins/generateFileSystemRouteTypesPlugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generateFileSystemRouteTypesPlugin.d.ts","sourceRoot":"","sources":["../../../src/vite/plugins/generateFileSystemRouteTypesPlugin.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAGlC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAEnC,wBAAgB,kCAAkC,CAAC,OAAO,EAAE,GAAG,CAAC,aAAa,GAAG,MAAM,CAkDrF"}
+{"version":3,"file":"generateFileSystemRouteTypesPlugin.d.ts","sourceRoot":"","sources":["../../../src/vite/plugins/generateFileSystemRouteTypesPlugin.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAIlC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAEnC,wBAAgB,kCAAkC,CAAC,OAAO,EAAE,GAAG,CAAC,aAAa,GAAG,MAAM,CAgDrF"}