npm - @platformatic/next - Versions diffs - 2.0.0-alpha.5 - Mend

@platformatic/next 2.0.0-alpha.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (46) hide show

package/test/fixtures/next/composer-without-prefix/next.config.mjs ADDED Viewed

@@ -0,0 +1,3 @@
+export default function () {
+  return {}
+}

package/test/fixtures/next/composer-without-prefix/package.json ADDED Viewed

@@ -0,0 +1,15 @@
+{
+  "name": "next",
+  "private": true,
+  "version": "0.1.0",
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start"
+  },
+  "dependencies": {
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "next": "^14.2.5"
+  }
+}

package/test/fixtures/next/composer-without-prefix/platformatic.application.json ADDED Viewed

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/next/2.0.0.json",
+  "server": {
+    "logger": {
+      "level": "error"
+    }
+  }
+}

package/test/fixtures/next/composer-without-prefix/platformatic.runtime.json ADDED Viewed

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": false,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "error"
+    }
+  },
+  "services": [
+    {
+      "id": "frontend",
+      "path": ".",
+      "config": "platformatic.application.json"
+    },
+    { "id": "service", "config": "platformatic.service.json", "path": "../../platformatic-service" },
+    { "id": "main", "config": "platformatic.no-prefix.composer.json", "path": "../../platformatic-composer" }
+  ]
+}

package/test/fixtures/next/composer-without-prefix/src/app/layout.js ADDED Viewed

@@ -0,0 +1,7 @@
+export default function RootLayout ({ children }) {
+  return (
+    <html lang='en'>
+      <body>{children}</body>
+    </html>
+  )
+}

package/test/fixtures/next/composer-without-prefix/src/app/page.js ADDED Viewed

@@ -0,0 +1,5 @@
+import { version } from '../../../../../tmp/version.js'
+export default function Home () {
+  return <div>Hello from {version}</div>
+}

package/test/fixtures/next/server-side/next.config.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ module.exports = {}

package/test/fixtures/next/server-side/package.json ADDED Viewed

@@ -0,0 +1,15 @@
+{
+  "name": "next",
+  "private": true,
+  "version": "0.1.0",
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start"
+  },
+  "dependencies": {
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "next": "^14.2.5"
+  }
+}

package/test/fixtures/next/server-side/platformatic.application.json ADDED Viewed

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/next/2.0.0.json",
+  "server": {
+    "logger": {
+      "level": "error"
+    }
+  },
+  "application": {
+    "basePath": "/frontend"
+  }
+}

package/test/fixtures/next/server-side/platformatic.runtime.json ADDED Viewed

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": false,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "error"
+    }
+  },
+  "services": [
+    {
+      "id": "frontend",
+      "path": ".",
+      "config": "platformatic.application.json"
+    },
+    { "id": "service", "config": "platformatic.service.json", "path": "../../platformatic-service" },
+    { "id": "main", "config": "platformatic.composer.json", "path": "../../platformatic-composer" }
+  ]
+}

package/test/fixtures/next/server-side/src/app/direct/route.js ADDED Viewed

@@ -0,0 +1,3 @@
+export async function GET () {
+  return Response.json({ ok: true })
+}

package/test/fixtures/next/server-side/src/app/layout.js ADDED Viewed

@@ -0,0 +1,7 @@
+export default function RootLayout ({ children }) {
+  return (
+    <html lang='en'>
+      <body>{children}</body>
+    </html>
+  )
+}

package/test/fixtures/next/server-side/src/app/page.js ADDED Viewed

@@ -0,0 +1,12 @@
+import { version } from '../../../../../tmp/version.js'
+export default async function Home () {
+  const response = await fetch('http://service.plt.local/time')
+  const { time } = await response.json()
+  return (
+    <div>
+      Hello from v{version} t{time}
+    </div>
+  )
+}

package/test/fixtures/next/standalone/next.config.mjs ADDED Viewed

@@ -0,0 +1,3 @@
+const nextConfig = {}
+export default nextConfig

package/test/fixtures/next/standalone/package.json ADDED Viewed

@@ -0,0 +1,15 @@
+{
+  "name": "next",
+  "private": true,
+  "version": "0.1.0",
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start"
+  },
+  "dependencies": {
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "next": "^14.2.5"
+  }
+}

package/test/fixtures/next/standalone/platformatic.runtime.json ADDED Viewed

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": false,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "error"
+    }
+  },
+  "services": [
+    {
+      "id": "main",
+      "path": "."
+    }
+  ]
+}

package/test/fixtures/next/standalone/src/app/layout.js ADDED Viewed

@@ -0,0 +1,7 @@
+export default function RootLayout ({ children }) {
+  return (
+    <html lang='en'>
+      <body>{children}</body>
+    </html>
+  )
+}

