backend_core: Zig から protobuf を利用する 使っている Gremlin というコード生成ライブラリと Zig という言語の 仕様上、 proto でライブラリを出力、というのはハックになってしまう。 そのため、多少効率は悪くなるが利用側で都度出力する形にした。 Protobuf は .proto 毎にソースファイルを生成、という形だが Zig は 配布形態に合わせたパッケージングとなる。つまり、静的・動的な ライブラリや実行ファイルがモジュールの単位となる。そのため「複数 ファイル群をモジュールとして公開」ということはできない。 このコミットでは protobuf の wkt (well-known types) の追加も 含まれている。これは Gremlin が protoc に対応しておらず wkt が 含まれていないため。このベンダリングに伴うライセンス周りの変更も 入っているため少し変更ファイル数が多くなっている。

Changes

14 changed files (+562/-1)

• .editorconfig
  • @@ -33,3 +33,8 @@ # terraform fmt は 2 スペース以外の指定ができない。
    [*.tf] indent_style = space indent_size = 2 + + # zig fmt は 4 スペース以外の指定ができない。 + [*.{zig,zon}] + indent_style = space + indent_size = 4
• .gitignore
  • @@ -35,3 +35,11 @@ .env
    # What: wireit のキャッシュディレクトリ。 .wireit + + # What: Zig のビルド出力先。 + # Why: ソースコードを元に生成されるもののため。ここにファイルをコピーすることはあっても + # このディレクトリをチェックインすることはない。 + zig-out + + # What: Zig のキャッシュディレクトリ。 + .zig-cache
• .tool-versions
  • @@ -8,3 +8,4 @@ bun 1.1.45
    terraform 1.10.3 protoc-gen-go 1.36.5 go 1.24.1 + zig 0.14.0
• LICENSES/BSD-3-Clause.txt (new)
  • @@ -0,0 +1,11 @@
    + Copyright (c) <year> <owner>. + + Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + + 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + + 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + + 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
• dprint.jsonc
  • @@ -23,6 +23,14 @@ },
    { "exts": ["go"], "command": "gofmt" + }, + { + "exts": ["zig"], + "command": "zig fmt --stdin" + }, + { + "exts": ["zon"], + "command": "zig fmt --zon --stdin" } ] },
• packages/backend_core/.gitignore (new)
  • @@ -0,0 +1,8 @@
    + # このディレクトリ特有の無視設定。 + # + # SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + # SPDX-License-Identifier: AGPL-3.0-only + + # What: Protobuf から自動生成されたソースコードの格納先。 + # Why: `packages/proto/` ディレクトリ配下の .proto ファイルから自動生成されるため。 + /src/proto
• packages/backend_core/build.zig (new)
  • @@ -0,0 +1,39 @@
    + // SPDX-FileCopyrightText: 2025 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + + //! Zig のビルドスクリプト。 + + const std = @import("std"); + + const ProtoGenStep = @import("gremlin").ProtoGenStep; + + pub fn build(b: *std.Build) void { + const target = b.standardTargetOptions(.{}); + const optimize = b.standardOptimizeOption(.{}); + + const gremlin = b.dependency("gremlin", .{ + .target = target, + .optimize = optimize, + }).module("gremlin"); + + const proto = ProtoGenStep.create( + b, + .{ + .proto_sources = b.path("../proto/"), + .target = b.path("src/proto"), + }, + ); + + // TODO: バックエンドをちゃんと実装する際にライブラリに変更する + const exe = b.addExecutable(.{ + .name = "backend_core", + .root_source_file = b.path("src/main.zig"), + .target = target, + .optimize = optimize, + }); + + exe.root_module.addImport("gremlin", gremlin); + exe.step.dependOn(&proto.step); + + b.installArtifact(exe); + }
