test: improve tests and integrity (#163)

farnabaz · web-flow · commit 016c339d34af · 2024-06-12T12:40:46.000+02:00
diff --git a/src/features.ts b/src/features.ts
@@ -98,7 +98,7 @@ export function setupOpenAPI(nuxt: Nuxt) {
   // Fallback to custom placeholder when openAPI is disabled
   nuxt.options.alias['#hub/openapi'] = nuxt.options.nitro?.experimental?.openAPI === true
     ? '#internal/nitro/routes/openapi'
-    : resolve('./runtime/openapi/templates/openapi')
+    : resolve('./runtime/openapi/server/templates/openapi')
 
   addServerScanDir(resolve('./runtime/openapi/server'))
 }
diff --git a/src/module.ts b/src/module.ts
@@ -9,6 +9,7 @@ import { version } from '../package.json'
 import { generateWrangler } from './utils/wrangler'
 import { setupCache, setupAnalytics, setupBlob, setupOpenAPI, setupDatabase, setupKV, setupBase, setupRemote } from './features'
 import type { ModuleOptions } from './types/module'
+import { addBuildHooks } from './utils/build'
 
 export * from './types'
 
@@ -85,6 +86,8 @@ export default defineNuxtModule<ModuleOptions>({
       return
     }
 
+    addBuildHooks(nuxt, hub)
+
     if (hub.remote) {
       await setupRemote(nuxt, hub)
       return
diff --git a/src/runtime/base/server/api/_hub/manifest.get.ts b/src/runtime/base/server/api/_hub/manifest.get.ts
@@ -7,7 +7,7 @@ import { useRuntimeConfig } from '#imports'
 
 export default eventHandler(async (event) => {
   await requireNuxtHubAuthorization(event)
-  const { version, cache, blob, kv, database } = useRuntimeConfig().hub
+  const { version, cache, analytics, blob, kv, database } = useRuntimeConfig().hub
   const [dbCheck, kvCheck, blobCheck] = await Promise.all([
     falseIfFail(() => database && hubDatabase().exec('PRAGMA table_list')),
     falseIfFail(() => kv && hubKV().getKeys('__check__')),
@@ -22,6 +22,7 @@ export default eventHandler(async (event) => {
       blob: Array.isArray(blobCheck?.blobs)
     },
     features: {
+      analytics,
       cache
     }
   }
diff --git a/src/runtime/openapi/server/api/_hub/openapi.get.ts b/src/runtime/openapi/server/api/_hub/openapi.get.ts
diff --git a/src/runtime/openapi/server/templates/openapi.ts b/src/runtime/openapi/server/templates/openapi.ts
diff --git a/test/analytics.test.ts b/test/analytics.test.ts
@@ -0,0 +1,25 @@
+import { fileURLToPath } from 'node:url'
+import { describe, it, expect } from 'vitest'
+import { setup, $fetch } from '@nuxt/test-utils'
+
+describe('Analytics', async () => {
+  await setup({
+    rootDir: fileURLToPath(new URL('./fixtures/analytics', import.meta.url)),
+    dev: true
+  })
+
+  it('Check manifest (Analytics is enabled)', async () => {
+    const manifest = await $fetch('/api/_hub/manifest')
+    expect(manifest).toMatchObject({
+      storage: {
+        database: false,
+        kv: false,
+        blob: false
+      },
+      features: {
+        analytics: true,
+        cache: false
+      }
+    })
+  })
+})
diff --git a/test/basic.test.ts b/test/basic.test.ts
@@ -1,7 +1,6 @@
 import { fileURLToPath } from 'node:url'
 import { describe, it, expect } from 'vitest'
 import { setup, $fetch } from '@nuxt/test-utils/e2e'
-import { version } from '../package.json'
 
 describe('ssr', async () => {
   await setup({
@@ -12,7 +11,6 @@ describe('ssr', async () => {
   it('Fetch Hub manifetst', async () => {
     const manifest = await $fetch('/api/_hub/manifest')
     expect(manifest).toMatchObject({
-      version,
       storage: {
         database: false,
         kv: false,
diff --git a/test/blob.test.ts b/test/blob.test.ts
@@ -2,7 +2,6 @@ import { fileURLToPath } from 'node:url'
 import fs from 'node:fs/promises'
 import { describe, it, expect } from 'vitest'
 import { setup, $fetch, url } from '@nuxt/test-utils'
-import { version } from '../package.json'
 import type { BlobListResult } from '../src/types/blob'
 import { useUpload } from '../src/runtime/blob/app/composables/useUpload'
 import { useMultipartUpload } from '../src/runtime/blob/app/composables/useMultipartUpload'
@@ -35,7 +34,6 @@ describe('Blob', async () => {
   it('Check manifest (Blob is enabled)', async () => {
     const manifest = await $fetch('/api/_hub/manifest')
     expect(manifest).toMatchObject({
-      version,
       storage: {
         database: false,
         kv: false,
diff --git a/test/cache.test.ts b/test/cache.test.ts
@@ -2,7 +2,6 @@ import { fileURLToPath } from 'node:url'
 import fs from 'node:fs/promises'
 import { describe, it, expect } from 'vitest'
 import { setup, $fetch } from '@nuxt/test-utils'
-import { version } from '../package.json'
 
 const cacheListFields = ['duration', 'expires', 'integrity', 'key', 'mtime', 'size']
 
@@ -18,7 +17,6 @@ describe('KV', async () => {
   it('Check manifest (Cache is enabled)', async () => {
     const manifest = await $fetch('/api/_hub/manifest')
     expect(manifest).toMatchObject({
-      version,
       storage: {
         database: false,
         kv: false,
diff --git a/test/fixtures/analytics/app.vue b/test/fixtures/analytics/app.vue
@@ -0,0 +1,17 @@
+<script setup lang="ts">
+import { useFetch } from '#app'
+
+const { data: manifest } = useFetch<Record<string, any>>('/api/_hub/manifest')
+</script>
+
+<template>
+  <h3>Data storage enabled:</h3>
+  <ul>
+    <li
+      v-for="primitive in Object.keys(manifest?.storage || {})"
+      :key="primitive"
+    >
+      {{ primitive }}
+    </li>
+  </ul>
+</template>
diff --git a/test/fixtures/analytics/nuxt.config.ts b/test/fixtures/analytics/nuxt.config.ts
@@ -0,0 +1,10 @@
+import { defineNuxtConfig } from 'nuxt/config'
+
+export default defineNuxtConfig({
+  modules: [
+    '../../../src/module'
+  ],
+  hub: {
+    analytics: true
+  }
+})
diff --git a/test/fixtures/analytics/package.json b/test/fixtures/analytics/package.json
@@ -0,0 +1,5 @@
+{
+  "private": true,
+  "name": "hub-analytics-test",
+  "type": "module"
+}
diff --git a/test/fixtures/basic/package.json b/test/fixtures/basic/package.json
@@ -1,5 +1,5 @@
 {
   "private": true,
-  "name": "basic",
+  "name": "hub-basic-test",
   "type": "module"
 }
diff --git a/test/fixtures/blob/package.json b/test/fixtures/blob/package.json
@@ -1,5 +1,5 @@
 {
   "private": true,
-  "name": "basic",
+  "name": "hub-blob-test",
   "type": "module"
 }
diff --git a/test/fixtures/cache/package.json b/test/fixtures/cache/package.json
@@ -1,5 +1,5 @@
 {
   "private": true,
-  "name": "basic",
+  "name": "hub-cache-test",
   "type": "module"
 }
diff --git a/test/fixtures/kv/package.json b/test/fixtures/kv/package.json
@@ -1,5 +1,5 @@
 {
   "private": true,
-  "name": "basic",
+  "name": "hub-kv-test",
   "type": "module"
 }
diff --git a/test/fixtures/openapi/app.vue b/test/fixtures/openapi/app.vue
@@ -0,0 +1,17 @@
+<script setup lang="ts">
+import { useFetch } from '#app'
+
+const { data: manifest } = useFetch<Record<string, any>>('/api/_hub/manifest')
+</script>
+
+<template>
+  <h3>Data storage enabled:</h3>
+  <ul>
+    <li
+      v-for="primitive in Object.keys(manifest?.storage || {})"
+      :key="primitive"
+    >
+      {{ primitive }}
+    </li>
+  </ul>
+</template>
diff --git a/test/fixtures/openapi/nuxt.config.ts b/test/fixtures/openapi/nuxt.config.ts
@@ -0,0 +1,12 @@
+import { defineNuxtConfig } from 'nuxt/config'
+
+export default defineNuxtConfig({
+  modules: [
+    '../../../src/module'
+  ],
+  nitro: {
+    experimental: {
+      openAPI: true
+    }
+  }
+})
diff --git a/test/fixtures/openapi/package.json b/test/fixtures/openapi/package.json
@@ -0,0 +1,5 @@
+{
+  "private": true,
+  "name": "hub-openapi-test",
+  "type": "module"
+}
diff --git a/test/kv.test.ts b/test/kv.test.ts
@@ -2,7 +2,6 @@ import { fileURLToPath } from 'node:url'
 import fs from 'node:fs/promises'
 import { describe, it, expect } from 'vitest'
 import { setup, $fetch } from '@nuxt/test-utils'
-import { version } from '../package.json'
 
 describe('KV', async () => {
   let data: Record<string, any> = {
@@ -22,7 +21,6 @@ describe('KV', async () => {
   it('Check manifest (KV is enabled)', async () => {
     const manifest = await $fetch('/api/_hub/manifest')
     expect(manifest).toMatchObject({
-      version,
       storage: {
         database: false,
         kv: true,
diff --git a/test/openapi.test.ts b/test/openapi.test.ts
@@ -0,0 +1,28 @@
+import { fileURLToPath } from 'node:url'
+import { describe, it, expect } from 'vitest'
+import { setup, $fetch } from '@nuxt/test-utils'
+
+describe('Open API', async () => {
+  await setup({
+    rootDir: fileURLToPath(new URL('./fixtures/openapi', import.meta.url)),
+    dev: true
+  })
+
+  it('Fetch Open API JSON', async () => {
+    const manifest = await $fetch<any>('/api/_hub/openapi')
+    expect(manifest).toMatchObject({
+      openapi: '3.1.0',
+      info: {
+        title: 'Nitro Server Routes'
+      }
+    })
+
+    const routes = Object.keys(manifest.paths)
+    expect(routes).not.includes('/api/_hub/analytics')
+    expect(routes).not.includes('/api/_hub/blob')
+    expect(routes).not.includes('/api/_hub/cache')
+    expect(routes).not.includes('/api/_hub/kv/{path}')
+    // Should include fallback route
+    expect(routes).includes('/api/_hub/{feature}')
+  })
+})

Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ export function setupOpenAPI(nuxt: Nuxt) {`
`98`	`98`	`// Fallback to custom placeholder when openAPI is disabled`
`99`	`99`	`nuxt.options.alias['#hub/openapi'] = nuxt.options.nitro?.experimental?.openAPI === true`
`100`	`100`	`? '#internal/nitro/routes/openapi'`
`101`		`- : resolve('./runtime/openapi/templates/openapi')`
	`101`	`+ : resolve('./runtime/openapi/server/templates/openapi')`
`102`	`102`
`103`	`103`	`addServerScanDir(resolve('./runtime/openapi/server'))`
`104`	`104`	`}`