@common-stack/generate-plugin 6.0.6-alpha.32 → 6.0.6-alpha.34

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [6.0.6-alpha.34](https://github.com/cdmbase/common-stack/compare/v6.0.6-alpha.33...v6.0.6-alpha.34) (2024-09-27)
+
+### Bug Fixes
+
+-   **server-stack:** apollo server redis cache ([2ef1df3](https://github.com/cdmbase/common-stack/commit/2ef1df30176616baf9816c47168687577f7aa8ff))
+
+## [6.0.6-alpha.33](https://github.com/cdmbase/common-stack/compare/v6.0.6-alpha.32...v6.0.6-alpha.33) (2024-09-23)
+
+**Note:** Version bump only for package @common-stack/generate-plugin
+
 ## [6.0.6-alpha.32](https://github.com/cdmbase/common-stack/compare/v6.0.6-alpha.31...v6.0.6-alpha.32) (2024-09-22)
 
 **Note:** Version bump only for package @common-stack/generate-plugin

package/lib/generators/add-backend/files/package.json

@@ -62,7 +62,7 @@
     "dependencies": {
         "@apollo/client": "^3.9.0",
         "@babel/runtime": "^7.20.1",
-        "@common-stack/server-stack": "6.0.6-alpha.31",
+        "@common-stack/server-stack": "6.0.6-alpha.33",
         "@container-stack/mailing-api-server": "^5.2.1-alpha.2",
         "@container-stack/territory": "^5.2.1-alpha.2",
         "@remix-run/node": "~2.10.1",

package/lib/generators/add-backend/files/src/api/root-schema.graphqls

@@ -10,12 +10,6 @@ scalar Observable
 scalar JSON
 scalar JSONObject
 
-directive @cacheControl(maxAge: Int, scope: CacheControlScope) on FIELD_DEFINITION | OBJECT | INTERFACE
-enum CacheControlScope {
-  PUBLIC
-  PRIVATE
-}
-
 """
  An object with an ID.
 """
@@ -84,7 +78,7 @@ interface IResourceUtilizationSettings {
     adminApiNamespace: String
 }
 
-""" 
+"""
  Input geometry of the location.
  List the `longitude` first and then `latitude`
   - Validate longitude values are between `-180` and `180`

package/lib/generators/add-frontend/templates/tools/checkQueryUsage.mjs

@@ -0,0 +1,192 @@
+import fs from 'fs';
+import path from 'path';
+import glob from'glob';
+
+// Regex to find `use<QueryName>Query` calls, capturing query name and arguments
+const queryPattern = /use([A-Za-z0-9]+Query)\(([^)]*)\)/g;
+const fileExtensions = ['.js', '.ts', '.jsx', '.tsx'];
+const excludeFiles = ['react-hooks', 'generated'];
+const basePath = process.cwd();
+
+const findPackageJsonFiles = () => {
+  const monorepoRoot = path.join(basePath, '..', '..');
+  return new Promise((resolve, reject) => {
+    glob(
+      `${monorepoRoot}/+(servers|portable-devices|packages|packages-modules)/**/package.json`,
+      { nodir: true, ignore: '**/node_modules/**' },
+      (err, files) => {
+        if (err) reject(`Unable to scan directory: ${err}`);
+        resolve(files);
+      },
+    );
+  });
+};
+
+// Function to transform componentPath from `lib` to `src` path and handle package names
+const transformComponentPath = (componentPath, packageName) => {
+  return componentPath
+    .replace('/lib/', '/src/')
+    .replace(packageName + '/', '')
+    .replace('.js', '');
+};
+
+// Normalize file paths for consistent comparison (remove extensions and resolve absolute paths)
+const normalizePath = (filePath) => {
+  const resolvedPath = path.resolve(filePath).replace(/\.[jt]sx?$/, ''); // Remove .js, .ts, .jsx, .tsx extensions
+  return resolvedPath;
+};
+
+// Function to extract component paths and queries from routes.json
+async function extractComponentPathsAndQueries(routesFile, packageName) {
+  let componentQueries = {};
+
+  try {
+    const content = await fs.promises.readFile(routesFile, 'utf-8');
+    const routes = JSON.parse(content);
+
+    // Traverse routes to extract componentPath and queries
+    routes.forEach(routeObj => {
+      Object.keys(routeObj).forEach(routeKey => {
+        const route = routeObj[routeKey];
+        if (route.hasComponent && route.componentPath) {
+          const transformedPath = normalizePath(transformComponentPath(route.componentPath, packageName));
+          const queries = Object.keys(route.queries || {});
+          if (queries.length > 0) {
+            componentQueries[transformedPath] = queries;
+          }
+        }
+      });
+    });
+
+    console.log('Extracted components and queries from routes.json:', componentQueries);
+  } catch (err) {
+    console.error(`Error reading routes.json file: ${routesFile}`, err);
+  }
+
+  return componentQueries;
+}
+
+// Function to recursively search for useQuery in files and validate if the file is a data component
+async function checkFiles(dir, componentQueries) {
+  const files = await fs.promises.readdir(dir, { withFileTypes: true });
+
+  for (const file of files) {
+    const fullPath = path.join(dir, file.name);
+
+    if (file.isDirectory()) {
+      // Recurse into subdirectories
+      await checkFiles(fullPath, componentQueries);
+    } else if (fileExtensions.includes(path.extname(file.name)) && !excludeFiles.includes(path.parse(file.name).name)) {
+      await checkForInvalidQueryUsage(fullPath, componentQueries);
+    }
+  }
+}
+
+// Function to extract query details from a match
+const extractQueryDetails = (queryMatch) => {
+  const [fullMatch, queryName, queryArgs] = queryMatch;
+  return {
+    queryName,
+    fullMatch,
+    queryArgs: queryArgs.trim(),
+    isLazyQuery: queryName.endsWith('LazyQuery'),
+    hasCacheOnlyFetchPolicy: queryArgs.includes("fetchPolicy: 'cache-only'"),
+  };
+};
+
+// Function to check for query usage in a file and validate if it is allowed
+async function checkForInvalidQueryUsage(filePath, componentQueries) {
+  try {
+    const content = await fs.promises.readFile(filePath, 'utf-8');
+    let match;
+    const usedQueries = [];
+    const queriesMissingCacheOnly = [];
+    const queriesWithNoArguments = [];
+    const queryNames = [];
+
+    while ((match = queryPattern.exec(content)) !== null) {
+      const queryDetails = extractQueryDetails(match);
+      usedQueries.push(queryDetails);
+      queryNames.push(queryDetails.queryName);
+
+      // Ignore LazyQuery for fetchPolicy check
+      if (!queryDetails.isLazyQuery && !queryDetails.hasCacheOnlyFetchPolicy) {
+        queriesMissingCacheOnly.push(queryDetails.queryName);
+      }
+
+      // Check for queries without arguments
+      if (queryDetails.queryArgs === '') {
+        queriesWithNoArguments.push(queryDetails.queryName);
+      }
+    }
+
+    if (usedQueries.length > 0) {
+      const normalizedFilePath = normalizePath(filePath);
+      const isDataComponent = componentQueries[normalizedFilePath];
+
+      const warnings = [];
+
+      // Warning if a data component has more than 3 queries
+      if (isDataComponent && usedQueries.length > 3) {
+        warnings.push(`Warning: Data component "${filePath}" has more than 3 queries. Consider splitting into multiple data components with a layout component as the parent.`);
+      }
+
+      // Consolidate missing cache-only fetchPolicy warnings
+      if (queriesMissingCacheOnly.length > 0) {
+        warnings.push(`Warning: The following queries are missing fetchPolicy: "cache-only":\n    - ${queriesMissingCacheOnly.join('\n    - ')}`);
+      }
+
+      // Warn for queries without arguments (which could fetch all data)
+      if (queriesWithNoArguments.length > 0) {
+        warnings.push(`Warning: The following queries have no arguments and could fetch all data. Consider narrowing the search and using pagination:\n    - ${queriesWithNoArguments.join('\n    - ')}`);
+      }
+
+      // Warning for non-data components with queries
+      if (!isDataComponent) {
+        warnings.push(`Warning: File "${filePath}" is a non-data component (not listed in routes.json) but is using queries.`);
+      }
+
+      // Display queries first, then display all warnings together
+      if (warnings.length > 0) {
+        console.log('----------------------------------------------------');
+        console.log(`File: ${filePath}`);
+        console.log('Queries:');
+        usedQueries.forEach(query => console.log(`  - ${query.fullMatch}`)); // Display full query details
+        console.log('\nWarnings:');
+        warnings.forEach(warning => console.log(`  - ${warning}`));
+        console.log('----------------------------------------------------\n');
+      }
+    }
+  } catch (err) {
+    console.error(`Error reading file: ${filePath}`, err);
+  }
+}
+
+// Check in a single package
+async function checkPackage(packageDir, packageName) {
+  const routesFile = path.resolve(path.join(packageDir, './lib/routes.json'));
+  const sourceDir = path.resolve(path.join(packageDir, './src'));
+  let componentQueries = {};
+
+  if (fs.existsSync(routesFile)) {
+    console.log(`Extracting component paths and queries from ${routesFile}...`);
+    componentQueries = await extractComponentPathsAndQueries(routesFile, packageName);
+  }
+
+  console.log(`Searching for query usage in files under ${sourceDir}...`);
+  await checkFiles(sourceDir, componentQueries);
+}
+
+// Run the script
+(async () => {
+  console.log('Checking useQuery usage ...');
+
+  const packageJsonFiles = await findPackageJsonFiles();
+  for (const file of packageJsonFiles) {
+    const packageJson = JSON.parse(fs.readFileSync(file, 'utf8'));
+    const packageDir = path.dirname(file);
+    await checkPackage(packageDir, packageJson.name);
+  }
+
+  console.log('Completed checking useQuery usage.');
+})();

package/lib/generators/add-fullstack/files/package.json

@@ -147,7 +147,7 @@
         "@babel/register": "^7.18.9",
         "@babel/runtime": "^7.20.1",
         "@common-stack/env-list-loader": "6.0.6-alpha.5",
-        "@common-stack/generate-plugin": "6.0.6-alpha.31",
+        "@common-stack/generate-plugin": "6.0.6-alpha.33",
         "@emotion/babel-plugin": "^11.11.0",
         "@graphql-codegen/add": "^5.0.2",
         "@graphql-codegen/cli": "^5.0.2",

package/lib/generators/add-moleculer/files/package.json

@@ -28,7 +28,7 @@
         "@common-stack/client-core": "6.0.6-alpha.5",
         "@common-stack/core": "6.0.6-alpha.5",
         "@common-stack/server-core": "6.0.6-alpha.5",
-        "@common-stack/server-stack": "6.0.6-alpha.31",
+        "@common-stack/server-stack": "6.0.6-alpha.33",
         "@common-stack/store-mongo": "6.0.6-alpha.5",
         "@container-stack/mailing-api": "5.2.1-alpha.1",
         "helmet": "^3.21.2",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@common-stack/generate-plugin",
-    "version": "6.0.6-alpha.32",
+    "version": "6.0.6-alpha.34",
     "type": "module",
     "main": "./lib/index.mjs",
     "typings": "./lib/index.d.ts",
@@ -25,5 +25,5 @@
     },
     "executors": "./executors.json",
     "generators": "./generators.json",
-    "gitHead": "dbc730a62e3bae08f50cc035918d6e4d6664470a"
+    "gitHead": "a18390ead2b175b764970e162055142a2f694e9e"
 }

package/src/generators/add-fullstack/files/package.json

@@ -147,7 +147,7 @@
         "@babel/register": "^7.18.9",
         "@babel/runtime": "^7.20.1",
         "@common-stack/env-list-loader": "6.0.6-alpha.5",
-        "@common-stack/generate-plugin": "6.0.6-alpha.31",
+        "@common-stack/generate-plugin": "6.0.6-alpha.33",
         "@emotion/babel-plugin": "^11.11.0",
         "@graphql-codegen/add": "^5.0.2",
         "@graphql-codegen/cli": "^5.0.2",

package/src/generators/add-moleculer/files/package.json

@@ -28,7 +28,7 @@
         "@common-stack/client-core": "6.0.6-alpha.5",
         "@common-stack/core": "6.0.6-alpha.5",
         "@common-stack/server-core": "6.0.6-alpha.5",
-        "@common-stack/server-stack": "6.0.6-alpha.31",
+        "@common-stack/server-stack": "6.0.6-alpha.33",
         "@common-stack/store-mongo": "6.0.6-alpha.5",
         "@container-stack/mailing-api": "5.2.1-alpha.1",
         "helmet": "^3.21.2",