Merge #76

76: make mocking better and some ci changes r=Emilgardis a=Emilgardis



Co-authored-by: Emil Gardström <emil.gardstrom@gmail.com>

Author: bors[bot]

.github/workflows/ci.yml

@@ -1,6 +1,6 @@
 name: CI
 env:
-  CI_TWITCH_OAUTH2_FEATURES: "all"
+  CI_TWITCH_OAUTH2_FEATURES: "all mock_api"
 on:
   pull_request:
     branches: [master]
@@ -39,7 +39,9 @@ jobs:
         id: cache
         with:
           path: | 
-            ~/.cargo
+            ~/.cargo/registry/index
+            ~/.cargo/registry/cache
+            ~/.cargo/git
             target
           key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
       - name: Test twitch_oauth2
@@ -80,14 +82,16 @@ jobs:
         id: cache
         with:
           path: | 
-            ~/.cargo
+            ~/.cargo/registry/index
+            ~/.cargo/registry/cache
+            ~/.cargo/git
             target
           key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
       - name: Run clippy --all-targets --all-features -- -D warnings
         uses: actions-rs/cargo@v1
         with:
           command: clippy
-          args: --all-targets --all-features -- -D warnings 
+          args: --locked --all-targets --all-features -- -D warnings 
   docs:
     name: Docs
     runs-on: ubuntu-latest
@@ -103,7 +107,9 @@ jobs:
         id: cache
         with:
           path: | 
-            ~/.cargo
+            ~/.cargo/registry/index
+            ~/.cargo/registry/cache
+            ~/.cargo/git
             target
           key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
       # We do the following to make sure docs.rs can document properly without anything broken, and that docs are working.
@@ -116,7 +122,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: doc
-          args: --no-deps --features "${{ env.CI_TWITCH_OAUTH2_FEATURES }}"
+          args: --locked --no-deps --features "${{ env.CI_TWITCH_OAUTH2_FEATURES }}"
   release:
     name: Release
     runs-on: ubuntu-latest

.github/workflows/gh-pages.yml

@@ -1,6 +1,6 @@
 name: github pages
 env:
-  CI_TWITCH_OAUTH2_FEATURES: "all"
+  CI_TWITCH_OAUTH2_FEATURES: "all mock_api"
   RUSTDOCFLAGS: "-Z unstable-options --html-in-header=docs/pre-content.html"
 on:
   push:
@@ -20,7 +20,11 @@ jobs:
         uses: actions/cache@v1
         id: cache
         with:
-          path: ~/.cargo
+          path: 
+            ~/.cargo/registry/index
+            ~/.cargo/registry/cache
+            ~/.cargo/git
+            target
           key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
       - name: mention 40 character commit rev in doc
         run: sed -i "s/{{commit}}/$(git rev-parse HEAD)/g" docs/pre-content.html

.vscode/settings.json

@@ -2,6 +2,6 @@
     "rust-analyzer.checkOnSave.allTargets": false,
     "rust-analyzer.checkOnSave.features": ["all"],
     "rust-analyzer.checkOnSave.enable": true,
-    "rust-analyzer.cargo.features": ["all"],
+    "rust-analyzer.cargo.features": ["all", "mock_api"],
     "rust-analyzer.experimental.procAttrMacros": true
 }

Cargo.toml

@@ -75,4 +75,4 @@ path = "examples/mock_user.rs"
 required-features = ["reqwest_client", "mock_api"]
 
 [package.metadata.docs.rs]
-features = ["all"]
+features = ["all", "mock_api"]

examples/mock_user.rs

