feat: Add DataAccessorBasedStore integration

index.ts

@@ -80,6 +80,10 @@ export * from './src/server/HttpHandler';
 export * from './src/server/HttpRequest';
 export * from './src/server/HttpResponse';
 
+// Storage/Accessors
+export * from './src/storage/accessors/DataAccessor';
+export * from './src/storage/accessors/FileDataAccessor';
+
 // Storage/Conversion
 export * from './src/storage/conversion/ChainedConverter';
 export * from './src/storage/conversion/QuadToRdfConverter';
@@ -95,6 +99,8 @@ export * from './src/storage/patch/SparqlUpdatePatchHandler';
 export * from './src/storage/AtomicResourceStore';
 export * from './src/storage/Conditions';
 export * from './src/storage/ContainerManager';
+export * from './src/storage/DataAccessorBasedStore';
+export * from './src/storage/ExtensionBasedMapper';
 export * from './src/storage/FileResourceStore';
 export * from './src/storage/InMemoryResourceStore';
 export * from './src/storage/Lock';
@@ -109,9 +115,12 @@ export * from './src/storage/SingleThreadedResourceLocker';
 export * from './src/storage/UrlContainerManager';
 
 // Util/Errors
+export * from './src/util/errors/ConflictHttpError';
 export * from './src/util/errors/ForbiddenHttpError';
 export * from './src/util/errors/HttpError';
+export * from './src/util/errors/MethodNotAllowedHttpError';
 export * from './src/util/errors/NotFoundHttpError';
+export * from './src/util/errors/SystemError';
 export * from './src/util/errors/UnauthorizedHttpError';
 export * from './src/util/errors/UnsupportedHttpError';
 export * from './src/util/errors/UnsupportedMediaTypeHttpError';

test/configs/AuthenticatedFileBasedDataAccessorConfig.ts

@@ -0,0 +1,64 @@
+import type { HttpHandler,
+  ResourceStore } from '../../index';
+import {
+  AuthenticatedLdpHandler,
+  BasicResponseWriter,
+  CompositeAsyncHandler,
+  MethodPermissionsExtractor,
+  RdfToQuadConverter,
+  UnsecureWebIdExtractor,
+  QuadToRdfConverter,
+} from '../../index';
+import type { ServerConfig } from './ServerConfig';
+import {
+  getConvertingStore,
+  getBasicRequestParser,
+  getOperationHandler,
+  getWebAclAuthorizer,
+  getFileDataAccessorStore,
+} from './Util';
+
+/**
+ * AuthenticatedFileResourceStoreConfig works with
+ * - a WebAclAuthorizer
+ * - a FileResourceStore wrapped in a converting store (rdf to quad & quad to rdf)
+ * - GET, POST, PUT & DELETE operation handlers
+ */
+export class AuthenticatedFileBasedDataAccessorConfig implements ServerConfig {
+  public base: string;
+  public store: ResourceStore;
+
+  public constructor(base: string, rootFilepath: string) {
+    this.base = base;
+    this.store = getConvertingStore(
+      getFileDataAccessorStore(base, rootFilepath),
+      [ new QuadToRdfConverter(),
+        new RdfToQuadConverter() ],
+    );
+  }
+
+  public getHttpHandler(): HttpHandler {
+    const requestParser = getBasicRequestParser();
+
+    const credentialsExtractor = new UnsecureWebIdExtractor();
+    const permissionsExtractor = new CompositeAsyncHandler([
+      new MethodPermissionsExtractor(),
+    ]);
+
+    const operationHandler = getOperationHandler(this.store);
+
+    const responseWriter = new BasicResponseWriter();
+    const authorizer = getWebAclAuthorizer(this.store, this.base);
+
+    const handler = new AuthenticatedLdpHandler({
+      requestParser,
+      credentialsExtractor,
+      permissionsExtractor,
+      authorizer,
+      operationHandler,
+      responseWriter,
+    });
+
+    return handler;
+  }
+}

test/configs/FileBasedDataAccessorConfig.ts

