@heyputer/puter.js 2.1.15 → 2.2.2

package/src/lib/filesystem/CacheFS.js

@@ -1,243 +0,0 @@
-import putility from '@heyputer/putility';
-import { RWLock } from '@heyputer/putility/src/libs/promise.js';
-import { ProxyFilesystem, TFilesystem } from './definitions.js';
-import { uuidv4 } from '../utils.js';
-
-export const ROOT_UUID = '00000000-0000-0000-0000-000000000000';
-const TTL = 5 * 1000;
-
-export class CacheFS extends putility.AdvancedBase {
-    static PROPERTIES = {
-        assocs_path_: () => ({}),
-        assocs_uuid_: () => ({}),
-        entries: () => ({}),
-    };
-
-    get_entry_ei (external_identifier) {
-        if ( Array.isArray(external_identifier) ) {
-            for ( const ei of external_identifier ) {
-                const entry = this.get_entry_ei(ei);
-                if ( entry ) return entry;
-            }
-            return;
-        }
-
-        console.log('GET ENTRY EI', external_identifier);
-
-        const internal_identifier =
-            this.assocs_path_[external_identifier] ||
-            this.assocs_uuid_[external_identifier] ||
-            external_identifier;
-
-        if ( ! internal_identifier ) {
-            return;
-        }
-        return this.entries[internal_identifier];
-    }
-
-    add_entry ({ id } = {}) {
-        const internal_identifier = id ?? uuidv4();
-        const entry = {
-            id: internal_identifier,
-            stat_has: {},
-            stat_exp: 0,
-            locks: {
-                stat: new RWLock(),
-                members: new RWLock(),
-            },
-        };
-        this.entries[internal_identifier] = entry;
-        return entry;
-    }
-
-    assoc_path (path, internal_identifier) {
-        console.log('ASSOC PATH', path, internal_identifier);
-        this.assocs_path_[path] = internal_identifier;
-    }
-
-    assoc_uuid (uuid, internal_identifier) {
-        if ( uuid === internal_identifier ) return;
-        this.assocs_uuid_[uuid] = internal_identifier;
-    }
-
-}
-
-export class CachedFilesystem extends ProxyFilesystem {
-    constructor (o) {
-        super(o);
-        // this.cacheFS = cacheFS;
-        this.cacheFS = new CacheFS();
-    }
-    static IMPLEMENTS = {
-        [TFilesystem]: {
-            stat: async function (o) {
-                let cent = this.cacheFS.get_entry_ei(o.path ?? o.uid);
-
-                const modifiers = [
-                    'subdomains',
-                    'permissions',
-                    'versions',
-                    'size',
-                ];
-
-                let values_requested = {};
-                for ( const mod of modifiers ) {
-                    const optionsKey = `return${
-                        mod.charAt(0).toUpperCase()
-                    }${mod.slice(1)}`;
-                    if ( ! o[optionsKey] ) continue;
-                    values_requested[mod] = true;
-                }
-
-                const satisfactory_cache = cent => {
-                    for ( const mod of modifiers ) {
-                        if ( ! values_requested[mod] ) continue;
-                        if ( ! cent.stat_has[mod] ) {
-                            return false;
-                        }
-                    }
-                    return true;
-                };
-
-                let cached_stat;
-                if ( cent && cent.stat && cent.stat_exp > Date.now() ) {
-                    const l = await cent.locks.stat.rlock();
-                    if ( satisfactory_cache(cent) ) {
-                        cached_stat = cent.stat;
-                    }
-                    l.unlock();
-                }
-
-                if ( cached_stat ) {
-                    console.log('CACHE HIT');
-                    return cached_stat;
-                }
-                console.log('CACHE MISS');
-
-                let l;
-                if ( cent ) {
-                    l = await cent.locks.stat.wlock();
-                }
-
-                console.log('DOING THE STAT', o);
-                const entry = await this.delegate.stat(o);
-
-                // We might have new information to identify a relevant cache entry
-                let cent_replaced = !!cent;
-                cent = this.cacheFS.get_entry_ei([entry.uid, entry.path]);
-                if ( cent ) {
-                    if ( cent_replaced ) l.unlock();
-                    l = await cent.locks.stat.wlock();
-                }
-
-                if ( ! cent ) {
-                    cent = this.cacheFS.add_entry({ id: entry.uid });
-                    this.cacheFS.assoc_path(entry.path, cent.id);
-                    this.cacheFS.assoc_uuid(entry.uid, cent.id);
-
-                    l = await cent.locks.stat.wlock();
-                }
-
-                cent.stat = entry;
-                cent.stat_has = { ...values_requested };
-                // TODO: increase cache TTL once invalidation works
-                cent.stat_exp = Date.now() + TTL;
-
-                l.unlock();
-
-                console.log('RETRUNING THE ENTRY', entry);
-                return entry;
-            },
-            readdir: async function (o) {
-                let cent = this.cacheFS.get_entry_ei([o.path, o.uid]);
-
-                console.log('CENT', cent, o);
-                let stats = null;
-                if ( cent && cent.members && cent.members_exp > Date.now() ) {
-                    console.log('MEMBERS', cent.members);
-                    stats = [];
-                    const l = await cent.locks.stat.rlock();
-
-                    for ( const id of cent.members ) {
-                        const member = this.cacheFS.get_entry_ei(id);
-                        if ( !member || !member.stat || member.stat_exp <= Date.now() ) {
-                            console.log('NO MEMBER OR STAT', member);
-                            stats = null;
-                            break;
-                        }
-                        console.log('member', member);
-                        if ( !o.no_assocs && !member.stat_has.subdomains ) {
-                            stats = null;
-                            break;
-                        }
-                        if ( !o.no_assocs && !member.stat_has.apps ) {
-                            stats = null;
-                            break;
-                        }
-                        if ( !o.no_thumbs && !member.stat_has.thumbnail ) {
-                            stats = null;
-                            break;
-                        }
-                        console.log('PUSHING', member.stat);
-
-                        stats.push(member.stat);
-                    }
-
-                    l.unlock();
-                }
-
-                console.log('STATS????', stats);
-                if ( stats ) {
-                    return stats;
-                }
-
-                let l;
-                if ( cent ) {
-                    l = await cent.locks.members.wlock();
-                }
-
-                const entries = await this.delegate.readdir(o);
-                if ( ! cent ) {
-                    cent = this.cacheFS.add_entry(o.uid ? { id: o.uid } : {});
-                    if ( o.path ) this.cacheFS.assoc_path(o.path, cent.id);
-                    l = await cent.locks.members.wlock();
-                }
-
-                let cent_ids = [];
-                for ( const entry of entries ) {
-                    let entry_cent = this.cacheFS.get_entry_ei([entry.path, entry.uid]);
-                    if ( ! entry_cent ) {
-                        entry_cent = this.cacheFS.add_entry({ id: entry.uid });
-                        this.cacheFS.assoc_path(entry.path, entry.uid);
-                    }
-                    cent_ids.push(entry_cent.id);
-                    // TODO: update_stat_ is not implemented
-                    // this.cacheFS.update_stat_(entry_cent, entry, {
-                    //     subdomains: ! o.no_assocs,
-                    //     apps: ! o.no_assocs,
-                    //     thumbnail: ! o.no_thumbs,
-                    // });
-                    entry_cent.stat = entry;
-                    entry_cent.stat_has = {
-                        subdomains: !o.no_assocs,
-                        apps: !o.no_assocs,
-                        thumbnail: !o.no_thumbs,
-                    };
-                    entry_cent.stat_exp = Date.now() + 1000 * 3;
-                }
-
-                cent.members = [];
-                for ( const id of cent_ids ) {
-                    cent.members.push(id);
-                }
-                cent.members_exp = Date.now() + TTL;
-
-                l.unlock();
-
-                console.log('CACHE ENTRY?', cent);
-
-                return entries;
-            },
-        },
-    };
-}

