기본 콘텐츠로 건너뛰기

socketcluster tutorial - 6. 미들웨어 및 인증 (Middleware and authorization)

미들웨어 및 인증


SocketCluster를 사용하면 클라이언트는 JavaScript를 사용하여 특정 채널로 데이터를 청취하고 발행하여 메시지를 서로 공유할 수 있습니다. 기본적으로 누구나 자신이 좋아하는 채널에 데이터에 수신하고 게시할 수 있습니다. 일부 시스템에서는 이것이 문제가 되지 않지만 대부분의 시스템은 사용자가 서로 상호 작용할 수 있는 방법을 규제하기 위해 어느 정도의 접근 제어가 필요합니다. 대부분의 시스템은 적절한 접근 권한을 시행하기 위해 연결을 인증하고 권한을 부여하는 방법이 필요합니다. 미들웨어 기능은 이러한 모든 작업을 수행할 수 있는 깔끔한 중앙 집중식 방식을 제공합니다.

SocketCluster에서 모든 실시간 이벤트는 서버에서 처리하기 전에 미들웨어 기능을 통과해야 합니다. SocketCluster는 다양한 종류의 상호 작용을 처리할 수 있는 다양한 종류의 미들웨어 라인을 제공합니다. 가장 유용한 미들웨어 라인은 워커 프로세스에 있지만 로드 밸런서(HTTP 용)에 의해 노출되는 미들웨어 라인이 있습니다. 이 튜토리얼에선 워커(실시간) 미들웨어에만 초점을 맞춥니다.

워커는 실시간 scServer 객체를 통해 미들웨어를 노출합니다. 이 객체는 worker.getSCServer()를 사용하여 액세스 할 수 있습니다.

미들웨어 기능을 서버에 추가하려면 다음을 사용해야 합니다.
scServer.addMiddleware (middlewareType, middlewareFunction);
scServer에서 사용할 수있는 미들웨어 유형은 다음과 같습니다.
scServer.MIDDLEWARE_HANDSHAKE
scServer.MIDDLEWARE_SUBSCRIBE
scServer.MIDDLEWARE_PUBLISH_IN
scServer.MIDDLEWARE_PUBLISH_OUT
scServer.MIDDLEWARE_EMIT
middlewareFunction에 전달한 req인자는 사용한 미들웨어의 종류에 따라 다릅니다. 다음 예제의 err객체는 JavaScript의 Error객체를 상속한 사용자 정의 클래스를 기반으로 합니다. 서버에서 스택 트레이스를 사용하지 않는 경우 폼에서 {name: 'MyCustomError', message: 'This is a custom error'} (또는 추가 사용자 정의 속성을 사용하여)와 같은 일반 객체를 next(err)에게 전달할 수 있습니다. 다음은 각 종류의 미들웨어를 사용하는 방법을 보여주는 몇 가지 샘플 코드 스니펫입니다.

핸드쉐이크

// WebSocket 핸드쉐이크용
wsServer.addMiddleware(wsServer.MIDDLEWARE_HANDSHAKE,
  function (req, next) {
    // ...
    if (...) {
      next() // Allow
    } else {
      var err = new MyCustomHandshakeFailedError('Handshake failed');
      next(err); // Block
      // next(true); // 서버 측에서 경고하지 않고 조용히 next() 블록에 true를 전달합니다.
    }
  }
);

구독하기

기본 인증 토큰 만료 오류로 실패합니다.
// Error 객체에 사용자 정의 속성을 가질 수 있습니다.
// 서버 측에서 경고를하지 않고 조용히 next () 블록에 true를 전달합니다.
wsServer.addMiddleware(wsServer.MIDDLEWARE_SUBSCRIBE,
  function (req, next) {
    // ...
    if (req.authTokenExpiredError) {
      next(req.authTokenExpiredError); // 기본 인증 토큰 기간 만료 오류로 실패
    } else if (...) {
      next() // Allow
    } else {
      var socketId = req.socket.id;
      var err = new MyCustomSubscribeFailedError(socketId + ' cannot subscribe to channel ' + req.channel);
      // You can have custom properties on your Error object.
      err.code = 1234;
      next(err); // Block
      // next(true); // 서버 측에서 경고하지 않고 조용히 next() 블록에 true를 전달합니다.
    }
  }
);

