Tugboat Next.js server can be restarted via Composer command #17400

alexfinnarn · 2024-03-04T20:00:41Z

Description

closes #17209 by adding commands to restart the next server after changing git branches.

Testing done

Tested on Tugboat with a test branch that makes the next-build footer red and switched between that branch and others.

Screenshots

test-red-footer branch on Tugboat

QA steps

Check that the preview server still works by going to the Tugboat URL for next, like https://next-suer27t71oqpgngyx21sblb9hukdweph.ci.cms.va.gov/.
- Validate that the homepage loads and the footer is the typical "VA blue" or whatever they call it.
- Validate any tricky parts of next-build, if you know them. I am not aware of typical smoke tests.
Log into the CMS and head to "/admin/content/deploy/next".
Fill out and submit the next server restart form with test-red-footer branch for next-build version and something else for the vets-website version.
Wait a few seconds and refresh. Refresh again if the form fields are not disabled and the build has not started.
- Validate that the form fields are disabled during the build.
- Validate that the next-build.txt file link leads to a log file with data in it. The log should grow every time you refresh and end with ==> Done.
Refresh the tab on "/admin/content/deploy/next".
- Validate that the form fields are no longer disabled.
Navigate back to the next preview server, a URL like https://next-suer27t71oqpgngyx21sblb9hukdweph.ci.cms.va.gov/.
- Validate that the homepage loads and the footer is now bright red.
- Validate any tricky parts of next-build, if you know them. I am not aware of typical smoke tests.
(Bonus Points) For a real parlor trick, you can navigate back to "/admin/content/deploy/next" and choose a different next-build branch to restart the server with. You'd have to create another PR in next-build with noticeable changes, but just reporting that users should be able to keep rebuilding the same Tugboat preview with various branches, even if most will only choose a branch one time.

Note: This PR, department-of-veterans-affairs/next-build#451, should be deleted after testing.

Definition of Done

Documentation has been updated, if applicable.
Tests have been added if necessary.
Automated tests have passed.
Code Quality Tests have passed.
Acceptance Criteria in related issue are met.
Manual Code Review Approved.
If there are field changes, front end output has been thoroughly checked.

Select Team for PR review

This reverts commit dfc8eec.

Co-authored-by: Tim Cosgrove <[email protected]>

alexfinnarn · 2024-03-13T16:33:11Z

scripts/next-install.sh

-#pushd "./next"
-yarn install
-#popd
+# @todo Should the manual steps go here like copying the .env file? or maybe in next-start.sh?


I need to delete this comment but don't want to rebuild Tugboat before a review.

alexfinnarn · 2024-03-13T16:34:36Z

scripts/next-start.sh


 # Start the dev server. Vets-website assets need to be in place prior to this build.
-APP_ENV=tugboat yarn start
+# Need to start in the background so the script can exit.
+APP_ENV=${APP_ENV} yarn start &> /dev/null &


I am unsure if running in the background is needed but I think the script paused and didn't continue. However, output isn't logged this way so might need adjusting to get output in logs if desired.

github-actions · 2024-09-18T02:11:42Z

docroot/modules/custom/va_gov_content_release/src/Form/NextGitForm.php

