@oneuptime/common 11.5.13 → 11.6.1

package/Models/AnalyticsModels/AnalyticsBaseModel/AnalyticsBaseModel.ts

@@ -77,6 +77,15 @@ export default class AnalyticsBaseModel extends CommonModel {
     materializedViews?: Array<MaterializedView> | undefined;
     enableMCP?: boolean | undefined;
     ttlExpression?: string | undefined; // e.g. "retentionDate DELETE"
+    /*
+     * Generic event/entity tables carry `_id` and `createdAt`. Derived
+     * AggregatingMergeTree targets do not represent independently-addressable
+     * rows: their identity is exactly their aggregation key, and an arbitrary
+     * creation timestamp has no stable meaning after merges. Those models set
+     * this false so ClickHouse can enforce that every non-key column is an
+     * aggregate measure. Defaults true for backward compatibility.
+     */
+    includeBaseColumns?: boolean | undefined;
     /*
      * Column that `findBy` falls back to when the caller doesn't
      * specify a `sort`. Defaults to `createdAt` (matching the legacy
@@ -100,31 +109,39 @@ export default class AnalyticsBaseModel extends CommonModel {
       this.tableEngine = data.tableEngine;
     }
 
-    columns.push(
-      new AnalyticsTableColumn({
-        key: "_id",
-        title: "ID",
-        description: "ID of this object",
-        required: true,
-        type: TableColumnType.ObjectID,
-        /*
-         * Ids are UUIDv7 (time-ordered — see ObjectID.generateTimeOrdered),
-         * so consecutive rows share their 48-bit timestamp prefix and ZSTD
-         * compresses them well; random v4 ids were incompressible.
-         */
-        codec: { codec: "ZSTD", level: 1 },
-      }),
-    );
+    if (data.includeBaseColumns !== false) {
+      columns.push(
+        new AnalyticsTableColumn({
+          key: "_id",
+          title: "ID",
+          description: "ID of this object",
+          required: true,
+          type: TableColumnType.ObjectID,
+          /*
+           * Ids are UUIDv7 (time-ordered — see ObjectID.generateTimeOrdered),
+           * so consecutive rows share their 48-bit timestamp prefix and ZSTD
+           * compresses them well; random v4 ids were incompressible.
+           */
+          codec: { codec: "ZSTD", level: 1 },
+        }),
+      );
 
-    columns.push(
-      new AnalyticsTableColumn({
-        key: "createdAt",
-        title: "Created",
-        description: "Date and Time when the object was created.",
-        required: true,
-        type: TableColumnType.Date,
-      }),
-    );
+      columns.push(
+        new AnalyticsTableColumn({
+          key: "createdAt",
+          title: "Created",
+          description: "Date and Time when the object was created.",
+          required: true,
+          type: TableColumnType.Date,
+        }),
+      );
+    }
+
+    if (data.includeBaseColumns === false && !data.defaultSortColumn) {
+      throw new BadDataException(
+        "defaultSortColumn is required when includeBaseColumns is false because createdAt is not part of the table schema",
+      );
+    }
 
     if (!data.primaryKeys || data.primaryKeys.length === 0) {
       throw new BadDataException("Primary keys are required");

package/Models/AnalyticsModels/MetricBaselineHourly.ts

@@ -234,6 +234,8 @@ GROUP BY projectId, name, primaryEntityId, day, hourOfWeek`,
       tableSettings:
         "ttl_only_drop_parts = 1, non_replicated_deduplication_window = 10000",
       ttlExpression: "day + INTERVAL 90 DAY",
+      includeBaseColumns: false,
+      defaultSortColumn: "day",
     });
   }
 }

package/Models/AnalyticsModels/MetricItemAggMV1m.ts

@@ -110,9 +110,10 @@ export default class MetricItemAggMV1m extends AnalyticsBaseModel {
       key: "retentionDate",
       title: "Retention Date",
       description:
-        "Date after which this row is eligible for TTL deletion. Computed by the MV as max(retentionDate) per bucket — inherits from the source MetricItemV3 rows.",
+        "Latest date after which this aggregate bucket is eligible for TTL deletion. Stored as SimpleAggregateFunction(max, DateTime) so partial rows keep the maximum expiry when AggregatingMergeTree merges them.",
       required: true,
       type: TableColumnType.Date,
+      simpleAggregateFunction: "max",
     });
 
     super({
@@ -156,7 +157,7 @@ SELECT
   countState(toFloat64(coalesce(value, sum, 0))) AS valueCountState,
   minState(toFloat64(coalesce(value, sum, 0))) AS valueMinState,
   maxState(toFloat64(coalesce(value, sum, 0))) AS valueMaxState,
-  max(retentionDate) AS retentionDate
+  maxSimpleState(retentionDate) AS retentionDate
 FROM MetricItemV3
 GROUP BY projectId, name, primaryEntityId, bucketTime`,
         },
