You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2021/12/07 20:26:12 UTC

[GitHub] [trafficcontrol] zrhoffman opened a new pull request #6410: TPv2: Improve performance of hostname regular expression

zrhoffman opened a new pull request #6410:
URL: https://github.com/apache/trafficcontrol/pull/6410


   <!--
   Thank you for contributing! Please be sure to read our contribution guidelines: https://github.com/apache/trafficcontrol/blob/master/CONTRIBUTING.md
   If this closes or relates to an existing issue, please reference it using one of the following:
   
   Closes: #ISSUE
   Related: #ISSUE
   
   If this PR fixes a security vulnerability, DO NOT submit! Instead, contact
   the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
   guidelines at https://apache.org/security regarding vulnerability disclosure.
   -->
   
   This PR fixes #6114 by improving the performance of the `VALID_HOSTNAME` regular expression.
   <!-- **^ Add meaningful description above** --><hr>
   
   ## Which Traffic Control components are affected by this PR?
   <!-- Please delete all components from this list that are NOT affected by this PR.
   Feel free to add the name of a tool or script that is affected but not on the list.
   -->
   - Traffic Portal v2
   
   ## What is the best way to verify this PR?
   <!-- Please include here ALL the steps necessary to test your PR.
   If your PR has tests (and most should), provide the steps needed to run the tests.
   If not, please provide step-by-step instructions to test the PR manually and explain why your PR does not need tests. -->
   Run the tests
   
   ## If this is a bugfix, which Traffic Control versions contained the bug?
   <!-- Delete this section if the PR is not a bugfix, or if the bug is only in the master branch.
   Examples:
   - 5.1.2
   - 5.1.3 (RC1)
    -->
   - 6.0.1
   - 5.1.4
   
   ## PR submission checklist
   - [x] This PR has tests <!-- If not, please delete this text and explain why this PR does not need tests. -->
   - [ ] This PR has documentation <!-- If not, please delete this text and explain why this PR does not need documentation. -->
   - [ ] This PR has a CHANGELOG.md entry <!-- A fix for a bug from an ATC release, an improvement, or a new feature should have a changelog entry. -->
   - [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://apache.org/security) for details)
   
   <!--
   Licensed to the Apache Software Foundation (ASF) under one
   or more contributor license agreements.  See the NOTICE file
   distributed with this work for additional information
   regarding copyright ownership.  The ASF licenses this file
   to you under the Apache License, Version 2.0 (the
   "License"); you may not use this file except in compliance
   with the License.  You may obtain a copy of the License at
   
       http://www.apache.org/licenses/LICENSE-2.0
   
   Unless required by applicable law or agreed to in writing,
   software distributed under the License is distributed on an
   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   KIND, either express or implied.  See the License for the
   specific language governing permissions and limitations
   under the License.
   -->


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #6410: TPv2: Improve performance of hostname regular expression

Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #6410:
URL: https://github.com/apache/trafficcontrol/pull/6410#discussion_r764503874



##########
File path: experimental/traffic-portal/src/app/core/new-delivery-service/new-delivery-service.component.spec.ts
##########
@@ -137,4 +137,29 @@ describe("NewDeliveryServiceComponent", () => {
 	// 	component.cdnObject.setValue({ name: 'testCDN', id: 1 } as CDN);
 	// 	component.dsType.setValue({ name: 'testType', id: 1 } as Type);
 	// });
+
+	it("should match domain names", async () => {
+		const invalidDomains: Array<string> = [
+			"d.",
+			"d-",
+			"d-.o",
+			"-d.o",
+		];
+		for (const invalidDomain of invalidDomains) {
+			expect(() => {
+				component.setDNSBypass(invalidDomain);
+			}).toThrow();
+		}
+		const validDomains: Array<string> = [
+			"d",
+			"d.o.m.a.i.n",
+			"d-o-------m.ain",
+		];
+		expect(() => {
+			for (const domain of validDomains) {
+				component.setDNSBypass(domain);
+				expect(component.deliveryService.dnsBypassCname).toBe(domain);
+			}
+		}).not.toThrow();

Review comment:
       These tests _could_ just be passing because the inputs are being mistaken for valid IP(v4 or v6) addresses - would you mind testing for those as well? If it's easier, feel free to just export the regular expression (and in that case no additional test cases would be necessary, though because it's necessarily testing less)

##########
File path: experimental/traffic-portal/src/app/core/new-delivery-service/new-delivery-service.component.spec.ts
##########
@@ -137,4 +137,14 @@ describe("NewDeliveryServiceComponent", () => {
 	// 	component.cdnObject.setValue({ name: 'testCDN', id: 1 } as CDN);
 	// 	component.dsType.setValue({ name: 'testType', id: 1 } as Type);
 	// });
+
+	it("should match hostnames", async () => {
+		const invalidHostnames: Array<string> = ["h.", "h-", "h-.o", "-h.o"];
+		invalidHostnames.forEach((invalidHostname: string) => void expect(() => component.setDNSBypass(invalidHostname)).toThrow());
+		const validHostnames: Array<string> = ["h", "h.o.s.T.n.a.m.e", "h-O-------s.tNaMe"];
+		expect(() => validHostnames.forEach((hostname: string) => {
+			component.setDNSBypass(hostname);
+			expect(component.deliveryService.dnsBypassCname).toBe(hostname);
+		})).not.toThrow();

Review comment:
       These tests could just be passing because the inputs are being mistaken for valid IP(v4 or v6) addresses - would you mind testing for those as well? If it's easier, feel free to just export the regular expression (and in that case no additional test cases would be necessary, though because it's necessarily testing less)




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #6410: TPv2: Improve performance of hostname regular expression

Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #6410:
URL: https://github.com/apache/trafficcontrol/pull/6410#discussion_r784551717



##########
File path: experimental/traffic-portal/src/app/core/new-delivery-service/new-delivery-service.component.spec.ts
##########
@@ -137,4 +137,14 @@ describe("NewDeliveryServiceComponent", () => {
 	// 	component.cdnObject.setValue({ name: 'testCDN', id: 1 } as CDN);
 	// 	component.dsType.setValue({ name: 'testType', id: 1 } as Type);
 	// });
+
+	it("should match hostnames", async () => {
+		const invalidHostnames: Array<string> = ["h.", "h-", "h-.o", "-h.o"];
+		invalidHostnames.forEach((invalidHostname: string) => void expect(() => component.setDNSBypass(invalidHostname)).toThrow());
+		const validHostnames: Array<string> = ["h", "h.o.s.T.n.a.m.e", "h-O-------s.tNaMe"];
+		expect(() => validHostnames.forEach((hostname: string) => {
+			component.setDNSBypass(hostname);
+			expect(component.deliveryService.dnsBypassCname).toBe(hostname);
+		})).not.toThrow();

Review comment:
       I'm going through the TPv2 code to increase test coverage atm, so I can do this myself when I get to this component.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] ocket8888 merged pull request #6410: TPv2: Improve performance of hostname regular expression

Posted by GitBox <gi...@apache.org>.
ocket8888 merged pull request #6410:
URL: https://github.com/apache/trafficcontrol/pull/6410


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org