Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added firebase redirect authentication #44

Merged
merged 3 commits into from
Oct 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions src/features/auth/AuthMain.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,23 @@ describe("CurrentUserStateIndicator", () => {
(firestoreAuth.login as jest.Mock).mockClear();
});

it("can login", async () => {
it("login will set loading ui to prevent double trigger", async () => {
(firestoreAuth.login as jest.Mock).mockResolvedValue(
new Promise((resolve) => setTimeout(resolve, 500))
);

const { store } = fullRender(<AuthMain />);

const loginButtonElement = screen.getByRole("button", {
name: "Continue with Google",
});
await act(() => fireEvent.click(loginButtonElement));

await waitFor(() => expect(store.getState().user.uid).not.toBe(""));
await waitFor(() => expect(store.getState().user.uid).toBe(""));
await waitFor(() => expect(screen.getByText("Checking...")).toBeTruthy());
});

it("login is integrated with firestore", async () => {
it("triggering login will rely on firestore module", async () => {
fullRender(<AuthMain />);

const loginButtonElement = screen.getByRole("button", {
Expand Down
9 changes: 5 additions & 4 deletions src/services/firestore-auth.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ import * as firebaseAuth from "firebase/auth";
describe("firestoreAuth", () => {
it("should successfully log in and return user information", async () => {
jest.spyOn(firebaseAuth, "getAuth");
jest.spyOn(firebaseAuth, "signInWithPopup");
const user = await firestoreAuth.login();
jest.spyOn(firebaseAuth, "getRedirectResult");
await firestoreAuth.login();
const user = await firestoreAuth.loadUser();
expect(user).toEqual({
uid: "abc123def456",
displayName: "Jane Doe",
Expand All @@ -16,7 +17,7 @@ describe("firestoreAuth", () => {

it("should block log in when user email is null", async () => {
jest.spyOn(firebaseAuth, "getAuth");
jest.spyOn(firebaseAuth, "signInWithPopup").mockResolvedValue({
jest.spyOn(firebaseAuth, "getRedirectResult").mockResolvedValue({
operationType: "signIn",
providerId: "google.com",
user: {
Expand All @@ -39,7 +40,7 @@ describe("firestoreAuth", () => {
photoURL: "",
},
});
await expect(firestoreAuth.login()).rejects.toThrow(
await expect(firestoreAuth.loadUser()).rejects.toThrow(
"Login blocked: unidentified user."
);
});
Expand Down
70 changes: 34 additions & 36 deletions src/services/firestore-auth.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ import type { User as FirebaseUser } from "firebase/auth";
import {
browserLocalPersistence,
getAuth,
getRedirectResult,
setPersistence,
signInWithPopup,
signInWithRedirect,
signOut,
} from "firebase/auth";
import { googleAuthProvider } from "./firestore-connection";
Expand All @@ -18,54 +19,51 @@ const firestoreAuth = {

export default firestoreAuth;

/** Loads user from redirection result, persistence, whatever. */
async function loadUser(): Promise<User> {
const empty: User = { uid: "", displayName: "", email: "" };

return new Promise((resolve) => {
const done = (user: FirebaseUser | null) => {
try {
if (user) {
const { uid, displayName, email } = user;
resolve({
uid,
displayName: displayName ?? email ?? "",
email: email ?? "?@?",
});
} else {
resolve(empty);
}
} catch (error) {
return new Promise((resolve, reject) => {
const handleResult = (user: FirebaseUser | null) => {
if (!user) {
const empty: User = { uid: "", displayName: "", email: "" };
resolve(empty);
return;
}

if (!user.uid || !user.email) {
reject(new Error("Login blocked: unidentified user."));
return;
}

resolve({
uid: user.uid,
displayName: user.displayName ?? user.email,
email: user.email,
});
};

setTimeout(() => done(null), 3000);
getAuth().onAuthStateChanged(once(done));
// prepare auth for one of the following events:
const auth = getAuth();
const onceHandleResult = once(handleResult);
// case of timeout (this was specially important for popup method but now not so much)
setTimeout(() => onceHandleResult(null), 5 * 1000);
// case of loaded by something else (like persistent successfully loaded)
auth.onAuthStateChanged(onceHandleResult);
// case of got result from redirect flow
getRedirectResult(auth)
.then((credentials) => credentials?.user || null)
.then(onceHandleResult);
});
}

async function login(): Promise<User> {
/** Trigger the login function, it redirects to an authentication page. */
async function login(): Promise<void> {
const auth = getAuth();

await setPersistence(auth, browserLocalPersistence);

const result = await signInWithPopup(auth, googleAuthProvider);
const {
user: { uid, displayName, email },
} = result;

if (!email) {
signOut(auth);
throw new Error("Login blocked: unidentified user.");
}

return {
uid,
displayName: displayName ?? email,
email,
};
await signInWithRedirect(auth, googleAuthProvider);
}

/** Clears the authentication data. */
async function logout() {
signOut(getAuth());
}
2 changes: 1 addition & 1 deletion src/state/user.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export const loadUser = createAsyncThunk(

export const login = createAsyncThunk(
"user/login",
() => firestoreAuth.login(),
() => firestoreAuth.login().then(firestoreAuth.loadUser),
{
condition: (_arg, thunkAPI) =>
(thunkAPI.getState() as RootState).user.status === "idle",
Expand Down
5 changes: 3 additions & 2 deletions src/testing-helpers/mock-firebase-auth.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type { Auth, AuthProvider } from "firebase/auth";

jest.mock("firebase/auth", () => ({
getAuth: jest.fn(),
getAuth: jest.fn().mockReturnValue({ onAuthStateChanged: jest.fn() }),
GoogleAuthProvider: jest.fn(() => ({
Qc: ["client_id", "response_type", "scope", "redirect_uri", "state"],
providerId: "google.com",
Expand All @@ -13,8 +13,9 @@ jest.mock("firebase/auth", () => ({
})),
setPersistence: jest.fn(),
browserLocalPersistence: jest.fn(),
signInWithRedirect: jest.fn(),
// eslint-disable-next-line @typescript-eslint/no-unused-vars
signInWithPopup: jest.fn((_: Auth, __: AuthProvider) =>
getRedirectResult: jest.fn((_: Auth, __: AuthProvider) =>
Promise.resolve({
operationType: "signIn",
providerId: "google.com",
Expand Down