comparing 9bddf0e5a9d2dfb3a993ebc0885e47e7e3591eb6 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

src/context.ts

···

       37
       37
        
           logger,

     

       38
       38
        
           oauthClient,

     

       39
       39
        
           resolver,

     

       40
       40
       +
       

     

       40
       41
        
           async destroy() {

     

       41
       42
        
             await ingester.destroy()

     

       42
       43
        
             await db.destroy()

+1 -1

src/index.ts

···

       29
       29
        
         // Gracefully shutdown the http server

     

       30
       30
        
         await terminate()

     

       31
       31
        
       

     

       32
       32
       -
         // Close the firehose connection

     

       32
       32
       +
         // Gracefully shutdown the application context

     

       33
       33
        
         await ctx.destroy()

     

       34
       34
        
       })

+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 {

+74 -40

src/routes.ts

···

       17
       17
        
       import { handler } from '#/lib/http'

     

       18
       18
        
       import { ifString } from '#/lib/util'

     

       19
       19
        
       import { page } from '#/lib/view'

     

       20
       20
       -
       import { home, STATUS_OPTIONS } from '#/pages/home'

     

       20
       20
       +
       import { home } from '#/pages/home'

     

       21
       21
        
       import { login } from '#/pages/login'

     

       22
       22
        
       

     

       23
       23
       +
       // Max age, in seconds, for static routes and assets

     

       24
       24
       +
       const MAX_AGE = env.NODE_ENV === 'production' ? 60 : 0

     

       25
       25
       +
       

     

       23
       26
        
       type Session = { did?: string }

     

       24
       27
        
       

     

       25
       28
        
       // Helper function to get the Atproto Agent for the active session

     
···

       28
       31
        
         res: ServerResponse,

     

       29
       32
        
         ctx: AppContext,

     

       30
       33
        
       ) {

     

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

     

       35
       35
       +
       

     

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

     

       32
       37
        
           cookieName: 'sid',

     

       33
       38
        
           password: env.COOKIE_SECRET,

     

       34
       39
        
         })

     

       35
       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
       +
       

     

       36
       45
        
         try {

     

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

     

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

     
···

       43
       52
        
         }

     

       44
       53
        
       }

     

       45
       54
        
       

     

       46
       46
       -
       export function createRouter(ctx: AppContext): RequestListener {

     

       55
       55
       +
       export const createRouter = (ctx: AppContext): RequestListener => {

     

       47
       56
        
         const router = express()

     

       48
       57
        
       

     

       49
       58
        
         // Static assets

     

       50
       50
       -
         router.use('/public', express.static(path.join(__dirname, 'pages', 'public')))

     

       59
       59
       +
         router.use(

     

       60
       60
       +
           '/public',

     

       61
       61
       +
           express.static(path.join(__dirname, 'pages', 'public'), {

     

       62
       62
       +
             maxAge: MAX_AGE * 1000,

     

       63
       63
       +
           }),

     

       64
       64
       +
         )

     

       51
       65
        
       

     

       52
       66
        
         // OAuth metadata

     

       53
       67
        
         router.get(

     

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

     

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

     

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

     

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

     

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

     

       57
       72
        
           }),

     

       58
       73
        
         )

     
···

       60
       75
        
         // Public keys

     

       61
       76
        
         router.get(

     

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

     

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

     

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

     

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

     

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

     

       65
       81
        
           }),

     

       66
       82
        
         )

     
···

       68
       84
        
         // OAuth callback to complete session creation

     

       69
       85
        
         router.get(

     

       70
       86
        
           '/oauth/callback',

     

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

     

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

     

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

     

       89
       89
       +
       

     

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

     

       73
       91
        
             try {

     

       74
       92
        
               // Load the session cookie

     
···

       92
       110
        
       

     

       93
       111
        
               // Update the session cookie

     

       94
       112
        
               session.did = oauth.session.did

     

       113
       113
       +
       

     

       95
       114
        
               await session.save()

     

       96
       115
        
             } catch (err) {

     

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

     

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

     

       99
       117
        
             }

     

       118
       118
       +
       

     

       100
       119
        
             return res.redirect('/')

     

       101
       120
        
           }),

     

       102
       121
        
         )

     
···

       104
       123
        
         // Login page

     

       105
       124
        
         router.get(

     

       106
       125
        
           '/login',

     

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

     

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

     

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

     

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

     

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

     

       109
       129
        
           }),

     

       110
       130
        
         )

     

       111
       131
        
       

     
