fix: Fixed e2e tests. (#411)

packages/docs/next.config.mjs

@@ -0,0 +1,14 @@
+import nextra from 'nextra'
+import {nodeTypes} from '@mdx-js/mdx'
+import rehypeRaw from 'rehype-raw'
+
+const withNextra = nextra({
+  theme: 'nextra-theme-docs',
+  themeConfig: './theme.config.jsx',
+  mdxOptions: {
+    // See: https://github.com/mdx-js/mdx/issues/1820
+    rehypePlugins: [[rehypeRaw, { passThrough: nodeTypes }]]
+  }
+})
+
+export default withNextra()

packages/docs/package.json

@@ -13,6 +13,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "@mdx-js/mdx": "^2.3.0",
     "@orama/orama": "workspace:*",
     "@orama/plugin-match-highlight": "workspace:*",
     "@orama/plugin-nextra": "workspace:*",
@@ -22,6 +23,7 @@
     "nextra-theme-docs": "^2.2.19",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "react-icons": "^4.8.0"
+    "react-icons": "^4.8.0",
+    "rehype-raw": "^6.1.1"
   }
 }

packages/orama/package.json

@@ -42,7 +42,8 @@
     "test": "c8 -c tests/config/c8-local.json tap --rcfile=tests/config/tap.yml tests/*.test.ts",
     "test:ci": "c8 -c tests/config/c8-ci.json tap --rcfile=tests/config/tap.yml --no-color tests/*.test.ts",
     "test:smoke": "tap --rcfile=tests/config/tap.yml tests/smoke/*.test.ts",