package/src/lib/filesystem/PostMessageFS.js

@@ -1,40 +0,0 @@
-import putility from '@heyputer/putility';
-import { TFilesystem } from './definitions.js';
-
-const example =     {
-    'id': 'f485f1ba-de07-422c-8c4b-c2da057d4a44',
-    'uid': 'f485f1ba-de07-422c-8c4b-c2da057d4a44',
-    'is_dir': true,
-    'immutable': true,
-    'name': 'Test',
-};
-
-export class PostMessageFilesystem extends putility.AdvancedBase {
-    constructor ({ rpc, messageTarget }) {
-        super();
-        this.rpc = rpc;
-        this.messageTarget = messageTarget;
-    }
-    static IMPLEMENTS = {
-        [TFilesystem]: {
-            stat: async function (o) {
-                return example;
-            },
-            readdir: async function (o) {
-                const tp = new putility.libs.promise.TeePromise();
-                const $callback = this.rpc.registerCallback((result) => {
-                    tp.resolve(result);
-                });
-                // return [example];
-                this.messageTarget.postMessage({
-                    $: 'puter-fs',
-                    $callback,
-                    op: 'readdir',
-                    args: o,
-                }, '*');
-
-                return await tp;
-            },
-        },
-    };
-}

package/src/lib/filesystem/definitions.js

