Adding tooling for REST resources

Co-authored-by: Jason Kurian <[email protected]>

Author: paulomarg

.eslintrc.js

@@ -4,18 +4,19 @@ module.exports = {
     es2021: true,
   },
   extends: ['plugin:@shopify/typescript', 'plugin:@shopify/prettier'],
-  ignorePatterns: ['dist/'],
+  ignorePatterns: ['dist/', 'src/rest-resources'],
   rules: {
     'import/no-named-as-default': 0,
     'no-mixed-operators': 0,
     'no-console': 0,
+    'lines-around-comment': 0,
   },
   overrides: [
     {
       files: [
-        'src/rest_resources/__tests__/*.ts',
-        'src/rest_resources/base.ts',
-        'src/rest_resources/admin*/*.ts',
+        'src/__tests__/*.ts',
+        'src/base-rest-resource.ts',
+        'src/rest-resources/*',
       ],
       rules: {
         '@typescript-eslint/naming-convention': [

.github/workflows/workflow.yml

@@ -14,3 +14,5 @@ jobs:
         run: yarn lint
       - name: Test
         run: yarn test
+      - name: Test REST resources
+        run: yarn test_rest_resources

jest.config.js

@@ -1,5 +1,10 @@
 module.exports = {
-  preset: 'ts-jest',
+  preset: 'ts-jest/presets/default-esm', // or other ESM presets
+  globals: {
+    'ts-jest': {
+      useESM: true,
+    },
+  },
   testEnvironment: 'node',
   moduleFileExtensions: ['ts', 'js', 'json'],
   watchPathIgnorePatterns: ['<rootDir>/node_modules/'],

package.json

@@ -6,7 +6,8 @@
   "types": "dist/index.d.ts",
   "prettier": "@shopify/prettier-config",
   "scripts": {
-    "test": "jest",
+    "test": "jest --testPathIgnorePatterns=src/rest-resources/__tests__",
+    "test_rest_resources": "ls src/rest-resources/__tests__ | xargs -I \"{}\" sh -c 'yarn jest --no-coverage --testPathPattern=\\\"{}\\\" || exit 255'",
     "build": "tsc",
     "lint": "eslint '**/*.{ts,tsx}' --max-warnings 0",
     "clean": "rimraf ./dist tsconfig.tsbuildinfo",
@@ -71,4 +72,4 @@
     "dist/*",
     "!tsconfig.tsbuildinfo"
   ]
-}
+}

src/rest_resources/__tests__/base.test.ts src/__tests__/base-rest-resource.test.ts

@@ -1,8 +1,8 @@
-import {Session} from '../../auth/session';
-import {RestResourceRequestError} from '../../error';
+import {Session} from '../auth/session';
+import {RestResourceRequestError} from '../error';
 
-import FakeResource from './fake_resource';
-import FakeResourceWithCustomPrefix from './fake_resource_with_custom_prefix';
+import FakeResource from './fake-resource';
+import FakeResourceWithCustomPrefix from './fake-resource-with-custom-prefix';
 
 describe('Base REST resource', () => {
   const domain = 'test-shop.myshopify.io';

src/__tests__/context.test.ts

@@ -2,7 +2,7 @@ import Cookies from 'cookies';
 
 import * as ShopifyErrors from '../error';
 import {Context} from '../context';
-import {ApiVersion, ContextParams} from '../base_types';
+import {ApiVersion, ContextParams} from '../base-types';
 
 jest.mock('cookies');
 

src/rest_resources/__tests__/fake_resource_with_custom_prefix.ts src/__tests__/fake-resource-with-custom-prefix.ts

@@ -1,5 +1,5 @@
-import Base, {ResourcePath} from '../base';
-import {SessionInterface} from '../../auth/session/types';
+import Base, {ResourcePath} from '../base-rest-resource';
+import {SessionInterface} from '../auth/session/types';
 
 interface FakeResourceWithCustomPrefixFindArgs {
   session: SessionInterface;

src/rest_resources/__tests__/fake_resource.ts src/__tests__/fake-resource.ts

@@ -1,5 +1,5 @@
-import Base, {ParamSet, ResourcePath} from '../base';
-import {SessionInterface} from '../../auth/session/types';
+import Base, {ParamSet, ResourcePath} from '../base-rest-resource';
+import {SessionInterface} from '../auth/session/types';
 
 interface FakeResourceFindArgs {
   params?: ParamSet;

src/rest_resources/base.ts src/base-rest-resource.ts

@@ -2,11 +2,11 @@ import {
   HttpResponseError,
   RestResourceError,
   RestResourceRequestError,
-} from '../error';
-import {SessionInterface} from '../auth/session/types';
-import {RestClient} from '../clients/rest';
-import {RestRequestReturn} from '../clients/rest/types';
-import {DataType, GetRequestParams} from '../clients/http_client/types';
+} from './error';
+import {SessionInterface} from './auth/session/types';
+import {RestClient} from './clients/rest';
+import {RestRequestReturn} from './clients/rest/types';
+import {DataType, GetRequestParams} from './clients/http_client/types';
 
 export interface IdSet {
   [id: string]: string | number | null;

src/base_types.ts src/base-types.ts

@@ -1,4 +1,4 @@
-import {ShopifyHeader} from '../../../base_types';
+import {ShopifyHeader} from '../../../base-types';
 import {GraphqlClient} from '../graphql_client';
 import {Context} from '../../../context';
 import * as ShopifyErrors from '../../../error';

src/clients/graphql/__tests__/graphql_client.test.ts

@@ -1,4 +1,4 @@
-import {ShopifyHeader} from '../../../base_types';
+import {ShopifyHeader} from '../../../base-types';
 import {StorefrontClient} from '../storefront_client';
 import {Context} from '../../../context';
 

src/clients/graphql/__tests__/storefront_client.test.ts

@@ -1,6 +1,6 @@
 import {MissingRequiredArgument} from '../../error';
 import {Context} from '../../context';
-import {ShopifyHeader} from '../../base_types';
+import {ShopifyHeader} from '../../base-types';
 import {HttpClient} from '../http_client/http_client';
 import {DataType, RequestReturn} from '../http_client/types';
 import * as ShopifyErrors from '../../error';

src/clients/graphql/graphql_client.ts

@@ -1,5 +1,5 @@
 import {Context} from '../../context';
-import {ShopifyHeader} from '../../base_types';
+import {ShopifyHeader} from '../../base-types';
 
 import {GraphqlClient, AccessTokenHeader} from './graphql_client';
 

src/clients/graphql/storefront_client.ts

@@ -1,6 +1,6 @@
 import querystring from 'querystring';
 
-import {ShopifyHeader} from '../../../base_types';
+import {ShopifyHeader} from '../../../base-types';
 import {DataType, GetRequestParams} from '../../http_client/types';
 import {RestClient} from '../rest_client';
 import {RestRequestReturn, PageInfo} from '../types';

src/clients/rest/__tests__/rest_client.test.ts

@@ -1,7 +1,7 @@
 import querystring from 'querystring';
 
 import {Context} from '../../context';
-import {ShopifyHeader} from '../../base_types';
+import {ShopifyHeader} from '../../base-types';
 import {HttpClient} from '../http_client/http_client';
 import {RequestParams, GetRequestParams} from '../http_client/types';
 import * as ShopifyErrors from '../../error';

src/clients/rest/rest_client.ts

@@ -1,7 +1,7 @@
 import * as ShopifyErrors from './error';
 import {SessionStorage} from './auth/session/session_storage';
 import {MemorySessionStorage} from './auth/session/storage/memory';
-import {ApiVersion, ContextParams} from './base_types';
+import {ApiVersion, ContextParams} from './base-types';
 import {AuthScopes} from './auth/scopes';
 
 interface ContextInterface extends ContextParams {

src/context.ts

@@ -1,4 +1,4 @@
-export * from './base_types';
+export * from './base-types';
 export * from './auth/types';
 export * from './clients/types';
 export * from './utils/types';

src/types.ts

@@ -1,10 +1,10 @@
-import {enableFetchMocks} from 'jest-fetch-mock';
+import fetchMock from 'jest-fetch-mock';
 
 import {Context} from '../context';
-import {ApiVersion} from '../base_types';
+import {ApiVersion} from '../base-types';
 import {MemorySessionStorage} from '../auth/session';
 
-enableFetchMocks();
+fetchMock.enableMocks();
 
 let currentCall = 0;
 beforeEach(() => {

src/utils/setup-jest.ts

@@ -1,5 +1,5 @@
 import {Context} from '../context';
-import {ApiVersion} from '../base_types';
+import {ApiVersion} from '../base-types';
 
 /**
  * Check if the current or optionally supplied version is compatible with a given version

src/utils/version-compatible.ts

@@ -5,7 +5,7 @@ import request from 'supertest';
 import {Method, Header, StatusCode} from '@shopify/network';
 
 import {DeliveryMethod, RegisterOptions, RegisterReturn} from '../types';
-import {ApiVersion, ShopifyHeader} from '../../base_types';
+import {ApiVersion, ShopifyHeader} from '../../base-types';
 import {Context} from '../../context';
 import {DataType} from '../../clients/types';
 import ShopifyWebhooks from '..';

src/webhooks/__tests__/registry.test.ts

@@ -4,7 +4,7 @@ import http from 'http';
 import {StatusCode} from '@shopify/network';
 
 import {GraphqlClient} from '../clients/graphql/graphql_client';
-import {ApiVersion, ShopifyHeader} from '../base_types';
+import {ApiVersion, ShopifyHeader} from '../base-types';
 import ShopifyUtilities from '../utils';
 import {Context} from '../context';
 import * as ShopifyErrors from '../error';