Files
openlayers/test/browser/spec/ol/source/IIIF.test.js
2022-08-03 13:25:43 +01:00

587 lines
19 KiB
JavaScript

import IIIF from '../../../../../src/ol/source/IIIF.js';
import {DEFAULT_TILE_SIZE} from '../../../../../src/ol/tilegrid/common.js';
import {Versions} from '../../../../../src/ol/format/IIIFInfo.js';
describe('ol/source/IIIF', function () {
const width = 2000,
height = 1500,
size = [width, height],
url = 'http://iiif.test/image-id';
function getMinimalSource() {
return new IIIF({
size: size,
});
}
function getSource(additionalOptions) {
const options = Object.assign(
{},
{
size: size,
url: url,
},
additionalOptions === undefined ? {} : additionalOptions
);
return new IIIF(options);
}
describe('constructor', function () {
it('requires valid size option', function () {
expect(function () {
new IIIF();
}).to.throwException();
expect(function () {
new IIIF({});
}).to.throwException();
expect(function () {
new IIIF({
size: [],
});
}).to.throwException();
expect(function () {
new IIIF({
size: 100,
});
}).to.throwException();
expect(function () {
new IIIF({
size: [100],
});
}).to.throwException();
expect(function () {
new IIIF({
size: [null, 100],
});
}).to.throwException();
expect(function () {
new IIIF({
size: ['very wide', 100],
});
}).to.throwException();
expect(function () {
new IIIF({
size: [0, 100],
});
}).to.throwException();
expect(function () {
new IIIF({
size: [100, null],
});
}).to.throwException();
expect(function () {
new IIIF({
size: [100, 0],
});
}).to.throwException();
expect(function () {
new IIIF({
size: [100, 'not that high'],
});
}).to.throwException();
expect(function () {
new IIIF({
size: [100, 200, 300],
});
}).to.throwException();
let source;
expect(function () {
source = new IIIF({
size: [100, 200],
});
}).to.not.throwException();
expect(source).to.be.a(IIIF);
expect(function () {
getMinimalSource();
}).to.not.throwException();
});
it('uses empty base URL, default quality, jpg format as default', function () {
const tileUrlFunction = getMinimalSource().getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be('full/full/0/default.jpg');
});
it('uses native as default quality for version 1', function () {
const tileUrlFunction = new IIIF({
size: size,
version: Versions.VERSION1,
}).getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be('full/full/0/native.jpg');
});
it('corrects non empty base URL if trailing slash is missing', function () {
// missing trailing slash is added
let tileUrlFunction = getSource().getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be(
'http://iiif.test/image-id/full/full/0/default.jpg'
);
// existent trailing slash isn't doubled
tileUrlFunction = getSource({
url: 'http://iiif.test/other-image-id/',
}).getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be(
'http://iiif.test/other-image-id/full/full/0/default.jpg'
);
});
});
describe('#getInterpolate()', function () {
it('is true by default', function () {
const source = new IIIF({size: size});
expect(source.getInterpolate()).to.be(true);
});
it('is false if constructed with interpolate: false', function () {
const source = new IIIF({size: size, interpolate: false});
expect(source.getInterpolate()).to.be(false);
});
});
describe('tileUrlFunction', function () {
it('has only one resolution and one tile if no tiles, resolutions, sizes and supported features are given', function () {
let tileUrlFunction = getSource().getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be(
'http://iiif.test/image-id/full/full/0/default.jpg'
);
expect(tileUrlFunction([-1, 0, 0])).to.be(undefined);
expect(tileUrlFunction([1, 0, 0])).to.be(undefined);
expect(tileUrlFunction([0, 1, 0])).to.be(undefined);
expect(tileUrlFunction([0, 0, 1])).to.be(undefined);
tileUrlFunction = getSource({
version: Versions.VERSION1,
}).getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be(
'http://iiif.test/image-id/full/full/0/native.jpg'
);
tileUrlFunction = getSource({
version: Versions.VERSION3,
}).getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be(
'http://iiif.test/image-id/full/max/0/default.jpg'
);
});
it('constructs the same number of resolutions as distinguishable sizes are given', function () {
let tileUrlFunction = getSource({
sizes: [
[2000, 1500],
[1000, 750],
[500, 375],
],
}).getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be(
'http://iiif.test/image-id/full/500,/0/default.jpg'
);
expect(tileUrlFunction([1, 0, 0])).to.be(
'http://iiif.test/image-id/full/1000,/0/default.jpg'
);
expect(tileUrlFunction([2, 0, 0])).to.be(
'http://iiif.test/image-id/full/full/0/default.jpg'
);
expect(tileUrlFunction([3, 0, 0])).to.be(undefined);
expect(tileUrlFunction([-1, 0, 0])).to.be(undefined);
expect(tileUrlFunction([0, 1, 0])).to.be(undefined);
expect(tileUrlFunction([0, 0, 1])).to.be(undefined);
expect(tileUrlFunction([1, 1, 0])).to.be(undefined);
expect(tileUrlFunction([1, 0, 1])).to.be(undefined);
tileUrlFunction = getSource({
sizes: [
[2000, 1500],
[1000, 750],
[500, 375],
],
version: Versions.VERSION3,
}).getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be(
'http://iiif.test/image-id/full/500,375/0/default.jpg'
);
expect(tileUrlFunction([1, 0, 0])).to.be(
'http://iiif.test/image-id/full/1000,750/0/default.jpg'
);
expect(tileUrlFunction([2, 0, 0])).to.be(
'http://iiif.test/image-id/full/max/0/default.jpg'
);
tileUrlFunction = getSource({
sizes: [
[2000, 1500],
[1000, 749],
[1000, 750],
[500, 375],
[500, 374],
],
}).getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be(
'http://iiif.test/image-id/full/500,/0/default.jpg'
);
expect(tileUrlFunction([1, 0, 0])).to.be(
'http://iiif.test/image-id/full/1000,/0/default.jpg'
);
expect(tileUrlFunction([2, 0, 0])).to.be(
'http://iiif.test/image-id/full/full/0/default.jpg'
);
expect(tileUrlFunction([3, 0, 0])).to.be(undefined);
tileUrlFunction = getSource({
version: Versions.VERSION3,
sizes: [
[2000, 1500],
[1000, 750],
[500, 375],
],
}).getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be(
'http://iiif.test/image-id/full/500,375/0/default.jpg'
);
expect(tileUrlFunction([1, 0, 0])).to.be(
'http://iiif.test/image-id/full/1000,750/0/default.jpg'
);
expect(tileUrlFunction([2, 0, 0])).to.be(
'http://iiif.test/image-id/full/max/0/default.jpg'
);
expect(tileUrlFunction([3, 0, 0])).to.be(undefined);
expect(tileUrlFunction([-1, 0, 0])).to.be(undefined);
expect(tileUrlFunction([0, 1, 0])).to.be(undefined);
expect(tileUrlFunction([0, 0, 1])).to.be(undefined);
expect(tileUrlFunction([1, 1, 0])).to.be(undefined);
expect(tileUrlFunction([1, 0, 1])).to.be(undefined);
});
it('cannot provide scaled tiles without provided tilesize or supported features', function () {
const tileUrlFunction = getSource({
resolutions: [16, 8, 4, 2, 1],
}).getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be(
'http://iiif.test/image-id/full/full/0/default.jpg'
);
expect(tileUrlFunction([-1, 0, 0])).to.be(undefined);
expect(tileUrlFunction([1, 0, 0])).to.be(undefined);
expect(tileUrlFunction([0, 1, 0])).to.be(undefined);
expect(tileUrlFunction([0, 0, 1])).to.be(undefined);
});
it('provides canonical tile URLs for all necessary resolutions if only a tileSize exists', function () {
let tileUrlFunction = getSource({
tileSize: 512,
}).getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be(
'http://iiif.test/image-id/full/500,/0/default.jpg'
);
expect(tileUrlFunction([-1, 0, 0])).to.be(undefined);
expect(tileUrlFunction([0, 1, 0])).to.be(undefined);
expect(tileUrlFunction([0, 0, 1])).to.be(undefined);
expect(tileUrlFunction([1, 0, 0])).to.be(
'http://iiif.test/image-id/0,0,1024,1024/512,/0/default.jpg'
);
expect(tileUrlFunction([1, 1, 0])).to.be(
'http://iiif.test/image-id/1024,0,976,1024/488,/0/default.jpg'
);
expect(tileUrlFunction([1, 0, 1])).to.be(
'http://iiif.test/image-id/0,1024,1024,476/512,/0/default.jpg'
);
expect(tileUrlFunction([1, 1, 1])).to.be(
'http://iiif.test/image-id/1024,1024,976,476/488,/0/default.jpg'
);
expect(tileUrlFunction([2, 0, 0])).to.be(
'http://iiif.test/image-id/0,0,512,512/512,/0/default.jpg'
);
expect(tileUrlFunction([2, 3, 0])).to.be(
'http://iiif.test/image-id/1536,0,464,512/464,/0/default.jpg'
);
expect(tileUrlFunction([2, 0, 2])).to.be(
'http://iiif.test/image-id/0,1024,512,476/512,/0/default.jpg'
);
expect(tileUrlFunction([2, 3, 2])).to.be(
'http://iiif.test/image-id/1536,1024,464,476/464,/0/default.jpg'
);
expect(tileUrlFunction([3, 0, 0])).to.be(undefined);
tileUrlFunction = getSource({
tileSize: 512,
version: Versions.VERSION3,
}).getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be(
'http://iiif.test/image-id/full/500,375/0/default.jpg'
);
expect(tileUrlFunction([1, 0, 0])).to.be(
'http://iiif.test/image-id/0,0,1024,1024/512,512/0/default.jpg'
);
expect(tileUrlFunction([1, 1, 0])).to.be(
'http://iiif.test/image-id/1024,0,976,1024/488,512/0/default.jpg'
);
expect(tileUrlFunction([1, 0, 1])).to.be(
'http://iiif.test/image-id/0,1024,1024,476/512,238/0/default.jpg'
);
expect(tileUrlFunction([1, 1, 1])).to.be(
'http://iiif.test/image-id/1024,1024,976,476/488,238/0/default.jpg'
);
expect(tileUrlFunction([2, 0, 0])).to.be(
'http://iiif.test/image-id/0,0,512,512/512,512/0/default.jpg'
);
expect(tileUrlFunction([2, 3, 0])).to.be(
'http://iiif.test/image-id/1536,0,464,512/464,512/0/default.jpg'
);
expect(tileUrlFunction([2, 0, 2])).to.be(
'http://iiif.test/image-id/0,1024,512,476/512,476/0/default.jpg'
);
expect(tileUrlFunction([2, 3, 2])).to.be(
'http://iiif.test/image-id/1536,1024,464,476/464,476/0/default.jpg'
);
});
it('provides canonical tile URLs for all provided resolutions if a tileSize also exists', function () {
const tileUrlFunction = getSource({
tileSize: 512,
resolutions: [8, 4, 2, 1],
}).getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be(
'http://iiif.test/image-id/full/250,/0/default.jpg'
);
expect(tileUrlFunction([1, 0, 0])).to.be(
'http://iiif.test/image-id/full/500,/0/default.jpg'
);
expect(tileUrlFunction([2, 0, 0])).to.be(
'http://iiif.test/image-id/0,0,1024,1024/512,/0/default.jpg'
);
expect(tileUrlFunction([2, 1, 0])).to.be(
'http://iiif.test/image-id/1024,0,976,1024/488,/0/default.jpg'
);
expect(tileUrlFunction([2, 0, 1])).to.be(
'http://iiif.test/image-id/0,1024,1024,476/512,/0/default.jpg'
);
expect(tileUrlFunction([2, 1, 1])).to.be(
'http://iiif.test/image-id/1024,1024,976,476/488,/0/default.jpg'
);
expect(tileUrlFunction([3, 0, 0])).to.be(
'http://iiif.test/image-id/0,0,512,512/512,/0/default.jpg'
);
expect(tileUrlFunction([3, 3, 0])).to.be(
'http://iiif.test/image-id/1536,0,464,512/464,/0/default.jpg'
);
expect(tileUrlFunction([3, 0, 2])).to.be(
'http://iiif.test/image-id/0,1024,512,476/512,/0/default.jpg'
);
expect(tileUrlFunction([3, 3, 2])).to.be(
'http://iiif.test/image-id/1536,1024,464,476/464,/0/default.jpg'
);
expect(tileUrlFunction([4, 0, 0])).to.be(undefined);
});
it('supports non square tiles', function () {
let tileUrlFunction = getSource({
tileSize: [1024, 512],
}).getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be(
'http://iiif.test/image-id/full/500,/0/default.jpg'
);
expect(tileUrlFunction([1, 0, 0])).to.be(
'http://iiif.test/image-id/0,0,2000,1024/1000,/0/default.jpg'
);
expect(tileUrlFunction([1, 0, 1])).to.be(
'http://iiif.test/image-id/0,1024,2000,476/1000,/0/default.jpg'
);
expect(tileUrlFunction([2, 0, 0])).to.be(
'http://iiif.test/image-id/0,0,1024,512/1024,/0/default.jpg'
);
expect(tileUrlFunction([2, 1, 0])).to.be(
'http://iiif.test/image-id/1024,0,976,512/976,/0/default.jpg'
);
expect(tileUrlFunction([2, 0, 2])).to.be(
'http://iiif.test/image-id/0,1024,1024,476/1024,/0/default.jpg'
);
expect(tileUrlFunction([2, 1, 2])).to.be(
'http://iiif.test/image-id/1024,1024,976,476/976,/0/default.jpg'
);
expect(tileUrlFunction([3, 0, 0])).to.be(undefined);
tileUrlFunction = getSource({
tileSize: [1024, 512],
version: Versions.VERSION3,
}).getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be(
'http://iiif.test/image-id/full/500,375/0/default.jpg'
);
expect(tileUrlFunction([2, 0, 0])).to.be(
'http://iiif.test/image-id/0,0,1024,512/1024,512/0/default.jpg'
);
});
it('provides tile URLs with default tile size if sufficient supported features are provided', function () {
let tileUrlFunction = getSource({
supports: ['regionByPx', 'sizeByW'],
}).getTileUrlFunction();
const maxZoom = Math.ceil(Math.log2(width / DEFAULT_TILE_SIZE));
expect(tileUrlFunction([maxZoom, 0, 0])).to.be(
'http://iiif.test/image-id/0,0,' +
DEFAULT_TILE_SIZE +
',' +
DEFAULT_TILE_SIZE +
'/' +
DEFAULT_TILE_SIZE +
',/0/default.jpg'
);
expect(tileUrlFunction([maxZoom + 1, 0, 0])).to.be(undefined);
tileUrlFunction = getSource({
supports: ['regionByPx', 'sizeByH'],
}).getTileUrlFunction();
expect(tileUrlFunction([maxZoom, 0, 0])).to.be(
'http://iiif.test/image-id/0,0,' +
DEFAULT_TILE_SIZE +
',' +
DEFAULT_TILE_SIZE +
'/,' +
DEFAULT_TILE_SIZE +
'/0/default.jpg'
);
expect(tileUrlFunction([maxZoom + 1, 0, 0])).to.be(undefined);
tileUrlFunction = getSource({
supports: ['regionByPx', 'sizeByWh'],
}).getTileUrlFunction();
expect(tileUrlFunction([maxZoom, 0, 0])).to.be(
'http://iiif.test/image-id/0,0,' +
DEFAULT_TILE_SIZE +
',' +
DEFAULT_TILE_SIZE +
'/' +
DEFAULT_TILE_SIZE +
',' +
DEFAULT_TILE_SIZE +
'/0/default.jpg'
);
expect(tileUrlFunction([maxZoom + 1, 0, 0])).to.be(undefined);
tileUrlFunction = getSource({
supports: ['regionByPct', 'sizeByPct'],
}).getTileUrlFunction();
const tileWPct = ((DEFAULT_TILE_SIZE / width) * 100).toLocaleString(
'en',
{maximumFractionDigits: 10}
),
tileHPct = ((DEFAULT_TILE_SIZE / height) * 100).toLocaleString('en', {
maximumFractionDigits: 10,
});
expect(tileUrlFunction([maxZoom, 0, 0])).to.be(
'http://iiif.test/image-id/pct:0,0,' +
tileWPct +
',' +
tileHPct +
'/pct:100/0/default.jpg'
);
expect(tileUrlFunction([maxZoom + 1, 0, 0])).to.be(undefined);
});
it('prefers canonical tile URLs', function () {
let tileUrlFunction = getSource({
tileSize: 512,
supports: [
'regionByPx',
'regionByPct',
'sizeByW',
'sizeByH',
'sizeByWh',
'sizeByPct',
],
}).getTileUrlFunction();
expect(tileUrlFunction([2, 0, 0])).to.be(
'http://iiif.test/image-id/0,0,512,512/512,/0/default.jpg'
);
tileUrlFunction = getSource({
tileSize: 512,
version: Versions.VERSION3,
supports: [
'regionByPx',
'regionByPct',
'sizeByW',
'sizeByH',
'sizeByWh',
'sizeByPct',
],
}).getTileUrlFunction();
expect(tileUrlFunction([2, 0, 0])).to.be(
'http://iiif.test/image-id/0,0,512,512/512,512/0/default.jpg'
);
});
it('provides correct tile URLs for percentage URL parameter values', function () {
const tileUrlFunction = getSource({
tileSize: 512,
supports: ['regionByPct', 'sizeByPct'],
}).getTileUrlFunction();
expect(tileUrlFunction([0, 0, 0])).to.be(
'http://iiif.test/image-id/full/pct:25/0/default.jpg'
);
expect(tileUrlFunction([-1, 0, 0])).to.be(undefined);
expect(tileUrlFunction([0, 1, 0])).to.be(undefined);
expect(tileUrlFunction([0, 0, 1])).to.be(undefined);
expect(tileUrlFunction([1, 0, 0])).to.be(
'http://iiif.test/image-id/pct:0,0,51.2,68.2666666667/pct:50/0/default.jpg'
);
expect(tileUrlFunction([1, 1, 0])).to.be(
'http://iiif.test/image-id/pct:51.2,0,48.8,68.2666666667/pct:50/0/default.jpg'
);
expect(tileUrlFunction([1, 0, 1])).to.be(
'http://iiif.test/image-id/pct:0,68.2666666667,51.2,31.7333333333/pct:50/0/default.jpg'
);
expect(tileUrlFunction([1, 1, 1])).to.be(
'http://iiif.test/image-id/pct:51.2,68.2666666667,48.8,31.7333333333/pct:50/0/default.jpg'
);
expect(tileUrlFunction([2, 0, 0])).to.be(
'http://iiif.test/image-id/pct:0,0,25.6,34.1333333333/pct:100/0/default.jpg'
);
expect(tileUrlFunction([2, 3, 0])).to.be(
'http://iiif.test/image-id/pct:76.8,0,23.2,34.1333333333/pct:100/0/default.jpg'
);
expect(tileUrlFunction([2, 0, 2])).to.be(
'http://iiif.test/image-id/pct:0,68.2666666667,25.6,31.7333333333/pct:100/0/default.jpg'
);
expect(tileUrlFunction([2, 3, 2])).to.be(
'http://iiif.test/image-id/pct:76.8,68.2666666667,23.2,31.7333333333/pct:100/0/default.jpg'
);
expect(tileUrlFunction([3, 0, 0])).to.be(undefined);
});
});
});