Merge pull request #1797 from nodeSolidServer/basic-prep

Basic prep

.github/workflows/ci.yml

@@ -17,17 +17,30 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x]
+        node-version: [ '>=20.17.0' ]
         os: [ubuntu-latest]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
+
+    # extract repository name
+    - if: github.event_name == 'pull_request'
+      run: echo "REPO_NAME=${{ github.event.pull_request.head.repo.full_name }}" >> $GITHUB_ENV
+
+    - if: github.event_name != 'pull_request'
+      run: echo "REPO_NAME=${GITHUB_REPOSITORY}" >> $GITHUB_ENV
+
     # extract branch name
     - if: github.event_name == 'pull_request'
       run: echo "BRANCH_NAME=${GITHUB_HEAD_REF}" >> $GITHUB_ENV
+
     - if: github.event_name != 'pull_request'
       run: echo "BRANCH_NAME=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV
 
+    # print repository name
+    - name: Get repository name
+      run: echo 'The repository name is' $REPO_NAME
+
     # print branch name
     - name: Get branch name
       run: echo 'The branch name is' $BRANCH_NAME
@@ -40,12 +53,12 @@ jobs:
     # test code
     - run: npm run standard
     - run: npm run validate
-    - run: npm run nyc
+    - run: npm run c8
     # Test global install of the package
     - run: npm pack .
     - run: npm install -g solid-server-*.tgz
     # Run the Solid test-suite
-    - run: bash test/surface/run-solid-test-suite.sh $BRANCH_NAME
+    - run: bash test/surface/run-solid-test-suite.sh $BRANCH_NAME $REPO_NAME
 
   # TODO: The pipeline should automate publication to npm, so that the docker build gets the correct version
   #       This job will only dockerize solid-server@latest / solid-server@<tag-name> from npmjs.com!
@@ -56,7 +69,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - uses: olegtarasov/get-tag@v2.1
         id: tagName

README.md

@@ -138,7 +138,7 @@ Your users will have a dedicated folder under `./data` at `./data/<username>.<yo
 > To use Gmail you may need to configure ["Allow Less Secure Apps"](https://www.google.com/settings/security/lesssecureapps) in your Gmail account unless you are using 2FA in which case you would have to create an [Application Specific](https://security.google.com/settings/security/apppasswords) password. You also may need to unlock your account with ["Allow access to your Google account"](https://accounts.google.com/DisplayUnlockCaptcha) to use SMTP.
 
 also add to `config.json`
-``` 
+```
   "useEmail": true,
   "emailHost": "smtp.gmail.com",
   "emailPort": "465",
@@ -206,6 +206,7 @@ $ solid start --help
     --multiuser                   Enable multi-user mode
     --idp [value]                 Obsolete; use --multiuser
     --no-live                     Disable live support through WebSockets
+    --no-prep                     Disable Per Resource Events
     --proxy [value]               Obsolete; use --corsProxy
     --cors-proxy [value]          Serve the CORS proxy on this path
     --suppress-data-browser       Suppress provision of a data browser
@@ -271,7 +272,7 @@ docker run -p 8443:8443 --name solid node-solid-server
 
 
 This will enable you to login to solid on https://localhost:8443 and then create a new account
-but not yet use that account. After a new account is made you will need to create an entry for 
+but not yet use that account. After a new account is made you will need to create an entry for
 it in your local (/etc/)hosts file in line with the account and subdomain, i.e. --
 
 ```pre
@@ -280,16 +281,16 @@ it in your local (/etc/)hosts file in line with the account and subdomain, i.e.
 
 You can modify the config within the docker container as follows:
 
- - Copy the `config.json` to the current directory with: 
+ - Copy the `config.json` to the current directory with:
    ```bash
    docker cp solid:/usr/src/app/config.json .
    ```
  - Edit the `config.json` file
- - Copy the file back with 
+ - Copy the file back with
    ```bash
    docker cp config.json solid:/usr/src/app/
    ```
- - Restart the server with 
+ - Restart the server with
    ```bash
    docker restart solid
    ```

bin/lib/options.js

@@ -143,6 +143,12 @@ module.exports = [
     flag: true,
     default: false
   },
+  {
+    name: 'no-prep',
+    help: 'Disable Per Resource Events',
+    flag: true,
+    default: false
+  },
   // {
   //   full: 'default-app',
   //   help: 'URI to use as a default app for resources (default: https://linkeddata.github.io/warp/#/list/)'

bin/solid

@@ -1,3 +1,3 @@
-#!/usr/bin/env node
+#!/usr/bin/env -S node --experimental-require-module
 const startCli = require('./lib/cli')
 startCli()

bin/solid.js

@@ -1,3 +1,3 @@
-#!/usr/bin/env node
+#!/usr/bin/env -S node --experimental-require-module
 const startCli = require('./lib/cli')
 startCli()

docker-image/src/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16-alpine
+FROM node:20-alpine
 
 # hadolint ignore=DL3018
 RUN apk add --no-cache openssl

lib/create-app.js

@@ -28,6 +28,11 @@ const ResourceMapper = require('./resource-mapper')
 const aclCheck = require('@solid/acl-check')
 const { version } = require('../package.json')
 
