feat: Introduce generic auxiliary resource support

test/unit/ldp/auxiliary/ComposedAuxiliaryStrategy.test.ts

@@ -0,0 +1,80 @@
+import type { AuxiliaryIdentifierStrategy } from '../../../../src/ldp/auxiliary/AuxiliaryIdentifierStrategy';
+import { ComposedAuxiliaryStrategy } from '../../../../src/ldp/auxiliary/ComposedAuxiliaryStrategy';
+import type { MetadataGenerator } from '../../../../src/ldp/auxiliary/MetadataGenerator';
+import type { Validator } from '../../../../src/ldp/auxiliary/Validator';
+import { RepresentationMetadata } from '../../../../src/ldp/representation/RepresentationMetadata';
+
+describe('A ComposedAuxiliaryStrategy', (): void => {
+  const identifier = { path: 'http://test.com/foo' };
+  let identifierStrategy: AuxiliaryIdentifierStrategy;
+  let metadataGenerator: MetadataGenerator;
+  let validator: Validator;
+  let strategy: ComposedAuxiliaryStrategy;
+
+  beforeEach(async(): Promise<void> => {
+    identifierStrategy = {
+      getAuxiliaryIdentifier: jest.fn(),
+      getAuxiliaryIdentifiers: jest.fn(),
+      getAssociatedIdentifier: jest.fn(),
+      isAuxiliaryIdentifier: jest.fn(),
+    };
+    metadataGenerator = {
+      handleSafe: jest.fn(),
+    } as any;
+    validator = {
+      handleSafe: jest.fn(),
+    } as any;
+    strategy = new ComposedAuxiliaryStrategy(identifierStrategy, metadataGenerator, validator, true);
+  });
+
+  it('calls the AuxiliaryIdentifierStrategy for related calls.', async(): Promise<void> => {
+    strategy.getAuxiliaryIdentifier(identifier);
+    expect(identifierStrategy.getAuxiliaryIdentifier).toHaveBeenCalledTimes(1);
+    expect(identifierStrategy.getAuxiliaryIdentifier).toHaveBeenLastCalledWith(identifier);
+
+    strategy.getAuxiliaryIdentifiers(identifier);
+    expect(identifierStrategy.getAuxiliaryIdentifiers).toHaveBeenCalledTimes(1);
+    expect(identifierStrategy.getAuxiliaryIdentifiers).toHaveBeenLastCalledWith(identifier);
+
+    strategy.getAssociatedIdentifier(identifier);
+    expect(identifierStrategy.getAssociatedIdentifier).toHaveBeenCalledTimes(1);
+    expect(identifierStrategy.getAssociatedIdentifier).toHaveBeenLastCalledWith(identifier);
+
+    strategy.isAuxiliaryIdentifier(identifier);
+    expect(identifierStrategy.isAuxiliaryIdentifier).toHaveBeenCalledTimes(1);
+    expect(identifierStrategy.isAuxiliaryIdentifier).toHaveBeenLastCalledWith(identifier);
+  });
+
+  it('returns the injected value for canDeleteRoot.', async(): Promise<void> => {
+    expect(strategy.requiresRootAuxiliary()).toBe(true);
+  });
+
+  it('adds metadata through the MetadataGenerator.', async(): Promise<void> => {
+    const metadata = new RepresentationMetadata();
+    await expect(strategy.addMetadata(metadata)).resolves.toBeUndefined();
+    expect(metadataGenerator.handleSafe).toHaveBeenCalledTimes(1);
+    expect(metadataGenerator.handleSafe).toHaveBeenLastCalledWith(metadata);
+  });
+
+  it('validates data through the Validator.', async(): Promise<void> => {
+    const representation = { data: 'data!' } as any;
+    await expect(strategy.validate(representation)).resolves.toBeUndefined();
+    expect(validator.handleSafe).toHaveBeenCalledTimes(1);
+    expect(validator.handleSafe).toHaveBeenLastCalledWith(representation);
+  });
+
+  it('defaults canDeleteRoot to false.', async(): Promise<void> => {
+    strategy = new ComposedAuxiliaryStrategy(identifierStrategy, metadataGenerator, validator);
+    expect(strategy.requiresRootAuxiliary()).toBe(false);
+  });
+
+  it('does not add metadata or validate if the corresponding classes are not injected.', async(): Promise<void> => {
+    strategy = new ComposedAuxiliaryStrategy(identifierStrategy);
+
+    const metadata = new RepresentationMetadata();
+    await expect(strategy.addMetadata(metadata)).resolves.toBeUndefined();
+
+    const representation = { data: 'data!' } as any;
+    await expect(strategy.validate(representation)).resolves.toBeUndefined();
+  });
+});

