feat: add redis example

[matthew-charles-chan]

Summary

• Refactors plugin to improve extensibility:
  • makes @fastify/view a plugin dependency, rather than registering it within fastify-cloudprnt. This will avoid possible errors in apps which have already registered @fastify/view
  • adds routePrefix option to avoid route collisions.
  • decorates fastify with a single cloudPrnt namespace containing all the cloudprnt methods
• Updates examples/basic to reflect the changes made to fastify-cloudprnt
• Adds redis example (examples/redis)
• Updates docker configuration:
  • updates Dockerfile to be used with all docker-compose files
  • adds docker compose files and associated scripts to run examples and tests
• Updates package.json in preparation of release

Test Plan

• clone and checkout this branch locally
• Confirm tests pass locally

  npm run test
  

  • OR: if you have not installed cputil on your local machine, you can run containerized tests:

    npm run test:docker

• Confirm the autotelic office printer is on and ready for connection
  • navigate to http://10.20.1.245/
  • click Device Status
  • confirm status is ready
• Connect your local machine to the created ngrok tunnel

  ngrok http --region=us --hostname=dev-socloudprnt.ngrok.io 3000

Redis Example

• Start the redis example

npm run example:redis

• Add a few print jobs to the queue using HTTPie

  http POST http://dev-socloudprnt.ngrok.io/job \
  token=testToken1 \
  jobData[token]=testToken1

  http POST http://dev-socloudprnt.ngrok.io/job \
  token=testToken2 \
  jobData[token]=testToken2

  http POST http://dev-socloudprnt.ngrok.io/job \
  token=testToken3 \
  jobData[token]=testToken3

• Confirm the jobs have been added to the respective redis hash and list

  • sh into the running redis server

    docker exec -ti cloudprnt-redis  redis-cli

  • Confirm jobData has been created

    HGETALL printJobData

      127.0.0.1:6379> HGETALL printJobData
      1) "testToken1"
      2) "{\"token\":\"testToken1\"}"
      3) "testToken2"
      4) "{\"token\":\"testToken2\"}"
      5) "testToken3"
      6) "{\"token\":\"testToken3\"}"

  • Confirm job queue has been created

    LRANGE printJobQueue 0 -1

      127.0.0.1:6379> LRANGE printJobQueue 0 -1
      1) "testToken3"
      2) "testToken2"
      3) "testToken1"

• The printer will poll the server within 120 seconds

• Confirm 3 receipts are printed containing the correct tokens

• After the receipts have been printed, confirm the jobData hash and printQueue list have been cleared

  127.0.0.1:6379> HGETALL printJobData
  (empty array)
  127.0.0.1:6379> LRANGE printJobQueue 0 -1
  (empty array)
  127.0.0.1:6379>

Note: validation status checks are currently failing. This looks to be caused by a bug in eslint-plugin-import: open issue.
Fixed in eslint-plugin-import 2.27.2

[eadmundo]

A thing of great beauty. I provided a suggestion for the docs. LGTM!