有一點規模的團隊，都需要逐漸構建自己的npm包。現在有一個比較好的解決方案Sinopia，可以快速搭建和部署私有的npm伺服器。

本文詳細記錄了我在搭建私有npm包時，遇到的問題，以及個人的思考。

1. 安裝Sinopia

安裝

首先，你要自己配置nodejs及npm的環境，然後執行

npm install -g sinopia

啟動

$ sinopia
 warn  --- config file  - .....\AppData\Roaming\sinopia\config.yaml
 warn  --- http address - http://localhost:4873/
 

連線中的文件已經寫的很詳細了，我就不重複造輪子了。

深坑預警

後來我們把私有倉庫改為了verdaccio,因為sinoipa不支援包名稱空間，詳情請見下文。

3、搭建好私有npm倉庫後遇到什麼坑？

我發現使用nrm切換到私有npm倉庫對應的源後，下載帶@ 符號的包都下載失敗，比如下載 @angular/core，就會下載失敗，這是為什麼呢，查閱了一些資料，發現這其實是Sinopia自己的bug，bug產生的原因就是：sinopia在代理到npmjs.org公有庫時將@符號轉碼為%40，致使在公有庫中找不到對應的包，返回404 ，簡單點說就是 @angular/core 代理請求的時候被轉換成了 %40angular/core，所以我們需要在代理請求發出之前將其轉回 @angular/core

4、如何解決？

修改sinopia原始碼：修改位於sinopia/lib/up-storage.js檔案第10行：將var encode = encodeURIComponen;，更改為：var encode = function(thing) {return encodeURIComponent(thing).replace(/^%40/, ‘@’);}; ,這段程式碼的含義就是將%40轉回@，於是就解決了不能下載帶有@符號的npm包的bug

5、更好的解決方案？

由於sinopia的作者已於二年前停止對sinopia的維護和升級，所以出來了一個sinopia的fork，名字叫做Verdaccio，然後由Verdaccio繼續對sinopia進行更新和維護，具體如何使用Verdaccio來構建私有npm伺服器，請見Verdaccio的github介紹

參考文件

2. 構建過程中遇到的問題：

2.1. 外網無法訪問私有sinopia伺服器

[root@webteam sysconfig]# systemctl stop firewalld.service 
[root@webteam sysconfig]# systemctl start firewalld.service 
[root@webteam sysconfig]# firewall-cmd --permanent --add-port=4873/tcp  
success
[root@webteam sysconfig]# firewall-cmd --reload
success
[root@webteam sysconfig]# 

參考文件

2.2. 開機自啟動

ascs@webteam sinopia]$ pm2 save
[PM2] Saving current process list...
[PM2] Successfully saved in /home/ascs/.pm2/dump.pm2

[[email protected] .pm2]$ pm2 startup centos
[PM2] Init System found: systemd
-----------------------------------------------------------
 PM2 detected systemd but you precised centos
 Please verify that your choice is indeed your init system
 If you arent sure, just run : pm2 startup
-----------------------------------------------------------
[PM2] To setup the Startup Script, copy/paste the following command:
sudo env PATH=$PATH:/usr/bin /usr/lib/node_modules/pm2/bin/pm2 startup centos -u ascs --hp /home/ascs
[[email protected] .pm2]$ sudo env PATH=$PATH:/usr/bin /usr/lib/node_modules/pm2/bin/pm2 startup centos -u ascs --hp /home/ascs

We trust you have received the usual lecture from the local System
Administrator. It usually boils down to these three things:

    #1) Respect the privacy of others.
    #2) Think before you type.
    #3) With great power comes great responsibility.

[sudo] password for ascs: 

2.3. 關於新增使用者失敗的問題

$ npm adduser
Username: webteam
Password:
Email: (this IS public) ([email protected])
npm ERR! code E500
npm ERR! Internal Server Error

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\Administrator\AppData\Roaming\npm-cache\_logs\2018-05-08T13_17_14_767Z-debug.log

