feat(clipboard): allow user to change domain used when copying to cli…

…pboard

.github/workflows/docker-images.yaml

@@ -9,7 +9,7 @@ on:
 
 jobs:
   build:
-    name: Build container
+    name: Build image
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -35,13 +35,13 @@ jobs:
         run: cd server && go test -v ./...
 
       - name: Login to DockerHub
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           username: ${{ github.repository_owner }}
           password: ${{ secrets.HUB_TOKEN }}
 
       - name: Log in to ghcr.io
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
@@ -82,7 +82,7 @@ jobs:
           npm ci install
           CI=false GENERATE_SOURCEMAP=false npm run build:docker
 
-      - name: Build and push
+      - name: Build docker image and push
         id: docker_build
         uses: docker/build-push-action@v2
         with:

README.md

@@ -52,12 +52,13 @@ docker build . -t shortpaste
 
 You can customize the behavior using environment variables:.
 
-| Environment Variable | Default Value     | Behaviour                                                                                                          |
-| -------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------ |
-| `API_KEY`            | `CHANGE-IT-ASAP`  | API key used to communicate with the API.                                                                          |
-| `BASE_PATH`          | `/`               | App base path (use it if the app does not have run its dedicated domain name).                                     |
-| `DEBUG`              |                   | Whether the app runs in debug mode or not (basically just more logs).                                              |
-| `PORT`               | 8080              | Port on which app is running, **should not be changed**.                                                           |
+| Environment Variable | Default Value    | Behaviour                                                                                                                     |
+| -------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| `API_KEY`            | `CHANGE-IT-ASAP` | API key used to communicate with the API.                                                                                     |
+| `BASE_PATH`          | `/`              | App base path (use it if the app does not have run its dedicated domain name).                                                |
+| `DOMAIN`             |                  | Override shortened URL domain in front, when copy to clipboard (default is the actual page domain). Example: `https://sho.rt` |
+| `DEBUG`              |                  | Whether the app runs in debug mode or not (basically just more logs).                                                         |
+| `PORT`               | 8080             | Port on which app is running, **should not be changed**.                                                                      |
 
 ## Securing
 
@@ -137,8 +138,8 @@ Your web browser should open on `http://localhost:3000`. The app is configured t
 
 ## TODO
 
-- [ ] optimize build
-- [ ] allow user to set the public url for shortened content
+- [x] optimize build time
+- [x] allow user to set the public url for shortened content
 - [x] move from sqlite3 to modernc.org/sqlite to compile without CGO (and use scratch, lighter image)
 - [ ] display status with version
 - [ ] allow user to change language

front/src/App.tsx

@@ -1,27 +1,48 @@
 import { Route } from "react-router-dom";
-import classes from './app.module.scss';
-import {MemoryRouter as Router} from "react-router-dom";
+import classes from "./app.module.scss";
+import { MemoryRouter as Router } from "react-router-dom";
 import { ThemeProvider, createTheme } from "@mui/material";
-import { Content, MainMenu } from './components';
-import { Files, Links, Texts } from './pages';
+import { Content, MainMenu } from "./components";
+import { Files, Links, Texts } from "./pages";
+import AppContext from "./app_context";
+import { useEffect, useState } from "react";
+import { App as ShortApp } from "./common/data.types";
+import { appRepository } from "./repositories";
+import { config } from "./core";
 
 const theme = createTheme({
-    spacing: 16,
+  spacing: 16,
 });
 
 function App() {
-  return <Router basename={process.env.PUBLIC_URL}>
-    <ThemeProvider theme={theme}>
-    <div className={classes.root}>
-      <MainMenu />
-      <Content>
-          <Route path="/" element={<Links />} />
-          <Route path="/texts" element={<Texts />} />
-          <Route path="/files" element={<Files />} />
-      </Content>
-    </div>
-  </ThemeProvider>
-  </Router>;
+  const [isLoading, setIsLoading] = useState(true);
+  const [appContextValue, setAppContextValue] = useState<ShortApp>();
+  useEffect(() => {
+    (async() => {
+      const app = await appRepository.get()
+      setAppContextValue(app);
+      config.domain = app.domain;
+      setIsLoading(false);
+    })();
+  }, []);
+
+  return (
+    <Router basename={process.env.PUBLIC_URL}>
+      <ThemeProvider theme={theme}>
+        <AppContext.Provider value={appContextValue}>
+          <div className={classes.root}>
+            {!isLoading ? <><MainMenu />
+            <Content>
+              <Route path="/" element={<Links />} />
+              <Route path="/texts" element={<Texts />} />
+              <Route path="/files" element={<Files />} />
+            </Content>
+            </> : null}
+          </div>
+        </AppContext.Provider>
+      </ThemeProvider>
+    </Router>
+  );
 }
 
 export default App;

front/src/app_context.tsx

@@ -0,0 +1,6 @@
+import { createContext } from "react";
+import { App as ShortApp } from "./common/data.types";
+
+const LinksContext = createContext<ShortApp|undefined>(undefined);
+
+export default LinksContext;

front/src/common/api.types.ts