• packages/backend_core/build.zig.zon (new)
  • @@ -0,0 +1,61 @@
    + // SPDX-FileCopyrightText: 2025 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + // + // === + // + // Zig の依存関係周りを定義するファイル。 + // 基本的には zig のサブコマンドで自動的に書き込まれるため手動ではいじらない。 + // デフォルトのコメントは有用なため残してある。 + + .{ + // This is the default name used by packages depending on this one. For + // example, when a user runs `zig fetch --save <url>`, this field is used + // as the key in the `dependencies` table. Although the user can choose a + // different name, most users will stick with this provided value. + // + // It is redundant to include "zig" in this name because it is already + // within the Zig package namespace. + .name = .backend_core, + + // This is a [Semantic Version](https://semver.org/). + // In a future version of Zig it will be used for package deduplication. + .version = "0.0.0", + + // Together with name, this represents a globally unique package + // identifier. This field is generated by the Zig toolchain when the + // package is first created, and then *never changes*. This allows + // unambiguous detection of one package being an updated version of + // another. + // + // When forking a Zig project, this id should be regenerated (delete the + // field and run `zig build`) if the upstream project is still maintained. + // Otherwise, the fork is *hostile*, attempting to take control over the + // original project's identity. Thus it is recommended to leave the comment + // on the following line intact, so that it shows up in code reviews that + // modify the field. + .fingerprint = 0xea6d0b6824b9f28f, // Changing this has security and trust implications. + + // Tracks the earliest Zig version that the package considers to be a + // supported use case. + .minimum_zig_version = "0.14.0", + + // This field is optional. + // Each dependency must either provide a `url` and `hash`, or a `path`. + // `zig build --fetch` can be used to fetch all dependencies of a package, recursively. + // Once all dependencies are fetched, `zig build` no longer requires + // internet connectivity. + .dependencies = .{ + .gremlin = .{ + .url = "https://github.com/octopus-foundation/gremlin.zig/archive/fccfe2659f24497199d86404e0ef7dbc79e033d2.tar.gz", + .hash = "gremlin-0.0.0-E2s91bN4DgDYbb4QNxl4ZT5nEEhNBkk5ngfVasDbsnNF", + }, + }, + .paths = .{ + "build.zig", + "build.zig.zon", + "src", + // For example... + //"LICENSE", + //"README.md", + }, + }
• packages/backend_core/src/main.zig (new)
  • @@ -0,0 +1,17 @@
    + // SPDX-FileCopyrightText: 2025 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + + const std = @import("std"); + + const ping_response = @import("./proto/yamori/meta/v1/ping_response.proto.zig"); + + pub fn main() !void { + var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator); + defer arena.deinit(); + + const allocator = arena.allocator(); + + const bytes = try ping_response.PingResponse.encode(&.{}, allocator); + + std.debug.print("{d} bytes: {s}\n", .{ bytes.len, bytes }); + }
• packages/proto/REUSE.toml (new)
  • @@ -0,0 +1,9 @@
    + # SPDX-FileCopyrightText: 2025 Shota FUJI <pockawoooh@gmail.com> + # SPDX-License-Identifier: AGPL-3.0-only + + version = 1 + + [[annotations]] + path = "google/**/*" + SPDX-FileCopyrightText = "Copyright 2008 Google Inc. All rights reserved." + SPDX-License-Identifier = "BSD-3-Clause"
• packages/proto/buf.gen.yaml
  • @@ -15,3 +15,8 @@ - local: protoc-gen-go
    out: go opt: - module=pocka.jp/x/yamori/proto/go + + inputs: + - directory: . + exclude_paths: + - google
