fix: handle enabled: false mocks properly

Fixes harlan-zw/nuxt-seo#501

Author: harlan-zw

src/module.ts

@@ -232,6 +232,7 @@ export default defineNuxtModule<ModuleOptions>({
       logger.debug('The module is disabled, skipping setup.')
       // need to mock the composables to allow module still to work when disabled
       addImports({ name: 'useRobotsRule', from: resolve(`./runtime/app/composables/mock`) })
+      addImports({ name: 'useBotDetection', from: resolve(`./runtime/app/composables/mock`) })
       nuxt.options.nitro = nuxt.options.nitro || {}
       nuxt.options.nitro.imports = nuxt.options.nitro.imports || {}
       nuxt.options.nitro.imports.presets = nuxt.options.nitro.imports.presets || []
@@ -240,6 +241,9 @@ export default defineNuxtModule<ModuleOptions>({
         imports: [
           'getPathRobotConfig',
           'getSiteRobotConfig',
+          'getBotDetection',
+          'isBot',
+          'getBotInfo',
         ],
       })
       return

test/e2e/disabled.test.ts

@@ -0,0 +1,25 @@
+import { createResolver } from '@nuxt/kit'
+import { $fetch, setup } from '@nuxt/test-utils'
+import { describe, expect, it } from 'vitest'
+
+const { resolve } = createResolver(import.meta.url)
+
+process.env.NODE_ENV = 'production'
+
+await setup({
+  rootDir: resolve('../fixtures/disabled'),
+  build: true,
+})
+
+describe('disabled module', () => {
+  it('should not crash when module is disabled', async () => {
+    const html = await $fetch('/')
+    expect(html).toContain('Disabled Module Test')
+    expect(html).toContain('Module is disabled')
+  })
+
+  it('should not have robots.txt when disabled', async () => {
+    // The module should not add the robots.txt route when disabled
+    await expect($fetch('/robots.txt')).rejects.toThrow()
+  })
+})

test/fixtures/disabled/nuxt.config.ts

@@ -0,0 +1,13 @@
+import NuxtRobots from '../../../src/module'
+
+export default defineNuxtConfig({
+  modules: [
+    NuxtRobots,
+  ],
+  robots: {
+    enabled: false,
+  },
+  site: {
+    url: 'https://example.com',
+  },
+})

test/fixtures/disabled/pages/index.vue

@@ -0,0 +1,6 @@
+<template>
+  <div>
+    <h1>Disabled Module Test</h1>
+    <p>Module is disabled</p>
+  </div>
+</template>

test/fixtures/disabled/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../../.nuxt/tsconfig.json"
+}

test/unit/mocks.test.ts

@@ -0,0 +1,44 @@
+import { describe, expect, it } from 'vitest'
+
+describe('mock composables', () => {
+  it('app mocks should export correctly', async () => {
+    const mocks = await import('../../src/runtime/app/composables/mock')
+
+    expect(mocks.useRobotsRule).toBeDefined()
+    expect(mocks.useBotDetection).toBeDefined()
+
+    // Test that they return expected mock values
+    const robotRule = mocks.useRobotsRule()
+    expect(robotRule.value).toBe('')
+
+    const botDetection = mocks.useBotDetection()
+    expect(botDetection.isBot.value).toBe(false)
+    expect(botDetection.botName.value).toBeUndefined()
+  })
+
+  it('server mocks should export correctly', async () => {
+    const mocks = await import('../../src/runtime/server/mock-composables')
+
+    expect(mocks.getPathRobotConfig).toBeDefined()
+    expect(mocks.getSiteRobotConfig).toBeDefined()
+    expect(mocks.getBotDetection).toBeDefined()
+    expect(mocks.isBot).toBeDefined()
+    expect(mocks.getBotInfo).toBeDefined()
+
+    // Test that they return expected mock values
+    const pathConfig = mocks.getPathRobotConfig({} as any)
+    expect(pathConfig).toEqual({ indexable: true, rule: '' })
+
+    const siteConfig = mocks.getSiteRobotConfig({} as any)
+    expect(siteConfig).toEqual({ indexable: true, hints: [] })
+
+    const botDetection = mocks.getBotDetection({} as any)
+    expect(botDetection).toEqual({ isBot: false })
+
+    const isBotResult = mocks.isBot({} as any)
+    expect(isBotResult).toBe(false)
+
+    const botInfo = mocks.getBotInfo({} as any)
+    expect(botInfo).toBeNull()
+  })
+})