Merge pull request #6098 from Shopify/submit-correct-resource-type-when-creating-staged-upload

use `SQLITE_DATABASE` resource type, to permit larger file uploads

Author: odacrem

packages/store/src/apis/admin/index.ts

@@ -1,28 +1,29 @@
-import {Shop} from './types.js'
-import {StagedUploadsCreate} from '../../cli/api/graphql/admin/generated/staged_uploads_create.js'
+import {Shop, SQLiteStagedUploadsCreate} from './types.js'
 import {ShopDetails} from '../../cli/api/graphql/admin/generated/shop_details.js'
 import {adminRequestDoc} from '@shopify/cli-kit/node/api/admin'
 import {ensureAuthenticatedAdmin} from '@shopify/cli-kit/node/session'
+import type {StagedUploadsCreateMutation} from '../../cli/api/graphql/admin/generated/staged_uploads_create.js'
 import type {
-  StagedUploadsCreateMutation,
-  StagedUploadsCreateMutationVariables,
-} from '../../cli/api/graphql/admin/generated/staged_uploads_create.js'
-import type {StagedUploadInput} from '../../cli/api/graphql/admin/generated/types.js'
-
+  SQLiteStagedUploadInput,
+  SQLiteStagedUploadsCreateMutationVariables,
+  SQLiteStagedUploadsCreateMutation,
+} from './types.js'
 import type {ShopDetailsQuery, ShopDetailsQueryVariables} from '../../cli/api/graphql/admin/generated/shop_details.js'
 
 export async function createStagedUploadAdmin(
   storeFqdn: string,
-  input: StagedUploadInput[],
+  input: SQLiteStagedUploadInput[],
+  version?: string,
 ): Promise<StagedUploadsCreateMutation> {
   const adminSession = await ensureAuthenticatedAdmin(storeFqdn)
 
-  return adminRequestDoc<StagedUploadsCreateMutation, StagedUploadsCreateMutationVariables>({
-    query: StagedUploadsCreate,
+  return adminRequestDoc<SQLiteStagedUploadsCreateMutation, SQLiteStagedUploadsCreateMutationVariables>({
+    query: SQLiteStagedUploadsCreate,
     session: adminSession,
     variables: {
       input,
     },
+    version,
   })
 }
 

packages/store/src/apis/admin/types.ts

@@ -1,4 +1,42 @@
+/* eslint-disable @typescript-eslint/consistent-type-definitions */
+
+import {StagedUploadsCreate} from '../../cli/api/graphql/admin/generated/staged_uploads_create.js'
+import {TypedDocumentNode as DocumentNode} from '@graphql-typed-document-node/core'
+
 export interface Shop {
   id: string
   name: string
 }
+export type SQLiteStagedUploadInput = {
+  filename: string
+  mimeType: 'application/x-sqlite3'
+  httpMethod: 'POST'
+  fileSize?: string
+  resource: 'SQLITE_DATABASE'
+}
+export type SQLiteStagedUploadsCreateMutationVariables = {
+  input: SQLiteStagedUploadInput[]
+}
+
+export type SQLiteStagedUploadsCreateMutation = {
+  stagedUploadsCreate?: {
+    stagedTargets?:
+      | {
+          url?: string | null
+          resourceUrl?: string | null
+          parameters: {name: string; value: string}[]
+        }[]
+      | null
+    userErrors: {field?: string[] | null; message: string}[]
+  } | null
+}
+
+export const SQLiteStagedUploadsCreate = {
+  ...StagedUploadsCreate,
+  definitions: [
+    {
+      ...StagedUploadsCreate.definitions[0],
+      name: {kind: 'Name', value: 'SQLiteStagedUploadsCreate'},
+    },
+  ],
+} as unknown as DocumentNode<SQLiteStagedUploadsCreateMutation, SQLiteStagedUploadsCreateMutationVariables>

packages/store/src/services/store/utils/file-uploader.test.ts

@@ -26,7 +26,7 @@ describe('FileUploader', () => {
         stagedTargets: [
           {
             url: 'https://upload.shopify.com/staged',
-            resourceUrl: 'https://shopify.com/resource/123',
+            resourceUrl: 'https://shopify.com/resource/123/',
             parameters: [
               {name: 'key', value: 'uploads/123'},
               {name: 'policy', value: 'policy123'},
@@ -52,17 +52,21 @@ describe('FileUploader', () => {
     test('should successfully upload a valid SQLite file', async () => {
       const result = await fileUploader.uploadSqliteFile(mockFilePath, mockStoreFqdn)
 
-      expect(result).toBe('https://shopify.com/resource/123')
+      expect(result).toBe('https://shopify.com/resource/123/uploads/123')
       expect(readFileSync).toHaveBeenCalledWith(mockFilePath)
-      expect(createStagedUploadAdmin).toHaveBeenCalledWith(mockStoreFqdn, [
-        {
-          resource: 'FILE',
-          filename: 'database.sqlite',
-          mimeType: 'application/x-sqlite3',
-          httpMethod: 'POST',
-          fileSize: '1024',
-        },
-      ])
+      expect(createStagedUploadAdmin).toHaveBeenCalledWith(
+        mockStoreFqdn,
+        [
+          {
+            resource: 'SQLITE_DATABASE',
+            filename: 'database.sqlite',
+            mimeType: 'application/x-sqlite3',
+            httpMethod: 'POST',
+            fileSize: '1024',
+          },
+        ],
+        'unstable',
+      )
       expect(fetch).toHaveBeenCalledWith('https://upload.shopify.com/staged', {
         method: 'POST',
         body: expect.any(FormData),
@@ -103,14 +107,14 @@ describe('FileUploader', () => {
     })
 
     test('should throw error when file is too large', async () => {
-      const largeSize = 30 * 1024 * 1024
+      const largeSize = 400 * 1024 * 1024
       vi.mocked(fileSize).mockResolvedValue(largeSize)
 
       const promise = fileUploader.uploadSqliteFile(mockFilePath, mockStoreFqdn)
       await expect(promise).rejects.toThrow(ValidationError)
       await expect(promise).rejects.toMatchObject({
         code: ErrorCodes.FILE_TOO_LARGE,
-        params: {filePath: mockFilePath, fileSize: '30MB', maxSize: '20MB'},
+        params: {filePath: mockFilePath, fileSize: '400MB', maxSize: '300MB'},
       })
     })
 

packages/store/src/services/store/utils/file-uploader.ts

@@ -1,26 +1,27 @@
-import {StagedUploadInput, createStagedUploadAdmin} from '../../../apis/admin/index.js'
+import {createStagedUploadAdmin} from '../../../apis/admin/index.js'
+import {SQLiteStagedUploadInput} from '../../../apis/admin/types.js'
 import {ValidationError, OperationError, ErrorCodes} from '../errors/errors.js'
 import {fetch} from '@shopify/cli-kit/node/http'
 import {fileExistsSync, fileSize, isDirectory, readFileSync} from '@shopify/cli-kit/node/fs'
 import {outputDebug} from '@shopify/cli-kit/node/output'
 
 export class FileUploader {
-  private readonly MAX_FILE_SIZE = 20 * 1024 * 1024
+  private readonly MAX_FILE_SIZE = 300 * 1024 * 1024
 
   async uploadSqliteFile(filePath: string, storeFqdn: string): Promise<string> {
     await this.validateSqliteFile(filePath)
 
     const fileBuffer = readFileSync(filePath)
     const sizeOfFile = await fileSize(filePath)
-    const uploadInput: StagedUploadInput = {
-      resource: 'FILE',
+    const uploadInput: SQLiteStagedUploadInput = {
+      resource: 'SQLITE_DATABASE',
       filename: 'database.sqlite',
       mimeType: 'application/x-sqlite3',
       httpMethod: 'POST',
       fileSize: sizeOfFile.toString(),
     }
 
-    const stagedUploadResponse = await createStagedUploadAdmin(storeFqdn, [uploadInput])
+    const stagedUploadResponse = await createStagedUploadAdmin(storeFqdn, [uploadInput], 'unstable')
 
     if (!stagedUploadResponse.stagedUploadsCreate?.stagedTargets?.length) {
       throw new OperationError('upload', ErrorCodes.STAGED_UPLOAD_FAILED, {
@@ -42,6 +43,15 @@ export class FileUploader {
       })
     }
 
+    const stagedUploadKeyParam = parameters.find((parameter) => parameter.name === 'key')
+    if (!stagedUploadKeyParam) {
+      throw new OperationError('upload', ErrorCodes.STAGED_UPLOAD_FAILED, {
+        reason: 'Missing key parameter in staged upload target',
+      })
+    }
+
+    const finalResourceUrl = resourceUrl + stagedUploadKeyParam.value
+
     const formData = new FormData()
 
     parameters.forEach((param) => {
@@ -63,7 +73,7 @@ export class FileUploader {
       })
     }
 
-    return resourceUrl
+    return finalResourceUrl
   }
 
   private async validateSqliteFile(filePath: string): Promise<void> {