Merge 3a351c7 into 4241c53

RELEASE_NOTES.md

@@ -3,12 +3,15 @@
 ## v3.0.0
 ### New features
 - The Identity Provider now uses the `webid` scope as required for Solid-OIDC.
+- It is now possible to modify how CLI variables are parsed.
 
 ### Configuration changes
 You might need to make changes to your v2 configuration if you use a custom config.
 
 The following changes pertain to the imports in the default configs:
-- ...
+- There is a new configuration option that needs to be imported:
+  - `/app/variables/default/json` contains everything related to parsing CLI arguments 
+    and assigning values to variables.
 
 The following changes are relevant for v2 custom configs that replaced certain features.
 - Conversion has been simplified so most converters are part of the conversion chain:

config/app/README.md

@@ -20,3 +20,7 @@ Handles the setup page the first time the server is started.
 * *optional*: Setup is available at `/setup` but the server can already be used.
               Everyone can access the setup page so make sure to complete that as soon as possible.
 * *required*: All requests will be redirected to the setup page until setup is completed.
+
+## Variables
+Handles parsing CLI parameters and assigning values to Components.js variables.
+* *default*: Assigns CLI parameters for all variables defined in `/config/util/variables/default.json`

config/app/variables/cli/cli.json

@@ -0,0 +1,22 @@
+{
+  "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^2.0.0/components/context.jsonld",
+  "@graph": [
+    {
+      "comment": "Extracts CLI arguments into a key/value object",
+      "@id": "urn:solid-server-app-setup:default:CliExtractor",
+      "@type": "YargsCliExtractor",
+      "parameters": {
+        "loggingLevel": { "alias": "l", "requiresArg": true, "type": "string" },
+        "baseUrl": { "alias": "b", "requiresArg": true, "type": "string" },
+        "port": { "alias": "p", "requiresArg": true, "type": "number" },
+        "rootFilePath": { "alias": "f", "requiresArg": true, "type": "string" },
+        "showStackTrace": { "alias": "t", "type": "boolean" },
+        "sparqlEndpoint": { "alias": "s", "requiresArg": true, "type": "string" },
+        "podConfigJson": { "requiresArg": true, "type": "string" }
+      },
+      "options": {
+        "usage": "node ./bin/server.js [args]"
+      }
+    }
+  ]
+}

config/app/variables/default.json

@@ -0,0 +1,28 @@
+{
+    "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^2.0.0/components/context.jsonld",
+    "import": [
+        "files-scs:config/app/variables/cli/cli.json",
+        "files-scs:config/app/variables/resolver/resolver.json"
+    ],
+    "@graph": [
+        {
+            "comment": "Combines a CliExtractor and VariableResolver to be used by the AppRunner.",
+            "@id": "urn:solid-server-app-setup:default:CliResolver",
+            "@type": "RecordObject",
+            "record": [
+                {
+                    "RecordObject:_record_key": "extractor",
+                    "RecordObject:_record_value": {
+                        "@id": "urn:solid-server-app-setup:default:CliExtractor"
+                    }
+                },
+                {
+                    "RecordObject:_record_key": "resolver",
+                    "RecordObject:_record_value": {
+                        "@id": "urn:solid-server-app-setup:default:VariableResolver"
+                    }
+                }
+            ]
+        }
+    ]
+}

config/app/variables/resolver/resolver.json

@@ -0,0 +1,65 @@
+{
+  "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^2.0.0/components/context.jsonld",
+  "@graph": [
+    {
+      "comment": "Converts an input key/value object into an object mapping values to Components.js variables",
+      "@id": "urn:solid-server-app-setup:default:VariableResolver",
+      "@type": "ComputerResolver",
+      "computers": [
+        {
+          "ComputerResolver:_computers_key": "urn:solid-server:default:variable:baseUrl",
+          "ComputerResolver:_computers_value": {
+            "@type": "BaseUrlComputer"
+          }
+        },
+        {
+          "ComputerResolver:_computers_key": "urn:solid-server:default:variable:loggingLevel",
+          "ComputerResolver:_computers_value": {
+            "@type": "ArgExtractor",
+            "key": "loggingLevel",
+            "defaultValue": "info"
+          }
+        },
+        {
+          "ComputerResolver:_computers_key": "urn:solid-server:default:variable:port",
+          "ComputerResolver:_computers_value": {
+            "@type": "ArgExtractor",
+            "key": "port",
+            "defaultValue": 3000
+          }
+        },
+        {
+          "ComputerResolver:_computers_key": "urn:solid-server:default:variable:rootFilePath",
+          "ComputerResolver:_computers_value": {
+            "@type": "AssetPathResolver",
+            "key": "rootFilePath",
+            "defaultPath": "./"
+          }
+        },
+        {
+          "ComputerResolver:_computers_key": "urn:solid-server:default:variable:sparqlEndpoint",
+          "ComputerResolver:_computers_value": {
+            "@type": "ArgExtractor",
+            "key": "sparqlEndpoint"
+          }
+        },
+        {
+          "ComputerResolver:_computers_key": "urn:solid-server:default:variable:showStackTrace",
+          "ComputerResolver:_computers_value": {
+            "@type": "ArgExtractor",
+            "key": "showStackTrace",
+            "defaultValue": false
+          }
+        },
+        {
+          "ComputerResolver:_computers_key": "urn:solid-server:default:variable:AssetPathResolver",
+          "ComputerResolver:_computers_value": {
+            "@type": "AssetPathResolver",
+            "key": "podConfigJson",
+            "defaultPath": "./pod-config.json"
+          }
+        }
+      ]
+    }
+  ]
+}

