Forem: kanthakran

GITHUB ACTION (Quick guide)

kanthakran — Fri, 11 Nov 2022 09:01:25 +0000

**
This article is written as a reminder of myself, if you can put this to good use, you are welcome to comment to add content.

What is GITHUB ACTION

it is CICD of Github .
like a normal CICD in the world but it can integrate some action on git for example push , release tag , create branch , delete branch etc ...

How it work ?

If you imagine deploying typically requires writing a script and using a machine to run . yes that it !

Hint machine for run script it naming runner

Github jest provide share server for run your script (CICD)

But you can register runner for run it

The components of GitHub Actions

in work flow it have 5 component

Workflows : Workflows are defined in the .github/workflows directory in a repository
Events : An event is a specific activity in a repository that triggers a workflow run
Jobs : A job is a set of steps in a workflow that execute on the same runner.
Actions : An action is a custom application for the GitHub Actions platform that performs a complex but frequently repeated task
Runner : A runner is a server that runs your workflows when they're triggered.

Example work flow

This workflow use for deploy cloudfront aws . it trigger when published release tag start with releases-prod/*

Why i use when published release tag
because when deploy project it should mark version of deployment example

releases-prod/v1.0.1 : when deploy production it check if in below work flow
releases-staging/v1.0.1 : when deploy staging it check if in below work flow
releases-develop/v1.0.1 : when deploy develop it check if in below work flow

Repo/.github/workflows/main.yml

When you create this file in the repo, it will be triggered by itself when you do something that matches the event you set.

hint: uses for call SDK on Github action example gcloud,aws ,huawei etc..

name: Node.js CICD
on:
  release:
    types: [published]

jobs:
  deploy-prod: # jobs name deploy-prod
    runs-on: ubuntu-latest # script run on ubuntu
    if: startsWith( github.ref, 'refs/tags/releases-prod/')
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v2
        with:
          node-version: '14'
      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID_PROD }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY_PROD }}
          aws-region: ap-southeast-2

      - name: yarn install
        run: yarn

      - name: test
        run: yarn test

      - name: build production
        run: yarn build:production

      - name: aws sync s3
        run: aws s3 sync ./build s3://my-hello-aws --acl public-read

      - name: deploy aws cloudfront
        run: aws cloudfront create-invalidation --distribution-id MY_DISTRIBUTE_ID --paths '/*'

      - name: print
        run: echo "deploy PROD"

#------------ deploy staging ------------
  deploy-staging: 
    runs-on: ubuntu-latest
    if: startsWith( github.ref, 'refs/tags/releases-staging/')
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v2
        with:
          node-version: '14'
      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID_PROD }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY_PROD }}
          aws-region: ap-southeast-2

      - name: yarn install
        run: yarn

      - name: build staging
        run: yarn build:staging

      - name: aws sync s3
        run: aws s3 sync ./build s3://my-hello-aws --acl public-read

      - name: deploy aws cloudfront
        run: aws cloudfront create-invalidation --distribution-id MY_DISTRIBUTE_ID --paths '/*'

      - name: print
        run: echo "deploy STAGING test"

#------------ deploy develop ------------

  deploy-develop: 
    # needs: build-develop
    runs-on: ubuntu-latest
    if: startsWith( github.ref, 'refs/tags/releases-develop/')
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v2
        with:
          node-version: '14'
      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID_DEVELOP }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY_DEVELOP }}
          aws-region: ap-southeast-2

      - name: yarn install
        run: yarn

      - name: build development
        run: yarn build:development

      - name: aws sync s3
        run: aws s3 sync ./build s3://my-hello-aws --acl public-read

      - name: deploy aws cloudfront
        run: aws cloudfront create-invalidation --distribution-id MY_DISTRIBUTE_ID --paths '/*'

      - name: print
        run: echo "deploy develop test"

Secret manager

${{ secrets.AWS_ACCESS_KEY_ID_PROD }} this value store in secret manager Github can config in below image .when you use it in CICD command it will replace by ****** for hidden.

Example log

Easy roll back

When you bomb yourself in the new version.
you can click action and rerun action for roll back follow image

click rerun all jobs for rollback to old version

Try it on your self

Reference

Deploy contract with Hardhat th.

kanthakran — Tue, 08 Mar 2022 10:15:30 +0000

บทความนี้เหมาะสำหรับคนที่มีความรู้เรื่องการ deploy smart contract อยู่แล้ว

แต่ปัญหาที่เจอ Hardhat ไม่ support บาง chain เช่น klaytn ใช้ truffle เหมือนเดิมดีกว่า

Hardhat vs Truffle

ส่วนตัวผมนั้นเคยใช้ Truffle เป็นประจำอยู่แล้ว จากประสบการณ์ การเขียน smart contract มันมี step เดิมๆ ที่ต้องใช้ tool 2 ตัวนี้

test
run test chain (อาจจะใช้ ganache หรือ testnet ก็ได้)
complie
deploy

Setup Hardhat

ใช้ npm ธรรมดาเลย

npm install --save-dev hardhat

Debug

ข้อดีของ hardhat เวลา debug เราสามารถใช้ console.log ได้เลยซึ่จะมีในตัวอย่างตอนที่เราสร้างขึ้นมาตาม command ข้างล่าง

Command

Create project

npx hardhat

ตรงนี้แล้วแต่จะเลือกเลยจะใช้ อะไรผมชอบ typescript

Compile

npx hardhat compile

Test

npx hardhat test

Run test chain

npx hardhat node

Config Hardhat

https://hardhat.org/config/

Deploy contract

npx hardhat run scripts/sample-script.js
or
npx hardhat run scripts/sample-script.js --network localhost 
# สำหรับเลือก network

หลังจาก deploy มัน auto verify code ให้เลยถ้าจะปิดหาวิธีเองนะ

สรุป

รวมๆ เป็น tool ที่ครบเครื่องมากๆ ในการ dev ไม่ว่าจะเป็นตัว plugin verify code, ตัว run chain test , test lib ต่างๆ รวมถึงตัว debug สุดล้ำ

ข้อเสียอย่างเดียวเลยคือ ไม่ได้ support ทุก chain แต่จะ dev ในนี้ไป deploy ใน truffle ก็ไม่เสียหาย hardhat ก็เทสไปใช้เท่าที่ใช้ได้ 555

Starport CLI

kanthakran — Fri, 21 Jan 2022 08:34:44 +0000

เป็น CLI ที่ build อยู่บน cosmos SDK

มันคืออะไร

มันเป็นเครื่องมือที่ใช้ในการสร้าง บำรุงรักษา blockchain โดยเฉพาะโดยใช้ Cosmos SDK และ Tendermint ตัวมันเองถูกเขียนด้วยภาษา go

Install Starport

curl https://get.starport.network/starport! | bash
sudo mv starport /usr/local/bin/

เริ่มต้นสร้าง chain เบื้องต้น (ทำตามตัวอย่างที่เค้าให้มา)

starport scaffold chain github.com/cosmonaut/hello
sudo mv starport /usr/local/bin/

คำสั่งนี้สร้าง Cosmos SDK blockchain ที่เรียกว่า Hello ใน dir hello ประกอบด้วย blockchain ที่พร้อมใช้งานเบื้องต้นให้เรา

staking (opens new window)(for delegated proof of stake)
bank (opens new window)(for fungible token transfers between accounts)
gov (opens new window)(for on-chain governance)

ภายใน hello ประกอบด้วย

File/directory	Purpose
app/	Files that wire together the blockchain. The most important file is app.go that contains type definition of the blockchain and functions to create and initialize it.
cmd/	The main package responsible for the CLI of compiled binary.
docs/	Directory for project's documentation. By default, an OpenAPI spec is generated.
proto/	Protocol buffer files describing the data structure.
testutil/	Helper functions for testing.
vue/	.A Vue 3 web app template.
x/	Cosmos SDK modules and custom modules.
config.yml	A configuration file for customizing a chain in development.

ในตอนนี้เราก็สามารถทำให้บล็อกเชนของคุณทำงานบนโหนดเดียวได้แล้ว (แค่ node.เดียวนะ)

Start a Blockchain

starport chain serve

เสร็จแล้วแค่นี้ละ
🌍 Tendermint node: http://0.0.0.0:26657
🌍 Blockchain API: http://0.0.0.0:1317
🌍 Token faucet: http://0.0.0.0:4500

0.0.0.0 ไปหา ip เครื่องมาใส่ลองเข้าไปดู เล่นได้เล่นดี

Cloud function ลองเล่น

kanthakran — Thu, 07 Jan 2021 18:35:32 +0000

มันคืออะไร

มันคือ FaaS = Function as a service พูดง่ายๆ เหมือนเขียน function ไว้บน gcloud เพื่อทำอะไรตามใจเรารักสามารถทำงานคู่กับหลายๆ อย่างบน gcloud ได้ตัวมันเองนั้นทำงานแบบ async และ serverless สามารถ scale ได้แบบอัตโนมัต
ซึ่งสามารถเขียนได้หลายภาษา

nodejs
python
go
java
.NET

การเก็บเงินของ Cloud Function

จะเก็บเงินตามที่เราเรียกใช้มันเท่านั้นโดยคิดตามเวลาในการประมวลผลโดยถ้าเราไม่ใช้ก็จะไม่เสียเงินจะดีกว่าการที่เราไปตั้ง host เพราะต้องเสียเงินตลอด
ดูราคาได้เลยยย
https://cloud.google.com/functions/pricing

เริ่มทดลองกันเลย

ในตัวอย่างนี้เราจะมาเล่นโดยใช้ nodejs

เมื่อเข้ามาแล้วกด create function ได้เลย

อันนี้อะไรก็ได้เลย

ตรงส่วนนี้ผมรู้สึงว่าน่าสนใจตัว trigger ค่อนข้างหลากหลายมากๆ แต่ขอเล่น http แล้วกันง่ายดี 55

ขอเลือกแบบไม่ต้อง authen เพราะแค่ลองเล่นกด save โลด

พอถึงหน้านี้แล้วรู้สึกได้ถึงความคุ้นเคย ใช่แล้วมัน express ชัดๆ
ดูค่อนข้างง่ายกับการใช้งานมากๆเลย
ส่วน package.json ใครจะลงอะไรก็ไป set dependency โลด

ในตัวอย่างลองเพิ่ม upper case เข้าไป

แล้วเรียกใช้ใน index แล้วกด Deploy ได้เลย
ใช้เวลานานนิดหน่อยนะ

เราได้หน้าประมาณนี้

สามารถลองยิงได้ผ่าน url ในหน้า trigger หรือเราจะหน้า test ก็ได้นะ

ผลคือ HELLO เพราะ upper case

และมันยังมีอะไรอีกมากมายไปลองเองนะ

log
Runtime environment variables,Build environment variables
permission
ฯลฯ

Deploy แบบ gcloud Command-Line Tool ก็ทำได้นะง่ายด้วย

https://cloud.google.com/functions/docs/quickstart

สิ่งที่ cloud function ทำได้นั้นดูค่อนข้างหลากหลายมากเลยครับ

ตัวอย่าง Function Notify

function notify อาจจะเป็น sms , mail ก็ดูไม่แย่นะ ลองดูตัวอย่างการประยุกต์จากลิ๊งข้างล่างเลย
https://firebase.google.com/docs/functions/use-cases

ความเห็นส่วนตัว

cloud function ค่อนข้างใช้เวลาน้อยมาในการเขียน function เพื่อทำงานบางอย่าง ง่ายในการเรียนรู้ และดูสามารถนำไปประยุกต์งานได้หลากหลายมากๆ

Test Driven Development (TDD) th.

kanthakran — Thu, 17 Dec 2020 06:57:52 +0000

TDD คือ

การสร้าง software ใน scope สั้นๆ โดยเราจะเขียน automate test เอาไว้ให้มัน fail ก่อนเพื่อจะกำหนดการทำงานของโปรแกรมในระดับ function แล้วเขียน code เพื่อให้ผ่าน test (เขียนให้ผ่านก่อน) แล้วเรามา refactor ให้มันดีขึ้นอีกที

http://newyorkschooltalk.org/wp-content/uploads/2020/02/1_ieVWcSsJmeBbZFo6a_dL5g.png

Step

เขียน test (เพื่อให้เห็น scope ของโปรแกรมของเรา)
run ให้ fail
เขียน code เขียนให้ผ่านก่อน
เทสที่เคย fail จะ pass จากการเขียน code
Refactor แก้ไข ให้ดีขึ้น

ข้อดี

มั่นใจของเก่าไม่พัง
debug ง่าย
requirement ไม่หาย
เราจะสามารถมั่นใจได้ว่าโปรแกรมทำงานได้ตรงตามที่เราเขียนจริงๆ

ข้อเสีย

นานเพราะต้องศึกษา
เสียเวลาเขียนเทสวุ่นเว้อ
ใช้ประสบการณ์สูง
ประเมิณเวลายาก เพราะต้องรวมเวลาเขียน test

สรุป

มันน้อยใช่ไหมละที่เขียนมา ใช่น้อยมากเลยแต่จริงๆ มองภาพรวมอาจจะง่ายแต่การแตก task สิ่งที่โปรแกรมเราต้องทำให้ละเอียดพอที่จะเขียน test แต่แรกนั้นต้องใช้เวลาในการฝึก การคิด test case ที่ครอบคลุมมากพอก็ไม่ใช่เรื่องง่าย การเขียน code ที่จะทำให้เราสามารถ mock data เพื่อ test ก็ต้องอาศัยแนวคิด จนกระทั่ง step สุดท้าย refactor อาจจะต้องอาศัยความรู้เรื่อง clean code หรือประสบการณ์ ที่มากพอถึงจะสามารถทำออกมาได้ดีได้

อาจจะต้องใช้ ความทุ่มเท ใส่ใจ และ passion เพื่อจะเป็นมืออาชีพ

DI for test

kanthakran — Sun, 06 Dec 2020 10:59:58 +0000

บทความนี้เป็นบันทึกที่จดไว้เพื่อแชร์สิ่งที่รู้ลงไปถ้าผิดอะไรช่วยกันคอมเม้นไว้ได้นะครับ

วันนี้ผมมาในหัวข้อเรื่อง dependency injection แต่ก่อนหน้านี้หัวข้อมันคือ Structure สำหรับการ mock เพื่อ test ที่ชื่อหัวข้อแบบนี้เพราะคิดไม่ออก

สิ่งที่เราจะได้รับจากบทความนี้คือ Loose Coupling และ Dependency Injection มีความสำคัญกับการ mock เพื่อ test ยังไง ผมเป็นคนหนึ่งที่เคยพยามที่จะเขียน test ต่างๆ แต่ติดปัญหา

function นี้เป็น private เราจะ test ยังไงควรเปลี่ยน pubilc สำหรับ test ไหม
แล้วทำไมเราต้องทำ dependency injection ในเมื่อเราสามารถประกาศตัวแปลใช้ได้ตรงๆ ได้

โดย ผมจะไม่สนใจว่าการ test นี้จะเป็นการเทสแบบไหน unit หรือ integration เอาแค่ concept

สารบัญ

เกรินนำ
Tight Coupling
Loose Coupling & Dependency injection
การ mock เพื่อ automate test
สรุป

Loose coupling และ Dependency injection คืออะไร

Loose coupling คือถ้าเราไปแปลใน google มันจะแปลว่า "ข้อต่อหลวม" มันคือการเขียนโปรแกรมให้ dependency ของ class หลุดออกจากกันเพื่อ mock data เช่น

โจทย์

ถ้าผมอยากจะเขียน api get User by status
http method : GET
path : /user/status
ผมต้องการ การ get user by status จาก database
สิ่งที่ผมวางไว้คือ userRepository คือตัวจัดการเอาของออกจาก database
ส่วน userService คือตัวที่จะนำมาคำนวนต่างๆ (ตัวอย่างขอไม่มีการคำนวน)

project structure

Tight Coupling

เป็นการสร้าง dependency ที่ผูกกันติดจนยากที่จะ mock userRepository getUserByStatus เพราะเกิดการ new ใน class

เผื่อมองภาพไม่ออก การที่ userRepository ถูก new ใน class userService มันทำให้เราเข้าไปแก้ไขอะไรในนั้นได้ยาก

Loose Coupling

จากตัวอย่างด้านบนถ้าเราเอา userRepository มาใส่ใน constructor เป็น parameter มันจะเกิดการ Loose coupling เพราะ userRepository ไม่ได้ขึ้นอยู่กับ class UserService การส่งสิ่งที่เราจะใช้ผ่าน constructor ถือเป็นการทำ Dependency injection ผ่าน constructor

ใน typescript เอา private ไปใส่ใน constructor มันจะกลายเป็น property ของ class เลย

สิ่งที่เกิดขึ้นคือ เราสามารถที่จะแก้ไข class userRepository ก่อนจะส่งเข้าไปได้

การ mock เพื่อ test

(mock คือการสร้างของจำลองไว้ test)
จากด้านบนเราจะเห็นแล้วว่าการที่เราจะ mock ของนั้นจะต้องมีโครงสร้างของโปรแกรมที่ดีพอที่จะทำให้เรา mock ได้ Loose Coupling

ตัวอย่างนี้จะใช้ jest นะครับ

ผม mock getCountUserByStatus ให้ return 20 มาเลย
ถ้าใน service มีการคำนวนอะไรเราก็จะสามารถ expect ค่านั้นได้เลย

สรุป

การ mock เพื่อ test นั้นจำเป็นต้องวางโครงสร้างของโปรแกรมให้ดีเพื่อที่การ mock เพื่อ test จะได้ทำได้ง่าย ไม่ว่าจะเป็นการแยก class ให้ดี หรือการทำ dependency injection ก็ตามถ้าเรา loose coupping ก็ไม่จำเป็นต้องเปลี่ยน function หรือ property เป็น public เพื่อเทส (เพราะมันไม่ควรทำ)

ผิดถูกยังไง comment ได้นะครับ

Clean code (TH.)

kanthakran — Thu, 12 Nov 2020 11:04:15 +0000

บทความนี้เป็นการสรุปเนื้อหาเท่าที่ผู้อ่านเข้าใจจากหนังสือ
CleanCode ของ Robert C martin หรือลุง Bob

Introduction
1. Clean code คืออะไร
2. Bad code
3. หนี้สินทาง software คืออะไร
4. แนวคิดเรื่อง Clean code (สำคัญ)
หลักการการทำ Clean code
1. Meaningful Name
2. Function
3. Comments
4. Formatting

Introduction

บทความนี้เป็นการสรุปหนังสือ Clean Code Robert C. Martin
ตามความเข้าใจหากผิดพลาดช่วย Comment กัได้นะเออ

Clean code คืออะไร

Clean code คือ code สะอาดครับ คำว่าสะสาดอาจจะหมายถึง อ่านง่าย แก้ไขง่าย ต่อยอดง่าย แต่เราจะทำยังไงให้มันได้อย่างที่เราบอกกันละ ก่อนอื่นเราต้องรู้จัก Bad code กันก่อน

Bad code

เราอาจจะเคยต้องอ่านโค๊ทต่อจากคนอื่น หรือ เราไม่ได้ทำ Project นั้นนานๆ แล้วกลับมาอ่านสิ่งที่เราจะเจอ

ตัวแปลตัวนี้คืออะไรวะ dowData อ่านชื่อแล้วงง
function นี้มันทำอะไรวะ genAcTcUserSta
อ่าน code แล้วต้องลงไปดูใน function เพราะชื่อไม่สื้อ
เรา check if เพื่ออะไรวะ for ตรงนี้ไม่เห็นจำเป็นต้องมีนิ
บางตัวแปลไม่ได้ใช้ประกาศทำไม
ฯลฯ

สิ่งเหล่านี้ที่เราเจอมาล้วนเป็นหนี้สินทาง software ทั้งสิ้น

หนี้สินทาง software คืออะไร

มันคือสิ่งที่ทำให้เราช้าลง เพราะหนี้สินล้วนมีดอกเบี้ย สิ่งที่จะเกิดผลกระทบ

เวลาในการศึกษา code นั้นๆ จะมากขึ้น เช่น มีคนใหม่เข้าทีมอ่านทีหัวแตก (learning curve สูง)
การแก้ไขโปรแกรมทำได้ยาก ไม่ว่าจะเพิ่ม feature หรือ fix bug
เขียน test ยาก (ถึงกับไม่รู้จะเขียนยังไง)
อ่านยากมากๆ อ่าน code แล้วอยากลาออก
ฯลฯ

วันหนึ่งจะมีคนพูดว่า "ถ้าอ่านยากขนาดนี้ เขียนใหม่ยังง่ายกว่า"

แนวคิดเรื่อง Clean code

ถ้าเราถามว่า code ทำงานได้ กับ code สวย อะไรสำคัญกว่ากัน
หลายคนคงตอบไม่ยากว่า งานเสร็จ code ทำงานได้สำคัญกว่าอยู่แล้ว
ความเร็วในการออกของสำคัญมากยิ่งเราอยู่ในโลกของ agile และ scrum

ผมก็จะบอกว่าถูกครับ

เรามองว่า Clean code เป็นสิ่งเล็กๆ แต่คุณลองคิดถึงเวลาคุณมีบ้าน ที่ประตูปิดไม่สนิท เวลาปิดมีเสียง เอี๊ยดดดๆ เหมือนในหนังผี กระเบื้องห้องน้ำเรียงมั่ว ก๊อกน้ำน้ำรั่ว
บางปลั๊กไม่มีไฟ ถามว่าเป็นบ้านไหม เป็น อยู่ได้ไหม ก็อยู่ได้ แต่ทุกสิ่งที่กล่าวมาล้วนปัดเป่าเสน่ของบ้านทั้งสิ้น

จงให้ความสำคัญกับสิ่งเล็กๆ ในสิ่งเล็กๆ ล้วนสำคัญ
คนธรรมดากับมืออาชีพ ต่างกันที่ความใส่ใจในรายระเอียด

แต่เรามักถูกบีบด้วยเวลา และคนเดินมาเร่งมากมาย เวลาเกิดปัญหาเราก็จะบอกว่า

ผมมีเวลาแค่นี้ครับ
ได้แค่นี้ก็หรูแล้ว
มันทำงานได้ก็โอเคร

จริงๆ แล้วไม่ใช่แค่ Programmer ที่จะต้องเข้าใจในคำว่า หนี้สินทาง software ขอเรียก software debt คำนี้มันเกิดตอนที่ ลุง Robert C. Martin อธิบายให้หัวหน้าฟังเพราะบริษัทที่ทำงานนั้นเกี่ยวกับด้านการเงินเลยเกิดคำนี้มาเพื่อให้หัวหน้าเข้าใจ มันแปลว่าหัวหน้า , PM ใครก็แล้วแต่ที่สั่งเรา ต้องเข้าใจ
ในเรื่อง software debt ด้วยเพื่อใช้ในการประเมิณเวลาในการทำด้วย

หลักการในการ Clean Code

Meaningful Names

การตั้งชื่อ

Use Intention-Revealing Names

ชื่อทุกสิ่งที่เราตั้งล้วนต้องมีความหมาย บ่งบอกถึงเจตนาของสิ่งนั้นๆ อย่างชัดเจน เช่น class function val หากชื่อพวกนั้นต้องการ comment แสดงว่าชื่อนั้นยังไม่บอกเจตนาอย่างชัดเจน

// Day of week
var dow 

or

var dayOfWeek

Use Pronounceable Names

ชื่อต้องอ่านออกเสียงได้ หลีกเลี่ยงการใช้

number series : a1 a2 a3

Noise words are another meaningless distinction

ลองนึกภาพว่าคุณมี product class. หากคุณมีชื่ออื่นที่เรียกว่า ProductInfo หรือ ProductData คุณได้สร้างชื่อให้แตกต่างกันโดยไม่ทำให้มีความหมายแตกต่างกัน ข้อมูลและข้อมูลเป็นสัญญาณรบกวนที่ไม่ชัดเจน
คำเช่น a, an และ this
อย่ากลัวที่จะตั้งชื่อยาวหากชื่อนั้นสร้างความแตกต่างอย่างมีความหมายได้

Noise words are redundant

ไม่ควรใส่ type ของตัวแปลไปหลังชื่อ เช่น nameString, dateLong เพื่อเลี่ยงการปิดเบือนข้อมูลเหมือน accountList ด้านบน และ

เพราะว่า IDE สมัยนี้หากเราเอาเมาส์ไปชี้ก็จะแสดง type ให้อยู่แล้วถ้าไม่ใช้ตัวแปร dynamic type

Avoid Disinformation

หลีกเลี่ยงการทำเกิดความเข้าใจผิด หรือทำให้ความหมายเปลี่ยนแปลง ต่างจากความหมายที่เราตั้งใจไว้ เช่น hp,aix, sco ทั้งหมดนี้ล้วนเป็นชื่อของ platfrom linux

การตั้งชื่อโดยใส่คำว่า list accountList การตั้งชื่อแบบนี้เสี่ยงต่อการเข้าใจผิดได้ง่ายว่ามันคือ รายการบัญชีหรือกลุ่มของบัญชีหรือเปล่า เราอาจจะใช้ accounts สำหรับ array account หรือ accountGroup สำหรับกลุ่มของ account

Make Meaningful Distinctions

ทำให้มีความหมายอย่างแตกต่างบางครั้งการตั้งชื่อให้แตกต่างกันมันก็ยาก ตัวแปรบางตัวที่ชื่อเหมือนกันจะโดนฟ้องโดยคอมไพเรอให้เปลี่ยนชื่อ

Use Searchable Names

ใช้ชื่อที่ search ได้ หลีกเลี่ยงการใช้ ตัวอักษรตัวเดียว และ ควรใช้ Constants แทน ตัวเลข มันไม่ง่ายเลยที่เราจะหาตัว i ที่เราตั้งการใน โปรเจค

หรือเราจะหาตัวเลข 1 ในโปรเจค ควรตั้ง constant แทน เช่น MAX_DRIVER_IN_CAR

Avoid Encodings

เลี่ยงการใช้ตัวย่อ เพราะว่ายากต่อการเข้าใจและออกเสียงไม่ได้ คิดถึงหนังสือพิมพ์ นย พตรอ นพ อะไรวะงงเยอะไปหมด

Member perfixes

เลี่ยงการใช้คำนำหน้าเช่น m_student ถ้า function เราเล็กพอสิ่งนี้จะไม่เกิดแน่นอน

Class Names

ควรเป็นคำนามเท่านั้น ห้ามใช้กริยา

Method Names

ควรเป็นกริยาเท่านั้น ห้ามเป็นคำนาม

Don't Be Cute

อย่าอวดฉลาดตั้งชื่อตัวแปลเท่ๆ เช่น Eureka ,phoenix, Aileen (แปลว่าแสงสว่าง)

Pick one word per concept

เป็นการนิยามชื่อ protocalManager และ ProtocolController ดูเหมือนกันเลยแต่จะเอาอันไหนละ

Use Solution Domain Name

ใช้การต่อชื่อไปอย่างสอดคล้องกัน createPluralDependentMessageParts
หากทำไม่ได้การเพิ่ม name space ไว้ข้างหน้าจะเป็นทางออกสุดท้าย

Function

Small ต้องเล็ก

1 บรรทัดไม่เกิน 150 อักษร
1 function ไม่ควรเกิน 100 บรรทัด
แต่จะให้ดี ไม่เกิน 20 บรรทัด

Blocks and Indenting

if else if else while statement ไม่ควรเกิน 1 บรรทัด หากเกินควรแยก function

Do One Thing

1 function ควรทำแยกสิ่งเดียว

Function Arguments

ควรน้อยที่สุดเท่าที่เปิดไปได้ และไม่ควรเกิน 3 ถ้าเกินเราอาจจะสร้าง class มารองรับ

Verbs and Keywords

เลือกชื่อที่ดีเป็นกริยาสำหรับ function

Have No Side Effects

function เราต้องไม่มี side effects เพราะหากมีเราจะรู้เลยว่า function เราไม่ได้ทำสิ่งเดียว Do One Thing

public class UserValidator {
 private Cryptographer cryptographer;
 public boolean checkPassword(String userName, String password) {
       User user = UserGateway.findByName(userName);
 if (user != User.NULL) {
       String codedPhrase = user.getPhraseEncodedByPassword();
       String phrase = cryptographer.decrypt(codedPhrase, password);
       if ("Valid Password".equals(phrase)) {
        Session.initialize();
       return true;
     }
   }
 return false;
}

code จาก clean code :Rovert C matin หน้าที่ 44

Extract Try/Catch Blocks

การ try catch ลงใน function เลยอาจจะทำให้ดูน่าเกลียด
หากเราไม่แยกการทำงานของ function ให้ทำงานเพียงอย่างเดียว
(ในการ try catch ควรมีแค่ function เดียวการทำงานเดียวที่เราดัก)

don't
ในตัวอย่างนี้เราจะเห็นได้ว่าเรา try catch ในหลาย function อาจจะทำให้เราสับสนได้ว่า error นี้มาจากกระบวนการไหนของ flow กันแน่

function delete(page){
 try{
  deletePage(page);
  registry.deleteReference(page.name);
  configKeys.deleteKey(page.name.makeKey());
 }catch(error){
   throw Exception("can't delete page "+page.id+" error :"+error)
 }
}

function delete(page){
 try{
  deletePageAndAllReferences(page);
 }catch(error){
  throw Exception("can't delete page "+page.id+" error :"+error)
 }
}
function deletePageAndAllReferences(){
  deletePage(page);
  registry.deleteReference(page.name);
  configKeys.deleteKey(page.name.makeKey());
}

เราควร

Don’t Repeat Yourself

อย่าทำซ้ำ เช่นซ้ำซ้อนการทำงานต่างๆ duplication

Comments

code ที่ดีต้องไม่มี comment เราชอบคิดว่ามันซับซ้อนเลยต้องมี comment จริงๆ มันไม่ถูกซะทีเดียวเราควรทำให้ code ดีมากกว่าคิดว่ามันซับซ้อนอ่านยากเลยต้อง comment
comment ที่ควรเขียนมีแค่ Copyright กับ authorship statement

หรือข้อยกเว้นหากเราเขียน libary ที่ซับซ้อนมากๆ การ comment ก็ไม่แปลกอะไรแต่ทางที่ดีที่สุดคือ ทางที่เราไม่ใส่ comment

Formatting

The coding style and readability เราควรจะจัด code style ให้ตรงกัน ซึ่งสามารถกำหนดใน IDE ได้
เช่น 150 ตัวอักษรสำหรับ 1 บรรทัด ฯลฯ

ทั้งหมดทั้งมวลนี้อาจจะไม่สอดคล้องกับสิ่งที่คุณรู้เชื่อ หรือเข้าใจ คุณอาจจะไม่เห็นด้วยกับบทความนี้ทั้งหมดก็ได้เพราะหลายคนประสบห์การต่างกันอาจจะมี trick ที่เทคนิคพิเศษที่ต่างกันไป

Forem: kanthakran

GITHUB ACTION (Quick guide)

What is GITHUB ACTION

How it work ?

The components of GitHub Actions

Example work flow

Repo/.github/workflows/main.yml

Secret manager

Example log

Easy roll back

Try it on your self

Reference

Deploy contract with Hardhat th.

Hardhat vs Truffle

Setup Hardhat

Debug

Command

Create project

Compile

Test

Run test chain

Config Hardhat

Deploy contract

สรุป

Starport CLI

มันคืออะไร

Install Starport

เริ่มต้นสร้าง chain เบื้องต้น (ทำตามตัวอย่างที่เค้าให้มา)

ภายใน hello ประกอบด้วย

Start a Blockchain

Cloud function ลองเล่น

มันคืออะไร

การเก็บเงินของ Cloud Function

เริ่มทดลองกันเลย

และมันยังมีอะไรอีกมากมายไปลองเองนะ

Deploy แบบ gcloud Command-Line Tool ก็ทำได้นะง่ายด้วย

สิ่งที่ cloud function ทำได้นั้นดูค่อนข้างหลากหลายมากเลยครับ

ตัวอย่าง Function Notify

ความเห็นส่วนตัว

Test Driven Development (TDD) th.

TDD คือ

http://newyorkschooltalk.org/wp-content/uploads/2020/02/1_ieVWcSsJmeBbZFo6a_dL5g.png

Step

ข้อดี

ข้อเสีย

สรุป

DI for test

สารบัญ

Loose coupling และ Dependency injection คืออะไร

โจทย์

project structure

Tight Coupling

Loose Coupling

การ mock เพื่อ test

สรุป

Clean code (TH.)

Table Of Contents

Introduction

Clean code คืออะไร

Bad code

หนี้สินทาง software คืออะไร

แนวคิดเรื่อง Clean code

หลักการในการ Clean Code

Meaningful Names

Use Intention-Revealing Names

Use Pronounceable Names

number series : a1 a2 a3

Noise words are another meaningless distinction

Noise words are redundant

Avoid Disinformation

Make Meaningful Distinctions

Use Searchable Names

Avoid Encodings

Member perfixes

Class Names

Method Names

Don't Be Cute

Pick one word per concept

Use Solution Domain Name

Function