[No QA][TS migration] Migrate remaining GitHub actions to TypeScript #38576

JKobrynski · 2024-03-19T12:39:07Z

Details

Fixed Issues

$ #38537
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

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: 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 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 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.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 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.
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.

.github/actions/javascript/getGraphiteString/getGraphiteString.ts

.github/actions/javascript/getArtifactInfo/getArtifactInfo.ts

fabioh8010 · 2024-03-20T09:08:49Z

.github/actions/javascript/getArtifactInfo/getArtifactInfo.ts

-const run = function () {
+type OctokitArtifact = OctokitComponents['schemas']['artifact'];
+
+const run = function (): Promise<OctokitArtifact | void> {


Suggested change

const run = function (): Promise<OctokitArtifact | void> {

const run = function (): Promise<void> {

fabioh8010 · 2024-03-20T09:08:58Z

.github/actions/javascript/getArtifactInfo/getArtifactInfo.ts

            console.error('A problem occurred while trying to communicate with the GitHub API', error);
            core.setFailed(error);
-        });
+        }) as Promise<OctokitArtifact | void>;


Suggested change

}) as Promise<OctokitArtifact | void>;

}) as Promise<void>;

BartoszGrajdek

LGTM! 😄

melvin-bot · 2024-03-22T16:00:50Z

@cubuspl42 @puneetlath One of you needs to 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]

puneetlath

I'm not super familiar with our GH actions, so left a comment to understand better. Also, is there any way for us to test these changes?

puneetlath · 2024-03-22T16:03:57Z

.github/actions/javascript/getArtifactInfo/index.js

