@oneuptime/common 11.3.20 → 11.3.22

package/Server/API/GlobalConfigAPI.ts

@@ -5,6 +5,7 @@ import {
   ExpressRequest,
   ExpressResponse,
   NextFunction,
+  OneUptimeRequest,
 } from "../Utils/Express";
 import Response from "../Utils/Response";
 import BaseAPI from "./BaseAPI";
@@ -16,7 +17,8 @@ import API from "../../Utils/API";
 import HTTPErrorResponse from "../../Types/API/HTTPErrorResponse";
 import HTTPResponse from "../../Types/API/HTTPResponse";
 import PartialEntity from "../../Types/Database/PartialEntity";
-import { EnterpriseLicenseValidationUrl } from "../EnvironmentConfig";
+import { EnterpriseLicenseValidationUrl, Host } from "../EnvironmentConfig";
+import EnterpriseLicenseInstanceSummary from "../../Types/EnterpriseLicense/EnterpriseLicenseInstanceSummary";
 import UserMiddleware from "../Middleware/UserAuthorization";
 
 export default class GlobalConfigAPI extends BaseAPI<
@@ -54,6 +56,7 @@ export default class GlobalConfigAPI extends BaseAPI<
 
     this.router.get(
       `${new this.entityType().getCrudApiPath()?.toString()}/license`,
+      UserMiddleware.getUserMiddleware,
       async (req: ExpressRequest, res: ExpressResponse, next: NextFunction) => {
         try {
           const config: GlobalConfig | null =
@@ -67,19 +70,42 @@ export default class GlobalConfigAPI extends BaseAPI<
                 enterpriseLicenseUserLimit: true,
                 enterpriseLicenseCurrentUserCount: true,
                 enterpriseLicenseUserCountUpdatedAt: true,
+                enterpriseLicenseInstances: true,
+                instanceId: true,
               },
               props: {
                 isRoot: true,
               },
             });
 
+          /*
+           * This route also serves the login page (before sign-in), so it
+           * cannot require authentication outright. Anonymous callers only
+           * get enough to render the edition pill — the license key, token
+           * and instance topology require a signed-in user.
+           */
+          const isAuthenticatedUser: boolean = Boolean(
+            (req as OneUptimeRequest).userAuthorization?.userId,
+          );
+
+          const licenseValid: boolean = Boolean(
+            config?.enterpriseLicenseToken &&
+              config?.enterpriseLicenseExpiresAt &&
+              config.enterpriseLicenseExpiresAt.getTime() > Date.now(),
+          );
+
           const responseBody: JSONObject = {
             companyName: config?.enterpriseCompanyName || null,
             expiresAt: config?.enterpriseLicenseExpiresAt
               ? config.enterpriseLicenseExpiresAt.toISOString()
               : null,
-            licenseKey: config?.enterpriseLicenseKey || null,
-            token: config?.enterpriseLicenseToken || null,
+            licenseKey: isAuthenticatedUser
+              ? config?.enterpriseLicenseKey || null
+              : null,
+            token: isAuthenticatedUser
+              ? config?.enterpriseLicenseToken || null
+              : null,
+            licenseValid: licenseValid,
             userLimit:
               typeof config?.enterpriseLicenseUserLimit === "number"
                 ? config.enterpriseLicenseUserLimit
@@ -91,6 +117,15 @@ export default class GlobalConfigAPI extends BaseAPI<
             userCountUpdatedAt: config?.enterpriseLicenseUserCountUpdatedAt
               ? config.enterpriseLicenseUserCountUpdatedAt.toISOString()
               : null,
+            instances:
+              isAuthenticatedUser &&
+              Array.isArray(config?.enterpriseLicenseInstances)
+                ? config.enterpriseLicenseInstances
+                : [],
+            instanceId:
+              isAuthenticatedUser && config?.instanceId
+                ? config.instanceId.toString()
+                : null,
           };
 
           return Response.sendJsonObjectResponse(req, res, responseBody);
@@ -112,12 +147,38 @@ export default class GlobalConfigAPI extends BaseAPI<
             throw new BadDataException("License key is required");
           }
 
+          const globalConfigId: ObjectID = ObjectID.getZeroObjectID();
+
+          const existingConfig: GlobalConfig | null =
+            await GlobalConfigService.findOneById({
+              id: globalConfigId,
+              select: {
+                _id: true,
+                instanceId: true,
+              },
+              props: {
+                isRoot: true,
+                ignoreHooks: true,
+              },
+            });
+
+          /*
+           * Send this instance's id and host along with the key so the
+           * license server registers this instance against the license and
+           * it shows up in the instance list on all instances that share
+           * the license.
+           */
+          const instanceId: ObjectID =
+            existingConfig?.instanceId || ObjectID.generate();
+
           const validationResponse:
             | HTTPResponse<JSONObject>
             | HTTPErrorResponse = await API.post<JSONObject>({
             url: EnterpriseLicenseValidationUrl,
             data: {
               licenseKey,
+              instanceId: instanceId.toString(),
+              host: Host,
             },
           });
 
@@ -178,6 +239,13 @@ export default class GlobalConfigAPI extends BaseAPI<
             }
           }
 
+          const instances: Array<EnterpriseLicenseInstanceSummary> =
+            Array.isArray(payload["instances"])
+              ? (payload[
+                  "instances"
+                ] as Array<EnterpriseLicenseInstanceSummary>)
+              : [];
+
           const updatePayload: PartialEntity<GlobalConfig> = {
             enterpriseCompanyName: companyNameRaw || null,
             enterpriseLicenseKey: licenseKeyRaw || null,
@@ -186,21 +254,13 @@ export default class GlobalConfigAPI extends BaseAPI<
             enterpriseLicenseUserLimit: userLimit,
             enterpriseLicenseCurrentUserCount: currentUserCount,
             enterpriseLicenseUserCountUpdatedAt: userCountUpdatedAt,
+            enterpriseLicenseInstances: instances,
           };
 
-          const globalConfigId: ObjectID = ObjectID.getZeroObjectID();
-
-          const existingConfig: GlobalConfig | null =
-            await GlobalConfigService.findOneById({
-              id: globalConfigId,
-              select: {
-                _id: true,
-              },
-              props: {
-                isRoot: true,
-                ignoreHooks: true,
-              },
-            });
+          if (!existingConfig?.instanceId) {
+            // Installs that predate instance ids: persist the one we generated.
+            updatePayload.instanceId = instanceId;
+          }
 
           if (existingConfig) {
             await GlobalConfigService.updateOneById({
@@ -244,6 +304,9 @@ export default class GlobalConfigAPI extends BaseAPI<
                 userCountUpdatedAt;
             }
 
+            newConfig.enterpriseLicenseInstances = instances;
+            newConfig.instanceId = instanceId;
+
             await GlobalConfigService.create({
               data: newConfig,
               props: {
@@ -263,6 +326,8 @@ export default class GlobalConfigAPI extends BaseAPI<
             userCountUpdatedAt: userCountUpdatedAt
               ? userCountUpdatedAt.toISOString()
               : null,
+            instances: instances,
+            instanceId: instanceId.toString(),
           });
         } catch (err) {
           next(err);