ToolJet/cypress-tests/cypress/commands/apiCommands.js

const envVar = Cypress.env("environment");

Cypress.Commands.add("apiCreateApp", (appName = "testApp") => {
  cy.window({ log: false }).then((win) => {
    win.localStorage.setItem("walkthroughCompleted", "true");
  });
  cy.getCookie("tj_auth_token", { log: false }).then((cookie) => {
    Cypress.env("authToken", `tj_auth_token=${cookie.value}`);
    cy.request({
      method: "POST",
      url: `${Cypress.env("server_host")}/api/apps`,
      headers: {
        "Tj-Workspace-Id": Cypress.env("workspaceId"),
        Cookie: `tj_auth_token = ${cookie.value}`,
      },
      body: {
        type: "front-end",
        name: appName,
        is_maintenance_on: false,
        organization_id: "",
        user_id: "",
        created_at: "",
        updated_at: "",
        id: "",
        is_public: null,
        workflow_enabled: false,
        creation_mode: "DEFAULT",
      },
    }).then((response) => {
      {
        log: false;
      }

      expect(response.status).to.equal(201);
      Cypress.env("appId", response.allRequestResponses[0]["Response Body"].id);
      Cypress.env(
        "user_id",
        response.allRequestResponses[0]["Response Body"].user_id
      );
      Cypress.log({
        name: "App create",
        displayName: "APP CREATED",
        message: `: ${response.body.name}`,
      });
    });
  });
});

Cypress.Commands.add("apiDeleteApp", (appId = Cypress.env("appId")) => {
  cy.getCookie("tj_auth_token", { log: false }).then((cookie) => {
    Cypress.env("authToken", `tj_auth_token=${cookie.value}`);
    cy.request(
      {
        method: "DELETE",
        url: `${Cypress.env("server_host")}/api/apps/${appId}`,
        headers: {
          "Tj-Workspace-Id": Cypress.env("workspaceId"),
          Cookie: Cypress.env("authToken"),
        },
      },
      { log: false }
    ).then((response) => {
      expect(response.status).to.equal(200);
      Cypress.log({
        name: "App Delete",
        displayName: "APP DELETED",
        message: `:${appId}`,
      });
    });
  });
});

Cypress.Commands.add(
  "openApp",
  (
    slug = "",
    workspaceId = Cypress.env("workspaceId"),
    appId = Cypress.env("appId"),
    componentSelector = "[data-cy='drag-and-drop-a-component-label']"
  ) => {
    cy.intercept("GET", "/api/apps/*").as("getAppData");

    cy.window({ log: false }).then((win) => {
      win.localStorage.setItem("walkthroughCompleted", "true");
    });

    cy.visit(`/${workspaceId}/apps/${appId}/${slug}`);

    cy.wait("@getAppData").then((interception) => {
      const responseData = interception.response.body;

      Cypress.env("editingVersionId", responseData.editing_version.id);
      Cypress.env("environmentId", responseData.editorEnvironment.id);
    });
    cy.get(componentSelector, { timeout: 10000 });
  }
);

Cypress.Commands.add("apiAddQuery", (queryName, query, dataQueryId) => {
  cy.getCookie("tj_auth_token").then((cookie) => {
    const headers = {
      "Tj-Workspace-Id": Cypress.env("workspaceId"),
      Cookie: `tj_auth_token=${cookie.value}`,
    };

    cy.apiGetAppData(Cypress.env("appId")).then((appData) => {
      const editingVersionId = appData.editing_version.id;

      cy.request({
        method: "PATCH",
        url: `${Cypress.env("server_host")}/api/data-queries/${dataQueryId}/versions/${editingVersionId}`,
        headers: headers,
        body: {
          name: queryName,
          options: {
            mode: "sql",
            transformationLanguage: "javascript",
            enableTransformation: false,
            query: query,
          },
        },
      }).then((patchResponse) => {
        expect(patchResponse.status).to.equal(200);
      });
    });
  });
});

