Merge 8dccbb0 into 182bcd9

README.md

@@ -116,8 +116,17 @@ to some commonly used settings:
 | `--sparqlEndpoint, -s` |                            | URL of the SPARQL endpoint, when using a quadstore-based configuration.                                                              |
 | `--showStackTrace, -t` | false                      | Enables detailed logging on error output.                                                                                            |
 | `--podConfigJson`      | `./pod-config.json`        | Path to the file that keeps track of dynamic Pod configurations. Only relevant when using `@css:config/dynamic.json`.                |
-| `--seededPodConfigJson` |                           | Path to the file that keeps track of seeded Pod configurations. |
+| `--seededPodConfigJson`|                            | Path to the file that keeps track of seeded Pod configurations.                                                                      |
 | `--mainModulePath, -m` |                            | Path from where Components.js will start its lookup when initializing configurations.                                                |
+| `--workers, -w`        | `1`                        | Run in multithreaded mode using workers. Special values are `-1` (scale to `num_cores-1`), `0` (scale to `num_cores`) and 1 (singlethreaded).     |
+
+### 🔀 Multithreading
+The Community Solid Server can be started in multithreaded mode with any config. The config must only contain components that are threadsafe though. If a non-threadsafe component is used in multithreaded mode, the server will describe with an error which class is the culprit.
+
+```node
+# Running multithreaded with autoscaling to number of logical cores minus 1
+npm start -- -c config/file.json -w -1
+```
 
 ### 🧶 Custom configurations
 More substantial changes to server behavior can be achieved

config/app/init/base/init.json

@@ -5,7 +5,8 @@
     "css:config/app/init/initializers/logger.json",
     "css:config/app/init/initializers/server.json",
     "css:config/app/init/initializers/seeded-pod.json",
-    "css:config/app/init/initializers/version.json"
+    "css:config/app/init/initializers/version.json",
+    "css:config/app/init/initializers/workers.json"
   ],
   "@graph": [
     {
@@ -14,12 +15,44 @@
       "@type": "SequenceHandler",
       "handlers": [
         { "@id": "urn:solid-server:default:LoggerInitializer" },
-        { "@id": "urn:solid-server:default:BaseUrlVerifier" },
-        { "@id": "urn:solid-server:default:ParallelInitializer" },
-        { "@id": "urn:solid-server:default:SeededPodInitializer" },
-        { "@id": "urn:solid-server:default:ServerInitializer" },
-        { "@id": "urn:solid-server:default:ModuleVersionVerifier" }
+        { "@id": "urn:solid-server:default:PrimaryInitializer" },
+        { "@id": "urn:solid-server:default:WorkerInitializer" }
       ]
+    },
+    {
+      "comment": "This wrapped sequence handler will be executed ONLY BY THE PRIMARY PROCESS when starting the server.",
+      "@id": "urn:solid-server:default:PrimaryInitializer",
+      "@type": "ProcessHandler",
+      "executeOnPrimary": true,
+      "clusterManager": { "@id": "urn:solid-server:default:ClusterManager" },
+      "source": {
+        "comment": "These initializers will all be executed sequentially when starting the server.",
+        "@id": "urn:solid-server:default:PrimarySequenceInitializer",
+        "@type":"SequenceHandler",
+        "handlers": [
+          { "@id": "urn:solid-server:default:BaseUrlVerifier" },
+          { "@id": "urn:solid-server:default:PrimaryParallelInitializer" },
+          { "@id": "urn:solid-server:default:SeededPodInitializer" },
+          { "@id": "urn:solid-server:default:ModuleVersionVerifier" },
+          { "@id": "urn:solid-server:default:WorkerManager" }
+        ]
+      }
+    },
+    {
+      "comment": "This wrapped sequence handler will be executed ONLY BY THE WORKER PROCESSES when starting the server.",
+      "@id": "urn:solid-server:default:WorkerInitializer",
+      "@type": "ProcessHandler",
+      "executeOnPrimary": false,
+      "clusterManager": { "@id": "urn:solid-server:default:ClusterManager" },
+      "source": {
+        "comment": "These initializers will all be executed sequentially when starting the server.",
+        "@id": "urn:solid-server:default:WorkerSequenceInitializer",
+        "@type": "SequenceHandler",
+        "handlers": [
+          { "@id": "urn:solid-server:default:WorkerParallelInitializer" },
+          { "@id": "urn:solid-server:default:ServerInitializer" }
+        ]
+      }
     }
   ]
 }

config/app/init/default.json

