Rearchitect based on recipes and modules

[rishabhpoddar]

Core

• Load the configs
• Load the storage layer
• Parse CLI args
• Start cronjob scheduler
• Start webserver
• Load module manager (see below)
• Load version file
• Initialise logging
• Listen for kill signal (and propagates them to the modules)

Module manager

Should be responsible for:

• Loads all the module JARs and their dependencies from the /modules/ directory in the installation location

• Routing of an API to a module:

  • Check if the API path starts with /recipe. If not, then perhaps it's for a different functionality in the core.
  • Ask all modules if they can handle the current API request.
  • If 0 modules say yes, then return 404
  • If 1 module says yes, then pass the task to that module
  • If > 1 say yes, then get the rId of that module and check it against the header's rId:
    • If the header has no rId, then throw an error saying "Please pass the rId in the header request. One of "rId1", or "rId2",...
    • If no rId match, then throw an error saying "Have you passed the correct rId in the request? Please use one of ...
    • If more than one match, then throw an error asking if one module has been specified two times in the /modules/ directory?
    • Pass the task to the one that matches.

• Provides a module interface (module-interface) that:

  • Asks a module if they can handle the current path (excluding /recipe) and method.
  • Gets the module's rId
  • Lets a module handle an API request
  • Allow a module to schedule a cronjob
  • All a module to interact with the underlying storage layer
  • Allow the module to use the apiKey if needed
  • Provide error and console logging functionality to a module
  • Give the installation path to a module so that they can load files like config.yaml from them
  • Let modules query for the version info
  • Propagates a stop signal to the module

Plugin interface change:

• Merge back supertokens-interface-plugin into supertokens-core #72
• Abstract operations of the underlying storage layer to allow users to do:
  • Transactions
  • Locking
  • Queries
  • Creation of tables if not created

Changes to config:

Please see #76

[rishabhpoddar]

Not needed.