@@ -172,6 +173,8 @@ GROUP BY projectId, name, primaryEntityId, bucketTime`,
       tableSettings:
         "ttl_only_drop_parts = 1, non_replicated_deduplication_window = 10000",
       ttlExpression: "retentionDate DELETE",
+      includeBaseColumns: false,
+      defaultSortColumn: "bucketTime",
     });
   }
 }

package/Models/AnalyticsModels/MetricItemAggMV1mByContainer.ts

@@ -111,9 +111,10 @@ export default class MetricItemAggMV1mByContainer extends AnalyticsBaseModel {
       key: "retentionDate",
       title: "Retention Date",
       description:
-        "Date after which this row is eligible for TTL deletion. Computed by the MV as max(retentionDate) per bucket — inherits from the source MetricItemV3 rows.",
+        "Latest date after which this aggregate bucket is eligible for TTL deletion. Stored as SimpleAggregateFunction(max, DateTime) so partial rows keep the maximum expiry when AggregatingMergeTree merges them.",
       required: true,
       type: TableColumnType.Date,
+      simpleAggregateFunction: "max",
     });
 
     super({
@@ -159,7 +160,7 @@ SELECT
   countState(toFloat64(coalesce(value, sum, 0))) AS valueCountState,
   minState(toFloat64(coalesce(value, sum, 0))) AS valueMinState,
   maxState(toFloat64(coalesce(value, sum, 0))) AS valueMaxState,
-  max(retentionDate) AS retentionDate
+  maxSimpleState(retentionDate) AS retentionDate
 FROM MetricItemV3
 WHERE containerEntityKey != ''
 GROUP BY projectId, name, containerEntityKey, bucketTime`,
@@ -173,6 +174,8 @@ GROUP BY projectId, name, containerEntityKey, bucketTime`,
       tableSettings:
         "ttl_only_drop_parts = 1, non_replicated_deduplication_window = 10000",
       ttlExpression: "retentionDate DELETE",
+      includeBaseColumns: false,
+      defaultSortColumn: "bucketTime",
     });
   }
 }

package/Models/AnalyticsModels/MetricItemAggMV1mByHostV2.ts

@@ -114,9 +114,10 @@ export default class MetricItemAggMV1mByHostV2 extends AnalyticsBaseModel {
       key: "retentionDate",
       title: "Retention Date",
       description:
-        "Date after which this row is eligible for TTL deletion. Computed by the MV as max(retentionDate) per bucket — inherits from the source MetricItemV3 rows.",
+        "Latest date after which this aggregate bucket is eligible for TTL deletion. Stored as SimpleAggregateFunction(max, DateTime) so partial rows keep the maximum expiry when AggregatingMergeTree merges them.",
       required: true,
       type: TableColumnType.Date,
+      simpleAggregateFunction: "max",
     });
 
     super({
@@ -162,7 +163,7 @@ SELECT
   countState(toFloat64(coalesce(value, sum, 0))) AS valueCountState,
   minState(toFloat64(coalesce(value, sum, 0))) AS valueMinState,
   maxState(toFloat64(coalesce(value, sum, 0))) AS valueMaxState,
-  max(retentionDate) AS retentionDate
+  maxSimpleState(retentionDate) AS retentionDate
 FROM MetricItemV3
 WHERE hostEntityKey != ''
 GROUP BY projectId, name, hostEntityKey, bucketTime`,
