This repository was archived by the owner on Aug 29, 2025. It is now read-only.

[WIP] upload scheduled query metadata#504

Merged
n-riesco merged 6 commits into from
Aug 3, 2018
Merged

[WIP] upload scheduled query metadata #504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
53e2869
remove setting of default refreshInterval from frontend
briandennis Jul 31, 2018
47d161d
add backend support for uploading metadata on create/update of queries
briandennis Jul 31, 2018
4f187b9
avoid throwing on null cronInterval in mapCronToRefresh
briandennis Aug 1, 2018
4bbfc6e
use mapCronToRefresh to set default refresh interval
briandennis Aug 2, 2018
e9f7a91
update jest tests to account for refreshInterval not being set by fro…
briandennis Aug 2, 2018
97dd563
add metadata specific error message
briandennis Aug 3, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions app/actions/sessions.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -166,7 +166,6 @@ export function createScheduledQuery(connectionId, payload = {}) {
fid: payload.fid,
filename: payload.filename,
name: payload.name,
refreshInterval: payload.refreshInterval,
query: payload.query,
cronInterval: payload.cronInterval,
connectionId
Expand All@@ -189,7 +188,6 @@ export function updateScheduledQuery(connectionId, payload = {}) {
fid: payload.fid,
filename: payload.filename,
name: payload.name,
refreshInterval: payload.refreshInterval,
query: payload.query,
cronInterval: payload.cronInterval,
connectionId
Expand Down
8 changes: 1 addition & 7 deletions app/components/Settings/scheduler/create-modal.jsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,12 +12,7 @@ import TimedMessage from './timed-message.jsx';
import CronPicker from '../cron-picker/cron-picker.jsx';
import SQL from './sql.jsx';

import {
getHighlightMode,
DEFAULT_REFRESH_INTERVAL,
WAITING_MESSAGE,
SAVE_WARNING
} from '../../../constants/constants.js';
import {getHighlightMode, WAITING_MESSAGE, SAVE_WARNING} from '../../../constants/constants.js';

import './create-modal.css';

Expand DownExpand Up@@ -109,7 +104,6 @@ class CreateModal extends Component {
this.props
.onSubmit({
query: this.state.code,
refreshInterval: DEFAULT_REFRESH_INTERVAL,
filename: generateFilename(),
cronInterval: this.state.interval,
name: this.state.name ? this.state.name.trim() : ''
Expand Down
12 changes: 3 additions & 9 deletions app/components/Settings/scheduler/preview-modal.jsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,7 @@ import CronPicker from '../cron-picker/cron-picker.jsx';
import {Row, Column} from '../../layout.jsx';
import SQL from './sql.jsx';
import {plotlyUrl} from '../../../utils/utils.js';
import {
getHighlightMode,
DEFAULT_REFRESH_INTERVAL,
WAITING_MESSAGE,
SAVE_WARNING
} from '../../../constants/constants.js';
import {getHighlightMode, WAITING_MESSAGE, SAVE_WARNING} from '../../../constants/constants.js';
import {getInitialCronMode} from '../cron-picker/cron-helpers.js';

const NO_OP = () => {};
Expand DownExpand Up@@ -85,7 +80,7 @@ export class PreviewModal extends Component {

onSubmit() {
if (this.state.editing) {
const {connectionId, fid, requestor, uids, refreshInterval} = this.props.query;
const {connectionId, fid, requestor, uids} = this.props.query;
const {code: query, cronInterval} = this.state;
const name = this.state.name ? this.state.name.trim() : '';

Expand All@@ -98,8 +93,7 @@ export class PreviewModal extends Component {
uids,
query,
name,
cronInterval,
refreshInterval: refreshInterval || DEFAULT_REFRESH_INTERVAL
cronInterval
})
.then(() => {
this.setState({
Expand Down
11 changes: 11 additions & 0 deletions app/components/Settings/scheduler/request-error.jsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,17 @@ function FormattedMessage(props) {
);
}

if (content.startsWith('MetadataError')) {
return (
<details style={outlineStyle}>
<summary style={outlineStyle}>
An unexpected error occurred while uploading query metadata. Please try again now.
</summary>
<pre>{capitalize(content.replace('MetadataError: ', ''))}</pre>
</details>
);
}

return content.slice(0, 100);
}

Expand Down
6 changes: 0 additions & 6 deletions app/constants/constants.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,12 +2,6 @@
/* eslint-disable no-multi-str */
import {concat} from 'ramda';

/**
* Default to '1 week' for `refreshInterval` for backwards compatability. For
* older versions this will prevent issues such as `setInterval(runQuery, NaN)`
*/
export const DEFAULT_REFRESH_INTERVAL = 7 * 24 * 60 * 60;

export const DIALECTS = {
MYSQL: 'mysql',
MARIADB: 'mariadb',
Expand Down
64 changes: 54 additions & 10 deletions backend/persistent/QueryScheduler.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import * as scheduler from 'node-schedule';

import {getConnectionById} from './Connections.js';
import * as Connections from './datastores/Datastores.js';
import { mapRefreshToCron } from '../utils/cronUtils.js';
import { mapRefreshToCron, mapCronToRefresh } from '../utils/cronUtils.js';
import Logger from '../logger';
import {
getQuery,
Expand All@@ -19,6 +19,7 @@ import {
getCurrentUser,
getGridMeta,
newGrid,
patchGrid,
updateGrid
} from './plotly-api.js';

Expand DownExpand Up@@ -97,7 +98,7 @@ class QueryScheduler {
requestor,
fid,
uids,
refreshInterval,
refreshInterval: refreshInterval || mapCronToRefresh(cronInterval),
cronInterval,
query,
connectionId
Expand DownExpand Up@@ -142,9 +143,11 @@ class QueryScheduler {
Object.keys(this.queryJobs).forEach(this.clearQuery);
}

queryAndCreateGrid(filename, query, connectionId, requestor) {
queryAndCreateGrid(filename, query, connectionId, requestor, cronInterval, refreshInterval) {
const {username, apiKey, accessToken} = getCredentials(requestor);
const formattedRefresh = refreshInterval || mapCronToRefresh(cronInterval);
let startTime;
let createdJson;

// Check if the user even exists
if (!username || !(apiKey || accessToken)) {
Expand DownExpand Up@@ -204,16 +207,38 @@ class QueryScheduler {
Logger.log(`Error ${res.status} while creating a grid`, 2);
}

return res.json().then((json) => {
Logger.log(`Grid ${json.file.fid} has been updated.`, 2);
return json;
return res.json();
}).then((json) => {
createdJson = json;
startTime = process.hrtime();

return patchGrid(
createdJson.file.fid,
requestor,
{
metadata: {
query,
connectionId,
connectorUrl: `https://${getSetting('CONNECTOR_HTTPS_DOMAIN')}:${getSetting('PORT_HTTPS')}`
},
refresh_interval: formattedRefresh
}
).catch((e) => {
/*
* Warning: The front end looks for "MetadataError" in this error message. Don't change it!
*/
throw new Error(`MetadataError: ${e.message}`);
});
}).then(() => {
Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);
Logger.log(`Grid ${createdJson.file.fid} has been updated.`, 2);
return createdJson;
});

}

queryAndUpdateGrid(fid, uids, query, connectionId, requestor) {
queryAndUpdateGrid(fid, uids, query, connectionId, requestor, cronInterval, refreshInterval) {
const requestedDBConnections = getConnectionById(connectionId);
const formattedRefresh = refreshInterval || mapCronToRefresh(cronInterval);
let startTime = process.hrtime();

/*
Expand DownExpand Up@@ -337,13 +362,32 @@ class QueryScheduler {

}

startTime = process.hrtime();

return patchGrid(
fid,
requestor,
{
metadata: {
query,
connectionId,
connectorUrl: `https://${getSetting('CONNECTOR_HTTPS_DOMAIN')}:${getSetting('PORT_HTTPS')}`
},
refresh_interval: formattedRefresh
}
).catch((e) => {
/*
* Warning: The front end looks for "MetadataError" in this error message. Don't change it!
*/
throw new Error(`MetadataError: ${e.message}`);
});
}).then((res) => {
Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);
return res.json().then(() => {
Logger.log(`Grid ${fid} has been updated.`, 2);
});
});

}

}

export default QueryScheduler;
Expand Down
12 changes: 12 additions & 0 deletions backend/persistent/plotly-api.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -152,6 +152,18 @@ export function deleteGrid(fid, requestor) {
});
}

export function patchGrid(fid, requestor, body) {
const {username, apiKey, accessToken} = getCredentials(requestor);

return plotlyAPIRequest(`grids/${fid}`, {
method: 'PATCH',
username,
apiKey,
accessToken,
body
});
}

export function updateGrid(rows, fid, uids, requestor) {
const {username, apiKey, accessToken} = getCredentials(requestor);

Expand Down
15 changes: 12 additions & 3 deletions backend/routes.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -664,13 +664,22 @@ export default class Servers {
* the endpoint `/queries/:fid`
*/
server.post('/queries', function postQueriesHandler(req, res, next) {
const {filename, fid, uids, query, connectionId, requestor} = req.params;
const {
filename,
fid,
uids,
query,
connectionId,
requestor,
cronInterval = null,

@n-riescon-riescoAug 1, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

out of curiosity, why setting the default to 'null'?

refreshInterval = null
} = req.params;

// If a filename has been provided,
// make the query and create a new grid
if (filename) {
return that.queryScheduler.queryAndCreateGrid(
filename, query, connectionId, requestor
filename, query, connectionId, requestor, cronInterval, refreshInterval
)
.then((newGridResponse) => {
const queryObject = {
Expand All@@ -691,7 +700,7 @@ export default class Servers {
if (fid) {
return checkWritePermissions(fid, requestor).then(function () {
return that.queryScheduler.queryAndUpdateGrid(
fid, uids, query, connectionId, requestor
fid, uids, query, connectionId, requestor, cronInterval, refreshInterval
);
})
.then(() => {
Expand Down
20 changes: 20 additions & 0 deletions backend/utils/cronUtils.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,26 @@ export function mapRefreshToCron (refreshInterval) {
return `${now.getMinutes()} ${now.getHours()} * * ${now.getDay()}`;
}

export function mapCronToRefresh (cronInterval) {
const DEFAULT_INTERVAL = 60 * 60 * 24 * 7; // default to weekly

if (!cronInterval) {
return DEFAULT_INTERVAL;
}

if (cronInterval === '* * * * *') {
return 60;
} else if (cronInterval === '*/5 * * * *') {
return 60 * 5;
} else if (cronInterval.match(/\S+? \* \* \* \*/)) {

@n-riescon-riescoAug 1, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this throws when cronInterval is null

return 60 * 60;
} else if (cronInterval.match(/\S+? \S+? \* \* \*/)) {
return 60 * 60 * 24;
}

return DEFAULT_INTERVAL;
}

function computeMinutes (now) {
let currMinute = now.getMinutes() % 5; // start at 5 min offset
const minutes = [];
Expand Down
3 changes: 0 additions & 3 deletions test/app/components/Settings/scheduler/create-modal.test.jsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ global.document.createRange = function() {

const wait = () => new Promise(resolve => setTimeout(resolve, 0));

const {DEFAULT_REFRESH_INTERVAL} = require('../../../../../app/constants/constants');
const CodeMirror = require('react-codemirror2').Controlled;
const CreateModal = require('../../../../../app/components/Settings/scheduler/create-modal.jsx');
const ErrorComponent = require('../../../../../app/components/error.jsx');
Expand DownExpand Up@@ -93,15 +92,13 @@ describe('Create Modal Test', () => {
// Once filename input is supported, this value should be: 'filename',
filename: expect.any(String),
query: 'SELECT * FROM foods',
refreshInterval: DEFAULT_REFRESH_INTERVAL,
cronInterval
})
);
expect(onSubmit).toHaveBeenCalledWith({
// Once filename input is supported, this value should be: 'filename',
filename: expect.any(String),
query: 'SELECT * FROM foods',
refreshInterval: DEFAULT_REFRESH_INTERVAL,
cronInterval,
name
});
Expand Down
5 changes: 1 addition & 4 deletions test/app/components/Settings/scheduler/preview-modal.jsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@ global.document.createRange = function() {
};

const PreviewModal = require('../../../../../app/components/Settings/scheduler/preview-modal.jsx').default;
const {DEFAULT_REFRESH_INTERVAL} = require('../../../../../app/constants/constants');

describe('Preview Modal Tests', () => {
beforeAll(() => {
Expand DownExpand Up@@ -155,9 +154,7 @@ describe('Preview Modal Tests', () => {
fid: 'fid:1',
requestor: 'user',
query: 'SELECT * FROM table',
cronInterval: '* * * * *',
// This is necessary to prevent older versions from breaking
refreshInterval: DEFAULT_REFRESH_INTERVAL
cronInterval: '* * * * *'
})
);
});
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content

This repository was archived by the owner on Aug 29, 2025. It is now read-only.

[WIP] upload scheduled query metadata#504
 Merged

n-riesco
merged 6 commits into

from

Aug 3, 2018
 Merged


[WIP] upload scheduled query metadata
#504
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
53e2869

remove setting of default refreshInterval from frontend


briandennis Jul 31, 2018
47d161d

add backend support for uploading metadata on create/update of queries


briandennis Jul 31, 2018
4f187b9

avoid throwing on null cronInterval in mapCronToRefresh


briandennis Aug 1, 2018
4bbfc6e

use mapCronToRefresh to set default refresh interval


briandennis Aug 2, 2018
e9f7a91

update jest tests to account for refreshInterval not being set by fro…


briandennis Aug 2, 2018
97dd563

add metadata specific error message


briandennis Aug 3, 2018

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 0 additions & 2 deletions
app/actions/sessions.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,7 +166,6 @@ export function createScheduledQuery(connectionId, payload = {}) {
 fid: payload.fid,
 filename: payload.filename,
 name: payload.name,
 refreshInterval: payload.refreshInterval,
 query: payload.query,
 cronInterval: payload.cronInterval,
 connectionId
Expand All@@ -189,7 +188,6 @@ export function updateScheduledQuery(connectionId, payload = {}) {
 fid: payload.fid,
 filename: payload.filename,
 name: payload.name,
 refreshInterval: payload.refreshInterval,
 query: payload.query,
 cronInterval: payload.cronInterval,
 connectionId
Expand Down

8 changes: 1 addition & 7 deletions
app/components/Settings/scheduler/create-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,12 +12,7 @@ import TimedMessage from './timed-message.jsx';
import CronPicker from '../cron-picker/cron-picker.jsx';
import SQL from './sql.jsx';

import {
 getHighlightMode,
 DEFAULT_REFRESH_INTERVAL,
 WAITING_MESSAGE,
 SAVE_WARNING
} from '../../../constants/constants.js';
import {getHighlightMode, WAITING_MESSAGE, SAVE_WARNING} from '../../../constants/constants.js';

import './create-modal.css';

Expand DownExpand Up@@ -109,7 +104,6 @@ class CreateModal extends Component {
 this.props
 .onSubmit({
 query: this.state.code,
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 filename: generateFilename(),
 cronInterval: this.state.interval,
 name: this.state.name ? this.state.name.trim() : ''
Expand Down

12 changes: 3 additions & 9 deletions
app/components/Settings/scheduler/preview-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,7 @@ import CronPicker from '../cron-picker/cron-picker.jsx';
import {Row, Column} from '../../layout.jsx';
import SQL from './sql.jsx';
import {plotlyUrl} from '../../../utils/utils.js';
import {
 getHighlightMode,
 DEFAULT_REFRESH_INTERVAL,
 WAITING_MESSAGE,
 SAVE_WARNING
} from '../../../constants/constants.js';
import {getHighlightMode, WAITING_MESSAGE, SAVE_WARNING} from '../../../constants/constants.js';
import {getInitialCronMode} from '../cron-picker/cron-helpers.js';

const NO_OP = () => {};
Expand DownExpand Up@@ -85,7 +80,7 @@ export class PreviewModal extends Component {

 onSubmit() {
 if (this.state.editing) {
 const {connectionId, fid, requestor, uids, refreshInterval} = this.props.query;
 const {connectionId, fid, requestor, uids} = this.props.query;
 const {code: query, cronInterval} = this.state;
 const name = this.state.name ? this.state.name.trim() : '';

Expand All@@ -98,8 +93,7 @@ export class PreviewModal extends Component {
 uids,
 query,
 name,
 cronInterval,
 refreshInterval: refreshInterval || DEFAULT_REFRESH_INTERVAL
 cronInterval
 })
 .then(() => {
 this.setState({
Expand Down

11 changes: 11 additions & 0 deletions
app/components/Settings/scheduler/request-error.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,17 @@ function FormattedMessage(props) {
 );
 }

 if (content.startsWith('MetadataError')) {
 return (
 <details style={outlineStyle}>
 <summary style={outlineStyle}>
 An unexpected error occurred while uploading query metadata. Please try again now.
 </summary>
 <pre>{capitalize(content.replace('MetadataError: ', ''))}</pre>
 </details>
 );
 }

 return content.slice(0, 100);
}

Expand Down

6 changes: 0 additions & 6 deletions
app/constants/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,12 +2,6 @@
/* eslint-disable no-multi-str */
import {concat} from 'ramda';

/**
 * Default to '1 week' for `refreshInterval` for backwards compatability. For
 * older versions this will prevent issues such as `setInterval(runQuery, NaN)`
 */
export const DEFAULT_REFRESH_INTERVAL = 7 * 24 * 60 * 60;

export const DIALECTS = {
 MYSQL: 'mysql',
 MARIADB: 'mariadb',
Expand Down

64 changes: 54 additions & 10 deletions
backend/persistent/QueryScheduler.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import * as scheduler from 'node-schedule';

import {getConnectionById} from './Connections.js';
import * as Connections from './datastores/Datastores.js';
import { mapRefreshToCron } from '../utils/cronUtils.js';
import { mapRefreshToCron, mapCronToRefresh } from '../utils/cronUtils.js';
import Logger from '../logger';
import {
 getQuery,
Expand All@@ -19,6 +19,7 @@ import {
 getCurrentUser,
 getGridMeta,
 newGrid,
 patchGrid,
 updateGrid
} from './plotly-api.js';

Expand DownExpand Up@@ -97,7 +98,7 @@ class QueryScheduler {
 requestor,
 fid,
 uids,
 refreshInterval,
 refreshInterval: refreshInterval || mapCronToRefresh(cronInterval),
 cronInterval,
 query,
 connectionId
Expand DownExpand Up@@ -142,9 +143,11 @@ class QueryScheduler {
 Object.keys(this.queryJobs).forEach(this.clearQuery);
 }

 queryAndCreateGrid(filename, query, connectionId, requestor) {
 queryAndCreateGrid(filename, query, connectionId, requestor, cronInterval, refreshInterval) {
 const {username, apiKey, accessToken} = getCredentials(requestor);
 const formattedRefresh = refreshInterval || mapCronToRefresh(cronInterval);
 let startTime;
 let createdJson;

 // Check if the user even exists
 if (!username || !(apiKey || accessToken)) {
Expand DownExpand Up@@ -204,16 +207,38 @@ class QueryScheduler {
 Logger.log(`Error ${res.status} while creating a grid`, 2);
 }

 return res.json().then((json) => {
 Logger.log(`Grid ${json.file.fid} has been updated.`, 2);
 return json;
 return res.json();
 }).then((json) => {
 createdJson = json;
 startTime = process.hrtime();

 return patchGrid(
 createdJson.file.fid,
 requestor,
 {
 metadata: {
 query,
 connectionId,
 connectorUrl: `https://${getSetting('CONNECTOR_HTTPS_DOMAIN')}:${getSetting('PORT_HTTPS')}`
 },
 refresh_interval: formattedRefresh
 }
 ).catch((e) => {
 /*
 * Warning: The front end looks for "MetadataError" in this error message. Don't change it!
 */
 throw new Error(`MetadataError: ${e.message}`);
 });
 }).then(() => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Grid ${createdJson.file.fid} has been updated.`, 2);
 return createdJson;
 });

 }

 queryAndUpdateGrid(fid, uids, query, connectionId, requestor) {
 queryAndUpdateGrid(fid, uids, query, connectionId, requestor, cronInterval, refreshInterval) {
 const requestedDBConnections = getConnectionById(connectionId);
 const formattedRefresh = refreshInterval || mapCronToRefresh(cronInterval);
 let startTime = process.hrtime();

 /*
Expand DownExpand Up@@ -337,13 +362,32 @@ class QueryScheduler {

 }

 startTime = process.hrtime();

 return patchGrid(
 fid,
 requestor,
 {
 metadata: {
 query,
 connectionId,
 connectorUrl: `https://${getSetting('CONNECTOR_HTTPS_DOMAIN')}:${getSetting('PORT_HTTPS')}`
 },
 refresh_interval: formattedRefresh
 }
 ).catch((e) => {
 /*
 * Warning: The front end looks for "MetadataError" in this error message. Don't change it!
 */
 throw new Error(`MetadataError: ${e.message}`);
 });
 }).then((res) => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);
 return res.json().then(() => {
 Logger.log(`Grid ${fid} has been updated.`, 2);
 });
 });

 }

}

export default QueryScheduler;
Expand Down

12 changes: 12 additions & 0 deletions
backend/persistent/plotly-api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -152,6 +152,18 @@ export function deleteGrid(fid, requestor) {
 });
}

export function patchGrid(fid, requestor, body) {
 const {username, apiKey, accessToken} = getCredentials(requestor);

 return plotlyAPIRequest(`grids/${fid}`, {
 method: 'PATCH',
 username,
 apiKey,
 accessToken,
 body
 });
}

export function updateGrid(rows, fid, uids, requestor) {
 const {username, apiKey, accessToken} = getCredentials(requestor);

Expand Down

15 changes: 12 additions & 3 deletions
backend/routes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -664,13 +664,22 @@ export default class Servers {
 * the endpoint `/queries/:fid`
 */
 server.post('/queries', function postQueriesHandler(req, res, next) {
 const {filename, fid, uids, query, connectionId, requestor} = req.params;
 const {
 filename,
 fid,
 uids,
 query,
 connectionId,
 requestor,
 cronInterval = null,
@n-riescon-riescoAug 1, 2018

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

out of curiosity, why setting the default to 'null'?
 refreshInterval = null
 } = req.params;

 // If a filename has been provided,
 // make the query and create a new grid
 if (filename) {
 return that.queryScheduler.queryAndCreateGrid(
 filename, query, connectionId, requestor
 filename, query, connectionId, requestor, cronInterval, refreshInterval
 )
 .then((newGridResponse) => {
 const queryObject = {
Expand All@@ -691,7 +700,7 @@ export default class Servers {
 if (fid) {
 return checkWritePermissions(fid, requestor).then(function () {
 return that.queryScheduler.queryAndUpdateGrid(
 fid, uids, query, connectionId, requestor
 fid, uids, query, connectionId, requestor, cronInterval, refreshInterval
 );
 })
 .then(() => {
Expand Down

20 changes: 20 additions & 0 deletions
backend/utils/cronUtils.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,26 @@ export function mapRefreshToCron (refreshInterval) {
 return `${now.getMinutes()} ${now.getHours()} * * ${now.getDay()}`;
}

export function mapCronToRefresh (cronInterval) {
 const DEFAULT_INTERVAL = 60 * 60 * 24 * 7; // default to weekly

 if (!cronInterval) {
 return DEFAULT_INTERVAL;
 }

 if (cronInterval === '* * * * *') {
 return 60;
 } else if (cronInterval === '*/5 * * * *') {
 return 60 * 5;
 } else if (cronInterval.match(/\S+? \* \* \* \*/)) {
@n-riescon-riescoAug 1, 2018

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this throws when cronInterval is null
 return 60 * 60;
 } else if (cronInterval.match(/\S+? \S+? \* \* \*/)) {
 return 60 * 60 * 24;
 }

 return DEFAULT_INTERVAL;
}

function computeMinutes (now) {
 let currMinute = now.getMinutes() % 5; // start at 5 min offset
 const minutes = [];
Expand Down

3 changes: 0 additions & 3 deletions
test/app/components/Settings/scheduler/create-modal.test.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ global.document.createRange = function() {

const wait = () => new Promise(resolve => setTimeout(resolve, 0));

const {DEFAULT_REFRESH_INTERVAL} = require('../../../../../app/constants/constants');
const CodeMirror = require('react-codemirror2').Controlled;
const CreateModal = require('../../../../../app/components/Settings/scheduler/create-modal.jsx');
const ErrorComponent = require('../../../../../app/components/error.jsx');
Expand DownExpand Up@@ -93,15 +92,13 @@ describe('Create Modal Test', () => {
 // Once filename input is supported, this value should be: 'filename',
 filename: expect.any(String),
 query: 'SELECT * FROM foods',
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 cronInterval
 })
 );
 expect(onSubmit).toHaveBeenCalledWith({
 // Once filename input is supported, this value should be: 'filename',
 filename: expect.any(String),
 query: 'SELECT * FROM foods',
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 cronInterval,
 name
 });
Expand Down

5 changes: 1 addition & 4 deletions
test/app/components/Settings/scheduler/preview-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@ global.document.createRange = function() {
};

const PreviewModal = require('../../../../../app/components/Settings/scheduler/preview-modal.jsx').default;
const {DEFAULT_REFRESH_INTERVAL} = require('../../../../../app/constants/constants');

describe('Preview Modal Tests', () => {
 beforeAll(() => {
Expand DownExpand Up@@ -155,9 +154,7 @@ describe('Preview Modal Tests', () => {
 fid: 'fid:1',
 requestor: 'user',
 query: 'SELECT * FROM table',
 cronInterval: '* * * * *',
 // This is necessary to prevent older versions from breaking
 refreshInterval: DEFAULT_REFRESH_INTERVAL
 cronInterval: '* * * * *'
 })
 );
 });
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content

This repository was archived by the owner on Aug 29, 2025. It is now read-only.

[WIP] upload scheduled query metadata#504
 Merged

n-riesco
merged 6 commits into

from

Aug 3, 2018
 Merged


[WIP] upload scheduled query metadata
#504
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
53e2869

remove setting of default refreshInterval from frontend


briandennis Jul 31, 2018
47d161d

add backend support for uploading metadata on create/update of queries


briandennis Jul 31, 2018
4f187b9

avoid throwing on null cronInterval in mapCronToRefresh


briandennis Aug 1, 2018
4bbfc6e

use mapCronToRefresh to set default refresh interval


briandennis Aug 2, 2018
e9f7a91

update jest tests to account for refreshInterval not being set by fro…


briandennis Aug 2, 2018
97dd563

add metadata specific error message


briandennis Aug 3, 2018

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 0 additions & 2 deletions
app/actions/sessions.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,7 +166,6 @@ export function createScheduledQuery(connectionId, payload = {}) {
 fid: payload.fid,
 filename: payload.filename,
 name: payload.name,
 refreshInterval: payload.refreshInterval,
 query: payload.query,
 cronInterval: payload.cronInterval,
 connectionId
Expand All@@ -189,7 +188,6 @@ export function updateScheduledQuery(connectionId, payload = {}) {
 fid: payload.fid,
 filename: payload.filename,
 name: payload.name,
 refreshInterval: payload.refreshInterval,
 query: payload.query,
 cronInterval: payload.cronInterval,
 connectionId
Expand Down

8 changes: 1 addition & 7 deletions
app/components/Settings/scheduler/create-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,12 +12,7 @@ import TimedMessage from './timed-message.jsx';
import CronPicker from '../cron-picker/cron-picker.jsx';
import SQL from './sql.jsx';

import {
 getHighlightMode,
 DEFAULT_REFRESH_INTERVAL,
 WAITING_MESSAGE,
 SAVE_WARNING
} from '../../../constants/constants.js';
import {getHighlightMode, WAITING_MESSAGE, SAVE_WARNING} from '../../../constants/constants.js';

import './create-modal.css';

Expand DownExpand Up@@ -109,7 +104,6 @@ class CreateModal extends Component {
 this.props
 .onSubmit({
 query: this.state.code,
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 filename: generateFilename(),
 cronInterval: this.state.interval,
 name: this.state.name ? this.state.name.trim() : ''
Expand Down

12 changes: 3 additions & 9 deletions
app/components/Settings/scheduler/preview-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,7 @@ import CronPicker from '../cron-picker/cron-picker.jsx';
import {Row, Column} from '../../layout.jsx';
import SQL from './sql.jsx';
import {plotlyUrl} from '../../../utils/utils.js';
import {
 getHighlightMode,
 DEFAULT_REFRESH_INTERVAL,
 WAITING_MESSAGE,
 SAVE_WARNING
} from '../../../constants/constants.js';
import {getHighlightMode, WAITING_MESSAGE, SAVE_WARNING} from '../../../constants/constants.js';
import {getInitialCronMode} from '../cron-picker/cron-helpers.js';

const NO_OP = () => {};
Expand DownExpand Up@@ -85,7 +80,7 @@ export class PreviewModal extends Component {

 onSubmit() {
 if (this.state.editing) {
 const {connectionId, fid, requestor, uids, refreshInterval} = this.props.query;
 const {connectionId, fid, requestor, uids} = this.props.query;
 const {code: query, cronInterval} = this.state;
 const name = this.state.name ? this.state.name.trim() : '';

Expand All@@ -98,8 +93,7 @@ export class PreviewModal extends Component {
 uids,
 query,
 name,
 cronInterval,
 refreshInterval: refreshInterval || DEFAULT_REFRESH_INTERVAL
 cronInterval
 })
 .then(() => {
 this.setState({
Expand Down

11 changes: 11 additions & 0 deletions
app/components/Settings/scheduler/request-error.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,17 @@ function FormattedMessage(props) {
 );
 }

 if (content.startsWith('MetadataError')) {
 return (
 <details style={outlineStyle}>
 <summary style={outlineStyle}>
 An unexpected error occurred while uploading query metadata. Please try again now.
 </summary>
 <pre>{capitalize(content.replace('MetadataError: ', ''))}</pre>
 </details>
 );
 }

 return content.slice(0, 100);
}

Expand Down

6 changes: 0 additions & 6 deletions
app/constants/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,12 +2,6 @@
/* eslint-disable no-multi-str */
import {concat} from 'ramda';

/**
 * Default to '1 week' for `refreshInterval` for backwards compatability. For
 * older versions this will prevent issues such as `setInterval(runQuery, NaN)`
 */
export const DEFAULT_REFRESH_INTERVAL = 7 * 24 * 60 * 60;

export const DIALECTS = {
 MYSQL: 'mysql',
 MARIADB: 'mariadb',
Expand Down

64 changes: 54 additions & 10 deletions
backend/persistent/QueryScheduler.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import * as scheduler from 'node-schedule';

import {getConnectionById} from './Connections.js';
import * as Connections from './datastores/Datastores.js';
import { mapRefreshToCron } from '../utils/cronUtils.js';
import { mapRefreshToCron, mapCronToRefresh } from '../utils/cronUtils.js';
import Logger from '../logger';
import {
 getQuery,
Expand All@@ -19,6 +19,7 @@ import {
 getCurrentUser,
 getGridMeta,
 newGrid,
 patchGrid,
 updateGrid
} from './plotly-api.js';

Expand DownExpand Up@@ -97,7 +98,7 @@ class QueryScheduler {
 requestor,
 fid,
 uids,
 refreshInterval,
 refreshInterval: refreshInterval || mapCronToRefresh(cronInterval),
 cronInterval,
 query,
 connectionId
Expand DownExpand Up@@ -142,9 +143,11 @@ class QueryScheduler {
 Object.keys(this.queryJobs).forEach(this.clearQuery);
 }

 queryAndCreateGrid(filename, query, connectionId, requestor) {
 queryAndCreateGrid(filename, query, connectionId, requestor, cronInterval, refreshInterval) {
 const {username, apiKey, accessToken} = getCredentials(requestor);
 const formattedRefresh = refreshInterval || mapCronToRefresh(cronInterval);
 let startTime;
 let createdJson;

 // Check if the user even exists
 if (!username || !(apiKey || accessToken)) {
Expand DownExpand Up@@ -204,16 +207,38 @@ class QueryScheduler {
 Logger.log(`Error ${res.status} while creating a grid`, 2);
 }

 return res.json().then((json) => {
 Logger.log(`Grid ${json.file.fid} has been updated.`, 2);
 return json;
 return res.json();
 }).then((json) => {
 createdJson = json;
 startTime = process.hrtime();

 return patchGrid(
 createdJson.file.fid,
 requestor,
 {
 metadata: {
 query,
 connectionId,
 connectorUrl: `https://${getSetting('CONNECTOR_HTTPS_DOMAIN')}:${getSetting('PORT_HTTPS')}`
 },
 refresh_interval: formattedRefresh
 }
 ).catch((e) => {
 /*
 * Warning: The front end looks for "MetadataError" in this error message. Don't change it!
 */
 throw new Error(`MetadataError: ${e.message}`);
 });
 }).then(() => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Grid ${createdJson.file.fid} has been updated.`, 2);
 return createdJson;
 });

 }

 queryAndUpdateGrid(fid, uids, query, connectionId, requestor) {
 queryAndUpdateGrid(fid, uids, query, connectionId, requestor, cronInterval, refreshInterval) {
 const requestedDBConnections = getConnectionById(connectionId);
 const formattedRefresh = refreshInterval || mapCronToRefresh(cronInterval);
 let startTime = process.hrtime();

 /*
Expand DownExpand Up@@ -337,13 +362,32 @@ class QueryScheduler {

 }

 startTime = process.hrtime();

 return patchGrid(
 fid,
 requestor,
 {
 metadata: {
 query,
 connectionId,
 connectorUrl: `https://${getSetting('CONNECTOR_HTTPS_DOMAIN')}:${getSetting('PORT_HTTPS')}`
 },
 refresh_interval: formattedRefresh
 }
 ).catch((e) => {
 /*
 * Warning: The front end looks for "MetadataError" in this error message. Don't change it!
 */
 throw new Error(`MetadataError: ${e.message}`);
 });
 }).then((res) => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);
 return res.json().then(() => {
 Logger.log(`Grid ${fid} has been updated.`, 2);
 });
 });

 }

}

export default QueryScheduler;
Expand Down

12 changes: 12 additions & 0 deletions
backend/persistent/plotly-api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -152,6 +152,18 @@ export function deleteGrid(fid, requestor) {
 });
}

export function patchGrid(fid, requestor, body) {
 const {username, apiKey, accessToken} = getCredentials(requestor);

 return plotlyAPIRequest(`grids/${fid}`, {
 method: 'PATCH',
 username,
 apiKey,
 accessToken,
 body
 });
}

export function updateGrid(rows, fid, uids, requestor) {
 const {username, apiKey, accessToken} = getCredentials(requestor);

Expand Down

15 changes: 12 additions & 3 deletions
backend/routes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -664,13 +664,22 @@ export default class Servers {
 * the endpoint `/queries/:fid`
 */
 server.post('/queries', function postQueriesHandler(req, res, next) {
 const {filename, fid, uids, query, connectionId, requestor} = req.params;
 const {
 filename,
 fid,
 uids,
 query,
 connectionId,
 requestor,
 cronInterval = null,
@n-riescon-riescoAug 1, 2018

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

out of curiosity, why setting the default to 'null'?
 refreshInterval = null
 } = req.params;

 // If a filename has been provided,
 // make the query and create a new grid
 if (filename) {
 return that.queryScheduler.queryAndCreateGrid(
 filename, query, connectionId, requestor
 filename, query, connectionId, requestor, cronInterval, refreshInterval
 )
 .then((newGridResponse) => {
 const queryObject = {
Expand All@@ -691,7 +700,7 @@ export default class Servers {
 if (fid) {
 return checkWritePermissions(fid, requestor).then(function () {
 return that.queryScheduler.queryAndUpdateGrid(
 fid, uids, query, connectionId, requestor
 fid, uids, query, connectionId, requestor, cronInterval, refreshInterval
 );
 })
 .then(() => {
Expand Down

20 changes: 20 additions & 0 deletions
backend/utils/cronUtils.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,26 @@ export function mapRefreshToCron (refreshInterval) {
 return `${now.getMinutes()} ${now.getHours()} * * ${now.getDay()}`;
}

export function mapCronToRefresh (cronInterval) {
 const DEFAULT_INTERVAL = 60 * 60 * 24 * 7; // default to weekly

 if (!cronInterval) {
 return DEFAULT_INTERVAL;
 }

 if (cronInterval === '* * * * *') {
 return 60;
 } else if (cronInterval === '*/5 * * * *') {
 return 60 * 5;
 } else if (cronInterval.match(/\S+? \* \* \* \*/)) {
@n-riescon-riescoAug 1, 2018

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this throws when cronInterval is null
 return 60 * 60;
 } else if (cronInterval.match(/\S+? \S+? \* \* \*/)) {
 return 60 * 60 * 24;
 }

 return DEFAULT_INTERVAL;
}

function computeMinutes (now) {
 let currMinute = now.getMinutes() % 5; // start at 5 min offset
 const minutes = [];
Expand Down

3 changes: 0 additions & 3 deletions
test/app/components/Settings/scheduler/create-modal.test.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ global.document.createRange = function() {

const wait = () => new Promise(resolve => setTimeout(resolve, 0));

const {DEFAULT_REFRESH_INTERVAL} = require('../../../../../app/constants/constants');
const CodeMirror = require('react-codemirror2').Controlled;
const CreateModal = require('../../../../../app/components/Settings/scheduler/create-modal.jsx');
const ErrorComponent = require('../../../../../app/components/error.jsx');
Expand DownExpand Up@@ -93,15 +92,13 @@ describe('Create Modal Test', () => {
 // Once filename input is supported, this value should be: 'filename',
 filename: expect.any(String),
 query: 'SELECT * FROM foods',
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 cronInterval
 })
 );
 expect(onSubmit).toHaveBeenCalledWith({
 // Once filename input is supported, this value should be: 'filename',
 filename: expect.any(String),
 query: 'SELECT * FROM foods',
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 cronInterval,
 name
 });
Expand Down

5 changes: 1 addition & 4 deletions
test/app/components/Settings/scheduler/preview-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@ global.document.createRange = function() {
};

const PreviewModal = require('../../../../../app/components/Settings/scheduler/preview-modal.jsx').default;
const {DEFAULT_REFRESH_INTERVAL} = require('../../../../../app/constants/constants');

describe('Preview Modal Tests', () => {
 beforeAll(() => {
Expand DownExpand Up@@ -155,9 +154,7 @@ describe('Preview Modal Tests', () => {
 fid: 'fid:1',
 requestor: 'user',
 query: 'SELECT * FROM table',
 cronInterval: '* * * * *',
 // This is necessary to prevent older versions from breaking
 refreshInterval: DEFAULT_REFRESH_INTERVAL
 cronInterval: '* * * * *'
 })
 );
 });
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content

This repository was archived by the owner on Aug 29, 2025. It is now read-only.

[WIP] upload scheduled query metadata#504
 Merged

n-riesco
merged 6 commits into

from

Aug 3, 2018
 Merged


[WIP] upload scheduled query metadata
#504
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
53e2869

remove setting of default refreshInterval from frontend


briandennis Jul 31, 2018
47d161d

add backend support for uploading metadata on create/update of queries


briandennis Jul 31, 2018
4f187b9

avoid throwing on null cronInterval in mapCronToRefresh


briandennis Aug 1, 2018
4bbfc6e

use mapCronToRefresh to set default refresh interval


briandennis Aug 2, 2018
e9f7a91

update jest tests to account for refreshInterval not being set by fro…


briandennis Aug 2, 2018
97dd563

add metadata specific error message


briandennis Aug 3, 2018

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 0 additions & 2 deletions
app/actions/sessions.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,7 +166,6 @@ export function createScheduledQuery(connectionId, payload = {}) {
 fid: payload.fid,
 filename: payload.filename,
 name: payload.name,
 refreshInterval: payload.refreshInterval,
 query: payload.query,
 cronInterval: payload.cronInterval,
 connectionId
Expand All@@ -189,7 +188,6 @@ export function updateScheduledQuery(connectionId, payload = {}) {
 fid: payload.fid,
 filename: payload.filename,
 name: payload.name,
 refreshInterval: payload.refreshInterval,
 query: payload.query,
 cronInterval: payload.cronInterval,
 connectionId
Expand Down

8 changes: 1 addition & 7 deletions
app/components/Settings/scheduler/create-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,12 +12,7 @@ import TimedMessage from './timed-message.jsx';
import CronPicker from '../cron-picker/cron-picker.jsx';
import SQL from './sql.jsx';

import {
 getHighlightMode,
 DEFAULT_REFRESH_INTERVAL,
 WAITING_MESSAGE,
 SAVE_WARNING
} from '../../../constants/constants.js';
import {getHighlightMode, WAITING_MESSAGE, SAVE_WARNING} from '../../../constants/constants.js';

import './create-modal.css';

Expand DownExpand Up@@ -109,7 +104,6 @@ class CreateModal extends Component {
 this.props
 .onSubmit({
 query: this.state.code,
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 filename: generateFilename(),
 cronInterval: this.state.interval,
 name: this.state.name ? this.state.name.trim() : ''
Expand Down

12 changes: 3 additions & 9 deletions
app/components/Settings/scheduler/preview-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,7 @@ import CronPicker from '../cron-picker/cron-picker.jsx';
import {Row, Column} from '../../layout.jsx';
import SQL from './sql.jsx';
import {plotlyUrl} from '../../../utils/utils.js';
import {
 getHighlightMode,
 DEFAULT_REFRESH_INTERVAL,
 WAITING_MESSAGE,
 SAVE_WARNING
} from '../../../constants/constants.js';
import {getHighlightMode, WAITING_MESSAGE, SAVE_WARNING} from '../../../constants/constants.js';
import {getInitialCronMode} from '../cron-picker/cron-helpers.js';

const NO_OP = () => {};
Expand DownExpand Up@@ -85,7 +80,7 @@ export class PreviewModal extends Component {

 onSubmit() {
 if (this.state.editing) {
 const {connectionId, fid, requestor, uids, refreshInterval} = this.props.query;
 const {connectionId, fid, requestor, uids} = this.props.query;
 const {code: query, cronInterval} = this.state;
 const name = this.state.name ? this.state.name.trim() : '';

Expand All@@ -98,8 +93,7 @@ export class PreviewModal extends Component {
 uids,
 query,
 name,
 cronInterval,
 refreshInterval: refreshInterval || DEFAULT_REFRESH_INTERVAL
 cronInterval
 })
 .then(() => {
 this.setState({
Expand Down

11 changes: 11 additions & 0 deletions
app/components/Settings/scheduler/request-error.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,17 @@ function FormattedMessage(props) {
 );
 }

 if (content.startsWith('MetadataError')) {
 return (
 <details style={outlineStyle}>
 <summary style={outlineStyle}>
 An unexpected error occurred while uploading query metadata. Please try again now.
 </summary>
 <pre>{capitalize(content.replace('MetadataError: ', ''))}</pre>
 </details>
 );
 }

 return content.slice(0, 100);
}

Expand Down

6 changes: 0 additions & 6 deletions
app/constants/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,12 +2,6 @@
/* eslint-disable no-multi-str */
import {concat} from 'ramda';

/**
 * Default to '1 week' for `refreshInterval` for backwards compatability. For
 * older versions this will prevent issues such as `setInterval(runQuery, NaN)`
 */
export const DEFAULT_REFRESH_INTERVAL = 7 * 24 * 60 * 60;

export const DIALECTS = {
 MYSQL: 'mysql',
 MARIADB: 'mariadb',
Expand Down

64 changes: 54 additions & 10 deletions
backend/persistent/QueryScheduler.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import * as scheduler from 'node-schedule';

import {getConnectionById} from './Connections.js';
import * as Connections from './datastores/Datastores.js';
import { mapRefreshToCron } from '../utils/cronUtils.js';
import { mapRefreshToCron, mapCronToRefresh } from '../utils/cronUtils.js';
import Logger from '../logger';
import {
 getQuery,
Expand All@@ -19,6 +19,7 @@ import {
 getCurrentUser,
 getGridMeta,
 newGrid,
 patchGrid,
 updateGrid
} from './plotly-api.js';

Expand DownExpand Up@@ -97,7 +98,7 @@ class QueryScheduler {
 requestor,
 fid,
 uids,
 refreshInterval,
 refreshInterval: refreshInterval || mapCronToRefresh(cronInterval),
 cronInterval,
 query,
 connectionId
Expand DownExpand Up@@ -142,9 +143,11 @@ class QueryScheduler {
 Object.keys(this.queryJobs).forEach(this.clearQuery);
 }

 queryAndCreateGrid(filename, query, connectionId, requestor) {
 queryAndCreateGrid(filename, query, connectionId, requestor, cronInterval, refreshInterval) {
 const {username, apiKey, accessToken} = getCredentials(requestor);
 const formattedRefresh = refreshInterval || mapCronToRefresh(cronInterval);
 let startTime;
 let createdJson;

 // Check if the user even exists
 if (!username || !(apiKey || accessToken)) {
Expand DownExpand Up@@ -204,16 +207,38 @@ class QueryScheduler {
 Logger.log(`Error ${res.status} while creating a grid`, 2);
 }

 return res.json().then((json) => {
 Logger.log(`Grid ${json.file.fid} has been updated.`, 2);
 return json;
 return res.json();
 }).then((json) => {
 createdJson = json;
 startTime = process.hrtime();

 return patchGrid(
 createdJson.file.fid,
 requestor,
 {
 metadata: {
 query,
 connectionId,
 connectorUrl: `https://${getSetting('CONNECTOR_HTTPS_DOMAIN')}:${getSetting('PORT_HTTPS')}`
 },
 refresh_interval: formattedRefresh
 }
 ).catch((e) => {
 /*
 * Warning: The front end looks for "MetadataError" in this error message. Don't change it!
 */
 throw new Error(`MetadataError: ${e.message}`);
 });
 }).then(() => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Grid ${createdJson.file.fid} has been updated.`, 2);
 return createdJson;
 });

 }

 queryAndUpdateGrid(fid, uids, query, connectionId, requestor) {
 queryAndUpdateGrid(fid, uids, query, connectionId, requestor, cronInterval, refreshInterval) {
 const requestedDBConnections = getConnectionById(connectionId);
 const formattedRefresh = refreshInterval || mapCronToRefresh(cronInterval);
 let startTime = process.hrtime();

 /*
Expand DownExpand Up@@ -337,13 +362,32 @@ class QueryScheduler {

 }

 startTime = process.hrtime();

 return patchGrid(
 fid,
 requestor,
 {
 metadata: {
 query,
 connectionId,
 connectorUrl: `https://${getSetting('CONNECTOR_HTTPS_DOMAIN')}:${getSetting('PORT_HTTPS')}`
 },
 refresh_interval: formattedRefresh
 }
 ).catch((e) => {
 /*
 * Warning: The front end looks for "MetadataError" in this error message. Don't change it!
 */
 throw new Error(`MetadataError: ${e.message}`);
 });
 }).then((res) => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);
 return res.json().then(() => {
 Logger.log(`Grid ${fid} has been updated.`, 2);
 });
 });

 }

}

export default QueryScheduler;
Expand Down

12 changes: 12 additions & 0 deletions
backend/persistent/plotly-api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -152,6 +152,18 @@ export function deleteGrid(fid, requestor) {
 });
}

export function patchGrid(fid, requestor, body) {
 const {username, apiKey, accessToken} = getCredentials(requestor);

 return plotlyAPIRequest(`grids/${fid}`, {
 method: 'PATCH',
 username,
 apiKey,
 accessToken,
 body
 });
}

export function updateGrid(rows, fid, uids, requestor) {
 const {username, apiKey, accessToken} = getCredentials(requestor);

Expand Down

15 changes: 12 additions & 3 deletions
backend/routes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -664,13 +664,22 @@ export default class Servers {
 * the endpoint `/queries/:fid`
 */
 server.post('/queries', function postQueriesHandler(req, res, next) {
 const {filename, fid, uids, query, connectionId, requestor} = req.params;
 const {
 filename,
 fid,
 uids,
 query,
 connectionId,
 requestor,
 cronInterval = null,
@n-riescon-riescoAug 1, 2018

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

out of curiosity, why setting the default to 'null'?
 refreshInterval = null
 } = req.params;

 // If a filename has been provided,
 // make the query and create a new grid
 if (filename) {
 return that.queryScheduler.queryAndCreateGrid(
 filename, query, connectionId, requestor
 filename, query, connectionId, requestor, cronInterval, refreshInterval
 )
 .then((newGridResponse) => {
 const queryObject = {
Expand All@@ -691,7 +700,7 @@ export default class Servers {
 if (fid) {
 return checkWritePermissions(fid, requestor).then(function () {
 return that.queryScheduler.queryAndUpdateGrid(
 fid, uids, query, connectionId, requestor
 fid, uids, query, connectionId, requestor, cronInterval, refreshInterval
 );
 })
 .then(() => {
Expand Down

20 changes: 20 additions & 0 deletions
backend/utils/cronUtils.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,26 @@ export function mapRefreshToCron (refreshInterval) {
 return `${now.getMinutes()} ${now.getHours()} * * ${now.getDay()}`;
}

export function mapCronToRefresh (cronInterval) {
 const DEFAULT_INTERVAL = 60 * 60 * 24 * 7; // default to weekly

 if (!cronInterval) {
 return DEFAULT_INTERVAL;
 }

 if (cronInterval === '* * * * *') {
 return 60;
 } else if (cronInterval === '*/5 * * * *') {
 return 60 * 5;
 } else if (cronInterval.match(/\S+? \* \* \* \*/)) {
@n-riescon-riescoAug 1, 2018

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this throws when cronInterval is null
 return 60 * 60;
 } else if (cronInterval.match(/\S+? \S+? \* \* \*/)) {
 return 60 * 60 * 24;
 }

 return DEFAULT_INTERVAL;
}

function computeMinutes (now) {
 let currMinute = now.getMinutes() % 5; // start at 5 min offset
 const minutes = [];
Expand Down

3 changes: 0 additions & 3 deletions
test/app/components/Settings/scheduler/create-modal.test.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ global.document.createRange = function() {

const wait = () => new Promise(resolve => setTimeout(resolve, 0));

const {DEFAULT_REFRESH_INTERVAL} = require('../../../../../app/constants/constants');
const CodeMirror = require('react-codemirror2').Controlled;
const CreateModal = require('../../../../../app/components/Settings/scheduler/create-modal.jsx');
const ErrorComponent = require('../../../../../app/components/error.jsx');
Expand DownExpand Up@@ -93,15 +92,13 @@ describe('Create Modal Test', () => {
 // Once filename input is supported, this value should be: 'filename',
 filename: expect.any(String),
 query: 'SELECT * FROM foods',
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 cronInterval
 })
 );
 expect(onSubmit).toHaveBeenCalledWith({
 // Once filename input is supported, this value should be: 'filename',
 filename: expect.any(String),
 query: 'SELECT * FROM foods',
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 cronInterval,
 name
 });
Expand Down

5 changes: 1 addition & 4 deletions
test/app/components/Settings/scheduler/preview-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@ global.document.createRange = function() {
};

const PreviewModal = require('../../../../../app/components/Settings/scheduler/preview-modal.jsx').default;
const {DEFAULT_REFRESH_INTERVAL} = require('../../../../../app/constants/constants');

describe('Preview Modal Tests', () => {
 beforeAll(() => {
Expand DownExpand Up@@ -155,9 +154,7 @@ describe('Preview Modal Tests', () => {
 fid: 'fid:1',
 requestor: 'user',
 query: 'SELECT * FROM table',
 cronInterval: '* * * * *',
 // This is necessary to prevent older versions from breaking
 refreshInterval: DEFAULT_REFRESH_INTERVAL
 cronInterval: '* * * * *'
 })
 );
 });
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content

This repository was archived by the owner on Aug 29, 2025. It is now read-only.

[WIP] upload scheduled query metadata#504
 Merged

n-riesco
merged 6 commits into

from

Aug 3, 2018
 Merged


[WIP] upload scheduled query metadata
#504
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
53e2869

remove setting of default refreshInterval from frontend


briandennis Jul 31, 2018
47d161d

add backend support for uploading metadata on create/update of queries


briandennis Jul 31, 2018
4f187b9

avoid throwing on null cronInterval in mapCronToRefresh


briandennis Aug 1, 2018
4bbfc6e

use mapCronToRefresh to set default refresh interval


briandennis Aug 2, 2018
e9f7a91

update jest tests to account for refreshInterval not being set by fro…


briandennis Aug 2, 2018
97dd563

add metadata specific error message


briandennis Aug 3, 2018

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 0 additions & 2 deletions
app/actions/sessions.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,7 +166,6 @@ export function createScheduledQuery(connectionId, payload = {}) {
 fid: payload.fid,
 filename: payload.filename,
 name: payload.name,
 refreshInterval: payload.refreshInterval,
 query: payload.query,
 cronInterval: payload.cronInterval,
 connectionId
Expand All@@ -189,7 +188,6 @@ export function updateScheduledQuery(connectionId, payload = {}) {
 fid: payload.fid,
 filename: payload.filename,
 name: payload.name,
 refreshInterval: payload.refreshInterval,
 query: payload.query,
 cronInterval: payload.cronInterval,
 connectionId
Expand Down

8 changes: 1 addition & 7 deletions
app/components/Settings/scheduler/create-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,12 +12,7 @@ import TimedMessage from './timed-message.jsx';
import CronPicker from '../cron-picker/cron-picker.jsx';
import SQL from './sql.jsx';

import {
 getHighlightMode,
 DEFAULT_REFRESH_INTERVAL,
 WAITING_MESSAGE,
 SAVE_WARNING
} from '../../../constants/constants.js';
import {getHighlightMode, WAITING_MESSAGE, SAVE_WARNING} from '../../../constants/constants.js';

import './create-modal.css';

Expand DownExpand Up@@ -109,7 +104,6 @@ class CreateModal extends Component {
 this.props
 .onSubmit({
 query: this.state.code,
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 filename: generateFilename(),
 cronInterval: this.state.interval,
 name: this.state.name ? this.state.name.trim() : ''
Expand Down

12 changes: 3 additions & 9 deletions
app/components/Settings/scheduler/preview-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,7 @@ import CronPicker from '../cron-picker/cron-picker.jsx';
import {Row, Column} from '../../layout.jsx';
import SQL from './sql.jsx';
import {plotlyUrl} from '../../../utils/utils.js';
import {
 getHighlightMode,
 DEFAULT_REFRESH_INTERVAL,
 WAITING_MESSAGE,
 SAVE_WARNING
} from '../../../constants/constants.js';
import {getHighlightMode, WAITING_MESSAGE, SAVE_WARNING} from '../../../constants/constants.js';
import {getInitialCronMode} from '../cron-picker/cron-helpers.js';

const NO_OP = () => {};
Expand DownExpand Up@@ -85,7 +80,7 @@ export class PreviewModal extends Component {

 onSubmit() {
 if (this.state.editing) {
 const {connectionId, fid, requestor, uids, refreshInterval} = this.props.query;
 const {connectionId, fid, requestor, uids} = this.props.query;
 const {code: query, cronInterval} = this.state;
 const name = this.state.name ? this.state.name.trim() : '';

Expand All@@ -98,8 +93,7 @@ export class PreviewModal extends Component {
 uids,
 query,
 name,
 cronInterval,
 refreshInterval: refreshInterval || DEFAULT_REFRESH_INTERVAL
 cronInterval
 })
 .then(() => {
 this.setState({
Expand Down

11 changes: 11 additions & 0 deletions
app/components/Settings/scheduler/request-error.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,17 @@ function FormattedMessage(props) {
 );
 }

 if (content.startsWith('MetadataError')) {
 return (
 <details style={outlineStyle}>
 <summary style={outlineStyle}>
 An unexpected error occurred while uploading query metadata. Please try again now.
 </summary>
 <pre>{capitalize(content.replace('MetadataError: ', ''))}</pre>
 </details>
 );
 }

 return content.slice(0, 100);
}

Expand Down

6 changes: 0 additions & 6 deletions
app/constants/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,12 +2,6 @@
/* eslint-disable no-multi-str */
import {concat} from 'ramda';

/**
 * Default to '1 week' for `refreshInterval` for backwards compatability. For
 * older versions this will prevent issues such as `setInterval(runQuery, NaN)`
 */
export const DEFAULT_REFRESH_INTERVAL = 7 * 24 * 60 * 60;

export const DIALECTS = {
 MYSQL: 'mysql',
 MARIADB: 'mariadb',
Expand Down

64 changes: 54 additions & 10 deletions
backend/persistent/QueryScheduler.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import * as scheduler from 'node-schedule';

import {getConnectionById} from './Connections.js';
import * as Connections from './datastores/Datastores.js';
import { mapRefreshToCron } from '../utils/cronUtils.js';
import { mapRefreshToCron, mapCronToRefresh } from '../utils/cronUtils.js';
import Logger from '../logger';
import {
 getQuery,
Expand All@@ -19,6 +19,7 @@ import {
 getCurrentUser,
 getGridMeta,
 newGrid,
 patchGrid,
 updateGrid
} from './plotly-api.js';

Expand DownExpand Up@@ -97,7 +98,7 @@ class QueryScheduler {
 requestor,
 fid,
 uids,
 refreshInterval,
 refreshInterval: refreshInterval || mapCronToRefresh(cronInterval),
 cronInterval,
 query,
 connectionId
Expand DownExpand Up@@ -142,9 +143,11 @@ class QueryScheduler {
 Object.keys(this.queryJobs).forEach(this.clearQuery);
 }

 queryAndCreateGrid(filename, query, connectionId, requestor) {
 queryAndCreateGrid(filename, query, connectionId, requestor, cronInterval, refreshInterval) {
 const {username, apiKey, accessToken} = getCredentials(requestor);
 const formattedRefresh = refreshInterval || mapCronToRefresh(cronInterval);
 let startTime;
 let createdJson;

 // Check if the user even exists
 if (!username || !(apiKey || accessToken)) {
Expand DownExpand Up@@ -204,16 +207,38 @@ class QueryScheduler {
 Logger.log(`Error ${res.status} while creating a grid`, 2);
 }

 return res.json().then((json) => {
 Logger.log(`Grid ${json.file.fid} has been updated.`, 2);
 return json;
 return res.json();
 }).then((json) => {
 createdJson = json;
 startTime = process.hrtime();

 return patchGrid(
 createdJson.file.fid,
 requestor,
 {
 metadata: {
 query,
 connectionId,
 connectorUrl: `https://${getSetting('CONNECTOR_HTTPS_DOMAIN')}:${getSetting('PORT_HTTPS')}`
 },
 refresh_interval: formattedRefresh
 }
 ).catch((e) => {
 /*
 * Warning: The front end looks for "MetadataError" in this error message. Don't change it!
 */
 throw new Error(`MetadataError: ${e.message}`);
 });
 }).then(() => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Grid ${createdJson.file.fid} has been updated.`, 2);
 return createdJson;
 });

 }

 queryAndUpdateGrid(fid, uids, query, connectionId, requestor) {
 queryAndUpdateGrid(fid, uids, query, connectionId, requestor, cronInterval, refreshInterval) {
 const requestedDBConnections = getConnectionById(connectionId);
 const formattedRefresh = refreshInterval || mapCronToRefresh(cronInterval);
 let startTime = process.hrtime();

 /*
Expand DownExpand Up@@ -337,13 +362,32 @@ class QueryScheduler {

 }

 startTime = process.hrtime();

 return patchGrid(
 fid,
 requestor,
 {
 metadata: {
 query,
 connectionId,
 connectorUrl: `https://${getSetting('CONNECTOR_HTTPS_DOMAIN')}:${getSetting('PORT_HTTPS')}`
 },
 refresh_interval: formattedRefresh
 }
 ).catch((e) => {
 /*
 * Warning: The front end looks for "MetadataError" in this error message. Don't change it!
 */
 throw new Error(`MetadataError: ${e.message}`);
 });
 }).then((res) => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);
 return res.json().then(() => {
 Logger.log(`Grid ${fid} has been updated.`, 2);
 });
 });

 }

}

export default QueryScheduler;
Expand Down

12 changes: 12 additions & 0 deletions
backend/persistent/plotly-api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -152,6 +152,18 @@ export function deleteGrid(fid, requestor) {
 });
}

export function patchGrid(fid, requestor, body) {
 const {username, apiKey, accessToken} = getCredentials(requestor);

 return plotlyAPIRequest(`grids/${fid}`, {
 method: 'PATCH',
 username,
 apiKey,
 accessToken,
 body
 });
}

export function updateGrid(rows, fid, uids, requestor) {
 const {username, apiKey, accessToken} = getCredentials(requestor);

Expand Down

15 changes: 12 additions & 3 deletions
backend/routes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -664,13 +664,22 @@ export default class Servers {
 * the endpoint `/queries/:fid`
 */
 server.post('/queries', function postQueriesHandler(req, res, next) {
 const {filename, fid, uids, query, connectionId, requestor} = req.params;
 const {
 filename,
 fid,
 uids,
 query,
 connectionId,
 requestor,
 cronInterval = null,
@n-riescon-riescoAug 1, 2018

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

out of curiosity, why setting the default to 'null'?
 refreshInterval = null
 } = req.params;

 // If a filename has been provided,
 // make the query and create a new grid
 if (filename) {
 return that.queryScheduler.queryAndCreateGrid(
 filename, query, connectionId, requestor
 filename, query, connectionId, requestor, cronInterval, refreshInterval
 )
 .then((newGridResponse) => {
 const queryObject = {
Expand All@@ -691,7 +700,7 @@ export default class Servers {
 if (fid) {
 return checkWritePermissions(fid, requestor).then(function () {
 return that.queryScheduler.queryAndUpdateGrid(
 fid, uids, query, connectionId, requestor
 fid, uids, query, connectionId, requestor, cronInterval, refreshInterval
 );
 })
 .then(() => {
Expand Down

20 changes: 20 additions & 0 deletions
backend/utils/cronUtils.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,26 @@ export function mapRefreshToCron (refreshInterval) {
 return `${now.getMinutes()} ${now.getHours()} * * ${now.getDay()}`;
}

export function mapCronToRefresh (cronInterval) {
 const DEFAULT_INTERVAL = 60 * 60 * 24 * 7; // default to weekly

 if (!cronInterval) {
 return DEFAULT_INTERVAL;
 }

 if (cronInterval === '* * * * *') {
 return 60;
 } else if (cronInterval === '*/5 * * * *') {
 return 60 * 5;
 } else if (cronInterval.match(/\S+? \* \* \* \*/)) {
@n-riescon-riescoAug 1, 2018

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this throws when cronInterval is null
 return 60 * 60;
 } else if (cronInterval.match(/\S+? \S+? \* \* \*/)) {
 return 60 * 60 * 24;
 }

 return DEFAULT_INTERVAL;
}

function computeMinutes (now) {
 let currMinute = now.getMinutes() % 5; // start at 5 min offset
 const minutes = [];
Expand Down

3 changes: 0 additions & 3 deletions
test/app/components/Settings/scheduler/create-modal.test.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ global.document.createRange = function() {

const wait = () => new Promise(resolve => setTimeout(resolve, 0));

const {DEFAULT_REFRESH_INTERVAL} = require('../../../../../app/constants/constants');
const CodeMirror = require('react-codemirror2').Controlled;
const CreateModal = require('../../../../../app/components/Settings/scheduler/create-modal.jsx');
const ErrorComponent = require('../../../../../app/components/error.jsx');
Expand DownExpand Up@@ -93,15 +92,13 @@ describe('Create Modal Test', () => {
 // Once filename input is supported, this value should be: 'filename',
 filename: expect.any(String),
 query: 'SELECT * FROM foods',
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 cronInterval
 })
 );
 expect(onSubmit).toHaveBeenCalledWith({
 // Once filename input is supported, this value should be: 'filename',
 filename: expect.any(String),
 query: 'SELECT * FROM foods',
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 cronInterval,
 name
 });
Expand Down

5 changes: 1 addition & 4 deletions
test/app/components/Settings/scheduler/preview-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@ global.document.createRange = function() {
};

const PreviewModal = require('../../../../../app/components/Settings/scheduler/preview-modal.jsx').default;
const {DEFAULT_REFRESH_INTERVAL} = require('../../../../../app/constants/constants');

describe('Preview Modal Tests', () => {
 beforeAll(() => {
Expand DownExpand Up@@ -155,9 +154,7 @@ describe('Preview Modal Tests', () => {
 fid: 'fid:1',
 requestor: 'user',
 query: 'SELECT * FROM table',
 cronInterval: '* * * * *',
 // This is necessary to prevent older versions from breaking
 refreshInterval: DEFAULT_REFRESH_INTERVAL
 cronInterval: '* * * * *'
 })
 );
 });
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content

This repository was archived by the owner on Aug 29, 2025. It is now read-only.

[WIP] upload scheduled query metadata#504
 Merged

n-riesco
merged 6 commits into

from

Aug 3, 2018
 Merged


[WIP] upload scheduled query metadata
#504
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
53e2869

remove setting of default refreshInterval from frontend


briandennis Jul 31, 2018
47d161d

add backend support for uploading metadata on create/update of queries


briandennis Jul 31, 2018
4f187b9

avoid throwing on null cronInterval in mapCronToRefresh


briandennis Aug 1, 2018
4bbfc6e

use mapCronToRefresh to set default refresh interval


briandennis Aug 2, 2018
e9f7a91

update jest tests to account for refreshInterval not being set by fro…


briandennis Aug 2, 2018
97dd563

add metadata specific error message


briandennis Aug 3, 2018

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 0 additions & 2 deletions
app/actions/sessions.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,7 +166,6 @@ export function createScheduledQuery(connectionId, payload = {}) {
 fid: payload.fid,
 filename: payload.filename,
 name: payload.name,
 refreshInterval: payload.refreshInterval,
 query: payload.query,
 cronInterval: payload.cronInterval,
 connectionId
Expand All@@ -189,7 +188,6 @@ export function updateScheduledQuery(connectionId, payload = {}) {
 fid: payload.fid,
 filename: payload.filename,
 name: payload.name,
 refreshInterval: payload.refreshInterval,
 query: payload.query,
 cronInterval: payload.cronInterval,
 connectionId
Expand Down

8 changes: 1 addition & 7 deletions
app/components/Settings/scheduler/create-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,12 +12,7 @@ import TimedMessage from './timed-message.jsx';
import CronPicker from '../cron-picker/cron-picker.jsx';
import SQL from './sql.jsx';

import {
 getHighlightMode,
 DEFAULT_REFRESH_INTERVAL,
 WAITING_MESSAGE,
 SAVE_WARNING
} from '../../../constants/constants.js';
import {getHighlightMode, WAITING_MESSAGE, SAVE_WARNING} from '../../../constants/constants.js';

import './create-modal.css';

Expand DownExpand Up@@ -109,7 +104,6 @@ class CreateModal extends Component {
 this.props
 .onSubmit({
 query: this.state.code,
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 filename: generateFilename(),
 cronInterval: this.state.interval,
 name: this.state.name ? this.state.name.trim() : ''
Expand Down

12 changes: 3 additions & 9 deletions
app/components/Settings/scheduler/preview-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,7 @@ import CronPicker from '../cron-picker/cron-picker.jsx';
import {Row, Column} from '../../layout.jsx';
import SQL from './sql.jsx';
import {plotlyUrl} from '../../../utils/utils.js';
import {
 getHighlightMode,
 DEFAULT_REFRESH_INTERVAL,
 WAITING_MESSAGE,
 SAVE_WARNING
} from '../../../constants/constants.js';
import {getHighlightMode, WAITING_MESSAGE, SAVE_WARNING} from '../../../constants/constants.js';
import {getInitialCronMode} from '../cron-picker/cron-helpers.js';

const NO_OP = () => {};
Expand DownExpand Up@@ -85,7 +80,7 @@ export class PreviewModal extends Component {

 onSubmit() {
 if (this.state.editing) {
 const {connectionId, fid, requestor, uids, refreshInterval} = this.props.query;
 const {connectionId, fid, requestor, uids} = this.props.query;
 const {code: query, cronInterval} = this.state;
 const name = this.state.name ? this.state.name.trim() : '';

Expand All@@ -98,8 +93,7 @@ export class PreviewModal extends Component {
 uids,
 query,
 name,
 cronInterval,
 refreshInterval: refreshInterval || DEFAULT_REFRESH_INTERVAL
 cronInterval
 })
 .then(() => {
 this.setState({
Expand Down

11 changes: 11 additions & 0 deletions
app/components/Settings/scheduler/request-error.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,17 @@ function FormattedMessage(props) {
 );
 }

 if (content.startsWith('MetadataError')) {
 return (
 <details style={outlineStyle}>
 <summary style={outlineStyle}>
 An unexpected error occurred while uploading query metadata. Please try again now.
 </summary>
 <pre>{capitalize(content.replace('MetadataError: ', ''))}</pre>
 </details>
 );
 }

 return content.slice(0, 100);
}

Expand Down

6 changes: 0 additions & 6 deletions
app/constants/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,12 +2,6 @@
/* eslint-disable no-multi-str */
import {concat} from 'ramda';

/**
 * Default to '1 week' for `refreshInterval` for backwards compatability. For
 * older versions this will prevent issues such as `setInterval(runQuery, NaN)`
 */
export const DEFAULT_REFRESH_INTERVAL = 7 * 24 * 60 * 60;

export const DIALECTS = {
 MYSQL: 'mysql',
 MARIADB: 'mariadb',
Expand Down

64 changes: 54 additions & 10 deletions
backend/persistent/QueryScheduler.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import * as scheduler from 'node-schedule';

import {getConnectionById} from './Connections.js';
import * as Connections from './datastores/Datastores.js';
import { mapRefreshToCron } from '../utils/cronUtils.js';
import { mapRefreshToCron, mapCronToRefresh } from '../utils/cronUtils.js';
import Logger from '../logger';
import {
 getQuery,
Expand All@@ -19,6 +19,7 @@ import {
 getCurrentUser,
 getGridMeta,
 newGrid,
 patchGrid,
 updateGrid
} from './plotly-api.js';

Expand DownExpand Up@@ -97,7 +98,7 @@ class QueryScheduler {
 requestor,
 fid,
 uids,
 refreshInterval,
 refreshInterval: refreshInterval || mapCronToRefresh(cronInterval),
 cronInterval,
 query,
 connectionId
Expand DownExpand Up@@ -142,9 +143,11 @@ class QueryScheduler {
 Object.keys(this.queryJobs).forEach(this.clearQuery);
 }

 queryAndCreateGrid(filename, query, connectionId, requestor) {
 queryAndCreateGrid(filename, query, connectionId, requestor, cronInterval, refreshInterval) {
 const {username, apiKey, accessToken} = getCredentials(requestor);
 const formattedRefresh = refreshInterval || mapCronToRefresh(cronInterval);
 let startTime;
 let createdJson;

 // Check if the user even exists
 if (!username || !(apiKey || accessToken)) {
Expand DownExpand Up@@ -204,16 +207,38 @@ class QueryScheduler {
 Logger.log(`Error ${res.status} while creating a grid`, 2);
 }

 return res.json().then((json) => {
 Logger.log(`Grid ${json.file.fid} has been updated.`, 2);
 return json;
 return res.json();
 }).then((json) => {
 createdJson = json;
 startTime = process.hrtime();

 return patchGrid(
 createdJson.file.fid,
 requestor,
 {
 metadata: {
 query,
 connectionId,
 connectorUrl: `https://${getSetting('CONNECTOR_HTTPS_DOMAIN')}:${getSetting('PORT_HTTPS')}`
 },
 refresh_interval: formattedRefresh
 }
 ).catch((e) => {
 /*
 * Warning: The front end looks for "MetadataError" in this error message. Don't change it!
 */
 throw new Error(`MetadataError: ${e.message}`);
 });
 }).then(() => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Grid ${createdJson.file.fid} has been updated.`, 2);
 return createdJson;
 });

 }

 queryAndUpdateGrid(fid, uids, query, connectionId, requestor) {
 queryAndUpdateGrid(fid, uids, query, connectionId, requestor, cronInterval, refreshInterval) {
 const requestedDBConnections = getConnectionById(connectionId);
 const formattedRefresh = refreshInterval || mapCronToRefresh(cronInterval);
 let startTime = process.hrtime();

 /*
Expand DownExpand Up@@ -337,13 +362,32 @@ class QueryScheduler {

 }

 startTime = process.hrtime();

 return patchGrid(
 fid,
 requestor,
 {
 metadata: {
 query,
 connectionId,
 connectorUrl: `https://${getSetting('CONNECTOR_HTTPS_DOMAIN')}:${getSetting('PORT_HTTPS')}`
 },
 refresh_interval: formattedRefresh
 }
 ).catch((e) => {
 /*
 * Warning: The front end looks for "MetadataError" in this error message. Don't change it!
 */
 throw new Error(`MetadataError: ${e.message}`);
 });
 }).then((res) => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);
 return res.json().then(() => {
 Logger.log(`Grid ${fid} has been updated.`, 2);
 });
 });

 }

}

export default QueryScheduler;
Expand Down

12 changes: 12 additions & 0 deletions
backend/persistent/plotly-api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -152,6 +152,18 @@ export function deleteGrid(fid, requestor) {
 });
}

export function patchGrid(fid, requestor, body) {
 const {username, apiKey, accessToken} = getCredentials(requestor);

 return plotlyAPIRequest(`grids/${fid}`, {
 method: 'PATCH',
 username,
 apiKey,
 accessToken,
 body
 });
}

export function updateGrid(rows, fid, uids, requestor) {
 const {username, apiKey, accessToken} = getCredentials(requestor);

Expand Down

15 changes: 12 additions & 3 deletions
backend/routes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -664,13 +664,22 @@ export default class Servers {
 * the endpoint `/queries/:fid`
 */
 server.post('/queries', function postQueriesHandler(req, res, next) {
 const {filename, fid, uids, query, connectionId, requestor} = req.params;
 const {
 filename,
 fid,
 uids,
 query,
 connectionId,
 requestor,
 cronInterval = null,
@n-riescon-riescoAug 1, 2018

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

out of curiosity, why setting the default to 'null'?
 refreshInterval = null
 } = req.params;

 // If a filename has been provided,
 // make the query and create a new grid
 if (filename) {
 return that.queryScheduler.queryAndCreateGrid(
 filename, query, connectionId, requestor
 filename, query, connectionId, requestor, cronInterval, refreshInterval
 )
 .then((newGridResponse) => {
 const queryObject = {
Expand All@@ -691,7 +700,7 @@ export default class Servers {
 if (fid) {
 return checkWritePermissions(fid, requestor).then(function () {
 return that.queryScheduler.queryAndUpdateGrid(
 fid, uids, query, connectionId, requestor
 fid, uids, query, connectionId, requestor, cronInterval, refreshInterval
 );
 })
 .then(() => {
Expand Down

20 changes: 20 additions & 0 deletions
backend/utils/cronUtils.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,26 @@ export function mapRefreshToCron (refreshInterval) {
 return `${now.getMinutes()} ${now.getHours()} * * ${now.getDay()}`;
}

export function mapCronToRefresh (cronInterval) {
 const DEFAULT_INTERVAL = 60 * 60 * 24 * 7; // default to weekly

 if (!cronInterval) {
 return DEFAULT_INTERVAL;
 }

 if (cronInterval === '* * * * *') {
 return 60;
 } else if (cronInterval === '*/5 * * * *') {
 return 60 * 5;
 } else if (cronInterval.match(/\S+? \* \* \* \*/)) {
@n-riescon-riescoAug 1, 2018

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this throws when cronInterval is null
 return 60 * 60;
 } else if (cronInterval.match(/\S+? \S+? \* \* \*/)) {
 return 60 * 60 * 24;
 }

 return DEFAULT_INTERVAL;
}

function computeMinutes (now) {
 let currMinute = now.getMinutes() % 5; // start at 5 min offset
 const minutes = [];
Expand Down

3 changes: 0 additions & 3 deletions
test/app/components/Settings/scheduler/create-modal.test.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ global.document.createRange = function() {

const wait = () => new Promise(resolve => setTimeout(resolve, 0));

const {DEFAULT_REFRESH_INTERVAL} = require('../../../../../app/constants/constants');
const CodeMirror = require('react-codemirror2').Controlled;
const CreateModal = require('../../../../../app/components/Settings/scheduler/create-modal.jsx');
const ErrorComponent = require('../../../../../app/components/error.jsx');
Expand DownExpand Up@@ -93,15 +92,13 @@ describe('Create Modal Test', () => {
 // Once filename input is supported, this value should be: 'filename',
 filename: expect.any(String),
 query: 'SELECT * FROM foods',
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 cronInterval
 })
 );
 expect(onSubmit).toHaveBeenCalledWith({
 // Once filename input is supported, this value should be: 'filename',
 filename: expect.any(String),
 query: 'SELECT * FROM foods',
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 cronInterval,
 name
 });
Expand Down

5 changes: 1 addition & 4 deletions
test/app/components/Settings/scheduler/preview-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@ global.document.createRange = function() {
};

const PreviewModal = require('../../../../../app/components/Settings/scheduler/preview-modal.jsx').default;
const {DEFAULT_REFRESH_INTERVAL} = require('../../../../../app/constants/constants');

describe('Preview Modal Tests', () => {
 beforeAll(() => {
Expand DownExpand Up@@ -155,9 +154,7 @@ describe('Preview Modal Tests', () => {
 fid: 'fid:1',
 requestor: 'user',
 query: 'SELECT * FROM table',
 cronInterval: '* * * * *',
 // This is necessary to prevent older versions from breaking
 refreshInterval: DEFAULT_REFRESH_INTERVAL
 cronInterval: '* * * * *'
 })
 );
 });
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content

This repository was archived by the owner on Aug 29, 2025. It is now read-only.

[WIP] upload scheduled query metadata#504
 Merged

n-riesco
merged 6 commits into

from

Aug 3, 2018
 Merged


[WIP] upload scheduled query metadata
#504
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
53e2869

remove setting of default refreshInterval from frontend


briandennis Jul 31, 2018
47d161d

add backend support for uploading metadata on create/update of queries


briandennis Jul 31, 2018
4f187b9

avoid throwing on null cronInterval in mapCronToRefresh


briandennis Aug 1, 2018
4bbfc6e

use mapCronToRefresh to set default refresh interval


briandennis Aug 2, 2018
e9f7a91

update jest tests to account for refreshInterval not being set by fro…


briandennis Aug 2, 2018
97dd563

add metadata specific error message


briandennis Aug 3, 2018

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 0 additions & 2 deletions
app/actions/sessions.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,7 +166,6 @@ export function createScheduledQuery(connectionId, payload = {}) {
 fid: payload.fid,
 filename: payload.filename,
 name: payload.name,
 refreshInterval: payload.refreshInterval,
 query: payload.query,
 cronInterval: payload.cronInterval,
 connectionId
Expand All@@ -189,7 +188,6 @@ export function updateScheduledQuery(connectionId, payload = {}) {
 fid: payload.fid,
 filename: payload.filename,
 name: payload.name,
 refreshInterval: payload.refreshInterval,
 query: payload.query,
 cronInterval: payload.cronInterval,
 connectionId
Expand Down

8 changes: 1 addition & 7 deletions
app/components/Settings/scheduler/create-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,12 +12,7 @@ import TimedMessage from './timed-message.jsx';
import CronPicker from '../cron-picker/cron-picker.jsx';
import SQL from './sql.jsx';

import {
 getHighlightMode,
 DEFAULT_REFRESH_INTERVAL,
 WAITING_MESSAGE,
 SAVE_WARNING
} from '../../../constants/constants.js';
import {getHighlightMode, WAITING_MESSAGE, SAVE_WARNING} from '../../../constants/constants.js';

import './create-modal.css';

Expand DownExpand Up@@ -109,7 +104,6 @@ class CreateModal extends Component {
 this.props
 .onSubmit({
 query: this.state.code,
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 filename: generateFilename(),
 cronInterval: this.state.interval,
 name: this.state.name ? this.state.name.trim() : ''
Expand Down

12 changes: 3 additions & 9 deletions
app/components/Settings/scheduler/preview-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,7 @@ import CronPicker from '../cron-picker/cron-picker.jsx';
import {Row, Column} from '../../layout.jsx';
import SQL from './sql.jsx';
import {plotlyUrl} from '../../../utils/utils.js';
import {
 getHighlightMode,
 DEFAULT_REFRESH_INTERVAL,
 WAITING_MESSAGE,
 SAVE_WARNING
} from '../../../constants/constants.js';
import {getHighlightMode, WAITING_MESSAGE, SAVE_WARNING} from '../../../constants/constants.js';
import {getInitialCronMode} from '../cron-picker/cron-helpers.js';

const NO_OP = () => {};
Expand DownExpand Up@@ -85,7 +80,7 @@ export class PreviewModal extends Component {

 onSubmit() {
 if (this.state.editing) {
 const {connectionId, fid, requestor, uids, refreshInterval} = this.props.query;
 const {connectionId, fid, requestor, uids} = this.props.query;
 const {code: query, cronInterval} = this.state;
 const name = this.state.name ? this.state.name.trim() : '';

Expand All@@ -98,8 +93,7 @@ export class PreviewModal extends Component {
 uids,
 query,
 name,
 cronInterval,
 refreshInterval: refreshInterval || DEFAULT_REFRESH_INTERVAL
 cronInterval
 })
 .then(() => {
 this.setState({
Expand Down

11 changes: 11 additions & 0 deletions
app/components/Settings/scheduler/request-error.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,17 @@ function FormattedMessage(props) {
 );
 }

 if (content.startsWith('MetadataError')) {
 return (
 <details style={outlineStyle}>
 <summary style={outlineStyle}>
 An unexpected error occurred while uploading query metadata. Please try again now.
 </summary>
 <pre>{capitalize(content.replace('MetadataError: ', ''))}</pre>
 </details>
 );
 }

 return content.slice(0, 100);
}

Expand Down

6 changes: 0 additions & 6 deletions
app/constants/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,12 +2,6 @@
/* eslint-disable no-multi-str */
import {concat} from 'ramda';

/**
 * Default to '1 week' for `refreshInterval` for backwards compatability. For
 * older versions this will prevent issues such as `setInterval(runQuery, NaN)`
 */
export const DEFAULT_REFRESH_INTERVAL = 7 * 24 * 60 * 60;

export const DIALECTS = {
 MYSQL: 'mysql',
 MARIADB: 'mariadb',
Expand Down

64 changes: 54 additions & 10 deletions
backend/persistent/QueryScheduler.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import * as scheduler from 'node-schedule';

import {getConnectionById} from './Connections.js';
import * as Connections from './datastores/Datastores.js';
import { mapRefreshToCron } from '../utils/cronUtils.js';
import { mapRefreshToCron, mapCronToRefresh } from '../utils/cronUtils.js';
import Logger from '../logger';
import {
 getQuery,
Expand All@@ -19,6 +19,7 @@ import {
 getCurrentUser,
 getGridMeta,
 newGrid,
 patchGrid,
 updateGrid
} from './plotly-api.js';

Expand DownExpand Up@@ -97,7 +98,7 @@ class QueryScheduler {
 requestor,
 fid,
 uids,
 refreshInterval,
 refreshInterval: refreshInterval || mapCronToRefresh(cronInterval),
 cronInterval,
 query,
 connectionId
Expand DownExpand Up@@ -142,9 +143,11 @@ class QueryScheduler {
 Object.keys(this.queryJobs).forEach(this.clearQuery);
 }

 queryAndCreateGrid(filename, query, connectionId, requestor) {
 queryAndCreateGrid(filename, query, connectionId, requestor, cronInterval, refreshInterval) {
 const {username, apiKey, accessToken} = getCredentials(requestor);
 const formattedRefresh = refreshInterval || mapCronToRefresh(cronInterval);
 let startTime;
 let createdJson;

 // Check if the user even exists
 if (!username || !(apiKey || accessToken)) {
Expand DownExpand Up@@ -204,16 +207,38 @@ class QueryScheduler {
 Logger.log(`Error ${res.status} while creating a grid`, 2);
 }

 return res.json().then((json) => {
 Logger.log(`Grid ${json.file.fid} has been updated.`, 2);
 return json;
 return res.json();
 }).then((json) => {
 createdJson = json;
 startTime = process.hrtime();

 return patchGrid(
 createdJson.file.fid,
 requestor,
 {
 metadata: {
 query,
 connectionId,
 connectorUrl: `https://${getSetting('CONNECTOR_HTTPS_DOMAIN')}:${getSetting('PORT_HTTPS')}`
 },
 refresh_interval: formattedRefresh
 }
 ).catch((e) => {
 /*
 * Warning: The front end looks for "MetadataError" in this error message. Don't change it!
 */
 throw new Error(`MetadataError: ${e.message}`);
 });
 }).then(() => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Grid ${createdJson.file.fid} has been updated.`, 2);
 return createdJson;
 });

 }

 queryAndUpdateGrid(fid, uids, query, connectionId, requestor) {
 queryAndUpdateGrid(fid, uids, query, connectionId, requestor, cronInterval, refreshInterval) {
 const requestedDBConnections = getConnectionById(connectionId);
 const formattedRefresh = refreshInterval || mapCronToRefresh(cronInterval);
 let startTime = process.hrtime();

 /*
Expand DownExpand Up@@ -337,13 +362,32 @@ class QueryScheduler {

 }

 startTime = process.hrtime();

 return patchGrid(
 fid,
 requestor,
 {
 metadata: {
 query,
 connectionId,
 connectorUrl: `https://${getSetting('CONNECTOR_HTTPS_DOMAIN')}:${getSetting('PORT_HTTPS')}`
 },
 refresh_interval: formattedRefresh
 }
 ).catch((e) => {
 /*
 * Warning: The front end looks for "MetadataError" in this error message. Don't change it!
 */
 throw new Error(`MetadataError: ${e.message}`);
 });
 }).then((res) => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);
 return res.json().then(() => {
 Logger.log(`Grid ${fid} has been updated.`, 2);
 });
 });

 }

}

export default QueryScheduler;
Expand Down

12 changes: 12 additions & 0 deletions
backend/persistent/plotly-api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -152,6 +152,18 @@ export function deleteGrid(fid, requestor) {
 });
}

export function patchGrid(fid, requestor, body) {
 const {username, apiKey, accessToken} = getCredentials(requestor);

 return plotlyAPIRequest(`grids/${fid}`, {
 method: 'PATCH',
 username,
 apiKey,
 accessToken,
 body
 });
}

export function updateGrid(rows, fid, uids, requestor) {
 const {username, apiKey, accessToken} = getCredentials(requestor);

Expand Down

15 changes: 12 additions & 3 deletions
backend/routes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -664,13 +664,22 @@ export default class Servers {
 * the endpoint `/queries/:fid`
 */
 server.post('/queries', function postQueriesHandler(req, res, next) {
 const {filename, fid, uids, query, connectionId, requestor} = req.params;
 const {
 filename,
 fid,
 uids,
 query,
 connectionId,
 requestor,
 cronInterval = null,
@n-riescon-riescoAug 1, 2018

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

out of curiosity, why setting the default to 'null'?
 refreshInterval = null
 } = req.params;

 // If a filename has been provided,
 // make the query and create a new grid
 if (filename) {
 return that.queryScheduler.queryAndCreateGrid(
 filename, query, connectionId, requestor
 filename, query, connectionId, requestor, cronInterval, refreshInterval
 )
 .then((newGridResponse) => {
 const queryObject = {
Expand All@@ -691,7 +700,7 @@ export default class Servers {
 if (fid) {
 return checkWritePermissions(fid, requestor).then(function () {
 return that.queryScheduler.queryAndUpdateGrid(
 fid, uids, query, connectionId, requestor
 fid, uids, query, connectionId, requestor, cronInterval, refreshInterval
 );
 })
 .then(() => {
Expand Down

20 changes: 20 additions & 0 deletions
backend/utils/cronUtils.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,26 @@ export function mapRefreshToCron (refreshInterval) {
 return `${now.getMinutes()} ${now.getHours()} * * ${now.getDay()}`;
}

export function mapCronToRefresh (cronInterval) {
 const DEFAULT_INTERVAL = 60 * 60 * 24 * 7; // default to weekly

 if (!cronInterval) {
 return DEFAULT_INTERVAL;
 }

 if (cronInterval === '* * * * *') {
 return 60;
 } else if (cronInterval === '*/5 * * * *') {
 return 60 * 5;
 } else if (cronInterval.match(/\S+? \* \* \* \*/)) {
@n-riescon-riescoAug 1, 2018

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this throws when cronInterval is null
 return 60 * 60;
 } else if (cronInterval.match(/\S+? \S+? \* \* \*/)) {
 return 60 * 60 * 24;
 }

 return DEFAULT_INTERVAL;
}

function computeMinutes (now) {
 let currMinute = now.getMinutes() % 5; // start at 5 min offset
 const minutes = [];
Expand Down

3 changes: 0 additions & 3 deletions
test/app/components/Settings/scheduler/create-modal.test.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ global.document.createRange = function() {

const wait = () => new Promise(resolve => setTimeout(resolve, 0));

const {DEFAULT_REFRESH_INTERVAL} = require('../../../../../app/constants/constants');
const CodeMirror = require('react-codemirror2').Controlled;
const CreateModal = require('../../../../../app/components/Settings/scheduler/create-modal.jsx');
const ErrorComponent = require('../../../../../app/components/error.jsx');
Expand DownExpand Up@@ -93,15 +92,13 @@ describe('Create Modal Test', () => {
 // Once filename input is supported, this value should be: 'filename',
 filename: expect.any(String),
 query: 'SELECT * FROM foods',
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 cronInterval
 })
 );
 expect(onSubmit).toHaveBeenCalledWith({
 // Once filename input is supported, this value should be: 'filename',
 filename: expect.any(String),
 query: 'SELECT * FROM foods',
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 cronInterval,
 name
 });
Expand Down

5 changes: 1 addition & 4 deletions
test/app/components/Settings/scheduler/preview-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@ global.document.createRange = function() {
};

const PreviewModal = require('../../../../../app/components/Settings/scheduler/preview-modal.jsx').default;
const {DEFAULT_REFRESH_INTERVAL} = require('../../../../../app/constants/constants');

describe('Preview Modal Tests', () => {
 beforeAll(() => {
Expand DownExpand Up@@ -155,9 +154,7 @@ describe('Preview Modal Tests', () => {
 fid: 'fid:1',
 requestor: 'user',
 query: 'SELECT * FROM table',
 cronInterval: '* * * * *',
 // This is necessary to prevent older versions from breaking
 refreshInterval: DEFAULT_REFRESH_INTERVAL
 cronInterval: '* * * * *'
 })
 );
 });
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content

This repository was archived by the owner on Aug 29, 2025. It is now read-only.

[WIP] upload scheduled query metadata#504
 Merged

n-riesco
merged 6 commits into

from

Aug 3, 2018
 Merged


[WIP] upload scheduled query metadata
#504
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
53e2869

remove setting of default refreshInterval from frontend


briandennis Jul 31, 2018
47d161d

add backend support for uploading metadata on create/update of queries


briandennis Jul 31, 2018
4f187b9

avoid throwing on null cronInterval in mapCronToRefresh


briandennis Aug 1, 2018
4bbfc6e

use mapCronToRefresh to set default refresh interval


briandennis Aug 2, 2018
e9f7a91

update jest tests to account for refreshInterval not being set by fro…


briandennis Aug 2, 2018
97dd563

add metadata specific error message


briandennis Aug 3, 2018

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 0 additions & 2 deletions
app/actions/sessions.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,7 +166,6 @@ export function createScheduledQuery(connectionId, payload = {}) {
 fid: payload.fid,
 filename: payload.filename,
 name: payload.name,
 refreshInterval: payload.refreshInterval,
 query: payload.query,
 cronInterval: payload.cronInterval,
 connectionId
Expand All@@ -189,7 +188,6 @@ export function updateScheduledQuery(connectionId, payload = {}) {
 fid: payload.fid,
 filename: payload.filename,
 name: payload.name,
 refreshInterval: payload.refreshInterval,
 query: payload.query,
 cronInterval: payload.cronInterval,
 connectionId
Expand Down

8 changes: 1 addition & 7 deletions
app/components/Settings/scheduler/create-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,12 +12,7 @@ import TimedMessage from './timed-message.jsx';
import CronPicker from '../cron-picker/cron-picker.jsx';
import SQL from './sql.jsx';

import {
 getHighlightMode,
 DEFAULT_REFRESH_INTERVAL,
 WAITING_MESSAGE,
 SAVE_WARNING
} from '../../../constants/constants.js';
import {getHighlightMode, WAITING_MESSAGE, SAVE_WARNING} from '../../../constants/constants.js';

import './create-modal.css';

Expand DownExpand Up@@ -109,7 +104,6 @@ class CreateModal extends Component {
 this.props
 .onSubmit({
 query: this.state.code,
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 filename: generateFilename(),
 cronInterval: this.state.interval,
 name: this.state.name ? this.state.name.trim() : ''
Expand Down

12 changes: 3 additions & 9 deletions
app/components/Settings/scheduler/preview-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,7 @@ import CronPicker from '../cron-picker/cron-picker.jsx';
import {Row, Column} from '../../layout.jsx';
import SQL from './sql.jsx';
import {plotlyUrl} from '../../../utils/utils.js';
import {
 getHighlightMode,
 DEFAULT_REFRESH_INTERVAL,
 WAITING_MESSAGE,
 SAVE_WARNING
} from '../../../constants/constants.js';
import {getHighlightMode, WAITING_MESSAGE, SAVE_WARNING} from '../../../constants/constants.js';
import {getInitialCronMode} from '../cron-picker/cron-helpers.js';

const NO_OP = () => {};
Expand DownExpand Up@@ -85,7 +80,7 @@ export class PreviewModal extends Component {

 onSubmit() {
 if (this.state.editing) {
 const {connectionId, fid, requestor, uids, refreshInterval} = this.props.query;
 const {connectionId, fid, requestor, uids} = this.props.query;
 const {code: query, cronInterval} = this.state;
 const name = this.state.name ? this.state.name.trim() : '';

Expand All@@ -98,8 +93,7 @@ export class PreviewModal extends Component {
 uids,
 query,
 name,
 cronInterval,
 refreshInterval: refreshInterval || DEFAULT_REFRESH_INTERVAL
 cronInterval
 })
 .then(() => {
 this.setState({
Expand Down

11 changes: 11 additions & 0 deletions
app/components/Settings/scheduler/request-error.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,17 @@ function FormattedMessage(props) {
 );
 }

 if (content.startsWith('MetadataError')) {
 return (
 <details style={outlineStyle}>
 <summary style={outlineStyle}>
 An unexpected error occurred while uploading query metadata. Please try again now.
 </summary>
 <pre>{capitalize(content.replace('MetadataError: ', ''))}</pre>
 </details>
 );
 }

 return content.slice(0, 100);
}

Expand Down

6 changes: 0 additions & 6 deletions
app/constants/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,12 +2,6 @@
/* eslint-disable no-multi-str */
import {concat} from 'ramda';

/**
 * Default to '1 week' for `refreshInterval` for backwards compatability. For
 * older versions this will prevent issues such as `setInterval(runQuery, NaN)`
 */
export const DEFAULT_REFRESH_INTERVAL = 7 * 24 * 60 * 60;

export const DIALECTS = {
 MYSQL: 'mysql',
 MARIADB: 'mariadb',
Expand Down

64 changes: 54 additions & 10 deletions
backend/persistent/QueryScheduler.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import * as scheduler from 'node-schedule';

import {getConnectionById} from './Connections.js';
import * as Connections from './datastores/Datastores.js';
import { mapRefreshToCron } from '../utils/cronUtils.js';
import { mapRefreshToCron, mapCronToRefresh } from '../utils/cronUtils.js';
import Logger from '../logger';
import {
 getQuery,
Expand All@@ -19,6 +19,7 @@ import {
 getCurrentUser,
 getGridMeta,
 newGrid,
 patchGrid,
 updateGrid
} from './plotly-api.js';

Expand DownExpand Up@@ -97,7 +98,7 @@ class QueryScheduler {
 requestor,
 fid,
 uids,
 refreshInterval,
 refreshInterval: refreshInterval || mapCronToRefresh(cronInterval),
 cronInterval,
 query,
 connectionId
Expand DownExpand Up@@ -142,9 +143,11 @@ class QueryScheduler {
 Object.keys(this.queryJobs).forEach(this.clearQuery);
 }

 queryAndCreateGrid(filename, query, connectionId, requestor) {
 queryAndCreateGrid(filename, query, connectionId, requestor, cronInterval, refreshInterval) {
 const {username, apiKey, accessToken} = getCredentials(requestor);
 const formattedRefresh = refreshInterval || mapCronToRefresh(cronInterval);
 let startTime;
 let createdJson;

 // Check if the user even exists
 if (!username || !(apiKey || accessToken)) {
Expand DownExpand Up@@ -204,16 +207,38 @@ class QueryScheduler {
 Logger.log(`Error ${res.status} while creating a grid`, 2);
 }

 return res.json().then((json) => {
 Logger.log(`Grid ${json.file.fid} has been updated.`, 2);
 return json;
 return res.json();
 }).then((json) => {
 createdJson = json;
 startTime = process.hrtime();

 return patchGrid(
 createdJson.file.fid,
 requestor,
 {
 metadata: {
 query,
 connectionId,
 connectorUrl: `https://${getSetting('CONNECTOR_HTTPS_DOMAIN')}:${getSetting('PORT_HTTPS')}`
 },
 refresh_interval: formattedRefresh
 }
 ).catch((e) => {
 /*
 * Warning: The front end looks for "MetadataError" in this error message. Don't change it!
 */
 throw new Error(`MetadataError: ${e.message}`);
 });
 }).then(() => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Grid ${createdJson.file.fid} has been updated.`, 2);
 return createdJson;
 });

 }

 queryAndUpdateGrid(fid, uids, query, connectionId, requestor) {
 queryAndUpdateGrid(fid, uids, query, connectionId, requestor, cronInterval, refreshInterval) {
 const requestedDBConnections = getConnectionById(connectionId);
 const formattedRefresh = refreshInterval || mapCronToRefresh(cronInterval);
 let startTime = process.hrtime();

 /*
Expand DownExpand Up@@ -337,13 +362,32 @@ class QueryScheduler {

 }

 startTime = process.hrtime();

 return patchGrid(
 fid,
 requestor,
 {
 metadata: {
 query,
 connectionId,
 connectorUrl: `https://${getSetting('CONNECTOR_HTTPS_DOMAIN')}:${getSetting('PORT_HTTPS')}`
 },
 refresh_interval: formattedRefresh
 }
 ).catch((e) => {
 /*
 * Warning: The front end looks for "MetadataError" in this error message. Don't change it!
 */
 throw new Error(`MetadataError: ${e.message}`);
 });
 }).then((res) => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);
 return res.json().then(() => {
 Logger.log(`Grid ${fid} has been updated.`, 2);
 });
 });

 }

}

export default QueryScheduler;
Expand Down

12 changes: 12 additions & 0 deletions
backend/persistent/plotly-api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -152,6 +152,18 @@ export function deleteGrid(fid, requestor) {
 });
}

export function patchGrid(fid, requestor, body) {
 const {username, apiKey, accessToken} = getCredentials(requestor);

 return plotlyAPIRequest(`grids/${fid}`, {
 method: 'PATCH',
 username,
 apiKey,
 accessToken,
 body
 });
}

export function updateGrid(rows, fid, uids, requestor) {
 const {username, apiKey, accessToken} = getCredentials(requestor);

Expand Down

15 changes: 12 additions & 3 deletions
backend/routes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -664,13 +664,22 @@ export default class Servers {
 * the endpoint `/queries/:fid`
 */
 server.post('/queries', function postQueriesHandler(req, res, next) {
 const {filename, fid, uids, query, connectionId, requestor} = req.params;
 const {
 filename,
 fid,
 uids,
 query,
 connectionId,
 requestor,
 cronInterval = null,
@n-riescon-riescoAug 1, 2018

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

out of curiosity, why setting the default to 'null'?
 refreshInterval = null
 } = req.params;

 // If a filename has been provided,
 // make the query and create a new grid
 if (filename) {
 return that.queryScheduler.queryAndCreateGrid(
 filename, query, connectionId, requestor
 filename, query, connectionId, requestor, cronInterval, refreshInterval
 )
 .then((newGridResponse) => {
 const queryObject = {
Expand All@@ -691,7 +700,7 @@ export default class Servers {
 if (fid) {
 return checkWritePermissions(fid, requestor).then(function () {
 return that.queryScheduler.queryAndUpdateGrid(
 fid, uids, query, connectionId, requestor
 fid, uids, query, connectionId, requestor, cronInterval, refreshInterval
 );
 })
 .then(() => {
Expand Down

20 changes: 20 additions & 0 deletions
backend/utils/cronUtils.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,26 @@ export function mapRefreshToCron (refreshInterval) {
 return `${now.getMinutes()} ${now.getHours()} * * ${now.getDay()}`;
}

export function mapCronToRefresh (cronInterval) {
 const DEFAULT_INTERVAL = 60 * 60 * 24 * 7; // default to weekly

 if (!cronInterval) {
 return DEFAULT_INTERVAL;
 }

 if (cronInterval === '* * * * *') {
 return 60;
 } else if (cronInterval === '*/5 * * * *') {
 return 60 * 5;
 } else if (cronInterval.match(/\S+? \* \* \* \*/)) {
@n-riescon-riescoAug 1, 2018

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this throws when cronInterval is null
 return 60 * 60;
 } else if (cronInterval.match(/\S+? \S+? \* \* \*/)) {
 return 60 * 60 * 24;
 }

 return DEFAULT_INTERVAL;
}

function computeMinutes (now) {
 let currMinute = now.getMinutes() % 5; // start at 5 min offset
 const minutes = [];
Expand Down

3 changes: 0 additions & 3 deletions
test/app/components/Settings/scheduler/create-modal.test.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ global.document.createRange = function() {

const wait = () => new Promise(resolve => setTimeout(resolve, 0));

const {DEFAULT_REFRESH_INTERVAL} = require('../../../../../app/constants/constants');
const CodeMirror = require('react-codemirror2').Controlled;
const CreateModal = require('../../../../../app/components/Settings/scheduler/create-modal.jsx');
const ErrorComponent = require('../../../../../app/components/error.jsx');
Expand DownExpand Up@@ -93,15 +92,13 @@ describe('Create Modal Test', () => {
 // Once filename input is supported, this value should be: 'filename',
 filename: expect.any(String),
 query: 'SELECT * FROM foods',
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 cronInterval
 })
 );
 expect(onSubmit).toHaveBeenCalledWith({
 // Once filename input is supported, this value should be: 'filename',
 filename: expect.any(String),
 query: 'SELECT * FROM foods',
 refreshInterval: DEFAULT_REFRESH_INTERVAL,
 cronInterval,
 name
 });
Expand Down

5 changes: 1 addition & 4 deletions
test/app/components/Settings/scheduler/preview-modal.jsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@ global.document.createRange = function() {
};

const PreviewModal = require('../../../../../app/components/Settings/scheduler/preview-modal.jsx').default;
const {DEFAULT_REFRESH_INTERVAL} = require('../../../../../app/constants/constants');

describe('Preview Modal Tests', () => {
 beforeAll(() => {
Expand DownExpand Up@@ -155,9 +154,7 @@ describe('Preview Modal Tests', () => {
 fid: 'fid:1',
 requestor: 'user',
 query: 'SELECT * FROM table',
 cronInterval: '* * * * *',
 // This is necessary to prevent older versions from breaking
 refreshInterval: DEFAULT_REFRESH_INTERVAL
 cronInterval: '* * * * *'
 })
 );
 });
Expand Down