Changelog

Gadget's high-performance data store used for session model storage now uses a new, more performant implementation. All apps are now using this implementation with no action needed, and no data lost in transition.This change is part of a larger effort to improve Gadget's performance and scalability.

Previously only integer literals were allowed as the arguments of the limit and offset commands. This makes it difficult to use these commands for paging through larger result sets. It is now possible to use variable references for these commands:

 query($limit: Integer, $offset: Integer) {
    students {
      name
      [ limit $limit offset $offset ]
    }
  }

The variable type must be Integer or Int. The query is still subject to the same platform row count limits whether the limit value is literal or passed in as a parameter at query execution time. The query will fail if a variable is used as limit or offset value, but its value is not provided when the query is executed.

Gadget now supports Shopify's StoreCreditAccount, PaymentTerms, and PaymentSchedules models, as well as the payment_terms webhooks.

Large TypeScript projects load quicker in the web editor, and the editor is more performant when working on these big projects. Additional tsconfig.json options, such as include and exclude, are also now supported by the web editor.

When looking at the Logs page in live mode, new log messages are sent from the server to the browser. The internal buffer of these logs would grow unbounded and therefore consume a large amount of memory over time.

This change caps the number of log messages that are kept in memory to 2000 messages. When new log messages are received by the browser we will evict older ones from memory to maintain the limit.

This does not affect the persistence of the log messages in Gadget and the log messages are still available to be searched.

The default React app templates are now using the React Router v7 library. It should be functionally equivalent to React Router v6.

Templates that start using React Router v7:

• React web app with auth
• Shopify embedded React app
• BigCommerce app

If you would like to upgrade your existing React app to use React Router v7, you can follow React Router's upgrade guide.

Support for the React Router v7 framework (similar to the existing Remix framework) will be available soon.

Columns in the data editor can now be re-ordered by dragging the column heading into a new location. The new order will be persisted per environment - all users on a single environment will see the reordered columns.

Columns can now also be hidden by right clicking on the column header and selecting Hide 'Column name'. Columns can be made visible again by right clicking on a column and selecting Unhide all columns.

Developers who were logged in to a production web app environment and navigated to a development environment's JS Playground would see all subsequent requests to their app and playground fail with a GGT_INCORRECT_ENVIRONMENT error. This bug is now fixed.

Gadget previously had a bug where sending multipart/form-data requests to an app's HTTP routes would corrupt the request body content if the request body contained bytes that weren't valid UTF-8. This bug has been fixed, so now you can POST images to HTTP routes just fine. Uploading files to the file field type is unaffected -- this is just for custom routes that handle multipart/form-data requests.

When the production environment is deployed, Gadget will automatically remove any cached content from the Cloudflare CDN in front of each app. This only matters to applications using Cache-Control headers to allow the CDN to cache responses and will ensure that a new version of the app will push changed content to the CDN immediately.

We already used to do this for just the /api/client/web.js file, but now we do it for any cached route because we're on Cloudflare Enterprise.

New apps now have the option to be created using TypeScript and existing apps have a new setting to enable TypeScript support. Read about TypeScript support in our docs.

Using the Restart app command in the command palette or hot module reloading sometimes causes the embedded app to be unauthenticated in development. These should now correctly reload the app in the authenticated state.

The billing page should now show the correct invoice plan, as well we've stopped showing irrelevant info on invoices that were created while on the free plan.

New Shopify apps will come with Gadget-managed shopify.app.toml files. In most cases, you shouldn't have to touch these files at all. These root-level TOMLs are required when building Shopify extensions and we're making it easier to work on these apps as a team by handling TOML creation.

The shopify.app.toml file is for your production environment, and any other connections to Shopify that are set up in development environments will automatically get a shopify.app.<env>.toml file. These TOML files typically only need to manually updated when you are using Shopify managed installs.

Read the docs on managed TOML files for more information.

Files inside a /public folder on Remix app production environments were not being correctly served. For example, a file /public/hello.txt was not being served at https://my-todo-list.gadget.app/hello.txt. This is now fixed.

