1861728092

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/tattersoftware/codeigniter4-firebase/commit/<a class=hub.com/tattersoftware/codeigniter4-firebase/commit/<a class="double-link" href="https://git"><a class=hub.com/tattersoftware/codeigniter4-firebase/commit/<a class="double-link" href="https://git"><a class=hub.com/tattersoftware/codeigniter4-firebase/commit/030580805f5f4de8a35db129a3cacc928764b6df">030580805<a href="https://github.com/tattersoftware/codeigniter4-firebase/commit/030580805f5f4de8a35db129a3cacc928764b6df">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/tattersoftware/codeigniter4-firebase/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/tattersoftware/codeigniter4-firebase/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/tattersoftware/codeigniter4-firebase/commit/030580805f5f4de8a35db129a3cacc928764b6df&quot;&gt;030580805&lt;/a&gt;&lt;a href=&quot;https://github.com/tattersoftware/codeigniter4-firebase/commit/030580805f5f4de8a35db129a3cacc928764b6df&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/tattersoftware/codeigniter4-firebase/commit/030580805f5f4de8a35db129a3cacc92&lt;/a&gt;8764b6df&quot;&gt;&amp;quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/tattersoftware/codeigniter4-firebase/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/tattersoftware/codeigniter4-firebase/commit/<a class="double-link" href="https://github.com/tattersoftware/codeigniter4-firebase/commit/9acac92177cb22da541e9d6c2ca237f6f2b142e7">9acac9217</a><a href="https://github.com/tattersoftware/codeigniter4-firebase/commit/030580805f5f4de8a35db129a3cacc928764b6df">&amp;quot;&amp;gt;9acac9217&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;9acac9217&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/tattersoftware/codeigniter4-firebase/commit/030580805f5f4de8a35db129a3cacc928764b&lt;/a&gt;6df&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/tattersoftware/codeigniter4-firebase/commit/<a class="double-link" href="https://github.com/tattersoftware/codeigniter4-firebase/commit/3dcc9ae64">3dcc9ae64">3dcc9ae64</a>

Pull Request Pull Request #31: Typed Properties

Run Details

3 of 6 new or added lines in 2 files covered. (50.0%)

201 of 240 relevant lines covered (83.75%)

10.55 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

89.66

/src/Test/FirestoreTestTrait.php

<?php

namespace Tatter\Firebase\Test;

use Google\Cloud\Firestore\CollectionReference;
use Google\Cloud\Firestore\FirestoreClient;
use RuntimeException;

/**
 * Trait to add some helpful utilities for testing with Firestore.
 */
trait FirestoreTestTrait
{
    protected function setUpFirestoreTestTrait(): void
    {
        helper(['firestore']);
    }

    /**
     * Completely empty a Firestore database.
     *
     * @param bool $useEmulator For testing only.
     */
    protected function clearFirestore(bool $useEmulator = true)
    {
        if (ENVIRONMENT !== 'testing') {
            throw new RuntimeException('This feature is only available during testing.'); // @codeCoverageIgnore
        }

        // Get the shared instance
        $firestore = firestore();

        // Check for an emulated instance
        if (
            $useEmulator
            && ($firestoreEmulatorHost = getenv('FIRESTORE_EMULATOR_HOST'))
            && ($projectId = service('firebase')->getDebugInfo()['projectId'])
        ) {
            $deleteUrl = 'http://' . $firestoreEmulatorHost . '/emulator/v1/projects/' . $projectId . '/databases/(default)/documents';
            single_service('curlrequest')->delete($deleteUrl);

            return;
        }

        // Otherwise delete each collection
        foreach ($firestore->collections() as $collection) {
            $this->deleteCollection($collection, $firestore);
        }
    }