這個問題，在檢視sinopia伺服器之後，我發現是Linux目錄許可權問題。

[ascs@webteam sinopia]$ sinopia
 warn  --- config file  - /usr/share/nginx/html/sinopia/config.yaml
 warn  --- http address - http://0.0.0.0:4873/
 error --- unexpected error: EACCES: permission denied, open '/usr/share/nginx/html/sinopia/htpasswd'
Error: EACCES: permission denied, open '/usr/share/nginx/html/sinopia/htpasswd'
    at Error (native)
 http  <-- 500, user: undefined, req: 'PUT /-/user/org.couchdb.user:webteam', error: internal server error
 error --- unexpected error: EACCES: permission denied, open '/usr/share/nginx/html/sinopia/htpasswd'
Error: EACCES: permission denied, open '/usr/share/nginx/html/sinopia/htpasswd'
    at Error (native)
 http  <-- 500, user: undefined, req: 'PUT /-/user/org.couchdb.user:webteam', error: internal server error
^C

那麼怎麼解決這個問題呢？

仔細檢視Linux提示的錯誤，考慮遠端向sinopia服務新增使用者的時候，也是向linux目錄下寫檔案的時候，這個時候的資料夾，如果沒有其他使用者的寫許可權，那麼是沒有辦法寫入的。所以就會報錯。

解決方法：

進入sinopia的父級目錄，然後將sinopia目錄的許可權提升。

[ascs@webteam sinopia]$ cd ..
[ascs@webteam html]$ su
密碼：
[root@webteam html]# chmod 757 sinopia/
[root@webteam html]# ls -al
總用量 20
drwxrwxr-x+ 19 root root 4096 5月   8 14:17 .
drwxr-xr-x.  3 root root   18 4月   3 14:22 ..
-rw-rwxr--+  1 root root  537 5月   3 16:40 50x.html
drwxr-xrwx   3 root root   40 5月   4 19:57 sinopia

2.4. 關於釋出包失敗的問題

解決了新增使用者失敗的問題，結果釋出包又出了問題，為什麼呢？

$ npm publish
npm ERR! Unexpected token u in JSON at position 0

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\Administrator\AppData\Roaming\npm-cache\_logs\2018-05-08T13_41_42_751Z-debug.log

檢視sinopia的日誌

/home/ascs/.pm2/logs/sinopia-error-1.log last 15 lines:
1|sinopia  | Error: EACCES: permission denied, open '/usr/share/nginx/html/sinopia/storage/.sinopia-db.json'
1|sinopia  |     at Error (native)
1|sinopia  |     at Object.fs.openSync (fs.js:642:18)
1|sinopia  |     at Object.fs.writeFileSync (fs.js:1348:33)
1|sinopia  |     at LocalData.sync (/usr/lib/node_modules/sinopia/lib/local-data.js:42:6)
1|sinopia  |     at LocalData.add (/usr/lib/node_modules/sinopia/lib/local-data.js:20:10)
1|sinopia  |     at updater (/usr/lib/node_modules/sinopia/lib/local-storage.js:251:27)
1|sinopia  |     at /usr/lib/node_modules/sinopia/lib/local-storage.js:582:5
1|sinopia  |     at /usr/lib/node_modules/sinopia/lib/local-fs.js:248:8
1|sinopia  |     at callback (/usr/lib/node_modules/sinopia/lib/local-fs.js:197:19)
1|sinopia  |     at onRead (/usr/lib/node_modules/sinopia/lib/local-fs.js:214:9)

沒錯，又碰上了許可權問題。老辦法，給.sinopia-db.json新增些許可權。

切換到root許可權，然後給檔案授權。

簡單粗暴的給了777，看官如果你要部署在公網上，請慎重喲。

