Merge pull request Shopify#311 from Shopify/paulo/add_base_rest_resource

Add base rest resource

Author: paulomarg

.eslintrc.js

@@ -3,12 +3,30 @@ module.exports = {
     browser: false,
     es2021: true,
   },
-  plugins: ['@shopify'],
-  extends: ['plugin:@shopify/typescript'],
+  extends: ['plugin:@shopify/typescript', 'plugin:@shopify/prettier'],
   ignorePatterns: ['dist/'],
   rules: {
     'import/no-named-as-default': 0,
     'no-mixed-operators': 0,
     'no-console': 0,
   },
+  overrides: [
+    {
+      files: [
+        'src/rest_resources/__tests__/*.ts',
+        'src/rest_resources/base.ts',
+        'src/rest_resources/admin*/*.ts',
+      ],
+      rules: {
+        '@typescript-eslint/naming-convention': [
+          'error',
+          {
+            selector: 'default',
+            // Allow snake_case so we can have properties that follow the API's naming conventions
+            format: ['camelCase', 'PascalCase', 'snake_case', 'UPPER_CASE'],
+          },
+        ],
+      },
+    },
+  ],
 };

CHANGELOG.md

@@ -14,6 +14,8 @@ and adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ### Fixed
 
+- ⚠️ [Breaking] Stop responding to the request in the GraphQL Proxy function, returning Shopify's response instead [#312](https://github.com/Shopify/shopify-node-api/pull/312)
+
 ## [2.1.0] - 2022-02-03
 
 ### Added

jest.config.js

@@ -6,4 +6,5 @@ module.exports = {
   testRegex: '.*\\.test\\.tsx?$',
   coverageDirectory: './coverage/',
   collectCoverage: true,
+  setupFilesAfterEnv: ['<rootDir>/src/utils/setup-jest.ts'],
 };

package.json

@@ -50,18 +50,18 @@
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@shopify/eslint-plugin": "^41.0.1",
+    "@shopify/eslint-plugin": "^41.1.0",
     "@shopify/prettier-config": "^1.1.2",
     "@types/cookies": "^0.7.5",
     "@types/jest": "^26.0.15",
     "@types/node": "^14.14.1",
     "@types/uuid": "^8.3.0",
     "eslint": "^7.30.0",
-    "eslint-plugin-tsdoc": "^0.2.7",
+    "eslint-plugin-prettier": "^4.0.0",
     "express": "^4.17.1",
     "jest": "^27.4.3",
     "jest-fetch-mock": "^3.0.3",
-    "prettier": "^2.3.2",
+    "prettier": "^2.5.1",
     "rimraf": "^3.0.2",
     "supertest": "^6.1.3",
     "ts-jest": "^27.1.1",

src/test/context.test.ts src/__tests__/context.test.ts

@@ -1,5 +1,3 @@
-import './test_helper';
-
 import Cookies from 'cookies';
 
 import * as ShopifyErrors from '../error';

src/auth/oauth/test/oauth.test.ts src/auth/oauth/__tests__/oauth.test.ts

@@ -1,5 +1,3 @@
-import '../../../test/test_helper';
-
 import querystring from 'querystring';
 import http from 'http';
 
