hypermedia-app · tpluscode · Jan 25, 2023 · Jan 25, 2023 · Jan 26, 2023 · Jan 27, 2023
diff --git a/.changeset/wise-balloons-accept.md b/.changeset/wise-balloons-accept.md
@@ -0,0 +1,7 @@
+---
+"@hydrofoil/roadshow": minor
+"@hydrofoil/roadshow-ssr": patch
+"@hydrofoil/roadshow-vite": patch
+---
+
+Rewrite to put emphasis on server-side rendering
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -21,7 +21,7 @@
     "no-param-reassign": ["error", { "props": false }]
   },
   "overrides": [{
-    "files": "**/test/**/*.ts",
+    "files": ["**/*.test.ts", "**/*.spec.ts"],
     "rules": {
       "no-unused-expressions": "warn",
       "babel/no-unused-expressions": "off"
@@ -31,5 +31,15 @@
     "rules": {
       "require-extensions/require-extensions": "error"
     }
+  }, {
+    "files": "apps/ssr-example/**",
+    "rules": {
+      "import/no-extraneous-dependencies": "warn"
+    }
+  }, {
+    "files": "apps/wikibus-ssr/**",
+    "globals": {
+      "JQueryStatic": "readonly"
+    }
   }]
 }
diff --git a/.github/workflows/heroku.yml b/.github/workflows/heroku.yml
diff --git a/.github/workflows/netlify.yml b/.github/workflows/netlify.yml
diff --git a/.github/workflows/playwright.yml b/.github/workflows/playwright.yml
@@ -0,0 +1,24 @@
+name: Playwright Tests
+
+on: [push, pull_request]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 16
+    - name: Install dependencies
+      run: yarn
+    - name: Install Playwright Browsers
+      run: yarn playwright install --with-deps
+    - name: Run Playwright tests
+      run: yarn test:ssr
+    - uses: actions/upload-artifact@v3
+      if: always()
+      with:
+        name: playwright-report
+        path: apps/ssr-example/playwright-report/
+        retention-days: 30
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,7 @@ dist/
 *.d.ts
 *.map
 coverage/
