Convert errors to Representations

README.md

@@ -69,6 +69,7 @@ Additional recipes for configuring and deploying the server can be found at [sol
 | `--loggingLevel, -l` | `"info"`| |
 | `--rootFilePath, -f` | `"./"` | Folder to start the server in when using a file-based config. |
 | `--sparqlEndpoint, -s` | | Endpoint to call when using a SPARQL-based config. |
+| `--showStackTrace, -t` | false | Whether error stack traces should be shown in responses. |
 | `--podConfigJson` | `"./pod-config.json"` | JSON file to store pod configuration when using a dynamic config. |
 | `--idpTemplateFolder` | `"templates/idp"` | Folder containing the templates used for IDP interactions. |
 

config/example-https-file.json

@@ -41,6 +41,7 @@
         "@id": "urn:solid-server:default:HttpServerFactory",
         "@type": "BaseHttpServerFactory",
         "handler": { "@id": "urn:solid-server:default:HttpHandler" },
+        "options_showStackTrace": { "@id": "urn:solid-server:default:variable:showStackTrace" },
         "options_https": true,
         "options_key": "/path/to/server.key",
         "options_cert": "/path/to/server.cert"

config/http/server-factory/https-example.json

@@ -9,6 +9,7 @@
         "@id": "urn:solid-server:default:HttpServerFactory",
         "@type": "BaseHttpServerFactory",
         "handler": { "@id": "urn:solid-server:default:HttpHandler" },
+        "options_showStackTrace": { "@id": "urn:solid-server:default:variable:showStackTrace" },
         "options_https": true,
         "options_key": "/path/to/server.key",
         "options_cert": "/path/to/server.cert"

config/http/server-factory/no-websockets.json

@@ -5,7 +5,8 @@
       "comment": "Creates a server that supports HTTP requests.",
       "@id": "urn:solid-server:default:ServerFactory",
       "@type": "BaseHttpServerFactory",
-      "handler": { "@id": "urn:solid-server:default:HttpHandler" }
+      "handler": { "@id": "urn:solid-server:default:HttpHandler" },
+      "options_showStackTrace": { "@id": "urn:solid-server:default:variable:showStackTrace" }
     }
   ]
 }

config/http/server-factory/websockets.json

@@ -8,7 +8,8 @@
       "baseServerFactory": {
         "@id": "urn:solid-server:default:HttpServerFactory",
         "@type": "BaseHttpServerFactory",
-        "handler": { "@id": "urn:solid-server:default:HttpHandler" }
+        "handler": { "@id": "urn:solid-server:default:HttpHandler" },
+        "options_showStackTrace": { "@id": "urn:solid-server:default:variable:showStackTrace" }
       },
       "webSocketHandler": {
         "@type": "UnsecureWebSocketsProtocol",

config/identity/handler/default.json

@@ -21,7 +21,8 @@
       "providerFactory": { "@id": "urn:solid-server:default:IdentityProviderFactory" },
       "interactionPolicy": { "@id": "urn:solid-server:auth:password:AccountInteractionPolicy" },
       "interactionHttpHandler": { "@id": "urn:solid-server:auth:password:InteractionHttpHandler" },
-      "errorResponseWriter": { "@type": "ErrorResponseWriter" }
+      "errorHandler": { "@id": "urn:solid-server:default:ErrorHandler" },
+      "responseWriter": { "@id": "urn:solid-server:default:ResponseWriter" }
     }
   ]
 }

config/identity/handler/provider-factory/identity.json

@@ -7,7 +7,8 @@
       "@type": "IdentityProviderFactory",
       "issuer": { "@id": "urn:solid-server:default:variable:baseUrl" },
       "configurationFactory": { "@id": "urn:solid-server:default:IdpConfigurationFactory" },
-      "errorResponseWriter": { "@type": "ErrorResponseWriter" }
+      "errorHandler": { "@id": "urn:solid-server:default:ErrorHandler" },
+      "responseWriter": { "@id": "urn:solid-server:default:ResponseWriter" }
     },
     {
       "comment": "Sets up the JWKS and cookie keys.",

config/ldp/handler/components/error-handler.json

@@ -0,0 +1,21 @@
+{
+  "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^0.0.0/components/context.jsonld",
+  "@graph": [
+    {
+      "comment": "Changes an error into a valid representation to send as a response.",
+      "@id": "urn:solid-server:default:ErrorHandler",
+      "@type": "WaterfallHandler",
+      "handlers": [
+        {
+          "@type": "ConvertingErrorHandler",
+          "converter": { "@id": "urn:solid-server:default:RepresentationConverter" },
+          "showStackTrace": { "@id": "urn:solid-server:default:variable:showStackTrace" }
+        },
+        {
+          "@type": "TextErrorHandler",
+          "showStackTrace": { "@id": "urn:solid-server:default:variable:showStackTrace" }
+        }
+      ]
+    }
+  ]
+}

config/ldp/handler/components/response-writer.json

@@ -4,14 +4,8 @@
     {
       "comment": "Writes the result to the response stream.",
       "@id": "urn:solid-server:default:ResponseWriter",
-      "@type": "WaterfallHandler",
-      "handlers": [
-        { "@type": "ErrorResponseWriter" },
-        {
-          "@type": "BasicResponseWriter",
-          "metadataWriter": { "@id": "urn:solid-server:default:MetadataWriter" }
-        }
-      ]
+      "@type": "BasicResponseWriter",
+      "metadataWriter": { "@id": "urn:solid-server:default:MetadataWriter" }
     }
   ]
 }

config/ldp/handler/default.json

@@ -1,6 +1,7 @@
 {
   "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^0.0.0/components/context.jsonld",
   "import": [
+    "files-scs:config/ldp/handler/components/error-handler.json",
     "files-scs:config/ldp/handler/components/operation-handler.json",
     "files-scs:config/ldp/handler/components/request-parser.json",
     "files-scs:config/ldp/handler/components/response-writer.json"
@@ -15,6 +16,7 @@
       "args_permissionsExtractor": { "@id": "urn:solid-server:default:PermissionsExtractor" },
       "args_authorizer": { "@id": "urn:solid-server:default:Authorizer" },
       "args_operationHandler": { "@id": "urn:solid-server:default:OperationHandler" },
+      "args_errorHandler": { "@id": "urn:solid-server:default:ErrorHandler" },
       "args_responseWriter": { "@id": "urn:solid-server:default:ResponseWriter" }
     }
   ]

config/ldp/metadata-writer/writers/mapped.json

@@ -11,7 +11,7 @@
           "MappedMetadataWriter:_headerMap_value": "Content-Type"
         },
         {
-          "MappedMetadataWriter:_headerMap_key": "urn:solid:http:location",
+          "MappedMetadataWriter:_headerMap_key": "urn:npm:solid:community-server:http:location",
           "MappedMetadataWriter:_headerMap_value": "Location"
         }
       ]

config/util/representation-conversion/default.json

@@ -23,7 +23,8 @@
           "@type": "ChainedConverter",
           "converters": [
             { "@id": "urn:solid-server:default:RdfToQuadConverter" },
-            { "@id": "urn:solid-server:default:QuadToRdfConverter" }
+            { "@id": "urn:solid-server:default:QuadToRdfConverter" },
+            { "@type": "ErrorToQuadConverter" }
           ]
         }
       ]

config/util/variables/default.json

@@ -23,9 +23,15 @@
       "@type": "Variable"
     },
     {
+      "comment": "The max level of log messages that should be output.",
       "@id": "urn:solid-server:default:variable:loggingLevel",
       "@type": "Variable"
     },
