@comet/upgrade 1.6.0 → 1.7.0

package/lib/v7/hide-graphql-field-suggestions.js

@@ -0,0 +1,74 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ts_morph_1 = require("ts-morph");
+/**
+ * Adds the `formatError` property to `GraphQLModule` options to hide `GraphQL` field suggestions for non dev environments.
+ */
+function hideGraphqlFieldSuggestions() {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const project = new ts_morph_1.Project({ tsConfigFilePath: "./api/tsconfig.json" });
+        const sourceFile = project.getSourceFile("api/src/app.module.ts");
+        if (!sourceFile)
+            throw new Error("app.module.ts not found");
+        // Add the required import statements
+        sourceFile.addImportDeclaration({
+            namedImports: ["ValidationError"],
+            moduleSpecifier: "apollo-server-express",
+        });
+        sourceFile.addImportDeclaration({
+            namedImports: ["ApolloDriverConfig"],
+            moduleSpecifier: "@nestjs/apollo",
+        });
+        // Get the forRoot method within AppModule
+        const forRootMethod = sourceFile.getClassOrThrow("AppModule").getMethodOrThrow("forRoot");
+        // Get the GraphQLModule.forRootAsync call within the forRoot method
+        const graphqlForRootCall = (_a = forRootMethod
+            .getBody()) === null || _a === void 0 ? void 0 : _a.getDescendantsOfKind(ts_morph_1.SyntaxKind.CallExpression).find((call) => call.getText().includes("GraphQLModule.forRootAsync"));
+        if (!graphqlForRootCall)
+            throw new Error("GraphQLModule.forRootAsync call not found within forRoot method.");
+        // Add the generic type ApolloDriverConfig to the GraphQLModule.forRootAsync call
+        if (!forRootMethod.getFullText().includes("GraphQLModule.forRootAsync<ApolloDriverConfig>")) {
+            const expression = graphqlForRootCall.getExpression();
+            if (!expression)
+                throw new Error("Expression not found within GraphQLModule.forRootAsync call.");
+            const expressionText = expression.getText();
+            expression.replaceWithText(expressionText.replace(`${expressionText}`, `${expressionText}<ApolloDriverConfig>`));
+        }
+        const formatErrorImplText = `
+        (error) => {
+            if (process.env.NODE_ENV !== "development") {
+                if (error instanceof ValidationError) {
+                    return new ValidationError("Invalid request.");
+                }
+            }
+            return error;
+        }`;
+        // return if property formatError already exists
+        if (graphqlForRootCall.getArguments().find((arg) => arg.getText().includes("formatError"))) {
+            throw new Error(`formatError property already exists in GraphQLModule.forRootAsync options. To be sure GraphQl field suggestions are disabled for non dev environments, please check if the implementation already contains: ${formatErrorImplText}`);
+        }
+        // Find the useFactory function within the GraphQLModule.forRootAsync call
+        const useFactoryFunction = graphqlForRootCall.getFirstDescendantByKindOrThrow(ts_morph_1.SyntaxKind.ArrowFunction, "useFactory function not found within GraphQLModule.forRootAsync call.");
+        if (!useFactoryFunction.getParent().getText().includes("useFactory"))
+            throw new Error("useFactory function not found within GraphQLModule.forRootAsync call.");
+        // Find the object literal being returned by the useFactory function
+        const returnObjectLiteral = useFactoryFunction.getFirstDescendantByKindOrThrow(ts_morph_1.SyntaxKind.ObjectLiteralExpression, "Object literal not found within useFactory function.");
+        // Add your formatError to GraphQLModule.forRootAsync options
+        returnObjectLiteral.addPropertyAssignment({
+            name: "formatError",
+            initializer: ({ write }) => write(formatErrorImplText),
+        });
+        sourceFile.saveSync();
+    });
+}
+exports.default = hideGraphqlFieldSuggestions;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@comet/upgrade",
-    "version": "1.6.0",
+    "version": "1.7.0",
     "description": "Upgrade scripts for Comet DXP",
     "homepage": "https://github.com/vivid-planet/comet-upgrade#readme",
     "bugs": {
@@ -31,7 +31,8 @@
         "eslint": "^8.56.0",
         "glob": "^10.3.10",
         "prettier": "^2.8.1",
-        "semver": "^7.3.8"
+        "semver": "^7.3.8",
+        "ts-morph": "^22.0.0"
     },
     "devDependencies": {
         "@comet/eslint-config": "^3.2.1",