add opfs_util and fix

Author: e1arikawa

packages/duckdb-wasm/src/bindings/config.ts

@@ -31,9 +31,11 @@ export interface DuckDBFilesystemConfig {
 
 export interface DuckDBOPFSConfig {
     /**
-     * Auto Opfs File Registration
+     * Defines how `opfs://` files are handled during SQL execution.
+     * - "auto": Automatically register `opfs://` files and drop them after execution.
+     * - "manual": Files must be manually registered and dropped.
      */
-    autoFileRegistration?: boolean;
+    fileHandling?: "auto" | "manual";
 }
 
 export enum DuckDBAccessMode {

packages/duckdb-wasm/src/parallel/async_bindings.ts

@@ -18,10 +18,9 @@ import { InstantiationProgress } from '../bindings/progress';
 import { arrowToSQLField } from '../json_typedef';
 import { WebFile } from '../bindings/web_file';
 import { DuckDBDataProtocol } from '../bindings';
+import { searchOPFSFiles, isOPFSProtocol } from "../utils/opfs_util";
 
 const TEXT_ENCODER = new TextEncoder();
-const REGEX_OPFS_FILE = /'(opfs:\/\/\S*?)'/g;
-const REGEX_OPFS_PROTOCOL = /(opfs:\/\/\S*?)/g;
 
 export class AsyncDuckDB implements AsyncDuckDBBindings {
     /** The message handler */
@@ -404,8 +403,8 @@ export class AsyncDuckDB implements AsyncDuckDBBindings {
 
     /** Run a query */
     public async runQuery(conn: ConnectionID, text: string): Promise<Uint8Array> {
-        if( this.isOpenedOPFSAutoFileRegistration() ){
-            const files = await this._preFileRegistration(text);
+        if( this.shouldOPFSFileHandling() ){
+            const files = await this.registerOPFSFileFromSQL(text);
             try {
                 return await this._runQueryAsync(conn, text);
             } finally {
@@ -432,8 +431,8 @@ export class AsyncDuckDB implements AsyncDuckDBBindings {
         text: string,
         allowStreamResult: boolean = false,
     ): Promise<Uint8Array | null> {
-        if( this.isOpenedOPFSAutoFileRegistration() ){
-            const files = await this._preFileRegistration(text);
+        if( this.shouldOPFSFileHandling() ){
+            const files = await this.registerOPFSFileFromSQL(text);
             try {
                 return await this._startPendingQueryAsync(conn, text, allowStreamResult);
             } finally {
@@ -693,16 +692,15 @@ export class AsyncDuckDB implements AsyncDuckDBBindings {
         await this.postTask(task);
     }
 
-    private isOpenedOPFSAutoFileRegistration():boolean {
-        let path = this.config.path ?? "";
-        if( path.search(REGEX_OPFS_PROTOCOL) > -1){
-            return this.config.opfs?.autoFileRegistration ?? false;
+    private shouldOPFSFileHandling():boolean {
+        if( isOPFSProtocol(this.config.path ?? "")){
+            return this.config.opfs?.fileHandling == "auto";
         }
         return false;
     }
 
-    private async _preFileRegistration(text: string) {
-        const files = [...text.matchAll(REGEX_OPFS_FILE)].map(match => match[1]);
+    private async registerOPFSFileFromSQL(text: string) {
+        const files = searchOPFSFiles(text);
         const result: string[] = [];
         for (const file of files) {
             try {

packages/duckdb-wasm/src/utils/opfs_util.ts

@@ -0,0 +1,10 @@
+export const REGEX_OPFS_FILE = /'(opfs:\/\/\S*?)'/g;
+export const REGEX_OPFS_PROTOCOL = /(opfs:\/\/\S*?)/g;
+
+export function isOPFSProtocol(path: string): boolean {
+    return path.search(REGEX_OPFS_PROTOCOL) > -1;
+}
+
+export function searchOPFSFiles(text: string) {
+    return [...text.matchAll(REGEX_OPFS_FILE)].map(match => match[1]);
+}

packages/duckdb-wasm/test/opfs.test.ts

@@ -284,7 +284,7 @@ export function testOPFS(baseDir: string, bundle: () => duckdb.DuckDBBundle): vo
             await db.reset();
             await db.dropFile('test.parquet');
             db.config.opfs = {
-                autoFileRegistration: true
+                fileHandling: "auto"
             };
             conn = await db.connect();
             //2. send query
@@ -307,7 +307,7 @@ export function testOPFS(baseDir: string, bundle: () => duckdb.DuckDBBundle): vo
             await db.reset();
             await db.dropFile('test.parquet');
             db.config.opfs = {
-                autoFileRegistration: true
+                fileHandling: "auto"
             };
             conn = await db.connect();
             //2. send query
@@ -332,7 +332,7 @@ export function testOPFS(baseDir: string, bundle: () => duckdb.DuckDBBundle): vo
             await db.reset();
             await db.dropFile('datadir/test.parquet');
             db.config.opfs = {
-                autoFileRegistration: true
+                fileHandling: "auto"
             };
             conn = await db.connect();
             //2. send query
@@ -365,7 +365,7 @@ export function testOPFS(baseDir: string, bundle: () => duckdb.DuckDBBundle): vo
         it('Copy CSV to OPFS + Load CSV', async () => {
             //1. data preparation
             db.config.opfs = {
-                autoFileRegistration: true
+                fileHandling: "auto"
             };
             await conn.query(`COPY ( SELECT 32 AS value ) TO 'opfs://file.csv'`);
             await conn.query(`COPY ( SELECT 42 AS value ) TO 'opfs://file.csv'`);