Page MenuHomePhabricator

[services] Change `dev-mode` to `sandbox`
ClosedPublic

Authored by max on Jun 27 2022, 3:53 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sun, Nov 3, 3:40 PM
Unknown Object (File)
Sun, Nov 3, 3:40 PM
Unknown Object (File)
Sun, Nov 3, 3:40 PM
Unknown Object (File)
Sun, Nov 3, 3:39 PM
Unknown Object (File)
Sun, Nov 3, 3:34 PM
Unknown Object (File)
Wed, Oct 23, 11:47 AM
Unknown Object (File)
Tue, Oct 22, 12:31 PM
Unknown Object (File)
Mon, Oct 21, 6:56 PM

Details

Summary

Following the @ashoat comments and @varun comments in D4253, it's better to remove the "jargon" dev-mode from the services commands and change it to 'sandbox'.

This diff is a refactoring dev-mode to sandbox.

Linear task: ENG-1299

Test Plan

Running yarn run-[service-name]-service-in-sandbox do the same as previous yarn run-[service-name]-service-dev-mode

Diff Detail

Repository
rCOMM Comm
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

tomek requested changes to this revision.Jun 28 2022, 2:16 AM
tomek added a reviewer: ashoat. tomek added 1 blocking reviewer(s): varun.

@ashoat's comment suggests to avoid dev-mode and use dev mode instead.
In other place @ashoat suggests to explain what a dev mode is https://phab.comm.dev/D4253#inline-26680
So it doesn't look like @ashoat's intention is to replace dev mode with sandbox.

On the other hand @varun suggests that we should change the commands to use sandbox in names.

So there's no place where someone suggests to change something more than just the commands. And it doesn't seem like there's an agreement regarding changing to sandbox.

Adding both @ashoat and @varun as blocking to clarify what's the goal here.

In my opinion, keeping dev mode is ok, but we need to clarify in the documentation what it means for us. The explanation of sandbox should also be included if we decide to rename. I'm not sure if sandbox is a better name, because dev mode not only sandboxes the environment, but also might e.g. have different log levels.

This revision now requires changes to proceed.Jun 28 2022, 2:16 AM
In D4368#123567, @palys-swm wrote:

@ashoat's comment suggests to avoid dev-mode and use dev mode instead.
In other place @ashoat suggests to explain what a dev mode is https://phab.comm.dev/D4253#inline-26680
So it doesn't look like @ashoat's intention is to replace dev mode with sandbox.

On the other hand @varun suggests that we should change the commands to use sandbox in names.

So there's no place where someone suggests to change something more than just the commands. And it doesn't seem like there's an agreement regarding changing to sandbox.

Adding both @ashoat and @varun as blocking to clarify what's the goal here.

In my opinion, keeping dev mode is ok, but we need to clarify in the documentation what it means for us. The explanation of sandbox should also be included if we decide to rename. I'm not sure if sandbox is a better name, because dev mode not only sandboxes the environment, but also might e.g. have different log levels.

I think the goal is clarity. With dev mode, there was confusion as to whether it was the only way to run/test services (it's not, since we can just run them with docker compose). I thought calling it a sandbox would make it clearer that it's a separate local environment. We could also call it a local cloud stack, which is the terminology LocalStack uses. That might be best, honestly.

All that being said, I don't feel too strongly about this, and am happy to defer to whatever you and @ashoat think

I actually think sandbox is a great name for this, better than dev mode!

Defer to others on the review

I actually think sandbox is a great name for this, better than dev mode!

I've voted for sandbox too. Maybe we should vote or something for this change to make a consensus? Btw, @karol-bisztyga didn't post his comment yet.

varun requested changes to this revision.Jun 29 2022, 3:18 PM

Can we change all instances of sandbox mode to just sandbox?

This revision now requires changes to proceed.Jun 29 2022, 3:18 PM

Change from sandbox-mode to sandbox.

In D4368#124580, @varun wrote:

Can we change all instances of sandbox mode to just sandbox?

Of course. Done!

This revision is now accepted and ready to land.Jun 30 2022, 3:34 AM
This revision was landed with ongoing or failed builds.Jul 4 2022, 5:29 AM
This revision was automatically updated to reflect the committed changes.