Cypress.Commands.add(
  "apiAddQueryToApp",
  ({ queryName, options, dataSourceName, dsKind }) => {
    cy.getCookie("tj_auth_token", { log: false }).then((cookie) => {
      const authToken = cookie?.value;
      const workspaceId = Cypress.env("workspaceId");
      const appId = Cypress.env("appId");
      const commonHeaders = {
        "tj-workspace-id": workspaceId,
        Cookie: `tj_auth_token=${authToken}; app_id=${appId}`,
      };

      cy.request({
        method: "GET",
        url: `${Cypress.env("server_host")}/api/apps/${appId}`,
        headers: commonHeaders,
      }).then((appResponse) => {
        const editingVersionId = appResponse.body.editing_version.id;
        const currentEnvironmentId = appResponse.body.editorEnvironment.id;
        Cypress.env("version-id", editingVersionId);
        Cypress.env("environmentVersion-id", currentEnvironmentId);

        cy.request({
          method: "GET",
          url: `${Cypress.env("server_host")}/api/data-sources/${workspaceId}/environments/${currentEnvironmentId}/versions/${editingVersionId}`,
          headers: commonHeaders,
        }).then((dsResponse) => {
          const dataSource = dsResponse.body.data_sources.find(
            (ds) => ds.name === dataSourceName
          );
          const dataSourceID = dataSource.id;
          Cypress.env(`${dataSourceName}`, dataSourceID);

          cy.request({
            method: "POST",
            url: `${Cypress.env("server_host")}/api/data-queries/data-sources/${dataSourceID}/versions/${editingVersionId}`,
            headers: {
              "Content-Type": "application/json",
              "tj-workspace-id": workspaceId,
              Cookie: `tj_auth_token=${authToken}; app_id=${appId}`,
            },
            body: {
              app_id: appId,
              app_version_id: editingVersionId,
              name: queryName,
              kind: dsKind,
              options: options,
              data_source_id: dataSourceID,
              plugin_id: null,
            },
          }).then((queryResponse) => {
            expect(queryResponse.status).to.eq(201);
            Cypress.env("query-id", queryResponse.body.id);
            Cypress.log({
              name: "apiAddQueryToApp",
              displayName: "QUERY CREATED",
              message: `${queryName} (${dsKind})`,
            });
          });
        });
      });
    });
  }
);

Cypress.Commands.add(
  "apiAddComponentToApp",
  (
    appName,
    componentName,
    layoutConfig = {},
    componentType = "Text",
    componentValue = "default"
  ) => {
    cy.getAppId(appName).then((appId) => {
      const defaultLayout = {
        desktop: { top: 90, left: 9, width: 6, height: 40 },
        mobile: { top: 90, left: 9, width: 6, height: 40 },
      };

      const layouts = {
        desktop: { ...defaultLayout.desktop, ...layoutConfig.desktop },
        mobile: { ...defaultLayout.mobile, ...layoutConfig.mobile },
      };

      cy.getCookie("tj_auth_token", { log: false }).then((cookie) => {
        Cypress.env("authToken", `tj_auth_token=${cookie.value}`);

        cy.request({
          method: "GET",
          url: `${Cypress.env("server_host")}/api/apps/${appId}`,
          headers: {
            "Tj-Workspace-Id": Cypress.env("workspaceId"),
            Cookie: `tj_auth_token=${cookie.value}`,
          },
        }).then((response) => {
          expect(response.status).to.eq(200);

          const { id: editingVersionId, home_page_id: homePageId } =
            response.body.editing_version;
          const componentId = crypto.randomUUID
            ? crypto.randomUUID()
            : require("uuid").v4();

          let finalProperties = {};
          if (componentType === "Text") {
            finalProperties = {
              text: { value: `${componentValue}` },
            };
          } else if (componentType === "TextInput") {
            finalProperties = {
              value: { value: `${componentValue}` },
            };
          }

          const requestBody = {
            is_user_switched_version: false,
            pageId: homePageId,
            diff: {
              [componentId]: {
                name: componentName,
                layouts: layouts,
                type: componentType,
                properties: finalProperties,
              },
            },
          };

          cy.request({
            method: "POST",
            url: `${Cypress.env("server_host")}/api/v2/apps/${appId}/versions/${editingVersionId}/components`,
            headers: {
              "Content-Type": "application/json",
              "Tj-Workspace-Id": Cypress.env("workspaceId"),
              Cookie: `tj_auth_token=${cookie.value}`,
            },
            body: requestBody,
          }).then((postResponse) => {
            expect(postResponse.status).to.eq(201);
            cy.log(`Component ${componentId} added successfully`);
          });
        });
      });
    });
  }
);

Cypress.Commands.add("apiMakeAppPublic", (appId = Cypress.env("appId")) => {
  cy.getAuthHeaders().then((headers) => {
    cy.request({
      method: "PUT",
      url: `${Cypress.env("server_host")}/api/apps/${appId}`,
      headers: headers,
      body: {
        app: { is_public: true },
      },
      log: false,
    }).then((response) => {
      expect(response.status).to.equal(200);
    });
  });
});

Cypress.Commands.add("apiReleaseApp", (appName) => {
  cy.getAppId(appName).then((appId) => {
    cy.getAuthHeaders().then((headers) => {
      cy.request({
        method: "GET",
        url: `${Cypress.env("server_host")}/api/apps/${appId}`,
        headers,
      })
        .then((response) => {
          expect(response.status).to.eq(200);
          const editingVersionId = response.body.editing_version.id;
          cy.request({
            method: "PUT",
            url: `${Cypress.env("server_host")}/api/apps/${appId}/release`,
            headers: headers,
            body: {
              versionToBeReleased: editingVersionId,
            },
          });
        })
        .then((res) => {
          expect(res.status).to.eq(200);
        });
    });
  });
});

Cypress.Commands.add("apiAddAppSlug", (appName, slug) => {
  cy.getAppId(appName).then((appId) => {
    cy.getAuthHeaders().then((headers) => {
      cy.request({
        method: "PUT",
        url: `${Cypress.env("server_host")}/api/apps/${appId}`,
        headers: headers,
        body: {
          app: {
            slug: slug,
          },
        },
      }).then((response) => {
        expect(response.status).to.eq(200);
        cy.log("App slug updated successfully");
      });
    });
  });
});

