@opensumi/ide-express-file-server 2.21.6 → 2.21.7-rc-1669780664.0

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@opensumi/ide-express-file-server",
-  "version": "2.21.6",
+  "version": "2.21.7-rc-1669780664.0",
   "files": [
-    "lib"
+    "lib",
+    "src"
   ],
   "license": "MIT",
   "main": "lib/index.js",
@@ -16,16 +17,16 @@
     "url": "git@github.com:opensumi/core.git"
   },
   "dependencies": {
-    "@opensumi/ide-core-common": "2.21.6",
-    "@opensumi/ide-core-node": "2.21.6",
-    "@opensumi/ide-static-resource": "2.21.6",
+    "@opensumi/ide-core-common": "2.21.7-rc-1669780664.0",
+    "@opensumi/ide-core-node": "2.21.7-rc-1669780664.0",
+    "@opensumi/ide-static-resource": "2.21.7-rc-1669780664.0",
     "koa-mount": "^4.0.0"
   },
   "devDependencies": {
-    "@opensumi/ide-core-browser": "2.21.6",
+    "@opensumi/ide-core-browser": "2.21.7-rc-1669780664.0",
     "@opensumi/ide-dev-tool": "^1.3.1",
     "@types/koa-mount": "^4.0.1",
     "superagent": "^5.1.0"
   },
-  "gitHead": "a34917dfa6d851e067a431ad700812e58e8cc8a8"
+  "gitHead": "a997e49dfa53179486d2148dfe336112acbb3a09"
 }

package/src/browser/file-server.contribution.ts

@@ -0,0 +1,32 @@
+import { Autowired } from '@opensumi/di';
+import { Domain, URI, AppConfig, Schemes } from '@opensumi/ide-core-browser';
+import {
+  StaticResourceContribution,
+  StaticResourceService,
+} from '@opensumi/ide-static-resource/lib/browser/static.definition';
+
+import { EXPRESS_SERVER_PATH } from '../common';
+
+@Domain(StaticResourceContribution)
+export class ExpressFileServerContribution implements StaticResourceContribution {
+  @Autowired(AppConfig)
+  appConfig: AppConfig;
+
+  registerStaticResolver(service: StaticResourceService): void {
+    service.registerStaticResourceProvider({
+      scheme: Schemes.file,
+      resolveStaticResource: (uri: URI) => {
+        // file 协议统一走静态服务
+        // http://${HOST}:8000/assets/${path}
+        const assetsUri = new URI(this.appConfig.staticServicePath || EXPRESS_SERVER_PATH);
+        /**
+         * uri.path 在 Windows 下会被解析为 /c:/Path/to/file
+         * fsPath C:\\Path\\to\\file
+         */
+        const [resourceUrl, query] = uri.codeUri.path.split('?');
+        return assetsUri.resolve(`assets${decodeURIComponent(resourceUrl)}`).withQuery(query);
+      },
+      roots: [this.appConfig.staticServicePath || EXPRESS_SERVER_PATH],
+    });
+  }
+}

package/src/browser/index.ts

@@ -0,0 +1,9 @@
+import { Provider, Injectable } from '@opensumi/di';
+import { BrowserModule } from '@opensumi/ide-core-browser';
+
+import { ExpressFileServerContribution } from './file-server.contribution';
+
+@Injectable()
+export class ExpressFileServerModule extends BrowserModule {
+  providers: Provider[] = [ExpressFileServerContribution];
+}

package/src/common/index.ts

@@ -0,0 +1,20 @@
+export const EXPRESS_SERVER_PORT = 8000;
+export const EXPRESS_SERVER_PATH = process.env.STATIC_SERVER_PATH || `http://127.0.0.1:${EXPRESS_SERVER_PORT}/`;
+// 静态服务资源白名单
+export const ALLOW_MIME = {
+  gif: 'image/gif',
+  jpg: 'image/jpeg',
+  png: 'image/png',
+  webp: 'image/webp',
+  svg: 'image/svg+xml',
+  ttf: 'font/ttf',
+  eot: 'font/eot',
+  otf: 'font/otf',
+  woff: 'font/woff',
+  woff2: 'font/woff2',
+  js: 'application/javascript',
+  css: 'text/css',
+  mp4: 'video/mp4',
+  ogg: 'video/ogg',
+  webm: 'video/webm',
+};

package/src/index.ts

@@ -0,0 +1 @@
+export * from './common';

package/src/node/express-file-server.contribution.ts

@@ -0,0 +1,59 @@
+import fs from 'fs';
+import path from 'path';
+
+import mount from 'koa-mount';
+
+import { Autowired } from '@opensumi/di';
+import { ServerAppContribution, Domain, IServerApp, AppConfig, URI } from '@opensumi/ide-core-node';
+
+import { ALLOW_MIME } from '../common';
+
+@Domain(ServerAppContribution)
+export class ExpressFileServerContribution implements ServerAppContribution {
+  @Autowired(AppConfig)
+  private appConfig: AppConfig;
+
+  getWhiteList() {
+    return [
+      // 插件市场安装目录
+      this.appConfig.marketplace.extensionDir,
+      ...(this.appConfig.staticAllowPath || []),
+    ];
+  }
+
+  initialize(app: IServerApp) {
+    app.use(
+      mount('/assets', async (ctx) => {
+        const uriPath = decodeURI(ctx.path.replace(/^\/assets/, ''));
+        if (!uriPath) {
+          ctx.status = 404;
+          return;
+        }
+
+        const filePath = URI.parse(`file://${uriPath}`).codeUri.fsPath;
+        const whitelist = this.getWhiteList();
+        const contentType = ALLOW_MIME[path.extname(filePath).slice(1)];
+        if (
+          /**
+           * 地址在白名单内
+           * Windows 下 C:\\Path\\to\\file 会被转换成 c:\\Path\\to\\file
+           */
+          whitelist.some(
+            (whitelistPath) => whitelistPath && filePath.toLowerCase().startsWith(whitelistPath.toLowerCase()),
+          ) &&
+          // 在允许的 contentType
+          contentType
+        ) {
+          ctx.set('Content-Type', contentType);
+          if (this.appConfig.staticAllowOrigin) {
+            ctx.set('Access-Control-Allow-Origin', this.appConfig.staticAllowOrigin);
+          }
+
+          ctx.body = fs.createReadStream(filePath);
+        } else {
+          ctx.status = 403;
+        }
+      }),
+    );
+  }
+}

package/src/node/index.ts

@@ -0,0 +1,9 @@
+import { Provider, Injectable } from '@opensumi/di';
+import { NodeModule } from '@opensumi/ide-core-node';
+
+import { ExpressFileServerContribution } from './express-file-server.contribution';
+
+@Injectable()
+export class ExpressFileServerModule extends NodeModule {
+  providers: Provider[] = [ExpressFileServerContribution];
+}