@shortlink-org/portolan 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +387 -0
- package/catalog/enum_test.go +46 -0
- package/catalog/model.go +932 -0
- package/catalog/roundtrip_test.go +185 -0
- package/catalog/via_test.go +38 -0
- package/cli/portolan.mjs +368 -0
- package/go.mod +14 -0
- package/go.sum +14 -0
- package/index.html +13 -0
- package/internal/commands/cargo.go +154 -0
- package/internal/commands/commands.go +143 -0
- package/internal/commands/commands_test.go +323 -0
- package/internal/commands/gradle.go +77 -0
- package/internal/commands/justfile.go +82 -0
- package/internal/commands/makefile.go +106 -0
- package/internal/commands/maven.go +93 -0
- package/internal/commands/packagejson.go +159 -0
- package/internal/commands/pyproject.go +169 -0
- package/internal/commands/taskfile.go +101 -0
- package/internal/commands/testdata/estate/.cargo/config.toml +7 -0
- package/internal/commands/testdata/estate/Makefile +33 -0
- package/internal/commands/testdata/estate/Taskfile.yml +21 -0
- package/internal/commands/testdata/estate/build.gradle.kts +21 -0
- package/internal/commands/testdata/estate/justfile +20 -0
- package/internal/commands/testdata/estate/package.json +13 -0
- package/internal/commands/testdata/estate/pom.xml +29 -0
- package/internal/commands/testdata/estate/pyproject.toml +27 -0
- package/internal/commands/testdata/estate/xtask/src/main.rs +27 -0
- package/internal/commands/testdata/golden/commands.json +305 -0
- package/internal/gohttp/analyze.go +2500 -0
- package/internal/gohttp/endpoints.go +1067 -0
- package/internal/gohttp/roots.go +320 -0
- package/internal/gohttp/typed.go +143 -0
- package/internal/goscan/constants.go +85 -0
- package/internal/goscan/goscan_test.go +227 -0
- package/internal/goscan/names.go +52 -0
- package/internal/goscan/parse_test.go +11 -0
- package/internal/goscan/source.go +36 -0
- package/internal/goscan/tree.go +155 -0
- package/internal/goscan/types.go +99 -0
- package/internal/wsdl/ids.go +127 -0
- package/internal/wsdl/ids_test.go +21 -0
- package/internal/wsdl/model.go +62 -0
- package/internal/wsdl/parse.go +920 -0
- package/internal/wsdl/parse_test.go +133 -0
- package/package.json +117 -0
- package/plugin/describe.go +107 -0
- package/plugin/describe_test.go +114 -0
- package/plugin/protocol.go +117 -0
- package/plugin/schematest/schematest.go +126 -0
- package/plugins/README.md +1160 -0
- package/plugins/extract-adr/describe.go +19 -0
- package/plugins/extract-adr/describe_test.go +11 -0
- package/plugins/extract-adr/extract.go +153 -0
- package/plugins/extract-adr/extract_test.go +350 -0
- package/plugins/extract-adr/history.go +99 -0
- package/plugins/extract-adr/main.go +65 -0
- package/plugins/extract-adr/options.schema.json +26 -0
- package/plugins/extract-adr/parse.go +642 -0
- package/plugins/extract-adr/parse_test.go +405 -0
- package/plugins/extract-asyncapi/describe.go +19 -0
- package/plugins/extract-asyncapi/describe_test.go +11 -0
- package/plugins/extract-asyncapi/extract.go +315 -0
- package/plugins/extract-asyncapi/extract_test.go +197 -0
- package/plugins/extract-asyncapi/main.go +48 -0
- package/plugins/extract-asyncapi/options.schema.json +26 -0
- package/plugins/extract-asyncapi/spec.go +151 -0
- package/plugins/extract-celery/README.md +169 -0
- package/plugins/extract-celery/extract.py +346 -0
- package/plugins/extract-celery/extract_test.py +192 -0
- package/plugins/extract-celery/main.py +66 -0
- package/plugins/extract-celery/options.py +31 -0
- package/plugins/extract-celery/options.schema.json +31 -0
- package/plugins/extract-celery/producers.py +156 -0
- package/plugins/extract-celery/routes_test.py +106 -0
- package/plugins/extract-commands/describe.go +19 -0
- package/plugins/extract-commands/describe_test.go +11 -0
- package/plugins/extract-commands/extract.go +79 -0
- package/plugins/extract-commands/extract_test.go +92 -0
- package/plugins/extract-commands/main.go +55 -0
- package/plugins/extract-commands/options.schema.json +20 -0
- package/plugins/extract-csr/avro.go +258 -0
- package/plugins/extract-csr/describe.go +19 -0
- package/plugins/extract-csr/describe_test.go +11 -0
- package/plugins/extract-csr/extract.go +338 -0
- package/plugins/extract-csr/extract_test.go +374 -0
- package/plugins/extract-csr/jsonschema.go +343 -0
- package/plugins/extract-csr/lock.go +25 -0
- package/plugins/extract-csr/main.go +84 -0
- package/plugins/extract-csr/options.schema.json +43 -0
- package/plugins/extract-csr/subject.go +102 -0
- package/plugins/extract-django/README.md +386 -0
- package/plugins/extract-django/apps.py +100 -0
- package/plugins/extract-django/auth.py +302 -0
- package/plugins/extract-django/auth_test.py +188 -0
- package/plugins/extract-django/clients.py +121 -0
- package/plugins/extract-django/contracts.py +458 -0
- package/plugins/extract-django/database.py +119 -0
- package/plugins/extract-django/domain.py +318 -0
- package/plugins/extract-django/events.py +86 -0
- package/plugins/extract-django/extract.py +601 -0
- package/plugins/extract-django/extract_test.py +397 -0
- package/plugins/extract-django/flows.py +1278 -0
- package/plugins/extract-django/flows_test.py +338 -0
- package/plugins/extract-django/ids.py +42 -0
- package/plugins/extract-django/ids_test.py +30 -0
- package/plugins/extract-django/lifecycle.py +222 -0
- package/plugins/extract-django/lifecycle_test.py +76 -0
- package/plugins/extract-django/main.py +66 -0
- package/plugins/extract-django/openapi.py +229 -0
- package/plugins/extract-django/openapi_test.py +60 -0
- package/plugins/extract-django/operations.py +96 -0
- package/plugins/extract-django/options.py +61 -0
- package/plugins/extract-django/options.schema.json +126 -0
- package/plugins/extract-django/routing.py +214 -0
- package/plugins/extract-django/routing_test.py +198 -0
- package/plugins/extract-django/serializers.py +558 -0
- package/plugins/extract-django/store.py +434 -0
- package/plugins/extract-django/transport.py +242 -0
- package/plugins/extract-flows/describe.go +19 -0
- package/plugins/extract-flows/describe_test.go +11 -0
- package/plugins/extract-flows/extract.go +91 -0
- package/plugins/extract-flows/main.go +45 -0
- package/plugins/extract-flows/options.schema.json +16 -0
- package/plugins/extract-flows/parse.go +593 -0
- package/plugins/extract-flows/parse_test.go +204 -0
- package/plugins/extract-glossary/describe.go +19 -0
- package/plugins/extract-glossary/describe_test.go +11 -0
- package/plugins/extract-glossary/extract.go +115 -0
- package/plugins/extract-glossary/extract_test.go +220 -0
- package/plugins/extract-glossary/main.go +59 -0
- package/plugins/extract-glossary/options.schema.json +21 -0
- package/plugins/extract-glossary/parse.go +214 -0
- package/plugins/extract-glossary/parse_test.go +203 -0
- package/plugins/extract-go/aggregate.go +214 -0
- package/plugins/extract-go/client.go +409 -0
- package/plugins/extract-go/client_test.go +266 -0
- package/plugins/extract-go/describe.go +19 -0
- package/plugins/extract-go/describe_test.go +11 -0
- package/plugins/extract-go/enum.go +195 -0
- package/plugins/extract-go/enum_test.go +82 -0
- package/plugins/extract-go/event.go +99 -0
- package/plugins/extract-go/extract.go +191 -0
- package/plugins/extract-go/extract_test.go +261 -0
- package/plugins/extract-go/flow.go +1441 -0
- package/plugins/extract-go/flow_test.go +609 -0
- package/plugins/extract-go/httpclient.go +174 -0
- package/plugins/extract-go/httpclient_test.go +296 -0
- package/plugins/extract-go/ids.go +92 -0
- package/plugins/extract-go/layout.go +225 -0
- package/plugins/extract-go/layout_test.go +125 -0
- package/plugins/extract-go/lifecycle.go +324 -0
- package/plugins/extract-go/lifecycle_test.go +108 -0
- package/plugins/extract-go/main.go +79 -0
- package/plugins/extract-go/operation.go +157 -0
- package/plugins/extract-go/options.schema.json +66 -0
- package/plugins/extract-go/source.go +316 -0
- package/plugins/extract-go/transport.go +321 -0
- package/plugins/extract-go/transport_test.go +145 -0
- package/plugins/extract-go/wiring.go +434 -0
- package/plugins/extract-go-nats/describe.go +19 -0
- package/plugins/extract-go-nats/describe_test.go +11 -0
- package/plugins/extract-go-nats/extract.go +177 -0
- package/plugins/extract-go-nats/extract_test.go +389 -0
- package/plugins/extract-go-nats/index.go +379 -0
- package/plugins/extract-go-nats/main.go +42 -0
- package/plugins/extract-go-nats/options.schema.json +21 -0
- package/plugins/extract-go-nats/resolve.go +161 -0
- package/plugins/extract-go-nats/sites.go +224 -0
- package/plugins/extract-graphql/describe.go +19 -0
- package/plugins/extract-graphql/describe_test.go +11 -0
- package/plugins/extract-graphql/extract.go +433 -0
- package/plugins/extract-graphql/extract_test.go +256 -0
- package/plugins/extract-graphql/ids.go +49 -0
- package/plugins/extract-graphql/lex.go +237 -0
- package/plugins/extract-graphql/main.go +51 -0
- package/plugins/extract-graphql/options.schema.json +31 -0
- package/plugins/extract-graphql/parse.go +621 -0
- package/plugins/extract-graphql/parse_test.go +122 -0
- package/plugins/extract-http-clients/describe.go +19 -0
- package/plugins/extract-http-clients/describe_test.go +11 -0
- package/plugins/extract-http-clients/extract.go +705 -0
- package/plugins/extract-http-clients/extract_test.go +1263 -0
- package/plugins/extract-http-clients/main.go +42 -0
- package/plugins/extract-http-clients/options.schema.json +33 -0
- package/plugins/extract-java/README.md +190 -0
- package/plugins/extract-java/build/org/portolan/extract/Catalog.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients$1.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients$2.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients$Call.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients$Client.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients$Route.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Domain$Aggregate.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Domain.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Events$Found.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Events.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Extract.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows$1.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows$Binding.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows$Draft.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows$Frame.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows$Options.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Ids.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Json$Reader.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Json.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Lifecycle$1.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Lifecycle$Move.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Lifecycle.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Main.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/OpenApi$Operation.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/OpenApi$Spec.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/OpenApi.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Operations$1.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Operations$UseCase.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Operations.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Proto$Rpc.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Proto$Service.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Proto.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Protocol$Builder.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Protocol$Input.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Protocol$Options.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Protocol.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Source$Project.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Source$Unit.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Source.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Transport$Endpoint.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Transport.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Yaml$Line.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Yaml$Reader.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Yaml.class +0 -0
- package/plugins/extract-java/options.schema.json +70 -0
- package/plugins/extract-openapi/describe.go +19 -0
- package/plugins/extract-openapi/describe_test.go +11 -0
- package/plugins/extract-openapi/discover.go +243 -0
- package/plugins/extract-openapi/extract.go +526 -0
- package/plugins/extract-openapi/extract_test.go +545 -0
- package/plugins/extract-openapi/main.go +75 -0
- package/plugins/extract-openapi/options.schema.json +62 -0
- package/plugins/extract-openapi/spec.go +350 -0
- package/plugins/extract-project/README.md +22 -0
- package/plugins/extract-project/describe.go +19 -0
- package/plugins/extract-project/describe_test.go +11 -0
- package/plugins/extract-project/extract.go +221 -0
- package/plugins/extract-project/extract_test.go +109 -0
- package/plugins/extract-project/main.go +41 -0
- package/plugins/extract-project/options.schema.json +48 -0
- package/plugins/extract-proto/ast.go +125 -0
- package/plugins/extract-proto/consumes.go +77 -0
- package/plugins/extract-proto/describe.go +19 -0
- package/plugins/extract-proto/extract.go +293 -0
- package/plugins/extract-proto/extract_test.go +459 -0
- package/plugins/extract-proto/ids.go +89 -0
- package/plugins/extract-proto/ids_test.go +57 -0
- package/plugins/extract-proto/lex.go +285 -0
- package/plugins/extract-proto/main.go +100 -0
- package/plugins/extract-proto/module.go +120 -0
- package/plugins/extract-proto/options.schema.json +51 -0
- package/plugins/extract-proto/parse.go +720 -0
- package/plugins/extract-proto/parse_test.go +307 -0
- package/plugins/extract-proto/provides.go +236 -0
- package/plugins/extract-proto/resolve.go +222 -0
- package/plugins/extract-proto/resolve_test.go +119 -0
- package/plugins/extract-python-kafka/README.md +36 -0
- package/plugins/extract-python-kafka/extract.py +211 -0
- package/plugins/extract-python-kafka/extract_test.py +68 -0
- package/plugins/extract-python-kafka/main.py +59 -0
- package/plugins/extract-python-kafka/options.py +29 -0
- package/plugins/extract-python-kafka/options.schema.json +31 -0
- package/plugins/extract-redis/README.md +11 -0
- package/plugins/extract-redis/describe.go +19 -0
- package/plugins/extract-redis/describe_test.go +11 -0
- package/plugins/extract-redis/extract.go +183 -0
- package/plugins/extract-redis/extract_test.go +168 -0
- package/plugins/extract-redis/keyspaces.go +469 -0
- package/plugins/extract-redis/main.go +44 -0
- package/plugins/extract-redis/options.schema.json +30 -0
- package/plugins/extract-river/describe.go +19 -0
- package/plugins/extract-river/describe_test.go +11 -0
- package/plugins/extract-river/extract.go +507 -0
- package/plugins/extract-river/extract_test.go +132 -0
- package/plugins/extract-river/main.go +42 -0
- package/plugins/extract-river/options.schema.json +21 -0
- package/plugins/extract-rust/Cargo.lock +133 -0
- package/plugins/extract-rust/Cargo.toml +23 -0
- package/plugins/extract-rust/README.md +204 -0
- package/plugins/extract-rust/options.schema.json +65 -0
- package/plugins/extract-rust/rustfmt.toml +1 -0
- package/plugins/extract-sql/ddl.go +893 -0
- package/plugins/extract-sql/ddl_test.go +401 -0
- package/plugins/extract-sql/describe.go +19 -0
- package/plugins/extract-sql/describe_test.go +11 -0
- package/plugins/extract-sql/layout.go +221 -0
- package/plugins/extract-sql/layout_test.go +55 -0
- package/plugins/extract-sql/lineage.go +107 -0
- package/plugins/extract-sql/main.go +141 -0
- package/plugins/extract-sql/maps.go +564 -0
- package/plugins/extract-sql/maps_java.go +117 -0
- package/plugins/extract-sql/maps_rust.go +333 -0
- package/plugins/extract-sql/maps_rust_test.go +70 -0
- package/plugins/extract-sql/maps_test.go +204 -0
- package/plugins/extract-sql/maps_ts.go +398 -0
- package/plugins/extract-sql/maps_ts_test.go +136 -0
- package/plugins/extract-sql/options.schema.json +53 -0
- package/plugins/extract-sql/projection.go +70 -0
- package/plugins/extract-sql/projection_test.go +50 -0
- package/plugins/extract-sql/store.go +420 -0
- package/plugins/extract-sql/store_test.go +233 -0
- package/plugins/extract-sql/view.go +295 -0
- package/plugins/extract-ts/README.md +306 -0
- package/plugins/extract-ts/ast.test.ts +178 -0
- package/plugins/extract-ts/ast.ts +648 -0
- package/plugins/extract-ts/clients.ts +185 -0
- package/plugins/extract-ts/domain.ts +164 -0
- package/plugins/extract-ts/extract.test.ts +208 -0
- package/plugins/extract-ts/extract.ts +200 -0
- package/plugins/extract-ts/flows.ts +783 -0
- package/plugins/extract-ts/graphql.test.ts +73 -0
- package/plugins/extract-ts/graphql.ts +181 -0
- package/plugins/extract-ts/ids.test.ts +21 -0
- package/plugins/extract-ts/ids.ts +52 -0
- package/plugins/extract-ts/lifecycle.ts +138 -0
- package/plugins/extract-ts/main.ts +48 -0
- package/plugins/extract-ts/openapi.test.ts +64 -0
- package/plugins/extract-ts/openapi.ts +99 -0
- package/plugins/extract-ts/operations.ts +93 -0
- package/plugins/extract-ts/options.schema.json +96 -0
- package/plugins/extract-ts/source.test.ts +174 -0
- package/plugins/extract-ts/source.ts +465 -0
- package/plugins/extract-ts/transport.ts +147 -0
- package/plugins/extract-ts/tsconfig.json +13 -0
- package/plugins/extract-ts/wiring.ts +190 -0
- package/plugins/extract-watermill/describe.go +19 -0
- package/plugins/extract-watermill/describe_test.go +11 -0
- package/plugins/extract-watermill/extract.go +1228 -0
- package/plugins/extract-watermill/extract_test.go +234 -0
- package/plugins/extract-watermill/main.go +41 -0
- package/plugins/extract-watermill/options.schema.json +21 -0
- package/plugins/extract-wsdl/describe.go +19 -0
- package/plugins/extract-wsdl/describe_test.go +11 -0
- package/plugins/extract-wsdl/extract.go +148 -0
- package/plugins/extract-wsdl/extract_test.go +45 -0
- package/plugins/extract-wsdl/main.go +53 -0
- package/plugins/extract-wsdl/options.schema.json +59 -0
- package/plugins/fetch-bsr/auth.go +114 -0
- package/plugins/fetch-bsr/bsr.go +240 -0
- package/plugins/fetch-bsr/cache.go +66 -0
- package/plugins/fetch-bsr/describe.go +19 -0
- package/plugins/fetch-bsr/fetch.go +192 -0
- package/plugins/fetch-bsr/fetch_test.go +465 -0
- package/plugins/fetch-bsr/lock.go +71 -0
- package/plugins/fetch-bsr/main.go +117 -0
- package/plugins/fetch-bsr/options.schema.json +42 -0
- package/plugins/fetch-csr/auth.go +95 -0
- package/plugins/fetch-csr/cache.go +69 -0
- package/plugins/fetch-csr/describe.go +19 -0
- package/plugins/fetch-csr/describe_test.go +11 -0
- package/plugins/fetch-csr/fetch.go +254 -0
- package/plugins/fetch-csr/fetch_test.go +494 -0
- package/plugins/fetch-csr/lock.go +95 -0
- package/plugins/fetch-csr/main.go +122 -0
- package/plugins/fetch-csr/options.schema.json +42 -0
- package/plugins/fetch-csr/registry.go +209 -0
- package/plugins/fetch-git/cache.go +65 -0
- package/plugins/fetch-git/describe.go +19 -0
- package/plugins/fetch-git/describe_test.go +11 -0
- package/plugins/fetch-git/fetch.go +181 -0
- package/plugins/fetch-git/fetch_test.go +332 -0
- package/plugins/fetch-git/git.go +169 -0
- package/plugins/fetch-git/lock.go +72 -0
- package/plugins/fetch-git/main.go +127 -0
- package/plugins/fetch-git/offline.go +39 -0
- package/plugins/fetch-git/options.schema.json +42 -0
- package/plugins/fetch-git/pin.go +90 -0
- package/plugins/fetch-git/pin_test.go +74 -0
- package/plugins/gen-backstage/describe.go +17 -0
- package/plugins/gen-backstage/main.go +22 -0
- package/plugins/gen-backstage/options.schema.json +30 -0
- package/plugins/gen-backstage/plugin.go +473 -0
- package/plugins/gen-backstage/plugin_test.go +145 -0
- package/plugins/gen-backstage.wasm +0 -0
- package/plugins/gen-markdown/adr.go +162 -0
- package/plugins/gen-markdown/aggregate.go +362 -0
- package/plugins/gen-markdown/canonical.go +93 -0
- package/plugins/gen-markdown/context.go +90 -0
- package/plugins/gen-markdown/coverage_test.go +89 -0
- package/plugins/gen-markdown/describe.go +19 -0
- package/plugins/gen-markdown/describe_test.go +11 -0
- package/plugins/gen-markdown/external.go +71 -0
- package/plugins/gen-markdown/flow.go +277 -0
- package/plugins/gen-markdown/glossary.go +76 -0
- package/plugins/gen-markdown/glossary_test.go +148 -0
- package/plugins/gen-markdown/llms.go +302 -0
- package/plugins/gen-markdown/main.go +22 -0
- package/plugins/gen-markdown/markdown.go +254 -0
- package/plugins/gen-markdown/markdown_test.go +100 -0
- package/plugins/gen-markdown/module.go +107 -0
- package/plugins/gen-markdown/options.schema.json +16 -0
- package/plugins/gen-markdown/plugin.go +39 -0
- package/plugins/gen-markdown/quality_test.go +176 -0
- package/plugins/gen-markdown/redis_test.go +38 -0
- package/plugins/gen-markdown/render.go +344 -0
- package/plugins/gen-markdown/render_test.go +186 -0
- package/plugins/gen-markdown/service.go +456 -0
- package/plugins/gen-markdown/source.go +177 -0
- package/plugins/gen-markdown/store.go +201 -0
- package/plugins/gen-markdown.wasm +0 -0
- package/plugins/gen-mermaid/describe.go +17 -0
- package/plugins/gen-mermaid/main.go +22 -0
- package/plugins/gen-mermaid/options.schema.json +10 -0
- package/plugins/gen-mermaid/plugin.go +104 -0
- package/plugins/gen-mermaid/plugin_test.go +33 -0
- package/plugins/gen-mermaid.wasm +0 -0
- package/plugins/openapi/ids.go +261 -0
- package/plugins/openapi/ids_test.go +98 -0
- package/plugins/pyplugin/catalog.py +209 -0
- package/plugins/pyplugin/celery_conf.py +436 -0
- package/plugins/pyplugin/celery_tasks.py +76 -0
- package/plugins/pyplugin/kafka.py +570 -0
- package/plugins/pyplugin/names.py +38 -0
- package/plugins/pyplugin/protocol.py +79 -0
- package/plugins/pyplugin/source.py +285 -0
- package/plugins/verify-codeowners/describe.go +19 -0
- package/plugins/verify-codeowners/describe_test.go +11 -0
- package/plugins/verify-codeowners/main.go +75 -0
- package/plugins/verify-codeowners/match.go +85 -0
- package/plugins/verify-codeowners/match_test.go +47 -0
- package/plugins/verify-codeowners/options.schema.json +15 -0
- package/plugins/verify-codeowners/owners.go +164 -0
- package/plugins/verify-codeowners/owners_test.go +225 -0
- package/plugins/verify-codeowners/parse.go +90 -0
- package/plugins/verify-codeowners/parse_test.go +62 -0
- package/plugins/verify-otel/describe.go +19 -0
- package/plugins/verify-otel/describe_test.go +11 -0
- package/plugins/verify-otel/main.go +53 -0
- package/plugins/verify-otel/match.go +336 -0
- package/plugins/verify-otel/options.schema.json +30 -0
- package/plugins/verify-otel/otlp.go +200 -0
- package/plugins/verify-otel/verify.go +734 -0
- package/plugins/verify-otel/verify_test.go +460 -0
- package/portolan.json +1073 -0
- package/public/favicon.svg +12 -0
- package/schema/portolan.schema.json +2558 -0
- package/scripts/README.md +53 -0
- package/scripts/build-report.mjs +60 -0
- package/scripts/build-report.test.mjs +44 -0
- package/scripts/builtin-plugins.mjs +49 -0
- package/scripts/catalog-sources.mjs +67 -0
- package/scripts/diff.mjs +315 -0
- package/scripts/diff.test.mjs +151 -0
- package/scripts/forge-comment.mjs +144 -0
- package/scripts/forge-comment.test.mjs +151 -0
- package/scripts/forge-release.mjs +138 -0
- package/scripts/forge-release.test.mjs +106 -0
- package/scripts/forge.mjs +61 -0
- package/scripts/gen-likec4.mjs +854 -0
- package/scripts/gen-likec4.test.mjs +258 -0
- package/scripts/gen.mjs +603 -0
- package/scripts/generated-docs.test.mjs +66 -0
- package/scripts/local-api.mjs +1192 -0
- package/scripts/local-api.test.mjs +387 -0
- package/scripts/manifest.mjs +214 -0
- package/scripts/manifest.test.mjs +148 -0
- package/scripts/output-path.mjs +79 -0
- package/scripts/output-path.test.mjs +45 -0
- package/scripts/package-smoke.mjs +37 -0
- package/scripts/plugin-host.mjs +419 -0
- package/scripts/plugin-host.test.mjs +109 -0
- package/scripts/plugin-wasm-worker.mjs +34 -0
- package/scripts/run-builtin.mjs +81 -0
- package/scripts/schema.mjs +357 -0
- package/scripts/site-docs.mjs +295 -0
- package/scripts/site-docs.test.mjs +181 -0
- package/scripts/vendor-lock.mjs +58 -0
- package/scripts/vendor-lock.test.mjs +69 -0
- package/src/README.md +38 -0
- package/src/app/App.tsx +448 -0
- package/src/app/BranchPicker.test.ts +46 -0
- package/src/app/BranchPicker.tsx +153 -0
- package/src/app/Breadcrumbs.test.ts +38 -0
- package/src/app/Breadcrumbs.tsx +223 -0
- package/src/app/BuildStamp.tsx +146 -0
- package/src/app/CommandPalette.tsx +292 -0
- package/src/app/HashScroll.tsx +45 -0
- package/src/app/Sidebar.tsx +1742 -0
- package/src/app/TopBar.tsx +393 -0
- package/src/app/density.tsx +64 -0
- package/src/app/forge-access.test.ts +27 -0
- package/src/app/forge-access.tsx +80 -0
- package/src/app/panels.tsx +141 -0
- package/src/app/pins.tsx +242 -0
- package/src/app/query-client.ts +24 -0
- package/src/app/responsive.ts +55 -0
- package/src/app/shortcuts.test.ts +39 -0
- package/src/app/shortcuts.tsx +282 -0
- package/src/app/theme.tsx +51 -0
- package/src/app/title.test.ts +14 -0
- package/src/app/title.ts +30 -0
- package/src/app/toast.tsx +59 -0
- package/src/app/tree-keys.test.ts +80 -0
- package/src/app/tree-keys.ts +87 -0
- package/src/app/ui-store.ts +52 -0
- package/src/catalog-error.test.ts +105 -0
- package/src/catalog-profile.test.ts +59 -0
- package/src/catalog-profile.ts +101 -0
- package/src/catalog-stores.test.ts +431 -0
- package/src/catalog.test.ts +1215 -0
- package/src/catalog.ts +3125 -0
- package/src/chat/Cards.tsx +408 -0
- package/src/chat/ChatPanel.tsx +79 -0
- package/src/chat/ChatSettings.tsx +219 -0
- package/src/chat/Composer.tsx +99 -0
- package/src/chat/Conversation.tsx +281 -0
- package/src/chat/Header.tsx +46 -0
- package/src/chat/Message.tsx +49 -0
- package/src/chat/Notice.tsx +195 -0
- package/src/chat/Starter.tsx +67 -0
- package/src/chat/Steps.tsx +45 -0
- package/src/chat/Waiting.tsx +87 -0
- package/src/chat/flags.test.ts +59 -0
- package/src/chat/flags.ts +155 -0
- package/src/chat/linkify.test.ts +30 -0
- package/src/chat/linkify.ts +45 -0
- package/src/chat/prefs.ts +56 -0
- package/src/chat/prompt.test.ts +43 -0
- package/src/chat/prompt.ts +157 -0
- package/src/chat/store.ts +35 -0
- package/src/chat/tools.ts +58 -0
- package/src/chat/transport.ts +70 -0
- package/src/components/AdrRow.tsx +29 -0
- package/src/components/AnchorLink.tsx +67 -0
- package/src/components/ApiReference.tsx +134 -0
- package/src/components/AsyncApiReference.tsx +120 -0
- package/src/components/CatalogStamp.tsx +155 -0
- package/src/components/ChannelRows.tsx +132 -0
- package/src/components/CommandRows.tsx +139 -0
- package/src/components/DiagramSkeleton.tsx +71 -0
- package/src/components/EditorLink.tsx +85 -0
- package/src/components/FieldTree.tsx +305 -0
- package/src/components/FlowTrigger.tsx +34 -0
- package/src/components/Ident.tsx +89 -0
- package/src/components/Integrations.tsx +243 -0
- package/src/components/LifecycleDiagram.tsx +110 -0
- package/src/components/MachineDocs.tsx +42 -0
- package/src/components/Markdown.tsx +173 -0
- package/src/components/MarkdownTable.tsx +206 -0
- package/src/components/Mermaid.tsx +211 -0
- package/src/components/MethodRows.tsx +309 -0
- package/src/components/Overlay.tsx +125 -0
- package/src/components/PageHeader.tsx +189 -0
- package/src/components/RowActions.tsx +97 -0
- package/src/components/SchemaDocument.tsx +89 -0
- package/src/components/Select.tsx +126 -0
- package/src/components/ShapeRows.tsx +118 -0
- package/src/components/SourceDoc.tsx +82 -0
- package/src/components/SourcePreview.tsx +441 -0
- package/src/components/TabRow.tsx +182 -0
- package/src/components/TechIcon.tsx +34 -0
- package/src/components/Toc.tsx +132 -0
- package/src/components/WhatLinksHere.tsx +273 -0
- package/src/components/WsdlReference.tsx +84 -0
- package/src/components/ddd-icons.tsx +107 -0
- package/src/components/kind.tsx +157 -0
- package/src/components/logo.tsx +61 -0
- package/src/components/primitives.tsx +264 -0
- package/src/data.test.ts +18 -0
- package/src/data.ts +202 -0
- package/src/enrich.test.ts +1150 -0
- package/src/enrich.ts +672 -0
- package/src/er/ErCanvas.tsx +533 -0
- package/src/er/RedisSchema.tsx +74 -0
- package/src/er/RelationCard.tsx +267 -0
- package/src/er/StoreHeader.tsx +155 -0
- package/src/er/TableNode.tsx +84 -0
- package/src/er/ViewNode.tsx +83 -0
- package/src/er/layout.test.ts +115 -0
- package/src/er/layout.ts +77 -0
- package/src/er/lineage.test.ts +140 -0
- package/src/er/lineage.ts +107 -0
- package/src/er/markers.tsx +79 -0
- package/src/er/spec.test.ts +344 -0
- package/src/er/spec.ts +426 -0
- package/src/flow/ChainList.tsx +162 -0
- package/src/flow/FlowTable.tsx +123 -0
- package/src/flow/FlowToolbar.tsx +372 -0
- package/src/flow/StepDetail.tsx +380 -0
- package/src/flow/StepRail.tsx +428 -0
- package/src/flow/answers.test.ts +50 -0
- package/src/flow/answers.ts +58 -0
- package/src/flow/chain.test.ts +383 -0
- package/src/flow/chain.ts +353 -0
- package/src/flow/chapters.test.ts +185 -0
- package/src/flow/chapters.ts +225 -0
- package/src/flow/continues.test.ts +102 -0
- package/src/flow/continues.ts +65 -0
- package/src/flow/cross-context.test.ts +97 -0
- package/src/flow/cross-context.ts +35 -0
- package/src/flow/mermaid.test.ts +22 -0
- package/src/flow/mermaid.ts +141 -0
- package/src/flow/outline.test.ts +212 -0
- package/src/flow/outline.ts +170 -0
- package/src/flow/paths.test.ts +129 -0
- package/src/flow/paths.ts +147 -0
- package/src/flow/prefs.test.ts +80 -0
- package/src/flow/prefs.ts +104 -0
- package/src/graph/DependencyGraph.tsx +283 -0
- package/src/graph/DependencyNodes.tsx +162 -0
- package/src/graph/EdgeLabel.tsx +61 -0
- package/src/graph/FocusedEventGraph.tsx +211 -0
- package/src/graph/GraphToolbar.tsx +187 -0
- package/src/graph/RoutedEdge.tsx +80 -0
- package/src/graph/dependency-layout.test.ts +360 -0
- package/src/graph/dependency-layout.ts +444 -0
- package/src/graph/elk.test.ts +70 -0
- package/src/graph/elk.ts +287 -0
- package/src/graph/nodes.tsx +97 -0
- package/src/graph/theme.ts +81 -0
- package/src/graph/useElkFlow.ts +125 -0
- package/src/index.css +1547 -0
- package/src/language/InLanguage.tsx +40 -0
- package/src/language/TermCard.tsx +132 -0
- package/src/language/cards.test.ts +114 -0
- package/src/language/cards.ts +111 -0
- package/src/lib/admonition.test.ts +49 -0
- package/src/lib/admonition.ts +48 -0
- package/src/lib/adr.test.ts +131 -0
- package/src/lib/adr.ts +68 -0
- package/src/lib/api.test.ts +122 -0
- package/src/lib/api.ts +135 -0
- package/src/lib/backlinks.test.ts +330 -0
- package/src/lib/backlinks.ts +567 -0
- package/src/lib/branch-compare.ts +16 -0
- package/src/lib/build-info.test.ts +76 -0
- package/src/lib/build-info.ts +80 -0
- package/src/lib/catalog-diff.test.ts +275 -0
- package/src/lib/catalog-diff.ts +655 -0
- package/src/lib/clipboard.ts +43 -0
- package/src/lib/comparison-memory.test.ts +40 -0
- package/src/lib/comparison-memory.ts +39 -0
- package/src/lib/context-color.ts +27 -0
- package/src/lib/context-map.test.ts +148 -0
- package/src/lib/context-map.ts +399 -0
- package/src/lib/data-model.test.ts +245 -0
- package/src/lib/data-model.ts +399 -0
- package/src/lib/data-problems.test.ts +178 -0
- package/src/lib/data-problems.ts +314 -0
- package/src/lib/derive.test.ts +251 -0
- package/src/lib/derive.ts +515 -0
- package/src/lib/editor-link.test.ts +125 -0
- package/src/lib/editor-link.ts +96 -0
- package/src/lib/editor-prefs.ts +27 -0
- package/src/lib/event-graph.test.ts +237 -0
- package/src/lib/event-graph.ts +327 -0
- package/src/lib/export-canvas.ts +37 -0
- package/src/lib/export-file.test.ts +30 -0
- package/src/lib/export-file.ts +20 -0
- package/src/lib/flow-tree.test.ts +177 -0
- package/src/lib/flow-tree.ts +160 -0
- package/src/lib/forge-refs.test.ts +50 -0
- package/src/lib/forge-refs.ts +60 -0
- package/src/lib/format.test.ts +35 -0
- package/src/lib/format.ts +64 -0
- package/src/lib/github-catalog.test.ts +301 -0
- package/src/lib/github-catalog.ts +610 -0
- package/src/lib/integrations.test.ts +119 -0
- package/src/lib/integrations.ts +133 -0
- package/src/lib/kinds.test.ts +91 -0
- package/src/lib/kinds.ts +204 -0
- package/src/lib/lifecycle.test.ts +93 -0
- package/src/lib/lifecycle.ts +165 -0
- package/src/lib/local-api.ts +194 -0
- package/src/lib/motion-features.ts +11 -0
- package/src/lib/motion.test.ts +120 -0
- package/src/lib/motion.tsx +269 -0
- package/src/lib/palette-recent.test.ts +80 -0
- package/src/lib/palette-recent.ts +90 -0
- package/src/lib/palette.test.ts +365 -0
- package/src/lib/palette.ts +593 -0
- package/src/lib/pins.test.ts +139 -0
- package/src/lib/pins.ts +130 -0
- package/src/lib/problems.test.ts +112 -0
- package/src/lib/project-preview.ts +5 -0
- package/src/lib/proto-problems.test.ts +121 -0
- package/src/lib/proto-problems.ts +65 -0
- package/src/lib/queries.test.ts +113 -0
- package/src/lib/queries.ts +131 -0
- package/src/lib/registry.test.ts +219 -0
- package/src/lib/registry.ts +208 -0
- package/src/lib/scenarios.ts +547 -0
- package/src/lib/setup-info.test.ts +199 -0
- package/src/lib/setup-info.ts +415 -0
- package/src/lib/shape.test.ts +289 -0
- package/src/lib/shape.ts +454 -0
- package/src/lib/sidebar-prefs.test.ts +32 -0
- package/src/lib/sidebar-prefs.ts +75 -0
- package/src/lib/source-code.test.ts +159 -0
- package/src/lib/source-code.ts +286 -0
- package/src/lib/source-doc.test.ts +131 -0
- package/src/lib/source-doc.ts +103 -0
- package/src/lib/source-highlight.test.ts +29 -0
- package/src/lib/source-highlight.ts +24 -0
- package/src/lib/source-link.test.ts +153 -0
- package/src/lib/source-link.ts +201 -0
- package/src/lib/spec-files.test.ts +24 -0
- package/src/lib/spec-files.ts +23 -0
- package/src/lib/table-directive.test.ts +139 -0
- package/src/lib/table-directive.ts +106 -0
- package/src/lib/tech.test.ts +120 -0
- package/src/lib/tech.ts +421 -0
- package/src/lib/terms.test.ts +67 -0
- package/src/lib/terms.ts +179 -0
- package/src/lib/wire-problems.test.ts +263 -0
- package/src/lib/wire-problems.ts +281 -0
- package/src/likec4/C4View.tsx +55 -0
- package/src/likec4/CanvasBridge.tsx +187 -0
- package/src/likec4/FlowView.tsx +235 -0
- package/src/likec4/InteractiveView.tsx +144 -0
- package/src/likec4/canvas-viewport.test.ts +149 -0
- package/src/likec4/canvas-viewport.ts +135 -0
- package/src/likec4/flow-edges.test.ts +51 -0
- package/src/likec4/flow-edges.ts +89 -0
- package/src/likec4/frame-theme.test.ts +76 -0
- package/src/likec4/frame-theme.ts +101 -0
- package/src/likec4/highlight-css.test.ts +49 -0
- package/src/likec4/highlight-css.ts +52 -0
- package/src/likec4/ids.test.ts +151 -0
- package/src/likec4/ids.ts +115 -0
- package/src/likec4/levels.tsx +70 -0
- package/src/likec4/mapping.test.ts +66 -0
- package/src/likec4/mapping.ts +54 -0
- package/src/likec4/reserved.json +141 -0
- package/src/likec4/view-index.ts +78 -0
- package/src/main.tsx +13 -0
- package/src/map/ContextMapGraph.tsx +274 -0
- package/src/map/ContextNode.tsx +70 -0
- package/src/map/FloatingEdge.tsx +86 -0
- package/src/merge.test.ts +1038 -0
- package/src/merge.ts +1004 -0
- package/src/pages/AdrDetail.tsx +242 -0
- package/src/pages/AdrIndex.tsx +114 -0
- package/src/pages/AggregatePage.tsx +727 -0
- package/src/pages/BlockPage.tsx +478 -0
- package/src/pages/CatalogFailure.tsx +111 -0
- package/src/pages/Changes.tsx +313 -0
- package/src/pages/ContextMap.tsx +534 -0
- package/src/pages/ContextPage.tsx +346 -0
- package/src/pages/EnumPage.tsx +282 -0
- package/src/pages/EventPage.tsx +686 -0
- package/src/pages/ExternalPage.tsx +204 -0
- package/src/pages/FlowDetail.tsx +663 -0
- package/src/pages/FlowIndex.tsx +303 -0
- package/src/pages/GraphPage.tsx +217 -0
- package/src/pages/Language.tsx +257 -0
- package/src/pages/ModulePage.tsx +366 -0
- package/src/pages/NotFound.tsx +54 -0
- package/src/pages/Overview.tsx +344 -0
- package/src/pages/Problems.tsx +360 -0
- package/src/pages/RegistryIndex.tsx +118 -0
- package/src/pages/ServicePage.tsx +746 -0
- package/src/pages/Settings.tsx +975 -0
- package/src/pages/StorePage.tsx +114 -0
- package/src/peek/PeekCard.test.ts +35 -0
- package/src/peek/PeekCard.tsx +118 -0
- package/src/peek/PeekLayer.tsx +147 -0
- package/src/peek/model.test.ts +156 -0
- package/src/peek/model.ts +253 -0
- package/src/routes.test.ts +222 -0
- package/src/routes.ts +449 -0
- package/src/selection/DetailPanel.tsx +1407 -0
- package/src/selection/hash.test.ts +73 -0
- package/src/selection/hash.ts +58 -0
- package/src/selection/model.test.ts +199 -0
- package/src/selection/model.ts +473 -0
- package/src/selection/pages.test.ts +115 -0
- package/src/selection/pages.ts +268 -0
- package/src/selection/store.test.ts +62 -0
- package/src/selection/store.ts +46 -0
- package/src/selection/sync.tsx +99 -0
- package/src/table/ColumnsMenu.tsx +72 -0
- package/src/table/DataTable.tsx +780 -0
- package/src/table/Facets.tsx +54 -0
- package/src/table/GroupMenu.tsx +69 -0
- package/src/table/Toolbar.tsx +190 -0
- package/src/table/cells.tsx +117 -0
- package/src/table/compare.test.ts +117 -0
- package/src/table/compare.ts +196 -0
- package/src/table/export.test.ts +88 -0
- package/src/table/export.ts +66 -0
- package/src/table/facet-groups.test.ts +74 -0
- package/src/table/facet-groups.ts +56 -0
- package/src/table/grouping.test.ts +84 -0
- package/src/table/grouping.ts +82 -0
- package/src/table/infer.test.ts +57 -0
- package/src/table/infer.ts +50 -0
- package/src/table/persist.test.ts +76 -0
- package/src/table/persist.ts +112 -0
- package/src/table/sort-url.test.ts +75 -0
- package/src/table/sort-url.ts +52 -0
- package/src/table/types.ts +80 -0
- package/src/table/useTableState.ts +220 -0
- package/src/test-catalog.ts +7 -0
- package/src/testing/estate/data__catalog.json +2847 -0
- package/src/testing/estate/data__flows.json +1724 -0
- package/src/testing/estate/examples__auth__portolan__api.json +212 -0
- package/src/testing/estate/examples__auth__portolan__domain.json +1204 -0
- package/src/testing/estate/examples__auth__portolan__glossary.json +226 -0
- package/src/testing/estate/examples__auth__portolan__observed.json +757 -0
- package/src/testing/estate/examples__auth__portolan__stores.json +195 -0
- package/src/testing/estate/examples__shop__cart__portolan__api.json +234 -0
- package/src/testing/estate/examples__shop__cart__portolan__commands.json +86 -0
- package/src/testing/estate/examples__shop__cart__portolan__domain.json +966 -0
- package/src/testing/estate/examples__shop__cart__portolan__observed.json +498 -0
- package/src/testing/estate/examples__shop__cart__portolan__stores.json +208 -0
- package/src/testing/estate/examples__shop__oms__portolan__glossary.json +98 -0
- package/src/testing/estate/examples__shop__oms__portolan__proto.json +186 -0
- package/src/testing/estate.ts +49 -0
- package/src/trail/Trail.tsx +81 -0
- package/src/trail/model.test.ts +157 -0
- package/src/trail/model.ts +189 -0
- package/src/trail/record.tsx +32 -0
- package/src/trail/store.test.ts +66 -0
- package/src/trail/store.ts +102 -0
- package/tsconfig.json +35 -0
- package/vite.config.ts +171 -0
|
@@ -0,0 +1,419 @@
|
|
|
1
|
+
// Runs a portolan generator plugin and returns what it wants written.
|
|
2
|
+
//
|
|
3
|
+
// A plugin never touches the tree (portolan.0001). It is handed a request on stdin and answers
|
|
4
|
+
// with named files on stdout; writing them - and refusing a name that climbs
|
|
5
|
+
// out of the output directory - is this file's job. That split is what lets the
|
|
6
|
+
// same plugin run as a sandboxed wasm module with no directory preopened at
|
|
7
|
+
// all, and it is why `--check` can compare a render against disk without the
|
|
8
|
+
// plugin knowing there is a disk.
|
|
9
|
+
|
|
10
|
+
import { spawn } from "node:child_process";
|
|
11
|
+
import { createHash } from "node:crypto";
|
|
12
|
+
import {
|
|
13
|
+
mkdirSync,
|
|
14
|
+
readFileSync,
|
|
15
|
+
rmSync,
|
|
16
|
+
statSync,
|
|
17
|
+
writeFileSync,
|
|
18
|
+
} from "node:fs";
|
|
19
|
+
import { mkdtemp } from "node:fs/promises";
|
|
20
|
+
import { tmpdir } from "node:os";
|
|
21
|
+
import { isAbsolute, join } from "node:path";
|
|
22
|
+
import { Worker } from "node:worker_threads";
|
|
23
|
+
|
|
24
|
+
const PORTOLAN_VERSION = "0.1.0";
|
|
25
|
+
const HOST_LIMITS = Object.freeze({
|
|
26
|
+
requestBytes: 4 * 1024 * 1024,
|
|
27
|
+
responseBytes: 16 * 1024 * 1024,
|
|
28
|
+
stderrBytes: 1024 * 1024,
|
|
29
|
+
wasmBytes: 64 * 1024 * 1024,
|
|
30
|
+
timeoutMs: 120_000,
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Runs one plugin.
|
|
35
|
+
*
|
|
36
|
+
* @param {{name: string, wasm?: {url: string, sha256?: string}, process?: {command: string, args?: string[]}}} plugin
|
|
37
|
+
* @param {unknown} request
|
|
38
|
+
* @returns {Promise<{files: {name: string, contents: string}[], describe?: object}>}
|
|
39
|
+
*/
|
|
40
|
+
export async function runPlugin(plugin, request, requestedLimits = {}) {
|
|
41
|
+
const limits = lowerLimits(requestedLimits);
|
|
42
|
+
let payload;
|
|
43
|
+
try {
|
|
44
|
+
payload = JSON.stringify(request);
|
|
45
|
+
} catch (cause) {
|
|
46
|
+
throw new Error(`plugin ${plugin.name}: request is not JSON-serializable: ${cause.message}`);
|
|
47
|
+
}
|
|
48
|
+
if (typeof payload !== "string") {
|
|
49
|
+
throw new Error(`plugin ${plugin.name}: request is not a JSON value`);
|
|
50
|
+
}
|
|
51
|
+
if (Buffer.byteLength(payload) > limits.requestBytes) {
|
|
52
|
+
throw new Error(`plugin ${plugin.name}: request exceeds ${limits.requestBytes} bytes`);
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
const result = plugin.wasm
|
|
56
|
+
? await runWasm(plugin, payload, limits)
|
|
57
|
+
: await runProcess(plugin, payload, limits);
|
|
58
|
+
if (result.stderr) process.stderr.write(result.stderr);
|
|
59
|
+
|
|
60
|
+
let response;
|
|
61
|
+
try {
|
|
62
|
+
response = JSON.parse(result.stdout);
|
|
63
|
+
} catch (cause) {
|
|
64
|
+
throw new Error(
|
|
65
|
+
`plugin ${plugin.name} did not answer with JSON: ${cause.message}`,
|
|
66
|
+
);
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
return { ...validateResponse(plugin.name, response), warnings: warningsIn(result.stderr) };
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* The warnings a plugin wrote to stderr, one per `warning: ` line, without the
|
|
74
|
+
* prefix.
|
|
75
|
+
*
|
|
76
|
+
* They are not part of the response - the protocol has no advisory property a
|
|
77
|
+
* caller may accidentally ignore - but for a service whose tree the extractor
|
|
78
|
+
* only half understood they are the whole story: which packages were not read
|
|
79
|
+
* as aggregates, which record was left out and why. Printed once as they
|
|
80
|
+
* arrive, they scroll off; kept beside the step in the build report, they are
|
|
81
|
+
* the list of what to fix.
|
|
82
|
+
*
|
|
83
|
+
* @param {string} stderr
|
|
84
|
+
* @returns {string[]}
|
|
85
|
+
*/
|
|
86
|
+
export function warningsIn(stderr) {
|
|
87
|
+
const warnings = [];
|
|
88
|
+
for (const line of String(stderr ?? "").split(/\r?\n/)) {
|
|
89
|
+
const warning = line.startsWith("warning: ") ? line.slice("warning: ".length).trim() : "";
|
|
90
|
+
if (warning) warnings.push(warning);
|
|
91
|
+
}
|
|
92
|
+
return warnings;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
function lowerLimits(requested) {
|
|
96
|
+
const limits = {};
|
|
97
|
+
for (const [name, maximum] of Object.entries(HOST_LIMITS)) {
|
|
98
|
+
const value = requested[name];
|
|
99
|
+
limits[name] = Number.isSafeInteger(value) && value > 0
|
|
100
|
+
? Math.min(value, maximum)
|
|
101
|
+
: maximum;
|
|
102
|
+
}
|
|
103
|
+
return limits;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
/** Reject malformed or over-broad responses before they reach the filesystem. */
|
|
107
|
+
export function validateResponse(name, response) {
|
|
108
|
+
if (!response || typeof response !== "object" || Array.isArray(response)) {
|
|
109
|
+
throw new Error(`plugin ${name} answered with a non-object response`);
|
|
110
|
+
}
|
|
111
|
+
const unexpected = Object.keys(response).filter((key) => !["files", "describe"].includes(key));
|
|
112
|
+
if (unexpected.length > 0) {
|
|
113
|
+
throw new Error(`plugin ${name} answered with unsupported properties: ${unexpected.join(", ")}`);
|
|
114
|
+
}
|
|
115
|
+
if (!Array.isArray(response.files)) {
|
|
116
|
+
throw new Error(`plugin ${name} answered without a files list`);
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
const seen = new Set();
|
|
120
|
+
const files = response.files.map((file, index) => {
|
|
121
|
+
if (!file || typeof file !== "object" || Array.isArray(file)) {
|
|
122
|
+
throw new Error(`plugin ${name}: files[${index}] is not an object`);
|
|
123
|
+
}
|
|
124
|
+
const keys = Object.keys(file);
|
|
125
|
+
if (keys.some((key) => !["name", "contents"].includes(key))) {
|
|
126
|
+
throw new Error(`plugin ${name}: files[${index}] has unsupported properties`);
|
|
127
|
+
}
|
|
128
|
+
if (typeof file.name !== "string" || !safeFileName(file.name)) {
|
|
129
|
+
throw new Error(`plugin ${name}: files[${index}] has an unsafe name`);
|
|
130
|
+
}
|
|
131
|
+
if (typeof file.contents !== "string") {
|
|
132
|
+
throw new Error(`plugin ${name}: files[${index}].contents is not a string`);
|
|
133
|
+
}
|
|
134
|
+
if (seen.has(file.name)) {
|
|
135
|
+
throw new Error(`plugin ${name}: duplicate output file ${file.name}`);
|
|
136
|
+
}
|
|
137
|
+
seen.add(file.name);
|
|
138
|
+
return { name: file.name, contents: file.contents };
|
|
139
|
+
});
|
|
140
|
+
|
|
141
|
+
if (response.describe !== undefined) validateDescriptor(name, response.describe);
|
|
142
|
+
return { files, ...(response.describe === undefined ? {} : { describe: response.describe }) };
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
function safeFileName(name) {
|
|
146
|
+
if (!name || name.includes("\0") || isAbsolute(name) || /^[A-Za-z]:[\\/]/.test(name)) return false;
|
|
147
|
+
const parts = name.split(/[\\/]/);
|
|
148
|
+
return parts.every((part) => part !== "" && part !== "." && part !== "..");
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
function validateDescriptor(pluginName, descriptor) {
|
|
152
|
+
if (!descriptor || typeof descriptor !== "object" || Array.isArray(descriptor)) {
|
|
153
|
+
throw new Error(`plugin ${pluginName}: describe is not an object`);
|
|
154
|
+
}
|
|
155
|
+
if (typeof descriptor.name !== "string" || descriptor.name.length === 0) {
|
|
156
|
+
throw new Error(`plugin ${pluginName}: describe.name is missing`);
|
|
157
|
+
}
|
|
158
|
+
if (typeof descriptor.summary !== "string") {
|
|
159
|
+
throw new Error(`plugin ${pluginName}: describe.summary is missing`);
|
|
160
|
+
}
|
|
161
|
+
if (!Array.isArray(descriptor.phases) || descriptor.phases.some((phase) => !["extract", "verify", "generate"].includes(phase))) {
|
|
162
|
+
throw new Error(`plugin ${pluginName}: describe.phases is invalid`);
|
|
163
|
+
}
|
|
164
|
+
if (!descriptor.options || typeof descriptor.options !== "object" || Array.isArray(descriptor.options)) {
|
|
165
|
+
throw new Error(`plugin ${pluginName}: describe.options is invalid`);
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
/**
|
|
170
|
+
* Asks a plugin what it is and what it can be told.
|
|
171
|
+
*
|
|
172
|
+
* The answer is a descriptor with a JSON Schema for its options, which is what
|
|
173
|
+
* schema/portolan.schema.json is composed from. A plugin written against an
|
|
174
|
+
* older protocol answers without one; that comes back as null rather than as
|
|
175
|
+
* an error, because a manifest naming it is not wrong, it is just a manifest
|
|
176
|
+
* nothing can check.
|
|
177
|
+
*
|
|
178
|
+
* @param {{name: string, wasm?: {url: string, sha256?: string}, process?: {command: string, args?: string[]}}} plugin
|
|
179
|
+
*/
|
|
180
|
+
export async function describePlugin(plugin) {
|
|
181
|
+
const { describe } = await runPlugin(plugin, {
|
|
182
|
+
portolanVersion: PORTOLAN_VERSION,
|
|
183
|
+
kind: "describe",
|
|
184
|
+
});
|
|
185
|
+
|
|
186
|
+
return describe ?? null;
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
// ---------------------------------------------------------------------------
|
|
190
|
+
// wasm
|
|
191
|
+
//
|
|
192
|
+
// Node's WASI takes file descriptors rather than pipes, so the request and the
|
|
193
|
+
// response go through a scratch directory. That is the only place the sandbox
|
|
194
|
+
// leaks, and it leaks into a temporary directory the plugin is not told about:
|
|
195
|
+
// `preopens` stays empty, so the module cannot open a path even if it tries.
|
|
196
|
+
// ---------------------------------------------------------------------------
|
|
197
|
+
|
|
198
|
+
async function runWasm(plugin, payload, limits) {
|
|
199
|
+
const bytes = await loadWasm(plugin, limits);
|
|
200
|
+
|
|
201
|
+
const dir = await mkdtemp(join(tmpdir(), "portolan-plugin-"));
|
|
202
|
+
const inPath = join(dir, "request.json");
|
|
203
|
+
const outPath = join(dir, "response.json");
|
|
204
|
+
const errPath = join(dir, "stderr.txt");
|
|
205
|
+
|
|
206
|
+
writeFileSync(inPath, payload);
|
|
207
|
+
writeFileSync(outPath, "");
|
|
208
|
+
writeFileSync(errPath, "");
|
|
209
|
+
|
|
210
|
+
try {
|
|
211
|
+
const worker = new Worker(new URL("./plugin-wasm-worker.mjs", import.meta.url), {
|
|
212
|
+
workerData: { name: plugin.name, bytes, inPath, outPath, errPath },
|
|
213
|
+
});
|
|
214
|
+
const code = await new Promise((resolve, reject) => {
|
|
215
|
+
let settled = false;
|
|
216
|
+
const finish = (cause, value) => {
|
|
217
|
+
if (settled) return;
|
|
218
|
+
settled = true;
|
|
219
|
+
clearTimeout(timer);
|
|
220
|
+
cause ? reject(cause) : resolve(value);
|
|
221
|
+
};
|
|
222
|
+
const timer = setTimeout(async () => {
|
|
223
|
+
if (settled) return;
|
|
224
|
+
settled = true;
|
|
225
|
+
clearTimeout(timer);
|
|
226
|
+
try {
|
|
227
|
+
await worker.terminate();
|
|
228
|
+
} finally {
|
|
229
|
+
reject(new Error(`plugin ${plugin.name}: timed out after ${limits.timeoutMs} ms`));
|
|
230
|
+
}
|
|
231
|
+
}, limits.timeoutMs);
|
|
232
|
+
worker.once("message", (message) => {
|
|
233
|
+
if (message.error) finish(new Error(`plugin ${plugin.name}: ${message.error}`));
|
|
234
|
+
else finish(null, message.code);
|
|
235
|
+
});
|
|
236
|
+
worker.once("error", (cause) => finish(new Error(`plugin ${plugin.name}: ${cause.message}`)));
|
|
237
|
+
worker.once("exit", (exitCode) => {
|
|
238
|
+
finish(new Error(`plugin ${plugin.name}: wasm worker exited ${exitCode} without a response`));
|
|
239
|
+
});
|
|
240
|
+
});
|
|
241
|
+
|
|
242
|
+
if (code !== 0 && code !== undefined) {
|
|
243
|
+
const message = readFileSync(errPath, "utf8").trim();
|
|
244
|
+
throw new Error(
|
|
245
|
+
`plugin ${plugin.name} exited ${code}${message ? `: ${message}` : ""}`,
|
|
246
|
+
);
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
if (statSync(outPath).size > limits.responseBytes) {
|
|
250
|
+
throw new Error(`plugin ${plugin.name}: response exceeds ${limits.responseBytes} bytes`);
|
|
251
|
+
}
|
|
252
|
+
if (statSync(errPath).size > limits.stderrBytes) {
|
|
253
|
+
throw new Error(`plugin ${plugin.name}: stderr exceeds ${limits.stderrBytes} bytes`);
|
|
254
|
+
}
|
|
255
|
+
const stdoutText = readFileSync(outPath, "utf8");
|
|
256
|
+
const stderrText = readFileSync(errPath, "utf8");
|
|
257
|
+
return { stdout: stdoutText, stderr: stderrText };
|
|
258
|
+
} finally {
|
|
259
|
+
rmSync(dir, { recursive: true, force: true });
|
|
260
|
+
}
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
async function loadWasm(plugin, limits) {
|
|
264
|
+
const { url, sha256 } = plugin.wasm;
|
|
265
|
+
|
|
266
|
+
if (url.startsWith("file://")) {
|
|
267
|
+
// Repo-relative, not a URL host. `file://plugins/x.wasm` means the file at
|
|
268
|
+
// plugins/x.wasm next to the manifest, which is the only thing anyone
|
|
269
|
+
// writing that line means.
|
|
270
|
+
const bytes = readFileSync(url.slice("file://".length));
|
|
271
|
+
// A checksum on a local file is optional: it protects a download, not a
|
|
272
|
+
// module that was just built from the source next to it.
|
|
273
|
+
if (sha256) verifyDigest(plugin.name, bytes, sha256);
|
|
274
|
+
|
|
275
|
+
verifyWasmSize(plugin.name, bytes, limits.wasmBytes);
|
|
276
|
+
return bytes;
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
if (!url.startsWith("https://")) {
|
|
280
|
+
throw new Error(
|
|
281
|
+
`plugin ${plugin.name}: wasm url must be https:// or file://, got ${url}`,
|
|
282
|
+
);
|
|
283
|
+
}
|
|
284
|
+
if (!sha256) {
|
|
285
|
+
throw new Error(
|
|
286
|
+
`plugin ${plugin.name}: a downloaded plugin must declare its sha256`,
|
|
287
|
+
);
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
const cacheDir = join("node_modules", ".cache", "portolan-plugins");
|
|
291
|
+
const cached = join(cacheDir, `${sha256}.wasm`);
|
|
292
|
+
try {
|
|
293
|
+
const bytes = readFileSync(cached);
|
|
294
|
+
verifyDigest(plugin.name, bytes, sha256);
|
|
295
|
+
|
|
296
|
+
verifyWasmSize(plugin.name, bytes, limits.wasmBytes);
|
|
297
|
+
return bytes;
|
|
298
|
+
} catch {
|
|
299
|
+
// Not cached yet, or cached wrongly. Either way, fetch it again.
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
const response = await fetch(url, {
|
|
303
|
+
redirect: "error",
|
|
304
|
+
signal: AbortSignal.timeout(limits.timeoutMs),
|
|
305
|
+
});
|
|
306
|
+
if (!response.ok) {
|
|
307
|
+
throw new Error(
|
|
308
|
+
`plugin ${plugin.name}: ${url} answered ${response.status}`,
|
|
309
|
+
);
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
const declaredSize = Number(response.headers.get("content-length"));
|
|
313
|
+
if (Number.isFinite(declaredSize) && declaredSize > limits.wasmBytes) {
|
|
314
|
+
throw new Error(`plugin ${plugin.name}: wasm module exceeds ${limits.wasmBytes} bytes`);
|
|
315
|
+
}
|
|
316
|
+
const chunks = [];
|
|
317
|
+
let size = 0;
|
|
318
|
+
for await (const chunk of response.body) {
|
|
319
|
+
size += chunk.byteLength;
|
|
320
|
+
if (size > limits.wasmBytes) {
|
|
321
|
+
throw new Error(`plugin ${plugin.name}: wasm module exceeds ${limits.wasmBytes} bytes`);
|
|
322
|
+
}
|
|
323
|
+
chunks.push(Buffer.from(chunk));
|
|
324
|
+
}
|
|
325
|
+
const bytes = Buffer.concat(chunks);
|
|
326
|
+
verifyWasmSize(plugin.name, bytes, limits.wasmBytes);
|
|
327
|
+
verifyDigest(plugin.name, bytes, sha256);
|
|
328
|
+
|
|
329
|
+
mkdirSync(cacheDir, { recursive: true });
|
|
330
|
+
writeFileSync(cached, bytes);
|
|
331
|
+
|
|
332
|
+
return bytes;
|
|
333
|
+
}
|
|
334
|
+
|
|
335
|
+
function verifyWasmSize(name, bytes, maximum) {
|
|
336
|
+
if (bytes.byteLength > maximum) {
|
|
337
|
+
throw new Error(`plugin ${name}: wasm module exceeds ${maximum} bytes`);
|
|
338
|
+
}
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
function verifyDigest(name, bytes, expected) {
|
|
342
|
+
const actual = createHash("sha256").update(bytes).digest("hex");
|
|
343
|
+
if (actual !== expected) {
|
|
344
|
+
throw new Error(
|
|
345
|
+
`plugin ${name}: sha256 is ${actual}, the manifest says ${expected}`,
|
|
346
|
+
);
|
|
347
|
+
}
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
// ---------------------------------------------------------------------------
|
|
351
|
+
// process
|
|
352
|
+
//
|
|
353
|
+
// The escape hatch for a generator that needs a toolchain - one reading Go
|
|
354
|
+
// source has to run `go list`, which no wasm module can. It gets the same
|
|
355
|
+
// protocol and none of the sandbox, which is the trade being made and the
|
|
356
|
+
// reason it is not the default.
|
|
357
|
+
// ---------------------------------------------------------------------------
|
|
358
|
+
|
|
359
|
+
function runProcess(plugin, payload, limits) {
|
|
360
|
+
const { command, args = [] } = plugin.process ?? {};
|
|
361
|
+
if (typeof command !== "string" || command.length === 0 || !Array.isArray(args) || args.some((arg) => typeof arg !== "string")) {
|
|
362
|
+
throw new Error(`plugin ${plugin.name}: process must declare command and string args`);
|
|
363
|
+
}
|
|
364
|
+
|
|
365
|
+
return new Promise((resolve, reject) => {
|
|
366
|
+
const child = spawn(command, args, { stdio: ["pipe", "pipe", "pipe"] });
|
|
367
|
+
|
|
368
|
+
const stdout = [];
|
|
369
|
+
const stderr = [];
|
|
370
|
+
let stdoutBytes = 0;
|
|
371
|
+
let stderrBytes = 0;
|
|
372
|
+
let settled = false;
|
|
373
|
+
|
|
374
|
+
const finish = (cause, value) => {
|
|
375
|
+
if (settled) return;
|
|
376
|
+
settled = true;
|
|
377
|
+
clearTimeout(timer);
|
|
378
|
+
cause ? reject(cause) : resolve(value);
|
|
379
|
+
};
|
|
380
|
+
const stopForLimit = (stream, limit) => {
|
|
381
|
+
child.kill("SIGKILL");
|
|
382
|
+
finish(new Error(`plugin ${plugin.name}: ${stream} exceeds ${limit} bytes`));
|
|
383
|
+
};
|
|
384
|
+
|
|
385
|
+
child.stdout.on("data", (chunk) => {
|
|
386
|
+
stdoutBytes += chunk.length;
|
|
387
|
+
if (stdoutBytes > limits.responseBytes) return stopForLimit("response", limits.responseBytes);
|
|
388
|
+
stdout.push(chunk);
|
|
389
|
+
});
|
|
390
|
+
child.stderr.on("data", (chunk) => {
|
|
391
|
+
stderrBytes += chunk.length;
|
|
392
|
+
if (stderrBytes > limits.stderrBytes) return stopForLimit("stderr", limits.stderrBytes);
|
|
393
|
+
stderr.push(chunk);
|
|
394
|
+
});
|
|
395
|
+
|
|
396
|
+
const timer = setTimeout(() => {
|
|
397
|
+
child.kill("SIGKILL");
|
|
398
|
+
finish(new Error(`plugin ${plugin.name}: timed out after ${limits.timeoutMs} ms`));
|
|
399
|
+
}, limits.timeoutMs);
|
|
400
|
+
|
|
401
|
+
child.on("error", (cause) => finish(new Error(`plugin ${plugin.name} did not start: ${cause.message}`)));
|
|
402
|
+
child.on("close", (code) => {
|
|
403
|
+
const stdoutText = Buffer.concat(stdout).toString("utf8");
|
|
404
|
+
const stderrText = Buffer.concat(stderr).toString("utf8");
|
|
405
|
+
if (code !== 0) {
|
|
406
|
+
finish(
|
|
407
|
+
new Error(
|
|
408
|
+
`plugin ${plugin.name} exited ${code}${stderrText ? `: ${stderrText.trim()}` : ""}`,
|
|
409
|
+
),
|
|
410
|
+
);
|
|
411
|
+
|
|
412
|
+
return;
|
|
413
|
+
}
|
|
414
|
+
finish(null, { stdout: stdoutText, stderr: stderrText });
|
|
415
|
+
});
|
|
416
|
+
|
|
417
|
+
child.stdin.end(payload);
|
|
418
|
+
});
|
|
419
|
+
}
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { describe, expect, it } from "vitest";
|
|
2
|
+
import { join } from "node:path";
|
|
3
|
+
import { mkdtempSync, rmSync, writeFileSync } from "node:fs";
|
|
4
|
+
import { tmpdir } from "node:os";
|
|
5
|
+
|
|
6
|
+
import { runPlugin, validateResponse, warningsIn } from "./plugin-host.mjs";
|
|
7
|
+
|
|
8
|
+
describe("plugin response validation", () => {
|
|
9
|
+
it("accepts only named text files", () => {
|
|
10
|
+
expect(validateResponse("fixture", { files: [{ name: "nested/result.json", contents: "{}" }] })).toEqual({
|
|
11
|
+
files: [{ name: "nested/result.json", contents: "{}" }],
|
|
12
|
+
});
|
|
13
|
+
});
|
|
14
|
+
|
|
15
|
+
it.each(["../secret", "/tmp/result", "C:\\tmp\\result", "a/../../secret", "./result"])(
|
|
16
|
+
"rejects unsafe output name %s",
|
|
17
|
+
(name) => {
|
|
18
|
+
expect(() => validateResponse("fixture", { files: [{ name, contents: "" }] })).toThrow("unsafe name");
|
|
19
|
+
},
|
|
20
|
+
);
|
|
21
|
+
|
|
22
|
+
it("rejects duplicate files and removed protocol properties", () => {
|
|
23
|
+
expect(() =>
|
|
24
|
+
validateResponse("fixture", {
|
|
25
|
+
files: [
|
|
26
|
+
{ name: "same", contents: "one" },
|
|
27
|
+
{ name: "same", contents: "two" },
|
|
28
|
+
],
|
|
29
|
+
}),
|
|
30
|
+
).toThrow("duplicate output file");
|
|
31
|
+
expect(() => validateResponse("fixture", { files: [], diagnostics: [] })).toThrow("unsupported properties");
|
|
32
|
+
});
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
describe("process plugins", () => {
|
|
36
|
+
it("passes arguments directly and parses a bounded response", async () => {
|
|
37
|
+
const script = `
|
|
38
|
+
process.stdin.resume();
|
|
39
|
+
process.stdin.on("end", () => process.stdout.write(JSON.stringify({files:[{name:process.argv[1],contents:"ok"}]})));
|
|
40
|
+
`;
|
|
41
|
+
const response = await runPlugin(
|
|
42
|
+
{ name: "fixture", process: { command: process.execPath, args: ["-e", script, "name with spaces.txt"] } },
|
|
43
|
+
{ portolanVersion: "0.1.0" },
|
|
44
|
+
);
|
|
45
|
+
expect(response.files).toEqual([{ name: "name with spaces.txt", contents: "ok" }]);
|
|
46
|
+
expect(response.warnings).toEqual([]);
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
it("keeps the warnings a plugin wrote to stderr beside its response", async () => {
|
|
50
|
+
const script = `
|
|
51
|
+
process.stderr.write("warning: shop.cart: internal/domain/errors has no struct called Errors\\n");
|
|
52
|
+
process.stderr.write("a note that is not a warning\\n");
|
|
53
|
+
process.stderr.write("warning: docs/adr/0004.md: left out of the fragment\\n");
|
|
54
|
+
process.stdin.resume();
|
|
55
|
+
process.stdin.on("end", () => process.stdout.write(JSON.stringify({files:[]})));
|
|
56
|
+
`;
|
|
57
|
+
const response = await runPlugin(
|
|
58
|
+
{ name: "fixture", process: { command: process.execPath, args: ["-e", script] } },
|
|
59
|
+
{ portolanVersion: "0.1.0" },
|
|
60
|
+
);
|
|
61
|
+
expect(response.warnings).toEqual([
|
|
62
|
+
"shop.cart: internal/domain/errors has no struct called Errors",
|
|
63
|
+
"docs/adr/0004.md: left out of the fragment",
|
|
64
|
+
]);
|
|
65
|
+
});
|
|
66
|
+
|
|
67
|
+
it("kills a zip-bomb-like response before buffering it", async () => {
|
|
68
|
+
const script = `process.stdout.write("x".repeat(4096));`;
|
|
69
|
+
await expect(
|
|
70
|
+
runPlugin(
|
|
71
|
+
{ name: "bomb", process: { command: process.execPath, args: ["-e", script] } },
|
|
72
|
+
{},
|
|
73
|
+
{ responseBytes: 1024 },
|
|
74
|
+
),
|
|
75
|
+
).rejects.toThrow("response exceeds 1024 bytes");
|
|
76
|
+
});
|
|
77
|
+
});
|
|
78
|
+
|
|
79
|
+
describe("wasm plugins", () => {
|
|
80
|
+
it("terminates a module whose _start never returns", async () => {
|
|
81
|
+
const dir = mkdtempSync(join(tmpdir(), "portolan-plugin-host-"));
|
|
82
|
+
const path = join(dir, "hang.wasm");
|
|
83
|
+
// (module (memory (export "memory") 1)
|
|
84
|
+
// (func (export "_start") (loop br 0)))
|
|
85
|
+
writeFileSync(path, Buffer.from(
|
|
86
|
+
"0061736d01000000010401600000030201000503010001071302066d656d6f72790200065f737461727400000a0901070003400c000b0b",
|
|
87
|
+
"hex",
|
|
88
|
+
));
|
|
89
|
+
try {
|
|
90
|
+
await expect(
|
|
91
|
+
runPlugin(
|
|
92
|
+
{ name: "hang", wasm: { url: `file://${path}` } },
|
|
93
|
+
{},
|
|
94
|
+
{ timeoutMs: 100 },
|
|
95
|
+
),
|
|
96
|
+
).rejects.toThrow("timed out after 100 ms");
|
|
97
|
+
} finally {
|
|
98
|
+
rmSync(dir, { recursive: true, force: true });
|
|
99
|
+
}
|
|
100
|
+
});
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
describe("warningsIn", () => {
|
|
104
|
+
it("reads only the warning lines, and nothing from an empty stderr", () => {
|
|
105
|
+
expect(warningsIn("")).toEqual([]);
|
|
106
|
+
expect(warningsIn(undefined)).toEqual([]);
|
|
107
|
+
expect(warningsIn("warning: one\r\nnote\nwarning: two \nwarning: \n")).toEqual(["one", "two"]);
|
|
108
|
+
});
|
|
109
|
+
});
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { closeSync, openSync } from "node:fs";
|
|
2
|
+
import { parentPort, workerData } from "node:worker_threads";
|
|
3
|
+
import { WASI } from "node:wasi";
|
|
4
|
+
|
|
5
|
+
async function run() {
|
|
6
|
+
const stdin = openSync(workerData.inPath, "r");
|
|
7
|
+
const stdout = openSync(workerData.outPath, "w");
|
|
8
|
+
const stderr = openSync(workerData.errPath, "w");
|
|
9
|
+
try {
|
|
10
|
+
const wasi = new WASI({
|
|
11
|
+
version: "preview1",
|
|
12
|
+
args: [workerData.name],
|
|
13
|
+
env: {},
|
|
14
|
+
preopens: {},
|
|
15
|
+
stdin,
|
|
16
|
+
stdout,
|
|
17
|
+
stderr,
|
|
18
|
+
});
|
|
19
|
+
const module = await WebAssembly.compile(workerData.bytes);
|
|
20
|
+
const instance = await WebAssembly.instantiate(module, wasi.getImportObject());
|
|
21
|
+
return wasi.start(instance);
|
|
22
|
+
} finally {
|
|
23
|
+
closeSync(stdin);
|
|
24
|
+
closeSync(stdout);
|
|
25
|
+
closeSync(stderr);
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
try {
|
|
30
|
+
const code = await run();
|
|
31
|
+
parentPort.postMessage({ code });
|
|
32
|
+
} catch (cause) {
|
|
33
|
+
parentPort.postMessage({ error: cause instanceof Error ? cause.message : String(cause) });
|
|
34
|
+
}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
// Process adapter for plugins bundled in the npm package. It keeps the
|
|
4
|
+
// plugin's cwd in the user's workspace while resolving source and toolchain
|
|
5
|
+
// files from the installation. Go plugins are compiled into the ignored
|
|
6
|
+
// `.portolan/bin` directory because `go run` changes the child cwd to the
|
|
7
|
+
// module containing the plugin.
|
|
8
|
+
|
|
9
|
+
import { spawn, spawnSync } from "node:child_process";
|
|
10
|
+
import { existsSync, mkdirSync, readFileSync } from "node:fs";
|
|
11
|
+
import { dirname, resolve } from "node:path";
|
|
12
|
+
import { fileURLToPath } from "node:url";
|
|
13
|
+
|
|
14
|
+
const installRoot = resolve(dirname(fileURLToPath(import.meta.url)), "..");
|
|
15
|
+
const workspace = process.cwd();
|
|
16
|
+
const name = process.argv[2];
|
|
17
|
+
const manifest = JSON.parse(readFileSync(resolve(installRoot, "portolan.json"), "utf8"));
|
|
18
|
+
const plugin = (manifest.plugins ?? []).find((candidate) => candidate.name === name);
|
|
19
|
+
|
|
20
|
+
if (!plugin?.process) {
|
|
21
|
+
console.error(`portolan: built-in process plugin ${JSON.stringify(name)} does not exist`);
|
|
22
|
+
process.exit(2);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
const command = plugin.process.command;
|
|
26
|
+
const args = [...(plugin.process.args ?? [])];
|
|
27
|
+
|
|
28
|
+
if (command === "go" && args[0] === "run" && args[1]) {
|
|
29
|
+
const binDir = resolve(workspace, ".portolan", "bin");
|
|
30
|
+
const suffix = process.platform === "win32" ? ".exe" : "";
|
|
31
|
+
const binary = resolve(binDir, `${name}${suffix}`);
|
|
32
|
+
mkdirSync(binDir, { recursive: true });
|
|
33
|
+
|
|
34
|
+
// Rebuilding is deliberately left to Go's build cache. Package upgrades can
|
|
35
|
+
// change shared extractor code without changing this plugin directory, so a
|
|
36
|
+
// timestamp shortcut here would make an old binary look current.
|
|
37
|
+
const built = spawnSync(
|
|
38
|
+
"go",
|
|
39
|
+
["build", "-o", binary, args[1]],
|
|
40
|
+
{ cwd: installRoot, stdio: ["ignore", "ignore", "inherit"] },
|
|
41
|
+
);
|
|
42
|
+
if (built.error) {
|
|
43
|
+
console.error(`portolan: could not start Go to build ${name}: ${built.error.message}`);
|
|
44
|
+
process.exit(1);
|
|
45
|
+
}
|
|
46
|
+
if (built.status !== 0 || !existsSync(binary)) process.exit(built.status ?? 1);
|
|
47
|
+
run(binary, []);
|
|
48
|
+
} else if (command === "cargo" && existsSync(resolve(installRoot, "plugins/extract-rust/target/release/portolan-extract-rust"))) {
|
|
49
|
+
run(resolve(installRoot, "plugins/extract-rust/target/release/portolan-extract-rust"), []);
|
|
50
|
+
} else {
|
|
51
|
+
if (command === "cargo") {
|
|
52
|
+
process.env.CARGO_TARGET_DIR = resolve(workspace, ".portolan", "bin", "cargo");
|
|
53
|
+
}
|
|
54
|
+
const resolved = args.map((arg, index) => {
|
|
55
|
+
if (!arg || arg.startsWith("-") || resolveArgument(command, index) === false) return arg;
|
|
56
|
+
return resolve(installRoot, arg);
|
|
57
|
+
});
|
|
58
|
+
run(command, resolved);
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
function resolveArgument(executable, index) {
|
|
62
|
+
if (["node", "python", "python3"].includes(executable)) return index === 0;
|
|
63
|
+
if (executable === "java") return index === 1;
|
|
64
|
+
if (executable === "cargo") return index === 3;
|
|
65
|
+
return false;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
function run(executable, argv) {
|
|
69
|
+
const child = spawn(executable, argv, { cwd: workspace, stdio: "inherit" });
|
|
70
|
+
child.once("error", (cause) => {
|
|
71
|
+
console.error(`portolan: built-in ${name} did not start: ${cause.message}`);
|
|
72
|
+
process.exitCode = 1;
|
|
73
|
+
});
|
|
74
|
+
child.once("exit", (code, signal) => {
|
|
75
|
+
if (signal) {
|
|
76
|
+
process.kill(process.pid, signal);
|
|
77
|
+
return;
|
|
78
|
+
}
|
|
79
|
+
process.exitCode = code ?? 1;
|
|
80
|
+
});
|
|
81
|
+
}
|