local cowait = require "test.cowait"
local mock_msg = require "test.msg"
local unload = require "deftest.util.unload"
local monarch = require "monarch.monarch"

local SCREEN1_STR = hash("screen1")
local SCREEN1 = hash(SCREEN1_STR)
local SCREEN2 = hash("screen2")
local SCREEN_PRELOAD = hash("screen_preload")
local FOCUS1 = hash("focus1")
local BACKGROUND = hash("background")
local POPUP1 = hash("popup1")
local POPUP2 = hash("popup2")
local FOOBAR = hash("foobar")
local TRANSITION1 = hash("transition1")

return function()

	local screens_instances = {}

	local function is_shown(screen_id)
		return monarch.is_visible(screen_id)
	end

	local function is_hidden(screen_id)
		return not monarch.is_visible(screen_id)
	end

	local function wait_timeout(fn, ...)
		local args = { ... }
		cowait(function() return fn(unpack(args)) end, 5)
		return fn(...)
	end

	local function wait_until_done(fn)
		local done = false
		fn(function() done = true end)
		wait_timeout(function() return done end)
	end
	local function wait_until_visible(screen_id)
		return wait_timeout(is_visible, screen_id)
	end
	local function wait_until_shown(screen_id)
		return wait_timeout(is_shown, screen_id)
	end
	local function wait_until_hidden(screen_id)
		return wait_timeout(is_hidden, screen_id)
	end
	local function wait_until_not_busy()
		return wait_timeout(function() return not monarch.is_busy() end)
	end

	local function assert_stack(expected_screens)
		local actual_screens = monarch.get_stack()
		if #actual_screens ~= #expected_screens then
			error("Stack length mismatch", 2)
		end
		for i=1,#actual_screens do
			if actual_screens[i] ~= expected_screens[i] then
				error("Stack content not matching", 2)
			end
		end
	end

	
	describe("monarch", function()
		before(function()
			mock_msg.mock()
			monarch = require "monarch.monarch"
			screens_instances = collectionfactory.create("#screensfactory")
			monarch.debug()
		end)

		after(function()
			while #monarch.get_stack() > 0 do
				monarch.back()
				wait_until_not_busy()
			end
			mock_msg.unmock()
			unload.unload("monarch%..*")
			for id,instance_id in pairs(screens_instances) do
				go.delete(instance_id)
			end
			cowait(0.1)
		end)


		it("should be able to tell if a screen exists", function()
			assert(monarch.screen_exists(SCREEN1))
			assert(monarch.screen_exists(SCREEN1_STR))
			assert(not monarch.screen_exists(hash("foobar")))
		end)


		it("should be able to show screens and go back to previous screens", function()
			monarch.show(SCREEN1_STR)
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert_stack({ SCREEN1 })

			monarch.show(SCREEN2)
			assert(wait_until_hidden(SCREEN1), "Screen1 was never hidden")
			assert(wait_until_shown(SCREEN2), "Screen2 was never shown")
			assert_stack({ SCREEN1, SCREEN2 })

			monarch.back()
			assert(wait_until_hidden(SCREEN2), "Screen2 was never hidden")
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert_stack({ SCREEN1 })

			monarch.back()
			assert(wait_until_hidden(SCREEN1), "Screen1 was never hidden")
			assert_stack({ })
		end)

		it("should be able to tell if a screen is visible or not", function()
			assert(not monarch.is_visible(SCREEN1))
			monarch.show(SCREEN1)
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert_stack({ SCREEN1 })
			assert(monarch.is_visible(SCREEN1))
			
			monarch.show(SCREEN2)
			assert(wait_until_hidden(SCREEN1), "Screen1 was never hidden")
			assert(wait_until_shown(SCREEN2), "Screen2 was never shown")
			assert_stack({ SCREEN1, SCREEN2 })
			assert(not monarch.is_visible(SCREEN1))
			assert(monarch.is_visible(SCREEN2))
			
			monarch.show(POPUP1)
			assert(wait_until_shown(POPUP1), "Popup1 was never shown")
			assert_stack({ SCREEN1, SCREEN2, POPUP1 })
			assert(not monarch.is_visible(SCREEN1))
			assert(monarch.is_visible(SCREEN2))
			assert(monarch.is_visible(POPUP1))
		end)

		it("should be able to show a screen without adding it to the stack", function()
			monarch.show(BACKGROUND, { no_stack = true })
			assert(wait_until_shown(BACKGROUND), "Background was never shown")
			assert_stack({ })

			monarch.show(SCREEN1)
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert_stack({ SCREEN1 })
		end)

		it("should be able to hide a screen not added to the stack", function()
			monarch.show(BACKGROUND, { no_stack = true })
			assert(wait_until_shown(BACKGROUND), "Background was never shown")
			assert_stack({ })

			monarch.hide(BACKGROUND)
			assert(wait_until_hidden(BACKGROUND), "Background was never hidden")
			assert_stack({ })
		end)

		it("should be able to hide the top screen", function()
			monarch.show(SCREEN1)
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert_stack({ SCREEN1 })

			monarch.show(SCREEN2)
			assert(wait_until_hidden(SCREEN1), "Screen1 was never hidden")
			assert(wait_until_shown(SCREEN2), "Screen2 was never shown")
			assert_stack({ SCREEN1, SCREEN2 })

			assert(monarch.hide(SCREEN1) == false)
			assert(monarch.hide(SCREEN2) == true)
			assert(wait_until_hidden(SCREEN2), "Screen2 was never hidden")
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert_stack({ SCREEN1 })
		end)

		it("should be able to pass data to a screen when showning it or going back to it", function()
			local data1 = { foo = "bar" }
			monarch.show(SCREEN1, nil, data1)
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")

			local data2 = { boo = "car" }
			monarch.show(SCREEN2, nil, data2)
			assert(wait_until_shown(SCREEN2), "Screen2 was never shown")
			
			assert(monarch.data(SCREEN1) == data1, "Expected data on screen1 doesn't match actual data")
			assert(monarch.data(SCREEN2) == data2, "Expected data on screen2 doesn't match actual data")

			local data_back = { going = "back" }
			monarch.back(data_back)
			assert_stack({ SCREEN1 })

			assert(monarch.data(SCREEN1) == data_back, "Expected data on screen1 doesn't match actual data")
		end)


		it("should be able to show the same screen twice", function()
			monarch.show(SCREEN1)
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert_stack({ SCREEN1 })
			monarch.show(SCREEN1)
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert_stack({ SCREEN1, SCREEN1 })
		end)
		

		it("should be able to clear the stack if trying to show the same screen twice", function()
			monarch.show(SCREEN1)
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert_stack({ SCREEN1 })
			monarch.show(SCREEN2)
			assert(wait_until_shown(SCREEN2), "Screen2 was never shown")
			assert_stack({ SCREEN1, SCREEN2 })
			monarch.show(SCREEN1, { clear = true })
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert_stack({ SCREEN1 })
		end)
		

		it("should be able to show one popup on top of another if the Popup On Popup flag is set", function()
			monarch.show(SCREEN1)
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert_stack({ SCREEN1 })
			monarch.show(POPUP1)
			assert(wait_until_shown(POPUP1), "Popup1 was never shown")
			assert_stack({ SCREEN1, POPUP1 })
			monarch.show(POPUP2)
			assert(wait_until_shown(POPUP2), "Popup2 was never shown")
			assert_stack({ SCREEN1, POPUP1, POPUP2 })
		end)

		
		it("should prevent further operations while hiding/showing a screen", function()
			assert(monarch.show(SCREEN1) == true)
			assert(monarch.show(SCREEN2) == false)
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert_stack({ SCREEN1 })

			assert(monarch.show(SCREEN2) == true)
			assert(wait_until_shown(SCREEN2), "Screen2 was never shown")
			assert_stack({ SCREEN1, SCREEN2 })

			assert(monarch.back() == true)
			assert(monarch.back() == false)
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert_stack({ SCREEN1 })
		end)
		
		
		it("should close any open popups when showing a popup without the Popup On Popup flag", function()
			monarch.show(SCREEN1)
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert_stack({ SCREEN1 })
			monarch.show(POPUP2)
			assert(wait_until_shown(POPUP2), "Popup2 was never shown")
			assert_stack({ SCREEN1, POPUP2 })
			monarch.show(POPUP1)
			assert(wait_until_shown(POPUP1), "Popup1 was never shown")
			assert_stack({ SCREEN1, POPUP1 })
		end)

		
		it("should close any open popups when showing a non-popup", function()
			monarch.show(SCREEN1)
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert_stack({ SCREEN1 })
			monarch.show(POPUP1)
			assert(wait_until_shown(POPUP1), "Popup1 was never shown")
			assert_stack({ SCREEN1, POPUP1 })
			monarch.show(POPUP2)
			assert(wait_until_shown(POPUP2), "Popup2 was never shown")
			assert_stack({ SCREEN1, POPUP1, POPUP2 })
			monarch.show(SCREEN2)
			assert(wait_until_shown(SCREEN2), "Popup2 was never shown")
			assert_stack({ SCREEN1, SCREEN2 })
		end)


		it("should be able to get the id of the screen at the top and bottom of the stack", function()
			assert(monarch.top() == nil)
			assert(monarch.bottom() == nil)
			assert(monarch.top(1) == nil)
			assert(monarch.bottom(-1) == nil)
						
			monarch.show(SCREEN1)
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert(monarch.top() == SCREEN1)
			assert(monarch.top(0) == SCREEN1)
			assert(monarch.top(1) == nil)
			assert(monarch.bottom() == SCREEN1)
			assert(monarch.bottom(0) == SCREEN1)
			assert(monarch.bottom(-1) == nil)
									
			monarch.show(SCREEN2)
			assert(wait_until_hidden(SCREEN1), "Screen1 was never hidden")
			assert(wait_until_shown(SCREEN2), "Screen2 was never shown")
			assert_stack({ SCREEN1, SCREEN2 })
			assert(monarch.top(0) == SCREEN2)
			assert(monarch.top(-1) == SCREEN1)
			assert(monarch.bottom(0) == SCREEN1)
			assert(monarch.bottom(1) == SCREEN2)
		end)

		it("should be busy while transition is running", function()
			monarch.show(TRANSITION1)
			assert(wait_until_shown(TRANSITION1), "Transition1 was never shown")
			assert(monarch.is_busy())
			assert(wait_until_not_busy())
		end)

		it("should be able to preload a screen and wait for it", function()
			assert(not monarch.is_preloading(TRANSITION1))
			monarch.preload(TRANSITION1)
			assert(monarch.is_preloading(TRANSITION1))
			wait_until_done(function(done)
				monarch.when_preloaded(TRANSITION1, done)
			end)
			assert(not monarch.is_preloading(TRANSITION1))
		end)
		
		it("should ignore any preload calls while busy", function()
			monarch.show(TRANSITION1)
			-- previously a call to preload() while also showing a screen would
			-- lock up monarch. See issue #32
			monarch.preload(TRANSITION1)
			assert(wait_until_shown(TRANSITION1), "Transition1 was never shown")
		end)
		
		it("should be able to notify listeners of navigation events", function()
			local URL1 = msg.url(screens_instances[hash("/listener1")])
			local URL2 = msg.url(screens_instances[hash("/listener2")])
			monarch.add_listener(URL1)
			monarch.add_listener(URL2)

			monarch.show(SCREEN1)
			assert(mock_msg.messages(URL1)[1].message_id == monarch.SCREEN_TRANSITION_IN_STARTED)
			assert(mock_msg.messages(URL1)[1].message.screen == SCREEN1)
			assert(mock_msg.messages(URL2)[1].message_id == monarch.SCREEN_TRANSITION_IN_STARTED)
			assert(mock_msg.messages(URL2)[1].message.screen == SCREEN1)
			assert(wait_until_not_busy())
			assert(mock_msg.messages(URL1)[2].message_id == monarch.SCREEN_TRANSITION_IN_FINISHED)
			assert(mock_msg.messages(URL1)[2].message.screen == SCREEN1)
			assert(mock_msg.messages(URL2)[2].message_id == monarch.SCREEN_TRANSITION_IN_FINISHED)
			assert(mock_msg.messages(URL2)[2].message.screen == SCREEN1)
												
			monarch.remove_listener(URL2)
			monarch.show(SCREEN2)
			assert(wait_until_not_busy())

			assert(#mock_msg.messages(URL1) == 6)
			assert(#mock_msg.messages(URL2) == 2)
			assert(mock_msg.messages(URL1)[3].message_id == monarch.SCREEN_TRANSITION_OUT_STARTED)
			assert(mock_msg.messages(URL1)[3].message.screen == SCREEN1)
			assert(mock_msg.messages(URL1)[4].message_id == monarch.SCREEN_TRANSITION_IN_STARTED)
			assert(mock_msg.messages(URL1)[4].message.screen == SCREEN2)
			assert(mock_msg.messages(URL1)[5].message_id == monarch.SCREEN_TRANSITION_IN_FINISHED)
			assert(mock_msg.messages(URL1)[5].message.screen == SCREEN2)
			assert(mock_msg.messages(URL1)[6].message_id == monarch.SCREEN_TRANSITION_OUT_FINISHED)
			assert(mock_msg.messages(URL1)[6].message.screen == SCREEN1)
						
			monarch.back()
			assert(wait_until_not_busy())
						
			assert(#mock_msg.messages(URL1) == 10)
			assert(#mock_msg.messages(URL2) == 2)
			assert(mock_msg.messages(URL1)[7].message_id == monarch.SCREEN_TRANSITION_OUT_STARTED)
			assert(mock_msg.messages(URL1)[7].message.screen == SCREEN2)
			assert(mock_msg.messages(URL1)[8].message_id == monarch.SCREEN_TRANSITION_IN_STARTED)
			assert(mock_msg.messages(URL1)[8].message.screen == SCREEN1)
			assert(mock_msg.messages(URL1)[9].message_id == monarch.SCREEN_TRANSITION_OUT_FINISHED)
			assert(mock_msg.messages(URL1)[9].message.screen == SCREEN2)
			assert(mock_msg.messages(URL1)[10].message_id == monarch.SCREEN_TRANSITION_IN_FINISHED)
			assert(mock_msg.messages(URL1)[10].message.screen == SCREEN1)
		end)

		it("should be able to show a screen even while it is preloading", function()
			assert(monarch.is_preloading(SCREEN_PRELOAD))
			monarch.show(SCREEN_PRELOAD, nil, { count = 1 })
			assert(wait_until_shown(SCREEN_PRELOAD), "Screen_preload was never shown")
		end)
		
		it("should be able to preload a screen and always keep it loaded", function()
			monarch.show(SCREEN_PRELOAD, nil, { count = 1 })
			assert(wait_until_shown(SCREEN_PRELOAD), "Screen_preload was never shown")
			-- first time the screen gets loaded it will increment the count
			assert(monarch.data(SCREEN_PRELOAD).count == 2)

			monarch.show(SCREEN_PRELOAD, { clear = true }, { count = 1 })
			assert(wait_until_shown(SCREEN_PRELOAD), "Screen_preload was never shown")
			-- second time the screen gets shown it will already be loaded and not increment the count
			assert(monarch.data(SCREEN_PRELOAD).count == 1)
		end)


		it("should be able to reload a preloaded screen", function()
			monarch.show(SCREEN_PRELOAD, nil, { count = 1 })
			assert(wait_until_shown(SCREEN_PRELOAD), "Screen_preload was never shown")
			-- first time the screen gets loaded it will increment the count
			assert(monarch.data(SCREEN_PRELOAD).count == 2)

			monarch.show(SCREEN_PRELOAD, { clear = true, reload = true }, { count = 1 })
			assert(wait_until_shown(SCREEN_PRELOAD), "Screen_preload was never shown")
			-- second time the screen gets shown it will be reloaded and increment the count
			assert(monarch.data(SCREEN_PRELOAD).count == 2)
		end)


		it("should send focus messages", function()
			_G.focus1_gained = nil
			_G.focus1_lost = nil

			monarch.show(SCREEN1)
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			monarch.show(FOCUS1)
			assert(wait_until_shown(FOCUS1), "Screen1 was never shown")
			assert(_G.focus1_gained)
			monarch.show(SCREEN1)
			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
			assert(wait_until_hidden(FOCUS1), "Focus1 was never hidden")
			assert(_G.focus1_lost)
		end)


		it("should be able to post messages without message data to visible screens", function()
			_G.screen1_foobar = nil
			_G.screen2_foobar = nil

			-- proxy screen
			monarch.show(SCREEN1)
			wait_until_shown(SCREEN1)
			assert(monarch.post(SCREEN1, "foobar"), "Expected monarch.post() to return true")
			cowait(0.1)
			assert(_G.screen1_foobar, "Screen1 never received a message")

			-- factory screen
			monarch.show(SCREEN2)
			wait_until_shown(SCREEN2)
			assert(monarch.post(SCREEN2, "foobar"), "Expected monarch.post() to return true")
			cowait(0.1)
			assert(_G.screen2_foobar, "Screen2 never received a message")
		end)


		it("should be able to post messages with message data to visible screens", function()
			_G.screen1_foobar = nil
			_G.screen2_foobar = nil

			-- proxy screen
			monarch.show(SCREEN1)
			wait_until_shown(SCREEN1)
			assert(monarch.post(SCREEN1, "foobar", { foo = "bar" }), "Expected monarch.post() to return true")
			cowait(0.1)
			assert(_G.screen1_foobar, "Screen1 never received a message")
			assert(_G.screen1_foobar.foo == "bar", "Screen1 never received message data")
			
			-- factory screen
			monarch.show(SCREEN2)
			wait_until_shown(SCREEN2)
			assert(monarch.post(SCREEN2, "foobar", { foo = "bar" }), "Expected monarch.post() to return true")
			cowait(0.1)
			assert(_G.screen2_foobar, "Screen2 never received a message")
			assert(_G.screen2_foobar.foo == "bar", "Screen2 never received message data")
		end)


		it("should not be able to post messages to hidden screens", function()
			_G.screen1_foobar = nil

			monarch.show(SCREEN1)
			wait_until_shown(SCREEN1)
			monarch.show(SCREEN2)
			wait_until_shown(SCREEN2)
			local ok, err = monarch.post(SCREEN1, "foobar")
			assert(not ok and err, "Expected monarch.post() to return false plus an error message")
			cowait(0.1)
			assert(not _G.screen1_foobar, "Screen1 should not have received a message")
		end)


		it("should not be able to post messages to proxy screens without a receiver url", function()
			monarch.show(POPUP1)
			wait_until_shown(POPUP1)
			local ok, err = monarch.post(POPUP1, "foobar")
			assert(not ok and err, "Expected monarch.post() to return false plus an error message")
		end)
	end)
end