Improve sync events

[raucao]

• Add "completed" status to sync-done
  A sync can be done with uncompleted tasks from errored requests. It will then continue during the next periodic sync, trying to fetch the errored items again. However, for UI integration it is useful to know whether the full sync process is completed or not, so it doesn't have to show sync finishing and re-starting several times throughout a long process with many items, which may involve a few attempts here and there.
• Add number of remaining tasks in queue to sync-req-done
  This is just an indicator of overall status, since the internal queue only ever holds 100 items at most. However, for UI integration, it can be useful to know if there's a larger queue left. For example to show a dedicated sync status, as opposed to hiding it in order to not inform the user about small, relatively immediate sync procedures.

[raucao]

I added a fix for a subtle bug in the finishTask function, which made my new tests fail for no obvious reason: d740c0c

[DougReeder]

The changes look good, but when I run npm ci and npm run test:mocha with this branch under Node 14 or 16, I get the error:

TSError: ⨯ Unable to compile TypeScript:
test/helpers/location.ts:90:5 - error TS2322: Type 'Document' is not assignable to type 'never'.

90 global["document"] = {} as Document;
~~~~~~~~~~~~~~~~~~

I don't get that error with the master branch; I'm not certain what's different.

[raucao]

Thanks. I did not change anything in that file, so it's unlikely that this error is related to my changes.

What's also weird is that GitHub didn't run the test actions for the last couple of commits. It still works fine for me on node 16 locally.

[raucao]

@DougReeder Could you try removing your node_modules folder and re-installing all modules from npm?

[DougReeder]

I deleted node-modules and updated npm to 9.6.4, and now when I run npm ci or npm i I get these errors:

npm ERR! code ERESOLVE
npm ERR! ERESOLVE could not resolve
npm ERR!
npm ERR! While resolving: typedoc@0.19.2
npm ERR! Found: typescript@4.8.4
npm ERR! node_modules/typescript
npm ERR! dev typescript@"^4.8.3" from the root project
npm ERR! peer typescript@"*" from ts-loader@8.4.0
npm ERR! node_modules/ts-loader
npm ERR! dev ts-loader@"^8.4.0" from the root project
npm ERR! 2 more (ts-node, tsutils)
npm ERR!
npm ERR! Could not resolve dependency:
npm ERR! peer typescript@"3.9.x || 4.0.x" from typedoc@0.19.2
npm ERR! node_modules/typedoc
npm ERR! dev typedoc@"^0.19.2" from the root project
npm ERR!
npm ERR! Conflicting peer dependency: typescript@4.0.8
npm ERR! node_modules/typescript
npm ERR! peer typescript@"3.9.x || 4.0.x" from typedoc@0.19.2
npm ERR! node_modules/typedoc
npm ERR! dev typedoc@"^0.19.2" from the root project

As noted, this PR doesn't change the dependencies, so I don't see how this issue could have been introduced by it. However. until I figure out what's going on, I can't sign off on this PR. :-(

[raucao]

Ah. You need to use the --force flag with those currently

https://remotestoragejs.readthedocs.io/en/latest/contributing/building.html#setup

See also #1276

[DougReeder]

Thanks for writing tests; that gives me a lot more confidence.

[DougReeder]

I'd prefer to have finishTask be async and use await throughout, but that can wait for a code cleanup.

[raucao]

Yeah, there are a lot of places where we will want to refactor using async/await, since it just wasn't available when the code was first written. In fact, we even had to use a library for promises at the time, because promises were the hot new thing while everyone was using callbacks still. ;)