DEV Community: Yuta Goto

Rubyでディレクトリ操作をする

Yuta Goto — Wed, 13 Dec 2023 15:01:00 +0000

rubyのバージョン3.2での情報です。

カレントディレクトリのパスを変更

Dir.chdir("/var/log")

現在のディレクトリを取得

Dir.chdir("/tmp")
Dir.getwd # => "/tmp"

カレントディレクトリ配下にあるファイルエントリ取得

Dir.children(".")
=>
[".circleci",
 ".codespellrc",
 ".gem_rbs_collection",
 ".git",
 ".github",
 ".gitignore",
 ".rspec",
 ".rspec_status",
 ".rubocop.yml",
 ".vscode",
 "Gemfile",
 "Gemfile.lock",
 "LICENSE.txt",
 "README.md",
 "Rakefile",
 "Steepfile",
 "bin",
 "config",
 "sample.gemspec",
 "lib",
 "pkg",
 "rbs_collection.lock.yaml",
 "rbs_collection.yaml",
 "sig",
 "spec"]

export requirements.txt from Pipfile

Yuta Goto — Tue, 12 Dec 2023 15:01:00 +0000

これは .ごっ！のアドベントカレンダーの13日目の記事です。

Pipfile.lock ファイルから requirements.txt ファイルを生成する方法は以下のコマンドを実行します。

$ pipenv requirements > requirements.txt

開発モジュールを含める場合は --dev オプションも付けます。

$ pipenv requirements --dev > requirements.txt

pipenv.pypa.io

WSL2にGoogle Chromeをインストールする

Yuta Goto — Mon, 11 Dec 2023 15:01:00 +0000

これは .ごっ！のアドベントカレンダーの12日目の記事です。

Microsoftのドキュメントの通りの通りに進めます。

WSL で Linux GUI アプリを実行する | Microsoft Learn

WSL で Linux GUI アプリの実行がどのようにサポートされるかについて説明します。

learn.microsoft.com

前提としてWSL2が有効になっていることとします。

インストール

$ cd /tmp
$ sudo wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
$ sudo dpkg -i google-chrome-stable_current_amd64.deb # 安定したバージョンを取得
$ sudo apt install --fix-broken -y # パッケージを修正
$ sudo dpkg -i google-chrome-stable_current_amd64.deb # パッケージを構成
$ google-chrome --version
Google Chrome 119.0.6045.159

起動するときは google-chrome コマンドを実行します。

アップデート

一度削除してから、再度 wget で取得してインストールを実行します。

sudo apt --purge remove google-chrome-stable

lsコマンドで得られたファイル・ディレクトリ名だけを行区切りで表示する

Yuta Goto — Sun, 10 Dec 2023 15:01:00 +0000

これは .ごっ！のアドベントカレンダーの11日目の記事です。

表題の通り、lsコマンドで得られるファイルやディレクトリ名だけを改行区切りで表示するためには -1 オプションをつけます。

/ $ ls -1
bin -> usr/bin
boot
dev
Docker
etc
home
init
lost+found
media
mnt
opt
proc
root
run
...

$ ls --help
List information about the FILEs (the current directory by default).
Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.

Mandatory arguments to long options are mandatory for short options too.
  -1                         list one file per line.  Avoid '\n' with -q or -b
...

tutorialspoint.com

nodenv to pnpm

Yuta Goto — Wed, 26 Apr 2023 14:28:56 +0000

Nodejsの環境の管理を nodenv から pnpm に置き換えたので、そのメモです。

nodenv / nodenv

Manage multiple NodeJS versions.

Seamlessly manage your app’s Node environment with nodenv.

Use nodenv to pick a Node version for your application and guarantee that your development environment matches production. Put nodenv to work with npm for painless Node upgrades and bulletproof deployments.

Powerful in development. Specify your app's Node version once in a single file. Keep all your teammates on the same page. No headaches running apps on different versions of Node. Just Works™ from the command line Override the Node version anytime: just set an environment variable.

