385 lines
20 KiB
JavaScript
385 lines
20 KiB
JavaScript
// API source route registration.
|
|
|
|
const { buildPagination } = require('../../../lib/pagination');
|
|
const renderApiSourcesPage = require('./list');
|
|
const renderApiSourceAddPage = require('./add');
|
|
const renderApiSourceEditPage = require('./edit');
|
|
const { buildDuplicateApiSourceName, buildDuplicateApiSource } = require('./duplicate');
|
|
const { fetchAppSettings } = require('#src/data/app-settings');
|
|
|
|
function toIsoTimestamp(value) {
|
|
if (!value) {
|
|
return '';
|
|
}
|
|
|
|
const date = new Date(value);
|
|
return Number.isNaN(date.getTime()) ? '' : date.toISOString();
|
|
}
|
|
|
|
async function getDataSourceUsageMaps(pool, common) {
|
|
const [slides] = await pool.query('SELECT content_json FROM c_slides WHERE content_json IS NOT NULL');
|
|
const apiSourceIds = new Set();
|
|
|
|
for (let index = 0; index < slides.length; index += 1) {
|
|
const content = typeof common.parseJsonSafe === 'function' ? common.parseJsonSafe(slides[index].content_json) : null;
|
|
if (!content || typeof content !== 'object') {
|
|
continue;
|
|
}
|
|
|
|
(function walk(value) {
|
|
if (!value || typeof value !== 'object') {
|
|
return;
|
|
}
|
|
|
|
if (Array.isArray(value)) {
|
|
value.forEach(walk);
|
|
return;
|
|
}
|
|
|
|
if (Object.prototype.hasOwnProperty.call(value, 'source_id')) {
|
|
const sourceId = Number(value.source_id);
|
|
if (Number.isFinite(sourceId)) {
|
|
apiSourceIds.add(sourceId);
|
|
}
|
|
}
|
|
|
|
Object.keys(value).forEach(function (key) {
|
|
walk(value[key]);
|
|
});
|
|
})(content);
|
|
}
|
|
|
|
return apiSourceIds;
|
|
}
|
|
|
|
async function isApiSourceInUse(pool, common, apiSourceId) {
|
|
const usageIds = await getDataSourceUsageMaps(pool, common);
|
|
return usageIds.has(Number(apiSourceId));
|
|
}
|
|
|
|
async function sendRefreshTaskState(req, res, dataSourceTasks, sourceId) {
|
|
const taskId = Number(req.query.refresh_task_id);
|
|
if (!Number.isFinite(taskId) || taskId <= 0) {
|
|
return res.status(400).json({ error: 'Missing refresh task id.' });
|
|
}
|
|
|
|
const task = await dataSourceTasks.getTaskStatusById(taskId);
|
|
const expectedKey = 'api-source-refresh:' + Number(sourceId);
|
|
if (!task || task.key !== expectedKey) {
|
|
return res.status(404).json({ error: 'Refresh task not found.' });
|
|
}
|
|
|
|
res.json(task);
|
|
}
|
|
|
|
module.exports = function registerApiSourceRoutes(app, deps) {
|
|
const pool = deps.pool;
|
|
const common = deps.common;
|
|
const pages = deps.pages;
|
|
const backgroundTaskQueue = deps.backgroundTaskQueue;
|
|
const dataSourceTasks = deps.dataSourceTasks;
|
|
const getAuditUserId = deps.getAuditUserId;
|
|
const redirectAfterSave = deps.redirectAfterSave;
|
|
const formatDashboardDate = deps.formatDashboardDate || function (value) {
|
|
return value ? String(value) : '';
|
|
};
|
|
const requirePermission = deps.requirePermission;
|
|
|
|
const LIST_PAGE_SIZE = 25;
|
|
|
|
app.get('/data-sources/api-sources', requirePermission('api-sources.read'), async function (req, res, next) {
|
|
try {
|
|
const page = Math.max(1, Math.floor(Number(req.query.page) || 1));
|
|
const search = common.getSearchQuery(req);
|
|
const sort = common.getSortQuery(req);
|
|
const direction = common.getSortDirectionQuery(req);
|
|
const data = await common.fetchApiSourcesPage(pool, page, LIST_PAGE_SIZE, search, sort, direction);
|
|
const usageIds = await getDataSourceUsageMaps(pool, common);
|
|
const apiSources = (data.apiSources || []).map(function (apiSource) {
|
|
return Object.assign({}, apiSource, {
|
|
authMethod: apiSource.auth_method || 'none',
|
|
authUsername: apiSource.auth_username || '',
|
|
authPassword: apiSource.auth_password || '',
|
|
authBearerToken: apiSource.auth_bearer_token || '',
|
|
authHeaderName: apiSource.auth_header_name || 'X-API-Key',
|
|
authHeaderValue: apiSource.auth_header_value || '',
|
|
tokenUrl: apiSource.token_url || '',
|
|
tokenResponsePath: apiSource.token_response_path || 'access_token',
|
|
tokenRefreshUrl: apiSource.token_refresh_url || '',
|
|
tokenRefreshRequestBodyJson: apiSource.token_refresh_request_body_json || '',
|
|
tokenRefreshResponsePath: apiSource.token_refresh_response_path || 'refresh_token',
|
|
itemsPath: apiSource.items_path || '',
|
|
intervalLabel: apiSource.update_interval_unit === 'seconds'
|
|
? (Math.max(1, Number(apiSource.update_interval_value) || 0) === 1 ? 'Every second' : `Every ${Math.max(1, Number(apiSource.update_interval_value) || 0)} seconds`)
|
|
: apiSource.update_interval_unit === 'hours'
|
|
? (Math.max(1, Number(apiSource.update_interval_value) || 0) === 1 ? 'Every hour' : `Every ${Math.max(1, Number(apiSource.update_interval_value) || 0)} hours`)
|
|
: (Math.max(1, Number(apiSource.update_interval_value) || 0) === 1 ? 'Every minute' : `Every ${Math.max(1, Number(apiSource.update_interval_value) || 0)} minutes`),
|
|
lastPullLabel: apiSource.last_pulled_at ? formatDashboardDate(apiSource.last_pulled_at) : 'Never',
|
|
lastPulledAtValue: apiSource.last_pulled_at ? new Date(apiSource.last_pulled_at).toISOString() : '',
|
|
inUse: usageIds.has(Number(apiSource.id))
|
|
});
|
|
});
|
|
|
|
res.send(renderApiSourcesPage({
|
|
apiSources: apiSources,
|
|
pagination: buildPagination(data.totalItems, data.currentPage, 'page', { search: search, sort: sort, direction: direction }, LIST_PAGE_SIZE, 'API sources', 'API source pages')
|
|
}, req.query.message ? String(req.query.message) : '', req.currentUser, formatDashboardDate));
|
|
} catch (error) {
|
|
next(error);
|
|
}
|
|
});
|
|
|
|
app.get('/data-sources/api-sources/new', requirePermission('api-sources.create'), async function (req, res, next) {
|
|
try {
|
|
const settings = await fetchAppSettings(pool);
|
|
res.send(renderApiSourceAddPage({
|
|
updateIntervalValue: settings['data-sources.api_default_interval_value'],
|
|
updateIntervalUnit: settings['data-sources.api_default_interval_unit']
|
|
}, req.query.message ? String(req.query.message) : '', req.currentUser));
|
|
} catch (error) {
|
|
next(error);
|
|
}
|
|
});
|
|
|
|
app.get('/data-sources/api-sources/:id/edit', requirePermission('api-sources.update'), async function (req, res, next) {
|
|
try {
|
|
const apiSource = await common.fetchApiSourceById(pool, Number(req.params.id));
|
|
if (!apiSource) {
|
|
return res.status(404).send('API source not found');
|
|
}
|
|
|
|
const [slides] = await pool.query('SELECT content_json FROM c_slides WHERE content_json IS NOT NULL');
|
|
const inUse = (slides || []).some(function (row) {
|
|
const content = typeof common.parseJsonSafe === 'function' ? common.parseJsonSafe(row.content_json) : null;
|
|
if (!content || typeof content !== 'object') {
|
|
return false;
|
|
}
|
|
|
|
const stack = [content];
|
|
while (stack.length) {
|
|
const value = stack.pop();
|
|
if (!value || typeof value !== 'object') {
|
|
continue;
|
|
}
|
|
if (Array.isArray(value)) {
|
|
value.forEach(function (item) { stack.push(item); });
|
|
continue;
|
|
}
|
|
if (Object.prototype.hasOwnProperty.call(value, 'source_id') && Number(value.source_id) === Number(apiSource.id)) {
|
|
return true;
|
|
}
|
|
Object.keys(value).forEach(function (key) {
|
|
stack.push(value[key]);
|
|
});
|
|
}
|
|
return false;
|
|
});
|
|
|
|
res.send(renderApiSourceEditPage(Object.assign({}, apiSource, {
|
|
apiUrl: apiSource.api_url,
|
|
authMethod: apiSource.auth_method || 'none',
|
|
authUsername: apiSource.auth_username || '',
|
|
authPassword: apiSource.auth_password || '',
|
|
authBearerToken: apiSource.auth_bearer_token || '',
|
|
authHeaderName: apiSource.auth_header_name || 'X-API-Key',
|
|
authHeaderValue: apiSource.auth_header_value || '',
|
|
tokenUrl: apiSource.token_url || '',
|
|
tokenRequestBodyJson: apiSource.token_request_body_json || '',
|
|
tokenResponsePath: apiSource.token_response_path || 'access_token',
|
|
tokenRefreshUrl: apiSource.token_refresh_url || '',
|
|
tokenRefreshRequestBodyJson: apiSource.token_refresh_request_body_json || '',
|
|
tokenRefreshResponsePath: apiSource.token_refresh_response_path || 'refresh_token',
|
|
tokenHeaderName: apiSource.token_header_name || 'Authorization',
|
|
tokenHeaderPrefix: apiSource.token_header_prefix || 'Bearer',
|
|
itemsPath: apiSource.items_path || '',
|
|
updateIntervalValue: apiSource.update_interval_value,
|
|
updateIntervalUnit: apiSource.update_interval_unit || 'minutes',
|
|
lastPulledAtValue: toIsoTimestamp(apiSource.last_pulled_at),
|
|
lastPulledAtLabel: apiSource.last_pulled_at ? String(apiSource.last_pulled_at) : '',
|
|
lastPullError: apiSource.last_pull_error || '',
|
|
lastResponseStatus: apiSource.last_response_status,
|
|
lastResponseContentType: apiSource.last_response_content_type,
|
|
lastResponseJson: apiSource.last_response_json || '',
|
|
inUse: inUse
|
|
}), {
|
|
lastResponseJson: apiSource.last_response_json || '',
|
|
lastPullError: apiSource.last_pull_error || ''
|
|
}, req.query.message ? String(req.query.message) : '', req.currentUser));
|
|
} catch (error) {
|
|
next(error);
|
|
}
|
|
});
|
|
|
|
app.get('/data-sources/api-sources/:id/duplicate', requirePermission('api-sources.read'), requirePermission('api-sources.create'), async function (req, res, next) {
|
|
try {
|
|
const apiSource = await common.fetchApiSourceById(pool, Number(req.params.id));
|
|
if (!apiSource) {
|
|
return res.status(404).send('API source not found');
|
|
}
|
|
|
|
let duplicateName = buildDuplicateApiSourceName(apiSource.name);
|
|
let duplicateIndex = 2;
|
|
while (await common.fetchDuplicateName(pool, 'i_api_sources', duplicateName)) {
|
|
duplicateName = buildDuplicateApiSourceName(apiSource.name) + ' (' + duplicateIndex + ')';
|
|
duplicateIndex += 1;
|
|
}
|
|
|
|
res.send(renderApiSourceAddPage(buildDuplicateApiSource(apiSource, duplicateName), req.query.message ? String(req.query.message) : 'Review the copied values and save when ready.', req.currentUser, {
|
|
messageVariant: 'info',
|
|
showSaveSecondaryActions: true
|
|
}));
|
|
} catch (error) {
|
|
next(error);
|
|
}
|
|
});
|
|
|
|
app.get('/data-sources/api-sources/:id/state', requirePermission('api-sources.update'), function (req, res, next) {
|
|
sendRefreshTaskState(req, res, dataSourceTasks, Number(req.params.id)).catch(next);
|
|
});
|
|
|
|
app.post('/data-sources/api-sources', requirePermission('api-sources.create'), async function (req, res, next) {
|
|
const connection = await pool.getConnection();
|
|
try {
|
|
const payload = common.buildApiSourcePayload(req, null);
|
|
if (await common.fetchDuplicateName(pool, 'i_api_sources', payload.name)) {
|
|
return res.redirect('/data-sources/api-sources/new?message=' + encodeURIComponent('An API source with that name already exists.'));
|
|
}
|
|
|
|
const actorId = getAuditUserId(req);
|
|
await connection.beginTransaction();
|
|
const [result] = await connection.query(
|
|
'INSERT INTO i_api_sources (name, api_url, request_method, request_body_json, auth_method, auth_username, auth_password, auth_bearer_token, auth_header_name, auth_header_value, token_url, token_request_body_json, token_response_path, token_refresh_url, token_refresh_request_body_json, token_refresh_response_path, token_header_name, token_header_prefix, items_path, update_interval_value, update_interval_unit, last_pulled_at, last_pull_error, last_response_status, last_response_content_type, last_response_json, created_by, modified_by) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)',
|
|
[payload.name, payload.apiUrl, payload.requestMethod, payload.requestBodyJson || null, payload.authMethod, payload.authUsername || null, payload.authPassword || null, payload.authBearerToken || null, payload.authHeaderName || null, payload.authHeaderValue || null, payload.tokenUrl || null, payload.tokenRequestBodyJson || null, payload.tokenResponsePath || null, payload.tokenRefreshUrl || null, payload.tokenRefreshRequestBodyJson || null, payload.tokenRefreshResponsePath || null, payload.tokenHeaderName || null, payload.tokenHeaderPrefix || null, payload.itemsPath || null, payload.updateIntervalValue, payload.updateIntervalUnit, null, null, null, null, null, actorId, actorId]
|
|
);
|
|
await connection.commit();
|
|
dataSourceTasks.registerRecurringRefresh('api-source', result.insertId, payload.name, payload.updateIntervalValue, payload.updateIntervalUnit, function () {
|
|
return dataSourceTasks.refreshApiSourceInBackground(result.insertId, actorId);
|
|
});
|
|
const refreshTask = await backgroundTaskQueue.enqueueTask({
|
|
key: 'api-source-refresh:' + result.insertId,
|
|
title: 'API source refresh',
|
|
category: 'data-source',
|
|
taskType: 'data-source-refresh',
|
|
payload: {
|
|
sourceType: 'api-source',
|
|
sourceId: result.insertId,
|
|
sourceName: payload.name,
|
|
actorId: actorId
|
|
},
|
|
metadata: {
|
|
sourceType: 'api-source',
|
|
sourceId: result.insertId,
|
|
sourceName: payload.name
|
|
}
|
|
});
|
|
const message = 'API source created. Refresh is running in the background.';
|
|
res.redirect('/data-sources/api-sources/' + result.insertId + '/edit?message=' + encodeURIComponent(message) + '&refresh_task_id=' + encodeURIComponent(refreshTask && refreshTask.id ? refreshTask.id : ''));
|
|
} catch (error) {
|
|
try {
|
|
await connection.rollback();
|
|
} catch (_rollbackError) {
|
|
// Ignore rollback failures and surface the original error.
|
|
}
|
|
next(error);
|
|
} finally {
|
|
connection.release();
|
|
}
|
|
});
|
|
|
|
app.post('/data-sources/api-sources/:id', requirePermission('api-sources.update'), async function (req, res, next) {
|
|
const connection = await pool.getConnection();
|
|
try {
|
|
const apiSource = await common.fetchApiSourceById(pool, Number(req.params.id));
|
|
if (!apiSource) {
|
|
return res.status(404).send('API source not found');
|
|
}
|
|
|
|
if (String(req.body && req.body.data_source_action || '').trim() === 'toggle') {
|
|
const enabled = apiSource.enabled === 0 || apiSource.enabled === false ? 1 : 0;
|
|
await connection.query('UPDATE i_api_sources SET enabled = ?, modified_by = ? WHERE id = ?', [enabled, getAuditUserId(req), apiSource.id]);
|
|
if (enabled) {
|
|
dataSourceTasks.registerRecurringRefresh('api-source', apiSource.id, apiSource.name, apiSource.update_interval_value, apiSource.update_interval_unit, function () {
|
|
return dataSourceTasks.refreshApiSourceInBackground(apiSource.id, getAuditUserId(req));
|
|
});
|
|
} else {
|
|
dataSourceTasks.removeRecurringRefresh('api-source', apiSource.id);
|
|
}
|
|
return res.redirect('/data-sources/api-sources/' + apiSource.id + '/edit?message=' + encodeURIComponent(enabled ? 'API source enabled.' : 'API source disabled.'));
|
|
}
|
|
|
|
const payload = common.buildApiSourcePayload(req, apiSource);
|
|
if (await common.fetchDuplicateName(pool, 'i_api_sources', payload.name, apiSource.id)) {
|
|
return res.redirect('/data-sources/api-sources/' + apiSource.id + '/edit?message=' + encodeURIComponent('An API source with that name already exists.'));
|
|
}
|
|
const actorId = getAuditUserId(req);
|
|
await connection.beginTransaction();
|
|
await connection.query(
|
|
'UPDATE i_api_sources SET name = ?, api_url = ?, request_method = ?, request_body_json = ?, auth_method = ?, auth_username = ?, auth_password = ?, auth_bearer_token = ?, auth_header_name = ?, auth_header_value = ?, token_url = ?, token_request_body_json = ?, token_response_path = ?, token_refresh_url = ?, token_refresh_request_body_json = ?, token_refresh_response_path = ?, token_header_name = ?, token_header_prefix = ?, items_path = ?, update_interval_value = ?, update_interval_unit = ?, modified_by = ? WHERE id = ?',
|
|
[payload.name, payload.apiUrl, payload.requestMethod, payload.requestBodyJson || null, payload.authMethod, payload.authUsername || null, payload.authPassword || null, payload.authBearerToken || null, payload.authHeaderName || null, payload.authHeaderValue || null, payload.tokenUrl || null, payload.tokenRequestBodyJson || null, payload.tokenResponsePath || null, payload.tokenRefreshUrl || null, payload.tokenRefreshRequestBodyJson || null, payload.tokenRefreshResponsePath || null, payload.tokenHeaderName || null, payload.tokenHeaderPrefix || null, payload.itemsPath || null, payload.updateIntervalValue, payload.updateIntervalUnit, actorId, apiSource.id]
|
|
);
|
|
await connection.commit();
|
|
if (apiSource.enabled === 0 || apiSource.enabled === false) {
|
|
dataSourceTasks.removeRecurringRefresh('api-source', apiSource.id);
|
|
} else {
|
|
dataSourceTasks.registerRecurringRefresh('api-source', apiSource.id, payload.name, payload.updateIntervalValue, payload.updateIntervalUnit, function () {
|
|
return dataSourceTasks.refreshApiSourceInBackground(apiSource.id, actorId);
|
|
});
|
|
}
|
|
redirectAfterSave(req, res, '/data-sources/api-sources/' + apiSource.id + '/edit', {
|
|
closeUrl: '/data-sources/api-sources',
|
|
newUrl: '/data-sources/api-sources/new',
|
|
message: 'API source updated.'
|
|
});
|
|
} catch (error) {
|
|
try {
|
|
await connection.rollback();
|
|
} catch (_rollbackError) {
|
|
// Ignore rollback failures and surface the original error.
|
|
}
|
|
next(error);
|
|
} finally {
|
|
connection.release();
|
|
}
|
|
});
|
|
|
|
app.post('/data-sources/api-sources/:id/refresh', requirePermission('api-sources.allow'), async function (req, res, next) {
|
|
try {
|
|
const apiSource = await common.fetchApiSourceById(pool, Number(req.params.id));
|
|
if (!apiSource) return res.status(404).send('API source not found');
|
|
if (apiSource.enabled === 0 || apiSource.enabled === false) {
|
|
return res.redirect('/data-sources/api-sources/' + apiSource.id + '/edit?message=' + encodeURIComponent('API source is disabled.'));
|
|
}
|
|
await backgroundTaskQueue.enqueueTask({ key: 'api-source-refresh:' + apiSource.id, title: 'API source refresh', category: 'data-source', taskType: 'data-source-refresh', payload: { sourceType: 'api-source', sourceId: apiSource.id, sourceName: apiSource.name, actorId: getAuditUserId(req) }, metadata: { sourceType: 'api-source', sourceId: apiSource.id, sourceName: apiSource.name } });
|
|
res.redirect('/data-sources/api-sources/' + apiSource.id + '/edit?message=' + encodeURIComponent('API source refresh queued.'));
|
|
} catch (error) { next(error); }
|
|
});
|
|
|
|
app.post('/data-sources/api-sources/:id/delete', requirePermission('api-sources.delete'), async function (req, res, next) {
|
|
try {
|
|
const apiSource = await common.fetchApiSourceById(pool, Number(req.params.id));
|
|
if (!apiSource) {
|
|
return res.status(404).send('API source not found');
|
|
}
|
|
|
|
if (await isApiSourceInUse(pool, common, apiSource.id)) {
|
|
return res.redirect('/data-sources/api-sources?message=' + encodeURIComponent('This API source is still used by one or more slides.'));
|
|
}
|
|
|
|
const connection = await pool.getConnection();
|
|
try {
|
|
await connection.beginTransaction();
|
|
await connection.query('DELETE FROM i_api_sources WHERE id = ?', [apiSource.id]);
|
|
await connection.commit();
|
|
dataSourceTasks.removeRecurringRefresh('api-source', apiSource.id);
|
|
} catch (error) {
|
|
await connection.rollback();
|
|
throw error;
|
|
} finally {
|
|
connection.release();
|
|
}
|
|
res.redirect('/data-sources/api-sources?message=' + encodeURIComponent('API source deleted.'));
|
|
} catch (error) {
|
|
next(error);
|
|
}
|
|
});
|
|
}; |