Add domain verification operation views

Related issue #375492 (closed)

What does this MR do and why?

Add domain verification operation views.

The feature is under feature flag: domain_verification_operation

The haml views are copy from app/views/projects/pages_domains/. The main differences:

• Add a new project select component in create form
• UI changed(design link) and follow the new Pajamas design system
• Action link url changed
• Need add new documentation page replace the doc link

dependent MRs:

• !116641 (merged)
• !116626 (merged)

design link Figma

/cc @daveliu @qk44077907

Screenshots or screen recordings

Empty index page	Index page with domains

New domain page

Edit domain page

How to set up and validate locally

1. simulate the SaaS locally:

   export GITLAB_SIMULATE_SAAS=1

2. Upload Premium license to enable domain_verification feature

3. Enable pages in gitlab.yml:

   pages:
     enabled: true
     access_control: false
     host: example.com
     port: 80
     external_http: true
     external_https: true

4. enable domain_verification_operation feature in console:

   Feature.enable(:domain_verification_operation)

5. Change application settings in rails console:

   ApplicationSetting.current.update(pages_domain_verification_enabled: true, lets_encrypt_terms_of_service_accepted: true, 
   lets_encrypt_notification_email: "test@gitlab.com")

6. Visit domain verification page http://localhost:3000/groups/flightjs/-/settings/domain_verification

7. Click the Add Domain button.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

• I have evaluated the MR acceptance checklist for this MR.

added JiHu contribution label

Hey @zhanglinjie!

Thank you for your contribution to GitLab. Please refer to the contribution flow documentation for a quick overview of the process, and the merge request (MR) guidelines for the detailed process.

When you're ready for a first review, post @gitlab-bot ready. If you know a relevant reviewer(s) (for example, someone that was involved in a related issue), you can also assign them directly with @gitlab-bot ready @user1 @user2.

At any time, if you need help, feel free to post @gitlab-bot help or initiate a mentor session on Discord. Read more on how to get help.

You can comment @gitlab-bot label <label1> <label2> to add labels to your MR. Please see the list of allowed labels in the label command documentation.

This message was generated automatically. You're welcome to improve it.

added Community contribution workflowin dev labels

assigned to @zhanglinjie

marked this merge request as draft

changed the description

	7 Warnings
	4062e104: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines.
	c5ac0bd7: The commit subject must contain at least 3 words. For more information, take a look at our Commit message guidelines.
	c25104c9: The commit subject must contain at least 3 words. For more information, take a look at our Commit message guidelines.
	7972e5d7: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines.
	d0a2665d: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines.
	f47fb5d3: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines.
	This merge request contains deprecated components. Please consider using Pajamas components instead.

	2 Messages
	CHANGELOG missing: If you want to create a changelog entry for GitLab FOSS, add the Changelog trailer to the commit message you want to add to the changelog. If you want to create a changelog entry for GitLab EE, also add the EE: true trailer to your commit message. If this merge request doesn't need a CHANGELOG entry, feel free to ignore this message.
	This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge.

Documentation review

The following files require a review from a technical writer:

• doc/user/img/get_domain_verification_code_v16_0.png (Link to current live version)
• doc/user/img/retry_domain_verification_v16_0.png (Link to current live version)
• doc/user/enterprise_user/index.md (Link to current live version)

The review does not need to block merging this merge request. See the:

• Metadata for the *.md files that you've changed. The first few lines of each *.md file identify the stage and group most closely associated with your docs change.
• The Technical Writer assigned for that stage and group.
• Documentation workflows for information on when to assign a merge request for review.

Deprecated components

These deprecated components are in the process of being migrated. Please consider using Pajamas components instead.

• bs-callout

Reviewer roulette

Changes that require review have been detected!

Please refer to the table below for assigning reviewers and maintainers suggested by Danger in the specified category:

