สำหรับนักพัฒนา

Site Code

Site Code — โค้ดฝั่งเซิร์ฟเวอร์ของเว็บ

เขียน TypeScript/JavaScript ที่รันบนเซิร์ฟเวอร์ของเว็บ (คล้าย functions.php ของ WordPress) — route, event, ฐานข้อมูลของตัวเอง, ผูกข้อมูลกับหน้าออกแบบ — พร้อมร่าง ทดสอบ และเผยแพร่อย่างปลอดภัย

อ่าน 9 นาทีอัปเดตล่าสุด

ดูเป็น Markdown

ในหน้านี้

Site Code คือโค้ด TypeScript / JavaScript ฝั่งเซิร์ฟเวอร์ของเว็บ เก็บในฐานข้อมูลของ CMS, รวมไฟล์ด้วย esbuild และรันใน sandbox (goja) ภายใน CMS ใช้ทำ route บนเว็บ, ฟังเหตุการณ์, ตารางข้อมูลของตัวเอง, แหล่งข้อมูลให้หน้าออกแบบ, งานเบื้องหลัง, หน้าในหลังบ้าน ฯลฯ — API ชุดเดียวกันนี้ใช้เขียน ปลั๊กอิน JavaScript ด้วย

หน้า โค้ดของเว็บไซต์#

เมนู นักพัฒนา → โค้ดของเว็บไซต์ มีแท็บ:

แท็บใช้ทำอะไร
แก้ไขโค้ดไฟล์ของโปรเจกต์ (ฉบับร่าง), ทดสอบ route, อัปโหลด/ดาวน์โหลด .zip, เผยแพร่, Safe mode
เวอร์ชันเวอร์ชันที่เคยเผยแพร่ (เก็บ 100 เวอร์ชันล่าสุด) และกู้คืน
บันทึกการทำงานlog จาก log.* / console.* และข้อผิดพลาดพร้อม stack ที่ชี้ไฟล์:บรรทัด (เก็บ 7 วัน)
ฐานข้อมูลตาราง ข้อมูล migration และ SQL console — ดู ฐานข้อมูลของ Site Code
สิทธิ์การเข้าถึงใครเรียก route / collection / action / หน้า / ตารางได้ (ผู้ดูแล override ค่าในโค้ดได้)
ค่าลับและการตั้งค่าค่าตั้งค่าและค่าลับที่โค้ดอ่านด้วย site.settings(), รายการโดเมนที่ http.fetch เรียกได้, ขีดจำกัดอีเมล/route
งานเบื้องหลังคิวงานและตารางเวลา cron
ฮุกfilter / event ทั้งหมดและผู้ฟังตามลำดับจริง
ตัวจัดรูปแบบformatter จากโค้ดและปลั๊กอิน และชื่อย่อ (alias)

สิทธิ์ที่ต้องมี#

สิทธิ์ทำอะไรได้
view_scriptsดูไฟล์ เวอร์ชัน log และสถานะ
edit_scriptsแก้/อัปโหลดไฟล์ บันทึกร่าง ทดสอบ route และแก้บล็อกโค้ดหน้าเว็บในหน้าออกแบบ
publish_scriptsเผยแพร่ กู้คืนเวอร์ชัน Safe mode — เทียบเท่าผู้ดูแลระบบ
manage_scriptsล้าง log, สิทธิ์การเข้าถึง, ค่าลับ, รายการโดเมนและขีดจำกัด
view_code_data / edit_code_dataดู / แก้ข้อมูลในฐานข้อมูลของโค้ด

ค่าเริ่มต้นมีแค่ผู้ดูแลระบบ ให้ตำแหน่งอื่นได้ที่ สิทธิ์การใช้งาน (ผู้ใช้และสิทธิ์)

โค้ดแรก: route สวัสดี#

  1. เปิด โค้ดของเว็บไซต์ แล้วสร้างไฟล์ main.ts (ไฟล์เริ่มต้นคือ main.ts ถ้าไม่มีใช้ main.js, index.ts, index.js)
  2. ใส่โค้ด:
// GET /hello/สมชาย → {"hi":"สมชาย"}
site.route('GET /hello/{name}', { access: ['*'] }, ({ request }) => ({ hi: request.params.name }));

// ข้อความธรรมดา
site.route('GET /feed.txt', { access: ['*'] }, () => ({
  status: 200, headers: { 'Content-Type': 'text/plain' }, body: 'ok',
}));

// ฟังเหตุการณ์ของระบบ (ทำงานหลังเกิดเหตุการณ์)
site.on('post.published', (post) => log.info('published', post.title, post.url));
  1. บันทึก — ระบบ build ร่างทันทีและแจ้งข้อผิดพลาดพร้อม ไฟล์:บรรทัด:คอลัมน์
  2. กด ทดสอบ route เพื่อรัน route ของร่างที่บันทึกแล้วใน sandbox (ไม่กระทบเว็บจริง แต่ใช้ฐานข้อมูลจริง)
  3. กด เผยแพร่ แล้วเปิด https://เว็บของคุณ/hello/สมชาย