@@ -94,7 +92,13 @@ describe('beginAuth', () => {
   });
 
   test('returns the correct auth url for given info', async () => {
-    const authRoute = await ShopifyOAuth.beginAuth(req, res, shop, '/some-callback', false);
+    const authRoute = await ShopifyOAuth.beginAuth(
+      req,
+      res,
+      shop,
+      '/some-callback',
+      false,
+    );
     const session = await Context.SESSION_STORAGE.loadSession(cookies.id);
     /* eslint-disable @typescript-eslint/naming-convention */
     const query = {
@@ -170,7 +174,7 @@ describe('validateAuthCallback', () => {
     res = {} as http.ServerResponse;
 
     Cookies.prototype.set.mockImplementation(
-      (cookieName: string, cookieValue: string, options: {expires: Date;}) => {
+      (cookieName: string, cookieValue: string, options: {expires: Date}) => {
         expect(cookieName).toBe('shopify_app_session');
         cookies.id = cookieValue;
         cookies.expires = options.expires;
@@ -383,7 +387,11 @@ describe('validateAuthCallback', () => {
     testCallbackQuery.hmac = expectedHmac;
 
     fetchMock.mockResponse(JSON.stringify(successResponse));
-    const returnedSession = await ShopifyOAuth.validateAuthCallback(req, res, testCallbackQuery);
+    const returnedSession = await ShopifyOAuth.validateAuthCallback(
+      req,
+      res,
+      testCallbackQuery,
+    );
 
     const jwtPayload: JwtPayload = {
       iss: `https://${shop}/admin`,
@@ -425,7 +433,10 @@ describe('validateAuthCallback', () => {
     const currentSession = await loadCurrentSession(jwtReq, jwtRes);
     expect(currentSession).not.toBe(null);
     expect(currentSession?.id).toEqual(jwtSessionId);
-    expect(cookies?.expires?.getTime() as number).toBeWithinSecondsOf(new Date().getTime(), 1);
+    expect(cookies?.expires?.getTime() as number).toBeWithinSecondsOf(
+      new Date().getTime(),
+      1,
+    );
   });
 
   test('properly updates the Oauth cookie for online, non-embedded apps', async () => {
@@ -463,11 +474,21 @@ describe('validateAuthCallback', () => {
     testCallbackQuery.hmac = expectedHmac;
 
     fetchMock.mockResponse(JSON.stringify(successResponse));
-    const returnedSession = await ShopifyOAuth.validateAuthCallback(req, res, testCallbackQuery);
+    const returnedSession = await ShopifyOAuth.validateAuthCallback(
+      req,
+      res,
+      testCallbackQuery,
+    );
     expect(returnedSession.id).toEqual(cookies.id);
 
-    expect(returnedSession?.expires?.getTime() as number).toBeWithinSecondsOf(new Date(Date.now() + successResponse.expires_in * 1000).getTime(), 1);
-    expect(cookies?.expires?.getTime() as number).toBeWithinSecondsOf(returnedSession?.expires?.getTime() as number, 1);
+    expect(returnedSession?.expires?.getTime() as number).toBeWithinSecondsOf(
+      new Date(Date.now() + successResponse.expires_in * 1000).getTime(),
+      1,
+    );
+    expect(cookies?.expires?.getTime() as number).toBeWithinSecondsOf(
+      returnedSession?.expires?.getTime() as number,
+      1,
+    );
 
     const cookieSession = await Context.SESSION_STORAGE.loadSession(cookies.id);
     expect(cookieSession).not.toBeUndefined();
@@ -508,13 +529,20 @@ describe('validateAuthCallback', () => {
     testCallbackQuery.hmac = expectedHmac;
 
     fetchMock.mockResponse(JSON.stringify(successResponse));
-    const returnedSession = await ShopifyOAuth.validateAuthCallback(req, res, testCallbackQuery);
+    const returnedSession = await ShopifyOAuth.validateAuthCallback(
+      req,
+      res,
+      testCallbackQuery,
+    );
     expect(returnedSession.id).toEqual(cookies.id);
     expect(returnedSession.id).toEqual(ShopifyOAuth.getOfflineSessionId(shop));
 
     const cookieSession = await Context.SESSION_STORAGE.loadSession(cookies.id);
     expect(cookieSession).not.toBeUndefined();
-    expect(cookies?.expires?.getTime() as number).toBeWithinSecondsOf(new Date().getTime(), 1);
+    expect(cookies?.expires?.getTime() as number).toBeWithinSecondsOf(
+      new Date().getTime(),
+      1,
+    );
     expect(returnedSession?.expires?.getTime()).toBeUndefined();
   });
 
@@ -553,7 +581,11 @@ describe('validateAuthCallback', () => {
     testCallbackQuery.hmac = expectedHmac;
 
     fetchMock.mockResponse(JSON.stringify(successResponse));
-    const returnedSession = await ShopifyOAuth.validateAuthCallback(req, res, testCallbackQuery);
+    const returnedSession = await ShopifyOAuth.validateAuthCallback(
+      req,
+      res,
+      testCallbackQuery,
+    );
     expect(returnedSession.id).toEqual(cookies.id);
     expect(returnedSession.id).toEqual(ShopifyOAuth.getOfflineSessionId(shop));
     expect(cookies?.expires?.getTime()).toBeUndefined();

src/auth/oauth/oauth.ts

@@ -173,7 +173,9 @@ const ShopifyOAuth = {
         );
         const jwtSession = Session.cloneSession(currentSession, jwtSessionId);
 
-        const sessionDeleted = await Context.SESSION_STORAGE.deleteSession(currentSession.id);
+        const sessionDeleted = await Context.SESSION_STORAGE.deleteSession(
+          currentSession.id,
+        );
         if (!sessionDeleted) {
           throw new ShopifyErrors.SessionStorageError(
             'OAuth Session could not be deleted. Please check your session storage functionality.',
@@ -195,7 +197,9 @@ const ShopifyOAuth = {
       secure: true,
     });
 
-    const sessionStored = await Context.SESSION_STORAGE.storeSession(currentSession);
+    const sessionStored = await Context.SESSION_STORAGE.storeSession(
+      currentSession,
+    );
     if (!sessionStored) {
       throw new ShopifyErrors.SessionStorageError(
         'OAuth Session could not be saved. Please check your session storage functionality.',

src/auth/scopes/test/scopes.test.ts src/auth/scopes/__tests__/scopes.test.ts

@@ -1,5 +1,3 @@
-import '../../../test/test_helper';
-
 import {AuthScopes} from '../index';
 
 describe('AuthScopes', () => {

src/auth/scopes/index.ts

@@ -1,4 +1,3 @@
-
 class AuthScopes {
   public static SCOPE_DELIMITER = ',';
 

src/auth/session/test/session.test.ts src/auth/session/__tests__/session.test.ts

@@ -1,9 +1,13 @@
-import '../../../test/test_helper';
 import {Session} from '..';
 
 describe('session', () => {
   it('can clone a session', () => {
-    const session = new Session('original', 'original-shop', 'original-state', true);
+    const session = new Session(
+      'original',
+      'original-shop',
+      'original-state',
+      true,
+    );
     const sessionClone = Session.cloneSession(session, 'new');
 
     expect(session.id).not.toEqual(sessionClone.id);
@@ -30,7 +34,12 @@ describe('isActive', () => {
   });
 
   it('returns false if session is not active', () => {
-    const session = new Session('not_active', 'inactive-shop', 'not_same', true);
+    const session = new Session(
+      'not_active',
+      'inactive-shop',
+      'not_same',
+      true,
+    );
     session.scope = 'test_scope';
     session.expires = new Date(Date.now() - 1);
     expect(session.isActive()).toBeFalsy();

src/auth/session/session_storage.ts

@@ -4,7 +4,6 @@ import {SessionInterface} from './types';
  * Defines the strategy to be used to store sessions for the Shopify App.
  */
 interface SessionStorage {
-
   /**
    * Creates or updates the given session in storage.
    *

src/auth/session/storage/test/custom.test.ts src/auth/session/storage/__tests__/custom.test.ts

@@ -1,13 +1,16 @@
-import '../../../../test/test_helper';
-
 import {Session} from '../../session';
 import {CustomSessionStorage} from '../custom';
 import {SessionStorageError} from '../../../../error';
 
 describe('custom session storage', () => {
   test('can perform actions', async () => {
     const sessionId = 'test_session';
-    let session: Session | undefined = new Session(sessionId, 'shop-url', 'state', true);
+    let session: Session | undefined = new Session(
+      sessionId,
+      'shop-url',
+      'state',
+      true,
+    );
 
     let storeCalled = false;
     let loadCalled = false;
@@ -99,7 +102,12 @@ describe('custom session storage', () => {
     const expiration = new Date();
     expiration.setDate(expiration.getDate() + 10);
 
-    let session: Session | undefined = new Session(sessionId, 'shop', 'state', true);
+    let session: Session | undefined = new Session(
+      sessionId,
+      'shop',
+      'state',
+      true,
+    );
     session.expires = expiration;
 
     const storage = new CustomSessionStorage(
@@ -128,7 +136,12 @@ describe('custom session storage', () => {
     expiration.setDate(expiration.getDate() + 10);
 
     /* eslint-disable @typescript-eslint/naming-convention */
-    let session: Session | undefined = new Session(sessionId, 'test.myshopify.io', '1234', true);
+    let session: Session | undefined = new Session(
+      sessionId,
+      'test.myshopify.io',
+      '1234',
+      true,
+    );
     session.scope = 'read_products';
     session.expires = expiration;
     session.isOnline = true;
@@ -174,7 +187,12 @@ describe('custom session storage', () => {
   it('allows empty fields in serialized object', async () => {
     const sessionId = 'test_session';
 
-    let session: Session | undefined = new Session(sessionId, 'shop', 'state', true);
+    let session: Session | undefined = new Session(
+      sessionId,
+      'shop',
+      'state',
+      true,
+    );
 
     let serializedSession = '';
     const storage = new CustomSessionStorage(

src/auth/session/storage/test/memory.test.ts src/auth/session/storage/__tests__/memory.test.ts

@@ -1,5 +1,3 @@
-import '../../../../test/test_helper';
-
 import {Session} from '../../session';
 import {MemorySessionStorage} from '../memory';
 

src/auth/session/storage/custom.ts

@@ -8,7 +8,7 @@ export class CustomSessionStorage implements SessionStorage {
     readonly storeCallback: (session: SessionInterface) => Promise<boolean>,
     readonly loadCallback: (
       id: string,
-    ) => Promise<SessionInterface | {[key: string]: unknown;} | undefined>,
+    ) => Promise<SessionInterface | {[key: string]: unknown} | undefined>,
     readonly deleteCallback: (id: string) => Promise<boolean>,
   ) {
     this.storeCallback = storeCallback;
@@ -27,7 +27,7 @@ export class CustomSessionStorage implements SessionStorage {
   }
 
   public async loadSession(id: string): Promise<SessionInterface | undefined> {
-    let result: SessionInterface | {[key: string]: unknown;} | undefined;
+    let result: SessionInterface | {[key: string]: unknown} | undefined;
     try {
       result = await this.loadCallback(id);
     } catch (error) {

src/auth/session/storage/memory.ts

@@ -2,7 +2,7 @@ import {SessionInterface} from '../types';
 import {SessionStorage} from '../session_storage';
 
 export class MemorySessionStorage implements SessionStorage {
-  private sessions: {[id: string]: SessionInterface;} = {};
+  private sessions: {[id: string]: SessionInterface} = {};
 
   public async storeSession(session: SessionInterface): Promise<boolean> {
     this.sessions[session.id] = session;