feat: Add unique ids for each block #1493

cobbcheng · 2020-12-30T13:11:25Z

When editing documents collaboratively, we usually need a unique id to save and identify the current block. This PR is modified and resubmitted based on this #1333 , because this PR is no longer maintained

I'm adressing #873 with this PR.

Tested Features:

Existing data: If your previous block does not have an "id" property, it will create a new unique id
Existing data: If your previous block does have an "id" property, it will keep the existing unique id
Existing data: If a block gets changed the "id" property stays the same
Insert New Block: It will create a new unique id
Copy & Paste blocks: It will create a new unique ids per copied block
Move Blocks (Up/Down): It will keep the existing unique id

Important Note:

If you "transform/transition" an existing block to another block it will receive a NEW unique id

neSpecc · 2021-01-01T16:34:01Z

Please, add a description to the PR. What case you're trying to cover?

cobbcheng · 2021-01-03T03:26:40Z

Please, add a description to the PR. What case you're trying to cover?

I'm sorry this is my negligence, I have added a description

mahono · 2021-01-09T10:58:28Z

Awesome. This is exactly what we need to finally use EditorJs for our system. We also need an ID per block for collaboration features and in some special cases to map (save) each block to a separate database record (which is not possible without an identifier). UUIDv4 perfectly fits. Maybe someone needs another "id generator" but this could be added/opened in a later step. So I can't wait to see this feature in EditorJS. 👍

chumbalayaa · 2021-01-19T16:26:56Z

Yes, we'd love to have uids assigned for each block. Really important for our commenting use case!

khaydarov · 2021-02-04T12:37:39Z

src/components/block/api.ts