config/default.json

@@ -4,6 +4,7 @@
     "files-scs:config/app/main/default.json",
     "files-scs:config/app/init/initialize-prefilled-root.json",
     "files-scs:config/app/setup/optional.json",
+    "files-scs:config/app/variables/default.json",
     "files-scs:config/http/handler/default.json",
     "files-scs:config/http/middleware/websockets.json",
     "files-scs:config/http/server-factory/websockets.json",

config/dynamic.json

@@ -4,6 +4,7 @@
     "files-scs:config/app/main/default.json",
     "files-scs:config/app/init/default.json",
     "files-scs:config/app/setup/required.json",
+    "files-scs:config/app/variables/default.json",
     "files-scs:config/http/handler/default.json",
     "files-scs:config/http/middleware/websockets.json",
     "files-scs:config/http/server-factory/websockets.json",

config/example-https-file.json

@@ -4,6 +4,7 @@
     "files-scs:config/app/main/default.json",
     "files-scs:config/app/init/default.json",
     "files-scs:config/app/setup/required.json",
+    "files-scs:config/app/variables/default.json",
     "files-scs:config/http/handler/default.json",
     "files-scs:config/http/middleware/websockets.json",
 

config/file-no-setup.json

@@ -4,6 +4,7 @@
     "files-scs:config/app/main/default.json",
     "files-scs:config/app/init/initialize-root.json",
     "files-scs:config/app/setup/disabled.json",
+    "files-scs:config/app/variables/default.json",
     "files-scs:config/http/handler/default.json",
     "files-scs:config/http/middleware/websockets.json",
     "files-scs:config/http/server-factory/websockets.json",

config/file.json

@@ -4,6 +4,7 @@
     "files-scs:config/app/main/default.json",
     "files-scs:config/app/init/default.json",
     "files-scs:config/app/setup/required.json",
+    "files-scs:config/app/variables/default.json",
     "files-scs:config/http/handler/default.json",
     "files-scs:config/http/middleware/websockets.json",
     "files-scs:config/http/server-factory/websockets.json",

config/memory-subdomains.json

@@ -4,6 +4,7 @@
     "files-scs:config/app/main/default.json",
     "files-scs:config/app/init/initialize-root.json",
     "files-scs:config/app/setup/optional.json",
+    "files-scs:config/app/variables/default.json",
     "files-scs:config/http/handler/default.json",
     "files-scs:config/http/middleware/websockets.json",
     "files-scs:config/http/server-factory/websockets.json",

config/path-routing.json

@@ -4,6 +4,7 @@
     "files-scs:config/app/main/default.json",
     "files-scs:config/app/init/initialize-root.json",
     "files-scs:config/app/setup/disabled.json",
+    "files-scs:config/app/variables/default.json",
     "files-scs:config/http/handler/default.json",
     "files-scs:config/http/middleware/websockets.json",
     "files-scs:config/http/server-factory/websockets.json",

config/restrict-idp.json

@@ -4,6 +4,7 @@
     "files-scs:config/app/main/default.json",
     "files-scs:config/app/init/default.json",
     "files-scs:config/app/setup/disabled.json",
+    "files-scs:config/app/variables/default.json",
     "files-scs:config/http/handler/default.json",
     "files-scs:config/http/middleware/websockets.json",
     "files-scs:config/http/server-factory/websockets.json",

config/sparql-endpoint-no-setup.json

@@ -4,6 +4,7 @@
     "files-scs:config/app/main/default.json",
     "files-scs:config/app/init/initialize-root.json",
     "files-scs:config/app/setup/disabled.json",
+    "files-scs:config/app/variables/default.json",
     "files-scs:config/http/handler/default.json",
     "files-scs:config/http/middleware/websockets.json",
     "files-scs:config/http/server-factory/websockets.json",

config/sparql-endpoint.json

@@ -4,6 +4,7 @@
     "files-scs:config/app/main/default.json",
     "files-scs:config/app/init/default.json",
     "files-scs:config/app/setup/required.json",
+    "files-scs:config/app/variables/default.json",
     "files-scs:config/http/handler/default.json",
     "files-scs:config/http/middleware/websockets.json",
     "files-scs:config/http/server-factory/websockets.json",

config/util/variables/default.json

@@ -8,7 +8,7 @@
       "@type": "Variable"
     },
     {
-      "comment": "Needs to be set to the base URL of the server for authnetication and authorization to function.",
+      "comment": "Needs to be set to the base URL of the server for authentication and authorization to function.",
       "@id": "urn:solid-server:default:variable:baseUrl",
       "@type": "Variable"
     },

src/index.ts

@@ -177,6 +177,20 @@ export * from './init/final/ParallelFinalizer';
 // Init/Setup
 export * from './init/setup/SetupHttpHandler';
 
+// Init/Cli
+export * from './init/cli/CliExtractor';
+export * from './init/cli/YargsCliExtractor';
+
+// Init/Variables/Computers
+export * from './init/variables/computers/ArgExtractor';
+export * from './init/variables/computers/AssetPathResolver';
+export * from './init/variables/computers/BaseUrlComputer';
+export * from './init/variables/computers/ValueComputer';
+
+// Init/Variables
+export * from './init/variables/ComputerResolver';
+export * from './init/variables/VariableResolver';
+
 // Init
 export * from './init/App';
 export * from './init/AppRunner';