Showing posts with label package. Show all posts
Showing posts with label package. Show all posts

Wednesday, February 17, 2021

[Laravel - Composer] วิธีการใช้ Custom Package พร้อมกับการกำหนด Version ของ Package นั้นในไฟล์ composer.json
[Laravel - Package] How to Use Your Custom Package with Package Version in Composer File

ไฟล์ composer.json เป็นแหล่งรวมรายการ package ที่ต้องใช้ใน Laravel project

บางครั้งเราอาจจะต้อง fork package บางตัวมาจาก repository อื่น เพื่อนำมาปรับใช้กับ project ของเรา

หลังจากที่เราปรับแก้ package แล้ว เรามีวิธีตั้งค่าไฟล์ composer เพื่อเรียกใช้ package จาก branch บน repository ของเราดังนี้
  1. เพิ่มชื่อ package ของเราในส่วน require หรือ require-dev ดังนี้
    "require": {
        ...
        "{package_name}": "dev-{branch_name}",
        ...
    }
    เช่น
    "require": {
        ...
        "monolog/monolog": "dev-fix-concurrent-mkdir",
        ...
    }
  2. เพิ่ม repository ของเราในส่วน repositories ดังนี้
    "repositories": {
        ...
        {
          "type": "vcs",
          "url": "{my_repository_url}"
        },
        ...
    }
    เช่น
    "repositories": {
        ...
        {
          "type": "vcs",
          "url": "https://github.com/my_repo/monolog.git"
        },
        ...
    }

Wednesday, February 26, 2020

[Laravel - Package] การเข้ารหัสและถอดรหัสข้อความโดยใช้ SSH keys
[Laravel - Package] String Encryption and Decryption by Using SSH Keys

การเข้ารหัสและถอดรหัสข้อความโดยใช้ SSH keys ใน Laravel เราจะใช้ package ชื่อ phpseclib

สำหรับตัวอย่างการเข้ารหัสและถอดรหัสเป็นดังนี้
use phpseclib\Crypt\RSA;
...

$publicKey = 'MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCEa1ivzN/iW1wBTyT1T6uPcDKzi3HlCBCp3ro61ZxA1byilNH/TP7HW3iFAh0A0Lyk7dZ7d6Ot4jdsXc783T+Ic0n2Blfh0kCm0ci7q2qXqOLpCa6N30LQyiDofSmaLRzQlD49kjVY8GJYrdqo7lEQvBupenJzjS71LgkIqq+BeQIDAQAB';

$privateKey = 'MIICXQIBAAKBgQCEa1ivzN/iW1wBTyT1T6uPcDKzi3HlCBCp3ro61ZxA1byilNH/TP7HW3iFAh0A0Lyk7dZ7d6Ot4jdsXc783T+Ic0n2Blfh0kCm0ci7q2qXqOLpCa6N30LQyiDofSmaLRzQlD49kjVY8GJYrdqo7lEQvBupenJzjS71LgkIqq+BeQIDAQABAoGAVfYZrIYjEJ6eK3tlUppVlNgREd0EItoJdzzPSEJDHROjUSeq60DgZCpNIossqMrYq3h6M8yGxOqFcCO1qxE1nDhwMRxNYALnM8yBfVTe/RfASD7A+XLBB4HKOPPAs7HjPj6rdJpTSLxSNFXW7lMmw+AUTuI1B5TTqINWR83rewECQQDrYAXjdB9/Xg2x+tW6kBh3Dcdm12d3bTIXklfVeds4/3tvJyZkWi/FnNAkZLG40+R39xzP2s+XbN4Ul14aok4VAkEAkAXNBC++X+91esEIwTf4RTMxn7Q/m5F9j7G827bTWUJ+oPCoCnmdLth+9QfMyVboo4D7P8w+trm665+emV7i1QJBALdBZrRFh/RxdPY6VkdPw0yGFNb0JKFuCg8iKHKT0mPZPfA3qgN92C3iPofnQhumFf51DiCiuvepkmqzw1e3QFUCQEDznMYqkfzKDX1S2RPqnfj3YYXY0Gbkcm//hGDCTwaOSnVikyZGOnEKChePcPfMThaO8MCQ6CeYE4h38BrTBBECQQDDp8w+aItksMhcLGIyPRZZmlLew6ic+Pv+8fES9apzy/13MbBpxm/oPVavftLQi+6N29eTtqbE7lL1hRcdsUqn';

