jest Jest encountered an unexpected token import とかexportが読み込めない

vue.jsのテストでjestを利用しています。

jestのバージョンは 27.4.3
nodeは 16.13.0です。

次のようなエラーが出てテストが実行できずに困っていました。

   Jest encountered an unexpected token

    Jest failed to parse a file. This happens e.g. when your code or its dependencies use non-standard JavaScript syntax, or when Jest is not configured to support such syntax.

    Out of the box Jest supports Babel, which will be used to transform your files into valid JS based on your Babel configuration.

    By default "node_modules" folder is ignored by transformers.

    Here's what you can do:
     • If you are trying to use ECMAScript Modules, see https://jestjs.io/docs/ecmascript-modules for how to enable it.
     • If you are trying to use TypeScript, see https://jestjs.io/docs/getting-started#using-typescript
     • To have some of your "node_modules" files transformed, you can specify a custom "transformIgnorePatterns" in your config.
     • If you need a custom transformation specify a "transform" option in your config.
     • If you simply want to mock your non-JS modules (e.g. binary assets) you can stub them out with the "moduleNameMapper" config option.

    You'll find more details and examples of these config options in the docs:
    https://jestjs.io/docs/configuration
    For information about custom transformations, see:
    https://jestjs.io/docs/code-transformation

    Details:

    /var/www/html/hoge/webpack_src/components/timeTable/templates/TimeTable.vue:1
    ({"Object.<anonymous>":function(module,exports,require,__dirname,__filename,jest){<template>
                                                                                      ^

    SyntaxError: Unexpected token '<'

       8 | import Vuex from "vuex";
       9 | import {createLocalVue, mount} from "@vue/test-utils";
    > 10 | import TimeTableVue from "../../../../../components/timeTable/templates/TimeTable";
         | ^
      11 | import {FontAwesomeIcon} from '@fortawesome/vue-fontawesome' // 追加
      12 |
      13 |

      at Runtime.createScriptFromCode (node_modules/jest-runtime/build/index.js:1728:14)
      at Object.<anonymous> (webpack_src/test/unit/specs/class/timeTable/TimeTableVue.spec.js:10:1)

node_modulesの中のimport, export が書いてあるところで止まっちゃうんですよ。

これについて平たく説明すると、jest は nodeで動作するのですが、nodeはexport や import という文法を知らないので、SyntaxErrorになってしまうというわけです。

下記のサイトに、解決方法が載っていました。有難うございます!

ts-jestが外部ライブラリをimportできない場合の対処方

https://media-massage.net/blog/ts-jest%E3%81%8C%E5%A4%96%E9%83%A8%E3%83%A9%E3%82%A4%E3%83%96%E3%83%A9%E3%83%AA%E3%82%92import%E3%81%A7%E3%81%8D%E3%81%AA%E3%81%84%E5%A0%B4%E5%90%88%E3%81%AE%E5%AF%BE%E5%87%A6%E6%96%B9/

このとき設定ファイルを.babelrcとして作成してしまうと意図通りに動作しないのでbabel.config.jsとすること。.babelrcで設定ファイルを作るとデフォルトではnode_modules内のファイルには設定が適用されない。

そうだったのか!目からうろこでした(泣)

というわけで、今まで.babelrc で書いていたところを babel.config.js にしたら直りました。

リンク先とほぼ同じですが、babel.config.js を載せておきます。

module.exports = {
    "presets": [
        [
            "@babel/preset-env",
            {
                "modules": false,
                "useBuiltIns": "usage",
                "targets": "> 0.25%, not dead",
                "corejs": 3
            }
        ]
    ],
    "env": {
        "test": {
            "presets": [["@babel/preset-env", {"targets": {"node": "current"}}]]
        }
    }
}

jest.conf.jsは次の通り。

const path = require('path')

module.exports = {
  rootDir: path.resolve(__dirname, '../../../'),
  moduleFileExtensions: [
    'js',
    'json',
    'vue'
  ],
  moduleNameMapper: {
    '^@/(.*)$': '<rootDir>/webpack_src/$1',
    '\\.(css|less)$': 'identity-obj-proxy'
  },
  transform: {
    '.*\\.(vue)$': 'vue-jest',
    '^.+\\.js$': 'babel-jest'
  },
  transformIgnorePatterns: [
  ],
  testPathIgnorePatterns: [
    '<rootDir>/webpack_src/test/e2e'
  ],
  snapshotSerializers: ['<rootDir>/node_modules/jest-serializer-vue'],
  setupFiles: ['<rootDir>/webpack_src/test/unit/setup'],
  coverageDirectory: '<rootDir>/webpack_src/test/unit/coverage',
  collectCoverageFrom: [
    'webpack_src/**/*.{js,vue}',
    '!webpack_src/main.js',
    '!**/node_modules/**'
  ],
  testURL: 'http://localhost/',
  globalSetup: '<rootDir>/webpack_src/test/unit/global-setup.js'
}

次の

transformIgnorePatterns: [
]

は空なので、指定しなくてもいいかと思いそうですが、これを削除すると、前述のエラーが出ます。

Jestの公式サイトによると、

https://jestjs.io/ja/docs/configuration#transformignorepatterns-arraystring

transformIgnorePatterns  のデフォルト値が

 
{ "transformIgnorePatterns": ["/node_modules/", "\\.pnp\\.[^\\\/]+$"] }

なので、書かないとnode_modules の中をtransform してくれないからじゃないかなって考えています。(←ただの推測でちゃんと確認してません。)

jest あるテストの中の一個のテストだけ実行する(it の単位で実行する)

大した話じゃないんですけど。

jest を書いたりしているときに、ほかのテストは実行したくない!今書いてるテストだけ実行したい!という時あると思います。

例えば、ActivityList.spec.jsというテストのプログラムのファイルがあったとして、次のようなテストを書いているとします。

describe('ActivityList.js operation', () => {
  it('ActivityList can find Same Activities', () => {
 // 中略
 }
}

この

'ActivityList can find Same Activities'

のテストだけ実行したい場合は、次のようにCLIで実行します。

npm run unit -- ActivityList.spec.js -t 'ActivityList.js operation ActivityList can find Same Activities'

下記のようなパターンでやるということですね。

jest -t '<describeString> <itString>'

すると、ほかのテストを飛ばしてくれます。

PostmanでAPI仕様書を作る試み② 外部に公開する

前回に続き、PostmanでAPI仕様書を作る試みの続きです。

今回は、本丸!作ったAPI仕様書を外部の人にも公開しよー!!

編です。

①まず、サンプルのAPIを作ります。右横の、赤丸で囲んだところをクリックします。

②次に表示されるコーナーの一番下にある赤丸で囲んだところをクリックしてください。

③すると… うぉぉぉっ!!
もうすでに、API仕様書っぽくなっている!!

最初にですね~ API仕様書を
GithubのAPI仕様書みたいにカッコよく見やすく作りたい!」
と思っていたのですが、これですでに近づいてますね!(^_-)-☆

④最後に公開しますが、上記のスクショの右上の「Publish」というところをクリックします。あとは、流れでできると思います。

それで公開したAPIドキュメントのサンプルがこちらです。

お金をお支払いすれば、オリジナルのドメインにもできるっぽいです。

料金体系はこちら

PostmanでAPI仕様書を作る試み リクエストとレスポンスを成功とか失敗で分けたい

皆さま、API仕様書ってどうしてますか?

会社によっては社内のナレッジベースみたいなところにあったり、Excelとかになってたりすると思います。

弊社ではこの度、メンテナンスが簡単で外部にも公開できるようなAPI仕様書作成ツールを探しており、今Postmanというのを検討しています。
Postmanは、メインの役割としてはWebサーバーにあるプログラムに何か値を「GET」とか「POST」で渡すときに、それが簡単にできるというプログラムです。

Postmanとはもう長い付き合いで、確か12年前ぐらいからあったんじゃないかな~
Perlで問い合わせフォームとか作ってた頃から、これを使ってテストしてた気がする。昔は、本当に何かをURLにPostするだけでしたが、今はめちゃ高機能になっているみたいです。

というわけで、ちょいちょいPostmanをAPI仕様書にしていく中で得られた便利な使い方を紹介していきたいなと思います。

まずは、「成功したとき」と「失敗したとき」でドキュメントを分けたいやつです。ほかのプログラマーさんにこういうニーズがあるかわかりませんが、とりあえず私は 「成功したとき」と「失敗したとき」 が知りたいです。
成功したときにどんな風に帰ってくるのかは普通でも必要だと思いますが、失敗したときにどのようにエラーが帰ってくるのか知りたいからです。

で、Postmanさんではその辺をカバーしてくれとります!ありがとう!♡
以下、やり方です。

① 普通にAPIにリクエストを送ります。Postmanを初めて使う人のために紹介しますと、POSTとあるところにURLを記載し、Params とあるところにGETパラメーターを入力、BodyとあるところにPostパラメーターを入力して、Sendと書かれた青いボタンをクリックします

②レスポンスが帰ってきたら、下記の赤丸をクリックしてください。すると、「Save ad example」というのが選べます。この度はリクエストに成功しているので、「リクエスト成功時」などという名前をつけます。

③すると、左のツリー構造でAPIを見れる場所で、このリクエストが成功したときとエラーの時のサンプルがあるんだなぁ~ とわかります。

便利ですね!

社員旅行で訪れた「あわしまマリンパーク」へ行く船。APIって船みたいなもんですよね。

Google Docsみたいな共同編集Webサイトを作るライブラリ Yjs 初めの一歩 まずは動作させてみる

Yjs と聞いて、何を思い浮かべるでしょうか?
検索すると、〇〇先輩とか出てきますが、先輩ではありません。

↓これです。

A CRDT framework with a powerful abstraction of shared data
https://github.com/yjs/yjs/tree/master

CRDTできるフレームワークと書いてありますが、CRDTとは何かと言い出すと、Conflict-free replicated data typeの略で結構難しい話になります。
そこで、CRDTをすごく平たく言うと、Google Docsとか、MicrosoftのOffice365のExcelとか、AさんとBさんが同じExcelのシートを開いていても、共同で編集できますよね。あれがCRDTです。

そんな機能を実現させるためのライブラリです。

ベルリン在住のケビン・ヤーン(?)さんが作っているようです。
ありがとう、ケビンさん!

さて、まずはめっちゃ簡単に動作させてみます。

しかし、「Yjs sample」 とかググってみても、Reactを使ったりマイクラを使ったり、TODOアプリとかちょっと複雑なアプリが多く出てきます。
そういうのじゃなくって、「Hello World」的なことがまずは最初にしたい!という人いませんか?→はい、私です。
他にもそういう方がいるのではないかと思いまして、この記事を書きました。

灯台元暗しでYjsの公式サイトに「Hello World」的なサンプルがありました!

https://docs.yjs.dev/

import * as Y from 'yjs'

// Yjs documents are collections of
// shared objects that sync automatically.
const ydoc = new Y.Doc()
// Define a shared Y.Map instance
const ymap = ydoc.getMap()
ymap.set('keyA', 'valueA')

// Create another Yjs document (simulating a remote user)
// and create some conflicting changes
const ydocRemote = new Y.Doc()
const ymapRemote = ydocRemote.getMap()
ymapRemote.set('keyB', 'valueB')

// Merge changes from remote
const update = Y.encodeStateAsUpdate(ydocRemote)
Y.applyUpdate(ydoc, update)

// Observe that the changes have merged
console.log(ymap.toJSON()) // => { keyA: 'valueA', keyB: 'valueB' }

これを、index.mjs という名前で保存します。

PCにNode.jsはインストールされていますか?されていなければ、まずはNode.jsをインストールしてください。

Node.jsがインストールされていれば、次はYjsをインストールします。
私の開発環境はWindowsです。なのでコマンドプロンプトを開いて次のコマンドを実行します。

npm i yjs y-websocket

厳密にいうと、後半のy-websocketは今は必要なさそうですが、いずれ必要になりそうなので入れておきます。

インストールできましたね!

そしたら、さっき保存したindex.mjs をnodeコマンドで動作させます。

node index.mjs

すると、上記のスクショのように、サンプルコードの下記の部分が表示されます。

console.log(ymap.toJSON()) 
('keyA', 'valueA')

だったymap が 

('keyB', 'valueB')

という ymapRemote と統合されて

 { keyA: 'valueA', keyB: 'valueB' }

になったんですね~。

すごい!
もちろん、これだけではすごさは全く伝わらないと思うので、Yjsについては今後記事を書いていきたいと思います。