mirror of
https://github.com/wavetermdev/waveterm.git
synced 2025-11-27 20:50:25 +08:00
Removes the embedded Docusaurus build from the application. The help view now always loads from https://docs.waveterm.dev/ instead of serving a locally bundled copy. This eliminates package size constraints on documentation content (e.g., videos) and removes unnecessary build/packaging overhead. **Backend changes:** - Deleted `pkg/docsite` package entirely - Removed docsite handler from `pkg/web/web.go` - Simplified `emain/docsite.ts` to return constant URL instead of probing for embedded docs **Frontend changes:** - Removed embedded URL translation logic from `helpview.tsx` - Homepage URL now uses constant instead of IPC call **Build configuration:** - Removed `docsite:build:embedded` task and all references - Removed `dist/docsite/**/*` from electron-builder asarUnpack - Removed `build-embedded` script from docs package.json Net result: -141 lines, +9 lines across 8 files. <!-- START COPILOT CODING AGENT SUFFIX --> <details> <summary>Original prompt</summary> > right now we build a docusaurus project to run both the online docs at docs.waveterm.dev AND to embed into the application. but this limits what we can show in the docs (especially large things like videos etc.) > > the internal docs already fall back to the website when it cannot find the embedded docs. > > i'd like to update the build and packaging etc to no longer build the embedded doc site. i'd also like to have the "help" view always render the live doc site at https://docs.waveterm.dev. </details> <!-- START COPILOT CODING AGENT TIPS --> --- 💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more [Copilot coding agent tips](https://gh.io/copilot-coding-agent-tips) in the docs. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: sawka <2722291+sawka@users.noreply.github.com>
504 lines
15 KiB
Go
504 lines
15 KiB
Go
// Copyright 2025, Command Line Inc.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package web
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/base64"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"io/fs"
|
|
"log"
|
|
"net"
|
|
"net/http"
|
|
"os"
|
|
"path/filepath"
|
|
"strconv"
|
|
"time"
|
|
|
|
"github.com/google/uuid"
|
|
"github.com/gorilla/mux"
|
|
"github.com/wavetermdev/waveterm/pkg/aiusechat"
|
|
"github.com/wavetermdev/waveterm/pkg/authkey"
|
|
"github.com/wavetermdev/waveterm/pkg/filestore"
|
|
"github.com/wavetermdev/waveterm/pkg/panichandler"
|
|
"github.com/wavetermdev/waveterm/pkg/remote/fileshare"
|
|
"github.com/wavetermdev/waveterm/pkg/schema"
|
|
"github.com/wavetermdev/waveterm/pkg/service"
|
|
"github.com/wavetermdev/waveterm/pkg/util/utilfn"
|
|
"github.com/wavetermdev/waveterm/pkg/wavebase"
|
|
"github.com/wavetermdev/waveterm/pkg/wshrpc"
|
|
"github.com/wavetermdev/waveterm/pkg/wshrpc/wshclient"
|
|
"github.com/wavetermdev/waveterm/pkg/wshrpc/wshserver"
|
|
"github.com/wavetermdev/waveterm/pkg/wshutil"
|
|
)
|
|
|
|
type WebFnType = func(http.ResponseWriter, *http.Request)
|
|
|
|
const TransparentGif64 = "R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7"
|
|
|
|
// Header constants
|
|
const (
|
|
CacheControlHeaderKey = "Cache-Control"
|
|
CacheControlHeaderNoCache = "no-cache"
|
|
|
|
ContentTypeHeaderKey = "Content-Type"
|
|
ContentTypeJson = "application/json"
|
|
ContentTypeBinary = "application/octet-stream"
|
|
|
|
ContentLengthHeaderKey = "Content-Length"
|
|
LastModifiedHeaderKey = "Last-Modified"
|
|
|
|
WaveZoneFileInfoHeaderKey = "X-ZoneFileInfo"
|
|
)
|
|
|
|
const HttpReadTimeout = 5 * time.Second
|
|
const HttpWriteTimeout = 21 * time.Second
|
|
const HttpMaxHeaderBytes = 60000
|
|
const HttpTimeoutDuration = 21 * time.Second
|
|
|
|
const WSStateReconnectTime = 30 * time.Second
|
|
const WSStatePacketChSize = 20
|
|
|
|
type WebFnOpts struct {
|
|
AllowCaching bool
|
|
JsonErrors bool
|
|
}
|
|
|
|
func copyHeaders(dst, src http.Header) {
|
|
for key, values := range src {
|
|
for _, value := range values {
|
|
dst.Add(key, value)
|
|
}
|
|
}
|
|
}
|
|
|
|
type notFoundBlockingResponseWriter struct {
|
|
w http.ResponseWriter
|
|
status int
|
|
headers http.Header
|
|
}
|
|
|
|
func (rw *notFoundBlockingResponseWriter) Header() http.Header {
|
|
return rw.headers
|
|
}
|
|
|
|
func (rw *notFoundBlockingResponseWriter) WriteHeader(status int) {
|
|
if status == http.StatusNotFound {
|
|
rw.status = status
|
|
return
|
|
}
|
|
rw.status = status
|
|
copyHeaders(rw.w.Header(), rw.headers)
|
|
rw.w.WriteHeader(status)
|
|
}
|
|
|
|
func (rw *notFoundBlockingResponseWriter) Write(b []byte) (int, error) {
|
|
if rw.status == http.StatusNotFound {
|
|
// Block the write if it's a 404
|
|
return len(b), nil
|
|
}
|
|
if rw.status == 0 {
|
|
rw.WriteHeader(http.StatusOK)
|
|
}
|
|
return rw.w.Write(b)
|
|
}
|
|
|
|
func handleService(w http.ResponseWriter, r *http.Request) {
|
|
bodyData, err := io.ReadAll(r.Body)
|
|
if err != nil {
|
|
http.Error(w, "Unable to read request body", http.StatusBadRequest)
|
|
return
|
|
}
|
|
defer r.Body.Close()
|
|
if r.Method != http.MethodPost {
|
|
http.Error(w, "Invalid request method", http.StatusMethodNotAllowed)
|
|
return
|
|
}
|
|
var webCall service.WebCallType
|
|
err = json.Unmarshal(bodyData, &webCall)
|
|
if err != nil {
|
|
http.Error(w, fmt.Sprintf("invalid request body: %v", err), http.StatusBadRequest)
|
|
}
|
|
|
|
rtn := service.CallService(r.Context(), webCall)
|
|
jsonRtn, err := json.Marshal(rtn)
|
|
if err != nil {
|
|
http.Error(w, fmt.Sprintf("error serializing response: %v", err), http.StatusInternalServerError)
|
|
}
|
|
w.Header().Set(ContentTypeHeaderKey, ContentTypeJson)
|
|
w.Header().Set(ContentLengthHeaderKey, fmt.Sprintf("%d", len(jsonRtn)))
|
|
w.WriteHeader(http.StatusOK)
|
|
w.Write(jsonRtn)
|
|
}
|
|
|
|
func marshalReturnValue(data any, err error) []byte {
|
|
var mapRtn = make(map[string]any)
|
|
if err != nil {
|
|
mapRtn["error"] = err.Error()
|
|
} else {
|
|
mapRtn["success"] = true
|
|
mapRtn["data"] = data
|
|
}
|
|
rtn, err := json.Marshal(mapRtn)
|
|
if err != nil {
|
|
return marshalReturnValue(nil, fmt.Errorf("error serializing response: %v", err))
|
|
}
|
|
return rtn
|
|
}
|
|
|
|
func handleWaveFile(w http.ResponseWriter, r *http.Request) {
|
|
zoneId := r.URL.Query().Get("zoneid")
|
|
name := r.URL.Query().Get("name")
|
|
offsetStr := r.URL.Query().Get("offset")
|
|
var offset int64 = 0
|
|
if offsetStr != "" {
|
|
var err error
|
|
offset, err = strconv.ParseInt(offsetStr, 10, 64)
|
|
if err != nil {
|
|
http.Error(w, fmt.Sprintf("invalid offset: %v", err), http.StatusBadRequest)
|
|
}
|
|
}
|
|
if _, err := uuid.Parse(zoneId); err != nil {
|
|
http.Error(w, fmt.Sprintf("invalid zoneid: %v", err), http.StatusBadRequest)
|
|
return
|
|
}
|
|
if name == "" {
|
|
http.Error(w, "name is required", http.StatusBadRequest)
|
|
return
|
|
|
|
}
|
|
file, err := filestore.WFS.Stat(r.Context(), zoneId, name)
|
|
if err == fs.ErrNotExist {
|
|
w.WriteHeader(http.StatusNoContent)
|
|
return
|
|
}
|
|
if err != nil {
|
|
http.Error(w, fmt.Sprintf("error getting file info: %v", err), http.StatusInternalServerError)
|
|
return
|
|
}
|
|
jsonFileBArr, err := json.Marshal(file)
|
|
if err != nil {
|
|
http.Error(w, fmt.Sprintf("error serializing file info: %v", err), http.StatusInternalServerError)
|
|
}
|
|
// can make more efficient by checking modtime + If-Modified-Since headers to allow caching
|
|
dataStartIdx := file.DataStartIdx()
|
|
if offset >= dataStartIdx {
|
|
dataStartIdx = offset
|
|
}
|
|
w.Header().Set(ContentTypeHeaderKey, ContentTypeBinary)
|
|
w.Header().Set(ContentLengthHeaderKey, fmt.Sprintf("%d", file.Size-dataStartIdx))
|
|
w.Header().Set(WaveZoneFileInfoHeaderKey, base64.StdEncoding.EncodeToString(jsonFileBArr))
|
|
w.Header().Set(LastModifiedHeaderKey, time.UnixMilli(file.ModTs).UTC().Format(http.TimeFormat))
|
|
if dataStartIdx >= file.Size {
|
|
w.WriteHeader(http.StatusOK)
|
|
return
|
|
}
|
|
for offset := dataStartIdx; offset < file.Size; offset += filestore.DefaultPartDataSize {
|
|
_, data, err := filestore.WFS.ReadAt(r.Context(), zoneId, name, offset, filestore.DefaultPartDataSize)
|
|
if err != nil {
|
|
if offset == 0 {
|
|
http.Error(w, fmt.Sprintf("error reading file: %v", err), http.StatusInternalServerError)
|
|
} else {
|
|
// nothing to do, the headers have already been sent
|
|
log.Printf("error reading file %s/%s @ %d: %v\n", zoneId, name, offset, err)
|
|
}
|
|
return
|
|
}
|
|
w.Write(data)
|
|
}
|
|
}
|
|
|
|
func serveTransparentGIF(w http.ResponseWriter) {
|
|
gifBytes, _ := base64.StdEncoding.DecodeString(TransparentGif64)
|
|
w.Header().Set("Content-Type", "image/gif")
|
|
w.WriteHeader(http.StatusOK)
|
|
w.Write(gifBytes)
|
|
}
|
|
|
|
func handleLocalStreamFile(w http.ResponseWriter, r *http.Request, path string, no404 bool) {
|
|
if no404 {
|
|
log.Printf("streaming file w/no404: %q\n", path)
|
|
// use the custom response writer
|
|
rw := ¬FoundBlockingResponseWriter{w: w, headers: http.Header{}}
|
|
|
|
// Serve the file using http.ServeFile
|
|
path, err := wavebase.ExpandHomeDir(path)
|
|
if err == nil {
|
|
http.ServeFile(rw, r, filepath.Clean(path))
|
|
// if the file was not found, serve the transparent GIF
|
|
log.Printf("got streamfile status: %d\n", rw.status)
|
|
if rw.status == http.StatusNotFound {
|
|
serveTransparentGIF(w)
|
|
}
|
|
} else {
|
|
serveTransparentGIF(w)
|
|
}
|
|
} else {
|
|
path, err := wavebase.ExpandHomeDir(path)
|
|
if err != nil {
|
|
http.Error(w, err.Error(), http.StatusBadRequest)
|
|
}
|
|
http.ServeFile(w, r, path)
|
|
}
|
|
}
|
|
|
|
func handleRemoteStreamFile(w http.ResponseWriter, req *http.Request, conn string, path string, no404 bool) error {
|
|
client := wshserver.GetMainRpcClient()
|
|
streamFileData := wshrpc.CommandRemoteStreamFileData{Path: path}
|
|
route := wshutil.MakeConnectionRouteId(conn)
|
|
rpcOpts := &wshrpc.RpcOpts{Route: route, Timeout: 60 * 1000}
|
|
rtnCh := wshclient.RemoteStreamFileCommand(client, streamFileData, rpcOpts)
|
|
return handleRemoteStreamFileFromCh(w, req, path, rtnCh, rpcOpts.StreamCancelFn, no404)
|
|
}
|
|
|
|
func handleRemoteStreamFileFromCh(w http.ResponseWriter, req *http.Request, path string, rtnCh <-chan wshrpc.RespOrErrorUnion[wshrpc.FileData], streamCancelFn func(), no404 bool) error {
|
|
firstPk := true
|
|
var fileInfo *wshrpc.FileInfo
|
|
loopDone := false
|
|
defer func() {
|
|
if loopDone {
|
|
return
|
|
}
|
|
// if loop didn't finish naturally clear it out
|
|
utilfn.DrainChannelSafe(rtnCh, "handleRemoteStreamFile")
|
|
}()
|
|
ctx := req.Context()
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
if streamCancelFn != nil {
|
|
streamCancelFn()
|
|
}
|
|
return ctx.Err()
|
|
case respUnion, ok := <-rtnCh:
|
|
if !ok {
|
|
loopDone = true
|
|
return nil
|
|
}
|
|
if respUnion.Error != nil {
|
|
return respUnion.Error
|
|
}
|
|
if firstPk {
|
|
firstPk = false
|
|
if respUnion.Response.Info == nil {
|
|
return fmt.Errorf("stream file protocol error, fileinfo is empty")
|
|
}
|
|
fileInfo = respUnion.Response.Info
|
|
if fileInfo.NotFound {
|
|
if no404 {
|
|
serveTransparentGIF(w)
|
|
return nil
|
|
} else {
|
|
return fmt.Errorf("file not found: %q", path)
|
|
}
|
|
}
|
|
if fileInfo.IsDir {
|
|
return fmt.Errorf("cannot stream directory: %q", path)
|
|
}
|
|
w.Header().Set(ContentTypeHeaderKey, fileInfo.MimeType)
|
|
w.Header().Set(ContentLengthHeaderKey, fmt.Sprintf("%d", fileInfo.Size))
|
|
continue
|
|
}
|
|
if respUnion.Response.Data64 == "" {
|
|
continue
|
|
}
|
|
decoder := base64.NewDecoder(base64.StdEncoding, bytes.NewReader([]byte(respUnion.Response.Data64)))
|
|
_, err := io.Copy(w, decoder)
|
|
if err != nil {
|
|
log.Printf("error streaming file %q: %v\n", path, err)
|
|
// not sure what to do here, the headers have already been sent.
|
|
// just return
|
|
return nil
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func handleStreamLocalFile(w http.ResponseWriter, r *http.Request) {
|
|
path := r.URL.Query().Get("path")
|
|
if path == "" {
|
|
http.Error(w, "path is required", http.StatusBadRequest)
|
|
return
|
|
}
|
|
no404 := r.URL.Query().Get("no404")
|
|
handleLocalStreamFile(w, r, path, no404 != "")
|
|
}
|
|
|
|
func handleStreamFile(w http.ResponseWriter, r *http.Request) {
|
|
conn := r.URL.Query().Get("connection")
|
|
if conn == "" {
|
|
conn = wshrpc.LocalConnName
|
|
}
|
|
path := r.URL.Query().Get("path")
|
|
if path == "" {
|
|
http.Error(w, "path is required", http.StatusBadRequest)
|
|
return
|
|
}
|
|
no404 := r.URL.Query().Get("no404")
|
|
data := wshrpc.FileData{
|
|
Info: &wshrpc.FileInfo{
|
|
Path: path,
|
|
},
|
|
}
|
|
rtnCh := fileshare.ReadStream(r.Context(), data)
|
|
err := handleRemoteStreamFileFromCh(w, r, path, rtnCh, nil, no404 != "")
|
|
if err != nil {
|
|
log.Printf("error streaming file %q %q: %v\n", conn, path, err)
|
|
http.Error(w, fmt.Sprintf("error streaming file: %v", err), http.StatusInternalServerError)
|
|
}
|
|
}
|
|
|
|
func WriteJsonError(w http.ResponseWriter, errVal error) {
|
|
w.Header().Set(ContentTypeHeaderKey, ContentTypeJson)
|
|
w.WriteHeader(http.StatusOK)
|
|
errMap := make(map[string]interface{})
|
|
errMap["error"] = errVal.Error()
|
|
barr, _ := json.Marshal(errMap)
|
|
w.Write(barr)
|
|
}
|
|
|
|
func WriteJsonSuccess(w http.ResponseWriter, data interface{}) {
|
|
w.Header().Set(ContentTypeHeaderKey, ContentTypeJson)
|
|
rtnMap := make(map[string]interface{})
|
|
rtnMap["success"] = true
|
|
if data != nil {
|
|
rtnMap["data"] = data
|
|
}
|
|
barr, err := json.Marshal(rtnMap)
|
|
if err != nil {
|
|
WriteJsonError(w, err)
|
|
return
|
|
}
|
|
w.WriteHeader(http.StatusOK)
|
|
w.Write(barr)
|
|
}
|
|
|
|
type ClientActiveState struct {
|
|
Fg bool `json:"fg"`
|
|
Active bool `json:"active"`
|
|
Open bool `json:"open"`
|
|
}
|
|
|
|
func WebFnWrap(opts WebFnOpts, fn WebFnType) WebFnType {
|
|
return func(w http.ResponseWriter, r *http.Request) {
|
|
defer func() {
|
|
recErr := panichandler.PanicHandler("WebFnWrap", recover())
|
|
if recErr == nil {
|
|
return
|
|
}
|
|
if opts.JsonErrors {
|
|
jsonRtn := marshalReturnValue(nil, recErr)
|
|
w.Header().Set(ContentTypeHeaderKey, ContentTypeJson)
|
|
w.Header().Set(ContentLengthHeaderKey, fmt.Sprintf("%d", len(jsonRtn)))
|
|
w.WriteHeader(http.StatusOK)
|
|
w.Write(jsonRtn)
|
|
} else {
|
|
http.Error(w, recErr.Error(), http.StatusInternalServerError)
|
|
}
|
|
}()
|
|
if !opts.AllowCaching {
|
|
w.Header().Set(CacheControlHeaderKey, CacheControlHeaderNoCache)
|
|
}
|
|
w.Header().Set("Access-Control-Expose-Headers", "X-ZoneFileInfo")
|
|
|
|
// Handle CORS preflight OPTIONS requests without auth validation
|
|
if r.Method == http.MethodOptions {
|
|
w.WriteHeader(http.StatusOK)
|
|
return
|
|
}
|
|
|
|
err := authkey.ValidateIncomingRequest(r)
|
|
if err != nil {
|
|
w.WriteHeader(http.StatusUnauthorized)
|
|
w.Write([]byte(fmt.Sprintf("error validating authkey: %v", err)))
|
|
return
|
|
}
|
|
fn(w, r)
|
|
}
|
|
}
|
|
|
|
func MakeTCPListener(serviceName string) (net.Listener, error) {
|
|
serverAddr := "127.0.0.1:"
|
|
rtn, err := net.Listen("tcp", serverAddr)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error creating listener at %v: %v", serverAddr, err)
|
|
}
|
|
log.Printf("Server [%s] listening on %s\n", serviceName, rtn.Addr())
|
|
return rtn, nil
|
|
}
|
|
|
|
func MakeUnixListener() (net.Listener, error) {
|
|
serverAddr := wavebase.GetDomainSocketName()
|
|
os.Remove(serverAddr) // ignore error
|
|
rtn, err := net.Listen("unix", serverAddr)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error creating listener at %v: %v", serverAddr, err)
|
|
}
|
|
os.Chmod(serverAddr, 0700)
|
|
log.Printf("Server [unix-domain] listening on %s\n", serverAddr)
|
|
return rtn, nil
|
|
}
|
|
|
|
const schemaPrefix = "/schema/"
|
|
|
|
// blocking
|
|
func RunWebServer(listener net.Listener) {
|
|
gr := mux.NewRouter()
|
|
|
|
// Create separate routers for different timeout requirements
|
|
waveRouter := mux.NewRouter()
|
|
waveRouter.HandleFunc("/wave/stream-local-file", WebFnWrap(WebFnOpts{AllowCaching: true}, handleStreamLocalFile))
|
|
waveRouter.HandleFunc("/wave/stream-file", WebFnWrap(WebFnOpts{AllowCaching: true}, handleStreamFile))
|
|
waveRouter.PathPrefix("/wave/stream-file/").HandlerFunc(WebFnWrap(WebFnOpts{AllowCaching: true}, handleStreamFile))
|
|
waveRouter.HandleFunc("/wave/file", WebFnWrap(WebFnOpts{AllowCaching: false}, handleWaveFile))
|
|
waveRouter.HandleFunc("/wave/service", WebFnWrap(WebFnOpts{JsonErrors: true}, handleService))
|
|
waveRouter.HandleFunc("/wave/aichat", WebFnWrap(WebFnOpts{JsonErrors: true, AllowCaching: false}, aiusechat.WaveAIGetChatHandler))
|
|
|
|
vdomRouter := mux.NewRouter()
|
|
vdomRouter.HandleFunc("/vdom/{uuid}/{path:.*}", WebFnWrap(WebFnOpts{AllowCaching: true}, handleVDom))
|
|
|
|
// Routes that need timeout handling
|
|
gr.PathPrefix("/wave/").Handler(http.TimeoutHandler(waveRouter, HttpTimeoutDuration, "Timeout"))
|
|
gr.PathPrefix("/vdom/").Handler(http.TimeoutHandler(vdomRouter, HttpTimeoutDuration, "Timeout"))
|
|
|
|
// Routes that should NOT have timeout handling (for streaming)
|
|
gr.HandleFunc("/api/post-chat-message", WebFnWrap(WebFnOpts{AllowCaching: false}, aiusechat.WaveAIPostMessageHandler))
|
|
|
|
// Other routes without timeout
|
|
gr.PathPrefix(schemaPrefix).Handler(http.StripPrefix(schemaPrefix, schema.GetSchemaHandler()))
|
|
|
|
handler := http.Handler(gr)
|
|
if wavebase.IsDevMode() {
|
|
originalHandler := handler
|
|
handler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
origin := r.Header.Get("Origin")
|
|
if origin != "" {
|
|
w.Header().Set("Access-Control-Allow-Origin", origin)
|
|
}
|
|
w.Header().Set("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, OPTIONS")
|
|
w.Header().Set("Access-Control-Allow-Headers", "Content-Type, X-Session-Id, X-AuthKey, Authorization, X-Requested-With, Accept, x-vercel-ai-ui-message-stream")
|
|
w.Header().Set("Access-Control-Expose-Headers", "X-ZoneFileInfo, Content-Length, Content-Type, x-vercel-ai-ui-message-stream")
|
|
w.Header().Set("Access-Control-Allow-Credentials", "true")
|
|
|
|
if r.Method == "OPTIONS" {
|
|
w.WriteHeader(204)
|
|
return
|
|
}
|
|
|
|
originalHandler.ServeHTTP(w, r)
|
|
})
|
|
}
|
|
server := &http.Server{
|
|
ReadTimeout: HttpReadTimeout,
|
|
WriteTimeout: HttpWriteTimeout,
|
|
MaxHeaderBytes: HttpMaxHeaderBytes,
|
|
Handler: handler,
|
|
}
|
|
err := server.Serve(listener)
|
|
if err != nil {
|
|
log.Printf("ERROR: %v\n", err)
|
|
}
|
|
}
|