@adobe-commerce/elsie 1.4.0-alpha2 → 1.4.0-beta2

package/bin/builders/gql/index.js

@@ -1,6 +1,7 @@
 const path = require('path');
 const createOrClearDirectory = require('./createOrClearDirectory');
 const getSchemaRef = require('./getSchemaRef');
+const validate = require('./validate');
 require('dotenv').config();
 
 const generate = require('@graphql-codegen/cli').generate;
@@ -67,5 +68,30 @@ module.exports = async function generateResourceBuilder(yargs) {
         },
       });
     })
-    .demandCommand(1, 1, 'choose a command: types or mocks');
+    .command(
+        'validate',
+        'Validate GraphQL operations',
+        async (yargs) => {
+            return yargs
+                .option('source', {
+                    alias: 's',
+                    describe: 'Path to the source code containing GraphQL operations',
+                    type: 'array',
+                    string: true,
+                    demandOption: true,
+                })
+                .option('endpoints', {
+                    alias: 'e',
+                    describe: 'Path to GraphQL endpoints',
+                    type: 'array',
+                    string: true,
+                    demandOption: true,
+                });
+        },
+        async (argv) => {
+            const { source, endpoints } = argv;
+            await validate(source, endpoints);
+        },
+    )
+    .demandCommand(1, 1, 'choose a command: types, mocks or validate');
 };

package/bin/builders/gql/validate.js

@@ -0,0 +1,135 @@
+#!/usr/bin/env node
+const fsPromises = require('node:fs/promises');
+const path = require('node:path');
+const parser = require('@babel/parser');
+const traverse = require('@babel/traverse');
+const { getIntrospectionQuery, buildClientSchema, parse, validate } = require('graphql');
+
+async function walk(dir, collected = []) {
+    const dirents = await fsPromises.readdir(dir, { withFileTypes: true });
+
+    for (const d of dirents) {
+        const full = path.resolve(dir, d.name);
+
+        if (d.isDirectory()) {
+            // skip node_modules and “hidden” folders such as .git
+            if (d.name === 'node_modules' || d.name.startsWith('.')) continue;
+            await walk(full, collected);
+        } else if (/\.(c?m?js|ts|tsx)$/.test(d.name)) {
+            collected.push(full);
+        }
+    }
+    return collected;
+}
+
+function extractConstants(code) {
+    const ast = parser.parse(code, {
+        sourceType: 'unambiguous',
+        plugins: [
+            'typescript',
+            'jsx',
+            'classProperties',
+            'objectRestSpread',
+            'dynamicImport',
+            'optionalChaining',
+            'nullishCoalescingOperator',
+        ],
+    });
+    const found = [];
+    traverse.default(ast, {
+        VariableDeclaration(path) {
+            if (path.node.kind !== 'const') return;
+            for (const decl of path.node.declarations) {
+                const { id, init } = decl;
+                if (!init || id.type !== 'Identifier') continue;
+                let text = null;
+                switch (init.type) {
+                    case 'TemplateLiteral': {
+                        // join all raw chunks; ignores embedded ${expr} for simplicity
+                        text = init.quasis.map(q => q.value.cooked).join('');
+                        break;
+                    }
+                    case 'StringLiteral':
+                        text = init.value;
+                        break;
+                }
+                if (text) {
+                    const match = text.match(/\b(query|mutation|fragment)\b/i);
+                    if (match) {
+                        found.push(text.trim());
+                    }
+                }
+            }
+        },
+    });
+
+    return found;
+}
+
+async function fetchSchema(endpoint) {
+    const body = JSON.stringify({ query: getIntrospectionQuery() });
+    const res  = await fetch(endpoint, {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body
+    });
+    if (!res.ok) throw new Error(`Introspection query failed: ${res.statusText}`);
+    const { data, errors } = await res.json();
+    if (errors?.length) throw new Error(`Server returned errors: ${JSON.stringify(errors)}`);
+    return buildClientSchema(data);
+}
+
+async function validateGqlOperations(endpoint, operation) {
+    console.log(`\nValidating against endpoint: ${endpoint}`);
+    try {
+        const document = parse(operation);
+        const errors = validate(await fetchSchema(endpoint), document);
+        if (errors.length) {
+            console.error('❌  Operation is NOT valid for this schema:');
+            errors.forEach(e => console.error('-', e.message));
+            process.exitCode = 1;
+        } else {
+            console.log('✅  Operation is valid!');
+        }
+    } catch (e) {
+        console.error(e);
+        process.exitCode = 1;
+    }
+}
+
+async function getAllOperations(directories) {
+    let fullContent = '';
+    for (const directory of directories) {
+        const files = await walk(path.resolve(directory));
+        for (const f of files) {
+            const code = await fsPromises.readFile(f, 'utf8');
+
+            let extracted;
+            try {
+                extracted = extractConstants(code);      // may throw on bad syntax
+            } catch (err) {
+                console.error(
+                    `⚠️  Skipping ${path.relative(process.cwd(), f)}\n` +
+                    `    ${err.message}`
+                );
+                continue;
+            }
+            fullContent += extracted;
+        }
+    }
+    return fullContent;
+}
+
+
+
+module.exports = async function main(sources, endpoints) {
+    for (const endpoint of endpoints) {
+        const operations = await getAllOperations(sources);
+        if (!operations) {
+            console.error('No GraphQL operations found in the specified directories.');
+            process.exitCode = 0;
+            return;
+        }
+        await validateGqlOperations(endpoint, operations);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe-commerce/elsie",
-  "version": "1.4.0-alpha2",
+  "version": "1.4.0-beta2",
   "license": "SEE LICENSE IN LICENSE.md",
   "description": "Domain Package SDK",
   "engines": {
@@ -36,8 +36,10 @@
   },
   "dependencies": {
     "@babel/core": "^7.24.9",
+    "@babel/parser": "^7.24.0",
     "@babel/preset-env": "^7.24.8",
     "@babel/preset-typescript": "^7.24.7",
+    "@babel/traverse": "^7.24.0",
     "@chromatic-com/storybook": "^1",
     "@graphql-codegen/cli": "^5.0.0",
     "@graphql-codegen/client-preset": "^4.1.0",