CHANGELOG.md

v2.9.1 (2024-09-18)

Features

• go: upgrade golang to v1.22.7 and some deps

Bug Fixes

• db: sql error with custom table prefix (#970)
• test: separate test db to isolate concurrent test instances (#975)
• transfer: ensure consistent time format in artrans export
• ui/plugin: prevent exceptions from blocking other plugins loading

Performance Improvements

• plugin_katex: add error message for missing katex deps

Code Refactoring

• dao: improve concurrent testing for FindCreateAction function
• go: hardcode version and get commit_hash via runtime/debug
• go: bump the module version and support go install (#979)

Testing

• mutex: add tests for keyed mutex

Documentation

• refine deployment documentation
• i18n: add English translations for docs (#978)
• landing: add multi-language and dark-mode for landing
• landing: add demo video in landing page

BREAKING CHANGE

The original Go module name was github.com/ArtalkJS/Artalk, which has now been modified to github.com/artalkjs/artalk/v2 (all lowercase). This change may affect the CI pipeline or other areas if you are compiling the Artalk server and have specified the fixed Go module name. Regarding the original -ldflags -X github.com/ArtalkJS/Artalk/internal/config.Version and CommitHash definitions, please remove them, as they are now obsolete. The Version has been hardcoded into the Go code, and the CommitHash is now read from the Go build info via runtime/debug’s vcs.revision value. This change only affects the server developers and does not impact the frontend UI client.

v2.9.0 (2024-09-03)

Features

• auth: add user profile and password changing (#966)
• config: add site_url config option (#967)
• go: upgrade golang to v1.22.6 and some deps
• ui/dashboard: new dashboard ui refresh for desktop devices (#957)
• ui/date: add dateFormatter config option (#940)
• ui/plugin: make ui plugin configurable
• ui/sidebar: add dark mode toggle for dashboard (#790)
• ui/sidebar: add page search by keywords in sidebar (#603)
• ui/sidebar: add user search by keywords in sidebar (#710)

Bug Fixes

• anti_spam: handle empty referer variable in anti-spam check (#853)
• api/auth: fix missing Microsoft oauth provider configuration (#929)
• api/auth: migrate auth_identities when account merging (#920)
• api/auth: register issue due to unremoved auth records after user deletion (#919)
• api/comment_add: improve the security of comment add api (#964)
• auth: correct email verification code send button
• plugin/lightbox: fix import for non-browser env (#931)
• plugin_kit: fix typescript lib path retrieval on win
• plugin_kit: import source path case error on linux
• sidebar: correct total item count for pagination in sidebar
• ui/dark_mode: apply dark mode config option before mounting ui (#890)
• ui/plugin-kit: fix typescript lib folder for api-extractor in monorepo
• ui/sidebar: disable admin password check dialog in sidebar
• ui/sidebar: show env variables in sidebar settings ui (#946) (#956)
• ui/stat: fix invalid backward compatible strategy (#880)
• validator: restrict to allow only HTTP protocol

Performance Improvements

• api/auth: add more specific error messages for login failures
• app/init: generate translated config file by env variable ATK_LOCALE
• auth: add loading skeleton for login methods list
• auth: enhance visibility of skip button (#863)
• auth: perform optical adjustment for consistent icon sizing
• auth: correct verify button position in register form
• i18n: auto-load frontend i18n locale js sources
• notify: improve error messages for notify (#943)
• plugin_kit: improve typescript diagnostics output
• style/sidebar: modify font-family for sidebar
• ui/sidebar: enhance i18n translations for sidebar
• ui/sidebar: mask sensitive input values in sidebar settings (#494)
• ui/sidebar: optimize setup process and i18n lazy load (#962)

Code Refactoring

• plugin_katex: use tokenizer extension of marked (#955)
• ui/deps: remove abortcontroller-polyfill (#923)
• ui/marked: replace pkg-level marked with new class instance (#954)
• ui/types: add Layer interface
• ui/user: rename nick to name in LocalUser data structure (#961)

Documentation

• auth: set auth.anonymous to false as default
• ui/i18n: add more locale support for sidebar
• ui/i18n: add translations for French, Korean, and Russian

v2.8.7 (2024-06-09)

Features

• go: upgrade golang to v1.22.3 and some deps
• plugin_kit: add vite plugin for developing artalk plugins (#904)
• sync: add keyed rw-mutex

Bug Fixes

• api/auth: include render mustache params for verification email subject (#910)
• api/stats: fix site_pv response body and add unit tests (#896)
• api/transfer_upload: close temp file in transfer upload endpoint (#877)
• auth: failed to register by social account on mysql database (#902)
• conf_env: enhance environment variable loading for config (#892)
• plugin_katex: fix event issue causing katex integration failure (#897)
• ui/height_limit: height limit issue for collapsed comments (#865)
• ui/sidebar: unable to logout if user is not admin in control center
• ui/types: remove marked dependency in dts (#868)

Performance Improvements

• conf: add cache for config metadata to boost startup speed (#892)
• dao: add singleflight for no-cache db find func
• gravatar: support both sha256 and md5 hash for gravatar (#912)
• gravatar: convert email to lowercase before hashing for gravatar
• gravatar: use sha256 hashing algorithm for gravatar (#874)
• ui/conf: exclude conf pvEl, countEl and statPageKeyAttr from remove server (#905)
• ui/dev: bump eslint to v9 (#915)

Code Refactoring

• dao: add date field to the page json entity
• dao: improve QueryDBWithCache func and concurrent unit tests (#884)
• transfer: improve the reliability of the transfer (#883)
• transfer: strip domain from page key by default (#873)
• ui: fix linter issues for ui and docs (#917)
• ui/stat: use class selector for pageview elements by default (#880)

Documentation

• refine documentation
• dev: refine contributing.md and translate to chinese
• i18n: revise French translation (#913)
• ip_region: add instructions for obtaining accurate IP under proxy

v2.8.6 (2024-05-09)

Features

• auth: user accounts merge tool (#854)
• auth: social login api endpoints (#854)
• ci: include frontend dist files in release (#860)
• i18n: add incremental updates feature for i18n code scan tool
• multi_push/lark: add card mode for lark push (#839)
• sync: add keyed mutex
• ui/auth: plugin-auth for integrating social login (#854)
• ui/img_lazyload: add support for lazy loading images (#850)

Bug Fixes

• api/pv: add mutex for page pv record endpoint
• cache/user: user id cache from email lookup not cleared
• comments_get: include site_name for isolation in associated query for comment's page
• dao: ensure find and create functions thread safe (#845)
• db/migrate: fix root_id migrate for database lacking recursive CTE support (#848) (#846)
• db_migrate: drop fk_comments_user foreign key constraint of the users table
• sidebar/site: unable to edit the new site urls
• ui/dark_mode: add support for configuring dark mode in backend (#790)
• ui/dark_mode: unable to toggle dark mode for sidebar in auto mode
• ui/height_limit: height limit not working while loading images (#849)
• ui/marked: optimize same origin link judgment logic

Documentation

• update introduction document
• auth: add social login feature (#854)
• i18n: add translation for Korean and Russian

v2.8.5 (2024-04-21)

Features

• ci/build: add nightly build workflow
• conf/http: add http.proxy_header config option
• go: upgrade golang to v1.22.2 and some deps

Bug Fixes

• cmd/gen: ensure directory before saving in gen cmd (#612)
• dao: prevent potential infinite loop in FindCommentRootID
• db/migrate: issue with root id generation
• db/migrator: remove foreign key constraints and better root_id generation (#835)
• log: improve log system and fix memory leaks (#843)
• transfer: retrieve root_id for imported comment data
• ui/comment: missing reply comment data when inserting (#838)
• ui/comment: incorrect reply comment data in nested mode (#771) (#837)
• ui/lifecycle: keep root element during destroy (#810)
• ui/sidebar: user list not refresh when data is modified
• ui/upload: unable to upload image when file extension is uppercase
• upload: add config option to solve request entity too large issue (#834)

Performance Improvements

• conf/upgit: disallow custom executable path of upgit for security (#817)
• db: optimize N+1 query in comment list (#799)
• i18n: add translation for 'parameter is required'
• ui/pkg: add shorter export names (#821)
• ui/version_check: beautify version upgrade notice

Code Refactoring

• comments_get: reduce api complexity by introducing LiteDB (#800)
• ui/prettier: add prettier code formatter

Documentation

• extras: add deploy guide for Valaxy (#836)
• i18n: add French translation (#797)

BREAKING CHANGE

For UpGit users: Due to security reasons, Artalk no longer allows configuring the executable file path (img_upload.upgit.exec) for upgit. Please add it to system environment variables instead.

v2.8.3 (2024-03-04)

Features

• api/auth: invalidate old auth tokens after changing password
• api/domain: add GET /conf/domain endpoint
• app: add onConfUpdated hook
• comment: add is_verified field for comment entity
• ui/api: add ctx.getApiHandlers() to handle error responses and expose hooks
• ui/editor: add beforeSubmit hook for editor submitting
• ui/plugins: support dynamic loading of ui plug-in scripts (#774)

Bug Fixes

• captcha/image: unable to display image captcha on initial load
• conf: skip patching IP region conf if disabled
• exception: missing message field after refactoring exception data structure
• sidebar/login: cannot select a name with the same email upon login (#781)
• ui/layer: ensure immediate operation when calling show() after hide()

Performance Improvements

• ui/editor: improve the icon details for editor

Code Refactoring

• dao: validate the args of the FindCreateUser function
• entity/user: extract CheckPassword function
• origin: extract CheckURLTrusted function

v2.8.2 (2024-02-05)

Bug Fixes

• api/comments: ua field is optional and not required (#767)
• style: replace style break-all with break-word in content el (#644)

Performance Improvements

• ui/editor: optimize editor styles for narrow-width screens
• ui/editor: modify editor plug-in text buttons to icons for brevity
• ui/editor: place Cancel Reply at the bottom of editor area (#644)
• ui/lite: disable ArtalkLite preview config option by default

v2.8.1 (2024-02-04)

Features

• api: add GET /comments/:id endpoint (#764)
• config: add db.prepare_stmt config option (#760) (#762)
• ui/goto: improved solution of navigating to comment via link hash (#693) (#765)

Bug Fixes

• api/comments: counting comments issue in PostgreSQL db (#760) (#761)
• cmd/admin: update user role to admin if already exists
• ip_region: unable to output the IP region correctly (#760)
• ui/list: unable to reply or delete comments after switching pagination
• ui/no_comment: always appears when creating comment
• ui/pv: missing pageTitle field in the PV request
• ui/scroll: scroll into view issue when relativeTo parameter is provided

Performance Improvements

• style/sidebar: improve some detail in sidebar

Code Refactoring

• ui/comment: loose coupling between Comment and Context
• ui/list: refactor the list layout manager

Documentation

• supplement and refine fe-api.md

v2.8.0 (2024-01-31)

Features

• go: upgrade golang to v1.21.5 and some deps
• notify: add notify_pending config option (#728) (#754)
• ui/admin: add logout button in admin panel (#488) (#753)

Bug Fixes

• cache: unable to change admin list after caching (#748) (#750)
• i18n: sidebar language cannot be changed
• ui/editor: prevent propagation of click event in editor (#734)
• ui/layer: unexpected behavior with multiple items when closing
• ui/lite: correct the instance name for compiling ArtalkLite (#740)
• ui/no_comment: flickering when clearing list before fetch
• ui/pagination: auto load list when scroll reaches bottom
• ui/sidebar: incorrectly increasing pv count in sidebar (#724)
• ui/sidebar_layer: sidebar still displays when login is required

Performance Improvements

• ui/conf: support for watching partial changes in config with watchConf() (#755)
• ui/i18n: refine some translation (#743)
• ui/pagination: replace the prev/next text on pagination buttons with icons (#743)
• ui/sidebar: prevent potential token leakage by clearing query in iframe url

Code Refactoring

• api: update swagger file of API v2
• api: refactor HTTP API to version 2 (#735)
• transfer: normalize transfer payload parameter name
• ui: optimize init and update lifecycle events
• ui/comment: rename class Comment to CommentNode
• ui/ctx: add getComments and getCommentNodes in context (#752)

Documentation

• update multi-sites manual (#747)

BREAKING CHANGE

For Developers: The HTTP API has now been updated to version v2, with a lot of adjustments made, such as changing to Restful API style, request type, request body, response body, etc. data structure, adding error response codes. You can refer to #735 or https://artalk.js.org/http-api Please update all your existing clients to adapt to the new v2 server. The new base path is /api/v2/. The UI package's HTTP client has been implemented to auto-generate based on Swagger.json, and there have been a lot of adjustments to the artalk.ctx.getApi() related code. In addition, the HTTP API no longer enforces checks on the header's Origin and Referer (to implement strict isolation of different sites) but still maintains the original CORS origin check.

For General Users: Now all administrators have the same level of authority (there is no longer super admin authority), the function of assigning sub-administrators with independent scope authority to individual sites has been removed, which can simplify the HTTP server maintenance and implementation. Upgrading only requires updating the client and server application at the same time, and there are no additional operations.

v2.7.3 (2023-12-28)

Features

• ci: add dry-run mode for build workflow
• cmd: support cli flag for creating admin account

Bug Fixes

• ui/init: stack overflow when merging with config defaults (#717)

Performance Improvements

• ui/build: better dts generation (#689)

Code Refactoring

• ci: better release workflow
• docker: add --build-arg argument to skip ui build
• test/ui: add more ui api tests
• ui: refactor directory structure (#712)
• ui/conf: better handling of mutable config (#722)
• ui/test: add vitest for unit testing

Documentation

• update ui api documentation

BREAKING CHANGE

Directly referencing artalk.conf and artalk.$root is deprecated. Please use functions instead: artalk.getConf() and artalk.getEl().

v2.7.2 (2023-12-20)

Features

• patch locale config from zh-cn to zh-CN (#678)

Bug Fixes

• sidebar: sidebar language switch and config save issue (#708)
• ui: add referrerpolicy attribute for iframe (#687) (#707)
• ui/dark-mode: potential memory leak issue in auto mode (#688)
• ui/pagination: auto switch page by url hashtag issue (#693)
• ui/sidebar: refactor settings and fix save issue (#677) (#706)

Code Refactoring

• ui: move window references into function scope (#675)
• ui/api: losing coupling between Api and User
• ui/user: user class no longer globally singleton

Documentation

• i18n: add translation for open button
• refactor: organize the pkgs and fix some issues (#702)

v2.7.1 (2023-12-17)

Bug Fixes

• build: generate source maps to ease debugging
• cout-widget: loadCountWidget issue
• ui: static method export issue in JS module (#669)

Documentation

• i18n: add translation of update notice

v2.7.0 (2023-12-17)

Features

• ui: support scrollRelativeTo config option
• ui/test: add end-to-end (e2e) testing using Playwright

Bug Fixes

• api/img-upload: public_path config enables the use of full url (#659) (#664)
• lifecycle: create multi-instances at the same time (#660) (#663)
• notify_pusher: panic when admin ids array is empty (#634)
• style/list: replace float to text-align in footer part (#619)
• ui: scroll to the center of the viewport issue
• ui/conf: sanitize noComment conf option for security (#624)
• ui/dark-mode: setDarkMode cannot save to instance config (#661)
• ui/editor: fix position of the comment box when replying (#643) (#648)

Performance Improvements

• cache: implement GC feature for simple_cache pkg (#656)

Code Refactoring

• editor: refactor editor plugin manager (#609)
• editor: refactor plug kit and events (#613)
• ui: reduce coupling with ContextApi
• ui: separate standalone admin-only-elem checker
• ui/api: loose coupling between Api and Context
• ui/conf: loose coupling between config and list fetch
• ui/event: refactor core event manager (#611)
• ui/layer: better layer implements and independence (#662)
• ui/list: separate list into standalone components (#618)
• ui/marked: separate markdown related codes
• ui/marked: loose coupling with marked func
• ui/plugin: further divide functionality into plugins (#615)
• ui/stat: losing coupling of CountWidget
• ui/types: better ArtalkType import and export (#620)

Documentation

• revise and add more examples
• provide clearer and more detailed instructions in CONTRIBUTING.md
• conf: disable frontend.uaBadge config option by default
• deploy: add deployment guide for render.com (#649)
• import: update the examples in import-framework.md (#665)

BREAKING CHANGE

The following top-level functions exported by the 'artalk' npm package have been deprecated: Artalk.update, Artalk.reload, and Artalk.destroy. These methods now require invocation on an instance created by either Artalk.init or new Artalk. Please utilize instance-level methods instead, such as artalkInstance.update. For more information, refer to the documentation. The update was implemented to enable the concurrent creation of multiple instances, adapting to situations where Vue components are simultaneously referenced across various pages. Initially, only a singular instance was permitted to mitigate memory leak concerns. However, this proved limiting for scenarios involving the caching of multiple component instances through 'keep-alive.' To better suit intricate SPA application needs, the choice was made to permit the creation of multiple independent instances. It's crucial to remember to manually invoke the artalk.destroy method when releasing components to avoid memory leaks (Issue #660).

v2.6.4 (2023-10-12)

Features

• go: upgrade golang to v1.21.3 and some deps

Bug Fixes

• editor: fix duplicate event binding when update conf (#605)
• email: sender not initialized correctly
• style: fix copyright text overlay on send button (#607)

Code Refactoring

• anti_spam: refactor anti_spam pkg and add unit test (#589)

v2.6.3 (2023-09-20)

Features

• config: add db.ssl to enable db ssl mode (#587)

Bug Fixes

• notify_tpl: fix template render result in notify case

Performance Improvements

• config: add error message for timezone setting (#586)

Code Refactoring

• renderer: abstract func of template renderer for multi-cases (#585)

Documentation

• new landing page

v2.6.2 (2023-09-12)

Bug Fixes

• cmd: remove app instance creation when mini boot (#577)

Performance Improvements

• style: modify z-index less than 5 (#578)

v2.6.1 (2023-09-11)

Bug Fixes

• captcha: image captcha base64 response issue (#575)

Documentation

• config: add info about env variables (#566)
• extras: add deploy guide for railway.app (#567)

v2.6.0 (2023-09-01)

Features

• config: support load env variables as config (#564)
• go: upgrade golang to v1.21.0 and some deps (#543)
• hook: add hook pkg
• simple_cache: a simple thread-safe cache with sync.Map
• utils: add common random utils

Bug Fixes

• cache: child comment ids store after comment updated
• cmd: fix parse root cmd global flags
• config: fix ip region patch
• db: fix dsn strings for mysql connections (#541)
• limiter: limiter log ignore options method req
• limiter: fix limiter always mode
• log: add missing log for web server listen func (#556)
• ui: fix plug cannot disable issue (#563)

Performance Improvements

• cmd: support command mini boot mode

Code Refactoring

• CI: replace using docker/metadata-action for the docker push (#545)
• CI: replace renovate with github dependabot (#546)
• anti_spam: refactor anti_spam pkg
• artransfer: refactor artransfer pkg
• cache: remove cached fields in struct to save memory (#555)
• cache: cache code tidy-up
• cache: refactor cache pkg
• cache: refactor cache pkg
• cache: refactor cache pkg
• captcha: refactor captcha pkg
• cloud: refactor cloud pkg
• cmd: refactor cmd pkg
• conf: better config.NewFromFile with error handle
• config: refactor config pkg
• core: refactor core pkg
• core: better AppService func with error handle
• cors: refactor cors middleware
• dao: refactor dao pkg
• dao_cache: add dao_cache pkg
• db: refactor db pkg
• email: refactor email pkg
• i18n: refactor i18n pkg
• ip_region: refactor ip_region pkg
• limiter: add limiter pkg
• log: create common log pkg
• main: refactor main.go
• notify: add notify_pusher pkg
• server/common: refactor server/common pkg
• server/handler: refactor server/handler pkg
• server/middleware: refactor server/middleware pkg
• test: create common test pkg

Documentation

• extras: add deploy guide for fly.io (#520)

v2.5.5 (2023-05-10)

Features

• build: add embedded fe lite and i18n scripts (#493) (#505)
• go: upgrade golang to v1.20.4 and some deps (#506)
• gravatar: add gravatar.params config option (#508)

Bug Fixes

• api: comment IP data loss after editing (#504)
• editor: prevent editor reset on comment failure (#507)

BREAKING CHANGE

The gravatar.default config option has been removed. Please use gravatar.params instead. The default value for gravatar.params is now "d=mp&s=240".

v2.5.4 (2023-04-09)

Features

• go: upgrade golang to v1.20.3 and some deps (#485)

Bug Fixes

• CI: upgrade and pin node.js and pnpm version (#484)

Documentation

• update swagger docs and some deps

v2.5.3 (2023-04-06)

Bug Fixes

• api/comment_add: SIGSEGV crash in comment_add (#478) (#481)

Performance Improvements

• ip_region: add db file existence check and error message (#482)

v2.5.2 (2023-03-19)

Bug Fixes

• ui: destroy instance when calling init func twice

Performance Improvements

• notify: shorten the length of notify key (#466)
• style: add !important for white-space css in code block (#467)

v2.5.1 (2023-03-16)

Features

• go: upgrade golang to v1.20.2

Bug Fixes

• ui/count-widget: context api undefined issue (#464)
• ui/i18n: duplicate packaging built-in language in the external script
• ui/paginator: showErr func call issue
• ui/sort-dropdown: dropdown menu disappears after call reload func (#461)

Code Refactoring

• anti_spam/aliyun: accessing aliyun green text api without sdk (#459)
• ui/user: modify user to standalone module (#463)

v2.5.0 (2023-03-10)

Features

• migrate from echo to go-fiber
• upgrade go to v1.20.1
• display IP region of comment (#418) (#447)
• docker ci add support for building arm64 wheels
• more functions to handle artalk lifecycle (#426)
• ui: add some static methods
• ui/height_limit: support scrollable height limit area (#451)
• ui/sidebar: add dark mode support (#450)
• captcha: add support for reCAPTCHA and hCaptcha (#456)
• captcha: support turnstile captcha by cloudflare (#453)
• i18n: add i18n support for backend (#343)
• i18n: translations for backend (#344)
• i18n: add i18n support for sidebar (#353)
• i18n: add zh-TW i18n translation for sidebar and app

Bug Fixes

• ui: hash goto function check condition issue
• ui/conf: avoid some conf overrides frontend from the backend (#449)
• ui/editor: disable img upload cannot hide its btn
• ui/i18n: subscribe event priority issue
• ui/sidebar: array type of preference initial data issue
• ui/sidebar: array type config option cannot be shown
• ui/sidebar: boolean type setting option save issue (#431) (#444)
• ui/sidebar: setting item save follow type of template
• lint: add tsc check before vite compile (#440)
• email: duplicate sending with multiple admins using same email addrs (#375)
• email: email queue initialization issue (#374)
• email: failback to email.mail_tpl if admin_notify.email.mail_tpl is empty
• timeAgo function does not display the now
• add .npmignore to fix NPM publish inclusion issue
• sidebar navigation sorting (#361)

Performance Improvements

• improve some css styles
• add graceful shutdown
• conf/i18n: detect and change locale when config file contains chinese
• ui/list: remove useless function call
• ui/sidebar: improve sidebar i18n

Code Refactoring

• bump to monorepo
• renamed from artalk-go to artalk
• http origin checker
• abstract email service
• project package structure
• remove version two-way check (#452)
• build scripts and CI tests
• replace pkger with go:embed
• launch with vscode debugger
• CI: one-key site creating with artalk integrated
• CI: improve build and release workflows (#358)
• captcha: abstract captcha service (#455)
• comment: separate comment ui renders from single file (#427)
• style: convert to use Sass as a style interpreter (#439)
• ui: automatic dependency injection (#429)
• ui/checker: simplify checker lifecycle function param table (#428)
• ui/dark-mode: separate dark mode logic into its own module (#430)
• ui/editor: modify editor ui to standalone module (#441)
• ui/editor: change functions of editor to standalone modules (#443)
• ui/height-limit: modify height limit function to standalone module (#435)
• ui/i18n: improve i18n function to standalone module (#434)
• ui/list: modify list pagination to standalone module (#437)
• page/fetch: remove goquery dependency when extracting page data (#442)
• anti_spam/qcloud-tms: implement qcloud tms api without sdk (#438)

Documentation

• migrate ArtalkJS/Docs to monorepo docs
• add CODE_OF_CONDUCT.md
• add simplified README for artalk npm package
• add translation section to CONTRIBUTING.md
• fix wrong config value (#371)
• fix broken links (#364)
• add open api (#360)
• add Project Structure section to CONTRIBUTING.md
• refine and add frontend api docs
• update setup-example-site.sh script usage
• init artalk with new frontend api
• deploy: add restart=always for docker to auto restart (#425)
• extras: add deploy guide for vuepress (#436)