Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

map.js triggers assertion when encountering an integer-keyed map with key 0

オープン
#27 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
javascript

調査の方向性

js/map.js の jspb.Map.deserializeBinary(507 行目付近)から始め、issue にある base64 入力と PlayerData 定義を使って失敗を再現します。整数キーの map エントリについて、キー 0 と 1 のデコードを比較します。提供されたデータが assertion なしでデシリアライズされ、キー 0 のエントリが保持されれば完了です。

索引モデルが issue の本文から書いたものです。

説明

bug help wanted javascript port-fix triaged

Version: 3.12.2
Language: Javascript

Following is a base64 string of bytes that has been coded from C# side. I could immediately decode at C# side just fine, but it failed to decode at JS library.

CiRlZjlhNTJlNC0wZDRmLTQyNzEtOGQzYi02ODZjYWE3N2M4ZWUSClBMQVlFUjc2MTYiCUxZWERQQkFDRkocaEpRQnFhT0t3SmZVbWtyTzF5UjZ5WVBXSWMxM1oCEgBaBggBEgIIAbIBAggBwgEMCIaVuPgFEOjNpLcB

It is coming from this proto definition. Please ignore references to other unknown messages, because the problem is on just field index 11.

message PlayerData {

    option (private_message) = true;
    reserved 3,5,7,8, 13 to 16;

    string player_id = 1;
    string display_name = 2;
    string short_player_id = 4;
    string start_playing = 6;
    string firebase_uid = 9;

    map<string,MinigameProgress> minigame_progresses = 10;

    //Problematic field on JS side
    map<int32,CharacterConfiguration> character_configurations = 11;

    int32 chilli = 12;

    int32 match_count_two_players = 17;
    int32 selected_character_configuration = 18;

    repeated UnlockedSet unlocked_sets = 19;

    repeated PermanentEvent permanent_events = 20; 

    map<string, google.protobuf.Timestamp> trial_timestamps = 21;

    SavedConfigurations saved_configurations = 22;

    repeated PurchasableFeatureId purchasable_features = 23;

    google.protobuf.Timestamp start_playing_20 = 24;
}

message CharacterConfiguration{

    E7.DuelOtters.Core.CharacterKind kind = 1;
    string headgear_system_name = 2;
    string clothing_system_name = 3;
    int32 winning_dance_id = 4;
    ColorMutation color_mutation = 5;
    EyeMutation eye_mutation = 6;
    CheekMutation cheek_mutation = 7;

    ClothingKind clothing_kind = 8;
    HeadgearKind headgear_kind = 9;
}

This is a ToString of real data coming from C#. Many were default, so it seems they had been efficiently stripped off.

{ "playerId": "ef9a52e4-0d4f-4271-8d3b-686caa77c8ee", "displayName": "PLAYER7616", "shortPlayerId": "LYXDPBACF", "firebaseUid": "hJQBqaOKwJfUmkrO1yR6yYPWIc13", "characterConfigurations": { "0": { }, "1": { "kind": "CharacterKind_Bomberjack" } }, "savedConfigurations": { "autoGameCenter": true }, "startPlaying20": "2020-07-14T19:41:58.384378600Z" }

When trying to deserialize in JS :

const b64 = "CiRlZjlhNTJlNC0wZDRmLTQyNzEtOGQzYi02ODZjYWE3N2M4ZWUSClBMQVlFUjc2MTYiCUxZWERQQkFDRkocaEpRQnFhT0t3SmZVbWtyTzF5UjZ5WVBXSWMxM1oCEgBaBggBEgIIAbIBAggBwgEMCIaVuPgFEOjNpLcB"
const buf = Buffer.from(b64, "base64")
PlayerData.deserializeBinary(buf)

It produces assertion failure :

Error [AssertionError]: Assertion failed
    at new goog.asserts.AssertionError (/Users/Sargon/Documents/Unity Projects/Main Projects/DuelOtters/Firebase/functions/node_modules/google-protobuf/google-protobuf.js:81:876)
    at Object.goog.asserts.doAssertFailure_ (/Users/Sargon/Documents/Unity Projects/Main Projects/DuelOtters/Firebase/functions/node_modules/google-protobuf/google-protobuf.js:82:257)
    at Object.goog.asserts.assert [as assert] (/Users/Sargon/Documents/Unity Projects/Main Projects/DuelOtters/Firebase/functions/node_modules/google-protobuf/google-protobuf.js:83:83)
    at Function.jspb.Map.deserializeBinary (/Users/Sargon/Documents/Unity Projects/Main Projects/DuelOtters/Firebase/functions/node_modules/google-protobuf/google-protobuf.js:411:241)

When compared with original source code, this assertion should be line 507 in js/map.js, jspb.Map.deserializeBinary : goog.asserts.assert(key != undefined); The key and value is going to be used in the map.set that follows so two asserts are there.

The problematic part in the data is the field index 11, map<int32,CharacterConfiguration> character_configurations = 11;

It is an int mapped to an another message. In the bytes, it has 2 members, int 0 mapped to an empty message, and int 1 mapped to a message with a bit of string data. Again, this is what they are at C#'s ToString debug :

 "characterConfigurations": { "0": { }, "1": { "kind": "CharacterKind_Bomberjack" } }

By simply removing the 0 keyed entry with default message value, and add it back to be keyed with 2 instead :

 "characterConfigurations": { "1": { "kind": "CharacterKind_Bomberjack" },  "2": { } }

JS is able to deserialize without triggering the assertion error. It seems like there is something with integer key at number 0. (C# could deserialize 0-keyed map in the protobuf bytes just fine)

主要言語
JavaScript
スター
471
フォーク
91
平均マージ
3時間 57分
マージ済み PR(30日)
2

環境構築

このプロジェクトの環境構築ファイルはまだ確認していません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

protocolbuffers/protobuf-javascript のほかの issue

protocolbuffers/protobuf-javascript の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。