vince-lynch / ws-monorepo Goto Github PK

Description:

certificate has expired on swapi.dev

swapi.dev's https certificate expired today

add the environment variable NODE_TLS_REJECT_UNAUTHORIZED in test enviroments

to be set to 0 to ensure that tests / devs can still interact with the endpoints

Tasks:

• add env variable to local Dockerfile for local testing
• add env variable to server-ws docker-compose (for tests dependent on)
• add env variable to local /server-ws/index.js to allow devs to test locally

Acceptance criteria:

• tests pass again in the GHA action

Notes:

https://swapi.dev/api/people/?search=dfs

In the event of an error (or no matches against your query term), an error object

Description:

Tasks:

• Do something
• Do another thing

Acceptance criteria:

• Can test that the things by doing this check

Notes:

Blah blah blah, check out this link,
Don't make assumptions on the approach, as might blind you later on.

turn into console app

Description:

Tasks:

• Do something
• Do another thing

Acceptance criteria:

• Can test that the things by doing this check

Notes:

Blah blah blah, check out this link,
Don't make assumptions on the approach, as might blind you later on.

Description:

add client connected message to client-ws

Tasks:

• Do something
• Do another thing

Acceptance criteria:

• Can test that the things by doing this check

Notes:

Blah blah blah, check out this link,
Don't make assumptions on the approach, as might blind you later on.

Description:

refactor writeQuery fn in cli.spec.js for client-ws package

Tasks:

• use regex to get pagination
• use number of received pages to know when to stop waiting for more stdouts

Acceptance criteria:

• tests still pass

Notes:

aim to reduce the time it takes for the tests to pass.

refactor the beneath

const writeQuery = (c, query = 'Luke Skywalker') =>
  new Promise((resolve) => {
    const output = { results: [], error: null }

    c.stdin.write(`${query}\r`)

    c.stdout.on('data', (data) => {
      const s = data.toString()
      const pages = s.split('\n')

      pages.forEach((page) => {
        if (page[0] === '(') {
          output.results.push(page)
        }
      })
      if (
        output.results.length &&
        pages[pages.length - 1] ===
          'What character would you like to search for? '
      ) {
        resolve(output)
      }
    })

    c.stderr.on('data', (data) => {
      const p = data.toString().split('\n')
      // eslint-disable-next-line prefer-destructuring
      output.error = p[0]
      resolve(output)
    })
  })

Description:

There is a test that is failing because it takes too long to get the 37 pages of results.

Tasks:

• #23

Acceptance criteria:

• tests pass and refactoring is done

Notes:

(https://github.com/vince-lynch/ws-monorepo/runs/4278537644?check_suite_focus=true

Description:

give proper error on server 404 or 502 bad gateway

Tasks:

• Do something
• Do another thing

Acceptance criteria:

• Can test that the things by doing this check

Notes:

Blah blah blah, check out this link,
Don't make assumptions on the approach, as might blind you later on.

Description:

jsdoc functions

Tasks:

• Do something
• Do another thing

Acceptance criteria:

• Can test that the things by doing this check

Notes:

Blah blah blah, check out this link,
Don't make assumptions on the approach, as might blind you later on.

Description:

reconnect on disconnect client-ws

give stderr on server disconnect, and call reconnect function

Tasks:

• listen for on.connectionError
• listen for on.Disconnected
• call reconnection fn
• allow customisable stdout on connected
• allow debounce for connection successful incase rapid connect - disconnects

Acceptance criteria:

• ensure tests can still pass
• demonstrate the disconnect - reconnect functionality in a screenshot.

Notes:

add debounce package

Description:

add square brackets to response

Acceptance criteria:

• allow films for character to be parse-able by wrapping in square brackets ws-client
• tests are updated to count the number of films that a character appeared in

Notes:

Description:

add monorepo, prettier, eslint

Tasks:

• Do something
• Do another thing

Acceptance criteria:

• Can test that the things by doing this check

Notes:

Blah blah blah, check out this link,
Don't make assumptions on the approach, as might blind you later on.

add connection to socket.io

Description:

Tasks:

• Do something
• Do another thing

Acceptance criteria:

• Can test that the things by doing this check

Notes:

Blah blah blah, check out this link,
Don't make assumptions on the approach, as might blind you later on.

Description:

allow sequential searches

Tasks:

• Remove commander (https://www.npmjs.com/package/commander)
• use readline

Acceptance criteria:

• The console should reset on completion of a search (on receipt of the last message in case of success, or on any error) to allow the user to make another search without restarting the application

Notes:

make an example query to server-ws from client-ws

Description:

Tasks:

• Do something
• Do another thing

Acceptance criteria:

• Can test that the things by doing this check

Notes:

Blah blah blah, check out this link,
Don't make assumptions on the approach, as might blind you later on.

Description:

refactor web sockets commands in client-ws

Tasks:

• Do something
• Do another thing

Acceptance criteria:

• Can test that the things by doing this check

Notes:

Blah blah blah, check out this link,
Don't make assumptions on the approach, as might blind you later on.

Description:

allow the user to make another search without restarting the application

Tasks:

• Do something
• Do another thing

Acceptance criteria:

• Can test that the things by doing this check

Notes:

Blah blah blah, check out this link,
Don't make assumptions on the approach, as might blind you later on.

Description:

add monorepo, prettier, eslint

Tasks:

• Do something
• Do another thing

Acceptance criteria:

• Can test that the things by doing this check

Notes:

Blah blah blah, check out this link,
Don't make assumptions on the approach, as might blind you later on.

Description:

combine search action and ws query function in client-ws

Tasks:

• Do something
• Do another thing

Acceptance criteria:

• Can test that the things by doing this check

Notes:

Blah blah blah, check out this link,
Don't make assumptions on the approach, as might blind you later on.