···

       113
       133
        
         router.post(

     

       114
       134
        
           '/login',

     

       115
       135
        
           express.urlencoded(),

     

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

     

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

     

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

     

       137
       137
       +
             // Never store this route

     

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

     

       118
       139
        
       

     

       119
       119
       -
             // Validate

     

       120
       120
       -
             if (!input) {

     

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

     

       140
       140
       +
             // Initiate the OAuth flow

     

       141
       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

     

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

     

       150
       150
       +
                 scope: 'atproto transition:generic',

     

       151
       151
       +
               })

     

       152
       152
       +
       

     

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

     

       154
       154
       +
             } catch (err) {

     

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

     

       156
       156
       +
       

     

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

     

       158
       158
       +
       

     

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

     

       122
       160
        
             }

     

       123
       161
        
           }),

     

       124
       162
        
         )

     
···

       126
       164
        
         // Signup

     

       127
       165
        
         router.get(

     

       128
       166
        
           '/signup',

     

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

     

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

     

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

     

       169
       169
       +
       

     

       130
       170
        
             try {

     

       131
       171
        
               const service = env.PDS_URL ?? 'https://bsky.social'

     

       132
       172
        
               const url = await ctx.oauthClient.authorize(service, {

     
···

       152
       192
        
         // Logout handler

     

       153
       193
        
         router.post(

     

       154
       194
        
           '/logout',

     

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

     

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

     

       196
       196
       +
             // Never store this route

     

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

     

       198
       198
       +
       

     

       156
       199
        
             const session = await getIronSession<Session>(req, res, {

     

       157
       200
        
               cookieName: 'sid',

     

       158
       201
        
               password: env.COOKIE_SECRET,

     
···

       177
       220
        
         // Homepage

     

       178
       221
        
         router.get(

     

       179
       222
        
           '/',

     

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

     

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

     

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

     

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

     

       183
       226
        
       

     
···

       226
       269
        
                 : {}

     

       227
       270
        
       

     

       228
       271
        
             // Serve the logged-in view

     

       229
       229
       -
             res.type('html').send(

     

       230
       230
       -
               page(

     

       231
       231
       -
                 home({

     

       232
       232
       -
                   statuses,

     

       233
       233
       -
                   didHandleMap,

     

       234
       234
       -
                   profile,

     

       235
       235
       -
                   myStatus,

     

       236
       236
       -
                 }),

     

       237
       237
       -
               ),

     

       238
       238
       -
             )

     

       272
       272
       +
             res

     

       273
       273
       +
               .type('html')

     

       274
       274
       +
               .send(page(home({ statuses, didHandleMap, profile, myStatus })))

     

       239
       275
        
           }),

     

       240
       276
        
         )

     

       241
       277
        
       

     
···

       243
       279
        
         router.post(

     

       244
       280
        
           '/status',

     

       245
       281
        
           express.urlencoded(),

     

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

     

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

     

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

     

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

     

       249
       285
        
             if (!agent) {

     

       250
       250
       -
               return res.redirect(`/login`)

     

       251
       251
       -
             }

     

       252
       252
       -
       

     

       253
       253
       -
             const status = ifString(req.body?.status)

     

       254
       254
       -
             if (!status || !STATUS_OPTIONS.includes(status)) {

     

       255
       255
       -
               throw new Error('Invalid status')

     

       286
       286
       +
               return res

     

       287
       287
       +
                 .status(401)

     

       288
       288
       +
                 .type('html')

     

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

     

       256
       290
        
             }

     

       257
       291
        
       

     

       258
       258
       -
             // Construct & validate their status record

     

       259
       259
       -
             const rkey = TID.nextStr()

     

       292
       292
       +
             // Construct their status record

     

       260
       293
        
             const record = {

     

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

     

       262
       262
       -
               status,

     

       295
       295
       +
               status: req.body?.status,

     

       263
       296
        
               createdAt: new Date().toISOString(),

     

       264
       297
        
             }

     

       265
       298
        
       

     

       299
       299
       +
             // Make sure the record generated from the input is valid

     

       266
       300
        
             if (!Status.validateRecord(record).success) {

     

       267
       301
        
               return res

     

       268
       302
        
                 .status(400)

     
···

       270
       304
        
                 .send('<h1>Error: Invalid status</h1>')

     

       271
       305
        
             }

     

       272
       306
        
       

     

       273
       273
       -
             // Write the status record to the user's repository

     

       274
       307
        
             let uri

     

       275
       308
        
             try {

     

       309
       309
       +
               // Write the status record to the user's repository

     

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

     

       277
       311
        
                 repo: agent.assertDid,

     

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

     

       279
       279
       -
                 rkey,

     

       313
       313
       +
                 rkey: TID.nextStr(),

     

       280
       314
        
                 record,

     

       281
       315
        
                 validate: false,

     

       282
       316
        
               })

     
···

       311
       345
        
               )

     

       312
       346
        
             }

     

       313
       347
        
       

     

       314
       314
       -
             res.redirect('/')

     

       348
       348
       +
             return res.redirect('/')

     

       315
       349
        
           }),

     

       316
       350
        
         )

     

       317
       351

Compare changes