API environment endpoints (#2529)

packages/back-end/package.json

@@ -27,8 +27,8 @@
     "generate-api-types": "yarn generate-api-models && swagger-cli bundle -t yaml src/api/openapi/openapi.tmp.yaml -o generated/spec.yaml && node src/scripts/generate-openapi.mjs"
   },
   "dependencies": {
-    "@aws-sdk/client-sts": "^3.567.0",
     "@aws-sdk/client-athena": "^3.564.0",
+    "@aws-sdk/client-sts": "^3.567.0",
     "@clickhouse/client": "^1.0.1",
     "@databricks/sql": "^1.8.1",
     "@dqbd/tiktoken": "^1.0.7",
@@ -141,7 +141,9 @@
     "delay-cli": "^2.0.0",
     "jest": "^27.1.1",
     "minimist": "^1.2.8",
+    "mongodb-memory-server": "^9.2.0",
     "rimraf": "^3.0.2",
+    "supertest": "^7.0.0",
     "typescript": "5.3.3"
   },
   "optionalDependencies": {

packages/back-end/src/api/api.router.ts

@@ -11,6 +11,7 @@ import experimentsRouter from "./experiments/experiments.router";
 import metricsRouter from "./metrics/metrics.router";
 import segmentsRouter from "./segments/segments.router";
 import projectsRouter from "./projects/projects.router";
+import environmentsRouter from "./environments/environments.router";
 import savedGroupsRouter from "./saved-groups/saved-groups.router";
 import sdkConnectionsRouter from "./sdk-connections/sdk-connections.router";
 import sdkPayloadRouter from "./sdk-payload/sdk-payload.router";
@@ -82,6 +83,7 @@ router.use("/metrics", metricsRouter);
 router.use("/segments", segmentsRouter);
 router.use("/dimensions", dimensionsRouter);
 router.use("/projects", projectsRouter);
+router.use("/environments", environmentsRouter);
 router.use("/sdk-connections", sdkConnectionsRouter);
 router.use("/data-sources", dataSourcesRouter);
 router.use("/visual-changesets", visualChangesetsRouter);

packages/back-end/src/api/environments/deleteEnvironment.ts

@@ -0,0 +1,46 @@
+import { DeleteEnvironmentResponse } from "../../../types/openapi";
+import { createApiRequestHandler } from "../../util/handler";
+import { deleteEnvironmentValidator } from "../../validators/openapi";
+import { updateOrganization } from "../../models/OrganizationModel";
+import { OrganizationInterface } from "../../../types/organization";
+import { auditDetailsDelete } from "../../services/audit";
+
+export const deleteEnvironment = createApiRequestHandler(
+  deleteEnvironmentValidator
+)(
+  async (req): Promise<DeleteEnvironmentResponse> => {
+    const id = req.params.id;
+    const org = req.context.org;
+    const environments = org.settings?.environments || [];
+
+    const environment = environments.find((env) => env.id === id);
+    if (!environment) {
+      throw Error(`Environment ${id} does not exists!`);
+    }
+
+    if (!req.context.permissions.canDeleteEnvironment(environment))
+      req.context.permissions.throwPermissionError();
+
+    const updates: Partial<OrganizationInterface> = {
+      settings: {
+        ...org.settings,
+        environments: [...environments.filter((env) => env.id !== id)],
+      },
+    };
+
+    await updateOrganization(org.id, updates);
+
+    await req.audit({
+      event: "environment.delete",
+      entity: {
+        object: "environment",
+        id: environment.id,
+      },
+      details: auditDetailsDelete(environment),
+    });
+
+    return {
+      deletedId: id,
+    };
+  }
+);

packages/back-end/src/api/environments/environments.router.ts

@@ -0,0 +1,14 @@
+import { Router } from "express";
+import { listEnvironments } from "./listEnvironments";
+import { putEnvironment } from "./putEnvironment";
+import { postEnvironment } from "./postEnvironment";
+import { deleteEnvironment } from "./deleteEnvironment";
+
+const router = Router();
+
+router.get("/", listEnvironments);
+router.post("/", postEnvironment);
+router.put("/:id", putEnvironment);
+router.delete("/:id", deleteEnvironment);
+
+export default router;

packages/back-end/src/api/environments/listEnvironments.ts

@@ -0,0 +1,33 @@
+import { ListEnvironmentsResponse } from "../../../types/openapi";
+import { createApiRequestHandler } from "../../util/handler";
+import { listEnvironmentsValidator } from "../../validators/openapi";
+
+export const listEnvironments = createApiRequestHandler(
+  listEnvironmentsValidator
+)(
+  async (req): Promise<ListEnvironmentsResponse> => {
+    const environments = (
+      req.context.org.settings?.environments || []
+    ).filter((environment) =>
+      req.context.permissions.canReadMultiProjectResource(environment.projects)
+    );
+
+    return {
+      environments: environments.map(
+        ({
+          id,
+          description = "",
+          toggleOnList = false,
+          defaultState = false,
+          projects = [],
+        }) => ({
+          id,
+          projects,
+          description,
+          defaultState,
+          toggleOnList,
+        })
+      ),
+    };
+  }
+);

packages/back-end/src/api/environments/postEnvironment.ts

@@ -0,0 +1,46 @@
+import { PostEnvironmentResponse } from "../../../types/openapi";
+import { createApiRequestHandler } from "../../util/handler";
+import { postEnvironmentValidator } from "../../validators/openapi";
+import { updateOrganization } from "../../models/OrganizationModel";
+import { OrganizationInterface } from "../../../types/organization";
+import { auditDetailsCreate } from "../../services/audit";
+import { validatePayload } from "./validations";
+
+export const postEnvironment = createApiRequestHandler(
+  postEnvironmentValidator
+)(
+  async (req): Promise<PostEnvironmentResponse> => {
+    const environment = await validatePayload(req.context, req.body);
+
+    const org = req.context.org;
+
+    if (org.settings?.environments?.some((env) => env.id === environment.id)) {
+      throw Error(`Environment ${environment.id} already exists!`);
+    }
+
+    if (!req.context.permissions.canCreateOrUpdateEnvironment(environment))
+      req.context.permissions.throwPermissionError();
+
+    const updates: Partial<OrganizationInterface> = {
+      settings: {
+        ...org.settings,
+        environments: [...(org.settings?.environments || []), environment],
+      },
+    };
+
+    await updateOrganization(org.id, updates);
+
+    await req.audit({
+      event: "environment.create",
+      entity: {
+        object: "environment",
+        id: environment.id,
+      },
+      details: auditDetailsCreate(environment),
+    });
+
+    return {
+      environment,
+    };
+  }
+);