ค่าเริ่มต้นของ access คือ ผู้ดูแลระบบเท่านั้น — ใส่ access: ['*'] เมื่อต้องการให้ทุกคนเรียกได้ หรือระบุ slug ของตำแหน่ง เช่น ['editor']

ร่าง → เผยแพร่#

  • บันทึก เขียนลงฉบับร่าง — เว็บจริงยังใช้เวอร์ชันที่เผยแพร่อยู่
  • เผยแพร่ build ร่างใหม่ ตรวจสิ่งที่ลงทะเบียน รัน migration ที่ค้างอยู่ แล้วเก็บเป็นเวอร์ชันใหม่ ถ้ามีปัญหาใด ๆ การเผยแพร่ถูกปฏิเสธและเวอร์ชันเดิมยังทำงานต่อ
  • เวอร์ชัน → กู้คืน ทำให้ snapshot เก่ากลับมาเป็นเวอร์ชันใหม่ (เลือกให้แทนที่ร่างด้วยได้) — การกู้คืนไม่รัน down() ของ migration
  • อัปโหลด .zip ทั้งโปรเจกต์ (รวมกับของเดิม หรือแทนที่ทั้งหมด ดูสิ่งที่จะเปลี่ยนก่อนยืนยัน) และ ดาวน์โหลดทั้งหมด เป็น .zip พร้อม anasaki.d.ts

โครงสร้างโปรเจกต์#

main.ts          ← จุดเริ่มต้น
events.ts        ← import { x } from './events'
lib/format.ts
data.json        ← import data from './data.json'
migrations/001_create_orders.ts
anasaki.d.ts     ← type ของ API ทั้งหมด (ดาวน์โหลดได้ / GET /api/v1/code/types)
  • นามสกุลที่รับ: .ts .js .mjs .json .md — ไม่เกิน 200 ไฟล์ ไฟล์ละ 512 KB รวม 2 MB
  • ไฟล์ static (2.2.0) — ไฟล์ในโฟลเดอร์ public/ (.css .js .mjs .json .svg .txt .xml .webmanifest .md) ไม่ถูก bundle แต่เสิร์ฟที่ /site-assets/<ชื่อ> จากเวอร์ชันที่เผยแพร่ site.asset('public/qr.js').url ได้ที่อยู่พร้อม ?v= (cache หนึ่งปี) และบล็อกโค้ดโหลดได้ด้วย anasaki.lib('qr') / anasaki.style('base')
  • import ได้เฉพาะพาธสัมพัทธ์ (./x, ../lib/y) และปลั๊กอิน JavaScript ที่เปิดอยู่ (import { bahtText } from 'thai') — ไม่มี node_modules ให้คัดลอกไลบรารีแบบ ES module ไว้ใน lib/
  • รองรับ ES2022 (class, async/await, optional chaining ฯลฯ) แต่ ไม่มี fetch, setTimeout, fs, process, Intl — ใช้ http.fetch แทน มี atob / btoa (2.2.0) และ toLocaleString('th-TH') แสดงปี พ.ศ. ได้ (2.1.1)

API ที่ใช้บ่อย#

db.posts.list({ type: 'post', category: 'news', perPage: 10 }); // { items, total }
db.posts.get('hello-world');                                    // ตาม slug หรือ id
cache.set('key', { any: 'json' }, 60); cache.get('key');         // cache ในหน่วยความจำ (10 MB)
crypto.uuid(); crypto.hash('sha256', 'data'); crypto.password.hash(pw);
log.info('ข้อความ', obj);                                        // → บันทึกการทำงาน

db, cache, crypto, mail, http, jobs ใช้ได้ ภายใน handler เท่านั้น เรียกที่ระดับบนสุดของไฟล์ (ตอนลงทะเบียน) จะ error

ขีดจำกัดและความปลอดภัย#

เรื่องขีดจำกัด
route / collection / action / page2 วินาทีต่อครั้ง
event handler10 วินาที
รันพร้อมกัน8 งาน — เกินรอได้ 2 วินาที แล้วตอบ 503
request body1 MB (ตั้ง maxBody ได้ถึง 5 MB)
circuit breakerhandler ที่ล้ม 20 ครั้งใน 1 นาที ถูกปิด 5 นาที
route สาธารณะ120 ครั้ง/นาที/IP (ตั้งได้)

โค้ดที่เผยแพร่แล้วทำให้เว็บมีปัญหา? เปิด Safe mode (หยุดรันโค้ดทั้งหมดบนเว็บจริงทันที) หรือถ้าเข้าหลังบ้านไม่ได้ ให้ตั้ง SITE_CODE_DISABLED=true ใน environment ของ container แล้วรีสตาร์ท

ต่อไป: แก้โค้ดใน VS Code ด้วย anasaki-code CLI · เพิ่มตารางของตัวเองที่ ฐานข้อมูลของ Site Code · เพิ่มฮุกและงานเบื้องหลังที่ ฮุก ประเภทเนื้อหา และงานเบื้องหลัง