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

Implement API to create a grid to store results of a scheduled query#444

Merged
n-riesco merged 5 commits into from
May 28, 2018
Merged

Implement API to create a grid to store results of a scheduled query #444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
26ec584
PlotlyAPI: use lowercase filenames
n-riesco May 26, 2018
c26fa9d
settings: add getCredentials(username)
n-riesco May 26, 2018
b3504bf
PlotlyAPI: refactor
n-riesco May 27, 2018
3aa1c34
routes: extend entrypoint POST queries
n-riesco May 27, 2018
728888b
PlotlyAPI: rename getGridMetadat to getGridMeta
n-riesco May 27, 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
179 changes: 0 additions & 179 deletions backend/persistent/PlotlyAPI.js
View file
Open in desktop

This file was deleted.

132 changes: 98 additions & 34 deletions backend/persistent/QueryScheduler.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,32 @@
import * as Connections from './datastores/Datastores';
import {getConnectionById} from './Connections';
import {getQuery, getQueries, saveQuery, deleteQuery} from './Queries';
import {getSetting} from '../settings';
import Logger from '../logger';
import {PlotlyAPIRequest, updateGrid} from './PlotlyAPI';
import {has} from 'ramda';

import {getConnectionById} from './Connections.js';
import * as Connections from './datastores/Datastores.js';
import Logger from '../logger';
import {
getQuery,
getQueries,
saveQuery,
deleteQuery
} from './Queries.js';

@tarzzztarzzzMay 28, 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.

(Not necessarily in this PR) but we should small-case these filenames as well.. !! Queries, Datastore etc, and remove .js extensions to be consistent.. !!

@n-riescon-riescoMay 28, 2018

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I want to keep the extensions, because:

  • it's grep-friendly
  • we have imports that only differ in the extension (e.g. code-editor.css and code-editor.jsx)

@n-riescon-riescoMay 28, 2018

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

The idea is to move to lower case, whenever we have a chance (instead of having a huge big PR). We don't really want to spend time on it.

import {
getCredentials,
getSetting
} from '../settings.js';
import {
getCurrentUser,
getGridMeta,
newGrid,
updateGrid
} from './plotly-api.js';

