Lewis Buckley
5da5253cec
* main: (31 commits) Remove overflow from columns Only reverse Watching button if icon_only Move video captions below content Account#slug uses the virtual "tenant" attribute Rename LOCAL_AUTHENTICATION to OSS_CONFIG Add a script to generate unique passwords per email address Visually hide the pagination indicator Use hide avatars from tabindex on preview Render a helpful menu of tenants temporarily Remove code related to Launchpad auth or 37id Users Formatting Fix missing close bracket from merge Reverse involvement buttons if watching Only render the manifest link for tenanted URLs Move load-balancer to fizzy-lb-101 Add otel_collector accessory for load balancer Fix: this was getting idiomorph confused as it was being invoked on many subtree elements Fix: deselect collections in the collections filter Wire up collection filtering: it should be performed in the generic cards view Remove falling back status that we don't support anymore ...
Fizzy
Setting up for development
First get everything installed and configured with:
bin/setup
If you'd like to load fixtures:
bin/rails db:fixtures:load
And then run the development server:
bin/dev
You'll be able to access the app in development at http://development-tenant.fizzy.localhost:3006
Running tests
For fast feedback loops, unit tests can be run with:
bin/rails test
The full continuous integration tests can be run with:
bin/ci
Working with AI features
To work on AI features you need the OpenAI API key stored in the development's credentials file. To decrypt the credentials,
you need place the key in a file config/credentials/development.key. You can copy the file from One Password in
"Fizzy - development.key".
To get semantic searches working for existing data you need to calculate all the vector embeds:
Card.find_each(&:refresh_search_embedding)
Comment.find_each(&:refresh_search_embedding)
Tests
AI Requests
For testing OpenAI API requests, we use VCR. If you want to test AI features exercising the API, you need to place the config/credentials/test.key
that you can get from 1Password in "Fizzy - test.key". Then, when running tests that use Open AI API, you must either set the env variable VCR_RECORD=1
or to add vcr_record! to the test. See VcrTestHelper. Due to Open AI quotas, you may need to limit the parallelization. E.g: PARALLEL_WORKERS=2
You can regenerate all the VCR fixtures with:
VCR_RECORD=1 PARALLEL_WORKERS=2 bin/rails test
A typical scenario is making modifications LLM prompts. You need to:
- Make the prompt changes.
- Run the test with
VCR_RECORD=1set. This will let the test make the actual network requests and record the responses as VCR fixtures. - Make sure that the test passes by running the test normally (without setting VCR_RECORD=1).
- Commit the YML fixtures that VCR has generated. That way, the next time you run the test, it will run fast without performing any request.
Notice that if you pass changing data to the prompt, this mechanism won't work. E.g: if you pass data timestamps. You need to make sure those timestamps are always the same across executions.
Outbound Emails
Development
You can view email previews at http://fizzy.localhost:3006/rails/mailers.
You can enable or disable letter_opener to
open sent emails automatically with:
bin/rails dev:email
Under the hood, this will create or remove tmp/email-dev.txt.
Environments
Fizzy is deployed with Kamal. You'll need to have the 1Password CLI set up in order to access the secrets that are used when deploying. Provided you have that, it should be as simple as bin/kamal deploy to the correct environment.
Beta
Beta is primarily intended for testing product features.
Beta tenant is:
This environment uses local disk for Active Storage.
Staging
Staging is primarily intended for testing infrastructure changes.
Production tenants are:
- https://37s.fizzy.37signals-staging.com/
- https://dev.fizzy.37signals-staging.com/
- https://qa.fizzy.37signals-staging.com/
This environment uses a FlashBlade bucket for blob storage, and shares nothing with Production. We may periodically copy data here from production.
Production
Production tenants are:
This environment uses a FlashBlade bucket for blob storage.