Debug API containers locally (#2112)

Author: vishalbollu

cli/cmd/errors.go

@@ -26,6 +26,7 @@ import (
 	s "github.com/cortexlabs/cortex/pkg/lib/strings"
 	"github.com/cortexlabs/cortex/pkg/lib/urls"
 	"github.com/cortexlabs/cortex/pkg/types/clusterconfig"
+	"github.com/cortexlabs/cortex/pkg/types/userconfig"
 )
 
 const (
@@ -67,6 +68,9 @@ const (
 	ErrShellCompletionNotSupported         = "cli.shell_completion_not_supported"
 	ErrNoTerminalWidth                     = "cli.no_terminal_width"
 	ErrDeployFromTopLevelDir               = "cli.deploy_from_top_level_dir"
+	ErrAPINameMustBeProvided               = "cli.api_name_must_be_provided"
+	ErrAPINotFoundInConfig                 = "cli.api_not_found_in_config"
+	ErrNotSupportedForKindAndType          = "cli.not_supported_for_kind_and_type"
 )
 
 func ErrorInvalidProvider(providerStr, cliConfigPath string) error {
@@ -267,3 +271,28 @@ func ErrorDeployFromTopLevelDir(genericDirName string) error {
 		Message: fmt.Sprintf("cannot deploy from your %s directory - when deploying your API, cortex sends all files in your project directory (i.e. the directory which contains cortex.yaml) to your cluster (see https://docs.cortex.dev/v/%s/); therefore it is recommended to create a subdirectory for your project files", genericDirName, consts.CortexVersionMinor),
 	})
 }
+
+func ErrorAPINameMustBeProvided() error {
+	return errors.WithStack(&errors.Error{
+		Kind:    ErrAPINameMustBeProvided,
+		Message: fmt.Sprintf("multiple apis listed; please specify the name of an api"),
+	})
+}
+
+func ErrorAPINotFoundInConfig(apiName string) error {
+	return errors.WithStack(&errors.Error{
+		Kind:    ErrAPINotFoundInConfig,
+		Message: fmt.Sprintf("api '%s' not found in config", apiName),
+	})
+}
+
+func ErrorNotSupportedForKindAndType(kind userconfig.Kind, predictorType userconfig.PredictorType) error {
+	return errors.WithStack(&errors.Error{
+		Kind:    ErrNotSupportedForKindAndType,
+		Message: fmt.Sprintf("this command is still in beta and currently only supports %s with type %s", userconfig.RealtimeAPIKind.String(), userconfig.PythonPredictorType.String()),
+		Metadata: map[string]interface{}{
+			"apiKind":       kind.String(),
+			"predictorType": predictorType.String(),
+		},
+	})
+}

cli/cmd/prepare_debug.go

@@ -0,0 +1,112 @@
+/*
+Copyright 2021 Cortex Labs, Inc.
+
+Licensed 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.
+*/
+
+package cmd
+
+import (
+	"fmt"
+	"path"
+
+	"github.com/cortexlabs/cortex/pkg/consts"
+	"github.com/cortexlabs/cortex/pkg/lib/errors"
+	"github.com/cortexlabs/cortex/pkg/lib/exit"
+	"github.com/cortexlabs/cortex/pkg/lib/files"
+	libjson "github.com/cortexlabs/cortex/pkg/lib/json"
+	"github.com/cortexlabs/cortex/pkg/lib/telemetry"
+	"github.com/cortexlabs/cortex/pkg/types/spec"
+	"github.com/cortexlabs/cortex/pkg/types/userconfig"
+	"github.com/spf13/cobra"
+)
+
+func prepareDebugInit() {
+	_prepareDebugCmd.Flags().SortFlags = false
+}
+
+var _prepareDebugCmd = &cobra.Command{
+	Use:   "prepare-debug CONFIG_FILE [API_NAME]",
+	Short: "prepare artifacts to debug containers",
+	Args:  cobra.RangeArgs(1, 2),
+	Run: func(cmd *cobra.Command, args []string) {
+		telemetry.Event("cli.prepare-debug")
+
+		configPath := args[0]
+
+		var apiName string
+		if len(args) == 2 {
+			apiName = args[1]
+		}
+
+		configBytes, err := files.ReadFileBytes(configPath)
+		if err != nil {
+			exit.Error(err)
+		}
+
+		projectRoot := files.Dir(files.UserRelToAbsPath(configPath))
+
+		apis, err := spec.ExtractAPIConfigs(configBytes, args[0])
+		if err != nil {
+			exit.Error(err)
+		}
+
+		if apiName == "" && len(apis) > 1 {
+			exit.Error(errors.Wrap(ErrorAPINameMustBeProvided(), configPath))
+		}
+
+		var apiToPrepare userconfig.API
+		if apiName == "" {
+			apiToPrepare = apis[0]
+		} else {
+			found := false
+			for i := range apis {
+				api := apis[i]
+				if api.Name == apiName {
+					found = true
+					apiToPrepare = api
+					break
+				}
+			}
+			if !found {
+				exit.Error(errors.Wrap(ErrorAPINotFoundInConfig(apiName), configPath))
+			}
+		}
+
+		if apiToPrepare.Kind != userconfig.RealtimeAPIKind {
+			exit.Error(ErrorNotSupportedForKindAndType(apiToPrepare.Kind, userconfig.UnknownPredictorType))
+		}
+		if apiToPrepare.Predictor.Type != userconfig.PythonPredictorType {
+			exit.Error(ErrorNotSupportedForKindAndType(apiToPrepare.Kind, apiToPrepare.Predictor.Type))
+		}
+
+		apiSpec := spec.API{
+			API: &apiToPrepare,
+		}
+
+		debugFileName := apiSpec.Name + ".debug.json"
+		jsonStr, err := libjson.Pretty(apiSpec)
+		if err != nil {
+			exit.Error(err)
+		}
+		files.WriteFile([]byte(jsonStr), path.Join(projectRoot, debugFileName))
+
+		fmt.Println(fmt.Sprintf(
+			`
+docker run -p 9000:8888 \
+-e "CORTEX_VERSION=%s" \
+-e "CORTEX_API_SPEC=/mnt/project/%s" \
+-v %s:/mnt/project \
+%s`, consts.CortexVersion, debugFileName, path.Clean(projectRoot), apiToPrepare.Predictor.Image))
+	},
+}

cli/cmd/root.go

@@ -112,6 +112,7 @@ func init() {
 	clusterInit()
 	completionInit()
 	deleteInit()
+	prepareDebugInit()
 	deployInit()
 	envInit()
 	getInit()
@@ -159,6 +160,7 @@ func Execute() {
 	_rootCmd.AddCommand(_logsCmd)
 	_rootCmd.AddCommand(_refreshCmd)
 	_rootCmd.AddCommand(_deleteCmd)
+	_rootCmd.AddCommand(_prepareDebugCmd)
 
 	_rootCmd.AddCommand(_clusterCmd)
 

dev/generate_cli_md.sh

@@ -37,6 +37,7 @@ commands=(
   "patch"
   "refresh"
   "delete"
+  "prepare-debug"
   "cluster up"
   "cluster info"
   "cluster scale"

docs/clients/cli.md

@@ -92,6 +92,18 @@ Flags:
   -h, --help            help for delete
 ```
 
+## prepare-debug
+
+```text
+prepare artifacts to debug containers
+
+Usage:
+  cortex prepare-debug CONFIG_FILE [API_NAME] [flags]
+
+Flags:
+  -h, --help   help for prepare-debug
+```
+
 ## cluster up
 
 ```text

pkg/cortex/serve/cortex_internal/lib/api/__init__.py

@@ -13,5 +13,5 @@
 # limitations under the License.
 
 from cortex_internal.lib.api.predictor import Predictor
-from cortex_internal.lib.api.api import API, get_api, get_spec
+from cortex_internal.lib.api.api import API, get_api
 from cortex_internal.lib.api.task import TaskAPI

pkg/cortex/serve/cortex_internal/lib/api/api.py

@@ -29,21 +29,17 @@
 class API:
     def __init__(
         self,
-        storage: S3,
         api_spec: Dict[str, Any],
         model_dir: str,
         cache_dir: str = ".",
     ):
-        self.storage = storage
         self.api_spec = api_spec
         self.cache_dir = cache_dir
 
         self.id = api_spec["id"]
         self.predictor_id = api_spec["predictor_id"]
         self.deployment_id = api_spec["deployment_id"]
 
-        self.key = api_spec["key"]
-        self.metadata_root = api_spec["metadata_root"]
         self.name = api_spec["name"]
         self.predictor = Predictor(api_spec, model_dir)
 
@@ -136,44 +132,14 @@ def get_api(
     spec_path: str,
     model_dir: str,
     cache_dir: str,
-    region: str,
 ) -> API:
-    storage, raw_api_spec = get_spec(spec_path, cache_dir, region)
+    with open(spec_path) as json_file:
+        raw_api_spec = json.load(json_file)
 
     api = API(
-        storage=storage,
         api_spec=raw_api_spec,
         model_dir=model_dir,
         cache_dir=cache_dir,
     )
 
     return api
-
-
-def get_spec(
-    spec_path: str,
-    cache_dir: str,
-    region: str,
-    spec_name: str = "api_spec.json",
-) -> Tuple[S3, dict]:
-    """
-    Args:
-        spec_path: Path to API spec (i.e. "s3://cortex-dev-0/apis/iris-classifier/api/69b93378fa5c0218-jy1fjtyihu-9fcc10739e7fc8050cefa8ca27ece1ee/master-spec.json").
-        cache_dir: Local directory where the API spec gets saved to.
-        region: Region of the bucket.
-        spec_name: File name of the spec as it is saved on disk.
-    """
-
-    bucket, key = S3.deconstruct_s3_path(spec_path)
-    storage = S3(bucket=bucket, region=region)
-
-    local_spec_path = os.path.join(cache_dir, spec_name)
-    if not os.path.isfile(local_spec_path):
-        storage.download_file(key, local_spec_path)
-
-    return storage, read_json(local_spec_path)
-
-
-def read_json(json_path: str):
-    with open(json_path) as json_file:
-        return json.load(json_file)

pkg/cortex/serve/cortex_internal/lib/telemetry.py

@@ -54,7 +54,11 @@ def init_sentry(
     In addition to that, the user ID tag is added to every reported event.
     """
 
-    if disabled is True or os.getenv("CORTEX_TELEMETRY_DISABLE", "").lower() == "true":
+    if (
+        disabled is True
+        or os.getenv("CORTEX_TELEMETRY_DISABLE", "").lower() == "true"
+        or os.getenv("CORTEX_DEBUGGING", "true").lower() == "true"
+    ):
         return
 
     if dsn == "":

pkg/cortex/serve/cortex_internal/serve/serve.py

@@ -284,7 +284,7 @@ def start_fn():
                 json.dump(used_ports, f)
                 f.truncate()
 
-        api = get_api(spec_path, model_dir, cache_dir, region)
+        api = get_api(spec_path, model_dir, cache_dir)
 
         client = api.predictor.initialize_client(
             tf_serving_host=tf_serving_host, tf_serving_port=tf_serving_port

pkg/cortex/serve/init/bootloader.sh

@@ -24,6 +24,10 @@ if [ "$CORTEX_VERSION" != "$EXPECTED_CORTEX_VERSION" ]; then
     exit 1
 fi
 
+export CORTEX_DEBUGGING=${CORTEX_DEBUGGING:-"true"}
+
+eval $(/opt/conda/envs/env/bin/python /src/cortex/serve/init/export_env_vars.py $CORTEX_API_SPEC)
+
 function substitute_env_vars() {
     file_to_run_substitution=$1
     /opt/conda/envs/env/bin/python -c "from cortex_internal.lib import util; import os; util.expand_environment_vars_on_file('$file_to_run_substitution')"