Modernise code

.circleci/config.yml

@@ -57,6 +57,8 @@ commands:
           path: test-results/junit.xml
       - store_artifacts:
           path: test-results/junit.xml
+      - store_artifacts:
+          path: profiler
 
 jobs:
   lint:
@@ -66,6 +68,7 @@ jobs:
       - checkout
       - run: composer install
       - run: composer lint
+      - run: composer analyse
 
   test:
     parameters:
@@ -149,10 +152,6 @@ workflows:
   build_and_test:
     jobs:
       - lint
-      - test:
-          name: test-php73
-          php_version: php73
-          mongo_version: 3.6.23
       - test:
           name: test-php74
           php_version: php74

.gitattributes

@@ -0,0 +1,11 @@
+/.circleci/ export-ignore
+/docker export-ignore
+/test export-ignore
+.editorconfig export-ignore
+.env export-ignore
+.php-cs-fixer* export-ignore
+*.log export-ignore
+docker-compose*.yml export-ignore
+logo.png export-ignore
+phpunit.xml export-ignore
+phpstan*.neon export-ignore

.gitignore

@@ -8,6 +8,7 @@ tags
 atlassian-ide-plugin.xml
 
 composer.lock
+profiler
 test-results
 .phpunit.result.cache
 .php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -10,10 +10,25 @@
     ->setRules([
         '@auto' => true,
         '@PhpCsFixer' => true,
+        'blank_line_before_statement' => ['statements' => [
+            'break',
+            'case',
+            'continue',
+            'declare',
+            'default',
+            'exit',
+            'goto',
+            'phpdoc',
+            'return',
+            'switch',
+            'throw',
+            'try',
+        ]],
         'concat_space' => ['spacing' => 'one'],
         'increment_style' => false,
         'multiline_whitespace_before_semicolons' => ['strategy' => 'no_multi_line'],
         'ordered_types' => ['null_adjustment' => 'always_last'],
+        'phpdoc_no_empty_return' => false,
         'phpdoc_types_order' => ['null_adjustment' => 'always_last'],
         'yoda_style' => false,
         'php_unit_method_casing' => false,
@@ -23,5 +38,7 @@
     ->setFinder(
         (new Finder())
             ->in(__DIR__)
+            ->ignoreVCSIgnored(true)
             ->ignoreDotFiles(false)
+            ->notPath('rector.php')
     );

composer.json

@@ -17,24 +17,21 @@
             "homepage": "http://talis.com/"
         }
     ],
