Validate saved data #591

PolinaShneider · 2019-01-09T18:03:58Z

Added plugins data validation

Just run: git submodule update --remote

neSpecc · 2019-01-10T11:11:53Z

src/components/block.ts

   */
-  public validateData(data: BlockToolData): BlockToolData|false {
+  public async validateData(data: BlockToolData): Promise<BlockToolData|false> {


лучше назвать просто validate, как остальные методы

src/components/modules/saver.ts

neSpecc · 2019-01-10T11:13:27Z

src/components/modules/saver.ts

+      blocks.map(async (block: Block, index) => {
+        const validData = await block.validateData(sanitizedData[index].data);
+        if (!validData) {
+          console.warn(`Invalid data in ${sanitizedData[index].tool} Tool!`);


не нужен варнинг

текст лога я скидывал

для логирования есть специальный метод

khaydarov · 2019-01-10T11:13:54Z

src/components/block.ts

   */
-  public validateData(data: BlockToolData): BlockToolData|false {
+  public async validateData(data: BlockToolData): Promise<BlockToolData|false> {


Что вернёт функция? blocktooldata либо всегда false?

blocktooldata, если валидация пройдена. Иначе false

Поменяй тогда и в описании плиз, а то там boolean

А True тоже булев тип

neSpecc · 2019-01-10T11:39:04Z

src/components/modules/saver.ts

+      blocks.map(async (block: Block, index) => {
+        const validData = await block.validate(sanitizedData[index].data);
+        if (!validData) {
+          _.log(`Block «${sanitizedData[index].tool}» skipped because saved data is invalid`, 'warn');


не нужен варнинг

neSpecc · 2019-01-10T11:39:29Z

src/components/modules/saver.ts

@@ -40,6 +41,16 @@ export default class Saver extends Module {
    const extractedData = await Promise.all(chainData);
    const sanitizedData = await Sanitizer.sanitizeBlocks(extractedData);

+    await Promise.all(
+      blocks.map(async (block: Block, index) => {


выше уже есть цикл по блокам, можно просто не пушить невалидные данные

src/components/block.ts

neSpecc · 2019-01-10T12:22:55Z

src/components/modules/saver.ts

-    blocks.forEach((block: Block) => {
-      chainData.push(block.save());
-    });
+    await Promise.all(


зачем тут await? и Promise.all?

src/components/modules/saver.ts

talyguryn

работает

gohabereg · 2019-01-10T13:35:36Z

src/components/block.ts

   */
-  public validateData(data: BlockToolData): BlockToolData|false {
+  public validate(data: BlockToolData): boolean {
    let isValid = true;

    if (this.tool.validate instanceof Function) {
      isValid = this.tool.validate(data);


Надо бы сделать вызов с await на случай, если плагин будет иметь асинхронный validate.

gohabereg · 2019-01-11T16:19:01Z

docs/tools.md

@@ -41,6 +41,8 @@ Process Tool's element created by `render()` function in DOM and return Block's

 ### validate() _optional_

+Allows to check correctness of Tool's `data`. If Tool's data didn't pass the validation it won't be saved.


Стоит описать тогда аргументы и тип возвращаемого значения

gohabereg · 2019-01-11T16:20:04Z

src/components/modules/saver.ts

@@ -34,10 +35,21 @@ export default class Saver extends Module {
    ModificationsObserver.disable();

    blocks.forEach((block: Block) => {
-      chainData.push(block.save());
+      chainData.push(block.save().then(async (blockData) => {


Может лучше тогда все на then переписать. И то, и другое как-то не очень смотрится

gohabereg · 2019-01-11T22:04:37Z

src/components/modules/saver.ts

+   * @param {Block} block - Editor's Tool
+   */
+  private pushValidData(block: Block): Promise<void|{isValid: boolean}> {
+    return Promise.resolve().then(


Это не нужно, сделай сам метод async

gohabereg · 2019-01-11T22:04:56Z

src/components/modules/saver.ts

+   * Calls block's save method and pushes only valid data to blocks array
+   * @param {Block} block - Editor's Tool
+   */
+  private pushValidData(block: Block): Promise<void|{isValid: boolean}> {


Надо бы как-то по-другому метод назвать

src/components/modules/saver.ts

…nto validate-saved-data

Not working

neSpecc · 2019-01-12T02:30:12Z

src/components/modules/saver.ts

+        }
+    });
+
+    extractedData.filter((blockData) => blockData.isValid);


это не рабочий код

src/components/modules/saver.ts

…nto validate-saved-data

neSpecc · 2019-01-12T12:58:34Z

src/components/modules/saver.ts

+
+      return {...blockData, isValid};
+  }
+
  /**
   * Creates output object with saved data, time and version of editor
   * @param {Object} allExtractedData


надо описать тип

PolinaShneider added 5 commits December 21, 2018 23:50

Specify submodule branch for test

9ef5a79

Change branch for testing convenience

dc734ec

Just run: git submodule update --remote

Added checklist submodule for test

fa69336

Attempt to validate data on save

5f19cfe

Rewrite promise.then to async/await

fc3ef98

PolinaShneider requested review from gohabereg, khaydarov, neSpecc and talyguryn as code owners January 9, 2019 18:03

PolinaShneider added 5 commits January 10, 2019 13:53

Move validate logic to saver

dd788f9

Remove extra space

12d504b

Fix tabs

bf4a57a

Don't need async/await here

568e823

Remove submodule

c5effb2

neSpecc requested changes Jan 10, 2019

View reviewed changes

khaydarov reviewed Jan 10, 2019

View reviewed changes

Improve logging, remove empty blocks from data array

ca9216f

neSpecc requested changes Jan 10, 2019

View reviewed changes

PolinaShneider added 2 commits January 10, 2019 14:57

Remove warning

739de39

Loop over blocks only once

5d52cec

neSpecc requested changes Jan 10, 2019

View reviewed changes

src/components/block.ts Show resolved Hide resolved

neSpecc requested changes Jan 10, 2019

View reviewed changes

Make validate non-async

11a85ba

talyguryn approved these changes Jan 10, 2019

View reviewed changes

gohabereg requested changes Jan 10, 2019

View reviewed changes

PolinaShneider added 4 commits January 10, 2019 18:55

Get rid of await Promise.all

07c80e5

Make validate async

c4e41a9

Call plugin's validate method with await

4f37f52

Add docs

ef1b52f

gohabereg requested changes Jan 11, 2019

View reviewed changes

PolinaShneider added 2 commits January 11, 2019 22:20

Update docs

415d68b

Make separate function for tools validation

bd3dbb8

gohabereg requested changes Jan 11, 2019

View reviewed changes

PolinaShneider added 2 commits January 12, 2019 01:09

Rename method

769575a

Add data types interfaces

787b07b

gohabereg reviewed Jan 11, 2019

View reviewed changes

src/components/modules/saver.ts Show resolved Hide resolved

PolinaShneider and others added 12 commits January 12, 2019 02:49

Improve logging

44ea5d7

Desctructure extraction object

1969d7b

Remove useless argument

9796c0a

Update README and changelog

9355fed

Make separate changelog for version

8eaa629

Increase version

fbdb88b

Bump version

da742e1

Merge branch 'master' of https://github.com/codex-team/codex.editor i…

68f7ebc

…nto validate-saved-data

Keep logs at their places

f4689e8

Fix logs order

ec0a3da

Merge branch 'master' of https://github.com/codex-team/codex.editor i…

373567d

…nto validate-saved-data

Pull submodules

83f4766

gohabereg previously approved these changes Jan 12, 2019

View reviewed changes

neSpecc requested changes Jan 12, 2019

View reviewed changes

PolinaShneider added 2 commits January 12, 2019 12:22

Improve logs grouping

08c8251

Merge branch 'master' of https://github.com/codex-team/codex.editor i…

fe87487

…nto validate-saved-data

neSpecc reviewed Jan 12, 2019

View reviewed changes

neSpecc and others added 2 commits January 12, 2019 16:16

log styles improved

6e33bdf

Describe allExtractedData type

79aa7c1

neSpecc approved these changes Jan 12, 2019

View reviewed changes

Improve JSDoc

38b066a

PolinaShneider merged commit fc3e146 into master Jan 12, 2019

PolinaShneider deleted the validate-saved-data branch January 12, 2019 16:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Validate saved data #591

Validate saved data #591

PolinaShneider commented Jan 9, 2019 •

edited

Loading

neSpecc Jan 10, 2019

neSpecc Jan 10, 2019

khaydarov Jan 10, 2019 •

edited

Loading

PolinaShneider Jan 10, 2019

khaydarov Jan 10, 2019

khaydarov Jan 10, 2019

neSpecc Jan 10, 2019

neSpecc Jan 10, 2019

neSpecc Jan 10, 2019

talyguryn left a comment

gohabereg Jan 10, 2019

gohabereg Jan 11, 2019

gohabereg Jan 11, 2019

gohabereg Jan 11, 2019

gohabereg Jan 11, 2019

neSpecc Jan 12, 2019

neSpecc Jan 12, 2019

		@@ -41,6 +41,8 @@ Process Tool's element created by `render()` function in DOM and return Block's

		### validate() _optional_

		Allows to check correctness of Tool's `data`. If Tool's data didn't pass the validation it won't be saved.

Validate saved data #591

Validate saved data #591

Conversation

PolinaShneider commented Jan 9, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

khaydarov Jan 10, 2019 • edited Loading

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

Choose a reason for hiding this comment

talyguryn left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PolinaShneider commented Jan 9, 2019 •

edited

Loading

khaydarov Jan 10, 2019 •

edited

Loading