Command to start a local container #491

cleve-fauna · 2024-12-06T22:17:53Z

Ticket(s): FE-5990

Problem

Fauna's docker container gives users an easy way to implement a reliable inner loop development cycle. It makes it easy for them to develop schemas and programs against Fauna locally, without incurring any service costs.

Our support for the container in tooling is absent. User's have to find it and build scripts to fire it up.

Solution

Take a first step to making the container more prevalent in the tooling by making a CLI command to start the container.

Result

You can start a local Fauna with fauna local

Testing

Ran the tests. Notice how I added a bunch for the container.

Out of Scope

I need to add tests for different argv inputs, including incorrect inputs. I've put a generic skipped test to flag that for now.

ecooper

Looking sharp.

I still want the ability to push a schema to a database (creating it if it doesn't already exist), but this is slick by itself too.

ecooper · 2024-12-11T22:27:02Z

package.json

@@ -79,7 +80,7 @@
    "pretest:ci": "npm run build:app",
    "test:ci": "mocha --forbid-only --recursive ./test --require ./test/mocha-root-hooks.mjs --reporter mocha-multi-reporters --reporter-options configFile=./test/config/reporter.json",
    "build": "npm run build:app && npm run build:sea",
-    "build:app": "esbuild --bundle ./src/user-entrypoint.mjs --platform=node --outfile=./dist/cli.cjs --format=cjs --inject:./sea/import-meta-url.js --define:import.meta.url=importMetaUrl --define:process.env.NODE_ENV=\\\"production\\\"",
+    "build:app": "esbuild --loader:.node=file --bundle ./src/user-entrypoint.mjs --platform=node --outfile=./dist/cli.cjs --format=cjs --inject:./sea/import-meta-url.js --define:import.meta.url=importMetaUrl --define:process.env.NODE_ENV=\\\"production\\\"",


tl;dr: What does this do?

Some node modules like low level crypto libraries esbuild does not bundle by default. This instructs esbuild to do so by copying the files it needs into the bundle.

ecooper · 2024-12-11T22:33:52Z

src/lib/docker-containers.mjs

+    containerPort,
+  });
+  logger.stderr(
+    `[StartContainer] Container '${containerName}' started. Monitoring HealthCheck for readiness.`,


FWIW, we could update colorize (and codeToAnsi) to support colorizing logs in a couple lines:

https://textmate-grammars-themes.netlify.app/?theme=github-dark-high-contrast&grammar=log

That's a good idea.

ecooper · 2024-12-11T22:38:11Z

src/commands/local.mjs

+    image: {
+      describe: "The image to run locally",
+      type: "string",
+      default: "fauna/faunadb:latest",
+    },


Why is this customizable?

It probably doesn't need to be. I put it in case someone wanted to use the "nightly" container build. But taht seems like an internal concern not appropriate for this tooling.

There are specific versions published: https://hub.docker.com/r/fauna/faunadb/tags

So i could see a case for having the tag be mutable for debugging. So you'd take a --tag argument instead. But we could also just drop it and always do latest which seems more appropriate for a web service.

I removed this flag.

ecooper · 2024-12-11T22:39:42Z

src/commands/local.mjs

+      type: "boolean",
+      default: true,
+    },
+  });


We can do this in a future PR, but I really love to see FSL directory flag and a database name flag that this command creates and pushes into.

That's good idea for starting up dev and test environments.

echo-bravo-yahoo · 2024-12-12T00:42:00Z

test/local.mjs

