TypeScript Lambdaを非常に管理しやすくするNodeJsFunctionの紹介

1. TypeScriptで書くLambdaを
CDKでいい感じに管理する
クライヤー篠塚 一帆

2. 自己紹介
 経歴
 生命系専攻
 組み込み&信号処理エンジニア (3年)
 事業企画 (1年)
 社内向けWebアプリエンジニア (1.5年)
 AWS, フロントエンド, バックエンド
 CDK歴
 半年ほど
 cloudformation半年 → ツラすぎて移行
クライヤー篠塚 一帆
2017 2018 2020 2021 2022
2019
回路、基板設計から行った
自作ニキシー管 温湿度気圧計
@badmintoncryer
@nixieminton

3. 04
03
02
01
目次
Introduction
基本のやり方
NodeJsFunction
とかいう神
Tips

4. Introduction
 やりたいこと
 API Gateway & lambdaでバックエンド構築
 LambdaもTypeScriptで実装
 TypeScript
 JavaScript + 静的型付け
 TypeScriptランタイムは
(あんまり)存在しない。
 一度JavaScriptへ変換(トランスパイル)し、
生成されたJavaScriptを実行する。
API Gateway AWS Lambda
let hoge = ‘test’
hoge = 123 // OK
JavaScript
let hoge: string = ‘test’
hoge = 123 // Error@静的解析
TypeScript
??

5. Introduction
 LambdaでTypeScriptを動かそう！
 Node.jsをランタイムとして指定
 TypeScriptコードをJavaScriptにトランスパイル & デプロイ
 デフォルトで入っていないモジュールを用いる場合、
モジュールの紐付けが必要
 aws-sdk, child_process, fs, etc.. は何もしなくても使える
 選択肢
 layerを使う
 node_modulesを含めたzipを生成してupload
 モジュールのバンドリング
 目指したこと
 cdk deploy コマンド一発で、以下全てをいい感じに実行
 TypeScriptコードのトランスパイル
 モジュールの紐付け
 lambdaへのデプロイ

6. 04
03
02
01
目次
Introduction
基本のやり方
NodeJsFunction
とかいう神
Tips

7. 基本のやり方
トランスパイル
モジュールの紐付け
デプロイ
// トランスパイル & バンドリング
$ tsc
// node_modules作成
$ npm install × N回 (各lambdaフォルダ毎)
$ cdk deploy
 aws-cdk-lib.aws_lambda.Function
 aws_lambda.FunctionでTypeScript Lambdaをデプロイするには？？
const function = new lambda.Function(this, 'MyFunction', {
runtime: lambda.Runtime.NODEJS_16_X,
code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler’)),
handler: 'index.handler‘
})
トランスパイル & バンドリング済みのJSファイルを指定
(正確にはディレクトリ丸ごとuploadされる)
運用でカバー or デプロイ用スクリプトが必要😩😩

8. 04
03
02
01
目次
Introduction
基本のやり方
NodeJsFunction
とかいう神
Tips

9. NodeJsFunctionとかいう神
トランスパイル
モジュールの紐付け
デプロイ
 aws-cdk-lib.aws_lambda_nodejs.NodeJsFunction
 NodeJsFunctionを使って TypeScript Lambdaをデプロイするには？？
const hogeLambda = new nodeLambda.NodejsFunction(scope, ‘hoge’, {
runtime: lambda.Runtime.NODEJS_16_X,
entry: path.join(__dirname, './index.ts‘)
})
// めんどくさいことぜんぶ、cdk deploy におまかせ！
$ cdk deploy
TypeScriptファイルをパス指定するだけ
脳死でcdk deployコマンドを叩くだけ😍

10. "use strict";
var __getOwnPropNames = Object.getOwnPropertyNames;
var __commonJS = (cb, mod) => function __require() {
return mod || (0, cb[__getOwnPropNames(cb)[0]])
((mod = { exports: {} }).exports, mod),
mod.exports;
};
…(数万行)…
exports.handler = async (
event, _context) => {
(なにかSqliteを操作)
return {…}
}
何を行っている？
 コード例 (index.ts)
import * as sqlite3 from ‘sqlite3’
exports.handler = async (
event: APIGatewayProxyEventV2WithJWTAuthorizer,
_context: Context
): Promise<APIGatewayProxyResult> => {
(なにかSqliteを操作)
return {…}
}
 成果物 (cdk.out/asset.〇〇.js)
1. node_modules内の
sqlite3モジュールを
JSファイルにバンドル
2. handlerを
JSにトランスパイル
JSファイルをlambdaにアップロード
$ cdk deploy でTypeScript Lambdaのデプロイが全て完結
1. 外部モジュールをimport
2. handlerをTypeScriptで記述
$ cdk synth
$ cdk deploy

11. 04
03
02
01
目次
Introduction
基本のやり方
nodeLambda.
NodeJsFunction
とかいう神
Tips

12. Tips
 lambda互換環境でモジュールをインストールしてほしい
 Why ?
 mac環境でインストールしたモジュールがlambdaで動かない…
 native extensionを含むモジュール
 How ?
 bundling: forceDockerBundling オプション
 lambda互換コンテナ環境上で一連の処理を実行してくれる
 注意点
 macOS上で著しく動作が遅いです。
 公式でも言及有り
 「macOSユーザーは、localでesbuild使うのがオススメだぜ」
 私はgithub actions上で動かすことにしました
モジュール
インストール
トランスパイル &
バンドリング
lambda互換コンテナ
PC
$ cdk synth cdk.out生成
コンテナ
立ち上げ
コンテナ
クローズ
lambda環境向けのモジュールを
バンドリングしたJSファイルが生成

13. Tips
 lambdaにアップロードするファイルを操作したい
 Why ?
 ex.1 容量制限(250MB)対策のため、不要なファイルを削除したい
 prismaは各種エンジンが重く、250MB制限と戦う必要あり
 ex.2 必要なファイルを投げ込みたい
 クライアント証明書とか持たせたい！
 How ?
 コマンドフックを活用
 beforeBundling, afterBundling, beforeInstall
const hogeLambda = new nodeLambda.NodejsFunction(scope, ‘hoge', {
entry: path.join(__dirname, './index.ts‘),
bundling: {
commandHooks: {
beforeInstall: (inputDir: string, outputDir: string) => [
// スキーマファイルのコピー
`cp -r ${inputDir}/prisma ${outputDir}`,
],
afterBundling: (inputDir: string, outputDir: string) => [
// 不要なディレクトリを削除
`rm -rf ${outputDir}/unusedDirPath`,
`cp ${inputDir}/libquery… ${outputDir}`,
],
}
}
})
cdk.out/asset〇〇の中身

14. まとめ
 CDKを使って、lambdaをTypeScriptで実装したい
 NodeJsFunctionが神
 トランスパイル、モジュールの紐付け、デプロイを全て行ってくれる
 lambda互換環境でのバンドリングも可能。
 コマンドフック活用で、お好みのファイル操作が可能
 独自モジュールの導入、lambda容量制限のため不要なファイルを削除
 めんどくさいことを全てCDKにおまかせできる！
 あとは $ cdk deploy するだけ♪
Have a happy TypeScript Lambda life !!