refactor protobuf handling for split/import
In order to split backend.proto into a more manageable size, the protobuf
handling needed to be updated. This took more time than I would have
liked, as each language handles protobuf differently:
- The Python Protobuf code ignores "package" directives, and relies
solely on how the files are laid out on disk. While it would have been
nice to keep the generated files in a private subpackage, Protobuf gets
confused if the files are located in a location that does not match
their original .proto layout, so the old approach of storing them in
_backend/ will not work. They now clutter up pylib/anki instead. I'm
rather annoyed by that, but alternatives seem to be having to add an extra
level to the Protobuf path, making the other languages suffer, or trying
to hack around the issue by munging sys.modules.
- Protobufjs fails to expose packages if they don't start with a capital
letter, despite the fact that lowercase packages are the norm in most
languages :-( This required a patch to fix.
- Rust was the easiest, as Prost is relatively straightforward compared
to Google's tools.
The Protobuf files are now stored in /proto/anki, with a separate package
for each file. I've split backend.proto into a few files as a test, but
the majority of that work is still to come.
The Python Protobuf building is a bit of a hack at the moment, hard-coding
"proto" as the top level folder, but it seems to get the job done for now.
Also changed the workspace name, as there seems to be a number of Bazel
repos moving away from the more awkward reverse DNS naming style.
2021-07-10 09:50:18 +02:00
|
|
|
// Copyright: Ankitects Pty Ltd and contributors
|
|
|
|
|
// License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
|
|
|
|
|
|
|
|
|
|
import { anki } from "./backend_proto";
|
2021-10-07 15:31:49 +02:00
|
|
|
|
2021-07-10 11:52:31 +02:00
|
|
|
import Cards = anki.cards;
|
2021-07-10 12:44:22 +02:00
|
|
|
import DeckConfig = anki.deckconfig;
|
2021-10-14 11:22:47 +02:00
|
|
|
import Generic = anki.generic;
|
2021-07-10 12:44:22 +02:00
|
|
|
import Notetypes = anki.notetypes;
|
2021-07-10 13:33:12 +02:00
|
|
|
import Scheduler = anki.scheduler;
|
2021-07-10 13:58:34 +02:00
|
|
|
import Stats = anki.stats;
|
2021-09-08 09:22:30 +02:00
|
|
|
import Tags = anki.tags;
|
update to latest rules_nodejs & switch to ts_project
ts_library() is deprecated and will presumably be dropped from a
future rules_nodejs, and it wasn't working with the jest tests
after updating, so we switch over to ts_project().
There are some downsides:
- It's a bit slower, as the worker mode doesn't appear to function
at the moment.
- Getting it working with a mix of source files and generated files
was quite tricky, especially as things behave differently on Windows,
and differently when editing with VS Code. Solved with a small patch
to the rules, and a wrapper script that copies everything into the
bin folder first. To keep VS Code working correctly as well, the built
files are symlinked into the source folder.
- TS libraries are not implicitly linked to node_modules, so they
can't be imported with an absolute name like "lib/proto" - we need
to use relative paths like "../lib/proto" instead. Adjusting "paths"
in tsconfig.json makes it work for TS compilation, but then it fails
at the esbuild stage. We could resolve it by wrapping the TS
libraries in a subsequent js_library() call, but that has the downside
of losing the transient dependencies, meaning they need to be listed
again. Alternatively we might be able to solve it in the future by
adjusting esbuild, but for now the paths have been made relative to
keep things simple.
Upsides:
- Along with updates to the Svelte tooling, Svelte typing has improved.
All exports made in a Svelte file are now visible to other files that
import them, and we no longer rebuild the Svelte files when TS files
are updated, as the Svelte files do no type checking themselves, and
are just a simple transpilation. Svelte-check now works on Windows again,
and there should be no errors when editing in VS Code after you've
built the project. The only downside seems to be that cmd+clicking
on a Svelte imports jumps to the .d.ts file instead of the original now;
presumably they'll fix that in a future plugin update.
- Each subfolder now has its own tsconfig.json, and tsc can be called
directly for testing purposes (but beware it will place build products
in the source tree): ts/node_modules/.bin/tsc -b ts
- We can drop the custom esbuild_toolchain, as it's included in the
latest rules_nodejs.
Other changes:
- "image_module_support" is moved into lib/, and imported with
<reference types=...>
- Images are now imported directly from their npm package; the
extra copy step has been removed.
Windows users may need to use "bazel clean" before building this,
due to old files lying around in the build folder.
2021-09-30 14:16:29 +02:00
|
|
|
|
2021-09-08 09:22:30 +02:00
|
|
|
export { Stats, Cards, DeckConfig, Notetypes, Scheduler, Tags };
|
2021-10-14 11:22:47 +02:00
|
|
|
|
|
|
|
|
export function unwrapOptionalNumber(
|
|
|
|
|
msg:
|
|
|
|
|
| Generic.IInt64
|
|
|
|
|
| Generic.IUInt32
|
|
|
|
|
| Generic.IInt32
|
|
|
|
|
| Generic.OptionalInt32
|
|
|
|
|
| Generic.OptionalUInt32
|
|
|
|
|
| null
|
|
|
|
|
| undefined
|
|
|
|
|
): number | undefined {
|
|
|
|
|
if (msg && msg !== null) {
|
|
|
|
|
if (msg.val !== null) {
|
|
|
|
|
return msg.val;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return undefined;
|
|
|
|
|
}
|