+  it("Creates and starts a container when none exists", async () => {
+    docker.pull.onCall(0).resolves();
+    docker.modem.followProgress.callsFake((stream, onFinished) => {
+      onFinished();
+    });
+    docker.listContainers.onCall(0).resolves([]);
+    fetch.onCall(0).resolves(f({})); // fast succeed the health check
+    logsStub.callsFake(async () => ({
+      on: () => {},
+      destroy: () => {},
+    }));
+    docker.createContainer.resolves({
+      start: startStub,
+      logs: logsStub,
+      unpause: unpauseStub,
+    });
+    await run("local", container);


cool tests :)

echo-bravo-yahoo · 2024-12-12T00:42:44Z

src/commands/local.mjs

+      default: "8443",
+    },
+    name: {
+      describe: "The name to give the container",


Suggested change

describe: "The name to give the container",

describe: "The name to give the container.",

src/commands/local.mjs

echo-bravo-yahoo · 2024-12-12T00:44:13Z

src/lib/docker-containers.mjs

+/**
+ * Ensures the container is running
+ * @param {string} imageName The name of the image to create the container from
+ * @param {string} containerName The name of the container to start
+ * @param {number} hostPort The port on the host machine mapped to the container's port
+ * @param {number} containerPort The port inside the container Fauna listens on
+ * @param {boolean} pull Whether to pull the latest image
+ * @returns {Promise<void>}
+ */


love the JSDoc annotations, they're really polished / helpful

echo-bravo-yahoo · 2024-12-12T00:47:44Z

src/lib/docker-containers.mjs

+  logger.stderr(
+    `[ContainerReady] Container '${containerName}' is up and healthy.`,
+  );


not for this PR, but this is probably a good fit for one of the verbosity level loggers (logger.debug/info/warn/error/fatal). maybe we put it on info and change the default log level to include info? going through the verbosity loggers gives users easier / better sifting (b/c you give it a component and a log level, and they can use those to filter in/out sets of logs).

Co-authored-by: echo-bravo-yahoo <[email protected]>

cleve-fauna force-pushed the v3_localCommands branch from 4d21108 to 5e67319 Compare December 10, 2024 14:00

cleve-fauna changed the title ~~RFC local conatiner commands~~ Command to start a local container Dec 10, 2024

cleve-fauna force-pushed the v3_localCommands branch from 17e72ec to 7ab0dbc Compare December 11, 2024 19:38

cleve-fauna marked this pull request as ready for review December 11, 2024 22:17

cleve-fauna requested a review from a team as a code owner December 11, 2024 22:17

cleve-fauna added 17 commits December 11, 2024 14:21

RFC local conatiner commands

ccd6dab

Log progress

e05a084

Use stderrStream

7a4e80a

Remove -q

06d063f

No jumps when writing output

51c17be

Fix build

0e9cc78

Improvements for states

faad2ad

Marke awaits in loop OK

0556605

Refactor

7c7a880

Refactor

cdca61b

Refactor

79b729f

Initial tests

62f5af4

Initial tests

7cde7de

Initial tests

b46dd05

Fix stuff

1e19e25

More tests

99b1ff6

More tests

6b8e3f7

cleve-fauna force-pushed the v3_localCommands branch from ca659cf to 6b8e3f7 Compare December 11, 2024 22:21

ecooper approved these changes Dec 11, 2024

View reviewed changes

ecooper requested review from echo-bravo-yahoo, wildemat and henryfauna December 11, 2024 22:36

ecooper reviewed Dec 11, 2024

View reviewed changes

Move test file to be for local command. Remove ability to pick the image

f4a8ab6

echo-bravo-yahoo approved these changes Dec 12, 2024

View reviewed changes

Apply suggestions from code review

920c381

Co-authored-by: echo-bravo-yahoo <[email protected]>

cleve-fauna merged commit 1801770 into v3 Dec 12, 2024
4 checks passed

cleve-fauna deleted the v3_localCommands branch December 12, 2024 01:39

cleve-fauna mentioned this pull request Dec 13, 2024

v3 colorLogs #523

Closed

wildemat mentioned this pull request Dec 18, 2024

update driver #543

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Command to start a local container #491

Command to start a local container #491

cleve-fauna commented Dec 6, 2024 •

edited

Loading

ecooper left a comment

ecooper Dec 11, 2024

cleve-fauna Dec 12, 2024

ecooper Dec 11, 2024

cleve-fauna Dec 12, 2024

ecooper Dec 11, 2024

cleve-fauna Dec 12, 2024 •

edited

Loading

cleve-fauna Dec 12, 2024

ecooper Dec 11, 2024

cleve-fauna Dec 12, 2024 •

edited

Loading

echo-bravo-yahoo Dec 12, 2024

echo-bravo-yahoo Dec 12, 2024

echo-bravo-yahoo Dec 12, 2024

echo-bravo-yahoo Dec 12, 2024

	describe: "The name to give the container",
	describe: "The name to give the container.",

Command to start a local container #491

Command to start a local container #491

Conversation

cleve-fauna commented Dec 6, 2024 • edited Loading

Problem

Solution

Result

Testing

Out of Scope

ecooper left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cleve-fauna Dec 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cleve-fauna Dec 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cleve-fauna commented Dec 6, 2024 •

edited

Loading

cleve-fauna Dec 12, 2024 •

edited

Loading

cleve-fauna Dec 12, 2024 •

edited

Loading