Email Verification

🔷 One-to-one relations

일대일 관계는 A가 B의 인스턴스를 하나만 포함하고 B가 A의 인스턴스를 하나만 포함하는 관계이다. 예를 들어 사용자 및 프로필 엔터티를 보면, 사용자는 하나의 프로필만 가질 수 있으며, 프로필은 하나의 사용자만 가질 수 있다.

@JoinColumn()을 설정한 쪽의 테이블에는 해당되는 엔터티 테이블에 대한 relation id와 foreign keys를 포함한다.

@JoinColumn은 관계의 한 쪽, 즉 데이터베이스 테이블에 foreign key가 있어야 하는 쪽에만 설정해야 합니다.

@InputType()
@ObjectType()
@Entity()
export class Verification extends CoreEntity {
  @Column()
  @Field((type) => String)
  code: string;

  @OneToOne((type) => User)
  @JoinColumn()
  user: User;
}

Case) Verification을 통해 그 안에 User에 접근해서 User의 email Verified를 false에서 true로 바꿀 것이기 때문에 Verification쪽에 @JoinColumn()을 추가하고 user를 통해 생성한 foreign key인 userId을 추가하도록 한 것이다.

🔷 테이블 연결하기

TypeORM에서도 관계를 가지고 있는 필드는 TypeORM에 따로 지정하지 않으면 자동으로 해당 필드를 보여주지 않는다.

🔹 loadRelationIds: true

true로 설정시 relation id 값만을 가져온다. (userId: 10)
엔터티의 모든 관계 ID를 로드하고 관계 개체가 아닌 관계 값에 매핑힌다.

🔹 relations

relations를 통해 해당 필드의 전체 데이터를 가져올 수도 있다.

async verifyEmail(code: string): Promise<boolean> {
    const verification = await this.verification.findOne({
      where: { code },
      relations: ['user'],
    });
    if (verification) {
      verification.user.verified = true;
      this.users.save(verification.user);
    }
    return false;
  }

🔷 Password Hash Error Fix

verified 업데이트를 위해 this.user.Save(verification.user) 할 때 BeforeUpdate가 항상 실행되어 password가 여러번 해쉬된다.

- 해결방법

1. {select: false}

• Entity 파일에서 해당 Column(password)에 {select: false}를 삽입해 find 실행자(find메서드들)를 통해 해당 엔티티를 가져올 때 해당 column을 선택되어지지 않도록 합니다.

• find메서드를 통해 받은 객체에 해당 column이 있을 경우에만 save가 실행되도록 if문을 사용한다.

  ※ Column을 {select: false}로 지정했을 경우 이전에 짜놓은 코드들 중 find메서드를 사용하는 부분에서 해당 column을 리턴받지 못해 에러가 날 수 있다. 이런 경우 find메서드에 select:['column']을 넣어 해당 Column이 리턴되도록 설정해주어야 한다.

2. this.user.update(verification.user)

• update()를 실행하게 되면 @BeforeUpdate()데코레이터가 실행되지 않는 것을 이용해서 아래와 같이 간단하게 update()메서드를 이용해서 verified를 업데이트 할 수 있다.

await this.verification.update(
	verification.user.id,
    { verified: true });

※ Mailgun

개발자를 위한 트랜젝션 이메일 API 서비스
https://www.mailgun.com

※ NestJS Mailer

Nodemailer 라이브러리를 사용하는 Nest.js 프레임워크(node.js)용 메일러 모듈
pug와 연동할 수 있으며 직접 html을 작성해 복잡하고 화려한 이메일 전송이 가능하다.
mailgun 또한 mailgun templete을 이용해 복잡한 이메일 전송이 가능하다.
https://nest-modules.github.io/mailer
https://github.com/nest-modules/mailer

🔷 Send Mail

🔹 GOT

npm i got
Node.js를 위한 인간 친화적이고 강력한 HTTP request 라이브러리
(프론트엔드에서의 Fetch와 같은 역할을 한다.)

🔹 Form-Data

npm i form-data
읽을 수 있는 "multipart/form-data" 스트림을 생성하는 라이브러리
다른 웹 애플리케이션에 form을 submit하고, 파일을 업로드하는 데 사용할 수 있다.
여기서는 mailgun의 api로 post를 보낼 때 form이 사용되었다.

Form의 형식은 Mailgun Api정보에 나와있는 형식을 따른다.

private async sendMail(subject: string, context: string) {
    const form = new FormData();
    form.append('from', `Excited User <mailgun@${this.options.domain}>`);
    form.append('to', `tem123@nate.com`);
    form.append('subject', subject);
    form.append('text', context);
  
    const response = await got(
      `https://api.mailgun.net/v3/${this.options.domain}/messages`,
      {
        method: 'POST',
        headers: {
          Authorization: `Basic ${Buffer.from(
            `api:${this.options.apiKeys}`,
          ).toString('base64')}`, // Buffer: Binary의 데이터를 담을 수 있는 객체
        },
        body: form,
      },
    );
    console.log(response.body);
  }

🔹 Mailgun Templete

- Handlebars

핸들바는 간단한 템플릿 언어이다. 템플릿과 input객체를 사용하여 HTML 또는 기타 텍스트 형식을 생성한다.

• 핸들바에서 자바스크립트 변수를 가져오기: {{ code }}
  ex) < p >{{firstname}} {{lastname}}< / p >
  https://handlebarsjs.com/guide/

- Template (Mailgun template을 통해 생성한 템플릿 이름)

템플릿 API를 통해 저장된 템플릿 이름
ex) formData.append('template', 'nuber-eats');

- v:my-var (사용할 변수 이름)

v: prefix를 통해 커스텀 JSON 데이터를 메세지에 이름을 붙여 보낼 수 있다.
ex) formData.append('v:code', 'abcd1234')

    form.append('template', 'verify-email');
    form.append('v:username', 'yeop');
    form.append('v:code', '15646');