@@ -5,8 +5,14 @@
   ],
   "@graph": [
     {
-      "comment": "These handlers are called whenever the server is started, and can be used to ensure that all necessary resources for booting are available.",
-      "@id": "urn:solid-server:default:ParallelInitializer",
+      "comment": "These handlers are called only for the Primary process whenever the server is started, and can be used to ensure that all necessary resources for booting are available. (in singlethreaded mode, these are always called)",
+      "@id": "urn:solid-server:default:PrimaryParallelInitializer",
+      "@type": "ParallelHandler",
+      "handlers": [ ]
+    },
+    {
+      "comment": "These handlers are called only for the workers processes whenever the server is started, and can be used to ensure that all necessary resources for booting are available. (in singlethreaded mode, these are always called)",
+      "@id": "urn:solid-server:default:WorkerParallelInitializer",
       "@type": "ParallelHandler",
       "handlers": [ ]
     }

config/app/init/initialize-prefilled-root.json

@@ -6,12 +6,18 @@
   ],
   "@graph": [
     {
-      "comment": "These handlers are called whenever the server is started, and can be used to ensure that all necessary resources for booting are available.",
-      "@id": "urn:solid-server:default:ParallelInitializer",
+      "comment": "These handlers are called only for the Primary process whenever the server is started, and can be used to ensure that all necessary resources for booting are available. (in singlethreaded mode, these are always called)",
+      "@id": "urn:solid-server:default:PrimaryParallelInitializer",
       "@type": "ParallelHandler",
       "handlers": [
         { "@id": "urn:solid-server:default:RootInitializer" }
       ]
+    },
+    {
+      "comment": "These handlers are called only for the workers processes whenever the server is started, and can be used to ensure that all necessary resources for booting are available. (in singlethreaded mode, these are always called)",
+      "@id": "urn:solid-server:default:WorkerParallelInitializer",
+      "@type": "ParallelHandler",
+      "handlers": [ ]
     }
   ]
 }

config/app/init/initialize-root.json

@@ -6,12 +6,18 @@
   ],
   "@graph": [
     {
-      "comment": "These handlers are called whenever the server is started, and can be used to ensure that all necessary resources for booting are available.",
-      "@id": "urn:solid-server:default:ParallelInitializer",
+      "comment": "These handlers are called only for the Primary process whenever the server is started, and can be used to ensure that all necessary resources for booting are available. (in singlethreaded mode, these are always called)",
+      "@id": "urn:solid-server:default:PrimaryParallelInitializer",
       "@type": "ParallelHandler",
       "handlers": [
         { "@id": "urn:solid-server:default:RootInitializer" }
       ]
+    },
+    {
+      "comment": "These handlers are called only for the workers processes whenever the server is started, and can be used to ensure that all necessary resources for booting are available. (in singlethreaded mode, these are always called)",
+      "@id": "urn:solid-server:default:WorkerParallelInitializer",
+      "@type": "ParallelHandler",
+      "handlers": [ ]
     }
   ]
 }

config/app/init/initializers/workers.json

@@ -0,0 +1,11 @@
+{
+  "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^5.0.0/components/context.jsonld",
+  "@graph": [
+    {
+      "comment": "Spawns the required amount of workers",
+      "@id": "urn:solid-server:default:WorkerManager",
+      "@type": "WorkerManager",
+      "clusterManager": { "@id": "urn:solid-server:default:ClusterManager" }
+    }
+  ]
+}

config/app/main/default.json

@@ -13,7 +13,12 @@
         "finalizers": [
           { "@id": "urn:solid-server:default:ServerInitializer" }
         ]
-      }
+      },
+      "clusterManager": { 
+        "@id": "urn:solid-server:default:ClusterManager",
+        "@type": "ClusterManager",
+        "workers": { "@id": "urn:solid-server:default:variable:workers" }
+       }
     }
   ]
 }

config/app/variables/cli/cli.json

@@ -102,6 +102,16 @@
             "type": "string",
             "describe": "Path to the file that will be used to seed pods."
           }
+        },
+        {
+          "@type": "YargsParameter",
+          "name": "workers",
+          "options": {
+            "alias": "w",
+            "requiresArg": true,
+            "type": "number",
+            "describe": "Run the server in multithreaded mode using workers. (special values: -1: num_cores-1, 0: num_cores). Defaults to 1 (singlethreaded)"
+          }
         }
       ],
       "options": {

config/app/variables/resolver/resolver.json

@@ -65,6 +65,14 @@
             "@type": "AssetPathExtractor",
             "key": "seededPodConfigJson"
           }
