Updates pre-commit hooks versions and fixes typos and formatting (Netflix#5277)

Author: mvilanova

.gitignore

@@ -176,7 +176,7 @@ yarn.lock
 
 # End of https://www.gitignore.io/api/macos,visualstudiocode,python
 
-# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
+# Custom rules (everything added below won't be overridden by 'Generate .gitignore File' if you use 'Update' option)
 
 ### Vim ###
 # Swap

.pre-commit-config.yaml

@@ -14,8 +14,8 @@ default_language_version:
 
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    # Ruff version.
-    rev: v0.1.4
+    # ruff version.
+    rev: v0.6.4
     hooks:
       # Run the linter.
       #
@@ -28,9 +28,10 @@ repos:
 
   # Typos
   - repo: https://github.com/crate-ci/typos
-    rev: v1.16.23
+    rev: v1.24.5
     hooks:
       - id: typos
+        exclude: ^(data/dispatch-sample-data.dump|src/dispatch/static/dispatch/src/|src/dispatch/database/revisions/)
 
   # Pytest
   - repo: local

docker/Dockerfile

@@ -93,7 +93,7 @@ COPY --from=sdist /dist/*.whl /tmp/dist/
 RUN buildDeps="" \
     && apt-get update \
     && apt-get install -y --no-install-recommends "$buildDeps" \
-    # remove internal index when internal plugins are seperated
+    # remove internal index when internal plugins are separated
     && pip install -U /tmp/dist/*.whl \
     && apt-get purge -y --auto-remove "$buildDeps" \
     # We install run-time dependencies strictly after

docs/docs/administration/contributing/core.mdx

@@ -4,7 +4,7 @@
 
 ### Folder Structure
 
-Dispatch's backend is a typical python web app. Its folder structure is a simple one and is mirrored between the backend code \(python\) and the frontend code \(javscript\).
+Dispatch's backend is a typical python web app. Its folder structure is a simple one and is mirrored between the backend code \(python\) and the frontend code \(javascript\).
 
 ```text
 ├── dispatch

docs/docs/administration/settings/case/case-type.mdx

@@ -16,7 +16,7 @@ Dispatch allows you to categorize your cases by defining case types and to map t
 
 **Case Template:** Allows you to create a new or map an existing case document template to the case type.
 
-**Oncall Service:** Allows you to map an existing oncall service that will be used to determing the owner of the case.
+**Oncall Service:** Allows you to map an existing oncall service that will be used to determining the owner of the case.
 
 **Incident Type:** The type of incident that will be created and linked to the case if a case of this type is moved to the Escalated status.
 

docs/docs/administration/settings/cost_model.mdx

@@ -13,7 +13,7 @@ If an incident type does not have a specific cost model assigned, the default cl
 ## Key Features
 
 ### Customizable Cost Models
-Users have the flexibility to define their unique cost models based on their organization's workflow and tools. This customization can be tailored to each incident type, providing a versitile approach to cost calculation. The cost model for an incident type can be changed at any time. When cost model changes are made to the incident type or an incident changes its type, all participant activity costs moving forward will be calculated using the new cost model.
+Users have the flexibility to define their unique cost models based on their organization's workflow and tools. This customization can be tailored to each incident type, providing a versatile approach to cost calculation. The cost model for an incident type can be changed at any time. When cost model changes are made to the incident type or an incident changes its type, all participant activity costs moving forward will be calculated using the new cost model.
 
 ### Plugin-Based Tracking
 Users can track costs from their existing tools by using our plugin-based tracking system. Users have the flexibility to select which plugins and specific plugin events they want to track, offering a targeted approach to cost calculation.

docs/docs/administration/settings/knowledge/runbooks.mdx

@@ -13,7 +13,7 @@ Today, there are two types of runbooks although their actual usage is the same.
 
 ### Engagement
 
-Runbook documents are dymanically matched to an incident based on their engagement filter. Similar to notification's a user can define for which incidents a document should be recommended to incident participants.
+Runbook documents are dynamically matched to an incident based on their engagement filter. Similar to notification's a user can define for which incidents a document should be recommended to incident participants.
 
 On incident creation (or when an important incident variable changes e.g. incident type) Dispatch will send the incident channel a document suggestion notification.
 

docs/docs/administration/settings/signal/definition.mdx

@@ -1,6 +1,6 @@
 # Signal Definition
 
-Signal Defintions are your starting point for onboarding a new Signal into Dispatch and allow a number of different configuration options.
+Signal Definitions are your starting point for onboarding a new Signal into Dispatch and allow a number of different configuration options.
 
 ## Sending Signals to Dispatch
 
@@ -59,7 +59,7 @@ don't necessarily warrant triage and investigation on their own. But, you can st
 
 ![](/img/admin-ui-signal-definition.png)
 
-**Variant**: The same signal can have multiple varitants with different defintions.
+**Variant**: The same signal can have multiple varitants with different definitions.
 
 **Owner**: Typically the team or owner that produces the Siganl.
 

docs/docs/administration/settings/signal/engagement-filter.mdx

@@ -1,6 +1,6 @@
 # Engagement Filter
 
-Engagement Filters are used to automate the process of reaching out to a user invovled in a specific Signal Instance. Engagement Filters make use of Entity Types that match email addresses for users in your environment and custom message you configure to be sent to those users. Engagement Filters also support multi-factor authentication when validating suspicious behavior. This feature is useful when you want to be confident the user you engaged is actually who they say they are and not a malicious actor.
+Engagement Filters are used to automate the process of reaching out to a user involved in a specific Signal Instance. Engagement Filters make use of Entity Types that match email addresses for users in your environment and custom message you configure to be sent to those users. Engagement Filters also support multi-factor authentication when validating suspicious behavior. This feature is useful when you want to be confident the user you engaged is actually who they say they are and not a malicious actor.
 
 ### Creating an Engagement Filter
 

docs/docs/administration/user.mdx

@@ -12,7 +12,7 @@ Users or organizational members represent users of the Dispatch UI and are diffe
 
 </div>
 
-**Role:** Dispatch uses role-based access control (RBAC) for its UI. Currently, this is only used to protect sensitive incidents whose visibilty is set to restricted. We do not currently have any controls surrounding Dispatch configuration and settings. There are four roles defined by Dispatch:
+**Role:** Dispatch uses role-based access control (RBAC) for its UI. Currently, this is only used to protect sensitive incidents whose visibility is set to restricted. We do not currently have any controls surrounding Dispatch configuration and settings. There are four roles defined by Dispatch:
 
 - Member: Can access everything except restricted incidents unless they are a direct participant.
 - Admin: Allows full access to the Dispatch UI and all incidents, whether their visibility is open or restricted.

docs/scripts/openapi.yaml

@@ -13044,7 +13044,7 @@ paths:
       - documents
   /{organization}/entity:
     get:
-      description: Get all entitys, or only those matching a given search term.
+      description: Get all entities, or only those matching a given search term.
       operationId: get_entities__organization__entity_get
       parameters:
       - in: path
@@ -13350,7 +13350,7 @@ paths:
       tags:
       - entities
     put:
-      description: Updates an exisiting entity.
+      description: Updates an existing entity.
       operationId: update_entity__organization__entity__entity_id__put
       parameters:
       - in: path
@@ -14548,7 +14548,7 @@ paths:
       tags:
       - feedback
     put:
-      description: Updates a feeback entry by its id.
+      description: Updates a feedback entry by its id.
       operationId: update_feedback__organization__feedback__feedback_id__put
       parameters:
       - in: path
@@ -21315,7 +21315,7 @@ paths:
       tags:
       - tags
     put:
-      description: Updates an exisiting tag.
+      description: Updates an existing tag.
       operationId: update_tag__organization__tags__tag_id__put
       parameters:
       - in: path

src/dispatch/auth/service.py

@@ -4,6 +4,7 @@
     :copyright: (c) 2019 by Netflix Inc., see AUTHORS for more
     :license: Apache, see LICENSE for more details.
 """
+
 import logging
 from typing import Annotated, Optional
 

src/dispatch/case/messaging.py

@@ -4,6 +4,7 @@
     :copyright: (c) 2019 by Netflix Inc., see AUTHORS for more
     :license: Apache, see LICENSE for more details.
 """
+
 import logging
 
 from sqlalchemy.orm import Session
@@ -29,7 +30,9 @@
 from dispatch.plugin import service as plugin_service
 from dispatch.event import service as event_service
 from dispatch.notification import service as notification_service
-from dispatch.plugins.dispatch_slack.case.messages import create_welcome_ephemeral_message_to_participant
+from dispatch.plugins.dispatch_slack.case.messages import (
+    create_welcome_ephemeral_message_to_participant,
+)
 
 from .enums import CaseStatus
 
@@ -124,9 +127,7 @@ def send_case_created_notifications(case: Case, db_session: Session):
         notification_template.insert(0, CASE_NAME)
 
     case_description = (
-        case.description
-        if len(case.description) <= 500
-        else f"{case.description[:500]}..."
+        case.description if len(case.description) <= 500 else f"{case.description[:500]}..."
     )
 
     notification_kwargs = {
@@ -180,9 +181,7 @@ def send_case_created_notifications(case: Case, db_session: Session):
     log.debug("Case created notifications sent.")
 
 
-def send_case_update_notifications(
-    case: Case, previous_case: CaseRead, db_session: Session
-):
+def send_case_update_notifications(case: Case, previous_case: CaseRead, db_session: Session):
     """Sends notifications about case changes."""
     notification_text = "Case Notification"
     notification_type = MessageType.case_notification
@@ -319,9 +318,7 @@ def send_case_welcome_participant_message(
     )
 
     if not plugin:
-        log.warning(
-            "Case participant welcome message not sent. No conversation plugin enabled."
-        )
+        log.warning("Case participant welcome message not sent. No conversation plugin enabled.")
         return
 
     welcome_message = create_welcome_ephemeral_message_to_participant(case=case)

src/dispatch/case_cost/service.py

@@ -112,7 +112,7 @@ def update_case_response_cost_for_case_type(db_session, case_type: CaseType) ->
 
 def calculate_response_cost(hourly_rate, total_response_time_seconds) -> int:
     """Calculates and rounds up the case response cost."""
-    return math.ceil(((total_response_time_seconds / SECONDS_IN_HOUR)) * hourly_rate)
+    return math.ceil((total_response_time_seconds / SECONDS_IN_HOUR) * hourly_rate)
 
 
 def get_default_case_response_cost(case: Case, db_session: SessionLocal) -> Optional[CaseCost]:
@@ -223,7 +223,6 @@ def calculate_case_response_cost_with_cost_model(case: Case, db_session: Session
     if case.case_type.cost_model:
         # Get the cost model. Iterate through all the listed activities we want to record.
         for activity in case.case_type.cost_model.activities:
-
             # Array of sorted (timestamp, user_id) tuples.
             case_events = fetch_case_events(
                 case=case, activity=activity, oldest=oldest, db_session=db_session

src/dispatch/cli.py

@@ -364,7 +364,9 @@ def drop_database():
     """Drops all data in database."""
     from sqlalchemy_utils import database_exists, drop_database
 
-    database_hostname = click.prompt(f"Please enter the database hostname (env = {config.DATABASE_HOSTNAME})")
+    database_hostname = click.prompt(
+        f"Please enter the database hostname (env = {config.DATABASE_HOSTNAME})"
+    )
     database_name = click.prompt(f"Please enter the database name (env = {config.DATABASE_NAME})")
     sqlalchemy_database_uri = f"postgresql+psycopg2://{config._DATABASE_CREDENTIAL_USER}:{config._QUOTED_DATABASE_PASSWORD}@{database_hostname}:{config.DATABASE_PORT}/{database_name}"
 
@@ -375,9 +377,7 @@ def drop_database():
             drop_database(str(sqlalchemy_database_uri))
             click.secho("Success.", fg="green")
     else:
-        click.secho(
-            f"Database '{database_hostname}:{database_name}' does not exist!!!", fg="red"
-        )
+        click.secho(f"Database '{database_hostname}:{database_name}' does not exist!!!", fg="red")
 
 
 @dispatch_database.command("upgrade")

src/dispatch/common/managers.py

@@ -6,6 +6,7 @@
 
 .. moduleauthor:: Kevin Glisson <[email protected]>
 """
+
 import logging
 from dispatch.exceptions import InvalidConfigurationError
 

src/dispatch/cost_model/service.py

@@ -112,7 +112,7 @@ def update(*, db_session, cost_model_in: CostModelUpdate) -> CostModel:
         cost_model_in.updated_at if cost_model_in.updated_at else datetime.utcnow()
     )
 
-    # Update all recognized activities. Delete all removed activites.
+    # Update all recognized activities. Delete all removed activities.
     update_activities = []
     delete_activities = []
 

src/dispatch/data/query/service.py

@@ -46,7 +46,7 @@ def get_by_name_or_raise(*, db_session, query_in: QueryRead, project_id: int) ->
 
 
 def get_all(*, db_session):
-    """Gets all querys."""
+    """Gets all queries."""
     return db_session.query(Query)
 
 

src/dispatch/data/source/models.py

@@ -101,6 +101,7 @@ class QueryReadMinimal(DispatchBase):
     name: str
     description: str
 
+
 class Link(DispatchBase):
     id: Optional[int]
     name: Optional[str]

src/dispatch/data/source/scheduled.py

@@ -4,6 +4,7 @@
     :copyright: (c) 2022 by Netflix Inc., see AUTHORS for more
     :license: Apache, see LICENSE for more details.
 """
+
 import logging
 
 from schedule import every

src/dispatch/database/service.py

@@ -185,8 +185,9 @@ def build_filters(filter_spec):
 
                 if not _is_iterable_filter(fn_args):
                     raise BadFilterFormat(
-                        "`{}` value must be an iterable across the function "
-                        "arguments".format(boolean_function.key)
+                        "`{}` value must be an iterable across the function " "arguments".format(
+                            boolean_function.key
+                        )
                     )
                 if boolean_function.only_one_arg and len(fn_args) != 1:
                     raise BadFilterFormat(

src/dispatch/email_templates/service.py

@@ -18,7 +18,9 @@ def get(*, email_template_id: int, db_session: Session) -> Optional[EmailTemplat
     )
 
 
-def get_by_type(*, email_template_type: str, project_id: int, db_session: Session) -> Optional[EmailTemplates]:
+def get_by_type(
+    *, email_template_type: str, project_id: int, db_session: Session
+) -> Optional[EmailTemplates]:
     """Gets an email template by its type."""
     return (
         db_session.query(EmailTemplates)
@@ -40,9 +42,7 @@ def create(*, email_template_in: EmailTemplatesCreate, db_session: Session) -> E
         db_session=db_session, project_in=email_template_in.project
     )
 
-    email_template = EmailTemplates(
-        **email_template_in.dict(exclude={"project"}), project=project
-    )
+    email_template = EmailTemplates(**email_template_in.dict(exclude={"project"}), project=project)
 
     db_session.add(email_template)
     db_session.commit()

src/dispatch/email_templates/views.py

@@ -14,7 +14,12 @@
 from dispatch.models import PrimaryKey
 from dispatch.exceptions import ExistsError
 
-from .models import EmailTemplatesRead, EmailTemplatesUpdate, EmailTemplatesPagination, EmailTemplatesCreate
+from .models import (
+    EmailTemplatesRead,
+    EmailTemplatesUpdate,
+    EmailTemplatesPagination,
+    EmailTemplatesCreate,
+)
 from .service import get, create, update, delete
 
 log = logging.getLogger(__name__)
@@ -47,9 +52,7 @@ def create_email_template(
 ):
     """Create a new email template."""
     try:
-        return create(
-            db_session=db_session, email_template_in=email_template_in
-        )
+        return create(db_session=db_session, email_template_in=email_template_in)
     except IntegrityError:
         raise ValidationError(
             [
@@ -80,7 +83,9 @@ def update_email_template(
         )
     try:
         email_template = update(
-            db_session=db_session, email_template=email_template, email_template_in=email_template_in
+            db_session=db_session,
+            email_template=email_template,
+            email_template_in=email_template_in,
         )
     except IntegrityError:
         raise ValidationError(

src/dispatch/entity/views.py

@@ -18,7 +18,7 @@
 
 @router.get("", response_model=EntityPagination)
 def get_entities(common: CommonParameters):
-    """Get all entitys, or only those matching a given search term."""
+    """Get all entities, or only those matching a given search term."""
     return search_filter_sort_paginate(model="Entity", **common)
 
 
@@ -42,7 +42,7 @@ def create_entity(db_session: DbSession, entity_in: EntityCreate):
 
 @router.put("/{entity_id}", response_model=EntityRead)
 def update_entity(db_session: DbSession, entity_id: PrimaryKey, entity_in: EntityUpdate):
-    """Updates an exisiting entity."""
+    """Updates an existing entity."""
     entity = get(db_session=db_session, entity_id=entity_id)
     if not entity:
         raise HTTPException(