Merge pull request #358 from contentstack/fix/DX-10294

fix(tsgen): resolve the real GraphQL endpoint per region

Author: naman-contentstack

.talismanrc

@@ -2,4 +2,16 @@ fileignoreconfig:
 
 - filename: pnpm-lock.yaml
   checksum: 98236e2588d5cffcbdda3464179d91e9540fd8ddb4d4fb5251cf0f7379876f42
+- filename: packages/contentstack-bulk-operations/src/utils/backup-dir-asset-fetcher.ts
+  checksum: fbf1ef882bf4ea8f06a7a28b9248a07e01f5a5d2d4da98dbb9ee52bc16ce318a
+- filename: packages/contentstack-bulk-operations/test/unit/utils/backup-dir-asset-fetcher.test.ts
+  checksum: b905524c952aff0f089fa5347e0db18479b75a438cd9ae77e2dfe1cb203d7e59
+- filename: packages/contentstack-import/src/import/modules/assets.ts
+  checksum: 014f612c3e8db21c891da0c17a1a3b4cd340c026c58034791d86cd5f73aa9f90
+- filename: packages/contentstack-bulk-operations/test/unit/utils/revert-retry-handler.test.ts
+  checksum: 142e7b67a06bc13b6b4191b17f2ea8ae31a3bce20086ea35a92f3e3671eb603d
+- filename: packages/contentstack-bulk-operations/src/commands/cm/stacks/bulk-assets.ts
+  checksum: 9392511b337c361b86c36eb2431d8fea9129a61f6b7d70dcb4a633fea339ca61
+- filename: packages/contentstack-bulk-operations/src/utils/batch-helper.ts
+  checksum: ddcd8ef7c56d1122df88075883a2768a28813147e8fdef5b8e72a1ec118c045a
   version: ""

packages/contentstack-cli-tsgen/src/commands/tsgen.ts

@@ -4,7 +4,11 @@ import * as path from "path";
 import * as fs from "fs";
 import { cliux } from "@contentstack/cli-utilities";
 import { generateTS, graphqlTS } from "@contentstack/types-generator";