Rock-solid in production. Your application's executables are its interface with ops. With nodenv and you'll never again need to cd in a cron job or Chef recipe to ensure you've selected the right runtime. The Node version dependency lives in one place—your app—so upgrades and rollbacks are atomic, even when you switch versions.

One thing well. nodenv is concerned solely with switching Node versions. It's…

View on GitHub

Fast, disk space efficient package manager | pnpm

Fast, disk space efficient package manager

pnpm.io

環境

WSL2
npm v9
bash

nodenvの削除

ホームディレクトリにある .nodenv を削除します。

$ rm -rf ~/.nodenv

.bashrc に書かれたnodenvの設定を削除します。

# 以下のような文が書かれているはずです
export PATH="$HOME/.nodenv/bin:$PATH

.bashrc を再読み込みし、 nodenvコマンドが使えないことを確認します。

$ source .bashrc 
$ nodenv
Command 'nodenv' not found

pnpmのインストール

Installationに書いてある通り、wgetでダウンロードしshellを実行します。

$ wget -qO- https://get.pnpm.io/install.sh | ENV="$HOME/.bashrc" SHELL="$(which bash)" bash -

この時点で pnpm コマンドが使えるはずです。

$ pnpm -v
8.3.0

nodejsのインストール

pnpm use -g でシステム全体で使用する特定バージョンのnodeのインストールをします。

# v20.X.Xをインストールする
$ pnpm env use --global 20

# LTS版をインストールする
$ pnpm env use --global lts

$ node -v
v20.0.0

Deploy to Google AppEngine with GitHubActions

Yuta Goto — Mon, 06 Feb 2023 02:55:30 +0000

GitHubActionsを使用してGoogleCloudのAppEngineにデプロイする方法の備忘録です。

バージョンアップで設定の仕方が変更になっている可能性があるため、最新情報はリポジトリを確認してください。

google-github-actions / deploy-appengine

A GitHub Action that deploys source code to Google App Engine.

deploy-appengine

This action deploys your source code to App Engine and makes the URL available to later build steps via outputs. This allows you to parameterize your App Engine deployments.

This is not an officially supported Google product, and it is not covered by a Google Cloud support contract. To report bugs or request features in a Google Cloud product, please contact Google Cloud support.

Prerequisites

This action requires Google Cloud credentials that are authorized to deploy an App Engine Application. See the Authorization section below for more information.
This action runs using Node 20. If you are using self-hosted GitHub Actions runners, you must use runner version 2.285.0 or newer.

Usage

jobs
  job_id:
    permissions:
      contents: 'read'
      id-token: 'write'

    steps:
    - id: 'auth'
      uses: 'google-github-actions/auth@v2'
      with:
        workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider'
        service_account

…

View on GitHub

サービスアカウントの準備

Google CloudのConsoleメニューのIAMと管理からサービスアカウントにアクセスしアカウントを作成します。App Engineに関するロールは「オーナー」「編集者」「App Engine管理者」「App Engine サービス管理者」のどれかにします。
また、ドキュメントにもあるとおりに、「ストレージ管理者」「Cloud Build編集者」も付与します。

作成したサービスアカウントの鍵の作成し、JSONをダウンロードします。

Actionの設定

ダウンロードした鍵のJSONの内容をそのまま、GitHub Actionsの環境変数に登録します。

準備が整ったら workflowを書いてコミットします。言語ごとのセットアップを適宜書き換えてください。

name: Deploy to App Engine
on:
  push:
    branches:
      - main

jobs:
  deploy:
    name: GAE Deploy
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: setup nodejs env # 言語に応じて変更する
        uses: actions/setup-node@v3
        with:
          node-version: 18
      - id: 'auth'
        name: 'Authenticate to Google Cloud'
        uses: 'google-github-actions/auth@v1'
        with:
          credentials_json: '${{ secrets.GCP_SA_KEY }}'
      - name: Deploy App
        id: deploy
        uses: 'google-github-actions/deploy-appengine@v1'
        with:
          project_id: ${{ secrets.GCP_PROJECT_ID }}

問題なく設定できていれば、デプロイが完了します。

躓いた点

