Finish Mobile <-> WearOS Communication

[thehale]

This is a top-level ticket tracking progress towards full implementation of the SimpleTimeTrackerAPI on both the WearOS and Mobile apps.

Background

Communication between the WearOS app and the Mobile app occurs via an RPC Client/Server implemented using Google's MessageClient and its related APIs.

The plumbing of the communication is already complete: the wear app has an RPC client that sends messages to the phones's RPC server (implemented as a Service so it can respond even when the app is in the background or the phone is sleeping).

sequenceDiagram
    actor User
    
    box green WearOS
    participant UI (Wear)
    participant WearRPCClient
    participant Messenger
    end

    box blue Phone
    participant WearService
    participant WearRPCServer
    participant DomainAPI
    end

    User->>UI (Wear): Interact with Wear app
    UI (Wear)->>WearRPCClient: Request needed data
    WearRPCClient->>WearRPCClient: Serialize message to BytesArray
    WearRPCClient->>Messenger: Request message delivery
    Messenger->>Messenger: Find nearest node
    Messenger->>WearService: Send message to phone
    WearService->>WearService: Wake up from sleep/background
    WearService->>WearRPCServer: Delegate message to RPC Server
    WearRPCServer->>WearRPCServer: Parse the message
    WearRPCServer->>DomainAPI: Request needed data
    DomainAPI->>DomainAPI: Query/update the Database
    DomainAPI->>WearRPCServer: Return data from database
    WearRPCServer->>WearService: Serialize response to BytesArray
    WearService->>Messenger: Return response
    Messenger->>Messenger: Run validation checks/error handling
    Messenger->>WearRPCClient: Forward response
    WearRPCClient->>WearRPCClient: Parse response
    WearRPCClient->>UI (Wear): Return requested data
    UI (Wear)->>User: Render UI update

Both the WearRPCClient and the DomainAPI implement the SimpleTimeTrackerAPI interface which defines all the methods believed to be necessary for the WearOS MVP.

Remaining Work

The following list of tickets track each method in WearRPCClient and DomainAPI not yet implemented. Once all the following are complete, this ticket can be closed as complete.

WearOS app

• Implement WearRPCClient.ping
• Implement WearRPCClient.queryActivities
• Implement WearRPCClient.queryCurrentActivities
• Implement WearRPCClient.setCurrentActivities
• Implement WearRPCClient.queryTagsForActivity
• Implement WearRPCClient.querySettings

Mobile app

• Implement WearRPCServer.onRequest
• Implement WearRPCServer.onPing
• Implement WearRPCServer.onQueryActivities
• Implement WearRPCServer.onQueryCurrentActivities
• Implement WearRPCServer.onSetCurrentActivities
• Implement WearRPCServer.onQueryTagsForActivity
• Implement WearRPCServer.onQuerySettings
• Implement DomainAPI.ping
• Implement DomainAPI.queryActivities
• Implement DomainAPI.queryCurrentActivities
• Implement DomainAPI.setCurrentActivities
• Implement DomainAPI.queryTagsForActivity
• Implement DomainAPI.querySettings

[thehale]

Another large tranche of methods were implemented in d46bccf

[thehale]

DomainAPI.queryTagsForActivity was completed in ef3384f

[thehale]

DomainAPI.queryCurrentActivities was fully completed in c328fc1