Page MenuHomePhabricator
Differential D5643

Introduce drafts related types and redux actions
ClosedPublic
Actions

Authored by marcin on Nov 16 2022, 4:27 AM.
Tags
None
Referenced Files
F6237209: D5643.diff
Thu, Apr 24, 4:22 PM
Unknown Object (File)
Sun, Apr 13, 4:20 PM
Unknown Object (File)
Sun, Apr 13, 4:20 PM
Unknown Object (File)
Sun, Apr 13, 4:20 PM
Unknown Object (File)
Thu, Apr 3, 12:38 AM
Unknown Object (File)
Tue, Apr 1, 7:57 AM
Unknown Object (File)
Mar 18 2025, 4:41 AM
Unknown Object (File)
Mar 17 2025, 7:58 PM
View All Files
Subscribers
• abosh
ashoat

Details

Reviewers
tomek
atul
ashoat
Commits
rCOMMf79c282ad8ee: Introduce drafts related types and redux actions
Summary

This differential defines types to store drafts in redux and actions to alter them via reducers. Note: setDraftStoreDraftsActionType si define temporarily to increase readability and enhance smooth code review process for this stack. It will be deleted shortly.

Test Plan

Make sure eslint and flow do not point any errors.

Diff Detail

Repository
rCOMM Comm
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

marcin created this revision.Nov 16 2022, 4:27 AM
Herald added subscribers: • abosh, ashoat. · View Herald TranscriptNov 16 2022, 4:27 AM
marcin added a child revision: D5644: Bring drafts and related actions to redux.Nov 16 2022, 4:30 AM
Harbormaster completed remote builds in B13463: Diff 18462.Nov 16 2022, 4:40 AM
marcin requested review of this revision.Nov 16 2022, 4:40 AM
marcin added a comment.Nov 16 2022, 5:14 AM

Important:

Note: setDraftStoreDraftsActionType is defined temporarily to increase readability and enhance smooth code review process for this stack. It will be deleted shortly.

It will be deleted in a differential to get rid of setMessageStoreMessagesActionType and setThreadStoreActionType.

ashoat requested changes to this revision.Nov 16 2022, 7:19 PM

Since the DraftStore should not exist on web, let's keep these files in native

This revision now requires changes to proceed.Nov 16 2022, 7:19 PM
ashoat resigned from this revision.Nov 16 2022, 7:21 PM

Although maybe we want to add this on web? It didn't exist there before, but now that we have redux-persist on web maybe it is a good idea...

This revision now requires review to proceed.Nov 16 2022, 7:21 PM
marcin planned changes to this revision.Nov 17 2022, 2:56 AM
marcin requested review of this revision.Nov 17 2022, 8:22 AM
atul accepted this revision.Nov 17 2022, 11:35 AM

Looks great!

This revision is now accepted and ready to land.Nov 17 2022, 11:35 AM
tomek accepted this revision.Nov 18 2022, 3:25 AM
marcin updated this revision to Diff 18642.Nov 21 2022, 3:32 AM

Add remove all drafts store operation

Harbormaster completed remote builds in B13612: Diff 18642.Nov 21 2022, 3:46 AM
marcin updated this revision to Diff 18684.Nov 21 2022, 9:31 AM

Rebase master

Harbormaster completed remote builds in B13637: Diff 18684.Nov 21 2022, 9:46 AM
marcin updated this revision to Diff 18753.Nov 23 2022, 4:49 AM

Rebase before landing

Harbormaster completed remote builds in B13687: Diff 18753.Nov 23 2022, 5:00 AM
Closed by commit rCOMMf79c282ad8ee: Introduce drafts related types and redux actions (authored by marcin). · Explain WhyNov 23 2022, 5:51 AM
This revision was automatically updated to reflect the committed changes.
marcin added a commit: rCOMMf79c282ad8ee: Introduce drafts related types and redux actions.

Revision Contents
Changeset List

PathSize
lib/
actions/
7 lines
types/
25 lines

Diff 18753

View Options

lib/actions/draft-actions.js

# 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

lib/types/draft-types.js

# 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