pleisto / mashcard Goto Github PK

Move username to arguments

Todo list:

• blockCreate, BlockPinOrUnpin, BlockCommit #425
• GroupUpdateMember, PodMembers #431
• ActiveStorage and CreateDirectUpload #441
• BlockSyncBatch
• BlockPins
• ChildrenBlocks
• DocumentInfo
• cleanup user.rb: fetch_current_pod_cache, current_pod_id, current_pod_cache, guess_pod
• cleanup current_pod.rb CurrentPod module
• cleanup specs

1. It's visual test but not virtual test
2. user name and avatar will be different with trunk environment in ci

• separate firefox and chromium

Todo block UI:

1. Placeholder/checkbox style doesn't match Figma design
2. Checkbox should be center-aligned with the text

https://www.figma.com/file/pKCVegQsV7NqwMfhapeWmR/?node-id=6352%3A102575

Background

We currently use an angular-style Folder-by-Feature structure for PWA, but there is a lack of consistent convention for the boundaries and granularity of features. So there is a lot of room for improvement.

https://www.figma.com/file/q3K2LG7Tw0kL3ClLOl3A8w/Components-Web?node-id=1356%3A13886

Trash hovered status:

1. There should be no underline;
2. The width and height of the selected area should be consistent with the page.

https://www.figma.com/file/RyaabEPkCD9l72OwwcNeSl/Web-UI---C-Page?node-id=7325%3A201874

——————

Display error after uploading a image Avatar.

——————

https://www.loom.com/share/db224a02041b444d85ff549bd6db842d

As shown in the video, it flashes when selected text gap.

repo

1. make the slash command to the last block
2. refresh page
3. slash menu will be shown at left top

https://www.loom.com/share/130ba1df54f94580b86dd3367eb599fe

Code block UI:

1. Placeholder style doesn't match Figma design
2. unexpected light gray background

https://www.figma.com/file/pKCVegQsV7NqwMfhapeWmR/?node-id=6104%3A105349

Background

We use a compound document structure that supports the inclusion of sub-pages within any page block, so there is no need real concept of folders. However, based on the user's mental model, we may want to making sub-page blocks look more like folders when they are presented on the parent page.

Design

Figma link

Goals

• Those pages containing sub-pages that do not have an icon set by the user will use the folder icon by default.
• Those pages containing sub-pages will display a list of sub-pages at the bottom of the page like a MacOS Finder.

The source field is used to distinguish whether a file comes from uploading or an external link. Because we need to do some tricks on getting the uploaded file's URL. It is no need to do that now, we can get the uploaded file's URL directly and remove this field on every file-related attributes object.

For Example:

https://github.com/mashcard/mashcard/blob/main/packages/brickdoc-editor/src/extensions/blocks/embed/meta.ts#L77
https://github.com/mashcard/mashcard/blob/main/apps/client-web/src/BrickdocGraphQL.ts#L156

export type BlockAttachment = {
  ...
  /** source */
  source?: Maybe<FileSource>
  ...
}

repo step

1. add paragraph, typing anything
2. add spreadsheet
3. typing spreadsheet title and click next paragraph quickly
4. the cursor will jump to the end of the first paragraph

repo video: https://www.loom.com/share/dc01f3d13022466a888c2b2332b7ae2a

As shown above, the embed icon is incorrect.

https://www.figma.com/file/pKCVegQsV7NqwMfhapeWmR/Web-UI---G-Embed?node-id=6719%3A127638

Tracking issue for:

• https://github.com/mashcard/mashcard/security/code-scanning/10

https://www.figma.com/file/pKCVegQsV7NqwMfhapeWmR/Web-UI---G-Embed?node-id=5033%3A185742

Although I have created a new page, the sidebar menu is still blank.

Link block UI：

1. Link Text View -> incorrect icon
2. incorrect icon color on hover
3. tried many sites but only most cannot show previews
4. at the bottom of the preview box, a site icon, and link title should be here
5. when editing, press 'Enter' doesn't dismiss the popup

https://www.figma.com/file/pKCVegQsV7NqwMfhapeWmR/?node-id=5477%3A283087

https://www.figma.com/file/RyaabEPkCD9l72OwwcNeSl/Web-UI---C-Page?node-id=7669%3A141006

repo step:

1. add page
2. add icon for new page
3. refresh
4. the page tree is disappear

https://www.loom.com/share/f40575f479ef41ccaf16f72312f40256

As shown above, the collaborator avatars are too close to the buttons.

https://www.figma.com/file/RyaabEPkCD9l72OwwcNeSl/?node-id=6596%3A114356

Currently, when we create a new h1 block, there is no text displayed.

We should provide a 'Heading 1' placeholder text here.

A list of all placeholder designs:

Since we already introduced the great state management library zustand, we should no longer use apollo's makeVar for local state management.

prepare for search feature

the extension option name is more like a function but not a hook now. We should correct it like this:

createConversation -> onCreateConversation

The top right and bottom left of the popover need a folded corner to turn the popover into a finished shape to simulate a ceramic texture.

Use case

• tl;dr: formula for automatic text summarization;
• Natural language to formula expression;

Background

Our application consists mainly of PWA and Monolith Server. Since http-only cookies are the only truly secure way to store user authentication credentials in the browser, we currently use a monolith server mounting PWA entrypoint and use cookies to authenticate GraphQL API requests.

As we may package PWA as a desktop app in the future, we need to refactor it to separating the concerns of PWA and Monolith Server.

Goals

• Split user authentication and API authentication;
• Use GraphQL query to instead of globalThis.brickdocContext to access metadata;
• Render and serve PWA entrypoint page using a static web server (To be discussed);
• Admin panel should be part of monolith server;

Solution

Internal Note: Our private monorepo has a PoC implementation of this refactor, which is available here.

We could use inertia.js to build fullstack features with React.js. And use doorkeeper-oidc to implement API authentication logic.

user authentication related features such as sign up, forgot password are implemented in the monolith server by inertia.js. PWA will be focused on the user facing features, and use PKCE flow to authenticate API requests. (The token needs to be stored in memory only, and remember-me will be transparently implemented in the monolith server via a cookie.)

https://www.figma.com/file/RyaabEPkCD9l72OwwcNeSl/Web-UI---C-Page?node-id=7527%3A135537

https://www.figma.com/file/pKCVegQsV7NqwMfhapeWmR/Web-UI---G-Embed?node-id=5796%3A149221

There are also various UI inconsistencies with designs on Figma. Since we didn't create another issue to track these UI issues, so they should be fixed in PRs for this issue too.

Related: https://github.com/pleisto/corp/issues/820. We probably have to refactor link marks.

https://www.figma.com/file/q3K2LG7Tw0kL3ClLOl3A8w/?node-id=1269%3A12973

test

written by @xxx

https://www.figma.com/file/q3K2LG7Tw0kL3ClLOl3A8w/Components-Web?node-id=1356%3A13886

It just a test to create issue by bot by @zhekai Ji

https://www.figma.com/file/RyaabEPkCD9l72OwwcNeSl/Web-UI---C-Page?node-id=7676%3A141096

BubbleMenu extension exists in the BubbleMenu component currently. Move it out to make it configurable in an extension be-like way.

https://www.loom.com/share/cca1a001f5634cb7813874a423444cc5

As shown in the video, It's hard to select the secondary menu: if the mouse moves slowly, the secondary menu will disappear.

Background

The accounts and pod models in this codebase are still legacy versions and need to be migrated to our new design ASAP to avoid schema changes in the future.

Goals

• Using Pod as a unique tenant modal, user and group is essentially a type of pod;
• Migrate configuration fields like invite_enabled to BrickdocConfig model;
• Rename Accounts::Member to Groups::Member to ensure correct semantics;
• Remove Accounts:: prefix from all models;
• Remove owner attribute from Pod model. Use Group::Member instead to simplify;

Solution

User and Group are the two types of pods, and they are inherited from Pod model and share the same database table (STI).

The logic for authentication is implemented in the Users::Authentication model, which is one-to-one relation with the User model. And, features specific to group pods like inviting members are implemented in Group model instead of Pod model.

Internal Note: Our private monorepo has a PoC implementation of this refactor, which is available here.

