Merge pull request #6262 from DFurnes/log-all-the-stars

Log all the stars

Author: DFurnes

lib/modules/dosomething/dosomething_northstar/dosomething_northstar.admin.inc

@@ -49,5 +49,16 @@ function dosomething_northstar_config_form($form, &$form_state) {
     '#default_value' => variable_get('dosomething_northstar_app_key', 'abc4324'),
   );
 
+  $form['log'] = [
+    '#type' => 'fieldset',
+    '#title' => t('Logging'),
+  ];
+  $form['log']['dosomething_northstar_log'] = [
+    '#type' => 'checkbox',
+    '#title' => t('Log requests and responses.'),
+    '#default_value' => variable_get('dosomething_northstar_log', FALSE),
+    '#description' => t("Logs Northstar activity. This should be disabled on production."),
+  ];
+
   return system_settings_form($form);
 }

lib/modules/dosomething/dosomething_northstar/dosomething_northstar.install

@@ -10,6 +10,59 @@
  */
 function dosomething_northstar_schema() {
   $schema['cache_dosomething_northstar'] = drupal_get_schema_unprocessed('system', 'cache');
+
+  $schema['dosomething_northstar_request_log'] = [
+    'description' => 'Log of requests made to Northstar for debugging.',
+    'fields' => [
+      'uid' => [
+        'description' => 'The user\'s Drupal UID',
+        'type' => 'int',
+        'not null' => TRUE,
+        'default' => 0,
+      ],
+      'op' => [
+        'description' => 'The operation being performed',
+        'type' => 'varchar',
+        'length' => 255,
+        'default' => '',
+      ],
+      'user_lang' => [
+        'description' => 'The user\'s language',
+        'type' => 'varchar',
+        'length' => 255,
+        'default' => '',
+      ],
+      'user_country' => [
+        'description' => 'The user\'s country code',
+        'type' => 'varchar',
+        'length' => 255,
+        'default' => '',
+      ],
+      'fastly_country' => [
+        'description' => 'The Fastly country code',
+        'type' => 'varchar',
+        'length' => 255,
+        'default' => '',
+      ],
+      'request_values' => [
+        'description' => 'The JSON request made to Northstar',
+        'type' => 'varchar',
+        'length' => 5000,
+        'default' => '',
+      ],
+      'response_code' => [
+        'description' => 'The HTTP response code from Northstar',
+        'type' => 'int',
+        'default' => 0,
+      ],
+      'response_values' => [
+        'description' => 'The JSON response from Northstar',
+        'type' => 'varchar',
+        'length' => 5000,
+      ],
+    ],
+  ];
+
   return $schema;
 }
 
@@ -24,3 +77,13 @@ function dosomething_northstar_update_7001() {
     db_create_table('cache_dosomething_northstar', $schema['cache_dosomething_northstar']);
   }
 }
+
+/**
+ * Create a new table "dosomething_northstar_request_log" for logging details of any
+ * Northstar request errors that occur.
+ */
+function dosomething_northstar_update_7002() {
+  $table_name = 'dosomething_northstar_request_log';
+  $schema = dosomething_northstar_schema();
+  db_create_table($table_name, $schema[$table_name]);
+}

lib/modules/dosomething/dosomething_northstar/dosomething_northstar.module

@@ -52,6 +52,7 @@ function dosomething_northstar_libraries_info() {
  * @return mixed|null
  */
 function dosomething_northstar_verify_user($credentials) {
+  global $user;
   $client = _dosomething_northstar_build_http_client();
 
   $response = drupal_http_request($client['base_url'] . '/auth/verify', [
@@ -60,6 +61,9 @@ function dosomething_northstar_verify_user($credentials) {
     'data' => json_encode($credentials),
   ]);
 
+  // Add to request log if enabled.
+  dosomething_northstar_log_request('verify_user', $user, $credentials, $response);
+
   if($response->code !== '200') {
     return null;
   }
@@ -99,6 +103,8 @@ function dosomething_northstar_register_user($form_state) {
     watchdog('dosomething_northstar', 'User not migrated : ' . $response->code, NULL, WATCHDOG_ERROR);
   }
 
+  // Add to request log if enabled.
+  dosomething_northstar_log_request('register_user', $user, $ns_user, $response);
 }
 
 /**
@@ -132,7 +138,6 @@ function dosomething_northstar_update_user($form_state) {
   $id = $user->uid;
   $ns_user = dosomething_northstar_build_ns_user($user, $form_state);
 
-  $northstar = new Northstar();
   $client = _dosomething_northstar_build_http_client();
 
   $response = drupal_http_request($client['base_url'] . '/users/drupal_id/' . $id, array(
@@ -148,6 +153,38 @@ function dosomething_northstar_update_user($form_state) {
     watchdog('dosomething_northstar', 'User not updated : ' . $response->code, NULL, WATCHDOG_ERROR);
   }
 
+  // Add to request log if enabled.
+  dosomething_northstar_log_request('update_user', $user, $ns_user, $response);
+}
+
+/**
+ * If the log is enabled, log this request to the database.
+ *
+ * @param string $op - label for the operation being performed
+ * @param object $user - the Drupal user
+ * @param array $request_body - the body of the request
+ * @param string $response - response JSON
+ */
+function dosomething_northstar_log_request($op, $user, $request_body, $response) {
+  if (!variable_get('dosomething_northstar_log')) return;
+
+  // Don't log plaintext passwords.
+  if (isset($request_body['password'])) {
+    $request_body['password'] = '*****';
+  }
+
+  db_insert('dosomething_northstar_request_log')
+    ->fields([
+      'op' => $op,
+      'uid' => $user->uid,
+      'user_lang' => $user->language,
+      'user_country' => $user->field_address[LANGUAGE_NONE][0]['country'],
+      'fastly_country' => dosomething_settings_get_geo_country_code(),
+      'request_values' => json_encode($request_body),
+      'response_code' => $response->code,
+      'response_values' => $response->data,
+    ])
+    ->execute();
 }
 
 /**