Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

run multiple server threads #10701

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

run multiple server threads #10701

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6bf18c8
run multiple server threads
chris48s Nov 23, 2024
00c4033
ignore command line args under test
chris48s Nov 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions entrypoint.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
import { expect } from 'chai'
import isSvg from 'is-svg'
import got from './core/got-test-client.js'
import startServer from './server.js'

let serverModule
let server
before(async function () {
this.timeout('30s')
// remove args coming from mocha
// https://github.com/badges/shields/issues/3365
process.argv = []
serverModule = await import('./server.js')
server = await startServer()
Comment on lines -11 to +12
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The core problem I ran into here was that cluster.fork() attempts to spawn a new worker process that executes the same script as the primary process. When a worker process is spawned, it executes the same Node.js script that started the primary process, but this didn't have the desired effect under test because the primary process is the test runner.
I worked round this by
a) exporting a function we can test from server.js
b) only starting in multi-threaded mode if we are not under test
This means the actual multi-threaded server startup is not under test, but I couldn't find any way around this. I think it is a tradeoff we would have to accept if we go down this road.

})

after('shut down the server', async function () {
await serverModule.server.stop()
await server.stop()
})

it('should render a badge', async function () {
Expand Down
38 changes: 31 additions & 7 deletions server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import cluster from 'cluster'
import { availableParallelism } from 'os'
import fs from 'fs'
import path from 'path'
import { fileURLToPath } from 'url'
Expand Down Expand Up @@ -25,11 +27,13 @@ Sentry.init({
},
})

if (+process.argv[2]) {
config.public.bind.port = +process.argv[2]
}
if (process.argv[3]) {
config.public.bind.address = process.argv[3]
if (process.env.NODE_CONFIG_ENV !== 'test') {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Switching from a dynamic await import to a module-level import also meant that this was picking up the test runner args here

shields/.github/actions/core-tests/action.yml

Line 13 in 9447077

run: npm run test:entrypoint -- --reporter json --reporter-option 'output=reports/entrypoint.json'
under test.

if (+process.argv[2]) {
config.public.bind.port = +process.argv[2]
}
if (process.argv[3]) {
config.public.bind.address = process.argv[3]
}
}

console.log('Configuration:')
Expand Down Expand Up @@ -60,6 +64,26 @@ if (fs.existsSync(legacySecretsPath)) {
)
process.exit(1)
}
export const server = new Server(config)

await server.start()
async function startServer() {
console.log(config)
const server = new Server(config)
await server.start()
return server
}

export default startServer

const numCPUs = availableParallelism()
if (process.env.NODE_CONFIG_ENV !== 'test') {
if (cluster.isPrimary) {
console.log(`Primary ${process.pid} is running`)

for (let i = 0; i < numCPUs; i++) {
cluster.fork()
}
} else {
await startServer()
console.log(`Worker ${process.pid} started`)
}
}
Loading