Category	Reviewer	Maintainer
backend	Hinam Mehra (@hmehra) (UTC+10)	Heinrich Lee Yu (@engwan) (UTC+8)
frontend	Tomas Vik (@viktomas) (UTC+2)	Vitaly Slobodin (@vitallium) (UTC+2)
test for spec/features/*	Sanad Liaquat (@sliaquat) (UTC+5)	Maintainer review is optional for test for spec/features/*

To spread load more evenly across eligible reviewers, Danger has picked a candidate for each review slot, based on their timezone. Feel free to override these selections if you think someone else would be better-suited or use the GitLab Review Workload Dashboard to find other available reviewers.

To read more on how to use the reviewer roulette, please take a look at the Engineering workflow and code review guidelines. Please consider assigning a reviewer or maintainer who is a domain expert in the area of the merge request.

Once you've decided who will review this merge request, assign them as a reviewer! Danger does not automatically notify them for you.

If needed, you can retry the danger-review job that generated this comment.

Generated by Danger

changed the description

added 1 commit

• b465571c - Add domain verification operation views

Compare with previous version

added 2 commits

• c0cf08d3 - Add domain verification operation actions
• 51dea545 - Add domain verification operation views

Compare with previous version

mentioned in merge request !115766 (closed)

mentioned in issue gitlab-jh/status-reports#214

mentioned in issue gitlab-org/quality/triage-reports#11920 (closed)

added backend frontend labels

added groupauthentication and authorization [DEPRECATED] label

added devopsmanage sectiondev labels

added featureaddition label

added typefeature label

added 941 commits

• 51dea545...af3c35ae - 939 commits from branch gitlab-org:master
• adf4664b - Add domain verification operation actions
• cd3d4de3 - Add domain verification operation views

Compare with previous version

mentioned in merge request !116641 (merged)

changed the description

changed the description

mentioned in issue gitlab-jh/status-reports#216

The instructions for testing in the description that update Let's Encrypt application settings do not work. The notification email can't include example.com per validation:

ActiveRecord::RecordInvalid: Validation failed: Lets encrypt notification email Let's Encrypt does not accept emails on example.com

Great work, @zhanglinjie

I'm in the process of reviewing !116641 (merged) but am using this MR to verify the frontend + backend together. Here are a few minor notes of things I encountered during brief testing.

More feedback on !116641 (merged) to come!

mentioned in merge request gitlab-com/www-gitlab-com!120758 (merged)

added 1 commit

• f8421689 - Add domain verification operation views

Compare with previous version

changed the description

mentioned in issue gitlab-jh/status-reports#218

mentioned in issue gitlab-jh/status-reports#220

added linked-issue label

added 4 commits

• 43a0bc50 - Update validation message
• 33bfb276 - Add shared_examples in DomainVerificationController spec
• 81daf7e2 - Update
• a3f73796 - Add domain verification operation views

Compare with previous version

changed the description

added 2617 commits

• a3f73796...45eb3133 - 2616 commits from branch gitlab-org:master
• f47fb5d3 - Add domain verification operation views

Compare with previous version

marked this merge request as ready

@gitlab-bot ready

added workflowready for review label and removed workflowin dev label

@brytannia, this Community contribution is ready for review.

• Do you have capacity and domain expertise to review this? We are mindful of your time, so if you are not able to take this on, please re-assign to one or more other reviewers.
• Add the workflowin dev label if the merge request needs action from the author.

This message was generated automatically. You're welcome to improve it.

requested review from @brytannia

requested review from @dblessing and removed review request for @brytannia

requested review from @agulina

Few minor suggestions. Angelo might have some better feedback since this is mostly frontend.

Thanks for your work, @zhanglinjie

removed review request for @agulina

@cynthia @jglassman1 We might need to update/simplify the following section in the Enterprise users docs to reflect this frontend change?

mentioned in issue gitlab-jh/status-reports#222

requested review from @jglassman1

added 3 commits

• d0a2665d - Update domain verification doc
• 7972e5d7 - Add domain verification helper
• bdd277e9 - Update domain verification doc

Compare with previous version

added Technical Writing label

added 1 commit

• 4ee07f9e - Update domain verification doc

Compare with previous version

approved this merge request

@jglassman1, thanks for approving this merge request.

This is the first time the merge request is approved. To ensure full test coverage, please start a new pipeline before merging.

For more info, please refer to the following links:

• rspec predictive jobs
• jest predictive jobs
• merging a merge request.

added pipeline:mr-approved label

removed review request for @jglassman1

@jglassman1, thanks for approving this merge request.

This is the first time the merge request has been approved. Please wait for AppSec approval before merging.

cc @gitlab-com/gl-security/appsec this is a JiHu contribution, please follow the JiHu contribution review process.

added 1 commit

• c25104c9 - Update

Compare with previous version

approved this merge request

added sec-planningcomplete label

approved this merge request

Thanks for this! A minor doc suggestion, but consider it non-blocking for merging purposes. We can always update the docs in a follow up MR.

approved this merge request

added docs-weight3 label

added 1 commit

• c5ac0bd7 - Update spec

Compare with previous version

added sec-planningpending-followup label and removed sec-planningcomplete label

rspec:undercoverage job failed, but test coverage locally is ok. Could we add pipeline:skip-undercoverage label to skip this job? @dblessing @agulina

SIMPLECOV=1 bundle exec rspec spec/presenters/pages_domain_presenter_spec.rb \
ee/spec/requests/groups/settings/domain_verification_controller_spec.rb \
ee/spec/features/groups/settings/domain_verification_spec.rb
scripts/undercoverage
#=> undercover: ✅ No coverage is missing in latest changes

approved this merge request

Hey @f_caplette,

would you have time to look at this merge request, please? Thanks!

requested review from @f_caplette

requested review from @jivanvl and removed review request for @f_caplette

changed milestone to %16.0

added 1 commit

• 4062e104 - Update domain verification views

Compare with previous version

@hsutor I believe this is the last piece needed before the comms to verify domains are sent out.

mentioned in issue gitlab-jh/status-reports#224

approved this merge request

removed review request for @jivanvl

approved this merge request

resolved all threads

added pipeline:skip-undercoverage label

enabled an automatic merge when the pipeline for 825ef92e succeeds

added documentation label

	7 Warnings
	4062e104: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines.
	c5ac0bd7: The commit subject must contain at least 3 words. For more information, take a look at our Commit message guidelines.
	c25104c9: The commit subject must contain at least 3 words. For more information, take a look at our Commit message guidelines.
	7972e5d7: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines.
	d0a2665d: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines.
	f47fb5d3: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines.
	This merge request contains deprecated components. Please consider using Pajamas components instead.

	2 Messages
	CHANGELOG missing: If you want to create a changelog entry for GitLab FOSS, add the Changelog trailer to the commit message you want to add to the changelog. If you want to create a changelog entry for GitLab EE, also add the EE: true trailer to your commit message. If this merge request doesn't need a CHANGELOG entry, feel free to ignore this message.
	This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge.

Documentation review

The following files require a review from a technical writer:

• doc/user/img/get_domain_verification_code_v16_0.png (Link to current live version)
• doc/user/img/retry_domain_verification_v16_0.png (Link to current live version)
• doc/user/enterprise_user/index.md (Link to current live version)

The review does not need to block merging this merge request. See the:

• Metadata for the *.md files that you've changed. The first few lines of each *.md file identify the stage and group most closely associated with your docs change.
• The Technical Writer assigned for that stage and group.
• Documentation workflows for information on when to assign a merge request for review.

Deprecated components

These deprecated components are in the process of being migrated. Please consider using Pajamas components instead.

• bs-callout

Reviewer roulette

Changes that require review have been detected!

Please refer to the table below for assigning reviewers and maintainers suggested by Danger in the specified category:

Category	Reviewer	Maintainer
backend	Hitesh Raghuvanshi (@hraghuvanshi) (UTC+5.5)	Heinrich Lee Yu (@engwan) (UTC+8)
frontend	Tomas Vik (@viktomas) (UTC+2)	Vitaly Slobodin (@vitallium) (UTC+2)
test for spec/features/*	Sanad Liaquat (@sliaquat) (UTC+5)	Maintainer review is optional for test for spec/features/*

To spread load more evenly across eligible reviewers, Danger has picked a candidate for each review slot, based on their timezone. Feel free to override these selections if you think someone else would be better-suited or use the GitLab Review Workload Dashboard to find other available reviewers.

To read more on how to use the reviewer roulette, please take a look at the Engineering workflow and code review guidelines. Please consider assigning a reviewer or maintainer who is a domain expert in the area of the merge request.

Once you've decided who will review this merge request, assign them as a reviewer! Danger does not automatically notify them for you.

If needed, you can retry the danger-review job that generated this comment.

Generated by Danger

Bundle size analysis [beta]

This compares changes in bundle size for entry points between the commits 73d65409 and 4062e104

Special assets

Entrypoint / Name	Size before	Size after	Diff	Diff in percent
average	4.03 MB	4.02 MB	-5.33 KB	-0.1 %
mainChunk	2.88 MB	2.88 MB	-	0.0 %

New entry points: 3

Expand

Entrypoint / Name	Size before	Size after	Diff	Diff in percent
pages.groups.settings.domain_verification.new	0 Bytes	397.27 KB	+397.27 KB	100.0 %
pages.groups.settings.domain_verification.show	0 Bytes	397.27 KB	+397.27 KB	100.0 %
pages.groups.settings.domain_verification.index	0 Bytes	255.81 KB	+255.81 KB	100.0 %

---

Please look at the full report for more details

---

Read more about how this report works.

Generated by Danger

Allure report

allure-report-publisher generated test report!

e2e-review-qa: test report for 4062e104

expand test summary

+-----------------------------------------------------------------------+
|                            suites summary                             |
+------------------+--------+--------+---------+-------+-------+--------+
|                  | passed | failed | skipped | flaky | total | result |
+------------------+--------+--------+---------+-------+-------+--------+
| Verify           | 10     | 0      | 0       | 0     | 10    | ✅     |
| Data Stores      | 22     | 0      | 0       | 0     | 22    | ✅     |
| Create           | 27     | 0      | 1       | 0     | 28    | ✅     |
| Plan             | 50     | 0      | 1       | 0     | 51    | ✅     |
| Govern           | 24     | 0      | 0       | 1     | 24    | ❗     |
| Manage           | 8      | 0      | 3       | 0     | 11    | ✅     |
| Framework sanity | 9      | 0      | 1       | 0     | 10    | ✅     |
| Monitor          | 4      | 0      | 0       | 0     | 4     | ✅     |
| Package          | 0      | 0      | 1       | 0     | 1     | ➖     |
+------------------+--------+--------+---------+-------+-------+--------+
| Total            | 154    | 0      | 7       | 1     | 161   | ❗     |
+------------------+--------+--------+---------+-------+-------+--------+

approved this merge request

added sec-planningcomplete label and removed sec-planningpending-followup label

resolved all threads

merged

@dblessing, did you forget to run a pipeline before you merged this work? Based on our code review process, if the latest pipeline was created more than 6 hours ago OR finished more than 2 hours ago, you should:

1. Ensure the merge request is not in Draft status.
2. Start a pipeline (especially important for Community contribution merge requests).
3. Set the merge request to merge when pipeline succeeds.

This is a guideline, not a rule. Please consider replying to this comment for transparency.

This message was generated automatically. You're welcome to improve it.

@zhanglinjie, how was your code review experience with this merge request? Please tell us how we can continue to iterate and improve:

1. React with a or a on this comment to describe your experience.
2. Create a new comment starting with @gitlab-bot feedback below, and leave any additional feedback you have for us in the comment.

Interested in learning more tips and tricks to solve your next challenge faster? Subscribe to the GitLab Community Newsletter for contributor-focused content and opportunities to level up.

Thanks for your help!

This message was generated automatically. You're welcome to improve it.

mentioned in commit 37a726af

added workflowstaging-canary label and removed workflowready for review label

added workflowcanary label and removed workflowstaging-canary label

added workflowstaging label and removed workflowcanary label

added workflowproduction label and removed workflowstaging label

added releasedcandidate label

mentioned in issue gitlab-jh/status-reports#226

added workflowpost-deploy-db-staging label and removed workflowproduction label

mentioned in merge request !121246 (merged)

mentioned in issue jh-upstream-report#76 (closed)