발행

SC는 게시를 위해 두 가지 미들웨어 라인을 지원합니다. MIDDLEWARE_PUBLISH_IN은 게시한 메시지를 처리한 후 (개별 소켓으로 보내기 직전) MIDDLEWARE_PUBLISH_OUT가 캡처한 메시지를 처리하는 동안 브로커에 도달하기 전에 서버에 도달할 때 인바운드 메시지를 캡처합니다. MIDDLEWARE_PUBLISH_OUT을 사용하면 메시지가 특정 소켓에 도달하는 것을 차단할 수 있습니다. 이 경우에는 메시지를 게시한 소켓이 자신의 메시지를 받지 않도록 메시지와 미들웨어를 설계할 수 있습니다.

Publish In

wsServer.addMiddleware(wsServer.MIDDLEWARE_PUBLISH_IN,
  function (req, next) {
    // ...
    if (...) {
      next() // Allow
    } else {
      var err = MyCustomPublishInFailedError(req.socket.id + ' cannot publish channel ' + req.channel);
      next(err); // Block
      // next(true); // 서버 측에서 경고하지 않고 조용히 next() 블록에 true를 전달합니다.
    }
  }
);

Publish out

wsServer.addMiddleware(wsServer.MIDDLEWARE_PUBLISH_OUT,
  function (req, next) {
    // ...
    if (...) {
      next() // Allow
    } else {
      var err = MyCustomPublishOutFailedError('Blocked publishing message out to ' + req.socket.id);
      next(err); // Block with notice
      // next(true); // 서버 측에서 경고하지 않고 조용히 next() 블록에 true를 전달합니다.
    }
  }
);

전송하기

wsServer.addMiddleware(wsServer.MIDDLEWARE_EMIT,
  function (req, next) {
    // ...
    if (...) {
      next() // Allow
    } else {
      var err = MyCustomEmitFailedError(req.socket.id + ' is not allowed to emit event ' + req.event);
      next(err); // Block
      // next(true); // 서버 측에서 경고하지 않고 조용히 next() 블록에 true를 전달합니다.
    }
  }
);
next() 함수는 언제든지 (비동기가 좋습니다) 호출할 수 있지만, 결과적으로 호출하는 것을 확인해야 합니다. 그렇지 않으면 클라이언트의 subscribe/ publish/emit 액션이 단순 타임아웃이나 클라이언트 쪽에서 원인을 알 수 없는 타임아웃 오류를 발생할 것입니다. 클라이언트가 뭔가를 하지 못하도록 차단하려면 명시적 오류를 주는 것이 더욱 다루기 쉽습니다.

이 블로그의 인기 게시물

vulcanJS - 10. Posts Update/Delete

마지막으로 수정과 삭제를 구현해보면 목록 조회(List), 상세 조회, 쓰기, 수정, 삭제까지 모든 필요한 요소를 아우를 수 있을 것이다.
감이 좋은 분들은 눈치 챘을지도 모르겠지만 사실 수정이란 건 UI면에서 볼때 이미 양식이 채워져있는 신규 쓰기와 별반 다르지 않다.

먼저 해야할 것은 역시나 Component를 만드는 일이다.
$ vulcan g component
? Package name spectrum-simplebb
? Component name PostsEditComponent
? Component type Class Component
? Register component Yes
   create packages/spectrum-simplebb/lib/components/PostsEditComponent.jsx
 conflict packages/spectrum-simplebb/lib/components/index.js
? Overwrite packages/spectrum-simplebb/lib/components/index.js? overwrite
    force packages/spectrum-simplebb/lib/components/index.js PostsEditComponent를 만들었다.
