@jcbuisson/express-x-plugins 4.0.8 → 4.0.10

package/README.md

@@ -2,7 +2,7 @@
 # express-x-plugins
 
 
-IMPORTANT
+IMPORTANT FOR ELECTRIC
 
 # set lc_messages=C for the PostgreSQL role so Electric receives recognizable English errors
 ALTER ROLE chris SET lc_messages = 'C';
@@ -13,9 +13,10 @@ ALTER SYSTEM SET max_replication_slots = 10;
 ALTER SYSTEM SET max_wal_senders = 10;
 ALTER ROLE chris WITH REPLICATION;
 
-## restart postgres
-sudo systemctl restart postgresql
+(restart postgres: `sudo systemctl restart postgresql`)
 
+## Use HTTP2
+nginx: `listen 443 ssl http2;`
 
 
 Currently includes:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jcbuisson/express-x-plugins",
-  "version": "4.0.8",
+  "version": "4.0.10",
   "description": "Plugins for express-x",
   "type": "module",
   "main": "./src/electric-server-plugin.mjs",

package/src/electric-client-plugin.mjs

@@ -2,17 +2,6 @@ import { Shape, ShapeStream } from '@electric-sql/client'
 import { firstValueFrom, Observable, Subject, takeUntil } from 'rxjs'
 import { getCurrentScope, onScopeDispose, ref } from 'vue'
 
-export class DisposableShape extends Shape {
-   subscribe(callback) {
-      const unsubscribe = super.subscribe(callback)
-      return () => {
-         unsubscribe()
-         if (this.numSubscribers === 0) this.stream.unsubscribeAll()
-      }
-   }
-}
-
-
 /**
  * Add Electric-backed reactive models to an Express-X client.
  *
@@ -100,6 +89,16 @@ export function electricClientPlugin(app, options = {}) {
 
 //////////////////////                   UTILITIES                   //////////////////////
 
+export class DisposableShape extends Shape {
+   subscribe(callback) {
+      const unsubscribe = super.subscribe(callback)
+      return () => {
+         unsubscribe()
+         if (this.numSubscribers === 0) this.stream.unsubscribeAll()
+      }
+   }
+}
+
 const IDENTIFIER = /^[A-Za-z_][A-Za-z0-9_]*$/
 const RANGE_OPERATORS = { gt: '>', gte: '>=', lt: '<', lte: '<=' }
 

package/src/electric-server-plugin.mjs

@@ -91,7 +91,7 @@ export function electricOfflinePlugin(app, db, models, options = {}) {
 
          update: async function(id, data) {
             await authorize(this, model.name, 'update', [id, data])
-            const set = buildSet(data)
+            const set = buildSet(data, model.primaryKey)
             return withTransaction(db, async client => {
                const result = await client.query(
                   `UPDATE ${model.quotedTable} SET ${set.sql} WHERE ${model.quotedPrimaryKey} = $${set.values.length + 1} RETURNING *`,
@@ -208,9 +208,9 @@ function buildWhere(where, startIndex = 1) {
    return { sql: clauses.length ? clauses.join(' AND ') : 'TRUE', values }
 }
 
-function buildSet(data, startIndex = 1) {
+function buildSet(data, primaryKey, startIndex = 1) {
    assertPlainObject(data, 'mutation data')
-   const entries = Object.entries(data).filter(([key, value]) => key !== 'uid' && value !== undefined)
+   const entries = Object.entries(data).filter(([key, value]) => key !== primaryKey && value !== undefined)
    if (entries.length === 0) throw new TypeError('mutation data must contain at least one field')
    return {
       sql: entries.map(([column], index) => `${quoteIdentifier(column, 'data column')} = $${startIndex + index}`).join(', '),

package/src/reload-client-plugin.mjs

@@ -6,20 +6,18 @@
  */
 export async function reloadPlugin(app) {
 
-   const cnxid = useSessionStorage('cnxid', '')
-   const cnxtoken = useSessionStorage('cnxtoken', '')
    const handleTransferToken = token => {
-      if (typeof token === 'string') cnxtoken.value = token
+      if (typeof token === 'string') sessionStorage.setItem('cnxtoken', token)
    }
 
    app.addConnectListener(async (socket) => {
       const socketId = socket.id
       console.log('connect', socketId)
-      const prevSocketId = cnxid.value
-      const prevTransferToken = cnxtoken.value
+      const prevSocketId = sessionStorage.getItem('cnxid') ?? ''
+      const prevTransferToken = sessionStorage.getItem('cnxtoken') ?? ''
       socket.off('cnx-transfer-token', handleTransferToken)
       socket.on('cnx-transfer-token', handleTransferToken)
-      cnxid.value = socketId
+      sessionStorage.setItem('cnxid', socketId)
       if (prevSocketId && prevTransferToken) {
          console.log('cnx-transfer', prevSocketId, 'to', socketId)
          let timeout

package/test/electric-client-plugin.test.mjs

@@ -77,23 +77,6 @@ test('getObservable emits Shape rows and cleans up its subscription', () => {
    subscription.unsubscribe()
 })
 
-test('getVueRef returns Shape rows in a Vue ref and cleans up with its scope', () => {
-   const app = { service: () => ({}) }
-   electricClientPlugin(app, { ShapeStream: FakeStream, Shape: FakeShape })
-   const todo = app.createElectricModel('todos')
-   const scope = effectScope()
-   let rows
-
-   scope.run(() => { rows = todo.getVueRef({ completed: false }) })
-
-   assert.equal(isRef(rows), true)
-   assert.deepEqual(rows.value, [{ uid: 'one', completed: false }])
-   const shape = FakeStream.instances.at(-1).shape
-   assert.equal(shape.unsubscribed, undefined)
-   scope.stop()
-   assert.equal(shape.unsubscribed, true)
-})
-
 test('findMany resolves with the first Shape rows and cleans up its subscription', async () => {
    const app = { service: () => ({}) }
    electricClientPlugin(app, { ShapeStream: FakeStream, Shape: FakeShape })

package/test/electric-server-plugin.test.mjs

@@ -48,6 +48,32 @@ test('allows the database to generate a primary key', async () => {
    assert.equal(queries[1].sql, 'INSERT INTO "todos" DEFAULT VALUES RETURNING *')
 })
 
+test('protects the configured primary key during updates', async () => {
+   const services = new Map()
+   const queries = []
+   const db = {
+      async query(sql, values = []) {
+         queries.push({ sql, values })
+         return { rows: [] }
+      },
+   }
+   const app = {
+      createService(name, methods) { services.set(name, methods) },
+      get() {},
+   }
+   electricOfflinePlugin(app, db, [{ name: 'people', primaryKey: 'id' }], {
+      authorize: async () => true,
+   })
+
+   await services.get('people').update.call({}, 7, { id: 99, uid: 'editable', name: 'Ada' })
+
+   assert.equal(
+      queries[0].sql,
+      'UPDATE "people" SET "uid" = $1, "name" = $2 WHERE "id" = $3 RETURNING *',
+   )
+   assert.deepEqual(queries[0].values, ['editable', 'Ada', 7])
+})
+
 test('requires authorization and reports forbidden calls', async () => {
    const { services } = fixture({ authorize: async () => false })
    await assert.rejects(