@social-mail/social-mail-web-server 1.5.52 → 1.5.53

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@social-mail/social-mail-web-server",
-  "version": "1.5.52",
+  "version": "1.5.53",
   "description": "## Phase 1",
   "main": "index.js",
   "type": "module",

package/src/server/model/SocialMailContext.ts

@@ -46,6 +46,7 @@ import VerificationToken, { VerificationTokenAddress } from "./entities/Verifica
 import MailboxFolder from "./entities/MailboxFolder.js";
 import HostedZone, { HostedZoneRecord, HostedZoneUser } from "./entities/HostedZone.js";
 import EmailAddressName from "./entities/EmailAddressName.js";
+import NameToken from "./entities/NameToken.js";
 
 @RegisterScoped
 export default class SocialMailContext extends EntityContext {
@@ -124,6 +125,8 @@ export default class SocialMailContext extends EntityContext {
 
     public mailboxSyncTargets = this.model.register(MailboxSyncTarget);
 
+    public nameTokens = this.model.register(NameToken);
+
     public channelConfigs = this.model.register(ChannelConfig);
 
     public subscriberEmails = this.model.register(SubscriberEmail);

package/src/server/model/SocialMailContextEvents.ts

@@ -99,6 +99,8 @@ import HostedZone, { HostedZoneRecord, HostedZoneUser } from "./entities/HostedZ
 import HostedZoneEvents, { HostedZoneRecordEvents, HostedZoneUserEvents } from "./events/HostedZoneEvents.js";
 import EmailAddressName from "./entities/EmailAddressName.js";
 import EmailAddressNameEvents from "./events/EmailAddressNameEvents.js";
+import NameToken from "./entities/NameToken.js";
+import NameTokenEvents from "./events/NameTokenEvents.js";
 
 @RegisterSingleton
 export default class SocialMailContextEvents extends ContextEvents {
@@ -141,6 +143,7 @@ export default class SocialMailContextEvents extends ContextEvents {
         this.register(MailboxContactEmail, MailboxContactEmailEvents);
         this.register(MailboxContactTag, MailboxContactTagEvents);
         this.register(MailboxEmail, MailboxEmailEvents);
+        this.register(NameToken, NameTokenEvents);
         this.register(Store, StoreEvents);
         this.register(StoreUser, StoreUserEvents);
         this.register(StoreItem, StoreItemEvents);

package/src/server/model/entities/EmailAddressName.ts

@@ -3,6 +3,7 @@ import Table from "@entity-access/entity-access/dist/decorators/Table.js";
 import { RelateTo } from "@entity-access/entity-access/dist/decorators/Relate.js";
 import EmailAddress from "./EmailAddress.js";
 import Tag from "./Tag.js";
+import NameToken from "./NameToken.js";
 
 /**
  * This table exists as an index of all historical name tokens used in the email address.
@@ -19,11 +20,11 @@ import Tag from "./Tag.js";
 export default class EmailAddressName {
 
     @Column({ dataType: "BigInt", key: true })
-    @RelateTo(Tag, {
-        property: (x) => x.tag,
+    @RelateTo(NameToken, {
+        property: (x) => x.nameToken,
         inverseProperty: (x) => x.emailAddressNames
     })
-    tagID: number;
+    nameTokenID: number;
 
     @Column({ dataType: "BigInt", key: true })
     @RelateTo(EmailAddress, {
@@ -34,4 +35,5 @@ export default class EmailAddressName {
 
     tag: Tag;
     emailAddress: EmailAddress;
+    nameToken: NameToken;
 }

package/src/server/model/entities/NameToken.ts

@@ -0,0 +1,54 @@
+import CheckConstraint from "@entity-access/entity-access/dist/decorators/CheckConstraint.js";
+import Column from "@entity-access/entity-access/dist/decorators/Column.js";
+import Index from "@entity-access/entity-access/dist/decorators/Index.js";
+import Table from "@entity-access/entity-access/dist/decorators/Table.js";
+import Sql from "@entity-access/entity-access/dist/sql/Sql.js";
+import type EmailAddressName from "./EmailAddressName.js";
+
+/**
+ * Since set of names will intersect with set of tags very rarely.
+ * We want to break names by spaces and save tokens with and without numbers.
+ * We will save username @ domain.com separately for faster search.
+ *
+ * Why not store full text in EmailAddressName itself?
+ * Since one name will be linked with many addresses. It will require less
+ * storage and faster access compared to inbuilt FTS.
+ *
+ * And This is the most importat part for Auto Complete.
+ *
+ * Why store suggest column?
+ * In dropdown we will only display suggestion if the name token has more than
+ * 2 chars.
+ *
+ * So why store less than 2 chars?
+ * User should be able to search `akash.in` by searching for 'in' in the search bar
+ * ignoring auto complete.
+ */
+
+@Table("NameTokens")
+@Index({
+    name: "UX_NameTokens_Unique",
+    unique: true,
+    columns: [
+        { name: (x) => x.word, descending: false },
+    ]
+})
+@Index({
+    name: "IX_NameTokens_Suggest",
+    columns: [ { name: (x) => x.word, descending: false }],
+    filter: (x) => x.suggest === true
+})
+export default class NameToken {
+
+    @Column({ dataType: "BigInt", key: true, generated: "identity"})
+    public nameTokenID: number;
+
+    @Column({ dataType: "Char", length: 400 })
+    public word: string;
+
+    @Column({ dataType:"Boolean", computed: (x) => Sql.text.length(x.word) > 2})
+    public suggest: boolean;
+
+    emailAddressNames: EmailAddressName[];
+
+}

package/src/server/model/entities/Tag.ts

@@ -10,7 +10,6 @@ import type MailboxContactTag from "./MailboxContactTag.js";
 import type EmailTag from "./EmailTag.js";
 import type { StoreItemFolderTag, StoreItemTag, StoreTag } from "./Store.js";
 import type MailboxFolder from "./MailboxFolder.js";
-import type EmailAddressName from "./EmailAddressName.js";
 
 /**
  * The reason tags table exists in form of string,bigint pair is, we need
@@ -84,5 +83,4 @@ export default class Tag {
     storeTags: StoreTag[];
     storeItemFolderTags: StoreItemFolderTag[];
     mailboxFolders: MailboxFolder[];
-    emailAddressNames: EmailAddressName[];
 }

package/src/server/model/events/NameTokenEvents.ts

@@ -0,0 +1,15 @@
+import { IEntityQuery } from "@entity-access/entity-access/dist/model/IFilterWithParameter.js";
+import NameToken from "../entities/NameToken.js";
+import AuthenticatedEvents from "./AuthenticatedEvents.js";
+
+
+export default class NameTokenEvents extends AuthenticatedEvents<NameToken> {
+
+    filter(query: IEntityQuery<NameToken>): IEntityQuery<NameToken> {
+        if (this.verify) {
+            this.sessionUser.ensureLoggedIn();
+        }
+        return query.limit(20);
+    }
+
+}

package/src/server/services/EmailAddressService.ts

@@ -6,7 +6,7 @@ import EntityAccessError from "@entity-access/entity-access/dist/common/EntityAc
 import { cacheFor } from "../../common/cacheFor.js";
 import Domain from "../model/entities/Domain.js";
 import WorkflowContext from "@entity-access/entity-access/dist/workflows/WorkflowContext.js";
-import UpdateEmailAddressNameWorkflow from "../workflows/email-address/UpdateEmailAddressNameWorkflow.js";
+import RepairEmailNameTagsWorkflow from "../workflows/repair/tags/RepairEmailNameTagsWorkflow.js";
 
 
 @RegisterSingleton
@@ -157,7 +157,7 @@ export default class EmailAddressService {
             return await this.getId(emailAddress + "@empty", name);
         }
 
-        const [ e, domainName ] = tokens;
+        const [ username, domainName ] = tokens;
 
         using scope = globalServices.createScope();
         const db = scope.resolve(SocialMailContext);
@@ -189,7 +189,9 @@ export default class EmailAddressService {
                 if (name && ea.name !== name) {
                     // schedule for names tag
                     const wc = ServiceProvider.resolve(this, WorkflowContext);
-                    await wc.queue(UpdateEmailAddressNameWorkflow, { id: ea.emailAddressID, name });
+                    await wc.queue(RepairEmailNameTagsWorkflow, { id: ea.emailAddressID, name });
+                    // we should try to save username as well but without stripping numbers
+                    await wc.queue(RepairEmailNameTagsWorkflow, { id: ea.emailAddressID, name:username, includeNumbers: true });
                 }
                 if(!hasMailbox && ((name && ea.name !== name) || ea.domainID !== domainID)) {
                     ea.name = name;

package/src/server/services/name-tokens/NameTokenService.ts

@@ -0,0 +1,43 @@
+import { RegisterSingleton, ServiceProvider } from "@entity-access/entity-access/dist/di/di.js";
+import SocialMailContext from "../../model/SocialMailContext.js";
+
+@RegisterSingleton
+export default class NameTokenService {
+
+    async updateName(name: string, { emailAddressID }, includeNumbers = false) {
+        name = name?.trim();
+        if (!name) {
+            return [];
+        }
+        name = name.toLowerCase();
+        const ids = [];
+
+        const regex = includeNumbers
+            ? /[^\p{L}\d]+/igmu
+            : /[^\p{L}]+/igmu;
+
+        const tokens = name.split(regex);
+        using scope = ServiceProvider.createScope(this);
+        const db = scope.resolve(SocialMailContext);
+        for (const token of tokens) {
+            if (!token) {
+                continue;
+            }
+            if (token.length < 2) {
+                continue;
+            }
+            const nameTokenID = await this.getOrSaveToken(db, token);
+            if (emailAddressID) {
+                // save tokens..
+                await db.emailAddressNames.statements.selectOrInsert({ emailAddressID, nameTokenID }, { emailAddressID, nameTokenID });
+            }
+            ids.push(nameTokenID);
+        }
+        return ids;
+    }
+
+    private async getOrSaveToken(db: SocialMailContext, word: string) {
+        const w = await db.nameTokens.statements.selectOrInsert({ word }, { word });
+        return w.nameTokenID;
+    }
+}

package/src/server/workflows/repair/tags/RepairEmailNameTagsWorkflow.ts

@@ -4,8 +4,9 @@ import Inject from "@entity-access/entity-access/dist/di/di.js";
 import Hashtags from "../../../../common/Hashtags.js";
 import TagService from "../../../services/tags/TagService.js";
 import { Email } from "../../../model/entities/Email.js";
+import NameTokenService from "../../../services/name-tokens/NameTokenService.js";
 
-export default class RepairEmailNameTagsWorkflow extends Workflow {
+export default class RepairEmailNameTagsWorkflow extends Workflow<{ id: number, name: string, includeNumbers?: boolean }> {
 
     static taskGroup = "batch";
 
@@ -20,9 +21,15 @@ export default class RepairEmailNameTagsWorkflow extends Workflow {
     async fixEmailTags(
         start: number,
         @Inject db?: SocialMailContext,
-        @Inject ts?: TagService
+        @Inject nts?: NameTokenService
     ) {
 
+        if (typeof this.input === "object" && this.input?.id) {
+            const ea = await db.emailAddresses.statements.select({}, { emailAddressID: this.input.id });
+            await nts.updateName(this.input.name, ea, this.input.includeNumbers);
+            return 0;
+        }
+
         for(let i = 0;i< 100;i++) {
             const emails = await db.emailAddresses.where({ start }, (p) => (x) => x.emailAddressID > p.start)
                 .orderBy(void 0, (p) => (x) => x.emailAddressID)
@@ -33,20 +40,15 @@ export default class RepairEmailNameTagsWorkflow extends Workflow {
                 return 0;
             }
 
-            for (const { emailAddressID, name } of emails) {
+            for (const { emailAddressID, name, emailAddress } of emails) {
                 start = emailAddressID;
                 if (!name) {
                     continue;
                 }
-                // fix tag...
-                const tokens = name.split(/[^\p{L}]+/igmu);
-                for (const token of tokens) {
-                    if (!token) {
-                        continue;
-                    }
-                    const tagID = await ts.getSystemTagID(token);
-                    await db.emailAddressNames.statements.selectOrInsert({ tagID, emailAddressID },{ tagID, emailAddressID });
-                }
+                await nts.updateName(name, { emailAddressID });
+                const [username ] = emailAddress.split("@", 2);
+                await nts.updateName(username, { emailAddressID }, true);
+
             }
             db.changeSet.clear();
         }

package/dist/server/workflows/email-address/UpdateEmailAddressNameWorkflow.d.ts

@@ -1,11 +0,0 @@
-import Workflow from "@entity-access/entity-access/dist/workflows/Workflow.js";
-import SocialMailContext from "../../model/SocialMailContext.js";
-import TagService from "../../services/tags/TagService.js";
-export default class UpdateEmailAddressNameWorkflow extends Workflow<{
-    id: number;
-    name: string;
-}> {
-    run(): Promise<number>;
-    update(db?: SocialMailContext, ts?: TagService): Promise<void>;
-}
-//# sourceMappingURL=UpdateEmailAddressNameWorkflow.d.ts.map

package/dist/server/workflows/email-address/UpdateEmailAddressNameWorkflow.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"UpdateEmailAddressNameWorkflow.d.ts","sourceRoot":"","sources":["../../../../src/server/workflows/email-address/UpdateEmailAddressNameWorkflow.ts"],"names":[],"mappings":"AACA,OAAO,QAA4B,MAAM,yDAAyD,CAAC;AACnG,OAAO,iBAAiB,MAAM,kCAAkC,CAAC;AACjE,OAAO,UAAU,MAAM,mCAAmC,CAAC;AAE3D,MAAM,CAAC,OAAO,OAAO,8BAA+B,SAAQ,QAAQ,CAAC;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;IAExF,GAAG;IAMH,MAAM,CACA,EAAE,CAAC,EAAE,iBAAiB,EACtB,EAAE,CAAC,EAAE,UAAU;CAc9B"}

package/dist/server/workflows/email-address/UpdateEmailAddressNameWorkflow.js

@@ -1,44 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-var __param = (this && this.__param) || function (paramIndex, decorator) {
-    return function (target, key) { decorator(target, key, paramIndex); }
-};
-import Inject from "@entity-access/entity-access/dist/di/di.js";
-import Workflow, { UniqueActivity } from "@entity-access/entity-access/dist/workflows/Workflow.js";
-import SocialMailContext from "../../model/SocialMailContext.js";
-import TagService from "../../services/tags/TagService.js";
-export default class UpdateEmailAddressNameWorkflow extends Workflow {
-    async run() {
-        await this.update();
-        return 1;
-    }
-    async update(db, ts) {
-        const { id: emailAddressID } = this.input;
-        // split tags...
-        const tokens = this.input.name.split(/[^\p{L}]+/igmu);
-        for (const token of tokens) {
-            if (!token) {
-                continue;
-            }
-            const tagID = await ts.getSystemTagID(token);
-            await db.emailAddressNames.statements.selectOrInsert({ tagID, emailAddressID }, { tagID, emailAddressID });
-        }
-    }
-}
-__decorate([
-    UniqueActivity,
-    __param(0, Inject),
-    __param(1, Inject),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [SocialMailContext,
-        TagService]),
-    __metadata("design:returntype", Promise)
-], UpdateEmailAddressNameWorkflow.prototype, "update", null);
-//# sourceMappingURL=UpdateEmailAddressNameWorkflow.js.map

package/dist/server/workflows/email-address/UpdateEmailAddressNameWorkflow.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"UpdateEmailAddressNameWorkflow.js","sourceRoot":"","sources":["../../../../src/server/workflows/email-address/UpdateEmailAddressNameWorkflow.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,MAAM,MAAM,4CAA4C,CAAC;AAChE,OAAO,QAAQ,EAAE,EAAE,cAAc,EAAE,MAAM,yDAAyD,CAAC;AACnG,OAAO,iBAAiB,MAAM,kCAAkC,CAAC;AACjE,OAAO,UAAU,MAAM,mCAAmC,CAAC;AAE3D,MAAM,CAAC,OAAO,OAAO,8BAA+B,SAAQ,QAAsC;IAE9F,KAAK,CAAC,GAAG;QACL,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACpB,OAAO,CAAC,CAAC;IACb,CAAC;IAGK,AAAN,KAAK,CAAC,MAAM,CACA,EAAsB,EACtB,EAAe;QAEvB,MAAM,EAAE,EAAE,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAC1C,gBAAgB;QAChB,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACtD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACzB,IAAI,CAAC,KAAK,EAAE,CAAC;gBACT,SAAS;YACb,CAAC;YACD,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC7C,MAAM,EAAE,CAAC,iBAAiB,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,EAAC,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAC;QAC9G,CAAC;IACL,CAAC;CAEJ;AAhBS;IADL,cAAc;IAEV,WAAA,MAAM,CAAA;IACN,WAAA,MAAM,CAAA;;qCADM,iBAAiB;QACjB,UAAU;;4DAY1B"}

package/src/server/workflows/email-address/UpdateEmailAddressNameWorkflow.ts

@@ -1,30 +0,0 @@
-import Inject from "@entity-access/entity-access/dist/di/di.js";
-import Workflow, { UniqueActivity } from "@entity-access/entity-access/dist/workflows/Workflow.js";
-import SocialMailContext from "../../model/SocialMailContext.js";
-import TagService from "../../services/tags/TagService.js";
-
-export default class UpdateEmailAddressNameWorkflow extends Workflow<{ id: number, name: string }> {
-
-    async run() {
-        await this.update();
-        return 1;
-    }
-
-    @UniqueActivity
-    async update(
-        @Inject db?: SocialMailContext,
-        @Inject ts?: TagService
-    ) {
-        const { id: emailAddressID } = this.input;
-        // split tags...
-        const tokens = this.input.name.split(/[^\p{L}]+/igmu);
-        for (const token of tokens) {
-            if (!token) {
-                continue;
-            }
-            const tagID = await ts.getSystemTagID(token);
-            await db.emailAddressNames.statements.selectOrInsert({ tagID, emailAddressID },{ tagID, emailAddressID });
-        }
-    }
-
-}