The g1t CLI prints JSON with each object's keys in sorted order however it is built, and its table of API operations lists each body's fields in sorted order. Another crate in the workspace turns on serde_json's preserve_order, and a shared build carried it into the CLI, so --json output and the generated table changed order depending on what was built alongside it, and cargo test across the workspace failed. The table is regenerated for the API after open sign-ups, which no longer has the personal invite operations. · e6ce8e8 · flagon-io/g1t

69	69		pub fn line(value: &Value) -> String {
70	70		match value {
71	71		Value::String(s) => s.clone(),
72		−	other => serde_json::to_string(other).expect("json"),
	72	+	other => serde_json::to_string(&crate::output::sorted(other)).expect("json"),
73	73		}
74	74		}
75	75

184	184		match schema["properties"].as_object() {
185	185		Some(props) if !props.is_empty() => {
186	186		writeln!(text, " body: &[").unwrap();
	187	+	// Sorted, so the table is the same with or without
	188	+	// serde_json's preserve_order in the build.
	189	+	let mut props: Vec<(&String, &Value)> = props.iter().collect();
	190	+	props.sort_by_key(\|(name, _)\| *name);
187	191		for (name, field) in props {
188	192		writeln!(
189	193		text,

2029	2029		body: &[],
2030	2030		},
2031	2031		Operation {
2032		−	id: "create_invite",
2033		−	method: "POST",
2034		−	path: "/user/invites",
2035		−	tag: "Invites",
2036		−	summary: "Create an invite",
2037		−	scope: Some("account:write"),
2038		−	params: &[],
2039		−	body: &[
2040		−	Field { name: "charge_workspace", kind: "string", required: false, values: &[] },
2041		−	Field { name: "email", kind: "string", required: false, values: &[] },
2042		−	Field { name: "workspace", kind: "string", required: false, values: &[] },
2043		−	],
2044		−	},
2045		−	Operation {
2046	2032		id: "decline_invitation",
2047	2033		method: "POST",
2048	2034		path: "/user/invitations/{id}/decline",
⋯
2076	2062		path: "/user/invitations",
2077	2063		tag: "Invites",
2078	2064		summary: "List your workspace invitations",
2079		−	scope: Some("account:read"),
2080		−	params: &[],
2081		−	body: &[],
2082		−	},
2083		−	Operation {
2084		−	id: "list_invites",
2085		−	method: "GET",
2086		−	path: "/user/invites",
2087		−	tag: "Invites",
2088		−	summary: "List your invites",
2089	2065		scope: Some("account:read"),
2090	2066		params: &[],
2091	2067		body: &[],
⋯
2099	2075		scope: Some("workspace:read"),
2100	2076		params: &[
2101	2077		Param { name: "workspace", location: In::Path, kind: "string", required: true, values: &[] },
2102		−	],
2103		−	body: &[],
2104		−	},
2105		−	Operation {
2106		−	id: "revoke_invite",
2107		−	method: "DELETE",
2108		−	path: "/user/invites/{id}",
2109		−	tag: "Invites",
2110		−	summary: "Revoke an invite",
2111		−	scope: Some("account:write"),
2112		−	params: &[
2113		−	Param { name: "id", location: In::Path, kind: "string", required: true, values: &[] },
2114	2078		],
2115	2079		body: &[],
2116	2080		},

66	66		}
67	67		return Ok(());
68	68		}
	69	+	let value = sorted(&value);
69	70		let text = if self.tty {
70	71		serde_json::to_string_pretty(&value)
71	72		} else {
⋯
203	204		}
204	205		}
205	206
	207	+	/// `value` with every object's keys in sorted order. Printed JSON must not
	208	+	/// depend on serde_json's `preserve_order`, which other crates in the
	209	+	/// workspace turn on for a shared build.
	210	+	pub fn sorted(value: &Value) -> Value {
	211	+	match value {
	212	+	Value::Object(map) => {
	213	+	let mut keys: Vec<&String> = map.keys().collect();
	214	+	keys.sort();
	215	+	Value::Object(keys.into_iter().map(\|k\| (k.clone(), sorted(&map[k]))).collect())
	216	+	}
	217	+	Value::Array(list) => Value::Array(list.iter().map(sorted).collect()),
	218	+	other => other.clone(),
	219	+	}
	220	+	}
	221	+
206	222		/// Keeps only `fields` of each object in `value`.
207	223		pub fn select(value: &Value, fields: &[String]) -> Result<Value> {
208	224		let objects: Vec<&Map<String, Value>> = match value {
⋯
365	381		fn json_is_compact_and_ordered() {
366	382		let value: Value = serde_json::from_str(r#"{"title":"a","number":1}"#).unwrap();
367	383		assert_eq!(
368		−	serde_json::to_string(&value).unwrap(),
	384	+	serde_json::to_string(&sorted(&value)).unwrap(),
369	385		r#"{"number":1,"title":"a"}"#
370	386		);
371	387		}

flagon-io/g1t

Comments