feat: create config page for sw settings #24

SgtPooki · 2024-02-21T03:19:55Z

partially addresses #22

Todo

Give feedback

make sure gateway and router config is being registered with helia instance properly on subdomains
center gear icon padding
add auto-reload config
Options

SgtPooki

quick review. still in draft cause it can use a bit more cleanup

src/sw.ts

src/lib/channel.ts

src/index.tsx

SgtPooki · 2024-02-21T03:26:51Z

src/app.tsx

+  if (isConfigExpanded) {
+    return (<Config />)


eventually, this landing page should only be the config page....?

src/context/service-worker-context.tsx

SgtPooki · 2024-02-23T17:32:21Z

Okay, so I found out that if you empty the config (gateways and routers to "[]"), it works fine; I will investigate further.

I think ff7bafe fixed this.

SgtPooki · 2024-02-23T19:32:32Z

question here: do we want the user to be able to override all of the gateways & routers? currently the config.gateways and routers are appended:

    blockBrokers: [
      trustlessGateway({
        gateways: ['https://trustless-gateway.link', ...config.gateways]
      })
    ],
    routers: ['https://delegated-ipfs.dev', ...config.routers].map(rUrl => delegatedHTTPRouting(rUrl))

aschmahmann · 2024-02-23T19:57:38Z

IMO getting shown a status page with a lot of options on initial load is a little unfriendly. Maybe just a "hey welcome to the service worker gateway, if you want to change settings or for more information go to "

aschmahmann · 2024-02-23T20:01:40Z

do we want the user to be able to override all of the gateways & routers? currently the config.gateways and routers are appended:

Other opinions welcome I'd probably start with append, and then we can figure out removal. Right now it's a bit tempting to just show the list of URLs to modify, but we may have some routers that are more complicated (e.g. a validating ENS router, or if IPNI federation gets off the ground)

SgtPooki · 2024-02-23T20:04:17Z

IMO getting shown a status page with a lot of options on initial load is a little unfriendly. Maybe just a "hey welcome to the service worker gateway, if you want to change settings or for more information go to "

I can leave it collapsed by default and have autoReload default to true?

SgtPooki · 2024-02-24T01:11:35Z

also see #19 (comment)

SgtPooki · 2024-02-26T17:31:04Z

chatted with lidel

config page is useful for educating users, we should not auto-reload. require user interaction for reloading, unless they enable autoreload
Link to docs for gateways
link to docs for routers

SgtPooki · 2024-02-27T06:15:10Z

new default page view:

Initial

After clicking "view config"

SgtPooki · 2024-02-27T06:17:12Z

src/components/collapsible.tsx

+  const [isCollapsed, setCollapsed] = useState(collapsed)
+
+  return (
+    <React.Fragment>


vscode was being weird in this file yelling about all types of syntax errors that didn't exist after closing it and re-opening. ¯\_(ツ)_/¯

SgtPooki · 2024-02-27T06:23:17Z

src/components/sw-ready-button.tsx

+  const buttonClasses = new Set(['button-reset', 'pv3', 'tc', 'bn', 'white', 'w-100', 'cursor-disabled', 'bg-gray'])
+  if (isServiceWorkerRegistered) {
+    buttonClasses.delete('bg-gray')
+    buttonClasses.delete('cursor-disabled')
+    buttonClasses.add('bg-animate')
+    buttonClasses.add('bg-black-80')
+    buttonClasses.add('hover-bg-aqua')
+    buttonClasses.add('pointer')
+  }


this should probably be a useMemo and two distinct string values

SgtPooki · 2024-02-27T06:25:46Z

src/index.tsx

+root.render(
+  <React.StrictMode>
+    <ServiceWorkerProvider>
+      <ConfigProvider expanded={window.location.pathname === '/config'}>
+          <App />
+      </ConfigProvider>
+    </ServiceWorkerProvider>
+  </React.StrictMode>
+)


simplified root logic. page rendering determined in app.tsx

SgtPooki · 2024-02-27T06:27:10Z

src/lib/common.ts

-   * Intended only for pushing from SW to the UI output terminal
-   */
-  SHOW_STATUS = 'SHOW_STATUS',
+  RELOAD_CONFIG = 'RELOAD_CONFIG',


we probably need a RELOAD_CONFIG_DONE here that SW emits so we can block on config saving until the SW is refreshed with any updated config. This should prevent any confusion when adding a new gateway and not seeing requests go to that gateway.

SgtPooki · 2024-02-27T06:28:15Z

src/lib/config-db.ts


 export interface ConfigDb {
  gateways: string[]
  routers: string[]
+  autoReload: boolean
+  debug: string


you can use https://npmjs.com/package/debug strings to set debug levels on the service worker. similar to setting DEBUG=... env var in the terminal

SgtPooki · 2024-02-27T06:29:41Z

src/lib/get-subdomain-parts.ts

+export interface UrlParts {
+  id: string | null
+  protocol: string | null
+  parentDomain: string


moved this over from sw mostly so i could use this for iframe rendering of the config page now that we dont have BASE_URL. Only change is the addition of this parentDomain

SgtPooki · 2024-02-27T06:31:22Z

src/redirectPage.tsx

+        channel.postMessage({ target: 'SW', action: 'RELOAD_CONFIG' })
+        // try to preload the content
+        setTimeout(() => {
+          fetch(window.location.href, { method: 'GET' }).then((response) => {


when user is done on config page, "load content" or refresh should result in immediate rendering (or at least less wait time)

SgtPooki · 2024-02-27T17:16:05Z

will merge this so we can iterate on any changes people want. lots of cleanup done in this PR

feat: create config page for sw settings

b29048f

SgtPooki commented Feb 21, 2024

View reviewed changes

src/sw.ts Outdated Show resolved Hide resolved

src/lib/channel.ts Outdated Show resolved Hide resolved

src/lib/channel.ts Outdated Show resolved Hide resolved

src/index.tsx Outdated Show resolved Hide resolved

SgtPooki added 5 commits February 20, 2024 19:22

Update src/lib/channel.ts

53001c6

Update src/sw.ts

7c6410f

Update src/lib/channel.ts

eca1114

Update src/index.tsx

0d5f91f

chore: fix build

764ebbc

SgtPooki commented Feb 21, 2024

View reviewed changes

SgtPooki self-assigned this Feb 21, 2024

SgtPooki added 10 commits February 21, 2024 18:27

Merge branch 'main' into feat/config-page

527cc4b

chore: change gear color

f80b2ed

feat: service worker config is shared to subdomains

7c988ad

fix: test running

3e73d05

fix: service worker registration

2c0cd88

chore: remove calls to removed to commsChannel methods

658c41d

chore: use LOCAL_STORAGE_KEYS

535fc7e

feat: config page auto reload works

c588d2a

chore: import react functions directly

d493df7

chore: use latest verified-fetch

f50182d

This comment was marked as resolved.

Sign in to view

SgtPooki marked this pull request as ready for review February 22, 2024 23:52

SgtPooki requested review from a team and lidel February 22, 2024 23:52

This comment was marked as resolved.

Sign in to view

2color reviewed Feb 23, 2024

View reviewed changes

src/context/service-worker-context.tsx Show resolved Hide resolved

2color reviewed Feb 23, 2024

View reviewed changes

src/context/service-worker-context.tsx Show resolved Hide resolved

SgtPooki added 2 commits February 23, 2024 09:45

chore: remove console.logs and cleanup

732f9a4

chore: consolidate app logic

ff7bafe

SgtPooki added 3 commits February 23, 2024 11:09

feat: users can control debugging output

b85f323

chore: todo determinism

8068f14

fix: gateway & routers default value

ffe08c1

SgtPooki added 3 commits February 23, 2024 12:23

fix: bug parsing ipfs namespaced subdomains

d078e2d

chore: comment

9304b9f

fix: use configured gateways & routers prior to defaults

78ebfc6

SgtPooki mentioned this pull request Feb 23, 2024

feat: Service worker configuration #22

Closed

SgtPooki added 2 commits February 23, 2024 13:16

Merge branch 'main' into feat/config-page

56485a5

Merge branch 'main' into feat/config-page

d4aa1d0

SgtPooki added 2 commits February 26, 2024 21:56

Merge branch 'main' into feat/config-page

78ec8a3

feat: config collapsed, reload button, sw-ready-btn

21c2e7b

chore: remove unused in config.tsx

4fcc269

SgtPooki commented Feb 27, 2024

View reviewed changes

SgtPooki merged commit d933208 into main Feb 27, 2024
12 checks passed

SgtPooki deleted the feat/config-page branch February 27, 2024 17:16

lidel mentioned this pull request Feb 28, 2024

fix: enforce origin isolation on subdomain gws #60

Merged

4 tasks

lidel mentioned this pull request Mar 15, 2024

chore(main): release 1.0.0 #120

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: create config page for sw settings #24

feat: create config page for sw settings #24

SgtPooki commented Feb 21, 2024 •

edited

Loading

Todo

SgtPooki left a comment

SgtPooki Feb 21, 2024

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

SgtPooki commented Feb 23, 2024 •

edited

Loading

SgtPooki commented Feb 23, 2024

aschmahmann commented Feb 23, 2024

aschmahmann commented Feb 23, 2024

SgtPooki commented Feb 23, 2024

SgtPooki commented Feb 24, 2024

SgtPooki commented Feb 26, 2024 •

edited

Loading

SgtPooki commented Feb 27, 2024

SgtPooki Feb 27, 2024

SgtPooki Feb 27, 2024

SgtPooki Feb 27, 2024

SgtPooki Feb 27, 2024

SgtPooki Feb 27, 2024

SgtPooki Feb 27, 2024

SgtPooki Feb 27, 2024

SgtPooki commented Feb 27, 2024

feat: create config page for sw settings #24

feat: create config page for sw settings #24

Conversation

SgtPooki commented Feb 21, 2024 • edited Loading

Todo

SgtPooki left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

SgtPooki commented Feb 23, 2024 • edited Loading

SgtPooki commented Feb 23, 2024

aschmahmann commented Feb 23, 2024

aschmahmann commented Feb 23, 2024

SgtPooki commented Feb 23, 2024

SgtPooki commented Feb 24, 2024

SgtPooki commented Feb 26, 2024 • edited Loading

SgtPooki commented Feb 27, 2024

Initial

After clicking "view config"

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SgtPooki commented Feb 27, 2024

SgtPooki commented Feb 21, 2024 •

edited

Loading

SgtPooki commented Feb 23, 2024 •

edited

Loading

SgtPooki commented Feb 26, 2024 •

edited

Loading