feat: add recordServiceUrl config option

README.md

@@ -20,12 +20,13 @@ Install the package
 npm install @currents/cypress
 ```
 
-Create a new configuration file: `currents.config.js` in the project’s root and set the `projectId` and the record key obtained from [Currents](https://app.currents.dev) or your self-hosted instance of Sorry Cypress:
+Create a new configuration file: `currents.config.js` in the project’s root, set the `projectId` and the record key obtained from [Currents](https://app.currents.dev) or your self-hosted instance of Sorry Cypress:
 
 ```js
 module.exports = {
   projectId: "Ij0RfK",
   recordKey: "xxx",
+  cloudServiceUrl: "https://cy.currents.dev", // Sorry Cypress users - set the director service URL
 };
 ```
 
@@ -38,16 +39,14 @@ const { cloudPlugin } = require("@currents/cypress/plugin");
 module.exports = defineConfig({
   e2e: {
     setupNodeEvents(on, config) {
-      cloudPlugin(on, config);
+      return cloudPlugin(on, config);
     },
   },
 });
 ```
 
 ## Usage
 
-Obtain the record key from https://app.currents.dev (or use any value for Sorry Cypress)
-
 ```sh
 npx cypress-cloud --parallel --record --key <your_key> --ci-build-id hello-cypress-cloud
 ```
@@ -63,8 +62,15 @@ See an example in [examples/webapp](./example/webapp) directory
 ```js
 // currents.config.js
 module.exports = {
-  projectId: "Ij0RfK",
-  recordKey: "the record key from currents.dev",
+  projectId: "Ij0RfK", // ProjectID obtained from https://app.currents.dev or Sorry Cypress
+  recordKey: "XXXXXXX", // Record key obtained from https://app.currents.dev, any value for Sorry Cypress
+  cloudServiceUrl: "https://cy.currents.dev", // Sorry Cypress users - the director service URL
+  e2e: {
+    batchSize: 3, // orchestration batch size for e2e tests
+  },
+  component: {
+    batchSize: 5, // orchestration batch size for component tests
+  },
 };
 ```
 
@@ -105,12 +111,14 @@ const results = await run({
 
 ## Troubleshooting
 
-Enable the debug mode and run the command
+Enable the debug mode and run the command:
 
 ```sh
 DEBUG=currents:* npx cypress-cloud run ...
 ```
 
+Capture all the logs in a plain text file and submit an issue.
+
 ## Testing
 
 ```sh

packages/cypress-cloud/lib/config.ts

@@ -15,12 +15,13 @@ export type ComponentConfig = {
 export type CurrentsConfig = {
   projectId?: string;
   recordKey?: string;
+  cloudServiceUrl?: string;
   e2e: E2EConfig;
   component: ComponentConfig;
 };
 
-export async function getCurrentsConfig(): Promise<CurrentsConfig> {
-  const configFilePath = await getConfigFilePath();
+export function getCurrentsConfig(): CurrentsConfig {
+  const configFilePath = getConfigFilePath();
   debug("loading currents config file from '%s'", configFilePath);
 
   const defaultConfig: CurrentsConfig = {
@@ -30,6 +31,7 @@ export async function getCurrentsConfig(): Promise<CurrentsConfig> {
     component: {
       batchSize: 5,
     },
+    cloudServiceUrl: "https://cy.currents.dev",
   };
 
   try {

packages/cypress-cloud/lib/httpClient/config.ts

@@ -1,4 +1,5 @@
 import { AxiosError, isAxiosError } from "axios";
+import { getCurrentsConfig } from "../config";
 
 export const isRetriableError = (err: AxiosError): boolean => {
   if (!isAxiosError(err)) {
@@ -17,4 +18,6 @@ export const isRetriableError = (err: AxiosError): boolean => {
 export const getDelay = (i: number) => [15 * 1000, 30 * 1000, 60 * 1000][i - 1];
 
 export const getBaseUrl = () =>
-  process.env.CURRENTS_API_URL || "https://cy.currents.dev";
+  process.env.CURRENTS_API_URL ??
+  getCurrentsConfig().cloudServiceUrl ??
+  "https://cy.currents.dev";