Previously, Gadget would connect to external services from only a single IP address. To support Gadget's growth, we now need to use multiple IPs to connect from, which means anyone using an allow list needs to add new IPs to the list. Under the hood, we're actually only using one new IP, but we're taking the time to add a bunch more so that we don't need to alert everyone to changes as we grow in the future.

The full list of IPs can be found in the Gadget docs.

Adds a colored border to the left of each log message that corresponds to the severity of the log level.

The Gelly limit command now supports an optional offset parameter. It takes one fixed integer which denotes a position in the list of results to start from. The query will return up to limit number of results starting from the offset position. This can be used to "page" through a long list of results, the limit reflects the size of the page and the offset reflects the position in the result set where the page should start.

For example, following query returns a second page of 5 posts:

Read the docs.

The deactivatedAt field on the shopifyGiftCard model is now correctly named and synced from Shopify. Previously, it was named disabledAt.

The list of models under "Schema" in the API documentation sidebar is now sorted alphabetically. This should help with applications that have many models to navigate quickly.

When file and folder names are long and don't fit in the sidebar the names are truncated. This adds a tooltip on hover to display the full file name.

‍

The Gadget logger was not correctly displaying errors that occurred when a Shopify app does not have protected customer data access on some model fields, for example, statusPageUrl on the shopifyOrder model. These should now be displayed correctly in the logs.

The type field has been added to the shopifyDiscount model which will list the GraphQL type of the discount. This is useful in differentiating between different types of discounts.

Adds support for filtering by role on the user model. Filters include equals, notEquals, isSet and contains. Read the docs for more info and examples.

The bulk data reset modal has been refreshed to make it easier to use. A bug where namespaced models were not able to be deleted through the modal was also fixed.

‍

Gadget now has a built-in framework linter that will alert you to Gadget-specific issues in your project. Read more.

‍

Falsy values like false, null, and empty strings are now be visible in the log viewer.

Gadget framework v1.3.0 is now released. v1.3.0 includes the ability to filter queries across relationships.

This framework version includes breaking changes to existing belongsTo relationship filters. Read the v1.3.0 migration guide.

Version 0.18.0 of @gadgetinc/react is now available.

This version includes many fixes and improvements for autocomponents. Read the full changelog here.

Before this change, the only auth action that supported passing custom params was the user signUp action that was triggered via API. With this change, all user auth actions support passing custom params, both via API triggers and via Google OAuth triggers.

Previously accessing the result of a background global action with namespaces would throw a GraphQL error. The bug has been fixed.

For example:

// `actionA` global action is under the `ns` namespace
const handle = await api.enqueue(api.ns.actionA)

// this threw an error previously
await handle.result()

‍

Fixed a bug where creating a new development environment would cause your BigCommerce connection to be in an invalid state on the new environment.

‍

Shopify customer webhooks no longer update the updated_at timestamp on the customer when only metafields are updated. Gadget will now update the customer record by checking the metafield's updated_at timestamp to also determine if the customer record should be updated.

The Gadget web editor now uses CodeMirror instead of Monaco to allow for a faster and more reliable auto-complete experience.

Gadget has now added support for Shopify API Version 2024-10. Details can be found in our Shopify API version changelog docs.

Previously, we erroneously tagged logs emitted using the global logger instance from gadget-server as being from the platform, rather than the user. Now, if apps use the global logger instance, its log events will be tagged as coming from the user and show up in the My Events filter.

Fixed an issue where enqueuing bulk model update actions with custom params would generate invalid GraphQL queries.

The GadgetMailer now returns the response from the sendMail method. This allows you to access the raw response from the email provider, which can be useful for debugging and monitoring sent emails.

We now output application logs by default while ggt dev is running. For more information, see the release notes.

You can now run the Restart app command on your production environment.

When Gadget detects that an action being called from the frontend is missing an API trigger, the dev harness will pop up with a warning about the missing trigger and gives developers the option to add the trigger.

Gadget now properly handles the deletion of ProductMedia and ProductVariantMedia records on incoming Shopify products webhooks.

GadgetMailer now supports attachments when sending emails. Learn more in our docs.

Previously, editing Shopify scopes would reset the permissions of the shopify-app-users role to match the requested scopes. We have fixed this to only remove permissions of scopes that have been removed from the connection.

