lkr-dev-cli 0.0.29__tar.gz → 0.0.30__tar.gz

{lkr_dev_cli-0.0.29 → lkr_dev_cli-0.0.30}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lkr-dev-cli
-Version: 0.0.29
+Version: 0.0.30
 Summary: lkr: a command line interface for looker
 Author: bwebs
 License-Expression: MIT
@@ -129,7 +129,7 @@ The observability command provides tools for monitoring and interacting with Loo
 - `GET /health`: Launches a headless browser to simulate embedding a dashboard, waits for a completion indicator, and logs the process for health checking. This endpoint accepts query parameters to help login users with custom attributes.
 
 > [!IMPORTANT]
-> Make sure you add the http://host:port to your domain allowlist in Admin Embed. [docs](https://cloud.google.com/looker/docs/embedded-javascript-events#adding_the_embed_domain_to_the_allowlist) Unless overridden, the default would be http://0.0.0.0:8080. These can also set via cli arguments. E.g., `lkr observability embed --host localhost --port 7777` or by setting the environment variables `HOST` and `PORT`. You can check the embed_domain by sending a request to the `/settings` endpoint.
+> Make sure you add the `http://host:port` to your domain allowlist in Admin Embed. [docs](https://cloud.google.com/looker/docs/embedded-javascript-events#adding_the_embed_domain_to_the_allowlist) Unless overridden, the default would be http://0.0.0.0:8080. These can also set via cli arguments. E.g., `lkr observability embed --host localhost --port 7777` or by setting the environment variables `HOST` and `PORT`. You can check the embed_domain by sending a request to the `/settings` endpoint.
 
 
 For example:
@@ -209,4 +209,112 @@ gcloud monitoring uptime create lkr-observability-health-check \
 ```
 
 ### Alternative Usage
-This can also be used to stress test your Looker environment as it serves an API that logs into a Looker embedded dashboard and runs queries like a user would within Chromium. If you wrote a script to repeatedly call this API with different parameters, you could use it to stress test your Looker environment and/or your database.
+This can also be used to stress test your Looker environment as it serves an API that logs into a Looker embedded dashboard and runs queries like a user would within Chromium. If you wrote a script to repeatedly call this API with different parameters, you could use it to stress test your Looker environment and/or your database.
+
+## User Attribute Updater (OIDC Token)
+
+1. Create a new cloud run using the `lkr-cli` public docker image `us-central1-docker.pkg.dev/lkr-dev-production/lkr-cli/cli:latest`
+2. Put in the environment variables LOOKERSDK_CLIENT_ID, LOOKERSDK_CLIENT_SECRET, LOOKERSDK_BASE_URL, LOOKER_WHITELISTED_BASE_URLS. The `LOOKER_WHITELISTED_BASE_URLS` would be the same url as the `LOOKERSDK_BASE_URL` if you are only using this for a single Looker instance. For more advanced use cases, you can set the `LOOKER_WHITELISTED_BASE_URLS` to a comma separated list of urls. The body of the request also accepts a `base_url`, `client_id`, and `client_secret` key that will override these settings.
+3. Deploy the cloud run
+4. Retrieve the URL of the cloud run
+5. Create the user attribute 
+   - Name: cloud_run_access_token 
+   - Data Type: String
+   - User Access: None
+   - Hide values: Yes
+   - Domain Allowlist: The URL of the cloud run from step 4. Looker will only allow the user attribute to be set if the request is going to this URL
+
+> [!NOTE]
+> The user attribute name can be anything you want. Typically you will be using this with an extension, so you should follow the naming convention of the type of user attribute you will be using with the extension. I would recommend using a `scoped user attributes` for this. See [Extension User Attributes](https://www.npmjs.com/package/@looker/extension-sdk#user-attributes). If you are using a `global_user_attribute`, then you can just use the name of it like `cloud_run_access_token`.
+
+6. Create a new cloud scheduler
+   - cron: `0 * * * *`
+   - Target Type: Cloud Run
+   - URL: The URL of the cloud run from step 4 with a path of `/identity_token`. E.g. `https://your-cloud-run-url.com/identity_token`
+   - HTTP Method: POST
+   - Headers: `Content-Type: application/json`
+   - Body: Use the user attribute_name from  step 5, or use the user_attribute_id found in the Looker URL after you created it or are editing it
+
+    ```json
+    {
+      "user_attribute": "cloud_run_access_token",
+      "update_type": "default"
+    }
+    ```
+   - Auth Header: OIDC Token
+   - Service Account: Choose the service account you want to use to run the cloud scheduler
+   - Audience: The URL of the cloud run
+   - Max Retries: >0
+7. Make sure the Service Account has the `Cloud Run Invoker` role
+8. Navigate the the cloud scheduler page, select the one you just created, and click Force Run
+9. Check the logs of the cloud run to see if there was a 200 response
+
+
+## UserAttributeUpdater `lkr-dev-cli`
+
+Exported from the `lkr-dev-cli` package is the `UserAttributeUpdater` pydantic class. This class has all the necessary logic to update a user attribute value. 
+
+It supports the following operations:
+- Updating a default value
+- Updating a group value
+- Updating a user value
+- Deleting a default value
+- Deleting a group value
+- Deleting a user value
+
+It can also support looking up looker ids. It will lookup the following if the id is not provided:
+- user_attribute_id by the name
+- user_id by the email or external_user_id
+- group_id by the name
+
+
+### Example Usage
+
+```python
+from lkr import UserAttributeUpdater
+
+# without credentials
+updater = UserAttributeUpdater(
+    user_attribute="cloud_run_access_token",
+    update_type="default",
+    value="123",
+)
+
+
+# with credentials
+updater = UserAttributeUpdater(
+    user_attribute="cloud_run_access_token",
+    update_type="default",
+    value="123",
+    base_url="https://your-looker-instance.com",
+    client_id="your-client-id",
+    client_secret="your-client-secret",
+)
+
+updater.update_user_attribute_value()
+
+# Getting authorization header from a FastAPI request
+from fastapi import Request
+from lkr import UserAttributeUpdater
+
+@app.post("/request_authorization")
+def request_authorization(request: Request):
+    body = await request.json()
+    updater = UserAttributeUpdater.model_validate(body)
+    updater.get_request_authorization_for_value(request)
+    updater.update_user_attribute_value()
+
+@app.post("/as_body")
+def as_body(request: Request, body: UserAttributeUpdater):
+    body.get_request_authorization_for_value(request)
+    body.update_user_attribute_value()
+
+@app.post("/assigning_value")
+def assigning_value(request: Request):
+    updater = UserAttributeUpdater(
+      user_attribute="cloud_run_access_token",
+      update_type="default"
+    )
+    updater.value = request.headers.get("my_custom_header")
+    updater.update_user_attribute_value()
+```

{lkr_dev_cli-0.0.29 → lkr_dev_cli-0.0.30}/README.md

@@ -107,7 +107,7 @@ The observability command provides tools for monitoring and interacting with Loo
 - `GET /health`: Launches a headless browser to simulate embedding a dashboard, waits for a completion indicator, and logs the process for health checking. This endpoint accepts query parameters to help login users with custom attributes.
 
 > [!IMPORTANT]
-> Make sure you add the http://host:port to your domain allowlist in Admin Embed. [docs](https://cloud.google.com/looker/docs/embedded-javascript-events#adding_the_embed_domain_to_the_allowlist) Unless overridden, the default would be http://0.0.0.0:8080. These can also set via cli arguments. E.g., `lkr observability embed --host localhost --port 7777` or by setting the environment variables `HOST` and `PORT`. You can check the embed_domain by sending a request to the `/settings` endpoint.
+> Make sure you add the `http://host:port` to your domain allowlist in Admin Embed. [docs](https://cloud.google.com/looker/docs/embedded-javascript-events#adding_the_embed_domain_to_the_allowlist) Unless overridden, the default would be http://0.0.0.0:8080. These can also set via cli arguments. E.g., `lkr observability embed --host localhost --port 7777` or by setting the environment variables `HOST` and `PORT`. You can check the embed_domain by sending a request to the `/settings` endpoint.
 
 
 For example:
@@ -187,4 +187,112 @@ gcloud monitoring uptime create lkr-observability-health-check \
 ```
 
 ### Alternative Usage
-This can also be used to stress test your Looker environment as it serves an API that logs into a Looker embedded dashboard and runs queries like a user would within Chromium. If you wrote a script to repeatedly call this API with different parameters, you could use it to stress test your Looker environment and/or your database.
+This can also be used to stress test your Looker environment as it serves an API that logs into a Looker embedded dashboard and runs queries like a user would within Chromium. If you wrote a script to repeatedly call this API with different parameters, you could use it to stress test your Looker environment and/or your database.
+
+## User Attribute Updater (OIDC Token)
+
+1. Create a new cloud run using the `lkr-cli` public docker image `us-central1-docker.pkg.dev/lkr-dev-production/lkr-cli/cli:latest`
+2. Put in the environment variables LOOKERSDK_CLIENT_ID, LOOKERSDK_CLIENT_SECRET, LOOKERSDK_BASE_URL, LOOKER_WHITELISTED_BASE_URLS. The `LOOKER_WHITELISTED_BASE_URLS` would be the same url as the `LOOKERSDK_BASE_URL` if you are only using this for a single Looker instance. For more advanced use cases, you can set the `LOOKER_WHITELISTED_BASE_URLS` to a comma separated list of urls. The body of the request also accepts a `base_url`, `client_id`, and `client_secret` key that will override these settings.
+3. Deploy the cloud run
+4. Retrieve the URL of the cloud run
+5. Create the user attribute 
+   - Name: cloud_run_access_token 
+   - Data Type: String
+   - User Access: None
+   - Hide values: Yes
+   - Domain Allowlist: The URL of the cloud run from step 4. Looker will only allow the user attribute to be set if the request is going to this URL
+
+> [!NOTE]
+> The user attribute name can be anything you want. Typically you will be using this with an extension, so you should follow the naming convention of the type of user attribute you will be using with the extension. I would recommend using a `scoped user attributes` for this. See [Extension User Attributes](https://www.npmjs.com/package/@looker/extension-sdk#user-attributes). If you are using a `global_user_attribute`, then you can just use the name of it like `cloud_run_access_token`.
+
+6. Create a new cloud scheduler
+   - cron: `0 * * * *`
+   - Target Type: Cloud Run
+   - URL: The URL of the cloud run from step 4 with a path of `/identity_token`. E.g. `https://your-cloud-run-url.com/identity_token`
+   - HTTP Method: POST
+   - Headers: `Content-Type: application/json`
+   - Body: Use the user attribute_name from  step 5, or use the user_attribute_id found in the Looker URL after you created it or are editing it
+
+    ```json
+    {
+      "user_attribute": "cloud_run_access_token",
+      "update_type": "default"
+    }
+    ```
+   - Auth Header: OIDC Token
+   - Service Account: Choose the service account you want to use to run the cloud scheduler
+   - Audience: The URL of the cloud run
+   - Max Retries: >0
+7. Make sure the Service Account has the `Cloud Run Invoker` role
+8. Navigate the the cloud scheduler page, select the one you just created, and click Force Run
+9. Check the logs of the cloud run to see if there was a 200 response
+
+
+## UserAttributeUpdater `lkr-dev-cli`
+
+Exported from the `lkr-dev-cli` package is the `UserAttributeUpdater` pydantic class. This class has all the necessary logic to update a user attribute value. 
+
+It supports the following operations:
+- Updating a default value
+- Updating a group value
+- Updating a user value
+- Deleting a default value
+- Deleting a group value
+- Deleting a user value
+
+It can also support looking up looker ids. It will lookup the following if the id is not provided:
+- user_attribute_id by the name
+- user_id by the email or external_user_id
+- group_id by the name
+
+
+### Example Usage
+
+```python
+from lkr import UserAttributeUpdater
+
+# without credentials
+updater = UserAttributeUpdater(
+    user_attribute="cloud_run_access_token",
+    update_type="default",
+    value="123",
+)
+
+
+# with credentials
+updater = UserAttributeUpdater(
+    user_attribute="cloud_run_access_token",
+    update_type="default",
+    value="123",
+    base_url="https://your-looker-instance.com",
+    client_id="your-client-id",
+    client_secret="your-client-secret",
+)
+
+updater.update_user_attribute_value()
+
+# Getting authorization header from a FastAPI request
+from fastapi import Request
+from lkr import UserAttributeUpdater
+
+@app.post("/request_authorization")
+def request_authorization(request: Request):
+    body = await request.json()
+    updater = UserAttributeUpdater.model_validate(body)
+    updater.get_request_authorization_for_value(request)
+    updater.update_user_attribute_value()
+
+@app.post("/as_body")
+def as_body(request: Request, body: UserAttributeUpdater):
+    body.get_request_authorization_for_value(request)
+    body.update_user_attribute_value()
+
+@app.post("/assigning_value")
+def assigning_value(request: Request):
+    updater = UserAttributeUpdater(
+      user_attribute="cloud_run_access_token",
+      update_type="default"
+    )
+    updater.value = request.headers.get("my_custom_header")
+    updater.update_user_attribute_value()
+```

{lkr_dev_cli-0.0.29 → lkr_dev_cli-0.0.30}/lkr/main.py

@@ -12,7 +12,10 @@ from lkr.observability.main import group as observability_group
 from lkr.tools.main import group as tools_group
 
 app = typer.Typer(
-    name="lkr", help="LookML Repository CLI", add_completion=True, no_args_is_help=True
+    name="lkr",
+    help="A CLI for Looker with helpful tools",
+    add_completion=True,
+    no_args_is_help=True,
 )
 
 app.add_typer(auth_group, name="auth")

{lkr_dev_cli-0.0.29 → lkr_dev_cli-0.0.30}/lkr/tools/classes.py

@@ -68,6 +68,17 @@ class UserAttributeUpdater(BaseModel):
             return None
         return init_api_key_sdk(api_key, True)
 
+    def _get_looker_user_id(self, sdk: Looker40SDK) -> str | None:
+        if self.looker_user_id:
+            return self.looker_user_id
+        elif self.email:
+            user = sdk.user_for_credential("email", self.email)
+            return user.id if user else None
+        elif self.external_user_id:
+            user = sdk.user_for_credential("embed", self.external_user_id)
+            return user.id if user else None
+        return None
+
     def _get_group_id(self, sdk: Looker40SDK) -> str | None:
         if self.group_id:
             return self.group_id
@@ -107,25 +118,24 @@ class UserAttributeUpdater(BaseModel):
             else:
                 raise ValueError("Group not found")
         elif self.update_type == "default":
-            sdk.delete_user_attribute(user_attribute_id)
+            user_attribute = sdk.user_attribute(user_attribute_id, "name,label,type")
+            sdk.update_user_attribute(
+                user_attribute_id,
+                WriteUserAttribute(
+                    default_value=None,
+                    name=user_attribute.name,
+                    label=user_attribute.label,
+                    type=user_attribute.type,
+                ),
+            )
         elif self.update_type == "user":
-            if self.looker_user_id:
-                sdk.delete_user_attribute_user_value(
-                    user_id=self.looker_user_id,
-                    user_attribute_id=user_attribute_id,
-                )
-            elif self.external_user_id:
-                sdk.delete_user_attribute_user_value(
-                    user_id=self.external_user_id,
-                    user_attribute_id=user_attribute_id,
-                )
-            elif self.email:
-                sdk.delete_user_attribute_user_value(
-                    user_id=self.email,
-                    user_attribute_id=user_attribute_id,
-                )
-            else:
+            looker_user_id = self._get_looker_user_id(sdk)
+            if not looker_user_id:
                 raise ValueError("User not found")
+            sdk.delete_user_attribute_user_value(
+                user_id=looker_user_id,
+                user_attribute_id=user_attribute_id,
+            )
 
     def update_user_attribute_value(self):
         if not self.value:
@@ -170,35 +180,16 @@ class UserAttributeUpdater(BaseModel):
                 ),
             )
         elif self.update_type == "user":
