<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[12481] sites/trunk/api.wordpress.org/public_html/dotorg/helpscout: Helpscout: Record some contributor stats.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/12481">12481</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/12481","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-03-17 09:16:45 +0000 (Fri, 17 Mar 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Helpscout: Record some contributor stats.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmldotorghelpscoutcommonphp">sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/common.php</a></li>
<li><a href="#sitestrunkapiwordpressorgpublic_htmldotorghelpscoutwebhookphp">sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/webhook.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkapiwordpressorgpublic_htmldotorghelpscoutcommonphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/common.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/common.php 2023-03-17 08:53:04 UTC (rev 12480)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/common.php 2023-03-17 09:16:45 UTC (rev 12481)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -233,6 +233,60 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return array_filter( $possible );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Determine the WordPress.org username for a Helpscout user ID.
+ *
+ * @param int $user_id Helpscout user ID.
+ * @return \WP_User WordPress.org user object.
+ */
+function get_wporg_user_for_helpscout_user( $hs_id, $instance = false ) {
+ wp_cache_add_global_groups( 'helpscout-users' );
+
+ if ( ! $hs_id ) {
+ return false;
+ }
+
+ $client = get_client( $instance );
+ $cache_key = "{$client->name}:{$hs_id}";
+
+ $user_id = wp_cache_get( $cache_key, 'helpscout-users', false, $found );
+ if ( $found ) {
+ return $user_id ? get_user_by( 'id', $user_id ) : false;
+ }
+
+ $hs_user = $client->get( "/users/{$hs_id}" );
+ if ( empty( $hs_user->email ) ) {
+ return false;
+ }
+
+ $emails = array_unique( array_merge( $hs_user->alternateEmails, [ $hs_user->email ] ) );
+
+ // Sort emails by string length
+ usort( $emails, function( $a, $b ) {
+ return strlen( $b ) <=> strlen( $a );
+ } );
+
+ foreach ( $emails as $email ) {
+ if ( preg_match( '!^(?P<user>.+)@(chat|git).wordpress.org$!i', $email, $m ) ) {
+ $user = get_user_by( 'login', $m['user'] );
+ if ( $user ) {
+ break;
+ }
+ }
+
+ $user = get_user_by( 'email', $email );
+ if ( $user ) {
+ break;
+ }
+ }
+
+ if ( $user ) {
+ wp_cache_set( $cache_key, $user->ID, 'helpscout-users', MONTH_IN_SECONDS );
+ }
+
+ return $user;
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // HelpScout sends json data in the POST, so grab it from the input directly.
</span><span class="cx" style="display: block; padding: 0 10px"> $HTTP_RAW_POST_DATA = file_get_contents( 'php://input' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="sitestrunkapiwordpressorgpublic_htmldotorghelpscoutwebhookphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/webhook.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/webhook.php 2023-03-17 08:53:04 UTC (rev 12480)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/webhook.php 2023-03-17 09:16:45 UTC (rev 12481)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,27 +1,101 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+namespace WordPressdotorg\API\HelpScout;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Webhook fired when an event is fired for any inbox.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// Events: Conversation Created (convo.created)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Events: Conversation Created (convo.created), convo.assigned, convo.customer.reply.created, convo.merged, convo.agent.reply.created, convo.deleted, convo.status, convo.moved
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // $request is the validated HelpScout request.
</span><span class="cx" style="display: block; padding: 0 10px"> $request = include __DIR__ . '/common.php';
</span><span class="cx" style="display: block; padding: 0 10px"> $event = $_SERVER['HTTP_X_HELPSCOUT_EVENT'] ?? '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-if (
- defined( 'HELPSCOUT_OPENVERSE_WEBHOOK' ) && HELPSCOUT_OPENVERSE_WEBHOOK &&
- defined( 'HELPSCOUT_OPENVERSE_MAILBOXID' ) && HELPSCOUT_OPENVERSE_MAILBOXID &&
- 'convo.created' === $event &&
- isset( $request->mailboxId ) && HELPSCOUT_OPENVERSE_MAILBOXID === $request->mailboxId
-) {
- $subject = $request->subject;
- $url = $request->_links->web->href;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Handle the openverse webhook.
+openverse_webhook( $event, $request );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_safe_remote_post(
- HELPSCOUT_OPENVERSE_WEBHOOK,
- [
- 'body' => wp_json_encode( compact( 'subject', 'url' ) )
- ]
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Warm the caches.
+get_email_thread( $request->id, true );
+
+// Record stats.
+contributor_stats( $event, $request );
+
+/**
+ * Ping the Openverse webhook.
+ */
+function openverse_webhook( $event, $request ) {
+ if (
+ 'production' === wp_get_environment_type() &&
+ defined( 'HELPSCOUT_OPENVERSE_WEBHOOK' ) && HELPSCOUT_OPENVERSE_WEBHOOK &&
+ defined( 'HELPSCOUT_OPENVERSE_MAILBOXID' ) && HELPSCOUT_OPENVERSE_MAILBOXID &&
+ 'convo.created' === $event &&
+ isset( $request->mailboxId ) && HELPSCOUT_OPENVERSE_MAILBOXID === $request->mailboxId
+ ) {
+ $subject = $request->subject;
+ $url = $request->_links->web->href;
+
+ wp_safe_remote_post(
+ HELPSCOUT_OPENVERSE_WEBHOOK,
+ [
+ 'body' => wp_json_encode( compact( 'subject', 'url' ) )
+ ]
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// Warm the caches.
-get_email_thread( $request->id, true );
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Record some Contributor stats.
+ *
+ * These are recorded through Webhook events, instead of through the Helpscout API, as the Helpscout stats API is focused around
+ * user KPI's, of which assigning emails, marking as spam, closing, etc. do not correspond to the type of data we want to track.
+ *
+ * @param string $event The Helpscout event.
+ * @param object $request The Helpscout payload.
+ */
+function contributor_stats( $event, $request ) {
+ bump_stats_extra( 'helpscout', $event );
+
+ $hs_user_id = false;
+ $hs_author_fields = [
+ $request->createdBy ?? false,
+ $request->closedByUser ?? false,
+ $request->_embedded->threads[0]->createdBy ?? false,
+ ];
+
+ foreach ( $hs_author_fields as $item ) {
+ if ( ! $item || ! isset( $item->id, $item->type ) || 'user' !== $item->type ) {
+ continue;
+ }
+
+ // User ID 0 is "unknown"/not-set, user ID 1 is HelpScout / Automations.
+ if ( $item->id > 1 ) {
+ $hs_user_id = $item->id;
+ break;
+ }
+ }
+
+ if ( ! $hs_user_id ) {
+ return;
+ }
+
+ // Determine the WordPress.org user for this HelpScout user.
+ $wporg_user = get_wporg_user_for_helpscout_user( $hs_user_id );
+ if ( $wporg_user ) {
+ $stat_user = $wporg_user->user_nicename;
+ } else {
+ $client = get_client();
+ $stat_user = "HS-{$client->name}-{$hs_user_id}";
+ }
+
+ // Total actions performed by user.
+ bump_stats_extra( 'hs-total', $stat_user );
+
+ // Specific actions performed by user, replies and outgoing emails are counted as replies.
+ switch ( $event ) {
+ case 'convo.agent.reply.created':
+ bump_stats_extra( 'hs-replies', $stat_user );
+ break;
+ case 'convo.created':
+ if ( 'user' === $request->createdBy->type ?? '' ) {
+ bump_stats_extra( 'hs-replies', $stat_user );
+ }
+ break;
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>