‍

A new version of @gadgetinc/react has been released. This version includes improvements and bug fixes for autocomponents:

• Updated the select property in useTable and AutoTable to completely override the default selection instead of being combined with the default selection (Breaking change)
• Updated AutoForm to throw an error when given an invalid action
• Updated AutoSubmit to always show a loading state while submitting
• Updated the AutoTable onClick callback prop to accept the full GadgetRecord corresponding to the row as well as the TableRow itself
• Bug: Fixed an issue with AutoTable where custom cell renderers with duplicate headers would have duplicate columns content
• Bug: Fixed bug in Polaris AutoTable where the createNewView button would erroneously appear on certain parent element widths
• Bug: Fixed a bug in AutoForm where the defaultValues prop values was not included in the submission request if the defaulted field was excluded with the include or exclude properties

Additional functions for working with date, datetime, and interval data have been added to Gelly.

datePart() and dateTrunc() allow for the manipulation of intervals and reflect the corresponding Postgres functions date_part and date_trunc.

• datePart allows you to extract a subfield from a value, for example, datePart("day", date: interval("3 days 60 hours")) would return 3
• dateTrunc allows you to truncate an Interval, for example, dateTrunc("month", date: interval("4 months 5 days")) returns an interval of 4 months
  

makeDate(), makeTimestamp(), and makeInterval() allow for the creation of time-related values from numeric inputs and have the following signatures:

• makeDate(year: number, month?: number, day?: number): Date
• makeTimestamp(year: number, month?: number, day?: number, hour?: number, minute? number, second?: number): DateTime
• makeInterval(years?: number, months?: number, weeks?: number, days?: number, hours?: number, minutes? number, seconds?: number): Interval

See the Gelly reference docs for more details and examples.

Gadget now supports Shopify's ProductMedia and ProductVariantMedia models. These models replace the ProductImage model, which will soon be deprecated. This change was necessary to sync product related media accurately and deterministically. ProductImage is synced non-deterministically due to an individual image now belonging to many products.

Learn more about the Media resource here and get more information about this change in our docs.

‍

‍

The Gadget API client used in action and route contexts has admin privileges by default. This is typically what you want in backend code so you can implement your business logic and use the internal API.

With the introduction of Remix, it is confusing when the API client in loaders has admin privileges but the corresponding API client side has the privileges of the current client session. To fix this we've added two methods to Gadget API clients: api.actAsSession and api.actAsAdmin which allow users to switch between the two privilege levels.

In Gadget actions and route handlers, the API client will be admin by default, but api.actAsSession can be used to switch to the session's privileges. In Remix loaders, the API client will have the privileges of the session that made the request, but api.actAsAdmin can be used to switch to admin privileges.

See docs on actAsAdmin when using Remix loaders.

With the introduction of support for Remix SSR, we need to support form submissions with app cookie authentication. Until today this was left as a todo, since all mutations were handled by our API client. However Remix promotes using standard HTML forms for data mutations and we were not allowing requests authenticated with an app cookie to submit forms.

This release adds a csrfToken property to application session records, that can be used in Remix loaders to add to server-rendered forms. Read more in the documentation.

‍

Build Shopify or web apps with Remix in Gadget, using server-side rendering or single-page application mode. Read the announcement here.

The docs chatbot has received a major upgrade behind the scenes. It has moved to the new OpenAI Assistants API which now handles all the heavy lifting of searching the doc embeddings. Try the chatbot.

‍

A warning has been added to the deploy modal that informs users what model or field data will be deleted as a result of deploying their changes to production. Read the docs for more information.

Gadget is deprecating all framework versions under 1.0 by March 1st, 2025. A banner has been added to the app list page to inform users of this change. It will only show up for users that have apps on deprecated versions.

There was a bug in the implementation of count() when the counted expression was a relationship chain, for example: count(students.courses).

The returned count could be higher than expected if a relationship in the chain had zero rows for some of the rows of the preceding relationship. A relationship chain is compiled into a chain of left joins and we used expression count(1) for relationship counts. We now make sure to use expression count(id) for relationship chains which filters out any null rows introduced by the left join.

