Ensure label updates work with API endpoints

yetanalytics · Feb 4, 2025 · ced1408 · ced1408
1 parent de1bbe5
commit ced1408
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 7 deletions.
diff --git a/src/main/lrsql/admin/interceptors/credentials.clj b/src/main/lrsql/admin/interceptors/credentials.clj
@@ -21,7 +21,9 @@
        (if-some [err (or (when key-pair?
                            (s/explain-data as/key-pair-spec params))
                          (when scopes?
-                           (s/explain-data as/scopes-spec params)))]
+                           (s/explain-data as/scopes-spec params))
+                         (when (:label params)
+                           (s/explain-data as/label-spec params)))]
          ;; Invalid parameters - Bad Request
          (assoc (chain/terminate ctx)
                 :response
@@ -31,6 +33,7 @@
          ;; Valid parameters - continue
          (let [cred-info (select-keys params [:api-key
                                               :secret-key
+                                              :label
                                               :scopes])]
            (-> ctx
                (assoc ::data cred-info)

diff --git a/src/main/lrsql/spec/auth.clj b/src/main/lrsql/spec/auth.clj
@@ -85,6 +85,9 @@
 (def scopes-spec
   (s/keys :req-un [::scopes]))
 
+(def label-spec
+  (s/keys :req-un [::label]))
+
 (def scoped-key-pair-spec
   (s/keys :req-un [::api-key
                    ::secret-key

diff --git a/src/test/lrsql/admin/route_test.clj b/src/test/lrsql/admin/route_test.clj
@@ -567,11 +567,12 @@
                        {:headers hdr
                         :body (u/write-json-str
                                {"scopes" ["all" "all/read"]})})
-            {:strs [api-key secret-key scopes]}
+            {:strs [api-key secret-key label scopes]}
             (u/parse-json body)]
         (is (= 200 status))
         (is (re-matches Base64RegEx api-key))
         (is (re-matches Base64RegEx secret-key))
+        (is (nil? label))
         (is (= #{"all" "all/read"} (set scopes)))
         (testing "and reading"
           (let [{:keys [status body]}
@@ -581,6 +582,7 @@
             (is (= 200 status))
             (is (= {"api-key"    api-key
                     "secret-key" secret-key
+                    "label"      nil
                     "scopes"     scopes}
                    (-> body
                        (u/parse-json :object? false)
@@ -596,10 +598,12 @@
                  {:headers hdr
                   :body    (u/write-json-str {"api-key"    api-key
                                               "secret-key" secret-key
+                                              "label"      "My Label"
                                               "scopes"     req-scopes})})
-                {:strs [scopes]}
+                {:strs [label scopes]}
                 (u/parse-json body)]
             (is (= 200 status))
+            (is (= "My Label" label))
             (is (= #{"all/read" "statements/read" "statements/read/mine"}
                    (set scopes)))))
         (testing "and reading after updating"
@@ -609,6 +613,7 @@
                  {:headers hdr})
                 {api-key'    "api-key"
                  secret-key' "secret-key"
+                 label'      "label"
                  scopes'     "scopes"}
                 (-> body
                     (u/parse-json :object? false)
@@ -617,9 +622,10 @@
             (is (= 200 status))
             (is (= api-key api-key'))
             (is (= secret-key secret-key'))
+            (is (= "My Label" label'))
             (is (= #{"all/read" "statements/read" "statements/read/mine"}
                    (set scopes')))))
-        (testing "and no-op scope update"
+        (testing "and no-op label + scope update"
           (let [req-scopes
                 ["all/read" "statements/read" "statements/read/mine"]
                 {:keys [status body]}
@@ -628,23 +634,27 @@
                  {:headers hdr
                   :body   (u/write-json-str {"api-key"    api-key
                                              "secret-key" secret-key
+                                             "label"      "My Label"
                                              "scopes"     req-scopes})})
-                {:strs [scopes]}
+                {:strs [label scopes]}
                 (u/parse-json body)]
             (is (= 200 status))
+            (is (= "My Label" label))
             (is (= #{"all/read" "statements/read" "statements/read/mine"}
                    (set scopes)))))
-        (testing "and deleting all scopes"
+        (testing "and deleting label and all scopes"
           (let [{:keys [status body]}
                 (curl/put
                  "http://0.0.0.0:8080/admin/creds"
                  {:headers hdr
+                  ;; Not including label key = nil label
                   :body   (u/write-json-str {"api-key"    api-key
                                              "secret-key" secret-key
                                              "scopes"     []})})
-                {:strs [scopes]}
+                {:strs [label scopes]}
                 (u/parse-json body)]
             (is (= 200 status))
+            (is (= nil label))
             (is (= #{} (set scopes)))))
         (testing "and deletion"
           (let [{:keys [status]}