@toa.io/extensions.exposition 1.0.0-alpha.7 → 1.0.0-alpha.71

package/features/probes.feature

@@ -0,0 +1,14 @@
+Feature: Probes
+
+  Scenario: Startup probe
+    Given the Gateway is running
+    And after 1 second
+    When the following request is received:
+      """
+      GET /.ready HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      cache-control: no-store
+      """

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

@@ -19,6 +19,7 @@ Feature: Queries
     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:
@@ -42,6 +43,7 @@ Feature: Queries
     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:
@@ -68,6 +70,7 @@ Feature: Queries
     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:
@@ -94,6 +97,7 @@ Feature: Queries
     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:
@@ -109,7 +113,7 @@ 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:
@@ -120,6 +124,7 @@ Feature: Queries
     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:
@@ -132,6 +137,37 @@ Feature: Queries
       volume: 200
       """
 
+  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
@@ -146,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:
@@ -161,7 +198,7 @@ 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:
@@ -175,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:
@@ -204,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:
@@ -220,3 +259,27 @@ 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
+      """

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

@@ -7,11 +7,13 @@ Feature: Response
         io:output: true
         GET:
           anonymous: true
-          dev:stub: hello
+          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:
@@ -19,6 +21,37 @@ Feature: Response
       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
@@ -32,11 +65,12 @@ Feature: Response
     When the following request is received:
       """
       GET /echo/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
       """
-      409 Conflict
+      422 Unprocessable Entity
       content-type: application/yaml
 
       code: CODE
@@ -54,11 +88,12 @@ Feature: Response
     When the following request is received:
       """
       GET /echo/ HTTP/1.1
+      host: nex.toa.io
       accept: application/msgpack
       """
     Then the following reply is sent:
       """
-      409 Conflict
+      422 Unprocessable Entity
       content-type: application/msgpack
       """
     And response body contains MessagePack-encoded value:

package/features/routes.feature

@@ -18,6 +18,7 @@ Feature: Routes
     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:
@@ -42,6 +43,7 @@ Feature: Routes
     When the following request is received:
       """
       GET /greeter/ HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -65,6 +67,7 @@ Feature: Routes
     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:
@@ -76,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:
       """
@@ -84,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:
@@ -94,8 +99,7 @@ Feature: Routes
       """
 
   Scenario: Routes with naming conflicts
-    Given the Gateway is running
-    And the `users` is running with the following manifest:
+    Given the `users` is running with the following manifest:
       """yaml
       exposition:
         /:
@@ -112,6 +116,7 @@ Feature: Routes
     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:
@@ -123,6 +128,7 @@ Feature: Routes
     When the following request is received:
       """
       POST /users/ HTTP/1.1
+      host: nex.toa.io
       content-type: application/yaml
 
       name: Alice
@@ -131,3 +137,88 @@ Feature: Routes
       """
       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/steps/Database.ts

@@ -1,6 +1,7 @@
 import { afterAll, beforeAll, binding, given } from 'cucumber-tsflow'
-import { type DataTable } from '@cucumber/cucumber'
 import { MongoClient } from 'mongodb'
+import type { Collection } from 'mongodb'
+import type { DataTable } from '@cucumber/cucumber'
 
 @binding()
 export class Database {
@@ -8,9 +9,7 @@ export class Database {
 
   @given('the `{word}` database contains:')
   public async upsert (id: string, table: DataTable): Promise<void> {
-    const [name, namespace = 'default'] = id.split('.').reverse()
-    const collection = Database.client.db(namespace).collection(name)
-
+    const collection = this.collection(id)
     const columns = table.raw()[0]
     const rows = table.rows()
     const documents: Document[] = []
@@ -22,7 +21,11 @@ export class Database {
         const str = rows[r][c]
         const int = parseInt(str)
 
-        document[columns[c]] = int.toString() === str ? int : str
+        document[columns[c]] = int.toString() === str
+          ? int
+          : str === 'null'
+            ? null
+            : str
       }
 
       documents.push(document)
@@ -36,10 +39,7 @@ export class Database {
 
   @given('the `{word}` database is empty')
   public async truncate (id: string): Promise<void> {
-    const [name, namespace = 'default'] = id.split('.').reverse()
-    const collection = Database.client.db(namespace).collection(name)
-
-    await collection.deleteMany({})
+    await this.collection(id).deleteMany({})
   }
 
   @beforeAll()
@@ -53,6 +53,13 @@ export class Database {
   public static async disconnect (): Promise<void> {
     await this.client.close()
   }
+
+  private collection (id: string): Collection {
+    const [name, namespace = 'default'] = id.split('.').reverse()
+    const collection = `${namespace}_${name}`.toLowerCase()
+
+    return Database.client.db('toa-dev').collection(collection)
+  }
 }
 
-type Document = Record<string, string | number>
+type Document = Record<string, string | number | null>

package/features/steps/Gateway.ts

@@ -6,6 +6,7 @@ import { encode, timeout } from '@toa.io/generic'
 import { Factory } from '../../source'
 import * as syntax from '../../source/RTD/syntax'
 import { shortcuts } from '../../source/Directive'
+import type * as http from '../../source/HTTP'
 
 let instance: Connector | null = null
 
@@ -23,11 +24,19 @@ export class Gateway {
       process.env.TOA_EXPOSITION = encode(tree)
     }
 
-    if (annotation.debug === true)
-      process.env.TOA_EXPOSITION_DEBUG = '1'
+    const { debug, trace, authorities } = annotation
+    const properties = Object.assign({}, DEFAULT_PROPERTIES)
 
-    if (annotation.trace === true)
-      process.env.TOA_EXPOSITION_TRACE = '1'
+    if (debug !== undefined)
+      properties.debug = debug
+
+    if (trace !== undefined)
+      properties.trace = trace
+
+    if (authorities !== undefined)
+      properties.authorities = authorities
+
+    process.env.TOA_EXPOSITION_PROPERTIES = encode(properties)
 
     await Gateway.stop()
 
@@ -54,7 +63,8 @@ export class Gateway {
     if (instance !== null)
       return
 
-    process.env.TOA_EXPOSITION ??= DEFAULT_ANNOTATION
+    process.env.TOA_EXPOSITION ??= DEFAULT_TREE
+    process.env.TOA_EXPOSITION_PROPERTIES ??= encode(DEFAULT_PROPERTIES)
 
     this.writeConfiguration()
 
@@ -76,6 +86,7 @@ export class Gateway {
       return
 
     delete process.env.TOA_EXPOSITION
+    delete process.env.TOA_EXPOSITION_PROPERTIES
 
     await Gateway.stop()
   }
@@ -96,7 +107,7 @@ export class Gateway {
   }
 }
 
-const DEFAULT_ANNOTATION = encode({
+const DEFAULT_TREE = encode({
   routes: [],
   methods: [],
   directives: [
@@ -108,6 +119,12 @@ const DEFAULT_ANNOTATION = encode({
   ]
 } satisfies syntax.Node)
 
+const DEFAULT_PROPERTIES: Partial<http.Options> = {
+  authorities: {
+    nex: 'nex.toa.io'
+  }
+}
+
 const DEFAULT_CONFIGURATION: Record<string, object> = {
   'identity.tokens': {
     key0: 'k3.local.pIZT8-9Fa6U_QtfQHOSStfGtmyzPINyKQq2Xk-hd7vA'