-    "config": {
-        "audit": {
-            "ignore": ["PKSA-gk21-j82g-2hhy"]
-        }
-    },
     "suggest": {
         "resque/php-resque": "Redis backed library for background jobs"
     },
     "require": {
-        "php" : ">=7.3",
+        "php" : ">=7.4",
         "mongodb/mongodb": "*",
         "monolog/monolog" : "~1.13",
         "semsol/arc2": "2.2.6"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.6.20",
         "resque/php-resque": "v1.3.6",
-        "friendsofphp/php-cs-fixer": "^3.4"
+        "friendsofphp/php-cs-fixer": "^3.4",
+        "perftools/php-profiler": "^1.2",
+        "phpstan/phpstan": "^2.1"
     },
     "autoload": {
         "classmap": ["src/"]
@@ -44,6 +41,7 @@
     },
     "scripts": {
         "lint": "php-cs-fixer check",
+        "analyse": "phpstan analyse --memory-limit 1024M",
         "test": [
             "Composer\\Config::disableProcessTimeout",
             "phpunit"

docker-compose.yml

@@ -8,13 +8,6 @@ x-base-config: &base-config
   env_file: .env
 
 services:
-  php73:
-    build:
-      context: ./docker
-      dockerfile: Dockerfile-php73
-    image: talis/tripod-php:php73-latest
-    <<: *base-config
-
   php74:
     build:
       context: ./docker

docker/Dockerfile-php74

@@ -15,4 +15,4 @@ RUN curl -sLo /tmp/mongosh.deb https://downloads.mongodb.com/compass/mongodb-mon
 COPY --from=mlocati/php-extension-installer:2.3.2 /usr/bin/install-php-extensions /usr/local/bin/
 COPY --from=composer:2.7.7 /usr/bin/composer /usr/local/bin/
 
-RUN install-php-extensions pcntl mongodb-1.19.3
+RUN install-php-extensions pcntl mongodb-1.19.3 xhprof

phpstan.neon

@@ -0,0 +1,17 @@
+parameters:
+  level: 5
+  phpVersion:
+    min: 70400 # PHP 7.4
+    max: 80419 # PHP 8.4.19
+  tips:
+    treatPhpDocTypesAsCertain: false
+  ignoreErrors:
+    - '#Access to undefined constant MongoDB\\Driver\\ReadPreference\:\:RP_.*#'
+    - '#Call to an undefined method MongoDB\\Driver\\ReadPreference\:\:getMode\(\)#'
+    - identifier: missingType.iterableValue
+      reportUnmatched: false
+    - identifier: unset.possiblyHookedProperty
+      reportUnmatched: false
+  paths:
+    - src
+    - test

phpunit.xml

@@ -5,11 +5,11 @@
     </php>
 
     <testsuites>
-        <testsuite name="Tripod_Performance_Tests">
-            <directory>test/performance</directory>
-        </testsuite>
         <testsuite name="Tripod_Unit_Tests">
             <directory>test/unit</directory>
         </testsuite>
+        <testsuite name="Tripod_Performance_Tests">
+            <directory>test/performance</directory>
+        </testsuite>
     </testsuites>
 </phpunit>

scripts/mongo/BSONToQuads.php

@@ -5,10 +5,9 @@
 use Tripod\Mongo\TriplesUtil;
 
 require_once __DIR__ . '/common.inc.php';
-
 require_once dirname(__FILE__, 3) . '/src/tripod.inc.php';
 
-if ($argc != 2) {
+if ($argc !== 2) {
     echo "usage: ./BSONToQuads.php tripodConfig.json < bsondata\n";
     echo "  When exporting bson data from Mongo use:  \n";
     echo "     mongoexport -d <dbname> -c <collectionName> > bsondata.txt \n";

scripts/mongo/BSONToTriples.php

@@ -5,16 +5,16 @@
 use Tripod\Mongo\TriplesUtil;
 
 require_once __DIR__ . '/common.inc.php';
-
 require_once dirname(__FILE__, 3) . '/src/tripod.inc.php';
 
-if ($argc != 2) {
+if ($argc !== 2) {
     echo "usage: ./BSONToTriples.php tripodConfig.json < bsondata\n";
     echo "  When exporting bson data from Mongo use:  \n";
     echo "     mongoexport -d <dbname> -c <collectionName> > bsondata.txt \n";
 
     exit;
 }
+
 array_shift($argv);
 $config = json_decode(file_get_contents($argv[0]), true);
 Config::setConfig($config);

scripts/mongo/common.inc.php

@@ -13,11 +13,9 @@
 }
 
 if (!defined('TRIPOD_COMPOSER_INSTALL')) {
-    exit(
-        'You need to set up the project dependencies using the following commands:' . PHP_EOL
+    exit('You need to set up the project dependencies using the following commands:' . PHP_EOL
         . 'curl -sS https://getcomposer.org/installer | php' . PHP_EOL
-        . 'php composer.phar install' . PHP_EOL
-    );
+        . 'php composer.phar install' . PHP_EOL);
 }
 
 require TRIPOD_COMPOSER_INSTALL;

scripts/mongo/createSearchDocuments.php

@@ -1,7 +1,7 @@
 <?php
 
 use Tripod\Config;
-use Tripod\iTripodStat;
+use Tripod\ITripodStat;
 use Tripod\Mongo\Driver;
 use Tripod\Timer;
 
@@ -20,20 +20,23 @@
     ]
 );
 
-function showUsage($scriptName)
+function showUsage(): void
 {
+    $scriptName = basename(__FILE__);
     $help = <<<END
+        {$scriptName}
+
         Usage:
 
         php {$scriptName} -c/--config path/to/tripod-config.json -s/--storename store-name [options]
 
         Options:
             -h --help               This help
             -c --config             path to MongoTripodConfig configuration (required)
-            -s --storename          Store to create views for (required)
+            -s --storename          Store to create search documents for (required)
             -d --spec               Only create for specified search document specs
             -i --id                 Resource ID to regenerate search documents for
-            -a --async              Generate table rows via queue
+            -a --async              Generate search documents via queue
             -q --queue              Queue name to place jobs on (defaults to configured TRIPOD_APPLY_QUEUE value)
 
             --stat-loader           Path to script to initialize a Stat object.  Note, it *must* return an iTripodStat object!
@@ -42,32 +45,27 @@ function showUsage($scriptName)
     echo $help;
 }
 
-if (empty($options) || isset($options['h']) || isset($options['help'])
+if (
+    $options === [] || $options === false || isset($options['h']) || isset($options['help'])
     || (!isset($options['c']) && !isset($options['config']))
     || (!isset($options['s']) && !isset($options['storename']))
 ) {
     showUsage();
 
     exit;
 }
+
 $configLocation = $options['c'] ?? $options['config'];
 
 require_once dirname(__FILE__, 3) . '/src/tripod.inc.php';
 
-/**
- * @param string|null      $id
- * @param string|null      $specId
- * @param string|null      $storeName
- * @param iTripodStat|null $stat
- * @param string|null      $queue
- */
-function generateSearchDocuments($id, $specId, $storeName, $stat = null, $queue = null)
+function generateSearchDocuments(?string $id, string $specId, string $storeName, ?ITripodStat $stat = null, ?string $queue = null): void
 {
     $spec = Config::getInstance()->getSearchDocumentSpecification($storeName, $specId);
     if (array_key_exists('from', $spec)) {
         Config::getInstance()->setMongoCursorTimeout(-1);
 
-        echo "Generating {$specId}";
+        echo 'Generating ' . $specId;
         $tripod = new Driver($spec['from'], $storeName, ['stat' => $stat]);
         $search = $tripod->getSearchIndexer();
         if ($id) {
@@ -85,31 +83,13 @@ function generateSearchDocuments($id, $specId, $storeName, $stat = null, $queue
 
 Config::setConfig(json_decode(file_get_contents($configLocation), true));
 
-if (isset($options['s']) || isset($options['storename'])) {
-    $storeName = $options['s'] ?? $options['storename'];
-} else {
-    $storeName = null;
-}
-
-if (isset($options['d']) || isset($options['spec'])) {
-    $specId = isset($options['d']) ? $options['t'] : $options['spec'];
-} else {
-    $specId = null;
-}
-
-if (isset($options['i']) || isset($options['id'])) {
-    $id = $options['i'] ?? $options['id'];
-} else {
-    $id = null;
-}
+$storeName = $options['s'] ?? $options['storename'] ?? null;
+$specId = $options['d'] ?? $options['spec'] ?? null;
+$id = $options['i'] ?? $options['id'] ?? null;
 
 $queue = null;
 if (isset($options['a']) || isset($options['async'])) {
-    if (isset($options['q']) || isset($options['queue'])) {
-        $queue = $options['queue'];
-    } else {
-        $queue = Config::getInstance()->getApplyQueueName();
-    }
+    $queue = $options['q'] ?? $options['queue'] ?? Config::getInstance()->getApplyQueueName();
 }
 
 $stat = null;