Page MenuHomePhabricator
Differential D5648

Implement draft store operations processing in CommCoreModule
ClosedPublic
Actions

Authored by marcin on Nov 16 2022, 5:16 AM.
Tags
None
Referenced Files
F6236962: D5648.diff
Thu, Apr 24, 4:01 PM
Unknown Object (File)
Mar 23 2025, 5:57 AM
Unknown Object (File)
Mar 16 2025, 10:05 AM
Unknown Object (File)
Mar 16 2025, 10:05 AM
Unknown Object (File)
Mar 16 2025, 10:05 AM
Unknown Object (File)
Mar 16 2025, 10:05 AM
Unknown Object (File)
Mar 16 2025, 10:05 AM
Unknown Object (File)
Mar 16 2025, 10:05 AM
View All Files
Subscribers
• abosh
ashoat

Details

Reviewers
tomek
atul
• jon
Commits
rCOMM15cd91b15b5f: Implement draft store operations processing in CommCoreModule
Summary

This differential implements draft store processing functionality in CommCoreModule to enable bulk drafts dump to SQLite.

Test Plan

Make sure eslint and flow do not point errors.

Diff Detail

Repository
rCOMM Comm
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

marcin created this revision.Nov 16 2022, 5:16 AM
Herald added a reviewer: • jon. · View Herald TranscriptNov 16 2022, 5:16 AM
Herald added subscribers: • abosh, ashoat. · View Herald Transcript
marcin added a parent revision: D5647: Implement DraftStoreOperations C++ utility.Nov 16 2022, 5:17 AM
marcin added a child revision: D5649: Persist drafts in SQLite.Nov 16 2022, 5:22 AM
Harbormaster completed remote builds in B13474: Diff 18473.Nov 16 2022, 5:30 AM
marcin requested review of this revision.Nov 16 2022, 5:30 AM
marcin planned changes to this revision.Nov 17 2022, 2:57 AM
marcin requested review of this revision.Nov 17 2022, 8:23 AM
atul accepted this revision.Nov 17 2022, 3:22 PM

Looks good!

Easy to review as it closely follows the conventions from processThreadStoreOperations(...) and processMessageStoreOperations(...)

