ローカル環境でのテストでSQLiteを使っていたけど、PostgreSQL固有の機能を使用した実装を行った場合はSQLiteではテストできなくなるのでPostgreSQLに変更したところ、今まで通ってたテストが通らなくなる場合があります。ファイル単体のテストでは通るのに、ファイル指定をせずに一括で行った場合にエラーになるといった現象となります。

対策

対策1

phpunit.xmlのprocessIsolationをtrueにする

processIsolation="true"

対策1を行った後に全体のテストを行うと、以下のエラーとなったケースがあります。

$ vendor/bin/phpunit
PHPUnit 9.5.25 #StandWithUkraine

Warning:       Your XML configuration validates against a deprecated schema.
Suggestion:    Migrate your XML configuration using "--migrate-configuration"!

EEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE   61 / 1757 (  3%)
EEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE  122 / 1757 (  6%)
EEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE  183 / 1757 ( 10%)
省略
EEEEEEEESerialization of 'Illuminate\Http\Testing\File' is not allowed

対策2

phpunit.xmlのbackupStaticAttributesをtrueにする（その場合、processIsolationはfalseで良い）

backupStaticAttributes="true"

Windowsで入力フォームのテキストエリアに改行を入れるとCRLFとなるのですが、Laravelの文字数に関するバリデーションでCRとLFで2文字にカウントされるのをLFに変換して1文字でカウントされるようにする方法です。

調べてみるとFormRequestのvalidationDataをオーバーライドするやり方が見つかったのですが、変換処理は全ての入力に対して行いたいので、基底となるクラスを作成して継承させるか、Traitを作成してuseするか等が考えられます。そうなると現行システムに対して変更するファイルが多くなってしまうのと、そもそもFormRequestを使ってない箇所もあったのでapp/Providers/AppServiceProvider.phpに処理を書いてみました。

class AppServiceProvider extends ServiceProvider
{
    private function convertCrlfToLf(&$results, $params, $prevKey = null)
    {
        foreach ($params as $key => $value) {
            if ($prevKey) {
                $key = $prevKey . '.' . $key;
            }

            if (is_array($value)) {
                $this->convertCrlfToLf($results, $value, $key);
            } else {
                $value = preg_replace("/\r\n/", "\n", $value);
                data_set($results, $key, $value);
            }
        }
    }

    /**
     * Bootstrap any application services.
     *
     * @return void
     */
    public function boot()
    {
        // windowsの場合、改行がCRLFで2文字としてカウントされるのでLFに変換する
        $results = [];
        $this->convertCrlfToLf($results, request()->all());
        request()->replace($results);

        // 以下省略

項目の多い入力フォーム等で、

<textarea name="foo[bar][baz]"></textarea>

のようにネストした配列にも対応させるため、再帰的に処理できるようにしました。

$dt = new Carbon();
echo $dt->formatLocalized('%Y年%m月%d日（%a）');

のようにformatLocalized()メソッドを使った方法が多く出てきますが、Carbon 2では isoFormat()メソッドが推奨されています。

$dt = new Carbon();
echo $dt->isoFormat('YYYY年MM月DD日（ddd）');

Laravelのフォームリクエストを使うと、記述したルールでのバリデーションを使ってバリデーションを行い、エラーがあった場合はエラー内容を持って前の画面に戻る、というのを行ってくれます。
コントローラー内に処理を書かなくて良くなり、コントローラーが見やすくなるので、APIの実装にも使いたいけどエラー内容をjsonで返すのどうやるんだろ？ていうときの書き方です。

protected function failedValidation(Validator $validator)
{
    if (request()->expectsJson()) {
        $response['errors']  = $validator->errors()->toArray();

        throw new HttpResponseException(
            response()->json( $response, 422 )
        );
    }
}

フォームリクエストクラス内に上記メソッドを追加します。
最初のif文でAjaxリクエストかどうか判定しています。Ajaxリクエストじゃない場合は何もせず通常通りとなりますので、Ajax、htmlのformどちらからのリクエストにも対応しています。

参考
https://qiita.com/yamatox/items/94e123849d924329a167

https://wada811.blogspot.com/2014/05/failed-to-push-to-github-over-https.html
https://qiita.com/kz800/items/497ec70bff3e555dacd0
を参考に、GitHubのPersonal access tokensを設定して .netrcに記述すればpushは出来るようになりました。

その後、別のプライベートリポジトリをcloneしようとしたらエラーで出来なかったので、以下のようにすればclone出来ました。

git clone https://ユーザ名:アクセストークン@github.com/ユーザ名/リポジトリ名

初期設定

今回に限らず、サーバ構築時の共通設定として以下の作業を行いました。

一般ユーザーの作成&sudo&ssh接続設定（公開鍵認証）&システムアップデート

参考: https://help.sakura.ad.jp/hc/ja/articles/206208181

sshdの再起動は

# systemctl restart sshd

参考URLにあるパケットフィルターはさくらのVPS用のものなので、ここではスルーします。

yum-cronによるパッケージの自動更新

インストール

# yum -y install yum-cron

設定

# vi /etc/yum/yum-cron.conf

自動更新を有効に設定

apply_updates = yes

サービス起動&自動起動設定

# systemctl start yum-cron # systemctl enable yum-cron
# systemctl enable yum-cron

Firewall設定

http、httpsのポートを開けます。

# vi /etc/firewalld/zones/public.xml

<zone>
  …省略
  <service name="http"/>
  <service name="https"/>
</zone>

設定変更したらサービスを再起動します。

# systemctl restart firewalld

Nginx

インストール

# vi /etc/yum.repos.d/nginx.repo

[nginx]
name=nginx repo
baseurl=http://nginx.org/packages/mainline/centos/7/$basearch/
enabled=0
gpgcheck=0

yum -y --enablerepo=nginx install nginx

サービス起動&自動起動設定

# systemctl start nginx
# systemctl enable nginx

php&php-fpm

EPELリポジトリの追加

# yum install epel-release

インストール済みだったような。

remiリポジトリの追加

# rpm -Uvh http://rpms.famillecollet.com/enterprise/remi-release-7.rpm

インストール

$ sudo yum -y install --enablerepo=remi,remi-php73 php php-devel php-mbstring php-pdo php-pgsql php-gd php-xml php-mcrypt php-fpm

php-fpmの設定

# vi /etc/php-fpm.d/www.conf

user = nginx
group = nginx
listen = /var/run/php-fpm/php-fpm.sock;
listen.owner = nginx
listen.group = nginx

php-fpm起動&自動起動設定

# systemctl start php-fpm
# systemctl enable php-fpm

Nginxでphpを設定

# vi /etc/nginx/conf.d/default.conf

root   /usr/share/nginx/html;

location / {} の中からserver {} 直下に出す

location / {
    index index.php index.html index.htm;
}

index.phpを追加

location ~ \.php$ {
    #root           html;
    fastcgi_pass   unix:/var/run/php-fpm/php-fpm.sock;
    fastcgi_index  index.php;
    fastcgi_param  SCRIPT_FILENAME  $document_root/$fastcgi_script_name;
    include        fastcgi_params;
}

コメントを外して、それぞれ変更

動作確認用phpファイル作成

# vi /usr/share/nginx/html/phpinfo.php

<?php phpinfo(); ?>

Nginxを再起動

# systemctl restart nginx

ブラウザから /phpinfo.php にアクセスして表示されるのを確認

Composerインストール

$ php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
$ php -r "if (hash_file('sha384', 'composer-setup.php') === '48e3236262b34d30969dca3c37281b3b4bbe3221bda826ac6a9a62d6444cdb0dcd0615698a5cbe587c3f0fe57a54d8f5') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"
$ php composer-setup.php
$ php -r "unlink('composer-setup.php');"

$ sudo mv composer.phar /usr/local/bin/composer

PostgreSQL

インストール

# yum -y install postgresql-server postgresql-devel

初期化処理

# postgresql-setup initdb

サービス起動&自動起動設定

# systemctl start postgresql.service
# systemctl enable postgresql.service

パスワード認証に変更

# vi /var/lib/pgsql/data/pg_hba.conf

local   all             all                                     md5
host    all             all             127.0.0.1/32            md5
host    all             all             ::1/128                 md5

に変更

postgresユーザのDB接続パスワード設定

# su - postgres
$ psql -U postgres
postgres=# ALTER USER postgres encrypted password 'パスワード'; postgres=# \q
$ exit

サービス再起動

# systemctl restart postgresql.service

ユーザー作成

# su - postgres
$ createuser -P ユーザー名
パスワード入力

DB作成

$ psql -U postgres
postgres=# create database DB名 owner ユーザー名;

Redis

インストール

# yum install --enablerepo=epel,remi redis

サービス起動&自動起動設定

# systemctl start redis.service
# systemctl enable redis.service

Laravelアプリ

Laravelアプリのgitリポジトリがある前提です。
今回は /var/www ディレクトリに配置します。上記で作成した一般ユーザが書き込みできるよう権限を付加しておきます。

git clone

$ git clone リポジトリURL
$ cd リポジトリ名

Laravelセットアップ

$ composer install
$ cp .env.example .env
$ php artisan key:generate
$ vi .env

APP_ENV=production
APP_DEBUG=false
APP_URL=[LaravelアプリのURL]

DB_CONNECTION=pgsql
DB_HOST=127.0.0.1
DB_PORT=5432
DB_DATABASE=[作成したDB名]
DB_USERNAME=[作成したDBユーザ名]
DB_PASSWORD=[DBユーザのパスワード]

QUEUE_CONNECTION=redis

MAIL_DRIVER=sparkpost
SPARKPOST_SECRET=[sparkpostのAPIキー]

メール送信は https://www.sparkpost.com/ を利用しました。

$ php artisan migrate:fresh --seed
$ chmod 777 -R /var/www/imbr-delivery/storage

Nginx設定変更

# vi /etc/nginx/conf.d/default.conf

root   /var/www/[リポジトリ名]/public;

location / {
    index  index.php index.html index.htm;
    try_files $uri $uri/ /index.php?$query_string;
}

設定変更後、サービスを再起動する。

# systemctl restart nginx

Let’s Encript

certbotのインストール

一般ユーザのホームディレクトリで行いました。

$ git clone https://github.com/certbot/certbot

証明書の取得

$ cd certbot
$ sudo ./certbot-auto --nginx

証明書の更新

0 4 1 * * /home/[一般ユーザ名]/certbot/certbot-auto renew && /bin/systemctl reload nginx

cronで設定します。

Supervisor

インストール

# yum install supervisor

サービス起動&自動起動設定

# systemctl start supervisord.service
# systemctl status supervisord.service

設定ファイル編集

# vi /etc/supervisord.d/laravel-worker.ini

[program:laravel-worker]
process_name=%(program_name)s_%(process_num)02d
directory=/var/www/[リポジトリ名]
command=php artisan queue:work redis --sleep=3 --tries=1
autostart=true
autorestart=true
user=root
numprocs=4
redirect_stderr=true
stdout_logfile=/var/www/imbr-delivery/storage/logs/worker.log

supervisorの起動

# supervisorctl reread
# supervisorctl update
# supervisorctl start laravel-worker:*

その他

タスクスケジューラ

Laravelのタスクスケジューラを使うために以下のCron設定を行います。

0,10,20,30,40,50 * * * * cd /var/www/[リポジトリ名] && php artisan schedule:run >> /dev/null 2>&1

管理画面で何かしらのデータをCSVファイルのアップロードによってインポートする機能を作りました。データの件数によっては処理に時間がかかってしまうので、インポート処理はジョブ化して非同期で実行するようにしました。

use App\Http\Requests\CsvRequest;
use App\Jobs\ImportFromCsvJob;

class ImportController extends Controller
{
    public function importCsv(CsvRequest $request)
    {
        $path = $request->csv->store('csv');
        ImportFromCsvJob::dispatch(auth()->user(), $path);

        $request->session()->flash('success', '作成処理を開始しました。終了したらメールで通知します。');

        return back();
    }
}

このように、コントローラー側でアップロードされたファイルを保存して、そのパスをジョブに渡します。ジョブ側では受け取ったパスをStorage::get()で読み込んでインポート処理を行います。

ローカル環境で確認して問題なかったので検証用環境にデプロイしたのですがインポートされませんでした。調べてみると、ジョブ側で File not found となっていました。

検証用環境

検証用環境はDokkuというHerokuライクなツールで構築しています。詳しい設定内容は省略しますが、Procfileにて

web: vendor/bin/heroku-php-apache2 public/
worker: php artisan queue:work --tries=3

となっていて、管理画面とキューワーカがそれぞれ実行されています。

原因と対応

管理画面とキューワーカはそれぞれ別のコンテナとなります。なのでwebにアップロードしたファイルがworkerには存在しませんでした。

# 検証用環境にて
$ dokku enter app-name web # webコンテナに入る
$ ls storage/app
アップロードしたファイルが表示される
$ exit
$ dokku enter app-name worker # workerコンテナに入る
$ ls storage/app
アップロードしたファイルは表示されない
$ exit

ストレージプラグインを使ってコンテナ間で共有できるストレージを設定しました。

$ dokku storage:mount app-name /path/to/shared-storage:/app/storage/app
$ dokku ps:rebuild app-name

これでインポート処理が行われるのを確認しました。

Laravelで、と書きましたがLaravel関係なかったです。仮想環境での問題なので、Herokuでも同様の対応が必要になると思われます。

config/auth.php にデフォルトで設定されている guards.api を使用してAPI認証を行うために必要な項目についてまとめました。
ベースとなる認証については php artisan make:auth で作成している前提となります。Laravel5.7で確認しました。

カラム追加

users テーブルにトークンを保持するための api_token カラムを追加します。

$ php artisan make:migration add_api_token_to_users_table --table=users

<?php

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class AddApiTokenToUsersTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::table('users', function (Blueprint $table) {
            $table->string('api_token', 60)->unique()->nullable();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::table('users', function (Blueprint $table) {
            $table->dropColumn('api_token');
        });
    }
}

$ php artisan migrate

モデル変更

App\Userの $fillable と $hidden に api_token を追加します。

トークンの作成・削除

ログイン時にトークンを生成、ログアウト時にトークンを削除する処理を入れます。
app/Http/Controllers/Auth/LoginController.phpに以下を追加します。

use Illuminate\Support\Str;

class LoginController extends Controller
{
    protected function authenticated(Request $request, $user)
    {
        $user->update(['api_token' => Str::random(60)]);
    }

    public function logout(Request $request)
    {
        $user = $request->user();
        $user->update(['api_token' => null]);

        $this->guard()->logout();

        $request->session()->invalidate();

        return $this->loggedOut($request) ?: redirect('/');
    }
}

動作確認

routes/api.phpにデフォルトで定義されている以下のルーティングで確認します。

Route::middleware('auth:api')->get('/user', function (Request $request) {
    return $request->user();
});

webから任意のユーザでログインし、トークンを生成します。生成したトークンはGETパラメータ api_token で渡すか、Headerパラメータの Authorization: Bearer トークンで渡すことができます。
/api/user にアクセスしてログインしているユーザの情報がjsonで取得できれば成功です。

認証に失敗した場合、Headerパラメータの Accept: application/json または X-Requested-With: XMLHttpRequest が設定されている場合は “message”: “Unauthenticated.” のjsonレスポンスが、それ以外はログイン画面に遷移するようになっています。

参考

https://qiita.com/zaburo/items/57657c78f54accf400f6
https://www.webopixel.net/php/1343.html
https://readouble.com/laravel/5.8/ja/api-authentication.html

実装しているとたまに表題の現象が発生して、見た感じパラメータも間違ってないのになんでだろう？ってなることがあったのでメモ。

結論を先に書くと、ルートパラメータとinputパラメータのパラメータ名が重複しているのが原因でした。

例えばIPアドレスを管理するとして、ip_addressesテーブルにip_addressカラムがあるとします。（その他のカラムは省略）
これを Route::resource(‘ip_addresses’, ‘IpAddressController’) なルーティングにした場合、フォームリクエストバリデーションでuniqueの除外IDに指定するパラメータ $this->ip_addressに入っているのはルートパラメータではなく、フォームのip_addressの入力値となります。（上記リンク参照）

解決策としては、ルーティングを以下のように変更してルートパラメータ名を変更する方法があります。

Route::resource('ip_addresses', 'IpAddressController')->parameters([
    'ip_addresses' => 'ipAddress',
]);

これでフォームリクエストバリデーションでuniqueの除外IDに指定するパラメータを $this->ipAddress にすれば有効になります。

Notification::send(auth()->user(), new NotificationClassName());

ローカル環境ではキューの設定(QUEUE_CONNECTION)がジョブが即時に実行される設定(sync)になっていて、それだと動いたのにデータベース(database)に変更したら動きませんでした。Laravelのログを確認したら

Call to a member function routeNotificationFor() on null

の文字が。キューがバックエンドで実行される事になって auth() が取得できなくなったという、当たり前といえば当たり前な出来事でした。
ログインユーザのインスタンスを別途受け渡して解決しました。確認したLaravelのバージョンは5.7です。

public function rules()
{
    return [
        'name' => 'required|max:255',
        'email' => [
            'required',
            'max:255',
            'email',
            Rule::unique('users')->ignore($this->user),
        ],
        'password' => ($this->user) ? 'nullable|min:6|confirmed' : 'required|min:6|confirmed',
    ];
}

↑はFormRequestに定義するrulesになります。ルーティングは↓を想定しています。

Route::resource('users', 'UserController');

また、コントローラー側でデータを保存前にpasswordの入力があるかチェックをして、入力がなければパラメータに含めない、という制御も必要になります。

public function update(UserRequest $request, User $user)
{
    $validatedData = $request->validated();

    if ($validatedData['password']) {
        $validatedData['password'] = Hash::make($validatedData['password']);
    } else {
        unset($validatedData['password']);
    }

    $user->update($validatedData);

    return redirect()->route('users.show', [$user]);
}

今回やりたいことは、ページの日本語／英語の表示切り替えで、設定内容をセッションで保持してページの読み込み時にセッションに保持された設定があれば反映する、ということです。

コントローラのコンストラクタに書けばいいかと思い調べてみたら、Laravel5.3以降は普通に書いても動かなくなったということで（参考ページ）回避策として下のような書き方が使えるということがわかりました。

public function __construct()
{
    $this->middleware(function ($request, $next) {
        if (session('lang')) {
            \App::setLocale(session('lang'));
        }
    
        return $next($request);
    });
}

ですがせっかくなのでミドルウェアを定義してみようと思います。Laravelのバージョンは5.7です。

実装

ミドルウェア作成

$ php artisan make:middleware Lang

<?php

namespace App\Http\Middleware;

use Closure;

class Lang
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        if (session('lang')) {
            \App::setLocale(session('lang'));
        }

        return $next($request);
    }
}

