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

package/features/{queries.feature → query.feature}

@@ -13,11 +13,13 @@ Feature: Queries
       """yaml
       exposition:
         /pot:
+          io:output: true
           GET: observe
       """
     When the following request is received:
       """
       GET /pots/pot/?id=99988d785d7d445cad45dbf8531f560b HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -35,11 +37,13 @@ Feature: Queries
       """yaml
       exposition:
         /:
+          io:output: true
           GET: enumerate
       """
     When the following request is received:
       """
       GET /pots/?criteria=volume<300&limit=10 HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -60,11 +64,13 @@ Feature: Queries
       """yaml
       exposition:
         /:
+          io:output: true
           GET: enumerate
       """
     When the following request is received:
       """
       GET /pots/?omit=1&limit=2 HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -85,11 +91,13 @@ Feature: Queries
       """yaml
       exposition:
         /:
+          io:output: true
           GET: enumerate
       """
     When the following request is received:
       """
       GET /pots/?sort=volume:desc&limit=2 HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -105,16 +113,18 @@ Feature: Queries
         volume: 300
       """
 
-  Scenario: Request to a route with a path variable
+  Scenario: Request to a route with path variable
     Given the `pots` is running with the following manifest:
       """yaml
       exposition:
         /:id:
+          io:output: true
           GET: observe
       """
     When the following request is received:
       """
       GET /pots/99988d785d7d445cad45dbf8531f560b/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -127,11 +137,43 @@ Feature: Queries
       volume: 200
       """
 
-  Scenario: Request to a route with predefined criretia
+  Scenario: Request to a route with path variable using OR operator
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:volume:
+          io:output: true
+          GET:
+            query:
+              criteria: ',volume==100'
+            endpoint: enumerate
+      """
+    When the following request is received:
+      """
+      GET /pots/200/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+
+      - id: 4c4759e6f9c74da989d64511df42d6f4
+        title: First pot
+        volume: 100
+        temperature: 80
+      - id: 99988d785d7d445cad45dbf8531f560b
+        title: Second pot
+        volume: 200
+      """
+
+  Scenario: Request to a route with predefined criteria
     Given the `pots` is running with the following manifest:
       """yaml
       exposition:
         /big:
+          io:output: true
           GET:
             endpoint: enumerate
             query:
@@ -140,6 +182,7 @@ Feature: Queries
     When the following request is received:
       """
       GET /pots/big/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -155,11 +198,12 @@ Feature: Queries
         volume: 400
       """
 
-  Scenario: Request to a route with combined criteria
+  Scenario: Request to a route with open criteria
     Given the `pots` is running with the following manifest:
       """yaml
       exposition:
         /big:
+          io:output: true
           GET:
             endpoint: enumerate
             query:
@@ -168,6 +212,7 @@ Feature: Queries
     When the following request is received:
       """
       GET /pots/big/?criteria=temperature>50 HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -186,6 +231,7 @@ Feature: Queries
       """yaml
       exposition:
         /hottest2:
+          io:output: true
           GET:
             endpoint: enumerate
             query:
@@ -196,6 +242,7 @@ Feature: Queries
     When the following request is received:
       """
       GET /pots/hottest2/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -212,3 +259,39 @@ Feature: Queries
         volume: 100
         temperature: 80
       """
+
+  Scenario: Query parameters
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          GET:
+            io:output: true
+            query:
+              parameters: [name]
+            endpoint: compute
+      """
+    When the following request is received:
+      """
+      GET /echo/?name=John HTTP/1.1
+      host: nex.toa.io
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      Hello John
+      """
+    When the following request is received:
+      """
+      GET /echo/?foo=bar HTTP/1.1
+      host: nex.toa.io
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      400 Bad Request
+
+      Query parameter 'foo' is not allowed
+      """

package/features/realtime.feature

@@ -0,0 +1,34 @@
+Feature: Realtime events
+
+  Background:
+    Given the Realtime is running with the following annotation:
+      """yaml
+      users.properties.sync: id
+      """
+    And the identity Bob is consuming realtime events
+
+  Scenario: Getting realtime events
+    Given the `users.properties` is running with the following manifest:
+      """yaml
+      exposition:
+        /:id:
+          anonymous: true
+          io:output: false
+          PATCH: transit
+      """
+    When the following request is received:
+      """
+      PATCH /users/properties/${{ Bob.id }}/ HTTP/1.1
+      host: nex.toa.io
+      content-type: application/yaml
+
+      newbie: false
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+    And the following event `users.properties.sync` is received by Bob:
+      """yaml
+      newbie: false
+      """

