Merge pull request #95 from evan-buss/development

* Improve error handling.

- Don't log.Fatal or panic()
- Return errors from func instead of logging directly in library code
- Send more error messages via websocket
- Make sure IRC connection is open before writing.

* Various maintenance tasks. (#76)

- Use new devcontainer "features" instead of scripts
- Update Go and NPM packages.
  - Fix breaking change with use-local-storage-state
- Add makefile for common commands

* Update Go packages.

* feat: add --searchbot flag (#86)

* feat: add --searchbot flag

* fix: uncomment flag assignment

* feat: add flag to disable automatic browser downloads (#87)

* chore: update npm and go deps

* feat: add desktop webview functionality

- some webviews don't have native copy paste so I update
  the search field on user selection

* feat: open desktop mode by default

* fix: get windows build working

* fix: windows tweaks

- use filepath.join() instead of path.join()
- change default download dir depending on which subcommand is selected
- allow double clicking on windows (disable cobra mousetrap thing)

* fix: resize grid on window height change

* fix: re-render grids when page height changes

* fix: set desktop mode as the default

- allows double clicking the executable to open the GUI

* fix: move openbrowser setting out of the server config

- server code shouldn't care how the page is being displayed.

* fix: Fully type redux stores / middleware / actions

- replace AppThunk with createAsyncThunk

* remove unused npm packages

* cleanup / add loading animation

* feat: download and extract files with ".temp" extension until completed

- This allows Calibre to watch a directory and only import
  the file when it's completed.

* fix: use separate config for each cobra command.

* fix: default desktop mode opens the browser.

- Cross compilation becomes A LOT more complicated
  once CGO is in the mix. Requires the time and energy
  to get build scripts to work across all platforms, and
  update the automated Github Actions to build on
  multiple machines (MacOS requires MacOS runner,
  Windows / Linux require Linux runner)
- This commit adds a build flag "webview" to enable
  webview desktop support but the default without
  the build flag is to open the browser on start.

* fix: use new build flag syntax

* block until close

* Add TLS Support for IRC communication (#90)

* Fix length comparison so zero doesn't appear. (#74)

* feat: Add IRC TLS support

Co-authored-by: Evan Buss <[email protected]>

* ci: update action versions / publish dev docker images

- update docker tag configuration to publish
  'edge' version whenever the 'development'
  branch is updated.

* fix: command binding fixes

- EnableTLS flag was only enabled for the server mode.
- "--dir" server mode flag wasn't registered properly.
- update

* chore: update npm packages

- updated to react 18

* fix: actually fix zero comparison?

* feat: migrate ui to mantine (#93)

* wip: start rewriting sidebar in mantine

- this is the start of making the layout responsive for various
  device sizes

* feat: rewrite sidebar with mantine

- responsive
- dark mode support

* feat: convert book list to mantine

* feat: rewrite notification drawer in mantine

* wip: start converting search page

* feat: convert search page to mantine

* wip: start implement book table in react table

* wip: re-implement table with react-table

Goals:
- mantine styling
- resizeable
- filterable
- dark mode

* wip: react table implementation

* wip: grid style tweaks

* wip: play with animations

* feat: finish converting components to mantine

* feat: remove evergreen-ui dependency

* chore: remove react-use

* Update README.md

* styling: fix issues

- long text overflows
- nicer sidebar toggling
- overflow wrapping with scroll

* chore: update dependencies

* feat: show placeholder when search empty

* fix: error line word wrapping

* docs: update readme

Co-authored-by: Kabir Kwatra <[email protected]>

Author: evan-buss

.devcontainer/Dockerfile

@@ -1,19 +1,12 @@
-# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.191.0/containers/go/.devcontainer/base.Dockerfile
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.217.4/containers/ubuntu/.devcontainer/base.Dockerfile
 
-# [Choice] Go version: 1, 1.16, 1.15
-ARG VARIANT="1.17"
-FROM mcr.microsoft.com/vscode/devcontainers/go:${VARIANT}
-
-# [Choice] Node.js version: none, lts, 16, 14, 12, 10
-ARG NODE_VERSION="none"
-RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+# [Choice] Ubuntu version (use hirsuite or bionic on local arm64/Apple Silicon): hirsute, focal, bionic
+ARG VARIANT="hirsute"
+FROM mcr.microsoft.com/vscode/devcontainers/base:0-${VARIANT}
 
 # [Optional] Uncomment this section to install additional OS packages.
 RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
-    && apt-get -y install --no-install-recommends tmux
-
-# [Optional] Uncomment the next line to use go get to install anything else you need
-RUN go get golang.org/x/tools/cmd/stringer
+  && apt-get -y install --no-install-recommends tmux
 
-# [Optional] Uncomment this line to install global node packages.
-RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g npm-check-updates" 2>&1
+# # [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g npm-check-updates" 2>&1

.devcontainer/devcontainer.json

@@ -1,41 +1,47 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
-// https://github.com/microsoft/vscode-dev-containers/tree/v0.191.0/containers/go
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.217.4/containers/ubuntu
 {
-	"name": "Go",
-	"build": {
-		"dockerfile": "Dockerfile",
-		"args": {
-			"VARIANT": "1.17",
-			"NODE_VERSION": "16"
-		}
-	},
-	"runArgs": [
-		"--cap-add=SYS_PTRACE",
-		"--security-opt",
-		"seccomp=unconfined"
-	],
-	// Set *default* container specific settings.json values on container create.
-	"settings": {
-		"go.toolsManagement.checkForUpdates": "local",
-		"go.useLanguageServer": true,
-		"go.gopath": "/go",
-		"go.goroot": "/usr/local/go"
-	},
-	// Add the IDs of extensions you want installed when the container is created.
-	"extensions": [
-		"golang.Go",
-		"eamodio.gitlens",
-		"bradlc.vscode-tailwindcss",
-		"esbenp.prettier-vscode",
-		"GitHub.copilot"
-	],
-	// Use 'forwardPorts' to make a list of ports inside the container available locally.
-	"forwardPorts": [
-		3000,
-		5228
-	],
-	// Use 'postCreateCommand' to run commands after the container is created.
-	// "postCreateCommand": "go version",
-	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
-	"remoteUser": "vscode"
-}
+  "name": "Ubuntu",
+  "build": {
+    "dockerfile": "Dockerfile",
+    "args": {
+      "VARIANT": "jammy"
+    }
+  },
+  // Set *default* container specific settings.json values on container create.
+  "settings": {
+    "go.toolsManagement.checkForUpdates": "local",
+    "go.addTags": {
+      "tags": "json",
+      "options": "json=omitempty",
+      "promptForTags": false,
+      "transform": "snakecase",
+      "template": ""
+    },
+    "go.useLanguageServer": true,
+    "go.gopath": "/go",
+    "go.goroot": "/usr/local/go"
+  },
+  "runArgs": ["--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined"],
+  // Add the IDs of extensions you want installed when the container is created.
+  "extensions": [
+    "golang.Go",
+    "eamodio.gitlens",
+    "bradlc.vscode-tailwindcss",
+    "esbenp.prettier-vscode",
+    "GitHub.copilot"
+  ],
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+  // Use 'postCreateCommand' to run commands after the container is created.
+  // "postCreateCommand": "uname -a",
+  // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+  "remoteUser": "vscode",
+  "features": {
+    "docker-in-docker": "latest",
+    "git": "latest",
+    "sshd": "latest",
+    "node": "lts",
+    "golang": "latest"
+  }
+}

.github/home_v3.png

@@ -7,6 +7,9 @@ name: Publish Image to Docker Hub
 on:
   workflow_dispatch:
   push:
+    branches:
+      - master
+      - development
     tags:
       - 'v*.*.*'
 
@@ -16,40 +19,43 @@ jobs:
 
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set Docker Metadata
         id: meta
-        uses: docker/metadata-action@v3
+        uses: docker/metadata-action@v4
         with:
           # list of Docker images to use as base name for tags
           images: |
             evanbuss/openbooks
           # generate Docker tags based on the following events/attributes
+          # 'latest' when push to master with tag
+          # 'edge' when push to development
+          # '1.1.1' when push version tag v1.1.1
           flavor: |
-            latest=true
+            latest=auto
           tags: |
-            type=sha
+            type=semver,pattern={{version}}
+            type=edge,branch=development
             
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
+        uses: docker/setup-qemu-action@v2
 
       - name: Set up Docker Buildx
         id: buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v2
         with:
           version: latest
           install: true
-          use: true
 
       - name: Login to Docker Hub
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
             username: ${{ secrets.DOCKER_USERNAME }}
             password: ${{ secrets.DOCKER_HUB_TOKEN }}
 
       - name: Build and Push
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v3
         with:
           context: .
           platforms: linux/amd64,linux/arm64,linux/arm
@@ -58,7 +64,7 @@ jobs:
           tags: ${{ steps.meta.outputs.tags }}
 
       - name: Docker Hub Description
-        uses: peter-evans/dockerhub-description@v2
+        uses: peter-evans/dockerhub-description@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}

.github/home_v3_dark.png

@@ -14,17 +14,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - uses: actions/setup-go@v2
         with:
           go-version: "^1.17.0"
       - run: go version
 
       - name: Setup Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
-          node-version: "16"
+          node-version: 16
 
       - name: Build
         run: ./build.sh

.github/workflows/docker_hub.yml

@@ -1,4 +1,5 @@
 # start persist
+mock_server
 openbooks
 !openbooks/
 *.DS_Store

.github/workflows/release.yml

@@ -10,26 +10,15 @@
       "request": "launch",
       "mode": "debug",
       "program": "cmd/openbooks",
-      "args": [
-        "server",
-        "--log",
-        "--server",
-        "localhost"
-      ],
+      "args": ["server", "--log", "--server", "localhost", "--persist"]
     },
     {
       "name": "Launch OpenBooks CLI",
       "type": "go",
       "request": "launch",
       "mode": "debug",
       "program": "cmd/openbooks",
-      "args": [
-        "cli",
-        "download",
-        "--server",
-        "localhost",
-        "!test"
-      ],
+      "args": ["cli", "download", "--server", "localhost", "!test"]
     }
   ]
-}
+}

