Merge pull request #1061 from grafana/document/async-await-redis

Update redis module's documentation to use `async/await` syntax

Author: oleiade

src/data/markdown/docs/02 javascript api/07 k6-experimental/02 redis.md

@@ -27,7 +27,5 @@ which operate in a synchronous manner,
 the Redis `Client` operates in an asynchronous manner.
 In practice, this means that using the Redis `Client`'s methods won't block test execution,
 and that the test will continue to run even if the Redis `Client` isn't ready to respond to the request.
-
-This new execution model does introduce a potential caveat: to depend on operations against Redis, all following operations should be made in the context of a [promise chain](https://javascript.info/promise-chaining).
-As the [Redis Client example](/javascript-api/k6-experimental/redis/client#example) demonstrates, whenever there is a dependency on a Redis operation result or return value, the operation should be wrapped in a promise itself.
-This way, a user can perform asynchronous interactions with Redis in a seemingly synchronous manner.
+The `async` and `await` keywords enable asynchronous, promise-based behavior to be written in a cleaner style, avoiding the need to explicitly configure promise chains
+(for details, refer to the [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function)).

src/data/markdown/docs/02 javascript api/07 k6-experimental/02 redis/10 Client.md

@@ -53,51 +53,44 @@ const redisClient = new redis.Client({
 // in the context of the measureUsingRedisData function.
 const crocodileIDs = new Array(0, 1, 2, 3, 4, 5, 6, 7, 8, 9);
 
-export function measureRedisPerformance() {
+export async function measureRedisPerformance() {
   // VUs are executed in a parallel fashion,
   // thus, to ensure that parallel VUs are not
   // modifying the same key at the same time,
   // we use keys indexed by the VU id.
   const key = `foo-${exec.vu.idInTest}`;
 
-  redisClient
-    .set(`foo-${exec.vu.idInTest}`, 1)
-    .then(() => redisClient.get(`foo-${exec.vu.idInTest}`))
-    .then((value) => redisClient.incrBy(`foo-${exec.vu.idInTest}`, value))
-    .then((_) => redisClient.del(`foo-${exec.vu.idInTest}`))
-    .then((_) => redisClient.exists(`foo-${exec.vu.idInTest}`))
-    .then((exists) => {
-      if (exists !== 0) {
-        throw new Error('foo should have been deleted');
-      }
-    });
+  await redisClient.set(key, 1);
+  await redisClient.incrBy(key, 10);
+  const value = await redisClient.get(key);
+  if (value !== '11') {
+    throw new Error('foo should have been incremented to 11');
+  }
+
+  await redisClient.del(key);
+  if (await redisClient.exists(key) !== 0) {
+    throw new Error('foo should have been deleted');
+  }
 }
 
-export function setup() {
-  redisClient.sadd('crocodile_ids', ...crocodileIDs);
+export async function setup() {
+    await redisClient.sadd('crocodile_ids', ...crocodileIDs);
 }
 
-export function measureUsingRedisData() {
+export async function measureUsingRedisData() {
   // Pick a random crocodile id from the dedicated redis set,
   // we have filled in setup().
-  redisClient
-    .srandmember('crocodile_ids')
-    .then((randomID) => {
-      const url = `https://test-api.k6.io/public/crocodiles/${randomID}`;
-      const res = http.get(url);
-
-      check(res, {
-        'status is 200': (r) => r.status === 200,
-        'content-type is application/json': (r) => r.headers['content-type'] === 'application/json',
-      });
-
-      return url;
-    })
-    .then((url) => redisClient.hincrby('k6_crocodile_fetched', url, 1));
+  const randomID = await redisClient.srandmember('crocodile_ids');
+  const url = `https://test-api.k6.io/public/crocodiles/${randomID}`;
+  const res = await http.asyncRequest("GET", url);
+
+  check(res, {'status is 200': (r) => r.status === 200});
+
+  await redisClient.hincrby('k6_crocodile_fetched', url, 1);
 }
 
-export function teardown() {
-  redisClient.del('crocodile_ids');
+export async function teardown() {
+    await redisClient.del('crocodile_ids');
 }
 
 export function handleSummary(data) {

src/data/markdown/docs/02 javascript api/07 k6-experimental/02 redis/10 Client/Client-decr.md

@@ -35,13 +35,18 @@ const redisClient = new redis.Client({
   password: redis_password,
 });
 
-export default function () {
-  redisClient
-    .set('mykey', 10, 0)
-    .then((_) => redisClient.incr('mykey'))
-    .then((value) => redisClient.incrBy('mykey', value))
-    .then((value) => redisClient.decrBy('mykey', value))
-    .then((_) => redisClient.decr('mykey'));
+export default async function () {
+    await redisClient.set('mykey', 10, 0);
+    
+    let value;
+    value = await redisClient.incr('mykey');
+    value = await redisClient.incrBy('mykey', value);
+    value = await redisClient.decrBy('mykey', value);
+    value = await redisClient.decr('mykey');
+
+    if (value !== -1) {
+        throw new Error('mykey should have been -1');
+    }
 }
 ```
 

src/data/markdown/docs/02 javascript api/07 k6-experimental/02 redis/10 Client/Client-decrby.md

@@ -36,13 +36,13 @@ const redisClient = new redis.Client({
   password: redis_password,
 });
 
-export default function () {
-  redisClient
-    .set('mykey', 10, 0)
-    .then((_) => redisClient.incr('mykey'))
-    .then((value) => redisClient.incrBy('mykey', value))
-    .then((value) => redisClient.decrBy('mykey', value))
-    .then((_) => redisClient.decr('mykey'));
+export default async function () {
+    await redisClient.set('mykey', 10, 0);
+    
+    const value = await redisClient.decrBy('mykey', 2);
+    if (value !== 8) {
+        throw new Error('mykey should have been 8');
+    }
 }
 ```
 

src/data/markdown/docs/02 javascript api/07 k6-experimental/02 redis/10 Client/Client-del.md

@@ -35,19 +35,18 @@ const redisClient = new redis.Client({
   password: redis_password,
 });
 
-export default function () {
-  redisClient
-    .set('mykey', 'myvalue', 0)
-    .then((_) => redisClient.exists('mykey'))
-    .then((exists) => {
-      if (exists === false) {
+export default async function () {
+    await redisClient.set('mykey', 'myvalue', 0);
+    
+    const exists = await redisClient.exists('mykey');
+    if (exists === false) {
         throw new Error('mykey should exist');
-      }
+    }
 
-      return redisClient.get('mykey');
-    })
-    .then((value) => console.log(`set key 'mykey' to value: ${value}`))
-    .then(() => redisClient.del('mykey'));
+    const value = await redisClient.get('mykey');
+    console.log(`set key 'mykey' to value: ${value}`);
+
+    await redisClient.del('mykey');
 }
 ```
 

src/data/markdown/docs/02 javascript api/07 k6-experimental/02 redis/10 Client/Client-exists.md

@@ -35,19 +35,20 @@ const redisClient = new redis.Client({
   password: redis_password,
 });
 
-export default function () {
-  redisClient
-    .set('mykey', 'myvalue', 0)
-    .then((_) => redisClient.exists('mykey'))
-    .then((exists) => {
-      if (exists === false) {
+export default async function () {
+    let exists = await redisClient.exists('mykey');
+    if (exists === true) {
+        throw new Error('mykey should not exist');
+    }
+
+    await redisClient.set('mykey', 'myvalue', 0);
+    
+    exists = await redisClient.exists('mykey');
+    if (exists === false) {
         throw new Error('mykey should exist');
-      }
-
-      return redisClient.get('mykey');
-    })
-    .then((value) => console.log(`set key 'mykey' to value: ${value}`))
-    .then(() => redisClient.del('mykey'));
+    }
+    
+    await redisClient.del('mykey');
 }
 ```
 

src/data/markdown/docs/02 javascript api/07 k6-experimental/02 redis/10 Client/Client-expire.md

@@ -36,19 +36,15 @@ const redisClient = new redis.Client({
   password: redis_password,
 });
 
-export default function () {
-  redisClient
-    .set('mykey', 'myvalue', 10)
-    .then((_) => redisClient.expire('mykey', 100))
-    .then((_) => redisClient.ttl('mykey'))
-    .then((ttl) => {
-      if (ttl <= 10) {
-        throw new Error('mykey should have a ttl of 10 <= x < 100');
-      }
-
-      return redisClient.persist('mykey', 100);
-    });
+export default async function () {
+    await redisClient.set('mykey', 'myvalue', 10);
+    await redisClient.expire('mykey', 100);
+    
+    const ttl = await redisClient.ttl('mykey');
+    if (ttl <= 10 || ttl >= 100) {
+    throw new Error('mykey should have a ttl of 10 <= x < 100');
+    }
 }
 ```
 
-</CodeGroup>
+</CodeGroup>

src/data/markdown/docs/02 javascript api/07 k6-experimental/02 redis/10 Client/Client-get.md

@@ -35,19 +35,18 @@ const redisClient = new redis.Client({
   password: redis_password,
 });
 
-export default function () {
-  redisClient
-    .set('mykey', 'myvalue', 0)
-    .then((_) => redisClient.exists('mykey'))
-    .then((exists) => {
-      if (exists === false) {
-        throw new Error('mykey should exist');
-      }
-
-      return redisClient.get('mykey');
-    })
-    .then((value) => console.log(`set key 'mykey' to value: ${value}`))
-    .then(() => redisClient.del('mykey'));
+export default async function () {
+    await redisClient.set('mykey', 'myvalue', 0)
+    
+    const exists = await redisClient.exists('mykey');
+    if (exists === false) {
+      throw new Error('mykey should exist');
+    }
+
+    const value = await redisClient.get('mykey');
+    console.log(`set key 'mykey' to value: ${value}`);
+    
+    await redisClient.del('mykey');
 }
 ```
 

src/data/markdown/docs/02 javascript api/07 k6-experimental/02 redis/10 Client/Client-getdel.md

@@ -35,11 +35,14 @@ const redisClient = new redis.Client({
   password: redis_password,
 });
 
-export default function () {
-  redisClient
-    .set('mykey', 'oldvalue', 0)
-    .then((_) => redisClient.getSet('mykey', 'newvalue'))
-    .then((_) => redisClient.getDel('mykey'));
+export default async function () {
+    await redisClient.set('mykey', 'oldvalue', 0);
+    let value = await redisClient.getSet('mykey', 'newvalue');
+    
+    value = await redisClient.getDel('mykey');
+    if (value !== 'newvalue') {
+        throw new Error('mykey should have been newvalue');
+    }
 }
 ```
 

src/data/markdown/docs/02 javascript api/07 k6-experimental/02 redis/10 Client/Client-getset.md

@@ -36,11 +36,10 @@ const redisClient = new redis.Client({
   password: redis_password,
 });
 
-export default function () {
-  redisClient
-    .set('mykey', 'oldvalue', 0)
-    .then((_) => redisClient.getSet('mykey', 'newvalue'))
-    .then((_) => redisClient.getDel('mykey'));
+export default async function () {
+    await redisClient.set('mykey', 'oldvalue', 0);
+    await redisClient.getSet('mykey', 'newvalue');
+    await redisClient.getDel('mykey');
 }
 ```