This repository has been archived by the owner on Sep 6, 2021. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11311 from adobe/abose/HealthLogs1.4
Health Data Logs for 1.4
- Loading branch information
Showing
6 changed files
with
264 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| /* | ||
| * Copyright (c) 2015 Adobe Systems Incorporated. All rights reserved. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a | ||
| * copy of this software and associated documentation files (the "Software"), | ||
| * to deal in the Software without restriction, including without limitation | ||
| * the rights to use, copy, modify, merge, publish, distribute, sublicense, | ||
| * and/or sell copies of the Software, and to permit persons to whom the | ||
| * Software is furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
| * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER | ||
| * DEALINGS IN THE SOFTWARE. | ||
| * | ||
| */ | ||
|
|
||
| /*jslint vars: true, plusplus: true, devel: true, nomen: true, regexp: true, indent: 4, maxerr: 50 */ | ||
| /*global define, $*/ | ||
|
|
||
| /** | ||
| * Utilities functions related to Health Data logging | ||
| */ | ||
| define(function (require, exports, module) { | ||
| "use strict"; | ||
|
|
||
| var PreferencesManager = require("preferences/PreferencesManager"), | ||
| LanguageManager = require("language/LanguageManager"), | ||
| FileUtils = require("file/FileUtils"), | ||
| PerfUtils = require("utils/PerfUtils"), | ||
|
|
||
| HEALTH_DATA_STATE_KEY = "HealthData.Logs", | ||
| logHealthData = true; | ||
|
|
||
| /** | ||
| * Init: creates the health log preference keys in the state.json file | ||
| */ | ||
| function init() { | ||
| PreferencesManager.stateManager.definePreference(HEALTH_DATA_STATE_KEY, "object", {}); | ||
| } | ||
|
|
||
| /** | ||
| * All the logging functions should be disabled if this returns false | ||
| * @returns {boolean} true if health data can be logged | ||
| */ | ||
| function shouldLogHealthData() { | ||
| return logHealthData; | ||
| } | ||
|
|
||
| /** | ||
| * Return the Performance related data | ||
| * @returns {Object} Performance Data aggregated till now | ||
| */ | ||
| function getPerformanceData() { | ||
| return PerfUtils.getHealthReport(); | ||
| } | ||
|
|
||
| /** | ||
| * Return all health data logged till now stored in the state prefs | ||
| * @returns {Object} Health Data aggregated till now | ||
| */ | ||
| function getStoredHealthData() { | ||
| return PreferencesManager.getViewState(HEALTH_DATA_STATE_KEY); | ||
| } | ||
|
|
||
| /** | ||
| * Return the aggregate of all health data logged till now from all sources | ||
| * @returns {Object} Health Data aggregated till now | ||
| */ | ||
| function getAggregatedHealthData() { | ||
| var healthData = getStoredHealthData(); | ||
| $.extend(healthData, getPerformanceData()); | ||
| return healthData; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the health data | ||
| * @param {Object} dataObject The object to be stored as health data | ||
| */ | ||
| function setHealthData(dataObject) { | ||
| if (!shouldLogHealthData()) { | ||
| return; | ||
| } | ||
| PreferencesManager.setViewState(HEALTH_DATA_STATE_KEY, dataObject); | ||
| } | ||
|
|
||
| /** | ||
| * Returns health data logged for the given key | ||
| * @returns {Object} Health Data object for the key or undefined if no health data stored | ||
| */ | ||
| function getHealthDataLog(key) { | ||
| var healthData = getStoredHealthData(); | ||
| return healthData[key]; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the health data for the given key | ||
| * @param {Object} dataObject The object to be stored as health data for the key | ||
| */ | ||
| function setHealthDataLog(key, dataObject) { | ||
| var healthData = getStoredHealthData(); | ||
| healthData[key] = dataObject; | ||
| setHealthData(healthData); | ||
| } | ||
|
|
||
| /** | ||
| * Clears all the health data recorded till now | ||
| */ | ||
| function clearHealthData() { | ||
| PreferencesManager.setViewState(HEALTH_DATA_STATE_KEY, {}); | ||
| //clear the performance related health data also | ||
| PerfUtils.clear(); | ||
| } | ||
|
|
||
| /** | ||
| * Enable or disable health data logs | ||
| * @param {boolean} enabled true to enable health logs | ||
| */ | ||
| function setHealthLogsEnabled(enabled) { | ||
| logHealthData = enabled; | ||
| if (!enabled) { | ||
| clearHealthData(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Whenever a file is opened call this function. The function will record the number of times | ||
| * the standard file types have been opened. We only log the standard filetypes | ||
| * @param {String} filePath The path of the file to be registered | ||
| * @param {boolean} addedToWorkingSet set to true if extensions of files added to the | ||
| * working set needs to be logged | ||
| */ | ||
| function fileOpened(filePath, addedToWorkingSet) { | ||
| if (!shouldLogHealthData()) { | ||
| return; | ||
| } | ||
| var fileExtension = FileUtils.getFileExtension(filePath), | ||
| language = LanguageManager.getLanguageForPath(filePath), | ||
| healthData = getStoredHealthData(), | ||
| fileExtCountMap = []; | ||
| healthData.fileStats = healthData.fileStats || { | ||
| openedFileExt : {}, | ||
| workingSetFileExt : {} | ||
| }; | ||
| if (language.getId() !== "unknown") { | ||
| fileExtCountMap = addedToWorkingSet ? healthData.fileStats.workingSetFileExt : healthData.fileStats.openedFileExt; | ||
| if (!fileExtCountMap[fileExtension]) { | ||
| fileExtCountMap[fileExtension] = 0; | ||
| } | ||
| fileExtCountMap[fileExtension]++; | ||
| setHealthData(healthData); | ||
| } | ||
| } | ||
|
|
||
| // Define public API | ||
| exports.getHealthDataLog = getHealthDataLog; | ||
| exports.setHealthDataLog = setHealthDataLog; | ||
| exports.getAggregatedHealthData = getAggregatedHealthData; | ||
| exports.clearHealthData = clearHealthData; | ||
| exports.fileOpened = fileOpened; | ||
| exports.setHealthLogsEnabled = setHealthLogsEnabled; | ||
| exports.shouldLogHealthData = shouldLogHealthData; | ||
| exports.init = init; | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.