package/features/require.feature

@@ -0,0 +1,67 @@
+Feature: Request requirements
+
+  Scenario Outline: Require headers
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          POST: create
+          /one/:id:
+            require:header: if-match
+            PUT: transit
+          /two/:id:
+            require:headers: [if-match]
+            PUT: transit
+      """
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      host: nex.toa.io
+      content-type: application/yaml
+      accept: application/yaml
+
+      title: Hello
+      volume: 1.5
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      etag: ${{ etag }}
+
+      id: ${{ id }}
+      """
+    When the following request is received:
+      """
+      PUT /pots/<variant>/${{ id }}/ HTTP/1.1
+      host: nex.toa.io
+      content-type: application/yaml
+      accept: text/plain
+
+      title: Hello
+      volume: 1.5
+      """
+    Then the following reply is sent:
+      """
+      400 Bad Request
+
+      Header required: if-match
+      """
+    When the following request is received:
+      """
+      PUT /pots/<variant>/${{ id }}/ HTTP/1.1
+      host: nex.toa.io
+      content-type: application/yaml
+      accept: text/plain
+      if-match: ${{ etag }}
+
+      title: Bye
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+    Examples:
+      | variant |
+      | one     |
+      | two     |

package/features/response.feature

@@ -0,0 +1,103 @@
+Feature: Response
+
+  Scenario: Content negotiation
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        GET:
+          anonymous: true
+          dev:stub:
+            hello: world
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      host: nex.toa.io
+      accept: application/json
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/json
+      vary: accept
+
+      {"hello":"world"}
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+      vary: accept
+
+      hello: world
+      """
+
+    # default is JSON
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/json
+      vary: accept
+
+      {"hello":"world"}
+      """
+
+  Scenario: Error as YAML
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          GET: error
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      422 Unprocessable Entity
+      content-type: application/yaml
+
+      code: CODE
+      message: message
+      """
+
+  Scenario: Error as MessagePack
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          GET: error
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/msgpack
+      """
+    Then the following reply is sent:
+      """
+      422 Unprocessable Entity
+      content-type: application/msgpack
+      """
+    And response body contains MessagePack-encoded value:
+      """yaml
+      code: CODE
+      message: message
+      """

package/features/routes.feature

@@ -6,16 +6,19 @@ Feature: Routes
       namespace: basic
 
       exposition:
-        /strict:
-          GET:
-            endpoint: greet
-        /shortcuts:
-          /operation:
-            GET: greet
+        /:
+          io:output: true
+          /strict:
+            GET:
+              endpoint: greet
+          /shortcuts:
+            /operation:
+              GET: greet
       """
     When the following request is received:
       """
       GET /basic/greeter<route> HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -34,11 +37,13 @@ Feature: Routes
       """yaml
       exposition:
         /:
+          io:output: true
           GET: greet
       """
     When the following request is received:
       """
       GET /greeter/ HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -52,14 +57,17 @@ Feature: Routes
     Given the `greeter` is running with the following manifest:
       """yaml
       exposition:
-        /*:
-          GET: greet
-        /foo/*/bar:
-          GET: greet
+        /:
+          io:output: true
+          /*:
+            GET: greet
+          /foo/*/bar:
+            GET: greet
       """
     When the following request is received:
       """
       GET /greeter/baz/ HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -71,6 +79,7 @@ Feature: Routes
     When the following request is received:
       """
       GET /greeter/baz/qux/ HTTP/1.1
+      host: nex.toa.io
       """
     Then the following reply is sent:
       """