+        },
+        {
+          "CombinedSettingsResolver:_resolvers_key": "urn:solid-server:default:variable:workers",
+          "CombinedSettingsResolver:_resolvers_value": {
+            "@type": "KeyExtractor",
+            "key": "workers", 
+            "defaultValue": 1
+          }
         }
       ]
     }

config/identity/access/restricted.json

@@ -13,7 +13,7 @@
     },
     {
       "comment": "IDP-related containers require initialized resources to support authorization.",
-      "@id": "urn:solid-server:default:ParallelInitializer",
+      "@id": "urn:solid-server:default:PrimaryParallelInitializer",
       "@type": "ParallelHandler",
       "handlers": [
         { "@id": "urn:solid-server:default:IdpContainerInitializer" },

config/identity/pod/dynamic.json

@@ -23,8 +23,8 @@
     },
 
     {
-      "comment": "Add to the list of initializers.",
-      "@id": "urn:solid-server:default:ParallelInitializer",
+      "comment": "Add to the list of primary initializers.",
+      "@id": "urn:solid-server:default:PrimaryParallelInitializer",
       "@type": "ParallelHandler",
       "handlers": [
         {

config/util/variables/default.json

@@ -41,6 +41,11 @@
       "comment": "Path to the JSON file used to seed pods.",
       "@id": "urn:solid-server:default:variable:seededPodConfigJson",
       "@type": "Variable"
+    },
+    {
+      "comment": "Run the server in multithreaded mode with the set amount of workers.",
+      "@id": "urn:solid-server:default:variable:workers",
+      "@type": "Variable"
     }
   ]
 }

package.json

@@ -102,7 +102,7 @@
     "arrayify-stream": "^2.0.0",
     "async-lock": "^1.3.0",
     "bcrypt": "^5.0.1",
-    "componentsjs": "^5.0.1",
+    "componentsjs": "^5.1.0",
     "cors": "^2.8.5",
     "cross-fetch": "^3.1.5",
     "ejs": "^3.1.6",
@@ -113,6 +113,7 @@
     "handlebars": "^4.7.7",
     "ioredis": "^5.0.4",
     "jose": "^4.4.0",
+    "jsonld-context-parser": "^2.1.5",
     "lodash.orderby": "^4.6.0",
     "marked": "^4.0.12",
     "mime-types": "^2.1.34",

src/index.ts

@@ -187,6 +187,11 @@ export * from './identity/storage/WebIdAdapterFactory';
 export * from './identity/IdentityProviderHttpHandler';
 export * from './identity/OidcHttpHandler';
 
+// Init/Cluster
+export * from './init/cluster/ClusterManager';
+export * from './init/cluster/SingleThreaded';
+export * from './init/cluster/WorkerManager';
+
 // Init/Final
 export * from './init/final/Finalizable';
 export * from './init/final/ParallelFinalizer';
@@ -218,9 +223,9 @@ export * from './init/ConfigPodInitializer';
 export * from './init/ContainerInitializer';
 export * from './init/Initializer';
 export * from './init/LoggerInitializer';
+export * from './init/ModuleVersionVerifier';
 export * from './init/SeededPodInitializer';
 export * from './init/ServerInitializer';
-export * from './init/ModuleVersionVerifier';
 
 // Logging
 export * from './logging/LazyLoggerFactory';
@@ -401,6 +406,7 @@ export * from './util/handlers/ConditionalHandler';
 export * from './util/handlers/HandlerUtil';
 export * from './util/handlers/MethodFilterHandler';
 export * from './util/handlers/ParallelHandler';
+export * from './util/handlers/ProcessHandler';
 export * from './util/handlers/SequenceHandler';
 export * from './util/handlers/StaticHandler';
 export * from './util/handlers/StaticThrowHandler';

src/init/App.ts

@@ -1,3 +1,4 @@
+import type { ClusterManager } from './cluster/ClusterManager';
 import type { Finalizable } from './final/Finalizable';
 import type { Initializer } from './Initializer';
 
@@ -7,10 +8,12 @@ import type { Initializer } from './Initializer';
 export class App {
   private readonly initializer: Initializer;
   private readonly finalizer: Finalizable;
+  public readonly clusterManager: ClusterManager;
 
-  public constructor(initializer: Initializer, finalizer: Finalizable) {
+  public constructor(initializer: Initializer, finalizer: Finalizable, clusterManager: ClusterManager) {
     this.initializer = initializer;
     this.finalizer = finalizer;
+    this.clusterManager = clusterManager;
   }
 
   /**