Skip to content
This repository has been archived by the owner on Jan 17, 2023. It is now read-only.

Commit

Permalink
Update deprecations (#3031)
Browse files Browse the repository at this point in the history
* Fix #2743, update Raven usage
Removes deprecated calls to .patchGlobal and Raven.middleware

* Fix #2741, update mozlog usage
Adds logging module and removes use of mozlog.config
  • Loading branch information
ianb authored and jaredhirsch committed Jun 13, 2017
1 parent cf6e72a commit 3e49677
Show file tree
Hide file tree
Showing 12 changed files with 60 additions and 56 deletions.
2 changes: 1 addition & 1 deletion server/src/db.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const config = require("./config").getProperties();

const pg = require("pg");
const mozlog = require("mozlog")("db");
const mozlog = require("./logging").mozlog("db");

let user = encodeURIComponent(config.db.user);
let dbname = encodeURIComponent(config.db.dbname || config.db.user);
Expand Down
2 changes: 1 addition & 1 deletion server/src/dbschema.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ const db = require("./db");
const Keygrip = require('keygrip');
const pgpatcher = require("pg-patcher");
const path = require("path");
const mozlog = require("mozlog")("dbschema");
const mozlog = require("./logging").mozlog("dbschema");

const MAX_DB_LEVEL = exports.MAX_DB_LEVEL = 16;

Expand Down
2 changes: 1 addition & 1 deletion server/src/jobs.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/** Any reoccuring jobs we have to do */

const config = require("./config").getProperties();
const mozlog = require("mozlog")("jobs");
const mozlog = require("./logging").mozlog("jobs");
const ua = require("universal-analytics");

// Convert to milliseconds:
Expand Down
45 changes: 45 additions & 0 deletions server/src/logging.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
const config = require("./config").getProperties();

exports.mozlog = require("mozlog")({
app: "screenshots-server",
fmt: "pretty",
level: config.log.level,
debug: config.log.lint
});

exports.installConsoleHandler = function() {
const console_mozlog = exports.mozlog("console");
// We can't prevent any third party libraries from writing to the console,
// so monkey patch it so they play nice with mozlog.
function logFactory(level) {
let logger = console_mozlog[level].bind(console_mozlog);
return function() {
let msg = "";
let stack = undefined;
for (var i = 0; i < arguments.length; i++) {
let arg = arguments[i];
if (msg) {
msg += " ";
}
if (typeof arg === "string") {
msg += arg;
} else {
if (arg && arg.stack) {
if (stack) {
stack = stack + "\n\n" + arg.stack;
} else {
stack = arg.stack;
}
}
msg += JSON.stringify(arg);
}
}
logger(level, {msg, stack});
}
}

console.debug = logFactory("debug");
console.info = logFactory("info");
console.warn = logFactory("warn");
console.error = logFactory("error");
};
2 changes: 1 addition & 1 deletion server/src/pages/leave-screenshots/server.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ const express = require("express");
const csrf = require('csurf');
const reactrender = require("../../reactrender");
const { Shot } = require("../../servershot");
const mozlog = require("mozlog")("leave-screenshots");
const mozlog = require("../../logging").mozlog("leave-screenshots");

const csrfProtection = csrf({cookie: true});
let app = express();
Expand Down
2 changes: 1 addition & 1 deletion server/src/pages/metrics/server.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ const reactrender = require("../../reactrender");
const { checkLastStoreQueriesTime, storeQueries } = require("./model");
const config = require("../../config").getProperties();
const { captureRavenException } = require("../../ravenclient");
const mozlog = require("mozlog")("metrics");
const mozlog = require("../../logging").mozlog("metrics");

let app = exports.app = express();

Expand Down
2 changes: 1 addition & 1 deletion server/src/pages/shotindex/server.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ const express = require("express");
const csrf = require("csurf");
const reactrender = require("../../reactrender");
const { Shot } = require("../../servershot");
const mozlog = require("mozlog")("shotindex");
const mozlog = require("../../logging").mozlog("shotindex");

let app = express();

Expand Down
7 changes: 4 additions & 3 deletions server/src/ravenclient.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
const config = require("./config").getProperties();
const raven = require("raven");


let ravenClient = null;

if (config.sentryDSN) {
ravenClient = new raven.Client(config.sentryDSN);
ravenClient.patchGlobal();
ravenClient.install();
}

exports.sendRavenMessage = function(req, message, options) {
Expand All @@ -31,12 +32,12 @@ exports.captureRavenException = function() {

exports.addRavenRequestHandler = function(app) {
if (ravenClient) {
app.use(raven.middleware.express.requestHandler(ravenClient));
app.use(raven.requestHandler());
}
};

exports.addRavenErrorHandler = function(app) {
if (ravenClient) {
app.use(raven.middleware.express.errorHandler(ravenClient));
app.use(raven.errorHandler());
}
};
2 changes: 1 addition & 1 deletion server/src/responses.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const config = require("./config").getProperties();
const { captureRavenException } = require("./ravenclient");
const mozlog = require("mozlog")("server");
const mozlog = require("./logging").mozlog("server");

exports.simpleResponse = function(res, message, status) {
status = status || 200;
Expand Down
46 changes: 2 additions & 44 deletions server/src/server.js
Original file line number Diff line number Diff line change
@@ -1,48 +1,6 @@
const config = require("./config").getProperties();

require("mozlog").config({
app: "screenshots-server",
fmt: "pretty",
level: config.log.level,
debug: config.log.lint
});

const console_mozlog = require("mozlog")("console");
// We can't prevent any third party libraries from writing to the console,
// so monkey patch it so they play nice with mozlog.
function logFactory(level) {
let logger = console_mozlog[level].bind(console_mozlog);
return function() {
let msg = "";
let stack = undefined;
for (var i = 0; i < arguments.length; i++) {
let arg = arguments[i];
if (msg) {
msg += " ";
}
if (typeof arg === "string") {
msg += arg;
} else {
if (arg && arg.stack) {
if (stack) {
stack = stack + "\n\n" + arg.stack;
} else {
stack = arg.stack;
}
}
msg += JSON.stringify(arg);
}
}
logger(level, {msg, stack});
}
}

console.debug = logFactory("debug");
console.info = logFactory("info");
console.warn = logFactory("warn");
console.error = logFactory("error");

const mozlog = require("mozlog")("server");
require("./logging").installConsoleHandler();
const mozlog = require("./logging").mozlog("server");
const path = require('path');
const { readFileSync, existsSync } = require('fs');
const Cookies = require("cookies");
Expand Down
2 changes: 1 addition & 1 deletion server/src/servershot.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ const uuid = require("uuid");
const linker = require("./linker");
const config = require("./config").getProperties();
const fs = require("fs");
const mozlog = require("mozlog")("servershot");
const mozlog = require("./logging").mozlog("servershot");

const SEARCHABLE_VERSION = 1;

Expand Down
2 changes: 1 addition & 1 deletion server/src/users.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ const db = require("./db");
const errors = require("./errors");
const { request } = require("./helpers");
const crypto = require("crypto");
const mozlog = require("mozlog")("users");
const mozlog = require("./logging").mozlog("users");
const abTests = require("./ab-tests");

function hashMatches(hash, secret) {
Expand Down

0 comments on commit 3e49677

Please sign in to comment.