feat: Validate GQL query before theme push

lib/stencil-push.js

@@ -8,6 +8,7 @@ function stencilPush(options = {}, callback) {
             utils.readStencilConfigFile,
             utils.getStoreHash,
             utils.getThemes,
+            utils.validateGqlQueries,
             utils.generateBundle,
             utils.uploadBundle,
             utils.notifyUserOfThemeLimitReachedIfNecessary,

lib/stencil-push.utils.js

@@ -5,6 +5,9 @@ const ProgressBar = require('progress');
 const uuid = require('uuid4');
 const os = require('os');
 
+const fs = require('fs');
+const path = require('path');
+const { parse } = require('graphql/index');
 const { THEME_PATH } = require('../constants');
 const Bundle = require('./stencil-bundle');
 const themeApiClient = require('./theme-api-client');
@@ -518,4 +521,61 @@ utils.notifyUserOfCompletion = (options, callback) => {
     callback(null, `Stencil Push Finished. Variation ID: ${options.variationId}`);
 };
 
+function validateQuery(query) {
+    try {
+        parse(query);
+        return true;
+    } catch (error) {
+        console.error('Error parsing GraphQL query:', error);
+        return false;
+    }
+}
+
+const gqlAssetDir = path.join(process.cwd(), 'assets', 'js');
+
+const gqlRegex = /^(query|mutation)\s+([a-zA-Z]+|\{)/;
+const stringLiteralRegex = /(['"`])(\\?.)*?\1|(`(?:\\.|[^`])*`)/g;
+
+utils.validateGqlQueries = async (options) => {
+    let invalidQueriesFound = false;
+
+    function scanFiles(dir) {
+        fs.readdirSync(dir).forEach((file) => {
+            const filePath = path.join(dir, file);
+
+            // If it's a directory, scan recursively
+            if (fs.lstatSync(filePath).isDirectory()) {
+                scanFiles(filePath);
+            } else if (path.extname(file) === '.js' && !filePath.includes('test')) {
+                const content = fs.readFileSync(filePath, 'utf8');
+
+                const stringLiterals = content.match(stringLiteralRegex);
+
+                if (stringLiterals) {
+                    stringLiterals.forEach((stringLiteral) => {
+                        // Remove surrounding quotes or backticks for further processing
+                        const cleanedString = stringLiteral.slice(1, -1);
+
+                        const matches = cleanedString.match(gqlRegex);
+                        if (matches) {
+                            if (!validateQuery(cleanedString)) {
+                                console.error(`Invalid GraphQL query found in file: ${filePath}`);
+                                invalidQueriesFound = true;
+                            }
+                        }
+                    });
+                }
+            }
+        });
+    }
+
+    scanFiles(gqlAssetDir);
+
+    if (invalidQueriesFound) {
+        throw new Error('GraphQL query validation failed. Fix it before proceeding.');
+    }
+
+    return options;
+};
+
 module.exports = utils;

package.json

@@ -69,6 +69,7 @@
     "front-matter": "^4.0.2",
     "glob": "^7.1.6",
     "graceful-fs": "^4.2.4",
+    "graphql": "^16.9.0",
     "husky": "^8.0.1",
     "image-size": "^0.9.1",
     "inquirer": "^8.1.5",