Skip to content
This repository has been archived by the owner on May 22, 2024. It is now read-only.

[terra-toolkit-docs] Update terra-functional-testing upgrade guide #648

Merged
merged 5 commits into from
May 7, 2021

Conversation

benbcai
Copy link
Contributor

@benbcai benbcai commented May 5, 2021

Summary

  • Added additional notes to the terra-functional-testing upgrade guide.
  • Moved the express-server CLI command from @cerner/terra-open-source-scripts to @cerner/terra-functional-testing so that projects that already depend on @cerner/terra-functional-testing will not need to additionally depend on @cerner/terra-open-source-scripts to use the express-server command.

Closes #638

@cerner/terra

@benbcai benbcai self-assigned this May 5, 2021
@mjhenkes mjhenkes temporarily deployed to terra-toolki-update-ter-ks3zxx May 5, 2021 19:58 Inactive
@@ -317,7 +325,13 @@ npm run start-prod
npm run start-static
```

Note: If you don't have some of these commands it is not necessary to add them. Just ensure the commands you do have are working as expected. All of the `tt-serve` commands should be updated to use webpack-dev-server or the terra express server
Note: If you don't have some of these commands it is not necessary to add them. If you changed from `tt-serve-static` to use the `express-server` command, be sure to also install the `@cerner/terra-open-source-scripts` package that provides this command. Just ensure the commands you do have are working as expected. All of the `tt-serve` commands should be updated to use webpack-dev-server or the terra express server.
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if we should split the express server out of open source scripts.. We didn't originally intend for internal teams to use that package.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Move it to terra-functional-testing?

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 think we should move it to terra-functional-testing. We also forgot to add the @cerner/terra-open-source-scripts dependency when we did the upgrade in our other projects so we would need to go back to add the dependency if we don't split 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'm onboard with moving it to terra-functional testing

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok. I'll move it as part of this PR and remove this from the doc.

@mjhenkes mjhenkes temporarily deployed to terra-toolki-update-ter-ks3zxx May 6, 2021 21:51 Inactive
benbcai added 3 commits May 6, 2021 18:05
…ra-functional-testing to eliminate the need to depend on terra-open-source-scripts to use express-server.
@mjhenkes mjhenkes temporarily deployed to terra-toolki-update-ter-ks3zxx May 6, 2021 23:37 Inactive
@@ -2,6 +2,9 @@

## Unreleased

* Removed
Copy link
Contributor

Choose a reason for hiding this comment

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

Technically non passive. Though for our uses, I'm not sure if it will affect us since for us most, if not all, packages that use the open source scripts, also use terra-functional testing.

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 searched in github for all the places that depend on @cerner/terra-open-source-scripts. There are a few but they all already also depend on @cerner/terra-functional-testing so this should continue to work for them.

@@ -7,6 +7,5 @@ module.exports = async (options) => {
site: options.site,
});

await server.createApp();
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 removed the call to createApp() because it is already being called inside start(). This is also to match AssetServerService where calling createApp() is not needed.

Copy link
Contributor

Choose a reason for hiding this comment

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

I was gonna ask about that :)

@@ -1,4 +1,4 @@
const ExpressServer = require('./ExpressServer');
const ExpressServer = require('../../express-server');
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This will now use the express-server that is currently in terra-functional-testing.

@benbcai benbcai merged commit f8b7792 into main May 7, 2021
@benbcai benbcai deleted the update-terra-functional-testing-docs branch May 7, 2021 17:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[terra-functional-testing] Update Upgrade Guide
3 participants