Actionhero is a realtime multi-transport nodejs API Server with integrated cluster capabilities and delayed tasks
APACHE-2.0 License
Bot releases are hidden (Show)
Published by evantahler over 4 years ago
Published by evantahler over 4 years ago
re-Enqueue
eventPublished by evantahler over 4 years ago
specHelper#deleteEnqueuedTasks
(https://github.com/actionhero/actionhero/pull/1398)Published by evantahler almost 5 years ago
Published by evantahler almost 5 years ago
Before
info: [ worker ] job success workerId=1 class=hello queue=default
After
info: [ worker ] job success workerId=1 class=hello queue=default args={"thing":"[FILTERED]", "id": 123}
We use config.general.filteredParams
, like the web server, to decide what params to filter when logged.
--daemon
option to start actionhero. It is now recommended to use a tool like PM2 or your OS's background process manager (ie systemd
) should you wish to run Actionhero in the background.Published by evantahler almost 5 years ago
Actionhero has moved to Typescript.
Typescript is a language that compiles
to javascript that makes the developer experience much nicer. It includes features like type checking, sharing interfaces and modules, and generally other "quality of life" features found in other languages to help you write better javascript code.
For Actionhero, that means we can now provide:
Type Hinting
Module definitions
Automatic Documentation directly from the code
Visit docs.actionherojs.com to see this live!
...and an overall more pleasant developer experience!
Note: You do not have to use Typescript to use Actionhero! Other than some layout changes to your project, you can continue to use Actionhero with regular javascript node.js projects. We will always ship compiled javascript files to NPM so that actionhero will still work with the most recent versions of Node.js. That said, the generators will favor Typescript projects moving forward, creating Typescript files
For now, the latest
Actionhero tag on NPM is still v20, the last javascript version of Actionhero. You can start using the Typescript version of Actionhero today by opting into the next
tag:
npm install actionhero@next
./node_modules/.bin/actionhero generate
npm install
npm run dev
Actionhero will create and install everything you need for a pleasant typescript experience, including a tsconfig
file, node's @types
and development tools already linked into your package.json
If you are upgarding an existing Actionhero project, the first thing to do is install the related packages and create new files:
npm install --save actionhero@next
npm install --save-dev @types/node prettier
npm uninstall standard
Update your scripts in package.json
"scripts": {
"dev": "ts-node-dev --transpile-only ./node_modules/.bin/actionhero start",
"start": "actionhero start",
"actionhero": "actionhero",
"test": "jest",
"pretest": "npm run build && npm run lint",
"postinstall": "npm run build",
"build": "tsc --declaration",
"lint": "prettier --check src/*/** __test__/*/**",
"pretty": "prettier --write src/*/** __test__/*/**"
},
and your jest
config as well, also in package.json
"jest": {
"testEnvironment": "node",
"transform": {
"^.+\\.ts?$": "ts-jest"
}
};
Remove the block about standard
from your package.json
. We are switching to prettier because it has better typescript support.
Remember - you will be using npm run dev
now when developing locally.
Typescript is managed by a tsconfig.json
file at the root of your project. Create one now with the following content:
{
"compilerOptions": {
"outDir": "./dist",
"allowJs": true,
"module": "commonjs",
"target": "es2018"
},
"include": ["./src/**/*"]
}
src
and dist
directoriessrc
modules
directoryYour project should now look like this:
|
|- boot.js
|- src
| - config
| - (project settings)
|
| - actions
| -- (your actions)
|
| - initializers
| -- (any additional initializers you want)
|
| - servers
| -- (custom servers you may make)
|
| - tasks
| -- (your tasks)
|
| - bin
| -- (your custom CLI commands)
|
|- locales
|-- (translation files)
|
|- __tests__
|-- (tests for your API)
|
| - log
|-- (default location for logs)
|
|- node_modules
|-- (your modules, actionhero should be npm installed in here)
|
|- pids
|-- (pidfiles for your running servers)
|
|- public
|-- (your static assets to be served by /file)
|
readme.md
package.json
Typescript uses the latest ES6-style syntax for importing and exporting things. You do not need to use babel to get this to work... Typescript does it for you!
src
from *.js
to *.ts
files
for f in _.js; do mv -- "$f" "${f%.js}.ts"; done
const {thing} = require('thing')
to Import-style import { thing } from 'thing'
module.exports = ...
or exports.thing = ...
to ES6-style export const thing = ...
For example:
OLD
const { Action } = require("actionhero");
exports.default = class MyAction extends Action {
constructor() {
super();
this.name = "hello";
this.description = "an actionhero action";
this.outputExample = { message: "hello" };
}
async run({ response }) {
response.message = "hello";
}
};
NEW
import { Action } from "actionhero";
export class MyAction extends Action {
constructor() {
super();
this.name = "hello";
this.description = "an actionhero action";
this.outputExample = { message: "hello" };
}
async run({ response }) {
response.message = "hello";
}
}
The config module (it is a module now!) produces a static object with your configuration. This means that it can be required via import {config} from 'actionhero'
at any point in your project's life cycle... you no longer need to wait for the initialization process to complete. However, this required some changes:
api
, they provide config
. Only other information from other config files is available to you, nothing from the rest of the application.To upgrade your config:
DEFAULT
(all caps), ie: export const DEFAULT = {config: { ... }}
config/general
, ie:paths: {
action: [path.join(__dirname, "..", "actions")],
task: [path.join(__dirname, "..", "tasks")],
server: [path.join(__dirname, "..", "servers")],
cli: [path.join(__dirname, "..", "bin")],
initializer: [path.join(__dirname, "..", "initializers")],
public: [path.join(process.cwd(), "public")],
pid: [path.join(process.cwd(), "pids")],
log: [path.join(process.cwd(), "log")],
plugin: [path.join(process.cwd(), "node_modules")],
locale: [path.join(process.cwd(), "locales")],
test: [path.join(process.cwd(), "__tests__")],
src: path.join(process.cwd(), "src"),
dist: path.join(process.cwd(), "dist")
}
Don’t forget any paths you might have in other environments (like test
)!
Now with Typescript, you’ll get an error if you try to set arbitrary properties on the data object either within an Action
or Middleware
. We need a place to pass data from the middleware to the action.
// in an initializer
import { action } from "actionhero";
import { models } from "./../models"; // in your project
const authenticatedTeamMemberMiddleware = {
name: "authenticated-team-member",
global: false,
priority: 1000,
preProcessor: async data => {
const { Team, TeamMember } = models;
const sessionData = await api.session.load(data.connection);
if (!sessionData) {
throw new Error("Please log in to continue");
} else if (
!data.params.csrfToken ||
data.params.csrfToken !== sessionData.csrfToken
) {
throw new Error("CSRF error");
} else {
const teamMember = await TeamMember.findOne({
where: { guid: sessionData.guid },
include: Team
});
data.session.data = sessionData; /// <--- HERE/
data.session.teamMember = teamMember; /// <--- HERE/
}
}
};
action.addMiddleware(authenticatedTeamMemberMiddleware);
A number of things have been moved out of the API object to simplify their use by creating import/export modules you can require directly. In this way, you can get type hinting for various parts of Actionhero! This is a logical separation between initializers
- code that executes when your server boots up and loads or connects vs modules
which provide an API for you to use in your code.
For example, the task
system has been split into 2 parts - both a module
and initializer
. The initializer continues to load your tasks into api.tasks.tasks
, but doesn’t expose any methods for you to use. Now, when you want to enqueue a task, you call task.enqueue()
you load it from the module via import {task} from 'actionhero'
The initialize
, start
, and stop
methods of your initializers will now be passed config
. This is helpful in the off chance you are modifying config
and cannot rely on the static export of that information (this is rare).
Removed from the API object and are now directly exported by Actionhero as modules:
ie: import { log, config } from 'actionhero'
The API object
what remains on the API object are truly things about your API - actions, tasks, servers, initializers. And now these elements are very typesafe. You can no longer add and remove things randomly to the API object. This means that in your project, you should create imports and exports directly and share them with your actions and tasks.
Polyfill
A polyfill will be included in the first few releases of Actionhero in typescript to port the new exports back to the api
object. A warning will be displayed.
A new config setting to enable or disable the polyfill is located at config.general.legacyApiPolyfill
config.general.id
: can no longer be setconfig.i18n.determineConnectionLocale
: this method should be set on the i18n
object exported by Actionhero.chatRoom.sanitizeMemberDetails()
is no longer overrideable/customizable.We have removed the custom module loaders for Actionhero's development mode, watchFileAndAct
. Now that we need to transpile our applications from typescript to javascript, we can rely on some of the excellent packages already developed for this purpose. Newly generated Actionhero projects will make use of node-ts-dev
(https://github.com/whitecolor/ts-node-dev) to boot and reload your projects when running in typescript mode.
Javascript projects can do a similar thing via the nodemon (https://nodemon.io/) package
Published by evantahler about 5 years ago
Related to https://github.com/actionhero/ah-swagger-plugin/pull/6
We have changed how Actionhero loads itself to always prefer components in node_modules
relative to the cwd
(current working directory):
Pros
npm install -g actionhero
) is now resistant to minor version changes between projectsdevDependancy
, and for us to boot the project and not have conflicting paths to source actionhero from. You can now just npm start
(./node_modules/.bin/actionhero
) in your plugins to start a server to run your pluginsCons
forever
) without first cd
-ing to the proper directory first things might not work depending on your load paths.This is a breaking change
Via https://github.com/actionhero/actionhero/pull/1338
Completes https://github.com/actionhero/actionhero/issues/1005
When generating a new action
or task
via the CLI, a template test will also now be creates in __tests__
. This will help encourage better testing of your actionhero projects. Of course, you can always delete the test files if you don't want it.
Adds api.config.general.paths.test
as setting in ./config/api.js
which defaults to [path.join(__dirname, '/../__tests__')]
This is a breaking change due to the new path
Via https://github.com/actionhero/actionhero/pull/1332
Currently, we have to add the custom error response code like this:
data.connection.rawConnection.responseHttpCode = 404
We can use the error.code that already exists in the error object
Now in action, you can do something like this :
const raiseNotFound = <your-condition>
if(raiseNotFound) {
const notFoundError = new Error(<msg>)
notFoundError.code = 404
throw notFoundError
}
via https://github.com/actionhero/actionhero/pull/1334
Adds api.specHelper.findEnqueuedTasks to write tests that check that task was enqueued!
describe('task testing', () => {
beforeEach(async () => {
await api.resque.queue.connection.redis.flushdb()
})
test('detect that a task was enqueued to run now', async () => {
await api.tasks.enqueue('regularTask', { word: 'testing' })
const found = await api.specHelper.findEnqueuedTasks('regularTask')
expect(found.length).toEqual(1)
expect(found[0].args[0].word).toEqual('testing')
expect(found[0].timestamp).toBeNull()
})
})
via https://github.com/actionhero/actionhero/pull/1331
NODE_ENV=test
(via https://github.com/actionhero/actionhero/pull/1336)Published by evantahler about 5 years ago
Published by evantahler over 5 years ago
Update test example and generated initializers so that they pass Standard.js checks
by @evanthaler via https://github.com/actionhero/actionhero/commit/06158ad3b57bfc451506f27e7510bea29ebeb7d8
Published by evantahler over 5 years ago
When creating a new Actionhero project, there is a now a top-level boot.js
file. You can use this new file to load or instantiate troublesome packages into your project that really want to be the first thing you load. Packages like newrelic
or dotenv
are these types of packages. Another use-case would be to configure your environment via an external source.
You can see the contents of boot.js
to add to an existing project here https://github.com/actionhero/actionhero/blob/master/bin/templates/boot.js
Via https://github.com/actionhero/actionhero/pull/1311 by @chimmelb
Now, if a periodic task fails, it will still be run again. This behavior is what the majority of Actionhero uses had expected was happening all along, so hopefully this change is less surprising for new Acitonhero users.
A new option has been added to tasks, reEnqueuePeriodicTaskIfException
with the default value of true
. If you want your tasks to not be re-enqueued should they throw an exception, you can set reEnqueuePeriodicTaskIfException = false
.
Via https://github.com/actionhero/actionhero/pull/1309 and https://github.com/actionhero/actionhero/commit/72fb343d5a0005ffa8e1f7550ca15c6fd169f82b by @dasagan
This change updates Actionhero's internal logging levels to more closely match The syslog protocol (RFC 5424). The details can be seen in the Pull Request.
Via https://github.com/actionhero/actionhero/pull/1314 by @aurasalexander
This new option updates ActionHero's development mode to "full" restart when an Action or Task changes, rather than a soft restart. This can be handy if you add a new initializer, param, or route.
Via https://github.com/actionhero/actionhero/pull/1313 by @aurasalexander
Published by evantahler over 5 years ago
Published by evantahler over 5 years ago
connection.create
middlewarePublished by evantahler over 5 years ago
Published by evantahler almost 6 years ago
When an error fails for a websocket client, we return response.error
. However, if a say
or roomAdd
fails for the same client, we do not set response.error
... now we do!
Add some more documentation about how you might contribute to ActionHero
Published by gcoonrod almost 6 years ago
web#urlPathForFiles
to null
now disables file server
Dependency | From Version | To Version |
---|---|---|
ioredis |
^4.1.0 |
^4.3.0 |
primus |
^7.2.3 |
^7.3.2 |
qs |
^6.5.2 |
^6.6.0 |
ws |
^6.1.0 |
^6.1.2 |
mime |
^2.3.1 |
^2.4.0 |
docdash |
^1.0.0 |
^1.0.1 |
Published by evantahler about 6 years ago
api.chatRoom.broadcast
should throw an error if something goes wrong (rather than return a string)
await
a connection leaving all member rooms when destroying it
And of course...
Published by evantahler about 6 years ago
Bringing the changes from #1243 in so we can build the docs for this version
Published by evantahler about 6 years ago
Bringing the changes from #1243 in so we can build the docs for this version
Published by evantahler about 6 years ago
Bringing the changes from https://github.com/actionhero/actionhero/pull/1243 in so we can build the docs for this version
Published by evantahler over 6 years ago