fix(db): correct arguments for get_task_queue_wm_2,

matt-boris · matt-boris · commit a850e992145f · 2022-06-02T16:01:04.000-04:00
deprecates `get_task_queue_wm`.
diff --git a/changelog/ENyXasvtT-mjBKqpaVztug.md b/changelog/ENyXasvtT-mjBKqpaVztug.md
@@ -0,0 +1,4 @@
+audience: general
+level: patch
+---
+Fix arguments for `get_task_queue_wm_2` (`get_task_queue_wm` is now deprecated).
diff --git a/db/fns.md b/db/fns.md
@@ -147,7 +147,7 @@
    * [`get_non_stopped_workers_quntil_providers`](#get_non_stopped_workers_quntil_providers)
    * [`get_queue_worker_with_wm_join`](#get_queue_worker_with_wm_join)
    * [`get_queue_workers_with_wm_join`](#get_queue_workers_with_wm_join)
-   * [`get_task_queue_wm`](#get_task_queue_wm)
+   * [`get_task_queue_wm_2`](#get_task_queue_wm_2)
    * [`get_task_queues_wm`](#get_task_queues_wm)
    * [`get_worker_2`](#get_worker_2)
    * [`get_worker_pool_error`](#get_worker_pool_error)
@@ -2327,7 +2327,7 @@ If the hashed session id does not exist, then an error code `P0002` will be thro
 * [`get_non_stopped_workers_quntil_providers`](#get_non_stopped_workers_quntil_providers)
 * [`get_queue_worker_with_wm_join`](#get_queue_worker_with_wm_join)
 * [`get_queue_workers_with_wm_join`](#get_queue_workers_with_wm_join)
-* [`get_task_queue_wm`](#get_task_queue_wm)
+* [`get_task_queue_wm_2`](#get_task_queue_wm_2)
 * [`get_task_queues_wm`](#get_task_queues_wm)
 * [`get_worker_2`](#get_worker_2)
 * [`get_worker_pool_error`](#get_worker_pool_error)
@@ -2555,22 +2555,20 @@ If the pagination arguments are both NULL, all rows are returned.
 Otherwise, page_size rows are returned at offset page_offset.
 This also performs an outer join with the worker_manager.worker table for more data.
 
-### get_task_queue_wm
+### get_task_queue_wm_2
 
 * *Mode*: read
 * *Arguments*:
   * `task_queue_id_in text`
   * `expires_in timestamptz`
-  * `page_size_in integer`
-  * `page_offset_in integer`
 * *Returns*: `table`
   * `task_queue_id text`
   * `expires timestamptz`
   * `last_date_active timestamptz`
   * `description text`
   * `stability text`
   * `etag uuid`
-* *Last defined on version*: 74
+* *Last defined on version*: 75
 
 Get a non-expired task queue by task_queue_id.
 
@@ -2857,6 +2855,7 @@ the return value is an empty set.
 ### deprecated methods
 
 * `get_non_stopped_workers_quntil(worker_pool_id_in text, worker_group_in text, worker_id_in text, page_size_in integer, page_offset_in integer)` (compatibility guaranteed until v46.0.0)
+* `get_task_queue_wm(task_queue_id_in text, expires_in timestamptz, page_size_in integer, page_offset_in integer)` (compatibility guaranteed until v46.0.0)
 * `get_worker_pool_with_capacity(worker_pool_id_in text)` (compatibility guaranteed until v46.0.0)
 * `get_worker_pools_with_capacity(page_size_in integer, page_offset_in integer)` (compatibility guaranteed until v46.0.0)
 * `update_worker_pool_with_capacity(worker_pool_id_in text, provider_id_in text, description_in text, config_in jsonb, last_modified_in timestamptz, owner_in text, email_on_error_in boolean)` (compatibility guaranteed until v46.0.0)
diff --git a/db/test/fns/worker_manager_test.js b/db/test/fns/worker_manager_test.js
@@ -1103,4 +1103,16 @@ suite(testing.suiteName(), function() {
       assert.equal(pools[1].current_capacity, 5);
     });
   });
+
+  suite(`${testing.suiteName()} - TaskQueue`, function() {
+    helper.dbTest('no such task queue', async function(db) {
+      const res = await db.fns.get_task_queue_wm_2('prov/wt', new Date());
+      assert.deepEqual(res, []);
+    });
+
+    helper.dbTest('get_task_queues_wm empty', async function(db) {
+      const res = await db.fns.get_task_queues_wm(null, null, null, null);
+      assert.deepEqual(res, []);
+    });
+  });
 });
diff --git a/db/test/versions/0075_test.js b/db/test/versions/0075_test.js
@@ -0,0 +1,6 @@
+const testing = require('taskcluster-lib-testing');
+
+suite(testing.suiteName(), function() {
+  // this version only updates method,
+  // to trigger index usage, so no tests are needed
+});
diff --git a/db/versions/0075.yml b/db/versions/0075.yml
@@ -0,0 +1,27 @@
+version: 75
+description: fix get_task_queue_wm args
+methods:
+  get_task_queue_wm:
+    deprecated: true
+  get_task_queue_wm_2:
+    description: |-
+      Get a non-expired task queue by task_queue_id.
+    mode: read
+    serviceName: worker_manager
+    args: task_queue_id_in text, expires_in timestamptz
+    returns: table(task_queue_id text, expires timestamptz, last_date_active timestamptz, description text, stability text, etag uuid)
+    body: |-
+      begin
+        return query
+        select
+          task_queues.task_queue_id,
+          task_queues.expires,
+          task_queues.last_date_active,
+          task_queues.description,
+          task_queues.stability,
+          public.gen_random_uuid()
+        from task_queues
+        where
+          task_queues.task_queue_id = task_queue_id_in and
+          task_queues.expires > expires_in;
+        end
diff --git a/db/versions/README.md b/db/versions/README.md
@@ -84,4 +84,5 @@ If this invariant is violated, it must be indicated clearly in the changelog.
 | [0072](./0072.yml) | v44.12.0 | add last_date_active to queue_workers |
 | [0073](./0073.yml) | v44.15.0 | include worker manager data to in queue worker responses |
 | [0074](./0074.yml) | v44.15.3 | get task queue(s) via worker manager service |
+| [0075](./0075.yml) | (pending release) | fix get_task_queue_wm args |
 <!-- AUTOGENERATED DO NOT EDIT - END -->
diff --git a/generated/db-schema.json b/generated/db-schema.json
diff --git a/services/worker-manager/src/queue-data.js b/services/worker-manager/src/queue-data.js
@@ -42,7 +42,7 @@ class TaskQueue {
 
   // Get a worker type from the DB, or undefined
   static async get(db, taskQueueId, expires) {
-    return TaskQueue.fromDbRows(await db.fns.get_task_queue_wm(taskQueueId, expires));
+    return TaskQueue.fromDbRows(await db.fns.get_task_queue_wm_2(taskQueueId, expires));
   }
 
   // Call db.get_task_queues.

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ class TaskQueue {`
`42`	`42`
`43`	`43`	`// Get a worker type from the DB, or undefined`
`44`	`44`	`static async get(db, taskQueueId, expires) {`
`45`		`- return TaskQueue.fromDbRows(await db.fns.get_task_queue_wm(taskQueueId, expires));`
	`45`	`+ return TaskQueue.fromDbRows(await db.fns.get_task_queue_wm_2(taskQueueId, expires));`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`// Call db.get_task_queues.`