@@ -14,6 +14,14 @@ function BlockAPI(
  block: Block
 ): void {
  const blockAPI: BlockAPIInterface = {
+    /**
+     * Tool id


Suggested change

* Tool id

* Block id

khaydarov · 2021-02-04T12:37:57Z

src/components/block/index.ts

@@ -27,6 +27,11 @@ import SelectionUtils from '../selection';
 * Interface describes Block class constructor argument
 */
 interface BlockConstructorOptions {
+  /**
+   * Tool's id


Suggested change

* Tool's id

* Block's id

khaydarov · 2021-02-04T12:38:17Z

src/components/block/index.ts

@@ -107,6 +112,11 @@ export default class Block {
    };
  }

+  /**
+   * unique identifier


Suggested change

* unique identifier

* Block unique identifier

khaydarov · 2021-02-04T12:40:20Z

types/api/block.d.ts

@@ -5,6 +5,11 @@ import {SavedData} from '../data-formats';
 * @interface BlockAPI Describes Block API methods and properties
 */
 export interface BlockAPI {
+  /**
+   * Tool name


Suggested change

* Tool name

* Block unique identifier

khaydarov · 2021-02-04T12:45:04Z

src/components/utils.ts

+ *
+ * @returns {string}
+ */
+export function generateUuidv4(): string {


I think it would be better to name this method just as generateId() and make UUIDv4 "private". E.g.

export function generateId(): string { return uuidv4(); } function uuidv4(): string { // your code }

so that we could change the id generator algorithm

hata6502 · 2021-02-04T13:12:17Z

src/components/modules/paste.ts

@@ -759,7 +759,7 @@ export default class Paste extends Module {
   *
   * @returns {void}
   */
-  private insertEditorJSData(blocks: Array<Pick<SavedData, 'data' | 'tool'>>): void {
+  private insertEditorJSData(blocks: Array<Pick<SavedData, 'id' | 'data' | 'tool'>>): void {


id seems unused.

Suggested change

private insertEditorJSData(blocks: Array<Pick<SavedData, 'id' | 'data' | 'tool'>>): void {

private insertEditorJSData(blocks: Array<Pick<SavedData, 'data' | 'tool'>>): void {

neSpecc · 2021-02-04T13:13:58Z

I think it's better to use nanoid(10) instead of UUIDv4

https://github.com/ai/nanoid

hata6502 · 2021-02-04T13:23:11Z

Should we close the ancestor PR #1333 with respects?

hata6502 · 2021-02-04T13:34:34Z

I think it's better to use nanoid(10) instead of UUIDv4

https://github.com/ai/nanoid

nanoid(10) is not recommended because of the collision rate.
The default behavior nanoid() is as safe as uuid.

https://zelark.github.io/nano-id-cc/

neSpecc · 2021-02-04T17:31:09Z

I think it's better to use nanoid(10) instead of UUIDv4
https://github.com/ai/nanoid

nanoid(10) is not recommended because of the collision rate.
The default behavior nanoid() is as safe as uuid.

https://zelark.github.io/nano-id-cc/

The uniqueness of block ids will be scoped by the single entry. So I think that collision of ids of blocks inside one entry will be rare.

cobbcheng · 2021-02-05T03:18:04Z

Thanks for your suggestions, you are right, I will modify and submit again, thanks!

neSpecc · 2021-02-18T13:45:08Z

src/components/utils.ts

+ * @returns {string}
+ */
+export function generateBlockId(): string {
+  return uuidv4();


Check this comment please #1493 (comment)

Ok i will change to nano(10)

@cobbcheng need any help on this?

evanjmg · 2021-03-03T12:59:12Z

cypress/plugins/index.js

+// the project's config changing)
+
+/**
+ * @type {Cypress.PluginConfig}


This supposed to be here?

marcoancona · 2021-04-05T18:16:44Z

Why is this considered "not ready"? Something I can help with? We would also like to use Editor.js but we are stuck because we cannot merge edits from different users.

mqtik · 2021-04-18T21:24:39Z

I'd like to help too.

mqtik · 2021-04-18T21:25:56Z

Question:
Does this respect blocks already containing an ID?

gohabereg · 2021-04-25T18:42:57Z

Closing due more relevant #1667

feat: Add unique ids for each block

bed0133

cobbcheng requested review from gohabereg, khaydarov and neSpecc as code owners December 30, 2020 13:11

khaydarov requested changes Feb 4, 2021

View reviewed changes

hata6502 reviewed Feb 4, 2021

View reviewed changes

fix: Improve code based on code review

ac5b4ad

milu2003 mentioned this pull request Feb 17, 2021

I want to set a unique ID for each block data. How should I do it? #1542

Closed

neSpecc added the not ready label Feb 18, 2021

neSpecc requested changes Feb 18, 2021

View reviewed changes

evanjmg reviewed Mar 3, 2021

View reviewed changes

cypress/plugins/index.js

// the project's config changing)

/**

* @type {Cypress.PluginConfig}

Copy link

evanjmg Mar 3, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This supposed to be here?

wtmaxim mentioned this pull request Mar 7, 2021

Unique id for each block - fix generate nanoid #1585

Closed

jggc mentioned this pull request Apr 20, 2021

Unique ids in blocks with nanoid #1667

Merged

gohabereg closed this Apr 25, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add unique ids for each block #1493

feat: Add unique ids for each block #1493

cobbcheng commented Dec 30, 2020 •

edited

neSpecc commented Jan 1, 2021

cobbcheng commented Jan 3, 2021

mahono commented Jan 9, 2021

chumbalayaa commented Jan 19, 2021

khaydarov Feb 4, 2021

khaydarov Feb 4, 2021

khaydarov Feb 4, 2021

khaydarov Feb 4, 2021

khaydarov Feb 4, 2021

hata6502 Feb 4, 2021

neSpecc commented Feb 4, 2021

hata6502 commented Feb 4, 2021

hata6502 commented Feb 4, 2021

neSpecc commented Feb 4, 2021

cobbcheng commented Feb 5, 2021

neSpecc Feb 18, 2021

cobbcheng Feb 18, 2021

evanjmg Mar 3, 2021

evanjmg Mar 3, 2021

marcoancona commented Apr 5, 2021

mqtik commented Apr 18, 2021

mqtik commented Apr 18, 2021

gohabereg commented Apr 25, 2021

	private insertEditorJSData(blocks: Array<Pick<SavedData, 'id' \| 'data' \| 'tool'>>): void {
	private insertEditorJSData(blocks: Array<Pick<SavedData, 'data' \| 'tool'>>): void {

feat: Add unique ids for each block #1493

feat: Add unique ids for each block #1493

Conversation

cobbcheng commented Dec 30, 2020 • edited

neSpecc commented Jan 1, 2021

cobbcheng commented Jan 3, 2021

mahono commented Jan 9, 2021

chumbalayaa commented Jan 19, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neSpecc commented Feb 4, 2021

hata6502 commented Feb 4, 2021

hata6502 commented Feb 4, 2021

neSpecc commented Feb 4, 2021

cobbcheng commented Feb 5, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcoancona commented Apr 5, 2021

mqtik commented Apr 18, 2021

mqtik commented Apr 18, 2021

gohabereg commented Apr 25, 2021

cobbcheng commented Dec 30, 2020 •

edited