school/web-api-manager
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

add ability to log what specific methods were blocked

Browse source
This commit is contained in:
Peter Snyder 2017-10-14 23:23:40 -05:00
parent fc4ecef273
commit eefd6bde58
9 changed files with 99 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
background_scripts/background.js
View file

@ -11,12 +11,14 @@
// (or the default option, "(default)"), to an array of standards
// that should be blocked on matching domains.
let domainRules;
let shouldLog;
// The extension depends on this fetch happening before the DOM on any
// pages is loaded. The Chrome and Firefox docs *do not* promise this,
// but in testing this is always the case.
storageLib.get(function (loadedDomainRules) {
domainRules = loadedDomainRules;
storageLib.get(function (storedValues) {
domainRules = storedValues.domainRules;
shouldLog = storedValues.shouldLog;
});
// Manage the state of the browser activity, by displaying the number
@ -66,7 +68,7 @@
// Listen for updates to the domain rules from the config page.
// The two types of messages that are sent to the background page are
// "rulesUpdate", which comes from the config page, indicating the domain
// "stateUpdate", which comes from the config page, indicating the domain
// blocking / matching rules have changed, and the "rulesForDomains"
// message, which comes from the browserAction popup, and is a request
// for information about "here are the domains of the frames on the
@ -74,8 +76,9 @@
rootObject.runtime.onMessage.addListener(function (request, ignore, sendResponse) {
const [label, data] = request;
if (label === "rulesUpdate") {
domainRules = data;
if (label === "stateUpdate") {
domainRules = data.domainRules;
shouldLog = data.shouldLog;
return;
}
@ -127,7 +130,12 @@
details.responseHeaders.push({
name: "Set-Cookie",
value: `web-api-manager=${packedValues}`
value: `wam-standards=${packedValues}`
});
details.responseHeaders.push({
name: "Set-Cookie",
value: `wam-log=${shouldLog ? "true" : "false"}`
});
return {

7
config/index.html
View file

@ -22,8 +22,10 @@
</div>
</div>
<div class="row">
<div class="col-xs-4 col-md-4 well">
<div class="col-xs-4 col-md-4">
<domain-rules :domain-names="domainNames" :selected-domain="selectedDomain"></domain-rules>
<logging-settings :should-log="shouldLog"></logging-settings>
</div>
<div class="col-xs-8 col-md-8">
@ -37,11 +39,12 @@
<script src="../lib/init.js"></script>
<script src="../content_scripts/dist/defaults.js"></script>
<script src="../content_scripts/dist/standards.js"></script>
<script src="../lib/storage.js"></script>
<script src="../lib/storage.js"></script>
<script src="js/lib/vue.js"></script>
<script src="js/state.js"></script>
<script src="js/components/domain-rules.vue.js"></script>
<script src="js/components/web-api-standards.vue.js"></script>
<script src="js/components/logging-settings.vue.js"></script>
<script src="js/config.js"></script>
</body>
</html>

4
config/js/components/domain-rules.vue.js
View file

@ -6,7 +6,7 @@
Vue.component("domain-rules", {
props: ["domainNames", "selectedDomain"],
template: `
<div class="domain-rules-container">
<div class="domain-rules-container well">
<div class="radio" v-for="aDomain in domainNames">
<label>
<input type="radio"
@ -29,7 +29,7 @@
<input class="form-control" v-model.trim="newDomain" placeholder="*.example.org">
</div>
<button type="submit" class="btn btn-default" @click="newDomainSubmitted">Submit</button>
<button type="submit" class="btn btn-default btn-block" @click="newDomainSubmitted">Add Rule</button>
</div>
`,
data: function () {

26
config/js/components/logging-settings.vue.js Normal file
View file

@ -0,0 +1,26 @@
/*jslint es6: true, this: true*/
/*global window, Vue*/
(function () {
"use strict";
Vue.component("logging-settings", {
props: ["shouldLog"],
template: `
<div class="logging-settings">
<div class="checkbox">
<label>
<input type="checkbox"
v-model="shouldLog"
@change="shouldLogChanged">
Log blocked functionality?
</label>
</div>
</div>
`,
methods: {
shouldLogChanged: function () {
this.$root.$data.setShouldLog(this.shouldLog);
}
}
});
}());

13
config/js/config.js
View file

@ -11,9 +11,9 @@
const state = stateLib.generateStateObject(defaultDomain, standards);
const onSettingsLoaded = function (loadedDomainRules) {
const onSettingsLoaded = function (storedSettings) {
state.setDomainRules(loadedDomainRules);
state.populateFromStorage(storedSettings);
const vm = new Vue({
el: doc.body,
@ -21,18 +21,17 @@
});
const updateStoredSettings = function () {
storageLib.set(state.domainRules, function () {
rootObject.runtime.sendMessage(["rulesUpdate", state.domainRules]);
storageLib.set(state.toStorage(), function () {
rootObject.runtime.sendMessage(["stateUpdate", state.toStorage()]);
});
};
vm.$watch("selectedStandards", updateStoredSettings);
vm.$watch("domainNames", updateStoredSettings);
vm.$watch("shouldLog", updateStoredSettings);
};
const onPageLoad = function () {
window.onload = function () {
storageLib.get(onSettingsLoaded);
};
window.onload = onPageLoad;
}());

18
config/js/state.js
View file

@ -4,6 +4,7 @@
"use strict";
const defaultDomain = "(default)";
const {packingLib, standards} = window.WEB_API_MANAGER;
const generateStateObject = function (initialDomain, standards) {
@ -12,8 +13,21 @@
standards: standards,
domainRules: {},
domainNames: [],
shouldLog: false,
selectedStandards: [],
toStorage: function () {
return {
domainRules: this.domainRules,
shouldLog: this.shouldLog
};
},
populateFromStorage: function (storedValues) {
this.setDomainRules(storedValues.domainRules);
this.setShouldLog(storedValues.shouldLog);
},
setDomainRules: function (newDomainRules) {
this.domainRules = newDomainRules;
this.domainNames = Object.keys(newDomainRules);
@ -47,6 +61,10 @@
this.domainNames = Object.keys(this.domainRules);
this.selectedDomain = newDomainRule;
this.selectedStandards = this.domainRules[newDomainRule];
},
setShouldLog: function (shouldLog) {
this.shouldLog = shouldLog;
}
};

12
content_scripts/src/instrument.js
View file

@ -8,18 +8,22 @@
const script = document.createElement('script');
const rootElm = document.head || document.documentElement;
const cookieKey = "web-api-manager";
const standardsCookieKey = "wam-standards";
const {packingLib, standards} = window.WEB_API_MANAGER;
const options = Object.keys(standards);
const packedValues = Cookies.get(cookieKey);
const packedValues = Cookies.get(standardsCookieKey);
const standardsToBlock = packingLib.unpack(options, packedValues);
Cookies.remove(cookieKey);
Cookies.remove(standardsCookieKey);
const shouldLogCookieKey = "wam-log";
const shouldLog = Cookies.get(shouldLogCookieKey);
Cookies.remove(shouldLogCookieKey);
const code = `
window.WEB_API_MANAGER_PAGE = {
standards: ${JSON.stringify(standards)},
toBlock: ${JSON.stringify(standardsToBlock)},
shouldLog: false
shouldLog: ${shouldLog}
};
###-INJECTED-PROXY-BLOCKING-CODE-###
`;

10
content_scripts/src/proxyblock.js
View file

@ -10,6 +10,7 @@
const shouldLog = settings.shouldLog;
const standardsToBlock = settings.toBlock;
const standardDefinitions = settings.standards;
const hostName = window.location.hostname;
const defaultFunction = function () {};
const funcPropNames = Object.getOwnPropertyNames(defaultFunction);
@ -59,9 +60,12 @@
let hasBeenLogged = false;
const logKeyPath = function () {
if (keyPath !== undefined && hasBeenLogged === false) {
if (keyPath !== undefined &&
hasBeenLogged === false &&
shouldLog) {
hasBeenLogged = true;
console.info(keyPath);
console.log("Blocked '" + keyPath + "' on '" + hostName + "'");
}
};
@ -128,6 +132,7 @@
}
try {
if (shouldLog === true) {
parentRef[lastPropertyName] = createBlockingProxy(keyPath);
return true;
@ -136,6 +141,7 @@
parentRef[lastPropertyName] = defaultBlockingProxy;
return true;
} catch (e) {
if (shouldLog) {
console.log("Error instrumenting " + keyPath + ": " + e);
}

18
lib/storage.js
View file

@ -4,23 +4,29 @@
"use strict";
const rootObject = window.browser || window.chrome;
const webApiManagerKeySettingsKey = "webApiManagerDomainRules";
const webApiManagerKeySettingsKey = "webApiManager";
const storageObject = rootObject.storage;
const get = function (callback) {
storageObject.local.get(webApiManagerKeySettingsKey, function (results) {
let loadedDomainRules = results && results[webApiManagerKeySettingsKey];
let loadedValues = results && results[webApiManagerKeySettingsKey];
// If there are no currently saved domain rules, then create
// a stubbed out one, using an empty blocking rule set.
if (!loadedDomainRules || Object.keys(loadedDomainRules).length === 0) {
loadedDomainRules = {
"(default)": []
if (!loadedValues ||
!loadedValues.domainRules ||
Object.keys(loadedValues.domainRules).length === 0) {
loadedValues = {
domainRules: {
"(default)": []
},
shouldLog: false
};
}
callback(loadedDomainRules);
callback(loadedValues);
});
};