@@ -1,40 +0,0 @@
-import putility from '@heyputer/putility';
-
-export const TFilesystem = 'TFilesystem';
-
-// TODO: UNUSED (eventually putility will support these definitions)
-//       This is here so that the idea is not forgotten.
-export const IFilesystem = {
-    methods: {
-        stat: {
-            parameters: {
-                path: {
-                    alias: 'uid',
-                },
-            },
-        },
-    },
-
-};
-
-export class ProxyFilesystem extends putility.AdvancedBase {
-    static PROPERTIES = {
-        delegate: () => {
-        },
-    };
-    // TODO: constructor implied by properties
-    constructor ({ delegate }) {
-        super();
-        this.delegate = delegate;
-    }
-    static IMPLEMENTS = {
-        [TFilesystem]: {
-            stat: async function (o) {
-                return this.delegate.stat(o);
-            },
-            readdir: async function (o) {
-                return this.delegate.readdir(o);
-            },
-        },
-    };
-}

package/src/services/APIAccess.js

@@ -1,46 +0,0 @@
-import putility from '@heyputer/putility';
-
-const { TTopics } = putility.traits;
-
-/**
- * Manages the auth token and origin used to communicate with
- * Puter's API
- */
-export class APIAccessService extends putility.concepts.Service {
-    static TOPICS = ['update'];
-
-    static PROPERTIES = {
-        auth_token: {
-            post_set (v) {
-                this.as(TTopics).pub('update');
-            },
-        },
-        api_origin: {
-            post_set () {
-                this.as(TTopics).pub('update');
-            },
-        },
-    };
-
-    // TODO: inconsistent! Update all dependents.
-    get_api_info () {
-        const self = this;
-        const o = {};
-        [
-            ['auth_token', 'auth_token'],
-            ['authToken', 'auth_token'],
-            ['APIOrigin', 'api_origin'],
-            ['api_origin', 'api_origin'],
-        ].forEach(([k1, k2]) => {
-            Object.defineProperty(o, k1, {
-                get () {
-                    return self[k2];
-                },
-                set (v) {
-                    return self;
-                },
-            });
-        });
-        return o;
-    }
-}

package/src/services/FSRelay.js

@@ -1,20 +0,0 @@
-import putility from '@heyputer/putility';
-
-const example =     {
-    'id': 'f485f1ba-de07-422c-8c4b-c2da057d4a44',
-    'uid': 'f485f1ba-de07-422c-8c4b-c2da057d4a44',
-    'is_dir': true,
-    'immutable': true,
-    'name': 'FromParentWindow',
-};
-
-export class FSRelayService extends putility.concepts.Service {
-    async _init () {
-        const services = this._.context.services;
-        const util = this._.context.util;
-        const svc_xdIncoming = services.get('xd-incoming');
-        svc_xdIncoming.register_tagged_listener('puter-fs', event => {
-            util.rpc.send(event.source, event.data.$callback, [example]);
-        });
-    }
-}

package/src/services/Filesystem.js

