fix: modify jupyter's authority from hash password to token string (#762

) Signed-off-by: zhenguo.li <zhenguo.li@shopee.com> Signed-off-by: zhenguo.li <zhenguo.li@shopee.com> Co-authored-by: zhenguo.li <zhenguo.li@shopee.com>
tensorchord · Aug 11, 2022 · b4a8519 · b4a8519
1 parent 1f0af98
commit b4a8519
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -201,7 +201,7 @@ def build():
         "numpy",
     ])
     shell("zsh")
-    config.jupyter(password="")
+    config.jupyter(token="")
 ```
 
 You can get the endpoint of the running Jupyter notebook via `envd envs ls`.

diff --git a/envd/api/config/__init__.py b/envd/api/config/__init__.py
@@ -41,12 +41,12 @@ def apt_source(mode: Optional[str], source: Optional[str]):
     pass
 
 
-def jupyter(password: str, port: int):
+def jupyter(token: str, port: int):
     """
     Configure jupyter notebook configuration
 
     Args:
-        password (str): Password for access authentication
+        token (str): Token for access authentication
         port (int): Port to serve jupyter notebook
     """
     pass

diff --git a/examples/mnist/build.envd b/examples/mnist/build.envd
@@ -9,7 +9,7 @@ def build():
         "numpy",
     ])
     shell("zsh")
-    config.jupyter(password="", port=8888)
+    config.jupyter(token="", port=8888)
 
 def build_gpu():
     build()

diff --git a/pkg/app/template/python.envd b/pkg/app/template/python.envd
@@ -1,7 +1,7 @@
 def build():
     # Use ubuntu20.04 as base image and install python
     base(os="ubuntu20.04", language="python3")
-    # Uncomment line below to enable Pypi mirror 
+    # Uncomment line below to enable Pypi mirror
     # config.pip_index(url = "https://pypi.tuna.tsinghua.edu.cn/simple")
 
     # Add the packages you are using here
@@ -11,4 +11,4 @@ def build():
     shell("zsh")
 
     # Setup jupyter notebook
-    config.jupyter(password="", port=8888)
+    config.jupyter(token="", port=8888)
diff --git a/pkg/lang/frontend/starlark/config/config.go b/pkg/lang/frontend/starlark/config/config.go
@@ -67,15 +67,15 @@ func ruleFuncGPU(thread *starlark.Thread, _ *starlark.Builtin,
 
 func ruleFuncJupyter(thread *starlark.Thread, _ *starlark.Builtin,
 	args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
-	var password starlark.String
+	var token starlark.String
 	var port starlark.Int
 
 	if err := starlark.UnpackArgs(ruleJupyter, args, kwargs,
-		"password?", &password, "port?", &port); err != nil {
+		"token?", &token, "port?", &port); err != nil {
 		return nil, err
 	}
 
-	pwdStr := password.GoString()
+	pwdStr := token.GoString()
 
 	portInt, ok := port.Int64()
 	if !ok {

diff --git a/pkg/lang/ir/editor.go b/pkg/lang/ir/editor.go
@@ -78,13 +78,12 @@ func (g Graph) generateJupyterCommand(workingDir string) []string {
 		"--ip", "0.0.0.0", "--notebook-dir", workingDir,
 	}
 
-	if g.JupyterConfig.Password != "" {
-		cmd = append(cmd, "--NotebookApp.password", g.JupyterConfig.Password,
-			"--NotebookApp.token", "''")
+	if g.JupyterConfig.Token != "" {
+		cmd = append(cmd, "--NotebookApp.token", g.JupyterConfig.Token)
 	} else {
-		cmd = append(cmd, "--NotebookApp.password", "''",
-			"--NotebookApp.token", "''")
+		cmd = append(cmd, "--NotebookApp.token", "''")
 	}
+
 	if g.JupyterConfig.Port != 0 {
 		p := strconv.Itoa(int(config.JupyterPortInContainer))
 		cmd = append(cmd, "--port", p)

diff --git a/pkg/lang/ir/editor_test.go b/pkg/lang/ir/editor_test.go
@@ -27,29 +27,27 @@ func TestGenerateCommand(t *testing.T) {
 		{
 			graph: Graph{
 				JupyterConfig: &JupyterConfig{
-					Password: "",
-					Port:     8888,
+					Token: "",
+					Port:  8888,
 				},
 			},
 			dir: "test",
 			expected: []string{
 				"python3", "-m", "notebook", "--ip", "0.0.0.0", "--notebook-dir", "test",
-				"--NotebookApp.password", "''", "--NotebookApp.token", "''",
-				"--port", "8888",
+				"--NotebookApp.token", "''", "--port", "8888",
 			},
 		},
 		{
 			graph: Graph{
 				JupyterConfig: &JupyterConfig{
-					Password: "test",
-					Port:     8888,
+					Token: "test",
+					Port:  8888,
 				},
 			},
 			dir: "test",
 			expected: []string{
 				"python3", "-m", "notebook", "--ip", "0.0.0.0", "--notebook-dir", "test",
-				"--NotebookApp.password", "test", "--NotebookApp.token", "''",
-				"--port", "8888",
+				"--NotebookApp.token", "test", "--port", "8888",
 			},
 		},
 		{

diff --git a/pkg/lang/ir/interface.go b/pkg/lang/ir/interface.go
@@ -129,8 +129,8 @@ func Shell(shell string) error {
 
 func Jupyter(pwd string, port int64) error {
 	DefaultGraph.JupyterConfig = &JupyterConfig{
-		Password: pwd,
-		Port:     port,
+		Token: pwd,
+		Port:  port,
 	}
 	return nil
 }

diff --git a/pkg/lang/ir/types.go b/pkg/lang/ir/types.go
@@ -96,8 +96,8 @@ type GitConfig struct {
 }
 
 type JupyterConfig struct {
-	Password string
-	Port     int64
+	Token string
+	Port  int64
 }
 
 const (