package/test/fixtures/next/standalone/src/app/page.js ADDED Viewed

@@ -0,0 +1,5 @@
+import { version } from '../../../../../tmp/version.js'
+export default function Home () {
+  return <div>Hello from {version}</div>
+}

package/test/fixtures/platformatic-composer/platformatic.composer.json ADDED Viewed

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/composer/1.52.0.json",
+  "composer": {
+    "services": [
+      {
+        "id": "frontend"
+      },
+      {
+        "id": "service"
+      }
+    ]
+  },
+  "plugins": {
+    "paths": [
+      {
+        "path": "./plugin.js"
+      }
+    ]
+  }
+}

package/test/fixtures/platformatic-composer/platformatic.no-prefix.composer.json ADDED Viewed

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/composer/1.52.0.json",
+  "composer": {
+    "services": [
+      {
+        "id": "frontend",
+        "proxy": {
+          "prefix": ""
+        }
+      },
+      {
+        "id": "service"
+      }
+    ]
+  },
+  "plugins": {
+    "paths": [
+      {
+        "path": "./plugin.js"
+      }
+    ]
+  }
+}

package/test/fixtures/platformatic-composer/plugin.js ADDED Viewed

@@ -0,0 +1,9 @@
+export default async function (app) {
+  app.get('/plugin', async () => {
+    return { ok: true }
+  })
+  app.get('/frontend/plugin', async () => {
+    return { ok: true }
+  })
+}

package/test/fixtures/platformatic-service/platformatic.service.json ADDED Viewed

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/service/1.52.0.json",
+  "server": {
+    "logger": {
+      "level": "error"
+    }
+  },
+  "plugins": {
+    "paths": [
+      {
+        "path": "./plugin.js"
+      }
+    ]
+  }
+}

package/test/fixtures/platformatic-service/plugin.js ADDED Viewed

@@ -0,0 +1,19 @@
+'use strict'
+export default async function (app) {
+  app.get('/mesh', async () => {
+    const meta = await globalThis[Symbol.for('plt.runtime.itc')].send('getServiceMeta', 'frontend')
+    const url = new URL(`${meta.composer.prefix}/direct`.replaceAll(/\/+/g, '/'), 'http://frontend.plt.local')
+    const response = await fetch(url)
+    return response.json()
+  })
+  app.get('/direct', async () => {
+    return { ok: true }
+  })
+  app.get('/time', async () => {
+    return { time: Date.now() }
+  })
+}

package/test/index.test.js ADDED Viewed