route도 만들자. /posts/edit/:id 이렇게 경로를 만들면 좋겠다. 그러고보니 이전 글에서 만든 상세보기도 /posts/view/:id 형식으로 만들껄 그랬다.
$ vulcan g route
? Package name spectrum-simplebb
? Route name postsEdit
? Route path /posts/edit/:_id
? Component name PostsEditComponent
? Layout name
 conflict packages/spectrum-simplebb/lib/modules/routes.js
? Overwrite packages/spectrum-simplebb/lib/modules/routes.js? overwrite
   …

VulcanJS 특징 번역

VulcanJS 특징http://docs.vulcanjs.org/features.html 의 내용입니다. GraphQL 스키마 생성 Vulcan은 SimpleSchema JSON 스키마를 기반으로 컬렉션의 GraphQL 스키마를 자동으로 생성합니다.
이렇게하면 두 가지 형식으로 스키마를 두 번 지정할 필요가 없습니다. 이 기능은 완전히 선택적이며 필요에 따라 수동으로 스키마를 지정할 수도 있습니다.

자동 생성 폼 Vulcan은 스키마를 사용하여 클라이언트 측 폼을 생성하고 적절한 Apollo Mutation을 통해 제출을 처리합니다.
예를 들어 하나의 동영상을 편집하기위한 양식을 표시하는 방법은 다음과 같습니다.
<VulcanForm
  collection={Movies}
  documentId={props.documentId}
  queryName="moviesListQuery"
  showRemove={true}
/> queryName 옵션은 작업이 완료되면 자동으로 업데이트되는 쿼리를 VulcanForm에 통지하는 한편, showRemove 옵션은 "Delete Movie' 버튼을 폼에 추가합니다.
VulcanForm 클라이언트 저장소에 아직 로드되지 않은 경우 수정할 문서를 읽어오기도 합니다.

쉬운 데이터 적재 Vulcan에는 Apollo 데이터를 쉽게 로드할 수 있도록 데이터 로딩 헬퍼 세트로 withList (복수 문서용)와 withDocument (단일 문서용)를 제공합니다.
예를 들어, withList를 사용하여 MoviesList 구성 요소에 모든 동영상을 포함하는 결과를 prop에 전달하는 방법은 다음과 같습니다.
const listOptions = {
  collection: Movies,
  queryName: 'moviesListQuery',
  fragment: fragment,
};
export default withList(listOptions)(MoviesList); …

vulcanJS - 1. vulcan-cli 설치하고 프로젝트 만들기

vulcanJS를 학습하면서 알아낸 점을 기록하는 의미의 튜토리얼을 써본다.

Telescope도 그랬지만 forum 형태의 예제에서 embedly를 사용하는 URL 요소가 글에 들어가는 점이나 일반인들에게는 익숙하지 않은 Markdown 문법 등을 걷어내고 최소형태에서부터 접근해야할 필요성을 느껴서 단순 post만 목록 열람하고 읽고 쓰는 구현을 해보기로 했다.

먼저, vulcanJS를 github를 통해 clone 하고 meteor create --package를 통해 만들수도 있지만 Vulcan-Cli(https://github.com/VulcanJS/vulcanjs-cli)가 있어서 이걸 일단 사용해보기로 한다.

대충 내용을 읽어보니 Rails 생각이 나기도 하고 재밌어 보인다.
npm install -g vulcanjs-cli 혹은 meteor 에서만 한다면
meteor npm install -g vulcanjs-cli 이런 식으로 설치하고 쓰면 된다.
npm 에 global로 설치한 첫번째 경우 기준으로 진행해보겠다.
설치하고 난 뒤 vulcan 을 실행해보면
$ vulcan
vulcan usage:
Synopsis
  vulcan <action> <object> <...>
    <action>   Operation to perform
    <object>   Asset type (contextual to action)
    <...>      Parameters. If not provided, interactively entered
Project initialisation
  vulcan create <appName>
  vulcan init <appName>
Assets creation
  vulcan (generate|g) package <packageName>
  vulcan (generate|g) model <packageName>…