@@ -79,6 +88,7 @@ Feature: Routes
     When the following request is received:
       """
       GET /greeter/foo/baz/bar/ HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -87,3 +97,128 @@ Feature: Routes
 
       Hello
       """
+
+  Scenario: Routes with naming conflicts
+    Given the `users` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          POST: create
+      """
+    And the `users.properties` is running with the following manifest:
+      """yaml
+      exposition:
+        /:id:
+          io:output: true
+          GET: observe
+      """
+    When the following request is received:
+      """
+      GET /users/properties/b5534021e30042259badffbd1831e472/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      newbie: false
+      """
+    When the following request is received:
+      """
+      POST /users/ HTTP/1.1
+      host: nex.toa.io
+      content-type: application/yaml
+
+      name: Alice
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """
+
+  Scenario: Routes with default namespace conflicts
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:foo:
+          io:output: true
+          PUT: compute
+      """
+    And the `echo.beacon` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          GET: hello
+      """
+    When the following request is received:
+      """
+      GET /echo/beacon/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+
+  Scenario: Routes with parameters
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:a/:b:
+          io:output: true
+          GET: parameters
+      """
+    When the following request is received:
+      """
+      GET /echo/foo/bar/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      a: foo
+      b: bar
+      """
+
+  Scenario: Route forwarding
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /show/:a/:b:
+          io:output: true
+          GET: parameters
+        /hello: /echo/show/foo/bar
+        /mirror/:a/:b: /echo/show/:a/:b
+      """
+    When the following request is received:
+      """
+      GET /echo/hello/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      a: foo
+      b: bar
+      """
+    When the following request is received:
+      """
+      GET /echo/mirror/bar/baz/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      a: bar
+      b: baz
+      """

package/features/server.feature

@@ -0,0 +1,21 @@
+Feature: `Server` response header
+
+  Scenario: `Server` response header
+    Given the annotation:
+      """yaml
+      /:
+        GET:
+          anonymous: true
+          dev:stub:
+            access: granted!
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      server: Exposition/
+      """

package/features/steps/.env.example

@@ -0,0 +1,3 @@
+CLOUDINARY_ENVIRONMENT=
+TOA_STORAGES_CLOUDINARY_API_KEY=
+TOA_STORAGES_CLOUDINARY_API_SECRET=

package/features/steps/Captures.ts

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

package/features/steps/Components.ts

@@ -1,3 +1,4 @@
+import * as assert from 'node:assert'
 import { after, binding, given } from 'cucumber-tsflow'
 import * as boot from '@toa.io/boot'
 import { timeout } from '@toa.io/generic'
@@ -8,7 +9,7 @@ import { Workspace } from './Workspace'
 @binding([Workspace])
 export class Components {
   private readonly workspace: Workspace
-  private composition: Connector | null = null
+  private compositions: Record<string, Connector> = {}
 
   public constructor (workspace: Workspace) {
     this.workspace = workspace
@@ -26,18 +27,29 @@ export class Components {
     await this.runComponent(name, manifest)
   }
 
-  @after()
   @given('the `{word}` is stopped')
-  public async stop (_?: string): Promise<void> {
-    await this.composition?.disconnect()
+  public async stop (name: string): Promise<void> {
+    assert.ok(name in this.compositions, `Composition '${name}' is not running`)
+
+    await this.compositions[name].disconnect()
+    delete this.compositions[name]
+  }
+
+  @after()
+  public async shutdown (): Promise<void> {
+    const promises = Object.values(this.compositions).map((composition) => composition.disconnect())
+
+    await Promise.all(promises)
   }
 
   private async runComponent (name: string, manifest?: object): Promise<void> {
+    assert.ok(!(name in this.compositions), `Composition '${name}' is already running`)
+
     const path = await this.workspace.addComponent(name, manifest)
 
-    this.composition = await boot.composition([path])
+    this.compositions[name] = await boot.composition([path])
 
-    await this.composition.connect()
+    await this.compositions[name].connect()
     await timeout(50) // discovery
   }
 }