v2.0.0

[LoicPoullain]

General issue: #658

Features

1. Developper experience (CLI) ✅

• Simplify commands for scripts and migrations (issue: Improve developper experience with scripts and migrations #494) (PR: [V2] Simplify commands for scripts, migrations and improve coder experience #684).

2. Authentication with sessions ✅

Summary: #799.

• Simplify logout (issue: [V2][Sessions] Simplify the logout #726) (PR: [V2] [Sessions] Simplify logout #659)
• Remove the need for a secret (issue: [V2][Sessions] Remove the need for a secret #727) (PR: [V2][Sessions] Remove the need for a secret #742)
• Do not let TypeORMStore auto-update the database schema (issue: [V2][Sessions] Do not try to update the database schema each time the application is launched #766) (PR: [V2][Sessions] Do not let TypeORMStore auto-update the database schema. #767)
• Allow to query all sessions of a user (issue: How to query all sessions of a user? #510) (PR: [V2] Officially support authenticated sessions and allow to perform certain actions on them. #780)
• Allow to query all connected users (issue: Allow to query all connected users #778) (PR: [V2] Officially support authenticated sessions and allow to perform certain actions on them. #780)
• Allow to force the disconnection of a user (issue: Allow to force the disconnection of a user #779) (PR: [V2] Officially support authenticated sessions and allow to perform certain actions on them. #780)
• Support flash sessions (issue: Sessions : support flash data #521) (PR: [V2] Support flash sessions #781)
• Allow to regenerate the session ID for security reasons (issue: [Sessions] Allow to regenerate the session ID #728) (PR: [V2] Simplify session system, make it more robust and add new features #792).
• Make it easier to implement a custom session store and maintain it (issue: [V2][Sessions] Simplify the implementation of a session stores. #794) (PR: [V2] Simplify session system, make it more robust and add new features #792).
• Cleanup regularly expired sessions in MongoStore and TypeORMStore (issue: [V2][Sessions] Cleanup regularly expired sessions #793) (PR: [V2] Simplify session system, make it more robust and add new features #792).
• Make it easier to use templates and to authenticate anonymous users (issue: [V2][Sessions] Make it easier to use templates and to authenticate anonymous users #795) (PR: [V2] Simplify session system, make it more robust and add new features #792).
• [MongoStore] Use sessionID instead of _id to prevent errors on hex vs base64 (issue: [V2][MongoStore] Do not use session ID as collection ID #797) (PR: [MongoStore] Use sessionID instead of _id #800)
• [V2][Sessions] Remove the need of setSessionCookie in login (issue: [V2][Sessions] Remove the need of setSessionCookie in login #796) (PR: [V2][Sessions] Remove the need of setSessionCookie in login #801)
• Make it easy/fast to use CSRF tokens with sessions (SPA & regular apps) (issue: [V2][Sessions] Make it super easy/fast to use CSRF tokens with sessions (SPA & regular apps) #798) (PR: [V2][Sessions] Make it easy/fast to use CSRF tokens with sessions (SPA & regular apps) #802)
• Do not save sessions if an error is thrown in a controller or a hook (PR: [V2] Do not save sessions on 500 #823).

3. Schema references in validation hooks ✅

• Allow to use OpenAPI schema references (issue: Ajv $ref problem #552) (PR: Allow to use OpenAPI schema references #734)

4. Service initialization ✅

• Initialize services by default (PR: [V2] Initialize services by default #733)

5. Accessing file metadata during uploading ✅

• [File upload] Access file size, mime type, encoding and original file name (issue: file metadata info while upload #673) (PR: [V2] [File upload] Access file size, mime type, encoding and original file name #730)

6. Safer configuration ✅

• Replace Config.get with Config.get2 (issue: Safer config access #496) (PR: [V2] Replace Config.get with Config.get2 #732)

7. Improve the naming of JWT settings ✅

• PR: [V2][Sessions] Make it easy/fast to use CSRF tokens with sessions (SPA & regular apps) #802

8. Remove support of Mongoose ✅

• Remove support of Mongoose (PR: [V2] Remove support of Mongoose #741)

9. Improve the configuration system ✅

• Use new configuration system (issues: Config: support .env.testing and .env.e2e files #497, [V2] Have a better configuration system #805) (PR: [V2] Use new configuration system #806)

10. Simplify the management of custom errors thrown in controllers and hooks ✅

• Simplify the management of custom errors thrown in controllers and hooks (issue: Make HttpResponseNotFound behaves like an Exception #638) (PR: Simplify the management of custom errors thrown in controllers and hooks #807)

11. Cleanup ✅

• Drop NodeJS 8 support and test NodeJS 12 (PR: [V2] Drop NodeJS 8 support and test NodeJS 12. #699).
• Remove outdated and useless security headers.
• Remove the objects ObjectDoesNotExist, PermissionDenied (PR: Remove the objects ObjectDoesNotExist, PermissionDenied and the func… #718)
• PR: Cleanup #804

Dependencies

Packages

• @foal/cli
  • [email protected]
• @foal/jwks-rsa
  • [email protected]
• @foal/swagger
  • [email protected]
• @foal/typestack
  • [email protected] (peer dependency)

Generated projects (foal createapp)

• [email protected]
• @types/[email protected]
• @types/[email protected]
• [email protected]
• [email protected]
• [email protected]
• [email protected]

[codecov]

Codecov Report

Merging #663 into master will decrease coverage by 0.06%.
The diff coverage is 94.73%.

@@            Coverage Diff             @@
##           master     #663      +/-   ##
==========================================
- Coverage   99.65%   99.58%   -0.07%     
==========================================
  Files          94       94              
  Lines        1725     1697      -28     
  Branches      408      377      -31     
==========================================
- Hits         1719     1690      -29     
- Misses          6        7       +1     

Impacted Files	Coverage Δ
packages/core/src/index.ts	90.00% <80.00%> (-10.00%)	⬇️
packages/core/src/sessions/session.ts	100.00% <100.00%> (ø)
packages/core/src/sessions/token.hook.ts	100.00% <100.00%> (ø)
packages/core/src/core/routes/utils.ts	100.00% <0.00%> (ø)
packages/core/src/express/create-app.ts	100.00% <0.00%> (ø)
packages/core/src/express/handle-errors.ts	100.00% <0.00%> (ø)
packages/core/src/express/send-response.ts	100.00% <0.00%> (ø)
packages/core/src/core/http/http-methods.ts	100.00% <0.00%> (ø)
packages/core/src/core/http/http-responses.ts	100.00% <0.00%> (ø)
packages/core/src/express/create-middleware.ts	100.00% <0.00%> (ø)
... and 7 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 37af9c7...37af9c7. Read the comment docs.

[codecov-commenter]

Codecov Report

Merging #663 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #663   +/-   ##
=======================================
  Coverage   99.58%   99.58%           
=======================================
  Files          94       94           
  Lines        1706     1706           
  Branches      380      380           
=======================================
  Hits         1699     1699           
  Misses          7        7           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 27279c1...27279c1. Read the comment docs.

[LoicPoullain]

Version 2 is officially released 🎉 It now has latest tag on npm