@@ -1,137 +0,0 @@
-import putility from '@heyputer/putility';
-import { PuterAPIFilesystem } from '../lib/filesystem/APIFS.js';
-import { CachedFilesystem } from '../lib/filesystem/CacheFS.js';
-import { ProxyFilesystem, TFilesystem } from '../lib/filesystem/definitions.js';
-import { PostMessageFilesystem } from '../lib/filesystem/PostMessageFS.js';
-import io from '../lib/socket.io/socket.io.esm.min.js';
-
-export class FilesystemService extends putility.concepts.Service {
-    static PROPERTIES = {
-        // filesystem:
-    };
-
-    static DEPENDS = ['api-access'];
-    static HOOKS = [
-        {
-            service: 'api-access',
-            event: 'update',
-            description: `
-                re-initialize the socket connection whenever the
-                authentication token or API origin is changed.
-            `,
-            async do () {
-                this.initializeSocket();
-            },
-        },
-    ];
-
-    _init () {
-        const env = this._.context.env;
-
-        if ( env === 'app' ) {
-            // TODO: uncomment when relay is ready
-            // this.init_app_fs_();
-
-            this.init_top_fs_();
-        } else {
-            this.init_top_fs_();
-        }
-
-        this.initializeSocket();
-    }
-
-    init_app_fs_ () {
-        this.fs_nocache_ = new PostMessageFilesystem({
-            messageTarget: globalThis.parent,
-            rpc: this._.context.util.rpc,
-        }).as(TFilesystem);
-        this.filesystem = this.fs_nocache_;
-    }
-    init_top_fs_ () {
-        const api_info = this._.context.services.get('api-access').get_api_info();
-        this.fs_nocache_ = new PuterAPIFilesystem({ api_info }).as(TFilesystem);
-        this.fs_cache_ = new CachedFilesystem({ delegate: this.fs_nocache_ }).as(TFilesystem);
-        // this.filesystem = this.fs_nocache;
-        this.fs_proxy_ = new ProxyFilesystem({ delegate: this.fs_nocache_ });
-        this.filesystem = this.fs_proxy_.as(TFilesystem);
-    }
-
-    cache_on () {
-        this.fs_proxy_.delegate = this.fs_cache_;
-    }
-    cache_off () {
-        this.fs_proxy_.delegate = this.fs_nocache_;
-    }
-
-    async initializeSocket () {
-        if ( this.socket ) {
-            this.socket.disconnect();
-        }
-
-        const svc_apiAccess = this._.context.services.get('api-access');
-        const api_info = svc_apiAccess.get_api_info();
-
-        if ( api_info.api_origin === undefined ) {
-            // This will get called again later with updated information
-            return;
-        }
-
-        this.socket = io(api_info.api_origin, {
-            auth: { auth_token: api_info.auth_token },
-            autoUnref: this._.context.env === 'nodejs',
-        });
-
-        this.bindSocketEvents();
-    }
-
-    bindSocketEvents () {
-        this.socket.on('connect', () => {
-            if ( puter.debugMode )
-            {
-                console.log('FileSystem Socket: Connected', this.socket.id);
-            }
-        });
-
-        this.socket.on('disconnect', () => {
-            if ( puter.debugMode )
-            {
-                console.log('FileSystem Socket: Disconnected');
-            }
-        });
-
-        this.socket.on('reconnect', (attempt) => {
-            if ( puter.debugMode )
-            {
-                console.log('FileSystem Socket: Reconnected', this.socket.id);
-            }
-        });
-
-        this.socket.on('reconnect_attempt', (attempt) => {
-            if ( puter.debugMode )
-            {
-                console.log('FileSystem Socket: Reconnection Attemps', attempt);
-            }
-        });
-
-        this.socket.on('reconnect_error', (error) => {
-            if ( puter.debugMode )
-            {
-                console.log('FileSystem Socket: Reconnection Error', error);
-            }
-        });
-
-        this.socket.on('reconnect_failed', () => {
-            if ( puter.debugMode )
-            {
-                console.log('FileSystem Socket: Reconnection Failed');
-            }
-        });
-
-        this.socket.on('error', (error) => {
-            if ( puter.debugMode )
-            {
-                console.error('FileSystem Socket Error:', error);
-            }
-        });
-    }
-}

package/src/services/NoPuterYet.js

@@ -1,20 +0,0 @@
-import putility from '@heyputer/putility';
-
-/**
- * Runs commands on the special `globalThis.when_puter_happens` global, for
- * situations where the `puter` global doesn't exist soon enough.
- */
-export class NoPuterYetService extends putility.concepts.Service {
-    _init () {
-        if ( ! globalThis.when_puter_happens ) return;
-        if ( puter && puter.env !== 'gui' ) return;
-
-        if ( ! Array.isArray(globalThis.when_puter_happens) ) {
-            globalThis.when_puter_happens = [globalThis.when_puter_happens];
-        }
-
-        for ( const fn of globalThis.when_puter_happens ) {
-            fn({ context: this._.context });
-        }
-    }
-}

package/src/services/XDIncoming.js

@@ -1,44 +0,0 @@
-import putility from '@heyputer/putility';
-
-const TeePromise = putility.libs.promise.TeePromise;
-
-/**
- * Manages message events from the window object.
- */
-export class XDIncomingService extends putility.concepts.Service {
-    _construct () {
-        this.filter_listeners_ = [];
-        this.tagged_listeners_ = {};
-    }
-
-    _init () {
-        globalThis.addEventListener('message', async event => {
-            for ( const fn of this.filter_listeners_ ) {
-                const tp = new TeePromise();
-                fn(event, tp);
-                if ( await tp ) return;
-            }
-
-            const data = event.data;
-            if ( ! data ) return;
-            const tag = data.$;
-            if ( ! tag ) return;
-            if ( ! this.tagged_listeners_[tag] ) return;
-
-            for ( const fn of this.tagged_listeners_[tag] ) {
-                fn({ data, source: event.source });
-            }
-        });
-    }
-
-    register_filter_listener (fn) {
-        this.filter_listeners_.push(fn);
-    }
-
-    register_tagged_listener (tag, fn) {
-        if ( ! this.tagged_listeners_[tag] ) {
-            this.tagged_listeners_[tag] = [];
-        }
-        this.tagged_listeners_[tag].push(fn);
-    }
-}