node,js xmlの圧縮ファイルを展開し、それをjsonファイルに変換する

Question

xmlファイルが圧縮されたzipファイルを展開して、展開されたxmlをjsonファイルにしたいです。

以下のライブラリを使用しました

https://www.npmjs.com/package/unzip
https://www.npmjs.com/package/xml2json

'use strict';

let fs = require('fs')
let unzip = require('unzip')
let parser = require('xml2json');

let originalFilePath = process.argv[2];

let XMLFileName = originalFilePath.replace(/^.*[\/]/, '').replace('.zip', '')
let XMLFileDirectory = '/users/*****/desktop/templatexml/' + XMLFileName + '/'
let XMLFilePath = '/users/*****/desktop/templatexml/' + XMLFileName + '/doc.xml'

let jsonFilePath = '/users/*****/desktop/templatexml/' + XMLFileName + '/doc.json'

convertToXML(originalFilePath).then(() => {
    let XMLFileData = fs.readFileSync(XMLFilePath, 'utf-8')
    let jsonData = parser.toJson(XMLFileData)
    createJson(jsonData)
})

function convertToXML(filePath) {
    return new Promise(function(filePath) {
        fs.createReadStream(filePath).pipe(unzip.Extract({ path: XMLFileDirectory }))
    });
}

function createJson(jsonData) {
    fs.writeFile(jsonFilePath, JSON.stringify(jsonData, null, '    '))
}

もともと、promiseは使っておらず、

convertToXML
createJson

とただ単に順番に書いていたのですが、そうすると、すでに解凍されたxmlファイルがないとjsonを作れなかったので、promiseを使ってみました
しかしpromiseの使い方が間違ってるのか

DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

とエラーが出てしまいます
どうすればいいでしょうか

---

追記

convertToXML(originalFilePath).then(() => { console.log("success") }, () => { console.log("failure") })

このようにすると、failureって出ます。
しかし

convertToXML(originalFilePath)

function convertToXML(filePath) {
    fs.createReadStream(filePath).pipe(unzip.Extract({ path: XMLFileDirectory }))
}

これだけだと普通にできるので、

return new Promise のところが何か間違ってるみたいです

---

追記

回答を参考に色々と試してみたのですが、

function convertToXML(filePath) {

    return new Promise((resolve, reject) => {
        fs.createReadStream(filePath).pipe(unzip.Extract({ path: XMLFileDirectory })).on("end", resolve(createJson())).on("error", reject(() => { console.log("error") }))
    })

}

これで以下のエラーが出てしまいました。
これはxmlファイルが生成されてないからでしょうか

DeprecationWarning: Calling an asynchronous function without callback is deprecated.

return new Promise((resolve, reject) => {
        fs.createReadStream(filePath).pipe(unzip.Extract({ path: XMLFileDirectory })).on("end", resolve(console.log("success"))).on("error", reject(() => { console.log("error") }))
    })

createJsonをconsole.log("success")にすると、successと出てくれますのでそうゆうことなのかなと。

resolveじゃなくてthenで書いた場合も同じエラーが出ます...。

Answer 1

そうですね、Promiseまわりの扱いが原因で上手く動作しません。
具体的に言えば、resolveが発火しないのでPromiseは一生完了にならない、つまりthenが発火しません。
また、Streamはpromiseと相性が良くないので関数の中身もちゃんと考えないとまともに動かないと思います。

• Promise
• Promiseを使う

勉強が捗るように軽く解説します

まず、Promiseというのはnew Promiseとするだけあってオブジェクトです。
インスタンスを作るときの引数はfunction (resolve, reject) {}という2つの引数固定です。

インスタンス化されたPromiseは「状態」というステートを準備した後に、
Promiseのコンストラクタで代入した関数を即刻実行します。

• pending: 初期状態。成功も失敗もしていません。
• fulfilled: 処理が成功して完了したことを意味します。
• rejected: 処理が失敗したことを意味します。