‍

We discovered that our default Cloudflare cache configuration for production frontend assets was only 4 hours long. Since frontend assets are versioned by content, we can be much more aggressive with how long browsers can cache them. We now tell browsers to cache production frontend assets for a year. This will help lower LCP times for Shopify.

Read more about TTL and CDN caching on Cloudflare.

A changelog of the most recent bug fixes, features, and updates is now available on the Home page in the Gadget editor.

Fixed an issue where ggt dev would infinitely loop after renaming or deleting a directory within an extensions folder.

‍

Vite's filesystem cache sometimes gets corrupted during normal operation, which can break development environments. To fix this, the Vite filesystem cache at node_modules/.vite needs to be cleared. We now automatically do this cache reset when users hit Restart node modules in the command palette in the editor.

Gadget now has a BigCommerce connection that handles OAuth, frontend session management, webhook subscriptions, and more for developers building single-click apps. The BigDesign library is set up in a React frontend, and the @space48/bigcommerce-api-js client is included for sending requests to the BigCommerce API.

See the connection quickstart and documentation for more information, and learn to build a full-stack single-click app with the tutorial.

Fixed a bug related to closing HMR websockets and Vite in development environment frontends:

- when an app was left idle too long and you came back to your app, you would be presented with a blank screen
- when you added a model (or did anything that restarted the sandbox), your app would go blank

Both of these were fixed by making sure that when an app sandbox shuts down, the HMR websocket was closed in the way expected by Vite.

Autocomponents provide high-level React components - data tables and forms - that are pre-configured to read and write data using your app's backend actions. They use a design system under the hood and this initial release focuses on Shopify Polaris.

They are configurable and extensible, and can be used to build complex user interfaces with minimal code.

For more info on building with autocomponents, read our guide.

The vite dependency version set in package.json has always been used to build app frontends in production. However we were not respecting this version for the development server. This issue is now fixed, and the same user-defined vite version is used for the development server and for building production.

Shopify's Storefront API access scopes are now available as options when setting up your Shopify connection in Gadget. Developers also have the option to enter a comma-separated list of scopes for any scopes not available in the existing list.

We've made performance and UX improvements to the background action UI.

The updated background actions page will see a 3-5X improvement in loading, filtering, and search performance. The UX improvements include an easier to find check logs link, relative enqueued and last attempt times, a new cancelled tab, and better handling of long job ids and errors.

Gelly schema for has many through relationships now includes automatically generated has many relationships to the through model.

For example, if student has many courses through registration, the schema for student now includes student.registrations. This allows you to filter by field values on the registration model when querying for student records.

// filter students by a registered date field on registrations
students {
 registrations {
  course: course.title
  [ where registered > date("2020-12-31") ]
 }
}

Lots of fixes and improvements have been recently added to Gelly.

Improvements have been made to Gelly's SQL compilation process, resulting in fewer sub-selects and more joins. This includes the following changes and fixes:
- improved relationship traversal - accessing related fields in Gelly now works for all relationship types
- expressions that include multiple relationship chains are now supported
- aggregation target changes for has one relationships
- group by expression fixes
- support for has many through relationships in Gelly

Types can now be inferred for results of arbitrary Gelly expressions thanks to:

- new base types, including updates to Date and DateTime, an Interval type for date arithmetic, and proper Vector support
- ternary expressions no longer cast non-compatable results and require explicit casting
- casting to additional base types is possible, and no longer relies on jsonb types
- coalesce() now uses the Postgres coalesce function and requires compatible types

Validation and error reporting has been improved, including:

- more precise and informative error messages including the sourceFilePath
- additional validations have been added
 - check for mixing aggregate and non-aggregate expressions in a selection
  - check for the use of has many relationships in a scalar context
  - check that group by expressions yield a scalar value for each row of the root model
  - check that selection aliases do not conflict with root model field names if the are referenced in a group by expression

These changes have also resulted in better integration with Gadget:

- better filter typing on computed fields
- support for has many through relationships in computed fields and model filters
- Gelly deduplicates fragment selections that select the same fields
- Gelly supports traversing across relationships to the same module multiple times in a single expression

