itzsaga/reading-plan-worker

Cloudflare worker to serve up The Axis Church reading plan each day.

The Axis Church Reading Plan Worker

While attempting to keep up with the daily reading I frequently found myself without the reading cards. Even though I can download them digitally, being a developer I wanted to try out something different. This worker is the results.

Features

• The reading info is uploaded using the wrangler cli kv:bulk functionality.
  • Already uploaded files can be found in the /kv_files/uploaded/ directory.
• Defaults to reading from the KV store todays date values.
• Accepts a query parameter to load readings from other days e.g. ?date=2021-09-01.
• Queries the text from the ESV API and cahces the response to ensure rate limits are note exceeded and response times stay super fast.

reading-plan-worker's Issues

API limits workaround

The ESV API has a limit of only allowing 500 verses or half of a full book of the Bible, whichever is less. However, with some books being 3 or less chapters the reading plan has those entire books on a single day. These books get truncated in the API response.

Need to figure out a way around this. Possible a flag on the date and merging of multiple API responses instead of the current all in one way.

Update README

Use KV instead of hardcoded file

Should switch to using the Cloudflare KV for the reading list. Store the file in repo and do a bulk upload via wrangler.

Tests

The TypeScript Starter Template includes some example test code. The code in this repository should have test coverage as well.

UI Based Navigation

The application has the logic built in to take a date query param. Need to add forward and back buttons to allow moving sequentially through the reading plan via the UI.

CICD

Currently I'm doing wrangler publish locally to update the worker. This should be taken care of automatically by a CICD pipeline when merging to main.

Timezones 🤦🏻‍♂️

The current date is based on UTC and doesn't take into account the time zone the end user is accessing the worker from. It could also be the time zone the worker is executed in. Though with the global CDN this should be close to where the end user is located.

Seed KV store

The KV will need to be seeded with the reading list. See the bulk documentation for how the file should be formatted.

Create two folders wip and submitted. After a file is bulk uploaded it should be moved into the submitted folder and have the date it was added to the KV store added in the file.

Check once added to the KV store:

• January
• February
• March
• April
• May
• June
• July
• August
• September
• October
• November
• December

Permanent KV values

The current code looks for a specific date every day. This is tedious to keep updated. The new code should disregard the year (unless in a leap year where we'll need an additional day added in). Need to think more about how this is architected but would like to remove the ttl from KV uploads and somehow "override" and look for specific leap year values during those years.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Pending Status Checks

These updates await pending status checks. To force their creation now, click the checkbox below.

• chore(deps): update dependency eslint to v9.11.1
• chore(deps): update dependency wrangler to v3.78.10
• chore(deps): update dependency @cloudflare/workers-types to v4.20240925.0
• chore(deps): update dependency miniflare to v3.20240925.0
• chore(deps): update typescript-eslint monorepo to v8.7.0 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)

Detected dependencies

github-actions

.github/workflows/codeql-analysis.yml

• actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332
• github/codeql-action v3
• github/codeql-action v3
• github/codeql-action v3

.github/workflows/publish-worker.yml

• actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332
• cloudflare/wrangler-action v3.7.0

npm

package.json

• @cloudflare/workers-types 4.20240919.0
• @types/jest ^29.0.0
• @typescript-eslint/eslint-plugin ^8.0.0
• @typescript-eslint/parser ^8.0.0
• eslint ^9.0.0
• eslint-config-prettier ^9.0.0
• eslint-config-typescript ^3.0.0
• jest ^29.0.0
• jest-environment-miniflare ^2.14.2
• miniflare ^3.0.0
• prettier ^3.0.0
• ts-jest ^29.0.0
• typescript 5.6.2
• wrangler ^3.22.1

nvm

.nvmrc

• node 20.17.0

---

• Check this box to trigger a request for Renovate to run again on this repository

Skip deploy on irrelevant changes

The deploy CI action should only run when needed. Right now it runs on every push to main so things like README.md updates trigger a deploy for no functional reason.

CICD update KV store

Wire up CICD to automatically bulk upload new files from a /kv_files/to_upload directory then move then to /kv_files/uploaded on merge to main to facilitate anyone writing those files and opening a PR to get them added.