earthstar-project/earthstar-foyer

A guestbook style web application using Earthstar

earthstar-foyer's Issues

Consider: encrypt user keypairs with a password?

Maybe store the user keypairs encrypted with a password that users have to enter every time they load the app.

Remember current app in LocalStorage

Implement user control panel

Note we're switching terminology here - we call them Users even though Earthstar calls them Authors.

Users should be able to

• sign in as existing user, using traditional username/password fields
• create new user (generate new keypair) with info about shortname requirements
• edit display name
• sign out. make sure the keypair is removed from localStorage.
• optional: sign in with keypair.json
• optional: download keypair.json

Sync button should light up when there are things to sync

I'm not sure where to keep track of this. Options:

1. From EarthbarStore, subscribe to store writes that are local. We need to track this for each workspace even across switching and reloading the page...
2. Or within core earthstar IStorage, have any writes happened since the last sync? The Syncer class would keep track of this, and store it in IStorage config storage. Which would have to be implemented for StorageMemory.

Discussion: a spec for lobby/foyer messages

• overall purpose and social expectations
• document paths
• interpreting message content -- what format is it in?
• expected newline display handling (see earthstar-project/earthstar-lobby#7)
• auto-linkify: regular http links
• auto-linkify: @-mentions
• auto-linkify: +workspace names

Trouble with multiple tabs

When Foyer is open in two tabs at the same time, both are writing to LocalStorage but neither is reading from it. This causes Problems.

We only load from LocalStorage to memory at startup and from that point we only write from memory to LocalStorage. Instead we need to keep LocalStorage and memory in sync with each other bidirectionally. It's like LocalStorage is a mini pub.

Luckily Earthstar data is easy to sync like this, but we may need to store each document as a separate LocalStorage item. However we also have some metadata that will be trickier to sync (list of workspaces and pub configuration).

Notes:

• LocalStorage has an onChange event we can use.
• There's also SessionStorage which is unique to each tab
• Could use cross tab communication to elect one tab as a leader, and funnel everything through that one?
  • BroadcastChannel
    • not supported in Safari. Use polyfill 1 or polyfill 2
  • use LocalStorage to communicate
  • SharedWorker - one webworker for multiple tabs (but not on safari)
• research on this issue
  • https://gist.github.com/pesterhazy/a840a21000b67cc5b7e601fdc91b9e18
  • https://github.com/firebase/firebase-js-sdk/blob/6a0154aee104a163d6d3b1a28d80fcbb9bace908/packages/firestore/src/local/indexeddb_persistence.ts#L125
  • localForage

Temporary workarounds:

• use a regular tab and a Private Browsing tab
• use two different browsers
• detect when running in a second tab and warn that changes are not permanent? Only sync to pubs but don't save to LocalStorage?

Help password managers save your password when creating a new user

When creating a new user, make it work like this:

1. Fill in shortname, click Create
2. Instead of logging in immediately, fill the generated username & password into the Log In fields
3. The user clicks Log In

This way password managers will detect the login event and save your password for you.

Properly read displayName from IStorage when rebuilding Kit in the user settings panel

Sometimes it's not refreshed properly. Not quite sure how to reproduce.

Delete workspace from localStorage when removing it

Make sure to clear the localStorage of a workspace's data, when the user removes the workspace.