fix(connect): set legacyGet header to true on cache.get and data.get #531

This will allow consumers who would like to use the legacy format to forcibly
continue doing so, even after the default in hyper is set to the new API

Author: TillaTheHun0

packages/connect/deno/mod.ts

@@ -33,11 +33,7 @@ export * from "./types.ts";
 
 export { createHyperVerify } from "./utils/hyper-verify.ts";
 
-export function connect(
-  CONNECTION_STRING: string,
-  // deno-lint-ignore no-inferrable-types
-  domain: string = "default",
-): Hyper {
+export function connect(CONNECTION_STRING: string, domain = "default"): Hyper {
   const config = new URL(CONNECTION_STRING);
 
   const h = async (hyperRequest: HyperRequest) => {
@@ -64,8 +60,6 @@ export function connect(
       .then((r) => (response.ok ? r : assoc("status", response.status, r)))
       .then((r) => (response.status >= 500 ? Promise.reject(r) : r));
 
-  //const log = (x: any) => (console.log(x), x);
-
   return {
     data: {
       add: (body) =>

packages/connect/deno/services/cache.ts

@@ -4,6 +4,7 @@ import {
   HyperRequestFunction,
   Method,
 } from "../types.ts";
+import { HYPER_LEGACY_GET_HEADER } from "../utils/hyper-request.ts";
 
 const service = "cache" as const;
 
@@ -14,21 +15,29 @@ export const add =
   (key: string, value: unknown, ttl?: string) => (h: HyperRequestFunction) =>
     h({ service, method: Method.POST, body: { key, value, ttl } });
 
-export const get = (key: string) => (h: HyperRequestFunction) =>
-  h({ service, method: Method.GET, resource: key });
+export const get = (key: string) => (h: HyperRequestFunction) => {
+  return h({
+    service,
+    method: Method.GET,
+    headers: new Headers({
+      [HYPER_LEGACY_GET_HEADER]: "true",
+    }),
+    resource: key,
+  });
+};
 
 export const remove = (key: string) => (h: HyperRequestFunction) =>
   h({ service, method: Method.DELETE, resource: key });
 
 export const set =
   (key: string, value: unknown, ttl?: string) => (h: HyperRequestFunction) =>
     h(
-      [{ service, method: Method.PUT, resource: key, body: value }]
-        .map(includeTTL(ttl))[0],
+      [{ service, method: Method.PUT, resource: key, body: value }].map(
+        includeTTL(ttl),
+      )[0],
     );
 
-// deno-lint-ignore no-inferrable-types
-export const query = (pattern: string = "*") => (h: HyperRequestFunction) =>
+export const query = (pattern = "*") => (h: HyperRequestFunction) =>
   h({
     service,
     method: Method.POST,

packages/connect/deno/services/data.ts

@@ -7,13 +7,22 @@ import {
   Method,
   QueryOptions,
 } from "../types.ts";
+import { HYPER_LEGACY_GET_HEADER } from "../utils/hyper-request.ts";
 
 const service = "data" as const;
 
 export const add = (body: unknown) => (hyper: HyperRequestFunction) =>
   hyper({ service, method: Method.POST, body });
-export const get = (id: string) => (hyper: HyperRequestFunction) =>
-  hyper({ service, method: Method.GET, resource: id });
+export const get = (id: string) => (hyper: HyperRequestFunction) => {
+  return hyper({
+    service,
+    method: Method.GET,
+    headers: new Headers({
+      [HYPER_LEGACY_GET_HEADER]: "true",
+    }),
+    resource: id,
+  });
+};
 export const list =
   (options: ListOptions = {}) => (hyper: HyperRequestFunction) =>
     hyper({ service, method: Method.GET, params: options });

packages/connect/deno/tests/cache.ts

@@ -10,6 +10,7 @@ import {
   remove,
   set,
 } from "../services/cache.ts";
+import { HYPER_LEGACY_GET_HEADER } from "../utils/hyper-request.ts";
 
 const test = Deno.test;
 
@@ -37,8 +38,10 @@ test("cache.get", async () => {
     assertEquals(h.service, "cache");
     assertEquals(h.method, "GET");
     assertEquals(h.resource, "game-1");
+    assertEquals(h.headers?.get(HYPER_LEGACY_GET_HEADER), "true");
     return Promise.resolve(new Request("http://localhost"));
   };
+
   await get("game-1")(mockRequest);
 });
 

packages/connect/deno/tests/data.ts

@@ -13,6 +13,7 @@ import {
   remove,
   update,
 } from "../services/data.ts";
+import { HYPER_LEGACY_GET_HEADER } from "../utils/hyper-request.ts";
 
 const test = Deno.test;
 
@@ -38,8 +39,10 @@ test("data.get", async () => {
     assertEquals(h.service, "data");
     assertEquals(h.method, "GET");
     assertEquals(h.resource, "game-1");
+    assertEquals(h.headers?.get(HYPER_LEGACY_GET_HEADER), "true");
     return Promise.resolve(new Request("http://localhost"));
   };
+
   await get("game-1")(mockRequest);
 });