Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[No QA] [TS migration] Migrate 'Config' files to TypeScript #37718

Merged
merged 57 commits into from
Mar 29, 2024

Conversation

JKobrynski
Copy link
Contributor

@JKobrynski JKobrynski commented Mar 5, 2024

Details

Fixed Issues

$ #25331
PROPOSAL: N/A

Tests

  1. Remove --publish always from the last line of build-desktop.sh
  2. Run:
  • npm run build
  • npm run build-staging
  • npm run build-adhoc
  • npm run web
  • npm run desktop-build
  • npm run desktop

Make sure the app builds with no errors, check if both desktop and web app are running correctly.

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

config/webpack/CustomVersionFilePlugin.ts Outdated Show resolved Hide resolved
config/webpack/webpack.dev.ts Outdated Show resolved Hide resolved
config/webpack/CustomVersionFilePlugin.ts Outdated Show resolved Hide resolved
config/webpack/CustomVersionFilePlugin.ts Outdated Show resolved Hide resolved
config/webpack/webpack.common.ts Show resolved Hide resolved
config/webpack/webpack.desktop.ts Show resolved Hide resolved
package.json Show resolved Hide resolved
scripts/build-desktop.sh Outdated Show resolved Hide resolved
tsconfig.json Outdated Show resolved Hide resolved
@JKobrynski
Copy link
Contributor Author

@cead22 made updates!

@JKobrynski JKobrynski requested a review from cead22 March 26, 2024 08:49
cead22
cead22 previously approved these changes Mar 26, 2024
@@ -30,7 +30,7 @@ title "Bundling Desktop js Bundle Using Webpack"
info " • ELECTRON_ENV: $ELECTRON_ENV"
info " • ENV file: $ENV_FILE"
info ""
npx webpack --config config/webpack/webpack.desktop.js --env envFile=$ENV_FILE
npx webpack --config config/webpack/webpack.desktop.ts --env file=$ENV_FILE
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB, but should we consider updating ENV everywhere here to ENVIRONMENT?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's up to you, let me know what you'd like to do. I didn't think of it

Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should update it

// eslint-disable-next-line @dword-design/import-alias/prefer-alias, import/no-relative-packages -- alias imports don't work for webpack
import {dependencies as desktopDependencies} from '../../desktop/package.json';
import type Environment from './types';
import getCommonConfig from './webpack.common';
Copy link
Contributor

Choose a reason for hiding this comment

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

Mentioning this again since you 👍 'd even though I said it's NAB. Are we updating all the configs to configurations or not? Just curious
image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm going to change it, thanks

import CustomVersionFilePlugin from './CustomVersionFilePlugin';
import type Environment from './types';

// require is necessary, there are no types for this package and the declaration file can't be seen by the build process which causes an error.
Copy link
Contributor

Choose a reason for hiding this comment

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

💚

production: '',
staging: '-stg',
dev: '-dev',
adhoc: '-adhoc',
};

function mapEnvToLogoSuffix(envFile) {
function mapEnvToLogoSuffix(envFile: string): string {
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB but envFile => environmentFile. Let's do this for all the truncated variable names in these files (like env below too)

@JKobrynski
Copy link
Contributor Author

@cead22 made updates!

@JKobrynski JKobrynski requested a review from cead22 March 27, 2024 09:46
Copy link
Contributor

@cead22 cead22 left a comment

Choose a reason for hiding this comment

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

2 more small changes and we can :shipit: envFile => environmentFile and the one in the review

import type {Configuration as DevServerConfiguration} from 'webpack-dev-server';
import {merge} from 'webpack-merge';
import type Environment from './types';
import getCommonConfig from './webpack.common';
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
import getCommonConfig from './webpack.common';
import getCommonConfiguration from './webpack.common';

@JKobrynski
Copy link
Contributor Author

@cead22 PR updated again!

@JKobrynski JKobrynski requested a review from cead22 March 28, 2024 08:06
@@ -31,20 +31,19 @@ switch (process.env.ENV) {
}

const env = dotenv.config({path: path.resolve(__dirname, `../${envFile}`)});
const custom = require('../config/webpack/webpack.common').default({
const custom: CustomWebpackConfig = require('../config/webpack/webpack.common')({
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
const custom: CustomWebpackConfig = require('../config/webpack/webpack.common')({
const custom: CustomWebpackConfig = require('../config/webpack/webpack.common').default({

...custom.resolve.alias,
};
const webpackConfig = ({config}: {config: Configuration}) => {
if (config.resolve && config.plugins && config.module) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Even if any of the config prop is not set we should still set our props.

Suggested change
if (config.resolve && config.plugins && config.module) {
if (!config.resolve) {
config.resolve = {};
}
if (!config.plugins) {
config.plugins = [];
}
if (!config.module) {
config.module = {};
}

@JKobrynski
Copy link
Contributor Author

@s77rt done!

@JKobrynski JKobrynski requested a review from s77rt March 28, 2024 13:59
@cead22 cead22 merged commit 5a8cb7f into Expensify:main Mar 29, 2024
19 checks passed
@melvin-bot melvin-bot bot added the Emergency label Mar 29, 2024
Copy link

melvin-bot bot commented Mar 29, 2024

@cead22 looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@cead22 cead22 removed the Emergency label Mar 29, 2024
@cead22
Copy link
Contributor

cead22 commented Mar 29, 2024

All checks showed as passing, so I don't know why the emergency label was added. This is not an emergency change
image

@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

OSBotify commented Apr 2, 2024

🚀 Deployed to staging by https://github.com/cead22 in version: 1.4.59-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Apr 8, 2024

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.60-13 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants