Feature: new security section, links #34987

waterim · 2024-01-23T19:13:40Z

Details

Added new Security section to readme, added links to all add/remove member places.

Fixed Issues

$ #33575
PROPOSAL: #33575 (comment)

Tests

Verify the rules added in #Security section of README.md are working as expected

Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

None

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

waterim · 2024-01-28T13:18:53Z

We need to update "Leave" part after new leave functionality will be added!

melvin-bot · 2024-01-29T15:58:06Z

@aimane-chnaif Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

aimane-chnaif · 2024-02-05T06:51:20Z

README.md

+# Security
+Updated rules for managing all types of chats (add/remove people)
+
+1. ### DM


Please put numbers inside # so that numbers are bolded as well
i.e. ### 1. DM

Its not possible on markdown to make ordered list bold unfortunately

The only alternative way is to make it without tabbing, but it looks messy

aimane-chnaif · 2024-02-05T08:12:52Z

iv. Workspace rooms seems not correct to me.

Member should be divided into default and invited

Current behavior:
default member: show Members option so they can Invite/Remove others
invited member: show Invite option so they can only Invite others

waterim · 2024-02-05T15:26:21Z

@aimane-chnaif

iv. Workspace rooms seems not correct to me.
Member should be divided into default and invited
Current behavior: default member: show Members option so they can Invite/Remove others invited member: show Invite option so they can only Invite others

Now everyone can delete everyone in the workspace room as discussed here, its not a workspace chat which is creating automatically, its a workspace room.

aimane-chnaif · 2024-02-05T15:29:46Z

@aimane-chnaif

iv. Workspace rooms seems not correct to me.

Member should be divided into default and invited
Current behavior: default member: show Members option so they can Invite/Remove others invited member: show Invite option so they can only Invite others

Now everyone can delete everyone in the workspace room as discussed here, its not a workspace chat which is creating automatically, its a workspace room.

ok then is it a bug that invited room member (but not a member of workspace) cannot remove someone from workspace room?

waterim · 2024-02-05T15:32:56Z

@aimane-chnaif Ahh, okay, I see, you are right, good catch, updating it.

waterim · 2024-02-05T15:36:02Z

@aimane-chnaif I think we need to add a possibility for Guests to leave the workspace room as well

aimane-chnaif · 2024-02-05T15:37:29Z

@aimane-chnaif I think we need to add a possibility for Guests to leave the workspace room as well

yes agree. But let's confirm with David in slack

waterim · 2024-02-05T15:52:26Z

@aimane-chnaif Okay, updated workspace room is correct.
Everyone can leave the workspace room right now(members and guests).

waterim · 2024-02-07T10:26:14Z

@aimane-chnaif hey, do you want me to update something additionally?
Or what is the blocker on the review?

aimane-chnaif · 2024-02-07T10:27:04Z

Let's get David's feedback again for the updated readme

waterim · 2024-02-07T12:53:40Z

@quinthar Please let us know your opinion regarding the README when you have some time.

aimane-chnaif · 2024-02-07T12:54:36Z

https://github.com/waterim/Expnesify/tree/feat-33575?tab=readme-ov-file#Security

README.md

waterim · 2024-02-08T12:25:44Z

@MonilBhavsar updated

aimane-chnaif · 2024-02-09T14:04:53Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

aimane-chnaif · 2024-02-09T14:05:21Z

I think we're still waiting on @quinthar's feedback on final readme
https://github.com/waterim/Expnesify/tree/feat-33575?tab=readme-ov-file#Security

README.md

waterim · 2024-02-13T11:14:25Z

@aimane-chnaif @quinthar approved updated security section: https://expensify.slack.com/archives/C0671JDRKQW/p1707794023284829?thread_ts=1703547187.140519&cid=C0671JDRKQW

README.md

OSBotify · 2024-02-13T12:37:55Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-02-15T05:23:40Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.41-12 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

security page, links

acb9b63

waterim changed the title ~~Feature: enw security page, links, tests~~ Feature: new security page, links, tests Jan 23, 2024

waterim changed the title ~~Feature: new security page, links, tests~~ Feature: new security section, links, tests Jan 23, 2024

waterim changed the title ~~Feature: new security section, links, tests~~ Feature: new security section, links Jan 26, 2024

waterim marked this pull request as ready for review January 29, 2024 15:58

