[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-panel-devel
Subject:    [Differential] [Changed Subscribers] D2295: improve logging for kscreen
From:       "davidedmundson (David Edmundson)" <noreply () phabricator ! kde ! org>
Date:       2016-07-28 10:44:48
Message-ID: 20160728104448.11194.98033.AFCA793E () phabricator ! kde ! org
[Download RAW message or body]

[Attachment #2 (multipart/alternative)]


davidedmundson added inline comments.

INLINE COMMENTS

> log.cpp:30
> +Log* Log::sInstance = nullptr;
> +QtMessageHandler sDefaultMessageHandler = nullptr;
> +

why have it separate instead of a member of log?

> log.cpp:35
> +    QByteArray localMsg = msg.toLocal8Bit();
> +    if (QString::fromLocal8Bit(context.category).startsWith(QStringLiteral("kscreen"))) \
> { +        Log::log(localMsg.constData(), context.category);

QLatin1String.

> log.cpp:46
> +
> +Log* Log::instance()
> +{

Question:
What's the threading policy on libkscreen?

This isn't reentrant (which might be fine)

> log.cpp:71
> +
> +    if (qEnvironmentVariableIsSet(logging_env)) {
> +        const QString logging_env_value = qgetenv(logging_env).constData();

you probably want to manually force the logging category to enable itself if this env \
var is set.

or get rid of this env var, and just check if the logging category is enabled.

> log.cpp:136
> +    const QString timestamp = \
> QString::number(QDateTime::currentDateTime().toMSecsSinceEpoch()); +    QString \
> logMessage = QString("\n%1 ; %2 ; %3 : %4").arg(timestamp, _cat, \
> instance()->context(), msg); +    QFile file(instance()->logFile());

why call instance() from inside a member function?
it'll always return this.

> log.cpp:137
> +    QString logMessage = QString("\n%1 ; %2 ; %3 : %4").arg(timestamp, _cat, \
> instance()->context(), msg); +    QFile file(instance()->logFile());
> +    if (!file.open(QIODevice::Append | QIODevice::Text)) {

You're going to need a file lock round this aren't you?
The entire point is that two processes will be writing in here at the same time.

REPOSITORY
  rLIBKSCREEN KScreen Library

BRANCH
  sebas/log

REVISION DETAIL
  https://phabricator.kde.org/D2295

EMAIL PREFERENCES
  https://phabricator.kde.org/settings/panel/emailpreferences/

To: sebas, #plasma, bshah
Cc: davidedmundson, bshah, plasma-devel, ali-mohamed, jensreuterberg, abetts, sebas


[Attachment #5 (text/html)]

<table><tr><td style="">davidedmundson added inline comments.</td><a \
style="text-decoration: none; padding: 4px 8px; margin: 0 8px 8px; float: right; \
color: #464C5C; font-weight: bold; border-radius: 3px; background-color: #F7F7F9; \
background-image: linear-gradient(to bottom,#fff,#f1f0f1); display: inline-block; \
border: 1px solid rgba(71,87,120,.2);" href="https://phabricator.kde.org/D2295" \
rel="noreferrer">View Revision</a></tr></table><br /><div><strong>INLINE \
COMMENTS</strong><div><div style="margin: 6px 0 12px 0;"><div style="border: 1px \
solid #C7CCD9; border-radius: 3px;"><div style="padding: 0; background: #F7F7F7; \
border-color: #e3e4e8; border-style: solid; border-width: 0 0 1px 0; margin: 0;"><div \
style="color: #74777d; background: #eff2f4; padding: 6px 8px; overflow: hidden;"><a \
style="float: right; text-decoration: none;" \
href="https://phabricator.kde.org/D2295#inline-9203" rel="noreferrer">View \
Inline</a><span style="color: #4b4d51; font-weight: bold;">log.cpp:30</span></div> \
<div style="font: 11px/15px &quot;Menlo&quot;, &quot;Consolas&quot;, \
&quot;Monaco&quot;, monospace; white-space: pre-wrap; clear: both; padding: 4px 0; \
margin: 0;"><div style="padding: 0 8px; margin: 0 4px; background: #d0ffd0;"><span \
class="n">Log</span><span style="color: #aa2211">*</span> <span \
class="n">Log</span><span style="color: #aa2211">::</span><span \
class="n">sInstance</span> <span style="color: #aa2211">=</span> <span style="color: \
#aa4000">nullptr</span><span class="p">;</span> </div><div style="padding: 0 8px; \
margin: 0 4px; background: #d0ffd0;"><span class="n">QtMessageHandler</span> <span \
class="n">sDefaultMessageHandler</span> <span style="color: #aa2211">=</span> <span \
style="color: #aa4000">nullptr</span><span class="p">;</span> </div></div></div>
<div style="margin: 8px 0; padding: 0 12px;"><p style="padding: 0; margin: 8px;">why \
have it separate instead of a member of log?</p></div></div><br /><div style="border: \
1px solid #C7CCD9; border-radius: 3px;"><div style="padding: 0; background: #F7F7F7; \
border-color: #e3e4e8; border-style: solid; border-width: 0 0 1px 0; margin: 0;"><div \
style="color: #74777d; background: #eff2f4; padding: 6px 8px; overflow: hidden;"><a \
style="float: right; text-decoration: none;" \
href="https://phabricator.kde.org/D2295#inline-9205" rel="noreferrer">View \
Inline</a><span style="color: #4b4d51; font-weight: bold;">log.cpp:35</span></div> \
<div style="font: 11px/15px &quot;Menlo&quot;, &quot;Consolas&quot;, \
&quot;Monaco&quot;, monospace; white-space: pre-wrap; clear: both; padding: 4px 0; \
margin: 0;"><div style="padding: 0 8px; margin: 0 4px; background: #d0ffd0;">    \
<span class="n">QByteArray</span> <span class="n">localMsg</span> <span style="color: \
#aa2211">=</span> <span class="n">msg</span><span class="p">.</span><span \
class="n">toLocal8Bit</span><span class="p">();</span> </div><div style="padding: 0 \
8px; margin: 0 4px; background: #d0ffd0;">    <span style="color: #aa4000">if</span> \
<span class="p">(</span><span class="n">QString</span><span style="color: \
#aa2211">::</span><span class="n">fromLocal8Bit</span><span class="p">(</span><span \
class="n">context</span><span class="p">.</span><span class="n">category</span><span \
class="p">).</span><span class="n">startsWith</span><span class="p">(</span><span \
class="n">QStringLiteral</span><span class="p">(</span><span style="color: \
#766510">&quot;kscreen&quot;</span><span class="p">)))</span> <span \
class="p">{</span> </div><div style="padding: 0 8px; margin: 0 4px; background: \
#d0ffd0;">        <span class="n">Log</span><span style="color: \
#aa2211">::</span><span class="n">log</span><span class="p">(</span><span \
class="n">localMsg</span><span class="p">.</span><span \
class="n">constData</span><span class="p">(),</span> <span \
class="n">context</span><span class="p">.</span><span class="n">category</span><span \
class="p">);</span> </div></div></div>
<div style="margin: 8px 0; padding: 0 12px;"><p style="padding: 0; margin: \
8px;">QLatin1String.</p></div></div><br /><div style="border: 1px solid #C7CCD9; \
border-radius: 3px;"><div style="padding: 0; background: #F7F7F7; border-color: \
#e3e4e8; border-style: solid; border-width: 0 0 1px 0; margin: 0;"><div style="color: \
#74777d; background: #eff2f4; padding: 6px 8px; overflow: hidden;"><a style="float: \
right; text-decoration: none;" href="https://phabricator.kde.org/D2295#inline-9204" \
rel="noreferrer">View Inline</a><span style="color: #4b4d51; font-weight: \
bold;">log.cpp:46</span></div> <div style="font: 11px/15px &quot;Menlo&quot;, \
&quot;Consolas&quot;, &quot;Monaco&quot;, monospace; white-space: pre-wrap; clear: \
both; padding: 4px 0; margin: 0;"><div style="padding: 0 8px; margin: 0 4px; \
background: #d0ffd0;"><span class="n">Log</span><span style="color: #aa2211">*</span> \
<span class="n">Log</span><span style="color: #aa2211">::</span><span \
class="n">instance</span><span class="p">()</span> </div><div style="padding: 0 8px; \
margin: 0 4px; background: #d0ffd0;"><span class="p">{</span> </div></div></div>
<div style="margin: 8px 0; padding: 0 12px;"><p style="padding: 0; margin: \
8px;">Question:<br /> What&#039;s the threading policy on libkscreen?</p>

<p style="padding: 0; margin: 8px;">This isn&#039;t reentrant (which might be \
fine)</p></div></div><br /><div style="border: 1px solid #C7CCD9; border-radius: \
3px;"><div style="padding: 0; background: #F7F7F7; border-color: #e3e4e8; \
border-style: solid; border-width: 0 0 1px 0; margin: 0;"><div style="color: #74777d; \
background: #eff2f4; padding: 6px 8px; overflow: hidden;"><a style="float: right; \
text-decoration: none;" href="https://phabricator.kde.org/D2295#inline-9207" \
rel="noreferrer">View Inline</a><span style="color: #4b4d51; font-weight: \
bold;">log.cpp:71</span></div> <div style="font: 11px/15px &quot;Menlo&quot;, \
&quot;Consolas&quot;, &quot;Monaco&quot;, monospace; white-space: pre-wrap; clear: \
both; padding: 4px 0; margin: 0;"><div style="padding: 0 8px; margin: 0 4px; \
background: #d0ffd0;">    <span style="color: #aa4000">if</span> <span \
class="p">(</span><span class="n">qEnvironmentVariableIsSet</span><span \
class="p">(</span><span class="n">logging_env</span><span class="p">))</span> <span \
class="p">{</span> </div><div style="padding: 0 8px; margin: 0 4px; background: \
#d0ffd0;">        <span style="color: #aa4000">const</span> <span \
class="n">QString</span> <span class="n">logging_env_value</span> <span style="color: \
#aa2211">=</span> <span class="n">qgetenv</span><span class="p">(</span><span \
class="n">logging_env</span><span class="p">).</span><span \
class="n">constData</span><span class="p">();</span> </div></div></div>
<div style="margin: 8px 0; padding: 0 12px;"><p style="padding: 0; margin: 8px;">you \
probably want to manually force the logging category to enable itself if this env var \
is set.</p>

<p style="padding: 0; margin: 8px;">or get rid of this env var, and just check if the \
logging category is enabled.</p></div></div><br /><div style="border: 1px solid \
#C7CCD9; border-radius: 3px;"><div style="padding: 0; background: #F7F7F7; \
border-color: #e3e4e8; border-style: solid; border-width: 0 0 1px 0; margin: 0;"><div \
style="color: #74777d; background: #eff2f4; padding: 6px 8px; overflow: hidden;"><a \
style="float: right; text-decoration: none;" \
href="https://phabricator.kde.org/D2295#inline-9206" rel="noreferrer">View \
Inline</a><span style="color: #4b4d51; font-weight: bold;">log.cpp:136</span></div> \
<div style="font: 11px/15px &quot;Menlo&quot;, &quot;Consolas&quot;, \
&quot;Monaco&quot;, monospace; white-space: pre-wrap; clear: both; padding: 4px 0; \
margin: 0;"><div style="padding: 0 8px; margin: 0 4px; background: #d0ffd0;">    \
<span style="color: #aa4000">const</span> <span class="n">QString</span> <span \
class="n">timestamp</span> <span style="color: #aa2211">=</span> <span \
class="n">QString</span><span style="color: #aa2211">::</span><span \
class="n">number</span><span class="p">(</span><span class="n">QDateTime</span><span \
style="color: #aa2211">::</span><span class="n">currentDateTime</span><span \
class="p">().</span><span class="n">toMSecsSinceEpoch</span><span \
class="p">());</span> </div><div style="padding: 0 8px; margin: 0 4px; background: \
#d0ffd0;">    <span class="n">QString</span> <span class="n">logMessage</span> <span \
style="color: #aa2211">=</span> <span class="n">QString</span><span \
class="p">(</span><span style="color: #766510">&quot;</span><span style="color: \
#bb6622">\n</span><span style="color: #766510">%1 ; %2 ; %3 : %4&quot;</span><span \
class="p">).</span><span class="n">arg</span><span class="p">(</span><span \
class="n">timestamp</span><span class="p">,</span> <span class="n">_cat</span><span \
class="p">,</span> <span class="n">instance</span><span class="p">()</span><span \
style="color: #aa2211">-&gt;</span><span class="n">context</span><span \
class="p">(),</span> <span class="n">msg</span><span class="p">);</span> </div><div \
style="padding: 0 8px; margin: 0 4px; background: #d0ffd0;">    <span \
class="n">QFile</span> <span style="color: #004012">file</span><span \
class="p">(</span><span class="n">instance</span><span class="p">()</span><span \
style="color: #aa2211">-&gt;</span><span class="n">logFile</span><span \
class="p">());</span> </div></div></div>
<div style="margin: 8px 0; padding: 0 12px;"><p style="padding: 0; margin: 8px;">why \
call instance() from inside a member function?<br /> it&#039;ll always return \
this.</p></div></div><br /><div style="border: 1px solid #C7CCD9; border-radius: \
3px;"><div style="padding: 0; background: #F7F7F7; border-color: #e3e4e8; \
border-style: solid; border-width: 0 0 1px 0; margin: 0;"><div style="color: #74777d; \
background: #eff2f4; padding: 6px 8px; overflow: hidden;"><a style="float: right; \
text-decoration: none;" href="https://phabricator.kde.org/D2295#inline-9210" \
rel="noreferrer">View Inline</a><span style="color: #4b4d51; font-weight: \
bold;">log.cpp:137</span></div> <div style="font: 11px/15px &quot;Menlo&quot;, \
&quot;Consolas&quot;, &quot;Monaco&quot;, monospace; white-space: pre-wrap; clear: \
both; padding: 4px 0; margin: 0;"><div style="padding: 0 8px; margin: 0 4px; \
background: #d0ffd0;">    <span class="n">QString</span> <span \
class="n">logMessage</span> <span style="color: #aa2211">=</span> <span \
class="n">QString</span><span class="p">(</span><span style="color: \
#766510">&quot;</span><span style="color: #bb6622">\n</span><span style="color: \
#766510">%1 ; %2 ; %3 : %4&quot;</span><span class="p">).</span><span \
class="n">arg</span><span class="p">(</span><span class="n">timestamp</span><span \
class="p">,</span> <span class="n">_cat</span><span class="p">,</span> <span \
class="n">instance</span><span class="p">()</span><span style="color: \
#aa2211">-&gt;</span><span class="n">context</span><span class="p">(),</span> <span \
class="n">msg</span><span class="p">);</span> </div><div style="padding: 0 8px; \
margin: 0 4px; background: #d0ffd0;">    <span class="n">QFile</span> <span \
style="color: #004012">file</span><span class="p">(</span><span \
class="n">instance</span><span class="p">()</span><span style="color: \
#aa2211">-&gt;</span><span class="n">logFile</span><span class="p">());</span> \
</div><div style="padding: 0 8px; margin: 0 4px; background: #d0ffd0;">    <span \
style="color: #aa4000">if</span> <span class="p">(</span><span style="color: \
#aa2211">!</span><span class="n">file</span><span class="p">.</span><span \
class="n">open</span><span class="p">(</span><span class="n">QIODevice</span><span \
style="color: #aa2211">::</span><span class="n">Append</span> <span style="color: \
#aa2211">|</span> <span class="n">QIODevice</span><span style="color: \
#aa2211">::</span><span class="n">Text</span><span class="p">))</span> <span \
class="p">{</span> </div></div></div>
<div style="margin: 8px 0; padding: 0 12px;"><p style="padding: 0; margin: \
8px;">You&#039;re going to need a file lock round this aren&#039;t you?<br /> The \
entire point is that two processes will be writing in here at the same \
time.</p></div></div></div></div></div><br \
/><div><strong>REPOSITORY</strong><div><div>rLIBKSCREEN KScreen \
Library</div></div></div><br \
/><div><strong>BRANCH</strong><div><div>sebas/log</div></div></div><br \
/><div><strong>REVISION DETAIL</strong><div><a \
href="https://phabricator.kde.org/D2295" \
rel="noreferrer">https://phabricator.kde.org/D2295</a></div></div><br \
/><div><strong>EMAIL PREFERENCES</strong><div><a \
href="https://phabricator.kde.org/settings/panel/emailpreferences/" \
rel="noreferrer">https://phabricator.kde.org/settings/panel/emailpreferences/</a></div></div><br \
/><div><strong>To: </strong>sebas, Plasma, bshah<br /><strong>Cc: \
</strong>davidedmundson, bshah, plasma-devel, ali-mohamed, jensreuterberg, abetts, \
sebas<br /></div>


[Attachment #6 (text/plain)]

_______________________________________________
Plasma-devel mailing list
Plasma-devel@kde.org
https://mail.kde.org/mailman/listinfo/plasma-devel


[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic