[No QA] Fix workflow warning about changed native files #55518

jnowakow · 2025-01-21T11:33:46Z

Explanation of Change

This is fix for lately introduced workflow which is right now failing.

Fixed Issues

No issue created
PROPOSAL:

Tests

Workflow will run on any PR that has native files changed. For manual testing one can rerun workflow for example on this PR

Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

Verify that no errors appear in the JS console

Make App PR with changes to native code
Ensure the comment with warning is added
Push another commit with native code changes to the pr
Make sure the commit is not duplicated

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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.ts 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 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(theme.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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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.
I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
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.

Screenshots/Videos

Android: Native

N/A

Android: mWeb Chrome

N/A

iOS: Native

N/A

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

N/A

MacOS: Desktop

N/A

melvin-bot · 2025-01-21T11:34:17Z

@neil-marcellini 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]

mountiny · 2025-01-21T12:27:14Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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.ts 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(theme.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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

mountiny

Thanks for follow ing, please add testing steps to the PR and we can confirm here #55518 that the fix worked

mountiny · 2025-01-21T15:03:38Z

I have updated the qa steps

mountiny · 2025-01-21T18:47:59Z

Marking this as WIP as we agreed that we are going to add a duplication check - the comments should not keep posting on the same PR with each commit changing the native files

…orkflow

…m:software-mansion-labs/expensify-app-fork into jnowakow/fix-native-file-comment-workflow

jnowakow · 2025-01-24T09:35:51Z

@mountiny I've added check for comment. I had to change trigger to pull_request_target because with pull_request GH cli doesn't have permissions to post comments.

mountiny · 2025-01-24T15:25:10Z

All yours @neil-marcellini

mountiny · 2025-01-24T15:25:25Z

.github/workflows/commentOnNativeFileChanged.yml

+
+

maybe unnecessary lines but NAB

AndrewGable · 2025-01-24T15:48:32Z

.github/workflows/commentOnNativeFileChanged.yml

@@ -1,7 +1,7 @@
 name: Comment on native files changed

 on:
-  pull_request:
+  pull_request_target:


I don't love pull_request_target, it has special rules and we should double check them here: https://github.com/Expensify/App/blob/main/.github/workflows/README.md#security-rules-

Also - I wonder if we can remove this workflow with this upcoming PR: #55328

Hmm that is good point, we might not need this so much with the workflow in the linked PR

Yeah, it seems that this workflow won't have sense if the #55328 is merged

mountiny · 2025-01-27T17:18:25Z

Lets close this then and focus on the #55328

mountiny · 2025-01-27T22:24:14Z

closing in favour off #55328

Fix workflow warining about changed native files

1c6203b

jnowakow requested a review from a team as a code owner January 21, 2025 11:33

melvin-bot bot requested a review from neil-marcellini January 21, 2025 11:34

melvin-bot bot removed the request for review from a team January 21, 2025 11:34

mountiny changed the title ~~Fix workflow warining about changed native files~~ Fix workflow warning about changed native files Jan 21, 2025

mountiny assigned jnowakow Jan 21, 2025

mountiny previously approved these changes Jan 21, 2025

View reviewed changes

mountiny added the InternalQA This pull request required internal QA label Jan 21, 2025

jnowakow changed the title ~~Fix workflow warning about changed native files~~ [No QA] Fix workflow warning about changed native files Jan 21, 2025

jnowakow dismissed mountiny’s stale review via 84bdf11 January 21, 2025 12:34

Change trigger

02e1044

jnowakow force-pushed the jnowakow/fix-native-file-comment-workflow branch 2 times, most recently from 6e2af41 to 02e1044 Compare January 21, 2025 13:59

mountiny changed the title ~~[No QA] Fix workflow warning about changed native files~~ [WIP] [No QA] Fix workflow warning about changed native files Jan 21, 2025

neil-marcellini marked this pull request as draft January 21, 2025 18:51

Merge branch 'Expensify:main' into jnowakow/fix-native-file-comment-w…

50a24cd

…orkflow

jnowakow mentioned this pull request Jan 24, 2025

[No QA] Create workflow to warn on native file changes #54357

Merged

50 tasks

jnowakow added 4 commits January 24, 2025 09:15

Specify --repo param instead checkout

c656515

Trigger workflow

033b714

Merge branch 'jnowakow/fix-native-file-comment-workflow' of github.co…

cb3d682

…m:software-mansion-labs/expensify-app-fork into jnowakow/fix-native-file-comment-workflow

Change trigger

68aad6d

jnowakow force-pushed the jnowakow/fix-native-file-comment-workflow branch from 9da99fd to 68aad6d Compare January 24, 2025 08:37

jnowakow added 3 commits January 24, 2025 10:29

Check if comment already exist

3ad5b7c

Change target

af7b578

Revert dummy commit

98098cc

jnowakow marked this pull request as ready for review January 24, 2025 09:33

mountiny changed the title ~~[WIP] [No QA] Fix workflow warning about changed native files~~ [No QA] Fix workflow warning about changed native files Jan 24, 2025

mountiny approved these changes Jan 24, 2025

View reviewed changes

mountiny reviewed Jan 24, 2025

View reviewed changes

.github/workflows/commentOnNativeFileChanged.yml

Comment on lines +39 to +40

Copy link

Contributor

mountiny Jan 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe unnecessary lines but NAB

AndrewGable reviewed Jan 24, 2025

View reviewed changes

mountiny closed this Jan 27, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Fix workflow warning about changed native files #55518

[No QA] Fix workflow warning about changed native files #55518

jnowakow commented Jan 21, 2025 •

edited by mountiny

Loading

melvin-bot bot commented Jan 21, 2025

mountiny commented Jan 21, 2025 •

edited

Loading

mountiny left a comment

mountiny commented Jan 21, 2025

mountiny commented Jan 21, 2025

jnowakow commented Jan 24, 2025

mountiny commented Jan 24, 2025

mountiny Jan 24, 2025

AndrewGable Jan 24, 2025

AndrewGable Jan 24, 2025

mountiny Jan 24, 2025

jnowakow Jan 27, 2025

mountiny commented Jan 27, 2025

mountiny commented Jan 27, 2025

[No QA] Fix workflow warning about changed native files #55518

[No QA] Fix workflow warning about changed native files #55518

Conversation

jnowakow commented Jan 21, 2025 • edited by mountiny Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jan 21, 2025

mountiny commented Jan 21, 2025 • edited Loading

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

mountiny commented Jan 21, 2025

mountiny commented Jan 21, 2025

jnowakow commented Jan 24, 2025

mountiny commented Jan 24, 2025

mountiny Jan 24, 2025

Choose a reason for hiding this comment

AndrewGable Jan 24, 2025

Choose a reason for hiding this comment

AndrewGable Jan 24, 2025

Choose a reason for hiding this comment

mountiny Jan 24, 2025

Choose a reason for hiding this comment

jnowakow Jan 27, 2025

Choose a reason for hiding this comment

mountiny commented Jan 27, 2025

mountiny commented Jan 27, 2025

jnowakow commented Jan 21, 2025 •

edited by mountiny

Loading

mountiny commented Jan 21, 2025 •

edited

Loading