@@ -1,8 +1,12 @@
-export type Status = {
-  status: "up";
+export type Config = {
+  domain: string;
   version: string;
 };
 
+export type Status = {
+  status: "up" | "down";
+};
+
 export type Link = {
   id: string;
   link: string;

front/src/common/data.types.ts

@@ -2,6 +2,8 @@ import {
   Link as ShortPasteLink,
   File as ShortPasteFile,
   Text as ShortPasteText,
+  Config as ShortPasteConfig,
+  Status as ShortPasteStatus,
 } from "./api.types";
 
 type ShortenedData = {
@@ -13,3 +15,5 @@ export type Link = ShortPasteLink & ShortenedData & {};
 export type File = ShortPasteFile & ShortenedData & {};
 
 export type Text = ShortPasteText & ShortenedData & {};
+
+export type App = ShortPasteConfig & ShortPasteStatus;

front/src/core/api.ts

@@ -4,6 +4,7 @@ import {
   Text as ShortPasteText,
   File as ShortPasteFile,
   Status,
+  Config,
 } from "../common/api.types";
 import config from "./config";
 
@@ -79,6 +80,10 @@ class Api {
   public getStatus(): Promise<AxiosResponse<Status>> {
     return this._axiosInstance.get<Status>("/status");
   }
+
+  public getConfig(): Promise<AxiosResponse<Config>> {
+    return this._axiosInstance.get<Config>("/config");
+  }
 }
 
 export default new Api();

front/src/core/config.ts

@@ -1,4 +1,6 @@
 export default class Config {
+  static domain: string = "";
+
   static get apiKey(): string {
     return process.env.REACT_APP_API_KEY || "%shortpaste-api-key-placeholder%";
   }
@@ -19,4 +21,11 @@ export default class Config {
     }
     return `${window.location.origin}${baseURL}`;
   }
+
+  static get shortenURL(): string {
+    if (this.domain !== "") {
+      return this.domain;
+    }
+    return this.baseURL;
+  }
 }

front/src/repositories/app_repository.ts

@@ -0,0 +1,11 @@
+import { api, config } from "../core";
+import { App as ShortApp } from "../common/data.types";
+
+export default class AppRepository {
+  static async get(): Promise<ShortApp> {
+    const { data: apiStatus } = await api.getStatus();
+    const { data: apiConfig } = await api.getConfig();
+
+    return { ...apiStatus, ...apiConfig };
+  }
+}

front/src/repositories/files_repository.ts

@@ -24,6 +24,6 @@ export default class FilesRepository {
   }
 
   static getShortURL(f: ShortPasteFile): string {
-    return `${config.baseURL}/f/${f.id}`;
+    return `${config.shortenURL}/f/${f.id}`;
   }
 }

front/src/repositories/index.ts

@@ -1,3 +1,4 @@
+export { default as appRepository } from "./app_repository";
 export { default as linksRepository } from "./links_repository";
 export { default as textsRepository } from "./texts_repository";
 export { default as filesRepository } from "./files_repository";

front/src/repositories/links_repository.ts

@@ -24,6 +24,6 @@ export default class LinksRepository {
   }
 
   static getShortURL(l: ShortPasteLink): string {
-    return `${config.baseURL}/l/${l.id}`;
+    return `${config.shortenURL}/l/${l.id}`;
   }
 }

front/src/repositories/texts_repository.ts

@@ -24,6 +24,6 @@ export default class TextsRepository {
   }
 
   static getShortURL(t: ShortPasteText): string {
-    return `${config.baseURL}/t/${t.id}`;
+    return `${config.shortenURL}/t/${t.id}`;
   }
 }

server/api/api.go

@@ -9,6 +9,9 @@ func Router(r chi.Router) {
 	r.Use(middleware.SetHeader("Content-Type", "application/json"))
 	r.Use(CheckApiKey)
 
+	r.Get(`/config`, ConfigList)
+	r.Get(`/status`, StatusList)
+
 	r.Get(`/links`, LinksList)
 	r.Post(`/links`, LinkAdd)
 	r.Delete(`/links/{id}`, LinkDelete)

server/api/config.go

@@ -0,0 +1,16 @@
+package api
+
+import (
+	"encoding/json"
+	"net/http"
+	"shortpaste/core/config"
+)
+
+func ConfigList(w http.ResponseWriter, r *http.Request) {
+	var list = map[string]interface{}{
+		"domain":  config.GetDomain(),
+		"version": config.AppVersion(),
+	}
+	body, _ := json.Marshal(list)
+	w.Write(body)
+}

server/api/status.go

@@ -3,13 +3,11 @@ package api
 import (
 	"encoding/json"
 	"net/http"
-	"shortpaste/core/config"
 )
 
 func StatusList(w http.ResponseWriter, r *http.Request) {
 	var list = map[string]interface{}{
-		"status":  "up",
-		"version": config.AppVersion(),
+		"status": "up",
 	}
 	body, _ := json.Marshal(list)
 	w.Write(body)

server/core/config/domain.go

@@ -0,0 +1,8 @@
+package config
+
+import "os"
+
+func GetDomain() string {
+	domain := os.Getenv("DOMAIN")
+	return domain
+}

server/core/config/domain_test.go

@@ -0,0 +1,18 @@
+package config
+
+import (
+	"os"
+	"testing"
+)
+
+func TestGetDomain(t *testing.T) {
+	os.Setenv("DOMAIN", "")
+
+	domain := GetDomain()
+
+	expectedDomain := ""
+
+	if expectedDomain != domain {
+		t.Fatalf("Expected base path %s, but got %s", expectedDomain, domain)
+	}
+}