Sendgrid-nodejs: 콜백 함수 서명이 노드 규칙을 따르지 않음

내 현재 솔루션은 상태 코드의 성공 여부를 확인하는 것입니다. 예 :

function sendMail(mail) {
  return new Promise((resolve, reject) => {

    //Build request
    let request = sg.emptyRequest();
    request.method = 'POST';
    request.path = '/v3/mail/send';
    request.body = mail.toJSON();

    //Send request
    sg.API(request, response => {
      if (response && response.statusCode &&
        response.statusCode >= 200 && response.statusCode <= 299) {
        resolve(response);
      }
      reject(new SendMailError(
        'Sendgrid response error ' + response.statusCode
      ));
    });
  });
}

보시다시피 이것은 매우 장황하며 단순히 이메일을 보내고 작동하는지 확인하기 위해 많은 상용구가 필요합니다.

제안 된 API는 다음과 같습니다.

function sendMail(mail) {
  return new Promise((resolve, reject) => {

    //Build request
    let request = sg.emptyRequest();
    request.method = 'POST';
    request.path = '/v3/mail/send';
    request.body = mail.toJSON();

    //Send request
    sg.API(request, (error, response) => {
      if (error {
        reject(new SendMailError(error);
      }
      resolve(response);
    });
  });
}

또는 더 나은 방법으로 약속이 반환되었습니다.

function sendMail(mail) {

  //Build request
  let request = sg.emptyRequest();
  request.method = 'POST';
  request.path = '/v3/mail/send';
  request.body = mail.toJSON();

  //Send request
  return sg.API(request);
}

이상적으로는 백그라운드에서 적절한 요청을 생성하는 전용 메일 전송 도우미가 반환되어 sendMail 도우미와 상용구가 모두 필요하지 않습니다.

sg.sendMail(mail);

이것이 당신이 추구하고 싶은 것이 있다면 나는 그것을 위해 PR을 만드는 것을 조사 할 것입니다.

감사합니다 @adambuczynski ,

일반적으로 오류 처리를 업데이트 할 계획이지만 아직 범위를 지정하지 않았습니다. 그때가되면이 피드백을 고려할 것입니다.

풀 요청을 제공하려면 서명 된 CLA가 필요합니다. https://github.com/sendgrid/sendgrid-nodejs/blob/master/CONTRIBUTING.md#cla

우리는 당신이 제안하는 향상의 종류에 대한 헬퍼 구조를 설정했습니다 : https://github.com/sendgrid/sendgrid-nodejs/tree/master/lib/helpers/mail. 이를 수정하는 데 도움을 주거나 helpers 디렉토리에서 직접 만들 수 있습니다.

귀하의 지원에 감사드립니다!

예, 메일 도우미를 보았습니다. 해당 개체에 메일 보내기 도우미를 만들겠습니까?

그것은 나에게 좋은 소리 :)

@adambuczynski 가 제안한 제안이 있습니다. 방금 v3 API로 업데이트했고 더 이상 간단한 도우미 함수를 사용할 수없고 대신 일련의 상용구 코드를 작성해야한다는 점에 매우 실망했습니다. 추악한 오류 처리 코드를 작성하지 않고는 더 이상 Bluebird promise로 래핑 할 수도 없습니다.

@beldenge 유효성 검사에 감사드립니다!

진행을 위해이 문제를 따르십시오. @adambuczynski 가 pull 요청을 생성하면 여기에 게시합니다. 그렇지 않으면 다음 라이브러리 업데이트 중 하나를 위해 로드맵에 추가 할 것입니다.

@thinkingserious 방금 서명 된 CA를 우편으로 보냈습니다. 다음 주에이 문제를 조사 할 시간이 있기를 바랍니다.

@adambuczynski 우리는 그것을 받았으며 피드백에 감사드립니다!

안녕하세요 여러분, 이것에 대해 잊은 것은 아니지만 저는 다른 여러 프로젝트로 조금 바빴습니다. 여전히 어떤 단계에서 이것을 조사하기를 바랍니다. :)