Other improvements include bug fixes to arithmetic operator associativity and the addition of an any() function to Gelly.

Read the full dev changelog.

The upsert API has been released to all apps. All existing apps will immediately have access to api.internal.<model>.upsert. Any apps on framework version >=1.1 will have a public upsert API for any model that has both a create and an update action. Read more in our guides.

The number of default retires for background actions has been lowered from 10 to 2 in development environments. This results in less noise while developing. A warning will also appear in the logs when a background action fails to execute. The default retry count for background actions is still 10 for all production environments.

Read more about background actions.

Shopify’s product webhooks now contain the updated_at field for each variant. Gadget will now use this field to determine if a variant needs to be fetched from Shopify when handling product webhooks. If the variant’s updated_at field in the webhook payload is newer than what is stored in the product variant's shopifyUpdatedAt field, Gadget will fetch the updated variant info from Shopify.

Gadget now uses Shopify's GraphQL API to sync DraftOrder and DraftOrderLineItem model data. The DraftOrderPlatformDiscount and DraftOrderPlatformDiscountAllocation models have also been added.

The FulfillmentService model for apps on Shopify API version > 2024-07 will use the GraphQL API for syncing data.

New version of ggt has been released with the following updates:

• uses esbuild to bundle, minify, and tree-shake, reducing package size and improving command speed
  • ggt package size reduced from ~60MB to ~8MB
  • ggt help performance improvement from ~350ms to ~170ms
• Fixed an issue causing ggt deploy to hang after deploying an app
• Fixed an issue causing ggt dev to print "Pulled files." when only hidden files were pulled
• Fixed an issue causing ggt to not work when run with Node.js 18.17 or lower

See the ggt source.

Gadget has now added support for Shopify API Version 2024-07. This version includes additions to the Shopify Order, Draft Order, and Customer models, and disconnects deprecated fields on Product Variants. Details and additional changes can be found in our Shopify API version changelog docs.

Quickly test your APIs with the new JavaScript playground. You can now run your environment’s actions in a JS console that has been pre-loaded with your Gadget app’s API client. Read the blog post for more info.

‍

Access the current environment and app name in code using process.env.GADGET_ENV and process.env.GADGET_APP. These can be used in both the frontend and backend, and are useful for adding environment-specific behaviors to apps.

‍

Use connections.shopify.currentSession.userId to get the ID of the Shopify user making a request. This allows for per-user functionality to be added to embedded Shopify admin apps. You can also read the Shopify session token that was used to authenticate the current request with connections.shopify.currentSession.token. If you want to learn how to access additional Shopify user data using OAuth token exchange, check out our docs.

‍

The connections object has been added to the gadget-server package. You can use this to access credentials or connected clients outside of actions or routes. We have a boot plugin example and more details available in our docs.

‍

Version 1.1 of the Gadget framework includes the ability to use realtime queries in imperative API clients, a ggt add command that adds models and actions to a project from the command line, a ~30% smaller API client, improvements to project folderization, API namespace control, and an upgrade to Node 20.12. Read more on framework v1.1.

A new package that makes it easier to register a session token with your Gadget app's API client. Can be used for both React and JS/TS extensions, and works with a variety of Shopify extension types, including customer account UI or checkout UI extensions. Read the reference docs for more information.

Gadget now supports making authenticated requests from within Shopify customer account UI extensions. A new access control role, shopify-storefront-customers can be added to apps during Shopify connection setup, allowing for fine-grain control over which actions customer users can call within extensions. Read our docs to learn more.

Shopify webhooks are now available as triggers for global actions, meaning you can build stateless applications that run custom code on incoming Shopify webhooks without storing the webhook payload in the database, saving on data storage costs. Learn how to use them in our docs.

Gadget has now added support for Shopify API Version 2024-04.

This update introduces support for up to 2,000 variants per product. Gadget will automatically synchronize all variants, ensuring that users do not need to manually update their product variant data. All the increased compute time required for this new functionality is provided free of charge.
‍
Enhanced webhook payloads now include a variant_gids field that lists all variant IDs for up to 2,000 variants, but only when the extended variants feature is enabled. This field helps in automatically fetching all variant data beyond the first 100, ensuring comprehensive data access without extra effort.