ミドルウェア登録

app/Http/Kernel.php の $routeMiddleware プロパティに追加します。

/**
 * The application's route middleware.
 *
 * These middleware may be assigned to groups or used individually.
 *
 * @var array
 */
protected $routeMiddleware = [
    'auth' => \App\Http\Middleware\Authenticate::class,
    'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
    'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,
    'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,
    'can' => \Illuminate\Auth\Middleware\Authorize::class,
    'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
    'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,
    'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
    'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,
    'lang' => \App\Http\Middleware\Lang::class, // 追加
];

コントローラのコンストラクタに以下のように書いたり、

/**
 * Create a new controller instance.
 *
 * @return void
 */
public function __construct()
{
    $this->middleware('lang');
}

ルート定義に書いて使うことができます。

Route::get('/', function () {
    //
})->middleware('lang');

おかげさまで、フリーランスになって10年になりました。

よく聞く話だとフリーランスになって10年続くのは全体の1割程度ということで、まぁ続かなかった9割のすべてが続けたくても続けられなかったのかというと、事業が順調で法人になったとか、いい会社が見つかって就職したりだとか、そもそも次の仕事見つけるまでのつなぎだったとかあるだろうし、生き残ったからすごい！とは思わないけど、自分でやると決めたことを断念することなく続けることができたのは良かったと思います。

フリーランスというと、始めた当時だと一念発起で独立開業！みたいなイメージがまだあったかもしれないけど、最近では時代の流れかライトな感覚になったように思います。例えると持ち家か賃貸かみたいな、一長一短あるのでお好きな方を選んでください的な。実際ここ数年で自分の周りにもフリーランスになった人が増えました。世はまさにフリーランス戦国時代か、っていうぐらい。まぁ自分の生息範囲が有名企業とは縁のない中小零細Web企業周辺なもんですから、行き着く先は自営業のおっさんっていうキャリアパスになるのもある意味納得な気がします。

そんなこんなでどのようにやってきたかを振り返りつつ、次の10年に向けて考えていきたいと思います。

続けるコツ

こういうのを書いておくとブログ記事っぽくなるのかなと思って考えてみたけど、結果として長く続いただけで長く続けようと思ってやってきたわけではなかったw。あえて言うとしたら無理をしないで自分の働きたいと思う働き方をすることじゃないかと思います。

バリバリ働きたい人はバリバリ働けばいいし、あまり働きたくない人はあまり仕事を入れなければいいし、会社員と同じように働きたければ客先常駐すればいいし、出勤したくなければリモートでできる仕事をすればいい、といった具合です。自分がやりたいと思うようにやれているか、というのが第一と思います。

第二に、満足な収入が得られているかどうかということですが、幸いフリーランスで仕事を受けるときって、いくら欲しいか聞かれるので正直に答えましょうw。

この2点が崩されると、やりたいようにやれてない＋満足な収入が得られていない＝最悪となってしまいます。

また、数年で転職というのが珍しくないIT業界ですが、フリーランスだとお付き合いする会社が1社でずっと同じというわけではないので事実上転職、みたいになるのも飽きずに続けられた要因かもしれないです。

次の10年に向けて

年齢的に現在40代で10年後には50代になるのでその頃にどうなってるんだろう、というのがあります。具体的には仕事が減ったり単価が下がるのではないかという懸念ですね。これに対しては今もやってるけど、リモートワークと複業が自分の中ではカギかなと思っています。

リモートワークで直接的なコミュニケーションが無ければ相手が何歳とか関係なくなるのでは、という作戦です。さすがに書いたコードがおじさん臭いと言われてしまえばお手上げですがw。「この人年齢はアレだけどコードはちゃんと書いてるし、Slackとかで普通にやり取りできるから大丈夫」と言ってもらえればアリかと。

また、年齢を重ねるにつれて、プロジェクトにおいてサブ的なポジションのお仕事にシフトしてくるだろうということで、そいう言ったお仕事を複数合わせて一本、を目指すやり方も検討したいです。

とはいえ、自分ひとりだけが年を取るわけではないので蓋を開けてみればそんなに変わってないような気もします。人材を扱う各社もその頃には「50代、60代のエンジニアがアツい」とか言ってそうだしw。

というわけで、今後ともよろしくお願いします。

マストドンでログインをRailsで実装するを使ってWebサービスを実装中に発見されたomniauth-mastodonの不具合と、その対応内容についてまとめました。

マストドンでログインの流れ

マストドンでログインの流れは以下のようになります。

①最初にこのようなダイアログが表示され、username@domain を入力してLoginをクリックします。

②すると入力したdomain のインスタンスのログイン画面に遷移するのでメールアドレスとパスワードを入力してログインすればコールバックを設定した画面に返ってきます。

③返ってきた画面ではインスタンスから取得した各種値の中でもprovider とuid をキーとしてデータの存在をチェックして、存在しなければ新規作成を行います。provider には認証を提供しているサービス名を表す文字列が入ります。マストドンなのでmastodon が、uid にはサービス内で一意の値が入ります。マストドンはインスタンスごとの管理となっているのでusername@domain となります。

不具合内容

uidとして返ってくるのは①の画面で入力したusername@domainなのですが、認証は②の画面で行われ、必ずしも①で入力したusernameでログインしなければいけないわけではありません。

例えば①でuser1@domain と入力して②でuser2 のメールアドレスとパスワードでログインしたらuidにはuser1@domain が返ってきてしまいます。これではアカウントの管理ができません。

対応内容

本家のGitHubを見てみるとこの問題に対するプルリクエストが挙がっていてマージされていました。

ですがその修正内容はuidの中身をusername@domain からid に変更するというものでした。これだとインスタンスが違えば重複が発生するのではないかという疑問と、実装中のWebサービスはusername@domainの形式が来ることを期待しているという都合もあってそのまま使うことが出来ませんでした。

なのでForkしてuidの中身を②でログインしたユーザーのusername@domain を返すよう変更しました。

gem 'mastodon-api', require: 'mastodon', github: 'tootsuite/mastodon-api'
gem 'omniauth-mastodon', github: 'ezaki3/omniauth-mastodon', branch: 'change-uid'
gem 'omniauth'

でインストールすることが出来ます。

前回構築した環境にLet’s EncryptでSSLを設定したときの作業履歴とメモ。

Firewall設定

httpsのポートを開けます。

# vi /etc/firewalld/zones/public.xml

<zone>
  …省略
  <service name="https"/>
</zone>

設定変更したらサービスを再起動します。

# systemctl restart firewalld

certbotのインストール

Let’s Encryptのクライアントをインストールします。今回はSSHでログインしたユーザーのホームディレクトリで行いました。

$ git clone https://github.com/certbot/certbot

証明書の取得

standaloneプラグイン(自前のHTTPサーバーを起動)で行うため、Nginxを止めておきます。

# systemctl stop nginx

インストールしたクライアントのディレクトリに移動して

$ cd certbot
$ ./certbot-auto certonly --standalone -t

まず、必要なパッケージのインストールについて確認が入るので「y」でインストールする。

次にメールアドレスを聞かれるので入力する

Enter email address (used for urgent renewal and security notices) (Enter 'c' to
cancel): メールアドレス

次に規約とメール送信について聞かれるので以下のように入力しました。

-------------------------------------------------------------------------------
Please read the Terms of Service at
https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf. You must
agree in order to register with the ACME server at
https://acme-v01.api.letsencrypt.org/directory
-------------------------------------------------------------------------------
(A)gree/(C)ancel: A

-------------------------------------------------------------------------------
Would you be willing to share your email address with the Electronic Frontier
Foundation, a founding partner of the Let's Encrypt project and the non-profit
organization that develops Certbot? We'd like to send you email about EFF and
our work to encrypt the web, protect its users and defend digital rights.
-------------------------------------------------------------------------------
(Y)es/(N)o: N

最後にドメインを入力します。

Please enter in your domain name(s) (comma and/or space separated)  (Enter 'c'
to cancel): ドメイン

成功すると以下のように表示されます。

IMPORTANT NOTES:
 - Congratulations!〜以下省略

Nginxの設定

証明書の設定と、httpへのアクセスをhttpsに転送する設定、あと後述する自動更新のための設定を行います。

# vi /etc/nginx/conf.d/設定ファイル名.conf

server {
    listen 443 ssl; # 80から変更
    proxy_set_header X-Forwarded-Proto https;
   #　以下省略
}

# vi /etc/nginx/conf.d/default.conf

server {
    # 自動更新のための設定
    location ^~ /.well-known/acme-challenge/ {
      default_type "text/plain";
      root        /usr/share/nginx/html;
    }

    # http => https
    location / {
        return 301 https://$host$request_uri;
    }
}

設定したらサービスを起動してhttpsで接続できるか、httpでアクセスしたらhttpsに転送されるか確認します。

# systemctl start nginx

証明書の更新

証明書を作成するときに指定したモードで更新も行われるけど、standaloneプラグインだとNginxを停止させなければいけないので、webrootプラグインに変更します。

以下のコマンドで実行がてら設定ファイルも更新されます。

$ ./certbot-auto certonly --webroot -w /usr/share/nginx/html -d ドメイン--agree-tos --force-renewal -n

とココまで書いてて気がついたけどNginxプラグインというのがあったので最初からそれを使っていたら良さげ。

更新を自動化する

cronを設定します。

0 4 1 * * /home/ユーザー名/certbot/certbot-auto renew && /bin/systemctl reload nginx

参考

https://qiita.com/HeRo/items/f9eb8d8a08d4d5b63ee9

調べてみると以下の情報が。

https://github.com/tootsuite/mastodon/issues/6399

なるほど、boxが新しくなってるのねということで、vagrant destroyしてvagrant upしたら今度は以下のエラーに。

The box 'ubuntu/xenial64' could not be found or
could not be accessed in the remote catalog. If this is a private
box on HashiCorp's Atlas, please verify you're logged in via
`vagrant login`. Also, please double-check the name. The expanded
URL and error message are shown below:

URL: ["https://atlas.hashicorp.com/ubuntu/xenial64"]
Error: The requested URL returned error: 404 Not Found

調べてみるとVagrantについてるcurlではダメだという情報があったので

sudo rm /opt/vagrant/embedded/bin/curl

してみたけど変わらず。Vagrantをアップデート(1.9.2 => 2.0.3)したらOKでした。

余談ですがVagrantアップデート後

vagrant plugin repair

しました。

フォームの入力エラー表示で入力項目の下に個別にエラーを表示させるやり方です。

<div class="form-group">
    <label for="name">名前</label>
    <input name="name" type="text" class="form-control @if($errors->has('name')) is-invalid @endif" id="name" value="{{ old('name') }}">
    <div class="invalid-feedback">
        @foreach ($errors->get('name') as $error)
            {{ $error }}<br>
        @endforeach
    </div>
</div>

Laravel5.4、Bootstrap v4.0を使っています。@if($errors->has(‘name’)) でエラーかどうか判定してclassを付加し、@foreach ($errors->get('name') as $error) でエラーメッセージを取得しています。

シンプルに

client = Mastodon::REST::Client.new(base_url: 'https://instance_domain', bearer_token: 'your_access_token')
client.create_status('Hello world')

だと投稿出来たのですが、公開範囲等のオプションを追加して

client.create_status('Hello world', params)

(paramsにオプションが定義されている)だとエラーとなり投稿できませんでした。メディアのアップロードも出来ませんでした。パラメータの指定の仕方はソースコードを確認してるのに、どうしてだろうと思ってたら、どうやら

gem 'mastodon-api', require: 'mastodon'

でインストールされるのがgithub上のより古いみたいで

gem 'mastodon-api', require: 'mastodon', github: 'tootsuite/mastodon-api'

とすれば動くようになりました。

omniauth-mastodonというgemを使ってマストドンでログインをRailsで実装する手順についてまとめました。また、ベースとなっているomniauthで必要な項目についても触れています。

omniauth-mastodon

インストール

# Gemfile
gem 'mastodon-api', require: 'mastodon'
gem 'omniauth-mastodon'
gem 'omniauth'

モデルの作成

後述する設定で使用するモデルを作成します。

$ rails generate model MastodonClient domain:string client_id:string client_secret:string

設定

マストドンはtwitter等と違ってドメインの異なる複数のインスタンスが存在します。twitterの場合は別途設定画面からアプリケーションを登録してその情報を使用するのですが、マストドンでは動的に取得してDBに保持します。

# config/initializers/omniauth.rb
Rails.application.config.middleware.use OmniAuth::Builder do
  provider :mastodon, scope: 'read write follow', credentials: lambda { |domain, callback_url|
    Rails.logger.info "Requested credentials for #{domain} with callback URL #{callback_url}"

    existing = MastodonClient.find_by(domain: domain)
    return [existing.client_id, existing.client_secret] unless existing.nil?

    client = Mastodon::REST::Client.new(base_url: "https://#{domain}")
    app = client.create_app('OmniAuth Test Harness', callback_url, 'read write follow')

    MastodonClient.create!(domain: domain, client_id: app.client_id, client_secret: app.client_secret)

    [app.client_id, app.client_secret]
  }
end

本家のREADMEでは

app = client.create_app('OmniAuth Test Harness', callback_url, 'read write follow')

に'read write follow' の指定はありませんが、省略したままだと

invalid_scope: 要求されたアクセス権は無効であるか、不明、または不正なフォーマットです。

のエラーとなります。また、第4引数として@param website [String] を渡すこともできます。認証済みアプリ一覧にWebsiteへのリンクを貼ることが出来ますので必要に応じてWebsiteのアドレスを入れます。

/auth/mastodon にアクセスするとマストドンでログインが始まります。

omniauth

設定

ここではUser モデルに保持する想定です。まずルーティングの設定をします。

# config/roues.rb
get '/auth/:provider/callback', to: 'sessions#create'

マストドンでログインが完了した時に返ってくる画面になります。

実装

# app/controllers/sessions_controller.rb
class SessionsController < ApplicationController
  def create
    @user = User.find_or_create_from_auth(request.env['omniauth.auth'])
    self.current_user = @user
    redirect_to '/'
  end
end

# app/models/user.rb
class User < ApplicationRecord
  def self.find_or_create_from_auth(auth)
    provider = auth[:provider]
    uid = auth[:uid]
    token = auth[:credentials].token

    self.find_or_create_by(provider: provider, uid: uid) do |user|
      user.token = token
    end
  end
end

認証情報を登録するための最低限の実装例です。

追記

マストドンでログイン実装後に発覚した問題について以下の記事にまとめています。

Mastodon API Ruby Gem インストール時の注意点

omniauth-mastodonをForkしてカスタマイズ

p = Product.new
p.name = "Some Book"
puts p.name # "Some Book"

では、テーブルに存在しない項目はどのようにすればよいか？モデルにVirtual Attributesを定義すれば出来ました。

attr_accessor :some_attribute

これでDBには保持しないけどパラメータとして受け取って何らかの処理を行う事が出来ます。

そもそも今更ながらブログを始めたのは社内技術勉強会で「技術ブログを書くことについて」発表しましたを見たのがきっかけでした。幾つかポイントが書かれていますが「自分のために書く」というのが自分の中で大きかったです。年齢的に40歳を超えてからさすがに以前ほど色々と覚えていられなくなったので書いておいた方が良いと思うようになりました。

とは言え実際に始めてみると何かと気になるもので、特にこれと言った投稿も出来なくて、ググれば他にいくらでも出てきそうな事だったりマニュアルに書いてるだろそれ、みたいな事しか書けないなと勝手にヘコんでますが、何か独自の情報を発信するとなるとハードルが上がってしまうので、あくまでも個人的に備忘録や作業履歴として書いてる事が他の誰かにとっても役に立ったら良いかなぐらいで考えるようにしています。

あとは普段リモートワークをしている事が多いので、近くにいない分、対応した内容をできるだけ丁寧に伝えたいと思ったり、ドキュメントを残しておくとまた別の機会に似たような仕事があった時に参照出来たり、そういったドキュメントを書く練習にもなっています。

そんなブログですが一部の記事が検索で上位に来るらしく多少はアクセスがあったり、顔を合わせる機会の多い同業の方は関心事も似ているのか「調べたいことがあってググったらezaki3のブログが出てきた」とか言ってもらえたりして、そういうのは励みになります。

アクセス数で言えば、先述した自分でこれは独自の情報と思う記事より、他にいくらでもありそう／マニュアルに書いてそう系の記事の方がアクセス数があったりなんかしてます。独自＝他の人が書かない事＝そもそも需要がない、という事なのだと思います。

もう少し特定の言語やフレームワークに話題を絞った方が近頃のネットの使い方としては良いのかもしれませんが、自分自身が古いタイプの何でも屋なのでもうしばらく雑多な感じで様子を見ようと思います。

ブログを書くようになってから、作業をしていてハマった時なんかは逆に「ブログネタゲットだぜ」と思えるようになったのは良かったですw

さくらのクラウドのスタートアップスクリプトで立てたインスタンス（CentOS、non-Docker）です。ソースコードはローカル環境でマージ、確認、プッシュ済みなのでそこの作業は省略します。

パッケージの追加

libicu-dev、libidn11-devが必要になりますがCentOSではパッケージ名が異なります。

$ yum install libicu-devel libidn-devel

ソースコードの最新化

マストドンのプロジェクトルートディレクトリで行います。

$ git pull origin develop

アップデート

gem、yarnで追加されたモジュールをインストールします。

$ bundle install
$ yarn install

Web Push notificationsを有効にするためのkeyを作成します。

$ RAILS_ENV=production bundle exec rake mastodon:webpush:generate_vapid_key

画面上に表示された情報を.env.production に追記します。

DBのmigrate、js等ファイルのビルドを行います。

$ RAILS_ENV=production bundle exec rails db:migrate
$ RAILS_ENV=production bundle exec rails assets:precompile

古いサムネイルを削除します。

$ RAILS_ENV=production bundle exec rails mastodon:maintenance:remove_deprecated_preview_cards

ここまでです。最後にサービスを再起動します。

詳しくはこちらのスライドにて => pngをjpgに変換・保存する in アイマストドン

私がお手伝いしているインスタンスもスマホゲーム利用者向けのインスタンスなので同等の効果が期待できそう、ということで移植させていただきました。

実装

実装内容についてはGitHubで公開しています。

https://github.com/mimumemo/mastodon/pull/3/files

前回に続いて今回はPawooに実装されているおすすめタグ機能（赤枠の部分）を移植しました。

ざっくりと以下の機能があります。

• おすすめタグは管理者権限を持つユーザーがユーザー設定→管理→運営タグで登録／編集／削除ができる
• おすすめタグ一覧取得APIからデータを取得して表示する
• おすすめタグ右側の鉛筆ボタンを押すとトゥート入力欄にタグが入力される

実装

実装内容についてはGitHubで公開しています。

https://github.com/mimumemo/mastodon/pull/2/files

最近マストドンのカスタマイズとかでReactを触るのでこの機会に勉強したく、まずは開発環境を作るところから。

MacでHomebrew、Node.jsはインストール済み。

手順

Yarnのインストール

$ brew install yarn

プロジェクトフォルダ作成

$ mkdir project-name
$ cd project-name

初期化

$ yarn init

入力項目はいったんデフォルトのままで。pakages.jsonが作成されます。

パッケージインストール

$ yarn add react react-dom 
$ yarn add webpack webpack-dev-server babel-loader babel-core babel-preset-react babel-preset-es2015 --dev

ファイル追加・編集

src/app.jsx

import React from 'react';
import ReactDOM from 'react-dom';

ReactDOM.render(
  <h1>Hello, world!</h1>,
  document.getElementById('root')
);

dist/index.html

<!doctype html>
<html>
<head>
  <meta charset="utf-8">
  <title>Hello React</title>
</head>
<body>
  <div id="root"></div>
  <script src="./bundle.js"></script>
</body>
</html>

webpack.config.js

var path = require('path');

module.exports = {
  entry: './src/app.jsx',
  output: {
    path: path.resolve('dist'),
    filename: 'bundle.js'
  },
  devtool: 'inline-source-map',
  module: {
    rules: [
      {
        test: /\.(js|jsx)$/,
        loader: 'babel-loader',
        options: {
          presets: ['es2015', 'react']
        }
      }
    ]
  },
  devServer: {
    contentBase: path.resolve('dist'),
  },
};

packages.json

"scripts": {
  "build": "webpack --progress",
  "start": "webpack-dev-server --inline"
}

を追加。

動作確認

$ yarn start

localhost:8080 で確認できます。jsを編集すると自動でビルドとブラウザのリロードが行われます。

ビルド

$ yarn build

CentOS7 + Rails5 + Nginx + puma + PostgreSQLで本番環境を構築したときの作業履歴とメモ。サーバーはさくらのクラウドです。

初期設定

Rails本番環境とは直接関係ない項目もありますが下準備&最低限必要な設定として行いました。

一般ユーザーの作成&sudo&ssh接続設定（公開鍵認証）

【さくらのVPS】サーバの初期設定ガイド

を参考に設定しました。

yum-cronによるパッケージの自動更新

インストール

# yum -y install yum-cron

設定

# vi /etc/yum/yum-cron.conf

自動更新を有効に設定

apply_updates = yes

サービス起動&自動起動設定

# systemctl start yum-cron
# systemctl enable yum-cron

Firewall設定

httpのポートを開けます。また、作業途中の確認用にポート3000も開けます。

# vi /etc/firewalld/zones/public.xml

<zone>
  …省略
  <service name="http"/>
  <port protocol="tcp" port="3000"/>
</zone>

ポート3000は確認が済んだら削除して閉じます。

設定変更したらサービスを再起動します。

# systemctl restart firewalld

PostgreSQL

インストール

# yum -y install postgresql-server postgresql-devel

初期化処理

# postgresql-setup initdb

サービス起動&自動起動設定

# systemctl start postgresql.service
# systemctl enable postgresql.service

パスワード認証に変更

# vi /var/lib/pgsql/data/pg_hba.conf

local   all             all                                     md5
host    all             all             127.0.0.1/32            md5
host    all             all             ::1/128                 md5

に変更します。

postgresユーザのDB接続パスワード設定

# su - postgres
$ psql -U postgres
postgres=# ALTER USER postgres encrypted password 'パスワード';
postgres=# \q
$ exit

サービス再起動

# systemctl restart postgresql.service

ユーザー作成

# su - postgres
$ createuser -P ユーザー名
パスワード入力

DB作成

作成したユーザーをオーナーとしたDBを作成します。

$ psql -U postgres
postgres=# create database DB名 owner ユーザー名;

rbenv

必要パッケージのインストール

# yum install -y git gcc gcc-c++ openssl-devel readline-devel

インストール

初期設定で作成した一般ユーザーのホームディレクトリで行います。

$ git clone https://github.com/sstephenson/rbenv.git ~/.rbenv

$ echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bash_profile
$ echo 'eval "$(rbenv init -)"' >> ~/.bash_profile
$ source ~/.bash_profile 

$ git clone https://github.com/sstephenson/ruby-build.git ~/.rbenv/plugins/ruby-build

rubyインストール

$ rbenv install 2.4.1
$ rbenv global 2.4.1
$ rbenv rehash

bundlerインストール

$ gem install bundler

Railsアプリのデプロイ

Railsアプリのgitリポジトリがある前提です。

初期設定で作成した一般ユーザーのホームディレクトリで行います。

git clone

$ git clone リポジトリURL
$ cd リポジトリ名

パッケージインストール

$ bundle install --without development test

.envファイル作成

$ vi .env

DB接続情報やその他アプリに必要な情報を設定します。

RAILS_DATABASE_USERNAME="ユーザー名"
RAILS_DATABASE_PASSWORD="パスワード"

DB名やホスト、ポートはconfig/database.yml にデフォルト値として設定しています。

production:
  adapter: postgresql
  encoding: unicode
  database: <%= ENV['RAILS_DATABASE'] || 'DB名' %>
  username: <%= ENV['RAILS_DATABASE_USERNAME'] %>
  password: <%= ENV['RAILS_DATABASE_PASSWORD'] %>
  host: <%= ENV['RAILS_DATABASE_HOST'] || 'localhost' %>
  port: <%= ENV['RAILS_DATABASE_PORT'] || '5432' %>

マイグレーション&アセットプリコンパイル

$ RAILS_ENV=production bundle exec rails db:migrate
$ RAILS_ENV=production bundle exec rails assets:precompile

Railsサーバー起動（手動）

$ SECRET_KEY_BASE=$(rake secret) RAILS_SERVE_STATIC_FILES=true RAILS_ENV=production puma -w 2

ブラウザからサーバー名:3000 に接続できることを確認します。確認できたらCtrl + cでサーバーを停止します。また、Firewall設定でポート3000を閉じます。

途中で

Bundler::GemRequireError: There was an error while trying to load the gem 'uglifier'.

のエラーが出たのでGemfileを編集してtherubyracer を使用するように変更したら解消されました。

gem 'therubyracer', platforms: :ruby

Node.jsがインストールされていない環境で発生するようです。

自動起動設定

# vi /etc/systemd/system/puma.service

[Unit]
Description=Puma HTTP Server
After=network.target

[Service]
Type=simple
User=webstaff
WorkingDirectory=/home/ユーザー名/リポジトリ名
Environment="RAILS_ENV=production"
Environment="RAILS_SERVE_STATIC_FILES=true"
Environment="PORT=3000"
ExecStart=/home/ユーザー名/.rbenv/shims/bundle exec puma -C config/puma.rb
TimeoutSec=15
Restart=always

[Install]
WantedBy=multi-user.target

.envにSECRET_KEY_BASE を追加します。

$ vi /home/ユーザー名/リポジトリ名/.env

値はプロジェクトルートディレクトリで以下のコマンドの実行結果を使います。

$ rake secret

最後にサービス起動と自動起動設定を行います。

# cd /etc/systemd/system
# systemctl start puma.service
# systemctl enable puma.service

Nginx

インストール

# vi /etc/yum.repos.d/nginx.repo

[nginx]
name=nginx repo
baseurl=http://nginx.org/packages/mainline/centos/7/$basearch/
gpgcheck=0
enabled=1

# yum install -y nginx

サービス起動&自動起動設定

# systemctl start nginx
# systemctl enable nginx

ブラウザからサーバー名にアクセスできることを確認します。

所有者変更

Railsアプリのファイルは初期設定で作成した一般ユーザーのホームディレクトリ配下にありますので、nginxがアクセスできるように作成した一般ユーザーで実行されるようにします。

# vi /etc/nginx/nginx.conf

user ユーザー名;

に変更します。また、ログファイルを格納するディレクトリの所有者を変更します。

# chown ユーザー名 /var/log/nginx

logrotateの設定を変更します。

# vi /etc/logrotate.d/nginx

create 640 ユーザー名 adm

リバースプロキシ設定

# vi /etc/nginx/conf.d/サーバー名など任意の名前.conf

server {
    listen 80;
    server_name サーバー名;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header Host $http_host;
    proxy_redirect off;
    proxy_max_temp_file_size 0;
    location / {
        proxy_pass http://localhost:3000;
    }
}

最後にサービスを再起動します。

# systemctl restart nginx

マストドンはオープンソースソフトウェアです。公開されているソースコードを使って自分でマストドンインスタンスを立てるのはもちろん、必要に応じてカスタマイズすることも自由です。また、それぞれのインスタンスでカスタマイズしたソースコードも公開されているので使ってみたい機能を移植することも可能です。

今回はPawooに実装されているお知らせ機能（赤枠の部分）を実装しました。

実装

前置きだけになってしまってアレなのですが、今回実装した内容もGitHubで公開しています。詳しくは↓

https://github.com/mimumemo/mastodon/pull/1/files

例えばアンケートなんかで「興味のある事にチェックしてください（複数可）」のようなフォームがあった場合に、アンケートテーブルと興味のある事テーブルを連携させるやり方について。railsではcollection_check_boxes というヘルパーを使うと簡潔に書くことができます。

モデル

アンケート（Questionnaire）と興味のある事（Hobby）にアソシエーションを設定します。中間テーブルとしてhobby_questionnaires を使用するhas_many :through を指定しています。

# app/models/questionnaire.rb
class Questionnaire < ActiveRecord::Base
  has_many :hobby_questionnaires
  has_many :hobbies, :through => :hobby_questionnaires
end

# app/models/hobby.rb
class Hobby < ActiveRecord::Base
  has_many :hobby_questionnaires
  has_many :questionnaries, :through => :hobby_questionnaires
end

ビュー

# app/views/questionnaries/_form.html.erb
・・・省略
<div class="form-group">
  <%= form.label :hobbies, class: 'col-sm-2 control-label' %>
  <div class="col-sm-10">
    <div class="checkbox">
      <%= collection_check_boxes(:questionnarie, :hobby_ids, Hobby.all, :id, :name) do |b| %>
        <%= b.label { b.check_box + b.text } %>
      <% end %>
    </div>
  </div>
</div>

コントローラー

ストロングパラメーターに指定を追加します。

# app/controllers/questionnaries_controller.rb
class QuestionnariesController < ApplicationController
  ・・・省略
    def post_params
      params.require(:instance).permit(・・・省略, {:hobby_ids => []})
    end
end

マストドンインスタンスを立ててからアップデートをどのタイミングで行うかについて、しばらく様子を見ていたのですが、v1.4系になって色々機能が追加されたのを使いたいということでアップデートすることになりました。

Vagrantなローカル環境で検証した時の作業メモです。

アップデートするのに必要な作業はReleases · tootsuite/mastodonを遡って確認しました。

パッケージの追加

$ sudo apt-get install pkg-config libprotobuf-dev protobuf-compiler -y

Node.jsのアップデート

サポートするNode.jsのバージョンが6以降となったのでアップデートします。

$ sudo npm install n -g
$ sudo n stable
$ sudo ln -sf /usr/local/bin/node /usr/bin/node

v1.4.6をマージ

このインスタンスでは、画像を差し替えるなど本家のソースコードを改変している箇所があります。なので本家のソースコードをマージします。origin はこのインスタンスのリポジトリを登録しているのでupstream に本家のリポジトリを登録します。このインスタンスのブランチはdevelop です。

$ git remote add upstream https://github.com/tootsuite/mastodon.git
$ git checkout -b master origin/master
$ git fetch upstream
$ git merge upstream/master
$ git checkout -b v1.4.6 v1.4.6
$ git checkout develop
$ git merge v1.4.6

ソースコードを改変した箇所でコンフリクトしたので修正します。また、変更内容をorigin にpushして本番環境ではpullします。

アップデート

$ bundle install
$ yarn install
$ bundle exec rails mastodon:maintenance:prepare_for_foreign_keys
$ bundle exec rails db:migrate
$ bundle exec rails assets:precompile
$ bundle exec rails r Rails.cache.clear

本番環境ではbundle exec のところにRAILS_ENV=production が入ります。

サービス起動

作業前にサービスを停止していたので起動します。

$ foreman start

動作確認

動作確認をしたところ、お気に入りが表示されない不具合が発生しました。

本家のissueに同様の不具合が挙がっていて解決法も示されていました。v1.4.6 タグではなくmaster ブランチで作業を行えば解決できるみたいなのでmaster ブランチをマージしてアップデートコマンドをやり直して動作確認できました。

$ bundle install
$ yarn install
$ bundle exec rails db:migrate
$ bundle exec rails assets:precompile

頼まれて立てたマストドンインスタンスのユーザ数が想像してたよりも多く（作業当時2000人ぐらい）、デフォルトの設定だと繋がりにくくなったりしたので対応した内容のまとめです。

インスタンスはさくらのクラウドのスタートアップスクリプト「Mastodon」を使って作成しました。

500エラー対策

混雑時に500エラーが発生してページや画像が表示されない、トゥートやブースト、お気に入りができない、といった現象が発生していました。

nginxのerror_logを見ると

2017/04/24 13:39:48 [crit] 30177#0: accept4() failed (24: Too many open files)

のように Too many open files のエラーが出ていました。

https://blog.be-dama.com/2016/08/31/centos7_nginx_too-many-open-files/

を参考に設定を変更しました。

また、別のエラーで

2017/04/24 21:20:26 [alert] 14304#0: 1024 worker_connections are not enough

というエラーが出ていました。

/etc/nginx/nginx.conf

events {
    worker_connections 2048;
}

1024 => 2048 にしました。

Sidekiqでキューが待機状態であふれる

マストドンではSidekiqを使って非同期処理を実行していますが、混雑時にキューがあふれてしまい、トゥートの反映に時間がかかったりしていました。

/etc/systemd/system/mastodon-sidekiq.service

Environment="DB_POOL=10"
ExecStart=/home/mastodon/.rbenv/shims/bundle exec sidekiq -c 10 -q default -q mailers -q pull -q push

DB_POOL と sidekiq のスレッド数を5 => 10にしました。

画像の保存先をS3に変更

サーバーセットアップ時に40GBの容量を選択して、当初の使用率は10%程度だったのですが、あっという間に50%を超えました。

https://hyper-text.org/archives/2017/04/mastodon-instance-with-amazon-s3.shtml

を参考にS3に変更しました。

会員登録や購入手続きやフォームからの問い合わせ等、何かしらができるWebサイトがあって、複数の外部サイトからリンクされていたとして、どこからの成果なのか判別したい、という要望があります。

外部サイト側でいわゆる広告コードをリンクする際にパラメータとして渡して、それをWebサイト側で保持する、という方法が取られると思います。

その際、外部サイトからリンクされるのはWebサイトのトップページだけとは限らない場合、共通化したいな〜と思いますよね。

LaravelではHTTPミドルウェアという機能を使えばスッキリまとめることができます。

ミドルウェアの定義

artisanコマンドを使ってファイルを生成できます。ファイルはapp/Http/Middleware に生成されます。

$ php artisan make:middleware PrCode

ファイルの中は以下になります。

<?php

namespace App\Http\Middleware;

use Closure;

class PrCode
{
    /**
    * Handle an incoming request.
    *
    * @param  \Illuminate\Http\Request  $request
    * @param  \Closure  $next
    * @return mixed
    */
    public function handle($request, Closure $next)
    {
        $pr_code = 'pr_code';
        if ( ! $request->input($pr_code)) {
            return $next($request);
        }

        $response = $next($request);
        $response->withCookie(cookie($pr_code, $request->input($pr_code), 0));

        return $response;
    }
}

リクエストパラメータにpr_code がないか、あってもfalse とみなされる値の場合は何もせず、それ以外の場合はCookieに値をセットしてリクエストのあった画面に遷移します。

また、今回のミドルウェアをルーティングで使用するためにapp/Http/Kernel.php の$routeMiddleware に追加します。

protected $routeMiddleware = [
    // 省略
    'pr_code' => \App\Http\Middleware\PrCode::class,
];

Cookieの取り出し・削除

成果が発生してCookieの値を取り出したい時は、該当するコントローラーにて

$request->cookie('pr_code');

Cookieの値を削除したい時は

return view('path.to.view')->withCookie(cookie()->forget('pr_code'));

pr_code ってベタに書いてるけど実際にはconfig化してConfig::get() するなどした方がいいと思います。

ルーティング

ミドルウェアの適用範囲をapp/Http/routes.php で設定します。

Route::group(['middleware' => 'pr_code'], function () {
    // ここに書いたルーティングが対象となります
});

スタートアップスクリプト「Mastodon」の更新のお知らせ・旧スクリプトを使用して作成されたインスタンス向けの作業のお願い

スクリプト更新されました。旧スクリプトで作成されたインスタンス向け作業についても案内されています。

はじめに

さくらのクラウドのスタートアップスクリプト「Mastodon」の手順でインスタンスを立てた後に気がついて行った設定について。

ちなみにインスタンスを立てたのは2017年4月20日です。

Nginxのlogrotate

nginxのログがローテートしたタイミングで書き込まれなくなっていました。nginxがmastodonユーザーで実行されているので/var/log/nginx の所有をmastodonユーザーに変更して/etc/logrotate.d/nginx を以下の内容に変更してローテートされるのを確認しました。

# /etc/logrotate.d/nginx
/var/log/nginx/*log {
    create 0644 mastodon nginx
    daily
    rotate 10
    missingok
    ifempty
    compress
    sharedscripts
    postrotate
        /bin/kill -USR1 `cat /run/nginx.pid 2>/dev/null` 2>/dev/null || true
    endscript
}

crontab

http://cryks.hateblo.jp/entry/2017/04/22/005755 http://qiita.com/koteitan/items/fadbe900c88481888917

を参考にrake mastodon:daily を1日2回実行するよう設定しました。mastodonユーザーにてcrontab -e した後、以下の内容で保存。

RAILS_ENV=production
15 3,6 * * * cd /home/mastodon/live && /home/mastodon/.rbenv/shims/bundle exec rake mastodon:daily > /dev/null

今回、郵便番号検索を実装する事になった。データベースには郵便番号データが入っていて、入力された郵便番号を元に都道府県・市区町村名・町域名を取得して入力画面上に表示させたいというもの。都道府県は以下の配列から生成されるドロップダウンとなっているので都道府県名ではなく都道府県コードが欲しいのだけどデータベースには入っていなかった。

[
    1 => '北海道', 
    // 省略
    47 => '沖縄',
]

全国地方公共団体コード（カラム名：jis_code）の先頭2桁が都道府県コードとして使えそうだったので以下のアクセサを作成した。

public function getPrefectureIdAttribute()
{
    return intval(substr($this->jis_code, 0, 2));
}

そしてModelの$appendsプロパティに定義してあげればオッケー。

protected $appends = ['prefecture_id'];

調べてみるとNginxの設定でsendfileというのがあり、それが有効だとカーネルでキャッシュされたデータを送信するということで、これが有効になっていたので無効に設定することでCSSファイルの変更内容が反映された。

# nginx.conf
sendfile off;

ちなみにApacheにも同様の設定があった。

# httpd.conf
EnableSendfile off

LaravelでLaravel Socialiteを使ってSNS認証の実装を試してみたときのメモ。

Facebookアプリの作成については省略。

インストール

$ composer require laravel/socialite

でインストールしようとしたら以下のエラーとなった。

$ composer require laravel/socialite
Using version ^3.0 for laravel/socialite
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Conclusion: remove laravel/framework v5.3.28
    - Conclusion: don't install laravel/framework v5.3.28
    - laravel/socialite v3.0.0 requires illuminate/support ~5.4 -> satisfiable by illuminate/support[v5.4.0, v5.4.9].
    - laravel/socialite v3.0.2 requires illuminate/support ~5.4 -> satisfiable by illuminate/support[v5.4.0, v5.4.9].
    - laravel/socialite v3.0.3 requires illuminate/support ~5.4 -> satisfiable by illuminate/support[v5.4.0, v5.4.9].
    - don't install illuminate/support v5.4.0|don't install laravel/framework v5.3.28
    - don't install illuminate/support v5.4.9|don't install laravel/framework v5.3.28
    - Installation request for laravel/framework (locked at v5.3.28, required as 5.3.*) -> satisfiable by laravel/framework[v5.3.28].
    - Installation request for laravel/socialite ^3.0 -> satisfiable by laravel/socialite[v3.0.0, v3.0.2, v3.0.3].


Installation failed, reverting ./composer.json to its original content.

socialite 3.0.* はlaravel 5.4以上が必要みたいなのでバージョンを指定してインストールした。

$ composer require laravel/socialite "2.0.*"

設定

config/app.php に以下を追加

'providers' => [
    // Other service providers...

    Laravel\Socialite\SocialiteServiceProvider::class,
],

'aliases' => [
    // Other aliases...

    'Socialite' => Laravel\Socialite\Facades\Socialite::class,
],

config/services.php に以下を追加

'facebook' => [
        'client_id'     => env('FACEBOOK_ID'),
        'client_secret' => env('FACEBOOK_SECRET'),
        'redirect'      => env('FACEBOOK_CALLBACKURL'),
    ],

このようにすると実際の値は.env に持たせることができる。

ルーティング

routes/web.php に以下を追加

// routes/web.php
Route::get('auth/{provider}', 'Auth\AuthController@redirectToProvider');
Route::get('auth/{provider}/callback', 'Auth\AuthController@handleProviderCallback');

コントローラー

app/Http/Controllers/Auth/AuthController.php を作成

<?php

namespace App\Http\Controllers\Auth;

use Socialite;
use App\Http\Controllers\Controller;

class AuthController extends Controller
{
    /**
     * Redirect the user to the Provider authentication page.
     *
     * @return Response
     */
    public function redirectToProvider($provider)
    {
        return Socialite::driver($provider)->redirect();
    }

    /**
     * Obtain the user information from Provider.
     *
     * @return Response
     */
    public function handleProviderCallback($provider)
    {
        $user = Socialite::driver($provider)->user();
        dd($user);
    }
}

動作確認

ブラウザから/auth/facebook にアクセスしてFacebookログインできるか確認する。

例えば何かしらのWebサービスで、サービス利用者としてのユーザーとサービス運営者としての管理者のアカウントをそれぞれ別のテーブルで管理して別々で認証させたい、という時の作業内容についてのメモ。

ユーザー認証

Laravelに用意されているスカフォールドを使う。

$ php artisan make:auth
$ php artisan migrate

users テーブルと必要なコントローラー、ビューのファイルが作成される。以下のルーティングが追加される。

$ php artisan route:list
+--------+-----------+------------------------------+----------------------+------------------------------------------------------------------------+--------------+
| Domain | Method    | URI                          | Name                 | Action                                                                 | Middleware   |
+--------+-----------+------------------------------+----------------------+------------------------------------------------------------------------+--------------+
|        | GET|HEAD  | home                         |                      | App\Http\Controllers\HomeController@index                              | web,auth     |
|        | POST      | login                        |                      | App\Http\Controllers\Auth\LoginController@login                        | web,guest    |
|        | GET|HEAD  | login                        | login                | App\Http\Controllers\Auth\LoginController@showLoginForm                | web,guest    |
|        | POST      | logout                       | logout               | App\Http\Controllers\Auth\LoginController@logout                       | web          |
|        | POST      | password/email               |                      | App\Http\Controllers\Auth\ForgotPasswordController@sendResetLinkEmail  | web,guest    |
|        | POST      | password/reset               |                      | App\Http\Controllers\Auth\ResetPasswordController@reset                | web,guest    |
|        | GET|HEAD  | password/reset               |                      | App\Http\Controllers\Auth\ForgotPasswordController@showLinkRequestForm | web,guest    |
|        | GET|HEAD  | password/reset/{token}       |                      | App\Http\Controllers\Auth\ResetPasswordController@showResetForm        | web,guest    |
|        | POST      | register                     |                      | App\Http\Controllers\Auth\RegisterController@register                  | web,guest    |
|        | GET|HEAD  | register                     | register             | App\Http\Controllers\Auth\RegisterController@showRegistrationForm      | web,guest    |
+--------+-----------+------------------------------+----------------------+------------------------------------------------------------------------+--------------+

管理者認証

テーブル

マイグレーションで管理者用のテーブルを作成する。

$ php artisan make:migration create_admin_users_table

今回はusers テーブルの内容を元に作成した。

<?php
// database/migrations/yyyy_mm_dd_*_create_admin_users_table.php
use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class CreateAdminUsersTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('admin_users', function (Blueprint $table) {
            $table->increments('id');
            $table->string('name');
            $table->string('email')->unique();
            $table->string('password');
            $table->rememberToken();
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::drop('admin_users');
    }
}

$ php artisan migrate

admin_users テーブルが作成される。

モデル

App/User.php をコピーしてApp/AdminUser.php を作成する。クラス名以外は特に変更点なし。

設定

config/auth.php を以下のように変更する。

<?php

return [

    'defaults' => [
        'guard' => 'user',
        'passwords' => 'users',
    ],

    'guards' => [
        'user' => [
            'driver' => 'session',
            'provider' => 'users',
        ],

        'api' => [
            'driver' => 'token',
            'provider' => 'users',
        ],

        'admin' => [
            'driver' => 'session',
            'provider' => 'admin_users',
        ],
    ],
    'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model' => App\User::class,
        ],

        'admin_users' => [
            'driver' => 'eloquent',
            'model' => App\AdminUser::class,
        ],
    ],

    'passwords' => [
        'users' => [
            'provider' => 'users',
            'table' => 'password_resets',
            'expire' => 60,
        ],
        'admin_users' => [
            'provider' => 'admin_users',
            'table' => 'password_resets',
            'expire' => 60,
        ],
    ],

];

ルーティング

routes/web.php に以下のルーティングを追加する。

Route::group(['prefix' => 'admin'], function() {
  $this->get('login', 'Admin\Auth\LoginController@showLoginForm');
  $this->post('login', 'Admin\Auth\LoginController@login');
  $this->post('logout', 'Admin\Auth\LoginController@logout');

  Route::get('/home', 'Admin\HomeController@index');
});

コントローラー

app/Http/Controllers/Auth/LoginController.php をapp/Http/Controllers/Admin/Auth/LoginController.php にコピーして以下のように変更する。

<?php

namespace App\Http\Controllers\Admin\Auth;

use App\Http\Controllers\Controller;
use Illuminate\Foundation\Auth\AuthenticatesUsers;
use Illuminate\Support\Facades\Auth;

class LoginController extends Controller
{
    /*
    |--------------------------------------------------------------------------
    | Login Controller
    |--------------------------------------------------------------------------
    |
    | This controller handles authenticating users for the application and
    | redirecting them to your home screen. The controller uses a trait
    | to conveniently provide its functionality to your applications.
    |
    */

    use AuthenticatesUsers;

    /**
     * Where to redirect users after login.
     *
     * @var string
     */
    protected $redirectTo = '/admin/home';

    /**
     * Create a new controller instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->middleware('guest', ['except' => 'logout']);
    }

    /**
     * Show the application's login form.
     *
     * @return \Illuminate\Http\Response
     */
    public function showLoginForm()
    {
        return view('admin.auth.login');
    }

    /**
     * Get the guard to be used during authentication.
     *
     * @return \Illuminate\Contracts\Auth\StatefulGuard
     */
    protected function guard()
    {
        return Auth::guard('admin');
    }
}

app/Http/Controllers/HomeController.php をapp/Http/Controllers/Admin/HomeController.php にコピーして以下のように変更する。

<?php

namespace App\Http\Controllers\Admin;

use App\Http\Controllers\Controller;
use Illuminate\Http\Request;

class HomeController extends Controller
{
    /**
     * Create a new controller instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->middleware('auth:admin');
    }

    /**
     * Show the application dashboard.
     *
     * @return \Illuminate\Http\Response
     */
    public function index()
    {
        return view('admin.home');
    }
}

ビュー

resources/views/auth/login.blade.php をresources/views/admin/auth/login.blade.php にコピーして以下の箇所を変更する。

<form class="form-horizontal" role="form" method="POST" action="{{ url('/admin/login') }}">

resources/views/home.blade.php をresources/views/admin/home.blade.php にコピーする。

その他

app/Exceptions/Handler.php のunauthenticated() を以下のように変更する。

protected function unauthenticated($request, AuthenticationException $exception)
{
    if ($request->expectsJson()) {
        return response()->json(['error' => 'Unauthenticated.'], 401);
    }

    if (in_array('admin', $exception->guards())) {
        return redirect()->guest('admin/login');
    }

    return redirect()->guest('login');
}

確認

ユーザーはブラウザから/register にアクセスして登録する。管理者の登録画面は今回用意していないので別途作成する。

ユーザーは/login からログインすると/home に遷移する。未ログイン状態で/home にアクセスすると/login にリダイレクトする。

管理者は/admin/login からログインすると/admin/home に遷移する。未ログイン状態で/admin/home にアクセスすると/admin/login にリダイレクトする。

ユーザーは管理者のログイン画面からはログインできず、管理者もユーザーのログイン画面からはログインできない。

前回の実装のテストを書いたのでメモ。LaravelではアプリケーションにHTTPリクエストを送信し、出力内容をチェックしたりフォームに入力したりリンクやボタンをクリックするようなテストを書くことができる。

データベース設定

.env.testing にテスト用データベースの接続設定を書く。

モデルファクトリーの追加

テストを実行する際にあらかじめデータを入れておきたい場合の便利な機能。database/factories/ModelFactory.php に設定を追加する。

$factory->define(App\Sample::class, function (Faker\Generator $faker) {
    return [
        'name' => $faker->name,
        'email' => $faker->unique()->safeEmail,
    ];
});

テストから以下のように使用する。

$sample = factory(App\Sample::class)->create();
$samples = factory(App\Sample::class, 3)->create(); // 件数を指定して複数生成する
$sample = factory(App\Sample::class)->make(); // DBに保存しない

テストファイルの生成と実行

テストファイルの作成

$ php artisan make:test SampleTest

実行

$ ./vendor/bin/phpunit

テスト後のデータベースリセット

テスト後にデータが残ったままだと色々影響があるのでリセットしたい、というのをLaravelでは用意されているトレイトを使用するだけでできる。

use DatabaseMigrations; // マイグレーションを使用する
use DatabaseTransactions; // トランザクションを使用する

今回はマイグレーションを使ってないのでuse DatabaseTransactions; を使用した。

テスト

一覧表示

public function testIndex()
{
    $samples = factory(App\Sample::class, 2)->create(); // テストデータ2件作成

    $this->visit('sample') // 一覧画面にアクセス
        ->see('Sample') // 画面に `Sample` が表示されている
        ->see($samples[0]->name)->see($samples[0]->email) // テストデータ1件目が表示されている
        ->see($samples[1]->name)->see($samples[1]->email) // テストデータ2件目が表示されている
        ->type($samples[0]->name,'name') // 検索フォームの名前欄にテストデータ1件目の名前を入力
        ->press('検索') // 検索ボタンを押す
        ->see($samples[0]->name) // テストデータ1件目が表示されている
        ->dontSee($samples[1]->name); // テストデータ2件目は表示されない
}

新規作成(バリデーションエラー)

public function testCreateNG()
{
    $this->visit('sample/create')
        ->type('','name')
        ->type('','email')
        ->press('作成')
        ->see('nameは必須です。')
        ->see('emailは必須です。');
}

新規作成(成功)

public function testCreateOK()
{
    $this->visit('sample/create')
        ->type('hoge','name')
        ->type('hoge@hoge.com','email')
        ->press('作成')
        ->seePageIs('/sample') // 一覧画面に遷移した
        ->see('hoge')
        ->see('hoge@hoge.com');
}

詳細画面

public function testShow()
{
    $sample = factory(App\Sample::class)->create();

    $this->visit('sample')
        ->click($sample->name) // 一覧画面の名前をクリックすると詳細画面に遷移する
        ->seeRouteIs('sample.show', ['sample' => $sample->id]) // ルーティングから遷移先の妥当性を検証
        ->see($sample->name);
}

編集

public function testEditOK()
{
    $sample = factory(App\Sample::class)->create();
    $new_name = 'new_name';

    $this->visit('sample')
        ->see($sample->name)
        ->click('編集')
        ->seeRouteIs('sample.edit', ['sample' => $sample->id])
        ->type($new_name,'name')
        ->press('編集')
        ->seePageIs('/sample')
        ->see($new_name) // 編集後の名前が表示されている
        ->dontSee($sample->name); // 編集前の名前は表示されていない
}

削除

public function testDeleteOK()
{
    $sample = factory(App\Sample::class)->create();

    $this->visit('sample')
        ->see($sample->name)
        ->press('削除')
        ->seePageIs('/sample')
        ->dontSee($sample->name);
}

補足

今回は画面に表示されているかどうかでデータが登録されていることを確認したけど、

$this->seeInDatabase('samples', [
    'email' => 'hoge@example.com'
]);

とすればデータベースを直接参照することもできる。

プロジェクトのメンバーに変更した内容を取り込んで

> vagrant provision

してもらったが上手くいかないということでログを見せてもらうと

ERROR! no action detected in task. This often indicates a misspelled module name
, or incorrect module path.

The error appears to have been in '/vagrant/provision/playbook.yml': line 16, column 7, 
but maybe elsewhere in the file depending on the exact syntax problem.

のようなエラーが。手元の環境では動いているのでファイルが壊れているのかな？と思い見せてもらったけど特に問題なさそう。

調べた結果、今回追加した設定が当該メンバーの仮想環境にインストールされているansibleのバージョンが古くて対応していなかったので、Vagrantfileに

config.vm.provision "ansible_local" do |ansible|
  ・・・省略
  ansible.version = "latest"
end

を追加して新しいバージョンのansibleがあればアップデートするようにして解決した。

Autodocとは、rspecを実行した時にドキュメントを生成してくれるツール。

GitHubのWikiを使って画面項目やアクション、使用しているAPIについて簡単にまとめたドキュメントを作成しているプロジェクトがある。最初はAutodocで生成したドキュメントをコピペでWikiの該当箇所に貼り付けていたんだけど、さすがにメンテナンス性が悪すぎるので、Autodocのドキュメントを丸ごとWikiのリポジトリに追加してWiki内でリンクを貼って参照できるようにしようとしたところ以下のような問題が発生した。

現象

Wikiのリポジトリで

/doc/api/v1/hoge/self.md
/doc/api/v1/huga/self.md

このようなフォルダ構成にしてもGitHubのWiki画面では認識されずhttps://github.com/user-name/project-name/wiki/self となってしまってどちらか片方しか参照できない。

対策

Autodocで以下の設定を追加した。

# spec/support/autodoc.rb
Autodoc.configuration.document_path_from_example = -> (example) do
  example.file_path.gsub(%r<\./spec/[^/]+/(.+)_spec\.rb>, '\1.md').gsub(%r</>, '-')
end

こうすることで

api-v1-hoge-self.md
api-v1-huga-self.md

となりGitHubのWiki画面でそれぞれ参照できるようになった。

Route::resource('sample', 'SampleController');

というルーティングが前提。

バリデーションのuniqueで指定したIDを除外したい場合Rule クラスのignore メソッドにIDを指定する。コントローラーにバリデーションを記述するのであれば

// app/Http/Controllers/SampleController.php
public function update(Request $request, $id)
{
    $this->validate($request, [
        'name' => 'required|max:255',
        'email' => [
            'required',
            'max:255',
            'email',
            Rule::unique('samples')->ignore($id),
        ],
    ]);

    // update処理
}

のように$id を受け取っているのでそれを指定すればいいけど、フォームリクエストに書くときはどうすればいいのか？結論は

// app/Http/Requests/SampleRequest.php
public function rules()
{
    return [
        'name' => 'required|max:255',
        'email' => [
            'required',
            'max:255',
            'email',
            Rule::unique('samples')->ignore($this->sample),
        ],
    ];
}

だったんだけど$this->sample というのはなんぞ？と思って調べてみた。

FormRequest クラスの継承元であるRequest クラスにあるマジックメソッドにて

// vendor/laravel/framework/src/Illuminate/Http/Request.php
/**
 * Get an input element from the request.
 *
 * @param  string  $key
 * @return mixed
 */
public function __get($key)
{
    if ($this->offsetExists($key)) {
        return $this->offsetGet($key);
    }

    return $this->route($key);
}

となっていてinputパラメータに該当するものがあればその値を、なければroute メソッドにて

// vendor/laravel/framework/src/Illuminate/Http/Request.php
/**
 * Get the route handling the request.
 *
 * @param string|null $param
 *
 * @return \Illuminate\Routing\Route|object|string
 */
public function route($param = null)
{
    $route = call_user_func($this->getRouteResolver());

    if (is_null($route) || is_null($param)) {
        return $route;
    } else {
        return $route->parameter($param);
    }
}

ルートパラメータから該当するものを取得するのがわかった。

Laravelの使い方を勉強するため、単一のテーブルに対するCRUDを実装したときのメモ。

インストール

Composerが必要なのでインストールしておく。Laravelはターミナルからcomposerコマンドでインストールする。

$ composer create-project --prefer-dist laravel/laravel sample

sampleというフォルダが作成される。sampleフォルダにて、

$ php artisan serve

とするとビルトインサーバーが起動してhttp://localhost:8000 でアクセスできる。

設定

config/app.php にtimezoneとlocaleを設定。

// config/app.php
'timezone' => 'Asia/Tokyo',
'locale' => 'ja',

.env にDB接続情報を設定。

ルーティング

routes/web.php にて設定を行う。様々な記述が可能だけど今回はCRUDを実装したかったので、

Route::resource('sample', 'SampleController');

とした。こうすることで以下のルーティングに対応してくれる。

ちなみに、

$ php artisan route:list

で設定されているルーティングを一覧表示することができる。

マイグレーション

今回は別のサンプルで使用したテーブルを使いまわしたのでマイグレーションは使用しない。

テンプレート

ヘッダー／フッターなどの共通部分レイアウトのファイルをresources/views/layouts/master.blade.php に作成した。

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>@yield('title')</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link type="text/css" rel="stylesheet" href="/css/bootstrap.min.css">
    <script src="//ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js"></script>
</head>
<body>
    <!-- 共通部分 -->
    <div class="container">
        @yield('content')
    </div>
    <!-- 共通部分 -->
    <script src="/js/bootstrap.min.js">
</body>
</html>

レイアウトに基づいた各ページは

@extends('layouts.master')

@section('title', 'Sample')

@section('content')
    <!-- ページ内容 -->
@endsection

となる。

コントローラー

artisanコマンドを使えばファイルを生成してくれる。

$ php artisan make:controller SampleController --resource

--resouces オプションで前述したルーティング設定に基づいたメソッドが作成される。

モデル

こちらもartisanコマンドで生成される。

$ php artisan make:model Sample

// app/Sample.php
<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Sample extends Model
{
    protected $guarded = [];
}

protected $guarded = []; を追加した。後述する新規作成で使用するcreate メソッドで必須となるパラメータで、指定したプロパティはcreateの対象としない（空の配列だと指定なしとなり全プロパティが対象となる）。

一覧表示

検索フォーム

//　resources/views/sample/index.blade.php
<form method="get" action="{{ url('sample') }}" class="form-inline" role="form">
    <div class="form-group">
        <label class="sr-only" for="name">名前</label>
        <input type="text" name="name" value="{{ request('name') }}" id="name" class="form-control" placeholder="名前">
    </div>
    <div class="form-group">
        <label class="sr-only" for="email">メールアドレス</label>
        <input type="text" name="email" value="{{ request('email') }}" id="email" class="form-control" placeholder="メールアドレス">
    </div>
    <input type="submit" name="btn" value="検索" class="btn">
</form>

波括弧で括られた箇所が動的に生成される。それぞれヘルパー関数を使用している。埋め込まれている箇所と関数名から大体想像がつくと思うので説明は省略する。

一覧表示

// resources/views/sample/index.blade.php
@if (count($results) > 0)
    <table class="table table-striped table-bordered table-condensed">
        <thead>
            <tr>
                <th>ID</th>
                <th>名前</th>
                <th>メールアドレス</th>
                <th>編集</th>
                <th>削除</th>
            </tr>
        </thead>
        <tbody>
            @foreach ($results as $result)
                <tr>
                    <td>{{ $result->id }}</td>
                    <td><a href="{{ route('sample.show', [$result->id]) }}">{{ $result->name }}</a></td>
                    <td>{{ $result->email }}</td>
                    <td><a href="{{ route('sample.edit', [$result->id]) }}" class="btn btn-default">編集</a></td>
                    <td>
                        <form method="post" action="{{ route('sample.destroy', [$result->id]) }}" style="display:inline;">
                            {!! csrf_field() !!}
                            {{ method_field('DELETE') }}
                            <button type="submit" class="btn btn-danger" onclick="return confirm('削除します。よろしいですか？')">削除</button>
                        </form>
                    </td>
                </tr>
            @endforeach
        </tbody>
    </table>
    {{ $results->links() }}
@else
    <p>登録されているデータはありません。</p>
@endif

Bladeテンプレートの制御構文@if や@foreach で条件による出し分けやループの処理を行う。

削除処理では{{ method_field('DELETE') }} でDELETEメソッドとして扱うことができるようになる。また、{!! csrf_field() !!} でCSRFトークンが埋め込まれる。

{{ $results->links() }} にはページネーションで生成されたページング表示が埋め込まれる。

結果表示

// resources/views/sample/index.blade.php
@if (session('success'))
    <div class="alert alert-success">
        <button class="close" data-dismiss="alert">&times;</button>
        {{ session('success') }}
    </div>
@endif
@if (session('error'))
    <div class="alert alert-error">
        <button class="close" data-dismiss="alert">&times;</button>
        {{ session('error') }}
    </div>
@endif

新規作成／編集／削除時、実行結果をセッションのフラッシュデータに保持して一覧画面へリダイレクトしてくるので、その表示用。

コントローラー

// app/Http/Controllers/SampleController.php
public function index(Request $request)
{
    $sample = Sample::query();

    if ($request->input('name')) {
        $sample->where('name', 'like', '%'.$request->input('name').'%');
    }

    if ($request->input('email')) {
        $sample->where('email', 'like', '%'.$request->input('email').'%');
    }

    $results = $sample->orderBy('id', 'desc')->paginate(20);

    return view('sample.index', ['results' => $results]);
}

こちらも大体見て想像がつくと思うので説明は省略する。使用するクラスはuse で宣言する必要がある。

新規作成

入力フォーム

// resources/views/sample/create.blade.php
<form method="post" action="{{ url('sample') }}">
    {!! csrf_field() !!}
    <div class="form-group">
        <label for="name" class="col-sm-2 control-label">名前*</label>
        <div class="col-sm-10">
            <input type="text" name="name" id="name" class="form-control" value="{{ old('name') }}">
        </div>
    </div>
    <div class="form-group">
        <label for="email" class="col-sm-2 control-label">メールアドレス*</label>
        <div class="col-sm-10">
            <input type="text" name="email" id="email" class="form-control" value="{{ old('email') }}">
        </div>
    </div>
    <div class="form-group">
        <div class="col-sm-offset-2 col-sm-10">
            <input type="submit" value="作成" class="btn">
        </div>
    </div>
</form>

ヘルパー関数のold でセッションのフラッシュデータとして保持されている入力値を埋め込んでいる。

入力エラー表示

// resources/views/sample/create.blade.php
@if (count($errors) > 0)
    <div class="alert alert-danger">
        <a class="close" data-dismiss="alert">&times;</a>
        @foreach ($errors->all() as $error)
            {{ $error }}<br>
        @endforeach
    </div>
@endif

あまり実践的ではない書き方（入力項目の下に個別に表示するのが望ましい）ですいません。

バリデーション

バリデーションはフォームリクエストとして別ファイルに書くことができる。artisanコマンドを使えばファイルを生成することができる。

$ php artisan make:request SampleRequest

authorize rules というメソッドが用意されていて

// app/Http/Request/SampleRequest.php
public function authorize()
{
    return true;
}

authorizeにはリクエストに対する認証が設定できる。今回は何もしないのでtrue を返すだけ。

// app/Http/Request/SampleRequest.php
public function rules()
{
    return [
        'name' => 'required|max:255',
        'email' => [
            'required',
            'max:255',
            'email',
            Rule::unique('samples')->ignore($this->sample),
        ],
    ];
}

rulesにバリデーションルールを設定する。Rule::unique('samples')->ignore($this->sample), がemailが一意かどうかをチェックして、編集時には自分のIDを除外する、といった指定になる。この指定の仕方がググっても情報がマチマチだったので別記事にまとめておきたい。

この設定を入れておけば入力エラー時にエラー内容を持って元の画面へリダイレクトしてくれる。

日本語版バリデーションメッセージはこちらを使わせていただきました。

https://gist.github.com/syokunin/b37725686b5baf09255b

resources/lang/ja/validation.php に設置。

コントローラー

// app/Http/Controllers/SampleController.php
public function create()
{
    return view('sample.create');
}

public function store(SampleRequest $request)
{
    if ($sample = Sample::create($request->only(['name', 'email']))) {
        $request->session()->flash('success', '作成しました。');
    } else {
        $request->session()->flash('error', '作成に失敗しました。');
    }

    return redirect('sample');
}

SampleRequest $request でフォームリクエストを指定している。

詳細表示

詳細表示

// resources/views/sample/show.blade.php
<table class="table table-striped table-bordered table-condensed">
    <tbody>
        <tr>
            <th>名前</th>
            <td>{{ $result->name }}</td>
        </tr>
        <tr>
            <th>メールアドレス</th>
            <td>{{ $result->email }}</td>
        </tr>
    </tbody>
</table>

サンプルにつき、詳細といいながら一覧と同じ項目しか出力できていない。

コントローラー

// app/Http/Controllers/SampleController.php
public function show($id)
{
    return view('sample.show', ['result' => Sample::findOrFail($id)]);
}

Sample::findOrFail($id) は指定IDのデータが見つからなかった場合は404を返す。

編集

入力フォーム

// resources/views/sample/edit.blade.php
<form method="post" action="{{ route('sample.update', [$result->id]) }}">
    {!! csrf_field() !!}
    {{ method_field('PUT') }}
    <div class="form-group">
        <label for="name" class="col-sm-2 control-label">名前*</label>
        <div class="col-sm-10">
            <input type="text" name="name" id="name" class="form-control" value="{{ old('name', $result->name) }}">
        </div>
    </div>
    <div class="form-group">
        <label for="email" class="col-sm-2 control-label">メールアドレス*</label>
        <div class="col-sm-10">
            <input type="text" name="email" id="email" class="form-control" value="{{ old('email', $result->email) }}">
        </div>
    </div>
    <div class="form-group">
        <div class="col-sm-offset-2 col-sm-10">
            <input type="submit" value="編集" class="btn">
        </div>
    </div>
</form>

{{ method_field('PUT') }} でPUTメソッドとして扱うことができるようにしている。また、old の第２引数にDBから取得した値を初期値として設定している。

コントローラー

// app/Http/Controllers/SampleController.php
public function edit($id)
{
    return view('sample.edit', ['result' => Sample::findOrFail($id)]);
}

public function update(SampleRequest $request, $id)
{
    $sample = Sample::findOrFail($id);

    $sample->name = $request->input('name');
    $sample->email = $request->input('email');

    if ($sample->save()) {
        $request->session()->flash('success', '編集しました。');
    } else {
        $request->session()->flash('error', '編集に失敗しました。');
    }

    return redirect('sample');
}

バリデーションは新規作成と同様。

削除

削除フォーム

一覧画面を参照。

コントローラー

// app/Http/Controllers/SampleController.php
public function destroy(Request $request, $id)
{
    $sample = Sample::findOrFail($id);

    if ($sample->delete()) {
        $request->session()->flash('success', '削除しました。');
    } else {
        $request->session()->flash('error', '削除に失敗しました。');
    }

    return redirect('sample');
}

説明は省略。

テスト

テストはまた別記事にまとめたい。 => 書いた。

自家用ノートをMacBook Air 11→MacBook Air 13へ買い替えた。移行については移行アシスタントを使えば簡単に移行できるんだけど、SSDを換装するなどしてかれこれ5年ほど使ってて、今となっては不要なアプリケーションとか設定とかが盛りだくさんだったので手動で移行する事にした。今使っている最小限のアプリケーションやデータ、設定を移行させるための作業内容メモ。

ソフトウェアのインストール

App Store からインストール

• One Drive
• Cot Editor
• Slack
• Xcode

Web からインストール

• Firefox
• Chrome
• Microsoft Office
• Atom
  • sync-settings で同期
• Cyberduck
• Android Studio
• MAMP
• Insomnia REST Client
• Homebrew
  • rbenv, ruby-build
    • ruby2.2.4
  • nodebrew
    • node7.2.0(latest)
  • imagemagick

ファイルの同期

• One Drive で主なデータを同期
• rssキーはUSBメモリで移行
• MySQL(MAMP)のデータはアクティブなプロジェクトのものをエクスポート→インポート

設定

• Macで隠しファイルを表示する方法
• gitのデフォルトユーザー名とメールアドレスを設定
• MAMPを使用しているプロジェクトはDocumentRootにシンボリックリンクを貼ったりVirtualHostの設定(hostsも設定)をする
• MAMPのPHPにパスを通す
• iOS 証明書をキーチェーンに追加

その他

• gitリポジトリのファイルについて、One Driveで同期したからかファイルのパーミッションが違っていて変更された扱いになっていたのでcheckoutで元に戻した
• 古い方のMacはMac を売却または譲渡する前にを参考に

Query Builderを使う場合、Query_Builder_Select::compile()を使うとサブクエリのSQLを文字列にすることが出来る。

上記URLの例をQuery Builderで作成するとこのような感じ。サブクエリのSQL文字列がクオートやバッククオートで囲まれないようにDB::expr()してあげる。

$sub_query = DB::select('author')
    ->from('articles')
    ->where('date', '<', time())
    ->where('draft', '=', 1)
    ->compile(Database_Connection::instance());

$query = DB::select()
    ->from('articles')
    ->where('author', '=', 16)
    ->or_where('author', DB::expr($sub_query));

$query->execute();

リモートワークをしててよく聞かれる事の続き。フリーランスのWebエンジニアとしてリモートワークをしててよく聞かれることについてのまとめ。

オン／オフの切り替え

作業場所として自宅を使う場合、自宅というのは元々生活するスペースなのでそこでどうやってオン／オフを切り替えているのか？というのもよく聞かれる。

理想的なのは仕事部屋として仕事以外のことはしない空間を用意することかもしれない。それは無理でも例えば作業机を用意してそこに向かっている間は仕事モードに切り替える等、自分なりのスイッチを持つことが大事だと思う。

仕事を始める時と同じように終わる時も切り替えないと、いつまでも仕事のことが気になってリラックス出来なかったり、ズルズルと仕事をしてしまうことになりかねない。自分の場合はテレビをつけたり晩御飯を自炊したりして切り替えている。

以下はリモートワークとは直接関係ないけどフリーランスをやっているとよくある質問なのでまとめておく。

仕事はどうやって取ってくるの？

会社員をしていると役割によっては仕事を取ってくるということにノータッチで、さらにWebエンジニアにとって営業的な活動は不慣れな人が多いからか、この事についてもよく聞かれる。営業って言っても知らない会社にいきなり電話したりとかしているわけではなく、知り合いだったり、知り合いからの紹介だったりが大半で、特に自分の場合はスケールさせたいと考えている方でもないのでその程度にしている。

近頃はフリーランス向けの案件紹介をしている会社もあるのでそういうのを利用することも出来るし、わりと蓋を開けてみればなんとかなるものだと思う。

ぶっちゃけ儲かるの？

多分フリーランスのイメージとしてバリバリやっている感があるのか、稼いでいると思っている人は多いのではないかと思う。フリーランス＝儲かるというわけではないけど、たくさん稼ぎたいとした時に自分でどうしたら良いのか考えて行動することが出来るという点において、自由度が高いのではないかと思う。

会社員であれば歩合制でもなければ何かをしたらそれが即給料に反映されるということはないけど、フリーランスであればより条件の良い案件を受けたり、数を増やしたりあの手この手を講じることが出来る。

反対に儲けることに主眼を置かない働き方も検討することが出来る。一定期間がっつり働いたら長期休暇を取るとか、稼働時間を少なめにして自由な時間を増やすとかも出来なくはない。

最後に

2回に渡ってアレコレまとめてみた。働き方が多様化していく中での1つの選択肢としてフリーランスもこれからどんどん増えていくのだろうと思う一方で、まだまだ回りからは物珍しく見られることもあるので、またこれをネタに何か書いてみようと思う。

• 通信中にローディング画面を表示させたい
• 認証エラーの時にログイン画面に遷移させたい

このような時は$httpProviderのinterceptorsプロパティを使う。

var app = angular.module('myApp', []);

app.config(['$httpProvider', function($httpProvider) {
  $httpProvider.interceptors.push(['$q', function ($q) {
    return {
      request: function(config) {
        // do something on success
        return config;
      },
      requestError: function(rejection) {
        // do something on error
        return $q.reject(rejection);
      },
      response: function(response) {
        // do something on success
        return response;
      },
      responseError: function(rejection) {
        // do something on error
        return $q.reject(rejection);
      }
    };
  }]);
}]);

自分はフリーランスのWebエンジニアとして8年近く仕事をしていて、大半は自宅で作業をしている。最近はリモートワークも広まりつつあるような気がするけれども、周りの人からどういう風にしているのか聞かれる事は多い。なのでリモートワークで気をつけている事など、どのように自宅で作業しているのか自分なりにまとめてみる。

リモート向きの仕事内容

周りの人と話してて一番多いのが「私は自宅で仕事するのはちょっと無理ですね」ていうパターン。それには後述するいくつかの要因があるけど、まずは1人で仕事するのに抵抗があるというのが大きいと思われる。

自分の場合はフリーランスになる前から1人でこなす仕事が多かったので作業場所が会社でも自宅でも大差ないので違和感無く出来たと思う。あと静かな環境の方が集中できるので、そういう意味で自宅は自分の中でもっとも静かな環境だ。

個人的な向き不向きやリモートで仕事したい／したくないはあると思うけど、それは抜きにして仕事内容が以下のいずれかに当てはまるのであればリモートでも可能だと言える。

• やることに関してある程度任されている
• 役割分担や作業内容が明確になっている

反対に、

• 任されている部分が少なく独断で動きにくい
• 作業内容に不明な点が多く都度確認が必要

のような場合はリモートよりも集まって仕事した方がいいと思う。

サボったりしない？

これもよくある質問シリーズ。人に見られていない&自宅は家事や趣味など仕事以外に出来ることがあり、サボろうと思えばサボれる状況である。自分も実際のところ全くサボってないとは言えない。

だけどそれに対して監視するとか、稼働している事を証明するとかいうよりは、やらないといけない事に対して出来ているかどうかについての判断だったり、いつまでに何をやればいいのか合意が取れているかどうかの方が大事だと思う。それができていれば後の時間をどう使うかは自由なはずだ。

生活のリズム

朝◯時出社みたいな制約が無いと休日のように夜更かしして次の日も遅くに目が覚めたり、下手をすると昼夜逆転の生活に…なんてことも心配する人もいると思う。

自分の場合はそもそも夜型ではないので問題ないんだけど、それでも出来るだけ規則正しい生活をするよう心がけている。それはそういう当たり前の事を当たり前にするというのが心挫けそうな時（主に仕事が無くて）に支えになると思っているからだ。

最後に

他にもいくつかあるけど、今回はこのあたりで。

こうやって書いてみると、ここに書いてあるような心配事は会社勤めをしていれば無い訳で、改めて会社で働くというシステムはよく出来ているのだなぁと思うのであった。でもそこを乗り越えれば時間は比較的自由がきくし、色々自分で試行錯誤する楽しみのようなものもあるかと思う。例えるならトレーニングをするにあたって、ジムに行く事も出来るし自宅でも出来る。どちらが優れているとかではなくどちらも選べるようになっているというのが大事なのだと思う。

使用したモジュール

https://github.com/nonplus/angular-ui-router-title

READMEに使い方書いてあるけど簡単に説明すると

bower install angular-ui-router-title

でインストールするか、ダウンロードしたファイルを任意の場所に設置。

<script src="bower_components/angular-ui-router-title/angular-ui-router-title.js"></script>

をhtmlに追加。ダウンロードした場合はパスを適宜置き換える。

var app = angular.module('myApp', ['ng', 'ui.router.title']);

でui.router.titleモジュールを読み込む。

<html ng-app>
<head>
  <title ng-bind="($title || 'Home') + ' - My Application'">My Application</title>
</head>
...

タイトルの埋込例。$titleが設定されていればその内容が、無ければHomeが表示されて、その後に - My Application と続く。

$titleはUI Routerの$stateProvider.state(name, stateConfig)のstateConfigオブジェクトのresolveプロパティで設定する。

app.config(['$stateProvider', function ($stateProvider) {
  $stateProvider
    .state('home', {
      ...
      resolve: {
        // 固定値
        $title: function() { return 'Home'; }
      }
    })
    .state('contacts', {
      url: '/contacts',
      ...
      resolve: {
        // コンタクトリスト
        contacts: ['Contacts', function(Contacts) {
          // APIからリストを取得
          return Contacts.query();
        }],
        // リストの件数を動的に設定
        $title: ['contacts', function(contacts) {
          return 'Contacts (' + contacts.length + ')';
        }]
      }
    })
    .state('contact', {
      url: '/contact/:contactId',
      ...
      resolve: {
        // コンタクト1件取得
        contact: ['Contacts', '$stateParams', function(Contacts, $stateParams) {
          // APIから1件取得
          return Contacts.get({ id: $stateParams.contactId });
        }],
        // contact.nameを動的に設定
        $title: ['contact', function(contact) {
          return contact.name;
        }]
      }
    })
}]);

他にパンくずリストの機能もあるので必要に応じて使ってみるといいかも。

C:\Path\to\project>vagrant up
Bringing machine 'default' up with 'virtualbox' provider...
==> default: Checking if box 'ubuntu/trusty64' is up to date...
==> default: A newer version of the box 'ubuntu/trusty64' is available! You currently
==> default: have version '20160816.0.0'. The latest is version '20160919.0.0'. Run
==> default: `vagrant box update` to update.
==> default: Clearing any previously set forwarded ports...
==> default: Clearing any previously set network interfaces...
==> default: Preparing network interfaces based on configuration...
    default: Adapter 1: nat
    default: Adapter 2: hostonly
==> default: Forwarding ports...
    default: 3000 (guest) => 3000 (host) (adapter 1)
    default: 22 (guest) => 2222 (host) (adapter 1)
==> default: Running 'pre-boot' VM customizations...
==> default: Booting VM...
==> default: Waiting for machine to boot. This may take a few minutes...
    default: SSH address: 127.0.0.1:2222
    default: SSH username: vagrant
    default: SSH auth method: private key
==> default: Machine booted and ready!
==> default: Checking for guest additions in VM...
    default: The guest additions on this VM do not match the installed version of
    default: VirtualBox! In most cases this is fine, but in rare cases it can
    default: prevent things such as shared folders from working properly. If you see
    default: shared folder errors, please make sure the guest additions within the
    default: virtual machine match the version of VirtualBox you have installed on
    default: your host and reload your VM.
    default:
    default: Guest Additions Version: 4.3.36
    default: VirtualBox Version: 5.1
==> default: Configuring and enabling network interfaces...
The following SSH command responded with a non-zero exit status.
Vagrant assumes that this means the command failed!

/sbin/ip -o -0 addr | grep -v LOOPBACK | awk '{print $2}' | sed 's/://'

Stdout from the command:



Stderr from the command:

/usr/bin/env: bash: No such file or directory
/etc/profile.d/rbenv.sh: line 2: $'\r': command not found
stdin: is not a tty
bash: line 2: sed: command not found
bash: line 2: grep: command not found

こんな感じでPATH設定がおかしくなっていてGeustAdditionsを取得&ビルドする所でコケている模様。ansibleでrbenvをインストールする際に

- name: add rbenv path to bash_profile
  copy: src=files/rbenv.sh dest=/etc/profile.d/rbenv.sh

としてPATHを追加しているが該当ファイルの記述には問題なく、また別のwindows環境では再現しなかった。

/etc/profile.d/rbenv.sh: line 2: $'\r': command not found

の \r ってのが気になって調べてみたら、windows環境のgitで改行コードの自動変換が設定されていてansibleコピー元のシェルスクリプトの改行コードがCRLFに変換されていたのが原因だった。

> git config --global core.autoCRLF false

で改行コードの自動変換を無効に設定した後、開発環境のリポジトリをクローンし直して作業してもらって解決した。