@oneuptime/common 13.0.5 → 13.0.6

package/Models/DatabaseModels/NetworkDeviceDiscoveryScan.ts

@@ -56,6 +56,21 @@ export interface DiscoveredNetworkDevice {
    * screen or a name column.
    */
   dnsHostname?: string | undefined;
+  /*
+   * The host's NetBIOS name, lower-cased, from a node status (NBSTAT) query
+   * the probe sent to UDP 137 (OneUptime issue #3677).
+   *
+   * Present only on scans with `isNetbiosLookupEnabled`, only for hosts that
+   * had neither a sysName nor a dnsHostname, only for private addresses and
+   * never from a global probe. Absent otherwise, and on every row stored
+   * before this field existed.
+   *
+   * SELF-REPORTED AND UNTRUSTED — more so than dnsHostname: it is whatever the
+   * machine at that address chose to answer, not even a record someone
+   * published. It is stored here verbatim in jsonb, so never render or store
+   * it without NetbiosNameUtil.normalizeNetbiosName.
+   */
+  netbiosName?: string | undefined;
   isAlreadyRegistered?: boolean | undefined;
   /*
    * False when the host answered ping but not SNMP — such hosts cannot be
@@ -575,6 +590,72 @@ export default class NetworkDeviceDiscoveryScan extends BaseModel {
   })
   public isSnmpEnabled?: boolean = undefined;
 
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.CreateNetworkDeviceDiscoveryScan,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.SettingsViewer,
+      Permission.ReadNetworkDeviceDiscoveryScan,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.EditNetworkDeviceDiscoveryScan,
+    ],
+  })
+  /*
+   * Name imported devices by the short hostname rather than the fully
+   * qualified one (OneUptime issue #3678): "wb-0660-kds01" instead of
+   * "wb-0660-kds01.wbhq.com". See ShortHostnameUtil for what counts as
+   * shortenable and why it is the first label rather than a typed suffix.
+   *
+   * A NAMING choice, not a sweep one, and that decides where it lives:
+   *
+   *   - It is NOT in NetworkDeviceDiscoveryScanService's SWEEP_COLUMNS.
+   *     Nothing the probe asks of a host changes, so flipping it must not
+   *     retire the run — the stored results are exactly as valid, and the
+   *     Review dialog simply names them differently the next time it opens.
+   *   - It is not sent to the probe. Names are decided where devices are
+   *     built: the dashboard's Review dialog and the auto-import rule engine,
+   *     both through DiscoveredDeviceBuilder.
+   *
+   * NOT NULL DEFAULT false. Every scan that existed before this column named
+   * devices by their full name, and a deploy must not start renaming what
+   * those scans import; a scan that wants short names says so. The full
+   * reverse-DNS name is stored on the device as `dnsName` either way.
+   */
+  @TableColumn({
+    isDefaultValueColumn: true,
+    required: false,
+    type: TableColumnType.Boolean,
+    canReadOnRelationQuery: true,
+    title: "Use Short Device Names",
+    description:
+      "Name imported devices by their short hostname (the first label of a fully qualified name, e.g. 'core-sw-01' rather than 'core-sw-01.corp.example.com'). The full reverse-DNS name is still stored on the device as its DNS Name.",
+    defaultValue: false,
+  })
+  @Column({
+    type: ColumnType.Boolean,
+    nullable: false,
+    default: false,
+  })
+  public useShortDeviceNames?: boolean = undefined;
+
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,
@@ -1035,6 +1116,76 @@ export default class NetworkDeviceDiscoveryScan extends BaseModel {
   })
   public statusMessage?: string = undefined;
 
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.CreateNetworkDeviceDiscoveryScan,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.SettingsViewer,
+      Permission.ReadNetworkDeviceDiscoveryScan,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.EditNetworkDeviceDiscoveryScan,
+    ],
+  })
+  /*
+   * Whether the probe asks hosts that are still unnamed after the sweep — no
+   * SNMP sysName, no reverse-DNS record — for their NetBIOS name (OneUptime
+   * issue #3677). This is what names the Windows machines that otherwise sit
+   * in the Review dialog as bare addresses.
+   *
+   * OPT-IN, NOT NULL DEFAULT false, because turning it on SENDS TRAFFIC: one
+   * UDP datagram to port 137 of each such host, plus one retry. NBSTAT sweeps
+   * are a textbook reconnaissance signature that IDS rules on PCI and other
+   * regulated networks alert on, so existing recurring scans must never start
+   * doing it on an upgrade, and an absent value (a probe polling a server too
+   * old to select this column) is read as off — the probe checks `=== true`.
+   *
+   * Guarded on the probe regardless of this value: queries go only to
+   * private and CGNAT IPv4 addresses (never public, loopback or link-local),
+   * and a global probe — one registered with REGISTER_PROBE_KEY — never sends
+   * them at all.
+   *
+   * Access control identical to isSnmpEnabled: it is the same kind of "what
+   * the scan asks of each host" choice, made by the same people.
+   *
+   * NOT a sweep column. It changes what is learned ABOUT hosts after the sweep,
+   * not which hosts are found, so toggling it must not retire a run's results
+   * the way changing the target or the SNMP setting does.
+   */
+  @TableColumn({
+    isDefaultValueColumn: true,
+    required: false,
+    type: TableColumnType.Boolean,
+    canReadOnRelationQuery: true,
+    title: "Look Up NetBIOS Names",
+    description:
+      "Whether hosts with no SNMP name and no reverse DNS record are asked for their NetBIOS name over UDP 137. Best-effort: Windows/Samba hosts that allow UDP 137 from the probe. Private addresses only; never done by global probes.",
+    defaultValue: false,
+  })
+  @Column({
+    type: ColumnType.Boolean,
+    nullable: false,
+    default: false,
+  })
+  public isNetbiosLookupEnabled?: boolean = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: [

package/Models/DatabaseModels/NetworkSiteAssignmentRule.ts

@@ -319,7 +319,7 @@ export default class NetworkSiteAssignmentRule extends RuleBaseModel {
     canReadOnRelationQuery: true,
     title: "Hostname Pattern",
     description:
-      "Devices whose hostname, SNMP system name or display name matches this wildcard pattern are assigned to the site",
+      "Devices whose hostname, SNMP system name, display name or DNS name matches this wildcard pattern are assigned to the site",
     example: "unit-1042-*",
   })
   @Column({

package/Models/DatabaseModels/Project.ts

@@ -2435,6 +2435,47 @@ export default class Project extends TenantModel {
   })
   public planName?: PlanType = undefined;
 
+  /*
+   * Where this project's data is meant to live, as a free-text label ("EU
+   * (Frankfurt)"). Only master admins set it, from the Admin Dashboard, and
+   * only on a server with billing enabled - see ProjectService, which trims
+   * it, stores a blank as null, and refuses a value when billing is off.
+   * Every project role can read it, because the customer's Project Settings
+   * shows it once it is set.
+   *
+   * create and update are deliberately empty: a master admin's write never
+   * reaches ColumnPermissions (UpdatePermission returns early on
+   * isMasterAdmin), so an empty list means "master admin only" rather than
+   * "nobody".
+   */
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadProject,
+      Permission.UnAuthorizedSsoUser,
+      Permission.ProjectUser,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.ShortText,
+    title: "Data Residency",
+    description:
+      "Where this project's data is hosted. Set by OneUptime staff on OneUptime Cloud.",
+    hideColumnInDocumentation: true,
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+  })
+  public dataResidency?: string = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: [],

