Expose event release lifecycle metadata

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hawk.api",
-  "version": "1.6.1",
+  "version": "1.7.0",
   "main": "index.ts",
   "license": "BUSL-1.1",
   "scripts": {

src/models/eventsFactory.js

@@ -3,6 +3,7 @@ import { createProjectEventsByIdLoader } from '../dataLoaders';
 import RedisHelper from '../redisHelper';
 import ChartDataService from '../services/chartDataService';
 import { getMidnightWithTimezoneOffset, getUTCMidnight } from '../utils/dates';
+import { normalizeReleaseName } from '../utils/releaseName';
 
 const Factory = require('./modelFactory');
 const mongo = require('../mongo');
@@ -770,10 +771,7 @@ class EventsFactory extends Factory {
     for (const repetition of repetitions) {
       const event = this._composeEventWithRepetition(eventOriginal, repetition);
 
-      result.repetitions.push({
-        ...event,
-        projectId: this.projectId,
-      });
+      result.repetitions.push(event);
     }
 
     const isLastPortion = result.nextCursor === null;
@@ -787,12 +785,7 @@ class EventsFactory extends Factory {
        * Get only 'repetitions' fields from event to fit Repetition scheme
        * @type {EventRepetitionSchema}
        */
-      const firstRepetition = {
-        ...eventOriginal,
-        originalTimestamp: eventOriginal.timestamp,
-        originalEventId: eventOriginal._id,
-        projectId: this.projectId,
-      };
+      const firstRepetition = this._composeEventWithRepetition(eventOriginal);
 
       result.repetitions.push(firstRepetition);
     }
@@ -814,14 +807,7 @@ class EventsFactory extends Factory {
     if (repetitionId.toString() === originalEventId.toString()) {
       const originalEvent = await this.eventsDataLoader.load(originalEventId);
 
-      /**
-       * All events have same type with originalEvent id
-       */
-      originalEvent.originalEventId = originalEventId;
-      originalEvent.originalTimestamp = originalEvent.timestamp;
-      originalEvent.projectId = this.projectId;
-
-      return originalEvent || null;
+      return originalEvent ? this._composeEventWithRepetition(originalEvent) : null;
     }
 
     /**
@@ -1104,23 +1090,25 @@ class EventsFactory extends Factory {
    * @returns {Event} event merged with repetition
    */
   _composeEventWithRepetition(event, repetition) {
+    const original = {
+      ...event,
+      originalTimestamp: event.timestamp,
+      originalEventId: event._id,
+      firstSeenInRelease: normalizeReleaseName(event.payload && event.payload.release),
+      resolvedInRelease: normalizeReleaseName(event.resolvedInRelease),
+      regressionInRelease: normalizeReleaseName(event.regressionInRelease),
+      projectId: this.projectId,
+    };
+
     if (!repetition) {
-      return {
-        ...event,
-        originalTimestamp: event.timestamp,
-        originalEventId: event._id,
-        projectId: this.projectId,
-      };
+      return original;
     }
 
     return {
-      ...event,
+      ...original,
       _id: repetition._id,
-      originalTimestamp: event.timestamp,
-      originalEventId: event._id,
       timestamp: repetition.timestamp,
-      payload: composeEventPayloadByRepetition(event.payload, repetition),
-      projectId: this.projectId,
+      payload: composeEventPayloadByRepetition(event.payload == null ? {} : event.payload, repetition),
     };
   }
 }

src/models/releasesFactory.ts

@@ -1,6 +1,7 @@
 // TODO: it would be great to move release logic from another factories/resolvers to this class
 import type { Collection, Db, ObjectId } from 'mongodb';
 import type { ReleaseDBScheme } from '@hawk.so/types';
+import { normalizeReleaseName } from '../utils/releaseName';
 
 /**
  * Interface representing how release files are stored in the DB
@@ -47,6 +48,7 @@ export default class ReleasesFactory {
    */
   private readonly collection: Collection<ReleaseDBScheme>;
   private readonly filesCollection: Collection<ReleaseFileDBScheme>;
+  private readonly latestRegisteredReleaseByProject = new Map<string, Promise<string | null>>();
 
   /**
    * Creates releases factory instance
@@ -57,6 +59,44 @@ export default class ReleasesFactory {
     this.filesCollection = dbConnection.collection<ReleaseFileDBScheme>('releases.files');
   }
 
+  /**
+   * Compare against the newest registered release, not the newest observed/deployed release.
+   * @param projectId - event's project
+   * @param firstSeenRelease - original event's release
+   */
+  public async isNewInLatestRelease(
+    projectId: string | ObjectId | null | undefined,
+    firstSeenRelease: unknown
+  ): Promise<boolean> {
+    const name = normalizeReleaseName(firstSeenRelease);
+
+    if (!projectId || name === null) {
+      return false;
+    }
+    const key = projectId.toString();
+    let latest = this.latestRegisteredReleaseByProject.get(key);
+
+    if (!latest) {
+      /*
+       * The existing index bounds the project, but does not cover the _id sort.
+       */
+      latest = this.collection.findOne({ projectId: key }, {
+        sort: { _id: -1 },
+        projection: {
+          release: 1,
+          _id: 0,
+        },
+        hint: {
+          projectId: 1,
+          release: 1,
+        },
+      }).then(doc => normalizeReleaseName(doc?.release));
+      this.latestRegisteredReleaseByProject.set(key, latest);
+    }
+
+    return name === await latest;
+  }
+
   /**
    * Find one release document by projectId and release label.
    * Tries both exact string match and numeric fallback (if release can be cast to number).

src/resolvers/event.js

@@ -6,6 +6,7 @@ const {
 const { askAiService } = require('../services/askAi');
 const { UserInputError } = require('apollo-server-express');
 const { ObjectId } = require('mongodb');
+const { normalizeReleaseName } = require('../utils/releaseName');
 
 /**
  * See all types and fields here {@see ../typeDefs/event.graphql}
@@ -23,6 +24,45 @@ module.exports = {
     },
   },
   Event: {
+    /**
+     * Returns the original release, preserving null for repetitions of legacy events.
+     *
+     * @param {Object} event - original event or composed repetition
+     * @returns {string|null}
+     */
+    firstSeenInRelease({ firstSeenInRelease, payload }) {
+      return normalizeReleaseName(firstSeenInRelease !== undefined ? firstSeenInRelease : payload && payload.release);
+    },
+
+    /**
+     * Compare the original release with the newest registered release.
+     * @param {Object} event - original event or composed repetition
+     * @param {Object} _args - query arguments
+     * @param {Object} context - request-scoped factories
+     * @returns {Promise<boolean>} whether the original first appeared in the newest registered release
+     */
+    isNew({ projectId, firstSeenInRelease, payload }, _args, { factories }) {
+      return factories.releasesFactory.isNewInLatestRelease(
+        projectId,
+        firstSeenInRelease !== undefined ? firstSeenInRelease : payload && payload.release
+      );
+    },
+
+    /**
+     * @param {Object} event - event with stored lifecycle metadata
+     * @returns {string|null} normalized resolution release
+     */
+    resolvedInRelease({ resolvedInRelease }) {
+      return normalizeReleaseName(resolvedInRelease);
+    },
+
+    /**
+     * @param {Object} event - event with stored lifecycle metadata
+     * @returns {string|null} normalized regression release
+     */
+    regressionInRelease({ regressionInRelease }) {
+      return normalizeReleaseName(regressionInRelease);
+    },
 
     /**
      * Returns repetitions portion of the event

src/typeDefs/event.ts

@@ -301,6 +301,26 @@ type Event {
   """
   release: Release
 
+  """
+  Release of the original event, regardless of the selected repetition
+  """
+  firstSeenInRelease: String
+
+  """
+  Whether the original event first appeared in the newest registered release for its project
+  """
+  isNew: Boolean!
+
+  """
+  Release in which the event was resolved
+  """
+  resolvedInRelease: String
+
+  """
+  Release in which the event regressed
+  """
+  regressionInRelease: String
+
   """
   Event repetitions portion
   """

src/utils/releaseName.ts

@@ -0,0 +1,19 @@
+/**
+ * Normalize absent or invalid release names without changing opaque identifiers.
+ *
+ * @param value - raw release name
+ * @returns the original identifier, a finite number as a string, or null
+ */
+export function normalizeReleaseName(value: unknown): string | null {
+  if (typeof value === 'number') {
+    return Number.isFinite(value) ? String(value) : null;
+  }
+
+  if (typeof value !== 'string') {
+    return null;
+  }
+
+  const name = value.trim().toLowerCase();
+
+  return name === '' || name === 'null' || name === 'undefined' || name === 'nan' ? null : value;
+}