Skip to content

Commit

Permalink
Fix: Token with sprite and glyphs (#192)
Browse files Browse the repository at this point in the history
* export Util.formatStyle

so we can run unit tests

* add unit test to show token issue

* fix sprite token issue

* unit test to check if token added to glyphs

* fix token added to glyphs (Fonts)

* Update spec/UtilSpec.js

Co-authored-by: Patrick Arlt <[email protected]>

* Update spec/UtilSpec.js

Co-authored-by: Patrick Arlt <[email protected]>

* Update spec/UtilSpec.js

Co-authored-by: Patrick Arlt <[email protected]>

* Update spec/UtilSpec.js

Co-authored-by: Patrick Arlt <[email protected]>

* check for same domain between style URL and sprite/glyph URL

* updated test names

---------

Co-authored-by: Patrick Arlt <[email protected]>
  • Loading branch information
gavinr-maps and patrickarlt authored Oct 12, 2023
1 parent 5e6aa8c commit 30f8267
Show file tree
Hide file tree
Showing 3 changed files with 175 additions and 4 deletions.
149 changes: 149 additions & 0 deletions spec/UtilSpec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
/* eslint-env mocha */
const metadata = {
tiles: ['tile/{z}/{y}/{x}.pbf'],
tileInfo: {
lods: [
{
level: 0,
resolution: 78271.516964,
scale: 295828763.7957775
}
]
}
};

describe('Util', function () {
it('should include the token in the sprite URL when the sprite URL is relative', function () {
const spriteUrl = '../sprites/sprite';
const token = 'asdf';
const styleUrl =
'https://tiles.arcgis.com/tiles/test/arcgis/rest/services/test/VectorTileServer/resources/styles/root.json';
const fullSpriteUrl =
'https://tiles.arcgis.com/tiles/test/arcgis/rest/services/test/VectorTileServer/resources/sprites/sprite';

const style = L.esri.Vector.Util.formatStyle(
{
version: 8,
sprite: spriteUrl,
glyphs: '../fonts/{fontstack}/{range}.pbf',
sources: {
esri: {
type: 'vector',
attribution: 'test',
bounds: [-180, -85.0511, 180, 85.0511],
minzoom: 0,
maxzoom: 19,
scheme: 'xyz',
url: '../../'
}
},
layers: []
},
styleUrl,
metadata,
token
);

// console.log("style.sprite", style.sprite);
expect(style.sprite).to.equal(`${fullSpriteUrl}?token=${token}`);
});

it('should include the token in the sprite URL when the sprite URL starts with https', function () {
const spriteUrl =
'https://www.arcgis.com/sharing/rest/content/items/123456789/resources/sprites/sprite-1679474043120';
const styleUrl =
'https://www.arcgis.com/sharing/rest/content/items/asdf/resources/styles/root.json';
const token = 'asdf';

const style = L.esri.Vector.Util.formatStyle(
{
version: 8,
sprite: spriteUrl,
glyphs: '../fonts/{fontstack}/{range}.pbf',
sources: {
esri: {
type: 'vector',
attribution: 'test',
bounds: [-180, -85.0511, 180, 85.0511],
minzoom: 0,
maxzoom: 19,
scheme: 'xyz',
url: '../../'
}
},
layers: []
},
styleUrl,
metadata,
token
);

expect(style.sprite).to.equal(`${spriteUrl}?token=${token}`);
});

it('should include the token in the glyph URL when the glyph URL is relative', function () {
const token = 'asdf';
const glyphUrl = '../fonts/{fontstack}/{range}.pbf';
const styleUrl =
'https://tiles.arcgis.com/tiles/test/arcgis/rest/services/test/VectorTileServer/resources/styles/root.json';
const fullGlyphUrl =
'https://tiles.arcgis.com/tiles/test/arcgis/rest/services/test/VectorTileServer/resources/fonts/{fontstack}/{range}.pbf';

const style = L.esri.Vector.Util.formatStyle(
{
version: 8,
sprite: 'https://www.arcgis.com/sharing/rest/content/items/123456789/resources/sprites/sprite-1679474043120',
glyphs: glyphUrl,
sources: {
esri: {
type: 'vector',
attribution: 'test',
bounds: [-180, -85.0511, 180, 85.0511],
minzoom: 0,
maxzoom: 19,
scheme: 'xyz',
url: '../../'
}
},
layers: []
},
styleUrl,
metadata,
token
);

expect(style.glyphs).to.equal(`${fullGlyphUrl}?token=${token}`);
});

it('should include the token in the glyph URL when the glyph URL starts with https', function () {
const token = 'asdf';
const glyphUrl = 'https://www.arcgis.com/sharing/rest/content/items/123456789//resources/fonts/{fontstack}/{range}.pbf';
const styleUrl =
'https://www.arcgis.com/sharing/rest/content/items/asdf/resources/styles/root.json';

const style = L.esri.Vector.Util.formatStyle(
{
version: 8,
sprite: 'https://www.arcgis.com/sharing/rest/content/items/123456789/resources/sprites/sprite-1679474043120',
glyphs: glyphUrl,
sources: {
esri: {
type: 'vector',
attribution: 'test',
bounds: [-180, -85.0511, 180, 85.0511],
minzoom: 0,
maxzoom: 19,
scheme: 'xyz',
url: '../../'
}
},
layers: []
},
styleUrl,
metadata,
token
);

expect(style.glyphs).to.equal(`${glyphUrl}?token=${token}`);
});
});
1 change: 1 addition & 0 deletions src/EsriLeafletVector.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ export { version as VERSION };

export { VectorBasemapLayer, vectorBasemapLayer } from './VectorBasemapLayer';
export { VectorTileLayer, vectorTileLayer } from './VectorTileLayer';
export { EsriUtil as Util } from './Util';
export { MaplibreGLJSLayer, maplibreGLJSLayer } from './MaplibreGLLayer';
29 changes: 25 additions & 4 deletions src/Util.js
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,10 @@ function loadStyleFromUrl (styleUrl, options, callback) {
request(styleUrl, params, callback);
}

function isSameTLD (url1, url2) {
return (new URL(url1)).hostname === (new URL(url2)).hostname;
}

export function formatStyle (style, styleUrl, metadata, token) {
// transforms style object in place and also returns it

Expand Down Expand Up @@ -210,9 +214,14 @@ export function formatStyle (style, styleUrl, metadata, token) {
'styles/root.json',
style.sprite.replace('../', '')
);

// add the token to the style.sprite property as a query param
style.sprite += token ? '?token=' + token : '';
}
if (style.sprite && token) {
// add the token to the style.sprite property as a query param, only if same domain (for token security)
if (isSameTLD(styleUrl, style.sprite)) {
style.sprite += '?token=' + token;
} else {
console.warn('Passing a token but sprite URL is not on same base URL, so you must pass the token manually.');
}
}

if (style.glyphs && style.glyphs.indexOf('http') === -1) {
Expand All @@ -221,9 +230,15 @@ export function formatStyle (style, styleUrl, metadata, token) {
'styles/root.json',
style.glyphs.replace('../', '')
);
}

if (style.glyphs && token) {
// add the token to the style.glyphs property as a query param
style.glyphs += token ? '?token=' + token : '';
if (isSameTLD(styleUrl, style.glyphs)) {
style.glyphs += '?token=' + token;
} else {
console.warn('Passing a token but glyph URL is not on same base URL, so you must pass the token manually.');
}
}

return style;
Expand Down Expand Up @@ -277,3 +292,9 @@ const WEB_MERCATOR_WKIDS = [3857, 102100, 102113];
export function isWebMercator (wkid) {
return WEB_MERCATOR_WKIDS.indexOf(wkid) >= 0;
}

export var EsriUtil = {
formatStyle: formatStyle
};

export default EsriUtil;

0 comments on commit 30f8267

Please sign in to comment.