bullmq/tests/child-pool.test.ts at e892e0b0a0f35ed4e9a04f8e915ae2226fe8db36 · taskforcesh/bullmq · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
import { ChildPool } from '../src/classes';
import { join } from 'path';
import { describe, beforeEach, afterEach, it, expect } from 'vitest';

const NoopProc = () => {};
describe('Child pool for Child Processes', () => {
  sandboxProcessTests();
});

describe('Child pool for Worker Threads', () => {
  sandboxProcessTests({
    mainFile: join(process.cwd(), 'dist/cjs/classes/main-worker.js'),
    useWorkerThreads: true,
  });
});

function sandboxProcessTests(
  {
    mainFile,
    useWorkerThreads,
  }: { mainFile?: string; useWorkerThreads?: boolean } = {
    useWorkerThreads: false,
  },
) {
  describe('Child pool', () => {
    let pool: ChildPool;

    beforeEach(() => {
      pool = new ChildPool({ mainFile, useWorkerThreads });
    });

    afterEach(() => pool.clean());

    it('should return same child if free', async () => {
      const processor = __dirname + '/fixtures/fixture_processor_bar.js';
      const child = await pool.retain(processor, NoopProc);
      expect(child).toBeTruthy();
      await pool.release(child);
      expect(Object.keys(pool.retained)).toHaveLength(0);
      const newChild = await pool.retain(processor, NoopProc);
      expect(child).toEqual(newChild);
    });

    it('should return a new child if reused the last free one', async () => {
      const processor = __dirname + '/fixtures/fixture_processor_bar.js';
      let child = await pool.retain(processor, NoopProc);
      expect(child).toBeTruthy();
      await pool.release(child);
      expect(Object.keys(pool.retained)).toHaveLength(0);
      let newChild = await pool.retain(processor, NoopProc);
      expect(child).toEqual(newChild);
      child = newChild;
      newChild = await pool.retain(processor, NoopProc);
      expect(child).not.toEqual(newChild);
    });

    it('should return a new child if none free', async () => {
      const processor = __dirname + '/fixtures/fixture_processor_bar.js';
      const child = await pool.retain(processor, NoopProc);
      expect(child).toBeTruthy();
      expect(Object.keys(pool.retained).length).toBeGreaterThan(0);
      const newChild = await pool.retain(processor, NoopProc);
      expect(child).not.toEqual(newChild);
    });

    it('should return a new child if killed', async () => {
      const processor = __dirname + '/fixtures/fixture_processor_bar.js';
      const child = await pool.retain(processor, NoopProc);
      expect(child).toBeTruthy();
      await pool.kill(child);
      expect(Object.keys(pool.retained)).toHaveLength(0);
      const newChild = await pool.retain(processor, NoopProc);
      expect(child).not.toEqual(newChild);
    });

    it('should return a new child if many retained and none free', async () => {
      const processor = __dirname + '/fixtures/fixture_processor_bar.js';
      const children = await Promise.all([
        pool.retain(processor, NoopProc),
        pool.retain(processor, NoopProc),
        pool.retain(processor, NoopProc),
        pool.retain(processor, NoopProc),
        pool.retain(processor, NoopProc),
        pool.retain(processor, NoopProc),
      ]);
      expect(children).toHaveLength(6);
      const child = await pool.retain(processor, NoopProc);
      expect(children).not.toContain(child);
    });

    it('should return an old child if many retained and one free', async () => {
      const processor = __dirname + '/fixtures/fixture_processor_bar.js';
      const children = await Promise.all([
        pool.retain(processor, NoopProc),
        pool.retain(processor, NoopProc),
        pool.retain(processor, NoopProc),
        pool.retain(processor, NoopProc),
        pool.retain(processor, NoopProc),
        pool.retain(processor, NoopProc),
      ]);

      expect(children).toHaveLength(6);
      await pool.release(children[0]);
      const child = await pool.retain(processor);
      expect(children).toContain(child);
    });

    it('should kill child on release when reuseChildProcess is false', async () => {
      const noReusePool = new ChildPool({
        mainFile,
        useWorkerThreads,
        reuseChildProcess: false,
      });
      const processor = __dirname + '/fixtures/fixture_processor_bar.js';
      const child = await noReusePool.retain(processor, NoopProc);
      expect(child).toBeTruthy();
      await noReusePool.release(child);
      expect(Object.keys(noReusePool.retained)).toHaveLength(0);
      expect(noReusePool.getAllFree()).toHaveLength(0);
      await noReusePool.clean();
    });

    it('should return a new child after release when reuseChildProcess is false', async () => {
      const noReusePool = new ChildPool({
        mainFile,
        useWorkerThreads,
        reuseChildProcess: false,
      });
      const processor = __dirname + '/fixtures/fixture_processor_bar.js';
      const child = await noReusePool.retain(processor, NoopProc);
      await noReusePool.release(child);
      const newChild = await noReusePool.retain(processor, NoopProc);
      expect(child).not.toEqual(newChild);
      await noReusePool.clean();
    });

    it('should consume execArgv array from process', async () => {
      const processor = __dirname + '/fixtures/fixture_processor_bar.js';
      process.execArgv.push('--no-warnings');

      const child = await pool.retain(processor, NoopProc);
      expect(child).toBeTruthy();
      if (!useWorkerThreads) {
        expect(child.childProcess.spawnargs).toContain('--no-warnings');
      }
    });
  });
}