feat(Tagging): Allow tags to be set by client

Author: cblanc

lib/client.ts

@@ -64,6 +64,12 @@ export interface Config {
    * String map specifying default headers
    */
   header: Header;
+  /**
+   * Append tags to helper requests like `lookupPostcode` and `lookupUDPRN`
+   *
+   * Tags attached to the client are overwritten on an request if it is also specified in the helper request options
+   */
+  tags: string[];
 }
 
 interface Defaults {
@@ -170,6 +176,7 @@ export class Client {
   readonly timeout: number;
   readonly agent: Agent;
   readonly header: Header;
+  readonly tags: string[];
   readonly postcodes: PostcodeResource;
   readonly addresses: AddressResource;
   readonly udprn: UdprnResource;
@@ -187,6 +194,7 @@ export class Client {
     this.strictAuthorisation = config.strictAuthorisation;
     this.timeout = config.timeout;
     this.agent = config.agent;
+    this.tags = config.tags;
     this.header = { ...Client.defaults.header, ...config.header };
     this.postcodes = createPostcodeResource(this);
     this.addresses = createAddressResource(this);
@@ -262,7 +270,7 @@ export class Client {
     appendAuthorization({ client: this, header, options });
     appendIp({ header, options });
     appendFilter({ query, options });
-    appendTags({ query, options });
+    appendTags({ client: this, query, options });
     appendPage({ query, options });
 
     const queryOptions: Request = { header, query };
@@ -287,7 +295,7 @@ export class Client {
     appendAuthorization({ client: this, header, options });
     appendIp({ header, options });
     appendFilter({ query, options });
-    appendTags({ query, options });
+    appendTags({ client: this, query, options });
 
     const request: Request = { header, query };
     if (options.timeout !== undefined) request.timeout = options.timeout;

lib/util.ts

@@ -172,16 +172,20 @@ export const appendFilter = ({
 };
 
 interface AppendTagsOptions {
+  client: Client;
   query: StringMap;
   options: Taggable;
 }
 
 // Adds tags to query
 export const appendTags = ({
+  client,
   query,
   options,
 }: AppendTagsOptions): StringMap => {
-  const { tags } = options;
+  let tags: string[] | undefined;
+  if (client.tags.length) tags = client.tags;
+  if (options.tags) tags = options.tags;
   if (tags !== undefined) query.tags = tags.join(",");
   return query;
 };

test/helper/index.ts

@@ -31,6 +31,7 @@ const defaultConfig: Config = Object.freeze({
   timeout: TIMEOUT,
   agent: new TestAgent(),
   header: {},
+  tags: [],
 });
 
 const TEN_SECONDS = 10000;

test/util.ts

@@ -219,19 +219,42 @@ describe("appendFilter", () => {
 });
 
 describe("appendTags", () => {
+  it("appends tags if configured on client", () => {
+    const tags = ["client"];
+    const client = new Client({ ...newConfig(), tags });
+    const query = {};
+    const options = { tags };
+    const result = appendTags({ client, query, options });
+    assert.equal(query, result);
+    assert.equal(result.tags, "client");
+  });
+
+  it("gives precendence to tags from options", () => {
+    const tags = ["client"];
+    const client = new Client({ ...newConfig(), tags });
+    const query = {};
+    const queryTags = ["foo", "bar"];
+    const options = { tags: queryTags };
+    const result = appendTags({ client, query, options });
+    assert.equal(query, result);
+    assert.equal(result.tags, "foo,bar");
+  });
+
   it("appends tags to query object", () => {
+    const client = new Client({ ...newConfig() });
     const query = {};
     const tags = ["foo", "bar"];
     const options = { tags };
-    const result = appendTags({ query, options });
+    const result = appendTags({ client, query, options });
     assert.equal(query, result);
     assert.equal(result.tags, "foo,bar");
   });
 
   it("does not change headers if left unspecified", () => {
+    const client = new Client({ ...newConfig() });
     const query = {};
     const options = {};
-    const result = appendTags({ query, options });
+    const result = appendTags({ client, query, options });
     assert.deepEqual(result, {});
   });
 });