mapbox token error message

[nicolaskruchten]

(Pulling #4035 (comment) out into its own issue)

In the case when the layout.mapbox.style key is not set, and a mapbox token is not provided, I don't think the error message should say "you need a token". It should say "you need to provide a style". And then if the style is known to require a token, we can say "you need a token".

If a token is provided and no style is provided, then we should do the same thing we do right now: use "basic" as the default style.

[etpinard]

Here's the current state of affairs:

plotly.js/test/jasmine/tests/mapbox_test.js

Lines 242 to 449 in 218a919

	describe('mapbox credentials', function() {
	var gd;
	var dummyToken = 'asfdsa124331wersdsa1321q3';
	var osmStyle = {
	id: 'osm',
	version: 8,
	sources: {
	'osm-tiles': {
	type: 'raster',
	tiles: [
	'https://a.tile.openstreetmap.org/{z}/{x}/{y}.png',
	'https://b.tile.openstreetmap.org/{z}/{x}/{y}.png'
	],
	tileSize: 256
	}
	},
	layers: [{
	id: 'osm-tiles',
	type: 'raster',
	source: 'osm-tiles',
	minzoom: 0,
	maxzoom: 22
	}]
	};
	beforeEach(function() {
	gd = createGraphDiv();
	Plotly.setPlotConfig({
	mapboxAccessToken: null
	});
	});
	afterEach(function() {
	Plotly.purge(gd);
	destroyGraphDiv();
	Plotly.setPlotConfig({
	mapboxAccessToken: MAPBOX_ACCESS_TOKEN
	});
	});
	it('@gl should throw error if token is not registered', function() {
	spyOn(Lib, 'error');
	expect(function() {
	Plotly.plot(gd, [{
	type: 'scattermapbox',
	lon: [10, 20, 30],
	lat: [10, 20, 30]
	}]);
	}).toThrow(new Error(constants.noAccessTokenErrorMsg));
	expect(Lib.error).toHaveBeenCalledWith('Uses Mapbox map style, but did not set an access token.');
	}, LONG_TIMEOUT_INTERVAL);
	it('@gl should throw error if token is invalid', function(done) {
	var cnt = 0;
	Plotly.plot(gd, [{
	type: 'scattermapbox',
	lon: [10, 20, 30],
	lat: [10, 20, 30]
	}], {}, {
	mapboxAccessToken: dummyToken
	})
	.catch(function(err) {
	cnt++;
	expect(err).toEqual(new Error(constants.mapOnErrorMsg));
	})
	.then(function() {
	expect(cnt).toEqual(1);
	done();
	});
	}, LONG_TIMEOUT_INTERVAL);
	it('@gl should use access token in mapbox layout options if present', function(done) {
	var cnt = 0;
	Plotly.plot(gd, [{
	type: 'scattermapbox',
	lon: [10, 20, 30],
	lat: [10, 20, 30]
	}], {
	mapbox: {
	accesstoken: MAPBOX_ACCESS_TOKEN
	}
	}, {
	mapboxAccessToken: dummyToken
	}).catch(function() {
	cnt++;
	}).then(function() {
	expect(cnt).toEqual(0);
	expect(gd._fullLayout.mapbox.accesstoken).toEqual(MAPBOX_ACCESS_TOKEN);
	done();
	});
	}, LONG_TIMEOUT_INTERVAL);
	it('@gl should warn when multiple tokens in mapbox layout options are present', function(done) {
	spyOn(Lib, 'warn');
	var cnt = 0;
	Plotly.plot(gd, [{
	type: 'scattermapbox',
	lon: [10, 20, 30],
	lat: [10, 20, 30]
	}, {
	type: 'scattermapbox',
	lon: [10, 20, 30],
	lat: [10, 20, 30],
	subplot: 'mapbox2'
	}], {
	mapbox: { accesstoken: MAPBOX_ACCESS_TOKEN },
	mapbox2: { accesstoken: dummyToken }
	}).catch(function() {
	cnt++;
	}).then(function() {
	expect(cnt).toEqual(0);
	expect(gd._fullLayout.mapbox.accesstoken).toEqual(MAPBOX_ACCESS_TOKEN);
	expect(Lib.warn).toHaveBeenCalledWith(constants.multipleTokensErrorMsg);
	done();
	});
	}, LONG_TIMEOUT_INTERVAL);
	it('@gl should not throw when using a custom non-mapbox style', function(done) {
	var cnt = 0;
	Plotly.plot(gd, [{
	type: 'scattermapbox',
	lon: [10, 20, 30],
	lat: [10, 20, 30]
	}], {
	mapbox: { style: osmStyle }
	}).catch(function() {
	cnt++;
	}).then(function() {
	expect(cnt).toEqual(0);
	expect(gd._fullLayout.mapbox.accesstoken).toBe(undefined);
	done();
	});
	}, LONG_TIMEOUT_INTERVAL);
	it('@gl should log when an access token is set while using a custom non-mapbox style', function(done) {
	spyOn(Lib, 'log');
	var cnt = 0;
	Plotly.plot(gd, [{
	type: 'scattermapbox',
	lon: [10, 20, 30],
	lat: [10, 20, 30]
	}], {
	mapbox: {
	style: osmStyle,
	accesstoken: MAPBOX_ACCESS_TOKEN
	}
	}).catch(function() {
	cnt++;
	}).then(function() {
	expect(cnt).toEqual(0);
	expect(Lib.log).toHaveBeenCalledWith([
	'Listed mapbox access token(s)',
	MAPBOX_ACCESS_TOKEN,
	'but did not use a Mapbox map style, ignoring token(s).'
	].join(' '));
	done();
	});
	}, LONG_TIMEOUT_INTERVAL);
	it('@gl should bypass access token in mapbox layout options when config points to an Atlas server', function(done) {
	var cnt = 0;
	var msg = [
	'An API access token is required to use Mapbox GL.',
	'See https://www.mapbox.com/api-documentation/#access-tokens-and-token-scopes'
	].join(' ');
	// TODO potential new way of doing this:
	// https://github.com/mapbox/mapbox-gl-js/pull/7594
	//
	// https://www.mapbox.com/atlas/#developing-with-atlas
	Plotly.plot(gd, [{
	type: 'scattermapbox',
	lon: [10, 20, 30],
	lat: [10, 20, 30]
	}], {
	mapbox: {
	accesstoken: MAPBOX_ACCESS_TOKEN
	}
	}, {
	mapboxAccessToken: ''
	})
	.catch(function(err) {
	cnt++;
	// Note that we get an error here on `new mapboxgl.Map`
	// as we don't have an Atlas server running.
	//
	// In essence, we test that the `new mapboxgl.Map` throws
	// as oppose to `findAccessToken`
	expect(err).toEqual(new Error(msg));
	})
	.then(function() {
	expect(cnt).toEqual(1);
	done();
	});
	}, LONG_TIMEOUT_INTERVAL);
	});

In brief,

• we log "Uses Mapbox map style, but did not set an access token" when trying to plot a mapbox base style w/o having set a token, and throw an error
• we throw an error, when a set access token is invalid
• We log "Listed mapbox access token(s) MAPBOX_ACCESS_TOKEN but did not use a Mapbox map style, ignoring token(s)." when a token is set for a non-Mapbox-server-style map.

[etpinard]

@nicolaskruchten I assume you want this for 1.49.0?

[nicolaskruchten]

yes for 1.49 unless the LOE is huge.

[etpinard]

OK, I'll push this as part of #4035