@oneuptime/common 7.0.3129 → 7.0.3139

package/Models/AnalyticsModels/AnalyticsBaseModel/AnalyticsBaseModel.ts

@@ -1,3 +1,4 @@
+import EnableRealtimeEventsOn from "../../../Types/Realtime/EnableRealtimeEventsOn";
 import Route from "../../../Types/API/Route";
 import AnalyticsTableEngine from "../../../Types/AnalyticsDatabase/AnalyticsTableEngine";
 import AnalyticsTableColumn from "../../../Types/AnalyticsDatabase/TableColumn";
@@ -19,7 +20,6 @@ import Permission, {
   UserTenantAccessPermission,
 } from "../../../Types/Permission";
 import Text from "../../../Types/Text";
-import { EnableRealtimeEventsOn } from "../../../Utils/Realtime";
 import CommonModel from "./CommonModel";
 
 export type AnalyticsBaseModelType = { new (): AnalyticsBaseModel };

package/Models/AnalyticsModels/Index.ts

@@ -6,7 +6,7 @@ import Span from "./Span";
 import TelemetryAttribute from "./TelemetryAttribute";
 import ExceptionInstance from "./ExceptionInstance";
 
-const AnalyticsModels: Array<typeof AnalyticsBaseModel> = [
+const AnalyticsModels: Array<{ new (): AnalyticsBaseModel }> = [
   Log,
   Span,
   Metric,
@@ -15,4 +15,31 @@ const AnalyticsModels: Array<typeof AnalyticsBaseModel> = [
   ExceptionInstance,
 ];
 
+const modelTypeMap: { [key: string]: { new (): AnalyticsBaseModel } } = {};
+
+type GetModelTypeByName = (
+  tableName: string,
+) => (new () => AnalyticsBaseModel) | null;
+
+export const getModelTypeByName: GetModelTypeByName = (
+  tableName: string,
+): (new () => AnalyticsBaseModel) | null => {
+  if (modelTypeMap[tableName]) {
+    return modelTypeMap[tableName] || null;
+  }
+
+  const modelType: { new (): AnalyticsBaseModel } | undefined =
+    AnalyticsModels.find((modelType: { new (): AnalyticsBaseModel }) => {
+      return new modelType().tableName === tableName;
+    });
+
+  if (!modelType) {
+    return null;
+  }
+
+  modelTypeMap[tableName] = modelType;
+
+  return modelType;
+};
+
 export default AnalyticsModels;

package/Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel.ts

@@ -1,3 +1,4 @@
+import EnableRealtimeEventsOn from "../../../Types/Realtime/EnableRealtimeEventsOn";
 import Route from "../../../Types/API/Route";
 import { ColumnAccessControl } from "../../../Types/BaseDatabase/AccessControl";
 import ColumnBillingAccessControl from "../../../Types/BaseDatabase/ColumnBillingAccessControl";
@@ -122,6 +123,9 @@ export default class DatabaseBaseModel extends BaseEntity {
   public singularName!: string | null;
   public pluralName!: string | null;
 
+  // realtime events.
+  public enableRealtimeEventsOn!: EnableRealtimeEventsOn | null;
+
   // total items  by
   public totalItemsByColumnName!: string | null;
   public totalItemsNumber!: number | null;

package/Models/DatabaseModels/Incident.ts

@@ -94,6 +94,11 @@ export interface TelemetryIncidentQuery {
   pluralName: "Incidents",
   icon: IconProp.Alert,
   tableDescription: "Manage incidents for your project",
+  enableRealtimeEventsOn: {
+    create: true,
+    update: true,
+    delete: true,
+  },
 })
 export default class Incident extends BaseModel {
   @ColumnAccessControl({

package/Models/DatabaseModels/Index.ts

@@ -141,7 +141,11 @@ import ScheduledMaintenanceTemplate from "./ScheduledMaintenanceTemplate";
 import ScheduledMaintenanceTemplateOwnerTeam from "./ScheduledMaintenanceTemplateOwnerTeam";
 import ScheduledMaintenanceTemplateOwnerUser from "./ScheduledMaintenanceTemplateOwnerUser";
 
-export default [
+import BaseModel from "./DatabaseBaseModel/DatabaseBaseModel";
+
+const AllModelTypes: Array<{
+  new (): BaseModel;
+}> = [
   User,
   Probe,
   Project,
@@ -302,3 +306,33 @@ export default [
 
   TelemetryException,
 ];
+
+const modelTypeMap: { [key: string]: { new (): BaseModel } } = {};
+
+type GetModelTypeByNameFunction = (
+  tableName: string,
+) => { new (): BaseModel } | null;
+
+export const getModelTypeByName: GetModelTypeByNameFunction = (
+  tableName: string,
+): { new (): BaseModel } | null => {
+  if (modelTypeMap[tableName]) {
+    return modelTypeMap[tableName] || null;
+  }
+
+  const modelType: { new (): BaseModel } | undefined = AllModelTypes.find(
+    (modelType: { new (): BaseModel }) => {
+      return new modelType().tableName === tableName;
+    },
+  );
+
+  if (!modelType) {
+    return null;
+  }
+
+  modelTypeMap[tableName] = modelType;
+
+  return modelType;
+};
+
+export default AllModelTypes;

package/Server/Middleware/ProjectAuthorization.ts

@@ -1,4 +1,3 @@
-import AccessTokenService from "../Services/AccessTokenService";
 import ApiKeyService from "../Services/ApiKeyService";
 import GlobalConfigService from "../Services/GlobalConfigService";
 import UserService from "../Services/UserService";
@@ -18,6 +17,7 @@ import UserType from "Common/Types/UserType";
 import ApiKey from "Common/Models/DatabaseModels/ApiKey";
 import GlobalConfig from "Common/Models/DatabaseModels/GlobalConfig";
 import User from "Common/Models/DatabaseModels/User";
+import APIKeyAccessPermission from "../Utils/APIKey/AccessPermission";
 
 export default class ProjectMiddleware {
   public static getProjectId(req: ExpressRequest): ObjectID | null {
@@ -94,10 +94,12 @@ export default class ProjectMiddleware {
           // (req as OneUptimeRequest).permissions =
           //     apiKeyModel.permissions || [];
           (req as OneUptimeRequest).userGlobalAccessPermission =
-            await AccessTokenService.getDefaultApiGlobalPermission(tenantId);
+            await APIKeyAccessPermission.getDefaultApiGlobalPermission(
+              tenantId,
+            );
 
           const userTenantAccessPermission: UserTenantAccessPermission | null =
-            await AccessTokenService.getApiTenantAccessPermission(
+            await APIKeyAccessPermission.getApiTenantAccessPermission(
               tenantId,
               apiKeyModel.id!,
             );

package/Server/Middleware/UserAuthorization.ts

@@ -31,6 +31,7 @@ import {
 } from "Common/Types/Permission";
 import UserType from "Common/Types/UserType";
 import Project from "Common/Models/DatabaseModels/Project";
+import UserPermissionUtil from "../Utils/UserPermission/UserPermission";
 
 export default class UserMiddleware {
   /*
@@ -40,11 +41,35 @@ export default class UserMiddleware {
    * Returns: 401: User is unauthorized since unauthorized token was present.
    */
 
-  public static getAccessToken(req: ExpressRequest): string | undefined {
+  public static getAccessTokenFromCookie(
+    req: ExpressRequest,
+  ): string | undefined {
+    let accessToken: string | undefined = undefined;
+
+    if (
+      CookieUtil.getCookieFromExpressRequest(req, CookieUtil.getUserTokenKey())
+    ) {
+      accessToken = CookieUtil.getCookieFromExpressRequest(
+        req,
+        CookieUtil.getUserTokenKey(),
+      );
+    }
+
+    return accessToken;
+  }
+
+  public static getAccessTokenFromExpressRequest(
+    req: ExpressRequest,
+  ): string | undefined {
     let accessToken: string | undefined = undefined;
 
-    if (CookieUtil.getCookie(req, CookieUtil.getUserTokenKey())) {
-      accessToken = CookieUtil.getCookie(req, CookieUtil.getUserTokenKey());
+    if (
+      CookieUtil.getCookieFromExpressRequest(req, CookieUtil.getUserTokenKey())
+    ) {
+      accessToken = CookieUtil.getCookieFromExpressRequest(
+        req,
+        CookieUtil.getUserTokenKey(),
+      );
     }
 
     return accessToken;
@@ -130,7 +155,8 @@ export default class UserMiddleware {
       );
     }
 
-    const accessToken: string | undefined = UserMiddleware.getAccessToken(req);
+    const accessToken: string | undefined =
+      UserMiddleware.getAccessTokenFromExpressRequest(req);
 
     if (!accessToken) {
       oneuptimeRequest.userType = UserType.Public;
@@ -202,6 +228,7 @@ export default class UserMiddleware {
             new ObjectID(userId),
             userGlobalAccessPermission.projectIds,
           );
+
         if (userTenantAccessPermission) {
           oneuptimeRequest.userTenantAccessPermission =
             userTenantAccessPermission;
@@ -340,7 +367,7 @@ export default class UserMiddleware {
       ) {
         // Add default permissions.
         userTenantAccessPermission =
-          AccessTokenService.getDefaultUserTenantAccessPermission(projectId);
+          UserPermissionUtil.getDefaultUserTenantAccessPermission(projectId);
       } else {
         // get project level permissions if projectid exists in request.
         userTenantAccessPermission =

package/Server/Services/AccessTokenService.ts

@@ -1,26 +1,20 @@
 import GlobalCache from "../Infrastructure/GlobalCache";
 import QueryHelper from "../Types/Database/QueryHelper";
-import ApiKeyPermissionService from "./ApiKeyPermissionService";
 import BaseService from "./BaseService";
 import TeamMemberService from "./TeamMemberService";
 import TeamPermissionService from "./TeamPermissionService";
 import LIMIT_MAX from "../../Types/Database/LimitMax";
-import { JSONObject } from "../../Types/JSON";
 import ObjectID from "../../Types/ObjectID";
 import Permission, {
   UserGlobalAccessPermission,
   UserPermission,
   UserTenantAccessPermission,
 } from "../../Types/Permission";
-import APIKeyPermission from "Common/Models/DatabaseModels/ApiKeyPermission";
 import Label from "Common/Models/DatabaseModels/Label";
 import TeamMember from "Common/Models/DatabaseModels/TeamMember";
 import TeamPermission from "Common/Models/DatabaseModels/TeamPermission";
-
-enum PermissionNamespace {
-  GlobalPermission = "global-permissions",
-  ProjectPermission = "project-permissions",
-}
+import UserPermissionUtil from "../Utils/UserPermission/UserPermission";
+import PermissionNamespace from "../Types/Permission/PermissionNamespace";
 
 export class AccessTokenService extends BaseService {
   public constructor() {
@@ -65,104 +59,6 @@ export class AccessTokenService extends BaseService {
     }
   }
 
-  public async getDefaultApiGlobalPermission(
-    projectId: ObjectID,
-  ): Promise<UserGlobalAccessPermission> {
-    return {
-      projectIds: [projectId],
-      globalPermissions: [
-        Permission.Public,
-        Permission.User,
-        Permission.CurrentUser,
-      ],
-      _type: "UserGlobalAccessPermission",
-    };
-  }
-
-  public async getMasterKeyApiGlobalPermission(
-    projectId: ObjectID,
-  ): Promise<UserGlobalAccessPermission> {
-    return {
-      projectIds: [projectId],
-      globalPermissions: [
-        Permission.Public,
-        Permission.User,
-        Permission.CurrentUser,
-        Permission.ProjectOwner,
-      ],
-      _type: "UserGlobalAccessPermission",
-    };
-  }
-
-  public async getMasterApiTenantAccessPermission(
-    projectId: ObjectID,
-  ): Promise<UserTenantAccessPermission> {
-    const userPermissions: Array<UserPermission> = [];
-
-    userPermissions.push({
-      permission: Permission.ProjectOwner,
-      labelIds: [],
-      _type: "UserPermission",
-    });
-
-    const permission: UserTenantAccessPermission =
-      this.getDefaultUserTenantAccessPermission(projectId);
-
-    permission.permissions = permission.permissions.concat(userPermissions);
-
-    return permission;
-  }
-
-  public async getApiTenantAccessPermission(
-    projectId: ObjectID,
-    apiKeyId: ObjectID,
-  ): Promise<UserTenantAccessPermission> {
-    // get team permissions.
-    const apiKeyPermission: Array<APIKeyPermission> =
-      await ApiKeyPermissionService.findBy({
-        query: {
-          apiKeyId: apiKeyId,
-        },
-        select: {
-          permission: true,
-          labels: {
-            _id: true,
-          },
-          isBlockPermission: true,
-        },
-
-        limit: LIMIT_MAX,
-        skip: 0,
-        props: {
-          isRoot: true,
-        },
-      });
-
-    const userPermissions: Array<UserPermission> = [];
-
-    for (const apiPermission of apiKeyPermission) {
-      if (!apiPermission.labels) {
-        apiPermission.labels = [];
-      }
-
-      userPermissions.push({
-        permission: apiPermission.permission!,
-        labelIds: apiPermission.labels.map((label: Label) => {
-          return label.id!;
-        }),
-        isBlockPermission: apiPermission.isBlockPermission,
-        _type: "UserPermission",
-      });
-    }
-
-    const permission: UserTenantAccessPermission =
-      this.getDefaultUserTenantAccessPermission(projectId);
-
-    permission.permissions = permission.permissions.concat(userPermissions);
-
-    return permission;
-  }
-
   public async refreshUserGlobalAccessPermission(
     userId: ObjectID,
   ): Promise<UserGlobalAccessPermission> {
@@ -207,53 +103,17 @@ export class AccessTokenService extends BaseService {
     return permissionToStore;
   }
 
-  public getDefaultUserTenantAccessPermission(
-    projectId: ObjectID,
-  ): UserTenantAccessPermission {
-    const userPermissions: Array<UserPermission> = [];
-
-    userPermissions.push({
-      permission: Permission.CurrentUser,
-      labelIds: [],
-      isBlockPermission: false,
-      _type: "UserPermission",
-    });
-
-    userPermissions.push({
-      permission: Permission.UnAuthorizedSsoUser,
-      labelIds: [],
-      isBlockPermission: false,
-      _type: "UserPermission",
-    });
-
-    const permission: UserTenantAccessPermission = {
-      projectId,
-      permissions: userPermissions,
-      isBlockPermission: false,
-      _type: "UserTenantAccessPermission",
-    };
-
-    return permission;
-  }
-
   public async getUserGlobalAccessPermission(
     userId: ObjectID,
   ): Promise<UserGlobalAccessPermission | null> {
-    const json: JSONObject | null = await GlobalCache.getJSONObject(
-      "user",
-      userId.toString(),
-    );
+    const json: UserGlobalAccessPermission | null =
+      await UserPermissionUtil.getUserGlobalAccessPermissionFromCache(userId);
 
     if (!json) {
       return await this.refreshUserGlobalAccessPermission(userId);
     }
 
-    const accessPermission: UserGlobalAccessPermission =
-      json as UserGlobalAccessPermission;
-
-    accessPermission._type = "UserGlobalAccessPermission";
-
-    return accessPermission;
+    return json;
   }
 
   public async refreshUserTenantAccessPermission(
@@ -325,7 +185,7 @@ export class AccessTokenService extends BaseService {
     }
 
     const permission: UserTenantAccessPermission =
-      this.getDefaultUserTenantAccessPermission(projectId);
+      UserPermissionUtil.getDefaultUserTenantAccessPermission(projectId);
 
     permission.permissions = permission.permissions.concat(userPermissions);
 
@@ -343,14 +203,10 @@ export class AccessTokenService extends BaseService {
     projectId: ObjectID,
   ): Promise<UserTenantAccessPermission | null> {
     const json: UserTenantAccessPermission | null =
-      (await GlobalCache.getJSONObject(
-        PermissionNamespace.ProjectPermission,
-        userId.toString() + projectId.toString(),
-      )) as UserTenantAccessPermission;
-
-    if (json) {
-      json._type = "UserTenantAccessPermission";
-    }
+      await UserPermissionUtil.getUserTenantAccessPermissionFromCache(
+        userId,
+        projectId,
+      );
 
     if (!json) {
       return await this.refreshUserTenantAccessPermission(userId, projectId);

package/Server/Services/AnalyticsDatabaseService.ts

@@ -47,12 +47,12 @@ import PositiveNumber from "../../Types/PositiveNumber";
 import Text from "../../Types/Text";
 import Typeof from "../../Types/Typeof";
 import API from "Common/Utils/API";
-import { ModelEventType } from "Common/Utils/Realtime";
 import { Stream } from "node:stream";
 import AggregateBy from "../Types/AnalyticsDatabase/AggregateBy";
 import AggregatedResult from "../../Types/BaseDatabase/AggregatedResult";
 import Sort from "../Types/AnalyticsDatabase/Sort";
 import AggregatedModel from "../../Types/BaseDatabase/AggregatedModel";
+import ModelEventType from "../../Types/Realtime/ModelEventType";
 
 export default class AnalyticsDatabaseService<
   TBaseModel extends AnalyticsBaseModel,
@@ -967,7 +967,7 @@ export default class AnalyticsDatabaseService<
 
             promises.push(
               Realtime.emitModelEvent({
-                model: item,
+                modelId: item.id!,
                 tenantId: tenantId,
                 eventType: ModelEventType.Create,
                 modelType: this.modelType,

package/Server/Services/DatabaseService.ts

@@ -60,6 +60,8 @@ import API from "Common/Utils/API";
 import Slug from "Common/Utils/Slug";
 import { DataSource, Repository, SelectQueryBuilder } from "typeorm";
 import { FindWhere } from "../../Types/BaseDatabase/Query";
+import Realtime from "../Utils/Realtime";
+import ModelEventType from "../../Types/Realtime/ModelEventType";
 
 class DatabaseService<TBaseModel extends BaseModel> extends BaseService {
   public modelType!: { new (): TBaseModel };
@@ -516,7 +518,58 @@ class DatabaseService<TBaseModel extends BaseModel> extends BaseService {
     return data;
   }
 
-  public async onTrigger(
+  public async onTriggerRealtime(
+    modelId: ObjectID,
+    projectId: ObjectID,
+    modelEventType: ModelEventType,
+  ): Promise<void> {
+    logger.debug("Realtime Events Enabled");
+    logger.debug(this.model.enableRealtimeEventsOn);
+
+    if (Realtime.isInitialized() && this.model.enableRealtimeEventsOn) {
+      logger.debug("Emitting realtime event");
+      let shouldEmitEvent: boolean = false;
+
+      if (
+        this.model.enableRealtimeEventsOn.create &&
+        modelEventType === ModelEventType.Create
+      ) {
+        shouldEmitEvent = true;
+      }
+
+      if (
+        this.model.enableRealtimeEventsOn.update &&
+        modelEventType === ModelEventType.Update
+      ) {
+        shouldEmitEvent = true;
+      }
+
+      if (
+        this.model.enableRealtimeEventsOn.delete &&
+        modelEventType === ModelEventType.Delete
+      ) {
+        shouldEmitEvent = true;
+      }
+
+      if (!shouldEmitEvent) {
+        logger.debug("Realtime event not enabled for this event type");
+        return;
+      }
+
+      logger.debug("Emitting realtime event");
+      Realtime.emitModelEvent({
+        tenantId: projectId,
+        eventType: modelEventType,
+        modelId: modelId,
+        modelType: this.modelType,
+      }).catch((err: Error) => {
+        logger.error("Cannot emit realtime event");
+        logger.error(err);
+      });
+    }
+  }
+
+  public async onTriggerWorkflow(
     id: ObjectID,
     projectId: ObjectID,
     triggerType: DatabaseTriggerType,
@@ -629,7 +682,16 @@ class DatabaseService<TBaseModel extends BaseModel> extends BaseService {
         }
 
         if (tenantId) {
-          await this.onTrigger(createBy.data.id!, tenantId, "on-create");
+          await this.onTriggerWorkflow(
+            createBy.data.id!,
+            tenantId,
+            "on-create",
+          );
+          await this.onTriggerRealtime(
+            createBy.data.id!,
+            tenantId,
+            ModelEventType.Create,
+          );
         }
       }
 
@@ -1031,7 +1093,12 @@ class DatabaseService<TBaseModel extends BaseModel> extends BaseService {
             }
 
             if (tenantId) {
-              await this.onTrigger(item.id!, tenantId, "on-delete");
+              await this.onTriggerWorkflow(item.id!, tenantId, "on-delete");
+              await this.onTriggerRealtime(
+                item.id!,
+                tenantId,
+                ModelEventType.Delete,
+              );
             }
           }
         }
@@ -1337,9 +1404,15 @@ class DatabaseService<TBaseModel extends BaseModel> extends BaseService {
           }
 
           if (tenantId) {
-            await this.onTrigger(item.id!, tenantId, "on-update", {
+            await this.onTriggerWorkflow(item.id!, tenantId, "on-update", {
               updatedFields: JSONFunctions.serialize(data as JSONObject),
             });
+
+            await this.onTriggerRealtime(
+              item.id!,
+              tenantId,
+              ModelEventType.Update,
+            );
           }
         }
       }

package/Server/Services/StatusPageService.ts

@@ -313,7 +313,7 @@ export class Service extends DatabaseService<StatusPage> {
   ): Promise<boolean> {
     try {
       // token decode.
-      const token: string | undefined = CookieUtil.getCookie(
+      const token: string | undefined = CookieUtil.getCookieFromExpressRequest(
         req,
         CookieUtil.getUserTokenKey(statusPageId),
       );

package/Server/Types/Permission/PermissionNamespace.ts

@@ -0,0 +1,6 @@
+enum PermissionNamespace {
+  GlobalPermission = "global-permissions",
+  ProjectPermission = "project-permissions",
+}
+
+export default PermissionNamespace;