Merge pull request #3 from life4/http-request

HTTPRequest

.drone.yml

@@ -16,8 +16,10 @@ steps:
       - golangci-lint run
 
   - name: test
-    image: golang
+    image: "golang:1.16.5-alpine3.13"
     commands:
-      - go mod download
-      - go install github.com/agnivade/wasmbrowsertest
-      - ./test.sh
+      - apk add --no-cache wget
+      - wget https://taskfile.dev/install.sh
+      - sh install.sh -- latest
+      - rm install.sh
+      - ./bin/task test

README.md

@@ -2,7 +2,7 @@
 
 **gweb** -- strictly typed [WebAPI](https://en.wikipedia.org/wiki/Web_API) library on top of [syscall/js](https://golang.org/pkg/syscall/js/). Like [flow](https://github.com/facebook/flow) or [TypeScript](https://www.typescriptlang.org/) but for Go. You need it if you want to interact with browser from [wasm-compiled](https://github.com/golang/go/wiki/WebAssembly) Go program.
 
-See examples on [gweb.orsinium.dev](https://gweb.orsinium.dev/).
+See examples on [gweb.orsinium.dev](https://gweb.orsinium.dev/) and [refs.md](./refs.md) for mapping of JS Web API to gweb functions.
 
 ## Features
 

Taskfile.yml

@@ -0,0 +1,40 @@
+# https://taskfile.dev
+version: '3'
+
+vars:
+  GOPATH:
+    sh: go env GOPATH
+
+tasks:
+  install:
+    cmds:
+      - go mod download
+      - go install github.com/agnivade/wasmbrowsertest
+
+  test:library:
+    deps:
+      - install
+    env:
+      GOOS: js
+      GOARCH: wasm
+    cmds:
+      - go test -exec={{.GOPATH}}/bin/wasmbrowsertest ./web/
+
+  test:examples:
+    env:
+      GOOS: js
+      GOARCH: wasm
+    cmds:
+      - rm -rf /tmp/gweb-bin
+      - mkdir -p /tmp/gweb-bin/
+      - go build -o /tmp/gweb-bin/ ./...
+
+  test:
+    desc: "run go test for the library and examples"
+    cmds:
+      - task: test:library
+      - task: test:examples
+
+  refs:
+    cmds:
+      - python3 generate_refs.py > refs.md

audio/analyser_node.go

@@ -28,7 +28,7 @@ func (analyser AnalyserNode) TimeDomain() TimeDomainBytes {
 }
 
 // FFTSize represents the window size in samples that is used
-// when performing a Fast Fourier Transform (FFT) to get frequency domain data..
+// when performing a Fast Fourier Transform (FFT) to get frequency domain data.
 // https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/fftSize
 func (analyser AnalyserNode) FFTSize() int {
 	return analyser.Get("fftSize").Int()
@@ -57,7 +57,7 @@ func (analyser AnalyserNode) SmoothingTimeConstant() float64 {
 // SETTERS
 
 // FFTSize represents the window size in samples that is used
-// when performing a Fast Fourier Transform (FFT) to get frequency domain data..
+// when performing a Fast Fourier Transform (FFT) to get frequency domain data.
 // https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/fftSize
 func (analyser AnalyserNode) SetFFTSize(value int) {
 	analyser.Set("fftSize", value)

examples/README.md

@@ -24,5 +24,5 @@ Build all:
 
 ```bash
 python3 -m pip install -r requirements.txt
-python3 build_all.py hello
+python3 build_all.py
 ```

examples/http_request/main.go

@@ -0,0 +1,18 @@
+package main
+
+import "github.com/life4/gweb/web"
+
+func main() {
+	window := web.GetWindow()
+	doc := window.Document()
+	doc.SetTitle("Making HTTP requests")
+
+	// make request
+	req := window.HTTPRequest("GET", "https://httpbin.org/get")
+	resp := req.Send(nil)
+
+	header := doc.CreateElement("pre")
+	header.SetText(string(resp.Body()))
+	body := doc.Body()
+	body.Node().AppendChild(header.Node())
+}

examples/index.yml

@@ -1,9 +1,9 @@
 categories:
-  - name: "DOM"
+  - name: DOM
     items:
-      - name: "hello"
+      - name: hello
         info: 'a small "hello world": set title, create element, add element onto the page.'
-      - name: "styling"
+      - name: styling
         info: "how to set CSS attributes for an object."
       - name: events
         info: how to handle events like mouse movement.
@@ -16,7 +16,7 @@ categories:
           how to dynamically load CSS (on example of
           [Bootstrap](https://getbootstrap.com/))
           and do something when it is ready.
-  - name: "Canvas"
+  - name: Canvas
     items:
       - name: triangle
         info: '"hello world" for `<canvas>`: make black background and draw a red triangle.'
@@ -36,12 +36,16 @@ categories:
           classic video game (famous because of clone
           [Arkanoid](https://en.wikipedia.org/wiki/Arkanoid))
           with a bit more natural (hence annoying) physic.
-  - name: "Audio"
+  - name: Audio
     items:
-      - name: "oscilloscope"
+      - name: oscilloscope
         info: "a small example of visualization of an audio from the user microphone."
-      - name: "piano"
+      - name: piano
         info: >
           play MIDI music! A good example of rendering sounds. Based on
           [Simple synth keyboard](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Simple_synth)
           MDN example.
+  - name: Networking
+    items:
+      - name: http_request
+        info: how to make an HTTP request

generate_refs.py

@@ -0,0 +1,32 @@
+import re
+from collections import defaultdict
+from pathlib import Path
+
+base_url = 'https://developer.mozilla.org/en-US/docs/Web/API/'
+doc_base_url = 'https://pkg.go.dev/github.com/life4/gweb/{package}#{obj}'
+link = re.escape(f'// {base_url}')
+rex = re.compile(rf'(?:{link}([a-zA-Z/-]+))+\nfunc \([a-z]+ \*?([a-zA-Z]+)\) ([a-zA-Z]+)')
+
+refs: dict = defaultdict(list)
+for path in Path().glob('*/*.go'):
+    content = path.read_text()
+    for match in rex.findall(content):
+        *links, struct, func = match
+        for link in links:
+            refs[link].append((path.parent.name, f'{struct}.{func}'))
+
+print("""
+# Reference
+
+Below is the mapping of web API to gweb functions.
+This file is autogenerated, so some references may be missed.
+
+| Web API | gweb |
+| ------- | ---- |
+""".strip())
+for ref, objects in sorted(refs.items()):
+    url = base_url + ref
+    ref = ref.replace('/', '.')
+    for package, obj in objects:
+        doc_url = doc_base_url.format(package=package, obj=obj)
+        print(f'| [{ref}]({url}) | [{obj}]({doc_url}) |')

go.mod

@@ -3,11 +3,10 @@ module github.com/life4/gweb
 go 1.13
 
 require (
-	github.com/agnivade/wasmbrowsertest v0.3.2 // indirect
+	github.com/agnivade/wasmbrowsertest v0.3.5 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/kr/text v0.2.0 // indirect
-	github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
-	github.com/stretchr/testify v1.5.1
-	gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
-	gopkg.in/yaml.v2 v2.2.8 // indirect
+	github.com/stretchr/testify v1.7.0
+	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
+	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
 )

go.sum

@@ -1,46 +1,55 @@
-github.com/agnivade/wasmbrowsertest v0.3.2/go.mod h1:zQt6ZTdl338xxRaMW395qccVE2eQm0SjC/SDz0mPWQI=
+github.com/agnivade/wasmbrowsertest v0.3.5 h1:U8ICR7Xa3LBGQb57HtbbXf5KAMjQhiWrCWlr1kD77Cw=
+github.com/agnivade/wasmbrowsertest v0.3.5/go.mod h1:zQt6ZTdl338xxRaMW395qccVE2eQm0SjC/SDz0mPWQI=
 github.com/chromedp/cdproto v0.0.0-20190614062957-d6d2f92b486d/go.mod h1:S8mB5wY3vV+vRIzf39xDXsw3XKYewW9X6rW2aEmkrSw=
+github.com/chromedp/cdproto v0.0.0-20190621002710-8cbd498dd7a0 h1:4Wocv9f+KWF4GtZudyrn8JSBTgHQbGp86mcsoH7j1iQ=
 github.com/chromedp/cdproto v0.0.0-20190621002710-8cbd498dd7a0/go.mod h1:S8mB5wY3vV+vRIzf39xDXsw3XKYewW9X6rW2aEmkrSw=
+github.com/chromedp/chromedp v0.3.1-0.20190619195644-fd957a4d2901 h1:tg66ykM8VYqP9k4DFQwSMnYv84HNTruF+GR6kefFNg4=
 github.com/chromedp/chromedp v0.3.1-0.20190619195644-fd957a4d2901/go.mod h1:mJdvfrVn594N9tfiPecUidF6W5jPRKHymqHfzbobPsM=
+github.com/creack/pty v1.1.9 h1:uDmaGzcdjhF4i/plgjmEsriH11Y0o7RKapEf/LDaM3w=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
-github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/edsrzf/mmap-go v1.0.0 h1:CEBF7HpRnUCSJgGUb5h1Gm7e3VkmVDrR8lvWVLtrOFw=
 github.com/edsrzf/mmap-go v1.0.0/go.mod h1:YO35OhQPt3KJa3ryjFM5Bs14WD66h8eGKpfaBNrHW5M=
+github.com/go-interpreter/wagon v0.5.1-0.20190713202023-55a163980b6c h1:DLLAPVFrk9iNzljMKF512CUmrFImQ6WU3sDiUS4IRqk=
 github.com/go-interpreter/wagon v0.5.1-0.20190713202023-55a163980b6c/go.mod h1:5+b/MBYkclRZngKF5s6qrgWxSLgE9F5dFdO1hAueZLc=
+github.com/gobwas/httphead v0.0.0-20180130184737-2c6c146eadee h1:s+21KNqlpePfkah2I+gwHF8xmJWRjooY+5248k6m4A0=
 github.com/gobwas/httphead v0.0.0-20180130184737-2c6c146eadee/go.mod h1:L0fX3K22YWvt/FAX9NnzrNzcI4wNYi9Yku4O0LKYflo=
+github.com/gobwas/pool v0.2.0 h1:QEmUOlnSjWtnpRGHF3SauEiOsy82Cup83Vf2LcMlnc8=
 github.com/gobwas/pool v0.2.0/go.mod h1:q8bcK0KcYlCgd9e7WYLm9LpyS+YeLd8JVDW6WezmKEw=
+github.com/gobwas/ws v1.0.2 h1:CoAavW/wd/kulfZmSIBt6p24n4j7tHgNVCjsfHVNUbo=
 github.com/gobwas/ws v1.0.2/go.mod h1:szmBTxLgaFppYjEmNtny/v3w89xOydFnnZMcgRRu/EM=
+github.com/google/pprof v0.0.0-20190515194954-54271f7e092f h1:Jnx61latede7zDD3DiiP4gmNz33uK0U5HDUaF0a/HVQ=
 github.com/google/pprof v0.0.0-20190515194954-54271f7e092f/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc=
+github.com/knq/sysutil v0.0.0-20181215143952-f05b59f0f307 h1:vl4eIlySbjertFaNwiMjXsGrFVK25aOWLq7n+3gh2ls=
 github.com/knq/sysutil v0.0.0-20181215143952-f05b59f0f307/go.mod h1:BjPj+aVjl9FW/cCGiF3nGh5v+9Gd3VCgBQbod/GlMaQ=
+github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI=
+github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
+github.com/kr/pty v1.1.1 h1:VkoXIwSboBpnk99O/KFauAEILuNHv5DVFKZMBN/gUgw=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
-github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/mailru/easyjson v0.0.0-20190403194419-1ea4449da983/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc=
 github.com/mailru/easyjson v0.0.0-20190614124828-94de47d64c63/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc=
+github.com/mailru/easyjson v0.0.0-20190620125010-da37f6c1e481 h1:IaSjLMT6WvkoZZjspGxy3rdaTEmWLoRm49WbtVUi9sA=
 github.com/mailru/easyjson v0.0.0-20190620125010-da37f6c1e481/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc=
-github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs=
-github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
-github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
-github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4=
-github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/twitchyliquid64/golang-asm v0.0.0-20190126203739-365674df15fc h1:RTUQlKzoZZVG3umWNzOYeFecQLIh+dbxXvJp1zPQJTI=
 github.com/twitchyliquid64/golang-asm v0.0.0-20190126203739-365674df15fc/go.mod h1:NoCfSFWosfqMqmmD7hApkirIK9ozpHjxRnRxs1l413A=
 golang.org/x/sys v0.0.0-20190306220234-b354f8bf4d9e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190618155005-516e3c20635f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20190712062909-fae7ac547cb7 h1:LepdCS8Gf/MVejFIt8lsiexZATdoGVyp5bcyS+rYoUI=
 golang.org/x/sys v0.0.0-20190712062909-fae7ac547cb7/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU=
-gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
-gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
-gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10=
-gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo=
+gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=