Add run_attempt as an optional key column for github_actions_repository_workflow_run get calls

[tsibley]

builds upon #463, but that PR can be considered separately from this one

This is the bare minimum to allow previous run attempts to be queried, which is useful for comparisons between attempts. User queries must explicitly iterate over a run's multiple attempts as necessary, e.g. by parsing previous_attempt_url in a with recursive CTE or simply presuming the series of attempts is generate_series(1, run_attempt).

A future improvement for this plugin might be exposing a new table, e.g. github_actions_repository_workflow_run_attempt, with the same list key columns of repository_full_name and id, and handling the iteration internally. GitHub's API unfortunately provides no listing endpoints for run attempts.

[misraved]

@tsibley is there a specific reason for adding CacheMatch: "exact" to this optional qual? It is typically used for columns that are populated using FromQuals.

[ParthaI]

@misraved, @tsibley,

From my understanding, we don’t need to include CacheMatch: "exact" for these optional qualifiers here. This is because the run_attempt optional qualifier is part of the Get config, not the List config.

According to the table design, the Get API call should always return a single row. In this table, the unique identifier is the id column, which is unique per row.

Query, result:

List Config execution:

> select id, run_attempt from github_actions_repository_workflow_run where repository_full_name = 'turbot/steampipe-plugin-aws' and  run_attempt > 2
+-------------+-------------+
| id          | run_attempt |
+-------------+-------------+
| 11666032178 | 3           |
| 10667532782 | 3           |
| 9872917837  | 5           |
| 8801296800  | 3           |
| 8753110746  | 3           |
| 8296554622  | 3           |
| 8065062549  | 4           |
| 8076825093  | 3           |
| 7887624205  | 3           |
| 7358331805  | 4           |
+-------------+-------------+

Get Config execution:

> select id, run_attempt from github_actions_repository_workflow_run where repository_full_name = 'turbot/steampipe-plugin-aws' and id = 7358331805 and run_attempt = 4
+------------+-------------+
| id         | run_attempt |
+------------+-------------+
| 7358331805 | 4           |
+------------+-------------+

[tsibley]

@ParthaI id is unique per row only because List can only return the latest run_attempt. A single id has multiple run attempts, though, and so the Get call needs to consider it as part of the key.

@misraved Without CacheMatch: "exact", there are false positive cache hits on a Get after a List when accessing previous run attempts.

[ParthaI]

@ParthaI id is unique per row only because List can only return the latest run_attempt. A single id has multiple run attempts, though, and so the Get call needs to consider it as part of the key.

Apologies for the misunderstanding, @tsibley. I was unaware of the API behaviour. It makes perfect sense to include CacheMatch: "exact" for the run_attempt optional key column qualifier. Thank you for clarifying!

Query result WITHOUT CacheMatch: "exact":

> select id, run_attempt from github_actions_repository_workflow_run where repository_full_name = 'turbot/steampipe-plugin-aws' and id = 7358331805
+------------+-------------+
| id         | run_attempt |
+------------+-------------+
| 7358331805 | 4           |
+------------+-------------+

Time: 1.7s. Rows returned: 0. Rows fetched: 1. Hydrate calls: 0.
> select id, run_attempt from github_actions_repository_workflow_run where repository_full_name = 'turbot/steampipe-plugin-aws' and id = 7358331805 and run_attempt = 1
+----+-------------+
| id | run_attempt |
+----+-------------+
+----+-------------+

Time: 20ms. Rows returned: 0. Rows fetched: 1 (cached). Hydrate calls: 0.

Query result WITH CacheMatch: "exact":

> select id, run_attempt from github_actions_repository_workflow_run where repository_full_name = 'turbot/steampipe-plugin-aws' and id = 7358331805
+------------+-------------+
| id         | run_attempt |
+------------+-------------+
| 7358331805 | 4           |
+------------+-------------+

Time: 1.7s. Rows returned: 0. Rows fetched: 1. Hydrate calls: 0.
> select id, run_attempt from github_actions_repository_workflow_run where repository_full_name = 'turbot/steampipe-plugin-aws' and id = 7358331805 and run_attempt = 1
+------------+-------------+
| id         | run_attempt |
+------------+-------------+
| 7358331805 | 1           |
+------------+-------------+

Time: 451ms. Rows returned: 0. Rows fetched: 1. Hydrate calls: 0.

Additionally, could you please use CacheMatch: query_cache.CacheMatchExact instead of CacheMatch: "exact"? For reference, you can check this example: AWS CloudControl Resource Table.

[tsibley]

I’ve swapped out the string literal for the symbol. Thanks for the pointer to it. I’d originally looked for it (quickly) but didn’t find it and the explanatory code comments used the string literal so I used that too.