Merge pull request Shopify#310 from Shopify/paulo/update_api_versions

Update supported Admin API versions

Author: paulomarg

Diff for: CHANGELOG.md

@@ -9,6 +9,7 @@ and adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ### Added
 
+- ⚠️ [Breaking] Update supported Admin API versions [#310](https://github.com/Shopify/shopify-node-api/pull/310)
 - Allow full paths in REST requests [#301](https://github.com/Shopify/shopify-node-api/pull/301)
 
 ### Fixed

Diff for: src/base_types.ts

@@ -16,20 +16,12 @@ export interface ContextParams {
 }
 
 export enum ApiVersion {
-  April19 = '2019-04',
-  July19 = '2019-07',
-  October19 = '2019-10',
-  January20 = '2020-01',
-  April20 = '2020-04',
-  July20 = '2020-07',
-  October20 = '2020-10',
-  January21 = '2021-01',
   April21 = '2021-04',
   July21 = '2021-07',
   October21 = '2021-10',
   January22 = '2022-01',
+  April22 = '2022-04',
   Unstable = 'unstable',
-  Unversioned = 'unversioned',
 }
 
 export enum ShopifyHeader {

Diff for: src/utils/version-compatible.ts

@@ -9,10 +9,7 @@ export default function versionCompatible(
   currentVersion: ApiVersion = Context.API_VERSION,
 ): boolean {
   // Return true if not using a dated version
-  if (
-    currentVersion === ApiVersion.Unstable ||
-    currentVersion === ApiVersion.Unversioned
-  ) {
+  if (currentVersion === ApiVersion.Unstable) {
     return true;
   }
   const numericVersion = (version: string) =>

Diff for: src/webhooks/registry.ts

@@ -15,7 +15,6 @@ import {
   RegisterReturn,
   WebhookRegistryEntry,
   WebhookCheckResponse,
-  WebhookCheckResponseLegacy,
   ShortenedRegisterOptions,
 } from './types';
 
@@ -113,35 +112,20 @@ function isSuccess(
   );
 }
 
-// 2020-07 onwards
-function versionSupportsEndpointField() {
-  return ShopifyUtilities.versionCompatible(ApiVersion.July20);
-}
-
 function versionSupportsPubSub() {
   return ShopifyUtilities.versionCompatible(ApiVersion.July21);
 }
 
 function validateDeliveryMethod(deliveryMethod: DeliveryMethod) {
-  if (
-    deliveryMethod === DeliveryMethod.EventBridge &&
-    !versionSupportsEndpointField()
-  ) {
-    throw new ShopifyErrors.UnsupportedClientType(
-      `EventBridge webhooks are not supported in API version "${Context.API_VERSION}".`,
-    );
-  } else if (
-    deliveryMethod === DeliveryMethod.PubSub &&
-    !versionSupportsPubSub()
-  ) {
+  if (deliveryMethod === DeliveryMethod.PubSub && !versionSupportsPubSub()) {
     throw new ShopifyErrors.UnsupportedClientType(
       `Pub/Sub webhooks are not supported in API version "${Context.API_VERSION}".`,
     );
   }
 }
 
 function buildCheckQuery(topic: string): string {
-  const query = `{
+  return `{
     webhookSubscriptions(first: 1, topics: ${topic}) {
       edges {
         node {
@@ -167,19 +151,6 @@ function buildCheckQuery(topic: string): string {
       }
     }
   }`;
-
-  const legacyQuery = `{
-    webhookSubscriptions(first: 1, topics: ${topic}) {
-      edges {
-        node {
-          id
-          callbackUrl
-        }
-      }
-    }
-  }`;
-
-  return versionSupportsEndpointField() ? query : legacyQuery;
 }
 
 function buildQuery(
@@ -243,7 +214,10 @@ function buildQuery(
 const WebhooksRegistry: RegistryInterface = {
   webhookRegistry: {},
 
-  addHandler(topic: string, {path, webhookHandler}: WebhookRegistryEntry): void {
+  addHandler(
+    topic: string,
+    {path, webhookHandler}: WebhookRegistryEntry,
+  ): void {
     WebhooksRegistry.webhookRegistry[topic] = {path, webhookHandler};
   },
 
@@ -256,7 +230,7 @@ const WebhooksRegistry: RegistryInterface = {
   },
 
   getHandler(topic: string): WebhookRegistryEntry | null {
-    return topic in WebhooksRegistry.webhookRegistry ? WebhooksRegistry.webhookRegistry[topic] : null;
+    return WebhooksRegistry.webhookRegistry[topic] ?? null;
   },
 
   getTopics(): string[] {
@@ -279,21 +253,18 @@ const WebhooksRegistry: RegistryInterface = {
         : path;
     const checkResult = (await client.query({
       data: buildCheckQuery(topic),
-    })) as {body: WebhookCheckResponse | WebhookCheckResponseLegacy;};
+    })) as {body: WebhookCheckResponse;};
     let webhookId: string | undefined;
     let mustRegister = true;
     if (checkResult.body.data.webhookSubscriptions.edges.length) {
       const {node} = checkResult.body.data.webhookSubscriptions.edges[0];
       let endpointAddress = '';
-      if ('endpoint' in node) {
-        if (node.endpoint.__typename === 'WebhookHttpEndpoint') {
-          endpointAddress = node.endpoint.callbackUrl;
-        } else if (node.endpoint.__typename === 'WebhookEventBridgeEndpoint') {
-          endpointAddress = node.endpoint.arn;
-        }
-      } else {
-        endpointAddress = node.callbackUrl;
+      if (node.endpoint.__typename === 'WebhookHttpEndpoint') {
+        endpointAddress = node.endpoint.callbackUrl;
+      } else if (node.endpoint.__typename === 'WebhookEventBridgeEndpoint') {
+        endpointAddress = node.endpoint.arn;
       }
+
       webhookId = node.id;
       if (endpointAddress === address) {
         mustRegister = false;
@@ -336,7 +307,7 @@ const WebhooksRegistry: RegistryInterface = {
           shop,
           deliveryMethod,
         };
-        const returnedRegister: RegisterReturn = await WebhooksRegistry.register(webhook);
+        const returnedRegister = await WebhooksRegistry.register(webhook);
         registerReturn = {...registerReturn, ...returnedRegister};
       }
     }
@@ -414,7 +385,9 @@ const WebhooksRegistry: RegistryInterface = {
           .digest('base64');
 
         if (ShopifyUtilities.safeCompare(generatedHash, hmac as string)) {
-          const graphqlTopic = (topic as string).toUpperCase().replace(/\//g, '_');
+          const graphqlTopic = (topic as string)
+            .toUpperCase()
+            .replace(/\//g, '_');
           const webhookEntry = WebhooksRegistry.getHandler(graphqlTopic);
 
           if (webhookEntry) {