Version 2 of Foal has been released in December 2020 🎉. This series of four articles presents the major new features.
Let’s get started!
Contents
- 1 New CLI commands#
- 2 Generating migrations#
- 3 Running migrations#
- 4 Build and run scripts in watch mode (development)#
- 5 Revert one migration#
- 6 Build migrations, scripts and the app#
- 7 Service and Application Initialization#
- 8 The AppController interface#
- 9 Custom Error-Handling & Hook Post Functions#
- 10 Accessing File Metadata during Uploads#
New CLI commands#
In version 1, there were many commands to use, and this, in a specific order. Running and generating migrations from model changes required four commands and building the whole application needed three.
In version 2, the number of CLI commands has been reduced and they have been simplified so that one action matches one command.
Generating migrations#
This command generates migrations by comparing the current database schema and the latest changes in your models.
Running migrations#
This command builds and runs all migrations.
Build and run scripts in watch mode (development)#
If you want to re-build your scripts each time a file is change, you can execute npm run develop in a separate terminal.
Revert one migration#
This command reverts the last executed migration.
Build migrations, scripts and the app#
This command builds the application, the scripts and the migrations. Unit and e2e tests are not included.
Service and Application Initialization#
In version 1, it was possible to add an init method to the AppController class and boot methods in the services to initialize the application. These features needed special options in order to be activated.
Starting from version 2, they are enabled by default.
The AppController interface#
This optional interface allows you to check that the subControllers property has the correct type as well as the init and handleError methods.
Custom Error-Handling & Hook Post Functions#
In version 1, when an error was thrown or rejected in a hook or a controller method, the remaining hook post functions were not executed.
Starting from version 2, the error is directly converted to an HttpResponseInternalServerError and passed to the next post hook functions.
This can be useful in case we want to use exceptions as HTTP responses without breaking the hook post functions.
Example
Accessing File Metadata during Uploads#
When using the @ValidateMultipartFormDataBody hook to handle file upload, it is now possible to access the file metadata.
Example
| Property name | Type | Description |
|---|---|---|
encoding |
string |
Encoding type of the file |
filename |
string|undefined |
Name of the file on the user’s computer |
mimeType |
string |
Mime type of the file |
path |
string |
Path where the file has been saved. If the saveTo option was not provided, the value is an empty string. |
buffer |
Buffer |
Buffer containing the entire file. If the saveTo option was provided, the value is an empty buffer. |
