comparing 436b39da9450193af36a03ece46c7de6b7bbae4b and main on cduck.me/statusphere-example-app-fork

+2 -2

.env.template

···

       4
       4
        
       DB_PATH=":memory:"         # The SQLite database path. Set as ":memory:" to use a temporary in-memory database.

     

       5
       5
        
       # PUBLIC_URL=""            # Set when deployed publicly, e.g. "https://mysite.com". Informs OAuth client id.

     

       6
       6
        
       # LOG_LEVEL="info"         # Options: 'fatal', 'error', 'warn', 'info', 'debug'

     

       7
       7
       -
       # PDS_URL="https://my.pds" # The the default PDS for login and sign-ups

     

       7
       7
       +
       # PDS_URL="https://my.pds" # The default PDS for login and sign-ups

     

       8
       8
        
       

     

       9
       9
       -
       # Secrets bellow *MUST* be set in production

     

       9
       9
       +
       # Secrets below *MUST* be set in production

     

       10
       10
        
       

     

       11
       11
        
       # May be generated with `openssl rand -base64 33`

     

       12
       12
        
       # COOKIE_SECRET=""

+42

README.md

···

       19
       19
        
       npm run dev

     

       20
       20
        
       # Navigate to http://localhost:8080

     

       21
       21
        
       ```

     

       22
       22
       +
       

     

       23
       23
       +
       ## Deploying

     

       24
       24
       +
       

     

       25
       25
       +
       In production, you will need a private key to sign OAuth tokens request. Use the

     

       26
       26
       +
       following command to generate a new private key:

     

       27
       27
       +
       

     

       28
       28
       +
       ```sh

     

       29
       29
       +
       ./bin/gen-jwk

     

       30
       30
       +
       ```

     

       31
       31
       +
       

     

       32
       32
       +
       The generated key must be added to the environment variables (`.env` file) in `PRIVATE_KEYS`.

     

       33
       33
       +
       

     

       34
       34
       +
       ```env

     

       35
       35
       +
       PRIVATE_KEYS='[{"kty":"EC","kid":"12",...}]'

     

       36
       36
       +
       ```

     

       37
       37
       +
       

     

       38
       38
       +
       > [!NOTE]

     

       39
       39
       +
       >

     

       40
       40
       +
       > The `PRIVATE_KEYS` can contain multiple keys. The first key in the array is

     

       41
       41
       +
       > the most recent one, and it will be used to sign new tokens. When a key is

     

       42
       42
       +
       > removed, all associated sessions will be invalidated.

     

       43
       43
       +
       

     

       44
       44
       +
       Make sure to also set the `COOKIE_SECRET`, which is used to sign session

     

       45
       45
       +
       cookies, in your environment variables (`.env` file). You should use a random

     

       46
       46
       +
       string for this:

     

       47
       47
       +
       

     

       48
       48
       +
       ```sh

     

       49
       49
       +
       openssl rand -base64 33

     

       50
       50
       +
       ```

     

       51
       51
       +
       

     

       52
       52
       +
       Finally, set the `PUBLIC_URL` to the URL where your app will be accessible. This

     

       53
       53
       +
       will allow the authorization servers to download the app's public keys.

     

       54
       54
       +
       

     

       55
       55
       +
       ```env

     

       56
       56
       +
       PUBLIC_URL="https://your-app-url.com"

     

       57
       57
       +
       ```

     

       58
       58
       +
       

     

       59
       59
       +
       > [!NOTE]

     

       60
       60
       +
       >

     

       61
       61
       +
       > You can use services like [ngrok](https://ngrok.com/) to expose your local

     

       62
       62
       +
       > server to the internet for testing purposes. Just set the `PUBLIC_URL` to the

     

       63
       63
       +
       > ngrok URL.

+1 -1

src/auth/client.ts

···

       31
       31
        
       

     

       32
       32
        
         // If a keyset is defined (meaning the client is confidential). Let's make

     

       33
       33
        
         // sure it has a private key for signing. Note: findPrivateKey will throw if

     

       34
       34
       -
         // the keyset does no contain a suitable private key.

     

       34
       34
       +
         // the keyset does not contain a suitable private key.

     

       35
       35
        
         const pk = keyset?.findPrivateKey({ use: 'sig' })

     

       36
       36
        
       

     

       37
       37
        
         const clientMetadata: OAuthClientMetadataInput = env.PUBLIC_URL

+6 -6

src/ingester.ts

···

       11
       11
        
       export function createIngester(db: Database) {

     

       12
       12
        
         const logger = pino({ name: 'firehose', level: env.LOG_LEVEL })

     

       13
       13
        
         return new Firehose({

     

       14
       14
       -
           service: env.FIREHOSE_URL,

     

       15
       15
       -
           idResolver: new IdResolver({

     

       16
       16
       -
             plcUrl: env.PLC_URL,

     

       17
       17
       -
             didCache: new MemoryCache(HOUR, DAY),

     

       18
       18
       -
           }),

     

       14
       14
       +
           filterCollections: ['xyz.statusphere.status'],

     

       19
       15
        
           handleEvent: async (evt: Event) => {

     

       20
       16
        
             // Watch for write events

     

       21
       17
        
             if (evt.event === 'create' || evt.event === 'update') {

     
···

       70
       66
        
           onError: (err: unknown) => {

     

       71
       67
        
             logger.error({ err }, 'error on firehose ingestion')

     

       72
       68
        
           },

     

       73
       73
       -
           filterCollections: ['xyz.statusphere.status'],

     

       74
       69
        
           excludeIdentity: true,

     

       75
       70
        
           excludeAccount: true,

     

       71
       71
       +
           service: env.FIREHOSE_URL,

     

       72
       72
       +
           idResolver: new IdResolver({

     

       73
       73
       +
             plcUrl: env.PLC_URL,

     

       74
       74
       +
             didCache: new MemoryCache(HOUR, DAY),

     

       75
       75
       +
           }),

     

       76
       76
        
         })

     

       77
       77
        
       }

+5 -4

src/lib/http.ts

···

       1
       1
       +
       import { Request, Response } from 'express'

     

       1
       2
        
       import { createHttpTerminator } from 'http-terminator'

     

       2
       3
        
       import { once } from 'node:events'

     

       3
       4
        
       import type {

     
···

       11
       12
        
       

     

       12
       13
        
       export type Middleware<

     

       13
       14
        
         Req extends IncomingMessage = IncomingMessage,

     

       14
       14
       -
         Res extends ServerResponse<Req> = ServerResponse<Req>,

     

       15
       15
       +
         Res extends ServerResponse = ServerResponse,

     

       15
       16
        
       > = (req: Req, res: Res, next: NextFunction) => void

     

       16
       17
        
       

     

       17
       18
        
       export type Handler<

     

       18
       19
        
         Req extends IncomingMessage = IncomingMessage,

     

       19
       19
       -
         Res extends ServerResponse<Req> = ServerResponse<Req>,

     

       20
       20
       +
         Res extends ServerResponse = ServerResponse,

     

       20
       21
        
       > = (req: Req, res: Res) => unknown | Promise<unknown>

     

       21
       22
        
       /**

     

       22
       23
        
        * Wraps a request handler middleware to ensure that `next` is called if it

     

       23
       24
        
        * throws or returns a promise that rejects.

     

       24
       25
        
        */

     

       25
       26
        
       export function handler<

     

       26
       26
       -
         Req extends IncomingMessage = IncomingMessage,

     

       27
       27
       -
         Res extends ServerResponse<Req> = ServerResponse<Req>,

     

       27
       27
       +
         Req extends IncomingMessage = Request,

     

       28
       28
       +
         Res extends ServerResponse = Response,

     

       28
       29
        
       >(fn: Handler<Req, Res>): Middleware<Req, Res> {

     

       29
       30
        
         return async (req, res, next) => {

     

       30
       31
        
           try {

+30 -37

src/routes.ts

···

       31
       31
        
         res: ServerResponse,

     

       32
       32
        
         ctx: AppContext,

     

       33
       33
        
       ) {

     

       34
       34
       +
         res.setHeader('Vary', 'Cookie')

     

       35
       35
       +
       

     

       34
       36
        
         const session = await getIronSession<Session>(req, res, {

     

       35
       37
        
           cookieName: 'sid',

     

       36
       38
        
           password: env.COOKIE_SECRET,

     

       37
       39
        
         })

     

       38
       40
        
         if (!session.did) return null

     

       41
       41
       +
       

     

       42
       42
       +
         // This page is dynamic and should not be cached publicly

     

       43
       43
       +
         res.setHeader('cache-control', `max-age=${MAX_AGE}, private`)

     

       44
       44
       +
       

     

       39
       45
        
         try {

     

       40
       46
        
           const oauthSession = await ctx.oauthClient.restore(session.did)

     

       41
       47
        
           return oauthSession ? new Agent(oauthSession) : null

     
···

       60
       66
        
         // OAuth metadata

     

       61
       67
        
         router.get(

     

       62
       68
        
           '/oauth-client-metadata.json',

     

       63
       63
       -
           handler((req: Request, res: Response) => {

     

       69
       69
       +
           handler((req, res) => {

     

       64
       70
        
             res.setHeader('cache-control', `max-age=${MAX_AGE}, public`)

     

       65
       71
        
             res.json(ctx.oauthClient.clientMetadata)

     

       66
       72
        
           }),

     
···

       69
       75
        
         // Public keys

     

       70
       76
        
         router.get(

     

       71
       77
        
           '/.well-known/jwks.json',

     

       72
       72
       -
           handler((req: Request, res: Response) => {

     

       78
       78
       +
           handler((req, res) => {

     

       73
       79
        
             res.setHeader('cache-control', `max-age=${MAX_AGE}, public`)

     

       74
       80
        
             res.json(ctx.oauthClient.jwks)

     

       75
       81
        
           }),

     
···

       78
       84
        
         // OAuth callback to complete session creation

     

       79
       85
        
         router.get(

     

       80
       86
        
           '/oauth/callback',

     

       81
       81
       -
           handler(async (req: Request, res: Response) => {

     

       87
       87
       +
           handler(async (req, res) => {

     

       82
       88
        
             res.setHeader('cache-control', 'no-store')

     

       83
       89
        
       

     

       84
       90
        
             const params = new URLSearchParams(req.originalUrl.split('?')[1])

     
···

       104
       110
        
       

     

       105
       111
        
               // Update the session cookie

     

       106
       112
        
               session.did = oauth.session.did

     

       113
       113
       +
       

     

       107
       114
        
               await session.save()

     

       108
       115
        
             } catch (err) {

     

       109
       116
        
               ctx.logger.error({ err }, 'oauth callback failed')

     

       110
       110
       -
               return res.redirect('/?error')

     

       111
       117
        
             }

     

       118
       118
       +
       

     

       112
       119
        
             return res.redirect('/')

     

       113
       120
        
           }),

     

       114
       121
        
         )

     
···

       116
       123
        
         // Login page

     

       117
       124
        
         router.get(

     

       118
       125
        
           '/login',

     

       119
       119
       -
           handler(async (req: Request, res: Response) => {

     

       126
       126
       +
           handler(async (req, res) => {

     

       120
       127
        
             res.setHeader('cache-control', `max-age=${MAX_AGE}, public`)

     

       121
       121
       -
       

     

       122
       122
       -
             return res.type('html').send(page(login({})))

     

       128
       128
       +
             res.type('html').send(page(login({})))

     

       123
       129
        
           }),

     

       124
       130
        
         )

     

       125
       131
        
       

     
···

       127
       133
        
         router.post(

     

       128
       134
        
           '/login',

     

       129
       135
        
           express.urlencoded(),

     

       130
       130
       -
           handler(async (req: Request, res: Response) => {

     

       136
       136
       +
           handler(async (req, res) => {

     

       137
       137
       +
             // Never store this route

     

       131
       138
        
             res.setHeader('cache-control', 'no-store')

     

       132
       139
        
       

     

       133
       133
       -
             const input = ifString(req.body.input)

     

       134
       134
       -
       

     

       135
       135
       -
             // Validate

     

       136
       136
       -
             if (!input) {

     

       137
       137
       -
               return res.type('html').send(page(login({ error: 'invalid input' })))

     

       138
       138
       -
             }

     

       139
       139
       -
       

     

       140
       140
       -
             // @NOTE "input" can be a handle, a DID or a service URL (PDS).

     

       141
       141
       -
       

     

       142
       140
        
             // Initiate the OAuth flow

     

       143
       141
        
             try {

     

       142
       142
       +
               // Validate input: can be a handle, a DID or a service URL (PDS).

     

       143
       143
       +
               const input = ifString(req.body.input)

     

       144
       144
       +
               if (!input) {

     

       145
       145
       +
                 throw new Error('Invalid input')

     

       146
       146
       +
               }

     

       147
       147
       +
       

     

       148
       148
       +
               // Initiate the OAuth flow

     

       144
       149
        
               const url = await ctx.oauthClient.authorize(input, {

     

       145
       150
        
                 scope: 'atproto transition:generic',

     

       146
       151
        
               })

     

       152
       152
       +
       

     

       147
       153
        
               res.redirect(url.toString())

     

       148
       154
        
             } catch (err) {

     

       149
       155
        
               ctx.logger.error({ err }, 'oauth authorize failed')

     

       150
       156
        
       

     

       151
       151
       -
               const error =

     

       152
       152
       -
                 err instanceof OAuthResolverError

     

       153
       153
       -
                   ? err.message

     

       154
       154
       -
                   : "couldn't initiate login"

     

       157
       157
       +
               const error = err instanceof Error ? err.message : 'unexpected error'

     

       155
       158
        
       

     

       156
       159
        
               return res.type('html').send(page(login({ error })))

     

       157
       160
        
             }

     
···

       161
       164
        
         // Signup

     

       162
       165
        
         router.get(

     

       163
       166
        
           '/signup',

     

       164
       164
       -
           handler(async (req: Request, res: Response) => {

     

       167
       167
       +
           handler(async (req, res) => {

     

       165
       168
        
             res.setHeader('cache-control', `max-age=${MAX_AGE}, public`)

     

       166
       169
        
       

     

       167
       170
        
             try {

     
···

       189
       192
        
         // Logout handler

     

       190
       193
        
         router.post(

     

       191
       194
        
           '/logout',

     

       192
       192
       -
           handler(async (req: Request, res: Response) => {

     

       195
       195
       +
           handler(async (req, res) => {

     

       193
       196
        
             // Never store this route

     

       194
       197
        
             res.setHeader('cache-control', 'no-store')

     

       195
       198
        
       

     
···

       217
       220
        
         // Homepage

     

       218
       221
        
         router.get(

     

       219
       222
        
           '/',

     

       220
       220
       -
           handler(async (req: Request, res: Response) => {

     

       221
       221
       -
             // Prevent caching of this page when the credentials change

     

       222
       222
       -
             res.setHeader('Vary', 'Cookie')

     

       223
       223
       -
       

     

       223
       223
       +
           handler(async (req, res) => {

     

       224
       224
        
             // If the user is signed in, get an agent which communicates with their server

     

       225
       225
        
             const agent = await getSessionAgent(req, res, ctx)

     

       226
       226
        
       

     
···

       250
       250
        
               return res.type('html').send(page(home({ statuses, didHandleMap })))

     

       251
       251
        
             }

     

       252
       252
        
       

     

       253
       253
       -
             // Make sure this page does not get cached in public caches (proxies)

     

       254
       254
       -
             res.setHeader('cache-control', 'private')

     

       255
       255
       -
       

     

       256
       253
        
             // Fetch additional information about the logged-in user

     

       257
       254
        
             const profileResponse = await agent.com.atproto.repo

     

       258
       255
        
               .getRecord({

     
···

       282
       279
        
         router.post(

     

       283
       280
        
           '/status',

     

       284
       281
        
           express.urlencoded(),

     

       285
       285
       -
           handler(async (req: Request, res: Response) => {

     

       286
       286
       -
             // Never store this route

     

       287
       287
       -
             res.setHeader('cache-control', 'no-store')

     

       288
       288
       -
       

     

       282
       282
       +
           handler(async (req, res) => {

     

       289
       283
        
             // If the user is signed in, get an agent which communicates with their server

     

       290
       284
        
             const agent = await getSessionAgent(req, res, ctx)

     

       291
       285
        
             if (!agent) {

     
···

       295
       289
        
                 .send('<h1>Error: Session required</h1>')

     

       296
       290
        
             }

     

       297
       291
        
       

     

       298
       298
       -
             // Construct & validate their status record

     

       299
       299
       -
             const rkey = TID.nextStr()

     

       292
       292
       +
             // Construct their status record

     

       300
       293
        
             const record = {

     

       301
       294
        
               $type: 'xyz.statusphere.status',

     

       302
       295
        
               status: req.body?.status,

     
···

       317
       310
        
               const res = await agent.com.atproto.repo.putRecord({

     

       318
       311
        
                 repo: agent.assertDid,

     

       319
       312
        
                 collection: 'xyz.statusphere.status',

     

       320
       320
       -
                 rkey,

     

       313
       313
       +
                 rkey: TID.nextStr(),

     

       321
       314
        
                 record,

     

       322
       315
        
                 validate: false,

     

       323
       316
        
               })

Compare changes