@@ -0,0 +1,62 @@
+import type { HttpHandler,
+  ResourceStore } from '../../index';
+import {
+  AllowEverythingAuthorizer,
+  AuthenticatedLdpHandler,
+  BasicResponseWriter,
+  CompositeAsyncHandler,
+  MethodPermissionsExtractor,
+  QuadToRdfConverter,
+  RawBodyParser,
+  RdfToQuadConverter,
+  UnsecureWebIdExtractor,
+} from '../../index';
+import type { ServerConfig } from './ServerConfig';
+import {
+  getOperationHandler,
+  getConvertingStore,
+  getBasicRequestParser,
+  getFileDataAccessorStore,
+} from './Util';
+
+/**
+ * FileBasedDataAccessorConfig works with
+ * - an AllowEverythingAuthorizer (no acl)
+ * - a DataAccessorBasedStore with a FileDataAccessor wrapped in a converting store (rdf to quad & quad to rdf)
+ * - GET, POST, PUT & DELETE operation handlers
+ */
+export class FileBasedDataAccessorConfig implements ServerConfig {
+  public store: ResourceStore;
+
+  public constructor(base: string, rootFilepath: string) {
+    this.store = getConvertingStore(
+      getFileDataAccessorStore(base, rootFilepath),
+      [ new QuadToRdfConverter(), new RdfToQuadConverter() ],
+    );
+  }
+
+  public getHttpHandler(): HttpHandler {
+    // This is for the sake of test coverage, as it could also be just getBasicRequestParser()
+    const requestParser = getBasicRequestParser([ new RawBodyParser() ]);
+
+    const credentialsExtractor = new UnsecureWebIdExtractor();
+    const permissionsExtractor = new CompositeAsyncHandler([
+      new MethodPermissionsExtractor(),
+    ]);
+    const authorizer = new AllowEverythingAuthorizer();
+
+    const operationHandler = getOperationHandler(this.store);
+    const responseWriter = new BasicResponseWriter();
+
+    const handler = new AuthenticatedLdpHandler({
+      requestParser,
+      credentialsExtractor,
+      permissionsExtractor,
+      authorizer,
+      operationHandler,
+      responseWriter,
+    });
+
+    return handler;
+  }
+}

test/configs/ServerConfig.ts

@@ -1,5 +1,7 @@
 import type { HttpHandler } from '../../src/server/HttpHandler';
+import type { ResourceStore } from '../../src/storage/ResourceStore';
 
 export interface ServerConfig {
+  store: ResourceStore;
   getHttpHandler: () => HttpHandler;
 }

test/configs/Util.ts

@@ -11,7 +11,10 @@ import {
   BasicTargetExtractor,
   CompositeAsyncHandler,
   ContentTypeParser,
+  DataAccessorBasedStore,
   DeleteOperationHandler,
+  ExtensionBasedMapper,
+  FileDataAccessor,
   FileResourceStore,
   GetOperationHandler,
   HeadOperationHandler,
@@ -32,7 +35,6 @@ import {
   UrlContainerManager,
   WebAclAuthorizer,
 } from '../../index';
-import { ExtensionBasedMapper } from '../../src/storage/ExtensionBasedMapper';
 
 export const BASE = 'http://test.com';
 
@@ -56,6 +58,21 @@ export const getFileResourceStore = (base: string, rootFilepath: string): FileRe
     new MetadataController(),
   );
 
