[Quasar + Electron] node-jdbc 적용 시 발생하는 오류 해결 방법 (feat. node-java)

📢 환경

Node: v16.15.0
Quasar: v2.7.5
electron: v18.3.5
node-jdbc: v0.7.6

🚨 문제

Quasar + Electron 환경에서 node-jdbc 라이브러리를 install 및 import 하자
실행 및 빌드가 되지 않는 문제 발생.

 

이 문제는 Electron 환경에 node-java 를 사용하고자 했을 때도 똑같이 발생할 것이다. 

아래에서 설명할 문제와 해결방법은 서로 연계되고 있으니 참고.

🚨 에러 코드

...라이브러리 경로
was compiled against a different Node.js version using
NODE_MODULE_VERSION 93. This version of Node.js requires
NODE_MODULE_VERSION 103. Please try re-compiling or re-installing
the module (for instance, using `npm rebuild` or `npm install`).

🚨 해결 방법

https://stackoverflow.com/a/52796884/20975122

Node - was compiled against a different Node.js version using NODE_MODULE_VERSION 51

위 stackoverflow 방법을 참고했다.

electron rebuild 를 해주라고 되어 있다.

electron rebuild 는 Electron 프레임워크에서 사용하는 명령어이다.
Electron 은 V8 엔진을 사용한다.
버전이 달라 V8 엔진과 노드 모듈의 호환성 문제가 발생할 수 있는데,
이를 해결하기 위해 다시 빌드하는 방법이다.

electron-rebuild 라이브러리 설치

$ npm i -D electron-rebuild

node_modules 삭제

$ rm -rf node_modules

package-lock.json 삭제

$ rm package-lock.json

npm 캐시 삭제

$ npm cache clean --force

npm 라이브러리 설치

$ npm i

electron rebuild

$ ./node_modules/.bin/electron-rebuild

🚨 에러 코드

electron rebuild 중 아래와 같은 에러 코드가 발생했다.

⠙ Building module: java, Completed: 0utils.obj : error LNK2019: "__declspec(dllimport) public: class std::shared_ptr<class v8::BackingStore> __cdecl v8::ArrayBuffer::GetBackingStore(void)" (__imp_?GetBacking                 gStore@ArrayBuffer@v8@@QEAA?AV?$shared_ptr@VBackingStor
e@v8@@@std@@XZ) 외부 기호(참조 위치: "class v8::Local<class v8::ArrayBuffer> __cdecl newArrayBuffer(void *,unsigned __int64)" (?newArrayBuffer@@YA?AV?$Local@VArrayBuffer@v8@@@v8@@PEAX_K@Z) 함수)에서 확인하지 못했습니다.

🚨 해결 방법

https://github.com/joeferner/node-java/pull/532/files

Fixes utils.cpp to support electron by lygstate · Pull Request #532 · joeferner/node-java

위 node-java 이슈를 참고했다.

 

node_modules\java\src\utils.cpp 의 코드가 기존엔 아래와 같이 되어 있었다.

#if NODE_VERSION_AT_LEAST(13, 0, 0)
  v8::Local<v8::ArrayBuffer> newArrayBuffer(void* elems, size_t length) {
    v8::Local<v8::ArrayBuffer> ab = v8::ArrayBuffer::New(v8::Isolate::GetCurrent(), length);
    memcpy(ab->GetBackingStore()->Data(), elems, length);
    return ab;
  }
#elif NODE_VERSION_AT_LEAST(4, 0, 0)
  v8::Local<v8::ArrayBuffer> newArrayBuffer(void* elems, size_t length) {
    v8::Local<v8::ArrayBuffer> ab = v8::ArrayBuffer::New(v8::Isolate::GetCurrent(), length);
    memcpy(ab->GetContents().Data(), elems, length);
    return ab;
  }
#endif

대충 노드 버전별로 어떤 동작을 할 지 정의되어 있는 코드인데,
여기서 사용된 메소드들의 호환 문제 때문에 rebuild 가 되지 않는 것이다. 

 

