@oneuptime/common 7.0.4372 → 7.0.4395

package/Models/AnalyticsModels/AnalyticsBaseModel/AnalyticsBaseModel.ts

@@ -140,13 +140,6 @@ export default class AnalyticsBaseModel extends CommonModel {
     this.crudApiPath = data.crudApiPath;
     this.enableRealtimeEventsOn = data.enableRealtimeEventsOn;
     this.partitionKey = data.partitionKey;
-
-    // initialize Arrays.
-    for (const column of this.tableColumns) {
-      if (column.type === TableColumnType.NestedModel) {
-        this.setColumnValue(column.key, []);
-      }
-    }
   }
 
   private _enableWorkflowOn: EnableWorkflowOn | undefined;

package/Models/AnalyticsModels/AnalyticsBaseModel/CommonModel.ts

@@ -207,19 +207,6 @@ export default class CommonModel {
         return;
       }
 
-      if (recordValue instanceof Array) {
-        if (recordValue.length > 0 && column.nestedModelType) {
-          json[column.key] = CommonModel.toJSONArray(
-            recordValue as Array<CommonModel>,
-            column.nestedModelType,
-          );
-        } else {
-          json[column.key] = recordValue;
-        }
-
-        return;
-      }
-
       json[column.key] = recordValue;
     });
 

package/Models/DatabaseModels/Monitor.ts

