@midwayjs/oss 4.0.0-beta.9 → 4.0.0

package/dist/manager.d.ts

@@ -1,10 +1,15 @@
-import { ServiceFactory } from '@midwayjs/core';
+import { ServiceFactory, MidwayTraceService } from '@midwayjs/core';
 import * as OSS from 'ali-oss';
 import type { OSSServiceFactoryReturnType, OSSServiceFactoryCreateClientConfigType } from './interface';
 export declare class OSSServiceFactory<T extends OSSServiceFactoryReturnType = OSSServiceFactoryReturnType> extends ServiceFactory<T> {
     ossConfig: OSSServiceFactoryCreateClientConfigType;
+    protected traceService: MidwayTraceService;
+    protected traceMetaResolver: any;
+    protected traceEnabled: any;
+    protected traceInjector: any;
     init(): Promise<void>;
     createClient(config: OSSServiceFactoryCreateClientConfigType): Promise<T>;
+    protected bindTraceContext(client: any): void;
     getName(): string;
 }
 export declare class OSSService implements OSS {

package/dist/manager.js

@@ -19,6 +19,10 @@ function checkBucketConfig(config) {
 }
 let OSSServiceFactory = class OSSServiceFactory extends core_1.ServiceFactory {
     ossConfig;
+    traceService;
+    traceMetaResolver;
+    traceEnabled;
+    traceInjector;
     async init() {
         await this.initClients(this.ossConfig, {
             concurrent: true,
@@ -30,16 +34,58 @@ let OSSServiceFactory = class OSSServiceFactory extends core_1.ServiceFactory {
         }
         if (config.clusters) {
             config.clusters.forEach(checkBucketConfig);
-            // @ts-expect-error because this code can return the correct type, but TS still reports an error
-            return new OSS.ClusterClient(config);
+            const client = new OSS.ClusterClient(config);
+            this.bindTraceContext(client);
+            return client;
         }
         if (config.sts === true) {
-            // @ts-expect-error because this code can return the correct type, but TS still reports an error
-            return new OSS.STS(config);
+            const client = new OSS.STS(config);
+            this.bindTraceContext(client);
+            return client;
         }
         checkBucketConfig(config);
-        // @ts-expect-error because this code can return the correct type, but TS still reports an error
-        return new OSS(config);
+        const client = new OSS(config);
+        this.bindTraceContext(client);
+        return client;
+    }
+    bindTraceContext(client) {
+        if (!client || !this.traceService) {
+            return;
+        }
+        const rawRequest = client.request?.bind(client);
+        if (!rawRequest) {
+            return;
+        }
+        client.request = async (...args) => {
+            const requestMethod = args?.[0]?.method || 'request';
+            const rawCarrier = typeof this.traceInjector === 'function'
+                ? this.traceInjector({
+                    request: args?.[0],
+                    custom: {
+                        requestMethod: String(requestMethod),
+                    },
+                })
+                : {};
+            const carrier = rawCarrier && typeof rawCarrier === 'object' ? rawCarrier : {};
+            return await this.traceService.runWithExitSpan(`oss.${String(requestMethod).toLowerCase()}`, {
+                enable: this.traceEnabled !== false,
+                carrier,
+                attributes: {
+                    'midway.protocol': 'oss',
+                    'midway.oss.method': String(requestMethod),
+                },
+                meta: this.traceMetaResolver,
+                metaArgs: {
+                    carrier,
+                    request: args?.[0],
+                    custom: {
+                        requestMethod: String(requestMethod),
+                    },
+                },
+            }, async () => {
+                return await rawRequest(...args);
+            });
+        };
     }
     getName() {
         return 'oss';
@@ -50,6 +96,22 @@ __decorate([
     (0, core_1.Config)('oss'),
     __metadata("design:type", Object)
 ], OSSServiceFactory.prototype, "ossConfig", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", core_1.MidwayTraceService)
+], OSSServiceFactory.prototype, "traceService", void 0);
+__decorate([
+    (0, core_1.Config)('oss.tracing.meta'),
+    __metadata("design:type", Object)
+], OSSServiceFactory.prototype, "traceMetaResolver", void 0);
+__decorate([
+    (0, core_1.Config)('oss.tracing.enable'),
+    __metadata("design:type", Object)
+], OSSServiceFactory.prototype, "traceEnabled", void 0);
+__decorate([
+    (0, core_1.Config)('oss.tracing.injector'),
+    __metadata("design:type", Object)
+], OSSServiceFactory.prototype, "traceInjector", void 0);
 __decorate([
     (0, core_1.Init)(),
     __metadata("design:type", Function),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@midwayjs/oss",
   "description": "midway oss component",
-  "version": "4.0.0-beta.9",
+  "version": "4.0.0",
   "main": "dist/index.js",
   "typings": "index.d.ts",
   "files": [
@@ -10,12 +10,12 @@
     "index.d.ts"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^4.0.0-beta.9",
-    "@midwayjs/mock": "^4.0.0-beta.9",
+    "@midwayjs/core": "^4.0.0",
+    "@midwayjs/mock": "^4.0.0",
     "dotenv": "16.4.7"
   },
   "dependencies": {
-    "@types/ali-oss": "6.16.13",
+    "@types/ali-oss": "6.23.3",
     "ali-oss": "6.23.0"
   },
   "keywords": [
@@ -38,5 +38,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "771e83974ef9f3d78c296e4ee0c8c68db44f6b31"
+  "gitHead": "014f32c23ebc1d5ac21777c76be2fd373ce992d8"
 }