Type safe!

Author: leocavalcante

bin/etl.php

@@ -3,9 +3,7 @@
 namespace AdsWarehouse;
 
 use AdsWarehouse\Account\Account;
-use AdsWarehouse\ETL\AdWords;
-use AdsWarehouse\ETL\ETL;
-use AdsWarehouse\ETL\FacebookAds;
+use AdsWarehouse\ETL\{AdWords, ETL, FacebookAds};
 use FacebookAds\Api;
 use FacebookAds\Logger\CurlLogger;
 use Google_Client;
@@ -14,35 +12,46 @@
 use Monolog\Handler\ErrorLogHandler;
 use PDO;
 use Siler\Monolog as Log;
+use function Siler\Env\{env_bool, env_var};
 
-date_default_timezone_set(getenv('TZ'));
+require_once __DIR__ . '/../vendor/autoload.php';
 
-$basedir = dirname(__DIR__, 1);
-require_once "$basedir/vendor/autoload.php";
+date_default_timezone_set(env_var('TZ'));
 
 Log\handler(new ErrorLogHandler());
 
-$pdo = new PDO(getenv('POSTGRES_DSN'));
+$pdo = new PDO(env_var('POSTGRES_DSN'));
 $pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::ERRMODE_EXCEPTION);
 $warehouse = new Warehouse\Pdo($pdo);
 
 $google_client = new Google_Client();
 $google_client->setApplicationName('Ads Warehouse');
-$google_client->setAuthConfig($basedir . DIRECTORY_SEPARATOR . getenv('GOOGLE_CREDENTIALS'));
+$google_client->setAuthConfig(__DIR__ . '/../' . env_var('GOOGLE_CREDENTIALS'));
 $google_client->setScopes([Google_Service_Analytics::ANALYTICS_READONLY]);
 
 $analytics = new Google_Service_AnalyticsReporting($google_client);
-$api = Api::init(getenv('FB_APP_ID'), getenv('FB_APP_SECRET'), getenv('FB_ACCESS_TOKEN'));
+$api = Api::init(env_var('FB_APP_ID'), env_var('FB_APP_SECRET'), env_var('FB_ACCESS_TOKEN'));
 
-if (getenv('APP_DEBUG') === 'true') {
+if (env_bool('APP_DEBUG')) {
     $api->setLogger(new CurlLogger());
 }
 
 $accounts = $warehouse->accounts();
 
-$etl = array_map(fn(Account $account) => [
-    new AdWords($warehouse, $analytics, $account->gaViewId),
-    new FacebookAds($warehouse, $api, $account->fbAdAccountId),
-], $accounts);
+/** @var array<int, ETL> $etl */
+$etl = array_map(function (Account $account) use ($warehouse, $analytics, $warehouse, $api): array {
+    /** @var array<int, ETL> $pipeline */
+    $pipeline = [];
 
-array_walk_recursive($elt, fn(ETL $etl): void => $etl->load());
+    if ($account->gaViewId !== null) {
+        $pipeline[] = new AdWords($warehouse, $analytics, $account->gaViewId);
+    }
+
+    if ($account->fbAdAccountId !== null) {
+        $pipeline[] = new FacebookAds($warehouse, $api, $account->fbAdAccountId);
+    }
+
+    return $pipeline;
+}, $accounts);
+
+array_walk_recursive($elt, fn(ETL $etl) => $etl->load());

bin/server.php

@@ -3,22 +3,25 @@
 namespace AdsWarehouse;
 
 use AdsWarehouse\Http\Handler;
+use GraphQL\Type\Schema;
 use Monolog\Handler\ErrorLogHandler;
 use PDO;
 use Siler\Monolog as Log;
+use function Siler\Env\env_bool;
+use function Siler\Env\env_var;
 use function Siler\Swoole\http;
 
-$basedir = dirname(__DIR__, 1);
-require_once "$basedir/vendor/autoload.php";
+require_once __DIR__ . '/../vendor/autoload.php';
 
 Log\handler(new ErrorLogHandler());
 
-$pdo = new PDO(getenv('POSTGRES_DSN'));
+$pdo = new PDO(env_var('POSTGRES_DSN'));
 $pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::ERRMODE_EXCEPTION);
 
 $context = new Context();
-$context->schema = require_once "$basedir/src/schema.php";
+/** @var Schema schema */
+$context->schema = require_once __DIR__ . '/../src/schema.php';
 $context->warehouse = new Warehouse\Pdo($pdo);
