@evanp/activitypub-bot 0.21.2 → 0.23.0

package/README.md

@@ -97,6 +97,24 @@ The path to the [config file](#config-file) for this server, which defines the u
 
 Falls back to `BOTS_CONFIG_FILE` environment variable. The default is to use the shipped default bot config file, which defines an [OKBot](#okbot) named `ok` and a [DoNothingBot](#donothingbot) named `null`.
 
+#### --delivery
+
+The number of background delivery workers to run for this server. These workers accept and process remote activities that arrive at the server. If the server has a lot of traffic, and it's taking a while for bots to do their thing, increase this number.
+
+Falls back to the `DELIVERY` environment variable. Default is 2.
+
+#### --distribution
+
+The number of background distribution workers to run for this server.  These workers distribute bot activities to followers and other recipients on remote servers.  If it's taking a while for bot activities to get to their recipients, increase this number.
+
+Falls back to the `DISTRIBUTION` environment variable. Default is 8.
+
+#### --index-file
+
+Path to the HTML file to show for the home page of your server. The activitypub.bot server doesn't support any other files, so any images or CSS stylesheets or JavaScript in this page have to be hosted elsewhere. Or just skip them!
+
+Falls back to the 'INDEX_FILE' environment variable. The default index file is in `web/index.html` and just says that this is an activitypub.bot server with a link to the GitHub repo.
+
 ### Config file
 
 The config file defines the bots provided by this server.

package/bin/activitypub-bot.js

@@ -12,6 +12,9 @@ const { values } = parseArgs({
     port: { type: 'string' },
     'bots-config-file': { type: 'string' },
     'log-level': { type: 'string' },
+    delivery: { type: 'string' },
+    distribution: { type: 'string' },
+    'index-file': { type: 'string' },
     help: { type: 'boolean', short: 'h' }
   },
   allowPositionals: false
@@ -26,13 +29,16 @@ Options:
   --port <number>            Port to listen on
   --bots-config-file <path>  Path to bots config module
   --log-level <level>        Log level (e.g., info, debug)
+  --delivery <number>        Number of background delivery workers
+  --distribution <number>    Number of background distribution workers
+  --index-file <path>        HTML page to show at root path
   -h, --help                 Show this help
 `)
   process.exit(0)
 }
 
 const normalize = (value) => (value === '' ? undefined : value)
-const parsePort = (value) => {
+const parseNumber = (value) => {
   if (!value) return undefined
   const parsed = Number.parseInt(value, 10)
   return Number.isNaN(parsed) ? undefined : parsed
@@ -40,20 +46,32 @@ const parsePort = (value) => {
 
 const baseDir = dirname(fileURLToPath(import.meta.url))
 const DEFAULT_BOTS_CONFIG_FILE = resolve(baseDir, '..', 'bots', 'index.js')
+const DEFAULT_INDEX_FILE = resolve(baseDir, '..', 'web', 'index.html')
 
 const DATABASE_URL = normalize(values['database-url']) || process.env.DATABASE_URL || 'sqlite::memory:'
 const ORIGIN = normalize(values.origin) || process.env.ORIGIN || 'https://activitypubbot.test'
-const PORT = parsePort(normalize(values.port)) || parsePort(process.env.PORT) || 9000 // HAL
+const PORT = parseNumber(normalize(values.port)) || parseNumber(process.env.PORT) || 9000 // HAL
 const BOTS_CONFIG_FILE =
   normalize(values['bots-config-file']) || process.env.BOTS_CONFIG_FILE || DEFAULT_BOTS_CONFIG_FILE
 const LOG_LEVEL =
   normalize(values['log-level']) ||
   process.env.LOG_LEVEL ||
   (process.env.NODE_ENV === 'test' ? 'silent' : 'info')
+const DELIVERY = parseNumber(values.delivery) || parseNumber(process.env.DELIVERY) || 2
+const DISTRIBUTION = parseNumber(values.distribution) || parseNumber(process.env.DISTRIBUTION) || 8
+const INDEX_FILE = values['index-file'] || process.env.INDEX_FILE || DEFAULT_INDEX_FILE
 
 const bots = (await import(BOTS_CONFIG_FILE)).default
 
-const app = await makeApp(DATABASE_URL, ORIGIN, bots, LOG_LEVEL)
+const app = await makeApp({
+  databaseUrl: DATABASE_URL,
+  origin: ORIGIN,
+  bots,
+  logLevel: LOG_LEVEL,
+  deliveryWorkerCount: DELIVERY,
+  distributionWorkerCount: DISTRIBUTION,
+  indexFileName: INDEX_FILE
+})
 
 const server = app.listen(parseInt(PORT), () => {
   app.locals.logger.info(`Listening on port ${PORT}`)

package/lib/app.js

@@ -1,8 +1,12 @@
+import http from 'node:http'
+import { resolve, dirname } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
 import { Sequelize } from 'sequelize'
 import express from 'express'
 import Logger from 'pino'
 import HTTPLogger from 'pino-http'
-import http from 'node:http'
+
 import { ActivityDistributor } from './activitydistributor.js'
 import { ActivityPubClient } from './activitypubclient.js'
 import { ActorStorage } from './actorstorage.js'
@@ -34,7 +38,10 @@ import { JobReaper } from './jobreaper.js'
 import { DeliveryWorker } from './deliveryworker.js'
 import { DistributionWorker } from './distributionworker.js'
 
-export async function makeApp (databaseUrl, origin, bots, logLevel = 'silent', deliveryWorkerCount = 2, distributionWorkerCount = 8) {
+const currentDir = dirname(fileURLToPath(import.meta.url))
+const DEFAULT_INDEX_FILENAME = resolve(currentDir, '..', 'web', 'index.html')
+
+export async function makeApp ({ databaseUrl, origin, bots, logLevel = 'silent', deliveryWorkerCount = 2, distributionWorkerCount = 8, indexFileName = DEFAULT_INDEX_FILENAME }) {
   const logger = Logger({
     level: logLevel
   })
@@ -159,7 +166,8 @@ export async function makeApp (databaseUrl, origin, bots, logLevel = 'silent', d
     activityHandler,
     origin,
     deliverer,
-    deliveryWorkers
+    deliveryWorkers,
+    indexFileName
   }
 
   app.use(HTTPLogger({

package/lib/jobreaper.js

@@ -1,7 +1,7 @@
 import { setTimeout as sleep } from 'node:timers/promises'
 
-const DEFAULT_TIMEOUT = 5 * 60 * 1000   // 5 minutes
-const DEFAULT_INTERVAL = 60 * 1000       // 1 minute
+const DEFAULT_TIMEOUT = 5 * 60 * 1000 // 5 minutes
+const DEFAULT_INTERVAL = 60 * 1000 // 1 minute
 
 export class JobReaper {
   #jobQueue

package/lib/routes/server.js

@@ -4,22 +4,34 @@ import as2 from '../activitystreams.js'
 const router = express.Router()
 
 router.get('/', async (req, res) => {
-  const { formatter } = req.app.locals
-  const server = await as2.import({
-    '@context': [
-      'https://www.w3.org/ns/activitystreams',
-      'https://w3id.org/security/v1'
-    ],
-    id: formatter.format({ server: true }),
-    type: 'Service',
-    publicKey: formatter.format({ server: true, type: 'publickey' })
+  const fullUrl = `${req.protocol}://${req.get('host')}${req.originalUrl}`
+  res.format({
+    html: async () => {
+      const { indexFileName } = req.app.locals
+      res.sendFile(indexFileName)
+    },
+    json: async () => {
+      const { formatter } = req.app.locals
+      const server = await as2.import({
+        '@context': [
+          'https://www.w3.org/ns/activitystreams',
+          'https://w3id.org/security/v1'
+        ],
+        id: formatter.format({ server: true }),
+        type: 'Service',
+        publicKey: formatter.format({ server: true, type: 'publickey' }),
+        url: {
+          type: 'Link',
+          mediaType: 'text/html',
+          href: fullUrl
+        }
+      })
+      const body = await server.export({ useOriginalContext: true })
+      res.status(200)
+      res.type(as2.mediaType)
+      res.json(body)
+    }
   })
-  res.status(200)
-  res.type(as2.mediaType)
-  const body = await server.prettyWrite(
-    { additional_context: 'https://w3id.org/security/v1' }
-  )
-  res.end(body)
 })
 
 router.get('/publickey', async (req, res) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evanp/activitypub-bot",
-  "version": "0.21.2",
+  "version": "0.23.0",
   "description": "server-side ActivityPub bot framework",
   "type": "module",
   "main": "lib/index.js",

package/web/index.html

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>activitypub.bot</title>
+</head>
+<body>
+  <h1>activitypub.bot</h1>
+  <p>
+    This is an activitypub.bot server. It hosts automated &quot;bot&quot; accounts on the <a href="https://en.wikipedia.org/wiki/Fediverse">Fediverse</a>.
+  </p>
+  <p>
+    <a href="https://github.com/evanp/activitypub-bot">Source</a>
+  </p>
+</body>
+</html>