Move config validation to Util
This commit is contained in:
James Lyne
parent
e5c5d03c72
commit
eb6674e106
106
src/api.ts
106
src/api.ts
@ -30,14 +30,12 @@ import {
|
||||
DynmapTileUpdate,
|
||||
DynmapUpdate,
|
||||
DynmapUpdateResponse,
|
||||
DynmapUpdates, DynmapUrlConfig,
|
||||
DynmapUpdates,
|
||||
DynmapWorld,
|
||||
DynmapWorldMap
|
||||
} from "@/dynmap";
|
||||
import {useStore} from "@/store";
|
||||
import ChatError from "@/errors/ChatError";
|
||||
import {LiveAtlasDynmapServerDefinition, LiveAtlasServerDefinition} from "@/index";
|
||||
import ConfigurationError from "@/errors/ConfigurationError";
|
||||
|
||||
const titleColours = /§[0-9a-f]/ig;
|
||||
|
||||
@ -556,96 +554,6 @@ function buildUpdates(data: Array<any>): DynmapUpdates {
|
||||
return updates;
|
||||
}
|
||||
|
||||
const validateLiveAtlasConfiguration = (config: any): Map<string, LiveAtlasServerDefinition> => {
|
||||
const check = '\nCheck your server configuration in index.html is correct.',
|
||||
result = new Map<string, LiveAtlasServerDefinition>();
|
||||
|
||||
if (!Object.keys(config).length) {
|
||||
throw new ConfigurationError(`No servers defined. ${check}`);
|
||||
}
|
||||
|
||||
for (const server in config) {
|
||||
if (!Object.hasOwnProperty.call(config, server)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const serverConfig = config[server];
|
||||
|
||||
if (!serverConfig || serverConfig.constructor !== Object || !Object.keys(serverConfig).length) {
|
||||
throw new ConfigurationError(`Server '${server}': Configuration missing. ${check}`);
|
||||
}
|
||||
|
||||
serverConfig.id = server;
|
||||
serverConfig.type = 'dynmap';
|
||||
|
||||
if (!serverConfig.dynmap || serverConfig.dynmap.constructor !== Object) {
|
||||
throw new ConfigurationError(`Server '${server}': Dynmap configuration object missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!serverConfig.dynmap.configuration) {
|
||||
throw new ConfigurationError(`Server '${server}': Dynmap configuration URL missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!serverConfig.dynmap.update) {
|
||||
throw new ConfigurationError(`Server '${server}': Dynmap update URL missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!serverConfig.dynmap.markers) {
|
||||
throw new ConfigurationError(`Server '${server}': Dynmap markers URL missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!serverConfig.dynmap.tiles) {
|
||||
throw new ConfigurationError(`Server '${server}': Dynmap tiles URL missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!serverConfig.dynmap.sendmessage) {
|
||||
throw new ConfigurationError(`Server '${server}': Dynmap sendmessage URL missing. ${check}`);
|
||||
}
|
||||
|
||||
result.set(server, serverConfig);
|
||||
}
|
||||
|
||||
return result;
|
||||
};
|
||||
|
||||
const validateDynmapConfiguration = (config: DynmapUrlConfig): Map<string, LiveAtlasDynmapServerDefinition> => {
|
||||
const check = '\nCheck your standalone/config.js file exists and is being loaded correctly.';
|
||||
|
||||
if (!config) {
|
||||
throw new ConfigurationError(`Dynmap configuration is missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!config.configuration) {
|
||||
throw new ConfigurationError(`Dynmap configuration URL is missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!config.update) {
|
||||
throw new ConfigurationError(`Dynmap update URL is missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!config.markers) {
|
||||
throw new ConfigurationError(`Dynmap markers URL is missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!config.tiles) {
|
||||
throw new ConfigurationError(`Dynmap tiles URL is missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!config.sendmessage) {
|
||||
throw new ConfigurationError(`Dynmap sendmessage URL is missing. ${check}`);
|
||||
}
|
||||
|
||||
const result = new Map<string, LiveAtlasDynmapServerDefinition>();
|
||||
result.set('dynmap', {
|
||||
id: 'dynmap',
|
||||
label: 'dynmap',
|
||||
type: 'dynmap',
|
||||
dynmap: config
|
||||
});
|
||||
|
||||
return result;
|
||||
};
|
||||
|
||||
async function fetchJSON(url: string, signal: AbortSignal) {
|
||||
let response, json;
|
||||
|
||||
@ -685,18 +593,6 @@ let configurationAbort: AbortController | undefined = undefined,
|
||||
updateAbort: AbortController | undefined = undefined;
|
||||
|
||||
export default {
|
||||
validateConfiguration(): Map<string, LiveAtlasServerDefinition> {
|
||||
if (!window.liveAtlasConfig) {
|
||||
throw new ConfigurationError(`Configuration object is missing`);
|
||||
}
|
||||
|
||||
if (typeof window.liveAtlasConfig.servers !== 'undefined') {
|
||||
return validateLiveAtlasConfiguration(window.liveAtlasConfig.servers || {});
|
||||
}
|
||||
|
||||
return validateDynmapConfiguration(window.config?.url || null);
|
||||
},
|
||||
|
||||
async getConfiguration(): Promise<DynmapConfigurationResponse> {
|
||||
if(configurationAbort) {
|
||||
configurationAbort.abort();
|
||||
|
||||
@ -15,14 +15,14 @@
|
||||
*/
|
||||
|
||||
import { createApp } from 'vue'
|
||||
import App from './App.vue'
|
||||
import API from './api';
|
||||
import App from './App.vue';
|
||||
import {store} from "@/store";
|
||||
|
||||
import 'leaflet/dist/leaflet.css';
|
||||
import 'normalize-scss/sass/normalize/_import-now.scss';
|
||||
import '@/scss/style.scss';
|
||||
import {MutationTypes} from "@/store/mutation-types";
|
||||
import {validateConfiguration} from "@/util";
|
||||
|
||||
const splash = document.getElementById('splash'),
|
||||
splashSpinner = document.getElementById('splash__spinner'),
|
||||
@ -86,7 +86,7 @@ window.showSplashError = function(message: string, fatal: boolean, attempts: num
|
||||
console.info(`LiveAtlas version ${store.state.version} - https://github.com/JLyne/LiveAtlas`);
|
||||
|
||||
try {
|
||||
const config = API.validateConfiguration();
|
||||
const config = validateConfiguration();
|
||||
|
||||
store.commit(MutationTypes.SET_SERVERS, config);
|
||||
|
||||
|
||||
115
src/util.ts
115
src/util.ts
@ -16,6 +16,8 @@
|
||||
|
||||
import {DynmapPlayer} from "@/dynmap";
|
||||
import {useStore} from "@/store";
|
||||
import {LiveAtlasDynmapServerDefinition, LiveAtlasServerDefinition} from "@/index";
|
||||
import ConfigurationError from "@/errors/ConfigurationError";
|
||||
|
||||
interface HeadQueueEntry {
|
||||
cacheKey: string;
|
||||
@ -202,3 +204,116 @@ export const parseMapSearchParams = (query: URLSearchParams) => {
|
||||
legacy: true,
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
const validateLiveAtlasConfiguration = (config: any): Map<string, LiveAtlasServerDefinition> => {
|
||||
const check = '\nCheck your server configuration in index.html is correct.',
|
||||
result = new Map<string, LiveAtlasServerDefinition>();
|
||||
|
||||
if (!Object.keys(config).length) {
|
||||
throw new ConfigurationError(`No servers defined. ${check}`);
|
||||
}
|
||||
|
||||
for (const server in config) {
|
||||
if (!Object.hasOwnProperty.call(config, server)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const serverConfig = config[server];
|
||||
|
||||
if (!serverConfig || serverConfig.constructor !== Object || !Object.keys(serverConfig).length) {
|
||||
throw new ConfigurationError(`Server '${server}': Configuration missing. ${check}`);
|
||||
}
|
||||
|
||||
serverConfig.id = server;
|
||||
serverConfig.type = serverConfig.type || 'dynmap';
|
||||
|
||||
switch(serverConfig.type) {
|
||||
case 'dynmap':
|
||||
if (!serverConfig.dynmap || serverConfig.dynmap.constructor !== Object) {
|
||||
throw new ConfigurationError(`Server '${server}': Dynmap configuration object missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!serverConfig.dynmap.configuration) {
|
||||
throw new ConfigurationError(`Server '${server}': Dynmap configuration URL missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!serverConfig.dynmap.update) {
|
||||
throw new ConfigurationError(`Server '${server}': Dynmap update URL missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!serverConfig.dynmap.markers) {
|
||||
throw new ConfigurationError(`Server '${server}': Dynmap markers URL missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!serverConfig.dynmap.tiles) {
|
||||
throw new ConfigurationError(`Server '${server}': Dynmap tiles URL missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!serverConfig.dynmap.sendmessage) {
|
||||
throw new ConfigurationError(`Server '${server}': Dynmap sendmessage URL missing. ${check}`);
|
||||
}
|
||||
break;
|
||||
|
||||
case 'pl3xmap':
|
||||
case 'plexmap':
|
||||
if (!serverConfig.plexmap || serverConfig.plexmap.constructor !== Object) {
|
||||
throw new ConfigurationError(`Server '${server}': Pl3xmap configuration object missing. ${check}`);
|
||||
}
|
||||
}
|
||||
|
||||
result.set(server, serverConfig);
|
||||
}
|
||||
|
||||
return result;
|
||||
};
|
||||
|
||||
const validateDynmapConfiguration = (config: DynmapUrlConfig): Map<string, LiveAtlasDynmapServerDefinition> => {
|
||||
const check = '\nCheck your standalone/config.js file exists and is being loaded correctly.';
|
||||
|
||||
if (!config) {
|
||||
throw new ConfigurationError(`Dynmap configuration is missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!config.configuration) {
|
||||
throw new ConfigurationError(`Dynmap configuration URL is missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!config.update) {
|
||||
throw new ConfigurationError(`Dynmap update URL is missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!config.markers) {
|
||||
throw new ConfigurationError(`Dynmap markers URL is missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!config.tiles) {
|
||||
throw new ConfigurationError(`Dynmap tiles URL is missing. ${check}`);
|
||||
}
|
||||
|
||||
if (!config.sendmessage) {
|
||||
throw new ConfigurationError(`Dynmap sendmessage URL is missing. ${check}`);
|
||||
}
|
||||
|
||||
const result = new Map<string, LiveAtlasDynmapServerDefinition>();
|
||||
result.set('dynmap', {
|
||||
id: 'dynmap',
|
||||
label: 'dynmap',
|
||||
type: 'dynmap',
|
||||
dynmap: config
|
||||
});
|
||||
|
||||
return result;
|
||||
};
|
||||
|
||||
export const validateConfiguration = (): Map<string, LiveAtlasServerDefinition> => {
|
||||
if (!window.liveAtlasConfig) {
|
||||
throw new ConfigurationError(`Configuration object is missing`);
|
||||
}
|
||||
|
||||
if (typeof window.liveAtlasConfig.servers !== 'undefined') {
|
||||
return validateLiveAtlasConfiguration(window.liveAtlasConfig.servers || {});
|
||||
}
|
||||
|
||||
return validateDynmapConfiguration(window.config?.url || null);
|
||||
};
|
||||
|
||||
Loading…
Reference in New Issue
Block a user