Merge pull request game-by-virtuals#155 from game-by-virtuals/twitter-plugin/yang-improve-error-log

[Twitter Plugin] Improve Error Log

Author: celesteanglm

plugins/twitter/examples/.env.example

@@ -0,0 +1,7 @@
+GAME_TWITTER_ACCESS_TOKEN=apx-<game-twitter-access-token>
+
+TWITTER_BEARER_TOKEN=<twitter-bearer-token>
+TWITTER_API_KEY=<twitter-api-key>
+TWITTER_API_SECRET_KEY=<twitter-api-secret-key>
+TWITTER_ACCESS_TOKEN=<twitter-access-token>
+TWITTER_ACCESS_TOKEN_SECRET=<twitter-access-token_secret>

plugins/twitter/twitter_plugin_gamesdk/twitter_plugin.py

@@ -61,6 +61,20 @@ def __init__(self, options: Dict[str, Any]) -> None:
         credentials = options.get("credentials")
         if not credentials:
             raise ValueError("Twitter API credentials are required.")
+
+        # Capture token for internal use
+        self.game_twitter_access_token = credentials.get("gameTwitterAccessToken")
+
+        # Auth gate: require EITHER gameTwitterAccessToken OR full credential set
+        has_api_credentials = all(
+            credentials.get(key) for key in ["bearerToken", "apiKey", "apiSecretKey", "accessToken", "accessTokenSecret"]
+        )
+
+        if not self.game_twitter_access_token and not has_api_credentials:
+            raise ValueError(
+                "Missing valid authentication. Provide either a 'gameTwitterAccessToken' or all required Twitter API credentials."
+            )
+
         # Init Tweepy client
         self.twitter_client: virtuals_tweepy.Client = virtuals_tweepy.Client(
             bearer_token = credentials.get("bearerToken"),
@@ -74,7 +88,16 @@ def __init__(self, options: Dict[str, Any]) -> None:
         # Configure logging
         logging.basicConfig(level=logging.INFO)
         self.logger: logging.Logger = logging.getLogger(__name__)
-        
-        self.game_twitter_access_token = credentials.get("gameTwitterAccessToken")
-        
 
+        self._check_authentication()
+
+    def _check_authentication(self) -> None:
+        """
+        Check if the credentials provided are valid by calling the /me endpoint or fetching user info.
+        """
+        try:
+            user = self.twitter_client.get_me(user_fields=["public_metrics"]).get('data')
+            self.logger.info(f"Authenticated as: {user.get('name')} (@{user.get('username')})")
+        except virtuals_tweepy.TweepyException as e:
+            self.logger.error(f"Authentication failed: {e}")
+            raise ValueError("Invalid Twitter credentials or failed authentication.")