Refactor core helpers into traits and streamline Snyk workflow

Author: c15k0

.github/workflows/snyk-security.yml

@@ -30,50 +30,33 @@ permissions:
 jobs:
   snyk:
     permissions:
-      contents: read # for actions/checkout to fetch code
-      security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
-      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+      contents: read
+      security-events: write
+      actions: read
     runs-on: ubuntu-latest
+    env:
+      SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
     steps:
       - uses: actions/checkout@v4
       - name: Set up Snyk CLI to check for security issues
-        # Snyk can be used to break the build when it detects security issues.
-        # In this case we want to upload the SAST issues to GitHub Code Scanning
         uses: snyk/actions/setup@806182742461562b67788a64410098c9d9b96adb
 
-        # For Snyk Open Source you must first set up the development environment for your application's dependencies
-        # For example for Node
-        #- uses: actions/setup-node@v4
-        #  with:
-        #    node-version: 20
-
-        env:
-          # This is where you will need to introduce the Snyk API token created with your Snyk account
-          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
-
-        # Runs Snyk Code (SAST) analysis and uploads result into GitHub.
-        # Use || true to not fail the pipeline
       - name: Snyk Code test
-        run: snyk code test --sarif > snyk-code.sarif # || true
+        run: snyk code test --sarif > snyk-code.sarif
 
-        # Runs Snyk Open Source (SCA) analysis and uploads result to Snyk.
       - name: Snyk Open Source monitor
         run: snyk monitor --all-projects
 
-        # Runs Snyk Infrastructure as Code (IaC) analysis and uploads result to Snyk.
-        # Use || true to not fail the pipeline.
       - name: Snyk IaC test and report
-        run: snyk iac test --report # || true
+        run: snyk iac test --report
 
-        # Build the docker image for testing
       - name: Build a Docker image
         run: docker build -t your/image-to-test .
-        # Runs Snyk Container (Container and SCA) analysis and uploads result to Snyk.
+
       - name: Snyk Container monitor
         run: snyk container monitor your/image-to-test --file=Dockerfile
 
-        # Push the Snyk Code results into GitHub Code Scanning tab
       - name: Upload result to GitHub Code Scanning
         uses: github/codeql-action/upload-sarif@v3
         with:
-          sarif_file: snyk-code.sarif
+          sarif_file: snyk-code.sarif

src/base/config/Config.php

@@ -7,6 +7,7 @@
 use PSFS\base\Request;
 use PSFS\base\Security;
 use PSFS\base\types\helpers\Inspector;
+use PSFS\base\types\traits\Config\ConfigPersistenceTrait;
 use PSFS\base\types\traits\SingletonTrait;
 use PSFS\base\types\traits\TestTrait;
 
@@ -17,6 +18,7 @@ class Config
 {
     use SingletonTrait;
     use TestTrait;
+    use ConfigPersistenceTrait;
 
     const DEFAULT_LANGUAGE = 'en';
     const DEFAULT_ENCODE = 'UTF-8';
@@ -150,42 +152,6 @@ public function isLoaded()
         return !empty($this->config);
     }
 
-    /**
-     * @param array $data
-     * @param array $extra
-     * @return array
-     */
-    protected static function saveConfigParams(array $data, $extra = null)
-    {
-        Logger::log('Saving required config parameters');
-        // Store newly provided configuration parameters.
-        if (!empty($extra) && array_key_exists('label', $extra) && is_array($extra['label'])) {
-            foreach ($extra['label'] as $index => $field) {
-                if (array_key_exists($index, $extra['value']) && !empty($extra['value'][$index])) {
-                    $data[$field] = $extra['value'][$index];
-                }
-            }
-        }
-        return $data;
-    }
-
-    /**
-     * @param array $data
-     * @return array
-     */
-    protected static function saveExtraParams(array $data)
-    {
-        $finalData = array();
-        if (!empty($data)) {
-            Logger::log('Saving extra configuration parameters');
-            foreach (self::iterateConfigEntries($data) as [$key, $value]) {
-                if (null !== $value) {
-                    $finalData[$key] = $value;
-                }
-            }
-        }
-        return $finalData;
-    }
 
     /**
      * @return boolean
@@ -324,20 +290,6 @@ public static function clearConfigFiles(): bool
         return $done;
     }
 
-    private static function shouldPersistConfigEntry(mixed $value, string $key): bool
-    {
-        if (in_array($key, self::$required, true)) {
-            return true;
-        }
-
-        // Keep explicit false/0 flags (security toggles rely on them).
-        if (is_bool($value) || is_int($value) || is_float($value)) {
-            return true;
-        }
-
-        return $value !== null && $value !== '';
-    }
-
     protected function createRepository(): ConfigRepositoryInterface
     {
         $configPath = CONFIG_DIR . DIRECTORY_SEPARATOR . self::CONFIG_FILE;
@@ -352,14 +304,4 @@ protected function createRepository(): ConfigRepositoryInterface
         return $fileRepository;
     }
 
-    /**
-     * @param array $data
-     * @return \Generator
-     */
-    private static function iterateConfigEntries(array $data): \Generator
-    {
-        foreach ($data as $key => $value) {
-            yield [$key, $value];
-        }
-    }
 }