$plaintext = 'test';

$rsa = new RSA();

$rsa->loadKey($publicKey);
$ciphertext = $rsa->encrypt($plaintext);

$rsa->loadKey($privateKey);
echo $rsa->decrypt($ciphertext);
สำหรับตัวอย่างการ Verify key เป็นดังนี้
$plaintext = 'ThisIsTest';

$rsa = new RSA();
$rsa->loadKey($privateKey);
$signature = $rsa->sign($plaintext);

$rsa->loadKey($publicKey);
$rsa->verify($plaintext, $signature); // Throw exception if verification is failed

Wednesday, December 11, 2019

[Laravel - Package] วิธีการใช้งาน Laravel Modules
[Laravel - Package] How to Use Laravel Modules

Modules

การสร้าง Module ใหม่

php artisan module:make module_name
ยกตัวอย่าง เช่น
php artisan module:make Projects

การตั้ง namespace ของ Class

namespace namespace_name\module_name\Http\Controllers;
ยกตัวอย่าง เช่น
namespace Modules\Projects\Http\Controllers;

Tuesday, December 3, 2019

[Laravel - Package] วิธีการติดตั้งและตั้งค่า Laravel Debugbar
[Laravel - Package] How to Install and Config Laravel Debugbar

Laravel Debugbar เป็น package ที่รวม PHP Debug Bar เข้ากับ Laravel เพื่อใช้แสดงข้อมูลจากส่วนต่างๆของ Application

วิธีการติดตั้ง

  1. สั่งติดตั้ง Laravel Modules package
  2. composer require barryvdh/laravel-debugbar --dev
  3. สร้างไฟล์ config ของ package ใน project
  4. php artisan vendor:publish --provider="Barryvdh\Debugbar\ServiceProvider"
    

[Laravel - Package] วิธีการติดตั้งและตั้งค่า Laravel Modules
[Laravel - Package] How to Install and Config Laravel Modules

Laravel Modules เป็น package ที่สร้างขึ้น เพื่อจัดการ Laravel application ที่มีขนาดใหญ่ โดยการแบ่งเป็น module ย่อยๆ

วิธีการติดตั้ง

  1. สั่งติดตั้ง Laravel Modules package
  2. composer require nwidart/laravel-modules
  3. สร้างไฟล์ config ของ package ใน project
  4. php artisan vendor:publish --provider="Nwidart\Modules\LaravelModulesServiceProvider"

Wednesday, November 27, 2019

[Laravel - Package] ขั้นตอนการตั้งค่า Packagist เพื่อให้ติดตั้ง Laravel Package ผ่าน Composer ได้
[Laravel - Package] Packagist Setting Steps for Laravel Package Installation via Composer

สมมติว่า เรามี Laravel package อยู่บน Repository ใดๆ แล้วเราต้องการให้สามารถติดตั้ง package ดังกล่าวผ่าน composer ได้เลย โดยไม่ต้องตั้งค่าใดๆเพิ่ม เรามีวิธีการดังต่อไปนี้

เนื่องจาก Composer ใช้งาน Packagist repository เป็น default repository เท่านั้น (อ่านเพิ่มเติมได้ใน Composer Repositories) ขั้นตอนการตั้งค่าจึงเป็นดังนี้
  1. Login เข้า https://packagist.org/
  2. เข้าหน้าเมนู Submit
  3. ใส่ repository url กดปุ่ม Check
  4. กดปุ่ม Submit
  5. รอจน package ถูกอัพเดตเรียบร้อย
สำหรับการทดสอบ ทำได้โดยรัน command ดังนี้
composer require arzeroid/laravel-model-encryptable
ผลที่ได้จะเป็นดังนี้

[Laravel - Package] วิธีการตั้งค่า Composer เพื่อติดตั้ง Package จาก GitHub
[Laravel] How to Install Package from GitHub via Composer

