refactor!: manually fetch csrf cookie

Author: alexzarbn

src/httpClient.ts

@@ -1,10 +1,8 @@
 import { HttpMethod } from './drivers/default/enums/httpMethod';
 import { Orion } from './orion';
-import { AuthDriver } from './drivers/default/enums/authDriver';
 import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 
 export class HttpClient {
-	protected static xsrfTokenFetched: boolean = false;
 	protected baseUrl: string;
 	protected client: AxiosInstance;
 
@@ -19,10 +17,6 @@ export class HttpClient {
 		params: any = {},
 		data: any = {}
 	): Promise<AxiosResponse> {
-		if (Orion.getAuthDriver() === AuthDriver.Sanctum) {
-			await this.prefetchXSRFToken();
-		}
-
 		const config: AxiosRequestConfig = Object.assign(Orion.getHttpClientConfig(), {
 			baseURL: this.baseUrl,
 			url,
@@ -37,21 +31,6 @@ export class HttpClient {
 		return this.client.request(config);
 	}
 
-	public async prefetchXSRFToken(): Promise<void> {
-		if (HttpClient.xsrfTokenFetched) {
-			return;
-		}
-
-		await this.client
-			.get(`sanctum/csrf-cookie`, { baseURL: Orion.getHost() })
-			.then(() => {
-				HttpClient.xsrfTokenFetched = true;
-			})
-			.catch(() => {
-				HttpClient.xsrfTokenFetched = false;
-			});
-	}
-
 	public getAxios(): AxiosInstance {
 		return this.client;
 	}

src/orion.ts

@@ -99,6 +99,18 @@ export class Orion {
 		return this;
 	}
 
+	public static async csrf(): Promise<void> {
+		if (this.authDriver !== AuthDriver.Sanctum) {
+			throw new Error(
+				`Current auth driver is set to "${this.authDriver}". Fetching CSRF cookie can only be used with "sanctum" driver.`
+			);
+		}
+
+		await Orion.makeHttpClient()
+			.getAxios()
+			.get(`sanctum/csrf-cookie`, { baseURL: Orion.getHost() });
+	}
+
 	protected static buildHttpClientConfig(): AxiosRequestConfig {
 		const config: AxiosRequestConfig = {
 			withCredentials: Orion.getAuthDriver() === AuthDriver.Sanctum,

tests/integration/httpClient.test.ts

@@ -1,7 +1,6 @@
 import { Orion } from '../../src/orion';
 import makeServer from './drivers/default/server';
 import { HttpMethod } from '../../src/drivers/default/enums/httpMethod';
-import { AuthDriver } from '../../src/drivers/default/enums/authDriver';
 
 let server: any;
 
@@ -23,18 +22,4 @@ describe('HttpClient tests', () => {
 		const requests = server.pretender.handledRequests;
 		expect(requests[0].requestHeaders['Authorization']).toStrictEqual('Bearer test');
 	});
-
-	test('prefetching xsrf token', async () => {
-		server.schema.posts.create({ title: 'Test Post' });
-
-		Orion.setAuthDriver(AuthDriver.Sanctum);
-		await Orion.makeHttpClient().request('/posts', HttpMethod.GET);
-
-		const requests = server.pretender.handledRequests;
-		expect(requests[0].url).toBe('https://api-mock.test/sanctum/csrf-cookie');
-		expect(requests[1].url).toBe('https://api-mock.test/api/posts');
-
-		await Orion.makeHttpClient().request('/posts', HttpMethod.GET);
-		expect(requests[2].url).toBe('https://api-mock.test/api/posts');
-	});
 });

tests/integration/orion.test.ts

@@ -0,0 +1,40 @@
+import { Orion } from '../../src/orion';
+import { AuthDriver } from '../../src/drivers/default/enums/authDriver';
+import makeServer from './drivers/default/server';
+
+let server: any;
+
+beforeEach(() => {
+	server = makeServer();
+});
+
+afterEach(() => {
+	server.shutdown();
+});
+
+describe('Orion tests', () => {
+	test('fetching csrf cookie', async () => {
+		Orion.setAuthDriver(AuthDriver.Sanctum);
+
+		await Orion.csrf();
+
+		const requests = server.pretender.handledRequests;
+		expect(requests[0].url).toBe('https://api-mock.test/sanctum/csrf-cookie');
+	});
+
+	test('attempting to fetch csrf cookie with invalid driver', async () => {
+		Orion.setAuthDriver(AuthDriver.Passport);
+
+		try {
+			await Orion.csrf();
+			expect(false).toBeTruthy();
+		} catch (error) {
+			expect(error.message).toBe(
+				`Current auth driver is set to "${AuthDriver.Passport}". Fetching CSRF cookie can only be used with "sanctum" driver.`
+			);
+		}
+
+		const requests = server.pretender.handledRequests;
+		expect(requests).toHaveLength(0);
+	});
+});

tests/unit/orion.test.ts

@@ -1,6 +1,7 @@
 import { Orion } from '../../src/orion';
 import { AuthDriver } from '../../src/drivers/default/enums/authDriver';
 import axios from 'axios';
+import { HttpMethod } from '../../src/drivers/default/enums/httpMethod';
 
 describe('Orion tests', () => {
 	test('initialization', () => {