@toa.io/extensions.exposition 0.24.0-alpha.22 → 0.24.0-alpha.23

package/features/octets.feature

@@ -70,17 +70,6 @@ Feature: Octets directive family
       """
       304 Not Modified
       """
-    When the following request is received:
-      """
-      GET /10cf16b458f759e0d617f2f3d83599ff:meta HTTP/1.1
-      accept: text/plain
-      """
-    Then the following reply is sent:
-      """
-      403 Forbidden
-
-      Metadata is not accessible.
-      """
     When the following request is received:
       """
       GET / HTTP/1.1
@@ -245,7 +234,7 @@ Feature: Octets directive family
       Trailing slash is redundant.
       """
 
-  Scenario: Accessing an Entry and the original BLOLB
+  Scenario: Original BLOLB is not accessible
     Given the annotation:
       """yaml
       /:
@@ -267,21 +256,6 @@ Feature: Octets directive family
       """
       201 Created
       """
-    When the following request is received:
-      """
-      GET /10cf16b458f759e0d617f2f3d83599ff:meta HTTP/1.1
-      accept: application/yaml
-      """
-    Then the following reply is sent:
-      """
-      200 OK
-      content-type: application/yaml
-      content-length: 124
-
-      id: 10cf16b458f759e0d617f2f3d83599ff
-      type: application/octet-stream
-      size: 8169
-      """
     When the following request is received:
       """
       GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1

package/features/octets.meta.feature

@@ -0,0 +1,65 @@
+Feature: Octets `content-meta` header
+
+  Scenario: Sending `content-meta` header
+    Given the `octets.tester` is running
+    And the annotation:
+      """yaml
+      /:
+        auth:anonymous: true
+        octets:context: octets
+        /*:
+          POST:
+            octets:store: ~
+          /*:
+            GET:
+              octets:fetch:
+                meta: true
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST /meta-header/ HTTP/1.1
+      content-type: application/octet-stream
+      content-meta: foo, bar=baz=1
+      content-meta: baz=1
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """
+    When the following request is received:
+      """
+      GET /meta-header/10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      accept: application/vnd.toa.octets.entry+yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      id: 10cf16b458f759e0d617f2f3d83599ff
+      type: application/octet-stream
+      size: 8169
+      meta:
+        foo: 'true'
+        bar: baz=1
+        baz: '1'
+      """
+
+  Scenario: CORS allows `content-meta` header
+    Given the annotation:
+      """yaml
+      /:
+        octets:context: octets
+        POST:
+          octets:store: ~
+      """
+    When the following request is received:
+      """
+      OPTIONS / HTTP/1.1
+      origin: http://example.com
+      """
+    Then the following reply is sent:
+      """
+      204 No Content
+      access-control-allow-origin: http://example.com
+      access-control-allow-headers: accept, authorization, content-type, content-meta
+      """

package/features/octets.workflows.feature

@@ -2,7 +2,7 @@ Feature: Octets storage workflows
 
   Scenario: Running a workflow
     Given the `octets.tester` is running
-    Given the annotation:
+    And the annotation:
       """yaml
       /:
         auth:anonymous: true
@@ -47,8 +47,8 @@ Feature: Octets storage workflows
       """
     When the following request is received:
       """
-      GET /10cf16b458f759e0d617f2f3d83599ff:meta HTTP/1.1
-      accept: application/yaml
+      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      accept: application/vnd.toa.octets.entry+yaml
       """
     Then the following reply is sent:
       """
@@ -74,7 +74,7 @@ Feature: Octets storage workflows
       content-length: 473831
       """
 
-  Scenario: Getting error when adding metadata to a file
+  Scenario: Getting error when running workflow on `store`
     Given the `octets.tester` is running
     Given the annotation:
       """yaml
@@ -112,3 +112,104 @@ Feature: Octets storage workflows
         message: Something went wrong
       --cut--
       """
+
+  Scenario: Running a workflow on `delete`
+    Given the `octets.tester` is running
+    And the annotation:
+      """yaml
+      /:
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:store: ~
+        /*:
+          GET:
+            octets:fetch: ~
+          DELETE:
+            octets:delete:
+              workflow:
+                echo: octets.tester.echo
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """
+    When the following request is received:
+      """
+      DELETE /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      202 Accepted
+      content-type: multipart/yaml; boundary=cut
+
+      --cut
+      echo: 10cf16b458f759e0d617f2f3d83599ff
+      --cut--
+      """
+    When the following request is received:
+      """
+      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      404 Not Found
+      """
+
+  Scenario: Error in the workflow on `delete`
+    Given the `octets.tester` is running
+    And the annotation:
+      """yaml
+      /:
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:store: ~
+        /*:
+          GET:
+            octets:fetch: ~
+          DELETE:
+            octets:delete:
+              workflow:
+                err: octets.tester.err
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """
+    When the following request is received:
+      """
+      DELETE /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      202 Accepted
+      content-type: multipart/yaml; boundary=cut
+
+      --cut
+      error:
+        step: err
+        code: ERROR
+        message: Something went wrong
+      --cut--
+      """
+    When the following request is received:
+      """
+      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """

package/features/steps/Captures.ts

@@ -1,5 +1,6 @@
-import * as http from '@toa.io/http'
+import * as http from '@toa.io/agent'
 import { binding } from 'cucumber-tsflow'
 
 @binding()
-export class Captures extends http.Captures {}
+export class Captures extends http.Captures {
+}

package/features/steps/HTTP.ts

@@ -2,7 +2,7 @@ import * as assert from 'node:assert'
 import * as fs from 'node:fs'
 import * as path from 'node:path'
 import { binding, then, when } from 'cucumber-tsflow'
-import * as http from '@toa.io/http'
+import * as http from '@toa.io/agent'
 import * as msgpack from 'msgpackr'
 import * as YAML from 'js-yaml'
 import { Captures } from './Captures'

package/features/steps/Parameters.ts

@@ -16,6 +16,6 @@ process.env.TOA_DEV = '1'
 process.env.TOA_STORAGES = encode({
   octets: {
     provider: 'tmp',
-    prefix: 'test'
+    directory: 'exposition'
   }
 })

package/features/steps/components/octets.tester/manifest.toa.yaml

@@ -12,4 +12,5 @@ operations:
   bar: *operation
   baz: *operation
   err: *operation
+  echo: *operation
   diversify: *operation

package/features/steps/components/octets.tester/operations/echo.js

@@ -0,0 +1,7 @@
+'use strict'
+
+async function baz (input) {
+  return input.entry.id
+}
+
+exports.computation = baz

package/features/steps/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "ESNext",
-    "outDir": "/dev/null",
+    "noEmit": true,
     "moduleResolution": "node",
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/extensions.exposition",
-  "version": "0.24.0-alpha.22",
+  "version": "0.24.0-alpha.23",
   "description": "Toa Exposition",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -17,10 +17,10 @@
     "access": "public"
   },
   "dependencies": {
-    "@toa.io/core": "0.24.0-alpha.22",
-    "@toa.io/generic": "0.24.0-alpha.22",
-    "@toa.io/schemas": "0.24.0-alpha.22",
-    "@toa.io/streams": "0.24.0-alpha.22",
+    "@toa.io/core": "0.24.0-alpha.23",
+    "@toa.io/generic": "0.24.0-alpha.23",
+    "@toa.io/schemas": "0.24.0-alpha.23",
+    "@toa.io/streams": "0.24.0-alpha.23",
     "bcryptjs": "2.4.3",
     "error-value": "0.3.0",
     "express": "4.18.2",
@@ -45,12 +45,12 @@
     "features": "cucumber-js"
   },
   "devDependencies": {
-    "@toa.io/extensions.storages": "0.24.0-alpha.22",
-    "@toa.io/http": "0.24.0-alpha.22",
+    "@toa.io/agent": "0.24.0-alpha.23",
+    "@toa.io/extensions.storages": "0.24.0-alpha.23",
     "@types/bcryptjs": "2.4.3",
     "@types/cors": "2.8.13",
     "@types/express": "4.17.17",
     "@types/negotiator": "0.6.1"
   },
-  "gitHead": "9680eca8da28019924a4c7cac5d803954d6c6936"
+  "gitHead": "df9de3cbb530e8f985a660bca0bf65bd027dbb01"
 }

package/schemas/octets/delete.cos.yaml

@@ -1 +1,2 @@
-~
+workflow+: <string>
+_: true

package/schemas/octets/list.cos.yaml

@@ -1 +1,2 @@
-~
+meta: boolean
+_: true

package/source/HTTP/Server.ts

@@ -7,7 +7,6 @@ import Negotiator from 'negotiator'
 import { read, write, type IncomingMessage, type OutgoingMessage } from './messages'
 import { ClientError, Exception } from './exceptions'
 import { formats, types } from './formats'
-import type { Format } from './formats'
 import type * as http from 'node:http'
 import type { Express, Request, Response, NextFunction } from 'express'
 
