feat: rate limiter + unit tests + readme (#115)

This PR add tests for the Rate Limiter middleware, the main changes
include:

- [x] Updated README with steps and configs to run it locally
   - [x] Project Setup
   - [x] Running Tests
- [x] Added Mocha, Chai and Sinon packages to run Unit Tests
- [x] Rate Limiter
   - [x] Feature Flag (env variable)
   - [x] Fixes
- [x] Rate Limiter middleware needs to be placed after the IPFS Parsed
URL middleware, so we can access the CID
- [x] Refactored the `import {version} from './package.json' to be set
via task and imported as ENV variable, so we can easily tweak that in
the tests and don't run into import issues
   - [x] Unit Tests
- 1. Calls next handler if no auth token is provided and rate limit is
not exceeded
- 2. Throws an error if no auth token is provided and rate limit is
exceeded
- 3. Calls next handler if auth token is present but no token metadata
is found and rate limit is not exceeded
- 4. Throws an error if auth token is present but no token metadata is
found and rate limit is exceeded
- 5. Calls next handler if auth token is present and token metadata is
invalid but rate limit is not exceeded
- 6. Throws an error if auth token is present and token metadata is
invalid and rate limit is exceeded
- 7. Calls next handler if auth token is present and token metadata is
valid
   - [x] Update Github Action to execute Unit Tests

---------

Co-authored-by: Travis Vachon <[email protected]>

.github/actions/test/action.yml

@@ -13,5 +13,9 @@ runs:
       shell: bash
     - run: npm run lint
       shell: bash
-    - run: npm test
+    - run: npm run test:unit
+      name: Unit Tests
+      shell: bash
+    - run: npm run test:miniflare
+      name: Miniflare Tests
       shell: bash

.gitignore

@@ -2,3 +2,4 @@ node_modules
 dist
 .mf
 .env
+.dev.vars

README.md

@@ -10,6 +10,113 @@
 
 ![freeway overview diagram](./docs/freeway.png)
 
+## Running Locally
+
+1. Install the project
+```sh
+npm install
+```
+
+2. CloudFlare Authentication
+```sh
+npx wrangler login
+```
+
+3. Get Your Account Id
+```sh
+npx wrangler whoami
+```
+
+4. Add your configs to `wrangler.toml`
+```sh
+[env.YOUR_USERNAME]
+# Custom name for your testing/dev worker
+name = "YOUR_USERNAME-freeway"
+workers_dev = true
+# Account Id from step 3
+account_id = "YOUR_ACCOUNT_ID"
+# See step 4.2 to create the R2 Bucket
+r2_buckets = [
+  { 
+    binding = "CARPARK", bucket_name = "carpark-YOUR_USERNAME-0", preview_bucket_name = "carpark-YOUR_USERNAME-preview-0" 
+  }
+]
+
+[env.YOUR_USERNAME.vars]
+DEBUG = "true"
+FF_RATE_LIMITER_ENABLED = "false"
+CONTENT_CLAIMS_SERVICE_URL = "https://dev.claims.web3.storage"
+```
+
+If you want to enable the Rate Limiter and KV add the following too:
+```sh
+[[env.YOUR_USERNAME.unsafe.bindings]]
+name = "RATE_LIMITER"
+type = "ratelimit"
+namespace_id = "0"
+simple = { limit = 100, period = 60 }
+
+[[env.YOUR_USERNAME.kv_namespaces]]
+binding = "AUTH_TOKEN_METADATA"
+# See step 4.1 to create the KV store
+id = "KV_ID"
+```
+
+4.1
+In order to get the KV ID you need to create a KV with the following command:
+```sh
+ npx wrangler kv namespace create YOUR_USERNAME-AUTH_TOKEN_METADATA       
+ ```
+Copy the `id` from the output and add it to your `env.YOUR_USERNAME.kv_namespaces`.
+
+4.2
+You will also need to create the R2 Bucket:
+```sh
+npx wrangler r2 bucket create carpark-YOUR_USERNAME-0
+```
+
+5. Start local server
+```sh
+npx wrangler dev -e YOUR_USERNAME
+```
+
+## Testing
+
+Freeway is using miniflare v3 for testing which allows you to define the testing configurations in the JavaScript code (see `src/test/index.spec.js`). 
+
+Note:
+- Miniflare v3 doesn't support the Rate Limiting binding for now, so we need to mock the rate limiting API to be able to use it in tests and in local development.
+
+In order to run the existing tests you can execute the following commands:
+
+**Miniflare Tests**
+```sh
+npm run test:miniflare
+```
+
+**Unit Tests**
+```sh
+npm run test:unit
+```
+
+**Integration Tests**
+```sh
+TBD
+```
+
+## Deployment
+
+Deploy the worker to Cloudflare using your environment configuration:
+```sh
+npx wrangler deploy -e YOUR_USERNAME
+```
+
+In order to remove the worker after your testing is done, you can execute:
+```sh
+npx wrangler delete YOUR_WORKER_NAME -e YOUR_USERNAME
+```
+If you are connected with the Cloudflare Company account, please make sure you are not deleting the `freeway-worker` - which is the Production worker.
+
 ## Contributing
 
 Feel free to join in. All welcome. Please read our [contributing guidelines](https://github.com/web3-storage/freeway/blob/main/CONTRIBUTING.md) and/or [open an issue](https://github.com/web3-storage/freeway/issues)!