From 099c2ae6484524557f7b311d5f9f97d5eec6f142 Mon Sep 17 00:00:00 2001
From: epriestley <git@epriestley.com>
Date: Fri, 3 Apr 2020 11:29:38 -0700
Subject: [PATCH] Introduce "FuturePool" to make it easier to manage an ongoing
 pool of futures

Summary:
Ref T11968. "FutureIterator" recently became non-rewindable, and starting a Future twice is now an error.

This complicates a handful of use cases where a mostly-constant pool of futures is maintained over a long period of time, notably in daemon overseers and repository pull daemons.

They previously relied on being able to do "new FutureIterator($futures)" to continue resolution of a list of futures from any state. This no longer works quite like it used to, since Futures generally may not belong to more than one iterator now (and this property is desirable).

Introduce "FuturePool", which maintains exactly one iterator but manages the small amount of glue around adding and removing Futures from it, destroying it if the pool empties, and rebuilding it if the pool fills.

Test Plan: See next change, which makes use of this.

Maniphest Tasks: T11968

Differential Revision: https://secure.phabricator.com/D21053
---
 src/__phutil_library_map__.php |  2 +
 src/future/FuturePool.php      | 67 ++++++++++++++++++++++++++++++++++
 2 files changed, 69 insertions(+)
 create mode 100644 src/future/FuturePool.php

diff --git a/src/__phutil_library_map__.php b/src/__phutil_library_map__.php
index b3a3e5e7..6870a8f3 100644
--- a/src/__phutil_library_map__.php
+++ b/src/__phutil_library_map__.php
@@ -513,6 +513,7 @@ phutil_register_library_map(array(
     'Future' => 'future/Future.php',
     'FutureIterator' => 'future/FutureIterator.php',
     'FutureIteratorTestCase' => 'future/__tests__/FutureIteratorTestCase.php',
+    'FuturePool' => 'future/FuturePool.php',
     'FutureProxy' => 'future/FutureProxy.php',
     'HTTPFuture' => 'future/http/HTTPFuture.php',
     'HTTPFutureCURLResponseStatus' => 'future/http/status/HTTPFutureCURLResponseStatus.php',
@@ -1455,6 +1456,7 @@ phutil_register_library_map(array(
       'Iterator',
     ),
     'FutureIteratorTestCase' => 'PhutilTestCase',
+    'FuturePool' => 'Phobject',
     'FutureProxy' => 'Future',
     'HTTPFuture' => 'BaseHTTPFuture',
     'HTTPFutureCURLResponseStatus' => 'HTTPFutureResponseStatus',
diff --git a/src/future/FuturePool.php b/src/future/FuturePool.php
new file mode 100644
index 00000000..3bcf9502
--- /dev/null
+++ b/src/future/FuturePool.php
@@ -0,0 +1,67 @@
+<?php
+
+final class FuturePool
+  extends Phobject {
+
+  private $shouldRewind;
+  private $iteratorTemplate;
+  private $iterator;
+  private $futures = array();
+
+  public function __construct() {
+    $this->iteratorTemplate = new FutureIterator(array());
+  }
+
+  public function getIteratorTemplate() {
+    return $this->iteratorTemplate;
+  }
+
+  public function addFuture(Future $future) {
+    $future_key = $future->getFutureKey();
+
+    if (!isset($this->futures[$future_key])) {
+      if (!$this->iterator) {
+        $this->iterator = clone $this->getIteratorTemplate();
+        $this->shouldRewind = true;
+      }
+
+      $iterator = $this->iterator;
+      $iterator->addFuture($future);
+
+      $this->futures[$future_key] = $future;
+    }
+
+    return $this;
+  }
+
+  public function hasFutures() {
+    return (bool)$this->futures;
+  }
+
+  public function resolve() {
+    $iterator = $this->iterator;
+
+    if (!$iterator) {
+      return null;
+    }
+
+    if ($this->shouldRewind) {
+      $iterator->rewind();
+      $this->shouldRewind = false;
+    } else {
+      $iterator->next();
+    }
+
+    if ($iterator->valid()) {
+      $future_key = $iterator->key();
+      if ($future_key !== null) {
+        unset($this->futures[$future_key]);
+      }
+      return $iterator->current();
+    } else {
+      $this->iterator = null;
+      return null;
+    }
+  }
+
+}