@@ -84,7 +83,8 @@ export class Server extends Connector {
   private extend (request: Request): IncomingMessage {
     const message = request as IncomingMessage
 
-    message.encoder = negotiate(request)
+    negotiate(request, message)
+
     message.pipelines = { body: [], response: [] }
 
     message.parse = async <T> (): Promise<T> => {
@@ -145,11 +145,23 @@ function supportedMethods (methods: Set<string>) {
   }
 }
 
-function negotiate (request: Request): Format | null {
+function negotiate (request: Request, message: IncomingMessage): void {
+  if (request.headers.accept !== undefined) {
+    const match = SUBTYPE.exec(request.headers.accept)
+
+    if (match !== null) {
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      const { type, subtype, suffix } = match.groups!
+
+      request.headers.accept = `${type}/${suffix}`
+      message.subtype = subtype
+    }
+  }
+
   const negotiator = new Negotiator(request)
   const mediaType = negotiator.mediaType(types)
 
-  return mediaType === undefined ? null : formats[mediaType]
+  message.encoder = mediaType === undefined ? null : formats[mediaType]
 }
 
 // https://github.com/whatwg/fetch/issues/1254
@@ -177,3 +189,5 @@ interface Properties {
 }
 
 export type Processing = (input: IncomingMessage) => Promise<OutgoingMessage>
+
+const SUBTYPE = /^(?<type>\w{1,32})\/(vnd\.toa\.(?<subtype>\S{1,32})\+)(?<suffix>\S{1,32})$/

package/source/HTTP/messages.ts

@@ -104,6 +104,7 @@ export interface IncomingMessage extends Request {
   query: Query
   parse: <T> () => Promise<T>
   encoder: Format | null
+  subtype: string | null
   pipelines: {
     body: Array<(input: unknown) => unknown>
     response: Array<(output: OutgoingMessage) => void>

package/source/directives/octets/Delete.ts

@@ -1,18 +1,27 @@
+import { Readable } from 'stream'
 import { NotFound } from '../../HTTP'
 import * as schemas from './schemas'
+import { Workflow } from './workflow'
+import type { Unit } from './workflow'
 import type { Maybe } from '@toa.io/types'
 import type { Component } from '@toa.io/core'
 import type { Output } from '../../io'
 import type { Directive, Input } from './types'
+import type { Remotes } from '../../Remotes'
+import type { Entry } from '@toa.io/extensions.storages'
 
 export class Delete implements Directive {
   public readonly targeted = true
 
+  private readonly workflow?: Workflow
   private readonly discovery: Promise<Component>
   private storage: Component | null = null
 
-  public constructor (value: null, discovery: Promise<Component>) {
-    schemas.remove.validate(value)
+  public constructor (options: Options | null, discovery: Promise<Component>, remotes: Remotes) {
+    schemas.remove.validate(options)
+
+    if (options?.workflow !== undefined)
+      this.workflow = new Workflow(options.workflow, remotes)
 
     this.discovery = discovery
   }
@@ -20,12 +29,42 @@ export class Delete implements Directive {
   public async apply (storage: string, request: Input): Promise<Output> {
     this.storage ??= await this.discovery
 
-    const input = { storage, path: request.path }
-    const error = await this.storage.invoke<Maybe<unknown>>('delete', { input })
+    const entry = await this.storage.invoke<Maybe<Entry>>('get',
+      { input: { storage, path: request.url } })
 
-    if (error instanceof Error)
+    if (entry instanceof Error)
       throw new NotFound()
 
-    return {}
+    const output: Output = {}
+
+    if (this.workflow !== undefined) {
+      output.status = 202
+      output.body = Readable.from(this.execute(request, storage, entry))
+    } else
+      await this.delete(storage, request)
+
+    return output
   }
+
+  private async delete (storage: string, request: Input): Promise<void> {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    await this.storage!.invoke('delete',
+      { input: { storage, path: request.url } })
+  }
+
+  private async * execute (request: Input, storage: string, entry: Entry): AsyncGenerator {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    for await (const chunk of this.workflow!.execute(request, storage, entry)) {
+      yield chunk
+
+      if (typeof chunk === 'object' && chunk !== null && 'error' in chunk)
+        return
+    }
+
+    await this.delete(storage, request)
+  }
+}
+
+export interface Options {
+  workflow?: Unit[] | Unit
 }

package/source/directives/octets/Fetch.ts

@@ -12,11 +12,11 @@ import type { Directive, Input } from './types'
 export class Fetch implements Directive {
   public readonly targeted = true
 
-  private readonly permissions: Permissions = { blob: true, meta: false }
+  private readonly permissions: Required<Permissions> = { blob: true, meta: false }
   private readonly discovery: Promise<Component>
   private storage: Component = null as unknown as Component
 
-  public constructor (permissions: Partial<Permissions> | null, discovery: Promise<Component>) {
+  public constructor (permissions: Permissions | null, discovery: Promise<Component>) {
     schemas.fetch.validate(permissions)
 
     Object.assign(this.permissions, permissions)
@@ -26,19 +26,22 @@ export class Fetch implements Directive {
   public async apply (storage: string, request: Input): Promise<Output> {
     this.storage ??= await this.discovery
 
-    if (request.url.slice(-5) === ':meta')
-      return await this.get(storage, request)
-    else
-      return await this.fetch(storage, request)
-  }
+    const variant = posix.basename(request.url).includes('.')
+    const metadata = request.subtype === 'octets.entry'
 
-  private async fetch (storage: string, request: Input): Promise<Output> {
-    const filename = posix.basename(request.url)
-    const variant = filename.includes('.')
+    if (!variant && metadata)
+      if (this.permissions.meta)
+        return this.get(storage, request)
+      else
+        throw new Forbidden('Metadata is not accessible.')
 
     if (!variant && !this.permissions.blob)
       throw new Forbidden('BLOB variant must be specified.')
 
+    return await this.fetch(storage, request)
+  }
+
+  private async fetch (storage: string, request: Input): Promise<Output> {
     if ('if-none-match' in request.headers)
       return { status: 304 }
 
@@ -58,11 +61,7 @@ export class Fetch implements Directive {
   }
 
   private async get (storage: string, request: Input): Promise<Output> {
-    if (!this.permissions.meta)
-      throw new Forbidden('Metadata is not accessible.')
-
-    const path = request.url.slice(0, -5)
-    const input = { storage, path }
+    const input = { storage, path: request.url }
     const entry = await this.storage.invoke<Maybe<Entry>>('get', { input })
 
     if (entry instanceof Error)
@@ -72,9 +71,9 @@ export class Fetch implements Directive {
   }
 }
 
-interface Permissions {
-  blob: boolean
-  meta: boolean
+export interface Permissions {
+  blob?: boolean
+  meta?: boolean
 }
 
 interface FetchResult {

package/source/directives/octets/List.ts

@@ -1,5 +1,7 @@
-import { NotFound } from '../../HTTP'
+import { posix } from 'node:path'
+import { Forbidden, NotFound } from '../../HTTP'
 import * as schemas from './schemas'
+import type { Entry } from '@toa.io/extensions.storages'
 import type { Maybe } from '@toa.io/types'
 import type { Component } from '@toa.io/core'
 import type { Output } from '../../io'
@@ -9,24 +11,52 @@ import type { Directive, Input } from './types'
 export class List implements Directive {
   public readonly targeted = false
 
+  private readonly permissions: Required<Permissions> = { meta: false }
   private readonly discovery: Promise<Component>
   private storage: Component | null = null
 
-  public constructor (value: null, discovery: Promise<Component>) {
-    schemas.remove.validate(value)
+  public constructor (permissions: Permissions | null, discovery: Promise<Component>) {
+    schemas.list.validate(permissions)
 
+    Object.assign(this.permissions, permissions)
     this.discovery = discovery
   }
 
   public async apply (storage: string, request: Input): Promise<Output> {
     this.storage ??= await this.discovery
 
-    const input = { storage, path: request.path }
-    const list = await this.storage.invoke<Maybe<unknown>>('list', { input })
+    const metadata = request.subtype === 'octets.entries'
+
+    if (metadata && !this.permissions.meta)
+      throw new Forbidden('Metadata is not accessible.')
+
+    const input = { storage, path: request.url }
+    const list = await this.storage.invoke<Maybe<string[]>>('list', { input })
 
     if (list instanceof Error)
       throw new NotFound()
 
-    return { body: list }
+    const body = metadata
+      ? await this.expand(storage, request.url, list)
+      : list
+
+    return { body }
   }
+
+  private async expand (storage: string, prefix: string, list: string[]):
+  Promise<Array<Maybe<Entry>>> {
+    const promises = list.map(async (id) => {
+      const path = posix.join(prefix, id)
+      const input = { storage, path }
+
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- ensured in `apply`
+      return this.storage!.invoke<Maybe<Entry>>('get', { input })
+    })
+
+    return await Promise.all(promises)
+  }
+}
+
+export interface Permissions {
+  meta?: boolean
 }

package/source/directives/octets/Permute.ts

@@ -13,7 +13,7 @@ export class Permute implements Directive {
   private storage: Component | null = null
 
   public constructor (value: null, discovery: Promise<Component>) {
-    schemas.remove.validate(value)
+    schemas.permute.validate(value)
 
     this.discovery = discovery
   }
@@ -24,7 +24,7 @@ export class Permute implements Directive {
     if (request.encoder === null)
       throw new NotAcceptable()
 
-    const path = request.path
+    const path = request.url
     const list = await request.parse()
     const input = { storage, path, list }
     const error = await this.storage.invoke<Maybe<unknown>>('permute', { input })