@things-factory/figure-service 10.1.112 → 10.1.113

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/figure-service",
-  "version": "10.1.112",
+  "version": "10.1.113",
   "publishConfig": {
     "access": "public",
     "@things-factory:registry": "https://registry.npmjs.org"
@@ -28,13 +28,13 @@
     "@hatiolab/figure-model": "^0.2.10",
     "@operato/typeorm-history": "^10.0.0",
     "@things-factory/ai-client-base": "^10.1.81",
-    "@things-factory/attachment-base": "^10.1.112",
-    "@things-factory/auth-base": "^10.1.111",
+    "@things-factory/attachment-base": "^10.1.113",
+    "@things-factory/auth-base": "^10.1.113",
     "@things-factory/env": "^10.1.20",
     "@things-factory/shell": "^10.1.106",
     "graphql-scalars": "^1.22.4",
     "graphql-upload": "^15.0.2",
     "koa-router": "^7.4.0"
   },
-  "gitHead": "e300d1b60b98ccb80380afe8df6d2807b1bcff91"
+  "gitHead": "9da1e467ddce23e600e64f08454289cb3b806212"
 }

package/server/index.ts

@@ -26,6 +26,8 @@ process.on('bootstrap-module-start' as any, () => {
  */
 import { getDataSource, inBootTurn } from '@things-factory/shell'
 import { moveBase64Thumbnails } from './service/figure/figure-thumbnail-upgrade.js'
+/* Who may read a figure picture by its attachment path (ADR-0106): registered with attachment-base at load. */
+import './service/figure/figure-thumbnail-reader.js'
 process.on('bootstrap-module-start' as any, () => {
   inBootTurn(() => moveBase64Thumbnails(getDataSource()))
     .then(moved => {

package/server/routers/figure-thumbnail-router.ts

@@ -105,15 +105,22 @@ export async function sendFigureThumbnail(
     attachment 의 공개 경로가 쓰는 `public` 을 따라 쓰지 않는다(판정 조건 1). 같은 내용은 같은 해시이므로 ETag 가
     곧 내용이다. 부르는 쪽이 `?v=` 로 판을 가리므로 오래 두어도 낡은 그림이 남지 않는다.
   */
-  context.type = picture.mimetype
-  context.set('Cache-Control', 'private, max-age=31536000')
-  context.set('ETag', `"${found.thumbnailHash}"`)
-  if (found.thumbnailUpdatedAt) context.set('Last-Modified', new Date(found.thumbnailUpdatedAt).toUTCString())
+  const ours = () => {
+    context.type = picture.mimetype
+    context.set('Cache-Control', 'private, max-age=31536000')
+    context.set('ETag', `"${found.thumbnailHash}"`)
+    if (found.thumbnailUpdatedAt) context.set('Last-Modified', new Date(found.thumbnailUpdatedAt).toUTCString())
+  }
+  ours()
+  /* koa answers `fresh` only for a 2xx: before a body the status is still 404, and the check never matched. */
+  context.status = 200
   if (context.fresh) {
     context.status = 304
     return
   }
   await files.send(context, picture.path!, next)
+  /* The storage sets its own (S3 its ETag, attachment's Cache-Control): this door's are said last. */
+  ours()
 }
 
 /**

package/server/service/figure/figure-thumbnail-db.test.ts

@@ -37,7 +37,10 @@ function mapFiles() {
       kept.set(path, bytes)
       return { id, path, size: bytes.length }
     },
+    /* As S3 does: its own tag and cache rule on the way out. */
     async send(koa: any, path: string) {
+      koa.set('ETag', '"storage-md5"')
+      koa.set('Cache-Control', 'public, max-age=31536000')
       koa.body = kept.get(path)
     }
   }
@@ -89,15 +92,16 @@ const attachments = (domainId?: string) =>
 function koa(ifNoneMatch?: string) {
   const headers: Record<string, string> = {}
   return {
-    status: 200,
+    status: 404,
     type: '',
     body: undefined as any,
     headers,
     set(k: string, v: string) {
       headers[k] = v
     },
+    /* As koa: fresh only for a 2xx or 304, and only when the request's tag is the response's. */
     get fresh() {
-      return !!ifNoneMatch && ifNoneMatch === headers['ETag']
+      return ((this.status >= 200 && this.status < 300) || this.status === 304) && !!ifNoneMatch && ifNoneMatch === headers['ETag']
     }
   }
 }
@@ -216,3 +220,17 @@ describe('the base64 an install holds, moved at start without losing one', () =>
     expect((await attachments(domain.id)).length).toBe(3)
   })
 })
+
+/* ADR-0106 decision 2: by its attachment path, a figure picture opens to whoever may query figures, as by its figure. */
+describe('read by its attachment path', () => {
+  it('figure registers the reader for its pictures, and it asks the figure query permission', async () => {
+    const { figureThumbnailReader } = loadCompiled('service/figure/figure-thumbnail-reader')
+    expect(attachmentBase.attachmentReaderOf('figure-thumbnail')).toBeDefined()
+    const asked: any[] = []
+    const check = async (...args: any[]) => (asked.push(args), false)
+    const context = { state: { domain: { id: 'd' }, user: { id: 'u' }, unsafeIP: false, prohibitedPrivileges: [] } }
+    expect(await figureThumbnailReader({}, context, check)).toBe(false)
+    expect(asked[0][0]).toEqual({ category: 'figure', privilege: 'query', owner: true })
+    expect(await figureThumbnailReader({}, context, async () => true)).toBe(true)
+  })
+})

package/server/service/figure/figure-thumbnail-reader.ts

@@ -0,0 +1,20 @@
+import { registerAttachmentReader } from '@things-factory/attachment-base'
+import { checkPermission } from '@things-factory/auth-base'
+
+import { THUMBNAIL_REF_TYPE } from './figure-thumbnail-store.js'
+
+/*
+ * Apart from the store, and loaded only by the server's entry: the store is read by pure modules (the save path,
+ * figure-ui's tests), and auth-base brings shell's routers with it.
+ */
+/**
+ * Who may read a figure picture by its attachment path (ADR-0106 decision 2): whoever may query figures -- the same door
+ * `/figure-thumbnail/:id` keeps, so the picture is no more open by its path than by its figure. attachment-base has
+ * already checked the attachment is of the request's domain.
+ */
+export async function figureThumbnailReader(_attachment: unknown, context: any, check: typeof checkPermission = checkPermission): Promise<boolean> {
+  const { domain, user, unsafeIP, prohibitedPrivileges } = context?.state ?? {}
+  return !!(await check({ category: 'figure', privilege: 'query', owner: true }, user, domain, unsafeIP, prohibitedPrivileges))
+}
+
+registerAttachmentReader(THUMBNAIL_REF_TYPE, (attachment, context) => figureThumbnailReader(attachment, context))

package/server/service/figure/figure-thumbnail-store.ts

@@ -105,3 +105,4 @@ export async function keepThumbnail(
   })
   return hash
 }
+