fix: Set the location header when registering a resource

Author: joachimvh

documentation/getting-started.md

@@ -115,8 +115,8 @@ in the relevant policies that determine access.
 The Solid identifier of the resource is irrelevant,
 and not even known by the AS.
 If the request is successful,
-the AS responds with a 201 status code.
-The location header contains the new identifier.
+the AS responds with a 201 status code and the UMA identifier in the body.
+The location header contains the URL needed to update the registration.
 The RS stores this identifier, linked to the Solid identifier, for future use.
 
 ### About identifiers

packages/uma/src/routes/ResourceRegistration.ts

@@ -4,6 +4,7 @@ import {
   createErrorMessage,
   getLoggerFor,
   InternalServerError,
+  joinUrl,
   KeyValueStorage,
   MethodNotAllowedHttpError,
   NotFoundHttpError,
@@ -93,6 +94,7 @@ export class ResourceRegistrationRequestHandler extends HttpHandler {
 
     return ({
       status: 201,
+      headers: { location: `${joinUrl(request.url.href, encodeURIComponent(resource))}` },
       body: {
         _id: resource,
         user_access_policy_uri: 'TODO: implement policy UI',

packages/uma/test/unit/routes/ResourceRegistration.test.ts

@@ -1,5 +1,6 @@
 import 'jest-rdf';
 import {
+  joinUrl,
   KeyValueStorage,
   MethodNotAllowedHttpError,
   NotFoundHttpError,
@@ -96,6 +97,7 @@ describe('ResourceRegistration', (): void => {
     it('registers the resource using the name as identifier.', async(): Promise<void> => {
       await expect(handler.handle(input)).resolves.toEqual({
         status: 201,
+        headers: { location: `http://example.com/foo/name` },
         body: { _id: 'name', user_access_policy_uri: 'TODO: implement policy UI' },
       });
       expect(resourceStore.set).toHaveBeenCalledTimes(1);
@@ -109,6 +111,7 @@ describe('ResourceRegistration', (): void => {
       input.request.body!.resource_defaults = { pred: [ 'scope' ], '@reverse': { 'rPred': [ 'otherScope' ]}};
       await expect(handler.handle(input)).resolves.toEqual({
         status: 201,
+        headers: { location: `http://example.com/foo/name` },
         body: { _id: 'name', user_access_policy_uri: 'TODO: implement policy UI' },
       });
       expect(policies.addRule).toHaveBeenCalledTimes(1);
@@ -144,6 +147,7 @@ describe('ResourceRegistration', (): void => {
       input.request.body!.name = 'entry';
       await expect(handler.handle(input)).resolves.toEqual({
         status: 201,
+        headers: { location: `http://example.com/foo/entry` },
         body: { _id: 'entry', user_access_policy_uri: 'TODO: implement policy UI' },
       });
       expect(policies.addRule).toHaveBeenCalledTimes(1);