Skip to content

Commit

Permalink
DEVLIB-1257: Rename Compute@Edge to Compute (#328)
Browse files Browse the repository at this point in the history
* DEVLIB-1257: Rename Compute@Edge to Compute

* Update README.md
  • Loading branch information
doramatadora authored Oct 31, 2023
1 parent 9135fc2 commit ab94de0
Show file tree
Hide file tree
Showing 13 changed files with 22 additions and 22 deletions.
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@

## 0.2.12 (2022-03-08)

- Add stubs for framing header controls, now available on C@E ([#139](https://github.com/fastly/Viceroy/pull/139))
- Add stubs for framing header controls, now available on Compute ([#139](https://github.com/fastly/Viceroy/pull/139))

## 0.2.11 (2022-02-15)

Expand Down Expand Up @@ -189,7 +189,7 @@

- Catch interrupt signals ([#85](https://github.com/fastly/Viceroy/pull/85))
- Include aarch64 tarballs for Linux and macOS ([#88](https://github.com/fastly/Viceroy/pull/88))
- Align URI and Host header semantics with production C@E ([#90](https://github.com/fastly/Viceroy/pull/90))
- Align URI and Host header semantics with production Compute ([#90](https://github.com/fastly/Viceroy/pull/90))

## 0.2.5 (2021-10-21)

Expand All @@ -206,9 +206,9 @@

### Additions
- Added the close functionality for `RequestHandle`, `ResponseHandle`,
`BodyHandle`, and `StreamingBodyHandle` in the upcoming Rust C@E `0.8.0` SDK
`BodyHandle`, and `StreamingBodyHandle` in the upcoming Rust Compute `0.8.0` SDK
release ([#65](https://github.com/fastly/Viceroy/pull/65))
- Added local dictionary support so that C@E programs that need dictionaries can work in Viceroy ([#61](https://github.com/fastly/Viceroy/pull/61))
- Added local dictionary support so that Compute programs that need dictionaries can work in Viceroy ([#61](https://github.com/fastly/Viceroy/pull/61))
- Added the ability to do host overrides from the TOML configuration ([#48](https://github.com/fastly/Viceroy/pull/48))

### Changes
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Contributing to Viceroy

First off thank you for wanting to contribute to making Viceroy better! We
appreciate you taking time to improve the Compute@Edge experience for developers
appreciate you taking time to improve the Compute experience for developers
everywhere. There are many ways you can contribute that include but aren't
limited to documentation, opening issues, issue triage, and code contributions.
We'll cover some of the ways you can contribute below, but if you don't see
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Viceroy

Viceroy provides local testing for developers working with Compute@Edge. It
allows you to run services written against the Compute@Edge APIs on your local
Viceroy provides local testing for developers working with Fastly Compute. It
allows you to run services written against the Compute APIs on your local
development machine, and allows you to configure testing backends for your
service to communicate with.

Viceroy is normally used through the [Fastly CLI's `fastly compute serve`
command][cli], where it is fully integrated into Compute@Edge workflows.
command][cli], where it is fully integrated into Compute workflows.
However, it is also a standalone open source tool with its own CLI and a
Rust library that can be embedded into your own testing infrastructure.

Expand All @@ -16,7 +16,7 @@ Rust library that can be embedded into your own testing infrastructure.

### Via the Fastly CLI

As mentioned above, most users of Compute@Edge should do local testing via the
As mentioned above, most users of Compute should do local testing via the
Fastly CLI, rather than working with Viceroy directly. Any [CLI release] of
version 0.34 or above supports local testing, and the workflow is documented
[here][cli].
Expand Down Expand Up @@ -50,12 +50,12 @@ viceroy bin/main.wasm
```

This will start a local server (by default at: `http://127.0.0.1:7676`), which can
be used to make requests to your Compute@Edge service locally. You can make requests
be used to make requests to your Compute service locally. You can make requests
by using [curl](https://curl.se/), or you can send a simple GET request by visiting
the URL in your web browser.

## Usage as a test runner
Viceroy can also be used as a test runner for running Rust unit tests for Compute@Edge applications in the following way:
Viceroy can also be used as a test runner for running Rust unit tests for Compute applications in the following way:

1. Ensure the `viceroy` command is available in your path
2. Add the following to your project's `.cargo/config`:
Expand Down
2 changes: 1 addition & 1 deletion cli/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "viceroy"
description = "Viceroy is a local testing daemon for Compute@Edge."
description = "Viceroy is a local testing daemon for Fastly Compute."
version = "0.9.3"
authors = ["Fastly"]
readme = "../README.md"
Expand Down
2 changes: 1 addition & 1 deletion cli/src/main.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Fastly's local testing daemon for Compute@Edge.
//! Fastly's local testing daemon for Compute.

// When building the project in release mode:
// (1): Promote warnings into errors.
Expand Down
2 changes: 1 addition & 1 deletion cli/src/opts.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ use {
// [clap](https://docs.rs/clap/latest/clap/) documentation for more information.
//
// Note that the doc comment below is used as descriptive text in the `--help` output.
/// Viceroy is a local testing daemon for Compute@Edge.
/// Viceroy is a local testing daemon for Compute.
#[derive(Parser, Debug)]
#[command(name = "viceroy", author, version, about)]
#[command(propagate_version = true)]
Expand Down
2 changes: 1 addition & 1 deletion lib/compute-at-edge-abi/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 🔗 compute-at-edge-abi

This directory contains the canonical `witx` definitions for the Compute@Edge
This directory contains the canonical `witx` definitions for the Compute
platform ABI.

### About `witx`
Expand Down
2 changes: 1 addition & 1 deletion lib/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ pub use crate::secret_store::SecretStores;

/// Fastly-specific configuration information.
///
/// This `struct` represents the fields and values in a Compute@Edge package's `fastly.toml`.
/// This `struct` represents the fields and values in a Compute package's `fastly.toml`.
#[derive(Debug, Clone)]
pub struct FastlyConfig {
name: String,
Expand Down
2 changes: 1 addition & 1 deletion lib/src/execute.rs
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,7 @@ fn configure_wasmtime(profiling_strategy: ProfilingStrategy) -> wasmtime::Config
const MB: usize = 1 << 20;
let mut pooling_allocation_config = PoolingAllocationConfig::default();

// This number matches C@E production
// This number matches Compute production
pooling_allocation_config.max_core_instance_size(MB);

// Core wasm programs have 1 memory
Expand Down
2 changes: 1 addition & 1 deletion lib/src/linking.rs
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ fn make_wasi_ctx(ctx: &ExecuteCtx, session: &Session) -> Result<WasiCtx, anyhow:
let mut wasi_ctx = WasiCtxBuilder::new();

// Viceroy provides a subset of the `FASTLY_*` environment variables that the production
// Compute@Edge platform provides:
// Compute platform provides:

wasi_ctx
// signal that we're in a local testing environment
Expand Down
2 changes: 1 addition & 1 deletion lib/src/wiggle_abi.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#![allow(clippy::too_many_arguments)]
#![allow(clippy::derive_partial_eq_without_eq)]

//! Wiggle implementations for the Compute@Edge ABI.
//! Wiggle implementations for the Compute ABI.
//
// Future maintainers wishing to peer into the code generated by theses macros can do so by running
// `cargo expand --package viceroy-lib wiggle_abi` in their shell, from the root of the `Viceroy`
Expand Down
4 changes: 2 additions & 2 deletions test-fixtures/src/bin/geolocation-lookup-default.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ fn main() {
assert_eq!(geo_v4.proxy_description(), ProxyDescription::Unknown);
assert_eq!(geo_v4.proxy_type(), ProxyType::Unknown);
assert_eq!(geo_v4.region(), Some("CA"));
// commented out because the below line fails both in Viceroy and C@E.
// commented out because the below line fails both in Viceroy and Compute.
// assert_eq!(geo_v4.utc_offset(), Some(UtcOffset::from_hms(-7, 0, 0).unwrap());

let client_ip_v6 = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
Expand All @@ -55,6 +55,6 @@ fn main() {
assert_eq!(geo_v6.proxy_description(), ProxyDescription::Unknown);
assert_eq!(geo_v6.proxy_type(), ProxyType::Unknown);
assert_eq!(geo_v6.region(), Some("CA"));
// commented out because the below line fails both in Viceroy and C@E.
// commented out because the below line fails both in Viceroy and Compute.
// assert_eq!(geo_v6.utc_offset(), Some(UtcOffset::from_hms(-7, 0, 0).unwrap());
}
2 changes: 1 addition & 1 deletion test-fixtures/src/bin/geolocation-lookup.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ fn main() {
assert_eq!(geo_v4.proxy_description(), ProxyDescription::Unknown);
assert_eq!(geo_v4.proxy_type(), ProxyType::Unknown);
assert_eq!(geo_v4.region(), Some("BC"));
// commented out because the below line fails both in Viceroy and C@E.
// commented out because the below line fails both in Viceroy and Compute.
// assert_eq!(geo_v4.utc_offset(), Some(UtcOffset::from_hms(-7, 0, 0).unwrap()));

let client_ip_v6 = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
Expand Down

0 comments on commit ab94de0

Please sign in to comment.