@toa.io/extensions.exposition 0.22.1 → 1.0.0-alpha.0

package/features/errors.feature

@@ -191,3 +191,21 @@ Feature: Errors
       | debug | response          |
       | false | content-length: 0 |
       | true  | Error: Broken!    |
+
+  Scenario: Not acceptable request
+    Given the annotation:
+      """yaml
+      /:
+        GET:
+          anonymous: true
+          dev:stub: hello
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      accept: image/jpeg
+      """
+    Then the following reply is sent:
+      """
+      406 Not Acceptable
+      """

package/features/identity.basic.feature

@@ -181,6 +181,7 @@ Feature: Basic authentication
     When the following request is received:
       """
       POST /identity/basic/ HTTP/1.1
+      accept: application/yaml
       content-type: application/yaml
 
       username: root
@@ -224,6 +225,7 @@ Feature: Basic authentication
       """
       PATCH /identity/basic/${{ id }}/ HTTP/1.1
       authorization: Token ${{ token }}
+      accept: application/yaml
       content-type: application/yaml
 
       username: admin

package/features/octets.feature

@@ -0,0 +1,295 @@
+Feature: Octets directive family
+
+  Background:
+    Given the annotation:
+      """yaml
+      /:
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:store: ~
+        GET:
+          octets:list: ~
+        PUT:
+          octets:permute: ~
+        /*:
+          GET:
+            octets:fetch: ~
+          DELETE:
+            octets:delete: ~
+        /media:
+          /jpeg:
+            POST:
+              octets:store:
+                accept: image/jpeg
+          /jpeg-or-png:
+            POST:
+              octets:store:
+                accept:
+                  - image/jpeg
+                  - image/png
+          /images:
+            POST:
+              octets:store:
+                accept: image/*
+      """
+
+  Scenario: Basic storage operations
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      accept: application/yaml
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      content-type: application/yaml
+
+      id: 10cf16b458f759e0d617f2f3d83599ff
+      type: application/octet-stream
+      size: 8169
+      """
+    When the following request is received:
+      """
+      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      """
+    Then the stream equals to `lenna.ascii` is sent with the following headers:
+      """
+      200 OK
+      content-type: application/octet-stream
+      content-length: 8169
+      etag: ${{ ETAG }}
+      """
+    When the following request is received:
+      """
+      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      if-none-match: ${{ ETAG }}
+      """
+    Then the following reply is sent:
+      """
+      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
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+
+      - 10cf16b458f759e0d617f2f3d83599ff
+      """
+    When the following request is received:
+      """
+      GET /10cf16b458f759e0d617f2f3d83599ff?foo=bar HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      404 Not Found
+      """
+    When the following request is received:
+      """
+      DELETE /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      204 No Content
+      """
+    When the following request is received:
+      """
+      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      404 Not Found
+      """
+
+  Scenario: Entries permutation
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      accept: application/yaml
+      content-type: application/octet-stream
+      """
+    And the stream of `lenna.png` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      accept: application/yaml
+      content-type: application/octet-stream
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+
+      - 10cf16b458f759e0d617f2f3d83599ff
+      - 814a0034f5549e957ee61360d87457e5
+      """
+    When the following request is received:
+      """
+      PUT / HTTP/1.1
+      content-type: application/yaml
+
+      - 814a0034f5549e957ee61360d87457e5
+      - 10cf16b458f759e0d617f2f3d83599ff
+      """
+    Then the following reply is sent:
+      """
+      204 No Content
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+
+      - 814a0034f5549e957ee61360d87457e5
+      - 10cf16b458f759e0d617f2f3d83599ff
+      """
+
+  Scenario: Media type control
+    When the stream of `lenna.png` is received with the following headers:
+      """
+      POST /media/jpeg-or-png/ HTTP/1.1
+      content-type: image/jpeg
+      """
+    Then the following reply is sent:
+      """
+      400 Bad Request
+      """
+    When the stream of `lenna.png` is received with the following headers:
+      """
+      POST /media/jpeg/ HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      415 Unsupported Media Type
+      """
+    When the stream of `lenna.png` is received with the following headers:
+      """
+      POST /media/jpeg-or-png/ HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """
+
+  Scenario Outline: Receiving <format> images
+    When the stream of `sample.<format>` is received with the following headers:
+      """
+      POST /media/images/ HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """
+    Examples:
+      | format |
+      | jpeg   |
+      | jxl    |
+      | gif    |
+      | heic   |
+      | avif   |
+      | webp   |
+
+  Scenario: Fetching non-existent BLOB
+    When the following request is received:
+      """
+      GET /whatever HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      404 Not Found
+      """
+
+  Scenario: Fetching a BLOB with trailing slash
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      accept: application/yaml
+      content-type: application/octet-stream
+      """
+    And the following request is received:
+      """
+      GET /10cf16b458f759e0d617f2f3d83599ff/ HTTP/1.1
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      404 Not Found
+      content-type: text/plain
+
+      Trailing slash is redundant.
+      """
+
+  Scenario: Accessing an Entry and the original BLOLB
+    Given the annotation:
+      """yaml
+      debug: true
+      /:
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:store: ~
+        /*:
+          GET:
+            octets:fetch:
+              meta: true
+              blob: false
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      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
+      """
+    Then the following reply is sent:
+      """
+      403 Forbidden
+
+      BLOB variant must be specified.
+      """

