New ngrok domains and code style

jn-jairo · Apr 12, 2023 · 9ab8394 · 9ab8394
1 parent 4c2466f
commit 9ab8394
Show file tree

Hide file tree

Showing 10 changed files with 118 additions and 68 deletions.
diff --git a/CHANGELOG-3.x.md b/CHANGELOG-3.x.md
@@ -1,6 +1,11 @@
 # Changelog
 
-## [Unreleased](https://github.com/jn-jairo/laravel-ngrok/compare/v3.0.0...3.x)
+## [Unreleased](https://github.com/jn-jairo/laravel-ngrok/compare/v3.0.1...3.x)
+
+## [v3.0.1 (2023-04-12)](https://github.com/jn-jairo/laravel-ngrok/compare/v3.0.0...v3.0.1)
+
+### Added
+- New ngrok domains
 
 ## [v3.0.0 (2023-02-25)](https://github.com/jn-jairo/laravel-ngrok/compare/v2.0.4...v3.0.0)
 

diff --git a/Makefile b/Makefile
@@ -83,7 +83,7 @@ test:
 		$(ARGS)
 
 .PHONY: test-coverage
-test-coverage: clear-coverage
+test-coverage: clean-coverage
 	@$(call show_title,'TEST COVERAGE') \
 	XDEBUG_MODE=coverage \
 	php -d zend_extension=xdebug.so \
@@ -119,7 +119,7 @@ parallel-test:
 		--passthru="--do-not-cache-result"
 
 .PHONY: parallel-test-coverage
-parallel-test-coverage: clear-coverage
+parallel-test-coverage: clean-coverage
 	@$(call show_title,'PARALLEL TEST COVERAGE') \
 	XDEBUG_MODE=coverage \
 	php -d zend_extension=xdebug.so \
@@ -132,7 +132,7 @@ parallel-test-coverage: clear-coverage
 		--coverage
 
 .PHONY: infection-test
-infection-test: clear-infection
+infection-test: clean-infection
 	@$(call show_title,'INFECTION TEST') \
 	infection \
 		--threads=$(shell nproc) \
@@ -164,15 +164,15 @@ show-coverage:
 show-infection:
 	@xdg-open build/infection/infection.html > /dev/null 2>&1
 
-.PHONY: clear
-clear: clear-coverage clear-infection
+.PHONY: clean
+clean: clean-coverage clean-infection
 
-.PHONY: clear-coverage
-clear-coverage:
+.PHONY: clean-coverage
+clean-coverage:
 	@$(call show_title,'CLEAR COVERAGE') \
 	(rm -r build/coverage > /dev/null 2>&1 || true)
 
-.PHONY: clear-infection
-clear-infection:
+.PHONY: clean-infection
+clean-infection:
 	@$(call show_title,'CLEAR INFECTION') \
 	(rm -r build/infection > /dev/null 2>&1 || true)
diff --git a/php-cs-fixer.php b/php-cs-fixer.php
@@ -7,4 +7,13 @@
 
 return (new PhpCsFixer\Config())->setRules([
     'no_unused_imports' => true,
+    'trailing_comma_in_multiline' => [
+        'after_heredoc' => true,
+        'elements' => [
+            'arguments',
+            'arrays',
+            'match',
+            'parameters',
+        ],
+    ],
 ])->setFinder($finder);