`(gcloud.app.deploy) Your deployment has succeeded, but promoting the new version to default failed. You may not have permissions to change traffic splits. Changing traffic splits requires the Owner, Editor, App Engine Admin, or App Engine Service Admin role. Please contact your project owner and use the "gcloud app services set-traffic --splits <version>=1" command to redirect traffic to your newly deployed version.`

権限が足りず、デプロイしたバージョンの反映に失敗したエラーです。サービスアカウントの権限をエラー文に書いてある内容のいずれかを付与しrerunすると、このエラーはなくせるはずです。

hash keys to method names

Yuta Goto — Fri, 23 Dec 2022 00:01:00 +0000

これは .ごっ！のアドベントカレンダーの19日目の記事です。

RubyのHashのキー名をメソッド名として扱うときの備忘録です。
例えば、 h = {num: 42} があったときに h.num で42を取得したいといったときです。

Rubyの Hash#fetch と method_missing をいい具合に利用します。

class Hash
  def method_missing(m)
    fetch(m) { fetch(m.to_s) { super } }
  end
end

h = {num: 42, str: "string", first_hash: { second_hash: "second_hash_str" }}
p h.num # => 42
p h.str # => "string"
p h.first_hash.second_hash # => "second_hash_str"
p h.string # => undefined method 'string' for {....}:Hash (NoMethodError)

この method_missing() は Hashにそのメソッドが定義されていなかった時に呼び出されるメソッドで、引数の m は呼び出そうとしたメソッド名のSymbolが渡ります。

fetch() はキーに関連付けられた値を返すメソッドです。キーがない場合はブロックの実行結果が返されます。

それぞれの詳しい内容はリファレンスマニュアルを読んでください。

https://docs.ruby-lang.org/ja/3.1/method/BasicObject/i/method_missing.html
https://docs.ruby-lang.org/ja/3.1/method/Hash/i/fetch.html

上記にあるコードを順番に読み解きます。

h.num の場合
1. method_missing に m = :num が渡る。
2. fetch(:num) で h には :num のキーがあるのでその値を返す。
  - h.string の場合
  - method_missing に m = :string が渡る。
  - fetch(:string) で h には :string のキーが存在しないのでブロックの中身が実行される。
  - m.to_s した結果が fetch されるので、 fetch("string")となるが h には "string" のキーが存在しないのでブロックの中身が実行される。
  - super で実際の method_missing が実行される。

良さげな使い方としては、 APIリクエストしてJSONを受け取った時にメソッドっぽく値を取り出すことができ、きれいなコードを書いているように見えることです。

以下サンプルコードです。

require 'faraday'

class Hash
  def method_missing(m)
    fetch(m) { fetch(m.to_s) { super } }
  end
end

conn = Faraday::new({url: "https://api.nasa.gov"}) do |c|
  c.request :json
  c.response :json
  c.adapter Faraday.default_adapter
end

res = conn.send(:get, "/planetary/apod", { api_key: "DEMO_KEY" }, nil)
p res.body.copyright # => "Craig Stocks"
p res.body.title # => "The Tadpole Nebula in Gas and Dust"

このコードでは faraday を使用していますが、httpリクエストの方法はなんでもよいです。

lostisland / faraday

Simple, but flexible HTTP client library, with support for multiple backends.

Faraday is an HTTP client library abstraction layer that provides a common interface over many adapters (such as Net::HTTP) and embraces the concept of Rack middleware when processing the request/response cycle Take a look at Awesome Faraday for a list of available adapters and middleware.

Why use Faraday?

Faraday gives you the power of Rack middleware for manipulating HTTP requests and responses, making it easier to build sophisticated API clients or web service libraries that abstract away the details of how HTTP requests are made.

Faraday comes with a lot of features out of the box, such as:

Support for multiple adapters (Net::HTTP, Typhoeus, Patron, Excon, HTTPClient, and more)
Persistent connections (keep-alive)
Parallel requests
Automatic response parsing (JSON, XML, YAML)
Customization of the request/response cycle with middleware
Support for streaming responses
Support for uploading files
And much more!

Getting Started

The best starting point is the Faraday Website, with…

View on GitHub

レスポンスbodyの中身をまるでメソッドかのように値を取得しています。

