@spotify/web-api-ts-sdk/src/test/SpotifyApiBuilder.ts

A typescript SDK for the Spotify Web API

import { SpotifyApi } from "../SpotifyApi";
import ClientCredentialsStrategy from "../auth/ClientCredentialsStrategy";
import { FakeAuthStrategy } from "./FakeAuthStrategy";
import { FetchApiMock } from "./FetchApiMock";
import { FetchApiSpy } from "./FetchApiSpy";
import AuthAsSpecifcUserForTests from "./AuthAsRealUserForTests";
import InMemoryCachingStrategy from "../caching/InMemoryCachingStrategy";
import { Scopes } from "../Scopes";

import dotenv from "dotenv";
import { SdkOptions } from "../types";
dotenv.config();

export function buildIntegrationTestSdkInstance(logResults: boolean = false): [SpotifyApi, FetchApiSpy] {
    // This should be replaced with a representative server-side auth flow
    // that returns a valid access token.

    // We'll load access keys from the .env file, so if it's not provided
    // all the integration tests will deliberately fail and not hit
    // the Spotify API

    const clientId = process.env.INTEGRATION_TESTS_SPOTIFY_CLIENT_ID;
    const clientSecret = process.env.INTEGRATION_TESTS_SPOTIFY_CLIENT_SECRET;

    if (!clientId || !clientSecret) {
        throw new Error("No client ID or secret provided. Please provide a valid Spotify client ID and secret in the /.env file as: INTEGRATION_TESTS_SPOTIFY_CLIENT_ID and INTEGRATION_TESTS_SPOTIFY_CLIENT_SECRET");
    }

    const authStrat = new ClientCredentialsStrategy(clientId, clientSecret);

    const fetchSpy = new FetchApiSpy(logResults);
    const sdkConfig = {
        fetch: (input: RequestInfo | URL, init?: RequestInit | undefined) => {
            return fetchSpy.fetch(input, init);
        },
        cachingStrategy: new InMemoryCachingStrategy()
    }

    const sdkInstance = new SpotifyApi(authStrat, sdkConfig);

    return [sdkInstance, fetchSpy];
}

export function buildIntegrationTestUserSdkInstance(logResults: boolean = false): [SpotifyApi, FetchApiSpy] {
    const clientId = process.env.INTEGRATION_TESTS_SPOTIFY_CLIENT_ID;
    const email = process.env.INTEGRATION_TESTS_USER_EMAIL;
    const password = process.env.INTEGRATION_TESTS_USER_PASSWORD;

    if (!clientId || !email || !password) {
        throw new Error("No client ID, or secret, or email, or password provided. Please provide a valid Spotify client ID and secret in the /.env file.");
    }

    const authStrat = new AuthAsSpecifcUserForTests(clientId, Scopes.all, email, password);

    const fetchSpy = new FetchApiSpy(logResults);
    const sdkConfig = {
        fetch: (input: RequestInfo | URL, init?: RequestInit | undefined) => {
            return fetchSpy.fetch(input, init);
        },
        cachingStrategy: new InMemoryCachingStrategy()
    }

    const sdkInstance = new SpotifyApi(authStrat, sdkConfig);

    return [sdkInstance, fetchSpy];
}

export function buildUnitTestSdkInstance(): [SpotifyApi, FetchApiMock] {
    const authStrat = new FakeAuthStrategy();
    const fetchMock = new FetchApiMock();
    const sdkConfig: SdkOptions = {
        fetch: (input: RequestInfo | URL, init?: RequestInit | undefined) => {
            return fetchMock.fetch(input, init);
        },
        cachingStrategy: new InMemoryCachingStrategy()
    };

    const sdkInstance = new SpotifyApi(authStrat, sdkConfig);

    return [sdkInstance, fetchMock];
}