@@ -176,6 +177,8 @@ GROUP BY projectId, name, hostEntityKey, bucketTime`,
       tableSettings:
         "ttl_only_drop_parts = 1, non_replicated_deduplication_window = 10000",
       ttlExpression: "retentionDate DELETE",
+      includeBaseColumns: false,
+      defaultSortColumn: "bucketTime",
     });
   }
 }

package/Models/AnalyticsModels/MetricItemAggMV1mByK8sCluster.ts

@@ -110,9 +110,10 @@ export default class MetricItemAggMV1mByK8sCluster extends AnalyticsBaseModel {
       key: "retentionDate",
       title: "Retention Date",
       description:
-        "Date after which this row is eligible for TTL deletion. Computed by the MV as max(retentionDate) per bucket — inherits from the source MetricItemV3 rows.",
+        "Latest date after which this aggregate bucket is eligible for TTL deletion. Stored as SimpleAggregateFunction(max, DateTime) so partial rows keep the maximum expiry when AggregatingMergeTree merges them.",
       required: true,
       type: TableColumnType.Date,
+      simpleAggregateFunction: "max",
     });
 
     super({
@@ -160,7 +161,7 @@ SELECT
   countState(toFloat64(coalesce(value, sum, 0))) AS valueCountState,
   minState(toFloat64(coalesce(value, sum, 0))) AS valueMinState,
   maxState(toFloat64(coalesce(value, sum, 0))) AS valueMaxState,
-  max(retentionDate) AS retentionDate
+  maxSimpleState(retentionDate) AS retentionDate
 FROM MetricItemV3
 WHERE k8sClusterEntityKey != ''
 GROUP BY projectId, name, k8sClusterEntityKey, bucketTime`,
@@ -174,6 +175,8 @@ GROUP BY projectId, name, k8sClusterEntityKey, bucketTime`,
       tableSettings:
         "ttl_only_drop_parts = 1, non_replicated_deduplication_window = 10000",
       ttlExpression: "retentionDate DELETE",
+      includeBaseColumns: false,
+      defaultSortColumn: "bucketTime",
     });
   }
 }

package/Models/AnalyticsModels/MetricItemAggMV1mByService.ts

@@ -112,9 +112,10 @@ export default class MetricItemAggMV1mByService extends AnalyticsBaseModel {
       key: "retentionDate",
       title: "Retention Date",
       description:
-        "Date after which this row is eligible for TTL deletion. Computed by the MV as max(retentionDate) per bucket — inherits from the source MetricItemV3 rows.",
+        "Latest date after which this aggregate bucket is eligible for TTL deletion. Stored as SimpleAggregateFunction(max, DateTime) so partial rows keep the maximum expiry when AggregatingMergeTree merges them.",
       required: true,
       type: TableColumnType.Date,
+      simpleAggregateFunction: "max",
     });
 
     super({
@@ -160,7 +161,7 @@ SELECT
   countState(toFloat64(coalesce(value, sum, 0))) AS valueCountState,
   minState(toFloat64(coalesce(value, sum, 0))) AS valueMinState,
   maxState(toFloat64(coalesce(value, sum, 0))) AS valueMaxState,
-  max(retentionDate) AS retentionDate
+  maxSimpleState(retentionDate) AS retentionDate
 FROM MetricItemV3
 WHERE serviceEntityKey != ''
 GROUP BY projectId, name, serviceEntityKey, bucketTime`,
