Adds http url validation to all weblinks (Netflix#4340)

Author: kevgliss

data/dispatch-sample-data.dump

@@ -1,6 +1,6 @@
 from typing import List, Optional
 
-from pydantic import Field, validator
+from pydantic import Field, validator, HttpUrl
 from sqlalchemy import JSON, Boolean, Column, ForeignKey, Integer, String
 from sqlalchemy.event import listen
 from sqlalchemy.ext.hybrid import hybrid_method
@@ -60,7 +60,7 @@ class Document(DispatchBase):
     name: NameStr
     resource_id: Optional[str] = Field(None, nullable=True)
     resource_type: Optional[str] = Field(None, nullable=True)
-    weblink: str
+    weblink: Optional[HttpUrl] = Field(None, nullable=True)
 
 
 class IncidentType(DispatchBase):

src/dispatch/case/type/models.py

@@ -1,6 +1,6 @@
 from typing import Optional, List
 from datetime import datetime
-from pydantic import Field
+from pydantic import Field, HttpUrl
 
 from sqlalchemy import (
     JSON,
@@ -122,7 +122,7 @@ class SourceBase(DispatchBase):
     size: Optional[int] = Field(None, nullable=True)
     external_id: Optional[str] = Field(None, nullable=True)
     aggregated: Optional[bool] = Field(False, nullable=True)
-    links: Optional[List] = []
+    links: Optional[List[HttpUrl]] = []
     tags: Optional[List[TagRead]] = []
     incidents: Optional[List[IncidentRead]] = []
     queries: Optional[List[QueryReadMinimal]] = []

src/dispatch/data/source/models.py

@@ -2,7 +2,7 @@
 from datetime import datetime
 from typing import ForwardRef, List, Optional
 
-from pydantic import validator, Field
+from pydantic import validator, Field, HttpUrl
 
 from sqlalchemy import Column, DateTime, ForeignKey, Integer, PrimaryKeyConstraint, String, Table
 from sqlalchemy.ext.hybrid import hybrid_property
@@ -263,7 +263,7 @@ class TaskRead(DispatchBase):
     created_at: Optional[datetime]
     description: Optional[str] = Field(None, nullable=True)
     status: TaskStatus = TaskStatus.open
-    weblink: Optional[str]
+    weblink: Optional[HttpUrl] = Field(None, nullable=True)
 
 
 class TaskReadMinimal(DispatchBase):

src/dispatch/incident/models.py

@@ -1,5 +1,5 @@
 from typing import List, Optional
-from pydantic import validator, Field
+from pydantic import validator, Field, HttpUrl
 from dispatch.models import NameStr, PrimaryKey
 
 from sqlalchemy import Column, Boolean, ForeignKey, Integer, String, JSON
@@ -76,7 +76,7 @@ class Document(DispatchBase):
     resource_type: Optional[str] = Field(None, nullable=True)
     resource_id: Optional[str] = Field(None, nullable=True)
     description: Optional[str] = Field(None, nullable=True)
-    weblink: str
+    weblink: Optional[HttpUrl] = Field(None, nullable=True)
 
 
 # Pydantic models...

src/dispatch/incident/type/models.py

@@ -1,6 +1,6 @@
 from datetime import datetime
-from typing import List, Optional
-from pydantic import Field
+from typing import List, Optional, Union
+from pydantic import Field, HttpUrl, validator
 
 from sqlalchemy import Column, ForeignKey, Integer, PrimaryKeyConstraint, String, Table
 from sqlalchemy.sql.schema import UniqueConstraint
@@ -63,12 +63,18 @@ class IndividualContact(Base, ContactMixin, ProjectMixin):
 
 
 class IndividualContactBase(ContactBase):
-    weblink: Optional[str] = Field(None, nullable=True)
+    weblink: Union[HttpUrl, None, str] = Field(None, nullable=True)
     mobile_phone: Optional[str] = Field(None, nullable=True)
     office_phone: Optional[str] = Field(None, nullable=True)
     title: Optional[str] = Field(None, nullable=True)
     external_id: Optional[str] = Field(None, nullable=True)
 
+    @validator("weblink")
+    def weblink_validator(cls, v):
+        if v is None or isinstance(v, HttpUrl) or v == "":
+            return v
+        raise ValueError("weblink is not an empty string or a valid weblink")
+
 
 class IndividualContactCreate(IndividualContactBase):
     filters: Optional[List[SearchFilterRead]]

src/dispatch/individual/models.py

@@ -2,7 +2,7 @@
 from datetime import datetime, timedelta
 
 from pydantic.fields import Field
-from pydantic.networks import EmailStr
+from pydantic.networks import EmailStr, HttpUrl
 from pydantic import BaseModel
 from pydantic.types import conint, constr, SecretStr
 
@@ -136,7 +136,7 @@ class EvergreenBase(DispatchBase):
 class ResourceBase(DispatchBase):
     resource_type: Optional[str] = Field(None, nullable=True)
     resource_id: Optional[str] = Field(None, nullable=True)
-    weblink: Optional[str] = Field(None, nullable=True)
+    weblink: Optional[HttpUrl] = Field(None, nullable=True)
 
 
 class ContactBase(DispatchBase):

src/dispatch/models.py

@@ -1,6 +1,6 @@
 from typing import Optional, NewType
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Field, HttpUrl
 
 from dispatch.enums import DispatchEnum
 
@@ -27,7 +27,7 @@ class TaskMetadata(SubjectMetadata):
 
 
 class MonitorMetadata(SubjectMetadata):
-    weblink: str
+    weblink: Optional[HttpUrl] = Field(None, nullable=True)
     plugin_instance_id: int