-$context->debug = getenv('APP_DEBUG') === 'true';
+$context->debug = env_bool('APP_DEBUG');
 
 http(new Handler($context), 8000)->start();

composer.lock

@@ -1,6 +1,6 @@
 create table account
 (
-    id uuid not null primary key,
+    id               uuid      not null primary key,
     name             varchar   not null,
     ga_view_id       int,
     fb_ad_account_id int,
@@ -9,8 +9,8 @@ create table account
 
 create table ad
 (
-    id uuid not null primary key,
-    account_id uuid not null references account (id),
+    id          uuid      not null primary key,
+    account_id  uuid      not null references account (id),
     name        varchar   not null,
     cost        float     not null default 0,
     impressions int       not null default 0,
@@ -22,3 +22,13 @@ create table ad
     date        date      not null,
     timestamp   timestamp not null default current_timestamp
 );
+
+create table metric
+(
+    id         uuid      not null primary key,
+    account_id uuid      not null references account (id),
+    key        varchar   not null,
+    value      int       not null default 0,
+    source     varchar   not null,
+    timestamp  timestamp not null default current_timestamp
+);

db/migrations/V1__Initial_version.sql

@@ -10,5 +10,6 @@
     <rule ref="PSR12">
         <exclude name="PSR12.Files.FileHeader"/>
         <exclude name="PSR12.Files.OpenTag"/>
+        <exclude name="Generic.Files.LineLength"/>
     </rule>
 </ruleset>

phpcs.xml

@@ -17,4 +17,12 @@
     <issueHandlers>
         <PropertyNotSetInConstructor errorLevel="suppress"/>
     </issueHandlers>
+
+    <stubs>
+        <file name="vendor/swoole/ide-helper/output/swoole/namespace/Server.php"/>
+        <file name="vendor/swoole/ide-helper/output/swoole/namespace/Server/Port.php"/>
+        <file name="vendor/swoole/ide-helper/output/swoole/namespace/Http/Server.php"/>
+        <file name="vendor/swoole/ide-helper/output/swoole/namespace/Http/Request.php"/>
+        <file name="vendor/swoole/ide-helper/output/swoole/namespace/Http/Response.php"/>
+    </stubs>
 </psalm>

psalm.xml

@@ -2,6 +2,7 @@
 
 namespace AdsWarehouse\Ad;
 
+use AdsWarehouse\Account\Account;
 use DateTime;
 use Ramsey\Uuid\Uuid;
 use Ramsey\Uuid\UuidInterface;
@@ -10,6 +11,7 @@ class Ad
 {
     /** @var UuidInterface|string */
     public $id;
+    public Account $account;
     public string $name;
     public float $cost;
     public int $impressions;

src/Ad/Ad.php

@@ -5,15 +5,15 @@
 use AdsWarehouse\Ad\Ad;
 use AdsWarehouse\Warehouse\Warehouse;
 use FacebookAds\Api;
-use FacebookAds\Object\AbstractObject;
+use FacebookAds\Cursor;
 use FacebookAds\Object\AdAccount;
 use FacebookAds\Object\AdsInsights;
 use FacebookAds\Object\Values\AdsInsightsDatePresetValues;
 use Ramsey\Uuid\Uuid;
 use function AdsWarehouse\yesterday;
 
 /**
- * @template-extends ETL<array<int, AbstractObject>>
+ * @template-extends ETL<array<int, AdsInsights>>
  */
 class FacebookAds extends ETL
 {
@@ -30,7 +30,7 @@ public function __construct(Warehouse $warehouse, Api $api, int $adAccountId)
     }
 
     /**
-     * @return array<int, AbstractObject>
+     * @return array<int, AdsInsights>
      */
     protected function extract(): array
     {
@@ -49,8 +49,13 @@ protected function extract(): array
             'date_preset' => AdsInsightsDatePresetValues::YESTERDAY,
         ];
 
-        $ad_account = new AdAccount($this->adAccountId);
-        return $ad_account->getInsights($fields, $params)->getArrayCopy();
+        $ad_account = new AdAccount(strval($this->adAccountId));
+
+        /** @var Cursor $insights */
+        $insights = $ad_account->getInsights($fields, $params);
+
+        /** @var array<int, AdsInsights> */
+        return $insights->getArrayCopy();
     }
 
     /**
@@ -60,6 +65,7 @@ protected function extract(): array
     protected function transform($data): array
     {
         return array_map(function (AdsInsights $insights): Ad {
+            /** @var array<string, string> $data */
             $data = $insights->getData();
 
             $ad = new Ad();

src/ETL/FacebookAds.php

@@ -9,6 +9,7 @@
 use Swoole\Http\Request;
 use Swoole\Http\Response;
 use Throwable;
+use UnexpectedValueException;
 use function Siler\Encoder\Json\decode;
 use function Siler\GraphQL\debug;
 use function Siler\GraphQL\execute;
@@ -26,10 +27,22 @@ public function __construct(Context $context)
         debug($context->debug ? Debug::INCLUDE_DEBUG_MESSAGE : 0);
     }
 
