feat: Add Global Context feature (#9970)

* Added Context class

* Added some convenient methods

* Enhance logger to properly include global context

* Add unit tests for Context class functionality

* Added tests for global context logging behaviour

* cs-fix

* Add docs

* add context() helper function

* cs-fix and fixing static analysis problems

* Some doc fixing

* Fix rst errors.

* Apply suggested changes

* Set $logGlobalContext to false by default

* Add docs for helper method

* cs-fix

* Fix the doc issue

* Applying code suggestions

Co-authored-by: John Paul E. Balandan, CPA <paulbalandan@gmail.com>
Co-authored-by: michalsn <michal@sniatala.pl>

* changed type from mixed|null to mixed

* Added __serialize and __unserialize methods.

* Returning $default if $key is not present. And only calling ArrayHelper if needed.

* Remove contructor

Co-authored-by: Michal Sniatala <michal@sniatala.pl>

---------

Co-authored-by: John Paul E. Balandan, CPA <paulbalandan@gmail.com>
Co-authored-by: michalsn <michal@sniatala.pl>

Author: 3 people

app/Config/Logger.php

@@ -51,6 +51,22 @@ class Logger extends BaseConfig
      */
     public string $dateFormat = 'Y-m-d H:i:s';
 
+    /**
+     * --------------------------------------------------------------------------
+     * Whether to log the global context
+     * --------------------------------------------------------------------------
+     *
+     * You can enable/disable logging of global context data, which comes from the
+     * `CodeIgniter\Context\Context` class. This data is automatically included in
+     * logs, and can be set using the `set()` method of the Context class. This is
+     * useful for including additional information in your logs, such as user IDs,
+     * request IDs, etc.
+     *
+     * **NOTE:** This **DOES NOT** include any data that has been marked as hidden
+     * using the `setHidden()` method of the Context class.
+     */
+    public bool $logGlobalContext = false;
+
     /**
      * --------------------------------------------------------------------------
      * Log Handlers

system/Common.php

@@ -14,6 +14,7 @@
 use CodeIgniter\Cache\CacheInterface;
 use CodeIgniter\Config\BaseConfig;
 use CodeIgniter\Config\Factories;
+use CodeIgniter\Context\Context;
 use CodeIgniter\Cookie\Cookie;
 use CodeIgniter\Cookie\CookieStore;
 use CodeIgniter\Cookie\Exceptions\CookieException;
@@ -212,6 +213,17 @@ function config(string $name, bool $getShared = true)
     }
 }
 
+if (! function_exists('context')) {
+    /**
+     * Provides access to the Context object, which is used to store
+     * contextual data during a request that can be accessed globally.
+     */
+    function context(): Context
+    {
+        return service('context');
+    }
+}
+
 if (! function_exists('cookie')) {
     /**
      * Simpler way to create a new Cookie instance.

system/Config/Services.php

@@ -18,6 +18,7 @@
 use CodeIgniter\Cache\ResponseCache;
 use CodeIgniter\CLI\Commands;
 use CodeIgniter\CodeIgniter;
+use CodeIgniter\Context\Context;
 use CodeIgniter\Database\ConnectionInterface;
 use CodeIgniter\Database\MigrationRunner;
 use CodeIgniter\Debug\Exceptions;
@@ -868,4 +869,16 @@ public static function typography(bool $getShared = true)
 
         return new Typography();
     }
+
+    /**
+     * The Context class provides a way to store and retrieve static data throughout requests.
+     */
+    public static function context(bool $getShared = true): Context
+    {
+        if ($getShared) {
+            return static::getSharedInstance('context');
+        }
+
+        return new Context();
+    }
 }