@@ -0,0 +1,131 @@
+import { dirname, resolve } from 'node:path'
+import { test } from 'node:test'
+import {
+  createRuntime,
+  fixturesDir,
+  setFixturesDir,
+  updateHMRVersion,
+  verifyHMR,
+  verifyHTMLViaHTTP,
+  verifyHTMLViaInject,
+  verifyJSONViaHTTP,
+  verifyJSONViaInject,
+} from '../../basic/test/helper.js'
+import { safeRemove } from '../../utils/index.js'
+function websocketHMRHandler (message, resolveConnection, resolveReload) {
+  switch (message.action) {
+    case 'sync':
+      resolveConnection()
+      break
+    case 'serverComponentChanges':
+      resolveReload()
+  }
+}
+function cleanNext (configFile) {
+  const root = dirname(resolve(fixturesDir, configFile))
+  return safeRemove(resolve(root, '.next'))
+}
+const packageRoot = resolve(import.meta.dirname, '..')
+setFixturesDir(resolve(import.meta.dirname, './fixtures'))
+test('can detect and start a Next application', async t => {
+  await updateHMRVersion()
+  await cleanNext('next/standalone/platformatic.runtime.json')
+  const { url } = await createRuntime(t, 'next/standalone/platformatic.runtime.json', packageRoot)
+  await verifyHTMLViaHTTP(url, '/', ['<script src="/_next/static/chunks/main-app.js'])
+  await verifyHMR(url, '/_next/webpack-hmr', undefined, websocketHMRHandler)
+})
+test('can detect and start a Next application when exposed in a composer with a prefix', async t => {
+  await updateHMRVersion()
+  await cleanNext('next/composer-with-prefix/platformatic.runtime.json')
+  const { runtime, url } = await createRuntime(t, 'next/composer-with-prefix/platformatic.runtime.json', packageRoot)
+  const htmlContents = ['<script src="/frontend/_next/static/chunks/main-app.js']
+  await verifyHTMLViaHTTP(url, '/frontend/', htmlContents)
+  await verifyHTMLViaInject(runtime, 'main', '/frontend', htmlContents)
+  await verifyHMR(url, '/frontend/_next/webpack-hmr', undefined, websocketHMRHandler)
+  await verifyJSONViaHTTP(url, '/plugin', 200, { ok: true })
+  await verifyJSONViaHTTP(url, '/frontend/plugin', 200, { ok: true })
+  await verifyJSONViaHTTP(url, '/service/direct', 200, { ok: true })
+  await verifyJSONViaInject(runtime, 'main', 'GET', 'plugin', 200, { ok: true })
+  await verifyJSONViaInject(runtime, 'main', 'GET', '/frontend/plugin', 200, { ok: true })
+  await verifyJSONViaInject(runtime, 'service', 'GET', '/direct', 200, { ok: true })
+})
+test('can detect and start a Next application when exposed in a composer without a prefix', async t => {
+  await updateHMRVersion()
+  await cleanNext('next/composer-without-prefix/platformatic.runtime.json')
+  const { runtime, url } = await createRuntime(t, 'next/composer-without-prefix/platformatic.runtime.json', packageRoot)
+  const htmlContents = ['<script src="/_next/static/chunks/main-app.js']
+  await verifyHTMLViaHTTP(url, '/', htmlContents)
+  await verifyHTMLViaInject(runtime, 'main', '/', htmlContents)
+  await verifyHMR(url, '/_next/webpack-hmr', undefined, websocketHMRHandler)
+  await verifyJSONViaHTTP(url, '/plugin', 200, { ok: true })
+  await verifyJSONViaHTTP(url, '/frontend/plugin', 200, { ok: true })
+  await verifyJSONViaHTTP(url, '/service/direct', 200, { ok: true })
+  await verifyJSONViaInject(runtime, 'main', 'GET', 'plugin', 200, { ok: true })
+  await verifyJSONViaInject(runtime, 'main', 'GET', '/frontend/plugin', 200, { ok: true })
+  await verifyJSONViaInject(runtime, 'service', 'GET', '/direct', 200, { ok: true })
+})
+// In this file the application purposely does not specify a platformatic.application.json to see if we automatically detect one
+test('can detect and start a Next application when exposed in a composer with a custom config and by autodetecting the prefix', async t => {
+  await updateHMRVersion()
+  await cleanNext('next/composer-autodetect-prefix/platformatic.runtime.json')
+  const { runtime, url } = await createRuntime(
+    t,
+    'next/composer-autodetect-prefix/platformatic.runtime.json',
+    packageRoot
+  )
+  const htmlContents = ['<script src="/nested/base/dir/_next/static/chunks/main-app.js']
+  await verifyHTMLViaHTTP(url, '/nested/base/dir/', htmlContents)
+  await verifyHTMLViaInject(runtime, 'main', '/nested/base/dir', htmlContents)
+  await verifyHMR(url, '/nested/base/dir/_next/webpack-hmr', undefined, websocketHMRHandler)
+  await verifyJSONViaHTTP(url, '/plugin', 200, { ok: true })
+  await verifyJSONViaHTTP(url, '/frontend/plugin', 200, { ok: true })
+  await verifyJSONViaHTTP(url, '/service/direct', 200, { ok: true })
+  await verifyJSONViaInject(runtime, 'main', 'GET', 'plugin', 200, { ok: true })
+  await verifyJSONViaInject(runtime, 'main', 'GET', '/frontend/plugin', 200, { ok: true })
+  await verifyJSONViaInject(runtime, 'service', 'GET', '/direct', 200, { ok: true })
+})
+test('can detect and start a Next application with working React Server Components and Next server API', async t => {
+  await updateHMRVersion()
+  await cleanNext('next/server-side/platformatic.runtime.json')
+  const { runtime, url } = await createRuntime(t, 'next/server-side/platformatic.runtime.json', packageRoot)
+  const htmlContents = ['<script src="/frontend/_next/static/chunks/main-app.js']
+  await verifyHTMLViaHTTP(url, '/frontend/', htmlContents)
+  await verifyHTMLViaInject(runtime, 'main', '/frontend', htmlContents)
+  await verifyHMR(url, '/frontend/_next/webpack-hmr', undefined, websocketHMRHandler)
+  await verifyJSONViaHTTP(url, '/plugin', 200, { ok: true })
+  await verifyJSONViaHTTP(url, '/frontend/plugin', 200, { ok: true })
+  await verifyJSONViaHTTP(url, '/service/direct', 200, { ok: true })
+  await verifyJSONViaInject(runtime, 'main', 'GET', 'plugin', 200, { ok: true })
+  await verifyJSONViaInject(runtime, 'main', 'GET', '/frontend/plugin', 200, { ok: true })
+  await verifyJSONViaInject(runtime, 'service', 'GET', '/direct', 200, { ok: true })
+  await verifyJSONViaInject(runtime, 'service', 'GET', '/mesh', 200, { ok: true })
+})