diff --git a/.github/workflows/perform-lints.yml b/.github/workflows/perform-lints.yml index 2a3df76..05a2542 100644 --- a/.github/workflows/perform-lints.yml +++ b/.github/workflows/perform-lints.yml @@ -107,7 +107,7 @@ jobs: uses: actions/checkout@v4 - name: Setup PHP - uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0@v2 + uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0@v2 with: php-version: '8.2' coverage: none @@ -115,7 +115,7 @@ jobs: # Install/cache composer dependencies - name: Install dependencies - uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # v3.1.0@v3 + uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # v3.1.0@v3 with: composer-options: '--no-progress' @@ -140,7 +140,7 @@ jobs: uses: actions/checkout@v4 - name: Setup PHP - uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0@v2 + uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0@v2 with: php-version: '8.2' extensions: mbstring, intl @@ -149,7 +149,7 @@ jobs: # Install/cache composer dependencies - name: Install dependencies - uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # v3.1.0@v3 + uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # v3.1.0@v3 with: composer-options: '--no-progress' @@ -203,7 +203,7 @@ jobs: uses: actions/checkout@v4 - name: Install PHP - uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0@v2 + uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0@v2 with: php-version: ${{ matrix.php }} extensions: json, mbstring @@ -211,7 +211,7 @@ jobs: # Install/cache composer dependencies - name: Install dependencies - uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # v3.1.0@v3 + uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # v3.1.0@v3 - name: Setup Node.js uses: actions/setup-node@v4 @@ -258,7 +258,7 @@ jobs: - name: Push coverage to Coveralls.io if: matrix.coverage == 1 - uses: coverallsapp/github-action@648a8eb78e6d50909eff900e4ec85cab4524a45b # v2.3.6 + uses: coverallsapp/github-action@648a8eb78e6d50909eff900e4ec85cab4524a45b # v2.3.6 with: github-token: ${{ secrets.GITHUB_TOKEN }} file: tests/_output/Integration-coverage.xml @@ -267,7 +267,7 @@ jobs: - name: Push coverage to CodeClimate if: matrix.coverage == 1 - uses: paambaati/codeclimate-action@f429536ee076d758a24705203199548125a28ca7 # v9.0.0 + uses: paambaati/codeclimate-action@f429536ee076d758a24705203199548125a28ca7 # v9.0.0 env: CC_TEST_REPORTER_ID: d16e661bd765b428e1b7bde991152367616a6511fab735cbb459976ec54096a0 with: @@ -286,14 +286,14 @@ jobs: uses: actions/checkout@v4 - name: Setup PHP - uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0@v2 + uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0@v2 with: php-version: '8.2' coverage: none tools: composer - name: Install Composer dependencies - uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # v3.1.0@v3 + uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # v3.1.0@v3 with: composer-options: '--no-progress' @@ -357,7 +357,7 @@ jobs: uses: actions/checkout@v4 - name: Setup PHP w/ Composer & WP-CLI - uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0@v2 + uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0@v2 with: php-version: 8.2 extensions: mbstring, intl, bcmath, exif, gd, mysqli, opcache, zip, pdo_mysql @@ -365,7 +365,7 @@ jobs: tools: composer:v2, wp-cli - name: Install Composer dependencies - uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # v3.1.0@v3 + uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # v3.1.0@v3 with: composer-options: '--no-progress' @@ -405,7 +405,7 @@ jobs: graphql-schema-linter /tmp/schema.graphql || true - name: Get Latest tag - uses: actions-ecosystem/action-get-latest-tag@b7c32daec3395a9616f88548363a42652b22d435 # v1.6.0 + uses: actions-ecosystem/action-get-latest-tag@b7c32daec3395a9616f88548363a42652b22d435 # v1.6.0 id: get-latest-tag - name: Test Schema for breaking changes diff --git a/.github/workflows/upload-release.yml b/.github/workflows/upload-release.yml index 3b319c0..8a8ea93 100644 --- a/.github/workflows/upload-release.yml +++ b/.github/workflows/upload-release.yml @@ -18,7 +18,7 @@ jobs: uses: actions/checkout@v4 - name: Setup PHP - uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0@v2 + uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0@v2 with: php-version: 7.4 coverage: none @@ -26,7 +26,7 @@ jobs: tools: composer:v2 - name: Install Composer dependencies - uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # v3.1.0@v3 + uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # v3.1.0@v3 with: composer-options: '--no-progress' @@ -54,7 +54,7 @@ jobs: path: snapwp-helper.zip - name: Upload release asset - uses: softprops/action-gh-release@c95fe1489396fe8a9eb87c0abf8aa5b2ef267fda # v2.2.1 + uses: softprops/action-gh-release@c95fe1489396fe8a9eb87c0abf8aa5b2ef267fda # v2.2.1 with: files: snapwp-helper.zip env: diff --git a/.github/workflows/upload-schema-artifact.yml b/.github/workflows/upload-schema-artifact.yml index 5ab3c74..bbf8f04 100644 --- a/.github/workflows/upload-schema-artifact.yml +++ b/.github/workflows/upload-schema-artifact.yml @@ -26,7 +26,7 @@ jobs: uses: actions/checkout@v4 - name: Setup PHP w/ Composer & WP-CLI - uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0@v2 + uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0@v2 with: php-version: 8.2 extensions: mbstring, intl, bcmath, exif, gd, mysqli, opcache, zip, pdo_mysql @@ -34,7 +34,7 @@ jobs: tools: composer:v2, wp-cli - name: Install Composer dependencies - uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # v3.1.0@v3 + uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # v3.1.0@v3 with: composer-options: '--no-progress' @@ -66,7 +66,7 @@ jobs: wp graphql generate-static-schema --allow-root - name: Upload schema as release artifact - uses: softprops/action-gh-release@c95fe1489396fe8a9eb87c0abf8aa5b2ef267fda # v2.2.1 + uses: softprops/action-gh-release@c95fe1489396fe8a9eb87c0abf8aa5b2ef267fda # v2.2.1 with: files: /tmp/schema.graphql env: diff --git a/CHANGELOG.md b/CHANGELOG.md index 2d8ee74..219add6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](./README.md#updating-and-versi - tests: Use `IntegrationTestCase` for Integration tests. - feat: Expose `generalSettings.siteIcon` field to the schema. +- refactor!: Update EnvGenerator variables and handling. +- dev: Deprecate the `snapwp_helper_get_env_content()` and `snapwp_helper_get_env_variables()` functions, in favor of using the `VariableRegistry` and `Generator` classes directly. ## [0.2.1] - 2025-03-10 diff --git a/access-functions.php b/access-functions.php index 98f6c2b..edac098 100644 --- a/access-functions.php +++ b/access-functions.php @@ -3,48 +3,51 @@ * Global functions for the SnapWP Helper plugin. * * @package SnapWP\Helper + * + * @phpstan-import-type SnapWP\Helper\Modules\EnvGenerator\VariableConfig from \SnapWP\Helper\Modules\EnvGenerator\VariableConfig */ declare(strict_types=1); use SnapWP\Helper\Modules\EnvGenerator\Generator; use SnapWP\Helper\Modules\EnvGenerator\VariableRegistry; -use SnapWP\Helper\Modules\GraphQL\Data\IntrospectionToken; if ( ! function_exists( 'snapwp_helper_get_env_content' ) ) { /** - * Generates the .env file content based on the provided variables. + * Generates the SnapWP .env file content based on the site configuration. + * + * @deprecated @next-version Use \SnapWP\Helper\Modules\EnvGenerator\Generator::generate() directly. + * @codeCoverageIgnore * * @return string|\WP_Error The .env file content or an error object. */ function snapwp_helper_get_env_content() { + _deprecated_function( + __FUNCTION__, + '@next-version', + sprintf( + /* translators: %s: function name */ + esc_html__( 'Please use %s directly.', 'snapwp-helper' ), + Generator::class . '::generate()' + ) + ); - // Fetch the environment variables and check for errors. - $variables = snapwp_helper_get_env_variables(); - if ( is_wp_error( $variables ) ) { - return new \WP_Error( - 'env_variables_error', - $variables->get_error_message(), - [ 'status' => 500 ] - ); - } + // Create registry and generator instances. + try { + $registry = new VariableRegistry(); + $generator = new Generator( $registry ); - $generator = new Generator( $variables, new VariableRegistry() ); + $content = $generator->generate(); - // Generate and return the content for env file. - $content = null; + // Bail if content is empty. + if ( empty( $content ) ) { + return new \WP_Error( 'env_generation_failed', esc_html__( 'Unable to generate .env content.', 'snapwp-helper' ) ); + } - try { - $content = $generator->generate(); + return $content; } catch ( \Throwable $e ) { return new \WP_Error( 'env_generation_failed', $e->getMessage() ); } - - if ( empty( $content ) ) { - return new \WP_Error( 'env_generation_failed', 'No content generated.' ); - } - - return $content; } } @@ -52,33 +55,28 @@ function snapwp_helper_get_env_content() { /** * Get the list of environment variables. * - * @return array,string>|\WP_Error The environment variables and their values. + * @deprecated @next-version Use \SnapWP\Helper\Modules\EnvGenerator\VariableRegistry::get_all_values() directly. + * @codeCoverageIgnore + * + * @return array|\WP_Error The environment variables and their values. */ function snapwp_helper_get_env_variables() { - if ( ! function_exists( 'graphql_get_endpoint' ) ) { - return new \WP_Error( 'graphql_not_found', 'WPGraphQL must be installed and activated.', [ 'status' => 500 ] ); - } - - // Get the introspection token. - $token = IntrospectionToken::get_token(); + _deprecated_function( + __FUNCTION__, + '@next-version', + sprintf( + /* translators: %s: function name */ + esc_html__( 'Please use %s directly.', 'snapwp-helper' ), + VariableRegistry::class . '::get_all_values()' + ) + ); - // Bail if we couldn't get the token. - if ( is_wp_error( $token ) ) { - return $token; + // Create registry and get all values. + try { + $registry = new VariableRegistry(); + return $registry->get_all_values(); + } catch ( \Throwable $e ) { + return new \WP_Error( 'env_variables_error', $e->getMessage(), [ 'status' => 500 ] ); } - - // Ensure the upload path has a leading slash for consistency. - $upload_dir = wp_get_upload_dir(); - $upload_path = '/' . ltrim( str_replace( ABSPATH, '', $upload_dir['basedir'] ), '/' ); - - return [ - 'NODE_TLS_REJECT_UNAUTHORIZED' => '0', - 'NEXT_PUBLIC_URL' => 'http://localhost:3000', - 'NEXT_PUBLIC_WORDPRESS_URL' => untrailingslashit( get_home_url() ), - 'NEXT_PUBLIC_GRAPHQL_ENDPOINT' => graphql_get_endpoint(), - 'NEXT_PUBLIC_WORDPRESS_UPLOADS_PATH' => $upload_path, - 'NEXT_PUBLIC_WORDPRESS_REST_URL_PREFIX' => '/' . rest_get_url_prefix(), - 'INTROSPECTION_TOKEN' => $token, - ]; } } diff --git a/docs/rest-api.md b/docs/rest-api.md index 9a2ce70..a0b5d75 100644 --- a/docs/rest-api.md +++ b/docs/rest-api.md @@ -23,12 +23,15 @@ curl -X GET \ This endpoint does not require any parameters to be passed in the request body. The .env file content is generated based on WordPress settings. Unchanged variables will be commented out. - - `NODE_TLS_REJECT_UNAUTHORIZED`: Only enable if connecting to a self-signed cert. (Default: `0`) - - `NEXT_PUBLIC_URL` (Required): The headless frontend domain URL. (Default: `http://localhost:3000`) - - `NEXT_PUBLIC_WORDPRESS_URL` (Required): The WordPress "frontend" domain URL. - - `NEXT_PUBLIC_GRAPHQL_ENDPOINT`: The WordPress GraphQL endpoint. (Default: `graphql`) - - `NEXT_PUBLIC_WORDPRESS_UPLOADS_PATH`: The WordPress Uploads directory path. (Default: `wp-content/uploads`) - - `NEXT_PUBLIC_WORDPRESS_REST_URL_PREFIX`: The WordPress REST URL Prefix. (Default: `wp-json`) + - `INTROSPECTION_TOKEN` (Required): Token used for authenticating GraphQL introspection queries + - `NEXT_PUBLIC_CORS_PROXY_PREFIX`: The CORS proxy prefix to use when bypassing CORS restrictions from WordPress server, Possible values: string|false Default: /proxy. This means for script module next app will make request `NEXT_PUBLIC_FRONTEND_URL/proxy/{module-path}`. (Default: `/proxy`) + - `NEXT_PUBLIC_FRONTEND_URL` (Required): The headless frontend domain URL. (Default: `http://localhost:3000`) + - `NEXT_PUBLIC_GRAPHQL_ENDPOINT` (Required): The WordPress GraphQL endpoint. (Default: `graphql`) + - `NEXT_PUBLIC_REST_URL_PREFIX`: The WordPress REST URL Prefix. (Default: `wp-json`) + - `NEXT_PUBLIC_WP_HOME_URL` (Required): The WordPress "frontend" domain URL. + - `NEXT_PUBLIC_WP_SITE_URL` : The WordPress "backend" domain URL. + - `NEXT_PUBLIC_WP_UPLOADS_DIRECTORY`: The WordPress Uploads directory path. (Default: `wp-content/uploads`) + - `NODE_TLS_REJECT_UNAUTHORIZED` (Required): Only enable if connecting to a self-signed cert. (Default: `0`) Note: This endpoint requires authentication with administrator privileges. @@ -42,7 +45,7 @@ Note: This endpoint requires authentication with administrator privileges. ```json { - "content": "\n# The headless frontend domain URL\nNEXT_URL=http://localhost:3000\\n\n# The WordPress \"frontend\" domain URL\nHOME_URL=https://headless-demo.local\\n\n# The WordPress GraphQL endpoint\nGRAPHQL_ENDPOINT=graphql\\n" + "content":"\n# Token used for authenticating GraphQL introspection queries\nINTROSPECTION_TOKEN=Th15IS4te5tT0KEN\n\n# The CORS proxy prefix to use when bypassing CORS restrictions from WordPress server, Possible values: string|false Default: \/proxy, This means for script module next app will make request NEXT_PUBLIC_FRONTEND_URL\/proxy\/{module-path}\n# NEXT_PUBLIC_CORS_PROXY_PREFIX=\/proxy\n\n# The headless frontend domain URL. Make sure the value matches the URL used by your frontend app.\nNEXT_PUBLIC_FRONTEND_URL=http:\/\/localhost:3000\n\n# The WordPress GraphQL endpoint\nNEXT_PUBLIC_GRAPHQL_ENDPOINT=graphql\n\n# The WordPress REST URL Prefix\n# NEXT_PUBLIC_REST_URL_PREFIX=\/wp-json\n\n# The WordPress \"frontend\" domain URL e.g. https:\/\/my-headless-site.local\nNEXT_PUBLIC_WP_HOME_URL=http:\/\/snapwp.local\n\n# The WordPress \"backend\" Site Address. Uncomment if different than `NEXT_PUBLIC_WP_HOME_URL` e.g. https:\/\/my-headless-site.local\/wp\/\n# NEXT_PUBLIC_WP_SITE_URL=\n\n# The WordPress Uploads directory path\n# NEXT_PUBLIC_WP_UPLOADS_DIRECTORY=\/wp-content\/uploads\n\n# Only enable if connecting to a self-signed cert\nNODE_TLS_REJECT_UNAUTHORIZED=0" } ``` diff --git a/src/Modules/Admin.php b/src/Modules/Admin.php index 8819734..3afdfd6 100644 --- a/src/Modules/Admin.php +++ b/src/Modules/Admin.php @@ -11,6 +11,8 @@ use SnapWP\Helper\Interfaces\Module; use SnapWP\Helper\Modules\Admin\Settings; +use SnapWP\Helper\Modules\EnvGenerator\Generator; +use SnapWP\Helper\Modules\EnvGenerator\VariableRegistry; use SnapWP\Helper\Modules\GraphQL\Data\IntrospectionToken; /** @@ -87,46 +89,34 @@ public function register_menu(): void { public function render_menu(): void { wp_enqueue_script( Assets::ADMIN_SCRIPT_HANDLE ); - $variables = snapwp_helper_get_env_variables(); + // Create registry to get environment variables. + $registry = new VariableRegistry(); - // Display an error message if the variables could not be loaded. - if ( is_wp_error( $variables ) ) { + try { + $variables = $registry->get_all_values(); + $env_file_content = $this->generate_env_content( $registry ); + } catch ( \Throwable $e ) { + // Display an error message if the variables could not be loaded. wp_admin_notice( sprintf( // translators: %s is the error message. __( 'Unable to load environment variables: %s', 'snapwp-helper' ), - $variables->get_error_message() + esc_html( $e->getMessage() ) ), [ 'type' => 'error', ] ); - } - - $env_file_content = snapwp_helper_get_env_content(); - - if ( is_wp_error( $env_file_content ) ) { - $error_message = sprintf( - // translators: %s is the error message. - __( 'Unable to generate the `.env` file content: %s', 'snapwp-helper' ), - $env_file_content->get_error_message() - ); - wp_admin_notice( - $error_message, - [ - 'type' => 'error', - ] - ); - // translators: %s is the error message. - $env_file_content = sprintf( __( 'Error: %s', 'snapwp-helper' ), $error_message ); + $variables = []; + $env_file_content = ''; } ?>