สมมติว่า เรามี Laravel package ตัวนึงอยู่บน GitHub ของเราตามรูปตัวอย่างข้างล่าง


เมื่อเราต้องการนำ package นั้นมาใช้งานใน project ของเรา โดยปกติแล้ว เราจะรัน command ดังนี้
composer require arzeroid/laravel-model-encryptable

Monday, November 25, 2019

[Laravel - Package] วิธีการติดตั้งและตั้งค่า Laravel Userstamps
[Laravel - Package] How to Install and Config Laravel Userstamps

Laravel-Userstamps เป็น package สำหรับจัดการฟิลด์ created_by และ updated_by (รวมถึง deleted_by กรณีที่เปิดใช้งาน Soft Delete) ของ Laravel model โดยใช้ข้อมูลของผู้ใช้งานในขณะนั้น โดยอัตโนมัติ เมื่อมีการสร้าง แก้ไข และลบ model

วิธีการติดตั้ง

  1. สั่งติดตั้ง Laravel-Userstamps package
  2. composer require wildside/userstamps

Friday, November 22, 2019

[Laravel - Package] วิธีการติดตั้งและตั้งค่า Laravel Sluggable
[Laravel - Package] How to Install and Config Laravel Sluggable

Eloquent-Sluggable เป็น package เสริมสำหรับสร้าง Slug ภายใน Laravel Model โดยจะสร้าง Slug ใส่ฟิลด์ที่ระบุให้โดยอัตโนมัติ เมื่อมีการบันทึกข้อมูล

วิธีการติดตั้ง

  1. สั่งติดตั้ง Eloquent-Sluggable package
  2. composer require cviebrock/eloquent-sluggable
  3. สร้างไฟล์ config ของ package ใน project
  4. php artisan vendor:publish --provider="Cviebrock\EloquentSluggable\ServiceProvider"
    

[Laravel - Package] วิธีการติดตั้งและตั้งค่า Laravel Activity Log
[Laravel - Package] How to Install and Config Laravel Activity Log

laravel-activitylog เป็น package สำหรับใช้จัดเก็บ log การใช้งานของ user ยิ่งไปกว่านั้น package นี้สามารถเก็บ log จาก model event ได้โดยอัตโนมัติ

วิธีการติดตั้ง

  1. สั่งติดตั้ง laravel-activitylog package
  2. composer require spatie/laravel-activitylog
  3. สร้างไฟล์ migration ของ package ใน project
  4. php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="migrations"
    
  5. รัน migrate เพื่อสร้างตารางในฐานข้อมูล
  6. php artisan migrate
    
  7. สร้างไฟล์ config ของ package ใน project
  8. php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="config"
    

Thursday, November 21, 2019

[Laravel - Package] วิธีการติดตั้งและตั้งค่า Laravel Permission
[Laravel - Package] How to Install and Config Laravel Permission

laravel-permission เป็น package สำหรับจัดการ roles และ permissions ของ user ใน database

วิธีการติดตั้ง

  1. สั่งติดตั้ง laravel-permission package
  2. composer require spatie/laravel-permission
  3. สร้างไฟล์ migration ของ package ใน project
  4. php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider" --tag="migrations"
    
  5. รัน migrate เพื่อสร้างตารางในฐานข้อมูล
  6. php artisan migrate
    
  7. สร้างไฟล์ config ของ package ใน project
  8. php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider" --tag="config"
    

Wednesday, November 20, 2019

[Laravel - Package] การสร้าง PHPDOC สำหรับ Laravel Model
[Laravel - Package] How to Generate PHP Document for Laravel Model

เราสามารถสร้าง PHPDOC ของ Laravel Model ได้ง่ายๆ ดังนี้
  1. ติดตั้ง Package Laravel IDE Helper เข้าไปใน Project โดยรันคำสั่งต่อไปนี้
    composer require --dev barryvdh/laravel-ide-helper
    
  2. รันคำสั่งต่อไปนี้ เพื่อสร้าง PHPDOC ของ Laravel Model 
    php artisan ide-helper:models -R
    

Monday, August 5, 2019