test/unit/ldp/auxiliary/LinkMetadataGenerator.test.ts

@@ -0,0 +1,39 @@
+import type { AuxiliaryIdentifierStrategy } from '../../../../src/ldp/auxiliary/AuxiliaryIdentifierStrategy';
+import { LinkMetadataGenerator } from '../../../../src/ldp/auxiliary/LinkMetadataGenerator';
+import { RepresentationMetadata } from '../../../../src/ldp/representation/RepresentationMetadata';
+import type { ResourceIdentifier } from '../../../../src/ldp/representation/ResourceIdentifier';
+
+describe('A LinkMetadataGenerator', (): void => {
+  const link = 'link';
+  const associatedId: ResourceIdentifier = { path: 'http://test.com/foo' };
+  const auxiliaryId: ResourceIdentifier = { path: 'http://test.com/foo.dummy' };
+  let generator: LinkMetadataGenerator;
+
+  beforeEach(async(): Promise<void> => {
+    const strategy = {
+      getAuxiliaryIdentifier: (identifier: ResourceIdentifier): ResourceIdentifier =>
+        ({ path: `${identifier.path}.dummy` }),
+      isAuxiliaryIdentifier: (identifier: ResourceIdentifier): boolean => identifier.path.endsWith('.dummy'),
+      getAssociatedIdentifier: (identifier: ResourceIdentifier): ResourceIdentifier =>
+        ({ path: identifier.path.slice(0, -'.dummy'.length) }),
+    } as AuxiliaryIdentifierStrategy;
+    generator = new LinkMetadataGenerator(link, strategy);
+  });
+
+  it('can handle all metadata.', async(): Promise<void> => {
+    await expect(generator.canHandle(null as any)).resolves.toBeUndefined();
+  });
+
+  it('stores no metadata if the input is an associated resource.', async(): Promise<void> => {
+    const metadata = new RepresentationMetadata(auxiliaryId);
+    await expect(generator.handle(metadata)).resolves.toBeUndefined();
+    expect(metadata.quads()).toHaveLength(0);
+  });
+
+  it('uses the stored link to add metadata for associated resources.', async(): Promise<void> => {
+    const metadata = new RepresentationMetadata(associatedId);
+    await expect(generator.handle(metadata)).resolves.toBeUndefined();
+    expect(metadata.quads()).toHaveLength(1);
+    expect(metadata.get(link)?.value).toBe(auxiliaryId.path);
+  });
+});

test/unit/ldp/auxiliary/RdfValidator.test.ts

@@ -0,0 +1,44 @@
+import { RdfValidator } from '../../../../src/ldp/auxiliary/RdfValidator';
+import { BasicRepresentation } from '../../../../src/ldp/representation/BasicRepresentation';
+import type { RepresentationConverter } from '../../../../src/storage/conversion/RepresentationConverter';
+import { readableToString } from '../../../../src/util/StreamUtil';
+import { StaticAsyncHandler } from '../../../util/StaticAsyncHandler';
+import 'jest-rdf';
+
+describe('An RdfValidator', (): void => {
+  let converter: RepresentationConverter;
+  let validator: RdfValidator;
+
+  beforeEach(async(): Promise<void> => {
+    converter = new StaticAsyncHandler<any>(true, null);
+    validator = new RdfValidator(converter);
+  });
+
+  it('can handle all representations.', async(): Promise<void> => {
+    await expect(validator.canHandle(null as any)).resolves.toBeUndefined();
+  });
+
+  it('always accepts content-type internal/quads.', async(): Promise<void> => {
+    const representation = new BasicRepresentation('data', 'internal/quads');
+    await expect(validator.handle(representation)).resolves.toBeUndefined();
+  });
+
+  it('validates data by running it through a converter.', async(): Promise<void> => {
+    converter.handleSafe = jest.fn().mockResolvedValue(new BasicRepresentation('transformedData', 'wrongType'));
+    const representation = new BasicRepresentation('data', 'content-type');
+    const quads = representation.metadata.quads();
+    await expect(validator.handle(representation)).resolves.toBeUndefined();
+    // Make sure the data can still be streamed
+    await expect(readableToString(representation.data)).resolves.toBe('data');
+    // Make sure the metadata was not changed
+    expect(quads).toBeRdfIsomorphic(representation.metadata.quads());
+  });
+
+  it('throws an error when validating invalid data.', async(): Promise<void> => {
+    converter.handleSafe = jest.fn().mockRejectedValue(new Error('bad data!'));
+    const representation = new BasicRepresentation('data', 'content-type');
+    await expect(validator.handle(representation)).rejects.toThrow('bad data!');
+    // Make sure the data on the readable has not been reset
+    expect(representation.data.readableEnded).toBe(true);
+  });
+});

