@toa.io/extensions.exposition 1.0.0-alpha.23 → 1.0.0-alpha.231

package/features/passkeys.feature

@@ -0,0 +1,66 @@
+Feature: Web Authentication
+
+  Scenario: Create a challenge to add a new passkey to existing identity
+    Given the `identity.passkeys` configuration:
+      """yaml
+      name: Nex
+      """
+    And transient identity
+    When the following request is received:
+      """
+      POST /identity/passkeys/challenges/${{ identity.id }}/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      content-type: application/yaml
+
+      type: creation
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+
+      challenge: ${{ challenge }}
+      identity: ${{ identity.id }}
+      timeout: 60000
+      authenticatorSelection:
+        requireResidentKey: true
+        residentKey: required
+      pubKeyCredParams:
+        - type: public-key
+          alg: -7
+        - type: public-key
+          alg: -257
+      """
+
+  Scenario: Create a challenge to create a passkey to new identity
+    Given the `identity.passkeys` configuration:
+      """yaml
+      name: Nex
+      """
+    And transient identity
+    When the following request is received:
+      """
+      POST /identity/passkeys/challenges/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      content-type: application/yaml
+
+      type: creation
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      authorization: Token ${{ token }}
+
+      challenge: ${{ challenge }}
+      identity: ${{ identity }}
+      timeout: 60000
+      authenticatorSelection:
+        requireResidentKey: true
+        residentKey: required
+      pubKeyCredParams:
+        - type: public-key
+          alg: -7
+        - type: public-key
+          alg: -257
+      """

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}

@@ -113,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:
@@ -137,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
@@ -167,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:
@@ -228,3 +259,104 @@ 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
+      """
+
+  Scenario: Text search
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          GET:
+            io:output: true
+            query:
+              search: true
+            endpoint: enumerate
+          /non-searchable:
+            GET:
+              io:output: true
+              endpoint: enumerate
+      """
+    When the following request is received:
+      """
+      GET /pots/?search=fourth HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      - id: bc6913d317334d76acd07d9f25f73535
+        title: Fourth pot
+        volume: 400
+      """
+    And the reply does not contain:
+      """
+      - id: 4c4759e6f9c74da989d64511df42d6f4
+        title: First pot
+        volume: 100
+      """
+    When the following request is received:
+      """
+      GET /pots/non-searchable/?search=first HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      400 Bad Request
+      """
+
+  Scenario: Querying sample
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          GET:
+            io:output: true
+            endpoint: enumerate
+      """
+    When the following request is received:
+      """
+      GET /pots/?sample=2 HTTP/1.1
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """

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/response.feature

@@ -22,6 +22,35 @@ Feature: Response
       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"}
       """
 

package/features/routes.feature

@@ -99,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:
         /:
@@ -138,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/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,5 @@
+CLOUDINARY_ENVIRONMENT=
+TOA_STORAGES_CLOUDINARY_API_KEY=
+TOA_STORAGES_CLOUDINARY_API_SECRET=
+TOA_STORAGES_CLOUDINARY_VIDEO_API_KEY=
+TOA_STORAGES_CLOUDINARY_VIDEO_API_SECRET=

package/features/steps/Captures.ts

@@ -3,4 +3,16 @@ import { binding } from 'cucumber-tsflow'
 
 @binding()
 export class Captures extends http.Captures {
+  public constructor () {
+    super(functions)
+  }
+}
+
+const functions: http.Functions = {
+  otp: function (this: Captures, value: string, arg: string): string {
+    const identity = this.get(arg + '.id')
+    const code = this.get(arg + '.code')
+
+    return Buffer.from(`${identity}:${code}`).toString('base64')
+  }
 }

package/features/steps/Common.ts

@@ -7,4 +7,8 @@ export class Common {
   public async timeout (interval: number): Promise<void> {
     await timeout(interval * 1000)
   }
+
+  @given('the process is running')
+  public async noop (): Promise<void> {
+  }
 }

package/features/steps/Gateway.ts

@@ -127,6 +127,8 @@ const DEFAULT_PROPERTIES: Partial<http.Options> = {
 
 const DEFAULT_CONFIGURATION: Record<string, object> = {
   'identity.tokens': {
-    key0: 'k3.local.pIZT8-9Fa6U_QtfQHOSStfGtmyzPINyKQq2Xk-hd7vA'
+    keys: {
+      0: 'k3.local.pIZT8-9Fa6U_QtfQHOSStfGtmyzPINyKQq2Xk-hd7vA'
+    }
   }
 }

package/features/steps/HTTP.ts

@@ -23,6 +23,7 @@ export class HTTP extends http.Agent {
   @when('the following request is received:')
   public override async request (input: string): Promise<any> {
     await this.gateway.start()
+
     this.fetched = await super.request(input)
   }
 
@@ -36,7 +37,7 @@ export class HTTP extends http.Agent {
     assert.ok(this.fetched !== null, 'Response is null')
 
     const buf = await this.fetched.arrayBuffer()
-    const value = encoders[format]?.(buf as Buffer)
+    const value = encoders[format]?.(buf as unknown as Buffer)
     const expected = YAML.load(yaml)
 
     assert.deepEqual(value, expected, 'Values are not equal')
@@ -61,12 +62,35 @@ export class HTTP extends http.Agent {
 
     await super.streamMatch(head, stream)
   }
+
+  @when('the following request is interrupted after {float} second(s):')
+  public async interrupt (delay: number, input: string): Promise<any> {
+    const controller = new AbortController()
+
+    await this.gateway.start()
+
+    setTimeout(() => {
+      if (pending)
+        controller.abort()
+      else
+        console.error('Request cannot be interrupted as it is already completed')
+    }, delay * 1000)
+
+    let pending = true
+
+    await super.fetch(input, { signal: controller.signal }).catch((e) => {
+      if (e.name !== 'AbortError')
+        throw e
+    })
+
+    pending = false
+  }
 }
 
-const FILEDIR = path.resolve(__dirname, '../../../storages/source/test')
+const FILES_DIR = path.resolve(__dirname, '../../../storages/source/test')
 
 function open (filename: string): Readable {
-  return fs.createReadStream(path.join(FILEDIR, filename))
+  return fs.createReadStream(path.join(FILES_DIR, filename))
 }
 
 const encoders: Record<string, (buf: Buffer | Uint8Array) => any> = {