add ability to access logs in getPath() by codebytere · Pull Request #10191 · electron/electron

codebytere · 2017-08-03T22:54:15Z

Adds the ability to get logs via app.getPath('logs'), implementing feature requested in #10118.

MacOS
Linux
Windows

Nota Bene: Unlike MacOS, Linux & Windows do not create log folders until a log-worthy event happens, so this implementation lets the app developer ensure the directory exists. If anyone has an idea for an alternate way this could be dealt with please let me know!

groundwater · 2017-08-08T22:03:50Z

brightray/browser/browser_main_parts.cc


 namespace brightray {

+void OverrideMacAppLogsPath();


Add a comment about the Mac logs file being somewhere else because of Objective-C implementation.

MarshallOfSound · 2017-08-09T22:24:51Z

brightray/browser/browser_main_parts.cc


+// void OverrideWinAppLogsPath() {
+//   base::FilePath path;
+//   // should be in c:\program files\myapp\logs ?


The logs location should be in %LOCALAPPDATA% or %APPDATA so we don't need admin permissions to write the file

what commit are you looking at? that was replaced a while ago haha

Wow... I just clicked the link in my notifications and went to the diff 😕

weird 😆

should be

void OverrideWinAppLogsPath() { std::string appName = GetApplicationName(); std::string logPath = "%HOMEDRIVE%%HOMEPATH%\\AppData\\Roaming\\"; std::string appLogPath = logPath + appName + "\\logs"; int status = mkdir(appLogPath.c_str(), S_IRWXU | S_IRGRP | S_IROTH); PathService::Override(DIR_APP_LOGS, base::FilePath(appLogPath)); }

in the current tree :D

zeke · 2017-08-10T19:35:59Z

Hey @codebytere do you wanna take a shot at adding some docs for this too?

MarshallOfSound · 2017-08-14T16:20:40Z

brightray/browser/browser_main_parts.cc

    // to get the error. We can't call shutdown from this thread without
    // tripping an error. Doing it through a function so that we'll be able
-    // to see it in any crash dumps.
+    // to see it in any crash dumps.back


Awkward word 😄

MarshallOfSound · 2017-08-14T16:22:50Z

brightray/browser/browser_main_parts.cc

+void OverrideLinuxAppLogsPath() {
+  std::string appName = GetApplicationName();
+  std::string homePath = std:string(getenv("HOME"));
+  std::string appLogPath = homePath + "/.config/" + appName + "/logs";


We're gonna get users asking this to respect $XDG_CONFIG_HOME , current paths don't though (and there is an issue for it). So do what you will 😆

zeke · 2017-09-20T00:03:50Z

Sorry for not getting to this earlier, @codebytere. Would you mind rebasing with master and pushing the changes up to see if we can get CI passing?

zeke · 2017-09-24T02:39:26Z

@codebytere I rebased with master (again) and am seeing this error on CircleCI:

../../brightray/browser/browser_main_parts.cc:110:29: error: unexpected ':' in nested name specifier; did you mean '::'?
  std::string homePath = std:string(getenv("HOME"));

zeke · 2017-09-28T16:49:19Z

@zcbenz does this look good to you?

zcbenz · 2017-09-29T11:32:36Z

brightray/browser/browser_main_parts.cc

+  std::string logPath = "%HOMEDRIVE%%HOMEPATH%\\AppData\\Roaming\\";
+  std::string appLogPath = logPath + appName + "\\logs";
+
+  status = mkdir(appLogPath.c_str(), S_IRWXU | S_IRGRP | S_IROTH);


The App::GetPath API (which calls PathService::Get) automatically creates the dir so there is no need to create it here.

zcbenz · 2017-09-29T11:35:04Z

brightray/browser/browser_main_parts.cc


 namespace brightray {

+void OverrideMacAppLogsPath();


The OverrideMacAppLogsPath is probably better to be a member of BrowserMainParts to make things clearer, you can reference how InitializeMainNib was done.

zcbenz · 2017-09-29T11:35:53Z

brightray/browser/browser_main_parts.cc

 #include "brightray/browser/browser_main_parts.h"

+#include <stdlib.h>
+#include <sys/stat.h>


This header should be guarded with #if defined(OS_POSIX) since it is not available on Windows.

zcbenz · 2017-09-29T11:37:44Z

brightray/browser/browser_main_parts.cc


+void OverrideWinAppLogsPath() {
+  int status;
+  std::string appName = GetApplicationName();


Should use app_name to conform the coding style.

zcbenz · 2017-09-29T11:42:45Z

brightray/browser/browser_main_parts.cc

 BrowserMainParts::~BrowserMainParts() {
 }

+void OverrideWinAppLogsPath() {


OverrideWinAppLogsPath and OverrideLinuxAppLogsPath are similar enough to be merged into one function, and you can also rename OverrideMacAppLogsPath to the same to make code simpler:

#if defined(OS_WIN) || defined(OS_LINUX) void OverrideAppLogsPath() { std::string app_name = GetApplicationName(); #if defined(OS_WIN) ... std::string app_log_path = ... #else ... std::string app_log_path = ... #endif PathService::Override(DIR_APP_LOGS, base::FilePath(app_log_path)); } #endif void BrowserMainParts::PreEarlyInitialization() { ... OverrideAppLogsPath(); }

zcbenz · 2017-09-29T11:44:18Z

brightray/browser/browser_main_parts_mac.mm

+  NSString* logsPath = [NSString stringWithFormat:@"Library/Logs/%@",bundleName];
+
+  NSString* libraryPath = [NSHomeDirectory() stringByAppendingPathComponent:logsPath];
+  std::string libPathString = std::string([libraryPath UTF8String]);


base::FilePath accepts StringPiece as input, so the std::string is not needed:

base::FilePath([libraryPath UTF8String])

All requested changes were made.

pronebird · 2017-09-30T18:57:01Z

brightray/browser/browser_main_parts_mac.mm

+void BrowserMainParts::OverrideAppLogsPath() {
+  base::FilePath path;
+  NSString* bundleName = [[[NSBundle mainBundle] infoDictionary]
+    objectForKey:@"CFBundleName"];


(id)kCFBundleNameKey

jkleinsc changed the title ~~add ability to access logs in getPath()~~ [WIP] add ability to access logs in getPath() Aug 7, 2017

groundwater reviewed Aug 8, 2017

View reviewed changes

MarshallOfSound reviewed Aug 9, 2017

View reviewed changes

MarshallOfSound reviewed Aug 14, 2017

View reviewed changes

zeke self-assigned this Aug 16, 2017

codebytere force-pushed the add_log_path_support branch from 331b2eb to a71f1fd Compare September 20, 2017 02:44

zeke force-pushed the add_log_path_support branch from 4a8e0ad to f8b45a1 Compare September 24, 2017 02:30

zeke requested a review from zcbenz September 28, 2017 16:48

testinterntest and others added 14 commits September 28, 2017 13:35

add ability to access logs in getPath()

5ef4caf

add first go at linux log path override

f026bbb

appeasing the linter

3de0080

fix override path

e096b5c

add windows override path and cleanup linux

e81cf74

add dir creation if none exists

2353fdb

fix string concat errors

c1c8f7b

fix escape backslashes

d2d4b4c

update docs for new getPath() path

e05f610

fix header and line length lint errors

fc443a8

fix typo in comment

94f46c9

fix incorrect std namespacing

223942b

add function signature declaration

911e266

remove unresolved external symbol

0dfadf7

codebytere force-pushed the add_log_path_support branch from 75f37a2 to 0dfadf7 Compare September 28, 2017 17:35

codebytere requested review from a team September 28, 2017 17:35

move overrides into the appropriate namespace

c620d0d

codebytere changed the title ~~[WIP] add ability to access logs in getPath()~~ add ability to access logs in getPath() Sep 29, 2017

zcbenz previously requested changes Sep 29, 2017

View reviewed changes

codebytere added 2 commits September 29, 2017 09:32

consolidate code and rename for clarity

e7bb553

convert to wstring for windows

96f1a25

zeke approved these changes Sep 29, 2017

View reviewed changes

zeke merged commit 9f89587 into master Sep 29, 2017

zeke deleted the add_log_path_support branch September 29, 2017 18:11

pronebird reviewed Sep 30, 2017

View reviewed changes

Conversation

codebytere commented Aug 3, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codebytere Aug 9, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zeke commented Aug 10, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MarshallOfSound Aug 14, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zeke commented Sep 20, 2017

Uh oh!

zeke commented Sep 24, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zeke commented Sep 28, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

codebytere commented Aug 3, 2017 •

edited

Loading

codebytere Aug 9, 2017 •

edited

Loading

MarshallOfSound Aug 14, 2017 •

edited

Loading

zeke commented Sep 24, 2017 •

edited

Loading