test/unit/ldp/auxiliary/RoutingAuxiliaryIdentifierStrategy.test.ts

@@ -0,0 +1,66 @@
+import type { AuxiliaryIdentifierStrategy } from '../../../../src/ldp/auxiliary/AuxiliaryIdentifierStrategy';
+import { RoutingAuxiliaryIdentifierStrategy } from '../../../../src/ldp/auxiliary/RoutingAuxiliaryIdentifierStrategy';
+import type { ResourceIdentifier } from '../../../../src/ldp/representation/ResourceIdentifier';
+import { InternalServerError } from '../../../../src/util/errors/InternalServerError';
+import { NotImplementedHttpError } from '../../../../src/util/errors/NotImplementedHttpError';
+
+class SimpleSuffixStrategy implements AuxiliaryIdentifierStrategy {
+  private readonly suffix: string;
+
+  public constructor(suffix: string) {
+    this.suffix = suffix;
+  }
+
+  public getAuxiliaryIdentifier(identifier: ResourceIdentifier): ResourceIdentifier {
+    return { path: `${identifier.path}${this.suffix}` };
+  }
+
+  public getAuxiliaryIdentifiers(identifier: ResourceIdentifier): ResourceIdentifier[] {
+    return [ this.getAuxiliaryIdentifier(identifier) ];
+  }
+
+  public isAuxiliaryIdentifier(identifier: ResourceIdentifier): boolean {
+    return identifier.path.endsWith(this.suffix);
+  }
+
+  public getAssociatedIdentifier(identifier: ResourceIdentifier): ResourceIdentifier {
+    return { path: identifier.path.slice(0, -this.suffix.length) };
+  }
+}
+
+describe('A RoutingAuxiliaryIdentifierStrategy', (): void => {
+  let sources: SimpleSuffixStrategy[];
+  let strategy: RoutingAuxiliaryIdentifierStrategy;
+  const baseId = { path: 'http://test.com/foo' };
+  const dummy1Id = { path: 'http://test.com/foo.dummy1' };
+  const dummy2Id = { path: 'http://test.com/foo.dummy2' };
+  const dummy3Id = { path: 'http://test.com/foo.dummy3' };
+
+  beforeEach(async(): Promise<void> => {
+    sources = [
+      new SimpleSuffixStrategy('.dummy1'),
+      new SimpleSuffixStrategy('.dummy2'),
+    ];
+    strategy = new RoutingAuxiliaryIdentifierStrategy(sources);
+  });
+
+  it('#getAuxiliaryIdentifier always errors.', async(): Promise<void> => {
+    expect((): any => strategy.getAuxiliaryIdentifier()).toThrow(InternalServerError);
+  });
+
+  it('#getAuxiliaryIdentifiers returns results of all sources.', async(): Promise<void> => {
+    expect(strategy.getAuxiliaryIdentifiers(baseId)).toEqual([ dummy1Id, dummy2Id ]);
+  });
+
+  it('#isAuxiliaryIdentifier returns true if there is at least 1 match.', async(): Promise<void> => {
+    expect(strategy.isAuxiliaryIdentifier(dummy1Id)).toBe(true);
+    expect(strategy.isAuxiliaryIdentifier(dummy2Id)).toBe(true);
+    expect(strategy.isAuxiliaryIdentifier(dummy3Id)).toBe(false);
+  });
+
+  it('#getAssociatedIdentifier returns the base id if a match is found.', async(): Promise<void> => {
+    expect(strategy.getAssociatedIdentifier(dummy1Id)).toEqual(baseId);
+    expect(strategy.getAssociatedIdentifier(dummy2Id)).toEqual(baseId);
+    expect((): any => strategy.getAssociatedIdentifier(dummy3Id)).toThrow(NotImplementedHttpError);
+  });
+});