Bulk actions can now be enqueued for execution in the background. Pass a bulk action to api.enqueue like you might any other action, and each element of the bulk action will run as its own background action.

Usage reports on the Usage tab are now filterable by specific applications. Allowing users to dig deeper into the triggers, shops, models, and actions that are using the most resources.

Gadget now supports background actions, enabling actions to run in the background, similar to background jobs. This allows developers to offload time-consuming processes from the main workflow, improving tasks like external API interactions and data processing. Wrap your actions in api.enqueue() to run them in the background. For more information check out the guide here.

Gadget applications can now enable source control using Git, through the use of various metadata files! To get started, use Gadget's CLI ggt to clone your app's files into a local directory and manage any changes between your local directory and the Gadget editor (in real time!). For more information on how to use Git based source-control with Gadget check out our guide here.

Gadget now enables developers to created unlimited, development environments for each project, featuring separate databases and code deployment facilities. These environments come with unique URLs and allow for independent version control, enhancing testing and development flexibility​. For more information check out the guide here.

Gadget has now added support for App Bridge v4 from Shopify. For more information on how to upgrade read the guide here.

The data editor within Gadget now provides the ability to export your data to a CSV, to do so navigate to the button in the `More Actions` menu. Exporting a CSV will export all the data for the model matching the current search in the editor to a CSV file, and email a link to that file to the current user. All fields on screen in the data editor will be included in the export, which excludes computed fields and fields of related models.

Gadget's default Vite configuration now supports using Web Workers with no extra configuration. Read more about Web Workers with Vite here.

The scheduler trigger now allows setting the selected date and time in UTC. A local equivalent of the scheduled date and time will also be shown to users.

Gadget now supports Shopify API version 2024-01. For a full list of changes see our API changelog here.

Gadget framework version v0.3.1 is released with support for shop level webhook disabling and a splitting the implicit daily sync into an explicitly scheduled sync and a webhook reconciliation. For more information check out our guide here.

Gadget developers can now export the contents they see in the log viewer to a file using the more actions button. All logs matching the search query and time range will be compiled into an .ndjson file and a link to the file will be emailed to the developer.

Currently Gadget will attempt to accept webhooks for a shopify shop that is marked as uninstalled in an apps database even though we processing that webhook will fail since that shop record will not have an access token. This means that an app will be billed for webhooks that we know will fail. After this change Gadget will respond to Shopify with a 410 (GONE) code which will eventually cause Shopify to stop sending webhooks for that shop.

Gadget now supports setting environment variables that are only read once by node.js at boot time, like NODE_EXTRA_CA_CERTS. Previously, these values were ignored to maximize boot performance, but now Gadget will correctly restart the node process in order to reflect changes to these variables.

Most actions are triggered by HTTP requests. Gadget exposes the details of the HTTP request that is causing an action to run at the request property of the action context, so you can get at stuff like the requester's IP address for attribution, or headers for rolling your own auth. Actions don't generally need to care about the request, but if they need to, it's there!

The Gadget framework v0.3 introduces support for Fastify V4 and Node 20. All new apps will come with default support for v0.3, existing apps will have to update their version. For a full list of changes and how to update your framework version check out our guide here.

Gadget supports a few different framework versions: each is a well-tested, trusted stack of system components. App developers can now control which framework version their app uses in their settings. To upgrade or downgrade, change the framework version in the settings, which will kick off a yarn install to update npm package dependencies for your app to match your system component versions. For more on how to change your framework version follow our documentation guide here.

When users choose to use custom credentials for their google oauth they will now receive the oauth tokens in the trigger payload. For apps using custom credentials there is now a toggle to request offline access from users. This will perform the google oauth request with access_type=offline and prompt=consent and will result in a refreshToken being available in the trigger payload. For users using Gadget managed credentials they will no longer be able to edit the scopes that are requested.

Shopify syncs on new apps now have an abort action that allows developers to abort a running sync. Syncs that are aborted will be in the "errored" state, and any long running activities will be stopped immedietely. For existing apps refer to our documentation guide on how to add the abort action.