pinokiod 8.0.22 → 8.0.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pinokiod",
-  "version": "8.0.22",
+  "version": "8.0.23",
   "description": "",
   "main": "index.js",
   "scripts": {

package/server/index.js

@@ -3606,7 +3606,6 @@ class Server {
 
       let error
       let items
-      let readme
 //      if (pathComponents.length === 0) {
 //        let files = await fs.promises.readdir(filepath, { withFileTypes: true })
 //        items = files
@@ -3629,18 +3628,8 @@ class Server {
           }
         }
 
-        // look for README.md
-
         let config
         for(let file of f.files) {
-          if (file.name.toLowerCase() === "readme.md") {
-            let p = path.resolve(filepath, file.name)
-            let md = await fs.promises.readFile(p, "utf8")
-            readme = marked.parse(md, {
-              baseUrl: req._parsedUrl.pathname.replace(/^\/_api/, "/raw/") + "/"
-              //baseUrl: req.originalUrl + "/"
-            })
-          }
           if (file.name === "pinokio.js") {
             let p = path.resolve(filepath, file.name)
             config  = (await this.kernel.loader.load(p)).resolved
@@ -4297,7 +4286,6 @@ class Server {
           home_sort: homeSortMode,
           running,
           notRunning,
-          readme,
           filepath,
           mode: null,
           kernel: this.kernel,
@@ -4329,7 +4317,6 @@ class Server {
           ishome: meta,
           running,
           notRunning,
-          readme,
           filepath,
           mode: null,
           kernel: this.kernel,

package/server/public/style.css

@@ -2637,13 +2637,6 @@ pre {
 pre:empty {
   display: none;
 }
-body.dark .readme {
-  background: none;
-  color: var(--dark-color);
-}
-.readme .content {
-  padding: 0 20px 20px;
-}
 body.dark .empty {
   background: var(--dark-bg);
 }
@@ -2653,21 +2646,6 @@ body.dark .empty {
   opacity: 0.5;
   background: var(--light-bg);
 }
-.readme {
-  max-width: var(--content-width);
-  box-sizing: border-box;
-  margin: 0 auto;
-}
-body.dark .readme a {
-  color: var(--dark-link-color);
-}
-.readme a {
-  color: var(--light-link-color);
-  text-decoration: none;
-}
-.readme ol, .readme ul {
-  padding-inline-start: 20px;
-}
 .runnables .row {
   display: flex;
   padding: 10px;

package/server/views/file_explorer.ejs

@@ -8,7 +8,6 @@
 <link href="/css/solid.min.css" rel="stylesheet">
 <link href="/css/regular.min.css" rel="stylesheet">
 <link href="/css/brands.min.css" rel="stylesheet">
-<link href="/markdown.css" rel="stylesheet"/>
 <link href="/noty.css" rel="stylesheet"/>
 <link href="/style.css" rel="stylesheet"/>
 <% if (agent === "electron") { %>
@@ -230,11 +229,6 @@ body.dark .browser-options-row {
     <div class='description'><%=item.description%></div>
   </a>
 <% }) %>
-<% if (readme) { %>
-<div class='readme markdown-body'>
-  <div class='content'><%-readme%></div>
-</div>
-<% } %>
 </div>
 </main>
 <script>

package/server/views/index.ejs

@@ -8,7 +8,6 @@
 <link href="/css/solid.min.css" rel="stylesheet">
 <link href="/css/regular.min.css" rel="stylesheet">
 <link href="/css/brands.min.css" rel="stylesheet">
-<link href="/markdown.css" rel="stylesheet"/>
 <link href="/noty.css" rel="stylesheet"/>
 <link href="/filepond.min.css" rel="stylesheet" />
 <link href="/filepond-plugin-image-preview.min.css" rel="stylesheet" />
@@ -2000,11 +1999,6 @@ body.dark aside .current.selected {
     </a>
   <% }) %>
 <% } %>
-<% if (readme) { %>
-<div class='readme markdown-body'>
-  <div class='content'><%-readme%></div>
-</div>
-<% } %>
 </div>
 <%- include('partials/main_sidebar', { selected: 'home' }) %>
 </main>

package/server/views/index2.ejs

@@ -8,7 +8,6 @@
 <link href="/css/solid.min.css" rel="stylesheet">
 <link href="/css/regular.min.css" rel="stylesheet">
 <link href="/css/brands.min.css" rel="stylesheet">
-<link href="/markdown.css" rel="stylesheet"/>
 <link href="/noty.css" rel="stylesheet"/>
 <link href="/filepond.min.css" rel="stylesheet" />
 <link href="/filepond-plugin-image-preview.min.css" rel="stylesheet" />
@@ -500,11 +499,6 @@ body.dark .open-menu, body.dark .browse {
     </a>
   <% }) %>
 <% } %>
-<% if (readme) { %>
-<div class='readme markdown-body'>
-  <div class='content'><%-readme%></div>
-</div>
-<% } %>
 <% if (display.includes("onboarding")) { %>
 <!--
 <div class='container'>

package/test/directory-readme-rendering.test.js

@@ -0,0 +1,125 @@
+const assert = require('node:assert/strict')
+const fs = require('node:fs')
+const http = require('node:http')
+const os = require('node:os')
+const path = require('node:path')
+const test = require('node:test')
+const express = require('express')
+const Server = require('../server')
+
+const viewsPath = path.resolve(__dirname, '..', 'server', 'views')
+
+async function createDirectoryRendererFixture() {
+  const homedir = await fs.promises.mkdtemp(path.join(os.tmpdir(), 'pinokio-directory-readme-'))
+  const apiRoot = path.resolve(homedir, 'api')
+  const appRoot = path.resolve(apiRoot, 'demo')
+  await fs.promises.mkdir(appRoot, { recursive: true })
+  await fs.promises.writeFile(path.resolve(apiRoot, 'README.md'), '# ROOT README SENTINEL\n')
+  await fs.promises.writeFile(path.resolve(appRoot, 'README.md'), '# APP README SENTINEL\n')
+  await fs.promises.writeFile(path.resolve(appRoot, 'keep.txt'), 'keep\n')
+
+  const renderer = Object.create(Server.prototype)
+  renderer.kernel = {
+    homedir,
+    path: (...segments) => path.resolve(homedir, ...segments),
+    api: {
+      userdir: apiRoot,
+      proxies: {},
+      running: {},
+      launcher: async (name) => ({
+        script: null,
+        launcher_root: ''
+      })
+    },
+    dns: async ({ name }) => {
+      renderer.kernel.pinokio_configs[name] = { dns: { '@': [] } }
+    },
+    peer: {
+      host: '127.0.0.1',
+      check_peers: async () => {}
+    },
+    launch_complete: true,
+    pinokio_configs: {}
+  }
+  renderer.autolaunch = {
+    applyHomeStartingState: async () => false
+  }
+  renderer.portal = ''
+  renderer.install = ''
+  renderer.port = 0
+  renderer.theme = 'light'
+  renderer.logo = ''
+  renderer.cloudflare_pub = null
+  renderer.composePeerAccessPayload = async () => ({
+    peer_access_points: [],
+    peer_url: 'http://127.0.0.1:42000',
+    peer_qr: null,
+    peer_access_router_installed: false
+  })
+  renderer.current_urls = async () => ({})
+  renderer.getPeers = () => []
+
+  const app = express()
+  app.set('views', viewsPath)
+  app.set('view engine', 'ejs')
+  app.get('/home', (req, res, next) => {
+    renderer.render(req, res, [], {}).catch(next)
+  })
+  app.get('/_api/demo', (req, res, next) => {
+    req.query.mode = 'source'
+    renderer.render(req, res, ['demo']).catch(next)
+  })
+  app.get('/api/demo', (req, res, next) => {
+    renderer.render(req, res, ['demo']).catch(next)
+  })
+  app.use((error, req, res, next) => {
+    res.status(500).send(error.stack || error.message)
+  })
+
+  const httpServer = http.createServer(app)
+  await new Promise((resolve, reject) => {
+    httpServer.once('error', reject)
+    httpServer.listen(0, '127.0.0.1', resolve)
+  })
+  const address = httpServer.address()
+
+  return {
+    baseUrl: `http://127.0.0.1:${address.port}`,
+    close: async () => {
+      await new Promise((resolve, reject) => {
+        httpServer.close((error) => error ? reject(error) : resolve())
+      })
+      await fs.promises.rm(homedir, { recursive: true, force: true })
+    }
+  }
+}
+
+test('directory pages list README files without auto-rendering their contents', async () => {
+  const fixture = await createDirectoryRendererFixture()
+  try {
+    const [homeResponse, sourceResponse, runResponse] = await Promise.all([
+      fetch(`${fixture.baseUrl}/home`),
+      fetch(`${fixture.baseUrl}/_api/demo`),
+      fetch(`${fixture.baseUrl}/api/demo`)
+    ])
+    const [homeHtml, sourceHtml, runHtml] = await Promise.all([
+      homeResponse.text(),
+      sourceResponse.text(),
+      runResponse.text()
+    ])
+
+    assert.equal(homeResponse.status, 200, homeHtml)
+    assert.equal(sourceResponse.status, 200, sourceHtml)
+    assert.equal(runResponse.status, 200, runHtml)
+
+    assert.doesNotMatch(homeHtml, /ROOT README SENTINEL/)
+    for (const html of [sourceHtml, runHtml]) {
+      assert.doesNotMatch(html, /APP README SENTINEL/)
+      assert.match(html, /data-name="README\.md"/)
+      assert.match(html, /data-name="keep\.txt"/)
+      assert.doesNotMatch(html, /class=['"]readme markdown-body['"]/)
+    }
+  } finally {
+    await fixture.close()
+  }
+})