Big Tesla merge

.golangci.yml

@@ -12,30 +12,8 @@ linters:
     - staticcheck
     - typecheck
     - unused
-#    - zerologlint
 
 issues:
   fix: true
 
-linters-settings:
-  gci:
-    # DEPRECATED: use `sections` and `prefix(github.com/org/project)` instead.
-    local-prefixes: github.com/org/project
-    # Section configuration to compare against.
-    # Section names are case-insensitive and may contain parameters in ().
-    # The default order of sections is `standard > default > custom > blank > dot`,
-    # If `custom-order` is `true`, it follows the order of `sections` option.
-    # Default: ["standard", "default"]
-    sections:
-      - standard # Standard section: captures all standard packages.
-      - default # Default section: contains all imports that could not be matched to another section type.
-      - prefix(github.com/DIMO-Network/devices-api) # Custom section: groups all imports with the specified Prefix.
-      - blank # Blank section: contains all blank imports. This section is not present unless explicitly enabled.
-      - dot # Dot section: contains all dot imports. This section is not present unless explicitly enabled.
-    # Skip generated files.
-    # Default: true
-    skip-generated: true
-    # Enable custom order of sections.
-    # If `true`, make the section order the same as the order of `sections`.
-    # Default: false
-    custom-order: false
+linters-settings: {}

charts/devices-api/values.yaml

@@ -90,6 +90,33 @@ env:
   TESLA_TOKEN_URL: https://auth.tesla.com/oauth2/v3/token
   TESLA_FLEET_URL: https://fleet-api.prd.%s.vn.cloud.tesla.com
   META_TRANSACTION_PROCESSOR_GRPC_ADDR: meta-transaction-processor-dev:8086
+  TESLA_TELEMETRY_HOST_NAME: ingest-tesla.dev.dimo.zone
+  TESLA_TELEMETRY_PORT: 443
+  TESLA_TELEMETRY_CA_CERTIFICATE: |
+    -----BEGIN CERTIFICATE-----
+    MIIBvDCCAWKgAwIBAgIRAL6QCUcK/8jy48V7ElERABowCgYIKoZIzj0EAwIwIzEh
+    MB8GA1UEAxMYRElNTyBDQSBEZXZlbG9wbWVudCBSb290MCAXDTIyMDQyMzExMTEw
+    M1oYDzIwNzIwNDEwMTExMTAzWjAyMTAwLgYDVQQDEydESU1PIENBIERldmVsb3Bt
+    ZW50IFNlcnZlciBJbnRlcm1lZGlhdGUwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNC
+    AAQMyh6plUM3p4KWWfK0CqWXr1B9NWk53+c9ps8OpgZZIyXjxiw1EHxrpcqU7C9e
+    hw+6JfmvTqqi3F4ES8K+Tt/mo2YwZDAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/
+    BAgwBgEB/wIBADAdBgNVHQ4EFgQU+7zrfioO4bjNpD9KiG8fbTcIq8kwHwYDVR0j
+    BBgwFoAUeMfSSqt+S65xQF82yRnjr+J5XC8wCgYIKoZIzj0EAwIDSAAwRQIhAK3s
+    Wtlk+d0fnkii091dTZGt+dtzEbM4HuizaG6mO5zPAiApi03qU/hdsAxXwlbhufH/
+    5HuUiCLgBK8vPvL2YdMaKQ==
+    -----END CERTIFICATE-----
+    -----BEGIN CERTIFICATE-----
+    MIIBrTCCAVKgAwIBAgIQEgthFz9Ww3+VaErBc3nDFjAKBggqhkjOPQQDAjAjMSEw
+    HwYDVQQDExhESU1PIENBIERldmVsb3BtZW50IFJvb3QwIBcNMjIwNDIzMTExMTAz
+    WhgPMjEyMjAzMzAxMTExMDNaMCMxITAfBgNVBAMTGERJTU8gQ0EgRGV2ZWxvcG1l
+    bnQgUm9vdDBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABBuxEb6jTyfrUwI8RiBV
+    KCQWqTAeLdHPj60Qk7HeMeaEcGjzF799xgpl6/8iNKaHN/w+705cdxp5pRswbUtu
+    izWjZjBkMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMBAf8ECDAGAQH/AgEBMB0GA1Ud
+    DgQWBBR4x9JKq35LrnFAXzbJGeOv4nlcLzAfBgNVHSMEGDAWgBR4x9JKq35LrnFA
+    XzbJGeOv4nlcLzAKBggqhkjOPQQDAgNJADBGAiEAlslTE9mX+VjPSYLKEsy48Rzh
+    OUCdaWovmF+28PyAi4wCIQDXRKpYK+VMFyUR1GJVoV3gWezQcJmFswuWq+7M+XPb
+    GQ==
+    -----END CERTIFICATE-----
 service:
   type: ClusterIP
   ports:

