refactor: use /ce-api prefix and add 404 error page to playground (#292)

* refactor: use /ce-api prefix and add 404 error page to playground

* restore layout test

* fix tests

playground/layouts/clear.vue

@@ -1,5 +1,6 @@
 <template>
   <div id="main-clear">
+    <h1>Clear layout</h1>
     <slot />
   </div>
 </template>

playground/nuxt.config.ts

@@ -8,7 +8,7 @@ export default defineNuxtConfig({
   compatibilityDate: '2024-12-16',
   drupalCe: {
     drupalBaseUrl: 'http://127.0.0.1:3000',
-    ceApiEndpoint: '/api',
+    ceApiEndpoint: '/ce-api',
   },
   i18n: {
     locales: ['en', 'de'],

playground/nuxt.config4test.ts

@@ -7,6 +7,6 @@ export default defineNuxtConfig({
   ],
   drupalCe: {
     drupalBaseUrl: 'http://127.0.0.1:3001',
-    ceApiEndpoint: '/api',
+    ceApiEndpoint: '/ce-api',
   },
 })

playground/server/routes/ce-api/[...].ts

@@ -0,0 +1,25 @@
+import { eventHandler, getRequestURL, setResponseStatus } from 'h3'
+// Catch-all handler for  /ce-api/* paths - avoids 404 endless loops.
+
+export default eventHandler((event) => {
+  const url = getRequestURL(event)
+  setResponseStatus(event, 404)
+  return {
+    title: 'Not found',
+    messages: [],
+    breadcrumbs: [],
+    metatags: {
+      meta: [
+        { name: 'title', content: 'Not found' }
+      ],
+      link: []
+    },
+    content_format: 'json',
+    content: {
+      element: 'drupal-markup',
+      content: `API endpoint ${url.pathname} not found.`
+    },
+    page_layout: 'default',
+    local_tasks: []
+  }
+})

playground/server/routes/ce-api/node/3.ts

@@ -0,0 +1,34 @@
+export default defineEventHandler(() => ({
+  title: 'Another page',
+  messages: [],
+  breadcrumbs: [],
+  metatags: {
+    meta: [{name: 'title', content: 'Another page | lupus decoupled'}, {
+      name: 'description',
+      content: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Arcu dictum varius duis at consectetur. Aliquam purus sit amet luctus. Varius morbi enim nunc faucibus a pellentesque sit. Vel facilisis volutpat est velit egestas dui id ornare arcu. Ut pharetra sit amet aliquam id diam maecenas. Quis commodo odio aenean sed adipiscing diam donec. Velit scelerisque in dictum non consectetur. Ultrices eros in cursus turpis massa. Amet volutpat consequat mauris nunc congue nisi vitae.'
+    }],
+    link: [{
+      rel: 'canonical',
+      href: 'https:\/\/8080-drunomics-lupusdecouple-fd0ilwlpax7.ws-eu84.gitpod.io\/node\/3'
+    }, {
+      rel: 'alternate',
+      hreflang: 'de',
+      href: 'https:\/\/8080-drunomics-lupusdecouple-fd0ilwlpax7.ws-eu84.gitpod.io\/de\/node\/3'
+    }, {
+      rel: 'alternate',
+      hreflang: 'en',
+      href: 'https:\/\/8080-drunomics-lupusdecouple-fd0ilwlpax7.ws-eu84.gitpod.io\/node\/3'
+    }]
+  },
+  content_format: 'json',
+  content: {
+    element: 'node',
+    type: 'page',
+    uid: '1',
+    title: 'Another page',
+    created: '1674823558',
+    body: '\u003Cp\u003ELorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Arcu dictum varius duis at consectetur. Aliquam purus sit amet luctus. Varius morbi enim nunc faucibus a pellentesque sit. Vel facilisis volutpat est velit egestas dui id ornare arcu. Ut pharetra sit amet aliquam id diam maecenas. Quis commodo odio aenean sed adipiscing diam donec. Velit scelerisque in dictum non consectetur. Ultrices eros in cursus turpis massa. Amet volutpat consequat mauris nunc congue nisi vitae. Turpis nunc eget lorem dolor sed viverra ipsum nunc aliquet. Tempus egestas sed sed risus pretium quam. Odio eu feugiat pretium nibh ipsum. Posuere sollicitudin aliquam ultrices sagittis orci. Convallis posuere morbi leo urna molestie. Porttitor rhoncus dolor purus non enim praesent. Mi tempus imperdiet nulla malesuada.\u003C\/p\u003E'
+  },
+  page_layout: 'clear',
+  local_tasks: [],
+}))

test/addRequestContentFormat/json.test.ts

@@ -12,7 +12,7 @@ describe('Module addRequestContentFormat option set to json', async () => {
       ],
       drupalCe: {
         drupalBaseUrl: 'http://127.0.0.1:3100',
-        ceApiEndpoint: '/api',
+        ceApiEndpoint: '/ce-api',
         addRequestContentFormat: 'json',
       },
     },

test/addRequestContentFormat/markup.test.ts

@@ -12,7 +12,7 @@ describe('Module addRequestContentFormat set to markup', async () => {
       ],
       drupalCe: {
         drupalBaseUrl: 'http://127.0.0.1:3101',
-        ceApiEndpoint: '/api',
+        ceApiEndpoint: '/ce-api',
         addRequestContentFormat: 'markup',
       },
     },

test/addRequestContentFormat/unset.test.ts

@@ -12,7 +12,7 @@ describe('Module addRequestContentFormat not set', async () => {
       ],
       drupalCe: {
         drupalBaseUrl: 'http://127.0.0.1:3102',
-        ceApiEndpoint: '/api',
+        ceApiEndpoint: '/ce-api',
       },
     },
     port: 3102,

test/addRequestFormat/set.test.ts

@@ -12,7 +12,7 @@ describe('Module addRequestFormat option set to true', async () => {
       ],
       drupalCe: {
         drupalBaseUrl: 'http://127.0.0.1:3200',
-        ceApiEndpoint: '/api',
+        ceApiEndpoint: '/ce-api',
         addRequestFormat: true,
       },
     },

test/addRequestFormat/unset.test.ts

@@ -12,7 +12,7 @@ describe('Module addRequestFormat not set', async () => {
       ],
       drupalCe: {
         drupalBaseUrl: 'http://127.0.0.1:3201',
-        ceApiEndpoint: '/api',
+        ceApiEndpoint: '/ce-api',
       },
     },
     port: 3201,

test/basicWithoutProxy.test.ts

@@ -12,7 +12,7 @@ describe('Site works with serverApiProxy disabled', async () => {
       ],
       drupalCe: {
         drupalBaseUrl: 'http://127.0.0.1:3002',
-        ceApiEndpoint: '/api',
+        ceApiEndpoint: '/ce-api',
         serverApiProxy: false,
       },
     },

test/i18n.test.ts

@@ -13,7 +13,7 @@ describe('Module @nuxtjs/i18n integration works', async () => {
       ],
       drupalCe: {
         drupalBaseUrl: 'http://127.0.0.1:3004',
-        ceApiEndpoint: '/api',
+        ceApiEndpoint: '/ce-api',
         serverApiProxy: true,
       },
       i18n: {

test/i18nWithoutProxy.test.ts

@@ -13,7 +13,7 @@ describe('Module @nuxtjs/i18n integration works', async () => {
       ],
       drupalCe: {
         drupalBaseUrl: 'http://127.0.0.1:3003',
-        ceApiEndpoint: '/api',
+        ceApiEndpoint: '/ce-api',
         serverApiProxy: false,
       },
       i18n: {

test/unit/components/preview.test.ts

@@ -4,7 +4,7 @@ import { mountSuspended, registerEndpoint } from '@nuxt/test-utils/runtime'
 import App from '~/app.vue'
 
 describe('Preview routes', () => {
-  registerEndpoint('http://127.0.0.1:3001/api/preview/node', () => ({
+  registerEndpoint('http://127.0.0.1:3001/ce-api/preview/node', () => ({
     content: {
       element: 'node-article',
       body: '<p>Some <b>example</b> body.</p>'
@@ -14,7 +14,7 @@ describe('Preview routes', () => {
     metatags: { meta: [], link: [], jsonld: [] }
   }))
 
-  registerEndpoint('http://127.0.0.1:3001/api/node/5/layout-preview', () => ({
+  registerEndpoint('http://127.0.0.1:3001/ce-api/node/5/layout-preview', () => ({
     content: {
       element: 'node-article',
       body: '<p>Some <b>example</b> body.</p>'

test/unit/fetchPageAndMenu.test.ts

@@ -15,13 +15,13 @@ describe('fetchPage and fetchMenu use the right API endpoints', () => {
     registerEndpoint('/api/drupal-ce/test-page', () => ({
       content: { title: 'Via Proxy' }
     }))
-    registerEndpoint('http://127.0.0.1:3001/api/test-page', () => ({
+    registerEndpoint('http://127.0.0.1:3001/ce-api/test-page', () => ({
       content: { title: 'Direct API' }
     }))
     registerEndpoint('/api/menu/api/menu_items/main', () => ({
       items: [{ title: 'Via Proxy Menu' }]
     }))
-    registerEndpoint('http://127.0.0.1:3001/api/api/menu_items/main', () => ({
+    registerEndpoint('http://127.0.0.1:3001/ce-api/api/menu_items/main', () => ({
       items: [{ title: 'Direct API Menu' }]
     }))
   })
@@ -69,7 +69,7 @@ describe('fetchPage and fetchMenu use the right API endpoints', () => {
         registerEndpoint('/api/menu/fr/api/menu_items/main', () => ({
           items: [{ title: 'Via Proxy Menu FR' }]
         }))
-        registerEndpoint('http://127.0.0.1:3001/api/fr/api/menu_items/main', () => ({
+        registerEndpoint('http://127.0.0.1:3001/ce-api/fr/api/menu_items/main', () => ({
           items: [{ title: 'Direct API Menu FR' }]
         }))
       })

vitest.config.ts

@@ -12,7 +12,7 @@ export default defineVitestConfig({
           modules: ['../dist/module.mjs'],
           drupalCe: {
             drupalBaseUrl: 'http://127.0.0.1:3001',
-            ceApiEndpoint: '/api',
+            ceApiEndpoint: '/ce-api',
           }
         }
       }