- +

@@ -138,36 +128,8 @@ public function render_menu(): void { ); ?>

- - - - - - - - - $value ) : ?> - - - - - - - -
- %s', $value ) ); ?> - - -
- - -
- - -
+ + render_variables_table( $registry, $variables ); ?>

@@ -238,7 +200,16 @@ public function render_menu(): void { ?>

-
    • +
  • + NEXT_PUBLIC_URL', + '.env', + ); + ?> +
    • @@ -256,6 +227,75 @@ public function render_menu(): void { generate(); + + if ( empty( $env_file_content ) ) { + throw new \Exception( esc_html__( 'No content generated.', 'snapwp-helper' ) ); + } + + return $env_file_content; + } + + /** + * Render the variables table. + * + * @param \SnapWP\Helper\Modules\EnvGenerator\VariableRegistry $registry The variable registry. + * @param array $variables The variables to display. + */ + private function render_variables_table( VariableRegistry $registry, array $variables ): void { + ?> + + + + + + + + + $value ) : ?> + get_output_mode( $key ); + $is_using_default = $registry->is_using_default_value( $key ); + ?> + + + + + + +
    + %s', $value ) ); ?> + + + + + + + + +
    + + +
    + +
    + - */ - private $values = []; - /** * The instance of the VariableRegistry class. * @@ -28,12 +21,10 @@ class Generator { /** * Constructor * - * @param array $values The values for the environment variables. * @param \SnapWP\Helper\Modules\EnvGenerator\VariableRegistry $registry The instance of the VariableRegistry class. */ - public function __construct( array $values, VariableRegistry $registry ) { + public function __construct( VariableRegistry $registry ) { $this->registry = $registry; - $this->values = $values; } /** @@ -42,47 +33,31 @@ public function __construct( array $values, VariableRegistry $registry ) { * @throws \InvalidArgumentException Thrown from prepare_variable method. */ public function generate(): ?string { - return $this->prepare_variables( $this->values ); - } - - /** - * Add environment variables to the generator based on the provided args. - * - * @param array $variables Associative array of environment variables to add. - * - * @throws \InvalidArgumentException If a required variable is missing a value. - */ - protected function prepare_variables( array $variables ): ?string { - // Prime the output string. - $output = ''; + // Get all registered variable names. + $variable_names = array_keys( $this->registry->get_all_variable_configs() ); - foreach ( $variables as $name => $value ) { - $variable_output = $this->prepare_variable( $name, $value ); + // Prepare output for all registered variables. + $output_parts = []; - if ( empty( $variable_output ) ) { - continue; - } + foreach ( $variable_names as $name ) { + $variable_output = $this->prepare_variable( $name ); - // Add a newline if there's already content. - if ( ! empty( $output ) ) { - $output .= "\n"; + if ( ! empty( $variable_output ) ) { + $output_parts[] = $variable_output; } - - $output .= $variable_output; } - return $output ?: null; + return ! empty( $output_parts ) ? implode( "\n\n", $output_parts ) : null; } /** * Prepare a single environment variable for output. * - * @param string $name The name of the variable. - * @param ?string $value The value of the variable. + * @param string $name The name of the variable. * * @throws \InvalidArgumentException If a required variable is missing a value. */ - protected function prepare_variable( string $name, ?string $value ): ?string { + protected function prepare_variable( string $name ): ?string { $variable = $this->registry->get_variable_config( $name ); // Skip if the variable is not registered. This acts as sanitization. @@ -91,27 +66,54 @@ protected function prepare_variable( string $name, ?string $value ): ?string { } $description = isset( $variable['description'] ) && is_string( $variable['description'] ) ? $variable['description'] : ''; - $default = isset( $variable['default'] ) && is_string( $variable['default'] ) ? $variable['default'] : ''; - $required = ! empty( $variable['required'] ); + $required = $this->registry->get_is_required( $name ); + + // Get resolved value (provided value, computed value, or default). + $resolved_value = $this->registry->get_value( $name ); // Check if a required variable has a value. - // @todo: handle NODE_TLS_REJECT_UNAUTHORIZED by checking the NEXT_PUBLIC_URL. - if ( $required && empty( $value ) && '0' !== $value ) { - throw new \InvalidArgumentException( 'Required variables must have a value.' ); + if ( $required && empty( $resolved_value ) && '0' !== $resolved_value ) { // '0' is a valid value. + throw new \InvalidArgumentException( + sprintf( + // translators: %s: The name of the variable. + esc_html__( 'Required variable %s must have a value.', 'snapwp-helper' ), + esc_html( $name ), + ) + ); } - // Determine the final value to output. - $resolved_value = ! empty( $value ) ? $value : $default; + // Get the output mode for this variable. + $output_mode = $this->registry->get_output_mode( $name ); + + // Skip if configured to not show this variable. + if ( VariableRegistry::OUTPUT_HIDDEN === $output_mode ) { + return null; + } // Prepare the output. - $comment = ! empty( $description ) ? sprintf( "\n# %s\n", $description ) : ''; + $comment = ! empty( $description ) ? sprintf( '# %s', $description ) : ''; + + // For commented variables with empty values, use the default value instead. + if ( VariableRegistry::OUTPUT_COMMENTED === $output_mode && + ( empty( $resolved_value ) && '0' !== $resolved_value ) ) { + $default_value = $this->registry->get_default_value( $name ); + $resolved_value = $default_value ?? ''; + } + $env_output = sprintf( '%s=%s', $name, $resolved_value ); - // Comment out variables if they're not required and have the default value. - if ( ! $required && $resolved_value === $default ) { + // Comment out variables based on output mode. + if ( VariableRegistry::OUTPUT_COMMENTED === $output_mode ) { $env_output = '# ' . $env_output; } - return $comment . $env_output; + // Combine comment and output. + $result = ''; + if ( ! empty( $comment ) ) { + $result .= $comment . "\n"; + } + $result .= $env_output; + + return $result; } } diff --git a/src/Modules/EnvGenerator/RestController.php b/src/Modules/EnvGenerator/RestController.php index c9d1b28..443152f 100644 --- a/src/Modules/EnvGenerator/RestController.php +++ b/src/Modules/EnvGenerator/RestController.php @@ -36,30 +36,39 @@ public function register_routes(): void { } /** - * This function is responsible for generating the REST controller for the EnvGenerator module. + * Generate the .env content and return it via REST API. * * @param \WP_REST_Request[]}> $request The REST request object. * * @return \WP_REST_Response|\WP_Error The response object. */ public function get_item( $request ) { + try { + // Create registry and generator to get .env content. + $registry = new VariableRegistry(); + $generator = new Generator( $registry ); - // Generate the .env content using the fetched variables. - $content = snapwp_helper_get_env_content(); + $content = $generator->generate(); - // Check if the content is an error. - if ( $content instanceof \WP_Error ) { + // Check if content was generated. + if ( empty( $content ) ) { + return new \WP_Error( + 'env_content_generation_failed', + __( 'No .env content was generated.', 'snapwp-helper' ), + [ 'status' => 500 ] + ); + } + + // Return the generated content in the response. + $response = new \WP_REST_Response( [ 'content' => $content ], 200 ); + return rest_ensure_response( $response ); + } catch ( \Throwable $e ) { return new \WP_Error( 'env_content_generation_failed', - $content->get_error_message(), + $e->getMessage(), [ 'status' => 500 ] ); } - - // Return the generated content in the response. - $response = new \WP_REST_Response( [ 'content' => $content ], 200 ); - - return rest_ensure_response( $response ); } /** diff --git a/src/Modules/EnvGenerator/VariableRegistry.php b/src/Modules/EnvGenerator/VariableRegistry.php index ce47f11..09f2b89 100644 --- a/src/Modules/EnvGenerator/VariableRegistry.php +++ b/src/Modules/EnvGenerator/VariableRegistry.php @@ -7,59 +7,36 @@ namespace SnapWP\Helper\Modules\EnvGenerator; +use SnapWP\Helper\Modules\GraphQL\Data\IntrospectionToken; + /** * VariableRegistry class to manage environment variables with descriptions and default values. + * + * @phpstan-type AllowedOutputMode = ('visible'|'commented'|'hidden') + * + * phpcs:disable SlevomatCodingStandard.Namespaces.FullyQualifiedClassNameInAnnotation.NonFullyQualifiedClassName + * @phpstan-type VariableConfig array{ + * description: string, + * default?: string|(callable(self): ?string)|null, + * outputMode: (AllowedOutputMode)|callable(self):(AllowedOutputMode), + * required: bool|(callable(self):bool), + * value?: string|(callable(self): ?string)|null, + * } + * + * phpcs:enable SlevomatCodingStandard.Namespaces.FullyQualifiedClassNameInAnnotation.NonFullyQualifiedClassName */ class VariableRegistry { /** - * Array of environment variables. - * - * @todo Support conditional variables. - * - * @var array + * Possible output modes for environment variables. */ - private const VARIABLES = [ - 'NODE_TLS_REJECT_UNAUTHORIZED' => [ - 'description' => 'Only enable if connecting to a self-signed cert', - 'default' => '0', - 'required' => true, - ], - 'NEXT_PUBLIC_URL' => [ - 'description' => 'The headless frontend domain URL. Make sure the value matches the URL used by your frontend app.', - 'default' => 'http://localhost:3000', - 'required' => true, - ], - 'NEXT_PUBLIC_WORDPRESS_URL' => [ - 'description' => 'The WordPress "frontend" domain URL', - 'default' => '', - 'required' => true, - ], - 'NEXT_PUBLIC_GRAPHQL_ENDPOINT' => [ - 'description' => 'The WordPress GraphQL endpoint', - 'default' => 'index.php?graphql', - 'required' => true, - ], - 'NEXT_PUBLIC_WORDPRESS_UPLOADS_PATH' => [ - 'description' => 'The WordPress Uploads directory path', - 'default' => '/wp-content/uploads', - 'required' => false, - ], - 'NEXT_PUBLIC_WORDPRESS_REST_URL_PREFIX' => [ - 'description' => 'The WordPress REST URL Prefix', - 'default' => '/wp-json', - 'required' => false, - ], - 'INTROSPECTION_TOKEN' => [ - 'description' => 'Token used for authenticating GraphQL introspection queries', - 'default' => '', - 'required' => true, - ], - ]; + public const OUTPUT_VISIBLE = 'visible'; + public const OUTPUT_COMMENTED = 'commented'; + public const OUTPUT_HIDDEN = 'hidden'; /** * Array to store registered environment variables with details. * - * @var array + * @var array */ private array $variables; @@ -70,28 +47,330 @@ public function __construct() { /** * Filters the list of environment variables recognized by SnapWP. * - * @param array $variables The default environment variables, keyed by name. + * @param array $variables The default environment variables, keyed by name. */ - $this->variables = (array) apply_filters( 'snapwp_helper/env/variables', self::VARIABLES ); + $this->variables = (array) apply_filters( 'snapwp_helper/env/variables', self::get_default_variables() ); } /** - * Gets the value of a registered variable. + * Get the default environment variables. * - * @param string $name The name of the variable to retrieve. - * - * @return ?array{description:string,default:string,required:bool} The details of the variable or null if not found. + * @return array The default environment variables. */ - public function get_variable_config( string $name ) { - return $this->variables[ $name ] ?? null; + private static function get_default_variables(): array { + return [ + 'NODE_TLS_REJECT_UNAUTHORIZED' => [ + 'description' => 'Enable if connecting to a self-signed cert.', + 'default' => '0', + 'outputMode' => self::OUTPUT_VISIBLE, + 'required' => true, + 'value' => static function ( self $registry ): string { + $frontend_url = $registry->get_value( 'NEXT_PUBLIC_FRONTEND_URL' ); + + // If the frontend is https, enable the flag. + return strpos( $frontend_url, 'https://' ) === 0 ? '1' : '0'; + }, + ], + 'NEXT_PUBLIC_FRONTEND_URL' => [ + 'description' => 'The URL of the Next.js "headless" frontend.', + 'default' => 'http://localhost:3000', + 'outputMode' => self::OUTPUT_VISIBLE, + 'required' => true, + 'value' => 'http://localhost:3000', // @todo Allow this to be stored and reused. + ], + 'NEXT_PUBLIC_WP_HOME_URL' => [ + 'description' => 'The traditional WordPress frontend domain URL. E.g. https://my-headless-site.local', + 'default' => null, + 'outputMode' => self::OUTPUT_VISIBLE, + 'required' => true, + 'value' => static fn (): string => untrailingslashit( get_home_url() ), + ], + 'NEXT_PUBLIC_WP_SITE_URL' => [ + 'description' => 'The WordPress "backend" Site Address. Uncomment if different than `NEXT_PUBLIC_WP_HOME_URL`. E.g. https://my-headless-site.local/wp/', + 'default' => null, + 'outputMode' => static function ( self $registry ): string { + $home_url = $registry->get_value( 'NEXT_PUBLIC_WP_HOME_URL' ); + $value = $registry->get_value( 'NEXT_PUBLIC_WP_SITE_URL' ); + + // If the value is the same as the home URL, hide it. + return $value === $home_url ? self::OUTPUT_HIDDEN : self::OUTPUT_VISIBLE; + }, + 'required' => static fn ( self $registry ): bool => $registry->get_value( 'NEXT_PUBLIC_WP_HOME_URL' ) !== $registry->get_value( 'NEXT_PUBLIC_WP_SITE_URL' ), + 'value' => static fn (): string => untrailingslashit( get_site_url() ), + ], + 'NEXT_PUBLIC_GRAPHQL_ENDPOINT' => [ + 'description' => 'The WordPress GraphQL endpoint.', + 'default' => 'index.php?graphql', + 'outputMode' => self::OUTPUT_VISIBLE, + 'required' => true, + 'value' => static fn (): ?string => function_exists( 'graphql_get_endpoint' ) ? graphql_get_endpoint() : null, + ], + 'NEXT_PUBLIC_REST_URL_PREFIX' => [ + 'description' => 'The WordPress REST API URL prefix.', + 'default' => '/wp-json', + 'outputMode' => static fn ( self $registry ): string => $registry->hide_if_default( 'NEXT_PUBLIC_REST_URL_PREFIX' ), + 'required' => static fn ( self $registry ): bool => $registry->require_if_not_default( 'NEXT_PUBLIC_REST_URL_PREFIX' ), + 'value' => static fn (): string => '/' . rest_get_url_prefix(), + ], + 'NEXT_PUBLIC_WP_UPLOADS_DIRECTORY' => [ + 'description' => 'The relative path to the WordPress uploads directory.', + 'default' => '/wp-content/uploads', + 'outputMode' => static fn ( self $registry ): string => $registry->hide_if_default( 'NEXT_PUBLIC_WP_UPLOADS_DIRECTORY' ), + 'required' => static fn ( self $registry ): bool => $registry->require_if_not_default( 'NEXT_PUBLIC_WP_UPLOADS_DIRECTORY' ), + 'value' => static function (): string { + $upload_dir = wp_get_upload_dir(); + return '/' . ltrim( str_replace( ABSPATH, '', $upload_dir['basedir'] ), '/' ); + }, + ], + 'NEXT_PUBLIC_CORS_PROXY_PREFIX' => [ + 'description' => 'The CORS proxy prefix to use when bypassing CORS restrictions from WordPress server. If unset, no proxy will be used.', + 'default' => '/proxy', + 'outputMode' => self::OUTPUT_COMMENTED, + 'required' => false, + 'value' => '', + ], + 'INTROSPECTION_TOKEN' => [ + 'description' => 'Token used for authenticating GraphQL introspection queries.', + 'default' => null, + 'outputMode' => self::OUTPUT_VISIBLE, + 'required' => true, + 'value' => static function () { + $token = IntrospectionToken::get_token(); + + return is_wp_error( $token ) ? null : $token; + }, + ], + ]; } /** * Retrieve all registered environment variables with their details. * - * @return array> An associative array with all registered variables and their details. + * @return array An associative array with all registered variables and their details. */ public function get_all_variable_configs(): array { return $this->variables; } + + /** + * Gets the configuration of a registered variable. + * + * @param string $name The name of the variable to retrieve. + * + * @return ?VariableConfig The configuration of the variable, or null if not found. + */ + public function get_variable_config( string $name ): ?array { + return $this->get_all_variable_configs()[ $name ] ?? null; + } + + /** + * Gets the default value for a variable, evaluating callbacks if necessary. + * + * @param string $name The name of the variable. + */ + public function get_default_value( string $name ): ?string { + $config = $this->get_variable_config( $name ); + if ( null === $config || ! isset( $config['default'] ) ) { + return null; + } + + $default = $config['default']; + + if ( is_callable( $default ) ) { + try { + // Compute the default value. + $default = $default( $this ); + + // Update the config to store the computed value. + $this->variables[ $name ]['default'] = $default; + } catch ( \Throwable $e ) { + return null; + } + } + + // All values are output as strings. + return isset( $default ) ? (string) $default : null; + } + + /** + * Gets the dynamic value for a variable, evaluating callbacks if necessary. + * Does not consider provided values, only the registry's configuration. + * + * @param string $name The name of the variable. + */ + public function get_computed_value( string $name ): ?string { + $config = $this->get_variable_config( $name ); + if ( null === $config ) { + return null; + } + + // Check if we already computed and cached this value. + if ( isset( $config['computed_value'] ) ) { + return $config['computed_value']; + } + + // If no value is set, return default. + if ( ! isset( $config['value'] ) ) { + return null; + } + + $value = $config['value']; + + if ( is_callable( $value ) ) { + try { + // Compute the value. + $value = $value( $this ); + } catch ( \Throwable $e ) { + return null; + } + } + + // Update the config to store the computed value. + if ( null !== $value ) { + // Store the computed result so we don't have to recalculate. + $this->variables[ $name ]['computed_value'] = (string) $value; + } + + // All values are output as strings. + return isset( $value ) ? (string) $value : null; + } + + /** + * Gets the final value for a variable, considering provided value, computed value, and default. + * + * @param string $name The name of the variable. + */ + public function get_value( string $name ): string { + // Try the computed value from the system information. + $computed_value = $this->get_computed_value( $name ); + + // Fallback to default if needed. + return isset( $computed_value ) ? (string) $computed_value : (string) $this->get_default_value( $name ); + } + + /** + * Determines if a variable is required. + * + * @param string $name The name of the variable. + */ + public function get_is_required( string $name ): bool { + $config = $this->get_variable_config( $name ); + + // Default to false if not set. + if ( null === $config ) { + return false; + } + + // If no required setting, use legacy behavior. + if ( ! isset( $config['required'] ) ) { + return false; + } + + $required = $config['required']; + if ( is_callable( $required ) ) { + try { + $required = $required( $this ); + // Update the config to store the computed value. + $this->variables[ $name ]['required'] = $required; + } catch ( \Throwable $e ) { + return false; + } + } + + return (bool) $required; + } + + /** + * Determines the output mode for a variable. + * + * @param string $name The name of the variable. + * + * @return AllowedOutputMode + */ + public function get_output_mode( string $name ): string { + $config = $this->get_variable_config( $name ); + + // Default to visible if not set. + if ( null === $config ) { + return self::OUTPUT_VISIBLE; + } + + // Check for the outputMode property according to the schema. + if ( isset( $config['outputMode'] ) ) { + $output = $config['outputMode']; + if ( is_callable( $output ) ) { + try { + $output = $output( $this ); + // Update the config to store the computed value. + $this->variables[ $name ]['outputMode'] = $output; + } catch ( \Throwable $e ) { + // Fallback to visible on error. + return self::OUTPUT_VISIBLE; + } + } + return $output; + } + + // If no output setting, use default behavior. + $default = $this->get_default_value( $name ); + $value = $this->get_value( $name ); + $required = $this->get_is_required( $name ); + + // If the value is the same as the default and not required, comment it. + return ( ! $required && $value === $default ) ? self::OUTPUT_COMMENTED : self::OUTPUT_VISIBLE; + } + + /** + * Get all variable values. + * + * @return array The resolved values for all variables. + */ + public function get_all_values(): array { + $values = []; + + foreach ( array_keys( $this->get_all_variable_configs() ) as $name ) { + $values[ $name ] = $this->get_value( $name ); + } + + return $values; + } + + /** + * Check if a variable is using its default value. + * + * @param string $name The name of the variable. + */ + public function is_using_default_value( string $name ): bool { + $config = $this->get_variable_config( $name ); + + // If there's no configuration or no default, it can't be using default. + if ( null === $config || ! isset( $config['default'] ) ) { + return false; + } + + $value = $this->get_computed_value( $name ); + $default = $this->get_default_value( $name ); + + return $value === $default; + } + + /** + * Callback to set the display mode to hidden for variables that are not required and their value matches the default. + * + * @param string $variable The name of the variable. + * + * @return 'visible'|'hidden' The output mode. + */ + private function hide_if_default( string $variable ): string { + return $this->is_using_default_value( $variable ) ? self::OUTPUT_HIDDEN : self::OUTPUT_VISIBLE; + } + + /** + * Callback to set the required status if the value is different from the default. + * + * @param string $variable The name of the variable. + */ + private function require_if_not_default( string $variable ): bool { + return ! $this->is_using_default_value( $variable ); + } } diff --git a/tests/Integration/GeneratorTest.php b/tests/Integration/GeneratorTest.php index f4c7f49..ca54cd1 100644 --- a/tests/Integration/GeneratorTest.php +++ b/tests/Integration/GeneratorTest.php @@ -1,149 +1,175 @@ '', - 'NEXT_PUBLIC_URL' => 'http://localhost:3000', - 'NEXT_PUBLIC_WORDPRESS_URL' => 'https://headless-demo.local', - 'NEXT_PUBLIC_GRAPHQL_ENDPOINT' => '', - 'NEXT_PUBLIC_WORDPRESS_UPLOADS_PATH' => '', - 'NEXT_PUBLIC_WORDPRESS_REST_URL_PREFIX' => '', - ]; - - $generator = new Generator( $values, $registry ); + $registry = new VariableRegistry(); + $generator = new Generator( $registry ); $this->assertInstanceOf( Generator::class, $generator ); } /** - * Tests if the Generator generates the correct formatt .ENV content. + * Tests if the Generator generates the correctly formatted .ENV content. */ public function testGenerateEnvContent(): void { + // Create a custom VariableRegistry with test variables. $registry = new VariableRegistry(); - $values = [ - 'NODE_TLS_REJECT_UNAUTHORIZED' => '5', - 'NEXT_PUBLIC_URL' => 'http://localhost:3000', - 'NEXT_PUBLIC_WORDPRESS_URL' => 'https://headless-demo.local', - 'NEXT_PUBLIC_GRAPHQL_ENDPOINT' => '/test_endpoint', - 'NEXT_PUBLIC_WORDPRESS_UPLOADS_PATH' => 'uploads', - 'NEXT_PUBLIC_WORDPRESS_REST_URL_PREFIX' => 'api', - 'INVALID_VARIABLE' => 'should-not-be-included', // This should not be included in the output. - ]; - - $generator = new Generator( $values, $registry ); - - // Generate the .env content. - $content = $generator->generate(); - - $expectedContent = ' -# Only enable if connecting to a self-signed cert -NODE_TLS_REJECT_UNAUTHORIZED=5 - -# The headless frontend domain URL. Make sure the value matches the URL used by your frontend app. -NEXT_PUBLIC_URL=http://localhost:3000 -# The WordPress "frontend" domain URL -NEXT_PUBLIC_WORDPRESS_URL=https://headless-demo.local - -# The WordPress GraphQL endpoint -NEXT_PUBLIC_GRAPHQL_ENDPOINT=/test_endpoint - -# The WordPress Uploads directory path -NEXT_PUBLIC_WORDPRESS_UPLOADS_PATH=uploads - -# The WordPress REST URL Prefix -NEXT_PUBLIC_WORDPRESS_REST_URL_PREFIX=api'; - - $this->assertSame( $expectedContent, $content ); + // Use reflection to modify the private variables property. + $reflection = new ReflectionClass( $registry ); + $variables_prop = $reflection->getProperty( 'variables' ); + $variables_prop->setAccessible( true ); + + // Get current variables to modify them. + $variables = $variables_prop->getValue( $registry ); + + // Set specific test values. + $variables['NODE_TLS_REJECT_UNAUTHORIZED']['value'] = '5'; + $variables['NEXT_PUBLIC_FRONTEND_URL']['value'] = 'http://localhost:3000'; + $variables['NEXT_PUBLIC_WP_HOME_URL']['value'] = 'https://headless-demo.local'; + $variables['NEXT_PUBLIC_GRAPHQL_ENDPOINT']['value'] = '/test_endpoint'; + $variables['NEXT_PUBLIC_WP_UPLOADS_DIRECTORY']['value'] = 'uploads'; + $variables['NEXT_PUBLIC_REST_URL_PREFIX']['value'] = 'api'; + $variables['INTROSPECTION_TOKEN']['value'] = '0123456789'; + + // Update the registry. + $variables_prop->setValue( $registry, $variables ); + + // Create generator with our modified registry. + $generator = new Generator( $registry ); + $content = $generator->generate(); + + // Ensure content is generated. + $this->assertNotNull( $content ); + $this->assertIsString( $content ); + + // Check for expected values. + $this->assertStringContainsString( 'NODE_TLS_REJECT_UNAUTHORIZED=5', $content ); + $this->assertStringContainsString( 'NEXT_PUBLIC_FRONTEND_URL=http://localhost:3000', $content ); + $this->assertStringContainsString( 'NEXT_PUBLIC_WP_HOME_URL=https://headless-demo.local', $content ); + $this->assertStringContainsString( 'NEXT_PUBLIC_GRAPHQL_ENDPOINT=/test_endpoint', $content ); + $this->assertStringContainsString( 'INTROSPECTION_TOKEN=0123456789', $content ); } /** * Tests if the Generator class throws correct error when missing required values. */ public function testMissingRequiredValuesEnvContent(): void { + // Create registry with a required variable that has no value. $registry = new VariableRegistry(); - $values = [ - 'NODE_TLS_REJECT_UNAUTHORIZED' => '', - 'NEXT_PUBLIC_URL' => '', - 'NEXT_PUBLIC_WORDPRESS_URL' => '', - 'NEXT_PUBLIC_GRAPHQL_ENDPOINT' => '', - 'NEXT_PUBLIC_WORDPRESS_UPLOADS_PATH' => '', - 'NEXT_PUBLIC_WORDPRESS_REST_URL_PREFIX' => '', + + // Use reflection to modify the private variables property. + $reflection = new ReflectionClass( $registry ); + $variables_prop = $reflection->getProperty( 'variables' ); + $variables_prop->setAccessible( true ); + + // Create a test variable that is required but has no value. + $variables = [ + 'TEST_REQUIRED_VAR' => [ + 'description' => 'Required variable that must have a value', + 'default' => null, + 'outputMode' => VariableRegistry::OUTPUT_VISIBLE, + 'required' => true, + 'value' => '', // Empty value should trigger the exception + ], ]; - $generator = new Generator( $values, $registry ); + // Set the variables. + $variables_prop->setValue( $registry, $variables ); + + $generator = new Generator( $registry ); // Expect an exception when calling generate() because of missing required values. $this->expectException( \InvalidArgumentException::class ); - $this->expectExceptionMessage( 'Required variables must have a value.' ); - - // Generate the .env content, which should throw an exception. $generator->generate(); } /** - * Tests if the Generator class handles missing values using the defaults. + * Tests if the Generator class handles commented-out variables correctly. */ public function testDefaultValuesForEnvContent(): void { + // Create registry with variables that should be commented out. $registry = new VariableRegistry(); - // CASE : For NODE_TLS_REJECT_UNAUTHORIZED with no default value, Generator class should comment out the variable in .ENV content. - $values = [ - 'NODE_TLS_REJECT_UNAUTHORIZED' => '0', - 'NEXT_PUBLIC_URL' => 'http://localhost:3000', - 'NEXT_PUBLIC_WORDPRESS_URL' => 'https://headless-demo.local', - 'NEXT_PUBLIC_GRAPHQL_ENDPOINT' => '/test_endpoint', - 'NEXT_PUBLIC_WORDPRESS_UPLOADS_PATH' => '', - 'NEXT_PUBLIC_WORDPRESS_REST_URL_PREFIX' => '', + // Use reflection to modify the private variables property. + $reflection = new ReflectionClass( $registry ); + $variables_prop = $reflection->getProperty( 'variables' ); + $variables_prop->setAccessible( true ); + + // Create test variables. + $variables = [ + 'NODE_TLS_REJECT_UNAUTHORIZED' => [ + 'description' => 'Only enable if connecting to a self-signed cert', + 'default' => '0', + 'outputMode' => VariableRegistry::OUTPUT_VISIBLE, + 'required' => true, + 'value' => '0', + ], + 'NEXT_PUBLIC_FRONTEND_URL' => [ + 'description' => 'The headless frontend domain URL', + 'default' => 'http://localhost:3000', + 'outputMode' => VariableRegistry::OUTPUT_VISIBLE, + 'required' => true, + 'value' => 'http://localhost:3000', + ], + 'NEXT_PUBLIC_CORS_PROXY_PREFIX' => [ + 'description' => 'The CORS proxy prefix', + 'default' => '/proxy', + 'outputMode' => VariableRegistry::OUTPUT_COMMENTED, + 'required' => false, + 'value' => '', // Empty value should show default in commented output. + ], + 'NEXT_PUBLIC_REST_URL_PREFIX' => [ + 'description' => 'The WordPress REST URL Prefix', + 'default' => '/wp-json', + 'outputMode' => VariableRegistry::OUTPUT_COMMENTED, + 'required' => false, + 'value' => '', // Empty value should show default in commented output. + ], + 'NEXT_PUBLIC_WP_UPLOADS_DIRECTORY' => [ + 'description' => 'The WordPress Uploads directory path', + 'default' => '/wp-content/uploads', + 'outputMode' => VariableRegistry::OUTPUT_COMMENTED, + 'required' => false, + 'value' => '', // Empty value should show default in commented output. + ], ]; - $generator = new Generator( $values, $registry ); - - // Generate the .env content. - $content = $generator->generate(); - - // Define expected content. - $expectedContent = ' -# Only enable if connecting to a self-signed cert -NODE_TLS_REJECT_UNAUTHORIZED=0 - -# The headless frontend domain URL. Make sure the value matches the URL used by your frontend app. -NEXT_PUBLIC_URL=http://localhost:3000 - -# The WordPress "frontend" domain URL -NEXT_PUBLIC_WORDPRESS_URL=https://headless-demo.local + // Set the variables. + $variables_prop->setValue( $registry, $variables ); -# The WordPress GraphQL endpoint -NEXT_PUBLIC_GRAPHQL_ENDPOINT=/test_endpoint + $generator = new Generator( $registry ); + $content = $generator->generate(); -# The WordPress Uploads directory path -# NEXT_PUBLIC_WORDPRESS_UPLOADS_PATH=/wp-content/uploads + // Ensure content is generated. + $this->assertNotNull( $content ); + $this->assertIsString( $content ); -# The WordPress REST URL Prefix -# NEXT_PUBLIC_WORDPRESS_REST_URL_PREFIX=/wp-json'; + // Check for standard values. + $this->assertStringContainsString( 'NODE_TLS_REJECT_UNAUTHORIZED=0', $content ); + $this->assertStringContainsString( 'NEXT_PUBLIC_FRONTEND_URL=http://localhost:3000', $content ); - $this->assertSame( $expectedContent, $content ); + // Check that commented variables use their default values. + $this->assertStringContainsString( '# NEXT_PUBLIC_CORS_PROXY_PREFIX=/proxy', $content ); + $this->assertStringContainsString( '# NEXT_PUBLIC_REST_URL_PREFIX=/wp-json', $content ); + $this->assertStringContainsString( '# NEXT_PUBLIC_WP_UPLOADS_DIRECTORY=/wp-content/uploads', $content ); } } diff --git a/tests/Integration/RestControllerTest.php b/tests/Integration/RestControllerTest.php index 5372a74..fba3993 100644 --- a/tests/Integration/RestControllerTest.php +++ b/tests/Integration/RestControllerTest.php @@ -73,7 +73,6 @@ public function testRegisterRoutes(): void { * Assuming standard default values. */ public function testGenerateEnvEndpoint(): void { - $admin_id = $this->factory()->user->create( [ 'role' => 'administrator' ] ); // Create a new POST request to the REST endpoint. @@ -84,18 +83,30 @@ public function testGenerateEnvEndpoint(): void { // Set the current user as administrator. wp_set_current_user( $admin_id ); - $actual = $this->server->dispatch( $request ); - $this->assertInstanceOf( \WP_REST_Response::class, $actual ); - $this->assertEquals( 200, $actual->get_status() ); + $response = $this->server->dispatch( $request ); + $this->assertInstanceOf( \WP_REST_Response::class, $response ); + $this->assertEquals( 200, $response->get_status() ); + + $response_data = $response->get_data(); + $this->assertNotEmpty( $response_data['content'] ); + + $content = $response_data['content']; + + // Check for required variables + $this->assertStringContainsString( 'NODE_TLS_REJECT_UNAUTHORIZED=', $content ); + $this->assertStringContainsString( 'NEXT_PUBLIC_FRONTEND_URL=http://localhost:3000', $content ); + $this->assertStringContainsString( 'NEXT_PUBLIC_WP_HOME_URL=' . untrailingslashit( get_home_url() ), $content ); - $actual_data = $actual->get_data(); + // Check if GraphQL endpoint is present + $graphql_endpoint = function_exists( 'graphql_get_endpoint' ) ? graphql_get_endpoint() : 'graphql'; + $this->assertStringContainsString( 'NEXT_PUBLIC_GRAPHQL_ENDPOINT=' . $graphql_endpoint, $content ); - $this->assertNotEmpty( $actual_data['content'] ); - $search = '\n'; - $replace = ''; - $expected = "\n# Only enable if connecting to a self-signed cert\nNODE_TLS_REJECT_UNAUTHORIZED=0\n\n# The headless frontend domain URL. Make sure the value matches the URL used by your frontend app.\nNEXT_PUBLIC_URL=http://localhost:3000\n\n# The WordPress \"frontend\" domain URL\nNEXT_PUBLIC_WORDPRESS_URL=" . get_home_url() . "\n\n# The WordPress GraphQL endpoint\nNEXT_PUBLIC_GRAPHQL_ENDPOINT=" . graphql_get_endpoint() . "\n\n# The WordPress Uploads directory path\n# NEXT_PUBLIC_WORDPRESS_UPLOADS_PATH=/" . str_replace( ABSPATH, '', wp_get_upload_dir()['basedir'] ) . "\n\n# The WordPress REST URL Prefix\n# NEXT_PUBLIC_WORDPRESS_REST_URL_PREFIX=/" . rest_get_url_prefix() . "\n\n# Token used for authenticating GraphQL introspection queries\nINTROSPECTION_TOKEN=" . IntrospectionToken::get_token(); + // Check for introspection token + $token = IntrospectionToken::get_token(); + $this->assertStringContainsString( 'INTROSPECTION_TOKEN=' . $token, $content ); - $this->assertEquals( $expected, str_replace( $search, $replace, $actual_data['content'] ) ); + // Check commented variable format + $this->assertStringContainsString( '# NEXT_PUBLIC_CORS_PROXY_PREFIX=/proxy', $content ); // Clean up. wp_delete_user( $admin_id, true );