    /**
     * Remove an entire Firestore Collection, including subcollections.
     *
     * @param CollectionReference|string $collection
     */
    protected function deleteCollection($collection, ?FirestoreClient $firestore = null)
    {
        $firestore ??= firestore();

        // If a collection name was given then get the reference
        if (is_string($collection)) {
            $collection = $firestore->collection($collection);
        }

        // https://firebase.google.com/docs/firestore/manage-data/delete-data#collections
        $documents = $collection->limit(30)->documents();

        while (! $documents->isEmpty()) {
            foreach ($documents as $document) {
                foreach ($document->reference()->collections() as $subcollection) {
                    $this->deleteCollection($subcollection, $firestore);
                }

                $document->reference()->delete();
            }
            $documents = $collection->limit(30)->documents();
        }

        // Repeat for any lingering deleted documents (not pagination safe)
        $documents = $collection->listDocuments();

        foreach ($documents as $document) {
            foreach ($document->collections() as $subcollection) {
                $this->deleteCollection($subcollection, $firestore);
            }

            $document->delete();
        }
    }
}

1	<?php
2
3	namespace Tatter\Firebase\Test;
4
5	use Google\Cloud\Firestore\CollectionReference;
6	use Google\Cloud\Firestore\FirestoreClient;
7	use RuntimeException;
8
9	/**
10	* Trait to add some helpful utilities for testing with Firestore.
11	*/
12	trait FirestoreTestTrait
13	{
14	protected function setUpFirestoreTestTrait(): void
15	{
16	helper(['firestore']);	53✔
17	}	53✔
18
19	/**
20	* Completely empty a Firestore database.
21	*
22	* @param bool $useEmulator For testing only.
23	*/
24	protected function clearFirestore(bool $useEmulator = true)
25	{
26	if (ENVIRONMENT !== 'testing') {	53✔
27	throw new RuntimeException('This feature is only available during testing.'); // @codeCoverageIgnore
28	}
29
30	// Get the shared instance
31	$firestore = firestore();	53✔
32
33	// Check for an emulated instance
34	if (
35	$useEmulator	53✔
36	&& ($firestoreEmulatorHost = getenv('FIRESTORE_EMULATOR_HOST'))	53✔
37	&& ($projectId = service('firebase')->getDebugInfo()['projectId'])	53✔
38	) {
39	$deleteUrl = 'http://' . $firestoreEmulatorHost . '/emulator/v1/projects/' . $projectId . '/databases/(default)/documents';	53✔
40	single_service('curlrequest')->delete($deleteUrl);	53✔
41
42	return;	53✔
43	}
44
45	// Otherwise delete each collection
46	foreach ($firestore->collections() as $collection) {	1✔
47	$this->deleteCollection($collection, $firestore);	1✔
48	}
49	}	1✔
50
51	/**
52	* Remove an entire Firestore Collection, including subcollections.
53	*
54	* @param CollectionReference\|string $collection
55	*/
56	protected function deleteCollection($collection, ?FirestoreClient $firestore = null)
57	{
58	$firestore ??= firestore();	3✔
59
60	// If a collection name was given then get the reference
61	if (is_string($collection)) {	3✔
62	$collection = $firestore->collection($collection);	2✔
63	}
64
65	// https://firebase.google.com/docs/firestore/manage-data/delete-data#collections
66	$documents = $collection->limit(30)->documents();	3✔
67
68	while (! $documents->isEmpty()) {	3✔
69	foreach ($documents as $document) {	3✔
70	foreach ($document->reference()->collections() as $subcollection) {	3✔
71	$this->deleteCollection($subcollection, $firestore);	1✔
72	}
73
74	$document->reference()->delete();	3✔
75	}
76	$documents = $collection->limit(30)->documents();	3✔
77	}
78
79	// Repeat for any lingering deleted documents (not pagination safe)
80	$documents = $collection->listDocuments();	3✔
81
82	foreach ($documents as $document) {	3✔
NEW 83	foreach ($document->collections() as $subcollection) {	×
NEW 84	$this->deleteCollection($subcollection, $firestore);	×
85	}
86
NEW 87	$document->delete();	×
88	}
89	}	3✔
90	}

tattersoftware / codeigniter4-firebase / 1861728092

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous