merged www separate site into the same project

Author: gcclinux

.github/workflows/pages.yml

@@ -0,0 +1,39 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: ["main"]
+    paths:
+      - "www/public/**"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: www/public
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

www/.gitignore

@@ -0,0 +1,69 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+firebase-debug.log*
+firebase-debug.*.log*
+
+# Firebase cache
+.firebase/
+
+# Firebase config
+
+# Uncomment this if you'd like others to create their own Firebase project.
+# For a team working on the same Firebase project(s), it is recommended to leave
+# it commented so all members can deploy to the same project(s) in .firebaserc.
+# .firebaserc
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# dataconnect generated files
+.dataconnect

www/README.md

@@ -0,0 +1 @@
+This is a web server that announces whether or not a particular Go version has been tagged.

www/go.mod

@@ -0,0 +1,4 @@
+module mymodule
+
+go 1.20
+

www/main.go

@@ -0,0 +1,141 @@
+// Copyright 2023 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Outyet is a web server that announces whether or not a particular Go version
+// has been tagged.
+package main
+
+import (
+	"expvar"
+	"flag"
+	"fmt"
+	"html/template"
+	"log"
+	"net/http"
+	"strings"
+	"sync"
+	"time"
+)
+
+// Command-line flags.
+var (
+	httpAddr   = flag.String("addr", "0.0.0.0:8080", "Listen address")
+	pollPeriod = flag.Duration("poll", 5*time.Second, "Poll period")
+	version    = flag.String("version", "1.20", "Go version")
+)
+
+const baseChangeURL = "https://go.googlesource.com/go/+/"
+
+func main() {
+	flag.Parse()
+	changeURL := fmt.Sprintf("%sgo%s", baseChangeURL, *version)
+
+	// Serve the images directory just like Firebase Hosting would
+	fs := http.FileServer(http.Dir("public/images"))
+	http.Handle("/images/", http.StripPrefix("/images/", fs))
+
+	// Serve the docs directory
+	docsFs := http.FileServer(http.Dir("public/docs"))
+	http.Handle("/docs/", http.StripPrefix("/docs/", docsFs))
+
+	// Serve the manual HTML viewer
+	http.HandleFunc("/manual.html", func(w http.ResponseWriter, r *http.Request) {
+		http.ServeFile(w, r, "public/manual.html")
+	})
+
+	http.Handle("/", NewServer(*version, changeURL, *pollPeriod))
+
+	addr := *httpAddr
+	port := addr
+	if idx := strings.LastIndex(addr, ":"); idx != -1 {
+		port = addr[idx:]
+	}
+
+	log.Printf("serving http://%s", addr)
+	log.Printf("local access: http://localhost%s", port)
+	log.Fatal(http.ListenAndServe(addr, nil))
+}
+
+// Exported variables for monitoring the server.
+// These are exported via HTTP as a JSON object at /debug/vars.
+var (
+	hitCount       = expvar.NewInt("hitCount")
+	pollCount      = expvar.NewInt("pollCount")
+	pollError      = expvar.NewString("pollError")
+	pollErrorCount = expvar.NewInt("pollErrorCount")
+)
+
+// Server implements the outyet server.
+// It serves the user interface (it's an http.Handler)
+// and polls the remote repository for changes.
+type Server struct {
+	version string
+	url     string
+	period  time.Duration
+
+	mu  sync.RWMutex // protects the yes variable
+	yes bool
+}
+
+// NewServer returns an initialized outyet server.
+func NewServer(version, url string, period time.Duration) *Server {
+	s := &Server{version: version, url: url, period: period}
+	go s.poll()
+	return s
+}
+
+// poll polls the change URL for the specified period until the tag exists.
+// Then it sets the Server's yes field true and exits.
+func (s *Server) poll() {
+	for !isTagged(s.url) {
+		pollSleep(s.period)
+	}
+	s.mu.Lock()
+	s.yes = true
+	s.mu.Unlock()
+	pollDone()
+}
+
+// Hooks that may be overridden for integration tests.
+var (
+	pollSleep = time.Sleep
+	pollDone  = func() {}
+)
+
+// isTagged makes an HTTP HEAD request to the given URL and reports whether it
+// returned a 200 OK response.
+func isTagged(url string) bool {
+	pollCount.Add(1)
+	r, err := http.Head(url)
+	if err != nil {
+		log.Print(err)
+		pollError.Set(err.Error())
+		pollErrorCount.Add(1)
+		return false
+	}
+	return r.StatusCode == http.StatusOK
+}
+
+// ServeHTTP implements the HTTP user interface.
+func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	hitCount.Add(1)
+	s.mu.RLock()
+	data := struct {
+		URL     string
+		Version string
+		Yes     bool
+	}{
+		s.url,
+		s.version,
+		s.yes,
+	}
+	s.mu.RUnlock()
+	err := tmpl.Execute(w, data)
+	if err != nil {
+		log.Print(err)
+	}
+}
+
+// tmpl is the HTML template that drives the user interface.
+var tmpl = template.Must(template.ParseFiles("public/index.html"))

www/main_test.go

@@ -0,0 +1,87 @@
+// Copyright 2023 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package main
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"strings"
+	"testing"
+	"time"
+)
+
+// statusHandler is an http.Handler that writes an empty response using itself
+// as the response status code.
+type statusHandler int
+
+func (h *statusHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	w.WriteHeader(int(*h))
+}
+
+func TestIsTagged(t *testing.T) {
+	// Set up a fake "Google Code" web server reporting 404 not found.
+	status := statusHandler(http.StatusNotFound)
+	s := httptest.NewServer(&status)
+	defer s.Close()
+
+	if isTagged(s.URL) {
+		t.Fatal("isTagged == true, want false")
+	}
+
+	// Change fake server status to 200 OK and try again.
+	status = http.StatusOK
+
+	if !isTagged(s.URL) {
+		t.Fatal("isTagged == false, want true")
+	}
+}
+
+func TestIntegration(t *testing.T) {
+	status := statusHandler(http.StatusNotFound)
+	ts := httptest.NewServer(&status)
+	defer ts.Close()
+
+	// Replace the pollSleep with a closure that we can block and unblock.
+	sleep := make(chan bool)
+	pollSleep = func(time.Duration) {
+		sleep <- true
+		sleep <- true
+	}
+
+	// Replace pollDone with a closure that will tell us when the poller is
+	// exiting.
+	done := make(chan bool)
+	pollDone = func() { done <- true }
+
+	// Put things as they were when the test finishes.
+	defer func() {
+		pollSleep = time.Sleep
+		pollDone = func() {}
+	}()
+
+	s := NewServer("1.x", ts.URL, 1*time.Millisecond)
+
+	<-sleep // Wait for poll loop to start sleeping.
+
+	// Make first request to the server.
+	r, _ := http.NewRequest("GET", "/", nil)
+	w := httptest.NewRecorder()
+	s.ServeHTTP(w, r)
+	if b := w.Body.String(); !strings.Contains(b, "No.") {
+		t.Fatalf("body = %s, want no", b)
+	}
+
+	status = http.StatusOK
+
+	<-sleep // Permit poll loop to stop sleeping.
+	<-done  // Wait for poller to see the "OK" status and exit.
+
+	// Make second request to the server.
+	w = httptest.NewRecorder()
+	s.ServeHTTP(w, r)
+	if b := w.Body.String(); !strings.Contains(b, "YES!") {
+		t.Fatalf("body = %q, want yes", b)
+	}
+}