package/features/octets.workflows.feature

@@ -0,0 +1,114 @@
+Feature: Octets storage workflows
+
+  Scenario: Running a workflow
+    Given the `octets.tester` is running
+    Given the annotation:
+      """yaml
+      /:
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:store:
+            workflow:
+              - add-foo: octets.tester.foo
+                add-bar: octets.tester.bar
+              - add-baz: octets.tester.baz
+              - diversify: octets.tester.diversify
+        /*:
+          GET:
+            octets:fetch:
+              meta: true
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      accept: application/yaml
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      content-type: multipart/yaml; boundary=cut
+
+      --cut
+      id: 10cf16b458f759e0d617f2f3d83599ff
+      type: application/octet-stream
+      size: 8169
+      --cut
+      add-foo: null
+      --cut
+      add-bar:
+        bar: baz
+      --cut
+      add-baz: null
+      --cut
+      diversify: null
+      --cut--
+      """
+    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
+
+      id: 10cf16b458f759e0d617f2f3d83599ff
+      type: application/octet-stream
+      size: 8169
+      meta:
+        foo: bar
+        bar: baz
+        baz: qux
+      """
+    When the following request is received:
+      """
+      GET /10cf16b458f759e0d617f2f3d83599ff.hello.png HTTP/1.1
+      """
+    Then the stream equals to `lenna.png` is sent with the following headers:
+      """
+      200 OK
+      content-type: image/png
+      content-length: 473831
+      """
+
+  Scenario: Getting error when adding metadata to a file
+    Given the `octets.tester` is running
+    Given the annotation:
+      """yaml
+      /:
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:store:
+            workflow:
+              add-foo: octets.tester.foo
+              add-bar: octets.tester.err
+              add-baz: octets.tester.baz
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      accept: application/yaml
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      content-type: multipart/yaml; boundary=cut
+
+      --cut
+      id: 10cf16b458f759e0d617f2f3d83599ff
+      type: application/octet-stream
+      size: 8169
+      --cut
+      add-foo: null
+      --cut
+      error:
+        step: add-bar
+        code: ERROR
+        message: Something went wrong
+      --cut--
+      """

package/features/routes.feature

@@ -47,3 +47,43 @@ Feature: Routes
 
       Hello
       """
+
+  Scenario: Wildcard routes
+    Given the `greeter` is running with the following manifest:
+      """yaml
+      exposition:
+        /*:
+          GET: greet
+        /foo/*/bar:
+          GET: greet
+      """
+    When the following request is received:
+      """
+      GET /greeter/baz/ HTTP/1.1
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      Hello
+      """
+    When the following request is received:
+      """
+      GET /greeter/baz/qux/ HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      404 Not Found
+      """
+    When the following request is received:
+      """
+      GET /greeter/foo/baz/bar/ HTTP/1.1
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      Hello
+      """

package/features/steps/HTTP.ts

@@ -1,9 +1,10 @@
-import * as assert from 'assert'
-import { AssertionError } from 'assert'
-import { binding, when, then } from 'cucumber-tsflow'
+import { AssertionError } from 'node:assert'
+import { binding, then, when } from 'cucumber-tsflow'
 import * as http from '@toa.io/http'
 import { trim } from '@toa.io/generic'
-import { Parameters } from './parameters'
+import { buffer } from '@toa.io/streams'
+import { open } from '../../../storages/source/test/util'
+import { Parameters } from './Parameters'
 import { Gateway } from './Gateway'
 
 @binding([Gateway, Parameters])
@@ -47,7 +48,11 @@ export class HTTP {
       const match = this.response.match(rx)
 
       if (match === null)
-        throw new AssertionError({ message: `Response is missing '${line}'\n${this.response}` })
+        throw new AssertionError({
+          message: `Response is missing '${line}'`,
+          expected: line,
+          actual: this.response
+        })
 
       Object.assign(this.variables, match.groups)
     }
@@ -62,9 +67,54 @@ export class HTTP {
 
       const includes = this.response.includes(line)
 
-      assert.equal(includes, false, `Response contains '${line}'\n${this.response}`)
+      if (includes)
+        throw new AssertionError({
+          message: `Response contains '${line}'`,
+          expected: line,
+          actual: this.response
+        })
     }
   }