-    "ci": "npm run build && npm run test:ci && npm run test:smoke"
+    "ci": "npm run build && npm run test:ci && npm run test:smoke",
+    "pack": "pnpm pack --pack-destination ../../dist"
   },
   "keywords": [
     "full-text search",

packages/plugin-astro/package.json

@@ -37,7 +37,8 @@
     "build": "swc --delete-dir-on-start --extensions .ts -d dist src",
     "postbuild": "tsc -p . --emitDeclarationOnly",
     "test": "node --loader=tsx --no-warnings=loader --test ./test/integration.ts | tap-mocha-reporter spec",
-    "lint": "eslint src --ext .js,.ts,.tsx,.cts"
+    "lint": "eslint src --ext .js,.ts,.tsx,.cts",
+    "pack": "pnpm pack --pack-destination ../../dist"
   },
   "dependencies": {
     "@orama/orama": "workspace:*",

packages/plugin-astro/test/integration.ts

@@ -2,7 +2,7 @@ import { create as createOramaDB, load as loadOramaDB, Schema, search } from '@o
 import assert from 'node:assert'
 import { exec, ExecException } from 'node:child_process'
 import { existsSync } from 'node:fs'
-import { cp, readFile, rm } from 'node:fs/promises'
+import { cp, readFile, rm, writeFile } from 'node:fs/promises'
 import { tmpdir } from 'node:os'
 import { dirname, resolve } from 'node:path'
 import { chdir } from 'node:process'
@@ -17,7 +17,7 @@ interface Execution {
 }
 
 const sandboxSource = fileURLToPath(new URL('./sandbox', import.meta.url))
-const sandbox = resolve(tmpdir(), `orama-plugin-astro-${Date.now()}`)
+const sandbox = process.env.KEEP_SANDBOX ? '/tmp/orama-astro-sandbox' : resolve(tmpdir(), `orama-plugin-astro-${Date.now()}`)
 
 async function cleanup(): Promise<void> {
   await rm(sandbox, { force: true, recursive: true })
@@ -50,20 +50,22 @@ async function execute(command: string, cwd?: string): Promise<Execution> {
 await cleanup()
 
 await test('plugin is able to generate orama DB at build time', async () => {
-  // Prepare the plugin
+  // Obtain general information
   const pluginInfo: Record<string, string> = JSON.parse(
-    await readFile(fileURLToPath(new URL(`../package.json`, import.meta.url)), 'utf-8')
+    await readFile(fileURLToPath(new URL('../package.json', import.meta.url)), 'utf-8')
   )
-  const pluginPath = fileURLToPath(new URL(`../orama-plugin-astro-${pluginInfo.version}.tgz`, import.meta.url))
-  const packResult = await execute('pnpm pack')
-  assert.equal(packResult.code, 0)
+  const rootDir = dirname(fileURLToPath(new URL(`../..`, import.meta.url)))
+  const version = pluginInfo.version
 
   // Prepare the sandbox
+  const packageJsonPath = resolve(sandbox, 'package.json')
   await cp(sandboxSource, sandbox, { recursive: true })
-  await cp(pluginPath, resolve(sandbox, 'plugin.tgz'))
-  await rm(pluginPath)
-
   chdir(sandbox)
+  console.log(`Sandbox created in ${sandbox}`)
+
+  // Update dependencies location
+  const packageJson = await readFile(packageJsonPath, 'utf-8')
+  await writeFile(packageJsonPath, packageJson.replace(/@ROOT@/g, rootDir).replace(/@VERSION@/g, version), 'utf-8')
 
   // Install dependencies
   const installResult = await execute('pnpm install', sandbox)
@@ -129,4 +131,7 @@ await test('generated DBs have indexed pages content', async () => {
   assert.ok(dynamicTestMissingSearchResult.count === 0)
 })
 
-await cleanup()
+if(!process.env.KEEP_SANDBOX) {
+  await cleanup()
+}
+

packages/plugin-astro/test/sandbox/package.json

@@ -1,14 +1,20 @@
 {
   "name": "@orama/plugin-astro-sandbox",
   "type": "module",
-  "version": "1.0.0-beta.4",
+  "version": "@VERSION@",
   "private": true,
   "scripts": {
     "build": "exit 0",
     "test": "exit 0"
   },
   "dependencies": {
-    "@orama/plugin-astro": "./plugin.tgz",
+    "@orama/plugin-astro": "^@VERSION@",
     "astro": "^2.0.2"
+  },
+  "pnpm": {
+    "overrides": {
+      "@orama/orama": "@ROOT@/dist/orama-orama-@[email protected]",
+      "@orama/plugin-astro": "@ROOT@/dist/orama-plugin-astro-@[email protected]"
+    }
   }
 }

packages/plugin-docusaurus/package.json

@@ -36,7 +36,8 @@
     "test": "node --loader=tsx --no-warnings=loader --test ./test/integration.ts | tap-mocha-reporter spec",
     "format": "prettier -w src",
     "lint": "eslint src --ext .js,.ts,.tsx,.cts",
-    "changelog": "auto-changelog -p"
+    "changelog": "auto-changelog -p",
+    "pack": "pnpm pack --pack-destination ../../dist"
   },
   "dependencies": {
     "@algolia/autocomplete-js": "^1.7.2",

packages/plugin-docusaurus/test/integration.ts

@@ -1,9 +1,9 @@
 import assert from 'node:assert'
 import { exec, ExecException } from 'node:child_process'
 import { existsSync } from 'node:fs'
-import { cp, readdir, readFile, rm } from 'node:fs/promises'
+import { cp, readdir, readFile, rm, writeFile } from 'node:fs/promises'
 import { tmpdir } from 'node:os'
-import { resolve } from 'node:path'
+import { dirname, resolve } from 'node:path'
 import { chdir } from 'node:process'
 import { test } from 'node:test'
 import { fileURLToPath } from 'node:url'
@@ -21,7 +21,7 @@ interface Execution {
 }
 
 const sandboxSource = fileURLToPath(new URL('./sandbox', import.meta.url))
-const sandbox = resolve(tmpdir(), `orama-plugin-docusaurus-${Date.now()}`)
+const sandbox = process.env.KEEP_SANDBOX ? '/tmp/orama-docusaurus-sandbox' : resolve(tmpdir(), `orama-plugin-docusaurus-${Date.now()}`)
 
 async function cleanup(): Promise<void> {
   await rm(sandbox, { force: true, recursive: true })
@@ -58,23 +58,25 @@ async function execute(command: string, cwd?: string): Promise<Execution> {
 await cleanup()
 
 await test('plugin is able to generate orama DB at build time', async () => {
-  // Prepare the plugin
+  // Obtain general information
   const pluginInfo: Record<string, string> = JSON.parse(
     await readFile(fileURLToPath(new URL('../package.json', import.meta.url)), 'utf-8')
   )
-  const pluginPath = fileURLToPath(new URL(`../orama-plugin-docusaurus-${pluginInfo.version}.tgz`, import.meta.url))
-  const packResult = await execute('pnpm pack')
-  assert.equal(packResult.code, 0)
+  const rootDir = dirname(fileURLToPath(new URL(`../..`, import.meta.url)))
+  const version = pluginInfo.version
 
   // Prepare the sandbox
+  const packageJsonPath = resolve(sandbox, 'package.json')
   await cp(sandboxSource, sandbox, { recursive: true })
-  await cp(pluginPath, resolve(sandbox, 'plugin.tgz'))
-  await rm(pluginPath)
-
   chdir(sandbox)
+  console.log(`Sandbox created in ${sandbox}`)
+
+  // Update dependencies location
+  const packageJson = await readFile(packageJsonPath, 'utf-8')
+  await writeFile(packageJsonPath, packageJson.replace(/@ROOT@/g, rootDir).replace(/@VERSION@/g, version), 'utf-8')
 
   // Install dependencies
-  const installResult = await execute('npm install', sandbox)
+  const installResult = await execute('pnpm install', sandbox)
   assert.equal(installResult.code, 0)
 
   // docusaurus build is successful
@@ -118,4 +120,6 @@ await test('generated DBs have indexed pages content', async () => {
   assert.ok(turtleSearchResult.count === 0)
 })
 
-await cleanup()
+if(!process.env.KEEP_SANDBOX) {
+  await cleanup()
+}

packages/plugin-docusaurus/test/sandbox/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orama/plugin-docusaurus-sandbox",
-  "version": "1.0.0-beta.4",
+  "version": "@VERSION@",
   "private": true,
   "scripts": {
     "build": "exit 0",
@@ -10,9 +10,52 @@
     "@docusaurus/core": "^2.3.1",
     "@docusaurus/preset-classic": "^2.3.1",
     "@docusaurus/theme-common": "^2.2.0",
+    "@docusaurus/types": "^2.4.1",
     "@mdx-js/react": "^1.6.22",
-    "@orama/plugin-docusaurus": "./plugin.tgz",
+    "@orama/plugin-docusaurus": "^@VERSION@",
     "react": "^17.0.2",
     "react-dom": "^17.0.2"
+  },
+  "pnpm": {
+    "overrides": {
+      "@orama/orama": "@ROOT@/dist/orama-orama-@[email protected]",
+      "@orama/plugin-docusaurus": "@ROOT@/dist/orama-plugin-docusaurus-@[email protected]",
+      "@orama/plugin-match-highlight": "@ROOT@/dist/orama-plugin-match-highlight-@[email protected]",
+      "@orama/plugin-parsedoc": "@ROOT@/dist/orama-plugin-parsedoc-@[email protected]"
+    },
+    "packageExtensions": {
+      "@docusaurus/theme-live-codeblock": {
+        "peerDependencies": {
+          "@docusaurus/theme-common": "*"
+        },
+        "dependencies": {
+          "@docusaurus/theme-common": "*"
+        }
+      },
+      "@docusaurus/preset-classic": {
+        "peerDependencies": {
+          "@docusaurus/theme-common": "*"
+        },
+        "dependencies": {
+          "@docusaurus/theme-common": "*"
+        }
+      },
+      "@docusaurus/theme-classic": {
+        "peerDependencies": {
+          "@docusaurus/theme-common": "*"
+        },
+        "dependencies": {
+          "@docusaurus/theme-common": "*"
+        }
+      },
+      "@docusaurus/theme-search-algolia": {
+        "peerDependencies": {
+          "@docusaurus/theme-common": "*"
+        },
+        "dependencies": {
+          "@docusaurus/theme-common": "*"
+        }
+      }
+    }
   }
 }

packages/plugin-match-highlight/package.json

@@ -35,7 +35,8 @@
     "dev": "swc --delete-dir-on-start -s -w --extensions .ts,.cts -d dist src",
     "build": "swc --delete-dir-on-start --extensions .ts,.cts -d dist src",
     "postbuild": "tsc -p . --emitDeclarationOnly && tsc -p tsconfig.cjs.json --emitDeclarationOnly && mv dist/commonjs.js dist/commonjs.cjs && mv dist/commonjs.js.map dist/commonjs.cjs.map",
-    "test": "c8 -c test/config/c8.json tap --rcfile=test/config/tap.yml test/*.test.ts"
+    "test": "c8 -c test/config/c8.json tap --rcfile=test/config/tap.yml test/*.test.ts",
+    "pack": "pnpm pack --pack-destination ../../dist"
   },
   "dependencies": {
     "@orama/orama": "workspace:*"

packages/plugin-parsedoc/package.json

@@ -31,7 +31,8 @@
     "dev": "swc --delete-dir-on-start -s -w --extensions .ts,.cts -d dist src",
     "build": "swc --delete-dir-on-start --extensions .ts,.cts -d dist src",
     "postbuild": "tsc -p . --emitDeclarationOnly && tsc -p tsconfig.cjs.json --emitDeclarationOnly && mv dist/commonjs.js dist/commonjs.cjs && mv dist/commonjs.js.map dist/commonjs.cjs.map",
-    "test": "c8 -c test/config/c8.json tap --rcfile=test/config/tap.yml test/*.test.ts"
+    "test": "c8 -c test/config/c8.json tap --rcfile=test/config/tap.yml test/*.test.ts",
+    "pack": "pnpm pack --pack-destination ../../dist"
   },
   "dependencies": {
     "@orama/orama": "workspace:*",