package/Models/DatabaseModels/ScheduledMaintenancePublicNote.ts

@@ -558,6 +558,80 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
   })
   public subscriberNotificationStatusMessage?: string = undefined;
 
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ScheduledMaintenanceAdmin,
+      Permission.ScheduledMaintenanceMember,
+      Permission.ScheduledMaintenanceViewer,
+      Permission.ReadScheduledMaintenancePublicNote,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ScheduledMaintenanceAdmin,
+      Permission.ScheduledMaintenanceMember,
+      Permission.EditScheduledMaintenancePublicNote,
+    ],
+  })
+  @TableColumn({
+    computed: true,
+    hideColumnInDocumentation: true,
+    required: false,
+    type: TableColumnType.ShortText,
+    title: "Subscriber Notification Status on Note Updated",
+    description:
+      "Status of the notification sent to subscribers when this note was last updated. Empty until an update notification is requested.",
+  })
+  @Index()
+  @Column({
+    type: ColumnType.ShortText,
+    nullable: true,
+  })
+  public subscriberNotificationStatusOnNoteUpdated?: StatusPageSubscriberNotificationStatus =
+    undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ScheduledMaintenanceAdmin,
+      Permission.ScheduledMaintenanceMember,
+      Permission.ScheduledMaintenanceViewer,
+      Permission.ReadScheduledMaintenancePublicNote,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ScheduledMaintenanceAdmin,
+      Permission.ScheduledMaintenanceMember,
+      Permission.EditScheduledMaintenancePublicNote,
+    ],
+  })
+  @TableColumn({
+    computed: true,
+    hideColumnInDocumentation: true,
+    required: false,
+    type: TableColumnType.VeryLongText,
+    title: "Notification Status Message on Note Updated",
+    description:
+      "Status message for the notification sent to subscribers when this note was last updated - includes success messages, failure reasons, or skip reasons",
+  })
+  @Column({
+    type: ColumnType.VeryLongText,
+    nullable: true,
+  })
+  public subscriberNotificationStatusMessageOnNoteUpdated?: string = undefined;
+
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,

