Skip to content

Don't fail concurrent comms credential requests for the same tab session #9020

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

Open
cstns wants to merge 2 commits into
base: main
Choose a base branch
from
+33 −10
Open

Don't fail concurrent comms credential requests for the same tab session #9020

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
b3e66e8
Don't fail concurrent comms credential requests for the same tab session
cstns Oct 22, 2026
457c057
Merge remote-tracking branch 'origin/main' into review/9019-comms-cre…
cstns Oct 27, 2026
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
3 changes: 2 additions & 1 deletion forge/db/controllers/BrokerClient.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ async function createClient (app, { username, ownerId, ownerType, prefix, where,
await existingClient.destroy()
}
const password = generateToken(32, prefix)
await app.db.models.BrokerClient.create({ username, password, ownerId, ownerType })
// Upsert, as a concurrent request for the same username can recreate it after the destroy above
await app.db.models.BrokerClient.upsert({ username, password, ownerId, ownerType })
const url = usePublicUrl
? (app.config.broker.public_url || app.config.broker.url || null)
: (app.config.broker.url || null)
Expand Down
19 changes: 10 additions & 9 deletions test/unit/forge/db/controllers/BrokerClient_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ describe('BrokerClient', function () {
models: {
BrokerClient: {
create: sandbox.stub(),
upsert: sandbox.stub(),
destroy: sandbox.stub(),
findOne: sandbox.stub(),
findOrCreate: sandbox.stub(),
Expand Down Expand Up @@ -134,7 +135,7 @@ describe('BrokerClient', function () {
it('should create broker client for team frontend', async function () {
const fakeClient = fakeBrokerClient()
app.db.models.BrokerClient.findOne.resolves(null)
app.db.models.BrokerClient.create.resolves(fakeClient)
app.db.models.BrokerClient.upsert.resolves(fakeClient)
const user = { id: 7, hashid: 'userHash' }
const team = { id: 11, hashid: 'teamHash' }
const sessionId = 'tab-1234567890'
Expand All @@ -144,7 +145,7 @@ describe('BrokerClient', function () {
should(result).have.property('password')
result.password.should.match(/^ffbtf_/)
should(result).have.property('url', 'http://public.url')
app.db.models.BrokerClient.create.calledWith({
app.db.models.BrokerClient.upsert.calledWith({
username: expectedUsername,
password: result.password,
ownerId: '' + user.id,
Expand All @@ -154,7 +155,7 @@ describe('BrokerClient', function () {
it('should destroy existing client for same session before creating a new one', async function () {
const existingClient = fakeBrokerClient()
app.db.models.BrokerClient.findOne.resolves(existingClient)
app.db.models.BrokerClient.create.resolves(fakeBrokerClient())
app.db.models.BrokerClient.upsert.resolves(fakeBrokerClient())
const user = { id: 7, hashid: 'userHash' }
const team = { id: 11, hashid: 'teamHash' }
const result = await BrokerClient.createClientForTeamFrontend(app, user, team, 'tab-1234567890')
Expand All @@ -163,7 +164,7 @@ describe('BrokerClient', function () {
})
it('should look up existing client scoped to the full username (including sessionId) so different tabs do not revoke each other', async function () {
app.db.models.BrokerClient.findOne.resolves(null)
app.db.models.BrokerClient.create.resolves(fakeBrokerClient())
app.db.models.BrokerClient.upsert.resolves(fakeBrokerClient())
const user = { id: 7, hashid: 'userHash' }
const team = { id: 11, hashid: 'teamHash' }
await BrokerClient.createClientForTeamFrontend(app, user, team, 'tab-A')
Expand All @@ -173,7 +174,7 @@ describe('BrokerClient', function () {
})
it('should include a last will that clears the tab presence entry', async function () {
app.db.models.BrokerClient.findOne.resolves(null)
app.db.models.BrokerClient.create.resolves(fakeBrokerClient())
app.db.models.BrokerClient.upsert.resolves(fakeBrokerClient())
const user = { id: 7, hashid: 'userHash' }
const team = { id: 11, hashid: 'teamHash' }
const sessionId = 'tab-1234567890'
Expand All @@ -194,15 +195,15 @@ describe('BrokerClient', function () {
it('should create broker client for expert client', async function () {
const fakeClient = fakeBrokerClient()
app.db.models.BrokerClient.findOne.resolves(null) // no existing client
app.db.models.BrokerClient.create.resolves(fakeClient)
app.db.models.BrokerClient.upsert.resolves(fakeClient)
const user = { id: 123, hashid: 'abc123' }
const sessionId = 'sess123'
const result = await BrokerClient.createClientForExpertClient(app, user, sessionId)
const expectedUsername = `expert-client:${user.hashid}:${sessionId}`
should(result).have.property('username', expectedUsername)
should(result).have.property('password')
result.password.should.match(/^ffbec_/) // check it has the right prefix
app.db.models.BrokerClient.create.calledWith({
app.db.models.BrokerClient.upsert.calledWith({
username: expectedUsername,
password: result.password,
ownerId: '' + user.id,
Expand All @@ -212,7 +213,7 @@ describe('BrokerClient', function () {
it('should destroy existing client before creating new one', async function () {
const fakeClient = fakeBrokerClient()
app.db.models.BrokerClient.findOne.resolves(fakeClient) // existing client found
app.db.models.BrokerClient.create.resolves(fakeClient)
app.db.models.BrokerClient.upsert.resolves(fakeClient)
const user = { id: 123, hashid: 'abc123' }
const sessionId = 'sess123'
const result = await BrokerClient.createClientForExpertClient(app, user, sessionId)
Expand All @@ -221,7 +222,7 @@ describe('BrokerClient', function () {
should(result).have.property('password')
result.password.should.match(/^ffbec_/) // check it has the right prefix
fakeClient.destroy.called.should.be.true() // should have destroyed existing client
app.db.models.BrokerClient.create.calledWith({
app.db.models.BrokerClient.upsert.calledWith({
username: expectedUsername,
password: result.password,
ownerId: '' + user.id,
Expand Down
21 changes: 21 additions & 0 deletions test/unit/forge/routes/api/team_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2030,6 +2030,27 @@ describe('Team API', function () {
result.will.should.have.property('payload')
should.doesNotThrow(() => JSON.parse(result.will.payload))
})
it('issues credentials to concurrent requests for the same session', async function () {
// Tabs that share sessionStorage (a restored or duplicated tab) ask for
// the same username at the same moment
const responses = await Promise.all([1, 2, 3, 4].map(() => app.inject({
method: 'POST',
url: `/api/v1/teams/${TestObjects.ATeam.hashid}/comms-credentials`,
payload: { sessionId: 'tab-concurrent' },
cookies: { sid: TestObjects.tokens.bob }
})))
responses.map(r => r.statusCode).should.eql([200, 200, 200, 200])
const clients = await app.db.models.BrokerClient.findAll({
where: { username: `fe-team:${TestObjects.bob.hashid}:${TestObjects.ATeam.hashid}:tab-concurrent` }
})
clients.should.have.length(1)
// The last credentials written are the ones that still authenticate
const results = await Promise.all(responses.map(r => {
const { username, password } = r.json()
return app.db.controllers.BrokerClient.authenticateCredentials(username, password)
}))
results.filter(Boolean).should.have.length(1)
})
it('rejects a non-member with 404', async function () {
const response = await app.inject({
method: 'POST',
Expand Down
Loading