fix: History file does not exist (#1784)

* fix: Shell adapter throwing an error because history file doesn't exist
* chore: Fix a test that is failing but not showing up as failed
* chore: Add doc comments on scripts

Author: joeyguerra

.github/workflows/pipeline.yml

@@ -36,13 +36,13 @@ jobs:
       - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
         run: npm audit signatures
   test:
-    name: Fast Tests
+    name: Tests
     runs-on: ubuntu-latest
     needs: build
     strategy:
       matrix:
         node-version:
-          - 23.x
+          - 24.x
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -54,7 +54,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
       - run: npm ci
-      - run: npm test --experimental-strip-types
+      - run: npm test -- --experimental-strip-types
   e2etest:
     name: E2E Test
     needs:

configuration/Config.mjs

@@ -1,3 +1,12 @@
+// Description:
+//   Configuration
+//
+// Commands:
+//
+// Notes:
+//   This is a test script.
+//
+
 export default async robot => {
   robot.config = {}
 }

src/adapters/Shell.mjs

@@ -1,6 +1,7 @@
 'use strict'
 
 import fs from 'node:fs'
+import { stat, writeFile, unlink } from 'node:fs/promises'
 import readline from 'node:readline'
 import Adapter from '../Adapter.mjs'
 import { TextMessage } from '../Message.mjs'
@@ -44,12 +45,15 @@ class Shell extends Adapter {
   }
 
   async run () {
-    if (!fs.existsSync(historyPath)) {
-      fs.writeFileSync(historyPath, '')
-    }
-    const stats = fs.statSync(historyPath)
-    if (stats.size > historySize) {
-      fs.unlinkSync(historyPath)
+    try {
+      const stats = await stat(historyPath)
+      if (stats.size > historySize) {
+        await unlink(historyPath)
+        await writeFile(historyPath, '')
+      }
+    } catch (error) {
+      console.log(error)
+      await writeFile(historyPath, '')
     }
 
     this.#rl = readline.createInterface({

test/Robot_test.mjs

@@ -247,17 +247,21 @@ describe('Robot', () => {
 
     it('stops processing if a listener marks the message as done', async () => {
       const testMessage = new TextMessage(user, 'message123')
+      let spyCalled = false
 
       const matchingListener = async response => {
-        response.message.done = true
-        assert.deepEqual(response.message, testMessage)
+        response.message.finish()
+        assert.equal(response.message.text, testMessage.text)
+        assert.equal(response.message.user.id, testMessage.user.id)
       }
       const listenerSpy = async message => {
+        spyCalled = true
         assert.fail('Should not have triggered listener')
       }
       robot.listen(() => true, null, matchingListener)
       robot.listen(() => true, null, listenerSpy)
       await robot.receive(testMessage)
+      assert.equal(spyCalled, false)
     })
 
     it('gracefully handles listener uncaughtExceptions (move on to next listener)', async () => {

test/Shell_test.mjs

@@ -4,6 +4,30 @@ import { describe, it, beforeEach, afterEach } from 'node:test'
 import assert from 'node:assert/strict'
 import { Robot, TextMessage, User } from '../index.mjs'
 import stream from 'node:stream'
+import fs from 'node:fs'
+import { writeFile } from 'node:fs/promises'
+
+describe('Shell history file test', () => {
+  it('History file is > 1024 bytes when running does not throw an error', async () => {
+    const robot = new Robot('Shell', false, 'TestHubot')
+    robot.stdin = new stream.Readable()
+    robot.stdin._read = () => {}
+    const __dirname = new URL('.', import.meta.url).pathname
+    const historyPath = `${__dirname}/../.hubot_history`
+    await writeFile(historyPath, 'a'.repeat(1025))
+    await robot.loadAdapter()
+    await robot.run()
+    assert.ok(fs.existsSync(historyPath), 'History file should exist')
+    try {
+      const stats = fs.statSync(historyPath)
+      assert.ok(stats.size <= 1024, 'History file should be less than or equal to 1024 bytes after running the robot')
+    } catch (error) {
+      assert.fail('Should not throw an error when reading history file')
+    } finally {
+      robot.shutdown()
+    }
+  })
+})
 
 describe('Shell Adapter Integration Test', () => {
   let robot = null
@@ -51,6 +75,7 @@ describe('Shell Adapter Integration Test', () => {
     assert.deepEqual(wasCalled, false)
   })
 })
+
 describe('Shell Adapter', () => {
   let robot = null
   beforeEach(async () => {

test/ordered-scripts/01-PFirst.mjs

@@ -1,3 +1,12 @@
+// Description:
+//   First one
+//
+// Commands:
+//
+// Notes:
+//   This is a test script.
+//
+
 export default async robot => {
   robot.loadedScripts = []
   robot.loadedScripts.push('01-First')

test/ordered-scripts/02-SetupBotConfig.mjs

@@ -1,3 +1,12 @@
+// Description:
+//   Setup bot configuration
+//
+// Commands:
+//
+// Notes:
+//   This is a test script.
+//
+
 export default async robot => {
   robot.loadedScripts.push('02-Second')
 }

test/ordered-scripts/WebSetup.mjs

@@ -1,3 +1,12 @@
+// Description:
+//   Third one
+//
+// Commands:
+//
+// Notes:
+//   This is a test script.
+//
+
 export default async robot => {
   robot.loadedScripts.push('03-Third')
 }