package/Models/DatabaseModels/SecurityEventConnection.ts

@@ -22,10 +22,10 @@ import SecurityEventConnectorProvider from "../../Types/SecurityEvent/Connectors
 import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
 
 /*
- * Same access split as GoogleSecOpsConnection: connecting a source means
- * holding a credential that reads someone's security product, so it stays
- * on the Admin tiers plus SecurityAdmin; every Security tier can read the
- * connection's health. The credential column itself is write-only.
+ * Connecting a source means holding a credential that reads someone's
+ * security product, so it stays on the Admin tiers plus SecurityAdmin;
+ * every Security tier can read the connection's health. The credential
+ * column itself is write-only.
  */
 const adminPermissions: Array<Permission> = [
   Permission.ProjectOwner,
@@ -42,13 +42,13 @@ const readPermissions: Array<Permission> = [
 ];
 
 /*
- * One managed pull connection to a security product (Microsoft Sentinel,
- * Defender XDR, CrowdStrike Falcon, Splunk, Elastic Security, AWS
- * Security Hub, Okta ...). The provider decides which keys `config` and
- * `secrets` carry — see SecurityEventConnectorCatalog — and which server
- * connector polls it. A Workers cron polls each enabled connection on its
- * interval, by the source's record CREATION time, and ingests the records
- * as normalized security events.
+ * One managed pull connection to a security product (Google SecOps,
+ * Microsoft Sentinel, Defender XDR, CrowdStrike Falcon, Splunk, Elastic
+ * Security, AWS Security Hub, Okta ...). The provider decides which keys
+ * `config` and `secrets` carry — see SecurityEventConnectorCatalog — and
+ * which server connector polls it. A Workers cron polls each enabled
+ * connection on its interval, by the source's record CREATION time, and
+ * ingests the records as normalized security events.
  */
 @EnableDocumentation()
 @TableBillingAccessControl({

package/Models/DatabaseModels/ServiceLevelObjective.ts

@@ -79,8 +79,32 @@ const decimalTransformer: ValueTransformer = {
  * silently rewrites history: budgets recompute against the new
  * definition on the worker's next tick. Recording those edits is how a
  * team answers "did the SLO get better, or did someone move the target?".
+ *
+ * The ignored columns are the evaluation worker's output: it rewrites them on
+ * every tick. Recorded, they would bury every edit a person made under a
+ * stream of "SLI 99.91 -> 99.92" rows (and status transitions are already
+ * told, with their context, in the SLO feed), so a worker-only write records
+ * nothing. autoAddedMonitors is the monitor-rule engine's bookkeeping of which
+ * attached monitors it owns; the attachment itself stays audited on
+ * `monitors`. The SLO's burn-rate rules, monitor rules and owners roll their
+ * entries up to this resource (their rootResource), so the SLO's Audit Logs
+ * page shows them too.
  */
-@EnableAuditLog()
+@EnableAuditLog({
+  ignoreColumns: [
+    "currentSliPercentage",
+    "errorBudgetRemainingPercentage",
+    "errorBudgetRemainingSeconds",
+    "errorBudgetTotalSeconds",
+    "currentBurnRate",
+    "sloStatus",
+    "statusChangeNotificationSentAt",
+    "lastEvaluatedAt",
+    "nextEvaluationAt",
+    "lastAccumulatedBucketEndAt",
+    "autoAddedMonitors",
+  ],
+})
 @EnableDocumentation()
 @AccessControlColumn("labels")
 @TenantColumn("projectId")
@@ -113,6 +137,12 @@ const decimalTransformer: ValueTransformer = {
 @Entity({
   name: "ServiceLevelObjective",
 })
+/*
+ * Every SLO list query pins `isArchived: false` inside a project, and the
+ * evaluation worker skips archived SLOs, so the pair is indexed together -
+ * the same composite index every other archivable resource carries.
+ */
+@Index(["projectId", "isArchived"])
 @EnableWorkflow({
   create: true,
   delete: true,
@@ -374,6 +404,134 @@ export default class ServiceLevelObjective extends BaseModel {
   })
   public isEnabled?: boolean = undefined;
 
+  /*
+   * Archiving retires an SLO without deleting its history: it disappears from
+   * the SLO lists, the worker stops evaluating it, and its open burn-rate
+   * alerts and incidents are resolved. Deliberately a separate flag from
+   * `isEnabled` - unarchiving must not silently re-enable an SLO somebody had
+   * paused, and re-enabling must not pull it back out of the archive.
+   *
+   * No dedicated permission: archiving is an update, so it is gated by Edit.
+   */
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateServiceLevelObjective,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjective,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditServiceLevelObjective,
+    ],
+  })
+  @TableColumn({
+    isDefaultValueColumn: true,
+    required: true,
+    type: TableColumnType.Boolean,
+    title: "Is Archived",
+    description: "Archived SLOs are hidden from lists and are not evaluated.",
+    defaultValue: false,
+  })
+  @Column({
+    type: ColumnType.Boolean,
+    nullable: false,
+    default: false,
+  })
+  public isArchived?: boolean = undefined;
+
+  /*
+   * Stamped server-side from the `isArchived` write (see
+   * DatabaseService.sanitizeCreateOrUpdate), which is why these are read-only
+   * to the client: "who archived this and when" cannot be spoofed.
+   */
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjective,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.Date,
+    title: "Archived At",
+    description: "When this Service Level Objective was archived.",
+  })
+  @Column({
+    type: ColumnType.Date,
+    nullable: true,
+  })
+  public archivedAt?: Date = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjective,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "archivedByUserId",
+    type: TableColumnType.Entity,
+    modelType: User,
+    title: "Archived by User",
+    description:
+      "Relation to User who archived this object (if this object was archived by a User)",
+  })
+  @ManyToOne(
+    () => {
+      return User;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "archivedByUserId" })
+  public archivedByUser?: User = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadServiceLevelObjective,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    title: "Archived by User ID",
+    description:
+      "User ID who archived this object (if this object was archived by a User)",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public archivedByUserId?: ObjectID = undefined;
+
   // SLI Configuration
 
   @ColumnAccessControl({
@@ -512,13 +670,31 @@ export default class ServiceLevelObjective extends BaseModel {
       Permission.EditServiceLevelObjective,
     ],
   })
