@wireapp/core 24.4.5 → 25.0.0

package/CHANGELOG.md

@@ -3,6 +3,68 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [25.0.0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@24.4.7...@wireapp/core@25.0.0) (2022-05-02)
+
+
+### Code Refactoring
+
+* Cleanup storage initialization ([#4257](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/issues/4257)) ([cf952c5](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/commit/cf952c5522ccebe2c4e97d7dbb27de447a532032))
+
+
+### BREAKING CHANGES
+
+* The way custom database are given to the `Account` has changed.
+- The constructor signature now changes.
+If you were doing
+
+```js
+const account = new Account(apiClient, createStoreEngine);
+```
+
+Now you need to do 
+
+```js
+const account = new Account(apiClient, {createStore: createStoreEngine});
+```
+
+- The `login` and `init` function do not take a storage engine parameter anymore. You now need to give a `createStore` function to the constructor in order to give a custom storage engine to the core. 
+
+BEFORE
+
+```js
+const account = new Accoun(apiClient);
+
+account.login(data, initClient, clientInfo, database);
+```
+
+AFTER
+
+```js
+const account = new Accoun(apiClient, {createStore: () => database});
+
+account.login(data, initClient, clientInfo);
+```
+
+
+
+
+
+## [24.4.7](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@24.4.6...@wireapp/core@24.4.7) (2022-04-21)
+
+**Note:** Version bump only for package @wireapp/core
+
+
+
+
+
+## [24.4.6](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@24.4.5...@wireapp/core@24.4.6) (2022-04-20)
+
+**Note:** Version bump only for package @wireapp/core
+
+
+
+
+
 ## [24.4.5](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@24.4.4...@wireapp/core@24.4.5) (2022-04-06)
 
 **Note:** Version bump only for package @wireapp/core

package/package.json

@@ -5,7 +5,7 @@
   "dependencies": {
     "@types/long": "4.0.1",
     "@types/node": "~14",
-    "@wireapp/api-client": "18.8.2",
+    "@wireapp/api-client": "19.0.0",
     "@wireapp/cryptobox": "12.8.0",
     "bazinga64": "5.10.0",
     "hash.js": "1.1.7",
@@ -69,6 +69,6 @@
     "test:project": "yarn dist && yarn test",
     "test:node": "nyc jasmine --config=jasmine.json"
   },
-  "version": "24.4.5",
-  "gitHead": "db7082ca9eca742678c4ee8f3e03d94f0704ec42"
+  "version": "25.0.0",
+  "gitHead": "1312d666c6dbae992b9811bf672e3fed303c1e90"
 }

package/src/main/Account.d.ts

@@ -52,11 +52,11 @@ export interface Account {
     on(event: PayloadBundleType.UNKNOWN, listener: (payload: any) => void): this;
     on(event: TOPIC.ERROR, listener: (payload: CoreError) => void): this;
 }
-export declare type StoreEngineProvider = (storeName: string) => Promise<CRUDEngine>;
+export declare type CreateStoreFn = (storeName: string, context: Context) => undefined | Promise<CRUDEngine | undefined>;
 export declare class Account extends EventEmitter {
     private readonly apiClient;
     private readonly logger;
-    private readonly storeEngineProvider;
+    private readonly createStore;
     private storeEngine?;
     static readonly TOPIC: typeof TOPIC;
     service?: {
@@ -77,16 +77,18 @@ export declare class Account extends EventEmitter {
     backendFeatures: BackendFeatures;
     /**
      * @param apiClient The apiClient instance to use in the core (will create a new new one if undefined)
-     * @param storeEngineProvider Used to store info in the database (will create a inMemory engine if undefined)
+     * @param storeEngineProvider Used to store info in the database (will create a inMemory engine if returns undefined)
      */
-    constructor(apiClient?: APIClient, storeEngineProvider?: StoreEngineProvider);
+    constructor(apiClient?: APIClient, { createStore }?: {
+        createStore?: CreateStoreFn;
+    });
     private persistCookie;
     get clientId(): string;
     get userId(): string;
     register(registration: RegisterData, clientType: ClientType): Promise<Context>;
-    init(clientType: ClientType, cookie?: Cookie, initializedStoreEngine?: CRUDEngine): Promise<Context>;
-    initServices(storeEngine: CRUDEngine): Promise<void>;
-    login(loginData: LoginData, initClient?: boolean, clientInfo?: ClientInfo, initializedStoreEngine?: CRUDEngine): Promise<Context>;
+    init(clientType: ClientType, cookie?: Cookie, initClient?: boolean): Promise<Context>;
+    initServices(context: Context): Promise<void>;
+    login(loginData: LoginData, initClient?: boolean, clientInfo?: ClientInfo): Promise<Context>;
     initClient(loginData: LoginData, clientInfo?: ClientInfo, entropyData?: Uint8Array): Promise<{
         isNewClient: boolean;
         localClient: RegisteredClient;

package/src/main/Account.js

@@ -70,9 +70,9 @@ var TOPIC;
 class Account extends events_1.EventEmitter {
     /**
      * @param apiClient The apiClient instance to use in the core (will create a new new one if undefined)
-     * @param storeEngineProvider Used to store info in the database (will create a inMemory engine if undefined)
+     * @param storeEngineProvider Used to store info in the database (will create a inMemory engine if returns undefined)
      */
-    constructor(apiClient = new api_client_1.APIClient(), storeEngineProvider) {
+    constructor(apiClient = new api_client_1.APIClient(), { createStore = () => undefined } = {}) {
         super();
         this.handlePayload = async (payload) => {
             switch (payload.type) {
@@ -90,16 +90,7 @@ class Account extends events_1.EventEmitter {
         };
         this.apiClient = apiClient;
         this.backendFeatures = this.apiClient.backendFeatures;
-        if (storeEngineProvider) {
-            this.storeEngineProvider = storeEngineProvider;
-        }
-        else {
-            this.storeEngineProvider = async (storeName) => {
-                const engine = new store_engine_1.MemoryEngine();
-                await engine.init(storeName);
-                return engine;
-            };
-        }
+        this.createStore = createStore;
         apiClient.on(api_client_1.APIClient.TOPIC.COOKIE_REFRESH, async (cookie) => {
             if (cookie && this.storeEngine) {
                 try {
@@ -127,35 +118,26 @@ class Account extends events_1.EventEmitter {
     }
     async register(registration, clientType) {
         const context = await this.apiClient.register(registration, clientType);
-        const storeEngine = await this.initEngine(context);
-        await this.initServices(storeEngine);
+        await this.initServices(context);
         return context;
     }
-    async init(clientType, cookie, initializedStoreEngine) {
+    async init(clientType, cookie, initClient = true) {
         const context = await this.apiClient.init(clientType, cookie);
-        if (initializedStoreEngine) {
-            this.storeEngine = initializedStoreEngine;
-            this.logger.log(`Initialized store with existing engine "${this.storeEngine.storeName}".`);
-        }
-        else {
-            this.storeEngine = await this.initEngine(context);
-        }
-        await this.initServices(this.storeEngine);
-        if (initializedStoreEngine) {
-            await this.initClient({
-                clientType,
-            });
+        await this.initServices(context);
+        if (initClient) {
+            await this.initClient({ clientType });
         }
         return context;
     }
-    async initServices(storeEngine) {
+    async initServices(context) {
+        this.storeEngine = await this.initEngine(context);
         const accountService = new account_1.AccountService(this.apiClient);
         const assetService = new conversation_1.AssetService(this.apiClient);
-        const cryptographyService = new cryptography_1.CryptographyService(this.apiClient, storeEngine, {
+        const cryptographyService = new cryptography_1.CryptographyService(this.apiClient, this.storeEngine, {
             // We want to encrypt with fully qualified session ids, only if the backend is federated with other backends
             useQualifiedIds: this.backendFeatures.isFederated,
         });
-        const clientService = new client_2.ClientService(this.apiClient, storeEngine, cryptographyService);
+        const clientService = new client_2.ClientService(this.apiClient, this.storeEngine, cryptographyService);
         const connectionService = new connection_1.ConnectionService(this.apiClient);
         const giphyService = new giphy_1.GiphyService(this.apiClient);
         const linkPreviewService = new linkPreview_1.LinkPreviewService(assetService);
@@ -163,7 +145,7 @@ class Account extends events_1.EventEmitter {
             // We can use qualified ids to send messages as long as the backend supports federated endpoints
             useQualifiedIds: this.backendFeatures.federationEndpoints,
         });
-        const notificationService = new notification_1.NotificationService(this.apiClient, cryptographyService, storeEngine);
+        const notificationService = new notification_1.NotificationService(this.apiClient, cryptographyService, this.storeEngine);
         const selfService = new self_1.SelfService(this.apiClient);
         const teamService = new team_1.TeamService(this.apiClient);
         const broadcastService = new broadcast_1.BroadcastService(this.apiClient, cryptographyService);
@@ -184,18 +166,11 @@ class Account extends events_1.EventEmitter {
             user: userService,
         };
     }
-    async login(loginData, initClient = true, clientInfo, initializedStoreEngine) {
+    async login(loginData, initClient = true, clientInfo) {
         this.resetContext();
         auth_2.LoginSanitizer.removeNonPrintableCharacters(loginData);
         const context = await this.apiClient.login(loginData);
-        if (initializedStoreEngine) {
-            this.storeEngine = initializedStoreEngine;
-            this.logger.log(`Initialized store with existing engine "${this.storeEngine.storeName}".`);
-        }
-        else {
-            this.storeEngine = await this.initEngine(context);
-        }
-        await this.initServices(this.storeEngine);
+        await this.initServices(context);
         if (initClient) {
             await this.initClient(loginData, clientInfo);
         }
@@ -291,12 +266,23 @@ class Account extends events_1.EventEmitter {
         const clientType = context.clientType === client_1.ClientType.NONE ? '' : `@${context.clientType}`;
         const dbName = `wire@${this.apiClient.config.urls.name}@${context.userId}${clientType}`;
         this.logger.log(`Initialising store with name "${dbName}"...`);
-        this.storeEngine = await this.storeEngineProvider(dbName);
+        const openDb = async () => {
+            const initializedDb = await this.createStore(dbName, context);
+            if (initializedDb) {
+                this.logger.log(`Initialized store with existing engine "${dbName}".`);
+                return initializedDb;
+            }
+            this.logger.log(`Initialized store with new memory engine "${dbName}".`);
+            const memoryEngine = new store_engine_1.MemoryEngine();
+            await memoryEngine.init(dbName);
+            return memoryEngine;
+        };
+        const storeEngine = await openDb();
         const cookie = auth_1.CookieStore.getCookie();
         if (cookie) {
-            await this.persistCookie(this.storeEngine, cookie);
+            await this.persistCookie(storeEngine, cookie);
         }
-        return this.storeEngine;
+        return storeEngine;
     }
 }
 exports.Account = Account;