feat(mwcp): FetchService.postFile()

Author: waitingsong

packages/midway-component-fetch/src/lib/fetch.service.ts

@@ -1,4 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
+import assert from 'node:assert'
+import type { Blob as NodeBlob } from 'node:buffer'
+
 import {
   type AsyncContextManager,
   ApplicationContext,
@@ -91,6 +94,25 @@ export class FetchService {
     return this.fetch(opts)
   }
 
+  postFile<T extends ResponseData>(
+    input: string,
+    file: File | Blob | NodeBlob,
+    options?: Omit<FetchOptions, 'url' | 'method' | 'body' | 'data' | 'contentType' | 'processData'>,
+  ): Promise<T> {
+
+    assert(file, 'file is empty, should be Buffer or Blob')
+
+    const opts = {
+      ...options,
+      url: input,
+      method: 'POST',
+      data: file,
+      processData: false,
+      contentType: false,
+    } as FetchOptions
+    return this.fetch(opts)
+  }
+
   // #region protected
 
   protected prepareTrace(options: FetchOptions): void {

packages/midway-component-fetch/test/lib/100.data.ts

@@ -0,0 +1,17 @@
+import { Blob as NodeBlob } from 'node:buffer'
+import { readFile } from 'node:fs/promises'
+import { join } from 'node:path'
+
+import { genCurrentDirname } from '@waiting/shared-core'
+
+
+const currDir = genCurrentDirname(import.meta.url)
+
+const fileName = 'loading-1.gif'
+const fileType = 'image/gif'
+const imgPath = join(currDir, '../images', fileName)
+const buf = await readFile(imgPath)
+export const imgBlob = typeof Blob === 'undefined'
+  ? new NodeBlob([buf], { type: fileType })
+  : new Blob([buf], { type: fileType })
+

packages/midway-component-fetch/test/lib/100.types.ts

@@ -0,0 +1,8 @@
+import type { UploadFileInfo } from '@midwayjs/busboy'
+
+
+export interface UploadRet {
+  fields: Record<string, string>
+  files: UploadFileInfo[]
+  traceId: string
+}

packages/midway-component-fetch/test/lib/102.postFile-trace.test.ts

@@ -0,0 +1,92 @@
+import assert from 'node:assert'
+
+import type { AssertsOptions } from '@mwcp/otel'
+import {
+  assertsSpan,
+  assertRootSpan,
+  retrieveTraceInfoFromRemote,
+  sortSpans,
+  assertJaegerParentSpanArray,
+} from '@mwcp/otel'
+import { fileShortPath } from '@waiting/shared-core'
+
+import { FetchService } from '##/index.js'
+import { apiBase, apiMethod } from '#@/api-test.js'
+import { testConfig } from '#@/root.config.js'
+
+import { imgBlob } from './100.data.js'
+import type { UploadRet } from './100.types.js'
+
+
+describe(fileShortPath(import.meta.url), () => {
+
+  const path = `${apiBase.upload}/${apiMethod.hello}`
+
+  it('postFile()', async () => {
+    const { app, host } = testConfig
+    const fetchService = await app.getApplicationContext().getAsync(FetchService)
+
+    const url = `${host}${path.slice(1)}`
+    const resp = await fetchService.postFile<UploadRet>(url, imgBlob)
+    assert(resp)
+    assert(resp.traceId)
+
+    const [info] = await retrieveTraceInfoFromRemote(resp.traceId, 2)
+    assert(info)
+    const traceId = info.traceID
+    const { spans } = info
+    const [rootSpan, span1] = sortSpans(spans)
+    assert(rootSpan)
+    assert(span1)
+
+    assertJaegerParentSpanArray([
+      { parentSpan: rootSpan, childSpan: span1 },
+    ])
+
+    assertRootSpan({
+      path,
+      span: rootSpan,
+      traceId,
+      operationName: `HTTP POST ${url.slice(7)}`,
+      mergeDefaultLogs: false,
+      mergeDefaultTags: false,
+      tags: {
+        'caller.class': 'FetchComponent',
+        'caller.method': 'fetch2',
+        'http.method': 'POST',
+        // 'http.resp.Content-Length': '227',
+        'http.resp.content-type': 'application/json; charset=utf-8',
+        'http.url': url,
+        'span.kind': 'client',
+      },
+      logs: [
+        { event: 'fetch.start', method: 'POST', url },
+        { event: 'prepare-request-data' },
+        { event: 'request-start' },
+        { event: 'request-finish' },
+        { event: 'handle-redirect-finish' },
+        { event: 'process-response-start' },
+        { event: 'process-response-finish' },
+        { event: 'fetch.finish', method: 'POST', url },
+      ],
+    })
+
+    const opt1: AssertsOptions = {
+      traceId,
+      operationName: `HTTP POST ${path}`,
+      tags: {
+        'http.method': 'POST',
+        'http.request.header.content_type': 'image/gif',
+        'http.request.header.user_agent': 'undici',
+        'http.route': path,
+        'http.target': path,
+        'span.kind': 'server',
+      },
+    }
+    assertsSpan(span1, opt1)
+  })
+
+
+})
+
+