[1일 1식 라라벨] 모델 변경 이력을 자동으로 저장해주는 패키지 Revisionable

스크린샷 2019-07-02 오후 5.25.12.png

위키백과의 “라라벨” 문서가 수정된 내역

위키의 핵심 기능은 과거의 모든 변경 내역을 조회할 수 있고, 원하면 과거 버전으로 쉽고 되돌아갈 수 있는 것이라 생각한다.
간혹 위키 같이 과거의 변경 내역을 기록으로 남기고 조회하는 기능이 필요할 때가 있다. 내가 운영하는 카페에서는 사물함 관리에 이 기능이 필요했다. 사물함 대여자 정보를 업데이트 할 때 실수를 할 수 있으므로, 변경되기 전의 데이터가 어딘가에 남아있어야 했다. 당시에는 단순하게 똑같은 테이블을 하나 더 만들어서(lockers 테이블과 똑같은 lockers_logs 테이블을 만드는 식으로) 업데이트 전에 백업하는 식으로 구현했다.

이런 기능이 내게만 필요했던 건 아니었는지 크리스 듀엘(Chris Duell)이 Revisionable이라는 패키지를 만들었다. 이 패키지를 사용하면 모델에 변화가 있을때마다 자동으로 ‘누가’, ‘무엇을’, ‘언제’, ‘어떻게’ 수정했는지가 저장된다. 수정내역을 남기고 싶은 모델에 RevisionableTrait 트레이트를 사용한다고 선언하기만 하면 된다. 사물함 관리 기능 만들 때 이 패키지가 알았더라면 ㅠ

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Venturecraft\Revisionable\RevisionableTrait;

class Post extends Model
{
    use RevisionableTrait;
}

실전에서 어떻게 쓰이는지 보는게 가장 와 닿을 것 같다. 내 카페용 애플리케이션에 관심있는 사람들은 없겠지만 겸사겸사 한 번 적용해보겠다.

설치

컴포저로 설치한다.

composer require venturecraft/revisionable

설치가 완료되면 config/app.php 파일의 providers 항목에 RevisionableServiceProvider를 등록한다.

'providers' => [
    Venturecraft\Revisionable\RevisionableServiceProvider::class,
]

설정 파일과 마이그레이션 파일을 퍼블리싱한다.

php artisan vendor:publish --provider="Venturecraft\Revisionable\RevisionableServiceProvider"

// 제대로 진행된다면 아래와 같은 결과 메시지가 터미널에 출력된다.
Copied File [/vendor/venturecraft/revisionable/src/config/revisionable.php] To [/config/revisionable.php]
Copied Directory [/vendor/venturecraft/revisionable/src/migrations] To [/database/migrations]
Publishing complete.

Revisionable 패키지는 모든 모델의 수정내역을 하나의 테이블로 관리한다. 마이그레이션을 실행한다.

php artisan migrate

데이터가 어떻게 저장되는지 확인하기 위해 마이그레이션 파일을 살펴보자.

public function up()
{
    Schema::create('revisions', function ($table) {
        $table->increments('id');
        $table->string('revisionable_type');
        $table->integer('revisionable_id');
        $table->integer('user_id')->nullable();
        $table->string('key');
        $table->text('old_value')->nullable();
        $table->text('new_value')->nullable();
        $table->timestamps();

        $table->index(array('revisionable_id', 'revisionable_type'));
    });
}

revisionable_type은 수정한 모델의 타입이고 revisionable_id는 수정한 모델의 ID 값이다. 이런 방식으로 하나의 테이블에서 모든 모델의 변경사항을 다루는 걸 일대다 다형성 관계라고 한다. 다형성 관계에 익숙하지 않은 사람들은 매뉴얼을 참고하자.

key는 모델의 어떤 값이 변경되었는지를 저장하는 값이다. 예를 들어 Post 모델의 title이 수정되었다면 key에 ‘title’이 값으로 저장된다.

카페용 애플리케이션에서 사물함은 Locker 모델로 관리했다. Locker 모델에 RevisionableTrait를 끼워넣는다.

<?php

namespace App;

use Carbon\Carbon;
use Illuminate\Database\Eloquent\Model;
use Venturecraft\Revisionable\RevisionableTrait;

class Locker extends Model
{
    use RevisionableTrait;

    ...이하 생략

Locker를 업데이트하는 LockerService::update()는 원래 아래와 같았다.

class LockerService
{
    public function update($request, $locker)
    {
        DB::transaction(function () use ($request, $locker) {
            $this->backup($locker);

            $inputs = $this->buildInputsForUpdate($request, $locker);

            $locker->update($inputs);
        });
    }

코드는 간단하다. 백업하고 업데이트할 데이터를 준비해서 업데이트한다.

이제 Revisionable이 수정내역을 관리해주기 때문에 백업하는 코드는 더이상 필요 없다. 그래서 $this->backup($locker); 줄을 지우고 LockerService::backup() 메소드를 통째로 제거했다.

테스트로 데이터를 하나 변경해봤다. 홍길동이 대여하고 있던 사물함을 장길산이 사용하게 된 시나리오다.

스크린샷 2019-07-02 오후 8.17.56.png

스크린샷 2019-07-02 오후 8.18.37.png

‘사용자’, ‘이용 시작 시점’, ‘이용 종료 시점’, ‘비밀번호’가 바뀌었다. revisions 테이블을 보면 아래와 같이 4개의 데이터가 추가되었다. 

스크린샷 2019-07-02 오후 8.19.14.png

변경 행위는 한 번인데, 변경된 필드마다 데이터가 하나씩 생성되는 점은 조금 아쉽다. 현재로서는 같은 행동이 원인이 되어 바뀌었는지 여부를 판단할 수 있는 유일한 방법은 revisions 테이블의 created_at 이 같은지 확인하는 방법 뿐이다. 수정내역을 사용자의 행동 단위로 묶을 수 있도록 식별값을 하나 더 추가했으면 어땟을까 싶다.

기본적인 기능 외에 아래와 같이 다양한 옵션을 제공한다. 필요할 때 패키지의 매뉴얼을 보고 활용하자.

  • 변경 뿐만 아니라 생성 기록도 저장하기
  • 저장할 필드, 혹은 제외할 필드 지정하기
  • 수정내역 저장 비활성화
  • 수정내역 최대 저장 갯수 지정
  • 출력 형식 변경하기

이 글은 7월 2일자 1일 1식 라라벨에 발행된 글입니다. 월 1만원으로 최신 라라벨 소식을 받아보세요.

[1일 1식 라라벨] 2019년 8월호 구독자 모집

1일 1식 라라벨 8월호 구독자를 모집합니다.

7월호 3주차가 끝났는데 다행히 펑크를 낸 날은 없었네요 🙂 용기내서 조금 더 해봅니다.

7월호에 발행했던 글들은 아래와 같습니다.

  • 5.8.25 버전부터 Response::assertViewHas()로 공유 데이터도 확인 가능
  • 모델 변경 이력을 자동을 저장해주는 패키지 Revisionable
  • 5.8.27 버전에 whereHasMorph() 추가됨
  • 특정 버전의 라라벨 설치하기
  • 라라벨 패키지를 선택할 때 물어야 할 8가지 질문
  • 테일러 오트웰은 왜 API 라우트를 routes/web.php에 작성했을까?
  • 테일러 오트웰이 사랑한 헬퍼, tap()
  • 5.8.28 새기능 1 – TestResponse에 tap 기능 추가
  • 5.8.28 새기능 2 – 컬렉션에 병합, 교체 기능 추가
  • 5.8.28 새기능 3 – Session에 only 메소드 추가
  • ERD를 그려주는 Laravel ER Diagram Generator
  • 의존성 충돌 해결하기
  • 라라벨 5.8.29 릴리즈
  • 라라벨 리퀘스트 라이프사이클
  • 라라벨에서 TailwindCSS 사용하기

많은 신청 바랍니다~ 신청 링크 https://forms.gle/ysHkKGdhhKka2ECK8

[1일 1식 라라벨 샘플] route:list를 JSON으로 출력하는 기능이 추가되었다

라라벨 5.8.25가 나왔다. (같은 날 긴급 패치가 나와서 현재 최신 버전은 5.8.26이다.) 5.8.25에서는 route:list를 JSON으로 출력하는 기능이 추가되었다.

route:list

route:list는 터미널에서 전체 라우트를 테이블 형태로 출력하는 아티즌 명령어이다. 아래와 같이 실행할 수 있다.

php artisan route:list

아래는 모던 PHP 유저 그룹 홈페이지 의 라우트를 출력한 예시이다.

route:list를 JSON으로 출력하기

라우트 목록을 JSON으로 출력하고 싶으면 --json 옵션을 붙이면 된다.

php artisan route:list --json

그러면 아래와 같이 JSON 형식으로 출력된다.

왜 만들었을까?

이 기능을 추가한 제이슨 맥크레리“프로그램으로 쉽게 파싱될 수 있어서 다른 도구나 서비스에 의해 쓰이기 좋다”고 이유를 밝혔다. 그런데 다른 도구나 서비스가 아티즌 커맨드를 쓰는 일이 있나 싶다.

기존에도 원한다면 라우트 파사드를 통해 이용해서 전체 라우트를 조회할 수 있었다.

$routes = \Illuminate\Support\Facades\Route::getRoutes()->get();

// get() 메소드에 조회하고자 하는 HTTP 메소드를 지정할 수도 있다.
$getRoutes = \Illuminate\Support\Facades\Route::getRoutes()->get('GET');

굳이 추가로 만든 이유를 찾자면 몇가지 항목으로 미리 정리해서 뽑아주기 때문에 살짝 더 편리할 수 있다 정도 아닐까? 아티즌 커맨드로 라우트 목록을 받으려면 아래와 같이 하면 된다.

Artisan::call('route:list --json');
$routes = Artisan::output();

어디에 쓰지?

전 직장에 입사했을 때, 이미 라라벨로 만든 애플리케이션이 잘 돌아가고 있었다. 다만, 테스트가 하나도 없었다. 사장님이 우선은 접속 안되는 페이지가 없는지 확인하는 테스트만 있어도 좀 안심이 될 것 같다고 이야기했고 나도 동의했다. 그때는 라우트 목록을 JSON으로 뽑는 기능도 없었고, 라우트 파사드로 조회할 수 있는지도 몰라서 아래와 같이 단순 무식하게 짰다.

$this->get("/")->assertSuccessful();

$this->get("/user/login")->assertSuccessful();
$this->get("/user/add")->assertSuccessful();
$this->get("/user/forget")->assertSuccessful();
... //이렇게 수십 줄이 이어진다.

// 로그인이 필요한 페이지는 이런 식으로
$this->actingAs($user)->get('/user/changePassword')->assertSuccessful();

지금 다시 짠다면 요번에 추가된 기능이나 라우트 파사드를 이용해서 좀 더 프로그램 답게(programmatically) 작성할 수 있지 않을까 싶다. GET 메소드만 쌱 조회해서 미들웨어에 auth 있나 없나 보고 그에 따라 샤샥.

이 글은 하루에 한 편씩 라라벨 관련 글을 메일로 보내드리는 [1일 1식 라라벨] 의 샘플 원고입니다. 조금 더 길어질 수도 짧아질 수도 있습니다만, 어느 정도 공들여 쓴 블로그 포스트 정도라고 생각해주시면 될 것 같습니다. 7월호 유료구독자를 모집하고 있습니다.

[1일 1식 라라벨] 구독자 모집

안녕하세요. 이현석입니다. 저는 PHP를 주로 사용하는 개발자이고 개발 관련 책과 글도 씁니다. 출간한 책으로는 “바쁜 팀장님 대신 알려주는 신입 PHP 개발자 안내서“가 있습니다. 대외활동으로는 모던 PHP 유저 그룹에서 꾸준히 활동 중이고, 코딩 야학에도 조력자로 참여하고 있습니다. 라라벨 관련해서는 XE 기술 세미나와 XECON에서 발표한 바 있고, 패스트캠퍼스에서 강의한 바 있습니다.

일간 이슬아와 이다님의 매일마감을 보고 용기내서 유료 뉴스레터를 시작합니다. 라라벨을 4 시절부터 써오고 있는데, 라라벨의 인기와 영향력은 날이 갈수록 늘어서 해외에서는 매일 새로운 자료들이 쏟아져 나오고 있습니다. 일 안하고 하루종일 읽기만 해도 과연 다 소화할 수 있을까 의문이 들 정도입니다. 한편, 한글로 된 자료는 좀처럼 찾아보기가 쉽지 않습니다. 그래서 매일 열심히 새로 나오는 라라벨 관련 정보들을 익히고, 하루에 한 편씩 알기 쉽게 정리해서 메일로 보내주는 일을 해보고자 합니다. 뉴스 큐레이션은 아닙니다. 샘플 원고는 여기서 확인하실 수 있습니다.

구독료는 한 달 1만원 입니다. 6월 말일까지 신청받고, 7월 1일부터 시작해서 7월 말일 까지 주중에 한 편씩 글을 보내드립니다. 주말엔 쉽니다.

보내드리는 글은 시간이 지나면 모든 사람들에게 공개할 예정입니다. 마음이 바뀌어 공개를 안할 수도 있습니다만, 일단은 3주 정도 후에 공개할까 합니다.

제 자신은 많은 개발자들이 무료로 공개한 자료로 학습했으면서, 글을 유료로 판매하는 것에 대해 다소 죄스런 마음이 있습니다. 하지만 앞서 말씀드렸듯 한글로 된 자료가 매우 희박한데, 그 이유는 지식을 공유할 만큼 여유로운 개발자의 수가 충분히 많지 않아서라고 생각합니다. 그래서 누군가는 여가시간이 아닌 일과시간을 이용해서 자료를 만들고 그것으로 돈을 버는 것도 의미가 있다고 믿습니다.

한 분 이라도 신청해주시면 진행합니다. 단 한 분만 구독하시더라도 최선을 다하겠습니다.

신청하시는 곳 https://forms.gle/rB4jFH6CYDETqpR97

라라벨에서 테이블 변경 마이그레이션 추가 후 테스트가 깨졌다

개발 단계에서는 테이블 생성하는 마이그레이션을 고쳐가며 작업해도 괜찮습니다. 하지만 이미 애플리케이션을 배포한 뒤라면 그럴 수 없죠. 기존 테이블을 수정하는 마이그레이션을 작성해야 합니다.

오늘은 기존 테이블을 변하는 마이그레이션을 작성하다가 겪은 일을 공유하고자 합니다.

아래와 같이 아주 간단한 마이그레이션을 작성했습니다.

public function up()
{
    Schema::table('posts', function(Blueprint $table) {
       $table->renameColumn('movie_id', 'postable_id');
       $table->string('postable_type')->default('');
    });
}

posts 테이블에서 movie_id 컬럼명을 postable_id로 바꾸고, postable_type 컬럼을 하나 추가하는 것입니다.

개발 환경에서는 마이그레이션이 문제 없이 실행되었는데, 테스트를 돌려보니 에러가 납니다. 에러 메시지를 보니 postable_type 컬럼이 없다고 합니다.

table posts has no column named postable_type

분명히 개발 환경에서 마이그레이션할 때 문제가 없었는데 어떻게 된 일일까요?

문제는 SQLite 때문이었습니다. 저는 테스트 속도를 높이기 위해 테스트시에는 SQLite를 쓰고 있습니다. 근데, SQLite는 테이블을 수정할 때 한 번에 여러 컬럼을 추가할 수가 없다고 하네요. 그래서 테스트 환경에서는 두번째 작업인 postable_type 컬럼 추가가 진행이 안된 것입니다.

해결 방법은 간단합니다. 수정하는 마이그레이션인 경우 한 번에 하나씩만 바꾸도록 코드를 바꿔주면 됩니다.

 public function up()
{
    Schema::table('posts', function(Blueprint $table) {
       $table->renameColumn('movie_id', 'postable_id');
    });

    Schema::table('posts', function(Blueprint $table) {
        $table->string('postable_type')->default('');
    });
}

물론 테스트 할 때 SQLite 안쓰시는 분은 신경쓰지 않으셔도 됩니다.

라라벨 5.8.16 새기능(2)

라라벨 5.8.16에서는 이전에 소개한 마이그레이션 이벤트 이외에 두가지 기능이 더 추가 되었습니다.

하나는 PostgreSQL을 사용하는 사람을 위한 기능으로, migrate:fresh 할 때 type을 지울 수 있는 옵션이 추가된 것입니다. 개발자에 의하면 PostgreSQL 에서는 ENUM에 타입을 사용하는데 migrate:fresh를 하면 테이블은 다 지워지지만 이 타입이 남아서 문제가 생겼었다고 하네요. 데이터베이스 뷰를 지우는 옵션을 사용하는 것과 같은 방법으로 사용하면 된다고 합니다. (데이터베이스 뷰를 지우는 옵션도 있었군요…ㅎㅎ)

php artisan migrate:fresh --drop-types

다른 하나는 MailMessage 클래스에 Renderable 컨트랙트를 추가한 것입니다. 이를 통해 알림(Notification) 메일이 어떻게 보내질 것인지 브라우저로 확인해볼 수 있다고 하네요. 예를 들어, 컨트롤러에서 다음과 같이 하면 된다고 합니다.

return (new FooNotification())->toMail('example@example.com');

브라우저로 메일 내용을 미리보는 건 Mailable 클래스에 이미 있던 기능인데, 같은 기능을 알림 메일에 사용하는 MailMessage 클래스에도 추가했다고 합니다.

그렇지 않아도 이번에 막 알림을 메일로도 받을 수 있게 작업하려는 참이었는데 잘됐네요 ㅎㅎ

라라벨 5.8.16 새기능(1) – 마이그레이션 이벤트 추가

Illuminate\Database\Events 네임스페이스에 아래 이벤트가 추가되었습니다.

  • MigrationEnded
  • MigrationsEnded
  • MigrationStarted
  • MigrationsStarted

이 기능을 제안하고 추가한 알렉스 보워스가 밝힌 용도는 마이그레이션을 시작할 때 캐시를 지우거나, 마이그레이션 시작과 종료를 모니터링하는 것 등 입니다.

참고

라라벨 5.8.11 – Date 파사드에 macro 메소드 추가

하 벌써 5.8.13이 나왔던데 뭔 업데이트가 이리 빠른가요.. 여튼 한 박자 늦긴 했지만 5.8.11 에 변경된 사항을 정리해봅니다.

Date 파사드에 macro 메소드 추가

Date::macro('example', function () {
    return 'hello';
});

Date::example(); // hello

위의 예시에서 보듯이 macro 메소드는 런타임에 인스턴스에 메소드를 추가할 수 있게 해줍니다. macro 메소드는 컬렉션에도 있고 리스폰스에도 있다는데 아직 써보진 못했어요. 왜 이 기능을 추가하기로 했는지 궁금해서 PR을 찾아봤는데 별 내용이 없더군요.

다행히 Carbon에 설명이 있어서 용도를 가늠해볼 수 있었습니다. Carbon 문서에서는 설정이나 유저 선호에 따라 날짜를 출력할 때 쓰기 좋다고 이야기하고 있습니다. 아래는 Carbon 문서에 있는 예시입니다. 파리 시간과 프랑스어로 바꾸고 calendar 메소드를 실행한 결과를 출력하도록 formatForUser 메소드를 추가합니다.

<?php
// Let assume you get user settings from the browser or preferences stored in a database
$userTimezone = 'Europe/Paris';
$userLanguage = 'fr_FR';

Carbon::macro('formatForUser', function () use ($userTimezone, $userLanguage) {
    $date = $this->copy()->tz($userTimezone)->locale($userLanguage);

    return $date->calendar(); // or ->isoFormat($customFormat), ->diffForHumans(), etc.
});

// Then let assume you store all your dates/times in UTC (because you definitely should)
$dateString = '2010-01-23 10:00:00'; // Get this from your database or any input

// Then now you can easily display any date in a page/e-mail using those user settings and the chosen format
echo Carbon::parse($dateString, 'UTC')->formatForUser();   // 23/01/2010

덕분에 이른바 Macroable 이라는 특성에 대해 생각해보는 기회가 됐네요. 현재까지 이해한 바로는 기존 클래스를 확장하기엔 불편하고, 헬퍼보다는 더 체계적이고 싶을 때 쓰면 좋은 것 같습니다. 가령 Collection을 확장해서 MyCollection을 만들면 엘로퀀트 ORM도 Collection 대신 MyCollection을 반환하게 손을 대는 등 프레임워크의 여러 부분에 손을 대야 할 것 같아요. 메소드 하나 추가하자고 일이 너무 커져버리니까 이런 경우에 macro라는 컨셉을 쓰나 봅니다. 이 부분은 잘 몰라서 뇌피셜을 쓴 것이니 바로잡아주실 필요가 있으면 댓글 부탁드려요.

5.8.11에 추가된 게 두 가지 더 있지만 그건 다음에 기회되면 다룰께요.

라라벨 5.8.9 – 이벤트 발견 기능 추가

5.8.8 까지는 어떤 이벤트가 발생하면 어떤 리스너가 작동해야하는지 직접 적어줬어야 했습니다. 아래와 같은 식이죠.

/**
 * The event listener mappings for the application.
 *
 * @var array
 */
protected $listen = [
    'App\Events\OrderShipped' => [
        'App\Listeners\SendShipmentNotification',
    ],
];

5.8.9 부터 이벤트 발견 기능이 추가되어 이벤트와 리스너의 관계를 직접 등록하는 수고를 덜게 됐습니다.

이벤트 발견 기능은 기본적으로 비활성화 되어 있습니다. 이벤트 발견 기능을 사용하려면 아래와 같이 EventServiceProvidershouldDiscoverEvents 메소드를 오버라이드해야 합니다.

/**
 * Determine if events and listeners should be automatically discovered.
 *
 * @return bool
 */
public function shouldDiscoverEvents()
{
    return true;
}

이벤트 발견 기능을 활성화하면 이벤트 캐시 파일이 있으면 이를 이용하고, 없으면 실시간으로 이벤트를 찾습니다. 실시간으로 리퀘스트를 찾으면 애플리케이션이 느려지기 때문에 되도록 캐시를 사용하는게 좋습니다. artisan event:cache 명령으로 캐시할 수 있습니다.

Laravel Collection 메소드 중 concat과 push의 차이

라라벨 5.8.8에서 쿼리 빌더에 forPageBeforeId 메소드가 추가되었습니다. 뭔지 알아보려고 PR을 보는데, 예제에서 컬렉션 메소드 중 concatpush를 쓰더군요.

$posts = new Collection;

$posts = $posts->concat(ChatPost::forPageBeforeId(15, $focused->id)->get()->reverse());

$posts = $posts->push($focused);

$posts = $posts->concat(ChatPost::forPageAfterId(15, $focused->id)->get());

둘 다 제가 잘 안쓰던 메소드들이라 메뉴얼을 찾아봤는데, 읭? 둘이 똑같아 보이는 겁니다.

push 메소드는 컬렉션의 마지막에 아이템을 추가합니다:

concat 메소드는 주어진 배열 또는 컬렉션의 마지막에 값을 추가합니다:

그래서 소스를 봤는데, 소스를 보니 차이점을 알겠더라구요.

    /**
     * Push all of the given items onto the collection. 
     *
     * @param  iterable  $source
     * @return static
     */
    public function concat($source)
    {
        $result = new static($this);

        foreach ($source as $item) {
            $result->push($item);   // 주어진 아이템들을 push를 사용해서 추가
        }

        return $result;
    }

push는 하나의 아이템을 컬렉션의 마지막에 추가하는 거고, concatpush 메소드를 이용해서 여러 아이템을 한 번에 추가하는 거였어요.

뭐 별로 중요한 얘기는 아니었습니다 하핫