-    public function __invoke(Request $request, Response $response)
+    /**
+     * @param Request $request
+     * @param Response $response
+     * @throws Throwable
+     */
+    public function __invoke(Request $request, Response $response): void
     {
         try {
-            $input = decode(raw());
+            $raw = raw();
+
+            if ($raw === null) {
+                throw new UnexpectedValueException('Empty content');
+            }
+
+            /** @var array<string, mixed> $input */
+            $input = decode($raw);
             $result = execute($this->context->schema, $input, $this->context->rootValue, $this->context);
         } catch (Throwable $exception) {
             Log\error('Internal error', ['exception' => $exception]);

src/Http/Handler.php

@@ -19,12 +19,13 @@ public function __construct(\PDO $pdo)
     public function store(array $ads): void
     {
         $stmt = $this->pdo->prepare(
-            'insert into ad (id, name, cost, impressions, clicks, cpm, cpc, ctr, source, date)
-            values (:id, :name, :cost, :impressions, :clicks, :cpm, :cpc, :ctr, :source, :date)'
+            'insert into ad (id, account_id, name, cost, impressions, clicks, cpm, cpc, ctr, source, date)
+            values (:id, :account_id, :name, :cost, :impressions, :clicks, :cpm, :cpc, :ctr, :source, :date)'
         );
 
         foreach ($ads as $ad) {
             $stmt->bindValue('id', $ad->id);
+            $stmt->bindValue('account_id', $ad->account->id);
             $stmt->bindValue('name', $ad->name);
             $stmt->bindValue('cost', $ad->cost);
             $stmt->bindValue('impressions', $ad->impressions, \PDO::PARAM_INT);
@@ -33,7 +34,7 @@ public function store(array $ads): void
             $stmt->bindValue('cpc', $ad->cpc);
             $stmt->bindValue('ctr', $ad->ctr);
             $stmt->bindValue('source', $ad->source);
-            $stmt->bindValue('date', $ad->date->format('Y-m-d'));
+            $stmt->bindValue('date', $ad->date instanceof DateTime ? $ad->date->format('Y-m-d') : $ad->date); // Type-safety!!!
 
             $stmt->execute();
         }
@@ -44,6 +45,7 @@ public function store(array $ads): void
      */
     public function items(): array
     {
+        /** @var array<int, Ad>|false $results */
         $results = $this->pdo->query('select * from ad order by timestamp desc')
             ->fetchAll(\PDO::FETCH_CLASS, Ad::class);
 
@@ -64,6 +66,14 @@ public function drop(string $source, DateTime $date): void
      */
     public function accounts(): array
     {
-        return $this->pdo->query('select * from account')->fetchAll(\PDO::FETCH_CLASS, Account::class);
+        /** @var array<int, Account>|false $results */
+        $results = $this->pdo->query('select * from account')
+            ->fetchAll(\PDO::FETCH_CLASS, Account::class);
+
+        if ($results === false) {
+            return [];
+        }
+
+        return $results;
     }
 }

src/Warehouse/Pdo.php

@@ -2,12 +2,12 @@
 
 namespace AdsWarehouse;
 
-use function Siler\File\concat_files;
-use function Siler\File\recur_iter_dir;
+use function Siler\File\{concat_files, recur_iter_dir};
 use function Siler\GraphQL\schema;
 
-$basedir = dirname(__DIR__, 1);
-$type_defs = concat_files(recur_iter_dir("$basedir/src", '/\.graphql$/'));
-$resolvers = require_once "$basedir/src/resolvers.php";
+$type_defs = concat_files(recur_iter_dir(__DIR__ . '/../src', '/\.graphql$/'));
+
+/** @var array<string, mixed> $resolvers */
+$resolvers = require_once __DIR__ . '/../src/resolvers.php';
 
 return schema($type_defs, $resolvers);