代入した関数は第一引数がresolve、第二引数がrejectでしたね？
即刻実行されたこの関数は、第一引数を実行すると状態がfulfilled、第二引数を実行すればrejectedになります。
その状態の変更をトリガーに、thenやcatchメソッドが発火する仕組みになっています。

• resolve(「thenの関数の第一引数になる受け継ぎたい値」)
• reject(「エラー理由」)

---

【おまけ】 Streamに関して

fs
  .createReadStream(filePath)
  .pipe(unzip.Extract({ path: XMLFileDirectory }))

こいつが大問題ですね。
Streamは情報の流れる河を用意して、パイプで繋げて運河を設計し、
細切れのデータを少しずつ流し込む難度の高い実装です。

JSはやることリストを関数に包んだ書き置きみたいにして、
コールバック関数として保存しておくという文化で非同期処理をこなしていきますので、
fs.createReadStream云々の1行をまるっと包んでresolveに投げ込んでも、書き置きをイベント発火条件として登録し終えただけなので望むZIPファイルの解凍を待つという事は出来ません。

結局ちゃんとXMLファイルが生成された後でなきゃresolveが叩けませんので、
どこかでZIPファイルをXMLファイルに解凍し終わるメソッドを実行してresolveに繋げるような設計が必要になります。
StreamもPromiseに負けず実装が難解なので多分普通に2〜3日かかると思いますが頑張ってくださいね。

---

setIntervalとかでxmlが作られているかチェックし続けるみたいなのってどうでしょうか...

却下です。
あまりにもイケてないですし、多分速攻で0バイトのファイルを作って少しずつZIPの解凍結果を流し込んでいく実装になってる可能性があって、動くかどうかわかりません。

https://nodejs.org/api/stream.html
本家のドキュメントをちらっと見ましたが、ReadableStreamにはendやcloseのイベントが使えますので、
下記のようなコードで行けるかも知れませんね。
完全に空で書いてて動くかは分かりませんが試してみてください。

function convertToXML(filePath) {
  // filePathは既に引数として束縛済なので、別に何もしなくてもアクセス可能
  return new Promise((resolve, reject) => {
    fs
      .createReadStream(filePath)
      .pipe(unzip.Extract({ path: XMLFileDirectory }))
      .on('end', resolve)
      .on('error', reject);
  });
}

Comments

[退会済みユーザー]

ありがとうございます
とても難しいです...
setIntervalとかでxmlが作られているかチェックし続けるみたいなのってどうでしょうか...

[miyabi-sun]

ちょっとだけヒントというか、考え方の方針としてコードを書き足しました。
これを元に頑張ってみてください。

[退会済みユーザー]

本当にありがとうございます

Answer 2

本当にご協力ありがとうざいました。
これで完全に動きました。
fs.writeFileをfs.writeFileSyncにしなきゃいけないのに気づくのにも時間がかかりました...。
ありがとうございました(T_T)

'use strict';

let fs = require('fs')
let unzip = require('unzip')
let parser = require('xml2json');

let originalFilePath = process.argv[2];

let XMLFileName = originalFilePath.replace(/^.*[\/]/, '').replace('.zip', '')
let XMLFileDirectory = '/users/*****/desktop/templatexml/' + XMLFileName + '/'
let XMLFilePath = XMLFileDirectory + 'doc.xml'

let jsonFilePath = XMLFileDirectory + 'doc.json'

convertToXML(originalFilePath)

function convertToXML(filePath) {
    fs.createReadStream(filePath).pipe(unzip.Extract({
        path: XMLFileDirectory
    })).on('close', function() {
        createJson()
    });
}

function createJson() {
    let XMLFileData = fs.readFileSync(XMLFilePath, 'utf-8')
    let jsonData = parser.toJson(XMLFileData)
    fs.writeFileSync(jsonFilePath, JSON.stringify(jsonData, null, '    '))
}