+const acceptEvents = require('express-accept-events').default
+const events = require('express-negotiate-events').default
+const eventID = require('express-prep/event-id').default
+const prep = require('express-prep').default
+
 const corsSettings = cors({
   methods: [
     'OPTIONS', 'HEAD', 'GET', 'PATCH', 'POST', 'PUT', 'DELETE'
@@ -61,6 +66,12 @@ function createApp (argv = {}) {
 
   const app = express()
 
+  // Add PREP support
+  if (argv.prep) {
+    app.use(eventID)
+    app.use(acceptEvents, events, prep)
+  }
+
   initAppLocals(app, argv, ldp)
   initHeaders(app)
   initViews(app, configPath)
@@ -115,7 +126,7 @@ function createApp (argv = {}) {
   }
 
   // Attach the LDP middleware
-  app.use('/', LdpMiddleware(corsSettings))
+  app.use('/', LdpMiddleware(corsSettings, argv.prep))
 
   // https://stackoverflow.com/questions/51741383/nodejs-express-return-405-for-un-supported-method
   app.use(function (req, res, next) {
@@ -168,6 +179,7 @@ function initAppLocals (app, argv, ldp) {
   app.locals.enforceToc = argv.enforceToc
   app.locals.tocUri = argv.tocUri
   app.locals.disablePasswordChecks = argv.disablePasswordChecks
+  app.locals.prep = argv.prep
 
   if (argv.email && argv.email.host) {
     app.locals.emailService = new EmailService(argv.templates.email, argv.email)
@@ -287,7 +299,7 @@ function initWebId (argv, app, ldp) {
   initAuthentication(app, argv)
 
   if (argv.multiuser) {
-    app.use(vhost('*', LdpMiddleware(corsSettings)))
+    app.use(vhost('*', LdpMiddleware(corsSettings, argv.prep)))
   }
 }
 

lib/debug.js

@@ -15,3 +15,4 @@ exports.accounts = debug('solid:accounts')
 exports.email = debug('solid:email')
 exports.ldp = debug('solid:ldp')
 exports.fs = debug('solid:fs')
+exports.prep = debug('solid:prep')

lib/handlers/delete.js

@@ -6,9 +6,12 @@ async function handler (req, res, next) {
   debug('DELETE -- Request on' + req.originalUrl)
 
   const ldp = req.app.locals.ldp
+  const prep = req.app.locals.prep
   try {
     await ldp.delete(req)
     debug('DELETE -- Ok.')
+    // Add event-id for notifications
+    prep && res.setHeader('Event-ID', res.setEventID())
     res.sendStatus(200)
     next()
   } catch (err) {

lib/handlers/get.js

@@ -17,9 +17,13 @@ const translate = require('../utils.js').translate
 const error = require('../http-error')
 
 const RDFs = require('../ldp').mimeTypesAsArray()
+const isRdf = require('../ldp').mimeTypeIsRdf
+
+const prepConfig = 'accept=("message/rfc822" "application/ld+json" "text/turtle")'
 
 async function handler (req, res, next) {
   const ldp = req.app.locals.ldp
+  const prep = req.app.locals.prep
   const includeBody = req.method === 'GET'
   const negotiator = new Negotiator(req)
   const baseUri = ldp.resourceMapper.resolveUrl(req.hostname, req.path)
@@ -103,22 +107,35 @@ async function handler (req, res, next) {
       debug('   sending data browser file: ' + dataBrowserPath)
       res.sendFile(dataBrowserPath)
       return
-    } else if (stream) {
+    } else if (stream) { // EXIT text/html
       res.setHeader('Content-Type', contentType)
       return stream.pipe(res)
     }
   }
 
   // If request accepts the content-type we found
   if (stream && negotiator.mediaType([contentType])) {
-    res.setHeader('Content-Type', contentType)
+    let headers = {
+      'Content-Type': contentType
+    }
     if (contentRange) {
-      const headers = { 'Content-Range': contentRange, 'Accept-Ranges': 'bytes', 'Content-Length': chunksize }
-      res.writeHead(206, headers)
-      return stream.pipe(res)
-    } else {
-      return stream.pipe(res)
+      headers = {
+        ...headers,
+        'Content-Range': contentRange,
+        'Accept-Ranges': 'bytes',
+        'Content-Length': chunksize
+      }
+      res.statusCode = 206
     }
+
+    if (prep & isRdf(contentType) && !res.sendEvents({
+      config: { prep: prepConfig },
+      body: stream,
+      isBodyStream: true,
+      headers
+    })) return
+    res.set(headers)
+    return stream.pipe(res)
   }
 
   // If it is not in our RDFs we can't even translate,
@@ -130,6 +147,14 @@ async function handler (req, res, next) {
     // Translate from the contentType found to the possibleRDFType desired
     const data = await translate(stream, baseUri, contentType, possibleRDFType)
     debug(req.originalUrl + ' translating ' + contentType + ' -> ' + possibleRDFType)
+    const headers = {
+      'Content-Type': possibleRDFType
+    }
+    if (prep && isRdf(contentType) && !res.sendEvents({
+      config: { prep: prepConfig },
+      body: data,
+      headers
+    })) return
     res.setHeader('Content-Type', possibleRDFType)
     res.send(data)
     return next()