Add CloseableHandle::closeWhenDisposed() (#159)

Summary:
If not used and `close()` is not called, handles will be closed at some
undefined later time, e.g. end of request or when garabage collected.

No current implementation is refcount-based.

Pull Request resolved: #159

Reviewed By: DavidSnider

Differential Revision: D22418834

Pulled By: fredemmott

fbshipit-source-id: 0bcee26d7d3357cafefd796944cf0172448361b6

Author: fredemmott

composer.json

@@ -17,6 +17,6 @@
     "hhvm/hsl": "^4.15"
   },
   "provide": {
-    "hhvm/hsl-io": "0.2.0"
+    "hhvm/hsl-io": "0.2.1"
   }
 }

src/io/CloseableHandle.php

@@ -19,4 +19,11 @@
 interface CloseableHandle extends Handle {
   /** Close the handle */
   public function close(): void;
+
+  /** Close the handle when the returned disposable is disposed.
+   *
+   * Usage: `using $handle->closeWhenDisposed();`
+   */
+  <<__ReturnDisposable>>
+  public function closeWhenDisposed(): \IDisposable;
 }

src/io/MemoryHandle.php

@@ -11,7 +11,7 @@
 namespace HH\Lib\IO;
 
 use namespace HH\Lib\{Math, OS, Str};
-use namespace HH\Lib\_Private\_OS;
+use namespace HH\Lib\_Private\{_IO, _OS};
 
 enum MemoryHandleWriteMode: int {
   OVERWRITE = 0;
@@ -42,6 +42,11 @@ public function close(): void {
     $this->offset = -1;
   }
 
+  <<__ReturnDisposable>>
+  public function closeWhenDisposed(): \IDisposable {
+    return new _IO\CloseWhenDisposed($this);
+  }
+
   public async function readAsync(
     ?int $max_bytes = null,
     ?int $_timeout_nanos = null,

src/io/_Private/CloseWhenDisposed.php

@@ -0,0 +1,24 @@
+<?hh
+/*
+ *  Copyright (c) 2004-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
+namespace HH\Lib\_Private\_IO;
+
+use namespace HH\Lib\IO;
+
+final class CloseWhenDisposed implements \IDisposable {
+  public function __construct(
+    private IO\CloseableHandle $handle,
+  ) {
+  }
+
+  public function __dispose(): void {
+    $this->handle->close();
+  }
+}

src/io/_Private/FileDescriptorHandle.php

@@ -11,7 +11,7 @@
 namespace HH\Lib\_Private\_IO;
 
 use namespace HH\Lib\{IO, OS, Str};
-use namespace HH\Lib\_Private\_OS;
+use namespace HH\Lib\_Private\{_IO, _OS};
 
 abstract class FileDescriptorHandle implements IO\CloseableHandle, IO\FDHandle {
   protected bool $isAwaitable = true;
@@ -52,4 +52,9 @@ final public function getFileDescriptor(): OS\FileDescriptor {
   final public function close(): void {
     OS\close($this->impl);
   }
+
+  <<__ReturnDisposable>>
+  final public function closeWhenDisposed(): \IDisposable {
+    return new _IO\CloseWhenDisposed($this);
+  }
 }

tests/io/MemoryHandleTest.php

@@ -30,6 +30,15 @@ final class MemoryHandleTest extends HackTest {
     expect(await $h->readAllAsync())->toEqual('derp');
   }
 
+  public function testCloseWhenDisposed(): void {
+    $h = new IO\MemoryHandle('foobar');
+    using ($h->closeWhenDisposed()) {
+      expect($h->read(3))->toEqual('foo');
+    }
+    $ex = expect(() ==> $h->read(3))->toThrow(OS\ErrnoException::class);
+    expect($ex->getErrno())->toEqual(OS\Errno::EBADF);
+  }
+
   public async function testReadAtInvalidOffset(): Awaitable<void> {
     $h = new IO\MemoryHandle('herpderp');
     $h->seek(99999);

tests/io/PipeTest.php

@@ -81,6 +81,20 @@ final class PipeTest extends HackTest {
     }
   }
 
+  public async function testCloseWhenDisposed(): Awaitable<void> {
+    list($r, $w) = IO\pipe();
+    using ($w->closeWhenDisposed()) {
+      $w->write("Hello, world\n");
+    }
+    expect(await $r->readAsync())->toEqual("Hello, world\n");
+    // - does not block forever
+    // - does not fail, just succeeds with no data
+    expect(await $r->readAsync())->toEqual('');
+
+    $ex = expect(() ==> $w->write('foo'))->toThrow(OS\ErrnoException::class);
+    expect($ex->getErrno())->toEqual(OS\Errno::EBADF);
+  }
+
   public async function testReadFromClosedPipe(): Awaitable<void> {
     // Intent is to:
     // - make sure we throw the expected errno