+/test-results/
+playwright-report/
+playwright/.cache/
+yarn-error.log
diff --git a/Procfile b/Procfile
diff --git a/apps/ssr-example/index.html b/apps/ssr-example/index.html
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <base href="/">
+</head>
+<body>
+
+<!--ssr-outlet-->
+
+<script src="./src/client.ts" type="module"></script>
+</body>
+</html>
diff --git a/apps/ssr-example/package.json b/apps/ssr-example/package.json
@@ -0,0 +1,27 @@
+{
+  "name": "ssr-test",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "start": "node --loader ts-node/esm server.ts",
+    "test": "playwright test",
+    "build:client": "vite build --outDir dist/client",
+    "build:server": "vite build --outDir dist/server --ssr src/server.ts"
+  },
+  "dependencies": {
+    "@hydrofoil/roadshow-ssr": "^0.0.0",
+    "@hydrofoil/roadshow-vite": "^0.0.0",
+    "@tpluscode/rdf-ns-builders": "^4",
+    "@vaadin/vaadin": "^23.2.15",
+    "clownface": "^1.5.1",
+    "express": "^4.18.2",
+    "lit": "^2.6.1",
+    "rdf-ext": "^2",
+    "test-data": "*"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.29.2",
+    "@types/express": "^4"
+  }
+}
diff --git a/apps/ssr-example/playwright.config.ts b/apps/ssr-example/playwright.config.ts
@@ -0,0 +1,73 @@
+/* eslint-disable import/no-extraneous-dependencies */
+import type { PlaywrightTestConfig } from '@playwright/test'
+import { devices } from '@playwright/test'
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// require('dotenv').config();
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+const config: PlaywrightTestConfig = {
+  testDir: './test',
+  /* Maximum time one test can run for. */
+  timeout: 30 * 1000,
+  expect: {
+    /**
+     * Maximum time expect() should wait for the condition to be met.
+     * For example in `await expect(locator).toHaveText();`
+     */
+    timeout: 5000,
+  },
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: 'html',
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Maximum time each action such as `click()` can take. Defaults to 0 (no limit). */
+    actionTimeout: 0,
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    baseURL: 'http://localhost:3000',
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: 'on-first-retry',
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'chromium',
+      use: {
+        ...devices['Desktop Chrome'],
+      },
+    },
+
+    {
+      name: 'firefox',
+      use: {
+        ...devices['Desktop Firefox'],
+      },
+    },
+  ],
+
+  /* Folder for test artifacts such as screenshots, videos, traces, etc. */
+  // outputDir: 'test-results/',
+
+  /* Run your local dev server before starting the tests */
+  webServer: {
+    command: 'npm run start',
+    port: 3000,
+  },
+}
+
+export default config
diff --git a/apps/ssr-example/server.ts b/apps/ssr-example/server.ts
@@ -0,0 +1,28 @@
+import path from 'path'
+import { fileURLToPath } from 'url'
+import express from 'express'
+import config from '@hydrofoil/roadshow-vite/config'
+import * as roadshow from '@hydrofoil/roadshow-vite/server'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+
+async function createServer() {
+  const app = express()
+
+  app.use(await roadshow.middleware({
+    vite: config,
+    production: {
+      modulePath: path.resolve(__dirname, './src/server.ts'),
+      indexPath: path.resolve(__dirname, 'index.html'),
+      clientBuildPath: '',
+    },
+    dev: {
+      modulePath: path.resolve(__dirname, './src/server.ts'),
+      indexPath: path.resolve(__dirname, 'index.html'),
+    },
+  }))
+
+  app.listen(3000)
+}
+
+createServer()
diff --git a/apps/ssr-example/src/client.ts b/apps/ssr-example/src/client.ts
@@ -0,0 +1,3 @@
+import '@hydrofoil/roadshow-ssr/client'
+import '@hydrofoil/roadshow/rs-view'
+import './viewers.js'
diff --git a/apps/ssr-example/src/element/ex-layout.ts b/apps/ssr-example/src/element/ex-layout.ts
@@ -0,0 +1,17 @@
+import { html, LitElement } from 'lit'
+import { customElement } from 'lit/decorators.js'
+import '@vaadin/app-layout/vaadin-app-layout.js'
+import { ex } from 'test-data/ns.js'
+import { defineViewer } from '@hydrofoil/roadshow'
+
+@customElement('ex-layout')
+export class ExLayout extends LitElement {
+  render() {
+    return html`<vaadin-app-layout>
+      <slot name="header" slot="navbar"></slot>
+    </vaadin-app-layout>
+    `
+  }
+}
+
+defineViewer(ex.LayoutViewer, 'ex-layout')
diff --git a/apps/ssr-example/src/server.ts b/apps/ssr-example/src/server.ts
@@ -0,0 +1,29 @@
+import * as roadshow from '@hydrofoil/roadshow-ssr'
+import { loadData } from 'test-data'
+import { dash } from '@tpluscode/rdf-ns-builders'
+import './viewers.js'
+import express from 'express'
+import $rdf from 'rdf-ext'
+import clownface from 'clownface'
+import isGraphPointer from 'is-graph-pointer'
+
+export async function render({ req }: { req: express.Request }) {
+  const id = req.originalUrl.substring(1)
+
+  const stream = loadData(id)
+  if (!stream) {
+    return undefined
+  }
+  const dataset = await $rdf.dataset().import(stream)
+  const pointer = clownface({ dataset }).namedNode(id)
+
+  const shape = pointer.out(dash.shape)
+  if (isGraphPointer.isNamedNode(shape)) {
+    const shapeStream = loadData(shape.value)
+    if (shapeStream) {
+      await dataset.import(shapeStream)
+    }
+  }
+
+  return roadshow.render({ pointer })
+}
diff --git a/apps/ssr-example/src/viewers.ts b/apps/ssr-example/src/viewers.ts
@@ -0,0 +1,2 @@
+import '@hydrofoil/roadshow/viewers'
+import './element/ex-layout.js'
diff --git a/apps/ssr-example/test/example.spec.ts b/apps/ssr-example/test/example.spec.ts
@@ -0,0 +1,9 @@
+import { test, expect } from '@playwright/test'
+
+test('simple page', async ({ page }) => {
+  await page.goto('/example/page')
+
+  const h1 = page.locator('h1')
+
+  await expect(h1).toHaveAttribute('slot', 'header')
+})
diff --git a/apps/storybook/.storybook/main.js b/apps/storybook/.storybook/main.js
diff --git a/apps/storybook/.storybook/preview.js b/apps/storybook/.storybook/preview.js