上記のコードは万能ではありません。 Hash のインスタンスメソッドにあるメソッド名がキー名と同じだった場合、インスタンスメソッドが優先されます。({dig: "dig_string"} とあった場合は、method_missingではないので Hash#dig が優先されるということです。)

小さい個人ツールやgemとして使う分には便利ではありますが、大きいプロダクトに適用させる場合には注意しましょう。

yarn berryで依存パッケージのバージョンを指定する

Yuta Goto — Sat, 16 Apr 2022 02:33:02 +0000

使用しているパッケージの依存パッケージのバージョンを指定するのに、npmを使用している場合は npm-force-resolutionsを使うと固定できますが、 yarn berry (yarn v2, v3) を使用する場合はyarn単体で指定することができます。

npm-force-resolutions - npm

This packages modifies package-lock.json to force the installation of specific version of a transitive dependency (dependency of dependency), similar to yarn's [selective dependency resolutions](https://yarnpkg.com/lang/en/docs/selective-version-resolutio. Latest version: 0.0.10, last published: a year ago. Start using npm-force-resolutions in your project by running `npm i npm-force-resolutions`. There are 28 other projects in the npm registry using npm-force-resolutions.

npmjs.com

ユースケースとしては、依存パッケージに脆弱性があったときに元のパッケージの対応を待たなくともひとまず依存パッケージのバージョンを上げる（下げる）ことができるといった具合です。（もちろん元のパッケージが即座に対応してくれればそれでよいですが。）

環境

npm: 8.1.2
yarn: 3.2.0
node: v16.13.2

指定方法

$ yarn set resolution <descriptor> <resolution>

のコマンドを実行します。

たとえば、 minimist のバージョンを ^1.2.0 から ^1.2.6 に上げるときは以下のようになります。

$ yarn set resolution minimist@npm:^1.2.0 ^1.2.6

実行すると yarn.lock でそのパッケージのバージョンが更新されていたり、 .yarn/cache のパッケージのZIPファイルが更新されてたりします。

注意

強制的にバージョン指定したため元のパッケージが意図しない動作になることがあります。

参考

yarn set resolution: https://yarnpkg.com/cli/set/resolution

ArtifactsにアップしたファイルのURLをSlackに通知する

Yuta Goto — Fri, 10 Dec 2021 11:19:45 +0000

CircleCIのArtifactにアップロードしたファイルのURLをSlackに通知する仕組みを作ります。作業リポジトリは以下です。

YutaGoto / artifacts-sample

Artifacts Sample

artifacts-sample

created by create-book.

References

VFM https://vivliostyle.github.io/vfm/#/vfm
Vivliostyle CLI https://github.com/vivliostyle/vivliostyle-cli#readme
Vivliostyle Themes https://github.com/vivliostyle/themes#readme
Awesome Vivliostyle https://github.com/vivliostyle/awesome-vivliostyle#readme
Vivliostyle (GitHub) https://github.com/vivliostyle
Vivliostyle https://vivliostyle.org

View on GitHub

サンプルとしてvivriostyleでビルドして出来上がったpdfファイルをArtifactとしてアップロードしています。

アーティファクトのアップロード

https://circleci.com/docs/ja/2.0/artifacts/

公式にある通り、 store_artifactsにパスを指定します。

jobs:
  build:
    executor:
      name: node/default
      tag: 'lts-browsers'
    working_directory: ~/project # 作業用ディレクトリ指定
    steps:
      - checkout
      - node/install-packages:
          cache-path: ~/project/node_modules
          override-ci-command: yarn install
      - run:
          name: build
          command: yarn build
      - run:
          command: mkdir ~/project/artifacts # アップロード用ディレクトリ生成
      - run:
          command: mv output.pdf ~/project/artifacts/output.pdf # pdfファイルの移動
      - store_artifacts:
          path: ~/project/artifacts # アップロード

URLの取得

https://circleci.com/docs/api/v1/#download-an-artifact-file

CircleCIのAPIにリクエストして環境変数に保存します。

artifacts=$(curl -X GET "https://circleci.com/api/v2/project/github/$CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME/$CIRCLE_BUILD_NUM/artifacts" \
-H "Accept: application/json" \
--header "Circle-Token: $CIRCLE_TOKEN") # APIをたたいてレスポンス値を代入する
artifact0=$(echo $artifacts | jq '.items[0].url') # jqコマンドでurlの文字列を取得する
echo "export ARTIFACT0=$artifact0" >> $BASH_ENV # 環境変数に登録する

変数に関しては過去記事もありますので合わせてみてください。

CircleCIで変数を扱う

Yuta Goto ・ Aug 11 '20

#circleci

Slackに通知

https://circleci.com/developer/ja/orbs/orb/circleci/slack

CircleCIのSlackOrbを使うと簡単に通知させることができます。メッセージの組み立てはSlackのBlock Kit Builderを使っています。

https://app.slack.com/block-kit-builder/

      - slack/notify:
          event: always # 常に通知させる
          custom: |
            {
              "blocks": [
                {
                  "type": "section",
                  "text": {
                    "type": "mrkdwn",
                    "text": "Book Artifacts <${ARTIFACT0}>"
                  }
                }
              ]
            }

結果

正しく登録できると以下の画像のようなSlack通知が来ると思います。リンククリックしたら実際にPDFファイルがブラウザで確認ができます。

CircleCIを使用してVercelにデプロイする

Yuta Goto — Sat, 02 Oct 2021 15:33:03 +0000

Vercelにはgit pushを検知してDeployする仕組みがあるが、lintやtestしてからのデプロイはgit push検知の状態ではできないのでvercelのコマンドを使用してCDツールに組み込む。

https://vercel.com/cli

準備

vercelのgit integrationを切っておく。

Vercelの個人設定からCircleCIで使用するTokenを生成する。

Vercelで生成したTokenをCircleCIの環境変数にセットする。

実装

yarn add でvercelコマンドを準備し、Scriptを組んでおくと楽に設定できる。

yarn add -D vercel

// package.json
{
  "scripts": {
    "deploy": "vercel --token $VERCEL_TOKEN --prod --confirm"
  }
}

--confirm はデプロイするための質問をスキップさせることができる。

https://vercel.com/docs/cli#commands/overview/unique-options/confirm

.circleci/config.yml に設定を書く。

# .circleci/config.yml
version: 2.1

orbs:
  node: circleci/node@4.7

jobs:
  deploy:
    working_directory: ~/[ProjectName]
    docker:
      - image: circleci/node:latest
    steps:
      - checkout
      - run:
          name: install
          command: yarn install
      - run:
          name: deploy
          command: yarn deploy

workflows:
  version: 2
  main:
    jobs:
      - deploy:
          filters:
            branches:
              only:
                - main

vercel --token $VERCEL_TOKEN --prod --confirm を実行すると現在のディレクトリがプロジェクト名として認識されデプロイされるので、 ymlファイルの working_directory: の [ProjectName] の部分をきちんと設定すれば意図したプロジェクト名でデプロイすることができる。

CIの実行結果に本番用のURLが出力されるので、そこからアクセスすることも可能になっている。

CircleCIのRust OrbでNightly版を使う

Yuta Goto — Thu, 19 Aug 2021 17:07:19 +0000

CircleCIのRustOrbsを使うときデフォルトではStable版になっています。最近のRustのバージョンでClippyを使うときはNightlyに切り替える必要があります。

特別な用意されたコマンドは実装されていないので普通に書きます。

# .ciecleci/config.yml

version: 2.1

orbs:
  rust: circleci/rust@1.5.0

jobs:
  lint:
    docker:
      - image: circleci/rust:latest
    steps:
      - checkout
      - run: rustup default nightly
      - rust/clippy

workflows:
  version: 2
  test:
    jobs:
      - lint

https://circleci.com/developer/orbs/orb/circleci/rust

Discord Slash Commandをつくる

Yuta Goto — Wed, 21 Jul 2021 14:32:34 +0000

DiscordのSlashコマンドを使ってみます。

https://discord.com/developers/docs/interactions/slash-commands

アプリの作成

https://discord.com/developers/applications

Developer PortalのApplicationsから新規作成します。

作成したら、OAuth2の設定ページに遷移して、OAuth2 URL Generatorの下にあるSCOPESから Bot, applications.commands を選択して、さらに Bot Permissions の Send Meesages にチェックを入れます。（必要に応じて追加でチェックを入れてください）

SCOPESにあるURLにアクセスしてBOTユーザをサーバーに招待します。

ここでBOTの下準備は完了です。

スラッシュコマンドの登録

https://discord.com/developers/docs/interactions/slash-commands#registering-a-command

公式のドキュメントにある通りスクリプトを組んで実行します。

import requests

url = "https://discord.com/api/v8/applications/<APPLICATION ID>/guilds/<GUILD ID>/commands"

json = {
    "name": "blep",
    "description": "Send a random adorable animal photo",
    "options": [
        {
            "name": "animal",
            "description": "The type of animal",
            "type": 3,
            "required": True,
            "choices": [
                {
                    "name": "Dog",
                    "value": "animal_dog"
                },
                {
                    "name": "Cat",
                    "value": "animal_cat"
                },
                {
                    "name": "Penguin",
                    "value": "animal_penguin"
                }
            ]
        },
        {
            "name": "only_smol",
            "description": "Whether to show only baby animals",
            "type": 5,
            "required": False
        }
    ]
}

headers = {
    "Authorization": "Bot <BOT TOKEN>"
}

r = requests.post(url, headers=headers, json=json)
print(r.status_code)

特定のサーバーでのみ使用するのであれば <GUILD ID> を指定します。
このスクリプトを実行して成功すれば201が表示されて終了します。
特定のサーバーでのみのコマンドであれば即時反映されるので、実際にDiscord上でも確認ができます。/ を入力すると候補に /blep が表示されるはずです。

ただこのままコマンドを送信してもエラーとなり何も発生しないので、ひとまずコマンドを送信したらBOTがメッセージを送信する処理を実装します。

コマンド送信後の実装

今回、本番環境では Cloudflare Workers KV を使用します。GoogleCloudRunなどのサーバレスのものを利用しても問題ないですが、CloudRunはアクセスがあってから起動するまでに時間がかかってしまい、Discord側でタイムアウト判定になってしまう可能性があります。Cloudflare Workers KVは起動がCloudRunよりもかなり早いので正常にレスポンスできるはずです。

https://www.cloudflare.com/ja-jp/products/workers-kv/

Cloudflare Workers KVのセットアップは割愛します。https://developers.cloudflare.com/workers/ に環境構築からデプロイまでかかれています。
外部ライブラリを利用するのでWebpackも利用します。

Discordのリクエストを受け付ける

discord-interactions を使って実装します。

https://www.npmjs.com/package/discord-interactions

このコードは何かしらコマンドのリクエストがあれば pong を返却するだけのものになっています。

以下のコードでヘッダーがちゃんとDiscordから来たものかを判定します。Discordで Interactions Endpoint URL を登録する際にあえて誤ったリクエストヘッダーがついたリクエストがくるので、それの判定を行います。

const valid = verifyKey(
  await request.clone().arrayBuffer(),
  request.headers.get('X-Signature-Ed25519'),
  request.headers.get('X-Signature-Timestamp'),
  discord_public_key
)

if (!valid) {
  return new Response('', { status: 401 })
}

以降の処理は正しい形式でJSONを返却します。 https://discord.com/developers/docs/interactions/slash-commands#responding-to-an-interaction にもサンプルが書いています。

デプロイ

外部パッケージを使用しているのでwebpackした後のコードをデプロイします。webpackやその設定の説明は端折ります。

デプロイもcloudflareのチュートリアルにある通りにコマンド一発で完了します。 https://developers.cloudflare.com/workers/get-started/guide#8-publish-your-project

デプロイが完了したらCloudflareのWorkers一覧ページにアクセスして、そこに表示されているURLを確認します。

そこに表示されているURLを Discordのアプリケーション設定ページの discord-interactions にペーストしてセーブしてチェックがパスしたら完了です。