Merge pull request #59 from firstlookmedia/fix-pq-env-stuff

edit persisted queries checks

Author: tomconroy

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 90
+}

README.md

@@ -59,16 +59,11 @@ To install on OSX `brew bundle` in this directory.
 
 ## Persisted queries
 
-By default, sites will not persist static queries. To enable persisted queries:
+To enable persisted queries:
 
-1. add `PERSIST_QUERIES: "true"` to all build circle configs
-2. add `QUERIES_S3_BUCKET` property to all build and deploy circle configs and point it to the s3 bucket where the site's queries live
-3. upgrade to the newest version of React scripts that has the `get` and `post` fetcher methods
-4. install our forked version of relay compiler: https://github.com/firstlookmedia/relay contains the .tar.gz of the compiler and you refer to it like so in the `package.json`: https://github.com/firstlookmedia/relay/releases/download/v1.5.0-flm.1/relay-compiler-1.5.0-flm.1.tar.gz
+1. Add `PERSIST_QUERIES: "true"` in the build and runtime environments
+2. Point `QUERIES_S3_BUCKET` to an s3 bucket during build time to deploy queries, making them accessible to the graphql backend
+3. Upgrade to the newest version of React scripts that has the `GET` and `POST` fetcher methods
+4. Upgrade to relay >= 3.0
 
 Note: persisted queries are always turned off during local development.
-
-### relay compiler
-
-We are using a forked version of relay similar to what the artsy folks are doing. Hopefully, this fork will get merged into relay proper, at which point we won't need to do anything special to get persisted static queries to work. Until then, we will need to stick to relay version `1.5.0` and if we do need to upgrade we'll have to update our fork, rebuild the compiler, and release it. The artsy folks and others have done an excellent job of keeping this fork up to date with subsequent relay releases, so this should not pose much a problem. In fact, it would be great for us to help with merging upstream relay releases into the PR version on the relay repository if necessary.
-

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firstlookmedia/react-scripts",
-  "version": "2.0.0-rc6",
+  "version": "2.0.0-rc10",
   "description": "shared react site configs",
   "author": "First Look Media",
   "license": "MIT",

scripts/build.js

@@ -1,4 +1,3 @@
-
 process.env.NODE_ENV = 'production';
 
 const webpack = require('webpack');
@@ -70,7 +69,7 @@ relayCompiler.on('close', (code) => {
     console.log();
     console.log('Building server files...');
     webpack(serverConfig).run(handler.bind(null, serverConfig));
-    if (process.env.PERSIST_QUERIES) {
+    if (process.env.PERSIST_QUERIES === 'true') {
       buildPersistedQueries();
     }
   });

scripts/upload-queries.js

@@ -7,6 +7,7 @@ const mime = require('mime');
 
 const s3 = new AWS.S3({ apiVersion: '2006-03-01' });
 const queriesBucket = process.env.QUERIES_S3_BUCKET;
+const persist = process.env.PERSIST_QUERIES === 'true';
 const uploadParams = {
   Bucket: queriesBucket,
   Key: '',
@@ -17,12 +18,19 @@ const uploadParams = {
 };
 const baseDir = './build/queries';
 
+if (!persist) {
+  console.error('Persist queries turned off. Exiting.');
+  process.exit(0);
+}
+
 if (!queriesBucket) {
   console.error('QUERIES_S3_BUCKET is empty. Exiting.');
   process.exit(1);
 }
 
 fs.readdir(baseDir, (err, files) => {
+  if (!files || files.length < 1) return;
+
   files.forEach((file) => {
     const fileStream = fs.createReadStream(path.join(baseDir, file));
     fileStream.on('error', (err) => {

scripts/utils/relayCompilerArguments.js

@@ -34,9 +34,9 @@ module.exports = [
   'src/__generated__',
 
   // FIXME: relay fork persist queries flag, remove when no projects use the fork
-  process.env.PERSIST_QUERIES ? '--persist' : '',
+  process.env.PERSIST_QUERIES === 'true' ? '--persist' : '',
 
   // relay v2+ persist queries flag
-  process.env.PERSIST_QUERIES ? '--persist-output' : '',
-  process.env.PERSIST_QUERIES ? './complete.queryMap.json' : '',
+  process.env.PERSIST_QUERIES === 'true' ? '--persist-output' : '',
+  process.env.PERSIST_QUERIES === 'true' ? './complete.queryMap.json' : '',
 ].reduce((acc, item) => acc.concat(item), []);

template/src/fetcher.js

@@ -46,7 +46,7 @@ class FetcherBase {
 
 export class ServerFetcher extends FetcherBase {
   constructor(url) {
-    const isStaticQueries = process.env.PERSIST_QUERIES;
+    const isStaticQueries = process.env.PERSIST_QUERIES === 'true';
     super(url, isStaticQueries);
 
     this.payloads = [];
@@ -67,7 +67,7 @@ export class ServerFetcher extends FetcherBase {
 
 export class ClientFetcher extends FetcherBase {
   constructor(url, payloads) {
-    const isStaticQueries = envConfig.PERSIST_QUERIES;
+    const isStaticQueries = envConfig.PERSIST_QUERIES === 'true';
     super(url, isStaticQueries);
 
     this.payloads = payloads;