@@ -16000,7 +16024,7 @@ module.exports = JSON.parse('[[[0,44],"disallowed_STD3_valid"],[[45,46],"valid"]
 /******/ 	// startup
 /******/ 	// Load entry module and return exports
 /******/ 	// This entry module is referenced by other modules so it can't be inlined
-/******/ 	var __webpack_exports__ = __nccwpck_require__(1307);
+/******/ 	var __webpack_exports__ = __nccwpck_require__(7750);


Sorry for my ignorance. Can you explain to me why this changed?

This file is auto-generated so I don't know the exact reason behind that change, but my guess is this might be due to module.exports changing to export default. Wdyt?

cubuspl42 · 2024-03-25T15:18:14Z

.github/actions/javascript/getArtifactInfo/getArtifactInfo.ts

    const artifactName = core.getInput('ARTIFACT_NAME', {required: true});

+    // TODO: remove type casting once GithubUtils (https://github.com/Expensify/App/pull/38280) is migrated to TypeScript


Can't we define our own typings for GithubUtils in the meanwhile?

Not sure what you mean, could you provide more details? 🙏

Are you familiar with ambient typings and .d.ts files?

In general, typings can be provided by any party. Either the original third-party library itself (let's say foo), another third-party library (like @types/foo), or the project that depends on foo itself.

I'm not sure if there's any difficulty with using ambient typings with GitHub actions specifically, I only used them in "typical" TypeScript projects, but I would assume it's possible.

We can give up if this becomes too time-consuming, but I'd give it a try.

Sure, I did it for some other modules, great idea! Actually GithubUtils PR got merged a couple hours ago so the problem is not valid anymore!

fabioh8010 · 2024-03-26T07:10:18Z

@JKobrynski bump

JKobrynski · 2024-03-27T10:24:36Z

@cubuspl42 @puneetlath PR updated!

puneetlath · 2024-03-27T16:12:32Z

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 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 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.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(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.
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

OSBotify · 2024-03-27T16:20:07Z

✋ 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-03-29T02:27:14Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.4.58-0 🚀

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

OSBotify · 2024-04-02T11:03:30Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.58-8 🚀

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

JKobrynski added 2 commits March 19, 2024 13:37

migrate getGraphiteString and getArtifactInfo to TypeScript

b11482b

update file extension in buildActions.sh

a7dba17

VickyStash reviewed Mar 19, 2024

View reviewed changes

.github/actions/javascript/getGraphiteString/getGraphiteString.ts Outdated Show resolved Hide resolved

.github/actions/javascript/getArtifactInfo/getArtifactInfo.ts Outdated Show resolved Hide resolved

JKobrynski added 2 commits March 19, 2024 15:44

apply suggested changes

7fd4d91

add todo comment

394f9df

JKobrynski requested a review from VickyStash March 19, 2024 14:49

Merge branch 'main' into migrateGroup30ToTypeScript

31e8c49

fabioh8010 reviewed Mar 20, 2024

View reviewed changes

update type casting in getArtifactInfo

16e5c0c

JKobrynski requested a review from fabioh8010 March 20, 2024 14:00

fabioh8010 approved these changes Mar 20, 2024

View reviewed changes

BartoszGrajdek approved these changes Mar 22, 2024

View reviewed changes

JKobrynski marked this pull request as ready for review March 22, 2024 16:00

JKobrynski requested a review from a team as a code owner March 22, 2024 16:00

melvin-bot bot requested review from cubuspl42 and removed request for a team and VickyStash March 22, 2024 16:00

melvin-bot bot requested a review from puneetlath March 22, 2024 16:00

JKobrynski mentioned this pull request Mar 22, 2024

[HOLD for payment 2024-04-09] [TS migration] Migrate remaining GitHub actions to TypeScript #38537

Closed

puneetlath requested changes Mar 22, 2024

View reviewed changes

cubuspl42 reviewed Mar 25, 2024

View reviewed changes

JKobrynski requested review from puneetlath and cubuspl42 March 26, 2024 10:41

JKobrynski added 5 commits March 26, 2024 13:29

Merge branch 'main' into migrateGroup30ToTypeScript

7648e0a

fix mocks import in test files

97fa360

Merge branch 'main' into migrateGroup30ToTypeScript

8d36a59

Merge branch 'main' into migrateGroup30ToTypeScript

3d32646

remove type castings related to GitHubUtils

81e823f

cubuspl42 approved these changes Mar 27, 2024

View reviewed changes

puneetlath approved these changes Mar 27, 2024

View reviewed changes

puneetlath merged commit d0a78c8 into Expensify:main Mar 27, 2024
17 of 20 checks passed

github-actions bot mentioned this pull request Mar 29, 2024

Deploy Checklist: New Expensify 2024-03-29 #39222

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA][TS migration] Migrate remaining GitHub actions to TypeScript #38576

[No QA][TS migration] Migrate remaining GitHub actions to TypeScript #38576

JKobrynski commented Mar 19, 2024 •

edited

Loading

fabioh8010 Mar 20, 2024

JKobrynski Mar 20, 2024

fabioh8010 Mar 20, 2024

JKobrynski Mar 20, 2024

BartoszGrajdek left a comment

melvin-bot bot commented Mar 22, 2024

puneetlath left a comment

puneetlath Mar 22, 2024

JKobrynski Mar 26, 2024

puneetlath Mar 27, 2024

cubuspl42 Mar 25, 2024

JKobrynski Mar 26, 2024

cubuspl42 Mar 27, 2024

JKobrynski Mar 27, 2024

fabioh8010 commented Mar 26, 2024

JKobrynski commented Mar 27, 2024

puneetlath commented Mar 27, 2024 •

edited

Loading

OSBotify commented Mar 27, 2024

OSBotify commented Mar 29, 2024

OSBotify commented Apr 2, 2024

	const run = function (): Promise<OctokitArtifact \| void> {
	const run = function (): Promise<void> {

		const artifactName = core.getInput('ARTIFACT_NAME', {required: true});

		// TODO: remove type casting once GithubUtils (https://github.com/Expensify/App/pull/38280) is migrated to TypeScript

[No QA][TS migration] Migrate remaining GitHub actions to TypeScript #38576

[No QA][TS migration] Migrate remaining GitHub actions to TypeScript #38576

Conversation

JKobrynski commented Mar 19, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BartoszGrajdek left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Mar 22, 2024

puneetlath left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabioh8010 commented Mar 26, 2024

JKobrynski commented Mar 27, 2024

puneetlath commented Mar 27, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Mar 27, 2024

OSBotify commented Mar 29, 2024

OSBotify commented Apr 2, 2024

JKobrynski commented Mar 19, 2024 •

edited

Loading

puneetlath commented Mar 27, 2024 •

edited

Loading