test/unit/ldp/auxiliary/RoutingAuxiliaryStrategy.test.ts

@@ -0,0 +1,106 @@
+import type { AuxiliaryStrategy } from '../../../../src/ldp/auxiliary/AuxiliaryStrategy';
+import { RoutingAuxiliaryStrategy } from '../../../../src/ldp/auxiliary/RoutingAuxiliaryStrategy';
+import { RepresentationMetadata } from '../../../../src/ldp/representation/RepresentationMetadata';
+import type { ResourceIdentifier } from '../../../../src/ldp/representation/ResourceIdentifier';
+import { NotImplementedHttpError } from '../../../../src/util/errors/NotImplementedHttpError';
+
+class SimpleSuffixStrategy implements AuxiliaryStrategy {
+  private readonly suffix: string;
+
+  public constructor(suffix: string) {
+    this.suffix = suffix;
+  }
+
+  public getAuxiliaryIdentifier(identifier: ResourceIdentifier): ResourceIdentifier {
+    return { path: `${identifier.path}${this.suffix}` };
+  }
+
+  public getAuxiliaryIdentifiers(identifier: ResourceIdentifier): ResourceIdentifier[] {
+    return [ this.getAuxiliaryIdentifier(identifier) ];
+  }
+
+  public isAuxiliaryIdentifier(identifier: ResourceIdentifier): boolean {
+    return identifier.path.endsWith(this.suffix);
+  }
+
+  public getAssociatedIdentifier(identifier: ResourceIdentifier): ResourceIdentifier {
+    return { path: identifier.path.slice(0, -this.suffix.length) };
+  }
+
+  public requiresRootAuxiliary(): boolean {
+    return true;
+  }
+
+  public async addMetadata(): Promise<void> {
+    // Empty fn
+  }
+
+  public async validate(): Promise<void> {
+    // Always validates
+  }
+}
+
+describe('A RoutingAuxiliaryStrategy', (): void => {
+  let sources: SimpleSuffixStrategy[];
+  let strategy: RoutingAuxiliaryStrategy;
+  const baseId = { path: 'http://test.com/foo' };
+  const dummy1Id = { path: 'http://test.com/foo.dummy1' };
+  const dummy2Id = { path: 'http://test.com/foo.dummy2' };
+  const dummy3Id = { path: 'http://test.com/foo.dummy3' };
+
+  beforeEach(async(): Promise<void> => {
+    sources = [
+      new SimpleSuffixStrategy('.dummy1'),
+      new SimpleSuffixStrategy('.dummy2'),
+    ];
+    strategy = new RoutingAuxiliaryStrategy(sources);
+  });
+
+  it('#addMetadata adds the metadata of all sources for the base identifier.', async(): Promise<void> => {
+    sources[0].addMetadata = jest.fn();
+    sources[1].addMetadata = jest.fn();
+    const metadata = new RepresentationMetadata(baseId);
+    await expect(strategy.addMetadata(metadata)).resolves.toBeUndefined();
+    expect(sources[0].addMetadata).toHaveBeenCalledTimes(1);
+    expect(sources[0].addMetadata).toHaveBeenLastCalledWith(metadata);
+    expect(sources[1].addMetadata).toHaveBeenCalledTimes(1);
+    expect(sources[1].addMetadata).toHaveBeenLastCalledWith(metadata);
+  });
+
+  it('#addMetadata adds the metadata of the correct source for auxiliary identifiers.', async(): Promise<void> => {
+    sources[0].addMetadata = jest.fn();
+    sources[1].addMetadata = jest.fn();
+    const metadata = new RepresentationMetadata(dummy2Id);
+    await expect(strategy.addMetadata(metadata)).resolves.toBeUndefined();
+    expect(sources[0].addMetadata).toHaveBeenCalledTimes(0);
+    expect(sources[1].addMetadata).toHaveBeenCalledTimes(1);
+    expect(sources[1].addMetadata).toHaveBeenLastCalledWith(metadata);
+  });
+
+  it('#canDeleteRoot returns the result of the correct source.', async(): Promise<void> => {
+    sources[0].requiresRootAuxiliary = jest.fn();
+    sources[1].requiresRootAuxiliary = jest.fn();
+    strategy.requiresRootAuxiliary(dummy2Id);
+    expect(sources[0].requiresRootAuxiliary).toHaveBeenCalledTimes(0);
+    expect(sources[1].requiresRootAuxiliary).toHaveBeenCalledTimes(1);
+    expect(sources[1].requiresRootAuxiliary).toHaveBeenLastCalledWith(dummy2Id);
+  });
+
+  it('#validates using the correct validator.', async(): Promise<void> => {
+    sources[0].validate = jest.fn();
+    sources[1].validate = jest.fn();
+
+    let metadata = new RepresentationMetadata(dummy1Id);
+    await expect(strategy.validate({ metadata } as any)).resolves.toBeUndefined();
+    expect(sources[0].validate).toHaveBeenCalledTimes(1);
+    expect(sources[1].validate).toHaveBeenCalledTimes(0);
+
+    metadata = new RepresentationMetadata(dummy2Id);
+    await expect(strategy.validate({ metadata } as any)).resolves.toBeUndefined();
+    expect(sources[0].validate).toHaveBeenCalledTimes(1);
+    expect(sources[1].validate).toHaveBeenCalledTimes(1);
+
+    metadata = new RepresentationMetadata(dummy3Id);
+    await expect(strategy.validate({ metadata } as any)).rejects.toThrow(NotImplementedHttpError);
+  });
+});

