github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-12-27 21:30:59 +00:00
Code Issues Projects Releases Packages Wiki Activity

[WebsocketController] skip leaveProject when joinProject didn't complete

Browse source 
Also drop dead code:
 - user_id bailout

   There is a check on a completed joinProject call now. It will always
    set a user_id, see Router.coffee which has a fallback `{_id:"..."}`.

 - late project_id bailout

   WebsocketLoadBalancer.emitToRoom will not work without a project_id.
   We have to bail out before the call.
This commit is contained in:
Jakob Ackermann 2020-05-12 12:55:04 +02:00
parent f4b17ebbad
commit 55af5e502f
2 changed files with 19 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
services/real-time/app/coffee/WebsocketController.coffee
View file

@ -51,23 +51,14 @@ module.exports = WebsocketController =
# is determined by FLUSH_IF_EMPTY_DELAY.
FLUSH_IF_EMPTY_DELAY: 500 #ms
leaveProject: (io, client, callback = (error) ->) ->
metrics.inc "editor.leave-project"
Utils.getClientAttributes client, ["project_id", "user_id"], (error, {project_id, user_id}) ->
return callback(error) if error?
return callback() unless project_id # client did not join project
metrics.inc "editor.leave-project"
logger.log {project_id, user_id, client_id: client.id}, "client leaving project"
WebsocketLoadBalancer.emitToRoom project_id, "clientTracking.clientDisconnected", client.id
# bail out if the client had not managed to authenticate or join
# the project. Prevents downstream errors in docupdater from
# flushProjectToMongoAndDelete with null project_id.
if not user_id?
logger.log {client_id: client.id}, "client leaving, unknown user"
return callback()
if not project_id?
logger.log {user_id: user_id, client_id: client.id}, "client leaving, not in project"
return callback()
# We can do this in the background
ConnectedUsersManager.markUserAsDisconnected project_id, client.id, (err) ->
if err?

21
services/real-time/test/unit/coffee/WebsocketControllerTests.coffee
View file

@ -143,6 +143,19 @@ describe 'WebsocketController', ->
@WebsocketController.FLUSH_IF_EMPTY_DELAY = 0
tk.reset() # Allow setTimeout to work.
describe "when the client did not joined a project yet", ->
beforeEach (done) ->
@client.params = {}
@WebsocketController.leaveProject @io, @client, done
it "should bail out when calling leaveProject", () ->
@WebsocketLoadBalancer.emitToRoom.called.should.equal false
@RoomManager.leaveProjectAndDocs.called.should.equal false
@ConnectedUsersManager.markUserAsDisconnected.called.should.equal false
it "should not inc any metric", () ->
@metrics.inc.called.should.equal false
describe "when the project is empty", ->
beforeEach (done) ->
@clientsInRoom = []
@ -201,8 +214,8 @@ describe 'WebsocketController', ->
.calledWith(@project_id)
.should.equal false
it "should increment the leave-project metric", ->
@metrics.inc.calledWith("editor.leave-project").should.equal true
it "should not increment the leave-project metric", ->
@metrics.inc.calledWith("editor.leave-project").should.equal false
describe "when client has not joined a project", ->
beforeEach (done) ->
@ -225,8 +238,8 @@ describe 'WebsocketController', ->
.calledWith(@project_id)
.should.equal false
it "should increment the leave-project metric", ->
@metrics.inc.calledWith("editor.leave-project").should.equal true
it "should not increment the leave-project metric", ->
@metrics.inc.calledWith("editor.leave-project").should.equal false
describe "joinDoc", ->
beforeEach ->