@@ -174,6 +175,8 @@ GROUP BY projectId, name, serviceEntityKey, bucketTime`,
       tableSettings:
         "ttl_only_drop_parts = 1, non_replicated_deduplication_window = 10000",
       ttlExpression: "retentionDate DELETE",
+      includeBaseColumns: false,
+      defaultSortColumn: "bucketTime",
     });
   }
 }

package/Models/DatabaseModels/EnterpriseLicense.ts

@@ -102,6 +102,27 @@ export default class EnterpriseLicense extends BaseModel {
   })
   public annualContractValue?: number = undefined;
 
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    required: true,
+    isDefaultValueColumn: true,
+    type: TableColumnType.Boolean,
+    title: "Evaluation License",
+    description:
+      "When enabled, this key is for evaluation and testing only — the customer's installation shows an evaluation notice and it is not meant for production use.",
+    defaultValue: false,
+  })
+  @Column({
+    nullable: false,
+    type: ColumnType.Boolean,
+    default: false,
+  })
+  public isEvaluationLicense?: boolean = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: [],

package/Models/DatabaseModels/EnterpriseLicenseInstance.ts

@@ -188,4 +188,29 @@ export default class EnterpriseLicenseInstance extends BaseModel {
     nullable: true,
   })
   public masterAdminEmails?: Array<string> = undefined;
+
+  /*
+   * Named oneuptimeVersion, not version: DatabaseBaseModel already declares a
+   * `version` @VersionColumn() (the optimistic-locking row revision) on every
+   * model, so a second `version` property would collide in the TypeORM entity
+   * metadata.
+   */
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.ShortText,
+    title: "OneUptime Version",
+    description:
+      "OneUptime version this instance last reported, for example 11.5.13. Lets support see which instances are running an outdated build.",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+  })
+  public oneuptimeVersion?: string = undefined;
 }

package/Models/DatabaseModels/GlobalConfig.ts

@@ -824,6 +824,25 @@ export default class GlobalConfig extends GlobalConfigModel {
   })
   public enterpriseLicenseToken?: string = undefined;
 
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.Boolean,
+    title: "Enterprise License Is Evaluation",
+    description:
+      "True when the validated enterprise license is an evaluation/testing license. Drives the evaluation notice shown in the edition modal.",
+    defaultValue: false,
+  })
+  @Column({
+    type: ColumnType.Boolean,
+    nullable: true,
+    default: false,
+  })
+  public enterpriseLicenseIsEvaluation?: boolean = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: [],
@@ -929,6 +948,63 @@ export default class GlobalConfig extends GlobalConfigModel {
   })
   public enterpriseLicenseExpiryReminderDays?: number = undefined;
 
+  /*
+   * The four latestRelease* columns cache the daily GitHub release check
+   * (Workers/Jobs/InstanceUpdate/CheckForNewVersion). They are a cache, not
+   * configuration: an air-gapped installation simply leaves them null and no
+   * update prompt is ever shown.
+   */
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.ShortText,
+    title: "Latest Release Version",
+    description:
+      "Latest OneUptime version published on GitHub, for example 11.6.0, as of the last update check. Null until the first successful check.",
+  })
+  @Column({
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+    nullable: true,
+  })
+  public latestReleaseVersion?: string = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.Date,
+    title: "Latest Release Published At",
+    description: "When the latest OneUptime version was published on GitHub.",
+  })
+  @Column({
+    type: ColumnType.Date,
+    nullable: true,
+  })
+  public latestReleasePublishedAt?: Date = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.Date,
+    title: "Latest Release Checked At",
+    description:
+      "When this installation last successfully checked GitHub for a newer OneUptime release.",
+  })
+  @Column({
+    type: ColumnType.Date,
+    nullable: true,
+  })
+  public latestReleaseCheckedAt?: Date = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: [],

package/Server/API/EnterpriseLicenseAPI.ts

@@ -5,6 +5,7 @@ import { JSONObject } from "../../Types/JSON";
 import PartialEntity from "../../Types/Database/PartialEntity";
 import EnterpriseLicenseInstanceSummary from "../../Types/EnterpriseLicense/EnterpriseLicenseInstanceSummary";
 import EnterpriseLicenseUsageUtil from "../../Utils/EnterpriseLicense/EnterpriseLicenseUsage";
+import VersionUtil from "../../Utils/VersionUtil";
 import LIMIT_MAX from "../../Types/Database/LimitMax";
 import ObjectID from "../../Types/ObjectID";
 import PositiveNumber from "../../Types/PositiveNumber";
@@ -29,6 +30,8 @@ export interface LicenseInstanceUpsert {
   licenseId: ObjectID;
   instanceId: string;
   host: string | undefined;
+  // OneUptime version the instance is running. Absent on instances too old to report it.
+  oneuptimeVersion?: string | null | undefined;
   // Usage fields are only set on report-user-count, not on validate.
   userCount?: number | undefined;
   userEmailHashes?: Array<string> | undefined;
@@ -84,6 +87,7 @@ export default class EnterpriseLicenseAPI extends BaseAPI<
                 userLimit: true,
                 currentUserCount: true,
                 userCountUpdatedAt: true,
+                isEvaluationLicense: true,
               },
               props: {
                 isRoot: true,
@@ -117,12 +121,16 @@ export default class EnterpriseLicenseAPI extends BaseAPI<
             req.body["instanceId"],
           );
           const instanceHost: string = this.parseShortText(req.body["host"]);
+          const instanceVersion: string | null | undefined = this.parseVersion(
+            req.body["version"],
+          );
 
           if (instanceId) {
             await this.upsertLicenseInstance({
               licenseId: license.id!,
               instanceId: instanceId,
               host: instanceHost || undefined,
+              oneuptimeVersion: instanceVersion,
             });
           }
 
@@ -154,6 +162,7 @@ export default class EnterpriseLicenseAPI extends BaseAPI<
             userCountUpdatedAt: license.userCountUpdatedAt
               ? license.userCountUpdatedAt.toISOString()
               : null,
+            isEvaluationLicense: Boolean(license.isEvaluationLicense),
             instances: this.getInstanceSummaries(instances),
             token,
           });
@@ -196,6 +205,7 @@ export default class EnterpriseLicenseAPI extends BaseAPI<
               select: {
                 _id: true,
                 userLimit: true,
+                isEvaluationLicense: true,
               },
               props: {
                 isRoot: true,
@@ -212,6 +222,9 @@ export default class EnterpriseLicenseAPI extends BaseAPI<
             req.body["instanceId"],
           );
           const instanceHost: string = this.parseShortText(req.body["host"]);
+          const instanceVersion: string | null | undefined = this.parseVersion(
+            req.body["version"],
+          );
           const userEmailHashes: Array<string> =
             EnterpriseLicenseUsageUtil.sanitizeUserEmailHashes(
               req.body["userEmailHashes"],
@@ -230,6 +243,7 @@ export default class EnterpriseLicenseAPI extends BaseAPI<
               licenseId: license.id!,
               instanceId: instanceId,
               host: instanceHost || undefined,
+              oneuptimeVersion: instanceVersion,
               userCount: userCount,
               userEmailHashes: userEmailHashes,
               masterAdminEmails: masterAdminEmails,
@@ -273,6 +287,7 @@ export default class EnterpriseLicenseAPI extends BaseAPI<
             userCountUpdatedAt: reportedAt.toISOString(),
             userLimit:
               typeof license.userLimit === "number" ? license.userLimit : null,
+            isEvaluationLicense: Boolean(license.isEvaluationLicense),
             instances: this.getInstanceSummaries(instances),
           });
         } catch (err) {
@@ -290,6 +305,31 @@ export default class EnterpriseLicenseAPI extends BaseAPI<
     return value.trim().substring(0, 100);
   }
 
+  /*
+   * report-user-count is unauthenticated, so the reported version is only
+   * stored when it is a version we could actually compare against a release —
+   * garbage never reaches the admin dashboard or the customer's modal.
+   *
+   * Three outcomes, and the callers depend on the distinction:
+   *   undefined — the instance sent no version at all (it predates this
+   *               field). Leave whatever is stored alone.
+   *   null      — it sent something, but not a version. Clear the stored
+   *               value, so an instance rolled back to a build with no
+   *               APP_VERSION stops advertising the version it used to run.
+   *   string    — a valid, canonical version to store.
+   */
+  private parseVersion(value: unknown): string | null | undefined {
+    if (value === undefined || value === null) {
+      return undefined;
+    }
+
+    /*
+     * Canonicalized rather than passed through, so the stored string is never
+     * something the UIs would render with a doubled "v".
+     */
+    return VersionUtil.canonicalize(value);
+  }
+
   private async findLicenseInstances(
     licenseId: ObjectID,
   ): Promise<Array<EnterpriseLicenseInstance>> {
@@ -304,6 +344,7 @@ export default class EnterpriseLicenseAPI extends BaseAPI<
         userCount: true,
         userEmailHashes: true,
         lastReportedAt: true,
+        oneuptimeVersion: true,
       },
       sort: {
         createdAt: SortOrder.Ascending,
@@ -331,6 +372,7 @@ export default class EnterpriseLicenseAPI extends BaseAPI<
           lastReportedAt: instance.lastReportedAt
             ? instance.lastReportedAt.toISOString()
             : null,
+          version: instance.oneuptimeVersion || null,
         };
       },
     );
@@ -370,6 +412,11 @@ export default class EnterpriseLicenseAPI extends BaseAPI<
       newInstance.host = data.host;
     }
 
+    // Null means "reported something that is not a version" — nothing to store.
+    if (data.oneuptimeVersion) {
+      newInstance.oneuptimeVersion = data.oneuptimeVersion;
+    }
+
     if (data.userCount !== undefined) {
       newInstance.userCount = data.userCount;
     }
@@ -434,6 +481,16 @@ export default class EnterpriseLicenseAPI extends BaseAPI<
       updateData.host = data.host;
     }
 
+    /*
+     * Null clears the column: an instance rebuilt onto a build with no
+     * APP_VERSION must stop advertising the version it used to run, because
+     * lastReportedAt is refreshed on the same request and would otherwise
+     * read as "confirmed running v11.5.13 as of today".
+     */
+    if (data.oneuptimeVersion !== undefined) {
+      updateData.oneuptimeVersion = data.oneuptimeVersion;
+    }
+
     if (data.userCount !== undefined) {
       updateData.userCount = data.userCount;
     }