[Laravel - Package] วิธีการเปลี่ยนข้อมูลที่ใช้สำหรับ Subject Claim ของ JWT ใน Laravel Model
[Laravel - Package] How to Change Data for Subject Claim of JWT in Laravel Model

JSON Web Token (JWT) ถูกใช้ใน stateless web application

jwt-auth เป็น JWT package ที่นิยมใช้สำหรับ Laravel framework

package นี้จะใช้ ID ของผู้ใช้งานเป็น sub claim (subject claim) โดยอัตโนมัติ

เนื่องจาก payload ของ JWT สามารถ decode ที่ใดก็ได้ โดยไม่จำเป็นต้องใช้ key ใดๆ การใช้ ID ของผู้ใช้งาน จึงทำให้เกิดปัญหาทางด้านความปลอดภัย

คุณสามารถเปลี่ยนฟิลด์ ID ของผู้ใช้งานเป็นฟิลด์อื่นด้วยวิธีตามด้านล่างนี้ เพื่อหลีกเลี่ยงปัญาด้านความปลอดภัย

Saturday, April 7, 2018

[Laravel - Package] การสร้าง Refresh Token เองจาก jwt-auth version 1.0.0-rc.1
[Laravel - Package] How to Manually Generate Refresh Token from jwt-auth version 1.0.0-rc.1

tymon/jwt-auth เป็น library สำหรับจัดการการเข้าใช้งานแบบ token โดยเวอร์ชั่นล่าสุดในตอนนี้ คือ 1.0.0-rc.1

สำหรับ access token สามารถสร้าง, ตรวจสอบและใช้งานได้อย่างปกติ แต่สำหรับการ refresh token นั้นจะผิดแปลกไปจาก library สำหรับ JWT ทั่วไป

โดยทั่วไปแล้ว หลังจากที่เรา refresh token ไปแล้ว เราจะได้ access token ใหม่ที่เริ่มนับเวลาหมดอายุรวมถึงเวลาที่สามารถทำการ refresh ใหม่ด้วย เพื่อใช้ token นั้นในระบบต่อไป โดยที่ระบบจะบังคับให้เรา login ใหม่ก็ต่อเมื่อเราไม่ได้ใช้งานระบบเป็นเวลานานจน access token หมดอายุและเลยกำหนดเวลาที่จะ refresh token ได้

สำหรับการ refresh token ของ jwt-auth นั้น access token ใหม่จะเริ่มนับเวลาหมดอายุใหม่เท่านั้น แต่เวลาที่สามารถทำการ refresh ใหม่นั้น ยังคงนับเวลาต่อจากเวลาของ token เดิม เนื่องจากเวลาสร้างของ access token ใหม่ใช้เวลาสร้างเดียวกับ access token เดิม ทำให้ไม่ว่าเราจะ refresh token ไปกี่ครั้ง ระบบก็จะบังคับให้เรา login ใหม่ เมื่อ access token ปัจจุบันหมดอายุและเลยกำหนดเวลาที่จะ refresh token ตัวแรกที่ได้หลังจาก log in ได้

Monday, August 14, 2017

[NodeJS] Optional Field ของ Joi ไม่อนุญาตค่า null และ empty string
[NodeJS] Optional Field of Joi Validator not Allow Null and Empty String

เนื่องจากใช้ HapiJS เป็น framework ของโปรเจค จึงใช้ Joi เป็น validator ซึ่งก็เหมือน Framework ตัวอื่นๆ คือ สามารถระบุได้ว่า field ใดนั้น required หรือ field ใดนั้นไม่ required

Joi มี method สำหรับการระบุข้างต้น คือ required() และ optional() ตามลำดับ ซึ่งถ้าไม่ระบุจะเป็น optional โดยอัตโนมัติ แต่มันไม่ได้จบเพียงเท่านี้ เพราะ Library ตัวนี้มีบางอย่างที่ขัดกับ validator ของ framework อื่นหลบซ่อนอยู่

สำหรับ required() จะเป็นปกติเหมือน framework ทั่วไป คือ field นั้นต้องมีค่า ซึ่งค่านั้นต้องไม่ใช่ null หรือ empty string