@thinkingserious 소스 코드를 살펴 봤지만 조금 지저분 해 보입니다. 편집하면 코드 린터가 자동으로 많은 변경을 수행합니다 (예 : 누락 된 세미콜론 추가, 문자열에 일관된 따옴표 스타일 사용, 언어 요소 사이에 일관된 간격 사용 등).

그런 일이 일어나도 괜찮습니까? 나는 그것을 보는 것이 내 두뇌를 아프게하기 때문에 코드로 작업 할 수 없을 것이라고 생각합니다. :)

추신 : 린터를 사용하지 않는 이유 :)

@adambuczynski ,

표준 스타일 가이드와 함께 http://eslint.org 를 사용합니다.

어느 것을 사용합니까? 동기화하고 동일한 린터를 사용할 수 있다면 멋질 것입니다.

ESLiint도 사용하지만 코드에 여전히 많은 불일치가 있기 때문에 많은 규칙을 적용하는 것 같지 않습니다.

이것이 내가 사용하는 구성입니다 : https://gist.github.com/adambuczynski/1fa24bcfc5d17b8d26e4c39ffca7560e#file -eslintrc-node-yaml

나는 그것이 일관성과 모범 사례 사이에 좋은 균형을 제공한다고 생각하지만 너무 짜증나 지 않습니다.

프로젝트에 .eslintrc.yaml 구성 파일이 없습니다. 선호하는 규칙을 추가 / 만들면 나도 사용할 수 있습니까?

@adambuczynski ,

나는 당신의 것을 사용하게되어 기쁩니다. 단단해 보입니다. :)

커밋의 일부로 추가하세요.

사용할 때 @thinkingserious 그것은 ES6에 대한 설정이 있지만 기능 예를 들어, 경고입니다 var 대신 let 하고 ES6 파서를 사용하여.

괜찮습니까, 아니면 이전 버전과의 호환성을 위해서만 ES5를 사용 하시겠습니까?

Node.js 버전을 지원해야합니다 : "0.10", "0.12", "iojs", "4"

해당 버전에 대한 지원을 중단하지 않으면 더 현대적인 접근 방식으로 괜찮습니다.

좋아, 나는 var를 유지하고 발생한 코드 스타일 문제를 수정했습니다. 이번 호와는 별도로 PR을 작성했습니다.

@thinkingserious Promise API도 구현하고 있지만 기본 약속은 Node 0.11.13에서만 도입되었습니다.

몇 가지 솔루션, 선호하는 조합 (또는 조합)을 알려주세요.

• bluebird promise를 종속성으로 사용
• 약속이 지원되는지 확인하고 지원되지 않는 경우 오류를 던지지 만 사람들이 사용하려고하면
• 사용자가 원하는 값으로 sendgrid.Promise 를 설정하여 사용하려는 promise 구현을 설정할 수 있습니다.

아마도 2와 3의 조합이 가장 간단하고 가장 유연 할 것입니다.

동의합니다.

저는이 옵션이 마음에 듭니다. "Promise가 지원되는지 확인하고 지원되지 않는 경우 오류가 발생하지만 사람들이 사용하려고하면 오류가 발생합니다."하지만 사용자가 원하는 구현을 지정할 수도 있습니다.

@thinkingserious 완벽합니다. 검토 할 준비가 된 것이 있습니다. 동일한 PR로 푸시할까요, 아니면 별도의 PR을 만들까요?

@adambuczynski 당신은 동일한 PR을 유지할 수 있습니다, 감사합니다!

# 261 참조

@beldenge PR https://github.com/sendgrid/sendgrid-nodejs/pull/261에 +1을 추가하여 Sendgrid 팀이이를 이동하고 병합을 고려할 수 있도록 하시겠습니까? 감사!

@adambuczynski 이제 +1을 추가하겠습니다 :)

https://github.com/sendgrid/sendgrid-nodejs/releases/tag/v4.0.0으로 수정되었습니다.