Repository navigation
Conversation
github-actions
Bot
added
the
no-changelog
grollest
force-pushed
the
grollest/app-logs-types-local
branch
from
November 9, 2026 22:18
3b95dbd to
9b53558
Compare
grollest
force-pushed
the
grollest/app-logs-types-local
branch
from
November 9, 2026 22:20
9b53558 to
670d1d7
Compare
4 tasks done
grollest
marked this pull request as ready for review
November 9, 2026 22:43
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
WHY are these changes introduced?
Developers and scripts need a way to discover the historical log types supported by their CLI without querying log records.
WHAT is this pull request doing?
Adds the hidden
shopify app logs-next types [TYPE]command for webhook and GraphQL logs. It uses the existing retrieval catalog and bundled descriptive metadata to list types or describe one type, including applicable filters, limitations, and a retrieval example.Supports human-readable output,
--json, and--json-schema, without requiring an app project or authentication. Existing log retrieval and legacy migration behavior remain unchanged.The command remains pre-release and hidden, so this change does not include a changeset.
How to manually test your changes?
From this checkout, with the CLI built, run:
Output (exit 0; stderr)
Output (exit 0; stderr)
Output (exit 0; stdout)
{ "types": [ { "name": "graphql", "description": "GraphQL request logs.", "filters": [ "store", "status", "operation-type", "operation-name", "request-id" ], "limitations": [ "Each filter accepts one exact value. Different filters combine with AND; records without the filtered field are excluded.", "--status accepts success or failure using the recorded result status, not inferred from HTTP codes or response bodies.", "--operation-name matches the client-supplied operation name, not a root API field. --operation-type matches the recorded operation kind; --request-id matches the request identifier." ], "example": "shopify app logs-next --type graphql --operation-name MyQuery --since 30m" } ] }Output (exit 0; stdout)
{ "anyOf": [ { "$ref": "#/definitions/Result" }, { "$ref": "#/definitions/Error" }, { "$ref": "#/definitions/Event" } ], "title": "CommandOutput", "definitions": { "Result": { "type": "object", "properties": { "types": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "webhook", "graphql" ] }, "description": { "type": "string" }, "filters": { "type": "array", "items": { "type": "string", "enum": [ "store", "status", "topic", "status-code", "operation-type", "operation-name", "request-id" ] }, "description": "Applicable filter flag names for app logs-next, without the -- prefix." }, "limitations": { "type": "array", "items": { "type": "string" } }, "example": { "type": "string" } }, "required": [ "name", "description", "filters", "limitations", "example" ], "additionalProperties": false }, "description": "The complete local catalog, or one selected type. Does not check app access or log availability." } }, "required": [ "types" ], "additionalProperties": false }, "Error": { "type": "object", "properties": { "error": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "abort" }, "message": { "type": "string" }, "code": { "type": "string", "minLength": 1, "description": "A stable error code, included only when known." }, "tryMessage": { "type": "string" }, "nextSteps": { "type": "array", "items": { "type": "string" } }, "customSections": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "body": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } ] } }, "required": [ "body" ], "additionalProperties": false } }, "details": { "description": "Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data." } }, "required": [ "type", "message" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "bug" }, "message": { "$ref": "#/definitions/Error/properties/error/anyOf/0/properties/message" }, "code": { "$ref": "#/definitions/Error/properties/error/anyOf/0/properties/code" }, "tryMessage": { "$ref": "#/definitions/Error/properties/error/anyOf/0/properties/tryMessage" }, "nextSteps": { "$ref": "#/definitions/Error/properties/error/anyOf/0/properties/nextSteps" }, "customSections": { "$ref": "#/definitions/Error/properties/error/anyOf/0/properties/customSections" }, "details": { "$ref": "#/definitions/Error/properties/error/anyOf/0/properties/details" }, "stack": { "type": "string" } }, "required": [ "type", "message" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "external" }, "message": { "$ref": "#/definitions/Error/properties/error/anyOf/0/properties/message" }, "code": { "$ref": "#/definitions/Error/properties/error/anyOf/0/properties/code" }, "tryMessage": { "$ref": "#/definitions/Error/properties/error/anyOf/0/properties/tryMessage" }, "nextSteps": { "$ref": "#/definitions/Error/properties/error/anyOf/0/properties/nextSteps" }, "customSections": { "$ref": "#/definitions/Error/properties/error/anyOf/0/properties/customSections" }, "details": { "$ref": "#/definitions/Error/properties/error/anyOf/0/properties/details" }, "command": { "type": "string" }, "args": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "message", "command", "args" ], "additionalProperties": false } ] } }, "required": [ "error" ], "additionalProperties": false }, "Event": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "diagnostic" }, "timestamp": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$", "description": "A UTC ISO 8601 instant with whole seconds and the Z timezone marker." }, "level": { "type": "string", "enum": [ "debug", "info", "warning", "error" ] }, "message": { "type": "string" }, "code": { "type": "string", "minLength": 1, "description": "A stable diagnostic code, included only when known." } }, "required": [ "type", "timestamp", "level", "message" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "progress" }, "timestamp": { "$ref": "#/definitions/Event/anyOf/0/properties/timestamp" }, "status": { "type": "string", "enum": [ "started", "updated", "retrying", "completed", "failed" ] }, "operation": { "type": "string" }, "message": { "type": "string" }, "current": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 } }, "required": [ "type", "timestamp", "status", "operation" ], "additionalProperties": false } ] } }, "$schema": "http://json-schema.org/draft-07/schema#" }Output (exit 1; stdout)
{"error":{"type":"abort","message":"Supported log types are webhook and graphql.","code":"invalid-argument"}}webhookandgraphql; selecting one type shows its details.typesarray, with one entry when a type is selected.Validation
Checklist
patchfor bug fixes ·minorfor new features ·majorfor breaking changes) and added a changeset withpnpm changeset add