유지보수 되고 있지 않은 라이브러리이기 때문에 직접 수정해줘야한다. 🤦‍♀️

위 코드를 아래와 같이 수정해주자.

#if NODE_VERSION_AT_LEAST(4, 0, 0)
  v8::Local<v8::ArrayBuffer> newArrayBuffer(void* elems, size_t length) {
    Nan::MaybeLocal<v8::Object> buf = Nan::NewBuffer((char*)elems, length);
    v8::Local<v8::Object> v8Buf = buf.ToLocalChecked();
    Nan::MaybeLocal<v8::Value> ab = Nan::Get(v8Buf, Nan::New<v8::String>("cause").ToLocalChecked());
    return ab.ToLocalChecked().As<v8::ArrayBuffer>();
  }
#endif

수정 후 다시 electron rebuild 해 보면 잘되는 걸 알 수 있다.

하지만, node_modules 의 코드를 직접 수정한 것이기 때문에, npm install 시 다시 원상복귀되어 버린다.
영구적으로 해당 코드를 프로젝트에 적용해야한다.

🚨 문제

수정한 node_modules 가 원상복귀되는 문제를 해결하기 위해 patch-package 라이브러리를 활용하려고 했으나,
patch-package 사용 후 빌드 시 수정된 코드가 제대로 덮어씌워지지(patch) 않는 문제를 발견했다.
이유는 추측하건데, node-java 가 node-jdbc 하위에 주입되는 라이브러리라
patch-package 가 제대로 적용이 안되는 것 같다.

🚨 해결 방법

node-java 코드를 fork 해 온 뒤, node_modules 를 직접 수정했던 것처럼 수정해서
commit, push 한다.
fork해온 repository 주소를 package.json 에 버전 대신 정의해주면 되는데,
node-jdbc 하위의 node-java 의 버전을 수정해야하는 것이기 때문에
package.json 의 overrides 속성을 사용해 정의해주면 된다.

"dependencies": {
        "jdbc": "0.7.6"
        // ...
 },
"overrides": {
        "jdbc": {
            "java": "https://github.com/doozi316/node-java.git"
        }
    },

🚨 에러 코드

수정된 라이브러리를 제대로 주입하긴 하나,
run 또는 build 시, 아래와 같은 에러 코드가 발생했다.

Node JS error: Cannot find module '../build/jvm_dll_path.json'

🚨 해결 방법

https://stackoverflow.com/a/63922730/20975122

Node JS error: Cannot find module '../build/jvm_dll_path.json'

위 stackoverflow 방법으로 해결했다.

 

원인은, 패키지 install 후 postInstall, 즉, install 이후에 어떤 기능이 동작해야하는데,
해당 기능이 동작되지 않아 발생한 문제이다. (이유는 모르겠음. 애초에 자동 실행 구현이 안되어 있는걸지도...)

install 이후에 동작해야할 기능은
node-java/postInstall.js 에 구현되어 있다.
이 파일을 수동 실행시켜주면 된다.

$ cd node_modules/java 
$ node postInstall.js

🚨 문제

위 방법을 모두 수행한 후엔, 눈에 띄는 에러는 없었지만
quasar.esm.js not found (404) 에러가 뜨며 run 이 되지 않는 문제가 발생했다.

🚨 해결 방법

아래 방법 실행 후 해결 됐다.
뭔가 이것저것 설치하고 리빌드를 자주해서 발생했던 문제인 것 같다.
아래 방법 실행 전엔, 프로젝트를 통째로 지우고 다시 clone 해온 뒤 실행시켰는데,
그 방법으로도 실행 및 빌드가 됐다.

node_modules 삭제

$ rm -rf node_modules

package-lock.json 삭제

$ rm package-lock.json

npm 캐시 삭제

$ npm cache clean --force

npm 라이브러리 설치

$ npm i