@fabric/http — Edge Nodes

.github/workflows/test.yaml

@@ -18,16 +18,33 @@ jobs:
     steps:
     - name: Checkout branch
       uses: actions/checkout@v3
+
+    - name: Install system dependencies (Ubuntu)
+      if: matrix.os == 'ubuntu-latest'
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev
+
+    - name: Install system dependencies (macOS)
+      if: matrix.os == 'macos-latest'
+      run: |
+        brew install pkg-config cairo pango libpng jpeg giflib librsvg
+
     - name: Install Node.js on ${{ matrix.os }}
       uses: actions/setup-node@v2
       with:
         node-version-file: '.nvmrc'
         cache: 'npm'
         cache-dependency-path: package-lock.json
+
     - name: Install dependencies
       run: npm ci
+      env:
+        PKG_CONFIG_PATH: /usr/local/lib/pkgconfig:/opt/homebrew/lib/pkgconfig
+
     - name: Generate coverage report
       run: npm run report:coverage
+
     - name: Send coverage report
       uses: codecov/codecov-action@v3.1.1
       with:

.nvmrc

@@ -1 +1 @@
-v18.19.0
+v18.19.1

.travis.yml

@@ -1,8 +1,10 @@
 dist: focal
 language: node_js
 node_js:
-  - 16.17.1
+  - 18.19.1
 before_install:
+  - sudo apt-get update
+  - sudo apt-get install -y build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev
   - npm install -g codecov
 after_success:
   - npm run report:coverage

README.md

@@ -5,37 +5,44 @@
 [![Community](https://img.shields.io/matrix/hub:fabric.pub.svg?style=flat-square)](https://chat.fabric.pub)
 
 Robust library for implementing Fabric-enabled Web Applications.
-## TODO
-- [ ] Replace `Fabric-enabled` with `Bitcoin-enabled`
+
+## What is Fabric?
+[Fabric][fabric] is an attempt at replicating the World Wide Web ("the WWW") as a peer-to-peer network, using payment relationships to exchange documents and scale the network.  `@fabric/http` provides a framework for hosting Fabric-enabled applications over HTTP, allowing them to be used as "edge servers" for legacy web users.
 
 ## Quick Start
 Building applications with `@fabric/http` is easy.
 
-```
-mkdir myapp && cd myapp
-npm init
-npm i --save @fabric/http
+```sh
+mkdir some-project && cd some-project
+npm init # Initialize the project
+npm i --save @fabric/http # Install the @fabric/http dependency
 ```
 
-Create an application by creating a new file (here we've used `scripts/app.js`), containing the following:
-### `scripts/app.js`:
+Create an application by creating a new file (here we've used `scripts/node.js`), containing the following:
+### `scripts/node.js`:
 ```js
 'use strict';
 
+// Dependencies
 const SPA = require('@fabric/http/types/spa');
 
+// Main Process
 async function main () {
   const spa = new SPA({
-    name: 'Example App',
-    synopsis: 'Simple demonstration of a single-page app.',
+    name: 'Example Application',
+    synopsis: 'Simple demonstration of a single-page application.',
     resources: {
       'Todo': {
         description: 'A to-do list item.'
       }
     }
   });
 
+  // Start the Process
   await spa.start();
+
+  // Return reference
+  return { id: spa.id };
 }
 
 main().catch((exception) => {
@@ -45,10 +52,7 @@ main().catch((exception) => {
 });
 ```
 
-Run `node scripts/app.js` to start the app, or `webpack scripts/app.js -o assets/app.min.js` to
+Run `node scripts/node.js` to start the app, or `webpack scripts/app.js -o assets/app.min.js` to
 build a browser version.
 
-### Advanced: `@maki/roller`
-
-## Maki, making beautiful apps a breeze
-Try `maki roll examples` in this repo for a mind-blowing experience.
+[fabric]: https://fabric.pub

middlewares/auth.js

@@ -25,7 +25,7 @@ module.exports = function FabricAuthenticationMiddleware (request, response, nex
 
     }
   } else {
-    this.emit('debug', `[WARNING] No "${HTTP_IDENTITY_HEADER_NAME}" header.  Consider rejecting here.`);
+    if (this.settings.verbosity > 2) this.emit('warning', `[WARNING] No "${HTTP_IDENTITY_HEADER_NAME}" header.  Consider rejecting here.`);
   }
 
   return next();