+/**
+ * Gives a file data accessor store based on (default) runtime config.
+ * @param base - Base URL.
+ * @param rootFilepath - The root file path.
+ *
+ * @returns The data accessor based store.
+ */
+export const getFileDataAccessorStore = (base: string, rootFilepath: string): DataAccessorBasedStore =>
+  new DataAccessorBasedStore(
+    new FileDataAccessor(new ExtensionBasedMapper(base, rootFilepath), new MetadataController()),
+    base,
+    new MetadataController(),
+    new UrlContainerManager(base),
+  );
+
 /**
  * Gives an in memory resource store based on (default) base url.
  * @param base - Optional base parameter for the run time config.

test/integration/AuthenticatedFileBasedStore.test.ts

@@ -1,39 +1,45 @@
 import { copyFileSync, mkdirSync } from 'fs';
 import { join } from 'path';
 import * as rimraf from 'rimraf';
-import type { HttpHandler, ResourceStore } from '../../index';
 import { ensureTrailingSlash } from '../../src/util/Util';
+import { AuthenticatedFileBasedDataAccessorConfig } from '../configs/AuthenticatedFileBasedDataAccessorConfig';
 import { AuthenticatedFileResourceStoreConfig } from '../configs/AuthenticatedFileResourceStoreConfig';
+import type { ServerConfig } from '../configs/ServerConfig';
 import { BASE, getRootFilePath } from '../configs/Util';
 import { AclTestHelper, FileTestHelper } from '../util/TestHelpers';
 
-describe('A server using a AuthenticatedFileResourceStore', (): void => {
+const fileResourceStore: [string, (rootFilePath: string) => ServerConfig] = [
-  let config: AuthenticatedFileResourceStoreConfig;
+  'FileResourceStore',
-  let handler: HttpHandler;
+  (rootFilePath: string): ServerConfig => new AuthenticatedFileResourceStoreConfig(BASE, rootFilePath),
-  let store: ResourceStore;
+];
-  let aclHelper: AclTestHelper;
+const dataAccessorStore: [string, (rootFilePath: string) => ServerConfig] = [
-  let fileHelper: FileTestHelper;
+  'FileDataAccessorBasedStore',
-  let rootFilePath: string;
+  (rootFilePath: string): ServerConfig => new AuthenticatedFileBasedDataAccessorConfig(BASE, rootFilePath),
-
+];
-  beforeAll(async(): Promise<void> => {
-    rootFilePath = getRootFilePath('AuthenticatedFileResourceStore');
-    mkdirSync(rootFilePath, { recursive: true });
-    config = new AuthenticatedFileResourceStoreConfig(BASE, rootFilePath);
-    handler = config.getHttpHandler();
-    ({ store } = config);
-    aclHelper = new AclTestHelper(store, ensureTrailingSlash(BASE));
-    fileHelper = new FileTestHelper(handler, new URL(ensureTrailingSlash(BASE)));
-
-    // Make sure the root directory exists
-    mkdirSync(rootFilePath, { recursive: true });
-    copyFileSync(join(__dirname, '../assets/permanent.txt'), `${rootFilePath}/permanent.txt`);
-  });
-
-  afterAll(async(): Promise<void> => {
-    rimraf.sync(rootFilePath, { glob: false });
-  });
 
+describe.each([ fileResourceStore, dataAccessorStore ])('A server using a %s', (name, configFn): void => {
   describe('with acl', (): void => {
+    let config: ServerConfig;
+    let aclHelper: AclTestHelper;
+    let fileHelper: FileTestHelper;
+    let rootFilePath: string;
+
+    beforeAll(async(): Promise<void> => {
+      rootFilePath = getRootFilePath(name);
+      mkdirSync(rootFilePath, { recursive: true });
+      config = configFn(rootFilePath);
+      aclHelper = new AclTestHelper(config.store, ensureTrailingSlash(BASE));
+      fileHelper = new FileTestHelper(config.getHttpHandler(), new URL(ensureTrailingSlash(BASE)));
+
+      // Make sure the root directory exists
+      mkdirSync(rootFilePath, { recursive: true });
+      copyFileSync(join(__dirname, '../assets/permanent.txt'), `${rootFilePath}/permanent.txt`);
+    });
+
+    afterAll(async(): Promise<void> => {
+      rimraf.sync(rootFilePath, { glob: false });
+    });
+
     it('can add a file to the store, read it and delete it if allowed.', async(): Promise<
     void
     > => {
@@ -41,7 +47,7 @@ describe('A server using a AuthenticatedFileResourceStore', (): void => {
       await aclHelper.setSimpleAcl({ read: true, write: true, append: true }, 'agent');
 
       // Create file
-      let response = await fileHelper.createFile('../assets/testfile2.txt', 'testfile2.txt');
+      let response = await fileHelper.createFile('../assets/testfile2.txt', 'testfile2.txt', 'text/plain');
       const id = response._getHeaders().location;
 
       // Get file
@@ -61,7 +67,7 @@ describe('A server using a AuthenticatedFileResourceStore', (): void => {
       await aclHelper.setSimpleAcl({ read: true, write: true, append: true }, 'authenticated');
 
       // Try to create file
-      const response = await fileHelper.createFile('../assets/testfile2.txt', 'testfile2.txt', true);
+      const response = await fileHelper.createFile('../assets/testfile2.txt', 'testfile2.txt', 'text/plain', true);
       expect(response.statusCode).toBe(401);
     });
 
@@ -71,7 +77,7 @@ describe('A server using a AuthenticatedFileResourceStore', (): void => {
       await aclHelper.setSimpleAcl({ read: true, write: false, append: false }, 'agent');
 
       // Try to create file
-      let response = await fileHelper.createFile('../assets/testfile2.txt', 'testfile2.txt', true);
+      let response = await fileHelper.createFile('../assets/testfile2.txt', 'testfile2.txt', 'text/plain', true);
       expect(response.statusCode).toBe(401);
 
       // GET permanent file

test/integration/FileBasedStore.test.ts

@@ -1,21 +1,32 @@
 import { mkdirSync } from 'fs';
 import * as rimraf from 'rimraf';
 import type { HttpHandler } from '../../src/server/HttpHandler';
+import { FileBasedDataAccessorConfig } from '../configs/FileBasedDataAccessorConfig';
 import { FileResourceStoreConfig } from '../configs/FileResourceStoreConfig';
+import type { ServerConfig } from '../configs/ServerConfig';
 import { BASE, getRootFilePath } from '../configs/Util';
 import { FileTestHelper } from '../util/TestHelpers';
 
-describe('A server using a FileResourceStore', (): void => {
+const fileResourceStore: [string, (rootFilePath: string) => ServerConfig] = [
+  'FileResourceStore',
+  (rootFilePath: string): ServerConfig => new FileResourceStoreConfig(BASE, rootFilePath),
+];
+const dataAccessorStore: [string, (rootFilePath: string) => ServerConfig] = [
+  'FileDataAccessorBasedStore',
+  (rootFilePath: string): ServerConfig => new FileBasedDataAccessorConfig(BASE, rootFilePath),
+];
+
+describe.each([ fileResourceStore, dataAccessorStore ])('A server using a %s', (name, configFn): void => {
   describe('without acl', (): void => {
     let rootFilePath: string;
-    let config: FileResourceStoreConfig;
+    let config: ServerConfig;
     let handler: HttpHandler;
     let fileHelper: FileTestHelper;
 
     beforeAll(async(): Promise<void> => {
-      rootFilePath = getRootFilePath('FileResourceStore');
+      rootFilePath = getRootFilePath(name);
       mkdirSync(rootFilePath, { recursive: true });
-      config = new FileResourceStoreConfig(BASE, rootFilePath);
+      config = configFn(rootFilePath);
       handler = config.getHttpHandler();
       fileHelper = new FileTestHelper(handler, new URL(BASE));
     });
@@ -27,7 +38,7 @@ describe('A server using a FileResourceStore', (): void => {
     it('can add a file to the store, read it and delete it.', async():
     Promise<void> => {
       // POST
-      let response = await fileHelper.createFile('../assets/testfile0.txt', 'testfile0.txt');
+      let response = await fileHelper.createFile('../assets/testfile0.txt', 'testfile0.txt', 'text/plain');
       const id = response._getHeaders().location;
 
       // GET
@@ -42,7 +53,7 @@ describe('A server using a FileResourceStore', (): void => {
     });
 
     it('can add and overwrite a file.', async(): Promise<void> => {
-      let response = await fileHelper.createFile('../assets/testfile0.txt', 'file.txt');
+      let response = await fileHelper.createFile('../assets/testfile0.txt', 'file.txt', 'text/plain');
       const id = response._getHeaders().location;
 
       // GET
@@ -52,7 +63,7 @@ describe('A server using a FileResourceStore', (): void => {
       expect(response._getBuffer().toString()).toContain('TESTFILE0');
 
       // PUT
-      response = await fileHelper.overwriteFile('../assets/testfile1.txt', id);
+      response = await fileHelper.overwriteFile('../assets/testfile1.txt', id, 'text/plain');
 
       // GET
       response = await fileHelper.getFile(id);
@@ -85,7 +96,7 @@ describe('A server using a FileResourceStore', (): void => {
       await fileHelper.createFolder('testfolder0/');
 
       // Create file
-      let response = await fileHelper.createFile('../assets/testfile0.txt', 'testfolder0/testfile0.txt');
+      let response = await fileHelper.createFile('../assets/testfile0.txt', 'testfolder0/testfile0.txt', 'text/plain');
       const id = response._getHeaders().location;
 
       // GET File
@@ -106,7 +117,7 @@ describe('A server using a FileResourceStore', (): void => {
       const folderId = response._getHeaders().location;
 
       // Create file
-      await fileHelper.createFile('../assets/testfile0.txt', 'testfolder1/testfile0.txt');
+      await fileHelper.createFile('../assets/testfile0.txt', 'testfolder1/testfile0.txt', 'text/plain');
 
       // Try DELETE folder
       response = await fileHelper.simpleCall(new URL(folderId), 'DELETE', {});
@@ -151,7 +162,7 @@ describe('A server using a FileResourceStore', (): void => {
       const subFolderId = response._getHeaders().location;
 
       // Create file
-      response = await fileHelper.createFile('../assets/testfile0.txt', 'testfolder3/testfile0.txt');
+      response = await fileHelper.createFile('../assets/testfile0.txt', 'testfolder3/testfile0.txt', 'text/plain');
       const fileId = response._getHeaders().location;
 
       response = await fileHelper.getFolder(folderId);
@@ -170,7 +181,7 @@ describe('A server using a FileResourceStore', (): void => {
     });
 
     it('can upload and delete a image.', async(): Promise<void> => {
-      let response = await fileHelper.createFile('../assets/testimage.png', 'image.png');
+      let response = await fileHelper.createFile('../assets/testimage.png', 'image.png', 'image/png');
       const fileId = response._getHeaders().location;
 
       // GET

test/util/TestHelpers.ts

@@ -108,7 +108,8 @@ export class FileTestHelper {
     return response;
   }
 
-  public async createFile(fileLocation: string, slug: string, mayFail = false): Promise<MockResponse<any>> {
+  public async createFile(fileLocation: string, slug: string, contentType: string, mayFail = false):
+  Promise<MockResponse<any>> {
     const fileData = await fs.readFile(
       join(__dirname, fileLocation),
     );
@@ -116,7 +117,7 @@ export class FileTestHelper {
     const response: MockResponse<any> = await this.callWithFile(
       this.baseUrl,
       'POST',
-      { 'content-type': 'application/octet-stream',
+      { 'content-type': contentType,
         slug,
         'transfer-encoding': 'chunked' },
       fileData,
@@ -129,7 +130,8 @@ export class FileTestHelper {
     return response;
   }
 
-  public async overwriteFile(fileLocation: string, requestUrl: string): Promise<MockResponse<any>> {
+  public async overwriteFile(fileLocation: string, requestUrl: string, contentType: string):
+  Promise<MockResponse<any>> {
     const fileData = await fs.readFile(
       join(__dirname, fileLocation),
     );
@@ -139,7 +141,7 @@ export class FileTestHelper {
     const response: MockResponse<any> = await this.callWithFile(
       putUrl,
       'PUT',
-      { 'content-type': 'application/octet-stream', 'transfer-encoding': 'chunked' },
+      { 'content-type': contentType, 'transfer-encoding': 'chunked' },
       fileData,
     );
     expect(response.statusCode).toBe(200);