Cypress.Commands.add("apiGetAppData", (appId = Cypress.env("appId")) => {
  cy.getAuthHeaders().then((headers) => {
    cy.request({
      method: "GET",
      url: `${Cypress.env("server_host")}/api/apps/${appId}`,
      headers: headers,
    }).then((response) => {
      expect(response.status).to.equal(200);
      return response.body;
    });
  });
});

Cypress.Commands.add("apiRunQuery", () => {
  cy.getCookie("tj_auth_token", { log: false }).then((cookie) => {
    const authToken = cookie?.value;
    const workspaceId = Cypress.env("workspaceId");
    const appId = Cypress.env("appId");

    const queryId = Cypress.env("query-id");
    const versionId = Cypress.env("version-id");
    const currentEnvironmentId = Cypress.env("environmentVersion-id");

    cy.request({
      method: "POST",
      url: `${Cypress.env("server_host")}/api/data-queries/${queryId}/versions/${versionId}/run/${currentEnvironmentId}`,
      headers: {
        "Content-Type": "application/json",
        "tj-workspace-id": workspaceId,
        Cookie: `tj_auth_token=${authToken}; app_id=${appId}`,
      },
      body: {},
    }).then((runResponse) => {
      expect(runResponse.status).to.eq(201);

      Cypress.log({
        name: "apiRunQuery",
        displayName: "QUERY RUN",
        message: `Ran query ${queryId} (version ${versionId})`,
      });
    });
  });
});

Cypress.Commands.add("apiUpdateGlobalSettings", (globalSettings) => {
  cy.getCookie("tj_auth_token")
    .should("exist")
    .then((cookie) => {
      return cy
        .request({
          method: "PUT",
          url: `${Cypress.env("server_host")}/api/v2/apps/${Cypress.env("appId")}/versions/${Cypress.env("editingVersionId")}/global_settings`,
          body: { globalSettings },
          headers: {
            "Content-Type": "application/json",
            "tj-workspace-id": Cypress.env("workspaceId") || "",
            Cookie: `tj_auth_token=${cookie.value}`,
          },
          failOnStatusCode: false,
        })
        .then((response) => {
          expect(response.status, "update global settings status").to.eq(200);
          return response.body;
        });
    });
});

Cypress.Commands.add(
  "apiPromoteAppVersion",
  (
    targetEnvId = Cypress.env("environmentId"),
    appId = Cypress.env("appId")
  ) => {
    cy.getCookie("tj_auth_token").then((cookie) => {
      cy.request({
        method: "PUT",
        url: `${Cypress.env("server_host")}/api/v2/apps/${appId}/versions/${Cypress.env("editingVersionId")}/promote`,
        body: { currentEnvironmentId: targetEnvId },
        headers: {
          "Content-Type": "application/json",
          "Tj-Workspace-Id": Cypress.env("workspaceId"),
          Cookie: `tj_auth_token=${cookie.value}`,
        },
      }).then((response) => {
        expect(response.status, "Promote app version status").to.eq(200);
        const editorEnv = response.body.editorEnvironment;

        if (editorEnv.name === "staging") {
          Cypress.env("stagingEnvId", editorEnv.id);
        } else if (editorEnv.name === "production") {
          Cypress.env("productionEnvId", editorEnv.id);
        }
        Cypress.log({
          name: "App promoted",
          message: `Environment: ${editorEnv.name} (${editorEnv.id})`,
        });
        return response.body;
      });
    });
  }
);

Cypress.Commands.add("apiGetAppIdByName", (appName) => {
  return cy.getAuthHeaders().then((headers) => {
    return cy
      .request({
        method: "GET",
        url: `${Cypress.env("server_host")}/api/apps`,
        headers: headers,
        log: false,
      })
      .then((response) => {
        expect(response.status).to.equal(200);
        const app = response.body.apps.find((app) => app.name === appName);
        expect(app, `App with name "${appName}" not found`).to.exist;
        return app.id;
      });
  });
});

Cypress.Commands.add(
  "apiPublishDraftVersion",
  (
    versionName,
    versionDescription = "",
    appId = Cypress.env("appId"),
    editingVersionId = Cypress.env("editingVersionId")
  ) => {
    cy.getCookie("tj_auth_token").then((cookie) => {
      cy.request({
        method: "PUT",
        url: `${Cypress.env("server_host")}/api/v2/apps/${appId}/versions/${editingVersionId}`,
        body: {
          is_user_switched_version: false,
          name: versionName,
          description: versionDescription,
          status: "PUBLISHED",
        },
        headers: {
          "Content-Type": "application/json",
          "tj-workspace-id": Cypress.env("workspaceId"),
          Cookie: `tj_auth_token=${cookie.value}`,
        },
      }).then((response) => {
        expect(response.status, "Publish draft version status").to.eq(200);
        Cypress.log({
          name: "Version published",
          displayName: "VERSION PUBLISHED",
          message: `Version: ${versionName} (${editingVersionId})`,
        });
        return response.body;
      });
    });
  }
);