.gitignore

@@ -6,7 +6,11 @@
 
 Openbooks allows you to download ebooks from irc.irchighway.net quickly and easily.
 
-![openbooks](https://raw.githubusercontent.com/evan-buss/openbooks/master/.github/home_v2.png)
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="./.github/home_v3_dark.png">
+  <img alt="openbooks screenshot" src="./.github/home_v3.png">
+</picture>
+
 
 ## Getting Started
 
@@ -42,6 +46,8 @@ two modes; Server or CLI. In CLI mode you interact and download books through
 a terminal interface. In server mode the application runs as a web application
 that you can visit in your browser.
 
+Double clicking the executable will open the UI in your browser. In the future it may use [webviews](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) to provide a "native-like" desktop application. 
+
 ## Development
 
 ### Install the dependencies
@@ -72,6 +78,15 @@ that you can visit in your browser.
   go run . server --server localhost --log
   ```
 
+### Desktop App
+Compile OpenBooks with experimental webview support:
+
+``` shell
+cd cmd/openbooks
+go build -tags webview
+```
+
+
 ## Why / How
 
 - I wrote this as an easier way to search and download books from irchighway.net. It handles all the extraction and data processing for you. You just have to click the book you want. Hopefully you find it much easier than the IRC interface.
@@ -88,5 +103,5 @@ that you can visit in your browser.
   - React.js
   - TypeScript
   - Redux / Redux Toolkit
-  - Tailwind CSS
-  - Evergreen UI
+  - Mantine UI / @emotion/react
+  - Framer Motion

.vscode/launch.json

@@ -10,12 +10,14 @@ import (
 )
 
 type Config struct {
-	UserName string // Username to use when connecting to IRC
-	Log      bool   // True if IRC messages should be logged
-	Dir      string
-	Server   string
-	irc      *irc.Conn
-	Version  string
+	UserName  string // Username to use when connecting to IRC
+	Log       bool   // True if IRC messages should be logged
+	Dir       string
+	Server    string
+	EnableTLS bool
+	SearchBot string
+	Version   string
+	irc       *irc.Conn
 }
 
 // StartInteractive instantiates the OpenBooks CLI interface
@@ -37,7 +39,7 @@ func StartInteractive(config Config) {
 	}
 
 	go core.StartReader(ctx, config.irc, handler)
-	terminalMenu(config.irc)
+	terminalMenu(config)
 
 	<-ctx.Done()
 }
@@ -93,7 +95,7 @@ func StartSearch(config Config, query string) {
 	time.Sleep(time.Until(nextSearchTime))
 
 	go core.StartReader(ctx, config.irc, handler)
-	core.SearchBook(config.irc, query)
+	core.SearchBook(config.irc, config.SearchBot, query)
 
 	setLastSearchTime()
 	fmt.Printf("%sSent search request.", clearLine)