@lokalise/node-api/test/oauth2/lokalise_auth.spec.ts

Official Lokalise API 2.0 Node.js client

import type {
	AuthError,
	RefreshTokenResponse,
	RequestTokenResponse,
} from "../../src/main.js";
import { describe, expect, it, LokaliseAuth, Stub } from "../setup.js";

describe("LokaliseAuth", () => {
	const client_id = <string>process.env.OAUTH2_CLIENT_ID;
	const client_secret = <string>process.env.OAUTH2_CLIENT_SECRET;
	const refresh_token = <string>process.env.OAUTH2_REFRESH_TOKEN;
	const lokaliseAuth = new LokaliseAuth(client_id, client_secret);
	const rootUrl = lokaliseAuth.authData.host;

	describe("constructor", () => {
		it("is expected to throw an error if the client secret is not provided", () => {
			expect(() => {
				new LokaliseAuth("fake", "");
			}).to.throw(Error);
		});

		it("is expected to throw an error if the client id is not provided", () => {
			expect(() => {
				new LokaliseAuth("", "fake");
			}).to.throw(Error);
		});

		it("is expected to set authData", () => {
			const dummy = new LokaliseAuth("id", "secret");
			expect(dummy.authData.client_id).to.eq("id");
			expect(dummy.authData.client_secret).to.eq("secret");
			expect(dummy.authData.version).to.eq("oauth2");
		});
	});

	describe("auth", () => {
		it("returns proper url with all set attrs", () => {
			const url = lokaliseAuth.auth(
				["read_projects", "write_team_groups"],
				"http://example.com/redirect",
				"random123",
			);
			expect(url).to.include(`?client_id=${client_id}`);
			expect(url).to.include("&scope=read_projects+write_team_groups");
			expect(url).to.include("&state=random123");
			expect(url).to.include(
				"&redirect_uri=http%3A%2F%2Fexample.com%2Fredirect",
			);
		});

		it("returns proper url with scope as string", () => {
			const url = lokaliseAuth.auth("read_projects");
			expect(url).to.include(`?client_id=${client_id}`);
			expect(url).to.include("&scope=read_projects");
		});
	});

	describe("token", () => {
		const code = "12988e3ec899e0c73a1fc4909063d81ca5ab0dd1";

		it("handles exceptions", async () => {
			const stub = new Stub({
				uri: "token",
				version: "oauth2",
				method: "POST",
				rootUrl: rootUrl,
				skipApiToken: true,
				doFail: true,
				body: {
					client_id,
					client_secret,
					code,
					grant_type: "authorization_code",
				},
			});

			await stub.setStub();

			await lokaliseAuth.token(code).catch((e) => {
				expect(e.error).to.eq("fetch failed");
			});
		});

		it("can be requested", async () => {
			const stub = new Stub({
				fixture: "oauth2/token.json",
				uri: "token",
				version: "oauth2",
				method: "POST",
				rootUrl: rootUrl,
				skipApiToken: true,
				body: {
					client_id,
					client_secret,
					code,
					grant_type: "authorization_code",
				},
			});

			await stub.setStub();

			const resp: RequestTokenResponse = await lokaliseAuth.token(code);

			expect(resp.access_token).to.eq("stubbed access");
			expect(resp.refresh_token).to.eq("stubbed refresh");
			expect(resp.expires_in).to.eq(3600);
			expect(resp.token_type).to.eq("Bearer");
		});

		it("handles errors", async () => {
			const stub = new Stub({
				fixture: "oauth2/token_error.json",
				uri: "token",
				version: "oauth2",
				status: 400,
				method: "POST",
				rootUrl: rootUrl,
				skipApiToken: true,
				body: {
					client_id,
					client_secret,
					code: "fake",
					grant_type: "authorization_code",
				},
			});

			await stub.setStub();

			await lokaliseAuth.token("fake").catch((e: AuthError) => {
				expect(e.code).to.equal(400);
				expect(e.error).to.equal("invalid_request");
				expect(e.error_description).to.equal(
					"code: Code must be 40 characters long",
				);
				expect(e.error_uri).to.equal("");
			});
		});
	});

	describe("refresh", () => {
		it("can be requested", async () => {
			const stub = new Stub({
				fixture: "oauth2/refresh.json",
				uri: "token",
				version: "oauth2",
				method: "POST",
				rootUrl: rootUrl,
				skipApiToken: true,
				body: {
					client_id,
					client_secret,
					refresh_token,
					grant_type: "refresh_token",
				},
			});

			await stub.setStub();

			const resp: RefreshTokenResponse =
				await lokaliseAuth.refresh(refresh_token);

			expect(resp.access_token).to.eq("stubbed access");
			expect(resp.scope).to.eq("write_team_groups read_projects");
			expect(resp.expires_in).to.eq(3600);
			expect(resp.token_type).to.eq("Bearer");
		});

		it("handles unexpected errors", async () => {
			const stub = new Stub({
				uri: "token",
				status: 400,
				version: "oauth2",
				method: "POST",
				rootUrl: rootUrl,
				skipApiToken: true,
				body: {
					client_id,
					client_secret,
					refresh_token: "fake",
					grant_type: "refresh_token",
				},
			});

			await stub.setStub();

			await lokaliseAuth.refresh("fake").catch((e: AuthError) => {
				expect(e.error).to.equal("Unexpected end of JSON input");
			});
		});

		it("handles errors", async () => {
			const stub = new Stub({
				fixture: "oauth2/refresh_error.json",
				uri: "token",
				status: 400,
				version: "oauth2",
				method: "POST",
				rootUrl: rootUrl,
				skipApiToken: true,
				body: {
					client_id,
					client_secret,
					refresh_token: "fake",
					grant_type: "refresh_token",
				},
			});

			await stub.setStub();

			await lokaliseAuth.refresh("fake").catch((e: AuthError) => {
				expect(e.code).to.equal(400);
				expect(e.error).to.equal("invalid_request");
				expect(e.error_description).to.equal(
					"refresh_token: Refresh token too short",
				);
				expect(e.error_uri).to.equal("");
			});
		});
	});
});