fix: Scripts not loaded in the order they exist in the file system

src/Robot.mjs

@@ -12,6 +12,7 @@ import { Listener, TextListener } from './Listener.mjs'
 import Message from './Message.mjs'
 import Middleware from './Middleware.mjs'
 
+const File = fs.promises
 const HUBOT_DEFAULT_ADAPTERS = ['Campfire', 'Shell']
 const HUBOT_DOCUMENTATION_SECTIONS = ['description', 'dependencies', 'configuration', 'commands', 'notes', 'author', 'authors', 'examples', 'tags', 'urls']
 
@@ -380,10 +381,18 @@ class Robot {
  // Returns nothing.
  async load (path) {
  this.logger.debug(`Loading scripts from ${path}`)
-
- if (fs.existsSync(path)) {
- const tasks = fs.readdirSync(path).sort().map(file => this.loadFile(path, file))
- await Promise.all(tasks)
+ try {
+ const folder = await File.readdir(path, { withFileTypes: true })
+ for await (const file of folder) {
+ if (file.isDirectory()) continue
+ try {
+ await this.loadFile(path, file.name)
+ } catch (e) {
+ this.logger.error(`Error loading file ${file.name} - ${e.stack}`)
+ }
+ }
+ } catch (e) {
+ this.logger.error(`Path ${path} does not exist`)
  }
  }
 

test/Robot_test.mjs

@@ -5,6 +5,7 @@ import assert from 'node:assert/strict'
 import path from 'node:path'
 import { Robot, CatchAllMessage, EnterMessage, LeaveMessage, TextMessage, TopicMessage, User, Response } from '../index.mjs'
 import mockAdapter from './fixtures/MockAdapter.mjs'
+
 describe('Robot', () => {
  describe('#http', () => {
  let robot = null
@@ -282,6 +283,22 @@ describe('Robot', () => {
  assert.ok(goodListenerCalled)
  })
  })
+ describe('#load', () => {
+ let robot = null
+ beforeEach(async () => {
+ robot = new Robot(mockAdapter, false, 'TestHubot')
+ await robot.loadAdapter()
+ await robot.run()
+ })
+ afterEach(() => {
+ robot.shutdown()
+ process.removeAllListeners()
+ })
+ it('should load scripts in the same order that they are in the folder', async () => {
+ await robot.load(path.resolve('./test/ordered-scripts'))
+ assert.deepEqual(robot.loadedScripts, ['01-First', '02-Second', '03-Third'])
+ })
+ })
  describe('#loadFile', () => {
  let robot = null
  beforeEach(async () => {

test/ordered-scripts/01-PFirst.mjs

@@ -0,0 +1,4 @@
+export default async robot => {
+ robot.loadedScripts = []
+ robot.loadedScripts.push('01-First')
+}

test/ordered-scripts/02-SetupBotConfig.mjs

@@ -0,0 +1,3 @@
+export default async robot => {
+ robot.loadedScripts.push('02-Second')
+}

test/ordered-scripts/WebSetup.mjs

@@ -0,0 +1,3 @@
+export default async robot => {
+ robot.loadedScripts.push('03-Third')
+}