test/unit/ldp/auxiliary/SuffixAuxiliaryIdentifierStrategy.test.ts

@@ -0,0 +1,45 @@
+import { SuffixAuxiliaryIdentifierStrategy } from '../../../../src/ldp/auxiliary/SuffixAuxiliaryIdentifierStrategy';
+import type { ResourceIdentifier } from '../../../../src/ldp/representation/ResourceIdentifier';
+import { InternalServerError } from '../../../../src/util/errors/InternalServerError';
+import 'jest-rdf';
+
+const suffix = '.dummy';
+
+describe('A SuffixAuxiliaryManager', (): void => {
+  let strategy: SuffixAuxiliaryIdentifierStrategy;
+  const associatedId: ResourceIdentifier = { path: 'http://test.com/foo' };
+  const auxiliaryId: ResourceIdentifier = { path: 'http://test.com/foo.dummy' };
+
+  beforeEach(async(): Promise<void> => {
+    strategy = new SuffixAuxiliaryIdentifierStrategy(suffix);
+  });
+
+  it('errors if the suffix is empty.', async(): Promise<void> => {
+    expect((): any => new SuffixAuxiliaryIdentifierStrategy('')).toThrow('Suffix length should be non-zero.');
+  });
+
+  it('creates new identifiers by appending the suffix.', async(): Promise<void> => {
+    expect(strategy.getAuxiliaryIdentifier(associatedId)).toEqual(auxiliaryId);
+  });
+
+  it('returns the same single identifier when requesting all of them.', async(): Promise<void> => {
+    expect(strategy.getAuxiliaryIdentifiers(associatedId)).toEqual([ auxiliaryId ]);
+  });
+
+  it('checks the suffix to determine if an identifier is auxiliary.', async(): Promise<void> => {
+    expect(strategy.isAuxiliaryIdentifier(associatedId)).toBe(false);
+    expect(strategy.isAuxiliaryIdentifier(auxiliaryId)).toBe(true);
+  });
+
+  it('errors when trying to get the associated id from a non-auxiliary identifier.', async(): Promise<void> => {
+    expect((): any => strategy.getAssociatedIdentifier(associatedId)).toThrow(InternalServerError);
+  });
+
+  it('removes the suffix to create the associated identifier.', async(): Promise<void> => {
+    expect(strategy.getAssociatedIdentifier(auxiliaryId)).toEqual(associatedId);
+  });
+
+  it('returns true on canDeleteRoot.', async(): Promise<void> => {
+    expect(strategy.canDeleteRoot()).toEqual(true);
+  });
+});