Merge pull request #10 from keboola/adamvyborny-COM-1550-improve-logging

Improve logging

Author: AdamVyborny

.github/workflows/push.yml

@@ -0,0 +1,34 @@
+name: 'GitHub Actions'
+'on':
+  - push
+concurrency: 'ci-${{ github.ref }}'
+env:
+  APP_IMAGE: keboola/google-client-bundle
+  DOCKERHUB_USER: '${{ secrets.DOCKERHUB_USER }}'
+  DOCKERHUB_TOKEN: '${{ secrets.DOCKERHUB_TOKEN }}'
+
+  CLIENT_ID: '${{ secrets.CLIENT_ID }}'
+  CLIENT_SECRET: '${{ secrets.CLIENT_SECRET }}'
+  REFRESH_TOKEN: '${{ secrets.REFRESH_TOKEN }}'
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: 'Check out the repo'
+        uses: actions/checkout@v2
+      -
+        name: 'Docker login'
+        if: env.DOCKERHUB_TOKEN
+        run: 'docker login --username "$DOCKERHUB_USER" --password "$DOCKERHUB_TOKEN"'
+      -
+        name: 'Build image'
+        run: 'docker build -t $APP_IMAGE .'
+      -
+        name: 'Run tests'
+        run: |
+          docker run \
+          -e CLIENT_ID \
+          -e CLIENT_SECRET \
+          -e REFRESH_TOKEN \
+          ${{env.APP_IMAGE}} composer ci

.travis.yml

@@ -1,4 +1,3 @@
 # Keboola Google API Client
-[![Build Status](https://travis-ci.org/keboola/google-client-bundle.svg?branch=master)](https://travis-ci.org/keboola/google-client-bundle)
 
 Basic client for Google APIs  

README.md

@@ -278,12 +278,10 @@ protected function logRetryRequest(
         ?ResponseInterface $response = null
     ): void {
         if ($this->logger !== null) {
-            $headersForLog = array_map(function ($item, $key) {
-                if (strtolower($key) === 'authorization') {
-                    return '*****';
-                }
-                return $item;
-            }, $request->getHeaders(), array_keys($request->getHeaders()));
+            $headersForLog = $request->getHeaders();
+            if (array_key_exists('authorization', array_change_key_case($headersForLog, CASE_LOWER))) {
+                $headersForLog['Authorization'] = '*****';
+            }
 
             $context = [
                 'request' => [
@@ -300,9 +298,14 @@ protected function logRetryRequest(
                     'reason' => $response->getReasonPhrase(),
                     'body' => $response->getBody()->getContents(),
                 ];
-            }
 
-            $this->logger->info(sprintf('Retrying request (%sx)', $retries), $context);
+                $this->logger->info(
+                    sprintf('Retrying request (%sx) - reason: %s', $retries, $response->getReasonPhrase()),
+                    $context
+                );
+            } else {
+                $this->logger->info(sprintf('Retrying request (%sx)', $retries), $context);
+            }
         }
     }
 

src/Google/RestApi.php

@@ -118,7 +118,35 @@ public function testRetries(): void
 
         foreach ($this->testHandler->getRecords() as $key => $value) {
             $this->assertEquals(Logger::INFO, $value['level']);
-            $this->assertEquals(sprintf('Retrying request (%dx)', $key), $value['message']);
+            $this->assertEquals(sprintf('Retrying request (%dx) - reason: Not Found', $key), $value['message']);
+            $this->assertEquals(
+                [
+                    'request' => [
+                        'uri' => 'https://www.googleapis.com/auth/invalid-scope',
+                        'headers' => [
+                            'User-Agent' => ['GuzzleHttp/6.5.5 curl/7.74.0 PHP/7.4.30'],
+                            'Host' => ['www.googleapis.com'],
+                            'Accept' => ['application/json'],
+                            'Authorization' => '*****',
+
+                        ],
+                        'method' => 'GET',
+                        'body' => '',
+                    ],
+                    'response' => [
+                        'statusCode' => 404,
+                        'reason' => 'Not Found',
+                        'body' => 'You are receiving this error either because your input OAuth2 scope name is ' .
+                            "invalid or it refers to a newer scope that is outside the domain of this legacy API.\n\n" .
+                            'This API was built at a time when the scope name format was not yet standardized. This ' .
+                            'is no longer the case and all valid scope names (both old and new) are catalogued at ' .
+                            'https://developers.google.com/identity/protocols/oauth2/scopes. Use that webpage to' .
+                            ' lookup (manually) the scope name associated with the API you are trying to call and use' .
+                            " it to craft your OAuth2 request.\n",
+                    ],
+                ],
+                $value['context']
+            );
         }
     }