[PWA-1119] UPWARD Path Config (#7)

* Flag config as sensitive and environment specific

* Fix whitespace

* Add docs for changes

Author: tjwiebell

README.md

@@ -11,20 +11,23 @@ The Magento 2 UPWARD connector module is part of the [Magento Cloud deployment][
 
 ## Configuration
 
-The Magento 2 UPWARD connector is configured in the admin area under:
+The Magento 2 UPWARD connector has additional settings that can be configured in the admin area under:
 
 **Stores > Configuration > General > Web > UPWARD PWA Configuration**.
 
 ### General configuration
 
 These are the configurations for the UPWARD process itself.
+
 #### UPWARD Config File
 
 This configuration is the location of the UPWARD configuration file for the UPWARD-PHP server.
+It is recommended you follow [system-specific best practices][] and set this value with an environment variable or the `magento config:set` CLI command.
 
-_Use the absolute path on the server for the value of this configuration._
+_You may use a path relative to your web root or an absolute path for the value of this configuration._
 
-Example: `/app/node_modules/@magento/venia-concept/dist/upward.yml`
+Relative: `fastcgi_param CONFIG__DEFAULT__WEB__UPWARD__PATH pwa/upward.yml`
+Absolute: `magento config:set -e web/upward/path /app/node_modules/@magento/venia-concept/dist/upward.yml`
 
 #### Front Name Allowlist
 
@@ -61,7 +64,7 @@ If a page is not configured for prerendering, the request continues using the no
 To see how a crawler sees a prerendered page, set your browser's User Agent to `Googlebot` and visit your URL.
 You can also run this on the command line and change the sample URL to your storefront's URL:
 
-``` sh
+```sh
 curl -A Googlebot https://www.example.com/ > page.html
 ```
 
@@ -74,9 +77,11 @@ For prerendering it is possible to force prerender to wait for a predefined time
 
 Add the following to the runtime script:
 
-``` js
+```js
 window.prerenderReady = false;
-setTimeout(function () { window.prerenderReady = true }, 1000 * 15)
+setTimeout(function () {
+  window.prerenderReady = true;
+}, 1000 * 15);
 ```
 
 For more information, see https://docs.prerender.io/test-it/.
@@ -90,3 +95,4 @@ If you cannot avoid sharing the hostname, access one service at a time or use a
 [upward-php]: https://github.com/magento/upward-php
 [magento cloud deployment]: http://pwastudio.io/tutorials/cloud-deploy/
 [prerender.io]: https://docs.prerender.io/
+[system-specific best practices]: https://devdocs.magento.com/guides/v2.4/config-guide/prod/config-reference-var-name.html

composer.json

@@ -8,6 +8,7 @@
         "php": "~7.3.0||~7.4.0",
         "magento/framework": "*",
         "magento/upward": "*",
+        "magento/module-config": "*",
         "magento/module-store": "*",
         "yireo/magento2-disable-service-worker-in-admin": "^0.0.2"
     },

etc/adminhtml/system.xml

@@ -12,12 +12,7 @@
             <group id="upward" translate="label" type="text" sortOrder="300"
                 showInDefault="1" showInWebsite="0" showInStore="0">
                 <label>UPWARD PWA Configuration</label>
-                <field id="config_path" type="text" translate="label,comment"
-                    sortOrder="20" showInDefault="1" showInWebsite="0" showInStore="0">
-                    <label>UPWARD Config File</label>
-                    <config_path>web/upward/path</config_path>
-                    <comment>Server path to YAML configuration file for UPWARD</comment>
-                </field>
+                <field id="path" type="text" showInDefault="0" showInWebsite="0" showInStore="0" />
                 <field id="front_names_to_skip" canRestore="1" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="30" translate="label,comment" type="textarea">
                     <label>Front Name Allowlist</label>
                     <comment>Line break separated list of URL's that will load the default Magento frontend.</comment>

etc/di.xml

@@ -17,4 +17,11 @@
         </arguments>
         <plugin name="upward_connector_app_areaList" sortOrder="10" type="Magento\UpwardConnector\Plugin\Magento\Framework\App\AreaList" />
     </type>
+    <type name="Magento\Config\Model\Config\TypePool">
+        <arguments>
+            <argument name="environment" xsi:type="array">
+                <item name="web/upward/path" xsi:type="string">1</item>
+            </argument>
+        </arguments>
+    </type>
 </config>