PHPLIB-528, PHPLIB-788: Use Session::isDirty() and update session spec tests (#889)

* PHPLIB-528: Use Session::isDirty() for spec test assertions

* PHPLIB-788: Update session spec tests

Synced with mongodb/specifications@e11c1e4

Author: jmikola

.evergreen/config.yml

@@ -608,14 +608,20 @@ axes:
   - id: driver-versions
     display_name: Driver Version
     values:
+      # TODO: Update to "1.13.0" once PHPC 1.13.0 is released
       - id: "oldest-supported"
-        display_name: "1.12.0"
+        # display_name: "1.13.0"
+        display_name: "1.13-dev (master)"
         variables:
-          EXTENSION_VERSION: "1.12.0"
+          # EXTENSION_VERSION: "1.13.0"
+          EXTENSION_BRANCH: "master"
+      # TODO: Update to "1.13.x"/"stable" once PHPC 1.13.0 is released
       - id: "latest-stable"
-        display_name: "1.12.x"
+        # display_name: "1.13.x"
+        display_name: "1.13-dev (master)"
         variables:
-          EXTENSION_VERSION: "stable"
+          # EXTENSION_VERSION: "stable"
+          EXTENSION_BRANCH: "master"
       - id: "latest-dev"
         display_name: "1.13-dev (master)"
         variables:

.github/workflows/coding-standards.yml

@@ -20,7 +20,7 @@ jobs:
         php-version:
           - "7.4"
         driver-version:
-          - "stable"
+          - "mongodb/mongo-php-driver@master"
 
     steps:
       - name: "Checkout"

.github/workflows/tests.yml

@@ -27,24 +27,24 @@ jobs:
         mongodb-version:
           - "4.4"
         driver-version:
-          - "stable"
+          - "mongodb/mongo-php-driver@master"
         topology:
           - "server"
         include:
           - os: "ubuntu-20.04"
             php-version: "8.0"
             mongodb-version: "5.0"
-            driver-version: "stable"
+            driver-version: "mongodb/mongo-php-driver@master"
             topology: "server"
           - os: "ubuntu-20.04"
             php-version: "8.0"
             mongodb-version: "4.4"
-            driver-version: "stable"
+            driver-version: "mongodb/mongo-php-driver@master"
             topology: "replica_set"
           - os: "ubuntu-20.04"
             php-version: "8.0"
             mongodb-version: "4.4"
-            driver-version: "stable"
+            driver-version: "mongodb/mongo-php-driver@master"
             topology: "sharded_cluster"
 
     steps:

composer.json

@@ -12,7 +12,7 @@
         "php": "^7.2 || ^8.0",
         "ext-hash": "*",
         "ext-json": "*",
-        "ext-mongodb": "^1.12.0",
+        "ext-mongodb": "^1.13.0",
         "jean85/pretty-package-versions": "^1.2 || ^2.0.1",
         "symfony/polyfill-php80": "^1.19"
     },

tests/UnifiedSpecTests/Context.php

@@ -17,7 +17,6 @@
 use function current;
 use function explode;
 use function implode;
-use function in_array;
 use function key;
 use function parse_url;
 use function PHPUnit\Framework\assertArrayHasKey;
@@ -50,9 +49,6 @@ final class Context
     /** @var string */
     private $activeClient;
 
-    /** @var string[] */
-    private $dirtySessions = [];
-
     /** @var EntityMap */
     private $entityMap;
 
@@ -134,20 +130,6 @@ public function getInternalClient(): Client
         return $this->internalClient;
     }
 
-    public function isDirtySession(string $sessionId): bool
-    {
-        return in_array($sessionId, $this->dirtySessions);
-    }
-
-    public function markDirtySession(string $sessionId): void
-    {
-        if ($this->isDirtySession($sessionId)) {
-            return;
-        }
-
-        $this->dirtySessions[] = $sessionId;
-    }
-
     public function isActiveClient(string $clientId): bool
     {
         return $this->activeClient === $clientId;

tests/UnifiedSpecTests/DirtySessionObserver.php

@@ -137,11 +137,6 @@ public function assert(bool $rethrowExceptions = false): void
         $result = null;
         $saveResultAsEntity = null;
 
-        if (isset($this->arguments['session'])) {
-            $dirtySessionObserver = new DirtySessionObserver($this->entityMap->getLogicalSessionId($this->arguments['session']));
-            $dirtySessionObserver->start();
-        }
-
         try {
             $result = $this->execute();
             $saveResultAsEntity = $this->saveResultAsEntity;
@@ -160,14 +155,6 @@ public function assert(bool $rethrowExceptions = false): void
             $error = $e;
         }
 
-        if (isset($dirtySessionObserver)) {
-            $dirtySessionObserver->stop();
-
-            if ($dirtySessionObserver->observedNetworkError()) {
-                $this->context->markDirtySession($this->arguments['session']);
-            }
-        }
-
         if (! $this->ignoreResultAndError) {
             $this->expectError->assert($error);
             $this->expectResult->assert($result, $saveResultAsEntity);
@@ -744,16 +731,12 @@ private function executeForTestRunner()
                 Assert::fail('Tests using assertNumberConnectionsCheckedOut should be skipped');
                 break;
             case 'assertSessionDirty':
-                /* Context::isDirtySession() requires the session ID. Avoid
-                 * checking $args['session'], which is already resolved. */
-                assertArrayHasKey('session', $this->arguments);
-                assertTrue($this->context->isDirtySession($this->arguments['session']));
+                assertArrayHasKey('session', $args);
+                assertTrue($args['session']->isDirty());
                 break;
             case 'assertSessionNotDirty':
-                /* Context::isDirtySession() requires the session ID. Avoid
-                 * checking $args['session'], which is already resolved. */
-                assertArrayHasKey('session', $this->arguments);
-                assertFalse($this->context->isDirtySession($this->arguments['session']));
+                assertArrayHasKey('session', $args);
+                assertFalse($args['session']->isDirty());
                 break;
             case 'assertSessionPinned':
                 assertArrayHasKey('session', $args);