Rinobot NPM | npm.io

Rinobot.js

Rinocloud lets you schedule tasks when files are created. Its useful for processing data automatically if your doing experiments or simulations.

This is the command line version of the program, not to be confused with the full rinobot app.

Getting started

Install from npm - you'll need node and npm installed

npm install rinobot -g

To run rinobot just type:

rinobot path/to/watch/

rinobot will then check the path for a rino.yaml file. If it exists it will start watching.

rino.yaml

The rino.yaml file describes the tasks you want done when a file appears in the watched directory.

We call these collection of tasks a pipeline. When a file is created, it will be run through the pipeline. If any of the tasks in the pipeline fail, we will queue the pipeline and try it again later.

example

Here is a simple example that uploads all .txt files that appear in a directory

apiToken: 8186755009251ef0bbb273fbc86d7b9caa228374

tasks:
  - match: "*.txt"
    command: "rinocloud-upload"
    on: add

And here is an example that calls the python script plot.py and plots the data and the uploads the .txt and .png file.

apiToken: 8186755009251ef0bbb273fbc86d7b9caa228374

ignore:
  - "*.py"

tasks:
  - match: "*.txt"
    command: "python"
    args: "plot.py {{filepath}}"

  - match: "*.txt"
    command: "rinocloud-upload"
    on: add

  - match: "*.png"
    command: "rinocloud-upload"
    on: add

Here is the plot.py file:

import sys
import numpy as np
import matplotlib.pyplot as plt

fpath = sys.argv[1]
data =  np.loadtxt(fpath)

plt.imshow(data, extent=[0, 100, 0, 1], aspect='auto')
plt.savefig(fpath.replace('.txt', '.png'))

development

This section is only relevant if you want to integrate rinobot with your javascript codebase or to develop rinobot itself.

To get setup run

npm install

And to start testing run

npm run test

All the source code lives in src/, the source is all es6 javascript, so it needs to be transpiled before we can distribute. So run npm run build to create the library is the dist/ folder.

example

const watchPath = 'some/dir'

const w = watcher
  .getChokidar()
  .watch(watchPath)
  .on('all', (event, path, stats) => {
    var p = new pipeline.Pipeline({
      path,
      event,
      watchPath,
      on_complete: function(pipeline){ console.log(pipeline.relPath + ' done') }
      on_log: function(pipeline, msg){ console.log(pipeline.relPath + ' ' + msg) }
    })
  })

pipeline

import {pipeline} from 'rinobot'
const p = new pipeline.Pipeline(options)

options has three required properties

event: String, the name of the event given by chokidar
path: Path, the path given by the chokidar event
watchPath: Path, the path of the root directory being watched

options has some optional properties

on_complete: function(pipeline), called when the entire pipeline completes successfully
on_error: function(pipeline, err), called if the pipeline fails to complete - the pipeline will abort before the error is thrown
on_ignore: function(pipeline), called if the pipeline ignores the file
on_log: function(pipeline, message), general log for entire pipeline
on_task_complete: function(pipeline, task, err), called when a task completes
on_task_error: function(pipeline, task), called when a task fails - the pipeline will abort
on_task_ignore: function(pipeline, task), called if the task has already been completed, or ignored for some other reason
api: rinocloud-javascript api instance, defaults to making its own instance

task

import {task} from 'rinobot'
const t = new task.Task(options)

A task will run on a schedule in series. And a group of tasks in a pipeline will all run in series with respect to all the other pipeline tasks.

If a pipeline fails, its tasks are removed from the queue and then there is a timeout and the pipeline is put to the end of the queue again.

watcher

import {watcher} from 'rinobot'

Chokidar is the library we use to monitor files, and we have a specific functions getChokidar to get the chokidar instance, this is because sometimes the pipelines and watcher operate in different process threads (for example in an electron.js application).

const chokidar = watcher.getChokidar()

Add a watcher to the list of watchers

watcher.addWatch(watch)

Close all the watchers

watcher.close()

Close a specific watcher by index

watcher.closeByIndex(index)

Rinobot.js event specification

Chokidar events:

add
- Triggered upon creating file, renaming file, renaming one of the parent folders, moving parent folder, moving file
unlink
- Triggered upon deleting file, renaming file, renaming one of the parent folders, moving parent folder, moving file
addDir
- Triggered upon creating folder, renaming folder, renaming one of the parent folders, moving parent folder
unlinkDir
- Triggered upon deleting folder, renaming folder, renaming one of the parent folders, moving parent folder
change
- Upon overwriting

User actions:

Create folder (addDir event)
Create file (add event)
Delete folder (unlinkDir or crashing program)
Delete file (unlink event)
Rename folder (unlinkDir + addDir events + multiple unlink, add, unlinkDir, addDir events for subfolders and files within)
Rename file (unlink + add events)
Change file (change event)
Move folder (unlinkDir + addDir events + multiple unlink, add, unlinkDir, addDir events for subfolders and files within).
Move file (unlink + add events)

Discriminating user actions:

No previously triggered unlink or unlinkDir event within 1 or 2 sec - create file or folder
No following triggered add oraddDir event within 1 or 2 sec - delete file or folder
If sequent unlink + add (issue: the order is not necessarily the same) triggered, can be:
- Renamed file (how to discriminate: events only two, the same base path)
- Renamed parent folder (Accompanied by at least unlinkDir + addDir. If the file is within modified folder path, only the modified folder has to be updated).
- Moved file (Events only two, different base path, file name the same. Issue: multiple files moved)
- Moved parent folder (Accompanied by at least unlinkDir + addDir. If the file is within modified folder path, only the top modified folder has to be updated)
If sequent unlinkDir + addDir (the order is not necessarily the same) triggered, can be:
- Renamed folder (find the top)