waterim requested a review from a team as a code owner January 29, 2024 15:58

melvin-bot bot requested review from aimane-chnaif and removed request for a team January 29, 2024 15:58

waterim added 3 commits January 29, 2024 18:15

update doc

1fd5c8f

update workspace room doc

b4ebc80

updated workspace rules

d51ac98

aimane-chnaif mentioned this pull request Feb 2, 2024

[$500] HIGH: Review who can remove whom from groups, workspaces, and workspace objects #33575

Closed

13 tasks

MonilBhavsar assigned waterim Feb 2, 2024

aimane-chnaif reviewed Feb 5, 2024

View reviewed changes

updated workspace room

c1955e5

waterim added 2 commits February 5, 2024 17:06

Merge remote-tracking branch 'upstream/main' into feat-33575

3d510ac

updated security section text

443ddec

MonilBhavsar reviewed Feb 8, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

updated security section

78d8eef

waterim added 2 commits February 12, 2024 15:29

Merge remote-tracking branch 'upstream/main' into feat-33575

be11084

updated security page

ce443d0

aimane-chnaif approved these changes Feb 13, 2024

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar February 13, 2024 03:18

MonilBhavsar reviewed Feb 13, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

updated

9db2e51

MonilBhavsar reviewed Feb 13, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

fix

c2a7cba

MonilBhavsar approved these changes Feb 13, 2024

View reviewed changes

MonilBhavsar merged commit fb69cc1 into Expensify:main Feb 13, 2024
15 checks passed

github-actions bot mentioned this pull request Feb 13, 2024

Deploy Checklist: New Expensify 2024-02-13 #36429

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: new security section, links #34987

Feature: new security section, links #34987

waterim commented Jan 23, 2024 •

edited by MonilBhavsar

Loading

waterim commented Jan 28, 2024

melvin-bot bot commented Jan 29, 2024

aimane-chnaif Feb 5, 2024

waterim Feb 5, 2024

waterim Feb 5, 2024

aimane-chnaif commented Feb 5, 2024 •

edited

Loading

waterim commented Feb 5, 2024

aimane-chnaif commented Feb 5, 2024 •

edited

Loading

waterim commented Feb 5, 2024

waterim commented Feb 5, 2024

aimane-chnaif commented Feb 5, 2024

waterim commented Feb 5, 2024

waterim commented Feb 7, 2024

aimane-chnaif commented Feb 7, 2024

waterim commented Feb 7, 2024 •

edited

Loading

aimane-chnaif commented Feb 7, 2024

waterim commented Feb 8, 2024

aimane-chnaif commented Feb 9, 2024

aimane-chnaif commented Feb 9, 2024

waterim commented Feb 13, 2024

OSBotify commented Feb 13, 2024

OSBotify commented Feb 15, 2024

Feature: new security section, links #34987

Feature: new security section, links #34987

Conversation

waterim commented Jan 23, 2024 • edited by MonilBhavsar Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

waterim commented Jan 28, 2024

melvin-bot bot commented Jan 29, 2024

aimane-chnaif Feb 5, 2024

Choose a reason for hiding this comment

waterim Feb 5, 2024

Choose a reason for hiding this comment

waterim Feb 5, 2024

Choose a reason for hiding this comment

aimane-chnaif commented Feb 5, 2024 • edited Loading

waterim commented Feb 5, 2024

aimane-chnaif commented Feb 5, 2024 • edited Loading

waterim commented Feb 5, 2024

waterim commented Feb 5, 2024

aimane-chnaif commented Feb 5, 2024

waterim commented Feb 5, 2024

waterim commented Feb 7, 2024

aimane-chnaif commented Feb 7, 2024

waterim commented Feb 7, 2024 • edited Loading

aimane-chnaif commented Feb 7, 2024

waterim commented Feb 8, 2024

aimane-chnaif commented Feb 9, 2024

Reviewer Checklist

Screenshots/Videos

aimane-chnaif commented Feb 9, 2024

waterim commented Feb 13, 2024

OSBotify commented Feb 13, 2024

OSBotify commented Feb 15, 2024

waterim commented Jan 23, 2024 •

edited by MonilBhavsar

Loading

aimane-chnaif commented Feb 5, 2024 •

edited

Loading

aimane-chnaif commented Feb 5, 2024 •

edited

Loading

waterim commented Feb 7, 2024 •

edited

Loading