Schemas

  create_enum "pod_type", ["User", "Group"]
  create_table "pods", force: :cascade do |t|
    # remove t.bigint "owner_id", null: false
    t.string "username", null: false # domain --> username
    t.string "display_name", null: false # name --> display_name
    t.string "bio", limit: 140, comment: "\"Bio\" means Biography in social media."
    # remove: t.boolean "personal", default: false, null: false
    t.datetime "deleted_at"
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false
    # remove: t.boolean "invite_enable", default: false, null: false
    # remove: t.string "invite_secret"
    t.index "lower((domain)::text)", name: "index_pods_on_lower_domain_text", unique: true
    t.index ["deleted_at"], name: "index_pods_on_deleted_at"
    # remove: invite_secret could store in redis.
    # remove: t.index ["invite_secret"], name: "index_pods_on_invite_secret", unique: true
    t.index ["owner_id"], name: "index_pods_on_owner_id"

    # new fields
    t.datetime "suspended_at", comment: "the date when the user was suspended"
    t.integer "suspended_reason", default: 0, comment: "enumeration value for the reason for the user suspension"
    t.string "external_avatar_url"
    t.string "last_pod_username" # migrate from `accounts_users`
    t.string "last_block_ids", default: "{}", null: false # migrate from `accounts_users`
  end

  create_table "users_authentications", force: :cascade do |t|
    t.belongs_to "user", null: false, foreign_key: { to_table: "pods" }
    t.string "email"
    t.string "encrypted_password", default: "", null: false
    t.string "reset_password_token"
    t.datetime "reset_password_sent_at"
    t.datetime "remember_created_at"
    t.integer "sign_in_count", default: 0, null: false
    t.datetime "current_sign_in_at"
    t.datetime "last_sign_in_at"
    t.string "current_sign_in_ip"
    t.string "last_sign_in_ip"
    t.string "confirmation_token"
    t.datetime "confirmed_at"
    t.datetime "confirmation_sent_at"
    t.string "unconfirmed_email"
    t.integer "failed_attempts", default: 0, null: false
    t.string "unlock_token"
    t.datetime "locked_at"
    t.datetime "deleted_at"
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false
    t.index ["confirmation_token"], unique: true
    t.index ["deleted_at"]
    t.index ["email"], unique: true
    t.index ["reset_password_token"], unique: true
    t.index ["unlock_token"], unique: true
  end

It is important to note that although the above schema appears to rename accounts_users to users_authentications, they have completely different semantics. The Users::Authentication model is only responsible for authentication, and the User model inheriting from Pod model being responsible for user information. Theoretically, once the user has logged in, the Users::Authentication is no longer needed.

Model

class Pod < ApplicationRecord
end

class User  < Pod
  has_one :authentication, class_name: "Users::Authentication"
  has_one :pod, class_name: "Pod", foreign_key: "id"
  has_many :group_members, class_name: "Groups::Member", dependent: :destroy
  has_many :groups, through: :group_members
  has_many :owned_groups,
    # don't destroy the user if it is owner of a group
    -> { where(role: :owner) }, through: :group_members, source: :group, dependent: :restrict_with_exception
end

class Group < Pod
  has_many :members, class_name: "Group::Member"
  has_many :members, class_name: 'Groups::Member', dependent: :destroy
  has_many :users, through: :members
  has_one :owner, -> { where(role: :owner) }, through: :members, source: :user
end

module Groups
  class Member < ApplicationRecord
    belongs_to :group, class_name: 'Group', inverse_of: :members
    belongs_to :user, class_name: 'User', inverse_of: :group_members

    ROLES = {
      owner: 0,
      member: 1,
    }
    enum role: ROLES
  end
end

• e2e test
• visual test

The hover status of this button should be：

https://www.figma.com/file/YcVOEbdec2oqyKrYFSkeYW/Components-Base?node-id=3673%3A11297

currently, the editor's i18n depends on the client-web app, it should be set up in the editor. And the editor should also have the ability to customize i18n.

Expect explicit dependency to make the usage of the editor clear. Use of @brickdoc/schema should be limited in the internal of the editor.

issues:

• https://github.com/mashcard/mashcard/blob/main/packages/brickdoc-editor/src/helpers/useUndo.ts#L8
• https://github.com/mashcard/mashcard/blob/main/packages/brickdoc-editor/src/components/editorViews/HistoryList/HistoryList.tsx#L25
• https://github.com/mashcard/mashcard/blob/main/packages/brickdoc-editor/src/components/blockViews/EmbedView/embedTypes/useBlockJustCreated.ts#L6