+  /*
+   * DEPRECATED - superseded by ServiceLevelObjectiveMonitorRule. The
+   * SloProductOverhaul migrations copied every SLO's labels into a monitor
+   * rule named "Auto-add monitors with labels" (through that rule's own label
+   * join table, not criteria JSON), and the engine reads only the rules.
+   *
+   * The column and its join table stay for one release anyway: during a
+   * rolling deploy, API pods from the previous release still read and write
+   * it, and dropping the table under them would fail their SLO queries. Do
+   * not show it or write it for new features; remove it in a later migration.
+   *
+   * It is still ACTED ON when a write carries it (a dashboard tab opened before
+   * the upgrade, an old API client or workflow): ServiceLevelObjectiveService
+   * turns the list into that monitor rule for an SLO with no monitor rules and
+   * ignores it once the SLO has some (applyDeprecatedMonitorLabelWrite), and
+   * SloLegacyMonitorLabelAdoption reads its join table. Removing the column
+   * means removing those paths too.
+   */
   @TableColumn({
     required: false,
     type: TableColumnType.EntityArray,
     modelType: Label,
-    title: "Auto-Add Monitors With Labels",
+    title: "Auto-Add Monitors With Labels (Deprecated)",
     description:
-      "Monitor labels that automatically attach monitors to this SLO. Any monitor in the project carrying at least one of these labels is added to the Monitors list, and is removed again when it stops carrying any of them.",
+      'Deprecated: superseded by SLO Monitor Rules and no longer read by the SLO engine. Existing labels were migrated into a monitor rule named "Auto-add monitors with labels". Kept only for compatibility during upgrades: labels written here to an SLO with no monitor rules are turned into that rule, and are ignored once the SLO has monitor rules. Use SLO Monitor Rules instead.',
   })
   @ManyToMany(
     () => {
@@ -541,10 +717,11 @@ export default class ServiceLevelObjective extends BaseModel {
 
   /*
    * Bookkeeping shadow of `monitors`: the subset of attached monitors that the
-   * label rule put there. Without it the rule could not tell a monitor it
-   * added from one a human attached by hand, so "this monitor no longer
-   * matches, detach it" would silently delete deliberate, manual attachments.
-   * Root-only: it is derived state, never something a client sets.
+   * SLO's monitor rules put there (the union over all its enabled rules).
+   * Without it the rules could not tell a monitor they added from one a human
+   * attached by hand, so "this monitor no longer matches, detach it" would
+   * silently delete deliberate, manual attachments. Root-only: it is derived
+   * state, never something a client sets.
    */
   @ColumnAccessControl({
     create: [],
@@ -563,7 +740,7 @@ export default class ServiceLevelObjective extends BaseModel {
     modelType: Monitor,
     title: "Auto Added Monitors",
     description:
-      "Monitors that were attached to this SLO by its label rule rather than by hand. Maintained by the server.",
+      "Monitors that were attached to this SLO by its monitor rules rather than by hand. Maintained by the server.",
   })
   @ManyToMany(
     () => {