Official Cloud Content Delivery - Release Notes and Known Issues

Hello Everyone!

This thread will be kept up to date with release notes for Cloud Content Delivery. It will also have an updated list of known issues.

Release Notes

December 2, 2020

We've released the API v0.9.87.

Summary

• Changed service so that billing is no longer deactivated when the last bucket is deleted for a project. The project needs to be archived to deactivate billing
• Added new params to the release diff entries endpoint: GetReleaseDiffEntries. You can now diff based upon release numbers or release ids. The new query params are ‘fromreleasenum’ and ‘toreleasenum’
• Added filter to the diff entries endpoints GetDiffEntries,GetReleaseDiffEntries. You can now filter entries by using ‘include_states’ and specifying a list of change states. For example: ‘include_states=Add,Delete,Update’

December 1, 2020

An overview support page is now available in the dashboard. This page gathers the following info and analytics:

Summary

• You can see your bandwidth consumption at the project level
• You can keep track of the total bandwidth used with details of the free bandwidth used and paid bandwidth used

November 24, 2020

We've released the API v0.9.79.

Summary

• Added new endpoint for Org usage
• Added missing foreign keys
• Configured the client API garbage collector
• Change queries for bucket and release lists to do far fewer queries
• Reworked how diffs are generated to create less load on the management server

November 6, 2020

We've released the API v0.9.73.

Summary

• Added created field to bucket model
• Reworked diff generation to prevent locking on uploads
• Updated SSL cert
• Reworked statistics gathering to improve performance
• Moved to stricter caching policy for the client API, to include HEAD requests and 404s

October 15, 2020

We've released the API v0.9.62.

Summary

• Documentation: fix “Try it out” button
• Documentation: added release notes
• Added ApiKeyAuth to all routes secured by it in docs.json
• Added /orgs GET route
• Re-worked file storage to prevent race conditions when uploading identical files (size + hash) with different filenames. The last file completely uploaded is the version that is served.

October 8, 2020

We've released the API v0.9.61, CLI v0.9.8, and some updates in the dashboard.

Summary

• This release adds support for editing the notes fields on releases after the release has been created (editing available via CLI and dashboard)
• This release adds a support page in the dashboard. You can now see the API service status in real-time, submit a support ticket, and access documentation for Cloud Content Delivery in the CCD section.

Dashboard

A support page is available in the dashboard. This page gathers the following information and links:

• The status of Management and Client APIs in real time
• Direct links to assistance: forum, documentation, and API reference
• Direct submission of a support ticket
• Main Cloud Content Delivery materials

API v0.9.61

• Added a PUT route to releases to update notes on a release after a release has been created.

CLI v0.9.8

• Added ‘releases update [releaseid] --notes’ to CLI to update notes after a release has been created
  
  
• Fixed error messages when a user does not have access to perform an operation to inform them they need to be a manager or owner of the project.

September 30, 2020

We've released the API v0.9.60 and CLI v0.9.7

Summary

• This release adds support for resuming uploads and downloads through the management API. Technical details are provided below.
  
  
• The “entries download” command in the CLI has been changed to write to file by default rather than STDOUT.

API v0.9.60

