mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-07 03:52:10 +00:00
# Which Problems Are Solved - The previous monorepo in monorepo structure for the login app and its related packages was fragmented, complicated and buggy. - The process for building and testing the login container was inconsistent between local development and CI. - Lack of clear documentation as well as easy and reliable ways for non-frontend developers to reproduce and fix failing PR checks locally. # How the Problems Are Solved - Consolidated the login app and its related npm packages by moving the main package to `apps/login/apps/login` and merging `apps/login/packages/integration` and `apps/login/packages/acceptance` into the main `apps/login` package. - Migrated from Docker Compose-based test setups to dev container-based setups, adding support for multiple dev container configurations: - `.devcontainer/base` - `.devcontainer/turbo-lint-unit` - `.devcontainer/turbo-lint-unit-debug` - `.devcontainer/login-integration` - `.devcontainer/login-integration-debug` - Added npm scripts to run the new dev container setups, enabling exact reproduction of GitHub PR checks locally, and updated the pipeline to use these containers. - Cleaned up Dockerfiles and docker-bake.hcl files to only build the production image for the login app. - Cleaned up compose files to focus on dev environments in dev containers. - Updated `CONTRIBUTING.md` with guidance on running and debugging PR checks locally using the new dev container approach. - Introduced separate Dockerfiles for the login app to distinguish between using published client packages and building clients from local protos. - Ensured the login container is always built in the pipeline for use in integration and acceptance tests. - Updated Makefile and GitHub Actions workflows to use `--frozen-lockfile` for installing pnpm packages, ensuring reproducible installs. - Disabled GitHub release creation by the changeset action. - Refactored the `/build` directory structure for clarity and maintainability. - Added a `clean` command to `docks/package.json`. - Experimentally added `knip` to the `zitadel-client` package for improved linting of dependencies and exports. # Additional Changes - Fixed Makefile commands for consistency and reliability. - Improved the structure and clarity of the `/build` directory to support seamless integration of the login build. - Enhanced documentation and developer experience for running and debugging CI checks locally. # Additional Context - See updated `CONTRIBUTING.md` for new local development and debugging instructions. - These changes are a prerequisite for further improvements to the CI pipeline and local development workflow. - Closes #10276
178 lines
3.8 KiB
TypeScript
178 lines
3.8 KiB
TypeScript
import { Page } from "@playwright/test";
|
|
import { registerWithPasskey } from "./register";
|
|
import { activateOTP, addTOTP, addUser, eventualNewUser, getUserByUsername, removeUser } from "./zitadel";
|
|
|
|
export interface userProps {
|
|
email: string;
|
|
isEmailVerified?: boolean;
|
|
firstName: string;
|
|
lastName: string;
|
|
organization: string;
|
|
password: string;
|
|
passwordChangeRequired?: boolean;
|
|
phone: string;
|
|
isPhoneVerified?: boolean;
|
|
}
|
|
|
|
class User {
|
|
private readonly props: userProps;
|
|
private user: string;
|
|
|
|
constructor(userProps: userProps) {
|
|
this.props = userProps;
|
|
}
|
|
|
|
async ensure(page: Page) {
|
|
const response = await addUser(this.props);
|
|
|
|
this.setUserId(response.userId);
|
|
}
|
|
|
|
async cleanup() {
|
|
await removeUser(this.getUserId());
|
|
}
|
|
|
|
public setUserId(userId: string) {
|
|
this.user = userId;
|
|
}
|
|
|
|
public getUserId() {
|
|
return this.user;
|
|
}
|
|
|
|
public getUsername() {
|
|
return this.props.email;
|
|
}
|
|
|
|
public getPassword() {
|
|
return this.props.password;
|
|
}
|
|
|
|
public getFirstname() {
|
|
return this.props.firstName;
|
|
}
|
|
|
|
public getLastname() {
|
|
return this.props.lastName;
|
|
}
|
|
|
|
public getPhone() {
|
|
return this.props.phone;
|
|
}
|
|
|
|
public getFullName() {
|
|
return `${this.props.firstName} ${this.props.lastName}`;
|
|
}
|
|
}
|
|
|
|
export class PasswordUser extends User {
|
|
async ensure(page: Page) {
|
|
await super.ensure(page);
|
|
await eventualNewUser(this.getUserId());
|
|
}
|
|
}
|
|
|
|
export enum OtpType {
|
|
sms = "sms",
|
|
email = "email",
|
|
}
|
|
|
|
export interface otpUserProps {
|
|
email: string;
|
|
isEmailVerified?: boolean;
|
|
firstName: string;
|
|
lastName: string;
|
|
organization: string;
|
|
password: string;
|
|
passwordChangeRequired?: boolean;
|
|
phone: string;
|
|
isPhoneVerified?: boolean;
|
|
type: OtpType;
|
|
}
|
|
|
|
export class PasswordUserWithOTP extends User {
|
|
private type: OtpType;
|
|
|
|
constructor(props: otpUserProps) {
|
|
super({
|
|
email: props.email,
|
|
firstName: props.firstName,
|
|
lastName: props.lastName,
|
|
organization: props.organization,
|
|
password: props.password,
|
|
phone: props.phone,
|
|
isEmailVerified: props.isEmailVerified,
|
|
isPhoneVerified: props.isPhoneVerified,
|
|
passwordChangeRequired: props.passwordChangeRequired,
|
|
});
|
|
this.type = props.type;
|
|
}
|
|
|
|
async ensure(page: Page) {
|
|
await super.ensure(page);
|
|
await activateOTP(this.getUserId(), this.type);
|
|
await eventualNewUser(this.getUserId());
|
|
}
|
|
}
|
|
|
|
export class PasswordUserWithTOTP extends User {
|
|
private secret: string;
|
|
|
|
async ensure(page: Page) {
|
|
await super.ensure(page);
|
|
this.secret = await addTOTP(this.getUserId());
|
|
await eventualNewUser(this.getUserId());
|
|
}
|
|
|
|
public getSecret(): string {
|
|
return this.secret;
|
|
}
|
|
}
|
|
|
|
export interface passkeyUserProps {
|
|
email: string;
|
|
firstName: string;
|
|
lastName: string;
|
|
organization: string;
|
|
phone: string;
|
|
isEmailVerified?: boolean;
|
|
isPhoneVerified?: boolean;
|
|
}
|
|
|
|
export class PasskeyUser extends User {
|
|
private authenticatorId: string;
|
|
|
|
constructor(props: passkeyUserProps) {
|
|
super({
|
|
email: props.email,
|
|
firstName: props.firstName,
|
|
lastName: props.lastName,
|
|
organization: props.organization,
|
|
password: "",
|
|
phone: props.phone,
|
|
isEmailVerified: props.isEmailVerified,
|
|
isPhoneVerified: props.isPhoneVerified,
|
|
});
|
|
}
|
|
|
|
public async ensure(page: Page) {
|
|
const authId = await registerWithPasskey(page, this.getFirstname(), this.getLastname(), this.getUsername());
|
|
this.authenticatorId = authId;
|
|
|
|
// wait for projection of user
|
|
await page.waitForTimeout(10000);
|
|
}
|
|
|
|
async cleanup() {
|
|
const resp: any = await getUserByUsername(this.getUsername());
|
|
if (!resp || !resp.result || !resp.result[0]) {
|
|
return;
|
|
}
|
|
await removeUser(resp.result[0].userId);
|
|
}
|
|
|
|
public getAuthenticatorId(): string {
|
|
return this.authenticatorId;
|
|
}
|
|
}
|