-import { sanitizePath, printFormattedError } from "../lib/helper";
+import {
+  sanitizePath,
+  printFormattedError,
+  resolveGraphqlHost,
+} from "../lib/helper";
 import { StackConnectionConfig } from "../types";
 
 function createOutputPath(outputFile: string) {
@@ -31,20 +35,6 @@ export default class TypeScriptCodeGeneratorCommand extends Command {
     '$ csdx tsgen -a "delivery token alias" --output "contentstack/generated.d.ts" --api-type graphql --namespace "GraphQL" ',
   ];
 
-  // Check if a region is a default Contentstack region
-  private isDefaultRegion(region: string): boolean {
-    const defaultRegions = [
-      "US",
-      "EU",
-      "AU",
-      "AZURE_NA",
-      "AZURE_EU",
-      "GCP_NA",
-      "GCP_EU",
-    ];
-    return defaultRegions.includes(region.toUpperCase());
-  }
-
   static flags: FlagInput = {
     alias: flags.string({
       char: "a",
@@ -150,36 +140,37 @@ export default class TypeScriptCodeGeneratorCommand extends Command {
       // Generate the GraphQL schema TypeScript definitions
       if (flags["api-type"] === "graphql") {
         try {
-          if (config.region === "us") {
-            config.region = "US";
-          }
-
           // Check if token has delivery type (required for GraphQL)
           if (token.type !== "delivery") {
             throw new Error(
               "GraphQL API requires a delivery token. Management tokens aren't supported.",
             );
           }
 
-          // Prepare GraphQL config - only include host for custom regions
-          const graphqlConfig: any = {
+          // GraphQL has its own host per region; config.host is the CDA (REST)
+          // host and answers a GraphQL query with a 403.
+          const graphqlHost = resolveGraphqlHost(this.region);
+
+          if (!graphqlHost) {
+            throw new Error(
+              `No GraphQL delivery endpoint is configured for the '${this.region.name}' region.`,
+            );
+          }
+
+          const graphqlConfig: StackConnectionConfig & {
+            namespace?: string;
+            logger?: any;
+          } = {
             apiKey: config.apiKey,
             token: config.token,
             environment: config.environment,
-            namespace: namespace,
+            region: this.region.name,
+            host: graphqlHost,
+            branch: config.branch,
+            namespace,
             logger: log,
           };
 
-          // Add region or host based on whether it's a custom region
-          if (config.host && !this.isDefaultRegion(config.region)) {
-            // Custom region - include both region and host
-            graphqlConfig.region = config.region;
-            graphqlConfig.host = config.host;
-          } else {
-            // Default region - only include region
-            graphqlConfig.region = config.region;
-          }
-
           const result = await graphqlTS(graphqlConfig);
 
           if (!result) {

packages/contentstack-cli-tsgen/src/lib/helper.ts

@@ -1,10 +1,23 @@
-import { log } from "@contentstack/cli-utilities";
+import { log, resolveCanonicalEndpoints } from '@contentstack/cli-utilities';
+
+/**
+ * Resolve the GraphQL delivery host for a region.
+ */
+export const resolveGraphqlHost = (region: {
+  name: string;
+  endpoints?: Record<string, string>;
+}): string | undefined => {
+  const graphqlDelivery =
+    region?.endpoints?.graphqlDelivery || resolveCanonicalEndpoints(region?.name)?.graphqlDelivery;
+
+  return graphqlDelivery?.replace(/^https?:\/\//, '').replace(/\/+$/, '');
+};
 
 export const sanitizePath = (str: string) => {
   return str
-    ?.replace(/^([\/\\]){2,}/, "./") // Normalize leading slashes/backslashes to ''
-    .replace(/[\/\\]+/g, "/") // Replace multiple slashes/backslashes with a single '/'
-    .replace(/(\.\.(\/|\\|$))+/g, ""); // Remove directory traversal (../ or ..\)
+    ?.replace(/^([\/\\]){2,}/, './') // Normalize leading slashes/backslashes to ''
+    .replace(/[\/\\]+/g, '/') // Replace multiple slashes/backslashes with a single '/'
+    .replace(/(\.\.(\/|\\|$))+/g, ''); // Remove directory traversal (../ or ..\)
 };
 
 /**
@@ -24,59 +37,46 @@ export interface FormattedError {
  * @param context - The context where the error occurred (e.g., "tsgen", "graphql")
  */
 export const printFormattedError = (error: FormattedError, context: string) => {
-  const errorCode = error?.error_code || "UNKNOWN_ERROR";
+  const errorCode = error?.error_code || 'UNKNOWN_ERROR';
   // Special handling for our numeric identifier validation errors
-  if (
-    errorCode === "VALIDATION_ERROR" &&
-    error?.error_message &&
-    error.error_message.includes("numeric identifiers")
-  ) {
+  if (errorCode === 'VALIDATION_ERROR' && error?.error_message && error.error_message.includes('numeric identifiers')) {
     // Just print our detailed message as-is, no extra formatting
     log.error(error.error_message);
     return;
   }
 
-  let errorMessage = "An unexpected error occurred. Try again.";
-  let hint = "";
+  let errorMessage = 'An unexpected error occurred. Try again.';
+  let hint = '';
 
   switch (errorCode) {
-    case "AUTHENTICATION_FAILED":
-      errorMessage = "Authentication failed. Check your credentials and try again.";
-      hint = "Please check your API key, token, and region.";
+    case 'AUTHENTICATION_FAILED':
+      errorMessage = 'Authentication failed. Check your credentials and try again.';
+      hint = 'Please check your API key, token, and region.';
       break;
-    case "INVALID_CREDENTIALS":
-      errorMessage = "Invalid credentials. Please verify and re-enter your login details.";
-      hint = "Please verify your API key, token, and region.";
+    case 'INVALID_CREDENTIALS':
+      errorMessage = 'Invalid credentials. Please verify and re-enter your login details.';
+      hint = 'Please verify your API key, token, and region.';
       break;
-    case "INVALID_INTERFACE_NAME":
-    case "INVALID_CONTENT_TYPE_UID":
-      errorMessage = "Generated types contain a TypeScript syntax error.";
-      hint =
-        "Use a prefix to ensure all interface names are valid TypeScript identifiers.";
+    case 'INVALID_INTERFACE_NAME':
+    case 'INVALID_CONTENT_TYPE_UID':
+      errorMessage = 'Generated types contain a TypeScript syntax error.';
+      hint = 'Use a prefix to ensure all interface names are valid TypeScript identifiers.';
       break;
-    case "INVALID_GLOBAL_FIELD_REFERENCE":
-      errorMessage = "Generated types contain a TypeScript syntax error.";
-      hint =
-        "Use a prefix to ensure all interface names are valid TypeScript identifiers.";
+    case 'INVALID_GLOBAL_FIELD_REFERENCE':
+      errorMessage = 'Generated types contain a TypeScript syntax error.';
+      hint = 'Use a prefix to ensure all interface names are valid TypeScript identifiers.';
       break;
-    case "VALIDATION_ERROR":
-      errorMessage = "Type generation failed due to a validation error.";
-      hint =
-        error?.error_message ||
-        "Type generation failed due to a validation error.";
+    case 'VALIDATION_ERROR':
+      errorMessage = 'Type generation failed due to a validation error.';
+      hint = error?.error_message || 'Type generation failed due to a validation error.';
       break;
-    case "TYPE_GENERATION_FAILED":
-      errorMessage = "Type generation failed due to a system error. Try again.";
-      hint =
-        error?.error_message ||
-        "Unexpected error during type generation. Try again.";
+    case 'TYPE_GENERATION_FAILED':
+      errorMessage = 'Type generation failed due to a system error. Try again.';
+      hint = error?.error_message || 'Unexpected error during type generation. Try again.';
       break;
     default:
-      errorMessage =
-        error?.error_message ||
-        error?.message ||
-        "An unexpected error occurred. Try again.";
-      hint = "Check the error details and try again.";
+      errorMessage = error?.error_message || error?.message || 'An unexpected error occurred. Try again.';
+      hint = 'Check the error details and try again.';
   }
 
   // Print formatted error output

packages/contentstack-cli-tsgen/test/unit/helper.test.ts

@@ -2,10 +2,18 @@
 // printFormattedError writes to spies instead of the real logger.
 jest.mock("@contentstack/cli-utilities", () => ({
   log: { error: jest.fn(), warn: jest.fn(), info: jest.fn() },
+  // Real lookup - the region-name-to-endpoint mapping is what these tests check.
+  resolveCanonicalEndpoints: jest.requireActual(
+    "@contentstack/cli-utilities/lib/region-endpoints",
+  ).resolveCanonicalEndpoints,
 }));
 
 import { log } from "@contentstack/cli-utilities";
-import { sanitizePath, printFormattedError } from "../../src/lib/helper";
+import {
+  sanitizePath,
+  printFormattedError,
+  resolveGraphqlHost,
+} from "../../src/lib/helper";
 
 const errorMock = log.error as jest.Mock;
 const warnMock = log.warn as jest.Mock;
@@ -209,3 +217,43 @@ describe("helper", () => {
     });
   });
 });
+
+describe("resolveGraphqlHost", () => {
+  // The regression: region names are stored as "AWS-NA"/"AZURE-EU"/..., so a
+  // lookup keyed on "US"/"AZURE_NA" misses and the CDA host gets used instead,
+  // which answers a GraphQL query with a 403.
+  it.each([
+    ["AWS-NA", "graphql.contentstack.com"],
+    ["AWS-EU", "eu-graphql.contentstack.com"],
+    ["AWS-AU", "au-graphql.contentstack.com"],
+    ["AZURE-NA", "azure-na-graphql.contentstack.com"],
+    ["AZURE-EU", "azure-eu-graphql.contentstack.com"],
+    ["GCP-NA", "gcp-na-graphql.contentstack.com"],
+    ["GCP-EU", "gcp-eu-graphql.contentstack.com"],
+  ])("resolves %s by name to %s", (name, expected) => {
+    expect(resolveGraphqlHost({ name })).toBe(expected);
+  });
+
+  it.each(["AWS-NA", "AWS-EU", "AZURE-EU", "GCP-NA"])(
+    "never returns a CDA host for %s",
+    (name) => {
+      const host = resolveGraphqlHost({ name });
+
+      expect(host).toContain("graphql");
+      expect(host).not.toContain("cdn.");
+    },
+  );
+
+  it("prefers the endpoints already on the region object", () => {
+    expect(
+      resolveGraphqlHost({
+        name: "AWS-NA",
+        endpoints: { graphqlDelivery: "https://custom-graphql.example.com/" },
+      }),
+    ).toBe("custom-graphql.example.com");
+  });
+
+  it("returns undefined for a custom region with no GraphQL endpoint", () => {
+    expect(resolveGraphqlHost({ name: "my-pilot-region" })).toBeUndefined();
+  });
+});