class QueryScheduler {
constructor() {
this.scheduleQuery = this.scheduleQuery.bind(this);
this.loadQueries = this.loadQueries.bind(this);
this.clearQuery = this.clearQuery.bind(this);
this.clearQueries = this.clearQueries.bind(this);
this.queryAndCreateGrid = this.queryAndCreateGrid.bind(this);
this.queryAndUpdateGrid = this.queryAndUpdateGrid.bind(this);

// this.job wraps this.queryAndUpdateGrid to avoid concurrent runs of the same job
Expand DownExpand Up@@ -106,7 +121,69 @@ class QueryScheduler {
Object.keys(this.queryJobs).forEach(this.clearQuery);
}

queryAndUpdateGrid (fid, uids, queryString, connectionId, requestor) {
queryAndCreateGrid(filename, query, connectionId, requestor) {
const {username, apiKey, accessToken} = getCredentials(requestor);
let startTime;

// Check if the user even exists
if (!username || !(apiKey || accessToken)) {

@tarzzztarzzzMay 28, 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.

We can simplify it:

if !(username || apiKey || accessToken) {

@n-riescon-riescoMay 28, 2018

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

tricky, but not equivalent: the latter doesn't catch the case when username is defined but both apiKey and accessToken are undefined.

/*
* Warning: The front end looks for "Unauthenticated" in this error message. Don't change it!
*/
const errorMessage = (
'Unauthenticated: Attempting to create a grid but the ' +
`authentication credentials for the user "${username}" do not exist.`
);
Logger.log(errorMessage, 0);
throw new Error(errorMessage);
}

// Check if the credentials are valid
return getCurrentUser(username).then(res => {
if (res.status !== 200) {
const errorMessage = (
`Unauthenticated: ${getSetting('PLOTLY_API_URL')} failed to identify ${username}.`
);
Logger.log(errorMessage, 0);
throw new Error(errorMessage);
}


startTime = process.hrtime();

Logger.log(`Querying "${query}" with connection ${connectionId} to create a new grid`, 2);
return Connections.query(query, getConnectionById(connectionId));

}).then(({rows, columnnames}) => {
Logger.log(`Query "${query}" took ${process.hrtime(startTime)[0]} seconds`, 2);
Logger.log('Create a new grid with new data', 2);
Logger.log(`First row: ${JSON.stringify(rows.slice(0, 1))}`, 2);

startTime = process.hrtime();

return newGrid(
filename,
columnnames,
rows,
requestor
);

}).then(res => {
Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);

if (res.status !== 201) {

@shannonlalshannonlalMay 27, 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.

Should be putting this into a constants file with actual codes? I noticed below we have 200, 401, etc. If we used names would make code easier to read

@n-riescon-riescoMay 27, 2018

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

No, it'd make the code less readable (in this context it's clear 201 is an HTTP status code).

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;
});
});

}

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

Expand All@@ -118,16 +195,12 @@ class QueryScheduler {
* If the user is the owner, then requestor === fid.split(':')[0]
* If the user is a collaborator, then requestor is different
*/
const username = requestor;
const user = getSetting('USERS').find(
u => u.username === username
);
const {username, apiKey, accessToken} = getCredentials(requestor);

// Check if the user even exists
if (!user || !(user.apiKey || user.accessToken)) {
if (!username || !(apiKey || accessToken)) {
/*
* Heads up - the front end looks for "Unauthenticated" in this
* error message. So don't change it!
* Warning: The front end looks for "Unauthenticated" in this error message. Don't change it!
*/
const errorMessage = (
`Unauthenticated: Attempting to update grid ${fid} but the ` +
Expand All@@ -136,11 +209,9 @@ class QueryScheduler {
Logger.log(errorMessage, 0);
throw new Error(errorMessage);
}
const {apiKey, accessToken} = user;

// Check if the credentials are valid
return PlotlyAPIRequest('users/current', {
method: 'GET', username, apiKey, accessToken
}).then(res => {
return getCurrentUser(username).then(res => {
if (res.status !== 200) {
const errorMessage = (
`Unauthenticated: ${getSetting('PLOTLY_API_URL')} failed to identify ${username}.`
Expand All@@ -149,21 +220,22 @@ class QueryScheduler {
throw new Error(errorMessage);
}

Logger.log(`Querying "${queryString}" with connection ${connectionId} to update grid ${fid}`, 2);
return Connections.query(queryString, requestedDBConnections);
Logger.log(`Querying "${query}" with connection ${connectionId} to update grid ${fid}`, 2);
return Connections.query(query, requestedDBConnections);

}).then(rowsAndColumns => {
}).then(({rows}) => {

Logger.log(`Query "${queryString}" took ${process.hrtime(startTime)[0]} seconds`, 2);
Logger.log(`Query "${query}" took ${process.hrtime(startTime)[0]} seconds`, 2);
Logger.log(`Updating grid ${fid} with new data`, 2);
Logger.log(
'First row: ' +
JSON.stringify(rowsAndColumns.rows.slice(0, 1)),
JSON.stringify(rows.slice(0, 1)),
2);

startTime = process.hrtime();

return updateGrid(
rowsAndColumns.rows,
rows,
fid,
uids,
requestor
Expand DownExpand Up@@ -196,16 +268,9 @@ class QueryScheduler {
* make an additional API call to GET it
*/

return PlotlyAPIRequest(
`grids/${fid}`,
{username, apiKey, accessToken, method: 'GET'}
).then(resFromGET => {
return getGridMeta(fid, username).then(resFromGET => {
if (resFromGET.status === 404) {
Logger.log(('' +
`Grid ID ${fid} doesn't exist on Plotly anymore, ` +
'removing persistent query.'),
2
);
Logger.log(`Grid ID ${fid} doesn't exist on Plotly anymore, removing persistent query.`, 2);
this.clearQuery(fid);
return deleteQuery(fid);
}
Expand All@@ -216,7 +281,6 @@ class QueryScheduler {
try {
filemeta = JSON.parse(text);
} catch (e) {
// Well, that's annoying.
Logger.log(`Failed to parse the JSON of request ${fid}`, 0);
Logger.log(e);
Logger.log('Text response: ' + text, 0);
Expand Down
Loading
, '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.

Implement API to create a grid to store results of a scheduled query#444
 Merged

n-riesco
merged 5 commits into

from

May 28, 2018
 Merged


Implement API to create a grid to store results of a scheduled query
#444
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
26ec584

PlotlyAPI: use lowercase filenames


n-riesco May 26, 2018
c26fa9d

settings: add getCredentials(username)


n-riesco May 26, 2018
b3504bf

PlotlyAPI: refactor


n-riesco May 27, 2018
3aa1c34

routes: extend entrypoint POST queries


n-riesco May 27, 2018
728888b

PlotlyAPI: rename getGridMetadat to getGridMeta


n-riesco May 27, 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


179 changes: 0 additions & 179 deletions
backend/persistent/PlotlyAPI.js

View file


Open in desktop


This file was deleted.


132 changes: 98 additions & 34 deletions
backend/persistent/QueryScheduler.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,32 @@
import * as Connections from './datastores/Datastores';
import {getConnectionById} from './Connections';
import {getQuery, getQueries, saveQuery, deleteQuery} from './Queries';
import {getSetting} from '../settings';
import Logger from '../logger';
import {PlotlyAPIRequest, updateGrid} from './PlotlyAPI';
import {has} from 'ramda';

import {getConnectionById} from './Connections.js';
import * as Connections from './datastores/Datastores.js';
import Logger from '../logger';
import {
 getQuery,
 getQueries,
 saveQuery,
 deleteQuery
} from './Queries.js';
@tarzzztarzzzMay 28, 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.

(Not necessarily in this PR) but we should small-case these filenames as well.. !! Queries, Datastore etc, and remove .js extensions to be consistent.. !!
@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I want to keep the extensions, because:
  • it's grep-friendly
  • we have imports that only differ in the extension (e.g. code-editor.css and code-editor.jsx)
@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

The idea is to move to lower case, whenever we have a chance (instead of having a huge big PR). We don't really want to spend time on it.
import {
 getCredentials,
 getSetting
} from '../settings.js';
import {
 getCurrentUser,
 getGridMeta,
 newGrid,
 updateGrid
} from './plotly-api.js';

class QueryScheduler {
 constructor() {
 this.scheduleQuery = this.scheduleQuery.bind(this);
 this.loadQueries = this.loadQueries.bind(this);
 this.clearQuery = this.clearQuery.bind(this);
 this.clearQueries = this.clearQueries.bind(this);
 this.queryAndCreateGrid = this.queryAndCreateGrid.bind(this);
 this.queryAndUpdateGrid = this.queryAndUpdateGrid.bind(this);

 // this.job wraps this.queryAndUpdateGrid to avoid concurrent runs of the same job
Expand DownExpand Up@@ -106,7 +121,69 @@ class QueryScheduler {
 Object.keys(this.queryJobs).forEach(this.clearQuery);
 }

 queryAndUpdateGrid (fid, uids, queryString, connectionId, requestor) {
 queryAndCreateGrid(filename, query, connectionId, requestor) {
 const {username, apiKey, accessToken} = getCredentials(requestor);
 let startTime;

 // Check if the user even exists
 if (!username || !(apiKey || accessToken)) {
@tarzzztarzzzMay 28, 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.

We can simplify it:
if !(username || apiKey || accessToken) {

@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

tricky, but not equivalent: the latter doesn't catch the case when username is defined but both apiKey and accessToken are undefined.
 /*
 * Warning: The front end looks for "Unauthenticated" in this error message. Don't change it!
 */
 const errorMessage = (
 'Unauthenticated: Attempting to create a grid but the ' +
 `authentication credentials for the user "${username}" do not exist.`
 );
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }

 // Check if the credentials are valid
 return getCurrentUser(username).then(res => {
 if (res.status !== 200) {
 const errorMessage = (
 `Unauthenticated: ${getSetting('PLOTLY_API_URL')} failed to identify ${username}.`
 );
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }


 startTime = process.hrtime();

 Logger.log(`Querying "${query}" with connection ${connectionId} to create a new grid`, 2);
 return Connections.query(query, getConnectionById(connectionId));

 }).then(({rows, columnnames}) => {
 Logger.log(`Query "${query}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log('Create a new grid with new data', 2);
 Logger.log(`First row: ${JSON.stringify(rows.slice(0, 1))}`, 2);

 startTime = process.hrtime();

 return newGrid(
 filename,
 columnnames,
 rows,
 requestor
 );

 }).then(res => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);

 if (res.status !== 201) {
@shannonlalshannonlalMay 27, 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.

Should be putting this into a constants file with actual codes? I noticed below we have 200, 401, etc. If we used names would make code easier to read
@n-riescon-riescoMay 27, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

No, it'd make the code less readable (in this context it's clear 201 is an HTTP status code).
 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;
 });
 });

 }

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

Expand All@@ -118,16 +195,12 @@ class QueryScheduler {
 * If the user is the owner, then requestor === fid.split(':')[0]
 * If the user is a collaborator, then requestor is different
 */
 const username = requestor;
 const user = getSetting('USERS').find(
 u => u.username === username
 );
 const {username, apiKey, accessToken} = getCredentials(requestor);

 // Check if the user even exists
 if (!user || !(user.apiKey || user.accessToken)) {
 if (!username || !(apiKey || accessToken)) {
 /*
 * Heads up - the front end looks for "Unauthenticated" in this
 * error message. So don't change it!
 * Warning: The front end looks for "Unauthenticated" in this error message. Don't change it!
 */
 const errorMessage = (
 `Unauthenticated: Attempting to update grid ${fid} but the ` +
Expand All@@ -136,11 +209,9 @@ class QueryScheduler {
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }
 const {apiKey, accessToken} = user;

 // Check if the credentials are valid
 return PlotlyAPIRequest('users/current', {
 method: 'GET', username, apiKey, accessToken
 }).then(res => {
 return getCurrentUser(username).then(res => {
 if (res.status !== 200) {
 const errorMessage = (
 `Unauthenticated: ${getSetting('PLOTLY_API_URL')} failed to identify ${username}.`
Expand All@@ -149,21 +220,22 @@ class QueryScheduler {
 throw new Error(errorMessage);
 }

 Logger.log(`Querying "${queryString}" with connection ${connectionId} to update grid ${fid}`, 2);
 return Connections.query(queryString, requestedDBConnections);
 Logger.log(`Querying "${query}" with connection ${connectionId} to update grid ${fid}`, 2);
 return Connections.query(query, requestedDBConnections);

 }).then(rowsAndColumns => {
 }).then(({rows}) => {

 Logger.log(`Query "${queryString}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Query "${query}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Updating grid ${fid} with new data`, 2);
 Logger.log(
 'First row: ' +
 JSON.stringify(rowsAndColumns.rows.slice(0, 1)),
 JSON.stringify(rows.slice(0, 1)),
 2);

 startTime = process.hrtime();

 return updateGrid(
rowsAndColumns.rows,
 rows,
 fid,
 uids,
 requestor
Expand DownExpand Up@@ -196,16 +268,9 @@ class QueryScheduler {
 * make an additional API call to GET it
 */

 return PlotlyAPIRequest(
 `grids/${fid}`,
 {username, apiKey, accessToken, method: 'GET'}
 ).then(resFromGET => {
 return getGridMeta(fid, username).then(resFromGET => {
 if (resFromGET.status === 404) {
 Logger.log(('' +
 `Grid ID ${fid} doesn't exist on Plotly anymore, ` +
 'removing persistent query.'),
 2
 );
 Logger.log(`Grid ID ${fid} doesn't exist on Plotly anymore, removing persistent query.`, 2);
 this.clearQuery(fid);
 return deleteQuery(fid);
 }
Expand All@@ -216,7 +281,6 @@ class QueryScheduler {
 try {
 filemeta = JSON.parse(text);
 } catch (e) {
 // Well, that's annoying.
 Logger.log(`Failed to parse the JSON of request ${fid}`, 0);
 Logger.log(e);
 Logger.log('Text response: ' + text, 0);
Expand Down
Loading

, '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.

Implement API to create a grid to store results of a scheduled query#444
 Merged

n-riesco
merged 5 commits into

from

May 28, 2018
 Merged


Implement API to create a grid to store results of a scheduled query
#444
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
26ec584

PlotlyAPI: use lowercase filenames


n-riesco May 26, 2018
c26fa9d

settings: add getCredentials(username)


n-riesco May 26, 2018
b3504bf

PlotlyAPI: refactor


n-riesco May 27, 2018
3aa1c34

routes: extend entrypoint POST queries


n-riesco May 27, 2018
728888b

PlotlyAPI: rename getGridMetadat to getGridMeta


n-riesco May 27, 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


179 changes: 0 additions & 179 deletions
backend/persistent/PlotlyAPI.js

View file


Open in desktop


This file was deleted.


132 changes: 98 additions & 34 deletions
backend/persistent/QueryScheduler.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,32 @@
import * as Connections from './datastores/Datastores';
import {getConnectionById} from './Connections';
import {getQuery, getQueries, saveQuery, deleteQuery} from './Queries';
import {getSetting} from '../settings';
import Logger from '../logger';
import {PlotlyAPIRequest, updateGrid} from './PlotlyAPI';
import {has} from 'ramda';

import {getConnectionById} from './Connections.js';
import * as Connections from './datastores/Datastores.js';
import Logger from '../logger';
import {
 getQuery,
 getQueries,
 saveQuery,
 deleteQuery
} from './Queries.js';
@tarzzztarzzzMay 28, 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.

(Not necessarily in this PR) but we should small-case these filenames as well.. !! Queries, Datastore etc, and remove .js extensions to be consistent.. !!
@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I want to keep the extensions, because:
  • it's grep-friendly
  • we have imports that only differ in the extension (e.g. code-editor.css and code-editor.jsx)
@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

The idea is to move to lower case, whenever we have a chance (instead of having a huge big PR). We don't really want to spend time on it.
import {
 getCredentials,
 getSetting
} from '../settings.js';
import {
 getCurrentUser,
 getGridMeta,
 newGrid,
 updateGrid
} from './plotly-api.js';

class QueryScheduler {
 constructor() {
 this.scheduleQuery = this.scheduleQuery.bind(this);
 this.loadQueries = this.loadQueries.bind(this);
 this.clearQuery = this.clearQuery.bind(this);
 this.clearQueries = this.clearQueries.bind(this);
 this.queryAndCreateGrid = this.queryAndCreateGrid.bind(this);
 this.queryAndUpdateGrid = this.queryAndUpdateGrid.bind(this);

 // this.job wraps this.queryAndUpdateGrid to avoid concurrent runs of the same job
Expand DownExpand Up@@ -106,7 +121,69 @@ class QueryScheduler {
 Object.keys(this.queryJobs).forEach(this.clearQuery);
 }

 queryAndUpdateGrid (fid, uids, queryString, connectionId, requestor) {
 queryAndCreateGrid(filename, query, connectionId, requestor) {
 const {username, apiKey, accessToken} = getCredentials(requestor);
 let startTime;

 // Check if the user even exists
 if (!username || !(apiKey || accessToken)) {
@tarzzztarzzzMay 28, 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.

We can simplify it:
if !(username || apiKey || accessToken) {

@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

tricky, but not equivalent: the latter doesn't catch the case when username is defined but both apiKey and accessToken are undefined.
 /*
 * Warning: The front end looks for "Unauthenticated" in this error message. Don't change it!
 */
 const errorMessage = (
 'Unauthenticated: Attempting to create a grid but the ' +
 `authentication credentials for the user "${username}" do not exist.`
 );
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }

 // Check if the credentials are valid
 return getCurrentUser(username).then(res => {
 if (res.status !== 200) {
 const errorMessage = (
 `Unauthenticated: ${getSetting('PLOTLY_API_URL')} failed to identify ${username}.`
 );
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }


 startTime = process.hrtime();

 Logger.log(`Querying "${query}" with connection ${connectionId} to create a new grid`, 2);
 return Connections.query(query, getConnectionById(connectionId));

 }).then(({rows, columnnames}) => {
 Logger.log(`Query "${query}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log('Create a new grid with new data', 2);
 Logger.log(`First row: ${JSON.stringify(rows.slice(0, 1))}`, 2);

 startTime = process.hrtime();

 return newGrid(
 filename,
 columnnames,
 rows,
 requestor
 );

 }).then(res => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);

 if (res.status !== 201) {
@shannonlalshannonlalMay 27, 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.

Should be putting this into a constants file with actual codes? I noticed below we have 200, 401, etc. If we used names would make code easier to read
@n-riescon-riescoMay 27, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

No, it'd make the code less readable (in this context it's clear 201 is an HTTP status code).
 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;
 });
 });

 }

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

Expand All@@ -118,16 +195,12 @@ class QueryScheduler {
 * If the user is the owner, then requestor === fid.split(':')[0]
 * If the user is a collaborator, then requestor is different
 */
 const username = requestor;
 const user = getSetting('USERS').find(
 u => u.username === username
 );
 const {username, apiKey, accessToken} = getCredentials(requestor);

 // Check if the user even exists
 if (!user || !(user.apiKey || user.accessToken)) {
 if (!username || !(apiKey || accessToken)) {
 /*
 * Heads up - the front end looks for "Unauthenticated" in this
 * error message. So don't change it!
 * Warning: The front end looks for "Unauthenticated" in this error message. Don't change it!
 */
 const errorMessage = (
 `Unauthenticated: Attempting to update grid ${fid} but the ` +
Expand All@@ -136,11 +209,9 @@ class QueryScheduler {
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }
 const {apiKey, accessToken} = user;

 // Check if the credentials are valid
 return PlotlyAPIRequest('users/current', {
 method: 'GET', username, apiKey, accessToken
 }).then(res => {
 return getCurrentUser(username).then(res => {
 if (res.status !== 200) {
 const errorMessage = (
 `Unauthenticated: ${getSetting('PLOTLY_API_URL')} failed to identify ${username}.`
Expand All@@ -149,21 +220,22 @@ class QueryScheduler {
 throw new Error(errorMessage);
 }

 Logger.log(`Querying "${queryString}" with connection ${connectionId} to update grid ${fid}`, 2);
 return Connections.query(queryString, requestedDBConnections);
 Logger.log(`Querying "${query}" with connection ${connectionId} to update grid ${fid}`, 2);
 return Connections.query(query, requestedDBConnections);

 }).then(rowsAndColumns => {
 }).then(({rows}) => {

 Logger.log(`Query "${queryString}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Query "${query}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Updating grid ${fid} with new data`, 2);
 Logger.log(
 'First row: ' +
 JSON.stringify(rowsAndColumns.rows.slice(0, 1)),
 JSON.stringify(rows.slice(0, 1)),
 2);

 startTime = process.hrtime();

 return updateGrid(
rowsAndColumns.rows,
 rows,
 fid,
 uids,
 requestor
Expand DownExpand Up@@ -196,16 +268,9 @@ class QueryScheduler {
 * make an additional API call to GET it
 */

 return PlotlyAPIRequest(
 `grids/${fid}`,
 {username, apiKey, accessToken, method: 'GET'}
 ).then(resFromGET => {
 return getGridMeta(fid, username).then(resFromGET => {
 if (resFromGET.status === 404) {
 Logger.log(('' +
 `Grid ID ${fid} doesn't exist on Plotly anymore, ` +
 'removing persistent query.'),
 2
 );
 Logger.log(`Grid ID ${fid} doesn't exist on Plotly anymore, removing persistent query.`, 2);
 this.clearQuery(fid);
 return deleteQuery(fid);
 }
Expand All@@ -216,7 +281,6 @@ class QueryScheduler {
 try {
 filemeta = JSON.parse(text);
 } catch (e) {
 // Well, that's annoying.
 Logger.log(`Failed to parse the JSON of request ${fid}`, 0);
 Logger.log(e);
 Logger.log('Text response: ' + text, 0);
Expand Down
Loading

, '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.

Implement API to create a grid to store results of a scheduled query#444
 Merged

n-riesco
merged 5 commits into

from

May 28, 2018
 Merged


Implement API to create a grid to store results of a scheduled query
#444
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
26ec584

PlotlyAPI: use lowercase filenames


n-riesco May 26, 2018
c26fa9d

settings: add getCredentials(username)


n-riesco May 26, 2018
b3504bf

PlotlyAPI: refactor


n-riesco May 27, 2018
3aa1c34

routes: extend entrypoint POST queries


n-riesco May 27, 2018
728888b

PlotlyAPI: rename getGridMetadat to getGridMeta


n-riesco May 27, 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


179 changes: 0 additions & 179 deletions
backend/persistent/PlotlyAPI.js

View file


Open in desktop


This file was deleted.


132 changes: 98 additions & 34 deletions
backend/persistent/QueryScheduler.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,32 @@
import * as Connections from './datastores/Datastores';
import {getConnectionById} from './Connections';
import {getQuery, getQueries, saveQuery, deleteQuery} from './Queries';
import {getSetting} from '../settings';
import Logger from '../logger';
import {PlotlyAPIRequest, updateGrid} from './PlotlyAPI';
import {has} from 'ramda';

import {getConnectionById} from './Connections.js';
import * as Connections from './datastores/Datastores.js';
import Logger from '../logger';
import {
 getQuery,
 getQueries,
 saveQuery,
 deleteQuery
} from './Queries.js';
@tarzzztarzzzMay 28, 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.

(Not necessarily in this PR) but we should small-case these filenames as well.. !! Queries, Datastore etc, and remove .js extensions to be consistent.. !!
@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I want to keep the extensions, because:
  • it's grep-friendly
  • we have imports that only differ in the extension (e.g. code-editor.css and code-editor.jsx)
@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

The idea is to move to lower case, whenever we have a chance (instead of having a huge big PR). We don't really want to spend time on it.
import {
 getCredentials,
 getSetting
} from '../settings.js';
import {
 getCurrentUser,
 getGridMeta,
 newGrid,
 updateGrid
} from './plotly-api.js';

class QueryScheduler {
 constructor() {
 this.scheduleQuery = this.scheduleQuery.bind(this);
 this.loadQueries = this.loadQueries.bind(this);
 this.clearQuery = this.clearQuery.bind(this);
 this.clearQueries = this.clearQueries.bind(this);
 this.queryAndCreateGrid = this.queryAndCreateGrid.bind(this);
 this.queryAndUpdateGrid = this.queryAndUpdateGrid.bind(this);

 // this.job wraps this.queryAndUpdateGrid to avoid concurrent runs of the same job
Expand DownExpand Up@@ -106,7 +121,69 @@ class QueryScheduler {
 Object.keys(this.queryJobs).forEach(this.clearQuery);
 }

 queryAndUpdateGrid (fid, uids, queryString, connectionId, requestor) {
 queryAndCreateGrid(filename, query, connectionId, requestor) {
 const {username, apiKey, accessToken} = getCredentials(requestor);
 let startTime;

 // Check if the user even exists
 if (!username || !(apiKey || accessToken)) {
@tarzzztarzzzMay 28, 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.

We can simplify it:
if !(username || apiKey || accessToken) {

@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

tricky, but not equivalent: the latter doesn't catch the case when username is defined but both apiKey and accessToken are undefined.
 /*
 * Warning: The front end looks for "Unauthenticated" in this error message. Don't change it!
 */
 const errorMessage = (
 'Unauthenticated: Attempting to create a grid but the ' +
 `authentication credentials for the user "${username}" do not exist.`
 );
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }

 // Check if the credentials are valid
 return getCurrentUser(username).then(res => {
 if (res.status !== 200) {
 const errorMessage = (
 `Unauthenticated: ${getSetting('PLOTLY_API_URL')} failed to identify ${username}.`
 );
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }


 startTime = process.hrtime();

 Logger.log(`Querying "${query}" with connection ${connectionId} to create a new grid`, 2);
 return Connections.query(query, getConnectionById(connectionId));

 }).then(({rows, columnnames}) => {
 Logger.log(`Query "${query}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log('Create a new grid with new data', 2);
 Logger.log(`First row: ${JSON.stringify(rows.slice(0, 1))}`, 2);

 startTime = process.hrtime();

 return newGrid(
 filename,
 columnnames,
 rows,
 requestor
 );

 }).then(res => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);

 if (res.status !== 201) {
@shannonlalshannonlalMay 27, 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.

Should be putting this into a constants file with actual codes? I noticed below we have 200, 401, etc. If we used names would make code easier to read
@n-riescon-riescoMay 27, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

No, it'd make the code less readable (in this context it's clear 201 is an HTTP status code).
 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;
 });
 });

 }

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

Expand All@@ -118,16 +195,12 @@ class QueryScheduler {
 * If the user is the owner, then requestor === fid.split(':')[0]
 * If the user is a collaborator, then requestor is different
 */
 const username = requestor;
 const user = getSetting('USERS').find(
 u => u.username === username
 );
 const {username, apiKey, accessToken} = getCredentials(requestor);

 // Check if the user even exists
 if (!user || !(user.apiKey || user.accessToken)) {
 if (!username || !(apiKey || accessToken)) {
 /*
 * Heads up - the front end looks for "Unauthenticated" in this
 * error message. So don't change it!
 * Warning: The front end looks for "Unauthenticated" in this error message. Don't change it!
 */
 const errorMessage = (
 `Unauthenticated: Attempting to update grid ${fid} but the ` +
Expand All@@ -136,11 +209,9 @@ class QueryScheduler {
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }
 const {apiKey, accessToken} = user;

 // Check if the credentials are valid
 return PlotlyAPIRequest('users/current', {
 method: 'GET', username, apiKey, accessToken
 }).then(res => {
 return getCurrentUser(username).then(res => {
 if (res.status !== 200) {
 const errorMessage = (
 `Unauthenticated: ${getSetting('PLOTLY_API_URL')} failed to identify ${username}.`
Expand All@@ -149,21 +220,22 @@ class QueryScheduler {
 throw new Error(errorMessage);
 }

 Logger.log(`Querying "${queryString}" with connection ${connectionId} to update grid ${fid}`, 2);
 return Connections.query(queryString, requestedDBConnections);
 Logger.log(`Querying "${query}" with connection ${connectionId} to update grid ${fid}`, 2);
 return Connections.query(query, requestedDBConnections);

 }).then(rowsAndColumns => {
 }).then(({rows}) => {

 Logger.log(`Query "${queryString}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Query "${query}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Updating grid ${fid} with new data`, 2);
 Logger.log(
 'First row: ' +
 JSON.stringify(rowsAndColumns.rows.slice(0, 1)),
 JSON.stringify(rows.slice(0, 1)),
 2);

 startTime = process.hrtime();

 return updateGrid(
rowsAndColumns.rows,
 rows,
 fid,
 uids,
 requestor
Expand DownExpand Up@@ -196,16 +268,9 @@ class QueryScheduler {
 * make an additional API call to GET it
 */

 return PlotlyAPIRequest(
 `grids/${fid}`,
 {username, apiKey, accessToken, method: 'GET'}
 ).then(resFromGET => {
 return getGridMeta(fid, username).then(resFromGET => {
 if (resFromGET.status === 404) {
 Logger.log(('' +
 `Grid ID ${fid} doesn't exist on Plotly anymore, ` +
 'removing persistent query.'),
 2
 );
 Logger.log(`Grid ID ${fid} doesn't exist on Plotly anymore, removing persistent query.`, 2);
 this.clearQuery(fid);
 return deleteQuery(fid);
 }
Expand All@@ -216,7 +281,6 @@ class QueryScheduler {
 try {
 filemeta = JSON.parse(text);
 } catch (e) {
 // Well, that's annoying.
 Logger.log(`Failed to parse the JSON of request ${fid}`, 0);
 Logger.log(e);
 Logger.log('Text response: ' + text, 0);
Expand Down
Loading

, '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.

Implement API to create a grid to store results of a scheduled query#444
 Merged

n-riesco
merged 5 commits into

from

May 28, 2018
 Merged


Implement API to create a grid to store results of a scheduled query
#444
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
26ec584

PlotlyAPI: use lowercase filenames


n-riesco May 26, 2018
c26fa9d

settings: add getCredentials(username)


n-riesco May 26, 2018
b3504bf

PlotlyAPI: refactor


n-riesco May 27, 2018
3aa1c34

routes: extend entrypoint POST queries


n-riesco May 27, 2018
728888b

PlotlyAPI: rename getGridMetadat to getGridMeta


n-riesco May 27, 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


179 changes: 0 additions & 179 deletions
backend/persistent/PlotlyAPI.js

View file


Open in desktop


This file was deleted.


132 changes: 98 additions & 34 deletions
backend/persistent/QueryScheduler.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,32 @@
import * as Connections from './datastores/Datastores';
import {getConnectionById} from './Connections';
import {getQuery, getQueries, saveQuery, deleteQuery} from './Queries';
import {getSetting} from '../settings';
import Logger from '../logger';
import {PlotlyAPIRequest, updateGrid} from './PlotlyAPI';
import {has} from 'ramda';

import {getConnectionById} from './Connections.js';
import * as Connections from './datastores/Datastores.js';
import Logger from '../logger';
import {
 getQuery,
 getQueries,
 saveQuery,
 deleteQuery
} from './Queries.js';
@tarzzztarzzzMay 28, 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.

(Not necessarily in this PR) but we should small-case these filenames as well.. !! Queries, Datastore etc, and remove .js extensions to be consistent.. !!
@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I want to keep the extensions, because:
  • it's grep-friendly
  • we have imports that only differ in the extension (e.g. code-editor.css and code-editor.jsx)
@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

The idea is to move to lower case, whenever we have a chance (instead of having a huge big PR). We don't really want to spend time on it.
import {
 getCredentials,
 getSetting
} from '../settings.js';
import {
 getCurrentUser,
 getGridMeta,
 newGrid,
 updateGrid
} from './plotly-api.js';

class QueryScheduler {
 constructor() {
 this.scheduleQuery = this.scheduleQuery.bind(this);
 this.loadQueries = this.loadQueries.bind(this);
 this.clearQuery = this.clearQuery.bind(this);
 this.clearQueries = this.clearQueries.bind(this);
 this.queryAndCreateGrid = this.queryAndCreateGrid.bind(this);
 this.queryAndUpdateGrid = this.queryAndUpdateGrid.bind(this);

 // this.job wraps this.queryAndUpdateGrid to avoid concurrent runs of the same job
Expand DownExpand Up@@ -106,7 +121,69 @@ class QueryScheduler {
 Object.keys(this.queryJobs).forEach(this.clearQuery);
 }

 queryAndUpdateGrid (fid, uids, queryString, connectionId, requestor) {
 queryAndCreateGrid(filename, query, connectionId, requestor) {
 const {username, apiKey, accessToken} = getCredentials(requestor);
 let startTime;

 // Check if the user even exists
 if (!username || !(apiKey || accessToken)) {
@tarzzztarzzzMay 28, 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.

We can simplify it:
if !(username || apiKey || accessToken) {

@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

tricky, but not equivalent: the latter doesn't catch the case when username is defined but both apiKey and accessToken are undefined.
 /*
 * Warning: The front end looks for "Unauthenticated" in this error message. Don't change it!
 */
 const errorMessage = (
 'Unauthenticated: Attempting to create a grid but the ' +
 `authentication credentials for the user "${username}" do not exist.`
 );
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }

 // Check if the credentials are valid
 return getCurrentUser(username).then(res => {
 if (res.status !== 200) {
 const errorMessage = (
 `Unauthenticated: ${getSetting('PLOTLY_API_URL')} failed to identify ${username}.`
 );
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }


 startTime = process.hrtime();

 Logger.log(`Querying "${query}" with connection ${connectionId} to create a new grid`, 2);
 return Connections.query(query, getConnectionById(connectionId));

 }).then(({rows, columnnames}) => {
 Logger.log(`Query "${query}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log('Create a new grid with new data', 2);
 Logger.log(`First row: ${JSON.stringify(rows.slice(0, 1))}`, 2);

 startTime = process.hrtime();

 return newGrid(
 filename,
 columnnames,
 rows,
 requestor
 );

 }).then(res => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);

 if (res.status !== 201) {
@shannonlalshannonlalMay 27, 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.

Should be putting this into a constants file with actual codes? I noticed below we have 200, 401, etc. If we used names would make code easier to read
@n-riescon-riescoMay 27, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

No, it'd make the code less readable (in this context it's clear 201 is an HTTP status code).
 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;
 });
 });

 }

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

Expand All@@ -118,16 +195,12 @@ class QueryScheduler {
 * If the user is the owner, then requestor === fid.split(':')[0]
 * If the user is a collaborator, then requestor is different
 */
 const username = requestor;
 const user = getSetting('USERS').find(
 u => u.username === username
 );
 const {username, apiKey, accessToken} = getCredentials(requestor);

 // Check if the user even exists
 if (!user || !(user.apiKey || user.accessToken)) {
 if (!username || !(apiKey || accessToken)) {
 /*
 * Heads up - the front end looks for "Unauthenticated" in this
 * error message. So don't change it!
 * Warning: The front end looks for "Unauthenticated" in this error message. Don't change it!
 */
 const errorMessage = (
 `Unauthenticated: Attempting to update grid ${fid} but the ` +
Expand All@@ -136,11 +209,9 @@ class QueryScheduler {
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }
 const {apiKey, accessToken} = user;

 // Check if the credentials are valid
 return PlotlyAPIRequest('users/current', {
 method: 'GET', username, apiKey, accessToken
 }).then(res => {
 return getCurrentUser(username).then(res => {
 if (res.status !== 200) {
 const errorMessage = (
 `Unauthenticated: ${getSetting('PLOTLY_API_URL')} failed to identify ${username}.`
Expand All@@ -149,21 +220,22 @@ class QueryScheduler {
 throw new Error(errorMessage);
 }

 Logger.log(`Querying "${queryString}" with connection ${connectionId} to update grid ${fid}`, 2);
 return Connections.query(queryString, requestedDBConnections);
 Logger.log(`Querying "${query}" with connection ${connectionId} to update grid ${fid}`, 2);
 return Connections.query(query, requestedDBConnections);

 }).then(rowsAndColumns => {
 }).then(({rows}) => {

 Logger.log(`Query "${queryString}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Query "${query}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Updating grid ${fid} with new data`, 2);
 Logger.log(
 'First row: ' +
 JSON.stringify(rowsAndColumns.rows.slice(0, 1)),
 JSON.stringify(rows.slice(0, 1)),
 2);

 startTime = process.hrtime();

 return updateGrid(
rowsAndColumns.rows,
 rows,
 fid,
 uids,
 requestor
Expand DownExpand Up@@ -196,16 +268,9 @@ class QueryScheduler {
 * make an additional API call to GET it
 */

 return PlotlyAPIRequest(
 `grids/${fid}`,
 {username, apiKey, accessToken, method: 'GET'}
 ).then(resFromGET => {
 return getGridMeta(fid, username).then(resFromGET => {
 if (resFromGET.status === 404) {
 Logger.log(('' +
 `Grid ID ${fid} doesn't exist on Plotly anymore, ` +
 'removing persistent query.'),
 2
 );
 Logger.log(`Grid ID ${fid} doesn't exist on Plotly anymore, removing persistent query.`, 2);
 this.clearQuery(fid);
 return deleteQuery(fid);
 }
Expand All@@ -216,7 +281,6 @@ class QueryScheduler {
 try {
 filemeta = JSON.parse(text);
 } catch (e) {
 // Well, that's annoying.
 Logger.log(`Failed to parse the JSON of request ${fid}`, 0);
 Logger.log(e);
 Logger.log('Text response: ' + text, 0);
Expand Down
Loading

, '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.

Implement API to create a grid to store results of a scheduled query#444
 Merged

n-riesco
merged 5 commits into

from

May 28, 2018
 Merged


Implement API to create a grid to store results of a scheduled query
#444
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
26ec584

PlotlyAPI: use lowercase filenames


n-riesco May 26, 2018
c26fa9d

settings: add getCredentials(username)


n-riesco May 26, 2018
b3504bf

PlotlyAPI: refactor


n-riesco May 27, 2018
3aa1c34

routes: extend entrypoint POST queries


n-riesco May 27, 2018
728888b

PlotlyAPI: rename getGridMetadat to getGridMeta


n-riesco May 27, 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


179 changes: 0 additions & 179 deletions
backend/persistent/PlotlyAPI.js

View file


Open in desktop


This file was deleted.


132 changes: 98 additions & 34 deletions
backend/persistent/QueryScheduler.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,32 @@
import * as Connections from './datastores/Datastores';
import {getConnectionById} from './Connections';
import {getQuery, getQueries, saveQuery, deleteQuery} from './Queries';
import {getSetting} from '../settings';
import Logger from '../logger';
import {PlotlyAPIRequest, updateGrid} from './PlotlyAPI';
import {has} from 'ramda';

import {getConnectionById} from './Connections.js';
import * as Connections from './datastores/Datastores.js';
import Logger from '../logger';
import {
 getQuery,
 getQueries,
 saveQuery,
 deleteQuery
} from './Queries.js';
@tarzzztarzzzMay 28, 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.

(Not necessarily in this PR) but we should small-case these filenames as well.. !! Queries, Datastore etc, and remove .js extensions to be consistent.. !!
@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I want to keep the extensions, because:
  • it's grep-friendly
  • we have imports that only differ in the extension (e.g. code-editor.css and code-editor.jsx)
@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

The idea is to move to lower case, whenever we have a chance (instead of having a huge big PR). We don't really want to spend time on it.
import {
 getCredentials,
 getSetting
} from '../settings.js';
import {
 getCurrentUser,
 getGridMeta,
 newGrid,
 updateGrid
} from './plotly-api.js';

class QueryScheduler {
 constructor() {
 this.scheduleQuery = this.scheduleQuery.bind(this);
 this.loadQueries = this.loadQueries.bind(this);
 this.clearQuery = this.clearQuery.bind(this);
 this.clearQueries = this.clearQueries.bind(this);
 this.queryAndCreateGrid = this.queryAndCreateGrid.bind(this);
 this.queryAndUpdateGrid = this.queryAndUpdateGrid.bind(this);

 // this.job wraps this.queryAndUpdateGrid to avoid concurrent runs of the same job
Expand DownExpand Up@@ -106,7 +121,69 @@ class QueryScheduler {
 Object.keys(this.queryJobs).forEach(this.clearQuery);
 }

 queryAndUpdateGrid (fid, uids, queryString, connectionId, requestor) {
 queryAndCreateGrid(filename, query, connectionId, requestor) {
 const {username, apiKey, accessToken} = getCredentials(requestor);
 let startTime;

 // Check if the user even exists
 if (!username || !(apiKey || accessToken)) {
@tarzzztarzzzMay 28, 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.

We can simplify it:
if !(username || apiKey || accessToken) {

@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

tricky, but not equivalent: the latter doesn't catch the case when username is defined but both apiKey and accessToken are undefined.
 /*
 * Warning: The front end looks for "Unauthenticated" in this error message. Don't change it!
 */
 const errorMessage = (
 'Unauthenticated: Attempting to create a grid but the ' +
 `authentication credentials for the user "${username}" do not exist.`
 );
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }

 // Check if the credentials are valid
 return getCurrentUser(username).then(res => {
 if (res.status !== 200) {
 const errorMessage = (
 `Unauthenticated: ${getSetting('PLOTLY_API_URL')} failed to identify ${username}.`
 );
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }


 startTime = process.hrtime();

 Logger.log(`Querying "${query}" with connection ${connectionId} to create a new grid`, 2);
 return Connections.query(query, getConnectionById(connectionId));

 }).then(({rows, columnnames}) => {
 Logger.log(`Query "${query}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log('Create a new grid with new data', 2);
 Logger.log(`First row: ${JSON.stringify(rows.slice(0, 1))}`, 2);

 startTime = process.hrtime();

 return newGrid(
 filename,
 columnnames,
 rows,
 requestor
 );

 }).then(res => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);

 if (res.status !== 201) {
@shannonlalshannonlalMay 27, 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.

Should be putting this into a constants file with actual codes? I noticed below we have 200, 401, etc. If we used names would make code easier to read
@n-riescon-riescoMay 27, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

No, it'd make the code less readable (in this context it's clear 201 is an HTTP status code).
 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;
 });
 });

 }

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

Expand All@@ -118,16 +195,12 @@ class QueryScheduler {
 * If the user is the owner, then requestor === fid.split(':')[0]
 * If the user is a collaborator, then requestor is different
 */
 const username = requestor;
 const user = getSetting('USERS').find(
 u => u.username === username
 );
 const {username, apiKey, accessToken} = getCredentials(requestor);

 // Check if the user even exists
 if (!user || !(user.apiKey || user.accessToken)) {
 if (!username || !(apiKey || accessToken)) {
 /*
 * Heads up - the front end looks for "Unauthenticated" in this
 * error message. So don't change it!
 * Warning: The front end looks for "Unauthenticated" in this error message. Don't change it!
 */
 const errorMessage = (
 `Unauthenticated: Attempting to update grid ${fid} but the ` +
Expand All@@ -136,11 +209,9 @@ class QueryScheduler {
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }
 const {apiKey, accessToken} = user;

 // Check if the credentials are valid
 return PlotlyAPIRequest('users/current', {
 method: 'GET', username, apiKey, accessToken
 }).then(res => {
 return getCurrentUser(username).then(res => {
 if (res.status !== 200) {
 const errorMessage = (
 `Unauthenticated: ${getSetting('PLOTLY_API_URL')} failed to identify ${username}.`
Expand All@@ -149,21 +220,22 @@ class QueryScheduler {
 throw new Error(errorMessage);
 }

 Logger.log(`Querying "${queryString}" with connection ${connectionId} to update grid ${fid}`, 2);
 return Connections.query(queryString, requestedDBConnections);
 Logger.log(`Querying "${query}" with connection ${connectionId} to update grid ${fid}`, 2);
 return Connections.query(query, requestedDBConnections);

 }).then(rowsAndColumns => {
 }).then(({rows}) => {

 Logger.log(`Query "${queryString}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Query "${query}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Updating grid ${fid} with new data`, 2);
 Logger.log(
 'First row: ' +
 JSON.stringify(rowsAndColumns.rows.slice(0, 1)),
 JSON.stringify(rows.slice(0, 1)),
 2);

 startTime = process.hrtime();

 return updateGrid(
rowsAndColumns.rows,
 rows,
 fid,
 uids,
 requestor
Expand DownExpand Up@@ -196,16 +268,9 @@ class QueryScheduler {
 * make an additional API call to GET it
 */

 return PlotlyAPIRequest(
 `grids/${fid}`,
 {username, apiKey, accessToken, method: 'GET'}
 ).then(resFromGET => {
 return getGridMeta(fid, username).then(resFromGET => {
 if (resFromGET.status === 404) {
 Logger.log(('' +
 `Grid ID ${fid} doesn't exist on Plotly anymore, ` +
 'removing persistent query.'),
 2
 );
 Logger.log(`Grid ID ${fid} doesn't exist on Plotly anymore, removing persistent query.`, 2);
 this.clearQuery(fid);
 return deleteQuery(fid);
 }
Expand All@@ -216,7 +281,6 @@ class QueryScheduler {
 try {
 filemeta = JSON.parse(text);
 } catch (e) {
 // Well, that's annoying.
 Logger.log(`Failed to parse the JSON of request ${fid}`, 0);
 Logger.log(e);
 Logger.log('Text response: ' + text, 0);
Expand Down
Loading

, '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.

Implement API to create a grid to store results of a scheduled query#444
 Merged

n-riesco
merged 5 commits into

from

May 28, 2018
 Merged


Implement API to create a grid to store results of a scheduled query
#444
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
26ec584

PlotlyAPI: use lowercase filenames


n-riesco May 26, 2018
c26fa9d

settings: add getCredentials(username)


n-riesco May 26, 2018
b3504bf

PlotlyAPI: refactor


n-riesco May 27, 2018
3aa1c34

routes: extend entrypoint POST queries


n-riesco May 27, 2018
728888b

PlotlyAPI: rename getGridMetadat to getGridMeta


n-riesco May 27, 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


179 changes: 0 additions & 179 deletions
backend/persistent/PlotlyAPI.js

View file


Open in desktop


This file was deleted.


132 changes: 98 additions & 34 deletions
backend/persistent/QueryScheduler.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,32 @@
import * as Connections from './datastores/Datastores';
import {getConnectionById} from './Connections';
import {getQuery, getQueries, saveQuery, deleteQuery} from './Queries';
import {getSetting} from '../settings';
import Logger from '../logger';
import {PlotlyAPIRequest, updateGrid} from './PlotlyAPI';
import {has} from 'ramda';

import {getConnectionById} from './Connections.js';
import * as Connections from './datastores/Datastores.js';
import Logger from '../logger';
import {
 getQuery,
 getQueries,
 saveQuery,
 deleteQuery
} from './Queries.js';
@tarzzztarzzzMay 28, 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.

(Not necessarily in this PR) but we should small-case these filenames as well.. !! Queries, Datastore etc, and remove .js extensions to be consistent.. !!
@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I want to keep the extensions, because:
  • it's grep-friendly
  • we have imports that only differ in the extension (e.g. code-editor.css and code-editor.jsx)
@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

The idea is to move to lower case, whenever we have a chance (instead of having a huge big PR). We don't really want to spend time on it.
import {
 getCredentials,
 getSetting
} from '../settings.js';
import {
 getCurrentUser,
 getGridMeta,
 newGrid,
 updateGrid
} from './plotly-api.js';

class QueryScheduler {
 constructor() {
 this.scheduleQuery = this.scheduleQuery.bind(this);
 this.loadQueries = this.loadQueries.bind(this);
 this.clearQuery = this.clearQuery.bind(this);
 this.clearQueries = this.clearQueries.bind(this);
 this.queryAndCreateGrid = this.queryAndCreateGrid.bind(this);
 this.queryAndUpdateGrid = this.queryAndUpdateGrid.bind(this);

 // this.job wraps this.queryAndUpdateGrid to avoid concurrent runs of the same job
Expand DownExpand Up@@ -106,7 +121,69 @@ class QueryScheduler {
 Object.keys(this.queryJobs).forEach(this.clearQuery);
 }

 queryAndUpdateGrid (fid, uids, queryString, connectionId, requestor) {
 queryAndCreateGrid(filename, query, connectionId, requestor) {
 const {username, apiKey, accessToken} = getCredentials(requestor);
 let startTime;

 // Check if the user even exists
 if (!username || !(apiKey || accessToken)) {
@tarzzztarzzzMay 28, 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.

We can simplify it:
if !(username || apiKey || accessToken) {

@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

tricky, but not equivalent: the latter doesn't catch the case when username is defined but both apiKey and accessToken are undefined.
 /*
 * Warning: The front end looks for "Unauthenticated" in this error message. Don't change it!
 */
 const errorMessage = (
 'Unauthenticated: Attempting to create a grid but the ' +
 `authentication credentials for the user "${username}" do not exist.`
 );
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }

 // Check if the credentials are valid
 return getCurrentUser(username).then(res => {
 if (res.status !== 200) {
 const errorMessage = (
 `Unauthenticated: ${getSetting('PLOTLY_API_URL')} failed to identify ${username}.`
 );
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }


 startTime = process.hrtime();

 Logger.log(`Querying "${query}" with connection ${connectionId} to create a new grid`, 2);
 return Connections.query(query, getConnectionById(connectionId));

 }).then(({rows, columnnames}) => {
 Logger.log(`Query "${query}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log('Create a new grid with new data', 2);
 Logger.log(`First row: ${JSON.stringify(rows.slice(0, 1))}`, 2);

 startTime = process.hrtime();

 return newGrid(
 filename,
 columnnames,
 rows,
 requestor
 );

 }).then(res => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);

 if (res.status !== 201) {
@shannonlalshannonlalMay 27, 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.

Should be putting this into a constants file with actual codes? I noticed below we have 200, 401, etc. If we used names would make code easier to read
@n-riescon-riescoMay 27, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

No, it'd make the code less readable (in this context it's clear 201 is an HTTP status code).
 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;
 });
 });

 }

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

Expand All@@ -118,16 +195,12 @@ class QueryScheduler {
 * If the user is the owner, then requestor === fid.split(':')[0]
 * If the user is a collaborator, then requestor is different
 */
 const username = requestor;
 const user = getSetting('USERS').find(
 u => u.username === username
 );
 const {username, apiKey, accessToken} = getCredentials(requestor);

 // Check if the user even exists
 if (!user || !(user.apiKey || user.accessToken)) {
 if (!username || !(apiKey || accessToken)) {
 /*
 * Heads up - the front end looks for "Unauthenticated" in this
 * error message. So don't change it!
 * Warning: The front end looks for "Unauthenticated" in this error message. Don't change it!
 */
 const errorMessage = (
 `Unauthenticated: Attempting to update grid ${fid} but the ` +
Expand All@@ -136,11 +209,9 @@ class QueryScheduler {
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }
 const {apiKey, accessToken} = user;

 // Check if the credentials are valid
 return PlotlyAPIRequest('users/current', {
 method: 'GET', username, apiKey, accessToken
 }).then(res => {
 return getCurrentUser(username).then(res => {
 if (res.status !== 200) {
 const errorMessage = (
 `Unauthenticated: ${getSetting('PLOTLY_API_URL')} failed to identify ${username}.`
Expand All@@ -149,21 +220,22 @@ class QueryScheduler {
 throw new Error(errorMessage);
 }

 Logger.log(`Querying "${queryString}" with connection ${connectionId} to update grid ${fid}`, 2);
 return Connections.query(queryString, requestedDBConnections);
 Logger.log(`Querying "${query}" with connection ${connectionId} to update grid ${fid}`, 2);
 return Connections.query(query, requestedDBConnections);

 }).then(rowsAndColumns => {
 }).then(({rows}) => {

 Logger.log(`Query "${queryString}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Query "${query}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Updating grid ${fid} with new data`, 2);
 Logger.log(
 'First row: ' +
 JSON.stringify(rowsAndColumns.rows.slice(0, 1)),
 JSON.stringify(rows.slice(0, 1)),
 2);

 startTime = process.hrtime();

 return updateGrid(
rowsAndColumns.rows,
 rows,
 fid,
 uids,
 requestor
Expand DownExpand Up@@ -196,16 +268,9 @@ class QueryScheduler {
 * make an additional API call to GET it
 */

 return PlotlyAPIRequest(
 `grids/${fid}`,
 {username, apiKey, accessToken, method: 'GET'}
 ).then(resFromGET => {
 return getGridMeta(fid, username).then(resFromGET => {
 if (resFromGET.status === 404) {
 Logger.log(('' +
 `Grid ID ${fid} doesn't exist on Plotly anymore, ` +
 'removing persistent query.'),
 2
 );
 Logger.log(`Grid ID ${fid} doesn't exist on Plotly anymore, removing persistent query.`, 2);
 this.clearQuery(fid);
 return deleteQuery(fid);
 }
Expand All@@ -216,7 +281,6 @@ class QueryScheduler {
 try {
 filemeta = JSON.parse(text);
 } catch (e) {
 // Well, that's annoying.
 Logger.log(`Failed to parse the JSON of request ${fid}`, 0);
 Logger.log(e);
 Logger.log('Text response: ' + text, 0);
Expand Down
Loading

, '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.

Implement API to create a grid to store results of a scheduled query#444
 Merged

n-riesco
merged 5 commits into

from

May 28, 2018
 Merged


Implement API to create a grid to store results of a scheduled query
#444
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
26ec584

PlotlyAPI: use lowercase filenames


n-riesco May 26, 2018
c26fa9d

settings: add getCredentials(username)


n-riesco May 26, 2018
b3504bf

PlotlyAPI: refactor


n-riesco May 27, 2018
3aa1c34

routes: extend entrypoint POST queries


n-riesco May 27, 2018
728888b

PlotlyAPI: rename getGridMetadat to getGridMeta


n-riesco May 27, 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


179 changes: 0 additions & 179 deletions
backend/persistent/PlotlyAPI.js

View file


Open in desktop


This file was deleted.


132 changes: 98 additions & 34 deletions
backend/persistent/QueryScheduler.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,32 @@
import * as Connections from './datastores/Datastores';
import {getConnectionById} from './Connections';
import {getQuery, getQueries, saveQuery, deleteQuery} from './Queries';
import {getSetting} from '../settings';
import Logger from '../logger';
import {PlotlyAPIRequest, updateGrid} from './PlotlyAPI';
import {has} from 'ramda';

import {getConnectionById} from './Connections.js';
import * as Connections from './datastores/Datastores.js';
import Logger from '../logger';
import {
 getQuery,
 getQueries,
 saveQuery,
 deleteQuery
} from './Queries.js';
@tarzzztarzzzMay 28, 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.

(Not necessarily in this PR) but we should small-case these filenames as well.. !! Queries, Datastore etc, and remove .js extensions to be consistent.. !!
@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I want to keep the extensions, because:
  • it's grep-friendly
  • we have imports that only differ in the extension (e.g. code-editor.css and code-editor.jsx)
@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

The idea is to move to lower case, whenever we have a chance (instead of having a huge big PR). We don't really want to spend time on it.
import {
 getCredentials,
 getSetting
} from '../settings.js';
import {
 getCurrentUser,
 getGridMeta,
 newGrid,
 updateGrid
} from './plotly-api.js';

class QueryScheduler {
 constructor() {
 this.scheduleQuery = this.scheduleQuery.bind(this);
 this.loadQueries = this.loadQueries.bind(this);
 this.clearQuery = this.clearQuery.bind(this);
 this.clearQueries = this.clearQueries.bind(this);
 this.queryAndCreateGrid = this.queryAndCreateGrid.bind(this);
 this.queryAndUpdateGrid = this.queryAndUpdateGrid.bind(this);

 // this.job wraps this.queryAndUpdateGrid to avoid concurrent runs of the same job
Expand DownExpand Up@@ -106,7 +121,69 @@ class QueryScheduler {
 Object.keys(this.queryJobs).forEach(this.clearQuery);
 }

 queryAndUpdateGrid (fid, uids, queryString, connectionId, requestor) {
 queryAndCreateGrid(filename, query, connectionId, requestor) {
 const {username, apiKey, accessToken} = getCredentials(requestor);
 let startTime;

 // Check if the user even exists
 if (!username || !(apiKey || accessToken)) {
@tarzzztarzzzMay 28, 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.

We can simplify it:
if !(username || apiKey || accessToken) {

@n-riescon-riescoMay 28, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

tricky, but not equivalent: the latter doesn't catch the case when username is defined but both apiKey and accessToken are undefined.
 /*
 * Warning: The front end looks for "Unauthenticated" in this error message. Don't change it!
 */
 const errorMessage = (
 'Unauthenticated: Attempting to create a grid but the ' +
 `authentication credentials for the user "${username}" do not exist.`
 );
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }

 // Check if the credentials are valid
 return getCurrentUser(username).then(res => {
 if (res.status !== 200) {
 const errorMessage = (
 `Unauthenticated: ${getSetting('PLOTLY_API_URL')} failed to identify ${username}.`
 );
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }


 startTime = process.hrtime();

 Logger.log(`Querying "${query}" with connection ${connectionId} to create a new grid`, 2);
 return Connections.query(query, getConnectionById(connectionId));

 }).then(({rows, columnnames}) => {
 Logger.log(`Query "${query}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log('Create a new grid with new data', 2);
 Logger.log(`First row: ${JSON.stringify(rows.slice(0, 1))}`, 2);

 startTime = process.hrtime();

 return newGrid(
 filename,
 columnnames,
 rows,
 requestor
 );

 }).then(res => {
 Logger.log(`Request to Plotly for creating a grid took ${process.hrtime(startTime)[0]} seconds`, 2);

 if (res.status !== 201) {
@shannonlalshannonlalMay 27, 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.

Should be putting this into a constants file with actual codes? I noticed below we have 200, 401, etc. If we used names would make code easier to read
@n-riescon-riescoMay 27, 2018

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

No, it'd make the code less readable (in this context it's clear 201 is an HTTP status code).
 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;
 });
 });

 }

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

Expand All@@ -118,16 +195,12 @@ class QueryScheduler {
 * If the user is the owner, then requestor === fid.split(':')[0]
 * If the user is a collaborator, then requestor is different
 */
 const username = requestor;
 const user = getSetting('USERS').find(
 u => u.username === username
 );
 const {username, apiKey, accessToken} = getCredentials(requestor);

 // Check if the user even exists
 if (!user || !(user.apiKey || user.accessToken)) {
 if (!username || !(apiKey || accessToken)) {
 /*
 * Heads up - the front end looks for "Unauthenticated" in this
 * error message. So don't change it!
 * Warning: The front end looks for "Unauthenticated" in this error message. Don't change it!
 */
 const errorMessage = (
 `Unauthenticated: Attempting to update grid ${fid} but the ` +
Expand All@@ -136,11 +209,9 @@ class QueryScheduler {
 Logger.log(errorMessage, 0);
 throw new Error(errorMessage);
 }
 const {apiKey, accessToken} = user;

 // Check if the credentials are valid
 return PlotlyAPIRequest('users/current', {
 method: 'GET', username, apiKey, accessToken
 }).then(res => {
 return getCurrentUser(username).then(res => {
 if (res.status !== 200) {
 const errorMessage = (
 `Unauthenticated: ${getSetting('PLOTLY_API_URL')} failed to identify ${username}.`
Expand All@@ -149,21 +220,22 @@ class QueryScheduler {
 throw new Error(errorMessage);
 }

 Logger.log(`Querying "${queryString}" with connection ${connectionId} to update grid ${fid}`, 2);
 return Connections.query(queryString, requestedDBConnections);
 Logger.log(`Querying "${query}" with connection ${connectionId} to update grid ${fid}`, 2);
 return Connections.query(query, requestedDBConnections);

 }).then(rowsAndColumns => {
 }).then(({rows}) => {

 Logger.log(`Query "${queryString}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Query "${query}" took ${process.hrtime(startTime)[0]} seconds`, 2);
 Logger.log(`Updating grid ${fid} with new data`, 2);
 Logger.log(
 'First row: ' +
 JSON.stringify(rowsAndColumns.rows.slice(0, 1)),
 JSON.stringify(rows.slice(0, 1)),
 2);

 startTime = process.hrtime();

 return updateGrid(
rowsAndColumns.rows,
 rows,
 fid,
 uids,
 requestor
Expand DownExpand Up@@ -196,16 +268,9 @@ class QueryScheduler {
 * make an additional API call to GET it
 */

 return PlotlyAPIRequest(
 `grids/${fid}`,
 {username, apiKey, accessToken, method: 'GET'}
 ).then(resFromGET => {
 return getGridMeta(fid, username).then(resFromGET => {
 if (resFromGET.status === 404) {
 Logger.log(('' +
 `Grid ID ${fid} doesn't exist on Plotly anymore, ` +
 'removing persistent query.'),
 2
 );
 Logger.log(`Grid ID ${fid} doesn't exist on Plotly anymore, removing persistent query.`, 2);
 this.clearQuery(fid);
 return deleteQuery(fid);
 }
Expand All@@ -216,7 +281,6 @@ class QueryScheduler {
 try {
 filemeta = JSON.parse(text);
 } catch (e) {
 // Well, that's annoying.
 Logger.log(`Failed to parse the JSON of request ${fid}`, 0);
 Logger.log(e);
 Logger.log('Text response: ' + text, 0);
Expand Down
Loading