rtail 0.2.1 → 2.0.0-rc.3

package/bin/rtail.js

@@ -0,0 +1,97 @@
+#!/usr/bin/env node
+'use strict'
+
+/*!
+ * The npm entry point: find this machine's binary and become it.
+ *
+ * rtail is a Go program. npm is one of the ways to get it, because the people
+ * who pipe logs into it are often already standing in a project with a
+ * package.json — but nothing here implements the client, and this file is the
+ * only JavaScript left in the install.
+ *
+ * ** Why a launcher at all. **
+ *
+ * The binaries ship as one package per platform (`@rtail/darwin-arm64` and
+ * friends), each declaring `os` and `cpu`, listed here as optional
+ * dependencies. npm installs the one that matches and silently skips the
+ * rest, so a Linux box downloads a Linux binary and nothing else. That is the
+ * arrangement esbuild uses, and it is the only one that needs no install-time
+ * download: no postinstall script, no curl, nothing that breaks behind a
+ * proxy or under `--ignore-scripts`.
+ *
+ * The cost is this file. A platform package can declare its own `bin`, and
+ * for a local install npm would link it — but `npm i -g rtail` links the bins
+ * of the named package only, never a transitive dependency's, so a global
+ * install would leave no `rtail` on PATH. Hence a launcher in the package the
+ * user actually named.
+ *
+ * Anyone who would rather not have Node in the path at all can take the
+ * binary straight from a release tarball, `go install`, or the container.
+ */
+
+const { spawnSync } = require('node:child_process')
+const { constants } = require('node:os')
+
+// Go and Node spell the same architectures differently.
+const PLATFORMS = {
+  'darwin-arm64': '@rtail/darwin-arm64',
+  'darwin-x64': '@rtail/darwin-x64',
+  'linux-arm64': '@rtail/linux-arm64',
+  'linux-x64': '@rtail/linux-x64',
+  'win32-x64': '@rtail/win32-x64'
+}
+
+const key = `${process.platform}-${process.arch}`
+const pkg = PLATFORMS[key]
+
+if (!pkg) {
+  console.error(
+    `rtail: no prebuilt binary for ${key}.\n` +
+      'Build one with `go install github.com/kilianc/rtail/v2/cmd/rtail@latest`,\n' +
+      'or open an issue at https://github.com/kilianc/rtail/issues if this\n' +
+      'platform should be published.'
+  )
+  process.exit(1)
+}
+
+const exe = 'win32' === process.platform ? 'rtail.exe' : 'rtail'
+
+let binary
+
+try {
+  binary = require.resolve(`${pkg}/bin/${exe}`)
+} catch {
+  // The optional dependency was skipped — almost always --no-optional, or a
+  // lockfile copied from a machine of a different shape.
+  console.error(
+    `rtail: ${pkg} is not installed.\n` +
+      'It is an optional dependency carrying the binary for this platform.\n' +
+      `Reinstall without --no-optional, or \`npm install ${pkg}\` directly.`
+  )
+  process.exit(1)
+}
+
+/*!
+ * stdio is inherited, which is the whole point.
+ *
+ * rtail is a pipe. Its stdin is the producer's stdout and its own stdout is
+ * whatever came next in the shell, so the file descriptors are handed over
+ * untouched rather than copied through this process — which also means no
+ * buffering, no mangling of a partial line, and a SIGINT at the terminal
+ * reaching the binary directly.
+ */
+const result = spawnSync(binary, process.argv.slice(2), { stdio: 'inherit' })
+
+if (result.error) {
+  console.error(`rtail: ${result.error.message}`)
+  process.exit(1)
+}
+
+// A child killed by a signal has a null status; 128 + signal is the shell's
+// convention for reporting that, and exiting 0 would claim it succeeded.
+if (null === result.status) {
+  const number = constants.signals[result.signal]
+  process.exit(number ? 128 + number : 1)
+}
+
+process.exit(result.status)

package/package.json