+
+  @when('the stream of `{word}` is received with the following headers:')
+  public async streamRequest (filename: string, head: string): Promise<any> {
+    head = trim(head) + '\n\n'
+
+    await this.gateway.start()
+
+    const { url, method, headers } = http.parse.request(head)
+    const href = new URL(url, this.origin).href
+    const body = open(filename)
+
+    headers.connection = 'close' // required for interrupted streams
+
+    const request = {
+      method,
+      headers,
+      body: body as unknown as ReadableStream,
+      duplex: 'half'
+    }
+
+    try {
+      const response = await fetch(href, request)
+
+      this.response = await http.parse.response(response)
+    } catch (e: any) {
+      console.error(e)
+      console.error(e.cause)
+
+      throw e
+    }
+  }
+
+  @then('the stream equals to `{word}` is sent with the following headers:')
+  public async responseStreamMatch (filename: string, head: string): Promise<any> {
+    const buf = await buffer(open(filename))
+    const text = buf.toString('utf8')
+    const expected = head + '\n\n' + text
+
+    this.responseIncludes(expected)
+  }
 }
 
 const CAPTURE = /\\\$\\{\\{ (?<name>[A-Za-z_]{0,32}) \\}\\}/g

package/features/steps/Parameters.ts

@@ -4,9 +4,12 @@ export class Parameters {
   public readonly origin: string
 
   public constructor () {
-    this.origin = 'http://localhost:8000'
+    this.origin = 'http://127.0.0.1:8000'
   }
 }
 
-setDefaultTimeout(10 * 1000)
+setDefaultTimeout(30 * 1000)
 process.env.TOA_DEV = '1'
+
+// { octets: tmp:///exposition-octets }
+process.env.TOA_STORAGES = '3gABpm9jdGV0c7h0bXA6Ly8vZXhwb3NpdGlvbi1vY3RldHM='

package/features/steps/Workspace.ts

@@ -1,16 +1,18 @@
 import { join } from 'node:path'
-import { directory } from '@toa.io/filesystem'
+import { tmpdir } from 'node:os'
+import { mkdtemp, copy } from 'fs-extra'
 import * as yaml from '@toa.io/yaml'
 
 export class Workspace {
   private root: string = devnull
 
   public static exists
-  (target: Workspace, key: string, descriptor: PropertyDescriptor): PropertyDescriptor {
+  (_0: unknown, _1: unknown, descriptor: PropertyDescriptor): PropertyDescriptor {
     const method = descriptor.value
 
     descriptor.value = async function (this: Workspace, ...args: any[]): Promise<any> {
-      if (this.root === devnull) this.root = await directory.temp()
+      if (this.root === devnull) this.root =
+        await mkdtemp(join(tmpdir(), Math.random().toString(36).slice(2)))
 
       return method.apply(this, args)
     }
@@ -23,9 +25,10 @@ export class Workspace {
     const source = join(__dirname, 'components', name)
     const target = join(this.root, name)
 
-    await directory.copy(source, target)
+    await copy(source, target)
 
-    if (patch !== undefined) await this.patchManifest(target, patch)
+    if (patch !== undefined)
+      await this.patchManifest(target, patch)
 
     return target
   }

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

@@ -0,0 +1,15 @@
+namespace: octets
+name: tester
+
+storages: octets
+
+operations:
+  foo: &operation
+    input:
+      storage*: string
+      path*: string
+      entry: object
+  bar: *operation
+  baz: *operation
+  err: *operation
+  diversify: *operation

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

@@ -0,0 +1,12 @@
+'use strict'
+
+import { setTimeout } from 'node:timers/promises'
+
+async function bar (input, context) {
+  await setTimeout(10)
+  await context.storages.octets.annotate(input.path, 'bar', 'baz')
+
+  return { bar: 'baz' }
+}
+
+exports.effect = bar

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

@@ -0,0 +1,11 @@
+'use strict'
+
+import { setTimeout } from 'node:timers/promises'
+
+async function baz (input, context) {
+  await setTimeout(30)
+
+  return context.storages.octets.annotate(input.path, 'baz', 'qux')
+}
+
+exports.effect = baz

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

@@ -0,0 +1,14 @@
+'use strict'
+
+const { join } = require('node:path')
+const { createReadStream } = require('node:fs')
+
+const lenna = join(__dirname, 'lenna.png')
+
+async function diversify (input, context) {
+  const stream = createReadStream(lenna)
+
+  return context.storages[input.storage].diversify(input.path, 'hello.png', stream)
+}
+
+exports.effect = diversify

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

@@ -0,0 +1,16 @@
+'use strict'
+
+import { setTimeout } from 'node:timers/promises'
+
+async function err (_) {
+  await setTimeout(20)
+
+  const err = Object.create(Error.prototype)
+
+  err.code = 'ERROR'
+  err.message = 'Something went wrong'
+
+  return err
+}
+
+exports.effect = err