Create chargeVersionNotes table model, helper and view

app/models/charge-version-note.model.js

@@ -0,0 +1,39 @@
+'use strict'
+
+/**
+ * Model for charge_version_notes (water.notes)
+ * @module ChargeVersionNote
+ */
+
+const { Model } = require('objection')
+
+const BaseModel = require('./base.model.js')
+
+class ChargeVersionNote extends BaseModel {
+  static get tableName () {
+    return 'chargeVersionNotes'
+  }
+
+  static get relationMappings () {
+    return {
+      chargeVersion: {
+        relation: Model.BelongsToOneRelation,
+        modelClass: 'charge-version.model',
+        join: {
+          from: 'chargeVersionNotes.id',
+          to: 'chargeVersions.noteId'
+        }
+      },
+      user: {
+        relation: Model.BelongsToOneRelation,
+        modelClass: 'user.model',
+        join: {
+          from: 'chargeVersionNotes.userId',
+          to: 'users.id'
+        }
+      }
+    }
+  }
+}
+
+module.exports = ChargeVersionNote

app/models/charge-version.model.js

@@ -48,6 +48,14 @@ class ChargeVersionModel extends BaseModel {
           to: 'chargeReferences.chargeVersionId'
         }
       },
+      chargeVersionNote: {
+        relation: Model.HasOneRelation,
+        modelClass: 'charge-version-note.model',
+        join: {
+          from: 'chargeVersions.noteId',
+          to: 'chargeVersionNotes.id'
+        }
+      },
       licence: {
         relation: Model.BelongsToOneRelation,
         modelClass: 'licence.model',

app/models/user.model.js

@@ -17,6 +17,14 @@ class UserModel extends BaseModel {
 
   static get relationMappings () {
     return {
+      chargeVersionNotes: {
+        relation: Model.HasManyRelation,
+        modelClass: 'charge-version-note.model',
+        join: {
+          from: 'users.id',
+          to: 'chargeVersionNotes.userId'
+        }
+      },
       groups: {
         relation: Model.ManyToManyRelation,
         modelClass: 'group.model',

db/migrations/legacy/20240807142828_water-notes.js

@@ -0,0 +1,31 @@
+'use strict'
+
+const tableName = 'notes'
+
+exports.up = function (knex) {
+  return knex
+    .schema
+    .withSchema('water')
+    .createTable(tableName, (table) => {
+      // Primary Key
+      table.uuid('note_id').primary().defaultTo(knex.raw('gen_random_uuid()'))
+
+      // Data
+      table.string('text').notNullable()
+      table.integer('user_id').notNullable()
+      table.string('type').notNullable().defaultTo('charge_version')
+      table.uuid('type_id')
+      table.uuid('licence_id')
+
+      // Legacy timestamps
+      table.timestamp('date_created', { useTz: false }).notNullable().defaultTo(knex.fn.now())
+      table.timestamp('date_updated', { useTz: false }).notNullable().defaultTo(knex.fn.now())
+    })
+}
+
+exports.down = function (knex) {
+  return knex
+    .schema
+    .withSchema('water')
+    .dropTableIfExists(tableName)
+}

db/migrations/public/20240807131002_create-charge-version-note-view.js

@@ -0,0 +1,28 @@
+'use strict'
+
+const viewName = 'charge_version_notes'
+
+exports.up = function (knex) {
+  return knex
+    .schema
+    .dropViewIfExists(viewName)
+    .createView(viewName, (view) => {
+      // NOTE: We have commented out unused columns from the source table
+      view.as(knex('notes').withSchema('water').select([
+        'note_id AS id',
+        'text AS note',
+        // 'type',
+        // 'type_id',
+        'user_id',
+        // 'licence_id',
+        'date_created AS created_at',
+        'date_updated AS updated_at'
+      ]))
+    })
+}
+
+exports.down = function (knex) {
+  return knex
+    .schema
+    .dropViewIfExists(viewName)
+}

test/models/charge-version-note.model.test.js

@@ -0,0 +1,62 @@
+'use strict'
+
+// Test framework dependencies
+const Lab = require('@hapi/lab')
+const Code = require('@hapi/code')
+
+const { describe, it, before, beforeEach } = exports.lab = Lab.script()
+const { expect } = Code
+
+// Test helpers
+const ChargeVersionHelper = require('../support/helpers/charge-version.helper.js')
+const ChargeVersionNoteHelper = require('../support/helpers/charge-version-note.helper.js')
+const UserHelper = require('../support/helpers/user.helper.js')
+
+// Thing under test
+const ChargeVersionNoteModel = require('../../app/models/charge-version-note.model.js')
+
+describe('Charge Version Note model', () => {
+  let testRecord
+
+  before(async () => {
+    testRecord = await ChargeVersionNoteHelper.add()
+  })
+
+  describe('Basic query', () => {
+    it('can successfully run a basic query', async () => {
+      const result = await ChargeVersionNoteModel.query()
+        .findById(testRecord.id)
+
+      expect(result).to.be.an.instanceOf(ChargeVersionNoteModel)
+      expect(result.id).to.be.equal(testRecord.id)
+    })
+  })
+
+  describe('Relationships', () => {
+    describe('when linking to charge version', () => {
+      beforeEach(async () => {
+        await ChargeVersionHelper.add({ noteId: testRecord.id })
+      })
+
+      it('can successfully run a related query', async () => {
+        const query = await ChargeVersionNoteModel.query()
+          .withGraphFetched('chargeVersion')
+
+        expect(query).to.exist()
+      })
+    })
+
+    describe('when linking to user', () => {
+      beforeEach(async () => {
+        await UserHelper.add({ id: testRecord.userId })
+      })
+
+      it('can successfully run a related query', async () => {
+        const query = await ChargeVersionNoteModel.query()
+          .withGraphFetched('user')
+
+        expect(query).to.exist()
+      })
+    })
+  })
+})

test/models/charge-version.model.test.js

@@ -17,6 +17,8 @@ const ChangeReasonModel = require('../../app/models/change-reason.model.js')
 const ChargeReferenceHelper = require('../support/helpers/charge-reference.helper.js')
 const ChargeReferenceModel = require('../../app/models/charge-reference.model.js')
 const ChargeVersionHelper = require('../support/helpers/charge-version.helper.js')
+const ChargeVersionNoteHelper = require('../support/helpers/charge-version-note.helper.js')
+const ChargeVersionNoteModel = require('../../app/models/charge-version-note.model.js')
 const LicenceHelper = require('../support/helpers/licence.helper.js')
 const LicenceModel = require('../../app/models/licence.model.js')
 const ReviewChargeVersionHelper = require('../support/helpers/review-charge-version.helper.js')
@@ -176,6 +178,37 @@ describe('Charge Version model', () => {
       })
     })
 
+    describe('when linking to charge version note', () => {
+      let testNote
+
+      beforeEach(async () => {
+        testNote = await ChargeVersionNoteHelper.add()
+
+        const { id: noteId } = testNote
+
+        testRecord = await ChargeVersionHelper.add({ noteId })
+      })
+
+      it('can successfully run a related query', async () => {
+        const query = await ChargeVersionModel.query()
+          .innerJoinRelated('chargeVersionNote')
+
+        expect(query).to.exist()
+      })
+
+      it('can eager load the note', async () => {
+        const result = await ChargeVersionModel.query()
+          .findById(testRecord.id)
+          .withGraphFetched('chargeVersionNote')
+
+        expect(result).to.be.instanceOf(ChargeVersionModel)
+        expect(result.id).to.equal(testRecord.id)
+
+        expect(result.chargeVersionNote).to.be.an.instanceOf(ChargeVersionNoteModel)
+        expect(result.chargeVersionNote).to.equal(testNote)
+      })
+    })
+
     describe('when linking to licence', () => {
       let testLicence
 

test/models/user.model.test.js

@@ -8,6 +8,8 @@
 const { expect } = Code
 
 // Test helpers
+const ChargeVersionNoteHelper = require('../support/helpers/charge-version-note.helper.js')
+const ChargeVersionNoteModel = require('../../app/models/charge-version-note.model.js')
 const GroupHelper = require('../support/helpers/group.helper.js')
 const GroupModel = require('../../app/models/group.model.js')
 const ReturnVersionHelper = require('../support/helpers/return-version.helper.js')
@@ -29,6 +31,8 @@
 const USER_WIRS_INDEX = 3
 
 describe('User model', () => {
+  let testChargeVersionNoteOne
+  let testChargeVersionNoteTwo
   let testGroup
   let testRecord
   let testRole
@@ -42,6 +46,8 @@
     testGroup = GroupHelper.select(GROUP_WIRS_INDEX)
     testUserGroup = UserGroupHelper.select(USER_GROUP_WIRS_INDEX)
 
+    testChargeVersionNoteOne = await ChargeVersionNoteHelper.add({ userId: testRecord.id, note: '1st test note' })
+    testChargeVersionNoteTwo = await ChargeVersionNoteHelper.add({ userId: testRecord.id, note: '2nd test note' })
     testUserRole = await UserRoleHelper.add({ userId: testRecord.id, roleId: testRole.id })
   })
 
@@ -55,6 +61,30 @@
   })
 
   describe('Relationships', () => {
+    describe('when linking to charge version notes', () => {
+      it('can successfully run a related query', async () => {
+        const query = await UserModel.query()
+          .innerJoinRelated('chargeVersionNotes')
+
+        expect(query).to.exist()
+      })
+
+      it('can eager load the charge version notes', async () => {
+        const result = await UserModel.query()
+          .findById(testRecord.id)
+          .withGraphFetched('chargeVersionNotes')
+
+        expect(result).to.be.instanceOf(UserModel)
+        expect(result.id).to.equal(testRecord.id)
+
+        expect(result.chargeVersionNotes).to.be.an.array()
+        expect(result.chargeVersionNotes).to.have.length(2)
+        expect(result.chargeVersionNotes[0]).to.be.an.instanceOf(ChargeVersionNoteModel)
+        expect(result.chargeVersionNotes[0]).to.equal(testChargeVersionNoteOne)
+        expect(result.chargeVersionNotes[1]).to.equal(testChargeVersionNoteTwo)
+      })
+    })
+
     describe('when linking through user groups to groups', () => {
       it('can successfully run a related query', async () => {
         const query = await UserModel.query()

test/support/helpers/charge-version-note.helper.js

@@ -0,0 +1,53 @@
+'use strict'
+
+/**
+ * @module ChargeVersionNoteHelper
+ */
+
+const { generateUserId } = require('./user.helper.js')
+const ChargeVersionNoteModel = require('../../../app/models/charge-version-note.model.js')
+
+/**
+ * Add a new charge version note
+ *
+ * If no `data` is provided, the default values will be used. These are
+ *
+ * - `note` - 'This is a test note'
+ * - `userId` - [randomly generated - 100001]
+ *
+ * @param {Object} [data] Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {Promise<module:NoteModel>} The instance of the newly created record
+ */
+function add (data = {}) {
+  const insertData = defaults(data)
+
+  return ChargeVersionNoteModel.query()
+    .insert({ ...insertData })
+    .returning('*')
+}
+
+/**
+ * Returns the defaults used
+ *
+ * It will override or append to them any data provided. Mainly used by the `add()` method, we make it available
+ * for use in tests to avoid having to duplicate values.
+ *
+ * @param {Object} [data] Any data you want to use instead of the defaults used here or in the database
+ */
+function defaults (data = {}) {
+  const defaults = {
+    note: 'This is a test note',
+    userId: generateUserId()
+  }
+
+  return {
+    ...defaults,
+    ...data
+  }
+}
+
+module.exports = {
+  add,
+  defaults
+}