X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=README.md;h=33c86749cca1ae140d0e3670cd8305a4a20e8400;hb=bc174bb01b551854155838932213d58efd12e4f4;hp=cd5939e895009b5fd6227726961aebd682aca347;hpb=04a72d188670df01668cbd7fe48fb86832ddd2b6;p=websub-hub diff --git a/README.md b/README.md index cd5939e..33c8674 100644 --- a/README.md +++ b/README.md @@ -114,6 +114,8 @@ The Hub keeps track of three primary entities: Any tasks in progress (notably: fetching new topic content, distributing that content to subscribers, or confirming pending verifications) are doled out and managed by a cooperative advisory locking mechanism. The task queue is wrangled in the database within the `*_in_progress` tables. +![Entity relationship diagram for Postgres engine](./documentation/media/postgres-er.svg) + A Hub node will periodically check for more tasks to perform, executing them up to a set concurrency limit. ### Quirks @@ -129,7 +131,6 @@ This implementation is built atop an in-house API framework, for Reasons. It wo - *.js - environment specific values, edit these as needed - server.js - launches the application server - src/ - - authenticator.js - interact with credentials and validation mechanisms - common.js - utility functions - communication.js - outgoing requests and associated logic - db/ @@ -147,10 +148,9 @@ This implementation is built atop an in-house API framework, for Reasons. It wo - enum.js - invariants - errors.js - local Error types - link-helper.js - processes Link headers - - logger.js - a very simple logging class + - logger/ - adds service-specific data filters to our logging module - manager.js - process incoming requests - service.js - defines incoming endpoints, linking the API server framework to the manager methods - - session-manager.js - process login/logout requests - template/ - HTML content - worker.js - maintains a pool of tasks in progress, for sending out updates, performing verifications, et cetera - static/ - static assets