• packages/proto/google/protobuf/field_mask.proto (new)
  • @@ -0,0 +1,245 @@
    + // Protocol Buffers - Google's data interchange format + // Copyright 2008 Google Inc. All rights reserved. + // https://developers.google.com/protocol-buffers/ + // + // Redistribution and use in source and binary forms, with or without + // modification, are permitted provided that the following conditions are + // met: + // + // * Redistributions of source code must retain the above copyright + // notice, this list of conditions and the following disclaimer. + // * Redistributions in binary form must reproduce the above + // copyright notice, this list of conditions and the following disclaimer + // in the documentation and/or other materials provided with the + // distribution. + // * Neither the name of Google Inc. nor the names of its + // contributors may be used to endorse or promote products derived from + // this software without specific prior written permission. + // + // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + syntax = "proto3"; + + package google.protobuf; + + option cc_enable_arenas = true; + option csharp_namespace = "Google.Protobuf.WellKnownTypes"; + option go_package = "google.golang.org/protobuf/types/known/fieldmaskpb"; + option java_multiple_files = true; + option java_outer_classname = "FieldMaskProto"; + option java_package = "com.google.protobuf"; + option objc_class_prefix = "GPB"; + + // `FieldMask` represents a set of symbolic field paths, for example: + // + // paths: "f.a" + // paths: "f.b.d" + // + // Here `f` represents a field in some root message, `a` and `b` + // fields in the message found in `f`, and `d` a field found in the + // message in `f.b`. + // + // Field masks are used to specify a subset of fields that should be + // returned by a get operation or modified by an update operation. + // Field masks also have a custom JSON encoding (see below). + // + // # Field Masks in Projections + // + // When used in the context of a projection, a response message or + // sub-message is filtered by the API to only contain those fields as + // specified in the mask. For example, if the mask in the previous + // example is applied to a response message as follows: + // + // f { + // a : 22 + // b { + // d : 1 + // x : 2 + // } + // y : 13 + // } + // z: 8 + // + // The result will not contain specific values for fields x,y and z + // (their value will be set to the default, and omitted in proto text + // output): + // + // + // f { + // a : 22 + // b { + // d : 1 + // } + // } + // + // A repeated field is not allowed except at the last position of a + // paths string. + // + // If a FieldMask object is not present in a get operation, the + // operation applies to all fields (as if a FieldMask of all fields + // had been specified). + // + // Note that a field mask does not necessarily apply to the + // top-level response message. In case of a REST get operation, the + // field mask applies directly to the response, but in case of a REST + // list operation, the mask instead applies to each individual message + // in the returned resource list. In case of a REST custom method, + // other definitions may be used. Where the mask applies will be + // clearly documented together with its declaration in the API. In + // any case, the effect on the returned resource/resources is required + // behavior for APIs. + // + // # Field Masks in Update Operations + // + // A field mask in update operations specifies which fields of the + // targeted resource are going to be updated. The API is required + // to only change the values of the fields as specified in the mask + // and leave the others untouched. If a resource is passed in to + // describe the updated values, the API ignores the values of all + // fields not covered by the mask. + // + // If a repeated field is specified for an update operation, new values will + // be appended to the existing repeated field in the target resource. Note that + // a repeated field is only allowed in the last position of a `paths` string. + // + // If a sub-message is specified in the last position of the field mask for an + // update operation, then new value will be merged into the existing sub-message + // in the target resource. + // + // For example, given the target message: + // + // f { + // b { + // d: 1 + // x: 2 + // } + // c: [1] + // } + // + // And an update message: + // + // f { + // b { + // d: 10 + // } + // c: [2] + // } + // + // then if the field mask is: + // + // paths: ["f.b", "f.c"] + // + // then the result will be: + // + // f { + // b { + // d: 10 + // x: 2 + // } + // c: [1, 2] + // } + // + // An implementation may provide options to override this default behavior for + // repeated and message fields. + // + // In order to reset a field's value to the default, the field must + // be in the mask and set to the default value in the provided resource. + // Hence, in order to reset all fields of a resource, provide a default + // instance of the resource and set all fields in the mask, or do + // not provide a mask as described below. + // + // If a field mask is not present on update, the operation applies to + // all fields (as if a field mask of all fields has been specified). + // Note that in the presence of schema evolution, this may mean that + // fields the client does not know and has therefore not filled into + // the request will be reset to their default. If this is unwanted + // behavior, a specific service may require a client to always specify + // a field mask, producing an error if not. + // + // As with get operations, the location of the resource which + // describes the updated values in the request message depends on the + // operation kind. In any case, the effect of the field mask is + // required to be honored by the API. + // + // ## Considerations for HTTP REST + // + // The HTTP kind of an update operation which uses a field mask must + // be set to PATCH instead of PUT in order to satisfy HTTP semantics + // (PUT must only be used for full updates). + // + // # JSON Encoding of Field Masks + // + // In JSON, a field mask is encoded as a single string where paths are + // separated by a comma. Fields name in each path are converted + // to/from lower-camel naming conventions. + // + // As an example, consider the following message declarations: + // + // message Profile { + // User user = 1; + // Photo photo = 2; + // } + // message User { + // string display_name = 1; + // string address = 2; + // } + // + // In proto a field mask for `Profile` may look as such: + // + // mask { + // paths: "user.display_name" + // paths: "photo" + // } + // + // In JSON, the same mask is represented as below: + // + // { + // mask: "user.displayName,photo" + // } + // + // # Field Masks and Oneof Fields + // + // Field masks treat fields in oneofs just as regular fields. Consider the + // following message: + // + // message SampleMessage { + // oneof test_oneof { + // string name = 4; + // SubMessage sub_message = 9; + // } + // } + // + // The field mask can be: + // + // mask { + // paths: "name" + // } + // + // Or: + // + // mask { + // paths: "sub_message" + // } + // + // Note that oneof type names ("test_oneof" in this case) cannot be used in + // paths. + // + // ## Field Mask Verification + // + // The implementation of any API method which has a FieldMask type field in the + // request should verify the included field paths, and return an + // `INVALID_ARGUMENT` error if any path is unmappable. + message FieldMask { + // The set of field mask paths. + repeated string paths = 1; + }
