Environments for Features (growthbook#236)

Author: jdorn

packages/back-end/src/controllers/config.ts

@@ -27,7 +27,7 @@ export async function getExperimentConfig(
   const { key } = req.params;
 
   try {
-    const organization = await lookupOrganizationByApiKey(key);
+    const { organization } = await lookupOrganizationByApiKey(key);
     if (!organization) {
       return res.status(400).json({
         status: 400,
@@ -89,7 +89,7 @@ export async function getExperimentsScript(
   const { key } = req.params;
 
   try {
-    const organization = await lookupOrganizationByApiKey(key);
+    const { organization } = await lookupOrganizationByApiKey(key);
     if (!organization) {
       return res
         .status(400)

packages/back-end/src/controllers/features.ts

@@ -17,15 +17,15 @@ export async function getFeaturesPublic(req: Request, res: Response) {
   const { key } = req.params;
 
   try {
-    const organization = await lookupOrganizationByApiKey(key);
+    const { organization, environment } = await lookupOrganizationByApiKey(key);
     if (!organization) {
       return res.status(400).json({
         status: 400,
         error: "Invalid API key",
       });
     }
 
-    const features = await getFeatureDefinitions(organization);
+    const features = await getFeatureDefinitions(organization, environment);
 
     // Cache for 30 seconds, serve stale up to 1 hour (10 hours if origin is down)
     res.set(
@@ -69,6 +69,7 @@ export async function postFeatures(
     description: "",
     project: "",
     rules: [],
+    environments: ["dev"],
     ...otherProps,
     dateCreated: new Date(),
     dateUpdated: new Date(),
@@ -135,7 +136,8 @@ export async function putFeature(
     updates.defaultValue !== feature.defaultValue
   ) {
     requiresWebhook = true;
-  } else if ("rules" in updates) {
+  }
+  if ("rules" in updates) {
     if (updates.rules?.length !== feature.rules?.length) {
       requiresWebhook = true;
     } else {
@@ -153,6 +155,11 @@ export async function putFeature(
       });
     }
   }
+  if ("environments" in updates) {
+    if (updates.environments?.length !== feature.environments?.length) {
+      requiresWebhook = true;
+    }
+  }
 
   await updateFeature(feature.organization, id, {
     ...updates,

packages/back-end/src/controllers/organizations.ts

@@ -1066,7 +1066,7 @@ export async function getApiKeys(req: AuthRequest, res: Response) {
 }
 
 export async function postApiKey(
-  req: AuthRequest<{ description?: string }>,
+  req: AuthRequest<{ description?: string; environment: string }>,
   res: Response
 ) {
   const { org } = getOrgFromReq(req);
@@ -1077,9 +1077,11 @@ export async function postApiKey(
     });
   }
 
+  const { description, environment } = req.body;
+
   const { preferExisting } = req.query as { preferExisting?: string };
   if (preferExisting) {
-    const existing = await getFirstApiKey(org.id);
+    const existing = await getFirstApiKey(org.id, environment);
     if (existing) {
       return res.status(200).json({
         status: 200,
@@ -1088,9 +1090,7 @@ export async function postApiKey(
     }
   }
 
-  const { description } = req.body;
-
-  const key = await createApiKey(org.id, description);
+  const key = await createApiKey(org.id, environment, description);
 
   res.status(200).json({
     status: 200,

packages/back-end/src/jobs/webhooks.ts

@@ -29,7 +29,10 @@ export default function (ag: Agenda) {
     const { overrides, expIdMapping } = await getExperimentOverrides(
       webhook.organization
     );
-    const features = await getFeatureDefinitions(webhook.organization);
+    const features = await getFeatureDefinitions(
+      webhook.organization,
+      "production"
+    );
     const payload = JSON.stringify({
       timestamp: Math.floor(Date.now() / 1000),
       overrides,

packages/back-end/src/models/ApiKeyModel.ts

@@ -6,6 +6,7 @@ const apiKeySchema = new mongoose.Schema({
     type: String,
     unique: true,
   },
+  environment: String,
   description: String,
   organization: String,
   dateCreated: Date,

packages/back-end/src/models/FeatureModel.ts

@@ -11,6 +11,7 @@ const featureSchema = new mongoose.Schema({
   dateUpdated: Date,
   valueType: String,
   defaultValue: String,
+  environments: [String],
   rules: [
     {
       _id: false,

packages/back-end/src/services/apiKey.ts

@@ -4,14 +4,18 @@ import md5 from "md5";
 
 export async function createApiKey(
   organization: string,
+  environment: string,
   description?: string
 ): Promise<string> {
-  const key = "key_" + md5(uniqid()).substr(0, 16);
+  const envPrefix = environment === "production" ? "prod" : environment;
+
+  const key = "key_" + envPrefix + "_" + md5(uniqid()).substr(0, 16);
 
   await ApiKeyModel.create({
     organization,
     key,
     description,
+    environment,
     dateCreated: new Date(),
   });
 
@@ -31,13 +35,14 @@ export async function deleteByOrganizationAndApiKey(
 
 export async function lookupOrganizationByApiKey(
   key: string
-): Promise<string | null> {
+): Promise<{ organization?: string; environment?: string }> {
   const doc = await ApiKeyModel.findOne({
     key,
   });
 
-  if (!doc) return null;
-  return doc.organization || null;
+  if (!doc || !doc.organization) return {};
+  const { organization, environment } = doc;
+  return { organization, environment };
 }
 
 export async function getAllApiKeysByOrganization(organization: string) {
@@ -46,8 +51,12 @@ export async function getAllApiKeysByOrganization(organization: string) {
   });
 }
 
-export async function getFirstApiKey(organization: string) {
+export async function getFirstApiKey(
+  organization: string,
+  environment: string
+) {
   return ApiKeyModel.findOne({
     organization,
+    environment,
   });
 }

packages/back-end/src/services/features.ts

@@ -17,11 +17,19 @@ function getJSONValue(type: FeatureValueType, value: string): any {
   if (type === "boolean") return value === "false" ? false : true;
   return null;
 }
-export async function getFeatureDefinitions(organization: string) {
+export async function getFeatureDefinitions(
+  organization: string,
+  environment?: string
+) {
   const features = await getAllFeatures(organization);
 
   const defs: Record<string, FeatureDefinition> = {};
   features.forEach((feature) => {
+    if (environment && !feature.environments?.includes(environment)) {
+      defs[feature.id] = { defaultValue: null };
+      return;
+    }
+
     defs[feature.id] = {
       defaultValue: getJSONValue(feature.valueType, feature.defaultValue),
       rules:

packages/back-end/types/apikey.d.ts

@@ -1,5 +1,6 @@
 export interface ApiKeyInterface {
   key: string;
+  environment?: string;
   description?: string;
   organization: string;
   dateCreated: Date;

packages/back-end/types/feature.d.ts

@@ -10,6 +10,7 @@ export interface FeatureInterface {
   dateCreated: Date;
   dateUpdated: Date;
   valueType: FeatureValueType;
+  environments: string[];
   defaultValue: string;
   rules?: FeatureRule[];
 }