[[email protected] storage]# chmod 777 .sinopia-db.json 
[[email protected] storage]# 
[[email protected] storage]# ls -al
總用量 4
drwxrwxrwx 3 root root  52 5月   8 21:55 .
drwxr-xrwx 3 root root  56 5月   8 21:37 ..
drwxrwxr-x 2 ascs ascs  90 5月   8 21:55 cityworks3d_cm
-rwxrwxrwx 1 root root 103 5月   8 21:55 .sinopia-db.json

再次釋出，成功！

$ npm publish
+ cityworks3d_cm@1.0.0

3. 隨之而來的問題：

3.1. npm的名稱空間問題

如果因為你起的包名與現有的包名太相近而被阻止釋出這個包，那麼找到一個獨一無二包名最簡單方法就是使用你的作用域。你可以使用@+你的npm使用者名稱加在包名前面將包劃到你的npm賬戶作用域下。比如，我的npm使用者名稱是ceejbot，所以我的作用域是@ceejbot。

在你自己的作用域下發佈一個包是免費的！你可以這樣去做：

我已經知道json-stream與現有包名太接近了，所以我需要找到一個新的名字。首先，我需要編輯我的package.json檔案，新增我的npm賬戶名來劃分一個作用域，所以：

{
    "name": "json-stream"
}

修改為：

{
    "name": "@ceejbot/json-stream"
}

然後我要釋出這個包。被劃了作用域的包預設是私有的，所以要通過—access=public 讓它變為公有的包：

> npm publish --access=public
+ @ceejbot/json-stream@1.0.0

每個人都可以向npm登錄檔中釋出公共的作用域包，但是你想釋出私有的包就要付費訂閱了。

參考文章

3.2. 生產環境中的使用

3.2.1. 容器部署

最佳實踐是將sinopia作為單獨服務部署在docker容器中

在此我製作了一個可以直接使用的Docker Image啟動容器則自動開啟服務, pm2將會守護sinopia程序

3.2.2. 版本控制

將sinopia作為公司內部npm庫還存在幾個問題

使用npm publish上傳的流程無法統一管理, 也就是無法持續整合/code review
每個版本的更新資訊完全依靠文件, 無法通過code diff追溯
以gitlab為例, 我的做法是

 將ci runner的伺服器切換至私有源, 使用npm adduser註冊一個root使用者

在sinopia伺服器上將sinopia/config.yaml中的max-users設定為-1, 禁止註冊與私自更新版本
將node庫原始碼在gitlab中建立專案 提交程式碼走PR流程
ci.yml中, build環境處理lint, unit test, production build等流程,tag環境npm publish提交版本, 保持gitlab與npm版本一致
郵件通知各組成員 庫版本更新資訊
3.2.3. 團隊使用

團隊所有成員切換npm至私有庫

推薦使用nrm庫 可以方便的切換npm源

nrm add private http://localhost:4873 # 新增源管理

nrm ls # 檢視源列表

nrm use private # 切換至該源

npm install @scope/[email protected]version --save-dev #

其它操作與npm公用庫相同

參考文章

4. 補充說明

4.1. NRM常用命令

nrm最常有的命令有 ： 
1.nrm ls 檢視已有的源 
2.nrm add <源名稱> <源地址> 新增源 
3.nrm use <源名稱>切換到現有的源
4.nrm test  測速

4.2. 使用npm安裝包

使用 npm –save 標誌下載一個包

常規: npm install pkg, 快捷方式: npm i pkg.

常規: npm i --global pkg, 快捷方式: npm i -g pkg.(全域性安裝一個包)

常規: npm i --save pkg, 快捷方式: npm i -S pkg`.(安裝一個專案依賴包，寫進dependence)

常規: npm i --save-dev pkg, 快捷方式: npm i -D pkg`.(全域性安裝一個專案開發依賴包，寫進devDependence)

舉個栗子：

npm install lodash --save

這將會在下載包檔案之前修改 package.json 檔案的依賴關係欄位。現在開啟剛才建立的 package.json 檔案我們會發現多了個 dependencies 欄位。