1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
|
// Package godartsass provides a Go API for the Dass Sass Embedded protocol.
//
// Use the Start function to create and start a new thread safe transpiler.
// Close it when done.
package godartsass
import (
"encoding/binary"
"encoding/json"
"errors"
"fmt"
"io"
"net/url"
"os"
"os/exec"
"path"
"strings"
"sync"
"time"
"github.com/cli/safeexec"
"github.com/bep/godartsass/internal/embeddedsassv1"
"google.golang.org/protobuf/proto"
)
const defaultDartSassEmbeddedFilename = "dart-sass-embedded"
// ErrShutdown will be returned from Execute and Close if the transpiler is or
// is about to be shut down.
var ErrShutdown = errors.New("connection is shut down")
// Start creates and starts a new SCSS transpiler that communicates with the
// Dass Sass Embedded protocol via Stdin and Stdout.
//
// Closing the transpiler will shut down the process.
//
// Note that the Transpiler is thread safe, and the recommended way of using
// this is to create one and use that for all the SCSS processing needed.
func Start(opts Options) (*Transpiler, error) {
if err := opts.init(); err != nil {
return nil, err
}
// See https://github.com/golang/go/issues/38736
bin, err := safeexec.LookPath(opts.DartSassEmbeddedFilename)
if err != nil {
return nil, err
}
cmd := exec.Command(bin)
cmd.Stderr = os.Stderr
conn, err := newConn(cmd)
if err != nil {
return nil, err
}
if err := conn.Start(); err != nil {
return nil, err
}
t := &Transpiler{
opts: opts,
conn: conn,
lenBuf: make([]byte, binary.MaxVarintLen64),
pending: make(map[uint32]*call),
}
go t.input()
return t, nil
}
// Version returns version information about the Dart Sass frameworks used
// in dartSassEmbeddedFilename.
func Version(dartSassEmbeddedFilename string) (DartSassVersion, error) {
var v DartSassVersion
bin, err := safeexec.LookPath(dartSassEmbeddedFilename)
if err != nil {
return v, err
}
cmd := exec.Command(bin, "--version")
cmd.Stderr = os.Stderr
out, err := cmd.Output()
if err != nil {
return v, err
}
if err := json.Unmarshal(out, &v); err != nil {
return v, err
}
return v, nil
}
type DartSassVersion struct {
ProtocolVersion string `json:"protocolVersion"`
CompilerVersion string `json:"compilerVersion"`
ImplementationVersion string `json:"implementationVersion"`
ImplementationName string `json:"implementationName"`
ID int `json:"id"`
}
// Transpiler controls transpiling of SCSS into CSS.
type Transpiler struct {
opts Options
// stdin/stdout of the Dart Sass protocol
conn byteReadWriteCloser
lenBuf []byte
msgBuf []byte
closing bool
shutdown bool
// Protects the sending of messages to Dart Sass.
sendMu sync.Mutex
mu sync.Mutex // Protects all below.
seq uint32
pending map[uint32]*call
}
// IsShutDown checks if all pending calls have been shut down.
// Used in tests.
func (t *Transpiler) IsShutDown() bool {
for _, p := range t.pending {
if p.Error != ErrShutdown {
return false
}
}
return true
}
// Result holds the result returned from Execute.
type Result struct {
CSS string
SourceMap string
}
// SassError is the error returned from Execute on compile errors.
type SassError struct {
Message string `json:"message"`
Span struct {
Text string `json:"text"`
Start struct {
Offset int `json:"offset"`
Column int `json:"column"`
} `json:"start"`
End struct {
Offset int `json:"offset"`
Column int `json:"column"`
} `json:"end"`
Url string `json:"url"`
Context string `json:"context"`
} `json:"span"`
}
func (e SassError) Error() string {
span := e.Span
file := path.Clean(strings.TrimPrefix(span.Url, "file:"))
return fmt.Sprintf("file: %q, context: %q: %s", file, span.Context, e.Message)
}
// Close closes the stream to the embedded Dart Sass Protocol, shutting it down.
// If it is already shutting down, ErrShutdown is returned.
func (t *Transpiler) Close() error {
t.sendMu.Lock()
defer t.sendMu.Unlock()
t.mu.Lock()
defer t.mu.Unlock()
if t.closing {
return ErrShutdown
}
t.closing = true
err := t.conn.Close()
return err
}
// Execute transpiles the string Source given in Args into CSS.
// If Dart Sass resturns a "compile failure", the error returned will be
// of type SassError.
func (t *Transpiler) Execute(args Args) (Result, error) {
var result Result
createInboundMessage := func(seq uint32) (*embeddedsassv1.InboundMessage, error) {
if err := args.init(seq, t.opts); err != nil {
return nil, err
}
message := &embeddedsassv1.InboundMessage_CompileRequest_{
CompileRequest: &embeddedsassv1.InboundMessage_CompileRequest{
Importers: args.sassImporters,
Style: args.sassOutputStyle,
Input: &embeddedsassv1.InboundMessage_CompileRequest_String_{
String_: &embeddedsassv1.InboundMessage_CompileRequest_StringInput{
Syntax: args.sassSourceSyntax,
Source: args.Source,
Url: args.URL,
},
},
SourceMap: args.EnableSourceMap,
SourceMapIncludeSources: args.SourceMapIncludeSources,
},
}
return &embeddedsassv1.InboundMessage{
Message: message,
}, nil
}
call, err := t.newCall(createInboundMessage, args)
if err != nil {
return result, err
}
select {
case call = <-call.Done:
case <-time.After(t.opts.Timeout):
return result, errors.New("timeout waiting for Dart Sass to respond; if you're running with Embedded Sass protocol < beta6, you need to upgrade")
}
if call.Error != nil {
return result, call.Error
}
response := call.Response
csp := response.Message.(*embeddedsassv1.OutboundMessage_CompileResponse_)
switch resp := csp.CompileResponse.Result.(type) {
case *embeddedsassv1.OutboundMessage_CompileResponse_Success:
result.CSS = resp.Success.Css
result.SourceMap = resp.Success.SourceMap
case *embeddedsassv1.OutboundMessage_CompileResponse_Failure:
asJson, err := json.Marshal(resp.Failure)
if err != nil {
return result, err
}
var sassErr SassError
err = json.Unmarshal(asJson, &sassErr)
if err != nil {
return result, err
}
return result, sassErr
default:
return result, fmt.Errorf("unsupported response type: %T", resp)
}
return result, nil
}
func (t *Transpiler) getCall(id uint32) *call {
t.mu.Lock()
defer t.mu.Unlock()
call, found := t.pending[id]
if !found {
panic(fmt.Sprintf("call with ID %d not found", id))
}
return call
}
func (t *Transpiler) input() {
var err error
for err == nil {
// The header is the length in bytes of the remaining message.
var l uint64
l, err = binary.ReadUvarint(t.conn)
if err != nil {
break
}
plen := int(l)
if len(t.msgBuf) < plen {
t.msgBuf = make([]byte, plen)
}
buf := t.msgBuf[:plen]
_, err = io.ReadFull(t.conn, buf)
if err != nil {
break
}
var msg embeddedsassv1.OutboundMessage
if err = proto.Unmarshal(buf, &msg); err != nil {
break
}
switch c := msg.Message.(type) {
case *embeddedsassv1.OutboundMessage_CompileResponse_:
id := c.CompileResponse.Id
// Attach it to the correct pending call.
t.mu.Lock()
call := t.pending[id]
delete(t.pending, id)
t.mu.Unlock()
if call == nil {
err = fmt.Errorf("call with ID %d not found", id)
break
}
call.Response = &msg
call.done()
case *embeddedsassv1.OutboundMessage_CanonicalizeRequest_:
call := t.getCall(c.CanonicalizeRequest.CompilationId)
resolved, resolveErr := call.importResolver.CanonicalizeURL(c.CanonicalizeRequest.GetUrl())
var response *embeddedsassv1.InboundMessage_CanonicalizeResponse
if resolveErr != nil {
response = &embeddedsassv1.InboundMessage_CanonicalizeResponse{
Id: c.CanonicalizeRequest.GetId(),
Result: &embeddedsassv1.InboundMessage_CanonicalizeResponse_Error{
Error: resolveErr.Error(),
},
}
} else {
var url *embeddedsassv1.InboundMessage_CanonicalizeResponse_Url
if resolved != "" {
url = &embeddedsassv1.InboundMessage_CanonicalizeResponse_Url{
Url: resolved,
}
}
response = &embeddedsassv1.InboundMessage_CanonicalizeResponse{
Id: c.CanonicalizeRequest.GetId(),
Result: url,
}
}
err = t.sendInboundMessage(
&embeddedsassv1.InboundMessage{
Message: &embeddedsassv1.InboundMessage_CanonicalizeResponse_{
CanonicalizeResponse: response,
},
},
)
case *embeddedsassv1.OutboundMessage_ImportRequest_:
call := t.getCall(c.ImportRequest.CompilationId)
url := c.ImportRequest.GetUrl()
imp, loadErr := call.importResolver.Load(url)
sourceSyntax := embeddedsassv1.Syntax_value[string(imp.SourceSyntax)]
var response *embeddedsassv1.InboundMessage_ImportResponse
var sourceMapURL string
// Dart Sass expect a browser-accessible URL or an empty string.
// If no URL is supplied, a `data:` URL wil be generated
// automatically from `contents`
if hasScheme(url) {
sourceMapURL = url
}
if loadErr != nil {
response = &embeddedsassv1.InboundMessage_ImportResponse{
Id: c.ImportRequest.GetId(),
Result: &embeddedsassv1.InboundMessage_ImportResponse_Error{
Error: loadErr.Error(),
},
}
} else {
response = &embeddedsassv1.InboundMessage_ImportResponse{
Id: c.ImportRequest.GetId(),
Result: &embeddedsassv1.InboundMessage_ImportResponse_Success{
Success: &embeddedsassv1.InboundMessage_ImportResponse_ImportSuccess{
Contents: imp.Content,
SourceMapUrl: sourceMapURL,
Syntax: embeddedsassv1.Syntax(sourceSyntax),
},
},
}
}
err = t.sendInboundMessage(
&embeddedsassv1.InboundMessage{
Message: &embeddedsassv1.InboundMessage_ImportResponse_{
ImportResponse: response,
},
},
)
case *embeddedsassv1.OutboundMessage_LogEvent_:
if t.opts.LogEventHandler != nil {
var logEvent LogEvent
e := c.LogEvent
if e.Span != nil {
u := e.Span.Url
if u == "" {
u = "stdin"
}
u, _ = url.QueryUnescape(u)
logEvent = LogEvent{
Type: LogEventType(e.Type),
Message: fmt.Sprintf("%s:%d:%d: %s", u, e.Span.Start.Line, e.Span.Start.Column, c.LogEvent.GetMessage()),
}
} else {
logEvent = LogEvent{
Type: LogEventType(e.Type),
Message: e.GetMessage(),
}
}
t.opts.LogEventHandler(logEvent)
}
case *embeddedsassv1.OutboundMessage_Error:
err = fmt.Errorf("SASS error: %s", c.Error.GetMessage())
default:
err = fmt.Errorf("unsupported response message type. %T", msg.Message)
}
}
// Terminate pending calls.
t.sendMu.Lock()
defer t.sendMu.Unlock()
t.mu.Lock()
defer t.mu.Unlock()
t.shutdown = true
isEOF := err == io.EOF || strings.Contains(err.Error(), "already closed")
if isEOF {
if t.closing {
err = ErrShutdown
} else {
err = io.ErrUnexpectedEOF
}
}
for _, call := range t.pending {
call.Error = err
call.done()
}
}
func (t *Transpiler) newCall(createInbound func(seq uint32) (*embeddedsassv1.InboundMessage, error), args Args) (*call, error) {
t.mu.Lock()
id := t.seq
req, err := createInbound(id)
if err != nil {
t.mu.Unlock()
return nil, err
}
call := &call{
Request: req,
Done: make(chan *call, 1),
importResolver: args.ImportResolver,
}
if t.shutdown || t.closing {
t.mu.Unlock()
call.Error = ErrShutdown
call.done()
return call, nil
}
t.pending[id] = call
t.seq++
t.mu.Unlock()
switch c := call.Request.Message.(type) {
case *embeddedsassv1.InboundMessage_CompileRequest_:
c.CompileRequest.Id = id
default:
return nil, fmt.Errorf("unsupported request message type. %T", call.Request.Message)
}
return call, t.sendInboundMessage(call.Request)
}
func (t *Transpiler) sendInboundMessage(message *embeddedsassv1.InboundMessage) error {
t.sendMu.Lock()
defer t.sendMu.Unlock()
t.mu.Lock()
if t.closing || t.shutdown {
t.mu.Unlock()
return ErrShutdown
}
t.mu.Unlock()
out, err := proto.Marshal(message)
if err != nil {
return fmt.Errorf("failed to marshal request: %s", err)
}
// Every message must begin with a varint indicating the length in bytes of
// the remaining message.
reqLen := uint64(len(out))
n := binary.PutUvarint(t.lenBuf, reqLen)
_, err = t.conn.Write(t.lenBuf[:n])
if err != nil {
return err
}
n, err = t.conn.Write(out)
if n != len(out) {
return errors.New("failed to write payload")
}
return err
}
type call struct {
Request *embeddedsassv1.InboundMessage
Response *embeddedsassv1.OutboundMessage
importResolver ImportResolver
Error error
Done chan *call
}
func (call *call) done() {
select {
case call.Done <- call:
default:
}
}
func hasScheme(s string) bool {
u, err := url.ParseRequestURI(s)
if err != nil {
return false
}
return u.Scheme != ""
}
|