@@ -1,76 +1,24 @@
 {
   "name": "rtail",
-  "version": "0.2.1",
+  "version": "2.0.0-rc.3",
   "description": "Terminal output to the browser in seconds, using UNIX pipes.",
-  "keywords": [
-    "tail",
-    "log",
-    "logs",
-    "logio",
-    "logging",
-    "udp"
-  ],
-  "bin": {
-    "rtail": "./cli/rtail-client.js",
-    "rtail-server": "./cli/rtail-server.js"
+  "keywords": ["log", "logging", "logio", "logs", "tail", "udp"],
+  "bin": { "rtail": "bin/rtail.js" },
+  "files": ["bin", "NOTICE"],
+  "engines": { "node": ">=20" },
+  "optionalDependencies": {
+    "@rtail/linux-x64": "2.0.0-rc.3",
+    "@rtail/linux-arm64": "2.0.0-rc.3",
+    "@rtail/darwin-x64": "2.0.0-rc.3",
+    "@rtail/darwin-arm64": "2.0.0-rc.3",
+    "@rtail/win32-x64": "2.0.0-rc.3"
   },
   "repository": {
     "type": "git",
-    "url": "git@github.com:kilianc/rtail.git"
-  },
-  "dependencies": {
-    "chrono-node": "^1.0.6",
-    "debug": "^2.1.0",
-    "express": "^4.10.0",
-    "json5": "^0.4.0",
-    "moniker": "^0.1.2",
-    "request": "^2.58.0",
-    "socket.io": "^1.1.0",
-    "split": "^1.0.0",
-    "strip-ansi": "^3.0.0",
-    "through2-map": "^2.0.0",
-    "update-notifier": "^0.5.0",
-    "yargs": "^3.14.0"
-  },
-  "devDependencies": {
-    "angular": "^1.3.15",
-    "angular-animate": "^1.4.0",
-    "angular-localforage": "^1.2.2",
-    "angular-moment": "^0.10.1",
-    "angular-rt-popup": "^1.0.5",
-    "angular-ui-router": "^0.2.15",
-    "ansi_up": "^1.2.1",
-    "autoprefixer-core": "^5.1.11",
-    "chai": "^3.0.0",
-    "del": "^1.1.1",
-    "gulp": "^3.9.0",
-    "gulp-ejs": "^1.1.0",
-    "gulp-livereload": "^3.8.0",
-    "gulp-load-plugins": "^0.10.0",
-    "gulp-minify-css": "^1.1.1",
-    "gulp-minify-html": "^1.0.2",
-    "gulp-ng-annotate": "^1.0.0",
-    "gulp-postcss": "^5.1.6",
-    "gulp-sass": "^2.0.1",
-    "gulp-sourcemaps": "^1.5.2",
-    "gulp-uglify": "^1.2.0",
-    "gulp-useref": "^1.1.2",
-    "gulp-util": "^3.0.4",
-    "highlight.js": "isagalaev/highlight.js",
-    "istanbul": "^0.3.17",
-    "istanbul-harmony": "^0.3.16",
-    "jquery": "^2.1.4",
-    "localforage": "^1.2.2",
-    "mocha": "^2.2.5",
-    "moment": "^2.10.3",
-    "node-sass": "^3.1.1",
-    "run-sequence": "^1.1.0"
-  },
-  "scripts": {
-    "app": "DEBUG=rtail:*,api:* gulp app",
-    "test": "NODE_ENV=test node --harmony test/runner.js",
-    "test:watch": "NODE_ENV=test nodemon --harmony test/runner.js"
+    "url": "git+https://github.com/kilianc/rtail.git"
   },
+  "homepage": "https://github.com/kilianc/rtail#readme",
+  "bugs": "https://github.com/kilianc/rtail/issues",
   "author": "Kilian Ciuffolo <me@nailik.org>",
-  "license": "MIT"
+  "license": "Apache-2.0"
 }

package/.jscsrc

@@ -1,28 +0,0 @@
-{
-  "preset": "airbnb",
-  "esnext": true,
-  "verbose": true,
-  "disallowCapitalizedComments": true,
-  "disallowMultipleLineBreaks": true,
-  "disallowMultipleSpaces": true,
-  "disallowSemicolons": true,
-  "disallowSpacesInAnonymousFunctionExpression": null,
-  "disallowSpacesInFunctionExpression": null,
-  "disallowYodaConditions": null,
-  "requireCamelCaseOrUpperCaseIdentifiers": null,
-  "requirePaddingNewLinesAfterUseStrict": true,
-  "requireSpacesInAnonymousFunctionExpression": {
-    "beforeOpeningRoundBrace": true,
-    "beforeOpeningCurlyBrace": true
-  },
-  "safeContextKeyword": ["self", "doc", "ctx"],
-  "validateIndentation": 2,
-  "plugins": [
-    "jscs-jsdoc"
-  ],
-  "jsDoc": {
-    "checkAnnotations": "closurecompiler",
-    "checkTypes": "strictNativeCase",
-    "enforceExistence": "exceptExports"
-  }
-}

package/.jshintrc

@@ -1,11 +0,0 @@
-{
-  "asi": true,
-  "esnext": true,
-  "expr": true,
-  "mocha": true,
-  "node": true,
-  "noyield": true,
-  "strict": true,
-  "unused": true,
-  "validthis": true
-}

package/.npmignore

@@ -1,4 +0,0 @@
-!dist
-app
-gulpfile.js
-wercker.yml

package/.scss-lint.yml

@@ -1,11 +0,0 @@
-linters:
-  ImportantRule:
-    enabled: false
-  Compass::*:
-    enabled: false
-  SelectorDepth:
-    enabled: false
-  NestingDepth:
-    enabled: false
-  PropertyCount:
-    enabled: false

package/cli/lib/webapp.js

@@ -1,54 +0,0 @@
-/*!
- * webapp.js
- * Created by Kilian Ciuffolo on Nov 11, 2014
- * (c) 2014-2015
- */
-
-'use strict'
-
-const debug = require('debug')('rtail:webapp')
-const get = require('request').defaults({ encoding: null })
-
-// serve frontend from s3
-module.exports = function webapp(opts) {
-  let cache = Object.create(null)
-  let cacheTTL = opts.ttl
-  let s3 = opts.s3
-
-  /*!
-   * wipes out cache every cacheTTL ms
-   */
-  setInterval(function () {
-    cache = Object.create(null)
-    debug('cleared cache')
-  }, cacheTTL)
-
-  /*!
-   * middleware
-   */
-  return function (req, res) {
-    if (cache[req.path]) {
-      return serveCache(req, res)
-    }
-
-    debug('caching %s', req.path)
-
-    get(s3 + req.path, function (err, s3res, body) {
-      cache[req.path] = {
-        headers: s3res.headers,
-        body: body
-      }
-
-      serveCache(req, res)
-    })
-  }
-
-  /*!
-   * serves req from cache
-   */
-  function serveCache(req, res) {
-    debug('serving from cache %s', req.path)
-    res.writeHead(200, cache[req.path].headers)
-    res.end(cache[req.path].body)
-  }
-}

package/cli/rtail-client.js

@@ -1,156 +0,0 @@
-#!/bin/sh
-":" //# comment; exec /usr/bin/env node --harmony "$0" "$@"
-
-/*!
- * rtail-client.js
- * Created by Kilian Ciuffolo on Oct 26, 2014
- * (c) 2014-2015
- */
-
-'use strict'
-
-const dgram = require('dgram')
-const split = require('split')
-const chrono = require('chrono-node')
-const JSON5 = require('json5')
-const yargs = require('yargs')
-const map = require('through2-map')
-const stripAnsi = require('strip-ansi')
-const moniker_ = require('moniker').choose
-const updateNotifier = require('update-notifier')
-const pkg = require('../package')
-
-/*!
- * inform the user of updates
- */
-updateNotifier({
-  packageName: pkg.name,
-  packageVersion: pkg.version
-}).notify()
-
-/*!
- * parsing argv
- */
-let argv = yargs
-  .usage('Usage: cmd | rtail [OPTIONS]')
-  .example('server | rtail > server.log', 'localhost + file')
-  .example('server | rtail --id api.domain.com', 'Name the log stream')
-  .example('server | rtail --host example.com', 'Sends to example.com')
-  .example('server | rtail --port 43567', 'Uses custom port')
-  .example('server | rtail --mute', 'No stdout')
-  .example('server | rtail --no-tty', 'Strips ansi colors')
-  .example('server | rtail --no-date-parse', 'Disable date parsing/stripping')
-  .option('host', {
-    alias: 'h',
-    type: 'string',
-    default: '127.0.0.1',
-    describe: 'The server host'
-  })
-  .option('port', {
-    alias: 'p',
-    type: 'string',
-    default: 9999,
-    describe: 'The server port'
-  })
-  .option('id', {
-    alias: 'name',
-    type: 'string',
-    default: function moniker() { return moniker_() } ,
-    describe: 'The log stream id'
-  })
-  .option('mute', {
-    alias: 'm',
-    type: 'boolean',
-    describe: 'Don\'t pipe stdin with stdout'
-  })
-  .option('tty', {
-    type: 'boolean',
-    default: true,
-    describe: 'Keeps ansi colors'
-  })
-  .option('parse-date', {
-    type: 'boolean',
-    default: true,
-    describe: 'Looks for dates to use as timestamp'
-  })
-  .help('help')
-  .version(pkg.version, 'version')
-  .alias('version', 'v')
-  .strict()
-  .argv
-
-/*!
- * setup pipes
- */
-if (!argv.mute) {
-  if (!process.stdout.isTTY || !argv.tty) {
-    process.stdin
-      .pipe(map(function (chunk) {
-        return stripAnsi(chunk.toString('utf8'))
-      }))
-      .pipe(process.stdout)
-  } else {
-    process.stdin.pipe(process.stdout)
-  }
-}
-
-/*!
- * initialize socket
- */
-let isClosed = false
-let isSending = 0
-let socket = dgram.createSocket('udp4')
-let baseMessage = { id: argv.id }
-
-socket.bind(function () {
-  socket.setBroadcast(true)
-})
-
-/*!
- * broadcast lines to browser
- */
-process.stdin
-  .pipe(split(null, null, { trailing: false }))
-  .on('data', function (line) {
-    let timestamp = null
-
-    try {
-      // try to JSON parse
-      line = JSON5.parse(line)
-    } catch (err) {
-      // look for timestamps if not an object
-      timestamp = argv.parseDate ? chrono.parse(line)[0] : null
-    }
-
-    if (timestamp) {
-      // escape for regexp and remove from line
-      timestamp.text = timestamp.text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&')
-      line = line.replace(new RegExp(' *[^ ]?' + timestamp.text + '[^ ]? *'), '')
-      // use timestamp as line timestamp
-      baseMessage.timestamp = Date.parse(timestamp.start.date())
-    } else {
-      baseMessage.timestamp = Date.now()
-    }
-
-    // update default message
-    baseMessage.content = line
-
-    // prepare binary message
-    let buffer = new Buffer(JSON.stringify(baseMessage))
-
-    // set semaphore
-    isSending ++
-
-    socket.send(buffer, 0, buffer.length, argv.port, argv.host, function () {
-      isSending --
-      if (isClosed && !isSending) socket.close()
-    })
-  })
-
-/*!
- * drain pipe and exit
- */
-process.stdin.on('end', function () {
-  isClosed = true
-  if (!isSending) socket.close()
-})

package/cli/rtail-server.js

@@ -1,144 +0,0 @@
-#!/bin/sh
-":" //# comment; exec /usr/bin/env node --harmony "$0" "$@"
-
-/*!
- * server.js
- * Created by Kilian Ciuffolo on Oct 26, 2014
- * (c) 2014-2015
- */
-
-'use strict'
-
-const dgram = require('dgram')
-const app = require('express')()
-const serve = require('express').static
-const http = require('http').Server(app)
-const io = require('socket.io')()
-const yargs = require('yargs')
-const debug = require('debug')('rtail:server')
-const webapp = require('./lib/webapp')
-const updateNotifier = require('update-notifier')
-const pkg = require('../package')
-
-/*!
- * inform the user of updates
- */
-updateNotifier({
-  packageName: pkg.name,
-  packageVersion: pkg.version
-}).notify()
-
-/*!
- * parsing argv
- */
-let argv = yargs
-  .usage('Usage: rtail-server [OPTIONS]')
-  .example('rtail-server --web-port 8080', 'Use custom HTTP port')
-  .example('rtail-server --udp-port 8080', 'Use custom UDP port')
-  .example('rtail-server --web-version stable', 'Always uses latest stable webapp')
-  .example('rtail-server --web-version unstable', 'Always uses latest develop webapp')
-  .example('rtail-server --web-version 0.1.3', 'Use webapp v0.1.3')
-  .option('udp-host', {
-    alias: 'uh',
-    default: '127.0.0.1',
-    describe: 'The listening UDP hostname'
-  })
-  .option('udp-port', {
-    alias: 'up',
-    default: 9999,
-    describe: 'The listening UDP port'
-  })
-  .option('web-host', {
-    alias: 'wh',
-    default: '127.0.0.1',
-    describe: 'The listening HTTP hostname'
-  })
-  .option('web-port', {
-    alias: 'wp',
-    default: 8888,
-    describe: 'The listening HTTP port'
-  })
-  .option('web-version', {
-    type: 'string',
-    describe: 'Define web app version to serve'
-  })
-  .help('help')
-  .alias('help', 'h')
-  .version(pkg.version, 'version')
-  .alias('version', 'v')
-  .strict()
-  .argv
-
-/*!
- * UDP sockets setup
- */
-let streams = {}
-let socket = dgram.createSocket('udp4')
-
-socket.on('message', function (data, remote) {
-  // try to decode JSON
-  try { data = JSON.parse(data) }
-  catch (err) { return debug('invalid data sent') }
-
-  if (!streams[data.id]) {
-    streams[data.id] = []
-    io.sockets.emit('streams', Object.keys(streams))
-  }
-
-  let message = {
-    timestamp: data.timestamp,
-    streamid: data.id,
-    host: remote.address,
-    port: remote.port,
-    content: data.content,
-    type: typeof data.content
-  }
-
-  // limit backlog to 100 lines
-  streams[data.id].length >= 100 && streams[data.id].shift()
-  streams[data.id].push(message)
-
-  debug(JSON.stringify(message))
-  io.sockets.to(data.id).emit('line', message)
-})
-
-/*!
- * socket.io
- */
-io.on('connection', function (socket) {
-  socket.emit('streams', Object.keys(streams))
-  socket.on('select stream', function (stream) {
-    socket.leave(socket.rooms[0])
-    if (!stream) return
-    socket.join(stream)
-    socket.emit('backlog', streams[stream])
-  })
-})
-
-/*!
- * serve static webapp from S3
- */
-if (!argv.webVersion) {
-  app.use(serve(__dirname + '/../dist'))
-} else if ('development' === argv.webVersion) {
-  app.use('/app', serve(__dirname + '/../app'))
-  app.use('/node_modules', serve(__dirname + '/../node_modules'))
-  io.path('/app/socket.io')
-} else {
-  app.use(webapp({
-    s3: 'http://rtail.s3-website-us-east-1.amazonaws.com/' + argv.webVersion,
-    ttl: 1000 * 60 * 60 * 6 // 6H
-  }))
-
-  debug('serving webapp from: http://rtail.s3-website-us-east-1.amazonaws.com/%s', argv.webVersion)
-}
-
-/*!
- * listen!
- */
-io.attach(http, { serveClient: false })
-socket.bind(argv.udpPort, argv.udpHost)
-http.listen(argv.webPort, argv.webHost)
-
-debug('UDP  server listening: %s:%s', argv.udpHost, argv.udpPort)
-debug('HTTP server listening: http://%s:%s', argv.webHost, argv.webPort)