-
-            def set_user_attribute_user_value(user_id: str):
-                sdk.set_user_attribute_user_value(
-                    user_id=user_id,
-                    user_attribute_id=user_attribute_id,
-                    body=WriteUserAttributeWithValue(
-                        value=self.value,
-                    ),
-                )
-
-            if self.looker_user_id:
-                set_user_attribute_user_value(self.looker_user_id)
-
-            elif self.external_user_id:
-                user = sdk.user_for_credential("embed", self.external_user_id)
-                if not (user and user.id):
-                    raise ValueError("User not found")
-                set_user_attribute_user_value(user.id)
-
-            elif self.email:
-                user = sdk.user_for_credential("email", self.email)
-                if not (user and user.id):
-                    raise ValueError("User not found")
-                set_user_attribute_user_value(user.id)
-
-            else:
+            looker_user_id = self._get_looker_user_id(sdk)
+            if not looker_user_id:
                 raise ValueError("User not found")
-        else:
-            raise ValueError("Invalid update_type")
+            sdk.set_user_attribute_user_value(
+                user_id=looker_user_id,
+                user_attribute_id=user_attribute_id,
+                body=WriteUserAttributeWithValue(
+                    value=self.value,
+                ),
+            )
 
 
 class AttributeUpdaterResponse(BaseModel):

{lkr_dev_cli-0.0.29 → lkr_dev_cli-0.0.30}/lkr/tools/main.py

@@ -14,9 +14,8 @@ group = typer.Typer()
 
 @group.command()
 def user_attribute_updater(
-    ctx: typer.Context,
     host: str = typer.Option(default="127.0.0.1", envvar="HOST"),
-    port: int = typer.Option(default=8080, envvar="x`"),
+    port: int = typer.Option(default=8080, envvar="PORT"),
 ):
     api = FastAPI()
 

{lkr_dev_cli-0.0.29 → lkr_dev_cli-0.0.30}/lkr.md

@@ -1,6 +1,6 @@
 # `lkr`
 
-LookML Repository CLI
+A CLI for Looker with helpful tools
 
 **Usage**:
 

{lkr_dev_cli-0.0.29 → lkr_dev_cli-0.0.30}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lkr-dev-cli"
-version = "0.0.29"
+version = "0.0.30"
 description = "lkr: a command line interface for looker"
 readme = "README.md"
 license = "MIT"