WIP: Feature: Friends & User Presence by elkangaroo · Pull Request #33 · bartok765/galaxy_blizzard_plugin

elkangaroo · 2020-07-12T02:39:06Z

WORK IN PROGRESS

Status Quo:

fetching friends list works
fetching friends presence works and can distinguish between offline, online, afk
fetching friends presence shows currently played game, if any
friends presence does not show in the Galaxy friends sidebar yet, only in log files (corresponding issue: Please enable user presence (friend sidebar) for battle.net platform gogcom/galaxy-integrations-python-api#164)
plugin needs to handle echo requests from battle.net server, otherwise will be disconnected after a few minutes

Partly solves #28

Needs more testing!

test friends presence with all battle.net games (tested with: Overwatch, StarCraft II, Diablo III, World of Warcraft)
test friends presence when friend has battle.net state "dnd" (does it map to gog "away"-state?)
test with GOG open for longer time (does it update correctly?)
- it updates correctly in subsequent "users presence import" from plugin
- sometimes we receive a disconnect message from battle.net, can we prevent this or try to re-connect?
test what happens when authenticated user is logged into Battle.net Mobile App

… in get_friends

…eplace callbacks with futures

elkangaroo · 2020-07-12T14:43:01Z

I rebased the branch and rewrote the socked handling using asyncio.
Now it can handle the echo requests from battle.net server and as a nice side effect is much faster than the previous implementation 🥳

elkangaroo · 2020-07-13T17:59:42Z

Now friends presence works correctly when multiple "game_accounts" are returned (which - from my understanding - means the friend is logged in multiple times [on multiple devices]).
It aggregates them and should return correct state and game.

Needs more testing, but otherwise I am quiet happy with the state of this PR now :)

bartok765

Thanks for getting me read this tonight, it is nice to read good code and learn something.

I've added some comments and some questions but in fact mostly testing is needed.

src/bnet_client.py

src/plugin.py

bartok765 · 2020-07-15T23:31:30Z

src/bnet_client.py

+        request = authentication_service_pb2.LogonRequest()
+        # request.program = "App"
+        request.program = "BSAp"  # login in as mobile
+        request.platform = "Win"


what does it mean for BSAp ?

What do you mean?

I mean is platform="Win" (windows) valid if program stands for Mobile App? Shouldn't be Android or iOS instead?

I know that for now it works, but it may looks... strange for blizzard backend metrics...

Ah, I see. I can try different values but don't know what it expects.

bartok765 · 2020-07-15T23:32:46Z

src/bnet_client.py

+        # request.program = "App"
+        request.program = "BSAp"  # login in as mobile
+        request.platform = "Win"
+        request.locale = "enUS"


for now we have no regional info fetched from proto communication so there is no need to specify that right?

I tried not sending locale, but then get immediately disconnected.
Do we have the correct value from authentication that we could use? I think we only have "region" ('eu', 'us', ...) so far, right?

yes, and the region is partially guessed, as login page require knowing it a priori...
There is https://www.blizzard.com/user but it defaults to en_US for me even if I have different settings (however I know it works for china).

For now I would leave en_US. Then we could ask @wanze for testing the same with china locale - if the rich present text is localized.

src/bnet_client.py

elkangaroo · 2020-07-18T11:52:57Z

Thanks @bartok765 for your review. I will look into your comments now.

elkangaroo · 2020-07-24T20:13:38Z

Hey @bartok765 I addressed most of your comments, can you please review again?

bartok765

I've left some comments, but it looks really nice already!

bartok765 · 2020-07-26T21:50:10Z

src/bnet_client.py

+        # request.program = "App"
+        request.program = "BSAp"  # login in as mobile
+        request.platform = "Win"
+        request.locale = "enUS"


yes, and the region is partially guessed, as login page require knowing it a priori...
There is https://www.blizzard.com/user but it defaults to en_US for me even if I have different settings (however I know it works for china).

For now I would leave en_US. Then we could ask @wanze for testing the same with china locale - if the rich present text is localized.

bartok765 · 2020-07-26T21:50:30Z

src/bnet_client.py

+        request = authentication_service_pb2.LogonRequest()
+        # request.program = "App"
+        request.program = "BSAp"  # login in as mobile
+        request.platform = "Win"


I mean is platform="Win" (windows) valid if program stands for Mobile App? Shouldn't be Android or iOS instead?

I know that for now it works, but it may looks... strange for blizzard backend metrics...

src/bnet_client.py

bartok765 · 2020-07-26T23:00:44Z

src/bnet_client.py

        await self._send_message(self._PRESENCE_SERVICE, 4, request, functools.partial(self._on_presence__query_account, future))

-    async def fetch_friend_presence_account_details(self, account_id, future: asyncio.Future):
+    async def fetch_friend_presence_account_details(self, entity_id, future: 'asyncio.Future[AccountInfo]'):


we can avoid repeating code for fetch_friend_battle_tag and fetch_friend_presence_account_details

What is your suggestion @bartok765 ? Maybe just put this in a private function with variable values replaced?

request = presence_service_pb2.QueryRequest() request.entity_id.high = entity_id.high request.entity_id.low = entity_id.low for i in [...]: key = request.key.add() key.program = 0x424e # hex code for "BN" key.group = ... key.field = i

Or do you have another idea?

group is the same in both methods, so yes - it could be either one private method for basic request with additional parameter of field list to set OR both methods may be just merged into one with additional param. I have no opinion which is better.

elkangaroo added 8 commits July 12, 2020 15:30

add proto files and re-compile them using latest protoc

07ae41d

restore and adjust BNetClient; WIP get_user_presence

3028d82

WIP refactor BNetClient; connect during authenticate; fetch battletag…

cb8d196

… in get_friends

WIP get_user_presence: detect away status, detect user is in-game

c906221

refactor: method names, fetch only battletags in get_friends

8f79afb

refactor: clean-up, bnet game_account presence WIP, bnet echo WIP

d125309

rewrite battle.net socket connection using asyncio.open_connection, r…

f79847f

…eplace callbacks with futures

fix user_presence game_id after rebase

4f43411

elkangaroo force-pushed the feature/friends_presence branch from fbd9747 to 4f43411 Compare July 12, 2020 14:37

correctly aggregate presence for multiple game_accounts of same user

09146eb

elkangaroo mentioned this pull request Jul 14, 2020

Please enable user presence (friend sidebar) for battle.net platform gogcom/galaxy-integrations-python-api#164

Open

fix Readme merge error

d6df493

bartok765 reviewed Jul 15, 2020

View reviewed changes

code review: remove unused code, minor changes

dd1d917

elkangaroo added 3 commits July 18, 2020 15:03

code review: adjust logging

f9e8687

code review: create classes for values returned in futures

199197b

add timeouts for futures, fix endless loop after disconnect

660f009

bartok765 reviewed Jul 26, 2020

View reviewed changes

code review: constants, types

ccdfa18

bartok765 force-pushed the master branch from 4de3476 to 05168d0 Compare December 14, 2020 10:40

bartok765 mentioned this pull request Nov 8, 2021

Diablo2: resurrected marked owned and added to recent games, but not actually owned #66

Open

bartok765 mentioned this pull request Nov 18, 2021

Transfer to organization #71

Open

Conversation

elkangaroo commented Jul 12, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

elkangaroo commented Jul 12, 2020

Uh oh!

elkangaroo commented Jul 13, 2020

Uh oh!

bartok765 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

elkangaroo commented Jul 18, 2020

Uh oh!

elkangaroo commented Jul 24, 2020

Uh oh!

bartok765 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

elkangaroo commented Jul 12, 2020 •

edited

Loading