@@ -531,7 +531,7 @@ export default class Monitor extends BaseModel {
     ],
   })
   @TableColumn({
-    type: TableColumnType.JSON,
+    type: TableColumnType.MonitorSteps,
     required: false,
     title: "Monitor Steps",
     description: "What would you like to monitor and what is the criteria?",

package/Server/Middleware/ProjectAuthorization.ts

@@ -67,7 +67,7 @@ export default class ProjectMiddleware {
     next: NextFunction,
   ): Promise<void> {
     try {
-      const tenantId: ObjectID | null = this.getProjectId(req);
+      let tenantId: ObjectID | null = this.getProjectId(req);
 
       const apiKey: ObjectID | null = this.getApiKey(req);
 
@@ -81,19 +81,27 @@ export default class ProjectMiddleware {
 
       let apiKeyModel: ApiKey | null = null;
 
-      if (tenantId) {
+      if (apiKey) {
         apiKeyModel = await ApiKeyService.findOneBy({
           query: {
-            projectId: tenantId,
             apiKey: apiKey,
             expiresAt: QueryHelper.greaterThan(OneUptimeDate.getCurrentDate()),
           },
           select: {
             _id: true,
+            projectId: true,
           },
           props: { isRoot: true },
         });
 
+        tenantId = apiKeyModel?.projectId || null;
+
+        if (!tenantId) {
+          throw new BadDataException(
+            "Project ID not found for the provided API Key.",
+          );
+        }
+
         if (apiKeyModel) {
           (req as OneUptimeRequest).userType = UserType.API;
           // TODO: Add API key permissions.

package/Server/Services/OpenTelemetryIngestService.ts

@@ -125,18 +125,22 @@ export default class OTelIngestService {
 
     const newDbMetric: Metric = Metric.fromJSON(
       dbMetric.toJSON(),
-      Metric,
+      Metric
     ) as Metric;
 
-    newDbMetric.startTimeUnixNano = datapoint["startTimeUnixNano"] as number;
-    newDbMetric.startTime = OneUptimeDate.fromUnixNano(
-      datapoint["startTimeUnixNano"] as number,
-    );
+    if (datapoint["startTimeUnixNano"]) {
+      newDbMetric.startTimeUnixNano = datapoint["startTimeUnixNano"] as number;
+      newDbMetric.startTime = OneUptimeDate.fromUnixNano(
+        datapoint["startTimeUnixNano"] as number
+      );
+    }
 
-    newDbMetric.timeUnixNano = datapoint["timeUnixNano"] as number;
-    newDbMetric.time = OneUptimeDate.fromUnixNano(
-      datapoint["timeUnixNano"] as number,
-    );
+    if (datapoint["timeUnixNano"]) {
+      newDbMetric.timeUnixNano = datapoint["timeUnixNano"] as number;
+      newDbMetric.time = OneUptimeDate.fromUnixNano(
+        datapoint["timeUnixNano"] as number
+      );
+    }
 
     if (Object.keys(datapoint).includes("asInt")) {
       newDbMetric.value = datapoint["asInt"] as number;

package/Server/Utils/AnalyticsDatabase/Statement.ts

@@ -169,7 +169,6 @@ export class Statement implements BaseQueryParams {
       [TableColumnType.Decimal]: "Double",
       [TableColumnType.Date]: "DateTime",
       [TableColumnType.JSON]: "JSON",
-      [TableColumnType.NestedModel]: "Nested",
       [TableColumnType.ArrayNumber]: "Array(Int32)",
       [TableColumnType.ArrayText]: "Array(String)",
       [TableColumnType.LongNumber]: "Int128",

package/Server/Utils/AnalyticsDatabase/StatementGenerator.ts

@@ -53,12 +53,18 @@ export default class StatementGenerator<TBaseModel extends AnalyticsBaseModel> {
     const whereStatement: Statement = this.toWhereStatement(updateBy.query);
 
     /* eslint-disable prettier/prettier */
-        const statement: Statement = SQL`
-            ALTER TABLE ${this.database.getDatasourceOptions().database!}.${this.model.tableName
+    const statement: Statement = SQL`
+            ALTER TABLE ${this.database.getDatasourceOptions().database!}.${
+              this.model.tableName
             }
-            UPDATE `.append(setStatement).append(SQL`
-            WHERE TRUE `).append(whereStatement);
-        /* eslint-enable prettier/prettier */
+            UPDATE `
+      .append(setStatement)
+      .append(
+        SQL`
+            WHERE TRUE `
+      )
+      .append(whereStatement);
+    /* eslint-enable prettier/prettier */
 
     logger.debug(`${this.model.tableName} Update Statement`);
     logger.debug(statement);
@@ -71,27 +77,7 @@ export default class StatementGenerator<TBaseModel extends AnalyticsBaseModel> {
   ): Array<string> {
     const columnNames: Array<string> = [];
     for (const column of tableColumns) {
-      if (column.type === TableColumnType.NestedModel) {
-        // Example of nested model query:
-
-        /**
-                 * 
-                 * INSERT INTO opentelemetry_spans (trace_id, span_id, attributes.key, attributes.value) VALUES 
-                    ('trace1', 'span1', ['key1', 'key2'], ['value1', 'value2']),
-                    ('trace2', 'span2', ['keyA', 'keyB'], ['valueA', 'valueB']);
-                 */
-
-        // Nested Model Support.
-        const nestedModelColumnNames: Array<string> = this.getColumnNames(
-          column.nestedModel!.tableColumns,
-        );
-
-        for (const nestedModelColumnName of nestedModelColumnNames) {
-          columnNames.push(`${column.key}.${nestedModelColumnName}`);
-        }
-      } else {
-        columnNames.push(column.key);
-      }
+      columnNames.push(column.key);
     }
 
     return columnNames;
@@ -168,45 +154,12 @@ export default class StatementGenerator<TBaseModel extends AnalyticsBaseModel> {
     const record: Record = [];
 
     for (const column of item.getTableColumns()) {
-      if (column.type === TableColumnType.NestedModel) {
-        // Nested Model Support.
-
-        // THis is very werid, but the output should work in a query like this:
-
-        /**
-                 * 
-                 * INSERT INTO opentelemetry_spans (trace_id, span_id, attributes.key, attributes.value) VALUES 
-                    ('trace1', 'span1', ['key1', 'key2'], ['value1', 'value2']),
-                    ('trace2', 'span2', ['keyA', 'keyB'], ['valueA', 'valueB']);
-                 */
-
-        for (const subColumn of column.nestedModel!.tableColumns) {
-          const subRecord: Record = [];
-
-          for (const nestedModelItem of item.getColumnValue(
-            column.key,
-          ) as Array<CommonModel>) {
-            const value: RecordValue = this.sanitizeValue(
-              nestedModelItem.getColumnValue(subColumn.key),
-              subColumn,
-              {
-                isNestedModel: true,
-              },
-            );
-
-            subRecord.push(value);
-          }
-
-          record.push(subRecord);
-        }
-      } else {
-        const value: RecordValue | undefined = this.sanitizeValue(
-          item.getColumnValue(column.key),
-          column,
-        );
+      const value: RecordValue | undefined = this.sanitizeValue(
+        item.getColumnValue(column.key),
+        column,
+      );
 
-        record.push(value);
-      }
+      record.push(value);
     }
 
     return record;
@@ -625,16 +578,6 @@ export default class StatementGenerator<TBaseModel extends AnalyticsBaseModel> {
         columns.append(SQL`, `);
       }
 
-      let nestedModelColumns: Statement | null = null;
-
-      if (column.type === TableColumnType.NestedModel) {
-        nestedModelColumns = SQL`(`
-          .append(
-            this.toColumnsCreateStatement(column.nestedModel!.tableColumns),
-          )
-          .append(SQL`)`);
-      }
-
       // special case - ClickHouse does not support using an a query parameter
       // to specify the column name when creating the table
       const keyStatement: string = column.key;
@@ -649,10 +592,6 @@ export default class StatementGenerator<TBaseModel extends AnalyticsBaseModel> {
                 .append(this.toColumnType(column.type))
                 .append(SQL`)`),
         );
-
-      if (nestedModelColumns) {
-        columns.append(SQL` `).append(nestedModelColumns);
-      }
     }
 
     return columns;
@@ -672,26 +611,34 @@ export default class StatementGenerator<TBaseModel extends AnalyticsBaseModel> {
       "Array(String)": TableColumnType.ArrayText,
       "Array(Int32)": TableColumnType.ArrayNumber,
       JSON: TableColumnType.JSON, //JSONArray is also JSON
-      Nested: TableColumnType.NestedModel,
       Bool: TableColumnType.Boolean,
     }[clickhouseType];
   }
 
   public toColumnType(type: TableColumnType): Statement {
-    return {
+    const statement: Statement | undefined = {
       [TableColumnType.Text]: SQL`String`,
       [TableColumnType.ObjectID]: SQL`String`,
       [TableColumnType.Boolean]: SQL`Bool`,
       [TableColumnType.Number]: SQL`Int32`,
       [TableColumnType.Decimal]: SQL`Double`,
+      [TableColumnType.IP]: SQL`String`,
+      [TableColumnType.Port]: SQL`String`,
       [TableColumnType.Date]: SQL`DateTime`,
       [TableColumnType.JSON]: SQL`String`, // we use JSON as a string because ClickHouse has really good JSON support for string types
       [TableColumnType.JSONArray]: SQL`String`, // we use JSON as a string because ClickHouse has really good JSON support for string types
-      [TableColumnType.NestedModel]: SQL`Nested`,
       [TableColumnType.ArrayNumber]: SQL`Array(Int32)`,
       [TableColumnType.ArrayText]: SQL`Array(String)`,
       [TableColumnType.LongNumber]: SQL`Int128`,
     }[type];
+
+    if (!statement) {
+      throw new BadDataException(
+        `Unknown column type: ${type}. Please add support for this column type.`,
+      );
+    }
+
+    return statement;
   }
 
   public toDoesColumnExistStatement(columnName: string): string {

package/Server/Utils/OpenAPI.ts

@@ -2,6 +2,10 @@ import {
   OpenAPIRegistry,
   OpenApiGeneratorV3,
 } from "@asteasolutions/zod-to-openapi";
+import type {
+  ParameterObject,
+  ReferenceObject,
+} from "@asteasolutions/zod-to-openapi/dist/types";
 import DatabaseBaseModel from "../../Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
 import Models from "../../Models/DatabaseModels/Index";
 import AnalyticsBaseModel from "../../Models/AnalyticsModels/AnalyticsBaseModel/AnalyticsBaseModel";
@@ -196,11 +200,37 @@ export default class OpenAPIUtil {
           description: "API Server",
         },
       ],
-      tags: tags.sort((a: any, b: any) => {
-        return a.name.localeCompare(b.name);
-      }),
+      tags: tags.sort(
+        (
+          a: { name: string; description: string },
+          b: { name: string; description: string },
+        ) => {
+          return a.name.localeCompare(b.name);
+        },
+      ),
     }) as unknown as JSONObject;
 
+    // Add security schemes and global security requirement
+    if (!spec["components"]) {
+      spec["components"] = {};
+    }
+
+    (spec["components"] as JSONObject)["securitySchemes"] = {
+      ApiKeyAuth: {
+        type: "apiKey",
+        in: "header",
+        name: "APIKey",
+        description:
+          "API key for authentication. Required for all API requests.",
+      },
+    };
+
+    spec["security"] = [
+      {
+        ApiKeyAuth: [],
+      },
+    ];
+
     LocalCache.setJSON("openapi", "spec", spec as JSONObject);
 
     return spec;
@@ -227,6 +257,7 @@ export default class OpenAPIUtil {
       summary: `List ${singularModelName}`,
       description: `Endpoint to list all ${singularModelName} items`,
       tags: [singularModelName],
+      parameters: [...OpenAPIUtil.getDefaultApiHeaders()],
       requestBody: {
         required: false,
         content: {
@@ -286,6 +317,7 @@ export default class OpenAPIUtil {
       summary: `Count ${singularModelName}`,
       description: `Endpoint to count ${singularModelName} items`,
       tags: [singularModelName],
+      parameters: [...OpenAPIUtil.getDefaultApiHeaders()],
       requestBody: {
         required: false,
         content: {
@@ -451,7 +483,7 @@ export default class OpenAPIUtil {
       description: `Endpoint to retrieve a single ${singularModelName} by ID`,
       tags: [singularModelName],
       parameters: [
-        ...(OpenAPIUtil.getDefaultApiHeaders() as Array<any>),
+        ...OpenAPIUtil.getDefaultApiHeaders(),
         {
           name: "id",
           in: "path",
@@ -497,17 +529,10 @@ export default class OpenAPIUtil {
     });
   }
 
-  public static getDefaultApiHeaders(): Array<JSONObject> {
-    return [
-      {
-        name: "APIKey",
-        in: "header",
-        required: true,
-        schema: { type: "string" },
-        description: "API key for authentication",
-        example: "your-api-key-here",
-      },
-    ];
+  public static getDefaultApiHeaders(): Array<
+    ParameterObject | ReferenceObject
+  > {
+    return [];
   }
 
   public static generateUpdateApiSpec(data: {
@@ -536,7 +561,7 @@ export default class OpenAPIUtil {
       description: `Endpoint to update an existing ${singularModelName}`,
       tags: [singularModelName],
       parameters: [
-        ...(OpenAPIUtil.getDefaultApiHeaders() as Array<any>),
+        ...OpenAPIUtil.getDefaultApiHeaders(),
         {
           name: "id",
           in: "path",
@@ -607,7 +632,7 @@ export default class OpenAPIUtil {
       description: `Endpoint to delete a ${singularModelName}`,
       tags: [singularModelName],
       parameters: [
-        ...(OpenAPIUtil.getDefaultApiHeaders() as Array<any>),
+        ...OpenAPIUtil.getDefaultApiHeaders(),
         {
           name: "id",
           in: "path",
@@ -850,6 +875,7 @@ export default class OpenAPIUtil {
       summary: `List ${singularModelName}`,
       description: `Endpoint to list all ${singularModelName} items`,
       tags: [singularModelName],
+      parameters: [...OpenAPIUtil.getDefaultApiHeaders()],
       requestBody: {
         required: false,
         content: {
@@ -909,6 +935,7 @@ export default class OpenAPIUtil {
       summary: `Count ${singularModelName}`,
       description: `Endpoint to count ${singularModelName} items`,
       tags: [singularModelName],
+      parameters: [...OpenAPIUtil.getDefaultApiHeaders()],
       requestBody: {
         required: false,
         content: {
@@ -1033,7 +1060,7 @@ export default class OpenAPIUtil {
       description: `Endpoint to retrieve a single ${singularModelName} by ID`,
       tags: [singularModelName],
       parameters: [
-        ...(OpenAPIUtil.getDefaultApiHeaders() as Array<any>),
+        ...OpenAPIUtil.getDefaultApiHeaders(),
         {
           name: "id",
           in: "path",
@@ -1105,7 +1132,7 @@ export default class OpenAPIUtil {
       description: `Endpoint to update an existing ${singularModelName}`,
       tags: [singularModelName],
       parameters: [
-        ...(OpenAPIUtil.getDefaultApiHeaders() as Array<any>),
+        ...OpenAPIUtil.getDefaultApiHeaders(),
         {
           name: "id",
           in: "path",
@@ -1176,7 +1203,7 @@ export default class OpenAPIUtil {
       description: `Endpoint to delete a ${singularModelName}`,
       tags: [singularModelName],
       parameters: [
-        ...(OpenAPIUtil.getDefaultApiHeaders() as Array<any>),
+        ...OpenAPIUtil.getDefaultApiHeaders(),
         {
           name: "id",
           in: "path",

package/Server/Utils/StartServer.ts

@@ -198,9 +198,9 @@ const init: InitFunction = async (
     app.use(`/${appName}`, ExpressStatic("/usr/src/app/public"));
 
     app.get(
-      `/${appName}/dist/bundle.js`,
+      `/${appName}/dist/Index.js`,
       (_req: ExpressRequest, res: ExpressResponse) => {
-        res.sendFile("/usr/src/app/public/dist/bundle.js");
+        res.sendFile("/usr/src/app/public/dist/Index.js");
       },
     );
 

package/Tests/Server/Utils/AnalyticsDatabase/StatementGenerator.test.ts

@@ -8,7 +8,6 @@ import StatementGenerator from "../../../../Server/Utils/AnalyticsDatabase/State
 import logger from "../../../../Server/Utils/Logger";
 import "../../TestingUtils/Init";
 import AnalyticsBaseModel from "../../../../Models/AnalyticsModels/AnalyticsBaseModel/AnalyticsBaseModel";
-import NestedModel from "../../../../Models/AnalyticsModels/AnalyticsBaseModel/NestedModel";
 import Route from "../../../../Types/API/Route";
 import AnalyticsTableEngine from "../../../../Types/AnalyticsDatabase/AnalyticsTableEngine";
 import AnalyticsTableColumn from "../../../../Types/AnalyticsDatabase/TableColumn";
@@ -238,54 +237,6 @@ describe("StatementGenerator", () => {
       );
     });
 
-    test("should support nested models", () => {
-      class TestNestedModel extends NestedModel {
-        public constructor() {
-          super({
-            tableColumns: [
-              new AnalyticsTableColumn({
-                key: "nested_column_1",
-                title: "<title>",
-                description: "<description>",
-                required: true,
-                type: TableColumnType.Text,
-              }),
-              new AnalyticsTableColumn({
-                key: "nested_column_2",
-                title: "<title>",
-                description: "<description>",
-                required: false,
-                type: TableColumnType.Number,
-              }),
-            ],
-          });
-        }
-      }
-
-      const statement: Statement = generator.toColumnsCreateStatement([
-        new AnalyticsTableColumn({
-          key: "column_1",
-          title: "<title>",
-          description: "<description>",
-          required: true,
-          type: TableColumnType.Text,
-        }),
-        new AnalyticsTableColumn({
-          key: "column_2",
-          title: "<title>",
-          description: "<description>",
-          required: false,
-          type: TableColumnType.NestedModel,
-          nestedModelType: TestNestedModel,
-        }),
-      ]);
-
-      expectStatement(
-        statement,
-        SQL`column_1 String, column_2 Nullable(Nested) (nested_column_1 String, nested_column_2 Nullable(Int32))`,
-      );
-    });
-
     test("should not add NULL|NOT NULL to Array types", () => {
       const statement: Statement = generator.toColumnsCreateStatement([
         new AnalyticsTableColumn({

package/Types/AnalyticsDatabase/TableColumn.ts

@@ -1,4 +1,3 @@
-import NestedModel from "../../Models/AnalyticsModels/AnalyticsBaseModel/NestedModel";
 import TableColumnType from "../AnalyticsDatabase/TableColumnType";
 import { ColumnAccessControl } from "../BaseDatabase/AccessControl";
 import ColumnBillingAccessControl from "../BaseDatabase/ColumnBillingAccessControl";
@@ -104,25 +103,8 @@ export default class AnalyticsTableColumn {
     this._accessControl = v;
   }
 
-  private _nestedModel?: NestedModel | undefined;
-  public get nestedModel(): NestedModel | undefined {
-    return this._nestedModel;
-  }
-  public set nestedModel(v: NestedModel | undefined) {
-    this._nestedModel = v;
-  }
-
-  private _nestedModelType?: { new (): NestedModel } | undefined;
-  public get nestedModelType(): { new (): NestedModel } | undefined {
-    return this._nestedModelType;
-  }
-  public set nestedModelType(v: { new (): NestedModel } | undefined) {
-    this._nestedModelType = v;
-  }
-
   public constructor(data: {
     key: string;
-    nestedModelType?: { new (): NestedModel } | undefined;
     title: string;
     description: string;
     required: boolean;
@@ -136,10 +118,6 @@ export default class AnalyticsTableColumn {
       | (() => Date | string | number | boolean)
       | undefined;
   }) {
-    if (data.type === TableColumnType.NestedModel && !data.nestedModelType) {
-      throw new Error("NestedModel is required when type is NestedModel");
-    }
-
     this.accessControl = data.accessControl;
     this.key = data.key;
     this.title = data.title;
@@ -152,9 +130,5 @@ export default class AnalyticsTableColumn {
     this.billingAccessControl = data.billingAccessControl;
     this.allowAccessIfSubscriptionIsUnpaid =
       data.allowAccessIfSubscriptionIsUnpaid || false;
-    if (data.nestedModelType) {
-      this.nestedModel = new data.nestedModelType();
-      this.nestedModelType = data.nestedModelType;
-    }
   }
 }

package/Types/AnalyticsDatabase/TableColumnType.ts

@@ -4,13 +4,14 @@ enum ColumnType {
   Boolean = "Boolean",
   Number = "Number",
   Text = "Text",
-  NestedModel = "Nested Model",
   JSON = "JSON",
   JSONArray = "JSON Array",
   Decimal = "Decimal",
   ArrayNumber = "Array of Numbers",
   ArrayText = "Array of Text",
   LongNumber = "Long Number",
+  IP = "IP",
+  Port = "Port",
 }
 
 export default ColumnType;

package/Types/Database/TableColumnType.ts

@@ -14,6 +14,7 @@ enum ColumnType {
   ShortURL = "Short URL",
   Markdown = "Markdown",
   Domain = "Domain",
+  MonitorSteps = "Monitor Steps",
   LongURL = "URL",
   ShortText = "Text",
   OTP = "One Time Password",
@@ -38,6 +39,8 @@ enum ColumnType {
   CustomFieldType = "Custom Field Type",
   MonitorType = "Monitor Type",
   WorkflowStatus = "Workflow Status",
+  IP = "IP",
+  Port = "Port",
 }
 
 export default ColumnType;

package/Types/GenericFunction.ts

@@ -1,4 +1,4 @@
-// eslint-disable-next-line @typescript-eslint/ban-types
+// eslint-disable-next-line @typescript-eslint/no-restricted-types
 type GenericFunction = Function;
 
 export default GenericFunction;

package/Types/GenericObject.ts

@@ -1,4 +1,4 @@
-// eslint-disable-next-line @typescript-eslint/ban-types
+// eslint-disable-next-line @typescript-eslint/no-restricted-types
 type GenericObject = Object;
 
 export default GenericObject;

package/Types/Object.ts

@@ -1,2 +1,2 @@
-// eslint-disable-next-line @typescript-eslint/ban-types
+// eslint-disable-next-line @typescript-eslint/no-restricted-types
 export type GlobalObject = object;