src/base/types/Api.php

@@ -14,6 +14,7 @@
 use PSFS\base\types\helpers\attributes\HttpMethod;
 use PSFS\base\types\helpers\attributes\Label;
 use PSFS\base\types\helpers\attributes\Route as RouteAttribute;
+use PSFS\base\types\traits\Api\ApiCrudResponseTrait;
 use PSFS\base\types\traits\Api\Crud\ApiListTrait;
 use PSFS\base\types\traits\Api\ManagerTrait;
 
@@ -22,7 +23,7 @@
  */
 abstract class Api extends Singleton
 {
-    use ManagerTrait, ApiListTrait;
+    use ManagerTrait, ApiListTrait, ApiCrudResponseTrait;
 
     const API_LIST_NAME_FIELD = '__name__';
     const API_FIELDS_RESULT_FIELD = '__fields';
@@ -69,27 +70,15 @@ public function init()
 
     private function checkActions($method)
     {
-        switch ($method) {
-            default:
-            case 'modelList':
-                $this->action = self::API_ACTION_LIST;
-                break;
-            case 'get':
-                $this->action = self::API_ACTION_GET;
-                break;
-            case 'post':
-                $this->action = self::API_ACTION_POST;
-                break;
-            case 'put':
-                $this->action = self::API_ACTION_PUT;
-                break;
-            case 'delete':
-                $this->action = self::API_ACTION_DELETE;
-                break;
-            case 'bulk':
-                $this->action = self::API_ACTION_BULK;
-                break;
-        }
+        $actionMap = [
+            'modelList' => self::API_ACTION_LIST,
+            'get' => self::API_ACTION_GET,
+            'post' => self::API_ACTION_POST,
+            'put' => self::API_ACTION_PUT,
+            'delete' => self::API_ACTION_DELETE,
+            'bulk' => self::API_ACTION_BULK,
+        ];
+        $this->action = $actionMap[(string)$method] ?? self::API_ACTION_LIST;
     }
 
     /**
@@ -175,16 +164,12 @@ public function post()
                 $message = t('Selected model could not be saved');
             }
         } catch (\Exception $e) {
-            if (Config::getParam('debug')) {
-                $message = t('An error occurred while saving the item: ') . '<br>' . $e->getMessage();
-            } else {
-                $message = t('An error occurred while saving the item: ') . '<br>' . $e->getCode();
-            }
-            $context = [];
-            if (null !== $e->getPrevious()) {
-                $context[] = $e->getPrevious()->getMessage();
-            }
-            Logger::log($e->getMessage(), LOG_CRIT, $context);
+            $message = $this->buildMutationErrorMessage(
+                'An error occurred while saving the item: ',
+                $e,
+                (bool)Config::getParam('debug')
+            );
+            $this->logCriticalException($e);
         }
 
         return $this->json(new JsonResponse($model, $saved, $saved ? 1 : 0, 0, $message), $status);
@@ -224,18 +209,12 @@ public function put($pk)
                     $message = t('An error occurred while updating the item, please check logs');
                 }
             } catch (\Exception $e) {
-                if (Config::getParam('debug')) {
-                    $message = t('An error occurred while updating the item: ') . '<br>' . $e->getMessage();
-                } else {
-                    $message = t(
-                            'An error occurred while updating the item, please check logs: '
-                        ) . '<br>' . $e->getCode();
-                }
-                $context = [];
-                if (null !== $e->getPrevious()) {
-                    $context[] = $e->getPrevious()->getMessage();
-                }
-                Logger::log($e->getMessage(), LOG_CRIT, $context);
+                $message = $this->buildMutationErrorMessage(
+                    'An error occurred while updating the item, please check logs: ',
+                    $e,
+                    (bool)Config::getParam('debug')
+                );
+                $this->logCriticalException($e);
             }
         } else {
             $message = t('Referenced model for update was not found');
@@ -275,11 +254,7 @@ public function delete($pk = null)
                     $deleted = true;
                 }
             } catch (\Exception $e) {
-                $context = [];
-                if (null !== $e->getPrevious()) {
-                    $context[] = $e->getPrevious()->getMessage();
-                }
-                Logger::log($e->getMessage(), LOG_CRIT, $context);
+                $this->logCriticalException($e);
             }
         }
 

src/base/types/helpers/MetadataDocParser.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace PSFS\base\types\helpers;
+
+class MetadataDocParser
+{
+    public static function readTagValue(string $tag, string $doc, mixed $default = null): mixed
+    {
+        preg_match('/@' . preg_quote($tag, '/') . '\ (.*)(\n|\r)/im', $doc, $matches);
+        return !empty($matches) ? $matches[1] : $default;
+    }
+
+    public static function readHttpMethod(string $doc, mixed $default = null): string
+    {
+        preg_match('/@(GET|POST|PUT|DELETE|HEAD|PATCH)(\n|\r)/i', $doc, $routeMethod);
+        return !empty($routeMethod) ? strtoupper($routeMethod[1]) : ($default ?? 'ALL');
+    }
+
+    public static function readVisibilityFlag(string $doc): bool
+    {
+        $value = (string)self::readTagValue('visible', $doc, '');
+        return !str_contains($value, 'false');
+    }
+
+    public static function readVarType(string $doc): ?string
+    {
+        $type = null;
+        if (preg_match(InjectorHelper::VAR_PATTERN, $doc, $matches) === 1) {
+            list(, $type) = $matches;
+        }
+        return is_string($type) ? $type : null;
+    }
+}
+

src/base/types/helpers/MetadataReader.php

@@ -158,26 +158,16 @@ private static function readFromDoc(string $tag, ?string $doc, mixed $default =
             return $default;
         }
         return match ($tag) {
-            'http' => self::readHttpMethodFromDoc($doc, $default),
-            'visible' => self::readVisibleFromDoc($doc),
-            'cache' => (bool)self::readFromDocValue('cache', $doc, $default ?? false),
-            default => self::readFromDocValue($tag, $doc, $default),
+            'http' => MetadataDocParser::readHttpMethod($doc, $default),
+            'visible' => MetadataDocParser::readVisibilityFlag($doc),
+            'cache' => (bool)MetadataDocParser::readTagValue('cache', $doc, $default ?? false),
+            default => MetadataDocParser::readTagValue($tag, $doc, $default),
         };
     }
 
-    private static function readFromDocValue(string $needle, string $doc, mixed $default): mixed
-    {
-        preg_match('/@' . preg_quote($needle, '/') . '\ (.*)(\n|\r)/im', $doc, $matches);
-        return !empty($matches) ? $matches[1] : $default;
-    }
-
     private static function readVarTypeFromDoc(string $doc): ?string
     {
-        $type = null;
-        if (preg_match(InjectorHelper::VAR_PATTERN, $doc, $matches) === 1) {
-            list(, $type) = $matches;
-        }
-        return $type;
+        return MetadataDocParser::readVarType($doc);
     }
 
     private static function extractPropertyType(?ReflectionType $type): ?string
@@ -201,16 +191,4 @@ private static function logLegacyFallback(string $context): void
         Logger::log('[LegacyMetadata] ' . $context, LOG_NOTICE);
     }
 
-    private static function readHttpMethodFromDoc(string $doc, mixed $default = null): string
-    {
-        preg_match('/@(GET|POST|PUT|DELETE|HEAD|PATCH)(\n|\r)/i', $doc, $routeMethod);
-        return !empty($routeMethod) ? strtoupper($routeMethod[1]) : ($default ?? 'ALL');
-    }
-
-    private static function readVisibleFromDoc(string $doc): bool
-    {
-        preg_match('/@visible\ (.*)(\n|\r)/im', $doc, $matches);
-        $value = !empty($matches) ? $matches[1] : '';
-        return !str_contains((string)$value, 'false');
-    }
 }

src/base/types/traits/Api/ApiCrudResponseTrait.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace PSFS\base\types\traits\Api;
+
+use Exception;
+use PSFS\base\Logger;
+
+trait ApiCrudResponseTrait
+{
+    protected function buildMutationErrorMessage(string $publicPrefix, Exception $e, bool $debug): string
+    {
+        if ($debug) {
+            return t($publicPrefix) . '<br>' . $e->getMessage();
+        }
+        return t($publicPrefix) . '<br>' . $e->getCode();
+    }
+
+    protected function logCriticalException(Exception $e): void
+    {
+        $context = $this->extractExceptionContext($e);
+        Logger::log($e->getMessage(), LOG_CRIT, $context);
+    }
+
+    /**
+     * @return array<int, string>
+     */
+    protected function extractExceptionContext(Exception $e): array
+    {
+        $context = [];
+        if (null !== $e->getPrevious()) {
+            $context[] = $e->getPrevious()->getMessage();
+        }
+        return $context;
+    }
+}
+