+    {
+      "comment": "Whether error stack traces should be shown in the server responses.",
+      "@id": "urn:solid-server:default:variable:showStackTrace",
+      "@type": "Variable"
+    },
     {
       "comment": "Path to the JSON file used to store configuration for dynamic pods.",
       "@id": "urn:solid-server:default:variable:podConfigJson",

src/identity/IdentityProviderFactory.ts

@@ -6,8 +6,9 @@ import type { AnyObject,
   Account,
   ErrorOut } from 'oidc-provider';
 import { Provider } from 'oidc-provider';
+import type { ErrorHandler } from '../ldp/http/ErrorHandler';
 import type { ResponseWriter } from '../ldp/http/ResponseWriter';
-
+import type { RepresentationPreferences } from '../ldp/representation/RepresentationPreferences';
 import type { ConfigurationFactory } from './configuration/ConfigurationFactory';
 
 /**
@@ -18,13 +19,15 @@ import type { ConfigurationFactory } from './configuration/ConfigurationFactory'
 export class IdentityProviderFactory {
   private readonly issuer: string;
   private readonly configurationFactory: ConfigurationFactory;
-  private readonly errorResponseWriter: ResponseWriter;
+  private readonly errorHandler: ErrorHandler;
+  private readonly responseWriter: ResponseWriter;
 
   public constructor(issuer: string, configurationFactory: ConfigurationFactory,
-    errorResponseWriter: ResponseWriter) {
+    errorHandler: ErrorHandler, responseWriter: ResponseWriter) {
     this.issuer = issuer;
     this.configurationFactory = configurationFactory;
-    this.errorResponseWriter = errorResponseWriter;
+    this.errorHandler = errorHandler;
+    this.responseWriter = responseWriter;
   }
 
   public async createProvider(interactionPolicyOptions: {
@@ -81,7 +84,9 @@ export class IdentityProviderFactory {
       },
       renderError:
         async(ctx: KoaContextWithOIDC, out: ErrorOut, error: Error): Promise<void> => {
-          await this.errorResponseWriter.handleSafe({ response: ctx.res, result: error });
+          const preferences: RepresentationPreferences = { type: { 'text/plain': 1 }};
+          const result = await this.errorHandler.handleSafe({ error, preferences });
+          await this.responseWriter.handleSafe({ response: ctx.res, result });
         },
     };
     return new Provider(this.issuer, augmentedConfig);

src/identity/IdentityProviderHttpHandler.ts

@@ -1,9 +1,11 @@
 import type { Provider } from 'oidc-provider';
+import type { ErrorHandler } from '../ldp/http/ErrorHandler';
 import type { ResponseWriter } from '../ldp/http/ResponseWriter';
+import type { RepresentationPreferences } from '../ldp/representation/RepresentationPreferences';
 import { getLoggerFor } from '../logging/LogUtil';
 import type { HttpHandlerInput } from '../server/HttpHandler';
 import { HttpHandler } from '../server/HttpHandler';
-import { isNativeError } from '../util/errors/ErrorUtil';
+import { assertNativeError, isNativeError } from '../util/errors/ErrorUtil';
 import type { IdentityProviderFactory } from './IdentityProviderFactory';
 import type { InteractionHttpHandler } from './interaction/InteractionHttpHandler';
 import type { InteractionPolicy } from './interaction/InteractionPolicy';
@@ -26,20 +28,23 @@ export class IdentityProviderHttpHandler extends HttpHandler {
   private readonly providerFactory: IdentityProviderFactory;
   private readonly interactionPolicy: InteractionPolicy;
   private readonly interactionHttpHandler: InteractionHttpHandler;
-  private readonly errorResponseWriter: ResponseWriter;
+  private readonly errorHandler: ErrorHandler;
+  private readonly responseWriter: ResponseWriter;
   private provider?: Provider;
 
   public constructor(
     providerFactory: IdentityProviderFactory,
     interactionPolicy: InteractionPolicy,
     interactionHttpHandler: InteractionHttpHandler,
-    errorResponseWriter: ResponseWriter,
+    errorHandler: ErrorHandler,
+    responseWriter: ResponseWriter,
   ) {
     super();
     this.providerFactory = providerFactory;
     this.interactionPolicy = interactionPolicy;
     this.interactionHttpHandler = interactionHttpHandler;
-    this.errorResponseWriter = errorResponseWriter;
+    this.errorHandler = errorHandler;
+    this.responseWriter = responseWriter;
   }
 
   /**
@@ -70,11 +75,10 @@ export class IdentityProviderHttpHandler extends HttpHandler {
     try {
       await this.interactionHttpHandler.handle({ ...input, provider });
     } catch (error: unknown) {
-      // ResponseWriter can only handle native errors
-      if (!isNativeError(error)) {
-        throw error;
-      }
-      await this.errorResponseWriter.handleSafe({ response: input.response, result: error });
+      assertNativeError(error);
+      const preferences: RepresentationPreferences = { type: { 'text/plain': 1 }};
+      const result = await this.errorHandler.handleSafe({ error, preferences });
+      await this.responseWriter.handleSafe({ response: input.response, result });
     }
   }
 }

src/index.ts

@@ -109,7 +109,8 @@ export * from './ldp/http/AcceptPreferenceParser';
 export * from './ldp/http/BasicRequestParser';
 export * from './ldp/http/BasicResponseWriter';
 export * from './ldp/http/BodyParser';
-export * from './ldp/http/ErrorResponseWriter';
+export * from './ldp/http/ConvertingErrorHandler';
+export * from './ldp/http/ErrorHandler';
 export * from './ldp/http/OriginalUrlExtractor';
 export * from './ldp/http/Patch';
 export * from './ldp/http/PreferenceParser';
@@ -119,6 +120,7 @@ export * from './ldp/http/ResponseWriter';
 export * from './ldp/http/SparqlUpdateBodyParser';
 export * from './ldp/http/SparqlUpdatePatch';
 export * from './ldp/http/TargetExtractor';
+export * from './ldp/http/TextErrorHandler';
 
 // LDP/Operations
 export * from './ldp/operations/DeleteOperationHandler';
@@ -216,9 +218,10 @@ export * from './storage/accessors/SparqlDataAccessor';
 export * from './storage/conversion/ChainedConverter';
 export * from './storage/conversion/ConstantConverter';
 export * from './storage/conversion/ContentTypeReplacer';
+export * from './storage/conversion/ConversionUtil';
+export * from './storage/conversion/ErrorToQuadConverter';
 export * from './storage/conversion/IfNeededConverter';
 export * from './storage/conversion/PassthroughConverter';
-export * from './storage/conversion/ConversionUtil';
 export * from './storage/conversion/QuadToRdfConverter';
 export * from './storage/conversion/RdfToQuadConverter';
 export * from './storage/conversion/RepresentationConverter';

src/init/AppRunner.ts

@@ -44,41 +44,32 @@ export class AppRunner {
   } = {}): void {
     // Parse the command-line arguments
     const { argv: params } = yargs(argv.slice(2))
+      .strict()
       .usage('node ./bin/server.js [args]')
-      .check((args, options): boolean => {
-        // Only take flags as arguments, not filenames
-        if (args._ && args._.length > 0) {
-          throw new Error(`Unsupported arguments: ${args._.join('", "')}`);
+      .check((args): boolean => {
+        if (args._.length > 0) {
+          throw new Error(`Unsupported positional arguments: "${args._.join('", "')}"`);
         }
-        for (const key in args) {
-          // Skip filename arguments (_) and the script name ($0)
-          if (key !== '_' && key !== '$0') {
-            // Check if the argument occurs in the provided options list
-            if (!options[key]) {
-              throw new Error(`Unknown option: "${key}"`);
-            }
-            // Check if the argument actually has a value ('> ./bin/server.js -s' is not valid)
-            if (!args[key]) {
-              throw new Error(`Missing value for argument "${key}"`);
-            }
-            // Check if the argument only has 1 value
-            if (Array.isArray(args[key])) {
-              throw new Error(`Multiple values were provided for: "${key}", [${args[key]}]`);
-            }
+        for (const key of Object.keys(args)) {
+          // We have no options that allow for arrays
+          const val = args[key];
+          if (key !== '_' && Array.isArray(val)) {
+            throw new Error(`Multiple values were provided for: "${key}": "${val.join('", "')}"`);
           }
         }
         return true;
       })
       .options({
-        baseUrl: { type: 'string', alias: 'b' },
-        config: { type: 'string', alias: 'c' },
-        loggingLevel: { type: 'string', alias: 'l', default: 'info' },
-        mainModulePath: { type: 'string', alias: 'm' },
-        idpTemplateFolder: { type: 'string' },
-        port: { type: 'number', alias: 'p', default: 3000 },
-        rootFilePath: { type: 'string', alias: 'f', default: './' },
-        sparqlEndpoint: { type: 'string', alias: 's' },
-        podConfigJson: { type: 'string', default: './pod-config.json' },
+        baseUrl: { type: 'string', alias: 'b', requiresArg: true },
+        config: { type: 'string', alias: 'c', requiresArg: true },
+        loggingLevel: { type: 'string', alias: 'l', default: 'info', requiresArg: true },
+        mainModulePath: { type: 'string', alias: 'm', requiresArg: true },
+        idpTemplateFolder: { type: 'string', requiresArg: true },
+        port: { type: 'number', alias: 'p', default: 3000, requiresArg: true },
+        rootFilePath: { type: 'string', alias: 'f', default: './', requiresArg: true },
+        showStackTrace: { type: 'boolean', alias: 't', default: false },
+        sparqlEndpoint: { type: 'string', alias: 's', requiresArg: true },
+        podConfigJson: { type: 'string', default: './pod-config.json', requiresArg: true },
       })
       .help();
 
@@ -129,6 +120,7 @@ export class AppRunner {
       'urn:solid-server:default:variable:rootFilePath':
         this.resolveFilePath(params.rootFilePath),
       'urn:solid-server:default:variable:sparqlEndpoint': params.sparqlEndpoint,
+      'urn:solid-server:default:variable:showStackTrace': params.showStackTrace,
       'urn:solid-server:default:variable:podConfigJson':
         this.resolveFilePath(params.podConfigJson),
       'urn:solid-server:default:variable:idpTemplateFolder':
@@ -158,6 +150,7 @@ export interface ConfigVariables {
   baseUrl?: string;
   rootFilePath?: string;
   sparqlEndpoint?: string;
+  showStackTrace?: boolean;
   podConfigJson?: string;
   idpTemplateFolder?: string;
 }