cmd/devices-api/api.go

@@ -40,7 +40,6 @@ import (
 	jwtware "github.com/gofiber/contrib/jwt"
 	"github.com/gofiber/fiber/v2"
 	"github.com/gofiber/fiber/v2/middleware/cache"
-	"github.com/gofiber/fiber/v2/middleware/cors"
 	fiberrecover "github.com/gofiber/fiber/v2/middleware/recover"
 	"github.com/gofiber/swagger"
 	grpc_middleware "github.com/grpc-ecosystem/go-grpc-middleware"
@@ -138,21 +137,17 @@ func startWebAPI(logger zerolog.Logger, settings *config.Settings, pdb db.Store,
 	countriesController := controllers.NewCountriesController()
 	userIntegrationAuthController := controllers.NewUserIntegrationAuthController(settings, pdb.DBS, &logger, ddSvc, teslaFleetAPISvc, redisCache, cipher, usersClient)
 
-	// commenting this out b/c the library includes the path in the metrics which saturates prometheus queries - need to fork / make our own
-	//prometheus := fiberprometheus.New("devices-api")
-	//app.Use(prometheus.Middleware)
 	app.Use(metrics.HTTPMetricsMiddleware)
 
 	app.Use(fiberrecover.New(fiberrecover.Config{
 		Next:              nil,
 		EnableStackTrace:  true,
 		StackTraceHandler: nil,
 	}))
-	//cors
-	app.Use(cors.New())
-	// request logging
-	app.Use(zflogger.New(logger, nil))
-	//cache
+
+	// Request logging.
+	app.Use(zflogger.New(logger, nil)) // TODO(elffjs): Is this even printing?
+
 	cacheHandler := cache.New(cache.Config{
 		Next: func(c *fiber.Ctx) bool {
 			return c.Query("refresh") == "true"
@@ -308,6 +303,7 @@ func startWebAPI(logger zerolog.Logger, settings *config.Settings, pdb db.Store,
 	udOwner.Post("/integrations/:integrationID/commands/trunk/open", userDeviceController.OpenTrunk)
 	udOwner.Post("/integrations/:integrationID/commands/frunk/open", userDeviceController.OpenFrunk)
 	udOwner.Get("/integrations/:integrationID/commands/:requestID", userDeviceController.GetCommandRequestStatus)
+	udOwner.Post("/integrations/:integrationID/commands/telemetry/subscribe", userDeviceController.TelemetrySubscribe)
 
 	udOwner.Post("/commands/opt-in", userDeviceController.DeviceOptIn)
 

cmd/devices-api/set_command_compat.go

@@ -57,7 +57,7 @@ func (p *setCommandCompatibilityCmd) Execute(ctx context.Context, _ *flag.FlagSe
 	return subcommands.ExitSuccess
 }
 
-var teslaEnabledCommands = []string{"doors/lock", "doors/unlock", "trunk/open", "frunk/open", "charge/limit"}
+var teslaEnabledCommands = []string{constants.DoorsLock, constants.DoorsUnlock, constants.TrunkOpen, constants.FrunkOpen, constants.ChargeLimit}
 
 func setCommandCompatibility(ctx context.Context, settings *config.Settings, pdb db.Store, ddSvc services.DeviceDefinitionService) error {
 
@@ -146,7 +146,7 @@ func setCommandCompatSmartcar(ctx context.Context, settings *config.Settings, pd
 			continue
 		}
 
-		md.Commands.Capable = []string{"doors/lock", "doors/unlock"}
+		md.Commands.Capable = []string{constants.DoorsLock, constants.DoorsUnlock}
 
 		if err := su.Metadata.Marshal(md); err != nil {
 			return err

docs/docs.go

@@ -1555,6 +1555,38 @@ const docTemplate = `{
                 }
             }
         },
+        "/user/devices/{userDeviceID}/integrations/{integrationID}/commands/telemetry/subscribe": {
+            "post": {
+                "description": "Subscribe vehicle for Telemetry Data. Currently, this only works for Teslas connected through Tesla.",
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "device",
+                    "integration",
+                    "command"
+                ],
+                "summary": "Subscribe vehicle for Telemetry Data",
+                "operationId": "telemetry-subscribe",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Device ID",
+                        "name": "userDeviceID",
+                        "in": "path",
+                        "required": true
+                    },
+                    {
+                        "type": "string",
+                        "description": "Integration ID",
+                        "name": "integrationID",
+                        "in": "path",
+                        "required": true
+                    }
+                ],
+                "responses": {}
+            }
+        },
         "/user/devices/{userDeviceID}/integrations/{integrationID}/commands/trunk/open": {
             "post": {
                 "description": "Open the device's front trunk. Currently, this only works for Teslas connected through Tesla.",
@@ -3082,6 +3114,14 @@ const docTemplate = `{
                 "status": {
                     "description": "Status is one of \"Pending\", \"PendingFirstData\", \"Active\", \"Failed\", \"DuplicateIntegration\".",
                     "type": "string"
+                },
+                "tesla": {
+                    "description": "Contains further details about tesla integration status",
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/internal_controllers.TeslaConnectionStatus"
+                        }
+                    ]
                 }
             }
         },
@@ -3397,6 +3437,15 @@ const docTemplate = `{
                 }
             }
         },
+        "internal_controllers.TeslaConnectionStatus": {
+            "type": "object",
+            "properties": {
+                "isVirtualKeyConnected": {
+                    "description": "Status of the virtual key connection",
+                    "type": "boolean"
+                }
+            }
+        },
         "internal_controllers.UpdateCountryCodeReq": {
             "type": "object",
             "properties": {

docs/swagger.json

@@ -1547,6 +1547,38 @@
                 }
             }
         },
+        "/user/devices/{userDeviceID}/integrations/{integrationID}/commands/telemetry/subscribe": {
+            "post": {
+                "description": "Subscribe vehicle for Telemetry Data. Currently, this only works for Teslas connected through Tesla.",
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "device",
+                    "integration",
+                    "command"
+                ],
+                "summary": "Subscribe vehicle for Telemetry Data",
+                "operationId": "telemetry-subscribe",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Device ID",
+                        "name": "userDeviceID",
+                        "in": "path",
+                        "required": true
+                    },
+                    {
+                        "type": "string",
+                        "description": "Integration ID",
+                        "name": "integrationID",
+                        "in": "path",
+                        "required": true
+                    }
+                ],
+                "responses": {}
+            }
+        },
         "/user/devices/{userDeviceID}/integrations/{integrationID}/commands/trunk/open": {
             "post": {
                 "description": "Open the device's front trunk. Currently, this only works for Teslas connected through Tesla.",
@@ -3074,6 +3106,14 @@
                 "status": {
                     "description": "Status is one of \"Pending\", \"PendingFirstData\", \"Active\", \"Failed\", \"DuplicateIntegration\".",
                     "type": "string"
+                },
+                "tesla": {
+                    "description": "Contains further details about tesla integration status",
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/internal_controllers.TeslaConnectionStatus"
+                        }
+                    ]
                 }
             }
         },
@@ -3389,6 +3429,15 @@
                 }
             }
         },
+        "internal_controllers.TeslaConnectionStatus": {
+            "type": "object",
+            "properties": {
+                "isVirtualKeyConnected": {
+                    "description": "Status of the virtual key connection",
+                    "type": "boolean"
+                }
+            }
+        },
         "internal_controllers.UpdateCountryCodeReq": {
             "type": "object",
             "properties": {

docs/swagger.yaml

@@ -581,6 +581,10 @@ definitions:
         description: Status is one of "Pending", "PendingFirstData", "Active", "Failed",
           "DuplicateIntegration".
         type: string
+      tesla:
+        allOf:
+        - $ref: '#/definitions/internal_controllers.TeslaConnectionStatus'
+        description: Contains further details about tesla integration status
     type: object
   internal_controllers.ManufacturerInfo:
     properties:
@@ -805,6 +809,12 @@ definitions:
         example: 0x30bce3da6985897224b29a0fe064fd2b426bb85a394cc09efe823b5c83326a8e
         type: string
     type: object
+  internal_controllers.TeslaConnectionStatus:
+    properties:
+      isVirtualKeyConnected:
+        description: Status of the virtual key connection
+        type: boolean
+    type: object
   internal_controllers.UpdateCountryCodeReq:
     properties:
       countryCode:
@@ -1852,6 +1862,30 @@ paths:
           description: No Content
       tags:
       - integrations
+  /user/devices/{userDeviceID}/integrations/{integrationID}/commands/telemetry/subscribe:
+    post:
+      description: Subscribe vehicle for Telemetry Data. Currently, this only works
+        for Teslas connected through Tesla.
+      operationId: telemetry-subscribe
+      parameters:
+      - description: Device ID
+        in: path
+        name: userDeviceID
+        required: true
+        type: string
+      - description: Integration ID
+        in: path
+        name: integrationID
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses: {}
+      summary: Subscribe vehicle for Telemetry Data
+      tags:
+      - device
+      - integration
+      - command
   /user/devices/{userDeviceID}/integrations/{integrationID}/commands/trunk/open:
     post:
       description: Open the device's front trunk. Currently, this only works for Teslas

internal/config/settings.go

@@ -87,6 +87,9 @@ type Settings struct {
 	TeslaClientSecret                 string `yaml:"TESLA_CLIENT_SECRET"`
 	TeslaTokenURL                     string `yaml:"TESLA_TOKEN_URL"`
 	TeslaFleetURL                     string `yaml:"TESLA_FLEET_URL"`
+	TeslaTelemetryHostName            string `yaml:"TESLA_TELEMETRY_HOST_NAME"`
+	TeslaTelemetryPort                int    `yaml:"TESLA_TELEMETRY_PORT"`
+	TeslaTelemetryCACertificate       string `yaml:"TESLA_TELEMETRY_CA_CERTIFICATE"`
 }
 
 func (s *Settings) IsProduction() bool {

internal/constants/consts.go

@@ -49,3 +49,12 @@ const (
 func (r AutoPiSubStatusEnum) String() string {
 	return string(r)
 }
+
+const (
+	ChargeLimit        string = "charge/limit"
+	FrunkOpen          string = "frunk/open"
+	TrunkOpen          string = "trunk/open"
+	DoorsLock          string = "doors/lock"
+	DoorsUnlock        string = "doors/unlock"
+	TelemetrySubscribe string = "telemetry/subscribe"
+)

internal/controllers/nft_controller.go

@@ -473,7 +473,7 @@ func (nc *NFTController) GetVehicleStatus(c *fiber.Ctx) error {
 // @Param       tokenID  path string true "Token ID"
 // @Router      /vehicle/{tokenID}/commands/doors/unlock [post]
 func (nc *NFTController) UnlockDoors(c *fiber.Ctx) error {
-	return nc.handleEnqueueCommand(c, "doors/unlock")
+	return nc.handleEnqueueCommand(c, constants.DoorsUnlock)
 }
 
 // LockDoors godoc
@@ -485,7 +485,7 @@ func (nc *NFTController) UnlockDoors(c *fiber.Ctx) error {
 // @Param       tokenID  path string true "Token ID"
 // @Router      /vehicle/{tokenID}/commands/doors/lock [post]
 func (nc *NFTController) LockDoors(c *fiber.Ctx) error {
-	return nc.handleEnqueueCommand(c, "doors/lock")
+	return nc.handleEnqueueCommand(c, constants.DoorsLock)
 }
 
 // OpenTrunk godoc
@@ -497,7 +497,7 @@ func (nc *NFTController) LockDoors(c *fiber.Ctx) error {
 // @Param       tokenID  path string true "Token ID"
 // @Router      /vehicle/{tokenID}/commands/trunk/open [post]
 func (nc *NFTController) OpenTrunk(c *fiber.Ctx) error {
-	return nc.handleEnqueueCommand(c, "trunk/open")
+	return nc.handleEnqueueCommand(c, constants.TrunkOpen)
 }
 
 // OpenFrunk godoc
@@ -509,7 +509,7 @@ func (nc *NFTController) OpenTrunk(c *fiber.Ctx) error {
 // @Param       tokenID  path string true "Token ID"
 // @Router      /vehicle/{tokenID}/commands/frunk/open [post]
 func (nc *NFTController) OpenFrunk(c *fiber.Ctx) error {
-	return nc.handleEnqueueCommand(c, "frunk/open")
+	return nc.handleEnqueueCommand(c, constants.FrunkOpen)
 }
 
 // handleEnqueueCommand enqueues the command specified by commandPath with the