diff --git a/src/NgrokProcessBuilder.php b/src/NgrokProcessBuilder.php
@@ -54,7 +54,7 @@ public function buildProcess(
         string $hostHeader = '',
         string $port = '80',
         string $host = '',
-        array $extra = []
+        array $extra = [],
     ): Process {
         $command = ['ngrok', 'http', '--log', 'stdout'];
 

diff --git a/src/NgrokServiceProvider.php b/src/NgrokServiceProvider.php
@@ -9,6 +9,19 @@
 
 class NgrokServiceProvider extends ServiceProvider
 {
+    /**
+     * Ngrok valid domains.
+     *
+     * @var array<int, string>
+     */
+    public const NGROK_DOMAINS = [
+        'ngrok.io',
+        'ngrok-free.app',
+        'ngrok-free.dev',
+        'ngrok.app',
+        'ngrok.dev',
+    ];
+
     /**
      * Bootstrap the application services.
      *
@@ -118,6 +131,12 @@ private function extractOriginalHost(Request $request): string
      */
     private function isNgrokHost(string $host): bool
     {
-        return (bool) preg_match('/^[\.\-a-z0-9]+\.ngrok\.io$/i', $host);
+        $domains = collect(self::NGROK_DOMAINS)
+            ->map(fn($domain) => preg_quote($domain, '/'))
+            ->join('|');
+
+        $regex = '/^[\.\-a-z0-9]+\.(?:' . $domains . ')$/i';
+
+        return (bool) preg_match($regex, $host);
     }
 }
diff --git a/src/NgrokWebService.php b/src/NgrokWebService.php
@@ -82,9 +82,9 @@ public function getTunnels(): array
         $response = json_decode(
             $this->getHttpClient()->request(
                 'GET',
-                $this->getUrl() . '/api/tunnels'
+                $this->getUrl() . '/api/tunnels',
             )->getBody(),
-            true
+            true,
         );
 
         if ($response !== false && isset($response['tunnels']) && ! empty($response['tunnels'])) {

diff --git a/tests/NgrokCommandTest.php b/tests/NgrokCommandTest.php
@@ -83,7 +83,7 @@
     array $config,
     array $params,
     array $expectedArguments,
-    array $expectedOutputs
+    array $expectedOutputs,
 ) {
     config($config);
 
@@ -92,11 +92,11 @@
 
     $tunnels = [
         [
-            'public_url' => 'http://0000-0000.ngrok.io',
+            'public_url' => 'http://0000-0000.ngrok-free.app',
             'config' => ['addr' => $host . ':' . $port],
         ],
         [
-            'public_url' => 'https://0000-0000.ngrok.io',
+            'public_url' => 'https://0000-0000.ngrok-free.app',
             'config' => ['addr' => $host . ':' . $port],
         ],
     ];
@@ -154,7 +154,7 @@
     array $config,
     array $params,
     array $expectedArguments,
-    array $expectedOutputs
+    array $expectedOutputs,
 ) {
     config($config);
 
@@ -163,11 +163,11 @@
 
     $tunnels = [
         [
-            'public_url' => 'http://0000-0000.ngrok.io',
+            'public_url' => 'http://0000-0000.ngrok-free.app',
             'config' => ['addr' => $host . ':' . $port],
         ],
         [
-            'public_url' => 'https://0000-0000.ngrok.io',
+            'public_url' => 'https://0000-0000.ngrok-free.app',
             'config' => ['addr' => $host . ':' . $port],
         ],
     ];

diff --git a/tests/NgrokProcessBuilderTest.php b/tests/NgrokProcessBuilderTest.php
@@ -61,7 +61,7 @@
 
 it('can build process', function (
     array $args,
-    string $command
+    string $command,
 ) {
     $processBuilder = new NgrokProcessBuilder(__DIR__);
     $process = $processBuilder->buildProcess(...$args);

diff --git a/tests/NgrokServiceProviderTest.php b/tests/NgrokServiceProviderTest.php
@@ -12,34 +12,51 @@
 
 uses(ProphecyTrait::class);
 
-$datasetValidNgrokUrl = [
-    'http_ngrok_2' => [
-        'http',
-        [
-            'HTTP_X_ORIGINAL_HOST' => '0000-0000.ngrok.io',
-        ],
-    ],
-    'http_ngrok_3' => [
-        'http',
-        [
-            'HTTP_X_FORWARDED_HOST' => '0000-0000.ngrok.io',
-        ],
-    ],
-    'https_ngrok_2' => [
-        'https',
-        [
-            'HTTP_X_ORIGINAL_HOST' => '0000-0000.ngrok.io',
-            'HTTP_X_FORWARDED_PROTO' => 'https',
-        ],
-    ],
-    'https_ngrok_3' => [
-        'https',
-        [
-            'HTTP_X_FORWARDED_HOST' => '0000-0000.ngrok.io',
-            'HTTP_X_FORWARDED_PROTO' => 'https',
-        ],
-    ],
-];
+$datasetValidNgrokUrl = (function () {
+    $dataset = [];
+
+    $domains = [
+        'legacy' => 'ngrok.io',
+        'free_app' => 'ngrok-free.app',
+        'free_dev' => 'ngrok-free.dev',
+        'paid_app' => 'ngrok.app',
+        'paid_dev' => 'ngrok.dev',
+    ];
+
+    foreach ($domains as $label => $domain) {
+        $dataset[$label . '_http_ngrok_2'] = [
+            'http',
+            [
+                'HTTP_X_ORIGINAL_HOST' => '0000-0000.ngrok-free.app',
+            ],
+        ];
+
+        $dataset[$label . '_http_ngrok_3'] = [
+            'http',
+            [
+                'HTTP_X_FORWARDED_HOST' => '0000-0000.ngrok-free.app',
+            ],
+        ];
+
+        $dataset[$label . '_https_ngrok_2'] = [
+            'https',
+            [
+                'HTTP_X_ORIGINAL_HOST' => '0000-0000.ngrok-free.app',
+                'HTTP_X_FORWARDED_PROTO' => 'https',
+            ],
+        ];
+
+        $dataset[$label . '_https_ngrok_3'] = [
+            'https',
+            [
+                'HTTP_X_FORWARDED_HOST' => '0000-0000.ngrok-free.app',
+                'HTTP_X_FORWARDED_PROTO' => 'https',
+            ],
+        ];
+    }
+
+    return $dataset;
+})();
 
 $datasetInvalidNgrokUrl = [
     'http_empty' => [
@@ -59,13 +76,13 @@
     'http_ngrok_2_domain' => [
         'http',
         [
-            'HTTP_X_ORIGINAL_HOST' => '0000-0000.notngrok.io',
+            'HTTP_X_ORIGINAL_HOST' => '0000-0000.notngrok-free.app',
         ],
     ],
     'http_ngrok_2_subdomain' => [
         'http',
         [
-            'HTTP_X_ORIGINAL_HOST' => '0000_0000.ngrok.io',
+            'HTTP_X_ORIGINAL_HOST' => '0000_0000.ngrok-free.app',
         ],
     ],
     'http_ngrok_3_domain_top_level' => [
@@ -77,13 +94,13 @@
     'http_ngrok_3_domain' => [
         'http',
         [
-            'HTTP_X_FORWARDED_HOST' => '0000-0000.notngrok.io',
+            'HTTP_X_FORWARDED_HOST' => '0000-0000.notngrok-free.app',
         ],
     ],
     'http_ngrok_3_subdomain' => [
         'http',
         [
-            'HTTP_X_FORWARDED_HOST' => '0000_0000.ngrok.io',
+            'HTTP_X_FORWARDED_HOST' => '0000_0000.ngrok-free.app',
         ],
     ],
     'https_ngrok_2_domain_top_level' => [
@@ -96,14 +113,14 @@
     'https_ngrok_2_domain' => [
         'https',
         [
-            'HTTP_X_ORIGINAL_HOST' => '0000-0000.notngrok.io',
+            'HTTP_X_ORIGINAL_HOST' => '0000-0000.notngrok-free.app',
             'HTTP_X_FORWARDED_PROTO' => 'https',
         ],
     ],
     'https_ngrok_2_subdomain' => [
         'https',
         [
-            'HTTP_X_ORIGINAL_HOST' => '0000_0000.ngrok.io',
+            'HTTP_X_ORIGINAL_HOST' => '0000_0000.ngrok-free.app',
             'HTTP_X_FORWARDED_PROTO' => 'https',
         ],
     ],
@@ -117,14 +134,14 @@
     'https_ngrok_3_domain' => [
         'https',
         [
-            'HTTP_X_FORWARDED_HOST' => '0000-0000.notngrok.io',
+            'HTTP_X_FORWARDED_HOST' => '0000-0000.notngrok-free.app',
             'HTTP_X_FORWARDED_PROTO' => 'https',
         ],
     ],
     'https_ngrok_3_subdomain' => [
         'https',
         [
-            'HTTP_X_FORWARDED_HOST' => '0000_0000.ngrok.io',
+            'HTTP_X_FORWARDED_HOST' => '0000_0000.ngrok-free.app',
             'HTTP_X_FORWARDED_PROTO' => 'https',
         ],
     ],
@@ -160,7 +177,7 @@
 
 it('does not setup invalid ngrok url', function (
     string $scheme,
-    array $headers
+    array $headers,
 ) {
     /**
      * @var \Prophecy\Prophecy\ObjectProphecy<\Illuminate\Routing\UrlGenerator> $urlGenerator
@@ -195,19 +212,19 @@
 
 it('setup valid ngrok url', function (
     string $scheme,
-    array $headers
+    array $headers,
 ) {
     /**
      * @var \Prophecy\Prophecy\ObjectProphecy<\Illuminate\Routing\UrlGenerator> $urlGenerator
      */
     $urlGenerator = prophesize(UrlGenerator::class);
     $urlGenerator->forceScheme($scheme)->shouldBeCalled();
-    $urlGenerator->forceRootUrl($scheme . '://0000-0000.ngrok.io')->shouldBeCalled();
+    $urlGenerator->forceRootUrl($scheme . '://0000-0000.ngrok-free.app')->shouldBeCalled();
     $urlGenerator->to(
         'foo',
         \Prophecy\Argument::any(),
-        \Prophecy\Argument::any()
-    )->willReturn($scheme . '://0000-0000.ngrok.io/foo')->shouldBeCalled();
+        \Prophecy\Argument::any(),
+    )->willReturn($scheme . '://0000-0000.ngrok-free.app/foo')->shouldBeCalled();
 
     $request = Request::create(
         $scheme . '://example.com/foo',
@@ -230,5 +247,5 @@
     $serviceProvider->boot();
 
     expect(Paginator::resolveCurrentPath())
-        ->toBe($scheme . '://0000-0000.ngrok.io/foo');
+        ->toBe($scheme . '://0000-0000.ngrok-free.app/foo');
 })->with($datasetValidNgrokUrl);