mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00

* feat: implemented SizeReporter and FileSizeReporter * test: FileSizeReporter tests * feat: added QuotedDataAccessor * test: added extra test to check recursiveness of filesizereporter * feat: added QuotaStrategy interface * feat: further progress in different files * feat: wrote doc, tests and improved code * feat: fixed bugs and code is now runnable and buildable * feat: finished implementation * fix: revert accidental chanegs * fix: fileSizeReported did not count container size * fix: bug calculating container sizes fixed * test: FileSizeReporter tests * test: QuotaDataValidator tests * test: QuotaError tests * fix: removed console.log * doc: added doc to several files * doc: changed doc for QuotaStrategy to new implementation * fix: improved content length regex * feat: improved GlobalQuotaStrategy code * fix: made FileSizeReported readonly * feat: added comments to quota-file.json * fix: changed default tempFilePath variable * test: included new tempFilePath variable in testing * chore: created seperate command for start:file:quota to pass tests * feat: removed all sync fs calls from FileSizeReporter * feat: minor changes in multple files * fix: changed function signatures to be in line with others * feat: optimized quota data validation * feat: improved FileSizeReporter code * fix: corrected calculation of containersizes and fixed erroring edgecase * feat: save content-length as number in metadata * feat: added comments and changed GlobalQuotaStrategy constructor * feat: changed file names and added small comment * test: AtomicFileDataAccessor tests * test: completed FileSizeReporter tests * fix: content-length is now saved correctly in RepresentationMetadata * feat: adapted content length metadata + tests * fix: removed tempFilePath variable * fix: reverted .gitignore * fix: forgot to remove tempFilePath variable from componentsjs config * test: GlobalQuotaStrategy tests * feat: replaced DataValidator with Validator * feat: reworked DataValidator * feat: added calcultateChunkSize() to SizeReporter * test: updated FileSizeReporter tests * fix: tempFile location now relative to rootFilePath * test: QuotaDataValidator tests * fix: corrected FileSizeReporter tests * fix: adapted FileSizeReporter tests * fix: FileSizeReporter bug on Windows * fix: regex linting error * feat: changed Validator class * feat: added PodQuotaStrategy to enable suota on a per pod basis * chore: bump context versions * fix: Capitalized comments in json file * chore: renamed ValidatorArgs to ValidatorInput * chore: order all exports * fix: made TODO comment clearer * chore: added seperated config files for global and pod based quota + fixed comments * chore: made minor changes to comments * feat: added PassthroughDataAccessor * feat: added PasstroughtDataAccessor + tests * fix: added invalid header check to ContentLengthParser * chore: improved mocks * chore: move quota limit higher up in config * fix: atomicity issue in AtomicFileDataAccessor * chore: moved .internal folder to config from FileSizeReporter * fix: improved algorithm to ignore folders while calculating file size in FileSizeReporter * fix: changes to support containers in the future * fix: added error handling to prevent reading of unexistent files * feat: added generic type to SizeReporter to calculate chunk sizes * test: use mocked DataAccessor * chore: added some comments to test and made minor improvement * fix: fs mock rename * chore: QuotaStrategy.estimateSize refactor * chore: move trackAvailableSpace to abstract class QuotaStrategy * fix: improved test case * test: quota integration tests * chore: edited some comments * chore: change lstat to stat * feat: moved estimateSize to SizeReporter to be consistent with calcultateChunkSize * test: finish up tests to reach coverage * fix: basic config * fix: minor changes to test CI run * fix: small fix for windows * fix: improved writing to file * chore: linting errors * chore: rename trackAvailableSpace * test: improved integration tests * test: logging info for test debugging * test: extra logging for debugging * test: logging for debugging * test: logging for debugging * test: logging for debugging * test: improved Quota integration test setup * test: improve quota tests for CI run * test: debugging Quota test * test: uncommented global quota test * test: changed global quota parameters * test: logging for debugging * test: logging cleanup * chore: minor changes, mostly typo fixes * chore: remove console.log * fix: getting inconsistent results * chore: try fix index.ts CI error * chore: try fix CI error * chore: try fix CI error * chore: revert last commits * chore: fix inconsistent files with origin * test: minor test improvements * chore: minor refactors and improvements * fix: added extra try catch for breaking bug * chore: improve config * chore: minor code improvements * test: use mockFs * feat: add extra check in podQuotaStrategy * chore: replace handle by handleSafe in ValidatingDataAccessor * chore: typo * test: improved Quota integration tests * test: made comment in test more correct * fix: rm -> rmdir for backwards compatibility * fix: fsPromises issue * chore: leave out irrelevant config * chore: removed start script from package.json * fix: Small fixes Co-authored-by: Joachim Van Herwegen <joachimvh@gmail.com>
78 lines
3.8 KiB
TypeScript
78 lines
3.8 KiB
TypeScript
import { RepresentationMetadata } from '../../../src/http/representation/RepresentationMetadata';
|
|
import type { ResourceIdentifier } from '../../../src/http/representation/ResourceIdentifier';
|
|
import type { DataAccessor } from '../../../src/storage/accessors/DataAccessor';
|
|
import { PodQuotaStrategy } from '../../../src/storage/quota/PodQuotaStrategy';
|
|
import { UNIT_BYTES } from '../../../src/storage/size-reporter/Size';
|
|
import type { Size } from '../../../src/storage/size-reporter/Size';
|
|
import type { SizeReporter } from '../../../src/storage/size-reporter/SizeReporter';
|
|
import { NotFoundHttpError } from '../../../src/util/errors/NotFoundHttpError';
|
|
import type { IdentifierStrategy } from '../../../src/util/identifiers/IdentifierStrategy';
|
|
import { SingleRootIdentifierStrategy } from '../../../src/util/identifiers/SingleRootIdentifierStrategy';
|
|
import { PIM, RDF } from '../../../src/util/Vocabularies';
|
|
import { mockFs } from '../../util/Util';
|
|
|
|
jest.mock('fs');
|
|
|
|
describe('PodQuotaStrategy', (): void => {
|
|
let strategy: PodQuotaStrategy;
|
|
let mockSize: Size;
|
|
let mockReporter: jest.Mocked<SizeReporter<any>>;
|
|
let identifierStrategy: IdentifierStrategy;
|
|
let accessor: jest.Mocked<DataAccessor>;
|
|
const base = 'http://localhost:3000/';
|
|
const rootFilePath = 'folder';
|
|
|
|
beforeEach((): void => {
|
|
jest.restoreAllMocks();
|
|
mockFs(rootFilePath, new Date());
|
|
mockSize = { amount: 2000, unit: UNIT_BYTES };
|
|
identifierStrategy = new SingleRootIdentifierStrategy(base);
|
|
mockReporter = {
|
|
getSize: jest.fn().mockResolvedValue({ unit: mockSize.unit, amount: 50 }),
|
|
getUnit: jest.fn().mockReturnValue(mockSize.unit),
|
|
calculateChunkSize: jest.fn(async(chunk: any): Promise<number> => chunk.length),
|
|
estimateSize: jest.fn().mockResolvedValue(5),
|
|
};
|
|
accessor = {
|
|
// Assume that the pod is called "nested"
|
|
getMetadata: jest.fn().mockImplementation(
|
|
async(identifier: ResourceIdentifier): Promise<RepresentationMetadata> => {
|
|
const res = new RepresentationMetadata();
|
|
if (identifier.path === `${base}nested/`) {
|
|
res.add(RDF.type, PIM.Storage);
|
|
}
|
|
return res;
|
|
},
|
|
),
|
|
} as any;
|
|
strategy = new PodQuotaStrategy(mockSize, mockReporter, identifierStrategy, accessor);
|
|
});
|
|
|
|
describe('getAvailableSpace()', (): void => {
|
|
it('should return a Size containing MAX_SAFE_INTEGER when writing outside a pod.', async(): Promise<void> => {
|
|
const result = strategy.getAvailableSpace({ path: `${base}file.txt` });
|
|
await expect(result).resolves.toEqual(expect.objectContaining({ amount: Number.MAX_SAFE_INTEGER }));
|
|
});
|
|
it('should ignore the size of the existing resource when writing inside a pod.', async(): Promise<void> => {
|
|
const result = strategy.getAvailableSpace({ path: `${base}nested/nested2/file.txt` });
|
|
await expect(result).resolves.toEqual(expect.objectContaining({ amount: mockSize.amount }));
|
|
expect(mockReporter.getSize).toHaveBeenCalledTimes(2);
|
|
});
|
|
it('should return a Size containing the available space when writing inside a pod.', async(): Promise<void> => {
|
|
accessor.getMetadata.mockImplementationOnce((): any => {
|
|
throw new NotFoundHttpError();
|
|
});
|
|
const result = strategy.getAvailableSpace({ path: `${base}nested/nested2/file.txt` });
|
|
await expect(result).resolves.toEqual(expect.objectContaining({ amount: mockSize.amount }));
|
|
expect(mockReporter.getSize).toHaveBeenCalledTimes(2);
|
|
});
|
|
it('should throw when looking for pim:Storage errors.', async(): Promise<void> => {
|
|
accessor.getMetadata.mockImplementationOnce((): any => {
|
|
throw new Error('error');
|
|
});
|
|
const result = strategy.getAvailableSpace({ path: `${base}nested/nested2/file.txt` });
|
|
await expect(result).rejects.toThrow('error');
|
|
});
|
|
});
|
|
});
|