This repository has been archived by the owner on Sep 6, 2021. It is now read-only.
Health Data Logs for 1.4 #11311
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,167 @@ | ||
| /* | ||
| * 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, jQuery*/ | ||
|
|
||
| /** | ||
| * Utilities functions related to Health data loggig | ||
|
There was a problem hiding this comment. typo: |
||
| */ | ||
| 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", {}); | ||
| } | ||
|
|
||
| /** | ||
| * Return the Performance related data | ||
| * @returns {Object} Performance Data aggregated till now | ||
| */ | ||
| function getPerformanceData() { | ||
| var perfData = PerfUtils.getHealthReport(); | ||
| return perfData; | ||
|
There was a problem hiding this comment. This would be simple. function getPerformanceData() {
return PerfUtils.getHealthReport();
} |
||
| } | ||
|
|
||
| /** | ||
| * Return the aggregate of all health data logged till now from all sources | ||
| * @returns {Object} Health Data aggregated till now | ||
| */ | ||
| function getAggregatedHealthData() { | ||
| var healthData = PreferencesManager.getViewState(HEALTH_DATA_STATE_KEY); | ||
|
There was a problem hiding this comment. Better call |
||
| jQuery.extend(healthData, getPerformanceData()); | ||
|
There was a problem hiding this comment. We usually use |
||
| return healthData; | ||
| } | ||
|
|
||
| /** | ||
| * Return all health data logged till now stored in the state prefs | ||
| * @returns {Object} Health Data aggregated till now | ||
| */ | ||
| function getHealthData() { | ||
|
There was a problem hiding this comment. A name like |
||
| var healthData = PreferencesManager.getViewState(HEALTH_DATA_STATE_KEY); | ||
| return healthData; | ||
| } | ||
|
There was a problem hiding this comment. This could also apply here. |
||
|
|
||
| /** | ||
| * Sets the health data | ||
| * @param {Object} dataObject The object to be stored as health data | ||
| */ | ||
| function setHealthData(dataObject) { | ||
| 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 = getHealthData(); | ||
| 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 = getHealthData(); | ||
| healthData[key] = dataObject; | ||
| setHealthData(healthData); | ||
| } | ||
|
|
||
| /** | ||
| * Clears all the health data recorded till now | ||
| */ | ||
| function clearHealthData() { | ||
| PreferencesManager.setViewState(HEALTH_DATA_STATE_KEY, {}); | ||
| //clear the preformance relaed health data also | ||
|
There was a problem hiding this comment. typos |
||
| PerfUtils.clear(); | ||
| } | ||
|
|
||
| /** | ||
| * Enable or disable health data logs | ||
| * @param {Boolean} enabled true to enable health logs | ||
| */ | ||
| function setHealthLogsEnabled(enabled) { | ||
| logHealthData = enabled; | ||
| if (!enabled) { | ||
| clearHealthData(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * All the logging functions should be disabled if this returns false | ||
| * @returns {Boolean} true if health data can be logged | ||
| */ | ||
| function shouldLogHealthData() { | ||
| return logHealthData; | ||
| } | ||
|
There was a problem hiding this comment. This function is a simple getter that is used only once and also not being exported, so we could eliminate it and use There was a problem hiding this comment. exported for access from other modules for future use. |
||
|
|
||
| /** | ||
| * When ever 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), | ||
|
There was a problem hiding this comment.
|
||
| language = LanguageManager.getLanguageForPath(filePath), | ||
| healthData = getHealthData(); | ||
| healthData.fileStats = healthData.fileStats || { | ||
| openedFileExt : {}, | ||
| workingSetFileExt : {} | ||
| }; | ||
| if (language.getId() !== "unknown") { | ||
|
There was a problem hiding this comment. Belated, but: is there a reason we don't want to log unrecognized file extensions too? Seems like it'd be a useful way of identifying gaps in our default set of syntax highlighters & file-extension mappings... There was a problem hiding this comment. File names and extensions I think are personal information. So it felt like one step short of sending all filenames opened in brackets to the servers- which makes even me paranoid. 😖 |
||
| if (addedToWorkingSet) { | ||
| healthData.fileStats.workingSetFileExt[fileextension] = healthData.fileStats.workingSetFileExt[fileextension] ? healthData.fileStats.workingSetFileExt[fileextension] + 1 : 1; | ||
| } else { | ||
| healthData.fileStats.openedFileExt[fileextension] = healthData.fileStats.openedFileExt[fileextension] ? healthData.fileStats.openedFileExt[fileextension] + 1 : 1; | ||
| } | ||
| setHealthData(healthData); | ||
| } | ||
| } | ||
|
|
||
| // Define public API | ||
| exports.getHealthDataLog = getHealthDataLog; | ||
| exports.setHealthDataLog = setHealthDataLog; | ||
| exports.getAggregatedHealthData = getAggregatedHealthData; | ||
| exports.clearHealthData = clearHealthData; | ||
| exports.fileOpened = fileOpened; | ||
| exports.setHealthLogsEnabled = setHealthLogsEnabled; | ||
| 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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This way, we call
fileOpenedtwo times (one time forhandleFileOpen, then forhandleFileAddToWorkingSetAndOpen). Is it meant to be like this?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it is meant to track twice, one log tracks all files opened to working set, and another the total of all files opened.