AO3-6916 Add devcontainer configuration

[brianjaustin]

Pull Request Checklist

Issue

https://otwarchive.atlassian.net/browse/AO3-6916

Credit

Brian Austin (they/he)

[brianjaustin]

This was a bit weird an caused some configuration annoyances, so I just updated it 🤷

[brianjaustin]

Devcontainers still doesn't support profiles easily; it's also a bit annoying (at least for me) when using docker otherwise, so I just removed this

[brianjaustin]

Docker supports compose.yaml now, and it seems to be the standard based on how often it shows up in the docs

[marcus8448]

Is it possible to start/stop/modify the containers defined in the compose.yml within the devcontainer? I can't seem to do it, but I've never used codespaces before so there may be something that I'm missing.

Since the devcontainer is a docker container, it tries (and fails) to start another redis when running a test:

otwarchive/config/initializers/gem-plugin_config/redis.rb

Line 8 in afd3593

start_redis!(rails_root, :cucumber) if rails_env == :test && !(ENV["CI"] || ENV["DOCKER"])

There's something wrong with selenium/chrome that cause tests that require JS to fail.

Also a leftover gitpod file

[marcus8448]

The devcontainer URL needs to be added to the list of allowed hosts.

otwarchive/config/environments/development.rb

Line 96 in d0531a2

config.hosts << "3000-#{ENV['GITPOD_WORKSPACE_ID']}.#{ENV['GITPOD_WORKSPACE_CLUSTER_HOST']}" if ENV["GITPOD_WORKSPACE_ID"]

[marcus8448]

Shouldn't this be hardcoded, since it's hardcoded in the Dockerfile? (it probably could stay as /otwa in that case too, but I don't feel strongly either way)

Suggested change

	"source=${localWorkspaceFolder},target=/${localWorkspaceFolderBasename},type=bind"
	"source=${localWorkspaceFolder},target=/otwarchive,type=bind"

[marcus8448]

The default docker client version installed in the container is too new:

Error response from daemon: client version 1.53 is too new. Maximum supported API version is 1.43

Interestingly, I am able to run docker compose to launch the test container despite this, but it seems like the mounts aren't working:
docker compose run --rm test ls -la /otwarchive comes up empty.

Additionally the host seems to still be blocked, even though the list is actually cleared according to the rails console :/

[brianjaustin]

The default docker client version installed in the container is too new:

I didn't run into any issues with this, so I'm not sure what the issue was. Do you have an older version of docker locally?

That's not really relevant anymore, since I changed to just bootstrap the regular docker compose setup instead of doing the fancy thing. It means less useful autocompletion, but it's not any more/less functional than the gitpod setup was I suppose...

[marcus8448]

Do you have an older version of docker locally?

I've been testing on GitHub Codespaces (so the host version is not controllable on my end), but with docker-in-docker it doesn't seem to be a problem anymore.

Ran some tests, poked around the dev server, everything seems to be working correctly!

[marcus8448]

It means less useful autocompletion, but it's not any more/less functional than the gitpod setup was I suppose...

Is it possible to build & use an image based on our Dockerfile (w/o the server launch) so that we have the ruby environment?
But if that's too much of a hassle to setup, I'm fine with leaving it as a future thing.