Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow additional comments to be added at initialization time #250

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+285 −230
Open

Allow additional comments to be added at initialization time #250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
218 changes: 114 additions & 104 deletions nodejs/sqlcommenter-nodejs/packages/sqlcommenter-knex/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,113 +12,122 @@
// See the License for the specific language governing permissions and
// limitations under the License.

const {hasComment} = require('./util');
const provider = require('./provider');
const hook = require('./hooks');
const { hasComment } = require("./util");
const provider = require("./provider");
const hook = require("./hooks");

const defaultFields = {
'route': true,
'tracestate': false,
'traceparent': false,
route: true,
tracestate: false,
traceparent: false,
};

/**
* All available variables for the commenter are on the `util.fields` object
* passing the include parameter will result in each item being excluded from
* the commenter output
*
*
* @param {Object} Knex
* @param {Object} include - A map of values to be optionally included.
* @param {Object} options - A configuration object specifying where to collect trace data from. Accepted fields are:
* TraceProvider: Should be either 'OpenCensus' or 'OpenTelemetry', indicating which library to collect trace data from.
* @param {Object} additionalComments - A map of strings or functions returning strings that should be included in all comments.
* @return {void}
*/
exports.wrapMainKnex = (Knex, include={}, options={}) => {

/* c8 ignore next 2 */
if (Knex.___alreadySQLCommenterWrapped___)
return;

const query = Knex.Client.prototype.query;

// TODO: Contemplate patch for knex's stream prototype
// in addition to the query for commenterization.

// Please don't change this prototype from an explicit function
// to use arrow functions lest we'll get bugs with not resolving "this".
Knex.Client.prototype.query = function(conn, obj) {

// If Knex.VERSION() is available, that means they are using a version of knex.js < 0.16.1
// because as per https://github.com/tgriesser/knex/blob/master/CHANGELOG.md#0161---28-nov-2018
// Knex.VERSION was removed in favour of `require('knex/package').version`

const sqlStmt = typeof obj === 'string' ? obj : obj.sql;

// If a comment already exists, do not insert a new one.
// See internal issue #20.
if (hasComment(sqlStmt)) // Just proceed with the next function ASAP
return query.apply(this, [conn, obj]);

const knexVersion = getKnexVersion(Knex);
const comments = {
db_driver: `knex:${knexVersion}`
};

if (Knex.__middleware__) {
const context = hook.getContext();
if (context && context.req) {
comments.route = context.req.route.path;
}
}

// Add trace context to comments, depending on the current provider.
provider.attachComments(options.TraceProvider, comments);

const filtering = typeof include === 'object' && include && Object.keys(include).length > 0;
// Filter out keys whose values are undefined or aren't to be included by default.
const keys = Object.keys(comments).filter((key) => {
/* c8 ignore next 6 */
if (!filtering)
return defaultFields[key] && comments[key];

// Otherwise since we are filtering, we have to
// see if the field is included and if it set.
return include[key] && comments[key];
});

// Finally sort the keys alphabetically.
keys.sort();

const commentStr = keys.map((key) => {
const uri_encoded_key = encodeURIComponent(key);
const uri_encoded_value = encodeURIComponent(comments[key]);
return `${uri_encoded_key}='${uri_encoded_value}'`;
}).join(',');

if (typeof obj === 'string') {
obj = {sql: `${sqlStmt} /*${commentStr}*/`};
} else {
obj.sql = `${sqlStmt} /*${commentStr}*/`;
}

return query.apply(this, [conn, obj]);
exports.wrapMainKnex = (
Knex,
include = {},
options = {},
additionalComments = {}
) => {
/* c8 ignore next 2 */
if (Knex.___alreadySQLCommenterWrapped___) return;

const query = Knex.Client.prototype.query;

// TODO: Contemplate patch for knex's stream prototype
// in addition to the query for commenterization.

// Please don't change this prototype from an explicit function
// to use arrow functions lest we'll get bugs with not resolving "this".
Knex.Client.prototype.query = function (conn, obj) {
// If Knex.VERSION() is available, that means they are using a version of knex.js < 0.16.1
// because as per https://github.com/tgriesser/knex/blob/master/CHANGELOG.md#0161---28-nov-2018
// Knex.VERSION was removed in favour of `require('knex/package').version`

const sqlStmt = typeof obj === "string" ? obj : obj.sql;

// If a comment already exists, do not insert a new one.
// See internal issue #20.
if (hasComment(sqlStmt))
// Just proceed with the next function ASAP
return query.apply(this, [conn, obj]);

const knexVersion = getKnexVersion(Knex);
const comments = {};
for (const [key, comment] of Object.entries(additionalComments)) {
comments[key] = typeof comment === "function" ? comment() : comment;
}
comments["db_driver"] = `knex:${knexVersion}`;

// Finally mark the object as having already been wrapped.
Knex.___alreadySQLCommenterWrapped___ = true;
}

const resolveKnexVersion = () => {
if (Knex.__middleware__) {
const context = hook.getContext();
if (context && context.req) {
comments.route = context.req.route.path;
}
}

try {
return require('knex/package').version;
} catch (err) {
// Perhaps they are using an old version of knex.js.
// That is because knex.js as per
// https://github.com/tgriesser/knex/blob/master/CHANGELOG.md#0161---28-nov-2018
// Knex.VERSION() was removed in favor of `require('knex/package').version`
return null;
// Add trace context to comments, depending on the current provider.
provider.attachComments(options.TraceProvider, comments);

const filtering =
typeof include === "object" && include && Object.keys(include).length > 0;
// Filter out keys whose values are undefined or aren't to be included by default.
const keys = Object.keys(comments).filter((key) => {
if (additionalComments[key]) return true;

/* c8 ignore next 6 */
if (!filtering) return defaultFields[key] && comments[key];

// Otherwise since we are filtering, we have to
// see if the field is included and if it set.
return include[key] && comments[key];
});

// Finally sort the keys alphabetically.
keys.sort();

const commentStr = keys
.map((key) => {
const uri_encoded_key = encodeURIComponent(key);
const uri_encoded_value = encodeURIComponent(comments[key]);
return `${uri_encoded_key}='${uri_encoded_value}'`;
})
.join(",");

if (typeof obj === "string") {
obj = { sql: `${sqlStmt} /*${commentStr}*/` };
} else {
obj.sql = `${sqlStmt} /*${commentStr}*/`;
}

return query.apply(this, [conn, obj]);
};

// Finally mark the object as having already been wrapped.
Knex.___alreadySQLCommenterWrapped___ = true;
};

const resolveKnexVersion = () => {
try {
return require("knex/package").version;
} catch (err) {
// Perhaps they are using an old version of knex.js.
// That is because knex.js as per
// https://github.com/tgriesser/knex/blob/master/CHANGELOG.md#0161---28-nov-2018
// Knex.VERSION() was removed in favor of `require('knex/package').version`
return null;
}
};

// Since resolveKnexVersion performs expensive lookups by imports,
Expand All @@ -127,28 +136,29 @@ const resolvedKnexVersion = resolveKnexVersion();

// Use getKnexVersion to find out the version of knex being used.
const getKnexVersion = (Knex) => {
return Knex && typeof Knex.VERSION === 'function' ? Knex.VERSION() : resolvedKnexVersion;
}
return Knex && typeof Knex.VERSION === "function"
? Knex.VERSION()
: resolvedKnexVersion;
};

/**
* All available variables for the commenter are on the `util.fields` object
* passing the include parameter will result items not available in that map
* only being included in the comment.
*
* @param {Object} Knex
*
* @param {Object} Knex
* @param {Object} include - A map of variables to include. If unset, we'll use default attributes.
* @param {Object} options - A configuration object specifying where to collect trace data from. Accepted fields are:
* TraceProvider: Should be either 'OpenCensus' or 'OpenTelemetry', indicating which library to collect trace data from.
* @return {Function} A middleware that is compatible with the express framework.
*/
exports.wrapMainKnexAsMiddleware = (Knex, include=null, options) => {

exports.wrapMainKnex(Knex, include, options);

return (req, res, next) => {
data = { req: req };
hook.createContext(data);
Knex.__middleware__ = true;
next();
}
}
exports.wrapMainKnexAsMiddleware = (Knex, include = null, options) => {
exports.wrapMainKnex(Knex, include, options);

return (req, res, next) => {
data = { req: req };
hook.createContext(data);
Knex.__middleware__ = true;
next();
};
};
Loading