native/cpp/CommonCpp/NativeModules/CommCoreModule.cpp
357 ↗(On Diff #18473)

Personally prefer being explicit in the lambda capture list, but don't think we ever determined any "team convention" so totally up to you

373 ↗(On Diff #18473)

Same thing where I'd personally prefer being explicit about the lambda capture list, but up to you

This revision is now accepted and ready to land.Nov 17 2022, 3:22 PM
marcin added inline comments.Nov 18 2022, 12:23 AM
native/cpp/CommonCpp/NativeModules/CommCoreModule.cpp
373 ↗(On Diff #18473)

Here and above I was following the code for processMessageStoreOperations and processThreadStoreOperations where lambda captures are also as simple as this.

tomek requested changes to this revision.Nov 18 2022, 4:01 AM
tomek added inline comments.
native/cpp/CommonCpp/NativeModules/CommCoreModule.cpp
317–318 ↗(On Diff #18473)

It's a really bad practice to use #define constants (in ancient times this was the solution, but now it's ok to use const). The most important drawback of using #define is that the name will disappear and during the runtime (e.g. debugging) there's only the value. So you won't see MOVE_DRAFT_OPERATION when debugging, it will be just "move" and that will make this process a lot harder.

This revision now requires changes to proceed.Nov 18 2022, 4:01 AM
marcin added inline comments.Nov 18 2022, 5:20 AM
native/cpp/CommonCpp/NativeModules/CommCoreModule.cpp
317–318 ↗(On Diff #18473)

Sure. I will also replace #define with constants for MessageStore and ThreadStore operations.

marcin updated this revision to Diff 18581.Nov 18 2022, 8:35 AM

Use const instead of define

Harbormaster completed remote builds in B13562: Diff 18581.Nov 18 2022, 8:49 AM
marcin updated this revision to Diff 18645.Nov 21 2022, 3:34 AM

Process remove all drafts operation in CommCoreModule

Harbormaster completed remote builds in B13615: Diff 18645.Nov 21 2022, 3:48 AM
tomek accepted this revision.Nov 21 2022, 4:40 AM
This revision is now accepted and ready to land.Nov 21 2022, 4:40 AM
marcin updated this revision to Diff 18689.Nov 21 2022, 9:40 AM

Rebase master

Harbormaster completed remote builds in B13642: Diff 18689.Nov 21 2022, 9:54 AM
marcin updated this revision to Diff 18758.Nov 23 2022, 4:54 AM

Rebase before landing

Harbormaster completed remote builds in B13692: Diff 18758.Nov 23 2022, 5:08 AM
Closed by commit rCOMM15cd91b15b5f: Implement draft store operations processing in CommCoreModule (authored by marcin). · Explain WhyNov 23 2022, 5:51 AM
This revision was automatically updated to reflect the committed changes.
marcin added a commit: rCOMM15cd91b15b5f: Implement draft store operations processing in CommCoreModule.

Revision Contents
Changeset List

PathSize
native/
cpp/
CommonCpp/
NativeModules/
3 lines
83 lines
_generated/
schema/
4 lines

Diff 18758

View Options

native/cpp/CommonCpp/NativeModules/CommCoreModule.h

# Motivation # Motivation
We use Nix to package all of the dependencies for our dev environment. It does several things for us: We use Nix to package all of the dependencies for our dev environment. It does several things for us:
- Enables new devs on macOS or Linux to set up our dev environment with just one command - Enables new devs on macOS or Linux to set up our dev environment with just one command
- Makes sure that everybody on the team is using the same versions of all the tools - Makes sure that everybody on the team is using the same versions of all the tools
- Allows us to isolate development dependencies from affecting the host system - Allows us to isolate development dependencies from affecting the host system
For how Nix package management works, please refer to the official [how Nix works guide](https://nixos.org/guides/how-nix-works.html). For how Nix package management works, please refer to the official [how Nix works guide](https://nixos.org/guides/how-nix-works.html).
# Supported workflows # Supported workflows
| Workflow | macOS supported | | Workflow | macOS supported |
| ------------------------------- | --------------- | | ------------------------------- | --------------- |
| `keyserver` (Node.js) | ✅ | | `keyserver` (Node.js) | ✅ **†** |
| `web` (Webpack) | ✅ | | `web` (Webpack) | ✅ **†** |
| `native` iOS (React Native) | ❌ **†** | | `native` iOS (React Native) | ✅ **†** |
| `native` Android (React Native) | ❌ **†** | | `native` Android (React Native) | ✅ **†** |
aboshUnsubmitted
Done
Inline Actions

At this point, nearly every workflow requires additional steps. Maybe we can think about a way to make this seem better in the future -- users should know before reading the footnote that Nix isn't going to do everything for them. But, it will do most of the work for them, and anything else will be smaller.

While the user might still know this, the footnote isn't really helping right now. It makes it seem like we told them Nix will do a lot of things, and then later slid in that they will have to do more things.

Currently, the footnote for these sections has a lot of examples for "additional steps." Plus, "additional steps" is broad and could mean any amount of steps, especially to a user who has no familiarity with the dev environment.

So we should think about that, since most of the time footnotes should be used sparingly. If they end up affecting a large portion of a section, we should just make it information the user knows outside of just the footnote. But this can be a separate issue.

abosh: At this point, nearly every workflow requires additional steps. Maybe we can think about a way…
jonAuthorUnsubmitted
Done
Inline Actions

I originally wrote this before the prerequisite section existed. I can just reference that section now.

Probably be a better user experience anyway.

Would you like me to just reference the section? ... I went ahead and just referenced it anyway.

jon: I originally wrote this before the prerequisite section existed. I can just reference that…
aboshUnsubmitted
Done
Inline Actions

Perfect! This is much better and explicitly links a section that users can find easily.

abosh: Perfect! This is much better and explicitly links a section that users can find easily.
| C++ services | ❌ **\*** | | C++ services | ❌ **\*** |
| Rust services | ✅ | | Rust services | ✅ |
**†** Workflow requires additional undocumented steps after Nix installation (e.g. installing XCode, XCode profile, Android Studio, or Android NDK). **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
aboshUnsubmitted
Done
Inline Actions
| Rust services | ✅ |
- **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
+ **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, browser extensions, Flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

I don't think we need the "optional," that can be made clearer in the actual documentation for React/Redux Dev Tools. Here, in a footnote, it's not as necessary.

abosh: I don't think we need the "optional," that can be made clearer in the actual documentation for…
jonAuthorUnsubmitted
Done
Inline Actions

Right, but it was never clear in the original documentation what is optional or not. Same with Flipper and idb.

I can also just remove the statement and replace it with a link to prerequisite section

jon: Right, but it was never clear in the original documentation what is optional or not. Same with…
jonAuthorUnsubmitted
Done
Inline Actions

Removed this comment in favor of just referencing the prerequisite section.

jon: Removed this comment in favor of just referencing the prerequisite section.
aboshUnsubmitted
Done
Inline Actions
| Rust services | ✅ |
- **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
+ **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or the Android NDK).
**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

Should this be "the" Android NDK?

abosh: Should this be "the" Android NDK?
jonAuthorUnsubmitted
Done
Inline Actions

If I switch Studio and NDK, I think it would sounds odd to me either way reactotron, the Android NDK, or Android Studio.

I can add it.

jon: If I switch Studio and NDK, I think it would sounds odd to me either way `reactotron, the…
**\*** Workflow requires RabbitMQ and AWS/Localstack to be available. **\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.
aboshUnsubmitted
Done
Inline Actions

What exactly does this mean?

abosh: What exactly does this mean?
jonAuthorUnsubmitted
Done
Inline Actions

It means that it's still in active development for nix support. It's largely documented here: https://github.com/CommE2E/comm/blob/master/docs/dev_services.md.

https://www.notion.so/commapp/Nix-Dev-Env-Status-170d0600d2a447fa840eb720fb11e951 will probably give you a better overview of the status; @ashoat didn't want this level of detail in user facing documentation.

jon: It means that it's still in active development for nix support. It's largely documented here…
aboshUnsubmitted
Done
Inline Actions

Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.

abosh: Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.
# Requirements # Requirements
To set up a dev environment using Nix, you will need a macOS or Linux machine. To set up a dev environment using Nix, you will need a macOS or Linux machine.
# Prerequisites # Prerequisites
## Nix package manager ## Nix package manager
▲ Show 20 Lines • Show All 55 Lines • Show Last 20 Lines
View Options

native/cpp/CommonCpp/NativeModules/CommCoreModule.cpp

# Motivation # Motivation
We use Nix to package all of the dependencies for our dev environment. It does several things for us: We use Nix to package all of the dependencies for our dev environment. It does several things for us:
- Enables new devs on macOS or Linux to set up our dev environment with just one command - Enables new devs on macOS or Linux to set up our dev environment with just one command
- Makes sure that everybody on the team is using the same versions of all the tools - Makes sure that everybody on the team is using the same versions of all the tools
- Allows us to isolate development dependencies from affecting the host system - Allows us to isolate development dependencies from affecting the host system
For how Nix package management works, please refer to the official [how Nix works guide](https://nixos.org/guides/how-nix-works.html). For how Nix package management works, please refer to the official [how Nix works guide](https://nixos.org/guides/how-nix-works.html).
# Supported workflows # Supported workflows
| Workflow | macOS supported | | Workflow | macOS supported |
| ------------------------------- | --------------- | | ------------------------------- | --------------- |
| `keyserver` (Node.js) | ✅ | | `keyserver` (Node.js) | ✅ **†** |
| `web` (Webpack) | ✅ | | `web` (Webpack) | ✅ **†** |
| `native` iOS (React Native) | ❌ **†** | | `native` iOS (React Native) | ✅ **†** |
| `native` Android (React Native) | ❌ **†** | | `native` Android (React Native) | ✅ **†** |
aboshUnsubmitted
Done
Inline Actions

At this point, nearly every workflow requires additional steps. Maybe we can think about a way to make this seem better in the future -- users should know before reading the footnote that Nix isn't going to do everything for them. But, it will do most of the work for them, and anything else will be smaller.

While the user might still know this, the footnote isn't really helping right now. It makes it seem like we told them Nix will do a lot of things, and then later slid in that they will have to do more things.

Currently, the footnote for these sections has a lot of examples for "additional steps." Plus, "additional steps" is broad and could mean any amount of steps, especially to a user who has no familiarity with the dev environment.

So we should think about that, since most of the time footnotes should be used sparingly. If they end up affecting a large portion of a section, we should just make it information the user knows outside of just the footnote. But this can be a separate issue.

abosh: At this point, nearly every workflow requires additional steps. Maybe we can think about a way…
jonAuthorUnsubmitted
Done
Inline Actions

I originally wrote this before the prerequisite section existed. I can just reference that section now.

Probably be a better user experience anyway.

Would you like me to just reference the section? ... I went ahead and just referenced it anyway.

jon: I originally wrote this before the prerequisite section existed. I can just reference that…
aboshUnsubmitted
Done
Inline Actions

Perfect! This is much better and explicitly links a section that users can find easily.

abosh: Perfect! This is much better and explicitly links a section that users can find easily.
| C++ services | ❌ **\*** | | C++ services | ❌ **\*** |
| Rust services | ✅ | | Rust services | ✅ |
**†** Workflow requires additional undocumented steps after Nix installation (e.g. installing XCode, XCode profile, Android Studio, or Android NDK). **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
aboshUnsubmitted
Done
Inline Actions
| Rust services | ✅ |
- **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
+ **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, browser extensions, Flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

I don't think we need the "optional," that can be made clearer in the actual documentation for React/Redux Dev Tools. Here, in a footnote, it's not as necessary.

abosh: I don't think we need the "optional," that can be made clearer in the actual documentation for…
jonAuthorUnsubmitted
Done
Inline Actions

Right, but it was never clear in the original documentation what is optional or not. Same with Flipper and idb.

I can also just remove the statement and replace it with a link to prerequisite section

jon: Right, but it was never clear in the original documentation what is optional or not. Same with…
jonAuthorUnsubmitted
Done
Inline Actions

Removed this comment in favor of just referencing the prerequisite section.

jon: Removed this comment in favor of just referencing the prerequisite section.
aboshUnsubmitted
Done
Inline Actions
| Rust services | ✅ |
- **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
+ **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or the Android NDK).
**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

Should this be "the" Android NDK?

abosh: Should this be "the" Android NDK?
jonAuthorUnsubmitted
Done
Inline Actions

If I switch Studio and NDK, I think it would sounds odd to me either way reactotron, the Android NDK, or Android Studio.

I can add it.

jon: If I switch Studio and NDK, I think it would sounds odd to me either way `reactotron, the…
**\*** Workflow requires RabbitMQ and AWS/Localstack to be available. **\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.
aboshUnsubmitted
Done
Inline Actions

What exactly does this mean?

abosh: What exactly does this mean?
jonAuthorUnsubmitted
Done
Inline Actions

It means that it's still in active development for nix support. It's largely documented here: https://github.com/CommE2E/comm/blob/master/docs/dev_services.md.

https://www.notion.so/commapp/Nix-Dev-Env-Status-170d0600d2a447fa840eb720fb11e951 will probably give you a better overview of the status; @ashoat didn't want this level of detail in user facing documentation.

jon: It means that it's still in active development for nix support. It's largely documented here…
aboshUnsubmitted
Done
Inline Actions

Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.

abosh: Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.
# Requirements # Requirements
To set up a dev environment using Nix, you will need a macOS or Linux machine. To set up a dev environment using Nix, you will need a macOS or Linux machine.
# Prerequisites # Prerequisites
## Nix package manager ## Nix package manager
▲ Show 20 Lines • Show All 55 Lines • Show Last 20 Lines
View Options

native/cpp/CommonCpp/_generated/NativeModules.h

# Motivation # Motivation
We use Nix to package all of the dependencies for our dev environment. It does several things for us: We use Nix to package all of the dependencies for our dev environment. It does several things for us:
- Enables new devs on macOS or Linux to set up our dev environment with just one command - Enables new devs on macOS or Linux to set up our dev environment with just one command
- Makes sure that everybody on the team is using the same versions of all the tools - Makes sure that everybody on the team is using the same versions of all the tools
- Allows us to isolate development dependencies from affecting the host system - Allows us to isolate development dependencies from affecting the host system
For how Nix package management works, please refer to the official [how Nix works guide](https://nixos.org/guides/how-nix-works.html). For how Nix package management works, please refer to the official [how Nix works guide](https://nixos.org/guides/how-nix-works.html).
# Supported workflows # Supported workflows
| Workflow | macOS supported | | Workflow | macOS supported |
| ------------------------------- | --------------- | | ------------------------------- | --------------- |
| `keyserver` (Node.js) | ✅ | | `keyserver` (Node.js) | ✅ **†** |
| `web` (Webpack) | ✅ | | `web` (Webpack) | ✅ **†** |
| `native` iOS (React Native) | ❌ **†** | | `native` iOS (React Native) | ✅ **†** |
| `native` Android (React Native) | ❌ **†** | | `native` Android (React Native) | ✅ **†** |
aboshUnsubmitted
Done
Inline Actions

At this point, nearly every workflow requires additional steps. Maybe we can think about a way to make this seem better in the future -- users should know before reading the footnote that Nix isn't going to do everything for them. But, it will do most of the work for them, and anything else will be smaller.

While the user might still know this, the footnote isn't really helping right now. It makes it seem like we told them Nix will do a lot of things, and then later slid in that they will have to do more things.

Currently, the footnote for these sections has a lot of examples for "additional steps." Plus, "additional steps" is broad and could mean any amount of steps, especially to a user who has no familiarity with the dev environment.

So we should think about that, since most of the time footnotes should be used sparingly. If they end up affecting a large portion of a section, we should just make it information the user knows outside of just the footnote. But this can be a separate issue.

abosh: At this point, nearly every workflow requires additional steps. Maybe we can think about a way…
jonAuthorUnsubmitted
Done
Inline Actions

I originally wrote this before the prerequisite section existed. I can just reference that section now.

Probably be a better user experience anyway.

Would you like me to just reference the section? ... I went ahead and just referenced it anyway.

jon: I originally wrote this before the prerequisite section existed. I can just reference that…
aboshUnsubmitted
Done
Inline Actions

Perfect! This is much better and explicitly links a section that users can find easily.

abosh: Perfect! This is much better and explicitly links a section that users can find easily.
| C++ services | ❌ **\*** | | C++ services | ❌ **\*** |
| Rust services | ✅ | | Rust services | ✅ |
**†** Workflow requires additional undocumented steps after Nix installation (e.g. installing XCode, XCode profile, Android Studio, or Android NDK). **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
aboshUnsubmitted
Done
Inline Actions
| Rust services | ✅ |
- **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
+ **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, browser extensions, Flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

I don't think we need the "optional," that can be made clearer in the actual documentation for React/Redux Dev Tools. Here, in a footnote, it's not as necessary.

abosh: I don't think we need the "optional," that can be made clearer in the actual documentation for…
jonAuthorUnsubmitted
Done
Inline Actions

Right, but it was never clear in the original documentation what is optional or not. Same with Flipper and idb.

I can also just remove the statement and replace it with a link to prerequisite section

jon: Right, but it was never clear in the original documentation what is optional or not. Same with…
jonAuthorUnsubmitted
Done
Inline Actions

Removed this comment in favor of just referencing the prerequisite section.

jon: Removed this comment in favor of just referencing the prerequisite section.
aboshUnsubmitted
Done
Inline Actions
| Rust services | ✅ |
- **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
+ **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or the Android NDK).
**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

Should this be "the" Android NDK?

abosh: Should this be "the" Android NDK?
jonAuthorUnsubmitted
Done
Inline Actions

If I switch Studio and NDK, I think it would sounds odd to me either way reactotron, the Android NDK, or Android Studio.

I can add it.

jon: If I switch Studio and NDK, I think it would sounds odd to me either way `reactotron, the…
**\*** Workflow requires RabbitMQ and AWS/Localstack to be available. **\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.
aboshUnsubmitted
Done
Inline Actions

What exactly does this mean?

abosh: What exactly does this mean?
jonAuthorUnsubmitted
Done
Inline Actions

It means that it's still in active development for nix support. It's largely documented here: https://github.com/CommE2E/comm/blob/master/docs/dev_services.md.

https://www.notion.so/commapp/Nix-Dev-Env-Status-170d0600d2a447fa840eb720fb11e951 will probably give you a better overview of the status; @ashoat didn't want this level of detail in user facing documentation.

jon: It means that it's still in active development for nix support. It's largely documented here…
aboshUnsubmitted
Done
Inline Actions

Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.

abosh: Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.
# Requirements # Requirements
To set up a dev environment using Nix, you will need a macOS or Linux machine. To set up a dev environment using Nix, you will need a macOS or Linux machine.
# Prerequisites # Prerequisites
## Nix package manager ## Nix package manager
▲ Show 20 Lines • Show All 55 Lines • Show Last 20 Lines
View Options

native/cpp/CommonCpp/_generated/NativeModules.cpp

# Motivation # Motivation
We use Nix to package all of the dependencies for our dev environment. It does several things for us: We use Nix to package all of the dependencies for our dev environment. It does several things for us:
- Enables new devs on macOS or Linux to set up our dev environment with just one command - Enables new devs on macOS or Linux to set up our dev environment with just one command
- Makes sure that everybody on the team is using the same versions of all the tools - Makes sure that everybody on the team is using the same versions of all the tools
- Allows us to isolate development dependencies from affecting the host system - Allows us to isolate development dependencies from affecting the host system
For how Nix package management works, please refer to the official [how Nix works guide](https://nixos.org/guides/how-nix-works.html). For how Nix package management works, please refer to the official [how Nix works guide](https://nixos.org/guides/how-nix-works.html).
# Supported workflows # Supported workflows
| Workflow | macOS supported | | Workflow | macOS supported |
| ------------------------------- | --------------- | | ------------------------------- | --------------- |
| `keyserver` (Node.js) | ✅ | | `keyserver` (Node.js) | ✅ **†** |
| `web` (Webpack) | ✅ | | `web` (Webpack) | ✅ **†** |
| `native` iOS (React Native) | ❌ **†** | | `native` iOS (React Native) | ✅ **†** |
| `native` Android (React Native) | ❌ **†** | | `native` Android (React Native) | ✅ **†** |
aboshUnsubmitted
Done
Inline Actions

At this point, nearly every workflow requires additional steps. Maybe we can think about a way to make this seem better in the future -- users should know before reading the footnote that Nix isn't going to do everything for them. But, it will do most of the work for them, and anything else will be smaller.

While the user might still know this, the footnote isn't really helping right now. It makes it seem like we told them Nix will do a lot of things, and then later slid in that they will have to do more things.

Currently, the footnote for these sections has a lot of examples for "additional steps." Plus, "additional steps" is broad and could mean any amount of steps, especially to a user who has no familiarity with the dev environment.

So we should think about that, since most of the time footnotes should be used sparingly. If they end up affecting a large portion of a section, we should just make it information the user knows outside of just the footnote. But this can be a separate issue.

abosh: At this point, nearly every workflow requires additional steps. Maybe we can think about a way…
jonAuthorUnsubmitted
Done
Inline Actions

I originally wrote this before the prerequisite section existed. I can just reference that section now.

Probably be a better user experience anyway.

Would you like me to just reference the section? ... I went ahead and just referenced it anyway.

jon: I originally wrote this before the prerequisite section existed. I can just reference that…
aboshUnsubmitted
Done
Inline Actions

Perfect! This is much better and explicitly links a section that users can find easily.

abosh: Perfect! This is much better and explicitly links a section that users can find easily.
| C++ services | ❌ **\*** | | C++ services | ❌ **\*** |
| Rust services | ✅ | | Rust services | ✅ |
**†** Workflow requires additional undocumented steps after Nix installation (e.g. installing XCode, XCode profile, Android Studio, or Android NDK). **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
aboshUnsubmitted
Done
Inline Actions
| Rust services | ✅ |
- **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
+ **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, browser extensions, Flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

I don't think we need the "optional," that can be made clearer in the actual documentation for React/Redux Dev Tools. Here, in a footnote, it's not as necessary.

abosh: I don't think we need the "optional," that can be made clearer in the actual documentation for…
jonAuthorUnsubmitted
Done
Inline Actions

Right, but it was never clear in the original documentation what is optional or not. Same with Flipper and idb.

I can also just remove the statement and replace it with a link to prerequisite section

jon: Right, but it was never clear in the original documentation what is optional or not. Same with…
jonAuthorUnsubmitted
Done
Inline Actions

Removed this comment in favor of just referencing the prerequisite section.

jon: Removed this comment in favor of just referencing the prerequisite section.
aboshUnsubmitted
Done
Inline Actions
| Rust services | ✅ |
- **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
+ **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or the Android NDK).
**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

Should this be "the" Android NDK?

abosh: Should this be "the" Android NDK?
jonAuthorUnsubmitted
Done
Inline Actions

If I switch Studio and NDK, I think it would sounds odd to me either way reactotron, the Android NDK, or Android Studio.

I can add it.

jon: If I switch Studio and NDK, I think it would sounds odd to me either way `reactotron, the…
**\*** Workflow requires RabbitMQ and AWS/Localstack to be available. **\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.
aboshUnsubmitted
Done
Inline Actions

What exactly does this mean?

abosh: What exactly does this mean?
jonAuthorUnsubmitted
Done
Inline Actions

It means that it's still in active development for nix support. It's largely documented here: https://github.com/CommE2E/comm/blob/master/docs/dev_services.md.

https://www.notion.so/commapp/Nix-Dev-Env-Status-170d0600d2a447fa840eb720fb11e951 will probably give you a better overview of the status; @ashoat didn't want this level of detail in user facing documentation.

jon: It means that it's still in active development for nix support. It's largely documented here…
aboshUnsubmitted
Done
Inline Actions

Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.

abosh: Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.
# Requirements # Requirements
To set up a dev environment using Nix, you will need a macOS or Linux machine. To set up a dev environment using Nix, you will need a macOS or Linux machine.
# Prerequisites # Prerequisites
## Nix package manager ## Nix package manager
▲ Show 20 Lines • Show All 55 Lines • Show Last 20 Lines
View Options

native/schema/CommCoreModuleSchema.js

Loading...