• packages/proto/google/protobuf/timestamp.proto (new)
  • @@ -0,0 +1,144 @@
    + // Protocol Buffers - Google's data interchange format + // Copyright 2008 Google Inc. All rights reserved. + // https://developers.google.com/protocol-buffers/ + // + // Redistribution and use in source and binary forms, with or without + // modification, are permitted provided that the following conditions are + // met: + // + // * Redistributions of source code must retain the above copyright + // notice, this list of conditions and the following disclaimer. + // * Redistributions in binary form must reproduce the above + // copyright notice, this list of conditions and the following disclaimer + // in the documentation and/or other materials provided with the + // distribution. + // * Neither the name of Google Inc. nor the names of its + // contributors may be used to endorse or promote products derived from + // this software without specific prior written permission. + // + // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + syntax = "proto3"; + + package google.protobuf; + + option cc_enable_arenas = true; + option csharp_namespace = "Google.Protobuf.WellKnownTypes"; + option go_package = "google.golang.org/protobuf/types/known/timestamppb"; + option java_multiple_files = true; + option java_outer_classname = "TimestampProto"; + option java_package = "com.google.protobuf"; + option objc_class_prefix = "GPB"; + + // A Timestamp represents a point in time independent of any time zone or local + // calendar, encoded as a count of seconds and fractions of seconds at + // nanosecond resolution. The count is relative to an epoch at UTC midnight on + // January 1, 1970, in the proleptic Gregorian calendar which extends the + // Gregorian calendar backwards to year one. + // + // All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap + // second table is needed for interpretation, using a [24-hour linear + // smear](https://developers.google.com/time/smear). + // + // The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By + // restricting to that range, we ensure that we can convert to and from [RFC + // 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. + // + // # Examples + // + // Example 1: Compute Timestamp from POSIX `time()`. + // + // Timestamp timestamp; + // timestamp.set_seconds(time(NULL)); + // timestamp.set_nanos(0); + // + // Example 2: Compute Timestamp from POSIX `gettimeofday()`. + // + // struct timeval tv; + // gettimeofday(&tv, NULL); + // + // Timestamp timestamp; + // timestamp.set_seconds(tv.tv_sec); + // timestamp.set_nanos(tv.tv_usec * 1000); + // + // Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. + // + // FILETIME ft; + // GetSystemTimeAsFileTime(&ft); + // UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; + // + // // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z + // // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. + // Timestamp timestamp; + // timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); + // timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); + // + // Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. + // + // long millis = System.currentTimeMillis(); + // + // Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) + // .setNanos((int) ((millis % 1000) * 1000000)).build(); + // + // Example 5: Compute Timestamp from Java `Instant.now()`. + // + // Instant now = Instant.now(); + // + // Timestamp timestamp = + // Timestamp.newBuilder().setSeconds(now.getEpochSecond()) + // .setNanos(now.getNano()).build(); + // + // Example 6: Compute Timestamp from current time in Python. + // + // timestamp = Timestamp() + // timestamp.GetCurrentTime() + // + // # JSON Mapping + // + // In JSON format, the Timestamp type is encoded as a string in the + // [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the + // format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" + // where {year} is always expressed using four digits while {month}, {day}, + // {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional + // seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), + // are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone + // is required. A proto3 JSON serializer should always use UTC (as indicated by + // "Z") when printing the Timestamp type and a proto3 JSON parser should be + // able to accept both UTC and other timezones (as indicated by an offset). + // + // For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past + // 01:30 UTC on January 15, 2017. + // + // In JavaScript, one can convert a Date object to this format using the + // standard + // [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) + // method. In Python, a standard `datetime.datetime` object can be converted + // to this format using + // [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with + // the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use + // the Joda Time's [`ISODateTimeFormat.dateTime()`]( + // http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime() + // ) to obtain a formatter capable of generating timestamps in this format. + // + message Timestamp { + // Represents seconds of UTC time since Unix epoch + // 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to + // 9999-12-31T23:59:59Z inclusive. + int64 seconds = 1; + + // Non-negative fractions of a second at nanosecond resolution. Negative + // second values with fractions must still have non-negative nanos values + // that count forward in time. Must be from 0 to 999,999,999 + // inclusive. + int32 nanos = 2; + }
• packages/proto/package.json
  • @@ -41,7 +41,7 @@ }
    ] }, "check": { - "command": "buf lint", + "command": "buf lint --exclude-path google", "files": ["yamori/**/*.proto"], "output": [] }