@@ -30,7 +30,6 @@ async fn main() -> anyhow::Result<()> {
         &reqwest::Client::builder()
             .redirect(reqwest::redirect::Policy::none())
             .build()?,
-        None,
         client_id,
         client_secret,
         user_id,

src/lib.rs

@@ -75,29 +75,29 @@ macro_rules! mock_env_url {
 static TWITCH_OAUTH2_URL: once_cell::sync::Lazy<url::Url> =
     mock_env_url!("TWITCH_OAUTH2_URL", "https://id.twitch.tv/oauth2/");
 
-/// Authorization URL (`/authorize`) for `id.twitch.tv`
+/// Authorization URL (`https://id.twitch.tv/oauth2/authorize`) for `id.twitch.tv`
 ///
-/// Can be overridden when feature `mock_api` is enabled with environment variable `TWITCH_OAUTH2_URL` to set the root path, or with `TWITCH_OAUTH2_AUTH_URL` to override the full url.
+/// Can be overridden when feature `mock_api` is enabled with environment variable `TWITCH_OAUTH2_URL` to set the root path, or with `TWITCH_OAUTH2_AUTH_URL` to override the base (`https://id.twitch.tv/oauth2/`) url.
 ///
 /// # Examples
 ///
 /// Set the environment variable `TWITCH_OAUTH2_URL` to `http://localhost:8080/auth/` to use [`twitch-cli` mock](https://github.com/twitchdev/twitch-cli/blob/main/docs/mock-api.md) endpoints.
 pub static AUTH_URL: once_cell::sync::Lazy<url::Url> = mock_env_url!("TWITCH_OAUTH2_AUTH_URL", {
     TWITCH_OAUTH2_URL.to_string() + "authorize"
 },);
-/// Token URL (`/token`) for `id.twitch.tv`
+/// Token URL (`https://id.twitch.tv/oauth2/token`) for `id.twitch.tv`
 ///
-/// Can be overridden when feature `mock_api` is enabled with environment variable `TWITCH_OAUTH2_URL` to set the root path, or with `TWITCH_OAUTH2_TOKEN_URL` to override the full url.
+/// Can be overridden when feature `mock_api` is enabled with environment variable `TWITCH_OAUTH2_URL` to set the root path, or with `TWITCH_OAUTH2_TOKEN_URL` to override the base (`https://id.twitch.tv/oauth2/`) url.
 ///
 /// # Examples
 ///
 /// Set the environment variable `TWITCH_OAUTH2_URL` to `http://localhost:8080/auth/` to use [`twitch-cli` mock](https://github.com/twitchdev/twitch-cli/blob/main/docs/mock-api.md) endpoints.
 pub static TOKEN_URL: once_cell::sync::Lazy<url::Url> = mock_env_url!("TWITCH_OAUTH2_TOKEN_URL", {
     TWITCH_OAUTH2_URL.to_string() + "token"
 },);
-/// Validation URL (`/validate`) for `id.twitch.tv`
+/// Validation URL (`https://id.twitch.tv/oauth2/validate`) for `id.twitch.tv`
 ///
-/// Can be overridden when feature `mock_api` is enabled with environment variable `TWITCH_OAUTH2_URL` to set the root path, or with `TWITCH_OAUTH2_VALIDATE_URL` to override the full url.
+/// Can be overridden when feature `mock_api` is enabled with environment variable `TWITCH_OAUTH2_URL` to set the root path, or with `TWITCH_OAUTH2_VALIDATE_URL` to override the base (`https://id.twitch.tv/oauth2/`) url.
 ///
 /// # Examples
 ///
@@ -106,9 +106,9 @@ pub static VALIDATE_URL: once_cell::sync::Lazy<url::Url> =
     mock_env_url!("TWITCH_OAUTH2_VALIDATE_URL", {
         TWITCH_OAUTH2_URL.to_string() + "validate"
     },);
-/// Revokation URL (`/revoke`) for `id.twitch.tv`
+/// Revokation URL (`https://id.twitch.tv/oauth2/revoke`) for `id.twitch.tv`
 ///
-/// Can be overridden when feature `mock_api` is enabled with environment variable `TWITCH_OAUTH2_URL` to set the root path, or with `TWITCH_OAUTH2_REVOKE_URL` to override the full url.
+/// Can be overridden when feature `mock_api` is enabled with environment variable `TWITCH_OAUTH2_URL` to set the root path, or with `TWITCH_OAUTH2_REVOKE_URL` to override the base (`https://id.twitch.tv/oauth2/`) url.
 ///
 /// # Examples
 ///

src/tokens/user_token.rs

@@ -3,7 +3,7 @@ use crate::tokens::{
     errors::{RefreshTokenError, UserTokenExchangeError, ValidationError},
     Scope, TwitchToken,
 };
-use crate::{parse_response, ClientSecret};
+use crate::ClientSecret;
 
 use super::errors::ImplicitUserTokenExchangeError;
 use crate::types::{AccessToken, ClientId, RefreshToken};
@@ -132,8 +132,6 @@ impl UserToken {
 
     /// Generate a user token from [mock-api](https://github.com/twitchdev/twitch-cli/blob/main/docs/mock-api.md#auth-namespace)
     ///
-    /// This will call `/mock/users?user_id={user_id}` to validate the token, since there is no `auth/validate` endpoint in mock-api.
-    ///
     /// # Examples
     ///
     /// ```rust,no_run
@@ -143,8 +141,6 @@ impl UserToken {
     ///     &reqwest::Client::builder()
     ///         .redirect(reqwest::redirect::Policy::none())
     ///         .build()?,
-    ///     // Pass in the mock api url to mock/users, if this is none, we'll assume the host is the same as the `/auth` url, but living instead on `/mock/users`
-    ///     None,
     ///     "mockclientid".into(),
     ///     "mockclientsecret".into(),
     ///     "user_id",
@@ -154,9 +150,9 @@ impl UserToken {
     /// # fn main() {run();}
     /// ```
     #[cfg_attr(nightly, doc(cfg(feature = "mock_api")))]
+    #[cfg(feature = "mock_api")]
     pub async fn mock_token<'a, C>(
         http_client: &'a C,
-        mock_api_users_url: impl Into<Option<url::Url>>,
         client_id: ClientId,
         client_secret: ClientSecret,
         user_id: impl AsRef<str>,
@@ -189,61 +185,16 @@ impl UserToken {
             .req(req)
             .await
             .map_err(UserTokenExchangeError::RequestError)?;
-        let response: crate::id::TwitchTokenResponse = parse_response(&resp)?;
-        let expires_in = response.expires_in();
-        let auth_header = format!("bearer {}", response.access_token().secret());
-        let mut user_headers = HeaderMap::new();
-        user_headers.insert(
-            http::header::AUTHORIZATION,
-            auth_header
-                .parse()
-                .expect("Failed to parse header for validation"),
-        );
-        user_headers.insert(
-            "Client-ID",
-            client_id
-                .as_str()
-                .parse()
-                .expect("Failed to parse header for validation"),
-        );
-        let mock_api_users_url = if let Some(url) = mock_api_users_url.into() {
-            url
-        } else {
-            // user didn't provide a url for user api mock. We assume the mock api lives on the same place as /auth
-            let mut url = crate::TWITCH_OAUTH2_URL.clone();
-            url.set_path("mock/users");
-            url
-        };
-
-        let user_req = crate::construct_request(
-            &mock_api_users_url,
-            &[("user_id", user_id)],
-            user_headers,
-            Method::GET,
-            vec![],
-        );
-
-        let user = http_client
-            .req(user_req)
-            .await
-            .map_err(UserTokenExchangeError::RequestError)?;
-
-        let user: serde_json::Value = crate::parse_response(&user)?;
+        let response: crate::id::TwitchTokenResponse = crate::parse_response(&resp)?;
 
-        Ok(UserToken::from_existing_unchecked(
+        UserToken::from_existing(
+            http_client,
             response.access_token,
             response.refresh_token,
-            client_id,
             client_secret,
-            user.pointer("/data/0/login")
-                .and_then(|login| login.as_str().map(|s| s.to_string()))
-                .unwrap(),
-            user.pointer("/data/0/id")
-                .and_then(|id| id.as_str().map(|s| s.to_string()))
-                .unwrap(),
-            response.scopes,
-            expires_in,
-        ))
+        )
+        .await
+        .map_err(Into::into)
     }
 
     /// Set the client secret