Merge pull request #153 from sspenst/fix-user-tests

fix: refresh token for user tests

Author: jordan-loeser

.env.template

@@ -1,6 +1,5 @@
+INTEGRATION_TESTS_REFRESH_TOKEN=your_refresh_token_for_tests
 INTEGRATION_TESTS_SPOTIFY_CLIENT_ID=your_spotify_client_id_for_tests
 INTEGRATION_TESTS_SPOTIFY_CLIENT_SECRET=your_spotify_client_secret_for_tests
-INTEGRATION_TESTS_USER_EMAIL=some@validuser.co.uk
-INTEGRATION_TESTS_USER_PASSWORD=some-valid-password
 VITE_SPOTIFY_CLIENT_ID=your_spotify_client_id_for_tests
 VITE_REDIRECT_TARGET=http://localhost:3000

CONTRIBUTING.md

@@ -35,12 +35,11 @@ You will need to create a new app in the Spotify Developer portal, and add a red
 
 Add the following environment variables:
 
+- `INTEGRATION_TESTS_REFRESH_TOKEN`
 - `INTEGRATION_TESTS_SPOTIFY_CLIENT_ID`
 - `INTEGRATION_TESTS_SPOTIFY_CLIENT_SECRET`
-- `INTEGRATION_TESTS_USER_EMAIL`
-- `INTEGRATION_TESTS_USER_PASSWORD`
 
-The latter two credentials are used to run integration tests in the scope of a *real user account*. This is required to test endpoints that require a user's authorization, such as `followPlaylist`. You need to make sure that your user has access to whichever Spotify app your client credentials and secret are for.
+`INTEGRATION_TESTS_REFRESH_TOKEN` is used to run integration tests in the scope of a *real user account*. This is required to test endpoints that require a user's authorization, such as `followPlaylist`. You need to make sure that your user has access to whichever Spotify app your client credentials and secret are for. You can obtain a refresh token by running the example app and authenticating.
 
 You can run the tests with `npm run test`, or using a plugin like [Wallaby](https://wallabyjs.com/).
 
@@ -76,12 +75,11 @@ You will need to create a new app in the Spotify Developer portal, and add a red
 
 You will need to add the following environment variables:
 
+- `INTEGRATION_TESTS_REFRESH_TOKEN`
 - `INTEGRATION_TESTS_SPOTIFY_CLIENT_ID`
 - `INTEGRATION_TESTS_SPOTIFY_CLIENT_SECRET`
-- `INTEGRATION_TESTS_USER_EMAIL`
-- `INTEGRATION_TESTS_USER_PASSWORD`
 
-The latter two credentials are used to run integration tests in the scope of a *real user account*. This is required to test endpoints that require a user's authorization, such as `followPlaylist`. You need to make sure that your user has access to whichever Spotify app your client credentials and secret are for.
+`INTEGRATION_TESTS_REFRESH_TOKEN` is used to run integration tests in the scope of a *real user account*. This is required to test endpoints that require a user's authorization, such as `followPlaylist`. You need to make sure that your user has access to whichever Spotify app your client credentials and secret are for. You can obtain a refresh token by running the example app and authenticating.
 
 You can run the tests with `npm run test`, or using a plugin like [Wallaby](https://wallabyjs.com/).
 

README.md

@@ -293,12 +293,11 @@ You will need to create a new app in the Spotify Developer portal, and add a red
 
 You will need to add the following environment variables:
 
+- `INTEGRATION_TESTS_REFRESH_TOKEN`
 - `INTEGRATION_TESTS_SPOTIFY_CLIENT_ID`
 - `INTEGRATION_TESTS_SPOTIFY_CLIENT_SECRET`
-- `INTEGRATION_TESTS_USER_EMAIL`
-- `INTEGRATION_TESTS_USER_PASSWORD`
 
-The latter two credentials are used to run integration tests in the scope of a *real user account*. This is required to test endpoints that require a user's authorization, such as `followPlaylist`. You need to make sure that your user has access to whichever Spotify app your client credentials and secret are for.
+`INTEGRATION_TESTS_REFRESH_TOKEN` is used to run integration tests in the scope of a *real user account*. This is required to test endpoints that require a user's authorization, such as `followPlaylist`. You need to make sure that your user has access to whichever Spotify app your client credentials and secret are for. You can obtain a refresh token by running the example app and authenticating.
 
 You can run the tests with `npm run test`, or using a plugin like [Wallaby](https://wallabyjs.com/).
 

example/index.html

@@ -20,6 +20,7 @@ <h2>Logged in as <span id="displayName"></span></h2>
             <li>Spotify URI: <a id="uri" href="#"></a></li>
             <li>Link: <a id="url" href="#"></a></li>
             <li>Profile Image: <span id="imgUrl"></span></li>
+            <li>Refresh Token: <span id="refreshToken"></span></li>
         </ul>
     </section>
 

example/script.ts

@@ -24,3 +24,6 @@ document.getElementById("uri")!.setAttribute("href", profile.external_urls.spoti
 document.getElementById("url")!.innerText = profile.href;
 document.getElementById("url")!.setAttribute("href", profile.href);
 document.getElementById("imgUrl")!.innerText = profile.images[0]?.url ?? '(no profile image)';
+
+const accessToken = await authStrategy.getAccessToken();
+document.getElementById("refreshToken")!.innerText = accessToken?.refresh_token ?? '(no refresh token)';

example/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "lib": ["ES2020", "DOM"],
+    "moduleResolution": "bundler",
+    "skipLibCheck": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["**/*.ts", "env.d.ts"]
+}
+