+  ) {
+    $selectionName = $frontend->getRawValue() . '_selection';
+    if ($form_state->getValue($selectionName) === 'default') {
+      $this->resetFrontendVersion($frontend, $form_state);


[PHPStan] _{reported by reviewdog 🐶}
Method Drupal\va_gov_content_release\Form\NextGitForm::resetFrontendVersion() invoked with 2 parameters, 1 required.

github-actions · 2024-09-18T02:11:42Z

...ot/modules/custom/va_gov_content_release/src/FrontendVersionSearch/FrontendVersionSearch.php

+      case $frontend->isNextBuild():
+        return $this->nbBranchSearch;
+
+      case $frontend->isNextVetsWebsite():


[PHPStan] _{reported by reviewdog 🐶}
Call to an undefined method Drupal\va_gov_content_release\Frontend\FrontendInterface::isNextVetsWebsite().

github-actions · 2024-09-18T02:11:42Z

...ot/modules/custom/va_gov_content_release/src/FrontendVersionSearch/FrontendVersionSearch.php

+      case $frontend->isNextBuild():
+        return $this->nbApiClient;
+
+      case $frontend->isNextVetsWebsite():


[PHPStan] _{reported by reviewdog 🐶}
Call to an undefined method Drupal\va_gov_content_release\Frontend\FrontendInterface::isNextVetsWebsite().

github-actions · 2024-09-18T02:11:43Z

docroot/modules/custom/va_gov_content_release/src/Form/NextGitForm.php

+    FrontendVersionInterface $frontendVersion,
+    FileSystemInterface $fileSystem,
+    ConfigFactory $config,
+    State $state


🚫 [PHP_CodeSniffer] <Drupal.Functions.MultiLineFunctionDeclaration.MissingTrailingComma> _{reported by reviewdog 🐶}
Multi-line function declarations must have a trailing comma after the last parameter

github-actions · 2024-09-18T02:11:44Z

docroot/modules/custom/va_gov_content_release/src/Form/NextGitForm.php

+   */
+  protected function submitFormForFrontend(
+    FrontendInterface $frontend,
+    FormStateInterface $form_state


🚫 [PHP_CodeSniffer] <Drupal.Functions.MultiLineFunctionDeclaration.MissingTrailingComma> _{reported by reviewdog 🐶}
Multi-line function declarations must have a trailing comma after the last parameter

github-actions · 2024-09-18T02:11:44Z

docroot/modules/custom/va_gov_content_release/src/Form/NextGitForm.php

+   */
+  protected function validateFormForFrontend(
+    FrontendInterface $frontend,
+    FormStateInterface $form_state


🚫 [PHP_CodeSniffer] <Drupal.Functions.MultiLineFunctionDeclaration.MissingTrailingComma> _{reported by reviewdog 🐶}
Multi-line function declarations must have a trailing comma after the last parameter

github-actions · 2024-09-18T02:11:44Z

docroot/modules/custom/va_gov_content_release/src/Form/NextGitForm.php

+   */
+  public function setFrontendVersion(
+    FrontendInterface $frontend,
+    FormStateInterface $form_state


🚫 [PHP_CodeSniffer] <Drupal.Functions.MultiLineFunctionDeclaration.MissingTrailingComma> _{reported by reviewdog 🐶}
Multi-line function declarations must have a trailing comma after the last parameter

github-actions · 2024-09-18T02:11:44Z

docroot/modules/custom/va_gov_content_release/src/Form/NextGitForm.php

+   */
+  public function getGitRef(
+    FrontendInterface $frontend,
+    FormStateInterface $form_state


🚫 [PHP_CodeSniffer] <Drupal.Functions.MultiLineFunctionDeclaration.MissingTrailingComma> _{reported by reviewdog 🐶}
Multi-line function declarations must have a trailing comma after the last parameter

alexfinnarn and others added 17 commits February 19, 2024 13:13

Reapply "VACMS-16853: next build branches ftw (#17154)" (#17261)

29593bd

This reverts commit dfc8eec.

Update READMES/cms-content-release.md

8c68896

Co-authored-by: Tim Cosgrove <[email protected]>

Update READMES/cms-content-release.md

a6440b8

Co-authored-by: Tim Cosgrove <[email protected]>

Apply suggestions from code review

906b8ae

Co-authored-by: Tim Cosgrove <[email protected]>

add separate frontend for next-vets-website

005f6fc

Merge branch 'main' into VACMS-16853-next-build-branches-ftw-d

a1db72c

change key used for next-vets-website repo

55e3c58

try cloning vets-website a different way to have more git informaiton

f723624

adjust unit test

49d14f6

Merge branch 'main' into VACMS-16853-next-build-branches-ftw-d

80a705a

adjust code after adjusting unit test

5bc83b2

Merge branch 'main' into VACMS-16853-next-build-branches-ftw-d

b2f9935

add stash and pop to next build frontend script

daa4ac9

Merge branch 'main' into VACMS-16853-next-build-branches-ftw-d

8e304c7

Merge branch 'main' into VACMS-16853-next-build-branches-ftw-d

c5589e8

update links on next content release form

c4d1356

restart next server in start command

e429472

va-cms-bot temporarily deployed to Tugboat March 4, 2024 20:00 Destroyed

github-actions bot added Accelerated Publishing CMS Team CMS Product team that manages both editor exp and devops labels Mar 4, 2024

va-cms-bot temporarily deployed to Tugboat March 5, 2024 17:40 Destroyed

va-cms-bot temporarily deployed to Tugboat March 5, 2024 19:25 Destroyed

update scripts

7b401d8

va-cms-bot had a problem deploying to Tugboat March 6, 2024 17:47 Error

Merge branch 'main' into VACMS-17209-restart-next-server

6b61b51

va-cms-bot temporarily deployed to Tugboat March 6, 2024 17:47 Destroyed

update scripts

9e4e810

va-cms-bot had a problem deploying to Tugboat March 7, 2024 21:01 Error

Merge branch 'main' into VACMS-17209-restart-next-server

4a75fc2

va-cms-bot temporarily deployed to Tugboat March 7, 2024 21:01 Destroyed

va-cms-bot had a problem deploying to Tugboat March 11, 2024 15:03 Error

Merge branch 'main' into VACMS-17209-restart-next-server

e319374

va-cms-bot temporarily deployed to Tugboat March 11, 2024 15:04 Destroyed

take out the debugging now that I know the server starts

733a034

va-cms-bot temporarily deployed to Tugboat March 11, 2024 17:37 Destroyed

Merge branch 'main' into VACMS-17209-restart-next-server

2e6c92f

va-cms-bot temporarily deployed to Tugboat March 11, 2024 17:39 Destroyed

va-cms-bot temporarily deployed to Tugboat March 11, 2024 23:23 Destroyed

try killing more process types

225390f

va-cms-bot temporarily deployed to Tugboat March 12, 2024 13:03 Destroyed

Merge branch 'main' into VACMS-17209-restart-next-server

5292ee1

va-cms-bot had a problem deploying to Tugboat March 12, 2024 14:57 Error

remove Tugboat steps to make build faster

8488432

va-cms-bot temporarily deployed to Tugboat March 12, 2024 14:59 Destroyed

debug

60b8e70

va-cms-bot temporarily deployed to Tugboat March 12, 2024 15:43 Destroyed

alexfinnarn added 2 commits March 13, 2024 09:06

add env vars script and set to execute script files

241b7ab

DRY env vars

1bd3741

va-cms-bot temporarily deployed to Tugboat March 13, 2024 13:13 Destroyed

alexfinnarn commented Mar 13, 2024

View reviewed changes

Merge main and bring up to date.

c27a2c7

github-actions bot reviewed Sep 18, 2024

View reviewed changes

va-cms-bot temporarily deployed to Tugboat September 18, 2024 02:38 Destroyed

Update Next Build on Tugboat to use proper node version for all scripts.

acc1805

va-cms-bot temporarily deployed to Tugboat September 18, 2024 22:21 Destroyed

va-cms-bot had a problem deploying to Tugboat September 23, 2024 18:38 Error

timcosgrove mentioned this pull request Sep 23, 2024

Make sure next-build uses node v18 everywhere. #19298

Closed

25 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tugboat Next.js server can be restarted via Composer command #17400

Tugboat Next.js server can be restarted via Composer command #17400

alexfinnarn commented Mar 4, 2024 •

edited

Loading

alexfinnarn Mar 13, 2024

alexfinnarn Mar 13, 2024

github-actions bot Sep 18, 2024

github-actions bot Sep 18, 2024

github-actions bot Sep 18, 2024

github-actions bot Sep 18, 2024

github-actions bot Sep 18, 2024

github-actions bot Sep 18, 2024

github-actions bot Sep 18, 2024

github-actions bot Sep 18, 2024

Tugboat Next.js server can be restarted via Composer command #17400

Are you sure you want to change the base?

Tugboat Next.js server can be restarted via Composer command #17400

Conversation

alexfinnarn commented Mar 4, 2024 • edited Loading

Description

Testing done

Screenshots

QA steps

Definition of Done

Select Team for PR review

alexfinnarn Mar 13, 2024

Choose a reason for hiding this comment

alexfinnarn Mar 13, 2024

Choose a reason for hiding this comment

github-actions bot Sep 18, 2024

Choose a reason for hiding this comment

github-actions bot Sep 18, 2024

Choose a reason for hiding this comment

github-actions bot Sep 18, 2024

Choose a reason for hiding this comment

github-actions bot Sep 18, 2024

Choose a reason for hiding this comment

github-actions bot Sep 18, 2024

Choose a reason for hiding this comment

github-actions bot Sep 18, 2024

Choose a reason for hiding this comment

github-actions bot Sep 18, 2024

Choose a reason for hiding this comment

github-actions bot Sep 18, 2024

Choose a reason for hiding this comment

alexfinnarn commented Mar 4, 2024 •

edited

Loading