สำหรับ optional() จะมีความแตกต่างจาก framework อื่น คือ field นั้นต้องมีค่า (ซึ่งค่านั้นต้องไม่ใช่ null หรือ empty string) หรือ field นั้นต้องหายไปเลย (undefined) อย่างใดอย่างหนึ่งเท่านั้น

อย่างไรก็ตาม สำหรับ framework ทั่วไป ในกรณีที่ไม่ระบุว่า required ความเป็นไปได้ของ field นั้น คือ มีค่าเป็นอะไรก็ได้รวมถึง null และ empty string ด้วย หรือ field นั้นจะหายไปเลยก็ได้

จะเห็นได้ว่า Joi ต่อให้เป็น optional ก็ไม่สามารถส่งค่า null หรือ empty string มาได้ วิธีแก้ไข คือ เพิ่ม .allow(null) และ .allow('') ต่อท้าย field ที่เป็น optional ด้วย

ปล. มีคนเปิด Issue เกี่ยวกับเรื่องนี้ ให้รวมค่า null กับ empty string เป็น optional ของ Joi ด้วย แต่ก็ได้คำตอบว่า มันโคตรจะไม่ปกติเลยหรือมันไม่ใช่ common use case ซึ่งจากคำตอบก็รู้แล้วแน่ๆว่า จะไม่มีการแก้ไขเกี่ยวกับเรื่องนี้ในอนาคตแน่นอน

สำหรับข้อมูลเพิ่มเติม สามารถอ่านได้ที่
How to allow a string or null?
Joi.string().optional() doesn't treat an empty string as unset

Saturday, July 8, 2017

[NodeJS] Mongoose: connect กับ createConnection ต่างกันยังไง
[NodeJS] Mongoose: What is the Different between connect and createConnection

การเชื่อมต่อ Mongdb ผ่าน Mongoose ทำได้ 2 วิธี คือ
  1. mongoose.connect(DB_URL) เป็นการสั่งให้ default connection เชื่อมต่อไปยัง Mongodb 
  2. mongoose.createConnection(DB_URL) เป็นการสร้าง connection ใหม่ เพื่อเชื่อมต่อไปยัง Mongodb
ซึ่งทั้ง 2 วิธี มีการใช้งานแตกต่างกัน คือ
  1. mongoose.connect(DB_URL)
    mongoose.connect(DB_URL);
    let db = mongoose.connection;
    db.model(MODEL_NAME).find();
  2. mongoose.createConnection(DB_URL)
    let db = mongoose.createConnection(DB_URL);
    db.model(MODEL_NAME).find();

Saturday, June 24, 2017

[NodeJS] สรุปสิ่งที่ต้องระวังสำหรับ NodeJS Packages: Mongoose
[NodeJS] Warning for NodeJS Packages: Mongoose

เมื่อสัปดาห์ที่ผ่านมา เจอปัญหาเกี่ยวกับ node packages แบบรายวันเลย โดยเฉพาะ mongoose เลยขอบันทึกเก็บไว้หน่อย
  • Method ของ Mongoose บางอัน return Promise บางอัน return Thenable
    • พวก save, create จะ return Promise
    • พวก findXXX จะ return Thenable
    • พวกที่ return Thenable สามารถใช้ exec() ต่อ เพื่อให้ return Promise ได้
    • จะใช้อันไหนไปเช็คในเอกสารดูอีกทีนะ (Thenable ใช้ .catch ไม่ได้นะจ๊ะ)
  • Moment เวลาเซฟเป็น object ผ่าน Mongoose มันเซฟเป็นค่าตัวเลข (เดาว่า Unix Timestamp) เวลาจะใช้ก็อย่าลืมแปลงกลับไปเป็น Moment ก่อนนะ
    • ถ้าอยากให้เซฟเป็นวันที่เลย ก็ใช้ toDate() ก่อนเซฟ มันจะเซฟเป็นแบบ ISODate 
  • Error ของ Promise ถ้า catch ไว้แล้วใช้ JSON.stringify(error) จะได้ "{}" เสมอ ไม่แน่ใจว่าเป็นเฉพาะ error ของ Mongoose หรือเปล่า ถ้าอยากได้ข้อความ error ก็ต้องใช้ error.message แทนนะ