• Added a PUT route to releases to update notes on a release after a release has been created.
  
  
• You can no longer download partial content through the client API. To download content through the client API the size (Content-Size) and MD5 hash (Content-Hash) must match. The client API will return a 404 if they do not match. We still support downloading incomplete files through the management API. Files uploaded before this release will still be available through the client API.
  
  
• If you upload the expected number of bytes (or more) for a file and the Content-Hash does not match the Upload-Offset will be reset to zero, and you will need to upload again. You can still download the file through the management API for troubleshooting purposes.
  
  
• Support has been added for tus uploads (https://tus.io/). This includes a POST endpoint for the /content routes. This route is NOT required to be called. It's simply for tus clients that break without it.
  
  
• Added x-unity-hash to content status endpoints. This includes md5, crc32c, sha1, and sha256 hashes when available. MD5 should be available for all files. The rest will only be available for new uploads. They headers looks like this:
  X-Unity-Hash: md5=4221d002ceb5d3c9e9137e495ceaa647
  X-Unity-Hash: crc32c=163c5da7
  X-Unity-Hash: sha1=804d716fc5844f1cc5516c8f0be7a480517fdea2
  X-Unity-Hash: sha256=b6668cf8c46c7075e18215d922e7812ca082fa6cc34668d00a6c20aee4551fb6
  
  
• You can now continue a partially uploaded file (or upload in partial segments). When continuing an upload you must start from the returned Upload-Offset or 0 to start over.
  
  
• The value of x-unity-hash will reflect what has been uploaded with partial uploads.
  
  
• Any files uploaded before this release will be assumed to be complete if their sizes match. No hash checks will be done.
  
  
• Any new file uploads will need to have matching Content-Size and Content-Hash MD5 hashes to be added to a release.

CLI v0.9.7 (optional upgrade)

• BREAKING: When using “entries download” the file will be downloaded to a local file with the same filename as the remote file. Previous behavior downloaded to STDOUT. You can continue to download to stdout using the output argument with a single dash:
  --output -
  
  
• BREAKING: When using “entries download” if a file exists and you try to overwrite it the command will fail. You will need to use the --force flag to overwrite the existing file.
  
  
• When using “entries download” you can resume partial downloads. Simply pass the --continue flag.

 

December 17, 2020

We've released the API v0.9.94.

Summary

• Switched all data validation to use Swagger/Open API standards. Some error message details have changed. For instance: ‘releaseid is a required field’ is now ‘releaseid in body is required’

 

January 6, 2021

We've released the API v0.9.98.

Summary

• Fixed API permissions documentation definition.
  
• Removed permissions from security nodes and added them as extensions in swagger.
  
  • Moved the values from security->permissions to x-permissions
    

 

January 14, 2021

We've released the API v0.9.102.

Summary

• Allow diffs against an empty bucket. You can do this with fromreleasenum=0.
  
• Properly cancel interrupted uploads.

 

February 4, 2021

We've released the API v0.9.107.

Summary

• Reworked diffs to improve performance and stability
• The ‘loading’ field will always be included in the ‘changecount’ model with a boolean value. Previously, the ‘loading’ field was only included when the value was true.

 

April 22, 2021

Hi all- I'm Christina, new Product Manager on the Cloud Content Delivery team. We've released API v0.9.147.

Summary

• Added complete flag to the Entry model (which is returned from routes like [GetEntry](/doc/#/Entries/GetEntry)). This indicates that the file that was uploaded matches the size and md5 sum that is expected.
• Optimized ReleaseEntry query to improve performance
• Return correct error message for content-type issues
• Improved logging to increase throughput

 

May 4, 2021

Entries can now be added, updated, downloaded, and deleted on the Latest page from the CCD dashboard

 

May 13, 2021

We've released API v0.9.159.

Summary

• New "File Upload" UI added to the Onboarding page, allowing users to add files directly in the dashboard instead of needing to use the CLI when onboarding onto the service
• Added complete field to ReleaseEntry model. This indicates that the file that was uploaded matches the size and md5 sum that is expected.
• Entries are now saved only if there is an actual change in the entry fields/content.
  • The JSON output for entry create/update commands now contains fields last_modified (changes every time at least one entry field is updated, i.e. entry content is changed) and updated_at (changes every time an update call is made)
• Added new checks and fixed existing checks for Labels and Metadata to prevent updating an entry when unchanged Label and/or Metadata is passed in update API call body.
• Added support for Unity Services Gateway requests coming in from the Unity dashboard.
• Updated SSL cert

 

May 20, 2021

We've released API v0.9.164.

Summary

• List of badges now returns most recently created badges first rather than sorting alphabetically
• Exposed Location header in Access-Control-Expose-Headers
• Added tos_accepted param to GetOrg
• Added API endpoint to accept term of service (TOS) SaveTosAccepted

 

June 7, 2021

We've released API v0.9.170, CLI v0.9.9, and dashboard improvements.

Summary

• API: Fixed a timeout when creating a release with large numbers of files (over 5000)
• CLI: Added --timeout flag to releases create command
• Dashboard: The following are now saved on page change or refresh:
  • The perPage setting of the changes, releases and badges tables
  • The filters for the changes table in Latest and Release pages
  • The state of Badges Information Panel in the Badges

 

June 4, 2021

As part of the Addressables v1.18.9 release, we have added the path pairs feature for better use with CCD:

Profile variables are automatically divided into a prefix and postfix by the

.

character. Profile variables sharing a prefix and a set of specific postfixes,

BuildPath

and

LoadPath

, are grouped together into a path pair.

A path pair is defined by the following criteria:

1. two variables with a common prefix separated by a

   .

   character
2. one variable postfix following the

   .

   must be

   BuildPath

3. one variable postfix following the

   .

   must be

   LoadPath

​

 

June 29, 2021

We've released API v1.1.2.

Summary

• Treat 0 byte files as complete
• Fixed database connection leak when uploading large numbers of files
• Currently when we read a path from the "path" query parameter we trim forward slashes, but not backslashes. This effectively breaks Windows players (and Windows Addressables development). This has been fixed in a pre-release version of Addressables, but this fixes it on the server side as well.

 

July 7, 2021

We added a checkbox to delete entries which are in the bucket but not in entries to be uploaded when using the upload feature in the dashboard. This brings the dashboard to full parity with the CLI.

 

July 22, 2021

We've released API v1.1.15

Summary

• BREAKING: in [doc/doc.json](/doc/doc.json) `x-permissions` has been removed; `x-permission` and `x-add-pipeline` added.
• Added attributes and permissions to [GetBucket](/doc/#/Buckets/GetBucket)
• Added attributes and permissions to [ListBucketsByProject](/doc/#/Buckets/ListBucketsByProject)
• Added [list permissions](/doc/#/Permissions/GetAllByBucket)
• Added [update permission](/doc/#/Permissions/UpdatePermissionByBucket)
• Added [create permissions](/doc/#/Permissions/CreatePermissionByBucket)
• Added [delete permissions](/doc/#/Permissions/DeletePermissionByBucket)

 

July 27, 2021

We've released Promotion Only Buckets!

A bucket can be marked as “promotion only” in order to restrict access to that bucket and prevent mistakes such as uploading incorrect content to a bucket. New bucket icons now indicate whether the bucket is open to all (open box icon) or promotion only (closed box icon).

• Open to all: Anyone can modify content in this bucket.
• Promotion only: Owners + Managers can modify content through promotion from another bucket. No one can upload to or delete content from this bucket.

 

August 9, 2021

We've released API v1.2.6

Summary

• Updated service events to support additional analytics

 

August 10, 2021

If you're using CCD with Cloud Build, we've added the following features:

• The ability to explicitly choose a different CCD bucket when copying a build target in Cloud Build
• The ability to turn off the --delete flag in Cloud Build so CCD can handle both incremental builds and clean builds
  
  
  

 

August 10, 2021

We have released 2 dashboard updates:

• The ability to cancel in progress uploads from the dashboard. Note that files that have already been uploaded at the time of cancellation will remain in the bucket.
• A new release selector for creating and editing badges in the dashboard.

 

August 10, 2021

We've released CLI v0.9.14.

Summary

• --interactive flag added globally (to disable y/n prompt)
• promote-only bucket support
• added --release to entries sync command
• improved upload behavior of sync
• added --badge with releases create command (and with entries sync when --release is specified)

 

September 9, 2021

We've released download metrics and error details in the CCD dashboard!

You can now view number of downloads in the last 24hrs, 7 days, and 30 days, as well as number of errors and error details in the last 24hrs.

 

September 20, 2021

We've released a dashboard update:

Users now have the option to create a release automatically once their upload is finished. The release will be created with the entries that were in bucket just before the upload plus the new files. This brings dashboard release creation to parity with the recently added CLI functionality.

 

September 20, 2021

We've just launched private buckets!

Private buckets protect read access to buckets with an access token, so that only those users with that access token can retrieve content from that bucket.

• You now have the option to make a bucket private upon creation.
• You can edit buckets in a new Settings page in the CCD dashboard.
• You can view, create, edit or delete bucket access tokens in the new Settings page.
• You can delete buckets on individual bucket pages.

 

October 21, 2021

We've released API v1.4.15 and CLI v0.10.4.

Summary
API v1.4.15

• Added promote bucket asynchronous to promote release between buckets asynchronously. Promotion to/from private buckets must use this endpoint
• Added get promotion
• Added versionid query parameter to upload content
• Update release and promotion analytics events to be recorded after diffs are complete
• Fixed basic analytics to properly record paths per project
• Updated API documentation:
  • Added workflow diagram for uploading content
  • Added information about multipart form uploads and tus uploads
  • Added a link to the main unity documentation and for the explanation of the concepts of entries/buckets/releases/badges
  • Added information on how deleting files work for an entry and bucket
  • Added information about hash used for entries, information about "current_versionid" and "complete" fields for entry responses
  • Called out about the API to search an entry by path and labelt
  • Added how to verify if the content is successfully uploaded

CLI v0.10.4

• Added --dryrun to releases create command
• Change releases promote to async promote, default timeout 60s.
• Add releases promotions status command, check async promote status.

 

November 4, 2021

We've released API v1.4.23.

Summary

• Updated SSL certificates
• Added from_bucket_name and to_bucket_name in the response of get promotion endpoint
• Added versionid query parameter to create content endpoint, this is still a route that only exists for tus clients. It now passes through the versionid flag.
• Update authorization process to properly return logged out errors to users in the dashboard.
• Added support for 0 byte file uploads. Can upload 0 byte files, create a release and download them.
• Added conditional Large File Optimization (LFO) query parameter to perform LFO on the CDN side for files larger than 100mb.
• Updated API documentation:
  • Added information about how Syncing works. Instructions to sync from a local folder using API

 

November 17, 2021

If you're using CCD with Addressables and Cloud Build, we've added the following feature:

• Added a checkbox that will be unchecked for existing build targets, but checked by default for all new ones.
• In the build-cli, if checked, we remove the value of RemoteBuildPath from the beginning of each filepath returned by UnityReflector.AddressablesBuildPlayerContent().
• Unchecking the box would have today's existing behavior:
  • Building an asset bundle locally generates

    measurementpack_assets_all.bundle

  • Building it in Cloud Build and uploading to CCD generates

    ServerData/StandaloneWindows64/measurementpack_assets_all.bundle

 

December 9, 2021

We've released API v1.4.39.

Summary

• Fixed the issue where the `content-type` attribute was not properly set for some files when uploaded to GCS. The `content-type` metadata is now explicitly set for GCS objects using the entry's `content-type` attribute. If the entry does not explicitly have a `content-type`, the GCS object will default to `application/octet-stream` as before.
• Added [get promotions](/doc/#/Buckets/GetPromotions), which by default, returns all the incoming and outgoing promotions for a bucket. You can use promotion_filter query parameter to get only incoming/only outgoing promotions. Also, promotion_status query parameter can be used to filter results based on the status of a promotion
• Added from_release_number in the response of [get promotion](/doc/#/Buckets/GetPromotion)
• Validate bucket id as guid earlier for client API.

 

December 13, 2021

We've released API v1.4.41.

Summary

• Fixed bug in Proxify where the `Upload-Length` header was deleted after processing requests for LFO, affecting values used by CDP. The header has been reinstated. Data ingestion will be back to normal, so the dashboard's usage panels will display data as intended.

 

January 21, 2022

We've launched 2 new features:

• Dashboard sorting: you can now sort entries in the CCD dashboard by size and updated date.
• Async promotions: you can now promote a release to or from a private bucket.

 

February 25, 2022

CCD is now integrated with Game Overrides. CCD customers can now deliver assets to the right players, at the right time by targeting and scheduling changes to their buckets and badges using Game Overrides. This enables use cases such as:

• Testing new content with specific QA test devices
• Only enabling Halloween assets around Halloween
• Sending different resolution assets to different countries or devices

More information can be found here.

 

April 13, 2022

We've released API v1.5.33.

Summary

• [BREAKING] UploadChecksum when doing partial uploads will now return the sha1sum of the upload rather than the entire file. This matches the TUS specification.
• Fixed an issue with uploading zero byte files through the Dashboard preventing creating a release.

 

April 25, 2022

We've released API v1.5.44 and CLI v0.11.0

Summary
API v1.5.44

• Added environment support to the API. All management routes now accept an Environment ID and all client routes accept an Environment Name
• All routes that do not specify an environment will default to the production environment.
• All routes that do not have an Environment ID or Name in the path have been marked deprecated. They have not actually been deprecated and will not be removed, but we wanted to indicate to developers in the documentation which routes should be used going forward.
• All new routes have an Operation ID with the suffix 'Env'. This is to preserve compatibility with code generators.
• Added direct signed URL uploads. When creating an entry to be uploaded via a signed URL you are not required to specify a content_hash or content_size.
  • Add the signed_url flag to [CreateEntryEnv](/doc/#/Entries/CreateEntryEnv)
  • Add the signed_url flag to [UpdateEntryEnv](/doc/#/Entries/UpdateEntryEnv)
  • Add the signed_url flag to [CreateOrUpdateEntryByPathEnv](/doc/#/Entries/CreateOrUpdateEntryByPathEnv)
• Added from_environment_id, from_environment_name, to_environment_id, to_environment_name in the response of [GetPromotionEnv](/doc/#/Buckets/GetPromotionEnv) and [GetPromotionsEnv](/doc/#/Buckets/GetPromotionsEnv)

CLI v0.11.0

• BREAKING CHANGE: We are introducing environment support to the CLI. CLI versions less than v0.11.0 will continue to work, but once you upgrade you will now need to add the --environment flag to most commands. Example:

  • ucd buckets list --environment=[ENVIRONMENT_ID] [PROJECT_ID]

• You can also save an environment to be used in all future commands by using the config environment
• command:

  • ucd config environment [ENVIRONMENT_ID]

• To find a list of environments for your project and their corresponding IDs visit the Dashboard. Click on Projects. Find your Project and then click on Environments under Project Settings.
• BREAKING CHANGE: An error message in CLI has changed from "No buckets found for project." to "No buckets found for given project and environment."

 

May 31, 2022

We've released API v1.6.28.

Summary

• BREAKING CHANGE: currently when you retrieve the last page of a result set with

  ?starting_after

  you will get a content range header with zero for the total records

  (Content-Range: */0)

  . This has been fixed to return the correct total for the list

  (Content-Range: */100)

• Added a new endpoint

  ListEnvironmentsByProject

  .
• Client API performance fix when fetching with environment.

 

June 2

We are excited to release a new opinionated workflow today. We are adding environments to CCD, and recommending that buckets be created per platform. This means:

• The Buckets page is now an environment-level page where you only see buckets per environment.
• If there are no buckets in selected environment, you can copy buckets and their settings from another environment.
• When creating a bucket, you can create it in any environments, with individual privacy and write permissions per environment.
• The Onboarding flow has been improved to feature the new environments feature.

All of your existing buckets will be listed under the "Production" environment.

Please note that if you bookmarked a Buckets/Bucket pages URL, it will give a 404 as these page URL have changed to now include the environment ID in the URL. You can simply use the side navigation to access the desired Bucket page and bookmark it again.

 

June 14

API v1.6.40

• Add internal API endpoints

CLI v0.11.10

• Reduced binary size significantly.
• When the environment is not specified with entries/releases/badges commands, the default (production) environment is now assumed.
• Enforce consistency between bucket, environment, and project when using “config set” commands.
• Added an “environments list” command to list all environments for the specified project.

 

June 29

Summary
API v1.6.49

• Updated source table to fix missing usage overview statistics

CLI v0.11.11

• Fixed panic on Ubuntu (crypto/hmac: hash generation function does not produce unique values)

 

July 7th

API v1.6.56

• configured timeouts to reduce 502s when uploading files
• fixes to internal API endpoints
• allow Client API to accept either Environment Name of ID for the environmentname parameter. We didn’t change the parameter name to reflect that as it could have potentially broken SDK generation tools.

CLI v0.11.12

• use the same timeout value when creating a release in ‘entries sync’ when the –release flag is specified

 

Hi All,
At around 8h30 am EDT this morning, the CCD team was alerted that some of our customers were having issue creating releases. Following a quick investigation, we confirmed the issue and created an internal incident. CCD took the immediate action of rollbacking yesterday’s release and at around 9h45 am EDT, we confirmed the issue was no longer happening and our customers were again able to create releases.We are currently working on a fix for the bug that was found in this release, which we will thoroughly test before releasing to customers next week.Sorry for the inconveniences that it might have caused. Let us know if you have any questions or comments.
Best Regards
CCD team